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
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
|
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Verilator - Translate and simulate SystemVerilog code using C++/SystemC</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#ARGUMENT-SUMMARY">ARGUMENT SUMMARY</a></li>
<li><a href="#VERILATION-ARGUMENTS">VERILATION ARGUMENTS</a></li>
<li><a href="#SIMULATION-RUNTIME-ARGUMENTS">SIMULATION RUNTIME ARGUMENTS</a></li>
<li><a href="#EXAMPLE-C-EXECUTION">EXAMPLE C++ EXECUTION</a></li>
<li><a href="#EXAMPLE-SYSTEMC-EXECUTION">EXAMPLE SYSTEMC EXECUTION</a></li>
<li><a href="#EVALUATION-LOOP">EVALUATION LOOP</a></li>
<li><a href="#BENCHMARKING-OPTIMIZATION">BENCHMARKING & OPTIMIZATION</a></li>
<li><a href="#FILES">FILES</a></li>
<li><a href="#ENVIRONMENT">ENVIRONMENT</a></li>
<li><a href="#CONNECTING-TO-C">CONNECTING TO C++</a></li>
<li><a href="#CONNECTING-TO-SYSTEMC">CONNECTING TO SYSTEMC</a></li>
<li><a href="#DIRECT-PROGRAMMING-INTERFACE-DPI">DIRECT PROGRAMMING INTERFACE (DPI)</a>
<ul>
<li><a href="#DPI-Example">DPI Example</a></li>
<li><a href="#DPI-System-Task-Functions">DPI System Task/Functions</a></li>
<li><a href="#DPI-Display-Functions">DPI Display Functions</a></li>
<li><a href="#DPI-Context-Functions">DPI Context Functions</a></li>
<li><a href="#DPI-Header-Isolation">DPI Header Isolation</a></li>
<li><a href="#Public-Functions">Public Functions</a></li>
</ul>
</li>
<li><a href="#VERIFICATION-PROCEDURAL-INTERFACE-VPI">VERIFICATION PROCEDURAL INTERFACE (VPI)</a>
<ul>
<li><a href="#VPI-Example">VPI Example</a></li>
</ul>
</li>
<li><a href="#CROSS-COMPILATION">CROSS COMPILATION</a>
<ul>
<li><a href="#CMake">CMake</a></li>
</ul>
</li>
<li><a href="#MULTITHREADING">MULTITHREADING</a>
<ul>
<li><a href="#Multithreaded-Verilog-and-Library-Support">Multithreaded Verilog and Library Support</a></li>
</ul>
</li>
<li><a href="#CONFIGURATION-FILES">CONFIGURATION FILES</a></li>
<li><a href="#LANGUAGE-STANDARD-SUPPORT">LANGUAGE STANDARD SUPPORT</a>
<ul>
<li><a href="#Verilog-2001-IEEE-1364-2001-Support">Verilog 2001 (IEEE 1364-2001) Support</a></li>
<li><a href="#Verilog-2005-IEEE-1364-2005-Support">Verilog 2005 (IEEE 1364-2005) Support</a></li>
<li><a href="#SystemVerilog-2005-IEEE-1800-2005-Support">SystemVerilog 2005 (IEEE 1800-2005) Support</a></li>
<li><a href="#SystemVerilog-2012-IEEE-1800-2012-Support">SystemVerilog 2012 (IEEE 1800-2012) Support</a></li>
<li><a href="#SystemVerilog-2017-IEEE-1800-2017-Support">SystemVerilog 2017 (IEEE 1800-2017) Support</a></li>
<li><a href="#Verilog-AMS-Support">Verilog AMS Support</a></li>
<li><a href="#Synthesis-Directive-Assertion-Support">Synthesis Directive Assertion Support</a></li>
</ul>
</li>
<li><a href="#LANGUAGE-EXTENSIONS">LANGUAGE EXTENSIONS</a></li>
<li><a href="#LANGUAGE-LIMITATIONS">LANGUAGE LIMITATIONS</a>
<ul>
<li><a href="#Synthesis-Subset">Synthesis Subset</a></li>
<li><a href="#Signal-Naming">Signal Naming</a></li>
<li><a href="#Bind">Bind</a></li>
<li><a href="#Class">Class</a></li>
<li><a href="#Dotted-cross-hierarchy-references">Dotted cross-hierarchy references</a></li>
<li><a href="#Latches">Latches</a></li>
<li><a href="#Structures-and-Unions">Structures and Unions</a></li>
<li><a href="#Time">Time</a></li>
<li><a href="#Unknown-states">Unknown states</a></li>
<li><a href="#Tri-Inout">Tri/Inout</a></li>
<li><a href="#Functions-Tasks">Functions & Tasks</a></li>
<li><a href="#Generated-Clocks">Generated Clocks</a></li>
<li><a href="#Gate-Primitives">Gate Primitives</a></li>
<li><a href="#Specify-blocks">Specify blocks</a></li>
<li><a href="#Array-Initialization">Array Initialization</a></li>
<li><a href="#Array-Out-of-Bounds">Array Out of Bounds</a></li>
<li><a href="#Assertions">Assertions</a></li>
<li><a href="#Encrypted-Verilog">Encrypted Verilog</a></li>
<li><a href="#Language-Keyword-Limitations">Language Keyword Limitations</a></li>
</ul>
</li>
<li><a href="#ERRORS-AND-WARNINGS">ERRORS AND WARNINGS</a>
<ul>
<li><a href="#Error-and-Warning-Format">Error and Warning Format</a></li>
<li><a href="#List-of-all-warnings">List of all warnings</a></li>
</ul>
</li>
<li><a href="#DEPRECATIONS">DEPRECATIONS</a></li>
<li><a href="#FAQ-FREQUENTLY-ASKED-QUESTIONS">FAQ/FREQUENTLY ASKED QUESTIONS</a></li>
<li><a href="#BUGS">BUGS</a></li>
<li><a href="#HISTORY">HISTORY</a></li>
<li><a href="#AUTHORS">AUTHORS</a></li>
<li><a href="#CONTRIBUTORS">CONTRIBUTORS</a></li>
<li><a href="#DISTRIBUTION">DISTRIBUTION</a></li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Verilator - Translate and simulate SystemVerilog code using C++/SystemC</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code> verilator --help
verilator --version
verilator --cc [options] [source_files.v]... [opt_c_files.cpp/c/cc/a/o/so]
verilator --sc [options] [source_files.v]... [opt_c_files.cpp/c/cc/a/o/so]
verilator --lint-only -Wall [source_files.v]...</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>The "Verilator" package converts all synthesizable, and many behavioral, Verilog and SystemVerilog designs into a C++ or SystemC model that after compiling can be executed. Verilator is not a traditional simulator, but a compiler.</p>
<p>Verilator is typically used as follows:</p>
<p>1. The <code>verilator</code> executable is invoked with parameters similar to GCC, Cadence Verilog-XL/NC-Verilog, or Synopsys VCS. <code>verilator</code> reads the specified user's SystemVerilog code, lints it, optionally adds coverage and waveform tracing support, and compiles the design into a source level C++ or SystemC "model". The resulting model's C++ or SystemC code is output as .cpp and .h files. This is referred to as "verilating" and the process is "to verilate"; the output is a "verilated" model.</p>
<p>2. For simulation, a small user written C++ wrapper file is required, the "wrapper". This wrapper defines the C++ function `main()` which instantiates the Verilated model as a C++/SystemC object.</p>
<p>3. The user main wrapper, the files created by Verilator, a "runtime library" provided by Verilator, and if applicable the SystemC libraries are then compiled using a C++ compiler to create a simulation executable.</p>
<p>4. The resulting executable will perform the actual simulation, during "simulation runtime".</p>
<p>To get started, jump down to the <a href="#EXAMPLE-C-EXECUTION">"EXAMPLE C++ EXECUTION"</a> section.</p>
<h1 id="ARGUMENT-SUMMARY">ARGUMENT SUMMARY</h1>
<p>This is a short summary of the arguments to the "verilator" executable. See <a href="#VERILATION-ARGUMENTS">"VERILATION ARGUMENTS"</a> for the detailed descriptions of these arguments.</p>
<pre><code> {file.v} Verilog package, module and top module filenames
{file.c/cc/cpp} Optional C++ files to compile in
{file.a/o/so} Optional C++ files to link in
+1364-1995ext+<ext> Use Verilog 1995 with file extension <ext>
+1364-2001ext+<ext> Use Verilog 2001 with file extension <ext>
+1364-2005ext+<ext> Use Verilog 2005 with file extension <ext>
+1800-2005ext+<ext> Use SystemVerilog 2005 with file extension <ext>
+1800-2009ext+<ext> Use SystemVerilog 2009 with file extension <ext>
+1800-2012ext+<ext> Use SystemVerilog 2012 with file extension <ext>
+1800-2017ext+<ext> Use SystemVerilog 2017 with file extension <ext>
--assert Enable all assertions
--autoflush Flush streams after all $displays
--bbox-sys Blackbox unknown $system calls
--bbox-unsup Blackbox unsupported language features
--bin <filename> Override Verilator binary
--build Build model executable/library after Verilation
-CFLAGS <flags> C++ compiler flags for makefile
--cc Create C++ output
--cdc Clock domain crossing analysis
--clk <signal-name> Mark specified signal as clock
--make <build-tool> Generate scripts for specified build tool
--compiler <compiler-name> Tune for specified C++ compiler
--converge-limit <loops> Tune convergence settle time
--coverage Enable all coverage
--coverage-line Enable line coverage
--coverage-toggle Enable toggle coverage
--coverage-user Enable SVL user coverage
--coverage-underscore Enable coverage of _signals
-D<var>[=<value>] Set preprocessor define
--debug Enable debugging
--debug-check Enable debugging assertions
--no-debug-leak Disable leaking memory in --debug mode
--debugi <level> Enable debugging at a specified level
--debugi-<srcfile> <level> Enable debugging a source file at a level
--default-language <lang> Default language to parse
+define+<var>=<value> Set preprocessor define
--dpi-hdr-only Only produce the DPI header file
--dump-defines Show preprocessor defines with -E
--dump-tree Enable dumping .tree files
--dump-treei <level> Enable dumping .tree files at a level
--dump-treei-<srcfile> <level> Enable dumping .tree file at a source file at a level
--dump-tree-addrids Use short identifiers instead of addresses
-E Preprocess, but do not compile
--error-limit <value> Abort after this number of errors
--exe Link to create executable
-F <file> Parse options from a file, relatively
-f <file> Parse options from a file
-FI <file> Force include of a file
--flatten Force inlining of all modules, tasks and functions
-G<name>=<value> Overwrite top-level parameter
--gdb Run Verilator under GDB interactively
--gdbbt Run Verilator under GDB for backtrace
--generate-key Create random key for --protect-key
--getenv <var> Get environment variable with defaults
--help Display this help
-I<dir> Directory to search for includes
-j <jobs> Parallelism for --build
--gate-stmts <value> Tune gate optimizer depth
--if-depth <value> Tune IFDEPTH warning
+incdir+<dir> Directory to search for includes
--inhibit-sim Create function to turn off sim
--inline-mult <value> Tune module inlining
-LDFLAGS <flags> Linker pre-object flags for makefile
--l2-name <value> Verilog scope name of the top module
--language <lang> Default language standard to parse
+libext+<ext>+[ext]... Extensions for finding modules
--lint-only Lint, but do not make output
-MAKEFLAGS <flags> Options to make during --build
--max-num-width <value> Maximum number width (default: 64K)
--MMD Create .d dependency files
--MP Create phony dependency targets
--Mdir <directory> Name of output object directory
--mod-prefix <topname> Name to prepend to lower classes
--no-clk <signal-name> Prevent marking specified signal as clock
--no-decoration Disable comments and symbol decorations
--no-pins64 Don't use vluint64_t's for 33-64 bit sigs
--no-skip-identical Disable skipping identical output
+notimingchecks Ignored
-O0 Disable optimizations
-O3 High performance optimizations
-O<optimization-letter> Selectable optimizations
-o <executable> Name of final executable
--no-order-clock-delay Disable ordering clock enable assignments
--no-verilate Skip verilation and just compile previously Verilated code.
--output-split <statements> Split .cpp files into pieces
--output-split-cfuncs <statements> Split model functions
--output-split-ctrace <statements> Split tracing functions
-P Disable line numbers and blanks with -E
--pins-bv <bits> Specify types for top level ports
--pins-sc-uint Specify types for top level ports
--pins-sc-biguint Specify types for top level ports
--pins-uint8 Specify types for top level ports
--pipe-filter <command> Filter all input through a script
--pp-comments Show preprocessor comments with -E
--prefix <topname> Name of top level class
--prof-cfuncs Name functions for profiling
--prof-threads Enable generating gantt chart data for threads
--protect-key <key> Key for symbol protection
--protect-ids Hash identifier names for obscurity
--protect-lib <name> Create a DPI protected library
--private Debugging; see docs
--public Debugging; see docs
--public-flat-rw Mark all variables, etc as public_flat_rw
-pvalue+<name>=<value> Overwrite toplevel parameter
--quiet-exit Don't print the command on failure
--relative-includes Resolve includes relative to current file
--no-relative-cfuncs Disallow 'this->' in generated functions
--report-unoptflat Extra diagnostics for UNOPTFLAT
--rr Run Verilator and record with rr
--savable Enable model save-restore
--sc Create SystemC output
--stats Create statistics file
--stats-vars Provide statistics on variables
-sv Enable SystemVerilog parsing
+systemverilogext+<ext> Synonym for +1800-2017ext+<ext>
--threads <threads> Enable multithreading
--threads-dpi <mode> Enable multithreaded DPI
--threads-max-mtasks <mtasks> Tune maximum mtask partitioning
--timescale <timescale> Sets default timescale
--timescale-override <timescale> Overrides all timescales
--top-module <topname> Name of top level input module
--trace Enable waveform creation
--trace-coverage Enable tracing of coverage
--trace-depth <levels> Depth of tracing
--trace-fst Enable FST waveform creation
--trace-max-array <depth> Maximum bit width for tracing
--trace-max-width <width> Maximum array depth for tracing
--trace-params Enable tracing of parameters
--trace-structs Enable tracing structure names
--trace-threads <threads> Enable waveform creation on separate threads
--trace-underscore Enable tracing of _signals
-U<var> Undefine preprocessor define
--unroll-count <loops> Tune maximum loop iterations
--unroll-stmts <stmts> Tune maximum loop body size
--unused-regexp <regexp> Tune UNUSED lint signals
-V Verbose version and config
-v <filename> Verilog library
+verilog1995ext+<ext> Synonym for +1364-1995ext+<ext>
+verilog2001ext+<ext> Synonym for +1364-2001ext+<ext>
--version Displays program version and exits
--vpi Enable VPI compiles
--waiver-output <filename> Create a waiver file based on the linter warnings
-Wall Enable all style warnings
-Werror-<message> Convert warnings to errors
-Wfuture-<message> Disable unknown message warnings
-Wno-<message> Disable warning
-Wno-context Disable source context on warnings
-Wno-fatal Disable fatal exit on warnings
-Wno-lint Disable all lint warnings
-Wno-style Disable all style warnings
-Wpedantic Warn on compliance-test issues
--x-assign <mode> Assign non-initial Xs to this value
--x-initial <mode> Assign initial Xs to this value
--x-initial-edge Enable initial X->0 and X->1 edge triggers
--xml-only Create XML parser output
--xml-output XML output filename
-y <dir> Directory to search for modules</code></pre>
<p>This is a short summary of the simulation runtime arguments, i.e. for the final Verilated simulation runtime models. See <a href="#SIMULATION-RUNTIME-ARGUMENTS">"SIMULATION RUNTIME ARGUMENTS"</a> for the detailed description of these arguments.</p>
<pre><code> +verilator+debug Enable debugging
+verilator+debugi+<value> Enable debugging at a level
+verilator+help Display help
+verilator+prof+threads+file+I<filename> Set profile filename
+verilator+prof+threads+start+I<value> Set profile starting point
+verilator+prof+threads+window+I<value> Set profile duration
+verilator+rand+reset+I<value> Set random reset technique
+verilator+seed+I<value> Set random seed
+verilator+noassert Disable assert checking
+verilator+V Verbose version and config
+verilator+version Show version and exit</code></pre>
<h1 id="VERILATION-ARGUMENTS">VERILATION ARGUMENTS</h1>
<p>The following are the arguments that may be passed to the "verilator" executable.</p>
<dl>
<dt id="file.v">{file.v}</dt>
<dd>
<p>Specifies the Verilog file containing the top module to be Verilated.</p>
</dd>
<dt id="file.c-.cc-.cpp-.cxx">{file.c/.cc/.cpp/.cxx}</dt>
<dd>
<p>Used with --exe to specify optional C++ files to be linked in with the Verilog code. The file path should either be absolute, or relative to where the make will be executed from, or add to your makefile's VPATH the appropriate directory to find the file.</p>
<p>See also the -CFLAGS and -LDFLAGS options, which are useful when the C++ files need special compiler flags.</p>
</dd>
<dt id="file.a-.o-.so">{file.a/.o/.so}</dt>
<dd>
<p>Specifies optional object or library files to be linked in with the Verilog code, as a shorthand for -LDFLAGS "<file>". The file path should either be absolute, or relative to where the make will be executed from, or add to your makefile's VPATH the appropriate directory to find the file.</p>
<p>If any files are specified in this way, Verilator will include a make rule that uses these files when linking the <i>module</i> executable. This generally is only useful when used with the --exe option.</p>
</dd>
<dt id="ext-ext">+1364-1995ext+<i>ext</i></dt>
<dd>
</dd>
<dt id="ext-ext1">+1364-2001ext+<i>ext</i></dt>
<dd>
</dd>
<dt id="ext-ext2">+1364-2005ext+<i>ext</i></dt>
<dd>
</dd>
<dt id="ext-ext3">+1800-2005ext+<i>ext</i></dt>
<dd>
</dd>
<dt id="ext-ext4">+1800-2009ext+<i>ext</i></dt>
<dd>
</dd>
<dt id="ext-ext5">+1800-2012ext+<i>ext</i></dt>
<dd>
</dd>
<dt id="ext-ext6">+1800-2017ext+<i>ext</i></dt>
<dd>
<p>Specifies the language standard to be used with a specific filename extension, <i>ext</i>.</p>
<p>For compatibility with other simulators, see also the synonyms <code>+verilog1995ext+</code><i>ext</i>, <code>+verilog2001ext+</code><i>ext</i>, and <code>+systemverilogext+</code><i>ext</i>.</p>
<p>For any source file, the language specified by these options takes precedence over any language specified by the <code>--default-language</code> or <code>--language</code> options.</p>
<p>These options take effect in the order they are encountered. Thus the following would use Verilog 1995 for <code>a.v</code> and Verilog 2001 for <code>b.v</code>.</p>
<pre><code> verilator ... +1364-1995ext+v a.v +1364-2001ext+v b.v</code></pre>
<p>These flags are only recommended for legacy mixed language designs, as the preferable option is to edit the code to repair new keywords, or add appropriate <code>`begin_keywords</code>.</p>
<p><b>Note</b> <code>`begin_keywords</code> is a SystemVerilog construct, which specifies <i>only</i> the set of keywords to be recognized. This also controls some error messages that vary between language standards. Note at present Verilator tends to be overly permissive, e.g. it will accept many grammar and other semantic extensions which might not be legal when set to an older standard.</p>
</dd>
<dt id="assert">--assert</dt>
<dd>
<p>Enable all assertions.</p>
</dd>
<dt id="autoflush">--autoflush</dt>
<dd>
<p>After every $display or $fdisplay, flush the output stream. This ensures that messages will appear immediately but may reduce performance. For best performance call "fflush(stdout)" occasionally in the C++ main loop. Defaults to off, which will buffer output as provided by the normal C/C++ standard library IO.</p>
</dd>
<dt id="bbox-sys">--bbox-sys</dt>
<dd>
<p>Black box any unknown $system task or function calls. System tasks will simply become no-operations, and system functions will be replaced with unsized zero. Arguments to such functions will be parsed, but not otherwise checked. This prevents errors when linting in the presence of company specific PLI calls.</p>
<p>Using this argument will likely cause incorrect simulation.</p>
</dd>
<dt id="bbox-unsup">--bbox-unsup</dt>
<dd>
<p>Black box some unsupported language features, currently UDP tables, the cmos and tran gate primitives, deassign statements, and mixed edge errors. This may enable linting the rest of the design even when unsupported constructs are present.</p>
<p>Using this argument will likely cause incorrect simulation.</p>
</dd>
<dt id="bin-filename">--bin <i>filename</i></dt>
<dd>
<p>Rarely needed. Override the default filename for Verilator itself. When a dependency (.d) file is created, this filename will become a source dependency, such that a change in this binary will have make rebuild the output files.</p>
</dd>
<dt id="build">--build</dt>
<dd>
<p>After generating the SystemC/C++ code, Verilator will invoke the toolchain to build the model library (and executable when <code>--exe</code> is also used). Verilator manages the build itself, and for this --build requires GNU Make to be available on the platform.</p>
</dd>
<dt id="CFLAGS-flags">-CFLAGS <i>flags</i></dt>
<dd>
<p>Add specified C compiler flag to the generated makefiles. For multiple flags either pass them as a single argument with space separators quoted in the shell (<code>-CFLAGS "-a -b"</code>), or use multiple -CFLAGS arguments (<code>-CFLAGS -a -CFLAGS -b</code>).</p>
<p>When make is run on the generated makefile these will be passed to the C++ compiler (g++/clang++/msvc++).</p>
</dd>
<dt id="cc">--cc</dt>
<dd>
<p>Specifies C++ without SystemC output mode; see also --sc.</p>
</dd>
<dt id="cdc">--cdc</dt>
<dd>
<p>Permanently experimental. Perform some clock domain crossing checks and issue related warnings (CDCRSTLOGIC) and then exit; if warnings other than CDC warnings are needed make a second run with --lint-only. Additional warning information is also written to the file {prefix}__cdc.txt.</p>
<p>Currently only checks some items that other CDC tools missed; if you have interest in adding more traditional CDC checks, please contact the authors.</p>
</dd>
<dt id="clk-signal-name">--clk <i>signal-name</i></dt>
<dd>
<p>Sometimes it is quite difficult for Verilator to distinguish clock signals from other data signals. Occasionally the clock signals can end up in the checking list of signals which determines if further evaluation is needed. This will heavily degrade the performance of a Verilated model.</p>
<p>With --clk <signal-name>, user can specified root clock into the model, then Verilator will mark the signal as clocker and propagate the clocker attribute automatically to other signals derived from that. In this way, Verilator will try to avoid taking the clocker signal into checking list.</p>
<p>Note signal-name is specified by the RTL hierarchy path. For example, v.foo.bar. If the signal is the input to top-module, the directly the signal name. If you find it difficult to find the exact name, try to use <code>/*verilator clocker*/</code> in RTL file to mark the signal directly.</p>
<p>If clock signals are assigned to vectors and then later used individually, Verilator will attempt to decompose the vector and connect the single-bit clock signals directly. This should be transparent to the user.</p>
</dd>
<dt id="make-build-tool">--make <i>build-tool</i></dt>
<dd>
<p>Generates a script for the specified build tool.</p>
<p>Supported values are <code>gmake</code> for GNU Make and <code>cmake</code> for CMake. Both can be specified together. If no build tool is specified, gmake is assumed. The executable of gmake can be configured via environment variable "MAKE".</p>
<p>When using --build Verilator takes over the responsibility of building the model library/executable. For this reason --make cannot be specified when using --build.</p>
</dd>
<dt id="compiler-compiler-name">--compiler <i>compiler-name</i></dt>
<dd>
<p>Enables workarounds for the specified C++ compiler, either <code>clang</code>, <code>gcc</code>, or <code>msvc</code>. Currently this does not change any performance tuning flags, but it may in the future.</p>
<dl>
<dt id="clang">clang</dt>
<dd>
<p>Tune for clang. This may reduce execution speed as it enables several workarounds to avoid silly hard-coded limits in clang. This includes breaking deep structures as for msvc as described below.</p>
</dd>
<dt id="gcc">gcc</dt>
<dd>
<p>Tune for GNU C++, although generated code should work on almost any compliant C++ compiler. Currently the default.</p>
</dd>
<dt id="msvc">msvc</dt>
<dd>
<p>Tune for Microsoft Visual C++. This may reduce execution speed as it enables several workarounds to avoid silly hard-coded limits in MSVC++. This includes breaking deeply nested parenthesized expressions into sub-expressions to avoid error C1009, and breaking deep blocks into functions to avoid error C1061.</p>
</dd>
</dl>
</dd>
<dt id="converge-limit-loops">--converge-limit <i>loops</i></dt>
<dd>
<p>Rarely needed. Specifies the maximum number of runtime iterations before creating a model failed to converge error. Defaults to 100.</p>
</dd>
<dt id="coverage">--coverage</dt>
<dd>
<p>Enables all forms of coverage, alias for "--coverage-line --coverage-toggle --coverage-user".</p>
</dd>
<dt id="coverage-line">--coverage-line</dt>
<dd>
<p>Specifies basic block line coverage analysis code should be inserted.</p>
<p>Coverage analysis adds statements at each code flow change point (e.g. at branches). At each such branch a unique counter is incremented. At the end of a test, the counters along with the filename and line number corresponding to each counter are written into logs/coverage.dat.</p>
<p>Verilator automatically disables coverage of branches that have a $stop in them, as it is assumed $stop branches contain an error check that should not occur. A /*verilator coverage_block_off*/ comment will perform a similar function on any code in that block or below, or /*verilator coverage_on/coverage_off*/ will disable coverage around lines of code.</p>
<p>Note Verilator may over-count combinatorial (non-clocked) blocks when those blocks receive signals which have had the UNOPTFLAT warning disabled; for most accurate results do not disable this warning when using coverage.</p>
</dd>
<dt id="coverage-toggle">--coverage-toggle</dt>
<dd>
<p>Specifies signal toggle coverage analysis code should be inserted.</p>
<p>Every bit of every signal in a module has a counter inserted. The counter will increment on every edge change of the corresponding bit.</p>
<p>Signals that are part of tasks or begin/end blocks are considered local variables and are not covered. Signals that begin with underscores, are integers, or are very wide (>256 bits total storage across all dimensions) are also not covered.</p>
<p>Hierarchy is compressed, such that if a module is instantiated multiple times, coverage will be summed for that bit across ALL instantiations of that module with the same parameter set. A module instantiated with different parameter values is considered a different module, and will get counted separately.</p>
<p>Verilator makes a minimally-intelligent decision about what clock domain the signal goes to, and only looks for edges in that clock domain. This means that edges may be ignored if it is known that the edge could never be seen by the receiving logic. This algorithm may improve in the future. The net result is coverage may be lower than what would be seen by looking at traces, but the coverage is a more accurate representation of the quality of stimulus into the design.</p>
<p>There may be edges counted near time zero while the model stabilizes. It's a good practice to zero all coverage just before releasing reset to prevent counting such behavior.</p>
<p>A /*verilator coverage_off/on */ comment pair can be used around signals that do not need toggle analysis, such as RAMs and register files.</p>
</dd>
<dt id="coverage-underscore">--coverage-underscore</dt>
<dd>
<p>Enable coverage of signals that start with an underscore. Normally, these signals are not covered. See also --trace-underscore.</p>
</dd>
<dt id="coverage-user">--coverage-user</dt>
<dd>
<p>Enables user inserted functional coverage. Currently, all functional coverage points are specified using SVA which must be separately enabled with --assert.</p>
<p>For example, the following statement will add a coverage point, with the comment "DefaultClock":</p>
<pre><code> DefaultClock: cover property (@(posedge clk) cyc==3);</code></pre>
</dd>
<dt id="Dvar-value">-D<i>var</i>=<i>value</i></dt>
<dd>
<p>Defines the given preprocessor symbol. Similar to +define, but does not allow multiple definitions with a single option using plus signs. +define is fairly standard across Verilog tools while -D is similar to GCC.</p>
</dd>
<dt id="debug">--debug</dt>
<dd>
<p>Select the debug executable of Verilator (if available), and enable more internal assertions (equivalent to <code>--debug-check</code>), debugging messages (equivalent to <code>--debugi 4</code>), and intermediate form dump files (equivalent to <code>--dump-treei 3</code>).</p>
</dd>
<dt id="debug-check">--debug-check</dt>
<dd>
<p>Rarely needed. Enable internal debugging assertion checks, without changing debug verbosity. Enabled automatically when --debug specified.</p>
</dd>
<dt id="no-debug-leak">--no-debug-leak</dt>
<dd>
<p>In --debug mode, by default Verilator intentionally leaks AstNode instances instead of freeing them, so that each node pointer is unique in the resulting tree files and dot files.</p>
<p>This option disables the leak. This may avoid out-of-memory errors when Verilating large models in --debug mode.</p>
<p>Outside of --debug mode, AstNode instances should never be leaked and this option has no effect.</p>
</dd>
<dt id="debugi-level">--debugi <i>level</i></dt>
<dd>
</dd>
<dt id="debugi-srcfile-level">--debugi-<i>srcfile</i> <i>level</i></dt>
<dd>
<p>Rarely needed - for developer use. Set internal debugging level globally to the specified debug level (1-10) or set the specified Verilator source file to the specified level (e.g. <code>--debugi-V3Width 9</code>). Higher levels produce more detailed messages.</p>
</dd>
<dt id="default-language-value">--default-language <i>value</i></dt>
<dd>
<p>Select the language to be used by default when first processing each Verilog file. The language value must be "1364-1995", "1364-2001", "1364-2005", "1800-2005", "1800-2009", "1800-2012" or "1800-2017".</p>
<p>Any language associated with a particular file extension (see the various +<i>lang</i>ext+ options) will be used in preference to the language specified by --default-language.</p>
<p>The --default-language flag is only recommended for legacy code using the same language in all source files, as the preferable option is to edit the code to repair new keywords, or add appropriate <code>`begin_keywords</code>. For legacy mixed language designs, the various +<i>lang</i>ext+ options should be used.</p>
<p>If no language is specified, either by this flag or +<i>lang</i>ext+ options, then the latest SystemVerilog language (IEEE 1800-2017) is used.</p>
</dd>
<dt id="define-var-value">+define+<i>var</i>=<i>value</i></dt>
<dd>
</dd>
<dt id="define-var-value-var2-value2">+define+<i>var</i>=<i>value</i>+<i>var2</i>=<i>value2</i>...</dt>
<dd>
<p>Defines the given preprocessor symbol, or multiple symbols if separated by plus signs. Similar to -D; +define is fairly standard across Verilog tools while -D is similar to GCC.</p>
</dd>
<dt id="dpi-hdr-only">--dpi-hdr-only</dt>
<dd>
<p>Only generate the DPI header file. This option has no effect on the name or location of the emitted DPI header file, it is output in <code>--Mdir</code> as it would be without this option.</p>
</dd>
<dt id="dump-defines">--dump-defines</dt>
<dd>
<p>With -E, suppress normal output, and instead print a list of all defines existing at the end of pre-processing the input files. Similar to GCC "-dM" option. This also gives you a way of finding out what is predefined in Verilator using the command:</p>
<pre><code> touch foo.v ; verilator -E --dump-defines foo.v</code></pre>
</dd>
<dt id="dump-tree">--dump-tree</dt>
<dd>
<p>Rarely needed. Enable writing .tree debug files with dumping level 3, which dumps the standard critical stages. For details on the format see the Verilator Internals manual. --dump-tree is enabled automatically with --debug, so "--debug --no-dump-tree" may be useful if the dump files are large and not desired.</p>
</dd>
<dt id="dump-treei-level">--dump-treei <i>level</i></dt>
<dd>
</dd>
<dt id="dump-treei-srcfile-level">--dump-treei-<i>srcfile</i> <i>level</i></dt>
<dd>
<p>Rarely needed - for developer use. Set internal tree dumping level globally to a specific dumping level or set the specified Verilator source file to the specified tree dumping level (e.g. <code>--dump-treei-V3Order 9</code>). Level 0 disables dumps and is equivalent to "--no-dump-tree". Level 9 enables dumping of every stage.</p>
</dd>
<dt id="dump-tree-addrids">--dump-tree-addrids</dt>
<dd>
<p>Rarely needed - for developer use. Replace AST node addresses with short identifiers in tree dumps to enhance readability. Each unique pointer value is mapped to a unique identifier, but note that this is not necessarily unique per node instance as an address might get reused by a newly allocated node after a node with the same address has been dumped then freed.</p>
</dd>
<dt id="E">-E</dt>
<dd>
<p>Preprocess the source code, but do not compile, as with 'gcc -E'. Output is written to standard out. Beware of enabling debugging messages, as they will also go to standard out.</p>
</dd>
<dt id="error-limit-value">--error-limit <i>value</i></dt>
<dd>
<p>After this number of errors are encountered during Verilator run, exit. Warnings are not counted in this limit. Defaults to 50.</p>
<p>Does not affect simulation runtime errors, for those see +verilator+error+limit.</p>
</dd>
<dt id="exe">--exe</dt>
<dd>
<p>Generate an executable. You will also need to pass additional .cpp files on the command line that implement the main loop for your simulation.</p>
</dd>
<dt id="F-file">-F <i>file</i></dt>
<dd>
<p>Read the specified file, and act as if all text inside it was specified as command line parameters. Any relative paths are relative to the directory containing the specified file. See also -f. Note -F is fairly standard across Verilog tools.</p>
</dd>
<dt id="f-file">-f <i>file</i></dt>
<dd>
<p>Read the specified file, and act as if all text inside it was specified as command line parameters. Any relative paths are relative to the current directory. See also -F. Note -f is fairly standard across Verilog tools.</p>
<p>The file may contain // comments which are ignored to the end of the line. Any $VAR, $(VAR), or ${VAR} will be replaced with the specified environment variable.</p>
</dd>
<dt id="FI-file">-FI <i>file</i></dt>
<dd>
<p>Force include of the specified C++ header file. All generated C++ files will insert a #include of the specified file before any other includes. The specified file might be used to contain define prototypes of custom VL_VPRINTF functions, and may need to include verilatedos.h as this file is included before any other standard includes.</p>
</dd>
<dt id="flatten">--flatten</dt>
<dd>
<p>Force flattening of the design's hierarchy, with all modules, tasks and functions inlined. Typically used with <code>--xml-only</code>. Note flattening large designs may require significant CPU time, memory and storage.</p>
</dd>
<dt id="Gname-value">-G<i>name</i>=<i>value</i></dt>
<dd>
<p>Overwrites the given parameter of the toplevel module. The value is limited to basic data literals:</p>
<dl>
<dt id="Verilog-integer-literals">Verilog integer literals</dt>
<dd>
<p>The standard Verilog integer literals are supported, so values like 32'h8, 2'b00, 4 etc. are allowed. Care must be taken that the single quote (I') is properly escaped in an interactive shell, e.g., as -GWIDTH=8\'hx.</p>
</dd>
<dt id="C-integer-literals">C integer literals</dt>
<dd>
<p>It is also possible to use C integer notation, including hexadecimal (0x..), octal (0..) or binary (0b..) notation.</p>
</dd>
<dt id="Double-literals">Double literals</dt>
<dd>
<p>Double literals must be one of the following styles: - contains a dot (.) (e.g. 1.23) - contains an exponent (e/E) (e.g. 12e3) - contains p/P for hexadecimal floating point in C99 (e.g. 0x123.ABCp1)</p>
</dd>
<dt id="Strings">Strings</dt>
<dd>
<p>Strings must be in double quotes (""). They must be escaped properly on the command line, e.g. as -GSTR="\"My String\"" or -GSTR='"My String"'.</p>
</dd>
</dl>
</dd>
<dt id="gate-stmts-value">--gate-stmts <i>value</i></dt>
<dd>
<p>Rarely needed. Set the maximum number of statements that may be present in an equation for the gate substitution optimization to inline that equation.</p>
</dd>
<dt id="gdb">--gdb</dt>
<dd>
<p>Run Verilator underneath an interactive GDB (or VERILATOR_GDB environment variable value) session. See also --gdbbt.</p>
</dd>
<dt id="gdbbt">--gdbbt</dt>
<dd>
<p>If --debug is specified, run Verilator underneath a GDB process and print a backtrace on exit, then exit GDB immediately. Without --debug or if GDB doesn't seem to work, this flag is ignored. Intended for easy creation of backtraces by users; otherwise see the --gdb flag.</p>
</dd>
<dt id="generate-key">--generate-key</dt>
<dd>
<p>Generate a true-random key suitable for use with --protect-key, print it, and exit immediately.</p>
</dd>
<dt id="getenv-variable">--getenv <i>variable</i></dt>
<dd>
<p>If the variable is declared in the environment, print it and exit immediately. Otherwise, if it's built into Verilator (e.g. VERILATOR_ROOT), print that and exit immediately. Otherwise, print a newline and exit immediately. This can be useful in makefiles. See also -V, and the various *.mk files.</p>
</dd>
<dt id="help">--help</dt>
<dd>
<p>Displays this message and program version and exits.</p>
</dd>
<dt id="Idir">-I<i>dir</i></dt>
<dd>
<p>See -y.</p>
</dd>
<dt id="if-depth-value">--if-depth <i>value</i></dt>
<dd>
<p>Rarely needed. Set the depth at which the IFDEPTH warning will fire, defaults to 0 which disables this warning.</p>
</dd>
<dt id="incdir-dir">+incdir+<i>dir</i></dt>
<dd>
<p>See -y.</p>
</dd>
<dt id="inhibit-sim">--inhibit-sim</dt>
<dd>
<p>Rarely needed. Create a "inhibitSim(bool)" function to enable and disable evaluation. This allows an upper level testbench to disable modules that are not important in a given simulation, without needing to recompile or change the SystemC modules instantiated.</p>
</dd>
<dt id="inline-mult-value">--inline-mult <i>value</i></dt>
<dd>
<p>Tune the inlining of modules. The default value of 2000 specifies that up to 2000 new operations may be added to the model by inlining, if more than this number of operations would result, the module is not inlined. Larger values, or a value < 1 will inline everything, will lead to longer compile times, but potentially faster simulation speed. This setting is ignored for very small modules; they will always be inlined, if allowed.</p>
</dd>
<dt id="j-value">-j <value></dt>
<dd>
<p>Specify the level of parallelism for --build. <value> must be a positive integer specifying the maximum number of parallel build jobs, or can be omitted. When <value> is omitted, the build will not try to limit the number of parallel build jobs but attempt to execute all independent build steps in parallel.</p>
</dd>
<dt id="LDFLAGS-flags">-LDFLAGS <i>flags</i></dt>
<dd>
<p>Add specified C linker flags to the generated makefiles. For multiple flags either pass them as a single argument with space separators quoted in the shell (<code>-LDFLAGS "-a -b"</code>), or use multiple -LDFLAGS arguments (<code>-LDFLAGS -a -LDFLAGS -b</code>).</p>
<p>When make is run on the generated makefile these will be passed to the C++ linker (ld) *after* the primary file being linked. This flag is called -LDFLAGS as that's the traditional name in simulators; it's would have been better called LDLIBS as that's the Makefile variable it controls. (In Make, LDFLAGS is before the first object, LDLIBS after. -L libraries need to be in the Make variable LDLIBS, not LDFLAGS.)</p>
</dd>
<dt id="l2-name-value">--l2-name <i>value</i></dt>
<dd>
<p>Instead of using the module name when showing Verilog scope, use the name provided. This allows simplifying some Verilator-embedded modeling methodologies. Default is an l2-name matching the top module. The default before 3.884 was "--l2-name v"</p>
<p>For example, the program "module t; initial $display("%m"); endmodule" will show by default "t". With "--l2-name v" it will print "v".</p>
</dd>
<dt id="language-value">--language <i>value</i></dt>
<dd>
<p>A synonym for <code>--default-language</code>, for compatibility with other tools and earlier versions of Verilator.</p>
</dd>
<dt id="libext-ext-ext">+libext+<i>ext</i>+<i>ext</i>...</dt>
<dd>
<p>Specify the extensions that should be used for finding modules. If for example module <i>x</i> is referenced, look in <i>x</i>.<i>ext</i>. Note +libext+ is fairly standard across Verilog tools. Defaults to .v and .sv.</p>
</dd>
<dt id="lint-only">--lint-only</dt>
<dd>
<p>Check the files for lint violations only, do not create any other output.</p>
<p>You may also want the -Wall option to enable messages that are considered stylistic and not enabled by default.</p>
<p>If the design is not to be completely Verilated see also the --bbox-sys and --bbox-unsup options.</p>
</dd>
<dt id="MAKEFLAGS-string">-MAKEFLAGS <string></dt>
<dd>
<p>When using --build, add the specified flag to the invoked make command line. For multiple flags either pass them as a single argument with space separators quoted in the shell (e.g. <code>-MAKEFLAGS "-a -b"</code>), or use multiple -MAKEFLAGS arguments (e.g. <code>-MAKEFLAGS -l -MAKEFLAGS -k</code>). Use of this option should not be required for simple builds using the host toolchain.</p>
</dd>
<dt id="max-num-width-value">--max-num-width <i>value</i></dt>
<dd>
<p>Set the maximum number literal width (e.g. in 1024'd22 this it the 1024). Defaults to 64K.</p>
</dd>
<dt id="MMD-item---no-MMD">--MMD =item --no-MMD</dt>
<dd>
<p>Enable/disable creation of .d dependency files, used for make dependency detection, similar to gcc -MMD option. By default this option is enabled for --cc or --sc modes.</p>
</dd>
<dt id="MP">--MP</dt>
<dd>
<p>When creating .d dependency files with --MMD, make phony targets. Similar to gcc -MP option.</p>
</dd>
<dt id="Mdir-directory">--Mdir <i>directory</i></dt>
<dd>
<p>Specifies the name of the Make object directory. All generated files will be placed in this directory. If not specified, "obj_dir" is used. The directory is created if it does not exist and the parent directories exist; otherwise manually create the Mdir before calling Verilator.</p>
</dd>
<dt id="mod-prefix-topname">--mod-prefix <i>topname</i></dt>
<dd>
<p>Specifies the name to prepend to all lower level classes. Defaults to the same as --prefix.</p>
</dd>
<dt id="no-clk-signal-name">--no-clk <i>signal-name</i></dt>
<dd>
<p>Prevent the specified signal from being marked as clock. See <code>--clk</code>.</p>
</dd>
<dt id="no-decoration">--no-decoration</dt>
<dd>
<p>When creating output Verilated code, minimize comments, white space, symbol names and other decorative items, at the cost of greatly reduced readability. This may assist C++ compile times. This will not typically change the ultimate model's performance, but may in some cases.</p>
</dd>
<dt id="no-pins64">--no-pins64</dt>
<dd>
<p>Backward compatible alias for "--pins-bv 33".</p>
</dd>
<dt id="no-relative-cfuncs">--no-relative-cfuncs</dt>
<dd>
<p>Disable 'this->' references in generated functions, and instead Verilator will generate absolute references starting from 'vlTOPp->'. This prevents V3Combine from merging functions from multiple instances of the same module, so it can grow the instruction stream.</p>
<p>This is a work around for old compilers. Don't set this if your C++ compiler supports __restrict__ properly, as GCC 4.5.x and newer do. For older compilers, test if this switch gives you better performance or not.</p>
<p>Compilers which don't honor __restrict__ will suspect that 'this->' references and 'vlTOPp->' references may alias, and may write slow code with extra loads and stores to handle the (imaginary) aliasing. Using only 'vlTOPp->' references allows these old compilers to produce tight code.</p>
</dd>
<dt id="no-skip-identical-item---skip-identical">--no-skip-identical =item --skip-identical</dt>
<dd>
<p>Rarely needed. Disables or enables skipping execution of Verilator if all source files are identical, and all output files exist with newer dates. By default this option is enabled for --cc or --sc modes only.</p>
</dd>
<dt id="notimingchecks">+notimingchecks</dt>
<dd>
<p>Ignored for compatibility with other simulators.</p>
</dd>
<dt id="O0">-O0</dt>
<dd>
<p>Disables optimization of the model.</p>
</dd>
<dt id="O3">-O3</dt>
<dd>
<p>Enables slow optimizations for the code Verilator itself generates (as opposed to "-CFLAGS -O3" which effects the C compiler's optimization. -O3 may improve simulation performance at the cost of compile time. This currently sets --inline-mult -1.</p>
</dd>
<dt id="Ooptimization-letter">-O<i>optimization-letter</i></dt>
<dd>
<p>Rarely needed. Enables or disables a specific optimizations, with the optimization selected based on the letter passed. A lowercase letter disables an optimization, an upper case letter enables it. This is intended for debugging use only; see the source code for version-dependent mappings of optimizations to -O letters.</p>
</dd>
<dt id="o-executable">-o <i>executable</i></dt>
<dd>
<p>Specify the name for the final executable built if using --exe. Defaults to the --prefix if not specified.</p>
</dd>
<dt id="no-order-clock-delay">--no-order-clock-delay</dt>
<dd>
<p>Rarely needed. Disables a bug fix for ordering of clock enables with delayed assignments. This flag should only be used when suggested by the developers.</p>
</dd>
<dt id="output-split-statements">--output-split <i>statements</i></dt>
<dd>
<p>Enables splitting the output .cpp files into multiple outputs. When a C++ file exceeds the specified number of operations, a new file will be created at the next function boundary. In addition, if the total output code size exceeds the specified value, VM_PARALLEL_BUILDS will be set to 1 by default in the generated make files, making parallel compilation possible. Using --output-split should have only a trivial impact on model performance. But can greatly improve C++ compilation speed. The use of <i>ccache</i> (set for you if present at configure time) is also more effective with this option.</p>
<p>This option is on by default with a value of 20000. To disable, pass with a value of 0.</p>
</dd>
<dt id="output-split-cfuncs-statements">--output-split-cfuncs <i>statements</i></dt>
<dd>
<p>Enables splitting functions in the output .cpp files into multiple functions. When a generated function exceeds the specified number of operations, a new function will be created. With --output-split, this will enable the C++ compiler to compile faster, at a small loss in performance that gets worse with decreasing split values. Note that this option is stronger than --output-split in the sense that --output-split will not split inside a function.</p>
<p>Defaults to the value of --output-split, unless explicitly specified.</p>
</dd>
<dt id="output-split-ctrace-statements">--output-split-ctrace <i>statements</i></dt>
<dd>
<p>Similar to --output-split-cfuncs, enables splitting trace functions in the output .cpp files into multiple functions.</p>
<p>Defaults to the value of --output-split, unless explicitly specified.</p>
</dd>
<dt id="P">-P</dt>
<dd>
<p>With -E, disable generation of `line markers and blank lines, similar to GCC -P flag.</p>
</dd>
<dt id="pins64">--pins64</dt>
<dd>
<p>Backward compatible alias for "--pins-bv 65". Note that's a 65, not a 64.</p>
</dd>
<dt id="pins-bv-width">--pins-bv <i>width</i></dt>
<dd>
<p>Specifies SystemC inputs/outputs of greater than or equal to <i>width</i> bits wide should use sc_bv's instead of uint32/vluint64_t's. The default is "--pins-bv 65", and the value must be less than or equal to 65. Versions before Verilator 3.671 defaulted to "--pins-bv 33". The more sc_bv is used, the worse for performance. Use the "/*verilator sc_bv*/" attribute to select specific ports to be sc_bv.</p>
</dd>
<dt id="pins-sc-uint">--pins-sc-uint</dt>
<dd>
<p>Specifies SystemC inputs/outputs of greater than 2 bits wide should use sc_uint between 2 and 64. When combined with the "--pins-sc-biguint" combination, it results in sc_uint being used between 2 and 64 and sc_biguint being used between 65 and 512.</p>
</dd>
<dt id="pins-sc-biguint">--pins-sc-biguint</dt>
<dd>
<p>Specifies SystemC inputs/outputs of greater than 65 bits wide should use sc_biguint between 65 and 512, and sc_bv from 513 upwards. When combined with the "--pins-sc-uint" combination, it results in sc_uint being used between 2 and 64 and sc_biguint being used between 65 and 512.</p>
</dd>
<dt id="pins-uint8">--pins-uint8</dt>
<dd>
<p>Specifies SystemC inputs/outputs that are smaller than the --pins-bv setting and 8 bits or less should use uint8_t instead of uint32_t. Likewise pins of width 9-16 will use uint16_t instead of uint32_t.</p>
</dd>
<dt id="pipe-filter-command">--pipe-filter <i>command</i></dt>
<dd>
<p>Rarely needed. Verilator will spawn the specified command as a subprocess pipe, to allow the command to perform custom edits on the Verilog code before it reaches Verilator.</p>
<p>Before reading each Verilog file, Verilator will pass the file name to the subprocess' stdin with 'read "<filename>"'. The filter may then read the file and perform any filtering it desires, and feeds the new file contents back to Verilator on stdout by first emitting a line defining the length in bytes of the filtered output 'Content-Length: <bytes>', followed by the new filtered contents. Output to stderr from the filter feeds through to Verilator's stdout and if the filter exits with non-zero status Verilator terminates. See the t/t_pipe_filter test for an example.</p>
<p>To debug the output of the filter, try using the -E option to see preprocessed output.</p>
</dd>
<dt id="pp-comments">--pp-comments</dt>
<dd>
<p>With -E, show comments in preprocessor output.</p>
</dd>
<dt id="prefix-topname">--prefix <i>topname</i></dt>
<dd>
<p>Specifies the name of the top level class and makefile. Defaults to V prepended to the name of the --top-module switch, or V prepended to the first Verilog filename passed on the command line.</p>
</dd>
<dt id="prof-cfuncs">--prof-cfuncs</dt>
<dd>
<p>Modify the created C++ functions to support profiling. The functions will be minimized to contain one "basic" statement, generally a single always block or wire statement. (Note this will slow down the executable by ~5%.) Furthermore, the function name will be suffixed with the basename of the Verilog module and line number the statement came from. This allows gprof or oprofile reports to be correlated with the original Verilog source statements. See also <a>verilator_profcfunc</a>.</p>
</dd>
<dt id="prof-threads">--prof-threads</dt>
<dd>
<p>Enable gantt chart data collection for threaded builds.</p>
<p>Verilator will record the start and end time of each macro-task across a number of calls to eval. (What is a macro-task? See the Verilator internals document.)</p>
<p>When profiling is enabled, the simulation runtime will emit a blurb of profiling data in non-human-friendly form. The <code>verilator_gantt</code> script will transform this into a nicer visual format and produce some related statistics.</p>
</dd>
<dt id="protect-key-key">--protect-key <i>key</i></dt>
<dd>
<p>Specifies the private key for --protect-ids. For best security this key should be 16 or more random bytes, a reasonable secure choice is the output of <code>verilator --generate-key</code>. Typically, a key would be created by the user once for a given protected design library, then every Verilator run for subsequent versions of that library would be passed the same --protect-key. Thus, if the input Verilog is similar between library versions (Verilator runs), the Verilated code will likewise be mostly similar.</p>
<p>If --protect-key is not specified and a key is needed, Verilator will generate a new key for every Verilator run. As the key is not saved, this is best for security, but means every Verilator run will give vastly different output even for identical input, perhaps harming compile times (and certainly thrashing any <i>ccache</i>).</p>
</dd>
<dt id="protect-ids">--protect-ids</dt>
<dd>
<p>Hash any private identifiers (variable, module, and assertion block names that are not on the top level) into hashed random-looking identifiers, resulting after compilation in protected library binaries that expose less design information. This hashing uses the provided or default --protect-key, see important details there.</p>
<p>Verilator will also create a {prefix}__idmap.xml file which contains the mapping from the hashed identifiers back to the original identifiers. This idmap file is to be kept private, and is to assist mapping any simulation runtime design assertions, coverage, or trace information, which will report the hashed identifiers, back to the original design's identifier names.</p>
<p>Using DPI imports/exports is allowed and generally relatively safe in terms of information disclosed, which is limited to the DPI function prototyptes. Use of the VPI is not recommended as many design details may be exposed, and an INSECURE warning will be issued.</p>
</dd>
<dt id="protect-lib-name">--protect-lib <i>name</i></dt>
<dd>
<p>Produces C++, Verilog wrappers and a Makefile which can in turn produce a DPI library which can be used by Verilator or other simulators along with the corresponding Verilog wrapper. The Makefile will build both a static and dynamic version of the library named lib<i>name</i>.a and lib<i>name</i>.so respectively. This is done because some simulators require a dynamic library, but the static library is arguably easier to use if possible. --protect-lib implies --protect-ids.</p>
<p>This allows for the secure delivery of sensitive IP without the need for encrypted RTL (i.e. IEEE P1735). See examples/make_protect_lib in the distribution for a demonstration of how to build and use the DPI library.</p>
<p>When using --protect-lib it is advised to also use <code>--timescale-override /1fs</code> to ensure the model has a time resolution that is always compatible with the time precision of the upper instantiating module.</p>
</dd>
<dt id="private">--private</dt>
<dd>
<p>Opposite of --public. Is the default; this option exists for backwards compatibility.</p>
</dd>
<dt id="public">--public</dt>
<dd>
<p>This is only for historical debug use. Using it may result in mis-simulation of generated clocks.</p>
<p>Declares all signals and modules public. This will turn off signal optimizations as if all signals had a /*verilator public*/ comments and inlining. This will also turn off inlining as if all modules had a /*verilator public_module*/, unless the module specifically enabled it with /*verilator inline_module*/.</p>
</dd>
<dt id="public-flat-rw">--public-flat-rw</dt>
<dd>
<p>Declares all variables, ports and wires public as if they had /*verilator public_flat_rw @ (<variable's_source_process_edge>)*/ comments. This will make them VPI accessible by their flat name, but not turn off module inlining. This is particularly useful in combination with --vpi. This may also in some rare cases result in mis-simulation of generated clocks. Instead of this global switch, marking only those signals that need public_flat_rw is typically significantly better performing.</p>
</dd>
<dt id="pvalue-name-value">-pvalue+<i>name</i>=<i>value</i></dt>
<dd>
<p>Overwrites the given parameter(s) of the toplevel module. See -G for a detailed description.</p>
</dd>
<dt id="quiet-exit">--quiet-exit</dt>
<dd>
<p>When exiting due to an error, do not display the "Exiting due to Errors" nor "Command Failed" messages.</p>
</dd>
<dt id="relative-includes">--relative-includes</dt>
<dd>
<p>When a file references an include file, resolve the filename relative to the path of the referencing file, instead of relative to the current directory.</p>
</dd>
<dt id="report-unoptflat">--report-unoptflat</dt>
<dd>
<p>Extra diagnostics for UNOPTFLAT warnings. This includes for each loop, the 10 widest variables in the loop, and the 10 most fanned out variables in the loop. These are candidates for splitting into multiple variables to break the loop.</p>
<p>In addition produces a GraphViz DOT file of the entire strongly connected components within the source associated with each loop. This is produced irrespective of whether --dump-tree is set. Such graphs may help in analyzing the problem, but can be very large indeed.</p>
<p>Various commands exist for viewing and manipulating DOT files. For example the <i>dot</i> command can be used to convert a DOT file to a PDF for printing. For example:</p>
<pre><code> dot -Tpdf -O Vt_unoptflat_simple_2_35_unoptflat.dot</code></pre>
<p>will generate a PDF Vt_unoptflat_simple_2_35_unoptflat.dot.pdf from the DOT file.</p>
<p>As an alternative, the <i>xdot</i> command can be used to view DOT files interactively:</p>
<pre><code> xdot Vt_unoptflat_simple_2_35_unoptflat.dot</code></pre>
</dd>
<dt id="rr">--rr</dt>
<dd>
<p>Run Verilator and record with rr. See: rr-project.org.</p>
</dd>
<dt id="savable">--savable</dt>
<dd>
<p>Enable including save and restore functions in the generated model.</p>
<p>The user code must create a VerilatedSerialize or VerilatedDeserialze object then calling the << or >> operators on the generated model and any other data the process needs saved/restored. These functions are not thread safe, and are typically called only by a main thread.</p>
<p>For example:</p>
<pre><code> void save_model(const char* filenamep) {
VerilatedSave os;
os.open(filenamep);
os << main_time; // user code must save the timestamp, etc
os << *topp;
}
void restore_model(const char* filenamep) {
VerilatedRestore os;
os.open(filenamep);
os >> main_time;
os >> *topp;
}</code></pre>
</dd>
<dt id="sc">--sc</dt>
<dd>
<p>Specifies SystemC output mode; see also --cc.</p>
</dd>
<dt id="stats">--stats</dt>
<dd>
<p>Creates a dump file with statistics on the design in {prefix}__stats.txt.</p>
</dd>
<dt id="stats-vars">--stats-vars</dt>
<dd>
<p>Creates more detailed statistics, including a list of all the variables by size (plain --stats just gives a count). See --stats, which is implied by this.</p>
</dd>
<dt id="structs-packed">--structs-packed</dt>
<dd>
<p>Converts all unpacked structures to packed structures and issues a UNPACKED warning. Currently this is the default and --no-structs-packed will not work. Specifying this option allows for forward compatibility when a future version of Verilator no longer always packs unpacked structures.</p>
</dd>
<dt id="sv">-sv</dt>
<dd>
<p>Specifies SystemVerilog language features should be enabled; equivalent to "--language 1800-2005". This option is selected by default, it exists for compatibility with other simulators.</p>
</dd>
<dt id="systemverilogext-ext">+systemverilogext+<i>ext</i></dt>
<dd>
<p>A synonym for <code>+1800-2017ext+</code><i>ext</i>.</p>
</dd>
<dt id="threads-threads">--threads <i>threads</i></dt>
<dd>
</dd>
<dt id="no-threads">--no-threads</dt>
<dd>
<p>With --threads 0 or --no-threads, the default, the generated model is not thread safe. With --threads 1, the generated model is single threaded but may run in a multithreaded environment. With --threads N, where N >= 2, the model is generated to run multithreaded on up to N threads. See <a href="#MULTITHREADING">"MULTITHREADING"</a>.</p>
</dd>
<dt id="threads-dpi-all">--threads-dpi all</dt>
<dd>
</dd>
<dt id="threads-dpi-none">--threads-dpi none</dt>
<dd>
</dd>
<dt id="threads-dpi-pure">--threads-dpi pure</dt>
<dd>
<p>When using --threads, controls which DPI imported tasks and functions are considered thread safe.</p>
<p>With --threads-dpi all, enable Verilator to assume all DPI imports are threadsafe, and to use thread-local storage for communication with DPI, potentially improving performance. Any DPI libraries need appropriate mutexes to avoid undefined behavior.</p>
<p>With --threads-dpi none, Verilator assume DPI imports are not thread safe, and Verilator will serialize calls to DPI imports by default, potentially harming performance.</p>
<p>With --threads-dpi pure, the default, Verilator assumes DPI pure imports are threadsafe, but non-pure DPI imports are not.</p>
</dd>
<dt id="threads-max-mtasks-value">--threads-max-mtasks <i>value</i></dt>
<dd>
<p>Rarely needed. When using --threads, specify the number of mtasks the model is to be partitioned into. If unspecified, Verilator approximates a good value.</p>
</dd>
<dt id="timescale-timeunit-timeprecision">--timescale <i>timeunit</i>/<i>timeprecision</i></dt>
<dd>
<p>Sets default timescale, timeunit and timeprecision for when `timescale does not occur in sources. Default is "1ps/1ps" (to match SystemC). This is overridden by <code>--timescale-override</code>.</p>
</dd>
<dt id="timescale-override-timeunit-timeprecision">--timescale-override <i>timeunit</i>/<i>timeprecision</i></dt>
<dd>
</dd>
<dt id="timescale-override-timeprecision">--timescale-override /<i>timeprecision</i></dt>
<dd>
<p>Overrides all `timescales in sources. The timeunit may be left empty to specify only to override the timeprecision, e.g. "/1fs".</p>
<p>The time precision must be consistent with SystemC's sc_set_time_resolution, or the C++ code instantiating the Verilated module. As 1fs is the finest time precision it may be desirable to always use a precision of 1fs.</p>
</dd>
<dt id="top-module-topname">--top-module <i>topname</i></dt>
<dd>
<p>When the input Verilog contains more than one top level module, specifies the name of the Verilog module to become the top level module, and sets the default for --prefix if not explicitly specified. This is not needed with standard designs with only one top. See also the MULTITOP warning section.</p>
</dd>
<dt id="trace">--trace</dt>
<dd>
<p>Adds waveform tracing code to the model using VCD format. This overrides <code>--trace-fst</code>.</p>
<p>Verilator will generate additional {prefix}__Trace*.cpp files that will need to be compiled. In addition verilated_vcd_sc.cpp (for SystemC traces) or verilated_vcd_c.cpp (for both) must be compiled and linked in. If using the Verilator generated Makefiles, these files will be added to the source file lists for you. If you are not using the Verilator Makefiles, you will need to add these to your Makefile manually.</p>
<p>Having tracing compiled in may result in some small performance losses, even when tracing is not turned on during model execution.</p>
<p>See also <code>--trace-threads</code>.</p>
</dd>
<dt id="trace-coverage">--trace-coverage</dt>
<dd>
<p>With --trace and --coverage-*, enable tracing to include a traced signal for every --coverage-line or --coverage-user inserted coverage point, to assist in debugging coverage items. Note --coverage-toggle does not get additional signals added, as the original signals being toggle-analyzed are already visible.</p>
<p>The added signal will be a 32-bit value which will increment on each coverage occurrence. Due to this, this option may greatly increase trace file sizes and reduce simulation speed.</p>
</dd>
<dt id="trace-depth-levels">--trace-depth <i>levels</i></dt>
<dd>
<p>Specify the number of levels deep to enable tracing, for example --trace-level 1 to only see the top level's signals. Defaults to the entire model. Using a small number will decrease visibility, but greatly improve simulation performance and trace file size.</p>
</dd>
<dt id="trace-fst">--trace-fst</dt>
<dd>
<p>Enable FST waveform tracing in the model. This overrides <code>--trace</code>. See also <code>--trace-threads</code>.</p>
</dd>
<dt id="trace-max-array-depth">--trace-max-array <i>depth</i></dt>
<dd>
<p>Rarely needed. Specify the maximum array depth of a signal that may be traced. Defaults to 32, as tracing large arrays may greatly slow traced simulations.</p>
</dd>
<dt id="trace-max-width-width">--trace-max-width <i>width</i></dt>
<dd>
<p>Rarely needed. Specify the maximum bit width of a signal that may be traced. Defaults to 256, as tracing large vectors may greatly slow traced simulations.</p>
</dd>
<dt id="no-trace-params">--no-trace-params</dt>
<dd>
<p>Disable tracing of parameters.</p>
</dd>
<dt id="trace-structs">--trace-structs</dt>
<dd>
<p>Enable tracing to show the name of packed structure, union, and packed array fields, rather than a single combined packed bus. Due to VCD file format constraints this may result in significantly slower trace times and larger trace files.</p>
</dd>
<dt id="trace-threads-threads">--trace-threads <i>threads</i></dt>
<dd>
<p>Enable waveform tracing using separate threads. This is typically faster in simulation runtime but uses more total compute. This option is independent of, and works with, both <code>--trace</code> and <code>--trace-fst</code>. Different trace formats can take advantage of more trace threads to varying degrees. Currently VCD tracing can utilize at most --trace-threads 1, and FST tracing can utilize at most --trace-threads 2. This overrides <code>--no-threads</code>.</p>
</dd>
<dt id="trace-underscore">--trace-underscore</dt>
<dd>
<p>Enable tracing of signals that start with an underscore. Normally, these signals are not output during tracing. See also --coverage-underscore.</p>
</dd>
<dt id="Uvar">-U<i>var</i></dt>
<dd>
<p>Undefines the given preprocessor symbol.</p>
</dd>
<dt id="unroll-count-loops">--unroll-count <i>loops</i></dt>
<dd>
<p>Rarely needed. Specifies the maximum number of loop iterations that may be unrolled. See also BLKLOOPINIT warning.</p>
</dd>
<dt id="unroll-stmts-statements">--unroll-stmts <i>statements</i></dt>
<dd>
<p>Rarely needed. Specifies the maximum number of statements in a loop for that loop to be unrolled. See also BLKLOOPINIT warning.</p>
</dd>
<dt id="unused-regexp-regexp">--unused-regexp <i>regexp</i></dt>
<dd>
<p>Rarely needed. Specifies a simple regexp with * and ? that if a signal name matches will suppress the UNUSED warning. Defaults to "*unused*". Setting it to "" disables matching.</p>
</dd>
<dt id="V">-V</dt>
<dd>
<p>Shows the verbose version, including configuration information compiled into Verilator. (Similar to perl -V.) See also --getenv.</p>
</dd>
<dt id="v-filename">-v <i>filename</i></dt>
<dd>
<p>Read the filename as a Verilog library. Any modules in the file may be used to resolve cell instantiations in the top level module, else ignored. Note -v is fairly standard across Verilog tools.</p>
</dd>
<dt id="no-verilate">--no-verilate</dt>
<dd>
<p>When using --build, disable generation of C++/SystemC code, and execute only the build. This can be useful for rebuilding Verilated code produced by a previous invocation of Verilator.</p>
</dd>
<dt id="verilog1995ext-ext">+verilog1995ext+<i>ext</i></dt>
<dd>
</dd>
<dt id="verilog2001ext-ext">+verilog2001ext+<i>ext</i></dt>
<dd>
<p>Synonyms for <code>+1364-1995ext+</code><i>ext</i> and <code>+1364-2001ext+</code><i>ext</i> respectively</p>
</dd>
<dt id="version">--version</dt>
<dd>
<p>Displays program version and exits.</p>
</dd>
<dt id="vpi">--vpi</dt>
<dd>
<p>Enable use of VPI and linking against the verilated_vpi.cpp files.</p>
</dd>
<dt id="waiver-output-filename">--waiver-output <filename></dt>
<dd>
<p>Generate a waiver file which contains all waiver statements to suppress the warnings emitted during this Verilator run. This in particular is useful as a starting point for solving linter warnings or suppressing them systematically.</p>
<p>The generated file is in the Verilator Configuration format, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a>, and can directly be consumed by Verilator. The standard file extension is .vlt.</p>
</dd>
<dt id="Wall">-Wall</dt>
<dd>
<p>Enable all code style warnings, including code style warnings that are normally disabled by default. Equivalent to "-Wwarn-lint -Wwarn-style". Excludes some specialty warnings, i.e. IMPERFECTSCH.</p>
</dd>
<dt id="Werror-message">-Werror-<i>message</i></dt>
<dd>
<p>Promote the specified warning message into an error message. This is generally to discourage users from violating important site-wide rules, for example <code>-Werror-NOUNOPTFLAT</code>.</p>
</dd>
<dt id="Wfuture-message">-Wfuture-<i>message</i></dt>
<dd>
<p>Rarely needed. Suppress unknown Verilator comments or warning messages with the given message code. This is used to allow code written with pragmas for a later version of Verilator to run under a older version; add -Wfuture- arguments for each message code or comment that the new version supports which the older version does not support.</p>
</dd>
<dt id="Wno-message">-Wno-<i>message</i></dt>
<dd>
<p>Disable the specified warning/error message. This will override any lint_on directives in the source, i.e. the warning will still not be printed.</p>
</dd>
<dt id="Wno-context">-Wno-context</dt>
<dd>
<p>Disable showing the suspected context of the warning message by quoting the source text at the suspected location. This can be used to appease tools which process the warning messages but may get confused by lines from the original source.</p>
</dd>
<dt id="Wno-fatal">-Wno-fatal</dt>
<dd>
<p>When warnings are detected, print them, but do not terminate Verilator.</p>
<p>Having warning messages in builds is sloppy. It is strongly recommended you cleanup your code, use inline lint_off, or use -Wno-... flags rather than using this option.</p>
</dd>
<dt id="Wno-lint">-Wno-lint</dt>
<dd>
<p>Disable all lint related warning messages, and all style warnings. This is equivalent to "-Wno-ALWCOMBORDER -Wno-BSSPACE -Wno-CASEINCOMPLETE -Wno-CASEOVERLAP -Wno-CASEX -Wno-CASEWITHX -Wno-CMPCONST -Wno-COLONPLUS -Wno-ENDLABEL -Wno-IMPLICIT -Wno-LITENDIAN -Wno-PINCONNECTEMPTY -Wno-PINMISSING -Wno-SYNCASYNCNET -Wno-UNDRIVEN -Wno-UNSIGNED -Wno-UNUSED -Wno-WIDTH" plus the list shown for Wno-style.</p>
<p>It is strongly recommended you cleanup your code rather than using this option, it is only intended to be use when running test-cases of code received from third parties.</p>
</dd>
<dt id="Wno-style">-Wno-style</dt>
<dd>
<p>Disable all code style related warning messages (note by default they are already disabled). This is equivalent to "-Wno-DECLFILENAME -Wno-DEFPARAM -Wno-IMPORTSTAR -Wno-INCABSPATH -Wno-PINCONNECTEMPTY -Wno-PINNOCONNECT -Wno-SYNCASYNCNET -Wno-UNDRIVEN -Wno-UNUSED -Wno-VARHIDDEN".</p>
</dd>
<dt id="Wpedantic">-Wpedantic</dt>
<dd>
<p>Warn on any construct demanded by IEEE, and disable all Verilator extensions that may interfere with IEEE compliance to the standard defined with --default-language (etc). Similar to GCC's -Wpedantic. Rarely used, and intended only for strict compliance tests.</p>
</dd>
<dt id="Wwarn-message">-Wwarn-<i>message</i></dt>
<dd>
<p>Enables the specified warning message.</p>
</dd>
<dt id="Wwarn-lint">-Wwarn-lint</dt>
<dd>
<p>Enable all lint related warning messages (note by default they are already enabled), but do not affect style messages. This is equivalent to "-Wwarn-ALWCOMBORDER -Wwarn-BSSPACE -Wwarn-CASEINCOMPLETE -Wwarn-CASEOVERLAP -Wwarn-CASEX -Wwarn-CASEWITHX -Wwarn-CMPCONST -Wwarn-COLONPLUS -Wwarn-ENDLABEL -Wwarn-IMPLICIT -Wwarn-LITENDIAN -Wwarn-PINMISSING -Wwarn-REALCVT -Wwarn-UNSIGNED -Wwarn-WIDTH".</p>
</dd>
<dt id="Wwarn-style">-Wwarn-style</dt>
<dd>
<p>Enable all code style related warning messages. This is equivalent to "-Wwarn ASSIGNDLY -Wwarn-DECLFILENAME -Wwarn-DEFPARAM -Wwarn-INCABSPATH -Wwarn-PINNOCONNECT -Wwarn-SYNCASYNCNET -Wwarn-UNDRIVEN -Wwarn-UNUSED -Wwarn-VARHIDDEN".</p>
</dd>
<dt id="x-assign-0">--x-assign 0</dt>
<dd>
</dd>
<dt id="x-assign-1">--x-assign 1</dt>
<dd>
</dd>
<dt id="x-assign-fast-default">--x-assign fast (default)</dt>
<dd>
</dd>
<dt id="x-assign-unique">--x-assign unique</dt>
<dd>
<p>Controls the two-state value that is substituted when an explicit X value is encountered in the source. <code>--x-assign fast</code>, the default, converts all Xs to whatever is best for performance. <code>--x-assign 0</code> converts all Xs to 0s, and is also fast. <code>--x-assign 1</code> converts all Xs to 1s, this is nearly as fast as 0, but more likely to find reset bugs as active high logic will fire. Using <code>--x-assign unique</code> will result in all explicit Xs being replaced by a constant value determined at runtime. The value is determined by calling a function at initialization time. This enables randomization of Xs with different seeds on different executions. This method is the slowest, but safest for finding reset bugs.</p>
<p>If using --x-assign unique, you may want to seed your random number generator such that each regression run gets a different randomization sequence. The simplest is to use the +verilator+seed runtime option. Alternatively use the system's srand48() or for Windows srand() function to do this. You'll probably also want to print any seeds selected, and code to enable rerunning with that same seed so you can reproduce bugs.</p>
<p><b>Note.</b> This option applies only to values which are explicitly written as X in the Verilog source code. Initial values of clocks are set to 0 unless --x-initial-edge is specified. Initial values of all other state holding variables are controlled with --x-initial.</p>
</dd>
<dt id="x-initial-0">--x-initial 0</dt>
<dd>
</dd>
<dt id="x-initial-fast">--x-initial fast</dt>
<dd>
</dd>
<dt id="x-initial-unique-default">--x-initial unique (default)</dt>
<dd>
<p>Controls the two-state value that is used to initialize variables that are not otherwise initialized.</p>
<p><code>--x-initial 0</code>, initializes all otherwise uninitialized variables to zero.</p>
<p><code>--x-initial unique</code>, the default, initializes variables using a function, which determines the value to use each initialization. This gives greatest flexibility and allows finding reset bugs. See <a href="#Unknown-states">"Unknown states"</a>.</p>
<p><code>--x-initial fast</code>, is best for performance, and initializes all variables to a state Verilator determines is optimal. This may allow further code optimizations, but will likely hide any code bugs relating to missing resets.</p>
<p><b>Note.</b> This option applies only to initial values of variables. Initial values of clocks are set to 0 unless --x-initial-edge is specified.</p>
</dd>
<dt id="x-initial-edge">--x-initial-edge</dt>
<dd>
<p>Enables emulation of event driven simulators which generally trigger an edge on a transition from X to 1 (<code>posedge</code>) or X to 0 (<code>negedge</code>). Thus the following code, where <code>rst_n</code> is uninitialized would set <code>res_n</code> to <code>1'b1</code> when <code>rst_n</code> is first set to zero:</p>
<pre><code> reg res_n = 1'b0;
always @(negedge rst_n) begin
if (rst_n == 1'b0) begin
res_n <= 1'b1;
end
end</code></pre>
<p>In Verilator, by default, uninitialized clocks are given a value of zero, so the above <code>always</code> block would not trigger.</p>
<p>While it is not good practice, there are some designs that rely on X → 0 triggering a <code>negedge</code>, particularly in reset sequences. Using --x-initial-edge with Verilator will replicate this behavior. It will also ensure that X → 1 triggers a <code>posedge</code>.</p>
<p><b>Note.</b> Some users have reported that using this option can affect convergence, and that it may be necessary to use --converge-limit to increase the number of convergence iterations. This may be another indication of problems with the modeled design that should be addressed.</p>
</dd>
<dt id="xml-only">--xml-only</dt>
<dd>
<p>Create XML output only, do not create any other output.</p>
<p>The XML format is intended to be used to leverage Verilator's parser and elaboration to feed to other downstream tools. Be aware that the XML format is still evolving; there will be some changes in future versions.</p>
</dd>
<dt id="xml-output-filename">--xml-output <i>filename</i></dt>
<dd>
<p>Filename for XML output file. Using this option automatically sets --xml-only.</p>
</dd>
<dt id="y-dir">-y <i>dir</i></dt>
<dd>
<p>Add the directory to the list of directories that should be searched for include files or libraries. The three flags -y, +incdir and -I have similar effect; +incdir and +y are fairly standard across Verilog tools while -I is used by many C++ compilers.</p>
<p>Verilator defaults to the current directory ("-y .") and any specified --Mdir, though these default paths are used after any user specified directories. This allows '-y "$(pwd)"' to be used if absolute filenames are desired for error messages instead of relative filenames.</p>
</dd>
</dl>
<h1 id="SIMULATION-RUNTIME-ARGUMENTS">SIMULATION RUNTIME ARGUMENTS</h1>
<p>The following are the arguments that may be passed to a Verilated executable, provided that executable calls Verilated::commandArgs().</p>
<p>All simulation runtime arguments begin with +verilator, so that the user's executable may skip over all +verilator arguments when parsing its command line.</p>
<dl>
<dt id="verilator-debug">+verilator+debug</dt>
<dd>
<p>Enable simulation runtime debugging. Equivalent to +verilator+debugi+4.</p>
</dd>
<dt id="verilator-debugi-value">+verilator+debugi+<i>value</i></dt>
<dd>
<p>Enable simulation runtime debugging at the provided level.</p>
</dd>
<dt id="verilator-error-limit-value">+verilator+error+limit+<i>value</i></dt>
<dd>
<p>Set number of non-fatal errors (e.g. assertion failures) before exiting simulation runtime. Also affects number of $stop calls needed before exit. Defaults to 1.</p>
</dd>
<dt id="verilator-help">+verilator+help</dt>
<dd>
<p>Display help and exit.</p>
</dd>
<dt id="verilator-prof-threads-file-filename">+verilator+prof+threads+file+<i>filename</i></dt>
<dd>
<p>When a model was Verilated using --prof-threads, sets the simulation runtime filename to dump to. Defaults to "profile_threads.dat".</p>
</dd>
<dt id="verilator-prof-threads-start-value">+verilator+prof+threads+start+<i>value</i></dt>
<dd>
<p>When a model was Verilated using --prof-threads, the simulation runtime will wait until $time is at this value (expressed in units of the time precision), then start the profiling warmup, then capturing. Generally this should be set to some time that is well within the normal operation of the simulation, i.e. outside of reset. If 0, the dump is disabled. Defaults to 1.</p>
</dd>
<dt id="verilator-prof-threads-window-value">+verilator+prof+threads+window+<i>value</i></dt>
<dd>
<p>When a model was Verilated using --prof-threads, after $time reaches +verilator+prof+threads+start, Verilator will warm up the profiling for this number of eval() calls, then will capture the profiling of this number of eval() calls. Defaults to 2, which makes sense for a single-clock-domain module where it's typical to want to capture one posedge eval() and one negedge eval().</p>
</dd>
<dt id="verilator-rand-reset-value">+verilator+rand+reset+<i>value</i></dt>
<dd>
<p>When a model was Verilated using "-x-initial unique", sets the simulation runtime initialization technique. 0 = Reset to zeros. 1 = Reset to all-ones. 2 = Randomize. See <a href="#Unknown-states">"Unknown states"</a>.</p>
</dd>
<dt id="verilator-seed-value">+verilator+seed+<i>value</i></dt>
<dd>
<p>For $random and "-x-initial unique", set the simulation runtime random seed value. If zero or not specified picks a value from the system random number generator.</p>
</dd>
<dt id="verilator-noassert">+verilator+noassert</dt>
<dd>
<p>Disable assert checking per runtime argument. This is the same as calling "Verilated::assertOn(false)" in the model.</p>
</dd>
<dt id="verilator-V">+verilator+V</dt>
<dd>
<p>Shows the verbose version, including configuration information.</p>
</dd>
<dt id="verilator-version">+verilator+version</dt>
<dd>
<p>Displays program version and exits.</p>
</dd>
</dl>
<h1 id="EXAMPLE-C-EXECUTION">EXAMPLE C++ EXECUTION</h1>
<p>We'll compile this example into C++.</p>
<pre><code> mkdir test_our
cd test_our
cat >our.v <<'EOF'
module our;
initial begin $display("Hello World"); $finish; end
endmodule
EOF
cat >sim_main.cpp <<'EOF'
#include "Vour.h"
#include "verilated.h"
int main(int argc, char** argv, char** env) {
Verilated::commandArgs(argc, argv);
Vour* top = new Vour;
while (!Verilated::gotFinish()) { top->eval(); }
delete top;
exit(0);
}
EOF</code></pre>
<p>See the README in the source kit for various ways to install or point to Verilator binaries. In brief, if you installed Verilator using the package manager of your operating system, or did a "make install" to place Verilator into your default path, you do not need anything special in your environment, and should not have VERILATOR_ROOT set. However, if you installed Verilator from sources and want to run Verilator out of where you compiled Verilator, you need to point to the kit:</p>
<pre><code> # See above; don't do this if using an OS-distributed Verilator
export VERILATOR_ROOT=/path/to/where/verilator/was/installed
export PATH=$VERILATOR_ROOT/bin:$PATH</code></pre>
<p>Now we run Verilator on our little example.</p>
<pre><code> verilator -Wall --cc our.v --exe --build sim_main.cpp</code></pre>
<p>We can see the source code under the "obj_dir" directory. See the FILES section below for descriptions of some of the files that were created.</p>
<pre><code> ls -l obj_dir</code></pre>
<p>(Verilator included a default compile rule and link rule, since we used --exe and passed a .cpp file on the Verilator command line. Verilator also then used <code>make</code> to build a final executable. You can also write your own compile rules, and run make yourself as we'll show in the SYSTEMC section.)</p>
<p>And now we run it</p>
<pre><code> obj_dir/Vour</code></pre>
<p>And we get as output</p>
<pre><code> Hello World
- our.v:2: Verilog $finish</code></pre>
<p>Really, you're better off writing a Makefile to do all this for you. Then, when your source changes it will automatically run all of these steps; to aid this Verilator can create a makefile dependency file. See the examples directory in the distribution.</p>
<h1 id="EXAMPLE-SYSTEMC-EXECUTION">EXAMPLE SYSTEMC EXECUTION</h1>
<p>This is an example similar to the above, but using SystemC.</p>
<pre><code> mkdir test_our_sc
cd test_our_sc
cat >our.v <<'EOF'
module our (clk);
input clk; // Clock is required to get initial activation
always @ (posedge clk)
begin $display("Hello World"); $finish; end
endmodule
EOF
cat >sc_main.cpp <<'EOF'
#include "Vour.h"
int sc_main(int argc, char** argv) {
Verilated::commandArgs(argc, argv);
sc_clock clk ("clk", 10, 0.5, 3, true);
Vour* top;
top = new Vour("top");
top->clk(clk);
while (!Verilated::gotFinish()) { sc_start(1, SC_NS); }
delete top;
exit(0);
}
EOF</code></pre>
<p>See the README in the source kit for various ways to install or point to Verilator binaries. In brief, if you installed Verilator using the package manager of your operating system, or did a "make install" to place Verilator into your default path, you do not need anything special in your environment, and should not have VERILATOR_ROOT set. However, if you installed Verilator from sources and want to run Verilator out of where you compiled Verilator, you need to point to the kit:</p>
<pre><code> # See above; don't do this if using an OS-distributed Verilator
export VERILATOR_ROOT=/path/to/where/verilator/was/installed
export PATH=$VERILATOR_ROOT/bin:$PATH</code></pre>
<p>Now we run Verilator on our little example.</p>
<pre><code> verilator -Wall --sc our.v</code></pre>
<p>We then can compile it</p>
<pre><code> make -j -C obj_dir -f Vour.mk Vour__ALL.a
make -j -C obj_dir -f Vour.mk ../sc_main.o verilated.o</code></pre>
<p>And link with SystemC. Note your path to the libraries may vary, depending on the operating system.</p>
<pre><code> cd obj_dir
export SYSTEMC_LIBDIR=/path/to/where/libsystemc.a/exists
export LD_LIBRARY_PATH=$SYSTEMC_LIBDIR:$LD_LIBRARY_PATH
# Might be needed if SystemC 2.3.0
export SYSTEMC_CXX_FLAGS=-pthread
g++ -L$SYSTEMC_LIBDIR ../sc_main.o Vour__ALL.a verilated.o \
-o Vour -lsystemc</code></pre>
<p>And now we run it</p>
<pre><code> cd ..
obj_dir/Vour</code></pre>
<p>And we get the same output as the C++ example:</p>
<pre><code> Hello World
- our.v:2: Verilog $finish</code></pre>
<p>Really, you're better off using a Makefile to do all this for you. Then, when your source changes it will automatically run all of these steps. See the examples directory in the distribution.</p>
<h1 id="EVALUATION-LOOP">EVALUATION LOOP</h1>
<p>When using SystemC, evaluation of the Verilated model is managed by the SystemC kernel, and for the most part can be ignored. When using C++, the user must call eval(), or eval_step() and eval_end_step().</p>
<p>1. When there is a single design instantiated at the C++ level that needs to evaluate, just call designp->eval().</p>
<p>2. When there are multiple designs instantiated at the C++ level that need to evaluate, call first_designp->eval_step() then ->eval_step() on all other designs. Then call ->eval_end_step() on the first design then all other designs. If there is only a single design, you would call eval_step() then eval_end_step(); in fact eval() described above is just a wrapper which calls these two functions.</p>
<p>When eval() is called Verilator looks for changes in clock signals and evaluates related sequential always blocks, such as computing always_ff @ (posedge...) outputs. Then Verilator evaluates combinatorial logic.</p>
<p>Note combinatorial logic is not computed before sequential always blocks are computed (for speed reasons). Therefore it is best to set any non-clock inputs up with a separate eval() call before changing clocks.</p>
<p>Alternatively, if all always_ff statements use only the posedge of clocks, or all inputs go directly to always_ff statements, as is typical, then you can change non-clock inputs on the negative edge of the input clock, which will be faster as there will be fewer eval() calls.</p>
<p>For more information on evaluation, see docs/internals.adoc in the distribution.</p>
<h1 id="BENCHMARKING-OPTIMIZATION">BENCHMARKING & OPTIMIZATION</h1>
<p>For best performance, run Verilator with the "-O3 --x-assign fast --x-initial fast --noassert" flags. The -O3 flag will require longer time to run Verilator, and "--x-assign fast --x-initial fast" may increase the risk of reset bugs in trade for performance; see the above documentation for these flags.</p>
<p>If using Verilated multithreaded, use <code>numactl</code> to ensure you are using non-conflicting hardware resources. See <a href="#MULTITHREADING">"MULTITHREADING"</a>.</p>
<p>Minor Verilog code changes can also give big wins. You should not have any UNOPTFLAT warnings from Verilator. Fixing these warnings can result in huge improvements; one user fixed their one UNOPTFLAT warning by making a simple change to a clock latch used to gate clocks and gained a 60% performance improvement.</p>
<p>Beyond that, the performance of a Verilated model depends mostly on your C++ compiler and size of your CPU's caches. Experience shows that large models are often limited by the size of the instruction cache, and as such reducing code size if possible can be beneficial.</p>
<p>The supplied $VERILATOR_ROOT/include/verilated.mk file uses the OPT, OPT_FAST, OPT_SLOW and OPT_GLOBAL variables to control optimization. You can set these when compiling the output of Verilator with Make, for example:</p>
<pre><code> make OPT_FAST="-Os -march=native" -f Vour.mk Vour__ALL.a</code></pre>
<p>OPT_FAST specifies optimization flags for those parts of the model that are on the fast path. This is mostly code that is executed every cycle. OPT_SLOW applies to slow-path code, which executes rarely, often only once at the beginning or end of simulation. Note that OPT_SLOW is ignored if VM_PARALLEL_BUILDS is not 1, in which case all generated code will be compiled in a single compilation unit using OPT_FAST. See also the <code>--output-split</code> option. The OPT_GLOBAL variable applies to common code in the runtime library used by Verilated models (shipped in $VERILATOR_ROOT/include). Additional C++ files passed on the verilator command line use OPT_FAST. The OPT variable applies to all compilation units in addition to the specific OPT_* variables described above.</p>
<p>You can also use the -CFLAGS and/or -LDFLAGS options on the verilator command line to pass flags directly to the compiler or linker.</p>
<p>The default values of the OPT_* variables are chosen to yield good simulation speed with reasonable C++ compilation times. To this end, OPT_FAST is set to "-Os" by default. Higher optimization such as "-O2" or "-O3" may help (though often they provide only a very small performance benefit), but compile times may be excessively large even with medium sized designs. Compilation times can be improved at the expense of simulation speed by reducing optimization, for example with OPT_FAST="-O0". Often good simulation speed can be achieved with OPT_FAST="-O1 -fstrict-aliasing" but with improved compilation times. Files controlled by OPT_SLOW have little effect on performance and therefore OPT_SLOW is empty by default (equivalent to "-O0") for improved compilation speed. In common use-cases there should be little benefit in changing OPT_SLOW. OPT_GLOBAL is set to "-Os" by default and there should rarely be a need to change it. As the runtime library is small in comparison to a lot of Verilated models, disabling optimization on the runtime library should not have a serious effect on overall compilation time, but may have detrimental effect on simulation speed, especially with tracing. In addition to the above, for best results use OPT="-march=native", the latest Clang compiler (about 10% faster than GCC), and link statically.</p>
<p>Generally the answer to which optimization level gives the best user experience depends on the use case and some experimentation can pay dividends. For a speedy debug cycle during development, especially on large designs where C++ compilation speed can dominate, consider using lower optimization to get to an executable faster. For throughput oriented use cases, for example regressions, it is usually worth spending extra compilation time to reduce total CPU time.</p>
<p>If you will be running many simulations on a single model, you can investigate profile guided optimization. With GCC, using -fprofile-arcs, then -fbranch-probabilities will yield another 15% or so.</p>
<p>Modern compilers also support link-time optimization (LTO), which can help especially if you link in DPI code. To enable LTO on GCC, pass "-flto" in both compilation and link. Note LTO may cause excessive compile times on large designs.</p>
<p>Unfortunately, using the optimizer with SystemC files can result in compilation taking several minutes. (The SystemC libraries have many little inlined functions that drive the compiler nuts.)</p>
<p>If you are using your own makefiles, you may want to compile the Verilated code with -DVL_INLINE_OPT=inline. This will inline functions, however this requires that all cpp files be compiled in a single compiler run.</p>
<p>You may uncover further tuning possibilities by profiling the Verilog code. Use Verilator's --prof-cfuncs, then GCC's -g -pg. You can then run either oprofile or gprof to see where in the C++ code the time is spent. Run the gprof output through verilator_profcfunc and it will tell you what Verilog line numbers on which most of the time is being spent.</p>
<p>When done, please let the author know the results. We like to keep tabs on how Verilator compares, and may be able to suggest additional improvements.</p>
<h1 id="FILES">FILES</h1>
<p>All output files are placed in the output directory specified with the <code>--Mdir</code> option, or "obj_dir" if not specified.</p>
<p>Verilator creates the following files in the output directory:</p>
<p>For --make gmake, it creates:</p>
<pre><code> {prefix}.mk // Make include file for compiling
{prefix}_classes.mk // Make include file with class names</code></pre>
<p>For --make cmake, it creates:</p>
<pre><code> {prefix}.cmake // CMake include script for compiling</code></pre>
<p>For -cc and -sc mode, it also creates:</p>
<pre><code> {prefix}.cpp // Top level C++ file
{prefix}.h // Top level header
{prefix}__Slow{__n}.cpp // Constructors and infrequent cold routines
{prefix}{__n}.cpp // Additional top C++ files (--output-split)
{prefix}{each_verilog_module}.cpp // Lower level internal C++ files
{prefix}{each_verilog_module}.h // Lower level internal header files
{prefix}{each_verilog_module}{__n}.cpp // Additional lower C++ files (--output-split)</code></pre>
<p>In certain debug and other modes, it also creates:</p>
<pre><code> {prefix}.xml // XML tree information (--xml)
{prefix}__Dpi.cpp // DPI import and export wrappers
{prefix}__Dpi.h // DPI import and export declarations
{prefix}__Inlines.h // Inline support functions
{prefix}__Syms.cpp // Global symbol table C++
{prefix}__Syms.h // Global symbol table header
{prefix}__Trace__Slow{__n}.cpp // Wave file generation code (--trace)
{prefix}__Trace{__n}.cpp // Wave file generation code (--trace)
{prefix}__cdc.txt // Clock Domain Crossing checks (--cdc)
{prefix}__stats.txt // Statistics (--stats)
{prefix}__idmap.txt // Symbol demangling (--protect-ids)</code></pre>
<p>It also creates internal files that can be mostly ignored:</p>
<pre><code> {mod_prefix}_{each_verilog_module}{__n}.vpp // Pre-processed verilog
{prefix}__ver.d // Make dependencies (-MMD)
{prefix}__verFiles.dat // Timestamps for skip-identical
{prefix}{misc}.dot // Debugging graph files (--debug)
{prefix}{misc}.tree // Debugging files (--debug)</code></pre>
<p>After running Make, the C++ compiler may produce the following:</p>
<pre><code> verilated{misc}.d // Intermediate dependencies
verilated{misc}.o // Intermediate objects
{mod_prefix}{misc}.d // Intermediate dependencies
{mod_prefix}{misc}.o // Intermediate objects
{prefix} // Final executable (w/--exe argument)
{prefix}__ALL.a // Library of all Verilated objects
{prefix}__ALL.cpp // Include of all code for single compile
{prefix}{misc}.d // Intermediate dependencies
{prefix}{misc}.o // Intermediate objects</code></pre>
<h1 id="ENVIRONMENT">ENVIRONMENT</h1>
<dl>
<dt id="LD_LIBRARY_PATH">LD_LIBRARY_PATH</dt>
<dd>
<p>A generic Linux/OS variable specifying what directories have shared object (.so) files. This path should include SystemC and any other shared objects needed at simulation runtime.</p>
</dd>
<dt id="MAKE">MAKE</dt>
<dd>
<p>Names the executable of the make command invoked when using the --build option. Some operating systems may require "gmake" to this variable to launch GNU make. If this variable is not specified, "make" is used.</p>
</dd>
<dt id="OBJCACHE">OBJCACHE</dt>
<dd>
<p>Optionally specifies a caching or distribution program to place in front of all runs of the C++ compiler. For example, "ccache". If using distcc or icecc/icecream, they would generally be run under cache; see the documentation for those programs. If OBJCACHE is not set, and at configure time ccache was present, ccache will be used as a default.</p>
</dd>
<dt id="SYSTEMC">SYSTEMC</dt>
<dd>
<p>Deprecated. Used only if SYSTEMC_INCLUDE or SYSTEMC_LIBDIR is not set. If set, specifies the directory containing the SystemC distribution. If not specified, it will come from a default optionally specified at configure time (before Verilator was compiled).</p>
</dd>
<dt id="SYSTEMC_ARCH">SYSTEMC_ARCH</dt>
<dd>
<p>Deprecated. Used only if SYSTEMC_LIBDIR is not set. Specifies the architecture name used by the SystemC kit. This is the part after the dash in the lib-{...} directory name created by a 'make' in the SystemC distribution. If not set, Verilator will try to intuit the proper setting, or use the default optionally specified at configure time (before Verilator was compiled).</p>
</dd>
<dt id="SYSTEMC_CXX_FLAGS">SYSTEMC_CXX_FLAGS</dt>
<dd>
<p>Specifies additional flags that are required to be passed to GCC when building the SystemC model. System 2.3.0 may need this set to "-pthread".</p>
</dd>
<dt id="SYSTEMC_INCLUDE">SYSTEMC_INCLUDE</dt>
<dd>
<p>If set, specifies the directory containing the systemc.h header file. If not specified, it will come from a default optionally specified at configure time (before Verilator was compiled), or computed from SYSTEMC/include.</p>
</dd>
<dt id="SYSTEMC_LIBDIR">SYSTEMC_LIBDIR</dt>
<dd>
<p>If set, specifies the directory containing the libsystemc.a library. If not specified, it will come from a default optionally specified at configure time (before Verilator was compiled), or computed from SYSTEMC/lib-SYSTEMC_ARCH.</p>
</dd>
<dt id="VERILATOR_BIN">VERILATOR_BIN</dt>
<dd>
<p>If set, specifies an alternative name of the <code>verilator</code> binary. May be used for debugging and selecting between multiple operating system builds.</p>
</dd>
<dt id="VERILATOR_COVERAGE_BIN">VERILATOR_COVERAGE_BIN</dt>
<dd>
<p>If set, specifies an alternative name of the <code>verilator_coverage binary</code>. May be used for debugging and selecting between multiple operating system builds.</p>
</dd>
<dt id="VERILATOR_GDB">VERILATOR_GDB</dt>
<dd>
<p>If set, the command to run when using the --gdb option, such as "ddd". If not specified, it will use "gdb".</p>
</dd>
<dt id="VERILATOR_ROOT">VERILATOR_ROOT</dt>
<dd>
<p>Specifies the directory containing the distribution kit. This is used to find the executable, Perl library, and include files. If not specified, it will come from a default optionally specified at configure time (before Verilator was compiled). It should not be specified if using a pre-compiled Verilator package as the hard-coded value should be correct.</p>
</dd>
</dl>
<h1 id="CONNECTING-TO-C">CONNECTING TO C++</h1>
<p>Verilator creates a <i>prefix</i>.h and <i>prefix</i>.cpp file for the top level module, together with additional .h and .cpp files for internals. See the examples directory in the kit for examples.</p>
<p>After the model is created, there will be a <i>prefix</i>.mk file that may be used with Make to produce a <i>prefix</i>__ALL.a file with all required objects in it. This is then linked with the user's C++ main loop to create the simulation executable.</p>
<p>The user must write the C++ main loop of the simulation. Here is a simple example:</p>
<pre><code> #include <verilated.h> // Defines common routines
#include <iostream> // Need std::cout
#include "Vtop.h" // From Verilating "top.v"
Vtop *top; // Instantiation of module
vluint64_t main_time = 0; // Current simulation time
// This is a 64-bit integer to reduce wrap over issues and
// allow modulus. This is in units of the timeprecision
// used in Verilog (or from --timescale-override)
double sc_time_stamp () { // Called by $time in Verilog
return main_time; // converts to double, to match
// what SystemC does
}
int main(int argc, char** argv) {
Verilated::commandArgs(argc, argv); // Remember args
top = new Vtop; // Create instance
top->reset_l = 0; // Set some inputs
while (!Verilated::gotFinish()) {
if (main_time > 10) {
top->reset_l = 1; // Deassert reset
}
if ((main_time % 10) == 1) {
top->clk = 1; // Toggle clock
}
if ((main_time % 10) == 6) {
top->clk = 0;
}
top->eval(); // Evaluate model
cout << top->out << endl; // Read a output
main_time++; // Time passes...
}
top->final(); // Done simulating
// // (Though this example doesn't get here)
delete top;
}</code></pre>
<p>Note signals are read and written as member variables of the model. You call the eval() method to evaluate the model. When the simulation is complete call the final() method to execute any SystemVerilog final blocks, and complete any assertions. See <a href="#EVALUATION-LOOP">"EVALUATION LOOP"</a>.</p>
<h1 id="CONNECTING-TO-SYSTEMC">CONNECTING TO SYSTEMC</h1>
<p>Verilator will convert the top level module to a SC_MODULE. This module will plug directly into a SystemC netlist.</p>
<p>The SC_MODULE gets the same pinout as the Verilog module, with the following type conversions: Pins of a single bit become bool. Pins 2-32 bits wide become uint32_t's. Pins 33-64 bits wide become sc_bv's or vluint64_t's depending on the --no-pins64 switch. Wider pins become sc_bv's. (Uints simulate the fastest so are used where possible.)</p>
<p>Lower modules are not pure SystemC code. This is a feature, as using the SystemC pin interconnect scheme everywhere would reduce performance by an order of magnitude.</p>
<h1 id="DIRECT-PROGRAMMING-INTERFACE-DPI">DIRECT PROGRAMMING INTERFACE (DPI)</h1>
<p>Verilator supports SystemVerilog Direct Programming Interface import and export statements. Only the SystemVerilog form ("DPI-C") is supported, not the original Synopsys-only DPI.</p>
<h2 id="DPI-Example">DPI Example</h2>
<p>In the SYSTEMC example above, if you wanted to import C++ functions into Verilog, put in our.v:</p>
<pre><code> import "DPI-C" function int add (input int a, input int b);
initial begin
$display("%x + %x = %x", 1, 2, add(1,2));
endtask</code></pre>
<p>Then after Verilating, Verilator will create a file Vour__Dpi.h with the prototype to call this function:</p>
<pre><code> extern int add (int a, int b);</code></pre>
<p>From the sc_main.cpp file (or another .cpp file passed to the Verilator command line, or the link), you'd then:</p>
<pre><code> #include "svdpi.h"
#include "Vour__Dpi.h"
int add(int a, int b) { return a+b; }</code></pre>
<h2 id="DPI-System-Task-Functions">DPI System Task/Functions</h2>
<p>Verilator extends the DPI format to allow using the same scheme to efficiently add system functions. Simply use a dollar-sign prefixed system function name for the import, but note it must be escaped.</p>
<pre><code> export "DPI-C" function integer \$myRand;
initial $display("myRand=%d", $myRand());</code></pre>
<p>Going the other direction, you can export Verilog tasks so they can be called from C++:</p>
<pre><code> export "DPI-C" task publicSetBool;
task publicSetBool;
input bit in_bool;
var_bool = in_bool;
endtask</code></pre>
<p>Then after Verilating, Verilator will create a file Vour__Dpi.h with the prototype to call this function:</p>
<pre><code> extern void publicSetBool(svBit in_bool);</code></pre>
<p>From the sc_main.cpp file, you'd then:</p>
<pre><code> #include "Vour__Dpi.h"
publicSetBool(value);</code></pre>
<p>Or, alternatively, call the function under the design class. This isn't DPI compatible but is easier to read and better supports multiple designs.</p>
<pre><code> #include "Vour__Dpi.h"
Vour::publicSetBool(value);
// or top->publicSetBool(value);</code></pre>
<p>Note that if the DPI task or function accesses any register or net within the RTL, it will require a scope to be set. This can be done using the standard functions within svdpi.h, after the module is instantiated, but before the task(s) and/or function(s) are called.</p>
<p>For example, if the top level module is instantiated with the name "dut" and the name references within tasks are all hierarchical (dotted) names with respect to that top level module, then the scope could be set with</p>
<pre><code> #include "svdpi.h"
...
svSetScope(svGetScopeFromName("TOP.dut"));</code></pre>
<p>(Remember that Verilator adds a "TOP" to the top of the module hierarchy.)</p>
<p>Scope can also be set from within a DPI imported C function that has been called from Verilog by querying the scope of that function. See the sections on DPI Context Functions and DPI Header Isolation below and the comments within the svdpi.h header for more information.</p>
<h2 id="DPI-Display-Functions">DPI Display Functions</h2>
<p>Verilator allows writing $display like functions using this syntax:</p>
<pre><code> import "DPI-C" function void
\$my_display(input string formatted /*verilator sformat*/ );</code></pre>
<p>The /*verilator sformat*/ indicates that this function accepts a $display like format specifier followed by any number of arguments to satisfy the format.</p>
<h2 id="DPI-Context-Functions">DPI Context Functions</h2>
<p>Verilator supports IEEE DPI Context Functions. Context imports pass the simulator context, including calling scope name, and filename and line number to the C code. For example, in Verilog:</p>
<pre><code> import "DPI-C" context function int dpic_line();
initial $display("This is line %d, again, line %d\n", `line, dpic_line());</code></pre>
<p>This will call C++ code which may then use the svGet* functions to read information, in this case the line number of the Verilog statement that invoked the dpic_line function:</p>
<pre><code> int dpic_line() {
// Get a scope: svScope scope = svGetScope();
const char* scopenamep = svGetNameFromScope(scope);
assert(scopenamep);
const char* filenamep = "";
int lineno = 0;
if (svGetCallerInfo(&filenamep, &lineno)) {
printf("dpic_line called from scope %s on line %d\n",
scopenamep, lineno);
return lineno;
} else {
return 0;
}
}</code></pre>
<p>See the IEEE Standard for more information.</p>
<h2 id="DPI-Header-Isolation">DPI Header Isolation</h2>
<p>Verilator places the IEEE standard header files such as svdpi.h into a separate include directory, vltstd (VeriLaTor STandarD). When compiling most applications $VERILATOR_ROOT/include/vltstd would be in the include path along with the normal $VERILATOR_ROOT/include. However, when compiling Verilated models into other simulators which have their own svdpi.h and similar standard files with different contents, the vltstd directory should not be included to prevent picking up incompatible definitions.</p>
<h2 id="Public-Functions">Public Functions</h2>
<p>Instead of DPI exporting, there's also Verilator public functions, which are slightly faster, but less compatible.</p>
<h1 id="VERIFICATION-PROCEDURAL-INTERFACE-VPI">VERIFICATION PROCEDURAL INTERFACE (VPI)</h1>
<p>Verilator supports a very limited subset of the VPI. This subset allows inspection, examination, value change callbacks, and depositing of values to public signals only.</p>
<p>VPI is enabled with the verilator --vpi switch.</p>
<p>To access signals via the VPI, Verilator must be told exactly which signals are to be accessed. This is done using the Verilator public pragmas documented below.</p>
<p>Verilator has an important difference from an event based simulator; signal values that are changed by the VPI will not immediately propagate their values, instead the top level header file's eval() method must be called. Normally this would be part of the normal evaluation (i.e. the next clock edge), not as part of the value change. This makes the performance of VPI routines extremely fast compared to event based simulators, but can confuse some test-benches that expect immediate propagation.</p>
<p>Note the VPI by its specified implementation will always be much slower than accessing the Verilator values by direct reference (structure->module->signame), as the VPI accessors perform lookup in functions at simulation runtime requiring at best hundreds of instructions, while the direct references are evaluated by the compiler and result in only a couple of instructions.</p>
<p>For signal callbacks to work the main loop of the program must call VerilatedVpi::callValueCbs().</p>
<h2 id="VPI-Example">VPI Example</h2>
<p>In the below example, we have readme marked read-only, and writeme which if written from outside the model will have the same semantics as if it changed on the specified clock edge.</p>
<pre><code> cat >our.v <<'EOF'
module our (input clk);
reg readme /*verilator public_flat_rd*/;
reg writeme /*verilator public_flat_rw @(posedge clk) */;
initial $finish;
endmodule
EOF</code></pre>
<p>There are many online tutorials and books on the VPI, but an example that accesses the above signal "readme" would be:</p>
<pre><code> cat >sim_main.cpp <<'<<EOF'
#include "Vour.h"
#include "verilated.h"
#include "verilated_vpi.h" // Required to get definitions
vluint64_t main_time = 0; // See comments in first example
double sc_time_stamp() { return main_time; }
void read_and_check() {
vpiHandle vh1 = vpi_handle_by_name((PLI_BYTE8*)"TOP.our.readme", NULL);
if (!vh1) { vl_fatal(__FILE__, __LINE__, "sim_main", "No handle found"); }
const char* name = vpi_get_str(vpiName, vh1);
printf("Module name: %s\n", name); // Prints "readme"
s_vpi_value v;
v.format = vpiIntVal;
vpi_get_value(vh1, &v);
printf("Value of v: %d\n", v.value.integer); // Prints "readme"
}
int main(int argc, char** argv, char** env) {
Verilated::commandArgs(argc, argv);
Vour* top = new Vour;
Verilated::internalsDump(); // See scopes to help debug
while (!Verilated::gotFinish()) {
top->eval();
VerilatedVpi::callValueCbs(); // For signal callbacks
read_and_check();
}
delete top;
exit(0);
}
EOF</code></pre>
<h1 id="CROSS-COMPILATION">CROSS COMPILATION</h1>
<p>Verilator supports cross-compiling Verilated code. This is generally used to run Verilator on a Linux system and produce C++ code that is then compiled on Windows.</p>
<p>Cross compilation involves up to three different OSes. The build system is where you configured and compiled Verilator, the host system where you run Verilator, and the target system where you compile the Verilated code and run the simulation.</p>
<p>Currently, Verilator requires the build and host system type to be the same, though the target system type may be different. To support this, ./configure and make Verilator on the build system. Then, run Verilator on the host system. Finally, the output of Verilator may be compiled on the different target system.</p>
<p>To support this, none of the files that Verilator produces will reference any configure generated build-system specific files, such as config.h (which is renamed in Verilator to config_build.h to reduce confusion.) The disadvantage of this approach is that include/verilatedos.h must self-detect the requirements of the target system, rather than using configure.</p>
<p>The target system may also require edits to the Makefiles, the simple Makefiles produced by Verilator presume the target system is the same type as the build system.</p>
<h2 id="CMake">CMake</h2>
<p>Verilator can be run using CMake, which takes care of both running Verilator and compiling the output. There is a CMake example in the examples/ directory. The following is a minimal CMakeLists.txt that would build the code listed in "EXAMPLE C++ EXECUTION":</p>
<pre><code> project(cmake_example)
find_package(verilator HINTS $ENV{VERILATOR_ROOT})
add_executable(Vour sim_main.cpp)
verilate(Vour SOURCES our.v)</code></pre>
<p>find_package will automatically find an installed copy of Verilator, or use a local build if VERILATOR_ROOT is set.</p>
<p>It is recommended to use CMake >= 3.12 and the Ninja generator, though other combinations should work. To build with CMake, change to the folder containing CMakeLists.txt and run:</p>
<pre><code> mkdir build
cd build
cmake -GNinja ..
ninja</code></pre>
<p>Or to build with your system default generator:</p>
<pre><code> mkdir build
cd build
cmake ..
cmake --build .</code></pre>
<p>If you're building the example you should have an executable to run:</p>
<pre><code> ./Vour</code></pre>
<p>The package sets the CMake variables verilator_FOUND, VERILATOR_ROOT and VERILATOR_BIN to the appropriate values, and also creates a verilate() function. verilate() will automatically create custom commands to run Verilator and add the generated C++ sources to the target specified.</p>
<pre><code> verilate(target SOURCES source ... [TOP_MODULE top] [PREFIX name]
[TRACE] [TRACE_FST] [SYSTEMC] [COVERAGE]
[INCLUDE_DIRS dir ...] [OPT_SLOW ...] [OPT_FAST ...]
[OPT_GLOBAL ..] [DIRECTORY dir] [VERILATOR_ARGS ...])</code></pre>
<p>Lowercase and ... should be replaced with arguments, the uppercase parts delimit the arguments and can be passed in any order, or left out entirely if optional.</p>
<p>verilate(target ...) can be called multiple times to add other verilog modules to an executable or library target.</p>
<p>When generating Verilated SystemC sources, you should also include the SystemC include directories and link to the SystemC libraries.</p>
<p>Verilator's CMake support provides a convenience function to automatically find and link to the SystemC library. It can be used as:</p>
<pre><code> verilator_link_systemc(target)</code></pre>
<p>where target is the name of your target.</p>
<p>The search paths can be configured by setting some variables:</p>
<p>- The variables SYSTEMC_INCLUDE and SYSTEMC_LIBDIR to give a direct path to the SystemC include an library path.</p>
<p>- SYSTEMC_ROOT to set the installation prefix of an installed SystemC library.</p>
<p>- SYSTEMC to set the installation prefix of an installed SystemC library (same as above).</p>
<p>- When using Accellera's SystemC with CMake support, a CMake target is available that simplifies the above steps. This will only work if the SystemC installation can be found by CMake. This can be configured by setting the CMAKE_PREFIX_PATH variable during CMake configuration.</p>
<p>Don't forget to set the same C++ standard for the Verilated sources as the SystemC library. This can be specified using the SYSTEMC_CXX_FLAGS environment variable.</p>
<dl>
<dt id="target">target</dt>
<dd>
<p>Name of a target created by add_executable or add_library.</p>
</dd>
<dt id="SOURCES">SOURCES</dt>
<dd>
<p>List of Verilog files to Verilate. Must have at least one file.</p>
</dd>
<dt id="PREFIX">PREFIX</dt>
<dd>
<p>Optional. Sets the Verilator output prefix. Defaults to the name of the first source file with a "V" prepended. Must be unique in each call to verilate(), so this is necessary if you build a module multiple times with different parameters. Must be a valid C++ identifier, i.e. contains no white space and only characters A-Z, a-z, 0-9 or _.</p>
</dd>
<dt id="TOP_MODULE">TOP_MODULE</dt>
<dd>
<p>Optional. Sets the name of the top module. Defaults to the name of the first file in the SOURCES array.</p>
</dd>
<dt id="TRACE">TRACE</dt>
<dd>
<p>Optional. Enables VCD tracing if present, equivalent to "VERILATOR_ARGS --trace".</p>
</dd>
<dt id="TRACE_FST">TRACE_FST</dt>
<dd>
<p>Optional. Enables FST tracing if present, equivalent to "VERILATOR_ARGS --trace-fst".</p>
</dd>
<dt id="SYSTEMC1">SYSTEMC</dt>
<dd>
<p>Optional. Enables SystemC mode, defaults to C++ if not specified.</p>
</dd>
<dt id="COVERAGE">COVERAGE</dt>
<dd>
<p>Optional. Enables coverage if present, equivalent to "VERILATOR_ARGS --coverage"</p>
</dd>
<dt id="INCLUDE_DIRS">INCLUDE_DIRS</dt>
<dd>
<p>Optional. Sets directories that Verilator searches (same as -y).</p>
</dd>
<dt id="OPT_SLOW">OPT_SLOW</dt>
<dd>
<p>Optional. Set compiler flags for the slow path. You may want to reduce the optimization level to improve compile times with large designs.</p>
</dd>
<dt id="OPT_FAST">OPT_FAST</dt>
<dd>
<p>Optional. Set compiler flags for the fast path.</p>
</dd>
<dt id="OPT_GLOBAL">OPT_GLOBAL</dt>
<dd>
<p>Optional. Set compiler flags for the common runtime library used by Verilated models.</p>
</dd>
<dt id="DIRECTORY">DIRECTORY</dt>
<dd>
<p>Optional. Set the verilator output directory. It is preferable to use the default, which will avoid collisions with other files.</p>
</dd>
<dt id="VERILATOR_ARGS">VERILATOR_ARGS</dt>
<dd>
<p>Optional. Extra arguments to Verilator. Do not specify --Mdir or --prefix here, use DIRECTORY or PREFIX.</p>
</dd>
</dl>
<h1 id="MULTITHREADING">MULTITHREADING</h1>
<p>Verilator supports multithreaded simulation models.</p>
<p>With --no-threads, the default, the model is not thread safe, and any use of more than one thread calling into one or even different Verilated models may result in unpredictable behavior. This gives the highest single thread performance.</p>
<p>With --threads 1, the generated model is single threaded, however the support libraries are multithread safe. This allows different instantiations of model(s) to potentially each be run under a different thread. All threading is the responsibility of the user's C++ testbench.</p>
<p>With --threads N, where N is at least 2, the generated model will be designed to run in parallel on N threads. The thread calling eval() provides one of those threads, and the generated model will create and manage the other N-1 threads. It's the client's responsibility not to oversubscribe the available CPU cores. Under CPU oversubscription, the Verilated model should not livelock nor deadlock, however, you can expect performance to be far worse than it would be with proper ratio of threads and CPU cores.</p>
<p>The remainder of this section describe behavior with --threads 1 or --threads N (not --no-threads).</p>
<p>VL_THREADED is defined when compiling a threaded Verilated module, causing the Verilated support classes become threadsafe.</p>
<p>The thread used for constructing a model must be the same thread that calls eval() into the model, this is called the "eval thread". The thread used to perform certain global operations such as saving and tracing must be done by a "main thread". In most cases the eval thread and main thread are the same thread (i.e. the user's top C++ testbench runs on a single thread), but this is not required.</p>
<p>The --trace-threads options can be used to produce trace dumps using multiple threads. If --trace-threads is set without --threads, then --trace-threads will imply --threads 1, i.e.: the support libraries will be thread safe.</p>
<p>With --trace-threads 0, trace dumps are produced on the main thread. This again gives the highest single thread performance.</p>
<p>With --trace-threads N, where N is at least 1, N additional threads will be created and managed by the trace files (e.g.: VerilatedVcdC or VerilatedFstC), to generate the trace dump. The main thread will be released to proceed with execution as soon as possible, though some blocking of the main thread is still necessary while capturing the trace. Different trace formats can utilize a various number of threads. See the --trace-threads option.</p>
<p>When running a multithreaded model, the default Linux task scheduler often works against the model, by assuming threads are short lived, and thus often schedules threads using multiple hyperthreads within the same physical core. For best performance use the <code>numactl</code> program to (when the threading count fits) select unique physical cores on the same socket. The same applies for --trace-threads as well.</p>
<p>As an example, if a model was Verilated with "--threads 4", we consult</p>
<pre><code> egrep 'processor|physical id|core id' /proc/cpuinfo</code></pre>
<p>To select cores 0, 1, 2, and 3 that are all located on the same socket (0) but different physical cores. (Also useful is "numactl --hardware", or <code>lscpu</code> but those doesn't show Hyperthreading cores.) Then we execute</p>
<pre><code> numactl -m 0 -C 0,1,2,3 -- verilated_executable_name</code></pre>
<p>This will limit memory to socket 0, and threads to cores 0, 1, 2, 3, (presumably on socket 0) optimizing performance. Of course this must be adjusted if you want another simulator using e.g. socket 1, or if you Verilated with a different number of threads. To see what CPUs are actually used, use --prof-threads.</p>
<h2 id="Multithreaded-Verilog-and-Library-Support">Multithreaded Verilog and Library Support</h2>
<p>$display/$stop/$finish are delayed until the end of an eval() call in order to maintain ordering between threads. This may result in additional tasks completing after the $stop or $finish.</p>
<ul>
<p>If using --coverage, the coverage routines are fully thread safe.</p>
<p>If using --dpi, Verilator assumes pure DPI imports are thread safe, balancing performance versus safety. See --threads-dpi.</p>
<p>If using --savable, the save/restore classes are not multithreaded and must be called only by the eval thread.</p>
<p>If using --sc, the SystemC kernel is not thread safe, therefore the eval thread and main thread must be the same.</p>
<p>If using --trace, the tracing classes must be constructed and called from the main thread.</p>
<p>If using --vpi, since SystemVerilog VPI was not architected by IEEE to be multithreaded, Verilator requires all VPI calls are only made from the main thread.</p>
</ul>
<h1 id="CONFIGURATION-FILES">CONFIGURATION FILES</h1>
<p>In addition to the command line, warnings and other features may be controlled by configuration files, typically named with the .vlt extension. An example:</p>
<pre><code> `verilator_config
lint_off -rule WIDTH
lint_off -rule CASEX -file "silly_vendor_code.v"</code></pre>
<p>This disables WIDTH warnings globally, and CASEX for a specific file.</p>
<p>Configuration files are fed through the normal Verilog preprocessor prior to parsing, so `ifdefs, `defines, and comments may be used as if it were normal Verilog code.</p>
<p>Note that file or line-specific configuration only applies to files read after the configuration file. It is therefore recommended to pass the configuration file to Verilator as the first file.</p>
<p>The grammar of configuration commands is as follows:</p>
<dl>
<dt id="verilator_config">`verilator_config</dt>
<dd>
<p>Take remaining text and treat it as Verilator configuration commands.</p>
</dd>
<dt id="coverage_on--file-filename--lines-line---line">coverage_on [-file "<filename>" [-lines <line> [ - <line> ]]]</dt>
<dd>
</dd>
<dt id="coverage_off--file-filename--lines-line---line">coverage_off [-file "<filename>" [-lines <line> [ - <line> ]]]</dt>
<dd>
<p>Enable/disable coverage for the specified filename (or wildcard with '*' or '?', or all files if omitted) and range of line numbers (or all lines if omitted). Often used to ignore an entire module for coverage analysis purposes.</p>
</dd>
<dt id="lint_on--rule-message--file-filename--lines-line---line">lint_on [-rule <message>] [-file "<filename>" [-lines <line> [ - <line>]]]</dt>
<dd>
</dd>
<dt id="lint_off--rule-message--file-filename--lines-line---line">lint_off [-rule <message>] [-file "<filename>" [-lines <line> [ - <line>]]]</dt>
<dd>
</dd>
<dt id="lint_off--rule-message--file-filename--match-string">lint_off [-rule <message>] [-file "<filename>"] [-match "<string>"]</dt>
<dd>
<p>Enable/disables the specified lint warning, in the specified filename (or wildcard with '*' or '?', or all files if omitted) and range of line numbers (or all lines if omitted).</p>
<p>With lint_off using '*' will override any lint_on directives in the source, i.e. the warning will still not be printed.</p>
<p>If the -rule is omitted, all lint warnings (see list in -Wno-lint) are enabled/disabled. This will override all later lint warning enables for the specified region.</p>
<p>If -match is set the linter warnings are matched against this (wildcard) string and are waived in case they match and iff rule and file (with wildcard) also match.</p>
<p>In previous versions -rule was named -msg. The latter is deprecated, but still works with a deprecation info, it may be removed in future versions.</p>
</dd>
<dt id="tracing_on--file-filename--lines-line---line">tracing_on [-file "<filename>" [-lines <line> [ - <line> ]]]</dt>
<dd>
</dd>
<dt id="tracing_off--file-filename--lines-line---line">tracing_off [-file "<filename>" [-lines <line> [ - <line> ]]]</dt>
<dd>
<p>Enable/disable waveform tracing for all future signals declared in the specified filename (or wildcard with '*' or '?', or all files if omitted) and range of line numbers (or all lines if omitted).</p>
<p>For tracing_off, cells below any module in the files/ranges specified will also not be traced.</p>
</dd>
<dt id="clock_enable--module-modulename--var-signame">clock_enable -module "<modulename>" -var "<signame>"</dt>
<dd>
<p>Indicate the signal is used to gate a clock, and the user takes responsibility for insuring there are no races related to it.</p>
<p>Same as /*verilator clock_enable*/, see <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information and an example.</p>
</dd>
<dt id="clocker--module-modulename--task-taskname--var-signame">clocker -module "<modulename>" [-task "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="clocker--module-modulename--function-funcname--var-signame">clocker -module "<modulename>" [-function "<funcname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="no_clocker--module-modulename--task-taskname--var-signame">no_clocker -module "<modulename>" [-task "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="no_clocker--module-modulename--function-funcname--var-signame">no_clocker -module "<modulename>" [-function "<funcname>"] -var "<signame>"</dt>
<dd>
<p>Indicate the signal is used as clock or not. This information is used by Verilator to mark the signal as clocker and propagate the clocker attribute automatically to derived signals. See <code>--clk</code> for more information.</p>
<p>Same as /*verilator clocker*/, see <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="coverage_block_off--module-modulename--block-blockname">coverage_block_off -module "<modulename>" -block "<blockname>"</dt>
<dd>
</dd>
<dt id="coverage_block_off--file-filename--line-lineno">coverage_block_off -file "<filename>" -line <lineno></dt>
<dd>
<p>Specifies the entire begin/end block should be ignored for coverage analysis purposes. Can either be specified as a named block or as a filename and line number.</p>
<p>Same as /*verilator coverage_block_off*/, see <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="full_case--file-filename--lines-lineno">full_case -file "<filename>" -lines <lineno></dt>
<dd>
</dd>
<dt id="parallel_case--file-filename--lines-lineno">parallel_case -file "<filename>" -lines <lineno></dt>
<dd>
<p>Same as "//synopsys full_case" and "//synopsys parallel_case". When these synthesis directives are discovered, Verilator will either formally prove the directive to be true, or failing that, will insert the appropriate code to detect failing cases at simulation runtime and print an "Assertion failed" error message.</p>
</dd>
<dt id="inline--module-modulename">inline -module "<modulename>"</dt>
<dd>
<p>Specifies the module may be inlined into any modules that use this module. Same as /*verilator inline_module*/, and see that under <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="isolate_assignments--module-modulename--task-taskname--var-signame">isolate_assignments -module "<modulename>" [-task "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="isolate_assignments--module-modulename--function-funcname--var-signame">isolate_assignments -module "<modulename>" [-function "<funcname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="isolate_assignments--module-modulename--function-fname">isolate_assignments -module "<modulename>" -function "<fname>"</dt>
<dd>
<p>Used to indicate the assignments to this signal in any blocks should be isolated into new blocks. When there is a large combinatorial block that is resulting in a UNOPTFLAT warning, attaching this to the signal causing a false loop may clear up the problem.</p>
<p>Same as /* verilator isolate_assignments */, see <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="no_inline--module-modulename">no_inline -module "<modulename>"</dt>
<dd>
<p>Specifies the module should not be inlined into any modules that use this module. Same as /*verilator no_inline_module*/, and see that under <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="no_inline--module-modulename--task-taskname">no_inline [-module "<modulename>"] -task "<taskname>"</dt>
<dd>
</dd>
<dt id="no_inline--module-modulename--function-funcname">no_inline [-module "<modulename>"] -function "<funcname>"</dt>
<dd>
<p>Specify the function or task should not be inlined into where it is used. This may reduce the size of the final executable when a task is used a very large number of times. For this flag to work, the task and tasks below it must be pure; they cannot reference any variables outside the task itself.</p>
<p>Same as /*verilator no_inline_task*/, see <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="public--module-modulename--task--function-taskname--var-signame">public [-module "<modulename>"] [-task/-function "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="public_flat--module-modulename--task--function-taskname--var-signame">public_flat [-module "<modulename>"] [-task/-function "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="public_flat_rd--module-modulename--task--function-taskname--var-signame">public_flat_rd [-module "<modulename>"] [-task/-function "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="public_flat_rw--module-modulename--task--function-taskname--var-signame-edge">public_flat_rw [-module "<modulename>"] [-task/-function "<taskname>"] -var "<signame>" "@(edge)"</dt>
<dd>
<p>Sets the variable to be public. Same as /*verilator public*/ or /*verilator public_flat*/ etc, see those under <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="sc_bv--module-modulename--task-taskname--var-signame">sc_bv -module "<modulename>" [-task "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="sc_bv--module-modulename--function-funcname--var-signame">sc_bv -module "<modulename>" [-function "<funcname>"] -var "<signame>"</dt>
<dd>
<p>Sets the port to be of sc_bv<<i>width</i>> type, instead of bool, vluint32_t or vluint64_t. Same as /*verilator sc_bv*/, see that under <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="sformat--module-modulename--task-taskname--var-signame">sformat [-module "<modulename>"] [-task "<taskname>"] -var "<signame>"</dt>
<dd>
</dd>
<dt id="sformat--module-modulename--function-funcname--var-signame">sformat [-module "<modulename>"] [-function "<funcname>"] -var "<signame>"</dt>
<dd>
<p>Must be applied to the final argument of type "input string" of a function or task to indicate the function or task should pass all remaining arguments through $sformatf. This allows creation of DPI functions with $display like behavior. See the test_regress/t/t_dpi_display.v file for an example.</p>
<p>Same as /*verilator sformat*/, see <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
<dt id="split_var--module-modulename--task-taskname--var-varname">split_var [-module "<modulename>"] [-task "<taskname>"] -var "<varname>"</dt>
<dd>
</dd>
<dt id="split_var--module-modulename--function-funcname--var-varname">split_var [-module "<modulename>"] [-function "<funcname>"] -var "<varname>"</dt>
<dd>
<p>Break the variable into multiple pieces typically to resolve UNOPTFLAT performance issues. Typically the variables to attach this to are recommended by Verilator itself, see UNOPTFLAT.</p>
<p>Same as /*verilator split_var*/, see <a href="#LANGUAGE-EXTENSIONS">"LANGUAGE EXTENSIONS"</a> for more information.</p>
</dd>
</dl>
<h1 id="LANGUAGE-STANDARD-SUPPORT">LANGUAGE STANDARD SUPPORT</h1>
<h2 id="Verilog-2001-IEEE-1364-2001-Support">Verilog 2001 (IEEE 1364-2001) Support</h2>
<p>Verilator supports most Verilog 2001 language features. This includes signed numbers, "always @*", generate statements, multidimensional arrays, localparam, and C-style declarations inside port lists.</p>
<h2 id="Verilog-2005-IEEE-1364-2005-Support">Verilog 2005 (IEEE 1364-2005) Support</h2>
<p>Verilator supports most Verilog 2005 language features. This includes the `begin_keywords and `end_keywords compiler directives, $clog2, and the uwire keyword.</p>
<h2 id="SystemVerilog-2005-IEEE-1800-2005-Support">SystemVerilog 2005 (IEEE 1800-2005) Support</h2>
<p>Verilator supports ==? and !=? operators, ++ and -- in some contexts, $bits, $countbits, $countones, $error, $fatal, $info, $isunknown, $onehot, $onehot0, $unit, $warning, always_comb, always_ff, always_latch, bit, byte, chandle, const, do-while, enum, export, final, import, int, interface, logic, longint, modport, package, program, shortint, struct, time, typedef, union, var, void, priority case/if, and unique case/if.</p>
<p>It also supports .name and .* interconnection.</p>
<p>Verilator partially supports concurrent assert and cover statements; see the enclosed coverage tests for the syntax which is allowed.</p>
<h2 id="SystemVerilog-2012-IEEE-1800-2012-Support">SystemVerilog 2012 (IEEE 1800-2012) Support</h2>
<p>Verilator implements a full SystemVerilog 2012 preprocessor, including function call-like preprocessor defines, default define arguments, `__FILE__, `__LINE__ and `undefineall.</p>
<p>Verilator currently has some support for SystemVerilog synthesis constructs. As SystemVerilog features enter common usage they are added; please file a bug if a feature you need is missing.</p>
<h2 id="SystemVerilog-2017-IEEE-1800-2017-Support">SystemVerilog 2017 (IEEE 1800-2017) Support</h2>
<p>Verilator supports the 2017 "for" loop constructs, and several minor cleanups made in 1800-2017.</p>
<h2 id="Verilog-AMS-Support">Verilog AMS Support</h2>
<p>Verilator implements a very small subset of Verilog AMS (Verilog Analog and Mixed-Signal Extensions) with the subset corresponding to those VMS keywords with near equivalents in the Verilog 2005 or SystemVerilog 2009 languages.</p>
<p>AMS parsing is enabled with "--language VAMS" or "--language 1800+VAMS".</p>
<p>At present Verilator implements ceil, exp, floor, ln, log, pow, sqrt, string, and wreal.</p>
<h2 id="Synthesis-Directive-Assertion-Support">Synthesis Directive Assertion Support</h2>
<p>With the --assert switch, Verilator reads any "//synopsys full_case" or "//synopsys parallel_case" directives. The same applies to any "//ambit synthesis", "//cadence" or "//pragma" directives of the same form.</p>
<p>When these synthesis directives are discovered, Verilator will either formally prove the directive to be true, or failing that, will insert the appropriate code to detect failing cases at simulation runtime and print an "Assertion failed" error message.</p>
<p>Verilator likewise also asserts any "unique" or "priority" SystemVerilog keywords on case statement, as well as "unique" on if statements. However, "priority if" is currently simply ignored.</p>
<h1 id="LANGUAGE-EXTENSIONS">LANGUAGE EXTENSIONS</h1>
<p>The following additional constructs are the extensions Verilator supports on top of standard Verilog code. Using these features outside of comments or `ifdef's may break other tools.</p>
<dl>
<dt id="FILE__">`__FILE__</dt>
<dd>
<p>The __FILE__ define expands to the current filename as a string, like C++'s __FILE__. This was incorporated into to the 1800-2009 standard (but supported by Verilator since 2006!)</p>
</dd>
<dt id="LINE__">`__LINE__</dt>
<dd>
<p>The __LINE__ define expands to the current filename as a string, like C++'s __LINE__. This was incorporated into to the 1800-2009 standard (but supported by Verilator since 2006!)</p>
</dd>
<dt id="error-string">`error <i>string</i></dt>
<dd>
<p>This will report an error when encountered, like C++'s #error.</p>
</dd>
<dt id="c-string">$c(<i>string</i>, ...);</dt>
<dd>
<p>The string will be embedded directly in the output C++ code at the point where the surrounding Verilog code is compiled. It may either be a standalone statement (with a trailing ; in the string), or a function that returns up to a 32-bit number (without a trailing ;). This can be used to call C++ functions from your Verilog code.</p>
<p>String arguments will be put directly into the output C++ code. Expression arguments will have the code to evaluate the expression inserted. Thus to call a C++ function, $c("func(",a,")") will result in 'func(a)' in the output C++ code. For input arguments, rather than hard-coding variable names in the string $c("func(a)"), instead pass the variable as an expression $c("func(",a,")"). This will allow the call to work inside Verilog functions where the variable is flattened out, and also enable other optimizations.</p>
<p>If you will be reading or writing any Verilog variables inside the C++ functions, the Verilog signals must be declared with /*verilator public*/.</p>
<p>You may also append an arbitrary number to $c, generally the width of the output. [signal_32_bits = $c32("...");] This allows for compatibility with other simulators which require a differently named PLI function name for each different output width.</p>
</dd>
<dt id="display-write-fdisplay-fwrite-sformat-swrite">$display, $write, $fdisplay, $fwrite, $sformat, $swrite</dt>
<dd>
<p>Format arguments may use C fprintf sizes after the % escape. Per the Verilog standard, %x prints a number with the natural width, and %0x prints a number with minimum width. Verilator extends this so %5x prints 5 digits per the C standard (this is unspecified in Verilog, but was incorporated into the 1800-2009).</p>
</dd>
<dt id="coverage_block_off">`coverage_block_off</dt>
<dd>
<p>Specifies the entire begin/end block should be ignored for coverage analysis. Must be inside a code block, e.g. within a begin/end pair. Same as /* verilator coverage_block_off */ and <code>coverage_block_off</code> in <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a>.</p>
</dd>
<dt id="systemc_header">`systemc_header</dt>
<dd>
<p>Take remaining text up to the next `verilog or `systemc_... mode switch and place it verbatim into the output .h file's header. Must be placed as a module item, e.g. directly inside a module/endmodule pair. Despite the name of this macro, this also works in pure C++ code.</p>
</dd>
<dt id="systemc_ctor">`systemc_ctor</dt>
<dd>
<p>Take remaining text up to the next `verilog or `systemc_... mode switch and place it verbatim into the C++ class constructor. Must be placed as a module item, e.g. directly inside a module/endmodule pair. Despite the name of this macro, this also works in pure C++ code.</p>
</dd>
<dt id="systemc_dtor">`systemc_dtor</dt>
<dd>
<p>Take remaining text up to the next `verilog or `systemc_... mode switch and place it verbatim into the C++ class destructor. Must be placed as a module item, e.g. directly inside a module/endmodule pair. Despite the name of this macro, this also works in pure C++ code.</p>
</dd>
<dt id="systemc_interface">`systemc_interface</dt>
<dd>
<p>Take remaining text up to the next `verilog or `systemc_... mode switch and place it verbatim into the C++ class interface. Must be placed as a module item, e.g. directly inside a module/endmodule pair. Despite the name of this macro, this also works in pure C++ code.</p>
</dd>
<dt id="systemc_imp_header">`systemc_imp_header</dt>
<dd>
<p>Take remaining text up to the next `verilog or `systemc_... mode switch and place it verbatim into the header of all files for this C++ class implementation. Must be placed as a module item, e.g. directly inside a module/endmodule pair. Despite the name of this macro, this also works in pure C++ code.</p>
</dd>
<dt id="systemc_implementation">`systemc_implementation</dt>
<dd>
<p>Take remaining text up to the next `verilog or `systemc_... mode switch and place it verbatim into a single file of the C++ class implementation. Must be placed as a module item, e.g. directly inside a module/endmodule pair. Despite the name of this macro, this also works in pure C++ code.</p>
<p>If you will be reading or writing any Verilog variables in the C++ functions, the Verilog signals must be declared with /*verilator public*/. See also the public task feature; writing an accessor may result in cleaner code.</p>
</dd>
<dt id="SYSTEMVERILOG">`SYSTEMVERILOG</dt>
<dd>
<p>The SYSTEMVERILOG, SV_COV_START and related standard defines are set by default when --language is 1800-*.</p>
</dd>
<dt id="VERILATOR">`VERILATOR</dt>
<dd>
</dd>
<dt id="verilator">`verilator</dt>
<dd>
</dd>
<dt id="verilator3">`verilator3</dt>
<dd>
<p>The VERILATOR, verilator and verilator3 defines are set by default so you may `ifdef around tool specific constructs.</p>
</dd>
<dt id="verilator_config1">`verilator_config</dt>
<dd>
<p>Take remaining text up to the next `verilog mode switch and treat it as Verilator configuration commands.</p>
</dd>
<dt id="verilog">`verilog</dt>
<dd>
<p>Switch back to processing Verilog code after a `systemc_... mode switch. The Verilog code returns to the last language mode specified with `begin_keywords, or SystemVerilog if none was specified.</p>
</dd>
<dt id="verilator-clock_enable">/*verilator clock_enable*/</dt>
<dd>
<p>Used after a signal declaration to indicate the signal is used to gate a clock, and the user takes responsibility for insuring there are no races related to it. (Typically by adding a latch, and running static timing analysis.) For example:</p>
<pre><code> reg enable_r /*verilator clock_enable*/;
wire gated_clk = clk & enable_r;
always_ff @ (posedge clk)
enable_r <= enable_early;</code></pre>
<p>The clock_enable attribute will cause the clock gate to be ignored in the scheduling algorithm, sometimes required for correct clock behavior, and always improving performance. It's also a good idea to enable the IMPERFECTSCH warning, to ensure all clock enables are properly recognized.</p>
<p>Same as <code>clock_enable</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-clocker">/*verilator clocker*/</dt>
<dd>
</dd>
<dt id="verilator-no_clocker">/*verilator no_clocker*/</dt>
<dd>
<p>Used after a signal declaration to indicate the signal is used as clock or not. This information is used by Verilator to mark the signal as clocker and propagate the clocker attribute automatically to derived signals. See <code>--clk</code> for more information.</p>
<p>Same as <code>clocker</code> and <code>no_clocker</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-coverage_block_off">/*verilator coverage_block_off*/</dt>
<dd>
<p>Specifies the entire begin/end block should be ignored for coverage analysis purposes.</p>
<p>Same as <code>coverage_block_off</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-coverage_off">/*verilator coverage_off*/</dt>
<dd>
<p>Specifies that following lines of code should have coverage disabled. Often used to ignore an entire module for coverage analysis purposes.</p>
</dd>
<dt id="verilator-coverage_on">/*verilator coverage_on*/</dt>
<dd>
<p>Specifies that following lines of code should have coverage re-enabled (if appropriate --coverage flags are passed) after being disabled earlier with /*verilator coverage_off*/.</p>
</dd>
<dt id="verilator-inline_module">/*verilator inline_module*/</dt>
<dd>
<p>Specifies the module the comment appears in may be inlined into any modules that use this module. This is useful to speed up simulation runtime. Note if using "--public" that signals under inlined submodules will be named <i>submodule</i>__DOT__<i>subsignal</i> as C++ does not allow "." in signal names.</p>
<p>Same as <code>inline</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-isolate_assignments">/*verilator isolate_assignments*/</dt>
<dd>
<p>Used after a signal declaration to indicate the assignments to this signal in any blocks should be isolated into new blocks. When there is a large combinatorial block that is resulting in a UNOPTFLAT warning, attaching this to the signal causing a false loop may clear up the problem.</p>
<p>IE, with the following</p>
<pre><code> reg splitme /* verilator isolate_assignments*/;
// Note the placement of the semicolon above
always @* begin
if (....) begin
splitme = ....;
other assignments
end
end</code></pre>
<p>Verilator will internally split the block that assigns to "splitme" into two blocks:</p>
<p>It would then internally break it into (sort of):</p>
<pre><code> // All assignments excluding those to splitme
always @* begin
if (....) begin
other assignments
end
end
// All assignments to splitme
always @* begin
if (....) begin
splitme = ....;
end
end</code></pre>
<p>Same as <code>isolate_assignments</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-lint_off-msg">/*verilator lint_off <i>msg</i>*/</dt>
<dd>
<p>Disable the specified warning message for any warnings following the comment.</p>
</dd>
<dt id="verilator-lint_on-msg">/*verilator lint_on <i>msg</i>*/</dt>
<dd>
<p>Re-enable the specified warning message for any warnings following the comment.</p>
</dd>
<dt id="verilator-lint_restore">/*verilator lint_restore*/</dt>
<dd>
<p>After a /*verilator lint_save*/, pop the stack containing lint message state. Often this is useful at the bottom of include files.</p>
</dd>
<dt id="verilator-lint_save">/*verilator lint_save*/</dt>
<dd>
<p>Push the current state of what lint messages are turned on or turned off to a stack. Later meta-comments may then lint_on or lint_off specific messages, then return to the earlier message state by using /*verilator lint_restore*/. For example:</p>
<pre><code> // verilator lint_save
// verilator lint_off SOME_WARNING
... // code needing SOME_WARNING turned off
// verilator lint_restore</code></pre>
<p>If SOME_WARNING was on before the lint_off, it will now be restored to on, and if it was off before the lint_off it will remain off.</p>
</dd>
<dt id="verilator-no_inline_module">/*verilator no_inline_module*/</dt>
<dd>
<p>Specifies the module the comment appears in should not be inlined into any modules that use this module.</p>
<p>Same as <code>no_inline</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-no_inline_task">/*verilator no_inline_task*/</dt>
<dd>
<p>Used in a function or task variable definition section to specify the function or task should not be inlined into where it is used. This may reduce the size of the final executable when a task is used a very large number of times. For this flag to work, the task and tasks below it must be pure; they cannot reference any variables outside the task itself.</p>
<p>Same as <code>no_inline</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-public-parameter">/*verilator public*/ (parameter)</dt>
<dd>
<p>Used after a parameter declaration to indicate the emitted C code should have the parameter values visible. Due to C++ language restrictions, this may only be used on 64-bit or narrower integral enumerations.</p>
<pre><code> parameter [2:0] PARAM /*verilator public*/ = 2'b0;</code></pre>
</dd>
<dt id="verilator-public-typedef-enum">/*verilator public*/ (typedef enum)</dt>
<dd>
<p>Used after an enum typedef declaration to indicate the emitted C code should have the enum values visible. Due to C++ language restrictions, this may only be used on 64-bit or narrower integral enumerations.</p>
<pre><code> typedef enum logic [2:0] { ZERO = 3'b0 } pub_t /*verilator public*/;</code></pre>
</dd>
<dt id="verilator-public-variable">/*verilator public*/ (variable)</dt>
<dd>
<p>Used after an input, output, register, or wire declaration to indicate the signal should be declared so that C code may read or write the value of the signal. This will also declare this module public, otherwise use /*verilator public_flat*/.</p>
<p>Instead of using public variables, consider instead making a DPI or public function that accesses the variable. This is nicer as it provides an obvious entry point that is also compatible across simulators.</p>
<p>Same as <code>public</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-public-task-function">/*verilator public*/ (task/function)</dt>
<dd>
<p>Used inside the declaration section of a function or task declaration to indicate the function or task should be made into a C++ function, public to outside callers. Public tasks will be declared as a void C++ function, public functions will get the appropriate non-void (bool, uint32_t, etc) return type. Any input arguments will become C++ arguments to the function. Any output arguments will become C++ reference arguments. Any local registers/integers will become function automatic variables on the stack.</p>
<p>Wide variables over 64 bits cannot be function returns, to avoid exposing complexities. However, wide variables can be input/outputs; they will be passed as references to an array of 32-bit numbers.</p>
<p>Generally, only the values of stored state (flops) should be written, as the model will NOT notice changes made to variables in these functions. (Same as when a signal is declared public.)</p>
<p>You may want to use DPI exports instead, as it's compatible with other simulators.</p>
<p>Same as <code>public</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-public_flat-variable">/*verilator public_flat*/ (variable)</dt>
<dd>
<p>Used after an input, output, register, or wire declaration to indicate the signal should be declared so that C code may read or write the value of the signal. This will not declare this module public, which means the name of the signal or path to it may change based upon the module inlining which takes place.</p>
<p>Same as <code>public_flat</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-public_flat_rd-variable">/*verilator public_flat_rd*/ (variable)</dt>
<dd>
<p>Used after an input, output, register, or wire declaration to indicate the signal should be declared public_flat (see above), but read-only.</p>
<p>Same as <code>public_flat_rd</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-public_flat_rw-edge_list-variable">/*verilator public_flat_rw @(<edge_list>) */ (variable)</dt>
<dd>
<p>Used after an input, output, register, or wire declaration to indicate the signal should be declared public_flat_rd (see above), and also writable, where writes should be considered to have the timing specified by the given sensitivity edge list. Set for all variables, ports and wires using the --public-flat-rw switch.</p>
<p>Same as <code>public_flat_rw</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-public_module">/*verilator public_module*/</dt>
<dd>
<p>Used after a module statement to indicate the module should not be inlined (unless specifically requested) so that C code may access the module. Verilator automatically sets this attribute when the module contains any public signals or `systemc_ directives. Also set for all modules when using the --public switch.</p>
<p>Same as <code>public</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-sc_clock">/*verilator sc_clock*/</dt>
<dd>
<p>Deprecated. Used after an input declaration to indicate the signal should be declared in SystemC as a sc_clock instead of a bool. This was needed in SystemC 1.1 and 1.2 only; versions 2.0 and later do not require clock pins to be sc_clocks and this is no longer needed.</p>
</dd>
<dt id="verilator-sc_bv">/*verilator sc_bv*/</dt>
<dd>
<p>Used after a port declaration. It sets the port to be of sc_bv<<i>width</i>> type, instead of bool, vluint32_t or vluint64_t. This may be useful if the port width is parameterized and the instantiating C++ code wants to always have a sc_bv so it can accept any width. In general you should avoid using this attribute when not necessary as with increasing usage of sc_bv the performance decreases significantly.</p>
<p>Same as <code>sc_bv</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-sformat">/*verilator sformat*/</dt>
<dd>
<p>Attached to the final argument of type "input string" of a function or task to indicate the function or task should pass all remaining arguments through $sformatf. This allows creation of DPI functions with $display like behavior. See the test_regress/t/t_dpi_display.v file for an example.</p>
<p>Same as <code>sformat</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-split_var">/*verilator split_var*/</dt>
<dd>
<p>Attached to a variable or a net declaration to break the variable into multiple pieces typically to resolve UNOPTFLAT performance issues. Typically the variables to attach this to are recommended by Verilator itself, see UNOPTFLAT below.</p>
<p>For example, Verilator will internally convert a variable with the metacomment such as:</p>
<pre><code> logic [7:0] x [0:1] /*verilator split_var*/;</code></pre>
<p>To:</p>
<pre><code> logic [7:0] x__BRA__0__KET__ /*verilator split_var*/;
logic [7:0] x__BRA__1__KET__ /*verilator split_var*/;</code></pre>
<p>Note that the generated packed variables retain the split_var metacomment because they may be split into further smaller pieces according to the access patterns.</p>
<p>This only supports unpacked arrays, packed arrays, and packed structs of integer types (reg, logic, bit, byte, int...); otherwise if a split was requested but cannot occur a SPLITVAR warning is issued. Splitting large arrays may slow down the Verilation speed, so use this only on variables that require it.</p>
<p>Same as <code>split_var</code> in configuration files, see <a href="#CONFIGURATION-FILES">"CONFIGURATION FILES"</a> for more information.</p>
</dd>
<dt id="verilator-tag-text">/*verilator tag <text...>*/</dt>
<dd>
<p>Attached after a variable or structure member to indicate opaque (to Verilator) text that should be passed through to the XML output as a tag, for use by downstream applications.</p>
</dd>
<dt id="verilator-tracing_off">/*verilator tracing_off*/</dt>
<dd>
<p>Disable waveform tracing for all future signals that are declared in this module, or cells below this module. Often this is placed just after a primitive's module statement, so that the entire module and cells below it are not traced.</p>
</dd>
<dt id="verilator-tracing_on">/*verilator tracing_on*/</dt>
<dd>
<p>Re-enable waveform tracing for all future signals or cells that are declared.</p>
</dd>
</dl>
<h1 id="LANGUAGE-LIMITATIONS">LANGUAGE LIMITATIONS</h1>
<p>There are some limitations and lack of features relative to the major closed-source simulators, by intent.</p>
<h2 id="Synthesis-Subset">Synthesis Subset</h2>
<p>Verilator supports the Synthesis subset with other verification constructs being added over time. Verilator also simulates events as Synopsys's Design Compiler would; namely given a block of the form:</p>
<pre><code> always @ (x) y = x & z;</code></pre>
<p>This will recompute y when there is even a potential for change in x or a change in z, that is when the flops computing x or z evaluate (which is what Design Compiler will synthesize.) A compliant simulator would only calculate y if x changes. We recommend using always_comb to make the code run the same everywhere. Also avoid putting $displays in combo blocks, as they may print multiple times when not desired, even on compliant simulators as event ordering is not specified.</p>
<h2 id="Signal-Naming">Signal Naming</h2>
<p>To avoid conflicts with C symbol naming, any character in a signal name that is not alphanumeric nor a single underscore will be replaced by __0hh where hh is the hex code of the character. To avoid conflicts with Verilator's internal symbols, any double underscore are replaced with ___05F (5F is the hex code of an underscore.)</p>
<h2 id="Bind">Bind</h2>
<p>Verilator only supports "bind" to a target module name, not an instance path.</p>
<h2 id="Class">Class</h2>
<p>Verilator class support is limited but in active development. Verilator supports members, and methods. Verilator does not support class static members, class extend, or class parameters.</p>
<h2 id="Dotted-cross-hierarchy-references">Dotted cross-hierarchy references</h2>
<p>Verilator supports dotted references to variables, functions and tasks in different modules. The portion before the dot must have a constant value; for example a[2].b is acceptable, while a[x].b is generally not.</p>
<p>References into generated and arrayed instances use the instance names specified in the Verilog standard; arrayed instances are named {cellName}[{instanceNumber}] in Verilog, which becomes {cellname}__BRA__{instanceNumber}__KET__ inside the generated C++ code.</p>
<h2 id="Latches">Latches</h2>
<p>Verilator is optimized for edge sensitive (flop based) designs. It will attempt to do the correct thing for latches, but most performance optimizations will be disabled around the latch.</p>
<h2 id="Structures-and-Unions">Structures and Unions</h2>
<p>Presently Verilator only supports packed structs and packed unions. Rand and randc tags on members are simply ignored. All structures and unions are represented as a single vector, which means that generating one member of a structure from blocking, and another from non-blocking assignments is unsupported.</p>
<h2 id="Time">Time</h2>
<p>All delays (#) are ignored, as they are in synthesis.</p>
<h2 id="Unknown-states">Unknown states</h2>
<p>Verilator is mostly a two state simulator, not a four state simulator. However, it has two features which uncover most initialization bugs (including many that a four state simulator will miss.)</p>
<p>Identity comparisons (=== or !==) are converted to standard ==/!= when neither side is a constant. This may make the expression yield a different result compared to a four state simulator. An === comparison to X will always be false, so that Verilog code which checks for uninitialized logic will not fire.</p>
<p>Assigning X to a variable will actually assign a constant value as determined by the --x-assign switch. This allows runtime randomization, thus if the value is actually used, the random value should cause downstream errors. Integers also get randomized, even though the Verilog 2001 specification says they initialize to zero. Note however that randomization happens at initialization time and hence during a single simulation run, the same constant (but random) value will be used every time the assignment is executed.</p>
<p>All variables, depending on --x-initial setting, are typically randomly initialized using a function. By running several random simulation runs you can determine that reset is working correctly. On the first run, have the function initialize variables to zero. On the second, have it initialize variables to one. On the third and following runs have it initialize them randomly. If the results match, reset works. (Note this is what the hardware will really do.) In practice, just setting all variables to one at startup finds most problems (since typically control signals are active-high).</p>
<p>--x-assign applies to variables explicitly initialized or assigned an X. Uninitialized clocks are initialized to zero, while all other state holding variables are initialized to a random value. Event driven simulators will generally trigger an edge on a transition from X to 1 (<code>posedge</code>) or X to 0 (<code>negedge</code>). However, by default, since clocks are initialized to zero, Verilator will not trigger an initial negedge. Some code (particularly for reset) may rely on X->0 triggering an edge. The --x-initial-edge switch enables this behavior. Comparing runs with and without this switch will find such problems.</p>
<h2 id="Tri-Inout">Tri/Inout</h2>
<p>Verilator converts some simple tristate structures into two state. Pullup, pulldown, bufif0, bufif1, notif0, notif1, pmos, nmos, tri0 and tri1 are also supported. Simple comparisons with === 1'bz are also supported.</p>
<p>An assignment of the form:</p>
<pre><code> inout driver;
wire driver = (enable) ? output_value : 1'bz;</code></pre>
<p>Will be converted to</p>
<pre><code> input driver; // Value being driven in from "external" drivers
output driver__en; // True if driven from this module
output driver__out; // Value being driven from this module</code></pre>
<p>External logic will be needed to combine these signals with any external drivers.</p>
<p>Tristate drivers are not supported inside functions and tasks; an inout there will be considered a two state variable that is read and written instead of a four state variable.</p>
<h2 id="Functions-Tasks">Functions & Tasks</h2>
<p>All functions and tasks will be inlined (will not become functions in C.) The only support provided is for simple statements in tasks (which may affect global variables).</p>
<p>Recursive functions and tasks are not supported. All inputs and outputs are automatic, as if they had the Verilog 2001 "automatic" keyword prepended. (If you don't know what this means, Verilator will do what you probably expect -- what C does. The default behavior of Verilog is different.)</p>
<h2 id="Generated-Clocks">Generated Clocks</h2>
<p>Verilator attempts to deal with generated and gated clocks correctly, however some cases cause problems in the scheduling algorithm which is optimized for performance. The safest option is to have all clocks as primary inputs to the model, or wires directly attached to primary inputs. For proper behavior clock enables may also need the /*verilator clock_enable*/ attribute.</p>
<h2 id="Gate-Primitives">Gate Primitives</h2>
<p>The 2-state gate primitives (and, buf, nand, nor, not, or, xnor, xor) are directly converted to behavioral equivalents. The 3-state and MOS gate primitives are not supported. Tables are not supported.</p>
<h2 id="Specify-blocks">Specify blocks</h2>
<p>All specify blocks and timing checks are ignored. All min:typ:max delays use the typical value.</p>
<h2 id="Array-Initialization">Array Initialization</h2>
<p>When initializing a large array, you need to use non-delayed assignments. Verilator will tell you when this needs to be fixed; see the BLKLOOPINIT error for more information.</p>
<h2 id="Array-Out-of-Bounds">Array Out of Bounds</h2>
<p>Writing a memory element that is outside the bounds specified for the array may cause a different memory element inside the array to be written instead. For power-of-2 sized arrays, Verilator will give a width warning and the address. For non-power-of-2-sizes arrays, index 0 will be written.</p>
<p>Reading a memory element that is outside the bounds specified for the array will give a width warning and wrap around the power-of-2 size. For non-power-of-2 sizes, it will return a unspecified constant of the appropriate width.</p>
<h2 id="Assertions">Assertions</h2>
<p>Verilator is beginning to add support for assertions. Verilator currently only converts assertions to simple "if (...) error" statements, and coverage statements to increment the line counters described in the coverage section.</p>
<p>Verilator does not support SEREs yet. All assertion and coverage statements must be simple expressions that complete in one cycle.</p>
<h2 id="Encrypted-Verilog">Encrypted Verilog</h2>
<p>Open source simulators like Verilator are unable to use encrypted RTL (i.e. IEEE P1735). Talk to your IP vendor about delivering IP blocks via Verilator's --protect-lib feature.</p>
<h2 id="Language-Keyword-Limitations">Language Keyword Limitations</h2>
<p>This section describes specific limitations for each language keyword.</p>
<dl>
<dt id="FILE__-__LINE__-begin_keywords-begin_keywords-begin_keywords-begin_keywords-begin_keywords-define-else-elsif-end_keywords-endif-error-ifdef-ifndef-include-line-systemc_ctor-systemc_dtor-systemc_header-systemc_imp_header-systemc_implementation-systemc_interface-undef-verilog">`__FILE__, `__LINE__, `begin_keywords, `begin_keywords, `begin_keywords, `begin_keywords, `begin_keywords, `define, `else, `elsif, `end_keywords, `endif, `error, `ifdef, `ifndef, `include, `line, `systemc_ctor, `systemc_dtor, `systemc_header, `systemc_imp_header, `systemc_implementation, `systemc_interface, `undef, `verilog</dt>
<dd>
<p>Fully supported.</p>
</dd>
<dt id="always-always_comb-always_ff-always_latch-and-assign-begin-buf-byte-case-casex-casez-default-defparam-do-while-else-end-endcase-endfunction-endgenerate-endmodule-endspecify-endtask-final-for-function-generate-genvar-if-initial-inout-input-int-integer-localparam-logic-longint-macromodule-module-nand-negedge-nor-not-or-output-parameter-posedge-reg-scalared-shortint-signed-supply0-supply1-task-time-tri-typedef-var-vectored-while-wire-xnor-xor">always, always_comb, always_ff, always_latch, and, assign, begin, buf, byte, case, casex, casez, default, defparam, do-while, else, end, endcase, endfunction, endgenerate, endmodule, endspecify, endtask, final, for, function, generate, genvar, if, initial, inout, input, int, integer, localparam, logic, longint, macromodule, module, nand, negedge, nor, not, or, output, parameter, posedge, reg, scalared, shortint, signed, supply0, supply1, task, time, tri, typedef, var, vectored, while, wire, xnor, xor</dt>
<dd>
<p>Generally supported.</p>
</dd>
<dt id="operators">++, -- operators</dt>
<dd>
<p>Increment/decrement can only be used as standalone statements or in certain limited cases.</p>
</dd>
<dt id="operator">'{} operator</dt>
<dd>
<p>Assignment patterns with order based, default, constant integer (array) or member identifier (struct/union) keys are supported. Data type keys and keys which are computed from a constant expression are not supported.</p>
</dd>
<dt id="uselib">`uselib</dt>
<dd>
<p>Uselib, a vendor specific library specification method, is ignored along with anything following it until the end of that line.</p>
</dd>
<dt id="cast-operator">cast operator</dt>
<dd>
<p>Casting is supported only between simple scalar types, signed and unsigned, not arrays nor structs.</p>
</dd>
<dt id="chandle">chandle</dt>
<dd>
<p>Treated as a "longint"; does not yet warn about operations that are specified as illegal on chandles.</p>
</dd>
<dt id="disable">disable</dt>
<dd>
<p>Disable statements may be used only if the block being disabled is a block the disable statement itself is inside. This was commonly used to provide loop break and continue functionality before SystemVerilog added the break and continue keywords.</p>
</dd>
<dt id="inside">inside</dt>
<dd>
<p>Inside expressions may not include unpacked array traversal or $ as an upper bound. Case inside and case matches are also unsupported.</p>
</dd>
<dt id="interface">interface</dt>
<dd>
<p>Interfaces and modports, including with generated data types are supported. Generate blocks around modports are not supported, nor are virtual interfaces nor unnamed interfaces.</p>
</dd>
<dt id="shortreal">shortreal</dt>
<dd>
<p>Short floating point (shortreal) numbers are converted to real. Most other simulators either do not support float, or convert likewise.</p>
</dd>
<dt id="specify-specparam">specify specparam</dt>
<dd>
<p>All specify blocks and timing checks are ignored.</p>
</dd>
<dt id="uwire">uwire</dt>
<dd>
<p>Verilator does not perform warning checking on uwires, it treats the uwire keyword as if it were the normal wire keyword.</p>
</dd>
<dt id="bits-countbits-countones-error-fatal-finish-info-isunknown-onehot-onehot0-readmemb-readmemh-signed-stime-stop-time-unsigned-warning">$bits, $countbits, $countones, $error, $fatal, $finish, $info, $isunknown, $onehot, $onehot0, $readmemb, $readmemh, $signed, $stime, $stop, $time, $unsigned, $warning.</dt>
<dd>
<p>Generally supported.</p>
</dd>
<dt id="dump-dumpports-and-related">$dump/$dumpports and related</dt>
<dd>
<p>$dumpfile or $dumpports will create a VCD or FST file (which is based on the --trace argument given when the model was Verilated). This will take effect starting at the next eval() call. If you have multiple Verilated designs under the same C model, then this will dump signals only from the design containing the $dumpvars.</p>
<p>$dumpvars and $dumpports module identifier is ignored; the traced instances will always start at the top of the design. The levels argument is also ignored, use tracing_on/tracing_off pragmas instead.</p>
<p>$dumpportson/$dumpportsoff/$dumpportsall/$dumpportslimit filename argument is ignored, only a single trace file may be active at once.</p>
<p>$dumpall/$dumpportsall, $dumpon/$dumpportson, $dumpoff/$dumpportsoff, and $dumplimit/$dumpportlimit are currently ignored.</p>
</dd>
<dt id="finish-stop">$finish, $stop</dt>
<dd>
<p>The rarely used optional parameter to $finish and $stop is ignored.</p>
</dd>
<dt id="fopen-fclose-fdisplay-ferror-feof-fflush-fgetc-fgets-fscanf-fwrite-fscanf-sscanf">$fopen, $fclose, $fdisplay, $ferror, $feof, $fflush, $fgetc, $fgets, $fscanf, $fwrite, $fscanf, $sscanf</dt>
<dd>
<p>Generally supported.</p>
</dd>
<dt id="fullskew-hold-nochange-period-recovery-recrem-removal-setup-setuphold-skew-timeskew-width">$fullskew, $hold, $nochange, $period, $recovery, $recrem, $removal, $setup, $setuphold, $skew, $timeskew, $width</dt>
<dd>
<p>All specify blocks and timing checks are ignored.</p>
</dd>
<dt id="monitor-strobe">$monitor, $strobe</dt>
<dd>
<p>Monitor and strobe are not supported, convert to always_comb $display or similar.</p>
</dd>
<dt id="random">$random</dt>
<dd>
<p>$random does not support the optional argument to set the seed. Use the srand function in C to accomplish this, and note there is only one random number generator (not one per module).</p>
</dd>
<dt id="readmemb-readmemh">$readmemb, $readmemh</dt>
<dd>
<p>Read memory commands should work properly. Note Verilator and the Verilog specification does not include support for readmem to multi-dimensional arrays.</p>
</dd>
<dt id="test-plusargs-value-plusargs">$test$plusargs, $value$plusargs</dt>
<dd>
<p>Supported, but the instantiating C++/SystemC testbench must call</p>
<pre><code> Verilated::commandArgs(argc, argv);</code></pre>
<p>to register the command line before calling $test$plusargs or $value$plusargs.</p>
</dd>
</dl>
<h1 id="ERRORS-AND-WARNINGS">ERRORS AND WARNINGS</h1>
<p>Warnings may be disabled in three ways. First, when the warning is printed it will include a warning code. Simply surround the offending line with a lint_off/lint_on pair:</p>
<pre><code> // verilator lint_off UNSIGNED
if (`DEF_THAT_IS_EQ_ZERO <= 3) $stop;
// verilator lint_on UNSIGNED</code></pre>
<p>Second, warnings may be disabled using a configuration file with a lint_off command. This is useful when a script is suppressing warnings and the Verilog source should not be changed.</p>
<p>Warnings may also be globally disabled by invoking Verilator with the <code>-Wno-<i>warning</i></code> switch. This should be avoided, as it removes all checking across the designs, and prevents other users from compiling your code without knowing the magic set of disables needed to successfully compile your design.</p>
<h2 id="Error-and-Warning-Format">Error and Warning Format</h2>
<p>Warnings and errors printed by Verilator always match this regular expression:</p>
<pre><code> %(Error|Warning)(-[A-Z0-9_]+)?: ((\S+):(\d+):((\d+):)? )?.*</code></pre>
<p>Errors and warning start with a percent sign (historical heritage from Digital Equipment Corporation). Some errors or warning have a code attached, with meanings described below. Some errors also have a filename, line number and optional column number (starting at column 1 to match GCC).</p>
<p>Following the error message, Verilator will typically show the user's source code corresponding to the error, prefixed by the line number and a " | ". Following this is typically an arrow and ~ pointing at the error on the source line directly above.</p>
<h2 id="List-of-all-warnings">List of all warnings</h2>
<dl>
<dt id="ALWCOMBORDER">ALWCOMBORDER</dt>
<dd>
<p>Warns that an always_comb block has a variable which is set after it is used. This may cause simulation-synthesis mismatches, as not all simulators allow this ordering.</p>
<pre><code> always_comb begin
a = b;
b = 1;
end</code></pre>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="ASSIGNIN">ASSIGNIN</dt>
<dd>
<p>Error that an assignment is being made to an input signal. This is almost certainly a mistake, though technically legal.</p>
<pre><code> input a;
assign a = 1'b1;</code></pre>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="ASSIGNDLY">ASSIGNDLY</dt>
<dd>
<p>Warns that you have an assignment statement with a delayed time in front of it, for example:</p>
<pre><code> a <= #100 b;
assign #100 a = b;</code></pre>
<p>Ignoring this warning may make Verilator simulations differ from other simulators, however at one point this was a common style so disabled by default as a code style warning.</p>
</dd>
<dt id="BLKANDNBLK">BLKANDNBLK</dt>
<dd>
<p>BLKANDNBLK is an error that a variable comes from a mix of blocking and non-blocking assignments. Generally, this is caused by a register driven by both combo logic and a flop:</p>
<pre><code> always @ (posedge clk) foo[0] <= ...
always @* foo[1] = ...</code></pre>
<p>Simply use a different register for the flop:</p>
<pre><code> always @ (posedge clk) foo_flopped[0] <= ...
always @* foo[0] = foo_flopped[0];
always @* foo[1] = ...</code></pre>
<p>This is not illegal in SystemVerilog, but a violation of good coding practice. Verilator reports this as an error, because ignoring this warning may make Verilator simulations differ from other simulators.</p>
<p>It is generally safe to disable this error (with a "// verilator lint_off BLKANDNBLK" metacomment or the -Wno-BLKANDNBLK option) when one of the assignments is inside a public task, or when the blocking and non-blocking assignments have non-overlapping bits and structure members.</p>
</dd>
<dt id="BLKSEQ">BLKSEQ</dt>
<dd>
<p>This indicates that a blocking assignment (=) is used in a sequential block. Generally non-blocking/delayed assignments (<=) are used in sequential blocks, to avoid the possibility of simulator races. It can be reasonable to do this if the generated signal is used ONLY later in the same block, however this style is generally discouraged as it is error prone.</p>
<pre><code> always @ (posedge clk) foo = ...</code></pre>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="BLKLOOPINIT">BLKLOOPINIT</dt>
<dd>
<p>This indicates that the initialization of an array needs to use non-delayed assignments. This is done in the interest of speed; if delayed assignments were used, the simulator would have to copy large arrays every cycle. (In smaller loops, loop unrolling allows the delayed assignment to work, though it's a bit slower than a non-delayed assignment.) Here's an example</p>
<pre><code> always @ (posedge clk)
if (~reset_l) begin
for (i=0; i<`ARRAY_SIZE; i++) begin
array[i] = 0; // Non-delayed for verilator
end</code></pre>
<p>This message is only seen on large or complicated loops because Verilator generally unrolls small loops. You may want to try increasing --unroll-count (and occasionally --unroll-stmts) which will raise the small loop bar to avoid this error.</p>
</dd>
<dt id="BOUNDED">BOUNDED</dt>
<dd>
<p>This indicates that bounded queues (e.g. "var name[$ : 3]") are unsupported.</p>
<p>Ignoring this warning may make Verilator simulations differ from other simulators.</p>
</dd>
<dt id="BSSPACE">BSSPACE</dt>
<dd>
<p>Warns that a backslash is followed by a space then a newline. Likely the intent was to have a backslash directly followed by a newline (e.g. when making a `define) and there's accidentally white space at the end of the line. If the space is not accidental, suggest removing the backslash in the code as it serves no function.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="CASEINCOMPLETE">CASEINCOMPLETE</dt>
<dd>
<p>Warns that inside a case statement there is a stimulus pattern for which there is no case item specified. This is bad style, if a case is impossible, it's better to have a "default: $stop;" or just "default: ;" so that any design assumption violations will be discovered in simulation.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="CASEOVERLAP">CASEOVERLAP</dt>
<dd>
<p>Warns that inside a case statement you have case values which are detected to be overlapping. This is bad style, as moving the order of case values will cause different behavior. Generally the values can be respecified to not overlap.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="CASEX">CASEX</dt>
<dd>
<p>Warns that it is simply better style to use casez, and <code>?</code> in place of <code>x</code>'s. See <a href="http://www.sunburst-design.com/papers/CummingsSNUG1999Boston_FullParallelCase_rev1_1.pdf">http://www.sunburst-design.com/papers/CummingsSNUG1999Boston_FullParallelCase_rev1_1.pdf</a></p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="CASEWITHX">CASEWITHX</dt>
<dd>
<p>Warns that a case statement contains a constant with a <code>x</code>. Verilator is two-state so interpret such items as always false. Note a common error is to use a <code>X</code> in a case or casez statement item; often what the user instead intended is to use a casez with <code>?</code>.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="CDCRSTLOGIC">CDCRSTLOGIC</dt>
<dd>
<p>With --cdc only, warns that asynchronous flop reset terms come from other than primary inputs or flopped outputs, creating the potential for reset glitches.</p>
</dd>
<dt id="CLKDATA">CLKDATA</dt>
<dd>
<p>Warns that clock signal is mixed used with/as data signal. The checking for this warning is enabled only if user has explicitly marked some signal as clocker using command line option or in-source meta comment (see <code>--clk</code>).</p>
<p>The warning can be disabled without affecting the simulation result. But it is recommended to check the warning as this may degrade the performance of the Verilated model.</p>
</dd>
<dt id="CMPCONST">CMPCONST</dt>
<dd>
<p>Warns that you are comparing a value in a way that will always be constant. For example "X > 1" will always be true when X is a single bit wide.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="COLONPLUS">COLONPLUS</dt>
<dd>
<p>Warns that a :+ is seen. Likely the intent was to use +: to select a range of bits. If the intent was a range that is explicitly positive, suggest adding a space, e.g. use ": +".</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="COMBDLY">COMBDLY</dt>
<dd>
<p>Warns that you have a delayed assignment inside of a combinatorial block. Using delayed assignments in this way is considered bad form, and may lead to the simulator not matching synthesis. If this message is suppressed, Verilator, like synthesis, will convert this to a non-delayed assignment, which may result in logic races or other nasties. See <a href="http://www.sunburst-design.com/papers/CummingsSNUG2000SJ_NBA_rev1_2.pdf">http://www.sunburst-design.com/papers/CummingsSNUG2000SJ_NBA_rev1_2.pdf</a></p>
<p>Ignoring this warning may make Verilator simulations differ from other simulators.</p>
</dd>
<dt id="CONTASSREG">CONTASSREG</dt>
<dd>
<p>Error that a continuous assignment is setting a reg. According to IEEE Verilog, but not SystemVerilog, a wire must be used as the target of continuous assignments.</p>
<p>This error is only reported when "--language 1364-1995", "--language 1364-2001", or "--language 1364-2005" is used.</p>
<p>Ignoring this error will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="DECLFILENAME">DECLFILENAME</dt>
<dd>
<p>Warns that a module or other declaration's name doesn't match the filename with path and extension stripped that it is declared in. The filename a modules/interfaces/programs is declared in should match the name of the module etc. so that -y directory searching will work. This warning is printed for only the first mismatching module in any given file, and -v library files are ignored.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="DEFPARAM">DEFPARAM</dt>
<dd>
<p>Warns that the "defparam" statement was deprecated in Verilog 2001 and all designs should now be using the #(...) format to specify parameters.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="DETECTARRAY">DETECTARRAY</dt>
<dd>
<p>Error when Verilator tries to deal with a combinatorial loop that could not be flattened, and which involves a datatype which Verilator cannot handle, such as an unpacked struct or a large unpacked array. This typically occurs when -Wno-UNOPTFLAT has been used to override an UNOPTFLAT warning (see below).</p>
<p>The solution is to break the loop, as described for UNOPTFLAT.</p>
</dd>
<dt id="DIDNOTCONVERGE">DIDNOTCONVERGE</dt>
<dd>
<p>Error at simulation runtime when model did not properly settle.</p>
<p>Verilator sometimes has to evaluate combinatorial logic multiple times, usually around code where a UNOPTFLAT warning was issued, but disabled. For example:</p>
<pre><code> always_comb b = ~a;
always_comb a = b</code></pre>
<p>This code will toggle forever, and thus to prevent an infinite loop, the executable will give the didn't converge error.</p>
<p>To debug this, first review any UNOPTFLAT warnings that were ignored. Though typically it is safe to ignore UNOPTFLAT (at a performance cost), at the time of issuing a UNOPTFLAT Verilator did not know if the logic would eventually converge and assumed it would.</p>
<p>Next, run Verilator with --prof-cfuncs. Run make on the generated files with "CPP_FLAGS=-DVL_DEBUG", to allow enabling simulation runtime debug messages. Rerun the test. Now just before the convergence error you should see additional output similar to this:</p>
<pre><code> CHANGE: filename.v:1: b
CHANGE: filename.v:2: a</code></pre>
<p>This means that signal b and signal a keep changing, inspect the code that modifies these signals. Note if many signals are getting printed then most likely all of them are oscillating. It may also be that e.g. "a" may be oscillating, then "a" feeds signal "c" which then is also reported as oscillating.</p>
<p>Finally, rare, more difficult cases can be debugged like a "C" program; either enter GDB and use its tracing facilities, or edit the generated C++ code to add appropriate prints to see what is going on.</p>
</dd>
<dt id="ENDLABEL">ENDLABEL</dt>
<dd>
<p>Warns that a label attached to a "end"-something statement does not match the label attached to the block start.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="GENCLK">GENCLK</dt>
<dd>
<p>Deprecated and no longer used as a warning. Used to indicate that the specified signal was is generated inside the model, and also being used as a clock.</p>
</dd>
<dt id="IFDEPTH">IFDEPTH</dt>
<dd>
<p>Warns that if/if else statements have exceeded the depth specified with --if-depth, as they are likely to result in slow priority encoders. Statements below unique and priority if statements are ignored. Solutions include changing the code to a case statement, or a SystemVerilog 'unique if' or 'priority if'.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="IGNOREDRETURN">IGNOREDRETURN</dt>
<dd>
<p>Warns that a non-void function is being called as a task, and hence the return value is being ignored.</p>
<p>This warning is required by IEEE. The portable way to suppress this warning (in SystemVerilog) is to use a void cast, e.g.</p>
<pre><code> void'(function_being_called_as_task());</code></pre>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="IMPERFECTSCH">IMPERFECTSCH</dt>
<dd>
<p>Warns that the scheduling of the model is not absolutely perfect, and some manual code edits may result in faster performance. This warning defaults to off, is not part of -Wall, and must be turned on explicitly before the top module statement is processed.</p>
</dd>
<dt id="IMPLICIT">IMPLICIT</dt>
<dd>
<p>Warns that a wire is being implicitly declared (it is a single bit wide output from a sub-module.) While legal in Verilog, implicit declarations only work for single bit wide signals (not buses), do not allow using a signal before it is implicitly declared by a cell, and can lead to dangling nets. A better option is the /*AUTOWIRE*/ feature of Verilog-Mode for Emacs, available from <a href="https://www.veripool.org/verilog-mode">https://www.veripool.org/verilog-mode</a></p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="IMPORTSTAR">IMPORTSTAR</dt>
<dd>
<p>Warns that an "import <i>package</i>::*" statement is in $unit scope. This causes the imported symbols to pollute the global namespace, defeating much of the purpose of having a package. Generally "import ::*" should only be used inside a lower scope such as a package or module.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="IMPURE">IMPURE</dt>
<dd>
<p>Warns that a task or function that has been marked with /*verilator no_inline_task*/ references variables that are not local to the task. Verilator cannot schedule these variables correctly.</p>
<p>Ignoring this warning may make Verilator simulations differ from other simulators.</p>
</dd>
<dt id="INCABSPATH">INCABSPATH</dt>
<dd>
<p>Warns that an `include filename specifies an absolute path. This means the code will not work on any other system with a different file system layout. Instead of using absolute paths, relative paths (preferably without any directory specified whatsoever) should be used, and +incdir used on the command line to specify the top include source directories.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="INFINITELOOP">INFINITELOOP</dt>
<dd>
<p>Warns that a while or for statement has a condition that is always true. and thus results in an infinite loop if the statement ever executes.</p>
<p>This might be unintended behavior if the loop body contains statements that in other simulators would make time pass, which Verilator is ignoring due to e.g. STMTDLY warnings being disabled.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly (i.e. hang due to the infinite loop).</p>
</dd>
<dt id="INITIALDLY">INITIALDLY</dt>
<dd>
<p>Warns that you have a delayed assignment inside of an initial or final block. If this message is suppressed, Verilator will convert this to a non-delayed assignment. See also the COMBDLY warning.</p>
<p>Ignoring this warning may make Verilator simulations differ from other simulators.</p>
</dd>
<dt id="INSECURE">INSECURE</dt>
<dd>
<p>Warns that the combination of options selected may be defeating the attempt to protect/obscure identifiers or hide information in the model. Correct the options provided, or inspect the output code to see if the information exposed is acceptable.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="LITENDIAN">LITENDIAN</dt>
<dd>
<p>Warns that a packed vector is declared with little endian bit numbering (i.e. [0:7]). Big endian bit numbering is now the overwhelming standard, and little numbering is now thus often due to simple oversight instead of intent.</p>
<p>Also warns that a cell is declared with little endian range (i.e. [0:7] or [7]) and is connected to a N-wide signal. Based on IEEE the bits will likely be backwards from what you expect (i.e. cell [0] will connect to signal bit [N-1] not bit [0]).</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="MODDUP">MODDUP</dt>
<dd>
<p>Warns that a module has multiple definitions. Generally this indicates a coding error, or a mistake in a library file and it's good practice to have one module per file (and only put each file once on the command line) to avoid these issues. For some gate level netlists duplicates are sometimes unavoidable, and MODDUP should be disabled.</p>
<p>Ignoring this warning will cause the more recent module definition to be discarded.</p>
</dd>
<dt id="MULTIDRIVEN">MULTIDRIVEN</dt>
<dd>
<p>Warns that the specified signal comes from multiple always blocks. This is often unsupported by synthesis tools, and is considered bad style. It will also cause longer simulation runtimes due to reduced optimizations.</p>
<p>Ignoring this warning will only slow simulations, it will simulate correctly.</p>
</dd>
<dt id="MULTITOP">MULTITOP</dt>
<dd>
<p>Warns that there are multiple top level modules, that is modules not instantiated by any other module, and both modules were put on the command line (not in a library). Three likely cases:</p>
<p>1. A single module is intended to be the top. This warning then occurs because some low level cell is being read in, but is not really needed as part of the design. The best solution for this situation is to ensure that only the top module is put on the command line without any flags, and all remaining library files are read in as libraries with -v, or are automatically resolved by having filenames that match the module names.</p>
<p>2. A single module is intended to be the top, the name of it is known, and all other modules should be ignored if not part of the design. The best solution is to use the --top-module option to specify the top module's name. All other modules that are not part of the design will be for the most part ignored (they must be clean in syntax and their contents will be removed as part of the Verilog module elaboration process.)</p>
<p>3. Multiple modules are intended to be design tops, e.g. when linting a library file. As multiple modules are desired, disable the MULTITOP warning. All input/outputs will go uniquely to each module, with any conflicting and identical signal names being made unique by adding a prefix based on the top module name followed by __02E (a Verilator-encoded ASCII ".'). This renaming is done even if the two modules' signals seem identical, e.g. multiple modules with a "clk" input.</p>
</dd>
<dt id="PINCONNECTEMPTY">PINCONNECTEMPTY</dt>
<dd>
<p>Warns that a cell instantiation has a pin which is connected to .pin_name(), e.g. not another signal, but with an explicit mention of the pin. It may be desirable to disable PINCONNECTEMPTY, as this indicates intention to have a no-connect.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="PINMISSING">PINMISSING</dt>
<dd>
<p>Warns that a module has a pin which is not mentioned in a cell instantiation. If a pin is not missing it should still be specified on the cell declaration with a empty connection, using "(.pin_name())".</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="PINNOCONNECT">PINNOCONNECT</dt>
<dd>
<p>Warns that a cell instantiation has a pin which is not connected to another signal.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="PROCASSWIRE">PROCASSWIRE</dt>
<dd>
<p>Error that a procedural assignment is setting a wire. According to IEEE, a var/reg must be used as the target of procedural assignments.</p>
</dd>
<dt id="REALCVT">REALCVT</dt>
<dd>
<p>Warns that a real number is being implicitly rounded to an integer, with possible loss of precision.</p>
</dd>
<dt id="REDEFMACRO">REDEFMACRO</dt>
<dd>
<p>Warns that you have redefined the same macro with a different value, for example:</p>
<pre><code> `define MACRO def1
//...
`define MACRO otherdef</code></pre>
<p>The best solution is to use a different name for the second macro. If this is not possible, add a undef to indicate the code is overriding the value:</p>
<pre><code> `define MACRO def1
//...
`undef MACRO
`define MACRO otherdef</code></pre>
</dd>
<dt id="SELRANGE">SELRANGE</dt>
<dd>
<p>Warns that a selection index will go out of bounds:</p>
<pre><code> wire vec[6:0];
initial out = vec[7]; // There is no 7</code></pre>
<p>Verilator will assume zero for this value, instead of X. Note that in some cases this warning may be false, when a condition upstream or downstream of the access means the access out of bounds will never execute or be used.</p>
<pre><code> wire vec[6:0];
initial begin
seven = 7;
...
if (seven != 7) out = vec[seven]; // Never will use vec[7]</code></pre>
</dd>
<dt id="SHORTREAL">SHORTREAL</dt>
<dd>
<p>Warns that Verilator does not support "shortreal" and they will be automatically promoted to "real". The recommendation is to replace any "shortreal" in the code with "real", as "shortreal" is not widely supported across industry tools.</p>
<p>Ignoring this warning may make Verilator simulations differ from other simulators, if the increased precision of real affects your model or DPI calls.</p>
</dd>
<dt id="SPLITVAR">SPLITVAR</dt>
<dd>
<p>Warns that a variable with a <code>split_var</code> metacomment was not split. Some possible reasons for this are:</p>
<p>* The datatype of the variable is not supported for splitting. (e.g. is a real).</p>
<p>* The access pattern of the variable can not be determined statically. (e.g. is accessed as a memory).</p>
<p>* The index of the array exceeds the array size.</p>
<p>* The variable is accessed from outside using dotted reference. (e.g. top.instance0.variable0 = 1).</p>
<p>* The variable is not declared in a module, but in a package or an interface.</p>
<p>* The variable is a parameter, localparam, genvar, or queue.</p>
<p>* The variable is tristate or bidirectional. (e.g. inout or ref).</p>
</dd>
<dt id="STMTDLY">STMTDLY</dt>
<dd>
<p>Warns that you have a statement with a delayed time in front of it, for example:</p>
<pre><code> #100 $finish;</code></pre>
<p>Ignoring this warning may make Verilator simulations differ from other simulators.</p>
</dd>
<dt id="SYMRSVDWORD">SYMRSVDWORD</dt>
<dd>
<p>Warning that a symbol matches a C++ reserved word and using this as a symbol name would result in odd C++ compiler errors. You may disable this warning, but the symbol will be renamed by Verilator to avoid the conflict.</p>
</dd>
<dt id="SYNCASYNCNET">SYNCASYNCNET</dt>
<dd>
<p>Warns that the specified net is used in at least two different always statements with posedge/negedges (i.e. a flop). One usage has the signal in the sensitivity list and body, probably as an async reset, and the other usage has the signal only in the body, probably as a sync reset. Mixing sync and async resets is usually a mistake. The warning may be disabled with a lint_off pragma around the net, or either flopped block.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="TASKNSVAR">TASKNSVAR</dt>
<dd>
<p>Error when a call to a task or function has a output from that task tied to a non-simple signal. Instead connect the task output to a temporary signal of the appropriate width, and use that signal to set the appropriate expression as the next statement. For example:</p>
<pre><code> task foo; output sig; ... endtask
always @* begin
foo(bus_we_select_from[2]); // Will get TASKNSVAR error
end</code></pre>
<p>Change this to:</p>
<pre><code> reg foo_temp_out;
always @* begin
foo(foo_temp_out);
bus_we_select_from[2] = foo_temp_out;
end</code></pre>
<p>Verilator doesn't do this conversion for you, as some more complicated cases would result in simulator mismatches.</p>
</dd>
<dt id="TICKCOUNT">TICKCOUNT</dt>
<dd>
<p>Warns that the number of ticks to delay a $past variable is greater than 10. At present Verilator effectively creates a flop for each delayed signals, and as such any large counts may lead to large design size increases.</p>
<p>Ignoring this warning will only slow simulations, it will simulate correctly.</p>
</dd>
<dt id="TIMESCALEMOD">TIMESCALEMOD</dt>
<dd>
<p>Error that `timescale is used in some but not all modules. Recommend using --timescale argument, or in front of all modules use:</p>
<pre><code> `include "timescale.vh"</code></pre>
<p>Then in that file set the timescale.</p>
<p>This is an error due to IEEE specifications, but it may be disabled similar to warnings. Ignoring this error may result in a module having an unexpected timescale.</p>
</dd>
<dt id="UNDRIVEN">UNDRIVEN</dt>
<dd>
<p>Warns that the specified signal has no source. Verilator is fairly liberal in the usage calculations; making a signal public, or setting only a single array element marks the entire signal as driven.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="UNOPT">UNOPT</dt>
<dd>
<p>Warns that due to some construct, optimization of the specified signal or block is disabled. The construct should be cleaned up to improve simulation performance.</p>
<p>A less obvious case of this is when a module instantiates two submodules. Inside submodule A, signal I is input and signal O is output. Likewise in submodule B, signal O is an input and I is an output. A loop exists and a UNOPT warning will result if AI & AO both come from and go to combinatorial blocks in both submodules, even if they are unrelated always blocks. This affects performance because Verilator would have to evaluate each submodule multiple times to stabilize the signals crossing between the modules.</p>
<p>Ignoring this warning will only slow simulations, it will simulate correctly.</p>
</dd>
<dt id="UNOPTFLAT">UNOPTFLAT</dt>
<dd>
<p>Warns that due to some construct, optimization of the specified signal is disabled. The signal reported includes a complete scope to the signal; it may be only one particular usage of a multiply instantiated block. The construct should be cleaned up to improve simulation performance; two times better performance may be possible by fixing these warnings.</p>
<p>Unlike the UNOPT warning, this occurs after flattening the netlist, and indicates a more basic problem, as the less obvious case described under UNOPT does not apply.</p>
<p>Often UNOPTFLAT is caused by logic that isn't truly circular as viewed by synthesis which analyzes interconnection per-bit, but is circular to simulation which analyzes per-bus:</p>
<pre><code> wire [2:0] x = {x[1:0], shift_in};</code></pre>
<p>This statement needs to be evaluated multiple times, as a change in "shift_in" requires "x" to be computed 3 times before it becomes stable. This is because a change in "x" requires "x" itself to change value, which causes the warning.</p>
<p>For significantly better performance, split this into 2 separate signals:</p>
<pre><code> wire [2:0] xout = {x[1:0], shift_in};</code></pre>
<p>and change all receiving logic to instead receive "xout". Alternatively, change it to</p>
<pre><code> wire [2:0] x = {xin[1:0], shift_in};</code></pre>
<p>and change all driving logic to instead drive "xin".</p>
<p>With this change this assignment needs to be evaluated only once. These sort of changes may also speed up your traditional event driven simulator, as it will result in fewer events per cycle.</p>
<p>The most complicated UNOPTFLAT path we've seen was due to low bits of a bus being generated from an always statement that consumed high bits of the same bus processed by another series of always blocks. The fix is the same; split it into two separate signals generated from each block.</p>
<p>Another way to resolve this warning is to add a <code>split_var</code> metacomment described above. This will cause the variable to be split internally, potentially resolving the conflict. If you run with --report-unoptflat Verilator will suggest possible candidates for <code>split_var</code>.</p>
<p>The UNOPTFLAT warning may also be due to clock enables, identified from the reported path going through a clock gating cell. To fix these, use the clock_enable meta comment described above.</p>
<p>The UNOPTFLAT warning may also occur where outputs from a block of logic are independent, but occur in the same always block. To fix this, use the isolate_assignments meta comment described above.</p>
<p>To assist in resolving UNOPTFLAT, the option <code>--report-unoptflat</code> can be used, which will provide suggestions for variables that can be split up, and a graph of all the nodes connected in the loop. See the <a>Arguments</a> section for more details.</p>
<p>Ignoring this warning will only slow simulations, it will simulate correctly.</p>
</dd>
<dt id="UNOPTTHREADS">UNOPTTHREADS</dt>
<dd>
<p>Warns that the thread scheduler was unable to partition the design to fill the requested number of threads.</p>
<p>One workaround is to request fewer threads with <code>--threads</code>.</p>
<p>Another possible workaround is to allow more MTasks in the simulation runtime, by increasing the value of --threads-max-mtasks. More MTasks will result in more communication and synchronization overhead at simulation runtime; the scheduler attempts to minimize the number of MTasks for this reason.</p>
<p>Ignoring this warning will only slow simulations, it will simulate correctly.</p>
</dd>
<dt id="UNPACKED">UNPACKED</dt>
<dd>
<p>Warns that unpacked structs and unions are not supported.</p>
<p>Ignoring this warning will make Verilator treat the structure as packed, which may make Verilator simulations differ from other simulators. This downgrading may also result what would normally be a legal unpacked struct/array inside an unpacked struct/array becoming an illegal unpacked struct/array inside a packed struct/array.</p>
</dd>
<dt id="UNSIGNED">UNSIGNED</dt>
<dd>
<p>Warns that you are comparing a unsigned value in a way that implies it is signed, for example "X < 0" will always be false when X is unsigned.</p>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="UNSUPPORTED">UNSUPPORTED</dt>
<dd>
<p>UNSUPPORTED is an error that the construct might be legal according to IEEE but is not currently supported.</p>
<p>This error may be ignored with --bbox-unsup, however this will make the design simulate incorrectly; see the details under --bbox-unsup.</p>
</dd>
<dt id="UNUSED">UNUSED</dt>
<dd>
<p>Warns that the specified signal is never used/consumed. Verilator is fairly liberal in the usage calculations; making a signal public, a signal matching --unused-regexp ("*unused*") or accessing only a single array element marks the entire signal as used.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
<p>A recommended style for unused nets is to put at the bottom of a file code similar to the following:</p>
<pre><code> wire _unused_ok = &{1'b0,
sig_not_used_a,
sig_not_used_yet_b, // To be fixed
1'b0};</code></pre>
<p>The reduction AND and constant zeros mean the net will always be zero, so won't use simulation runtime. The redundant leading and trailing zeros avoid syntax errors if there are no signals between them. The magic name "unused" (-unused-regexp) is recognized by Verilator and suppresses warnings; if using other lint tools, either teach it to the tool to ignore signals with "unused" in the name, or put the appropriate lint_off around the wire. Having unused signals in one place makes it easy to find what is unused, and reduces the number of lint_off pragmas, reducing bugs.</p>
</dd>
<dt id="USERINFO-USERWARN-USERERROR-USERFATAL">USERINFO, USERWARN, USERERROR, USERFATAL</dt>
<dd>
<p>A SystemVerilog elaboration-time assertion print was executed.</p>
</dd>
<dt id="VARHIDDEN">VARHIDDEN</dt>
<dd>
<p>Warns that a task, function, or begin/end block is declaring a variable by the same name as a variable in the upper level module or begin/end block (thus hiding the upper variable from being able to be used.) Rename the variable to avoid confusion when reading the code.</p>
<p>Disabled by default as this is a code style warning; it will simulate correctly.</p>
</dd>
<dt id="WIDTH">WIDTH</dt>
<dd>
<p>Warns that based on width rules of Verilog, two operands have different widths. Verilator generally can intuit the common usages of widths, and you shouldn't need to disable this message like you do with most lint programs. Generally other than simple mistakes, you have two solutions:</p>
<p>If it's a constant 0 that's 32 bits or less, simply leave it unwidthed. Verilator considers zero to be any width needed.</p>
<p>Concatenate leading zeros when doing arithmetic. In the statement</p>
<pre><code> wire [5:0] plus_one = from[5:0] + 6'd1 + carry[0];</code></pre>
<p>The best fix, which clarifies intent and will also make all tools happy is:</p>
<pre><code> wire [5:0] plus_one = from[5:0] + 6'd1 + {5'd0, carry[0]};</code></pre>
<p>Ignoring this warning will only suppress the lint check, it will simulate correctly.</p>
</dd>
<dt id="WIDTHCONCAT">WIDTHCONCAT</dt>
<dd>
<p>Warns that based on width rules of Verilog, a concatenate or replication has an indeterminate width. In most cases this violates the Verilog rule that widths inside concatenates and replicates must be sized, and should be fixed in the code.</p>
<pre><code> wire [63:0] concat = {1, 2};</code></pre>
<p>An example where this is technically legal (though still bad form) is:</p>
<pre><code> parameter PAR = 1;
wire [63:0] concat = {PAR, PAR};</code></pre>
<p>The correct fix is to either size the 1 ("32'h1"), or add the width to the parameter definition ("parameter [31:0]"), or add the width to the parameter usage ("{PAR[31:0],PAR[31:0]}".</p>
</dd>
</dl>
<p>The following describes the less obvious errors:</p>
<dl>
<dt id="Internal-Error">Internal Error</dt>
<dd>
<p>This error should never occur first, though may occur if earlier warnings or error messages have corrupted the program. If there are no other warnings or errors, submit a bug report.</p>
</dd>
<dt id="Unsupported">Unsupported: ....</dt>
<dd>
<p>This error indicates that you are using a Verilog language construct that is not yet supported in Verilator. See the Limitations chapter.</p>
</dd>
</dl>
<h1 id="DEPRECATIONS">DEPRECATIONS</h1>
<p>The following deprecated items are scheduled for future removal:</p>
<dl>
<dt id="Pre-C-11-compiler-support">Pre-C++11 compiler support</dt>
<dd>
<p>Verilator supports pre-C++11 compilers for non-threaded models when configured with --enable-prec11/--enable-prec11-final. This flag will be removed and C++11 compilers will be required for both compiling Verilator and compiling Verilated models no sooner than September 2020.</p>
</dd>
<dt id="SystemC-2.2-and-earlier-support">SystemC 2.2 and earlier support</dt>
<dd>
<p>Support for SystemC versions 2.2 and earlier including the related sc_clock variable attribute will be removed no sooner than September 2020. The supported versions will be SystemC 2.3.0 (SYSTEMC_VERSION 20111121) and later (presently 2.3.0, 2.3.1, 2.3.2, 2.3.3).</p>
</dd>
<dt id="Configuration-File--msg">Configuration File -msg</dt>
<dd>
<p>The -msg argument to lint_off has been replaced with -rule. -msg is planned for removal no sooner than January 2021.</p>
</dd>
<dt id="XML-locations">XML locations</dt>
<dd>
<p>The XML <code>fl</code> attribute has been replaced with <code>loc</code>. <code>fl</code> is planned for removal no sooner than January 2021.</p>
</dd>
</dl>
<h1 id="FAQ-FREQUENTLY-ASKED-QUESTIONS">FAQ/FREQUENTLY ASKED QUESTIONS</h1>
<dl>
<dt id="Can-I-contribute">Can I contribute?</dt>
<dd>
<p>Please contribute! Just submit a pull request, or raise an issue to discuss if looking for something to help on. For more information see our contributor agreement.</p>
</dd>
<dt id="How-widely-is-Verilator-used">How widely is Verilator used?</dt>
<dd>
<p>Verilator is used by many of the largest silicon design companies, and all the way down to college projects. Verilator is one of the "big 4" simulators, meaning one of the 4 main SystemVerilog simulators available, namely the commercial products Synopsys VCS (tm), Mentor Questa/ModelSim (tm), Cadence Xcelium/Incisive/NC-Verilog/NC-Sim (tm), and the open-source Verilator. The three commercial offerings are often collectively called the "big 3" simulators.</p>
</dd>
<dt id="Does-Verilator-run-under-Windows">Does Verilator run under Windows?</dt>
<dd>
<p>Yes, using Cygwin. Verilated output also compiles under Microsoft Visual C++, but this is not tested every release.</p>
</dd>
<dt id="Can-you-provide-binaries">Can you provide binaries?</dt>
<dd>
<p>You can install Verilator via the system package manager (apt, yum, etc.) on many Linux distributions, including Debian, Ubuntu, SuSE, Fedora, and others. These packages are provided by the Linux distributions and generally will lag the version of the mainline Verilator repository. If no binary package is available for your distribution, how about you set one up? Please contact the authors for assistance.</p>
</dd>
<dt id="How-can-it-be-faster-than-name-a-big-3-closed-source-simulator">How can it be faster than (name-a-big-3-closed-source-simulator)?</dt>
<dd>
<p>Generally, the implied part of the question is "... with all of the manpower they can put into developing it."</p>
<p>Most simulators have to be compliant with the complete IEEE 1364 (Verilog) and IEEE 1800 (SystemVerilog) standards, meaning they have to be event driven. This prevents them from being able to reorder blocks and make netlist-style optimizations, which are where most of the gains come from.</p>
<p>You should not be scared by non-compliance. Your synthesis tool isn't compliant with the whole standard to start with, so your simulator need not be either. Verilator is closer to the synthesis interpretation, so this is a good thing for getting working silicon.</p>
</dd>
<dt id="Will-Verilator-output-remain-under-my-own-license">Will Verilator output remain under my own license?</dt>
<dd>
<p>Yes, it's just like using GCC on your programs; this is why Verilator uses the "GNU *Lesser* Public License Version 3" instead of the more typical "GNU Public License". See the licenses for details, but in brief, if you change Verilator itself or the header files Verilator includes, you must make the source code available under the GNU Lesser Public License. However, Verilator output (the Verilated code) only "include"s the licensed files, and so you are NOT required to release any output from Verilator.</p>
<p>You also have the option of using the Perl Artistic License, which again does not require you to release your Verilog or generated code, and also allows you to modify Verilator for internal use without distributing the modified version. But please contribute back to the community!</p>
<p>One limit is that you cannot under either license release a commercial Verilog simulation product incorporating Verilator without making the source code available.</p>
<p>As is standard with Open Source, contributions back to Verilator will be placed under the Verilator copyright and LGPL/Artistic license. Small test cases will be released into the public domain so they can be used anywhere, and large tests under the LGPL/Artistic, unless requested otherwise.</p>
</dd>
<dt id="Why-is-running-Verilator-to-create-a-model-so-slow">Why is running Verilator (to create a model) so slow?</dt>
<dd>
<p>Verilator needs more memory than the resulting simulator will require, as Verilator internally creates all of the state of the resulting generated simulator in order to optimize it. If it takes more than a few minutes or so (and you're not using --debug since debug mode is disk bound), see if your machine is paging; most likely you need to run it on a machine with more memory. Very large designs are known to have topped 16GB resident set size.</p>
</dd>
<dt id="How-do-I-generate-waveforms-traces-in-C">How do I generate waveforms (traces) in C++?</dt>
<dd>
<p>See the next question for tracing in SystemC mode.</p>
<p>A. Add the --trace switch to Verilator, and in your top level C code, call Verilated::traceEverOn(true). Then you may use $dumpfile and $dumpvars to enable traces, same as with any Verilog simulator. See <code>examples/make_tracing_c</code>.</p>
<p>B. Or, for finer-grained control, or C++ files with multiple Verilated modules you may also create the trace purely from C++. Create a VerilatedVcdC object, and in your main loop call "trace_object->dump(time)" every time step, and finally call "trace_object->close()". You also need to compile verilated_vcd_c.cpp and add it to your link, preferably by adding the dependencies in $(VK_GLOBAL_OBJS) to your Makefile's link rule. This is done for you if using the Verilator --exe flag. Note you can also call ->trace on multiple Verilated objects with the same trace file if you want all data to land in the same output file.</p>
<pre><code> #include "verilated_vcd_c.h"
...
int main(int argc, char** argv, char** env) {
...
Verilated::traceEverOn(true);
VerilatedVcdC* tfp = new VerilatedVcdC;
topp->trace(tfp, 99); // Trace 99 levels of hierarchy
tfp->open("obj_dir/t_trace_ena_cc/simx.vcd");
...
while (sc_time_stamp() < sim_time && !Verilated::gotFinish()) {
main_time += #;
tfp->dump(main_time);
}
tfp->close();
}</code></pre>
</dd>
<dt id="How-do-I-generate-waveforms-traces-in-SystemC">How do I generate waveforms (traces) in SystemC?</dt>
<dd>
<p>A. Add the --trace switch to Verilator, and in your top level sc_main, call Verilated::traceEverOn(true). Then you may use $dumpfile and $dumpvars to enable traces, same as with any Verilog simulator, see the non-SystemC example in <code>examples/make_tracing_c</code>. This will trace only the module containing the $dumpvar.</p>
<p>B. Or, you may create a trace purely from SystemC, which may trace all Verilated designs in the SystemC model. Create a VerilatedVcdSc object as you would create a normal SystemC trace file. For an example, see the call to VerilatedVcdSc in the examples/make_tracing_sc/sc_main.cpp file of the distribution, and below.</p>
<p>Alternatively you may use the C++ trace mechanism described in the previous question, note the timescale and timeprecision will be inherited from your SystemC settings.</p>
<p>You also need to compile verilated_vcd_sc.cpp and verilated_vcd_c.cpp and add them to your link, preferably by adding the dependencies in $(VK_GLOBAL_OBJS) to your Makefile's link rule. This is done for you if using the Verilator --exe flag.</p>
<p>Note you can also call ->trace on multiple Verilated objects with the same trace file if you want all data to land in the same output file.</p>
<p>When using SystemC 2.3, the SystemC library must have been built with the experimental simulation phase callback based tracing disabled. This is disabled by default when building SystemC with its configure based build system, but when building SystemC with CMake, you must pass -DENABLE_PHASE_CALLBACKS_TRACING=OFF to disable this feature.</p>
<pre><code> #include "verilated_vcd_sc.h"
...
int main(int argc, char** argv, char** env) {
...
Verilated::traceEverOn(true);
VerilatedVcdSc* tfp = new VerilatedVcdSc;
topp->trace(tfp, 99); // Trace 99 levels of hierarchy
tfp->open("obj_dir/t_trace_ena_cc/simx.vcd");
...
sc_start(1);
...
tfp->close();
}</code></pre>
</dd>
<dt id="How-do-I-generate-FST-waveforms-traces-in-C">How do I generate FST waveforms (traces) in C++?</dt>
<dd>
<p>FST is a trace file format developed by GTKWave. Verilator provides basic FST support. To dump traces in FST format, add the --trace-fst switch to Verilator and either A. use $dumpfile/$dumpvars in Verilog as described in the VCD example above, or B. in C++ change the include described in the VCD example above:</p>
<pre><code> #include "verilated_fst_c.h"
VerilatedFstC* tfp = new VerilatedFstC;</code></pre>
<p>Note that currently supporting both FST and VCD in a single simulation is impossible, but such requirement should be rare. You can however ifdef around the trace format in your C++ main loop, and select VCD or FST at build time, should you require.</p>
</dd>
<dt id="How-do-I-generate-FST-waveforms-aka-dumps-or-traces-in-SystemC">How do I generate FST waveforms (aka dumps or traces) in SystemC?</dt>
<dd>
<p>The FST library from GTKWave does not currently support SystemC; use VCD format instead.</p>
</dd>
<dt id="How-do-I-view-waveforms-aka-dumps-or-traces">How do I view waveforms (aka dumps or traces)?</dt>
<dd>
<p>Verilator creates standard VCD (Value Change Dump) and FST files. VCD files are viewable with the open source GTKWave (recommended) or Dinotrace (legacy) programs, or any of the many closed-source offerings; FST is supported only by GTKWave.</p>
</dd>
<dt id="How-do-I-reduce-the-size-of-large-waveform-trace-files">How do I reduce the size of large waveform (trace) files?</dt>
<dd>
<p>First, instead of calling VerilatedVcdC->open at the beginning of time, delay calling it until the time stamp where you want tracing to begin. Likewise you can also call VerilatedVcdC->open before the end of time (perhaps a short period after you detect a verification error).</p>
<p>Next, add /*verilator tracing_off*/ to any very low level modules you never want to trace (such as perhaps library cells). Finally, use the --trace-depth option to limit the depth of tracing, for example --trace-depth 1 to see only the top level signals.</p>
<p>Also be sure you write your trace files to a local solid-state drive, instead of to a network drive. Network drives are generally far slower.</p>
<p>You can also consider using FST tracing instead of VCD. FST dumps are a fraction of the size of the equivalent VCD. FST tracing can be slower than VCD tracing, but it might be the only option if the VCD file size is prohibitively large.</p>
</dd>
<dt id="How-do-I-do-coverage-analysis">How do I do coverage analysis?</dt>
<dd>
<p>Verilator supports both block (line) coverage and user inserted functional coverage.</p>
<p>First, run verilator with the --coverage option. If you are using your own makefile, compile the model with the GCC flag -DVM_COVERAGE (if using the makefile provided by Verilator, it will do this for you).</p>
<p>At the end of your test, call VerilatedCov::write passing the name of the coverage data file (typically "logs/coverage.dat").</p>
<p>Run each of your tests in different directories. Each test will create a logs/coverage.dat file.</p>
<p>After running all of your tests, execute the verilator_coverage tool. The verilator_coverage tool reads the logs/coverage.dat file(s), and creates an annotated source code listing showing code coverage details.</p>
<p>For an example, after running 'make test' in the Verilator distribution, see the examples/make_tracing_c/logs directory. Grep for lines starting with '%' to see what lines Verilator believes need more coverage.</p>
<p>Info files can be written by verilator_coverage for import to <code>lcov</code>. This enables use of <code>genhtml</code> for HTML reports and importing reports to sites such as <a href="https://codecov.io">https://codecov.io</a>.</p>
</dd>
<dt id="Where-is-the-translate_off-command-How-do-I-ignore-a-construct">Where is the translate_off command? (How do I ignore a construct?)</dt>
<dd>
<p>Translate on/off pragmas are generally a bad idea, as it's easy to have mismatched pairs, and you can't see what another tool sees by just preprocessing the code. Instead, use the preprocessor; Verilator defines the "VERILATOR" define for you, so just wrap the code in an ifndef region:</p>
<pre><code> `ifndef VERILATOR
Something_Verilator_Dislikes;
`endif</code></pre>
<p>Most synthesis tools similarly define SYNTHESIS for you.</p>
</dd>
<dt id="Why-do-I-get-unexpected-do-or-unexpected-bit-errors">Why do I get "unexpected <code>do</code>" or "unexpected <code>bit</code>" errors?</dt>
<dd>
<p>The words <code>do</code>, <code>bit</code>, <code>ref</code>, <code>return</code>, and others are reserved keywords in SystemVerilog. Older Verilog code might use these as identifiers. You should change your code to not use them to ensure it works with newer tools. Alternatively, surround them by the Verilog 2005/SystemVerilog begin_keywords pragma to indicate Verilog 2001 code.</p>
<pre><code> `begin_keywords "1364-2001"
integer bit; initial bit = 1;
`end_keywords</code></pre>
<p>If you want the whole design to be parsed as Verilog 2001, please see the <code>--default-language</code> option.</p>
</dd>
<dt id="How-do-I-prevent-my-assertions-from-firing-during-reset">How do I prevent my assertions from firing during reset?</dt>
<dd>
<p>Call Verilated::assertOn(false) before you first call the model, then turn it back on after reset. It defaults to true. When false, all assertions controlled by --assert are disabled.</p>
</dd>
<dt id="Why-do-I-get-undefined-reference-to-sc_time_stamp">Why do I get "undefined reference to `sc_time_stamp()'"?</dt>
<dd>
<p>In C++ (non SystemC) code you need to define this function so that the simulator knows the current time. See the "CONNECTING TO C++" examples.</p>
</dd>
<dt id="Why-do-I-get-undefined-reference-to-VL_RAND_RESET_I-or-Verilated">Why do I get "undefined reference to `VL_RAND_RESET_I' or `Verilated::...'"?</dt>
<dd>
<p>You need to link your compiled Verilated code against the verilated.cpp file found in the include directory of the Verilator kit. This is one target in the $(VK_GLOBAL_OBJS) make variable, which should be part of your Makefile's link rule. If you use --exe, this is done for you.</p>
</dd>
<dt id="Is-the-PLI-supported">Is the PLI supported?</dt>
<dd>
<p>Only somewhat. More specifically, the common PLI-ish calls $display, $finish, $stop, $time, $write are converted to C++ equivalents. You can also use the "import DPI" SystemVerilog feature to call C code (see the chapter above). There is also limited VPI access to public signals.</p>
<p>If you want something more complex, since Verilator emits standard C++ code, you can simply write your own C++ routines that can access and modify signal values without needing any PLI interface code, and call it with $c("{any_c++_statement}").</p>
</dd>
<dt id="How-do-I-make-a-Verilog-module-that-contain-a-C-object">How do I make a Verilog module that contain a C++ object?</dt>
<dd>
<p>You need to add the object to the structure that Verilator creates, then use $c to call a method inside your object. The test_regress/t/t_extend_class files show an example of how to do this.</p>
</dd>
<dt id="How-do-I-get-faster-build-times">How do I get faster build times?</dt>
<dd>
<p>When running make pass the make variable VM_PARALLEL_BUILDS=1 so that builds occur in parallel. Note this is now set by default if an output file was large enough to be split due to the --output-split option.</p>
<p>Verilator emits any infrequently executed "cold" routines into separate __Slow.cpp files. This can accelerate compilation as optimization can be disabled on these routines. See the OPT_FAST and OPT_SLOW make variables and the BENCHMARKING & OPTIMIZATION section of the manual.</p>
<p>Use a recent compiler. Newer compilers tend to be faster.</p>
<p>Compile in parallel on many machines and use caching; see the web for the ccache, distcc and icecream packages. ccache will skip GCC runs between identical source builds, even across different users. If ccache was installed when Verilator was built it is used, or see OBJCACHE environment variable to override this. Also see the --output-split option.</p>
<p>To reduce the compile time of classes that use a Verilated module (e.g. a top CPP file) you may wish to add /*verilator no_inline_module*/ to your top level module. This will decrease the amount of code in the model's Verilated class, improving compile times of any instantiating top level C++ code, at a relatively small cost of execution performance.</p>
</dd>
<dt id="Why-do-so-many-files-need-to-recompile-when-I-add-a-signal">Why do so many files need to recompile when I add a signal?</dt>
<dd>
<p>Adding a new signal requires the symbol table to be recompiled. Verilator uses one large symbol table, as that results in 2-3 less assembly instructions for each signal access. This makes the execution time 10-15% faster, but can result in more compilations when something changes.</p>
</dd>
<dt id="How-do-I-access-Verilog-functions-tasks-in-C">How do I access Verilog functions/tasks in C?</dt>
<dd>
<p>Use the SystemVerilog Direct Programming Interface. You write a Verilog function or task with input/outputs that match what you want to call in with C. Then mark that function as a DPI export function. See the DPI chapter in the IEEE Standard.</p>
</dd>
<dt id="How-do-I-access-C-functions-tasks-in-Verilog">How do I access C++ functions/tasks in Verilog?</dt>
<dd>
<p>Use the SystemVerilog Direct Programming Interface. You write a Verilog function or task with input/outputs that match what you want to call in with C. Then mark that function as a DPI import function. See the DPI chapter in the IEEE Standard.</p>
</dd>
<dt id="How-do-I-access-signals-in-C">How do I access signals in C?</dt>
<dd>
<p>The best thing to do is to make a SystemVerilog "export DPI" task or function that accesses that signal, as described in the DPI chapter in the manual and DPI tutorials on the web. This will allow Verilator to better optimize the model and should be portable across simulators.</p>
<p>If you really want raw access to the signals, declare the signals you will be accessing with a /*verilator public*/ comment before the closing semicolon. Then scope into the C++ class to read the value of the signal, as you would any other member variable.</p>
<p>Signals are the smallest of 8-bit unsigned chars (equivalent to uint8_t), 16-bit unsigned shorts (uint16_t), 32-bit unsigned longs (uint32_t), or 64-bit unsigned long longs (uint64_t) that fits the width of the signal. Generally, you can use just uint32_t's for 1 to 32 bits, or vluint64_t for 1 to 64 bits, and the compiler will properly up-convert smaller entities. Note even signed ports are declared as unsigned; you must sign extend yourself to the appropriate signal width.</p>
<p>Signals wider than 64 bits are stored as an array of 32-bit uint32_t's. Thus to read bits 31:0, access signal[0], and for bits 63:32, access signal[1]. Unused bits (for example bit numbers 65-96 of a 65-bit vector) will always be zero. If you change the value you must make sure to pack zeros in the unused bits or core-dumps may result, because Verilator strips array bound checks where it believes them to be unnecessary to improve performance.</p>
<p>In the SYSTEMC example above, if you had in our.v:</p>
<pre><code> input clk /*verilator public*/;
// Note the placement of the semicolon above</code></pre>
<p>From the sc_main.cpp file, you'd then:</p>
<pre><code> #include "Vour.h"
#include "Vour_our.h"
cout << "clock is " << top->our->clk << endl;</code></pre>
<p>In this example, clk is a bool you can read or set as any other variable. The value of normal signals may be set, though clocks shouldn't be changed by your code or you'll get strange results.</p>
</dd>
<dt id="Should-a-module-be-in-Verilog-or-SystemC">Should a module be in Verilog or SystemC?</dt>
<dd>
<p>Sometimes there is a block that just interconnects cells, and have a choice as to if you write it in Verilog or SystemC. Everything else being equal, best performance is when Verilator sees all of the design. So, look at the hierarchy of your design, labeling cells as to if they are SystemC or Verilog. Then:</p>
<p>A module with only SystemC cells below must be SystemC.</p>
<p>A module with a mix of Verilog and SystemC cells below must be SystemC. (As Verilator cannot connect to lower-level SystemC cells.)</p>
<p>A module with only Verilog cells below can be either, but for best performance should be Verilog. (The exception is if you have a design that is instantiated many times; in this case Verilating one of the lower modules and instantiating that Verilated cells multiple times into a SystemC module *may* be faster.)</p>
</dd>
</dl>
<h1 id="BUGS">BUGS</h1>
<p>First, check the <a href="#LANGUAGE-LIMITATIONS">"LANGUAGE LIMITATIONS"</a> section.</p>
<p>Next, try the --debug switch. This will enable additional internal assertions, and may help identify the problem.</p>
<p>Finally, reduce your code to the smallest possible routine that exhibits the bug. Even better, create a test in the test_regress/t directory, as follows:</p>
<pre><code> cd test_regress
cp -p t/t_EXAMPLE.pl t/t_BUG.pl
cp -p t/t_EXAMPLE.v t/t_BUG.v</code></pre>
<p>There are many hints on how to write a good test in the driver.pl documentation which can be seen by running:</p>
<pre><code> cd $VERILATOR_ROOT # Need the original distribution kit
test_regress/driver.pl --help</code></pre>
<p>Edit t/t_BUG.pl to suit your example; you can do anything you want in the Verilog code there; just make sure it retains the single clk input and no outputs. Now, the following should fail:</p>
<pre><code> cd $VERILATOR_ROOT # Need the original distribution kit
cd test_regress
t/t_BUG.pl # Run on Verilator
t/t_BUG.pl --debug # Run on Verilator, passing --debug to Verilator
t/t_BUG.pl --vcs # Run on VCS simulator
t/t_BUG.pl --nc|--iv|--ghdl # Likewise on other simulators</code></pre>
<p>The test driver accepts a number of options, many of which mirror the main Verilator option. For example the previous test could have been run with debugging enabled. The full set of test options can be seen by running driver.pl --help as shown above.</p>
<p>Finally, report the bug using the bug tracker at <a href="https://verilator.org/issues">https://verilator.org/issues</a>. The bug will become publicly visible; if this is unacceptable, mail the bug report to <code>wsnyder@wsnyder.org</code>.</p>
<h1 id="HISTORY">HISTORY</h1>
<p>Verilator was conceived in 1994 by Paul Wasson at the Core Logic Group at Digital Equipment Corporation. The Verilog code that was converted to C was then merged with a C based CPU model of the Alpha processor and simulated in a C based environment called CCLI.</p>
<p>In 1995 Verilator started being used also for Multimedia and Network Processor development inside Digital. Duane Galbi took over active development of Verilator, and added several performance enhancements. CCLI was still being used as the shell.</p>
<p>In 1998, through the efforts of existing DECies, mainly Duane Galbi, Digital graciously agreed to release the source code. (Subject to the code not being resold, which is compatible with the GNU Public License.)</p>
<p>In 2001, Wilson Snyder took the kit, and added a SystemC mode, and called it Verilator2. This was the first packaged public release.</p>
<p>In 2002, Wilson Snyder created Verilator 3.000 by rewriting Verilator from scratch in C++. This added many optimizations, yielding about a 2-5x performance gain.</p>
<p>In 2009, major SystemVerilog and DPI language support was added.</p>
<p>In 2018, Verilator 4.000 was released with multithreaded support.</p>
<p>Currently, various language features and performance enhancements are added as the need arises. Verilator is now about 3x faster than in 2002, and is faster than most (if not every) other simulator.</p>
<h1 id="AUTHORS">AUTHORS</h1>
<p>When possible, please instead report bugs to <a href="https://verilator.org/issues">https://verilator.org/issues</a>.</p>
<p>Wilson Snyder <wsnyder@wsnyder.org></p>
<p>Major concepts by Paul Wasson, Duane Galbi, John Coiner and Jie Xu.</p>
<h1 id="CONTRIBUTORS">CONTRIBUTORS</h1>
<p>Many people have provided ideas and other assistance with Verilator.</p>
<p>Verilator is receiving major development support from the CHIPS Alliance.</p>
<p>Previous major corporate sponsors of Verilator, by providing significant contributions of time or funds included include Atmel Corporation, Cavium Inc., Compaq Corporation, Digital Equipment Corporation, Embecosm Ltd., Hicamp Systems, Intel Corporation, Mindspeed Technologies Inc., MicroTune Inc., picoChip Designs Ltd., Sun Microsystems Inc., Nauticus Networks Inc., and SiCortex Inc.</p>
<p>The people who have contributed major functionality are Byron Bradley, Jeremy Bennett, Lane Brooks, John Coiner, Duane Galbi, Geza Lore, Todd Strader, Stefan Wallentowitz, Paul Wasson, Jie Xu, and Wilson Snyder. Major testers included Jeff Dutton, Jonathon Donaldson, Ralf Karge, David Hewson, Iztok Jeras, Wim Michiels, Alex Solomatnikov, Sebastien Van Cauwenberghe, Gene Weber, and Clifford Wolf.</p>
<p>Some of the people who have provided ideas, and feedback for Verilator include: David Addison, Tariq B. Ahmad, Nikana Anastasiadis, Hans Van Antwerpen, Vasu Arasanipalai, Jens Arm, Sharad Bagri, Matthew Ballance, Andrew Bardsley, Matthew Barr, Geoff Barrett, Julius Baxter, Jeremy Bennett, Michael Berman, Victor Besyakov, Moinak Bhattacharyya, David Binderman, Piotr Binkowski, Johan Bjork, David Black, Tymoteusz Blazejczyk, Daniel Bone, Gregg Bouchard, Christopher Boumenot, Nick Bowler, Byron Bradley, Bryan Brady, Maarten De Braekeleer, Charlie Brej, J Briquet, Lane Brooks, John Brownlee, Jeff Bush, Lawrence Butcher, Tony Bybell, Ted Campbell, Chris Candler, Lauren Carlson, Donal Casey, Sebastien Van Cauwenberghe, Alex Chadwick, Terry Chen, Yi-Chung Chen, Enzo Chi, Robert A. Clark, Allan Cochrane, John Coiner, Gianfranco Costamagna, Sean Cross, George Cuan, Joe DErrico, Lukasz Dalek, Laurens van Dam, Gunter Dannoritzer, Ashutosh Das, Bernard Deadman, John Demme, Mike Denio, John Deroo, Philip Derrick, John Dickol, Ruben Diez, Danny Ding, Jacko Dirks, Ivan Djordjevic, Jonathon Donaldson, Leendert van Doorn, Sebastian Dressler, Alex Duller, Jeff Dutton, Tomas Dzetkulic, Usuario Eda, Charles Eddleston, Chandan Egbert, Joe Eiler, Ahmed El-Mahmoudy, Trevor Elbourne, Mats Engstrom, Robert Farrell, Eugen Fekete, Fabrizio Ferrandi, Udi Finkelstein, Brian Flachs, Andrea Foletto, Bob Fredieu, Duane Galbi, Benjamin Gartner, Christian Gelinek, Peter Gerst, Glen Gibb, Michael Gielda, Shankar Giri, Dan Gisselquist, Petr Gladkikh, Sam Gladstone, Amir Gonnen, Chitlesh Goorah, Kai Gossner, Sergi Granell, Al Grant, Alexander Grobman, Xuan Guo, Driss Hafdi, Neil Hamilton, James Hanlon, Oyvind Harboe, Jannis Harder, Junji Hashimoto, Thomas Hawkins, Mitch Hayenga, Robert Henry, Stephen Henry, David Hewson, Jamey Hicks, Joel Holdsworth, Andrew Holme, Hiroki Honda, Alex Hornung, David Horton, Peter Horvath, Jae Hossell, Alan Hunter, James Hutchinson, Jamie Iles, Ben Jackson, Shareef Jalloq, Krzysztof Jankowski, HyungKi Jeong, Iztok Jeras, James Johnson, Christophe Joly, Franck Jullien, James Jung, Mike Kagen, Arthur Kahlich, Kaalia Kahn, Guy-Armand Kamendje, Vasu Kandadi, Kanad Kanhere, Patricio Kaplan, Pieter Kapsenberg, Ralf Karge, Dan Katz, Sol Katzman, Ian Kennedy, Jonathan Kimmitt, Olof Kindgren, Kevin Kiningham, Dan Kirkham, Sobhan Klnv, Gernot Koch, Soon Koh, Nathan Kohagen, Steve Kolecki, Brett Koonce, Will Korteland, Wojciech Koszek, Varun Koyyalagunta, David Kravitz, Roland Kruse, Sergey Kvachonok, Charles Eric LaForest, Ed Lander, Steve Lang, Stephane Laurent, Walter Lavino, Christian Leber, Larry Lee, Igor Lesik, John Li, Eivind Liland, Yu Sheng Lin, Charlie Lind, Andrew Ling, Jiuyang Liu, Paul Liu, Derek Lockhart, Jake Longo, Geza Lore, Arthur Low, Stefan Ludwig, Dan Lussier, Fred Ma, Duraid Madina, Affe Mao, Julien Margetts, Mark Marshall, Alfonso Martinez, Yves Mathieu, Patrick Maupin, Jason McMullan, Elliot Mednick, Wim Michiels, Miodrag Milanovic, Wai Sum Mong, Peter Monsson, Sean Moore, Dennis Muhlestein, John Murphy, Matt Myers, Nathan Myers, Richard Myers, Dimitris Nalbantis, Peter Nelson, Bob Newgard, Cong Van Nguyen, Paul Nitza, Yossi Nivin, Pete Nixon, Lisa Noack, Mark Nodine, Kuba Ober, Andreas Olofsson, Aleksander Osman, James Pallister, Vassilis Papaefstathiou, Brad Parker, Dan Petrisko, Maciej Piechotka, David Pierce, Dominic Plunkett, David Poole, Mike Popoloski, Roman Popov, Rich Porter, Niranjan Prabhu, Usha Priyadharshini, Mark Jackson Pulver, Prateek Puri, Marshal Qiao, Danilo Ramos, Chris Randall, Anton Rapp, Josh Redford, Odd Magne Reitan, Frederic Requin, Frederick Requin, Dustin Richmond, Alberto Del Rio, Eric Rippey, Oleg Rodionov, Ludwig Rogiers, Paul Rolfe, Arjen Roodselaar, Tobias Rosenkranz, Huang Rui, Jan Egil Ruud, Denis Rystsov, John Sanguinetti, Galen Seitz, Salman Sheikh, Hao Shi, Mike Shinkarovsky, Rafael Shirakawa, Jeffrey Short, Anderson Ignacio Da Silva, Rodney Sinclair, Steven Slatter, Brian Small, Garrett Smith, Tim Snyder, Maciej Sobkowski, Stan Sokorac, Alex Solomatnikov, Wei Song, Art Stamness, David Stanford, John Stevenson, Pete Stevenson, Patrick Stewart, Rob Stoddard, Todd Strader, John Stroebel, Sven Stucki, Howard Su, Emerson Suguimoto, Gene Sullivan, Qingyao Sun, Renga Sundararajan, Rupert Swarbrick, Yutetsu Takatsukasa, Peter Tengstrand, Wesley Terpstra, Rui Terra, Stefan Thiede, Gary Thomas, Ian Thompson, Kevin Thompson, Mike Thyer, Hans Tichelaar, Viktor Tomov, Steve Tong, Michael Tresidder, Neil Turton, Srini Vemuri, Yuri Victorovich, Bogdan Vukobratovic, Holger Waechtler, Philipp Wagner, Stefan Wallentowitz, Shawn Wang, Paul Wasson, Greg Waters, Thomas Watts, Eugene Weber, David Welch, Thomas J Whatson, Marco Widmer, Leon Wildman, Daniel Wilkerson, Gerald Williams, Trevor Williams, Jan Van Winkel, Jeff Winston, Joshua Wise, Clifford Wolf, Tobias Wolfel, Johan Wouters, Junyi Xi, Ding Xiaoliang, Jie Xu, Mandy Xu, Takatsukasa Y, Luke Yang, and Amir Yazdanbakhsh.</p>
<p>Thanks to them, and all those we've missed including above, or wished to remain anonymous.</p>
<h1 id="DISTRIBUTION">DISTRIBUTION</h1>
<p>The latest version is available from <a href="https://verilator.org">https://verilator.org</a>.</p>
<p>Copyright 2003-2020 by Wilson Snyder. This program is free software; you can redistribute it and/or modify the Verilator internals under the terms of either the GNU Lesser General Public License Version 3 or the Perl Artistic License Version 2.0.</p>
<p>All Verilog and C++/SystemC code quoted within this documentation file are released as Creative Commons Public Domain (CC0). Many example files and test files are likewise released under CC0 into effectively the Public Domain as described in the files themselves.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>verilator_coverage</a>, <a>verilator_gantt</a>, <a>verilator_profcfunc</a>, <a>make</a>,</p>
<p><a href="#verilator---help">"verilator --help"</a> which is the source for this document,</p>
<p>and docs/internals.adoc in the distribution.</p>
</body>
</html>
|
