ghc/includes/SchedAPI.h

   1 /* -----------------------------------------------------------------------------
   2  * $Id: SchedAPI.h,v 1.15 2002/06/19 20:45:17 sof Exp $
   3  *
   4  * (c) The GHC Team 1998
   5  *
   6  * External API for the scheduler.  For most uses, the functions in
   7  * RtsAPI.h should be enough.
   8  *
   9  * ---------------------------------------------------------------------------*/
  10
  11 #ifndef SCHEDAPI_H
  12 #define SCHEDAPI_H
  13
  14 #if defined(GRAN)
  15 // Dummy def for NO_PRI if not in GranSim
  16 #define NO_PRI  0
  17 #endif
  18
  19 extern SchedulerStatus waitThread(StgTSO *main_thread, /*out*/StgClosure **ret);
  20
  21 /*
  22  * Creating threads
  23  */
  24 #if defined(GRAN)
  25 extern StgTSO *createThread(nat stack_size, StgInt pri);
  26 #else
  27 extern StgTSO *createThread(nat stack_size);
  28 #endif
  29 #if defined(PAR) || defined(SMP)
  30 extern void taskStart(void);
  31 #endif
  32 extern void scheduleThread(StgTSO *tso);
  33 extern SchedulerStatus scheduleWaitThread(StgTSO *tso, /*out*/HaskellObj* ret);
  34
  35 static inline void pushClosure   (StgTSO *tso, StgClosure *c) {
  36   tso->sp--;
  37   tso->sp[0] = (W_) c;
  38 }
  39
  40 static inline void pushRealWorld (StgTSO *tso) {
  41   tso->sp--;
  42   tso->sp[0] = (W_) REALWORLD_TAG;
  43 }
  44 static inline StgTSO *
  45 createGenThread(nat stack_size,  StgClosure *closure) {
  46   StgTSO *t;
  47 #if defined(GRAN)
  48   t = createThread(stack_size, NO_PRI);
  49 #else
  50   t = createThread(stack_size);
  51 #endif
  52   pushClosure(t,closure);
  53   return t;
  54 }
  55
  56 static inline StgTSO *
  57 createIOThread(nat stack_size,  StgClosure *closure) {
  58   StgTSO *t;
  59 #if defined(GRAN)
  60   t = createThread(stack_size, NO_PRI);
  61 #else
  62   t = createThread(stack_size);
  63 #endif
  64   pushRealWorld(t);
  65   pushClosure(t,closure);
  66   return t;
  67 }
  68
  69 /*
  70  * Same as above, but also evaluate the result of the IO action
  71  * to whnf while we're at it.
  72  */
  73
  74 static inline StgTSO *
  75 createStrictIOThread(nat stack_size,  StgClosure *closure) {
  76   StgTSO *t;
  77 #if defined(GRAN)
  78   t = createThread(stack_size, NO_PRI);
  79 #else
  80   t = createThread(stack_size);
  81 #endif
  82   pushClosure(t,closure);
  83   pushClosure(t,(StgClosure*)&stg_forceIO_closure);
  84   return t;
  85 }
  86
  87
  88 /*
  89  * Killing threads
  90  */
  91 extern void deleteThread(StgTSO *tso);
  92 extern void deleteAllThreads ( void );
  93 extern int  howManyThreadsAvail ( void );
  94 /*
  95  * Run until there are no more threads.
  96  */
  97 extern void finishAllThreads ( void );
  98
  99 /*
 100  * Reverting CAFs
 101  */
 102 extern void RevertCAFs ( void );
 103
 104 #endif