Repository navigation
Expand file tree
/
Copy pathvunit_packages.html
More file actions
756 lines (712 loc) · 57.8 KB
/
Copy pathvunit_packages.html
File metadata and controls
756 lines (712 loc) · 57.8 KB
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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="author" title="About these documents" href="about.html"><link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Examples" href="examples.html"><link rel="prev" title="HDL Libraries" href="hdl_libraries.html">
<link rel="prefetch" href="_static/VUnit_logo.png" as="image">
<link rel="shortcut icon" href="_static/vunit.ico"><!-- Generated with Sphinx 7.3.7 and Furo 2025.12.19 -->
<title>VUnit Packages - VUnit documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css" />
<style>
body {
--color-code-background: #f2f2f2;
--color-code-foreground: #1e1e1e;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">VUnit documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="_static/VUnit_logo.png" alt="Logo"/>
</div>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="blog/index.html">Blog</a><input aria-label="Toggle navigation of Blog" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="blog/2023_08_26_vhdl_configurations.html">Improved Support for VHDL Configurations and OSVVM</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2023_04_01_vunit_phases.html">VUnit Phases</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2023_03_31_vunit_events.html">VUnit Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2022_09_19_vunit_user_conference.html">VUnit User Conference</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2022_09_06_vunit_and_other_frameworks.html">FAQ What is VUnit’s Relation to Other Verification Frameworks?</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2020_08_12_continuous_integration_with_vunit_action_in_10_lines_of_code.html">Continuous Integration With VUnit Action in 10 Lines of Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_09_22_sigasi_adds_full_vunit_support.html">Sigasi Adds Full VUnit Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_07_22_sigasi_deepens_its_commitment_to_the_vunit_testing_framework.html">Sigasi Deepens Its Commitment to the VUnit Testing Framework</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_03_22_vunit_community_developed_bfms.html">VUnit Community Developed BFMs</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_02_12_vunit3.html">VUnit 3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_12_14_vunit_bfms_as_simple_as_emailing.html">VUnit BFMs - as Simple as Emailing</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_11_23_vunit_matlab_integration.html">VUnit Matlab Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_11_07_vunit_3_0_while_waiting_for_vhdl_2017.html">VUnit 3.0 - While Waiting for VHDL-2017</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_10_31_vunit_3_0_color_logging.html">VUnit 3.0 Color Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_09_28_sigasi_adds_support_for_vunit_testing_framework.html">Sigasi Adds Support for VUnit Testing Framework</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_06_03_enable_your_simulator_to_handle_complex_top_level_generics.html">Enable Your Simulator to Handle Complex Top-Level Generics</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_01_12_vunit_getting_started_1_2_3.html">VUnit - Getting Started 1-2-3</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_11_22_vunit_the_best_value_for_initial_effort_part3.html">VUnit - The Best Value for Initial Effort - Part 3</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_11_16_vunit_the_best_value_for_initial_effort_part2.html">VUnit - The Best Value for Initial Effort - Part 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_11_15_vunit_the_best_value_for_initial_effort_part1.html">VUnit - The Best Value for Initial Effort - Part 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_08_08_making_osvvm_a_submodule.html">Making OSVVM a Git Submodule</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_02_21_improving_vhdl_testbench_design_with_message_passing.html">Improving VHDL Testbench Design with Message Passing</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_02_01_website_updates.html">Website Updates</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_01_29_chat_with_vunit_users_and_developers.html">Chat with VUnit Users and Developers</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_01_26_welcome_to_our_new_website.html">Welcome to Our New Website</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2015_12_15_free_and_open_source_verification_with_vunit_and_ghdl.html">Free and Open Source Verification with VUnit and GHDL</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2015_10_08_who_is_using_UVM.html">Who’s Using UVM (or Not) for FPGA Development, and Why?</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2015_09_24_short_introduction_to_vunit.html">Short Introduction to VUnit</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">What is VUnit?</a></li>
<li class="toctree-l1"><a class="reference internal" href="installing.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="testimonials/testimonials.html">Testimonials</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="id/user_guide.html">Identity Package</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging/user_guide.html">Logging Library User Guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="check/user_guide.html">Check Library User Guide</a><input aria-label="Toggle navigation of Check Library User Guide" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="check/check_api.html"><em>check</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="check/checker_pkg.html"><em>checker</em> package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="run/user_guide.html">Run Library User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="com/user_guide.html">Communication Library User Guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="verification_components/user_guide.html">Verification Components User Guide</a><input aria-label="Toggle navigation of Verification Components User Guide" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="verification_components/memory_model.html">Memory Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html">Bus Master VCI</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html#stream-master-vci">Stream Master VCI</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html#stream-slave-vci">Stream Slave VCI</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html#synchronization-vci">Synchronization VCI</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="data_types/user_guide.html">Data Types User Guide</a><input aria-label="Toggle navigation of Data Types User Guide" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="data_types/event_user_guide.html">VUnit Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/queue.html"><em>queue</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/integer_array.html"><em>integer_array</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/ext_string.html"><em>external string</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/ext_integer_vector.html"><em>external integer vector</em> package</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="cli.html">Command Line Interface</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="py/ui.html">Python Interface</a><input aria-label="Toggle navigation of Python Interface" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="py/vunit.html">vunit.ui</a></li>
<li class="toctree-l2"><a class="reference internal" href="py/opts.html">Compilation Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="py/opts.html#simulation-options">Simulation Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hdl_libraries.html">HDL Libraries</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">VUnit Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Continuous Integration</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ci/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/script.html">Setup/configuration scripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/container.html">Containers and/or Virtual Machines</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/manual.html">Manual setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/usecases.html">Practical use cases</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="https://github.com/VUnit/vunit/blob/master/docs/vunit_packages.rst?plain=true" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div><div class="edit-this-page">
<a class="muted-link" href="https://github.com/VUnit/vunit/edit/master/docs/vunit_packages.rst" rel="edit" title="Edit this page">
<svg><use href="#svg-pencil"></use></svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="vunit-packages">
<span id="id1"></span><h1>VUnit Packages<a class="headerlink" href="#vunit-packages" title="Link to this heading">¶</a></h1>
<p>HDL code can be distributed as a Python package and added to a VUnit project
with <a class="reference internal" href="py/vunit.html#vunit.ui.VUnit.add_package" title="vunit.ui.VUnit.add_package"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_package()</span></code></a>.</p>
<p>A VUnit package must be installed and importable, and its root directory must
contain a <code class="docutils literal notranslate"><span class="pre">vunit_pkg.toml</span></code> manifest. Namespace packages are not currently
supported.</p>
<p>To use a package, add it in the project’s run script:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">vunit</span><span class="w"> </span><span class="kn">import</span> <span class="n">VUnit</span>
<span class="n">vu</span> <span class="o">=</span> <span class="n">VUnit</span><span class="o">.</span><span class="n">from_argv</span><span class="p">()</span>
<span class="n">vu</span><span class="o">.</span><span class="n">add_vhdl_builtins</span><span class="p">()</span>
<span class="n">vu</span><span class="o">.</span><span class="n">add_package</span><span class="p">(</span><span class="s2">"foo"</span><span class="p">)</span>
<span class="n">vu</span><span class="o">.</span><span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
<p>The manifest specifies the package’s source files, version requirements,
and compilation options. For example:</p>
<div class="literal-block-wrapper docutils container" id="id2">
<div class="code-block-caption"><span class="caption-text">vunit_pkg.toml</span><a class="headerlink" href="#id2" title="Link to this code">¶</a></div>
<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span class="k">[package]</span>
<span class="c1"># The package requires VUnit 5.0.0.dev15 or later and VHDL 2008 or later.</span>
<span class="n">requires</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'vunit >= "5.0.0.dev15" and vhdl >= "2008"'</span>
<span class="c1"># The default library for the package's sources.</span>
<span class="n">library</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"foo_lib"</span>
<span class="c1"># Default compile options for all sources in the package. These options are optional and can also be overridden for</span>
<span class="c1"># individual source entries.</span>
<span class="n">compile_option</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">[</span><span class="s2">"ghdl.a_flags"</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s2">"-fpsl"</span><span class="p">]],</span>
<span class="w"> </span><span class="p">[</span><span class="s2">"nvc.a_flags"</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s2">"--psl"</span><span class="p">]]</span>
<span class="p">]</span>
<span class="k">[[package.sources]]</span>
<span class="n">include</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">"hdl/src/*.vhd"</span><span class="p">]</span>
<span class="k">[[package.sources]]</span>
<span class="n">include</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">"hdl/compat/*.vhd"</span><span class="p">]</span>
<span class="c1"># Overrides the default library foo_lib for this source entry.</span>
<span class="n">library</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"foo_compat"</span>
<span class="k">[[package.sources]]</span>
<span class="n">include</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">"hdl/ghdl_extras_pkg.vhd"</span><span class="p">,</span><span class="w"> </span><span class="s2">"hdl/ghdl_extras_pkg-body.vhd"</span><span class="p">]</span>
<span class="c1"># Conditionally includes this source entry based on the environment.</span>
<span class="n">when</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'vhdl >= "2019" and simulator == "ghdl" and ghdl_version >= "6.0.0"'</span>
</pre></div>
</div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">requires</span></code> expression in the example allows the package to be used with
VUnit 5.0.0.dev15 or later and VHDL 2008 or later. Each <code class="docutils literal notranslate"><span class="pre">[[package.sources]]</span></code>
table defines a source entry, and its <code class="docutils literal notranslate"><span class="pre">include</span></code> patterns are relative to the
package root. The first entry adds files matching <code class="docutils literal notranslate"><span class="pre">hdl/src/*.vhd</span></code> to the
default library, <code class="docutils literal notranslate"><span class="pre">foo_lib</span></code>. The second adds <code class="docutils literal notranslate"><span class="pre">hdl/compat/*.vhd</span></code> to
<code class="docutils literal notranslate"><span class="pre">foo_compat</span></code> instead.</p>
<p>The final source entry is added only when all parts of its <code class="docutils literal notranslate"><span class="pre">when</span></code> condition
match: the selected VHDL standard is 2019 or later, the simulator is GHDL, and
the GHDL version is 6.0.0 or later. Otherwise, that entry’s source files are
skipped.</p>
<p>The package-level <code class="docutils literal notranslate"><span class="pre">compile_option</span></code> values shown apply to every source entry.
Each option is a two-element array containing an option name and an array of
string values. A source-level option, if specified, overrides the package-level
option with the same name for that entry.</p>
<p>The supported manifest fields are:</p>
<div class="table-wrapper colwidths-given docutils container">
<table class="docutils align-default">
<colgroup>
<col style="width: 24.0%" />
<col style="width: 20.0%" />
<col style="width: 56.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Field</p></th>
<th class="head"><p>Location</p></th>
<th class="head"><p>Meaning</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">requires</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[package]</span></code></p></td>
<td><p>Environment expression that must match before the package can be used.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">library</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[package]</span></code></p></td>
<td><p>Default library for package sources. Required when <code class="docutils literal notranslate"><span class="pre">sources</span></code> is
present. VUnit creates the library for the package.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">sources</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[[package.sources]]</span></code></p></td>
<td><p>Repeated source tables. Each table must contain <code class="docutils literal notranslate"><span class="pre">include</span></code>, an array
of source patterns relative to the package root.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">when</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[[package.sources]]</span></code></p></td>
<td><p>Optional environment expression that controls whether this source
entry is included.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">library</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[[package.sources]]</span></code></p></td>
<td><p>Optional library override for this source entry. VUnit creates the
library if needed.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">compile_option</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[package]</span></code> or <code class="docutils literal notranslate"><span class="pre">[[package.sources]]</span></code></p></td>
<td><p>Array of option-name/value-array pairs. Source-level options override
package-level options with the same name.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setup</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[package]</span></code></p></td>
<td><p>Optional Python setup function, specified as <code class="docutils literal notranslate"><span class="pre">"module:function"</span></code>.
See <a class="reference internal" href="#package-setup-function"><span class="std std-ref">Setup Function</span></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">requires-vunit</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[package]</span></code></p></td>
<td><p>Deprecated. Use <code class="docutils literal notranslate"><span class="pre">requires</span></code> to specify a VUnit version constraint.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">requires-vhdl</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">[package]</span></code></p></td>
<td><p>Deprecated. Use <code class="docutils literal notranslate"><span class="pre">requires</span></code> to specify a VHDL standard constraint.</p></td>
</tr>
</tbody>
</table>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">requires</span></code> and <code class="docutils literal notranslate"><span class="pre">when</span></code> expressions support the markers <code class="docutils literal notranslate"><span class="pre">vunit</span></code>,
<code class="docutils literal notranslate"><span class="pre">vhdl</span></code>, <code class="docutils literal notranslate"><span class="pre">simulator</span></code>, and the simulator version markers
<code class="docutils literal notranslate"><span class="pre">activehdl_version</span></code>, <code class="docutils literal notranslate"><span class="pre">ghdl_version</span></code>, <code class="docutils literal notranslate"><span class="pre">modelsim_version</span></code>,
<code class="docutils literal notranslate"><span class="pre">nvc_version</span></code>, and <code class="docutils literal notranslate"><span class="pre">rivierapro_version</span></code>. Values must be quoted strings.
Comparisons use <code class="docutils literal notranslate"><span class="pre">==</span></code>, <code class="docutils literal notranslate"><span class="pre">!=</span></code>, <code class="docutils literal notranslate"><span class="pre"><</span></code>, <code class="docutils literal notranslate"><span class="pre"><=</span></code>, <code class="docutils literal notranslate"><span class="pre">></span></code>, or <code class="docutils literal notranslate"><span class="pre">>=</span></code>. A simulator
version marker has a value only when its corresponding simulator is selected.
If a marker has no value, equality and inequality comparisons are supported
(<code class="docutils literal notranslate"><span class="pre">==</span></code> is false and <code class="docutils literal notranslate"><span class="pre">!=</span></code> is true); ordering comparisons are unavailable.</p>
<p>Comparisons can be combined with <code class="docutils literal notranslate"><span class="pre">and</span></code> and <code class="docutils literal notranslate"><span class="pre">or</span></code>, and parentheses can group
them. <code class="docutils literal notranslate"><span class="pre">and</span></code> has higher precedence than <code class="docutils literal notranslate"><span class="pre">or</span></code>; parentheses can override
that precedence. These operators short-circuit: <code class="docutils literal notranslate"><span class="pre">and</span></code> skips its second
comparison when the first is false, and <code class="docutils literal notranslate"><span class="pre">or</span></code> skips it when the first is
true. For example, in <code class="docutils literal notranslate"><span class="pre">simulator</span> <span class="pre">==</span> <span class="pre">"ghdl"</span> <span class="pre">and</span> <span class="pre">ghdl_version</span> <span class="pre">>=</span> <span class="pre">"6.0.0"</span></code>,
the GHDL version is checked only if GHDL is selected. If another simulator is
selected, the first comparison is false, so the version marker is not
evaluated while it has no value.</p>
<p><code class="docutils literal notranslate"><span class="pre">requires</span></code> determines whether the package can be used in the current
environment. <code class="docutils literal notranslate"><span class="pre">when</span></code> determines whether a particular source entry is
included. A source entry without <code class="docutils literal notranslate"><span class="pre">when</span></code> is included whenever the package
can be used.</p>
<p>The deprecated <code class="docutils literal notranslate"><span class="pre">requires-vunit</span></code> and <code class="docutils literal notranslate"><span class="pre">requires-vhdl</span></code> fields are still
supported, but new manifests should use <code class="docutils literal notranslate"><span class="pre">requires</span></code>.</p>
<p>VUnit uses the project’s VHDL standard when it satisfies <code class="docutils literal notranslate"><span class="pre">requires</span></code>. If not,
VUnit selects the closest supported VHDL standard that makes the full
<code class="docutils literal notranslate"><span class="pre">requires</span></code> expression match. A warning is issued when a different standard
is selected, and the package is compiled with that standard. For example, if
the project uses VHDL 2008 and the manifest has
<code class="docutils literal notranslate"><span class="pre">requires</span> <span class="pre">=</span> <span class="pre">'vhdl</span> <span class="pre">==</span> <span class="pre">"1993"'</span></code>, the package is compiled with VHDL 1993. If the
project uses VHDL 2019 and the manifest has <code class="docutils literal notranslate"><span class="pre">requires</span> <span class="pre">=</span> <span class="pre">'vhdl</span> <span class="pre"><=</span> <span class="pre">"2008"'</span></code>,
VUnit selects VHDL 2008, the closest supported standard that satisfies the
requirement.</p>
<p>Manifest validation is strict: unknown fields and values of the wrong type
are rejected.</p>
<section id="publishing">
<h2>Publishing<a class="headerlink" href="#publishing" title="Link to this heading">¶</a></h2>
<p>It is recommended to publish VUnit packages on PyPI and add the <code class="docutils literal notranslate"><span class="pre">vunitpkg</span></code>
keyword to the package metadata in <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code>. This makes VUnit
packages easier to identify and discover:</p>
<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span class="k">[project]</span>
<span class="n">keywords</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">"vunitpkg"</span><span class="p">]</span>
</pre></div>
</div>
</section>
<section id="setup-function">
<span id="package-setup-function"></span><h2>Setup Function<a class="headerlink" href="#setup-function" title="Link to this heading">¶</a></h2>
<p>Packages can be defined entirely in <cite>vunit_pkg.toml</cite>. For packages that need additional setup, such as building a
native library, generating sources, or configuring simulator options, the optional <cite>setup</cite> key specifies a Python
function in the format <cite>“module:function”</cite>:</p>
<div class="literal-block-wrapper docutils container" id="id3">
<div class="code-block-caption"><span class="caption-text">vunit_pkg.toml</span><a class="headerlink" href="#id3" title="Link to this code">¶</a></div>
<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span class="k">[package]</span>
<span class="n">library</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"foo_lib"</span>
<span class="n">setup</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"foo.vunit_setup:setup"</span>
<span class="k">[[package.sources]]</span>
<span class="n">include</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">"hdl/src/*.vhd"</span><span class="p">]</span>
</pre></div>
</div>
</div>
<p>The project must explicitly allow the setup function to run:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">vu</span><span class="o">.</span><span class="n">add_package</span><span class="p">(</span><span class="s2">"foo"</span><span class="p">,</span> <span class="n">allow_setup</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>If a package declares a setup function and <code class="docutils literal notranslate"><span class="pre">allow_setup=True</span></code> is not
provided, adding the package fails with an error identifying the function
that would have run. This makes permission to execute package setup code
explicit in the project’s run script. Packages that only list HDL sources
do not need a setup function.</p>
<p>After adding the sources listed in the manifest, VUnit imports the specified
module and calls the setup function with a
<a class="reference internal" href="py/vunit.html#vunit.package_context.PackageContext" title="vunit.package_context.PackageContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageContext</span></code></a>:</p>
<div class="literal-block-wrapper docutils container" id="id4">
<div class="code-block-caption"><span class="caption-text">foo/vunit_setup.py</span><a class="headerlink" href="#id4" title="Link to this code">¶</a></div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">setup</span><span class="p">(</span><span class="n">context</span><span class="p">):</span>
<span class="n">build_dir</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="n">output_path</span> <span class="o">/</span> <span class="s2">"foo"</span>
<span class="n">build_native_library</span><span class="p">(</span><span class="n">context</span><span class="o">.</span><span class="n">package_root</span> <span class="o">/</span> <span class="s2">"c"</span><span class="p">,</span> <span class="n">build_dir</span><span class="p">)</span>
<span class="n">context</span><span class="o">.</span><span class="n">add_source_files</span><span class="p">(</span><span class="s2">"foo_lib"</span><span class="p">,</span> <span class="n">build_dir</span> <span class="o">/</span> <span class="s2">"*.vhd"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p>The context provides the package root, the default library created for the package,
the VHDL standard used for its sources, the VUnit output path, the run script
path, and information about the selected simulator. Exceptions raised by
the setup function are reported as package errors.</p>
<p>A package that builds against a simulator installation needs information
about that installation during setup, before VUnit creates the simulator
interface. The context exposes this information through the following
attributes:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">context.simulator_class</span></code> is the selected simulator interface class.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">context.simulator_name</span></code> is the selected simulator’s name.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">context.simulator_prefix</span></code> is the directory containing the selected
simulator’s executables.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">context.simulator_backend</span></code> identifies the installation’s backend,
where applicable. For GHDL, this is the code generator: <code class="docutils literal notranslate"><span class="pre">"mcode"</span></code>,
<code class="docutils literal notranslate"><span class="pre">"llvm"</span></code>, <code class="docutils literal notranslate"><span class="pre">"llvm-jit"</span></code>, or <code class="docutils literal notranslate"><span class="pre">"gcc"</span></code>. For simulators without a backend
distinction, it is <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p></li>
</ul>
<p>Both <code class="docutils literal notranslate"><span class="pre">simulator_class</span></code> and <code class="docutils literal notranslate"><span class="pre">simulator_name</span></code> are <code class="docutils literal notranslate"><span class="pre">None</span></code> when no simulator
is found.</p>
</section>
<section id="simulator-hooks">
<h2>Simulator Hooks<a class="headerlink" href="#simulator-hooks" title="Link to this heading">¶</a></h2>
<p>A package’s HDL sources may depend on a native library or generated files.
The simulator may need additional flags or environment variables to locate
and use these dependencies.</p>
<p>Use <code class="docutils literal notranslate"><span class="pre">context.register_simulator_hooks(simulator_name,</span> <span class="pre">...)</span></code> to register
functions that supply these settings for a particular simulator. Hooks
receive the simulator interface, so they can adapt their results to its
configuration. They apply only to the project in which they are registered,
that is to the tests of the VUnit object the package is added to. Creating
another VUnit object neither removes them nor gives them to the new object.</p>
<p>The following example builds a native library and registers hooks to load
it with NVC or link it with GHDL:</p>
<div class="literal-block-wrapper docutils container" id="id5">
<div class="code-block-caption"><span class="caption-text">foo/vunit_setup.py</span><a class="headerlink" href="#id5" title="Link to this code">¶</a></div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">setup</span><span class="p">(</span><span class="n">context</span><span class="p">):</span>
<span class="n">library</span> <span class="o">=</span> <span class="n">build_native_library</span><span class="p">(</span>
<span class="n">context</span><span class="o">.</span><span class="n">package_root</span> <span class="o">/</span> <span class="s2">"c"</span><span class="p">,</span>
<span class="n">context</span><span class="o">.</span><span class="n">output_path</span> <span class="o">/</span> <span class="s2">"foo"</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">context</span><span class="o">.</span><span class="n">register_simulator_hooks</span><span class="p">(</span>
<span class="s2">"nvc"</span><span class="p">,</span>
<span class="n">run_flags</span><span class="o">=</span><span class="k">lambda</span> <span class="n">simulator_interface</span><span class="p">:</span> <span class="p">[</span><span class="sa">f</span><span class="s2">"--load=</span><span class="si">{</span><span class="n">library</span><span class="si">}</span><span class="s2">"</span><span class="p">],</span>
<span class="p">)</span>
<span class="n">context</span><span class="o">.</span><span class="n">register_simulator_hooks</span><span class="p">(</span>
<span class="s2">"ghdl"</span><span class="p">,</span>
<span class="n">elab_flags</span><span class="o">=</span><span class="k">lambda</span> <span class="n">simulator_interface</span><span class="p">:</span> <span class="p">[</span><span class="sa">f</span><span class="s2">"-Wl,</span><span class="si">{</span><span class="n">library</span><span class="si">}</span><span class="s2">"</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<p>The GHDL hook above assumes a backend that links native libraries during
elaboration. Backend-specific hooks are described below.</p>
<p>Four hook types are available, with support depending on the simulator:</p>
<div class="table-wrapper colwidths-given docutils container">
<table class="docutils align-default">
<colgroup>
<col style="width: 20.0%" />
<col style="width: 45.0%" />
<col style="width: 35.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Hook</p></th>
<th class="head"><p>Return value</p></th>
<th class="head"><p>Supported simulators</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">elab_flags(simulator_interface)</span></code></p></td>
<td><p>Additional flags for test elaboration.</p></td>
<td><p>GHDL, NVC, and ModelSim/Questa. ModelSim/Questa passes these flags
to <code class="docutils literal notranslate"><span class="pre">vopt</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">run_flags(simulator_interface)</span></code></p></td>
<td><p>Additional flags for test simulation.</p></td>
<td><p>All simulators. For simulators based on <code class="docutils literal notranslate"><span class="pre">vsim</span></code>, these flags are
added to the <code class="docutils literal notranslate"><span class="pre">vsim</span></code> command in the generated do-file.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">process_flags(simulator_interface)</span></code></p></td>
<td><p>Additional command-line flags for the simulator process started
by VUnit.</p></td>
<td><p>ModelSim/Questa and Riviera-PRO, for both persistent and batch
<code class="docutils literal notranslate"><span class="pre">vsim</span></code> processes.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">run_env(simulator_interface,</span> <span class="pre">env)</span></code></p></td>
<td><p>The simulation environment, based on the environment supplied
in <code class="docutils literal notranslate"><span class="pre">env</span></code>.</p></td>
<td><p>GHDL and NVC, and the <code class="docutils literal notranslate"><span class="pre">vsim</span></code> process for ModelSim/Questa and
Riviera-PRO.</p></td>
</tr>
</tbody>
</table>
</div>
<p>For simulators based on <code class="docutils literal notranslate"><span class="pre">vsim</span></code>, <code class="docutils literal notranslate"><span class="pre">run_flags</span></code> and <code class="docutils literal notranslate"><span class="pre">process_flags</span></code> target
different commands:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">run_flags</span></code> adds options to the <code class="docutils literal notranslate"><span class="pre">vsim</span></code> command inside the generated
do-file. Use it for options that control what is loaded into the simulation.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">process_flags</span></code> adds options to the command line used to start the
<code class="docutils literal notranslate"><span class="pre">vsim</span></code> process. Use it for options that configure the process itself.</p></li>
</ul>
<p>For example, Questa’s <code class="docutils literal notranslate"><span class="pre">-noautoldlibpath</span></code> option prevents bundled runtime
libraries from being added to the dynamic library search path. It is only
honoured on the process command line, so it belongs in <code class="docutils literal notranslate"><span class="pre">process_flags</span></code>.</p>
<p>VUnit evaluates <code class="docutils literal notranslate"><span class="pre">process_flags</span></code> and <code class="docutils literal notranslate"><span class="pre">run_env</span></code> when it constructs the
simulator interface. These hooks must therefore be registered before the
interface is created. Registering them in a package setup function meets
this requirement: setup runs during
<a class="reference internal" href="py/vunit.html#vunit.ui.VUnit.add_package" title="vunit.ui.VUnit.add_package"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_package()</span></code></a>, before
<a class="reference internal" href="py/vunit.html#vunit.ui.VUnit.main" title="vunit.ui.VUnit.main"><code class="xref py py-meth docutils literal notranslate"><span class="pre">main()</span></code></a> creates the interface.</p>
<p>Hooks can also inspect the simulator installation through the interface
they receive. The <code class="docutils literal notranslate"><span class="pre">simulator_interface.prefix</span></code> attribute contains the
directory of the simulator executables, matching
<code class="docutils literal notranslate"><span class="pre">context.simulator_prefix</span></code> from the setup function.</p>
<p>For GHDL, <code class="docutils literal notranslate"><span class="pre">GHDLInterface.backend</span></code> identifies the code generator:
<code class="docutils literal notranslate"><span class="pre">"mcode"</span></code>, <code class="docutils literal notranslate"><span class="pre">"llvm"</span></code>, <code class="docutils literal notranslate"><span class="pre">"llvm-jit"</span></code>, or <code class="docutils literal notranslate"><span class="pre">"gcc"</span></code>. This determines how
native libraries are bound to the design. The <code class="docutils literal notranslate"><span class="pre">"llvm"</span></code> and <code class="docutils literal notranslate"><span class="pre">"gcc"</span></code>
backends link them during elaboration; the other backends load them at
runtime.</p>
<p>A hook can use this information to return flags only for the relevant
backends. For example, with <code class="docutils literal notranslate"><span class="pre">library</span></code> referring to the built native
library, this hook adds a linker search path only for <code class="docutils literal notranslate"><span class="pre">"llvm"</span></code> and
<code class="docutils literal notranslate"><span class="pre">"gcc"</span></code>:</p>
<div class="literal-block-wrapper docutils container" id="id6">
<div class="code-block-caption"><span class="caption-text">foo/vunit_setup.py</span><a class="headerlink" href="#id6" title="Link to this code">¶</a></div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">elab_flags</span><span class="p">(</span><span class="n">simulator_interface</span><span class="p">):</span>
<span class="k">if</span> <span class="n">simulator_interface</span><span class="o">.</span><span class="n">backend</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"llvm"</span><span class="p">,</span> <span class="s2">"gcc"</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="k">return</span> <span class="p">[</span><span class="sa">f</span><span class="s2">"-Wl,-L</span><span class="si">{</span><span class="n">library</span><span class="o">.</span><span class="n">parent</span><span class="si">}</span><span class="s2">"</span><span class="p">]</span>
</pre></div>
</div>
</div>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="examples.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Examples</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="hdl_libraries.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">HDL Libraries</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2014-2026, Lars Asplund
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
<a class="muted-link fa-solid fa-brands fa-twitter" href="https://twitter.com/VUnitFramework" aria-label="Twitter @VUnitFramework"></a>
<a class="muted-link fa-solid fa-brands fa-gitter" href="https://gitter.im/VUnit/vunit" aria-label="Gitter VUnit/vunit"></a>
<a class="muted-link fa-solid fa-brands fa-github" href="https://github.com/VUnit/vunit" aria-label="GitHub VUnit/vunit"></a>
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">VUnit Packages</a><ul>
<li><a class="reference internal" href="#publishing">Publishing</a></li>
<li><a class="reference internal" href="#setup-function">Setup Function</a></li>
<li><a class="reference internal" href="#simulator-hooks">Simulator Hooks</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
</body>
</html>