added -h, --help option to display a much detailed help page.
[charm.git] / README
1                            Charm++ CVS Version
2
3        Copyright (C) 1989-2000 Regents of the University of Illinois
4
5 INTRODUCTION
6 ============
7
8 Charm++ is a message-passing parallel language and runtime system.
9 It is implemented as a set of libraries for C++, is efficient,
10 and is portable to a wide variety of parallel machines.
11 Source code is provided, and non-commercial use is free.
12
13
14 GETTING THE LATEST CHARM SOURCE
15 ===============================
16
17 You can use our anonymous cvs server to checkout the latest charm++ source code.
18 (It may not be the latest stable version though) 
19 What you need to do is as following:
20
21 1. login the cvs server:
22
23       cvs -d :pserver:checkout@charm.cs.uiuc.edu:/cvsroot login
24
25       when CVS password is prompted, just press enter.
26 2. checkout charm:
27
28       cvs co -P charm
29
30       You should get latest charm source tree.
31 3. logout the cvs server:
32
33       cvs logout
34
35
36 PICKING A VERSION
37 =================
38
39 First, you need to decide which version of charm++ to use. The "build" 
40 script in charm source directory takes several command line options to
41 compile Charm++. The command line syntax is:
42
43 build <target> <version> [options ...] [--basedir=dir] [--libdir=dir] [--incdir=dir] [charmc-options ...]
44
45 for detailed help messages, use -h or --help to the build script, i.e.
46 ./build --help
47
48 REQUIRED:
49 ---------
50 <target> specifies the parts of Charm++ to compile.  The most often used 
51   <target> is "charm++", which will compile the key Charm++ executables and 
52   runtime libraries.  Other common targets are "AMPI" and "FEM".
53 <versions> defines the CPU, OS and Communication layer of the machines.  See 
54   "How to choose a <version>" below for details.
55
56 OPTIONAL:
57 ---------
58 <options> defines more detailed information of the compilations, including 
59   compilers, features to support, etc.  See "How to choose <option>"
60   below.
61 [--libdir=dir] specify additional lib paths for building Charm++.
62 [--incdir=dir] specify additional include paths for building Charm++.
63 [--basedir=dir] a shortcut to specify additional include and lib paths for 
64                building Charm++, the include path is dir/include and lib path 
65                is dir/lib.
66
67
68 Running build script, a directory of the name of combination of version and 
69 options like "<version>-<option1>-<option2>-..." will be created and 
70 the build script will compile Charm++ under this directory.
71
72 For example, on an ordinary Linux PC:
73
74    ./build charm++ net-linux
75
76 will build charm++ in the directory: net-linux/.  The communication
77 defaults to UDP packets and the compiler to gcc.
78
79 For a more complex example, on a Scyld workstation with the Intel C++ 
80 compiler, where you want the communication to happen over TCP sockets:
81
82    ./build charm++ net-linux scyld icc tcp
83
84 will build charm++ in the directory: net-linux-scyld-tcp-icc/.
85
86 You can specify multiple options, however you can use at most one compiler 
87 option. The sequence of the options are not important given in build script, 
88 only one directory name will be generated, following the rules:
89 1. compiler option will be at the end;
90 2. other options are sorted alphabetically.
91
92 **** How to choose a <version> ****
93
94 Here is the table for choosing correct version. The default setting of compiler
95 in Charm version is gcc/g++. However, one can use <options> to specify other 
96 compilers. See the detailed explanation of the <options> below.
97 (Note: this isn't a complete list.  Run ./build for a complete listing)
98
99 Charm version          OS        Communication    Default Compiler  
100 -------------       ---------    --------------   --------------------
101 net-linux            PC Linux       UDP/Myrinet   GNU compiler
102 net-sol              Solaris        UDP           GNU compiler
103 net-win32            Win32          UDP           MS Visual C++
104 net-cygwin           Win32/cygwin   UDP           GNU compiler
105 mpi-sp               IBM A/IX       MPI           A/IX xlC Compiler 
106 mpi-origin           Origin2000     MPI           SGI C++ compiler
107
108 net-ppc-darwin       MacOS X        UDP           GNU C++ compiler
109 net-linux-ia64       IA64 Linux     UDP/Myrinet   GNU compiler
110 net-irix             IRIX           UDP           GNU compiler
111 net-axp              Alpha          UDP           GNU compiler
112 net-hp               HP-UX          UDP           GNU compiler
113 mpi-linux            PC Linux       MPI           GNU compiler
114 mpi-linux-ia64       IA64 Linux     MPI           GNU compiler
115 mpi-axp              Alpha          MPI           GNU compiler
116 mpi-linux-axp        Alpha Linux    MPI           GNU compiler
117 origin2000           Origin2000  shared-mem       SGI C++ compiler
118 t3e                  Cray T3E    shared-mem       Cray C++ compiler
119
120
121 To choose <version>, your choice is determined by three options:
122
123 1.)  The way a parallel program written in Charm++ will communicate:
124
125         "net-" Charm++ communicates using the regular TCP/IP stack
126 (UDP packets), which works everywhere but is fairly slow.  Use this
127 option for networks of workstations, clusters, or single-machine 
128 development and testing.
129
130         "mpi-" Charm++ communicates using MPI calls.  Use this for
131 machines with a good MPI implementation (such as the Origin 2000).
132
133         "exemplar", "ncube-2", "paragon-red", "sp3", and "t3e" Charm++
134 communicates using direct calls to the machine's communication primitives.
135
136         "sim-" and "uth-" are not actively maintained.  These are
137 single-processor versions: "uth-" simulates processors as user-level
138 threads; "sim-" switches between processors and counts communications.
139
140
141 2.)  Your operating system:
142
143         "linux"   Linux 
144         "win32"   MS Windows with MS Visual C++ compiler
145         "cygwin"  MS Windows with Cygnus' Cygwin Unix layer
146         "irix"    SGI IRIX
147         "origin"  SGI Origin 2000 IRIX
148         "sol"     Solaris
149         "sun"     SunOS
150         "rs6k"    IBM R/S 6000 A/IX 
151         "sp"      IBM SP A/IX
152         "hp"      Hewlett-Packard HP-UX
153         "axp"     DEC Alpha DECUNIX
154         
155
156 3.)  Some operating systems have other options, such as:
157         "-x86"     For Solaris, use PC hardware (instead of Sun).
158         "-axp"     For Linux, use Alpha hardware (instead of PC).
159         "-ia64"    Use Itanium(tm) instructions (instead of x86)
160
161 Your Charm++ version is made by concatenating the options, e.g.:
162
163 "net-linux"     Charm++ for a network of Linux workstations, compiled
164                 using g++.
165 "mpi-origin"    Charm++ for SGI Origin 2000, compiled using SGI CC.
166
167
168 **** How to choose <options> ****
169
170 <version> above defines the most important OS, CPU and Communication of 
171 your machine, and most of time, it use the GNU gcc as default compiler. 
172 To use different compiler or demand additional special feature support, you 
173 need to choose <options> from the following list:
174
175 * gcc3  - GNU GCC/G++ version 3
176 * acc  - HP aC++ compiler
177 * cc  - For Sun WorkShop C++ compilers;
178 * cc64 - For 64 bits Sun WorkShop C++ compilers;
179 * cxx - DIGITAL C++ compiler;
180 * kcc - KAI C++ compiler;
181 * pgcc - Portland Group's C++ compiler;
182 * icc - Intel C/C++ compiler for Linux IA32
183 * ecc - Intel C/C++ compiler for Linux IA64
184 * mpcc - SUN Solaris C++ compiler for MPI.
185
186 * scyld - support Beowulf Scyld;
187 * gm - support MyriCom's Myrinet GM library;
188 * vmi - support NCSA's VMI library;
189
190 * tcp - for net- version, default communication is via UDP. Using option
191         tcp will switch to TCP. TCP version of CHarm++ is usually slower
192         than UDP, but it is more reliable.
193 * smp - Enable direct SMP support.  An "smp" version communicates using
194         shared memory within a machine; but normal message passing across 
195         machines. Because of locking, "smp" may slightly impact non-SMP 
196         performance. Try your application to decide if enabling smp mode 
197         improves performance.
198
199 * bluegene - compile Charm++ as running on Blue Gene emulator.
200 * help - show supported options for a version. For example, for net-linux, 
201          running:
202          > ./build charm++ net-linux help
203          will give:
204          supported options: gcc3 gm icc kcc pgcc scyld smp bluegene tcp
205
206
207 BUILDING THE SOURCE
208 ===================
209
210 If you have downloaded a binary version of Charm++, you can skip
211 this step-- Charm++ should already be compiled.  For win32 systems,
212 see README.win32; for Cygwin version, see README.cygwin; for net- version, 
213 see README.net.
214
215 Once you have decided on a version, unpack Charm++, cd into charm,
216 and run
217
218      > ./build <target> <version> <opts>
219
220 <target> is one of
221         "charm++"  The basic Charm++ language.
222         "AMPI"     An implementation of MPI on top of Charm++
223         "FEM"      A Finite-Element framework on top of Charm++
224
225 <version> is described above
226
227 <opts> are build-time options (such as the compiler or "smp"), 
228 or command line options passed to the charmc compile script.
229 Common compile time options such as -g, -O, -Ipath, -Lpath, -llib are 
230 accepted.
231
232 For example, on a Linux machine, you would run
233      > ./build charm++ net-linux -O
234
235 This will construct a net-linux directory, link over all
236 the Charm++ source code into net-linux/tmp, build the entire
237 Charm++ runtime system in net-linux/tmp, and link sample programs 
238 into net-linux/pgms.
239
240 Several #define's control the compilation of Charm++.  Some of these
241 #define's can be found in src/<version>/conv-mach.h.  #define's can
242 also be specified on the command line, using the -D option.  For
243 example,
244     > ./build charm++ net-linux -O -DCMK_OPTIMIZE=1
245
246 CMK_OPTIMIZE: Turn on optimizations in Charm++/Converse. This disables most of
247 the run-time checking performed by Converse and Charm++ runtime. This option
248 should be used only after the program has been debugged. Also, this option
249 disables Converse/Charm++ tracing mechanisms such as projections and summary.
250
251
252 BUILDING A PROGRAM
253 ==================
254
255 To make a sample program, cd into pgms/charm++/queens/.
256 This program solves the N-queens problem-- find how many ways there 
257 are to arrange N queens on an NxN chess board such that none may 
258 attack another.
259
260 To build the program, type make.  You should get an
261 executable named "pgm".
262
263
264 RUNNING A PROGRAM
265 ==================
266
267 Following the previous example, to run the program on two processors, type
268
269      > ./charmrun ./pgm 12 100 +p2
270
271 This should run for a few seconds, and print out:
272 There are 14200 Solutions to 12 queens. Finish time=4.030000
273
274 Charmrun is used to provide a uniform interface to run charm programs.
275 On some platforms, charmrun is just a shell script which calls the 
276 platform-specific start program, such as mpirun on mpi versions.
277
278 For net- version, charmrun is an executable which invokes rsh or ssh to start 
279 node programs on remote machines. You should set up a ~/.nodelist that 
280 enumerates all the machines you want to run jobs on, otherwise it will
281 create a default ~/.nodelist for you that contains only localhost. Here is a 
282 typical .nodelist file:
283
284 group main ++shell /bin/ssh
285 host <machinename>
286
287 The default remote shell program is rsh, but you can define different remote 
288 shell you like to start remote processes in the ++shell option. You should 
289 also make sure that you can rsh or ssh to these machines without password 
290 authentication. Just type following command to verify:
291      > rsh <machinename> date
292 If this gives you current date immediately, your running environment with this 
293 node has been setup correctly.
294
295 Now, for test running purpose, net- version charmrun comes with an easy-to-use 
296 "++local" options. No remote shell invocation is needed in this case. It starts
297 node programs right on your local machine. This could be useful if you just 
298 want to run program on only one machine, for example, your laptop. This
299 can save you all the hassle of setting up rsh/ssh or charmd daemons.
300 To use this option, just type:
301      
302      > ./charmrun ++local ./pgm 12 100 +p2
303
304 However, for best performance, you should launch one node program per processor.
305
306 For more detailed information, please check the "INSTALLATION MANUAL" and "RUN MANUAL" 
307 under doc/install.
308
309
310 FOR MORE INFORMATION
311 ====================
312
313 The Charm++ web page, with documentation, more programs,
314 and the latest version of Charm++, is at
315         http://charm.cs.uiuc.edu/
316
317 The Charm++ mailing list, for questions, comments, suggestions, 
318 improvements, or bug reports is
319         ppl@cs.uiuc.edu
320
321
322 AUTHORS
323 =======
324
325 Charm++ was created and is maintained by the Parallel Programming Lab, 
326 in the Computer Science department at the University of Illinois at
327 Urbana-Champaign.  Our managing professor is Dr. L.V. Kale; students
328 have included (in rough time order) Wennie Shu, Kevin Nomura, Wayne
329 Fenton, Balkrishna Ramkumar, Vikram Saletore, Amitabh B. Sinha, Manish
330 Gupta, Attila Gursoy, Balkrishna Ramkumar, Amitabh B. Sinha, Nimish
331 Shah, Sanjeev Krishnan, Jayant DeSouza, Parthasarathy Ramachandran,
332 Jeff Wright, Michael Lang, Jackie Wang, Fang Hu, Michael Denardo,
333 Joshua Yelon, Narain Jagathesan, Zehra Sura, Krishnan Varadarajan, and
334 Sameer Paranjpye.  Current developers include Milind Bhandarkar,
335 Robert Brunner, Terry Wilmarth, Gengbin Zheng, Jayant Desouza, Orion
336 Lawlor, Karthik Mahesh, and Neelam Saboo.
337
338
339
340