/* ---------------------------------------------------------------------------
- * $Id: Schedule.c,v 1.114 2002/01/31 11:18:07 sof Exp $
+ * $Id: Schedule.c,v 1.123 2002/02/14 07:52:05 sof Exp $
*
* (c) The GHC Team, 1998-2000
*
#include "Sparks.h"
#include "Capability.h"
#include "OSThreads.h"
+#include "Task.h"
#include <stdarg.h>
SchedulerStatus stat;
StgClosure ** ret;
#if defined(RTS_SUPPORTS_THREADS)
- CondVar wakeup;
+ Condition wakeup;
#endif
struct StgMainThread_ *link;
} StgMainThread;
/* rtsTime TimeOfNextEvent, EndOfTimeSlice; now in GranSim.c */
/*
- In GranSim we have a runable and a blocked queue for each processor.
+ In GranSim we have a runnable and a blocked queue for each processor.
In order to minimise code changes new arrays run_queue_hds/tls
are created. run_queue_hd is then a short cut (macro) for
run_queue_hds[CurrentProc] (see GranSim.h).
*/
StgTSO *all_threads;
-/* Threads suspended in _ccall_GC.
+/* When a thread performs a safe C call (_ccall_GC, using old
+ * terminology), it gets put on the suspended_ccalling_threads
+ * list. Used by the garbage collector.
*/
static StgTSO *suspended_ccalling_threads;
#define MIN_STACK_WORDS (RESERVED_STACK_WORDS + sizeofW(StgStopFrame) + 2)
-#if !defined(SMP)
-Capability MainCapability; /* for non-SMP, we have one global capability */
-#endif
-
#if defined(GRAN)
StgTSO *CurrentTSO;
#endif
rtsBool ready_to_gc;
-/* All our current task ids, saved in case we need to kill them later.
- */
-#if defined(SMP)
-//@cindex task_ids
-task_info *task_ids;
-#endif
-
void addToBlockedQueue ( StgTSO *tso );
static void schedule ( void );
/* ToDo: carefully document the invariants that go together
* with these synchronisation objects.
*/
-MutexVar sched_mutex = INIT_MUTEX_VAR;
-MutexVar term_mutex = INIT_MUTEX_VAR;
-CondVar thread_ready_cond = INIT_COND_VAR;
-CondVar gc_pending_cond = INIT_COND_VAR;
+Mutex sched_mutex = INIT_MUTEX_VAR;
+Mutex term_mutex = INIT_MUTEX_VAR;
-nat await_death;
+
+
+
+/* thread_ready_cond: when signalled, a thread has become runnable for a
+ * task to execute.
+ *
+ * In the non-SMP case, it also implies that the thread that is woken up has
+ * exclusive access to the RTS and all its data structures (that are not
+ * under sched_mutex's control).
+ *
+ * thread_ready_cond is signalled whenever COND_NO_THREADS_READY doesn't hold.
+ *
+ */
+Condition thread_ready_cond = INIT_COND_VAR;
+#if 0
+/* For documentation purposes only */
+#define COND_NO_THREADS_READY() (noCapabilities() || EMPTY_RUN_QUEUE())
#endif
+/*
+ * To be able to make an informed decision about whether or not
+ * to create a new task when making an external call, keep track of
+ * the number of tasks currently blocked waiting on thread_ready_cond.
+ * (if > 0 => no need for a new task, just unblock an existing one).
+ *
+ * waitForWork() takes care of keeping it up-to-date; Task.startTask()
+ * uses its current value.
+ */
+nat rts_n_waiting_tasks = 0;
+
+static void waitForWork(void);
+
+# if defined(SMP)
+static Condition gc_pending_cond = INIT_COND_VAR;
+nat await_death;
+# endif
+
+#endif /* RTS_SUPPORTS_THREADS */
+
#if defined(PAR)
StgTSO *LastTSO;
rtsTime TimeOfLastYield;
StgTSO *MainTSO;
*/
+#if defined(PAR) || defined(RTS_SUPPORTS_THREADS)
+static void taskStart(void);
+static void
+taskStart(void)
+{
+ schedule();
+}
+#endif
+
+
+
+
//@node Main scheduling loop, Suspend and Resume, Prototypes, Main scheduling code
//@subsection Main scheduling loop
# endif
#endif
rtsBool was_interrupted = rtsFalse;
+
+#if defined(RTS_SUPPORTS_THREADS)
+schedule_start:
+#endif
+#if defined(RTS_SUPPORTS_THREADS)
ACQUIRE_LOCK(&sched_mutex);
+#endif
+
+#if defined(RTS_SUPPORTS_THREADS)
+ /* ToDo: consider SMP support */
+ if ( rts_n_waiting_workers > 0 && noCapabilities() ) {
+ /* (At least) one native thread is waiting to
+ * deposit the result of an external call. So,
+ * be nice and hand over our capability.
+ */
+ yieldCapability(cap);
+ /* Lost our sched_mutex lock, try to re-enter the scheduler. */
+ goto schedule_start;
+ }
+#endif
+
+#if defined(RTS_SUPPORTS_THREADS)
+ while ( noCapabilities() ) {
+ waitForWork();
+ }
+#endif
#if defined(GRAN)
}
*prev = m->link;
m->stat = Success;
- broadcastCondVar(&m->wakeup);
+ broadcastCondition(&m->wakeup);
break;
case ThreadKilled:
if (m->ret) *(m->ret) = NULL;
} else {
m->stat = Killed;
}
- broadcastCondVar(&m->wakeup);
+ broadcastCondition(&m->wakeup);
break;
default:
break;
* work for them.
*/
if (getFreeCapabilities() - n > 1) {
- signalCondVar ( &thread_ready_cond );
+ signalCondition( &thread_ready_cond );
}
}
#endif // SMP
* ToDo: what if another client comes along & requests another
* main thread?
*/
- if (blocked_queue_hd != END_TSO_QUEUE || sleeping_queue != END_TSO_QUEUE) {
- awaitEvent(
- (run_queue_hd == END_TSO_QUEUE)
+ if ( !EMPTY_QUEUE(blocked_queue_hd) || !EMPTY_QUEUE(sleeping_queue) ) {
+ awaitEvent( EMPTY_RUN_QUEUE()
#if defined(SMP)
&& allFreeCapabilities()
#endif
* inform all the main threads.
*/
#ifndef PAR
- if (blocked_queue_hd == END_TSO_QUEUE
- && run_queue_hd == END_TSO_QUEUE
- && sleeping_queue == END_TSO_QUEUE
-#if defined(SMP)
+ if ( EMPTY_RUN_QUEUE()
+ && EMPTY_QUEUE(blocked_queue_hd)
+ && EMPTY_QUEUE(sleeping_queue)
+#if defined(RTS_SUPPORTS_THREADS)
+ && EMPTY_QUEUE(suspended_ccalling_threads)
+#endif
+#ifdef SMP
&& allFreeCapabilities()
#endif
)
{
IF_DEBUG(scheduler, sched_belch("deadlocked, forcing major GC..."));
+#if defined(THREADED_RTS)
+ /* and SMP mode ..? */
+ releaseCapability(cap);
+#endif
+ RELEASE_LOCK(&sched_mutex);
GarbageCollect(GetRoots,rtsTrue);
- if (blocked_queue_hd == END_TSO_QUEUE
- && run_queue_hd == END_TSO_QUEUE
- && sleeping_queue == END_TSO_QUEUE) {
+ ACQUIRE_LOCK(&sched_mutex);
+ if ( EMPTY_QUEUE(blocked_queue_hd)
+ && EMPTY_RUN_QUEUE()
+ && EMPTY_QUEUE(sleeping_queue) ) {
IF_DEBUG(scheduler, sched_belch("still deadlocked, checking for black holes..."));
detectBlackHoles();
* build, send *all* main threads the deadlock exception,
* since none of them can make progress).
*/
- if (run_queue_hd == END_TSO_QUEUE) {
+ if ( EMPTY_RUN_QUEUE() ) {
StgMainThread *m;
#if defined(RTS_SUPPORTS_THREADS)
for (m = main_threads; m != NULL; m = m->link) {
}
#endif
}
-#if !defined(RTS_SUPPORTS_THREADS)
- ASSERT( run_queue_hd != END_TSO_QUEUE );
+#if defined(RTS_SUPPORTS_THREADS)
+ /* ToDo: revisit conditions (and mechanism) for shutting
+ down a multi-threaded world */
+ if ( EMPTY_RUN_QUEUE() ) {
+ IF_DEBUG(scheduler, sched_belch("all done, i think...shutting down."));
+ shutdownHaskellAndExit(0);
+ }
#endif
+ ASSERT( !EMPTY_RUN_QUEUE() );
}
}
#elif defined(PAR)
*/
if (ready_to_gc) {
IF_DEBUG(scheduler,sched_belch("waiting for GC"));
- waitCondVar ( &gc_pending_cond, &sched_mutex );
+ waitCondition( &gc_pending_cond, &sched_mutex );
}
#endif
#if defined(RTS_SUPPORTS_THREADS)
/* block until we've got a thread on the run queue and a free
* capability.
+ *
*/
- while ( run_queue_hd == END_TSO_QUEUE
-#if defined(SMP)
- || noFreeCapabilities()
-#endif
- ) {
- IF_DEBUG(scheduler, sched_belch("waiting for work"));
- waitCondVar ( &thread_ready_cond, &sched_mutex );
- IF_DEBUG(scheduler, sched_belch("work now available"));
+ if ( EMPTY_RUN_QUEUE() ) {
+ /* Give up our capability */
+ releaseCapability(cap);
+ while ( noCapabilities() || EMPTY_RUN_QUEUE() ) {
+ IF_DEBUG(scheduler, sched_belch("thread %d: waiting for work", osThreadId()));
+ waitForWork();
+ IF_DEBUG(scheduler, sched_belch("thread %d: work now available %d %d", osThreadId(), getFreeCapabilities(),EMPTY_RUN_QUEUE()));
+ }
}
#endif
#endif
#else /* !GRAN && !PAR */
- /* grab a thread from the run queue
- */
+ /* grab a thread from the run queue */
ASSERT(run_queue_hd != END_TSO_QUEUE);
t = POP_RUN_QUEUE();
-
// Sanity check the thread we're about to run. This can be
// expensive if there is lots of thread switching going on...
IF_DEBUG(sanity,checkTSO(t));
-
#endif
-#ifdef SMP
grabCapability(&cap);
-#else
- cap = &MainCapability;
-#endif
-
cap->r.rCurrentTSO = t;
/* context switches are now initiated by the timer signal, unless
barf("schedule: invalid thread return code %d", (int)ret);
}
-#ifdef SMP
+#if defined(RTS_SUPPORTS_THREADS)
+ /* I don't understand what this re-grab is doing -- sof */
grabCapability(&cap);
#endif
GarbageCollect(GetRoots,rtsFalse);
ready_to_gc = rtsFalse;
#ifdef SMP
- broadcastCondVar(&gc_pending_cond);
+ broadcastCondition(&gc_pending_cond);
#endif
#if defined(GRAN)
/* add a ContinueThread event to continue execution of current thread */
void deleteAllThreads ( void )
{
- StgTSO* t;
+ StgTSO* t, *next;
IF_DEBUG(scheduler,sched_belch("deleting all threads"));
- for (t = run_queue_hd; t != END_TSO_QUEUE; t = t->link) {
+ for (t = run_queue_hd; t != END_TSO_QUEUE; t = next) {
+ next = t->link;
deleteThread(t);
}
- for (t = blocked_queue_hd; t != END_TSO_QUEUE; t = t->link) {
+ for (t = blocked_queue_hd; t != END_TSO_QUEUE; t = next) {
+ next = t->link;
deleteThread(t);
}
- for (t = sleeping_queue; t != END_TSO_QUEUE; t = t->link) {
+ for (t = sleeping_queue; t != END_TSO_QUEUE; t = next) {
+ next = t->link;
deleteThread(t);
}
run_queue_hd = run_queue_tl = END_TSO_QUEUE;
/* startThread and insertThread are now in GranSim.c -- HWL */
+
//@node Suspend and Resume, Run queue code, Main scheduling loop, Main scheduling code
//@subsection Suspend and Resume
nat tok;
Capability *cap;
- // assume that *reg is a pointer to the StgRegTable part of a Capability
+ /* assume that *reg is a pointer to the StgRegTable part
+ * of a Capability.
+ */
cap = (Capability *)((void *)reg - sizeof(StgFunTable));
ACQUIRE_LOCK(&sched_mutex);
cap->r.rCurrentTSO->link = suspended_ccalling_threads;
suspended_ccalling_threads = cap->r.rCurrentTSO;
+#if defined(RTS_SUPPORTS_THREADS)
+ cap->r.rCurrentTSO->why_blocked = BlockedOnCCall;
+#endif
+
/* Use the thread ID as the token; it should be unique */
tok = cap->r.rCurrentTSO->id;
-#ifdef SMP
/* Hand back capability */
- releaseCapability(&cap);
+ releaseCapability(cap);
+
+#if defined(RTS_SUPPORTS_THREADS) && !defined(SMP)
+ /* Preparing to leave the RTS, so ensure there's a native thread/task
+ waiting to take over.
+
+ ToDo: optimise this and only create a new task if there's a need
+ for one (i.e., if there's only one Concurrent Haskell thread alive,
+ there's no need to create a new task).
+ */
+ IF_DEBUG(scheduler, sched_belch("worker thread (%d): leaving RTS\n", tok));
+ startTask(taskStart);
#endif
+ THREAD_RUNNABLE();
RELEASE_LOCK(&sched_mutex);
return tok;
}
StgTSO *tso, **prev;
Capability *cap;
- ACQUIRE_LOCK(&sched_mutex);
+#if defined(RTS_SUPPORTS_THREADS)
+ /* Wait for permission to re-enter the RTS with the result.. */
+ grabReturnCapability(&cap);
+#else
+ grabCapability(&cap);
+#endif
+ /* Remove the thread off of the suspended list */
prev = &suspended_ccalling_threads;
for (tso = suspended_ccalling_threads;
tso != END_TSO_QUEUE;
barf("resumeThread: thread not found");
}
tso->link = END_TSO_QUEUE;
+ /* Reset blocking status */
+ tso->why_blocked = NotBlocked;
-#ifdef SMP
- while ( noFreeCapabilities() ) {
- IF_DEBUG(scheduler, sched_belch("waiting to resume"));
- waitCondVar(&thread_ready_cond, &sched_mutex);
- IF_DEBUG(scheduler, sched_belch("resuming thread %d", tso->id));
- }
- grabCapability(&cap);
-#else
- cap = &MainCapability;
-#endif
+ RELEASE_LOCK(&sched_mutex);
cap->r.rCurrentTSO = tso;
-
- RELEASE_LOCK(&sched_mutex);
return &cap->r;
}
+#if defined(RTS_SUPPORTS_THREADS)
+static void
+waitForWork()
+{
+ rts_n_waiting_tasks++;
+ waitCondition(&thread_ready_cond, &sched_mutex);
+ rts_n_waiting_tasks--;
+ return;
+}
+#endif
+
+
/* ---------------------------------------------------------------------------
* Static functions
* ------------------------------------------------------------------------ */
* ------------------------------------------------------------------------ */
void
-scheduleThread(StgTSO *tso)
+scheduleThread_(StgTSO *tso
+#if defined(THREADED_RTS)
+ , rtsBool createTask
+#endif
+ )
{
ACQUIRE_LOCK(&sched_mutex);
* soon as we release the scheduler lock below.
*/
PUSH_ON_RUN_QUEUE(tso);
+#if defined(THREADED_RTS)
+ /* If main() is scheduling a thread, don't bother creating a
+ * new task.
+ */
+ if ( createTask ) {
+ startTask(taskStart);
+ }
+#endif
THREAD_RUNNABLE();
#if 0
RELEASE_LOCK(&sched_mutex);
}
-/* ---------------------------------------------------------------------------
- * startTasks()
- *
- * Start up Posix threads to run each of the scheduler tasks.
- * I believe the task ids are not needed in the system as defined.
- * KH @ 25/10/99
- * ------------------------------------------------------------------------ */
-
-#if defined(PAR) || defined(SMP)
-void
-taskStart(void) /* ( void *arg STG_UNUSED) */
+void scheduleThread(StgTSO* tso)
{
- schedule();
-}
+#if defined(THREADED_RTS)
+ return scheduleThread_(tso, rtsTrue);
+#else
+ return scheduleThread_(tso);
#endif
+}
/* ---------------------------------------------------------------------------
* initScheduler()
* queues contained any threads, they'll be garbage collected at the
* next pass.
*
- * This now calls startTasks(), so should only be called once! KH @ 25/10/99
* ------------------------------------------------------------------------ */
#ifdef SMP
RtsFlags.ConcFlags.ctxtSwitchTicks =
RtsFlags.ConcFlags.ctxtSwitchTime / TICK_MILLISECS;
+
+#if defined(RTS_SUPPORTS_THREADS)
+ /* Initialise the mutex and condition variables used by
+ * the scheduler. */
+ initMutex(&sched_mutex);
+ initMutex(&term_mutex);
+
+ initCondition(&thread_ready_cond);
+#endif
+
+#if defined(SMP)
+ initCondition(&gc_pending_cond);
+#endif
+
+#if defined(RTS_SUPPORTS_THREADS)
+ ACQUIRE_LOCK(&sched_mutex);
+#endif
/* Install the SIGHUP handler */
-#ifdef SMP
+#if defined(SMP)
{
struct sigaction action,oact;
}
#endif
-#ifdef SMP
- /* Allocate N Capabilities */
- initCapabilities(RtsFlags.ParFlags.nNodes);
-#else
- initCapability(&MainCapability);
+ /* A capability holds the state a native thread needs in
+ * order to execute STG code. At least one capability is
+ * floating around (only SMP builds have more than one).
+ */
+ initCapabilities();
+
+#if defined(RTS_SUPPORTS_THREADS)
+ /* start our haskell execution tasks */
+# if defined(SMP)
+ startTaskManager(RtsFlags.ParFlags.nNodes, taskStart);
+# else
+ startTaskManager(0,taskStart);
+# endif
#endif
#if /* defined(SMP) ||*/ defined(PAR)
initSparkPools();
#endif
-}
-#ifdef SMP
-void
-startTasks( void )
-{
- nat i;
- int r;
- OSThreadId tid;
-
- /* make some space for saving all the thread ids */
- task_ids = stgMallocBytes(RtsFlags.ParFlags.nNodes * sizeof(task_info),
- "initScheduler:task_ids");
-
- /* and create all the threads */
- for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
- r = createOSThread(&tid,taskStart);
- if (r != 0) {
- barf("startTasks: Can't create new Posix thread");
- }
- task_ids[i].id = tid;
- task_ids[i].mut_time = 0.0;
- task_ids[i].mut_etime = 0.0;
- task_ids[i].gc_time = 0.0;
- task_ids[i].gc_etime = 0.0;
- task_ids[i].elapsedtimestart = stat_getElapsedTime();
- IF_DEBUG(scheduler,fprintf(stderr,"scheduler: Started task: %ld\n",tid););
- }
-}
+#if defined(RTS_SUPPORTS_THREADS)
+ RELEASE_LOCK(&sched_mutex);
#endif
+}
+
void
exitScheduler( void )
{
-#ifdef SMP
- nat i;
-
- /* Don't want to use pthread_cancel, since we'd have to install
- * these silly exception handlers (pthread_cleanup_{push,pop}) around
- * all our locks.
- */
-#if 0
- /* Cancel all our tasks */
- for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
- pthread_cancel(task_ids[i].id);
- }
-
- /* Wait for all the tasks to terminate */
- for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
- IF_DEBUG(scheduler,fprintf(stderr,"scheduler: waiting for task %ld\n",
- task_ids[i].id));
- pthread_join(task_ids[i].id, NULL);
- }
-#endif
-
- /* Send 'em all a SIGHUP. That should shut 'em up.
- */
- await_death = RtsFlags.ParFlags.nNodes;
- for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
- pthread_kill(task_ids[i].id,SIGTERM);
- }
- while (await_death > 0) {
- sched_yield();
- }
+#if defined(RTS_SUPPORTS_THREADS)
+ stopTaskManager();
#endif
}
{
do {
while (run_queue_hd != END_TSO_QUEUE) {
- waitThread ( run_queue_hd, NULL );
+ waitThread ( run_queue_hd, NULL);
}
while (blocked_queue_hd != END_TSO_QUEUE) {
- waitThread ( blocked_queue_hd, NULL );
+ waitThread ( blocked_queue_hd, NULL);
}
while (sleeping_queue != END_TSO_QUEUE) {
- waitThread ( blocked_queue_hd, NULL );
+ waitThread ( blocked_queue_hd, NULL);
}
} while
(blocked_queue_hd != END_TSO_QUEUE ||
SchedulerStatus
waitThread(StgTSO *tso, /*out*/StgClosure **ret)
+{
+#if defined(THREADED_RTS)
+ return waitThread_(tso,ret, rtsFalse);
+#else
+ return waitThread_(tso,ret);
+#endif
+}
+
+SchedulerStatus
+waitThread_(StgTSO *tso,
+ /*out*/StgClosure **ret
+#if defined(THREADED_RTS)
+ , rtsBool blockWaiting
+#endif
+ )
{
StgMainThread *m;
SchedulerStatus stat;
m->ret = ret;
m->stat = NoStatus;
#if defined(RTS_SUPPORTS_THREADS)
- initCondVar(&m->wakeup);
+ initCondition(&m->wakeup);
#endif
m->link = main_threads;
main_threads = m;
- IF_DEBUG(scheduler, fprintf(stderr, "== scheduler: new main thread (%d)\n",
- m->tso->id));
+ IF_DEBUG(scheduler, sched_belch("== scheduler: new main thread (%d)\n", m->tso->id));
-#ifdef SMP
- do {
- waitCondVar(&m->wakeup, &sched_mutex);
- } while (m->stat == NoStatus);
+#if defined(RTS_SUPPORTS_THREADS)
+
+# if defined(THREADED_RTS)
+ if (!blockWaiting) {
+ /* In the threaded case, the OS thread that called main()
+ * gets to enter the RTS directly without going via another
+ * task/thread.
+ */
+ RELEASE_LOCK(&sched_mutex);
+ schedule();
+ ASSERT(m->stat != NoStatus);
+ } else
+# endif
+ {
+ IF_DEBUG(scheduler, sched_belch("sfoo"));
+ do {
+ waitCondition(&m->wakeup, &sched_mutex);
+ } while (m->stat == NoStatus);
+ }
#elif defined(GRAN)
/* GranSim specific init */
CurrentTSO = m->tso; // the TSO to run
schedule();
#else
+ RELEASE_LOCK(&sched_mutex);
schedule();
ASSERT(m->stat != NoStatus);
#endif
stat = m->stat;
#if defined(RTS_SUPPORTS_THREADS)
- closeCondVar(&m->wakeup);
+ closeCondition(&m->wakeup);
#endif
IF_DEBUG(scheduler, fprintf(stderr, "== scheduler: main thread (%d) finished\n",
m->tso->id));
free(m);
- RELEASE_LOCK(&sched_mutex);
+#if defined(THREADED_RTS)
+ if (blockWaiting)
+#endif
+ RELEASE_LOCK(&sched_mutex);
return stat;
}
tso->block_info.closure, info_type(tso->block_info.closure));
break;
#endif
+#if defined(RTS_SUPPORTS_THREADS)
+ case BlockedOnCCall:
+ fprintf(stderr,"is blocked on an external call");
+ break;
+#endif
default:
barf("printThreadBlockage: strange tso->why_blocked: %d for TSO %d (%d)",
tso->why_blocked, tso->id, tso);
//* sched_mutex:: @cindex\s-+sched_mutex
//* schedule:: @cindex\s-+schedule
//* take_off_run_queue:: @cindex\s-+take_off_run_queue
-//* task_ids:: @cindex\s-+task_ids
//* term_mutex:: @cindex\s-+term_mutex
//* thread_ready_cond:: @cindex\s-+thread_ready_cond
//@end index