1cf6d2eb064f19e9d0d084ac6e120415b09340b3
[charm.git] / doc / jade / manual.tex
1 \documentclass[10pt]{article}
2 \usepackage{../pplmanual}
3 \input{../pplmanual}
4
5 \title{Jade Language Manual}
6 \version{1.0}
7 \credits{
8 Jade was developed by Jayant DeSouza.
9 }
10
11 \begin{document}
12 \maketitle
13
14 \section{Introduction}
15
16 This manual describes \jade, which is a new parallel programming language
17 developed over \charmpp{} and Java. \charmpp{} is a
18 \CC{}-based parallel programming library developed by Prof. L. V. Kal\'{e} 
19 and his students over the last 10 years at University of Illinois.
20
21 We first describe our philosophy behind this work (why we do what we do).
22 Later we give a brief introduction to \charmpp{} and rationale for \jade. We
23 describe \jade in detail. Appendices contain the details of installing
24 \jade, building and running \jade programs.
25
26 \subsection{Our Philosophy}
27
28 \subsection{Terminology}
29
30 \begin{description}
31
32 \item[Module] A module refers to 
33
34 \item[Thread] A thread is a lightweight process that owns a stack and machine
35 registers including program counter, but shares code and data with other
36 threads within the same address space. If the underlying operating system
37 recognizes a thread, it is known as kernel thread, otherwise it is known as
38 user-thread. A context-switch between threads refers to suspending one thread's
39 execution and transferring control to another thread. Kernel threads typically
40 have higher context switching costs than user-threads because of operating
41 system overheads. The policy implemented by the underlying system for
42 transferring control between threads is known as thread scheduling policy.
43 Scheduling policy for kernel threads is determined by the operating system, and
44 is often more inflexible than user-threads. Scheduling policy is said to be
45 non-preemptive if a context-switch occurs only when the currently running
46 thread willingly asks to be suspended, otherwise it is said to be preemptive.
47 \jade threads are non-preemptive user-level threads.
48
49 \item[Object] An object is just a blob of memory on which certain computations
50 can be performed. The memory is referred to as an object's state, and the set
51 of computations that can be performed on the object is called the interface of
52 the object.
53
54 \end{description}
55
56 \section{\charmpp{}}
57
58 \charmpp{} is an object-oriented parallel programming library for \CC{}.  It
59 differs from traditional message passing programming libraries (such as MPI) in
60 that \charmpp{} is ``message-driven''. Message-driven parallel programs do not
61 block the processor waiting for a message to be received.  Instead, each
62 message carries with itself a computation that the processor performs on
63 arrival of that message. The underlying runtime system of \charmpp{} is called
64 \converse{}, which implements a ``scheduler'' that chooses which message to
65 schedule next (message-scheduling in \charmpp{} involves locating the object
66 for which the message is intended, and executing the computation specified in
67 the incoming message on that object). A parallel object in \charmpp{} is a
68 \CC{} object on which a certain computations can be asked to performed from
69 remote processors.
70
71 \charmpp{} programs exhibit latency tolerance since the scheduler always picks
72 up the next available message rather than waiting for a particular message to
73 arrive.  They also tend to be modular, because of their object-based nature.
74 Most importantly, \charmpp{} programs can be \emph{dynamically load balanced},
75 because the messages are directed at objects and not at processors; thus
76 allowing the runtime system to migrate the objects from heavily loaded
77 processors to lightly loaded processors. It is this feature of \charmpp{} that
78 we utilize for \jade.
79
80 Since many CSE applications are originally written using MPI, one would have to
81 do a complete rewrite if they were to be converted to \charmpp{} to take
82 advantage of dynamic load balancing. This is indeed impractical. However,
83 \converse{} -- the runtime system of \charmpp{} -- came to our rescue here,
84 since it supports interoperability between different parallel programming
85 paradigms such as parallel objects and threads. Using this feature, we
86 developed \jade, an implementation of a significant subset of MPI-1.1
87 standard over \charmpp{}.  \jade is described in the next section.
88
89 \section{\jade}
90
91 Every mainchare's main is executed at startup.
92
93 \subsection{threaded methods}
94
95 \begin{alltt}
96 class C {
97     public threaded void start(CProxy_CacheGroup cg) { ... }
98 }
99 \end{alltt}
100
101 \subsection{readonly}
102
103 \begin{alltt}
104 class C {
105     public static readonly CProxy_TheMain mainChare;
106     public static int readonly aReadOnly;
107 }
108 \end{alltt}
109
110 Accessed as C.aReadOnly;
111
112 Must be initialized in the main of a mainchare.  Value at the end of main is
113 propagated to all processors.  Then execution begins.
114
115 \subsection{msa}
116
117 \begin{alltt}
118 arr1.enroll();
119 int a = arr1[10]; // get
120 arr1[10] = 122; // set
121 arr1[10] += 2;  // accumulate
122 arr1.sync();    // sync
123 \end{alltt}
124
125 \subsection{\jade Status}
126
127 \appendix
128
129 \section{Installing \jade}
130
131 \jade is included in the source distribution of \charmpp{}. 
132 To get the latest sources from PPL, visit:
133         http://charm.cs.uiuc.edu/
134
135 and follow the download link.
136 Now one has to build \charmpp{} and \jade from source.
137
138 The build script for \charmpp{} is called \texttt{build}. The syntax for this
139 script is:
140
141 \begin{alltt}
142 > build <target> <version> <opts>
143 \end{alltt}
144
145 For building \jade (which also includes building \charmpp{} and other
146 libraries needed by \jade), specify \verb+<target>+ to be \verb+jade+. And
147 \verb+<opts>+ are command line options passed to the \verb+charmc+ compile
148 script.  Common compile time options such as \texttt{-g, -O, -Ipath, -Lpath,
149 -llib} are accepted. 
150
151 To build a debugging version of \jade, use the option: ``\texttt{-g}''. 
152 To build a production version of \jade, use the options: ``\texttt{-O 
153 -DCMK\_OPTIMIZE=1}''.
154
155 \verb+<version>+ depends on the machine, operating system, and the underlying
156 communication library one wants to use for running \jade programs.
157 See the charm/README file for details on picking the proper version.
158 Following is an example of how to build \jade under linux and ethernet
159 environment, with debugging info produced:
160
161 \begin{alltt}
162 > build jade net-linux -g
163 \end{alltt}
164
165 \section{Compiling and Running \jade Programs}
166 \subsection{Compiling \jade Programs}
167
168 \charmpp{} provides a cross-platform compile-and-link script called \charmc{}
169 to compile C, \CC{}, Fortran, \charmpp{} and \jade programs.  This script
170 resides in the \texttt{bin} subdirectory in the \charmpp{} installation
171 directory. The main purpose of this script is to deal with the differences of
172 various compiler names and command-line options across various machines on
173 which \charmpp{} runs.
174
175 In spite of the platform-neutral syntax of \charmc{}, one may have to specify
176 some platform-specific options for compiling and building \jade codes.
177 Fortunately, if \charmc{} does not recognize any particular options on its
178 command line, it promptly passes it to all the individual compilers and linkers
179 it invokes to compile the program.
180
181 You can use \charmc{} to build your \jade program the same way as other
182 compilers like \texttt{cc}.  To build an \jade program, the command line 
183 option \emph{-language jade} should be specified. All the command line 
184 flags that you would use for other compilers can be used with \charmc the 
185 same way. For example:
186
187 \begin{alltt}
188 > charmc -language jade -c pgm.java -O3
189 > charmc -language jade -o pgm pgm.o -lm -O3 
190 \end{alltt}
191
192 \subsection{Running}
193
194 The \charmpp{} distribution contains a script called \texttt{charmrun} that makes
195 the job of running \jade programs portable and easier across all parallel
196 machines supported by \charmpp{}. When compiling a \jade program, \charmc{} copies \texttt{charmrun} to the directory
197 where the \jade program is built.  \texttt{charmrun} takes a command line
198 parameter specifying the number of processors to run on, and the name of the program
199 followed by \jade options (such as TBD) and the program arguments. A typical
200 invocation of \jade program \texttt{pgm} with \texttt{charmrun} is:
201
202 \begin{alltt}
203 > charmrun pgm +p16 +vp32 +tcharm_stacksize 3276800
204 \end{alltt}
205
206 Here, the \jade program \texttt{pgm} is run on 16 physical processors with
207 32 chunks (which will be mapped 2 per processor initially), where each
208 user-level thread associated with a chunk has the stack size of 3,276,800 bytes.
209
210 \section{Jade Developer documentation}
211
212 \subsection{Files}
213
214 \jade source files are spread out across several directories of the \charmpp{}
215 CVS tree.
216
217 \begin{tabular}{|r|l|}
218 \hline\\
219 charm/doc/jade                         & \jade user documentation files \\
220 charm/src/langs/jade/                  & ANTLR parser files, \jade runtime library code\\
221 charm/java/charm/jade/                 & \jade java code \\
222 charm/java/bin/                        & \jade scripts \\
223 charm/pgms/jade/                       & \jade example programs and tests \\
224 \hline
225 \end{tabular}
226
227 After building \jade, files are installed in:
228
229 \begin{tabular}{|r|l|}
230 \hline\\
231 charm/include/                         & \jade runtime library header files\\
232 charm/lib/                             & \jade runtime library\\
233 charm/java/bin/                        & \texttt{jade.jar} file \\
234 \hline
235 \end{tabular}
236
237 \subsection{Java packages}
238
239 The way packages work in Java is as follows: There is a ROOT directory. Within
240 the ROOT, a subdirectory is used which also gives the package name.  Beneath
241 the package directory all the \texttt{.class} files are stored.  The ROOT
242 directory should be placed in the java CLASSPATH.
243
244 For \jade, the ROOT is charm/java/charm/.
245
246 The \jade package name is \texttt{jade}, and is in charm/java/charm/jade.
247 Within here, all the jade Java files are placed, they are compiled to
248 \texttt{.class} files, and then jar'd up into the \texttt{jade.jar} file, which
249 is placed in charm/java/bin for convenience.
250
251 \end{document}