-
Notifications
You must be signed in to change notification settings - Fork 249
/
dict_pkg.vhd
439 lines (372 loc) · 12.7 KB
/
dict_pkg.vhd
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
-- This Source Code Form is subject to the terms of the Mozilla Public
-- License, v. 2.0. If a copy of the MPL was not distributed with this file,
-- You can obtain one at http://mozilla.org/MPL/2.0/.
--
-- Copyright (c) 2014-2024, Lars Asplund lars.anders.asplund@gmail.com
--
-- dict_pkg provides the dict_t data type which is an dynamic dictionary implementation.
-- All dict keys are strings but the values can be of many different data types and a single
-- dict can hold a mix of data types.
library ieee;
use ieee.std_logic_1164.all;
use ieee.math_complex.all;
use ieee.numeric_bit.all;
use ieee.numeric_std.all;
use work.codec_pkg.all;
use work.data_types_private_pkg.all;
use work.integer_array_pkg.all;
use work.integer_vector_ptr_pkg.all;
use work.integer_vector_ptr_pool_pkg.all;
use work.queue_pkg.all;
use work.string_ptr_pkg.all;
use work.string_ptr_pool_pkg.all;
package dict_pkg is
type dict_t is record
p_meta : integer_vector_ptr_t;
p_bucket_lengths : integer_vector_ptr_t;
p_bucket_keys : integer_vector_ptr_t;
p_bucket_values : integer_vector_ptr_t;
p_bucket_value_types : integer_vector_ptr_t;
end record;
constant null_dict : dict_t := (others => null_ptr);
-- Create a new empty dict. Must be done before applying any other operation on the dict.
impure function new_dict
return dict_t;
procedure deallocate (
variable dict : inout dict_t
);
impure function has_key (
dict : dict_t;
key : string
) return boolean;
impure function num_keys (
dict : dict_t
) return natural;
procedure remove (
dict : dict_t;
key : string
);
-- Set and get for different value data types. A dict can hold any mix of data types.
-- There are also overloaded get and set subprogram aliases for each type. These comes
-- with the risk of ambiguities which the type specific subprograms don't have.
procedure set_string (
dict : dict_t;
key : string;
value : string
);
impure function get_string (
dict : dict_t;
key : string
) return string;
procedure set_integer (
dict : dict_t;
key : string;
value : integer
);
impure function get_integer (
dict : dict_t;
key : string
) return integer;
procedure set_character (
dict : dict_t;
key : string;
value : character
);
impure function get_character (
dict : dict_t;
key : string
) return character;
procedure set_boolean (
dict : dict_t;
key : string;
value : boolean
);
impure function get_boolean (
dict : dict_t;
key : string
) return boolean;
procedure set_real (
dict : dict_t;
key : string;
value : real
);
impure function get_real (
dict : dict_t;
key : string
) return real;
procedure set_bit (
dict : dict_t;
key : string;
value : bit
);
impure function get_bit (
dict : dict_t;
key : string
) return bit;
procedure set_std_ulogic (
dict : dict_t;
key : string;
value : std_ulogic
);
impure function get_std_ulogic (
dict : dict_t;
key : string
) return std_ulogic;
procedure set_severity_level (
dict : dict_t;
key : string;
value : severity_level
);
impure function get_severity_level (
dict : dict_t;
key : string
) return severity_level;
procedure set_file_open_status (
dict : dict_t;
key : string;
value : file_open_status
);
impure function get_file_open_status (
dict : dict_t;
key : string
) return file_open_status;
procedure set_file_open_kind (
dict : dict_t;
key : string;
value : file_open_kind
);
impure function get_file_open_kind (
dict : dict_t;
key : string
) return file_open_kind;
procedure set_bit_vector (
dict : dict_t;
key : string;
value : bit_vector
);
impure function get_bit_vector (
dict : dict_t;
key : string
) return bit_vector;
procedure set_std_ulogic_vector (
dict : dict_t;
key : string;
value : std_ulogic_vector
);
impure function get_std_ulogic_vector (
dict : dict_t;
key : string
) return std_ulogic_vector;
procedure set_complex (
dict : dict_t;
key : string;
value : complex
);
impure function get_complex (
dict : dict_t;
key : string
) return complex;
procedure set_complex_polar (
dict : dict_t;
key : string;
value : complex_polar
);
impure function get_complex_polar (
dict : dict_t;
key : string
) return complex_polar;
procedure set_numeric_bit_unsigned (
dict : dict_t;
key : string;
value : ieee.numeric_bit.unsigned
);
impure function get_numeric_bit_unsigned (
dict : dict_t;
key : string
) return ieee.numeric_bit.unsigned;
procedure set_numeric_bit_signed (
dict : dict_t;
key : string;
value : ieee.numeric_bit.signed
);
impure function get_numeric_bit_signed (
dict : dict_t;
key : string
) return ieee.numeric_bit.signed;
procedure set_numeric_std_unsigned (
dict : dict_t;
key : string;
value : ieee.numeric_std.unsigned
);
impure function get_numeric_std_unsigned (
dict : dict_t;
key : string
) return ieee.numeric_std.unsigned;
procedure set_numeric_std_signed (
dict : dict_t;
key : string;
value : ieee.numeric_std.signed
);
impure function get_numeric_std_signed (
dict : dict_t;
key : string
) return ieee.numeric_std.signed;
procedure set_time (
dict : dict_t;
key : string;
value : time
);
impure function get_time (
dict : dict_t;
key : string
) return time;
-- get and set aliases for every type specific get and set subprogram. All but the set
-- and get aliases for string type values will be enabled in VUnit v5.0. These create
-- ambiguities with the original set and get subprograms for string and a backward
-- compatibility that needs to be solved in a major VUnit release
alias set is set_string[dict_t, string, string];
alias get is get_string[dict_t, string return string];
-- alias set is set_integer[dict_t, string, integer];
-- alias get is get_integer[dict_t, string return integer];
-- alias set is set_character[dict_t, string, character];
-- alias get is get_character[dict_t, string return character];
-- alias set is set_boolean[dict_t, string, boolean];
-- alias get is get_boolean[dict_t, string return boolean];
-- alias set is set_real[dict_t, string, real];
-- alias get is get_real[dict_t, string return real];
-- alias set is set_bit[dict_t, string, bit];
-- alias get is get_bit[dict_t, string return bit];
-- alias set is set_std_ulogic[dict_t, string, std_ulogic];
-- alias get is get_std_ulogic[dict_t, string return std_ulogic];
-- alias set is set_severity_level[dict_t, string, severity_level];
-- alias get is get_severity_level[dict_t, string return severity_level];
-- alias set is set_file_open_status[dict_t, string, file_open_status];
-- alias get is get_file_open_status[dict_t, string return file_open_status];
-- alias set is set_file_open_kind[dict_t, string, file_open_kind];
-- alias get is get_file_open_kind[dict_t, string return file_open_kind];
-- alias set is set_bit_vector[dict_t, string, bit_vector];
-- alias get is get_bit_vector[dict_t, string return bit_vector];
-- alias set is set_std_ulogic_vector[dict_t, string, std_ulogic_vector];
-- alias get is get_std_ulogic_vector[dict_t, string return std_ulogic_vector];
-- alias set is set_complex[dict_t, string, complex];
-- alias get is get_complex[dict_t, string return complex];
-- alias set is set_complex_polar[dict_t, string, complex_polar];
-- alias get is get_complex_polar[dict_t, string return complex_polar];
-- alias set is set_numeric_bit_unsigned[dict_t, string, ieee.numeric_bit.unsigned];
-- alias get is get_numeric_bit_unsigned[dict_t, string return ieee.numeric_bit.unsigned];
-- alias set is set_numeric_bit_signed[dict_t, string, ieee.numeric_bit.signed];
-- alias get is get_numeric_bit_signed[dict_t, string return ieee.numeric_bit.signed];
-- alias set is set_numeric_std_unsigned[dict_t, string, ieee.numeric_std.unsigned];
-- alias get is get_numeric_std_unsigned[dict_t, string return ieee.numeric_std.unsigned];
-- alias set is set_numeric_std_signed[dict_t, string, ieee.numeric_std.signed];
-- alias get is get_numeric_std_signed[dict_t, string return ieee.numeric_std.signed];
-- alias set is set_time[dict_t, string, time];
-- alias get is get_time[dict_t, string return time];
-- alias set is set_boolean_vector[dict_t, string, boolean_vector];
-- alias get is get_boolean_vector[dict_t, string return boolean_vector];
-- alias set is set_time_vector[dict_t, string, time_vector];
-- alias get is get_time_vector[dict_t, string return time_vector];
-- alias set is set_real_vector[dict_t, string, real_vector];
-- alias get is get_real_vector[dict_t, string return real_vector];
-- alias set is set_integer_vector[dict_t, string, integer_vector];
-- alias get is get_integer_vector[dict_t, string return integer_vector];
-- alias set is set_ufixed[dict_t, string, ufixed];
-- alias get is get_ufixed[dict_t, string return ufixed];
-- alias set is set_sfixed[dict_t, string, sfixed];
-- alias get is get_sfixed[dict_t, string return sfixed];
-- alias set is set_float[dict_t, string, float];
-- alias get is get_float[dict_t, string return float];
-- Setting a dict value that is of a VUnit reference data type will hand over the
-- ownership of the reference to the dict, i.e. the value in the set call will be
-- null when the procedure returns. The strict handling of ownership reduces the
-- risk of bugs caused by several variables referencing and modifying the same piece
-- of data. If that is the intention the value has to be copied before passing it to
-- the set procedure. The set procedures has a "_ref" suffix to highlight this difference
-- in behaviour.
procedure set_dict_t_ref (
dict : dict_t;
key : string;
value : inout dict_t
);
impure function get_dict_t_ref (
dict : dict_t;
key : string
) return dict_t;
procedure set_integer_vector_ptr_t_ref (
dict : dict_t;
key : string;
value : inout integer_vector_ptr_t
);
impure function get_integer_vector_ptr_t_ref (
dict : dict_t;
key : string
) return integer_vector_ptr_t;
procedure set_string_ptr_t_ref (
dict : dict_t;
key : string;
value : inout string_ptr_t
);
impure function get_string_ptr_t_ref (
dict : dict_t;
key : string
) return string_ptr_t;
procedure set_integer_array_t_ref (
dict : dict_t;
key : string;
value : inout integer_array_t
);
impure function get_integer_array_t_ref (
dict : dict_t;
key : string
) return integer_array_t;
procedure set_queue_t_ref (
dict : dict_t;
key : string;
value : inout queue_t
);
impure function get_queue_t_ref (
dict : dict_t;
key : string
) return queue_t;
alias set_ref is set_dict_t_ref[dict_t, string, dict_t];
alias get_ref is get_dict_t_ref[dict_t, string return dict_t];
alias set_ref is set_integer_vector_ptr_t_ref[dict_t, string, integer_vector_ptr_t];
alias get_ref is get_integer_vector_ptr_t_ref[dict_t, string return integer_vector_ptr_t];
alias set_ref is set_string_ptr_t_ref[dict_t, string, string_ptr_t];
alias get_ref is get_string_ptr_t_ref[dict_t, string return string_ptr_t];
alias set_ref is set_integer_array_t_ref[dict_t, string, integer_array_t];
alias get_ref is get_integer_array_t_ref[dict_t, string return integer_array_t];
alias set_ref is set_queue_t_ref[dict_t, string, queue_t];
alias get_ref is get_queue_t_ref[dict_t, string return queue_t];
procedure push_ref (
constant queue : queue_t;
value : inout dict_t
);
impure function pop_ref (
queue : queue_t
) return dict_t;
alias push_dict_t_ref is push_ref[queue_t, dict_t];
alias pop_dict_t_ref is pop_ref[queue_t return dict_t];
function encode (
data : dict_t
) return string;
function decode (
code : string
) return dict_t;
procedure decode (
constant code : string;
variable index : inout positive;
variable result : out dict_t
);
-- Private
procedure p_set_with_type (
dict : dict_t;
key, value : string;
value_type : data_type_t
);
impure function p_get_with_type (
dict : dict_t;
key : string;
expected_value_type : data_type_t
) return string;
end package;