/* -----------------------------------------------------------------------------
- * $Id: Schedule.h,v 1.26 2002/02/04 20:40:37 sof Exp $
+ * $Id: Schedule.h,v 1.36 2002/10/22 11:01:20 simonmar Exp $
*
* (c) The GHC Team 1998-1999
*
* (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
extern void initScheduler ( void );
extern void exitScheduler ( void );
-//@cindex awakenBlockedQueue
/* awakenBlockedQueue()
*
* Takes a pointer to the beginning of a blocked TSO queue, and
void awakenBlockedQueue(StgTSO *tso);
#endif
-//@cindex unblockOne
/* unblockOne()
*
* Takes a pointer to the beginning of a blocked TSO queue, and
StgTSO *unblockOne(StgTSO *tso);
#endif
-//@cindex raiseAsync
/* raiseAsync()
*
* Raises an exception asynchronously in the specified thread.
* Locks assumed : none
*/
void raiseAsync(StgTSO *tso, StgClosure *exception);
+void raiseAsyncWithLock(StgTSO *tso, StgClosure *exception);
-//@cindex awaitEvent
/* awaitEvent()
*
* Raises an exception asynchronously in the specified thread.
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 awaken_blocked_queue(StgBlockingQueueElement *q, StgClosure *node);
void unlink_from_bq(StgTSO* tso, StgClosure* node);
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
*/
/* In Select.c */
extern nat timestamp;
-/* Free capability list.
- * Locks required: sched_mutex.
- */
-#ifdef SMP
-extern Capability *free_capabilities;
-extern nat n_free_capabilities;
-#else
-extern Capability MainCapability;
-#endif
-
/* Thread queues.
* Locks required : sched_mutex
*
extern StgTSO *all_threads;
#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 gc_pending_cond;
+extern Condition returning_worker_cond;
+extern nat rts_n_waiting_workers;
+extern nat rts_n_waiting_tasks;
#endif
+StgInt forkProcess(StgTSO *tso);
+
+extern SchedulerStatus rts_mainEvalIO(HaskellObj p, /*out*/HaskellObj *ret);
+
+
/* Called by shutdown_handler(). */
void interruptStgRts ( void );
void resurrectThreads( StgTSO * );
-//@node Some convenient macros, Index, Scheduler Vars and Data Types
-//@subsection Some convenient macros
+/* Main threads:
+ *
+ * These are the threads which clients have requested that we run.
+ *
+ * In a 'threaded' build, we might have several concurrent clients all
+ * waiting for results, and each one will wait on a condition variable
+ * until the result is available.
+ *
+ * In non-SMP, clients are strictly nested: the first client calls
+ * into the RTS, which might call out again to C with a _ccall_GC, and
+ * eventually re-enter the RTS.
+ *
+ * This is non-abstract at the moment because the garbage collector
+ * treats pointers to TSOs from the main thread list as "weak" - these
+ * pointers won't prevent a thread from receiving a BlockedOnDeadMVar
+ * exception.
+ *
+ * Main threads information is kept in a linked list:
+ */
+typedef struct StgMainThread_ {
+ StgTSO * tso;
+ SchedulerStatus stat;
+ StgClosure ** ret;
+#if defined(RTS_SUPPORTS_THREADS)
+ Condition wakeup;
+#endif
+ struct StgMainThread_ *link;
+} StgMainThread;
-/* debugging only
+/* Main thread queue.
+ * Locks required: sched_mutex.
*/
-#ifdef DEBUG
-void printThreadBlockage(StgTSO *tso);
-void printThreadStatus(StgTSO *tso);
+extern StgMainThread *main_threads;
+
void printAllThreads(void);
+#ifdef COMPILING_SCHEDULER
+static void printThreadBlockage(StgTSO *tso);
+static void printThreadStatus(StgTSO *tso);
#endif
+/* debugging only
+ */
+#ifdef DEBUG
void print_bq (StgClosure *node);
+#endif
#if defined(PAR)
void print_bqe (StgBlockingQueueElement *bqe);
#endif
+void labelThread(StgPtr tso, char *label);
+
/* -----------------------------------------------------------------------------
* Some convenient macros...
*/
/* 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.
*/
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) { \
+ if ( !noCapabilities() ) { \
signalCondition(&thread_ready_cond); \
} \
context_switch = 1;
#define THREAD_RUNNABLE() /* nothing */
#endif
-//@cindex EMPTY_RUN_QUEUE
-/* Check whether the run queue is empty i.e. the PE is idle
+/* Check whether various thread queues are empty
*/
-#define EMPTY_RUN_QUEUE() (run_queue_hd == END_TSO_QUEUE)
+#define EMPTY_QUEUE(q) (q == END_TSO_QUEUE)
-#endif /* __SCHEDULE_H__ */
+#define EMPTY_RUN_QUEUE() (EMPTY_QUEUE(run_queue_hd))
+#define EMPTY_BLOCKED_QUEUE() (EMPTY_QUEUE(blocked_queue_hd))
+#define EMPTY_SLEEPING_QUEUE() (EMPTY_QUEUE(sleeping_queue))
-//@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
+#define EMPTY_THREAD_QUEUES() (EMPTY_RUN_QUEUE() && \
+ EMPTY_BLOCKED_QUEUE() && \
+ EMPTY_SLEEPING_QUEUE())
+
+#endif /* __SCHEDULE_H__ */
projects / ghc-hetmet.git / blobdiff