Type and Status Defintions

Type and Status Defintions
- Table of Contents
  - address_description
  - breakId
  - expId
  - expMetric
  - expParam
  - expType
  - target
  - linenumber_spec
  - ListOf_
  - statusType
  - viewType
  - verbosity_list_spec

address_description

is an absolute or relative address.

<address_description> ::= <int> || <string>

breakId

is a breakpoint identifier.

<breakId> ::= <int>

expId

is an experiment identifier.

<expId> ::= <int>

<expId_spec> ::= -x <expId>

expMetric

is a result that an experiment can return. It could be a full report, a value or a set of values.

<metric_name> ::= <string>

<expMetric> ::= [<expType>::]<metric_name>

<expMetric_list> ::= <expMetric> [ , <expMetric> ] +

expParam

is the experiment parameters correspond to items in the experiment class that can be changed by the user or a tool component.

<param_name> ::= <string>

<expParam> ::= [<expType>::]<param_name>

<expParamValue> ::= [ <int> || <float> || <string> || "<string>"]

- If <expType> is specified, then only that collector's parameter is updated.
- If <expType> is NOT specified, then all parameters matching the parameter name are updated, regardless of the collector name, for that experiment .

expType

is the experiment type designator. Using this in the expCreate or expAttach command fills in the default values for the experiment.

<predefined_exp> ::= { pcsamp || usertime || mpi || fpe || hwc || io || ? }

<user_defined_exp> ::= <filename>

<expType>> ::= [ <predefined_exp> || <user_defined_exp> ]

<expType_list> ::= <expType> [ , <expType> ] +

target

represents the host file and machine along with a specific process, thread, or rank identifier.

<rankname> ::= <int>

<rank_range> ::= <rankname> [ : <rankname> ]

<rank_list> ::= <rank_range> [ , <rank_range> ] +

<rank_list_spec> ::= -r <rank_list>

<threadname> ::= <int>

<thread_range> ::= <threadname> [ : <threadname> ]

<thread_list> ::= <thread_range> [ , <thread_range> ] +

<thread_list_spec> ::= -t <thread_list>

<pidname> ::= <int>

<pid_range> ::= <pidname> [ : <pidname> ]

<pid_list> ::= <pid_range> [ , <pid_range> ] +

<pid_list_spec> ::= -p <pid_list>

<filename> ::= <string> || "<string>"

<file_list> ::= <filename> [ , <filename> ] +

<file_list_spec> ::= -f <file_list>

<IP_Address> ::= <int>.<int>.<int>.<int>

<hostname> ::= <string> || <IP_Address>

<host_list> ::= -h <host_name> [ , <host_name> ] +

<host_list_spec> ::= -h <host_list>

<clustername> ::= <string> || "<string>"

<cluster_list> ::= <clustername> [ , <clustername> ] +

<cluster_list_spec> ::= -c <cluster_list>

<target> ::= [ <cluster_list_spec> ] [ <host_list_spec> ] [ <file_list_spec> ] [ <pid_list_spec> ] [ <thread_list_spec ] [ <rank_list_spec ]

<target_list> ::= <target> [ ; <target> ] +

<file_spec> ::= -f <file_name>

<host_spec> ::= -h <host_name>

<host_file> ::= [ <host_spec> ] <file_spec>

linenumber_range_spec

is a source line number

<lineno_range> ::= <lineno> [ : <lineno> ]

<linenumber_range_spec> ::= -l <lineno_range>

<linenumber_list_spec> ::= -l <lineno_range> [ , <lineno_range> ] +

ListOf_

xxx indicates a list of type xxx items.

statusType

is the current state of the experiment.

<statusType> ::= { NonExistent || Paused || Disabled || Running || Terminated || Error }

viewType

is the output view display/report type designator. This indicates the format of the output display that the performance data is needed for.

<viewType> ::= <string>

<viewType_list> ::= <viewType> [ , <viewType> ] +

verbosity_list_spec

is used to control the amount and detail of information provided by the help command. The currently supported values are brief, normal and detailed, which can be abreviated b, n or d.

<verbosityType> ::= <string>

<verbosity_list_spec> ::= -v <verbosityType> [ , <verbosityType> ] +