Difference between revisions of "Batch Jobs Moab"
(→Multithreaded + MPI parallel Programs) |
(→Serial Programs) |
||
Line 201: | Line 201: | ||
a) execute: |
a) execute: |
||
<pre> |
<pre> |
||
− | $ msub -N test -l nodes=1:ppn=1,walltime=3:00:00,pmem=5000mb job.sh |
+ | $ msub -q singlenode -N test -l nodes=1:ppn=1,walltime=3:00:00,pmem=5000mb job.sh |
</pre> |
</pre> |
||
or |
or |
||
Line 217: | Line 217: | ||
and execute the modified script without any msub command line options: |
and execute the modified script without any msub command line options: |
||
<pre> |
<pre> |
||
− | $ msub job.sh |
+ | $ msub -q singlenode job.sh |
</pre> |
</pre> |
||
Note, that msub command line options overrule script options. |
Note, that msub command line options overrule script options. |
||
<br> |
<br> |
||
− | |||
== Handling job script options and arguments == |
== Handling job script options and arguments == |
Revision as of 16:23, 9 December 2014
Any kind of calculation on the compute nodes of a bwHPC cluster of tier 2 or 3 requires the user to define calculations as a sequence of commands or single command together with required run time, number of CPU cores and main memory and submit all, i.e., the batch job, to a resource and workload managing software. All bwHPC cluster of tier 2 and 3, including have installed the workload managing software MOAB. Therefore any job submission by the user is to be executed by commands of the MOAB software. MOAB queues and runs user jobs based on fair sharing policies.
This page only describes options and commands that can be used on all bwHPC clusters. Options specific to a single cluster are described in the following separate articles:
- Batch Jobs - bwUniCluster Features
- Batch Jobs - bwForCluster Chemistry Features
- Batch Jobs - ForHLR Features
Overview of:
MOAB commands | Brief explanation |
---|---|
msub | submits a job and queues it in an input queue |
checkjob | displays detailed job state information |
showq | displays information about active, eligible, blocked, and/or recently completed jobs |
showbf | shows what resources are available for immediate use |
showstart | returns start time of submitted job or requested resources |
canceljob | cancels a job |
Contents
1 Job Submission
Batch jobs are submitted by using the command msub. The main purpose of the msub command is to specify the resources that are needed to run the job. msub will then queue the batch job. However, starting of batch job depends on availability of the requested resources and the fair sharing value.
1.1 msub Command
The syntax and use of msub can be displayed via:
$ man msub
msub options can be used from the command line or in your job script.
msub Options | ||
---|---|---|
Command line | Script | Purpose |
-l resources | #MSUB -l resources | Defines the resources that are required by the job. See the description below for this important flag. |
-N name | #MSUB -N name | Gives a user specified name to the job. |
-o filename | #MSUB -o filename | Defines the filename to be used for the standard output stream of the batch job. By default the file with defined filename is placed under your job submit directory. To place under a different location, expand filename by the relative or absolute path of destination. |
-q queue | #MSUB -q queue | Defines the queue class |
-v variable=arg | #MSUB -v variable=arg | Expands the list of environment variables that are exported to the job |
-S Shell | #MSUB -S Shell | Declares the shell (state path+name, e.g. /bin/bash) that interprets the job script |
For cluster specific msub options, read:
1.1.1 msub -l resource_list
The -l option is one of the most important msub options. It is used to specify a number of resource requirements for your job. Multiple resource strings are separated by commas.
msub -l resource_list | ||
---|---|---|
resource | Purpose | |
-l nodes=2:ppn=16 | Number of nodes and number of processes per node | |
-l walltime=600 -l walltime=01:30:00 |
Wall-clock time. Default units are seconds. HH:MM:SS format is also accepted. | |
-l pmem=1000mb | Maximum amount of physical memory used by any single process of the job.
Allowed units are kb, mb, gb. Be aware that processes are either MPI tasks if running MPI parallel jobs or threads if running multithreaded jobs. | |
-l mem=1000mb | Maximum amount of physical memory used by the job.
Allowed units are kb, mb, gb. Be aware that this memory value is the accumulated memory for all MPI tasks or all threads of the job. | |
-l advres=res_name | Specifies the reservation "res_name" required to run the job.
| |
-l naccesspolicy=policy | Specifies how node resources should be accessed, e.g. -l naccesspolicy=singlejob reserves all requested nodes for the job exclusively. Attention, if you request nodes=1:ppn=4 together with singlejob you will be charged for the maximum cores of the node.
|
Note that all compute nodes do not have SWAP space, thus DO NOT specify '-l vmem' or '-l pvmem' or your jobs will not start.
1.1.2 msub -q queues
Queue classes define maximum resources such as walltime, nodes and processes per node and partition of the compute system. Note that queue settings of the bwHPC cluster are not identical, but differ due to their different prerequisites, such as HPC performance, scalability and throughput levels. Details can be found here:
2 Environment Variables for Batch Jobs
Once an eligible compute jobs starts on the compute system, MOAB adds the following variables to the job's environment:
MOAB variables | ||
---|---|---|
Environment variables | Description | |
MOAB_CLASS | Class name | |
MOAB_GROUP | Group name | |
MOAB_JOBID | Job ID | |
MOAB_JOBNAME | Job name | |
MOAB_NODECOUNT | Number of nodes allocated to job | |
MOAB_PARTITION | Partition name the job is running in | |
MOAB_PROCCOUNT | Number of processors allocated to job | |
MOAB_SUBMITDIR | Directory of job submission | |
MOAB_USER | User name |
MOAB environment variables can be used to generalize your job scripts, compare msub examples.
2.1 bwHPC Cluster specific environment variables
Note that bwHPC Cluster may use different resource managers and additional environment variables. Details can be found here:
3 Interactive Jobs
The policy on interactive batch jobs can be found here:
4 msub Examples
4.1 Serial Programs
To submit a serial job that runs the script job.sh and that requires 5000 MB of main memory and 3 hours of wall clock time
a) execute:
$ msub -q singlenode -N test -l nodes=1:ppn=1,walltime=3:00:00,pmem=5000mb job.sh
or
b) add after the initial line of your script job.sh the lines:
#MSUB -l nodes=1:ppn=1
#MSUB -l walltime=3:00:00
#MSUB -l pmem=5000mb
#MSUB -N test
|
and execute the modified script without any msub command line options:
$ msub -q singlenode job.sh
Note, that msub command line options overrule script options.
4.2 Handling job script options and arguments
Job script options and arguments as followed:
$ ./job.sh -n 10
can not be passed while using msub command since those will be interpreted as command line options of msub.
Solution A:
Submit a wrapper script, e.g. wrapper.sh:
$ msub wrapper.sh
which simply contains all options and arguments of job.sh. The script wrapper.sh would at least contain the following lines:
#!/bin/bash
./job.sh -n 10
|
Solution B:
Add after the header of your BASH script job.sh the following lines:
## check if $SCRIPT_FLAGS is "set"
if [ -n "${SCRIPT_FLAGS}" ] ; then
## but if positional parameters are already present
## we are going to ignore $SCRIPT_FLAGS
if [ -z "${*}" ] ; then
set -- ${SCRIPT_FLAGS}
fi
fi
|
These lines modify your BASH script to read options and arguments from the environment variable $SCRIPT_FLAGS. Now submit your script job.sh as followed:
$ msub -v SCRIPT_FLAGS='-n 10' job.sh
4.3 Multithreaded Programs
Multithreaded programs operate faster than serial programs on CPUs with multiple cores. Moreover, multiple threads of one process share resources such as memory.
For multithreaded programs based on Open Multi-Processing (OpenMP) number of threads are defined by the environment variable OMP_NUM_THREADS. By default this variable is set to 1 (OMP_NUM_THREADS=1).
To submit a batch job called OpenMP_Test that runs a fourfold threaded program omp_executable which requires 6000 MByte of total physical memory and total wall clock time of 3 hours:
- generate the script job_omp.sh containing the following lines:
#!/bin/bash
#MSUB -l nodes=1:ppn=4
#MSUB -l walltime=3:00:00
#MSUB -l mem=6000mb
#MSUB -v EXECUTABLE=./omp_executable
#MSUB -v MODULE=<placeholder>
#MSUB -N OpenMP_Test
#Usually you should set
export KMP_AFFINITY=compact,1,0
#export KMP_AFFINITY=verbose,compact,1,0 prints messages concerning the supported affinity
#KMP_AFFINITY Description: https://software.intel.com/en-us/node/524790#KMP_AFFINITY_ENVIRONMENT_VARIABLE
module load ${MODULE}
export OMP_NUM_THREADS=${MOAB_PROCCOUNT}
echo "Executable ${EXECUTABLE} running on ${MOAB_PROCCOUNT} cores with ${OMP_NUM_THREADS} threads"
startexe=${EXECUTABLE}
echo $startexe
exec $startexe
|
Using Intel compiler the environment variable KMP_AFFINITY switches on binding of threads to specific cores and, if necessary, replace <placeholder> with the required modulefile to enable the OpenMP environment and execute the script job_omp.sh without any msub command line options:
$ msub -q singlenode job_omp.sh
Note, that msub command line options overrule script options, e.g.,
$ msub -l mem=2000mb -q singlenode job_omp.sh
overwrites the script setting of 6000 MByte with 2000 MByte.
4.4 MPI parallel Programs
MPI parallel programs run faster than serial programs on multi CPU and multi core systems. N-fold spawned processes of the MPI program, i.e., MPI tasks, run simultaneously and communicate via the Message Passing Interface (MPI) paradigm. MPI tasks do not share memory but can be spawned over different nodes.
Multiple MPI tasks can not be launched by the MPI parallel program itself but via mpirun, e.g. 4 MPI tasks of my_par_program:
$ mpirun -n 4 my_par_program
However, this given command can not be directly included in your msub command for submitting as a batch job to the compute cluster, see above.
Generate a wrapper script job_ompi.sh for OpenMPI containing the following lines:
#!/bin/bash
module load mpi/openmpi/<placeholder_for_version>
mpirun -bind-to-core -bycore -report-bindings my_par_program
|
Attention: Do NOT add mpirun options -n <number_of_processes> or any other option defining processes or nodes, since MOAB instructs mpirun about number of processes and node hostnames. Use ALWAYS the MPI options -bind-to-core and -bycore|-bysocket|-bynode.
Generate a wrapper script for Intel MPI, job_impi.sh containing the following lines:
#!/bin/bash
module load mpi/impi/<placeholder_for_version>
mpiexec.hydra -bootstrap slurm my_par_program
|
Attention: Do NOT add mpirun options -n <number_of_processes> or any other option defining processes or nodes, since MOAB instructs mpirun about number of processes and node hostnames.
Moreover, replace <placeholder_for_version> with the wished version of Intel MPI to enable the MPI environment.
Considering 4 OpenMPI tasks on a single node, each requiring 1000 MByte, and running for 1 hour, execute:
$ msub -l nodes=1:ppn=4,pmem=1000mb,walltime=01:00:00 job_ompi.sh
Launching and running 32 Intel MPI tasks on 4 nodes, each requiring 1000 MByte, and running for 5 hours, execute:
$ msub -l nodes=4:ppn=16,pmem=1000mb,walltime=05:00:00 job_impi.sh
4.5 Multithreaded + MPI parallel Programs
Multithreaded + MPI parallel programs operate faster than serial programs on multi CPUs with multiple cores. All threads of one process share resources such as memory. On the contrary MPI tasks do not share memory but can be spawned over different nodes.
Multiple MPI tasks must be launched by the MPI parallel program mpirun and mpiexec.hydra respectively. For multithreaded programs based on Open Multi-Processing (OpenMP) number of threads are defined by the environment variable OMP_NUM_THREADS. By default this variable is set to 1 (OMP_NUM_THREADS=1).
For OpenMPI a job-script to submit a batch job called job_ompi_omp.sh that runs a MPI program with 4 tasks and an fivefold threaded program ompi_omp_program requiring 6000 MByte of physical memory per process/thread (using 5 threads per MPI task you will get 5*6000 MByte = 30000 MByte per MPI task) and total wall clock time of 3 hours looks like:
#!/bin/bash
#MSUB -l nodes=2:ppn=20
#MSUB -l walltime=03:00:00
#MSUB -l pmem=6000mb
#MSUB -v MPI_MODULE=mpi/ompi
#MSUB -v OMP_NUM_THREADS=5
#MSUB -v MPIRUN_OPTIONS="-bind-to-core -bynode -cpus-per-proc 4 -report-bindings"
#MSUB -v EXECUTABLE=./ompi_omp_program
#MSUB -N test_ompi_omp
module load ${MPI_MODULE}
TASK_COUNT=$((${MOAB_PROCCOUNT}/${OMP_NUM_THREADS}))
echo "${EXECUTABLE} running on ${MOAB_PROCCOUNT} cores with ${TASK_COUNT} MPI-tasks and ${OMP_NUM_THREADS} threads"
startexe="mpirun -n ${TASK_COUNT} ${MPIRUN_OPTIONS} ${EXECUTABLE}"
echo $startexe
exec $startexe
|
Execute the script job_ompi_omp.sh adding the queue class "multinode" to your msub command:
$ msub -q multinode job_ompi_omp.sh
With the mpirun option -bind-to-core MPI tasks and OpenMP threads are bound to physical cores. With the option -bynode that must be set (neighbored) MPI tasks will be attached to different nodes and the value of the option -cpus-per-proc <value> must be set to ${OMP_NUM_THREADS}. The option -report-bindings shows the bindings between MPI tasks and physical cores.
The option -bysocket does not work!!! The mpirun-options -bind-to-core, -bynode and -cpus-per-proc should always be used when running a multithreaded MPI program else your multithreaded MPI program will run only on 1 node.
For Intel MPI a job-script to submit a batch job called job_impi_omp.sh that runs a Intel MPI program with 8 tasks and a tenfold threaded program impi_omp_program requiring 32000 MByte of total physical memory per task and total wall clock time of 6 hours looks like:
#!/bin/bash
#MSUB -l nodes=4:ppn=20
#MSUB -l walltime=06:00:00
#MSUB -l pmem=3200mb
#MSUB -v MPI_MODULE=mpi/impi
#MSUB -v OMP_NUM_THREADS=10
#MSUB -v MPIRUN_OPTIONS="-binding "domain=omp" -print-rank-map -ppn 2 -envall"
#MSUB -v EXE=./impi_omp_program
#MSUB -N test_impi_omp
#If using more than one MPI task per node please set
export KMP_AFFINITY=scatter
#export KMP_AFFINITY=verbose,scatter prints messages concerning the supported affinity
#KMP_AFFINITY Description: https://software.intel.com/en-us/node/524790#KMP_AFFINITY_ENVIRONMENT_VARIABLE
module load ${MPI_MODULE}
TASK_COUNT=$((${MOAB_PROCCOUNT}/${OMP_NUM_THREADS}))
echo "${EXE} running on ${MOAB_PROCCOUNT} cores with ${TASK_COUNT} MPI-tasks and ${OMP_NUM_THREADS} threads"
startexe="mpiexec.hydra -bootstrap slurm ${MPIRUN_OPTIONS} -n ${TASK_COUNT} ${EXE}"
echo $startexe
exec $startexe
|
Using Intel compiler the environment variable KMP_AFFINITY switches on binding of threads to specific cores. If you only run one MPI task per node please set KMP_AFFINITY=compact,1,0.
Execute the script job_impi_omp.sh adding the queue class "multinode" to your msub command:
$ msub -q multinode job_impi_omp.sh
The mpirun option -print-rank-map shows the bindings between MPI tasks and nodes (not very beneficial). The option -binding binds MPI tasks (processes) to a particular processor; domain=omp means that the domain size is determined by the number of threads. In the above examples (2 MPI tasks per node) you could also choose -binding "cell=unit;map=bunch"; this binding maps one MPI process to each socket.
4.6 Chain jobs
A job chain is a sequence of jobs where each job automatically starts its successor. Chain Job handling differs on the bwHPC Clusters. See the cluster-specific pages
5 Status of batch system/jobs
5.1 Start time of job or resources - showstart
The following command can be used by any user to displays the estimated start time of a job based a number of analysis types based on historical usage, earliest available reservable resources, and priority based backlog. To show estimated start time of job <job_ID> enter:
$ showstart -e all <job_ID>
Furthermore start time of resource demands, e.g. 16 processes @ 12 h, can be displayed via:
$ showstart -e all 16@12:00:00
For further options of showstart read the manpage of showstart:
$ man showstart
5.2 List of your submitted jobs - showq
The following command displays information about your active, eligible, blocked, and/or recently completed jobs:
$ showq
The summary of your active jobs shows how many jobs of yours are running, how many processors are in use by your jobs and how many nodes are in use by all active jobs.
For further options of showq read the manpage of showq:
$ man showq
5.3 Shows free resources - showbf
The following command displays what resources are available for immediate use for the whole partition - for queue "singlenode" - for queue "multinode" - for queue "fat":
$ showbf $ showbf -c singlenode $ showbf -c multinode $ showbf -c fat
For further options of showbf read the manpage of showbf:
$ man showbf
5.4 Detailed job information - checkjob
checkjob <jobID> displays detailed job state information and diagnostic output for the (finished) job of <jobID>:
$ checkjob <jobID>
The returned output for finished job ID uc1.000000 reads:
job uc1.000000
AName: test.sh
State: Completed
Completion Code: 0 Time: Thu Jul 31 16:03:32
Creds: user:XXXX group:YYY account:ZZZ class:develop
WallTime: 00:01:06 of 00:10:00
SubmitTime: Thu Jul 31 16:02:18
(Time Queued Total: 00:00:08 Eligible: 00:03:41)
TemplateSets: DEFAULT
NodeMatchPolicy: EXACTNODE
Total Requested Tasks: 1
Req[0] TaskCount: 1 Partition: uc1
Memory >= 4000M Disk >= 0 Swap >= 0
Dedicated Resources Per Task: PROCS: 1 MEM: 4000M
NodeSet=ONEOF:FEATURE:[NONE]
Allocated Nodes:
[uc1n459:1]
SystemID: uc1
SystemJID: uc1.000000
IWD: /pfs/data1/home/ZZZ/YYY/XXX/bwUniCluster
SubmitDir: /pfs/data1/home/ZZZ/YYY/XXX/bwUniCluster
Executable: /opt/moab/spool/moab.job.jCLed6
StartCount: 1
Execution Partition: uc1
Flags: GLOBALQUEUE
StartPriority: 5321
|
For further options of checkjob read the manpage of checkjob:
$ man checkjob
6 Job management
6.1 Canceling own jobs
canceljob <jobID> cancels the own job with <jobID>.
$ canceljob <jobID>
Note that only own jobs can be cancelled. The command:
$ mjobctl -c <jobID>
has the same effect as canceljob <jobID>.