zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: support method/spawn as mpirunDebug command-line options

Browse Source
This commit is contained in:
Mark Olesen
2017-11-04 17:25:26 +01:00
parent 507486194e
commit 061a85858f
1 changed files with 140 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
bin/mpirunDebug
View File

@ -4,7 +4,7 @@
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration | # \\ / O peration |
# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation # \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
# \\/ M anipulation | # \\/ M anipulation | Copyright (C) 2017 OpenCFD Ltd.
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# License # License
# This file is part of OpenFOAM. # This file is part of OpenFOAM.
@ -26,50 +26,90 @@
# mpirunDebug # mpirunDebug
# #
# Description # Description
# Driver script to run mpi jobs with the processes in separate # Driver script to run mpi jobs with the processes in a separate XTerm
# windows or to separate log files. # or to separate log files.
# Requires bash on all processors. # Requires bash on all processors.
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
usage() {
if [ `uname -s` = Linux ] exec 1>&2
then while [ "$#" -ge 1 ]; do echo "$1"; shift; done
ECHO='echo -e'
else
ECHO='echo'
fi
usage()
{
cat<<USAGE cat<<USAGE
Usage: ${0##*/} -np <dd> <executable> <args> Usage: ${0##*/} [OPTION] -np <N> <executable> <args>
* This will run like mpirun but with each process in an XTerm options:
-method=MODE Run mode
(0) normal
(1) gdb+xterm
(2) gdb
(3) log
(4) log+xterm
(5) xterm+valgrind
(6) gperftools(callgrind)
-spawn=TYPE Spawn type: (1) local (2) remote
-log Alias for -method=3
-local Alias for -spawn=1
-yes Start without additional prompt
-help Print the usage
Invoke mpirun but with each process in a separate XTerm, or to separate logfile
USAGE USAGE
exit 1 exit 1
} }
unset nProcs exec args case "$(uname -s)" in
Linux)
ECHO='echo -e'
;;
*)
ECHO='echo'
;;
esac
while [ "$1" != "" ] unset nProcs appName appArgs
unset method spawn optNoAsk
# parse options
while [ "$#" -gt 0 ]
do do
echo "$1" # echo "$1" 1>&2
case $1 in case "$1" in
-help)
usage
;;
-method=[0-6])
method="${1#*=}"
;;
-spawn=[1-2])
spawn="${1#*=}"
;;
-log)
method=3
;;
-local)
spawn=1
;;
-yes)
optNoAsk=true
;;
-np) -np)
nProcs=$2 nProcs=$2
shift shift
;; ;;
*) *)
if [ ! "$exec" ] if [ -z "$appName" ]
then then
exec=$1 appName="$1"
elif [ ! "$args" ]
then
args="\"$1\""
else else
args="$args \"$1\"" appArgs="${appArgs}${appArgs:+ }\"$1\""
fi fi
;; ;;
esac esac
@ -77,54 +117,61 @@ do
done done
echo "nProcs=$nProcs" echo "nProcs=$nProcs"
echo "exec=$exec" echo "exec=$appName"
echo "args=$args" echo "args=$appArgs"
[ "$nProcs" ] || usage [ -n "$nProcs" ] || usage
[ "$args" ] || usage [ -n "$appArgs" ] || usage
[ "$exec" ] || usage [ -n "$appName" ] || usage
exec=`which $exec` exec=$(command -v $appName)
if [ ! -x "$exec" ] [ -x "$exec" ] || {
then echo "Cannot find executable $appName or is not executable"
echo "Cannot find executable $exec or is not executable"
usage usage
fi }
if [ ! "$PWD" ] [ -n "$PWD" ] || PWD=$(pwd)
then
PWD=`pwd`
fi
echo "run $args" > $PWD/gdbCommands echo "run $appArgs" > $PWD/gdbCommands
echo "where" >> $PWD/gdbCommands echo "where" >> $PWD/gdbCommands
echo "Constructed gdb initialization file $PWD/gdbCommands" echo "Constructed gdb initialization file $PWD/gdbCommands"
$ECHO "Choose running method: 0)normal 1)gdb+xterm 2)gdb 3)log 4)log+xterm 5)xterm+valgrind 6)gperftools(callgrind): \c" # Choose method
read method if [ -z "$method" ]
case "$method" in then
0 | 1 | 2 | 3 | 4 | 5 | 6) $ECHO "Choose running method: 0)normal 1)gdb+xterm 2)gdb 3)log 4)log+xterm 5)xterm+valgrind 6)gperftools(callgrind): \c"
read method
case "$method" in
0 | 1 | 2 | 3 | 4 | 5 | 6)
# okay # okay
;; ;;
*) *)
usage usage
;; ;;
esac esac
fi
$ECHO "Run all processes local or distributed? 1)local 2)remote: \c" # Choose spawn
read spawn if [ -z "$spawn" ]
if [ "$spawn" -ne 1 -a "$spawn" -ne 2 ]
then then
$ECHO "Run all processes local or distributed? 1)local 2)remote: \c"
read spawn
case "$spawn" in
1 | 2)
# okay
;;
*)
usage usage
;;
esac
fi fi
# check ~/.$WM_PROJECT/$WM_PROJECT_VERSION/ # check ~/.$WM_PROJECT/$WM_PROJECT_VERSION/
# check ~/.$WM_PROJECT/ # check ~/.$WM_PROJECT/
# check <installedProject>/etc/ # check <installedProject>/etc/
if [ "$WM_PROJECT" ] if [ -n "$WM_PROJECT" ]
then then
for i in \ for i in \
$HOME/.$WM_PROJECT/$WM_PROJECT_VERSION \ $HOME/.$WM_PROJECT/$WM_PROJECT_VERSION \
$HOME/.$WM_PROJECT \ $HOME/.$WM_PROJECT \
@ -143,7 +190,7 @@ fi
# Source OpenFOAM settings if OpenFOAM environment not set. # Source OpenFOAM settings if OpenFOAM environment not set.
# attempt to preserve the installation directory 'FOAM_INST_DIR' # attempt to preserve the installation directory 'FOAM_INST_DIR'
# use FOAM_SETTINGS to pass command-line settings # use FOAM_SETTINGS to pass command-line settings
if [ "$FOAM_INST_DIR" ] if [ -n "$FOAM_INST_DIR" ]
then then
sourceFoam="FOAM_INST_DIR=$FOAM_INST_DIR . $sourceFoam $FOAM_SETTINGS" sourceFoam="FOAM_INST_DIR=$FOAM_INST_DIR . $sourceFoam $FOAM_SETTINGS"
else else
@ -162,49 +209,53 @@ for ((proc=0; proc<$nProcs; proc++))
do do
procCmdFile="$PWD/processor${proc}.sh" procCmdFile="$PWD/processor${proc}.sh"
procLog="processor${proc}.log" procLog="processor${proc}.log"
geom="-geometry 120x15+$xpos+$ypos" xterm="xterm -font fixed -title processor${proc} -geometry 120x15+$xpos+$ypos"
unset node
case "$WM_MPLIB" in case "$WM_MPLIB" in
*OPENMPI) *OPENMPI)
node="-np 1 " node="-np 1 "
;; ;;
*)
node=""
esac esac
echo "#!/bin/bash" > $procCmdFile echo "#!/bin/bash" > $procCmdFile
echo "$sourceFoam" >> $procCmdFile
echo "cd $PWD" >> $procCmdFile
case "$method" in case "$method" in
0) 0)
echo "$sourceFoam; cd $PWD; $exec $args | tee $procLog" >> $procCmdFile
echo "${node}$procCmdFile" >> $PWD/mpirun.schema echo "${node}$procCmdFile" >> $PWD/mpirun.schema
echo "$exec $appArgs | tee $procLog" >> $procCmdFile
;; ;;
1) 1)
echo "$sourceFoam; cd $PWD; gdb -command $PWD/gdbCommands $exec 2>&1 | tee $procLog; read dummy" >> $procCmdFile echo "${node}$xterm -e $procCmdFile" >> $PWD/mpirun.schema
#echo "$sourceFoam; cd $PWD; $exec $args; read dummy" >> $procCmdFile echo "gdb -command $PWD/gdbCommands $exec 2>&1 | tee $procLog"
echo "${node}xterm -font fixed -title 'processor'$proc $geom -e $procCmdFile" >> $PWD/mpirun.schema echo "read dummy"
;; ;;
2) 2)
echo "$sourceFoam; cd $PWD; gdb -command $PWD/gdbCommands $exec > $procLog 2>&1" >> $procCmdFile
echo "${node}$procCmdFile" >> $PWD/mpirun.schema echo "${node}$procCmdFile" >> $PWD/mpirun.schema
echo "gdb -command $PWD/gdbCommands $exec > $procLog 2>&1"
;; ;;
3) 3)
echo "$sourceFoam; cd $PWD; $exec $args > $procLog 2>&1" >> $procCmdFile
echo "${node}$procCmdFile" >> $PWD/mpirun.schema echo "${node}$procCmdFile" >> $PWD/mpirun.schema
echo "$exec $appArgs > $procLog 2>&1"
;; ;;
4) 4)
echo "$sourceFoam; cd $PWD; $exec $args 2>&1 | tee $procLog; read dummy" >> $procCmdFile echo "${node}$xterm -e $procCmdFile" >> $PWD/mpirun.schema
echo "${node}xterm -font fixed -title 'processor'$proc $geom -e $procCmdFile" >> $PWD/mpirun.schema echo "$exec $appArgs 2>&1 | tee $procLog"
echo "read dummy"
;; ;;
5) 5)
echo "$sourceFoam; cd $PWD; valgrind --leak-check=full --show-reachable=yes $exec $args 2>&1 | tee $procLog; read dummy" >> $procCmdFile echo "${node}$xterm -e $procCmdFile" >> $PWD/mpirun.schema
echo "${node}xterm -font fixed -title 'processor'$proc $geom -e $procCmdFile" >> $PWD/mpirun.schema echo "valgrind --leak-check=full --show-reachable=yes $exec $appArgs 2>&1 | tee $procLog"
echo "read dummy"
;; ;;
6) 6)
echo "$sourceFoam; cd $PWD; CPUPROFILE=log.profiler_$proc $exec $args; \
pprof --callgrind $exec log.profiler_$proc > log.profiler_$proc.callgrind;" >> $procCmdFile
echo "${node}$procCmdFile" >> $PWD/mpirun.schema echo "${node}$procCmdFile" >> $PWD/mpirun.schema
echo "CPUPROFILE=log.profiler_$proc $exec $appArgs"
echo "pprof --callgrind $exec log.profiler_$proc > log.profiler_$proc.callgrind"
;; ;;
esac esac >> $procCmdFile
chmod +x $procCmdFile chmod +x $procCmdFile
@ -255,11 +306,20 @@ MPICH)
esac esac
echo "Constructed $PWD/mpirun.schema file." echo "Constructed $PWD/mpirun.schema file."
echo "" echo
echo " $cmd" echo " $cmd"
echo "" echo
$ECHO "Press return to execute.\c"
read dummy if [ -n "$optNoAsk" ]
then
echo "starting: " $(date '+%Y-%m-%d %H:%M:%S %z' 2>/dev/null)
echo
else
# Pause before running
$ECHO "Press return to execute.\c"
read dummy
fi
exec $cmd exec $cmd
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------