TcSimplify.hs 86.4 KB
Newer Older
1 2
{-# LANGUAGE CPP #-}

3
module TcSimplify(
4
       simplifyInfer,
5
       growThetaTyVars,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
6
       simplifyAmbiguityCheck,
7
       simplifyDefault,
8 9
       simplifyTop, simplifyInteractive, solveEqualities,
       simplifyWantedsTcM,
10
       tcCheckSatisfiability,
11

12 13
       -- For Rules we need these
       solveWanteds, runTcSDeriveds
14
  ) where
15

16
#include "HsVersions.h"
17

18
import Bag
19
import Class         ( Class, classKey, classTyCon )
20
import DynFlags      ( WarningFlag ( Opt_WarnMonomorphism )
21
                     , WarnReason ( Reason )
22
                     , DynFlags( solverIterations ) )
23
import Inst
24
import ListSetOps
25
import Maybes
26 27
import Name
import Outputable
28
import Pair
29 30
import PrelInfo
import PrelNames
31 32 33
import TcErrors
import TcEvidence
import TcInteract
34
import TcCanonical   ( makeSuperClasses, mkGivensWithSuperClasses )
35
import TcMType   as TcM
36
import TcRnMonad as TcM
37 38 39
import TcSMonad  as TcS
import TcType
import TrieMap       () -- DV: for now
40
import Type
41
import TysWiredIn    ( ptrRepLiftedTy )
42 43 44 45
import Unify         ( tcMatchTy )
import Util
import Var
import VarSet
46 47
import BasicTypes    ( IntWithInf, intGtLimit )
import ErrUtils      ( emptyMessages )
48
import qualified GHC.LanguageExtensions as LangExt
49

50
import Control.Monad ( when, unless )
51
import Data.List     ( partition )
52 53
import Data.Foldable    ( fold )

Austin Seipp's avatar
Austin Seipp committed
54
{-
55
*********************************************************************************
56
*                                                                               *
57 58 59
*                           External interface                                  *
*                                                                               *
*********************************************************************************
Austin Seipp's avatar
Austin Seipp committed
60
-}
61

62 63
simplifyTop :: WantedConstraints -> TcM (Bag EvBind)
-- Simplify top-level constraints
64 65 66
-- Usually these will be implications,
-- but when there is nothing to quantify we don't wrap
-- in a degenerate implication, so we do that here instead
67
simplifyTop wanteds
68
  = do { traceTc "simplifyTop {" $ text "wanted = " <+> ppr wanteds
Simon Peyton Jones's avatar
Simon Peyton Jones committed
69 70 71 72
       ; ((final_wc, unsafe_ol), binds1) <- runTcS $
            do { final_wc <- simpl_top wanteds
               ; unsafe_ol <- getSafeOverlapFailures
               ; return (final_wc, unsafe_ol) }
73 74 75
       ; traceTc "End simplifyTop }" empty

       ; traceTc "reportUnsolved {" empty
76
       ; binds2 <- reportUnsolved final_wc
77
       ; traceTc "reportUnsolved }" empty
78

79 80 81 82
       ; traceTc "reportUnsolved (unsafe overlapping) {" empty
       ; unless (isEmptyCts unsafe_ol) $ do {
           -- grab current error messages and clear, warnAllUnsolved will
           -- update error messages which we'll grab and then restore saved
83
           -- messages.
84
           ; errs_var  <- getErrsVar
85 86
           ; saved_msg <- TcM.readTcRef errs_var
           ; TcM.writeTcRef errs_var emptyMessages
87 88 89 90 91

           ; warnAllUnsolved $ WC { wc_simple = unsafe_ol
                                  , wc_insol = emptyCts
                                  , wc_impl = emptyBag }

92 93
           ; whyUnsafe <- fst <$> TcM.readTcRef errs_var
           ; TcM.writeTcRef errs_var saved_msg
94 95 96 97
           ; recordUnsafeInfer whyUnsafe
           }
       ; traceTc "reportUnsolved (unsafe overlapping) }" empty

98 99 100
       ; return (evBindMapBinds binds1 `unionBags` binds2) }

-- | Type-check a thing that emits only equality constraints, then
101
-- solve those constraints. Fails outright if there is trouble.
102 103
solveEqualities :: TcM a -> TcM a
solveEqualities thing_inside
104 105
  = checkNoErrs $  -- See Note [Fail fast on kind errors]
    do { (result, wanted) <- captureConstraints thing_inside
106
       ; traceTc "solveEqualities {" $ text "wanted = " <+> ppr wanted
Simon Peyton Jones's avatar
Simon Peyton Jones committed
107
       ; final_wc <- runTcSEqualities $ simpl_top wanted
108 109 110 111 112 113
       ; traceTc "End solveEqualities }" empty

       ; traceTc "reportAllUnsolved {" empty
       ; reportAllUnsolved final_wc
       ; traceTc "reportAllUnsolved }" empty
       ; return result }
114

Simon Peyton Jones's avatar
Simon Peyton Jones committed
115
simpl_top :: WantedConstraints -> TcS WantedConstraints
116
    -- See Note [Top-level Defaulting Plan]
117
simpl_top wanteds
118
  = do { wc_first_go <- nestTcS (solveWantedsAndDrop wanteds)
119
                            -- This is where the main work happens
Simon Peyton Jones's avatar
Simon Peyton Jones committed
120
       ; try_tyvar_defaulting wc_first_go }
121
  where
122 123
    try_tyvar_defaulting :: WantedConstraints -> TcS WantedConstraints
    try_tyvar_defaulting wc
124
      | isEmptyWC wc
125 126
      = return wc
      | otherwise
127
      = do { free_tvs <- TcS.zonkTyCoVarsAndFV (tyCoVarsOfWC wc)
128
           ; let meta_tvs = varSetElems (filterVarSet isMetaTyVar free_tvs)
129
                   -- zonkTyCoVarsAndFV: the wc_first_go is not yet zonked
130
                   -- filter isMetaTyVar: we might have runtime-skolems in GHCi,
131 132
                   -- and we definitely don't want to try to assign to those!

133 134 135
           ; defaulted <- mapM defaultTyVarTcS meta_tvs   -- Has unification side effects
           ; if or defaulted
             then do { wc_residual <- nestTcS (solveWanteds wc)
136
                            -- See Note [Must simplify after defaulting]
137 138
                     ; try_class_defaulting wc_residual }
             else try_class_defaulting wc }     -- No defaulting took place
139

140 141
    try_class_defaulting :: WantedConstraints -> TcS WantedConstraints
    try_class_defaulting wc
Austin Seipp's avatar
Austin Seipp committed
142
      | isEmptyWC wc
143 144
      = return wc
      | otherwise  -- See Note [When to do type-class defaulting]
145
      = do { something_happened <- applyDefaultingRules wc
146
                                   -- See Note [Top-level Defaulting Plan]
147
           ; if something_happened
148
             then do { wc_residual <- nestTcS (solveWantedsAndDrop wc)
149
                     ; try_class_defaulting wc_residual }
Simon Peyton Jones's avatar
Simon Peyton Jones committed
150
                  -- See Note [Overview of implicit CallStacks] in TcEvidence
151 152 153 154 155 156 157 158 159 160 161
             else try_callstack_defaulting wc }

    try_callstack_defaulting :: WantedConstraints -> TcS WantedConstraints
    try_callstack_defaulting wc
      | isEmptyWC wc
      = return wc
      | otherwise
      = defaultCallStacks wc

-- | Default any remaining @CallStack@ constraints to empty @CallStack@s.
defaultCallStacks :: WantedConstraints -> TcS WantedConstraints
Simon Peyton Jones's avatar
Simon Peyton Jones committed
162
-- See Note [Overview of implicit CallStacks] in TcEvidence
163 164 165 166 167 168 169 170 171 172 173 174 175 176
defaultCallStacks wanteds
  = do simples <- handle_simples (wc_simple wanteds)
       implics <- mapBagM handle_implic (wc_impl wanteds)
       return (wanteds { wc_simple = simples, wc_impl = implics })

  where

  handle_simples simples
    = catBagMaybes <$> mapBagM defaultCallStack simples

  handle_implic implic = do
    wanteds <- defaultCallStacks (ic_wanted implic)
    return (implic { ic_wanted = wanteds })

177 178 179 180
  defaultCallStack ct
    | Just (cls, tys) <- getClassPredTys_maybe (ctPred ct)
    , Just _ <- isCallStackDict cls tys
    = do { solveCallStack (cc_ev ct) EvCsEmpty
181 182 183 184 185
         ; return Nothing }

  defaultCallStack ct
    = return (Just ct)

186

187 188 189 190 191
{- Note [Fail fast on kind errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
solveEqualities is used to solve kind equalities when kind-checking
user-written types. If solving fails we should fail outright, rather
than just accumulate an error message, for two reasons:
Simon Peyton Jones's avatar
Simon Peyton Jones committed
192

193 194 195
  * A kind-bogus type signature may cause a cascade of knock-on
    errors if we let it pass

Simon Peyton Jones's avatar
Simon Peyton Jones committed
196 197 198 199 200
  * More seriously, we don't have a convenient term-level place to add
    deferred bindings for unsolved kind-equality constraints, so we
    don't build evidence bindings (by usine reportAllUnsolved). That
    means that we'll be left with with a type that has coercion holes
    in it, something like
201 202 203 204 205 206 207
           <type> |> co-hole
    where co-hole is not filled in.  Eeek!  That un-filled-in
    hole actually causes GHC to crash with "fvProv falls into a hole"
    See Trac #11563, #11520, #11516, #11399

So it's important to use 'checkNoErrs' here!

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
Note [When to do type-class defaulting]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In GHC 7.6 and 7.8.2, we did type-class defaulting only if insolubleWC
was false, on the grounds that defaulting can't help solve insoluble
constraints.  But if we *don't* do defaulting we may report a whole
lot of errors that would be solved by defaulting; these errors are
quite spurious because fixing the single insoluble error means that
defaulting happens again, which makes all the other errors go away.
This is jolly confusing: Trac #9033.

So it seems better to always do type-class defaulting.

However, always doing defaulting does mean that we'll do it in
situations like this (Trac #5934):
   run :: (forall s. GenST s) -> Int
Austin Seipp's avatar
Austin Seipp committed
223
   run = fromInteger 0
224 225 226
We don't unify the return type of fromInteger with the given function
type, because the latter involves foralls.  So we're left with
    (Num alpha, alpha ~ (forall s. GenST s) -> Int)
Austin Seipp's avatar
Austin Seipp committed
227 228
Now we do defaulting, get alpha := Integer, and report that we can't
match Integer with (forall s. GenST s) -> Int.  That's not totally
229 230 231 232 233 234
stupid, but perhaps a little strange.

Another potential alternative would be to suppress *all* non-insoluble
errors if there are *any* insoluble errors, anywhere, but that seems
too drastic.

235 236 237 238 239 240 241 242 243
Note [Must simplify after defaulting]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We may have a deeply buried constraint
    (t:*) ~ (a:Open)
which we couldn't solve because of the kind incompatibility, and 'a' is free.
Then when we default 'a' we can solve the constraint.  And we want to do
that before starting in on type classes.  We MUST do it before reporting
errors, because it isn't an error!  Trac #7967 was due to this.

244 245
Note [Top-level Defaulting Plan]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
246 247
We have considered two design choices for where/when to apply defaulting.
   (i) Do it in SimplCheck mode only /whenever/ you try to solve some
248
       simple constraints, maybe deep inside the context of implications.
249
       This used to be the case in GHC 7.4.1.
250
   (ii) Do it in a tight loop at simplifyTop, once all other constraints have
251 252
        finished. This is the current story.

253
Option (i) had many disadvantages:
254 255
   a) Firstly, it was deep inside the actual solver.
   b) Secondly, it was dependent on the context (Infer a type signature,
256 257
      or Check a type signature, or Interactive) since we did not want
      to always start defaulting when inferring (though there is an exception to
258
      this, see Note [Default while Inferring]).
259 260 261 262 263 264 265 266 267 268 269
   c) It plainly did not work. Consider typecheck/should_compile/DfltProb2.hs:
          f :: Int -> Bool
          f x = const True (\y -> let w :: a -> a
                                      w a = const a (y+1)
                                  in w y)
      We will get an implication constraint (for beta the type of y):
               [untch=beta] forall a. 0 => Num beta
      which we really cannot default /while solving/ the implication, since beta is
      untouchable.

Instead our new defaulting story is to pull defaulting out of the solver loop and
270
go with option (ii), implemented at SimplifyTop. Namely:
271 272
     - First, have a go at solving the residual constraint of the whole
       program
273 274
     - Try to approximate it with a simple constraint
     - Figure out derived defaulting equations for that simple constraint
275 276 277 278
     - Go round the loop again if you did manage to get some equations

Now, that has to do with class defaulting. However there exists type variable /kind/
defaulting. Again this is done at the top-level and the plan is:
279
     - At the top-level, once you had a go at solving the constraint, do
Gabor Greif's avatar
Gabor Greif committed
280
       figure out /all/ the touchable unification variables of the wanted constraints.
281 282 283
     - Apply defaulting to their kinds

More details in Note [DefaultTyVar].
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

Note [Safe Haskell Overlapping Instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In Safe Haskell, we apply an extra restriction to overlapping instances. The
motive is to prevent untrusted code provided by a third-party, changing the
behavior of trusted code through type-classes. This is due to the global and
implicit nature of type-classes that can hide the source of the dictionary.

Another way to state this is: if a module M compiles without importing another
module N, changing M to import N shouldn't change the behavior of M.

Overlapping instances with type-classes can violate this principle. However,
overlapping instances aren't always unsafe. They are just unsafe when the most
selected dictionary comes from untrusted code (code compiled with -XSafe) and
overlaps instances provided by other modules.

In particular, in Safe Haskell at a call site with overlapping instances, we
apply the following rule to determine if it is a 'unsafe' overlap:

 1) Most specific instance, I1, defined in an `-XSafe` compiled module.
 2) I1 is an orphan instance or a MPTC.
 3) At least one overlapped instance, Ix, is both:
    A) from a different module than I1
    B) Ix is not marked `OVERLAPPABLE`

This is a slightly involved heuristic, but captures the situation of an
imported module N changing the behavior of existing code. For example, if
condition (2) isn't violated, then the module author M must depend either on a
type-class or type defined in N.

Secondly, when should these heuristics be enforced? We enforced them when the
type-class method call site is in a module marked `-XSafe` or `-XTrustworthy`.
This allows `-XUnsafe` modules to operate without restriction, and for Safe
Haskell inferrence to infer modules with unsafe overlaps as unsafe.

One alternative design would be to also consider if an instance was imported as
a `safe` import or not and only apply the restriction to instances imported
safely. However, since instances are global and can be imported through more
than one path, this alternative doesn't work.

Note [Safe Haskell Overlapping Instances Implementation]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

327
How is this implemented? It's complicated! So we'll step through it all:
328 329

 1) `InstEnv.lookupInstEnv` -- Performs instance resolution, so this is where
Simon Peyton Jones's avatar
Simon Peyton Jones committed
330 331 332 333
    we check if a particular type-class method call is safe or unsafe. We do this
    through the return type, `ClsInstLookupResult`, where the last parameter is a
    list of instances that are unsafe to overlap. When the method call is safe,
    the list is null.
334

335
 2) `TcInteract.matchClassInst` -- This module drives the instance resolution
Simon Peyton Jones's avatar
Simon Peyton Jones committed
336 337 338
    / dictionary generation. The return type is `LookupInstResult`, which either
    says no instance matched, or one found, and if it was a safe or unsafe
    overlap.
339 340

 3) `TcInteract.doTopReactDict` -- Takes a dictionary / class constraint and
Simon Peyton Jones's avatar
Simon Peyton Jones committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 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
     tries to resolve it by calling (in part) `matchClassInst`. The resolving
     mechanism has a work list (of constraints) that it process one at a time. If
     the constraint can't be resolved, it's added to an inert set. When compiling
     an `-XSafe` or `-XTrustworthy` module, we follow this approach as we know
     compilation should fail. These are handled as normal constraint resolution
     failures from here-on (see step 6).

     Otherwise, we may be inferring safety (or using `-Wunsafe`), and
     compilation should succeed, but print warnings and/or mark the compiled module
     as `-XUnsafe`. In this case, we call `insertSafeOverlapFailureTcS` which adds
     the unsafe (but resolved!) constraint to the `inert_safehask` field of
     `InertCans`.

 4) `TcSimplify.simplifyTop`:
       * Call simpl_top, the top-level function for driving the simplifier for
         constraint resolution.

       * Once finished, call `getSafeOverlapFailures` to retrieve the
         list of overlapping instances that were successfully resolved,
         but unsafe. Remember, this is only applicable for generating warnings
         (`-Wunsafe`) or inferring a module unsafe. `-XSafe` and `-XTrustworthy`
         cause compilation failure by not resolving the unsafe constraint at all.

       * For unresolved constraints (all types), call `TcErrors.reportUnsolved`,
         while for resolved but unsafe overlapping dictionary constraints, call
         `TcErrors.warnAllUnsolved`. Both functions convert constraints into a
         warning message for the user.

       * In the case of `warnAllUnsolved` for resolved, but unsafe
         dictionary constraints, we collect the generated warning
         message (pop it) and call `TcRnMonad.recordUnsafeInfer` to
         mark the module we are compiling as unsafe, passing the
         warning message along as the reason.

 5) `TcErrors.*Unsolved` -- Generates error messages for constraints by
    actually calling `InstEnv.lookupInstEnv` again! Yes, confusing, but all we
    know is the constraint that is unresolved or unsafe. For dictionary, all we
    know is that we need a dictionary of type C, but not what instances are
    available and how they overlap. So we once again call `lookupInstEnv` to
    figure that out so we can generate a helpful error message.

 6) `TcRnMonad.recordUnsafeInfer` -- Save the unsafe result and reason in an
      IORef called `tcg_safeInfer`.

 7) `HscMain.tcRnModule'` -- Reads `tcg_safeInfer` after type-checking, calling
    `HscMain.markUnsafeInfer` (passing the reason along) when safe-inferrence
    failed.
Austin Seipp's avatar
Austin Seipp committed
388
-}
389

390
------------------
391 392 393
simplifyAmbiguityCheck :: Type -> WantedConstraints -> TcM ()
simplifyAmbiguityCheck ty wanteds
  = do { traceTc "simplifyAmbiguityCheck {" (text "type = " <+> ppr ty $$ text "wanted = " <+> ppr wanteds)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
394
       ; (final_wc, _) <- runTcS $ simpl_top wanteds
395 396 397 398 399
       ; traceTc "End simplifyAmbiguityCheck }" empty

       -- Normally report all errors; but with -XAllowAmbiguousTypes
       -- report only insoluble ones, since they represent genuinely
       -- inaccessible code
400
       ; allow_ambiguous <- xoptM LangExt.AllowAmbiguousTypes
401
       ; traceTc "reportUnsolved(ambig) {" empty
402
       ; tc_lvl <- TcM.getTcLevel
403
       ; unless (allow_ambiguous && not (insolubleWC tc_lvl final_wc))
404
                (discardResult (reportUnsolved final_wc))
405 406 407 408
       ; traceTc "reportUnsolved(ambig) }" empty

       ; return () }

409 410
------------------
simplifyInteractive :: WantedConstraints -> TcM (Bag EvBind)
411
simplifyInteractive wanteds
412
  = traceTc "simplifyInteractive" empty >>
413
    simplifyTop wanteds
414 415

------------------
416
simplifyDefault :: ThetaType    -- Wanted; has no type variables in it
417
                -> TcM ()       -- Succeeds if the constraint is soluble
418
simplifyDefault theta
419
  = do { traceTc "simplifyInteractive" empty
420 421 422 423 424
       ; loc <- getCtLocM DefaultOrigin Nothing
       ; let wanted = [ CtDerived { ctev_pred = pred
                                  , ctev_loc  = loc }
                      | pred <- theta ]
       ; unsolved <- runTcSDeriveds (solveWanteds (mkSimpleWC wanted))
425
       ; traceTc "reportUnsolved {" empty
426
       ; reportAllUnsolved unsolved
427
       ; traceTc "reportUnsolved }" empty
428
       ; return () }
429

430 431 432
------------------
tcCheckSatisfiability :: Bag EvVar -> TcM Bool
-- Return True if satisfiable, False if definitely contradictory
433
tcCheckSatisfiability given_ids
434
  = do { lcl_env <- TcM.getLclEnv
435 436
       ; let given_loc = mkGivenLoc topTcLevel UnkSkol lcl_env
       ; (res, _ev_binds) <- runTcS $
437 438
             do { traceTcS "checkSatisfiability {" (ppr given_ids)
                ; given_cts <- mkGivensWithSuperClasses given_loc (bagToList given_ids)
439
                     -- See Note [Superclases and satisfiability]
440 441 442 443 444
                ; insols <- solveSimpleGivens given_cts
                ; insols <- try_harder insols
                ; traceTcS "checkSatisfiability }" (ppr insols)
                ; return (isEmptyBag insols) }
       ; return res }
445
 where
446 447 448
    try_harder :: Cts -> TcS Cts
    -- Maybe we have to search up the superclass chain to find
    -- an unsatisfiable constraint.  Example: pmcheck/T3927b.
449
    -- At the moment we try just once
450 451 452 453 454 455
    try_harder insols
      | not (isEmptyBag insols)   -- We've found that it's definitely unsatisfiable
      = return insols             -- Hurrah -- stop now.
      | otherwise
      = do { pending_given <- getPendingScDicts
           ; new_given <- makeSuperClasses pending_given
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
           ; solveSimpleGivens new_given }

{- Note [Superclases and satisfiability]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand superclasses before starting, because (Int ~ Bool), has
(Int ~~ Bool) as a superclass, which in turn has (Int ~N# Bool)
as a superclass, and it's the latter that is insoluble.  See
Note [The equality types story] in TysPrim.

If we fail to prove unsatisfiability we (arbitrarily) try just once to
find superclasses, using try_harder.  Reason: we might have a type
signature
   f :: F op (Implements push) => ..
where F is a type function.  This happened in Trac #3972.

We could do more than once but we'd have to have /some/ limit: in the
the recurisve case, we would go on forever in the common case where
the constraints /are/ satisfiable (Trac #10592 comment:12!).

For stratightforard situations without type functions the try_harder
step does nothing.

478

479
***********************************************************************************
480
*                                                                                 *
481 482 483
*                            Inference
*                                                                                 *
***********************************************************************************
484

485 486 487 488 489 490 491 492
Note [Inferring the type of a let-bound variable]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   f x = rhs

To infer f's type we do the following:
 * Gather the constraints for the RHS with ambient level *one more than*
   the current one.  This is done by the call
493
        pushLevelAndCaptureConstraints (tcMonoBinds...)
494 495 496 497
   in TcBinds.tcPolyInfer

 * Call simplifyInfer to simplify the constraints and decide what to
   quantify over. We pass in the level used for the RHS constraints,
498
   here called rhs_tclvl.
499 500 501 502

This ensures that the implication constraint we generate, if any,
has a strictly-increased level compared to the ambient level outside
the let binding.
503

Austin Seipp's avatar
Austin Seipp committed
504
-}
505

506
simplifyInfer :: TcLevel               -- Used when generating the constraints
507
              -> Bool                  -- Apply monomorphism restriction
508
              -> [TcIdSigInfo]         -- Any signatures (possibly partial)
509 510
              -> [(Name, TcTauType)]   -- Variables to be generalised,
                                       -- and their tau-types
511
              -> WantedConstraints
512
              -> TcM ([TcTyVar],    -- Quantify over these type variables
513
                      [EvVar],      -- ... and these constraints (fully zonked)
514
                      TcEvBinds)    -- ... binding these evidence variables
515
simplifyInfer rhs_tclvl apply_mr sigs name_taus wanteds
516
  | isEmptyWC wanteds
517 518 519
  = do { gbl_tvs <- tcGetGlobalTyCoVars
       ; qtkvs <- quantify_tvs sigs gbl_tvs $
                  splitDepVarsOfTypes (map snd name_taus)
520
       ; traceTc "simplifyInfer: empty WC" (ppr name_taus $$ ppr qtkvs)
521
       ; return (qtkvs, [], emptyTcEvBinds) }
522

523
  | otherwise
524
  = do { traceTc "simplifyInfer {"  $ vcat
525 526 527 528 529
             [ text "sigs =" <+> ppr sigs
             , text "binds =" <+> ppr name_taus
             , text "rhs_tclvl =" <+> ppr rhs_tclvl
             , text "apply_mr =" <+> ppr apply_mr
             , text "(unzonked) wanted =" <+> ppr wanteds
530 531
             ]

532 533 534 535 536 537 538
       -- First do full-blown solving
       -- NB: we must gather up all the bindings from doing
       -- this solving; hence (runTcSWithEvBinds ev_binds_var).
       -- And note that since there are nested implications,
       -- calling solveWanteds will side-effect their evidence
       -- bindings, so we can't just revert to the input
       -- constraint.
539

540
       ; ev_binds_var <- TcM.newTcEvBinds
541
       ; wanted_transformed_incl_derivs <- setTcLevel rhs_tclvl $
542
           do { sig_derived <- concatMapM mkSigDerivedWanteds sigs
543 544
                  -- the False says we don't really need to solve all Deriveds
              ; runTcSWithEvBinds False (Just ev_binds_var) $
545
                solveWanteds (wanteds `addSimples` listToBag sig_derived) }
546
       ; wanted_transformed_incl_derivs <- TcM.zonkWC wanted_transformed_incl_derivs
547

548 549 550 551
       -- Find quant_pred_candidates, the predicates that
       -- we'll consider quantifying over
       -- NB: We do not do any defaulting when inferring a type, this can lead
       -- to less polymorphic types, see Note [Default while Inferring]
552

553
       ; tc_lcl_env <- TcM.getLclEnv
554
       ; let wanted_transformed = dropDerivedWC wanted_transformed_incl_derivs
555
       ; quant_pred_candidates   -- Fully zonked
556
           <- if insolubleWC rhs_tclvl wanted_transformed_incl_derivs
557
              then return []   -- See Note [Quantification with errors]
558
                               -- NB: must include derived errors in this test,
559 560 561
                               --     hence "incl_derivs"

              else do { let quant_cand = approximateWC wanted_transformed
562 563 564
                            meta_tvs   = filter isMetaTyVar (varSetElems (tyCoVarsOfCts quant_cand))

                      ; gbl_tvs <- tcGetGlobalTyCoVars
565 566
                            -- Miminise quant_cand.  We are not interested in any evidence
                            -- produced, because we are going to simplify wanted_transformed
567
                            -- again later. All we want here are the predicates over which to
568
                            -- quantify.
569
                            --
570 571
                            -- If any meta-tyvar unifications take place (unlikely),
                            -- we'll pick that up later.
572

573 574 575 576 577 578 579
                      -- See Note [Promote _and_ default when inferring]
                      ; let def_tyvar tv
                              = when (not $ tv `elemVarSet` gbl_tvs) $
                                defaultTyVar tv
                      ; mapM_ def_tyvar meta_tvs
                      ; mapM_ (promoteTyVar rhs_tclvl) meta_tvs

580
                      ; WC { wc_simple = simples }
581 582
                           <- setTcLevel rhs_tclvl $
                              runTcSDeriveds       $
583 584 585 586
                              solveSimpleWanteds   $
                              mapBag toDerivedCt quant_cand
                                -- NB: we don't want evidence,
                                -- so use Derived constraints
587 588

                      ; simples <- TcM.zonkSimples simples
589

590
                      ; return [ ctEvPred ev | ct <- bagToList simples
591
                                             , let ev = ctEvidence ct ] }
592

593
       -- NB: quant_pred_candidates is already fully zonked
594

595
       -- Decide what type variables and constraints to quantify
596
       ; zonked_taus <- mapM (TcM.zonkTcType . snd) name_taus
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
       ; let zonked_tau_tkvs = splitDepVarsOfTypes zonked_taus
       ; (qtvs, bound_theta)
           <- decideQuantification apply_mr sigs name_taus
                                   quant_pred_candidates zonked_tau_tkvs

         -- Promote any type variables that are free in the inferred type
         -- of the function:
         --    f :: forall qtvs. bound_theta => zonked_tau
         -- These variables now become free in the envt, and hence will show
         -- up whenever 'f' is called.  They may currently at rhs_tclvl, but
         -- they had better be unifiable at the outer_tclvl!
         -- Example:   envt mentions alpha[1]
         --            tau_ty = beta[2] -> beta[2]
         --            consraints = alpha ~ [beta]
         -- we don't quantify over beta (since it is fixed by envt)
         -- so we must promote it!  The inferred type is just
         --   f :: beta -> beta
       ; outer_tclvl    <- TcM.getTcLevel
       ; zonked_tau_tvs <- fold <$>
                           traverse TcM.zonkTyCoVarsAndFV zonked_tau_tkvs
              -- decideQuantification turned some meta tyvars into
              -- quantified skolems, so we have to zonk again

       ; let phi_tvs     = tyCoVarsOfTypes bound_theta
                           `unionVarSet` zonked_tau_tvs

             promote_tvs = closeOverKinds phi_tvs `delVarSetList` qtvs
       ; MASSERT2( closeOverKinds promote_tvs `subVarSet` promote_tvs
                 , ppr phi_tvs $$
                   ppr (closeOverKinds phi_tvs) $$
                   ppr promote_tvs $$
                   ppr (closeOverKinds promote_tvs) )
           -- we really don't want a type to be promoted when its kind isn't!

           -- promoteTyVar ignores coercion variables
       ; mapM_ (promoteTyVar outer_tclvl) (varSetElems promote_tvs)

           -- Emit an implication constraint for the
           -- remaining constraints from the RHS
       ; bound_theta_vars <- mapM TcM.newEvVar bound_theta
       ; let skol_info   = InferSkol [ (name, mkSigmaTy [] bound_theta ty)
                                     | (name, ty) <- name_taus ]
639
                        -- Don't add the quantified variables here, because
640 641
                        -- they are also bound in ic_skols and we want them
                        -- to be tidied uniformly
642

643
             implic = Implic { ic_tclvl    = rhs_tclvl
644
                             , ic_skols    = qtvs
645
                             , ic_no_eqs   = False
646
                             , ic_given    = bound_theta_vars
647
                             , ic_wanted   = wanted_transformed
648
                             , ic_status   = IC_Unsolved
649
                             , ic_binds    = Just ev_binds_var
650
                             , ic_info     = skol_info
651
                             , ic_env      = tc_lcl_env }
652
       ; emitImplication implic
653

654
         -- All done!
655
       ; traceTc "} simplifyInfer/produced residual implication for quantification" $
656 657 658 659 660 661 662
         vcat [ text "quant_pred_candidates =" <+> ppr quant_pred_candidates
              , text "zonked_taus" <+> ppr zonked_taus
              , text "zonked_tau_tvs=" <+> ppr zonked_tau_tvs
              , text "promote_tvs=" <+> ppr promote_tvs
              , text "bound_theta =" <+> ppr bound_theta
              , text "qtvs =" <+> ppr qtvs
              , text "implic =" <+> ppr implic ]
663

664
       ; return ( qtvs, bound_theta_vars, TcEvBinds ev_binds_var ) }
665

666 667 668 669 670
mkSigDerivedWanteds :: TcIdSigInfo -> TcM [Ct]
-- See Note [Add deriveds for signature contexts]
mkSigDerivedWanteds (TISI { sig_bndr = PartialSig { sig_name = name }
                          , sig_theta = theta, sig_tau = tau })
 = do { let skol_info = InferSkol [(name, mkSigmaTy [] theta tau)]
671
      ; loc <- getCtLocM (GivenOrigin skol_info) (Just TypeLevel)
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
      ; return [ mkNonCanonical (CtDerived { ctev_pred = pred
                                           , ctev_loc = loc })
               | pred <- theta ] }
mkSigDerivedWanteds _ = return []

{- Note [Add deriveds for signature contexts]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider this (Trac #11016):
  f2 :: (?x :: Int) => _
  f2 = ?x
We'll use plan InferGen because there are holes in the type.  But we want
to have the (?x :: Int) constraint floating around so that the functional
dependencies kick in.  Otherwise the occurrence of ?x on the RHS produces
constraint (?x :: alpha), and we wont unify alpha:=Int.

Solution: in simplifyInfer, just before simplifying the constraints
gathered from the RHS, add Derived constraints for the context of any
type signatures.  This is rare; if there is a type signature we'll usually
be doing CheckGen.  But it happens for signatures with holes.

Austin Seipp's avatar
Austin Seipp committed
692 693
************************************************************************
*                                                                      *
694
                Quantification
Austin Seipp's avatar
Austin Seipp committed
695 696
*                                                                      *
************************************************************************
697 698 699 700 701 702 703

Note [Deciding quantification]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If the monomorphism restriction does not apply, then we quantify as follows:
  * Take the global tyvars, and "grow" them using the equality constraints
    E.g.  if x:alpha is in the environment, and alpha ~ [beta] (which can
          happen because alpha is untouchable here) then do not quantify over
704 705
          beta, because alpha fixes beta, and beta is effectively free in
          the environment too
706 707 708
    These are the mono_tvs

  * Take the free vars of the tau-type (zonked_tau_tvs) and "grow" them
709
    using all the constraints.  These are tau_tvs_plus
710

711 712 713 714
  * Use quantifyTyVars to quantify over (tau_tvs_plus - mono_tvs), being
    careful to close over kinds, and to skolemise the quantified tyvars.
    (This actually unifies each quantifies meta-tyvar with a fresh skolem.)
    Result is qtvs.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
715

716
  * Filter the constraints using pickQuantifiablePreds and the qtvs.
717 718
    We have to zonk the constraints first, so they "see" the freshly
    created skolems.
719

720 721 722
If the MR does apply, mono_tvs includes all the constrained tyvars --
including all covars -- and the quantified constraints are empty/insoluble.

Austin Seipp's avatar
Austin Seipp committed
723
-}
724

725
decideQuantification
726 727 728 729 730 731 732
  :: Bool                  -- try the MR restriction?
  -> [TcIdSigInfo]
  -> [(Name, TcTauType)]   -- variables to be generalised (for errors only)
  -> [PredType]            -- candidate theta
  -> Pair TcTyCoVarSet     -- dependent (kind) variables & type variables
  -> TcM ( [TcTyVar]       -- Quantify over these (skolems)
         , [PredType] )    -- and this context (fully zonked)
733
-- See Note [Deciding quantification]
734 735
decideQuantification apply_mr sigs name_taus constraints
                     zonked_pair@(Pair zonked_tau_kvs zonked_tau_tvs)
736
  | apply_mr     -- Apply the Monomorphism restriction
737 738 739
  = do { gbl_tvs <- tcGetGlobalTyCoVars
       ; let constrained_tvs = tyCoVarsOfTypes constraints `unionVarSet`
                               filterVarSet isCoVar zonked_tkvs
740
             mono_tvs = gbl_tvs `unionVarSet` constrained_tvs
741
       ; qtvs <- quantify_tvs sigs mono_tvs zonked_pair
742

743
           -- Warn about the monomorphism restriction
744
       ; warn_mono <- woptM Opt_WarnMonomorphism
745
       ; let mr_bites = constrained_tvs `intersectsVarSet` zonked_tkvs
746
       ; warnTc (Reason Opt_WarnMonomorphism) (warn_mono && mr_bites) $
747
         hang (text "The Monomorphism Restriction applies to the binding"
748
               <> plural bndrs <+> text "for" <+> pp_bndrs)
749 750
             2 (text "Consider giving a type signature for"
                <+> if isSingleton bndrs then pp_bndrs
751
                                         else text "these binders")
752

753 754 755
       -- All done
       ; traceTc "decideQuantification 1" (vcat [ppr constraints, ppr gbl_tvs, ppr mono_tvs
                                                , ppr qtvs, ppr mr_bites])
756
       ; return (qtvs, []) }
757 758

  | otherwise
759
  = do { gbl_tvs <- tcGetGlobalTyCoVars
760
       ; let mono_tvs     = growThetaTyVars equality_constraints gbl_tvs
761
             tau_tvs_plus = growThetaTyVars constraints zonked_tau_tvs
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
       ; qtvs <- quantify_tvs sigs mono_tvs (Pair zonked_tau_kvs tau_tvs_plus)
          -- We don't grow the kvs, as there's no real need to. Recall
          -- that quantifyTyVars uses the separation between kvs and tvs
          -- only for defaulting, and we don't want (ever) to default a tv
          -- to *. So, don't grow the kvs.

       ; constraints <- TcM.zonkTcTypes constraints
                 -- quantiyTyVars turned some meta tyvars into
                 -- quantified skolems, so we have to zonk again

       ; let theta     = pickQuantifiablePreds (mkVarSet qtvs) constraints
             min_theta = mkMinimalBySCs theta
               -- See Note [Minimize by Superclasses]

       ; traceTc "decideQuantification 2"
           (vcat [ text "constraints:"  <+> ppr constraints
                 , text "gbl_tvs:"      <+> ppr gbl_tvs
                 , text "mono_tvs:"     <+> ppr mono_tvs
                 , text "zonked_kvs:"   <+> ppr zonked_tau_kvs
                 , text "tau_tvs_plus:" <+> ppr tau_tvs_plus
                 , text "qtvs:"         <+> ppr qtvs
                 , text "min_theta:"    <+> ppr min_theta ])
784
       ; return (qtvs, min_theta) }
785
  where
786
    zonked_tkvs = zonked_tau_kvs `unionVarSet` zonked_tau_tvs
787 788
    bndrs    = map fst name_taus
    pp_bndrs = pprWithCommas (quotes . ppr) bndrs
789 790
    equality_constraints = filter isEqPred constraints

791 792 793 794 795 796 797 798 799 800
quantify_tvs :: [TcIdSigInfo]
             -> TcTyVarSet   -- the monomorphic tvs
             -> Pair TcTyVarSet   -- kvs, tvs to quantify
             -> TcM [TcTyVar]
-- See Note [Which type variables to quantify]
quantify_tvs sigs mono_tvs (Pair tau_kvs tau_tvs)
  = quantifyTyVars (mono_tvs `delVarSetList` sig_qtvs)
                   (Pair tau_kvs
                         (tau_tvs `extendVarSetList` sig_qtvs
                                  `extendVarSetList` sig_wcs))
801 802 803 804 805
                   -- NB: quantifyTyVars zonks its arguments
  where
    sig_qtvs = [ skol | sig <- sigs, (_, skol) <- sig_skols sig ]
    sig_wcs  = [ wc   | TISI { sig_bndr = PartialSig { sig_wcs = wcs } } <- sigs
                      , (_, wc) <- wcs ]
806

807 808

------------------
809
growThetaTyVars :: ThetaType -> TyCoVarSet -> TyVarSet
810
-- See Note [Growing the tau-tvs using constraints]
811
-- NB: only returns tyvars, never covars
812
growThetaTyVars theta tvs
813 814 815
  | null theta = tvs_only
  | otherwise  = filterVarSet isTyVar $
                 transCloVarSet mk_next seed_tvs
816
  where
817 818
    tvs_only = filterVarSet isTyVar tvs
    seed_tvs = tvs `unionVarSet` tyCoVarsOfTypes ips
819
    (ips, non_ips) = partition isIPPred theta
820
                         -- See Note [Inheriting implicit parameters] in TcType
821 822 823 824 825 826

    mk_next :: VarSet -> VarSet -- Maps current set to newly-grown ones
    mk_next so_far = foldr (grow_one so_far) emptyVarSet non_ips
    grow_one so_far pred tvs
       | pred_tvs `intersectsVarSet` so_far = tvs `unionVarSet` pred_tvs
       | otherwise                          = tvs
827
       where
828
         pred_tvs = tyCoVarsOfType pred
829

830 831 832 833 834 835
{- Note [Which type variables to quantify]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When choosing type variables to quantify, the basic plan is to
quantify over all type variables that are
 * free in the tau_tvs, and
 * not forced to be monomorphic (mono_tvs),
836
   for example by being free in the environment.
837

838
However, for a pattern binding, or with wildcards, we might
839
be doing inference *in the presence of a type signature*.
840 841
Mostly, if there is a signature we use CheckGen, not InferGen,
but with pattern bindings or wildcards we might do InferGen
842 843 844
and still have a type signature.  For example:
   f :: _ -> a
   f x = ...
845 846
or
   g :: (Eq _a) => _b -> _b
847 848 849
or
   p :: a -> a
   (p,q) = e
850
In all these cases we use plan InferGen, and hence call simplifyInfer.
851 852 853 854 855
But those 'a' variables are skolems, and we should be sure to quantify
over them, regardless of the monomorphism restriction etc.  If we
don't, when reporting a type error we panic when we find that a
skolem isn't bound by any enclosing implication.

856 857 858 859 860 861 862 863 864 865
Moreover we must quantify over all wildcards that are not free in
the environment.  In the case of 'g' for example, silly though it is,
we want to get the inferred type
   g :: forall t. Eq t => Int -> Int
and then report ambiguity, rather than *not* quantifying over 't'
and getting some much more mysterious error later.  A similar case
is
  h :: F _a -> Int

That's why we pass sigs to simplifyInfer, and make sure (in
866 867 868
quantify_tvs) that we do quantify over them.  Trac #10615 is
a case in point.

869 870 871 872 873 874 875 876
Note [Quantifying over equality constraints]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Should we quantify over an equality constraint (s ~ t)?  In general, we don't.
Doing so may simply postpone a type error from the function definition site to
its call site.  (At worst, imagine (Int ~ Bool)).

However, consider this
         forall a. (F [a] ~ Int) => blah
877
Should we quantify over the (F [a] ~ Int)?  Perhaps yes, because at the call
878 879 880 881
site we will know 'a', and perhaps we have instance  F [Bool] = Int.
So we *do* quantify over a type-family equality where the arguments mention
the quantified variables.

882 883 884
Note [Growing the tau-tvs using constraints]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
(growThetaTyVars insts tvs) is the result of extending the set
885
    of tyvars, tvs, using all conceivable links from pred
886 887 888 889 890 891 892 893

E.g. tvs = {a}, preds = {H [a] b, K (b,Int) c, Eq e}
Then growThetaTyVars preds tvs = {a,b,c}

Notice that
   growThetaTyVars is conservative       if v might be fixed by vs
                                         => v `elem` grow(vs,C)

894 895 896 897 898 899 900 901
Note [Quantification with errors]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If we find that the RHS of the definition has some absolutely-insoluble
constraints, we abandon all attempts to find a context to quantify
over, and instead make the function fully-polymorphic in whatever
type we have found.  For two reasons
  a) Minimise downstream errors
  b) Avoid spurious errors from this function
902

903
But NB that we must include *derived* errors in the check. Example:
904 905 906
    (a::*) ~ Int#
We get an insoluble derived error *~#, and we don't want to discard
it before doing the isInsolubleWC test!  (Trac #8262)
907

908 909
Note [Default while Inferring]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
910
Our current plan is that defaulting only happens at simplifyTop and
911
not simplifyInfer.  This may lead to some insoluble deferred constraints.
912 913
Example:

914
instance D g => C g Int b
915 916

constraint inferred = (forall b. 0 => C gamma alpha b) /\ Num alpha
917
type inferred       = gamma -> gamma
918

919 920 921
Now, if we try to default (alpha := Int) we will be able to refine the implication to
  (forall b. 0 => C gamma Int b)
which can then be simplified further to
922
  (forall b. 0 => D gamma)
923
Finally, we /can/ approximate this implication with (D gamma) and infer the quantified
924 925
type:  forall g. D g => g -> g

926
Instead what will currently happen is that we will get a quantified type
927 928 929
(forall g. g -> g) and an implication:
       forall g. 0 => (forall b. 0 => C g alpha b) /\ Num alpha

930
Which, even if the simplifyTop defaults (alpha := Int) we will still be left with an
931 932 933
unsolvable implication:
       forall g. 0 => (forall b. 0 => D g)

934
The concrete example would be:
935 936 937
       h :: C g a s => g -> a -> ST s a
       f (x::gamma) = (\_ -> x) (runST (h x (undefined::alpha)) + 1)

938 939
But it is quite tedious to do defaulting and resolve the implication constraints, and
we have not observed code breaking because of the lack of defaulting in inference, so
940 941 942 943
we don't do it for now.



944
Note [Minimize by Superclasses]
945
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
946 947 948 949 950 951 952
When we quantify over a constraint, in simplifyInfer we need to
quantify over a constraint that is minimal in some sense: For
instance, if the final wanted constraint is (Eq alpha, Ord alpha),
we'd like to quantify over Ord alpha, because we can just get Eq alpha
from superclass selection from Ord alpha. This minimization is what
mkMinimalBySCs does. Then, simplifyInfer uses the minimal constraint
to check the original wanted.
953

954

955
Note [Avoid unnecessary constraint simplification]
956
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
957
    -------- NB NB NB (Jun 12) -------------
958 959 960
    This note not longer applies; see the notes with Trac #4361.
    But I'm leaving it in here so we remember the issue.)
    ----------------------------------------
961
When inferring the type of a let-binding, with simplifyInfer,
962
try to avoid unnecessarily simplifying class constraints.
963
Doing so aids sharing, but it also helps with delicate
964
situations like
965

simonpj@microsoft.com's avatar