3 # Copyright (c) 2007-2015. The SimGrid Team.
6 # This program is free software; you can redistribute it and/or modify it
7 # under the terms of the license (GNU LGPL) which comes with this package.
11 SIMGRID_VERSION="@SIMGRID_VERSION_STRING@"
12 SIMGRID_GITHASH="@SIMGRID_GITHASH@"
14 DEFAULT_LOOPBACK_BANDWIDTH="498000000"
15 DEFAULT_LOOPBACK_LATENCY="0.000004"
16 DEFAULT_NETWORK_BANDWIDTH="$((26 * 1024 * 1024))"
17 DEFAULT_NETWORK_LATENCY="0.000005"
21 LOOPBACK_BANDWIDTH="${DEFAULT_LOOPBACK_BANDWIDTH}"
22 LOOPBACK_LATENCY="${DEFAULT_LOOPBACK_LATENCY}"
23 NETWORK_BANDWIDTH="${DEFAULT_NETWORK_BANDWIDTH}"
24 NETWORK_LATENCY="${DEFAULT_NETWORK_LATENCY}"
25 POWER="${DEFAULT_POWER}"
27 SIMOPTS="--cfg=surf/precision:1e-9 --cfg=network/model:SMPI --cfg=network/TCP_gamma:4194304"
29 #usage to print the way this script should be called
32 Usage: $0 [OPTIONS] -platform <xmldesc> -hostfile <hostfile> program [program-options]
34 -keep-temps # don't remove the generated files after execution
35 -wrapper <command> # use command to run the program (e.g. "valgrind")
36 -map # display the machine on which each process rank is mapped
37 -np <numprocs> # use that amount of processes from the hostfile.
38 # By default, all processes of the hostfile are used.
39 -trace-ti # activate time independant tracing (for replay, default in smpi_simgrid.txt)
40 -trace # activate tracing (Paje, default in smpi_simgrid.trace)
41 -trace-comment <comment> # put a comment on the top of the trace file
42 -trace-comment-file <file> # put file contents on the top of the trace file as comment
43 -trace-grouped # group MPI processes by location
44 -trace-resource # trace resource utilization
45 -trace-viva # generate configuration for Viva's GraphView
46 -trace-file <tracefile> # name of the tracefile (simgrid_smpi.trace)
47 -ext <value> # additional parameter (reserved)
48 -foreground # run the child process in the foreground:
49 # - it can access the terminal;
50 # - but we cannot stop it when we receive a signal.
51 # This is useful with -wrapper "gdb --args".
53 -version # Displays the SimGrid version (human readable)
54 -git-version # Displays the git hash of SimGrid
56 or (deprecated usage):
57 $0 [-keep-temps] [-np <numprocs>] [-bandwidth <bytes/sec>] [-latency <secs>] program [program-options]
62 #check if we have at least one parameter
75 unset foreground ; foreground=0
77 trapped_signals="HUP INT QUIT ILL ABRT SEGV FPE ALRM TERM USR1 USR2 BUS"
81 if [ -z "${KEEP}" ] ; then
82 if [ -z "${PLATFORM}" -a -n "$PLATFORMTMP" ]; then
86 if [ ${HOSTFILETMP} = 1 -a -n "$HOSTFILE" ] ; then
90 if [ ${UNROLLEDHOSTFILETMP} = 1 -a -n "$UNROLLEDHOSTFILE" ] ; then
91 rm -f ${UNROLLEDHOSTFILE}
94 if [ -n ${APPLICATIONTMP} ]; then
95 rm -f ${APPLICATIONTMP}
105 # Cleanup and kill the child process:
107 if ! [ -z "$pid" ]; then
112 # Raise the same signal again (remove the traps first):
113 trap - $trapped_signals
116 # This should never happen:
121 for s in $trapped_signals; do
122 trap "smpirun_trap $s" $s
132 NETWORK_BANDWIDTH="$2"
141 if [ ! -f "${PLATFORM}" ]; then
142 echo "[`basename $0`] ** error: the file '${PLATFORM}' does not exist. Aborting."
149 if [ ! -f "${HOSTFILE}" ]; then
150 echo "[`basename $0`] ** error: the file '${HOSTFILE}' does not exist. Aborting."
158 if [ ! -f "${HOSTFILE}" ]; then
159 echo "[`basename $0`] ** error: the file '${HOSTFILE}' does not exist. Aborting."
182 TRACE_TI_ACTIVE="true"
191 "-trace-comment-file")
192 TRACE_COMMENT_FILE="$2"
207 TRACE_RESOURCE="true"
226 "-help" | "--help" | "-h")
231 "-version" | "--version" | "-v")
232 printf '%b\n' "$SIMGRID_VERSION"
236 "-git-version" | "--git-version")
237 printf '%b\n' "$SIMGRID_GITHASH"
244 SIMOPTS="$SIMOPTS ${1%%=*}=$OPT"
258 if [ -n "$WRAPPER" ]; then
265 # steel --cfg and --logs options
266 while [ $# -gt 0 ]; do
271 SIMOPTS="$SIMOPTS ${1%%=*}=$OPT"
276 PROC_ARGS="${PROC_ARGS:+$PROC_ARGS }$1"
283 ##-----------------------------------
286 if [ -z "${HOSTFILE}" ] && [ -z "${PLATFORM}" ] ; then
287 echo "No hostfile nor platform specified."
292 if [ -z "${HOSTFILE}" ] ; then
294 HOSTFILE="$(mktemp tmphostXXXXXX)"
295 perl -ne 'print "$1\n" if /.*<host.*?id="(.*?)".*?\/>.*/' ${PLATFORM} > ${HOSTFILE}
296 perl -ne 'if (/.*<cluster.*?prefix="(.*?)".*?radical="(.*?)".*?suffix="(.*?)".*/) {
297 my ($pre,$rad,$post)=($1,$2,$3);
298 for my $elm (split(",",$rad)) {
299 if ($elm=~/^([^-]*?)-([^-]*)$/) {
300 for (my $i=$1; $i<=$2;$i++) {
301 print "$pre$i$post\n";
304 print "$pre$elm$post\n";
307 } elsif (/<cluster/) {
308 die ("Unparsable cluster tag. Either provide an hostfile yourself or give the attributes prefix, radical and suffix in that order on the <cluster line");
309 }' ${PLATFORM} >> ${HOSTFILE}
311 UNROLLEDHOSTFILETMP=0
313 #parse if our lines are terminated by :num_process
314 multiple_processes=`grep -c ":" $HOSTFILE`
315 if [ "${multiple_processes}" -gt 0 ] ; then
316 UNROLLEDHOSTFILETMP=1
317 UNROLLEDHOSTFILE="$(mktemp tmphostXXXXXX)"
318 perl -ne ' do{ for ( 1 .. $2 ) { print "$1\n" } } if /(.*?):(\d+).*/' ${HOSTFILE} > ${UNROLLEDHOSTFILE}
319 if [ ${HOSTFILETMP} = 1 ] ; then
323 HOSTFILE=$UNROLLEDHOSTFILE
327 # Don't use wc -l to compute it to avoid issues with trailing \n at EOF
328 hostfile_procs=`grep -c "[a-zA-Z0-9]" $HOSTFILE`
329 if [ ${hostfile_procs} = 0 ] ; then
330 echo "[`basename $0`] ** error: the hostfile '${HOSTFILE}' is empty. Aborting." >&2
334 if [ -z "${NUMPROCS}" ] ; then
335 # Use the amount of processes in the hostfile as default value for the -np parameter
336 NUMPROCS=$hostfile_procs
340 if [ ${NUMPROCS} -gt ${hostfile_procs} ] ; then
341 echo "You requested to use ${NUMPROCS} processes, but there is only ${hostfile_procs} processes in your hostfile..." >&2
344 ##-------------------------------- DEFAULT or SPECIFIED PLATFORM --------------------------------------
345 if [ -z "${PLATFORM}" ]; then
346 PLATFORMTMP="$(mktemp tmpXXXXXX)"
348 cat > ${PLATFORMTMP} <<PLATFORMHEAD
349 <?xml version='1.0'?>
350 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
351 <platform version="3">
352 <AS id="AS0" routing="Full">
356 while [ $i -gt 0 ]; do
357 echo " <host id=\"host$i\" power=\"${POWER}\"/>" >> ${PLATFORMTMP}
358 echo " <link id=\"loop$i\" bandwidth=\"${LOOPBACK_BANDWIDTH}\" latency=\"${LOOPBACK_LATENCY}\"/>" >> ${PLATFORMTMP}
359 echo " <link id=\"link$i\" bandwidth=\"${NETWORK_BANDWIDTH}\" latency=\"${NETWORK_LATENCY}\"/>" >> ${PLATFORMTMP}
364 while [ $i -gt 0 ]; do
366 while [ $j -gt 0 ]; do
367 if [ $i -eq $j ]; then
368 echo " <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"loop$i\"/></route>" >> ${PLATFORMTMP}
370 echo " <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"link$i\"/><link_ctn id=\"link$j\"/></route>" >> ${PLATFORMTMP}
377 cat >> ${PLATFORMTMP} <<PLATFORMFOOT
383 PLATFORMTMP=${PLATFORM}
385 ##-------------------------------- end DEFAULT or SPECIFIED PLATFORM --------------------------------------
387 ##-------------------------------- DEFAULT APPLICATION --------------------------------------
388 APPLICATIONTMP="$(mktemp tmpXXXXXX)"
389 #APPLICATIONTMP="app.xml"
392 cat > ${APPLICATIONTMP} <<APPLICATIONHEAD
393 <?xml version='1.0'?>
394 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
395 <platform version="3">
398 ##---- cache hostnames of hostfile---------------
399 if [ -n "${HOSTFILE}" ] && [ -f ${HOSTFILE} ]; then
400 hostnames=$(cat ${HOSTFILE} | tr '\n\r' ' ')
401 NUMHOSTS=$(cat ${HOSTFILE} | wc -l)
404 if [ "${EXTOPT}" = "smpi_replay" ]; then
405 APP_TRACES=$PROC_ARGS
406 if [ -n "${APP_TRACES}" ] && [ -f "${APP_TRACES}" ]; then
407 hosttraces=$(cat ${APP_TRACES} | tr '\n\r' ' ' )
408 NUMTRACES=$(cat ${APP_TRACES} | wc -l)
410 printf "File not found: %s\n", "${APP_TRACES:-\${APP_TRACES\}}" >&2
415 ##----------------------------------------------------------
416 ## generate application.xml with hostnames from hostfile:
417 ## the name of host_i (1<=i<=p, where -np p) is the line i
418 ## in hostfile (where -hostfile hostfile), or "host$i" if
419 ## hostfile has less than i lines.
420 ##----------------------------------------------------------
422 HAVE_SEQ="`which seq 2>/dev/null`"
424 if [ -n "${HAVE_SEQ}" ]; then
425 SEQ=`${HAVE_SEQ} 0 $((${NUMPROCS}-1))`
428 while [ $cnt -lt ${NUMPROCS} ] ; do
434 ##---- generate <process> tags------------------------------
438 if [ -n "${HOSTFILE}" ]; then
439 j=$(( $i % ${NUMHOSTS} + 1 ))
441 ##---- optional display of ranks to process mapping
442 if [ -n "${MAPOPT}" ]; then
443 echo "[rank $i] -> $(echo $hostnames|cut -d' ' -f$j)"
446 if [ -z "$(echo $hostnames|cut -d' ' -f$j)" ]; then
449 host="$(echo $hostnames|cut -d' ' -f$j)"
451 echo " <process host=\"${host}\" function=\"$i\"> <!-- function name used only for logging -->" >> ${APPLICATIONTMP}
452 echo " <argument value=\"1\"/> <!-- instance -->" >> ${APPLICATIONTMP}
453 echo " <argument value=\"$i\"/> <!-- rank -->" >> ${APPLICATIONTMP}
454 if [ "${EXTOPT}" = "smpi_replay" ]; then
455 if [ ${NUMTRACES} -gt 1 ]; then
456 echo " <argument value=\"$(echo $hosttraces|cut -d' ' -f$j)\"/>" >> ${APPLICATIONTMP}
458 echo " <argument value=\"$(echo $hosttraces|cut -d' ' -f1)\"/>" >> ${APPLICATIONTMP}
461 for ARG in $PROC_ARGS; do
462 echo " <argument value=\"${ARG}\"/>" >> ${APPLICATIONTMP}
465 echo " </process>" >> ${APPLICATIONTMP}
468 cat >> ${APPLICATIONTMP} <<APPLICATIONFOOT
471 ##-------------------------------- end DEFAULT APPLICATION --------------------------------------
473 ##---------------------- SMPI TRACING OPTIONS ---------------------------------
474 if [ -n "${TRACE_ACTIVE}" ]; then
475 #define trace filename
476 if [ -n "${TRACE_TI_ACTIVE}" ]; then
477 if [ -z "${TRACE_FILENAME}" ]; then
478 TRACE_FILENAME="smpi_simgrid.txt"
480 TRACEOPTIONS="--cfg=tracing:yes --cfg=tracing/filename:${TRACE_FILENAME} --cfg=tracing/smpi:yes --cfg=tracing/smpi/format:TI --cfg=tracing/smpi/computing:yes"
482 if [ -z "${TRACE_FILENAME}" ]; then
483 TRACE_FILENAME="smpi_simgrid.trace"
485 TRACEOPTIONS="--cfg=tracing:yes --cfg=tracing/filename:${TRACE_FILENAME} --cfg=tracing/smpi:yes"
488 if [ -n "${TRACE_COMMENT}" ]; then
489 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/comment:${TRACE_COMMENT}"
492 if [ -n "${TRACE_COMMENT_FILE}" ]; then
493 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/comment_file:${TRACE_COMMENT_FILE}"
496 if [ -n "${TRACE_GROUPED}" ]; then
497 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/smpi/group:yes"
500 if [ -n "${TRACE_RESOURCE}" ]; then
501 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes"
504 if [ -n "${TRACE_VIVA}" ]; then
505 TRACEOPTIONS="${TRACEOPTIONS} --cfg=viva/categorized:smpi_cat.plist --cfg=viva/uncategorized:smpi_uncat.plist"
508 ##---------------------- end SMPI TRACING OPTIONS ---------------------------------
510 export SMPI_GLOBAL_SIZE=${NUMPROCS}
511 if [ -n "${KEEP}" ] ; then
512 echo ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP}
513 if [ ${HOSTFILETMP} = 1 ] ; then
514 echo "Generated hostfile ${HOSTFILE} keeped."
516 if [ ${UNROLLEDHOSTFILETMP} = 1 ] ; then
517 echo "Generated unrolled hostfile ${UNROLLEDHOSTFILE} keeped."
520 if [ "$foreground" = 1 ]; then
521 ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP}
524 ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP} &