Ben Gamari pushed to branch wip/loop-backtrace at Glasgow Haskell Compiler / GHC

Commits:

9 changed files:

Changes:

  • changelog.d/builtin-exception-backtraces
    1
    +section: rts
    
    2
    +synopsis: Non-termination exceptions now have backtrace annotations
    
    3
    +issues: #21878
    
    4
    +mrs: !16158
    
    5
    +description: {
    
    6
    +  The `NonTermination` exception (manifesting in printed exception output as
    
    7
    +  `<<loop>>`) now include `Backtrace` `ExceptionAnnotations`, like exceptions
    
    8
    +  thrown from user-written Haskell.
    
    9
    +}
    
    10
    +

  • libraries/ghc-internal/include/RtsIfaceSymbols.h
    ... ... @@ -20,7 +20,7 @@ CLOSURE(GHCziInternalziIOziException, blockedIndefinitelyOnSTM_closure)
    20 20
     CLOSURE(GHCziInternalziIOziException, cannotCompactFunction_closure)
    
    21 21
     CLOSURE(GHCziInternalziIOziException, cannotCompactPinned_closure)
    
    22 22
     CLOSURE(GHCziInternalziIOziException, cannotCompactMutable_closure)
    
    23
    -CLOSURE(GHCziInternalziControlziExceptionziBase, nonTermination_closure)
    
    23
    +CLOSURE(GHCziInternalziControlziExceptionziBase, nonTerminationError_closure)
    
    24 24
     CLOSURE(GHCziInternalziControlziExceptionziBase, nestedAtomically_closure)
    
    25 25
     CLOSURE(GHCziInternalziControlziExceptionziBase, noMatchingContinuationPrompt_closure)
    
    26 26
     #if defined(mingw32_HOST_OS)
    

  • libraries/ghc-internal/src/GHC/Internal/Control/Exception/Base.hs
    ... ... @@ -108,7 +108,9 @@ module GHC.Internal.Control.Exception.Base (
    108 108
             impossibleError, impossibleConstraintError,
    
    109 109
             nonExhaustiveGuardsError, patError, noMethodBindingError,
    
    110 110
             typeError,
    
    111
    -        nonTermination, nestedAtomically, noMatchingContinuationPrompt,
    
    111
    +        nonTermination, nonTerminationError,
    
    112
    +        nestedAtomically,
    
    113
    +        noMatchingContinuationPrompt,
    
    112 114
       ) where
    
    113 115
     
    
    114 116
     import           GHC.Internal.Base (
    
    ... ... @@ -448,6 +450,9 @@ impossibleConstraintError s = errorWithoutStackTrace (unpackCStringUtf8# s)
    448 450
     
    
    449 451
     
    
    450 452
     -- GHC's RTS calls this
    
    453
    +nonTerminationError :: IO ()
    
    454
    +nonTerminationError = throwIO NonTermination
    
    455
    +
    
    451 456
     nonTermination :: SomeException
    
    452 457
     nonTermination = toException NonTermination
    
    453 458
     
    

  • rts/Prelude.h
    ... ... @@ -58,7 +58,7 @@ extern StgClosure ZCMain_main_closure;
    58 58
     #define cannotCompactFunction_closure ghc_hs_iface->cannotCompactFunction_closure
    
    59 59
     #define cannotCompactPinned_closure ghc_hs_iface->cannotCompactPinned_closure
    
    60 60
     #define cannotCompactMutable_closure ghc_hs_iface->cannotCompactMutable_closure
    
    61
    -#define nonTermination_closure    ghc_hs_iface->nonTermination_closure
    
    61
    +#define nonTerminationError_closure    ghc_hs_iface->nonTerminationError_closure
    
    62 62
     #define nestedAtomically_closure  ghc_hs_iface->nestedAtomically_closure
    
    63 63
     #define absentSumFieldError_closure ghc_hs_iface->absentSumFieldError_closure
    
    64 64
     #define underflowException_closure ghc_hs_iface->underflowException_closure
    

  • rts/RtsStartup.c
    ... ... @@ -193,7 +193,7 @@ static void initBuiltinGcRoots(void)
    193 193
         getStablePtr((StgPtr)heapOverflow_closure);
    
    194 194
         getStablePtr((StgPtr)unpackCString_closure);
    
    195 195
         getStablePtr((StgPtr)blockedIndefinitelyOnMVar_closure);
    
    196
    -    getStablePtr((StgPtr)nonTermination_closure);
    
    196
    +    getStablePtr((StgPtr)nonTerminationError_closure);
    
    197 197
         getStablePtr((StgPtr)blockedIndefinitelyOnSTM_closure);
    
    198 198
         getStablePtr((StgPtr)allocationLimitExceeded_closure);
    
    199 199
         getStablePtr((StgPtr)cannotCompactFunction_closure);
    

  • rts/Schedule.c
    ... ... @@ -3276,6 +3276,17 @@ findAtomicallyFrameHelper (Capability *cap, StgTSO *tso)
    3276 3276
       }
    
    3277 3277
     }
    
    3278 3278
     
    
    3279
    +static void throwNontermination(Capability *cap, StgTSO *tso) {
    
    3280
    +  StgStack *stack = tso->stackobj;
    
    3281
    +  stack->sp -= 3;
    
    3282
    +  stack->sp[0] = (W_)&stg_enter_info;
    
    3283
    +  stack->sp[1] = (W_)nonTerminationError_closure;
    
    3284
    +  stack->sp[2] = (W_)&stg_ap_v_info;
    
    3285
    +  tso->why_blocked = NotBlocked;
    
    3286
    +  appendToRunQueue(cap,tso);
    
    3287
    +}
    
    3288
    +
    
    3289
    +
    
    3279 3290
     /* -----------------------------------------------------------------------------
    
    3280 3291
        resurrectThreads is called after garbage collection on the list of
    
    3281 3292
        threads found to be garbage.  Each of these threads will be woken
    
    ... ... @@ -3313,8 +3324,7 @@ resurrectThreads (StgTSO *threads)
    3313 3324
                                       (StgClosure *)blockedIndefinitelyOnMVar_closure);
    
    3314 3325
                 break;
    
    3315 3326
             case BlockedOnBlackHole:
    
    3316
    -            throwToSingleThreaded(cap, tso,
    
    3317
    -                                  (StgClosure *)nonTermination_closure);
    
    3327
    +            throwNontermination(cap, tso);
    
    3318 3328
                 break;
    
    3319 3329
             case BlockedOnSTM:
    
    3320 3330
                 throwToSingleThreaded(cap, tso,
    

  • rts/include/rts/RtsToHsIface.h
    ... ... @@ -25,7 +25,7 @@ typedef struct {
    25 25
         StgClosure *cannotCompactFunction_closure;  // GHC.Internal.IO.Exception.cannotCompactFunction_closure
    
    26 26
         StgClosure *cannotCompactPinned_closure;  // GHC.Internal.IO.Exception.cannotCompactPinned_closure
    
    27 27
         StgClosure *cannotCompactMutable_closure;  // GHC.Internal.IO.Exception.cannotCompactMutable_closure
    
    28
    -    StgClosure *nonTermination_closure;  // GHC.Internal.Control.Exception.Base.nonTermination_closure
    
    28
    +    StgClosure *nonTerminationError_closure;  // GHC.Internal.Control.Exception.Base.nonTerminationError_closure
    
    29 29
         StgClosure *nestedAtomically_closure;  // GHC.Internal.Control.Exception.Base.nestedAtomically_closure
    
    30 30
         StgClosure *noMatchingContinuationPrompt_closure;  // GHC.Internal.Control.Exception.Base.noMatchingContinuationPrompt_closure
    
    31 31
         StgClosure *blockedOnBadFD_closure;  // GHC.Internal.Event.Thread.blockedOnBadFD_closure
    

  • testsuite/tests/rts/LoopBacktrace.stderr
    ... ... @@ -3,19 +3,19 @@ LoopBacktrace: Uncaught exception ghc-internal:GHC.Internal.Control.Exception.Ba
    3 3
     <<loop>>
    
    4 4
     
    
    5 5
     IPE backtrace:
    
    6
    -    Cmm$rts/StgStartup.cmm. (:)
    
    7
    -    Cmm$rts/Exception.cmm. (:)
    
    8
    -    GHC.Internal.Base.thenIO (libraries/ghc-internal/src/GHC/Internal/Base.hs:2336:1-72)
    
    9
    -    GHC.Internal.IO.Handle.Text. (:)
    
    10
    -    GHC.Internal.Show. (:)
    
    11
    -    Main.x (LoopBacktrace.hs:6:1-9)
    
    12
    -    Cmm$rts/Updates.cmm. (:)
    
    13
    -    GHC.Num.Integer. (:)
    
    14
    -    Cmm$rts/HeapStackCheck.cmm. (:)
    
    15
    -    GHC.Internal.IO.throwIO (libraries/ghc-internal/src/GHC/Internal/IO.hs:285:36)
    
    16
    -    GHC.Internal.Exception.bindIO (libraries/ghc-internal/src/GHC/Internal/Base.hs:2333:1-76)
    
    17
    -    GHC.Internal.Exception.Backtrace.bindIO (libraries/ghc-internal/src/GHC/Internal/Base.hs:2333:1-76)
    
    18
    -    GHC.Internal.Exception.Backtrace.$ (libraries/ghc-internal/src/GHC/Internal/Base.hs:2267:1-9)
    
    6
    +  GHC.Internal.Exception.Backtrace.collectBacktraces' (libraries/ghc-internal/src/GHC/Internal/Exception/Backtrace.hs:(179,1)-(202,25))
    
    7
    +  GHC.Internal.Exception.Backtrace.collectBacktraces (libraries/ghc-internal/src/GHC/Internal/Exception/Backtrace.hs:174:39-56)
    
    8
    +  GHC.Internal.Exception.toExceptionWithBacktrace (libraries/ghc-internal/src/GHC/Internal/Exception.hs:(179,26)-(181,53))
    
    9
    +  GHC.Internal.IO.throwIO (libraries/ghc-internal/src/GHC/Internal/IO.hs:293:36)
    
    10
    +  Cmm$rts/HeapStackCheck.cmm. (:)
    
    11
    +  GHC.Internal.Bignum.Integer.integerAdd (libraries/ghc-internal/src/GHC/Internal/Bignum/Integer.hs:(547,1)-(571,52))
    
    12
    +  Cmm$rts/Updates.cmm. (:)
    
    13
    +  Main.x (LoopBacktrace.hs:6:1-9)
    
    14
    +  GHC.Internal.Show.show (libraries/ghc-internal/src/GHC/Internal/Show.hs:497:10-21)
    
    15
    +  GHC.Internal.IO.Handle.Text.hPutStr' (libraries/ghc-internal/src/GHC/Internal/IO/Handle/Text.hs:667:29-37)
    
    16
    +  GHC.Internal.Base.thenIO (libraries/ghc-internal/src/GHC/Internal/Base.hs:2337:1-72)
    
    17
    +  Cmm$rts/Exception.cmm. (:)
    
    18
    +  Cmm$rts/StgStartup.cmm. (:)
    
    19 19
     HasCallStack backtrace:
    
    20
    -  throwIO, called at libraries/ghc-internal/src/GHC/Internal/Control/Exception/Base.hs:446:23 in ghc-internal:GHC.Internal.Control.Exception.Base
    
    20
    +  throwIO, called at libraries/ghc-internal/src/GHC/Internal/Control/Exception/Base.hs:452:23 in ghc-internal:GHC.Internal.Control.Exception.Base
    
    21 21
     

  • testsuite/tests/rts/T2783.stderr
    1 1
     T2783: Uncaught exception ghc-internal:GHC.Internal.Control.Exception.Base.NonTermination:
    
    2 2
     
    
    3 3
     <<loop>>
    
    4
    +
    
    5
    +HasCallStack backtrace:
    
    6
    +  throwIO, called at libraries/ghc-internal/src/GHC/Internal/Control/Exception/Base.hs:452:23 in ghc-internal:GHC.Internal.Control.Exception.Base
    
    7
    +