2 % (c) The GRASP/AQUA Project, Glasgow University, 1998
5 Run through the STG code and compute the Static Reference Table for
6 each let-binding. At the same time, we figure out which top-level
7 bindings have no CAF references, and record the fact in their IdInfo.
10 {-# OPTIONS -fno-warn-incomplete-patterns #-}
11 -- The above warning supression flag is a temporary kludge.
12 -- While working on this module you are encouraged to remove it and fix
13 -- any warnings in the module. See
14 -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
17 module SRT( computeSRTs ) where
19 #include "HsVersions.h"
25 import Maybes ( orElse, expectJust )
34 computeSRTs :: [StgBinding] -> [(StgBinding,[(Id,[Id])])]
35 -- The incoming bindingd are filled with SRTEntries in their SRT slots
36 -- the outgoing ones have NoSRT/SRT values instead
38 computeSRTs binds = srtTopBinds emptyVarEnv binds
40 -- --------------------------------------------------------------------------
43 srtTopBinds :: IdEnv Id -> [StgBinding] -> [(StgBinding, [(Id,[Id])])]
46 srtTopBinds env (StgNonRec b rhs : binds) =
47 (StgNonRec b rhs', [(b,srt')]) : srtTopBinds env' binds
49 (rhs', srt) = srtTopRhs b rhs
50 env' = maybeExtendEnv env b rhs
51 srt' = applyEnvList env srt
52 srtTopBinds env (StgRec bs : binds) =
53 (StgRec (zip bndrs rhss), zip bndrs srts') : srtTopBinds env binds
55 (rhss, srts) = unzip [ srtTopRhs b r | (b,r) <- bs ]
57 srts' = map (applyEnvList env) srts
59 -- Shorting out indirections in SRTs: if a binding has an SRT with a single
60 -- element in it, we just inline it with that element everywhere it occurs
63 -- This is in a way a generalisation of the CafInfo. CafInfo says
64 -- whether a top-level binding has *zero* CAF references, allowing us
65 -- to omit it from SRTs. Here, we pick up bindings with *one* CAF
66 -- reference, and inline its SRT everywhere it occurs. We could pass
67 -- this information across module boundaries too, but we currently
70 maybeExtendEnv ::IdEnv Id -> Id -> StgRhs -> IdEnv Id
71 maybeExtendEnv env bndr (StgRhsClosure _ _ _ ReEntrant (SRTEntries cafs) _ _)
72 | [one] <- varSetElems cafs
73 = extendVarEnv env bndr (applyEnv env one)
74 maybeExtendEnv env _ _ = env
76 applyEnvList :: IdEnv Id -> [Id] -> [Id]
77 applyEnvList env = map (applyEnv env)
79 applyEnv :: IdEnv Id -> Id -> Id
80 applyEnv env id = lookupVarEnv env id `orElse` id
82 -- ---- Top-level right hand sides:
84 srtTopRhs :: Id -> StgRhs -> (StgRhs, [Id])
86 srtTopRhs _ rhs@(StgRhsCon _ _ _) = (rhs, [])
87 srtTopRhs _ rhs@(StgRhsClosure _ _ _ _ (SRTEntries cafs) _ _)
88 = (srtRhs table rhs, elems)
90 elems = varSetElems cafs
91 table = mkVarEnv (zip elems [0..])
95 srtBind :: IdEnv Int -> StgBinding -> StgBinding
97 srtBind table (StgNonRec binder rhs) = StgNonRec binder (srtRhs table rhs)
98 srtBind table (StgRec pairs) = StgRec [ (b, srtRhs table r) | (b,r) <- pairs ]
100 -- ---- Right Hand Sides:
102 srtRhs :: IdEnv Int -> StgRhs -> StgRhs
104 srtRhs _ e@(StgRhsCon _ _ _) = e
105 srtRhs table (StgRhsClosure cc bi free_vars u srt args body)
106 = StgRhsClosure cc bi free_vars u (constructSRT table srt) args
107 $! (srtExpr table body)
109 -- ---------------------------------------------------------------------------
112 srtExpr :: IdEnv Int -> StgExpr -> StgExpr
114 srtExpr _ e@(StgApp _ _) = e
115 srtExpr _ e@(StgLit _) = e
116 srtExpr _ e@(StgConApp _ _) = e
117 srtExpr _ e@(StgOpApp _ _ _) = e
119 srtExpr table (StgSCC cc expr) = StgSCC cc $! srtExpr table expr
121 srtExpr table (StgTick m n expr) = StgTick m n $! srtExpr table expr
123 srtExpr table (StgCase scrut live1 live2 uniq srt alt_type alts)
124 = StgCase expr' live1 live2 uniq srt' alt_type alts'
126 expr' = srtExpr table scrut
127 srt' = constructSRT table srt
128 alts' = map (srtAlt table) alts
130 srtExpr table (StgLet bind body)
131 = srtBind table bind =: \ bind' ->
132 srtExpr table body =: \ body' ->
135 srtExpr table (StgLetNoEscape live1 live2 bind body)
136 = srtBind table bind =: \ bind' ->
137 srtExpr table body =: \ body' ->
138 StgLetNoEscape live1 live2 bind' body'
140 srtExpr _table expr = pprPanic "srtExpr" (ppr expr)
142 srtAlt :: IdEnv Int -> StgAlt -> StgAlt
143 srtAlt table (con,args,used,rhs)
144 = (,,,) con args used $! srtExpr table rhs
146 -----------------------------------------------------------------------------
147 -- Construct an SRT bitmap.
149 constructSRT :: IdEnv Int -> SRT -> SRT
150 constructSRT table (SRTEntries entries)
151 | isEmptyVarSet entries = NoSRT
152 | otherwise = seqBitmap bitmap $ SRT offset len bitmap
154 ints = map (expectJust "constructSRT" . lookupVarEnv table)
155 (varSetElems entries)
156 sorted_ints = sortLe (<=) ints
157 offset = head sorted_ints
158 bitmap_entries = map (subtract offset) sorted_ints
159 len = last bitmap_entries + 1
160 bitmap = intsToBitmap len bitmap_entries
162 -- ---------------------------------------------------------------------------
165 (=:) :: a -> (a -> b) -> b