August 2025 - ghc-commits

[Git][ghc/ghc][wip/romes/step-out-11] debugger: Re-use the last BreakpointId whole in step-out
by Rodrigo Mesquita (＠alt-romes) 01 Aug '25

01 Aug '25

Rodrigo Mesquita pushed to branch wip/romes/step-out-11 at Glasgow Haskell Compiler / GHC Commits: f5c6d98e by Rodrigo Mesquita at 2025-08-01T21:30:27+01:00 debugger: Re-use the last BreakpointId whole in step-out Previously, to come up with a location to stop at for `:stepout`, we would store the location of the last BreakpointId surrounding the continuation, as described by Note [Debugger: Stepout internal break locs]. However, re-using just the location from the last source breakpoint isn't sufficient to provide the necessary information in the break location. Specifically, it wouldn't bind any variables at that location. Really, there is no reason not to re-use the last breakpoint wholesale, and re-use all the information we had there. Step-out should behave just as if we had stopped at the call, but s.t. continuing will not re-execute the call. This commit updates the CgBreakInfo to always store a BreakpointId, be it the original one or the one we're emulating (for step-out). It makes variable bindings on :stepout work - - - - - 13 changed files: - compiler/GHC/ByteCode/Breakpoints.hs - compiler/GHC/Linker/Loader.hs - compiler/GHC/Runtime/Debugger/Breakpoints.hs - compiler/GHC/StgToByteCode.hs - ghc/GHCi/UI.hs - testsuite/tests/ghci.debugger/scripts/T26042b.script - testsuite/tests/ghci.debugger/scripts/T26042b.stdout - testsuite/tests/ghci.debugger/scripts/T26042c.stdout - testsuite/tests/ghci.debugger/scripts/T26042d2.stdout - testsuite/tests/ghci.debugger/scripts/T26042e.stdout - testsuite/tests/ghci.debugger/scripts/T26042f.script - testsuite/tests/ghci.debugger/scripts/T26042f2.stdout - testsuite/tests/ghci.debugger/scripts/T26042g.stdout Changes: ===================================== compiler/GHC/ByteCode/Breakpoints.hs ===================================== @@ -177,15 +177,17 @@ data CgBreakInfo -- necessarily the same: See Note [Breakpoint identifiers]. -- -- If there is no original tick identifier (that is, the breakpoint was - -- created during code generation), instead refer directly to the SrcSpan - -- we want to use for it. + -- created during code generation), we re-use the BreakpointId of something else. + -- It would also be reasonable to have an @Either something BreakpointId@ + -- for @cgb_tick_id@, but currently we can always re-use a source-level BreakpointId. + -- In the case of step-out, see Note [Debugger: Stepout internal break locs] } -- See Note [Syncing breakpoint info] in GHC.Runtime.Eval -- | Breakpoints created during code generation don't have a source-level tick --- location. Instead, we come up with one ourselves. -newtype InternalBreakLoc = InternalBreakLoc SrcSpan - deriving newtype (Eq, Show, NFData, Outputable) +-- location. Instead, we re-use an existing one. +newtype InternalBreakLoc = InternalBreakLoc { internalBreakLoc :: BreakpointId } + deriving newtype (Eq, NFData, Outputable) -- | Get an internal breakpoint info by 'InternalBreakpointId' getInternalBreak :: InternalBreakpointId -> InternalModBreaks -> CgBreakInfo @@ -207,36 +209,34 @@ assert_modules_match ibi_mod imbs_mod = -- | Get the source module and tick index for this breakpoint -- (as opposed to the module where this breakpoint occurs, which is in 'InternalBreakpointId') -getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> Either InternalBreakLoc BreakpointId +getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> BreakpointId getBreakSourceId (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix - in cgb_tick_id cgb + in either internalBreakLoc id (cgb_tick_id cgb) -- | Get the source module for this breakpoint (where the breakpoint is defined) getBreakSourceMod :: InternalBreakpointId -> InternalModBreaks -> Module getBreakSourceMod (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix - in case cgb_tick_id cgb of - Left InternalBreakLoc{} -> imodBreaks_module imbs - Right BreakpointId{bi_tick_mod} -> bi_tick_mod + in either (bi_tick_mod . internalBreakLoc) bi_tick_mod (cgb_tick_id cgb) -- | Get the source span for this breakpoint getBreakLoc :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO SrcSpan -getBreakLoc = getBreakXXX modBreaks_locs (\(InternalBreakLoc x) -> x) +getBreakLoc = getBreakXXX modBreaks_locs -- | Get the vars for this breakpoint getBreakVars :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [OccName] -getBreakVars = getBreakXXX modBreaks_vars (const []) +getBreakVars = getBreakXXX modBreaks_vars -- | Get the decls for this breakpoint getBreakDecls :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [String] -getBreakDecls = getBreakXXX modBreaks_decls (const []) +getBreakDecls = getBreakXXX modBreaks_decls -- | Get the decls for this breakpoint -getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO (Maybe (String, String)) -getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) +getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO ((String, String)) +getBreakCCS = getBreakXXX modBreaks_ccs -- | Internal utility to access a ModBreaks field at a particular breakpoint index -- @@ -253,12 +253,12 @@ getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) -- -- To avoid cyclic dependencies, we instead receive a function that looks up -- the 'ModBreaks' given a 'Module' -getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (InternalBreakLoc -> a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a -getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = +getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a +getBreakXXX view lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ do let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix - case cgb_tick_id cgb of - Right BreakpointId{bi_tick_mod, bi_tick_index} + case either internalBreakLoc id (cgb_tick_id cgb) of + BreakpointId{bi_tick_mod, bi_tick_index} | bi_tick_mod == ibi_mod -> do let these_mbs = imodBreaks_modBreaks imbs @@ -267,8 +267,6 @@ getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) -> do other_mbs <- lookupModule bi_tick_mod return $ view other_mbs ! bi_tick_index - Left l -> - return $ viewInternal l -------------------------------------------------------------------------------- -- Instances ===================================== compiler/GHC/Linker/Loader.hs ===================================== @@ -1712,10 +1712,8 @@ allocateCCS interp ce mbss let count = maybe 0 ((+1) . fst) $ IM.lookupMax imodBreaks_breakInfo let ccs = IM.map (\info -> - case cgb_tick_id info of - Right bi -> fromMaybe (toRemotePtr nullPtr) - (M.lookup bi ccss) - Left InternalBreakLoc{} -> toRemotePtr nullPtr + fromMaybe (toRemotePtr nullPtr) + (M.lookup (either internalBreakLoc id (cgb_tick_id info)) ccss) ) imodBreaks_breakInfo assertPpr (count == length ccs) ===================================== compiler/GHC/Runtime/Debugger/Breakpoints.hs ===================================== @@ -257,6 +257,8 @@ mkBreakpointOccurrences = do Right (BreakpointId tick_mod tick_ix) -> extendModuleEnvWith (IntMap.unionWith (S.<>)) bmp tick_mod (IntMap.singleton tick_ix [ibi]) Left _ + -- Do not include internal breakpoints in the visible breakpoint + -- occurrences! -> bmp ) bmp0 (imodBreaks_breakInfo ibrks) ===================================== compiler/GHC/StgToByteCode.hs ===================================== @@ -63,7 +63,7 @@ import GHC.StgToCmm.Closure ( NonVoid(..), fromNonVoid, idPrimRepU, assertNonVoidIds, assertNonVoidStgArgs ) import GHC.StgToCmm.Layout import GHC.Runtime.Heap.Layout hiding (WordOff, ByteOff, wordsToBytes) -import GHC.Runtime.Interpreter ( interpreterProfiled, readIModModBreaks ) +import GHC.Runtime.Interpreter ( interpreterProfiled ) import GHC.Data.Bitmap import GHC.Data.FlatBag as FlatBag import GHC.Data.OrdList @@ -99,7 +99,7 @@ import GHC.CoreToIface import Control.Monad.IO.Class import Control.Monad.Trans.Reader (ReaderT(..)) import Control.Monad.Trans.State (StateT(..)) -import Data.Array ((!)) +import Data.Bifunctor (Bifunctor(..)) -- ----------------------------------------------------------------------------- -- Generating byte code for a complete module @@ -402,11 +402,16 @@ schemeER_wrk d p (StgTick bp@(Breakpoint tick_ty tick_id fvs) rhs) = do -- See Note [Debugger: Stepout internal break locs] code <- withBreakTick bp $ schemeE d 0 p rhs - let idOffSets = getVarOffSets platform d p fvs + -- As per Note [Stack layout when entering run_BCO], the breakpoint AP_STACK + -- as we yield from the interpreter is headed by a stg_apply_interp + BCO to be a valid stack. + -- Therefore, the var offsets are offset by 2 words + let idOffSets = map (fmap (second (+2))) $ + getVarOffSets platform d p fvs ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Right tick_id) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty + (Right tick_id) mibi <- newBreakInfo breakInfo @@ -416,21 +421,15 @@ schemeER_wrk d p (StgTick bp@(Breakpoint tick_ty tick_id fvs) rhs) = do schemeER_wrk d p rhs = schemeE d 0 p rhs +-- | Get the offset in words into this breakpoint's AP_STACK which contains the matching Id getVarOffSets :: Platform -> StackDepth -> BCEnv -> [Id] -> [Maybe (Id, WordOff)] getVarOffSets platform depth env = map getOffSet where getOffSet id = case lookupBCEnv_maybe id env of - Nothing -> Nothing - Just offset -> - -- michalt: I'm not entirely sure why we need the stack - -- adjustment by 2 here. I initially thought that there's - -- something off with getIdValFromApStack (the only user of this - -- value), but it looks ok to me. My current hypothesis is that - -- this "adjustment" is needed due to stack manipulation for - -- BRK_FUN in Interpreter.c In any case, this is used only when - -- we trigger a breakpoint. - let !var_depth_ws = bytesToWords platform (depth - offset) + 2 - in Just (id, var_depth_ws) + Nothing -> Nothing + Just offset -> + let !var_depth_ws = bytesToWords platform (depth - offset) + in Just (id, var_depth_ws) fvsToEnv :: BCEnv -> CgStgRhs -> [Id] -- Takes the free variables of a right-hand side, and @@ -1141,10 +1140,17 @@ doCase d s p scrut bndr alts -- When an alt is entered, it assumes the returned value is -- on top of the itbl; see Note [Return convention for non-tuple values] -- for details. - ret_frame_size_w :: WordOff - ret_frame_size_w | ubx_tuple_frame = - if profiling then 5 else 4 - | otherwise = 2 + ctoi_frame_header_w :: WordOff + ctoi_frame_header_w + | ubx_tuple_frame = + if profiling then 5 else 4 + | otherwise = 2 + + -- The size of the ret_*_info frame header, whose frame returns the + -- value to the case continuation frame (ctoi_*_info) + ret_info_header_w :: WordOff + | ubx_tuple_frame = 3 + | otherwise = 1 -- The stack space used to save/restore the CCCS when profiling save_ccs_size_b | profiling && @@ -1319,12 +1325,10 @@ doCase d s p scrut bndr alts let -- drop the stg_ctoi_*_info header... - alt_final1 = SLIDE bndr_size ret_frame_size_w `consOL` alt_final0 + alt_final1 = SLIDE bndr_size ctoi_frame_header_w `consOL` alt_final0 -- after dropping the stg_ret_*_info header - alt_final2 - | ubx_tuple_frame = SLIDE 0 3 `consOL` alt_final1 - | otherwise = SLIDE 0 1 `consOL` alt_final1 + alt_final2 = SLIDE 0 ret_info_header_w `consOL` alt_final1 -- When entering a case continuation BCO, the stack is always headed -- by the stg_ret frame and the stg_ctoi frame that returned to it. @@ -1341,14 +1345,21 @@ doCase d s p scrut bndr alts -- continuation BCO, for step-out. -- See Note [Debugger: Stepout internal break locs] -> do - internal_tick_loc <- makeCaseInternalBreakLoc tick_id - -- same fvs available in the case expression are available in the case continuation - let idOffSets = getVarOffSets platform d p fvs + -- same fvs available in the surrounding tick are available in the case continuation + + -- The variable offsets into the yielded AP_STACK are adjusted + -- differently because a case continuation AP_STACK has the + -- additional stg_ret and stg_ctoi frame headers + -- (as per Note [Stack layout when entering run_BCO]): + let firstVarOff = ret_info_header_w+bndr_size+ctoi_frame_header_w + idOffSets = map (fmap (second (+firstVarOff))) $ + getVarOffSets platform d p fvs ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Left internal_tick_loc) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty + (Left (InternalBreakLoc tick_id)) mibi <- newBreakInfo breakInfo return $ case mibi of @@ -1361,8 +1372,8 @@ doCase d s p scrut bndr alts alt_bco_name = getName bndr alt_bco = mkProtoBCO platform add_bco_name alt_bco_name alt_final (Left alts) 0{-no arity-} bitmap_size bitmap True{-is alts-} - scrut_code <- schemeE (d + wordsToBytes platform ret_frame_size_w + save_ccs_size_b) - (d + wordsToBytes platform ret_frame_size_w + save_ccs_size_b) + scrut_code <- schemeE (d + wordsToBytes platform ctoi_frame_header_w + save_ccs_size_b) + (d + wordsToBytes platform ctoi_frame_header_w + save_ccs_size_b) p scrut if ubx_tuple_frame then do let tuple_bco = tupleBCO platform call_info args_offsets @@ -1374,25 +1385,6 @@ doCase d s p scrut bndr alts _ -> panic "schemeE(StgCase).push_alts" in return (PUSH_ALTS alt_bco scrut_rep `consOL` scrut_code) --- | Come up with an 'InternalBreakLoc' from the location of the given 'BreakpointId'. --- See also Note [Debugger: Stepout internal break locs] -makeCaseInternalBreakLoc :: BreakpointId -> BcM InternalBreakLoc -makeCaseInternalBreakLoc bid = do - hug <- hsc_HUG <$> getHscEnv - curr_mod <- getCurrentModule - mb_mod_brks <- getCurrentModBreaks - - InternalBreakLoc <$> case bid of - BreakpointId{bi_tick_mod, bi_tick_index} - | bi_tick_mod == curr_mod - , Just these_mbs <- mb_mod_brks - -> do - return $ modBreaks_locs these_mbs ! bi_tick_index - | otherwise - -> do - other_mbs <- liftIO $ readIModModBreaks hug bi_tick_mod - return $ modBreaks_locs other_mbs ! bi_tick_index - {- Note [Debugger: Stepout internal break locs] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1438,6 +1430,8 @@ always have a relevant breakpoint location: - So the source location will point to the thing you've just stepped out of + - The variables available are the same as the ones bound just before entering + - Doing :step-local from there will put you on the selected alternative (which at the source level may also be the e.g. next line in a do-block) @@ -2758,9 +2752,6 @@ newBreakInfo info = BcM $ \env st -> do getCurrentModule :: BcM Module getCurrentModule = BcM $ \env st -> return (bcm_module env, st) -getCurrentModBreaks :: BcM (Maybe ModBreaks) -getCurrentModBreaks = BcM $ \env st -> return (modBreaks env, st) - withBreakTick :: StgTickish -> BcM a -> BcM a withBreakTick bp (BcM act) = BcM $ \env st -> act env{last_bp_tick=Just bp} st ===================================== ghc/GHCi/UI.hs ===================================== @@ -1621,7 +1621,7 @@ toBreakIdAndLocation (Just inf) = do brks <- liftIO $ readIModBreaks hug inf let bi = getBreakSourceId inf brks return $ listToMaybe [ id_loc | id_loc@(_,loc) <- IntMap.assocs (breaks st), - Right (breakId loc) == bi ] + breakId loc == bi ] printStoppedAtBreakInfo :: GHC.GhcMonad m => Resume -> [Name] -> m () printStoppedAtBreakInfo res names = do ===================================== testsuite/tests/ghci.debugger/scripts/T26042b.script ===================================== @@ -7,12 +7,15 @@ main -- stepout of foo True to caller (ie bar) :stepout :list +:show bindings -- stepout of bar (to branch of foo False, where bar was called) :stepout :list +:show bindings -- stepout to right after the call to foo False in main :stepout :list +:show bindings -- done :continue ===================================== testsuite/tests/ghci.debugger/scripts/T26042b.stdout ===================================== @@ -8,7 +8,7 @@ _result :: 10 foo True i = return i ^^^^^^^^ 11 foo False _ = do -Stopped in Main., T26042b.hs:20:3-17 +Stopped in Main.bar, T26042b.hs:20:3-17 _result :: GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, @@ -17,7 +17,11 @@ _result :: 20 y <- foo True t ^^^^^^^^^^^^^^^ 21 return y -Stopped in Main., T26042b.hs:14:3-18 +_result :: + GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld + -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, + Int #) = _ +Stopped in Main.foo, T26042b.hs:14:3-18 _result :: GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, @@ -26,7 +30,11 @@ _result :: 14 n <- bar (x + y) ^^^^^^^^^^^^^^^^ 15 return n -Stopped in Main., T26042b.hs:5:3-26 +_result :: + GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld + -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, + Int #) = _ +Stopped in Main.main, T26042b.hs:5:3-26 _result :: GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, @@ -35,5 +43,9 @@ _result :: 5 a <- foo False undefined ^^^^^^^^^^^^^^^^^^^^^^^^ 6 print a +_result :: + GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld + -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, + () #) = _ 14 14 ===================================== testsuite/tests/ghci.debugger/scripts/T26042c.stdout ===================================== @@ -8,7 +8,7 @@ _result :: 10 foo True i = return i ^^^^^^^^ 11 foo False _ = do -Stopped in Main., T26042c.hs:5:3-26 +Stopped in Main.main, T26042c.hs:5:3-26 _result :: GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, ===================================== testsuite/tests/ghci.debugger/scripts/T26042d2.stdout ===================================== @@ -11,7 +11,7 @@ _result :: 12 putStrLn "hello2.2" hello2.1 hello2.2 -Stopped in Main., T26042d2.hs:6:3 +Stopped in Main.main, T26042d2.hs:6:3 _result :: GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld -> (# GHC.Internal.Prim.State# GHC.Internal.Prim.RealWorld, ===================================== testsuite/tests/ghci.debugger/scripts/T26042e.stdout ===================================== @@ -7,7 +7,7 @@ y :: [a1] -> Int = _ 11 let !z = y x ^^^^^^^^^^^^ 12 let !t = y ['b'] -Stopped in T7., T26042e.hs:18:3-17 +Stopped in T7.main, T26042e.hs:18:3-17 _result :: IO () = _ 17 main = do 18 let !(x, y) = a ===================================== testsuite/tests/ghci.debugger/scripts/T26042f.script ===================================== @@ -4,10 +4,12 @@ top :list -- out of t :stepout +:show bindings :list -- out of g :stepout :list +:show bindings -- out of f :stepout ===================================== testsuite/tests/ghci.debugger/scripts/T26042f2.stdout ===================================== @@ -8,16 +8,22 @@ x :: Int = 450 21 pure (x + 3) ^^ 22 {-# OPAQUE t #-} -Stopped in T8., T26042f.hs:14:3-14 +Stopped in T8.g, T26042f.hs:14:3-14 +_result :: Identity Int = _ +x :: Int = 225 +x :: Int = 225 _result :: Identity Int = _ 13 g x = do 14 a <- t (x*2) ^^^^^^^^^^^^ 15 n <- pure (a+a) -Stopped in T8., T26042f.hs:8:3-14 +Stopped in T8.f, T26042f.hs:8:3-14 _result :: Identity Int = _ +x :: Int = 15 7 f x = do 8 b <- g (x*x) ^^^^^^^^^^^^ 9 y <- pure (b+b) +x :: Int = 15 +_result :: Identity Int = _ 7248 ===================================== testsuite/tests/ghci.debugger/scripts/T26042g.stdout ===================================== @@ -6,7 +6,7 @@ x :: Int = 14 11 succ x = (-) (x - 2) (x + 1) ^^^^^^^^^^^^^^^^^^^ 12 -Stopped in T9., T26042g.hs:(6,3)-(8,21) +Stopped in T9.top, T26042g.hs:(6,3)-(8,21) _result :: Int = _ 5 top = do vv View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/f5c6d98e1c3d1fe2bc5370d81015cd9… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/f5c6d98e1c3d1fe2bc5370d81015cd9… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/fendor/ann-frame] Add primop to annotate the call stack with arbitrary data
by Hannes Siebenhandl (＠fendor) 01 Aug '25

01 Aug '25

Hannes Siebenhandl pushed to branch wip/fendor/ann-frame at Glasgow Haskell Compiler / GHC Commits: 42659c33 by Ben Gamari at 2025-08-01T18:39:43+02:00 Add primop to annotate the call stack with arbitrary data We introduce a new primop `annotateStack#` which allows us to push arbitrary data onto the call-stack. This allows us to extract the data later when decoding the stack, for example when an exception is thrown, showing more information to the user without having to annotate the full call-stack with `HasCallStack` constraints. A new stack frame value is introduced `AnnFrame`, which consists of nothing but a generic payload. The primop has a small wrapper API that allows users to annotate their call-stack in programs. There is a pure API and an IO-based one. The former is a little bit dubious, as it affects the evaluation of a program, so use with care. The latter is "safe", as it doesn't change the evaluation of the program. The stack annotation mechanism is similarly implemented to the `ExceptionAnnotation` and `Exception`, there is a typeclass to indicate something can be pushed onto the call-stack and all values are wrapped in the existential `SomeStackAnnotation`, which recover the type of the annotation payload. There is currently no builtin way to show the stack annotations when `Backtraces` are displayed (i.e., when showing stack traces to the user), which we will address in a follow-up MR. ------------------------- Metric Increase: ghc_experimental_so ------------------------- We increase the size of the package, so this is not unreasonable. Co-Authored-By: fendor <fendor(a)posteo.de> Co-Authored-By: Ben Gamari <bgamari.foss(a)gmail.com> - - - - - 47 changed files: - compiler/GHC/Builtin/primops.txt.pp - compiler/GHC/StgToCmm/Prim.hs - compiler/GHC/StgToJS/Prim.hs - libraries/ghc-experimental/ghc-experimental.cabal.in - + libraries/ghc-experimental/src/GHC/Stack/Annotation/Experimental.hs - libraries/ghc-heap/GHC/Exts/Heap/ClosureTypes.hs - libraries/ghc-heap/GHC/Exts/Heap/Closures.hs - libraries/ghc-heap/GHC/Exts/Stack.hs - libraries/ghc-heap/GHC/Exts/Stack/Constants.hsc - libraries/ghc-heap/GHC/Exts/Stack/Decode.hs - + libraries/ghc-heap/tests/stack-annotation/Makefile - + libraries/ghc-heap/tests/stack-annotation/TestUtils.hs - + libraries/ghc-heap/tests/stack-annotation/all.T - + libraries/ghc-heap/tests/stack-annotation/ann_frame001.hs - + libraries/ghc-heap/tests/stack-annotation/ann_frame001.stdout - + libraries/ghc-heap/tests/stack-annotation/ann_frame002.hs - + libraries/ghc-heap/tests/stack-annotation/ann_frame002.stdout - + libraries/ghc-heap/tests/stack-annotation/ann_frame003.hs - + libraries/ghc-heap/tests/stack-annotation/ann_frame003.stdout - + libraries/ghc-heap/tests/stack-annotation/ann_frame004.hs - + libraries/ghc-heap/tests/stack-annotation/ann_frame004.stdout - libraries/ghc-internal/src/GHC/Internal/ClosureTypes.hs - rts/ClosureFlags.c - rts/LdvProfile.c - rts/PrimOps.cmm - rts/Printer.c - rts/RetainerProfile.c - rts/RtsSymbols.c - rts/TraverseHeap.c - rts/include/rts/storage/ClosureTypes.h - rts/include/rts/storage/Closures.h - rts/include/stg/MiscClosures.h - rts/js/profiling.js - rts/sm/Compact.c - rts/sm/Evac.c - rts/sm/NonMovingMark.c - rts/sm/Sanity.c - rts/sm/Scav.c - testsuite/tests/interface-stability/base-exports.stdout - testsuite/tests/interface-stability/base-exports.stdout-javascript-unknown-ghcjs - testsuite/tests/interface-stability/base-exports.stdout-mingw32 - testsuite/tests/interface-stability/base-exports.stdout-ws-32 - testsuite/tests/interface-stability/ghc-experimental-exports.stdout - testsuite/tests/interface-stability/ghc-experimental-exports.stdout-mingw32 - testsuite/tests/interface-stability/ghc-prim-exports.stdout - testsuite/tests/interface-stability/ghc-prim-exports.stdout-mingw32 - utils/deriveConstants/Main.hs The diff was not included because it is too large. View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/42659c33945e0c318d6946eff651ad3… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/42659c33945e0c318d6946eff651ad3… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/fendor/ann-frame] Apply 1 suggestion(s) to 1 file(s)
by Hannes Siebenhandl (＠fendor) 01 Aug '25

01 Aug '25

Hannes Siebenhandl pushed to branch wip/fendor/ann-frame at Glasgow Haskell Compiler / GHC Commits: 1df3969f by Hannes Siebenhandl at 2025-08-01T16:39:16+00:00 Apply 1 suggestion(s) to 1 file(s) Co-authored-by: Rodrigo Mesquita <rodrigo.m.mesquita(a)gmail.com> - - - - - 1 changed file: - rts/PrimOps.cmm Changes: ===================================== rts/PrimOps.cmm ===================================== @@ -2768,9 +2768,7 @@ INFO_TABLE_RET (stg_ann_frame, ANN_FRAME, or vector registers. See Note [Frames intercepting frames]. */ /* - This frame doesn't do anything except pushing 'ann' onto the stack. - When decoding the stack, this frame can be used to enhance backtraces - with source locations, or other additional data. + This frame doesn't do anything when entered. It is only useful when decoding the stack, since this frame serves as an annotation that can be used to enhance backtraces with source locations, or other additional data. */ unwind Sp = W_[Sp + SIZEOF_StgAnnFrame]; Sp = Sp + SIZEOF_StgAnnFrame; View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/1df3969feb31ed2b62b13cf0840c44f… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/1df3969feb31ed2b62b13cf0840c44f… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/T23109] Fix specialiser
by Simon Peyton Jones (＠simonpj) 01 Aug '25

01 Aug '25

Simon Peyton Jones pushed to branch wip/T23109 at Glasgow Haskell Compiler / GHC Commits: 4fc506cb by Simon Peyton Jones at 2025-08-01T17:38:47+01:00 Fix specialiser ..needs documentation - - - - - 1 changed file: - compiler/GHC/Core/Opt/Specialise.hs Changes: ===================================== compiler/GHC/Core/Opt/Specialise.hs ===================================== @@ -1674,7 +1674,10 @@ specCalls spec_imp env existing_rules calls_for_me fn rhs return () -} - ; let env' = env { se_subst = subst'' } + ; let inner_rhs_bndrs = dropList all_call_args rhs_bndrs + env' = env { se_subst = subst'' } + (env'', inner_rhs_bndrs') = substBndrs env' inner_rhs_bndrs + all_rules = rules_acc ++ existing_rules -- all_rules: we look both in the rules_acc (generated by this invocation -- of specCalls), and in existing_rules (passed in to specCalls) @@ -1684,13 +1687,13 @@ specCalls spec_imp env existing_rules calls_for_me fn rhs then return spec_acc else do { -- Run the specialiser on the specialised RHS - (rhs_body', rhs_uds) <- specExpr env' $ - mkLams (dropList all_call_args rhs_bndrs) rhs_body + (rhs_body', rhs_uds) <- specExpr env'' rhs_body -- Add the { d1' = dx1; d2' = dx2 } usage stuff -- to the rhs_uds; see Note [Specialising Calls] - ; let (spec_uds, dumped_dbs) = dumpUDs spec_bndrs (dx_binds `consDictBinds` rhs_uds) - spec_rhs = mkLams spec_bndrs $ + ; let all_spec_bndrs = spec_bndrs ++ inner_rhs_bndrs' + (spec_uds, dumped_dbs) = dumpUDs all_spec_bndrs (dx_binds `consDictBinds` rhs_uds) + spec_rhs = mkLams all_spec_bndrs $ wrapDictBindsE dumped_dbs rhs_body' spec_fn_ty = exprType spec_rhs View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/4fc506cb5f4c355b5fe3138bae1cafb… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/4fc506cb5f4c355b5fe3138bae1cafb… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/romes/step-out-11] debugger: Re-use the last BreakpointId whole in step-out
by Rodrigo Mesquita (＠alt-romes) 01 Aug '25

01 Aug '25

Rodrigo Mesquita pushed to branch wip/romes/step-out-11 at Glasgow Haskell Compiler / GHC Commits: 41f3ee41 by Rodrigo Mesquita at 2025-08-01T16:42:28+01:00 debugger: Re-use the last BreakpointId whole in step-out Previously, to come up with a location to stop at for `:stepout`, we would store the location of the last BreakpointId surrounding the continuation, as described by Note [Debugger: Stepout internal break locs]. However, re-using just the location from the last source breakpoint isn't sufficient to provide the necessary information in the break location. Specifically, it wouldn't bind any variables at that location. Really, there is no reason not to re-use the last breakpoint wholesale, and re-use all the information we had there. Step-out should behave just as if we had stopped at the call, but s.t. continuing will not re-execute the call. This commit updates the CgBreakInfo to always store a BreakpointId, be it the original one or the one we're emulating (for step-out). More uniform and better information on break. - - - - - 5 changed files: - compiler/GHC/ByteCode/Breakpoints.hs - compiler/GHC/Linker/Loader.hs - compiler/GHC/Runtime/Debugger/Breakpoints.hs - compiler/GHC/StgToByteCode.hs - ghc/GHCi/UI.hs Changes: ===================================== compiler/GHC/ByteCode/Breakpoints.hs ===================================== @@ -167,7 +167,7 @@ data CgBreakInfo { cgb_tyvars :: ![IfaceTvBndr] -- ^ Type variables in scope at the breakpoint , cgb_vars :: ![Maybe (IfaceIdBndr, Word)] , cgb_resty :: !IfaceType - , cgb_tick_id :: !(Either InternalBreakLoc BreakpointId) + , cgb_tick_id :: !BreakpointId -- ^ This field records the original breakpoint tick identifier for this -- internal breakpoint info. It is used to convert a breakpoint -- *occurrence* index ('InternalBreakpointId') into a *definition* index @@ -177,8 +177,10 @@ data CgBreakInfo -- necessarily the same: See Note [Breakpoint identifiers]. -- -- If there is no original tick identifier (that is, the breakpoint was - -- created during code generation), instead refer directly to the SrcSpan - -- we want to use for it. + -- created during code generation), we re-use the BreakpointId of something else. + -- It would also be reasonable to have an @Either something BreakpointId@ + -- for @cgb_tick_id@, but currently we can always re-use a source-level BreakpointId. + -- In the case of step-out, see Note [Debugger: Stepout internal break locs] } -- See Note [Syncing breakpoint info] in GHC.Runtime.Eval @@ -207,7 +209,7 @@ assert_modules_match ibi_mod imbs_mod = -- | Get the source module and tick index for this breakpoint -- (as opposed to the module where this breakpoint occurs, which is in 'InternalBreakpointId') -getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> Either InternalBreakLoc BreakpointId +getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> BreakpointId getBreakSourceId (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix @@ -219,24 +221,23 @@ getBreakSourceMod (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix in case cgb_tick_id cgb of - Left InternalBreakLoc{} -> imodBreaks_module imbs - Right BreakpointId{bi_tick_mod} -> bi_tick_mod + BreakpointId{bi_tick_mod} -> bi_tick_mod -- | Get the source span for this breakpoint getBreakLoc :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO SrcSpan -getBreakLoc = getBreakXXX modBreaks_locs (\(InternalBreakLoc x) -> x) +getBreakLoc = getBreakXXX modBreaks_locs -- | Get the vars for this breakpoint getBreakVars :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [OccName] -getBreakVars = getBreakXXX modBreaks_vars (const []) +getBreakVars = getBreakXXX modBreaks_vars -- | Get the decls for this breakpoint getBreakDecls :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [String] -getBreakDecls = getBreakXXX modBreaks_decls (const []) +getBreakDecls = getBreakXXX modBreaks_decls -- | Get the decls for this breakpoint -getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO (Maybe (String, String)) -getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) +getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO ((String, String)) +getBreakCCS = getBreakXXX modBreaks_ccs -- | Internal utility to access a ModBreaks field at a particular breakpoint index -- @@ -253,12 +254,12 @@ getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) -- -- To avoid cyclic dependencies, we instead receive a function that looks up -- the 'ModBreaks' given a 'Module' -getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (InternalBreakLoc -> a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a -getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = +getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a +getBreakXXX view lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ do let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix case cgb_tick_id cgb of - Right BreakpointId{bi_tick_mod, bi_tick_index} + BreakpointId{bi_tick_mod, bi_tick_index} | bi_tick_mod == ibi_mod -> do let these_mbs = imodBreaks_modBreaks imbs @@ -267,8 +268,6 @@ getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) -> do other_mbs <- lookupModule bi_tick_mod return $ view other_mbs ! bi_tick_index - Left l -> - return $ viewInternal l -------------------------------------------------------------------------------- -- Instances ===================================== compiler/GHC/Linker/Loader.hs ===================================== @@ -1712,10 +1712,8 @@ allocateCCS interp ce mbss let count = maybe 0 ((+1) . fst) $ IM.lookupMax imodBreaks_breakInfo let ccs = IM.map (\info -> - case cgb_tick_id info of - Right bi -> fromMaybe (toRemotePtr nullPtr) - (M.lookup bi ccss) - Left InternalBreakLoc{} -> toRemotePtr nullPtr + fromMaybe (toRemotePtr nullPtr) + (M.lookup (cgb_tick_id info) ccss) ) imodBreaks_breakInfo assertPpr (count == length ccs) ===================================== compiler/GHC/Runtime/Debugger/Breakpoints.hs ===================================== @@ -254,10 +254,8 @@ mkBreakpointOccurrences = do IntMap.foldrWithKey (\info_ix cgi bmp -> do let ibi = InternalBreakpointId imod info_ix case cgb_tick_id cgi of - Right (BreakpointId tick_mod tick_ix) + BreakpointId tick_mod tick_ix -> extendModuleEnvWith (IntMap.unionWith (S.<>)) bmp tick_mod (IntMap.singleton tick_ix [ibi]) - Left _ - -> bmp ) bmp0 (imodBreaks_breakInfo ibrks) -------------------------------------------------------------------------------- ===================================== compiler/GHC/StgToByteCode.hs ===================================== @@ -63,7 +63,7 @@ import GHC.StgToCmm.Closure ( NonVoid(..), fromNonVoid, idPrimRepU, assertNonVoidIds, assertNonVoidStgArgs ) import GHC.StgToCmm.Layout import GHC.Runtime.Heap.Layout hiding (WordOff, ByteOff, wordsToBytes) -import GHC.Runtime.Interpreter ( interpreterProfiled, readIModModBreaks ) +import GHC.Runtime.Interpreter ( interpreterProfiled ) import GHC.Data.Bitmap import GHC.Data.FlatBag as FlatBag import GHC.Data.OrdList @@ -99,7 +99,6 @@ import GHC.CoreToIface import Control.Monad.IO.Class import Control.Monad.Trans.Reader (ReaderT(..)) import Control.Monad.Trans.State (StateT(..)) -import Data.Array ((!)) -- ----------------------------------------------------------------------------- -- Generating byte code for a complete module @@ -406,7 +405,7 @@ schemeER_wrk d p (StgTick bp@(Breakpoint tick_ty tick_id fvs) rhs) = do ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Right tick_id) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo @@ -1341,14 +1340,13 @@ doCase d s p scrut bndr alts -- continuation BCO, for step-out. -- See Note [Debugger: Stepout internal break locs] -> do - internal_tick_loc <- makeCaseInternalBreakLoc tick_id -- same fvs available in the case expression are available in the case continuation let idOffSets = getVarOffSets platform d p fvs ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Left internal_tick_loc) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo return $ case mibi of @@ -1374,25 +1372,6 @@ doCase d s p scrut bndr alts _ -> panic "schemeE(StgCase).push_alts" in return (PUSH_ALTS alt_bco scrut_rep `consOL` scrut_code) --- | Come up with an 'InternalBreakLoc' from the location of the given 'BreakpointId'. --- See also Note [Debugger: Stepout internal break locs] -makeCaseInternalBreakLoc :: BreakpointId -> BcM InternalBreakLoc -makeCaseInternalBreakLoc bid = do - hug <- hsc_HUG <$> getHscEnv - curr_mod <- getCurrentModule - mb_mod_brks <- getCurrentModBreaks - - InternalBreakLoc <$> case bid of - BreakpointId{bi_tick_mod, bi_tick_index} - | bi_tick_mod == curr_mod - , Just these_mbs <- mb_mod_brks - -> do - return $ modBreaks_locs these_mbs ! bi_tick_index - | otherwise - -> do - other_mbs <- liftIO $ readIModModBreaks hug bi_tick_mod - return $ modBreaks_locs other_mbs ! bi_tick_index - {- Note [Debugger: Stepout internal break locs] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1438,6 +1417,8 @@ always have a relevant breakpoint location: - So the source location will point to the thing you've just stepped out of + - The variables available are the same as the ones bound just before entering + - Doing :step-local from there will put you on the selected alternative (which at the source level may also be the e.g. next line in a do-block) @@ -2758,9 +2739,6 @@ newBreakInfo info = BcM $ \env st -> do getCurrentModule :: BcM Module getCurrentModule = BcM $ \env st -> return (bcm_module env, st) -getCurrentModBreaks :: BcM (Maybe ModBreaks) -getCurrentModBreaks = BcM $ \env st -> return (modBreaks env, st) - withBreakTick :: StgTickish -> BcM a -> BcM a withBreakTick bp (BcM act) = BcM $ \env st -> act env{last_bp_tick=Just bp} st @@ -2774,7 +2752,7 @@ tickFS = fsLit "ticked" -- Dehydrating CgBreakInfo -dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> Either InternalBreakLoc BreakpointId -> CgBreakInfo +dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> BreakpointId -> CgBreakInfo dehydrateCgBreakInfo ty_vars idOffSets tick_ty bid = CgBreakInfo { cgb_tyvars = map toIfaceTvBndr ty_vars ===================================== ghc/GHCi/UI.hs ===================================== @@ -1621,7 +1621,7 @@ toBreakIdAndLocation (Just inf) = do brks <- liftIO $ readIModBreaks hug inf let bi = getBreakSourceId inf brks return $ listToMaybe [ id_loc | id_loc@(_,loc) <- IntMap.assocs (breaks st), - Right (breakId loc) == bi ] + breakId loc == bi ] printStoppedAtBreakInfo :: GHC.GhcMonad m => Resume -> [Name] -> m () printStoppedAtBreakInfo res names = do View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/41f3ee410fa2bcb6d7febc539fec495… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/41f3ee410fa2bcb6d7febc539fec495… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/romes/26227] Drop "unlit command" from settings
by Rodrigo Mesquita (＠alt-romes) 01 Aug '25

01 Aug '25

Rodrigo Mesquita pushed to branch wip/romes/26227 at Glasgow Haskell Compiler / GHC Commits: ac859b36 by Rodrigo Mesquita at 2025-08-01T16:42:04+01:00 Drop "unlit command" from settings The `unlit` program is a binary distributed with ghc. Its location is hardcoded to a path relative to its `$topdir`. It's unnecessary and confusing to write this into a global or per-target settings file since we don't allow it to be configured (except at runtime with -pgmL). Towards #26227 - - - - - 4 changed files: - compiler/GHC/Driver/Session.hs - compiler/GHC/Settings/IO.hs - hadrian/bindist/Makefile - hadrian/src/Rules/Generate.hs Changes: ===================================== compiler/GHC/Driver/Session.hs ===================================== @@ -3502,6 +3502,7 @@ compilerInfo dflags ("target has .ident directive", queryBool tgtSupportsIdentDirective), ("target has subsections via symbols", queryBool tgtSupportsSubsectionsViaSymbols), ("target RTS linker only supports shared libraries", queryBool tgtRTSLinkerOnlySupportsSharedLibs), + ("unlit command", toolSettings_pgm_L (toolSettings dflags)), ("Unregisterised", queryBool tgtUnregisterised), ("LLVM target", query tgtLlvmTarget), ("LLVM llc command", queryCmdMaybe id tgtLlc), ===================================== compiler/GHC/Settings/IO.hs ===================================== @@ -65,9 +65,6 @@ initSettings top_dir = do Nothing -> throwE $ SettingsError_BadData $ "Can't parse as Target " ++ show targetFile let mySettings = Map.fromList settingsList - getBooleanSetting :: String -> ExceptT SettingsError m Bool - getBooleanSetting key = either pgmError pure $ - getRawBooleanSetting settingsFile mySettings key -- see Note [topdir: How GHC finds its files] -- NB: top_dir is assumed to be in standard Unix @@ -79,10 +76,7 @@ initSettings top_dir = do getRawSetting settingsFile mySettings key getSetting_topDir top key = either pgmError pure $ getRawFilePathSetting top settingsFile mySettings key - getSetting_toolDir top tool key = - expandToolDir tool <$> getSetting_topDir top key getSetting key = getSetting_topDir top_dir key - getToolSetting key = getSetting_toolDir top_dir mtool_dir key expandDirVars top tool = expandToolDir tool . expandTopDir top @@ -131,12 +125,8 @@ initSettings top_dir = do let ghc_usage_msg_path = installed "ghc-usage.txt" ghci_usage_msg_path = installed "ghci-usage.txt" - -- For all systems, unlit, split, mangle are GHC utilities - -- architecture-specific stuff is done when building Config.hs - unlit_path <- getToolSetting "unlit command" - - -- Other things being equal, 'as' is simply 'gcc' - let (cc_link, cc_link_args) = getTool (ccLinkProgram . tgtCCompilerLink) + -- Other things being equal, 'as' is simply 'gcc' + (cc_link, cc_link_args) = getTool (ccLinkProgram . tgtCCompilerLink) as_prog = cc_prog as_args = map Option cc_args ld_prog = cc_link @@ -146,6 +136,9 @@ initSettings top_dir = do let (ld_r_path, ld_r_args) = getTool (mergeObjsProgram . const ld_r_prog) pure (ld_r_path, map Option ld_r_args) iserv_prog = libexec "ghc-iserv" + unlit_prog = libexec (if (tgtLocallyExecutable target) + then "unlit" -- not a cross compiler + else targetPlatformTriple target ++ "-unlit") baseUnitId <- getSetting_raw "base unit-id" @@ -180,7 +173,7 @@ initSettings top_dir = do , toolSettings_arSupportsDashL = arSupportsDashL $ tgtAr target , toolSettings_cmmCppSupportsG0 = cmmCppSupportsG0 $ tgtCmmCPreprocessor target - , toolSettings_pgm_L = unlit_path + , toolSettings_pgm_L = unlit_prog , toolSettings_pgm_P = (hs_cpp_prog, map Option hs_cpp_args) , toolSettings_pgm_JSP = (js_cpp_prog, map Option js_cpp_args) , toolSettings_pgm_CmmP = (cmmCpp_prog, map Option cmmCpp_args) ===================================== hadrian/bindist/Makefile ===================================== @@ -85,8 +85,7 @@ WrapperBinsDir=${bindir} # N.B. this is duplicated from includes/ghc.mk. lib/settings : config.mk @rm -f $@ - @echo '[("unlit command", "$$topdir/../bin/$(CrossCompilePrefix)unlit")' >> $@ - @echo ',("RTS ways", "$(GhcRTSWays)")' >> $@ + @echo '[("RTS ways", "$(GhcRTSWays)")' >> $@ @echo ',("Relative Global Package DB", "package.conf.d")' >> $@ @echo ',("base unit-id", "$(BaseUnitId)")' >> $@ @echo "]" >> $@ ===================================== hadrian/src/Rules/Generate.hs ===================================== @@ -8,7 +8,6 @@ import Development.Shake.FilePath import Data.Char (isSpace) import qualified Data.Set as Set import Base -import qualified Context import Expression import Hadrian.Oracles.TextFile (lookupSystemConfig, getTargetTarget) import Oracles.Flag hiding (arSupportsAtFile, arSupportsDashL) @@ -460,7 +459,6 @@ ghcWrapper stage = do generateSettings :: FilePath -> Expr String generateSettings settingsFile = do - ctx <- getContext stage <- getStage package_db_path <- expr $ do @@ -482,8 +480,7 @@ generateSettings settingsFile = do let rel_pkg_db = makeRelativeNoSysLink (dropFileName settingsFile) package_db_path settings <- traverse sequence $ - [ ("unlit command", ("$topdir/../bin/" <>) <$> expr (programName (ctx { Context.package = unlit }))) - , ("RTS ways", escapeArgs . map show . Set.toList <$> getRtsWays) + [ ("RTS ways", escapeArgs . map show . Set.toList <$> getRtsWays) , ("Relative Global Package DB", pure rel_pkg_db) , ("base unit-id", pure base_unit_id) ] View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ac859b36f0b67f56ca4a09f2500c188… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ac859b36f0b67f56ca4a09f2500c188… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/romes/step-out-11] debugger: Re-use the last BreakpointId whole in step-out
by Rodrigo Mesquita (＠alt-romes) 01 Aug '25

01 Aug '25

Rodrigo Mesquita pushed to branch wip/romes/step-out-11 at Glasgow Haskell Compiler / GHC Commits: e6812855 by Rodrigo Mesquita at 2025-08-01T16:40:47+01:00 debugger: Re-use the last BreakpointId whole in step-out Previously, to come up with a location to stop at for `:stepout`, we would store the location of the last BreakpointId surrounding the continuation, as described by Note [Debugger: Stepout internal break locs]. However, re-using just the location from the last source breakpoint isn't sufficient to provide the necessary information in the break location. Specifically, it wouldn't bind any variables at that location. Really, there is no reason not to re-use the last breakpoint wholesale, and re-use all the information we had there. Step-out should behave just as if we had stopped at the call, but s.t. continuing will not re-execute the call. This commit updates the CgBreakInfo to always store a BreakpointId, be it the original one or the one we're emulating (for step-out). More uniform and better information on break. - - - - - 4 changed files: - compiler/GHC/ByteCode/Breakpoints.hs - compiler/GHC/Linker/Loader.hs - compiler/GHC/Runtime/Debugger/Breakpoints.hs - compiler/GHC/StgToByteCode.hs Changes: ===================================== compiler/GHC/ByteCode/Breakpoints.hs ===================================== @@ -167,7 +167,7 @@ data CgBreakInfo { cgb_tyvars :: ![IfaceTvBndr] -- ^ Type variables in scope at the breakpoint , cgb_vars :: ![Maybe (IfaceIdBndr, Word)] , cgb_resty :: !IfaceType - , cgb_tick_id :: !(Either InternalBreakLoc BreakpointId) + , cgb_tick_id :: !BreakpointId -- ^ This field records the original breakpoint tick identifier for this -- internal breakpoint info. It is used to convert a breakpoint -- *occurrence* index ('InternalBreakpointId') into a *definition* index @@ -177,8 +177,10 @@ data CgBreakInfo -- necessarily the same: See Note [Breakpoint identifiers]. -- -- If there is no original tick identifier (that is, the breakpoint was - -- created during code generation), instead refer directly to the SrcSpan - -- we want to use for it. + -- created during code generation), we re-use the BreakpointId of something else. + -- It would also be reasonable to have an @Either something BreakpointId@ + -- for @cgb_tick_id@, but currently we can always re-use a source-level BreakpointId. + -- In the case of step-out, see Note [Debugger: Stepout internal break locs] } -- See Note [Syncing breakpoint info] in GHC.Runtime.Eval @@ -207,7 +209,7 @@ assert_modules_match ibi_mod imbs_mod = -- | Get the source module and tick index for this breakpoint -- (as opposed to the module where this breakpoint occurs, which is in 'InternalBreakpointId') -getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> Either InternalBreakLoc BreakpointId +getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> BreakpointId getBreakSourceId (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix @@ -219,24 +221,23 @@ getBreakSourceMod (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix in case cgb_tick_id cgb of - Left InternalBreakLoc{} -> imodBreaks_module imbs - Right BreakpointId{bi_tick_mod} -> bi_tick_mod + BreakpointId{bi_tick_mod} -> bi_tick_mod -- | Get the source span for this breakpoint getBreakLoc :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO SrcSpan -getBreakLoc = getBreakXXX modBreaks_locs (\(InternalBreakLoc x) -> x) +getBreakLoc = getBreakXXX modBreaks_locs -- | Get the vars for this breakpoint getBreakVars :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [OccName] -getBreakVars = getBreakXXX modBreaks_vars (const []) +getBreakVars = getBreakXXX modBreaks_vars -- | Get the decls for this breakpoint getBreakDecls :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [String] -getBreakDecls = getBreakXXX modBreaks_decls (const []) +getBreakDecls = getBreakXXX modBreaks_decls -- | Get the decls for this breakpoint -getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO (Maybe (String, String)) -getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) +getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO ((String, String)) +getBreakCCS = getBreakXXX modBreaks_ccs -- | Internal utility to access a ModBreaks field at a particular breakpoint index -- @@ -253,12 +254,12 @@ getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) -- -- To avoid cyclic dependencies, we instead receive a function that looks up -- the 'ModBreaks' given a 'Module' -getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (InternalBreakLoc -> a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a -getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = +getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a +getBreakXXX view lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ do let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix case cgb_tick_id cgb of - Right BreakpointId{bi_tick_mod, bi_tick_index} + BreakpointId{bi_tick_mod, bi_tick_index} | bi_tick_mod == ibi_mod -> do let these_mbs = imodBreaks_modBreaks imbs @@ -267,8 +268,6 @@ getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) -> do other_mbs <- lookupModule bi_tick_mod return $ view other_mbs ! bi_tick_index - Left l -> - return $ viewInternal l -------------------------------------------------------------------------------- -- Instances ===================================== compiler/GHC/Linker/Loader.hs ===================================== @@ -1712,10 +1712,8 @@ allocateCCS interp ce mbss let count = maybe 0 ((+1) . fst) $ IM.lookupMax imodBreaks_breakInfo let ccs = IM.map (\info -> - case cgb_tick_id info of - Right bi -> fromMaybe (toRemotePtr nullPtr) - (M.lookup bi ccss) - Left InternalBreakLoc{} -> toRemotePtr nullPtr + fromMaybe (toRemotePtr nullPtr) + (M.lookup (cgb_tick_id info) ccss) ) imodBreaks_breakInfo assertPpr (count == length ccs) ===================================== compiler/GHC/Runtime/Debugger/Breakpoints.hs ===================================== @@ -254,10 +254,8 @@ mkBreakpointOccurrences = do IntMap.foldrWithKey (\info_ix cgi bmp -> do let ibi = InternalBreakpointId imod info_ix case cgb_tick_id cgi of - Right (BreakpointId tick_mod tick_ix) + BreakpointId tick_mod tick_ix -> extendModuleEnvWith (IntMap.unionWith (S.<>)) bmp tick_mod (IntMap.singleton tick_ix [ibi]) - Left _ - -> bmp ) bmp0 (imodBreaks_breakInfo ibrks) -------------------------------------------------------------------------------- ===================================== compiler/GHC/StgToByteCode.hs ===================================== @@ -63,7 +63,7 @@ import GHC.StgToCmm.Closure ( NonVoid(..), fromNonVoid, idPrimRepU, assertNonVoidIds, assertNonVoidStgArgs ) import GHC.StgToCmm.Layout import GHC.Runtime.Heap.Layout hiding (WordOff, ByteOff, wordsToBytes) -import GHC.Runtime.Interpreter ( interpreterProfiled, readIModModBreaks ) +import GHC.Runtime.Interpreter ( interpreterProfiled ) import GHC.Data.Bitmap import GHC.Data.FlatBag as FlatBag import GHC.Data.OrdList @@ -99,7 +99,6 @@ import GHC.CoreToIface import Control.Monad.IO.Class import Control.Monad.Trans.Reader (ReaderT(..)) import Control.Monad.Trans.State (StateT(..)) -import Data.Array ((!)) -- ----------------------------------------------------------------------------- -- Generating byte code for a complete module @@ -406,7 +405,7 @@ schemeER_wrk d p (StgTick bp@(Breakpoint tick_ty tick_id fvs) rhs) = do ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Right tick_id) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo @@ -1341,14 +1340,13 @@ doCase d s p scrut bndr alts -- continuation BCO, for step-out. -- See Note [Debugger: Stepout internal break locs] -> do - internal_tick_loc <- makeCaseInternalBreakLoc tick_id -- same fvs available in the case expression are available in the case continuation let idOffSets = getVarOffSets platform d p fvs ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Left internal_tick_loc) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo return $ case mibi of @@ -1374,25 +1372,6 @@ doCase d s p scrut bndr alts _ -> panic "schemeE(StgCase).push_alts" in return (PUSH_ALTS alt_bco scrut_rep `consOL` scrut_code) --- | Come up with an 'InternalBreakLoc' from the location of the given 'BreakpointId'. --- See also Note [Debugger: Stepout internal break locs] -makeCaseInternalBreakLoc :: BreakpointId -> BcM InternalBreakLoc -makeCaseInternalBreakLoc bid = do - hug <- hsc_HUG <$> getHscEnv - curr_mod <- getCurrentModule - mb_mod_brks <- getCurrentModBreaks - - InternalBreakLoc <$> case bid of - BreakpointId{bi_tick_mod, bi_tick_index} - | bi_tick_mod == curr_mod - , Just these_mbs <- mb_mod_brks - -> do - return $ modBreaks_locs these_mbs ! bi_tick_index - | otherwise - -> do - other_mbs <- liftIO $ readIModModBreaks hug bi_tick_mod - return $ modBreaks_locs other_mbs ! bi_tick_index - {- Note [Debugger: Stepout internal break locs] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1438,6 +1417,8 @@ always have a relevant breakpoint location: - So the source location will point to the thing you've just stepped out of + - The variables available are the same as the ones bound just before entering + - Doing :step-local from there will put you on the selected alternative (which at the source level may also be the e.g. next line in a do-block) @@ -2758,9 +2739,6 @@ newBreakInfo info = BcM $ \env st -> do getCurrentModule :: BcM Module getCurrentModule = BcM $ \env st -> return (bcm_module env, st) -getCurrentModBreaks :: BcM (Maybe ModBreaks) -getCurrentModBreaks = BcM $ \env st -> return (modBreaks env, st) - withBreakTick :: StgTickish -> BcM a -> BcM a withBreakTick bp (BcM act) = BcM $ \env st -> act env{last_bp_tick=Just bp} st @@ -2774,7 +2752,7 @@ tickFS = fsLit "ticked" -- Dehydrating CgBreakInfo -dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> Either InternalBreakLoc BreakpointId -> CgBreakInfo +dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> BreakpointId -> CgBreakInfo dehydrateCgBreakInfo ty_vars idOffSets tick_ty bid = CgBreakInfo { cgb_tyvars = map toIfaceTvBndr ty_vars View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/e681285538f8e3488e190b0acd4ea53… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/e681285538f8e3488e190b0acd4ea53… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/romes/step-out-11] debugger: Re-use the last BreakpointId whole in step-out
by Rodrigo Mesquita (＠alt-romes) 01 Aug '25

01 Aug '25

Rodrigo Mesquita pushed to branch wip/romes/step-out-11 at Glasgow Haskell Compiler / GHC Commits: cc885a91 by Rodrigo Mesquita at 2025-08-01T16:39:00+01:00 debugger: Re-use the last BreakpointId whole in step-out Previously, to come up with a location to stop at for `:stepout`, we would store the location of the last BreakpointId surrounding the continuation, as described by Note [Debugger: Stepout internal break locs]. However, re-using just the location from the last source breakpoint isn't sufficient to provide the necessary information in the break location. Specifically, it wouldn't bind any variables at that location. Really, there is no reason not to re-use the last breakpoint wholesale, and re-use all the information we had there. Step-out should behave just as if we had stopped at the call, but s.t. continuing will not re-execute the call. This commit updates the CgBreakInfo to always store a BreakpointId, be it the original one or the one we're emulating (for step-out). More uniform and better information on break. - - - - - 3 changed files: - compiler/GHC/ByteCode/Breakpoints.hs - compiler/GHC/Linker/Loader.hs - compiler/GHC/StgToByteCode.hs Changes: ===================================== compiler/GHC/ByteCode/Breakpoints.hs ===================================== @@ -167,7 +167,7 @@ data CgBreakInfo { cgb_tyvars :: ![IfaceTvBndr] -- ^ Type variables in scope at the breakpoint , cgb_vars :: ![Maybe (IfaceIdBndr, Word)] , cgb_resty :: !IfaceType - , cgb_tick_id :: !(Either InternalBreakLoc BreakpointId) + , cgb_tick_id :: !BreakpointId -- ^ This field records the original breakpoint tick identifier for this -- internal breakpoint info. It is used to convert a breakpoint -- *occurrence* index ('InternalBreakpointId') into a *definition* index @@ -177,8 +177,10 @@ data CgBreakInfo -- necessarily the same: See Note [Breakpoint identifiers]. -- -- If there is no original tick identifier (that is, the breakpoint was - -- created during code generation), instead refer directly to the SrcSpan - -- we want to use for it. + -- created during code generation), we re-use the BreakpointId of something else. + -- It would also be reasonable to have an @Either something BreakpointId@ + -- for @cgb_tick_id@, but currently we can always re-use a source-level BreakpointId. + -- In the case of step-out, see Note [Debugger: Stepout internal break locs] } -- See Note [Syncing breakpoint info] in GHC.Runtime.Eval @@ -207,7 +209,7 @@ assert_modules_match ibi_mod imbs_mod = -- | Get the source module and tick index for this breakpoint -- (as opposed to the module where this breakpoint occurs, which is in 'InternalBreakpointId') -getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> Either InternalBreakLoc BreakpointId +getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> BreakpointId getBreakSourceId (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix @@ -219,24 +221,23 @@ getBreakSourceMod (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix in case cgb_tick_id cgb of - Left InternalBreakLoc{} -> imodBreaks_module imbs - Right BreakpointId{bi_tick_mod} -> bi_tick_mod + BreakpointId{bi_tick_mod} -> bi_tick_mod -- | Get the source span for this breakpoint getBreakLoc :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO SrcSpan -getBreakLoc = getBreakXXX modBreaks_locs (\(InternalBreakLoc x) -> x) +getBreakLoc = getBreakXXX modBreaks_locs -- | Get the vars for this breakpoint getBreakVars :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [OccName] -getBreakVars = getBreakXXX modBreaks_vars (const []) +getBreakVars = getBreakXXX modBreaks_vars -- | Get the decls for this breakpoint getBreakDecls :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [String] -getBreakDecls = getBreakXXX modBreaks_decls (const []) +getBreakDecls = getBreakXXX modBreaks_decls -- | Get the decls for this breakpoint -getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO (Maybe (String, String)) -getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) +getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO ((String, String)) +getBreakCCS = getBreakXXX modBreaks_ccs -- | Internal utility to access a ModBreaks field at a particular breakpoint index -- @@ -253,12 +254,12 @@ getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) -- -- To avoid cyclic dependencies, we instead receive a function that looks up -- the 'ModBreaks' given a 'Module' -getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (InternalBreakLoc -> a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a -getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = +getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a +getBreakXXX view lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ do let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix case cgb_tick_id cgb of - Right BreakpointId{bi_tick_mod, bi_tick_index} + BreakpointId{bi_tick_mod, bi_tick_index} | bi_tick_mod == ibi_mod -> do let these_mbs = imodBreaks_modBreaks imbs @@ -267,8 +268,6 @@ getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) -> do other_mbs <- lookupModule bi_tick_mod return $ view other_mbs ! bi_tick_index - Left l -> - return $ viewInternal l -------------------------------------------------------------------------------- -- Instances ===================================== compiler/GHC/Linker/Loader.hs ===================================== @@ -1712,10 +1712,8 @@ allocateCCS interp ce mbss let count = maybe 0 ((+1) . fst) $ IM.lookupMax imodBreaks_breakInfo let ccs = IM.map (\info -> - case cgb_tick_id info of - Right bi -> fromMaybe (toRemotePtr nullPtr) - (M.lookup bi ccss) - Left InternalBreakLoc{} -> toRemotePtr nullPtr + fromMaybe (toRemotePtr nullPtr) + (M.lookup (cgb_tick_id info) ccss) ) imodBreaks_breakInfo assertPpr (count == length ccs) ===================================== compiler/GHC/StgToByteCode.hs ===================================== @@ -63,7 +63,7 @@ import GHC.StgToCmm.Closure ( NonVoid(..), fromNonVoid, idPrimRepU, assertNonVoidIds, assertNonVoidStgArgs ) import GHC.StgToCmm.Layout import GHC.Runtime.Heap.Layout hiding (WordOff, ByteOff, wordsToBytes) -import GHC.Runtime.Interpreter ( interpreterProfiled, readIModModBreaks ) +import GHC.Runtime.Interpreter ( interpreterProfiled ) import GHC.Data.Bitmap import GHC.Data.FlatBag as FlatBag import GHC.Data.OrdList @@ -99,7 +99,6 @@ import GHC.CoreToIface import Control.Monad.IO.Class import Control.Monad.Trans.Reader (ReaderT(..)) import Control.Monad.Trans.State (StateT(..)) -import Data.Array ((!)) -- ----------------------------------------------------------------------------- -- Generating byte code for a complete module @@ -406,7 +405,7 @@ schemeER_wrk d p (StgTick bp@(Breakpoint tick_ty tick_id fvs) rhs) = do ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Right tick_id) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo @@ -1341,14 +1340,13 @@ doCase d s p scrut bndr alts -- continuation BCO, for step-out. -- See Note [Debugger: Stepout internal break locs] -> do - internal_tick_loc <- makeCaseInternalBreakLoc tick_id -- same fvs available in the case expression are available in the case continuation let idOffSets = getVarOffSets platform d p fvs ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Left internal_tick_loc) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo return $ case mibi of @@ -1374,25 +1372,6 @@ doCase d s p scrut bndr alts _ -> panic "schemeE(StgCase).push_alts" in return (PUSH_ALTS alt_bco scrut_rep `consOL` scrut_code) --- | Come up with an 'InternalBreakLoc' from the location of the given 'BreakpointId'. --- See also Note [Debugger: Stepout internal break locs] -makeCaseInternalBreakLoc :: BreakpointId -> BcM InternalBreakLoc -makeCaseInternalBreakLoc bid = do - hug <- hsc_HUG <$> getHscEnv - curr_mod <- getCurrentModule - mb_mod_brks <- getCurrentModBreaks - - InternalBreakLoc <$> case bid of - BreakpointId{bi_tick_mod, bi_tick_index} - | bi_tick_mod == curr_mod - , Just these_mbs <- mb_mod_brks - -> do - return $ modBreaks_locs these_mbs ! bi_tick_index - | otherwise - -> do - other_mbs <- liftIO $ readIModModBreaks hug bi_tick_mod - return $ modBreaks_locs other_mbs ! bi_tick_index - {- Note [Debugger: Stepout internal break locs] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1438,6 +1417,8 @@ always have a relevant breakpoint location: - So the source location will point to the thing you've just stepped out of + - The variables available are the same as the ones bound just before entering + - Doing :step-local from there will put you on the selected alternative (which at the source level may also be the e.g. next line in a do-block) @@ -2758,9 +2739,6 @@ newBreakInfo info = BcM $ \env st -> do getCurrentModule :: BcM Module getCurrentModule = BcM $ \env st -> return (bcm_module env, st) -getCurrentModBreaks :: BcM (Maybe ModBreaks) -getCurrentModBreaks = BcM $ \env st -> return (modBreaks env, st) - withBreakTick :: StgTickish -> BcM a -> BcM a withBreakTick bp (BcM act) = BcM $ \env st -> act env{last_bp_tick=Just bp} st @@ -2774,7 +2752,7 @@ tickFS = fsLit "ticked" -- Dehydrating CgBreakInfo -dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> Either InternalBreakLoc BreakpointId -> CgBreakInfo +dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> BreakpointId -> CgBreakInfo dehydrateCgBreakInfo ty_vars idOffSets tick_ty bid = CgBreakInfo { cgb_tyvars = map toIfaceTvBndr ty_vars View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/cc885a91e712bda3d5a255c4450f06f… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/cc885a91e712bda3d5a255c4450f06f… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/romes/step-out-11] debugger: Re-use the last BreakpointId whole in step-out
by Rodrigo Mesquita (＠alt-romes) 01 Aug '25

01 Aug '25

Rodrigo Mesquita pushed to branch wip/romes/step-out-11 at Glasgow Haskell Compiler / GHC Commits: 6d265ed5 by Rodrigo Mesquita at 2025-08-01T16:34:14+01:00 debugger: Re-use the last BreakpointId whole in step-out Previously, to come up with a location to stop at for `:stepout`, we would store the location of the last BreakpointId surrounding the continuation, as described by Note [Debugger: Stepout internal break locs]. However, re-using just the location from the last source breakpoint isn't sufficient to provide the necessary information in the break location. Specifically, it wouldn't bind any variables at that location. Really, there is no reason not to re-use the last breakpoint wholesale, and re-use all the information we had there. Step-out should behave just as if we had stopped at the call, but s.t. continuing will not re-execute the call. This commit updates the CgBreakInfo to always store a BreakpointId, be it the original one or the one we're emulating (for step-out). More uniform and better information on break. - - - - - 2 changed files: - compiler/GHC/ByteCode/Breakpoints.hs - compiler/GHC/StgToByteCode.hs Changes: ===================================== compiler/GHC/ByteCode/Breakpoints.hs ===================================== @@ -167,7 +167,7 @@ data CgBreakInfo { cgb_tyvars :: ![IfaceTvBndr] -- ^ Type variables in scope at the breakpoint , cgb_vars :: ![Maybe (IfaceIdBndr, Word)] , cgb_resty :: !IfaceType - , cgb_tick_id :: !(Either InternalBreakLoc BreakpointId) + , cgb_tick_id :: !BreakpointId -- ^ This field records the original breakpoint tick identifier for this -- internal breakpoint info. It is used to convert a breakpoint -- *occurrence* index ('InternalBreakpointId') into a *definition* index @@ -177,8 +177,10 @@ data CgBreakInfo -- necessarily the same: See Note [Breakpoint identifiers]. -- -- If there is no original tick identifier (that is, the breakpoint was - -- created during code generation), instead refer directly to the SrcSpan - -- we want to use for it. + -- created during code generation), we re-use the BreakpointId of something else. + -- It would also be reasonable to have an @Either something BreakpointId@ + -- for @cgb_tick_id@, but currently we can always re-use a source-level BreakpointId. + -- In the case of step-out, see Note [Debugger: Stepout internal break locs] } -- See Note [Syncing breakpoint info] in GHC.Runtime.Eval @@ -207,7 +209,7 @@ assert_modules_match ibi_mod imbs_mod = -- | Get the source module and tick index for this breakpoint -- (as opposed to the module where this breakpoint occurs, which is in 'InternalBreakpointId') -getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> Either InternalBreakLoc BreakpointId +getBreakSourceId :: InternalBreakpointId -> InternalModBreaks -> BreakpointId getBreakSourceId (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix @@ -219,24 +221,23 @@ getBreakSourceMod (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix in case cgb_tick_id cgb of - Left InternalBreakLoc{} -> imodBreaks_module imbs - Right BreakpointId{bi_tick_mod} -> bi_tick_mod + BreakpointId{bi_tick_mod} -> bi_tick_mod -- | Get the source span for this breakpoint getBreakLoc :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO SrcSpan -getBreakLoc = getBreakXXX modBreaks_locs (\(InternalBreakLoc x) -> x) +getBreakLoc = getBreakXXX modBreaks_locs -- | Get the vars for this breakpoint getBreakVars :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [OccName] -getBreakVars = getBreakXXX modBreaks_vars (const []) +getBreakVars = getBreakXXX modBreaks_vars -- | Get the decls for this breakpoint getBreakDecls :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO [String] -getBreakDecls = getBreakXXX modBreaks_decls (const []) +getBreakDecls = getBreakXXX modBreaks_decls -- | Get the decls for this breakpoint -getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO (Maybe (String, String)) -getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) +getBreakCCS :: (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO ((String, String)) +getBreakCCS = getBreakXXX modBreaks_ccs -- | Internal utility to access a ModBreaks field at a particular breakpoint index -- @@ -253,12 +254,12 @@ getBreakCCS = getBreakXXX (fmap Just . modBreaks_ccs) (const Nothing) -- -- To avoid cyclic dependencies, we instead receive a function that looks up -- the 'ModBreaks' given a 'Module' -getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (InternalBreakLoc -> a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a -getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = +getBreakXXX :: (ModBreaks -> Array BreakTickIndex a) -> (Module -> IO ModBreaks) -> InternalBreakpointId -> InternalModBreaks -> IO a +getBreakXXX view lookupModule (InternalBreakpointId ibi_mod ibi_ix) imbs = assert_modules_match ibi_mod (imodBreaks_module imbs) $ do let cgb = imodBreaks_breakInfo imbs IM.! ibi_ix case cgb_tick_id cgb of - Right BreakpointId{bi_tick_mod, bi_tick_index} + BreakpointId{bi_tick_mod, bi_tick_index} | bi_tick_mod == ibi_mod -> do let these_mbs = imodBreaks_modBreaks imbs @@ -267,8 +268,6 @@ getBreakXXX view viewInternal lookupModule (InternalBreakpointId ibi_mod ibi_ix) -> do other_mbs <- lookupModule bi_tick_mod return $ view other_mbs ! bi_tick_index - Left l -> - return $ viewInternal l -------------------------------------------------------------------------------- -- Instances ===================================== compiler/GHC/StgToByteCode.hs ===================================== @@ -63,7 +63,7 @@ import GHC.StgToCmm.Closure ( NonVoid(..), fromNonVoid, idPrimRepU, assertNonVoidIds, assertNonVoidStgArgs ) import GHC.StgToCmm.Layout import GHC.Runtime.Heap.Layout hiding (WordOff, ByteOff, wordsToBytes) -import GHC.Runtime.Interpreter ( interpreterProfiled, readIModModBreaks ) +import GHC.Runtime.Interpreter ( interpreterProfiled ) import GHC.Data.Bitmap import GHC.Data.FlatBag as FlatBag import GHC.Data.OrdList @@ -99,7 +99,6 @@ import GHC.CoreToIface import Control.Monad.IO.Class import Control.Monad.Trans.Reader (ReaderT(..)) import Control.Monad.Trans.State (StateT(..)) -import Data.Array ((!)) -- ----------------------------------------------------------------------------- -- Generating byte code for a complete module @@ -406,7 +405,7 @@ schemeER_wrk d p (StgTick bp@(Breakpoint tick_ty tick_id fvs) rhs) = do ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Right tick_id) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo @@ -1341,14 +1340,13 @@ doCase d s p scrut bndr alts -- continuation BCO, for step-out. -- See Note [Debugger: Stepout internal break locs] -> do - internal_tick_loc <- makeCaseInternalBreakLoc tick_id -- same fvs available in the case expression are available in the case continuation let idOffSets = getVarOffSets platform d p fvs ty_vars = tyCoVarsOfTypesWellScoped (tick_ty:map idType fvs) toWord :: Maybe (Id, WordOff) -> Maybe (Id, Word) toWord = fmap (\(i, wo) -> (i, fromIntegral wo)) - breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty (Left internal_tick_loc) + breakInfo = dehydrateCgBreakInfo ty_vars (map toWord idOffSets) tick_ty tick_id mibi <- newBreakInfo breakInfo return $ case mibi of @@ -1374,25 +1372,6 @@ doCase d s p scrut bndr alts _ -> panic "schemeE(StgCase).push_alts" in return (PUSH_ALTS alt_bco scrut_rep `consOL` scrut_code) --- | Come up with an 'InternalBreakLoc' from the location of the given 'BreakpointId'. --- See also Note [Debugger: Stepout internal break locs] -makeCaseInternalBreakLoc :: BreakpointId -> BcM InternalBreakLoc -makeCaseInternalBreakLoc bid = do - hug <- hsc_HUG <$> getHscEnv - curr_mod <- getCurrentModule - mb_mod_brks <- getCurrentModBreaks - - InternalBreakLoc <$> case bid of - BreakpointId{bi_tick_mod, bi_tick_index} - | bi_tick_mod == curr_mod - , Just these_mbs <- mb_mod_brks - -> do - return $ modBreaks_locs these_mbs ! bi_tick_index - | otherwise - -> do - other_mbs <- liftIO $ readIModModBreaks hug bi_tick_mod - return $ modBreaks_locs other_mbs ! bi_tick_index - {- Note [Debugger: Stepout internal break locs] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1438,6 +1417,8 @@ always have a relevant breakpoint location: - So the source location will point to the thing you've just stepped out of + - The variables available are the same as the ones bound just before entering + - Doing :step-local from there will put you on the selected alternative (which at the source level may also be the e.g. next line in a do-block) @@ -2758,9 +2739,6 @@ newBreakInfo info = BcM $ \env st -> do getCurrentModule :: BcM Module getCurrentModule = BcM $ \env st -> return (bcm_module env, st) -getCurrentModBreaks :: BcM (Maybe ModBreaks) -getCurrentModBreaks = BcM $ \env st -> return (modBreaks env, st) - withBreakTick :: StgTickish -> BcM a -> BcM a withBreakTick bp (BcM act) = BcM $ \env st -> act env{last_bp_tick=Just bp} st @@ -2774,7 +2752,7 @@ tickFS = fsLit "ticked" -- Dehydrating CgBreakInfo -dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> Either InternalBreakLoc BreakpointId -> CgBreakInfo +dehydrateCgBreakInfo :: [TyVar] -> [Maybe (Id, Word)] -> Type -> BreakpointId -> CgBreakInfo dehydrateCgBreakInfo ty_vars idOffSets tick_ty bid = CgBreakInfo { cgb_tyvars = map toIfaceTvBndr ty_vars View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/6d265ed5d591c24e5c0689825223a0a… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/6d265ed5d591c24e5c0689825223a0a… You're receiving this email because of your account on gitlab.haskell.org.

1 0

[Git][ghc/ghc][wip/romes/26227] Drop "unlit command" from settings
by Rodrigo Mesquita (＠alt-romes) 01 Aug '25

01 Aug '25

Rodrigo Mesquita pushed to branch wip/romes/26227 at Glasgow Haskell Compiler / GHC Commits: 3150b664 by Rodrigo Mesquita at 2025-08-01T16:07:33+01:00 Drop "unlit command" from settings The `unlit` program is a binary distributed with ghc. Its location is hardcoded to a path relative to its `$topdir`. It's unnecessary and confusing to write this into a global or per-target settings file since we don't allow it to be configured (except at runtime with -pgmL). Towards #26227 - - - - - 4 changed files: - compiler/GHC/Driver/Session.hs - compiler/GHC/Settings/IO.hs - hadrian/bindist/Makefile - hadrian/src/Rules/Generate.hs Changes: ===================================== compiler/GHC/Driver/Session.hs ===================================== @@ -3502,6 +3502,7 @@ compilerInfo dflags ("target has .ident directive", queryBool tgtSupportsIdentDirective), ("target has subsections via symbols", queryBool tgtSupportsSubsectionsViaSymbols), ("target RTS linker only supports shared libraries", queryBool tgtRTSLinkerOnlySupportsSharedLibs), + ("unlit command", toolSettings_pgm_L (toolSettings dflags)), ("Unregisterised", queryBool tgtUnregisterised), ("LLVM target", query tgtLlvmTarget), ("LLVM llc command", queryCmdMaybe id tgtLlc), ===================================== compiler/GHC/Settings/IO.hs ===================================== @@ -131,12 +131,8 @@ initSettings top_dir = do let ghc_usage_msg_path = installed "ghc-usage.txt" ghci_usage_msg_path = installed "ghci-usage.txt" - -- For all systems, unlit, split, mangle are GHC utilities - -- architecture-specific stuff is done when building Config.hs - unlit_path <- getToolSetting "unlit command" - - -- Other things being equal, 'as' is simply 'gcc' - let (cc_link, cc_link_args) = getTool (ccLinkProgram . tgtCCompilerLink) + -- Other things being equal, 'as' is simply 'gcc' + (cc_link, cc_link_args) = getTool (ccLinkProgram . tgtCCompilerLink) as_prog = cc_prog as_args = map Option cc_args ld_prog = cc_link @@ -146,6 +142,9 @@ initSettings top_dir = do let (ld_r_path, ld_r_args) = getTool (mergeObjsProgram . const ld_r_prog) pure (ld_r_path, map Option ld_r_args) iserv_prog = libexec "ghc-iserv" + unlit_prog = libexec (if (tgtLocallyExecutable target) + then "unlit" -- not a cross compiler + else targetPlatformTriple target ++ "-unlit") baseUnitId <- getSetting_raw "base unit-id" @@ -180,7 +179,7 @@ initSettings top_dir = do , toolSettings_arSupportsDashL = arSupportsDashL $ tgtAr target , toolSettings_cmmCppSupportsG0 = cmmCppSupportsG0 $ tgtCmmCPreprocessor target - , toolSettings_pgm_L = unlit_path + , toolSettings_pgm_L = unlit_prog , toolSettings_pgm_P = (hs_cpp_prog, map Option hs_cpp_args) , toolSettings_pgm_JSP = (js_cpp_prog, map Option js_cpp_args) , toolSettings_pgm_CmmP = (cmmCpp_prog, map Option cmmCpp_args) ===================================== hadrian/bindist/Makefile ===================================== @@ -85,8 +85,7 @@ WrapperBinsDir=${bindir} # N.B. this is duplicated from includes/ghc.mk. lib/settings : config.mk @rm -f $@ - @echo '[("unlit command", "$$topdir/../bin/$(CrossCompilePrefix)unlit")' >> $@ - @echo ',("RTS ways", "$(GhcRTSWays)")' >> $@ + @echo '[("RTS ways", "$(GhcRTSWays)")' >> $@ @echo ',("Relative Global Package DB", "package.conf.d")' >> $@ @echo ',("base unit-id", "$(BaseUnitId)")' >> $@ @echo "]" >> $@ ===================================== hadrian/src/Rules/Generate.hs ===================================== @@ -8,7 +8,6 @@ import Development.Shake.FilePath import Data.Char (isSpace) import qualified Data.Set as Set import Base -import qualified Context import Expression import Hadrian.Oracles.TextFile (lookupSystemConfig, getTargetTarget) import Oracles.Flag hiding (arSupportsAtFile, arSupportsDashL) @@ -460,7 +459,6 @@ ghcWrapper stage = do generateSettings :: FilePath -> Expr String generateSettings settingsFile = do - ctx <- getContext stage <- getStage package_db_path <- expr $ do @@ -482,8 +480,7 @@ generateSettings settingsFile = do let rel_pkg_db = makeRelativeNoSysLink (dropFileName settingsFile) package_db_path settings <- traverse sequence $ - [ ("unlit command", ("$topdir/../bin/" <>) <$> expr (programName (ctx { Context.package = unlit }))) - , ("RTS ways", escapeArgs . map show . Set.toList <$> getRtsWays) + [ ("RTS ways", escapeArgs . map show . Set.toList <$> getRtsWays) , ("Relative Global Package DB", pure rel_pkg_db) , ("base unit-id", pure base_unit_id) ] View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/3150b6645fac3a4223e4a3fa2cb4a32… -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/3150b6645fac3a4223e4a3fa2cb4a32… You're receiving this email because of your account on gitlab.haskell.org.

1 0