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