X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Frts%2FSchedule.h;h=b2a07e46214d90f3bea65e39833dcbe278a8ec8b;hb=9e6162f9d0102d1f5738bf78258b24ea5a647ea4;hp=78b7a60bc79f7b9c14d82ad3c01f07b03fbf8dd1;hpb=dd4c28a9c706cce09ecc2c6f532969efa925532f;p=ghc-hetmet.git diff --git a/ghc/rts/Schedule.h b/ghc/rts/Schedule.h index 78b7a60..b2a07e4 100644 --- a/ghc/rts/Schedule.h +++ b/ghc/rts/Schedule.h @@ -1,5 +1,5 @@ /* ----------------------------------------------------------------------------- - * $Id: Schedule.h,v 1.17 2000/03/31 03:09:36 hwloidl Exp $ + * $Id: Schedule.h,v 1.38 2003/03/17 14:47:48 simonmar Exp $ * * (c) The GHC Team 1998-1999 * @@ -8,31 +8,18 @@ * * -------------------------------------------------------------------------*/ -//@menu -//* Scheduler Functions:: -//* Scheduler Vars and Data Types:: -//* Some convenient macros:: -//* Index:: -//@end menu +#ifndef __SCHEDULE_H__ +#define __SCHEDULE_H__ +#include "OSThreads.h" -//@node Scheduler Functions, Scheduler Vars and Data Types -//@subsection 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() * * Takes a pointer to the beginning of a blocked TSO queue, and @@ -47,9 +34,11 @@ void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node); void awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node); #else void awakenBlockedQueue(StgTSO *tso); +#if defined(RTS_SUPPORTS_THREADS) +void awakenBlockedQueueNoLock(StgTSO *tso); +#endif #endif -//@cindex unblockOne /* unblockOne() * * Takes a pointer to the beginning of a blocked TSO queue, and @@ -64,7 +53,6 @@ StgBlockingQueueElement *unblockOne(StgBlockingQueueElement *bqe, StgClosure *no StgTSO *unblockOne(StgTSO *tso); #endif -//@cindex raiseAsync /* raiseAsync() * * Raises an exception asynchronously in the specified thread. @@ -73,19 +61,46 @@ StgTSO *unblockOne(StgTSO *tso); * Locks assumed : none */ void raiseAsync(StgTSO *tso, StgClosure *exception); +void raiseAsyncWithLock(StgTSO *tso, StgClosure *exception); -//@cindex awaitEvent -/* awaitEvent() +/* awaitEvent(rtsBool wait) * - * Raises an exception asynchronously in the specified thread. + * Checks for blocked threads that need to be woken. * * Called from STG : NO * Locks assumed : sched_mutex */ 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 */ + +/* wakeBlockedWorkerThread() + * + * If a worker thread is currently blocked in awaitEvent(), interrupt it. + * + * Called from STG : NO + * Locks assumed : sched_mutex + */ +void wakeBlockedWorkerThread(void); /* 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 awaken_blocked_queue(StgBlockingQueueElement *q, StgClosure *node); void unlink_from_bq(StgTSO* tso, StgClosure* node); @@ -101,32 +116,14 @@ 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; -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 @@ -138,35 +135,26 @@ 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; -#endif +StgInt forkProcess(StgTSO *tso); -/* Needed by Hugs. - */ +extern SchedulerStatus rts_mainLazyIO(HaskellObj p, /*out*/HaskellObj *ret); + + +/* Called by shutdown_handler(). */ void interruptStgRts ( void ); void raiseAsync(StgTSO *tso, StgClosure *exception); @@ -174,34 +162,66 @@ nat run_queue_len(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; +#if defined(THREADED_RTS) + rtsBool thread_bound; + Condition bound_thread_cond; +#endif +#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... */ -/* 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_CAF_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. * NOTE: tso->link should be END_TSO_QUEUE before calling this macro. */ @@ -214,7 +234,6 @@ void print_bq (StgClosure *node); } \ 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. */ @@ -225,7 +244,6 @@ void print_bq (StgClosure *node); run_queue_tl = tso; \ } -//@cindex POP_RUN_QUEUE /* Pop the first thread off the runnable queue. */ #define POP_RUN_QUEUE() \ @@ -240,7 +258,6 @@ void print_bq (StgClosure *node); t; \ }) -//@cindex APPEND_TO_BLOCKED_QUEUE /* Add a thread to the end of the blocked queue. */ #define APPEND_TO_BLOCKED_QUEUE(tso) \ @@ -252,41 +269,37 @@ void print_bq (StgClosure *node); } \ 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); \ - } \ + wakeBlockedWorkerThread(); \ context_switch = 1; #else #define THREAD_RUNNABLE() /* nothing */ #endif -//@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 -//* 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 -//* 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 +/* Check whether various thread queues are empty + */ +#define EMPTY_QUEUE(q) (q == END_TSO_QUEUE) + +#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)) + +#define EMPTY_THREAD_QUEUES() (EMPTY_RUN_QUEUE() && \ + EMPTY_BLOCKED_QUEUE() && \ + EMPTY_SLEEPING_QUEUE()) + +#if defined(RTS_SUPPORTS_THREADS) +/* If no task is waiting for a capability, + * spawn a new worker thread. + * + * (Used by the RtsAPI) + */ +void +startSchedulerTask(void); +#endif + +#endif /* __SCHEDULE_H__ */