TcInteract.lhs 82.1 KB
Newer Older
1 2
\begin{code}
module TcInteract ( 
3 4 5
     solveInteract, solveInteractGiven, solveInteractWanted,
     AtomicInert, tyVarsOfInert, 
     InertSet, emptyInert, updInertSet, extractUnsolved, solveOne,
6 7 8 9
  ) where  

#include "HsVersions.h"

10

11 12 13 14 15 16 17 18 19
import BasicTypes 
import TcCanonical
import VarSet
import Type

import Id 
import Var

import TcType
20
import HsBinds
21

22
import Inst( tyVarsOfEvVar )
23 24 25
import InstEnv
import Class
import TyCon
26 27 28 29 30 31 32
import Name

import FunDeps

import Coercion
import Outputable

33
import TcRnTypes
34
import TcErrors
35
import TcSMonad
36
import Bag
37
import qualified Data.Map as Map
38

39 40
import Control.Monad( when )

41 42 43 44
import FastString ( sLit ) 
import DynFlags
\end{code}

45
Note [InertSet invariants]
46 47 48 49 50 51 52 53 54 55 56 57 58 59
~~~~~~~~~~~~~~~~~~~~~~~~~~~
An InertSet is a bag of canonical constraints, with the following invariants:

  1 No two constraints react with each other. 
    
    A tricky case is when there exists a given (solved) dictionary 
    constraint and a wanted identical constraint in the inert set, but do 
    not react because reaction would create loopy dictionary evidence for 
    the wanted. See note [Recursive dictionaries]

  2 Given equalities form an idempotent substitution [none of the
    given LHS's occur in any of the given RHS's or reactant parts]

  3 Wanted equalities also form an idempotent substitution
60

61 62 63 64 65 66
  4 The entire set of equalities is acyclic.

  5 Wanted dictionaries are inert with the top-level axiom set 

  6 Equalities of the form tv1 ~ tv2 always have a touchable variable
    on the left (if possible).
67 68

  7 No wanted constraints tv1 ~ tv2 with tv1 touchable. Such constraints
69 70
    will be marked as solved right before being pushed into the inert set. 
    See note [Touchables and givens].
71 72 73

  8 No Given constraint mentions a touchable unification variable,
    except if the
74 75 76 77 78 79 80 81 82 83 84 85 86 87
 
Note that 6 and 7 are /not/ enforced by canonicalization but rather by 
insertion in the inert list, ie by TcInteract. 

During the process of solving, the inert set will contain some
previously given constraints, some wanted constraints, and some given
constraints which have arisen from solving wanted constraints. For
now we do not distinguish between given and solved constraints.

Note that we must switch wanted inert items to given when going under an
implication constraint (when in top-level inference mode).

\begin{code}

88 89 90 91
data CCanMap a = CCanMap { cts_given   :: Map.Map a CanonicalCts
                                          -- Invariant: all Given
                         , cts_derived :: Map.Map a CanonicalCts 
                                          -- Invariant: all Derived
92 93
                         , cts_wanted  :: Map.Map a CanonicalCts } 
                                          -- Invariant: all Wanted
94

95
cCanMapToBag :: Ord a => CCanMap a -> CanonicalCts 
96 97 98
cCanMapToBag cmap = Map.fold unionBags rest_wder (cts_given cmap)
  where rest_wder = Map.fold unionBags rest_der  (cts_wanted cmap) 
        rest_der  = Map.fold unionBags emptyCCan (cts_derived cmap)
99 100

emptyCCanMap :: CCanMap a 
101 102
emptyCCanMap = CCanMap { cts_given = Map.empty
                       , cts_derived = Map.empty, cts_wanted = Map.empty } 
103 104 105 106 107 108

updCCanMap:: Ord a => (a,CanonicalCt) -> CCanMap a -> CCanMap a 
updCCanMap (a,ct) cmap 
  = case cc_flavor ct of 
      Wanted {} 
          -> cmap { cts_wanted = Map.insertWith unionBags a this_ct (cts_wanted cmap) } 
109 110 111 112
      Given {} 
          -> cmap { cts_given = Map.insertWith unionBags a this_ct (cts_given cmap) }
      Derived {}
          -> cmap { cts_derived = Map.insertWith unionBags a this_ct (cts_derived cmap) }
113 114 115 116 117
  where this_ct = singleCCan ct 

getRelevantCts :: Ord a => a -> CCanMap a -> (CanonicalCts, CCanMap a) 
-- Gets the relevant constraints and returns the rest of the CCanMap
getRelevantCts a cmap 
118 119 120
    = let relevant = unionManyBags [ Map.findWithDefault emptyCCan a (cts_wanted cmap)
                                   , Map.findWithDefault emptyCCan a (cts_given cmap)
                                   , Map.findWithDefault emptyCCan a (cts_derived cmap) ]
121
          residual_map = cmap { cts_wanted = Map.delete a (cts_wanted cmap) 
122 123
                              , cts_given = Map.delete a (cts_given cmap) 
                              , cts_derived = Map.delete a (cts_derived cmap) }
124 125
      in (relevant, residual_map) 

126 127 128 129 130 131 132 133 134
extractUnsolvedCMap :: Ord a => CCanMap a -> (CanonicalCts, CCanMap a)
-- Gets the wanted or derived constraints and returns a residual
-- CCanMap with only givens.
extractUnsolvedCMap cmap =
  let wntd = Map.fold unionBags emptyCCan (cts_wanted cmap)
      derd = Map.fold unionBags emptyCCan (cts_derived cmap)
  in (wntd `unionBags` derd, 
           cmap { cts_wanted = Map.empty, cts_derived = Map.empty })

135

136
-- See Note [InertSet invariants]
137
data InertSet 
138
  = IS { inert_eqs          :: CanonicalCts               -- Equalities only (CTyEqCan)
139
       , inert_dicts        :: CCanMap Class              -- Dictionaries only
140
       , inert_ips          :: CCanMap (IPName Name)      -- Implicit parameters 
141 142
       , inert_frozen       :: CanonicalCts
       , inert_funeqs       :: CCanMap TyCon              -- Type family equalities only
143 144
               -- This representation allows us to quickly get to the relevant 
               -- inert constraints when interacting a work item with the inert set.
145
       }
146

147 148 149 150
tyVarsOfInert :: InertSet -> TcTyVarSet 
tyVarsOfInert (IS { inert_eqs    = eqs
                  , inert_dicts  = dictmap
                  , inert_ips    = ipmap
151 152 153 154 155
                  , inert_frozen = frozen
                  , inert_funeqs = funeqmap }) = tyVarsOfCanonicals cts
  where
    cts = eqs `andCCan` frozen `andCCan` cCanMapToBag dictmap
              `andCCan` cCanMapToBag ipmap `andCCan` cCanMapToBag funeqmap
156

157
instance Outputable InertSet where
158
  ppr is = vcat [ vcat (map ppr (Bag.bagToList $ inert_eqs is))
159
                , vcat (map ppr (Bag.bagToList $ cCanMapToBag (inert_dicts is)))
160 161
                , vcat (map ppr (Bag.bagToList $ cCanMapToBag (inert_ips is))) 
                , vcat (map ppr (Bag.bagToList $ cCanMapToBag (inert_funeqs is)))
162
                , vcat (map ppr (Bag.bagToList $ inert_frozen is))
163 164
                ]
                       
165
emptyInert :: InertSet
166
emptyInert = IS { inert_eqs    = Bag.emptyBag
167
                , inert_frozen = Bag.emptyBag
168 169
                , inert_dicts  = emptyCCanMap
                , inert_ips    = emptyCCanMap
170
                , inert_funeqs = emptyCCanMap }
171 172

updInertSet :: InertSet -> AtomicInert -> InertSet 
173 174 175 176 177 178 179 180 181 182
updInertSet is item 
  | isCTyEqCan item                     -- Other equality 
  = let eqs' = inert_eqs is `Bag.snocBag` item 
    in is { inert_eqs = eqs' } 
  | Just cls <- isCDictCan_Maybe item   -- Dictionary 
  = is { inert_dicts = updCCanMap (cls,item) (inert_dicts is) } 
  | Just x  <- isCIPCan_Maybe item      -- IP 
  = is { inert_ips   = updCCanMap (x,item) (inert_ips is) }  
  | Just tc <- isCFunEqCan_Maybe item   -- Function equality 
  = is { inert_funeqs = updCCanMap (tc,item) (inert_funeqs is) }
183
  | otherwise 
184
  = is { inert_frozen = inert_frozen is `Bag.snocBag` item }
185

186
extractUnsolved :: InertSet -> (InertSet, CanonicalCts)
187
-- Postcondition: the returned canonical cts are either Derived, or Wanted.
188
extractUnsolved is@(IS {inert_eqs = eqs}) 
189 190 191
  = let is_solved  = is { inert_eqs    = solved_eqs
                        , inert_dicts  = solved_dicts
                        , inert_ips    = solved_ips
192 193
                        , inert_frozen = emptyCCan
                        , inert_funeqs = solved_funeqs }
194
    in (is_solved, unsolved)
195

196
  where (unsolved_eqs, solved_eqs)       = Bag.partitionBag (not.isGivenCt) eqs
197 198 199
        (unsolved_ips, solved_ips)       = extractUnsolvedCMap (inert_ips is) 
        (unsolved_dicts, solved_dicts)   = extractUnsolvedCMap (inert_dicts is) 
        (unsolved_funeqs, solved_funeqs) = extractUnsolvedCMap (inert_funeqs is) 
200

201
        unsolved = unsolved_eqs `unionBags` inert_frozen is `unionBags`
202
                   unsolved_ips `unionBags` unsolved_dicts `unionBags` unsolved_funeqs
203 204 205 206 207 208 209 210 211 212 213 214 215 216
\end{code}

%*********************************************************************
%*                                                                   * 
*                      Main Interaction Solver                       *
*                                                                    *
**********************************************************************

Note [Basic plan] 
~~~~~~~~~~~~~~~~~
1. Canonicalise (unary)
2. Pairwise interaction (binary)
    * Take one from work list 
    * Try all pair-wise interactions with each constraint in inert
217 218 219 220
   
   As an optimisation, we prioritize the equalities both in the 
   worklist and in the inerts. 

221 222 223 224 225 226 227 228
3. Try to solve spontaneously for equalities involving touchables 
4. Top-level interaction (binary wrt top-level)
   Superclass decomposition belongs in (4), see note [Superclasses]

\begin{code}
type AtomicInert = CanonicalCt     -- constraint pulled from InertSet
type WorkItem    = CanonicalCt     -- constraint pulled from WorkList

229 230
-- A mixture of Given, Wanted, and Derived constraints. 
-- We split between equalities and the rest to process equalities first. 
231
type WorkList = CanonicalCts
232 233

unionWorkLists :: WorkList -> WorkList -> WorkList 
234
unionWorkLists = andCCan
235 236

isEmptyWorkList :: WorkList -> Bool 
237
isEmptyWorkList = isEmptyCCan 
238 239

emptyWorkList :: WorkList
240
emptyWorkList = emptyCCan
241

242
workListFromCCan :: CanonicalCt -> WorkList 
243
workListFromCCan = singleCCan
244

245
------------------------
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
data StopOrContinue 
  = Stop			-- Work item is consumed
  | ContinueWith WorkItem	-- Not consumed

instance Outputable StopOrContinue where
  ppr Stop             = ptext (sLit "Stop")
  ppr (ContinueWith w) = ptext (sLit "ContinueWith") <+> ppr w

-- Results after interacting a WorkItem as far as possible with an InertSet
data StageResult
  = SR { sr_inerts     :: InertSet
           -- The new InertSet to use (REPLACES the old InertSet)
       , sr_new_work   :: WorkList
           -- Any new work items generated (should be ADDED to the old WorkList)
           -- Invariant: 
           --    sr_stop = Just workitem => workitem is *not* in sr_inerts and
           --                               workitem is inert wrt to sr_inerts
       , sr_stop       :: StopOrContinue
       }

instance Outputable StageResult where
  ppr (SR { sr_inerts = inerts, sr_new_work = work, sr_stop = stop })
    = ptext (sLit "SR") <+> 
      braces (sep [ ptext (sLit "inerts =") <+> ppr inerts <> comma
             	  , ptext (sLit "new work =") <+> ppr work <> comma
             	  , ptext (sLit "stop =") <+> ppr stop])

type SimplifierStage = WorkItem -> InertSet -> TcS StageResult 

-- Combine a sequence of simplifier 'stages' to create a pipeline 
runSolverPipeline :: [(String, SimplifierStage)]
                  -> InertSet -> WorkItem 
                  -> TcS (InertSet, WorkList)
-- Precondition: non-empty list of stages 
runSolverPipeline pipeline inerts workItem
  = do { traceTcS "Start solver pipeline" $ 
            vcat [ ptext (sLit "work item =") <+> ppr workItem
                 , ptext (sLit "inerts    =") <+> ppr inerts]

       ; let itr_in = SR { sr_inerts = inerts
                        , sr_new_work = emptyWorkList
                        , sr_stop = ContinueWith workItem }
       ; itr_out <- run_pipeline pipeline itr_in
       ; let new_inert 
              = case sr_stop itr_out of 
       	          Stop              -> sr_inerts itr_out
292
                  ContinueWith item -> sr_inerts itr_out `updInertSet` item
293 294 295 296 297 298 299 300 301 302 303 304 305
       ; return (new_inert, sr_new_work itr_out) }
  where 
    run_pipeline :: [(String, SimplifierStage)]
                 -> StageResult -> TcS StageResult
    run_pipeline [] itr                         = return itr
    run_pipeline _  itr@(SR { sr_stop = Stop }) = return itr

    run_pipeline ((name,stage):stages) 
                 (SR { sr_new_work = accum_work
                     , sr_inerts   = inerts
                     , sr_stop     = ContinueWith work_item })
      = do { itr <- stage work_item inerts 
           ; traceTcS ("Stage result (" ++ name ++ ")") (ppr itr)
306
           ; let itr' = itr { sr_new_work = accum_work `unionWorkLists` sr_new_work itr }
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
           ; run_pipeline stages itr' }
\end{code}

Example 1:
  Inert:   {c ~ d, F a ~ t, b ~ Int, a ~ ty} (all given)
  Reagent: a ~ [b] (given)

React with (c~d)     ==> IR (ContinueWith (a~[b]))  True    []
React with (F a ~ t) ==> IR (ContinueWith (a~[b]))  False   [F [b] ~ t]
React with (b ~ Int) ==> IR (ContinueWith (a~[Int]) True    []

Example 2:
  Inert:  {c ~w d, F a ~g t, b ~w Int, a ~w ty}
  Reagent: a ~w [b]

React with (c ~w d)   ==> IR (ContinueWith (a~[b]))  True    []
React with (F a ~g t) ==> IR (ContinueWith (a~[b]))  True    []    (can't rewrite given with wanted!)
etc.

Example 3:
  Inert:  {a ~ Int, F Int ~ b} (given)
  Reagent: F a ~ b (wanted)

React with (a ~ Int)   ==> IR (ContinueWith (F Int ~ b)) True []
React with (F Int ~ b) ==> IR Stop True []    -- after substituting we re-canonicalize and get nothing

\begin{code}
-- Main interaction solver: we fully solve the worklist 'in one go', 
-- returning an extended inert set.
--
-- See Note [Touchables and givens].
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
solveInteractGiven :: InertSet -> GivenLoc -> [EvVar] -> TcS InertSet
solveInteractGiven inert gloc evs
  = do { (_, inert_ret) <- solveInteract inert $ listToBag $
                           map mk_given evs
       ; return inert_ret }
  where
    flav = Given gloc
    mk_given ev = mkEvVarX ev flav

solveInteractWanted :: InertSet -> [WantedEvVar] -> TcS InertSet
solveInteractWanted inert wvs
  = do { (_,inert_ret) <- solveInteract inert $ listToBag $
                          map wantedToFlavored wvs
       ; return inert_ret }

solveInteract :: InertSet -> Bag FlavoredEvVar -> TcS (Bool, InertSet)
-- Post: (True,  inert_set) means we managed to discharge all constraints
--                          without actually doing any interactions!
--       (False, inert_set) means some interactions occurred
357 358
solveInteract inert ws 
  = do { dyn_flags <- getDynFlags
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
       ; sctx <- getTcSContext

       ; traceTcS "solveInteract, before clever canonicalization:" $
         vcat [ text "ws = " <+>  ppr (mapBag (\(EvVarX ev ct)
                                                   -> (ct,evVarPred ev)) ws)
              , text "inert = " <+> ppr inert ]

       ; (flag, inert_ret) <- foldlBagM (tryPreSolveAndInteract sctx dyn_flags) (True,inert) ws 

       ; traceTcS "solveInteract, after clever canonicalization (and interaction):" $
         vcat [ text "No interaction happened = " <+> ppr flag
              , text "inert_ret = " <+> ppr inert_ret ]

       ; return (flag, inert_ret) }


tryPreSolveAndInteract :: SimplContext
                       -> DynFlags
                       -> (Bool, InertSet)
                       -> FlavoredEvVar
                       -> TcS (Bool, InertSet)
-- Returns: True if it was able to discharge this constraint AND all previous ones
tryPreSolveAndInteract sctx dyn_flags (all_previous_discharged, inert)
                       flavev@(EvVarX ev_var fl)
  = do { let inert_cts = get_inert_cts (evVarPred ev_var)

       ; this_one_discharged <- dischargeFromCCans inert_cts flavev

       ; if this_one_discharged
         then return (all_previous_discharged, inert)
389

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
         else do
       { extra_cts <- mkCanonical fl ev_var
       ; inert_ret <- solveInteractWithDepth (ctxtStkDepth dyn_flags,0,[])
                                             inert extra_cts
       ; return (False, inert_ret) } }

  where
    get_inert_cts (ClassP clas _)
      | simplEqsOnly sctx = emptyCCan
      | otherwise         = fst (getRelevantCts clas (inert_dicts inert))
    get_inert_cts (IParam {})
      = emptyCCan -- We must not do the same thing for IParams, because (contrary
                  -- to dictionaries), work items /must/ override inert items.
                 -- See Note [Overriding implicit parameters] in TcInteract.
    get_inert_cts (EqPred {})
      = inert_eqs inert `unionBags` cCanMapToBag (inert_funeqs inert)

dischargeFromCCans :: CanonicalCts -> FlavoredEvVar -> TcS Bool
dischargeFromCCans cans (EvVarX ev fl)
  = Bag.foldlBagM discharge_ct False cans
  where discharge_ct :: Bool -> CanonicalCt -> TcS Bool
411
        discharge_ct True _ct = return True
412 413 414 415 416 417 418 419 420
        discharge_ct False ct
          | evVarPred (cc_id ct) `tcEqPred` evVarPred ev
          , cc_flavor ct `canSolve` fl
          = do { when (isWanted fl) $ set_ev_bind ev (cc_id ct) 
               ; return True }
          where set_ev_bind x y
                    | EqPred {} <- evVarPred y
                    = setEvBind x (EvCoercion (mkCoVarCoercion y))
                    | otherwise = setEvBind x (EvId y)
421 422 423 424 425
        discharge_ct False _ct = return False
\end{code}

Note [Avoiding the superclass explosion] 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
426 427 428 429 430 431 432 433 434 435 436 437
This note now is not as significant as it used to be because we no
longer add the superclasses of Wanted as Derived, except only if they
have equality superclasses or superclasses with functional
dependencies. The fear was that hundreds of identical wanteds would
give rise each to the same superclass or equality Derived's which
would lead to a blo-up in the number of interactions.

Instead, what we do with tryPreSolveAndCanon, is when we encounter a
new constraint, we very quickly see if it can be immediately
discharged by a class constraint in our inert set or the previous
canonicals. If so, we add nothing to the returned canonical
constraints.
438 439

\begin{code}
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
solveOne :: InertSet -> WorkItem -> TcS InertSet 
solveOne inerts workItem 
  = do { dyn_flags <- getDynFlags
       ; solveOneWithDepth (ctxtStkDepth dyn_flags,0,[]) inerts workItem
       }

-----------------
solveInteractWithDepth :: (Int, Int, [WorkItem])
                       -> InertSet -> WorkList -> TcS InertSet
solveInteractWithDepth ctxt@(max_depth,n,stack) inert ws 
  | isEmptyWorkList ws
  = return inert

  | n > max_depth 
  = solverDepthErrorTcS n stack

  | otherwise 
  = do { traceTcS "solveInteractWithDepth" $ 
458 459 460 461
              vcat [ text "Current depth =" <+> ppr n
                   , text "Max depth =" <+> ppr max_depth ]

	      -- Solve equalities first
462
       ; let (eqs, non_eqs) = Bag.partitionBag isCTyEqCan ws
463 464
       ; is_from_eqs <- Bag.foldlBagM (solveOneWithDepth ctxt) inert eqs
       ; Bag.foldlBagM (solveOneWithDepth ctxt) is_from_eqs non_eqs }
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487

------------------
-- Fully interact the given work item with an inert set, and return a
-- new inert set which has assimilated the new information.
solveOneWithDepth :: (Int, Int, [WorkItem])
                  -> InertSet -> WorkItem -> TcS InertSet
solveOneWithDepth (max_depth, n, stack) inert work
  = do { traceTcS0 (indent ++ "Solving {") (ppr work)
       ; (new_inert, new_work) <- runSolverPipeline thePipeline inert work
         
       ; traceTcS0 (indent ++ "Subgoals:") (ppr new_work)

	 -- Recursively solve the new work generated 
         -- from workItem, with a greater depth
       ; res_inert <- solveInteractWithDepth (max_depth, n+1, work:stack)
                                new_inert new_work 

       ; traceTcS0 (indent ++ "Done }") (ppr work) 
       ; return res_inert }
  where
    indent = replicate (2*n) ' '

thePipeline :: [(String,SimplifierStage)]
488 489 490 491
thePipeline = [ ("interact with inert eqs", interactWithInertEqsStage)
              , ("interact with inerts",    interactWithInertsStage)
              , ("spontaneous solve",       spontaneousSolveStage)
              , ("top-level reactions",     topReactionsStage) ]
492 493 494 495 496 497 498 499
\end{code}

*********************************************************************************
*                                                                               * 
                       The spontaneous-solve Stage
*                                                                               *
*********************************************************************************

500 501 502 503 504 505
Note [Efficient Orientation] 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There are two cases where we have to be careful about 
orienting equalities to get better efficiency. 

506
Case 1: In Rewriting Equalities (function rewriteEqLHS) 
507

508 509 510 511 512 513 514 515 516 517
    When rewriting two equalities with the same LHS:
          (a)  (tv ~ xi1) 
          (b)  (tv ~ xi2) 
    We have a choice of producing work (xi1 ~ xi2) (up-to the
    canonicalization invariants) However, to prevent the inert items
    from getting kicked out of the inerts first, we prefer to
    canonicalize (xi1 ~ xi2) if (b) comes from the inert set, or (xi2
    ~ xi1) if (a) comes from the inert set.
    
    This choice is implemented using the WhichComesFromInert flag. 
518

519 520 521 522 523
Case 2: Functional Dependencies 
    Again, we should prefer, if possible, the inert variables on the RHS

Case 3: IP improvement work
    We must always rewrite so that the inert type is on the right. 
524

525 526 527
\begin{code}
spontaneousSolveStage :: SimplifierStage 
spontaneousSolveStage workItem inerts 
528 529
  = do { mSolve <- trySpontaneousSolve workItem

530
       ; case mSolve of 
531
           SPCantSolve -> -- No spontaneous solution for him, keep going
532 533
               return $ SR { sr_new_work   = emptyWorkList
                           , sr_inerts     = inerts
534 535
                           , sr_stop       = ContinueWith workItem }

536
           SPSolved workItem'
537 538 539 540 541 542 543 544 545 546
               | not (isGivenCt workItem) 
	       	 -- Original was wanted or derived but we have now made him 
                 -- given so we have to interact him with the inerts due to
                 -- its status change. This in turn may produce more work.
		 -- We do this *right now* (rather than just putting workItem'
		 -- back into the work-list) because we've solved 
               -> do { (new_inert, new_work) <- runSolverPipeline 
                             [ ("recursive interact with inert eqs", interactWithInertEqsStage)
                             , ("recursive interact with inerts", interactWithInertsStage)
                             ] inerts workItem'
547 548 549
                     ; return $ SR { sr_new_work = new_work 
                                   , sr_inerts   = new_inert -- will include workItem' 
                                   , sr_stop     = Stop }
550
                     }
551 552 553
               | otherwise 
                   -> -- Original was given; he must then be inert all right, and
                      -- workList' are all givens from flattening
554
                      return $ SR { sr_new_work = emptyWorkList
555 556
                                  , sr_inerts   = inerts `updInertSet` workItem' 
                                  , sr_stop     = Stop }
557 558 559 560
           SPError -> -- Return with no new work
               return $ SR { sr_new_work = emptyWorkList
                           , sr_inerts   = inerts
                           , sr_stop     = Stop }
561
       }
562

563 564 565 566 567 568
data SPSolveResult = SPCantSolve | SPSolved WorkItem | SPError
-- SPCantSolve means that we can't do the unification because e.g. the variable is untouchable
-- SPSolved workItem' gives us a new *given* to go on 
-- SPError means that it's completely impossible to solve this equality, eg due to a kind error


569
-- @trySpontaneousSolve wi@ solves equalities where one side is a
570
-- touchable unification variable.
571
--     	    See Note [Touchables and givens] 
572 573
trySpontaneousSolve :: WorkItem -> TcS SPSolveResult
trySpontaneousSolve workItem@(CTyEqCan { cc_id = cv, cc_flavor = gw, cc_tyvar = tv1, cc_rhs = xi })
574
  | isGiven gw
575
  = return SPCantSolve
576 577 578 579
  | Just tv2 <- tcGetTyVar_maybe xi
  = do { tch1 <- isTouchableMetaTyVar tv1
       ; tch2 <- isTouchableMetaTyVar tv2
       ; case (tch1, tch2) of
580 581 582 583
           (True,  True)  -> trySpontaneousEqTwoWay cv gw tv1 tv2
           (True,  False) -> trySpontaneousEqOneWay cv gw tv1 xi
           (False, True)  -> trySpontaneousEqOneWay cv gw tv2 (mkTyVarTy tv1)
	   _ -> return SPCantSolve }
584 585
  | otherwise
  = do { tch1 <- isTouchableMetaTyVar tv1
586
       ; if tch1 then trySpontaneousEqOneWay cv gw tv1 xi
587
                 else do { traceTcS "Untouchable LHS, can't spontaneously solve workitem:" (ppr workItem) 
588
                         ; return SPCantSolve }
589
       }
590 591 592 593

  -- No need for 
  --      trySpontaneousSolve (CFunEqCan ...) = ...
  -- See Note [No touchables as FunEq RHS] in TcSMonad
594
trySpontaneousSolve _ = return SPCantSolve
595 596

----------------
597
trySpontaneousEqOneWay :: CoVar -> CtFlavor -> TcTyVar -> Xi -> TcS SPSolveResult
598
-- tv is a MetaTyVar, not untouchable
599
trySpontaneousEqOneWay cv gw tv xi	
600
  | not (isSigTyVar tv) || isTyVarTy xi 
601 602
  = do { let kxi = typeKind xi -- NB: 'xi' is fully rewritten according to the inerts 
                               -- so we have its more specific kind in our hands
603
       ; if kxi `isSubKind` tyVarKind tv then
604
             solveWithIdentity cv gw tv xi
605 606 607
         else return SPCantSolve
{-
         else if tyVarKind tv `isSubKind` kxi then
608 609 610 611 612 613
             return SPCantSolve -- kinds are compatible but we can't solveWithIdentity this way
                                -- This case covers the  a_touchable :: * ~ b_untouchable :: ?? 
                                -- which has to be deferred or floated out for someone else to solve 
                                -- it in a scope where 'b' is no longer untouchable.
         else do { addErrorTcS KindError gw (mkTyVarTy tv) xi -- See Note [Kind errors]
                 ; return SPError }
614
-}
615
       }
616
  | otherwise -- Still can't solve, sig tyvar and non-variable rhs
617
  = return SPCantSolve
618 619

----------------
620
trySpontaneousEqTwoWay :: CoVar -> CtFlavor -> TcTyVar -> TcTyVar -> TcS SPSolveResult
621
-- Both tyvars are *touchable* MetaTyvars so there is only a chance for kind error here
622
trySpontaneousEqTwoWay cv gw tv1 tv2
623
  | k1 `isSubKind` k2
624
  , nicer_to_update_tv2 = solveWithIdentity cv gw tv2 (mkTyVarTy tv1)
625
  | k2 `isSubKind` k1 
626
  = solveWithIdentity cv gw tv1 (mkTyVarTy tv2)
627
  | otherwise -- None is a subkind of the other, but they are both touchable! 
628 629 630
  = return SPCantSolve
    -- do { addErrorTcS KindError gw (mkTyVarTy tv1) (mkTyVarTy tv2)
    --   ; return SPError }
631 632 633 634 635 636
  where
    k1 = tyVarKind tv1
    k2 = tyVarKind tv2
    nicer_to_update_tv2 = isSigTyVar tv1 || isSystemName (Var.varName tv2)
\end{code}

637 638 639 640 641 642
Note [Kind errors] 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider the wanted problem: 
      alpha ~ (# Int, Int #) 
where alpha :: ?? and (# Int, Int #) :: (#). We can't spontaneously solve this constraint, 
but we should rather reject the program that give rise to it. If 'trySpontaneousEqTwoWay' 
643
simply returns @CantSolve@ then that wanted constraint is going to propagate all the way and 
644
get quantified over in inference mode. That's bad because we do know at this point that the 
645
constraint is insoluble. Instead, we call 'recKindErrorTcS' here, which will fail later on.
646 647

The same applies in canonicalization code in case of kind errors in the givens. 
648

649
However, when we canonicalize givens we only check for compatibility (@compatKind@). 
650
If there were a kind error in the givens, this means some form of inconsistency or dead code.
651

652 653 654 655 656
You may think that when we spontaneously solve wanteds we may have to look through the 
bindings to determine the right kind of the RHS type. E.g one may be worried that xi is 
@alpha@ where alpha :: ? and a previous spontaneous solving has set (alpha := f) with (f :: *).
But we orient our constraints so that spontaneously solved ones can rewrite all other constraint
so this situation can't happen. 
657

658 659
Note [Spontaneous solving and kind compatibility] 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
660 661 662
Note that our canonical constraints insist that *all* equalities (tv ~
xi) or (F xis ~ rhs) require the LHS and the RHS to have *compatible*
the same kinds.  ("compatible" means one is a subKind of the other.)
663

664 665 666 667 668 669 670 671 672 673 674 675 676 677
  - It can't be *equal* kinds, because
     b) wanted constraints don't necessarily have identical kinds
               eg   alpha::? ~ Int
     b) a solved wanted constraint becomes a given

  - SPJ thinks that *given* constraints (tv ~ tau) always have that
    tau has a sub-kind of tv; and when solving wanted constraints
    in trySpontaneousEqTwoWay we re-orient to achieve this.

  - Note that the kind invariant is maintained by rewriting.
    Eg wanted1 rewrites wanted2; if both were compatible kinds before,
       wanted2 will be afterwards.  Similarly givens.

Caveat:
678 679 680 681 682 683 684 685 686
  - Givens from higher-rank, such as: 
          type family T b :: * -> * -> * 
          type instance T Bool = (->) 

          f :: forall a. ((T a ~ (->)) => ...) -> a -> ... 
          flop = f (...) True 
     Whereas we would be able to apply the type instance, we would not be able to 
     use the given (T Bool ~ (->)) in the body of 'flop' 

687 688 689 690 691 692 693

Note [Avoid double unifications] 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The spontaneous solver has to return a given which mentions the unified unification
variable *on the left* of the equality. Here is what happens if not: 
  Original wanted:  (a ~ alpha),  (alpha ~ Int) 
We spontaneously solve the first wanted, without changing the order! 
694
      given : a ~ alpha      [having unified alpha := a] 
695 696 697
Now the second wanted comes along, but he cannot rewrite the given, so we simply continue.
At the end we spontaneously solve that guy, *reunifying*  [alpha := Int] 

698
We avoid this problem by orienting the resulting given so that the unification
699 700
variable is on the left.  [Note that alternatively we could attempt to
enforce this at canonicalization]
701

702 703 704
See also Note [No touchables as FunEq RHS] in TcSMonad; avoiding
double unifications is the main reason we disallow touchable
unification variables as RHS of type family equations: F xis ~ alpha.
705 706 707

\begin{code}
----------------
708 709

solveWithIdentity :: CoVar -> CtFlavor -> TcTyVar -> Xi -> TcS SPSolveResult
710 711
-- Solve with the identity coercion 
-- Precondition: kind(xi) is a sub-kind of kind(tv)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
712 713 714
-- Precondition: CtFlavor is Wanted or Derived
-- See [New Wanted Superclass Work] to see why solveWithIdentity 
--     must work for Derived as well as Wanted
715
-- Returns: workItem where 
716
--        workItem = the new Given constraint
717 718 719
solveWithIdentity cv wd tv xi 
  = do { traceTcS "Sneaky unification:" $ 
                       vcat [text "Coercion variable:  " <+> ppr wd, 
720 721 722
                             text "Coercion:           " <+> pprEq (mkTyVarTy tv) xi,
                             text "Left  Kind is     : " <+> ppr (typeKind (mkTyVarTy tv)),
                             text "Right Kind is     : " <+> ppr (typeKind xi)
723
                  ]
724

725 726
       ; setWantedTyBind tv xi
       ; cv_given <- newGivenCoVar (mkTyVarTy tv) xi xi
727

728 729
       ; when (isWanted wd) (setWantedCoBind cv xi)
           -- We don't want to do this for Derived, that's why we use 'when (isWanted wd)'
730 731 732

       ; return $ SPSolved (CTyEqCan { cc_id = cv_given
                                     , cc_flavor = mkGivenFlavor wd UnkSkol
733
                                     , cc_tyvar  = tv, cc_rhs = xi }) }
734 735 736
\end{code}


737 738


739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
*********************************************************************************
*                                                                               * 
                       The interact-with-inert Stage
*                                                                               *
*********************************************************************************

\begin{code}
-- Interaction result of  WorkItem <~> AtomicInert
data InteractResult
   = IR { ir_stop         :: StopOrContinue
            -- Stop
            --   => Reagent (work item) consumed.
            -- ContinueWith new_reagent
            --   => Reagent transformed but keep gathering interactions. 
            --      The transformed item remains inert with respect 
            --      to any previously encountered inerts.

        , ir_inert_action :: InertAction
            -- Whether the inert item should remain in the InertSet.

        , ir_new_work     :: WorkList
            -- new work items to add to the WorkList
        }

-- What to do with the inert reactant.
764 765 766
data InertAction = KeepInert 
                 | DropInert 
                 | KeepTransformedInert CanonicalCt -- Keep a slightly transformed inert
767 768

mkIRContinue :: Monad m => WorkItem -> InertAction -> WorkList -> m InteractResult
769
mkIRContinue wi keep newWork = return $ IR (ContinueWith wi) keep newWork 
770 771

mkIRStop :: Monad m => InertAction -> WorkList -> m InteractResult
772
mkIRStop keep newWork = return $ IR Stop keep newWork 
773

774
dischargeWorkItem :: Monad m => m InteractResult
775
dischargeWorkItem = mkIRStop KeepInert emptyWorkList
776 777

noInteraction :: Monad m => WorkItem -> m InteractResult
778
noInteraction workItem = mkIRContinue workItem KeepInert emptyWorkList
779

dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
780
data WhichComesFromInert = LeftComesFromInert | RightComesFromInert 
781
     -- See Note [Efficient Orientation] 
782

783

784
---------------------------------------------------
785 786 787
-- Interact a single WorkItem with the equalities of an inert set as
-- far as possible, i.e. until we get a Stop result from an individual
-- reaction (i.e. when the WorkItem is consumed), or until we've
788 789 790 791
-- interact the WorkItem with the entire equalities of the InertSet

interactWithInertEqsStage :: SimplifierStage 
interactWithInertEqsStage workItem inert
792 793 794 795 796
  = Bag.foldlBagM interactNext initITR (inert_eqs inert)
  where
    initITR = SR { sr_inerts   = inert { inert_eqs = emptyCCan }
                 , sr_new_work = emptyWorkList
                 , sr_stop     = ContinueWith workItem }
797

798 799 800 801
---------------------------------------------------
-- Interact a single WorkItem with *non-equality* constraints in the inert set. 
-- Precondition: equality interactions must have already happened, hence we have 
-- to pick up some information from the incoming inert, before folding over the 
802 803
-- "Other" constraints it contains!

804 805
interactWithInertsStage :: SimplifierStage
interactWithInertsStage workItem inert
806 807 808 809 810
  = let (relevant, inert_residual) = getISRelevant workItem inert 
        initITR = SR { sr_inerts   = inert_residual
                     , sr_new_work = emptyWorkList
                     , sr_stop     = ContinueWith workItem } 
    in Bag.foldlBagM interactNext initITR relevant 
811
  where 
812
    getISRelevant :: CanonicalCt -> InertSet -> (CanonicalCts, InertSet) 
813 814 815 816 817 818
    getISRelevant (CFrozenErr {}) is = (emptyCCan, is)
                  -- Nothing s relevant; we have alread interacted
                  -- it with the equalities in the inert set

    getISRelevant (CDictCan { cc_class = cls } ) is
      = let (relevant, residual_map) = getRelevantCts cls (inert_dicts is)
819 820 821 822 823 824 825 826 827 828 829 830 831
        in (relevant, is { inert_dicts = residual_map }) 
    getISRelevant (CFunEqCan { cc_fun = tc } ) is 
      = let (relevant, residual_map) = getRelevantCts tc (inert_funeqs is) 
        in (relevant, is { inert_funeqs = residual_map })
    getISRelevant (CIPCan { cc_ip_nm = nm }) is 
      = let (relevant, residual_map) = getRelevantCts nm (inert_ips is)
        in (relevant, is { inert_ips = residual_map }) 
    -- An equality, finally, may kick everything except equalities out 
    -- because we have already interacted the equalities in interactWithInertEqsStage
    getISRelevant _eq_ct is  -- Equality, everything is relevant for this one 
                             -- TODO: if we were caching variables, we'd know that only 
                             --       some are relevant. Experiment with this for now. 
      = let cts = cCanMapToBag (inert_ips is) `unionBags` 
832 833 834
                    cCanMapToBag (inert_dicts is) `unionBags` cCanMapToBag (inert_funeqs is)
        in (cts, is { inert_dicts  = emptyCCanMap
                    , inert_ips    = emptyCCanMap
835
                    , inert_funeqs = emptyCCanMap })
836

837 838 839
interactNext :: StageResult -> AtomicInert -> TcS StageResult 
interactNext it inert  
  | ContinueWith workItem <- sr_stop it
840 841
  = do { let inerts      = sr_inerts it 

842
       ; ir <- interactWithInert inert workItem
843

844 845
       -- New inerts depend on whether we KeepInert or not and must
       -- be updated with FD improvement information from the interaction result (ir)
846
       ; let inerts_new = case ir_inert_action ir of
847 848 849
                            KeepInert                   -> inerts `updInertSet` inert
                            DropInert                   -> inerts
                            KeepTransformedInert inert' -> inerts `updInertSet` inert'
850 851 852 853 854 855

       ; return $ SR { sr_inerts   = inerts_new
                     , sr_new_work = sr_new_work it `unionWorkLists` ir_new_work ir
                     , sr_stop     = ir_stop ir } }
  | otherwise 
  = return $ it { sr_inerts = (sr_inerts it) `updInertSet` inert }
856 857

-- Do a single interaction of two constraints.
858 859
interactWithInert :: AtomicInert -> WorkItem -> TcS InteractResult
interactWithInert inert workitem 
860 861
  =  do { ctxt <- getTcSContext
        ; let is_allowed  = allowedInteraction (simplEqsOnly ctxt) inert workitem 
862 863 864

        ; if is_allowed then 
              doInteractWithInert inert workitem 
865 866 867 868 869 870 871 872 873 874 875
          else 
              noInteraction workitem 
        }

allowedInteraction :: Bool -> AtomicInert -> WorkItem -> Bool 
-- Allowed interactions 
allowedInteraction eqs_only (CDictCan {}) (CDictCan {}) = not eqs_only
allowedInteraction eqs_only (CIPCan {})   (CIPCan {})   = not eqs_only
allowedInteraction _ _ _ = True 

--------------------------------------------
876
doInteractWithInert :: CanonicalCt -> CanonicalCt -> TcS InteractResult
877 878
-- Identical class constraints.

879
doInteractWithInert
880
           (CDictCan { cc_id = d1, cc_flavor = fl1, cc_class = cls1, cc_tyargs = tys1 }) 
881
  workItem@(CDictCan { cc_flavor = fl2, cc_class = cls2, cc_tyargs = tys2 })
882 883 884 885 886
  | cls1 == cls2 && (and $ zipWith tcEqType tys1 tys2)
  = solveOneFromTheOther (d1,fl1) workItem 

  | cls1 == cls2 && (not (isGiven fl1 && isGiven fl2))
  = 	 -- See Note [When improvement happens]
887 888 889 890
    do { let pty1 = ClassP cls1 tys1
             pty2 = ClassP cls2 tys2
             work_item_pred_loc = (pty2, pprFlavorArising fl2)
             inert_pred_loc     = (pty1, pprFlavorArising fl1)
891
	     loc                = combineCtLoc fl1 fl2
892 893
             eqn_pred_locs = improveFromAnother work_item_pred_loc inert_pred_loc
                             -- See Note [Efficient Orientation]
894

895 896 897 898 899
       ; derived_evs <- mkDerivedFunDepEqns loc eqn_pred_locs
       ; fd_work <- mapM mkCanonicalFEV derived_evs
                 -- See Note [Generating extra equalities]

       ; mkIRContinue workItem KeepInert (unionManyBags fd_work)
900 901 902 903
       }

-- Class constraint and given equality: use the equality to rewrite
-- the class constraint. 
904
doInteractWithInert (CTyEqCan { cc_id = cv, cc_flavor = ifl, cc_tyvar = tv, cc_rhs = xi }) 
905 906 907
                    (CDictCan { cc_id = dv, cc_flavor = wfl, cc_class = cl, cc_tyargs = xis }) 
  | ifl `canRewrite` wfl 
  , tv `elemVarSet` tyVarsOfTypes xis
908
  = do { rewritten_dict <- rewriteDict (cv,tv,xi) (dv,wfl,cl,xis)
909 910
            -- Continue with rewritten Dictionary because we can only be in the 
            -- interactWithEqsStage, so the dictionary is inert. 
911
       ; mkIRContinue rewritten_dict KeepInert emptyWorkList }
912
    
913
doInteractWithInert (CDictCan { cc_id = dv, cc_flavor = ifl, cc_class = cl, cc_tyargs = xis }) 
914 915 916
           workItem@(CTyEqCan { cc_id = cv, cc_flavor = wfl, cc_tyvar = tv, cc_rhs = xi })
  | wfl `canRewrite` ifl
  , tv `elemVarSet` tyVarsOfTypes xis
917 918
  = do { rewritten_dict <- rewriteDict (cv,tv,xi) (dv,ifl,cl,xis)
       ; mkIRContinue workItem DropInert (workListFromCCan rewritten_dict) }
919 920 921

-- Class constraint and given equality: use the equality to rewrite
-- the class constraint.
922
doInteractWithInert (CTyEqCan { cc_id = cv, cc_flavor = ifl, cc_tyvar = tv, cc_rhs = xi }) 
923 924 925 926
                    (CIPCan { cc_id = ipid, cc_flavor = wfl, cc_ip_nm = nm, cc_ip_ty = ty }) 
  | ifl `canRewrite` wfl
  , tv `elemVarSet` tyVarsOfType ty 
  = do { rewritten_ip <- rewriteIP (cv,tv,xi) (ipid,wfl,nm,ty) 
927
       ; mkIRContinue rewritten_ip KeepInert emptyWorkList } 
928

929
doInteractWithInert (CIPCan { cc_id = ipid, cc_flavor = ifl, cc_ip_nm = nm, cc_ip_ty = ty }) 
930 931 932 933
           workItem@(CTyEqCan { cc_id = cv, cc_flavor = wfl, cc_tyvar = tv, cc_rhs = xi })
  | wfl `canRewrite` ifl
  , tv `elemVarSet` tyVarsOfType ty
  = do { rewritten_ip <- rewriteIP (cv,tv,xi) (ipid,ifl,nm,ty) 
934
       ; mkIRContinue workItem DropInert (workListFromCCan rewritten_ip) }
935 936 937 938 939 940

-- Two implicit parameter constraints.  If the names are the same,
-- but their types are not, we generate a wanted type equality 
-- that equates the type (this is "improvement").  
-- However, we don't actually need the coercion evidence,
-- so we just generate a fresh coercion variable that isn't used anywhere.
941
doInteractWithInert (CIPCan { cc_id = id1, cc_flavor = ifl, cc_ip_nm = nm1, cc_ip_ty = ty1 }) 
942
           workItem@(CIPCan { cc_flavor = wfl, cc_ip_nm = nm2, cc_ip_ty = ty2 })
943 944 945 946
  | nm1 == nm2 && isGiven wfl && isGiven ifl
  = 	-- See Note [Overriding implicit parameters]
        -- Dump the inert item, override totally with the new one
	-- Do not require type equality
947
    mkIRContinue workItem DropInert emptyWorkList
948

949 950 951
  | nm1 == nm2 && ty1 `tcEqType` ty2 
  = solveOneFromTheOther (id1,ifl) workItem 

952
  | nm1 == nm2
953
  =  	-- See Note [When improvement happens]
954
    do { co_var <- newWantedCoVar ty2 ty1 -- See Note [Efficient Orientation]
955
       ; let flav = Wanted (combineCtLoc ifl wfl) 
956
       ; cans <- mkCanonical flav co_var 
957
       ; mkIRContinue workItem KeepInert cans }
958 959 960 961



-- Never rewrite a given with a wanted equality, and a type function
962 963 964
-- equality can never rewrite an equality. We rewrite LHS *and* RHS 
-- of function equalities so that our inert set exposes everything that 
-- we know about equalities.
965

966
-- Inert: equality, work item: function equality
967
doInteractWithInert (CTyEqCan { cc_id = cv1, cc_flavor = ifl, cc_tyvar = tv, cc_rhs = xi1 }) 
968 969 970
                    (CFunEqCan { cc_id = cv2, cc_flavor = wfl, cc_fun = tc
                               , cc_tyargs = args, cc_rhs = xi2 })
  | ifl `canRewrite` wfl 
971
  , tv `elemVarSet` tyVarsOfTypes (xi2:args) -- Rewrite RHS as well
972
  = do { rewritten_funeq <- rewriteFunEq (cv1,tv,xi1) (cv2,wfl,tc,args,xi2) 
973
       ; mkIRStop KeepInert (workListFromCCan rewritten_funeq) } 
974
         -- Must Stop here, because we may no longer be inert after the rewritting.
975 976

-- Inert: function equality, work item: equality
977
doInteractWithInert (CFunEqCan {cc_id = cv1, cc_flavor = ifl, cc_fun = tc
978 979 980
                              , cc_tyargs = args, cc_rhs = xi1 }) 
           workItem@(CTyEqCan { cc_id = cv2, cc_flavor = wfl, cc_tyvar = tv, cc_rhs = xi2 })
  | wfl `canRewrite` ifl
981
  , tv `elemVarSet` tyVarsOfTypes (xi1:args) -- Rewrite RHS as well
982
  = do { rewritten_funeq <- rewriteFunEq (cv2,tv,xi2) (cv1,ifl,tc,args,xi1) 
983
       ; mkIRContinue workItem DropInert (workListFromCCan rewritten_funeq) } 
984 985 986 987 988 989 990 991
         -- One may think that we could (KeepTransformedInert rewritten_funeq) 
         -- but that is wrong, because it may end up not being inert with respect 
         -- to future inerts. Example: 
         -- Original inert = {    F xis ~  [a], b ~ Maybe Int } 
         -- Work item comes along = a ~ [b] 
         -- If we keep { F xis ~ [b] } in the inert set we will end up with: 
         --      { F xis ~ [b], b ~ Maybe Int, a ~ [Maybe Int] } 
         -- At the end, which is *not* inert. So we should unfortunately DropInert here.
992

993
doInteractWithInert (CFunEqCan { cc_id = cv1, cc_flavor = fl1, cc_fun = tc1
994 995 996
                               , cc_tyargs = args1, cc_rhs = xi1 }) 
           workItem@(CFunEqCan { cc_id = cv2, cc_flavor = fl2, cc_fun = tc2
                               , cc_tyargs = args2, cc_rhs = xi2 })
997
  | fl1 `canSolve` fl2 && lhss_match
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
998
  = do { cans <- rewriteEqLHS LeftComesFromInert  (mkCoVarCoercion cv1,xi1) (cv2,fl2,xi2) 
999
       ; mkIRStop KeepInert cans } 
1000
  | fl2 `canSolve` fl1 && lhss_match
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1001
  = do { cans <- rewriteEqLHS RightComesFromInert (mkCoVarCoercion cv2,xi2) (cv1,fl1,xi1) 
1002
       ; mkIRContinue workItem DropInert cans }
1003 1004 1005
  where
    lhss_match = tc1 == tc2 && and (zipWith tcEqType args1 args2) 

1006
doInteractWithInert (CTyEqCan { cc_id = cv1, cc_flavor = fl1, cc_tyvar = tv1, cc_rhs = xi1 }) 
1007 1008
           workItem@(CTyEqCan { cc_id = cv2, cc_flavor = fl2, cc_tyvar = tv2, cc_rhs = xi2 })
-- Check for matching LHS 
1009
  | fl1 `canSolve` fl2 && tv1 == tv2 
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1010
  = do { cans <- rewriteEqLHS LeftComesFromInert (mkCoVarCoercion cv1,xi1) (cv2,fl2,xi2) 
1011
       ; mkIRStop KeepInert cans } 
1012

1013
  | fl2 `canSolve` fl1 && tv1 == tv2 
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1014
  = do { cans <- rewriteEqLHS RightComesFromInert (mkCoVarCoercion cv2,xi2) (cv1,fl1,xi1) 
1015
       ; mkIRContinue workItem DropInert cans }
1016 1017 1018
-- Check for rewriting RHS 
  | fl1 `canRewrite` fl2 && tv1 `elemVarSet` tyVarsOfType xi2 
  = do { rewritten_eq <- rewriteEqRHS (cv1,tv1,xi1) (cv2,fl2,tv2,xi2) 
1019
       ; mkIRStop KeepInert rewritten_eq }
1020 1021
  | fl2 `canRewrite` fl1 && tv2 `elemVarSet` tyVarsOfType xi1
  = do { rewritten_eq <- rewriteEqRHS (cv2,tv2,xi2) (cv1,fl1,tv1,xi1) 
1022
       ; mkIRContinue workItem DropInert rewritten_eq } 
1023

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
doInteractWithInert (CTyEqCan   { cc_id = cv1, cc_flavor = fl1, cc_tyvar = tv1, cc_rhs = xi1 })
                    (CFrozenErr { cc_id = cv2, cc_flavor = fl2 })
  | fl1 `canRewrite` fl2 && tv1 `elemVarSet` tyVarsOfEvVar cv2
  = do { rewritten_frozen <- rewriteFrozen (cv1, tv1, xi1) (cv2, fl2)
       ; mkIRStop KeepInert rewritten_frozen }

doInteractWithInert (CFrozenErr { cc_id = cv2, cc_flavor = fl2 })
           workItem@(CTyEqCan   { cc_id = cv1, cc_flavor = fl1, cc_tyvar = tv1, cc_rhs = xi1 })
  | fl1 `canRewrite` fl2 && tv1 `elemVarSet` tyVarsOfEvVar cv2
  = do { rewritten_frozen <- rewriteFrozen (cv1, tv1, xi1) (cv2, fl2)
       ; mkIRContinue workItem DropInert rewritten_frozen }

1036
-- Fall-through case for all other situations
1037
doInteractWithInert _ workItem = noInteraction workItem
1038

1039
-------------------------
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
-- Equational Rewriting 
rewriteDict  :: (CoVar, TcTyVar, Xi) -> (DictId, CtFlavor, Class, [Xi]) -> TcS CanonicalCt
rewriteDict (cv,tv,xi) (dv,gw,cl,xis) 
  = do { let cos  = substTysWith [tv] [mkCoVarCoercion cv] xis -- xis[tv] ~ xis[xi]
             args = substTysWith [tv] [xi] xis
             con  = classTyCon cl 
             dict_co = mkTyConCoercion con cos 
       ; dv' <- newDictVar cl args 
       ; case gw of 
           Wanted {}         -> setDictBind dv (EvCast dv' (mkSymCoercion dict_co))
1050 1051 1052
           Given {}          -> setDictBind dv' (EvCast dv dict_co) 
           Derived {}        -> return () -- Derived dicts we don't set any evidence

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
       ; return (CDictCan { cc_id = dv'
                          , cc_flavor = gw 
                          , cc_class = cl 
                          , cc_tyargs = args }) } 

rewriteIP :: (CoVar,TcTyVar,Xi) -> (EvVar,CtFlavor, IPName Name, TcType) -> TcS CanonicalCt 
rewriteIP (cv,tv,xi) (ipid,gw,nm,ty) 
  = do { let ip_co = substTyWith [tv] [mkCoVarCoercion cv] ty     -- ty[tv] ~ t[xi] 
             ty'   = substTyWith [tv] [xi] ty
       ; ipid' <- newIPVar nm ty' 
       ; case gw of 
           Wanted {}         -> setIPBind ipid  (EvCast ipid' (mkSymCoercion ip_co))
1065 1066 1067
           Given {}          -> setIPBind ipid' (EvCast ipid ip_co) 
           Derived {}        -> return () -- Derived ips: we don't set any evidence

1068 1069 1070 1071 1072 1073
       ; return (CIPCan { cc_id = ipid'
                        , cc_flavor = gw
                        , cc_ip_nm = nm
                        , cc_ip_ty = ty' }) }
   
rewriteFunEq :: (CoVar,TcTyVar,Xi) -> (CoVar,CtFlavor,TyCon, [Xi], Xi) -> TcS CanonicalCt
1074
rewriteFunEq (cv1,tv,xi1) (cv2,gw, tc,args,xi2)                   -- cv2 :: F args ~ xi2
1075 1076
  = do { let arg_cos = substTysWith [tv] [mkCoVarCoercion cv1] args 
             args'   = substTysWith [tv] [xi1] args 
1077 1078 1079 1080
             fun_co  = mkTyConCoercion tc arg_cos                 -- fun_co :: F args ~ F args'

             xi2'    = substTyWith [tv] [xi1] xi2
             xi2_co  = substTyWith [tv] [mkCoVarCoercion cv1] xi2 -- xi2_co :: xi2 ~ xi2' 
1081
       ; cv2' <- case gw of 
1082
                   Wanted {} -> do { cv2' <- newWantedCoVar (mkTyConApp tc args') xi2'
1083
                                   ; setWantedCoBind cv2 $ 
1084 1085
                                     fun_co `mkTransCoercion` 
                                            mkCoVarCoercion cv2' `mkTransCoercion` mkSymCoercion xi2_co
1086
                                   ; return cv2' } 
1087
                   Given {}  -> newGivenCoVar (mkTyConApp tc args') xi2' $
1088 1089
                                  mkSymCoercion fun_co `mkTransCoercion` 
                                                mkCoVarCoercion cv2 `mkTransCoercion` xi2_co
1090 1091
                   Derived {} -> newDerivedId (EqPred (mkTyConApp tc args') xi2')

1092 1093 1094 1095
       ; return (CFunEqCan { cc_id = cv2'
                           , cc_flavor = gw
                           , cc_tyargs = args'
                           , cc_fun = tc 
1096
                           , cc_rhs = xi2' }) }
1097 1098


1099
rewriteEqRHS :: (CoVar,TcTyVar,Xi) -> (CoVar,CtFlavor,TcTyVar,Xi) -> TcS WorkList
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
-- Use the first equality to rewrite the second, flavors already checked. 
-- E.g.          c1 : tv1 ~ xi1   c2 : tv2 ~ xi2
-- rewrites c2 to give
--               c2' : tv2 ~ xi2[xi1/tv1]
-- We must do an occurs check to sure the new constraint is canonical
-- So we might return an empty bag
rewriteEqRHS (cv1,tv1,xi1) (cv2,gw,tv2,xi2) 
  | Just tv2' <- tcGetTyVar_maybe xi2'
  , tv2 == tv2'	 -- In this case xi2[xi1/tv1] = tv2, so we have tv2~tv2
  = do { when (isWanted gw) (setWantedCoBind cv2 (mkSymCoercion co2')) 
       ; return emptyCCan } 
1111 1112 1113 1114 1115 1116
  | otherwise
  = do { cv2' <-
           case gw of
             Wanted {}
                 -> do { cv2' <- newWantedCoVar (mkTyVarTy tv2) xi2'
                       ; setWantedCoBind cv2 $
1117
                         mkCoVarCoercion cv2' `mkTransCoercion` mkSymCoercion co2'
1118
                       ; return cv2' }
1119 1120
             Given {} 
                 -> newGivenCoVar (mkTyVarTy tv2) xi2' $ 
1121
                    mkCoVarCoercion cv2 `mkTransCoercion` co2'
1122 1123
             Derived {} 
                 -> newDerivedId (EqPred (mkTyVarTy tv2) xi2')
1124

1125
       ; canEq gw cv2' (mkTyVarTy tv2) xi2' 
1126 1127 1128 1129 1130
       }
  where 
    xi2' = substTyWith [tv1] [xi1] xi2 
    co2' = substTyWith [tv1] [mkCoVarCoercion cv1] xi2  -- xi2 ~ xi2[xi1/tv1]

dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1131

1132
rewriteEqLHS :: WhichComesFromInert -> (Coercion,Xi) -> (CoVar,CtFlavor,Xi) -> TcS WorkList
1133
-- Used to ineract two equalities of the following form: 
1134 1135
-- First Equality:   co1: (XXX ~ xi1)  
-- Second Equality:  cv2: (XXX ~ xi2) 
1136
-- Where the cv1 `canSolve` cv2 equality 
1137 1138
-- We have an option of creating new work (xi1 ~ xi2) OR (xi2 ~ xi1), 
--    See Note [Efficient Orientation] for that 
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
rewriteEqLHS which (co1,xi1) (cv2,gw,xi2) 
  = do { cv2' <- case (isWanted gw, which) of 
                   (True,LeftComesFromInert) ->
                       do { cv2' <- newWantedCoVar xi2 xi1 
                          ; setWantedCoBind cv2 $ 
                            co1 `mkTransCoercion` mkSymCoercion (mkCoVarCoercion cv2')
                          ; return cv2' } 
                   (True,RightComesFromInert) -> 
                       do { cv2' <- newWantedCoVar xi1 xi2 
                          ; setWantedCoBind cv2 $ 
                            co1 `mkTransCoercion` mkCoVarCoercion cv2'
                          ; return cv2' } 
                   (False,LeftComesFromInert) ->
1152 1153 1154 1155
                       if isGiven gw then 
                           newGivenCoVar xi2 xi1 $ 
                           mkSymCoercion (mkCoVarCoercion cv2) `mkTransCoercion` co1 
                       else newDerivedId (EqPred xi2 xi1) 
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1156
                   (False,RightComesFromInert) -> 
1157 1158 1159 1160 1161
                       if isGiven gw then 
                           newGivenCoVar xi1 xi2 $
                           mkSymCoercion co1 `mkTransCoercion` mkCoVarCoercion cv2
                       else newDerivedId (EqPred xi1 xi2)
       ; mkCanonical gw cv2' }
1162
                                           
1163 1164 1165