DsBinds.hs 48.7 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3 4
{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998

Simon Marlow's avatar
Simon Marlow committed
5 6

Pattern-matching bindings (HsBinds and MonoBinds)
7

8 9 10
Handles @HsBinds@; those at the top level require different handling,
in that the @Rec@/@NonRec@/etc structure is thrown away (whereas at
lower levels it is preserved with @let@/@letrec@s).
Austin Seipp's avatar
Austin Seipp committed
11
-}
12

13
{-# LANGUAGE CPP #-}
Ian Lynagh's avatar
Ian Lynagh committed
14

15
module DsBinds ( dsTopLHsBinds, dsLHsBinds, decomposeRuleLhs, dsSpec,
16
                 dsHsWrapper, dsTcEvBinds, dsTcEvBinds_s, dsEvBinds, dsMkUserRule
17
  ) where
18

19 20
#include "HsVersions.h"

21 22
import {-# SOURCE #-}   DsExpr( dsLExpr )
import {-# SOURCE #-}   Match( matchWrapper )
23

24
import DsMonad
Simon Marlow's avatar
Simon Marlow committed
25
import DsGRHSs
26
import DsUtils
27

28 29
import HsSyn            -- lots of things
import CoreSyn          -- lots of things
30
import Literal          ( Literal(MachStr) )
31
import CoreSubst
32
import OccurAnal        ( occurAnalyseExpr )
33
import MkCore
Simon Marlow's avatar
Simon Marlow committed
34
import CoreUtils
35
import CoreArity ( etaExpand )
36
import CoreUnfold
37
import CoreFVs
38
import UniqSupply
39
import Digraph
40

41
import PrelNames
42
import TysPrim ( mkProxyPrimTy )
43
import TyCon
44
import TcEvidence
45
import TcType
46
import Type
47
import Kind( isKind )
batterseapower's avatar
batterseapower committed
48
import Coercion hiding (substCo)
49
import TysWiredIn ( eqBoxDataCon, coercibleDataCon, mkListTy
50 51
                  , mkBoxedTupleTy, charTy
                  , typeNatKind, typeSymbolKind )
Simon Marlow's avatar
Simon Marlow committed
52
import Id
53
import MkId(proxyHashId)
54
import Class
55
import DataCon  ( dataConTyCon )
56
import Name
57
import IdInfo   ( IdDetails(..) )
58
import Var
59
import VarSet
Simon Marlow's avatar
Simon Marlow committed
60
import Rules
61
import VarEnv
62
import Outputable
63
import Module
Simon Marlow's avatar
Simon Marlow committed
64 65
import SrcLoc
import Maybes
66
import OrdList
Simon Marlow's avatar
Simon Marlow committed
67 68
import Bag
import BasicTypes hiding ( TopLevel )
Ian Lynagh's avatar
Ian Lynagh committed
69
import DynFlags
Simon Marlow's avatar
Simon Marlow committed
70
import FastString
71
import Util
72
import MonadUtils
73
import Control.Monad(liftM,when)
74

75
{-**********************************************************************
Austin Seipp's avatar
Austin Seipp committed
76
*                                                                      *
77
           Desugaring a MonoBinds
Austin Seipp's avatar
Austin Seipp committed
78
*                                                                      *
79
**********************************************************************-}
80

81 82
dsTopLHsBinds :: LHsBinds Id -> DsM (OrdList (Id,CoreExpr))
dsTopLHsBinds binds = ds_lhs_binds binds
83

84
dsLHsBinds :: LHsBinds Id -> DsM [(Id,CoreExpr)]
85
dsLHsBinds binds = do { binds' <- ds_lhs_binds binds
86
                      ; return (fromOL binds') }
87 88

------------------------
89
ds_lhs_binds :: LHsBinds Id -> DsM (OrdList (Id,CoreExpr))
90

91 92
ds_lhs_binds binds = do { ds_bs <- mapBagM dsLHsBind binds
                        ; return (foldBag appOL id nilOL ds_bs) }
93

94 95
dsLHsBind :: LHsBind Id -> DsM (OrdList (Id,CoreExpr))
dsLHsBind (L loc bind) = putSrcSpanDs loc $ dsHsBind bind
96

97
dsHsBind :: HsBind Id -> DsM (OrdList (Id,CoreExpr))
98

99
dsHsBind (VarBind { var_id = var, var_rhs = expr, var_inline = inline_regardless })
100 101
  = do  { dflags <- getDynFlags
        ; core_expr <- dsLExpr expr
102

103 104
                -- Dictionary bindings are always VarBinds,
                -- so we only need do this here
105
        ; let var' | inline_regardless = var `setIdUnfolding` mkCompulsoryUnfolding core_expr
106
                   | otherwise         = var
107

108
        ; return (unitOL (makeCorePair dflags var' False 0 core_expr)) }
109

110
dsHsBind (FunBind { fun_id = L _ fun, fun_matches = matches
111
                  , fun_co_fn = co_fn, fun_tick = tick })
112
 = do   { dflags <- getDynFlags
113
        ; (args, body) <- matchWrapper (FunRhs (idName fun)) matches
114
        ; let body' = mkOptTickBox tick body
115
        ; rhs <- dsHsWrapper co_fn (mkLams args body')
116
        ; {- pprTrace "dsHsBind" (ppr fun <+> ppr (idInlinePragma fun)) $ -}
117
           return (unitOL (makeCorePair dflags fun False 0 rhs)) }
118 119 120

dsHsBind (PatBind { pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty
                  , pat_ticks = (rhs_tick, var_ticks) })
121
  = do  { body_expr <- dsGuarded grhss ty
122 123
        ; let body' = mkOptTickBox rhs_tick body_expr
        ; sel_binds <- mkSelectorBinds var_ticks pat body'
124 125
          -- We silently ignore inline pragmas; no makeCorePair
          -- Not so cool, but really doesn't matter
126
    ; return (toOL sel_binds) }
sof's avatar
sof committed
127

128 129 130 131
        -- A common case: one exported variable
        -- Non-recursive bindings come through this way
        -- So do self-recursive bindings, and recursive bindings
        -- that have been chopped up with type signatures
132 133 134
dsHsBind (AbsBinds { abs_tvs = tyvars, abs_ev_vars = dicts
                   , abs_exports = [export]
                   , abs_ev_binds = ev_binds, abs_binds = binds })
135 136
  | ABE { abe_wrap = wrap, abe_poly = global
        , abe_mono = local, abe_prags = prags } <- export
137
  = do  { dflags <- getDynFlags
138 139 140
        ; bind_prs <- ds_lhs_binds binds
        ; let core_bind = Rec (fromOL bind_prs)
        ; ds_binds <- dsTcEvBinds_s ev_binds
141
        ; rhs <- dsHsWrapper wrap $  -- Usually the identity
142 143
                            mkLams tyvars $ mkLams dicts $
                            mkCoreLets ds_binds $
144 145
                            Let core_bind $
                            Var local
146

147 148 149 150 151 152 153
        ; (spec_binds, rules) <- dsSpecs rhs prags

        ; let   global'   = addIdSpecialisations global rules
                main_bind = makeCorePair dflags global' (isDefaultMethod prags)
                                         (dictArity dicts) rhs

        ; return (main_bind `consOL` spec_binds) }
sof's avatar
sof committed
154

155 156 157
dsHsBind (AbsBinds { abs_tvs = tyvars, abs_ev_vars = dicts
                   , abs_exports = exports, abs_ev_binds = ev_binds
                   , abs_binds = binds })
158
         -- See Note [Desugaring AbsBinds]
159 160 161
  = do  { dflags <- getDynFlags
        ; bind_prs    <- ds_lhs_binds binds
        ; let core_bind = Rec [ makeCorePair dflags (add_inline lcl_id) False 0 rhs
162
                              | (lcl_id, rhs) <- fromOL bind_prs ]
163
                -- Monomorphic recursion possible, hence Rec
164

165 166 167
              locals       = map abe_mono exports
              tup_expr     = mkBigCoreVarTup locals
              tup_ty       = exprType tup_expr
168
        ; ds_binds <- dsTcEvBinds_s ev_binds
169 170 171 172
        ; let poly_tup_rhs = mkLams tyvars $ mkLams dicts $
                             mkCoreLets ds_binds $
                             Let core_bind $
                             tup_expr
173

174
        ; poly_tup_id <- newSysLocalDs (exprType poly_tup_rhs)
175

176
        ; let mk_bind (ABE { abe_wrap = wrap, abe_poly = global
177
                           , abe_mono = local, abe_prags = spec_prags })
178 179
                = do { tup_id  <- newSysLocalDs tup_ty
                     ; rhs <- dsHsWrapper wrap $
180
                                 mkLams tyvars $ mkLams dicts $
181 182
                                 mkTupleSelector locals local tup_id $
                                 mkVarApps (Var poly_tup_id) (tyvars ++ dicts)
183
                     ; let rhs_for_spec = Let (NonRec poly_tup_id poly_tup_rhs) rhs
184 185
                     ; (spec_binds, rules) <- dsSpecs rhs_for_spec spec_prags
                     ; let global' = (global `setInlinePragma` defaultInlinePragma)
186 187 188
                                             `addIdSpecialisations` rules
                           -- Kill the INLINE pragma because it applies to
                           -- the user written (local) function.  The global
189 190
                           -- Id is just the selector.  Hmm.
                     ; return ((global', rhs) `consOL` spec_binds) }
191

192
        ; export_binds_s <- mapM mk_bind exports
193

194 195
        ; return ((poly_tup_id, poly_tup_rhs) `consOL`
                    concatOL export_binds_s) }
196 197 198 199 200 201 202 203 204 205 206
  where
    inline_env :: IdEnv Id   -- Maps a monomorphic local Id to one with
                             -- the inline pragma from the source
                             -- The type checker put the inline pragma
                             -- on the *global* Id, so we need to transfer it
    inline_env = mkVarEnv [ (lcl_id, setInlinePragma lcl_id prag)
                          | ABE { abe_mono = lcl_id, abe_poly = gbl_id } <- exports
                          , let prag = idInlinePragma gbl_id ]

    add_inline :: Id -> Id    -- tran
    add_inline lcl_id = lookupVarEnv inline_env lcl_id `orElse` lcl_id
207

cactus's avatar
cactus committed
208 209
dsHsBind (PatSynBind{}) = panic "dsHsBind: PatSynBind"

210
------------------------
211 212
makeCorePair :: DynFlags -> Id -> Bool -> Arity -> CoreExpr -> (Id, CoreExpr)
makeCorePair dflags gbl_id is_default_method dict_arity rhs
213
  | is_default_method                 -- Default methods are *always* inlined
214 215
  = (gbl_id `setIdUnfolding` mkCompulsoryUnfolding rhs, rhs)

216
  | DFunId is_newtype <- idDetails gbl_id
217 218
  = (mk_dfun_w_stuff is_newtype, rhs)

219 220
  | otherwise
  = case inlinePragmaSpec inline_prag of
221 222 223
          EmptyInlineSpec -> (gbl_id, rhs)
          NoInline        -> (gbl_id, rhs)
          Inlinable       -> (gbl_id `setIdUnfolding` inlinable_unf, rhs)
224
          Inline          -> inline_pair
225

226 227
  where
    inline_prag   = idInlinePragma gbl_id
228
    inlinable_unf = mkInlinableUnfolding dflags rhs
229 230
    inline_pair
       | Just arity <- inlinePragmaSat inline_prag
231 232
        -- Add an Unfolding for an INLINE (but not for NOINLINE)
        -- And eta-expand the RHS; see Note [Eta-expanding INLINE things]
233
       , let real_arity = dict_arity + arity
234
        -- NB: The arity in the InlineRule takes account of the dictionaries
235 236 237 238 239 240
       = ( gbl_id `setIdUnfolding` mkInlineUnfolding (Just real_arity) rhs
         , etaExpand real_arity rhs)

       | otherwise
       = pprTrace "makeCorePair: arity missing" (ppr gbl_id) $
         (gbl_id `setIdUnfolding` mkInlineUnfolding Nothing rhs, rhs)
241

242 243 244
                -- See Note [ClassOp/DFun selection] in TcInstDcls
                -- See Note [Single-method classes]  in TcInstDcls
    mk_dfun_w_stuff is_newtype
Austin Seipp's avatar
Austin Seipp committed
245
       | is_newtype
246 247 248 249 250 251 252 253 254 255 256 257
       = gbl_id `setIdUnfolding`  mkInlineUnfolding (Just 0) rhs
                `setInlinePragma` alwaysInlinePragma { inl_sat = Just 0 }
       | otherwise
       = gbl_id `setIdUnfolding`  mkDFunUnfolding dfun_bndrs dfun_constr dfun_args
                `setInlinePragma` dfunInlinePragma
    (dfun_bndrs, dfun_body) = collectBinders (simpleOptExpr rhs)
    (dfun_con, dfun_args)   = collectArgs dfun_body
    dfun_constr | Var id <- dfun_con
                , DataConWorkId con <- idDetails id
                = con
                | otherwise = pprPanic "makeCorePair: dfun" (ppr rhs)

258 259 260 261

dictArity :: [Var] -> Arity
-- Don't count coercion variables in arity
dictArity dicts = count isId dicts
262

Austin Seipp's avatar
Austin Seipp committed
263
{-
264 265 266 267 268 269 270 271 272 273
[Desugaring AbsBinds]
~~~~~~~~~~~~~~~~~~~~~
In the general AbsBinds case we desugar the binding to this:

       tup a (d:Num a) = let fm = ...gm...
                             gm = ...fm...
                         in (fm,gm)
       f a d = case tup a d of { (fm,gm) -> fm }
       g a d = case tup a d of { (fm,gm) -> fm }

274 275 276 277 278
Note [Rules and inlining]
~~~~~~~~~~~~~~~~~~~~~~~~~
Common special case: no type or dictionary abstraction
This is a bit less trivial than you might suppose
The naive way woudl be to desguar to something like
279 280
        f_lcl = ...f_lcl...     -- The "binds" from AbsBinds
        M.f = f_lcl             -- Generated from "exports"
281
But we don't want that, because if M.f isn't exported,
282 283
it'll be inlined unconditionally at every call site (its rhs is
trivial).  That would be ok unless it has RULES, which would
284 285 286
thereby be completely lost.  Bad, bad, bad.

Instead we want to generate
287 288 289
        M.f = ...f_lcl...
        f_lcl = M.f
Now all is cool. The RULES are attached to M.f (by SimplCore),
290 291 292 293
and f_lcl is rapidly inlined away.

This does not happen in the same way to polymorphic binds,
because they desugar to
294
        M.f = /\a. let f_lcl = ...f_lcl... in f_lcl
295
Although I'm a bit worried about whether full laziness might
296
float the f_lcl binding out and then inline M.f at its call site
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

Note [Specialising in no-dict case]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Even if there are no tyvars or dicts, we may have specialisation pragmas.
Class methods can generate
      AbsBinds [] [] [( ... spec-prag]
         { AbsBinds [tvs] [dicts] ...blah }
So the overloading is in the nested AbsBinds. A good example is in GHC.Float:

  class  (Real a, Fractional a) => RealFrac a  where
    round :: (Integral b) => a -> b

  instance  RealFrac Float  where
    {-# SPECIALIZE round :: Float -> Int #-}

312
The top-level AbsBinds for $cround has no tyvars or dicts (because the
313 314 315 316 317 318 319
instance does not).  But the method is locally overloaded!

Note [Abstracting over tyvars only]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When abstracting over type variable only (not dictionaries), we don't really need to
built a tuple and select from it, as we do in the general case. Instead we can take

320 321 322 323 324
        AbsBinds [a,b] [ ([a,b], fg, fl, _),
                         ([b],   gg, gl, _) ]
                { fl = e1
                  gl = e2
                   h = e3 }
325 326 327

and desugar it to

328 329 330
        fg = /\ab. let B in e1
        gg = /\b. let a = () in let B in S(e2)
        h  = /\ab. let B in e3
331 332

where B is the *non-recursive* binding
333 334 335
        fl = fg a b
        gl = gg b
        h  = h a b    -- See (b); note shadowing!
336 337

Notice (a) g has a different number of type variables to f, so we must
338 339
             use the mkArbitraryType thing to fill in the gaps.
             We use a type-let to do that.
340

341 342 343 344
         (b) The local variable h isn't in the exports, and rather than
             clone a fresh copy we simply replace h by (h a b), where
             the two h's have different types!  Shadowing happens here,
             which looks confusing but works fine.
345

346 347 348 349
         (c) The result is *still* quadratic-sized if there are a lot of
             small bindings.  So if there are more than some small
             number (10), we filter the binding set B by the free
             variables of the particular RHS.  Tiresome.
350 351

Why got to this trouble?  It's a common case, and it removes the
352
quadratic-sized tuple desugaring.  Less clutter, hopefully faster
353 354 355 356
compilation, especially in a case where there are a *lot* of
bindings.


357 358 359 360 361 362 363 364
Note [Eta-expanding INLINE things]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   foo :: Eq a => a -> a
   {-# INLINE foo #-}
   foo x = ...

If (foo d) ever gets floated out as a common sub-expression (which can
365
happen as a result of method sharing), there's a danger that we never
366 367 368 369
get to do the inlining, which is a Terribly Bad thing given that the
user said "inline"!

To avoid this we pre-emptively eta-expand the definition, so that foo
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
370
has the arity with which it is declared in the source code.  In this
371
example it has arity 2 (one for the Eq and one for x). Doing this
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
372
should mean that (foo d) is a PAP and we don't share it.
373 374 375

Note [Nested arities]
~~~~~~~~~~~~~~~~~~~~~
376 377 378 379 380 381 382 383 384 385 386 387 388 389
For reasons that are not entirely clear, method bindings come out looking like
this:

  AbsBinds [] [] [$cfromT <= [] fromT]
    $cfromT [InlPrag=INLINE] :: T Bool -> Bool
    { AbsBinds [] [] [fromT <= [] fromT_1]
        fromT :: T Bool -> Bool
        { fromT_1 ((TBool b)) = not b } } }

Note the nested AbsBind.  The arity for the InlineRule on $cfromT should be
gotten from the binding for fromT_1.

It might be better to have just one level of AbsBinds, but that requires more
thought!
Austin Seipp's avatar
Austin Seipp committed
390
-}
391

392
------------------------
393
dsSpecs :: CoreExpr     -- Its rhs
394
        -> TcSpecPrags
395 396
        -> DsM ( OrdList (Id,CoreExpr)  -- Binding for specialised Ids
               , [CoreRule] )           -- Rules for the Global Ids
397
-- See Note [Handling SPECIALISE pragmas] in TcBinds
398 399 400 401 402 403
dsSpecs _ IsDefaultMethod = return (nilOL, [])
dsSpecs poly_rhs (SpecPrags sps)
  = do { pairs <- mapMaybeM (dsSpec (Just poly_rhs)) sps
       ; let (spec_binds_s, rules) = unzip pairs
       ; return (concatOL spec_binds_s, rules) }

404 405 406
dsSpec :: Maybe CoreExpr        -- Just rhs => RULE is for a local binding
                                -- Nothing => RULE is for an imported Id
                                --            rhs is in the Id's unfolding
407 408 409
       -> Located TcSpecPrag
       -> DsM (Maybe (OrdList (Id,CoreExpr), CoreRule))
dsSpec mb_poly_rhs (L loc (SpecPrag poly_id spec_co spec_inl))
410
  | isJust (isClassOpId_maybe poly_id)
411 412
  = putSrcSpanDs loc $
    do { warnDs (ptext (sLit "Ignoring useless SPECIALISE pragma for class method selector")
413 414
                 <+> quotes (ppr poly_id))
       ; return Nothing  }  -- There is no point in trying to specialise a class op
415 416
                            -- Moreover, classops don't (currently) have an inl_sat arity set
                            -- (it would be Just 0) and that in turn makes makeCorePair bleat
417

418 419
  | no_act_spec && isNeverActive rule_act
  = putSrcSpanDs loc $
420 421 422
    do { warnDs (ptext (sLit "Ignoring useless SPECIALISE pragma for NOINLINE function:")
                 <+> quotes (ppr poly_id))
       ; return Nothing  }  -- Function is NOINLINE, and the specialiation inherits that
423
                            -- See Note [Activation pragmas for SPECIALISE]
424

425
  | otherwise
426
  = putSrcSpanDs loc $
427 428
    do { uniq <- newUnique
       ; let poly_name = idName poly_id
429 430
             spec_occ  = mkSpecOcc (getOccName poly_name)
             spec_name = mkInternalName uniq spec_occ (getSrcSpan poly_name)
431 432 433
       ; (bndrs, ds_lhs) <- liftM collectBinders
                                  (dsHsWrapper spec_co (Var poly_id))
       ; let spec_ty = mkPiTypes bndrs (exprType ds_lhs)
434 435 436 437
       ; -- pprTrace "dsRule" (vcat [ ptext (sLit "Id:") <+> ppr poly_id
         --                         , ptext (sLit "spec_co:") <+> ppr spec_co
         --                         , ptext (sLit "ds_rhs:") <+> ppr ds_lhs ]) $
         case decomposeRuleLhs bndrs ds_lhs of {
438
           Left msg -> do { warnDs msg; return Nothing } ;
439
           Right (rule_bndrs, _fn, args) -> do
440

441
       { dflags <- getDynFlags
442
       ; this_mod <- getModule
Simon Peyton Jones's avatar
Simon Peyton Jones committed
443 444 445 446
       ; let fn_unf    = realIdUnfolding poly_id
             unf_fvs   = stableUnfoldingVars fn_unf `orElse` emptyVarSet
             in_scope  = mkInScopeSet (unf_fvs `unionVarSet` exprsFreeVars args)
             spec_unf  = specUnfolding dflags (mkEmptySubst in_scope) bndrs args fn_unf
447 448 449
             spec_id   = mkLocalId spec_name spec_ty
                            `setInlinePragma` inl_prag
                            `setIdUnfolding`  spec_unf
450
       ; rule <- dsMkUserRule this_mod is_local_id
Ian Lynagh's avatar
Ian Lynagh committed
451
                        (mkFastString ("SPEC " ++ showPpr dflags poly_name))
452 453 454
                        rule_act poly_name
                        rule_bndrs args
                        (mkVarApps (Var spec_id) bndrs)
455

456
       ; spec_rhs <- dsHsWrapper spec_co poly_rhs
457

458 459 460 461
-- Commented out: see Note [SPECIALISE on INLINE functions]
--       ; when (isInlinePragma id_inl)
--              (warnDs $ ptext (sLit "SPECIALISE pragma on INLINE function probably won't fire:")
--                        <+> quotes (ppr poly_name))
Simon Peyton Jones's avatar
Simon Peyton Jones committed
462 463 464 465 466

       ; return (Just (unitOL (spec_id, spec_rhs), rule))
            -- NB: do *not* use makeCorePair on (spec_id,spec_rhs), because
            --     makeCorePair overwrites the unfolding, which we have
            --     just created using specUnfolding
467 468 469 470
       } } }
  where
    is_local_id = isJust mb_poly_rhs
    poly_rhs | Just rhs <-  mb_poly_rhs
471
             = rhs          -- Local Id; this is its rhs
472 473
             | Just unfolding <- maybeUnfoldingTemplate (realIdUnfolding poly_id)
             = unfolding    -- Imported Id; this is its unfolding
474 475 476
                            -- Use realIdUnfolding so we get the unfolding
                            -- even when it is a loop breaker.
                            -- We want to specialise recursive functions!
477
             | otherwise = pprPanic "dsImpSpecs" (ppr poly_id)
478
                            -- The type checker has checked that it *has* an unfolding
479

480 481 482 483 484
    id_inl = idInlinePragma poly_id

    -- See Note [Activation pragmas for SPECIALISE]
    inl_prag | not (isDefaultInlinePragma spec_inl)    = spec_inl
             | not is_local_id  -- See Note [Specialising imported functions]
485
                                 -- in OccurAnal
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
             , isStrongLoopBreaker (idOccInfo poly_id) = neverInlinePragma
             | otherwise                               = id_inl
     -- Get the INLINE pragma from SPECIALISE declaration, or,
     -- failing that, from the original Id

    spec_prag_act = inlinePragmaActivation spec_inl

    -- See Note [Activation pragmas for SPECIALISE]
    -- no_act_spec is True if the user didn't write an explicit
    -- phase specification in the SPECIALISE pragma
    no_act_spec = case inlinePragmaSpec spec_inl of
                    NoInline -> isNeverActive  spec_prag_act
                    _        -> isAlwaysActive spec_prag_act
    rule_act | no_act_spec = inlinePragmaActivation id_inl   -- Inherit
             | otherwise   = spec_prag_act                   -- Specified by user


503 504 505 506 507 508 509 510 511 512 513
dsMkUserRule :: Module -> Bool -> RuleName -> Activation
       -> Name -> [CoreBndr] -> [CoreExpr] -> CoreExpr -> DsM CoreRule
dsMkUserRule this_mod is_local name act fn bndrs args rhs = do
    let rule = mkRule this_mod False is_local name act fn bndrs args rhs
    dflags <- getDynFlags
    when (isOrphan (ru_orphan rule) && wopt Opt_WarnOrphans dflags) $
        warnDs (ruleOrphWarn rule)
    return rule

ruleOrphWarn :: CoreRule -> SDoc
ruleOrphWarn rule = ptext (sLit "Orphan rule:") <+> ppr rule
514

515 516 517 518 519 520 521 522 523 524 525 526 527
{- Note [SPECIALISE on INLINE functions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We used to warn that using SPECIALISE for a function marked INLINE
would be a no-op; but it isn't!  Especially with worker/wrapper split
we might have
   {-# INLINE f #-}
   f :: Ord a => Int -> a -> ...
   f d x y = case x of I# x' -> $wf d x' y

We might want to specialise 'f' so that we in turn specialise '$wf'.
We can't even /name/ '$wf' in the source code, so we can't specialise
it even if we wanted to.  Trac #10721 is a case in point.

528 529 530 531 532 533 534 535
Note [Activation pragmas for SPECIALISE]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
From a user SPECIALISE pragma for f, we generate
  a) A top-level binding    spec_fn = rhs
  b) A RULE                 f dOrd = spec_fn

We need two pragma-like things:

536
* spec_fn's inline pragma: inherited from f's inline pragma (ignoring
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
                           activation on SPEC), unless overriden by SPEC INLINE

* Activation of RULE: from SPECIALISE pragma (if activation given)
                      otherwise from f's inline pragma

This is not obvious (see Trac #5237)!

Examples      Rule activation   Inline prag on spec'd fn
---------------------------------------------------------------------
SPEC [n] f :: ty            [n]   Always, or NOINLINE [n]
                                  copy f's prag

NOINLINE f
SPEC [n] f :: ty            [n]   NOINLINE
                                  copy f's prag

NOINLINE [k] f
SPEC [n] f :: ty            [n]   NOINLINE [k]
                                  copy f's prag

INLINE [k] f
558
SPEC [n] f :: ty            [n]   INLINE [k]
559 560 561 562 563 564 565 566 567 568
                                  copy f's prag

SPEC INLINE [n] f :: ty     [n]   INLINE [n]
                                  (ignore INLINE prag on f,
                                  same activation for rule and spec'd fn)

NOINLINE [k] f
SPEC f :: ty                [n]   INLINE [k]


Austin Seipp's avatar
Austin Seipp committed
569 570
************************************************************************
*                                                                      *
571
\subsection{Adding inline pragmas}
Austin Seipp's avatar
Austin Seipp committed
572 573 574
*                                                                      *
************************************************************************
-}
575

576
decomposeRuleLhs :: [Var] -> CoreExpr -> Either SDoc ([Var], Id, [CoreExpr])
unknown's avatar
unknown committed
577 578
-- (decomposeRuleLhs bndrs lhs) takes apart the LHS of a RULE,
-- The 'bndrs' are the quantified binders of the rules, but decomposeRuleLhs
579
-- may add some extra dictionary binders (see Note [Free dictionaries])
unknown's avatar
unknown committed
580
--
581
-- Returns Nothing if the LHS isn't of the expected shape
582 583 584 585 586 587
-- Note [Decomposing the left-hand side of a RULE]
decomposeRuleLhs orig_bndrs orig_lhs
  | not (null unbound)    -- Check for things unbound on LHS
                          -- See Note [Unused spec binders]
  = Left (vcat (map dead_msg unbound))

588 589
  | Just (fn_id, args) <- decompose fun2 args2
  , let extra_dict_bndrs = mk_extra_dict_bndrs fn_id args
590 591 592
  = -- pprTrace "decmposeRuleLhs" (vcat [ ptext (sLit "orig_bndrs:") <+> ppr orig_bndrs
    --                                  , ptext (sLit "orig_lhs:") <+> ppr orig_lhs
    --                                  , ptext (sLit "lhs1:")     <+> ppr lhs1
593 594
    --                                  , ptext (sLit "extra_dict_bndrs:") <+> ppr extra_dict_bndrs
    --                                  , ptext (sLit "fn_id:") <+> ppr fn_id
595
    --                                  , ptext (sLit "args:")   <+> ppr args]) $
596
    Right (orig_bndrs ++ extra_dict_bndrs, fn_id, args)
597

598
  | otherwise
599
  = Left bad_shape_msg
600
 where
601 602 603 604
   lhs1         = drop_dicts orig_lhs
   lhs2         = simpleOptExpr lhs1  -- See Note [Simplify rule LHS]
   (fun2,args2) = collectArgs lhs2

605 606
   lhs_fvs    = exprFreeVars lhs2
   unbound    = filterOut (`elemVarSet` lhs_fvs) orig_bndrs
607

608
   orig_bndr_set = mkVarSet orig_bndrs
609

610
        -- Add extra dict binders: Note [Free dictionaries]
611 612 613 614 615 616 617 618 619 620 621 622
   mk_extra_dict_bndrs fn_id args
     = [ mkLocalId (localiseName (idName d)) (idType d)
       | d <- varSetElems (exprsFreeVars args `delVarSetList` (fn_id : orig_bndrs))
              -- fn_id: do not quantify over the function itself, which may
              -- itself be a dictionary (in pathological cases, Trac #10251)
       , isDictId d ]

   decompose (Var fn_id) args
      | not (fn_id `elemVarSet` orig_bndr_set)
      = Just (fn_id, args)

   decompose _ _ = Nothing
623 624

   bad_shape_msg = hang (ptext (sLit "RULE left-hand side too complicated to desugar"))
625 626
                      2 (vcat [ text "Optimised lhs:" <+> ppr lhs2
                              , text "Orig lhs:" <+> ppr orig_lhs])
627
   dead_msg bndr = hang (sep [ ptext (sLit "Forall'd") <+> pp_bndr bndr
628
                             , ptext (sLit "is not bound in RULE lhs")])
629 630 631
                      2 (vcat [ text "Orig bndrs:" <+> ppr orig_bndrs
                              , text "Orig lhs:" <+> ppr orig_lhs
                              , text "optimised lhs:" <+> ppr lhs2 ])
632
   pp_bndr bndr
633 634 635
    | isTyVar bndr                      = ptext (sLit "type variable") <+> quotes (ppr bndr)
    | Just pred <- evVarPred_maybe bndr = ptext (sLit "constraint") <+> quotes (ppr pred)
    | otherwise                         = ptext (sLit "variable") <+> quotes (ppr bndr)
636 637

   drop_dicts :: CoreExpr -> CoreExpr
638
   drop_dicts e
639 640 641
       = wrap_lets needed bnds body
     where
       needed = orig_bndr_set `minusVarSet` exprFreeVars body
642
       (bnds, body) = split_lets (occurAnalyseExpr e)
643
           -- The occurAnalyseExpr drops dead bindings which is
644 645
           -- crucial to ensure that every binding is used later;
           -- which in turn makes wrap_lets work right
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

   split_lets :: CoreExpr -> ([(DictId,CoreExpr)], CoreExpr)
   split_lets e
     | Let (NonRec d r) body <- e
     , isDictId d
     , (bs, body') <- split_lets body
     = ((d,r):bs, body')
     | otherwise
     = ([], e)

   wrap_lets :: VarSet -> [(DictId,CoreExpr)] -> CoreExpr -> CoreExpr
   wrap_lets _ [] body = body
   wrap_lets needed ((d, r) : bs) body
     | rhs_fvs `intersectsVarSet` needed = Let (NonRec d r) (wrap_lets needed' bs body)
     | otherwise                         = wrap_lets needed bs body
     where
       rhs_fvs = exprFreeVars r
       needed' = (needed `minusVarSet` rhs_fvs) `extendVarSet` d
664

Austin Seipp's avatar
Austin Seipp committed
665
{-
666
Note [Decomposing the left-hand side of a RULE]
667
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
668
There are several things going on here.
669 670
* drop_dicts: see Note [Drop dictionary bindings on rule LHS]
* simpleOptExpr: see Note [Simplify rule LHS]
671
* extra_dict_bndrs: see Note [Free dictionaries]
672 673 674

Note [Drop dictionary bindings on rule LHS]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
675
drop_dicts drops dictionary bindings on the LHS where possible.
676 677
   E.g.  let d:Eq [Int] = $fEqList $fEqInt in f d
     --> f d
678
   Reasoning here is that there is only one d:Eq [Int], and so we can
679 680 681 682
   quantify over it. That makes 'd' free in the LHS, but that is later
   picked up by extra_dict_bndrs (Note [Dead spec binders]).

   NB 1: We can only drop the binding if the RHS doesn't bind
683
         one of the orig_bndrs, which we assume occur on RHS.
684 685 686 687 688 689
         Example
            f :: (Eq a) => b -> a -> a
            {-# SPECIALISE f :: Eq a => b -> [a] -> [a] #-}
         Here we want to end up with
            RULE forall d:Eq a.  f ($dfEqList d) = f_spec d
         Of course, the ($dfEqlist d) in the pattern makes it less likely
690
         to match, but there is no other way to get d:Eq a
691

692
   NB 2: We do drop_dicts *before* simplOptEpxr, so that we expect all
693 694 695 696 697 698
         the evidence bindings to be wrapped around the outside of the
         LHS.  (After simplOptExpr they'll usually have been inlined.)
         dsHsWrapper does dependency analysis, so that civilised ones
         will be simple NonRec bindings.  We don't handle recursive
         dictionaries!

Gabor Greif's avatar
Gabor Greif committed
699
    NB3: In the common case of a non-overloaded, but perhaps-polymorphic
700 701 702 703 704 705
         specialisation, we don't need to bind *any* dictionaries for use
         in the RHS. For example (Trac #8331)
             {-# SPECIALIZE INLINE useAbstractMonad :: ReaderST s Int #-}
             useAbstractMonad :: MonadAbstractIOST m => m Int
         Here, deriving (MonadAbstractIOST (ReaderST s)) is a lot of code
         but the RHS uses no dictionaries, so we want to end up with
706
             RULE forall s (d :: MonadAbstractIOST (ReaderT s)).
707 708
                useAbstractMonad (ReaderT s) d = $suseAbstractMonad s

709 710 711
   Trac #8848 is a good example of where there are some intersting
   dictionary bindings to discard.

712 713 714 715 716 717 718 719 720 721
The drop_dicts algorithm is based on these observations:

  * Given (let d = rhs in e) where d is a DictId,
    matching 'e' will bind e's free variables.

  * So we want to keep the binding if one of the needed variables (for
    which we need a binding) is in fv(rhs) but not already in fv(e).

  * The "needed variables" are simply the orig_bndrs.  Consider
       f :: (Eq a, Show b) => a -> b -> String
Austin Seipp's avatar
Austin Seipp committed
722
       ... SPECIALISE f :: (Show b) => Int -> b -> String ...
723 724 725 726 727 728
    Then orig_bndrs includes the *quantified* dictionaries of the type
    namely (dsb::Show b), but not the one for Eq Int

So we work inside out, applying the above criterion at each step.


729 730 731 732
Note [Simplify rule LHS]
~~~~~~~~~~~~~~~~~~~~~~~~
simplOptExpr occurrence-analyses and simplifies the LHS:

733
   (a) Inline any remaining dictionary bindings (which hopefully
734 735 736
       occur just once)

   (b) Substitute trivial lets so that they don't get in the way
737
       Note that we substitute the function too; we might
738 739
       have this as a LHS:  let f71 = M.f Int in f71

740
   (c) Do eta reduction.  To see why, consider the fold/build rule,
741 742 743 744
       which without simplification looked like:
          fold k z (build (/\a. g a))  ==>  ...
       This doesn't match unless you do eta reduction on the build argument.
       Similarly for a LHS like
745
         augment g (build h)
746
       we do not want to get
747
         augment (\a. g a) (build h)
748 749
       otherwise we don't match when given an argument like
          augment (\a. h a a) (build h)
750

751
Note [Matching seqId]
752 753
~~~~~~~~~~~~~~~~~~~
The desugarer turns (seq e r) into (case e of _ -> r), via a special-case hack
754
and this code turns it back into an application of seq!
755 756
See Note [Rules for seq] in MkId for the details.

757 758 759
Note [Unused spec binders]
~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
760
        f :: a -> a
Austin Seipp's avatar
Austin Seipp committed
761
        ... SPECIALISE f :: Eq a => a -> a ...
762 763
It's true that this *is* a more specialised type, but the rule
we get is something like this:
764 765
        f_spec d = f
        RULE: f = f_spec d
Gabor Greif's avatar
typos  
Gabor Greif committed
766 767
Note that the rule is bogus, because it mentions a 'd' that is
not bound on the LHS!  But it's a silly specialisation anyway, because
768 769 770 771
the constraint is unused.  We could bind 'd' to (error "unused")
but it seems better to reject the program because it's almost certainly
a mistake.  That's what the isDeadBinder call detects.

772 773
Note [Free dictionaries]
~~~~~~~~~~~~~~~~~~~~~~~~
774 775
When the LHS of a specialisation rule, (/\as\ds. f es) has a free dict,
which is presumably in scope at the function definition site, we can quantify
776 777 778
over it too.  *Any* dict with that type will do.

So for example when you have
779 780
        f :: Eq a => a -> a
        f = <rhs>
Austin Seipp's avatar
Austin Seipp committed
781
        ... SPECIALISE f :: Int -> Int ...
782 783

Then we get the SpecPrag
784
        SpecPrag (f Int dInt)
785 786

And from that we want the rule
787 788 789

        RULE forall dInt. f Int dInt = f_spec
        f_spec = let f = <rhs> in f Int dInt
790 791 792 793 794 795 796

But be careful!  That dInt might be GHC.Base.$fOrdInt, which is an External
Name, and you can't bind them in a lambda or forall without getting things
confused.   Likewise it might have an InlineRule or something, which would be
utterly bogus. So we really make a fresh Id, with the same unique and type
as the old one, but with an Internal name and no IdInfo.

797

Austin Seipp's avatar
Austin Seipp committed
798 799
************************************************************************
*                                                                      *
800
                Desugaring evidence
Austin Seipp's avatar
Austin Seipp committed
801 802
*                                                                      *
************************************************************************
803

Austin Seipp's avatar
Austin Seipp committed
804
-}
805

806
dsHsWrapper :: HsWrapper -> CoreExpr -> DsM CoreExpr
807
dsHsWrapper WpHole            e = return e
808 809 810
dsHsWrapper (WpTyApp ty)      e = return $ App e (Type ty)
dsHsWrapper (WpLet ev_binds)  e = do bs <- dsTcEvBinds ev_binds
                                     return (mkCoreLets bs e)
811 812 813 814
dsHsWrapper (WpCompose c1 c2) e = do { e1 <- dsHsWrapper c2 e
                                     ; dsHsWrapper c1 e1 }
dsHsWrapper (WpFun c1 c2 t1 _) e = do { x <- newSysLocalDs t1
                                      ; e1 <- dsHsWrapper c1 (Var x)
815
                                      ; e2 <- dsHsWrapper c2 (mkCoreAppDs (text "dsHsWrapper") e e1)
816
                                      ; return (Lam x e2) }
817
dsHsWrapper (WpCast co)       e = ASSERT(tcCoercionRole co == Representational)
818
                                  dsTcCoercion co (mkCastDs e)
819 820
dsHsWrapper (WpEvLam ev)      e = return $ Lam ev e
dsHsWrapper (WpTyLam tv)      e = return $ Lam tv e
821
dsHsWrapper (WpEvApp    tm)   e = liftM (App e) (dsEvTerm tm)
822 823

--------------------------------------
824 825 826 827 828
dsTcEvBinds_s :: [TcEvBinds] -> DsM [CoreBind]
dsTcEvBinds_s []       = return []
dsTcEvBinds_s (b:rest) = ASSERT( null rest )  -- Zonker ensures null
                         dsTcEvBinds b

829
dsTcEvBinds :: TcEvBinds -> DsM [CoreBind]
830
dsTcEvBinds (TcEvBinds {}) = panic "dsEvBinds"    -- Zonker has got rid of this
831 832
dsTcEvBinds (EvBinds bs)   = dsEvBinds bs

833
dsEvBinds :: Bag EvBind -> DsM [CoreBind]
834
dsEvBinds bs = mapM ds_scc (sccEvBinds bs)
835
  where
836 837 838
    ds_scc (AcyclicSCC (EvBind { eb_lhs = v, eb_rhs = r }))
                          = liftM (NonRec v) (dsEvTerm r)
    ds_scc (CyclicSCC bs) = liftM Rec (mapM ds_pair bs)
839

840
    ds_pair (EvBind { eb_lhs = v, eb_rhs = r }) = liftM ((,) v) (dsEvTerm r)
841 842 843 844 845

sccEvBinds :: Bag EvBind -> [SCC EvBind]
sccEvBinds bs = stronglyConnCompFromEdgedVertices edges
  where
    edges :: [(EvBind, EvVar, [EvVar])]
846
    edges = foldrBag ((:) . mk_node) [] bs
847 848

    mk_node :: EvBind -> (EvBind, EvVar, [EvVar])
849 850
    mk_node b@(EvBind { eb_lhs = var, eb_rhs = term })
       = (b, var, varSetElems (evVarsOfTerm term))
851 852


853 854 855 856 857 858
{-**********************************************************************
*                                                                      *
           Desugaring EvTerms
*                                                                      *
**********************************************************************-}

859
dsEvTerm :: EvTerm -> DsM CoreExpr
860 861 862 863 864
dsEvTerm (EvId v)           = return (Var v)
dsEvTerm (EvCallStack cs)   = dsEvCallStack cs
dsEvTerm (EvTypeable ty ev) = dsEvTypeable ty ev
dsEvTerm (EvLit (EvNum n))  = mkIntegerExpr n
dsEvTerm (EvLit (EvStr s))  = mkStringExprFS s
865

866
dsEvTerm (EvCast tm co)
867
  = do { tm' <- dsEvTerm tm
868
       ; dsTcCoercion co $ mkCastDs tm' }
869 870 871 872 873
         -- 'v' is always a lifted evidence variable so it is
         -- unnecessary to call varToCoreExpr v here.

dsEvTerm (EvDFunApp df tys tms)
  = return (Var df `mkTyApps` tys `mkApps` (map Var tms))
874

875
dsEvTerm (EvCoercion (TcCoVarCo v)) = return (Var v)  -- See Note [Simple coercions]
Joachim Breitner's avatar
Joachim Breitner committed
876
dsEvTerm (EvCoercion co)            = dsTcCoercion co mkEqBox
877

878
dsEvTerm (EvSuperClass d n)
879 880
  = do { d' <- dsEvTerm d
       ; let (cls, tys) = getClassPredTys (exprType d')
881
             sc_sel_id  = classSCSelId cls n    -- Zero-indexed