ghc/rts/Schedule.h

   1 /* -----------------------------------------------------------------------------
   2  * $Id: Schedule.h,v 1.31 2002/03/12 13:57:12 simonmar Exp $
   3  *
   4  * (c) The GHC Team 1998-1999
   5  *
   6  * Prototypes for functions in Schedule.c
   7  * (RTS internal scheduler interface)
   8  *
   9  * -------------------------------------------------------------------------*/
  10
  11 #ifndef __SCHEDULE_H__
  12 #define __SCHEDULE_H__
  13 #include "OSThreads.h"
  14
  15 /* initScheduler(), exitScheduler(), startTasks()
  16  *
  17  * Called from STG :  no
  18  * Locks assumed   :  none
  19  */
  20 extern void initScheduler  ( void );
  21 extern void exitScheduler  ( void );
  22
  23 /* awakenBlockedQueue()
  24  *
  25  * Takes a pointer to the beginning of a blocked TSO queue, and
  26  * wakes up the entire queue.
  27  *
  28  * Called from STG :  yes
  29  * Locks assumed   :  none
  30  */
  31 #if defined(GRAN)
  32 void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node);
  33 #elif defined(PAR)
  34 void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node);
  35 #else
  36 void awakenBlockedQueue(StgTSO *tso);
  37 #endif
  38
  39 /* unblockOne()
  40  *
  41  * Takes a pointer to the beginning of a blocked TSO queue, and
  42  * removes the first thread, placing it on the runnable queue.
  43  *
  44  * Called from STG : yes
  45  * Locks assumed   : none
  46  */
  47 #if defined(GRAN) || defined(PAR)
  48 StgBlockingQueueElement *unblockOne(StgBlockingQueueElement *bqe, StgClosure *node);
  49 #else
  50 StgTSO *unblockOne(StgTSO *tso);
  51 #endif
  52
  53 /* raiseAsync()
  54  *
  55  * Raises an exception asynchronously in the specified thread.
  56  *
  57  * Called from STG :  yes
  58  * Locks assumed   :  none
  59  */
  60 void raiseAsync(StgTSO *tso, StgClosure *exception);
  61
  62 /* awaitEvent()
  63  *
  64  * Raises an exception asynchronously in the specified thread.
  65  *
  66  * Called from STG :  NO
  67  * Locks assumed   :  sched_mutex
  68  */
  69 void awaitEvent(rtsBool wait);  /* In Select.c */
  70
  71 /* wakeUpSleepingThreads(nat ticks)
  72  *
  73  * Wakes up any sleeping threads whose timers have expired.
  74  *
  75  * Called from STG :  NO
  76  * Locks assumed   :  sched_mutex
  77  */
  78 rtsBool wakeUpSleepingThreads(nat);  /* In Select.c */
  79
  80 /* GetRoots(evac_fn f)
  81  *
  82  * Call f() for each root known to the scheduler.
  83  *
  84  * Called from STG :  NO
  85  * Locks assumed   :  ????
  86  */
  87 void GetRoots(evac_fn);
  88
  89 // ToDo: check whether all fcts below are used in the SMP version, too
  90 #if defined(GRAN)
  91 void    awaken_blocked_queue(StgBlockingQueueElement *q, StgClosure *node);
  92 void    unlink_from_bq(StgTSO* tso, StgClosure* node);
  93 void    initThread(StgTSO *tso, nat stack_size, StgInt pri);
  94 #elif defined(PAR)
  95 nat     run_queue_len(void);
  96 void    awaken_blocked_queue(StgBlockingQueueElement *q, StgClosure *node);
  97 void    initThread(StgTSO *tso, nat stack_size);
  98 #else
  99 char   *info_type(StgClosure *closure);    // dummy
 100 char   *info_type_by_ip(StgInfoTable *ip); // dummy
 101 void    awaken_blocked_queue(StgTSO *q);
 102 void    initThread(StgTSO *tso, nat stack_size);
 103 #endif
 104
 105 /* Context switch flag.
 106  * Locks required  : sched_mutex
 107  */
 108 extern nat context_switch;
 109 extern rtsBool interrupted;
 110
 111 /* In Select.c */
 112 extern nat timestamp;
 113
 114 /* Thread queues.
 115  * Locks required  : sched_mutex
 116  *
 117  * In GranSim we have one run/blocked_queue per PE.
 118  */
 119 #if defined(GRAN)
 120 // run_queue_hds defined in GranSim.h
 121 #else
 122 extern  StgTSO *run_queue_hd, *run_queue_tl;
 123 extern  StgTSO *blocked_queue_hd, *blocked_queue_tl;
 124 extern  StgTSO *sleeping_queue;
 125 #endif
 126 /* Linked list of all threads. */
 127 extern  StgTSO *all_threads;
 128
 129 #if defined(RTS_SUPPORTS_THREADS)
 130 /* Schedule.c has detailed info on what these do */
 131 extern Mutex       sched_mutex;
 132 extern Condition   thread_ready_cond;
 133 extern Condition   returning_worker_cond;
 134 extern nat         rts_n_waiting_workers;
 135 extern nat         rts_n_waiting_tasks;
 136 #endif
 137
 138
 139 /* Sigh, RTS-internal versions of waitThread(), scheduleThread(), and
 140    rts_evalIO() for the use by main() only. ToDo: better. */
 141 extern SchedulerStatus waitThread_(StgTSO *tso,
 142                                    /*out*/StgClosure **ret
 143 #if defined(THREADED_RTS)
 144                                    , rtsBool blockWaiting
 145 #endif
 146                                    );
 147 extern SchedulerStatus rts_mainEvalIO(HaskellObj p, /*out*/HaskellObj *ret);
 148
 149
 150 /* Called by shutdown_handler(). */
 151 void interruptStgRts ( void );
 152
 153 void raiseAsync(StgTSO *tso, StgClosure *exception);
 154 nat  run_queue_len(void);
 155
 156 void resurrectThreads( StgTSO * );
 157
 158 /* Main threads:
 159  *
 160  * These are the threads which clients have requested that we run.
 161  *
 162  * In a 'threaded' build, we might have several concurrent clients all
 163  * waiting for results, and each one will wait on a condition variable
 164  * until the result is available.
 165  *
 166  * In non-SMP, clients are strictly nested: the first client calls
 167  * into the RTS, which might call out again to C with a _ccall_GC, and
 168  * eventually re-enter the RTS.
 169  *
 170  * This is non-abstract at the moment because the garbage collector
 171  * treats pointers to TSOs from the main thread list as "weak" - these
 172  * pointers won't prevent a thread from receiving a BlockedOnDeadMVar
 173  * exception.
 174  *
 175  * Main threads information is kept in a linked list:
 176  */
 177 typedef struct StgMainThread_ {
 178   StgTSO *         tso;
 179   SchedulerStatus  stat;
 180   StgClosure **    ret;
 181 #if defined(RTS_SUPPORTS_THREADS)
 182   Condition        wakeup;
 183 #endif
 184   struct StgMainThread_ *link;
 185 } StgMainThread;
 186
 187 /* Main thread queue.
 188  * Locks required: sched_mutex.
 189  */
 190 extern StgMainThread *main_threads;
 191
 192 /* debugging only
 193  */
 194 #ifdef DEBUG
 195 void printThreadBlockage(StgTSO *tso);
 196 void printThreadStatus(StgTSO *tso);
 197 void printAllThreads(void);
 198 #endif
 199 void print_bq (StgClosure *node);
 200 #if defined(PAR)
 201 void print_bqe (StgBlockingQueueElement *bqe);
 202 #endif
 203
 204 /* -----------------------------------------------------------------------------
 205  * Some convenient macros...
 206  */
 207
 208 /* END_TSO_QUEUE and friends now defined in includes/StgMiscClosures.h */
 209
 210 /* Add a thread to the end of the run queue.
 211  * NOTE: tso->link should be END_TSO_QUEUE before calling this macro.
 212  */
 213 #define APPEND_TO_RUN_QUEUE(tso)                \
 214     ASSERT(tso->link == END_TSO_QUEUE);         \
 215     if (run_queue_hd == END_TSO_QUEUE) {        \
 216       run_queue_hd = tso;                       \
 217     } else {                                    \
 218       run_queue_tl->link = tso;                 \
 219     }                                           \
 220     run_queue_tl = tso;
 221
 222 /* Push a thread on the beginning of the run queue.  Used for
 223  * newly awakened threads, so they get run as soon as possible.
 224  */
 225 #define PUSH_ON_RUN_QUEUE(tso)                  \
 226     tso->link = run_queue_hd;                   \
 227       run_queue_hd = tso;                       \
 228     if (run_queue_tl == END_TSO_QUEUE) {        \
 229       run_queue_tl = tso;                       \
 230     }
 231
 232 /* Pop the first thread off the runnable queue.
 233  */
 234 #define POP_RUN_QUEUE()                         \
 235   ({ StgTSO *t = run_queue_hd;                  \
 236     if (t != END_TSO_QUEUE) {                   \
 237       run_queue_hd = t->link;                   \
 238       t->link = END_TSO_QUEUE;                  \
 239       if (run_queue_hd == END_TSO_QUEUE) {      \
 240         run_queue_tl = END_TSO_QUEUE;           \
 241       }                                         \
 242     }                                           \
 243     t;                                          \
 244   })
 245
 246 /* Add a thread to the end of the blocked queue.
 247  */
 248 #define APPEND_TO_BLOCKED_QUEUE(tso)            \
 249     ASSERT(tso->link == END_TSO_QUEUE);         \
 250     if (blocked_queue_hd == END_TSO_QUEUE) {    \
 251       blocked_queue_hd = tso;                   \
 252     } else {                                    \
 253       blocked_queue_tl->link = tso;             \
 254     }                                           \
 255     blocked_queue_tl = tso;
 256
 257 /* Signal that a runnable thread has become available, in
 258  * case there are any waiting tasks to execute it.
 259  */
 260 #if defined(RTS_SUPPORTS_THREADS)
 261 #define THREAD_RUNNABLE()                       \
 262   if ( !noCapabilities() ) {                    \
 263      signalCondition(&thread_ready_cond);       \
 264   }                                             \
 265   context_switch = 1;
 266 #else
 267 #define THREAD_RUNNABLE()  /* nothing */
 268 #endif
 269
 270 /* Check whether various thread queues are empty
 271  */
 272 #define EMPTY_QUEUE(q)         (q == END_TSO_QUEUE)
 273
 274 #define EMPTY_RUN_QUEUE()      (EMPTY_QUEUE(run_queue_hd))
 275 #define EMPTY_BLOCKED_QUEUE()  (EMPTY_QUEUE(blocked_queue_hd))
 276 #define EMPTY_SLEEPING_QUEUE() (EMPTY_QUEUE(sleeping_queue))
 277
 278 #define EMPTY_THREAD_QUEUES()  (EMPTY_RUN_QUEUE() && \
 279                                 EMPTY_BLOCKED_QUEUE() && \
 280                                 EMPTY_SLEEPING_QUEUE())
 281
 282 #endif /* __SCHEDULE_H__ */