Simics Reference Manual

1 Introduction

This manual contains the reference documentation for Simics itself. It includes a complete list of all commands defined by the Simics core as well as by the loadable modules included in the main product. It also provides documentation on the available components and classes.

This manual is aimed at Simics users (the command list chapter, and possibly the lists of components and classes) and script developers (haps, classes, and interfaces).

This manual is strictly meant to be used as reference documentation, and it provides little explanation on how to use the various features described. Refer to other Simics manuals for more information; these are listed in the Documentation Contents document.
Additional reference documentation:

Simics API Reference Manual
Includes descriptions of all Simics APIs with their functions, types, interfaces and haps. Most of the API functions are available for scripting to all Simics users. The APIs needed for model development and for extending the simulator itself require the Simics Model Builder product.
Target-Specific Reference Manuals
Target system packages typically come with reference manuals documenting the classes, commands and haps that they define.

2 Command-Line Tools and Programs

This section documents the command-line options of the tools and programs delivered as part of Simics.

2.1 simics

OPTIONS

--batch-mode Run in batch mode. This means that Simics will exit when all commands and scripts given on the command line have executed.

If an error has occurred, Simics will exit with a non-zero status. If all commands run to completion without any error, Simics exits with status 0, indicating success.

Simics will not use the command history file in batch mode.
--license Print the Simics license text and exit. This is the default license and is also included in the LICENSE file.
--log-file FILE Log issued CLI commands to a different file than the default. This implies -log (unless -no-log was specified).
--no-win Disable external windows. This will prevent Simics from opening target console windows or any other external windows.

Disabling a target console only makes it invisible. It does not change its simulated functionality. Disabling it is useful when running in batch mode or when the target console isn't needed, since it doesn't require access to a graphical environment, and running with windows disabled is usually somewhat faster.
--script-trace Show when a Simics script is entered/exited, along with any parameters passed to it and result variables returned from it.
--verbose Make Simics more verbose. This makes Simics give ample details about the execution. This is the opposite of the --quiet flag. The quiet and verbose flags turn off each other. The default is somewhere in the middle with a "reasonable" output level.

Setting the verbose flag can be useful when solving problems with Simics. Some friendly warnings are not printed unless verbose is turned on.

Note that there will be quite a bit of information printed, most of which isn't usually needed.
-e COMMAND or --execute COMMAND Execute a CLI command. Equivalent of typing in the command at the command line prompt.
-h, --help Makes Simics print a brief help screen and exit.
-q or --quiet Make Simics less verbose. This makes Simics output less information, which is useful for batch execution. The opposite effect can be obtained with the --verbose flag. The quiet and verbose flags turn off each other. If you want Simics to be really quiet you can also give the --no-copyright flag.

Note that Simics is rather quiet by default, so this flag usually does not have much effect.
-v, --version, --base-version
Print the Simics version number and exit. Other information printed include the information of packages. --base-version only prints out Simics version.
-x
This flag has no effect and is kept for compatibility; it takes no arguments.

ADVANCED-OPTIONS

--echo Enable command echoing. When echoing is enabled, Simics will echo all commands executed by startup scripts. Note that this only affects any startup scripts loaded after the -echo flag on the command line.
--module-path Add a path to the directory list that Simics searches for modules.
--no-copyright Do not display copyright information when starting Simics. See also the --verbose and --quiet flags.
--no-settings Do not read any settings files, such as preferences.
--stop-on-error Stop the simulation and interrupt the currently running script on error logs.

With this option, error logs with be treated as actual errors, and set the exit status accordingly when used in combination with --batch-mode.
-core
Allow Simics to dump core on fatal signals.
-dstc
Force the D-STC to be enabled. See the -no-stc flag for more information.
-istc
Force the I-STC to be enabled. See the -no-stc flag for more information.
-n, --no-startup Do not run the commands from the startup-commands script files.
-no-dstc
Force the D-STC to be disabled. See the -no-stc flag for more information.
-no-istc
Force the I-STC to be disabled. See the -no-stc flag for more information.
-no-stc
Disable the Simics internal caches for memory operations and instruction fetches (STCs) that Simics uses to speed up the simulation.

Disabling the STCs (this flag disables both the D-STC and the I-STC) can be useful for debugging plug-ins such as cache models, since it will ensure that all memory accesses are fully visible.

It is possible to selectively disable the data and instruction STCs using the -no-dstc and -no-istc flags, respectively. The STCs are typically enabled by default, although in some versions of Simics they may be disabled. See also the -stc flag.
-python-verbose
Set the Python verbose flag. This will, for example, make Python print information when Python modules are being loaded. This is the same option as the -v flag in mini-python.
-stc
Force the I-STC and D-STC to be enabled (default). See the -no-stc flag for more information. The STCs are typically enabled by default, although in some versions of Simics they may be disabled.

2.2 addon-manager

SYNOPSIS

addon-manager [options] [-u path] [-s path] [-d path]

DESCRIPTION

Configure Simics add-on packages to work with the Simics installation. When run without any option, this script will list the current add-on packages configuration. If any package listed is invalid (for example, if the package has been deleted), the script will propose to update the configuration to remove the invalid packages.

OPTIONS

-b, --batch The script will act according to the command-line arguments without asking any questions.
-c, --create-empty Create an empty package list in the project. This will cause the project to ignore any package associations of the main Simics installation. Only valid when operating on a project or together with the -f parameter.
-C, --copy-from-simics-base Create a new package list in a project, by copying the package list from the main Simics installation. Only valid when operating on a project or together with the -f parameter. Roughly equivalent to -u simics_dir.
-d, --deselect PATH Remove the package in PATH from the add-on package list. Note that listed packages that do not exist anymore will be removed automatically whenever this script runs.
-f, --package-list Specify the file containing the package list. This is an alternative to the default (storing the list in the main Simics installation) or running addon-manager in a project.
-s, --select PATH Add the package in PATH to the add-on package list.
-u, --upgrade [PATH|FILE] Re-use the add-on package list found as FILE or present in PATH. The current list is backed-up as with a .backup extension.
-v, --version Print the version of the script and the major version of Simics that it can be used with.
-p, --project PATH Handle the package associations of the project path instead of the base package. This can also be done by running the addon-manager script located in path/bin.

2.3 craff

SYNOPSIS

craff [options] [input-file ...]

DESCRIPTION

The compressed random access file format is used by Simics's image module to handle sparse block data. The craff command line utility can be used to create and manipulate craff files.

The default operation is to merge the input files, each of which can be either in craff format, fixed-type VHD format, VHDX format, or raw files (e.g., disk or memory dumps) and to output the merged result to an output file. The order of the input files is important: data from later input files override earlier files. Since craff files can have holes (gaps) in them, data from earlier files can propagate to the result.

Each file argument is on the form filename[,start[,size[,offset]]] where start, size and offset are optional numerical parameters as follows:

start
Where the input file data should be placed in the output. If omitted, zero is assumed.
size
How much to use from the input file. By default, all data to the end of the file is used.
offset
Where in the input file to read the data. If omitted, zero is assumed.

For example, the argument myfile.craff,300,100,700 will take 100 bytes at offset 700 from myfile.craff and place them at offset 300 in the output.

OPTIONS

-o, --output=FILE
Specifies the output file name. Without this option, output will go to craff.out. A hyphen (-) means standard output, and implies -q. Writing to standard output is only possible in raw format (-d) or when writing a content map (-l).
-d, --decompress
Causes the output to be an ordinary (raw) file. The default is to output in the craff format. When this option is given, any holes in the output are filled with zero bytes.
--vhd
Causes the output to be in VHD (Windows Virtual Hard Disk) format. The generated file is always of the "Fixed hard disk" (non-sparse) type, holes filled with zero bytes.
--create=SIZE
Create a zero filled image of the specified size without using any input files.
-l, --content-map
Writes a human-readable map of the input files to the output. Blocks are marked D where data is present, and . (dot) where not.
-D, --diff
Instead of merging the input files, output the difference between the input files as a craff file. There must be exactly two input files. The output is the file that, when merged with the first file, would result in the second file. The input files may be in craff or raw format.
-z, --zero-fill-gaps
Fills gaps with zero bytes and marks them as present. Without this option, a gap in all input files will remain a gap in the output file.
-Z, --omit-zero-blocks
Treats blocks that consist entirely of zero bytes as empty in the output (i.e., they will be output as holes).
-b, --block-size=SIZE
Specifies the output block size in bytes. The size must be a power of 2, and may be specified in kilobytes using 'k' as a suffix. Without this option, the block size will be the smallest of the input files' block sizes.

This is the smallest unit of storage in a craff file. Larger values compress better, but will waste more space if only part of the block is present. A block size of at least 4k is recommended.
-s, --sub-block-size=SIZE
Specifies the output sub-block size in bytes. The size must be a power of 2, and may be specified in kilobytes using 'k' as a suffix. Without this option, the block size will be the smallest of the input files' sub-block sizes.

This is the smallest unit of granularity in a craff file. Smaller values allow more fine-grained control of what data is present, but uses more space. For disk dumps, the sector size is useful (often 512 bytes); for memory dumps, use the page size (such as 4k or 8k).
-i, --dir-entries=N
Specifies the number of entries in each directory node. Must be a power of 2.
-c, --compression=COMPRESSION
Specifies the compression type: none or zlib. No compression is faster but zlib makes the files smaller.
-e, --extract=START
Extracts a block to the output file. The extracted block starts at file offset START and the size is given by --extract-block-size. The output is in raw format.
-w, --extract-block-size=SIZE
Size of block to extract with --extract.
-r, --resize=SIZE
Create an output file of the specified size, zero padding it if the input files are shorter than this size or truncating it if they are longer.
--verify
Verify the integrity of the input files.
-n, --info
Displays file information for each of the input files to the standard output.
-q, --quiet
Suppresses the progress indicator.
-v, --version
Displays version information of the craff utility itself.
-h, --help
Displays a summary of the command line options.

2.4 project-setup

SYNOPSIS

project-setup [options] [project]

DESCRIPTION

Creates or updates a Simics project for user scripts and modules. If project directory is omitted, the current working directory is used.

The host Python path to be used in the project can be set via the --python command line parameter or via the SIMICS_PYTHON environment variable. If any of these are set, a Python virtual environment is also created and all necessary Python packages are installed into it, unless --no-venv is specified. The generated project scripts will use the Python in the virtual environment, or the specified Python directly if --no-venv is specified. To make sure Python packages required by the Simics GUI are also installed, use the --with-gui command line parameter.

OPTIONS

-h, --help Show help message and exit.
-v, --version Prints information about Simics (version, installation directory).
-V, --verbose Print more information about the actions taken by the script.
-n, --dry-run Execute normally, but do not change or create any files.
--ignore-existing-files Suppress warnings when creating a new project using a directory that is not empty.
--package-list Provide an explicit list of add-on packages for the project. Each line must be an absolute path for an add-on package. A project-local .package-list file will be created.
--python Path to the host Python binary to be used by all Simics executions in the project. If not set, the SIMICS_PYTHON environment variable is read to obtain the host Python path. If neither is set, no host Python is used and package 1033 must be available.
--no-venv Do not create a Python virtual environment in the project.
--ignore-cygwin-warning (Windows-only) Prevent the script from checking whether the project directory looks like a Cygwin path or not.
--force Force the project-setup script to create or update a project. Files that would be overwritten will be backed up automatically.
--check-project-version Check the version of the project, and return 1 if it needs to be created or updated, 0 otherwise.
--with-cmake Create a project with CMake support.
--without-cmake Create a project without CMake support (Default).
--with-gmake Create a project with GNU Make support (Default).
--without-gmake Create a project without GNU Make support.

2.5 checkpoint-merge

SYNOPSIS

checkpoint-merge [options] src dst [paths...]

src The checkpoint to merge files from.
dst The new checkpoint.
paths Paths to checkpoint files. This parameter may be omitted, in which case paths are derived from the source checkpoint.

DESCRIPTION

Merges all ancestors of a given checkpoint into a new checkpoint. The output checkpoint therefore has no dependencies; it is an absolute checkpoint. This is useful if you, for example, want to distribute a checkpoint.

Note that this also merges image files with disk and memory contents, to make sure the output checkpoint really is self-contained.

With the --checkpoints-only option, the resulting checkpoint will still have references to initial image files, so it will not really be entirely self-contained. However, it is likely to be smaller and the merge itself takes less time.

Any recordings in the given checkpoint, i.e. the most recent source checkpoint, are discarded.

OPTIONS

-c, --checkpoints-only Only combine checkpoints, keeping dependencies on base image files.
-j N, --jobs=N Run up to N craff/copy jobs in parallel.
-h, --help Show help message and exit.

2.6 test-runner

SYNOPSIS

test-runner [options] [suite-pattern ...]

DESCRIPTION

List or run Simics tests.

Simics tests are placed in test suites, which are directories containing a SUITEINFO file. By default, the test-runner command searches for test suites in the directories test, targets and modules of the Simics project, and in the test directory of installed Simics packages.

If the program is run with the flag --list, the names of all found test suites are listed:

$ ./bin/test-runner --list
modules/bar/test
modules/foo/test
test/t15_checkpoints: [simics]/test/t15_checkpoints

The name of a suite is the path of the directory, relative to the project or Simics installation path, using / as directory separator. If the test suite is located in the Simics installation, then the absolute path is printed as well.

The flag --test can be used to list the individual tests of each test suite:

$ ./bin/test-runner --tests --suite=modules/bar/test
Suite: modules/foo/test
    s-foo
    s-info-status

If neither --list nor --tests is passed, all found test suites will be run. For example, the command ./bin/test-runner --suite=modules/bar/test will run all tests of the test suite modules/bar/test. If test-runner is run with no arguments, then all tests in all test suites will be run.

Other than the argument --suite, a suite pattern can also be used to filter test suites. If one or more suite patterns are provided, only the suites matching at least one of the patterns will be run. A suite matches a suite pattern if the pattern is a substring of the suite's name. For example, if there is a suite modules/foo/test, then the command ./bin/test-runner foo will run that suite, and possibly other suites as well.

When an environment variable TEST_PATTERN is set, the value will be used as a pattern to filter the tests to be run within the test suite. The pattern is interpreted according to Python's regular expression syntax. For example, if the variable is set as export TEST_PATTERN="s-.+DMA-", then test-runner will run tests named s-xyz-DMA-read and s-abc-DMA-write, and skip tests named Xs-xyz-DMA-read or s-abc-DMAwrite.

The variable can also be set to multiple patterns with the semicolon as a separator, e.g. export TEST_PATTERN="pattern0;pattern1". This will run tests that match any one of the given patterns.

By default, all tests run sequentially. When the -j option is passed, automatically added s-*.py scripts, may be executed in parallel. The tests will be executed in an unspecified order, so -j should only be used if you know that there are no dependencies between the tests of the suite.

OPTIONS

-h, --help: show this help message and exit
--details: print detail help information
--logdir: the directory tests save logfiles in, defaults to [project]/logs/tests
--basedir: the base directory where the modules containing the tests exist, defaults to 'modules'
--moduledirs: directories with modules containing tests,separated by ';'
--project-only: disable the tests from Simics packages
-l, --list: list the suites matching the patterns
-t, --tests: list tests matching the given patterns
--tag TAG: Run all suites where a tag in SUITEINFO matches TAG
--suite SUITE: specify a test suite to be executed
-n NAME, --name NAME: specify a test name to be executed
-j N, --jobs N: run up to N Simics script tests in parallel in each test suite; N will be automatically set to the number of processors on the machine if not specified
-v, --verbose: print more verbose information when running
--py3: Deprecated, no effect.
--py2: Deprecated, no effect.

RETURN VALUE

The exit status is 0 if selected test suites succeed, 1 if there is an internal error, and 2 if any test fails.

2.7 project-setup Model Builder functionality

SYNOPSIS

project-setup [options] [project]

DESCRIPTION

This section only includes the Model Builder specific functionality of project-setup. The documentation for the basic functionality can be found in the Simics Reference Manual.

OPTIONS

--device=DEVICE_NAME, --dml-device=DEVICE_NAME Generate skeleton code for a device, suitable to use as a starting point for implementing your own device. The default implementation language is DML. See the --c-device and --py-device options for creating devices using other languages. If the device already exists, this option is ignored. To recreate the skeleton, remove the device directory.
--c-device=DEVICE_NAME Similar to --device, but creates a device using C instead of DML.
--c++-device=DEVICE_NAME Similar to --device, but creates a device using C++ instead of DML.
--py-device=DEVICE_NAME Similar to --device, but creates a device using Python and the pyobj module instead of DML.
--py-device-confclass=DEVICE_NAME Similar to --device, but creates a device using Python and the confclass module instead of DML.
--component=COMPONENT_NAME Similar to --device, but creates a component skeleton in Python.
--copy-module=DEVICE_NAME Copies the source code of a module into the project. The files will be copied from the Simics installation. If the module already exist in your project, you must manually delete it first.
--list-modules List the modules with source code that can be copied into the project using the --copy-module argument.
--osa-tracker=TRACKER_NAME Generate skeleton code for an OS Awareness tracker, suitable to use as a starting point for implementing your own OS Awareness tracker. If the module already exists, this option is ignored. To recreate the skeleton, remove the module directory. The skeleton will be created in a directory named after the TRACKER_NAME and suffixed with '-tracker'.
--instrumentation-tool=TOOL_NAME Generate skeleton code for an instrumentation tool, suitable to use as a starting point for implementing your own tool. If the module already exists, this option is ignored. To recreate the skeleton, remove the module directory. The skeleton will be created in a directory named after the TOOL_NAME.
--instrumentation-filter=FILTER_NAME Generate skeleton code for an instrumentation filter, suitable to use as a starting point for implementing your own filter. If the module already exists, this option is ignored. To recreate the skeleton, remove the module directory. The skeleton will be created in a directory named after the FILTER_NAME.

3 Commands

3.1 Command Categories

3.1.1 Breakpoints

<bank_instrumentation_subscribe>.bp-break-bank – set device access break
<bank_instrumentation_subscribe>.bp-run-until-bank – run until specified device access occurs
<bank_instrumentation_subscribe>.bp-trace-bank – enable tracing of device accesses
<bank_instrumentation_subscribe>.bp-wait-for-bank – wait for specified device access
<bp-manager.bank>.break – set device access break
<bp-manager.bank>.run-until – run until specified device access occurs
<bp-manager.bank>.trace – enable tracing of device accesses
<bp-manager.bank>.wait-for – wait for specified device access
<bp-manager.con-gfx>.break – set graphical breakpoint
<bp-manager.con-gfx>.run-until – run until graphical break matches
<bp-manager.con-gfx>.trace – enable tracing of graphical matches
<bp-manager.con-gfx>.wait-for – wait for graphical match
<bp-manager.con-string>.break – set string breakpoint
<bp-manager.con-string>.run-until – run until string appears
<bp-manager.con-string>.trace – enable tracing of string appearances
<bp-manager.con-string>.wait-for – wait for specified string
<bp-manager.con-string>.wait-then-write – wait for a string, then write an input string
<bp-manager.cr>.break – set break on control register access
<bp-manager.cr>.run-until – run until specified control register access
<bp-manager.cr>.trace – enable tracing of control register accesses
<bp-manager.cr>.wait-for – wait for specified control register access
<bp-manager.cycle>.break – set cycle breakpoint
<bp-manager.cycle>.run-until – run until specified cycle
<bp-manager.cycle>.trace – enable tracing of cycle points
<bp-manager.cycle>.wait-for – wait for specified cycle
<bp-manager.cycle_event>.break – set cycle event break
<bp-manager.cycle_event>.run-until – run until specified cycle event occurs
<bp-manager.cycle_event>.trace – enable tracing of cycle events
<bp-manager.cycle_event>.wait-for – wait for specified cycle event
<bp-manager.eth_link>.break – break on Found src mac in network stream at the provided link
<bp-manager.eth_link>.run-until – trace Found src mac in network stream at the provided link
<bp-manager.eth_link>.trace – wait_for
<bp-manager.eth_link>.wait-for – run_until
<bp-manager.exc>.break – set break on exception
<bp-manager.exc>.run-until – run until specified exception occurs
<bp-manager.exc>.trace – enable tracing of exceptions
<bp-manager.exc>.wait-for – wait for specified exception
<bp-manager.hap>.break – set hap breakpoint
<bp-manager.hap>.run-until – run until hap triggers
<bp-manager.hap>.trace – enable tracing of hap triggers
<bp-manager.hap>.wait-for – wait for hap to trigger
<bp-manager.log>.break – set break on log output
<bp-manager.log>.run-until – run until log output appears
<bp-manager.log>.trace – enable tracing of log messages
<bp-manager.log>.wait-for – wait until log output appears
<bp-manager.magic>.break – set magic instruction break
<bp-manager.magic>.run-until – run until specified magic instruction occurs
<bp-manager.magic>.trace – enable tracing of magic instructions
<bp-manager.magic>.wait-for – wait for specified magic instruction
<bp-manager.memory>.break – set break on memory access
<bp-manager.memory>.run-until – run until specified memory access
<bp-manager.memory>.trace – enable tracing of memory accesses
<bp-manager.memory>.unbreak – remove breakpoint range
<bp-manager.memory>.wait-for – wait for specified memory access
<bp-manager.msr>.break – set break on architectural MSR access
<bp-manager.msr>.run-until – run until specified architectural MSR access
<bp-manager.msr>.trace – enable tracing of architectural MSR accesses
<bp-manager.msr>.wait-for – wait for specified architectural MSR access
<bp-manager.notify>.break – set notifier breakpoint
<bp-manager.notify>.run-until – run until notifier triggers
<bp-manager.notify>.trace – enable tracing of notifier triggers
<bp-manager.notify>.wait-for – wait for notifier to trigger
<bp-manager.os_awareness>.break – break on OS Awareness node changes
<bp-manager.os_awareness>.run-until – run until OS Awareness node changes
<bp-manager.os_awareness>.trace – trace OS Awareness node changes
<bp-manager.os_awareness>.wait-for – wait for OS Awareness node changes
<bp-manager.src-line>.break – add breakpoint at a source code line
<bp-manager.src-line>.run-until – run until reaching source code line
<bp-manager.src-line>.trace – enable tracing of source code line reaches
<bp-manager.src-line>.wait-for – wait until reaching source code line
<bp-manager.src-location>.break – add breakpoint at a location
<bp-manager.src-location>.run-until – run until reaching location
<bp-manager.src-location>.trace – enable tracing of location reaches
<bp-manager.src-location>.wait-for – wait until reaching location
<bp-manager.step>.break – set step breakpoint
<bp-manager.step>.run-until – run until specified step
<bp-manager.step>.trace – enable tracing of step points
<bp-manager.step>.wait-for – wait for specified step
<bp-manager.step_event>.break – set step event break
<bp-manager.step_event>.run-until – run until specified step event occurs
<bp-manager.step_event>.trace – enable tracing of step events
<bp-manager.step_event>.wait-for – wait for specified step event
<bp-manager.time>.break – set time breakpoint
<bp-manager.time>.run-until – run until specified time
<bp-manager.time>.trace – enable tracing of time points
<bp-manager.time>.wait-for – wait for specified time
<bp_manager>.disable – disable breakpoint
<bp_manager>.enable – enable breakpoint
<bp_manager>.enabled – enable or disable breakpoint
<bp_manager>.ignore-count – set number of hits of breakpoint to ignore
<bp_manager>.list-types – list breakpoint type providers
<bp_manager>.test-trigger – test trigger breakpoint
<bp_manager>.wait-for-breakpoint – wait for breakpoint
<break_strings_v2>.bp-break-console-string – set string breakpoint
<break_strings_v2>.bp-run-until-console-string – run until string appears
<break_strings_v2>.bp-trace-console-string – enable tracing of string appearances
<break_strings_v2>.bp-wait-for-console-string – wait for specified string
<breakpoint>.bp-break-memory – set break on memory access
<breakpoint>.bp-run-until-memory – run until specified memory access
<breakpoint>.bp-trace-memory – enable tracing of memory accesses
<breakpoint>.bp-wait-for-memory – wait for specified memory access
<cycle>.bp-break-cycle – set cycle breakpoint
<cycle>.bp-break-time – set time breakpoint
<cycle>.bp-run-until-cycle – run until specified cycle
<cycle>.bp-run-until-time – run until specified time
<cycle>.bp-trace-cycle – enable tracing of cycle points
<cycle>.bp-trace-time – enable tracing of time points
<cycle>.bp-wait-for-cycle – wait for specified cycle
<cycle>.bp-wait-for-time – wait for specified time
<cycle_event_instrumentation>.bp-break-cycle-event – set cycle event break
<cycle_event_instrumentation>.bp-run-until-cycle-event – run until specified cycle event occurs
<cycle_event_instrumentation>.bp-trace-cycle-event – enable tracing of cycle events
<cycle_event_instrumentation>.bp-wait-for-cycle-event – wait for specified cycle event
<exception>.bp-break-exception – set break on exception
<exception>.bp-run-until-exception – run until specified exception occurs
<exception>.bp-trace-exception – enable tracing of exceptions
<exception>.bp-wait-for-exception – wait for specified exception
<gfx_break>.bp-break-gfx – set graphical breakpoint
<gfx_break>.bp-run-until-gfx – run until graphical break matches
<gfx_break>.bp-trace-gfx – enable tracing of graphical matches
<gfx_break>.bp-wait-for-gfx – wait for graphical match
<graphcon>.gfx-break-info – return information about a graphical breakpoint
<graphcon>.gfx-break-match – determine if graphical breakpoint currently matches
<graphcon>.save-break-xy – specify and save a graphical breakpoint
<network_breakpoint>.bp-break-network – break on Found src mac in network stream at the provided link
<network_breakpoint>.bp-run-until-network – trace Found src mac in network stream at the provided link
<network_breakpoint>.bp-trace-network – wait_for
<network_breakpoint>.bp-wait-for-network – run_until
<osa_component>.bp-break – break on OS Awareness node changes
<osa_component>.bp-run-until – run until OS Awareness node changes
<osa_component>.bp-trace – trace OS Awareness node changes
<osa_component>.bp-wait-for – wait for OS Awareness node changes
<processor_internal>.bp-break-control-register – set break on control register access
<processor_internal>.bp-break-magic – set magic instruction break
<processor_internal>.bp-run-until-control-register – run until specified control register access
<processor_internal>.bp-run-until-magic – run until specified magic instruction occurs
<processor_internal>.bp-trace-control-register – enable tracing of control register accesses
<processor_internal>.bp-trace-magic – enable tracing of magic instructions
<processor_internal>.bp-wait-for-control-register – wait for specified control register access
<processor_internal>.bp-wait-for-magic – wait for specified magic instruction
<register_breakpoint>.break-register – add a register breakpoint
<register_breakpoint>.break-register-list – list current breakpoints
<register_breakpoint>.unbreak-register – remove a register breakpoint
<step>.bp-break-step – set step breakpoint
<step>.bp-run-until-step – run until specified step
<step>.bp-trace-step – enable tracing of step points
<step>.bp-wait-for-step – wait for specified step
<step_event_instrumentation>.bp-break-step-event – set step event break
<step_event_instrumentation>.bp-run-until-step-event – run until specified step event occurs
<step_event_instrumentation>.bp-trace-step-event – enable tracing of step events
<step_event_instrumentation>.bp-wait-for-step-event – wait for specified step event
<symdebug>.bp-break-source-line – add breakpoint at a source code line
<symdebug>.bp-break-source-location – add breakpoint at a location
<symdebug>.bp-run-until-source-line – run until reaching source code line
<symdebug>.bp-run-until-source-location – run until reaching location
<symdebug>.bp-trace-source-line – enable tracing of source code line reaches
<symdebug>.bp-trace-source-location – enable tracing of location reaches
<symdebug>.bp-wait-for-source-line – wait until reaching source code line
<symdebug>.bp-wait-for-source-location – wait until reaching location
<x86_msr>.bp-break-msr – set break on architectural MSR access
<x86_msr>.bp-run-until-msr – run until specified architectural MSR access
<x86_msr>.bp-trace-msr – enable tracing of architectural MSR accesses
<x86_msr>.bp-wait-for-msr – wait for specified architectural MSR access
break-io – break on device accesses
unbreak-io – break on device accesses

3.1.2 CLI

! – execute a shell command
!= – not equal
# – treat the line as a comment
$ – get the value of a CLI variable
% – read register by name, module or string formatting
& – various bitwise operators
* – arithmetic multiplication
+ – arithmetic addition
+= – add to a CLI variable
- – arithmetic subtraction
-= – subtract from a CLI variable
-> – access object attribute
/ – arithmetic division
: – unused operator
< – less than
<< – bitwise left shift
<= – less or equal
= – set a CLI variable
== – equal
> – greater than
>= – greater or equal
>> – bitwise right shift
@ – evaluate a Python statement
[
^ – bitwise XOR operation
| – bitwise OR operation
~ – bitwise not
<script-params>.assigned – return names of assigned parameters
<script-params>.describe – display parameter information
<script-params>.get – get parameter value
<script-params>.help – display script parameters
<script-params>.list – list parameter values
<script-params>.save – save parameter values
<script-params>.setdefault – set parameter value default
add-data-to-script-pipe – send data to a script pipe
alias – add an alias
and – logical and
atoi – convert string to integer
bin – display integer in binary notation
bits – bit manipulation
break-loop – break the execution in a script loop
break-script-branch – break the execution of a script branch
cd – change working directory
change-namespace – change current namespace
command-file-history – list current CLI script stack
command-file-stack – list current CLI command file stack
command-history – show CLI command history
continue-loop – skip to next iteration in a script loop
create-script-barrier – create a script barrier
create-script-pipe – create a script pipe
current-namespace – return current namespace
date – host time and date
dec – display integer in decimal notation
decl – declare parameter
defined – variable defined
digit-grouping – set or show output formatting for numbers
dirs – display directory stack
disable-jit – disable JIT compilation for all JIT-capable processors
disable-tech-preview – disable tech preview for feature
disable-unsupported-feature – disable unsupported feature
display – print expression at prompt
echo – print a value
enable-jit – enable JIT compilation for all JIT-capable processors
enable-tech-preview – enable tech preview for feature
enable-unsupported-feature – enable unsupported feature
env – return environment variable value
exec – execute a string as a CLI command
expect – fail if not equal
foreach – run code with iterator
get-command-args – get list of command arguments
hex – display integer in hexadecimal notation
if – run a block conditionally
in-list – check for occurrence in list
in-string – check for substring in string
int-to-double-float – interpret integer as 64-bit floating point
int-to-extended-double-float – interpret integer as 80-bit floating point
int-to-quad-float – interpret integer as 128-bit floating point
int-to-single-float – interpret integer as 32-bit floating point
interrupt-script – interrupt script execution
interrupt-script-branch – interrupt the execution of a script branch
list-commands – list CLI commands
list-length – returns the length of a list
list-presets – list available presets
list-processors – list processors
list-processors-summary – prints a summary for processors
list-script-branches – list all script branches
list-targets – list available targets
list-transactions – list deferred transactions
list-variables – list CLI variables
load-target – load a target system
local – define a local variable
ls – list files
match-string – compare string with a pattern and return matches
max – max
min – min
not – logical not
object-exists – check if object exists
oct – display integer in octal notation
or – logical or
output-radix – change the default output radix
pid – print pid of Simics process
pipe – run commands through a pipe
popd – pop directory from directory stack
pow – power of
print – display integer in various bases
pselect – get or set the currently selected processor/clock
pushd – push directory on directory stack
pwd – print working directory
python – evaluate a Python expression
python-mode – switch command line to Python mode
quit – quit from Simics
range – create and return a list of integers
read-variable – value of a named variable
restart-simics – restart the current simics session
run-script – run a script file
script-barrier-limit – manipulate the script barrier limit
script-branch – start a script branch
script-pipe-has-data – check if script pipe contains data
set-table-border-style – set table border style
shell – execute a shell command
signed – interpret unsigned integer as signed
simulation-running – check if simulation is running
split-string – split string based on its type
string-length – returns the length of a string in bytes
telnet-frontend – enable telnet access to the command line
try – runs a block of commands and catches any error
undisplay – remove expression installed by display
unset – remove a CLI variable
unsigned – interpret an integer as unsigned 64-bit
wait-for-global-sync – wait until the global time in all cells is synchronized
wait-for-global-time – wait until reaching a specified global time
wait-for-script-barrier – wait until enough branches have reached a barrier
wait-for-script-pipe – wait until there is data on a script pipe
wait-for-simulation-started – wait for simulation to start
wait-for-simulation-stopped – wait for simulation to stop
while – run a block while true

3.1.3 Components

<component>.connect-to – connect component into an existing component hierarchy
<component>.delete – delete non-instantiated components
<component>.get-available-connector – returns the name of a free connector
<component>.get-component-object – get named object from components
<component>.get-connection – return connection information
<component>.get-connector-list – return list of connectors
<component>.get-processor-list – return list of processors
change-namespace – change current namespace
connect – connect connectors
copy-connector – copy object
create-and-connect-ddr-memory-comp – create and connect memory modules to the system
create-brody – create a non-instantiated brody
create-can-link – create a non-instantiated can_link
create-cell-and-clocks-comp – create a non-instantiated cell_and_clocks_comp
create-cp3-quad100tx – create a non-instantiated cp3_quad100tx
create-cpci-adapter – create a non-instantiated cpci_adapter
create-cpci-backplane – create a non-instantiated cpci_backplane
create-datagram-link – create a non-instantiated datagram_link
create-ddr-memory-module-comp – create a non-instantiated ddr_memory_module_comp
create-ddr2-memory-module-comp – create a non-instantiated ddr2_memory_module_comp
create-ddr3-memory-module-comp – create a non-instantiated ddr3_memory_module_comp
create-deckard – create a non-instantiated deckard
create-dummy-comp – create a non-instantiated dummy_comp
create-elliot – create a non-instantiated elliot
create-emmett – create a non-instantiated emmett
create-empty-components – create a non-instantiated empty_components
create-etg-comp – create a non-instantiated etg_comp
create-etg-panel-comp – create a non-instantiated etg_panel_comp
create-eth-injector-comp – create a non-instantiated eth_injector_comp
create-ethan – create a non-instantiated ethan
create-ethernet-cable – create a non-instantiated ethernet_cable
create-ethernet-hub – create a non-instantiated ethernet_hub
create-ethernet-switch – create a non-instantiated ethernet_switch
create-ethernet-vlan-switch – create a non-instantiated ethernet_vlan_switch
create-frankie-carbone – create a non-instantiated frankie_carbone
create-generic-pcie-switch – create a non-instantiated generic_pcie_switch
create-gertie – create a non-instantiated gertie
create-gfx-console-comp – create a non-instantiated gfx_console_comp
create-gml-link – create a non-instantiated gml_link
create-godzilla – create a non-instantiated godzilla
create-hal – create a non-instantiated hal
create-hunt – create a non-instantiated hunt
create-i210-comp – create a non-instantiated i210_comp
create-i210-v2-comp – create a non-instantiated i210_v2_comp
create-i2c-link-v2 – create a non-instantiated i2c_link_v2
create-i3c-cable – create a non-instantiated i3c_cable
create-i3c-link – create a non-instantiated i3c_link
create-i82571EB-v2-comp – create a non-instantiated i82571EB_v2_comp
create-i82574-v2-comp – create a non-instantiated i82574_v2_comp
create-i82576EB-v2-comp – create a non-instantiated i82576EB_v2_comp
create-i82583V-v2-comp – create a non-instantiated i82583V_v2_comp
create-ide-cdrom-comp – create a non-instantiated ide_cdrom_comp
create-ide-disk-comp – create a non-instantiated ide_disk_comp
create-ieee-802-15-4-link – create a non-instantiated ieee_802_15_4_link
create-korben – create a non-instantiated korben
create-leeloo – create a non-instantiated leeloo
create-legacy-upstream-pcie-adapter-comp – create a non-instantiated legacy_upstream_pcie_adapter_comp
create-maria-singer – create a non-instantiated maria_singer
create-marvin – create a non-instantiated marvin
create-mcfly – create a non-instantiated mcfly
create-micron-mtfc128gap-emmc-card – create a non-instantiated micron_mtfc128gap_emmc_card
create-micron-mtfc16gap-emmc-card – create a non-instantiated micron_mtfc16gap_emmc_card
create-micron-mtfc2ggqdi-emmc-card – create a non-instantiated micron_mtfc2ggqdi_emmc_card
create-micron-mtfc32gap-emmc-card – create a non-instantiated micron_mtfc32gap_emmc_card
create-micron-mtfc4gacaeam-emmc-card – create a non-instantiated micron_mtfc4gacaeam_emmc_card
create-micron-mtfc4gacaeam-emmc-card-with-boot-part – create a non-instantiated micron_mtfc4gacaeam_emmc_card_with_boot_part
create-micron-mtfc4ggqdi-emmc-card – create a non-instantiated micron_mtfc4ggqdi_emmc_card
create-micron-mtfc4ggqdi-sdhc-card – create a non-instantiated micron_mtfc4ggqdi_sdhc_card
create-micron-mtfc64gap-emmc-card – create a non-instantiated micron_mtfc64gap_emmc_card
create-micron-mtfc64ggqdi-sdhc-card – create a non-instantiated micron_mtfc64ggqdi_sdhc_card
create-micron-mtfc8gacaeam-emmc-card – create a non-instantiated micron_mtfc8gacaeam_emmc_card
create-micron-mtfc8gam-emmc-card – create a non-instantiated micron_mtfc8gam_emmc_card
create-mmc-card-comp – create a non-instantiated mmc_card_comp
create-motherboard-x86-simple – create a non-instantiated motherboard_x86_simple
create-motherboard-x86-simple-no-apic – create a non-instantiated motherboard_x86_simple_no_apic
create-nemo – create a non-instantiated nemo
create-nikita – create a non-instantiated nikita
create-pci-accel-vga-comp – create a non-instantiated pci_accel_vga_comp
create-pci-accel-vga-v2-comp – create a non-instantiated pci_accel_vga_v2_comp
create-pci-am79c973-comp – create a non-instantiated pci_am79c973_comp
create-pci-bcm5703c-comp – create a non-instantiated pci_bcm5703c_comp
create-pci-bcm5704c-comp – create a non-instantiated pci_bcm5704c_comp
create-pci-dec21041-comp – create a non-instantiated pci_dec21041_comp
create-pci-dec21140 – create a non-instantiated pci_dec21140
create-pci-dec21140-panel – create a non-instantiated pci_dec21140_panel
create-pci-dec21140a-comp – create a non-instantiated pci_dec21140a_comp
create-pci-dec21143-comp – create a non-instantiated pci_dec21143_comp
create-pci-i21152-comp – create a non-instantiated pci_i21152_comp
create-pci-i82543gc-comp – create a non-instantiated pci_i82543gc_comp
create-pci-i82546bg-comp – create a non-instantiated pci_i82546bg_comp
create-pci-i82559-comp – create a non-instantiated pci_i82559_comp
create-pci-pd6729-comp – create a non-instantiated pci_pd6729_comp
create-pci-vga-comp – create a non-instantiated pci_vga_comp
create-pcmcia-flash-disk-comp – create a non-instantiated pcmcia_flash_disk_comp
create-phy-comp – create a non-instantiated phy_comp
create-rachel – create a non-instantiated rachel
create-real-network-bridge-comp – create a non-instantiated real_network_bridge_comp
create-real-network-host-comp – create a non-instantiated real_network_host_comp
create-ripley – create a non-instantiated ripley
create-roy-batty – create a non-instantiated roy_batty
create-sample-802-15-4-panel – create a non-instantiated sample_802_15_4_panel
create-sample-802-15-4-transceiver-comp – create a non-instantiated sample_802_15_4_transceiver_comp
create-sample-dynamic-connectors – create a non-instantiated sample_dynamic_connectors
create-sample-i3c-target-comp – create a non-instantiated sample_i3c_target_comp
create-sample-pci-card – create a non-instantiated sample_pci_card
create-sample-pcie-device-comp – create a non-instantiated sample_pcie_device_comp
create-sample-pcie-endpoint-shim-comp – create a non-instantiated sample_pcie_endpoint_shim_comp
create-sample-pcie-switch-shim-comp – create a non-instantiated sample_pcie_switch_shim_comp
create-sample-signal-device – create a non-instantiated sample_signal_device
create-sata-cdrom-comp – create a non-instantiated sata_cdrom_comp
create-sata-disk-comp – create a non-instantiated sata_disk_comp
create-sdram-memory-module-comp – create a non-instantiated sdram_memory_module_comp
create-sebastian – create a non-instantiated sebastian
create-ser-link – create a non-instantiated ser_link
create-service-node-comp – create a non-instantiated service_node_comp
create-signal-link – create a non-instantiated signal_link
create-simics-nvme-comp – create a non-instantiated simics_nvme_comp
create-simple-memory-module – create a non-instantiated simple_memory_module
create-standard-pcie-switch-comp – create a non-instantiated standard_pcie_switch_comp
create-txt-console-comp – create a non-instantiated txt_console_comp
create-tyler-durden – create a non-instantiated tyler_durden
create-tyrell – create a non-instantiated tyrell
create-usb-disk-comp – create a non-instantiated usb_disk_comp
create-usb-hs-keyboard-comp – create a non-instantiated usb_hs_keyboard_comp
create-usb-keyboard-comp – create a non-instantiated usb_keyboard_comp
create-usb-mouse-comp – create a non-instantiated usb_mouse_comp
create-usb-tablet-component – create a non-instantiated usb_tablet_component
create-virtio-mmio-blk-comp – create a non-instantiated virtio_mmio_blk_comp
create-virtio-pcie-blk-comp – create a non-instantiated virtio_pcie_blk_comp
create-virtio-pcie-fs-comp – create a non-instantiated virtio_pcie_fs_comp
create-virtio-pcie-net-comp – create a non-instantiated virtio_pcie_net_comp
create-wall-e – create a non-instantiated wall_e
create-x86-chassis – create a non-instantiated x86_chassis
create-zorg – create a non-instantiated zorg
current-namespace – return current namespace
delete-connector – delete connector copy
disconnect – disconnect connectors
instantiate-components – instantiate components
list-components – print components
move-object – move object
new-brody – create an instantiated brody
new-can-link – create an instantiated can_link
new-cell-and-clocks-comp – create an instantiated cell_and_clocks_comp
new-cp3-quad100tx – create an instantiated cp3_quad100tx
new-cpci-adapter – create an instantiated cpci_adapter
new-cpci-backplane – create an instantiated cpci_backplane
new-datagram-link – create an instantiated datagram_link
new-ddr-memory-module-comp – create an instantiated ddr_memory_module_comp
new-ddr2-memory-module-comp – create an instantiated ddr2_memory_module_comp
new-ddr3-memory-module-comp – create an instantiated ddr3_memory_module_comp
new-deckard – create an instantiated deckard
new-dummy-comp – create an instantiated dummy_comp
new-elliot – create an instantiated elliot
new-emmett – create an instantiated emmett
new-empty-components – create an instantiated empty_components
new-etg-comp – create an instantiated etg_comp
new-etg-panel-comp – create an instantiated etg_panel_comp
new-eth-injector-comp – create an instantiated eth_injector_comp
new-ethan – create an instantiated ethan
new-ethernet-cable – create an instantiated ethernet_cable
new-ethernet-hub – create an instantiated ethernet_hub
new-ethernet-switch – create an instantiated ethernet_switch
new-ethernet-vlan-switch – create an instantiated ethernet_vlan_switch
new-frankie-carbone – create an instantiated frankie_carbone
new-generic-pcie-switch – create an instantiated generic_pcie_switch
new-gertie – create an instantiated gertie
new-gfx-console-comp – create an instantiated gfx_console_comp
new-gml-link – create an instantiated gml_link
new-godzilla – create an instantiated godzilla
new-hal – create an instantiated hal
new-hunt – create an instantiated hunt
new-i210-comp – create an instantiated i210_comp
new-i210-v2-comp – create an instantiated i210_v2_comp
new-i2c-link-v2 – create an instantiated i2c_link_v2
new-i3c-cable – create an instantiated i3c_cable
new-i3c-link – create an instantiated i3c_link
new-ide-cdrom-comp – create an instantiated ide_cdrom_comp
new-ide-disk-comp – create an instantiated ide_disk_comp
new-ieee-802-15-4-link – create an instantiated ieee_802_15_4_link
new-korben – create an instantiated korben
new-leeloo – create an instantiated leeloo
new-legacy-upstream-pcie-adapter-comp – create an instantiated legacy_upstream_pcie_adapter_comp
new-maria-singer – create an instantiated maria_singer
new-marvin – create an instantiated marvin
new-mcfly – create an instantiated mcfly
new-micron-mtfc128gap-emmc-card – create an instantiated micron_mtfc128gap_emmc_card
new-micron-mtfc16gap-emmc-card – create an instantiated micron_mtfc16gap_emmc_card
new-micron-mtfc2ggqdi-emmc-card – create an instantiated micron_mtfc2ggqdi_emmc_card
new-micron-mtfc32gap-emmc-card – create an instantiated micron_mtfc32gap_emmc_card
new-micron-mtfc4gacaeam-emmc-card – create an instantiated micron_mtfc4gacaeam_emmc_card
new-micron-mtfc4gacaeam-emmc-card-with-boot-part – create an instantiated micron_mtfc4gacaeam_emmc_card_with_boot_part
new-micron-mtfc4ggqdi-emmc-card – create an instantiated micron_mtfc4ggqdi_emmc_card
new-micron-mtfc4ggqdi-sdhc-card – create an instantiated micron_mtfc4ggqdi_sdhc_card
new-micron-mtfc64gap-emmc-card – create an instantiated micron_mtfc64gap_emmc_card
new-micron-mtfc64ggqdi-sdhc-card – create an instantiated micron_mtfc64ggqdi_sdhc_card
new-micron-mtfc8gacaeam-emmc-card – create an instantiated micron_mtfc8gacaeam_emmc_card
new-micron-mtfc8gam-emmc-card – create an instantiated micron_mtfc8gam_emmc_card
new-mmc-card-comp – create an instantiated mmc_card_comp
new-motherboard-x86-simple – create an instantiated motherboard_x86_simple
new-motherboard-x86-simple-no-apic – create an instantiated motherboard_x86_simple_no_apic
new-nemo – create an instantiated nemo
new-nikita – create an instantiated nikita
new-pci-accel-vga-comp – create an instantiated pci_accel_vga_comp
new-pci-accel-vga-v2-comp – create an instantiated pci_accel_vga_v2_comp
new-pci-am79c973-comp – create an instantiated pci_am79c973_comp
new-pci-bcm5703c-comp – create an instantiated pci_bcm5703c_comp
new-pci-bcm5704c-comp – create an instantiated pci_bcm5704c_comp
new-pci-dec21041-comp – create an instantiated pci_dec21041_comp
new-pci-dec21140 – create an instantiated pci_dec21140
new-pci-dec21140-panel – create an instantiated pci_dec21140_panel
new-pci-dec21140a-comp – create an instantiated pci_dec21140a_comp
new-pci-dec21143-comp – create an instantiated pci_dec21143_comp
new-pci-i21152-comp – create an instantiated pci_i21152_comp
new-pci-i82543gc-comp – create an instantiated pci_i82543gc_comp
new-pci-i82546bg-comp – create an instantiated pci_i82546bg_comp
new-pci-i82559-comp – create an instantiated pci_i82559_comp
new-pci-pd6729-comp – create an instantiated pci_pd6729_comp
new-pci-vga-comp – create an instantiated pci_vga_comp
new-pcmcia-flash-disk-comp – create an instantiated pcmcia_flash_disk_comp
new-phy-comp – create an instantiated phy_comp
new-rachel – create an instantiated rachel
new-real-network-bridge-comp – create an instantiated real_network_bridge_comp
new-real-network-host-comp – create an instantiated real_network_host_comp
new-ripley – create an instantiated ripley
new-roy-batty – create an instantiated roy_batty
new-sample-802-15-4-panel – create an instantiated sample_802_15_4_panel
new-sample-802-15-4-transceiver-comp – create an instantiated sample_802_15_4_transceiver_comp
new-sample-dynamic-connectors – create an instantiated sample_dynamic_connectors
new-sample-i3c-target-comp – create an instantiated sample_i3c_target_comp
new-sample-pci-card – create an instantiated sample_pci_card
new-sample-pcie-device-comp – create an instantiated sample_pcie_device_comp
new-sample-pcie-endpoint-shim-comp – create an instantiated sample_pcie_endpoint_shim_comp
new-sample-pcie-switch-shim-comp – create an instantiated sample_pcie_switch_shim_comp
new-sample-signal-device – create an instantiated sample_signal_device
new-sata-cdrom-comp – create an instantiated sata_cdrom_comp
new-sata-disk-comp – create an instantiated sata_disk_comp
new-sdram-memory-module-comp – create an instantiated sdram_memory_module_comp
new-sebastian – create an instantiated sebastian
new-ser-link – create an instantiated ser_link
new-service-node-comp – create an instantiated service_node_comp
new-signal-link – create an instantiated signal_link
new-simics-nvme-comp – create an instantiated simics_nvme_comp
new-simple-memory-module – create an instantiated simple_memory_module
new-standard-pcie-switch-comp – create an instantiated standard_pcie_switch_comp
new-txt-console-comp – create an instantiated txt_console_comp
new-tyler-durden – create an instantiated tyler_durden
new-tyrell – create an instantiated tyrell
new-usb-disk-comp – create an instantiated usb_disk_comp
new-usb-hs-keyboard-comp – create an instantiated usb_hs_keyboard_comp
new-usb-keyboard-comp – create an instantiated usb_keyboard_comp
new-usb-mouse-comp – create an instantiated usb_mouse_comp
new-usb-tablet-component – create an instantiated usb_tablet_component
new-virtio-mmio-blk-comp – create an instantiated virtio_mmio_blk_comp
new-virtio-pcie-blk-comp – create an instantiated virtio_pcie_blk_comp
new-virtio-pcie-fs-comp – create an instantiated virtio_pcie_fs_comp
new-virtio-pcie-net-comp – create an instantiated virtio_pcie_net_comp
new-wall-e – create an instantiated wall_e
new-x86-chassis – create an instantiated x86_chassis
new-zorg – create an instantiated zorg
save-component-template – save a component configuration template

3.1.4 Configuration

<image>.add-diff-file – add a diff file to the image
<image>.add-partial-diff-file – add a partial diff file to the image
<image>.clear-files – clear the list of files for an image
<image>.list-files – list files representing the contents of an image
<image>.save – save image to disk
<image>.save-diff-file – save changes since last checkpoint
<memory-space>.add-map – map device in a memory-space
<memory-space>.del-map – remove device map from a memory-space
<memory-space>.map – print memory map
<port-space>.add-map – map device in a port-space
<port-space>.del-map – remove device map from a port-space
<port-space>.map – print port map
add-directory – add a directory to the Simics search path
add-module-directory – add a directory to the module search path
check-cell-partitioning – verify that cell partitioning is OK
devs – list all mapped devices in Simics
enable-writable-persistent-state – create/load a R/W persistent state
l – list namespace objects
list-attributes – list all attributes
list-blueprint-params – list blueprint parameters
list-blueprint-state – list blueprint state
list-blueprints – list blueprints
list-checkpoints – list checkpoints
list-classes – list all configuration classes
list-failed-modules – list the modules that are not loadable
list-interfaces – list all interfaces
list-modules – list loadable modules
list-object-references – list attributes that references 'object'
list-objects – list objects
list-persistent-images – show information about images with "persistent" data
list-preferences – list preferences
ll – list namespace objects
load-module – load module into Simics
load-persistent-state – load persistent state
module-list-refresh – create a new list of loadable modules
print-blueprint-state – print blueprint state
print-sync-info – print synchronization configuration
read-configuration – load a saved configuration
record-session – save configuration including a recording
save-component-template – save a component configuration template
save-image-contents – save image to disk
save-image-diff – save changes since last checkpoint
save-persistent-state – save persistent simulator state
save-preferences – save preferences
set-min-latency – set the min latency of the sync domain
write-configuration – save configuration

3.1.5 Consoles

<graphcon>.input – send string to a console
<textcon>.capture-start – capture output to file
<textcon>.capture-stop – stop output capture to file
<textcon>.enable-cmd-line-output – enable output to Simics command line
<textcon>.hide – hide the console window
<textcon>.host-serial-setup – setup host serial connection
<textcon>.input – send input to a console
<textcon>.input-file – input a file into a console
<textcon>.record-start – start recording of output on the console
<textcon>.record-stop – stop recording of output on the console
<textcon>.save-to-file – save console screen to file
<textcon>.show – display the console window
<textcon>.telnet-setup – setup telnet connection
<textcon>.telnet-status – return telnet connection data

3.1.6 Debugging

<bank_instrumentation_subscribe>.bp-break-bank – set device access break
<bank_instrumentation_subscribe>.bp-trace-bank – enable tracing of device accesses
<bp-manager.bank>.break – set device access break
<bp-manager.bank>.trace – enable tracing of device accesses
<bp-manager.con-gfx>.break – set graphical breakpoint
<bp-manager.con-gfx>.trace – enable tracing of graphical matches
<bp-manager.con-string>.break – set string breakpoint
<bp-manager.con-string>.trace – enable tracing of string appearances
<bp-manager.con-string>.wait-then-write – wait for a string, then write an input string
<bp-manager.cr>.break – set break on control register access
<bp-manager.cr>.trace – enable tracing of control register accesses
<bp-manager.cycle>.break – set cycle breakpoint
<bp-manager.cycle>.trace – enable tracing of cycle points
<bp-manager.cycle_event>.break – set cycle event break
<bp-manager.cycle_event>.trace – enable tracing of cycle events
<bp-manager.eth_link>.break – break on Found src mac in network stream at the provided link
<bp-manager.eth_link>.trace – wait_for
<bp-manager.exc>.break – set break on exception
<bp-manager.exc>.trace – enable tracing of exceptions
<bp-manager.hap>.break – set hap breakpoint
<bp-manager.hap>.trace – enable tracing of hap triggers
<bp-manager.log>.break – set break on log output
<bp-manager.log>.trace – enable tracing of log messages
<bp-manager.magic>.break – set magic instruction break
<bp-manager.magic>.trace – enable tracing of magic instructions
<bp-manager.memory>.break – set break on memory access
<bp-manager.memory>.trace – enable tracing of memory accesses
<bp-manager.memory>.unbreak – remove breakpoint range
<bp-manager.msr>.break – set break on architectural MSR access
<bp-manager.msr>.trace – enable tracing of architectural MSR accesses
<bp-manager.notify>.break – set notifier breakpoint
<bp-manager.notify>.trace – enable tracing of notifier triggers
<bp-manager.os_awareness>.break – break on OS Awareness node changes
<bp-manager.os_awareness>.trace – trace OS Awareness node changes
<bp-manager.src-line>.break – add breakpoint at a source code line
<bp-manager.src-line>.trace – enable tracing of source code line reaches
<bp-manager.src-location>.break – add breakpoint at a location
<bp-manager.src-location>.trace – enable tracing of location reaches
<bp-manager.step>.break – set step breakpoint
<bp-manager.step>.trace – enable tracing of step points
<bp-manager.step_event>.break – set step event break
<bp-manager.step_event>.trace – enable tracing of step events
<bp-manager.time>.break – set time breakpoint
<bp-manager.time>.trace – enable tracing of time points
<bp_manager>.delete – delete a breakpoint
<bp_manager>.disable – disable breakpoint
<bp_manager>.enable – enable breakpoint
<bp_manager>.enabled – enable or disable breakpoint
<bp_manager>.ignore-count – set number of hits of breakpoint to ignore
<bp_manager>.list – list breakpoints
<bp_manager>.list-types – list breakpoint type providers
<bp_manager>.show – show details about a breakpoint
<bp_manager>.test-trigger – test trigger breakpoint
<bp_manager>.wait-for-breakpoint – wait for breakpoint
<break_strings_v2>.bp-break-console-string – set string breakpoint
<break_strings_v2>.bp-trace-console-string – enable tracing of string appearances
<breakpoint>.bp-break-memory – set break on memory access
<breakpoint>.bp-trace-memory – enable tracing of memory accesses
<context>.on – switch on context object
<cycle>.bp-break-cycle – set cycle breakpoint
<cycle>.bp-break-time – set time breakpoint
<cycle>.bp-trace-cycle – enable tracing of cycle points
<cycle>.bp-trace-time – enable tracing of time points
<cycle_event_instrumentation>.bp-break-cycle-event – set cycle event break
<cycle_event_instrumentation>.bp-trace-cycle-event – enable tracing of cycle events
<exception>.bp-break-exception – set break on exception
<exception>.bp-trace-exception – enable tracing of exceptions
<gdb-remote>.disconnect – disconnect from the remote gdb
<gdb-remote>.signal – tell remote gdb we got a signal
<gdb-remote>.target – set target CPU for gdb connection
<gfx_break>.bp-break-gfx – set graphical breakpoint
<gfx_break>.bp-trace-gfx – enable tracing of graphical matches
<hap-meter>.listen-for-exceptions – listen for exception haps
<hap-meter>.listen-for-hap – listen for a specified hap
<linux_mapper>.log-syscalls – start logging system calls
<linux_tracker_comp>.log-syscalls – start logging system calls
<memory_space>.debug – get debug object
<network_breakpoint>.bp-break-network – break on Found src mac in network stream at the provided link
<network_breakpoint>.bp-trace-network – wait_for
<os_awareness>.active-node – list the active nodes
<os_awareness>.find – find a node
<os_awareness>.list – list all processes/tasks
<os_awareness>.node-info – print all properties of a software node
<os_awareness>.node-tree – list software node tree
<osa_component>.bp-break – break on OS Awareness node changes
<osa_component>.bp-trace – trace OS Awareness node changes
<osa_parameters>.load-parameters – load tracker parameter settings
<processor_info>.debug – get debug object
<processor_internal>.bp-break-control-register – set break on control register access
<processor_internal>.bp-break-magic – set magic instruction break
<processor_internal>.bp-trace-control-register – enable tracing of control register accesses
<processor_internal>.bp-trace-magic – enable tracing of magic instructions
<state-assertion>.add – add an object to be asserted
<state-assertion>.add-mem-lis – add a memory listener on the specified memory space
<state-assertion>.fforward – fast-forward a state assertion file when comparing
<state-assertion>.start – start trace asserting/comparing
<state-assertion>.stop – stop trace asserting/comparing and close the file
<step>.bp-break-step – set step breakpoint
<step>.bp-trace-step – enable tracing of step points
<step_event_instrumentation>.bp-break-step-event – set step event break
<step_event_instrumentation>.bp-trace-step-event – enable tracing of step events
<symdebug>.bp-break-source-line – add breakpoint at a source code line
<symdebug>.bp-break-source-location – add breakpoint at a location
<symdebug>.bp-trace-source-line – enable tracing of source code line reaches
<symdebug>.bp-trace-source-location – enable tracing of location reaches
<symdebug>.down – go down N stack frames
<symdebug>.frame – change current stack frame
<symdebug>.list – list source and/or disassemble
<symdebug>.stack-trace – display stack trace
<symdebug>.step-into – run to the next source line
<symdebug>.step-into-instruction – run to the next instruction
<symdebug>.step-out – finish the current function
<symdebug>.step-over – run to the next source line, skipping subroutine calls
<symdebug>.step-over-instruction – run to the next instruction, skipping subroutine calls
<symdebug>.sym-address – return the address of expression or source line
<symdebug>.sym-file – return source file for function or address
<symdebug>.sym-function – return function at a given address
<symdebug>.sym-line – return source line for function or address
<symdebug>.sym-list – list symbols
<symdebug>.sym-source – print source location for function or address
<symdebug>.sym-string – evaluate symbolic expression
<symdebug>.sym-type – return the type of a symbolic expression
<symdebug>.sym-value – evaluate symbolic expression
<symdebug>.sym-write – write value to variable
<symdebug>.up – go up N stack frames
<x86_msr>.bp-break-msr – set break on architectural MSR access
<x86_msr>.bp-trace-msr – enable tracing of architectural MSR accesses
add-pathmap-entry – add a path map entry
add-symbol-file – add symbol file to debugging contexts
clear-memorymap – clear all memory map entries
clear-pathmap – clear all path map entries
context-query-for-object – create a context query for a Simics object
context-query-for-object-list – create a context query for a list of objects
debug-context – return the current debug object
disable-debugger – get debug object
down – go down N stack frames
enable-debugger – enable command line debugger
frame – change current stack frame
list – list source and/or disassemble
list-debug-contexts – list debug contexts
list-sections – lists the relocatable sections of a symbol file
list-segments – lists the segments of a symbol file
new-attr-meter – create an attribute meter
new-context – create a new context
new-gdb-remote – create a gdb session
new-hap-meter – create a new hap meter
new-mem-traffic-meter – create a memory traffic meter
new-tcf-agent – create a tcf agent
print-event-queue – print event queue for processor
print-realtime-queue – list all callbacks in the realtime event queue
remove-symbol-file – remove symbol file from debugging contexts
set-context – set the current context of a CPU
show-memorymap – show the current memory map
show-pathmap – show the current path map
stack-trace – display stack trace
start-eclipse-backend – start accepting connections from Eclipse
state-assertion-connect – connect to a state-assertion receiver
state-assertion-create-file – record a state assertion file
state-assertion-open-file – open a state assertion file for comparing
state-assertion-receive – wait for a connection from a state assertion sender
state-assertion-simple-assert – assert the file
state-assertion-simple-record – record the state of an object every x steps
step-into – run to the next source line
step-out – finish the current function
step-over – run to the next source line, skipping subroutine calls
step-over-instruction – run to the next instruction, skipping subroutine calls
sym-address – return the address of expression or source line
sym-file – return source file for function or address
sym-function – return function at a given address
sym-line – return source line for function or address
sym-list – list symbols
sym-source – print source location for function or address
sym-string – evaluate symbolic expression
sym-type – return the type of a symbolic expression
sym-value – evaluate symbolic expression
sym-write – write value to variable
up – go up N stack frames

3.1.7 Disks

<cdrom_image>.delete – delete an unused cdrom-image object
<ide-cdrom>.eject – eject media from CD-ROM drive
<ide-cdrom>.insert – insert media in CD-ROM drive
<ide-disk>.add-diff-file – add a diff file to the image
<ide-disk>.add-partial-diff-file – add a partial diff file to the image
<ide-disk>.default-translation – get or set the default CHS translation
<ide-disk>.print-partition-table – print the partition table
<ide-disk>.save-diff-file – save diff file to disk
<ide-disk>.save-mbr-partition – save an MBR partition to a file
<image>.add-diff-file – add a diff file to the image
<image>.add-partial-diff-file – add a partial diff file to the image
<image>.clear-files – clear the list of files for an image
<image>.list-files – list files representing the contents of an image
<image>.save – save image to disk
<image>.save-diff-file – save changes since last checkpoint
<simple-scsi-disk>.add-diff-file – add a diff file to the image
<simple-scsi-disk>.add-partial-diff-file – add a partial diff file to the image
<simple-scsi-disk>.print-partition-table – print the partition table
<simple-scsi-disk>.save-diff-file – save diff file to disk
<simple-scsi-disk>.save-mbr-partition – save an MBR partition to a file
create-ide-cdrom-comp – create a non-instantiated ide_cdrom_comp
create-ide-disk-comp – create a non-instantiated ide_disk_comp
create-sata-cdrom-comp – create a non-instantiated sata_cdrom_comp
create-sata-disk-comp – create a non-instantiated sata_disk_comp
create-virtio-mmio-blk-comp – create a non-instantiated virtio_mmio_blk_comp
enable-writable-persistent-state – create/load a R/W persistent state
load-persistent-state – load persistent state
new-cdrom-image – create new cdrom-image object
new-ide-cdrom-comp – create an instantiated ide_cdrom_comp
new-ide-disk-comp – create an instantiated ide_disk_comp
new-sata-cdrom-comp – create an instantiated sata_cdrom_comp
new-sata-disk-comp – create an instantiated sata_disk_comp
new-virtio-mmio-blk-comp – create an instantiated virtio_mmio_blk_comp
save-image-contents – save image to disk
save-image-diff – save changes since last checkpoint
save-persistent-state – save persistent simulator state

3.1.8 Execution

<cell>.set-time-quantum – get/set the time quantum for a given cell
<cycle>.print-time – print number of steps and cycles executed
<instruction_fetch>.instruction-fetch-mode – set or get current mode for instruction fetching
<realtime>.disable – disable real-time behavior
<realtime>.enable – enable real-time behavior
<step_cycle_ratio>.set-step-rate – set steps per cycle rate
clear-object-lock-stats – clear object lock statistics
disable-multicore-accelerator – disable mca
disable-multithreading – disable multithreading
disable-object-lock-stats – disable object lock statistics collection
disable-page-sharing – disable page-sharing
disassemble-settings – change disassembly output settings
enable-multicore-accelerator – enable multicore-accelerator
enable-multithreading – enable multithreaded simulation
enable-object-lock-stats – enable object lock statistics collection
enable-page-sharing – enable page-sharing
enable-real-time-mode – enable real-time behavior
enable-subsystem-threading – enable cell threading
force-step-instruction – step instructions while other processors stall
istc-enable – enable or disable internal caches
list-thread-domains – list cells and thread domains in them
multicore-accelerator-status – print multicore accelerator status
penable – switch processor on
print-object-lock-stats – print object lock statistics
print-time – print number of steps and cycles executed
run – start execution
run-cycles – start execution
run-seconds – execute for seconds
set-max-time-span – set threading mode
set-pc – set the current processor's program counter
set-thread-limit – limit the number of simulation threads
set-threading-mode – set threading mode
set-time-quantum – set time quantum
step-cycle – step one or more cycles
step-instruction – step one or more instructions
stop – interrupt simulation

3.1.9 Files

<service-node>.set-tftp-directory – set TFTP directory
<service_node_comp>.set-ftp-directory – set FTP root directory
<service_node_comp>.set-tftp-directory – set TFTP directory
<simicsfs_server>.add-client-group – add client group
<simicsfs_server>.add-path-rule – add path rule
<simicsfs_server>.check-path-rules – check path rules
<simicsfs_server>.list-client-groups – list client groups
<simicsfs_server>.list-clients – list SimicsFS clients
<simicsfs_server>.list-path-rules – list path rules
<simicsfs_server>.remove-client-group – remove client group
<simicsfs_server>.remove-path-rule – remove path rule
add-directory – add a directory to the Simics search path
add-module-directory – add a directory to the module search path
cd – change working directory
clear-directories – clear the Simics search path
dirs – display directory stack
file-exists – check if a file exists in the search path
list-checkpoints – list checkpoints
list-directories – list directories in Simics search path
list-presets – list available presets
list-simics-search-paths – return %simics% search paths
list-targets – list available targets
load-target – load a target system
lookup-file – lookup a filename
ls – list files
native-path – convert a filename to host native form
popd – pop directory from directory stack
pushd – push directory on directory stack
pwd – print working directory
run-script – run a script file
start-command-line-capture – send output to file
start-simicsfs-server – create and connect the SimicsFS server
stop-command-line-capture – stop sending output to file

3.1.10 Graphics

<accel-vga>.redraw – redraw display
<accel-vga>.refresh-rate – set refresh rate for the display
<accel-vga>.text-dump – print text contents of display
<accel_vga_v2>.redraw – redraw display
<accel_vga_v2>.refresh-rate – set refresh rate for the display
<accel_vga_v2>.text-dump – print text contents of display
<graphcon>.capture-start – capture output to file
<graphcon>.capture-stop – stop output capture to file
<graphcon>.dimming – get/set dimming status
<graphcon>.get-pixel – read pixel value
<graphcon>.gfx-break-info – return information about a graphical breakpoint
<graphcon>.gfx-break-match – determine if graphical breakpoint currently matches
<graphcon>.gfx-break-png – export graphical breakpoint data to a PNG file
<graphcon>.grab-setup – set grab button and modifier
<graphcon>.hide – hide the console window
<graphcon>.input – send string to a console
<graphcon>.input-file – input a file into a console
<graphcon>.save-break-xy – specify and save a graphical breakpoint
<graphcon>.screenshot – save screen as PNG or BMP
<graphcon>.set-pixel – write pixel value
<graphcon>.show – display the console window
<graphcon>.vnc-setup – setup VNC connection
<graphcon>.vnc-status – return VNC connection data
<graphcon>.wait-for-pixel-value – real pixel value
<vga>.redraw – redraw display
<vga>.refresh-rate – set refresh rate for the display
<vga>.text-dump – print text contents of display
<vga_pci>.redraw – redraw display
<vga_pci>.refresh-rate – set refresh rate for the display
<vga_pci>.text-dump – print text contents of display
create-pci-accel-vga-comp – create a non-instantiated pci_accel_vga_comp
create-pci-accel-vga-v2-comp – create a non-instantiated pci_accel_vga_v2_comp
create-pci-vga-comp – create a non-instantiated pci_vga_comp
new-pci-accel-vga-comp – create an instantiated pci_accel_vga_comp
new-pci-accel-vga-v2-comp – create an instantiated pci_accel_vga_v2_comp
new-pci-vga-comp – create an instantiated pci_vga_comp

3.1.11 Help

api-help – get API help
api-search – search API help
copyright – print full Simics copyright information
get-command-args – get list of command arguments
help – help command
help-search – search for text in documentation
license – print Simics license
list-attributes – list all attributes
list-commands – list CLI commands
list-target-info – lists target information
print-target-info – prints target information
release-notes – display product release notes
system-info – system info
version – display Simics version

3.1.12 Image

<cdrom_image>.delete – delete an unused cdrom-image object
<image>.add-diff-file – add a diff file to the image
<image>.add-partial-diff-file – add a partial diff file to the image
<image>.clear-files – clear the list of files for an image
<image>.get – get bytes from image
<image>.list-files – list files representing the contents of an image
<image>.load-vmem – load Verilog VMEM file into memory
<image>.save – save image to disk
<image>.save-diff-file – save changes since last checkpoint
<image>.save-vmem – save VMEM file of memory
<image>.set – set bytes in image to specified value
enable-writable-persistent-state – create/load a R/W persistent state
new-cdrom-image – create new cdrom-image object
save-image-contents – save image to disk
save-image-diff – save changes since last checkpoint
set-image-memory-limit – limit image memory usage

3.1.13 Inspection

% – read register by name, module or string formatting
<memory-space>.map – print memory map
<pcie_function_info>.pcie-dma-read – memory PCIe DMA Read
<pcie_function_info>.pcie-dma-write – memory PCIe (DMA) Write
<port-space>.map – print port map
<transaction_translator>.memory-map – print physical memory map
<translator>.memory-map – print physical memory map
devs – list all mapped devices in Simics
disassemble – disassemble instructions
get – get value of physical address
get-device-offset – read from an offset in a device bank
get-device-reg – read from a register in a device bank
list-device-regs – find registers by name
list-pcie-hierarchies – list PCIe hierarchies in the system
list-thread-domains – list cells and thread domains in them
logical-to-physical – translate logical address to physical
memory-map – print physical memory map
pcie-config-probe – probe PCIe hierarchy with a BDF
pcie-config-read – configuration Read PCIe
pcie-config-write – configuration Write PCIe
print-device-reg-info – print detailed information of device registers
print-device-regs – list registers in a bank
print-event-queue – print event queue for processor
print-processor-registers – print cpu registers
print-realtime-queue – list all callbacks in the realtime event queue
probe-address – find destination for an address
processor-status – show processors' status
read-reg – read a register
set-device-offset – write at an offset in a device bank
set-device-reg – write to a register in a device bank
x – examine raw memory contents

3.1.14 Instrumentation

<bank_coverage_tool>.access-count – print bank access count
<bank_coverage_tool>.add-filter – add filter to the tool
<bank_coverage_tool>.add-instrumentation – add instrumentation
<bank_coverage_tool>.connect-all – connect to the banks of all devices
<bank_coverage_tool>.coverage – print bank coverages
<bank_coverage_tool>.delete – deletes instrumentation tool
<bank_coverage_tool>.disable-instrumentation – disable instrumentation
<bank_coverage_tool>.enable-instrumentation – enable instrumentation
<bank_coverage_tool>.info – print information about the object
<bank_coverage_tool>.list-providers – list-provider objects
<bank_coverage_tool>.load – load instrumented bank coverage from file
<bank_coverage_tool>.remove-filter – remove filter from the tool
<bank_coverage_tool>.remove-instrumentation – remove instrumentation
<bank_coverage_tool>.save – save instrumented bank coverage to file
<bank_coverage_tool>.status – print status of the object
<bank_patch_tool>.add-filter – add filter to the tool
<bank_patch_tool>.add-instrumentation – add instrumentation
<bank_patch_tool>.delete – deletes instrumentation tool
<bank_patch_tool>.disable-instrumentation – disable instrumentation
<bank_patch_tool>.enable-instrumentation – enable instrumentation
<bank_patch_tool>.info – print information about the object
<bank_patch_tool>.list-providers – list-provider objects
<bank_patch_tool>.remove-filter – remove filter from the tool
<bank_patch_tool>.remove-instrumentation – remove instrumentation
<bank_patch_tool>.status – print status of the object
<cpu_mode_filter>.add-mode – filter on specific modes
<cpu_mode_filter>.delete – remove the filter
<cpu_mode_filter>.remove-mode – stop filtering on a mode
<event_histogram>.add-filter – add filter to the tool
<event_histogram>.add-instrumentation – add instrumentation
<event_histogram>.clear – clear instruction sizes frequencies
<event_histogram>.delete – deletes instrumentation tool
<event_histogram>.histogram – print taken exceptions with frequencies
<event_histogram>.list-providers – list-provider objects
<event_histogram>.remove-filter – remove filter from the tool
<event_histogram>.remove-instrumentation – remove instrumentation
<exception_histogram>.add-filter – add filter to the tool
<exception_histogram>.add-instrumentation – add instrumentation
<exception_histogram>.clear – clear instruction sizes frequencies
<exception_histogram>.delete – deletes instrumentation tool
<exception_histogram>.disable-instrumentation – disable instrumentation
<exception_histogram>.enable-instrumentation – enable instrumentation
<exception_histogram>.histogram – print taken exceptions with frequencies
<exception_histogram>.info – print information about the object
<exception_histogram>.list-providers – list-provider objects
<exception_histogram>.remove-filter – remove filter from the tool
<exception_histogram>.remove-instrumentation – remove instrumentation
<exception_histogram>.status – print status of the object
<instruction_count>.add-filter – add filter to the tool
<instruction_count>.add-instrumentation – add instrumentation
<instruction_count>.clear – clear instruction counts
<instruction_count>.delete – deletes instrumentation tool
<instruction_count>.disable-instrumentation – disable instrumentation
<instruction_count>.enable-instrumentation – enable instrumentation
<instruction_count>.info – print information about the object
<instruction_count>.list-providers – list-provider objects
<instruction_count>.remove-filter – remove filter from the tool
<instruction_count>.remove-instrumentation – remove instrumentation
<instruction_count>.status – print status of the object
<instruction_histogram>.add-filter – add filter to the tool
<instruction_histogram>.add-instrumentation – add instrumentation
<instruction_histogram>.clear – remove old data
<instruction_histogram>.delete – deletes instrumentation tool
<instruction_histogram>.disable-instrumentation – disable instrumentation
<instruction_histogram>.enable-instrumentation – enable instrumentation
<instruction_histogram>.histogram – print instruction histogram
<instruction_histogram>.info – print information about the object
<instruction_histogram>.list-providers – list-provider objects
<instruction_histogram>.remove-filter – remove filter from the tool
<instruction_histogram>.remove-instrumentation – remove instrumentation
<instruction_histogram>.status – print status of the object
<interface_histogram_tool>.add-filter – add filter to the tool
<interface_histogram_tool>.delete – deletes instrumentation tool
<interface_histogram_tool>.disable-instrumentation – disable instrumentation
<interface_histogram_tool>.enable-instrumentation – enable instrumentation
<interface_histogram_tool>.info – print information about the object
<interface_histogram_tool>.list-providers – list-provider objects
<interface_histogram_tool>.remove-filter – remove filter from the tool
<interface_histogram_tool>.remove-instrumentation – remove instrumentation
<interface_histogram_tool>.status – print status of the object
<interface_log_tool>.add-filter – add filter to the tool
<interface_log_tool>.delete – deletes instrumentation tool
<interface_log_tool>.disable-instrumentation – disable instrumentation
<interface_log_tool>.enable-instrumentation – enable instrumentation
<interface_log_tool>.info – print information about the object
<interface_log_tool>.list-providers – list-provider objects
<interface_log_tool>.remove-filter – remove filter from the tool
<interface_log_tool>.remove-instrumentation – remove instrumentation
<interface_log_tool>.status – print status of the object
<memory_profiler>.add-filter – add filter to the tool
<memory_profiler>.add-instrumentation – add instrumentation
<memory_profiler>.delete – deletes instrumentation tool
<memory_profiler>.disable-instrumentation – disable instrumentation
<memory_profiler>.enable-instrumentation – enable instrumentation
<memory_profiler>.info – print information about the object
<memory_profiler>.list-providers – list-provider objects
<memory_profiler>.profile – print memory profile
<memory_profiler>.remove-filter – remove filter from the tool
<memory_profiler>.remove-instrumentation – remove instrumentation
<memory_profiler>.status – print status of the object
<process_filter>.add-pattern – filter on a specific node path pattern
<process_filter>.delete – remove the filter
<process_filter>.remove-pattern – stop filtering on a process
<process_histogram>.add-filter – add filter to the tool
<process_histogram>.add-instrumentation – add instrumentation
<process_histogram>.clear – clear process histogram
<process_histogram>.delete – deletes instrumentation tool
<process_histogram>.histogram – print histogram of executed processes
<process_histogram>.list-providers – list-provider objects
<process_histogram>.process-info – print detailed info on a process
<process_histogram>.remove-filter – remove filter from the tool
<process_histogram>.remove-instrumentation – remove instrumentation
<ram_tracer>.add-filter – add filter to the tool
<ram_tracer>.add-instrumentation – add instrumentation
<ram_tracer>.delete – deletes instrumentation tool
<ram_tracer>.disable-instrumentation – disable instrumentation
<ram_tracer>.enable-instrumentation – enable instrumentation
<ram_tracer>.info – print information about the object
<ram_tracer>.list-providers – list-provider objects
<ram_tracer>.remove-filter – remove filter from the tool
<ram_tracer>.remove-instrumentation – remove instrumentation
<ram_tracer>.status – print status of the object
<simple_cache_tool>.add-filter – add filter to the tool
<simple_cache_tool>.add-instrumentation – add instrumentation
<simple_cache_tool>.delete – deletes instrumentation tool
<simple_cache_tool>.disable-instrumentation – disable instrumentation
<simple_cache_tool>.enable-instrumentation – enable instrumentation
<simple_cache_tool>.info – print information about the object
<simple_cache_tool>.list-providers – list-provider objects
<simple_cache_tool>.remove-filter – remove filter from the tool
<simple_cache_tool>.remove-instrumentation – remove instrumentation
<simple_cache_tool>.status – print status of the object
<sr_histogram>.add-filter – add filter to the tool
<sr_histogram>.add-instrumentation – add instrumentation
<sr_histogram>.delete – deletes instrumentation tool
<sr_histogram>.disable-instrumentation – disable instrumentation
<sr_histogram>.enable-instrumentation – enable instrumentation
<sr_histogram>.info – print information about the object
<sr_histogram>.list-providers – list-provider objects
<sr_histogram>.remove-filter – remove filter from the tool
<sr_histogram>.remove-instrumentation – remove instrumentation
<sr_histogram>.status – print status of the object
<sr_ticks>.add-filter – add filter to the tool
<sr_ticks>.add-instrumentation – add instrumentation
<sr_ticks>.delete – deletes instrumentation tool
<sr_ticks>.disable-instrumentation – disable instrumentation
<sr_ticks>.enable-instrumentation – enable instrumentation
<sr_ticks>.info – print information about the object
<sr_ticks>.list-providers – list-provider objects
<sr_ticks>.remove-filter – remove filter from the tool
<sr_ticks>.remove-instrumentation – remove instrumentation
<sr_ticks>.status – print status of the object
<tracer_tool>.add-filter – add filter to the tool
<tracer_tool>.add-instrumentation – add instrumentation
<tracer_tool>.delete – deletes instrumentation tool
<tracer_tool>.disable-instrumentation – disable instrumentation
<tracer_tool>.enable-instrumentation – enable instrumentation
<tracer_tool>.info – print information about the object
<tracer_tool>.list-providers – list-provider objects
<tracer_tool>.remove-filter – remove filter from the tool
<tracer_tool>.remove-instrumentation – remove instrumentation
<tracer_tool>.status – print status of the object
<x86_branch_profiler>.add-filter – add filter to the tool
<x86_branch_profiler>.add-instrumentation – add instrumentation
<x86_branch_profiler>.delete – deletes instrumentation tool
<x86_branch_profiler>.disable-instrumentation – disable instrumentation
<x86_branch_profiler>.enable-instrumentation – enable instrumentation
<x86_branch_profiler>.info – print information about the object
<x86_branch_profiler>.list-providers – list-provider objects
<x86_branch_profiler>.remove-filter – remove filter from the tool
<x86_branch_profiler>.remove-instrumentation – remove instrumentation
<x86_branch_profiler>.status – print status of the object
<x86_mode_filter>.add-mode – add a mode to the filter
<x86_mode_filter>.delete – add a mode to the filter
<x86_mode_filter>.remove-mode – remove a mode from the filter
<x86_mode_histogram>.add-filter – add filter to the tool
<x86_mode_histogram>.add-instrumentation – add instrumentation
<x86_mode_histogram>.delete – deletes instrumentation tool
<x86_mode_histogram>.disable-instrumentation – disable instrumentation
<x86_mode_histogram>.enable-instrumentation – enable instrumentation
<x86_mode_histogram>.histogram – print x86 mode histogram
<x86_mode_histogram>.info – print information about the object
<x86_mode_histogram>.list-providers – list-provider objects
<x86_mode_histogram>.remove-filter – remove filter from the tool
<x86_mode_histogram>.remove-instrumentation – remove instrumentation
<x86_mode_histogram>.status – print status of the object
add-instrumentation-filter – add filter to connections
add-instrumentation-group – add new instrumentation group
disable-instrumentation – disable instrumentation
enable-instrumentation – enable instrumentation
instrumentation-move – reorder instrumentation connections
instrumentation-order – list instrumentation order for object
list-instrumentation – list established instrumentation connections
list-instrumentation-callbacks – list instrumentation callbacks
list-instrumentation-groups – list instrumentation groups
list-instrumentation-tools – list existing instrumentation tools
new-bank-coverage-tool – create a new bank_coverage_tool object
new-bank-patch-tool – create a new bank_patch_tool object
new-cpu-mode-filter – filter on certain modes (user/supervisor/hypervisor)
new-cycle-staller – create new cycle staller
new-event-histogram – create a new event_histogram object
new-exception-histogram – create a new exception_histogram object
new-instruction-count – create a new instruction_count object
new-instruction-histogram – create a new instruction_histogram object
new-memory-profiler – create a new memory_profiler object
new-process-filter – filter on certain processes
new-process-histogram – create a new process_histogram object
new-ram-tracer – create a new ram_tracer object
new-simple-cache-tool – create a new simple_cache_tool object
new-sr-histogram – create a new sr_histogram object
new-sr-ticks – create a new sr_ticks object
new-tracer-tool – create a new tracer_tool object
new-x86-branch-profiler – create a new x86_branch_profiler object
new-x86-mode-filter – filter on different execution modes
new-x86-mode-histogram – create a new x86_mode_histogram object
remove-instrumentation – remove instrumentation
remove-instrumentation-filter – remove instrumentation filter
remove-instrumentation-group – remove an instrumentation group

3.1.15 Links

<ethernet_cable>.get-free-connector – return the name of an unused connector
<ethernet_cable>.set-goal-latency – set the link's goal latency in seconds
<ethernet_hub>.get-free-connector – return the name of an unused connector
<ethernet_hub>.set-goal-latency – set the link's goal latency in seconds
<ethernet_switch>.get-free-connector – return the name of an unused connector
<ethernet_switch>.set-goal-latency – set the link's goal latency in seconds
<ethernet_vlan_switch>.get-free-connector – return the name of an unused access connector
<ethernet_vlan_switch>.get-free-trunk-connector – return the name of an unused trunk connector
<ethernet_vlan_switch>.set-goal-latency – set the link's goal latency in seconds
<ieee_802_15_4_link>.get-free-connector – return the name of an unused connector
create-ser-link – create a non-instantiated ser_link
new-ser-link – create an instantiated ser_link

3.1.16 Logging

log – print log entries for all objects
log-filter – suppress log messages for the object
log-group – enable/disable a log group
log-level – set or get the log level
log-setup – configure log behavior
log-size – set log buffer size
log-type – set or get the current log types

3.1.17 Matic

<agent_handle>.agent-poll-interval – set the agent's polling interval
<agent_handle>.agent-quit – quit the agent for this handle
<agent_handle>.agent-restart – restart the Simics target agent
<agent_handle>.change-directory – change this handle's working directory
<agent_handle>.delete-handle – delete this agent handle
<agent_handle>.discard-jobs – discard jobs from this agent handle
<agent_handle>.download – download file from system to host
<agent_handle>.download-dir – download directory from target to host
<agent_handle>.get-captured-output – get or print the captured job output
<agent_handle>.list-files – list target directory contents
<agent_handle>.list-jobs – list commands posted on this handle
<agent_handle>.print-file – print file contents on Simics CLI
<agent_handle>.print-working-directory – print this handle's working directory
<agent_handle>.run – execute a command on the target system
<agent_handle>.run-until-job – run simulation until job completed
<agent_handle>.target-time – set or get target system date and time
<agent_handle>.upload – upload file from host to target
<agent_handle>.upload-dir – upload directory from host to target
<agent_handle>.wait-for-job – suspend script branch until job completed
<agent_manager>.connect-to-agent – create a handle for a Simics Agent
<agent_manager>.disable – disable the manager and delete handles
<agent_manager>.enable – enable the agent_manager
<agent_manager>.list-agents – list all known Simics Agents
<hostfs>.root – get or set the hostfs root directory
start-agent-manager – create and enable a Matic agent manager
start-magic-pipe – create and enable a Magic communication pipe
start-pipe-manager – create and enable the Magic pipe manager

3.1.18 Memory

<memory-space>.add-map – map device in a memory-space
<memory-space>.check-overlaps – check memory space overlaps
<memory-space>.del-map – remove device map from a memory-space
<memory-space>.map – print memory map
<memory_profiler>.add-memory-profiler – add a memory profiler to the processor
<memory_profiler>.list-memory-profilers – list memory profilers connected to the processor
<memory_profiler>.remove-memory-profiler – remove a memory profiler from the processor
<memory_space>.load-vmem – load Verilog VMEM file into memory
<memory_space>.save-vmem – save VMEM file of memory
<pcie-downstream-port-legacy.cfg>.map – print memory map
<pcie-downstream-port-legacy.io>.map – print memory map
<pcie-downstream-port-legacy.mem>.map – print memory map
<pcie-downstream-port-legacy.msg>.map – print memory map
<pcie-downstream-port.cfg>.map – print memory map
<pcie-downstream-port.io>.map – print memory map
<pcie-downstream-port.mem>.map – print memory map
<pcie-downstream-port.msg>.map – print memory map
<pcie_function_info>.pcie-dma-read – memory PCIe DMA Read
<pcie_function_info>.pcie-dma-write – memory PCIe (DMA) Write
<port-space>.add-map – map device in a port-space
<port-space>.del-map – remove device map from a port-space
<port-space>.map – print port map
<transaction>.wait-for-get – issue an inquiry read transaction and wait for it to complete
<transaction>.wait-for-read – issue a read transaction and wait for it to complete
<transaction>.wait-for-set – issue an inquiry write transaction and wait for it to complete
<transaction>.wait-for-write – issue a write transaction and wait for it to complete
<transaction_translator>.memory-map – print physical memory map
<translator>.memory-map – print physical memory map
disassemble – disassemble instructions
disassemble-settings – change disassembly output settings
enable-writable-persistent-state – create/load a R/W persistent state
get – get value of physical address
load-binary – load binary (executable) file into memory
load-file – load file into memory
load-intel-hex – load Intel HEX file into memory
load-intel-obj – load Intel .obj or .32.obj file into memory
logical-to-physical – translate logical address to physical
memory-map – print physical memory map
pcie-config-probe – probe PCIe hierarchy with a BDF
pcie-config-read – configuration Read PCIe
pcie-config-write – configuration Write PCIe
print-image-memory-stats – image memory usage statistics
probe-address – find destination for an address
save-file – save memory contents to a binary file
save-intel-hex – save memory contents to an Intel HEX file
save-intel-obj – save memory contents to an Intel .obj file
set – set physical address to specified value
wait-for-get – issue an inquiry read transaction and wait for it to complete
wait-for-read – issue a read transaction and wait for it to complete
wait-for-set – issue an inquiry write transaction and wait for it to complete
wait-for-write – issue a write transaction and wait for it to complete
x – examine raw memory contents

3.1.19 Modules

add-module-directory – add a directory to the module search path
list-failed-modules – list the modules that are not loadable
list-modules – list loadable modules
list-packages – list package info in search path order
list-prioritized-packages – list packages marked as prioritized
list-simics-search-paths – return %simics% search paths
load-module – load module into Simics
module-list-refresh – create a new list of loadable modules
set-prioritized-package – mark package as prioritized

3.1.20 Networking

<etg>.packet-rate – set or display the packets per second rate
<etg>.packet-size – set or display the packet size
<etg>.set-bandwidth-limit – set or display the bandwidth limit in bits per second
<etg>.start – start generating traffic
<etg>.stop – stop generating traffic
<eth-probe>.delete – delete the probe
<eth-probe>.pcap-dump – dump Ethernet traffic to a pcap file
<eth-probe>.pcap-dump-stop – stop the current dump
<eth-probe>.tcpdump – run the tcpdump program
<eth-probe>.wireshark – run the wireshark/ethereal program
<ethernet_cable>.get-free-connector – return the name of an unused connector
<ethernet_cable>.pcap-dump – dump Ethernet traffic to a pcap file
<ethernet_cable>.pcap-dump-stop – stop the current dump
<ethernet_cable>.set-goal-latency – set the link's goal latency in seconds
<ethernet_cable>.tcpdump – run the tcpdump program
<ethernet_cable>.wireshark – run the wireshark/ethereal program
<ethernet_hub>.get-free-connector – return the name of an unused connector
<ethernet_hub>.pcap-dump – dump Ethernet traffic to a pcap file
<ethernet_hub>.pcap-dump-stop – stop the current dump
<ethernet_hub>.set-goal-latency – set the link's goal latency in seconds
<ethernet_hub>.tcpdump – run the tcpdump program
<ethernet_hub>.wireshark – run the wireshark/ethereal program
<ethernet_switch>.get-free-connector – return the name of an unused connector
<ethernet_switch>.pcap-dump – dump Ethernet traffic to a pcap file
<ethernet_switch>.pcap-dump-stop – stop the current dump
<ethernet_switch>.set-goal-latency – set the link's goal latency in seconds
<ethernet_switch>.tcpdump – run the tcpdump program
<ethernet_switch>.wireshark – run the wireshark/ethereal program
<ethernet_vlan_switch>.add-vlan – add a VLAN definition and corresponding connectors
<ethernet_vlan_switch>.get-free-connector – return the name of an unused access connector
<ethernet_vlan_switch>.get-free-trunk-connector – return the name of an unused trunk connector
<ethernet_vlan_switch>.pcap-dump – dump Ethernet traffic to a pcap file
<ethernet_vlan_switch>.pcap-dump-stop – stop the current dump
<ethernet_vlan_switch>.set-goal-latency – set the link's goal latency in seconds
<ethernet_vlan_switch>.tcpdump – run the tcpdump program
<ethernet_vlan_switch>.wireshark – run the wireshark/ethereal program
<ieee_802_15_4_probe>.pcap-dump – dump network traffic to a file
<ieee_802_15_4_probe>.pcap-dump-stop – stop the current dump
<ieee_802_15_4_probe>.tcpdump – run the tcpdump program
<ieee_802_15_4_probe>.tcpdump-stop – stop the current tcpdump capture
<ieee_802_15_4_probe>.wireshark – run the wireshark/ethereal program
<ieee_802_15_4_probe>.wireshark-stop – stop the current wireshark capture
<real_network_bridge_comp>.disconnect-real-network – disconnect from the real network
<real_network_host_comp>.disconnect-real-network – disconnect from the real network
<service-node>.add-host – add host entry
<service-node>.arp – inspect and manipulate ARP table
<service-node>.delete-host – delete host entry
<service-node>.dhcp-add-pool – add DHCP pool
<service-node>.dhcp-leases – print DHCP leases
<service-node>.disable-real-dns – disable real DNS
<service-node>.disable-service – disable network service
<service-node>.enable-ftp-alg – enable FTP ALG
<service-node>.enable-real-dns – enable real DNS
<service-node>.enable-service – enable network service
<service-node>.get-ip-address-from-pool – pop an IP address from the DHCP pool
<service-node>.list-host-info – list host info database
<service-node>.route – show the routing table
<service-node>.set-tftp-directory – set TFTP directory
<service-node>.tcpip-info – show TCP/IP info
<service_node_comp>.add-host – add host entry
<service_node_comp>.arp – inspect and manipulate ARP table
<service_node_comp>.delete-host – delete host entry
<service_node_comp>.dhcp-add-pool – add DHCP pool
<service_node_comp>.dhcp-leases – print DHCP leases
<service_node_comp>.disable-real-dns – disable real DNS
<service_node_comp>.disable-service – disable network service
<service_node_comp>.enable-ftp-alg – enable FTP ALG
<service_node_comp>.enable-real-dns – enable real DNS
<service_node_comp>.enable-service – enable network service
<service_node_comp>.get-ip-address-from-pool – pop an IP address from the DHCP pool
<service_node_comp>.list-host-info – list host info database
<service_node_comp>.ntp-set-virtual-time – set time for NTP
<service_node_comp>.ntp-time – get timing mode
<service_node_comp>.ntp-virtual-time-mode – set virtual time as base time for NTP
<service_node_comp>.route – show the routing table
<service_node_comp>.route-add – add an entry to the routing table
<service_node_comp>.set-ftp-directory – set FTP root directory
<service_node_comp>.set-tftp-directory – set TFTP directory
<service_node_comp>.tcpip-info – show TCP/IP info
<signal_link>.get-free-receiver-connector – return the name of an unused receiver connector
<signal_link>.get-free-sender-connector – return the name of an unused sender connector
connect-real-network – connect a simulated machine to the real network
connect-real-network-bridge – connect bridge between real and simulated network
connect-real-network-host – connect real host to the simulated network
connect-real-network-napt – enable NAPT from simulated network
connect-real-network-port-in – setup port forwarding to a simulated machine
connect-real-network-port-out – setup port forwarding to real machine
create-cp3-quad100tx – create a non-instantiated cp3_quad100tx
create-etg-comp – create a non-instantiated etg_comp
create-eth-injector-comp – create a non-instantiated eth_injector_comp
create-ethernet-cable – create a non-instantiated ethernet_cable
create-ethernet-switch – create a non-instantiated ethernet_switch
create-ethernet-vlan-switch – create a non-instantiated ethernet_vlan_switch
create-i210-v2-comp – create a non-instantiated i210_v2_comp
create-pci-am79c973-comp – create a non-instantiated pci_am79c973_comp
create-pci-bcm5703c-comp – create a non-instantiated pci_bcm5703c_comp
create-pci-bcm5704c-comp – create a non-instantiated pci_bcm5704c_comp
create-pci-dec21041-comp – create a non-instantiated pci_dec21041_comp
create-pci-dec21140 – create a non-instantiated pci_dec21140
create-pci-dec21140a-comp – create a non-instantiated pci_dec21140a_comp
create-pci-dec21143-comp – create a non-instantiated pci_dec21143_comp
create-pci-i82543gc-comp – create a non-instantiated pci_i82543gc_comp
create-pci-i82546bg-comp – create a non-instantiated pci_i82546bg_comp
create-pci-i82559-comp – create a non-instantiated pci_i82559_comp
create-phy-comp – create a non-instantiated phy_comp
create-real-network-bridge-comp – create a non-instantiated real_network_bridge_comp
create-real-network-host-comp – create a non-instantiated real_network_host_comp
create-service-node-comp – create a non-instantiated service_node_comp
create-unconnected-ethernet-probe – create an unconnected probe
default-port-forward-target – set default port forwarding target
disconnect-real-network – disconnect from the real network
disconnect-real-network-port-in – remove port forwarding to a simulated machine
disconnect-real-network-port-out – remove port forwarding to real machine
get-auto-mac-address – get an unused MAC address
insert-ethernet-probe – insert Ethernet probe
list-port-forwarding-setup – view the port forwarding setup
new-cp3-quad100tx – create an instantiated cp3_quad100tx
new-etg-comp – create an instantiated etg_comp
new-eth-injector-comp – create an instantiated eth_injector_comp
new-ethernet-cable – create an instantiated ethernet_cable
new-ethernet-switch – create an instantiated ethernet_switch
new-ethernet-vlan-switch – create an instantiated ethernet_vlan_switch
new-i210-v2-comp – create an instantiated i210_v2_comp
new-pci-am79c973-comp – create an instantiated pci_am79c973_comp
new-pci-bcm5703c-comp – create an instantiated pci_bcm5703c_comp
new-pci-bcm5704c-comp – create an instantiated pci_bcm5704c_comp
new-pci-dec21041-comp – create an instantiated pci_dec21041_comp
new-pci-dec21140 – create an instantiated pci_dec21140
new-pci-dec21140a-comp – create an instantiated pci_dec21140a_comp
new-pci-dec21143-comp – create an instantiated pci_dec21143_comp
new-pci-i82543gc-comp – create an instantiated pci_i82543gc_comp
new-pci-i82546bg-comp – create an instantiated pci_i82546bg_comp
new-pci-i82559-comp – create an instantiated pci_i82559_comp
new-phy-comp – create an instantiated phy_comp
new-real-network-bridge-comp – create an instantiated real_network_bridge_comp
new-real-network-host-comp – create an instantiated real_network_host_comp
new-service-node-comp – create an instantiated service_node_comp
pcap-dump – dump Ethernet traffic to file
pcap-dump-stop – stop the current dump
tcpdump – run the tcpdump program
tcpdump-stop – stop the current tcpdump capture
wireshark – run the wireshark/ethereal program
wireshark-stop – stop the current wireshark capture

3.1.21 Notifiers

list-hap-callbacks – lists all hap callbacks
list-haps – lists all haps
list-notifier-subscribers – list added notifier subscribers
list-notifiers – list available notifiers

3.1.22 PCI

create-cp3-quad100tx – create a non-instantiated cp3_quad100tx
create-cpci-adapter – create a non-instantiated cpci_adapter
create-cpci-backplane – create a non-instantiated cpci_backplane
create-gertie – create a non-instantiated gertie
create-i210-v2-comp – create a non-instantiated i210_v2_comp
create-pci-accel-vga-comp – create a non-instantiated pci_accel_vga_comp
create-pci-accel-vga-v2-comp – create a non-instantiated pci_accel_vga_v2_comp
create-pci-am79c973-comp – create a non-instantiated pci_am79c973_comp
create-pci-bcm5703c-comp – create a non-instantiated pci_bcm5703c_comp
create-pci-bcm5704c-comp – create a non-instantiated pci_bcm5704c_comp
create-pci-dec21041-comp – create a non-instantiated pci_dec21041_comp
create-pci-dec21140 – create a non-instantiated pci_dec21140
create-pci-dec21140a-comp – create a non-instantiated pci_dec21140a_comp
create-pci-dec21143-comp – create a non-instantiated pci_dec21143_comp
create-pci-i21152-comp – create a non-instantiated pci_i21152_comp
create-pci-i82543gc-comp – create a non-instantiated pci_i82543gc_comp
create-pci-i82546bg-comp – create a non-instantiated pci_i82546bg_comp
create-pci-i82559-comp – create a non-instantiated pci_i82559_comp
create-pci-pd6729-comp – create a non-instantiated pci_pd6729_comp
create-pci-vga-comp – create a non-instantiated pci_vga_comp
create-sample-pci-card – create a non-instantiated sample_pci_card
new-cp3-quad100tx – create an instantiated cp3_quad100tx
new-cpci-adapter – create an instantiated cpci_adapter
new-cpci-backplane – create an instantiated cpci_backplane
new-gertie – create an instantiated gertie
new-i210-v2-comp – create an instantiated i210_v2_comp
new-pci-accel-vga-comp – create an instantiated pci_accel_vga_comp
new-pci-accel-vga-v2-comp – create an instantiated pci_accel_vga_v2_comp
new-pci-am79c973-comp – create an instantiated pci_am79c973_comp
new-pci-bcm5703c-comp – create an instantiated pci_bcm5703c_comp
new-pci-bcm5704c-comp – create an instantiated pci_bcm5704c_comp
new-pci-dec21041-comp – create an instantiated pci_dec21041_comp
new-pci-dec21140 – create an instantiated pci_dec21140
new-pci-dec21140a-comp – create an instantiated pci_dec21140a_comp
new-pci-dec21143-comp – create an instantiated pci_dec21143_comp
new-pci-i21152-comp – create an instantiated pci_i21152_comp
new-pci-i82543gc-comp – create an instantiated pci_i82543gc_comp
new-pci-i82546bg-comp – create an instantiated pci_i82546bg_comp
new-pci-i82559-comp – create an instantiated pci_i82559_comp
new-pci-pd6729-comp – create an instantiated pci_pd6729_comp
new-pci-vga-comp – create an instantiated pci_vga_comp
new-sample-pci-card – create an instantiated sample_pci_card

3.1.23 Parameters

<script-params>.assigned – return names of assigned parameters
<script-params>.describe – display parameter information
<script-params>.get – get parameter value
<script-params>.help – display script parameters
<script-params>.list – list parameter values
<script-params>.save – save parameter values
<script-params>.setdefault – set parameter value default
decl – declare parameter
list-presets – list available presets
list-targets – list available targets
load-target – load a target system
run-script – run a script file

3.1.24 Performance

<cell>.set-time-quantum – get/set the time quantum for a given cell
<hypersim-pattern-matcher>.delete-pattern – remove a pattern from the matcher
<mtprof>.cellstat – display cell profiling information
<mtprof>.disable – disable multithreaded simulation profiling
<mtprof>.enable – enable multithreaded simulation profiling
<mtprof>.modelstat – display ideal execution time on a sufficiently parallel host
<mtprof>.save-data – save profiling data to file
<realtime>.disable – disable real-time behavior
<realtime>.enable – enable real-time behavior
<step_cycle_ratio>.set-step-rate – set steps per cycle rate
<x86>.enable-vmp – enable VMP
<x86>.vmp – query VMP status
clear-io-stats – clear the device access stats
clear-object-lock-stats – clear object lock statistics
disable-mtprof – disable mtprof data collection
disable-multicore-accelerator – disable mca
disable-multithreading – disable multithreading
disable-object-lock-stats – disable object lock statistics collection
disable-page-sharing – disable page-sharing
disable-vmp – disable VMP for all x86 processors
disable-vmp-feature – disable VMP feature
enable-hypersim – enable hypersimulation
enable-mtprof – enable multithreaded simulation profiling
enable-multicore-accelerator – enable multicore-accelerator
enable-multithreading – enable multithreaded simulation
enable-object-lock-stats – enable object lock statistics collection
enable-page-sharing – enable page-sharing
enable-real-time-mode – enable real-time behavior
enable-subsystem-threading – enable cell threading
enable-vmp – enable VMP for all VMP-capable processors
enable-vmp-feature – enable VMP feature
hypersim-status – show hypersim status
istc-enable – enable or disable internal caches
list-hypersim-patterns – list available hypersim patterns
list-thread-domains – list cells and thread domains in them
multicore-accelerator-status – print multicore accelerator status
print-device-access-stats – list most frequently accessed devices
print-object-lock-stats – print object lock statistics
set-max-time-span – set threading mode
set-min-latency – set the min latency of the sync domain
set-thread-limit – limit the number of simulation threads
set-threading-mode – set threading mode
set-time-quantum – set time quantum
setup-x86-timing – set timing for all x86 processors
system-perfmeter – activate Simics performance monitoring
system-perfmeter-summary – prints system-perfmeter summary
vmp-feature-status – show VMP feature settings
vmp-version – print VMP version information

3.1.25 Probes

<eth-probe>.delete – delete the probe
<probe_monitor>.add-probe – add a probe to the monitor
<probe_monitor>.clear-history – clear the sample history of the probes
<probe_monitor>.delete – delete monitor
<probe_monitor>.export-json – save probe data in json format
<probe_monitor>.force-sample – manually trigger a sample
<probe_monitor>.html-report – produce an HTML report with graphs and performance data
<probe_monitor>.merge-json – save probe data in json format
<probe_monitor>.plot-graph – produce a plot of probes
<probe_monitor>.print-history – print sample history of the probes
<probe_monitor>.profile-probes – fake samples and do a python profile of the collection
<probe_monitor>.remove-probe – remove probe from monitor
<probe_monitor>.reset-session – reset the probes' session start values
<probe_monitor>.sampling-settings – set sampling settings
<probe_monitor>.start – start the monitor
<probe_monitor>.stop – stop the monitor
<probe_monitor>.summary – show total summary of probes
<probe_monitor>.table-settings – set the table settings
<probe_streamer>.add-probe – add a probe to the streamer
<probe_streamer>.delete – delete streamer
<probe_streamer>.force-sample – manually trigger a sample
<probe_streamer>.remove-probe – remove probe from streamer
<probe_streamer>.reset-session – reset the probes' session start values
<probe_streamer>.sampling-settings – set sampling settings
<probe_streamer>.start – start the streamer
<probe_streamer>.stop – stop the streamer
<probe_streamer>.summary – show total summary of probes
<probe_system_perfmeter>.add-probe – add a probe to the system-perfmeter
<probe_system_perfmeter>.clear-history – clear the sample history of the probes
<probe_system_perfmeter>.delete – delete system-perfmeter
<probe_system_perfmeter>.export-json – save probe data in json format
<probe_system_perfmeter>.force-sample – manually trigger a sample
<probe_system_perfmeter>.html-report – produce an HTML report with graphs and performance data
<probe_system_perfmeter>.merge-json – save probe data in json format
<probe_system_perfmeter>.plot-graph – produce a plot of probes
<probe_system_perfmeter>.print-history – print sample history of the probes
<probe_system_perfmeter>.profile-probes – fake samples and do a python profile of the collection
<probe_system_perfmeter>.remove-probe – remove probe from system-perfmeter
<probe_system_perfmeter>.reset-session – reset the probes' session start values
<probe_system_perfmeter>.sampling-settings – set sampling settings
<probe_system_perfmeter>.start – start the system-perfmeter
<probe_system_perfmeter>.stop – stop the system-perfmeter
<probe_system_perfmeter>.summary – show total summary of probes
<probe_system_perfmeter>.table-settings – set the table settings
<probes>.list-kinds – print table of probe-kinds
<probes>.new-aggregate-probe – create new aggregate probe
<probes>.new-attribute-probe – new attribute based probe
<probes>.new-fraction-object-probe – create object specific fraction probe
<probes>.new-fraction-probe – create probe fraction probe
<probes>.new-percent-probe – create new percent probe
<probes>.new-sum-probe – create new sum probe
<probes>.read – return probe value
<probes>.subscribe – subscribe to probes
<probes>.unsubscribe – unsubscribe to probes
create-unconnected-ethernet-probe – create an unconnected probe
enable-probes – enable probe framework
insert-ethernet-probe – insert Ethernet probe
insert-ieee-802-15-4-probe – insert IEEE 802.15.4 probe
new-probe-monitor – create new probe-monitor
new-probe-streamer – create new probe-streamer
new-system-perfmeter – create new system-perfmeter

3.1.26 Processors

<exception>.list-exceptions – list exceptions on a processor
<processor_info>.enabled – get enable status
disassemble – disassemble instructions
list-processors – list processors
list-processors-summary – prints a summary for processors
logical-to-physical – translate logical address to physical
penable – switch processor on
print-event-queue – print event queue for processor
print-processor-registers – print cpu registers
processor-status – show processors' status
set-pc – set the current processor's program counter

3.1.27 Profiling

<address_profiler>.address-profile-data – linear map of address profiling data
<address_profiler>.address-profile-info – general info about an address profiler
<address_profiler>.address-profile-toplist – print toplist of address profiling data
<branch_recorder>.clean – delete all branch arcs in the branch recorder
<branch_recorder>.print-branch-arcs – print branch arcs
<branch_recorder_handler>.attach-branch-recorder – attach a branch recorder to a processor
<branch_recorder_handler>.detach-branch-recorder – detach a branch recorder from a processor
<branch_recorder_handler>.start-instruction-profiling – get started with instruction profiling
<cycle>.print-time – print number of steps and cycles executed
<data_profiler>.clear – clear data profiler
<instruction_fetch>.instruction-fetch-mode – set or get current mode for instruction fetching
<memory_profiler>.add-memory-profiler – add a memory profiler to the processor
<memory_profiler>.list-memory-profilers – list memory profilers connected to the processor
<memory_profiler>.remove-memory-profiler – remove a memory profiler from the processor
<mtprof>.cellstat – display cell profiling information
<mtprof>.disable – disable multithreaded simulation profiling
<mtprof>.enable – enable multithreaded simulation profiling
<mtprof>.save-data – save profiling data to file
<vtune_measurement>.flamegraph – produce a flamegraph (.svg) file of the profile
<vtune_measurement>.launch-gui – start vtune-gui on collected data
<vtune_measurement>.module-profile – show module profile of run
<vtune_measurement>.profile – show profile of run
<vtune_measurement>.save-folded-stacks – fold stacks of the profile and write it to a file
<vtune_measurement>.start – start measurement
<vtune_measurement>.stop – stop measurement
<vtune_measurement>.summary – show VTune summary of the run
<vtune_measurement>.thread-groups – show available thread groups
<vtune_measurement>.thread-profile – show thread profile of run
<x86_branch_profiler>.histogram – print histogram of branches used
disable-mtprof – disable mtprof data collection
enable-mtprof – enable multithreaded simulation profiling
new-branch-recorder – create a new branch recorder
print-time – print number of steps and cycles executed

3.1.28 Python

@ – evaluate a Python statement
python – evaluate a Python expression
python-mode – switch command line to Python mode
reset-sys-path – reset Python sys.path

3.1.29 Recording

<arinc429_bus>.capture-start – start traffic recorder
<arinc429_bus>.capture-stop – stop traffic recorder
<arinc429_bus>.playback-start – start traffic generator
<arinc429_bus>.playback-stop – stop traffic generation
<recorder>.playback-start – play back recorded asynchronous input
<recorder>.playback-stop – stop playback
<recorder>.recorder-start – record asynchronous input to file
<recorder>.recorder-stop – stop recorder
<textcon>.record-start – start recording of output on the console
<textcon>.record-stop – stop recording of output on the console
add-session-comment – add a time-stamped user comment
list-session-comments – list all time-stamped session comments
start-playback – play back previously recorded input from a file
start-recording – record all asynchronous input to file
stop-playback – stop playback of asynchronous input from a file
stop-recording – stop recording of session or asynchronous input

3.1.30 Registers

% – read register by name, module or string formatting
<register_breakpoint>.break-register – add a register breakpoint
<register_breakpoint>.unbreak-register – remove a register breakpoint
get-device-offset – read from an offset in a device bank
get-device-reg – read from a register in a device bank
list-device-regs – find registers by name
print-device-reg-info – print detailed information of device registers
print-device-regs – list registers in a bank
print-processor-registers – print cpu registers
read-reg – read a register
set-device-offset – write at an offset in a device bank
set-device-reg – write to a register in a device bank
set-pc – set the current processor's program counter
write-reg – write to register

3.1.31 Snapshots

delete-snapshot – delete in-memory snapshots of the simulation state
list-snapshots – list in-memory snapshots of the simulation state
restore-snapshot – restore the simulation state from an in-memory snapshot
take-snapshot – take a snapshot of the current simulation state

3.1.32 Tracing

<DS12887-c>.trace-nvram – trace nvram updates
<bp-manager.bank>.trace – enable tracing of device accesses
<bp-manager.con-gfx>.trace – enable tracing of graphical matches
<bp-manager.con-string>.trace – enable tracing of string appearances
<bp-manager.cr>.trace – enable tracing of control register accesses
<bp-manager.cycle>.trace – enable tracing of cycle points
<bp-manager.cycle_event>.trace – enable tracing of cycle events
<bp-manager.eth_link>.trace – wait_for
<bp-manager.exc>.trace – enable tracing of exceptions
<bp-manager.hap>.trace – enable tracing of hap triggers
<bp-manager.log>.trace – enable tracing of log messages
<bp-manager.magic>.trace – enable tracing of magic instructions
<bp-manager.memory>.trace – enable tracing of memory accesses
<bp-manager.msr>.trace – enable tracing of architectural MSR accesses
<bp-manager.notify>.trace – enable tracing of notifier triggers
<bp-manager.os_awareness>.trace – trace OS Awareness node changes
<bp-manager.src-line>.trace – enable tracing of source code line reaches
<bp-manager.src-location>.trace – enable tracing of location reaches
<bp-manager.step>.trace – enable tracing of step points
<bp-manager.step_event>.trace – enable tracing of step events
<bp-manager.time>.trace – enable tracing of time points
<instruction_fetch>.instruction-fetch-mode – set or get current mode for instruction fetching
<trace-sync>.enable – enable core2 hardware bug workaround

3.1.33 USB

<usb_hs_keyboard>.key-down – send key down event
<usb_hs_keyboard>.key-press – send key event
<usb_keyboard>.key-down – send key down event
<usb_keyboard>.key-press – send key event
<usb_mouse>.left-button – send button down/up event
<usb_mouse>.moveto – move mouse cursor
<usb_mouse>.reset – reset mouse cursor
create-usb-disk-comp – create a non-instantiated usb_disk_comp
create-usb-tablet-component – create a non-instantiated usb_tablet_component
new-usb-disk-comp – create an instantiated usb_disk_comp
new-usb-tablet-component – create an instantiated usb_tablet_component

3.1.34 Virtio

create-virtio-mmio-blk-comp – create a non-instantiated virtio_mmio_blk_comp
new-virtio-mmio-blk-comp – create an instantiated virtio_mmio_blk_comp

3.1.35 network commands

<ethernet_cable>.start-link-monitor – start background monitoring of an Ethernet link
<ethernet_cable>.stop-link-monitor – stop Ethernet link monitoring
<ethernet_cable>.view-link-monitor – view status of the monitored Ethernet link
<ethernet_hub>.start-link-monitor – start background monitoring of an Ethernet link
<ethernet_hub>.stop-link-monitor – stop Ethernet link monitoring
<ethernet_hub>.view-link-monitor – view status of the monitored Ethernet link
<ethernet_switch>.start-link-monitor – start background monitoring of an Ethernet link
<ethernet_switch>.stop-link-monitor – stop Ethernet link monitoring
<ethernet_switch>.view-link-monitor – view status of the monitored Ethernet link

3.2 Command List

!

Synopsis

!shell-command

Name	Type	Direction
eth1	ethernet-link	down
eth2	ethernet-link	down
eth3	ethernet-link	down
eth4	ethernet-link	down
pci	pci-bus	up

Name	Type	Direction
bridge_slot[0]	compact-pci-bus	down
bridge_slot[1]	compact-pci-bus	down
bridge_slot[2]	compact-pci-bus	down
bridge_slot[3]	compact-pci-bus	down
bridge_slot[4]	compact-pci-bus	down
device_slot[0]	compact-pci-bus	down
device_slot[1]	compact-pci-bus	down
device_slot[2]	compact-pci-bus	down
device_slot[3]	compact-pci-bus	down
device_slot[4]	compact-pci-bus	down
pci_slot	pci-bus	down

Name	Type	Direction
debug	serial	down
eth0	ethernet-link	down
uart[0]	serial	down
uart[1]	serial	down

Name	Type	Direction
abs_mouse	abs-mouse	up
device	graphics-console	up
keyboard	keyboard	up
mouse	mouse	up

Name	Type	Direction
eth[0]	ethernet-link	down
eth[1]	ethernet-link	down
pci_bus	pci-bus	up

Name	Type	Direction
cpu[0]	x86-apic-processor	down
cpu[1]	x86-apic-processor	down
cpu[2]	x86-apic-processor	down
cpu[3]	x86-apic-processor	down
cpu[4]	x86-apic-processor	down
cpu[5]	x86-apic-processor	down
cpu[6]	x86-apic-processor	down
cpu[7]	x86-apic-processor	down
dimm[0]	mem-bus	down
dimm[1]	mem-bus	down
dimm[2]	mem-bus	down
dimm[3]	mem-bus	down
reset_bus	x86-reset-bus	down

Name	Type	Direction
cpu[0]	x86-processor	down
dimm[0]	mem-bus	down
dimm[1]	mem-bus	down
dimm[2]	mem-bus	down
dimm[3]	mem-bus	down
reset_bus	x86-reset-bus	down

Name	Type	Direction
pci_bus	pci-bus	up
pci_slot[0]	pci-bus	down
pci_slot[10]	pci-bus	down
pci_slot[11]	pci-bus	down
pci_slot[12]	pci-bus	down
pci_slot[13]	pci-bus	down
pci_slot[14]	pci-bus	down
pci_slot[15]	pci-bus	down
pci_slot[16]	pci-bus	down
pci_slot[17]	pci-bus	down
pci_slot[18]	pci-bus	down
pci_slot[19]	pci-bus	down
pci_slot[1]	pci-bus	down
pci_slot[20]	pci-bus	down
pci_slot[21]	pci-bus	down
pci_slot[22]	pci-bus	down
pci_slot[23]	pci-bus	down
pci_slot[2]	pci-bus	down
pci_slot[3]	pci-bus	down
pci_slot[4]	pci-bus	down
pci_slot[5]	pci-bus	down
pci_slot[6]	pci-bus	down
pci_slot[7]	pci-bus	down
pci_slot[8]	pci-bus	down
pci_slot[9]	pci-bus	down

Name	Type	Direction
pci_bus	pci-bus	up
pcmcia[0]	pcmcia-slot	down
pcmcia[1]	pcmcia-slot	down

Name	Type	Direction
receiver0	signal-link-receiver	any
sender0	signal-link-sender	any

Name	Type	Direction
mission1	harpoon-bus	up
mission2	harpoon-bus	up

Name	Type	Direction
slot[0]	pci-bus	down
slot[1]	pci-bus	down
slot[2]	pci-bus	down
slot[3]	pci-bus	down
upstream_target	pci-bus	up

Name	Type	Direction
connector_abs_mouse	abs-mouse	down
connector_mouse	mouse	down
connector_usb_host	usb-port	up