Top-Level (::) Namespace

ARGS(dpmid)

Contains the arguments to be passed the next time the process starts, with TotalView ID dpid.

A string

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_all variable.

group, process, or thread

group

ARGS_DEFAULT

Contains the argument passed to a new process when no ARGS(dpid) variable is defined.

A string

None

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_done variable.

group, process, or thread

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)

A number

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

 true or false

false

EXECUTABLE_PATH

Contains a colon-separated list of the directories searched for source and executable files. For more information, see Search Path.

 Any directory or directory path. To include the current setting, use $EXECUTABLE_PATH.

.(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 as follows:

+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.

{}

EXECUTABLE_SEARCH_PATH

Contains a list of paths, separated by a colon, to search for executables. For more information, see Search Path.

 Any directory or directory path.

${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.

 A Tcl array of lists indexed by the group ID. Each entry contains the members of one group.

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.

 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.

 A positive integer, or the AUTO or NONE strings

Auto

MAX_LEVELS

Defines the maximum number of levels that the dwhere command displays.

 A positive integer

512

MAX_LIST

Defines the number of lines that the dlist command displays.

 A positive integer

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.

{}

OBJECT_SEARCH_PATH

Contains a list of paths separated by a colon to search for your program’s object files. For more information, see Search Path.

 Any directory or directory path.

${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.

 An integer

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.

 Any string. To access the value of PTSET, place the variable within brackets; that is, [dset PTSET].

{[dfocus]> }

PTSET

Contains the current focus. This is a read-only value and cannot be set.

 A string

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.

 A number

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.

true or false

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.

{}

SHARED_LIBRARY_SEARCH_PATH

Contains a list of paths, each separated by a colon, to search for your program’s shared library files. For more information, see Search Path.

 Any directory or directory path.

${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.

{}

SOURCE_SEARCH_PATH

Contains a list of paths, separated by a colon, to search for your program’s source files. For more information, see Search Path.

 Any directory or directory path.

${COMPILATION_DIRECTORY}: ${EXECUTABLE_PATH}: ${EXECUTABLE_DIRECTORY}: ${links{${EXECUTABLE_DIRECTORY}): .:${TOTALVIEW_SRC}

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

group, process, or thread

process

TAB_WIDTH

Indicates the number of spaces used to simulate a tab character when the CLI displays information.

 A positive number. A value of -1 indicates that the CLI does not simulate tab expansion.

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.

 A Tcl list

None

TVHEAP_ARGS

Environment variable for configuring memory debugging. Many of the same configurations are available using the dheap command.

When TotalView starts, it reads the values in the TVHEAP_ARGS environment variable, if it exists. Values set in this environment variable override any TotalView default values. Using the reset option in the UI resets the value to the values in this variable, rather than the TotalView default values.

If you set a value in the CLI using dheap, I assume it overrides values in this env variable? We should address that.

Supported Values:

display_a llocations_on_exit=boolean

Dumps the allocation table when your program exits. If your program ends because it receives a signal, TotalView might not be able to dump this table.

backtrace_depth=depth

Sets the backtrace depth value. See dheap -backtrace subcommands.

backtrace_trim=trim

Sets the backtrace trim value. See dheap-backtrace subcommands.

enable_event_filtering=boolean

Controls which HIA events should stop program execution. Same as dheap -event_filter subcommands.

notify_free_not_allocated=boolean

notify_realloc_not_allocated=boolean

notify_addr_not_at_start=boolean

notify_double_alloc=boolean

notify_guard_corruption=boolean

notify_alloc_not_in_heap=boolean

notify_alloc_null=boolean

notify_alloc_returned_bad_alignment=boolean

notify_bad_alignment_argument=boolean

notify_dealloc=boolean

notify_realloc=boolean

notify_double_dealloc=boolean

enable_guard_blocks=boolean

Enables, disables, and configures guard blocks. Same as dheap -guard subcommands [ start_address [ end_address ] ]. See also Guarding Allocated Memory.

guard_max_size=positive-integer

guard_pre_size=positive-integer

guard_post_size=positive-integer

guard_pre_pattern=integer

guard_post_pattern=integer

enable_hoarding=boolean

Controls whether to surrender allocated blocks back to your program’s heap manager. If you do not specify a subcommand, TotalView displays information about the hoarded blocks. Same as dheap -hoard [ subcommands ]. For more information, see Hoarding Memory Blocks.

hoard_all_blocks=boolean

hoard_maximum_num_blocks=positive-integer

hoard_maximum_kb=positive-integer

enable_hoard_autoshrink=boolean

hoard_autoshrink_threshold_kb=positive-integer

hoard_autoshrink_trigger_count=positive-integer

enable_red_zones=boolean

Helps catch bounds errors and use-after-free errors. The basic idea is that each allocation is placed in its own page. Same as dheap -red_zones [ subcommands ].

enable_rz_size_ranges=boolean

rz_alignment=positive-integer

rz_detect_underrun=boolean

rz_detect_overrun=boolean

rz_detect_use_after_free=boolean

rz_end_alligned=boolean

rz_exit_val=integer

rz_fence_size=positive-integer

rz_mode=overrun | underrun |unfenced | manual

rz_size_range=positive-integer, positive-integer, positive-integer

rz_size_range_enable=positive-integer,boolean

memalign_strict_alignment_even_multiple

TotalView provides an integral multiple of the alignment rather than the even multiple described in the platform memalign documentation. Setting this value uses the platform alignment definition. However, your results might be inconsistent if you do this.

output_fd=int

output_file=pathname

Still supported without standalone MemoryScape? Not in the dheap command.

Sends output from MemoryScape to the file descriptor or file that you name.

paint_on_alloc=boolean

Fills, or paints, blocks as they are allocated and deallocated. Same as dheap -paint [ subcommands ]. See also Painting Memory.

paint_on_dealloc=boolean

paint_on_zalloc=boolean

paint_alloc_pattern=integer

paint_dealloc_pattern=integer

verbosity=int

Sets TotalView’s verbosity level. If the level is greater than 0, TotalView sends information to stderr. Same as setting the VERBOSE variable.

Supported values are:

0: Display no information. The default.

1: Print error messages.

2: Print all relevant information.

Example

For more than one value, separate entries with spaces and place the entire entry within quote. For example:

setenv TVHEAP_ARGS=”output_file=my_file backtrace_depth=16”

 See subcommands above.

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.

 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.

 Any valid directory or directory path. To include the current setting, use $TOTALVIEW_TCLLIB_PATH.

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.

 A string containing the platform and version number

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.

info, warning, error, and silent

info

WGROUP(pid)

The group ID of the thread group of worker threads associated with the process pid. This variable is read-only.

 A number

None

WGROUP(pid.tid)

Contains one of the following:

The group ID of the workers group in which thread pid.tid is a member

0 (zero), which indicates that thread pid.tid is 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.

 A number representing the pid.tid

None