NERSCPowering Scientific Discovery Since 1974

Totalview

Description

TotalView from Rogue Wave Software is a parallel debugging tool that can be run with up to 512 processors.

It provides both X Windows-based Graphical User Interface (GUI) and command line interface (CLI) environments for debugging. The performance of the GUI can be greatly improved if used in conjunction with free NX software.

The TotalView documentation web page is a good resource for learning more about some of the advanced TotalView features.

Compiling Code to Run with TotalView

In order to use TotalView, code must be compiled with the -g option. With the Intel compiler, you may have to add the '-O0' flag, too. We also recommend that you do not run with optimization turned on, flags such as -fast.

A Fortran example:

% ftn -g -O0 -o testTV_ex testTV.f

A C example:

% cc -g -O0 -o testTV_ex testTV.c

Starting a Job with TotalView

Be sure to log in with an X window forwarding enabled. This could mean using the -X or -Y option to ssh. The -Y option often works better for Mac OSX.

% ssh -Y username@cori.nersc.gov

If you don't have the files, please run the 'setup_batchmode_key' command:

% setup_batchmode_key

Then start an interactive batch session on Cori or Edison.

% salloc -N numNodes -p debug                 # on Cori or Edison

where 'numNodes' is the number of compute nodes that you need to use. To use TotalView, first load the TotalView modulefile to set the correct environment settings with the following command:

% module load totalview

Because of a SLURM integration issue, you have to follow the following steps to start a debugging session, instead of the previous way of running the totalview command with an executable name in one command.

Just type 'totalview' at a Unix prompt. A window titled 'TotalView Debugger' will open.

% totalview

totalview debugger

Click on 'A new parallel program'. This will open the 'Parallel Program Session' window. Select 'SLURM' for the Parallel System Name, and set the number of MPI tasks and the number of compute nodes used. The example below is to start a 16 MPI task (-n 16) application running using 2 compute nodes (-N 2).

totalview parallel program session

Click Next. In the next window (the PROGRAM DETAILS tab), provide the executable file name and, if any, command line arguments.

totalview session

Click the 'Start Session' button.

Then, the process window will show the source code, waiting for your command.

If the user source code is not displayed in the process window at this stage, select the main routine in the stack trace pane (the upper left frame) of the process window.

To start debugging, create a break point by clicking on a line number in the source pane, and click 'Go'. After that, you can use other buttons ('Next', 'Step', 'Out', etc.).

There is a smaller window called the 'root window' beside the process window, displaying all the (MPI) processes and threads created for the debugging application. You can see MPI task id (rank) and its status for each process or thread from the window.

 You will want to check the value of variables from time to time in order to see whether your program is running as expected. If you want to check a local variable, you can simply look up the 'Stack Frame' section in the process window. For any variable, right-click on the variable in the source pane and select 'Dive'.

Select 'Across Processes' to view the value across processes. If you are in a threaded region and want to view the value across threads, then select the 'Across Threads' menu.

 

Known Limitations

TotalView does not support on Cray systems:

  • Debugging MPI_Spawn(), OpenMP, or Cray SHMEM programs
  • Compiled EVAL points and expressions.
  • Type transformations for the PGI C++ compiler standard template library collection classes
  • Exception handling for the PGI C++ compiler run time library
  • Spawing a process onto the compute processors
  • Machine partitioning schemes, gang scheduling, or batch systems

Memory debugging (MemoryScape) doesn't work on Hopper. Rogue Wave Software is working on the problem.

Availability

PackagePlatformCategoryVersionModuleInstall DateDate Made Default
TotalView babbage applications/ debugging 8.15.10 totalview/8.15.10 2015-11-03 2015-11-03
TotalView babbage applications/ debugging 8.15.7 totalview/8.15.7 2015-11-03
TotalView babbage applications/ debugging 8T.12.0-1 totalview/8T.12.0-1 2014-01-08 2014-01-08
TotalView cori applications/ debugging 2016.01.06 totalview/2016.01.06 2016-02-02 2016-02-02
TotalView cori applications/ debugging 2016.04.08 totalview/2016.04.08 2016-06-29 2016-06-29
TotalView cori applications/ debugging 8.15.10 totalview/8.15.10 2015-10-16 2015-10-16
TotalView edison applications/ debugging 2016.01.06 totalview/2016.01.06 2016-02-02 2016-02-02
TotalView edison applications/ debugging 2016.04.08 totalview/2016.04.08 2016-06-08 2016-06-08
TotalView edison applications/ debugging 8.15.0 totalview/8.15.0 2015-02-19 2015-02-19