vcoverage man page

vcoverage — Verilog/SystemC coverage analyzer

Synopsis

 Create report:
    vcoverage -f input.vc <datafile>
 Merge reports
    vcoverage --noreport -write <merged.dat>  <datafiles>

Description

Vcoverage reads the specified data file and generates annotated source code with coverage metrics annotated.  By default logs/coverage.pl is read. If multiple coverage points exist on the same line, additional lines will be inserted to report the additional points.

Additional Verilog-standard arguments specify the search paths necessary to find the source code that the coverage analysis was performed on.

To get correct coverage percentages, you may wish to read logs/coverage.pl into Emacs and do a M-x keep-lines to include only those statistics of interest.

For Verilog conditions that should never occur, you should add a $stop statement.  This will remove the coverage during the next build.

Arguments

--all-files

Specifies all files should be shown.  By default, only those source files which have low coverage are written to the output directory.

--help

Displays this message and program version and exits.

--min count

Specifies the minimum occurrence count that should be flagged if the coverage point does not include a specified threshold.  Defaults to 10.

--noreport

Don't produce output files.  Used with --write to merge files.

--o output_directory

Sprcifies the directory name that source files with annotated coverage data should be written to.

--unlink

When using --write to combine coverage data, unlink all input files after the output has been created.

--version

Displays program version and exits.

--write filename

Specifies the aggregate coverage results, summed across all the files, should be written to the given filename.  This is useful in scripts to combine many sequential runs into one master coverage file.

Verilog Arguments

The following arguments are compatible with GCC, VCS and most Verilog programs.

+libext+ext+ext...

Defines the extensions for Verilog files.

+define+var+value =item -Dvar=value

Defines the given variable.

+incdir+dir =item -Idir

Specifies a directory for finding include files.

-f file

Specifies a file containing additional command line arguments.

-y dir

Specifies a module search directory.

Distribution

SystemPerl is part of the <http://www.veripool.org/> free SystemC software tool suite.  The latest version is available from CPAN and from <http://www.veripool.org/systemperl>.

Copyright 2001-2014 by Wilson Snyder.  This package is free software; you can redistribute it and/or modify it under the terms of either the GNU Lesser General Public License Version 3 or the Perl Artistic License Version 2.0.

Authors

Wilson Snyder <wsnyder@wsnyder.org>

See Also

SystemC::Manual, Verilog::Getopt, SystemC::Coverage

Info

2014-11-06 perl v5.24.1 User Contributed Perl Documentation