1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2004
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.
11 * ---------------------------------------------------------------------------*/
14 #include "RaiseAsync.h"
16 import ghczmprim_GHCziBool_True_closure;
18 /* -----------------------------------------------------------------------------
21 A thread can request that asynchronous exceptions not be delivered
22 ("blocked") for the duration of an I/O computation. The primitive
24 blockAsyncExceptions# :: IO a -> IO a
26 is used for this purpose. During a blocked section, asynchronous
27 exceptions may be unblocked again temporarily:
29 unblockAsyncExceptions# :: IO a -> IO a
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.
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.
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
50 -------------------------------------------------------------------------- */
52 INFO_TABLE_RET( stg_unblockAsyncExceptionszh_ret, RET_SMALL )
56 StgTSO_flags(CurrentTSO) = StgTSO_flags(CurrentTSO) &
57 ~(TSO_BLOCKEX::I32|TSO_INTERRUPTIBLE::I32);
59 /* Eagerly raise a blocked exception, if there is one */
60 if (StgTSO_blocked_exceptions(CurrentTSO) != END_TSO_QUEUE) {
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.
69 * raiseAsync assumes that the stack is in ThreadRunGHC state,
70 * i.e. with a return address on the top. In unreg mode, the
71 * return value for IO is on top of the return address, so we
72 * need to make a small adjustment here.
76 STK_CHK_GEN( WDS(2), R1_PTR, stg_unblockAsyncExceptionszh_ret_info);
80 Sp(0) = stg_gc_unpt_r1_info;
82 Sp(0) = stg_ut_1_0_unreg_info;
85 (r) = foreign "C" maybePerformBlockedException (MyCapability() "ptr",
86 CurrentTSO "ptr") [R1];
89 if (StgTSO_what_next(CurrentTSO) == ThreadKilled::I16) {
90 jump stg_threadFinished;
93 ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
94 jump %ENTRY_CODE(Sp(0));
99 * Readjust stack in unregisterised mode if we didn't raise an
100 * exception, see above
110 jump %ENTRY_CODE(Sp(0));
114 jump %ENTRY_CODE(Sp(1));
118 INFO_TABLE_RET( stg_blockAsyncExceptionszh_ret, RET_SMALL )
120 StgTSO_flags(CurrentTSO) =
121 StgTSO_flags(CurrentTSO) | TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32;
125 jump %ENTRY_CODE(Sp(0));
129 jump %ENTRY_CODE(Sp(1));
133 blockAsyncExceptionszh_fast
135 /* Args: R1 :: IO a */
136 STK_CHK_GEN( WDS(2)/* worst case */, R1_PTR, blockAsyncExceptionszh_fast);
138 if ((TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX) == 0) {
140 StgTSO_flags(CurrentTSO) =
141 StgTSO_flags(CurrentTSO) | TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32;
143 /* avoid growing the stack unnecessarily */
144 if (Sp(0) == stg_blockAsyncExceptionszh_ret_info) {
148 Sp(0) = stg_unblockAsyncExceptionszh_ret_info;
156 unblockAsyncExceptionszh_fast
160 /* Args: R1 :: IO a */
161 STK_CHK_GEN( WDS(2), R1_PTR, unblockAsyncExceptionszh_fast);
163 if ((TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX) != 0) {
165 StgTSO_flags(CurrentTSO) = StgTSO_flags(CurrentTSO) &
166 ~(TSO_BLOCKEX::I32|TSO_INTERRUPTIBLE::I32);
168 /* Eagerly raise a blocked exception, if there is one */
169 if (StgTSO_blocked_exceptions(CurrentTSO) != END_TSO_QUEUE) {
171 * We have to be very careful here, as in killThread#, since
172 * we are about to raise an async exception in the current
173 * thread, which might result in the thread being killed.
176 (r) = foreign "C" maybePerformBlockedException (MyCapability() "ptr",
177 CurrentTSO "ptr") [R1];
180 if (StgTSO_what_next(CurrentTSO) == ThreadKilled::I16) {
181 jump stg_threadFinished;
184 ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
185 jump %ENTRY_CODE(Sp(0));
190 /* avoid growing the stack unnecessarily */
191 if (Sp(0) == stg_unblockAsyncExceptionszh_ret_info) {
195 Sp(0) = stg_blockAsyncExceptionszh_ret_info;
203 asyncExceptionsBlockedzh_fast
206 if ((TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX) != 0) {
215 /* args: R1 = TSO to kill, R2 = Exception */
224 STK_CHK_GEN( WDS(3), R1_PTR & R2_PTR, killThreadzh_fast);
227 * We might have killed ourselves. In which case, better be *very*
228 * careful. If the exception killed us, then return to the scheduler.
229 * If the exception went to a catch frame, we'll just continue from
233 if (StgTSO_what_next(target) == ThreadRelocated::I16) {
234 target = StgTSO__link(target);
237 if (target == CurrentTSO) {
239 /* ToDo: what if the current thread is blocking exceptions? */
240 foreign "C" throwToSingleThreaded(MyCapability() "ptr",
241 target "ptr", exception "ptr")[R1,R2];
242 if (StgTSO_what_next(CurrentTSO) == ThreadKilled::I16) {
243 jump stg_threadFinished;
246 ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
247 jump %ENTRY_CODE(Sp(0));
252 out = BaseReg + OFFSET_StgRegTable_rmp_tmp_w;
254 (retcode) = foreign "C" throwTo(MyCapability() "ptr",
260 switch [THROWTO_SUCCESS .. THROWTO_BLOCKED] (retcode) {
262 case THROWTO_SUCCESS: {
263 jump %ENTRY_CODE(Sp(0));
266 case THROWTO_BLOCKED: {
268 // we must block, and call throwToReleaseTarget() before returning
269 jump stg_block_throwto;
275 /* -----------------------------------------------------------------------------
277 -------------------------------------------------------------------------- */
285 /* Catch frames are very similar to update frames, but when entering
286 * one we just pop the frame off the stack and perform the correct
287 * kind of return to the activation record underneath us on the stack.
290 INFO_TABLE_RET(stg_catch_frame, CATCH_FRAME,
291 #if defined(PROFILING)
292 W_ unused1, W_ unused2,
294 W_ unused3, "ptr" W_ unused4)
297 Sp = Sp + SIZEOF_StgCatchFrame;
298 jump %ENTRY_CODE(Sp(SP_OFF));
304 Sp = Sp + SIZEOF_StgCatchFrame;
306 jump %ENTRY_CODE(Sp(SP_OFF));
310 /* -----------------------------------------------------------------------------
311 * The catch infotable
313 * This should be exactly the same as would be generated by this STG code
315 * catch = {x,h} \n {} -> catch#{x,h}
317 * It is used in deleteThread when reverting blackholes.
318 * -------------------------------------------------------------------------- */
320 INFO_TABLE(stg_catch,2,0,FUN,"catch","catch")
322 R2 = StgClosure_payload(R1,1); /* h */
323 R1 = StgClosure_payload(R1,0); /* x */
329 /* args: R1 = m :: IO a, R2 = handler :: Exception -> IO a */
330 STK_CHK_GEN(SIZEOF_StgCatchFrame + WDS(1), R1_PTR & R2_PTR, catchzh_fast);
332 /* Set up the catch frame */
333 Sp = Sp - SIZEOF_StgCatchFrame;
334 SET_HDR(Sp,stg_catch_frame_info,W_[CCCS]);
336 StgCatchFrame_handler(Sp) = R2;
337 StgCatchFrame_exceptions_blocked(Sp) = TO_W_(StgTSO_flags(CurrentTSO)) & TSO_BLOCKEX;
338 TICK_CATCHF_PUSHED();
340 /* Apply R1 to the realworld token */
346 /* -----------------------------------------------------------------------------
347 * The raise infotable
349 * This should be exactly the same as would be generated by this STG code
351 * raise = {err} \n {} -> raise#{err}
353 * It is used in raisezh_fast to update thunks on the update list
354 * -------------------------------------------------------------------------- */
356 INFO_TABLE(stg_raise,1,0,THUNK_1_0,"raise","raise")
358 R1 = StgThunk_payload(R1,0);
363 no_break_on_exception: W_[1];
366 INFO_TABLE_RET(stg_raise_ret, RET_SMALL, "ptr" W_ arg1)
370 W_[no_break_on_exception] = 1;
379 /* args : R1 :: Exception */
383 #if defined(PROFILING)
384 /* Debugging tool: on raising an exception, show where we are. */
386 /* ToDo: currently this is a hack. Would be much better if
387 * the info was only displayed for an *uncaught* exception.
389 if (RtsFlags_ProfFlags_showCCSOnException(RtsFlags) != 0::I32) {
390 foreign "C" fprintCCS_stderr(W_[CCCS] "ptr") [];
395 StgTSO_sp(CurrentTSO) = Sp;
396 (frame_type) = foreign "C" raiseExceptionHelper(BaseReg "ptr", CurrentTSO "ptr", exception "ptr") [];
397 Sp = StgTSO_sp(CurrentTSO);
398 if (frame_type == ATOMICALLY_FRAME) {
399 /* The exception has reached the edge of a memory transaction. Check that
400 * the transaction is valid. If not then perhaps the exception should
401 * not have been thrown: re-run the transaction. "trec" will either be
402 * a top-level transaction running the atomic block, or a nested
403 * transaction running an invariant check. In the latter case we
404 * abort and de-allocate the top-level transaction that encloses it
405 * as well (we could just abandon its transaction record, but this makes
406 * sure it's marked as aborted and available for re-use). */
409 trec = StgTSO_trec(CurrentTSO);
410 (r) = foreign "C" stmValidateNestOfTransactions(trec "ptr") [];
411 ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
412 foreign "C" stmAbortTransaction(MyCapability() "ptr", trec "ptr") [];
413 foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr") [];
415 if (outer != NO_TREC) {
416 foreign "C" stmAbortTransaction(MyCapability() "ptr", outer "ptr") [];
417 foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", outer "ptr") [];
420 StgTSO_trec(CurrentTSO) = NO_TREC;
422 // Transaction was valid: continue searching for a catch frame
423 Sp = Sp + SIZEOF_StgAtomicallyFrame;
424 goto retry_pop_stack;
426 // Transaction was not valid: we retry the exception (otherwise continue
427 // with a further call to raiseExceptionHelper)
428 ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
429 StgTSO_trec(CurrentTSO) = trec;
430 R1 = StgAtomicallyFrame_code(Sp);
435 // After stripping the stack, see whether we should break here for
436 // GHCi (c.f. the -fbreak-on-exception flag). We do this after
437 // stripping the stack for a reason: we'll be inspecting values in
438 // GHCi, and it helps if all the thunks under evaluation have
439 // already been updated with the exception, rather than being left
441 if (W_[no_break_on_exception] != 0) {
442 W_[no_break_on_exception] = 0;
444 if (TO_W_(CInt[rts_stop_on_exception]) != 0) {
446 // we don't want any further exceptions to be caught,
447 // until GHCi is ready to handle them. This prevents
448 // deadlock if an exception is raised in InteractiveUI,
449 // for exmplae. Perhaps the stop_on_exception flag should
451 W_[rts_stop_on_exception] = 0;
452 ("ptr" ioAction) = foreign "C" deRefStablePtr (W_[rts_breakpoint_io_action] "ptr") [];
455 Sp(5) = stg_raise_ret_info;
456 Sp(4) = stg_noforceIO_info; // required for unregisterised
457 Sp(3) = exception; // the AP_STACK
458 Sp(2) = ghczmprim_GHCziBool_True_closure; // dummy breakpoint info
459 Sp(1) = ghczmprim_GHCziBool_True_closure; // True <=> a breakpoint
461 jump RET_LBL(stg_ap_pppv);
465 if (frame_type == STOP_FRAME) {
467 * We've stripped the entire stack, the thread is now dead.
468 * We will leave the stack in a GC'able state, see the stg_stop_thread
469 * entry code in StgStartup.cmm.
471 Sp = CurrentTSO + TSO_OFFSET_StgTSO_stack
472 + WDS(TO_W_(StgTSO_stack_size(CurrentTSO))) - WDS(2);
473 Sp(1) = exception; /* save the exception */
474 Sp(0) = stg_enter_info; /* so that GC can traverse this stack */
475 StgTSO_what_next(CurrentTSO) = ThreadKilled::I16;
476 SAVE_THREAD_STATE(); /* inline! */
478 jump stg_threadFinished;
481 /* Ok, Sp points to the enclosing CATCH_FRAME or CATCH_STM_FRAME. Pop everything
482 * down to and including this frame, update Su, push R1, and enter the handler.
484 if (frame_type == CATCH_FRAME) {
485 handler = StgCatchFrame_handler(Sp);
487 handler = StgCatchSTMFrame_handler(Sp);
490 /* Restore the blocked/unblocked state for asynchronous exceptions
491 * at the CATCH_FRAME.
493 * If exceptions were unblocked, arrange that they are unblocked
494 * again after executing the handler by pushing an
495 * unblockAsyncExceptions_ret stack frame.
497 * If we've reached an STM catch frame then roll back the nested
498 * transaction we were using.
502 if (frame_type == CATCH_FRAME) {
503 Sp = Sp + SIZEOF_StgCatchFrame;
504 if (StgCatchFrame_exceptions_blocked(frame) == 0) {
506 Sp(0) = stg_unblockAsyncExceptionszh_ret_info;
510 trec = StgTSO_trec(CurrentTSO);
511 ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
512 foreign "C" stmAbortTransaction(MyCapability() "ptr", trec "ptr") [];
513 foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr") [];
514 StgTSO_trec(CurrentTSO) = outer;
515 Sp = Sp + SIZEOF_StgCatchSTMFrame;
518 /* Ensure that async excpetions are blocked when running the handler.
520 StgTSO_flags(CurrentTSO) =
521 StgTSO_flags(CurrentTSO) | TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32;
523 /* Call the handler, passing the exception value and a realworld
524 * token as arguments.
532 jump RET_LBL(stg_ap_pv);
537 /* Args :: R1 :: Exception */