Console Command Reference

add

  • add branch <from BRANCH> [<to INSTRUCTION>]+

    Adds the given from/to references to the branches list

  • add tile <tile id|*>

    Add xCORE tile to active set

  • add exclusion <ANY>

    Adds the given reference to the list of exclusions

  • add functiontime <FUNCTION> <value> <MODE>

    Adds the given function time to the list of defines

  • add instructiontime <ENDPOINT> <value> <MODE>

    Adds the given instruction time to the list of defines

  • add loop <ANY> <iterations>

    Adds the given loop count define to the list of defines

  • add looppath <ANY> <iterations>

    Adds the given loop path count define to the list of defines

  • add loopscope <ANY> <SCOPE>

    Adds the given loop scope define to the list of defines

  • add pathtime <from ENDPOINT> <to ENDPOINT> <value> <MODE>

    Adds the given path time to the list of defines

analyze

  • analyze endpoints <from ENDPOINT> <to ENDPOINT>

    Analyzes between the specified endpoints

  • analyze function <FUNCTION>

    Analyzes the given function

  • analyze loop <ANY>

    Analyzes the given loop

config

  • config case <best/worst>

    Sets the case (currently: worst)

  • config Ewarning <on/off>

    Treats errors as warnings or not (currently: off)

  • config freq <node id> <tile frequency>

    Sets the operating frequency in MHz for the given node

  • config from <ENDPOINT>

    Sets the from endpoint

  • config looppoint <ANY>

    Sets the loop point

  • config scale <true/false>

    Configures whether results are scales (currently: true)

  • config srcpaths <paths>

    Sets the (semicolon separated) source search path

  • config cores <tile id> <num cores>

    Sets number of cores currently executing for the given tile

  • config timeout <seconds>

    Sets the tools timeout on load

  • config Terror <on/off>

    Treat timing failures as errors or not (currently: on)

  • config to <ENDPOINT>

    Sets the to endpoint

  • config verbosity <level>

    Sets the tool verbosity level (range: -10 -> +10, default: 0)

  • config Werror <on/off>

    Treats warnings as errors or not (currently: off)

clear

  • clear()

    Clears the screen (GUI mode only)

debug

  • debug dumpactiveexclusions()

    Dumps a list of PCs that the exclusions have resolved to

  • debug dumpcachedfunction <FUNCTION>

    Dumps the cached function structure

  • debug dumpcallgraph()

    Dumps the call graph for all tiles in dot (graphviz) format

  • debug dumpcontrolflow <FUNCTION>

    Dumps the control flow graph for the given function in dot (graphviz) format

  • debug dumpmanual()

    Dumps the console reference chapter of the manual in tex format

  • debug dumpstacknodes <REFERENCE>

    Dumps the stack nodes for the given reference

  • debug dumpunresolvedinstructions()

    Dumps a list of instructions that are unresolved

  • debug verifyreference <ANY>

    Verifies the existance of the given reference

  • debug frompoints()

    Displays the from endpoints currently configured

  • debug topoints()

    Displays the to endpoints currently configured

  • debug instructiontime <route id> <node id>

    Displays the instruction time set for the given node in the given route

  • debug loop <route id> <node id>

    Displays the loop iterations set for the given node in the given route

  • debug looppath <route id> <node id>

    Displays the loop path iterations set for the given node in the given route

  • debug loopscope <route id> <node id>

    Displays the loop scope set for the given node in the given route

  • debug listglobalreferences <ANY>

    Lists all the matching references for the given reference on the global tree

  • debug listroutereferences <route id> <ANY>

    Lists all the matching references for the given reference on the given route

  • debug memusage()

    Displays the current memory usage for the JVM

  • debug getmemthreshold()

    Displays the current memory usage threshold

  • debug setmemthreshold <threshold>

    Sets the memory threshold to the given value (0.0 - 1.0)

echo

  • echo "text"

    Prints the text to the console

exit

  • exit()

    Quits the application

help

  • help [command|command subcommand|option]

    Displays help message for the given arguments

history

  • history()

    Displays the command history

load

  • load <xe file>

    Loads the given XMOS executable file

list

  • list allcalls()

    Lists all the possible locations for calls

  • list allendpoints()

    Lists all the possible locations for endpoints

  • list branches [route id]

    Lists the branches - optionally for the specified route

  • list calls()

    Lists the calls

  • list tiles()

    Lists the active xCORE tiles

  • list endpoints()

    Lists the endpoints

  • list exclusions [route id]

    Displays the exclusions - optionally for the specified route

  • list functions()

    Lists the functions in the loaded application

  • list functiontimes()

    Displays the function time defines

  • list instructiontimes()

    Displays the instruction time defines

  • list knowns <route id>

    Displays the list of knowns set for the given route

  • list labels()

    Lists the labels

  • list loops()

    Displays the loop defines

  • list looppaths()

    Displays the loop path defines

  • list loopscopes()

    Displays the loop scope defines

  • list pathtimes()

    Displays the path time defines

  • list sources()

    Lists the source files

  • list srccommands()

    Displays the command list embedded in the loaded executable

  • list srcloops()

    Displays the loop counts embedded in the loaded executable

  • list srclabels()

    Lists the source labels

  • list allsrclabels()

    Lists all the possible locations for source labels

  • list corestartpoints()

    Lists the logical core start points

  • list corestoppoints()

    Lists the logical core stop points

  • list unknowns <route id>

    Displays the list of unknowns for the given route

print

  • print summary()

    Shows routes summary (verbosity -2|-1|0)

  • print structure <route id> [node id]

    Displays the structure for given route/node (verbosity 0|1)

  • print asm <route id> [node id]

    Displays annotated assembly for the given route/node

  • print src <route id> [node id]

    Displays annotated source file(s) for given route/node

  • print trace <route id> [node id]

    Displays instruction trace for the worst case path of the given route/node

  • print routeinfo <route id>

    Shows detailed information for the given route

  • print nodeinfo <route id> <node id>

    Shows detailed information for the given node in the given route

  • print warnings()

    Prints all timing warnings

  • print distribution <route id> [node id]

    Displays time distribution for the given route/node

pwd

  • pwd()

    Displays the current working directory

remove

  • remove branch <from BRANCH|*> [<to INSTRUCTION|*>]+

    Removes the given from/to references from the branches list

  • remove tile <tile id|*>

    Removes xCORE tile from active set

  • remove exclusion <ANY|*>

    Removes the given reference (or all if ‘*’) from the list of exclusions

  • remove functiontime <FUNCTION|*>

    Removes the given functon time from the list of defines

  • remove instructiontime <ENDPOINT|*>

    Removes the given instruction time from the list of defines

  • remove loop <ANY|*>

    Removes the given loop count define to the list of defines

  • remove looppath <ANY|*>

    Removes the given loop path count define to the list of defines

  • remove loopscope <ANY|*>

    Removes the given loop scope define to the list of defines

  • remove pathtime <from ENDPOINT|*> <to ENDPOINT|*>

    Removes the given path time from the list of defines

  • remove route <route id>

    Removes the route with the given id from the current analysis

scripter

  • scripter disable <ANY>

    Disables a mapping

  • scripter dump()

    Dumps script which represents the current state - also embeds active pragmas into source

  • scripter embed <filename>

    Embeds the script into the designated file - also embed active pragmas into source

  • scripter enable <ANY>

    Enables a mapping

  • scripter listrefs()

    Lists all references which will be used in the script

  • scripter rename <ANY> <TO_NAME>

    Renames a mapping

set

  • set exclusion <route id> <ANY>

    Sets an exclusion on the given reference

  • set functiontime <route id> <FUNCTION> <value> <MODE>

    Sets timing requirement for the given function on the given route

  • set instructiontime <route id> <ENDPOINT> <value> <MODE>

    Sets the time taken for the instruction at the given pc

  • set loop <route id> <ANY> <iterations>

    Sets the number of iterations for the loop identified

  • set looppath <route id> <ANY> <iterations>

    Sets the number of iterations for the path identified

  • set loopscope <route id> <ANY> <SCOPE>

    Sets the scope of the referenced loop

  • set pathtime <route id> <from ENDPOINT> <to ENDPOINT> <value> <MODE>

    Sets timing requirement for the given path on the given route

  • set required <route id> <value> <MODE>

    Sets the maximum allowed time taken for the given route

source

  • source <file name> [args]

    Sources the given script file

status

  • status()

    Displays current status

version

  • version()

    Displays the version information

Pragmas

  • #pragma xta label "name"

    Provides a label that can be used to specify timing constraints.

  • #pragma xta endpoint "name"

    Specifies an endpoint. It may appear before an input or output statement.

  • #pragma xta call "name"

    Defines a label for a (function) call point. Use to specify a particular called instance of a function. For example, if a function contains a loop, the iterations for this loop can be set to a different value depending on which call point the function was called from.

  • #pragma xta command "command"

    Allows XTA commands to be embedded into source code. All commands are run every time the binary is loaded into the XTA. Commands are executed in the order they occur in the file, but the order between commands in different source files is not defined.

  • #pragma xta loop "integer"

    Applies the given loop XTA iterations to the loop containing the pragma.

Timing Modes

The available timing modes are:

  • ns()

    nanoseconds

  • us()

    microseconds

  • ms()

    milliseconds

  • MHz()

    megahertz

  • KHz()

    kilohertz

  • Hz()

    hertz

  • cycles()

    The core cycle count is the number of scheduled slots that the logical core required to perform the sequence. The relationship between core cycles and time is a function of the number of cores currently running and the xCORE tile frequency.

Loop Scopes

Supported values for scope are:

  • relative/r()

    Iteration number propagates to the enclosing path (Default)

  • absolute/a()

    Absolute number of iterations

Reference Classes

FUNCTION

  • FunctionPc()

    Raw program counter specified in the format: 0x*

  • Function()

    Any function

BRANCH

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • CallPc()

    Call specified in the format: 0x*

  • CallFileLine()

    Call specified in the format: ‘file name:line number’

  • Call()

    Call specified using the source level pragma mechanism

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

  • CallLabel()

    Any source or assembly level symbol defined with respect to an executable section

INSTRUCTION

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • FunctionPc()

    Raw program counter specified in the format: 0x*

  • Function()

    Any function

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

ENDPOINT

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • EndpointFileLine()

    Endpoint specified in the format: ‘file name:line number’

  • Endpoint()

    Endpoint specified using the source level pragma mechanism

  • CallPc()

    Call specified in the format: 0x*

  • CallFileLine()

    Call specified in the format: ‘file name:line number’

  • Call()

    Call specified using the source level pragma mechanism

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

  • CallLabel()

    Any source or assembly level symbol defined with respect to an executable section

ANY

  • SrcLabelPc()

    Raw program counter specified in the format: 0x*

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • EndpointFileLine()

    Endpoint specified in the format: ‘file name:line number’

  • Endpoint()

    Endpoint specified using the source level pragma mechanism

  • CallPc()

    Call specified in the format: 0x*

  • CallFileLine()

    Call specified in the format: ‘file name:line number’

  • Call()

    Call specified using the source level pragma mechanism

  • SrcLabelFileLine()

    Source label specified in the format: ‘file name:line number’

  • SrcLabel()

    Source label specified using the source level pragma mechanism

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

  • CallLabel()

    Any source or assembly level symbol defined with respect to an executable section

FUNCTION_WITH_EVERYTHING

  • EverythingReference()

    Matches everything: ‘*’

  • FunctionPc()

    Raw program counter specified in the format: 0x*

  • Function()

    Any function

BRANCH_WITH_EVERYTHING

  • EverythingReference()

    Matches everything: ‘*’

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • CallPc()

    Call specified in the format: 0x*

  • CallFileLine()

    Call specified in the format: ‘file name:line number’

  • Call()

    Call specified using the source level pragma mechanism

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

  • CallLabel()

    Any source or assembly level symbol defined with respect to an executable section

INSTRUCTION_WITH_EVERYTHING

  • EverythingReference()

    Matches everything: ‘*’

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • FunctionPc()

    Raw program counter specified in the format: 0x*

  • Function()

    Any function

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

ENDPOINT_WITH_EVERYTHING

  • EverythingReference()

    Matches everything: ‘*’

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • EndpointFileLine()

    Endpoint specified in the format: ‘file name:line number’

  • Endpoint()

    Endpoint specified using the source level pragma mechanism

  • CallPc()

    Call specified in the format: 0x*

  • CallFileLine()

    Call specified in the format: ‘file name:line number’

  • Call()

    Call specified using the source level pragma mechanism

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

  • CallLabel()

    Any source or assembly level symbol defined with respect to an executable section

ANY_WITH_EVERYTHING

  • EverythingReference()

    Matches everything: ‘*’

  • SrcLabelPc()

    Raw program counter specified in the format: 0x*

  • EndpointPC()

    Raw program counter specified in the format: 0x*

  • EndpointFileLine()

    Endpoint specified in the format: ‘file name:line number’

  • Endpoint()

    Endpoint specified using the source level pragma mechanism

  • CallPc()

    Call specified in the format: 0x*

  • CallFileLine()

    Call specified in the format: ‘file name:line number’

  • Call()

    Call specified using the source level pragma mechanism

  • SrcLabelFileLine()

    Source label specified in the format: ‘file name:line number’

  • SrcLabel()

    Source label specified using the source level pragma mechanism

  • Label()

    Any source or assembly level symbol defined with respect to an executable section

  • CallLabel()

    Any source or assembly level symbol defined with respect to an executable section

See Also