/* -----------------------------------------------------------------------------
- * $Id: Schedule.h,v 1.10 1999/11/09 15:46:55 simonmar Exp $
+ * $Id: Schedule.h,v 1.29 2002/02/15 07:50:37 sof Exp $
*
* (c) The GHC Team 1998-1999
*
* Prototypes for functions in Schedule.c
* (RTS internal scheduler interface)
*
- * ---------------------------------------------------------------------------*/
+ * -------------------------------------------------------------------------*/
+#ifndef __SCHEDULE_H__
+#define __SCHEDULE_H__
+#include "OSThreads.h"
+//@menu
+//* Scheduler Functions::
+//* Scheduler Vars and Data Types::
+//* Some convenient macros::
+//* Index::
+//@end menu
+
+//@node Scheduler Functions, Scheduler Vars and Data Types
+//@subsection Scheduler Functions
+
+//@cindex initScheduler
+//@cindex exitScheduler
/* 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()
*
* Takes a pointer to the beginning of a blocked TSO queue, and
* Called from STG : yes
* Locks assumed : none
*/
+#if defined(GRAN)
+void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node);
+#elif defined(PAR)
+void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node);
+#else
void awakenBlockedQueue(StgTSO *tso);
+#endif
+//@cindex unblockOne
/* unblockOne()
*
* Takes a pointer to the beginning of a blocked TSO queue, and
* Called from STG : yes
* Locks assumed : none
*/
+#if defined(GRAN) || defined(PAR)
+StgBlockingQueueElement *unblockOne(StgBlockingQueueElement *bqe, StgClosure *node);
+#else
StgTSO *unblockOne(StgTSO *tso);
+#endif
+//@cindex raiseAsync
/* raiseAsync()
*
* Raises an exception asynchronously in the specified thread.
*/
void raiseAsync(StgTSO *tso, StgClosure *exception);
+//@cindex awaitEvent
/* awaitEvent()
*
* Raises an exception asynchronously in the specified thread.
*/
void awaitEvent(rtsBool wait); /* In Select.c */
-/* Context switch flag.
- * Locks required : sched_mutex
+/* wakeUpSleepingThreads(nat ticks)
+ *
+ * Wakes up any sleeping threads whose timers have expired.
+ *
+ * Called from STG : NO
+ * Locks assumed : sched_mutex
*/
-extern nat context_switch;
-
-extern nat ticks_since_select;
+rtsBool wakeUpSleepingThreads(nat); /* In Select.c */
-/* Capability type
+/* GetRoots(evac_fn f)
+ *
+ * Call f() for each root known to the scheduler.
+ *
+ * Called from STG : NO
+ * Locks assumed : ????
*/
-typedef StgRegTable Capability;
+void GetRoots(evac_fn);
-/* Free capability list.
- * Locks required: sched_mutex.
- */
-#ifdef SMP
-extern Capability *free_capabilities;
-extern nat n_free_capabilities;
+// ToDo: check whether all fcts below are used in the SMP version, too
+//@cindex awaken_blocked_queue
+#if defined(GRAN)
+void awaken_blocked_queue(StgBlockingQueueElement *q, StgClosure *node);
+void unlink_from_bq(StgTSO* tso, StgClosure* node);
+void initThread(StgTSO *tso, nat stack_size, StgInt pri);
+#elif defined(PAR)
+nat run_queue_len(void);
+void awaken_blocked_queue(StgBlockingQueueElement *q, StgClosure *node);
+void initThread(StgTSO *tso, nat stack_size);
#else
-extern Capability MainRegTable;
+char *info_type(StgClosure *closure); // dummy
+char *info_type_by_ip(StgInfoTable *ip); // dummy
+void awaken_blocked_queue(StgTSO *q);
+void initThread(StgTSO *tso, nat stack_size);
#endif
+//@node Scheduler Vars and Data Types, Some convenient macros, Scheduler Functions
+//@subsection Scheduler Vars and Data Types
+
+//@cindex context_switch
+/* Context switch flag.
+ * Locks required : sched_mutex
+ */
+extern nat context_switch;
+extern rtsBool interrupted;
+
+/* 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;
+extern StgTSO *sleeping_queue;
+#endif
+/* Linked list of all threads. */
+extern StgTSO *all_threads;
-#ifdef DEBUG
-extern void printThreadBlockage(StgTSO *tso);
+#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
-#ifdef SMP
-extern pthread_mutex_t sched_mutex;
-extern pthread_cond_t thread_ready_cond;
-extern pthread_cond_t gc_pending_cond;
+
+/* 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);
+
+
+/* Called by shutdown_handler(). */
+void interruptStgRts ( void );
+
+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
-#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;
+/* 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.
* NOTE: tso->link should be END_TSO_QUEUE before calling this macro.
*/
} \
run_queue_tl = tso;
+//@cindex PUSH_ON_RUN_QUEUE
/* Push a thread on the beginning of the run queue. Used for
* newly awakened threads, so they get run as soon as possible.
*/
if (run_queue_tl == END_TSO_QUEUE) { \
run_queue_tl = tso; \
}
-
+
+//@cindex POP_RUN_QUEUE
/* Pop the first thread off the runnable queue.
*/
#define POP_RUN_QUEUE() \
t; \
})
+//@cindex APPEND_TO_BLOCKED_QUEUE
/* Add a thread to the end of the blocked queue.
*/
#define APPEND_TO_BLOCKED_QUEUE(tso) \
} \
blocked_queue_tl = tso;
+//@cindex THREAD_RUNNABLE
/* 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
+//* POP_RUN_QUEUE :: @cindex\s-+POP_RUN_QUEUE
+//* PUSH_ON_RUN_QUEUE:: @cindex\s-+PUSH_ON_RUN_QUEUE
+//* awaitEvent:: @cindex\s-+awaitEvent
+//* awakenBlockedQueue:: @cindex\s-+awakenBlockedQueue
+//* awaken_blocked_queue:: @cindex\s-+awaken_blocked_queue
+//* context_switch:: @cindex\s-+context_switch
+//* exitScheduler:: @cindex\s-+exitScheduler
+//* gc_pending_cond:: @cindex\s-+gc_pending_cond
+//* initScheduler:: @cindex\s-+initScheduler
+//* raiseAsync:: @cindex\s-+raiseAsync
+//* startTasks:: @cindex\s-+startTasks
+//* unblockOne:: @cindex\s-+unblockOne
+//@end index
projects / ghc-hetmet.git / blobdiff