Merge branch 'master' into type-nats
[ghc.git] / compiler / types / OptCoercion.lhs
1 %\r
2 % (c) The University of Glasgow 2006\r
3 %\r
4 \r
5 \begin{code}\r
6 {-# OPTIONS_GHC -w #-}\r
7 module OptCoercion (\r
8         optCoercion\r
9    ) where \r
10 \r
11 #include "HsVersions.h"\r
12 \r
13 import Unify    ( tcMatchTy )\r
14 import Coercion\r
15 import Type\r
16 import TypeRep\r
17 import TyCon\r
18 import Var\r
19 import VarSet\r
20 import VarEnv\r
21 import PrelNames\r
22 import Util\r
23 import Outputable\r
24 \end{code}\r
25 \r
26 %************************************************************************\r
27 %*                                                                      *\r
28                  Optimising coercions                                                                   \r
29 %*                                                                      *\r
30 %************************************************************************\r
31 \r
32 Note [Subtle shadowing in coercions]\r
33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
34 Supose we optimising a coercion\r
35     optCoercion (forall (co_X5:t1~t2). ...co_B1...)\r
36 The co_X5 is a wild-card; the bound variable of a coercion for-all\r
37 should never appear in the body of the forall. Indeed we often\r
38 write it like this\r
39     optCoercion ( (t1~t2) => ...co_B1... )\r
40 \r
41 Just because it's a wild-card doesn't mean we are free to choose\r
42 whatever variable we like.  For example it'd be wrong for optCoercion\r
43 to return\r
44    forall (co_B1:t1~t2). ...co_B1...\r
45 because now the co_B1 (which is really free) has been captured, and\r
46 subsequent substitutions will go wrong.  That's why we can't use\r
47 mkCoPredTy in the ForAll case, where this note appears.  \r
48 \r
49 \begin{code}\r
50 optCoercion :: TvSubst -> Coercion -> NormalCo\r
51 -- ^ optCoercion applies a substitution to a coercion, \r
52 --   *and* optimises it to reduce its size\r
53 optCoercion env co = opt_co env False co\r
54 \r
55 type NormalCo = Coercion\r
56   -- Invariants: \r
57   --  * The substitution has been fully applied\r
58   --  * For trans coercions (co1 `trans` co2)\r
59   --       co1 is not a trans, and neither co1 nor co2 is identity\r
60   --  * If the coercion is the identity, it has no CoVars of CoTyCons in it (just types)\r
61 \r
62 type NormalNonIdCo = NormalCo  -- Extra invariant: not the identity\r
63 \r
64 opt_co, opt_co' :: TvSubst\r
65                 -> Bool        -- True <=> return (sym co)\r
66                 -> Coercion\r
67                 -> NormalCo     \r
68 opt_co = opt_co'\r
69 \r
70 {-    Debuggery \r
71 opt_co env sym co \r
72 -- = pprTrace "opt_co {" (ppr sym <+> ppr co) $\r
73 --              co1 `seq` \r
74 --               pprTrace "opt_co done }" (ppr co1) \r
75 --               WARN( not same_co_kind, ppr co  <+> dcolon <+> pprEqPred (s1,t1) \r
76 --                                   $$ ppr co1 <+> dcolon <+> pprEqPred (s2,t2) )\r
77  =   WARN( not (coreEqType co1 simple_result), \r
78            (text "env=" <+> ppr env) $$\r
79            (text "input=" <+> ppr co) $$\r
80            (text "simple=" <+> ppr simple_result) $$\r
81            (text "opt=" <+> ppr co1) )\r
82      co1\r
83  where\r
84    co1 = opt_co' env sym co\r
85    same_co_kind = s1 `coreEqType` s2 && t1 `coreEqType` t2\r
86    (s,t) = coercionKind (substTy env co)\r
87    (s1,t1) | sym = (t,s)\r
88            | otherwise = (s,t)\r
89    (s2,t2) = coercionKind co1\r
90 \r
91    simple_result | sym = mkSymCoercion (substTy env co)\r
92                  | otherwise = substTy env co\r
93 -}\r
94 \r
95 opt_co' env sym (AppTy ty1 ty2)           = mkAppTy (opt_co env sym ty1) (opt_co env sym ty2)\r
96 opt_co' env sym (FunTy ty1 ty2)           = FunTy (opt_co env sym ty1) (opt_co env sym ty2)\r
97 opt_co' env sym (PredTy (ClassP cls tys)) = PredTy (ClassP cls (map (opt_co env sym) tys))\r
98 opt_co' env sym (PredTy (IParam n ty))    = PredTy (IParam n (opt_co env sym ty))\r
99 opt_co' _   _   co@(PredTy (EqPred {}))   = pprPanic "optCoercion" (ppr co)\r
100 \r
101 opt_co' env sym co@(TyVarTy tv)\r
102   | Just ty <- lookupTyVar env tv = opt_co' (zapTvSubstEnv env) sym ty\r
103   | not (isCoVar tv)     = co   -- Identity; does not mention a CoVar\r
104   | ty1 `coreEqType` ty2 = ty1  -- Identity; ..ditto..\r
105   | not sym              = co\r
106   | otherwise            = mkSymCoercion co\r
107   where\r
108     (ty1,ty2) = coVarKind tv\r
109 \r
110 opt_co' env sym (ForAllTy tv cor) \r
111   | isTyVar tv  = case substTyVarBndr env tv of\r
112                    (env', tv') -> ForAllTy tv' (opt_co' env' sym cor)\r
113 \r
114 opt_co' env sym co@(ForAllTy co_var cor) \r
115   | isCoVar co_var \r
116   = WARN( co_var `elemVarSet` tyVarsOfType cor, ppr co )\r
117     ForAllTy co_var' cor'\r
118   where\r
119     (co1,co2) = coVarKind co_var\r
120     co1' = opt_co' env sym co1\r
121     co2' = opt_co' env sym co2\r
122     cor' = opt_co' env sym cor\r
123     co_var' = uniqAway (getTvInScope env) (mkWildCoVar (mkCoKind co1' co2'))\r
124     -- See Note [Subtle shadowing in coercions]\r
125 \r
126 opt_co' env sym (TyConApp tc cos)\r
127   | Just (arity, desc) <- isCoercionTyCon_maybe tc\r
128   = mkAppTys (opt_co_tc_app env sym tc desc (take arity cos))\r
129              (map (opt_co env sym) (drop arity cos))\r
130   | otherwise\r
131   = TyConApp tc (map (opt_co env sym) cos)\r
132 \r
133 opt_co' _ _ co@(LiteralTy _) = co\r
134 \r
135 --------\r
136 opt_co_tc_app :: TvSubst -> Bool -> TyCon -> CoTyConDesc -> [Coercion] -> NormalCo\r
137 -- Used for CoercionTyCons only\r
138 -- Arguments are *not* already simplified/substituted\r
139 opt_co_tc_app env sym tc desc cos\r
140   = case desc of\r
141       CoAxiom {} -- Do *not* push sym inside top-level axioms\r
142                  -- e.g. if g is a top-level axiom\r
143                  --   g a : F a ~ a\r
144                  -- Then (sym (g ty)) /= g (sym ty) !!\r
145         | sym       -> mkSymCoercion the_co  \r
146         | otherwise -> the_co\r
147         where\r
148            the_co = TyConApp tc (map (opt_co env False) cos)\r
149            -- Note that the_co does *not* have sym pushed into it\r
150     \r
151       CoTrans \r
152         | sym       -> opt_trans opt_co2 opt_co1   -- sym (g `o` h) = sym h `o` sym g\r
153         | otherwise -> opt_trans opt_co1 opt_co2\r
154 \r
155       CoUnsafe\r
156         | sym       -> mkUnsafeCoercion ty2' ty1'\r
157         | otherwise -> mkUnsafeCoercion ty1' ty2'\r
158 \r
159       CoSym   -> opt_co env (not sym) co1\r
160       CoLeft  -> opt_lr fst\r
161       CoRight -> opt_lr snd\r
162       CoCsel1 -> opt_csel fstOf3\r
163       CoCsel2 -> opt_csel sndOf3\r
164       CoCselR -> opt_csel thirdOf3\r
165 \r
166       CoInst        -- See if the first arg is already a forall\r
167                     -- ...then we can just extend the current substitution\r
168         | Just (tv, co1_body) <- splitForAllTy_maybe co1\r
169         -> opt_co (extendTvSubst env tv ty2') sym co1_body\r
170 \r
171                     -- See if is *now* a forall\r
172         | Just (tv, opt_co1_body) <- splitForAllTy_maybe opt_co1\r
173         -> substTyWith [tv] [ty2'] opt_co1_body -- An inefficient one-variable substitution\r
174 \r
175         | otherwise\r
176         -> TyConApp tc [opt_co1, ty2']\r
177 \r
178   where\r
179     (co1 : cos1) = cos\r
180     (co2 : _)    = cos1\r
181 \r
182     ty1' = substTy env co1\r
183     ty2' = substTy env co2\r
184 \r
185         -- These opt_cos have the sym pushed into them\r
186     opt_co1 = opt_co env sym co1\r
187     opt_co2 = opt_co env sym co2\r
188 \r
189     the_unary_opt_co = TyConApp tc [opt_co1]\r
190 \r
191     opt_lr   sel = case splitAppTy_maybe opt_co1 of\r
192                      Nothing -> the_unary_opt_co \r
193                      Just lr -> sel lr\r
194     opt_csel sel = case splitCoPredTy_maybe opt_co1 of\r
195                      Nothing -> the_unary_opt_co \r
196                      Just lr -> sel lr\r
197 \r
198 -------------\r
199 opt_transL :: [NormalCo] -> [NormalCo] -> [NormalCo]\r
200 opt_transL = zipWith opt_trans\r
201 \r
202 opt_trans :: NormalCo -> NormalCo -> NormalCo\r
203 opt_trans co1 co2\r
204   | isIdNormCo co1 = co2\r
205   | otherwise      = opt_trans1 co1 co2\r
206 \r
207 opt_trans1 :: NormalNonIdCo -> NormalCo -> NormalCo\r
208 -- First arg is not the identity\r
209 opt_trans1 co1 co2\r
210   | isIdNormCo co2 = co1\r
211   | otherwise      = opt_trans2 co1 co2\r
212 \r
213 opt_trans2 :: NormalNonIdCo -> NormalNonIdCo -> NormalCo\r
214 -- Neither arg is the identity\r
215 opt_trans2 (TyConApp tc [co1a,co1b]) co2\r
216   | tc `hasKey` transCoercionTyConKey\r
217   = opt_trans1 co1a (opt_trans2 co1b co2)\r
218 \r
219 opt_trans2 co1 co2 \r
220   | Just co <- opt_trans_rule co1 co2\r
221   = co\r
222 \r
223 opt_trans2 co1 (TyConApp tc [co2a,co2b])\r
224   | tc `hasKey` transCoercionTyConKey\r
225   , Just co1_2a <- opt_trans_rule co1 co2a\r
226   = if isIdNormCo co1_2a\r
227     then co2b\r
228     else opt_trans2 co1_2a co2b\r
229 \r
230 opt_trans2 co1 co2\r
231   = mkTransCoercion co1 co2\r
232 \r
233 ------\r
234 opt_trans_rule :: NormalNonIdCo -> NormalNonIdCo -> Maybe NormalCo\r
235 opt_trans_rule (TyConApp tc1 args1) (TyConApp tc2 args2)\r
236   | tc1 == tc2\r
237   = case isCoercionTyCon_maybe tc1 of\r
238       Nothing \r
239         -> Just (TyConApp tc1 (opt_transL args1 args2))\r
240       Just (arity, desc) \r
241         | arity == length args1\r
242         -> opt_trans_rule_equal_tc desc args1 args2\r
243         | otherwise\r
244         -> case opt_trans_rule_equal_tc desc \r
245                          (take arity args1) \r
246                          (take arity args2) of\r
247               Just co -> Just $ mkAppTys co $ \r
248                          opt_transL (drop arity args1) (drop arity args2)\r
249               Nothing -> Nothing \r
250  \r
251 -- Push transitivity inside apply\r
252 opt_trans_rule co1 co2\r
253   | Just (co1a, co1b) <- splitAppTy_maybe co1\r
254   , Just (co2a, co2b) <- etaApp_maybe co2\r
255   = Just (mkAppTy (opt_trans co1a co2a) (opt_trans co1b co2b))\r
256 \r
257   | Just (co2a, co2b) <- splitAppTy_maybe co2\r
258   , Just (co1a, co1b) <- etaApp_maybe co1\r
259   = Just (mkAppTy (opt_trans co1a co2a) (opt_trans co1b co2b))\r
260 \r
261 -- Push transitivity inside (s~t)=>r\r
262 -- We re-use the CoVar rather than using mkCoPredTy\r
263 -- See Note [Subtle shadowing in coercions]\r
264 opt_trans_rule co1 co2\r
265   | Just (cv1,r1) <- splitForAllTy_maybe co1\r
266   , isCoVar cv1\r
267   , Just (s1,t1) <- coVarKind_maybe cv1\r
268   , Just (s2,t2,r2) <- etaCoPred_maybe co2\r
269   = Just (ForAllTy (mkCoVar (coVarName cv1) (mkCoKind (opt_trans s1 s2) (opt_trans t1 t2)))\r
270                    (opt_trans r1 r2))\r
271 \r
272   | Just (cv2,r2) <- splitForAllTy_maybe co2\r
273   , isCoVar cv2\r
274   , Just (s2,t2) <- coVarKind_maybe cv2\r
275   , Just (s1,t1,r1) <- etaCoPred_maybe co1\r
276   = Just (ForAllTy (mkCoVar (coVarName cv2) (mkCoKind (opt_trans s1 s2) (opt_trans t1 t2)))\r
277                    (opt_trans r1 r2))\r
278 \r
279 -- Push transitivity inside forall\r
280 opt_trans_rule co1 co2\r
281   | Just (tv1,r1) <- splitTypeForAll_maybe co1\r
282   , Just (tv2,r2) <- etaForAll_maybe co2\r
283   , let r2' = substTyWith [tv2] [TyVarTy tv1] r2\r
284   = Just (ForAllTy tv1 (opt_trans2 r1 r2'))\r
285 \r
286   | Just (tv2,r2) <- splitTypeForAll_maybe co2\r
287   , Just (tv1,r1) <- etaForAll_maybe co1\r
288   , let r1' = substTyWith [tv1] [TyVarTy tv2] r1\r
289   = Just (ForAllTy tv1 (opt_trans2 r1' r2))\r
290 \r
291 opt_trans_rule co1 co2\r
292 {-      Omitting for now, because unsound\r
293   | Just (sym1, (ax_tc1, ax1_args, ax_tvs, ax_lhs, ax_rhs)) <- co1_is_axiom_maybe\r
294   , Just (sym2, (ax_tc2, ax2_args, _, _, _)) <- co2_is_axiom_maybe\r
295   , ax_tc1 == ax_tc2\r
296   , sym1 /= sym2\r
297   = Just $\r
298     if sym1 \r
299     then substTyWith ax_tvs (opt_transL (map mkSymCoercion ax1_args) ax2_args) ax_rhs\r
300     else substTyWith ax_tvs (opt_transL ax1_args (map mkSymCoercion ax2_args)) ax_lhs\r
301 -}\r
302 \r
303   | Just (sym, (ax_tc, ax_args, ax_tvs, ax_lhs, _)) <- co1_is_axiom_maybe\r
304   , Just cos <- matchesAxiomLhs ax_tvs ax_lhs co2\r
305   = Just $ \r
306     if sym \r
307     then mkSymCoercion $ TyConApp ax_tc (opt_transL (map mkSymCoercion cos) ax_args)\r
308     else                 TyConApp ax_tc (opt_transL ax_args cos)\r
309 \r
310   | Just (sym, (ax_tc, ax_args, ax_tvs, ax_lhs, _)) <- isAxiom_maybe co2\r
311   , Just cos <- matchesAxiomLhs ax_tvs ax_lhs co1\r
312   = Just $ \r
313     if sym \r
314     then mkSymCoercion $ TyConApp ax_tc (opt_transL ax_args (map mkSymCoercion cos))\r
315     else                 TyConApp ax_tc (opt_transL cos ax_args)\r
316   where\r
317     co1_is_axiom_maybe = isAxiom_maybe co1\r
318     co2_is_axiom_maybe = isAxiom_maybe co2\r
319 \r
320 opt_trans_rule co1 co2  -- Identity rule\r
321   | (ty1,_) <- coercionKind co1\r
322   , (_,ty2) <- coercionKind co2\r
323   , ty1 `coreEqType` ty2\r
324   = Just ty2\r
325 \r
326 opt_trans_rule _ _ = Nothing\r
327 \r
328 -----------  \r
329 isAxiom_maybe :: Coercion -> Maybe (Bool, (TyCon, [Coercion], [TyVar], Type, Type))\r
330 isAxiom_maybe co\r
331   | Just (tc, args) <- splitTyConApp_maybe co\r
332   , Just (_, desc)  <- isCoercionTyCon_maybe tc\r
333   = case desc of\r
334       CoAxiom { co_ax_tvs = tvs, co_ax_lhs = lhs, co_ax_rhs = rhs } \r
335             -> Just (False, (tc, args, tvs, lhs, rhs))\r
336       CoSym | (arg1:_) <- args  \r
337             -> case isAxiom_maybe arg1 of\r
338                  Nothing           -> Nothing\r
339                  Just (sym, stuff) -> Just (not sym, stuff)\r
340       _ -> Nothing\r
341   | otherwise\r
342   = Nothing\r
343 \r
344 matchesAxiomLhs :: [TyVar] -> Type -> Type -> Maybe [Type]\r
345 matchesAxiomLhs tvs ty_tmpl ty \r
346   = case tcMatchTy (mkVarSet tvs) ty_tmpl ty of\r
347       Nothing    -> Nothing\r
348       Just subst -> Just (map (substTyVar subst) tvs)\r
349 \r
350 -----------  \r
351 opt_trans_rule_equal_tc :: CoTyConDesc -> [Coercion] -> [Coercion] -> Maybe Coercion\r
352 -- Rules for Coercion TyCons only\r
353 \r
354 -- Push transitivity inside instantiation\r
355 opt_trans_rule_equal_tc desc [co1,ty1] [co2,ty2]\r
356   | CoInst <- desc\r
357   , ty1 `coreEqType` ty2\r
358   , co1 `compatible_co` co2\r
359   = Just (mkInstCoercion (opt_trans2 co1 co2) ty1) \r
360 \r
361 opt_trans_rule_equal_tc desc [co1] [co2]\r
362   | CoLeft  <- desc, is_compat = Just (mkLeftCoercion res_co)\r
363   | CoRight <- desc, is_compat = Just (mkRightCoercion res_co)\r
364   | CoCsel1 <- desc, is_compat = Just (mkCsel1Coercion res_co)\r
365   | CoCsel2 <- desc, is_compat = Just (mkCsel2Coercion res_co)\r
366   | CoCselR <- desc, is_compat = Just (mkCselRCoercion res_co)\r
367   where\r
368     is_compat = co1 `compatible_co` co2\r
369     res_co    = opt_trans2 co1 co2\r
370 \r
371 opt_trans_rule_equal_tc _ _ _ = Nothing\r
372 \r
373 -------------\r
374 compatible_co :: Coercion -> Coercion -> Bool\r
375 -- Check whether (co1 . co2) will be well-kinded\r
376 compatible_co co1 co2\r
377   = x1 `coreEqType` x2          \r
378   where\r
379     (_,x1) = coercionKind co1\r
380     (x2,_) = coercionKind co2\r
381 \r
382 -------------\r
383 etaForAll_maybe :: Coercion -> Maybe (TyVar, Coercion)\r
384 -- Try to make the coercion be of form (forall tv. co)\r
385 etaForAll_maybe co\r
386   | Just (tv, r) <- splitForAllTy_maybe co\r
387   , not (isCoVar tv)    -- Check it is a *type* forall, not a (t1~t2)=>co\r
388   = Just (tv, r)\r
389 \r
390   | (ty1,ty2) <- coercionKind co\r
391   , Just (tv1, _) <- splitTypeForAll_maybe ty1\r
392   , Just (tv2, _) <- splitTypeForAll_maybe ty2\r
393   , tyVarKind tv1 `eqKind` tyVarKind tv2\r
394   = Just (tv1, mkInstCoercion co (mkTyVarTy tv1))\r
395 \r
396   | otherwise\r
397   = Nothing\r
398 \r
399 etaCoPred_maybe :: Coercion -> Maybe (Coercion, Coercion, Coercion)\r
400 etaCoPred_maybe co \r
401   | Just (s,t,r) <- splitCoPredTy_maybe co\r
402   = Just (s,t,r)\r
403   \r
404   --  co :: (s1~t1)=>r1 ~ (s2~t2)=>r2\r
405   | (ty1,ty2) <- coercionKind co        -- We know ty1,ty2 have same kind\r
406   , Just (s1,_,_) <- splitCoPredTy_maybe ty1\r
407   , Just (s2,_,_) <- splitCoPredTy_maybe ty2\r
408   , typeKind s1 `eqKind` typeKind s2    -- t1,t2 have same kinds\r
409   = Just (mkCsel1Coercion co, mkCsel2Coercion co, mkCselRCoercion co)\r
410   \r
411   | otherwise\r
412   = Nothing\r
413 \r
414 etaApp_maybe :: Coercion -> Maybe (Coercion, Coercion)\r
415 -- Split a coercion g :: t1a t1b ~ t2a t2b\r
416 -- into (left g, right g) if possible\r
417 etaApp_maybe co\r
418   | Just (co1, co2) <- splitAppTy_maybe co\r
419   = Just (co1, co2)\r
420 \r
421   | (ty1,ty2) <- coercionKind co\r
422   , Just (ty1a, _) <- splitAppTy_maybe ty1\r
423   , Just (ty2a, _) <- splitAppTy_maybe ty2\r
424   , typeKind ty1a `eqKind` typeKind ty2a\r
425   = Just (mkLeftCoercion co, mkRightCoercion co)\r
426 \r
427   | otherwise\r
428   = Nothing\r
429 \r
430 -------------\r
431 splitTypeForAll_maybe :: Type -> Maybe (TyVar, Type)\r
432 -- Returns Just only for a *type* forall, not a (t1~t2)=>co\r
433 splitTypeForAll_maybe ty\r
434   | Just (tv, rty) <- splitForAllTy_maybe ty\r
435   , not (isCoVar tv)\r
436   = Just (tv, rty)\r
437 \r
438   | otherwise\r
439   = Nothing\r
440 \r
441 -------------\r
442 isIdNormCo :: NormalCo -> Bool\r
443 -- Cheap identity test: look for coercions with no coercion variables at all\r
444 -- So it'll return False for (sym g `trans` g)\r
445 isIdNormCo ty = go ty\r
446   where\r
447     go (TyVarTy tv)            = not (isCoVar tv)\r
448     go (AppTy t1 t2)           = go t1 && go t2\r
449     go (FunTy t1 t2)           = go t1 && go t2\r
450     go (ForAllTy tv ty)        = go (tyVarKind tv) && go ty\r
451     go (TyConApp tc tys)       = not (isCoercionTyCon tc) && all go tys\r
452     go (PredTy (IParam _ ty))  = go ty\r
453     go (PredTy (ClassP _ tys)) = all go tys\r
454     go (PredTy (EqPred t1 t2)) = go t1 && go t2\r
455     go (LiteralTy _)           = True\r
456 \end{code}  \r
457 \r