total-view.md

# Total View

TotalView is a GUI-based source code multi-process, multi-thread debugger.

## License and Limitations for Anselm Users

On Anselm users can debug OpenMP or MPI code that runs up to 64 parallel processes. These limitation means that:

```console
    1 user can debug up 64 processes, or
    32 users can debug 2 processes, etc.
```

Debugging of GPU accelerated codes is also supported.

You can check the status of the licenses here:

```console
$ cat /apps/user/licenses/totalview_features_state.txt

    # totalview
    # -------------------------------------------------
    # FEATURE                       TOTAL   USED AVAIL
    # -------------------------------------------------
    TotalView_Team                     64      0     64
    Replay                             64      0     64
    CUDA                               64      0     64
```

## Compiling Code to Run With TotalView

### Modules

Load all necessary modules to compile the code. For example:

```console
$ ml intel **or** ml foss
```

Load the TotalView module:

```console
$ ml totalview/8.12
```

Compile the code:

```console
$ mpicc -g -O0 -o test_debug test.c
$ mpif90 -g -O0 -o test_debug test.f
```

### Compiler Flags

Before debugging, you need to compile your code with theses flags:

!!! note
    \* **-g** : Generates extra debugging information usable by GDB. **-g3** includes even more debugging information. This option is available for GNU and INTEL C/C++ and Fortran compilers.
    \* **-O0** : Suppress all optimizations.

## Starting a Job With TotalView

Be sure to log in with an X window forwarding enabled. This could mean using the -X in the ssh:

```console
local $ ssh -X username@anselm.it4i.cz
```

Other options is to access login node using VNC. Please see the detailed information on how to use graphic user interface on Anselm.

From the login node an interactive session with X windows forwarding (-X option) can be started by following command:

```console
$ qsub -I -X -A NONE-0-0 -q qexp -lselect=1:ncpus=16:mpiprocs=16,walltime=01:00:00
```

Then launch the debugger with the totalview command followed by the name of the executable to debug.

### Debugging a Serial Code

To debug a serial code use:

```console
$ totalview test_debug
```

### Debugging a Parallel Code - Option 1

To debug a parallel code compiled with **OpenMPI** you need to setup your TotalView environment:

!!! hint
    To be able to run parallel debugging procedure from the command line without stopping the debugger in the mpiexec source code you have to add the following function to your `~/.tvdrc` file:

```console
    proc mpi_auto_run_starter {loaded_id} {
        set starter_programs {mpirun mpiexec orterun}
        set executable_name [TV::symbol get $loaded_id full_pathname]
        set file_component [file tail $executable_name]

        if {[lsearch -exact $starter_programs $file_component] != -1} {
            puts "*************************************"
            puts "Automatically starting $file_component"
            puts "*************************************"
            dgo
        }
    }

    # Append this function to TotalView's image load callbacks so that
    # TotalView run this program automatically.

    dlappend TV::image_load_callbacks mpi_auto_run_starter
```

The source code of this function can be also found in

```console
$ /apps/mpi/openmpi/intel/1.6.5/etc/openmpi-totalview.tcl
```

!!! note
    You can also add only following line to you ~/.tvdrc file instead of the entire function:
    **source /apps/mpi/openmpi/intel/1.6.5/etc/openmpi-totalview.tcl**

You need to do this step only once.

Now you can run the parallel debugger using:

```console
$ mpirun -tv -n 5 ./test_debug
```

When following dialog appears click on "Yes"

![](../../../img/totalview1.png)

At this point the main TotalView GUI window will appear and you can insert the breakpoints and start debugging:

![](../../../img/totalview2.png)

### Debugging a Parallel Code - Option 2

Other option to start new parallel debugging session from a command line is to let TotalView to execute mpirun by itself. In this case user has to specify a MPI implementation used to compile the source code.

The following example shows how to start debugging session with Intel MPI:

```console
$ ml intel
$ ml totalview
$ totalview -mpi "Intel MPI-Hydra" -np 8 ./hello_debug_impi
```

After running previous command you will see the same window as shown in the screenshot above.

More information regarding the command line parameters of the TotalView can be found TotalView Reference Guide, Chapter 7: TotalView Command Syntax.

## Documentation

[1] The [TotalView documentation](http://www.roguewave.com/support/product-documentation/totalview-family.aspx#totalview) web page is a good resource for learning more about some of the advanced TotalView features.