2.3 Commands

This section gives an overview of all commands provided by the software object. Using the help command for a specific command will give more detailed help for that command.

2.3.1 Controlling

enable-tracker

Enables the OS Awareness framework and associated trackers. This is necessary for most other commands to work.

simics> board.software.enable-tracker
OSA control enabled.

disable-tracker

Disables the OS Awareness framework and enabled trackers. This will destroy all node trees.

simics> board.software.disable-tracker
OSA control disabled.

2.3.2 Tracking Related

These commands will require that the tracker is enabled in order to work.

find

Search for a node in the node tree. The output of the command is a list of node path patterns (see 2.4) matching the search.

simics> board.software.find node="tid=1"
/Linux/Userspace/pid=1/tid=1

list

Prints a list of all processes in the system.

simics> board.software.list
Process         Binary  PID  TID
systemd                    1    1
...
simics.agent             283  283
python3                  284  284
systemd                  289  289
(sd-pam)                 290  290
bash                     296  296

node-info

Prints the name and value of all properties of the given node.

simics> board.software.node-info "tid=1"

              Name : systemd
              Path : /Linux/Userspace/pid=1/tid=1
                ID : 644
            Parent : 643
          Children : []
          extra_id : tid
      memory_space : 643
    multiprocessor : False
               pid : 1
               tid : 1

node-tree

Lists the node trees for an active software trackers.

simics> board.software.node-tree

bp-break -active

Break the simulation when a specific node becomes active.

simics> board.software.bp-break -active node-pattern = "tid=1"
Added breakpoint 1

bp-break -inactive

Break the simulation when a specific node gets deactivated.

simics> board.software.bp-break -inactive node-pattern = "tid=1"
Added breakpoint 2

bp.delete

Remove breakpoints that were created by bp-break.

simics> bp.delete -all

active-node

List the node that is active on a certain processor.

simics> board.software.active-node
board.mb.cpu0.core[0][0] is active on /Linux/Userspace/pid=1/tid=1

bp-wait-for -active

Similar to bp-break -active, but to be used in a script-branch.

bp-wait-for -inactive

Similar to bp-break -inactive, but to be used in a script-branch.

2.3.3 Parameter Related

These commands do not require the tracker to be enabled.

load-parameters

Load configuration parameters for a software tracker from a file.

save-parameters

Save the current configuration parameters to a file.

supports-parameters

Tells whether or not a parameters file is supported by the current modules.