rts/Exception.cmm

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2004
   4  *
   5  * Exception support
   6  *
   7  * This file is written in a subset of C--, extended with various
   8  * features specific to GHC.  It is compiled by GHC directly.  For the
   9  * syntax of .cmm files, see the parser in ghc/compiler/cmm/CmmParse.y.
  10  *
  11  * ---------------------------------------------------------------------------*/
  12
  13 #include "Cmm.h"
  14 #include "RaiseAsync.h"
  15
  16 import ghczmprim_GHCziBool_True_closure;
  17
  18 /* -----------------------------------------------------------------------------
  19    Exception Primitives
  20
  21    A thread can request that asynchronous exceptions not be delivered
  22    ("blocked") for the duration of an I/O computation.  The primitive
  23
  24         blockAsyncExceptions# :: IO a -> IO a
  25
  26    is used for this purpose.  During a blocked section, asynchronous
  27    exceptions may be unblocked again temporarily:
  28
  29         unblockAsyncExceptions# :: IO a -> IO a
  30
  31    Furthermore, asynchronous exceptions are blocked automatically during
  32    the execution of an exception handler.  Both of these primitives
  33    leave a continuation on the stack which reverts to the previous
  34    state (blocked or unblocked) on exit.
  35
  36    A thread which wants to raise an exception in another thread (using
  37    killThread#) must block until the target thread is ready to receive
  38    it.  The action of unblocking exceptions in a thread will release all
  39    the threads waiting to deliver exceptions to that thread.
  40
  41    NB. there's a bug in here.  If a thread is inside an
  42    unsafePerformIO, and inside blockAsyncExceptions# (there is an
  43    unblockAsyncExceptions_ret on the stack), and it is blocked in an
  44    interruptible operation, and it receives an exception, then the
  45    unsafePerformIO thunk will be updated with a stack object
  46    containing the unblockAsyncExceptions_ret frame.  Later, when
  47    someone else evaluates this thunk, the blocked exception state is
  48    not restored.
  49
  50    -------------------------------------------------------------------------- */
  51
  52 INFO_TABLE_RET( stg_unblockAsyncExceptionszh_ret, RET_SMALL )
  53 {
  54     CInt r;
  55
  56     StgTSO_flags(CurrentTSO) = StgTSO_flags(CurrentTSO) &
  57         ~(TSO_BLOCKEX::I32|TSO_INTERRUPTIBLE::I32);
  58
  59     /* Eagerly raise a blocked exception, if there is one */
  60     if (StgTSO_blocked_exceptions(CurrentTSO) != END_TSO_QUEUE) {
  61         /*
  62          * We have to be very careful here, as in killThread#, since
  63          * we are about to raise an async exception in the current
  64          * thread, which might result in the thread being killed.
  65          */
  66
  67         STK_CHK_GEN( WDS(2), R1_PTR, stg_unblockAsyncExceptionszh_ret_info);
  68         Sp_adj(-2);
  69         Sp(1) = R1;
  70         Sp(0) = stg_gc_unpt_r1_info;
  71         SAVE_THREAD_STATE();
  72         (r) = foreign "C" maybePerformBlockedException (MyCapability() "ptr",
  73                                                       CurrentTSO "ptr") [R1];
  74
  75         if (r != 0::CInt) {
  76             if (StgTSO_what_next(CurrentTSO) == ThreadKilled::I16) {
  77                 jump stg_threadFinished;
  78             } else {
  79                 LOAD_THREAD_STATE();
  80                 ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
  81                 jump %ENTRY_CODE(Sp(0));
  82             }
  83         }
  84     }
  85
  86     Sp_adj(1);
  87     jump %ENTRY_CODE(Sp(0));
  88 }
  89
  90 INFO_TABLE_RET( stg_blockAsyncExceptionszh_ret, RET_SMALL )
  91 {
  92     StgTSO_flags(CurrentTSO) =
  93         StgTSO_flags(CurrentTSO) | TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32;
  94
  95     Sp_adj(1);
  96     jump %ENTRY_CODE(Sp(0));
  97 }
  98
  99 blockAsyncExceptionszh_fast
 100 {
 101     /* Args: R1 :: IO a */
 102     STK_CHK_GEN( WDS(2)/* worst case */, R1_PTR, blockAsyncExceptionszh_fast);
 103
 104     if ((TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX) == 0) {
 105
 106         StgTSO_flags(CurrentTSO) =
 107            StgTSO_flags(CurrentTSO) | TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32;
 108
 109         /* avoid growing the stack unnecessarily */
 110         if (Sp(0) == stg_blockAsyncExceptionszh_ret_info) {
 111             Sp_adj(1);
 112         } else {
 113             Sp_adj(-1);
 114             Sp(0) = stg_unblockAsyncExceptionszh_ret_info;
 115         }
 116     }
 117     TICK_UNKNOWN_CALL();
 118     TICK_SLOW_CALL_v();
 119     jump stg_ap_v_fast;
 120 }
 121
 122 unblockAsyncExceptionszh_fast
 123 {
 124     CInt r;
 125
 126     /* Args: R1 :: IO a */
 127     STK_CHK_GEN( WDS(2), R1_PTR, unblockAsyncExceptionszh_fast);
 128
 129     if ((TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX) != 0) {
 130
 131         StgTSO_flags(CurrentTSO) = StgTSO_flags(CurrentTSO) &
 132            ~(TSO_BLOCKEX::I32|TSO_INTERRUPTIBLE::I32);
 133
 134         /* Eagerly raise a blocked exception, if there is one */
 135         if (StgTSO_blocked_exceptions(CurrentTSO) != END_TSO_QUEUE) {
 136             /*
 137              * We have to be very careful here, as in killThread#, since
 138              * we are about to raise an async exception in the current
 139              * thread, which might result in the thread being killed.
 140              */
 141             SAVE_THREAD_STATE();
 142             (r) = foreign "C" maybePerformBlockedException (MyCapability() "ptr",
 143                                                       CurrentTSO "ptr") [R1];
 144
 145             if (r != 0::CInt) {
 146                 if (StgTSO_what_next(CurrentTSO) == ThreadKilled::I16) {
 147                     jump stg_threadFinished;
 148                 } else {
 149                     LOAD_THREAD_STATE();
 150                     ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
 151                     jump %ENTRY_CODE(Sp(0));
 152                 }
 153             }
 154         }
 155
 156         /* avoid growing the stack unnecessarily */
 157         if (Sp(0) == stg_unblockAsyncExceptionszh_ret_info) {
 158             Sp_adj(1);
 159         } else {
 160             Sp_adj(-1);
 161             Sp(0) = stg_blockAsyncExceptionszh_ret_info;
 162         }
 163     }
 164     TICK_UNKNOWN_CALL();
 165     TICK_SLOW_CALL_v();
 166     jump stg_ap_v_fast;
 167 }
 168
 169 asyncExceptionsBlockedzh_fast
 170 {
 171     /* args: none */
 172     if ((TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX) != 0) {
 173         RET_N(1);
 174     } else {
 175         RET_N(0);
 176     }
 177 }
 178
 179 killThreadzh_fast
 180 {
 181     /* args: R1 = TSO to kill, R2 = Exception */
 182
 183     W_ why_blocked;
 184     W_ target;
 185     W_ exception;
 186
 187     target = R1;
 188     exception = R2;
 189
 190     /* Needs 3 words because throwToSingleThreaded uses some stack */
 191     STK_CHK_GEN( WDS(3), R1_PTR & R2_PTR, killThreadzh_fast);
 192
 193     /*
 194      * We might have killed ourselves.  In which case, better be *very*
 195      * careful.  If the exception killed us, then return to the scheduler.
 196      * If the exception went to a catch frame, we'll just continue from
 197      * the handler.
 198      */
 199   loop:
 200     if (StgTSO_what_next(target) == ThreadRelocated::I16) {
 201         target = StgTSO__link(target);
 202         goto loop;
 203     }
 204     if (target == CurrentTSO) {
 205         SAVE_THREAD_STATE();
 206         /* ToDo: what if the current thread is blocking exceptions? */
 207         foreign "C" throwToSingleThreaded(MyCapability() "ptr",
 208                                           target "ptr", exception "ptr")[R1,R2];
 209         if (StgTSO_what_next(CurrentTSO) == ThreadKilled::I16) {
 210             jump stg_threadFinished;
 211         } else {
 212             LOAD_THREAD_STATE();
 213             ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
 214             jump %ENTRY_CODE(Sp(0));
 215         }
 216     } else {
 217         W_ out;
 218         W_ retcode;
 219         out = Sp - WDS(1); /* ok to re-use stack space here */
 220
 221         (retcode) = foreign "C" throwTo(MyCapability() "ptr",
 222                                       CurrentTSO "ptr",
 223                                       target "ptr",
 224                                       exception "ptr",
 225                                       out "ptr") [R1,R2];
 226
 227         switch [THROWTO_SUCCESS .. THROWTO_BLOCKED] (retcode) {
 228
 229         case THROWTO_SUCCESS: {
 230             jump %ENTRY_CODE(Sp(0));
 231         }
 232
 233         case THROWTO_BLOCKED: {
 234             R3 = W_[out];
 235             // we must block, and call throwToReleaseTarget() before returning
 236             jump stg_block_throwto;
 237         }
 238         }
 239     }
 240 }
 241
 242 /* -----------------------------------------------------------------------------
 243    Catch frames
 244    -------------------------------------------------------------------------- */
 245
 246 #define SP_OFF 0
 247
 248 /* Catch frames are very similar to update frames, but when entering
 249  * one we just pop the frame off the stack and perform the correct
 250  * kind of return to the activation record underneath us on the stack.
 251  */
 252
 253 INFO_TABLE_RET(stg_catch_frame, CATCH_FRAME,
 254 #if defined(PROFILING)
 255   W_ unused1, W_ unused2,
 256 #endif
 257   W_ unused3, P_ unused4)
 258    {
 259       Sp = Sp + SIZEOF_StgCatchFrame;
 260       jump %ENTRY_CODE(Sp(SP_OFF));
 261    }
 262
 263 /* -----------------------------------------------------------------------------
 264  * The catch infotable
 265  *
 266  * This should be exactly the same as would be generated by this STG code
 267  *
 268  * catch = {x,h} \n {} -> catch#{x,h}
 269  *
 270  * It is used in deleteThread when reverting blackholes.
 271  * -------------------------------------------------------------------------- */
 272
 273 INFO_TABLE(stg_catch,2,0,FUN,"catch","catch")
 274 {
 275   R2 = StgClosure_payload(R1,1); /* h */
 276   R1 = StgClosure_payload(R1,0); /* x */
 277   jump catchzh_fast;
 278 }
 279
 280 catchzh_fast
 281 {
 282     /* args: R1 = m :: IO a, R2 = handler :: Exception -> IO a */
 283     STK_CHK_GEN(SIZEOF_StgCatchFrame + WDS(1), R1_PTR & R2_PTR, catchzh_fast);
 284
 285     /* Set up the catch frame */
 286     Sp = Sp - SIZEOF_StgCatchFrame;
 287     SET_HDR(Sp,stg_catch_frame_info,W_[CCCS]);
 288
 289     StgCatchFrame_handler(Sp) = R2;
 290     StgCatchFrame_exceptions_blocked(Sp) = TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX;
 291     TICK_CATCHF_PUSHED();
 292
 293     /* Apply R1 to the realworld token */
 294     TICK_UNKNOWN_CALL();
 295     TICK_SLOW_CALL_v();
 296     jump stg_ap_v_fast;
 297 }
 298
 299 /* -----------------------------------------------------------------------------
 300  * The raise infotable
 301  *
 302  * This should be exactly the same as would be generated by this STG code
 303  *
 304  *   raise = {err} \n {} -> raise#{err}
 305  *
 306  * It is used in raisezh_fast to update thunks on the update list
 307  * -------------------------------------------------------------------------- */
 308
 309 INFO_TABLE(stg_raise,1,0,THUNK_1_0,"raise","raise")
 310 {
 311   R1 = StgThunk_payload(R1,0);
 312   jump raisezh_fast;
 313 }
 314
 315 section "data" {
 316   no_break_on_exception: W_[1];
 317 }
 318
 319 INFO_TABLE_RET(stg_raise_ret, RET_SMALL, P_ arg1)
 320 {
 321   R1 = Sp(1);
 322   Sp = Sp + WDS(2);
 323   W_[no_break_on_exception] = 1;
 324   jump raisezh_fast;
 325 }
 326
 327 raisezh_fast
 328 {
 329     W_ handler;
 330     W_ frame_type;
 331     W_ exception;
 332     /* args : R1 :: Exception */
 333
 334    exception = R1;
 335
 336 #if defined(PROFILING)
 337     /* Debugging tool: on raising an  exception, show where we are. */
 338
 339     /* ToDo: currently this is a hack.  Would be much better if
 340      * the info was only displayed for an *uncaught* exception.
 341      */
 342     if (RtsFlags_ProfFlags_showCCSOnException(RtsFlags) != 0::I32) {
 343       foreign "C" fprintCCS_stderr(W_[CCCS] "ptr") [];
 344     }
 345 #endif
 346
 347 retry_pop_stack:
 348     StgTSO_sp(CurrentTSO) = Sp;
 349     (frame_type) = foreign "C" raiseExceptionHelper(BaseReg "ptr", CurrentTSO "ptr", exception "ptr") [];
 350     Sp = StgTSO_sp(CurrentTSO);
 351     if (frame_type == ATOMICALLY_FRAME) {
 352       /* The exception has reached the edge of a memory transaction.  Check that
 353        * the transaction is valid.  If not then perhaps the exception should
 354        * not have been thrown: re-run the transaction.  "trec" will either be
 355        * a top-level transaction running the atomic block, or a nested
 356        * transaction running an invariant check.  In the latter case we
 357        * abort and de-allocate the top-level transaction that encloses it
 358        * as well (we could just abandon its transaction record, but this makes
 359        * sure it's marked as aborted and available for re-use). */
 360       W_ trec, outer;
 361       W_ r;
 362       trec = StgTSO_trec(CurrentTSO);
 363       (r) = foreign "C" stmValidateNestOfTransactions(trec "ptr") [];
 364       ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
 365       foreign "C" stmAbortTransaction(MyCapability() "ptr", trec "ptr") [];
 366       foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr") [];
 367
 368       if (outer != NO_TREC) {
 369         foreign "C" stmAbortTransaction(MyCapability() "ptr", outer "ptr") [];
 370         foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", outer "ptr") [];
 371       }
 372
 373       StgTSO_trec(CurrentTSO) = NO_TREC;
 374       if (r != 0) {
 375         // Transaction was valid: continue searching for a catch frame
 376         Sp = Sp + SIZEOF_StgAtomicallyFrame;
 377         goto retry_pop_stack;
 378       } else {
 379         // Transaction was not valid: we retry the exception (otherwise continue
 380         // with a further call to raiseExceptionHelper)
 381         ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
 382         StgTSO_trec(CurrentTSO) = trec;
 383         R1 = StgAtomicallyFrame_code(Sp);
 384         jump stg_ap_v_fast;
 385       }
 386     }
 387
 388     // After stripping the stack, see whether we should break here for
 389     // GHCi (c.f. the -fbreak-on-exception flag).  We do this after
 390     // stripping the stack for a reason: we'll be inspecting values in
 391     // GHCi, and it helps if all the thunks under evaluation have
 392     // already been updated with the exception, rather than being left
 393     // as blackholes.
 394     if (W_[no_break_on_exception] != 0) {
 395         W_[no_break_on_exception] = 0;
 396     } else {
 397         if (TO_W_(CInt[rts_stop_on_exception]) != 0) {
 398             W_ ioAction;
 399             // we don't want any further exceptions to be caught,
 400             // until GHCi is ready to handle them.  This prevents
 401             // deadlock if an exception is raised in InteractiveUI,
 402             // for exmplae.  Perhaps the stop_on_exception flag should
 403             // be per-thread.
 404             W_[rts_stop_on_exception] = 0;
 405             ("ptr" ioAction) = foreign "C" deRefStablePtr (W_[rts_breakpoint_io_action] "ptr") [];
 406             Sp = Sp - WDS(7);
 407             Sp(6) = exception;
 408             Sp(5) = stg_raise_ret_info;
 409             Sp(4) = stg_noforceIO_info;    // required for unregisterised
 410             Sp(3) = exception;             // the AP_STACK
 411             Sp(2) = ghczmprim_GHCziBool_True_closure; // dummy breakpoint info
 412             Sp(1) = ghczmprim_GHCziBool_True_closure; // True <=> a breakpoint
 413             R1 = ioAction;
 414             jump RET_LBL(stg_ap_pppv);
 415         }
 416     }
 417
 418     if (frame_type == STOP_FRAME) {
 419         /*
 420          * We've stripped the entire stack, the thread is now dead.
 421          * We will leave the stack in a GC'able state, see the stg_stop_thread
 422          * entry code in StgStartup.cmm.
 423          */
 424         Sp = CurrentTSO + TSO_OFFSET_StgTSO_stack
 425                 + WDS(TO_W_(StgTSO_stack_size(CurrentTSO))) - WDS(2);
 426         Sp(1) = exception;      /* save the exception */
 427         Sp(0) = stg_enter_info; /* so that GC can traverse this stack */
 428         StgTSO_what_next(CurrentTSO) = ThreadKilled::I16;
 429         SAVE_THREAD_STATE();    /* inline! */
 430
 431         jump stg_threadFinished;
 432     }
 433
 434     /* Ok, Sp points to the enclosing CATCH_FRAME or CATCH_STM_FRAME.  Pop everything
 435      * down to and including this frame, update Su, push R1, and enter the handler.
 436      */
 437     if (frame_type == CATCH_FRAME) {
 438       handler = StgCatchFrame_handler(Sp);
 439     } else {
 440       handler = StgCatchSTMFrame_handler(Sp);
 441     }
 442
 443     /* Restore the blocked/unblocked state for asynchronous exceptions
 444      * at the CATCH_FRAME.
 445      *
 446      * If exceptions were unblocked, arrange that they are unblocked
 447      * again after executing the handler by pushing an
 448      * unblockAsyncExceptions_ret stack frame.
 449      *
 450      * If we've reached an STM catch frame then roll back the nested
 451      * transaction we were using.
 452      */
 453     W_ frame;
 454     frame = Sp;
 455     if (frame_type == CATCH_FRAME) {
 456       Sp = Sp + SIZEOF_StgCatchFrame;
 457       if (StgCatchFrame_exceptions_blocked(frame) == 0) {
 458         Sp_adj(-1);
 459         Sp(0) = stg_unblockAsyncExceptionszh_ret_info;
 460       }
 461     } else {
 462       W_ trec, outer;
 463       trec = StgTSO_trec(CurrentTSO);
 464       ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
 465       foreign "C" stmAbortTransaction(MyCapability() "ptr", trec "ptr") [];
 466       foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr") [];
 467       StgTSO_trec(CurrentTSO) = outer;
 468       Sp = Sp + SIZEOF_StgCatchSTMFrame;
 469     }
 470
 471     /* Ensure that async excpetions are blocked when running the handler.
 472     */
 473     StgTSO_flags(CurrentTSO) =
 474         StgTSO_flags(CurrentTSO) | TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32;
 475
 476     /* Call the handler, passing the exception value and a realworld
 477      * token as arguments.
 478      */
 479     Sp_adj(-1);
 480     Sp(0) = exception;
 481     R1 = handler;
 482     Sp_adj(-1);
 483     TICK_UNKNOWN_CALL();
 484     TICK_SLOW_CALL_pv();
 485     jump RET_LBL(stg_ap_pv);
 486 }
 487
 488 raiseIOzh_fast
 489 {
 490   /* Args :: R1 :: Exception */
 491   jump raisezh_fast;
 492 }