Docs: cleanup mpiexec description
[charm.git] / doc / install / run.tex
1 \section{Executing \charmpp{} Programs}
2 \label{executing charm programs}
3
4 When compiling \charmpp{} programs, the charmc linker produces 
5 both an executable file and a program called {\tt charmrun},
6 which is used to load the executable onto the parallel machine.
7
8 To run a \charmpp{} program named ``pgm'' on four processors, type:
9 \begin{alltt}
10 charmrun pgm +p4
11 \end{alltt}
12
13
14 Programs built using the network version of \charmpp{} can be run
15 alone, without charmrun.  This restricts you to using the processors
16 on the local machine, but it is convenient and often useful for
17 debugging.  For example, a \charmpp{} program can be run on one
18 processor in the debugger using:
19
20 \begin{alltt}
21 gdb pgm
22 \end{alltt}
23
24 \subsection[Command Line Options]{Command Line Options}
25 \label{command line options}
26 \index{command line options}
27
28 A \charmpp{} program accepts the following command line options:
29 \begin{description}
30
31 \item[{\tt +pN}] Run the program with N processors. The default is 1.
32
33 \item[{\tt +ss}] Print summary statistics about chare creation.  This option
34 prints the total number of chare creation requests, and the total number of
35 chare creation requests processed across all processors.
36
37 \item[{\tt +cs}] Print statistics about the number of create chare messages
38 requested and processed, the number of messages for chares requested and 
39 processed, and the number of messages for branch office chares requested and
40 processed, on a per processor basis.  Note that the number of messages 
41 created and processed for a particular type of message on a given node 
42 may not be the same, since a message may be processed by a different
43 processor from the one originating the request.
44
45 \item[{\tt user\_options}] Options that are be interpreted by the user
46 program may be included mixed with the system options. 
47 However, {\tt user\_options} cannot start with +.
48 The {\tt user\_options} will be passed as arguments to the user program 
49 via the usual {\tt argc/argv} construct to the {\tt main}
50 entry point of the main chare. 
51 \charmpp{} system options will not appear in {\tt argc/argv}.
52
53 \end{description}
54
55
56
57 \subsubsection{Additional Network Options}
58 \label{network command line options}
59
60 The following {\tt ++} command line options are available in
61 the network version:
62 \begin{description}
63
64 \item[{\tt ++local}] Run charm program only on local machines. No 
65  remote shell invocation is needed in this case. It starts node programs 
66  right on your local machine. This could be useful if you just want to 
67  run small program on only one machine, for example, your laptop.
68
69
70 \item[{\tt ++mpiexec}]
71
72 Use the cluster's {\tt mpiexec} job launcher instead of the built in rsh/ssh
73 method.
74
75 This will pass {\tt -np \$P} to indicate how many processes to
76 launch. An executable named something other than {\tt mpiexec} can be
77 used with the additional argument {\tt ++remote-shell} {\it runmpi},
78 with `runmpi' replaced by the necessary name. At present, this depends
79 on the environment variables {\tt OMPI\_COMM\_WORLD\_RANK} and {\tt
80   OMPI\_COMM\_WORLD\_SIZE} being set in each launched process.
81
82 Use of this option can potentially provide a few benefits:
83
84 \begin{itemize}
85 \item Faster startup compared to the SSH/RSH approach charmrun would
86   otherwise use
87 \item No need to generate a nodelist file
88 \item Multi-node job startup on clusters that do no allow connections
89   from the head/login nodes to the compute nodes
90 \end{itemize}
91
92 \item[{\tt ++debug}] Run each node under gdb in an xterm window, prompting
93 the user to begin execution.
94
95 \item[{\tt ++debug-no-pause}] Run each node under gdb in an xterm window
96 immediately (i.e. without prompting the user to begin execution).
97
98 \item[{\tt ++maxrsh}] Maximum number of {\tt rsh}'s to run at a
99 time.
100
101 \item[{\tt ++nodelist}] File containing list of nodes.
102
103
104 \item[{\tt ++ppn}]              number of pes per node
105
106 \item[{\tt ++help}]             print help messages
107
108 \item[{\tt ++runscript}]        script to run node-program with
109
110 \item[{\tt ++xterm}]            which xterm to use
111
112 \item[{\tt ++in-xterm}]         Run each node in an xterm window
113
114 \item[{\tt ++display}]          X Display for xterm
115
116 \item[{\tt ++debugger}]         which debugger to use
117
118 \item[{\tt ++remote-shell}]     which remote shell to use
119
120 \item[{\tt ++useip}]            Use IP address provided for charmrun IP
121
122 \item[{\tt ++usehostname}]      Send nodes our symbolic hostname instead of IP address
123
124 \item[{\tt ++server-auth}]      CCS Authentication file
125
126 \item[{\tt ++server-port}]      Port to listen for CCS requests
127
128 \item[{\tt ++server}]           Enable client-server (CCS) mode
129
130 \item[{\tt ++nodegroup}]        which group of nodes to use
131
132 \item[{\tt ++verbose}]          Print diagnostic messages
133
134 \item[{\tt ++timeout}]          seconds to wait per host connection
135
136 \item[{\tt ++p}]                number of processes to create
137
138 \end{description}
139
140 If using the {\tt ++debug} option, the user must ensure the
141 following:
142 \begin{enumerate}
143
144 \item The {\tt DISPLAY} environment variable points to your terminal.
145 SSH's X11 forwarding does not work properly with \charmpp{}.
146
147 \item The nodes must be authorized to create windows on the host machine (see
148 man pages for {\tt xhost} and {\tt xauth}).
149
150 \item {\tt xterm}, {\tt xdpyinfo},  and {\tt gdb} must be in
151 the user's path.
152
153 \item The path must be set in the {\tt .cshrc} file, not the {\tt .login}
154 file, because {\tt rsh} does not run the {\tt .login} file. 
155
156 \end{enumerate}
157
158
159 \subsubsection{Multicore Options}
160
161 On multicore platforms, operating systems (by default) are free to move
162 processes and threads among cores to balance load. This however sometimes can
163 degrade the performance of Charm++ applications due to the extra overhead of
164 moving processes and threads, especailly when Charm++ applications has already
165 implemented its own dynamic load balancing.
166
167 Charm++ provides the following runtime options to set the processor affinity
168 automatically so that processes or threads no longer move. When cpu affinity
169 is supported by an operating system (tested at Charm++ configuration time),
170 same runtime options can be used for all flavors of Charm++ versions including
171 network and MPI versions, smp and non-smp versions.
172
173 \begin{description}
174
175 \item[{\tt +setcpuaffinity}]             set cpu affinity automatically for processes (when Charm++ is based on non-smp versions) or threads (when smp)
176
177 \item[{\tt +excludecore <core \#>}]       does not set cpu affinity for the given core number. One can use this option multiple times to provide a list of core numbers to avoid.
178
179 \end{description}
180
181 \subsection{Nodelist file}
182
183 For network of workstations,
184 the list of machines to run the program can be specified in a file.  
185 Without a nodelist file, \charmpp{} runs the program only on the 
186 local machine.
187
188 The format of this file
189 allows you to define groups of machines, giving each group a name.
190 Each line of the nodes file is a command.  The most important command
191 is:
192
193 \begin{alltt}
194 host <hostname> <qualifiers>
195 \end{alltt}
196
197 which specifies a host.  The other commands are qualifiers: they modify
198 the properties of all hosts that follow them.  The qualifiers are:
199
200
201 \begin{tabbing}
202 {\tt group <groupname>}~~~\= - subsequent hosts are members of specified group\\
203 {\tt login <login>  }     \> - subsequent hosts use the specified login\\
204 {\tt shell <shell>  }     \> - subsequent hosts use the specified remote 
205 shell\\
206 %{\tt passwd <passwd>}     \> - subsequent hosts use the specified password\\
207 {\tt setup <cmd>  }       \> - subsequent hosts should execute cmd\\
208 {\tt pathfix <dir1> <dir2>}         \> - subsequent hosts should replace dir1 with dir2 in the program path\\
209 {\tt cpus <n>}            \> - subsequent hosts should use N light-weight processes\\
210 {\tt speed <s>}           \> - subsequent hosts have relative speed rating\\
211 {\tt ext <extn>}          \> - subsequent hosts should append extn to the pgm name\\
212 \end{tabbing}
213
214 {\bf Note:}
215 By default, charmrun uses a remote shell ``rsh'' to spawn node processes
216 on the remote hosts. The {\tt shell} qualifier can be used to override
217 it with say, ``ssh''. One can set the {\tt CONV\_RSH} environment variable
218 or use charmrun option {\tt ++remote-shell} to override the default remote 
219 shell for all hosts with unspecified {\tt shell} qualifier.
220
221 All qualifiers accept ``*'' as an argument, this resets the modifier to
222 its default value.  Note that currently, the passwd, cpus, and speed
223 factors are ignored.  Inline qualifiers are also allowed:
224
225 \begin{alltt}
226 host beauty ++cpus 2 ++shell ssh
227 \end{alltt}
228
229 Except for ``group'', every other qualifier can be inlined, with the
230 restriction that if the ``setup'' qualifier is inlined, it should be
231 the last qualifier on the ``host'' or ``group'' statement line.
232
233 Here is a simple nodes file:
234
235 \begin{alltt}
236         group kale-sun ++cpus 1
237           host charm.cs.uiuc.edu ++shell ssh
238           host dp.cs.uiuc.edu
239           host grace.cs.uiuc.edu
240           host dagger.cs.uiuc.edu
241         group kale-sol
242           host beauty.cs.uiuc.edu ++cpus 2
243         group main
244           host localhost
245 \end{alltt}
246
247 This defines three groups of machines: group kale-sun, group kale-sol,
248 and group main.  The ++nodegroup option is used to specify which group
249 of machines to use.  Note that there is wraparound: if you specify
250 more nodes than there are hosts in the group, it will reuse
251 hosts. Thus,
252
253 \begin{alltt}
254         charmrun pgm ++nodegroup kale-sun +p6
255 \end{alltt}
256
257 uses hosts (charm, dp, grace, dagger, charm, dp) respectively as
258 nodes (0, 1, 2, 3, 4, 5).
259
260 If you don't specify a ++nodegroup, the default is ++nodegroup main.
261 Thus, if one specifies
262
263 \begin{alltt}
264         charmrun pgm +p4
265 \end{alltt}
266
267 it will use ``localhost'' four times.  ``localhost'' is a Unix
268 trick; it always find a name for whatever machine you're on.
269
270 The user is required to set up remote login permissions on all nodes
271 using the ``.rhosts'' file in the home directory if ``rsh'' is used for remote
272 login into the hosts. If ``ssh'' is used, the user will have to setup
273 password-less login to remote hosts using
274 RSA authentication based on a key-pair and adding public keys to 
275 ``.ssh/authorized\_keys'' file. See ``ssh'' documentation for more information.
276
277 In a network environment, {\tt charmrun} must
278 be able to locate the directory of the executable.  If all workstations
279 share a common file name space this is trivial.  If they don't, {\tt charmrun}
280 will attempt to find the executable in a directory with the same path
281 from the {\bf \$HOME} directory.  Pathname resolution is performed as 
282 follows:
283 \begin{enumerate}
284         \item The system computes the absolute path of {\tt pgm}.
285         \item If the absolute path starts with the equivalent of {\bf \$HOME} 
286         or the current working directory, the beginning part of the 
287         path 
288         is replaced with the environment variable {\bf \$HOME} or the 
289         current working directory. However, if {\tt ++pathfix dir1 dir2} is 
290         specified in the nodes file (see above), the part of
291         the path matching {\tt dir1} is replaced with {\tt dir2}.
292         \item The system tries to locate this program (with modified 
293         pathname and appended extension if specified) on all nodes.
294 \end{enumerate}
295
296 \subsubsection{IO buffering options}
297 \label{io buffer options}
298 There may be circumstances where a \charmpp{} application may want to take
299 or relinquish control of stdout buffer flushing. Most systems default to
300 giving the \charmpp{} runtime control over stdout but a few default to
301 giving the application that control. The user can override these system
302 defaults with the following runtime options:
303
304 \begin{description}
305 \item[{\tt +io\_flush\_user}]     User (application) controls stdout flushing
306 \item[{\tt +io\_flush\_system}]   The \charmpp{} runtime controls flushing
307 \end{description}