ghc/includes/SchedAPI.h

   1 /* -----------------------------------------------------------------------------
   2  * $Id: SchedAPI.h,v 1.17 2002/12/27 12:33:21 panne Exp $
   3  *
   4  * (c) The GHC Team 1998-2002
   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, StgWord c) {
  36   tso->sp--;
  37   tso->sp[0] = (W_) c;
  38 }
  39
  40 static inline StgTSO *
  41 createGenThread(nat stack_size,  StgClosure *closure) {
  42   StgTSO *t;
  43 #if defined(GRAN)
  44   t = createThread(stack_size, NO_PRI);
  45 #else
  46   t = createThread(stack_size);
  47 #endif
  48   pushClosure(t, (W_)closure);
  49   pushClosure(t, (W_)&stg_enter_info);
  50   return t;
  51 }
  52
  53 static inline StgTSO *
  54 createIOThread(nat stack_size,  StgClosure *closure) {
  55   StgTSO *t;
  56 #if defined(GRAN)
  57   t = createThread(stack_size, NO_PRI);
  58 #else
  59   t = createThread(stack_size);
  60 #endif
  61   pushClosure(t, (W_)&stg_noforceIO_info);
  62   pushClosure(t, (W_)&stg_ap_v_info);
  63   pushClosure(t, (W_)closure);
  64   pushClosure(t, (W_)&stg_enter_info);
  65   return t;
  66 }
  67
  68 /*
  69  * Same as above, but also evaluate the result of the IO action
  70  * to whnf while we're at it.
  71  */
  72
  73 static inline StgTSO *
  74 createStrictIOThread(nat stack_size,  StgClosure *closure) {
  75   StgTSO *t;
  76 #if defined(GRAN)
  77   t = createThread(stack_size, NO_PRI);
  78 #else
  79   t = createThread(stack_size);
  80 #endif
  81   pushClosure(t, (W_)&stg_forceIO_info);
  82   pushClosure(t, (W_)&stg_ap_v_info);
  83   pushClosure(t, (W_)closure);
  84   pushClosure(t, (W_)&stg_enter_info);
  85   return t;
  86 }
  87
  88
  89 /*
  90  * Killing threads
  91  */
  92 extern void deleteThread(StgTSO *tso);
  93 extern void deleteAllThreads ( void );
  94 extern int  howManyThreadsAvail ( void );
  95 /*
  96  * Run until there are no more threads.
  97  */
  98 extern void finishAllThreads ( void );
  99
 100 #endif