More work on the simplifier's inlining strategies
[ghc-hetmet.git] / compiler / prelude / PrelRules.lhs
index a03aff2..bc8c9b8 100644 (file)
@@ -20,7 +20,8 @@ module PrelRules ( primOpRules, builtinRules ) where
 #include "HsVersions.h"
 
 import CoreSyn
-import Id              ( mkWildId, idUnfolding )
+import MkCore          ( mkWildCase )
+import Id              ( realIdUnfolding )
 import Literal         ( Literal(..), mkMachInt, mkMachWord
                        , literalType
                        , word2IntLit, int2WordLit
@@ -34,7 +35,8 @@ import PrimOp         ( PrimOp(..), tagToEnumKey )
 import TysWiredIn      ( boolTy, trueDataConId, falseDataConId )
 import TyCon           ( tyConDataCons_maybe, isEnumerationTyCon, isNewTyCon )
 import DataCon         ( dataConTag, dataConTyCon, dataConWorkId, fIRST_TAG )
-import CoreUtils       ( cheapEqExpr, exprIsConApp_maybe )
+import CoreUtils       ( cheapEqExpr )
+import CoreUnfold      ( exprIsConApp_maybe )
 import Type            ( tyConAppTyCon, coreEqType )
 import OccName         ( occNameFS )
 import PrelNames       ( unpackCStringFoldrName, unpackCStringFoldrIdKey, hasKey,
@@ -44,6 +46,8 @@ import Name           ( Name, nameOccName )
 import Outputable
 import FastString
 import StaticFlags      ( opt_SimplExcessPrecision )
+import Constants
+
 import Data.Bits as Bits
 import Data.Word       ( Word )
 \end{code}
@@ -179,7 +183,7 @@ primOpRules op op_name = primop_rule op
     primop_rule WordEqOp       = relop (==)
     primop_rule WordNeOp       = relop (/=)
 
-    primop_rule other          = []
+    primop_rule _              = []
 
 
 \end{code}
@@ -220,7 +224,7 @@ cmpOp cmp l1 l2
     go (MachWord64 i1) (MachWord64 i2) = done (i1 `compare` i2)
     go (MachFloat i1)  (MachFloat i2)  = done (i1 `compare` i2)
     go (MachDouble i1) (MachDouble i2) = done (i1 `compare` i2)
-    go l1             l2              = Nothing
+    go _               _               = Nothing
 
 --------------------------
 
@@ -230,23 +234,23 @@ negOp (MachFloat f)    = Just (mkFloatVal (-f))
 negOp (MachDouble 0.0) = Nothing
 negOp (MachDouble d)   = Just (mkDoubleVal (-d))
 negOp (MachInt i)      = intResult (-i)
-negOp l                       = Nothing
+negOp _                = Nothing
 
 --------------------------
 intOp2 :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
 intOp2 op (MachInt i1) (MachInt i2) = intResult (i1 `op` i2)
-intOp2 op l1          l2           = Nothing           -- Could find LitLit
+intOp2 _  _            _            = Nothing -- Could find LitLit
 
 intOp2Z :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
 -- Like intOp2, but Nothing if i2=0
 intOp2Z op (MachInt i1) (MachInt i2)
   | i2 /= 0 = intResult (i1 `op` i2)
-intOp2Z op l1 l2 = Nothing             -- LitLit or zero dividend
+intOp2Z _ _ _ = Nothing                -- LitLit or zero dividend
 
 intShiftOp2 :: (Integer->Int->Integer) -> Literal -> Literal -> Maybe CoreExpr
        -- Shifts take an Int; hence second arg of op is Int
 intShiftOp2 op (MachInt i1) (MachInt i2) = intResult (i1 `op` fromInteger i2)
-intShiftOp2 op l1           l2           = Nothing 
+intShiftOp2 _  _            _            = Nothing 
 
 shiftRightLogical :: Integer -> Int -> Integer
 -- Shift right, putting zeros in rather than sign-propagating as Bits.shiftR would do
@@ -259,41 +263,51 @@ shiftRightLogical x n = fromIntegral (fromInteger x `shiftR` n :: Word)
 wordOp2 :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
 wordOp2 op (MachWord w1) (MachWord w2)
   = wordResult (w1 `op` w2)
-wordOp2 op l1 l2 = Nothing             -- Could find LitLit
+wordOp2 _ _ _ = Nothing                -- Could find LitLit
 
 wordOp2Z :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
 wordOp2Z op (MachWord w1) (MachWord w2)
   | w2 /= 0 = wordResult (w1 `op` w2)
-wordOp2Z op l1 l2 = Nothing    -- LitLit or zero dividend
+wordOp2Z _ _ _ = Nothing       -- LitLit or zero dividend
 
-wordBitOp2 op l1@(MachWord w1) l2@(MachWord w2)
+wordBitOp2 :: (Integer->Integer->Integer) -> Literal -> Literal
+           -> Maybe CoreExpr
+wordBitOp2 op (MachWord w1) (MachWord w2)
   = wordResult (w1 `op` w2)
-wordBitOp2 op l1 l2 = Nothing          -- Could find LitLit
+wordBitOp2 _ _ _ = Nothing             -- Could find LitLit
 
 wordShiftOp2 :: (Integer->Int->Integer) -> Literal -> Literal -> Maybe CoreExpr
        -- Shifts take an Int; hence second arg of op is Int
 wordShiftOp2 op (MachWord x) (MachInt n) 
   = wordResult (x `op` fromInteger n)
        -- Do the shift at type Integer
-wordShiftOp2 op l1 l2 = Nothing        
+wordShiftOp2 _ _ _ = Nothing   
 
 --------------------------
+floatOp2 :: (Rational -> Rational -> Rational) -> Literal -> Literal
+         -> Maybe (Expr CoreBndr)
 floatOp2  op (MachFloat f1) (MachFloat f2)
   = Just (mkFloatVal (f1 `op` f2))
-floatOp2  op l1 l2 = Nothing
+floatOp2 _ _ _ = Nothing
 
+floatOp2Z :: (Rational -> Rational -> Rational) -> Literal -> Literal
+          -> Maybe (Expr CoreBndr)
 floatOp2Z op (MachFloat f1) (MachFloat f2)
   | f2 /= 0   = Just (mkFloatVal (f1 `op` f2))
-floatOp2Z op l1 l2 = Nothing
+floatOp2Z _ _ _ = Nothing
 
 --------------------------
+doubleOp2 :: (Rational -> Rational -> Rational) -> Literal -> Literal
+          -> Maybe (Expr CoreBndr)
 doubleOp2  op (MachDouble f1) (MachDouble f2)
   = Just (mkDoubleVal (f1 `op` f2))
-doubleOp2 op l1 l2 = Nothing
+doubleOp2 _ _ _ = Nothing
 
+doubleOp2Z :: (Rational -> Rational -> Rational) -> Literal -> Literal
+           -> Maybe (Expr CoreBndr)
 doubleOp2Z op (MachDouble f1) (MachDouble f2)
   | f2 /= 0   = Just (mkDoubleVal (f1 `op` f2))
-doubleOp2Z op l1 l2 = Nothing
+doubleOp2Z _ _ _ = Nothing
 
 
 --------------------------
@@ -321,16 +335,16 @@ litEq :: Name
       -> [CoreRule]
 litEq op_name is_eq
   = [BuiltinRule { ru_name = occNameFS (nameOccName op_name) 
-                               `appendFS` FSLIT("->case"),
+                               `appendFS` (fsLit "->case"),
                   ru_fn = op_name, 
                   ru_nargs = 2, ru_try = rule_fn }]
   where
-    rule_fn [Lit lit, expr] = do_lit_eq lit expr
-    rule_fn [expr, Lit lit] = do_lit_eq lit expr
-    rule_fn other          = Nothing
+    rule_fn _ [Lit lit, expr] = do_lit_eq lit expr
+    rule_fn _ [expr, Lit lit] = do_lit_eq lit expr
+    rule_fn _ _              = Nothing
     
     do_lit_eq lit expr
-      = Just (Case expr (mkWildId (literalType lit)) boolTy
+      = Just (mkWildCase expr (literalType lit) boolTy
                    [(DEFAULT,    [], val_if_neq),
                     (LitAlt lit, [], val_if_eq)])
     val_if_eq  | is_eq     = trueVal
@@ -342,14 +356,14 @@ litEq op_name is_eq
 -- runtime either, and compilation of completely harmless things like
 --    ((124076834 :: Word32) + (2147483647 :: Word32))
 -- would yield a warning. Instead we simply squash the value into the
--- Int range, but not in a way suitable for cross-compiling... :-(
+-- *target* Int/Word range.
 intResult :: Integer -> Maybe CoreExpr
 intResult result
-  = Just (mkIntVal (toInteger (fromInteger result :: Int)))
+  = Just (mkIntVal (toInteger (fromInteger result :: TargetInt)))
 
 wordResult :: Integer -> Maybe CoreExpr
 wordResult result
-  = Just (mkWordVal (toInteger (fromInteger result :: Word)))
+  = Just (mkWordVal (toInteger (fromInteger result :: TargetWord)))
 \end{code}
 
 
@@ -360,7 +374,9 @@ wordResult result
 %************************************************************************
 
 \begin{code}
-mkBasicRule :: Name -> Int -> ([CoreExpr] -> Maybe CoreExpr) -> [CoreRule]
+mkBasicRule :: Name -> Int
+            -> (IdUnfoldingFun -> [CoreExpr] -> Maybe CoreExpr)
+            -> [CoreRule]
 -- Gives the Rule the same name as the primop itself
 mkBasicRule op_name n_args rule_fn
   = [BuiltinRule { ru_name = occNameFS (nameOccName op_name),
@@ -372,16 +388,16 @@ oneLit :: Name -> (Literal -> Maybe CoreExpr)
 oneLit op_name test
   = mkBasicRule op_name 1 rule_fn
   where
-    rule_fn [Lit l1] = test (convFloating l1)
-    rule_fn _        = Nothing
+    rule_fn _ [Lit l1] = test (convFloating l1)
+    rule_fn _ _        = Nothing
 
 twoLits :: Name -> (Literal -> Literal -> Maybe CoreExpr)
        -> [CoreRule]
 twoLits op_name test 
   = mkBasicRule op_name 2 rule_fn
   where
-    rule_fn [Lit l1, Lit l2] = test (convFloating l1) (convFloating l2)
-    rule_fn _                = Nothing
+    rule_fn _ [Lit l1, Lit l2] = test (convFloating l1) (convFloating l2)
+    rule_fn _ _                = Nothing
 
 -- When excess precision is not requested, cut down the precision of the
 -- Rational value to that of Float/Double. We confuse host architecture
@@ -393,11 +409,16 @@ convFloating (MachDouble d) | not opt_SimplExcessPrecision =
    MachDouble (toRational ((fromRational d) :: Double))
 convFloating l = l
 
+trueVal, falseVal :: Expr CoreBndr
 trueVal       = Var trueDataConId
 falseVal      = Var falseDataConId
+mkIntVal :: Integer -> Expr CoreBndr
 mkIntVal    i = Lit (mkMachInt  i)
+mkWordVal :: Integer -> Expr CoreBndr
 mkWordVal   w = Lit (mkMachWord w)
+mkFloatVal :: Rational -> Expr CoreBndr
 mkFloatVal  f = Lit (convFloating (MachFloat  f))
+mkDoubleVal :: Rational -> Expr CoreBndr
 mkDoubleVal d = Lit (convFloating (MachDouble d))
 \end{code}
 
@@ -409,7 +430,8 @@ mkDoubleVal d = Lit (convFloating (MachDouble d))
 %************************************************************************
 
 \begin{code}
-tagToEnumRule [Type ty, Lit (MachInt i)]
+tagToEnumRule :: IdUnfoldingFun -> [Expr CoreBndr] -> Maybe (Expr CoreBndr)
+tagToEnumRule _ [Type ty, Lit (MachInt i)]
   = ASSERT( isEnumerationTyCon tycon ) 
     case filter correct_tag (tyConDataCons_maybe tycon `orElse` []) of
 
@@ -422,7 +444,7 @@ tagToEnumRule [Type ty, Lit (MachInt i)]
     tag   = fromInteger i
     tycon = tyConAppTyCon ty
 
-tagToEnumRule other = Nothing
+tagToEnumRule _ _ = Nothing
 \end{code}
 
 For dataToTag#, we can reduce if either 
@@ -431,17 +453,18 @@ For dataToTag#, we can reduce if either
        (b) the argument is a variable whose unfolding is a known constructor
 
 \begin{code}
-dataToTagRule [Type ty1, Var tag_to_enum `App` Type ty2 `App` tag]
+dataToTagRule :: IdUnfoldingFun -> [Expr CoreBndr] -> Maybe (Arg CoreBndr)
+dataToTagRule _ [Type ty1, Var tag_to_enum `App` Type ty2 `App` tag]
   | tag_to_enum `hasKey` tagToEnumKey
   , ty1 `coreEqType` ty2
   = Just tag   -- dataToTag (tagToEnum x)   ==>   x
 
-dataToTagRule [_, val_arg]
-  | Just (dc,_) <- exprIsConApp_maybe val_arg
+dataToTagRule id_unf [_, val_arg]
+  | Just (dc,_,_) <- exprIsConApp_maybe id_unf val_arg
   = ASSERT( not (isNewTyCon (dataConTyCon dc)) )
     Just (mkIntVal (toInteger (dataConTag dc - fIRST_TAG)))
 
-dataToTagRule other = Nothing
+dataToTagRule _ _ = Nothing
 \end{code}
 
 %************************************************************************
@@ -481,11 +504,11 @@ are explicit.)
 builtinRules :: [CoreRule]
 -- Rules for non-primops that can't be expressed using a RULE pragma
 builtinRules
-  = [ BuiltinRule { ru_name = FSLIT("AppendLitString"), ru_fn = unpackCStringFoldrName,
+  = [ BuiltinRule { ru_name = fsLit "AppendLitString", ru_fn = unpackCStringFoldrName,
                    ru_nargs = 4, ru_try = match_append_lit },
-      BuiltinRule { ru_name = FSLIT("EqString"), ru_fn = eqStringName,
+      BuiltinRule { ru_name = fsLit "EqString", ru_fn = eqStringName,
                    ru_nargs = 2, ru_try = match_eq_string },
-      BuiltinRule { ru_name = FSLIT("Inline"), ru_fn = inlineIdName,
+      BuiltinRule { ru_name = fsLit "Inline", ru_fn = inlineIdName,
                    ru_nargs = 2, ru_try = match_inline }
     ]
 
@@ -494,14 +517,15 @@ builtinRules
 -- The rule is this:
 --     unpackFoldrCString# "foo" c (unpackFoldrCString# "baz" c n)  =  unpackFoldrCString# "foobaz" c n
 
-match_append_lit [Type ty1,
-                  Lit (MachStr s1),
-                  c1,
-                  Var unpk `App` Type ty2 
-                           `App` Lit (MachStr s2)
-                           `App` c2
-                           `App` n
-                 ]
+match_append_lit :: IdUnfoldingFun -> [Expr CoreBndr] -> Maybe (Expr CoreBndr)
+match_append_lit _ [Type ty1,
+                   Lit (MachStr s1),
+                   c1,
+                   Var unpk `App` Type ty2 
+                            `App` Lit (MachStr s2)
+                            `App` c2
+                            `App` n
+                  ]
   | unpk `hasKey` unpackCStringFoldrIdKey && 
     c1 `cheapEqExpr` c2
   = ASSERT( ty1 `coreEqType` ty2 )
@@ -510,25 +534,26 @@ match_append_lit [Type ty1,
                   `App` c1
                   `App` n)
 
-match_append_lit other = Nothing
+match_append_lit _ _ = Nothing
 
 ---------------------------------------------------
 -- The rule is this:
 --     eqString (unpackCString# (Lit s1)) (unpackCString# (Lit s2) = s1==s2
 
-match_eq_string [Var unpk1 `App` Lit (MachStr s1),
-                Var unpk2 `App` Lit (MachStr s2)]
+match_eq_string :: IdUnfoldingFun -> [Expr CoreBndr] -> Maybe (Expr CoreBndr)
+match_eq_string _ [Var unpk1 `App` Lit (MachStr s1),
+                  Var unpk2 `App` Lit (MachStr s2)]
   | unpk1 `hasKey` unpackCStringIdKey,
     unpk2 `hasKey` unpackCStringIdKey
   = Just (if s1 == s2 then trueVal else falseVal)
 
-match_eq_string other = Nothing
+match_eq_string _ _ = Nothing
 
 
 ---------------------------------------------------
 -- The rule is this:
 --     inline f_ty (f a b c) = <f's unfolding> a b c
--- (if f has an unfolding)
+-- (if f has an unfolding, EVEN if it's a loop breaker)
 --
 -- It's important to allow the argument to 'inline' to have args itself
 -- (a) because its more forgiving to allow the programmer to write
@@ -538,10 +563,12 @@ match_eq_string other = Nothing
 --     programmer can't avoid
 --
 -- Also, don't forget about 'inline's type argument!
-match_inline (Type _ : e : _)
+match_inline :: IdUnfoldingFun -> [Expr CoreBndr] -> Maybe (Expr CoreBndr)
+match_inline _ (Type _ : e : _)
   | (Var f, args1) <- collectArgs e,
-    Just unf <- maybeUnfoldingTemplate (idUnfolding f)
+    Just unf <- maybeUnfoldingTemplate (realIdUnfolding f)
+            -- Ignore the IdUnfoldingFun here!
   = Just (mkApps unf args1)
 
-match_inline other = Nothing
-\end{code}             
+match_inline _ _ = Nothing
+\end{code}