Difference between revisions of "DDT"

From UFRC
Jump to navigation Jump to search
 
(25 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Software]][[Category:Development]]
+
[[Category:Software]][[Category:Utility]]
 
{|<!--CONFIGURATION: REQUIRED-->
 
{|<!--CONFIGURATION: REQUIRED-->
 
|{{#vardefine:app|DDT}}
 
|{{#vardefine:app|DDT}}
|{{#vardefine:url|http://www.allinea.com/products/ddt}}
+
|{{#vardefine:url|https://www.linaroforge.com/}}
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
Line 14: Line 14:
 
|}
 
|}
 
<!--BODY-->
 
<!--BODY-->
Allinea DDT is a graphical source code debugging analysis tool with the power that you need to take control of software bugs whenever they occur, making it simpler to solve even the most complex multi-threaded or multi-process software problems. This installation Includes Allinea DDT, MAP for performance analysis, and Allinea Reports for characterizing and understanding the performance of HPC applications.  
+
Linaro Forge combines Linaro DDT, the leading debugger for time-saving high performance application debugging, Linaro MAP, the trusted performance profiler for invaluable optimization advice across native and Python HPC codes, and Linaro Performance Reports for advanced reporting capabilities. Linaro DDT and Linaro MAP are also available as standalone products.
 
 
This module enables the use of the Allinea DDT, MAP, and Reports tools.
 
  
 
==Using DDT==  
 
==Using DDT==  
First, download the Allinea Forge remote client and install it on your computer:
+
First, download the Linaro Forge remote client and install it on your computer:
 
 
* http://www.allinea.com/products/forge/download
 
  
 +
* https://www.linaroforge.com/freeTrial/
 
'''IMPORTANT NOTE''':  
 
'''IMPORTANT NOTE''':  
Please make sure that the version of Allinea Forge remote client installed on your computer is consistent with the version of Allinea Forge module you use on hipergator.  
+
Please make sure that the version of Arm Forge remote client installed on your computer is consistent with the version of Arm Forge module you use on hipergator. The instructions below assume that the version of your Arm Forge local client is version 23.0.
  
 
Create a batch submission script for the application you want to debug as though you were going to submit it to the queue. Be sure that you add the following sequence before the <code>mpiexec</code> command in your script:
 
Create a batch submission script for the application you want to debug as though you were going to submit it to the queue. Be sure that you add the following sequence before the <code>mpiexec</code> command in your script:
  
<pre>ddt --connect --debug --log ddt-debug.log \</pre>
+
<pre>ddt --connect --debug --log ddt-debug.log </pre>
 
 
If you need more help creating the script, please use the example job script further down the page. Then, proceed with the steps below.  Note that where "gui5" is specified, you can use "gui3", "gui4" or "gui6" as well.
 
 
 
# Start the remote client on your personal device
 
# In the "Remote Launch" pulldown menu, select "Configure..."
 
# Click "Add" and fill in the following information: <br> '''Connection Name:''' ufrc-ddt <br> '''Host Name:''' <username>@hpg2.rc.ufl.edu <username>@gui5.ufhpc <br> '''Remote Installation Directory:''' /apps/allinea/forge/6.0 <br> '''Remote Script:''' <leave blank>
 
# Click "OK"
 
# Click "Close"
 
# On the main screen, select 'ufrc-ddt' from the Remote Launch pulldown menu
 
# From another window (PuTTY/Terminal/etc.), log into hpg2.rc.ufl.edu as you normally would.
 
# Modify the following command appropriately and use it to schedule your job:
 
 
 
<source lang=bash>cd /ufrc/<group>/<username>/example-directory
 
sbatch example-job
 
</source>
 
  
 +
For newer (3.x+) builds of OpenMPI, you may need to use,
  
It may take up to 90 seconds for your job to start; once it does, you will get a connection request from ddt running your job. Accept the request and you should be ready to start debugging your application.  
+
<pre>ddt --connect --mpi='OpenMPI (Compatibility)' <some_mpi_executable></pre>
 
+
<div class="mw-collapsible mw-collapsed" style="width:70%; padding: 5px; border: 1px solid gray;">
==Example Job Script==
+
''Expand this section to view reference example.''
<source lang=bash>
+
<div class="mw-collapsible-content" style="padding: 5px;">
 +
<pre>
 
#!/bin/bash
 
#!/bin/bash
 
#SBATCH --job-name=example-job  #A name for your job
 
#SBATCH --job-name=example-job  #A name for your job
Line 61: Line 45:
 
#SBATCH --mem-per-cpu=2000mb  #Per processor memory request
 
#SBATCH --mem-per-cpu=2000mb  #Per processor memory request
 
#SBATCH --time=12:00:00      #Walltime in hh:mm:ss or d-hh:mm:ss
 
#SBATCH --time=12:00:00      #Walltime in hh:mm:ss or d-hh:mm:ss
#SBATCH --partition=hpg2-dev
+
#SBATCH --partition=hpg-dev
  
 
module load <modules_required_for_your_application>
 
module load <modules_required_for_your_application>
module load ddt/7.0.4
+
module load ddt/23.0
  
 
#mpiexec  ./main > resid.dat
 
#mpiexec  ./main > resid.dat
ddt --connect --debug --log ddt-debug.log \
+
ddt --connect --debug --log ddt-debug.log mpiexec ./main > resid.dat
  mpiexec ./main > resid.dat
+
</pre>
</source>
+
</div>
 +
</div>
 +
Submit the job with
 +
<pre>cd /blue/<group>/<username>/example-directory
 +
sbatch example-job </pre>
 +
Next, start a desktop or console session in OnDemand.
 +
 
 +
Once both your debugging job and console or Desktop session are running you can connect:
 +
 
 +
# Start the remote client GUI in the OnDemand session with
 +
module load ddt
 +
forge
 +
# In the "Remote Launch" pulldown menu, select "Configure..."
 +
# Click "Add" and fill in the following information: <br> '''Connection Name:''' ufrc-ddt <br> '''Host Name:''' <username>@GUI_NODE.rc.ufl.edu<br> '''Remote Installation Directory:''' /apps/arm/forge/23.0 <br> '''Remote Script:''' <leave blank> <br>Note that GUI_NODE corresponds to the gui server the gui job is running on e.g. i21a-s3.
 +
# Click "OK"
 +
# Click "Close"
 +
# On the main screen, select 'ufrc-ddt' from the Remote Launch pulldown menu
 +
 
 +
You will get a connection request from ddt running your job. Accept the request and you should be ready to start debugging your application.
 +
 
 +
==SSH Tunnel==
 +
If you would prefer to run the Forge client on your local computer you'll have to forward the port DDT listens on to your local computer. Once you know what compute node and port DDT is running on you can create an ssh tunnel from your local computer to the ddt instance. E.g.
 +
ssh -N -L 8080:c12345a-s42.ufhpc:37546 albert.gator@hpg.rc.ufl.edu
  
 
<!--Modules-->
 
<!--Modules-->
==Required Modules==
+
==Environment Modules==
 
+
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
===Serial===
 
* {{#lowercase:{{#var:app}}}}
 
<!--===Parallel (OpenMP)===
 
* intel
 
* {{#var:app}}
 
===Parallel (MPI)===
 
* intel
 
* openmpi
 
* {{#var:app}}
 
-->
 
 
==System Variables==
 
==System Variables==
* HPC_{{#uppercase:{{#var:app}}}}_DIR
+
* HPC_{{uc:{{#var:app}}}}_DIR
* HPC_{{#uppercase:{{#var:app}}}}_BIN
+
* HPC_{{uc:{{#var:app}}}}_BIN
 
<!--Configuration-->
 
<!--Configuration-->
 
{{#if: {{#var: conf}}|==Configuration==
 
{{#if: {{#var: conf}}|==Configuration==

Latest revision as of 19:24, 30 October 2023

Linaro Forge combines Linaro DDT, the leading debugger for time-saving high performance application debugging, Linaro MAP, the trusted performance profiler for invaluable optimization advice across native and Python HPC codes, and Linaro Performance Reports for advanced reporting capabilities. Linaro DDT and Linaro MAP are also available as standalone products.

Using DDT

First, download the Linaro Forge remote client and install it on your computer:

IMPORTANT NOTE: Please make sure that the version of Arm Forge remote client installed on your computer is consistent with the version of Arm Forge module you use on hipergator. The instructions below assume that the version of your Arm Forge local client is version 23.0.

Create a batch submission script for the application you want to debug as though you were going to submit it to the queue. Be sure that you add the following sequence before the mpiexec command in your script:

ddt --connect --debug --log ddt-debug.log 

For newer (3.x+) builds of OpenMPI, you may need to use,

ddt --connect --mpi='OpenMPI (Compatibility)' <some_mpi_executable>

Expand this section to view reference example.

#!/bin/bash
#SBATCH --job-name=example-job  #A name for your job
#SBATCH --output my_job-%j.out #Output File
#SBATCH --error my_job-%j.err  #Error File
#SBATCH --mail-type=FAIL,END  #What emails you want
#SBATCH --mail-user=<username>@ufl.edu   #Where
#SBATCH --nodes=1     #No. of processors requested
#SBATCH --ntasks=1    #Total no. of  processors
#SBATCH --cpus-per-task=1    #No. CPUs per task
#SBATCH --mem-per-cpu=2000mb   #Per processor memory request
#SBATCH --time=12:00:00       #Walltime in hh:mm:ss or d-hh:mm:ss
#SBATCH --partition=hpg-dev

module load <modules_required_for_your_application>
module load ddt/23.0

#mpiexec  ./main > resid.dat
ddt --connect --debug --log ddt-debug.log mpiexec ./main > resid.dat

Submit the job with

cd /blue/<group>/<username>/example-directory 
sbatch example-job 

Next, start a desktop or console session in OnDemand.

Once both your debugging job and console or Desktop session are running you can connect:

  1. Start the remote client GUI in the OnDemand session with
module load ddt
forge
  1. In the "Remote Launch" pulldown menu, select "Configure..."
  2. Click "Add" and fill in the following information:
    Connection Name: ufrc-ddt
    Host Name: <username>@GUI_NODE.rc.ufl.edu
    Remote Installation Directory: /apps/arm/forge/23.0
    Remote Script: <leave blank>
    Note that GUI_NODE corresponds to the gui server the gui job is running on e.g. i21a-s3.
  3. Click "OK"
  4. Click "Close"
  5. On the main screen, select 'ufrc-ddt' from the Remote Launch pulldown menu

You will get a connection request from ddt running your job. Accept the request and you should be ready to start debugging your application.

SSH Tunnel

If you would prefer to run the Forge client on your local computer you'll have to forward the port DDT listens on to your local computer. Once you know what compute node and port DDT is running on you can create an ssh tunnel from your local computer to the ddt instance. E.g.

ssh -N -L 8080:c12345a-s42.ufhpc:37546 albert.gator@hpg.rc.ufl.edu

Environment Modules

Run module spider DDT to find out what environment modules are available for this application.

System Variables

  • HPC_DDT_DIR
  • HPC_DDT_BIN