src/smpi/smpirun.in

   1 #! /bin/sh
   2
   3 @CMAKE_SMPI_COMMAND@
   4
   5 DEFAULT_LOOPBACK_BANDWIDTH="498000000"
   6 DEFAULT_LOOPBACK_LATENCY="0.000004"
   7 DEFAULT_NETWORK_BANDWIDTH="$((26 * 1024 * 1024))"
   8 DEFAULT_NETWORK_LATENCY="0.000005"
   9 DEFAULT_NUMPROCS="4"
  10 DEFAULT_POWER="100"
  11
  12 LOOPBACK_BANDWIDTH="${DEFAULT_LOOPBACK_BANDWIDTH}"
  13 LOOPBACK_LATENCY="${DEFAULT_LOOPBACK_LATENCY}"
  14 NETWORK_BANDWIDTH="${DEFAULT_NETWORK_BANDWIDTH}"
  15 NETWORK_LATENCY="${DEFAULT_NETWORK_LATENCY}"
  16 POWER="${DEFAULT_POWER}"
  17
  18 SIMOPTS="--cfg=maxmin/precision:1e-9 --cfg=network/model:SMPI --cfg=network/TCP_gamma:4194304"
  19
  20 #usage to print the way this script should be called
  21 usage () {
  22 cat <<EOF
  23 Usage: $0 [OPTIONS] -platform <xmldesc> -hostfile <hostfile> program [program-options]
  24 Options:
  25   -keep-temps                # don't remove the generated files after execution
  26   -wrapper <command>         # use command to run the program (e.g. "valgrind")
  27   -map                       # display the machine on which each process rank is mapped
  28   -np <numprocs>             # use that amount of processes from the hostfile.
  29                              # By default, all processes of the hostfile are used.
  30   -trace-ti                  # activate time independant tracing (for replay, default in smpi_simgrid.txt)
  31   -trace                     # activate tracing (Paje, default in smpi_simgrid.trace)
  32   -trace-comment <comment>   # put a comment on the top of the trace file
  33   -trace-comment-file <file> # put file contents on the top of the trace file as comment
  34   -trace-grouped             # group MPI processes by location
  35   -trace-resource            # trace resource utilization
  36   -trace-viva               # generate configuration for Viva's GraphView
  37   -trace-file <tracefile>    # name of the tracefile (simgrid_smpi.trace)
  38   -ext <value>               # additional parameter (reserved)
  39
  40 or (deprecated usage):
  41   $0 [-keep-temps] [-np <numprocs>] [-bandwidth <bytes/sec>] [-latency <secs>] program [program-options]
  42
  43 EOF
  44 }
  45
  46 #check if we have at least one parameter
  47 if [ $# -eq 0 ]
  48 then
  49     usage
  50     exit
  51 fi
  52
  53 EXTOPT=""
  54 WRAPPER=""
  55 HOSTFILE=""
  56
  57 while true; do
  58   case "$1" in
  59    "-np" | "-n")
  60       NUMPROCS="$2"
  61       shift 2
  62     ;;
  63    "-bandwidth")
  64       NETWORK_BANDWIDTH="$2"
  65       shift 2
  66     ;;
  67    "-latency")
  68       NETWORK_LATENCY="$2"
  69       shift 2
  70     ;;
  71    "-platform")
  72         PLATFORM="$2"
  73       if [ ! -f "${PLATFORM}" ]; then
  74                 echo "[$0] ** error: the file '${PLATFORM}' does not exist. Aborting."
  75                 exit 1
  76       fi
  77         shift 2
  78     ;;
  79    "-hostfile")
  80         HOSTFILE="$2"
  81       if [ ! -f "${HOSTFILE}" ]; then
  82                 echo "[$0] ** error: the file '${HOSTFILE}' does not exist. Aborting."
  83                 exit 1
  84       fi
  85         shift 2
  86     ;;
  87
  88    "-ext")
  89       EXTOPT="$2"
  90       shift 2
  91    ;;
  92
  93    "-map")
  94         MAPOPT="true"
  95       shift 1
  96    ;;
  97
  98    "-trace")
  99       TRACE_ACTIVE="true"
 100       shift 1
 101    ;;
 102
 103    "-trace-ti")
 104       TRACE_ACTIVE="true"
 105       TRACE_TI_ACTIVE="true"
 106       shift 1
 107    ;;
 108
 109    "-trace-comment")
 110       TRACE_COMMENT="$2"
 111       shift 2
 112    ;;
 113
 114    "-trace-comment-file")
 115       TRACE_COMMENT_FILE="$2"
 116       shift 2
 117    ;;
 118
 119    "-trace-file")
 120       TRACE_FILENAME="$2"
 121       shift 2
 122    ;;
 123
 124    "-trace-grouped")
 125       TRACE_GROUPED="true"
 126       shift 1
 127    ;;
 128
 129    "-trace-resource")
 130       TRACE_RESOURCE="true"
 131       shift 1
 132    ;;
 133
 134    "-trace-viva")
 135         TRACE_VIVA="true"
 136           shift 1
 137    ;;
 138
 139    "-keep-temps")
 140         KEEP="true"
 141       shift 1
 142    ;;
 143
 144    "-wrapper")
 145       WRAPPER="$2"
 146       shift 2
 147       ;;
 148
 149    "-help" | "--help" | "-h")
 150       usage
 151       exit
 152    ;;
 153
 154    "--cfg="*|"--log="*)
 155      for OPT in ${1#*=}
 156      do
 157        SIMOPTS="$SIMOPTS ${1%%=*}=$OPT"
 158      done
 159      shift 1
 160    ;;
 161     *)
 162       break
 163     ;;
 164   esac
 165 done
 166
 167 if [ -n "$WRAPPER" ]; then
 168     EXEC="$WRAPPER $1"
 169 else
 170     EXEC="$1"
 171 fi
 172 shift
 173
 174 # steel --cfg and --logs options
 175 while [ $# -gt 0 ]; do
 176   case "$1" in
 177    "--cfg="*|"--log="*)
 178      for OPT in ${1#*=}
 179      do
 180        SIMOPTS="$SIMOPTS ${1%%=*}=$OPT"
 181      done
 182      shift 1
 183    ;;
 184     *)
 185       PROC_ARGS="${PROC_ARGS:+$PROC_ARGS }$1"
 186       shift
 187     ;;
 188   esac
 189 done
 190
 191
 192 ##-----------------------------------
 193
 194 # Basic checks on the provided arguments
 195 if [ -z "${EXEC}" ] ; then
 196     echo "You must provide a program to execute."
 197     usage
 198     exit 1
 199 fi
 200
 201 if [ -z "${HOSTFILE}" ] && [ -z "${PLATFORM}" ] ; then
 202     echo "No hostfile nor platform specified."
 203     usage
 204     exit 1
 205 fi
 206
 207 HOSTFILETMP=0
 208 if [ -z "${HOSTFILE}" ] ; then
 209     HOSTFILETMP=1
 210     HOSTFILE="$(mktemp tmphostXXXXXX)"
 211     perl -ne 'print "$1\n" if /.*<host.*?id="(.*?)".*?\/>.*/' ${PLATFORM} > ${HOSTFILE}
 212 fi
 213
 214 # Don't use wc -l to compute it to avoid issues with trailing \n at EOF
 215 hostfile_procs=`grep -c "[a-zA-Z0-9]" $HOSTFILE`
 216
 217 if [ -z "${NUMPROCS}" ] ; then
 218     # Use the amount of processes in the hostfile as default value for the -np parameter
 219     NUMPROCS=$hostfile_procs
 220 fi
 221
 222
 223 if [ ${NUMPROCS} -gt ${hostfile_procs} ] ; then
 224     echo "You requested to use ${NUMPROCS} processes, but there is only ${hostfile_procs} processes in your hostfile..." >&2
 225 fi
 226
 227 ##-------------------------------- DEFAULT or SPECIFIED PLATFORM --------------------------------------
 228 if [ -z "${PLATFORM}" ]; then
 229         PLATFORMTMP="$(mktemp tmpXXXXXX)"
 230
 231         cat > ${PLATFORMTMP} <<PLATFORMHEAD
 232 <?xml version='1.0'?>
 233 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
 234 <platform version="3">
 235 <AS id="AS0" routing="Full">
 236 PLATFORMHEAD
 237
 238 i=${NUMPROCS}
 239 while [ $i -gt 0 ]; do
 240   echo "  <host id=\"host$i\" power=\"${POWER}\"/>" >> ${PLATFORMTMP}
 241   echo "  <link id=\"loop$i\" bandwidth=\"${LOOPBACK_BANDWIDTH}\" latency=\"${LOOPBACK_LATENCY}\"/>" >> ${PLATFORMTMP}
 242   echo "  <link id=\"link$i\" bandwidth=\"${NETWORK_BANDWIDTH}\" latency=\"${NETWORK_LATENCY}\"/>" >> ${PLATFORMTMP}
 243   i=$((i - 1))
 244 done
 245
 246 i=${NUMPROCS}
 247 while [ $i -gt 0 ]; do
 248   j=${NUMPROCS}
 249   while [ $j -gt 0 ]; do
 250     if [ $i -eq $j ]; then
 251       echo "  <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"loop$i\"/></route>" >> ${PLATFORMTMP}
 252     else
 253       echo "  <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"link$i\"/><link_ctn id=\"link$j\"/></route>" >> ${PLATFORMTMP}
 254     fi
 255     j=$((j - 1))
 256   done
 257   i=$((i - 1))
 258 done
 259
 260 cat >> ${PLATFORMTMP} <<PLATFORMFOOT
 261 </AS>
 262 </platform>
 263 PLATFORMFOOT
 264
 265 else
 266         PLATFORMTMP=${PLATFORM}
 267 fi
 268 ##-------------------------------- end DEFAULT or SPECIFIED PLATFORM --------------------------------------
 269
 270 ##-------------------------------- DEFAULT APPLICATION --------------------------------------
 271 APPLICATIONTMP="$(mktemp tmpXXXXXX)"
 272 #APPLICATIONTMP="app.xml"
 273
 274
 275 cat > ${APPLICATIONTMP} <<APPLICATIONHEAD
 276 <?xml version='1.0'?>
 277 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
 278 <platform version="3">
 279 APPLICATIONHEAD
 280
 281 ##---- cache hostnames of hostfile---------------
 282 if [ -n "${HOSTFILE}" ] && [ -f ${HOSTFILE} ]; then
 283   hostnames=$(cat ${HOSTFILE} | tr '\n\r' '  ')
 284   NUMHOSTS=$(cat ${HOSTFILE} | wc -l)
 285 fi
 286
 287 if [ "${EXTOPT}" = "smpi_replay" ]; then
 288   APP_TRACES=$PROC_ARGS
 289   if [ -n "${APP_TRACES}" ] && [ -f "${APP_TRACES}" ]; then
 290      hosttraces=$(cat ${APP_TRACES} | tr '\n\r' '  ' )
 291      NUMTRACES=$(cat ${APP_TRACES} | wc -l)
 292   else
 293      printf "File not found: %s\n", "${APP_TRACES:-\${APP_TRACES\}}" >&2
 294      exit 1
 295   fi
 296 fi
 297
 298 ##----------------------------------------------------------
 299 ##  generate application.xml with hostnames from hostfile:
 300 ##  the name of host_i (1<=i<=p, where -np p) is the line i
 301 ##  in hostfile (where -hostfile hostfile), or "host$i" if
 302 ##  hostfile has less than i lines.
 303 ##----------------------------------------------------------
 304
 305 HAVE_SEQ="`which seq 2>/dev/null`"
 306
 307 if [ -n "${HAVE_SEQ}" ]; then
 308         SEQ=`${HAVE_SEQ} 0 $((${NUMPROCS}-1))`
 309 else
 310       cnt=0
 311         while (( $cnt < ${NUMPROCS} )) ; do
 312             SEQ="$SEQ $cnt"
 313             cnt=$((cnt + 1));
 314         done
 315 fi
 316
 317 ##---- generate <process> tags------------------------------
 318
 319 for i in ${SEQ}
 320 do
 321   if [ -n "${HOSTFILE}" ]; then
 322         j=$(( $i % ${NUMHOSTS} + 1 ))
 323   fi
 324   ##---- optional display of ranks to process mapping
 325   if [ -n "${MAPOPT}" ]; then
 326         echo "[rank $i] -> $(echo $hostnames|cut -d' ' -f$j)"
 327   fi
 328
 329   if [ -z "$(echo $hostnames|cut -d' ' -f$j)" ]; then
 330         host="host"$($j)
 331   else
 332         host="$(echo $hostnames|cut -d' ' -f$j)"
 333   fi
 334   echo "  <process host=\"${host}\" function=\"$i\"> <!-- function name used only for logging -->" >> ${APPLICATIONTMP}
 335   echo "    <argument value=\"$i\"/> <!-- rank -->" >> ${APPLICATIONTMP}
 336   if [ "${EXTOPT}" = "smpi_replay" ]; then
 337     if  [ ${NUMTRACES} -gt 1 ]; then
 338       echo "    <argument value=\"$(echo $hosttraces|cut -d' ' -f$j)\"/>" >> ${APPLICATIONTMP}
 339     else
 340       echo "    <argument value=\"$(echo $hosttraces|cut -d' ' -f1)\"/>" >> ${APPLICATIONTMP}
 341     fi
 342   else
 343     for ARG in $PROC_ARGS; do
 344        echo "    <argument value=\"${ARG}\"/>" >> ${APPLICATIONTMP}
 345     done
 346   fi
 347   echo "  </process>" >> ${APPLICATIONTMP}
 348 done
 349
 350 cat >> ${APPLICATIONTMP} <<APPLICATIONFOOT
 351 </platform>
 352 APPLICATIONFOOT
 353 ##-------------------------------- end DEFAULT APPLICATION --------------------------------------
 354
 355 ##---------------------- SMPI TRACING OPTIONS ---------------------------------
 356 if [ -n "${TRACE_ACTIVE}" ]; then
 357   #define trace filename
 358   if [ -n "${TRACE_TI_ACTIVE}" ]; then
 359     if [ -z "${TRACE_FILENAME}" ]; then
 360       TRACE_FILENAME="smpi_simgrid.txt"
 361     fi
 362     TRACEOPTIONS="--cfg=tracing:yes --cfg=tracing/filename:${TRACE_FILENAME} --cfg=tracing/smpi:yes --cfg=tracing/smpi/format:TI --cfg=tracing/smpi/computing:yes"
 363   else
 364     if [ -z "${TRACE_FILENAME}" ]; then
 365       TRACE_FILENAME="smpi_simgrid.trace"
 366     fi
 367     TRACEOPTIONS="--cfg=tracing:yes --cfg=tracing/filename:${TRACE_FILENAME} --cfg=tracing/smpi:yes"
 368   fi
 369
 370   if [ -n "${TRACE_COMMENT}" ]; then
 371     TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/comment:${TRACE_COMMENT}"
 372   fi
 373
 374   if [ -n "${TRACE_COMMENT_FILE}" ]; then
 375     TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/comment_file:${TRACE_COMMENT_FILE}"
 376   fi
 377
 378   if [ -n "${TRACE_GROUPED}" ]; then
 379     TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/smpi/group:yes"
 380   fi
 381
 382   if [ -n "${TRACE_RESOURCE}" ]; then
 383     TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes"
 384   fi
 385
 386   if [ -n "${TRACE_VIVA}" ]; then
 387     TRACEOPTIONS="${TRACEOPTIONS} --cfg=viva/categorized:smpi_cat.plist --cfg=viva/uncategorized:smpi_uncat.plist"
 388   fi
 389 fi
 390 ##---------------------- end SMPI TRACING OPTIONS ---------------------------------
 391
 392 export SMPI_GLOBAL_SIZE=${NUMPROCS}
 393 if [ -n "${KEEP}" ] ; then
 394   echo ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP}
 395   if [ ${HOSTFILETMP} = 1 ] ; then
 396     echo "Generated hostfile ${HOSTFILE} keeped."
 397   fi
 398 fi
 399 ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP}
 400 status=$?
 401
 402 if [ -z "${KEEP}" ] ; then
 403    if [ -z "${PLATFORM}" ]; then
 404         rm ${PLATFORMTMP}
 405    fi
 406    if [ ${HOSTFILETMP} = 1 ] ; then
 407         rm ${HOSTFILE}
 408    fi
 409    rm ${APPLICATIONTMP}
 410 fi
 411
 412 exit $status