ghc/rts/Schedule.c

   1 /* ---------------------------------------------------------------------------
   2  * $Id: Schedule.c,v 1.168 2003/04/08 15:53:51 sof Exp $
   3  *
   4  * (c) The GHC Team, 1998-2000
   5  *
   6  * Scheduler
   7  *
   8  * Different GHC ways use this scheduler quite differently (see comments below)
   9  * Here is the global picture:
  10  *
  11  * WAY  Name     CPP flag  What's it for
  12  * --------------------------------------
  13  * mp   GUM      PAR          Parallel execution on a distributed memory machine
  14  * s    SMP      SMP          Parallel execution on a shared memory machine
  15  * mg   GranSim  GRAN         Simulation of parallel execution
  16  * md   GUM/GdH  DIST         Distributed execution (based on GUM)
  17  *
  18  * --------------------------------------------------------------------------*/
  19
  20 //@node Main scheduling code, , ,
  21 //@section Main scheduling code
  22
  23 /*
  24  * Version with scheduler monitor support for SMPs (WAY=s):
  25
  26    This design provides a high-level API to create and schedule threads etc.
  27    as documented in the SMP design document.
  28
  29    It uses a monitor design controlled by a single mutex to exercise control
  30    over accesses to shared data structures, and builds on the Posix threads
  31    library.
  32
  33    The majority of state is shared.  In order to keep essential per-task state,
  34    there is a Capability structure, which contains all the information
  35    needed to run a thread: its STG registers, a pointer to its TSO, a
  36    nursery etc.  During STG execution, a pointer to the capability is
  37    kept in a register (BaseReg).
  38
  39    In a non-SMP build, there is one global capability, namely MainRegTable.
  40
  41    SDM & KH, 10/99
  42
  43  * Version with support for distributed memory parallelism aka GUM (WAY=mp):
  44
  45    The main scheduling loop in GUM iterates until a finish message is received.
  46    In that case a global flag @receivedFinish@ is set and this instance of
  47    the RTS shuts down. See ghc/rts/parallel/HLComms.c:processMessages()
  48    for the handling of incoming messages, such as PP_FINISH.
  49    Note that in the parallel case we have a system manager that coordinates
  50    different PEs, each of which are running one instance of the RTS.
  51    See ghc/rts/parallel/SysMan.c for the main routine of the parallel program.
  52    From this routine processes executing ghc/rts/Main.c are spawned. -- HWL
  53
  54  * Version with support for simulating parallel execution aka GranSim (WAY=mg):
  55
  56    The main scheduling code in GranSim is quite different from that in std
  57    (concurrent) Haskell: while concurrent Haskell just iterates over the
  58    threads in the runnable queue, GranSim is event driven, i.e. it iterates
  59    over the events in the global event queue.  -- HWL
  60 */
  61
  62 //@menu
  63 //* Includes::
  64 //* Variables and Data structures::
  65 //* Main scheduling loop::
  66 //* Suspend and Resume::
  67 //* Run queue code::
  68 //* Garbage Collextion Routines::
  69 //* Blocking Queue Routines::
  70 //* Exception Handling Routines::
  71 //* Debugging Routines::
  72 //* Index::
  73 //@end menu
  74
  75 //@node Includes, Variables and Data structures, Main scheduling code, Main scheduling code
  76 //@subsection Includes
  77
  78 #include "PosixSource.h"
  79 #include "Rts.h"
  80 #include "SchedAPI.h"
  81 #include "RtsUtils.h"
  82 #include "RtsFlags.h"
  83 #include "Storage.h"
  84 #include "StgRun.h"
  85 #include "StgStartup.h"
  86 #include "Hooks.h"
  87 #define COMPILING_SCHEDULER
  88 #include "Schedule.h"
  89 #include "StgMiscClosures.h"
  90 #include "Storage.h"
  91 #include "Interpreter.h"
  92 #include "Exception.h"
  93 #include "Printer.h"
  94 #include "Signals.h"
  95 #include "Sanity.h"
  96 #include "Stats.h"
  97 #include "Timer.h"
  98 #include "Prelude.h"
  99 #include "ThreadLabels.h"
 100 #ifdef PROFILING
 101 #include "Proftimer.h"
 102 #include "ProfHeap.h"
 103 #endif
 104 #if defined(GRAN) || defined(PAR)
 105 # include "GranSimRts.h"
 106 # include "GranSim.h"
 107 # include "ParallelRts.h"
 108 # include "Parallel.h"
 109 # include "ParallelDebug.h"
 110 # include "FetchMe.h"
 111 # include "HLC.h"
 112 #endif
 113 #include "Sparks.h"
 114 #include "Capability.h"
 115 #include "OSThreads.h"
 116 #include  "Task.h"
 117
 118 #ifdef HAVE_SYS_TYPES_H
 119 #include <sys/types.h>
 120 #endif
 121 #ifdef HAVE_UNISTD_H
 122 #include <unistd.h>
 123 #endif
 124
 125 #include <string.h>
 126 #include <stdlib.h>
 127 #include <stdarg.h>
 128
 129 //@node Variables and Data structures, Prototypes, Includes, Main scheduling code
 130 //@subsection Variables and Data structures
 131
 132 /* Main thread queue.
 133  * Locks required: sched_mutex.
 134  */
 135 StgMainThread *main_threads = NULL;
 136
 137 #ifdef THREADED_RTS
 138 // Pointer to the thread that executes main
 139 // When this thread is finished, the program terminates
 140 // by calling shutdownHaskellAndExit.
 141 // It would be better to add a call to shutdownHaskellAndExit
 142 // to the Main.main wrapper and to remove this hack.
 143 StgMainThread *main_main_thread = NULL;
 144 #endif
 145
 146 /* Thread queues.
 147  * Locks required: sched_mutex.
 148  */
 149 #if defined(GRAN)
 150
 151 StgTSO* ActiveTSO = NULL; /* for assigning system costs; GranSim-Light only */
 152 /* rtsTime TimeOfNextEvent, EndOfTimeSlice;            now in GranSim.c */
 153
 154 /*
 155    In GranSim we have a runnable and a blocked queue for each processor.
 156    In order to minimise code changes new arrays run_queue_hds/tls
 157    are created. run_queue_hd is then a short cut (macro) for
 158    run_queue_hds[CurrentProc] (see GranSim.h).
 159    -- HWL
 160 */
 161 StgTSO *run_queue_hds[MAX_PROC], *run_queue_tls[MAX_PROC];
 162 StgTSO *blocked_queue_hds[MAX_PROC], *blocked_queue_tls[MAX_PROC];
 163 StgTSO *ccalling_threadss[MAX_PROC];
 164 /* We use the same global list of threads (all_threads) in GranSim as in
 165    the std RTS (i.e. we are cheating). However, we don't use this list in
 166    the GranSim specific code at the moment (so we are only potentially
 167    cheating).  */
 168
 169 #else /* !GRAN */
 170
 171 StgTSO *run_queue_hd = NULL;
 172 StgTSO *run_queue_tl = NULL;
 173 StgTSO *blocked_queue_hd = NULL;
 174 StgTSO *blocked_queue_tl = NULL;
 175 StgTSO *sleeping_queue = NULL;    /* perhaps replace with a hash table? */
 176
 177 #endif
 178
 179 /* Linked list of all threads.
 180  * Used for detecting garbage collected threads.
 181  */
 182 StgTSO *all_threads = NULL;
 183
 184 /* When a thread performs a safe C call (_ccall_GC, using old
 185  * terminology), it gets put on the suspended_ccalling_threads
 186  * list. Used by the garbage collector.
 187  */
 188 static StgTSO *suspended_ccalling_threads;
 189
 190 static StgTSO *threadStackOverflow(StgTSO *tso);
 191
 192 /* KH: The following two flags are shared memory locations.  There is no need
 193        to lock them, since they are only unset at the end of a scheduler
 194        operation.
 195 */
 196
 197 /* flag set by signal handler to precipitate a context switch */
 198 //@cindex context_switch
 199 nat context_switch = 0;
 200
 201 /* if this flag is set as well, give up execution */
 202 //@cindex interrupted
 203 rtsBool interrupted = rtsFalse;
 204
 205 /* Next thread ID to allocate.
 206  * Locks required: thread_id_mutex
 207  */
 208 //@cindex next_thread_id
 209 static StgThreadID next_thread_id = 1;
 210
 211 /*
 212  * Pointers to the state of the current thread.
 213  * Rule of thumb: if CurrentTSO != NULL, then we're running a Haskell
 214  * thread.  If CurrentTSO == NULL, then we're at the scheduler level.
 215  */
 216
 217 /* The smallest stack size that makes any sense is:
 218  *    RESERVED_STACK_WORDS    (so we can get back from the stack overflow)
 219  *  + sizeofW(StgStopFrame)   (the stg_stop_thread_info frame)
 220  *  + 1                       (the realworld token for an IO thread)
 221  *  + 1                       (the closure to enter)
 222  *
 223  * A thread with this stack will bomb immediately with a stack
 224  * overflow, which will increase its stack size.
 225  */
 226
 227 #define MIN_STACK_WORDS (RESERVED_STACK_WORDS + sizeofW(StgStopFrame) + 2)
 228
 229
 230 #if defined(GRAN)
 231 StgTSO *CurrentTSO;
 232 #endif
 233
 234 /*  This is used in `TSO.h' and gcc 2.96 insists that this variable actually
 235  *  exists - earlier gccs apparently didn't.
 236  *  -= chak
 237  */
 238 StgTSO dummy_tso;
 239
 240 static rtsBool ready_to_gc;
 241
 242 /*
 243  * Set to TRUE when entering a shutdown state (via shutdownHaskellAndExit()) --
 244  * in an MT setting, needed to signal that a worker thread shouldn't hang around
 245  * in the scheduler when it is out of work.
 246  */
 247 static rtsBool shutting_down_scheduler = rtsFalse;
 248
 249 void            addToBlockedQueue ( StgTSO *tso );
 250
 251 static void     schedule          ( void );
 252        void     interruptStgRts   ( void );
 253
 254 static void     detectBlackHoles  ( void );
 255
 256 #ifdef DEBUG
 257 static void sched_belch(char *s, ...);
 258 #endif
 259
 260 #if defined(RTS_SUPPORTS_THREADS)
 261 /* ToDo: carefully document the invariants that go together
 262  *       with these synchronisation objects.
 263  */
 264 Mutex     sched_mutex       = INIT_MUTEX_VAR;
 265 Mutex     term_mutex        = INIT_MUTEX_VAR;
 266
 267 /*
 268  * A heavyweight solution to the problem of protecting
 269  * the thread_id from concurrent update.
 270  */
 271 Mutex     thread_id_mutex   = INIT_MUTEX_VAR;
 272
 273
 274 # if defined(SMP)
 275 static Condition gc_pending_cond = INIT_COND_VAR;
 276 nat await_death;
 277 # endif
 278
 279 #endif /* RTS_SUPPORTS_THREADS */
 280
 281 #if defined(PAR)
 282 StgTSO *LastTSO;
 283 rtsTime TimeOfLastYield;
 284 rtsBool emitSchedule = rtsTrue;
 285 #endif
 286
 287 #if DEBUG
 288 static char *whatNext_strs[] = {
 289   "ThreadRunGHC",
 290   "ThreadInterpret",
 291   "ThreadKilled",
 292   "ThreadRelocated",
 293   "ThreadComplete"
 294 };
 295 #endif
 296
 297 #if defined(PAR)
 298 StgTSO * createSparkThread(rtsSpark spark);
 299 StgTSO * activateSpark (rtsSpark spark);
 300 #endif
 301
 302 /*
 303  * The thread state for the main thread.
 304 // ToDo: check whether not needed any more
 305 StgTSO   *MainTSO;
 306  */
 307
 308 #if defined(PAR) || defined(RTS_SUPPORTS_THREADS)
 309 static void taskStart(void);
 310 static void
 311 taskStart(void)
 312 {
 313   schedule();
 314 }
 315 #endif
 316
 317 #if defined(RTS_SUPPORTS_THREADS)
 318 void
 319 startSchedulerTask(void)
 320 {
 321     startTask(taskStart);
 322 }
 323 #endif
 324
 325 //@node Main scheduling loop, Suspend and Resume, Prototypes, Main scheduling code
 326 //@subsection Main scheduling loop
 327
 328 /* ---------------------------------------------------------------------------
 329    Main scheduling loop.
 330
 331    We use round-robin scheduling, each thread returning to the
 332    scheduler loop when one of these conditions is detected:
 333
 334       * out of heap space
 335       * timer expires (thread yields)
 336       * thread blocks
 337       * thread ends
 338       * stack overflow
 339
 340    Locking notes:  we acquire the scheduler lock once at the beginning
 341    of the scheduler loop, and release it when
 342
 343       * running a thread, or
 344       * waiting for work, or
 345       * waiting for a GC to complete.
 346
 347    GRAN version:
 348      In a GranSim setup this loop iterates over the global event queue.
 349      This revolves around the global event queue, which determines what
 350      to do next. Therefore, it's more complicated than either the
 351      concurrent or the parallel (GUM) setup.
 352
 353    GUM version:
 354      GUM iterates over incoming messages.
 355      It starts with nothing to do (thus CurrentTSO == END_TSO_QUEUE),
 356      and sends out a fish whenever it has nothing to do; in-between
 357      doing the actual reductions (shared code below) it processes the
 358      incoming messages and deals with delayed operations
 359      (see PendingFetches).
 360      This is not the ugliest code you could imagine, but it's bloody close.
 361
 362    ------------------------------------------------------------------------ */
 363 //@cindex schedule
 364 static void
 365 schedule( void )
 366 {
 367   StgTSO *t;
 368   Capability *cap;
 369   StgThreadReturnCode ret;
 370 #if defined(GRAN)
 371   rtsEvent *event;
 372 #elif defined(PAR)
 373   StgSparkPool *pool;
 374   rtsSpark spark;
 375   StgTSO *tso;
 376   GlobalTaskId pe;
 377   rtsBool receivedFinish = rtsFalse;
 378 # if defined(DEBUG)
 379   nat tp_size, sp_size; // stats only
 380 # endif
 381 #endif
 382   rtsBool was_interrupted = rtsFalse;
 383   StgTSOWhatNext prev_what_next;
 384
 385   ACQUIRE_LOCK(&sched_mutex);
 386
 387 #if defined(RTS_SUPPORTS_THREADS)
 388   waitForWorkCapability(&sched_mutex, &cap, rtsFalse);
 389   IF_DEBUG(scheduler, sched_belch("worker thread (osthread %p): entering RTS", osThreadId()));
 390 #else
 391   /* simply initialise it in the non-threaded case */
 392   grabCapability(&cap);
 393 #endif
 394
 395 #if defined(GRAN)
 396   /* set up first event to get things going */
 397   /* ToDo: assign costs for system setup and init MainTSO ! */
 398   new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc],
 399             ContinueThread,
 400             CurrentTSO, (StgClosure*)NULL, (rtsSpark*)NULL);
 401
 402   IF_DEBUG(gran,
 403            fprintf(stderr, "GRAN: Init CurrentTSO (in schedule) = %p\n", CurrentTSO);
 404            G_TSO(CurrentTSO, 5));
 405
 406   if (RtsFlags.GranFlags.Light) {
 407     /* Save current time; GranSim Light only */
 408     CurrentTSO->gran.clock = CurrentTime[CurrentProc];
 409   }
 410
 411   event = get_next_event();
 412
 413   while (event!=(rtsEvent*)NULL) {
 414     /* Choose the processor with the next event */
 415     CurrentProc = event->proc;
 416     CurrentTSO = event->tso;
 417
 418 #elif defined(PAR)
 419
 420   while (!receivedFinish) {    /* set by processMessages */
 421                                /* when receiving PP_FINISH message         */
 422 #else
 423
 424   while (1) {
 425
 426 #endif
 427
 428     IF_DEBUG(scheduler, printAllThreads());
 429
 430 #if defined(RTS_SUPPORTS_THREADS)
 431     /* Check to see whether there are any worker threads
 432        waiting to deposit external call results. If so,
 433        yield our capability */
 434     yieldToReturningWorker(&sched_mutex, &cap);
 435 #endif
 436
 437     /* If we're interrupted (the user pressed ^C, or some other
 438      * termination condition occurred), kill all the currently running
 439      * threads.
 440      */
 441     if (interrupted) {
 442       IF_DEBUG(scheduler, sched_belch("interrupted"));
 443       interrupted = rtsFalse;
 444       was_interrupted = rtsTrue;
 445 #if defined(RTS_SUPPORTS_THREADS)
 446       // In the threaded RTS, deadlock detection doesn't work,
 447       // so just exit right away.
 448       prog_belch("interrupted");
 449       releaseCapability(cap);
 450       startTask(taskStart);     // thread-safe-call to shutdownHaskellAndExit
 451       RELEASE_LOCK(&sched_mutex);
 452       shutdownHaskellAndExit(EXIT_SUCCESS);
 453 #else
 454       deleteAllThreads();
 455 #endif
 456     }
 457
 458     /* Go through the list of main threads and wake up any
 459      * clients whose computations have finished.  ToDo: this
 460      * should be done more efficiently without a linear scan
 461      * of the main threads list, somehow...
 462      */
 463 #if defined(RTS_SUPPORTS_THREADS)
 464     {
 465       StgMainThread *m, **prev;
 466       prev = &main_threads;
 467       for (m = main_threads; m != NULL; prev = &m->link, m = m->link) {
 468         switch (m->tso->what_next) {
 469         case ThreadComplete:
 470           if (m->ret) {
 471               // NOTE: return val is tso->sp[1] (see StgStartup.hc)
 472               *(m->ret) = (StgClosure *)m->tso->sp[1];
 473           }
 474           *prev = m->link;
 475           m->stat = Success;
 476           broadcastCondition(&m->wakeup);
 477 #ifdef DEBUG
 478           removeThreadLabel((StgWord)m->tso);
 479 #endif
 480           if(m == main_main_thread)
 481           {
 482               releaseCapability(cap);
 483               startTask(taskStart);     // thread-safe-call to shutdownHaskellAndExit
 484               RELEASE_LOCK(&sched_mutex);
 485               shutdownHaskellAndExit(EXIT_SUCCESS);
 486           }
 487           break;
 488         case ThreadKilled:
 489           if (m->ret) *(m->ret) = NULL;
 490           *prev = m->link;
 491           if (was_interrupted) {
 492             m->stat = Interrupted;
 493           } else {
 494             m->stat = Killed;
 495           }
 496           broadcastCondition(&m->wakeup);
 497 #ifdef DEBUG
 498           removeThreadLabel((StgWord)m->tso);
 499 #endif
 500           if(m == main_main_thread)
 501           {
 502               releaseCapability(cap);
 503               startTask(taskStart);     // thread-safe-call to shutdownHaskellAndExit
 504               RELEASE_LOCK(&sched_mutex);
 505               shutdownHaskellAndExit(EXIT_SUCCESS);
 506           }
 507           break;
 508         default:
 509           break;
 510         }
 511       }
 512     }
 513
 514 #else /* not threaded */
 515
 516 # if defined(PAR)
 517     /* in GUM do this only on the Main PE */
 518     if (IAmMainThread)
 519 # endif
 520     /* If our main thread has finished or been killed, return.
 521      */
 522     {
 523       StgMainThread *m = main_threads;
 524       if (m->tso->what_next == ThreadComplete
 525           || m->tso->what_next == ThreadKilled) {
 526 #ifdef DEBUG
 527         removeThreadLabel((StgWord)m->tso);
 528 #endif
 529         main_threads = main_threads->link;
 530         if (m->tso->what_next == ThreadComplete) {
 531             // We finished successfully, fill in the return value
 532             // NOTE: return val is tso->sp[1] (see StgStartup.hc)
 533             if (m->ret) { *(m->ret) = (StgClosure *)m->tso->sp[1]; };
 534             m->stat = Success;
 535             return;
 536         } else {
 537           if (m->ret) { *(m->ret) = NULL; };
 538           if (was_interrupted) {
 539             m->stat = Interrupted;
 540           } else {
 541             m->stat = Killed;
 542           }
 543           return;
 544         }
 545       }
 546     }
 547 #endif
 548
 549     /* Top up the run queue from our spark pool.  We try to make the
 550      * number of threads in the run queue equal to the number of
 551      * free capabilities.
 552      *
 553      * Disable spark support in SMP for now, non-essential & requires
 554      * a little bit of work to make it compile cleanly. -- sof 1/02.
 555      */
 556 #if 0 /* defined(SMP) */
 557     {
 558       nat n = getFreeCapabilities();
 559       StgTSO *tso = run_queue_hd;
 560
 561       /* Count the run queue */
 562       while (n > 0 && tso != END_TSO_QUEUE) {
 563         tso = tso->link;
 564         n--;
 565       }
 566
 567       for (; n > 0; n--) {
 568         StgClosure *spark;
 569         spark = findSpark(rtsFalse);
 570         if (spark == NULL) {
 571           break; /* no more sparks in the pool */
 572         } else {
 573           /* I'd prefer this to be done in activateSpark -- HWL */
 574           /* tricky - it needs to hold the scheduler lock and
 575            * not try to re-acquire it -- SDM */
 576           createSparkThread(spark);
 577           IF_DEBUG(scheduler,
 578                    sched_belch("==^^ turning spark of closure %p into a thread",
 579                                (StgClosure *)spark));
 580         }
 581       }
 582       /* We need to wake up the other tasks if we just created some
 583        * work for them.
 584        */
 585       if (getFreeCapabilities() - n > 1) {
 586           signalCondition( &thread_ready_cond );
 587       }
 588     }
 589 #endif // SMP
 590
 591     /* check for signals each time around the scheduler */
 592 #if defined(RTS_USER_SIGNALS)
 593     if (signals_pending()) {
 594       RELEASE_LOCK(&sched_mutex); /* ToDo: kill */
 595       startSignalHandlers();
 596       ACQUIRE_LOCK(&sched_mutex);
 597     }
 598 #endif
 599
 600     /* Check whether any waiting threads need to be woken up.  If the
 601      * run queue is empty, and there are no other tasks running, we
 602      * can wait indefinitely for something to happen.
 603      */
 604     if ( !EMPTY_QUEUE(blocked_queue_hd) || !EMPTY_QUEUE(sleeping_queue)
 605 #if defined(RTS_SUPPORTS_THREADS) && !defined(SMP)
 606                 || EMPTY_RUN_QUEUE()
 607 #endif
 608         )
 609     {
 610       awaitEvent( EMPTY_RUN_QUEUE()
 611 #if defined(SMP)
 612         && allFreeCapabilities()
 613 #endif
 614         );
 615     }
 616     /* we can be interrupted while waiting for I/O... */
 617     if (interrupted) continue;
 618
 619     /*
 620      * Detect deadlock: when we have no threads to run, there are no
 621      * threads waiting on I/O or sleeping, and all the other tasks are
 622      * waiting for work, we must have a deadlock of some description.
 623      *
 624      * We first try to find threads blocked on themselves (ie. black
 625      * holes), and generate NonTermination exceptions where necessary.
 626      *
 627      * If no threads are black holed, we have a deadlock situation, so
 628      * inform all the main threads.
 629      */
 630 #if !defined(PAR) && !defined(RTS_SUPPORTS_THREADS)
 631     if (   EMPTY_THREAD_QUEUES()
 632 #if defined(RTS_SUPPORTS_THREADS)
 633         && EMPTY_QUEUE(suspended_ccalling_threads)
 634 #endif
 635 #ifdef SMP
 636         && allFreeCapabilities()
 637 #endif
 638         )
 639     {
 640         IF_DEBUG(scheduler, sched_belch("deadlocked, forcing major GC..."));
 641 #if defined(THREADED_RTS)
 642         /* and SMP mode ..? */
 643         releaseCapability(cap);
 644 #endif
 645         // Garbage collection can release some new threads due to
 646         // either (a) finalizers or (b) threads resurrected because
 647         // they are about to be send BlockedOnDeadMVar.  Any threads
 648         // thus released will be immediately runnable.
 649         GarbageCollect(GetRoots,rtsTrue);
 650
 651         if ( !EMPTY_RUN_QUEUE() ) { goto not_deadlocked; }
 652
 653         IF_DEBUG(scheduler,
 654                  sched_belch("still deadlocked, checking for black holes..."));
 655         detectBlackHoles();
 656
 657         if ( !EMPTY_RUN_QUEUE() ) { goto not_deadlocked; }
 658
 659 #if defined(RTS_USER_SIGNALS)
 660         /* If we have user-installed signal handlers, then wait
 661          * for signals to arrive rather then bombing out with a
 662          * deadlock.
 663          */
 664 #if defined(RTS_SUPPORTS_THREADS)
 665         if ( 0 ) { /* hmm..what to do? Simply stop waiting for
 666                       a signal with no runnable threads (or I/O
 667                       suspended ones) leads nowhere quick.
 668                       For now, simply shut down when we reach this
 669                       condition.
 670
 671                       ToDo: define precisely under what conditions
 672                       the Scheduler should shut down in an MT setting.
 673                    */
 674 #else
 675         if ( anyUserHandlers() ) {
 676 #endif
 677             IF_DEBUG(scheduler,
 678                      sched_belch("still deadlocked, waiting for signals..."));
 679
 680             awaitUserSignals();
 681
 682             // we might be interrupted...
 683             if (interrupted) { continue; }
 684
 685             if (signals_pending()) {
 686                 RELEASE_LOCK(&sched_mutex);
 687                 startSignalHandlers();
 688                 ACQUIRE_LOCK(&sched_mutex);
 689             }
 690             ASSERT(!EMPTY_RUN_QUEUE());
 691             goto not_deadlocked;
 692         }
 693 #endif
 694
 695         /* Probably a real deadlock.  Send the current main thread the
 696          * Deadlock exception (or in the SMP build, send *all* main
 697          * threads the deadlock exception, since none of them can make
 698          * progress).
 699          */
 700         {
 701             StgMainThread *m;
 702 #if defined(RTS_SUPPORTS_THREADS)
 703             for (m = main_threads; m != NULL; m = m->link) {
 704                 switch (m->tso->why_blocked) {
 705                 case BlockedOnBlackHole:
 706                     raiseAsync(m->tso, (StgClosure *)NonTermination_closure);
 707                     break;
 708                 case BlockedOnException:
 709                 case BlockedOnMVar:
 710                     raiseAsync(m->tso, (StgClosure *)Deadlock_closure);
 711                     break;
 712                 default:
 713                     barf("deadlock: main thread blocked in a strange way");
 714                 }
 715             }
 716 #else
 717             m = main_threads;
 718             switch (m->tso->why_blocked) {
 719             case BlockedOnBlackHole:
 720                 raiseAsync(m->tso, (StgClosure *)NonTermination_closure);
 721                 break;
 722             case BlockedOnException:
 723             case BlockedOnMVar:
 724                 raiseAsync(m->tso, (StgClosure *)Deadlock_closure);
 725                 break;
 726             default:
 727                 barf("deadlock: main thread blocked in a strange way");
 728             }
 729 #endif
 730         }
 731
 732 #if defined(RTS_SUPPORTS_THREADS)
 733         /* ToDo: revisit conditions (and mechanism) for shutting
 734            down a multi-threaded world  */
 735         IF_DEBUG(scheduler, sched_belch("all done, i think...shutting down."));
 736         RELEASE_LOCK(&sched_mutex);
 737         shutdownHaskell();
 738         return;
 739 #endif
 740     }
 741   not_deadlocked:
 742
 743 #elif defined(RTS_SUPPORTS_THREADS)
 744     /* ToDo: add deadlock detection in threaded RTS */
 745 #elif defined(PAR)
 746     /* ToDo: add deadlock detection in GUM (similar to SMP) -- HWL */
 747 #endif
 748
 749 #if defined(SMP)
 750     /* If there's a GC pending, don't do anything until it has
 751      * completed.
 752      */
 753     if (ready_to_gc) {
 754       IF_DEBUG(scheduler,sched_belch("waiting for GC"));
 755       waitCondition( &gc_pending_cond, &sched_mutex );
 756     }
 757 #endif
 758
 759 #if defined(RTS_SUPPORTS_THREADS)
 760 #if defined(SMP)
 761     /* block until we've got a thread on the run queue and a free
 762      * capability.
 763      *
 764      */
 765     if ( EMPTY_RUN_QUEUE() ) {
 766       /* Give up our capability */
 767       releaseCapability(cap);
 768
 769       /* If we're in the process of shutting down (& running the
 770        * a batch of finalisers), don't wait around.
 771        */
 772       if ( shutting_down_scheduler ) {
 773         RELEASE_LOCK(&sched_mutex);
 774         return;
 775       }
 776       IF_DEBUG(scheduler, sched_belch("thread %d: waiting for work", osThreadId()));
 777       waitForWorkCapability(&sched_mutex, &cap, rtsTrue);
 778       IF_DEBUG(scheduler, sched_belch("thread %d: work now available", osThreadId()));
 779     }
 780 #else
 781     if ( EMPTY_RUN_QUEUE() ) {
 782       continue; // nothing to do
 783     }
 784 #endif
 785 #endif
 786
 787 #if defined(GRAN)
 788     if (RtsFlags.GranFlags.Light)
 789       GranSimLight_enter_system(event, &ActiveTSO); // adjust ActiveTSO etc
 790
 791     /* adjust time based on time-stamp */
 792     if (event->time > CurrentTime[CurrentProc] &&
 793         event->evttype != ContinueThread)
 794       CurrentTime[CurrentProc] = event->time;
 795
 796     /* Deal with the idle PEs (may issue FindWork or MoveSpark events) */
 797     if (!RtsFlags.GranFlags.Light)
 798       handleIdlePEs();
 799
 800     IF_DEBUG(gran, fprintf(stderr, "GRAN: switch by event-type\n"));
 801
 802     /* main event dispatcher in GranSim */
 803     switch (event->evttype) {
 804       /* Should just be continuing execution */
 805     case ContinueThread:
 806       IF_DEBUG(gran, fprintf(stderr, "GRAN: doing ContinueThread\n"));
 807       /* ToDo: check assertion
 808       ASSERT(run_queue_hd != (StgTSO*)NULL &&
 809              run_queue_hd != END_TSO_QUEUE);
 810       */
 811       /* Ignore ContinueThreads for fetching threads (if synchr comm) */
 812       if (!RtsFlags.GranFlags.DoAsyncFetch &&
 813           procStatus[CurrentProc]==Fetching) {
 814         belch("ghuH: Spurious ContinueThread while Fetching ignored; TSO %d (%p) [PE %d]",
 815               CurrentTSO->id, CurrentTSO, CurrentProc);
 816         goto next_thread;
 817       }
 818       /* Ignore ContinueThreads for completed threads */
 819       if (CurrentTSO->what_next == ThreadComplete) {
 820         belch("ghuH: found a ContinueThread event for completed thread %d (%p) [PE %d] (ignoring ContinueThread)",
 821               CurrentTSO->id, CurrentTSO, CurrentProc);
 822         goto next_thread;
 823       }
 824       /* Ignore ContinueThreads for threads that are being migrated */
 825       if (PROCS(CurrentTSO)==Nowhere) {
 826         belch("ghuH: trying to run the migrating TSO %d (%p) [PE %d] (ignoring ContinueThread)",
 827               CurrentTSO->id, CurrentTSO, CurrentProc);
 828         goto next_thread;
 829       }
 830       /* The thread should be at the beginning of the run queue */
 831       if (CurrentTSO!=run_queue_hds[CurrentProc]) {
 832         belch("ghuH: TSO %d (%p) [PE %d] is not at the start of the run_queue when doing a ContinueThread",
 833               CurrentTSO->id, CurrentTSO, CurrentProc);
 834         break; // run the thread anyway
 835       }
 836       /*
 837       new_event(proc, proc, CurrentTime[proc],
 838                 FindWork,
 839                 (StgTSO*)NULL, (StgClosure*)NULL, (rtsSpark*)NULL);
 840       goto next_thread;
 841       */ /* Catches superfluous CONTINUEs -- should be unnecessary */
 842       break; // now actually run the thread; DaH Qu'vam yImuHbej
 843
 844     case FetchNode:
 845       do_the_fetchnode(event);
 846       goto next_thread;             /* handle next event in event queue  */
 847
 848     case GlobalBlock:
 849       do_the_globalblock(event);
 850       goto next_thread;             /* handle next event in event queue  */
 851
 852     case FetchReply:
 853       do_the_fetchreply(event);
 854       goto next_thread;             /* handle next event in event queue  */
 855
 856     case UnblockThread:   /* Move from the blocked queue to the tail of */
 857       do_the_unblock(event);
 858       goto next_thread;             /* handle next event in event queue  */
 859
 860     case ResumeThread:  /* Move from the blocked queue to the tail of */
 861       /* the runnable queue ( i.e. Qu' SImqa'lu') */
 862       event->tso->gran.blocktime +=
 863         CurrentTime[CurrentProc] - event->tso->gran.blockedat;
 864       do_the_startthread(event);
 865       goto next_thread;             /* handle next event in event queue  */
 866
 867     case StartThread:
 868       do_the_startthread(event);
 869       goto next_thread;             /* handle next event in event queue  */
 870
 871     case MoveThread:
 872       do_the_movethread(event);
 873       goto next_thread;             /* handle next event in event queue  */
 874
 875     case MoveSpark:
 876       do_the_movespark(event);
 877       goto next_thread;             /* handle next event in event queue  */
 878
 879     case FindWork:
 880       do_the_findwork(event);
 881       goto next_thread;             /* handle next event in event queue  */
 882
 883     default:
 884       barf("Illegal event type %u\n", event->evttype);
 885     }  /* switch */
 886
 887     /* This point was scheduler_loop in the old RTS */
 888
 889     IF_DEBUG(gran, belch("GRAN: after main switch"));
 890
 891     TimeOfLastEvent = CurrentTime[CurrentProc];
 892     TimeOfNextEvent = get_time_of_next_event();
 893     IgnoreEvents=(TimeOfNextEvent==0); // HWL HACK
 894     // CurrentTSO = ThreadQueueHd;
 895
 896     IF_DEBUG(gran, belch("GRAN: time of next event is: %ld",
 897                          TimeOfNextEvent));
 898
 899     if (RtsFlags.GranFlags.Light)
 900       GranSimLight_leave_system(event, &ActiveTSO);
 901
 902     EndOfTimeSlice = CurrentTime[CurrentProc]+RtsFlags.GranFlags.time_slice;
 903
 904     IF_DEBUG(gran,
 905              belch("GRAN: end of time-slice is %#lx", EndOfTimeSlice));
 906
 907     /* in a GranSim setup the TSO stays on the run queue */
 908     t = CurrentTSO;
 909     /* Take a thread from the run queue. */
 910     t = POP_RUN_QUEUE(); // take_off_run_queue(t);
 911
 912     IF_DEBUG(gran,
 913              fprintf(stderr, "GRAN: About to run current thread, which is\n");
 914              G_TSO(t,5));
 915
 916     context_switch = 0; // turned on via GranYield, checking events and time slice
 917
 918     IF_DEBUG(gran,
 919              DumpGranEvent(GR_SCHEDULE, t));
 920
 921     procStatus[CurrentProc] = Busy;
 922
 923 #elif defined(PAR)
 924     if (PendingFetches != END_BF_QUEUE) {
 925         processFetches();
 926     }
 927
 928     /* ToDo: phps merge with spark activation above */
 929     /* check whether we have local work and send requests if we have none */
 930     if (EMPTY_RUN_QUEUE()) {  /* no runnable threads */
 931       /* :-[  no local threads => look out for local sparks */
 932       /* the spark pool for the current PE */
 933       pool = &(MainRegTable.rSparks); // generalise to cap = &MainRegTable
 934       if (advisory_thread_count < RtsFlags.ParFlags.maxThreads &&
 935           pool->hd < pool->tl) {
 936         /*
 937          * ToDo: add GC code check that we really have enough heap afterwards!!
 938          * Old comment:
 939          * If we're here (no runnable threads) and we have pending
 940          * sparks, we must have a space problem.  Get enough space
 941          * to turn one of those pending sparks into a
 942          * thread...
 943          */
 944
 945         spark = findSpark(rtsFalse);                /* get a spark */
 946         if (spark != (rtsSpark) NULL) {
 947           tso = activateSpark(spark);       /* turn the spark into a thread */
 948           IF_PAR_DEBUG(schedule,
 949                        belch("==== schedule: Created TSO %d (%p); %d threads active",
 950                              tso->id, tso, advisory_thread_count));
 951
 952           if (tso==END_TSO_QUEUE) { /* failed to activate spark->back to loop */
 953             belch("==^^ failed to activate spark");
 954             goto next_thread;
 955           }               /* otherwise fall through & pick-up new tso */
 956         } else {
 957           IF_PAR_DEBUG(verbose,
 958                        belch("==^^ no local sparks (spark pool contains only NFs: %d)",
 959                              spark_queue_len(pool)));
 960           goto next_thread;
 961         }
 962       }
 963
 964       /* If we still have no work we need to send a FISH to get a spark
 965          from another PE
 966       */
 967       if (EMPTY_RUN_QUEUE()) {
 968       /* =8-[  no local sparks => look for work on other PEs */
 969         /*
 970          * We really have absolutely no work.  Send out a fish
 971          * (there may be some out there already), and wait for
 972          * something to arrive.  We clearly can't run any threads
 973          * until a SCHEDULE or RESUME arrives, and so that's what
 974          * we're hoping to see.  (Of course, we still have to
 975          * respond to other types of messages.)
 976          */
 977         TIME now = msTime() /*CURRENT_TIME*/;
 978         IF_PAR_DEBUG(verbose,
 979                      belch("--  now=%ld", now));
 980         IF_PAR_DEBUG(verbose,
 981                      if (outstandingFishes < RtsFlags.ParFlags.maxFishes &&
 982                          (last_fish_arrived_at!=0 &&
 983                           last_fish_arrived_at+RtsFlags.ParFlags.fishDelay > now)) {
 984                        belch("--$$ delaying FISH until %ld (last fish %ld, delay %ld, now %ld)",
 985                              last_fish_arrived_at+RtsFlags.ParFlags.fishDelay,
 986                              last_fish_arrived_at,
 987                              RtsFlags.ParFlags.fishDelay, now);
 988                      });
 989
 990         if (outstandingFishes < RtsFlags.ParFlags.maxFishes &&
 991             (last_fish_arrived_at==0 ||
 992              (last_fish_arrived_at+RtsFlags.ParFlags.fishDelay <= now))) {
 993           /* outstandingFishes is set in sendFish, processFish;
 994              avoid flooding system with fishes via delay */
 995           pe = choosePE();
 996           sendFish(pe, mytid, NEW_FISH_AGE, NEW_FISH_HISTORY,
 997                    NEW_FISH_HUNGER);
 998
 999           // Global statistics: count no. of fishes
1000           if (RtsFlags.ParFlags.ParStats.Global &&
1001               RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
1002             globalParStats.tot_fish_mess++;
1003           }
1004         }
1005
1006         receivedFinish = processMessages();
1007         goto next_thread;
1008       }
1009     } else if (PacketsWaiting()) {  /* Look for incoming messages */
1010       receivedFinish = processMessages();
1011     }
1012
1013     /* Now we are sure that we have some work available */
1014     ASSERT(run_queue_hd != END_TSO_QUEUE);
1015
1016     /* Take a thread from the run queue, if we have work */
1017     t = POP_RUN_QUEUE();  // take_off_run_queue(END_TSO_QUEUE);
1018     IF_DEBUG(sanity,checkTSO(t));
1019
1020     /* ToDo: write something to the log-file
1021     if (RTSflags.ParFlags.granSimStats && !sameThread)
1022         DumpGranEvent(GR_SCHEDULE, RunnableThreadsHd);
1023
1024     CurrentTSO = t;
1025     */
1026     /* the spark pool for the current PE */
1027     pool = &(MainRegTable.rSparks); // generalise to cap = &MainRegTable
1028
1029     IF_DEBUG(scheduler,
1030              belch("--=^ %d threads, %d sparks on [%#x]",
1031                    run_queue_len(), spark_queue_len(pool), CURRENT_PROC));
1032
1033 # if 1
1034     if (0 && RtsFlags.ParFlags.ParStats.Full &&
1035         t && LastTSO && t->id != LastTSO->id &&
1036         LastTSO->why_blocked == NotBlocked &&
1037         LastTSO->what_next != ThreadComplete) {
1038       // if previously scheduled TSO not blocked we have to record the context switch
1039       DumpVeryRawGranEvent(TimeOfLastYield, CURRENT_PROC, CURRENT_PROC,
1040                            GR_DESCHEDULE, LastTSO, (StgClosure *)NULL, 0, 0);
1041     }
1042
1043     if (RtsFlags.ParFlags.ParStats.Full &&
1044         (emitSchedule /* forced emit */ ||
1045         (t && LastTSO && t->id != LastTSO->id))) {
1046       /*
1047          we are running a different TSO, so write a schedule event to log file
1048          NB: If we use fair scheduling we also have to write  a deschedule
1049              event for LastTSO; with unfair scheduling we know that the
1050              previous tso has blocked whenever we switch to another tso, so
1051              we don't need it in GUM for now
1052       */
1053       DumpRawGranEvent(CURRENT_PROC, CURRENT_PROC,
1054                        GR_SCHEDULE, t, (StgClosure *)NULL, 0, 0);
1055       emitSchedule = rtsFalse;
1056     }
1057
1058 # endif
1059 #else /* !GRAN && !PAR */
1060
1061     /* grab a thread from the run queue */
1062     ASSERT(run_queue_hd != END_TSO_QUEUE);
1063     t = POP_RUN_QUEUE();
1064     // Sanity check the thread we're about to run.  This can be
1065     // expensive if there is lots of thread switching going on...
1066     IF_DEBUG(sanity,checkTSO(t));
1067 #endif
1068
1069     cap->r.rCurrentTSO = t;
1070
1071     /* context switches are now initiated by the timer signal, unless
1072      * the user specified "context switch as often as possible", with
1073      * +RTS -C0
1074      */
1075     if ((RtsFlags.ConcFlags.ctxtSwitchTicks == 0
1076          && (run_queue_hd != END_TSO_QUEUE
1077              || blocked_queue_hd != END_TSO_QUEUE
1078              || sleeping_queue != END_TSO_QUEUE)))
1079         context_switch = 1;
1080     else
1081         context_switch = 0;
1082
1083 run_thread:
1084
1085     RELEASE_LOCK(&sched_mutex);
1086
1087     IF_DEBUG(scheduler, sched_belch("-->> running thread %ld %s ...",
1088                               t->id, whatNext_strs[t->what_next]));
1089
1090 #ifdef PROFILING
1091     startHeapProfTimer();
1092 #endif
1093
1094     /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
1095     /* Run the current thread
1096      */
1097     prev_what_next = t->what_next;
1098     switch (prev_what_next) {
1099     case ThreadKilled:
1100     case ThreadComplete:
1101         /* Thread already finished, return to scheduler. */
1102         ret = ThreadFinished;
1103         break;
1104     case ThreadRunGHC:
1105         ret = StgRun((StgFunPtr) stg_returnToStackTop, &cap->r);
1106         break;
1107     case ThreadInterpret:
1108         ret = interpretBCO(cap);
1109         break;
1110     default:
1111       barf("schedule: invalid what_next field");
1112     }
1113     /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
1114
1115     /* Costs for the scheduler are assigned to CCS_SYSTEM */
1116 #ifdef PROFILING
1117     stopHeapProfTimer();
1118     CCCS = CCS_SYSTEM;
1119 #endif
1120
1121     ACQUIRE_LOCK(&sched_mutex);
1122
1123 #ifdef RTS_SUPPORTS_THREADS
1124     IF_DEBUG(scheduler,fprintf(stderr,"scheduler (task %ld): ", osThreadId()););
1125 #elif !defined(GRAN) && !defined(PAR)
1126     IF_DEBUG(scheduler,fprintf(stderr,"scheduler: "););
1127 #endif
1128     t = cap->r.rCurrentTSO;
1129
1130 #if defined(PAR)
1131     /* HACK 675: if the last thread didn't yield, make sure to print a
1132        SCHEDULE event to the log file when StgRunning the next thread, even
1133        if it is the same one as before */
1134     LastTSO = t;
1135     TimeOfLastYield = CURRENT_TIME;
1136 #endif
1137
1138     switch (ret) {
1139     case HeapOverflow:
1140 #if defined(GRAN)
1141       IF_DEBUG(gran, DumpGranEvent(GR_DESCHEDULE, t));
1142       globalGranStats.tot_heapover++;
1143 #elif defined(PAR)
1144       globalParStats.tot_heapover++;
1145 #endif
1146
1147       // did the task ask for a large block?
1148       if (cap->r.rHpAlloc > BLOCK_SIZE_W) {
1149           // if so, get one and push it on the front of the nursery.
1150           bdescr *bd;
1151           nat blocks;
1152
1153           blocks = (nat)BLOCK_ROUND_UP(cap->r.rHpAlloc * sizeof(W_)) / BLOCK_SIZE;
1154
1155           IF_DEBUG(scheduler,belch("--<< thread %ld (%s) stopped: requesting a large block (size %d)",
1156                                    t->id, whatNext_strs[t->what_next], blocks));
1157
1158           // don't do this if it would push us over the
1159           // alloc_blocks_lim limit; we'll GC first.
1160           if (alloc_blocks + blocks < alloc_blocks_lim) {
1161
1162               alloc_blocks += blocks;
1163               bd = allocGroup( blocks );
1164
1165               // link the new group into the list
1166               bd->link = cap->r.rCurrentNursery;
1167               bd->u.back = cap->r.rCurrentNursery->u.back;
1168               if (cap->r.rCurrentNursery->u.back != NULL) {
1169                   cap->r.rCurrentNursery->u.back->link = bd;
1170               } else {
1171                   ASSERT(g0s0->blocks == cap->r.rCurrentNursery &&
1172                          g0s0->blocks == cap->r.rNursery);
1173                   cap->r.rNursery = g0s0->blocks = bd;
1174               }
1175               cap->r.rCurrentNursery->u.back = bd;
1176
1177               // initialise it as a nursery block.  We initialise the
1178               // step, gen_no, and flags field of *every* sub-block in
1179               // this large block, because this is easier than making
1180               // sure that we always find the block head of a large
1181               // block whenever we call Bdescr() (eg. evacuate() and
1182               // isAlive() in the GC would both have to do this, at
1183               // least).
1184               {
1185                   bdescr *x;
1186                   for (x = bd; x < bd + blocks; x++) {
1187                       x->step = g0s0;
1188                       x->gen_no = 0;
1189                       x->flags = 0;
1190                   }
1191               }
1192
1193               // don't forget to update the block count in g0s0.
1194               g0s0->n_blocks += blocks;
1195               // This assert can be a killer if the app is doing lots
1196               // of large block allocations.
1197               ASSERT(countBlocks(g0s0->blocks) == g0s0->n_blocks);
1198
1199               // now update the nursery to point to the new block
1200               cap->r.rCurrentNursery = bd;
1201
1202               // we might be unlucky and have another thread get on the
1203               // run queue before us and steal the large block, but in that
1204               // case the thread will just end up requesting another large
1205               // block.
1206               PUSH_ON_RUN_QUEUE(t);
1207               break;
1208           }
1209       }
1210
1211       /* make all the running tasks block on a condition variable,
1212        * maybe set context_switch and wait till they all pile in,
1213        * then have them wait on a GC condition variable.
1214        */
1215       IF_DEBUG(scheduler,belch("--<< thread %ld (%s) stopped: HeapOverflow",
1216                                t->id, whatNext_strs[t->what_next]));
1217       threadPaused(t);
1218 #if defined(GRAN)
1219       ASSERT(!is_on_queue(t,CurrentProc));
1220 #elif defined(PAR)
1221       /* Currently we emit a DESCHEDULE event before GC in GUM.
1222          ToDo: either add separate event to distinguish SYSTEM time from rest
1223                or just nuke this DESCHEDULE (and the following SCHEDULE) */
1224       if (0 && RtsFlags.ParFlags.ParStats.Full) {
1225         DumpRawGranEvent(CURRENT_PROC, CURRENT_PROC,
1226                          GR_DESCHEDULE, t, (StgClosure *)NULL, 0, 0);
1227         emitSchedule = rtsTrue;
1228       }
1229 #endif
1230
1231       ready_to_gc = rtsTrue;
1232       context_switch = 1;               /* stop other threads ASAP */
1233       PUSH_ON_RUN_QUEUE(t);
1234       /* actual GC is done at the end of the while loop */
1235       break;
1236
1237     case StackOverflow:
1238 #if defined(GRAN)
1239       IF_DEBUG(gran,
1240                DumpGranEvent(GR_DESCHEDULE, t));
1241       globalGranStats.tot_stackover++;
1242 #elif defined(PAR)
1243       // IF_DEBUG(par,
1244       // DumpGranEvent(GR_DESCHEDULE, t);
1245       globalParStats.tot_stackover++;
1246 #endif
1247       IF_DEBUG(scheduler,belch("--<< thread %ld (%s) stopped, StackOverflow",
1248                                t->id, whatNext_strs[t->what_next]));
1249       /* just adjust the stack for this thread, then pop it back
1250        * on the run queue.
1251        */
1252       threadPaused(t);
1253       {
1254         StgMainThread *m;
1255         /* enlarge the stack */
1256         StgTSO *new_t = threadStackOverflow(t);
1257
1258         /* This TSO has moved, so update any pointers to it from the
1259          * main thread stack.  It better not be on any other queues...
1260          * (it shouldn't be).
1261          */
1262         for (m = main_threads; m != NULL; m = m->link) {
1263           if (m->tso == t) {
1264             m->tso = new_t;
1265           }
1266         }
1267         threadPaused(new_t);
1268         PUSH_ON_RUN_QUEUE(new_t);
1269       }
1270       break;
1271
1272     case ThreadYielding:
1273 #if defined(GRAN)
1274       IF_DEBUG(gran,
1275                DumpGranEvent(GR_DESCHEDULE, t));
1276       globalGranStats.tot_yields++;
1277 #elif defined(PAR)
1278       // IF_DEBUG(par,
1279       // DumpGranEvent(GR_DESCHEDULE, t);
1280       globalParStats.tot_yields++;
1281 #endif
1282       /* put the thread back on the run queue.  Then, if we're ready to
1283        * GC, check whether this is the last task to stop.  If so, wake
1284        * up the GC thread.  getThread will block during a GC until the
1285        * GC is finished.
1286        */
1287       IF_DEBUG(scheduler,
1288                if (t->what_next != prev_what_next) {
1289                    belch("--<< thread %ld (%s) stopped to switch evaluators",
1290                          t->id, whatNext_strs[t->what_next]);
1291                } else {
1292                    belch("--<< thread %ld (%s) stopped, yielding",
1293                          t->id, whatNext_strs[t->what_next]);
1294                }
1295                );
1296
1297       IF_DEBUG(sanity,
1298                //belch("&& Doing sanity check on yielding TSO %ld.", t->id);
1299                checkTSO(t));
1300       ASSERT(t->link == END_TSO_QUEUE);
1301
1302       // Shortcut if we're just switching evaluators: don't bother
1303       // doing stack squeezing (which can be expensive), just run the
1304       // thread.
1305       if (t->what_next != prev_what_next) {
1306           goto run_thread;
1307       }
1308
1309       threadPaused(t);
1310
1311 #if defined(GRAN)
1312       ASSERT(!is_on_queue(t,CurrentProc));
1313
1314       IF_DEBUG(sanity,
1315                //belch("&& Doing sanity check on all ThreadQueues (and their TSOs).");
1316                checkThreadQsSanity(rtsTrue));
1317 #endif
1318
1319 #if defined(PAR)
1320       if (RtsFlags.ParFlags.doFairScheduling) {
1321         /* this does round-robin scheduling; good for concurrency */
1322         APPEND_TO_RUN_QUEUE(t);
1323       } else {
1324         /* this does unfair scheduling; good for parallelism */
1325         PUSH_ON_RUN_QUEUE(t);
1326       }
1327 #else
1328       // this does round-robin scheduling; good for concurrency
1329       APPEND_TO_RUN_QUEUE(t);
1330 #endif
1331
1332 #if defined(GRAN)
1333       /* add a ContinueThread event to actually process the thread */
1334       new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc],
1335                 ContinueThread,
1336                 t, (StgClosure*)NULL, (rtsSpark*)NULL);
1337       IF_GRAN_DEBUG(bq,
1338                belch("GRAN: eventq and runnableq after adding yielded thread to queue again:");
1339                G_EVENTQ(0);
1340                G_CURR_THREADQ(0));
1341 #endif /* GRAN */
1342       break;
1343
1344     case ThreadBlocked:
1345 #if defined(GRAN)
1346       IF_DEBUG(scheduler,
1347                belch("--<< thread %ld (%p; %s) stopped, blocking on node %p [PE %d] with BQ: ",
1348                                t->id, t, whatNext_strs[t->what_next], t->block_info.closure, (t->block_info.closure==(StgClosure*)NULL ? 99 : where_is(t->block_info.closure)));
1349                if (t->block_info.closure!=(StgClosure*)NULL) print_bq(t->block_info.closure));
1350
1351       // ??? needed; should emit block before
1352       IF_DEBUG(gran,
1353                DumpGranEvent(GR_DESCHEDULE, t));
1354       prune_eventq(t, (StgClosure *)NULL); // prune ContinueThreads for t
1355       /*
1356         ngoq Dogh!
1357       ASSERT(procStatus[CurrentProc]==Busy ||
1358               ((procStatus[CurrentProc]==Fetching) &&
1359               (t->block_info.closure!=(StgClosure*)NULL)));
1360       if (run_queue_hds[CurrentProc] == END_TSO_QUEUE &&
1361           !(!RtsFlags.GranFlags.DoAsyncFetch &&
1362             procStatus[CurrentProc]==Fetching))
1363         procStatus[CurrentProc] = Idle;
1364       */
1365 #elif defined(PAR)
1366       IF_DEBUG(scheduler,
1367                belch("--<< thread %ld (%p; %s) stopped, blocking on node %p with BQ: ",
1368                      t->id, t, whatNext_strs[t->what_next], t->block_info.closure));
1369       IF_PAR_DEBUG(bq,
1370
1371                    if (t->block_info.closure!=(StgClosure*)NULL)
1372                      print_bq(t->block_info.closure));
1373
1374       /* Send a fetch (if BlockedOnGA) and dump event to log file */
1375       blockThread(t);
1376
1377       /* whatever we schedule next, we must log that schedule */
1378       emitSchedule = rtsTrue;
1379
1380 #else /* !GRAN */
1381       /* don't need to do anything.  Either the thread is blocked on
1382        * I/O, in which case we'll have called addToBlockedQueue
1383        * previously, or it's blocked on an MVar or Blackhole, in which
1384        * case it'll be on the relevant queue already.
1385        */
1386       IF_DEBUG(scheduler,
1387                fprintf(stderr, "--<< thread %d (%s) stopped: ",
1388                        t->id, whatNext_strs[t->what_next]);
1389                printThreadBlockage(t);
1390                fprintf(stderr, "\n"));
1391
1392       /* Only for dumping event to log file
1393          ToDo: do I need this in GranSim, too?
1394       blockThread(t);
1395       */
1396 #endif
1397       threadPaused(t);
1398       break;
1399
1400     case ThreadFinished:
1401       /* Need to check whether this was a main thread, and if so, signal
1402        * the task that started it with the return value.  If we have no
1403        * more main threads, we probably need to stop all the tasks until
1404        * we get a new one.
1405        */
1406       /* We also end up here if the thread kills itself with an
1407        * uncaught exception, see Exception.hc.
1408        */
1409       IF_DEBUG(scheduler,belch("--++ thread %d (%s) finished",
1410                                t->id, whatNext_strs[t->what_next]));
1411 #if defined(GRAN)
1412       endThread(t, CurrentProc); // clean-up the thread
1413 #elif defined(PAR)
1414       /* For now all are advisory -- HWL */
1415       //if(t->priority==AdvisoryPriority) ??
1416       advisory_thread_count--;
1417
1418 # ifdef DIST
1419       if(t->dist.priority==RevalPriority)
1420         FinishReval(t);
1421 # endif
1422
1423       if (RtsFlags.ParFlags.ParStats.Full &&
1424           !RtsFlags.ParFlags.ParStats.Suppressed)
1425         DumpEndEvent(CURRENT_PROC, t, rtsFalse /* not mandatory */);
1426 #endif
1427       break;
1428
1429     default:
1430       barf("schedule: invalid thread return code %d", (int)ret);
1431     }
1432
1433 #ifdef PROFILING
1434     // When we have +RTS -i0 and we're heap profiling, do a census at
1435     // every GC.  This lets us get repeatable runs for debugging.
1436     if (performHeapProfile ||
1437         (RtsFlags.ProfFlags.profileInterval==0 &&
1438          RtsFlags.ProfFlags.doHeapProfile && ready_to_gc)) {
1439         GarbageCollect(GetRoots, rtsTrue);
1440         heapCensus();
1441         performHeapProfile = rtsFalse;
1442         ready_to_gc = rtsFalse; // we already GC'd
1443     }
1444 #endif
1445
1446     if (ready_to_gc
1447 #ifdef SMP
1448         && allFreeCapabilities()
1449 #endif
1450         ) {
1451       /* everybody back, start the GC.
1452        * Could do it in this thread, or signal a condition var
1453        * to do it in another thread.  Either way, we need to
1454        * broadcast on gc_pending_cond afterward.
1455        */
1456 #if defined(RTS_SUPPORTS_THREADS)
1457       IF_DEBUG(scheduler,sched_belch("doing GC"));
1458 #endif
1459       GarbageCollect(GetRoots,rtsFalse);
1460       ready_to_gc = rtsFalse;
1461 #ifdef SMP
1462       broadcastCondition(&gc_pending_cond);
1463 #endif
1464 #if defined(GRAN)
1465       /* add a ContinueThread event to continue execution of current thread */
1466       new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc],
1467                 ContinueThread,
1468                 t, (StgClosure*)NULL, (rtsSpark*)NULL);
1469       IF_GRAN_DEBUG(bq,
1470                fprintf(stderr, "GRAN: eventq and runnableq after Garbage collection:\n");
1471                G_EVENTQ(0);
1472                G_CURR_THREADQ(0));
1473 #endif /* GRAN */
1474     }
1475
1476 #if defined(GRAN)
1477   next_thread:
1478     IF_GRAN_DEBUG(unused,
1479                   print_eventq(EventHd));
1480
1481     event = get_next_event();
1482 #elif defined(PAR)
1483   next_thread:
1484     /* ToDo: wait for next message to arrive rather than busy wait */
1485 #endif /* GRAN */
1486
1487   } /* end of while(1) */
1488
1489   IF_PAR_DEBUG(verbose,
1490                belch("== Leaving schedule() after having received Finish"));
1491 }
1492
1493 /* ---------------------------------------------------------------------------
1494  * Singleton fork(). Do not copy any running threads.
1495  * ------------------------------------------------------------------------- */
1496
1497 StgInt forkProcess(StgTSO* tso) {
1498
1499 #ifndef mingw32_TARGET_OS
1500   pid_t pid;
1501   StgTSO* t,*next;
1502   StgMainThread *m;
1503   rtsBool doKill;
1504
1505   IF_DEBUG(scheduler,sched_belch("forking!"));
1506
1507   pid = fork();
1508   if (pid) { /* parent */
1509
1510   /* just return the pid */
1511
1512   } else { /* child */
1513   /* wipe all other threads */
1514   run_queue_hd = run_queue_tl = tso;
1515   tso->link = END_TSO_QUEUE;
1516
1517   /* When clearing out the threads, we need to ensure
1518      that a 'main thread' is left behind; if there isn't,
1519      the Scheduler will shutdown next time it is entered.
1520
1521      ==> we don't kill a thread that's on the main_threads
1522          list (nor the current thread.)
1523
1524      [ Attempts at implementing the more ambitious scheme of
1525        killing the main_threads also, and then adding the
1526        current thread onto the main_threads list if it wasn't
1527        there already, failed -- waitThread() (for one) wasn't
1528        up to it. If it proves to be desirable to also kill
1529        the main threads, then this scheme will have to be
1530        revisited (and fully debugged!)
1531
1532        -- sof 7/2002
1533      ]
1534   */
1535   /* DO NOT TOUCH THE QUEUES directly because most of the code around
1536      us is picky about finding the thread still in its queue when
1537      handling the deleteThread() */
1538
1539   for (t = all_threads; t != END_TSO_QUEUE; t = next) {
1540     next = t->link;
1541
1542     /* Don't kill the current thread.. */
1543     if (t->id == tso->id) continue;
1544     doKill=rtsTrue;
1545     /* ..or a main thread */
1546     for (m = main_threads; m != NULL; m = m->link) {
1547         if (m->tso->id == t->id) {
1548           doKill=rtsFalse;
1549           break;
1550         }
1551     }
1552     if (doKill) {
1553       deleteThread(t);
1554     }
1555   }
1556   }
1557   return pid;
1558 #else /* mingw32 */
1559   barf("forkProcess#: primop not implemented for mingw32, sorry! (%u)\n", tso->id);
1560   /* pointlessly printing out the TSOs 'id' to avoid CC unused warning. */
1561   return -1;
1562 #endif /* mingw32 */
1563 }
1564
1565 /* ---------------------------------------------------------------------------
1566  * deleteAllThreads():  kill all the live threads.
1567  *
1568  * This is used when we catch a user interrupt (^C), before performing
1569  * any necessary cleanups and running finalizers.
1570  *
1571  * Locks: sched_mutex held.
1572  * ------------------------------------------------------------------------- */
1573
1574 void deleteAllThreads ( void )
1575 {
1576   StgTSO* t, *next;
1577   IF_DEBUG(scheduler,sched_belch("deleting all threads"));
1578   for (t = all_threads; t != END_TSO_QUEUE; t = next) {
1579       next = t->global_link;
1580       deleteThread(t);
1581   }
1582   run_queue_hd = run_queue_tl = END_TSO_QUEUE;
1583   blocked_queue_hd = blocked_queue_tl = END_TSO_QUEUE;
1584   sleeping_queue = END_TSO_QUEUE;
1585 }
1586
1587 /* startThread and  insertThread are now in GranSim.c -- HWL */
1588
1589
1590 //@node Suspend and Resume, Run queue code, Main scheduling loop, Main scheduling code
1591 //@subsection Suspend and Resume
1592
1593 /* ---------------------------------------------------------------------------
1594  * Suspending & resuming Haskell threads.
1595  *
1596  * When making a "safe" call to C (aka _ccall_GC), the task gives back
1597  * its capability before calling the C function.  This allows another
1598  * task to pick up the capability and carry on running Haskell
1599  * threads.  It also means that if the C call blocks, it won't lock
1600  * the whole system.
1601  *
1602  * The Haskell thread making the C call is put to sleep for the
1603  * duration of the call, on the susepended_ccalling_threads queue.  We
1604  * give out a token to the task, which it can use to resume the thread
1605  * on return from the C function.
1606  * ------------------------------------------------------------------------- */
1607
1608 StgInt
1609 suspendThread( StgRegTable *reg,
1610                rtsBool concCall
1611 #if !defined(RTS_SUPPORTS_THREADS) && !defined(DEBUG)
1612                STG_UNUSED
1613 #endif
1614                )
1615 {
1616   nat tok;
1617   Capability *cap;
1618
1619   /* assume that *reg is a pointer to the StgRegTable part
1620    * of a Capability.
1621    */
1622   cap = (Capability *)((void *)reg - sizeof(StgFunTable));
1623
1624   ACQUIRE_LOCK(&sched_mutex);
1625
1626   IF_DEBUG(scheduler,
1627            sched_belch("thread %d did a _ccall_gc (is_concurrent: %d)", cap->r.rCurrentTSO->id,concCall));
1628
1629   // XXX this might not be necessary --SDM
1630   cap->r.rCurrentTSO->what_next = ThreadRunGHC;
1631
1632   threadPaused(cap->r.rCurrentTSO);
1633   cap->r.rCurrentTSO->link = suspended_ccalling_threads;
1634   suspended_ccalling_threads = cap->r.rCurrentTSO;
1635
1636 #if defined(RTS_SUPPORTS_THREADS)
1637   if(cap->r.rCurrentTSO->blocked_exceptions == NULL)
1638   {
1639       cap->r.rCurrentTSO->why_blocked = BlockedOnCCall;
1640       cap->r.rCurrentTSO->blocked_exceptions = END_TSO_QUEUE;
1641   }
1642   else
1643   {
1644       cap->r.rCurrentTSO->why_blocked = BlockedOnCCall_NoUnblockExc;
1645   }
1646 #endif
1647
1648   /* Use the thread ID as the token; it should be unique */
1649   tok = cap->r.rCurrentTSO->id;
1650
1651   /* Hand back capability */
1652   releaseCapability(cap);
1653
1654 #if defined(RTS_SUPPORTS_THREADS)
1655   /* Preparing to leave the RTS, so ensure there's a native thread/task
1656      waiting to take over.
1657   */
1658   IF_DEBUG(scheduler, sched_belch("worker thread (%d, osthread %p): leaving RTS", tok, osThreadId()));
1659   //if (concCall) { // implementing "safe" as opposed to "threadsafe" is more difficult
1660       startTask(taskStart);
1661   //}
1662 #endif
1663
1664   /* Other threads _might_ be available for execution; signal this */
1665   THREAD_RUNNABLE();
1666   RELEASE_LOCK(&sched_mutex);
1667   return tok;
1668 }
1669
1670 StgRegTable *
1671 resumeThread( StgInt tok,
1672               rtsBool concCall STG_UNUSED )
1673 {
1674   StgTSO *tso, **prev;
1675   Capability *cap;
1676
1677 #if defined(RTS_SUPPORTS_THREADS)
1678   /* Wait for permission to re-enter the RTS with the result. */
1679   ACQUIRE_LOCK(&sched_mutex);
1680   grabReturnCapability(&sched_mutex, &cap);
1681
1682   IF_DEBUG(scheduler, sched_belch("worker thread (%d, osthread %p): re-entering RTS", tok, osThreadId()));
1683 #else
1684   grabCapability(&cap);
1685 #endif
1686
1687   /* Remove the thread off of the suspended list */
1688   prev = &suspended_ccalling_threads;
1689   for (tso = suspended_ccalling_threads;
1690        tso != END_TSO_QUEUE;
1691        prev = &tso->link, tso = tso->link) {
1692     if (tso->id == (StgThreadID)tok) {
1693       *prev = tso->link;
1694       break;
1695     }
1696   }
1697   if (tso == END_TSO_QUEUE) {
1698     barf("resumeThread: thread not found");
1699   }
1700   tso->link = END_TSO_QUEUE;
1701
1702 #if defined(RTS_SUPPORTS_THREADS)
1703   if(tso->why_blocked == BlockedOnCCall)
1704   {
1705       awakenBlockedQueueNoLock(tso->blocked_exceptions);
1706       tso->blocked_exceptions = NULL;
1707   }
1708 #endif
1709
1710   /* Reset blocking status */
1711   tso->why_blocked  = NotBlocked;
1712
1713   cap->r.rCurrentTSO = tso;
1714 #if defined(RTS_SUPPORTS_THREADS)
1715   RELEASE_LOCK(&sched_mutex);
1716 #endif
1717   return &cap->r;
1718 }
1719
1720
1721 /* ---------------------------------------------------------------------------
1722  * Static functions
1723  * ------------------------------------------------------------------------ */
1724 static void unblockThread(StgTSO *tso);
1725
1726 /* ---------------------------------------------------------------------------
1727  * Comparing Thread ids.
1728  *
1729  * This is used from STG land in the implementation of the
1730  * instances of Eq/Ord for ThreadIds.
1731  * ------------------------------------------------------------------------ */
1732
1733 int
1734 cmp_thread(StgPtr tso1, StgPtr tso2)
1735 {
1736   StgThreadID id1 = ((StgTSO *)tso1)->id;
1737   StgThreadID id2 = ((StgTSO *)tso2)->id;
1738
1739   if (id1 < id2) return (-1);
1740   if (id1 > id2) return 1;
1741   return 0;
1742 }
1743
1744 /* ---------------------------------------------------------------------------
1745  * Fetching the ThreadID from an StgTSO.
1746  *
1747  * This is used in the implementation of Show for ThreadIds.
1748  * ------------------------------------------------------------------------ */
1749 int
1750 rts_getThreadId(StgPtr tso)
1751 {
1752   return ((StgTSO *)tso)->id;
1753 }
1754
1755 #ifdef DEBUG
1756 void
1757 labelThread(StgPtr tso, char *label)
1758 {
1759   int len;
1760   void *buf;
1761
1762   /* Caveat: Once set, you can only set the thread name to "" */
1763   len = strlen(label)+1;
1764   buf = stgMallocBytes(len * sizeof(char), "Schedule.c:labelThread()");
1765   strncpy(buf,label,len);
1766   /* Update will free the old memory for us */
1767   updateThreadLabel((StgWord)tso,buf);
1768 }
1769 #endif /* DEBUG */
1770
1771 /* ---------------------------------------------------------------------------
1772    Create a new thread.
1773
1774    The new thread starts with the given stack size.  Before the
1775    scheduler can run, however, this thread needs to have a closure
1776    (and possibly some arguments) pushed on its stack.  See
1777    pushClosure() in Schedule.h.
1778
1779    createGenThread() and createIOThread() (in SchedAPI.h) are
1780    convenient packaged versions of this function.
1781
1782    currently pri (priority) is only used in a GRAN setup -- HWL
1783    ------------------------------------------------------------------------ */
1784 //@cindex createThread
1785 #if defined(GRAN)
1786 /*   currently pri (priority) is only used in a GRAN setup -- HWL */
1787 StgTSO *
1788 createThread(nat size, StgInt pri)
1789 #else
1790 StgTSO *
1791 createThread(nat size)
1792 #endif
1793 {
1794
1795     StgTSO *tso;
1796     nat stack_size;
1797
1798     /* First check whether we should create a thread at all */
1799 #if defined(PAR)
1800   /* check that no more than RtsFlags.ParFlags.maxThreads threads are created */
1801   if (advisory_thread_count >= RtsFlags.ParFlags.maxThreads) {
1802     threadsIgnored++;
1803     belch("{createThread}Daq ghuH: refusing to create another thread; no more than %d threads allowed (currently %d)",
1804           RtsFlags.ParFlags.maxThreads, advisory_thread_count);
1805     return END_TSO_QUEUE;
1806   }
1807   threadsCreated++;
1808 #endif
1809
1810 #if defined(GRAN)
1811   ASSERT(!RtsFlags.GranFlags.Light || CurrentProc==0);
1812 #endif
1813
1814   // ToDo: check whether size = stack_size - TSO_STRUCT_SIZEW
1815
1816   /* catch ridiculously small stack sizes */
1817   if (size < MIN_STACK_WORDS + TSO_STRUCT_SIZEW) {
1818     size = MIN_STACK_WORDS + TSO_STRUCT_SIZEW;
1819   }
1820
1821   stack_size = size - TSO_STRUCT_SIZEW;
1822
1823   tso = (StgTSO *)allocate(size);
1824   TICK_ALLOC_TSO(stack_size, 0);
1825
1826   SET_HDR(tso, &stg_TSO_info, CCS_SYSTEM);
1827 #if defined(GRAN)
1828   SET_GRAN_HDR(tso, ThisPE);
1829 #endif
1830
1831   // Always start with the compiled code evaluator
1832   tso->what_next = ThreadRunGHC;
1833
1834   /* tso->id needs to be unique.  For now we use a heavyweight mutex to
1835    * protect the increment operation on next_thread_id.
1836    * In future, we could use an atomic increment instead.
1837    */
1838   ACQUIRE_LOCK(&thread_id_mutex);
1839   tso->id = next_thread_id++;
1840   RELEASE_LOCK(&thread_id_mutex);
1841
1842   tso->why_blocked  = NotBlocked;
1843   tso->blocked_exceptions = NULL;
1844
1845   tso->stack_size   = stack_size;
1846   tso->max_stack_size = round_to_mblocks(RtsFlags.GcFlags.maxStkSize)
1847                               - TSO_STRUCT_SIZEW;
1848   tso->sp           = (P_)&(tso->stack) + stack_size;
1849
1850 #ifdef PROFILING
1851   tso->prof.CCCS = CCS_MAIN;
1852 #endif
1853
1854   /* put a stop frame on the stack */
1855   tso->sp -= sizeofW(StgStopFrame);
1856   SET_HDR((StgClosure*)tso->sp,(StgInfoTable *)&stg_stop_thread_info,CCS_SYSTEM);
1857   // ToDo: check this
1858 #if defined(GRAN)
1859   tso->link = END_TSO_QUEUE;
1860   /* uses more flexible routine in GranSim */
1861   insertThread(tso, CurrentProc);
1862 #else
1863   /* In a non-GranSim setup the pushing of a TSO onto the runq is separated
1864    * from its creation
1865    */
1866 #endif
1867
1868 #if defined(GRAN)
1869   if (RtsFlags.GranFlags.GranSimStats.Full)
1870     DumpGranEvent(GR_START,tso);
1871 #elif defined(PAR)
1872   if (RtsFlags.ParFlags.ParStats.Full)
1873     DumpGranEvent(GR_STARTQ,tso);
1874   /* HACk to avoid SCHEDULE
1875      LastTSO = tso; */
1876 #endif
1877
1878   /* Link the new thread on the global thread list.
1879    */
1880   tso->global_link = all_threads;
1881   all_threads = tso;
1882
1883 #if defined(DIST)
1884   tso->dist.priority = MandatoryPriority; //by default that is...
1885 #endif
1886
1887 #if defined(GRAN)
1888   tso->gran.pri = pri;
1889 # if defined(DEBUG)
1890   tso->gran.magic = TSO_MAGIC; // debugging only
1891 # endif
1892   tso->gran.sparkname   = 0;
1893   tso->gran.startedat   = CURRENT_TIME;
1894   tso->gran.exported    = 0;
1895   tso->gran.basicblocks = 0;
1896   tso->gran.allocs      = 0;
1897   tso->gran.exectime    = 0;
1898   tso->gran.fetchtime   = 0;
1899   tso->gran.fetchcount  = 0;
1900   tso->gran.blocktime   = 0;
1901   tso->gran.blockcount  = 0;
1902   tso->gran.blockedat   = 0;
1903   tso->gran.globalsparks = 0;
1904   tso->gran.localsparks  = 0;
1905   if (RtsFlags.GranFlags.Light)
1906     tso->gran.clock  = Now; /* local clock */
1907   else
1908     tso->gran.clock  = 0;
1909
1910   IF_DEBUG(gran,printTSO(tso));
1911 #elif defined(PAR)
1912 # if defined(DEBUG)
1913   tso->par.magic = TSO_MAGIC; // debugging only
1914 # endif
1915   tso->par.sparkname   = 0;
1916   tso->par.startedat   = CURRENT_TIME;
1917   tso->par.exported    = 0;
1918   tso->par.basicblocks = 0;
1919   tso->par.allocs      = 0;
1920   tso->par.exectime    = 0;
1921   tso->par.fetchtime   = 0;
1922   tso->par.fetchcount  = 0;
1923   tso->par.blocktime   = 0;
1924   tso->par.blockcount  = 0;
1925   tso->par.blockedat   = 0;
1926   tso->par.globalsparks = 0;
1927   tso->par.localsparks  = 0;
1928 #endif
1929
1930 #if defined(GRAN)
1931   globalGranStats.tot_threads_created++;
1932   globalGranStats.threads_created_on_PE[CurrentProc]++;
1933   globalGranStats.tot_sq_len += spark_queue_len(CurrentProc);
1934   globalGranStats.tot_sq_probes++;
1935 #elif defined(PAR)
1936   // collect parallel global statistics (currently done together with GC stats)
1937   if (RtsFlags.ParFlags.ParStats.Global &&
1938       RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
1939     //fprintf(stderr, "Creating thread %d @ %11.2f\n", tso->id, usertime());
1940     globalParStats.tot_threads_created++;
1941   }
1942 #endif
1943
1944 #if defined(GRAN)
1945   IF_GRAN_DEBUG(pri,
1946                 belch("==__ schedule: Created TSO %d (%p);",
1947                       CurrentProc, tso, tso->id));
1948 #elif defined(PAR)
1949     IF_PAR_DEBUG(verbose,
1950                  belch("==__ schedule: Created TSO %d (%p); %d threads active",
1951                        tso->id, tso, advisory_thread_count));
1952 #else
1953   IF_DEBUG(scheduler,sched_belch("created thread %ld, stack size = %lx words",
1954                                  tso->id, tso->stack_size));
1955 #endif
1956   return tso;
1957 }
1958
1959 #if defined(PAR)
1960 /* RFP:
1961    all parallel thread creation calls should fall through the following routine.
1962 */
1963 StgTSO *
1964 createSparkThread(rtsSpark spark)
1965 { StgTSO *tso;
1966   ASSERT(spark != (rtsSpark)NULL);
1967   if (advisory_thread_count >= RtsFlags.ParFlags.maxThreads)
1968   { threadsIgnored++;
1969     barf("{createSparkThread}Daq ghuH: refusing to create another thread; no more than %d threads allowed (currently %d)",
1970           RtsFlags.ParFlags.maxThreads, advisory_thread_count);
1971     return END_TSO_QUEUE;
1972   }
1973   else
1974   { threadsCreated++;
1975     tso = createThread(RtsFlags.GcFlags.initialStkSize);
1976     if (tso==END_TSO_QUEUE)
1977       barf("createSparkThread: Cannot create TSO");
1978 #if defined(DIST)
1979     tso->priority = AdvisoryPriority;
1980 #endif
1981     pushClosure(tso,spark);
1982     PUSH_ON_RUN_QUEUE(tso);
1983     advisory_thread_count++;
1984   }
1985   return tso;
1986 }
1987 #endif
1988
1989 /*
1990   Turn a spark into a thread.
1991   ToDo: fix for SMP (needs to acquire SCHED_MUTEX!)
1992 */
1993 #if defined(PAR)
1994 //@cindex activateSpark
1995 StgTSO *
1996 activateSpark (rtsSpark spark)
1997 {
1998   StgTSO *tso;
1999
2000   tso = createSparkThread(spark);
2001   if (RtsFlags.ParFlags.ParStats.Full) {
2002     //ASSERT(run_queue_hd == END_TSO_QUEUE); // I think ...
2003     IF_PAR_DEBUG(verbose,
2004                  belch("==^^ activateSpark: turning spark of closure %p (%s) into a thread",
2005                        (StgClosure *)spark, info_type((StgClosure *)spark)));
2006   }
2007   // ToDo: fwd info on local/global spark to thread -- HWL
2008   // tso->gran.exported =  spark->exported;
2009   // tso->gran.locked =   !spark->global;
2010   // tso->gran.sparkname = spark->name;
2011
2012   return tso;
2013 }
2014 #endif
2015
2016 static SchedulerStatus waitThread_(/*out*/StgMainThread* m
2017 #if defined(THREADED_RTS)
2018                                    , rtsBool blockWaiting
2019 #endif
2020                                    );
2021
2022
2023 /* ---------------------------------------------------------------------------
2024  * scheduleThread()
2025  *
2026  * scheduleThread puts a thread on the head of the runnable queue.
2027  * This will usually be done immediately after a thread is created.
2028  * The caller of scheduleThread must create the thread using e.g.
2029  * createThread and push an appropriate closure
2030  * on this thread's stack before the scheduler is invoked.
2031  * ------------------------------------------------------------------------ */
2032
2033 static void scheduleThread_ (StgTSO* tso);
2034
2035 void
2036 scheduleThread_(StgTSO *tso)
2037 {
2038   // Precondition: sched_mutex must be held.
2039
2040   /* Put the new thread on the head of the runnable queue.  The caller
2041    * better push an appropriate closure on this thread's stack
2042    * beforehand.  In the SMP case, the thread may start running as
2043    * soon as we release the scheduler lock below.
2044    */
2045   PUSH_ON_RUN_QUEUE(tso);
2046   THREAD_RUNNABLE();
2047
2048 #if 0
2049   IF_DEBUG(scheduler,printTSO(tso));
2050 #endif
2051 }
2052
2053 void scheduleThread(StgTSO* tso)
2054 {
2055   ACQUIRE_LOCK(&sched_mutex);
2056   scheduleThread_(tso);
2057   RELEASE_LOCK(&sched_mutex);
2058 }
2059
2060 SchedulerStatus
2061 scheduleWaitThread(StgTSO* tso, /*[out]*/HaskellObj* ret)
2062 {       // Precondition: sched_mutex must be held
2063   StgMainThread *m;
2064
2065   m = stgMallocBytes(sizeof(StgMainThread), "waitThread");
2066   m->tso = tso;
2067   m->ret = ret;
2068   m->stat = NoStatus;
2069 #if defined(RTS_SUPPORTS_THREADS)
2070   initCondition(&m->wakeup);
2071 #endif
2072
2073   /* Put the thread on the main-threads list prior to scheduling the TSO.
2074      Failure to do so introduces a race condition in the MT case (as
2075      identified by Wolfgang Thaller), whereby the new task/OS thread
2076      created by scheduleThread_() would complete prior to the thread
2077      that spawned it managed to put 'itself' on the main-threads list.
2078      The upshot of it all being that the worker thread wouldn't get to
2079      signal the completion of the its work item for the main thread to
2080      see (==> it got stuck waiting.)    -- sof 6/02.
2081   */
2082   IF_DEBUG(scheduler, sched_belch("waiting for thread (%d)\n", tso->id));
2083
2084   m->link = main_threads;
2085   main_threads = m;
2086
2087   scheduleThread_(tso);
2088 #if defined(THREADED_RTS)
2089   return waitThread_(m, rtsTrue);
2090 #else
2091   return waitThread_(m);
2092 #endif
2093 }
2094
2095 /* ---------------------------------------------------------------------------
2096  * initScheduler()
2097  *
2098  * Initialise the scheduler.  This resets all the queues - if the
2099  * queues contained any threads, they'll be garbage collected at the
2100  * next pass.
2101  *
2102  * ------------------------------------------------------------------------ */
2103
2104 #ifdef SMP
2105 static void
2106 term_handler(int sig STG_UNUSED)
2107 {
2108   stat_workerStop();
2109   ACQUIRE_LOCK(&term_mutex);
2110   await_death--;
2111   RELEASE_LOCK(&term_mutex);
2112   shutdownThread();
2113 }
2114 #endif
2115
2116 void
2117 initScheduler(void)
2118 {
2119 #if defined(GRAN)
2120   nat i;
2121
2122   for (i=0; i<=MAX_PROC; i++) {
2123     run_queue_hds[i]      = END_TSO_QUEUE;
2124     run_queue_tls[i]      = END_TSO_QUEUE;
2125     blocked_queue_hds[i]  = END_TSO_QUEUE;
2126     blocked_queue_tls[i]  = END_TSO_QUEUE;
2127     ccalling_threadss[i]  = END_TSO_QUEUE;
2128     sleeping_queue        = END_TSO_QUEUE;
2129   }
2130 #else
2131   run_queue_hd      = END_TSO_QUEUE;
2132   run_queue_tl      = END_TSO_QUEUE;
2133   blocked_queue_hd  = END_TSO_QUEUE;
2134   blocked_queue_tl  = END_TSO_QUEUE;
2135   sleeping_queue    = END_TSO_QUEUE;
2136 #endif
2137
2138   suspended_ccalling_threads  = END_TSO_QUEUE;
2139
2140   main_threads = NULL;
2141   all_threads  = END_TSO_QUEUE;
2142
2143   context_switch = 0;
2144   interrupted    = 0;
2145
2146   RtsFlags.ConcFlags.ctxtSwitchTicks =
2147       RtsFlags.ConcFlags.ctxtSwitchTime / TICK_MILLISECS;
2148
2149 #if defined(RTS_SUPPORTS_THREADS)
2150   /* Initialise the mutex and condition variables used by
2151    * the scheduler. */
2152   initMutex(&sched_mutex);
2153   initMutex(&term_mutex);
2154   initMutex(&thread_id_mutex);
2155
2156   initCondition(&thread_ready_cond);
2157 #endif
2158
2159 #if defined(SMP)
2160   initCondition(&gc_pending_cond);
2161 #endif
2162
2163 #if defined(RTS_SUPPORTS_THREADS)
2164   ACQUIRE_LOCK(&sched_mutex);
2165 #endif
2166
2167   /* Install the SIGHUP handler */
2168 #if defined(SMP)
2169   {
2170     struct sigaction action,oact;
2171
2172     action.sa_handler = term_handler;
2173     sigemptyset(&action.sa_mask);
2174     action.sa_flags = 0;
2175     if (sigaction(SIGTERM, &action, &oact) != 0) {
2176       barf("can't install TERM handler");
2177     }
2178   }
2179 #endif
2180
2181   /* A capability holds the state a native thread needs in
2182    * order to execute STG code. At least one capability is
2183    * floating around (only SMP builds have more than one).
2184    */
2185   initCapabilities();
2186
2187 #if defined(RTS_SUPPORTS_THREADS)
2188     /* start our haskell execution tasks */
2189 # if defined(SMP)
2190     startTaskManager(RtsFlags.ParFlags.nNodes, taskStart);
2191 # else
2192     startTaskManager(0,taskStart);
2193 # endif
2194 #endif
2195
2196 #if /* defined(SMP) ||*/ defined(PAR)
2197   initSparkPools();
2198 #endif
2199
2200 #if defined(RTS_SUPPORTS_THREADS)
2201   RELEASE_LOCK(&sched_mutex);
2202 #endif
2203
2204 }
2205
2206 void
2207 exitScheduler( void )
2208 {
2209 #if defined(RTS_SUPPORTS_THREADS)
2210   stopTaskManager();
2211 #endif
2212   shutting_down_scheduler = rtsTrue;
2213 }
2214
2215 /* -----------------------------------------------------------------------------
2216    Managing the per-task allocation areas.
2217
2218    Each capability comes with an allocation area.  These are
2219    fixed-length block lists into which allocation can be done.
2220
2221    ToDo: no support for two-space collection at the moment???
2222    -------------------------------------------------------------------------- */
2223
2224 /* -----------------------------------------------------------------------------
2225  * waitThread is the external interface for running a new computation
2226  * and waiting for the result.
2227  *
2228  * In the non-SMP case, we create a new main thread, push it on the
2229  * main-thread stack, and invoke the scheduler to run it.  The
2230  * scheduler will return when the top main thread on the stack has
2231  * completed or died, and fill in the necessary fields of the
2232  * main_thread structure.
2233  *
2234  * In the SMP case, we create a main thread as before, but we then
2235  * create a new condition variable and sleep on it.  When our new
2236  * main thread has completed, we'll be woken up and the status/result
2237  * will be in the main_thread struct.
2238  * -------------------------------------------------------------------------- */
2239
2240 int
2241 howManyThreadsAvail ( void )
2242 {
2243    int i = 0;
2244    StgTSO* q;
2245    for (q = run_queue_hd; q != END_TSO_QUEUE; q = q->link)
2246       i++;
2247    for (q = blocked_queue_hd; q != END_TSO_QUEUE; q = q->link)
2248       i++;
2249    for (q = sleeping_queue; q != END_TSO_QUEUE; q = q->link)
2250       i++;
2251    return i;
2252 }
2253
2254 void
2255 finishAllThreads ( void )
2256 {
2257    do {
2258       while (run_queue_hd != END_TSO_QUEUE) {
2259          waitThread ( run_queue_hd, NULL);
2260       }
2261       while (blocked_queue_hd != END_TSO_QUEUE) {
2262          waitThread ( blocked_queue_hd, NULL);
2263       }
2264       while (sleeping_queue != END_TSO_QUEUE) {
2265          waitThread ( blocked_queue_hd, NULL);
2266       }
2267    } while
2268       (blocked_queue_hd != END_TSO_QUEUE ||
2269        run_queue_hd     != END_TSO_QUEUE ||
2270        sleeping_queue   != END_TSO_QUEUE);
2271 }
2272
2273 SchedulerStatus
2274 waitThread(StgTSO *tso, /*out*/StgClosure **ret)
2275 {
2276   StgMainThread *m;
2277   SchedulerStatus stat;
2278
2279   m = stgMallocBytes(sizeof(StgMainThread), "waitThread");
2280   m->tso = tso;
2281   m->ret = ret;
2282   m->stat = NoStatus;
2283 #if defined(RTS_SUPPORTS_THREADS)
2284   initCondition(&m->wakeup);
2285 #endif
2286
2287   /* see scheduleWaitThread() comment */
2288   ACQUIRE_LOCK(&sched_mutex);
2289   m->link = main_threads;
2290   main_threads = m;
2291
2292   IF_DEBUG(scheduler, sched_belch("waiting for thread %d", tso->id));
2293 #if defined(THREADED_RTS)
2294   stat = waitThread_(m, rtsFalse);
2295 #else
2296   stat = waitThread_(m);
2297 #endif
2298   RELEASE_LOCK(&sched_mutex);
2299   return stat;
2300 }
2301
2302 static
2303 SchedulerStatus
2304 waitThread_(StgMainThread* m
2305 #if defined(THREADED_RTS)
2306             , rtsBool blockWaiting
2307 #endif
2308            )
2309 {
2310   SchedulerStatus stat;
2311
2312   // Precondition: sched_mutex must be held.
2313   IF_DEBUG(scheduler, sched_belch("== scheduler: new main thread (%d)\n", m->tso->id));
2314
2315 #if defined(RTS_SUPPORTS_THREADS)
2316
2317 # if defined(THREADED_RTS)
2318   if (!blockWaiting) {
2319     /* In the threaded case, the OS thread that called main()
2320      * gets to enter the RTS directly without going via another
2321      * task/thread.
2322      */
2323     main_main_thread = m;
2324     RELEASE_LOCK(&sched_mutex);
2325     schedule();
2326     ACQUIRE_LOCK(&sched_mutex);
2327     main_main_thread = NULL;
2328     ASSERT(m->stat != NoStatus);
2329   } else
2330 # endif
2331   {
2332     do {
2333       waitCondition(&m->wakeup, &sched_mutex);
2334     } while (m->stat == NoStatus);
2335   }
2336 #elif defined(GRAN)
2337   /* GranSim specific init */
2338   CurrentTSO = m->tso;                // the TSO to run
2339   procStatus[MainProc] = Busy;        // status of main PE
2340   CurrentProc = MainProc;             // PE to run it on
2341
2342   RELEASE_LOCK(&sched_mutex);
2343   schedule();
2344 #else
2345   RELEASE_LOCK(&sched_mutex);
2346   schedule();
2347   ASSERT(m->stat != NoStatus);
2348 #endif
2349
2350   stat = m->stat;
2351
2352 #if defined(RTS_SUPPORTS_THREADS)
2353   closeCondition(&m->wakeup);
2354 #endif
2355
2356   IF_DEBUG(scheduler, fprintf(stderr, "== scheduler: main thread (%d) finished\n",
2357                               m->tso->id));
2358   stgFree(m);
2359
2360   // Postcondition: sched_mutex still held
2361   return stat;
2362 }
2363
2364 //@node Run queue code, Garbage Collextion Routines, Suspend and Resume, Main scheduling code
2365 //@subsection Run queue code
2366
2367 #if 0
2368 /*
2369    NB: In GranSim we have many run queues; run_queue_hd is actually a macro
2370        unfolding to run_queue_hds[CurrentProc], thus CurrentProc is an
2371        implicit global variable that has to be correct when calling these
2372        fcts -- HWL
2373 */
2374
2375 /* Put the new thread on the head of the runnable queue.
2376  * The caller of createThread better push an appropriate closure
2377  * on this thread's stack before the scheduler is invoked.
2378  */
2379 static /* inline */ void
2380 add_to_run_queue(tso)
2381 StgTSO* tso;
2382 {
2383   ASSERT(tso!=run_queue_hd && tso!=run_queue_tl);
2384   tso->link = run_queue_hd;
2385   run_queue_hd = tso;
2386   if (run_queue_tl == END_TSO_QUEUE) {
2387     run_queue_tl = tso;
2388   }
2389 }
2390
2391 /* Put the new thread at the end of the runnable queue. */
2392 static /* inline */ void
2393 push_on_run_queue(tso)
2394 StgTSO* tso;
2395 {
2396   ASSERT(get_itbl((StgClosure *)tso)->type == TSO);
2397   ASSERT(run_queue_hd!=NULL && run_queue_tl!=NULL);
2398   ASSERT(tso!=run_queue_hd && tso!=run_queue_tl);
2399   if (run_queue_hd == END_TSO_QUEUE) {
2400     run_queue_hd = tso;
2401   } else {
2402     run_queue_tl->link = tso;
2403   }
2404   run_queue_tl = tso;
2405 }
2406
2407 /*
2408    Should be inlined because it's used very often in schedule.  The tso
2409    argument is actually only needed in GranSim, where we want to have the
2410    possibility to schedule *any* TSO on the run queue, irrespective of the
2411    actual ordering. Therefore, if tso is not the nil TSO then we traverse
2412    the run queue and dequeue the tso, adjusting the links in the queue.
2413 */
2414 //@cindex take_off_run_queue
2415 static /* inline */ StgTSO*
2416 take_off_run_queue(StgTSO *tso) {
2417   StgTSO *t, *prev;
2418
2419   /*
2420      qetlaHbogh Qu' ngaSbogh ghomDaQ {tso} yIteq!
2421
2422      if tso is specified, unlink that tso from the run_queue (doesn't have
2423      to be at the beginning of the queue); GranSim only
2424   */
2425   if (tso!=END_TSO_QUEUE) {
2426     /* find tso in queue */
2427     for (t=run_queue_hd, prev=END_TSO_QUEUE;
2428          t!=END_TSO_QUEUE && t!=tso;
2429          prev=t, t=t->link)
2430       /* nothing */ ;
2431     ASSERT(t==tso);
2432     /* now actually dequeue the tso */
2433     if (prev!=END_TSO_QUEUE) {
2434       ASSERT(run_queue_hd!=t);
2435       prev->link = t->link;
2436     } else {
2437       /* t is at beginning of thread queue */
2438       ASSERT(run_queue_hd==t);
2439       run_queue_hd = t->link;
2440     }
2441     /* t is at end of thread queue */
2442     if (t->link==END_TSO_QUEUE) {
2443       ASSERT(t==run_queue_tl);
2444       run_queue_tl = prev;
2445     } else {
2446       ASSERT(run_queue_tl!=t);
2447     }
2448     t->link = END_TSO_QUEUE;
2449   } else {
2450     /* take tso from the beginning of the queue; std concurrent code */
2451     t = run_queue_hd;
2452     if (t != END_TSO_QUEUE) {
2453       run_queue_hd = t->link;
2454       t->link = END_TSO_QUEUE;
2455       if (run_queue_hd == END_TSO_QUEUE) {
2456         run_queue_tl = END_TSO_QUEUE;
2457       }
2458     }
2459   }
2460   return t;
2461 }
2462
2463 #endif /* 0 */
2464
2465 //@node Garbage Collextion Routines, Blocking Queue Routines, Run queue code, Main scheduling code
2466 //@subsection Garbage Collextion Routines
2467
2468 /* ---------------------------------------------------------------------------
2469    Where are the roots that we know about?
2470
2471         - all the threads on the runnable queue
2472         - all the threads on the blocked queue
2473         - all the threads on the sleeping queue
2474         - all the thread currently executing a _ccall_GC
2475         - all the "main threads"
2476
2477    ------------------------------------------------------------------------ */
2478
2479 /* This has to be protected either by the scheduler monitor, or by the
2480         garbage collection monitor (probably the latter).
2481         KH @ 25/10/99
2482 */
2483
2484 void
2485 GetRoots(evac_fn evac)
2486 {
2487 #if defined(GRAN)
2488   {
2489     nat i;
2490     for (i=0; i<=RtsFlags.GranFlags.proc; i++) {
2491       if ((run_queue_hds[i] != END_TSO_QUEUE) && ((run_queue_hds[i] != NULL)))
2492           evac((StgClosure **)&run_queue_hds[i]);
2493       if ((run_queue_tls[i] != END_TSO_QUEUE) && ((run_queue_tls[i] != NULL)))
2494           evac((StgClosure **)&run_queue_tls[i]);
2495
2496       if ((blocked_queue_hds[i] != END_TSO_QUEUE) && ((blocked_queue_hds[i] != NULL)))
2497           evac((StgClosure **)&blocked_queue_hds[i]);
2498       if ((blocked_queue_tls[i] != END_TSO_QUEUE) && ((blocked_queue_tls[i] != NULL)))
2499           evac((StgClosure **)&blocked_queue_tls[i]);
2500       if ((ccalling_threadss[i] != END_TSO_QUEUE) && ((ccalling_threadss[i] != NULL)))
2501           evac((StgClosure **)&ccalling_threads[i]);
2502     }
2503   }
2504
2505   markEventQueue();
2506
2507 #else /* !GRAN */
2508   if (run_queue_hd != END_TSO_QUEUE) {
2509       ASSERT(run_queue_tl != END_TSO_QUEUE);
2510       evac((StgClosure **)&run_queue_hd);
2511       evac((StgClosure **)&run_queue_tl);
2512   }
2513
2514   if (blocked_queue_hd != END_TSO_QUEUE) {
2515       ASSERT(blocked_queue_tl != END_TSO_QUEUE);
2516       evac((StgClosure **)&blocked_queue_hd);
2517       evac((StgClosure **)&blocked_queue_tl);
2518   }
2519
2520   if (sleeping_queue != END_TSO_QUEUE) {
2521       evac((StgClosure **)&sleeping_queue);
2522   }
2523 #endif
2524
2525   if (suspended_ccalling_threads != END_TSO_QUEUE) {
2526       evac((StgClosure **)&suspended_ccalling_threads);
2527   }
2528
2529 #if defined(PAR) || defined(GRAN)
2530   markSparkQueue(evac);
2531 #endif
2532
2533 #if defined(RTS_USER_SIGNALS)
2534   // mark the signal handlers (signals should be already blocked)
2535   markSignalHandlers(evac);
2536 #endif
2537
2538   // main threads which have completed need to be retained until they
2539   // are dealt with in the main scheduler loop.  They won't be
2540   // retained any other way: the GC will drop them from the
2541   // all_threads list, so we have to be careful to treat them as roots
2542   // here.
2543   {
2544       StgMainThread *m;
2545       for (m = main_threads; m != NULL; m = m->link) {
2546           switch (m->tso->what_next) {
2547           case ThreadComplete:
2548           case ThreadKilled:
2549               evac((StgClosure **)&m->tso);
2550               break;
2551           default:
2552               break;
2553           }
2554       }
2555   }
2556 }
2557
2558 /* -----------------------------------------------------------------------------
2559    performGC
2560
2561    This is the interface to the garbage collector from Haskell land.
2562    We provide this so that external C code can allocate and garbage
2563    collect when called from Haskell via _ccall_GC.
2564
2565    It might be useful to provide an interface whereby the programmer
2566    can specify more roots (ToDo).
2567
2568    This needs to be protected by the GC condition variable above.  KH.
2569    -------------------------------------------------------------------------- */
2570
2571 static void (*extra_roots)(evac_fn);
2572
2573 void
2574 performGC(void)
2575 {
2576   /* Obligated to hold this lock upon entry */
2577   ACQUIRE_LOCK(&sched_mutex);
2578   GarbageCollect(GetRoots,rtsFalse);
2579   RELEASE_LOCK(&sched_mutex);
2580 }
2581
2582 void
2583 performMajorGC(void)
2584 {
2585   ACQUIRE_LOCK(&sched_mutex);
2586   GarbageCollect(GetRoots,rtsTrue);
2587   RELEASE_LOCK(&sched_mutex);
2588 }
2589
2590 static void
2591 AllRoots(evac_fn evac)
2592 {
2593     GetRoots(evac);             // the scheduler's roots
2594     extra_roots(evac);          // the user's roots
2595 }
2596
2597 void
2598 performGCWithRoots(void (*get_roots)(evac_fn))
2599 {
2600   ACQUIRE_LOCK(&sched_mutex);
2601   extra_roots = get_roots;
2602   GarbageCollect(AllRoots,rtsFalse);
2603   RELEASE_LOCK(&sched_mutex);
2604 }
2605
2606 /* -----------------------------------------------------------------------------
2607    Stack overflow
2608
2609    If the thread has reached its maximum stack size, then raise the
2610    StackOverflow exception in the offending thread.  Otherwise
2611    relocate the TSO into a larger chunk of memory and adjust its stack
2612    size appropriately.
2613    -------------------------------------------------------------------------- */
2614
2615 static StgTSO *
2616 threadStackOverflow(StgTSO *tso)
2617 {
2618   nat new_stack_size, new_tso_size, stack_words;
2619   StgPtr new_sp;
2620   StgTSO *dest;
2621
2622   IF_DEBUG(sanity,checkTSO(tso));
2623   if (tso->stack_size >= tso->max_stack_size) {
2624
2625     IF_DEBUG(gc,
2626              belch("@@ threadStackOverflow of TSO %d (%p): stack too large (now %ld; max is %ld",
2627                    tso->id, tso, tso->stack_size, tso->max_stack_size);
2628              /* If we're debugging, just print out the top of the stack */
2629              printStackChunk(tso->sp, stg_min(tso->stack+tso->stack_size,
2630                                               tso->sp+64)));
2631
2632     /* Send this thread the StackOverflow exception */
2633     raiseAsync(tso, (StgClosure *)stackOverflow_closure);
2634     return tso;
2635   }
2636
2637   /* Try to double the current stack size.  If that takes us over the
2638    * maximum stack size for this thread, then use the maximum instead.
2639    * Finally round up so the TSO ends up as a whole number of blocks.
2640    */
2641   new_stack_size = stg_min(tso->stack_size * 2, tso->max_stack_size);
2642   new_tso_size   = (nat)BLOCK_ROUND_UP(new_stack_size * sizeof(W_) +
2643                                        TSO_STRUCT_SIZE)/sizeof(W_);
2644   new_tso_size = round_to_mblocks(new_tso_size);  /* Be MBLOCK-friendly */
2645   new_stack_size = new_tso_size - TSO_STRUCT_SIZEW;
2646
2647   IF_DEBUG(scheduler, fprintf(stderr,"== scheduler: increasing stack size from %d words to %d.\n", tso->stack_size, new_stack_size));
2648
2649   dest = (StgTSO *)allocate(new_tso_size);
2650   TICK_ALLOC_TSO(new_stack_size,0);
2651
2652   /* copy the TSO block and the old stack into the new area */
2653   memcpy(dest,tso,TSO_STRUCT_SIZE);
2654   stack_words = tso->stack + tso->stack_size - tso->sp;
2655   new_sp = (P_)dest + new_tso_size - stack_words;
2656   memcpy(new_sp, tso->sp, stack_words * sizeof(W_));
2657
2658   /* relocate the stack pointers... */
2659   dest->sp         = new_sp;
2660   dest->stack_size = new_stack_size;
2661
2662   /* Mark the old TSO as relocated.  We have to check for relocated
2663    * TSOs in the garbage collector and any primops that deal with TSOs.
2664    *
2665    * It's important to set the sp value to just beyond the end
2666    * of the stack, so we don't attempt to scavenge any part of the
2667    * dead TSO's stack.
2668    */
2669   tso->what_next = ThreadRelocated;
2670   tso->link = dest;
2671   tso->sp = (P_)&(tso->stack[tso->stack_size]);
2672   tso->why_blocked = NotBlocked;
2673   dest->mut_link = NULL;
2674
2675   IF_PAR_DEBUG(verbose,
2676                belch("@@ threadStackOverflow of TSO %d (now at %p): stack size increased to %ld",
2677                      tso->id, tso, tso->stack_size);
2678                /* If we're debugging, just print out the top of the stack */
2679                printStackChunk(tso->sp, stg_min(tso->stack+tso->stack_size,
2680                                                 tso->sp+64)));
2681
2682   IF_DEBUG(sanity,checkTSO(tso));
2683 #if 0
2684   IF_DEBUG(scheduler,printTSO(dest));
2685 #endif
2686
2687   return dest;
2688 }
2689
2690 //@node Blocking Queue Routines, Exception Handling Routines, Garbage Collextion Routines, Main scheduling code
2691 //@subsection Blocking Queue Routines
2692
2693 /* ---------------------------------------------------------------------------
2694    Wake up a queue that was blocked on some resource.
2695    ------------------------------------------------------------------------ */
2696
2697 #if defined(GRAN)
2698 static inline void
2699 unblockCount ( StgBlockingQueueElement *bqe, StgClosure *node )
2700 {
2701 }
2702 #elif defined(PAR)
2703 static inline void
2704 unblockCount ( StgBlockingQueueElement *bqe, StgClosure *node )
2705 {
2706   /* write RESUME events to log file and
2707      update blocked and fetch time (depending on type of the orig closure) */
2708   if (RtsFlags.ParFlags.ParStats.Full) {
2709     DumpRawGranEvent(CURRENT_PROC, CURRENT_PROC,
2710                      GR_RESUMEQ, ((StgTSO *)bqe), ((StgTSO *)bqe)->block_info.closure,
2711                      0, 0 /* spark_queue_len(ADVISORY_POOL) */);
2712     if (EMPTY_RUN_QUEUE())
2713       emitSchedule = rtsTrue;
2714
2715     switch (get_itbl(node)->type) {
2716         case FETCH_ME_BQ:
2717           ((StgTSO *)bqe)->par.fetchtime += CURRENT_TIME-((StgTSO *)bqe)->par.blockedat;
2718           break;
2719         case RBH:
2720         case FETCH_ME:
2721         case BLACKHOLE_BQ:
2722           ((StgTSO *)bqe)->par.blocktime += CURRENT_TIME-((StgTSO *)bqe)->par.blockedat;
2723           break;
2724 #ifdef DIST
2725         case MVAR:
2726           break;
2727 #endif
2728         default:
2729           barf("{unblockOneLocked}Daq Qagh: unexpected closure in blocking queue");
2730         }
2731       }
2732 }
2733 #endif
2734
2735 #if defined(GRAN)
2736 static StgBlockingQueueElement *
2737 unblockOneLocked(StgBlockingQueueElement *bqe, StgClosure *node)
2738 {
2739     StgTSO *tso;
2740     PEs node_loc, tso_loc;
2741
2742     node_loc = where_is(node); // should be lifted out of loop
2743     tso = (StgTSO *)bqe;  // wastes an assignment to get the type right
2744     tso_loc = where_is((StgClosure *)tso);
2745     if (IS_LOCAL_TO(PROCS(node),tso_loc)) { // TSO is local
2746       /* !fake_fetch => TSO is on CurrentProc is same as IS_LOCAL_TO */
2747       ASSERT(CurrentProc!=node_loc || tso_loc==CurrentProc);
2748       CurrentTime[CurrentProc] += RtsFlags.GranFlags.Costs.lunblocktime;
2749       // insertThread(tso, node_loc);
2750       new_event(tso_loc, tso_loc, CurrentTime[CurrentProc],
2751                 ResumeThread,
2752                 tso, node, (rtsSpark*)NULL);
2753       tso->link = END_TSO_QUEUE; // overwrite link just to be sure
2754       // len_local++;
2755       // len++;
2756     } else { // TSO is remote (actually should be FMBQ)
2757       CurrentTime[CurrentProc] += RtsFlags.GranFlags.Costs.mpacktime +
2758                                   RtsFlags.GranFlags.Costs.gunblocktime +
2759                                   RtsFlags.GranFlags.Costs.latency;
2760       new_event(tso_loc, CurrentProc, CurrentTime[CurrentProc],
2761                 UnblockThread,
2762                 tso, node, (rtsSpark*)NULL);
2763       tso->link = END_TSO_QUEUE; // overwrite link just to be sure
2764       // len++;
2765     }
2766     /* the thread-queue-overhead is accounted for in either Resume or UnblockThread */
2767     IF_GRAN_DEBUG(bq,
2768                   fprintf(stderr," %s TSO %d (%p) [PE %d] (block_info.closure=%p) (next=%p) ,",
2769                           (node_loc==tso_loc ? "Local" : "Global"),
2770                           tso->id, tso, CurrentProc, tso->block_info.closure, tso->link));
2771     tso->block_info.closure = NULL;
2772     IF_DEBUG(scheduler,belch("-- Waking up thread %ld (%p)",
2773                              tso->id, tso));
2774 }
2775 #elif defined(PAR)
2776 static StgBlockingQueueElement *
2777 unblockOneLocked(StgBlockingQueueElement *bqe, StgClosure *node)
2778 {
2779     StgBlockingQueueElement *next;
2780
2781     switch (get_itbl(bqe)->type) {
2782     case TSO:
2783       ASSERT(((StgTSO *)bqe)->why_blocked != NotBlocked);
2784       /* if it's a TSO just push it onto the run_queue */
2785       next = bqe->link;
2786       // ((StgTSO *)bqe)->link = END_TSO_QUEUE; // debugging?
2787       PUSH_ON_RUN_QUEUE((StgTSO *)bqe);
2788       THREAD_RUNNABLE();
2789       unblockCount(bqe, node);
2790       /* reset blocking status after dumping event */
2791       ((StgTSO *)bqe)->why_blocked = NotBlocked;
2792       break;
2793
2794     case BLOCKED_FETCH:
2795       /* if it's a BLOCKED_FETCH put it on the PendingFetches list */
2796       next = bqe->link;
2797       bqe->link = (StgBlockingQueueElement *)PendingFetches;
2798       PendingFetches = (StgBlockedFetch *)bqe;
2799       break;
2800
2801 # if defined(DEBUG)
2802       /* can ignore this case in a non-debugging setup;
2803          see comments on RBHSave closures above */
2804     case CONSTR:
2805       /* check that the closure is an RBHSave closure */
2806       ASSERT(get_itbl((StgClosure *)bqe) == &stg_RBH_Save_0_info ||
2807              get_itbl((StgClosure *)bqe) == &stg_RBH_Save_1_info ||
2808              get_itbl((StgClosure *)bqe) == &stg_RBH_Save_2_info);
2809       break;
2810
2811     default:
2812       barf("{unblockOneLocked}Daq Qagh: Unexpected IP (%#lx; %s) in blocking queue at %#lx\n",
2813            get_itbl((StgClosure *)bqe), info_type((StgClosure *)bqe),
2814            (StgClosure *)bqe);
2815 # endif
2816     }
2817   IF_PAR_DEBUG(bq, fprintf(stderr, ", %p (%s)", bqe, info_type((StgClosure*)bqe)));
2818   return next;
2819 }
2820
2821 #else /* !GRAN && !PAR */
2822 static StgTSO *
2823 unblockOneLocked(StgTSO *tso)
2824 {
2825   StgTSO *next;
2826
2827   ASSERT(get_itbl(tso)->type == TSO);
2828   ASSERT(tso->why_blocked != NotBlocked);
2829   tso->why_blocked = NotBlocked;
2830   next = tso->link;
2831   PUSH_ON_RUN_QUEUE(tso);
2832   THREAD_RUNNABLE();
2833   IF_DEBUG(scheduler,sched_belch("waking up thread %ld", tso->id));
2834   return next;
2835 }
2836 #endif
2837
2838 #if defined(GRAN) || defined(PAR)
2839 inline StgBlockingQueueElement *
2840 unblockOne(StgBlockingQueueElement *bqe, StgClosure *node)
2841 {
2842   ACQUIRE_LOCK(&sched_mutex);
2843   bqe = unblockOneLocked(bqe, node);
2844   RELEASE_LOCK(&sched_mutex);
2845   return bqe;
2846 }
2847 #else
2848 inline StgTSO *
2849 unblockOne(StgTSO *tso)
2850 {
2851   ACQUIRE_LOCK(&sched_mutex);
2852   tso = unblockOneLocked(tso);
2853   RELEASE_LOCK(&sched_mutex);
2854   return tso;
2855 }
2856 #endif
2857
2858 #if defined(GRAN)
2859 void
2860 awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node)
2861 {
2862   StgBlockingQueueElement *bqe;
2863   PEs node_loc;
2864   nat len = 0;
2865
2866   IF_GRAN_DEBUG(bq,
2867                 belch("##-_ AwBQ for node %p on PE %d @ %ld by TSO %d (%p): ", \
2868                       node, CurrentProc, CurrentTime[CurrentProc],
2869                       CurrentTSO->id, CurrentTSO));
2870
2871   node_loc = where_is(node);
2872
2873   ASSERT(q == END_BQ_QUEUE ||
2874          get_itbl(q)->type == TSO ||   // q is either a TSO or an RBHSave
2875          get_itbl(q)->type == CONSTR); // closure (type constructor)
2876   ASSERT(is_unique(node));
2877
2878   /* FAKE FETCH: magically copy the node to the tso's proc;
2879      no Fetch necessary because in reality the node should not have been
2880      moved to the other PE in the first place
2881   */
2882   if (CurrentProc!=node_loc) {
2883     IF_GRAN_DEBUG(bq,
2884                   belch("## node %p is on PE %d but CurrentProc is %d (TSO %d); assuming fake fetch and adjusting bitmask (old: %#x)",
2885                         node, node_loc, CurrentProc, CurrentTSO->id,
2886                         // CurrentTSO, where_is(CurrentTSO),
2887                         node->header.gran.procs));
2888     node->header.gran.procs = (node->header.gran.procs) | PE_NUMBER(CurrentProc);
2889     IF_GRAN_DEBUG(bq,
2890                   belch("## new bitmask of node %p is %#x",
2891                         node, node->header.gran.procs));
2892     if (RtsFlags.GranFlags.GranSimStats.Global) {
2893       globalGranStats.tot_fake_fetches++;
2894     }
2895   }
2896
2897   bqe = q;
2898   // ToDo: check: ASSERT(CurrentProc==node_loc);
2899   while (get_itbl(bqe)->type==TSO) { // q != END_TSO_QUEUE) {
2900     //next = bqe->link;
2901     /*
2902        bqe points to the current element in the queue
2903        next points to the next element in the queue
2904     */
2905     //tso = (StgTSO *)bqe;  // wastes an assignment to get the type right
2906     //tso_loc = where_is(tso);
2907     len++;
2908     bqe = unblockOneLocked(bqe, node);
2909   }
2910
2911   /* if this is the BQ of an RBH, we have to put back the info ripped out of
2912      the closure to make room for the anchor of the BQ */
2913   if (bqe!=END_BQ_QUEUE) {
2914     ASSERT(get_itbl(node)->type == RBH && get_itbl(bqe)->type == CONSTR);
2915     /*
2916     ASSERT((info_ptr==&RBH_Save_0_info) ||
2917            (info_ptr==&RBH_Save_1_info) ||
2918            (info_ptr==&RBH_Save_2_info));
2919     */
2920     /* cf. convertToRBH in RBH.c for writing the RBHSave closure */
2921     ((StgRBH *)node)->blocking_queue = (StgBlockingQueueElement *)((StgRBHSave *)bqe)->payload[0];
2922     ((StgRBH *)node)->mut_link       = (StgMutClosure *)((StgRBHSave *)bqe)->payload[1];
2923
2924     IF_GRAN_DEBUG(bq,
2925                   belch("## Filled in RBH_Save for %p (%s) at end of AwBQ",
2926                         node, info_type(node)));
2927   }
2928
2929   /* statistics gathering */
2930   if (RtsFlags.GranFlags.GranSimStats.Global) {
2931     // globalGranStats.tot_bq_processing_time += bq_processing_time;
2932     globalGranStats.tot_bq_len += len;      // total length of all bqs awakened
2933     // globalGranStats.tot_bq_len_local += len_local;  // same for local TSOs only
2934     globalGranStats.tot_awbq++;             // total no. of bqs awakened
2935   }
2936   IF_GRAN_DEBUG(bq,
2937                 fprintf(stderr,"## BQ Stats of %p: [%d entries] %s\n",
2938                         node, len, (bqe!=END_BQ_QUEUE) ? "RBH" : ""));
2939 }
2940 #elif defined(PAR)
2941 void
2942 awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node)
2943 {
2944   StgBlockingQueueElement *bqe;
2945
2946   ACQUIRE_LOCK(&sched_mutex);
2947
2948   IF_PAR_DEBUG(verbose,
2949                belch("##-_ AwBQ for node %p on [%x]: ",
2950                      node, mytid));
2951 #ifdef DIST
2952   //RFP
2953   if(get_itbl(q)->type == CONSTR || q==END_BQ_QUEUE) {
2954     IF_PAR_DEBUG(verbose, belch("## ... nothing to unblock so lets just return. RFP (BUG?)"));
2955     return;
2956   }
2957 #endif
2958
2959   ASSERT(q == END_BQ_QUEUE ||
2960          get_itbl(q)->type == TSO ||
2961          get_itbl(q)->type == BLOCKED_FETCH ||
2962          get_itbl(q)->type == CONSTR);
2963
2964   bqe = q;
2965   while (get_itbl(bqe)->type==TSO ||
2966          get_itbl(bqe)->type==BLOCKED_FETCH) {
2967     bqe = unblockOneLocked(bqe, node);
2968   }
2969   RELEASE_LOCK(&sched_mutex);
2970 }
2971
2972 #else   /* !GRAN && !PAR */
2973
2974 #ifdef RTS_SUPPORTS_THREADS
2975 void
2976 awakenBlockedQueueNoLock(StgTSO *tso)
2977 {
2978   while (tso != END_TSO_QUEUE) {
2979     tso = unblockOneLocked(tso);
2980   }
2981 }
2982 #endif
2983
2984 void
2985 awakenBlockedQueue(StgTSO *tso)
2986 {
2987   ACQUIRE_LOCK(&sched_mutex);
2988   while (tso != END_TSO_QUEUE) {
2989     tso = unblockOneLocked(tso);
2990   }
2991   RELEASE_LOCK(&sched_mutex);
2992 }
2993 #endif
2994
2995 //@node Exception Handling Routines, Debugging Routines, Blocking Queue Routines, Main scheduling code
2996 //@subsection Exception Handling Routines
2997
2998 /* ---------------------------------------------------------------------------
2999    Interrupt execution
3000    - usually called inside a signal handler so it mustn't do anything fancy.
3001    ------------------------------------------------------------------------ */
3002
3003 void
3004 interruptStgRts(void)
3005 {
3006     interrupted    = 1;
3007     context_switch = 1;
3008 }
3009
3010 /* -----------------------------------------------------------------------------
3011    Unblock a thread
3012
3013    This is for use when we raise an exception in another thread, which
3014    may be blocked.
3015    This has nothing to do with the UnblockThread event in GranSim. -- HWL
3016    -------------------------------------------------------------------------- */
3017
3018 #if defined(GRAN) || defined(PAR)
3019 /*
3020   NB: only the type of the blocking queue is different in GranSim and GUM
3021       the operations on the queue-elements are the same
3022       long live polymorphism!
3023
3024   Locks: sched_mutex is held upon entry and exit.
3025
3026 */
3027 static void
3028 unblockThread(StgTSO *tso)
3029 {
3030   StgBlockingQueueElement *t, **last;
3031
3032   switch (tso->why_blocked) {
3033
3034   case NotBlocked:
3035     return;  /* not blocked */
3036
3037   case BlockedOnMVar:
3038     ASSERT(get_itbl(tso->block_info.closure)->type == MVAR);
3039     {
3040       StgBlockingQueueElement *last_tso = END_BQ_QUEUE;
3041       StgMVar *mvar = (StgMVar *)(tso->block_info.closure);
3042
3043       last = (StgBlockingQueueElement **)&mvar->head;
3044       for (t = (StgBlockingQueueElement *)mvar->head;
3045            t != END_BQ_QUEUE;
3046            last = &t->link, last_tso = t, t = t->link) {
3047         if (t == (StgBlockingQueueElement *)tso) {
3048           *last = (StgBlockingQueueElement *)tso->link;
3049           if (mvar->tail == tso) {
3050             mvar->tail = (StgTSO *)last_tso;
3051           }
3052           goto done;
3053         }
3054       }
3055       barf("unblockThread (MVAR): TSO not found");
3056     }
3057
3058   case BlockedOnBlackHole:
3059     ASSERT(get_itbl(tso->block_info.closure)->type == BLACKHOLE_BQ);
3060     {
3061       StgBlockingQueue *bq = (StgBlockingQueue *)(tso->block_info.closure);
3062
3063       last = &bq->blocking_queue;
3064       for (t = bq->blocking_queue;
3065            t != END_BQ_QUEUE;
3066            last = &t->link, t = t->link) {
3067         if (t == (StgBlockingQueueElement *)tso) {
3068           *last = (StgBlockingQueueElement *)tso->link;
3069           goto done;
3070         }
3071       }
3072       barf("unblockThread (BLACKHOLE): TSO not found");
3073     }
3074
3075   case BlockedOnException:
3076     {
3077       StgTSO *target  = tso->block_info.tso;
3078
3079       ASSERT(get_itbl(target)->type == TSO);
3080
3081       if (target->what_next == ThreadRelocated) {
3082           target = target->link;
3083           ASSERT(get_itbl(target)->type == TSO);
3084       }
3085
3086       ASSERT(target->blocked_exceptions != NULL);
3087
3088       last = (StgBlockingQueueElement **)&target->blocked_exceptions;
3089       for (t = (StgBlockingQueueElement *)target->blocked_exceptions;
3090            t != END_BQ_QUEUE;
3091            last = &t->link, t = t->link) {
3092         ASSERT(get_itbl(t)->type == TSO);
3093         if (t == (StgBlockingQueueElement *)tso) {
3094           *last = (StgBlockingQueueElement *)tso->link;
3095           goto done;
3096         }
3097       }
3098       barf("unblockThread (Exception): TSO not found");
3099     }
3100
3101   case BlockedOnRead:
3102   case BlockedOnWrite:
3103     {
3104       /* take TSO off blocked_queue */
3105       StgBlockingQueueElement *prev = NULL;
3106       for (t = (StgBlockingQueueElement *)blocked_queue_hd; t != END_BQ_QUEUE;
3107            prev = t, t = t->link) {
3108         if (t == (StgBlockingQueueElement *)tso) {
3109           if (prev == NULL) {
3110             blocked_queue_hd = (StgTSO *)t->link;
3111             if ((StgBlockingQueueElement *)blocked_queue_tl == t) {
3112               blocked_queue_tl = END_TSO_QUEUE;
3113             }
3114           } else {
3115             prev->link = t->link;
3116             if ((StgBlockingQueueElement *)blocked_queue_tl == t) {
3117               blocked_queue_tl = (StgTSO *)prev;
3118             }
3119           }
3120           goto done;
3121         }
3122       }
3123       barf("unblockThread (I/O): TSO not found");
3124     }
3125
3126   case BlockedOnDelay:
3127     {
3128       /* take TSO off sleeping_queue */
3129       StgBlockingQueueElement *prev = NULL;
3130       for (t = (StgBlockingQueueElement *)sleeping_queue; t != END_BQ_QUEUE;
3131            prev = t, t = t->link) {
3132         if (t == (StgBlockingQueueElement *)tso) {
3133           if (prev == NULL) {
3134             sleeping_queue = (StgTSO *)t->link;
3135           } else {
3136             prev->link = t->link;
3137           }
3138           goto done;
3139         }
3140       }
3141       barf("unblockThread (I/O): TSO not found");
3142     }
3143
3144   default:
3145     barf("unblockThread");
3146   }
3147
3148  done:
3149   tso->link = END_TSO_QUEUE;
3150   tso->why_blocked = NotBlocked;
3151   tso->block_info.closure = NULL;
3152   PUSH_ON_RUN_QUEUE(tso);
3153 }
3154 #else
3155 static void
3156 unblockThread(StgTSO *tso)
3157 {
3158   StgTSO *t, **last;
3159
3160   /* To avoid locking unnecessarily. */
3161   if (tso->why_blocked == NotBlocked) {
3162     return;
3163   }
3164
3165   switch (tso->why_blocked) {
3166
3167   case BlockedOnMVar:
3168     ASSERT(get_itbl(tso->block_info.closure)->type == MVAR);
3169     {
3170       StgTSO *last_tso = END_TSO_QUEUE;
3171       StgMVar *mvar = (StgMVar *)(tso->block_info.closure);
3172
3173       last = &mvar->head;
3174       for (t = mvar->head; t != END_TSO_QUEUE;
3175            last = &t->link, last_tso = t, t = t->link) {
3176         if (t == tso) {
3177           *last = tso->link;
3178           if (mvar->tail == tso) {
3179             mvar->tail = last_tso;
3180           }
3181           goto done;
3182         }
3183       }
3184       barf("unblockThread (MVAR): TSO not found");
3185     }
3186
3187   case BlockedOnBlackHole:
3188     ASSERT(get_itbl(tso->block_info.closure)->type == BLACKHOLE_BQ);
3189     {
3190       StgBlockingQueue *bq = (StgBlockingQueue *)(tso->block_info.closure);
3191
3192       last = &bq->blocking_queue;
3193       for (t = bq->blocking_queue; t != END_TSO_QUEUE;
3194            last = &t->link, t = t->link) {
3195         if (t == tso) {
3196           *last = tso->link;
3197           goto done;
3198         }
3199       }
3200       barf("unblockThread (BLACKHOLE): TSO not found");
3201     }
3202
3203   case BlockedOnException:
3204     {
3205       StgTSO *target  = tso->block_info.tso;
3206
3207       ASSERT(get_itbl(target)->type == TSO);
3208
3209       while (target->what_next == ThreadRelocated) {
3210           target = target->link;
3211           ASSERT(get_itbl(target)->type == TSO);
3212       }
3213
3214       ASSERT(target->blocked_exceptions != NULL);
3215
3216       last = &target->blocked_exceptions;
3217       for (t = target->blocked_exceptions; t != END_TSO_QUEUE;
3218            last = &t->link, t = t->link) {
3219         ASSERT(get_itbl(t)->type == TSO);
3220         if (t == tso) {
3221           *last = tso->link;
3222           goto done;
3223         }
3224       }
3225       barf("unblockThread (Exception): TSO not found");
3226     }
3227
3228   case BlockedOnRead:
3229   case BlockedOnWrite:
3230     {
3231       StgTSO *prev = NULL;
3232       for (t = blocked_queue_hd; t != END_TSO_QUEUE;
3233            prev = t, t = t->link) {
3234         if (t == tso) {
3235           if (prev == NULL) {
3236             blocked_queue_hd = t->link;
3237             if (blocked_queue_tl == t) {
3238               blocked_queue_tl = END_TSO_QUEUE;
3239             }
3240           } else {
3241             prev->link = t->link;
3242             if (blocked_queue_tl == t) {
3243               blocked_queue_tl = prev;
3244             }
3245           }
3246           goto done;
3247         }
3248       }
3249       barf("unblockThread (I/O): TSO not found");
3250     }
3251
3252   case BlockedOnDelay:
3253     {
3254       StgTSO *prev = NULL;
3255       for (t = sleeping_queue; t != END_TSO_QUEUE;
3256            prev = t, t = t->link) {
3257         if (t == tso) {
3258           if (prev == NULL) {
3259             sleeping_queue = t->link;
3260           } else {
3261             prev->link = t->link;
3262           }
3263           goto done;
3264         }
3265       }
3266       barf("unblockThread (I/O): TSO not found");
3267     }
3268
3269   default:
3270     barf("unblockThread");
3271   }
3272
3273  done:
3274   tso->link = END_TSO_QUEUE;
3275   tso->why_blocked = NotBlocked;
3276   tso->block_info.closure = NULL;
3277   PUSH_ON_RUN_QUEUE(tso);
3278 }
3279 #endif
3280
3281 /* -----------------------------------------------------------------------------
3282  * raiseAsync()
3283  *
3284  * The following function implements the magic for raising an
3285  * asynchronous exception in an existing thread.
3286  *
3287  * We first remove the thread from any queue on which it might be
3288  * blocked.  The possible blockages are MVARs and BLACKHOLE_BQs.
3289  *
3290  * We strip the stack down to the innermost CATCH_FRAME, building
3291  * thunks in the heap for all the active computations, so they can
3292  * be restarted if necessary.  When we reach a CATCH_FRAME, we build
3293  * an application of the handler to the exception, and push it on
3294  * the top of the stack.
3295  *
3296  * How exactly do we save all the active computations?  We create an
3297  * AP_STACK for every UpdateFrame on the stack.  Entering one of these
3298  * AP_STACKs pushes everything from the corresponding update frame
3299  * upwards onto the stack.  (Actually, it pushes everything up to the
3300  * next update frame plus a pointer to the next AP_STACK object.
3301  * Entering the next AP_STACK object pushes more onto the stack until we
3302  * reach the last AP_STACK object - at which point the stack should look
3303  * exactly as it did when we killed the TSO and we can continue
3304  * execution by entering the closure on top of the stack.
3305  *
3306  * We can also kill a thread entirely - this happens if either (a) the
3307  * exception passed to raiseAsync is NULL, or (b) there's no
3308  * CATCH_FRAME on the stack.  In either case, we strip the entire
3309  * stack and replace the thread with a zombie.
3310  *
3311  * Locks: sched_mutex held upon entry nor exit.
3312  *
3313  * -------------------------------------------------------------------------- */
3314
3315 void
3316 deleteThread(StgTSO *tso)
3317 {
3318   raiseAsync(tso,NULL);
3319 }
3320
3321 void
3322 raiseAsyncWithLock(StgTSO *tso, StgClosure *exception)
3323 {
3324   /* When raising async exs from contexts where sched_mutex isn't held;
3325      use raiseAsyncWithLock(). */
3326   ACQUIRE_LOCK(&sched_mutex);
3327   raiseAsync(tso,exception);
3328   RELEASE_LOCK(&sched_mutex);
3329 }
3330
3331 void
3332 raiseAsync(StgTSO *tso, StgClosure *exception)
3333 {
3334     StgRetInfoTable *info;
3335     StgPtr sp;
3336
3337     // Thread already dead?
3338     if (tso->what_next == ThreadComplete || tso->what_next == ThreadKilled) {
3339         return;
3340     }
3341
3342     IF_DEBUG(scheduler,
3343              sched_belch("raising exception in thread %ld.", tso->id));
3344
3345     // Remove it from any blocking queues
3346     unblockThread(tso);
3347
3348     sp = tso->sp;
3349
3350     // The stack freezing code assumes there's a closure pointer on
3351     // the top of the stack, so we have to arrange that this is the case...
3352     //
3353     if (sp[0] == (W_)&stg_enter_info) {
3354         sp++;
3355     } else {
3356         sp--;
3357         sp[0] = (W_)&stg_dummy_ret_closure;
3358     }
3359
3360     while (1) {
3361         nat i;
3362
3363         // 1. Let the top of the stack be the "current closure"
3364         //
3365         // 2. Walk up the stack until we find either an UPDATE_FRAME or a
3366         // CATCH_FRAME.
3367         //
3368         // 3. If it's an UPDATE_FRAME, then make an AP_STACK containing the
3369         // current closure applied to the chunk of stack up to (but not
3370         // including) the update frame.  This closure becomes the "current
3371         // closure".  Go back to step 2.
3372         //
3373         // 4. If it's a CATCH_FRAME, then leave the exception handler on
3374         // top of the stack applied to the exception.
3375         //
3376         // 5. If it's a STOP_FRAME, then kill the thread.
3377
3378         StgPtr frame;
3379
3380         frame = sp + 1;
3381         info = get_ret_itbl((StgClosure *)frame);
3382
3383         while (info->i.type != UPDATE_FRAME
3384                && (info->i.type != CATCH_FRAME || exception == NULL)
3385                && info->i.type != STOP_FRAME) {
3386             frame += stack_frame_sizeW((StgClosure *)frame);
3387             info = get_ret_itbl((StgClosure *)frame);
3388         }
3389
3390         switch (info->i.type) {
3391
3392         case CATCH_FRAME:
3393             // If we find a CATCH_FRAME, and we've got an exception to raise,
3394             // then build the THUNK raise(exception), and leave it on
3395             // top of the CATCH_FRAME ready to enter.
3396             //
3397         {
3398 #ifdef PROFILING
3399             StgCatchFrame *cf = (StgCatchFrame *)frame;
3400 #endif
3401             StgClosure *raise;
3402
3403             // we've got an exception to raise, so let's pass it to the
3404             // handler in this frame.
3405             //
3406             raise = (StgClosure *)allocate(sizeofW(StgClosure)+1);
3407             TICK_ALLOC_SE_THK(1,0);
3408             SET_HDR(raise,&stg_raise_info,cf->header.prof.ccs);
3409             raise->payload[0] = exception;
3410
3411             // throw away the stack from Sp up to the CATCH_FRAME.
3412             //
3413             sp = frame - 1;
3414
3415             /* Ensure that async excpetions are blocked now, so we don't get
3416              * a surprise exception before we get around to executing the
3417              * handler.
3418              */
3419             if (tso->blocked_exceptions == NULL) {
3420                 tso->blocked_exceptions = END_TSO_QUEUE;
3421             }
3422
3423             /* Put the newly-built THUNK on top of the stack, ready to execute
3424              * when the thread restarts.
3425              */
3426             sp[0] = (W_)raise;
3427             sp[-1] = (W_)&stg_enter_info;
3428             tso->sp = sp-1;
3429             tso->what_next = ThreadRunGHC;
3430             IF_DEBUG(sanity, checkTSO(tso));
3431             return;
3432         }
3433
3434         case UPDATE_FRAME:
3435         {
3436             StgAP_STACK * ap;
3437             nat words;
3438
3439             // First build an AP_STACK consisting of the stack chunk above the
3440             // current update frame, with the top word on the stack as the
3441             // fun field.
3442             //
3443             words = frame - sp - 1;
3444             ap = (StgAP_STACK *)allocate(PAP_sizeW(words));
3445
3446             ap->size = words;
3447             ap->fun  = (StgClosure *)sp[0];
3448             sp++;
3449             for(i=0; i < (nat)words; ++i) {
3450                 ap->payload[i] = (StgClosure *)*sp++;
3451             }
3452
3453             SET_HDR(ap,&stg_AP_STACK_info,
3454                     ((StgClosure *)frame)->header.prof.ccs /* ToDo */);
3455             TICK_ALLOC_UP_THK(words+1,0);
3456
3457             IF_DEBUG(scheduler,
3458                      fprintf(stderr,  "scheduler: Updating ");
3459                      printPtr((P_)((StgUpdateFrame *)frame)->updatee);
3460                      fprintf(stderr,  " with ");
3461                      printObj((StgClosure *)ap);
3462                 );
3463
3464             // Replace the updatee with an indirection - happily
3465             // this will also wake up any threads currently
3466             // waiting on the result.
3467             //
3468             // Warning: if we're in a loop, more than one update frame on
3469             // the stack may point to the same object.  Be careful not to
3470             // overwrite an IND_OLDGEN in this case, because we'll screw
3471             // up the mutable lists.  To be on the safe side, don't
3472             // overwrite any kind of indirection at all.  See also
3473             // threadSqueezeStack in GC.c, where we have to make a similar
3474             // check.
3475             //
3476             if (!closure_IND(((StgUpdateFrame *)frame)->updatee)) {
3477                 // revert the black hole
3478                 UPD_IND_NOLOCK(((StgUpdateFrame *)frame)->updatee,ap);
3479             }
3480             sp += sizeofW(StgUpdateFrame) - 1;
3481             sp[0] = (W_)ap; // push onto stack
3482             break;
3483         }
3484
3485         case STOP_FRAME:
3486             // We've stripped the entire stack, the thread is now dead.
3487             sp += sizeofW(StgStopFrame);
3488             tso->what_next = ThreadKilled;
3489             tso->sp = sp;
3490             return;
3491
3492         default:
3493             barf("raiseAsync");
3494         }
3495     }
3496     barf("raiseAsync");
3497 }
3498
3499 /* -----------------------------------------------------------------------------
3500    resurrectThreads is called after garbage collection on the list of
3501    threads found to be garbage.  Each of these threads will be woken
3502    up and sent a signal: BlockedOnDeadMVar if the thread was blocked
3503    on an MVar, or NonTermination if the thread was blocked on a Black
3504    Hole.
3505
3506    Locks: sched_mutex isn't held upon entry nor exit.
3507    -------------------------------------------------------------------------- */
3508
3509 void
3510 resurrectThreads( StgTSO *threads )
3511 {
3512   StgTSO *tso, *next;
3513
3514   for (tso = threads; tso != END_TSO_QUEUE; tso = next) {
3515     next = tso->global_link;
3516     tso->global_link = all_threads;
3517     all_threads = tso;
3518     IF_DEBUG(scheduler, sched_belch("resurrecting thread %d", tso->id));
3519
3520     switch (tso->why_blocked) {
3521     case BlockedOnMVar:
3522     case BlockedOnException:
3523       /* Called by GC - sched_mutex lock is currently held. */
3524       raiseAsync(tso,(StgClosure *)BlockedOnDeadMVar_closure);
3525       break;
3526     case BlockedOnBlackHole:
3527       raiseAsync(tso,(StgClosure *)NonTermination_closure);
3528       break;
3529     case NotBlocked:
3530       /* This might happen if the thread was blocked on a black hole
3531        * belonging to a thread that we've just woken up (raiseAsync
3532        * can wake up threads, remember...).
3533        */
3534       continue;
3535     default:
3536       barf("resurrectThreads: thread blocked in a strange way");
3537     }
3538   }
3539 }
3540
3541 /* -----------------------------------------------------------------------------
3542  * Blackhole detection: if we reach a deadlock, test whether any
3543  * threads are blocked on themselves.  Any threads which are found to
3544  * be self-blocked get sent a NonTermination exception.
3545  *
3546  * This is only done in a deadlock situation in order to avoid
3547  * performance overhead in the normal case.
3548  *
3549  * Locks: sched_mutex is held upon entry and exit.
3550  * -------------------------------------------------------------------------- */
3551
3552 static void
3553 detectBlackHoles( void )
3554 {
3555     StgTSO *tso = all_threads;
3556     StgClosure *frame;
3557     StgClosure *blocked_on;
3558     StgRetInfoTable *info;
3559
3560     for (tso = all_threads; tso != END_TSO_QUEUE; tso = tso->global_link) {
3561
3562         while (tso->what_next == ThreadRelocated) {
3563             tso = tso->link;
3564             ASSERT(get_itbl(tso)->type == TSO);
3565         }
3566
3567         if (tso->why_blocked != BlockedOnBlackHole) {
3568             continue;
3569         }
3570         blocked_on = tso->block_info.closure;
3571
3572         frame = (StgClosure *)tso->sp;
3573
3574         while(1) {
3575             info = get_ret_itbl(frame);
3576             switch (info->i.type) {
3577             case UPDATE_FRAME:
3578                 if (((StgUpdateFrame *)frame)->updatee == blocked_on) {
3579                     /* We are blocking on one of our own computations, so
3580                      * send this thread the NonTermination exception.
3581                      */
3582                     IF_DEBUG(scheduler,
3583                              sched_belch("thread %d is blocked on itself", tso->id));
3584                     raiseAsync(tso, (StgClosure *)NonTermination_closure);
3585                     goto done;
3586                 }
3587
3588                 frame = (StgClosure *) ((StgUpdateFrame *)frame + 1);
3589                 continue;
3590
3591             case STOP_FRAME:
3592                 goto done;
3593
3594                 // normal stack frames; do nothing except advance the pointer
3595             default:
3596                 (StgPtr)frame += stack_frame_sizeW(frame);
3597             }
3598         }
3599         done: ;
3600     }
3601 }
3602
3603 //@node Debugging Routines, Index, Exception Handling Routines, Main scheduling code
3604 //@subsection Debugging Routines
3605
3606 /* -----------------------------------------------------------------------------
3607  * Debugging: why is a thread blocked
3608  * [Also provides useful information when debugging threaded programs
3609  *  at the Haskell source code level, so enable outside of DEBUG. --sof 7/02]
3610    -------------------------------------------------------------------------- */
3611
3612 static
3613 void
3614 printThreadBlockage(StgTSO *tso)
3615 {
3616   switch (tso->why_blocked) {
3617   case BlockedOnRead:
3618     fprintf(stderr,"is blocked on read from fd %d", tso->block_info.fd);
3619     break;
3620   case BlockedOnWrite:
3621     fprintf(stderr,"is blocked on write to fd %d", tso->block_info.fd);
3622     break;
3623   case BlockedOnDelay:
3624     fprintf(stderr,"is blocked until %d", tso->block_info.target);
3625     break;
3626   case BlockedOnMVar:
3627     fprintf(stderr,"is blocked on an MVar");
3628     break;
3629   case BlockedOnException:
3630     fprintf(stderr,"is blocked on delivering an exception to thread %d",
3631             tso->block_info.tso->id);
3632     break;
3633   case BlockedOnBlackHole:
3634     fprintf(stderr,"is blocked on a black hole");
3635     break;
3636   case NotBlocked:
3637     fprintf(stderr,"is not blocked");
3638     break;
3639 #if defined(PAR)
3640   case BlockedOnGA:
3641     fprintf(stderr,"is blocked on global address; local FM_BQ is %p (%s)",
3642             tso->block_info.closure, info_type(tso->block_info.closure));
3643     break;
3644   case BlockedOnGA_NoSend:
3645     fprintf(stderr,"is blocked on global address (no send); local FM_BQ is %p (%s)",
3646             tso->block_info.closure, info_type(tso->block_info.closure));
3647     break;
3648 #endif
3649 #if defined(RTS_SUPPORTS_THREADS)
3650   case BlockedOnCCall:
3651     fprintf(stderr,"is blocked on an external call");
3652     break;
3653   case BlockedOnCCall_NoUnblockExc:
3654     fprintf(stderr,"is blocked on an external call (exceptions were already blocked)");
3655     break;
3656 #endif
3657   default:
3658     barf("printThreadBlockage: strange tso->why_blocked: %d for TSO %d (%d)",
3659          tso->why_blocked, tso->id, tso);
3660   }
3661 }
3662
3663 static
3664 void
3665 printThreadStatus(StgTSO *tso)
3666 {
3667   switch (tso->what_next) {
3668   case ThreadKilled:
3669     fprintf(stderr,"has been killed");
3670     break;
3671   case ThreadComplete:
3672     fprintf(stderr,"has completed");
3673     break;
3674   default:
3675     printThreadBlockage(tso);
3676   }
3677 }
3678
3679 void
3680 printAllThreads(void)
3681 {
3682   StgTSO *t;
3683   void *label;
3684
3685 # if defined(GRAN)
3686   char time_string[TIME_STR_LEN], node_str[NODE_STR_LEN];
3687   ullong_format_string(TIME_ON_PROC(CurrentProc),
3688                        time_string, rtsFalse/*no commas!*/);
3689
3690   fprintf(stderr, "all threads at [%s]:\n", time_string);
3691 # elif defined(PAR)
3692   char time_string[TIME_STR_LEN], node_str[NODE_STR_LEN];
3693   ullong_format_string(CURRENT_TIME,
3694                        time_string, rtsFalse/*no commas!*/);
3695
3696   fprintf(stderr,"all threads at [%s]:\n", time_string);
3697 # else
3698   fprintf(stderr,"all threads:\n");
3699 # endif
3700
3701   for (t = all_threads; t != END_TSO_QUEUE; t = t->global_link) {
3702     fprintf(stderr, "\tthread %d @ %p ", t->id, (void *)t);
3703     label = lookupThreadLabel((StgWord)t);
3704     if (label) fprintf(stderr,"[\"%s\"] ",(char *)label);
3705     printThreadStatus(t);
3706     fprintf(stderr,"\n");
3707   }
3708 }
3709
3710 #ifdef DEBUG
3711
3712 /*
3713    Print a whole blocking queue attached to node (debugging only).
3714 */
3715 //@cindex print_bq
3716 # if defined(PAR)
3717 void
3718 print_bq (StgClosure *node)
3719 {
3720   StgBlockingQueueElement *bqe;
3721   StgTSO *tso;
3722   rtsBool end;
3723
3724   fprintf(stderr,"## BQ of closure %p (%s): ",
3725           node, info_type(node));
3726
3727   /* should cover all closures that may have a blocking queue */
3728   ASSERT(get_itbl(node)->type == BLACKHOLE_BQ ||
3729          get_itbl(node)->type == FETCH_ME_BQ ||
3730          get_itbl(node)->type == RBH ||
3731          get_itbl(node)->type == MVAR);
3732
3733   ASSERT(node!=(StgClosure*)NULL);         // sanity check
3734
3735   print_bqe(((StgBlockingQueue*)node)->blocking_queue);
3736 }
3737
3738 /*
3739    Print a whole blocking queue starting with the element bqe.
3740 */
3741 void
3742 print_bqe (StgBlockingQueueElement *bqe)
3743 {
3744   rtsBool end;
3745
3746   /*
3747      NB: In a parallel setup a BQ of an RBH must end with an RBH_Save closure;
3748   */
3749   for (end = (bqe==END_BQ_QUEUE);
3750        !end; // iterate until bqe points to a CONSTR
3751        end = (get_itbl(bqe)->type == CONSTR) || (bqe->link==END_BQ_QUEUE),
3752        bqe = end ? END_BQ_QUEUE : bqe->link) {
3753     ASSERT(bqe != END_BQ_QUEUE);                               // sanity check
3754     ASSERT(bqe != (StgBlockingQueueElement *)NULL);            // sanity check
3755     /* types of closures that may appear in a blocking queue */
3756     ASSERT(get_itbl(bqe)->type == TSO ||
3757            get_itbl(bqe)->type == BLOCKED_FETCH ||
3758            get_itbl(bqe)->type == CONSTR);
3759     /* only BQs of an RBH end with an RBH_Save closure */
3760     //ASSERT(get_itbl(bqe)->type != CONSTR || get_itbl(node)->type == RBH);
3761
3762     switch (get_itbl(bqe)->type) {
3763     case TSO:
3764       fprintf(stderr," TSO %u (%x),",
3765               ((StgTSO *)bqe)->id, ((StgTSO *)bqe));
3766       break;
3767     case BLOCKED_FETCH:
3768       fprintf(stderr," BF (node=%p, ga=((%x, %d, %x)),",
3769               ((StgBlockedFetch *)bqe)->node,
3770               ((StgBlockedFetch *)bqe)->ga.payload.gc.gtid,
3771               ((StgBlockedFetch *)bqe)->ga.payload.gc.slot,
3772               ((StgBlockedFetch *)bqe)->ga.weight);
3773       break;
3774     case CONSTR:
3775       fprintf(stderr," %s (IP %p),",
3776               (get_itbl(bqe) == &stg_RBH_Save_0_info ? "RBH_Save_0" :
3777                get_itbl(bqe) == &stg_RBH_Save_1_info ? "RBH_Save_1" :
3778                get_itbl(bqe) == &stg_RBH_Save_2_info ? "RBH_Save_2" :
3779                "RBH_Save_?"), get_itbl(bqe));
3780       break;
3781     default:
3782       barf("Unexpected closure type %s in blocking queue", // of %p (%s)",
3783            info_type((StgClosure *)bqe)); // , node, info_type(node));
3784       break;
3785     }
3786   } /* for */
3787   fputc('\n', stderr);
3788 }
3789 # elif defined(GRAN)
3790 void
3791 print_bq (StgClosure *node)
3792 {
3793   StgBlockingQueueElement *bqe;
3794   PEs node_loc, tso_loc;
3795   rtsBool end;
3796
3797   /* should cover all closures that may have a blocking queue */
3798   ASSERT(get_itbl(node)->type == BLACKHOLE_BQ ||
3799          get_itbl(node)->type == FETCH_ME_BQ ||
3800          get_itbl(node)->type == RBH);
3801
3802   ASSERT(node!=(StgClosure*)NULL);         // sanity check
3803   node_loc = where_is(node);
3804
3805   fprintf(stderr,"## BQ of closure %p (%s) on [PE %d]: ",
3806           node, info_type(node), node_loc);
3807
3808   /*
3809      NB: In a parallel setup a BQ of an RBH must end with an RBH_Save closure;
3810   */
3811   for (bqe = ((StgBlockingQueue*)node)->blocking_queue, end = (bqe==END_BQ_QUEUE);
3812        !end; // iterate until bqe points to a CONSTR
3813        end = (get_itbl(bqe)->type == CONSTR) || (bqe->link==END_BQ_QUEUE), bqe = end ? END_BQ_QUEUE : bqe->link) {
3814     ASSERT(bqe != END_BQ_QUEUE);             // sanity check
3815     ASSERT(bqe != (StgBlockingQueueElement *)NULL);  // sanity check
3816     /* types of closures that may appear in a blocking queue */
3817     ASSERT(get_itbl(bqe)->type == TSO ||
3818            get_itbl(bqe)->type == CONSTR);
3819     /* only BQs of an RBH end with an RBH_Save closure */
3820     ASSERT(get_itbl(bqe)->type != CONSTR || get_itbl(node)->type == RBH);
3821
3822     tso_loc = where_is((StgClosure *)bqe);
3823     switch (get_itbl(bqe)->type) {
3824     case TSO:
3825       fprintf(stderr," TSO %d (%p) on [PE %d],",
3826               ((StgTSO *)bqe)->id, (StgTSO *)bqe, tso_loc);
3827       break;
3828     case CONSTR:
3829       fprintf(stderr," %s (IP %p),",
3830               (get_itbl(bqe) == &stg_RBH_Save_0_info ? "RBH_Save_0" :
3831                get_itbl(bqe) == &stg_RBH_Save_1_info ? "RBH_Save_1" :
3832                get_itbl(bqe) == &stg_RBH_Save_2_info ? "RBH_Save_2" :
3833                "RBH_Save_?"), get_itbl(bqe));
3834       break;
3835     default:
3836       barf("Unexpected closure type %s in blocking queue of %p (%s)",
3837            info_type((StgClosure *)bqe), node, info_type(node));
3838       break;
3839     }
3840   } /* for */
3841   fputc('\n', stderr);
3842 }
3843 #else
3844 /*
3845    Nice and easy: only TSOs on the blocking queue
3846 */
3847 void
3848 print_bq (StgClosure *node)
3849 {
3850   StgTSO *tso;
3851
3852   ASSERT(node!=(StgClosure*)NULL);         // sanity check
3853   for (tso = ((StgBlockingQueue*)node)->blocking_queue;
3854        tso != END_TSO_QUEUE;
3855        tso=tso->link) {
3856     ASSERT(tso!=NULL && tso!=END_TSO_QUEUE);   // sanity check
3857     ASSERT(get_itbl(tso)->type == TSO);  // guess what, sanity check
3858     fprintf(stderr," TSO %d (%p),", tso->id, tso);
3859   }
3860   fputc('\n', stderr);
3861 }
3862 # endif
3863
3864 #if defined(PAR)
3865 static nat
3866 run_queue_len(void)
3867 {
3868   nat i;
3869   StgTSO *tso;
3870
3871   for (i=0, tso=run_queue_hd;
3872        tso != END_TSO_QUEUE;
3873        i++, tso=tso->link)
3874     /* nothing */
3875
3876   return i;
3877 }
3878 #endif
3879
3880 static void
3881 sched_belch(char *s, ...)
3882 {
3883   va_list ap;
3884   va_start(ap,s);
3885 #ifdef SMP
3886   fprintf(stderr, "scheduler (task %ld): ", osThreadId());
3887 #elif defined(PAR)
3888   fprintf(stderr, "== ");
3889 #else
3890   fprintf(stderr, "scheduler: ");
3891 #endif
3892   vfprintf(stderr, s, ap);
3893   fprintf(stderr, "\n");
3894   va_end(ap);
3895 }
3896
3897 #endif /* DEBUG */
3898
3899
3900 //@node Index,  , Debugging Routines, Main scheduling code
3901 //@subsection Index
3902
3903 //@index
3904 //* StgMainThread::  @cindex\s-+StgMainThread
3905 //* awaken_blocked_queue::  @cindex\s-+awaken_blocked_queue
3906 //* blocked_queue_hd::  @cindex\s-+blocked_queue_hd
3907 //* blocked_queue_tl::  @cindex\s-+blocked_queue_tl
3908 //* context_switch::  @cindex\s-+context_switch
3909 //* createThread::  @cindex\s-+createThread
3910 //* gc_pending_cond::  @cindex\s-+gc_pending_cond
3911 //* initScheduler::  @cindex\s-+initScheduler
3912 //* interrupted::  @cindex\s-+interrupted
3913 //* next_thread_id::  @cindex\s-+next_thread_id
3914 //* print_bq::  @cindex\s-+print_bq
3915 //* run_queue_hd::  @cindex\s-+run_queue_hd
3916 //* run_queue_tl::  @cindex\s-+run_queue_tl
3917 //* sched_mutex::  @cindex\s-+sched_mutex
3918 //* schedule::  @cindex\s-+schedule
3919 //* take_off_run_queue::  @cindex\s-+take_off_run_queue
3920 //* term_mutex::  @cindex\s-+term_mutex
3921 //@end index