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