Schedule.h 6.84 KB
Newer Older
1
2
/* -----------------------------------------------------------------------------
 *
3
 * (c) The GHC Team 1998-2005
4
5
6
7
 *
 * Prototypes for functions in Schedule.c 
 * (RTS internal scheduler interface)
 *
8
 * -------------------------------------------------------------------------*/
9

10
11
12
#ifndef SCHEDULE_H
#define SCHEDULE_H

Simon Marlow's avatar
Simon Marlow committed
13
#include "rts/OSThreads.h"
14
#include "Capability.h"
15
#include "Trace.h"
16

17
#include "BeginPrivate.h"
18

19
/* initScheduler(), exitScheduler()
20
21
 * Called from STG :  no
 * Locks assumed   :  none
22
 */
23
void initScheduler (void);
24
void exitScheduler (rtsBool wait_foreign);
25
void freeScheduler (void);
Simon Marlow's avatar
Simon Marlow committed
26
void markScheduler (evac_fn evac, void *user);
27

28
// Place a new thread on the run queue of the current Capability
29
void scheduleThread (Capability *cap, StgTSO *tso);
30

31
32
33
34
35
// Place a new thread on the run queue of a specified Capability
// (cap is the currently owned Capability, cpu is the number of
// the desired Capability).
void scheduleThreadOn(Capability *cap, StgWord cpu, StgTSO *tso);

Simon Marlow's avatar
Simon Marlow committed
36
37
38
39
/* wakeUpRts()
 * 
 * Causes an OS thread to wake up and run the scheduler, if necessary.
 */
Simon Marlow's avatar
Simon Marlow committed
40
#if defined(THREADED_RTS)
Simon Marlow's avatar
Simon Marlow committed
41
void wakeUpRts(void);
Simon Marlow's avatar
Simon Marlow committed
42
#endif
43

44
/* raiseExceptionHelper */
45
StgWord raiseExceptionHelper (StgRegTable *reg, StgTSO *tso, StgClosure *exception);
46

47
/* findRetryFrameHelper */
48
StgWord findRetryFrameHelper (Capability *cap, StgTSO *tso);
49

50
51
/* Entry point for a new worker */
void scheduleWorker (Capability *cap, Task *task);
52

53
54
55
/* The state of the scheduler.  This is used to control the sequence
 * of events during shutdown, and when the runtime is interrupted
 * using ^C.
56
 */
57
58
#define SCHED_RUNNING       0  /* running as normal */
#define SCHED_INTERRUPTING  1  /* ^C detected, before threads are deleted */
59
#define SCHED_SHUTTING_DOWN 2  /* final shutdown */
60

Simon Marlow's avatar
Simon Marlow committed
61
extern volatile StgWord sched_state;
62

63
/* 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 * flag that tracks whether we have done any execution in this time
 * slice, and controls the disabling of the interval timer.
 *
 * The timer interrupt transitions ACTIVITY_YES into
 * ACTIVITY_MAYBE_NO, waits for RtsFlags.GcFlags.idleGCDelayTime,
 * and then:
 *   - if idle GC is no, set ACTIVITY_INACTIVE and wakeUpRts()
 *   - if idle GC is off, set ACTIVITY_DONE_GC and stopTimer()
 *
 * If the scheduler finds ACTIVITY_INACTIVE, then it sets
 * ACTIVITY_DONE_GC, performs the GC and calls stopTimer().
 *
 * If the scheduler finds ACTIVITY_DONE_GC and it has a thread to run,
 * it enables the timer again with startTimer().
78
 */
79
80
81
82
83
84
85
86
87
#define ACTIVITY_YES      0
  // the RTS is active
#define ACTIVITY_MAYBE_NO 1
  // no activity since the last timer signal
#define ACTIVITY_INACTIVE 2
  // RtsFlags.GcFlags.idleGCDelayTime has passed with no activity
#define ACTIVITY_DONE_GC  3
  // like ACTIVITY_INACTIVE, but we've done a GC too (if idle GC is
  // enabled) and the interval timer is now turned off.
88

89
90
91
92
93
94
/* Recent activity flag.
 * Locks required  : Transition from MAYBE_NO to INACTIVE
 * happens in the timer signal, so it is atomic.  Trnasition from
 * INACTIVE to DONE_GC happens under sched_mutex.  No lock required
 * to set it to ACTIVITY_YES.
 */
95
extern volatile StgWord recent_activity;
96

97
98
/* Thread queues.
 * Locks required  : sched_mutex
99
100
 *
 * In GranSim we have one run/blocked_queue per PE.
101
 */
Simon Marlow's avatar
Simon Marlow committed
102
extern  StgTSO *blackhole_queue;
103
#if !defined(THREADED_RTS)
Simon Marlow's avatar
Simon Marlow committed
104
105
extern  StgTSO *blocked_queue_hd, *blocked_queue_tl;
extern  StgTSO *sleeping_queue;
106
#endif
107

108
109
extern rtsBool heap_overflow;

110
#if defined(THREADED_RTS)
Simon Marlow's avatar
Simon Marlow committed
111
extern Mutex sched_mutex;
sof's avatar
sof committed
112
#endif
113

sof's avatar
sof committed
114
/* Called by shutdown_handler(). */
115
void interruptStgRts (void);
116

117
void resurrectThreads (StgTSO *);
118

119
/* -----------------------------------------------------------------------------
120
 * Some convenient macros/inline functions...
121
122
 */

123
124
#if !IN_STG_CODE

125
/* END_TSO_QUEUE and friends now defined in includes/stg/MiscClosures.h */
126

127
128
/* Add a thread to the end of the run queue.
 * NOTE: tso->link should be END_TSO_QUEUE before calling this macro.
129
 * ASSUMES: cap->running_task is the current task.
130
 */
131
132
133
134
EXTERN_INLINE void
appendToRunQueue (Capability *cap, StgTSO *tso);

EXTERN_INLINE void
135
136
appendToRunQueue (Capability *cap, StgTSO *tso)
{
137
    ASSERT(tso->_link == END_TSO_QUEUE);
138
139
    if (cap->run_queue_hd == END_TSO_QUEUE) {
	cap->run_queue_hd = tso;
140
        tso->block_info.prev = END_TSO_QUEUE;
141
    } else {
142
	setTSOLink(cap, cap->run_queue_tl, tso);
143
        setTSOPrev(cap, tso, cap->run_queue_tl);
144
145
146
    }
    cap->run_queue_tl = tso;
}
147

Simon Marlow's avatar
Simon Marlow committed
148
/* Push a thread on the beginning of the run queue.
149
 * ASSUMES: cap->running_task is the current task.
150
 */
151
152
153
154
EXTERN_INLINE void
pushOnRunQueue (Capability *cap, StgTSO *tso);

EXTERN_INLINE void
155
156
pushOnRunQueue (Capability *cap, StgTSO *tso)
{
157
    setTSOLink(cap, tso, cap->run_queue_hd);
158
159
160
161
    tso->block_info.prev = END_TSO_QUEUE;
    if (cap->run_queue_hd != END_TSO_QUEUE) {
        setTSOPrev(cap, cap->run_queue_hd, tso);
    }
162
163
164
    cap->run_queue_hd = tso;
    if (cap->run_queue_tl == END_TSO_QUEUE) {
	cap->run_queue_tl = tso;
165
    }
166
}
167

168
169
/* Pop the first thread off the runnable queue.
 */
170
INLINE_HEADER StgTSO *
171
172
173
174
popRunQueue (Capability *cap)
{ 
    StgTSO *t = cap->run_queue_hd;
    ASSERT(t != END_TSO_QUEUE);
175
    cap->run_queue_hd = t->_link;
Simon Marlow's avatar
Simon Marlow committed
176
177
178
    if (t->_link != END_TSO_QUEUE) {
        t->_link->block_info.prev = END_TSO_QUEUE;
    }
179
    t->_link = END_TSO_QUEUE; // no write barrier req'd
180
181
182
183
184
    if (cap->run_queue_hd == END_TSO_QUEUE) {
	cap->run_queue_tl = END_TSO_QUEUE;
    }
    return t;
}
185

186
187
188
189
190
191
192
193
INLINE_HEADER StgTSO *
peekRunQueue (Capability *cap)
{
    return cap->run_queue_hd;
}

void removeFromRunQueue (Capability *cap, StgTSO *tso);
extern void promoteInRunQueue (Capability *cap, StgTSO *tso);
194

195
196
/* Add a thread to the end of the blocked queue.
 */
197
#if !defined(THREADED_RTS)
198
INLINE_HEADER void
199
200
appendToBlockedQueue(StgTSO *tso)
{
201
    ASSERT(tso->_link == END_TSO_QUEUE);
202
203
204
    if (blocked_queue_hd == END_TSO_QUEUE) {
	blocked_queue_hd = tso;
    } else {
205
	setTSOLink(&MainCapability, blocked_queue_tl, tso);
206
    }
207
    blocked_queue_tl = tso;
208
209
}
#endif
210

211
/* Check whether various thread queues are empty
212
 */
213
INLINE_HEADER rtsBool
214
215
216
217
218
emptyQueue (StgTSO *q)
{
    return (q == END_TSO_QUEUE);
}

219
INLINE_HEADER rtsBool
220
221
222
223
224
emptyRunQueue(Capability *cap)
{
    return emptyQueue(cap->run_queue_hd);
}

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/* assumes that the queue is not empty; so combine this with
 * an emptyRunQueue check! */
INLINE_HEADER rtsBool
singletonRunQueue(Capability *cap)
{
    ASSERT(!emptyRunQueue(cap));
    return cap->run_queue_hd->_link == END_TSO_QUEUE;
}

INLINE_HEADER void
truncateRunQueue(Capability *cap)
{
    cap->run_queue_hd = END_TSO_QUEUE;
    cap->run_queue_tl = END_TSO_QUEUE;
}

241
242
243
244
#if !defined(THREADED_RTS)
#define EMPTY_BLOCKED_QUEUE()  (emptyQueue(blocked_queue_hd))
#define EMPTY_SLEEPING_QUEUE() (emptyQueue(sleeping_queue))
#endif
245

246
INLINE_HEADER rtsBool
247
248
249
250
251
emptyThreadQueues(Capability *cap)
{
    return emptyRunQueue(cap)
#if !defined(THREADED_RTS)
	&& EMPTY_BLOCKED_QUEUE() && EMPTY_SLEEPING_QUEUE()
252
#endif
253
254
    ;
}
255

256
257
#endif /* !IN_STG_CODE */

258
#include "EndPrivate.h"
259

260
261
#endif /* SCHEDULE_H */