NextGen TotalView for HPC Reference Guide : PART I Using the CLI : Chapter 5 TotalView Variables : Top-Level (::) Namespace
Top-Level (::) Namespace
ARGS(dpmid)
Contains the arguments to be passed the next time the process starts, with TotalView ID dpid.
Permitted Values: A string
Default: None
ARGS_DEFAULT
Contains the argument passed to a new process when no ARGS(dpid) variable is defined.
Permitted Values: A string
Default: None
BARRIER_STOP_ALL
Contains the value for the “stop_when_done” property for newly created action points. This property defines additional elements to stop when a barrier point is satisfied or a thread encounters this action point. You can also set this value using the When barrier hit, stop value in the Action Points Page of the File > Preferences dialog box. The values are:
group
Stops all processes in a thread’s control group when a thread reaches a barrier created using this default.
process
Stops the process in which the thread is running when a thread reaches a barrier created using this default.
none
Stops only the thread that hit a barrier created using this default.
This variable is the same as the TV::barrier_stop_allvariable.
Permitted Values: group, process, or thread
Default: group
BARRIER_STOP_­WHEN_DONE
Contains the default value used when a barrier point is satisfied. You can also set this value using the -stop_when_done command-line option or the When barrier done, stop value in the Action Points Page of the File > Preferences dialog box. The values are:
group
When a barrier is satisfied, stops all processes in the control group.
process
When a barrier is satisfied, stops the processes in the satisfaction set.
none
Stops only the threads in the satisfaction set; other threads are not affected. For process barriers, there is no difference between process and none.
In all cases, TotalViewreleases the satisfaction set when the barrier is satisfied.
This variable is the same as the TV::barrier_stop_when_donevariable.
Permitted Values: group, process, or thread
Default: group
CGROUP(dpid)
Contains the control group for the process with the TotalView ID dpid. Setting this variable moves process dpid into a different control group. For example, the following command moves process 3 into the same group as process 1:
dset CGROUP(3) $CGROUP(1)
Permitted Values: A number
Default: None
COMMAND_EDITING
Enables some Emacs-like commands for use when editing text in the CLI. These editing commands are always available in the CLI window of the TotalView GUI. However, they are available only in the stand­-alone CLI if the terminal in which it is running supports cursor positioning and clear-to-end-of-line. The commands you can use are:
^A: Moves the cursor to the beginning of the line
^B: Moves the cursor one character backward
^D: Deletes the character to the right of cursor
^E: Moves the cursor to the end of the line
^F: Moves the cursor one character forward
^K: Deletes all text to the end of line
^N: Retrieves the next entered command (only works after ^P)
^P: Retrieves the previously entered command
^R or ^L: Redraws the line
^U: Deletes all text from the cursor to the beginning of the line
Rubout or Backspace: Deletes the character to the left of the cursor
Permitted Values: true or false
Default: false
EXECUTABLE_PATH
Contains a colon-separated list of the directories searched for source and executable files.
Permitted Values: Any directory or directory path. To include the current setting, use $EXECUTABLE_PATH.
Default: .(dot)
EXECUTABLE_SEARCH_MAPPINGS
Contains pairs of regular expressions and replacement and replacement strings—these replacements are called mappings—separated by colons. TotalView applies these mappings to the search paths before it looks for source, object, and program files.
The syntax for mapping strings is:
+regular_exp+=+replacement+ :+regular_exp+=+replacement+
This example shows two pairs, each delimited by a colon (“:”). Each element within a pair is delimited by any character except a colon. The first character entered is the delimiter. This example uses a “+” as a delimiter. (Traditionally, forward slashes are used as delimiters but are not used here, as a forward slash is also used to separate components of a pathname. For example, /home/my_dir contains forward slashes.)
Be aware that special characters must follow standard Tcl rules and conventions, for example:
dset EXECUTABLE_SEARCH_MAPPINGS {+^/nfs/compiled/u2/(.*)$+ = +/nfs/host/u2/\1+ }
This expression applies a mapping so that a directory named /nfs/compiled/u2/project/src1 in the expanded search path becomes /nfs/host/u2/project/src1.
Default: {}
EXECUTABLE_SEARCH_PATH
Contains a list of paths, separated by a colon, to search for executables. For information, see “Setting Search Paths Using TotalView for HPC Variables” in the TotalView for HPC in-product help.
Permitted Values: Any directory or directory path.
Default: ${EXECUTABLE_PATH};${$PATH}:.
GROUP(gid)
Contains a list of the TotalView IDs for all members in group gid.
The first element indicates the type of group:
control
The group of all processes in a program
lockstep
A group of threads that share the same PC
process
A user-created process group
share
The group of processes in one program that share the same executable image
thread
A user-created thread group
workers
The group of worker threads in a program
Elements that follow are either pids (for process groups) or pid.tid pairs (for thread groups).
The gid is a simple number for most groups. In contrast, a lockstep group’s ID number is of the form pid.tid. Thus, GROUP(2.3) contains the lockstep group for thread 3 in process 2. Note, however, that the CLI does not display lockstep groups when you use dset with no arguments because they are hidden variables.
The GROUP(id) variable is read-only.
Permitted Values: A Tcl array of lists indexed by the group ID. Each entry contains the members of one group.
Default: None
GROUPS
Contains a list of all TotalView groups IDs. Lockstep groups are not contained in this list. This is a read-only value and cannot be set.
Permitted Values: A Tcl list of IDs.
LINES_PER_SCREEN
Defines the number of lines shown before the CLI stops printing information and displays its more prompt. The following values have special meaning:
0
No more processing occurs, and the printing does not stop when the screen fills with data.
NONE
A synonym for 0
AUTO
The CLI uses the tty settings to determine the number of lines to display. This may not work in all cases. For example, Emacs sets the tty value to 0. If AUTO works improperly, you need to explicitly set a value.
Permitted Values: A positive integer, or the AUTO or NONEstrings
Default: Auto
MAX_LEVELS
Defines the maximum number of levels that the dwhere command displays.
Permitted Values: A positive integer
Default: 512
MAX_LIST
Defines the number of lines that the dlist command displays.
Permitted Values: A positive integer
Default: 20
OBJECT_SEARCH_MAPPINGS
Contains pairs of regular expressions and replacement and replacement strings (called mappings) separated by colons. TotalView applies these mappings to the search paths when searching for source, object, and program files. For more information, see EXECUTABLE_SEARCH_MAPPINGS.
Default: {}
OBJECT_SEARCH_PATH
Contains a list of paths separated by a colon to search for your program’s object files. For information, see “Search Path Variables That You Can Set” in the TotalView for HPC in-product help.
Permitted Values: Any directory or directory path.
Default: ${COMPILATION_DIRECTORY): ${EXECUTABLE_PATH}: ${EXECUTABLE_DIRECTORY}: $links{${EXECUTABLE_DIRECTORY}}: .:${TOTALVIEW_SRC}
PROCESS(dpid)
Contains a list of information associated with a dpid. This is a read-only value and cannot be set.
Permitted Values: An integer
Default: None
PROMPT
Defines the CLI prompt. Any information within brackets ([ ]) is assumed to be a Tcl command, so therefore evaluated before the prompt string is created.
Permitted Values: Any string. To access the value of PTSET, place the variable within brackets; that is, [dset PTSET].
Default: {[dfocus]> }
PTSET
Contains the current focus. This is a read-only value and cannot be set.
Permitted Values: A string
Default: d1.<
SGROUP(pid)
Contains the group ID of the share group for process pid. The share group is determined by the control group for the process and the executable associated with this process. You cannot directly modify this group.
Permitted Values: A number
Default: None
SHARE_ACTION_­POINT
Indicates the scope for newly created action points. In the CLI, this is the dbarrier, dbreak, and dwatch commands. If this boolean value is true, newly created action point are shared across the group; if false, a newly created action point is active only in the process in which it is set.
As an alternative to setting this variable, you can select the Plant in share group check box in the Action Points Page in the File > Preferences dialog box. To override this value in the GUI, use the Plant in share group checkbox in the Action Point > Properties dialog box.
Permitted Values: true or false
Default: true
SHARED_LIBRARY_SEARCH_MAPPINGS
Contains pairs of regular expressions and replacement strings (mappings), separated by colons. TotalView applies these mappings to the search paths before it looks for shared library files.
Default: {}
SHARED_LIBRARY_SEARCH_PATH
Contains a list of paths, each separated by a colon, to search for your program’s shared library files.
Permitted Values: Any directory or directory path.
Default: ${EXECUTABLE_PATH}:
SOURCE_SEARCH_MAPPINGS
Contains pairs of regular expressions and replacement strings (mappings) separated by colons. TotalView applies these mappings to the search paths before it looks for source, object, and program files. For more information, see EXECUTABLE_SEARCH_MAPPINGS.
Default: {}
SOURCE_SEARCH_PATH
Contains a list of paths, separated by a colon, to search for your program’s source files. For information, see “Search Path Variables That You Can Set” in the TotalView for HPC in-product help.
Permitted Values: Any directory or directory path.
Default: ${COMPILATION_DIRECTORY}: ${EXECUTABLE_PATH}: ${EXECUTABLE_DIRECTORY}: ${links{${EXECUTABLE_DIRECTORY}): .:${TOTALVIEW_SRC}
STACK_TRACE_TRANSFORM_ENABLED
Controls whether TotalView filters the stack. Because not all applications can benefit from stack filtering, this variable is false by default.
NOTE >> If TotalView detects that an application has a feature that can benefit from stack filtering, it enables this variable.
Permitted Values: true or false
Default: false
STOP_ALL
Indicates a default property for newly created action points, defining additional elements to stop when this action point is encountered
group
Stops the entire control group when the action point is hit
process
Stops the entire process when the action point is hit
thread
Stops only the thread that hit the action point. Note that none is a synonym for thread
Permitted Values: group, process, or thread
Default: process
TAB_WIDTH
Indicates the number of spaces used to simulate a tab character when the CLI displays information.
Permitted Values: A positive number. A value of -1 indicates that the CLI does not simulate tab expansion.
Default: 8
THREADS(pid)
Contains a list of all threads in the process pid, in the form {pid.1 pid.2 ...}. This is a read-only variable and cannot be set.
Permitted Values: A Tcl list
Default: None
TOTALVIEW_ROOT_­PATH
Names the directory containing the TotalView executable. This is a read-only variable and cannot be set. This variable is exported as TVROOT, and can be used in launch strings.
Permitted Values: The location of the TotalView installation directory
TOTALVIEW_­TCLLIB_­PATH
Contains a list of the directories in which the CLI searches for TCL library components.
Permitted Values: Any valid directory or directory path. To include the current setting, use $TOTALVIEW_TCLLIB_PATH.
Default: The directory containing the CLI’s Tcl libraries
TOTALVIEW_­VERSION
Contains the version number and the type of computer architecture upon which TotalView is executing. This is a read-only variable and cannot be set.
Permitted Values: A string containing the platform and version number
Default: Platform-specific
VERBOSE
Sets the error message information displayed by the CLI:
info
Prints errors, warnings, and informational messages. Informational messages include data on dynamic libraries and symbols.
warning
Prints only errors and warnings.
error
Prints only error messages.
silent
Does not print error, warning, and informational messages. This also shuts off printing results from CLI commands. This should be used only when the CLI is run in batch mode.
Permitted Values: info, warning, error, and silent
Default: info
WGROUP(pid)
The group ID of the thread group of worker threads associated with the process pid. This variable is read-only.
Permitted Values: A number
Default: None
WGROUP(pid.tid)
Contains one of the following:
The group ID of the workers group in which thread pid.tidis a member
0 (zero), which indicates that threadpid.tidis not a worker thread
Storing a nonzero value in this variable marks a thread as a worker. In this case, the returned value is the ID of the workers group associated with the control group, regardless of the actual nonzero value assigned to it.
Permitted Values: A number representing the pid.tid
Default: None