SCCfinal.lhs 13.2 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
26
27

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}
module SCCfinal ( stgMassageForProfiling ) where

28
#include "HsVersions.h"
29
30

import StgSyn
31

Simon Marlow's avatar
Simon Marlow committed
32
import PackageConfig	( PackageId )
33
import StaticFlags	( opt_AutoSccsOnIndividualCafs )
34
import CostCentre	-- lots of things
Simon Marlow's avatar
Simon Marlow committed
35
36
import Id
import Name
sof's avatar
sof committed
37
import Module		( Module )
Simon Marlow's avatar
Simon Marlow committed
38
39
40
41
import UniqSupply	( splitUniqSupply, UniqSupply )
#ifdef PROF_DO_BOXING
import UniqSupply	( uniqFromSupply )
#endif
42
import VarSet
43
import ListSetOps	( removeDups )
sof's avatar
sof committed
44
import Outputable	
45
46
47
48
49
50

infixr 9 `thenMM`, `thenMM_`
\end{code}

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

Simon Marlow's avatar
Simon Marlow committed
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
64
65
66
67
	(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])
68
69
70
71

	local_ccs_no_dups  = fst (removeDups cmpCostCentre local_ccs)
	extern_ccs_no_dups = fst (removeDups cmpCostCentre extern_ccs)
    in
72
73
74
    ((fixed_ccs ++ local_ccs_no_dups, 
      extern_ccs_no_dups, 
      fixed_cc_stacks ++ cc_stacks), stg_binds2)
75
76
  where

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
87
88
      = do_top_rhs b rhs 		`thenMM` \ rhs' ->
	addTopLevelIshId b (
	   do_top_bindings bs `thenMM` \bs' ->
89
	   returnMM (StgNonRec b rhs' : bs')
90
91
	)

92
    do_top_bindings (StgRec pairs : bs)
93
94
95
      = addTopLevelIshIds binders (
	   mapMM do_pair pairs		`thenMM` \ pairs2 ->
	   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
102
103
104
	   = do_top_rhs b rhs	`thenMM` \ rhs2 ->
	     returnMM (b, rhs2)

    ----------
105
    do_top_rhs :: Id -> StgRhs -> MassageM StgRhs
106

107
    do_top_rhs binder (StgRhsClosure _ bi fv u srt [] (StgSCC cc (StgConApp con args)))
Simon Marlow's avatar
Simon Marlow committed
108
      | not (isSccCountCostCentre cc) && not (isDllConApp this_pkg con args)
109
110
	-- Trivial _scc_ around nothing but static data
	-- 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
119
120
121
122
        && not (isSccCountCostCentre cc)
	-- Top level CAF without a cost centre attached
	-- Attach and collect cc of trivial _scc_ in body
      = collectCC cc					`thenMM_`
	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
129
	-- Top level CAF without a cost centre attached
	-- Attach CAF cc (collect if individual CAF ccs)
130
      = (if opt_AutoSccsOnIndividualCafs 
Simon Marlow's avatar
Simon Marlow committed
131
		then let cc = mkAutoCC binder modl CafCC
132
			 ccs = mkSingletonCCS cc
Simon Marlow's avatar
Simon Marlow committed
133
134
135
136
137
                                -- 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
138
139
140
141
142
143
		     in
		     collectCC  cc  `thenMM_`
		     collectCCS ccs `thenMM_`
		     returnMM ccs
		else 
		     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
149
	-- Top level CAF with cost centre attached
	-- 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
159
160
161
      | otherwise
      = pprPanic "SCCfinal: CAF with cc:" (ppr no_ccs)

    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
171
    do_expr (StgLit l) = returnMM (StgLit l)

172
173
    do_expr (StgApp fn args)
      = boxHigherOrderArgs (StgApp fn) args
174

175
176
177
    do_expr (StgConApp con args)
      = boxHigherOrderArgs (\args -> StgConApp con args) args

178
179
    do_expr (StgOpApp con args res_ty)
      = boxHigherOrderArgs (\args -> StgOpApp con args res_ty) args
180

181
    do_expr (StgSCC cc expr)	-- Ha, we found a cost centre!
182
183
      = collectCC cc		`thenMM_`
	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
189
	mapMM do_alt alts 	`thenMM` \ alts' ->
	returnMM (StgCase expr' fv1 fv2 bndr srt alt_type alts')
190
      where
191
192
193
	do_alt (id, bs, use_mask, e)
	  = do_expr e `thenMM` \ e' ->
	    returnMM (id, bs, use_mask, e')
194
195

    do_expr (StgLet b e)
196
197
198
199
200
201
202
	= do_let b e `thenMM` \ (b,e) ->
	  returnMM (StgLet b e)

    do_expr (StgLetNoEscape lvs1 lvs2 b e)
	= do_let b e `thenMM` \ (b,e) ->
	  returnMM (StgLetNoEscape lvs1 lvs2 b e)

andy@galois.com's avatar
andy@galois.com committed
203
204
205
206
    do_expr (StgTick m n expr) 
        = do_expr expr `thenMM` \ expr' ->
          returnMM (StgTick m n expr')

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

211
212
    ----------------------------------

213
    do_let (StgNonRec b rhs) e
214
215
216
      = do_rhs rhs		 	`thenMM` \ rhs' ->
	addTopLevelIshId b (
	  do_expr e		  	`thenMM` \ e' ->
217
	  returnMM (StgNonRec b rhs',e')
218
219
        )

220
    do_let (StgRec pairs) e
221
222
223
      = addTopLevelIshIds binders (
	   mapMM do_pair pairs	 	`thenMM` \ pairs' ->
	   do_expr e		  	`thenMM` \ e' ->
224
	   returnMM (StgRec pairs', e')
225
	)
226
      where
227
228
229
230
	binders = map fst pairs
	do_pair (b, rhs) 
	   = do_rhs rhs			`thenMM` \ rhs2 ->
	     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
241
      = collectCC cc `thenMM_`
	returnMM (StgRhsCon cc con args)
242
-}
243

244
    do_rhs (StgRhsClosure _ bi fv u srt args expr)
245
246
      = slurpSCCs currentCCS expr	`thenMM` \ (expr', ccs) ->
	do_expr expr'			`thenMM` \ expr'' ->
247
	returnMM (StgRhsClosure ccs bi fv u srt args expr'')
248
249
250
      where
	slurpSCCs ccs (StgSCC cc e) 
	     = collectCC cc 			`thenMM_`
251
	       slurpSCCs (cc `pushCCOnCCS` ccs) e
252
253
	slurpSCCs ccs e 
	     = returnMM (e, ccs)
254
255

    do_rhs (StgRhsCon cc con args)
256
      = returnMM (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
277
278
#ifndef PROF_DO_BOXING
boxHigherOrderArgs almost_expr args
   = returnMM (almost_expr args)
#else
279
boxHigherOrderArgs almost_expr args
280
281
282
  = getTopLevelIshIds		`thenMM` \ ids ->
    mapAccumMM (do_arg ids) [] args	`thenMM` \ (let_bindings, new_args) ->
    returnMM (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)
289
290
291
      =     -- make a trivial let-binding for the top-level function
	getUniqueMM		`thenMM` \ uniq ->
	let
292
	    new_var = mkSysLocal FSLIT("sf") uniq var_type
293
	in
294
295
296
297
298
	returnMM ( (new_var, old_var) : bindings, StgVarArg new_var )
      where
	var_type = idType old_var

    do_arg ids bindings arg = returnMM (bindings, arg)
299
300

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

    mk_stg_let cc (new_var, old_var) body
      = 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
313
314
315
316
317
318
319
320
321
\end{code}

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

\begin{code}
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
329
330
  -> CollectedCCs
  -> (CollectedCCs, result)

331
-- the initMM function also returns the final CollectedCCs
332

333
initMM :: Module	-- module name, which we may consult
334
       -> UniqSupply
335
336
337
       -> MassageM a
       -> (CollectedCCs, a)

338
initMM mod_name init_us m = m mod_name noCCS init_us emptyVarSet ([],[],[])
339
340
341
342

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

343
thenMM expr cont mod scope_cc us ids ccs
344
  = case splitUniqSupply us	of { (s1, s2) ->
345
346
    case (expr mod scope_cc s1 ids ccs) of { (ccs2, result) ->
    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
351
    case (expr mod scope_cc s1 ids ccs)	of { (ccs2, _) ->
    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
360
361
362
363
364
365
366
367
368
369
370
371
372

mapMM :: (a -> MassageM b) -> [a] -> MassageM [b]
mapMM f [] = returnMM []
mapMM f (m:ms)
  = f m		`thenMM` \ r  ->
    mapMM f ms	`thenMM` \ rs ->
    returnMM (r:rs)

mapAccumMM :: (acc -> x -> MassageM (acc, y)) -> acc -> [x] -> MassageM (acc, [y])
mapAccumMM f b [] = returnMM (b, [])
mapAccumMM f b (m:ms)
  = f b m		`thenMM` \ (b2, r)  ->
    mapAccumMM f b2 ms	`thenMM` \ (b3, rs) ->
    returnMM (b3, r:rs)

Simon Marlow's avatar
Simon Marlow committed
373
#ifdef PROF_DO_BOXING
374
getUniqueMM :: MassageM Unique
375
getUniqueMM mod scope_cc us ids ccs = (ccs, uniqFromSupply us)
Simon Marlow's avatar
Simon Marlow committed
376
#endif
377

378
379
380
381
addTopLevelIshId :: Id -> MassageM a -> MassageM a
addTopLevelIshId id scope mod scope_cc us ids ccs
  | isCurrentCCS scope_cc = scope mod scope_cc us ids ccs
  | otherwise             = scope mod scope_cc us (extendVarSet ids id) ccs
382

383
384
385
386
addTopLevelIshIds :: [Id] -> MassageM a -> MassageM a
addTopLevelIshIds [] cont = cont
addTopLevelIshIds (id:ids) cont 
  = addTopLevelIshId id (addTopLevelIshIds ids cont)
387

388
389
390
391
392
393
394
395
getTopLevelIshIds :: MassageM VarSet
getTopLevelIshIds mod scope_cc us ids ccs = (ccs, ids)
\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
396

397
\begin{code}
398
set_lambda_cc :: MassageM a -> MassageM a
399
400
set_lambda_cc action mod scope_cc us ids ccs
  = action mod currentCCS us ids ccs
401

402
403
404
set_prevailing_cc :: CostCentreStack -> MassageM a -> MassageM a
set_prevailing_cc cc_to_set_to action mod scope_cc us ids ccs
  = 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
409
410
411
412
\end{code}

\begin{code}
collectCC :: CostCentre -> MassageM ()

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
419
420
421
	((local_ccs, cc : extern_ccs, ccss), ())

collectCCS :: CostCentreStack -> MassageM ()

422
collectCCS ccs mod_name scope_cc us ids (local_ccs, extern_ccs, ccss)
423
424
  = ASSERT(not (noCCSAttached ccs))
    ((local_ccs, extern_ccs, ccs : ccss), ())
425
\end{code}