/* -----------------------------------------------------------------------------
- * $Id: Schedule.h,v 1.13 2000/01/13 14:34:05 hwloidl Exp $
+ * $Id: Schedule.h,v 1.28 2002/02/13 08:48:07 sof Exp $
*
* (c) The GHC Team 1998-1999
*
* (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()
* Locks assumed : none
*/
#if defined(GRAN)
-# error FixME
+void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node);
#elif defined(PAR)
void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node);
#else
* Called from STG : yes
* Locks assumed : none
*/
-#if defined(GRAN)
-# error FixME
-#elif defined(PAR)
-StgTSO *unblockOne(StgTSO *tso, StgClosure *node);
+#if defined(GRAN) || defined(PAR)
+StgBlockingQueueElement *unblockOne(StgBlockingQueueElement *bqe, StgClosure *node);
#else
StgTSO *unblockOne(StgTSO *tso);
#endif
*/
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)
void initThread(StgTSO *tso, nat stack_size);
#endif
-// debugging only
-#ifdef DEBUG
-extern void printThreadBlockage(StgTSO *tso);
-#endif
-void print_bq (StgClosure *node);
-
//@node Scheduler Vars and Data Types, Some convenient macros, Scheduler Functions
//@subsection Scheduler Vars and Data Types
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
+ *
+ * In GranSim we have one run/blocked_queue per PE.
*/
+#if defined(GRAN)
+// run_queue_hds defined in GranSim.h
+#else
extern StgTSO *run_queue_hd, *run_queue_tl;
extern StgTSO *blocked_queue_hd, *blocked_queue_tl;
-
-#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;
+extern StgTSO *sleeping_queue;
#endif
+/* Linked list of all threads. */
+extern StgTSO *all_threads;
-//@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;
+#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
-#if !defined(GRAN)
-extern StgTSO *run_queue_hd, *run_queue_tl;
-extern StgTSO *blocked_queue_hd, *blocked_queue_tl;
+
+/* 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 void scheduleThread_(StgTSO *tso
+#if defined(THREADED_RTS)
+ , rtsBool createTask
+#endif
+ );
+extern SchedulerStatus rts_mainEvalIO(HaskellObj p, /*out*/HaskellObj *ret);
-/* Needed by Hugs.
- */
+
+/* Called by shutdown_handler(). */
void interruptStgRts ( void );
-// ?? needed -- HWL
+
void raiseAsync(StgTSO *tso, StgClosure *exception);
+nat run_queue_len(void);
+
+void resurrectThreads( StgTSO * );
//@node Some convenient macros, Index, Scheduler Vars and Data Types
//@subsection Some convenient macros
+/* debugging only
+ */
+#ifdef DEBUG
+void printThreadBlockage(StgTSO *tso);
+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...
*/
-#define END_TSO_QUEUE ((StgTSO *)(void*)&END_TSO_QUEUE_closure)
-#define END_CAF_LIST ((StgCAF *)(void*)&END_TSO_QUEUE_closure)
+/* 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.
run_queue_tl = tso; \
}
-//@cindex POP_RUN_QUEUE
+//@cindex POP_RUN_QUEUE
/* Pop the first thread off the runnable queue.
*/
#define POP_RUN_QUEUE() \
/* 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
//* 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