CmmBuildInfoTables.hs 13.8 KB
Newer Older
1
{-# LANGUAGE GADTs #-}
2

Jan Stolarek's avatar
Jan Stolarek committed
3
-- See Note [Deprecations in Hoopl] in Hoopl module
4
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
5
module CmmBuildInfoTables
6
    ( CAFSet, CAFEnv, cafAnal
7
    , doSRTs, TopSRT, emptySRT, isEmptySRT, srtToData )
8
where
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
9 10 11

#include "HsVersions.h"

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

Simon Peyton Jones's avatar
Simon Peyton Jones committed
29
import PprCmm()
30 31
import Data.Map (Map)
import qualified Data.Map as Map
32 33
import Data.Set (Set)
import qualified Data.Set as Set
34
import Control.Monad
35

Simon Marlow's avatar
Simon Marlow committed
36 37 38
import qualified Prelude as P
import Prelude hiding (succ)

Simon Marlow's avatar
Simon Marlow committed
39
foldSet :: (a -> b -> b) -> b -> Set a -> b
40 41
foldSet = Set.foldr

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
42 43 44
-----------------------------------------------------------------------
-- SRTs

45 46 47 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
{- 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} ]

80
This is what flattenCAFSets is doing.
81 82

-}
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
83 84 85 86

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

87
type CAFSet = Set CLabel
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
88 89 90 91
type CAFEnv = BlockEnv CAFSet

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

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

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

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

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

134 135 136
isEmptySRT :: TopSRT -> Bool
isEmptySRT srt = null (rev_elts srt)

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

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

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

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

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

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

-- 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.)
240
-- Any procedure referring to a non-static CAF c must keep live
241
-- any CAF that is reachable from c.
242 243
localCAFInfo :: CAFEnv -> CmmDecl -> (CAFSet, Maybe CLabel)
localCAFInfo _      (CmmData _ _) = (Set.empty, Nothing)
244
localCAFInfo cafEnv proc@(CmmProc _ top_l _ (CmmGraph {g_entry=entry})) =
245
  case topInfoTable proc of
246 247
    Just (CmmInfoTable { cit_rep = rep })
      | not (isStaticRep rep) && not (isStackRep rep)
248 249 250 251
      -> (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
252 253 254 255 256 257 258 259 260 261 262 263

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

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
274
        g = stronglyConnCompFromEdgedVertices
275 276 277 278 279 280 281 282 283 284 285 286 287
              [ ((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)
288
       -> (BlockEnv CAFSet, CmmDecl)
289
bundle flatmap (env, decl@(CmmProc infos lbl _ g)) (closure_cafs, mb_lbl)
290 291 292 293 294 295 296 297 298 299 300
  = ( 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)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
301
                      then pprPanic "bundle" (ppr l <+> ppr lbl <+> ppr (info_tbls infos) $$ ppr env $$ ppr decl)
302 303
                      else flatten flatmap $ expectJust "bundle" $ mapLookup l env

Simon Marlow's avatar
Simon Marlow committed
304
bundle _flatmap (_, decl) _
305
  = ( mapEmpty, decl )
306

307 308

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

315 316
doSRTs :: DynFlags
       -> TopSRT
317 318 319
       -> [(CAFEnv, [CmmDecl])]
       -> IO (TopSRT, [CmmDecl])

320
doSRTs dflags topSRT tops
321 322 323 324 325 326
  = 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
327
    setSRT (topSRT, rst) (caf_map, decl@(CmmProc{})) = do
328
       (topSRT, srt_tables, srt_env) <- buildSRTs dflags topSRT caf_map
329 330
       let decl' = updInfoSRTs srt_env decl
       return (topSRT, decl': srt_tables ++ rst)
331 332 333
    setSRT (topSRT, rst) (_, decl) =
      return (topSRT, decl : rst)

334
buildSRTs :: DynFlags -> TopSRT -> BlockEnv CAFSet
335
          -> UniqSM (TopSRT, [CmmDecl], BlockEnv C_SRT)
336
buildSRTs dflags top_srt caf_map
337 338 339
  = foldM doOne (top_srt, [], mapEmpty) (mapToList caf_map)
  where
  doOne (top_srt, decls, srt_env) (l, cafs)
340
    = do (top_srt, mb_decl, srt) <- buildSRT dflags top_srt cafs
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
         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)]
-
-}


356 357 358 359 360 361 362 363
{- 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
-}

364
updInfoSRTs :: BlockEnv C_SRT -> CmmDecl -> CmmDecl
365 366
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
367 368 369
  where updInfoTbl l info_tbl
             = info_tbl { cit_srt = expectJust "updInfo" $ mapLookup l srt_env }
updInfoSRTs _ t = t