CmmBuildInfoTables.hs 13.9 KB
Newer Older
1
{-# LANGUAGE GADTs, NoMonoLocalBinds #-}
Ian Lynagh's avatar
Ian Lynagh committed
2

3
-- Norman likes local bindings
4 5
-- If this module lives on I'd like to get rid of the NoMonoLocalBinds
-- extension in due course
6

Ian Lynagh's avatar
Ian Lynagh committed
7
-- Todo: remove -fno-warn-warnings-deprecations
8
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
9
module CmmBuildInfoTables
10
    ( CAFSet, CAFEnv, cafAnal
11
    , doSRTs, TopSRT, emptySRT, isEmptySRT, srtToData )
12
where
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
13 14 15

#include "HsVersions.h"

16
import Hoopl
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
17 18 19 20
import Digraph
import BlockId
import Bitmap
import CLabel
Simon Marlow's avatar
Simon Marlow committed
21
import PprCmmDecl ()
22
import Cmm
23
import CmmUtils
Simon Marlow's avatar
Simon Marlow committed
24
import CmmInfo
Ian Lynagh's avatar
Ian Lynagh committed
25
import Data.List
26
import DynFlags
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
27 28 29 30
import Maybes
import Outputable
import SMRep
import UniqSupply
31
import Util
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
32

33 34
import Data.Map (Map)
import qualified Data.Map as Map
35 36
import Data.Set (Set)
import qualified Data.Set as Set
37
import Control.Monad
38

Simon Marlow's avatar
Simon Marlow committed
39 40 41
import qualified Prelude as P
import Prelude hiding (succ)

Simon Marlow's avatar
Simon Marlow committed
42
foldSet :: (a -> b -> b) -> b -> Set a -> b
43 44
foldSet = Set.foldr

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
45 46 47
-----------------------------------------------------------------------
-- SRTs

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
{- EXAMPLE

f = \x. ... g ...
  where
    g = \y. ... h ... c1 ...
    h = \z. ... c2 ...

c1 & c2 are CAFs

g and h are local functions, but they have no static closures.  When
we generate code for f, we start with a CmmGroup of four CmmDecls:

   [ f_closure, f_entry, g_entry, h_entry ]

we process each CmmDecl separately in cpsTop, giving us a list of
CmmDecls. e.g. for f_entry, we might end up with

   [ f_entry, f1_ret, f2_proc ]

where f1_ret is a return point, and f2_proc is a proc-point.  We have
a CAFSet for each of these CmmDecls, let's suppose they are

   [ f_entry{g_closure}, f1_ret{g_closure}, f2_proc{} ]
   [ g_entry{h_closure, c1_closure} ]
   [ h_entry{c2_closure} ]

Now, note that we cannot use g_closure and h_closure in an SRT,
because there are no static closures corresponding to these functions.
So we have to flatten out the structure, replacing g_closure and
h_closure with their contents:

   [ f_entry{c2_closure, c1_closure}, f1_ret{c2_closure,c1_closure}, f2_proc{} ]
   [ g_entry{c2_closure, c1_closure} ]
   [ h_entry{c2_closure} ]

83
This is what flattenCAFSets is doing.
84 85

-}
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
86 87 88 89

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

90
type CAFSet = Set CLabel
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
91 92 93 94
type CAFEnv = BlockEnv CAFSet

-- First, an analysis to find live CAFs.
cafLattice :: DataflowLattice CAFSet
95 96 97
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')
98

99 100
cafTransfers :: BwdTransfer CmmNode CAFSet
cafTransfers = mkBTransfer3 first middle last
101
  where first  _ live = live
102 103
        middle m live = foldExpDeep addCaf m live
        last   l live = foldExpDeep addCaf l (joinOutFacts cafLattice l live)
104 105 106 107 108
        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
109
        add l s = if hasCAF l then Set.insert (toClosureLbl l) s
110
                              else s
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
111

Simon Marlow's avatar
Simon Marlow committed
112
cafAnal :: CmmGraph -> CAFEnv
113
cafAnal g = dataflowAnalBwd g [] $ analBwd cafLattice cafTransfers
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
114 115 116 117 118 119 120 121 122

-----------------------------------------------------------------------
-- 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]
123
                     , elt_map  :: Map CLabel Int }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
124
                        -- map: CLabel -> its last entry in the table
Ian Lynagh's avatar
Ian Lynagh committed
125 126 127
instance Outputable TopSRT where
  ppr (TopSRT lbl next elts eltmap) =
    text "TopSRT:" <+> ppr lbl
128
                   <+> ppr next
Ian Lynagh's avatar
Ian Lynagh committed
129 130
                   <+> ppr elts
                   <+> ppr eltmap
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
131

132 133 134
emptySRT :: MonadUnique m => m TopSRT
emptySRT =
  do top_lbl <- getUniqueM >>= \ u -> return $ mkTopSRTLabel u
135
     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
136

137 138 139
isEmptySRT :: TopSRT -> Bool
isEmptySRT srt = null (rev_elts srt)

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
140
cafMember :: TopSRT -> CLabel -> Bool
141
cafMember srt lbl = Map.member lbl (elt_map srt)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
142 143

cafOffset :: TopSRT -> CLabel -> Maybe Int
144
cafOffset srt lbl = Map.lookup lbl (elt_map srt)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
145 146 147 148 149

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

Simon Peyton Jones's avatar
Simon Peyton Jones committed
153
srtToData :: TopSRT -> CmmGroup
154
srtToData srt = [CmmData RelocatableReadOnlyData (Statics (lbl srt) tbl)]
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
155 156 157 158 159 160
    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.
--
161
-- When building the local view of the SRT, we first make sure that all the CAFs are
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
162 163 164
-- 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.
165 166
buildSRT :: DynFlags -> TopSRT -> CAFSet -> UniqSM (TopSRT, Maybe CmmDecl, C_SRT)
buildSRT dflags topSRT cafs =
167
  do let
168 169
         -- 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
170
         sub_srt topSRT localCafs =
171
           let cafs = Set.elems localCafs
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
172
               mkSRT topSRT =
173
                 do localSRTs <- procpointSRT dflags (lbl topSRT) (elt_map topSRT) cafs
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
174
                    return (topSRT, localSRTs)
175
           in if length cafs > maxBmpSize dflags then
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
176 177 178 179 180 181 182 183 184 185 186
                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
187
               farthestFst x y = case (Map.lookup x m, Map.lookup y m) of
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
188 189 190 191 192 193 194
                                   (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
195
                   Just ix -> if next - ix > maxBmpSize dflags then
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
196 197 198 199 200 201 202 203 204
                                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.
205
procpointSRT :: DynFlags -> CLabel -> Map CLabel Int -> [CLabel] ->
206
                UniqSM (Maybe CmmDecl, C_SRT)
207
procpointSRT _ _ _ [] =
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
208
 return (Nothing, NoC_SRT)
209 210
procpointSRT dflags top_srt top_table entries =
 do (top, srt) <- bitmap `seq` to_SRT dflags top_srt offset len bitmap
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
211 212
    return (top, srt)
  where
213
    ints = map (expectJust "constructSRT" . flip Map.lookup top_table) entries
Ian Lynagh's avatar
Ian Lynagh committed
214
    sorted_ints = sort ints
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
215 216 217
    offset = head sorted_ints
    bitmap_entries = map (subtract offset) sorted_ints
    len = P.last bitmap_entries + 1
218
    bitmap = intsToBitmap dflags len bitmap_entries
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
219

220 221
maxBmpSize :: DynFlags -> Int
maxBmpSize dflags = widthInBits (wordWidth dflags) `div` 2
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
222 223

-- Adapted from codeGen/StgCmmUtils, which converts from SRT to C_SRT.
224 225
to_SRT :: DynFlags -> CLabel -> Int -> Int -> Bitmap -> UniqSM (Maybe CmmDecl, C_SRT)
to_SRT dflags top_srt off len bmp
Simon Marlow's avatar
Simon Marlow committed
226
  | len > maxBmpSize dflags || bmp == [toStgWord dflags (fromStgHalfWord (srtEscape dflags))]
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
227 228 229
  = do id <- getUniqueM
       let srt_desc_lbl = mkLargeSRTLabel id
           tbl = CmmData RelocatableReadOnlyData $
230
                   Statics srt_desc_lbl $ map CmmStaticLit
231
                     ( cmmLabelOffW dflags top_srt off
232 233
                     : mkWordCLit dflags (fromIntegral len)
                     : map (mkStgWordCLit dflags) bmp)
Simon Marlow's avatar
Simon Marlow committed
234
       return (Just tbl, C_SRT srt_desc_lbl 0 (srtEscape dflags))
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
235
  | otherwise
236
  = return (Nothing, C_SRT top_srt off (toStgHalfWord dflags (fromStgWord (head bmp))))
237
        -- The fromIntegral converts to StgHalfWord
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
238 239 240 241 242

-- 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.)
243
-- Any procedure referring to a non-static CAF c must keep live
244
-- any CAF that is reachable from c.
245 246
localCAFInfo :: CAFEnv -> CmmDecl -> (CAFSet, Maybe CLabel)
localCAFInfo _      (CmmData _ _) = (Set.empty, Nothing)
247
localCAFInfo cafEnv proc@(CmmProc _ top_l _ (CmmGraph {g_entry=entry})) =
248
  case topInfoTable proc of
249 250
    Just (CmmInfoTable { cit_rep = rep })
      | not (isStaticRep rep) && not (isStackRep rep)
251 252 253 254
      -> (cafs, Just (toClosureLbl top_l))
    _other -> (cafs, Nothing)
  where
    cafs = expectJust "maybeBindCAFs" $ mapLookup entry cafEnv
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
255 256 257 258 259 260 261 262 263 264 265 266

-- 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.
267
mkTopCAFInfo :: [(CAFSet, Maybe CLabel)] -> Map CLabel CAFSet
268
mkTopCAFInfo localCAFs = foldl addToTop Map.empty g
269 270
  where
        addToTop env (AcyclicSCC (l, cafset)) =
271
          Map.insert l (flatten env cafset) env
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
272 273
        addToTop env (CyclicSCC nodes) =
          let (lbls, cafsets) = unzip nodes
274
              cafset  = foldr Set.delete (foldl Set.union Set.empty cafsets) lbls
275
          in foldl (\env l -> Map.insert l (flatten env cafset) env) env lbls
276

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
277
        g = stronglyConnCompFromEdgedVertices
278 279 280 281 282 283 284 285 286 287 288 289 290
              [ ((l,cafs), l, Set.elems cafs) | (cafs, Just l) <- localCAFs ]

flatten :: Map CLabel CAFSet -> CAFSet -> CAFSet
flatten env cafset = foldSet (lookup env) Set.empty cafset
  where
      lookup env caf cafset' =
          case Map.lookup caf env of
             Just cafs -> foldSet Set.insert cafset' cafs
             Nothing   -> Set.insert caf cafset'

bundle :: Map CLabel CAFSet
       -> (CAFEnv, CmmDecl)
       -> (CAFSet, Maybe CLabel)
291
       -> (BlockEnv CAFSet, CmmDecl)
292
bundle flatmap (env, decl@(CmmProc infos lbl _ g)) (closure_cafs, mb_lbl)
293 294 295 296 297 298 299 300 301 302 303 304 305 306
  = ( mapMapWithKey get_cafs (info_tbls infos), decl )
 where
  entry = g_entry g

  entry_cafs
    | Just l <- mb_lbl = expectJust "bundle" $ Map.lookup l flatmap
    | otherwise        = flatten flatmap closure_cafs

  get_cafs l _
    | l == entry = entry_cafs
    | otherwise  = if not (mapMember l env)
                      then pprPanic "bundle" (ppr l <+> ppr lbl <+> ppr (info_tbls infos))
                      else flatten flatmap $ expectJust "bundle" $ mapLookup l env

Simon Marlow's avatar
Simon Marlow committed
307
bundle _flatmap (_, decl) _
308
  = ( mapEmpty, decl )
309

310 311

flattenCAFSets :: [(CAFEnv, [CmmDecl])] -> [(BlockEnv CAFSet, CmmDecl)]
312 313
flattenCAFSets cpsdecls = zipWith (bundle flatmap) zipped localCAFs
   where
314
     zipped    = [ (env,decl) | (env,decls) <- cpsdecls, decl <- decls ]
315 316 317
     localCAFs = unzipWith localCAFInfo zipped
     flatmap   = mkTopCAFInfo localCAFs -- transitive closure of localCAFs

318 319
doSRTs :: DynFlags
       -> TopSRT
320 321 322
       -> [(CAFEnv, [CmmDecl])]
       -> IO (TopSRT, [CmmDecl])

323
doSRTs dflags topSRT tops
324 325 326 327 328 329
  = do
     let caf_decls = flattenCAFSets tops
     us <- mkSplitUniqSupply 'u'
     let (topSRT', gs') = initUs_ us $ foldM setSRT (topSRT, []) caf_decls
     return (topSRT', reverse gs' {- Note [reverse gs] -})
  where
330
    setSRT (topSRT, rst) (caf_map, decl@(CmmProc{})) = do
331
       (topSRT, srt_tables, srt_env) <- buildSRTs dflags topSRT caf_map
332 333
       let decl' = updInfoSRTs srt_env decl
       return (topSRT, decl': srt_tables ++ rst)
334 335 336
    setSRT (topSRT, rst) (_, decl) =
      return (topSRT, decl : rst)

337
buildSRTs :: DynFlags -> TopSRT -> BlockEnv CAFSet
338
          -> UniqSM (TopSRT, [CmmDecl], BlockEnv C_SRT)
339
buildSRTs dflags top_srt caf_map
340 341 342
  = foldM doOne (top_srt, [], mapEmpty) (mapToList caf_map)
  where
  doOne (top_srt, decls, srt_env) (l, cafs)
343
    = do (top_srt, mb_decl, srt) <- buildSRT dflags top_srt cafs
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
         return ( top_srt, maybeToList mb_decl ++ decls
                , mapInsert l srt srt_env )

{-
- In each CmmDecl there is a mapping from BlockId -> CmmInfoTable
- The one corresponding to g_entry is the closure info table, the
  rest are continuations.
- Each one needs an SRT.
- We get the CAFSet for each one from the CAFEnv
- flatten gives us
    [(BlockEnv CAFSet, CmmDecl)]
-
-}


359 360 361 362 363 364 365 366
{- Note [reverse gs]

   It is important to keep the code blocks in the same order,
   otherwise binary sizes get slightly bigger.  I'm not completely
   sure why this is, perhaps the assembler generates bigger jump
   instructions for forward refs.  --SDM
-}

367
updInfoSRTs :: BlockEnv C_SRT -> CmmDecl -> CmmDecl
368 369
updInfoSRTs srt_env (CmmProc top_info top_l live g) =
  CmmProc (top_info {info_tbls = mapMapWithKey updInfoTbl (info_tbls top_info)}) top_l live g
370 371 372
  where updInfoTbl l info_tbl
             = info_tbl { cit_srt = expectJust "updInfo" $ mapLookup l srt_env }
updInfoSRTs _ t = t