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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
|
/* GHDL Wavefile reader library.
Copyright (C) 2005-2017 Tristan Gingold
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <gnu.org/licenses>.
*/
#ifndef _LIBGHW_H_
#define _LIBGHW_H_
#include <stdio.h>
#include <stdlib.h>
/* To be libraries friendly. */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
/* The libghw uses the standard c99 int32_t and int64_t. They are declared
in stdint.h. Header inttypes.h includes stdint.h and provides macro for
printf and co specifiers. Use it if known to be available. */
#if defined(__cplusplus) || \
(defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) || \
defined(HAVE_INTTYPES_H)
/* Use C99 standard header. */
#include <inttypes.h>
#define GHWPRI64 "%" PRId64
#define GHWPRI32 "%" PRId32
#else
#include <stdint.h>
#define GHWPRI64 "%lld"
#define GHWPRI32 "%d"
#endif
enum ghdl_rtik
{
ghdl_rtik_top, /* 0 */
ghdl_rtik_library,
ghdl_rtik_package,
ghdl_rtik_package_body,
ghdl_rtik_entity,
ghdl_rtik_architecture, /* 5 */
ghdl_rtik_process,
ghdl_rtik_block,
ghdl_rtik_if_generate,
ghdl_rtik_for_generate,
ghdl_rtik_instance,
ghdl_rtik_constant,
ghdl_rtik_iterator,
ghdl_rtik_variable,
ghdl_rtik_signal,
ghdl_rtik_file,
ghdl_rtik_port,
ghdl_rtik_generic,
ghdl_rtik_alias,
ghdl_rtik_guard,
ghdl_rtik_component,
ghdl_rtik_attribute,
ghdl_rtik_type_b2, /* 22 */
ghdl_rtik_type_e8,
ghdl_rtik_type_e32,
ghdl_rtik_type_i32, /* 25 */
ghdl_rtik_type_i64,
ghdl_rtik_type_f64,
ghdl_rtik_type_p32,
ghdl_rtik_type_p64,
ghdl_rtik_type_access, /* 30 */
ghdl_rtik_type_array,
ghdl_rtik_type_record,
ghdl_rtik_type_file,
ghdl_rtik_subtype_scalar,
ghdl_rtik_subtype_array, /* 35 */
ghdl_rtik_subtype_array_ptr, /* Obsolete. */
ghdl_rtik_subtype_unbounded_array,
ghdl_rtik_subtype_record,
ghdl_rtik_subtype_unbounded_record,
#if 0
ghdl_rtik_subtype_access, /* 40 */
ghdl_rtik_type_protected,
ghdl_rtik_element,
ghdl_rtik_unit,
ghdl_rtik_attribute_transaction,
ghdl_rtik_attribute_quiet,
ghdl_rtik_attribute_stable,
#endif
ghdl_rtik_error
};
/* Well-known types. */
enum ghw_wkt_type
{
ghw_wkt_unknown,
ghw_wkt_boolean,
ghw_wkt_bit,
ghw_wkt_std_ulogic
};
struct ghw_range_b2
{
enum ghdl_rtik kind:8;
int dir:8; /* 0: to, !0: downto. */
unsigned char left;
unsigned char right;
};
struct ghw_range_e8
{
enum ghdl_rtik kind:8;
int dir:8; /* 0: to, !0: downto. */
unsigned char left;
unsigned char right;
};
struct ghw_range_i32
{
enum ghdl_rtik kind:8;
int dir:8; /* 0: to, !0: downto. */
int32_t left;
int32_t right;
};
struct ghw_range_i64
{
enum ghdl_rtik kind:8;
int dir:8;
int64_t left;
int64_t right;
};
struct ghw_range_f64
{
enum ghdl_rtik kind:8;
int dir:8;
double left;
double right;
};
union ghw_range
{
enum ghdl_rtik kind:8;
struct ghw_range_b2 b2;
struct ghw_range_e8 e8;
struct ghw_range_i32 i32;
struct ghw_range_i64 i64;
struct ghw_range_f64 f64;
};
/* Note: the first two fields must be kind and name. */
union ghw_type;
struct ghw_type_common
{
enum ghdl_rtik kind;
const char *name;
};
struct ghw_type_enum
{
enum ghdl_rtik kind;
const char *name;
enum ghw_wkt_type wkt;
unsigned int nbr;
const char **lits;
};
struct ghw_type_scalar
{
enum ghdl_rtik kind;
const char *name;
};
struct ghw_unit
{
const char *name;
int64_t val;
};
struct ghw_type_physical
{
enum ghdl_rtik kind;
const char *name;
uint32_t nbr_units;
struct ghw_unit *units;
};
struct ghw_type_array
{
enum ghdl_rtik kind;
const char *name;
unsigned int nbr_dim;
union ghw_type *el;
union ghw_type **dims;
};
struct ghw_subtype_unbounded_array
{
enum ghdl_rtik kind;
const char *name;
union ghw_type *base;
};
struct ghw_subtype_array
{
enum ghdl_rtik kind;
const char *name;
union ghw_type *base;
int nbr_scalars;
union ghw_range **rngs;
union ghw_type *el;
};
struct ghw_subtype_scalar
{
enum ghdl_rtik kind;
const char *name;
union ghw_type *base;
union ghw_range *rng;
};
struct ghw_record_element
{
const char *name;
union ghw_type *type;
};
struct ghw_type_record
{
enum ghdl_rtik kind;
const char *name;
unsigned int nbr_fields;
int nbr_scalars; /* Number of scalar elements (ie nbr of signals). */
struct ghw_record_element *els;
};
struct ghw_subtype_record
{
enum ghdl_rtik kind;
const char *name;
struct ghw_type_record *base;
int nbr_scalars; /* Number of scalar elements (ie nbr of signals). */
struct ghw_record_element *els;
};
struct ghw_subtype_unbounded_record
{
enum ghdl_rtik kind;
const char *name;
struct ghw_type_record *base;
};
union ghw_type
{
enum ghdl_rtik kind;
struct ghw_type_common common;
struct ghw_type_enum en;
struct ghw_type_scalar sc;
struct ghw_type_physical ph;
struct ghw_subtype_scalar ss;
struct ghw_type_array ar;
struct ghw_type_record rec;
struct ghw_subtype_array sa;
struct ghw_subtype_unbounded_array sua;
struct ghw_subtype_record sr;
struct ghw_subtype_unbounded_record sur;
};
union ghw_val
{
unsigned char b2;
unsigned char e8;
int32_t i32;
int64_t i64;
double f64;
};
/* A non-composite signal. */
struct ghw_sig
{
union ghw_type *type;
union ghw_val *val;
};
enum ghw_hie_kind
{
ghw_hie_eoh = 0,
ghw_hie_design = 1,
ghw_hie_block = 3,
ghw_hie_generate_if = 4,
ghw_hie_generate_for = 5,
ghw_hie_instance = 6,
ghw_hie_package = 7,
ghw_hie_process = 13,
ghw_hie_generic = 14,
ghw_hie_eos = 15,
ghw_hie_signal = 16,
ghw_hie_port_in = 17,
ghw_hie_port_out = 18,
ghw_hie_port_inout = 19,
ghw_hie_port_buffer = 20,
ghw_hie_port_linkage = 21
};
#define GHW_NO_SIG 0
struct ghw_hie
{
enum ghw_hie_kind kind;
struct ghw_hie *parent;
const char *name;
struct ghw_hie *brother;
union
{
struct
{
struct ghw_hie *child;
union ghw_type *iter_type;
union ghw_val *iter_value;
} blk;
struct
{
union ghw_type *type;
/* Array of signal elements.
Last element is GHW_NO_SIG (0). */
unsigned int *sigs;
} sig;
} u;
};
struct ghw_handler
{
FILE *stream;
/* True if STREAM was popen, else was fopen. */
unsigned char stream_ispipe;
/* True if words are big-endian. */
unsigned char word_be;
unsigned char word_len;
unsigned char off_len;
/* Minor version. */
int version;
/* Set by user. */
int flag_verbose;
/* String table. */
/* Number of strings. */
unsigned nbr_str;
/* Size of the strings (without nul). */
unsigned str_size;
/* String table. */
char **str_table;
/* Array containing strings. */
char *str_content;
/* Type table. */
unsigned nbr_types;
union ghw_type **types;
/* Non-composite (or basic) signals. */
unsigned nbr_sigs;
char *skip_sigs;
int flag_full_names;
struct ghw_sig *sigs;
/* Hierarchy. */
struct ghw_hie *hie;
/* Time of the next cycle. */
int64_t snap_time;
};
/* Open a GHW file with H.
Return < 0 in case of error. */
int ghw_open (struct ghw_handler *h, const char *filename);
/* Return base type of T. */
union ghw_type *ghw_get_base_type (union ghw_type *t);
/* Return length of RNG. */
int ghw_get_range_length (union ghw_range *rng);
/* Put the ASCII representation of VAL into BUF, whose size if LEN.
A NUL is always written to BUF. */
void ghw_get_value (char *buf, int len, union ghw_val *val,
union ghw_type *type);
const char *ghw_get_hie_name (struct ghw_hie *h);
void ghw_disp_hie (struct ghw_handler *h, struct ghw_hie *top);
int ghw_read_base (struct ghw_handler *h);
void ghw_filter_signals (struct ghw_handler *h, int *signals_to_keep,
int nb_signals_to_keep);
void ghw_disp_values (struct ghw_handler *h);
int ghw_read_cycle_start (struct ghw_handler *h);
int ghw_read_cycle_cont (struct ghw_handler *h, int *list);
int ghw_read_cycle_next (struct ghw_handler *h);
int ghw_read_cycle_end (struct ghw_handler *h);
enum ghw_sm_type
{
/* At init;
Read section name. */
ghw_sm_init = 0,
ghw_sm_sect = 1,
ghw_sm_cycle = 2
};
enum ghw_res
{
ghw_res_error = -1,
ghw_res_eof = -2,
ghw_res_ok = 0,
ghw_res_snapshot = 1,
ghw_res_cycle = 2,
ghw_res_other = 3
};
enum ghw_res ghw_read_sm_hdr (struct ghw_handler *h, int *list);
int ghw_read_sm (struct ghw_handler *h, enum ghw_sm_type *sm);
int ghw_read_dump (struct ghw_handler *h);
struct ghw_section
{
const char name[4];
int (*handler) (struct ghw_handler * h);
};
extern struct ghw_section ghw_sections[];
int ghw_read_section (struct ghw_handler *h);
void ghw_close (struct ghw_handler *h);
const char *ghw_get_dir (int is_downto);
void ghw_disp_subtype_indication (struct ghw_handler *h, union ghw_type *t);
/* Note: TYPE must be a base type (used only to display literals). */
void ghw_disp_range (union ghw_type *type, union ghw_range *rng);
void ghw_disp_type (struct ghw_handler *h, union ghw_type *t);
void ghw_disp_types (struct ghw_handler *h);
#endif /* _LIBGHW_H_ */
|