SCCfinal.lhs 13.9 KB
Newer Older
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
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

This is now a sort-of-normal STG-to-STG pass (WDP 94/06), run by stg2stg.

* Traverses the STG program collecting the cost centres. These are
  required to declare the cost centres at the start of code
  generation.

  Note: because of cross-module unfolding, some of these cost centres
  may be from other modules.  But will still have to give them
  "extern" declarations.

* Puts on CAF cost-centres if the user has asked for individual CAF
  cost-centres.

* Ditto for individual DICT cost-centres.

* Boxes top-level inherited functions passed as arguments.

* "Distributes" given cost-centres to all as-yet-unmarked RHSs.

\begin{code}
26
{-# OPTIONS -w #-}
27
28
29
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
Ian Lynagh's avatar
Ian Lynagh committed
30
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
31
32
-- for details

33
34
module SCCfinal ( stgMassageForProfiling ) where

35
#include "HsVersions.h"
36
37

import StgSyn
38

39
import StaticFlags	( opt_AutoSccsOnIndividualCafs )
40
import CostCentre	-- lots of things
Simon Marlow's avatar
Simon Marlow committed
41
42
import Id
import Name
43
import Module
Simon Marlow's avatar
Simon Marlow committed
44
45
46
47
import UniqSupply	( splitUniqSupply, UniqSupply )
#ifdef PROF_DO_BOXING
import UniqSupply	( uniqFromSupply )
#endif
48
import VarSet
49
import ListSetOps	( removeDups )
twanvl's avatar
twanvl committed
50
import Outputable
51
52
53
54
\end{code}

\begin{code}
stgMassageForProfiling
Simon Marlow's avatar
Simon Marlow committed
55
	:: PackageId
56
	-> Module			-- module name
57
58
	-> UniqSupply		    	-- unique supply
	-> [StgBinding]		    	-- input
59
	-> (CollectedCCs, [StgBinding])
60

Simon Marlow's avatar
Simon Marlow committed
61
stgMassageForProfiling this_pkg mod_name us stg_binds
62
  = let
63
	((local_ccs, extern_ccs, cc_stacks),
64
	 stg_binds2)
65
	  = initMM mod_name us (do_top_bindings stg_binds)
66

67
68
69
70
71
	(fixed_ccs, fixed_cc_stacks)
	  = if opt_AutoSccsOnIndividualCafs
	    then ([],[])  -- don't need "all CAFs" CC 
			  -- (for Prelude, we use PreludeCC)
	    else ([all_cafs_cc], [all_cafs_ccs])
72
73
74
75

	local_ccs_no_dups  = fst (removeDups cmpCostCentre local_ccs)
	extern_ccs_no_dups = fst (removeDups cmpCostCentre extern_ccs)
    in
76
77
78
    ((fixed_ccs ++ local_ccs_no_dups, 
      extern_ccs_no_dups, 
      fixed_cc_stacks ++ cc_stacks), stg_binds2)
79
80
  where

81
    all_cafs_cc  = mkAllCafsCC mod_name
82
    all_cafs_ccs = mkSingletonCCS all_cafs_cc
83
84

    ----------
85
    do_top_bindings :: [StgBinding] -> MassageM [StgBinding]
86

twanvl's avatar
twanvl committed
87
    do_top_bindings [] = return []
88

twanvl's avatar
twanvl committed
89
90
91
92
93
    do_top_bindings (StgNonRec b rhs : bs) = do
        rhs' <- do_top_rhs b rhs
        addTopLevelIshId b $ do
           bs' <- do_top_bindings bs
           return (StgNonRec b rhs' : bs')
94

95
    do_top_bindings (StgRec pairs : bs)
twanvl's avatar
twanvl committed
96
97
98
99
      = addTopLevelIshIds binders $ do
           pairs2 <- mapM do_pair pairs
           bs' <- do_top_bindings bs
           return (StgRec pairs2 : bs')
100
      where
twanvl's avatar
twanvl committed
101
102
103
104
        binders = map fst pairs
        do_pair (b, rhs) = do
             rhs2 <- do_top_rhs b rhs
             return (b, rhs2)
105
106

    ----------
107
    do_top_rhs :: Id -> StgRhs -> MassageM StgRhs
108

109
    do_top_rhs binder (StgRhsClosure _ bi fv u srt [] (StgSCC cc (StgConApp con args)))
Simon Marlow's avatar
Simon Marlow committed
110
      | not (isSccCountCostCentre cc) && not (isDllConApp this_pkg con args)
111
112
	-- Trivial _scc_ around nothing but static data
	-- Eliminate _scc_ ... and turn into StgRhsCon
113
114

	-- isDllConApp checks for LitLit args too
twanvl's avatar
twanvl committed
115
      = return (StgRhsCon dontCareCCS con args)
116

117
{- Can't do this one with cost-centre stacks:  --SDM
118
    do_top_rhs binder (StgRhsClosure no_cc bi fv u [] (StgSCC ty cc expr))
119
      | (noCCSAttached no_cc || currentOrSubsumedCCS no_cc)
120
121
122
        && not (isSccCountCostCentre cc)
	-- Top level CAF without a cost centre attached
	-- Attach and collect cc of trivial _scc_ in body
twanvl's avatar
twanvl committed
123
124
125
      = do collectCC cc
           expr' <- set_prevailing_cc cc (do_expr expr)
           return (StgRhsClosure cc bi fv u [] expr')
126
-}
127

128
    do_top_rhs binder (StgRhsClosure no_cc bi fv u srt [] body)
twanvl's avatar
twanvl committed
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
      | noCCSAttached no_cc || currentOrSubsumedCCS no_cc = do
        -- Top level CAF without a cost centre attached
        -- Attach CAF cc (collect if individual CAF ccs)
        caf_ccs <- if opt_AutoSccsOnIndividualCafs
                   then let cc = mkAutoCC binder modl CafCC
                            ccs = mkSingletonCCS cc
                                   -- careful: the binder might be :Main.main,
                                   -- which doesn't belong to module mod_name.
                                   -- bug #249, tests prof001, prof002
                            modl | Just m <- nameModule_maybe (idName binder) = m
                                 | otherwise = mod_name
                        in do
                        collectNewCC  cc
                        collectCCS ccs
                        return ccs
                   else
                        return all_cafs_ccs
        body' <- set_prevailing_cc caf_ccs (do_expr body)
        return (StgRhsClosure caf_ccs bi fv u srt [] body')
148

149
    do_top_rhs binder (StgRhsClosure cc bi fv u srt [] body)
150
151
	-- Top level CAF with cost centre attached
	-- Should this be a CAF cc ??? Does this ever occur ???
152
      = pprPanic "SCCfinal: CAF with cc:" (ppr cc)
153

154
    do_top_rhs binder (StgRhsClosure no_ccs bi fv u srt args body)
155
	-- Top level function, probably subsumed
156
      | noCCSAttached no_ccs
twanvl's avatar
twanvl committed
157
158
      = do body' <- set_lambda_cc (do_expr body)
           return (StgRhsClosure subsumedCCS bi fv u srt args body')
159

160
161
162
163
      | otherwise
      = pprPanic "SCCfinal: CAF with cc:" (ppr no_ccs)

    do_top_rhs binder (StgRhsCon ccs con args)
164
	-- Top-level (static) data is not counted in heap
165
	-- profiles; nor do we set CCCS from it; so we
166
	-- just slam in dontCareCostCentre
twanvl's avatar
twanvl committed
167
      = return (StgRhsCon dontCareCCS con args)
168
169

    ------
170
    do_expr :: StgExpr -> MassageM StgExpr
171

twanvl's avatar
twanvl committed
172
    do_expr (StgLit l) = return (StgLit l)
173

174
175
    do_expr (StgApp fn args)
      = boxHigherOrderArgs (StgApp fn) args
176

177
178
179
    do_expr (StgConApp con args)
      = boxHigherOrderArgs (\args -> StgConApp con args) args

180
181
    do_expr (StgOpApp con args res_ty)
      = boxHigherOrderArgs (\args -> StgOpApp con args res_ty) args
182

twanvl's avatar
twanvl committed
183
184
185
186
    do_expr (StgSCC cc expr) = do	-- Ha, we found a cost centre!
        collectCC cc
        expr' <- do_expr expr
        return (StgSCC cc expr')
187

twanvl's avatar
twanvl committed
188
189
190
191
    do_expr (StgCase expr fv1 fv2 bndr srt alt_type alts) = do
        expr' <- do_expr expr
        alts' <- mapM do_alt alts
        return (StgCase expr' fv1 fv2 bndr srt alt_type alts')
192
      where
twanvl's avatar
twanvl committed
193
194
195
        do_alt (id, bs, use_mask, e) = do
            e' <- do_expr e
            return (id, bs, use_mask, e')
196

twanvl's avatar
twanvl committed
197
198
199
    do_expr (StgLet b e) = do
          (b,e) <- do_let b e
          return (StgLet b e)
200

twanvl's avatar
twanvl committed
201
202
203
    do_expr (StgLetNoEscape lvs1 lvs2 b e) = do
          (b,e) <- do_let b e
          return (StgLetNoEscape lvs1 lvs2 b e)
204

twanvl's avatar
twanvl committed
205
206
207
    do_expr (StgTick m n expr) = do
          expr' <- do_expr expr
          return (StgTick m n expr')
andy@galois.com's avatar
andy@galois.com committed
208

209
210
211
212
#ifdef DEBUG
    do_expr other = pprPanic "SCCfinal.do_expr" (ppr other)
#endif

213
214
    ----------------------------------

twanvl's avatar
twanvl committed
215
216
217
218
219
    do_let (StgNonRec b rhs) e = do
        rhs' <- do_rhs rhs
        addTopLevelIshId b $ do
          e' <- do_expr e
          return (StgNonRec b rhs',e')
220

221
    do_let (StgRec pairs) e
twanvl's avatar
twanvl committed
222
223
224
225
      = addTopLevelIshIds binders $ do
           pairs' <- mapM do_pair pairs
           e' <- do_expr e
           return (StgRec pairs', e')
226
      where
twanvl's avatar
twanvl committed
227
228
229
230
        binders = map fst pairs
        do_pair (b, rhs) = do
             rhs2 <- do_rhs rhs
             return (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)
twanvl's avatar
twanvl committed
240
241
      = do collectCC cc
	   return (StgRhsCon cc con args)
242
-}
243

twanvl's avatar
twanvl committed
244
245
246
247
    do_rhs (StgRhsClosure _ bi fv u srt args expr) = do
        (expr', ccs) <- slurpSCCs currentCCS expr
        expr'' <- do_expr expr'
        return (StgRhsClosure ccs bi fv u srt args expr'')
248
      where
twanvl's avatar
twanvl committed
249
250
251
	slurpSCCs ccs (StgSCC cc e)
             = do collectCC cc
                  slurpSCCs (cc `pushCCOnCCS` ccs) e
252
	slurpSCCs ccs e 
twanvl's avatar
twanvl committed
253
	     = return (e, ccs)
254
255

    do_rhs (StgRhsCon cc con args)
twanvl's avatar
twanvl committed
256
      = return (StgRhsCon currentCCS con args)
257
258
259
260
261
262
263
264
\end{code}

%************************************************************************
%*									*
\subsection{Boxing higher-order args}
%*									*
%************************************************************************

265
266
267
Boxing is *turned off* at the moment, until we can figure out how to
do it properly in general.

268
269
\begin{code}
boxHigherOrderArgs
270
    :: ([StgArg] -> StgExpr)
271
			-- An application lacking its arguments
272
    -> [StgArg]		-- arguments which we might box
273
    -> MassageM StgExpr
274

275
276
#ifndef PROF_DO_BOXING
boxHigherOrderArgs almost_expr args
twanvl's avatar
twanvl committed
277
   = return (almost_expr args)
278
#else
twanvl's avatar
twanvl committed
279
280
281
282
boxHigherOrderArgs almost_expr args = do
    ids <- getTopLevelIshIds
    (let_bindings, new_args) <- mapAccumLM (do_arg ids) [] args
    return (foldr (mk_stg_let currentCCS) (almost_expr new_args) let_bindings)
283
284
285
  where
    ---------------

286
    do_arg ids bindings arg@(StgVarArg old_var)
287
	|  (not (isLocalVar old_var) || elemVarSet old_var ids)
288
	&& isFunTy (dropForAlls var_type)
twanvl's avatar
twanvl committed
289
290
      = do    -- make a trivial let-binding for the top-level function
	uniq <- getUniqueMM
291
	let
292
	    new_var = mkSysLocal FSLIT("sf") uniq var_type
twanvl's avatar
twanvl committed
293
	return ( (new_var, old_var) : bindings, StgVarArg new_var )
294
295
296
      where
	var_type = idType old_var

twanvl's avatar
twanvl committed
297
    do_arg ids bindings arg = return (bindings, arg)
298
299

    ---------------
300
    mk_stg_let :: CostCentreStack -> (Id, Id) -> StgExpr -> StgExpr
301
302
303

    mk_stg_let cc (new_var, old_var) body
      = let
304
	    rhs_body    = StgApp old_var [{-args-}]
305
	    rhs_closure = StgRhsClosure cc stgArgOcc [{-fvs-}] ReEntrant NoSRT{-eeek!!!-} [{-args-}] rhs_body
306
        in
307
	StgLet (StgNonRec new_var rhs_closure) body
308
      where
309
	bOGUS_LVs = emptyUniqSet -- easier to print than: panic "mk_stg_let: LVs"
310
#endif
311
312
313
314
315
316
317
318
319
\end{code}

%************************************************************************
%*									*
\subsection{Boring monad stuff for this}
%*									*
%************************************************************************

\begin{code}
twanvl's avatar
twanvl committed
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
newtype MassageM result
  = MassageM {
      unMassageM :: Module              -- module name
                 -> CostCentreStack     -- prevailing CostCentre
                                        -- if none, subsumedCosts at top-level
                                        -- currentCostCentre at nested levels
                 -> UniqSupply
                 -> VarSet              -- toplevel-ish Ids for boxing
                 -> CollectedCCs
                 -> (CollectedCCs, result)
    }

instance Monad MassageM where
    return x = MassageM (\_ _ _ _ ccs -> (ccs, x))
    (>>=) = thenMM
    (>>)  = thenMM_
336

337
-- the initMM function also returns the final CollectedCCs
338

339
initMM :: Module	-- module name, which we may consult
340
       -> UniqSupply
341
342
343
       -> MassageM a
       -> (CollectedCCs, a)

twanvl's avatar
twanvl committed
344
initMM mod_name init_us (MassageM m) = m mod_name noCCS init_us emptyVarSet ([],[],[])
345
346
347
348

thenMM  :: MassageM a -> (a -> MassageM b) -> MassageM b
thenMM_ :: MassageM a -> (MassageM b) -> MassageM b

twanvl's avatar
twanvl committed
349
350
351
352
thenMM expr cont = MassageM $ \mod scope_cc us ids ccs ->
    case splitUniqSupply us of { (s1, s2) ->
    case unMassageM expr mod scope_cc s1 ids ccs of { (ccs2, result) ->
    unMassageM (cont result) mod scope_cc s2 ids ccs2 }}
353

twanvl's avatar
twanvl committed
354
355
356
357
thenMM_ expr cont = MassageM $ \mod scope_cc us ids ccs ->
    case splitUniqSupply us of { (s1, s2) ->
    case unMassageM expr mod scope_cc s1 ids ccs of { (ccs2, _) ->
    unMassageM cont mod scope_cc s2 ids ccs2 }}
358

Simon Marlow's avatar
Simon Marlow committed
359
#ifdef PROF_DO_BOXING
360
getUniqueMM :: MassageM Unique
twanvl's avatar
twanvl committed
361
getUniqueMM = MassageM \mod scope_cc us ids ccs -> (ccs, uniqFromSupply us)
Simon Marlow's avatar
Simon Marlow committed
362
#endif
363

364
addTopLevelIshId :: Id -> MassageM a -> MassageM a
twanvl's avatar
twanvl committed
365
366
367
368
addTopLevelIshId id scope
   = MassageM $ \mod scope_cc us ids ccs ->
      if isCurrentCCS scope_cc then unMassageM scope mod scope_cc us ids ccs
                               else unMassageM scope mod scope_cc us (extendVarSet ids id) ccs
369

370
371
372
373
addTopLevelIshIds :: [Id] -> MassageM a -> MassageM a
addTopLevelIshIds [] cont = cont
addTopLevelIshIds (id:ids) cont 
  = addTopLevelIshId id (addTopLevelIshIds ids cont)
374

375
getTopLevelIshIds :: MassageM VarSet
twanvl's avatar
twanvl committed
376
getTopLevelIshIds = MassageM $ \mod scope_cc us ids ccs -> (ccs, ids)
377
378
379
380
381
382
\end{code}

The prevailing CCS is used to tell whether we're in a top-levelish
position, where top-levelish is defined as "not inside a lambda".
Prevailing CCs used to be used for something much more complicated,
I'm sure --SDM
383

384
\begin{code}
385
set_lambda_cc :: MassageM a -> MassageM a
twanvl's avatar
twanvl committed
386
387
388
set_lambda_cc action
   =    MassageM $     \mod scope_cc   us ids ccs
   -> unMassageM action mod currentCCS us ids ccs
389

390
set_prevailing_cc :: CostCentreStack -> MassageM a -> MassageM a
twanvl's avatar
twanvl committed
391
392
393
set_prevailing_cc cc_to_set_to action
   =    MassageM $     \mod scope_cc     us ids ccs
   -> unMassageM action mod cc_to_set_to us ids ccs
394

395
get_prevailing_cc :: MassageM CostCentreStack
twanvl's avatar
twanvl committed
396
get_prevailing_cc = MassageM $ \mod scope_cc us ids ccs -> (ccs, scope_cc)
397
398
399
400
\end{code}

\begin{code}
collectCC :: CostCentre -> MassageM ()
twanvl's avatar
twanvl committed
401
402
403
collectCC cc = MassageM $ \mod_name scope_cc us ids (local_ccs, extern_ccs, ccss)
  -> ASSERT(not (noCCAttached cc))
     if (cc `ccFromThisModule` mod_name) then
404
	((cc : local_ccs, extern_ccs, ccss), ())
twanvl's avatar
twanvl committed
405
     else -- must declare it "extern"
406
407
	((local_ccs, cc : extern_ccs, ccss), ())

408
409
410
411
412
-- Version of collectCC used when we definitely want to declare this
-- CC as local, even if its module name is not the same as the current
-- module name (eg. the special :Main module) see bug #249, #1472, 
-- test prof001,prof002.
collectNewCC :: CostCentre -> MassageM ()
twanvl's avatar
twanvl committed
413
414
collectNewCC cc = MassageM $ \mod_name scope_cc us ids (local_ccs, extern_ccs, ccss)
  -> ((cc : local_ccs, extern_ccs, ccss), ())
415

416
417
collectCCS :: CostCentreStack -> MassageM ()

twanvl's avatar
twanvl committed
418
419
420
collectCCS ccs = MassageM $ \mod_name scope_cc us ids (local_ccs, extern_ccs, ccss)
  -> ASSERT(not (noCCSAttached ccs))
     ((local_ccs, extern_ccs, ccs : ccss), ())
421
\end{code}