docs/manpages/smpirun.1

   1 .TH smpirun 1
   2 .SH NAME
   3 smpirun \- Execute 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 can run MPI programs that were compiled with smpicc on top of
   8 the simulator. Basically, it generates a deployment file 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 Please refer to the
  16 .UR https://simgrid.org/doc/latest/Tutorial_MPI_Applications.html#describing-your-platform
  17 online documentation.
  18 .UE
  19 .TP
  20 \fB\-hostfile\fR, \fB\-machinefile\fR <hostfile>
  21 Hostfile listing all the machines in use
  22 .SH SMPI OPTIONS
  23 The smpirun itself accepts some optional parameters, that are not to
  24 be mixed with the configuration options described in the next section.
  25
  26 .TP
  27 \fB\-help\fR
  28 Print the usage and a summary of the available options.
  29 .TP
  30 \fB\-keep-temps\fR
  31 Do not remove the generated files after execution.
  32 .TP
  33 \fB\-wrapper\fR <command>
  34 Use command to run the program (e.g. "valgrind", "gdb --args", "rr record").
  35 You usually want to use the "-foreground" option as well in order to have a TTY.
  36 .TP
  37 \fB\-gdb\fR
  38 Run within GDB (equivalent to -wrapper "gdb --args" -keep-temps).
  39 .TP
  40 \fB\-lldb\fR
  41 Run within LLDB (equivalent to -wrapper "lldb --" -keep-temps).
  42 .TP
  43 \fB\-vgdb\fR
  44 Run within Valgrind+GDB (equivalent to -wrapper "valgrind --vgdb=yes --vgdb-error=0" -keep-temps).
  45 .TP
  46 \fB\-foreground\fR
  47 Run the child process in the foreground.
  48 This gives the child process access to the TTY.
  49 .TP
  50 \fB\-map\fR
  51 Display the machine on which each process rank is mapped.
  52 .TP
  53 \fB\-np\fR <numprocs>
  54 Use that amount of processes. By default, there is the same number of processes as there are of hosts in the hostfile.
  55 .TP
  56 \fB\-no-privatize\fR
  57 Disable the privatization of global variables, that is activated by default.
  58 This should only be necessary if you use dynamic libraries, but you
  59 should probably link statically instead of disabling this. Do not link
  60 statically against SimGrid, only against the other libraries.
  61 .TP
  62 \fB\-trace\fR
  63 Activate the trace mechanism if available (equivalent to \fB--cfg\fR=\fItracing\fR:\fIyes\fR \fB--cfg\fR=\fItracing/smpi\fR:\fIyes\fR)
  64 .TP
  65 \fB\-trace-ti\fR
  66 Activate time independent tracing.
  67 .TP
  68 \fB\-trace-comment\fR <comment>
  69 Put a comment on the top of the trace file.
  70 .TP
  71 \fB\-trace-comment-file\fR <file>
  72 Insert the content of the file at the head of the trace file as a comment.
  73 .TP
  74 \fB\-trace-grouped\fR
  75 Group MPI processes by location.
  76 .TP
  77 \fB\-trace-resource\fR
  78 Trace resource utilization.
  79 .TP
  80 \fB\-trace-file\fR <tracefile>
  81 Name of the tracefile
  82 .TP
  83 \fB\-replay\fR <tracefile>
  84 Replay a trace instead of actually executing an application.
  85 .TP
  86 \fB\-quiet\fR
  87 Reduce output verbosity. This is useful to make tests reproducible.
  88 .TP
  89 \fB\-version\fR
  90 Displays the SimGrid version (human readable).
  91 .TP
  92 \fB\-git-version\fR
  93 Displays the git hash of SimGrid.
  94 .TP
  95 .SH SIMULATION OPTIONS
  96 You can change many simulation parameters on command line by passing
  97 \fB--cfg\fR=\fIparameter\fR:\fIvalue\fR after the program name.
  98 A full list of the existing parameters and their meaning can be found at
  99 https://simgrid.org/doc/latest/Configuring_SimGrid.html
 100
 101 Here are some options commonly used with SMPI:
 102 .TP
 103 \fB--cfg=smpi/cpu-threshold:XXX\fR
 104 Only simulate computation chunks that last more than XXX seconds.
 105 .TP
 106 \fB--cfg=smpi/simulate-computation:no\fR
 107 Disable the simulation of all computation chunks (that are still executed on the host machine).
 108
 109 .SH AUTHORS
 110 The SimGrid team
 111 .SH COPYRIGHT AND LICENCE
 112 Copyright (c) 2014-2023. The SimGrid Team. All rights reserved.
 113
 114 This program is free software; you may redistribute it and/or modify
 115 it under the terms of GNU LGPL (v2.1) license.
 116 .SH SEE ALSO
 117 .B smpicc\fR(1)
 118 .B smpicxx\fR(1)
 119 .B smpiff\fR(1)
 120 .B smpif90\fR(1)