Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Basic checks on the arguments provoded to smpirun
[simgrid.git] / 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 NUMPROCS="${DEFAULT_NUMPROCS}"
17 POWER="${DEFAULT_POWER}"
18
19 SIMOPTS="--cfg=maxmin/precision:1e-9 --cfg=network/model:SMPI --cfg=network/TCP_gamma:4194304"
20
21 #usage to print the way this script should be called
22 function usage () {
23     echo "usage:"
24     echo "$0 [-quiet] [-keep-temps]"
25     echo "      [-np <numprocs>] -platform <xmldesc> -hostfile <hostfile> [-map] program [program-options]"
26     echo "      [-keep-temps]             # don't remove the generated files after execution"
27     echo "      [-map]                    # display the machine on which each process rank is mapped"
28     echo "      [-trace]                  # activate tracing"
29     echo "      [-trace-grouped]          # group MPI processes by location"
30     echo "      [-trace-resource]         # trace resource utilization"
31     echo "      [-trace-triva]            # generate configuration for Triva's GraphView"
32     echo "      [-trace-file <tracefile>] # name of the tracefile (simgrid_smpi.trace)"
33     echo "or (deprecated usage):"
34     echo "$0 [-quiet] [-keep-temps] [-np <numprocs>] [-bandwidth <bytes/sec>] [-latency <secs>] program [program-options]"
35     echo
36 }
37
38 #check if we have at least one parameter
39 if [ $# -eq 0 ]
40 then
41     usage
42     exit
43 fi
44
45 while true; do
46   case "$1" in
47    "-np" | "-n")
48       NUMPROCS="$2"
49       shift 2
50     ;;
51    "-bandwidth")
52       NETWORK_BANDWIDTH="$2"
53       shift 2
54     ;;
55    "-latency")
56       NETWORK_LATENCY="$2"
57       shift 2
58     ;;
59    "-platform")
60         PLATFORM="$2"
61       if [ ! -f ${PLATFORM} ]; then
62                 echo "[$0] ** error: the file '${PLATFORM}' does not exist. Aborting."
63                 exit 1
64       fi
65         shift 2
66     ;;
67    "-hostfile")
68         HOSTFILE="$2"
69       if [ ! -f ${HOSTFILE} ]; then
70                 echo "[$0] ** error: the file '${HOSTFILE}' does not exist. Aborting."
71                 exit 1
72       fi
73         shift 2
74     ;;
75
76    "-map")
77         MAPOPT="true"
78       shift 1
79    ;;
80
81    "-trace")
82         TRACE_ACTIVE="true"
83           shift 1
84    ;;
85
86    "-trace-file")
87       TRACE_FILENAME="$2"
88       shift 2
89    ;;
90
91    "-trace-grouped")
92       TRACE_GROUPED="true"
93       shift 1
94    ;;
95
96    "-trace-resource")
97       TRACE_RESOURCE="true"
98       shift 1
99    ;;
100
101    "-trace-triva")
102         TRACE_TRIVA="true"
103           shift 1
104    ;;
105
106    "-keep-temps")
107         KEEP="true"
108       shift 1
109    ;;
110
111    "-help" | "--help" | "-h")
112       usage
113       exit
114    ;;
115
116    "--cfg="*|"--log="*)
117      for OPT in ${1#*=}
118      do
119        SIMOPTS="$SIMOPTS ${1%%=*}=$OPT"
120      done
121      shift 1
122    ;;
123     *)
124       break
125     ;;
126   esac
127 done
128
129 EXEC="$1"
130 shift
131
132 ##-----------------------------------
133
134 # Basic checks on the provided arguments
135 if [ -z ${EXEC} ] ; then
136     echo "You must provide a program to execute."
137     usage
138     exit 1
139 fi
140
141 if [ -z ${HOSTFILE} ] ; then
142     echo "No hostfile specified."
143     usage
144     exit 1
145 fi
146
147
148 ##-------------------------------- DEFAULT or SPECIFIED PLATFORM --------------------------------------
149 if [ -z "${PLATFORM}" ]; then
150         PLATFORMTMP="$(mktemp tmpXXXXXX)"
151
152         cat > ${PLATFORMTMP} <<PLATFORMHEAD
153 <?xml version='1.0'?>
154 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
155 <platform version="3">
156 <AS id="AS0" routing="Full">
157 PLATFORMHEAD
158
159 for (( i=${NUMPROCS}; $i ; i=$i-1 )) do
160   echo "  <host id=\"host$i\" power=\"${POWER}\"/>" >> ${PLATFORMTMP}
161   echo "  <link id=\"loop$i\" bandwidth=\"${LOOPBACK_BANDWIDTH}\" latency=\"${LOOPBACK_LATENCY}\"/>" >> ${PLATFORMTMP}
162   echo "  <link id=\"link$i\" bandwidth=\"${NETWORK_BANDWIDTH}\" latency=\"${NETWORK_LATENCY}\"/>" >> ${PLATFORMTMP}
163 done
164
165 for (( i=${NUMPROCS}; $i ; i=$i-1 )) do
166   for (( j=${NUMPROCS}; $j ; j=$j-1 )) do
167     if [ $i -eq $j ]; then
168       echo "  <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"loop$i\"/></route>" >> ${PLATFORMTMP}
169     else
170       echo "  <route src=\"host$i\" dst=\"host$j\"><link_ctn id=\"link$i\"/><link_ctn id=\"link$j\"/></route>" >> ${PLATFORMTMP}
171     fi
172   done
173 done
174
175 cat >> ${PLATFORMTMP} <<PLATFORMFOOT
176 </AS>
177 </platform>
178 PLATFORMFOOT
179
180 else
181         PLATFORMTMP=${PLATFORM}
182 fi
183 ##-------------------------------- end DEFAULT or SPECIFIED PLATFORM --------------------------------------
184
185 ##-------------------------------- DEFAULT APPLICATION --------------------------------------
186 APPLICATIONTMP="$(mktemp tmpXXXXXX)"
187 #APPLICATIONTMP="app.xml"
188
189
190 cat > ${APPLICATIONTMP} <<APPLICATIONHEAD
191 <?xml version='1.0'?>
192 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
193 <platform version="3">
194 APPLICATIONHEAD
195
196 ##---- cache hostnames of hostfile---------------
197 if [ -n "${HOSTFILE}" ] && [ -f ${HOSTFILE} ]; then
198         hostnames=(`cat ${HOSTFILE} | tr \\\n " "`)
199       NUMHOSTS=`cat ${HOSTFILE} | wc -l`
200 fi
201
202 ##----------------------------------------------------------
203 ##  generate application.xml with hostnames from hostfile:
204 ##  the name of host_i (1<=i<=p, where -np p) is the line i
205 ##  in hostfile (where -hostfile hostfile), or "host$i" if
206 ##  hostfile has less than i lines.
207 ##----------------------------------------------------------
208
209 HAVE_SEQ="`which seq 2>/dev/null`"
210
211 if [ -n "${HAVE_SEQ}" ]; then
212         SEQ=`${HAVE_SEQ} 0 $((${NUMPROCS}-1))`
213 else
214       cnt=0
215         while (( $cnt < ${NUMPROCS} )) ; do
216             SEQ="$SEQ $cnt"
217             cnt=$((cnt + 1));
218         done
219 fi
220
221 ##---- generate <process> tags------------------------------
222
223 for i in ${SEQ}
224 do
225   if [ -n "${HOSTFILE}" ]; then
226         j=$(( $i % ${NUMHOSTS} ))
227   fi
228   ##---- optional display of ranks to process mapping
229   if [ -n "${MAPOPT}" ]; then
230         echo "[rank $i] -> ${hostnames[$j]}"
231   fi
232
233   if [ -z "${hostnames[$j]}" ]; then
234         host="host"$(($j+1))
235   else
236         host="${hostnames[$j]}"
237   fi
238   echo "  <process host=\"${host}\" function=\"rank$i\"> <!-- function name used only for logging -->" >> ${APPLICATIONTMP}
239   echo "    <argument value=\"$i\"/> <!-- rank -->" >> ${APPLICATIONTMP}
240   for ARG in $*; do
241     echo "    <argument value=\"${ARG}\"/>" >> ${APPLICATIONTMP}
242   done
243   echo "  </process>" >> ${APPLICATIONTMP}
244 done
245
246 cat >> ${APPLICATIONTMP} <<APPLICATIONFOOT
247 </platform>
248 APPLICATIONFOOT
249 ##-------------------------------- end DEFAULT APPLICATION --------------------------------------
250
251 ##---------------------- SMPI TRACING OPTIONS ---------------------------------
252 if [ -n "${TRACE_ACTIVE}" ]; then
253   #define trace filename
254   if [ -z "${TRACE_FILENAME}" ]; then
255     TRACE_FILENAME="smpi_simgrid.trace"
256   fi
257   TRACEOPTIONS="--cfg=tracing:1 --cfg=tracing/filename:${TRACE_FILENAME} --cfg=tracing/smpi:1"
258
259   if [ -n "${TRACE_GROUPED}" ]; then
260     TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/smpi/group:1"
261   fi
262
263   if [ -n "${TRACE_RESOURCE}" ]; then
264     TRACEOPTIONS="${TRACEOPTIONS} --cfg=tracing/categorized:1 --cfg=tracing/uncategorized:1"
265   fi
266
267   if [ -n "${TRACE_TRIVA}" ]; then
268     TRACEOPTIONS="${TRACEOPTIONS} --cfg=triva/categorized:smpi_cat.plist --cfg=triva/uncategorized:smpi_uncat.plist"
269   fi
270 fi
271 ##---------------------- end SMPI TRACING OPTIONS ---------------------------------
272
273 export SMPI_GLOBAL_SIZE=${NUMPROCS}
274 if [ -n "${KEEP}" ] ; then
275   echo ${EXEC} ${SIMOPTS} ${TRACEOPTIONS} ${PLATFORMTMP} ${APPLICATIONTMP}
276 fi
277 ${EXEC} ${SIMOPTS} ${TRACEOPTIONS} ${PLATFORMTMP} ${APPLICATIONTMP}
278 status=$?
279
280 if [ -z "${KEEP}" ] ; then
281    if [ -z "${PLATFORM}" ]; then
282         rm ${PLATFORMTMP}
283    fi
284    rm ${APPLICATIONTMP}
285 fi
286
287 exit $status