CmmBuildInfoTables.hs 12.2 KB
Newer Older
1
{-# LANGUAGE GADTs, NoMonoLocalBinds #-}
Ian Lynagh's avatar
Ian Lynagh committed
2 3 4 5 6 7 8
{-# OPTIONS -fno-warn-tabs #-}
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and
-- detab the module (please do the detabbing in a separate patch). See
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
-- for details

9
-- Norman likes local bindings
10 11
-- If this module lives on I'd like to get rid of the NoMonoLocalBinds
-- extension in due course
12

Ian Lynagh's avatar
Ian Lynagh committed
13
-- Todo: remove -fno-warn-warnings-deprecations
14
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
15
module CmmBuildInfoTables
16
    ( CAFSet, CAFEnv, cafAnal, localCAFInfo, mkTopCAFInfo
17
    , setInfoTableSRT
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
18
    , TopSRT, emptySRT, srtToData
19
    , bundleCAFs
Simon Marlow's avatar
Simon Marlow committed
20
    , cafTransfers )
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
21 22 23 24
where

#include "HsVersions.h"

25 26 27
-- These should not be imported here!
import StgCmmUtils

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
28 29
import Digraph
import qualified Prelude as P
30
import Prelude hiding (succ)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
31 32 33 34

import BlockId
import Bitmap
import CLabel
35
import Cmm
36
import CmmUtils
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
37
import IdInfo
Ian Lynagh's avatar
Ian Lynagh committed
38
import Data.List
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
39 40
import Maybes
import Name
41
import OptimizationFuel
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
42 43 44
import Outputable
import SMRep
import UniqSupply
45

Simon Marlow's avatar
Simon Marlow committed
46
import Hoopl
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
47

48 49
import Data.Map (Map)
import qualified Data.Map as Map
50 51
import Data.Set (Set)
import qualified Data.Set as Set
52

Simon Marlow's avatar
Simon Marlow committed
53
foldSet :: (a -> b -> b) -> b -> Set a -> b
54 55 56 57 58 59
#if __GLASGOW_HASKELL__ < 704
foldSet = Set.fold
#else
foldSet = Set.foldr
#endif

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
----------------------------------------------------------------
-- Building InfoTables


-----------------------------------------------------------------------
-- SRTs

-- WE NEED AN EXAMPLE HERE.
-- IN PARTICULAR, WE NEED TO POINT OUT THE DISTINCTION BETWEEN
-- FUNCTIONS WITH STATIC CLOSURES AND THOSE THAT MUST BE CONSTRUCTED
-- DYNAMICALLY (AND HENCE CAN'T BE REFERENCED IN AN SRT).
-- IN THE LATTER CASE, WE HAVE TO TAKE ALL THE CAFs REFERENCED BY
-- THE CLOSURE AND INLINE THEM INTO ANY SRT THAT MAY MENTION THE CLOSURE.
-- (I.E. TAKE THE TRANSITIVE CLOSURE, but only for non-static closures).


-----------------------------------------------------------------------
-- Finding the CAFs used by a procedure

79
type CAFSet = Set CLabel
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
80 81 82 83
type CAFEnv = BlockEnv CAFSet

-- First, an analysis to find live CAFs.
cafLattice :: DataflowLattice CAFSet
84 85 86
cafLattice = DataflowLattice "live cafs" Set.empty add
  where add _ (OldFact old) (NewFact new) = case old `Set.union` new of
                                              new' -> (changeIf $ Set.size new' > Set.size old, new')
87

88 89
cafTransfers :: BwdTransfer CmmNode CAFSet
cafTransfers = mkBTransfer3 first middle last
90
  where first  _ live = live
91 92
        middle m live = foldExpDeep addCaf m live
        last   l live = foldExpDeep addCaf l (joinOutFacts cafLattice l live)
93 94 95 96 97
        addCaf e set = case e of
               CmmLit (CmmLabel c)              -> add c set
               CmmLit (CmmLabelOff c _)         -> add c set
               CmmLit (CmmLabelDiffOff c1 c2 _) -> add c1 $ add c2 set
               _ -> set
98
        add l s = if hasCAF l then Set.insert (toClosureLbl l) s
99
                              else s
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
100

Simon Marlow's avatar
Simon Marlow committed
101
cafAnal :: CmmGraph -> CAFEnv
102
cafAnal g = dataflowAnalBwd g [] $ analBwd cafLattice cafTransfers
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
103 104 105 106 107 108 109 110 111

-----------------------------------------------------------------------
-- Building the SRTs

-- Description of the SRT for a given module.
-- Note that this SRT may grow as we greedily add new CAFs to it.
data TopSRT = TopSRT { lbl      :: CLabel
                     , next_elt :: Int -- the next entry in the table
                     , rev_elts :: [CLabel]
112
                     , elt_map  :: Map CLabel Int }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
113
                        -- map: CLabel -> its last entry in the table
Ian Lynagh's avatar
Ian Lynagh committed
114 115 116
instance Outputable TopSRT where
  ppr (TopSRT lbl next elts eltmap) =
    text "TopSRT:" <+> ppr lbl
117
                   <+> ppr next
Ian Lynagh's avatar
Ian Lynagh committed
118 119
                   <+> ppr elts
                   <+> ppr eltmap
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
120 121 122 123

emptySRT :: MonadUnique m => m TopSRT
emptySRT =
  do top_lbl <- getUniqueM >>= \ u -> return $ mkSRTLabel (mkFCallName u "srt") NoCafRefs
124
     return TopSRT { lbl = top_lbl, next_elt = 0, rev_elts = [], elt_map = Map.empty }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
125 126

cafMember :: TopSRT -> CLabel -> Bool
127
cafMember srt lbl = Map.member lbl (elt_map srt)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
128 129

cafOffset :: TopSRT -> CLabel -> Maybe Int
130
cafOffset srt lbl = Map.lookup lbl (elt_map srt)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
131 132 133 134 135

addCAF :: CLabel -> TopSRT -> TopSRT
addCAF caf srt =
  srt { next_elt = last + 1
      , rev_elts = caf : rev_elts srt
136
      , elt_map  = Map.insert caf last (elt_map srt) }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
137 138
    where last  = next_elt srt

Simon Peyton Jones's avatar
Simon Peyton Jones committed
139
srtToData :: TopSRT -> CmmGroup
140
srtToData srt = [CmmData RelocatableReadOnlyData (Statics (lbl srt) tbl)]
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
141 142 143 144 145 146 147 148 149 150
    where tbl = map (CmmStaticLit . CmmLabel) (reverse (rev_elts srt))

-- Once we have found the CAFs, we need to do two things:
-- 1. Build a table of all the CAFs used in the procedure.
-- 2. Compute the C_SRT describing the subset of CAFs live at each procpoint.
--
-- When building the local view of the SRT, we first make sure that all the CAFs are 
-- in the SRT. Then, if the number of CAFs is small enough to fit in a bitmap,
-- we make sure they're all close enough to the bottom of the table that the
-- bitmap will be able to cover all of them.
151
buildSRTs :: TopSRT -> Map CLabel CAFSet -> CAFSet ->
Simon Peyton Jones's avatar
Simon Peyton Jones committed
152
             FuelUniqSM (TopSRT, Maybe CmmDecl, C_SRT)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
153
buildSRTs topSRT topCAFMap cafs =
154 155 156
  do let liftCAF lbl z = -- get CAFs for functions without static closures
           case Map.lookup lbl topCAFMap of Just cafs -> z `Set.union` cafs
                                            Nothing   -> Set.insert lbl z
157 158
         -- For each label referring to a function f without a static closure,
         -- replace it with the CAFs that are reachable from f.
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
159
         sub_srt topSRT localCafs =
160
           let cafs = Set.elems (foldSet liftCAF Set.empty localCafs)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
161 162 163
               mkSRT topSRT =
                 do localSRTs <- procpointSRT (lbl topSRT) (elt_map topSRT) cafs
                    return (topSRT, localSRTs)
164
           in if length cafs > maxBmpSize then
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
165 166 167 168 169 170 171 172 173 174 175
                mkSRT (foldl add_if_missing topSRT cafs)
              else -- make sure all the cafs are near the bottom of the srt
                mkSRT (add_if_too_far topSRT cafs)
         add_if_missing srt caf =
           if cafMember srt caf then srt else addCAF caf srt
         -- If a CAF is more than maxBmpSize entries from the young end of the
         -- SRT, then we add it to the SRT again.
         -- (Note: Not in the SRT => infinitely far.)
         add_if_too_far srt@(TopSRT {elt_map = m}) cafs =
           add srt (sortBy farthestFst cafs)
             where
176
               farthestFst x y = case (Map.lookup x m, Map.lookup y m) of
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
                                   (Nothing, Nothing) -> EQ
                                   (Nothing, Just _)  -> LT
                                   (Just _,  Nothing) -> GT
                                   (Just d, Just d')  -> compare d' d
               add srt [] = srt
               add srt@(TopSRT {next_elt = next}) (caf : rst) =
                 case cafOffset srt caf of
                   Just ix -> if next - ix > maxBmpSize then
                                add (addCAF caf srt) rst
                              else srt
                   Nothing -> add (addCAF caf srt) rst
     (topSRT, subSRTs) <- sub_srt topSRT cafs
     let (sub_tbls, blockSRTs) = subSRTs
     return (topSRT, sub_tbls, blockSRTs)

-- Construct an SRT bitmap.
-- Adapted from simpleStg/SRT.lhs, which expects Id's.
194
procpointSRT :: CLabel -> Map CLabel Int -> [CLabel] ->
Simon Peyton Jones's avatar
Simon Peyton Jones committed
195
                FuelUniqSM (Maybe CmmDecl, C_SRT)
196
procpointSRT _ _ [] =
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
197 198 199 200 201
 return (Nothing, NoC_SRT)
procpointSRT top_srt top_table entries =
 do (top, srt) <- bitmap `seq` to_SRT top_srt offset len bitmap
    return (top, srt)
  where
202
    ints = map (expectJust "constructSRT" . flip Map.lookup top_table) entries
Ian Lynagh's avatar
Ian Lynagh committed
203
    sorted_ints = sort ints
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
204 205 206 207 208 209 210 211 212
    offset = head sorted_ints
    bitmap_entries = map (subtract offset) sorted_ints
    len = P.last bitmap_entries + 1
    bitmap = intsToBitmap len bitmap_entries

maxBmpSize :: Int
maxBmpSize = widthInBits wordWidth `div` 2

-- Adapted from codeGen/StgCmmUtils, which converts from SRT to C_SRT.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
213
to_SRT :: CLabel -> Int -> Int -> Bitmap -> FuelUniqSM (Maybe CmmDecl, C_SRT)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
214 215 216 217 218
to_SRT top_srt off len bmp
  | len > maxBmpSize || bmp == [fromIntegral srt_escape]
  = do id <- getUniqueM
       let srt_desc_lbl = mkLargeSRTLabel id
           tbl = CmmData RelocatableReadOnlyData $
219
                   Statics srt_desc_lbl $ map CmmStaticLit
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
220 221 222 223 224 225 226 227 228 229 230 231
                     ( cmmLabelOffW top_srt off
                     : mkWordCLit (fromIntegral len)
                     : map mkWordCLit bmp)
       return (Just tbl, C_SRT srt_desc_lbl 0 srt_escape)
  | otherwise
  = return (Nothing, C_SRT top_srt off (fromIntegral (head bmp)))
	-- The fromIntegral converts to StgHalfWord

-- Gather CAF info for a procedure, but only if the procedure
-- doesn't have a static closure.
-- (If it has a static closure, it will already have an SRT to
--  keep its CAFs live.)
232
-- Any procedure referring to a non-static CAF c must keep live
233
-- any CAF that is reachable from c.
234 235 236
localCAFInfo :: CAFEnv -> CmmDecl -> Maybe (CLabel, CAFSet)
localCAFInfo _      (CmmData _ _) = Nothing
localCAFInfo cafEnv (CmmProc top_info top_l (CmmGraph {g_entry=entry})) =
237
  case info_tbl top_info of
238 239
    CmmInfoTable { cit_rep = rep } 
      | not (isStaticRep rep) 
240
      -> Just (toClosureLbl top_l,
241
               expectJust "maybeBindCAFs" $ mapLookup entry cafEnv)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
242 243 244 245 246 247 248 249 250 251 252 253 254
    _ -> Nothing

-- Once we have the local CAF sets for some (possibly) mutually
-- recursive functions, we can create an environment mapping
-- each function to its set of CAFs. Note that a CAF may
-- be a reference to a function. If that function f does not have
-- a static closure, then we need to refer specifically
-- to the set of CAFs used by f. Of course, the set of CAFs
-- used by f must be included in the local CAF sets that are input to
-- this function. To minimize lookup time later, we return
-- the environment with every reference to f replaced by its set of CAFs.
-- To do this replacement efficiently, we gather strongly connected
-- components, then we sort the components in topological order.
255 256
mkTopCAFInfo :: [(CLabel, CAFSet)] -> Map CLabel CAFSet
mkTopCAFInfo localCAFs = foldl addToTop Map.empty g
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
257
  where addToTop env (AcyclicSCC (l, cafset)) =
258
          Map.insert l (flatten env cafset) env
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
259 260
        addToTop env (CyclicSCC nodes) =
          let (lbls, cafsets) = unzip nodes
261
              cafset  = foldr Set.delete (foldl Set.union Set.empty cafsets) lbls
262
          in foldl (\env l -> Map.insert l (flatten env cafset) env) env lbls
263
        flatten env cafset = foldSet (lookup env) Set.empty cafset
264
        lookup env caf cafset' =
265
          case Map.lookup caf env of Just cafs -> foldSet add cafset' cafs
266 267
                                     Nothing -> add caf cafset'
        add caf cafset' = Set.insert caf cafset'
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
268
        g = stronglyConnCompFromEdgedVertices
269
              (map (\n@(l, cafs) -> (n, l, Set.elems cafs)) localCAFs)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
270

271
-- Bundle the CAFs used at a procpoint.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
272
bundleCAFs :: CAFEnv -> CmmDecl -> (CAFSet, CmmDecl)
273 274
bundleCAFs cafEnv t@(CmmProc _ _ (CmmGraph {g_entry=entry})) =
  (expectJust "bundleCAFs" (mapLookup entry cafEnv), t)
275
bundleCAFs _ t = (Set.empty, t)
276

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
277
-- Construct the SRTs for the given procedure.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
278 279
setInfoTableSRT :: Map CLabel CAFSet -> TopSRT -> (CAFSet, CmmDecl) ->
                   FuelUniqSM (TopSRT, [CmmDecl])
280
setInfoTableSRT topCAFMap topSRT (cafs, t) =
281 282
  setSRT cafs topCAFMap topSRT t

283
setSRT :: CAFSet -> Map CLabel CAFSet -> TopSRT ->
Simon Peyton Jones's avatar
Simon Peyton Jones committed
284
          CmmDecl -> FuelUniqSM (TopSRT, [CmmDecl])
285 286
setSRT cafs topCAFMap topSRT t =
  do (topSRT, cafTable, srt) <- buildSRTs topSRT topCAFMap cafs
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
287 288
     let t' = updInfo id (const srt) t
     case cafTable of
289
       Just tbl -> return (topSRT, [t', tbl])
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
290 291
       Nothing  -> return (topSRT, [t'])

292 293
type StackLayout = Liveness

Simon Peyton Jones's avatar
Simon Peyton Jones committed
294
updInfo :: (StackLayout -> StackLayout) -> (C_SRT -> C_SRT) -> CmmDecl -> CmmDecl
295 296 297 298 299
updInfo toVars toSrt (CmmProc top_info top_l g) =
  CmmProc (top_info {info_tbl=updInfoTbl toVars toSrt (info_tbl top_info)}) top_l g
updInfo _ _ t = t

updInfoTbl :: (StackLayout -> StackLayout) -> (C_SRT -> C_SRT) -> CmmInfoTable -> CmmInfoTable
300 301 302 303 304
updInfoTbl toVars toSrt info_tbl@(CmmInfoTable {})
  = info_tbl { cit_srt = toSrt (cit_srt info_tbl)
             , cit_rep = case cit_rep info_tbl of
                           StackRep ls -> StackRep (toVars ls)
                           other       -> other }
305
updInfoTbl _ _ t@CmmNonInfoTable = t