compiler/profiling/SCCfinal.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[SCCfinal]{Modify and collect code generation for final STG program}
   5
   6 This is now a sort-of-normal STG-to-STG pass (WDP 94/06), run by stg2stg.
   7
   8 * Traverses the STG program collecting the cost centres. These are
   9   required to declare the cost centres at the start of code
  10   generation.
  11
  12   Note: because of cross-module unfolding, some of these cost centres
  13   may be from other modules.  But will still have to give them
  14   "extern" declarations.
  15
  16 * Puts on CAF cost-centres if the user has asked for individual CAF
  17   cost-centres.
  18
  19 * Ditto for individual DICT cost-centres.
  20
  21 * Boxes top-level inherited functions passed as arguments.
  22
  23 * "Distributes" given cost-centres to all as-yet-unmarked RHSs.
  24
  25 \begin{code}
  26 module SCCfinal ( stgMassageForProfiling ) where
  27
  28 #include "HsVersions.h"
  29
  30 import StgSyn
  31
  32 import PackageConfig    ( PackageId )
  33 import StaticFlags      ( opt_AutoSccsOnIndividualCafs )
  34 import CostCentre       -- lots of things
  35 import Id
  36 import Name
  37 import Module           ( Module )
  38 import UniqSupply       ( splitUniqSupply, UniqSupply )
  39 #ifdef PROF_DO_BOXING
  40 import UniqSupply       ( uniqFromSupply )
  41 #endif
  42 import VarSet
  43 import ListSetOps       ( removeDups )
  44 import Outputable
  45
  46 infixr 9 `thenMM`, `thenMM_`
  47 \end{code}
  48
  49 \begin{code}
  50 stgMassageForProfiling
  51         :: PackageId
  52         -> Module                       -- module name
  53         -> UniqSupply                   -- unique supply
  54         -> [StgBinding]                 -- input
  55         -> (CollectedCCs, [StgBinding])
  56
  57 stgMassageForProfiling this_pkg mod_name us stg_binds
  58   = let
  59         ((local_ccs, extern_ccs, cc_stacks),
  60          stg_binds2)
  61           = initMM mod_name us (do_top_bindings stg_binds)
  62
  63         (fixed_ccs, fixed_cc_stacks)
  64           = if opt_AutoSccsOnIndividualCafs
  65             then ([],[])  -- don't need "all CAFs" CC
  66                           -- (for Prelude, we use PreludeCC)
  67             else ([all_cafs_cc], [all_cafs_ccs])
  68
  69         local_ccs_no_dups  = fst (removeDups cmpCostCentre local_ccs)
  70         extern_ccs_no_dups = fst (removeDups cmpCostCentre extern_ccs)
  71     in
  72     ((fixed_ccs ++ local_ccs_no_dups,
  73       extern_ccs_no_dups,
  74       fixed_cc_stacks ++ cc_stacks), stg_binds2)
  75   where
  76
  77     all_cafs_cc  = mkAllCafsCC mod_name
  78     all_cafs_ccs = mkSingletonCCS all_cafs_cc
  79
  80     ----------
  81     do_top_bindings :: [StgBinding] -> MassageM [StgBinding]
  82
  83     do_top_bindings [] = returnMM []
  84
  85     do_top_bindings (StgNonRec b rhs : bs)
  86       = do_top_rhs b rhs                `thenMM` \ rhs' ->
  87         addTopLevelIshId b (
  88            do_top_bindings bs `thenMM` \bs' ->
  89            returnMM (StgNonRec b rhs' : bs')
  90         )
  91
  92     do_top_bindings (StgRec pairs : bs)
  93       = addTopLevelIshIds binders (
  94            mapMM do_pair pairs          `thenMM` \ pairs2 ->
  95            do_top_bindings bs `thenMM` \ bs' ->
  96            returnMM (StgRec pairs2 : bs')
  97         )
  98       where
  99         binders = map fst pairs
 100         do_pair (b, rhs)
 101            = do_top_rhs b rhs   `thenMM` \ rhs2 ->
 102              returnMM (b, rhs2)
 103
 104     ----------
 105     do_top_rhs :: Id -> StgRhs -> MassageM StgRhs
 106
 107     do_top_rhs binder (StgRhsClosure _ bi fv u srt [] (StgSCC cc (StgConApp con args)))
 108       | not (isSccCountCostCentre cc) && not (isDllConApp this_pkg con args)
 109         -- Trivial _scc_ around nothing but static data
 110         -- Eliminate _scc_ ... and turn into StgRhsCon
 111
 112         -- isDllConApp checks for LitLit args too
 113       = returnMM (StgRhsCon dontCareCCS con args)
 114
 115 {- Can't do this one with cost-centre stacks:  --SDM
 116     do_top_rhs binder (StgRhsClosure no_cc bi fv u [] (StgSCC ty cc expr))
 117       | (noCCSAttached no_cc || currentOrSubsumedCCS no_cc)
 118         && not (isSccCountCostCentre cc)
 119         -- Top level CAF without a cost centre attached
 120         -- Attach and collect cc of trivial _scc_ in body
 121       = collectCC cc                                    `thenMM_`
 122         set_prevailing_cc cc (do_expr expr)             `thenMM`  \ expr' ->
 123         returnMM (StgRhsClosure cc bi fv u [] expr')
 124 -}
 125
 126     do_top_rhs binder (StgRhsClosure no_cc bi fv u srt [] body)
 127       | noCCSAttached no_cc || currentOrSubsumedCCS no_cc
 128         -- Top level CAF without a cost centre attached
 129         -- Attach CAF cc (collect if individual CAF ccs)
 130       = (if opt_AutoSccsOnIndividualCafs
 131                 then let cc = mkAutoCC binder modl CafCC
 132                          ccs = mkSingletonCCS cc
 133                                 -- careful: the binder might be :Main.main,
 134                                 -- which doesn't belong to module mod_name.
 135                                 -- bug #249, tests prof001, prof002
 136                          modl | Just m <- nameModule_maybe (idName binder) = m
 137                               | otherwise = mod_name
 138                      in
 139                      collectNewCC  cc  `thenMM_`
 140                      collectCCS ccs `thenMM_`
 141                      returnMM ccs
 142                 else
 143                      returnMM all_cafs_ccs)             `thenMM`  \ caf_ccs ->
 144            set_prevailing_cc caf_ccs (do_expr body)     `thenMM`  \ body' ->
 145            returnMM (StgRhsClosure caf_ccs bi fv u srt [] body')
 146
 147     do_top_rhs binder (StgRhsClosure cc bi fv u srt [] body)
 148         -- Top level CAF with cost centre attached
 149         -- Should this be a CAF cc ??? Does this ever occur ???
 150       = pprPanic "SCCfinal: CAF with cc:" (ppr cc)
 151
 152     do_top_rhs binder (StgRhsClosure no_ccs bi fv u srt args body)
 153         -- Top level function, probably subsumed
 154       | noCCSAttached no_ccs
 155       = set_lambda_cc (do_expr body)    `thenMM` \ body' ->
 156         returnMM (StgRhsClosure subsumedCCS bi fv u srt args body')
 157
 158       | otherwise
 159       = pprPanic "SCCfinal: CAF with cc:" (ppr no_ccs)
 160
 161     do_top_rhs binder (StgRhsCon ccs con args)
 162         -- Top-level (static) data is not counted in heap
 163         -- profiles; nor do we set CCCS from it; so we
 164         -- just slam in dontCareCostCentre
 165       = returnMM (StgRhsCon dontCareCCS con args)
 166
 167     ------
 168     do_expr :: StgExpr -> MassageM StgExpr
 169
 170     do_expr (StgLit l) = returnMM (StgLit l)
 171
 172     do_expr (StgApp fn args)
 173       = boxHigherOrderArgs (StgApp fn) args
 174
 175     do_expr (StgConApp con args)
 176       = boxHigherOrderArgs (\args -> StgConApp con args) args
 177
 178     do_expr (StgOpApp con args res_ty)
 179       = boxHigherOrderArgs (\args -> StgOpApp con args res_ty) args
 180
 181     do_expr (StgSCC cc expr)    -- Ha, we found a cost centre!
 182       = collectCC cc            `thenMM_`
 183         do_expr expr            `thenMM` \ expr' ->
 184         returnMM (StgSCC cc expr')
 185
 186     do_expr (StgCase expr fv1 fv2 bndr srt alt_type alts)
 187       = do_expr expr            `thenMM` \ expr' ->
 188         mapMM do_alt alts       `thenMM` \ alts' ->
 189         returnMM (StgCase expr' fv1 fv2 bndr srt alt_type alts')
 190       where
 191         do_alt (id, bs, use_mask, e)
 192           = do_expr e `thenMM` \ e' ->
 193             returnMM (id, bs, use_mask, e')
 194
 195     do_expr (StgLet b e)
 196         = do_let b e `thenMM` \ (b,e) ->
 197           returnMM (StgLet b e)
 198
 199     do_expr (StgLetNoEscape lvs1 lvs2 b e)
 200         = do_let b e `thenMM` \ (b,e) ->
 201           returnMM (StgLetNoEscape lvs1 lvs2 b e)
 202
 203     do_expr (StgTick m n expr)
 204         = do_expr expr `thenMM` \ expr' ->
 205           returnMM (StgTick m n expr')
 206
 207 #ifdef DEBUG
 208     do_expr other = pprPanic "SCCfinal.do_expr" (ppr other)
 209 #endif
 210
 211     ----------------------------------
 212
 213     do_let (StgNonRec b rhs) e
 214       = do_rhs rhs                      `thenMM` \ rhs' ->
 215         addTopLevelIshId b (
 216           do_expr e                     `thenMM` \ e' ->
 217           returnMM (StgNonRec b rhs',e')
 218         )
 219
 220     do_let (StgRec pairs) e
 221       = addTopLevelIshIds binders (
 222            mapMM do_pair pairs          `thenMM` \ pairs' ->
 223            do_expr e                    `thenMM` \ e' ->
 224            returnMM (StgRec pairs', e')
 225         )
 226       where
 227         binders = map fst pairs
 228         do_pair (b, rhs)
 229            = do_rhs rhs                 `thenMM` \ rhs2 ->
 230              returnMM (b, rhs2)
 231
 232     ----------------------------------
 233     do_rhs :: StgRhs -> MassageM StgRhs
 234         -- We play much the same game as we did in do_top_rhs above;
 235         -- but we don't have to worry about cafs etc.
 236
 237 {-
 238     do_rhs (StgRhsClosure closure_cc bi fv u [] (StgSCC ty cc (StgCon (DataCon con) args _)))
 239       | not (isSccCountCostCentre cc)
 240       = collectCC cc `thenMM_`
 241         returnMM (StgRhsCon cc con args)
 242 -}
 243
 244     do_rhs (StgRhsClosure _ bi fv u srt args expr)
 245       = slurpSCCs currentCCS expr       `thenMM` \ (expr', ccs) ->
 246         do_expr expr'                   `thenMM` \ expr'' ->
 247         returnMM (StgRhsClosure ccs bi fv u srt args expr'')
 248       where
 249         slurpSCCs ccs (StgSCC cc e)
 250              = collectCC cc                     `thenMM_`
 251                slurpSCCs (cc `pushCCOnCCS` ccs) e
 252         slurpSCCs ccs e
 253              = returnMM (e, ccs)
 254
 255     do_rhs (StgRhsCon cc con args)
 256       = returnMM (StgRhsCon currentCCS con args)
 257 \end{code}
 258
 259 %************************************************************************
 260 %*                                                                      *
 261 \subsection{Boxing higher-order args}
 262 %*                                                                      *
 263 %************************************************************************
 264
 265 Boxing is *turned off* at the moment, until we can figure out how to
 266 do it properly in general.
 267
 268 \begin{code}
 269 boxHigherOrderArgs
 270     :: ([StgArg] -> StgExpr)
 271                         -- An application lacking its arguments
 272     -> [StgArg]         -- arguments which we might box
 273     -> MassageM StgExpr
 274
 275 #ifndef PROF_DO_BOXING
 276 boxHigherOrderArgs almost_expr args
 277    = returnMM (almost_expr args)
 278 #else
 279 boxHigherOrderArgs almost_expr args
 280   = getTopLevelIshIds           `thenMM` \ ids ->
 281     mapAccumMM (do_arg ids) [] args     `thenMM` \ (let_bindings, new_args) ->
 282     returnMM (foldr (mk_stg_let currentCCS) (almost_expr new_args) let_bindings)
 283   where
 284     ---------------
 285
 286     do_arg ids bindings arg@(StgVarArg old_var)
 287         |  (not (isLocalVar old_var) || elemVarSet old_var ids)
 288         && isFunTy (dropForAlls var_type)
 289       =     -- make a trivial let-binding for the top-level function
 290         getUniqueMM             `thenMM` \ uniq ->
 291         let
 292             new_var = mkSysLocal FSLIT("sf") uniq var_type
 293         in
 294         returnMM ( (new_var, old_var) : bindings, StgVarArg new_var )
 295       where
 296         var_type = idType old_var
 297
 298     do_arg ids bindings arg = returnMM (bindings, arg)
 299
 300     ---------------
 301     mk_stg_let :: CostCentreStack -> (Id, Id) -> StgExpr -> StgExpr
 302
 303     mk_stg_let cc (new_var, old_var) body
 304       = let
 305             rhs_body    = StgApp old_var [{-args-}]
 306             rhs_closure = StgRhsClosure cc stgArgOcc [{-fvs-}] ReEntrant NoSRT{-eeek!!!-} [{-args-}] rhs_body
 307         in
 308         StgLet (StgNonRec new_var rhs_closure) body
 309       where
 310         bOGUS_LVs = emptyUniqSet -- easier to print than: panic "mk_stg_let: LVs"
 311 #endif
 312 \end{code}
 313
 314 %************************************************************************
 315 %*                                                                      *
 316 \subsection{Boring monad stuff for this}
 317 %*                                                                      *
 318 %************************************************************************
 319
 320 \begin{code}
 321 type MassageM result
 322   =  Module             -- module name
 323   -> CostCentreStack    -- prevailing CostCentre
 324                         -- if none, subsumedCosts at top-level
 325                         -- currentCostCentre at nested levels
 326   -> UniqSupply
 327   -> VarSet             -- toplevel-ish Ids for boxing
 328   -> CollectedCCs
 329   -> (CollectedCCs, result)
 330
 331 -- the initMM function also returns the final CollectedCCs
 332
 333 initMM :: Module        -- module name, which we may consult
 334        -> UniqSupply
 335        -> MassageM a
 336        -> (CollectedCCs, a)
 337
 338 initMM mod_name init_us m = m mod_name noCCS init_us emptyVarSet ([],[],[])
 339
 340 thenMM  :: MassageM a -> (a -> MassageM b) -> MassageM b
 341 thenMM_ :: MassageM a -> (MassageM b) -> MassageM b
 342
 343 thenMM expr cont mod scope_cc us ids ccs
 344   = case splitUniqSupply us     of { (s1, s2) ->
 345     case (expr mod scope_cc s1 ids ccs) of { (ccs2, result) ->
 346     cont result mod scope_cc s2 ids ccs2 }}
 347
 348 thenMM_ expr cont mod scope_cc us ids ccs
 349   = case splitUniqSupply us     of { (s1, s2) ->
 350     case (expr mod scope_cc s1 ids ccs) of { (ccs2, _) ->
 351     cont mod scope_cc s2 ids ccs2 }}
 352
 353 returnMM :: a -> MassageM a
 354 returnMM result mod scope_cc us ids ccs = (ccs, result)
 355
 356 nopMM :: MassageM ()
 357 nopMM mod scope_cc us ids ccs = (ccs, ())
 358
 359 mapMM :: (a -> MassageM b) -> [a] -> MassageM [b]
 360 mapMM f [] = returnMM []
 361 mapMM f (m:ms)
 362   = f m         `thenMM` \ r  ->
 363     mapMM f ms  `thenMM` \ rs ->
 364     returnMM (r:rs)
 365
 366 mapAccumMM :: (acc -> x -> MassageM (acc, y)) -> acc -> [x] -> MassageM (acc, [y])
 367 mapAccumMM f b [] = returnMM (b, [])
 368 mapAccumMM f b (m:ms)
 369   = f b m               `thenMM` \ (b2, r)  ->
 370     mapAccumMM f b2 ms  `thenMM` \ (b3, rs) ->
 371     returnMM (b3, r:rs)
 372
 373 #ifdef PROF_DO_BOXING
 374 getUniqueMM :: MassageM Unique
 375 getUniqueMM mod scope_cc us ids ccs = (ccs, uniqFromSupply us)
 376 #endif
 377
 378 addTopLevelIshId :: Id -> MassageM a -> MassageM a
 379 addTopLevelIshId id scope mod scope_cc us ids ccs
 380   | isCurrentCCS scope_cc = scope mod scope_cc us ids ccs
 381   | otherwise             = scope mod scope_cc us (extendVarSet ids id) ccs
 382
 383 addTopLevelIshIds :: [Id] -> MassageM a -> MassageM a
 384 addTopLevelIshIds [] cont = cont
 385 addTopLevelIshIds (id:ids) cont
 386   = addTopLevelIshId id (addTopLevelIshIds ids cont)
 387
 388 getTopLevelIshIds :: MassageM VarSet
 389 getTopLevelIshIds mod scope_cc us ids ccs = (ccs, ids)
 390 \end{code}
 391
 392 The prevailing CCS is used to tell whether we're in a top-levelish
 393 position, where top-levelish is defined as "not inside a lambda".
 394 Prevailing CCs used to be used for something much more complicated,
 395 I'm sure --SDM
 396
 397 \begin{code}
 398 set_lambda_cc :: MassageM a -> MassageM a
 399 set_lambda_cc action mod scope_cc us ids ccs
 400   = action mod currentCCS us ids ccs
 401
 402 set_prevailing_cc :: CostCentreStack -> MassageM a -> MassageM a
 403 set_prevailing_cc cc_to_set_to action mod scope_cc us ids ccs
 404   = action mod cc_to_set_to us ids ccs
 405
 406 get_prevailing_cc :: MassageM CostCentreStack
 407 get_prevailing_cc mod scope_cc us ids ccs = (ccs, scope_cc)
 408 \end{code}
 409
 410 \begin{code}
 411 collectCC :: CostCentre -> MassageM ()
 412
 413 collectCC cc mod_name scope_cc us ids (local_ccs, extern_ccs, ccss)
 414   = ASSERT(not (noCCAttached cc))
 415     if (cc `ccFromThisModule` mod_name) then
 416         ((cc : local_ccs, extern_ccs, ccss), ())
 417     else -- must declare it "extern"
 418         ((local_ccs, cc : extern_ccs, ccss), ())
 419
 420 -- Version of collectCC used when we definitely want to declare this
 421 -- CC as local, even if its module name is not the same as the current
 422 -- module name (eg. the special :Main module) see bug #249, #1472,
 423 -- test prof001,prof002.
 424 collectNewCC :: CostCentre -> MassageM ()
 425 collectNewCC cc mod_name scope_cc us ids (local_ccs, extern_ccs, ccss)
 426   = ((cc : local_ccs, extern_ccs, ccss), ())
 427
 428 collectCCS :: CostCentreStack -> MassageM ()
 429
 430 collectCCS ccs mod_name scope_cc us ids (local_ccs, extern_ccs, ccss)
 431   = ASSERT(not (noCCSAttached ccs))
 432     ((local_ccs, extern_ccs, ccs : ccss), ())
 433 \end{code}