summaryrefslogtreecommitdiff
path: root/ghc/includes/SchedAPI.h
blob: 26dac54e7610635881fd2a48c2cbe90ed74dc6b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/* -----------------------------------------------------------------------------
 * $Id: SchedAPI.h,v 1.3 1999/05/21 14:46:21 sof Exp $
 *
 * (c) The GHC Team 1998
 *
 * External API for the scheduler.  For most uses, the functions in
 * RtsAPI.h should be enough.
 *
 * ---------------------------------------------------------------------------*/

#ifndef SCHEDAPI_H
#define SCHEDAPI_H

/*
 * Running the scheduler
 */

typedef enum {
    Success,      
    Killed,	 /* another thread killed us                           */
    Interrupted, /* stopped in response to a call to interruptStgRts   */
    Deadlock,   
    AllBlocked,  /* subtly different from Deadlock                     */
} SchedulerStatus;
      
SchedulerStatus schedule(StgTSO *main_thread, /*out*/StgClosure **ret);

/* 
 * Creating threads
 */

StgTSO *createThread   (nat stack_size);

static inline void pushClosure   (StgTSO *tso, StgClosure *c) {
  tso->sp--;
  tso->sp[0] = (W_) c;
}

static inline void pushRealWorld (StgTSO *tso) {
  tso->sp--;
  tso->sp[0] = (W_) REALWORLD_TAG;
}
static inline StgTSO *
createGenThread(nat stack_size,  StgClosure *closure) {
  StgTSO *t;
  t = createThread(stack_size);
  pushClosure(t,closure);
  return t;
}

static inline StgTSO *
createIOThread(nat stack_size,  StgClosure *closure) {
  StgTSO *t;
  t = createThread(stack_size);
  pushRealWorld(t);
  pushClosure(t,closure);
  return t;
}

/*
 * Same as above, but also evaluate the result of the IO action
 * to whnf while we're at it.
 */

static inline StgTSO *
createStrictIOThread(nat stack_size,  StgClosure *closure) {
  StgTSO *t;
  t = createThread(stack_size);
  pushClosure(t,closure);
  pushClosure(t,&forceIO_closure);
  return t;
}


/* 
 * Killing threads
 */

void    deleteThread(StgTSO *tso);

/*
 * Reverting CAFs
 */

void RevertCAFs(void);

#endif