ghc/rts/Schedule.c

   1 /* ---------------------------------------------------------------------------
   2  * $Id: Schedule.c,v 1.75 2000/08/15 11:48:06 simonmar Exp $
   3  *
   4  * (c) The GHC Team, 1998-2000
   5  *
   6  * Scheduler
   7  *
   8  * The main scheduling code in GranSim is quite different from that in std
   9  * (concurrent) Haskell: while concurrent Haskell just iterates over the
  10  * threads in the runnable queue, GranSim is event driven, i.e. it iterates
  11  * over the events in the global event queue.  -- HWL
  12  * --------------------------------------------------------------------------*/
  13
  14 //@node Main scheduling code, , ,
  15 //@section Main scheduling code
  16
  17 /* Version with scheduler monitor support for SMPs.
  18
  19    This design provides a high-level API to create and schedule threads etc.
  20    as documented in the SMP design document.
  21
  22    It uses a monitor design controlled by a single mutex to exercise control
  23    over accesses to shared data structures, and builds on the Posix threads
  24    library.
  25
  26    The majority of state is shared.  In order to keep essential per-task state,
  27    there is a Capability structure, which contains all the information
  28    needed to run a thread: its STG registers, a pointer to its TSO, a
  29    nursery etc.  During STG execution, a pointer to the capability is
  30    kept in a register (BaseReg).
  31
  32    In a non-SMP build, there is one global capability, namely MainRegTable.
  33
  34    SDM & KH, 10/99
  35 */
  36
  37 //@menu
  38 //* Includes::
  39 //* Variables and Data structures::
  40 //* Main scheduling loop::
  41 //* Suspend and Resume::
  42 //* Run queue code::
  43 //* Garbage Collextion Routines::
  44 //* Blocking Queue Routines::
  45 //* Exception Handling Routines::
  46 //* Debugging Routines::
  47 //* Index::
  48 //@end menu
  49
  50 //@node Includes, Variables and Data structures, Main scheduling code, Main scheduling code
  51 //@subsection Includes
  52
  53 #include "Rts.h"
  54 #include "SchedAPI.h"
  55 #include "RtsUtils.h"
  56 #include "RtsFlags.h"
  57 #include "Storage.h"
  58 #include "StgRun.h"
  59 #include "StgStartup.h"
  60 #include "GC.h"
  61 #include "Hooks.h"
  62 #include "Schedule.h"
  63 #include "StgMiscClosures.h"
  64 #include "Storage.h"
  65 #include "Evaluator.h"
  66 #include "Exception.h"
  67 #include "Printer.h"
  68 #include "Main.h"
  69 #include "Signals.h"
  70 #include "Sanity.h"
  71 #include "Stats.h"
  72 #include "Itimer.h"
  73 #include "Prelude.h"
  74 #if defined(GRAN) || defined(PAR)
  75 # include "GranSimRts.h"
  76 # include "GranSim.h"
  77 # include "ParallelRts.h"
  78 # include "Parallel.h"
  79 # include "ParallelDebug.h"
  80 # include "FetchMe.h"
  81 # include "HLC.h"
  82 #endif
  83 #include "Sparks.h"
  84
  85 #include <stdarg.h>
  86
  87 //@node Variables and Data structures, Prototypes, Includes, Main scheduling code
  88 //@subsection Variables and Data structures
  89
  90 /* Main threads:
  91  *
  92  * These are the threads which clients have requested that we run.
  93  *
  94  * In an SMP build, we might have several concurrent clients all
  95  * waiting for results, and each one will wait on a condition variable
  96  * until the result is available.
  97  *
  98  * In non-SMP, clients are strictly nested: the first client calls
  99  * into the RTS, which might call out again to C with a _ccall_GC, and
 100  * eventually re-enter the RTS.
 101  *
 102  * Main threads information is kept in a linked list:
 103  */
 104 //@cindex StgMainThread
 105 typedef struct StgMainThread_ {
 106   StgTSO *         tso;
 107   SchedulerStatus  stat;
 108   StgClosure **    ret;
 109 #ifdef SMP
 110   pthread_cond_t wakeup;
 111 #endif
 112   struct StgMainThread_ *link;
 113 } StgMainThread;
 114
 115 /* Main thread queue.
 116  * Locks required: sched_mutex.
 117  */
 118 static StgMainThread *main_threads;
 119
 120 /* Thread queues.
 121  * Locks required: sched_mutex.
 122  */
 123 #if defined(GRAN)
 124
 125 StgTSO* ActiveTSO = NULL; /* for assigning system costs; GranSim-Light only */
 126 /* rtsTime TimeOfNextEvent, EndOfTimeSlice;            now in GranSim.c */
 127
 128 /*
 129    In GranSim we have a runable and a blocked queue for each processor.
 130    In order to minimise code changes new arrays run_queue_hds/tls
 131    are created. run_queue_hd is then a short cut (macro) for
 132    run_queue_hds[CurrentProc] (see GranSim.h).
 133    -- HWL
 134 */
 135 StgTSO *run_queue_hds[MAX_PROC], *run_queue_tls[MAX_PROC];
 136 StgTSO *blocked_queue_hds[MAX_PROC], *blocked_queue_tls[MAX_PROC];
 137 StgTSO *ccalling_threadss[MAX_PROC];
 138 /* We use the same global list of threads (all_threads) in GranSim as in
 139    the std RTS (i.e. we are cheating). However, we don't use this list in
 140    the GranSim specific code at the moment (so we are only potentially
 141    cheating).  */
 142
 143 #else /* !GRAN */
 144
 145 StgTSO *run_queue_hd, *run_queue_tl;
 146 StgTSO *blocked_queue_hd, *blocked_queue_tl;
 147
 148 #endif
 149
 150 /* Linked list of all threads.
 151  * Used for detecting garbage collected threads.
 152  */
 153 StgTSO *all_threads;
 154
 155 /* Threads suspended in _ccall_GC.
 156  */
 157 static StgTSO *suspended_ccalling_threads;
 158
 159 static void GetRoots(void);
 160 static StgTSO *threadStackOverflow(StgTSO *tso);
 161
 162 /* KH: The following two flags are shared memory locations.  There is no need
 163        to lock them, since they are only unset at the end of a scheduler
 164        operation.
 165 */
 166
 167 /* flag set by signal handler to precipitate a context switch */
 168 //@cindex context_switch
 169 nat context_switch;
 170
 171 /* if this flag is set as well, give up execution */
 172 //@cindex interrupted
 173 rtsBool interrupted;
 174
 175 /* Next thread ID to allocate.
 176  * Locks required: sched_mutex
 177  */
 178 //@cindex next_thread_id
 179 StgThreadID next_thread_id = 1;
 180
 181 /*
 182  * Pointers to the state of the current thread.
 183  * Rule of thumb: if CurrentTSO != NULL, then we're running a Haskell
 184  * thread.  If CurrentTSO == NULL, then we're at the scheduler level.
 185  */
 186
 187 /* The smallest stack size that makes any sense is:
 188  *    RESERVED_STACK_WORDS    (so we can get back from the stack overflow)
 189  *  + sizeofW(StgStopFrame)   (the stg_stop_thread_info frame)
 190  *  + 1                       (the realworld token for an IO thread)
 191  *  + 1                       (the closure to enter)
 192  *
 193  * A thread with this stack will bomb immediately with a stack
 194  * overflow, which will increase its stack size.
 195  */
 196
 197 #define MIN_STACK_WORDS (RESERVED_STACK_WORDS + sizeofW(StgStopFrame) + 2)
 198
 199 /* Free capability list.
 200  * Locks required: sched_mutex.
 201  */
 202 #ifdef SMP
 203 //@cindex free_capabilities
 204 //@cindex n_free_capabilities
 205 Capability *free_capabilities; /* Available capabilities for running threads */
 206 nat n_free_capabilities;       /* total number of available capabilities */
 207 #else
 208 //@cindex MainRegTable
 209 Capability MainRegTable;       /* for non-SMP, we have one global capability */
 210 #endif
 211
 212 #if defined(GRAN)
 213 StgTSO *CurrentTSO;
 214 #endif
 215
 216 rtsBool ready_to_gc;
 217
 218 /* All our current task ids, saved in case we need to kill them later.
 219  */
 220 #ifdef SMP
 221 //@cindex task_ids
 222 task_info *task_ids;
 223 #endif
 224
 225 void            addToBlockedQueue ( StgTSO *tso );
 226
 227 static void     schedule          ( void );
 228        void     interruptStgRts   ( void );
 229 #if defined(GRAN)
 230 static StgTSO * createThread_     ( nat size, rtsBool have_lock, StgInt pri );
 231 #else
 232 static StgTSO * createThread_     ( nat size, rtsBool have_lock );
 233 #endif
 234
 235 static void     detectBlackHoles  ( void );
 236
 237 #ifdef DEBUG
 238 static void sched_belch(char *s, ...);
 239 #endif
 240
 241 #ifdef SMP
 242 //@cindex sched_mutex
 243 //@cindex term_mutex
 244 //@cindex thread_ready_cond
 245 //@cindex gc_pending_cond
 246 pthread_mutex_t sched_mutex       = PTHREAD_MUTEX_INITIALIZER;
 247 pthread_mutex_t term_mutex        = PTHREAD_MUTEX_INITIALIZER;
 248 pthread_cond_t  thread_ready_cond = PTHREAD_COND_INITIALIZER;
 249 pthread_cond_t  gc_pending_cond   = PTHREAD_COND_INITIALIZER;
 250
 251 nat await_death;
 252 #endif
 253
 254 #if defined(PAR)
 255 StgTSO *LastTSO;
 256 rtsTime TimeOfLastYield;
 257 #endif
 258
 259 #if DEBUG
 260 char *whatNext_strs[] = {
 261   "ThreadEnterGHC",
 262   "ThreadRunGHC",
 263   "ThreadEnterHugs",
 264   "ThreadKilled",
 265   "ThreadComplete"
 266 };
 267
 268 char *threadReturnCode_strs[] = {
 269   "HeapOverflow",                       /* might also be StackOverflow */
 270   "StackOverflow",
 271   "ThreadYielding",
 272   "ThreadBlocked",
 273   "ThreadFinished"
 274 };
 275 #endif
 276
 277 /*
 278  * The thread state for the main thread.
 279 // ToDo: check whether not needed any more
 280 StgTSO   *MainTSO;
 281  */
 282
 283 //@node Main scheduling loop, Suspend and Resume, Prototypes, Main scheduling code
 284 //@subsection Main scheduling loop
 285
 286 /* ---------------------------------------------------------------------------
 287    Main scheduling loop.
 288
 289    We use round-robin scheduling, each thread returning to the
 290    scheduler loop when one of these conditions is detected:
 291
 292       * out of heap space
 293       * timer expires (thread yields)
 294       * thread blocks
 295       * thread ends
 296       * stack overflow
 297
 298    Locking notes:  we acquire the scheduler lock once at the beginning
 299    of the scheduler loop, and release it when
 300
 301       * running a thread, or
 302       * waiting for work, or
 303       * waiting for a GC to complete.
 304
 305    GRAN version:
 306      In a GranSim setup this loop iterates over the global event queue.
 307      This revolves around the global event queue, which determines what
 308      to do next. Therefore, it's more complicated than either the
 309      concurrent or the parallel (GUM) setup.
 310
 311    GUM version:
 312      GUM iterates over incoming messages.
 313      It starts with nothing to do (thus CurrentTSO == END_TSO_QUEUE),
 314      and sends out a fish whenever it has nothing to do; in-between
 315      doing the actual reductions (shared code below) it processes the
 316      incoming messages and deals with delayed operations
 317      (see PendingFetches).
 318      This is not the ugliest code you could imagine, but it's bloody close.
 319
 320    ------------------------------------------------------------------------ */
 321 //@cindex schedule
 322 static void
 323 schedule( void )
 324 {
 325   StgTSO *t;
 326   Capability *cap;
 327   StgThreadReturnCode ret;
 328 #if defined(GRAN)
 329   rtsEvent *event;
 330 #elif defined(PAR)
 331   StgSparkPool *pool;
 332   rtsSpark spark;
 333   StgTSO *tso;
 334   GlobalTaskId pe;
 335 #endif
 336   rtsBool was_interrupted = rtsFalse;
 337
 338   ACQUIRE_LOCK(&sched_mutex);
 339
 340 #if defined(GRAN)
 341
 342   /* set up first event to get things going */
 343   /* ToDo: assign costs for system setup and init MainTSO ! */
 344   new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc],
 345             ContinueThread,
 346             CurrentTSO, (StgClosure*)NULL, (rtsSpark*)NULL);
 347
 348   IF_DEBUG(gran,
 349            fprintf(stderr, "GRAN: Init CurrentTSO (in schedule) = %p\n", CurrentTSO);
 350            G_TSO(CurrentTSO, 5));
 351
 352   if (RtsFlags.GranFlags.Light) {
 353     /* Save current time; GranSim Light only */
 354     CurrentTSO->gran.clock = CurrentTime[CurrentProc];
 355   }
 356
 357   event = get_next_event();
 358
 359   while (event!=(rtsEvent*)NULL) {
 360     /* Choose the processor with the next event */
 361     CurrentProc = event->proc;
 362     CurrentTSO = event->tso;
 363
 364 #elif defined(PAR)
 365
 366   while (!GlobalStopPending) {          /* GlobalStopPending set in par_exit */
 367
 368 #else
 369
 370   while (1) {
 371
 372 #endif
 373
 374     IF_DEBUG(scheduler, printAllThreads());
 375
 376     /* If we're interrupted (the user pressed ^C, or some other
 377      * termination condition occurred), kill all the currently running
 378      * threads.
 379      */
 380     if (interrupted) {
 381       IF_DEBUG(scheduler, sched_belch("interrupted"));
 382       for (t = run_queue_hd; t != END_TSO_QUEUE; t = t->link) {
 383         deleteThread(t);
 384       }
 385       for (t = blocked_queue_hd; t != END_TSO_QUEUE; t = t->link) {
 386         deleteThread(t);
 387       }
 388       run_queue_hd = run_queue_tl = END_TSO_QUEUE;
 389       blocked_queue_hd = blocked_queue_tl = END_TSO_QUEUE;
 390       interrupted = rtsFalse;
 391       was_interrupted = rtsTrue;
 392     }
 393
 394     /* Go through the list of main threads and wake up any
 395      * clients whose computations have finished.  ToDo: this
 396      * should be done more efficiently without a linear scan
 397      * of the main threads list, somehow...
 398      */
 399 #ifdef SMP
 400     {
 401       StgMainThread *m, **prev;
 402       prev = &main_threads;
 403       for (m = main_threads; m != NULL; m = m->link) {
 404         switch (m->tso->what_next) {
 405         case ThreadComplete:
 406           if (m->ret) {
 407             *(m->ret) = (StgClosure *)m->tso->sp[0];
 408           }
 409           *prev = m->link;
 410           m->stat = Success;
 411           pthread_cond_broadcast(&m->wakeup);
 412           break;
 413         case ThreadKilled:
 414           *prev = m->link;
 415           if (was_interrupted) {
 416             m->stat = Interrupted;
 417           } else {
 418             m->stat = Killed;
 419           }
 420           pthread_cond_broadcast(&m->wakeup);
 421           break;
 422         default:
 423           break;
 424         }
 425       }
 426     }
 427
 428 #else
 429 # if defined(PAR)
 430     /* in GUM do this only on the Main PE */
 431     if (IAmMainThread)
 432 # endif
 433     /* If our main thread has finished or been killed, return.
 434      */
 435     {
 436       StgMainThread *m = main_threads;
 437       if (m->tso->what_next == ThreadComplete
 438           || m->tso->what_next == ThreadKilled) {
 439         main_threads = main_threads->link;
 440         if (m->tso->what_next == ThreadComplete) {
 441           /* we finished successfully, fill in the return value */
 442           if (m->ret) { *(m->ret) = (StgClosure *)m->tso->sp[0]; };
 443           m->stat = Success;
 444           return;
 445         } else {
 446           if (was_interrupted) {
 447             m->stat = Interrupted;
 448           } else {
 449             m->stat = Killed;
 450           }
 451           return;
 452         }
 453       }
 454     }
 455 #endif
 456
 457     /* Top up the run queue from our spark pool.  We try to make the
 458      * number of threads in the run queue equal to the number of
 459      * free capabilities.
 460      */
 461 #if defined(SMP)
 462     {
 463       nat n = n_free_capabilities;
 464       StgTSO *tso = run_queue_hd;
 465
 466       /* Count the run queue */
 467       while (n > 0 && tso != END_TSO_QUEUE) {
 468         tso = tso->link;
 469         n--;
 470       }
 471
 472       for (; n > 0; n--) {
 473         StgClosure *spark;
 474         spark = findSpark();
 475         if (spark == NULL) {
 476           break; /* no more sparks in the pool */
 477         } else {
 478           /* I'd prefer this to be done in activateSpark -- HWL */
 479           /* tricky - it needs to hold the scheduler lock and
 480            * not try to re-acquire it -- SDM */
 481           StgTSO *tso;
 482           tso = createThread_(RtsFlags.GcFlags.initialStkSize, rtsTrue);
 483           pushClosure(tso,spark);
 484           PUSH_ON_RUN_QUEUE(tso);
 485 #ifdef PAR
 486           advisory_thread_count++;
 487 #endif
 488
 489           IF_DEBUG(scheduler,
 490                    sched_belch("turning spark of closure %p into a thread",
 491                                (StgClosure *)spark));
 492         }
 493       }
 494       /* We need to wake up the other tasks if we just created some
 495        * work for them.
 496        */
 497       if (n_free_capabilities - n > 1) {
 498           pthread_cond_signal(&thread_ready_cond);
 499       }
 500     }
 501 #endif /* SMP */
 502
 503     /* Check whether any waiting threads need to be woken up.  If the
 504      * run queue is empty, and there are no other tasks running, we
 505      * can wait indefinitely for something to happen.
 506      * ToDo: what if another client comes along & requests another
 507      * main thread?
 508      */
 509     if (blocked_queue_hd != END_TSO_QUEUE) {
 510       awaitEvent(
 511            (run_queue_hd == END_TSO_QUEUE)
 512 #ifdef SMP
 513         && (n_free_capabilities == RtsFlags.ParFlags.nNodes)
 514 #endif
 515         );
 516     }
 517
 518     /* check for signals each time around the scheduler */
 519 #ifndef mingw32_TARGET_OS
 520     if (signals_pending()) {
 521       start_signal_handlers();
 522     }
 523 #endif
 524
 525     /*
 526      * Detect deadlock: when we have no threads to run, there are no
 527      * threads waiting on I/O or sleeping, and all the other tasks are
 528      * waiting for work, we must have a deadlock of some description.
 529      *
 530      * We first try to find threads blocked on themselves (ie. black
 531      * holes), and generate NonTermination exceptions where necessary.
 532      *
 533      * If no threads are black holed, we have a deadlock situation, so
 534      * inform all the main threads.
 535      */
 536 #ifdef SMP
 537     if (blocked_queue_hd == END_TSO_QUEUE
 538         && run_queue_hd == END_TSO_QUEUE
 539         && (n_free_capabilities == RtsFlags.ParFlags.nNodes))
 540     {
 541         IF_DEBUG(scheduler, sched_belch("deadlocked, checking for black holes..."));
 542         detectBlackHoles();
 543         if (run_queue_hd == END_TSO_QUEUE) {
 544             StgMainThread *m;
 545             for (m = main_threads; m != NULL; m = m->link) {
 546                 m->ret = NULL;
 547                 m->stat = Deadlock;
 548                 pthread_cond_broadcast(&m->wakeup);
 549             }
 550             main_threads = NULL;
 551         }
 552     }
 553 #else /* ! SMP */
 554     if (blocked_queue_hd == END_TSO_QUEUE
 555         && run_queue_hd == END_TSO_QUEUE)
 556     {
 557         IF_DEBUG(scheduler, sched_belch("deadlocked, checking for black holes..."));
 558         detectBlackHoles();
 559         if (run_queue_hd == END_TSO_QUEUE) {
 560             StgMainThread *m = main_threads;
 561             m->ret = NULL;
 562             m->stat = Deadlock;
 563             main_threads = m->link;
 564             return;
 565         }
 566     }
 567 #endif
 568
 569 #ifdef SMP
 570     /* If there's a GC pending, don't do anything until it has
 571      * completed.
 572      */
 573     if (ready_to_gc) {
 574       IF_DEBUG(scheduler,sched_belch("waiting for GC"));
 575       pthread_cond_wait(&gc_pending_cond, &sched_mutex);
 576     }
 577
 578     /* block until we've got a thread on the run queue and a free
 579      * capability.
 580      */
 581     while (run_queue_hd == END_TSO_QUEUE || free_capabilities == NULL) {
 582       IF_DEBUG(scheduler, sched_belch("waiting for work"));
 583       pthread_cond_wait(&thread_ready_cond, &sched_mutex);
 584       IF_DEBUG(scheduler, sched_belch("work now available"));
 585     }
 586 #endif
 587
 588 #if defined(GRAN)
 589
 590     if (RtsFlags.GranFlags.Light)
 591       GranSimLight_enter_system(event, &ActiveTSO); // adjust ActiveTSO etc
 592
 593     /* adjust time based on time-stamp */
 594     if (event->time > CurrentTime[CurrentProc] &&
 595         event->evttype != ContinueThread)
 596       CurrentTime[CurrentProc] = event->time;
 597
 598     /* Deal with the idle PEs (may issue FindWork or MoveSpark events) */
 599     if (!RtsFlags.GranFlags.Light)
 600       handleIdlePEs();
 601
 602     IF_DEBUG(gran, fprintf(stderr, "GRAN: switch by event-type\n"))
 603
 604     /* main event dispatcher in GranSim */
 605     switch (event->evttype) {
 606       /* Should just be continuing execution */
 607     case ContinueThread:
 608       IF_DEBUG(gran, fprintf(stderr, "GRAN: doing ContinueThread\n"));
 609       /* ToDo: check assertion
 610       ASSERT(run_queue_hd != (StgTSO*)NULL &&
 611              run_queue_hd != END_TSO_QUEUE);
 612       */
 613       /* Ignore ContinueThreads for fetching threads (if synchr comm) */
 614       if (!RtsFlags.GranFlags.DoAsyncFetch &&
 615           procStatus[CurrentProc]==Fetching) {
 616         belch("ghuH: Spurious ContinueThread while Fetching ignored; TSO %d (%p) [PE %d]",
 617               CurrentTSO->id, CurrentTSO, CurrentProc);
 618         goto next_thread;
 619       }
 620       /* Ignore ContinueThreads for completed threads */
 621       if (CurrentTSO->what_next == ThreadComplete) {
 622         belch("ghuH: found a ContinueThread event for completed thread %d (%p) [PE %d] (ignoring ContinueThread)",
 623               CurrentTSO->id, CurrentTSO, CurrentProc);
 624         goto next_thread;
 625       }
 626       /* Ignore ContinueThreads for threads that are being migrated */
 627       if (PROCS(CurrentTSO)==Nowhere) {
 628         belch("ghuH: trying to run the migrating TSO %d (%p) [PE %d] (ignoring ContinueThread)",
 629               CurrentTSO->id, CurrentTSO, CurrentProc);
 630         goto next_thread;
 631       }
 632       /* The thread should be at the beginning of the run queue */
 633       if (CurrentTSO!=run_queue_hds[CurrentProc]) {
 634         belch("ghuH: TSO %d (%p) [PE %d] is not at the start of the run_queue when doing a ContinueThread",
 635               CurrentTSO->id, CurrentTSO, CurrentProc);
 636         break; // run the thread anyway
 637       }
 638       /*
 639       new_event(proc, proc, CurrentTime[proc],
 640                 FindWork,
 641                 (StgTSO*)NULL, (StgClosure*)NULL, (rtsSpark*)NULL);
 642       goto next_thread;
 643       */ /* Catches superfluous CONTINUEs -- should be unnecessary */
 644       break; // now actually run the thread; DaH Qu'vam yImuHbej
 645
 646     case FetchNode:
 647       do_the_fetchnode(event);
 648       goto next_thread;             /* handle next event in event queue  */
 649
 650     case GlobalBlock:
 651       do_the_globalblock(event);
 652       goto next_thread;             /* handle next event in event queue  */
 653
 654     case FetchReply:
 655       do_the_fetchreply(event);
 656       goto next_thread;             /* handle next event in event queue  */
 657
 658     case UnblockThread:   /* Move from the blocked queue to the tail of */
 659       do_the_unblock(event);
 660       goto next_thread;             /* handle next event in event queue  */
 661
 662     case ResumeThread:  /* Move from the blocked queue to the tail of */
 663       /* the runnable queue ( i.e. Qu' SImqa'lu') */
 664       event->tso->gran.blocktime +=
 665         CurrentTime[CurrentProc] - event->tso->gran.blockedat;
 666       do_the_startthread(event);
 667       goto next_thread;             /* handle next event in event queue  */
 668
 669     case StartThread:
 670       do_the_startthread(event);
 671       goto next_thread;             /* handle next event in event queue  */
 672
 673     case MoveThread:
 674       do_the_movethread(event);
 675       goto next_thread;             /* handle next event in event queue  */
 676
 677     case MoveSpark:
 678       do_the_movespark(event);
 679       goto next_thread;             /* handle next event in event queue  */
 680
 681     case FindWork:
 682       do_the_findwork(event);
 683       goto next_thread;             /* handle next event in event queue  */
 684
 685     default:
 686       barf("Illegal event type %u\n", event->evttype);
 687     }  /* switch */
 688
 689     /* This point was scheduler_loop in the old RTS */
 690
 691     IF_DEBUG(gran, belch("GRAN: after main switch"));
 692
 693     TimeOfLastEvent = CurrentTime[CurrentProc];
 694     TimeOfNextEvent = get_time_of_next_event();
 695     IgnoreEvents=(TimeOfNextEvent==0); // HWL HACK
 696     // CurrentTSO = ThreadQueueHd;
 697
 698     IF_DEBUG(gran, belch("GRAN: time of next event is: %ld",
 699                          TimeOfNextEvent));
 700
 701     if (RtsFlags.GranFlags.Light)
 702       GranSimLight_leave_system(event, &ActiveTSO);
 703
 704     EndOfTimeSlice = CurrentTime[CurrentProc]+RtsFlags.GranFlags.time_slice;
 705
 706     IF_DEBUG(gran,
 707              belch("GRAN: end of time-slice is %#lx", EndOfTimeSlice));
 708
 709     /* in a GranSim setup the TSO stays on the run queue */
 710     t = CurrentTSO;
 711     /* Take a thread from the run queue. */
 712     t = POP_RUN_QUEUE(); // take_off_run_queue(t);
 713
 714     IF_DEBUG(gran,
 715              fprintf(stderr, "GRAN: About to run current thread, which is\n");
 716              G_TSO(t,5))
 717
 718     context_switch = 0; // turned on via GranYield, checking events and time slice
 719
 720     IF_DEBUG(gran,
 721              DumpGranEvent(GR_SCHEDULE, t));
 722
 723     procStatus[CurrentProc] = Busy;
 724
 725 #elif defined(PAR)
 726
 727     if (PendingFetches != END_BF_QUEUE) {
 728         processFetches();
 729     }
 730
 731     /* ToDo: phps merge with spark activation above */
 732     /* check whether we have local work and send requests if we have none */
 733     if (run_queue_hd == END_TSO_QUEUE) {  /* no runnable threads */
 734       /* :-[  no local threads => look out for local sparks */
 735       /* the spark pool for the current PE */
 736       pool = &(MainRegTable.rSparks); // generalise to cap = &MainRegTable
 737       if (advisory_thread_count < RtsFlags.ParFlags.maxThreads &&
 738           pool->hd < pool->tl) {
 739         /*
 740          * ToDo: add GC code check that we really have enough heap afterwards!!
 741          * Old comment:
 742          * If we're here (no runnable threads) and we have pending
 743          * sparks, we must have a space problem.  Get enough space
 744          * to turn one of those pending sparks into a
 745          * thread...
 746          */
 747
 748         spark = findSpark();                /* get a spark */
 749         if (spark != (rtsSpark) NULL) {
 750           tso = activateSpark(spark);       /* turn the spark into a thread */
 751           IF_PAR_DEBUG(schedule,
 752                        belch("==== schedule: Created TSO %d (%p); %d threads active",
 753                              tso->id, tso, advisory_thread_count));
 754
 755           if (tso==END_TSO_QUEUE) { /* failed to activate spark->back to loop */
 756             belch("==^^ failed to activate spark");
 757             goto next_thread;
 758           }               /* otherwise fall through & pick-up new tso */
 759         } else {
 760           IF_PAR_DEBUG(verbose,
 761                        belch("==^^ no local sparks (spark pool contains only NFs: %d)",
 762                              spark_queue_len(pool)));
 763           goto next_thread;
 764         }
 765       } else
 766       /* =8-[  no local sparks => look for work on other PEs */
 767       {
 768         /*
 769          * We really have absolutely no work.  Send out a fish
 770          * (there may be some out there already), and wait for
 771          * something to arrive.  We clearly can't run any threads
 772          * until a SCHEDULE or RESUME arrives, and so that's what
 773          * we're hoping to see.  (Of course, we still have to
 774          * respond to other types of messages.)
 775          */
 776         if (//!fishing &&
 777             outstandingFishes < RtsFlags.ParFlags.maxFishes ) { // &&
 778           // (last_fish_arrived_at+FISH_DELAY < CURRENT_TIME)) {
 779           /* fishing set in sendFish, processFish;
 780              avoid flooding system with fishes via delay */
 781           pe = choosePE();
 782           sendFish(pe, mytid, NEW_FISH_AGE, NEW_FISH_HISTORY,
 783                    NEW_FISH_HUNGER);
 784         }
 785
 786         processMessages();
 787         goto next_thread;
 788         // ReSchedule(0);
 789       }
 790     } else if (PacketsWaiting()) {  /* Look for incoming messages */
 791       processMessages();
 792     }
 793
 794     /* Now we are sure that we have some work available */
 795     ASSERT(run_queue_hd != END_TSO_QUEUE);
 796     /* Take a thread from the run queue, if we have work */
 797     t = POP_RUN_QUEUE();  // take_off_run_queue(END_TSO_QUEUE);
 798
 799     /* ToDo: write something to the log-file
 800     if (RTSflags.ParFlags.granSimStats && !sameThread)
 801         DumpGranEvent(GR_SCHEDULE, RunnableThreadsHd);
 802
 803     CurrentTSO = t;
 804     */
 805     /* the spark pool for the current PE */
 806     pool = &(MainRegTable.rSparks); // generalise to cap = &MainRegTable
 807
 808     IF_DEBUG(scheduler, belch("--^^ %d sparks on [%#x] (hd=%x; tl=%x; base=%x, lim=%x)",
 809                               spark_queue_len(pool),
 810                               CURRENT_PROC,
 811                               pool->hd, pool->tl, pool->base, pool->lim));
 812
 813     IF_DEBUG(scheduler, belch("--== %d threads on [%#x] (hd=%x; tl=%x)",
 814                               run_queue_len(), CURRENT_PROC,
 815                               run_queue_hd, run_queue_tl));
 816
 817 #if 0
 818     if (t != LastTSO) {
 819       /*
 820          we are running a different TSO, so write a schedule event to log file
 821          NB: If we use fair scheduling we also have to write  a deschedule
 822              event for LastTSO; with unfair scheduling we know that the
 823              previous tso has blocked whenever we switch to another tso, so
 824              we don't need it in GUM for now
 825       */
 826       DumpRawGranEvent(CURRENT_PROC, CURRENT_PROC,
 827                        GR_SCHEDULE, t, (StgClosure *)NULL, 0, 0);
 828
 829     }
 830 #endif
 831 #else /* !GRAN && !PAR */
 832
 833     /* grab a thread from the run queue
 834      */
 835     ASSERT(run_queue_hd != END_TSO_QUEUE);
 836     t = POP_RUN_QUEUE();
 837     IF_DEBUG(sanity,checkTSO(t));
 838
 839 #endif
 840
 841     /* grab a capability
 842      */
 843 #ifdef SMP
 844     cap = free_capabilities;
 845     free_capabilities = cap->link;
 846     n_free_capabilities--;
 847 #else
 848     cap = &MainRegTable;
 849 #endif
 850
 851     cap->rCurrentTSO = t;
 852
 853     /* context switches are now initiated by the timer signal, unless
 854      * the user specified "context switch as often as possible", with
 855      * +RTS -C0
 856      */
 857     if (RtsFlags.ConcFlags.ctxtSwitchTicks == 0
 858         && (run_queue_hd != END_TSO_QUEUE
 859             || blocked_queue_hd != END_TSO_QUEUE))
 860         context_switch = 1;
 861     else
 862         context_switch = 0;
 863
 864     RELEASE_LOCK(&sched_mutex);
 865
 866     IF_DEBUG(scheduler, sched_belch("-->> Running TSO %ld (%p) %s ...",
 867                               t->id, t, whatNext_strs[t->what_next]));
 868
 869     /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
 870     /* Run the current thread
 871      */
 872     switch (cap->rCurrentTSO->what_next) {
 873     case ThreadKilled:
 874     case ThreadComplete:
 875       /* Thread already finished, return to scheduler. */
 876       ret = ThreadFinished;
 877       break;
 878     case ThreadEnterGHC:
 879       ret = StgRun((StgFunPtr) stg_enterStackTop, cap);
 880       break;
 881     case ThreadRunGHC:
 882       ret = StgRun((StgFunPtr) stg_returnToStackTop, cap);
 883       break;
 884     case ThreadEnterHugs:
 885 #ifdef INTERPRETER
 886       {
 887          StgClosure* c;
 888          IF_DEBUG(scheduler,sched_belch("entering Hugs"));
 889          c = (StgClosure *)(cap->rCurrentTSO->sp[0]);
 890          cap->rCurrentTSO->sp += 1;
 891          ret = enter(cap,c);
 892          break;
 893       }
 894 #else
 895       barf("Panic: entered a BCO but no bytecode interpreter in this build");
 896 #endif
 897     default:
 898       barf("schedule: invalid what_next field");
 899     }
 900     /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
 901
 902     /* Costs for the scheduler are assigned to CCS_SYSTEM */
 903 #ifdef PROFILING
 904     CCCS = CCS_SYSTEM;
 905 #endif
 906
 907     ACQUIRE_LOCK(&sched_mutex);
 908
 909 #ifdef SMP
 910     IF_DEBUG(scheduler,fprintf(stderr,"scheduler (task %ld): ", pthread_self()););
 911 #elif !defined(GRAN) && !defined(PAR)
 912     IF_DEBUG(scheduler,fprintf(stderr,"scheduler: "););
 913 #endif
 914     t = cap->rCurrentTSO;
 915
 916 #if defined(PAR)
 917     /* HACK 675: if the last thread didn't yield, make sure to print a
 918        SCHEDULE event to the log file when StgRunning the next thread, even
 919        if it is the same one as before */
 920     LastTSO = t; //(ret == ThreadBlocked) ? END_TSO_QUEUE : t;
 921     TimeOfLastYield = CURRENT_TIME;
 922 #endif
 923
 924     switch (ret) {
 925     case HeapOverflow:
 926       /* make all the running tasks block on a condition variable,
 927        * maybe set context_switch and wait till they all pile in,
 928        * then have them wait on a GC condition variable.
 929        */
 930       IF_DEBUG(scheduler,belch("--<< thread %ld (%p; %s) stopped: HeapOverflow",
 931                                t->id, t, whatNext_strs[t->what_next]));
 932       threadPaused(t);
 933 #if defined(GRAN)
 934       ASSERT(!is_on_queue(t,CurrentProc));
 935 #endif
 936
 937       ready_to_gc = rtsTrue;
 938       context_switch = 1;               /* stop other threads ASAP */
 939       PUSH_ON_RUN_QUEUE(t);
 940       /* actual GC is done at the end of the while loop */
 941       break;
 942
 943     case StackOverflow:
 944       IF_DEBUG(scheduler,belch("--<< thread %ld (%p; %s) stopped, StackOverflow",
 945                                t->id, t, whatNext_strs[t->what_next]));
 946       /* just adjust the stack for this thread, then pop it back
 947        * on the run queue.
 948        */
 949       threadPaused(t);
 950       {
 951         StgMainThread *m;
 952         /* enlarge the stack */
 953         StgTSO *new_t = threadStackOverflow(t);
 954
 955         /* This TSO has moved, so update any pointers to it from the
 956          * main thread stack.  It better not be on any other queues...
 957          * (it shouldn't be).
 958          */
 959         for (m = main_threads; m != NULL; m = m->link) {
 960           if (m->tso == t) {
 961             m->tso = new_t;
 962           }
 963         }
 964         threadPaused(new_t);
 965         PUSH_ON_RUN_QUEUE(new_t);
 966       }
 967       break;
 968
 969     case ThreadYielding:
 970 #if defined(GRAN)
 971       IF_DEBUG(gran,
 972                DumpGranEvent(GR_DESCHEDULE, t));
 973       globalGranStats.tot_yields++;
 974 #elif defined(PAR)
 975       IF_DEBUG(par,
 976                DumpGranEvent(GR_DESCHEDULE, t));
 977 #endif
 978       /* put the thread back on the run queue.  Then, if we're ready to
 979        * GC, check whether this is the last task to stop.  If so, wake
 980        * up the GC thread.  getThread will block during a GC until the
 981        * GC is finished.
 982        */
 983       IF_DEBUG(scheduler,
 984                if (t->what_next == ThreadEnterHugs) {
 985                    /* ToDo: or maybe a timer expired when we were in Hugs?
 986                     * or maybe someone hit ctrl-C
 987                     */
 988                    belch("--<< thread %ld (%p; %s) stopped to switch to Hugs",
 989                          t->id, t, whatNext_strs[t->what_next]);
 990                } else {
 991                    belch("--<< thread %ld (%p; %s) stopped, yielding",
 992                          t->id, t, whatNext_strs[t->what_next]);
 993                }
 994                );
 995
 996       threadPaused(t);
 997
 998       IF_DEBUG(sanity,
 999                //belch("&& Doing sanity check on yielding TSO %ld.", t->id);
1000                checkTSO(t));
1001       ASSERT(t->link == END_TSO_QUEUE);
1002 #if defined(GRAN)
1003       ASSERT(!is_on_queue(t,CurrentProc));
1004
1005       IF_DEBUG(sanity,
1006                //belch("&& Doing sanity check on all ThreadQueues (and their TSOs).");
1007                checkThreadQsSanity(rtsTrue));
1008 #endif
1009       APPEND_TO_RUN_QUEUE(t);
1010 #if defined(GRAN)
1011       /* add a ContinueThread event to actually process the thread */
1012       new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc],
1013                 ContinueThread,
1014                 t, (StgClosure*)NULL, (rtsSpark*)NULL);
1015       IF_GRAN_DEBUG(bq,
1016                belch("GRAN: eventq and runnableq after adding yielded thread to queue again:");
1017                G_EVENTQ(0);
1018                G_CURR_THREADQ(0))
1019 #endif /* GRAN */
1020       break;
1021
1022     case ThreadBlocked:
1023 #if defined(GRAN)
1024       IF_DEBUG(scheduler,
1025                belch("--<< thread %ld (%p; %s) stopped, blocking on node %p [PE %d] with BQ: ",
1026                                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)));
1027                if (t->block_info.closure!=(StgClosure*)NULL) print_bq(t->block_info.closure));
1028
1029       // ??? needed; should emit block before
1030       IF_DEBUG(gran,
1031                DumpGranEvent(GR_DESCHEDULE, t));
1032       prune_eventq(t, (StgClosure *)NULL); // prune ContinueThreads for t
1033       /*
1034         ngoq Dogh!
1035       ASSERT(procStatus[CurrentProc]==Busy ||
1036               ((procStatus[CurrentProc]==Fetching) &&
1037               (t->block_info.closure!=(StgClosure*)NULL)));
1038       if (run_queue_hds[CurrentProc] == END_TSO_QUEUE &&
1039           !(!RtsFlags.GranFlags.DoAsyncFetch &&
1040             procStatus[CurrentProc]==Fetching))
1041         procStatus[CurrentProc] = Idle;
1042       */
1043 #elif defined(PAR)
1044       IF_DEBUG(par,
1045                DumpGranEvent(GR_DESCHEDULE, t));
1046
1047       /* Send a fetch (if BlockedOnGA) and dump event to log file */
1048       blockThread(t);
1049
1050       IF_DEBUG(scheduler,
1051                belch("--<< thread %ld (%p; %s) stopped, blocking on node %p with BQ: ",
1052                                t->id, t, whatNext_strs[t->what_next], t->block_info.closure);
1053                if (t->block_info.closure!=(StgClosure*)NULL) print_bq(t->block_info.closure));
1054
1055 #else /* !GRAN */
1056       /* don't need to do anything.  Either the thread is blocked on
1057        * I/O, in which case we'll have called addToBlockedQueue
1058        * previously, or it's blocked on an MVar or Blackhole, in which
1059        * case it'll be on the relevant queue already.
1060        */
1061       IF_DEBUG(scheduler,
1062                fprintf(stderr, "--<< thread %d (%p) stopped: ", t->id, t);
1063                printThreadBlockage(t);
1064                fprintf(stderr, "\n"));
1065
1066       /* Only for dumping event to log file
1067          ToDo: do I need this in GranSim, too?
1068       blockThread(t);
1069       */
1070 #endif
1071       threadPaused(t);
1072       break;
1073
1074     case ThreadFinished:
1075       /* Need to check whether this was a main thread, and if so, signal
1076        * the task that started it with the return value.  If we have no
1077        * more main threads, we probably need to stop all the tasks until
1078        * we get a new one.
1079        */
1080       /* We also end up here if the thread kills itself with an
1081        * uncaught exception, see Exception.hc.
1082        */
1083       IF_DEBUG(scheduler,belch("--++ thread %d (%p) finished", t->id, t));
1084 #if defined(GRAN)
1085       endThread(t, CurrentProc); // clean-up the thread
1086 #elif defined(PAR)
1087       advisory_thread_count--;
1088       if (RtsFlags.ParFlags.ParStats.Full)
1089         DumpEndEvent(CURRENT_PROC, t, rtsFalse /* not mandatory */);
1090 #endif
1091       break;
1092
1093     default:
1094       barf("schedule: invalid thread return code %d", (int)ret);
1095     }
1096
1097 #ifdef SMP
1098     cap->link = free_capabilities;
1099     free_capabilities = cap;
1100     n_free_capabilities++;
1101 #endif
1102
1103 #ifdef SMP
1104     if (ready_to_gc && n_free_capabilities == RtsFlags.ParFlags.nNodes)
1105 #else
1106     if (ready_to_gc)
1107 #endif
1108       {
1109       /* everybody back, start the GC.
1110        * Could do it in this thread, or signal a condition var
1111        * to do it in another thread.  Either way, we need to
1112        * broadcast on gc_pending_cond afterward.
1113        */
1114 #ifdef SMP
1115       IF_DEBUG(scheduler,sched_belch("doing GC"));
1116 #endif
1117       GarbageCollect(GetRoots,rtsFalse);
1118       ready_to_gc = rtsFalse;
1119 #ifdef SMP
1120       pthread_cond_broadcast(&gc_pending_cond);
1121 #endif
1122 #if defined(GRAN)
1123       /* add a ContinueThread event to continue execution of current thread */
1124       new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc],
1125                 ContinueThread,
1126                 t, (StgClosure*)NULL, (rtsSpark*)NULL);
1127       IF_GRAN_DEBUG(bq,
1128                fprintf(stderr, "GRAN: eventq and runnableq after Garbage collection:\n");
1129                G_EVENTQ(0);
1130                G_CURR_THREADQ(0))
1131 #endif /* GRAN */
1132     }
1133 #if defined(GRAN)
1134   next_thread:
1135     IF_GRAN_DEBUG(unused,
1136                   print_eventq(EventHd));
1137
1138     event = get_next_event();
1139
1140 #elif defined(PAR)
1141   next_thread:
1142     /* ToDo: wait for next message to arrive rather than busy wait */
1143
1144 #else /* GRAN */
1145   /* not any more
1146   next_thread:
1147     t = take_off_run_queue(END_TSO_QUEUE);
1148   */
1149 #endif /* GRAN */
1150   } /* end of while(1) */
1151 }
1152
1153 /* A hack for Hugs concurrency support.  Needs sanitisation (?) */
1154 void deleteAllThreads ( void )
1155 {
1156   StgTSO* t;
1157   IF_DEBUG(scheduler,sched_belch("deleteAllThreads()"));
1158   for (t = run_queue_hd; t != END_TSO_QUEUE; t = t->link) {
1159     deleteThread(t);
1160   }
1161   for (t = blocked_queue_hd; t != END_TSO_QUEUE; t = t->link) {
1162     deleteThread(t);
1163   }
1164   run_queue_hd = run_queue_tl = END_TSO_QUEUE;
1165   blocked_queue_hd = blocked_queue_tl = END_TSO_QUEUE;
1166 }
1167
1168 /* startThread and  insertThread are now in GranSim.c -- HWL */
1169
1170 //@node Suspend and Resume, Run queue code, Main scheduling loop, Main scheduling code
1171 //@subsection Suspend and Resume
1172
1173 /* ---------------------------------------------------------------------------
1174  * Suspending & resuming Haskell threads.
1175  *
1176  * When making a "safe" call to C (aka _ccall_GC), the task gives back
1177  * its capability before calling the C function.  This allows another
1178  * task to pick up the capability and carry on running Haskell
1179  * threads.  It also means that if the C call blocks, it won't lock
1180  * the whole system.
1181  *
1182  * The Haskell thread making the C call is put to sleep for the
1183  * duration of the call, on the susepended_ccalling_threads queue.  We
1184  * give out a token to the task, which it can use to resume the thread
1185  * on return from the C function.
1186  * ------------------------------------------------------------------------- */
1187
1188 StgInt
1189 suspendThread( Capability *cap )
1190 {
1191   nat tok;
1192
1193   ACQUIRE_LOCK(&sched_mutex);
1194
1195   IF_DEBUG(scheduler,
1196            sched_belch("thread %d did a _ccall_gc", cap->rCurrentTSO->id));
1197
1198   threadPaused(cap->rCurrentTSO);
1199   cap->rCurrentTSO->link = suspended_ccalling_threads;
1200   suspended_ccalling_threads = cap->rCurrentTSO;
1201
1202   /* Use the thread ID as the token; it should be unique */
1203   tok = cap->rCurrentTSO->id;
1204
1205 #ifdef SMP
1206   cap->link = free_capabilities;
1207   free_capabilities = cap;
1208   n_free_capabilities++;
1209 #endif
1210
1211   RELEASE_LOCK(&sched_mutex);
1212   return tok;
1213 }
1214
1215 Capability *
1216 resumeThread( StgInt tok )
1217 {
1218   StgTSO *tso, **prev;
1219   Capability *cap;
1220
1221   ACQUIRE_LOCK(&sched_mutex);
1222
1223   prev = &suspended_ccalling_threads;
1224   for (tso = suspended_ccalling_threads;
1225        tso != END_TSO_QUEUE;
1226        prev = &tso->link, tso = tso->link) {
1227     if (tso->id == (StgThreadID)tok) {
1228       *prev = tso->link;
1229       break;
1230     }
1231   }
1232   if (tso == END_TSO_QUEUE) {
1233     barf("resumeThread: thread not found");
1234   }
1235
1236 #ifdef SMP
1237   while (free_capabilities == NULL) {
1238     IF_DEBUG(scheduler, sched_belch("waiting to resume"));
1239     pthread_cond_wait(&thread_ready_cond, &sched_mutex);
1240     IF_DEBUG(scheduler, sched_belch("resuming thread %d", tso->id));
1241   }
1242   cap = free_capabilities;
1243   free_capabilities = cap->link;
1244   n_free_capabilities--;
1245 #else
1246   cap = &MainRegTable;
1247 #endif
1248
1249   cap->rCurrentTSO = tso;
1250
1251   RELEASE_LOCK(&sched_mutex);
1252   return cap;
1253 }
1254
1255
1256 /* ---------------------------------------------------------------------------
1257  * Static functions
1258  * ------------------------------------------------------------------------ */
1259 static void unblockThread(StgTSO *tso);
1260
1261 /* ---------------------------------------------------------------------------
1262  * Comparing Thread ids.
1263  *
1264  * This is used from STG land in the implementation of the
1265  * instances of Eq/Ord for ThreadIds.
1266  * ------------------------------------------------------------------------ */
1267
1268 int cmp_thread(const StgTSO *tso1, const StgTSO *tso2)
1269 {
1270   StgThreadID id1 = tso1->id;
1271   StgThreadID id2 = tso2->id;
1272
1273   if (id1 < id2) return (-1);
1274   if (id1 > id2) return 1;
1275   return 0;
1276 }
1277
1278 /* ---------------------------------------------------------------------------
1279    Create a new thread.
1280
1281    The new thread starts with the given stack size.  Before the
1282    scheduler can run, however, this thread needs to have a closure
1283    (and possibly some arguments) pushed on its stack.  See
1284    pushClosure() in Schedule.h.
1285
1286    createGenThread() and createIOThread() (in SchedAPI.h) are
1287    convenient packaged versions of this function.
1288
1289    currently pri (priority) is only used in a GRAN setup -- HWL
1290    ------------------------------------------------------------------------ */
1291 //@cindex createThread
1292 #if defined(GRAN)
1293 /*   currently pri (priority) is only used in a GRAN setup -- HWL */
1294 StgTSO *
1295 createThread(nat stack_size, StgInt pri)
1296 {
1297   return createThread_(stack_size, rtsFalse, pri);
1298 }
1299
1300 static StgTSO *
1301 createThread_(nat size, rtsBool have_lock, StgInt pri)
1302 {
1303 #else
1304 StgTSO *
1305 createThread(nat stack_size)
1306 {
1307   return createThread_(stack_size, rtsFalse);
1308 }
1309
1310 static StgTSO *
1311 createThread_(nat size, rtsBool have_lock)
1312 {
1313 #endif
1314
1315     StgTSO *tso;
1316     nat stack_size;
1317
1318     /* First check whether we should create a thread at all */
1319 #if defined(PAR)
1320   /* check that no more than RtsFlags.ParFlags.maxThreads threads are created */
1321   if (advisory_thread_count >= RtsFlags.ParFlags.maxThreads) {
1322     threadsIgnored++;
1323     belch("{createThread}Daq ghuH: refusing to create another thread; no more than %d threads allowed (currently %d)",
1324           RtsFlags.ParFlags.maxThreads, advisory_thread_count);
1325     return END_TSO_QUEUE;
1326   }
1327   threadsCreated++;
1328 #endif
1329
1330 #if defined(GRAN)
1331   ASSERT(!RtsFlags.GranFlags.Light || CurrentProc==0);
1332 #endif
1333
1334   // ToDo: check whether size = stack_size - TSO_STRUCT_SIZEW
1335
1336   /* catch ridiculously small stack sizes */
1337   if (size < MIN_STACK_WORDS + TSO_STRUCT_SIZEW) {
1338     size = MIN_STACK_WORDS + TSO_STRUCT_SIZEW;
1339   }
1340
1341   stack_size = size - TSO_STRUCT_SIZEW;
1342
1343   tso = (StgTSO *)allocate(size);
1344   TICK_ALLOC_TSO(size-TSO_STRUCT_SIZEW, 0);
1345
1346   SET_HDR(tso, &TSO_info, CCS_SYSTEM);
1347 #if defined(GRAN)
1348   SET_GRAN_HDR(tso, ThisPE);
1349 #endif
1350   tso->what_next     = ThreadEnterGHC;
1351
1352   /* tso->id needs to be unique.  For now we use a heavyweight mutex to
1353    * protect the increment operation on next_thread_id.
1354    * In future, we could use an atomic increment instead.
1355    */
1356   if (!have_lock) { ACQUIRE_LOCK(&sched_mutex); }
1357   tso->id = next_thread_id++;
1358   if (!have_lock) { RELEASE_LOCK(&sched_mutex); }
1359
1360   tso->why_blocked  = NotBlocked;
1361   tso->blocked_exceptions = NULL;
1362
1363   tso->splim        = (P_)&(tso->stack) + RESERVED_STACK_WORDS;
1364   tso->stack_size   = stack_size;
1365   tso->max_stack_size = round_to_mblocks(RtsFlags.GcFlags.maxStkSize)
1366                               - TSO_STRUCT_SIZEW;
1367   tso->sp           = (P_)&(tso->stack) + stack_size;
1368
1369 #ifdef PROFILING
1370   tso->prof.CCCS = CCS_MAIN;
1371 #endif
1372
1373   /* put a stop frame on the stack */
1374   tso->sp -= sizeofW(StgStopFrame);
1375   SET_HDR((StgClosure*)tso->sp,(StgInfoTable *)&stg_stop_thread_info,CCS_SYSTEM);
1376   tso->su = (StgUpdateFrame*)tso->sp;
1377
1378   // ToDo: check this
1379 #if defined(GRAN)
1380   tso->link = END_TSO_QUEUE;
1381   /* uses more flexible routine in GranSim */
1382   insertThread(tso, CurrentProc);
1383 #else
1384   /* In a non-GranSim setup the pushing of a TSO onto the runq is separated
1385    * from its creation
1386    */
1387 #endif
1388
1389 #if defined(GRAN) || defined(PAR)
1390   DumpGranEvent(GR_START,tso);
1391 #endif
1392
1393   /* Link the new thread on the global thread list.
1394    */
1395   tso->global_link = all_threads;
1396   all_threads = tso;
1397
1398 #if defined(GRAN)
1399   tso->gran.pri = pri;
1400 # if defined(DEBUG)
1401   tso->gran.magic = TSO_MAGIC; // debugging only
1402 # endif
1403   tso->gran.sparkname   = 0;
1404   tso->gran.startedat   = CURRENT_TIME;
1405   tso->gran.exported    = 0;
1406   tso->gran.basicblocks = 0;
1407   tso->gran.allocs      = 0;
1408   tso->gran.exectime    = 0;
1409   tso->gran.fetchtime   = 0;
1410   tso->gran.fetchcount  = 0;
1411   tso->gran.blocktime   = 0;
1412   tso->gran.blockcount  = 0;
1413   tso->gran.blockedat   = 0;
1414   tso->gran.globalsparks = 0;
1415   tso->gran.localsparks  = 0;
1416   if (RtsFlags.GranFlags.Light)
1417     tso->gran.clock  = Now; /* local clock */
1418   else
1419     tso->gran.clock  = 0;
1420
1421   IF_DEBUG(gran,printTSO(tso));
1422 #elif defined(PAR)
1423 # if defined(DEBUG)
1424   tso->par.magic = TSO_MAGIC; // debugging only
1425 # endif
1426   tso->par.sparkname   = 0;
1427   tso->par.startedat   = CURRENT_TIME;
1428   tso->par.exported    = 0;
1429   tso->par.basicblocks = 0;
1430   tso->par.allocs      = 0;
1431   tso->par.exectime    = 0;
1432   tso->par.fetchtime   = 0;
1433   tso->par.fetchcount  = 0;
1434   tso->par.blocktime   = 0;
1435   tso->par.blockcount  = 0;
1436   tso->par.blockedat   = 0;
1437   tso->par.globalsparks = 0;
1438   tso->par.localsparks  = 0;
1439 #endif
1440
1441 #if defined(GRAN)
1442   globalGranStats.tot_threads_created++;
1443   globalGranStats.threads_created_on_PE[CurrentProc]++;
1444   globalGranStats.tot_sq_len += spark_queue_len(CurrentProc);
1445   globalGranStats.tot_sq_probes++;
1446 #endif
1447
1448 #if defined(GRAN)
1449   IF_GRAN_DEBUG(pri,
1450                 belch("==__ schedule: Created TSO %d (%p);",
1451                       CurrentProc, tso, tso->id));
1452 #elif defined(PAR)
1453     IF_PAR_DEBUG(verbose,
1454                  belch("==__ schedule: Created TSO %d (%p); %d threads active",
1455                        tso->id, tso, advisory_thread_count));
1456 #else
1457   IF_DEBUG(scheduler,sched_belch("created thread %ld, stack size = %lx words",
1458                                  tso->id, tso->stack_size));
1459 #endif
1460   return tso;
1461 }
1462
1463 /*
1464   Turn a spark into a thread.
1465   ToDo: fix for SMP (needs to acquire SCHED_MUTEX!)
1466 */
1467 #if defined(PAR)
1468 //@cindex activateSpark
1469 StgTSO *
1470 activateSpark (rtsSpark spark)
1471 {
1472   StgTSO *tso;
1473
1474   ASSERT(spark != (rtsSpark)NULL);
1475   tso = createThread_(RtsFlags.GcFlags.initialStkSize, rtsTrue);
1476   if (tso!=END_TSO_QUEUE) {
1477     pushClosure(tso,spark);
1478     PUSH_ON_RUN_QUEUE(tso);
1479     advisory_thread_count++;
1480
1481     if (RtsFlags.ParFlags.ParStats.Full) {
1482       //ASSERT(run_queue_hd == END_TSO_QUEUE); // I think ...
1483       IF_PAR_DEBUG(verbose,
1484                    belch("==^^ activateSpark: turning spark of closure %p (%s) into a thread",
1485                          (StgClosure *)spark, info_type((StgClosure *)spark)));
1486     }
1487   } else {
1488     barf("activateSpark: Cannot create TSO");
1489   }
1490   // ToDo: fwd info on local/global spark to thread -- HWL
1491   // tso->gran.exported =  spark->exported;
1492   // tso->gran.locked =   !spark->global;
1493   // tso->gran.sparkname = spark->name;
1494
1495   return tso;
1496 }
1497 #endif
1498
1499 /* ---------------------------------------------------------------------------
1500  * scheduleThread()
1501  *
1502  * scheduleThread puts a thread on the head of the runnable queue.
1503  * This will usually be done immediately after a thread is created.
1504  * The caller of scheduleThread must create the thread using e.g.
1505  * createThread and push an appropriate closure
1506  * on this thread's stack before the scheduler is invoked.
1507  * ------------------------------------------------------------------------ */
1508
1509 void
1510 scheduleThread(StgTSO *tso)
1511 {
1512   if (tso==END_TSO_QUEUE){
1513     schedule();
1514     return;
1515   }
1516
1517   ACQUIRE_LOCK(&sched_mutex);
1518
1519   /* Put the new thread on the head of the runnable queue.  The caller
1520    * better push an appropriate closure on this thread's stack
1521    * beforehand.  In the SMP case, the thread may start running as
1522    * soon as we release the scheduler lock below.
1523    */
1524   PUSH_ON_RUN_QUEUE(tso);
1525   THREAD_RUNNABLE();
1526
1527 #if 0
1528   IF_DEBUG(scheduler,printTSO(tso));
1529 #endif
1530   RELEASE_LOCK(&sched_mutex);
1531 }
1532
1533 /* ---------------------------------------------------------------------------
1534  * startTasks()
1535  *
1536  * Start up Posix threads to run each of the scheduler tasks.
1537  * I believe the task ids are not needed in the system as defined.
1538  *  KH @ 25/10/99
1539  * ------------------------------------------------------------------------ */
1540
1541 #if defined(PAR) || defined(SMP)
1542 void *
1543 taskStart( void *arg STG_UNUSED )
1544 {
1545   rts_evalNothing(NULL);
1546 }
1547 #endif
1548
1549 /* ---------------------------------------------------------------------------
1550  * initScheduler()
1551  *
1552  * Initialise the scheduler.  This resets all the queues - if the
1553  * queues contained any threads, they'll be garbage collected at the
1554  * next pass.
1555  *
1556  * This now calls startTasks(), so should only be called once!  KH @ 25/10/99
1557  * ------------------------------------------------------------------------ */
1558
1559 #ifdef SMP
1560 static void
1561 term_handler(int sig STG_UNUSED)
1562 {
1563   stat_workerStop();
1564   ACQUIRE_LOCK(&term_mutex);
1565   await_death--;
1566   RELEASE_LOCK(&term_mutex);
1567   pthread_exit(NULL);
1568 }
1569 #endif
1570
1571 //@cindex initScheduler
1572 void
1573 initScheduler(void)
1574 {
1575 #if defined(GRAN)
1576   nat i;
1577
1578   for (i=0; i<=MAX_PROC; i++) {
1579     run_queue_hds[i]      = END_TSO_QUEUE;
1580     run_queue_tls[i]      = END_TSO_QUEUE;
1581     blocked_queue_hds[i]  = END_TSO_QUEUE;
1582     blocked_queue_tls[i]  = END_TSO_QUEUE;
1583     ccalling_threadss[i]  = END_TSO_QUEUE;
1584   }
1585 #else
1586   run_queue_hd      = END_TSO_QUEUE;
1587   run_queue_tl      = END_TSO_QUEUE;
1588   blocked_queue_hd  = END_TSO_QUEUE;
1589   blocked_queue_tl  = END_TSO_QUEUE;
1590 #endif
1591
1592   suspended_ccalling_threads  = END_TSO_QUEUE;
1593
1594   main_threads = NULL;
1595   all_threads  = END_TSO_QUEUE;
1596
1597   context_switch = 0;
1598   interrupted    = 0;
1599
1600   RtsFlags.ConcFlags.ctxtSwitchTicks =
1601       RtsFlags.ConcFlags.ctxtSwitchTime / TICK_MILLISECS;
1602
1603 #ifdef INTERPRETER
1604   ecafList = END_ECAF_LIST;
1605   clearECafTable();
1606 #endif
1607
1608   /* Install the SIGHUP handler */
1609 #ifdef SMP
1610   {
1611     struct sigaction action,oact;
1612
1613     action.sa_handler = term_handler;
1614     sigemptyset(&action.sa_mask);
1615     action.sa_flags = 0;
1616     if (sigaction(SIGTERM, &action, &oact) != 0) {
1617       barf("can't install TERM handler");
1618     }
1619   }
1620 #endif
1621
1622 #ifdef SMP
1623   /* Allocate N Capabilities */
1624   {
1625     nat i;
1626     Capability *cap, *prev;
1627     cap  = NULL;
1628     prev = NULL;
1629     for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
1630       cap = stgMallocBytes(sizeof(Capability), "initScheduler:capabilities");
1631       cap->link = prev;
1632       prev = cap;
1633     }
1634     free_capabilities = cap;
1635     n_free_capabilities = RtsFlags.ParFlags.nNodes;
1636   }
1637   IF_DEBUG(scheduler,fprintf(stderr,"scheduler: Allocated %d capabilities\n",
1638                              n_free_capabilities););
1639 #endif
1640
1641 #if defined(SMP) || defined(PAR)
1642   initSparkPools();
1643 #endif
1644 }
1645
1646 #ifdef SMP
1647 void
1648 startTasks( void )
1649 {
1650   nat i;
1651   int r;
1652   pthread_t tid;
1653
1654   /* make some space for saving all the thread ids */
1655   task_ids = stgMallocBytes(RtsFlags.ParFlags.nNodes * sizeof(task_info),
1656                             "initScheduler:task_ids");
1657
1658   /* and create all the threads */
1659   for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
1660     r = pthread_create(&tid,NULL,taskStart,NULL);
1661     if (r != 0) {
1662       barf("startTasks: Can't create new Posix thread");
1663     }
1664     task_ids[i].id = tid;
1665     task_ids[i].mut_time = 0.0;
1666     task_ids[i].mut_etime = 0.0;
1667     task_ids[i].gc_time = 0.0;
1668     task_ids[i].gc_etime = 0.0;
1669     task_ids[i].elapsedtimestart = elapsedtime();
1670     IF_DEBUG(scheduler,fprintf(stderr,"scheduler: Started task: %ld\n",tid););
1671   }
1672 }
1673 #endif
1674
1675 void
1676 exitScheduler( void )
1677 {
1678 #ifdef SMP
1679   nat i;
1680
1681   /* Don't want to use pthread_cancel, since we'd have to install
1682    * these silly exception handlers (pthread_cleanup_{push,pop}) around
1683    * all our locks.
1684    */
1685 #if 0
1686   /* Cancel all our tasks */
1687   for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
1688     pthread_cancel(task_ids[i].id);
1689   }
1690
1691   /* Wait for all the tasks to terminate */
1692   for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
1693     IF_DEBUG(scheduler,fprintf(stderr,"scheduler: waiting for task %ld\n",
1694                                task_ids[i].id));
1695     pthread_join(task_ids[i].id, NULL);
1696   }
1697 #endif
1698
1699   /* Send 'em all a SIGHUP.  That should shut 'em up.
1700    */
1701   await_death = RtsFlags.ParFlags.nNodes;
1702   for (i = 0; i < RtsFlags.ParFlags.nNodes; i++) {
1703     pthread_kill(task_ids[i].id,SIGTERM);
1704   }
1705   while (await_death > 0) {
1706     sched_yield();
1707   }
1708 #endif
1709 }
1710
1711 /* -----------------------------------------------------------------------------
1712    Managing the per-task allocation areas.
1713
1714    Each capability comes with an allocation area.  These are
1715    fixed-length block lists into which allocation can be done.
1716
1717    ToDo: no support for two-space collection at the moment???
1718    -------------------------------------------------------------------------- */
1719
1720 /* -----------------------------------------------------------------------------
1721  * waitThread is the external interface for running a new computation
1722  * and waiting for the result.
1723  *
1724  * In the non-SMP case, we create a new main thread, push it on the
1725  * main-thread stack, and invoke the scheduler to run it.  The
1726  * scheduler will return when the top main thread on the stack has
1727  * completed or died, and fill in the necessary fields of the
1728  * main_thread structure.
1729  *
1730  * In the SMP case, we create a main thread as before, but we then
1731  * create a new condition variable and sleep on it.  When our new
1732  * main thread has completed, we'll be woken up and the status/result
1733  * will be in the main_thread struct.
1734  * -------------------------------------------------------------------------- */
1735
1736 int
1737 howManyThreadsAvail ( void )
1738 {
1739    int i = 0;
1740    StgTSO* q;
1741    for (q = run_queue_hd; q != END_TSO_QUEUE; q = q->link)
1742       i++;
1743    for (q = blocked_queue_hd; q != END_TSO_QUEUE; q = q->link)
1744       i++;
1745    return i;
1746 }
1747
1748 void
1749 finishAllThreads ( void )
1750 {
1751    do {
1752       while (run_queue_hd != END_TSO_QUEUE) {
1753          waitThread ( run_queue_hd, NULL );
1754       }
1755       while (blocked_queue_hd != END_TSO_QUEUE) {
1756          waitThread ( blocked_queue_hd, NULL );
1757       }
1758    } while
1759       (blocked_queue_hd != END_TSO_QUEUE ||
1760         run_queue_hd != END_TSO_QUEUE);
1761 }
1762
1763 SchedulerStatus
1764 waitThread(StgTSO *tso, /*out*/StgClosure **ret)
1765 {
1766   StgMainThread *m;
1767   SchedulerStatus stat;
1768
1769   ACQUIRE_LOCK(&sched_mutex);
1770
1771   m = stgMallocBytes(sizeof(StgMainThread), "waitThread");
1772
1773   m->tso = tso;
1774   m->ret = ret;
1775   m->stat = NoStatus;
1776 #ifdef SMP
1777   pthread_cond_init(&m->wakeup, NULL);
1778 #endif
1779
1780   m->link = main_threads;
1781   main_threads = m;
1782
1783   IF_DEBUG(scheduler, fprintf(stderr, "scheduler: new main thread (%d)\n",
1784                               m->tso->id));
1785
1786 #ifdef SMP
1787   do {
1788     pthread_cond_wait(&m->wakeup, &sched_mutex);
1789   } while (m->stat == NoStatus);
1790 #elif defined(GRAN)
1791   /* GranSim specific init */
1792   CurrentTSO = m->tso;                // the TSO to run
1793   procStatus[MainProc] = Busy;        // status of main PE
1794   CurrentProc = MainProc;             // PE to run it on
1795
1796   schedule();
1797 #else
1798   schedule();
1799   ASSERT(m->stat != NoStatus);
1800 #endif
1801
1802   stat = m->stat;
1803
1804 #ifdef SMP
1805   pthread_cond_destroy(&m->wakeup);
1806 #endif
1807
1808   IF_DEBUG(scheduler, fprintf(stderr, "scheduler: main thread (%d) finished\n",
1809                               m->tso->id));
1810   free(m);
1811
1812   RELEASE_LOCK(&sched_mutex);
1813
1814   return stat;
1815 }
1816
1817 //@node Run queue code, Garbage Collextion Routines, Suspend and Resume, Main scheduling code
1818 //@subsection Run queue code
1819
1820 #if 0
1821 /*
1822    NB: In GranSim we have many run queues; run_queue_hd is actually a macro
1823        unfolding to run_queue_hds[CurrentProc], thus CurrentProc is an
1824        implicit global variable that has to be correct when calling these
1825        fcts -- HWL
1826 */
1827
1828 /* Put the new thread on the head of the runnable queue.
1829  * The caller of createThread better push an appropriate closure
1830  * on this thread's stack before the scheduler is invoked.
1831  */
1832 static /* inline */ void
1833 add_to_run_queue(tso)
1834 StgTSO* tso;
1835 {
1836   ASSERT(tso!=run_queue_hd && tso!=run_queue_tl);
1837   tso->link = run_queue_hd;
1838   run_queue_hd = tso;
1839   if (run_queue_tl == END_TSO_QUEUE) {
1840     run_queue_tl = tso;
1841   }
1842 }
1843
1844 /* Put the new thread at the end of the runnable queue. */
1845 static /* inline */ void
1846 push_on_run_queue(tso)
1847 StgTSO* tso;
1848 {
1849   ASSERT(get_itbl((StgClosure *)tso)->type == TSO);
1850   ASSERT(run_queue_hd!=NULL && run_queue_tl!=NULL);
1851   ASSERT(tso!=run_queue_hd && tso!=run_queue_tl);
1852   if (run_queue_hd == END_TSO_QUEUE) {
1853     run_queue_hd = tso;
1854   } else {
1855     run_queue_tl->link = tso;
1856   }
1857   run_queue_tl = tso;
1858 }
1859
1860 /*
1861    Should be inlined because it's used very often in schedule.  The tso
1862    argument is actually only needed in GranSim, where we want to have the
1863    possibility to schedule *any* TSO on the run queue, irrespective of the
1864    actual ordering. Therefore, if tso is not the nil TSO then we traverse
1865    the run queue and dequeue the tso, adjusting the links in the queue.
1866 */
1867 //@cindex take_off_run_queue
1868 static /* inline */ StgTSO*
1869 take_off_run_queue(StgTSO *tso) {
1870   StgTSO *t, *prev;
1871
1872   /*
1873      qetlaHbogh Qu' ngaSbogh ghomDaQ {tso} yIteq!
1874
1875      if tso is specified, unlink that tso from the run_queue (doesn't have
1876      to be at the beginning of the queue); GranSim only
1877   */
1878   if (tso!=END_TSO_QUEUE) {
1879     /* find tso in queue */
1880     for (t=run_queue_hd, prev=END_TSO_QUEUE;
1881          t!=END_TSO_QUEUE && t!=tso;
1882          prev=t, t=t->link)
1883       /* nothing */ ;
1884     ASSERT(t==tso);
1885     /* now actually dequeue the tso */
1886     if (prev!=END_TSO_QUEUE) {
1887       ASSERT(run_queue_hd!=t);
1888       prev->link = t->link;
1889     } else {
1890       /* t is at beginning of thread queue */
1891       ASSERT(run_queue_hd==t);
1892       run_queue_hd = t->link;
1893     }
1894     /* t is at end of thread queue */
1895     if (t->link==END_TSO_QUEUE) {
1896       ASSERT(t==run_queue_tl);
1897       run_queue_tl = prev;
1898     } else {
1899       ASSERT(run_queue_tl!=t);
1900     }
1901     t->link = END_TSO_QUEUE;
1902   } else {
1903     /* take tso from the beginning of the queue; std concurrent code */
1904     t = run_queue_hd;
1905     if (t != END_TSO_QUEUE) {
1906       run_queue_hd = t->link;
1907       t->link = END_TSO_QUEUE;
1908       if (run_queue_hd == END_TSO_QUEUE) {
1909         run_queue_tl = END_TSO_QUEUE;
1910       }
1911     }
1912   }
1913   return t;
1914 }
1915
1916 #endif /* 0 */
1917
1918 //@node Garbage Collextion Routines, Blocking Queue Routines, Run queue code, Main scheduling code
1919 //@subsection Garbage Collextion Routines
1920
1921 /* ---------------------------------------------------------------------------
1922    Where are the roots that we know about?
1923
1924         - all the threads on the runnable queue
1925         - all the threads on the blocked queue
1926         - all the thread currently executing a _ccall_GC
1927         - all the "main threads"
1928
1929    ------------------------------------------------------------------------ */
1930
1931 /* This has to be protected either by the scheduler monitor, or by the
1932         garbage collection monitor (probably the latter).
1933         KH @ 25/10/99
1934 */
1935
1936 static void GetRoots(void)
1937 {
1938   StgMainThread *m;
1939
1940 #if defined(GRAN)
1941   {
1942     nat i;
1943     for (i=0; i<=RtsFlags.GranFlags.proc; i++) {
1944       if ((run_queue_hds[i] != END_TSO_QUEUE) && ((run_queue_hds[i] != NULL)))
1945         run_queue_hds[i]    = (StgTSO *)MarkRoot((StgClosure *)run_queue_hds[i]);
1946       if ((run_queue_tls[i] != END_TSO_QUEUE) && ((run_queue_tls[i] != NULL)))
1947         run_queue_tls[i]    = (StgTSO *)MarkRoot((StgClosure *)run_queue_tls[i]);
1948
1949       if ((blocked_queue_hds[i] != END_TSO_QUEUE) && ((blocked_queue_hds[i] != NULL)))
1950         blocked_queue_hds[i] = (StgTSO *)MarkRoot((StgClosure *)blocked_queue_hds[i]);
1951       if ((blocked_queue_tls[i] != END_TSO_QUEUE) && ((blocked_queue_tls[i] != NULL)))
1952         blocked_queue_tls[i] = (StgTSO *)MarkRoot((StgClosure *)blocked_queue_tls[i]);
1953       if ((ccalling_threadss[i] != END_TSO_QUEUE) && ((ccalling_threadss[i] != NULL)))
1954         ccalling_threadss[i] = (StgTSO *)MarkRoot((StgClosure *)ccalling_threadss[i]);
1955     }
1956   }
1957
1958   markEventQueue();
1959
1960 #else /* !GRAN */
1961   if (run_queue_hd != END_TSO_QUEUE) {
1962     ASSERT(run_queue_tl != END_TSO_QUEUE);
1963     run_queue_hd      = (StgTSO *)MarkRoot((StgClosure *)run_queue_hd);
1964     run_queue_tl      = (StgTSO *)MarkRoot((StgClosure *)run_queue_tl);
1965   }
1966
1967   if (blocked_queue_hd != END_TSO_QUEUE) {
1968     ASSERT(blocked_queue_tl != END_TSO_QUEUE);
1969     blocked_queue_hd  = (StgTSO *)MarkRoot((StgClosure *)blocked_queue_hd);
1970     blocked_queue_tl  = (StgTSO *)MarkRoot((StgClosure *)blocked_queue_tl);
1971   }
1972 #endif
1973
1974   for (m = main_threads; m != NULL; m = m->link) {
1975     m->tso = (StgTSO *)MarkRoot((StgClosure *)m->tso);
1976   }
1977   if (suspended_ccalling_threads != END_TSO_QUEUE)
1978     suspended_ccalling_threads =
1979       (StgTSO *)MarkRoot((StgClosure *)suspended_ccalling_threads);
1980
1981 #if defined(SMP) || defined(PAR) || defined(GRAN)
1982   markSparkQueue();
1983 #endif
1984 }
1985
1986 /* -----------------------------------------------------------------------------
1987    performGC
1988
1989    This is the interface to the garbage collector from Haskell land.
1990    We provide this so that external C code can allocate and garbage
1991    collect when called from Haskell via _ccall_GC.
1992
1993    It might be useful to provide an interface whereby the programmer
1994    can specify more roots (ToDo).
1995
1996    This needs to be protected by the GC condition variable above.  KH.
1997    -------------------------------------------------------------------------- */
1998
1999 void (*extra_roots)(void);
2000
2001 void
2002 performGC(void)
2003 {
2004   GarbageCollect(GetRoots,rtsFalse);
2005 }
2006
2007 void
2008 performMajorGC(void)
2009 {
2010   GarbageCollect(GetRoots,rtsTrue);
2011 }
2012
2013 static void
2014 AllRoots(void)
2015 {
2016   GetRoots();                   /* the scheduler's roots */
2017   extra_roots();                /* the user's roots */
2018 }
2019
2020 void
2021 performGCWithRoots(void (*get_roots)(void))
2022 {
2023   extra_roots = get_roots;
2024
2025   GarbageCollect(AllRoots,rtsFalse);
2026 }
2027
2028 /* -----------------------------------------------------------------------------
2029    Stack overflow
2030
2031    If the thread has reached its maximum stack size, then raise the
2032    StackOverflow exception in the offending thread.  Otherwise
2033    relocate the TSO into a larger chunk of memory and adjust its stack
2034    size appropriately.
2035    -------------------------------------------------------------------------- */
2036
2037 static StgTSO *
2038 threadStackOverflow(StgTSO *tso)
2039 {
2040   nat new_stack_size, new_tso_size, diff, stack_words;
2041   StgPtr new_sp;
2042   StgTSO *dest;
2043
2044   IF_DEBUG(sanity,checkTSO(tso));
2045   if (tso->stack_size >= tso->max_stack_size) {
2046
2047     IF_DEBUG(gc,
2048              belch("@@ threadStackOverflow of TSO %d (%p): stack too large (now %ld; max is %ld",
2049                    tso->id, tso, tso->stack_size, tso->max_stack_size);
2050              /* If we're debugging, just print out the top of the stack */
2051              printStackChunk(tso->sp, stg_min(tso->stack+tso->stack_size,
2052                                               tso->sp+64)));
2053
2054 #ifdef INTERPRETER
2055     fprintf(stderr, "fatal: stack overflow in Hugs; aborting\n" );
2056     exit(1);
2057 #else
2058     /* Send this thread the StackOverflow exception */
2059     raiseAsync(tso, (StgClosure *)stackOverflow_closure);
2060 #endif
2061     return tso;
2062   }
2063
2064   /* Try to double the current stack size.  If that takes us over the
2065    * maximum stack size for this thread, then use the maximum instead.
2066    * Finally round up so the TSO ends up as a whole number of blocks.
2067    */
2068   new_stack_size = stg_min(tso->stack_size * 2, tso->max_stack_size);
2069   new_tso_size   = (nat)BLOCK_ROUND_UP(new_stack_size * sizeof(W_) +
2070                                        TSO_STRUCT_SIZE)/sizeof(W_);
2071   new_tso_size = round_to_mblocks(new_tso_size);  /* Be MBLOCK-friendly */
2072   new_stack_size = new_tso_size - TSO_STRUCT_SIZEW;
2073
2074   IF_DEBUG(scheduler, fprintf(stderr,"scheduler: increasing stack size from %d words to %d.\n", tso->stack_size, new_stack_size));
2075
2076   dest = (StgTSO *)allocate(new_tso_size);
2077   TICK_ALLOC_TSO(new_tso_size-sizeofW(StgTSO),0);
2078
2079   /* copy the TSO block and the old stack into the new area */
2080   memcpy(dest,tso,TSO_STRUCT_SIZE);
2081   stack_words = tso->stack + tso->stack_size - tso->sp;
2082   new_sp = (P_)dest + new_tso_size - stack_words;
2083   memcpy(new_sp, tso->sp, stack_words * sizeof(W_));
2084
2085   /* relocate the stack pointers... */
2086   diff = (P_)new_sp - (P_)tso->sp; /* In *words* */
2087   dest->su    = (StgUpdateFrame *) ((P_)dest->su + diff);
2088   dest->sp    = new_sp;
2089   dest->splim = (P_)dest->splim + (nat)((P_)dest - (P_)tso);
2090   dest->stack_size = new_stack_size;
2091
2092   /* and relocate the update frame list */
2093   relocate_TSO(tso, dest);
2094
2095   /* Mark the old TSO as relocated.  We have to check for relocated
2096    * TSOs in the garbage collector and any primops that deal with TSOs.
2097    *
2098    * It's important to set the sp and su values to just beyond the end
2099    * of the stack, so we don't attempt to scavenge any part of the
2100    * dead TSO's stack.
2101    */
2102   tso->what_next = ThreadRelocated;
2103   tso->link = dest;
2104   tso->sp = (P_)&(tso->stack[tso->stack_size]);
2105   tso->su = (StgUpdateFrame *)tso->sp;
2106   tso->why_blocked = NotBlocked;
2107   dest->mut_link = NULL;
2108
2109   IF_PAR_DEBUG(verbose,
2110                belch("@@ threadStackOverflow of TSO %d (now at %p): stack size increased to %ld",
2111                      tso->id, tso, tso->stack_size);
2112                /* If we're debugging, just print out the top of the stack */
2113                printStackChunk(tso->sp, stg_min(tso->stack+tso->stack_size,
2114                                                 tso->sp+64)));
2115
2116   IF_DEBUG(sanity,checkTSO(tso));
2117 #if 0
2118   IF_DEBUG(scheduler,printTSO(dest));
2119 #endif
2120
2121   return dest;
2122 }
2123
2124 //@node Blocking Queue Routines, Exception Handling Routines, Garbage Collextion Routines, Main scheduling code
2125 //@subsection Blocking Queue Routines
2126
2127 /* ---------------------------------------------------------------------------
2128    Wake up a queue that was blocked on some resource.
2129    ------------------------------------------------------------------------ */
2130
2131 /* ToDo: check push_on_run_queue vs. PUSH_ON_RUN_QUEUE */
2132
2133 #if defined(GRAN)
2134 static inline void
2135 unblockCount ( StgBlockingQueueElement *bqe, StgClosure *node )
2136 {
2137 }
2138 #elif defined(PAR)
2139 static inline void
2140 unblockCount ( StgBlockingQueueElement *bqe, StgClosure *node )
2141 {
2142   /* write RESUME events to log file and
2143      update blocked and fetch time (depending on type of the orig closure) */
2144   if (RtsFlags.ParFlags.ParStats.Full) {
2145     DumpRawGranEvent(CURRENT_PROC, CURRENT_PROC,
2146                      GR_RESUME, ((StgTSO *)bqe), ((StgTSO *)bqe)->block_info.closure,
2147                      0, 0 /* spark_queue_len(ADVISORY_POOL) */);
2148
2149     switch (get_itbl(node)->type) {
2150         case FETCH_ME_BQ:
2151           ((StgTSO *)bqe)->par.fetchtime += CURRENT_TIME-((StgTSO *)bqe)->par.blockedat;
2152           break;
2153         case RBH:
2154         case FETCH_ME:
2155         case BLACKHOLE_BQ:
2156           ((StgTSO *)bqe)->par.blocktime += CURRENT_TIME-((StgTSO *)bqe)->par.blockedat;
2157           break;
2158         default:
2159           barf("{unblockOneLocked}Daq Qagh: unexpected closure in blocking queue");
2160         }
2161       }
2162 }
2163 #endif
2164
2165 #if defined(GRAN)
2166 static StgBlockingQueueElement *
2167 unblockOneLocked(StgBlockingQueueElement *bqe, StgClosure *node)
2168 {
2169     StgTSO *tso;
2170     PEs node_loc, tso_loc;
2171
2172     node_loc = where_is(node); // should be lifted out of loop
2173     tso = (StgTSO *)bqe;  // wastes an assignment to get the type right
2174     tso_loc = where_is((StgClosure *)tso);
2175     if (IS_LOCAL_TO(PROCS(node),tso_loc)) { // TSO is local
2176       /* !fake_fetch => TSO is on CurrentProc is same as IS_LOCAL_TO */
2177       ASSERT(CurrentProc!=node_loc || tso_loc==CurrentProc);
2178       CurrentTime[CurrentProc] += RtsFlags.GranFlags.Costs.lunblocktime;
2179       // insertThread(tso, node_loc);
2180       new_event(tso_loc, tso_loc, CurrentTime[CurrentProc],
2181                 ResumeThread,
2182                 tso, node, (rtsSpark*)NULL);
2183       tso->link = END_TSO_QUEUE; // overwrite link just to be sure
2184       // len_local++;
2185       // len++;
2186     } else { // TSO is remote (actually should be FMBQ)
2187       CurrentTime[CurrentProc] += RtsFlags.GranFlags.Costs.mpacktime +
2188                                   RtsFlags.GranFlags.Costs.gunblocktime +
2189                                   RtsFlags.GranFlags.Costs.latency;
2190       new_event(tso_loc, CurrentProc, CurrentTime[CurrentProc],
2191                 UnblockThread,
2192                 tso, node, (rtsSpark*)NULL);
2193       tso->link = END_TSO_QUEUE; // overwrite link just to be sure
2194       // len++;
2195     }
2196     /* the thread-queue-overhead is accounted for in either Resume or UnblockThread */
2197     IF_GRAN_DEBUG(bq,
2198                   fprintf(stderr," %s TSO %d (%p) [PE %d] (block_info.closure=%p) (next=%p) ,",
2199                           (node_loc==tso_loc ? "Local" : "Global"),
2200                           tso->id, tso, CurrentProc, tso->block_info.closure, tso->link));
2201     tso->block_info.closure = NULL;
2202     IF_DEBUG(scheduler,belch("-- Waking up thread %ld (%p)",
2203                              tso->id, tso));
2204 }
2205 #elif defined(PAR)
2206 static StgBlockingQueueElement *
2207 unblockOneLocked(StgBlockingQueueElement *bqe, StgClosure *node)
2208 {
2209     StgBlockingQueueElement *next;
2210
2211     switch (get_itbl(bqe)->type) {
2212     case TSO:
2213       ASSERT(((StgTSO *)bqe)->why_blocked != NotBlocked);
2214       /* if it's a TSO just push it onto the run_queue */
2215       next = bqe->link;
2216       // ((StgTSO *)bqe)->link = END_TSO_QUEUE; // debugging?
2217       PUSH_ON_RUN_QUEUE((StgTSO *)bqe);
2218       THREAD_RUNNABLE();
2219       unblockCount(bqe, node);
2220       /* reset blocking status after dumping event */
2221       ((StgTSO *)bqe)->why_blocked = NotBlocked;
2222       break;
2223
2224     case BLOCKED_FETCH:
2225       /* if it's a BLOCKED_FETCH put it on the PendingFetches list */
2226       next = bqe->link;
2227       bqe->link = PendingFetches;
2228       PendingFetches = bqe;
2229       break;
2230
2231 # if defined(DEBUG)
2232       /* can ignore this case in a non-debugging setup;
2233          see comments on RBHSave closures above */
2234     case CONSTR:
2235       /* check that the closure is an RBHSave closure */
2236       ASSERT(get_itbl((StgClosure *)bqe) == &RBH_Save_0_info ||
2237              get_itbl((StgClosure *)bqe) == &RBH_Save_1_info ||
2238              get_itbl((StgClosure *)bqe) == &RBH_Save_2_info);
2239       break;
2240
2241     default:
2242       barf("{unblockOneLocked}Daq Qagh: Unexpected IP (%#lx; %s) in blocking queue at %#lx\n",
2243            get_itbl((StgClosure *)bqe), info_type((StgClosure *)bqe),
2244            (StgClosure *)bqe);
2245 # endif
2246     }
2247   // IF_DEBUG(scheduler,sched_belch("waking up thread %ld", tso->id));
2248   return next;
2249 }
2250
2251 #else /* !GRAN && !PAR */
2252 static StgTSO *
2253 unblockOneLocked(StgTSO *tso)
2254 {
2255   StgTSO *next;
2256
2257   ASSERT(get_itbl(tso)->type == TSO);
2258   ASSERT(tso->why_blocked != NotBlocked);
2259   tso->why_blocked = NotBlocked;
2260   next = tso->link;
2261   PUSH_ON_RUN_QUEUE(tso);
2262   THREAD_RUNNABLE();
2263   IF_DEBUG(scheduler,sched_belch("waking up thread %ld", tso->id));
2264   return next;
2265 }
2266 #endif
2267
2268 #if defined(GRAN) || defined(PAR)
2269 inline StgBlockingQueueElement *
2270 unblockOne(StgBlockingQueueElement *bqe, StgClosure *node)
2271 {
2272   ACQUIRE_LOCK(&sched_mutex);
2273   bqe = unblockOneLocked(bqe, node);
2274   RELEASE_LOCK(&sched_mutex);
2275   return bqe;
2276 }
2277 #else
2278 inline StgTSO *
2279 unblockOne(StgTSO *tso)
2280 {
2281   ACQUIRE_LOCK(&sched_mutex);
2282   tso = unblockOneLocked(tso);
2283   RELEASE_LOCK(&sched_mutex);
2284   return tso;
2285 }
2286 #endif
2287
2288 #if defined(GRAN)
2289 void
2290 awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node)
2291 {
2292   StgBlockingQueueElement *bqe;
2293   PEs node_loc;
2294   nat len = 0;
2295
2296   IF_GRAN_DEBUG(bq,
2297                 belch("## AwBQ for node %p on PE %d @ %ld by TSO %d (%p): ", \
2298                       node, CurrentProc, CurrentTime[CurrentProc],
2299                       CurrentTSO->id, CurrentTSO));
2300
2301   node_loc = where_is(node);
2302
2303   ASSERT(get_itbl(q)->type == TSO ||   // q is either a TSO or an RBHSave
2304          get_itbl(q)->type == CONSTR); // closure (type constructor)
2305   ASSERT(is_unique(node));
2306
2307   /* FAKE FETCH: magically copy the node to the tso's proc;
2308      no Fetch necessary because in reality the node should not have been
2309      moved to the other PE in the first place
2310   */
2311   if (CurrentProc!=node_loc) {
2312     IF_GRAN_DEBUG(bq,
2313                   belch("## node %p is on PE %d but CurrentProc is %d (TSO %d); assuming fake fetch and adjusting bitmask (old: %#x)",
2314                         node, node_loc, CurrentProc, CurrentTSO->id,
2315                         // CurrentTSO, where_is(CurrentTSO),
2316                         node->header.gran.procs));
2317     node->header.gran.procs = (node->header.gran.procs) | PE_NUMBER(CurrentProc);
2318     IF_GRAN_DEBUG(bq,
2319                   belch("## new bitmask of node %p is %#x",
2320                         node, node->header.gran.procs));
2321     if (RtsFlags.GranFlags.GranSimStats.Global) {
2322       globalGranStats.tot_fake_fetches++;
2323     }
2324   }
2325
2326   bqe = q;
2327   // ToDo: check: ASSERT(CurrentProc==node_loc);
2328   while (get_itbl(bqe)->type==TSO) { // q != END_TSO_QUEUE) {
2329     //next = bqe->link;
2330     /*
2331        bqe points to the current element in the queue
2332        next points to the next element in the queue
2333     */
2334     //tso = (StgTSO *)bqe;  // wastes an assignment to get the type right
2335     //tso_loc = where_is(tso);
2336     len++;
2337     bqe = unblockOneLocked(bqe, node);
2338   }
2339
2340   /* if this is the BQ of an RBH, we have to put back the info ripped out of
2341      the closure to make room for the anchor of the BQ */
2342   if (bqe!=END_BQ_QUEUE) {
2343     ASSERT(get_itbl(node)->type == RBH && get_itbl(bqe)->type == CONSTR);
2344     /*
2345     ASSERT((info_ptr==&RBH_Save_0_info) ||
2346            (info_ptr==&RBH_Save_1_info) ||
2347            (info_ptr==&RBH_Save_2_info));
2348     */
2349     /* cf. convertToRBH in RBH.c for writing the RBHSave closure */
2350     ((StgRBH *)node)->blocking_queue = (StgBlockingQueueElement *)((StgRBHSave *)bqe)->payload[0];
2351     ((StgRBH *)node)->mut_link       = (StgMutClosure *)((StgRBHSave *)bqe)->payload[1];
2352
2353     IF_GRAN_DEBUG(bq,
2354                   belch("## Filled in RBH_Save for %p (%s) at end of AwBQ",
2355                         node, info_type(node)));
2356   }
2357
2358   /* statistics gathering */
2359   if (RtsFlags.GranFlags.GranSimStats.Global) {
2360     // globalGranStats.tot_bq_processing_time += bq_processing_time;
2361     globalGranStats.tot_bq_len += len;      // total length of all bqs awakened
2362     // globalGranStats.tot_bq_len_local += len_local;  // same for local TSOs only
2363     globalGranStats.tot_awbq++;             // total no. of bqs awakened
2364   }
2365   IF_GRAN_DEBUG(bq,
2366                 fprintf(stderr,"## BQ Stats of %p: [%d entries] %s\n",
2367                         node, len, (bqe!=END_BQ_QUEUE) ? "RBH" : ""));
2368 }
2369 #elif defined(PAR)
2370 void
2371 awakenBlockedQueue(StgBlockingQueueElement *q, StgClosure *node)
2372 {
2373   StgBlockingQueueElement *bqe, *next;
2374
2375   ACQUIRE_LOCK(&sched_mutex);
2376
2377   IF_PAR_DEBUG(verbose,
2378                belch("## AwBQ for node %p on [%x]: ",
2379                      node, mytid));
2380
2381   ASSERT(get_itbl(q)->type == TSO ||
2382          get_itbl(q)->type == BLOCKED_FETCH ||
2383          get_itbl(q)->type == CONSTR);
2384
2385   bqe = q;
2386   while (get_itbl(bqe)->type==TSO ||
2387          get_itbl(bqe)->type==BLOCKED_FETCH) {
2388     bqe = unblockOneLocked(bqe, node);
2389   }
2390   RELEASE_LOCK(&sched_mutex);
2391 }
2392
2393 #else   /* !GRAN && !PAR */
2394 void
2395 awakenBlockedQueue(StgTSO *tso)
2396 {
2397   ACQUIRE_LOCK(&sched_mutex);
2398   while (tso != END_TSO_QUEUE) {
2399     tso = unblockOneLocked(tso);
2400   }
2401   RELEASE_LOCK(&sched_mutex);
2402 }
2403 #endif
2404
2405 //@node Exception Handling Routines, Debugging Routines, Blocking Queue Routines, Main scheduling code
2406 //@subsection Exception Handling Routines
2407
2408 /* ---------------------------------------------------------------------------
2409    Interrupt execution
2410    - usually called inside a signal handler so it mustn't do anything fancy.
2411    ------------------------------------------------------------------------ */
2412
2413 void
2414 interruptStgRts(void)
2415 {
2416     interrupted    = 1;
2417     context_switch = 1;
2418 }
2419
2420 /* -----------------------------------------------------------------------------
2421    Unblock a thread
2422
2423    This is for use when we raise an exception in another thread, which
2424    may be blocked.
2425    This has nothing to do with the UnblockThread event in GranSim. -- HWL
2426    -------------------------------------------------------------------------- */
2427
2428 #if defined(GRAN) || defined(PAR)
2429 /*
2430   NB: only the type of the blocking queue is different in GranSim and GUM
2431       the operations on the queue-elements are the same
2432       long live polymorphism!
2433 */
2434 static void
2435 unblockThread(StgTSO *tso)
2436 {
2437   StgBlockingQueueElement *t, **last;
2438
2439   ACQUIRE_LOCK(&sched_mutex);
2440   switch (tso->why_blocked) {
2441
2442   case NotBlocked:
2443     return;  /* not blocked */
2444
2445   case BlockedOnMVar:
2446     ASSERT(get_itbl(tso->block_info.closure)->type == MVAR);
2447     {
2448       StgBlockingQueueElement *last_tso = END_BQ_QUEUE;
2449       StgMVar *mvar = (StgMVar *)(tso->block_info.closure);
2450
2451       last = (StgBlockingQueueElement **)&mvar->head;
2452       for (t = (StgBlockingQueueElement *)mvar->head;
2453            t != END_BQ_QUEUE;
2454            last = &t->link, last_tso = t, t = t->link) {
2455         if (t == (StgBlockingQueueElement *)tso) {
2456           *last = (StgBlockingQueueElement *)tso->link;
2457           if (mvar->tail == tso) {
2458             mvar->tail = (StgTSO *)last_tso;
2459           }
2460           goto done;
2461         }
2462       }
2463       barf("unblockThread (MVAR): TSO not found");
2464     }
2465
2466   case BlockedOnBlackHole:
2467     ASSERT(get_itbl(tso->block_info.closure)->type == BLACKHOLE_BQ);
2468     {
2469       StgBlockingQueue *bq = (StgBlockingQueue *)(tso->block_info.closure);
2470
2471       last = &bq->blocking_queue;
2472       for (t = bq->blocking_queue;
2473            t != END_BQ_QUEUE;
2474            last = &t->link, t = t->link) {
2475         if (t == (StgBlockingQueueElement *)tso) {
2476           *last = (StgBlockingQueueElement *)tso->link;
2477           goto done;
2478         }
2479       }
2480       barf("unblockThread (BLACKHOLE): TSO not found");
2481     }
2482
2483   case BlockedOnException:
2484     {
2485       StgTSO *target  = tso->block_info.tso;
2486
2487       ASSERT(get_itbl(target)->type == TSO);
2488       ASSERT(target->blocked_exceptions != NULL);
2489
2490       last = (StgBlockingQueueElement **)&target->blocked_exceptions;
2491       for (t = (StgBlockingQueueElement *)target->blocked_exceptions;
2492            t != END_BQ_QUEUE;
2493            last = &t->link, t = t->link) {
2494         ASSERT(get_itbl(t)->type == TSO);
2495         if (t == (StgBlockingQueueElement *)tso) {
2496           *last = (StgBlockingQueueElement *)tso->link;
2497           goto done;
2498         }
2499       }
2500       barf("unblockThread (Exception): TSO not found");
2501     }
2502
2503   case BlockedOnDelay:
2504   case BlockedOnRead:
2505   case BlockedOnWrite:
2506     {
2507       StgBlockingQueueElement *prev = NULL;
2508       for (t = (StgBlockingQueueElement *)blocked_queue_hd; t != END_BQ_QUEUE;
2509            prev = t, t = t->link) {
2510         if (t == (StgBlockingQueueElement *)tso) {
2511           if (prev == NULL) {
2512             blocked_queue_hd = (StgTSO *)t->link;
2513             if ((StgBlockingQueueElement *)blocked_queue_tl == t) {
2514               blocked_queue_tl = END_TSO_QUEUE;
2515             }
2516           } else {
2517             prev->link = t->link;
2518             if ((StgBlockingQueueElement *)blocked_queue_tl == t) {
2519               blocked_queue_tl = (StgTSO *)prev;
2520             }
2521           }
2522           goto done;
2523         }
2524       }
2525       barf("unblockThread (I/O): TSO not found");
2526     }
2527
2528   default:
2529     barf("unblockThread");
2530   }
2531
2532  done:
2533   tso->link = END_TSO_QUEUE;
2534   tso->why_blocked = NotBlocked;
2535   tso->block_info.closure = NULL;
2536   PUSH_ON_RUN_QUEUE(tso);
2537   RELEASE_LOCK(&sched_mutex);
2538 }
2539 #else
2540 static void
2541 unblockThread(StgTSO *tso)
2542 {
2543   StgTSO *t, **last;
2544
2545   ACQUIRE_LOCK(&sched_mutex);
2546   switch (tso->why_blocked) {
2547
2548   case NotBlocked:
2549     return;  /* not blocked */
2550
2551   case BlockedOnMVar:
2552     ASSERT(get_itbl(tso->block_info.closure)->type == MVAR);
2553     {
2554       StgTSO *last_tso = END_TSO_QUEUE;
2555       StgMVar *mvar = (StgMVar *)(tso->block_info.closure);
2556
2557       last = &mvar->head;
2558       for (t = mvar->head; t != END_TSO_QUEUE;
2559            last = &t->link, last_tso = t, t = t->link) {
2560         if (t == tso) {
2561           *last = tso->link;
2562           if (mvar->tail == tso) {
2563             mvar->tail = last_tso;
2564           }
2565           goto done;
2566         }
2567       }
2568       barf("unblockThread (MVAR): TSO not found");
2569     }
2570
2571   case BlockedOnBlackHole:
2572     ASSERT(get_itbl(tso->block_info.closure)->type == BLACKHOLE_BQ);
2573     {
2574       StgBlockingQueue *bq = (StgBlockingQueue *)(tso->block_info.closure);
2575
2576       last = &bq->blocking_queue;
2577       for (t = bq->blocking_queue; t != END_TSO_QUEUE;
2578            last = &t->link, t = t->link) {
2579         if (t == tso) {
2580           *last = tso->link;
2581           goto done;
2582         }
2583       }
2584       barf("unblockThread (BLACKHOLE): TSO not found");
2585     }
2586
2587   case BlockedOnException:
2588     {
2589       StgTSO *target  = tso->block_info.tso;
2590
2591       ASSERT(get_itbl(target)->type == TSO);
2592       ASSERT(target->blocked_exceptions != NULL);
2593
2594       last = &target->blocked_exceptions;
2595       for (t = target->blocked_exceptions; t != END_TSO_QUEUE;
2596            last = &t->link, t = t->link) {
2597         ASSERT(get_itbl(t)->type == TSO);
2598         if (t == tso) {
2599           *last = tso->link;
2600           goto done;
2601         }
2602       }
2603       barf("unblockThread (Exception): TSO not found");
2604     }
2605
2606   case BlockedOnDelay:
2607   case BlockedOnRead:
2608   case BlockedOnWrite:
2609     {
2610       StgTSO *prev = NULL;
2611       for (t = blocked_queue_hd; t != END_TSO_QUEUE;
2612            prev = t, t = t->link) {
2613         if (t == tso) {
2614           if (prev == NULL) {
2615             blocked_queue_hd = t->link;
2616             if (blocked_queue_tl == t) {
2617               blocked_queue_tl = END_TSO_QUEUE;
2618             }
2619           } else {
2620             prev->link = t->link;
2621             if (blocked_queue_tl == t) {
2622               blocked_queue_tl = prev;
2623             }
2624           }
2625           goto done;
2626         }
2627       }
2628       barf("unblockThread (I/O): TSO not found");
2629     }
2630
2631   default:
2632     barf("unblockThread");
2633   }
2634
2635  done:
2636   tso->link = END_TSO_QUEUE;
2637   tso->why_blocked = NotBlocked;
2638   tso->block_info.closure = NULL;
2639   PUSH_ON_RUN_QUEUE(tso);
2640   RELEASE_LOCK(&sched_mutex);
2641 }
2642 #endif
2643
2644 /* -----------------------------------------------------------------------------
2645  * raiseAsync()
2646  *
2647  * The following function implements the magic for raising an
2648  * asynchronous exception in an existing thread.
2649  *
2650  * We first remove the thread from any queue on which it might be
2651  * blocked.  The possible blockages are MVARs and BLACKHOLE_BQs.
2652  *
2653  * We strip the stack down to the innermost CATCH_FRAME, building
2654  * thunks in the heap for all the active computations, so they can
2655  * be restarted if necessary.  When we reach a CATCH_FRAME, we build
2656  * an application of the handler to the exception, and push it on
2657  * the top of the stack.
2658  *
2659  * How exactly do we save all the active computations?  We create an
2660  * AP_UPD for every UpdateFrame on the stack.  Entering one of these
2661  * AP_UPDs pushes everything from the corresponding update frame
2662  * upwards onto the stack.  (Actually, it pushes everything up to the
2663  * next update frame plus a pointer to the next AP_UPD object.
2664  * Entering the next AP_UPD object pushes more onto the stack until we
2665  * reach the last AP_UPD object - at which point the stack should look
2666  * exactly as it did when we killed the TSO and we can continue
2667  * execution by entering the closure on top of the stack.
2668  *
2669  * We can also kill a thread entirely - this happens if either (a) the
2670  * exception passed to raiseAsync is NULL, or (b) there's no
2671  * CATCH_FRAME on the stack.  In either case, we strip the entire
2672  * stack and replace the thread with a zombie.
2673  *
2674  * -------------------------------------------------------------------------- */
2675
2676 void
2677 deleteThread(StgTSO *tso)
2678 {
2679   raiseAsync(tso,NULL);
2680 }
2681
2682 void
2683 raiseAsync(StgTSO *tso, StgClosure *exception)
2684 {
2685   StgUpdateFrame* su = tso->su;
2686   StgPtr          sp = tso->sp;
2687
2688   /* Thread already dead? */
2689   if (tso->what_next == ThreadComplete || tso->what_next == ThreadKilled) {
2690     return;
2691   }
2692
2693   IF_DEBUG(scheduler, sched_belch("raising exception in thread %ld.", tso->id));
2694
2695   /* Remove it from any blocking queues */
2696   unblockThread(tso);
2697
2698   /* The stack freezing code assumes there's a closure pointer on
2699    * the top of the stack.  This isn't always the case with compiled
2700    * code, so we have to push a dummy closure on the top which just
2701    * returns to the next return address on the stack.
2702    */
2703   if ( LOOKS_LIKE_GHC_INFO((void*)*sp) ) {
2704     *(--sp) = (W_)&dummy_ret_closure;
2705   }
2706
2707   while (1) {
2708     int words = ((P_)su - (P_)sp) - 1;
2709     nat i;
2710     StgAP_UPD * ap;
2711
2712     /* If we find a CATCH_FRAME, and we've got an exception to raise,
2713      * then build PAP(handler,exception,realworld#), and leave it on
2714      * top of the stack ready to enter.
2715      */
2716     if (get_itbl(su)->type == CATCH_FRAME && exception != NULL) {
2717       StgCatchFrame *cf = (StgCatchFrame *)su;
2718       /* we've got an exception to raise, so let's pass it to the
2719        * handler in this frame.
2720        */
2721       ap = (StgAP_UPD *)allocate(sizeofW(StgPAP) + 2);
2722       TICK_ALLOC_UPD_PAP(3,0);
2723       SET_HDR(ap,&PAP_info,cf->header.prof.ccs);
2724
2725       ap->n_args = 2;
2726       ap->fun = cf->handler;    /* :: Exception -> IO a */
2727       ap->payload[0] = exception;
2728       ap->payload[1] = ARG_TAG(0); /* realworld token */
2729
2730       /* throw away the stack from Sp up to and including the
2731        * CATCH_FRAME.
2732        */
2733       sp = (P_)su + sizeofW(StgCatchFrame) - 1;
2734       tso->su = cf->link;
2735
2736       /* Restore the blocked/unblocked state for asynchronous exceptions
2737        * at the CATCH_FRAME.
2738        *
2739        * If exceptions were unblocked at the catch, arrange that they
2740        * are unblocked again after executing the handler by pushing an
2741        * unblockAsyncExceptions_ret stack frame.
2742        */
2743       if (!cf->exceptions_blocked) {
2744         *(sp--) = (W_)&unblockAsyncExceptionszh_ret_info;
2745       }
2746
2747       /* Ensure that async exceptions are blocked when running the handler.
2748        */
2749       if (tso->blocked_exceptions == NULL) {
2750         tso->blocked_exceptions = END_TSO_QUEUE;
2751       }
2752
2753       /* Put the newly-built PAP on top of the stack, ready to execute
2754        * when the thread restarts.
2755        */
2756       sp[0] = (W_)ap;
2757       tso->sp = sp;
2758       tso->what_next = ThreadEnterGHC;
2759       IF_DEBUG(sanity, checkTSO(tso));
2760       return;
2761     }
2762
2763     /* First build an AP_UPD consisting of the stack chunk above the
2764      * current update frame, with the top word on the stack as the
2765      * fun field.
2766      */
2767     ap = (StgAP_UPD *)allocate(AP_sizeW(words));
2768
2769     ASSERT(words >= 0);
2770
2771     ap->n_args = words;
2772     ap->fun    = (StgClosure *)sp[0];
2773     sp++;
2774     for(i=0; i < (nat)words; ++i) {
2775       ap->payload[i] = (StgClosure *)*sp++;
2776     }
2777
2778     switch (get_itbl(su)->type) {
2779
2780     case UPDATE_FRAME:
2781       {
2782         SET_HDR(ap,&AP_UPD_info,su->header.prof.ccs /* ToDo */);
2783         TICK_ALLOC_UP_THK(words+1,0);
2784
2785         IF_DEBUG(scheduler,
2786                  fprintf(stderr,  "scheduler: Updating ");
2787                  printPtr((P_)su->updatee);
2788                  fprintf(stderr,  " with ");
2789                  printObj((StgClosure *)ap);
2790                  );
2791
2792         /* Replace the updatee with an indirection - happily
2793          * this will also wake up any threads currently
2794          * waiting on the result.
2795          */
2796         UPD_IND_NOLOCK(su->updatee,ap);  /* revert the black hole */
2797         su = su->link;
2798         sp += sizeofW(StgUpdateFrame) -1;
2799         sp[0] = (W_)ap; /* push onto stack */
2800         break;
2801       }
2802
2803     case CATCH_FRAME:
2804       {
2805         StgCatchFrame *cf = (StgCatchFrame *)su;
2806         StgClosure* o;
2807
2808         /* We want a PAP, not an AP_UPD.  Fortunately, the
2809          * layout's the same.
2810          */
2811         SET_HDR(ap,&PAP_info,su->header.prof.ccs /* ToDo */);
2812         TICK_ALLOC_UPD_PAP(words+1,0);
2813
2814         /* now build o = FUN(catch,ap,handler) */
2815         o = (StgClosure *)allocate(sizeofW(StgClosure)+2);
2816         TICK_ALLOC_FUN(2,0);
2817         SET_HDR(o,&catch_info,su->header.prof.ccs /* ToDo */);
2818         o->payload[0] = (StgClosure *)ap;
2819         o->payload[1] = cf->handler;
2820
2821         IF_DEBUG(scheduler,
2822                  fprintf(stderr,  "scheduler: Built ");
2823                  printObj((StgClosure *)o);
2824                  );
2825
2826         /* pop the old handler and put o on the stack */
2827         su = cf->link;
2828         sp += sizeofW(StgCatchFrame) - 1;
2829         sp[0] = (W_)o;
2830         break;
2831       }
2832
2833     case SEQ_FRAME:
2834       {
2835         StgSeqFrame *sf = (StgSeqFrame *)su;
2836         StgClosure* o;
2837
2838         SET_HDR(ap,&PAP_info,su->header.prof.ccs /* ToDo */);
2839         TICK_ALLOC_UPD_PAP(words+1,0);
2840
2841         /* now build o = FUN(seq,ap) */
2842         o = (StgClosure *)allocate(sizeofW(StgClosure)+1);
2843         TICK_ALLOC_SE_THK(1,0);
2844         SET_HDR(o,&seq_info,su->header.prof.ccs /* ToDo */);
2845         o->payload[0] = (StgClosure *)ap;
2846
2847         IF_DEBUG(scheduler,
2848                  fprintf(stderr,  "scheduler: Built ");
2849                  printObj((StgClosure *)o);
2850                  );
2851
2852         /* pop the old handler and put o on the stack */
2853         su = sf->link;
2854         sp += sizeofW(StgSeqFrame) - 1;
2855         sp[0] = (W_)o;
2856         break;
2857       }
2858
2859     case STOP_FRAME:
2860       /* We've stripped the entire stack, the thread is now dead. */
2861       sp += sizeofW(StgStopFrame) - 1;
2862       sp[0] = (W_)exception;    /* save the exception */
2863       tso->what_next = ThreadKilled;
2864       tso->su = (StgUpdateFrame *)(sp+1);
2865       tso->sp = sp;
2866       return;
2867
2868     default:
2869       barf("raiseAsync");
2870     }
2871   }
2872   barf("raiseAsync");
2873 }
2874
2875 /* -----------------------------------------------------------------------------
2876    resurrectThreads is called after garbage collection on the list of
2877    threads found to be garbage.  Each of these threads will be woken
2878    up and sent a signal: BlockedOnDeadMVar if the thread was blocked
2879    on an MVar, or NonTermination if the thread was blocked on a Black
2880    Hole.
2881    -------------------------------------------------------------------------- */
2882
2883 void
2884 resurrectThreads( StgTSO *threads )
2885 {
2886   StgTSO *tso, *next;
2887
2888   for (tso = threads; tso != END_TSO_QUEUE; tso = next) {
2889     next = tso->global_link;
2890     tso->global_link = all_threads;
2891     all_threads = tso;
2892     IF_DEBUG(scheduler, sched_belch("resurrecting thread %d", tso->id));
2893
2894     switch (tso->why_blocked) {
2895     case BlockedOnMVar:
2896     case BlockedOnException:
2897       raiseAsync(tso,(StgClosure *)BlockedOnDeadMVar_closure);
2898       break;
2899     case BlockedOnBlackHole:
2900       raiseAsync(tso,(StgClosure *)NonTermination_closure);
2901       break;
2902     case NotBlocked:
2903       /* This might happen if the thread was blocked on a black hole
2904        * belonging to a thread that we've just woken up (raiseAsync
2905        * can wake up threads, remember...).
2906        */
2907       continue;
2908     default:
2909       barf("resurrectThreads: thread blocked in a strange way");
2910     }
2911   }
2912 }
2913
2914 /* -----------------------------------------------------------------------------
2915  * Blackhole detection: if we reach a deadlock, test whether any
2916  * threads are blocked on themselves.  Any threads which are found to
2917  * be self-blocked get sent a NonTermination exception.
2918  *
2919  * This is only done in a deadlock situation in order to avoid
2920  * performance overhead in the normal case.
2921  * -------------------------------------------------------------------------- */
2922
2923 static void
2924 detectBlackHoles( void )
2925 {
2926     StgTSO *t = all_threads;
2927     StgUpdateFrame *frame;
2928     StgClosure *blocked_on;
2929
2930     for (t = all_threads; t != END_TSO_QUEUE; t = t->global_link) {
2931
2932         if (t->why_blocked != BlockedOnBlackHole) {
2933             continue;
2934         }
2935
2936         blocked_on = t->block_info.closure;
2937
2938         for (frame = t->su; ; frame = frame->link) {
2939             switch (get_itbl(frame)->type) {
2940
2941             case UPDATE_FRAME:
2942                 if (frame->updatee == blocked_on) {
2943                     /* We are blocking on one of our own computations, so
2944                      * send this thread the NonTermination exception.
2945                      */
2946                     IF_DEBUG(scheduler,
2947                              sched_belch("thread %d is blocked on itself", t->id));
2948                     raiseAsync(t, (StgClosure *)NonTermination_closure);
2949                     goto done;
2950                 }
2951                 else {
2952                     continue;
2953                 }
2954
2955             case CATCH_FRAME:
2956             case SEQ_FRAME:
2957                 continue;
2958
2959             case STOP_FRAME:
2960                 break;
2961             }
2962             break;
2963         }
2964
2965     done:
2966     }
2967 }
2968
2969 //@node Debugging Routines, Index, Exception Handling Routines, Main scheduling code
2970 //@subsection Debugging Routines
2971
2972 /* -----------------------------------------------------------------------------
2973    Debugging: why is a thread blocked
2974    -------------------------------------------------------------------------- */
2975
2976 #ifdef DEBUG
2977
2978 void
2979 printThreadBlockage(StgTSO *tso)
2980 {
2981   switch (tso->why_blocked) {
2982   case BlockedOnRead:
2983     fprintf(stderr,"blocked on read from fd %d", tso->block_info.fd);
2984     break;
2985   case BlockedOnWrite:
2986     fprintf(stderr,"blocked on write to fd %d", tso->block_info.fd);
2987     break;
2988   case BlockedOnDelay:
2989 #if defined(HAVE_SETITIMER) || defined(mingw32_TARGET_OS)
2990     fprintf(stderr,"blocked on delay of %d ms", tso->block_info.delay);
2991 #else
2992     fprintf(stderr,"blocked on delay of %d ms",
2993             tso->block_info.target - getourtimeofday());
2994 #endif
2995     break;
2996   case BlockedOnMVar:
2997     fprintf(stderr,"blocked on an MVar");
2998     break;
2999   case BlockedOnException:
3000     fprintf(stderr,"blocked on delivering an exception to thread %d",
3001             tso->block_info.tso->id);
3002     break;
3003   case BlockedOnBlackHole:
3004     fprintf(stderr,"blocked on a black hole");
3005     break;
3006   case NotBlocked:
3007     fprintf(stderr,"not blocked");
3008     break;
3009 #if defined(PAR)
3010   case BlockedOnGA:
3011     fprintf(stderr,"blocked on global address; local FM_BQ is %p (%s)",
3012             tso->block_info.closure, info_type(tso->block_info.closure));
3013     break;
3014   case BlockedOnGA_NoSend:
3015     fprintf(stderr,"blocked on global address (no send); local FM_BQ is %p (%s)",
3016             tso->block_info.closure, info_type(tso->block_info.closure));
3017     break;
3018 #endif
3019   default:
3020     barf("printThreadBlockage: strange tso->why_blocked: %d for TSO %d (%d)",
3021          tso->why_blocked, tso->id, tso);
3022   }
3023 }
3024
3025 void
3026 printThreadStatus(StgTSO *tso)
3027 {
3028   switch (tso->what_next) {
3029   case ThreadKilled:
3030     fprintf(stderr,"has been killed");
3031     break;
3032   case ThreadComplete:
3033     fprintf(stderr,"has completed");
3034     break;
3035   default:
3036     printThreadBlockage(tso);
3037   }
3038 }
3039
3040 void
3041 printAllThreads(void)
3042 {
3043   StgTSO *t;
3044
3045   sched_belch("all threads:");
3046   for (t = all_threads; t != END_TSO_QUEUE; t = t->global_link) {
3047     fprintf(stderr, "\tthread %d is ", t->id);
3048     printThreadStatus(t);
3049     fprintf(stderr,"\n");
3050   }
3051 }
3052
3053 /*
3054    Print a whole blocking queue attached to node (debugging only).
3055 */
3056 //@cindex print_bq
3057 # if defined(PAR)
3058 void
3059 print_bq (StgClosure *node)
3060 {
3061   StgBlockingQueueElement *bqe;
3062   StgTSO *tso;
3063   rtsBool end;
3064
3065   fprintf(stderr,"## BQ of closure %p (%s): ",
3066           node, info_type(node));
3067
3068   /* should cover all closures that may have a blocking queue */
3069   ASSERT(get_itbl(node)->type == BLACKHOLE_BQ ||
3070          get_itbl(node)->type == FETCH_ME_BQ ||
3071          get_itbl(node)->type == RBH);
3072
3073   ASSERT(node!=(StgClosure*)NULL);         // sanity check
3074   /*
3075      NB: In a parallel setup a BQ of an RBH must end with an RBH_Save closure;
3076   */
3077   for (bqe = ((StgBlockingQueue*)node)->blocking_queue, end = (bqe==END_BQ_QUEUE);
3078        !end; // iterate until bqe points to a CONSTR
3079        end = (get_itbl(bqe)->type == CONSTR) || (bqe->link==END_BQ_QUEUE), bqe = end ? END_BQ_QUEUE : bqe->link) {
3080     ASSERT(bqe != END_BQ_QUEUE);             // sanity check
3081     ASSERT(bqe != (StgTSO*)NULL);            // sanity check
3082     /* types of closures that may appear in a blocking queue */
3083     ASSERT(get_itbl(bqe)->type == TSO ||
3084            get_itbl(bqe)->type == BLOCKED_FETCH ||
3085            get_itbl(bqe)->type == CONSTR);
3086     /* only BQs of an RBH end with an RBH_Save closure */
3087     ASSERT(get_itbl(bqe)->type != CONSTR || get_itbl(node)->type == RBH);
3088
3089     switch (get_itbl(bqe)->type) {
3090     case TSO:
3091       fprintf(stderr," TSO %d (%x),",
3092               ((StgTSO *)bqe)->id, ((StgTSO *)bqe));
3093       break;
3094     case BLOCKED_FETCH:
3095       fprintf(stderr," BF (node=%p, ga=((%x, %d, %x)),",
3096               ((StgBlockedFetch *)bqe)->node,
3097               ((StgBlockedFetch *)bqe)->ga.payload.gc.gtid,
3098               ((StgBlockedFetch *)bqe)->ga.payload.gc.slot,
3099               ((StgBlockedFetch *)bqe)->ga.weight);
3100       break;
3101     case CONSTR:
3102       fprintf(stderr," %s (IP %p),",
3103               (get_itbl(bqe) == &RBH_Save_0_info ? "RBH_Save_0" :
3104                get_itbl(bqe) == &RBH_Save_1_info ? "RBH_Save_1" :
3105                get_itbl(bqe) == &RBH_Save_2_info ? "RBH_Save_2" :
3106                "RBH_Save_?"), get_itbl(bqe));
3107       break;
3108     default:
3109       barf("Unexpected closure type %s in blocking queue of %p (%s)",
3110            info_type(bqe), node, info_type(node));
3111       break;
3112     }
3113   } /* for */
3114   fputc('\n', stderr);
3115 }
3116 # elif defined(GRAN)
3117 void
3118 print_bq (StgClosure *node)
3119 {
3120   StgBlockingQueueElement *bqe;
3121   PEs node_loc, tso_loc;
3122   rtsBool end;
3123
3124   /* should cover all closures that may have a blocking queue */
3125   ASSERT(get_itbl(node)->type == BLACKHOLE_BQ ||
3126          get_itbl(node)->type == FETCH_ME_BQ ||
3127          get_itbl(node)->type == RBH);
3128
3129   ASSERT(node!=(StgClosure*)NULL);         // sanity check
3130   node_loc = where_is(node);
3131
3132   fprintf(stderr,"## BQ of closure %p (%s) on [PE %d]: ",
3133           node, info_type(node), node_loc);
3134
3135   /*
3136      NB: In a parallel setup a BQ of an RBH must end with an RBH_Save closure;
3137   */
3138   for (bqe = ((StgBlockingQueue*)node)->blocking_queue, end = (bqe==END_BQ_QUEUE);
3139        !end; // iterate until bqe points to a CONSTR
3140        end = (get_itbl(bqe)->type == CONSTR) || (bqe->link==END_BQ_QUEUE), bqe = end ? END_BQ_QUEUE : bqe->link) {
3141     ASSERT(bqe != END_BQ_QUEUE);             // sanity check
3142     ASSERT(bqe != (StgBlockingQueueElement *)NULL);  // sanity check
3143     /* types of closures that may appear in a blocking queue */
3144     ASSERT(get_itbl(bqe)->type == TSO ||
3145            get_itbl(bqe)->type == CONSTR);
3146     /* only BQs of an RBH end with an RBH_Save closure */
3147     ASSERT(get_itbl(bqe)->type != CONSTR || get_itbl(node)->type == RBH);
3148
3149     tso_loc = where_is((StgClosure *)bqe);
3150     switch (get_itbl(bqe)->type) {
3151     case TSO:
3152       fprintf(stderr," TSO %d (%p) on [PE %d],",
3153               ((StgTSO *)bqe)->id, (StgTSO *)bqe, tso_loc);
3154       break;
3155     case CONSTR:
3156       fprintf(stderr," %s (IP %p),",
3157               (get_itbl(bqe) == &RBH_Save_0_info ? "RBH_Save_0" :
3158                get_itbl(bqe) == &RBH_Save_1_info ? "RBH_Save_1" :
3159                get_itbl(bqe) == &RBH_Save_2_info ? "RBH_Save_2" :
3160                "RBH_Save_?"), get_itbl(bqe));
3161       break;
3162     default:
3163       barf("Unexpected closure type %s in blocking queue of %p (%s)",
3164            info_type((StgClosure *)bqe), node, info_type(node));
3165       break;
3166     }
3167   } /* for */
3168   fputc('\n', stderr);
3169 }
3170 #else
3171 /*
3172    Nice and easy: only TSOs on the blocking queue
3173 */
3174 void
3175 print_bq (StgClosure *node)
3176 {
3177   StgTSO *tso;
3178
3179   ASSERT(node!=(StgClosure*)NULL);         // sanity check
3180   for (tso = ((StgBlockingQueue*)node)->blocking_queue;
3181        tso != END_TSO_QUEUE;
3182        tso=tso->link) {
3183     ASSERT(tso!=NULL && tso!=END_TSO_QUEUE);   // sanity check
3184     ASSERT(get_itbl(tso)->type == TSO);  // guess what, sanity check
3185     fprintf(stderr," TSO %d (%p),", tso->id, tso);
3186   }
3187   fputc('\n', stderr);
3188 }
3189 # endif
3190
3191 #if defined(PAR)
3192 static nat
3193 run_queue_len(void)
3194 {
3195   nat i;
3196   StgTSO *tso;
3197
3198   for (i=0, tso=run_queue_hd;
3199        tso != END_TSO_QUEUE;
3200        i++, tso=tso->link)
3201     /* nothing */
3202
3203   return i;
3204 }
3205 #endif
3206
3207 static void
3208 sched_belch(char *s, ...)
3209 {
3210   va_list ap;
3211   va_start(ap,s);
3212 #ifdef SMP
3213   fprintf(stderr, "scheduler (task %ld): ", pthread_self());
3214 #else
3215   fprintf(stderr, "scheduler: ");
3216 #endif
3217   vfprintf(stderr, s, ap);
3218   fprintf(stderr, "\n");
3219 }
3220
3221 #endif /* DEBUG */
3222
3223
3224 //@node Index,  , Debugging Routines, Main scheduling code
3225 //@subsection Index
3226
3227 //@index
3228 //* MainRegTable::  @cindex\s-+MainRegTable
3229 //* StgMainThread::  @cindex\s-+StgMainThread
3230 //* awaken_blocked_queue::  @cindex\s-+awaken_blocked_queue
3231 //* blocked_queue_hd::  @cindex\s-+blocked_queue_hd
3232 //* blocked_queue_tl::  @cindex\s-+blocked_queue_tl
3233 //* context_switch::  @cindex\s-+context_switch
3234 //* createThread::  @cindex\s-+createThread
3235 //* free_capabilities::  @cindex\s-+free_capabilities
3236 //* gc_pending_cond::  @cindex\s-+gc_pending_cond
3237 //* initScheduler::  @cindex\s-+initScheduler
3238 //* interrupted::  @cindex\s-+interrupted
3239 //* n_free_capabilities::  @cindex\s-+n_free_capabilities
3240 //* next_thread_id::  @cindex\s-+next_thread_id
3241 //* print_bq::  @cindex\s-+print_bq
3242 //* run_queue_hd::  @cindex\s-+run_queue_hd
3243 //* run_queue_tl::  @cindex\s-+run_queue_tl
3244 //* sched_mutex::  @cindex\s-+sched_mutex
3245 //* schedule::  @cindex\s-+schedule
3246 //* take_off_run_queue::  @cindex\s-+take_off_run_queue
3247 //* task_ids::  @cindex\s-+task_ids
3248 //* term_mutex::  @cindex\s-+term_mutex
3249 //* thread_ready_cond::  @cindex\s-+thread_ready_cond
3250 //@end index