Make -frewrite-rules into a dynamic flag; off for -O0
[ghc-hetmet.git] / compiler / prelude / PrelRules.lhs
1 %
2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3 %
4 \section[ConFold]{Constant Folder}
5
6 Conceptually, constant folding should be parameterized with the kind
7 of target machine to get identical behaviour during compilation time
8 and runtime. We cheat a little bit here...
9
10 ToDo:
11    check boundaries before folding, e.g. we can fold the Float addition
12    (i1 + i2) only if it results in a valid Float.
13
14 \begin{code}
15
16 {-# OPTIONS -optc-DNON_POSIX_SOURCE #-}
17
18 module PrelRules ( primOpRules, builtinRules ) where
19
20 #include "HsVersions.h"
21
22 import CoreSyn
23 import Id               ( mkWildId, idUnfolding )
24 import Literal          ( Literal(..), mkMachInt, mkMachWord
25                         , literalType
26                         , word2IntLit, int2WordLit
27                         , narrow8IntLit, narrow16IntLit, narrow32IntLit
28                         , narrow8WordLit, narrow16WordLit, narrow32WordLit
29                         , char2IntLit, int2CharLit
30                         , float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit
31                         , float2DoubleLit, double2FloatLit
32                         )
33 import PrimOp           ( PrimOp(..), tagToEnumKey )
34 import TysWiredIn       ( boolTy, trueDataConId, falseDataConId )
35 import TyCon            ( tyConDataCons_maybe, isEnumerationTyCon, isNewTyCon )
36 import DataCon          ( dataConTag, dataConTyCon, dataConWorkId, fIRST_TAG )
37 import CoreUtils        ( cheapEqExpr, exprIsConApp_maybe )
38 import Type             ( tyConAppTyCon, coreEqType )
39 import OccName          ( occNameFS )
40 import PrelNames        ( unpackCStringFoldrName, unpackCStringFoldrIdKey, hasKey,
41                           eqStringName, unpackCStringIdKey, inlineIdName )
42 import Maybes           ( orElse )
43 import Name             ( Name, nameOccName )
44 import Outputable
45 import FastString
46 import StaticFlags      ( opt_SimplExcessPrecision )
47 import Data.Bits as Bits
48 import Data.Word        ( Word )
49 \end{code}
50
51
52 Note [Constant folding]
53 ~~~~~~~~~~~~~~~~~~~~~~~
54 primOpRules generates the rewrite rules for each primop
55 These rules do what is often called "constant folding"
56 E.g. the rules for +# might say
57              4 +# 5 = 9
58 Well, of course you'd need a lot of rules if you did it 
59 like that, so we use a BuiltinRule instead, so that we
60 can match in any two literal values.  So the rule is really
61 more like
62              (Lit 4) +# (Lit y) = Lit (x+#y)
63 where the (+#) on the rhs is done at compile time
64
65 That is why these rules are built in here.  Other rules
66 which don't need to be built in are in GHC.Base. For 
67 example:
68         x +# 0 = x
69
70
71 \begin{code}
72 primOpRules :: PrimOp -> Name -> [CoreRule]
73 primOpRules op op_name = primop_rule op
74   where
75         -- A useful shorthand
76     one_lit   = oneLit  op_name
77     two_lits  = twoLits op_name
78     relop cmp = two_lits (cmpOp (\ord -> ord `cmp` EQ))
79         -- Cunning.  cmpOp compares the values to give an Ordering.
80         -- It applies its argument to that ordering value to turn
81         -- the ordering into a boolean value.  (`cmp` EQ) is just the job.
82
83     -- ToDo:    something for integer-shift ops?
84     --          NotOp
85
86     primop_rule TagToEnumOp = mkBasicRule op_name 2 tagToEnumRule
87     primop_rule DataToTagOp = mkBasicRule op_name 2 dataToTagRule
88
89         -- Int operations
90     primop_rule IntAddOp    = two_lits (intOp2     (+))
91     primop_rule IntSubOp    = two_lits (intOp2     (-))
92     primop_rule IntMulOp    = two_lits (intOp2     (*))
93     primop_rule IntQuotOp   = two_lits (intOp2Z    quot)
94     primop_rule IntRemOp    = two_lits (intOp2Z    rem)
95     primop_rule IntNegOp    = one_lit  negOp
96     primop_rule ISllOp      = two_lits (intShiftOp2 Bits.shiftL)
97     primop_rule ISraOp      = two_lits (intShiftOp2 Bits.shiftR)
98     primop_rule ISrlOp      = two_lits (intShiftOp2 shiftRightLogical)
99
100         -- Word operations
101     primop_rule WordAddOp   = two_lits (wordOp2    (+))
102     primop_rule WordSubOp   = two_lits (wordOp2    (-))
103     primop_rule WordMulOp   = two_lits (wordOp2    (*))
104     primop_rule WordQuotOp  = two_lits (wordOp2Z   quot)
105     primop_rule WordRemOp   = two_lits (wordOp2Z   rem)
106     primop_rule AndOp       = two_lits (wordBitOp2 (.&.))
107     primop_rule OrOp        = two_lits (wordBitOp2 (.|.))
108     primop_rule XorOp       = two_lits (wordBitOp2 xor)
109     primop_rule SllOp       = two_lits (wordShiftOp2 Bits.shiftL)
110     primop_rule SrlOp       = two_lits (wordShiftOp2 shiftRightLogical)
111
112         -- coercions
113     primop_rule Word2IntOp      = one_lit (litCoerce word2IntLit)
114     primop_rule Int2WordOp      = one_lit (litCoerce int2WordLit)
115     primop_rule Narrow8IntOp    = one_lit (litCoerce narrow8IntLit)
116     primop_rule Narrow16IntOp   = one_lit (litCoerce narrow16IntLit)
117     primop_rule Narrow32IntOp   = one_lit (litCoerce narrow32IntLit)
118     primop_rule Narrow8WordOp   = one_lit (litCoerce narrow8WordLit)
119     primop_rule Narrow16WordOp  = one_lit (litCoerce narrow16WordLit)
120     primop_rule Narrow32WordOp  = one_lit (litCoerce narrow32WordLit)
121     primop_rule OrdOp           = one_lit (litCoerce char2IntLit)
122     primop_rule ChrOp           = one_lit (litCoerce int2CharLit)
123     primop_rule Float2IntOp     = one_lit (litCoerce float2IntLit)
124     primop_rule Int2FloatOp     = one_lit (litCoerce int2FloatLit)
125     primop_rule Double2IntOp    = one_lit (litCoerce double2IntLit)
126     primop_rule Int2DoubleOp    = one_lit (litCoerce int2DoubleLit)
127         -- SUP: Not sure what the standard says about precision in the following 2 cases
128     primop_rule Float2DoubleOp  = one_lit (litCoerce float2DoubleLit)
129     primop_rule Double2FloatOp  = one_lit (litCoerce double2FloatLit)
130
131         -- Float
132     primop_rule FloatAddOp   = two_lits (floatOp2  (+))
133     primop_rule FloatSubOp   = two_lits (floatOp2  (-))
134     primop_rule FloatMulOp   = two_lits (floatOp2  (*))
135     primop_rule FloatDivOp   = two_lits (floatOp2Z (/))
136     primop_rule FloatNegOp   = one_lit  negOp
137
138         -- Double
139     primop_rule DoubleAddOp   = two_lits (doubleOp2  (+))
140     primop_rule DoubleSubOp   = two_lits (doubleOp2  (-))
141     primop_rule DoubleMulOp   = two_lits (doubleOp2  (*))
142     primop_rule DoubleDivOp   = two_lits (doubleOp2Z (/))
143     primop_rule DoubleNegOp   = one_lit  negOp
144
145         -- Relational operators
146     primop_rule IntEqOp  = relop (==) ++ litEq op_name True
147     primop_rule IntNeOp  = relop (/=) ++ litEq op_name False
148     primop_rule CharEqOp = relop (==) ++ litEq op_name True
149     primop_rule CharNeOp = relop (/=) ++ litEq op_name False
150
151     primop_rule IntGtOp         = relop (>)
152     primop_rule IntGeOp         = relop (>=)
153     primop_rule IntLeOp         = relop (<=)
154     primop_rule IntLtOp         = relop (<)
155
156     primop_rule CharGtOp        = relop (>)
157     primop_rule CharGeOp        = relop (>=)
158     primop_rule CharLeOp        = relop (<=)
159     primop_rule CharLtOp        = relop (<)
160
161     primop_rule FloatGtOp       = relop (>)
162     primop_rule FloatGeOp       = relop (>=)
163     primop_rule FloatLeOp       = relop (<=)
164     primop_rule FloatLtOp       = relop (<)
165     primop_rule FloatEqOp       = relop (==)
166     primop_rule FloatNeOp       = relop (/=)
167
168     primop_rule DoubleGtOp      = relop (>)
169     primop_rule DoubleGeOp      = relop (>=)
170     primop_rule DoubleLeOp      = relop (<=)
171     primop_rule DoubleLtOp      = relop (<)
172     primop_rule DoubleEqOp      = relop (==)
173     primop_rule DoubleNeOp      = relop (/=)
174
175     primop_rule WordGtOp        = relop (>)
176     primop_rule WordGeOp        = relop (>=)
177     primop_rule WordLeOp        = relop (<=)
178     primop_rule WordLtOp        = relop (<)
179     primop_rule WordEqOp        = relop (==)
180     primop_rule WordNeOp        = relop (/=)
181
182     primop_rule other           = []
183
184
185 \end{code}
186
187 %************************************************************************
188 %*                                                                      *
189 \subsection{Doing the business}
190 %*                                                                      *
191 %************************************************************************
192
193 ToDo: the reason these all return Nothing is because there used to be
194 the possibility of an argument being a litlit.  Litlits are now gone,
195 so this could be cleaned up.
196
197 \begin{code}
198 --------------------------
199 litCoerce :: (Literal -> Literal) -> Literal -> Maybe CoreExpr
200 litCoerce fn lit = Just (Lit (fn lit))
201
202 --------------------------
203 cmpOp :: (Ordering -> Bool) -> Literal -> Literal -> Maybe CoreExpr
204 cmpOp cmp l1 l2
205   = go l1 l2
206   where
207     done res | cmp res   = Just trueVal
208              | otherwise = Just falseVal
209
210         -- These compares are at different types
211     go (MachChar i1)   (MachChar i2)   = done (i1 `compare` i2)
212     go (MachInt i1)    (MachInt i2)    = done (i1 `compare` i2)
213     go (MachInt64 i1)  (MachInt64 i2)  = done (i1 `compare` i2)
214     go (MachWord i1)   (MachWord i2)   = done (i1 `compare` i2)
215     go (MachWord64 i1) (MachWord64 i2) = done (i1 `compare` i2)
216     go (MachFloat i1)  (MachFloat i2)  = done (i1 `compare` i2)
217     go (MachDouble i1) (MachDouble i2) = done (i1 `compare` i2)
218     go l1              l2              = Nothing
219
220 --------------------------
221
222 negOp :: Literal -> Maybe CoreExpr      -- Negate
223 negOp (MachFloat 0.0)  = Nothing  -- can't represent -0.0 as a Rational
224 negOp (MachFloat f)    = Just (mkFloatVal (-f))
225 negOp (MachDouble 0.0) = Nothing
226 negOp (MachDouble d)   = Just (mkDoubleVal (-d))
227 negOp (MachInt i)      = intResult (-i)
228 negOp l                = Nothing
229
230 --------------------------
231 intOp2 :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
232 intOp2 op (MachInt i1) (MachInt i2) = intResult (i1 `op` i2)
233 intOp2 op l1           l2           = Nothing           -- Could find LitLit
234
235 intOp2Z :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
236 -- Like intOp2, but Nothing if i2=0
237 intOp2Z op (MachInt i1) (MachInt i2)
238   | i2 /= 0 = intResult (i1 `op` i2)
239 intOp2Z op l1 l2 = Nothing              -- LitLit or zero dividend
240
241 intShiftOp2 :: (Integer->Int->Integer) -> Literal -> Literal -> Maybe CoreExpr
242         -- Shifts take an Int; hence second arg of op is Int
243 intShiftOp2 op (MachInt i1) (MachInt i2) = intResult (i1 `op` fromInteger i2)
244 intShiftOp2 op l1           l2           = Nothing 
245
246 shiftRightLogical :: Integer -> Int -> Integer
247 -- Shift right, putting zeros in rather than sign-propagating as Bits.shiftR would do
248 -- Do this by converting to Word and back.  Obviously this won't work for big 
249 -- values, but its ok as we use it here
250 shiftRightLogical x n = fromIntegral (fromInteger x `shiftR` n :: Word)
251
252
253 --------------------------
254 wordOp2 :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
255 wordOp2 op (MachWord w1) (MachWord w2)
256   = wordResult (w1 `op` w2)
257 wordOp2 op l1 l2 = Nothing              -- Could find LitLit
258
259 wordOp2Z :: (Integer->Integer->Integer) -> Literal -> Literal -> Maybe CoreExpr
260 wordOp2Z op (MachWord w1) (MachWord w2)
261   | w2 /= 0 = wordResult (w1 `op` w2)
262 wordOp2Z op l1 l2 = Nothing     -- LitLit or zero dividend
263
264 wordBitOp2 op l1@(MachWord w1) l2@(MachWord w2)
265   = wordResult (w1 `op` w2)
266 wordBitOp2 op l1 l2 = Nothing           -- Could find LitLit
267
268 wordShiftOp2 :: (Integer->Int->Integer) -> Literal -> Literal -> Maybe CoreExpr
269         -- Shifts take an Int; hence second arg of op is Int
270 wordShiftOp2 op (MachWord x) (MachInt n) 
271   = wordResult (x `op` fromInteger n)
272         -- Do the shift at type Integer
273 wordShiftOp2 op l1 l2 = Nothing 
274
275 --------------------------
276 floatOp2  op (MachFloat f1) (MachFloat f2)
277   = Just (mkFloatVal (f1 `op` f2))
278 floatOp2  op l1 l2 = Nothing
279
280 floatOp2Z op (MachFloat f1) (MachFloat f2)
281   | f2 /= 0   = Just (mkFloatVal (f1 `op` f2))
282 floatOp2Z op l1 l2 = Nothing
283
284 --------------------------
285 doubleOp2  op (MachDouble f1) (MachDouble f2)
286   = Just (mkDoubleVal (f1 `op` f2))
287 doubleOp2 op l1 l2 = Nothing
288
289 doubleOp2Z op (MachDouble f1) (MachDouble f2)
290   | f2 /= 0   = Just (mkDoubleVal (f1 `op` f2))
291 doubleOp2Z op l1 l2 = Nothing
292
293
294 --------------------------
295         -- This stuff turns
296         --      n ==# 3#
297         -- into
298         --      case n of
299         --        3# -> True
300         --        m  -> False
301         --
302         -- This is a Good Thing, because it allows case-of case things
303         -- to happen, and case-default absorption to happen.  For
304         -- example:
305         --
306         --      if (n ==# 3#) || (n ==# 4#) then e1 else e2
307         -- will transform to
308         --      case n of
309         --        3# -> e1
310         --        4# -> e1
311         --        m  -> e2
312         -- (modulo the usual precautions to avoid duplicating e1)
313
314 litEq :: Name 
315       -> Bool           -- True <=> equality, False <=> inequality
316       -> [CoreRule]
317 litEq op_name is_eq
318   = [BuiltinRule { ru_name = occNameFS (nameOccName op_name) 
319                                 `appendFS` FSLIT("->case"),
320                    ru_fn = op_name, 
321                    ru_nargs = 2, ru_try = rule_fn }]
322   where
323     rule_fn [Lit lit, expr] = do_lit_eq lit expr
324     rule_fn [expr, Lit lit] = do_lit_eq lit expr
325     rule_fn other           = Nothing
326     
327     do_lit_eq lit expr
328       = Just (Case expr (mkWildId (literalType lit)) boolTy
329                     [(DEFAULT,    [], val_if_neq),
330                      (LitAlt lit, [], val_if_eq)])
331     val_if_eq  | is_eq     = trueVal
332                | otherwise = falseVal
333     val_if_neq | is_eq     = falseVal
334                | otherwise = trueVal
335
336 -- Note that we *don't* warn the user about overflow. It's not done at
337 -- runtime either, and compilation of completely harmless things like
338 --    ((124076834 :: Word32) + (2147483647 :: Word32))
339 -- would yield a warning. Instead we simply squash the value into the
340 -- Int range, but not in a way suitable for cross-compiling... :-(
341 intResult :: Integer -> Maybe CoreExpr
342 intResult result
343   = Just (mkIntVal (toInteger (fromInteger result :: Int)))
344
345 wordResult :: Integer -> Maybe CoreExpr
346 wordResult result
347   = Just (mkWordVal (toInteger (fromInteger result :: Word)))
348 \end{code}
349
350
351 %************************************************************************
352 %*                                                                      *
353 \subsection{Vaguely generic functions
354 %*                                                                      *
355 %************************************************************************
356
357 \begin{code}
358 mkBasicRule :: Name -> Int -> ([CoreExpr] -> Maybe CoreExpr) -> [CoreRule]
359 -- Gives the Rule the same name as the primop itself
360 mkBasicRule op_name n_args rule_fn
361   = [BuiltinRule { ru_name = occNameFS (nameOccName op_name),
362                    ru_fn = op_name, 
363                    ru_nargs = n_args, ru_try = rule_fn }]
364
365 oneLit :: Name -> (Literal -> Maybe CoreExpr)
366        -> [CoreRule]
367 oneLit op_name test
368   = mkBasicRule op_name 1 rule_fn
369   where
370     rule_fn [Lit l1] = test (convFloating l1)
371     rule_fn _        = Nothing
372
373 twoLits :: Name -> (Literal -> Literal -> Maybe CoreExpr)
374         -> [CoreRule]
375 twoLits op_name test 
376   = mkBasicRule op_name 2 rule_fn
377   where
378     rule_fn [Lit l1, Lit l2] = test (convFloating l1) (convFloating l2)
379     rule_fn _                = Nothing
380
381 -- When excess precision is not requested, cut down the precision of the
382 -- Rational value to that of Float/Double. We confuse host architecture
383 -- and target architecture here, but it's convenient (and wrong :-).
384 convFloating :: Literal -> Literal
385 convFloating (MachFloat  f) | not opt_SimplExcessPrecision =
386    MachFloat  (toRational ((fromRational f) :: Float ))
387 convFloating (MachDouble d) | not opt_SimplExcessPrecision =
388    MachDouble (toRational ((fromRational d) :: Double))
389 convFloating l = l
390
391 trueVal       = Var trueDataConId
392 falseVal      = Var falseDataConId
393 mkIntVal    i = Lit (mkMachInt  i)
394 mkWordVal   w = Lit (mkMachWord w)
395 mkFloatVal  f = Lit (convFloating (MachFloat  f))
396 mkDoubleVal d = Lit (convFloating (MachDouble d))
397 \end{code}
398
399                                                 
400 %************************************************************************
401 %*                                                                      *
402 \subsection{Special rules for seq, tagToEnum, dataToTag}
403 %*                                                                      *
404 %************************************************************************
405
406 \begin{code}
407 tagToEnumRule [Type ty, Lit (MachInt i)]
408   = ASSERT( isEnumerationTyCon tycon ) 
409     case filter correct_tag (tyConDataCons_maybe tycon `orElse` []) of
410
411
412         []        -> Nothing    -- Abstract type
413         (dc:rest) -> ASSERT( null rest )
414                      Just (Var (dataConWorkId dc))
415   where 
416     correct_tag dc = (dataConTag dc - fIRST_TAG) == tag
417     tag   = fromInteger i
418     tycon = tyConAppTyCon ty
419
420 tagToEnumRule other = Nothing
421 \end{code}
422
423 For dataToTag#, we can reduce if either 
424         
425         (a) the argument is a constructor
426         (b) the argument is a variable whose unfolding is a known constructor
427
428 \begin{code}
429 dataToTagRule [Type ty1, Var tag_to_enum `App` Type ty2 `App` tag]
430   | tag_to_enum `hasKey` tagToEnumKey
431   , ty1 `coreEqType` ty2
432   = Just tag    -- dataToTag (tagToEnum x)   ==>   x
433
434 dataToTagRule [_, val_arg]
435   | Just (dc,_) <- exprIsConApp_maybe val_arg
436   = ASSERT( not (isNewTyCon (dataConTyCon dc)) )
437     Just (mkIntVal (toInteger (dataConTag dc - fIRST_TAG)))
438
439 dataToTagRule other = Nothing
440 \end{code}
441
442 %************************************************************************
443 %*                                                                      *
444 \subsection{Built in rules}
445 %*                                                                      *
446 %************************************************************************
447
448 Note [Scoping for Builtin rules]
449 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
450 When compiling a (base-package) module that defines one of the
451 functions mentioned in the RHS of a built-in rule, there's a danger
452 that we'll see
453
454         f = ...(eq String x)....
455
456         ....and lower down...
457
458         eqString = ...
459
460 Then a rewrite would give
461
462         f = ...(eqString x)...
463         ....and lower down...
464         eqString = ...
465
466 and lo, eqString is not in scope.  This only really matters when we get to code
467 generation.  With -O we do a GlomBinds step that does a new SCC analysis on the whole
468 set of bindings, which sorts out the dependency.  Without -O we don't do any rule
469 rewriting so again we are fine.
470
471 (This whole thing doesn't show up for non-built-in rules because their dependencies
472 are explicit.)
473
474
475 \begin{code}
476 builtinRules :: [CoreRule]
477 -- Rules for non-primops that can't be expressed using a RULE pragma
478 builtinRules
479   = [ BuiltinRule { ru_name = FSLIT("AppendLitString"), ru_fn = unpackCStringFoldrName,
480                     ru_nargs = 4, ru_try = match_append_lit },
481       BuiltinRule { ru_name = FSLIT("EqString"), ru_fn = eqStringName,
482                     ru_nargs = 2, ru_try = match_eq_string },
483       BuiltinRule { ru_name = FSLIT("Inline"), ru_fn = inlineIdName,
484                     ru_nargs = 2, ru_try = match_inline }
485     ]
486
487
488 ---------------------------------------------------
489 -- The rule is this:
490 --      unpackFoldrCString# "foo" c (unpackFoldrCString# "baz" c n)  =  unpackFoldrCString# "foobaz" c n
491
492 match_append_lit [Type ty1,
493                    Lit (MachStr s1),
494                    c1,
495                    Var unpk `App` Type ty2 
496                             `App` Lit (MachStr s2)
497                             `App` c2
498                             `App` n
499                   ]
500   | unpk `hasKey` unpackCStringFoldrIdKey && 
501     c1 `cheapEqExpr` c2
502   = ASSERT( ty1 `coreEqType` ty2 )
503     Just (Var unpk `App` Type ty1
504                    `App` Lit (MachStr (s1 `appendFS` s2))
505                    `App` c1
506                    `App` n)
507
508 match_append_lit other = Nothing
509
510 ---------------------------------------------------
511 -- The rule is this:
512 --      eqString (unpackCString# (Lit s1)) (unpackCString# (Lit s2) = s1==s2
513
514 match_eq_string [Var unpk1 `App` Lit (MachStr s1),
515                  Var unpk2 `App` Lit (MachStr s2)]
516   | unpk1 `hasKey` unpackCStringIdKey,
517     unpk2 `hasKey` unpackCStringIdKey
518   = Just (if s1 == s2 then trueVal else falseVal)
519
520 match_eq_string other = Nothing
521
522
523 ---------------------------------------------------
524 -- The rule is this:
525 --      inline f_ty (f a b c) = <f's unfolding> a b c
526 -- (if f has an unfolding)
527 --
528 -- It's important to allow the argument to 'inline' to have args itself
529 -- (a) because its more forgiving to allow the programmer to write
530 --       inline f a b c
531 --   or  inline (f a b c)
532 -- (b) because a polymorphic f wll get a type argument that the 
533 --     programmer can't avoid
534 --
535 -- Also, don't forget about 'inline's type argument!
536 match_inline (Type _ : e : _)
537   | (Var f, args1) <- collectArgs e,
538     Just unf <- maybeUnfoldingTemplate (idUnfolding f)
539   = Just (mkApps unf args1)
540
541 match_inline other = Nothing
542 \end{code}