TcInteract.lhs 86 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
import Class
import TyCon
25 26 27 28 29 30 31
import Name

import FunDeps

import Coercion
import Outputable

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

38 39
import Control.Monad( when )

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

44
Note [InertSet invariants]
45 46 47 48 49 50 51 52 53 54 55 56 57 58
~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
59

60 61 62 63 64 65
  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).
66 67

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

  8 No Given constraint mentions a touchable unification variable,
    except if the
73 74 75 76 77 78 79 80 81 82 83 84 85 86
 
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}

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

94
cCanMapToBag :: Ord a => CCanMap a -> CanonicalCts 
95 96 97
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)
98 99

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

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) } 
108 109 110 111
      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) }
112 113 114 115 116
  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 
117 118 119
    = let relevant = unionManyBags [ Map.findWithDefault emptyCCan a (cts_wanted cmap)
                                   , Map.findWithDefault emptyCCan a (cts_given cmap)
                                   , Map.findWithDefault emptyCCan a (cts_derived cmap) ]
120
          residual_map = cmap { cts_wanted = Map.delete a (cts_wanted cmap) 
121 122
                              , cts_given = Map.delete a (cts_given cmap) 
                              , cts_derived = Map.delete a (cts_derived cmap) }
123 124
      in (relevant, residual_map) 

125 126 127 128 129 130 131 132 133
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 })

134

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

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

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

updInertSet :: InertSet -> AtomicInert -> InertSet 
172 173 174 175 176 177 178 179 180 181
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) }
182
  | otherwise 
183
  = is { inert_frozen = inert_frozen is `Bag.snocBag` item }
184

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

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

200
        unsolved = unsolved_eqs `unionBags` inert_frozen is `unionBags`
201
                   unsolved_ips `unionBags` unsolved_dicts `unionBags` unsolved_funeqs
202 203 204 205 206 207 208 209 210 211 212 213 214 215
\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
216 217 218 219
   
   As an optimisation, we prioritize the equalities both in the 
   worklist and in the inerts. 

220 221 222 223 224 225 226 227
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

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

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

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

emptyWorkList :: WorkList
239
emptyWorkList = emptyCCan
240

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

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
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])

272 273 274
type SubGoalDepth = Int	  -- Starts at zero; used to limit infinite
     		    	  -- recursion of sub-goals
type SimplifierStage = SubGoalDepth -> WorkItem -> InertSet -> TcS StageResult 
275 276

-- Combine a sequence of simplifier 'stages' to create a pipeline 
277 278 279
runSolverPipeline :: SubGoalDepth
                  -> [(String, SimplifierStage)]
		  -> InertSet -> WorkItem 
280 281
                  -> TcS (InertSet, WorkList)
-- Precondition: non-empty list of stages 
282
runSolverPipeline depth pipeline inerts workItem
283 284 285 286 287
  = do { traceTcS "Start solver pipeline" $ 
            vcat [ ptext (sLit "work item =") <+> ppr workItem
                 , ptext (sLit "inerts    =") <+> ppr inerts]

       ; let itr_in = SR { sr_inerts = inerts
288 289
                         , sr_new_work = emptyWorkList
                         , sr_stop = ContinueWith workItem }
290 291 292 293
       ; itr_out <- run_pipeline pipeline itr_in
       ; let new_inert 
              = case sr_stop itr_out of 
       	          Stop              -> sr_inerts itr_out
294
                  ContinueWith item -> sr_inerts itr_out `updInertSet` item
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 })
306
      = do { itr <- stage depth work_item inerts 
307
           ; traceTcS ("Stage result (" ++ name ++ ")") (ppr itr)
308
           ; let itr' = itr { sr_new_work = accum_work `unionWorkLists` sr_new_work itr }
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 338 339
           ; 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].
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
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
359 360
solveInteract inert ws 
  = do { dyn_flags <- getDynFlags
361 362 363 364 365 366 367
       ; sctx <- getTcSContext

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

368 369
       ; (flag, inert_ret) <- foldrBagM (tryPreSolveAndInteract sctx dyn_flags) (True,inert) ws 
                        -- use foldr to preserve the order
370 371 372 373 374 375 376 377 378 379 380

       ; 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
                       -> FlavoredEvVar
381
                       -> (Bool, InertSet)
382 383
                       -> TcS (Bool, InertSet)
-- Returns: True if it was able to discharge this constraint AND all previous ones
384
tryPreSolveAndInteract sctx dyn_flags flavev@(EvVarX ev_var fl) (all_previous_discharged, inert)
385 386 387 388 389 390
  = 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)
391

392 393
         else do
       { extra_cts <- mkCanonical fl ev_var
394
       ; inert_ret <- solveInteractWithDepth (ctxtStkDepth dyn_flags,0,[]) extra_cts inert
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
       ; 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
412
        discharge_ct True _ct = return True
413 414 415 416 417 418 419 420 421
        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)
422 423 424 425 426
        discharge_ct False _ct = return False
\end{code}

Note [Avoiding the superclass explosion] 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
427 428 429 430 431 432 433 434 435 436 437 438
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.
439 440

\begin{code}
441 442
solveOne :: WorkItem -> InertSet -> TcS InertSet 
solveOne workItem inerts 
443
  = do { dyn_flags <- getDynFlags
444
       ; solveOneWithDepth (ctxtStkDepth dyn_flags,0,[]) workItem inerts
445 446 447 448
       }

-----------------
solveInteractWithDepth :: (Int, Int, [WorkItem])
449 450
                       -> WorkList -> InertSet -> TcS InertSet
solveInteractWithDepth ctxt@(max_depth,n,stack) ws inert
451 452 453 454 455 456 457 458
  | isEmptyWorkList ws
  = return inert

  | n > max_depth 
  = solverDepthErrorTcS n stack

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

	      -- Solve equalities first
464
       ; let (eqs, non_eqs) = Bag.partitionBag isCTyEqCan ws
465 466 467
       ; is_from_eqs <- Bag.foldrBagM (solveOneWithDepth ctxt) inert eqs
       ; Bag.foldrBagM (solveOneWithDepth ctxt) is_from_eqs non_eqs }
                        -- use foldr to preserve the order
468 469 470 471 472

------------------
-- 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])
473 474
                  -> WorkItem -> InertSet -> TcS InertSet
solveOneWithDepth (max_depth, depth, stack) work inert
475 476
  = do { traceFireTcS depth (text "Solving {" <+> ppr work)
       ; (new_inert, new_work) <- runSolverPipeline depth thePipeline inert work
477 478 479
         
	 -- Recursively solve the new work generated 
         -- from workItem, with a greater depth
480
       ; res_inert <- solveInteractWithDepth (max_depth, depth+1, work:stack) new_work new_inert 
481

482 483
       ; traceFireTcS depth (text "Done }" <+> ppr work) 

484 485 486
       ; return res_inert }

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

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

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

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

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

507 508 509 510 511 512 513 514 515 516
    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. 
517

518 519 520 521 522
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. 
523

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

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

535
           SPSolved workItem'
536 537 538 539 540 541
               | 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 
542 543 544
               -> do { bumpStepCountTcS
	       	     ; traceFireTcS depth (ptext (sLit "Spontaneous (w/d)") <+> ppr workItem)
                     ; (new_inert, new_work) <- runSolverPipeline depth
545 546 547
                             [ ("recursive interact with inert eqs", interactWithInertEqsStage)
                             , ("recursive interact with inerts", interactWithInertsStage)
                             ] inerts workItem'
548 549 550
                     ; return $ SR { sr_new_work = new_work 
                                   , sr_inerts   = new_inert -- will include workItem' 
                                   , sr_stop     = Stop }
551
                     }
552 553 554
               | otherwise 
                   -> -- Original was given; he must then be inert all right, and
                      -- workList' are all givens from flattening
555 556 557 558 559
                      do { bumpStepCountTcS
	       	         ; traceFireTcS depth (ptext (sLit "Spontaneous (g)") <+> ppr workItem)
                         ; return $ SR { sr_new_work = emptyWorkList
                                       , sr_inerts   = inerts `updInertSet` workItem' 
                                       , sr_stop     = Stop } }
560 561 562 563
           SPError -> -- Return with no new work
               return $ SR { sr_new_work = emptyWorkList
                           , sr_inerts   = inerts
                           , sr_stop     = Stop }
564
       }
565

566 567 568 569 570 571
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


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

  -- No need for 
  --      trySpontaneousSolve (CFunEqCan ...) = ...
  -- See Note [No touchables as FunEq RHS] in TcSMonad
598
trySpontaneousSolve _ = return SPCantSolve
599 600

----------------
601
trySpontaneousEqOneWay :: CoVar -> CtFlavor -> TcTyVar -> Xi -> TcS SPSolveResult
602
-- tv is a MetaTyVar, not untouchable
603
trySpontaneousEqOneWay cv gw tv xi	
604
  | not (isSigTyVar tv) || isTyVarTy xi 
605 606
  = do { let kxi = typeKind xi -- NB: 'xi' is fully rewritten according to the inerts 
                               -- so we have its more specific kind in our hands
607
       ; if kxi `isSubKind` tyVarKind tv then
608
             solveWithIdentity cv gw tv xi
609 610 611
         else return SPCantSolve
{-
         else if tyVarKind tv `isSubKind` kxi then
612 613 614 615 616 617
             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 }
618
-}
619
       }
620
  | otherwise -- Still can't solve, sig tyvar and non-variable rhs
621
  = return SPCantSolve
622 623

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

641 642 643 644 645 646
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' 
647
simply returns @CantSolve@ then that wanted constraint is going to propagate all the way and 
648
get quantified over in inference mode. That's bad because we do know at this point that the 
649
constraint is insoluble. Instead, we call 'recKindErrorTcS' here, which will fail later on.
650 651

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

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

656 657 658 659 660
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. 
661

662 663
Note [Spontaneous solving and kind compatibility] 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
664 665 666
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.)
667

668 669 670 671 672 673 674 675 676 677 678 679 680 681
  - 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:
682 683 684 685 686 687 688 689 690
  - 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' 

691 692 693 694 695 696 697

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! 
698
      given : a ~ alpha      [having unified alpha := a] 
699 700 701
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] 

702
We avoid this problem by orienting the resulting given so that the unification
703 704
variable is on the left.  [Note that alternatively we could attempt to
enforce this at canonicalization]
705

706 707 708
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.
709 710 711

\begin{code}
----------------
712 713

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

729 730
       ; setWantedTyBind tv xi
       ; cv_given <- newGivenCoVar (mkTyVarTy tv) xi xi
731

732 733
       ; when (isWanted wd) (setWantedCoBind cv xi)
           -- We don't want to do this for Derived, that's why we use 'when (isWanted wd)'
734 735 736

       ; return $ SPSolved (CTyEqCan { cc_id = cv_given
                                     , cc_flavor = mkGivenFlavor wd UnkSkol
737
                                     , cc_tyvar  = tv, cc_rhs = xi }) }
738 739 740
\end{code}


741 742


743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
*********************************************************************************
*                                                                               * 
                       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
765 766

        , ir_fire :: Maybe String    -- Tells whether a rule fired, and if so what
767 768 769
        }

-- What to do with the inert reactant.
770
data InertAction = KeepInert | DropInert 
771

772 773 774 775
mkIRContinue :: String -> WorkItem -> InertAction -> WorkList -> TcS InteractResult
mkIRContinue rule wi keep newWork 
  = return $ IR { ir_stop = ContinueWith wi, ir_inert_action = keep
                , ir_new_work = newWork, ir_fire = Just rule }
776

777 778 779 780
mkIRStop :: String -> WorkList -> TcS InteractResult
mkIRStop rule newWork
  = return $ IR { ir_stop = Stop, ir_inert_action = KeepInert
                , ir_new_work = newWork, ir_fire = Just rule }
781 782

noInteraction :: Monad m => WorkItem -> m InteractResult
783 784 785
noInteraction wi
  = return $ IR { ir_stop = ContinueWith wi, ir_inert_action = KeepInert
                , ir_new_work = emptyWorkList, ir_fire = Nothing }
786

dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
787
data WhichComesFromInert = LeftComesFromInert | RightComesFromInert 
788
     -- See Note [Efficient Orientation] 
789

790

791
---------------------------------------------------
792 793 794
-- 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
795 796 797
-- interact the WorkItem with the entire equalities of the InertSet

interactWithInertEqsStage :: SimplifierStage 
798
interactWithInertEqsStage depth workItem inert
799 800
  = Bag.foldrBagM (interactNext depth) initITR (inert_eqs inert)
                        -- use foldr to preserve the order
801 802 803 804
  where
    initITR = SR { sr_inerts   = inert { inert_eqs = emptyCCan }
                 , sr_new_work = emptyWorkList
                 , sr_stop     = ContinueWith workItem }
805

806 807 808 809
---------------------------------------------------
-- 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 
810 811
-- "Other" constraints it contains!

812
interactWithInertsStage :: SimplifierStage
813
interactWithInertsStage depth workItem inert
814 815 816 817
  = let (relevant, inert_residual) = getISRelevant workItem inert 
        initITR = SR { sr_inerts   = inert_residual
                     , sr_new_work = emptyWorkList
                     , sr_stop     = ContinueWith workItem } 
818 819
    in Bag.foldrBagM (interactNext depth) initITR relevant 
                        -- use foldr to preserve the order
820
  where 
821
    getISRelevant :: CanonicalCt -> InertSet -> (CanonicalCts, InertSet) 
822 823 824 825 826 827
    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)
828 829 830 831 832 833 834 835 836 837 838 839 840
        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` 
841 842 843
                    cCanMapToBag (inert_dicts is) `unionBags` cCanMapToBag (inert_funeqs is)
        in (cts, is { inert_dicts  = emptyCCanMap
                    , inert_ips    = emptyCCanMap
844
                    , inert_funeqs = emptyCCanMap })
845

846 847
interactNext :: SubGoalDepth -> AtomicInert -> StageResult -> TcS StageResult 
interactNext depth inert it
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
  | ContinueWith work_item <- sr_stop it
  = do { let inerts = sr_inerts it 

       ; IR { ir_new_work = new_work, ir_inert_action = inert_action
            , ir_fire = fire_info, ir_stop = stop } 
            <- interactWithInert inert work_item

       ; let mk_msg rule 
      	       = text rule <+> keep_doc
      	         <+> vcat [ ptext (sLit "Inert =") <+> ppr inert
      	                  , ptext (sLit "Work =")  <+> ppr work_item
      	                  , ppUnless (isEmptyBag new_work) $
                            ptext (sLit "New =") <+> ppr new_work ]
             keep_doc = case inert_action of
                 	  KeepInert -> ptext (sLit "[keep]")
                 	  DropInert -> ptext (sLit "[drop]")
       ; case fire_info of
           Just rule -> do { bumpStepCountTcS
                           ; traceFireTcS depth (mk_msg rule) }
           Nothing  -> return ()

       -- New inerts depend on whether we KeepInert or not 
       ; let inerts_new = case inert_action of
                            KeepInert -> inerts `updInertSet` inert
                            DropInert -> inerts
873 874

       ; return $ SR { sr_inerts   = inerts_new
875 876
                     , sr_new_work = sr_new_work it `unionWorkLists` new_work
                     , sr_stop     = stop } }
877 878
  | otherwise 
  = return $ it { sr_inerts = (sr_inerts it) `updInertSet` inert }
879 880

-- Do a single interaction of two constraints.
881 882
interactWithInert :: AtomicInert -> WorkItem -> TcS InteractResult
interactWithInert inert workitem 
883 884
  =  do { ctxt <- getTcSContext
        ; let is_allowed  = allowedInteraction (simplEqsOnly ctxt) inert workitem 
885 886 887

        ; if is_allowed then 
              doInteractWithInert inert workitem 
888 889 890 891 892 893 894 895 896 897 898
          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 

--------------------------------------------
899
doInteractWithInert :: CanonicalCt -> CanonicalCt -> TcS InteractResult
900 901
-- Identical class constraints.

902
doInteractWithInert
903
           (CDictCan { cc_id = d1, cc_flavor = fl1, cc_class = cls1, cc_tyargs = tys1 }) 
904
  workItem@(CDictCan { cc_id = d2, cc_flavor = fl2, cc_class = cls2, cc_tyargs = tys2 })
905 906 907 908 909
  | cls1 == cls2 && (and $ zipWith tcEqType tys1 tys2)
  = solveOneFromTheOther (d1,fl1) workItem 

  | cls1 == cls2 && (not (isGiven fl1 && isGiven fl2))
  = 	 -- See Note [When improvement happens]
910 911 912
    do { let pty1 = ClassP cls1 tys1
             pty2 = ClassP cls2 tys2
             inert_pred_loc     = (pty1, pprFlavorArising fl1)
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
             work_item_pred_loc = (pty2, pprFlavorArising fl2)
             fd_eqns = improveFromAnother 
                                  inert_pred_loc     -- the template
                                  work_item_pred_loc -- the one we aim to rewrite
                                  -- See Note [Efficient Orientation]

       ; m <- rewriteWithFunDeps fd_eqns tys2 fl2
       ; case m of 
           Nothing -> noInteraction workItem
           Just (rewritten_tys2, cos2, fd_work)

             | tcEqTypes tys1 rewritten_tys2
             -> -- Solve him on the spot in this case
                do { let dict_co = mkTyConCoercion (classTyCon cls1) cos2
                   ; when (isWanted fl2) $ setDictBind d2 (EvCast d1 dict_co)
                   ; mkIRStop "Cls/Cls fundep (solved)" fd_work }

             | isWanted fl2
             -> -- We could not quite solve him, but we stil rewrite him
	        -- Example: class C a b c | a -> b
		--          Given: C Int Bool x, Wanted: C Int beta y
		--          Then rewrite the wanted to C Int Bool y
		--          but note that is still not identical to the given
		-- The important thing is that the rewritten constraint is
		-- inert wrt the given.
		-- In fact, it is inert wrt all the previous inerts too, so
		-- we can keep on going rather than sending it back to the work list
                do { let dict_co = mkTyConCoercion (classTyCon cls1) cos2
                   ; d2' <- newDictVar cls1 rewritten_tys2
                   ; setDictBind d2 (EvCast d2' dict_co)
                   ; let workItem' = workItem { cc_id = d2', cc_tyargs = rewritten_tys2 }
                   ; mkIRContinue "Cls/Cls fundep (partial)" workItem' KeepInert fd_work } 

             | otherwise
             -> ASSERT (isDerived fl2)	-- Derived constraints have no evidence,
	     	       		  	-- so just produce the rewritten constraint
                let workItem' = workItem { cc_tyargs = rewritten_tys2 }
                in mkIRContinue "Cls/Cls fundep" workItem' KeepInert fd_work 
  }
952 953 954

-- Class constraint and given equality: use the equality to rewrite
-- the class constraint. 
955
doInteractWithInert (CTyEqCan { cc_id = cv, cc_flavor = ifl, cc_tyvar = tv, cc_rhs = xi }) 
956 957 958
                    (CDictCan { cc_id = dv, cc_flavor = wfl, cc_class = cl, cc_tyargs = xis }) 
  | ifl `canRewrite` wfl 
  , tv `elemVarSet` tyVarsOfTypes xis
959
  = do { rewritten_dict <- rewriteDict (cv,tv,xi) (dv,wfl,cl,xis)
960 961
            -- Continue with rewritten Dictionary because we can only be in the 
            -- interactWithEqsStage, so the dictionary is inert. 
962
       ; mkIRContinue "Eq/Cls" rewritten_dict KeepInert emptyWorkList }
963
    
964
doInteractWithInert (CDictCan { cc_id = dv, cc_flavor = ifl, cc_class = cl, cc_tyargs = xis }) 
965 966 967
           workItem@(CTyEqCan { cc_id = cv, cc_flavor = wfl, cc_tyvar = tv, cc_rhs = xi })
  | wfl `canRewrite` ifl
  , tv `elemVarSet` tyVarsOfTypes xis
968
  = do { rewritten_dict <- rewriteDict (cv,tv,xi) (dv,ifl,cl,xis)
969
       ; mkIRContinue "Cls/Eq" workItem DropInert (workListFromCCan rewritten_dict) }
970 971 972

-- Class constraint and given equality: use the equality to rewrite
-- the class constraint.
973
doInteractWithInert (CTyEqCan { cc_id = cv, cc_flavor = ifl, cc_tyvar = tv, cc_rhs = xi }) 
974 975 976 977
                    (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) 
978
       ; mkIRContinue "Eq/IP" rewritten_ip KeepInert emptyWorkList } 
979

980
doInteractWithInert (CIPCan { cc_id = ipid, cc_flavor = ifl, cc_ip_nm = nm, cc_ip_ty = ty }) 
981 982 983 984
           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) 
985
       ; mkIRContinue "IP/Eq" workItem DropInert (workListFromCCan rewritten_ip) }
986 987 988 989 990 991

-- 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.
992
doInteractWithInert (CIPCan { cc_id = id1, cc_flavor = ifl, cc_ip_nm = nm1, cc_ip_ty = ty1 }) 
993
           workItem@(CIPCan { cc_flavor = wfl, cc_ip_nm = nm2, cc_ip_ty = ty2 })
994 995 996 997
  | 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
998 999 1000
	-- For example, given let ?x::Int = 3 in let ?x::Bool = True in ...
	--              we must *override* the outer one with the inner one
    mkIRContinue "IP/IP override" workItem DropInert emptyWorkList
1001

1002 1003 1004
  | nm1 == nm2 && ty1 `tcEqType` ty2 
  = solveOneFromTheOther (id1,ifl) workItem 

1005
  | nm1 == nm2
1006
  =  	-- See Note [When improvement happens]
1007
    do { co_var <- newWantedCoVar ty2 ty1 -- See Note [Efficient Orientation]
1008
       ; let flav = Wanted (combineCtLoc ifl wfl) 
1009
       ; cans <- mkCanonical flav co_var 
1010
       ; mkIRContinue "IP/IP fundep" workItem KeepInert cans }
1011 1012

-- Never rewrite a given with a wanted equality, and a type function
1013 1014 1015
-- 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.
1016

1017
-- Inert: equality, work item: function equality
1018
doInteractWithInert (CTyEqCan { cc_id = cv1, cc_flavor = ifl, cc_tyvar = tv, cc_rhs = xi1 }) 
1019 1020 1021
                    (CFunEqCan { cc_id = cv2, cc_flavor = wfl, cc_fun = tc
                               , cc_tyargs = args, cc_rhs = xi2 })
  | ifl `canRewrite` wfl 
1022
  , tv `elemVarSet` tyVarsOfTypes (xi2:args) -- Rewrite RHS as well
1023
  = do { rewritten_funeq <- rewriteFunEq (cv1,tv,xi1) (cv2,wfl,tc,args,xi2) 
1024
       ; mkIRStop "Eq/FunEq" (workListFromCCan rewritten_funeq) } 
1025
         -- Must Stop here, because we may no longer be inert after the rewritting.
1026 1027

-- Inert: function equality, work item: equality
1028
doInteractWithInert (CFunEqCan {cc_id = cv1, cc_flavor = ifl, cc_fun = tc
1029 1030 1031
                              , cc_tyargs = args, cc_rhs = xi1 }) 
           workItem@(CTyEqCan { cc_id = cv2, cc_flavor = wfl, cc_tyvar = tv, cc_rhs = xi2 })
  | wfl `canRewrite` ifl
1032
  , tv `elemVarSet` tyVarsOfTypes (xi1:args) -- Rewrite RHS as well
1033
  = do { rewritten_funeq <- rewriteFunEq (cv2,tv,xi2) (cv1,ifl,tc,args,xi1) 
1034
       ; mkIRContinue "FunEq/Eq" workItem DropInert (workListFromCCan rewritten_funeq) } 
1035 1036 1037 1038 1039 1040 1041 1042
         -- 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.
1043

1044
doInteractWithInert (CFunEqCan { cc_id = cv1, cc_flavor = fl1, cc_fun = tc1
1045 1046 1047
                               , cc_tyargs = args1, cc_rhs = xi1 }) 
           workItem@(CFunEqCan { cc_id = cv2, cc_flavor = fl2, cc_fun = tc2
                               , cc_tyargs = args2, cc_rhs = xi2 })
1048
  | fl1 `canSolve` fl2 && lhss_match
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1049
  = do { cans <- rewriteEqLHS LeftComesFromInert  (mkCoVarCoercion cv1,xi1) (cv2,fl2,xi2) 
1050
       ; mkIRStop "FunEq/FunEq" cans } 
1051
  | fl2 `canSolve` fl1 && lhss_match
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1052
  = do { cans <- rewriteEqLHS RightComesFromInert (mkCoVarCoercion cv2,xi2) (cv1,fl1,xi1) 
1053
       ; mkIRContinue "FunEq/FunEq" workItem DropInert cans }
1054 1055 1056
  where
    lhss_match = tc1 == tc2 && and (zipWith tcEqType args1 args2) 

1057
doInteractWithInert (CTyEqCan { cc_id = cv1, cc_flavor = fl1, cc_tyvar = tv1, cc_rhs = xi1 }) 
1058 1059
           workItem@(CTyEqCan { cc_id = cv2, cc_flavor = fl2, cc_tyvar = tv2, cc_rhs = xi2 })
-- Check for matching LHS 
1060
  | fl1 `canSolve` fl2 && tv1 == tv2 
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1061
  = do { cans <- rewriteEqLHS LeftComesFromInert (mkCoVarCoercion cv1,xi1) (cv2,fl2,xi2) 
1062
       ; mkIRStop "Eq/Eq lhs" cans } 
1063

1064
  | fl2 `canSolve` fl1 && tv1 == tv2 
dimitris@microsoft.com's avatar
dimitris@microsoft.com committed
1065
  = do { cans <- rewriteEqLHS RightComesFromInert (mkCoVarCoercion cv2,xi2) (cv1,fl1,xi1) 
1066 1067
       ; mkIRContinue "Eq/Eq lhs" workItem DropInert cans }

1068 1069 1070
-- Check for rewriting RHS 
  | fl1 `canRewrite` fl2 && tv1 `elemVarSet` tyVarsOfType xi2 
  = do { rewritten_eq <- rewriteEqRHS (cv1,tv1,xi1) (cv2,fl2,tv2,xi2) 
1071 1072
       ; mkIRStop "Eq/Eq rhs" rewritten_eq }

1073 1074
  | fl2 `canRewrite` fl1 && tv2 `elemVarSet` tyVarsOfType xi1
  = do { rewritten_eq <- rewriteEqRHS (cv2,tv2,xi2) (cv1,fl1,tv1,xi1) 
1075
       ; mkIRContinue "Eq/Eq rhs" workItem DropInert rewritten_eq } 
1076

1077 1078 1079 1080
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)
1081
       ; mkIRStop "Frozen/Eq" rewritten_frozen }
1082 1083 1084 1085 1086

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)
1087
       ; mkIRContinue "Frozen/Eq" workItem DropInert rewritten_frozen }
1088

1089
-- Fall-through case for all other situations
1090
doInteractWithInert _ workItem = noInteraction workItem
1091

1092
-------------------------
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
-- 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))
1103 1104 1105
           Given {}          -> setDictBind dv' (EvCast dv dict_co) 
           Derived {}        -> return () -- Derived dicts we don't set any evidence

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
       ; 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))
1118 1119 1120
           Given {}          -> setIPBind ipid' (EvCast ipid ip_co) 
           Derived {}        -> return () -- Derived ips: we don't set any evidence

1121 1122 1123 1124 1125 1126
       ; 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
1127
rewriteFunEq (cv1,tv,xi1) (cv2,gw, tc,args,xi2)                   -- cv2 :: F args ~ xi2
1128 1129
  = do { let arg_cos = substTysWith [tv] [mkCoVarCoercion cv1] args 
             args'   = substTysWith [tv] [xi1] args 
1130 1131 1132 1133
             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' 
1134
       ; cv2' <- case gw of 
1135
                   Wanted {} -> do { cv2' <- newWantedCoVar (mkTyConApp tc args') xi2'
1136
                                   ; setWantedCoBind cv2 $ 
1137 1138
                                     fun_co `mkTransCoercion` 
                                            mkCoVarCoercion cv2' `mkTransCoercion` mkSymCoercion xi2_co