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)
49 -version # Displays the SimGrid version (human readable)
50 -git-version # Displays the git hash of SimGrid
52 or (deprecated usage):
53 $0 [-keep-temps] [-np <numprocs>] [-bandwidth <bytes/sec>] [-latency <secs>] program [program-options]
58 #check if we have at least one parameter
76 NETWORK_BANDWIDTH="$2"
85 if [ ! -f "${PLATFORM}" ]; then
86 echo "[`basename $0`] ** error: the file '${PLATFORM}' does not exist. Aborting."
93 if [ ! -f "${HOSTFILE}" ]; then
94 echo "[`basename $0`] ** error: the file '${HOSTFILE}' does not exist. Aborting."
102 if [ ! -f "${HOSTFILE}" ]; then
103 echo "[`basename $0`] ** error: the file '${HOSTFILE}' does not exist. Aborting."
126 TRACE_TI_ACTIVE="true"
135 "-trace-comment-file")
136 TRACE_COMMENT_FILE="$2"
151 TRACE_RESOURCE="true"
170 "-help" | "--help" | "-h")
175 "-version" | "--version" | "-v")
176 printf '%b\n' "$SIMGRID_VERSION"
180 "-git-version" | "--git-version")
181 printf '%b\n' "$SIMGRID_GITHASH"
188 SIMOPTS="$SIMOPTS ${1%%=*}=$OPT"
198 if [ -n "$WRAPPER" ]; then
205 # steel --cfg and --logs options
206 while [ $# -gt 0 ]; do
211 SIMOPTS="$SIMOPTS ${1%%=*}=$OPT"
216 PROC_ARGS="${PROC_ARGS:+$PROC_ARGS }$1"
223 ##-----------------------------------
226 if [ -z "${HOSTFILE}" ] && [ -z "${PLATFORM}" ] ; then
227 echo "No hostfile nor platform specified."
233 if [ -z "${HOSTFILE}" ] ; then
235 HOSTFILE="$(mktemp tmphostXXXXXX)"
236 perl -ne 'print "$1\n" if /.*<host.*?id="(.*?)".*?\/>.*/' ${PLATFORM} > ${HOSTFILE}
237 perl -ne 'if (/.*<cluster.*?prefix="(.*?)".*?radical="(.*?)".*?suffix="(.*?)".*/) {
238 my ($pre,$rad,$post)=($1,$2,$3);
239 for my $elm (split(",",$rad)) {
240 if ($elm=~/^([^-]*?)-([^-]*)$/) {
241 for (my $i=$1; $i<=$2;$i++) {
242 print "$pre$i$post\n";
245 print "$pre$elm$post\n";
248 } elsif (/<cluster/) {
249 die ("Unparsable cluster tag. Either provide an hostfile yourself or give the attributes prefix, radical and suffix in that order on the <cluster line");
250 }' ${PLATFORM} >> ${HOSTFILE}
252 UNROLLEDHOSTFILETMP=0
254 #parse if our lines are terminated by :num_process
255 multiple_processes=`grep -c ":" $HOSTFILE`
256 if [ "${multiple_processes}" -gt 0 ] ; then
257 UNROLLEDHOSTFILETMP=1
258 UNROLLEDHOSTFILE="$(mktemp tmphostXXXXXX)"
259 perl -ne ' do{ for ( 1 .. $2 ) { print "$1\n" } } if /(.*?):(\d+).*/' ${HOSTFILE} > ${UNROLLEDHOSTFILE}
260 if [ ${HOSTFILETMP} = 1 ] ; then
264 HOSTFILE=$UNROLLEDHOSTFILE
268 # Don't use wc -l to compute it to avoid issues with trailing \n at EOF
269 hostfile_procs=`grep -c "[a-zA-Z0-9]" $HOSTFILE`
270 if [ ${hostfile_procs} = 0 ] ; then
271 echo "[`basename $0`] ** error: the hostfile '${HOSTFILE}' is empty. Aborting." >&2
275 if [ -z "${NUMPROCS}" ] ; then
276 # Use the amount of processes in the hostfile as default value for the -np parameter
277 NUMPROCS=$hostfile_procs
281 if [ ${NUMPROCS} -gt ${hostfile_procs} ] ; then
282 echo "You requested to use ${NUMPROCS} processes, but there is only ${hostfile_procs} processes in your hostfile..." >&2
285 ##-------------------------------- DEFAULT or SPECIFIED PLATFORM --------------------------------------
286 if [ -z "${PLATFORM}" ]; then
287 PLATFORMTMP="$(mktemp tmpXXXXXX)"
289 cat > ${PLATFORMTMP} <<PLATFORMHEAD
290 <?xml version='1.0'?>
291 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
292 <platform version="3">
293 <AS id="AS0" routing="Full">
297 while [ $i -gt 0 ]; do
298 echo " <host id=\"host$i\" power=\"${POWER}\"/>" >> ${PLATFORMTMP}
299 echo " <link id=\"loop$i\" bandwidth=\"${LOOPBACK_BANDWIDTH}\" latency=\"${LOOPBACK_LATENCY}\"/>" >> ${PLATFORMTMP}
300 echo " <link id=\"link$i\" bandwidth=\"${NETWORK_BANDWIDTH}\" latency=\"${NETWORK_LATENCY}\"/>" >> ${PLATFORMTMP}
305 while [ $i -gt 0 ]; do
307 while [ $j -gt 0 ]; do
308 if [ $i -eq $j ]; then
309 echo " <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"loop$i\"/></route>" >> ${PLATFORMTMP}
311 echo " <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"link$i\"/><link_ctn id=\"link$j\"/></route>" >> ${PLATFORMTMP}
318 cat >> ${PLATFORMTMP} <<PLATFORMFOOT
324 PLATFORMTMP=${PLATFORM}
326 ##-------------------------------- end DEFAULT or SPECIFIED PLATFORM --------------------------------------
328 ##-------------------------------- DEFAULT APPLICATION --------------------------------------
329 APPLICATIONTMP="$(mktemp tmpXXXXXX)"
330 #APPLICATIONTMP="app.xml"
333 cat > ${APPLICATIONTMP} <<APPLICATIONHEAD
334 <?xml version='1.0'?>
335 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
336 <platform version="3">
339 ##---- cache hostnames of hostfile---------------
340 if [ -n "${HOSTFILE}" ] && [ -f ${HOSTFILE} ]; then
341 hostnames=$(cat ${HOSTFILE} | tr '\n\r' ' ')
342 NUMHOSTS=$(cat ${HOSTFILE} | wc -l)
345 if [ "${EXTOPT}" = "smpi_replay" ]; then
346 APP_TRACES=$PROC_ARGS
347 if [ -n "${APP_TRACES}" ] && [ -f "${APP_TRACES}" ]; then
348 hosttraces=$(cat ${APP_TRACES} | tr '\n\r' ' ' )
349 NUMTRACES=$(cat ${APP_TRACES} | wc -l)
351 printf "File not found: %s\n", "${APP_TRACES:-\${APP_TRACES\}}" >&2
356 ##----------------------------------------------------------
357 ## generate application.xml with hostnames from hostfile:
358 ## the name of host_i (1<=i<=p, where -np p) is the line i
359 ## in hostfile (where -hostfile hostfile), or "host$i" if
360 ## hostfile has less than i lines.
361 ##----------------------------------------------------------
363 HAVE_SEQ="`which seq 2>/dev/null`"
365 if [ -n "${HAVE_SEQ}" ]; then
366 SEQ=`${HAVE_SEQ} 0 $((${NUMPROCS}-1))`
369 while [ $cnt -lt ${NUMPROCS} ] ; do
375 ##---- generate <process> tags------------------------------
379 if [ -n "${HOSTFILE}" ]; then
380 j=$(( $i % ${NUMHOSTS} + 1 ))
382 ##---- optional display of ranks to process mapping
383 if [ -n "${MAPOPT}" ]; then
384 echo "[rank $i] -> $(echo $hostnames|cut -d' ' -f$j)"
387 if [ -z "$(echo $hostnames|cut -d' ' -f$j)" ]; then
390 host="$(echo $hostnames|cut -d' ' -f$j)"
392 echo " <process host=\"${host}\" function=\"$i\"> <!-- function name used only for logging -->" >> ${APPLICATIONTMP}
393 echo " <argument value=\"1\"/> <!-- instance -->" >> ${APPLICATIONTMP}
394 echo " <argument value=\"$i\"/> <!-- rank -->" >> ${APPLICATIONTMP}
395 if [ "${EXTOPT}" = "smpi_replay" ]; then
396 if [ ${NUMTRACES} -gt 1 ]; then
397 echo " <argument value=\"$(echo $hosttraces|cut -d' ' -f$j)\"/>" >> ${APPLICATIONTMP}
399 echo " <argument value=\"$(echo $hosttraces|cut -d' ' -f1)\"/>" >> ${APPLICATIONTMP}
402 for ARG in $PROC_ARGS; do
403 echo " <argument value=\"${ARG}\"/>" >> ${APPLICATIONTMP}
406 echo " </process>" >> ${APPLICATIONTMP}
409 cat >> ${APPLICATIONTMP} <<APPLICATIONFOOT
412 ##-------------------------------- end DEFAULT APPLICATION --------------------------------------
414 ##---------------------- SMPI TRACING OPTIONS ---------------------------------
415 if [ -n "${TRACE_ACTIVE}" ]; then
416 #define trace filename
417 if [ -n "${TRACE_TI_ACTIVE}" ]; then
418 if [ -z "${TRACE_FILENAME}" ]; then
419 TRACE_FILENAME="smpi_simgrid.txt"
421 TRACEOPTIONS="--cfg=tracing:yes --cfg=tracing/filename:${TRACE_FILENAME} --cfg=tracing/smpi:yes --cfg=tracing/smpi/format:TI --cfg=tracing/smpi/computing:yes"
423 if [ -z "${TRACE_FILENAME}" ]; then
424 TRACE_FILENAME="smpi_simgrid.trace"
426 TRACEOPTIONS="--cfg=tracing:yes --cfg=tracing/filename:${TRACE_FILENAME} --cfg=tracing/smpi:yes"
429 if [ -n "${TRACE_COMMENT}" ]; then
430 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/comment:${TRACE_COMMENT}"
433 if [ -n "${TRACE_COMMENT_FILE}" ]; then
434 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/comment_file:${TRACE_COMMENT_FILE}"
437 if [ -n "${TRACE_GROUPED}" ]; then
438 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/smpi/group:yes"
441 if [ -n "${TRACE_RESOURCE}" ]; then
442 TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes"
445 if [ -n "${TRACE_VIVA}" ]; then
446 TRACEOPTIONS="${TRACEOPTIONS} --cfg=viva/categorized:smpi_cat.plist --cfg=viva/uncategorized:smpi_uncat.plist"
449 ##---------------------- end SMPI TRACING OPTIONS ---------------------------------
451 export SMPI_GLOBAL_SIZE=${NUMPROCS}
452 if [ -n "${KEEP}" ] ; then
453 echo ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP}
454 if [ ${HOSTFILETMP} = 1 ] ; then
455 echo "Generated hostfile ${HOSTFILE} keeped."
457 if [ ${UNROLLEDHOSTFILETMP} = 1 ] ; then
458 echo "Generated unrolled hostfile ${UNROLLEDHOSTFILE} keeped."
461 ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP}
464 if [ -z "${KEEP}" ] ; then
465 if [ -z "${PLATFORM}" ]; then
468 if [ ${HOSTFILETMP} = 1 ] ; then
471 if [ ${UNROLLEDHOSTFILETMP} = 1 ] ; then
472 rm ${UNROLLEDHOSTFILE}