[project @ 2002-03-04 17:01:26 by simonmar]
[ghc-hetmet.git] / ghc / rts / Schedule.h
index d0c3f99..cb12eb1 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: Schedule.h,v 1.18 2000/04/14 15:18:07 sewardj Exp $
+ * $Id: Schedule.h,v 1.29 2002/02/15 07:50:37 sof Exp $
  *
  * (c) The GHC Team 1998-1999
  *
@@ -7,6 +7,9 @@
  * (RTS internal scheduler interface)
  *
  * -------------------------------------------------------------------------*/
+#ifndef __SCHEDULE_H__
+#define __SCHEDULE_H__
+#include "OSThreads.h"
 
 //@menu
 //* Scheduler Functions::      
 
 //@cindex initScheduler
 //@cindex exitScheduler
-//@cindex startTasks
 /* initScheduler(), exitScheduler(), startTasks()
  * 
  * Called from STG :  no
  * Locks assumed   :  none
  */
-void initScheduler( void );
-void exitScheduler( void );
-#ifdef SMP
-void startTasks( void );
-#endif
-
+extern void initScheduler  ( void );
+extern void exitScheduler  ( void );
 
 //@cindex awakenBlockedQueue
 /* awakenBlockedQueue()
@@ -85,6 +83,24 @@ void raiseAsync(StgTSO *tso, StgClosure *exception);
  */
 void awaitEvent(rtsBool wait);  /* In Select.c */
 
+/* wakeUpSleepingThreads(nat ticks)
+ *
+ * Wakes up any sleeping threads whose timers have expired.
+ *
+ * Called from STG :  NO
+ * Locks assumed   :  sched_mutex
+ */
+rtsBool wakeUpSleepingThreads(nat);  /* In Select.c */
+
+/* GetRoots(evac_fn f)
+ *
+ * Call f() for each root known to the scheduler.
+ *
+ * Called from STG :  NO
+ * Locks assumed   :  ????
+ */
+void GetRoots(evac_fn);
+
 // ToDo: check whether all fcts below are used in the SMP version, too
 //@cindex awaken_blocked_queue
 #if defined(GRAN)
@@ -112,22 +128,8 @@ void    initThread(StgTSO *tso, nat stack_size);
 extern nat context_switch;
 extern rtsBool interrupted;
 
-extern  nat ticks_since_select;
-
-//@cindex Capability
-/* Capability type
- */
-typedef StgRegTable Capability;
-
-/* Free capability list.
- * Locks required: sched_mutex.
- */
-#ifdef SMP
-extern Capability *free_capabilities;
-extern nat n_free_capabilities;
-#else
-extern Capability MainRegTable;
-#endif
+/* In Select.c */
+extern nat timestamp;
 
 /* Thread queues.
  * Locks required  : sched_mutex
@@ -139,35 +141,33 @@ extern Capability MainRegTable;
 #else
 extern  StgTSO *run_queue_hd, *run_queue_tl;
 extern  StgTSO *blocked_queue_hd, *blocked_queue_tl;
+extern  StgTSO *sleeping_queue;
 #endif
 /* Linked list of all threads. */
 extern  StgTSO *all_threads;
 
-#ifdef SMP
-//@cindex sched_mutex
-//@cindex thread_ready_cond
-//@cindex gc_pending_cond
-extern pthread_mutex_t sched_mutex;
-extern pthread_cond_t  thread_ready_cond;
-extern pthread_cond_t  gc_pending_cond;
+#if defined(RTS_SUPPORTS_THREADS)
+/* Schedule.c has detailed info on what these do */
+extern Mutex       sched_mutex;
+extern Condition   thread_ready_cond;
+extern Condition   returning_worker_cond;
+extern nat         rts_n_waiting_workers;
+extern nat         rts_n_waiting_tasks;
 #endif
 
-//@cindex task_info
-#ifdef SMP
-typedef struct {
-  pthread_t id;
-  double    elapsedtimestart;
-  double    mut_time;
-  double    mut_etime;
-  double    gc_time;
-  double    gc_etime;
-} task_info;
-
-extern task_info *task_ids;
+
+/* Sigh, RTS-internal versions of waitThread(), scheduleThread(), and
+   rts_evalIO() for the use by main() only. ToDo: better. */
+extern SchedulerStatus waitThread_(StgTSO *tso,
+                                  /*out*/StgClosure **ret
+#if defined(THREADED_RTS)
+                                  , rtsBool blockWaiting
 #endif
+                                  );
+extern SchedulerStatus rts_mainEvalIO(HaskellObj p, /*out*/HaskellObj *ret);
 
-/* Needed by Hugs.
- */
+
+/* Called by shutdown_handler(). */
 void interruptStgRts ( void );
 
 void raiseAsync(StgTSO *tso, StgClosure *exception);
@@ -186,21 +186,15 @@ void printThreadStatus(StgTSO *tso);
 void printAllThreads(void);
 #endif
 void print_bq (StgClosure *node);
+#if defined(PAR)
+void print_bqe (StgBlockingQueueElement *bqe);
+#endif
 
 /* -----------------------------------------------------------------------------
  * Some convenient macros...
  */
 
-/* this is the NIL ptr for a TSO queue (e.g. runnable queue) */
-#define END_TSO_QUEUE  ((StgTSO *)(void*)&END_TSO_QUEUE_closure)
-/* this is the NIL ptr for a list CAFs */
-#define END_ECAF_LIST   ((StgCAF *)(void*)&END_TSO_QUEUE_closure)
-#if defined(PAR) || defined(GRAN)
-/* this is the NIL ptr for a blocking queue */
-# define END_BQ_QUEUE  ((StgBlockingQueueElement *)(void*)&END_TSO_QUEUE_closure)
-/* this is the NIL ptr for a blocked fetch queue (as in PendingFetches in GUM) */
-# define END_BF_QUEUE  ((StgBlockedFetch *)(void*)&END_TSO_QUEUE_closure)
-#endif
+/* END_TSO_QUEUE and friends now defined in includes/StgMiscClosures.h */
 
 //@cindex APPEND_TO_RUN_QUEUE
 /* Add a thread to the end of the run queue.
@@ -257,26 +251,32 @@ void print_bq (StgClosure *node);
 /* Signal that a runnable thread has become available, in
  * case there are any waiting tasks to execute it.
  */
-#ifdef SMP
+#if defined(RTS_SUPPORTS_THREADS)
 #define THREAD_RUNNABLE()                      \
-  if (free_capabilities != NULL) {             \
-     pthread_cond_signal(&thread_ready_cond);  \
+  if ( !noCapabilities() ) {                   \
+     signalCondition(&thread_ready_cond);      \
   }                                            \
   context_switch = 1;
 #else
 #define THREAD_RUNNABLE()  /* nothing */
 #endif
 
+//@cindex EMPTY_RUN_QUEUE
+/* Check whether the run queue is empty i.e. the PE is idle
+ */
+#define EMPTY_RUN_QUEUE()     (run_queue_hd == END_TSO_QUEUE)
+#define EMPTY_QUEUE(q)        (q == END_TSO_QUEUE)
+
+#endif /* __SCHEDULE_H__ */
+
 //@node Index,  , Some convenient macros
 //@subsection Index
 
 //@index
 //* APPEND_TO_BLOCKED_QUEUE::  @cindex\s-+APPEND_TO_BLOCKED_QUEUE
 //* APPEND_TO_RUN_QUEUE::  @cindex\s-+APPEND_TO_RUN_QUEUE
-//* Capability::  @cindex\s-+Capability
 //* POP_RUN_QUEUE    ::  @cindex\s-+POP_RUN_QUEUE    
 //* PUSH_ON_RUN_QUEUE::  @cindex\s-+PUSH_ON_RUN_QUEUE
-//* THREAD_RUNNABLE::  @cindex\s-+THREAD_RUNNABLE
 //* awaitEvent::  @cindex\s-+awaitEvent
 //* awakenBlockedQueue::  @cindex\s-+awakenBlockedQueue
 //* awaken_blocked_queue::  @cindex\s-+awaken_blocked_queue
@@ -285,9 +285,6 @@ void print_bq (StgClosure *node);
 //* gc_pending_cond::  @cindex\s-+gc_pending_cond
 //* initScheduler::  @cindex\s-+initScheduler
 //* raiseAsync::  @cindex\s-+raiseAsync
-//* sched_mutex::  @cindex\s-+sched_mutex
 //* startTasks::  @cindex\s-+startTasks
-//* task_info::  @cindex\s-+task_info
-//* thread_ready_cond::  @cindex\s-+thread_ready_cond
 //* unblockOne::  @cindex\s-+unblockOne
 //@end index