summaryrefslogtreecommitdiffstats
path: root/src/base/cba/cbaReadBlif.c
blob: c324b37f050b88518530cdfa49142e7108f1b6a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
/**CFile****************************************************************

  FileName    [cbaReadBlif.c]

  SystemName  [ABC: Logic synthesis and verification system.]

  PackageName [Verilog parser.]

  Synopsis    [Parses several flavors of word-level Verilog.]

  Author      [Alan Mishchenko]
  
  Affiliation [UC Berkeley]

  Date        [Ver. 1.0. Started - November 29, 2014.]

  Revision    [$Id: cbaReadBlif.c,v 1.00 2014/11/29 00:00:00 alanmi Exp $]

***********************************************************************/

#include "cba.h"
#include "cbaPrs.h"

ABC_NAMESPACE_IMPL_START

////////////////////////////////////////////////////////////////////////
///                        DECLARATIONS                              ///
////////////////////////////////////////////////////////////////////////

// BLIF keywords
typedef enum { 
    CBA_BLIF_NONE = 0, // 0:  unused
    CBA_BLIF_MODEL,    // 1:  .model
    CBA_BLIF_INPUTS,   // 2:  .inputs
    CBA_BLIF_OUTPUTS,  // 3:  .outputs
    CBA_BLIF_NAMES,    // 4:  .names
    CBA_BLIF_SUBCKT,   // 5:  .subckt
    CBA_BLIF_GATE,     // 6:  .gate
    CBA_BLIF_LATCH,    // 7:  .latch
    CBA_BLIF_END,      // 8:  .end
    CBA_BLIF_UNKNOWN   // 9:  unknown
} Cba_BlifType_t;

const char * s_BlifTypes[CBA_BLIF_UNKNOWN+1] = {
    NULL,              // 0:  unused
    ".model",          // 1:  .model   
    ".inputs",         // 2:  .inputs
    ".outputs",        // 3:  .outputs
    ".names",          // 4:  .names
    ".subckt",         // 5:  .subckt
    ".gate",           // 6:  .gate
    ".latch",          // 7:  .latch
    ".end",            // 8:  .end
    NULL               // 9:  unknown
};

static inline void Cba_PrsAddBlifDirectives( Cba_Prs_t * p )
{
    int i;
    for ( i = 1; s_BlifTypes[i]; i++ )
        Abc_NamStrFindOrAdd( p->pDesign->pNames, (char *)s_BlifTypes[i],   NULL );
    assert( Abc_NamObjNumMax(p->pDesign->pNames) == i );
}

static inline int  Cba_PrsIsSpace( char c )                    { return c == ' ' || c == '\t' || c == '\r';                     }
static inline int  Cba_PrsIsOk( Cba_Prs_t * p )                { return (int)(p->pCur < p->pLimit);                             }
static inline int  Cba_PrsIsChar( Cba_Prs_t * p, char c )      { return *p->pCur == 'c';                                        }
static inline int  Cba_PrsIsLit( Cba_Prs_t * p )               { return *p->pCur == '0' || *p->pCur == '1' || *p->pCur == '-';  }
static inline void Cba_PrsSkipToChar( Cba_Prs_t * p, char c )  { while ( *p->pCur != c ) p->pCur++;                             }
static inline char Cba_PrsSkip( Cba_Prs_t * p )                { return *p->pCur++;                                             }


////////////////////////////////////////////////////////////////////////
///                     FUNCTION DEFINITIONS                         ///
////////////////////////////////////////////////////////////////////////

/**Function*************************************************************

  Synopsis    [Reading names.]

  Description []
               
  SideEffects []

  SeeAlso     []

***********************************************************************/
static inline void Cba_PrsSkipSpaces( Cba_Prs_t * p )
{
    while ( Cba_PrsIsSpace(*p->pCur) )
        Cba_PrsSkip(p);
    if ( Cba_PrsIsChar(p, '#') )  
        Cba_PrsSkipToChar( p, '\n' );
    else if ( Cba_PrsIsChar(p, '\\') )
    {
        Cba_PrsSkipToChar( p, '\n' );
        Cba_PrsSkip(p);
        Cba_PrsSkipSpaces( p );
    }   
}
static inline int Cba_PrsReadName( Cba_Prs_t * p )
{
    char * pStart = p->pCur;
    while ( !Cba_PrsIsSpace(*p->pCur) && !Cba_PrsIsChar(p, '\\') )
        Cba_PrsSkip(p);
    if ( pStart == p->pCur )
        return 0;
    return Abc_NamStrFindOrAddLim( p->pDesign->pNames, pStart, p->pCur, NULL );
}
static inline int Cba_PrsReadName2( Cba_Prs_t * p )
{
    char * pStart = p->pCur;
    while ( !Cba_PrsIsSpace(*p->pCur) && !Cba_PrsIsChar(p, '\\') && !Cba_PrsIsChar(p, '=') )
        Cba_PrsSkip(p);
    if ( pStart == p->pCur )
        return 0;
    return Abc_NamStrFindOrAddLim( p->pDesign->pNames, pStart, p->pCur, NULL );
}

/**Function*************************************************************

  Synopsis    []

  Description []
               
  SideEffects []

  SeeAlso     []

***********************************************************************/
static inline int Cba_PrsReadCube( Cba_Prs_t * p )
{
    while ( Cba_PrsIsLit(p) )
        Vec_StrPush( p->vCover, Cba_PrsSkip(p) );
    Cba_PrsSkipSpaces( p );
    Vec_StrPush( p->vCover, ' ' );
    if ( !Cba_PrsIsLit(p) )                           return Cba_PrsErrorSet(p, "Cannot detect output literal.", 1);
    Vec_StrPush( p->vCover, Cba_PrsSkip(p) );
    return 1;
}
static inline void Cba_PrsSaveCover( Cba_Prs_t * p )
{
    int iToken;
    assert( Vec_StrSize(p->vCover) > 0 );
    Vec_StrPush( p->vCover, '\0' );
    iToken = Abc_NamStrFindOrAdd( p->pDesign->pFuncs, Vec_StrArray(p->vCover), NULL );
    Vec_StrClear( p->vCover );
    assert( Vec_IntEntryLast(p->vFuncsCur) == 1 );
    Vec_IntWriteEntry( p->vFuncsCur, Vec_IntSize(p->vFuncsCur)-1, iToken );
}

/**Function*************************************************************

  Synopsis    []

  Description []
               
  SideEffects []

  SeeAlso     []

***********************************************************************/
static inline int Cba_PrsReadSignals( Cba_Prs_t * p, int fSkipFirst )
{
    Cba_PrsSkipSpaces( p );
    Vec_IntFill( p->vTemp, fSkipFirst, -1 );
    while ( !Cba_PrsIsChar(p, '\n') )
    {
        Vec_IntPush( p->vTemp, Cba_PrsReadName(p) );
        Cba_PrsSkipSpaces( p );
    }
    if ( Vec_IntSize(p->vTemp) == 0 )  return Cba_PrsErrorSet(p, "List of signals is empty.", 1);
    if ( Vec_IntCountZero(p->vTemp) )  return Cba_PrsErrorSet(p, "Cannot read names in the list.", 1); 
    return 0;
}
static inline int Cba_PrsReadInputs( Cba_Prs_t * p )
{
    if ( Cba_PrsReadSignals(p, 0) )    return 1;
    Vec_IntAppend( p->vInputsCur, p->vTemp );
    return 0;
}
static inline int Cba_PrsReadOutputs( Cba_Prs_t * p )
{
    if ( Cba_PrsReadSignals(p, 0) )    return 1;
    Vec_IntAppend( p->vOutputsCur, p->vTemp );
    return 0;
}
static inline int Cba_PrsReadNode( Cba_Prs_t * p )
{
    if ( Cba_PrsReadSignals(p, 1) )    return 1;
    Vec_IntWriteEntry( p->vTemp, 0, Vec_IntPop(p->vTemp) );
    // save results
    Vec_IntPush( p->vFuncsCur, 1 );
    Vec_IntPush( p->vTypesCur, CBA_PRS_NODE );
    Cba_PrsSetupVecInt( p, Vec_WecPushLevel(p->vFaninsCur), p->vTemp );
    return 0;
}
static inline int Cba_PrsReadBox( Cba_Prs_t * p, int fGate )
{
    Cba_PrsSkipSpaces( p );
    if ( Cba_PrsIsChar(p, '\n') )      return Cba_PrsErrorSet(p, "Cannot read model name.", 1);
    Vec_IntPush( p->vFuncsCur, Cba_PrsReadName(p) );
    Cba_PrsSkipSpaces( p );
    if ( Cba_PrsIsChar(p, '\n') )      return Cba_PrsErrorSet(p, "Cannot read formal/actual inputs.", 1);
    while ( !Cba_PrsIsChar(p, '\n') )
    {
        Vec_IntPush( p->vTemp, Cba_PrsReadName(p) );
        Cba_PrsSkipSpaces( p );
        if ( !Cba_PrsIsChar(p, '=') )  return Cba_PrsErrorSet(p, "Cannot find symbol \'=\'.", 1);
        p->pCur++;
        Cba_PrsSkipSpaces( p );
        Vec_IntPush( p->vTemp, Cba_PrsReadName(p) );
        Cba_PrsSkipSpaces( p );
    }
    // save results
    Vec_IntPush( p->vTypesCur, CBA_PRS_BOX );
    Cba_PrsSetupVecInt( p, Vec_WecPushLevel(p->vFaninsCur), p->vTemp );
    return 0;
}
static inline int Cba_PrsReadLatch( Cba_Prs_t * p )
{
    Vec_IntFill( p->vTemp, 2, -1 );
    Cba_PrsSkipSpaces( p );
    if ( Cba_PrsIsChar(p, '\n') )      return Cba_PrsErrorSet(p, "Cannot read latch input.", 1);
    Vec_IntWriteEntry( p->vTemp, 1, Cba_PrsReadName(p) );
    Cba_PrsSkipSpaces( p );
    if ( Cba_PrsIsChar(p, '\n') )      return Cba_PrsErrorSet(p, "Cannot read latch output.", 1);
    Vec_IntWriteEntry( p->vTemp, 0, Cba_PrsReadName(p) );
    if ( Cba_PrsIsChar(p, '0') )
        Vec_IntPush( p->vFuncsCur, 0 );
    else if ( Cba_PrsIsChar(p, '1') )
        Vec_IntPush( p->vFuncsCur, 1 );
    else if ( Cba_PrsIsChar(p, '2') || Cba_PrsIsChar(p, '\n') )
        Vec_IntPush( p->vFuncsCur, 2 );
    else                               return Cba_PrsErrorSet(p, "Cannot read latch init value.", 1);
    // save results
    Vec_IntPush( p->vTypesCur, CBA_PRS_LATCH );
    Cba_PrsSetupVecInt( p, Vec_WecPushLevel(p->vFaninsCur), p->vTemp );
    return 0;
}
static inline int Cba_PrsReadModel( Cba_Prs_t * p )
{
    Cba_PrsSkipSpaces( p );
    if ( Vec_IntSize(p->vInputsCur) > 0 )           return Cba_PrsErrorSet(p, "Parsing previous model is unfinished.", 1);
    p->iModuleName = Cba_PrsReadName( p );
    if ( p->iModuleName == 0 )                      return Cba_PrsErrorSet(p, "Cannot read model name.", 1);
    Cba_PrsSkipSpaces( p );
    if ( !Cba_PrsIsChar(p, '\n') )                  return Cba_PrsErrorSet(p, "Trailing symbols on .model line.", 1);
    return 0;
}
static inline int Cba_PrsReadEnd( Cba_Prs_t * p )
{
    if ( Vec_IntSize(p->vInputsCur) == 0 )          return Cba_PrsErrorSet(p, "Directive .end without .model.", 1);
    Cba_PrsAddCurrentModel( p, p->iModuleName );
    return 0;
}

static inline int Cba_PrsReadDirective( Cba_Prs_t * p )
{
    int iToken;
    if ( !Cba_PrsIsChar(p, '.') )
        return Cba_PrsReadCube( p );
    if ( Vec_StrSize(p->vCover) > 0 ) // SOP was specified for the previous node
        Cba_PrsSaveCover( p );
    iToken = Cba_PrsReadName( p );  
    if ( iToken == CBA_BLIF_MODEL )
        return Cba_PrsReadModel( p );
    if ( iToken == CBA_BLIF_INPUTS )
        return Cba_PrsReadInputs( p );
    if ( iToken == CBA_BLIF_OUTPUTS )
        return Cba_PrsReadOutputs( p );
    if ( iToken == CBA_BLIF_NAMES )
        return Cba_PrsReadNode( p );
    if ( iToken == CBA_BLIF_SUBCKT )
        return Cba_PrsReadBox( p, 0 );
    if ( iToken == CBA_BLIF_GATE )
        return Cba_PrsReadBox( p, 1 );
    if ( iToken == CBA_BLIF_LATCH )
        return Cba_PrsReadLatch( p );
    if ( iToken == CBA_BLIF_END )
        return Cba_PrsReadEnd( p );
    assert( 0 );
    return 1;
}
static inline int Cba_PrsReadLines( Cba_Prs_t * p )
{
    while ( Cba_PrsIsChar(p, '\n') )
    {
        p->pCur++; Cba_PrsSkipSpaces( p );
        if ( Cba_PrsIsChar(p, '\n') )    
            continue;
        if ( Cba_PrsReadDirective( p ) )
            return 1;
    }
    return 0;
}

/**Function*************************************************************

  Synopsis    []

  Description []
               
  SideEffects []

  SeeAlso     []

***********************************************************************/
Cba_Man_t * Cba_PrsReadBlif( char * pFileName )
{
    Cba_Man_t * pDesign = NULL;
    Cba_Prs_t * p = Cba_PrsAlloc( pFileName );
    if ( p == NULL )
        return NULL;
    Cba_PrsAddBlifDirectives( p );
    Cba_PrsReadLines( p );
    if ( Cba_PrsErrorPrint(p) )
        ABC_SWAP( Cba_Man_t *, pDesign, p->pDesign );
    Cba_PrsFree( p );
    return pDesign;
}


////////////////////////////////////////////////////////////////////////
///                       END OF FILE                                ///
////////////////////////////////////////////////////////////////////////


ABC_NAMESPACE_IMPL_END