forge OverviewArm Forge brings together Arm DDT and Arm MAP to enable both debugging and profiling in a single package. See the Support section below for help on how to use each tool, or the Arm Forge User Guide for more information.
Arm DDTArm DDT is an advanced debugging tool used for scalar, multi-threaded, and large-scale parallel applications. In addition to traditional debugging features (setting breakpoints, stepping through code, examining variables), DDT also supports attaching to already-running processes and memory debugging. In-depth debugging information is beyond the scope of this guide, and is best answered by the Arm Forge User Guide.
Additional DDT ArticlesIn addition to the information below, the following articles can help you perform specific tasks with DDT:
Launching DDTThe first step in using DDT is to launch the DDT GUI. This can either be launched on the remote machine using X11 forwarding, or by running a remote client on your local machine, and connecting it to the remote machine. The remote client provides a native GUI (for Linux / OS X / Windows) that should be more far more responsive than X11, but requires a little extra setup. It is also useful if you don't have a preconfigured X11 server. To get started using the remote client, follow the Forge Remote Client setup guide. To use X11 forwarding, in a terminal do the following:
$ ssh -X user@<host>.ccs.ornl.gov $ module load forge $ ddt &
Running your jobOnce you have launched a DDT GUI, we can initiate a debugging session from a batch job script using DDT's "Reverse Connect" functionality. This will connect the debug session launched from the batch script to an already running GUI. This is the most widely applicable method of launching, and allows re-use of any setup logic contained in existing batch scripts. (This method can also be easily modified to launch DDT from an interactive batch session.)
- Copy or modify an existing job script. (If you don't have an existing job script, you may wish to read the section on letting DDT submit your job to the queue).
- Include the following near the top of your jobs script:
$ source $MODULESHOME/init/bash # If not already included, to make the module command available module load ddt
- Finally, prefix the
ddt --connect, e.g.:
$ aprun -n 1024 -N 8 ./myprogrambecomes:
$ ddt --connect aprun -n 1024 -N 8 ./myprogram
Offline DebuggingIn addition to debugging interactively, DDT also supports "Offline Debugging". This can be particularly useful if your job takes a long time to schedule (and you're not sure if you'll be available when it runs). DDT will execute you program under the debugger, and write a plain text or HTML report for you to inspect at your convenience. To run your program with DDT's Offline Debugging, modify your existing job script and modify your aprun command such that:
$ aprun -n 1024 -N 8 ./myprogramWould become:
$ ddt --offline=output.html aprun -n 1024 -N 8 ./myprogram
Replacing printf / debug statements with tracepointsAdding a quick debug statement is often a tempting next step when trying to debug an issue, but repeated compile/run cycles can quickly become time consuming. Rather than adding logging statements, you can add tracepoints inside DDT. Tracepoints have the following advantages over debug statements:
- No source code modification - this means there's no need to recompile, and no need to track down and remove logging statements after debugging.
- Scalability - variables can be collected and summarized over thousands of processes without worrying about where/how to store the output, or how to sift through the data afterwards.
- Variables are automatically compared across processes. Variables with differing values across processes are highlighted and sparklines are included to give a quick graphical representation of the distribution on values.
Attaching to a running jobYou can also use DDT to connect to an already-running job. To do so, you must be connected to the system on which the job is running. You do not need to be logged into the job's head node (the node from which
mpirunwas launched), but DDT needs to know the head node. The process is fairly simple:
- Find your job's head node:
- On Titan and Eos, run
qstat -f <jobid> | grep login_node_id. The node listed is the head node.
- On other systems, run
qstat -f <jobid> | grep exec_host. The _first_ node listed is the head node.
- On Titan and Eos, run
- Start DDT by running
module load forgeand then
- When DDT starts, select the option to "Attach to an already running program".
- In that dialog box, make sure the appropriate MPI implementation is selected. If not, click the "Change MPI" button and select the proper one.
- If the job's head node is not listed after the word "Hosts", click on "Choose Hosts".
- Click "Add".
- Type the host name in the resulting dialog box and click "OK".
- To make things faster, uncheck any other hosts listed in the dialog box.
- Click "OK" to return.
- Once DDT has finished scanning, your job should appear in the "Automatically-detected jobs" tab, select it and click the "Attach" button.
Letting DDT submit your job to the queueThis method can be useful when using the Forge Remote Client or when your program doesn't have a complex existing launch script.
module load forge.
- When the GUI starts, click the "Run and debug a program" button.
- In the DDT "Run" dialog, ensure the "Submit to Queue" box is checked.
- Optionally select a queue template file (by clicking "Configure" by the "Submit to Queue" box).
If your typical job scripts are basically only an
apruncommand, the default is fine. If your scripts are more complex, you'll need to create your own template file. The default file can be a good start. If you need help creating one, contact email@example.com or see the Forge User Guide.
- Click the "Parameters" button by the "Submit to Queue" box.
- In the resulting dialog box, select an appropriate walltime limit, account, and queue. Then click "OK".
- Enter your executable in the "Application" box, enter any command line options your executable takes on the "Arguments" line, and select an appropriate number of processes and threads.
- Click "Submit". Your job will be submitted to the queue and your debug session will start once the job begins to run. While it's waiting to start, DDT will display a dialog box displaying
Starting DDT from an interactive-batch job
Note: To tunnel a GUI from a batch job, the
-X PBS option should be used to enable X11 forwarding.
- Start your interactive-batch job with
qsub -I -X ...(
-Xenables X11 forwarding).
module load forge.
- Start DDT with the command
- When the GUI starts, click the "Run and debug a program" button.
- In the DDT "Run" dialog, ensure the "Submit to Queue" box is not checked.
- Enter your executable, number of processors, etc.
- Click "Run" to run the program.
Memory Debugging (on Cray systems)In order to use the memory debugging functionality of DDT on Titan, you need to link against the DDT memory debugging library. (On non-Cray systems DDT can preload the shared library automatically if your program uses dynamic linking). In order to link the memory debugging library:
module load ddt(This determines the location of the library to link).
module load ddt-memdebug(This tells the
CCcompiler wrappers to link the library).
- Re-link your program (e.g. by deleting your binary and running make).
- The behavior of
ddt-memdebugdepends on the current programming environment. For this reason, you may encounter issues if you switch programming environments after
ddt-memdebughas been loaded. To avoid this, please ensure that you unload
ddt-memdebugbefore switching programming environments (you can then load it again).
- The Fortran
ALLOCATEfunction cannot currently be wrapped when using the PGI compiler, so allocations will not be tracked, or protected.
- When using the Cray compiler, some libraries are compiled in such a way that DDT can not collect a backtrace when allocating memory. In this case, DDT can only show the location (rather than the full backtrace) for when memory is allocated.
Debugging scalar/non-MPI programs (Cray systems)Launching a debug session on the Cray systems requires the program be linked with the Cray PMI library. (This happens automatically when linking with MPI.) In addition, DDT must be told not to run your program to the
MPI_Initfunction (as it won't be called). If you are using the Cray compiler wrappers, you can load the
ddt-non-mpimodule (before linking your program) to include the PMI library. The same module should also be loaded prior to running
ddt(to tell DDT not to attempt to run to
MPI_Initduring initialization). Finally, enable the "MPI" option in the DDT run dialog. This will ensure DDT launches your program with
aprun. Using the ddt-non-mpi module with the DDT Remote Client When using the Forge Remote Client, we can't load the
ddt-non-mpi modulein to the client itself. Instead we have three options:
- If using "Reverse Connect", load the module before launching
ddt --connect ...
- Load the
ddt-non-mpimodule inside your "queue template file" (configured via the "Options" dialog).
- Load the module using the "remote script" mechanism while configuring your remote host in the DDT Remote Client. For convenience, you may specify the following file as the remote script:
Arm MAPArm MAP (part of the Arm Forge suite, with DDT) is a profiler for parallel, multithreaded or single threaded C, C++, Fortran and F90 codes. It provides in depth analysis and bottleneck pinpointing to the source line. Unlike most profilers, it's designed to be able to profile pthreads, OpenMP or MPI for parallel and threaded code. MAP aims to be simple to use - there's no need to instrument each source file, or configure.
Linking your program with the MAP Sampler (for Cray systems)In order to collect information about your program, you must link your program with the MAP sampling libraries. When using shared libraries on, MAP can do this automatically at runtime. On Cray systems, the map-static-link and map-dynamic-link modules can help with this.
- module load forge
- module load map-link-static # or map-link-dynamic
- Re-compile or re-link your program.
Do I need to recompile?There's no need to instrument your code with Arm MAP, so there's no strict requirement to recompile. However, if your binary wasn't compiled with the -g compiler flag, MAP won't be able to show you source-line information, so recompiling would be beneficial.
Note: If using the Cray compiler, you may wish to use
-G2 instead of
-g. This will prevent the compiler from disabling most optimizations, which could affect runtime performance.
Generating a MAP output fileArm MAP can generate a profile using the GUI or the command line. The GUI option should look familiar to existing users of DDT, whereas the command line option may offer the smoothest transition when moving from an existing launch configuration. MAP profiles are small in size, and there's generally no configuration required other than your existing aprun command line. To generate a profile using MAP, take an existing queue submission script and modify to include the following:
source $MODULESHOME/init/bash # May already be included if using modules module load forgeAnd then add a prefix your aprun command so that:
aprun -n 128 -N 8 ./myapp a b cwould become:
map --profile aprun -n 128 -N 8 ./myapp a b cOnce your job has completed running, the program's working directory should contain a timestamped .map file such as myapp_1p_1t_2016-01-01_12-00.map.
Profiling a subset of your applicationTo profile only a subset of your application, you can either use the
--start-after=TIMEand its command line options (see
map --helpfor more information), or use the API to have your code tell MAP when to start and stop sampling, as detailed here.
Viewing a MAP profileOnce you have collected a profile, you can then view the information using the map command, either by launching and choosing "Load Profile Data File", or by specifying the file on the command line e.g.
map ./myapp_1p_1t_2016-01-01_12-00.map(The above will require a SSH connection with X11 forwarding, or other remote graphics setup.) An alternative that provides a local, native GUI (for Linux, OS X, or Windows) is to install the Arm Forge Remote Client on your local machine. This client is able to load and view profiles locally (useful when working offline), or remotely (which avoids the need to copy the profile data and corresponding source code to your local machine). The remote client can be used for both Arm DDT and Arm MAP. For more information on how to install and configure the remote client, see the remote client setup page. For more information see the Arm Forge user guide (also available via the "Help" menu in the MAP GUI).
Additional Arm MAP resources