SMRep.lhs 14.6 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 9 10 11

This is here, rather than in ClosureInfo, just to keep nhc happy.
Other modules should access this info through ClosureInfo.

\begin{code}
12 13
{-# LANGUAGE GeneralizedNewtypeDeriving #-}

14
module SMRep (
Simon Marlow's avatar
Simon Marlow committed
15
        -- * Words and bytes
16
        StgWord, fromStgWord, toStgWord,
17
        StgHalfWord, fromStgHalfWord, toStgHalfWord,
18 19
        hALF_WORD_SIZE, hALF_WORD_SIZE_IN_BITS,
        WordOff, ByteOff,
20
        roundUpToWords,
21

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

        -- ** Construction
29
        mkHeapRep, blackHoleRep, mkStackRep, mkRTSRep,
30

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

        -- ** Size-related things
35 36 37 38
        heapClosureSize,
        fixedHdrSize, arrWordsHdrSize, arrPtrsHdrSize,
        profHdrSize, thunkHdrSize, nonHdrSize,

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

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

47
#include "../HsVersions.h"
48
#include "../includes/MachDeps.h"
49

50
import DynFlags
sof's avatar
sof committed
51
import Outputable
52
import Platform
53
import FastString
54

55
import Data.Array.Base
56
import Data.Char( ord )
Simon Marlow's avatar
Simon Marlow committed
57
import Data.Word
58
import Data.Bits
59 60
\end{code}

61 62

%************************************************************************
63 64 65
%*                                                                      *
                Words and bytes
%*                                                                      *
66 67 68
%************************************************************************

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

72 73
roundUpToWords :: DynFlags -> ByteOff -> ByteOff
roundUpToWords dflags n = (n + (wORD_SIZE dflags - 1)) .&. (complement (wORD_SIZE dflags - 1))
74 75 76 77 78
\end{code}

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

\begin{code}
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
newtype StgWord = StgWord Word64
    deriving (Eq,
#if __GLASGOW_HASKELL__ < 706
              Num,
#endif
              Bits, IArray UArray)

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)

--

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
newtype StgHalfWord = StgHalfWord Integer
    deriving Eq

fromStgHalfWord :: StgHalfWord -> Integer
fromStgHalfWord (StgHalfWord i) = i

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

instance Outputable StgHalfWord where
    ppr (StgHalfWord i) = integer i

ian@well-typed.com's avatar
ian@well-typed.com committed
121 122 123 124
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
125 126
\end{code}

127

128
%************************************************************************
129
%*                                                                      *
130
\subsubsection[SMRep-datatype]{@SMRep@---storage manager representation}
131
%*                                                                      *
132 133 134
%************************************************************************

\begin{code}
135 136
-- | A description of the layout of a closure.  Corresponds directly
-- to the closure types in includes/rts/storage/ClosureTypes.h.
137
data SMRep
138 139 140 141 142 143 144 145 146
  = 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

  | StackRep            -- Stack frame (RET_SMALL or RET_BIG)
        Liveness

147 148 149 150
  | RTSRep              -- The RTS needs to declare info tables with specific
        StgHalfWord     -- type tags, so this form lets us override the default
        SMRep           -- tag for an SMRep.

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
-- | 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

type ConstrTag         = StgHalfWord
type ConstrDescription = [Word8] -- result of dataConIdentity
type FunArity          = StgHalfWord
type SelectorOffset    = StgWord

-------------------------
-- 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.
175
--
176 177
-- In the compiled program, liveness bitmaps that fit inside a single
-- word (StgWord) are stored as a single word, while larger bitmaps are
178
-- stored as a pointer to an array of words.
179 180 181 182 183 184 185 186

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
187 188
  = ArgSpec             -- Fits one of the standard patterns
        !StgHalfWord    -- RTS type identifier ARG_P, ARG_N, ...
189

190 191
  | ArgGen              -- General case
        Liveness        -- Details about the arguments
192 193 194 195 196


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

197 198 199
mkHeapRep :: DynFlags -> IsStatic -> WordOff -> WordOff -> ClosureTypeInfo
          -> SMRep
mkHeapRep dflags is_static ptr_wds nonptr_wds cl_type_info
200 201 202 203 204 205 206
  = HeapRep is_static
            ptr_wds
            (nonptr_wds + slop_wds)
            cl_type_info
  where
     slop_wds
      | is_static = 0
207
      | otherwise = max 0 (minClosureSize dflags - (hdr_size + payload_size))
208

209
     hdr_size     = closureTypeHdrSize dflags cl_type_info
210
     payload_size = ptr_wds + nonptr_wds
211

212 213
mkRTSRep :: StgHalfWord -> SMRep -> SMRep
mkRTSRep = RTSRep
214 215

mkStackRep :: [Bool] -> SMRep
216
mkStackRep liveness = StackRep liveness
217 218 219 220

blackHoleRep :: SMRep
blackHoleRep = HeapRep False 0 0 BlackHole

Simon Marlow's avatar
Simon Marlow committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
-----------------------------------------------------------------------------
-- Predicates

isStaticRep :: SMRep -> IsStatic
isStaticRep (HeapRep is_static _ _ _) = is_static
isStaticRep (StackRep {})             = False
isStaticRep (RTSRep _ rep)            = isStaticRep rep

isConRep :: SMRep -> Bool
isConRep (HeapRep _ _ _ Constr{}) = True
isConRep _                        = False

isThunkRep :: SMRep -> Bool
isThunkRep (HeapRep _ _ _ Thunk{})         = True
isThunkRep (HeapRep _ _ _ ThunkSelector{}) = True
isThunkRep (HeapRep _ _ _ BlackHole{})     = True
isThunkRep _                               = False

Simon Marlow's avatar
Simon Marlow committed
239 240 241 242
isFunRep :: SMRep -> Bool
isFunRep (HeapRep _ _ _ Fun{}) = True
isFunRep _                     = False

Simon Marlow's avatar
Simon Marlow committed
243 244 245 246 247 248 249
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


250 251 252 253
-----------------------------------------------------------------------------
-- Size-related things

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

257 258
-- | Size of the profiling part of a closure header
-- (StgProfHeader in includes/rts/storage/Closures.h)
259 260
profHdrSize  :: DynFlags -> WordOff
profHdrSize dflags
261
 | dopt Opt_SccProfilingOn dflags = pROF_HDR_SIZE dflags
262
 | otherwise                      = 0
263

264 265 266
-- | The garbage collector requires that every closure is at least as
--   big as this.
minClosureSize :: DynFlags -> WordOff
267
minClosureSize dflags = fixedHdrSize dflags + mIN_PAYLOAD_SIZE dflags
268

269 270
arrWordsHdrSize :: DynFlags -> ByteOff
arrWordsHdrSize dflags
271
 = fixedHdrSize dflags * wORD_SIZE dflags + sIZEOF_StgArrWords_NoHdr dflags
272

273 274
arrPtrsHdrSize :: DynFlags -> ByteOff
arrPtrsHdrSize dflags
275
 = fixedHdrSize dflags * wORD_SIZE dflags + sIZEOF_StgMutArrPtrs_NoHdr dflags
276

277
-- Thunks have an extra header word on SMP, so the update doesn't
278
-- splat the payload.
279 280
thunkHdrSize :: DynFlags -> WordOff
thunkHdrSize dflags = fixedHdrSize dflags + smp_hdr
281
        where smp_hdr = sIZEOF_StgSMPThunkHeader dflags `quot` wORD_SIZE dflags
282

283

284 285 286
nonHdrSize :: SMRep -> WordOff
nonHdrSize (HeapRep _ p np _) = p + np
nonHdrSize (StackRep bs)      = length bs
287
nonHdrSize (RTSRep _ rep)     = nonHdrSize rep
288

289 290 291 292 293 294 295 296 297 298 299
heapClosureSize :: DynFlags -> SMRep -> WordOff
heapClosureSize dflags (HeapRep _ p np ty)
 = closureTypeHdrSize dflags ty + p + np
heapClosureSize _ _ = panic "SMRep.heapClosureSize"

closureTypeHdrSize :: DynFlags -> ClosureTypeInfo -> WordOff
closureTypeHdrSize dflags ty = case ty of
                  Thunk{}         -> thunkHdrSize dflags
                  ThunkSelector{} -> thunkHdrSize dflags
                  BlackHole{}     -> thunkHdrSize dflags
                  _               -> fixedHdrSize dflags
300 301 302 303 304
        -- 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.
305

306 307
-----------------------------------------------------------------------------
-- deriving the RTS closure type from an SMRep
308

309 310 311
#include "../includes/rts/storage/ClosureTypes.h"
#include "../includes/rts/storage/FunTypes.h"
-- Defines CONSTR, CONSTR_1_0 etc
312

313
-- | Derives the RTS closure type from an 'SMRep'
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
rtsClosureType :: DynFlags -> SMRep -> StgHalfWord
rtsClosureType dflags rep
    = toStgHalfWord dflags
    $ case rep of
      RTSRep ty _ -> fromStgHalfWord ty

      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

      _ -> panic "rtsClosureType"
353 354

-- We export these ones
355 356 357 358 359
rET_SMALL, rET_BIG, aRG_GEN, aRG_GEN_BIG :: DynFlags -> StgHalfWord
rET_SMALL   dflags = toStgHalfWord dflags RET_SMALL
rET_BIG     dflags = toStgHalfWord dflags RET_BIG
aRG_GEN     dflags = toStgHalfWord dflags ARG_GEN
aRG_GEN_BIG dflags = toStgHalfWord dflags ARG_GEN_BIG
360
\end{code}
361

362 363
Note [Static NoCaf constructors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
364
If we know that a top-level binding 'x' is not Caffy (ie no CAFs are
365 366 367 368
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.
369

370
Currently we don't do this; instead we treat nullary constructors
371
as non-Caffy, and the others as potentially Caffy.
372

373

374
%************************************************************************
375
%*                                                                      *
376
             Pretty printing of SMRep and friends
377
%*                                                                      *
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
%************************************************************************

\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

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

397 398
   ppr (RTSRep ty rep) = ptext (sLit "tag:") <> ppr ty <+> ppr rep

399
instance Outputable ArgDescr where
400
  ppr (ArgSpec n) = ptext (sLit "ArgSpec") <+> ppr n
401
  ppr (ArgGen ls) = ptext (sLit "ArgGen") <+> ppr ls
402

403 404
pprTypeInfo :: ClosureTypeInfo -> SDoc
pprTypeInfo (Constr tag descr)
405
  = ptext (sLit "Con") <+>
406
    braces (sep [ ptext (sLit "tag:") <+> ppr tag
407 408 409
                , ptext (sLit "descr:") <> text (show descr) ])

pprTypeInfo (Fun arity args)
410
  = ptext (sLit "Fun") <+>
411
    braces (sep [ ptext (sLit "arity:") <+> ppr arity
412 413
                , ptext (sLit ("fun_type:")) <+> ppr args ])

414
pprTypeInfo (ThunkSelector offset)
415
  = ptext (sLit "ThunkSel") <+> ppr offset
416 417 418 419

pprTypeInfo Thunk     = ptext (sLit "Thunk")
pprTypeInfo BlackHole = ptext (sLit "BlackHole")

Simon Marlow's avatar
Simon Marlow committed
420
-- XXX Does not belong here!!
421 422 423 424 425 426 427
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}