rts/RaiseAsync.c

   1 /* ---------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2006
   4  *
   5  * Asynchronous exceptions
   6  *
   7  * --------------------------------------------------------------------------*/
   8
   9 #include "PosixSource.h"
  10 #include "Rts.h"
  11 #include "Threads.h"
  12 #include "Trace.h"
  13 #include "RaiseAsync.h"
  14 #include "SMP.h"
  15 #include "Schedule.h"
  16 #include "LdvProfile.h"
  17 #include "Updates.h"
  18 #include "STM.h"
  19 #include "Sanity.h"
  20 #include "Profiling.h"
  21 #if defined(mingw32_HOST_OS)
  22 #include "win32/IOManager.h"
  23 #endif
  24
  25 static void raiseAsync (Capability *cap,
  26                         StgTSO *tso,
  27                         StgClosure *exception,
  28                         rtsBool stop_at_atomically,
  29                         StgPtr stop_here);
  30
  31 static void removeFromQueues(Capability *cap, StgTSO *tso);
  32
  33 static void blockedThrowTo (Capability *cap, StgTSO *source, StgTSO *target);
  34
  35 static void performBlockedException (Capability *cap,
  36                                      StgTSO *source, StgTSO *target);
  37
  38 /* -----------------------------------------------------------------------------
  39    throwToSingleThreaded
  40
  41    This version of throwTo is safe to use if and only if one of the
  42    following holds:
  43
  44      - !THREADED_RTS
  45
  46      - all the other threads in the system are stopped (eg. during GC).
  47
  48      - we surely own the target TSO (eg. we just took it from the
  49        run queue of the current capability, or we are running it).
  50
  51    It doesn't cater for blocking the source thread until the exception
  52    has been raised.
  53    -------------------------------------------------------------------------- */
  54
  55 void
  56 throwToSingleThreaded(Capability *cap, StgTSO *tso, StgClosure *exception)
  57 {
  58     throwToSingleThreaded_(cap, tso, exception, rtsFalse, NULL);
  59 }
  60
  61 void
  62 throwToSingleThreaded_(Capability *cap, StgTSO *tso, StgClosure *exception,
  63                        rtsBool stop_at_atomically, StgPtr stop_here)
  64 {
  65     // Thread already dead?
  66     if (tso->what_next == ThreadComplete || tso->what_next == ThreadKilled) {
  67         return;
  68     }
  69
  70     // Remove it from any blocking queues
  71     removeFromQueues(cap,tso);
  72
  73     raiseAsync(cap, tso, exception, stop_at_atomically, stop_here);
  74 }
  75
  76 void
  77 suspendComputation(Capability *cap, StgTSO *tso, StgPtr stop_here)
  78 {
  79     // Thread already dead?
  80     if (tso->what_next == ThreadComplete || tso->what_next == ThreadKilled) {
  81         return;
  82     }
  83
  84     // Remove it from any blocking queues
  85     removeFromQueues(cap,tso);
  86
  87     raiseAsync(cap, tso, NULL, rtsFalse, stop_here);
  88 }
  89
  90 /* -----------------------------------------------------------------------------
  91    throwTo
  92
  93    This function may be used to throw an exception from one thread to
  94    another, during the course of normal execution.  This is a tricky
  95    task: the target thread might be running on another CPU, or it
  96    may be blocked and could be woken up at any point by another CPU.
  97    We have some delicate synchronisation to do.
  98
  99    There is a completely safe fallback scheme: it is always possible
 100    to just block the source TSO on the target TSO's blocked_exceptions
 101    queue.  This queue is locked using lockTSO()/unlockTSO().  It is
 102    checked at regular intervals: before and after running a thread
 103    (schedule() and threadPaused() respectively), and just before GC
 104    (scheduleDoGC()).  Activating a thread on this queue should be done
 105    using maybePerformBlockedException(): this is done in the context
 106    of the target thread, so the exception can be raised eagerly.
 107
 108    This fallback scheme works even if the target thread is complete or
 109    killed: scheduleDoGC() will discover the blocked thread before the
 110    target is GC'd.
 111
 112    Blocking the source thread on the target thread's blocked_exception
 113    queue is also employed when the target thread is currently blocking
 114    exceptions (ie. inside Control.Exception.block).
 115
 116    We could use the safe fallback scheme exclusively, but that
 117    wouldn't be ideal: most calls to throwTo would block immediately,
 118    possibly until the next GC, which might require the deadlock
 119    detection mechanism to kick in.  So we try to provide promptness
 120    wherever possible.
 121
 122    We can promptly deliver the exception if the target thread is:
 123
 124      - runnable, on the same Capability as the source thread (because
 125        we own the run queue and therefore the target thread).
 126
 127      - blocked, and we can obtain exclusive access to it.  Obtaining
 128        exclusive access to the thread depends on how it is blocked.
 129
 130    We must also be careful to not trip over threadStackOverflow(),
 131    which might be moving the TSO to enlarge its stack.
 132    lockTSO()/unlockTSO() are used here too.
 133
 134    Returns:
 135
 136    THROWTO_SUCCESS    exception was raised, ok to continue
 137
 138    THROWTO_BLOCKED    exception was not raised; block the source
 139                       thread then call throwToReleaseTarget() when
 140                       the source thread is properly tidied away.
 141
 142    -------------------------------------------------------------------------- */
 143
 144 nat
 145 throwTo (Capability *cap,       // the Capability we hold
 146          StgTSO *source,        // the TSO sending the exception
 147          StgTSO *target,        // the TSO receiving the exception
 148          StgClosure *exception, // the exception closure
 149          /*[out]*/ void **out USED_IF_THREADS)
 150 {
 151     StgWord status;
 152
 153     // follow ThreadRelocated links in the target first
 154     while (target->what_next == ThreadRelocated) {
 155         target = target->_link;
 156         // No, it might be a WHITEHOLE:
 157         // ASSERT(get_itbl(target)->type == TSO);
 158     }
 159
 160     debugTrace(DEBUG_sched, "throwTo: from thread %lu to thread %lu",
 161                (unsigned long)source->id, (unsigned long)target->id);
 162
 163 #ifdef DEBUG
 164     if (traceClass(DEBUG_sched)) {
 165         debugTraceBegin("throwTo: target");
 166         printThreadStatus(target);
 167         debugTraceEnd();
 168     }
 169 #endif
 170
 171     goto check_target;
 172 retry:
 173     debugTrace(DEBUG_sched, "throwTo: retrying...");
 174
 175 check_target:
 176     // Thread already dead?
 177     if (target->what_next == ThreadComplete
 178         || target->what_next == ThreadKilled) {
 179         return THROWTO_SUCCESS;
 180     }
 181
 182     status = target->why_blocked;
 183
 184     switch (status) {
 185     case NotBlocked:
 186         /* if status==NotBlocked, and target->cap == cap, then
 187            we own this TSO and can raise the exception.
 188
 189            How do we establish this condition?  Very carefully.
 190
 191            Let
 192                P = (status == NotBlocked)
 193                Q = (tso->cap == cap)
 194
 195            Now, if P & Q are true, then the TSO is locked and owned by
 196            this capability.  No other OS thread can steal it.
 197
 198            If P==0 and Q==1: the TSO is blocked, but attached to this
 199            capabilty, and it can be stolen by another capability.
 200
 201            If P==1 and Q==0: the TSO is runnable on another
 202            capability.  At any time, the TSO may change from runnable
 203            to blocked and vice versa, while it remains owned by
 204            another capability.
 205
 206            Suppose we test like this:
 207
 208               p = P
 209               q = Q
 210               if (p && q) ...
 211
 212             this is defeated by another capability stealing a blocked
 213             TSO from us to wake it up (Schedule.c:unblockOne()).  The
 214             other thread is doing
 215
 216               Q = 0
 217               P = 1
 218
 219             assuming arbitrary reordering, we could see this
 220             interleaving:
 221
 222               start: P==0 && Q==1
 223               P = 1
 224               p = P
 225               q = Q
 226               Q = 0
 227               if (p && q) ...
 228
 229             so we need a memory barrier:
 230
 231               p = P
 232               mb()
 233               q = Q
 234               if (p && q) ...
 235
 236             this avoids the problematic case.  There are other cases
 237             to consider, but this is the tricky one.
 238
 239             Note that we must be sure that unblockOne() does the
 240             writes in the correct order: Q before P.  The memory
 241             barrier ensures that if we have seen the write to P, we
 242             have also seen the write to Q.
 243         */
 244     {
 245         Capability *target_cap;
 246
 247         write_barrier();
 248         target_cap = target->cap;
 249         if (target_cap == cap && (target->flags & TSO_BLOCKEX) == 0) {
 250             // It's on our run queue and not blocking exceptions
 251             raiseAsync(cap, target, exception, rtsFalse, NULL);
 252             return THROWTO_SUCCESS;
 253         } else {
 254             // Otherwise, just block on the blocked_exceptions queue
 255             // of the target thread.  The queue will get looked at
 256             // soon enough: it is checked before and after running a
 257             // thread, and during GC.
 258             lockTSO(target);
 259
 260             // Avoid race with threadStackOverflow, which may have
 261             // just moved this TSO.
 262             if (target->what_next == ThreadRelocated) {
 263                 unlockTSO(target);
 264                 target = target->_link;
 265                 goto retry;
 266             }
 267             blockedThrowTo(cap,source,target);
 268             *out = target;
 269             return THROWTO_BLOCKED;
 270         }
 271     }
 272
 273     case BlockedOnMVar:
 274     {
 275         /*
 276           To establish ownership of this TSO, we need to acquire a
 277           lock on the MVar that it is blocked on.
 278         */
 279         StgMVar *mvar;
 280         StgInfoTable *info USED_IF_THREADS;
 281
 282         mvar = (StgMVar *)target->block_info.closure;
 283
 284         // ASSUMPTION: tso->block_info must always point to a
 285         // closure.  In the threaded RTS it does.
 286         switch (get_itbl(mvar)->type) {
 287         case MVAR_CLEAN:
 288         case MVAR_DIRTY:
 289             break;
 290         default:
 291             goto retry;
 292         }
 293
 294         info = lockClosure((StgClosure *)mvar);
 295
 296         if (target->what_next == ThreadRelocated) {
 297             target = target->_link;
 298             unlockClosure((StgClosure *)mvar,info);
 299             goto retry;
 300         }
 301         // we have the MVar, let's check whether the thread
 302         // is still blocked on the same MVar.
 303         if (target->why_blocked != BlockedOnMVar
 304             || (StgMVar *)target->block_info.closure != mvar) {
 305             unlockClosure((StgClosure *)mvar, info);
 306             goto retry;
 307         }
 308
 309         if ((target->flags & TSO_BLOCKEX) &&
 310             ((target->flags & TSO_INTERRUPTIBLE) == 0)) {
 311             lockClosure((StgClosure *)target);
 312             blockedThrowTo(cap,source,target);
 313             unlockClosure((StgClosure *)mvar, info);
 314             *out = target;
 315             return THROWTO_BLOCKED; // caller releases TSO
 316         } else {
 317             removeThreadFromMVarQueue(cap, mvar, target);
 318             raiseAsync(cap, target, exception, rtsFalse, NULL);
 319             unblockOne(cap, target);
 320             unlockClosure((StgClosure *)mvar, info);
 321             return THROWTO_SUCCESS;
 322         }
 323     }
 324
 325     case BlockedOnBlackHole:
 326     {
 327         ACQUIRE_LOCK(&sched_mutex);
 328         // double checking the status after the memory barrier:
 329         if (target->why_blocked != BlockedOnBlackHole) {
 330             RELEASE_LOCK(&sched_mutex);
 331             goto retry;
 332         }
 333
 334         if (target->flags & TSO_BLOCKEX) {
 335             lockTSO(target);
 336             blockedThrowTo(cap,source,target);
 337             RELEASE_LOCK(&sched_mutex);
 338             *out = target;
 339             return THROWTO_BLOCKED; // caller releases TSO
 340         } else {
 341             removeThreadFromQueue(cap, &blackhole_queue, target);
 342             raiseAsync(cap, target, exception, rtsFalse, NULL);
 343             unblockOne(cap, target);
 344             RELEASE_LOCK(&sched_mutex);
 345             return THROWTO_SUCCESS;
 346         }
 347     }
 348
 349     case BlockedOnException:
 350     {
 351         StgTSO *target2;
 352         StgInfoTable *info;
 353
 354         /*
 355           To obtain exclusive access to a BlockedOnException thread,
 356           we must call lockClosure() on the TSO on which it is blocked.
 357           Since the TSO might change underneath our feet, after we
 358           call lockClosure() we must check that
 359
 360              (a) the closure we locked is actually a TSO
 361              (b) the original thread is still  BlockedOnException,
 362              (c) the original thread is still blocked on the TSO we locked
 363              and (d) the target thread has not been relocated.
 364
 365           We synchronise with threadStackOverflow() (which relocates
 366           threads) using lockClosure()/unlockClosure().
 367         */
 368         target2 = target->block_info.tso;
 369
 370         info = lockClosure((StgClosure *)target2);
 371         if (info != &stg_TSO_info) {
 372             unlockClosure((StgClosure *)target2, info);
 373             goto retry;
 374         }
 375         if (target->what_next == ThreadRelocated) {
 376             target = target->_link;
 377             unlockTSO(target2);
 378             goto retry;
 379         }
 380         if (target2->what_next == ThreadRelocated) {
 381             target->block_info.tso = target2->_link;
 382             unlockTSO(target2);
 383             goto retry;
 384         }
 385         if (target->why_blocked != BlockedOnException
 386             || target->block_info.tso != target2) {
 387             unlockTSO(target2);
 388             goto retry;
 389         }
 390
 391         /*
 392            Now we have exclusive rights to the target TSO...
 393
 394            If it is blocking exceptions, add the source TSO to its
 395            blocked_exceptions queue.  Otherwise, raise the exception.
 396         */
 397         if ((target->flags & TSO_BLOCKEX) &&
 398             ((target->flags & TSO_INTERRUPTIBLE) == 0)) {
 399             lockTSO(target);
 400             blockedThrowTo(cap,source,target);
 401             unlockTSO(target2);
 402             *out = target;
 403             return THROWTO_BLOCKED;
 404         } else {
 405             removeThreadFromQueue(cap, &target2->blocked_exceptions, target);
 406             raiseAsync(cap, target, exception, rtsFalse, NULL);
 407             unblockOne(cap, target);
 408             unlockTSO(target2);
 409             return THROWTO_SUCCESS;
 410         }
 411     }
 412
 413     case BlockedOnSTM:
 414         lockTSO(target);
 415         // Unblocking BlockedOnSTM threads requires the TSO to be
 416         // locked; see STM.c:unpark_tso().
 417         if (target->why_blocked != BlockedOnSTM) {
 418             goto retry;
 419         }
 420         if ((target->flags & TSO_BLOCKEX) &&
 421             ((target->flags & TSO_INTERRUPTIBLE) == 0)) {
 422             blockedThrowTo(cap,source,target);
 423             *out = target;
 424             return THROWTO_BLOCKED;
 425         } else {
 426             raiseAsync(cap, target, exception, rtsFalse, NULL);
 427             unblockOne(cap, target);
 428             unlockTSO(target);
 429             return THROWTO_SUCCESS;
 430         }
 431
 432     case BlockedOnCCall:
 433     case BlockedOnCCall_NoUnblockExc:
 434         // I don't think it's possible to acquire ownership of a
 435         // BlockedOnCCall thread.  We just assume that the target
 436         // thread is blocking exceptions, and block on its
 437         // blocked_exception queue.
 438         lockTSO(target);
 439         blockedThrowTo(cap,source,target);
 440         *out = target;
 441         return THROWTO_BLOCKED;
 442
 443 #ifndef THREADEDED_RTS
 444     case BlockedOnRead:
 445     case BlockedOnWrite:
 446     case BlockedOnDelay:
 447 #if defined(mingw32_HOST_OS)
 448     case BlockedOnDoProc:
 449 #endif
 450         if ((target->flags & TSO_BLOCKEX) &&
 451             ((target->flags & TSO_INTERRUPTIBLE) == 0)) {
 452             blockedThrowTo(cap,source,target);
 453             return THROWTO_BLOCKED;
 454         } else {
 455             removeFromQueues(cap,target);
 456             raiseAsync(cap, target, exception, rtsFalse, NULL);
 457             return THROWTO_SUCCESS;
 458         }
 459 #endif
 460
 461     default:
 462         barf("throwTo: unrecognised why_blocked value");
 463     }
 464     barf("throwTo");
 465 }
 466
 467 // Block a TSO on another TSO's blocked_exceptions queue.
 468 // Precondition: we hold an exclusive lock on the target TSO (this is
 469 // complex to achieve as there's no single lock on a TSO; see
 470 // throwTo()).
 471 static void
 472 blockedThrowTo (Capability *cap, StgTSO *source, StgTSO *target)
 473 {
 474     debugTrace(DEBUG_sched, "throwTo: blocking on thread %lu", (unsigned long)target->id);
 475     setTSOLink(cap, source, target->blocked_exceptions);
 476     target->blocked_exceptions = source;
 477     dirty_TSO(cap,target); // we modified the blocked_exceptions queue
 478
 479     source->block_info.tso = target;
 480     write_barrier(); // throwTo_exception *must* be visible if BlockedOnException is.
 481     source->why_blocked = BlockedOnException;
 482 }
 483
 484
 485 #ifdef THREADED_RTS
 486 void
 487 throwToReleaseTarget (void *tso)
 488 {
 489     unlockTSO((StgTSO *)tso);
 490 }
 491 #endif
 492
 493 /* -----------------------------------------------------------------------------
 494    Waking up threads blocked in throwTo
 495
 496    There are two ways to do this: maybePerformBlockedException() will
 497    perform the throwTo() for the thread at the head of the queue
 498    immediately, and leave the other threads on the queue.
 499    maybePerformBlockedException() also checks the TSO_BLOCKEX flag
 500    before raising an exception.
 501
 502    awakenBlockedExceptionQueue() will wake up all the threads in the
 503    queue, but not perform any throwTo() immediately.  This might be
 504    more appropriate when the target thread is the one actually running
 505    (see Exception.cmm).
 506
 507    Returns: non-zero if an exception was raised, zero otherwise.
 508    -------------------------------------------------------------------------- */
 509
 510 int
 511 maybePerformBlockedException (Capability *cap, StgTSO *tso)
 512 {
 513     StgTSO *source;
 514
 515     if (tso->blocked_exceptions != END_TSO_QUEUE &&
 516         (tso->flags & TSO_BLOCKEX) != 0) {
 517         debugTrace(DEBUG_sched, "throwTo: thread %lu has blocked exceptions but is inside block", (unsigned long)tso->id);
 518     }
 519
 520     if (tso->blocked_exceptions != END_TSO_QUEUE
 521         && ((tso->flags & TSO_BLOCKEX) == 0
 522             || ((tso->flags & TSO_INTERRUPTIBLE) && interruptible(tso)))) {
 523
 524         // Lock the TSO, this gives us exclusive access to the queue
 525         lockTSO(tso);
 526
 527         // Check the queue again; it might have changed before we
 528         // locked it.
 529         if (tso->blocked_exceptions == END_TSO_QUEUE) {
 530             unlockTSO(tso);
 531             return 0;
 532         }
 533
 534         // We unblock just the first thread on the queue, and perform
 535         // its throw immediately.
 536         source = tso->blocked_exceptions;
 537         performBlockedException(cap, source, tso);
 538         tso->blocked_exceptions = unblockOne_(cap, source,
 539                                               rtsFalse/*no migrate*/);
 540         unlockTSO(tso);
 541         return 1;
 542     }
 543     return 0;
 544 }
 545
 546 void
 547 awakenBlockedExceptionQueue (Capability *cap, StgTSO *tso)
 548 {
 549     if (tso->blocked_exceptions != END_TSO_QUEUE) {
 550         lockTSO(tso);
 551         awakenBlockedQueue(cap, tso->blocked_exceptions);
 552         tso->blocked_exceptions = END_TSO_QUEUE;
 553         unlockTSO(tso);
 554     }
 555 }
 556
 557 static void
 558 performBlockedException (Capability *cap, StgTSO *source, StgTSO *target)
 559 {
 560     StgClosure *exception;
 561
 562     ASSERT(source->why_blocked == BlockedOnException);
 563     ASSERT(source->block_info.tso->id == target->id);
 564     ASSERT(source->sp[0] == (StgWord)&stg_block_throwto_info);
 565     ASSERT(((StgTSO *)source->sp[1])->id == target->id);
 566     // check ids not pointers, because the thread might be relocated
 567
 568     exception = (StgClosure *)source->sp[2];
 569     throwToSingleThreaded(cap, target, exception);
 570     source->sp += 3;
 571 }
 572
 573 /* -----------------------------------------------------------------------------
 574    Remove a thread from blocking queues.
 575
 576    This is for use when we raise an exception in another thread, which
 577    may be blocked.
 578
 579    Precondition: we have exclusive access to the TSO, which entails
 580    holding a lock on the object that owns the queue, if the TSO is
 581    blocked.  e.g. if the thread is blocked on an MVar, we must hold a
 582    lock on the MVar before calling removeFromQueues().
 583
 584    This has nothing to do with the UnblockThread event in GranSim. -- HWL
 585    -------------------------------------------------------------------------- */
 586
 587 static void
 588 removeFromQueues(Capability *cap, StgTSO *tso)
 589 {
 590   switch (tso->why_blocked) {
 591
 592   case NotBlocked:
 593       return;
 594
 595   case BlockedOnSTM:
 596     // Be careful: nothing to do here!  We tell the scheduler that the
 597     // thread is runnable and we leave it to the stack-walking code to
 598     // abort the transaction while unwinding the stack.  We should
 599     // perhaps have a debugging test to make sure that this really
 600     // happens and that the 'zombie' transaction does not get
 601     // committed.
 602     goto done;
 603
 604   case BlockedOnMVar:
 605       removeThreadFromMVarQueue(cap, (StgMVar *)tso->block_info.closure, tso);
 606       goto done;
 607
 608   case BlockedOnBlackHole:
 609       // we have exclusive access to this TSO, which implies that we
 610       // must hold sched_mutex:
 611       ASSERT_LOCK_HELD(&sched_mutex);
 612       removeThreadFromQueue(cap, &blackhole_queue, tso);
 613       goto done;
 614
 615   case BlockedOnException:
 616     {
 617       StgTSO *target  = tso->block_info.tso;
 618
 619       // NO: when called by threadPaused(), we probably have this
 620       // TSO already locked (WHITEHOLEd) because we just placed
 621       // ourselves on its queue.
 622       // ASSERT(get_itbl(target)->type == TSO);
 623
 624       while (target->what_next == ThreadRelocated) {
 625           target = target->_link;
 626       }
 627
 628       removeThreadFromQueue(cap, &target->blocked_exceptions, tso);
 629       goto done;
 630     }
 631
 632 #if !defined(THREADED_RTS)
 633   case BlockedOnRead:
 634   case BlockedOnWrite:
 635 #if defined(mingw32_HOST_OS)
 636   case BlockedOnDoProc:
 637 #endif
 638       removeThreadFromDeQueue(cap, &blocked_queue_hd, &blocked_queue_tl, tso);
 639 #if defined(mingw32_HOST_OS)
 640       /* (Cooperatively) signal that the worker thread should abort
 641        * the request.
 642        */
 643       abandonWorkRequest(tso->block_info.async_result->reqID);
 644 #endif
 645       goto done;
 646
 647   case BlockedOnDelay:
 648         removeThreadFromQueue(cap, &sleeping_queue, tso);
 649         goto done;
 650 #endif
 651
 652   default:
 653       barf("removeFromQueues: %d", tso->why_blocked);
 654   }
 655
 656  done:
 657   tso->_link = END_TSO_QUEUE; // no write barrier reqd
 658   tso->why_blocked = NotBlocked;
 659   tso->block_info.closure = NULL;
 660   appendToRunQueue(cap,tso);
 661
 662   // We might have just migrated this TSO to our Capability:
 663   if (tso->bound) {
 664       tso->bound->cap = cap;
 665   }
 666   tso->cap = cap;
 667 }
 668
 669 /* -----------------------------------------------------------------------------
 670  * raiseAsync()
 671  *
 672  * The following function implements the magic for raising an
 673  * asynchronous exception in an existing thread.
 674  *
 675  * We first remove the thread from any queue on which it might be
 676  * blocked.  The possible blockages are MVARs and BLACKHOLE_BQs.
 677  *
 678  * We strip the stack down to the innermost CATCH_FRAME, building
 679  * thunks in the heap for all the active computations, so they can
 680  * be restarted if necessary.  When we reach a CATCH_FRAME, we build
 681  * an application of the handler to the exception, and push it on
 682  * the top of the stack.
 683  *
 684  * How exactly do we save all the active computations?  We create an
 685  * AP_STACK for every UpdateFrame on the stack.  Entering one of these
 686  * AP_STACKs pushes everything from the corresponding update frame
 687  * upwards onto the stack.  (Actually, it pushes everything up to the
 688  * next update frame plus a pointer to the next AP_STACK object.
 689  * Entering the next AP_STACK object pushes more onto the stack until we
 690  * reach the last AP_STACK object - at which point the stack should look
 691  * exactly as it did when we killed the TSO and we can continue
 692  * execution by entering the closure on top of the stack.
 693  *
 694  * We can also kill a thread entirely - this happens if either (a) the
 695  * exception passed to raiseAsync is NULL, or (b) there's no
 696  * CATCH_FRAME on the stack.  In either case, we strip the entire
 697  * stack and replace the thread with a zombie.
 698  *
 699  * ToDo: in THREADED_RTS mode, this function is only safe if either
 700  * (a) we hold all the Capabilities (eg. in GC, or if there is only
 701  * one Capability), or (b) we own the Capability that the TSO is
 702  * currently blocked on or on the run queue of.
 703  *
 704  * -------------------------------------------------------------------------- */
 705
 706 static void
 707 raiseAsync(Capability *cap, StgTSO *tso, StgClosure *exception,
 708            rtsBool stop_at_atomically, StgPtr stop_here)
 709 {
 710     StgRetInfoTable *info;
 711     StgPtr sp, frame;
 712     nat i;
 713
 714     debugTrace(DEBUG_sched,
 715                "raising exception in thread %ld.", (long)tso->id);
 716
 717 #if defined(PROFILING)
 718     /*
 719      * Debugging tool: on raising an  exception, show where we are.
 720      * See also Exception.cmm:raisezh_fast.
 721      * This wasn't done for asynchronous exceptions originally; see #1450
 722      */
 723     if (RtsFlags.ProfFlags.showCCSOnException)
 724     {
 725         fprintCCS_stderr(tso->prof.CCCS);
 726     }
 727 #endif
 728
 729     // mark it dirty; we're about to change its stack.
 730     dirty_TSO(cap, tso);
 731
 732     sp = tso->sp;
 733
 734     // ASSUMES: the thread is not already complete or dead.  Upper
 735     // layers should deal with that.
 736     ASSERT(tso->what_next != ThreadComplete && tso->what_next != ThreadKilled);
 737
 738     // The stack freezing code assumes there's a closure pointer on
 739     // the top of the stack, so we have to arrange that this is the case...
 740     //
 741     if (sp[0] == (W_)&stg_enter_info) {
 742         sp++;
 743     } else {
 744         sp--;
 745         sp[0] = (W_)&stg_dummy_ret_closure;
 746     }
 747
 748     frame = sp + 1;
 749     while (stop_here == NULL || frame < stop_here) {
 750
 751         // 1. Let the top of the stack be the "current closure"
 752         //
 753         // 2. Walk up the stack until we find either an UPDATE_FRAME or a
 754         // CATCH_FRAME.
 755         //
 756         // 3. If it's an UPDATE_FRAME, then make an AP_STACK containing the
 757         // current closure applied to the chunk of stack up to (but not
 758         // including) the update frame.  This closure becomes the "current
 759         // closure".  Go back to step 2.
 760         //
 761         // 4. If it's a CATCH_FRAME, then leave the exception handler on
 762         // top of the stack applied to the exception.
 763         //
 764         // 5. If it's a STOP_FRAME, then kill the thread.
 765         //
 766         // NB: if we pass an ATOMICALLY_FRAME then abort the associated
 767         // transaction
 768
 769         info = get_ret_itbl((StgClosure *)frame);
 770
 771         switch (info->i.type) {
 772
 773         case UPDATE_FRAME:
 774         {
 775             StgAP_STACK * ap;
 776             nat words;
 777
 778             // First build an AP_STACK consisting of the stack chunk above the
 779             // current update frame, with the top word on the stack as the
 780             // fun field.
 781             //
 782             words = frame - sp - 1;
 783             ap = (StgAP_STACK *)allocateLocal(cap,AP_STACK_sizeW(words));
 784
 785             ap->size = words;
 786             ap->fun  = (StgClosure *)sp[0];
 787             sp++;
 788             for(i=0; i < (nat)words; ++i) {
 789                 ap->payload[i] = (StgClosure *)*sp++;
 790             }
 791
 792             SET_HDR(ap,&stg_AP_STACK_info,
 793                     ((StgClosure *)frame)->header.prof.ccs /* ToDo */);
 794             TICK_ALLOC_UP_THK(words+1,0);
 795
 796             //IF_DEBUG(scheduler,
 797             //       debugBelch("sched: Updating ");
 798             //       printPtr((P_)((StgUpdateFrame *)frame)->updatee);
 799             //       debugBelch(" with ");
 800             //       printObj((StgClosure *)ap);
 801             //  );
 802
 803             // Perform the update
 804             // TODO: this may waste some work, if the thunk has
 805             // already been updated by another thread.
 806             UPD_IND_NOLOCK(((StgUpdateFrame *)frame)->updatee,
 807                            (StgClosure *)ap);
 808
 809             sp += sizeofW(StgUpdateFrame) - 1;
 810             sp[0] = (W_)ap; // push onto stack
 811             frame = sp + 1;
 812             continue; //no need to bump frame
 813         }
 814
 815         case STOP_FRAME:
 816         {
 817             // We've stripped the entire stack, the thread is now dead.
 818             tso->what_next = ThreadKilled;
 819             tso->sp = frame + sizeofW(StgStopFrame);
 820             return;
 821         }
 822
 823         case CATCH_FRAME:
 824             // If we find a CATCH_FRAME, and we've got an exception to raise,
 825             // then build the THUNK raise(exception), and leave it on
 826             // top of the CATCH_FRAME ready to enter.
 827             //
 828         {
 829 #ifdef PROFILING
 830             StgCatchFrame *cf = (StgCatchFrame *)frame;
 831 #endif
 832             StgThunk *raise;
 833
 834             if (exception == NULL) break;
 835
 836             // we've got an exception to raise, so let's pass it to the
 837             // handler in this frame.
 838             //
 839             raise = (StgThunk *)allocateLocal(cap,sizeofW(StgThunk)+1);
 840             TICK_ALLOC_SE_THK(1,0);
 841             SET_HDR(raise,&stg_raise_info,cf->header.prof.ccs);
 842             raise->payload[0] = exception;
 843
 844             // throw away the stack from Sp up to the CATCH_FRAME.
 845             //
 846             sp = frame - 1;
 847
 848             /* Ensure that async excpetions are blocked now, so we don't get
 849              * a surprise exception before we get around to executing the
 850              * handler.
 851              */
 852             tso->flags |= TSO_BLOCKEX | TSO_INTERRUPTIBLE;
 853
 854             /* Put the newly-built THUNK on top of the stack, ready to execute
 855              * when the thread restarts.
 856              */
 857             sp[0] = (W_)raise;
 858             sp[-1] = (W_)&stg_enter_info;
 859             tso->sp = sp-1;
 860             tso->what_next = ThreadRunGHC;
 861             IF_DEBUG(sanity, checkTSO(tso));
 862             return;
 863         }
 864
 865         case ATOMICALLY_FRAME:
 866             if (stop_at_atomically) {
 867                 ASSERT(stmGetEnclosingTRec(tso->trec) == NO_TREC);
 868                 stmCondemnTransaction(cap, tso -> trec);
 869                 tso->sp = frame;
 870                 tso->what_next = ThreadRunGHC;
 871                 return;
 872             }
 873             // Not stop_at_atomically... fall through and abort the
 874             // transaction.
 875
 876         case CATCH_STM_FRAME:
 877         case CATCH_RETRY_FRAME:
 878             // IF we find an ATOMICALLY_FRAME then we abort the
 879             // current transaction and propagate the exception.  In
 880             // this case (unlike ordinary exceptions) we do not care
 881             // whether the transaction is valid or not because its
 882             // possible validity cannot have caused the exception
 883             // and will not be visible after the abort.
 884
 885                 {
 886             StgTRecHeader *trec = tso -> trec;
 887             StgTRecHeader *outer = stmGetEnclosingTRec(trec);
 888             debugTrace(DEBUG_stm,
 889                        "found atomically block delivering async exception");
 890             stmAbortTransaction(cap, trec);
 891             stmFreeAbortedTRec(cap, trec);
 892             tso -> trec = outer;
 893             break;
 894             };
 895
 896         default:
 897             break;
 898         }
 899
 900         // move on to the next stack frame
 901         frame += stack_frame_sizeW((StgClosure *)frame);
 902     }
 903
 904     // if we got here, then we stopped at stop_here
 905     ASSERT(stop_here != NULL);
 906 }
 907
 908