SMRep.lhs 16.5 KB
Newer Older
1
%
Simon Marlow's avatar
Simon Marlow committed
2
% (c) The University of Glasgow 2006
3
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4
%
Simon Marlow's avatar
Simon Marlow committed
5 6

Storage manager representation of closures
7 8

\begin{code}
9 10
{-# LANGUAGE GeneralizedNewtypeDeriving #-}

11
module SMRep (
Simon Marlow's avatar
Simon Marlow committed
12
        -- * Words and bytes
13 14 15 16
        WordOff, ByteOff,
        wordsToBytes, bytesToWordsRoundUp,
        roundUpToWords,

17
        StgWord, fromStgWord, toStgWord,
18
        StgHalfWord, fromStgHalfWord, toStgHalfWord,
19
        hALF_WORD_SIZE, hALF_WORD_SIZE_IN_BITS,
20

Simon Marlow's avatar
Simon Marlow committed
21
        -- * Closure repesentation
22 23
        SMRep(..), -- CmmInfo sees the rep; no one else does
        IsStatic,
24
        ClosureTypeInfo(..), ArgDescr(..), Liveness,
25
        ConstrDescription,
Simon Marlow's avatar
Simon Marlow committed
26 27

        -- ** Construction
28
        mkHeapRep, blackHoleRep, indStaticRep, mkStackRep, mkRTSRep, arrPtrsRep,
29

Simon Marlow's avatar
Simon Marlow committed
30
        -- ** Predicates
Simon Marlow's avatar
Simon Marlow committed
31
        isStaticRep, isConRep, isThunkRep, isFunRep, isStaticNoCafCon,
32
        isStackRep,
Simon Marlow's avatar
Simon Marlow committed
33 34

        -- ** Size-related things
35 36 37
        heapClosureSizeW,
        fixedHdrSize, arrWordsHdrSize, arrPtrsHdrSize, arrPtrsHdrSizeW,
        profHdrSize, thunkHdrSize, nonHdrSizeW,
38

Simon Marlow's avatar
Simon Marlow committed
39 40
        -- ** RTS closure types
        rtsClosureType, rET_SMALL, rET_BIG,
41 42
        aRG_GEN, aRG_GEN_BIG,

43 44 45
        -- ** Arrays
        card, cardRoundUp, cardTableSizeB, cardTableSizeW,

Simon Marlow's avatar
Simon Marlow committed
46
        -- * Operations over [Word8] strings that don't belong here
47
        pprWord8String, stringToWord8s
48 49
    ) where

50
#include "../HsVersions.h"
51
#include "../includes/MachDeps.h"
52

53
import DynFlags
sof's avatar
sof committed
54
import Outputable
55
import Platform
56
import FastString
57

58
import Data.Char( ord )
Simon Marlow's avatar
Simon Marlow committed
59
import Data.Word
60
import Data.Bits
61 62
\end{code}

63 64

%************************************************************************
65 66 67
%*                                                                      *
                Words and bytes
%*                                                                      *
68 69 70
%************************************************************************

\begin{code}
71 72
type WordOff = Int -- Word offset, or word count
type ByteOff = Int -- Byte offset, or byte count
73

74
roundUpToWords :: DynFlags -> ByteOff -> ByteOff
75 76 77 78 79 80 81 82 83
roundUpToWords dflags n =
  (n + (wORD_SIZE dflags - 1)) .&. (complement (wORD_SIZE dflags - 1))

wordsToBytes :: DynFlags -> WordOff -> ByteOff
wordsToBytes dflags n = wORD_SIZE dflags * n

bytesToWordsRoundUp :: DynFlags -> ByteOff -> WordOff
bytesToWordsRoundUp dflags n = (n + word_size - 1) `quot` word_size
 where word_size = wORD_SIZE dflags
84 85 86 87 88
\end{code}

StgWord is a type representing an StgWord on the target platform.

\begin{code}
89
-- A Word64 is large enough to hold a Word for either a 32bit or 64bit platform
90 91 92 93 94
newtype StgWord = StgWord Word64
    deriving (Eq,
#if __GLASGOW_HASKELL__ < 706
              Num,
#endif
95
              Bits)
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113

fromStgWord :: StgWord -> Integer
fromStgWord (StgWord i) = toInteger i

toStgWord :: DynFlags -> Integer -> StgWord
toStgWord dflags i
    = case platformWordSize (targetPlatform dflags) of
      -- These conversions mean that things like toStgWord (-1)
      -- do the right thing
      4 -> StgWord (fromIntegral (fromInteger i :: Word32))
      8 -> StgWord (fromInteger i :: Word64)
      w -> panic ("toStgWord: Unknown platformWordSize: " ++ show w)

instance Outputable StgWord where
    ppr (StgWord i) = integer (toInteger i)

--

114 115 116
-- A Word32 is large enough to hold half a Word for either a 32bit or
-- 64bit platform
newtype StgHalfWord = StgHalfWord Word32
117 118 119
    deriving Eq

fromStgHalfWord :: StgHalfWord -> Integer
120
fromStgHalfWord (StgHalfWord w) = toInteger w
121 122 123 124 125 126

toStgHalfWord :: DynFlags -> Integer -> StgHalfWord
toStgHalfWord dflags i
    = case platformWordSize (targetPlatform dflags) of
      -- These conversions mean that things like toStgHalfWord (-1)
      -- do the right thing
127 128
      4 -> StgHalfWord (fromIntegral (fromInteger i :: Word16))
      8 -> StgHalfWord (fromInteger i :: Word32)
129 130 131
      w -> panic ("toStgHalfWord: Unknown platformWordSize: " ++ show w)

instance Outputable StgHalfWord where
132
    ppr (StgHalfWord w) = integer (toInteger w)
133

ian@well-typed.com's avatar
ian@well-typed.com committed
134 135 136 137
hALF_WORD_SIZE :: DynFlags -> ByteOff
hALF_WORD_SIZE dflags = platformWordSize (targetPlatform dflags) `shiftR` 1
hALF_WORD_SIZE_IN_BITS :: DynFlags -> Int
hALF_WORD_SIZE_IN_BITS dflags = platformWordSize (targetPlatform dflags) `shiftL` 2
138 139
\end{code}

140
%************************************************************************
141
%*                                                                      *
142
\subsubsection[SMRep-datatype]{@SMRep@---storage manager representation}
143
%*                                                                      *
144 145 146
%************************************************************************

\begin{code}
147 148
-- | A description of the layout of a closure.  Corresponds directly
-- to the closure types in includes/rts/storage/ClosureTypes.h.
149
data SMRep
150 151 152 153 154 155
  = HeapRep              -- GC routines consult sizes in info tbl
        IsStatic
        !WordOff         --  # ptr words
        !WordOff         --  # non-ptr words INCLUDING SLOP (see mkHeapRep below)
        ClosureTypeInfo  -- type-specific info

156 157 158 159
  | ArrayPtrsRep
        !WordOff        -- # ptr words
        !WordOff        -- # card table words

160 161 162
  | StackRep            -- Stack frame (RET_SMALL or RET_BIG)
        Liveness

163
  | RTSRep              -- The RTS needs to declare info tables with specific
164
        Int             -- type tags, so this form lets us override the default
165 166
        SMRep           -- tag for an SMRep.

167 168 169 170 171 172 173 174 175 176 177 178 179 180
-- | True <=> This is a static closure.  Affects how we garbage-collect it.
-- Static closure have an extra static link field at the end.
type IsStatic = Bool

-- From an SMRep you can get to the closure type defined in
-- includes/rts/storage/ClosureTypes.h. Described by the function
-- rtsClosureType below.

data ClosureTypeInfo
  = Constr        ConstrTag ConstrDescription
  | Fun           FunArity ArgDescr
  | Thunk
  | ThunkSelector SelectorOffset
  | BlackHole
181
  | IndStatic
182

183
type ConstrTag         = Int
184
type ConstrDescription = [Word8] -- result of dataConIdentity
185 186
type FunArity          = Int
type SelectorOffset    = Int
187 188 189 190 191

-------------------------
-- We represent liveness bitmaps as a Bitmap (whose internal
-- representation really is a bitmap).  These are pinned onto case return
-- vectors to indicate the state of the stack for the garbage collector.
192
--
193 194
-- In the compiled program, liveness bitmaps that fit inside a single
-- word (StgWord) are stored as a single word, while larger bitmaps are
195
-- stored as a pointer to an array of words.
196 197 198 199 200 201 202 203

type Liveness = [Bool]   -- One Bool per word; True  <=> non-ptr or dead
                         --                    False <=> ptr

-------------------------
-- An ArgDescr describes the argument pattern of a function

data ArgDescr
204
  = ArgSpec             -- Fits one of the standard patterns
205
        !Int            -- RTS type identifier ARG_P, ARG_N, ...
206

207 208
  | ArgGen              -- General case
        Liveness        -- Details about the arguments
209 210 211 212 213


-----------------------------------------------------------------------------
-- Construction

214 215 216
mkHeapRep :: DynFlags -> IsStatic -> WordOff -> WordOff -> ClosureTypeInfo
          -> SMRep
mkHeapRep dflags is_static ptr_wds nonptr_wds cl_type_info
217 218 219 220 221 222 223
  = HeapRep is_static
            ptr_wds
            (nonptr_wds + slop_wds)
            cl_type_info
  where
     slop_wds
      | is_static = 0
224
      | otherwise = max 0 (minClosureSize dflags - (hdr_size + payload_size))
225

226
     hdr_size     = closureTypeHdrSize dflags cl_type_info
227
     payload_size = ptr_wds + nonptr_wds
228

229
mkRTSRep :: Int -> SMRep -> SMRep
230
mkRTSRep = RTSRep
231 232

mkStackRep :: [Bool] -> SMRep
233
mkStackRep liveness = StackRep liveness
234 235 236 237

blackHoleRep :: SMRep
blackHoleRep = HeapRep False 0 0 BlackHole

238 239 240
indStaticRep :: SMRep
indStaticRep = HeapRep True 1 0 IndStatic

241 242 243
arrPtrsRep :: DynFlags -> WordOff -> SMRep
arrPtrsRep dflags elems = ArrayPtrsRep elems (cardTableSizeW dflags elems)

Simon Marlow's avatar
Simon Marlow committed
244 245 246 247 248 249
-----------------------------------------------------------------------------
-- Predicates

isStaticRep :: SMRep -> IsStatic
isStaticRep (HeapRep is_static _ _ _) = is_static
isStaticRep (RTSRep _ rep)            = isStaticRep rep
250
isStaticRep _                         = False
Simon Marlow's avatar
Simon Marlow committed
251

252 253 254 255 256
isStackRep :: SMRep -> Bool
isStackRep StackRep{}     = True
isStackRep (RTSRep _ rep) = isStackRep rep
isStackRep _              = False

Simon Marlow's avatar
Simon Marlow committed
257 258 259 260 261 262 263 264
isConRep :: SMRep -> Bool
isConRep (HeapRep _ _ _ Constr{}) = True
isConRep _                        = False

isThunkRep :: SMRep -> Bool
isThunkRep (HeapRep _ _ _ Thunk{})         = True
isThunkRep (HeapRep _ _ _ ThunkSelector{}) = True
isThunkRep (HeapRep _ _ _ BlackHole{})     = True
265
isThunkRep (HeapRep _ _ _ IndStatic{})     = True
Simon Marlow's avatar
Simon Marlow committed
266 267
isThunkRep _                               = False

Simon Marlow's avatar
Simon Marlow committed
268 269 270 271
isFunRep :: SMRep -> Bool
isFunRep (HeapRep _ _ _ Fun{}) = True
isFunRep _                     = False

Simon Marlow's avatar
Simon Marlow committed
272 273 274 275 276 277 278
isStaticNoCafCon :: SMRep -> Bool
-- This should line up exactly with CONSTR_NOCAF_STATIC above
-- See Note [Static NoCaf constructors]
isStaticNoCafCon (HeapRep True 0 _ Constr{}) = True
isStaticNoCafCon _                           = False


279 280 281 282
-----------------------------------------------------------------------------
-- Size-related things

-- | Size of a closure header (StgHeader in includes/rts/storage/Closures.h)
283
fixedHdrSize :: DynFlags -> WordOff
284
fixedHdrSize dflags = sTD_HDR_SIZE dflags + profHdrSize dflags
285

286 287
-- | Size of the profiling part of a closure header
-- (StgProfHeader in includes/rts/storage/Closures.h)
288 289
profHdrSize  :: DynFlags -> WordOff
profHdrSize dflags
ian@well-typed.com's avatar
ian@well-typed.com committed
290
 | gopt Opt_SccProfilingOn dflags = pROF_HDR_SIZE dflags
291
 | otherwise                      = 0
292

293 294 295
-- | The garbage collector requires that every closure is at least as
--   big as this.
minClosureSize :: DynFlags -> WordOff
296
minClosureSize dflags = fixedHdrSize dflags + mIN_PAYLOAD_SIZE dflags
297

298 299
arrWordsHdrSize :: DynFlags -> ByteOff
arrWordsHdrSize dflags
300
 = fixedHdrSize dflags * wORD_SIZE dflags + sIZEOF_StgArrWords_NoHdr dflags
301

302 303
arrPtrsHdrSize :: DynFlags -> ByteOff
arrPtrsHdrSize dflags
304
 = fixedHdrSize dflags * wORD_SIZE dflags + sIZEOF_StgMutArrPtrs_NoHdr dflags
305

306 307 308 309 310
arrPtrsHdrSizeW :: DynFlags -> WordOff
arrPtrsHdrSizeW dflags =
    fixedHdrSize dflags +
    (sIZEOF_StgMutArrPtrs_NoHdr dflags `quot` wORD_SIZE dflags)

311
-- Thunks have an extra header word on SMP, so the update doesn't
312
-- splat the payload.
313 314
thunkHdrSize :: DynFlags -> WordOff
thunkHdrSize dflags = fixedHdrSize dflags + smp_hdr
315
        where smp_hdr = sIZEOF_StgSMPThunkHeader dflags `quot` wORD_SIZE dflags
316

317

318 319 320 321 322
nonHdrSizeW :: SMRep -> WordOff
nonHdrSizeW (HeapRep _ p np _) = p + np
nonHdrSizeW (ArrayPtrsRep elems ct) = elems + ct
nonHdrSizeW (StackRep bs)      = length bs
nonHdrSizeW (RTSRep _ rep)     = nonHdrSizeW rep
323

324 325
heapClosureSizeW :: DynFlags -> SMRep -> WordOff
heapClosureSizeW dflags (HeapRep _ p np ty)
326
 = closureTypeHdrSize dflags ty + p + np
327 328 329
heapClosureSizeW dflags (ArrayPtrsRep elems ct)
 = arrPtrsHdrSizeW dflags + elems + ct
heapClosureSizeW _ _ = panic "SMRep.heapClosureSize"
330 331 332 333 334 335

closureTypeHdrSize :: DynFlags -> ClosureTypeInfo -> WordOff
closureTypeHdrSize dflags ty = case ty of
                  Thunk{}         -> thunkHdrSize dflags
                  ThunkSelector{} -> thunkHdrSize dflags
                  BlackHole{}     -> thunkHdrSize dflags
336
                  IndStatic{}     -> thunkHdrSize dflags
337
                  _               -> fixedHdrSize dflags
338 339 340 341 342
        -- All thunks use thunkHdrSize, even if they are non-updatable.
        -- this is because we don't have separate closure types for
        -- updatable vs. non-updatable thunks, so the GC can't tell the
        -- difference.  If we ever have significant numbers of non-
        -- updatable thunks, it might be worth fixing this.
343

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
-- ---------------------------------------------------------------------------
-- Arrays

-- | The byte offset into the card table of the card for a given element
card :: DynFlags -> Int -> Int
card dflags i = i `shiftR` mUT_ARR_PTRS_CARD_BITS dflags

-- | Convert a number of elements to a number of cards, rounding up
cardRoundUp :: DynFlags -> Int -> Int
cardRoundUp dflags i =
  card dflags (i + ((1 `shiftL` mUT_ARR_PTRS_CARD_BITS dflags) - 1))

-- | The size of a card table, in bytes
cardTableSizeB :: DynFlags -> Int -> ByteOff
cardTableSizeB dflags elems = cardRoundUp dflags elems

-- | The size of a card table, in words
cardTableSizeW :: DynFlags -> Int -> WordOff
cardTableSizeW dflags elems =
  bytesToWordsRoundUp dflags (cardTableSizeB dflags elems)

365 366
-----------------------------------------------------------------------------
-- deriving the RTS closure type from an SMRep
367

368 369 370
#include "../includes/rts/storage/ClosureTypes.h"
#include "../includes/rts/storage/FunTypes.h"
-- Defines CONSTR, CONSTR_1_0 etc
371

372
-- | Derives the RTS closure type from an 'SMRep'
373 374 375 376
rtsClosureType :: SMRep -> Int
rtsClosureType rep
    = case rep of
      RTSRep ty _ -> ty
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

      HeapRep False 1 0 Constr{} -> CONSTR_1_0
      HeapRep False 0 1 Constr{} -> CONSTR_0_1
      HeapRep False 2 0 Constr{} -> CONSTR_2_0
      HeapRep False 1 1 Constr{} -> CONSTR_1_1
      HeapRep False 0 2 Constr{} -> CONSTR_0_2
      HeapRep False _ _ Constr{} -> CONSTR

      HeapRep False 1 0 Fun{} -> FUN_1_0
      HeapRep False 0 1 Fun{} -> FUN_0_1
      HeapRep False 2 0 Fun{} -> FUN_2_0
      HeapRep False 1 1 Fun{} -> FUN_1_1
      HeapRep False 0 2 Fun{} -> FUN_0_2
      HeapRep False _ _ Fun{} -> FUN

      HeapRep False 1 0 Thunk{} -> THUNK_1_0
      HeapRep False 0 1 Thunk{} -> THUNK_0_1
      HeapRep False 2 0 Thunk{} -> THUNK_2_0
      HeapRep False 1 1 Thunk{} -> THUNK_1_1
      HeapRep False 0 2 Thunk{} -> THUNK_0_2
      HeapRep False _ _ Thunk{} -> THUNK

      HeapRep False _ _ ThunkSelector{} ->  THUNK_SELECTOR

      -- Approximation: we use the CONSTR_NOCAF_STATIC type for static
      -- constructors -- that have no pointer words only.
      HeapRep True 0 _ Constr{} -> CONSTR_NOCAF_STATIC  -- See isStaticNoCafCon below
      HeapRep True _ _ Constr{} -> CONSTR_STATIC
      HeapRep True _ _ Fun{}    -> FUN_STATIC
      HeapRep True _ _ Thunk{}  -> THUNK_STATIC

      HeapRep False _ _ BlackHole{} -> BLACKHOLE

410 411
      HeapRep False _ _ IndStatic{} -> IND_STATIC

412
      _ -> panic "rtsClosureType"
413 414

-- We export these ones
415 416 417 418 419
rET_SMALL, rET_BIG, aRG_GEN, aRG_GEN_BIG :: Int
rET_SMALL   = RET_SMALL
rET_BIG     = RET_BIG
aRG_GEN     = ARG_GEN
aRG_GEN_BIG = ARG_GEN_BIG
420
\end{code}
421

422 423
Note [Static NoCaf constructors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
424
If we know that a top-level binding 'x' is not Caffy (ie no CAFs are
425 426 427 428
reachable from 'x'), then a statically allocated constructor (Just x)
is also not Caffy, and the garbage collector need not follow its
argument fields.  Exploiting this would require two static info tables
for Just, for the two cases where the argument was Caffy or non-Caffy.
429

430
Currently we don't do this; instead we treat nullary constructors
431
as non-Caffy, and the others as potentially Caffy.
432

433

434
%************************************************************************
435
%*                                                                      *
436
             Pretty printing of SMRep and friends
437
%*                                                                      *
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
%************************************************************************

\begin{code}
instance Outputable ClosureTypeInfo where
   ppr = pprTypeInfo

instance Outputable SMRep where
   ppr (HeapRep static ps nps tyinfo)
     = hang (header <+> lbrace) 2 (ppr tyinfo <+> rbrace)
     where
       header = ptext (sLit "HeapRep")
                <+> if static then ptext (sLit "static") else empty
                <+> pp_n "ptrs" ps <+> pp_n "nonptrs" nps
       pp_n :: String -> Int -> SDoc
       pp_n _ 0 = empty
       pp_n s n = int n <+> text s

455 456
   ppr (ArrayPtrsRep size _) = ptext (sLit "ArrayPtrsRep") <+> ppr size

457 458
   ppr (StackRep bs) = ptext (sLit "StackRep") <+> ppr bs

459 460
   ppr (RTSRep ty rep) = ptext (sLit "tag:") <> ppr ty <+> ppr rep

461
instance Outputable ArgDescr where
462
  ppr (ArgSpec n) = ptext (sLit "ArgSpec") <+> ppr n
463
  ppr (ArgGen ls) = ptext (sLit "ArgGen") <+> ppr ls
464

465 466
pprTypeInfo :: ClosureTypeInfo -> SDoc
pprTypeInfo (Constr tag descr)
467
  = ptext (sLit "Con") <+>
468
    braces (sep [ ptext (sLit "tag:") <+> ppr tag
469 470 471
                , ptext (sLit "descr:") <> text (show descr) ])

pprTypeInfo (Fun arity args)
472
  = ptext (sLit "Fun") <+>
473
    braces (sep [ ptext (sLit "arity:") <+> ppr arity
474 475
                , ptext (sLit ("fun_type:")) <+> ppr args ])

476
pprTypeInfo (ThunkSelector offset)
477
  = ptext (sLit "ThunkSel") <+> ppr offset
478 479 480

pprTypeInfo Thunk     = ptext (sLit "Thunk")
pprTypeInfo BlackHole = ptext (sLit "BlackHole")
481
pprTypeInfo IndStatic = ptext (sLit "IndStatic")
482

Simon Marlow's avatar
Simon Marlow committed
483
-- XXX Does not belong here!!
484 485 486 487 488 489 490
stringToWord8s :: String -> [Word8]
stringToWord8s s = map (fromIntegral . ord) s

pprWord8String :: [Word8] -> SDoc
-- Debug printing.  Not very clever right now.
pprWord8String ws = text (show ws)
\end{code}