Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use the CMake macro #cmakedefine01 in configurable files.
[simgrid.git] / doc / manpage / smpirun.1
1 .TH smpirun 1
2 .SH NAME
3 smpirun \- Exectute MPI programs in the SimGrid simulator
4 .SH SYNOPSIS
5 smpirun [\fISMPI OPTIONS\fR]… \fB\-platform\fR <platform.xml> \fB\-hostfile\fR <hostfile> program [\fISIMULATION OPTIONS\fR] [\fIPROGRAM OPTIONS\fR]
6 .SH DESCRIPTION
7 smpirun car run MPI programs that were compiled with smpicc on top of
8 the simulator. Basically, it generates a deployment files from the
9 provided hostfile (if needed), and launches the simulation with the right
10 arguments. It is intended to be easy to use to regular MPI users.
11 .SH MANDATORY PARAMETERS
12 .TP
13 \fB\-platform\fR <platform.xml>
14 XML file describing the platform on which we want to deploy the program 
15 .TP
16 \fB\-hostfile\fR, \fB\-machinefile\fR <hostfile>
17 Hostfile listing all the machines in use
18 .SH SMPI OPTIONS
19 The smpirun itself accepts some optionnal parameters, that are not to
20 be mixed with the configuration options described in the next section.
21
22 .TP
23 \fB\-help\fR
24 Print the usage and a résumé of the available options
25 .TP
26 \fB\-keep-temps\fR
27 Do not remove the generated files after execution.
28 .TP
29 \fB\-wrapper\fR <command>
30 Use command to run the program (e.g. "valgrind", "gdb --args", "rr record").
31 You usually want to use the "-foreground" option as well in order to have a TTY.
32 .TP
33 \fB\-foreground\fR
34 Run the child process in the foreground.
35 This gives the child process access to the TTY.
36 .TP
37 \fB\-map\fR
38 Display the machine on which each process rank is mapped.
39 .TP
40 \fB\-np\fR <numprocs>
41 Use that amount of processes. By default, there is the same number of processes as there are of hosts in the hostfile.
42 .TP
43 \fB\-no-privatize\fR
44 Disable the globals privatization, that is activated by default.
45 This should only be necessary if you use dynamic libraries, but you
46 should probably link statically instead of disabling this. Do not link
47 statically against SimGrid, only the others.
48 .TP
49 \fB\-trace\fR
50 Activate the trace mechanism if available (equivalent to \fB--cfg\fR=\fItracing\fR:\fIyes\fR \fB--cfg\fR=\fItracing/smpi\fR:\fIyes\fR)
51 .TP
52 \fB\-trace-ti\fR
53 Activate time independant tracing.
54 .TP
55 \fB\-trace-comment\fR <comment>
56 Put a comment on the top of the trace file.
57 .TP
58 \fB\-trace-comment-file\fR <file>
59 Insert the content of the file at the head of the trace file as a comment.
60 .TP
61 \fB\-trace-grouped\fR
62 Group MPI processes by location.
63 .TP
64 \fB\-trace-resource\fR
65 Trace resource utilization.
66 .TP
67 \fB\-trace-viva\fR
68 Generate configuration for Viva's GraphView.
69 .TP
70 \fB\-trace-file\fR <tracefile>
71 Name of the tracefile
72
73 .SH SIMULATION OPTIONS
74 You can change many simulation parameter on the command line by passing
75 \fB--cfg\fR=\fIparameter\fR:\fIvalue\fR after the program name. 
76 A full list of existing parameters and their meaning can be found at
77 http://simgrid.gforge.inria.fr/simgrid/latest/doc/options.html 
78
79 Here are some options commonly used with SMPI:
80 .TP
81 \fB--cfg=smpi/cpu-threshold:XXX\fR
82 Only simulate computation chunks that last more than XXX seconds.
83 .TP
84 \fB--cfg=smpi/simulate-computation:no\fR
85 Disable the simulation of all computation chunks (that are still executed on the host machine).
86
87 .SH AUTHORS
88 The SimGrid team (simgrid-devel@lists.gforge.inria.fr)
89 .SH COPYRIGHT AND LICENCE
90 Copyright (c) 2014-2016. The SimGrid Team. All rights reserved.
91
92 This program is free software; you may redistribute it and/or modify
93 it under the terms of GNU LGPL (v2.1) license. 
94 .SH SEE ALSO
95 .B smpicc\fR(1)
96 .B smpicxx\fR(1)
97 .B smpiff\fR(1)
98 .B smpif90\fR(1)