Cleaning up Utility

mpicleanup

Clean up the environment after an abnormally terminated MPI run under the mpiexec.hydra process manager.

Syntax

mpicleanup [ -i <input_file> | -t -f <hostsfile> ] [ -r <rshcmd> ] \

[ -b <branch_count> ] [-p] [-s | -d] [-h] [-V]

or

mpicleanup [ --input <input_file> | --total --file <hostsfile> ] \

[ --rsh <rshcmd> ] [ --branch <branch_count> ] [ --parallel ] \

[ --silent | --verbose ] [ --help ] [ --version ]

Arguments

-i <input_file> |
--input <input_file>

Specify the input file generated by mpiexec.hydra. The default value is mpiexec_${username}_$PPID.log located in the temporary directory determined by the values of the I_MPI_TMPDIR or TMPDIR environment variables, or in the /tmp directory.

-t | --total

Use the total mode to stop all user processes on the specified machines. This option is not supported for the root user.

-f <hostsfile> |

--file <hostsfile>

Specify the file containing the list of machines to clean up.

-r <rshcmd> |

--rsh <rshcmd>

Specify the remote shell to use. The default shell is ssh.

-b <branch_count> |
--branch <branch_count>

Define the number of the child processes. The default value is 32.

-p |

--parallel

Use the parallel launch mode. This option is only applicable if all hosts are available. Otherwise a part of machines may stay in an undefined state.

-s | --silent

Suppress extra output generation.

-d | --verbose

Output verbose information.

-h | --help

Display a help message.

-V | --version

Display IntelĀ® MPI Library version information.

Description

Use this command to clean up the environment after an abnormal MPI job termination.

For example, use the following command to stop processes mentioned in the input file generated by the prior mpiexec.hydra invocation:

$ mpicleanup

or

$ mpicleanup --input /path/to/input.file

Use the following command to stop all your user processes on the machines specified in the hostsfile file:

$ mpicleanup --file hostsfile --total