Vl-model-opts-p
Options for running vl model.
(vl-model-opts-p x) is a defaggregate of the following fields.
- help — Show a brief usage message and exit.
Invariant (booleanp help).
- readme — Show a more elaborate README and exit.
Invariant (booleanp readme).
- outdir — Default is ".". Controls where the translation files should
be written.
Invariant (stringp outdir).
- model-file — Default is "model.sao". Contains the main vl-translation-p
object with E modules as well as copious other information
about from the translation. See the readme for details. To
avoid writing this file, you can use the empty string, i.e.,
--model-file ''.
Invariant (stringp model-file).
- esims-file — Default is "esims.sao". Contains just the E modules, and is
typically much smaller than model.sao. To avoid writing this
file, you can use the empty string, i.e., --esims-file ''.
Invariant (stringp esims-file).
- verilog-file — Default is "vl_model.v". Contains a "simplified" version
of some subset of the input Verilog modules. To avoid writing
this file, use the empty string, i.e., --verilog-file ''.
Invariant (stringp verilog-file).
- start-files — The list of files to parse. (Not options; this is the rest of
the command line, hence :hide t).
Invariant (string-listp start-files).
- search-path — Control the search path for finding modules. You can give
this switch multiple times, to set up multiple search paths in
priority order.
Invariant (string-listp search-path).
- include-dirs — Control the list of directories for `include files. You can
give this switch multiple times. By default, we look only in
the current directory.
Invariant (string-listp include-dirs).
- search-exts — Control the search extensions for finding modules. You can
give this switch multiple times. By default we just look for
files named "foo.v" in the --search directories. But if you
have Verilog files with different extensions, this won't work,
so you can add these extensions here. EXT should not include
the period, e.g., use "--searchext vv" to consider files
like "foo.vv", etc.
Invariant (string-listp search-exts).
- defines — Set up definitions to use before parsing begins. Equivalent
to putting `define VAR 1 at the top of your Verilog file.
You can give this option multiple times.
Invariant (string-listp defines).
- unroll-limit — Set the maximum number of times to unroll loops to LIMIT.
Default: 100.
Invariant (natp unroll-limit).
- dropmods — Delete MOD from the module hierarchy before doing any simplification.
This is a gross (but effective) way to work through any bugs in
VL that cause hard errors and are triggered by certain modules.
We will fail to model anything that depends on the dropped
modules.
Invariant (string-listp dropmods).
- edition — Which edition of the Verilog standard to implement?
Default: "SystemVerilog" (IEEE 1800-2012). You can
alternately use "Verilog" for IEEE 1364-2005, i.e.,
Verilog-2005.
Invariant (vl-edition-p edition).
- strict — Disable VL extensions to Verilog.
Invariant (booleanp strict).
- mem — How much memory to try to use. Default: 4 GB. Raising this
may improve performance by avoiding garbage collection. To
avoid swapping, keep this below (physical_memory - 2 GB).
Invariant (posp mem).
- mustfail — Print a failure message and exit with status 1 if MOD is
translated successfully. This option is mainly meant for
running tests to ensure that VL is properly rejecting bad
constructs. You can give this option multiple times.
Invariant (string-listp mustfail).
- mustget — Print a failure message and exit with status 1 if MOD is
not translated successfully. You can give this option
multiple times.
Invariant (string-listp mustget).
Source link: vl-model-opts-p
Subtopics
- Parse-vl-model-opts
- Parse arguments from the command line into a vl-model-opts-p aggregate.
- Vl-model-opts
- Raw constructor for vl-model-opts-p structures.
- Make-vl-model-opts
- Constructor macro for vl-model-opts-p structures.
- Honsed-vl-model-opts
- Raw constructor for honsed vl-model-opts-p structures.
- Change-vl-model-opts
- A copying macro that lets you create new vl-model-opts-p structures, based on existing structures.
- *vl-model-opts-usage*
- Automatically generated usage message.
- Make-honsed-vl-model-opts
- Constructor macro for honsed vl-model-opts-p structures.
- Vl-model-opts->verilog-file
- Access the verilog-file field of a vl-model-opts-p structure.
- Vl-model-opts->unroll-limit
- Access the unroll-limit field of a vl-model-opts-p structure.
- Vl-model-opts->strict
- Access the strict field of a vl-model-opts-p structure.
- Vl-model-opts->start-files
- Access the start-files field of a vl-model-opts-p structure.
- Vl-model-opts->search-path
- Access the search-path field of a vl-model-opts-p structure.
- Vl-model-opts->search-exts
- Access the search-exts field of a vl-model-opts-p structure.
- Vl-model-opts->readme
- Access the readme field of a vl-model-opts-p structure.
- Vl-model-opts->outdir
- Access the outdir field of a vl-model-opts-p structure.
- Vl-model-opts->mustget
- Access the mustget field of a vl-model-opts-p structure.
- Vl-model-opts->mustfail
- Access the mustfail field of a vl-model-opts-p structure.
- Vl-model-opts->model-file
- Access the model-file field of a vl-model-opts-p structure.
- Vl-model-opts->mem
- Access the mem field of a vl-model-opts-p structure.
- Vl-model-opts->include-dirs
- Access the include-dirs field of a vl-model-opts-p structure.
- Vl-model-opts->help
- Access the help field of a vl-model-opts-p structure.
- Vl-model-opts->esims-file
- Access the esims-file field of a vl-model-opts-p structure.
- Vl-model-opts->edition
- Access the edition field of a vl-model-opts-p structure.
- Vl-model-opts->dropmods
- Access the dropmods field of a vl-model-opts-p structure.
- Vl-model-opts->defines
- Access the defines field of a vl-model-opts-p structure.
