Skip to content

Commit

Permalink
Merge pull request #278 from ARCHER2-HPC/jsindt-patch-1
Browse files Browse the repository at this point in the history
Update debug.md
  • Loading branch information
welucas2 committed Jul 7, 2021
2 parents e0212d6 + 6dd41c9 commit f4dc4d3
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/user-guide/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,25 @@ First, load `valgrind4hpc`:

module load valgrind4hpc

To run valgrind4hpc, first reserve the resources you will use with `salloc`.
The following reservation request is for 2 nodes (256 physical cores) for 20
minutes on the short queue:

auser@uan01:> salloc --nodes=2 --tasks-per-node=128 --cpus-per-task=1 \
--time=00:20:00 --partition=standard --qos=short \
--reservation=shortqos --hint=nomultithread \
--distribution=block:block --account=[budget code]

Once your allocation is ready, Use valgrind4hpc to run and profile your
executable. To test an executable called `my_executable` that requires two
arguments `arg1` and `arg2` on 2 nodes and 256 processes, run:

valgrind4hpc --tool=memcheck --num-ranks=256 my_executable -- arg1 arg2

In particular, note the `--` separating the executable from the
arguments (this is not necessary if your executable takes no arguments).

<!---
Valgrind4hpc will launch an srun job to run the executable while it
profiles. To test an executable called `my_executable` that requires two
arguments `arg1` and `arg2` on two nodes and 256 processes, run:
Expand All @@ -310,6 +329,7 @@ In particular, note the `--` separating the executable from the
arguments (this is not necessary if your executable takes no arguments).
The `--launcher-args="arguments"` allow you to set launcher flags for
`srun`.
--->

Valgrind4hpc only supports certain tools found in valgrind. These are:
memcheck, helgrind, exp-sgcheck, or drd. The
Expand Down

0 comments on commit f4dc4d3

Please sign in to comment.