summaryrefslogtreecommitdiff
path: root/ghc/compiler/codeGen/SMRep.lhs
blob: 0e8f628d3f8ccdb3c0ba84a3917440851f2bc9a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
%
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[SMRep]{Storage manager representations of closure}

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

\begin{code}
module SMRep (
	SMRep(..), ClosureType(..),
	isConstantRep, isStaticRep,
	fixedHdrSize, arrHdrSize, fixedItblSize, pprSMRep

#ifndef OMIT_NATIVE_CODEGEN
	, getSMRepClosureTypeInt
	, cONSTR
	, cONSTR_1_0
	, cONSTR_0_1
	, cONSTR_2_0
	, cONSTR_1_1
	, cONSTR_0_2
	, cONSTR_STATIC
	, cONSTR_NOCAF_STATIC
	, fUN
	, fUN_1_0
	, fUN_0_1
	, fUN_2_0
	, fUN_1_1
	, fUN_0_2
	, fUN_STATIC
	, tHUNK
	, tHUNK_1_0
	, tHUNK_0_1
	, tHUNK_2_0
	, tHUNK_1_1
	, tHUNK_0_2
	, tHUNK_STATIC
	, tHUNK_SELECTOR
	, rET_SMALL
	, rET_VEC_SMALL
	, rET_BIG
	, rET_VEC_BIG
	, bLACKHOLE
#endif
    ) where

#include "HsVersions.h"

import CmdLineOpts
import AbsCSyn		( Liveness(..) )
import Constants	( sTD_HDR_SIZE, pROF_HDR_SIZE,
			  gRAN_HDR_SIZE, tICKY_HDR_SIZE, aRR_HDR_SIZE,
			  sTD_ITBL_SIZE, pROF_ITBL_SIZE,
			  gRAN_ITBL_SIZE, tICKY_ITBL_SIZE )
import Outputable
import GlaExts		( Int(..), Int#, (<#), (==#), (<#), (>#) )
\end{code}

%************************************************************************
%*									*
\subsubsection[SMRep-datatype]{@SMRep@---storage manager representation}
%*									*
%************************************************************************

\begin{code}
data SMRep
     -- static closure have an extra static link field at the end.
  = StaticRep
	Int		-- # ptr words (useful for interpreter, debugger, etc)
	Int		-- # non-ptr words
	ClosureType     -- closure type

  | GenericRep		-- GC routines consult sizes in info tbl
	Int		-- # ptr words
	Int		-- # non-ptr words
	ClosureType	-- closure type

  | ConstantRep		-- CONSTR with zero-arity

  | BlackHoleRep

data ClosureType
    = CONSTR
    | CONSTR_p_n Int Int
    | CONSTR_NOCAF
    | FUN
    | FUN_p_n Int Int
    | THUNK
    | THUNK_p_n Int Int
    | THUNK_SELECTOR
  deriving (Eq,Ord)

\end{code}

Size of a closure header.

\begin{code}
fixedHdrSize :: Int{-words-}
fixedHdrSize = sTD_HDR_SIZE + profHdrSize + granHdrSize + tickyHdrSize

profHdrSize  :: Int{-words-}
profHdrSize  | opt_SccProfilingOn   = pROF_HDR_SIZE
	     | otherwise	    = 0

granHdrSize  :: Int{-words-}
granHdrSize  | opt_GranMacros	    = gRAN_HDR_SIZE
	     | otherwise	    = 0

tickyHdrSize :: Int{-words-}
tickyHdrSize | opt_DoTickyProfiling = tICKY_HDR_SIZE
	     | otherwise	    = 0

arrHdrSize   :: Int{-words-}
arrHdrSize   = fixedHdrSize + aRR_HDR_SIZE
\end{code}

Size of an info table.

\begin{code}
fixedItblSize :: Int{-words-}
fixedItblSize = sTD_ITBL_SIZE + profItblSize + granItblSize + tickyItblSize

profItblSize  :: Int{-words-}
profItblSize  | opt_SccProfilingOn   = pROF_ITBL_SIZE
	      | otherwise	    = 0

granItblSize  :: Int{-words-}
granItblSize  | opt_GranMacros	    = gRAN_ITBL_SIZE
	      | otherwise	    = 0

tickyItblSize :: Int{-words-}
tickyItblSize | opt_DoTickyProfiling = tICKY_ITBL_SIZE
	      | otherwise	    = 0
\end{code}

\begin{code}
isConstantRep, isStaticRep :: SMRep -> Bool
isConstantRep ConstantRep     = True
isConstantRep other 	      = False

isStaticRep (StaticRep _ _ _) = True
isStaticRep _		      = False
\end{code}

\begin{code}
{- ToDo: needed? -}
instance Text SMRep where
    showsPrec d rep
      = showString (case rep of
	   StaticRep _ _ _   	                 -> "STATIC"
	   GenericRep _ _ _   	                 -> ""
	   ConstantRep				 -> "")

instance Outputable SMRep where
    ppr rep = pprSMRep rep

pprSMRep :: SMRep -> SDoc
pprSMRep (GenericRep _ _ t) 	= pprClosureType t
pprSMRep (StaticRep _ _ t)  	= pprClosureType t <> ptext SLIT("_STATIC")
pprSMRep ConstantRep        	= ptext SLIT("CONSTR_NOCAF_STATIC")
pprSMRep BlackHoleRep       	= ptext SLIT("BLACKHOLE")

pprClosureType CONSTR	   	= ptext SLIT("CONSTR")
pprClosureType (CONSTR_p_n p n) = ptext SLIT("CONSTR_") <> int p <> char '_' <> int n
pprClosureType CONSTR_NOCAF	= ptext SLIT("CONSTR_NOCAF")
pprClosureType FUN		= ptext SLIT("FUN")
pprClosureType (FUN_p_n p n)	= ptext SLIT("FUN_") <> int p <> char '_' <> int n
pprClosureType THUNK		= ptext SLIT("THUNK")
pprClosureType (THUNK_p_n p n)  = ptext SLIT("THUNK_") <> int p <> char '_' <> int n
pprClosureType THUNK_SELECTOR   = ptext SLIT("THUNK_SELECTOR")

#ifndef OMIT_NATIVE_CODEGEN
getSMRepClosureTypeInt :: SMRep -> Int
getSMRepClosureTypeInt (GenericRep _ _ t) =
  case t of
    CONSTR 	   -> cONSTR
    CONSTR_p_n 1 0 -> cONSTR_1_0
    CONSTR_p_n 0 1 -> cONSTR_0_1
    CONSTR_p_n 2 0 -> cONSTR_2_0
    CONSTR_p_n 1 1 -> cONSTR_1_1
    CONSTR_p_n 0 2 -> cONSTR_0_2
    CONSTR_NOCAF   -> panic "getClosureTypeInt: CONSTR_NOCAF"
    FUN    	   -> fUN
    FUN_p_n 1 0    -> fUN_1_0
    FUN_p_n 0 1    -> fUN_0_1
    FUN_p_n 2 0    -> fUN_2_0
    FUN_p_n 1 1    -> fUN_1_1
    FUN_p_n 0 2    -> fUN_0_2
    THUNK  	   -> tHUNK
    THUNK_p_n 1 0  -> tHUNK_1_0
    THUNK_p_n 0 1  -> tHUNK_0_1
    THUNK_p_n 2 0  -> tHUNK_2_0
    THUNK_p_n 1 1  -> tHUNK_1_1
    THUNK_p_n 0 2  -> tHUNK_0_2
    THUNK_SELECTOR -> tHUNK_SELECTOR
getSMRepClosureTypeInt (StaticRep _ _ t) =
  case t of
    CONSTR 	   -> cONSTR_STATIC
    CONSTR_NOCAF   -> cONSTR_NOCAF_STATIC
    FUN    	   -> fUN_STATIC
    THUNK  	   -> tHUNK_STATIC
    THUNK_SELECTOR -> panic "getClosureTypeInt: THUNK_SELECTOR_STATIC"

getSMRepClosureTypeInt ConstantRep = cONSTR_NOCAF_STATIC

getSMRepClosureTypeInt BlackHoleRep = bLACKHOLE

-- Just the ones we need:

#include "../includes/ClosureTypes.h"

cONSTR                  = (CONSTR               :: Int)
cONSTR_1_0              = (CONSTR_1_0           :: Int)
cONSTR_0_1              = (CONSTR_0_1           :: Int)
cONSTR_2_0              = (CONSTR_2_0           :: Int)
cONSTR_1_1              = (CONSTR_1_1           :: Int)
cONSTR_0_2              = (CONSTR_0_2           :: Int)
cONSTR_STATIC           = (CONSTR_STATIC        :: Int)
cONSTR_NOCAF_STATIC     = (CONSTR_NOCAF_STATIC  :: Int)
fUN                     = (FUN                  :: Int)
fUN_1_0                 = (FUN_1_0              :: Int)
fUN_0_1                 = (FUN_0_1              :: Int)
fUN_2_0                 = (FUN_2_0              :: Int)
fUN_1_1                 = (FUN_1_1              :: Int)
fUN_0_2                 = (FUN_0_2              :: Int)
fUN_STATIC              = (FUN_STATIC           :: Int)
tHUNK                   = (THUNK                :: Int)
tHUNK_1_0               = (THUNK_1_0            :: Int)
tHUNK_0_1               = (THUNK_0_1            :: Int)
tHUNK_2_0               = (THUNK_2_0            :: Int)
tHUNK_1_1               = (THUNK_1_1            :: Int)
tHUNK_0_2               = (THUNK_0_2            :: Int)
tHUNK_STATIC            = (THUNK_STATIC         :: Int)
tHUNK_SELECTOR          = (THUNK_SELECTOR       :: Int)
rET_SMALL               = (RET_SMALL            :: Int)
rET_VEC_SMALL           = (RET_VEC_SMALL        :: Int)
rET_BIG                 = (RET_BIG              :: Int)
rET_VEC_BIG             = (RET_VEC_BIG          :: Int)
bLACKHOLE               = (BLACKHOLE            :: Int)

#endif OMIT_NATIVE_CODEGEN
\end{code}