Simulator Options - 2023.2 English

AI Engine Tools and Flows User Guide (UG1076)

Document ID
Release Date
2023.2 English

The complete set of the AI Engine simulator (aiesimulator) options are described in this section. In most cases, just pointing to pkg-dir is sufficient.

Table 1. AI Engine Simulator Options
Options Description
-h, --help Shows the help message and exits.
--display-run-interval=<time in ns> Displays time stamp periodically after each time (in ns) tick. For example, aiesimulator --display-run-interval=10 --pkg-dir=./Work --i=.. will display the time stamp every 10ns, as seen in Figure 1.
--dump-vcd=<file> Dump VCD waveform information into <file>. Because the tool appends .vcd to the specified file name, it is not necessary to include the file suffix.
Note: This option allows you to access a subset of the signals. If you want all the signals or a different subset of the signals you should use the --options-file option to specify the category of signals to be generated in the VCD file.
Note: To generate the XPE file from the aiesimulator generated vcd file, use the vcdanalyze tool as follows:
vcdanalyze --vcd <vcdfile> --xpe [OPTIONS]
The available options are:
  • -s=<STARTTIME>: Specifies the start time (Optional).
  • -e=<ENDTIME>: Specifies the end time (Optional).
  • --out=<RPT>: Generates the workload estimation report in ".rpt" format.
  • -v: Generates verbose output (Optional).
  • --xpe: Generates the power estimate report.
  • --xpe-dir=<XPEOutputDir>: Specifies the directory for generating XPE reports. The default is ./aiesim_xpe.
For information on using the XPE file, see Power Design Manager User Guide (UG1556).
Note: The --online option and --dump-vcd option cannot be used together. If both options are specified, only --online option takes effect.
--options-file=<file> Text file used to select and generate specific VCD data. For example, aiesimulator --options-file=<options>.txt --dump-vcd. The <options.txt> file will specify modules whose data needs to be generated as VCD data.

This switch should be used along with --dump-vcd switch for generating VCD.

--enable-memory-check Enable runtime program and data memory boundary access check. Any violation access will be reported as an [ERROR] message. This option is disabled by default. When you run a simulation with this option enabled, and open the run summary in the Vitis IDE, the graph view displays a Memory Violations tab. This tab reports all the memory violations detected in the simulation run. You can click on a specific violation and navigate to the line in the source code causing the violation. For more information, see Memory Violations.
--hang-detect-time=<time in ns> The aiesimulator will exit if all active cores are in a stalled state after the time period (in ns), provided by this option. For example, if the option--hang-detect-time=10 is provided to the aiesimulator, if after 10 ns all the active cores are in a stalled state, the aiesimulator will exit.
Note: This option is not supported in AI Engine-ML devices.
-i Alias of --input-dir=<dir> option.
-o Alias of --output-dir=<dir> option.
--pkg-dir=<dir> Specify the package directory, for example, ./Work.
--profile Generates profiling data for all used cores. Allows generation of printf trace messages on stdout and collects profiling statistics during simulation. This can slightly slow down the simulator.
Optionally, specify profiling of specific cores by using --profile=(col,row)(col,row)...
Note: This option is not yet available in hw_emu for AI Engine ML
--simulation-cycle-timeout=<cycles> Run the application for a given number of cycles after it is loaded.
Tip: Specify the --simulation-cycle-timeout option to end the simulation session after the specified number of cycles. However, when specifying simulation timeout during the debug process, be sure to specify a larger number of cycles because the debug will terminate when the timeout cycle is reached.
--online -text -wdb

Use this option with -text and -wdb to parse VCD data on-the-fly, to produce an event.txt file, and waveform database (WDB) output file.

For example, aiesimulator --pkg-dir=./Work --i=.. --online -text -wdb will produce a WDB file and an event text file that can be opened in the Vitis IDE.

Tip: The --online and --dump-vcd options cannot be used together. If both options are specified, AI Engine Simulator gives an error.
--output-time-stamp Use --output-time-stamp=no to get output file without time values and --output-time-stamp to get uniform time value (in ns) in output file.
Figure 1. AI Engine Simulator Display Run Example