Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
activity::CommImpl: stick to our naming standards for the fields
[simgrid.git] / src / smpi / smpirun.in
index 3016954..8d28059 100755 (executable)
@@ -1,6 +1,6 @@
-#! /bin/sh
+#!/usr/bin/env sh
 
-# Copyright (c) 2007-2016, The SimGrid Team. All rights reserved.
+# Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.
 
 # This program is free software; you can redistribute it and/or modify it
 # under the terms of the license (GNU LGPL) which comes with this package.
@@ -23,7 +23,7 @@ NETWORK_BANDWIDTH="${DEFAULT_NETWORK_BANDWIDTH}"
 NETWORK_LATENCY="${DEFAULT_NETWORK_LATENCY}"
 SPEED="${DEFAULT_SPEED}"
 
-PRIVATIZE="--cfg=smpi/privatization:@HAVE_PRIVATIZATION@"
+PRIVATIZE="--cfg=smpi/privatization:${SMPI_PRIVATIZATION:-@HAVE_PRIVATIZATION@}"
 
 SIMOPTS="--cfg=surf/precision:1e-9 --cfg=network/model:SMPI"
 
@@ -31,6 +31,7 @@ SIMOPTS="--cfg=surf/precision:1e-9 --cfg=network/model:SMPI"
 usage () {
     cat <<EOF
 Usage: $0 [OPTIONS] -platform <xmldesc> -hostfile <hostfile> program [program-options]
+       $0 [OPTIONS] -platform <xmldesc> -hostfile <hostfile> -replay <tracefile> [program] [program-options]
 Options:
   -keep-temps                # don't remove the generated files after execution
   -wrapper <command>         # use command to run the program (e.g. "valgrind" or "gdb --args")
@@ -45,7 +46,7 @@ Options:
   -trace-grouped             # group MPI processes by location
   -trace-resource            # trace resource utilization
   -trace-file <tracefile>    # name of the tracefile (simgrid_smpi.trace)
-  -ext <value>               # additional parameter (reserved)
+  -replay <tracefile>        # replays a trace instead of actually executing an application
 
   -version                   # Displays the SimGrid version (human readable)
   -git-version               # Displays the git hash of SimGrid
@@ -63,7 +64,6 @@ then
     exit
 fi
 
-EXTOPT=""
 WRAPPER=""
 HOSTFILE=""
 HOSTFILETMP=0
@@ -153,12 +153,12 @@ while true; do
             fi
            shift 2
             ;;
-        "-ext")
-            EXTOPT="$2"
+        "-replay")
+            APP_TRACES="$2"
             shift 2
             ;;
        "-no-privatize")
-           PRIVATIZE=""
+           PRIVATIZE="--cfg=smpi/privatization:no"
            shift 1
            ;;
         "-map")
@@ -232,16 +232,25 @@ while true; do
     esac
 done
 
-# check if we still have at least one parameter beyond options
-if [ $# -eq 0 ]
-then
-    echo "Error: no program to execute!"
-    usage
-    exit
-fi
+if [ -n "${APP_TRACES}" ] ; then
+    if [ $# -eq 0 ] ; then
+        EXEC="@SMPIREPLAYMAIN@"
+    else
+        EXEC="$1"
+        shift
+    fi
+else
+    # check if we still have at least one parameter beyond options
+    if [ $# -eq 0 ]
+    then
+        echo "Error: no program to execute!"
+        usage
+        exit
+    fi
 
-EXEC="$1"
-shift
+    EXEC="$1"
+    shift
+fi
 
 # steel --cfg and --logs options
 while [ $# -gt 0 ]; do
@@ -255,7 +264,7 @@ while [ $# -gt 0 ]; do
             ;;
         *)
             PROC_ARGS="${PROC_ARGS:+$PROC_ARGS }$1"
-            shift      
+            shift
             ;;
     esac
 done
@@ -270,19 +279,21 @@ if [ -z "${HOSTFILE}" ] ; then
     HOSTFILETMP=1
     HOSTFILE="$(mktemp smpitmp-hostfXXXXXX)"
     perl -ne 'print "$1\n" if /.*<host.*?id="(.*?)".*?\/>.*/' ${PLATFORM} > ${HOSTFILE}
-    perl -ne 'if (/.*<cluster.*?prefix="(.*?)".*?radical="(.*?)".*?suffix="(.*?)".*/) { 
-                my ($pre,$rad,$post)=($1,$2,$3); 
-               for my $elm (split(",",$rad)) { 
-                 if ($elm=~/^([^-]*?)-([^-]*)$/) { 
-                    for (my $i=$1; $i<=$2;$i++) { 
-                       print "$pre$i$post\n"; 
+    # put all <cluster tag on its own line.
+    cat ${PLATFORM} | tr '\n' ' ' | sed 's/<cluster/\n<cluster/' | \
+      perl -ne 'if (m/.*<cluster.*?prefix="(.*?)".*?radical="(.*?)".*?suffix="(.*?)".*/s) {
+                my ($pre,$rad,$post)=($1,$2,$3);
+               for my $elm (split(",",$rad)) {
+                 if ($elm=~/^([^-]*?)-([^-]*)$/) {
+                    for (my $i=$1; $i<=$2;$i++) {
+                       print "$pre$i$post\n";
                     }
                  } else {
                     print "$pre$elm$post\n";
                  }
                }
              } elsif (/<cluster/) {
-            die ("Unparsable cluster tag. smpirun uses a primitive regular expression to parse cluster tags. Either provide a hostfile yourself or give the attributes prefix, radical and suffix IN THAT ORDER and ON THE SAME LINE as the opening tag (<cluster)");
+            die ("Unparsable cluster tag. smpirun uses a primitive regular expression to parse cluster tags. Either provide a hostfile yourself or give the attributes prefix, radical and suffix IN THAT ORDER.");
              }' ${PLATFORM} >> ${HOSTFILE}
 fi
 UNROLLEDHOSTFILETMP=0
@@ -321,7 +332,7 @@ if [ -z "${PLATFORM}" ]; then
 
     cat > ${PLATFORMTMP} <<PLATFORMHEAD
 <?xml version='1.0'?>
-<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
+<!DOCTYPE platform SYSTEM "https://simgrid.org/simgrid.dtd">
 <platform version="4.1">
 <zone id="AS0" routing="Full">
 PLATFORMHEAD
@@ -363,7 +374,7 @@ APPLICATIONTMP="$(mktemp smpitmp-appXXXXXX)"
 
 cat > ${APPLICATIONTMP} <<APPLICATIONHEAD
 <?xml version='1.0'?>
-<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
+<!DOCTYPE platform SYSTEM "https://simgrid.org/simgrid.dtd">
 <platform version="4.1">
 APPLICATIONHEAD
 
@@ -372,9 +383,8 @@ if [ -n "${HOSTFILE}" ] && [ -f ${HOSTFILE} ]; then
     hostnames=$(cat ${HOSTFILE} | tr '\n\r' '  ')
 fi
 
-if [ "${EXTOPT}" = "smpi_replay" ]; then
-    APP_TRACES=$PROC_ARGS
-    if [ -n "${APP_TRACES}" ] && [ -f "${APP_TRACES}" ]; then
+if [ -n "${APP_TRACES}" ]; then
+    if [ -f "${APP_TRACES}" ]; then
         hosttraces=$(cat ${APP_TRACES} | tr '\n\r' '  ' )
         NUMTRACES=$(cat ${APP_TRACES} | wc -l)
         REPLAY=1
@@ -386,7 +396,7 @@ fi
 
 ##----------------------------------------------------------
 ##  generate application.xml with hostnames from hostfile:
-##  the name of host_i (1<=i<=p, where -np p) is the line i in hostfile (where -hostfile hostfile), or "host$i" if 
+##  the name of host_i (1<=i<=p, where -np p) is the line i in hostfile (where -hostfile hostfile), or "host$i" if
 ##  hostfile has less than i lines.
 ##----------------------------------------------------------
 
@@ -422,15 +432,16 @@ do
     fi
 
     echo "  <actor host=\"${host}\" function=\"$i\"> <!-- function name used only for logging -->
-    <argument value=\"smpirun\"/> <!-- instance -->
-    <argument value=\"$i\"/> <!-- rank -->" >> ${APPLICATIONTMP}
+    <prop id=\"instance_id\" value=\"smpirun\"/>
+    <prop id=\"rank\" value=\"$i\"/>" >> ${APPLICATIONTMP}
     if [ ${REPLAY} = 1 ]; then
+        echo "    <prop id=\"smpi_replay\" value=\"true\"/>" >> ${APPLICATIONTMP}
         if  [ ${NUMTRACES} -gt 1 ]; then
             echo "    <argument value=\"$(echo $hosttraces|cut -d' ' -f$j)\"/>" >> ${APPLICATIONTMP}
         else
             echo "    <argument value=\"$(echo $hosttraces|cut -d' ' -f1)\"/>" >> ${APPLICATIONTMP}
         fi
-    else 
+    else
     echo ${XML_ARGS} >> ${APPLICATIONTMP}
     fi
     echo "  </actor>" >> ${APPLICATIONTMP}
@@ -480,7 +491,7 @@ if [ -n "${KEEP}" ] ; then
         echo "Generated hostfile ${HOSTFILE} kept."
     fi
     if [ ${UNROLLEDHOSTFILETMP} = 1 ] ; then
-        echo "Generated unrolled hostfile ${UNROLLEDHOSTFILE} kept." 
+        echo "Generated unrolled hostfile ${UNROLLEDHOSTFILE} kept."
     fi
 fi
 
@@ -495,11 +506,17 @@ fi
 # * The FD 3 is used to temporarily store FD 1. This is because the shell connects FD 1 to /dev/null when the command
 #   is launched in the background: this can be overriden in bash but not in standard bourne shell.
 exec 3<&0
-${WRAPPER} "@SMPIMAIN@" ${EXEC} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP} <&3 3>&- &
+${WRAPPER} "@SMPIMAIN@" ${EXEC} ${PRIVATIZE} ${TRACEOPTIONS} ${SIMOPTS} ${PLATFORMTMP} ${APPLICATIONTMP} <&3 3>&- &
 pid=$!
 exec 3>&-
 wait $pid
 status=$?
+# With dash on Windows WSL/Ubuntu, "wait" sometimes returns early with an exit
+# status of 128. Try again.
+while test $status -eq 128 && kill -0 $pid 2>/dev/null; do
+    wait $pid
+    status=$?
+done
 pid=""
 
 # Keep temporary files on failures to help debugging