finished overhaul.
[charm.git] / doc / converse / threads.tex
1 \chapter{Threads}
2
3 The calls in this chapter can be used to put together runtime systems
4 for languages that support threads.
5 This threads package, like most thread packages, provides basic
6 functionality like creating threads, destroying threads, yielding, 
7 suspending, and awakening a suspended thread. In
8 addition, it provides facilities whereby you can write your own thread
9 schedulers.  
10
11 \section{Basic Thread Calls}
12
13 In this section, we refer to the ``scheduler queue''.  By this, we mean
14 the priority queue described in section \ref{schedqueue}.
15
16
17 \function{typedef struct CthThreadStruct *CthThread;}
18 \index{CthThread}
19 \desc{This is an opaque type defined in {\tt converse.h}.  It represents
20 a first-class thread object.  No information is publicized about the
21 contents of a CthThreadStruct.}
22
23 \function{typedef void (CthVoidFn)();}
24 \index{CthVoidFn}
25 \desc{This is a type defined in {\tt threads.h}.  It represents
26 a function that returns nothing.}
27
28 \function{typedef CthThread (CthThFn)();}
29 \index{CthThFn}
30 \desc{This is a type defined in {\tt threads.h}.  It represents
31 a function that returns a CthThread.}
32
33 \function{CthThread CthSelf()}
34 \index{CthSelf}
35 \desc{Returns the currently-executing thread.  Note: even the initial
36 flow of control that inherently existed when the program began
37 executing {\tt main} counts as a thread.  You may retrieve that thread
38 object using {\tt CthSelf} and use it like any other.}
39
40 \function{CthThread CthCreate(CthVoidFn fn, void *arg, int size)}
41 \index{CthCreate}
42 \desc{Creates a new thread object.  The thread is not given control
43 yet.  To make the thread execute, you must push it into the
44 scheduler queue, using CthAwaken below.  When (and if) the thread
45 eventually receives control, it will begin executing the specified
46 function {\tt fn} with the specified argument.  The {\tt size}
47 parameter specifies the stack size in bytes, 0 means use the default
48 size.  Caution: almost all threads are created with CthCreate, but not
49 all.  In particular, the one initial thread of control that came into
50 existence when your program was first {\tt exec}'d was not created
51 with {\tt CthCreate}, but it can be retrieved (say, by calling {\tt
52 CthSelf} in {\tt main}), and it can be used like any other {\tt
53 CthThread}.}
54
55 \function{void CthFree(CthThread t)}
56 \index{CthFree}
57 \desc{Frees thread {\tt t}.  You may ONLY free the
58 currently-executing thread (yes, this sounds strange, it's
59 historical).  Naturally, the free will actually be postponed until the
60 thread suspends.  This is how a thread terminates itself: it calls
61 {\tt CthFree(CthSelf())}, then gives up control to another thread.}
62
63 \function{void CthSuspend()}
64 \index{CthSuspend}
65 \desc{Causes the current thread to stop executing.
66 The suspended thread will not start executing again until somebody
67 pushes it into the scheduler queue again, using CthAwaken below.  Control
68 transfers to the thread running CsdScheduler.  This has the effect of
69 polling for messages, and possibly transferring control to a
70 thread in the scheduler queue.}
71
72 \function{void CthAwaken(CthThread t)}
73 \index{CthAwaken}
74 \desc{Pushes a thread into the scheduler queue.  Caution: a thread
75 must only be in the queue once.  Pushing it in twice is a crashable
76 error.}
77
78 \function{void CthYield()}
79 \index{CthYield}
80 \desc{This function is part of the scheduler-interface.  It simply
81 executes {\tt \{ CthAwaken(CthSelf()); CthSuspend(); \} }.  This combination
82 gives up control temporarily, but ensures that control will eventually
83 return.}
84
85 \section{Thread Scheduling Hooks}
86
87 Normally, when you CthAwaken a thread, it goes into the primary
88 ready-queue: namely, the main Converse queue described in section
89 \ref{schedqueue}.  However, it is possible to hook a thread to make
90 it go into a different ready-queue.  That queue doesn't have to be
91 priority-queue: it could be FIFO, or LIFO, or in fact it could handle
92 its threads in any complicated order you desire.  This is a powerful
93 way to implement your own scheduling policies for threads.
94
95 To achieve this, you must first implement a new kind of ready-queue.
96 You must implement a function that inserts threads into this queue.
97 The function must have this prototype:
98
99 {\bf void awakenfn(CthThread t);}
100
101 When a thread suspends, it must choose a new thread to transfer control
102 to.  You must implement a function that makes the decision: which thread
103 should the current thread transfer to.  This function must have this
104 prototype:
105
106 {\bf CthThread choosefn();}
107
108 Typically, the choosefn would choose a thread from your ready-queue.
109 Alternately, it might choose to always transfer control to a central
110 scheduling thread.
111
112 You then configure individual threads to actually use this new
113 ready-queue.  This is done using CthSetStrategy:
114
115 \function{void CthSetStrategy(CthThread t, CthVoidFn awakenfn, CthThFn choosefn)}
116 \index{CthSetStrategy}
117 \desc{Causes the thread to use the specified \param{awakefn} whenever
118 you CthAwaken it, and the specified \param{choosefn} whenever you
119 CthSuspend it.}
120
121 CthSetStrategy alters the behavior of CthSuspend and CthAwaken.
122 Normally, when a thread is awakened with CthAwaken, it gets inserted
123 into the main ready-queue.  Setting the thread's {\tt awakenfn} will
124 cause the thread to be inserted into your ready-queue instead.
125 Similarly, when a thread suspends using CthSuspend, it normally
126 transfers control to some thread in the main ready-queue.  Setting the
127 thread's {\tt choosefn} will cause it to transfer control to a thread
128 chosen by your {\tt choosefn} instead.
129
130 You may reset a thread to its normal behavior using CthSetStrategyDefault:
131
132 \function{void CthSetStrategyDefault(CthThread t)}
133 \index{CthSetStrategyDefault}
134 \desc{Restores the value of \param{awakefn} and \param{choosefn} to
135 their default values.  This implies that the next time you CthAwaken
136 the specified thread, it will be inserted into the normal ready-queue.}
137
138 Keep in mind that this only resolves the issue of how threads get into
139 your ready-queue, and how those threads suspend.  To actually make
140 everything ``work out'' requires additional planning: you have to make
141 sure that control gets transferred to everywhere it needs to go.
142
143 Scheduling threads may need to use this function as well:
144
145 \function{void CthResume(CthThread t)}
146 \index{CthResume}
147 \desc{Immediately transfers control to thread {\tt t}.  This routine is
148 primarily intended for people who are implementing schedulers, not for
149 end-users.  End-users should probably call {\tt CthSuspend} or {\tt
150 CthAwaken} (see below).  Likewise, programmers implementing locks,
151 barriers, and other synchronization devices should also probably rely
152 on {\tt CthSuspend} and {\tt CthAwaken}.}
153
154 A final caution about the {\tt choosefn}: it may only return a thread
155 that wants the CPU, eg, a thread that has been awakened using the {\tt
156 awakefn}.  If no such thread exists, if the {\tt choosefn} cannot
157 return an awakened thread, then it must not return at all: instead, it
158 must wait until, by means of some pending IO event, a thread becomes
159 awakened (pending events could be asynchonous disk reads, networked
160 message receptions, signal handlers, etc).  For this reason, many
161 schedulers perform the task of polling the IO devices as a side
162 effect.  If handling the IO event causes a thread to be awakened, then
163 the choosefn may return that thread.  If no pending events exist, then
164 all threads will remain permanently blocked, the program is therefore
165 done, and the {\tt choosefn} should call {\tt exit}.
166
167 There is one minor exception to the rule stated above (``the scheduler
168 may not resume a thread unless it has been declared that the thread
169 wants the CPU using the {\tt awakefn}'').  If a thread {\tt t} is part
170 of the scheduling module, it is permitted for the scheduling module to
171 resume {\tt t} whenever it so desires: presumably, the scheduling
172 module knows when its threads want the CPU.
173
174 \internal{
175 \function{void CthSetVar(CthThread t, void **var, void *val)}
176 \desc{Specifies that the global variable pointed to by {\tt
177 var} should be set to value {\tt val} whenever thread {\tt t} is
178 executing.  {\tt var} should be of type {\tt void *}, or at least
179 should be coercible to a {\tt void *}.  This can be used to associate
180 thread-private data with thread {\tt t}.
181
182 it is intended that this function be used as follows:}
183
184 \begin{verbatim}
185     /* User defines a struct th_info containing all the thread-private  */
186     /* data he wishes to associate with threads.  He also defines       */
187     /* a global variable 'current_thread_info' which will always hold   */
188     /* the th_info of the currently-executing thread.                   */
189     struct th_info { ... } *current_thread_info;
190
191     /* User creates a thread 't', and allocates a block of memory       */
192     /* 'tinfo' to hold the thread's private data.  User tells the       */
193     /* system that whenever thread 't' is running, the global variable  */
194     /* 'current_thread_info' should be set to 'tinfo'.  Thus, thread    */
195     /* 't' can access its private data just by dereferencing            */
196     /* 'current_thread_info'.                                           */
197     t = CthCreate( ... );
198     tinfo = (struct th_info *)malloc(sizeof(struct th_info));
199     CthSetVar(t, &current_thread_info, tinfo);
200 \end{verbatim}
201
202 \desc{Note: you can use CthSetVar multiple times on a thread, thereby
203 attaching multiple data items to it.  However, each data item slows
204 down context-switch to that thread by a tiny amount.  Therefore, a
205 module should ideally attach no more than one data item to a thread.
206 We allow multiple data items to be attached so that independent
207 modules can attach data to a thread without interfering with each
208 other.}
209
210 \function{void *CthGetVar(CthThread t, void **var)}
211 \desc{This makes it possible to retrieve values previously stored with
212 {\tt CthSetVar} when {\tt t} is {\it not} executing.  Returns the value
213 that {\tt var} will be set to when {\tt t} is running.}
214 }