src/smpi/smpirun.in

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