2 % (c) The GRASP/AQUA Project, Glasgow University, 1998
4 \section[Literal]{@Literal@: Machine literals (unboxed, of course)}
8 ( Literal(..) -- Exported to ParseIface
9 , mkMachInt, mkMachWord
10 , mkMachInt64, mkMachWord64
11 , isLitLitLit, maybeLitLit, litSize, litIsDupable,
12 , literalType, literalPrimRep
15 , inIntRange, inWordRange, tARGET_MAX_INT, inCharRange
17 , word2IntLit, int2WordLit
18 , narrow8IntLit, narrow16IntLit, narrow32IntLit
19 , narrow8WordLit, narrow16WordLit, narrow32WordLit
20 , char2IntLit, int2CharLit
21 , float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit
22 , nullAddrLit, float2DoubleLit, double2FloatLit
25 #include "HsVersions.h"
27 import TysPrim ( charPrimTy, addrPrimTy, floatPrimTy, doublePrimTy,
28 intPrimTy, wordPrimTy, int64PrimTy, word64PrimTy
30 import PrimRep ( PrimRep(..) )
31 import TcType ( Type, tcCmpType )
32 import Type ( typePrimRep )
33 import PprType ( pprParendType )
34 import CStrings ( pprFSInCStyle )
38 import Util ( thenCmp )
40 import Ratio ( numerator )
41 import FastString ( uniqueOfFS, lengthFS )
42 import Int ( Int8, Int16, Int32 )
43 import Word ( Word8, Word16, Word32 )
44 import Char ( ord, chr )
49 %************************************************************************
53 %************************************************************************
55 If we're compiling with GHC (and we're not cross-compiling), then we
56 know that minBound and maxBound :: Int are the right values for the
57 target architecture. Otherwise, we assume -2^31 and 2^31-1
58 respectively (which will be wrong on a 64-bit machine).
61 tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD :: Integer
62 #if __GLASGOW_HASKELL__
63 tARGET_MIN_INT = toInteger (minBound :: Int)
64 tARGET_MAX_INT = toInteger (maxBound :: Int)
66 tARGET_MIN_INT = -2147483648
67 tARGET_MAX_INT = 2147483647
69 tARGET_MAX_WORD = (tARGET_MAX_INT * 2) + 1
71 tARGET_MAX_CHAR :: Int
72 tARGET_MAX_CHAR = 0x10ffff
76 %************************************************************************
80 %************************************************************************
82 So-called @Literals@ are {\em either}:
85 An unboxed (``machine'') literal (type: @IntPrim@, @FloatPrim@, etc.),
86 which is presumed to be surrounded by appropriate constructors
87 (@mKINT@, etc.), so that the overall thing makes sense.
89 An Integer, Rational, or String literal whose representation we are
90 {\em uncommitted} about; i.e., the surrounding with constructors,
91 function applications, etc., etc., has not yet been done.
97 -- First the primitive guys
98 MachChar Int -- Char# At least 31 bits
101 | MachAddr Integer -- Whatever this machine thinks is a "pointer"
103 | MachInt Integer -- Int# At least WORD_SIZE_IN_BITS bits
104 | MachInt64 Integer -- Int64# At least 64 bits
105 | MachWord Integer -- Word# At least WORD_SIZE_IN_BITS bits
106 | MachWord64 Integer -- Word64# At least 64 bits
109 | MachDouble Rational
111 -- MachLabel is used (only) for the literal derived from a
112 -- "foreign label" declaration.
113 -- string argument is the name of a symbol. This literal
114 -- refers to the *address* of the label.
115 | MachLabel FAST_STRING -- always an Addr#
117 -- lit-lits only work for via-C compilation, hence they
118 -- are deprecated. The string is emitted verbatim into
119 -- the C file, and can therefore be any C expression,
120 -- macro call, #defined constant etc.
121 | MachLitLit FAST_STRING Type -- Type might be Addr# or Int# etc
125 instance Outputable Literal where
128 instance Show Literal where
129 showsPrec p lit = showsPrecSDoc p (ppr lit)
131 instance Eq Literal where
132 a == b = case (a `compare` b) of { EQ -> True; _ -> False }
133 a /= b = case (a `compare` b) of { EQ -> False; _ -> True }
135 instance Ord Literal where
136 a <= b = case (a `compare` b) of { LT -> True; EQ -> True; GT -> False }
137 a < b = case (a `compare` b) of { LT -> True; EQ -> False; GT -> False }
138 a >= b = case (a `compare` b) of { LT -> False; EQ -> True; GT -> True }
139 a > b = case (a `compare` b) of { LT -> False; EQ -> False; GT -> True }
140 compare a b = cmpLit a b
147 mkMachInt, mkMachWord, mkMachInt64, mkMachWord64 :: Integer -> Literal
149 mkMachInt x = -- ASSERT2( inIntRange x, integer x )
150 -- not true: you can write out of range Int# literals
152 mkMachWord x = -- ASSERT2( inWordRange x, integer x )
154 mkMachInt64 x = MachInt64 x
155 mkMachWord64 x = MachWord64 x
157 inIntRange, inWordRange :: Integer -> Bool
158 inIntRange x = x >= tARGET_MIN_INT && x <= tARGET_MAX_INT
159 inWordRange x = x >= 0 && x <= tARGET_MAX_WORD
161 inCharRange :: Int -> Bool
162 inCharRange c = c >= 0 && c <= tARGET_MAX_CHAR
168 word2IntLit, int2WordLit,
169 narrow8IntLit, narrow16IntLit, narrow32IntLit,
170 narrow8WordLit, narrow16WordLit, narrow32WordLit,
171 char2IntLit, int2CharLit,
172 float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit,
173 float2DoubleLit, double2FloatLit
174 :: Literal -> Literal
176 word2IntLit (MachWord w)
177 | w > tARGET_MAX_INT = MachInt (w - tARGET_MAX_WORD - 1)
178 | otherwise = MachInt w
180 int2WordLit (MachInt i)
181 | i < 0 = MachWord (1 + tARGET_MAX_WORD + i) -- (-1) ---> tARGET_MAX_WORD
182 | otherwise = MachWord i
184 narrow8IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int8))
185 narrow16IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int16))
186 narrow32IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int32))
187 narrow8WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word8))
188 narrow16WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word16))
189 narrow32WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word32))
191 char2IntLit (MachChar c) = MachInt (toInteger c)
192 int2CharLit (MachInt i) = MachChar (fromInteger i)
194 float2IntLit (MachFloat f) = MachInt (truncate f)
195 int2FloatLit (MachInt i) = MachFloat (fromInteger i)
197 double2IntLit (MachDouble f) = MachInt (truncate f)
198 int2DoubleLit (MachInt i) = MachDouble (fromInteger i)
200 float2DoubleLit (MachFloat f) = MachDouble f
201 double2FloatLit (MachDouble d) = MachFloat d
203 nullAddrLit :: Literal
204 nullAddrLit = MachAddr 0
210 isLitLitLit (MachLitLit _ _) = True
211 isLitLitLit _ = False
213 maybeLitLit (MachLitLit s t) = Just (s,t)
214 maybeLitLit _ = Nothing
216 litIsDupable :: Literal -> Bool
217 -- True if code space does not go bad if we duplicate this literal
218 -- False principally of strings
219 litIsDupable (MachStr _) = False
220 litIsDupable other = True
222 litSize :: Literal -> Int
223 -- used by CoreUnfold.sizeExpr
224 litSize (MachStr str) = lengthFS str `div` 4
231 literalType :: Literal -> Type
232 literalType (MachChar _) = charPrimTy
233 literalType (MachStr _) = addrPrimTy
234 literalType (MachAddr _) = addrPrimTy
235 literalType (MachInt _) = intPrimTy
236 literalType (MachWord _) = wordPrimTy
237 literalType (MachInt64 _) = int64PrimTy
238 literalType (MachWord64 _) = word64PrimTy
239 literalType (MachFloat _) = floatPrimTy
240 literalType (MachDouble _) = doublePrimTy
241 literalType (MachLabel _) = addrPrimTy
242 literalType (MachLitLit _ ty) = ty
246 literalPrimRep :: Literal -> PrimRep
248 literalPrimRep (MachChar _) = CharRep
249 literalPrimRep (MachStr _) = AddrRep -- specifically: "char *"
250 literalPrimRep (MachAddr _) = AddrRep
251 literalPrimRep (MachInt _) = IntRep
252 literalPrimRep (MachWord _) = WordRep
253 literalPrimRep (MachInt64 _) = Int64Rep
254 literalPrimRep (MachWord64 _) = Word64Rep
255 literalPrimRep (MachFloat _) = FloatRep
256 literalPrimRep (MachDouble _) = DoubleRep
257 literalPrimRep (MachLabel _) = AddrRep
258 literalPrimRep (MachLitLit _ ty) = typePrimRep ty
265 cmpLit (MachChar a) (MachChar b) = a `compare` b
266 cmpLit (MachStr a) (MachStr b) = a `compare` b
267 cmpLit (MachAddr a) (MachAddr b) = a `compare` b
268 cmpLit (MachInt a) (MachInt b) = a `compare` b
269 cmpLit (MachWord a) (MachWord b) = a `compare` b
270 cmpLit (MachInt64 a) (MachInt64 b) = a `compare` b
271 cmpLit (MachWord64 a) (MachWord64 b) = a `compare` b
272 cmpLit (MachFloat a) (MachFloat b) = a `compare` b
273 cmpLit (MachDouble a) (MachDouble b) = a `compare` b
274 cmpLit (MachLabel a) (MachLabel b) = a `compare` b
275 cmpLit (MachLitLit a b) (MachLitLit c d) = (a `compare` c) `thenCmp` (b `tcCmpType` d)
276 cmpLit lit1 lit2 | litTag lit1 <# litTag lit2 = LT
279 litTag (MachChar _) = _ILIT(1)
280 litTag (MachStr _) = _ILIT(2)
281 litTag (MachAddr _) = _ILIT(3)
282 litTag (MachInt _) = _ILIT(4)
283 litTag (MachWord _) = _ILIT(5)
284 litTag (MachInt64 _) = _ILIT(6)
285 litTag (MachWord64 _) = _ILIT(7)
286 litTag (MachFloat _) = _ILIT(8)
287 litTag (MachDouble _) = _ILIT(9)
288 litTag (MachLabel _) = _ILIT(10)
289 litTag (MachLitLit _ _) = _ILIT(11)
294 * MachX (i.e. unboxed) things are printed unadornded (e.g. 3, 'a', "foo")
295 exceptions: MachFloat and MachAddr get an initial keyword prefix
299 = getPprStyle $ \ sty ->
301 code_style = codeStyle sty
302 iface_style = ifaceStyle sty
305 MachChar ch | code_style -> hcat [ptext SLIT("(C_)"), text (show ch)]
306 | otherwise -> pprHsChar ch
308 MachStr s | code_style -> pprFSInCStyle s
309 | otherwise -> pprHsString s
310 -- Warning: printing MachStr in code_style assumes it contains
311 -- only characters '\0'..'\xFF'!
313 MachInt i | code_style && i == tARGET_MIN_INT -> parens (integer (i+1) <> text "-1")
314 -- Avoid a problem whereby gcc interprets
315 -- the constant minInt as unsigned.
316 | otherwise -> pprIntVal i
318 MachInt64 i | code_style -> pprIntVal i -- Same problem with gcc???
319 | otherwise -> ptext SLIT("__int64") <+> integer i
321 MachWord w | code_style -> pprHexVal w
322 | otherwise -> ptext SLIT("__word") <+> integer w
324 MachWord64 w | code_style -> pprHexVal w
325 | otherwise -> ptext SLIT("__word64") <+> integer w
327 MachFloat f | code_style -> ptext SLIT("(StgFloat)") <> rational f
328 | otherwise -> ptext SLIT("__float") <+> rational f
330 MachDouble d | iface_style && d < 0 -> parens (rational d)
331 | otherwise -> rational d
333 MachAddr p | code_style -> ptext SLIT("(void*)") <> integer p
334 | otherwise -> ptext SLIT("__addr") <+> integer p
336 MachLabel l | code_style -> ptext SLIT("(&") <> ptext l <> char ')'
337 | otherwise -> ptext SLIT("__label") <+> pprHsString l
339 MachLitLit s ty | code_style -> ptext s
340 | otherwise -> parens (hsep [ptext SLIT("__litlit"),
344 pprIntVal :: Integer -> SDoc
345 -- Print negative integers with parens to be sure it's unambiguous
346 pprIntVal i | i < 0 = parens (integer i)
347 | otherwise = integer i
349 pprHexVal :: Integer -> SDoc
350 -- Print in C hex format: 0x13fa
351 pprHexVal 0 = ptext SLIT("0x0")
352 pprHexVal w = ptext SLIT("0x") <> go w
355 go w = go quot <> dig
357 (quot,rem) = w `quotRem` 16
358 dig | rem < 10 = char (chr (fromInteger rem + ord '0'))
359 | otherwise = char (chr (fromInteger rem - 10 + ord 'a'))
363 %************************************************************************
367 %************************************************************************
369 Hash values should be zero or a positive integer. No negatives please.
370 (They mess up the UniqFM for some reason.)
373 hashLiteral :: Literal -> Int
374 hashLiteral (MachChar c) = c + 1000 -- Keep it out of range of common ints
375 hashLiteral (MachStr s) = hashFS s
376 hashLiteral (MachAddr i) = hashInteger i
377 hashLiteral (MachInt i) = hashInteger i
378 hashLiteral (MachInt64 i) = hashInteger i
379 hashLiteral (MachWord i) = hashInteger i
380 hashLiteral (MachWord64 i) = hashInteger i
381 hashLiteral (MachFloat r) = hashRational r
382 hashLiteral (MachDouble r) = hashRational r
383 hashLiteral (MachLabel s) = hashFS s
384 hashLiteral (MachLitLit s _) = hashFS s
386 hashRational :: Rational -> Int
387 hashRational r = hashInteger (numerator r)
389 hashInteger :: Integer -> Int
390 hashInteger i = 1 + abs (fromInteger (i `rem` 10000))
391 -- The 1+ is to avoid zero, which is a Bad Number
392 -- since we use * to combine hash values
394 hashFS :: FAST_STRING -> Int
395 hashFS s = iBox (uniqueOfFS s)