1VERILATOR_COVERAGE(1) User Contributed Perl DocumentationVERILATOR_COVERAGE(1)
2
3
4

NAME

6       verilator_coverage - Verilator coverage analyzer
7

SYNOPSIS

9           verilator_coverage --help
10           verilator_coverage --version
11
12           verilator_coverage --annotate <obj>
13
14           verilator_coverage  -write merged.dat -read <datafiles>...
15
16       Verilator_coverage processes Verilator coverage reports.
17
18       With --anotate, it reads the specified data file and generates
19       annotated source code with coverage metrics annotated.  If multiple
20       coverage points exist on the same line, additional lines will be
21       inserted to report the additional points.
22
23       Additional Verilog-standard arguments specify the search paths
24       necessary to find the source code that the coverage analysis was
25       performed on.
26
27       To get correct coverage percentages, you may wish to read
28       logs/coverage.dat into Emacs and do a M-x keep-lines to include only
29       those statistics of interest.
30
31       For Verilog conditions that should never occur, you should add a $stop
32       statement.  This will remove the coverage during the next build.
33

ARGUMENTS

35       filename
36           Specify input data file, may be repeated to read multiple inputs.
37           If no data file is specified, by default coverage.dat is read.
38
39       --annotate output_directory
40           Sprcifies the directory name that source files with annotated
41           coverage data should be written to.
42
43       --annotate-all
44           Specifies all files should be shown.  By default, only those source
45           files which have low coverage are written to the output directory.
46
47       --annotate-min count
48           Specifies the minimum occurrence count that should be flagged if
49           the coverage point does not include a specified threshold.
50           Defaults to 10.
51
52       --help
53           Displays this message and program version and exits.
54
55       --rank
56           Print an experimental report listing the relative importance of
57           each test in covering all of the coverage points.  The report shows
58           "Covered" which indicates the number of points that test covers; a
59           test is considered to cover a point if it has a bucket count of at
60           least 1. The "rank" column has a higher number t indicate the test
61           is more important, and rank 0 means the test does not need to be
62           run to cover the points.  "RankPts" indicates the number of
63           coverage points this test will contribute to overall coverage if
64           all tests are run in the order of highest to lowest rank.
65
66       --unlink
67           When using --write to combine coverage data, unlink all input files
68           after the output has been created.
69
70       --version
71           Displays program version and exits.
72
73       --write filename
74           Specifies the aggregate coverage results, summed across all the
75           files, should be written to the given filename.  This is useful in
76           scripts to combine many sequential runs into one master coverage
77           file.
78

VERILOG ARGUMENTS

80       The following arguments are compatible with GCC, VCS and most Verilog
81       programs.
82
83       +libext+ext+ext...
84           Defines the extensions for Verilog files.
85
86       +define+var+value =item -Dvar=value
87           Defines the given variable.
88
89       +incdir+dir =item -Idir
90           Specifies a directory for finding include files.
91
92       -f file
93           Specifies a file containing additional command line arguments.
94
95       -y dir
96           Specifies a module search directory.
97

DISTRIBUTION

99       The latest version is available from <http://www.veripool.org/>.
100
101       Copyright 2003-2018 by Wilson Snyder.  Verilator is free software; you
102       can redistribute it and/or modify the Verilator internals under the
103       terms of either the GNU Lesser General Public License Version 3 or the
104       Perl Artistic License Version 2.0.
105

AUTHORS

107       Wilson Snyder <wsnyder@wsnyder.org>
108

SEE ALSO

110       "verilator"
111
112       "verilator_coverage --help" which is the source for this document.
113
114
115
116perl v5.28.1                      2018-03-11             VERILATOR_COVERAGE(1)
Impressum