3. Usage¶
3.1. CLI¶
Once you have RISCV-ISAC installed, executing riscv_isac --help should print the following on the terminal.
Options:
--version Show the version and exit.
-v, --verbose [info|error|debug]
Set verbose level
--help Show this message and exit.
Commands:
coverage Run Coverage analysis on tracefile.
merge Merge given coverage files.
normalize Normalize the cgf.
RISCV-ISAC has three commands : coverage, merge and normalize which are described below.
Help text for each command can be accessed by executing riscv_isac <command> --help
Help command:
Usage: riscv_isac coverage [OPTIONS]
Run Coverage analysis on tracefile.
Options:
-e, --elf PATH ELF file
-t, --trace-file PATH Instruction trace file to be analyzed
-c, --cgf-file PATH Coverage Group File [required]
-d, --detailed Select detailed mode of coverage printing
--parser-name NAME Parser plugin name
--decoder-name NAME Decoder plugin name
--parser-path PATH Parser file path
--decoder-path PATH Decoder file path
-o, --output-file PATH Coverage Group File
--test-label LABEL_START LABEL_END
Pair of labels denoting start and end points
of the test region(s). Multiple allowed.
--sig-label LABEL_START LABEL_END
Pair of labels denoting start and end points
of the signature region(s). Multiple
allowed.
--dump PATH Dump Normalized Coverage Group File
-l, --cov-label COVERAGE LABEL Coverage labels to consider for this run.
-x, --xlen [32|64] XLEN value for the ISA.
--help Show this message and exit.
Help Command:
Usage: riscv_isac merge [OPTIONS] [FILES]...
Merge given coverage files.
Options:
-d, --detailed Select detailed mode of coverage printing
-c, --cgf-file PATH Coverage Group File [required]
-o, --output-file PATH Coverage Group File.
--help Show this message and exit.
Help Command:
Usage: riscv_isac normalize [OPTIONS]
Normalize the cgf.
Options:
-c, --cgf-file PATH Coverage Group File [required]
-o, --output-file PATH Coverage Group File [required]
-x, --xlen [32|64] XLEN value for the ISA.
--help Show this message and exit.