Skip to content
Snippets Groups Projects
Running_OpenMPI.md 8.19 KiB
Newer Older
Lukáš Krupčík's avatar
Lukáš Krupčík committed
Running OpenMPI
==============
Lukáš Krupčík's avatar
Lukáš Krupčík committed

OpenMPI program execution
-------------------------
Lukáš Krupčík's avatar
Lukáš Krupčík committed
The OpenMPI programs may be executed only via the PBS Workload manager, by entering an appropriate queue. On Anselm, the **bullxmpi-1.2.4.1** and **OpenMPI 1.6.5** are OpenMPI based MPI implementations.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### Basic usage

!!! Note "Note"
	Use the mpiexec to run the OpenMPI code.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Example:

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ qsub -q qexp -l select=4:ncpus=16 -I
    qsub: waiting for job 15210.srv11 to start
    qsub: job 15210.srv11 ready

    $ pwd
    /home/username

    $ module load openmpi
    $ mpiexec -pernode ./helloworld_mpi.x
    Hello world! from rank 0 of 4 on host cn17
    Hello world! from rank 1 of 4 on host cn108
    Hello world! from rank 2 of 4 on host cn109
    Hello world! from rank 3 of 4 on host cn110
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

!!! Note "Note"
	Please be aware, that in this example, the directive **-pernode** is used to run only **one task per node**, which is normally an unwanted behaviour (unless you want to run hybrid code with just one MPI and 16 OpenMP tasks per node). In normal MPI programs **omit the -pernode directive** to run up to 16 MPI tasks per each node.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In this example, we allocate 4 nodes via the express queue interactively. We set up the openmpi environment and interactively run the helloworld_mpi.x program. Note that the executable helloworld_mpi.x must be available within the
same path on all nodes. This is automatically fulfilled on the /home and /scratch filesystem.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
You need to preload the executable, if running on the local scratch /lscratch filesystem
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ pwd
    /lscratch/15210.srv11

    $ mpiexec -pernode --preload-binary ./helloworld_mpi.x
    Hello world! from rank 0 of 4 on host cn17
    Hello world! from rank 1 of 4 on host cn108
    Hello world! from rank 2 of 4 on host cn109
    Hello world! from rank 3 of 4 on host cn110
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In this example, we assume the executable helloworld_mpi.x is present on compute node cn17 on local scratch. We call the mpiexec whith the **--preload-binary** argument (valid for openmpi). The mpiexec will copy the executable from cn17 to the /lscratch/15210.srv11 directory on cn108, cn109 and cn110 and execute the program.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

!!! Note "Note"
	MPI process mapping may be controlled by PBS parameters.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
The mpiprocs and ompthreads parameters allow for selection of number of running MPI processes per node as well as number of OpenMP threads per MPI process.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### One MPI process per node

Lukáš Krupčík's avatar
Lukáš Krupčík committed
Follow this example to run one MPI process per node, 16 threads per process.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ qsub -q qexp -l select=4:ncpus=16:mpiprocs=1:ompthreads=16 -I

    $ module load openmpi

    $ mpiexec --bind-to-none ./helloworld_mpi.x
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In this example, we demonstrate recommended way to run an MPI application, using 1 MPI processes per node and 16 threads per socket, on 4 nodes.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### Two MPI processes per node

Lukáš Krupčík's avatar
Lukáš Krupčík committed
Follow this example to run two MPI processes per node, 8 threads per process. Note the options to mpiexec.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ qsub -q qexp -l select=4:ncpus=16:mpiprocs=2:ompthreads=8 -I

    $ module load openmpi

    $ mpiexec -bysocket -bind-to-socket ./helloworld_mpi.x
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In this example, we demonstrate recommended way to run an MPI application, using 2 MPI processes per node and 8 threads per socket, each process and its threads bound to a separate processor socket of the node, on 4 nodes
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### 16 MPI processes per node

Lukáš Krupčík's avatar
Lukáš Krupčík committed
Follow this example to run 16 MPI processes per node, 1 thread per process. Note the options to mpiexec.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ qsub -q qexp -l select=4:ncpus=16:mpiprocs=16:ompthreads=1 -I

    $ module load openmpi

    $ mpiexec -bycore -bind-to-core ./helloworld_mpi.x
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In this example, we demonstrate recommended way to run an MPI application, using 16 MPI processes per node, single threaded. Each process is bound to separate processor core, on 4 nodes.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### OpenMP thread affinity

!!! Note "Note"
	Important!  Bind every OpenMP thread to a core!
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In the previous two examples with one or two MPI processes per node, the operating system might still migrate OpenMP threads between cores. You might want to avoid this by setting these environment variable for GCC OpenMP:
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ export GOMP_CPU_AFFINITY="0-15"
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

or this one for Intel OpenMP:

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ export KMP_AFFINITY=granularity=fine,compact,1,0
Lukáš Krupčík's avatar
Lukáš Krupčík committed
``
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
As of OpenMP 4.0 (supported by GCC 4.9 and later and Intel 14.0 and later) the following variables may be used for Intel or GCC:
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ export OMP_PROC_BIND=true
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ export OMP_PLACES=cores
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

OpenMPI Process Mapping and Binding
------------------------------------------------
Lukáš Krupčík's avatar
Lukáš Krupčík committed
The mpiexec allows for precise selection of how the MPI processes will be mapped to the computational nodes and how these processes will bind to particular processor sockets and cores.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
MPI process mapping may be specified by a hostfile or rankfile input to the mpiexec program. Altough all implementations of MPI provide means for process mapping and binding, following examples are valid for the openmpi only.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### Hostfile

Example hostfile

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    cn110.bullx
    cn109.bullx
    cn108.bullx
    cn17.bullx
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Use the hostfile to control process placement

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ mpiexec -hostfile hostfile ./helloworld_mpi.x
    Hello world! from rank 0 of 4 on host cn110
    Hello world! from rank 1 of 4 on host cn109
    Hello world! from rank 2 of 4 on host cn108
    Hello world! from rank 3 of 4 on host cn17
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In this example, we see that ranks have been mapped on nodes according to the order in which nodes show in the hostfile
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### Rankfile

Lukáš Krupčík's avatar
Lukáš Krupčík committed
Exact control of MPI process placement and resource binding is provided by specifying a rankfile
Lukáš Krupčík's avatar
Lukáš Krupčík committed

!!! Note "Note"
	Appropriate binding may boost performance of your application.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Example rankfile

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    rank 0=cn110.bullx slot=1:0,1
    rank 1=cn109.bullx slot=0:*
    rank 2=cn108.bullx slot=1:1-2
    rank 3=cn17.bullx slot=0:1,1:0-2
    rank 4=cn109.bullx slot=0:*,1:*
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
This rankfile assumes 5 ranks will be running on 4 nodes and provides exact mapping and binding of the processes to the processor sockets and cores
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Explanation:
rank 0 will be bounded to cn110, socket1 core0 and core1
rank 1 will be bounded to cn109, socket0, all cores
rank 2 will be bounded to cn108, socket1, core1 and core2
Lukáš Krupčík's avatar
Lukáš Krupčík committed
rank 3 will be bounded to cn17, socket0 core1, socket1 core0, core1, core2
Lukáš Krupčík's avatar
Lukáš Krupčík committed
rank 4 will be bounded to cn109, all cores on both sockets

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ mpiexec -n 5 -rf rankfile --report-bindings ./helloworld_mpi.x
    [cn17:11180]  MCW rank 3 bound to socket 0[core 1] socket 1[core 0-2]: [. B . . . . . .][B B B . . . . .] (slot list 0:1,1:0-2)
    [cn110:09928] MCW rank 0 bound to socket 1[core 0-1]: [. . . . . . . .][B B . . . . . .] (slot list 1:0,1)
    [cn109:10395] MCW rank 1 bound to socket 0[core 0-7]: [B B B B B B B B][. . . . . . . .] (slot list 0:*)
    [cn108:10406]  MCW rank 2 bound to socket 1[core 1-2]: [. . . . . . . .][. B B . . . . .] (slot list 1:1-2)
    [cn109:10406]  MCW rank 4 bound to socket 0[core 0-7] socket 1[core 0-7]: [B B B B B B B B][B B B B B B B B] (slot list 0:*,1:*)
    Hello world! from rank 3 of 5 on host cn17
    Hello world! from rank 1 of 5 on host cn109
    Hello world! from rank 0 of 5 on host cn110
    Hello world! from rank 4 of 5 on host cn109
    Hello world! from rank 2 of 5 on host cn108
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In this example we run 5 MPI processes (5 ranks) on four nodes. The rankfile defines how the processes will be mapped on the nodes, sockets and cores. The **--report-bindings** option was used to print out the actual process location and bindings. Note that ranks 1 and 4 run on the same node and their core binding overlaps.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
It is users responsibility to provide correct number of ranks, sockets and cores.
Lukáš Krupčík's avatar
Lukáš Krupčík committed

### Bindings verification

Lukáš Krupčík's avatar
Lukáš Krupčík committed
In all cases, binding and threading may be verified by executing for example:
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
```bash
Lukáš Krupčík's avatar
Lukáš Krupčík committed
    $ mpiexec -bysocket -bind-to-socket --report-bindings echo
    $ mpiexec -bysocket -bind-to-socket numactl --show
    $ mpiexec -bysocket -bind-to-socket echo $OMP_NUM_THREADS
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Changes in OpenMPI 1.8
----------------------
Some options have changed in OpenMPI version 1.8.

 |version 1.6.5 |version 1.8.1 |
 | --- | --- |
 |--bind-to-none |--bind-to none |
 |--bind-to-core |--bind-to core |
 |--bind-to-socket |--bind-to socket |
 |-bysocket |--map-by socket |
 |-bycore |--map-by core |
Lukáš Krupčík's avatar
Lukáš Krupčík committed
 |-pernode |--map-by ppr:1:node |