From d9ff9405287dd93faca6f9a97f703a438e714b36 Mon Sep 17 00:00:00 2001 From: Yutaka Ishikawa Date: Fri, 15 Jun 2018 11:55:59 +0900 Subject: [PATCH] mpimcexec: Man page Change-Id: I99ea2821500cc1cfadc912d93c88d308b92ed9cf --- Makefile.in | 1 + arch/x86_64/tools/mpimcexec.1in | 59 +++++++++++++++++++++++++++++++++ configure | 3 +- configure.ac | 1 + 4 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 arch/x86_64/tools/mpimcexec.1in diff --git a/Makefile.in b/Makefile.in index 57362715..fbb83e85 100755 --- a/Makefile.in +++ b/Makefile.in @@ -59,6 +59,7 @@ install: install -m 644 kernel/include/swapfmt.h $(INCDIR); \ mkdir -p -m 755 $(MANDIR)/man1; \ install -m 644 arch/x86_64/tools/mcreboot.1 $(MANDIR)/man1/mcreboot.1; \ + install -m 644 arch/x86_64/tools/mpimcexec.1 $(MANDIR)/man1/mpimcexec.1; \ ;; \ *) \ echo "unknown target $(TARGET)" >&2 \ diff --git a/arch/x86_64/tools/mpimcexec.1in b/arch/x86_64/tools/mpimcexec.1in new file mode 100644 index 00000000..03599baa --- /dev/null +++ b/arch/x86_64/tools/mpimcexec.1in @@ -0,0 +1,59 @@ +.\" Man page for mpimcexec +.\" + +.TH MPIMCEXEC 1 "@MCKERNEL_RELEASE_DATE@" "Version @MCKERNEL_VERSION@" MCKERNEL @MCKERNEL_VERSION@" +.SH NAME +mpimcexec \- run an MPI application on McKernel +.\" + +.\" ---------------------------- SYNOPSIS ---------------------------- +.SH SYNOPSIS +.B mpimcexec \fR [\fIoptions\fR] \fI\fR + +.\" ---------------------------- DESCRIPTION ---------------------------- +.SH DESCRIPTION +mpimcexec is a wrapper script to run an MPI application on McKernels. +It executes the mpiexec command to spawn the mcexec command on Mckernel +on compute nodes, and each mcexec turns to run \fI\fR. + +.\" ---------------------------- OPTIONS ---------------------------- +.SH OPTIONS + +.TP +.B -ppn N, --ppn N, --ranks-per-node N +Specify the number of MPI ranks per node. It is always required. +.TP +.B -n N, --n N, --ranks N +Specify the number of total MPI ranks. +e.g., + $ mpimcexec -n 32 -ppn 4 ./a.out +.br +In the above example, 32 MPI processes are invoked +on eight compute nodes each of which has four processes. +.TP +.B --nodes N +Specify the number of compute nodes. +By default, all nodes, specified by "PJM --mpi proc" option, are used. +.TP +.B --env, -env +Pass an additional environment variable +.TP +.B -m N, --numa N +Specify preferred NUMA node. +.TP +.B -h , ---hostfile +Specify a host file for MPI +.TP +.B --help +Show help message + +.PP +.\" ---------------------------- SEE ALSO ---------------------------- +.SH SEE ALSO +\fBmcexec\fR (1), \fBmpiexec\fR (1) + +.\" ---------------------------- AUTHORS ---------------------------- +.SH AUTHORS +Copyright (C) 2018 McKernel Development Team, RIKEN AICS, Japan + + diff --git a/configure b/configure index 36aced87..49b6c8ac 100755 --- a/configure +++ b/configure @@ -5060,7 +5060,7 @@ ac_config_headers="$ac_config_headers config.h" # POSTK_DEBUG_ARCH_DEP_37 # AC_CONFIG_FILES arch dependfiles separate -ac_config_files="$ac_config_files Makefile executer/user/Makefile executer/user/mcexec.1:executer/user/mcexec.1in executer/user/vmcore2mckdump executer/user/arch/$ARCH/Makefile executer/user/arch/x86_64/Makefile executer/kernel/mcctrl/Makefile executer/kernel/mcctrl/arch/$ARCH/Makefile executer/kernel/mcoverlayfs/Makefile executer/kernel/mcoverlayfs/linux-3.10.0-327.36.1.el7/Makefile executer/kernel/mcoverlayfs/linux-4.0.9/Makefile executer/kernel/mcoverlayfs/linux-4.6.7/Makefile executer/include/qlmpilib.h kernel/Makefile kernel/Makefile.build kernel/include/swapfmt.h arch/x86_64/tools/mcreboot-attached-mic.sh arch/x86_64/tools/mcshutdown-attached-mic.sh arch/x86_64/tools/mcreboot-builtin-x86.sh arch/x86_64/tools/mcreboot-smp-x86.sh arch/x86_64/tools/mcstop+release-smp-x86.sh arch/x86_64/tools/mcoverlay-destroy-smp-x86.sh arch/x86_64/tools/mcoverlay-create-smp-x86.sh arch/x86_64/tools/eclair-dump-backtrace.exp arch/x86_64/tools/mcshutdown-builtin-x86.sh arch/x86_64/tools/mcreboot.1:arch/x86_64/tools/mcreboot.1in arch/x86_64/tools/mpimcexec arch/x86_64/tools/irqbalance_mck.service arch/x86_64/tools/irqbalance_mck.in tools/mcstat/Makefile" +ac_config_files="$ac_config_files Makefile executer/user/Makefile executer/user/mcexec.1:executer/user/mcexec.1in executer/user/vmcore2mckdump executer/user/arch/$ARCH/Makefile executer/user/arch/x86_64/Makefile executer/kernel/mcctrl/Makefile executer/kernel/mcctrl/arch/$ARCH/Makefile executer/kernel/mcoverlayfs/Makefile executer/kernel/mcoverlayfs/linux-3.10.0-327.36.1.el7/Makefile executer/kernel/mcoverlayfs/linux-4.0.9/Makefile executer/kernel/mcoverlayfs/linux-4.6.7/Makefile executer/include/qlmpilib.h kernel/Makefile kernel/Makefile.build kernel/include/swapfmt.h arch/x86_64/tools/mcreboot-attached-mic.sh arch/x86_64/tools/mcshutdown-attached-mic.sh arch/x86_64/tools/mcreboot-builtin-x86.sh arch/x86_64/tools/mcreboot-smp-x86.sh arch/x86_64/tools/mcstop+release-smp-x86.sh arch/x86_64/tools/mcoverlay-destroy-smp-x86.sh arch/x86_64/tools/mcoverlay-create-smp-x86.sh arch/x86_64/tools/eclair-dump-backtrace.exp arch/x86_64/tools/mcshutdown-builtin-x86.sh arch/x86_64/tools/mcreboot.1:arch/x86_64/tools/mcreboot.1in arch/x86_64/tools/mpimcexec arch/x86_64/tools/mpimcexec.1:arch/x86_64/tools/mpimcexec.1in arch/x86_64/tools/irqbalance_mck.service arch/x86_64/tools/irqbalance_mck.in tools/mcstat/Makefile" if test "$TARGET" = "smp-x86"; then @@ -5796,6 +5796,7 @@ do "arch/x86_64/tools/mcshutdown-builtin-x86.sh") CONFIG_FILES="$CONFIG_FILES arch/x86_64/tools/mcshutdown-builtin-x86.sh" ;; "arch/x86_64/tools/mcreboot.1") CONFIG_FILES="$CONFIG_FILES arch/x86_64/tools/mcreboot.1:arch/x86_64/tools/mcreboot.1in" ;; "arch/x86_64/tools/mpimcexec") CONFIG_FILES="$CONFIG_FILES arch/x86_64/tools/mpimcexec" ;; + "arch/x86_64/tools/mpimcexec.1") CONFIG_FILES="$CONFIG_FILES arch/x86_64/tools/mpimcexec.1:arch/x86_64/tools/mpimcexec.1in" ;; "arch/x86_64/tools/irqbalance_mck.service") CONFIG_FILES="$CONFIG_FILES arch/x86_64/tools/irqbalance_mck.service" ;; "arch/x86_64/tools/irqbalance_mck.in") CONFIG_FILES="$CONFIG_FILES arch/x86_64/tools/irqbalance_mck.in" ;; "tools/mcstat/Makefile") CONFIG_FILES="$CONFIG_FILES tools/mcstat/Makefile" ;; diff --git a/configure.ac b/configure.ac index 7e6d5078..320e4710 100644 --- a/configure.ac +++ b/configure.ac @@ -569,6 +569,7 @@ AC_CONFIG_FILES([ arch/x86_64/tools/mcshutdown-builtin-x86.sh arch/x86_64/tools/mcreboot.1:arch/x86_64/tools/mcreboot.1in arch/x86_64/tools/mpimcexec + arch/x86_64/tools/mpimcexec.1:arch/x86_64/tools/mpimcexec.1in arch/x86_64/tools/irqbalance_mck.service arch/x86_64/tools/irqbalance_mck.in tools/mcstat/Makefile