( Literal(..) -- Exported to ParseIface
, mkMachInt, mkMachWord
, mkMachInt64, mkMachWord64
- , isLitLitLit, maybeLitLit, litIsDupable,
+ , litSize
+ , litIsDupable, litIsTrivial
, literalType, literalPrimRep
, hashLiteral
- , inIntRange, inWordRange, tARGET_MAX_INT
+ , inIntRange, inWordRange, tARGET_MAX_INT, inCharRange
+ , isZeroLit,
- , word2IntLit, int2WordLit, char2IntLit, int2CharLit
+ , word2IntLit, int2WordLit
+ , narrow8IntLit, narrow16IntLit, narrow32IntLit
+ , narrow8WordLit, narrow16WordLit, narrow32WordLit
+ , char2IntLit, int2CharLit
, float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit
- , addr2IntLit, int2AddrLit, float2DoubleLit, double2FloatLit
+ , nullAddrLit, float2DoubleLit, double2FloatLit
) where
#include "HsVersions.h"
intPrimTy, wordPrimTy, int64PrimTy, word64PrimTy
)
import PrimRep ( PrimRep(..) )
-import Type ( Type, typePrimRep )
-import PprType ( pprParendType )
-import CStrings ( charToC, charToEasyHaskell, pprFSInCStyle )
+import Type ( Type )
+import CStrings ( pprFSInCStyle )
import Outputable
-import Util ( thenCmp )
-
-import Ratio ( numerator, denominator )
-import FastString ( uniqueOfFS )
+import FastTypes
+import FastString
+import Binary
+
+import Ratio ( numerator )
+import FastString ( uniqueOfFS, lengthFS )
+import DATA_INT ( Int8, Int16, Int32 )
+import DATA_WORD ( Word8, Word16, Word32 )
import Char ( ord, chr )
\end{code}
tARGET_MAX_INT = 2147483647
#endif
tARGET_MAX_WORD = (tARGET_MAX_INT * 2) + 1
+
+tARGET_MAX_CHAR :: Int
+tARGET_MAX_CHAR = 0x10ffff
\end{code}
data Literal
= ------------------
-- First the primitive guys
- MachChar Char
- | MachStr FAST_STRING
+ MachChar Char -- Char# At least 31 bits
+ | MachStr FastString
- | MachAddr Integer -- Whatever this machine thinks is a "pointer"
+ | MachNullAddr -- the NULL pointer, the only pointer value
+ -- that can be represented as a Literal.
- | MachInt Integer -- Int# At least 32 bits
+ | MachInt Integer -- Int# At least WORD_SIZE_IN_BITS bits
| MachInt64 Integer -- Int64# At least 64 bits
- | MachWord Integer -- Word# At least 32 bits
+ | MachWord Integer -- Word# At least WORD_SIZE_IN_BITS bits
| MachWord64 Integer -- Word64# At least 64 bits
| MachFloat Rational
| MachDouble Rational
+ -- MachLabel is used (only) for the literal derived from a
+ -- "foreign label" declaration.
-- string argument is the name of a symbol. This literal
-- refers to the *address* of the label.
- | MachLabel FAST_STRING -- always an Addr#
+ | MachLabel FastString -- always an Addr#
+ (Maybe Int) -- the size (in bytes) of the arguments
+ -- the label expects. Only applicable with
+ -- 'stdcall' labels.
+ -- Just x => "@<x>" will be appended to label
+ -- name when emitting asm.
+\end{code}
- -- lit-lits only work for via-C compilation, hence they
- -- are deprecated. The string is emitted verbatim into
- -- the C file, and can therefore be any C expression,
- -- macro call, #defined constant etc.
- | MachLitLit FAST_STRING Type -- Type might be Addr# or Int# etc
+Binary instance
+
+\begin{code}
+instance Binary Literal where
+ put_ bh (MachChar aa) = do putByte bh 0; put_ bh aa
+ put_ bh (MachStr ab) = do putByte bh 1; put_ bh ab
+ put_ bh (MachNullAddr) = do putByte bh 2
+ put_ bh (MachInt ad) = do putByte bh 3; put_ bh ad
+ put_ bh (MachInt64 ae) = do putByte bh 4; put_ bh ae
+ put_ bh (MachWord af) = do putByte bh 5; put_ bh af
+ put_ bh (MachWord64 ag) = do putByte bh 6; put_ bh ag
+ put_ bh (MachFloat ah) = do putByte bh 7; put_ bh ah
+ put_ bh (MachDouble ai) = do putByte bh 8; put_ bh ai
+ put_ bh (MachLabel aj mb) = do putByte bh 9; put_ bh aj ; put_ bh mb
+ get bh = do
+ h <- getByte bh
+ case h of
+ 0 -> do
+ aa <- get bh
+ return (MachChar aa)
+ 1 -> do
+ ab <- get bh
+ return (MachStr ab)
+ 2 -> do
+ return (MachNullAddr)
+ 3 -> do
+ ad <- get bh
+ return (MachInt ad)
+ 4 -> do
+ ae <- get bh
+ return (MachInt64 ae)
+ 5 -> do
+ af <- get bh
+ return (MachWord af)
+ 6 -> do
+ ag <- get bh
+ return (MachWord64 ag)
+ 7 -> do
+ ah <- get bh
+ return (MachFloat ah)
+ 8 -> do
+ ai <- get bh
+ return (MachDouble ai)
+ 9 -> do
+ aj <- get bh
+ mb <- get bh
+ return (MachLabel aj mb)
\end{code}
\begin{code}
\begin{code}
mkMachInt, mkMachWord, mkMachInt64, mkMachWord64 :: Integer -> Literal
-mkMachInt x = ASSERT2( inIntRange x, integer x ) MachInt x
-mkMachWord x = ASSERT2( inWordRange x, integer x ) MachWord x
-mkMachInt64 x = MachInt64 x -- Assertions?
-mkMachWord64 x = MachWord64 x -- Ditto?
+mkMachInt x = -- ASSERT2( inIntRange x, integer x )
+ -- Not true: you can write out of range Int# literals
+ -- For example, one can write (intToWord# 0xffff0000) to
+ -- get a particular Word bit-pattern, and there's no other
+ -- convenient way to write such literals, which is why we allow it.
+ MachInt x
+mkMachWord x = -- ASSERT2( inWordRange x, integer x )
+ MachWord x
+mkMachInt64 x = MachInt64 x
+mkMachWord64 x = MachWord64 x
inIntRange, inWordRange :: Integer -> Bool
inIntRange x = x >= tARGET_MIN_INT && x <= tARGET_MAX_INT
inWordRange x = x >= 0 && x <= tARGET_MAX_WORD
+
+inCharRange :: Char -> Bool
+inCharRange c = c >= '\0' && c <= chr tARGET_MAX_CHAR
+
+isZeroLit :: Literal -> Bool
+isZeroLit (MachInt 0) = True
+isZeroLit (MachInt64 0) = True
+isZeroLit (MachWord 0) = True
+isZeroLit (MachWord64 0) = True
+isZeroLit (MachFloat 0) = True
+isZeroLit (MachDouble 0) = True
+isZeroLit other = False
\end{code}
Coercions
~~~~~~~~~
\begin{code}
-word2IntLit, int2WordLit, char2IntLit, int2CharLit,
- float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit,
- addr2IntLit, int2AddrLit, float2DoubleLit, double2FloatLit :: Literal -> Literal
+word2IntLit, int2WordLit,
+ narrow8IntLit, narrow16IntLit, narrow32IntLit,
+ narrow8WordLit, narrow16WordLit, narrow32WordLit,
+ char2IntLit, int2CharLit,
+ float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit,
+ float2DoubleLit, double2FloatLit
+ :: Literal -> Literal
word2IntLit (MachWord w)
- | w > tARGET_MAX_INT = MachInt ((-1) + tARGET_MAX_WORD - w)
+ | w > tARGET_MAX_INT = MachInt (w - tARGET_MAX_WORD - 1)
| otherwise = MachInt w
int2WordLit (MachInt i)
| i < 0 = MachWord (1 + tARGET_MAX_WORD + i) -- (-1) ---> tARGET_MAX_WORD
| otherwise = MachWord i
+narrow8IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int8))
+narrow16IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int16))
+narrow32IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int32))
+narrow8WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word8))
+narrow16WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word16))
+narrow32WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word32))
+
char2IntLit (MachChar c) = MachInt (toInteger (ord c))
int2CharLit (MachInt i) = MachChar (chr (fromInteger i))
float2IntLit (MachFloat f) = MachInt (truncate f)
int2FloatLit (MachInt i) = MachFloat (fromInteger i)
-double2IntLit (MachFloat f) = MachInt (truncate f)
+double2IntLit (MachDouble f) = MachInt (truncate f)
int2DoubleLit (MachInt i) = MachDouble (fromInteger i)
-addr2IntLit (MachAddr a) = MachInt a
-int2AddrLit (MachInt i) = MachAddr i
-
float2DoubleLit (MachFloat f) = MachDouble f
double2FloatLit (MachDouble d) = MachFloat d
+
+nullAddrLit :: Literal
+nullAddrLit = MachNullAddr
\end{code}
Predicates
~~~~~~~~~~
\begin{code}
-isLitLitLit (MachLitLit _ _) = True
-isLitLitLit _ = False
-
-maybeLitLit (MachLitLit s t) = Just (s,t)
-maybeLitLit _ = Nothing
+litIsTrivial :: Literal -> Bool
+-- True if there is absolutely no penalty to duplicating the literal
+-- c.f. CoreUtils.exprIsTrivial
+-- False principally of strings
+litIsTrivial (MachStr _) = False
+litIsTrivial other = True
litIsDupable :: Literal -> Bool
- -- True if code space does not go bad if we duplicate this literal
- -- False principally of strings
+-- True if code space does not go bad if we duplicate this literal
+-- c.f. CoreUtils.exprIsDupable
+-- Currently we treat it just like litIsTrivial
litIsDupable (MachStr _) = False
litIsDupable other = True
+
+litSize :: Literal -> Int
+-- Used by CoreUnfold.sizeExpr
+litSize (MachStr str) = 1 + ((lengthFS str + 3) `div` 4)
+ -- Every literal has size at least 1, otherwise
+ -- f "x"
+ -- might be too small
+ -- [Sept03: make literal strings a bit bigger to avoid fruitless
+ -- duplication of little strings]
+litSize _other = 1
\end{code}
Types
literalType :: Literal -> Type
literalType (MachChar _) = charPrimTy
literalType (MachStr _) = addrPrimTy
-literalType (MachAddr _) = addrPrimTy
+literalType (MachNullAddr) = addrPrimTy
literalType (MachInt _) = intPrimTy
literalType (MachWord _) = wordPrimTy
literalType (MachInt64 _) = int64PrimTy
literalType (MachWord64 _) = word64PrimTy
literalType (MachFloat _) = floatPrimTy
literalType (MachDouble _) = doublePrimTy
-literalType (MachLabel _) = addrPrimTy
-literalType (MachLitLit _ ty) = ty
+literalType (MachLabel _ _) = addrPrimTy
\end{code}
\begin{code}
literalPrimRep (MachChar _) = CharRep
literalPrimRep (MachStr _) = AddrRep -- specifically: "char *"
-literalPrimRep (MachAddr _) = AddrRep
+literalPrimRep (MachNullAddr) = AddrRep
literalPrimRep (MachInt _) = IntRep
literalPrimRep (MachWord _) = WordRep
literalPrimRep (MachInt64 _) = Int64Rep
literalPrimRep (MachWord64 _) = Word64Rep
literalPrimRep (MachFloat _) = FloatRep
literalPrimRep (MachDouble _) = DoubleRep
-literalPrimRep (MachLabel _) = AddrRep
-literalPrimRep (MachLitLit _ ty) = typePrimRep ty
+literalPrimRep (MachLabel _ _) = AddrRep
\end{code}
\begin{code}
cmpLit (MachChar a) (MachChar b) = a `compare` b
cmpLit (MachStr a) (MachStr b) = a `compare` b
-cmpLit (MachAddr a) (MachAddr b) = a `compare` b
+cmpLit (MachNullAddr) (MachNullAddr) = EQ
cmpLit (MachInt a) (MachInt b) = a `compare` b
cmpLit (MachWord a) (MachWord b) = a `compare` b
cmpLit (MachInt64 a) (MachInt64 b) = a `compare` b
cmpLit (MachWord64 a) (MachWord64 b) = a `compare` b
cmpLit (MachFloat a) (MachFloat b) = a `compare` b
cmpLit (MachDouble a) (MachDouble b) = a `compare` b
-cmpLit (MachLabel a) (MachLabel b) = a `compare` b
-cmpLit (MachLitLit a b) (MachLitLit c d) = (a `compare` c) `thenCmp` (b `compare` d)
-cmpLit lit1 lit2 | litTag lit1 _LT_ litTag lit2 = LT
- | otherwise = GT
-
-litTag (MachChar _) = ILIT(1)
-litTag (MachStr _) = ILIT(2)
-litTag (MachAddr _) = ILIT(3)
-litTag (MachInt _) = ILIT(4)
-litTag (MachWord _) = ILIT(5)
-litTag (MachInt64 _) = ILIT(6)
-litTag (MachWord64 _) = ILIT(7)
-litTag (MachFloat _) = ILIT(8)
-litTag (MachDouble _) = ILIT(9)
-litTag (MachLabel _) = ILIT(10)
-litTag (MachLitLit _ _) = ILIT(11)
+cmpLit (MachLabel a _) (MachLabel b _) = a `compare` b
+cmpLit lit1 lit2 | litTag lit1 <# litTag lit2 = LT
+ | otherwise = GT
+
+litTag (MachChar _) = _ILIT(1)
+litTag (MachStr _) = _ILIT(2)
+litTag (MachNullAddr) = _ILIT(3)
+litTag (MachInt _) = _ILIT(4)
+litTag (MachWord _) = _ILIT(5)
+litTag (MachInt64 _) = _ILIT(6)
+litTag (MachWord64 _) = _ILIT(7)
+litTag (MachFloat _) = _ILIT(8)
+litTag (MachDouble _) = _ILIT(9)
+litTag (MachLabel _ _) = _ILIT(10)
\end{code}
Printing
~~~~~~~~
* MachX (i.e. unboxed) things are printed unadornded (e.g. 3, 'a', "foo")
- exceptions: MachFloat and MachAddr get an initial keyword prefix
+ exceptions: MachFloat gets an initial keyword prefix.
\begin{code}
pprLit lit
= getPprStyle $ \ sty ->
let
code_style = codeStyle sty
- iface_style = ifaceStyle sty
in
case lit of
- MachChar ch | code_style -> hcat [ptext SLIT("(C_)"), char '\'',
- text (charToC ch), char '\'']
- | iface_style -> char '\'' <> text (charToEasyHaskell ch) <> char '\''
- | otherwise -> text ['\'', ch, '\'']
+ MachChar ch | code_style -> hcat [ptext SLIT("(C_)"), text (show (ord ch))]
+ | otherwise -> pprHsChar ch
MachStr s | code_style -> pprFSInCStyle s
- | otherwise -> pprFSAsString s
+ | otherwise -> pprHsString s
+ -- Warning: printing MachStr in code_style assumes it contains
+ -- only characters '\0'..'\xFF'!
MachInt i | code_style && i == tARGET_MIN_INT -> parens (integer (i+1) <> text "-1")
-- Avoid a problem whereby gcc interprets
MachWord64 w | code_style -> pprHexVal w
| otherwise -> ptext SLIT("__word64") <+> integer w
- MachFloat f | code_style -> ptext SLIT("(StgFloat)") <> rational f
+ MachFloat f | code_style -> ptext SLIT("(StgFloat)") <> code_rational f
| otherwise -> ptext SLIT("__float") <+> rational f
- MachDouble d | iface_style && d < 0 -> parens (rational d)
- | otherwise -> rational d
+ MachDouble d | code_style -> code_rational d
+ | otherwise -> rational d
- MachAddr p | code_style -> ptext SLIT("(void*)") <> integer p
- | otherwise -> ptext SLIT("__addr") <+> integer p
+ MachNullAddr | code_style -> ptext SLIT("(void*)0")
+ | otherwise -> ptext SLIT("__NULL")
- MachLabel l | code_style -> ptext SLIT("(&") <> ptext l <> char ')'
- | otherwise -> ptext SLIT("__label") <+> pprFSAsString l
+ MachLabel l mb
+ | code_style -> ptext SLIT("(&") <> ftext l <> char ')'
+ | otherwise -> ptext SLIT("__label") <+>
+ case mb of
+ Nothing -> pprHsString l
+ Just x -> doubleQuotes (text (unpackFS l ++ '@':show x))
- MachLitLit s ty | code_style -> ptext s
- | otherwise -> parens (hsep [ptext SLIT("__litlit"),
- pprFSAsString s,
- pprParendType ty])
+-- negative floating literals in code style need parentheses to avoid
+-- interacting with surrounding syntax.
+code_rational d | d < 0 = parens (rational d)
+ | otherwise = rational d
pprIntVal :: Integer -> SDoc
-- Print negative integers with parens to be sure it's unambiguous
hashLiteral :: Literal -> Int
hashLiteral (MachChar c) = ord c + 1000 -- Keep it out of range of common ints
hashLiteral (MachStr s) = hashFS s
-hashLiteral (MachAddr i) = hashInteger i
+hashLiteral (MachNullAddr) = 0
hashLiteral (MachInt i) = hashInteger i
hashLiteral (MachInt64 i) = hashInteger i
hashLiteral (MachWord i) = hashInteger i
hashLiteral (MachWord64 i) = hashInteger i
hashLiteral (MachFloat r) = hashRational r
hashLiteral (MachDouble r) = hashRational r
-hashLiteral (MachLabel s) = hashFS s
-hashLiteral (MachLitLit s _) = hashFS s
+hashLiteral (MachLabel s _) = hashFS s
hashRational :: Rational -> Int
hashRational r = hashInteger (numerator r)
-- The 1+ is to avoid zero, which is a Bad Number
-- since we use * to combine hash values
-hashFS :: FAST_STRING -> Int
-hashFS s = IBOX( uniqueOfFS s )
+hashFS :: FastString -> Int
+hashFS s = iBox (uniqueOfFS s)
\end{code}