DsBinds.hs 55.6 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 CoreOpt          ( simpleOptExpr )
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 Digraph
39

40
import PrelNames
41
import TyCon
42
import TcEvidence
43
import TcType
44
import Type
45
import Coercion
Eric Seidel's avatar
Eric Seidel committed
46
import TysWiredIn ( typeNatKind, typeSymbolKind )
Simon Marlow's avatar
Simon Marlow committed
47
import Id
48
import MkId(proxyHashId)
49
import Class
50
import Name
51
import VarSet
Simon Marlow's avatar
Simon Marlow committed
52
import Rules
53
import VarEnv
54
import Outputable
55
import Module
Simon Marlow's avatar
Simon Marlow committed
56 57
import SrcLoc
import Maybes
58
import OrdList
Simon Marlow's avatar
Simon Marlow committed
59
import Bag
Richard Eisenberg's avatar
Richard Eisenberg committed
60
import BasicTypes
Ian Lynagh's avatar
Ian Lynagh committed
61
import DynFlags
Simon Marlow's avatar
Simon Marlow committed
62
import FastString
63
import Util
64
import MonadUtils
65
import qualified GHC.LanguageExtensions as LangExt
66
import Control.Monad
67

68
{-**********************************************************************
Austin Seipp's avatar
Austin Seipp committed
69
*                                                                      *
70
           Desugaring a MonoBinds
Austin Seipp's avatar
Austin Seipp committed
71
*                                                                      *
72
**********************************************************************-}
73

74 75
-- | Desugar top level binds, strict binds are treated like normal
-- binds since there is no good time to force before first usage.
76
dsTopLHsBinds :: LHsBinds Id -> DsM (OrdList (Id,CoreExpr))
Richard Eisenberg's avatar
Richard Eisenberg committed
77 78 79 80 81 82
dsTopLHsBinds binds
     -- see Note [Strict binds checks]
  | not (isEmptyBag unlifted_binds) || not (isEmptyBag bang_binds)
  = do { mapBagM_ (top_level_err "bindings for unlifted types") unlifted_binds
       ; mapBagM_ (top_level_err "strict pattern bindings")    bang_binds
       ; return nilOL }
83

Richard Eisenberg's avatar
Richard Eisenberg committed
84 85 86 87 88 89
  | otherwise
  = do { (force_vars, prs) <- dsLHsBinds binds
       ; when debugIsOn $
         do { xstrict <- xoptM LangExt.Strict
            ; MASSERT2( null force_vars || xstrict, ppr binds $$ ppr force_vars ) }
              -- with -XStrict, even top-level vars are listed as force vars.
90

Richard Eisenberg's avatar
Richard Eisenberg committed
91 92 93 94 95 96 97 98 99 100
       ; return (toOL prs) }

  where
    unlifted_binds = filterBag (isUnliftedHsBind . unLoc) binds
    bang_binds     = filterBag (isBangedPatBind  . unLoc) binds

    top_level_err desc (L loc bind)
      = putSrcSpanDs loc $
        errDs (hang (text "Top-level" <+> text desc <+> text "aren't allowed:")
                  2 (ppr bind))
101

102

Richard Eisenberg's avatar
Richard Eisenberg committed
103
-- | Desugar all other kind of bindings, Ids of strict binds are returned to
104
-- later be forced in the binding group body, see Note [Desugar Strict binds]
Richard Eisenberg's avatar
Richard Eisenberg committed
105 106 107 108
dsLHsBinds :: LHsBinds Id -> DsM ([Id], [(Id,CoreExpr)])
dsLHsBinds binds
  = do { MASSERT( allBag (not . isUnliftedHsBind . unLoc) binds )
       ; ds_bs <- mapBagM dsLHsBind binds
109 110 111
       ; return (foldBag (\(a, a') (b, b') -> (a ++ b, a' ++ b'))
                         id ([], []) ds_bs) }

Richard Eisenberg's avatar
Richard Eisenberg committed
112
------------------------
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
dsLHsBind :: LHsBind Id
          -> DsM ([Id], [(Id,CoreExpr)])
dsLHsBind (L loc bind) = do dflags <- getDynFlags
                            putSrcSpanDs loc $ dsHsBind dflags bind

-- | Desugar a single binding (or group of recursive binds).
dsHsBind :: DynFlags
         -> HsBind Id
         -> DsM ([Id], [(Id,CoreExpr)])
         -- ^ The Ids of strict binds, to be forced in the body of the
         -- binding group see Note [Desugar Strict binds] and all
         -- bindings and their desugared right hand sides.

dsHsBind dflags
         (VarBind { var_id = var
                  , var_rhs = expr
                  , var_inline = inline_regardless })
  = do  { core_expr <- dsLExpr expr
131 132
                -- Dictionary bindings are always VarBinds,
                -- so we only need do this here
133
        ; let var' | inline_regardless = var `setIdUnfolding` mkCompulsoryUnfolding core_expr
134
                   | otherwise         = var
135
        ; let core_bind@(id,_) = makeCorePair dflags var' False 0 core_expr
136
              force_var = if xopt LangExt.Strict dflags
137 138 139 140 141 142
                          then [id]
                          else []
        ; return (force_var, [core_bind]) }

dsHsBind dflags
         (FunBind { fun_id = L _ fun, fun_matches = matches
143
                  , fun_co_fn = co_fn, fun_tick = tick })
144
 = do   { (args, body) <- matchWrapper
Ben Gamari's avatar
Ben Gamari committed
145
                           (mkPrefixFunRhs (noLoc $ idName fun))
146
                           Nothing matches
Simon Peyton Jones's avatar
Simon Peyton Jones committed
147
        ; core_wrap <- dsHsWrapper co_fn
148
        ; let body' = mkOptTickBox tick body
Simon Peyton Jones's avatar
Simon Peyton Jones committed
149 150
              rhs   = core_wrap (mkLams args body')
              core_binds@(id,_) = makeCorePair dflags fun False 0 rhs
151
              force_var =
152
                if xopt LangExt.Strict dflags
153 154 155
                   && matchGroupArity matches == 0 -- no need to force lambdas
                then [id]
                else []
156
        ; {- pprTrace "dsHsBind" (ppr fun <+> ppr (idInlinePragma fun)) $ -}
157
           return (force_var, [core_binds]) }
158

159 160
dsHsBind dflags
         (PatBind { pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty
161
                  , pat_ticks = (rhs_tick, var_ticks) })
162
  = do  { body_expr <- dsGuarded grhss ty
163
        ; let body' = mkOptTickBox rhs_tick body_expr
164
              pat'  = decideBangHood dflags pat
165
        ; (force_var,sel_binds) <- mkSelectorBinds var_ticks pat body'
166 167
          -- We silently ignore inline pragmas; no makeCorePair
          -- Not so cool, but really doesn't matter
168 169
        ; let force_var' = if isBangedLPat pat'
                           then [force_var]
170 171
                           else []
        ; return (force_var', sel_binds) }
sof's avatar
sof committed
172

173
        -- A common case: one exported variable, only non-strict binds
174
        -- Non-recursive bindings come through this way
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
175 176
        -- So do self-recursive bindings
        -- Bindings with complete signatures are AbsBindsSigs, below
177 178
dsHsBind dflags
         (AbsBinds { abs_tvs = tyvars, abs_ev_vars = dicts
179 180
                   , abs_exports = [export]
                   , abs_ev_binds = ev_binds, abs_binds = binds })
181
  | ABE { abe_wrap = wrap, abe_poly = global
182
        , abe_mono = local, abe_prags = prags } <- export
183 184 185
  , not (xopt LangExt.Strict dflags)             -- Handle strict binds
  , not (anyBag (isBangedPatBind . unLoc) binds) --        in the next case
  = -- See Note [AbsBinds wrappers] in HsBinds
186
    addDictsDs (toTcTypeBag (listToBag dicts)) $
187
         -- addDictsDs: push type constraints deeper for pattern match check
Richard Eisenberg's avatar
Richard Eisenberg committed
188
    do { (_, bind_prs) <- dsLHsBinds binds
189
       ; ds_binds <- dsTcEvBinds_s ev_binds
Simon Peyton Jones's avatar
Simon Peyton Jones committed
190
       ; core_wrap <- dsHsWrapper wrap -- Usually the identity
191

Simon Peyton Jones's avatar
Simon Peyton Jones committed
192 193 194
       ; let rhs = core_wrap $
                   mkLams tyvars $ mkLams dicts $
                   mkCoreLets ds_binds $
195
                   mkLetRec bind_prs $
Simon Peyton Jones's avatar
Simon Peyton Jones committed
196
                   Var local
197
       ; (spec_binds, rules) <- dsSpecs rhs prags
198

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

203
       ; return ([], main_bind : fromOL spec_binds) }
sof's avatar
sof committed
204

205 206 207 208 209 210
        -- Another common case: no tyvars, no dicts
        -- In this case we can have a much simpler desugaring
dsHsBind dflags
         (AbsBinds { abs_tvs = [], abs_ev_vars = []
                   , abs_exports = exports
                   , abs_ev_binds = ev_binds, abs_binds = binds })
Richard Eisenberg's avatar
Richard Eisenberg committed
211
  = do { (force_vars, bind_prs) <- dsLHsBinds binds
212 213 214 215
       ; let mk_bind (ABE { abe_wrap = wrap
                          , abe_poly = global
                          , abe_mono = local
                          , abe_prags = prags })
Simon Peyton Jones's avatar
Simon Peyton Jones committed
216
              = do { core_wrap <- dsHsWrapper wrap
217 218
                   ; return (makeCorePair dflags global
                                          (isDefaultMethod prags)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
219
                                          0 (core_wrap (Var local))) }
220 221 222 223 224
       ; main_binds <- mapM mk_bind exports

       ; ds_binds <- dsTcEvBinds_s ev_binds
       ; return (force_vars, flattenBinds ds_binds ++ bind_prs ++ main_binds) }

225 226
dsHsBind dflags
         (AbsBinds { abs_tvs = tyvars, abs_ev_vars = dicts
227 228
                   , abs_exports = exports, abs_ev_binds = ev_binds
                   , abs_binds = binds })
229
         -- See Note [Desugaring AbsBinds]
230 231
  = addDictsDs (toTcTypeBag (listToBag dicts)) $
         -- addDictsDs: push type constraints deeper for pattern match check
Richard Eisenberg's avatar
Richard Eisenberg committed
232
     do { (local_force_vars, bind_prs) <- dsLHsBinds binds
233
        ; let core_bind = Rec [ makeCorePair dflags (add_inline lcl_id) False 0 rhs
234
                              | (lcl_id, rhs) <- bind_prs ]
235
                -- Monomorphic recursion possible, hence Rec
236
              new_force_vars = get_new_force_vars local_force_vars
237
              locals       = map abe_mono exports
238 239
              all_locals   = locals ++ new_force_vars
              tup_expr     = mkBigCoreVarTup all_locals
240
              tup_ty       = exprType tup_expr
241
        ; ds_binds <- dsTcEvBinds_s ev_binds
242 243
        ; let poly_tup_rhs = mkLams tyvars $ mkLams dicts $
                             mkCoreLets ds_binds $
244
                             mkLet core_bind $
245
                             tup_expr
246

247
        ; poly_tup_id <- newSysLocalDs (exprType poly_tup_rhs)
248

249 250 251 252 253
        -- Find corresponding global or make up a new one: sometimes
        -- we need to make new export to desugar strict binds, see
        -- Note [Desugar Strict binds]
        ; (exported_force_vars, extra_exports) <- get_exports local_force_vars

254
        ; let mk_bind (ABE { abe_wrap = wrap
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
255
                           , abe_poly = global
256
                           , abe_mono = local, abe_prags = spec_prags })
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
257
                         -- See Note [AbsBinds wrappers] in HsBinds
258
                = do { tup_id  <- newSysLocalDs tup_ty
Simon Peyton Jones's avatar
Simon Peyton Jones committed
259 260 261 262 263
                     ; core_wrap <- dsHsWrapper wrap
                     ; let rhs = core_wrap $ mkLams tyvars $ mkLams dicts $
                                 mkTupleSelector all_locals local tup_id $
                                 mkVarApps (Var poly_tup_id) (tyvars ++ dicts)
                           rhs_for_spec = Let (NonRec poly_tup_id poly_tup_rhs) rhs
264 265
                     ; (spec_binds, rules) <- dsSpecs rhs_for_spec spec_prags
                     ; let global' = (global `setInlinePragma` defaultInlinePragma)
266 267 268
                                             `addIdSpecialisations` rules
                           -- Kill the INLINE pragma because it applies to
                           -- the user written (local) function.  The global
269
                           -- Id is just the selector.  Hmm.
270
                     ; return ((global', rhs) : fromOL spec_binds) }
271

272
        ; export_binds_s <- mapM mk_bind (exports ++ extra_exports)
273

274 275 276
        ; return (exported_force_vars
                 ,(poly_tup_id, poly_tup_rhs) :
                   concat export_binds_s) }
277 278 279 280 281
  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
282 283 284 285
    inline_env
      = mkVarEnv [ (lcl_id, setInlinePragma lcl_id prag)
                 | ABE { abe_mono = lcl_id, abe_poly = gbl_id } <- exports
                 , let prag = idInlinePragma gbl_id ]
286 287

    add_inline :: Id -> Id    -- tran
288 289
    add_inline lcl_id = lookupVarEnv inline_env lcl_id
                        `orElse` lcl_id
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
    global_env :: IdEnv Id -- Maps local Id to its global exported Id
    global_env =
      mkVarEnv [ (local, global)
               | ABE { abe_mono = local, abe_poly = global } <- exports
               ]

    -- find variables that are not exported
    get_new_force_vars lcls =
      foldr (\lcl acc -> case lookupVarEnv global_env lcl of
                           Just _ -> acc
                           Nothing -> lcl:acc)
            [] lcls

    -- find exports or make up new exports for force variables
    get_exports :: [Id] -> DsM ([Id], [ABExport Id])
    get_exports lcls =
      foldM (\(glbls, exports) lcl ->
              case lookupVarEnv global_env lcl of
                Just glbl -> return (glbl:glbls, exports)
                Nothing   -> do export <- mk_export lcl
                                let glbl = abe_poly export
                                return (glbl:glbls, export:exports))
            ([],[]) lcls

    mk_export local =
      do global <- newSysLocalDs
                     (exprType (mkLams tyvars (mkLams dicts (Var local))))
         return (ABE {abe_poly = global
                     ,abe_mono = local
                     ,abe_wrap = WpHole
                     ,abe_prags = SpecPrags []})

323
-- AbsBindsSig is a combination of AbsBinds and FunBind
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
324 325 326 327 328 329 330 331 332 333
dsHsBind dflags (AbsBindsSig { abs_tvs = tyvars, abs_ev_vars = dicts
                             , abs_sig_export  = global
                             , abs_sig_prags   = prags
                             , abs_sig_ev_bind = ev_bind
                             , abs_sig_bind    = bind })
  | L bind_loc FunBind { fun_matches = matches
                       , fun_co_fn   = co_fn
                       , fun_tick    = tick } <- bind
  = putSrcSpanDs bind_loc $
    addDictsDs (toTcTypeBag (listToBag dicts)) $
334
             -- addDictsDs: push type constraints deeper for pattern match check
335
    do { (args, body) <- matchWrapper
Ben Gamari's avatar
Ben Gamari committed
336
                           (mkPrefixFunRhs (noLoc $ idName global))
337
                           Nothing matches
Simon Peyton Jones's avatar
Simon Peyton Jones committed
338 339 340 341
       ; core_wrap <- dsHsWrapper co_fn
       ; let body'   = mkOptTickBox tick body
             fun_rhs = core_wrap (mkLams args body')
             force_vars
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
               | xopt LangExt.Strict dflags
               , matchGroupArity matches == 0 -- no need to force lambdas
               = [global]
               | otherwise
               = []

       ; ds_binds <- dsTcEvBinds ev_bind
       ; let rhs = mkLams tyvars $
                   mkLams dicts $
                   mkCoreLets ds_binds $
                   fun_rhs

       ; (spec_binds, rules) <- dsSpecs rhs prags
       ; let global' = addIdSpecialisations global rules
             main_bind = makeCorePair dflags global' (isDefaultMethod prags)
                                      (dictArity dicts) rhs

       ; return (force_vars, main_bind : fromOL spec_binds) }

  | otherwise
  = pprPanic "dsHsBind: AbsBindsSig" (ppr bind)

364 365
dsHsBind _ (PatSynBind{}) = panic "dsHsBind: PatSynBind"

cactus's avatar
cactus committed
366

367 368

-- | This is where we apply INLINE and INLINABLE pragmas. All we need to
369 370 371 372 373 374
-- do is to attach the unfolding information to the Id.
--
-- Other decisions about whether to inline are made in
-- `calcUnfoldingGuidance` but the decision about whether to then expose
-- the unfolding in the interface file is made in `TidyPgm.addExternal`
-- using this information.
375
------------------------
376 377
makeCorePair :: DynFlags -> Id -> Bool -> Arity -> CoreExpr -> (Id, CoreExpr)
makeCorePair dflags gbl_id is_default_method dict_arity rhs
378
  | is_default_method                 -- Default methods are *always* inlined
379 380
  = (gbl_id `setIdUnfolding` mkCompulsoryUnfolding rhs, rhs)

381 382
  | otherwise
  = case inlinePragmaSpec inline_prag of
383 384 385
          EmptyInlineSpec -> (gbl_id, rhs)
          NoInline        -> (gbl_id, rhs)
          Inlinable       -> (gbl_id `setIdUnfolding` inlinable_unf, rhs)
386
          Inline          -> inline_pair
387

388 389
  where
    inline_prag   = idInlinePragma gbl_id
390
    inlinable_unf = mkInlinableUnfolding dflags rhs
391 392
    inline_pair
       | Just arity <- inlinePragmaSat inline_prag
393 394
        -- Add an Unfolding for an INLINE (but not for NOINLINE)
        -- And eta-expand the RHS; see Note [Eta-expanding INLINE things]
395
       , let real_arity = dict_arity + arity
396
        -- NB: The arity in the InlineRule takes account of the dictionaries
397
       = ( gbl_id `setIdUnfolding` mkInlineUnfoldingWithArity real_arity rhs
398 399 400 401
         , etaExpand real_arity rhs)

       | otherwise
       = pprTrace "makeCorePair: arity missing" (ppr gbl_id) $
402
         (gbl_id `setIdUnfolding` mkInlineUnfolding rhs, rhs)
403 404 405 406

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

Austin Seipp's avatar
Austin Seipp committed
408
{-
409 410
Note [Desugaring AbsBinds]
~~~~~~~~~~~~~~~~~~~~~~~~~~
411 412 413 414 415 416 417 418
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 }

419 420 421 422 423
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
424 425
        f_lcl = ...f_lcl...     -- The "binds" from AbsBinds
        M.f = f_lcl             -- Generated from "exports"
426
But we don't want that, because if M.f isn't exported,
427 428
it'll be inlined unconditionally at every call site (its rhs is
trivial).  That would be ok unless it has RULES, which would
429 430 431
thereby be completely lost.  Bad, bad, bad.

Instead we want to generate
432 433 434
        M.f = ...f_lcl...
        f_lcl = M.f
Now all is cool. The RULES are attached to M.f (by SimplCore),
435 436 437 438
and f_lcl is rapidly inlined away.

This does not happen in the same way to polymorphic binds,
because they desugar to
439
        M.f = /\a. let f_lcl = ...f_lcl... in f_lcl
440
Although I'm a bit worried about whether full laziness might
441
float the f_lcl binding out and then inline M.f at its call site
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456

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 #-}

457
The top-level AbsBinds for $cround has no tyvars or dicts (because the
458 459 460 461 462 463 464
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

465 466 467 468 469
        AbsBinds [a,b] [ ([a,b], fg, fl, _),
                         ([b],   gg, gl, _) ]
                { fl = e1
                  gl = e2
                   h = e3 }
470 471 472

and desugar it to

473 474 475
        fg = /\ab. let B in e1
        gg = /\b. let a = () in let B in S(e2)
        h  = /\ab. let B in e3
476 477

where B is the *non-recursive* binding
478 479 480
        fl = fg a b
        gl = gg b
        h  = h a b    -- See (b); note shadowing!
481 482

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

486 487 488 489
         (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.
490

491 492 493 494
         (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.
495 496

Why got to this trouble?  It's a common case, and it removes the
497
quadratic-sized tuple desugaring.  Less clutter, hopefully faster
498 499 500 501
compilation, especially in a case where there are a *lot* of
bindings.


502 503 504 505 506 507 508 509
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
510
happen as a result of method sharing), there's a danger that we never
511 512 513 514
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
515
has the arity with which it is declared in the source code.  In this
516
example it has arity 2 (one for the Eq and one for x). Doing this
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
517
should mean that (foo d) is a PAP and we don't share it.
518 519 520

Note [Nested arities]
~~~~~~~~~~~~~~~~~~~~~
521 522 523 524 525 526 527 528 529 530 531 532 533 534
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!
535 536 537 538


Note [Desugar Strict binds]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
539
See https://ghc.haskell.org/trac/ghc/wiki/StrictPragma
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591

Desugaring strict variable bindings looks as follows (core below ==>)

  let !x = rhs
  in  body
==>
  let x = rhs
  in x `seq` body -- seq the variable

and if it is a pattern binding the desugaring looks like

  let !pat = rhs
  in body
==>
  let x = rhs -- bind the rhs to a new variable
      pat = x
  in x `seq` body -- seq the new variable

if there is no variable in the pattern desugaring looks like

  let False = rhs
  in body
==>
  let x = case rhs of {False -> (); _ -> error "Match failed"}
  in x `seq` body

In order to force the Ids in the binding group they are passed around
in the dsHsBind family of functions, and later seq'ed in DsExpr.ds_val_bind.

Consider a recursive group like this

  letrec
     f : g = rhs[f,g]
  in <body>

Without `Strict`, we get a translation like this:

  let t = /\a. letrec tm = rhs[fm,gm]
                      fm = case t of fm:_ -> fm
                      gm = case t of _:gm -> gm
                in
                (fm,gm)

  in let f = /\a. case t a of (fm,_) -> fm
  in let g = /\a. case t a of (_,gm) -> gm
  in <body>

Here `tm` is the monomorphic binding for `rhs`.

With `Strict`, we want to force `tm`, but NOT `fm` or `gm`.
Alas, `tm` isn't in scope in the `in <body>` part.

Gabor Greif's avatar
Gabor Greif committed
592
The simplest thing is to return it in the polymorphic
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
tuple `t`, thus:

  let t = /\a. letrec tm = rhs[fm,gm]
                      fm = case t of fm:_ -> fm
                      gm = case t of _:gm -> gm
                in
                (tm, fm, gm)

  in let f = /\a. case t a of (_,fm,_) -> fm
  in let g = /\a. case t a of (_,_,gm) -> gm
  in let tm = /\a. case t a of (tm,_,_) -> tm
  in tm `seq` <body>


See https://ghc.haskell.org/trac/ghc/wiki/StrictPragma for a more
detailed explanation of the desugaring of strict bindings.

Richard Eisenberg's avatar
Richard Eisenberg committed
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 639 640 641
Note [Strict binds checks]
~~~~~~~~~~~~~~~~~~~~~~~~~~
There are several checks around properly formed strict bindings. They
all link to this Note. These checks must be here in the desugarer because
we cannot know whether or not a type is unlifted until after zonking, due
to levity polymorphism. These checks all used to be handled in the typechecker
in checkStrictBinds (before Jan '17).

We define an "unlifted bind" to be any bind that binds an unlifted id. Note that

  x :: Char
  (# True, x #) = blah

is *not* an unlifted bind. Unlifted binds are detected by HsUtils.isUnliftedHsBind.

Define a "banged bind" to have a top-level bang. Detected by HsPat.isBangedPatBind.
Define a "strict bind" to be either an unlifted bind or a banged bind.

The restrictions are:
  1. Strict binds may not be top-level. Checked in dsTopLHsBinds.

  2. Unlifted binds must also be banged. (There is no trouble to compile an unbanged
     unlifted bind, but an unbanged bind looks lazy, and we don't want users to be
     surprised by the strictness of an unlifted bind.) Checked in first clause
     of DsExpr.ds_val_bind.

  3. Unlifted binds may not have polymorphism (#6078). (That is, no quantified type
     variables or constraints.) Checked in first clause
     of DsExpr.ds_val_bind.

  4. Unlifted binds may not be recursive. Checked in second clause of ds_val_bind.

Austin Seipp's avatar
Austin Seipp committed
642
-}
643

644
------------------------
645
dsSpecs :: CoreExpr     -- Its rhs
646
        -> TcSpecPrags
647 648
        -> DsM ( OrdList (Id,CoreExpr)  -- Binding for specialised Ids
               , [CoreRule] )           -- Rules for the Global Ids
649
-- See Note [Handling SPECIALISE pragmas] in TcBinds
650 651 652 653 654 655
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) }

656 657 658
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
659 660 661
       -> Located TcSpecPrag
       -> DsM (Maybe (OrdList (Id,CoreExpr), CoreRule))
dsSpec mb_poly_rhs (L loc (SpecPrag poly_id spec_co spec_inl))
662
  | isJust (isClassOpId_maybe poly_id)
663
  = putSrcSpanDs loc $
664 665
    do { warnDs NoReason (text "Ignoring useless SPECIALISE pragma for class method selector"
                          <+> quotes (ppr poly_id))
666
       ; return Nothing  }  -- There is no point in trying to specialise a class op
667 668
                            -- Moreover, classops don't (currently) have an inl_sat arity set
                            -- (it would be Just 0) and that in turn makes makeCorePair bleat
669

670 671
  | no_act_spec && isNeverActive rule_act
  = putSrcSpanDs loc $
672 673
    do { warnDs NoReason (text "Ignoring useless SPECIALISE pragma for NOINLINE function:"
                          <+> quotes (ppr poly_id))
674
       ; return Nothing  }  -- Function is NOINLINE, and the specialiation inherits that
675
                            -- See Note [Activation pragmas for SPECIALISE]
676

677
  | otherwise
678
  = putSrcSpanDs loc $
679 680
    do { uniq <- newUnique
       ; let poly_name = idName poly_id
681 682
             spec_occ  = mkSpecOcc (getOccName poly_name)
             spec_name = mkInternalName uniq spec_occ (getSrcSpan poly_name)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
683 684 685 686 687 688 689 690 691 692
             (spec_bndrs, spec_app) = collectHsWrapBinders spec_co
               -- spec_co looks like
               --         \spec_bndrs. [] spec_args
               -- perhaps with the body of the lambda wrapped in some WpLets
               -- E.g. /\a \(d:Eq a). let d2 = $df d in [] (Maybe a) d2

       ; core_app <- dsHsWrapper spec_app

       ; let ds_lhs  = core_app (Var poly_id)
             spec_ty = mkLamTypes spec_bndrs (exprType ds_lhs)
693 694 695
       ; -- pprTrace "dsRule" (vcat [ text "Id:" <+> ppr poly_id
         --                         , text "spec_co:" <+> ppr spec_co
         --                         , text "ds_rhs:" <+> ppr ds_lhs ]) $
Simon Peyton Jones's avatar
Simon Peyton Jones committed
696
         case decomposeRuleLhs spec_bndrs ds_lhs of {
697
           Left msg -> do { warnDs NoReason msg; return Nothing } ;
698
           Right (rule_bndrs, _fn, args) -> do
699

700
       { dflags <- getDynFlags
701
       ; this_mod <- getModule
Simon Peyton Jones's avatar
Simon Peyton Jones committed
702
       ; let fn_unf    = realIdUnfolding poly_id
Simon Peyton Jones's avatar
Simon Peyton Jones committed
703
             spec_unf  = specUnfolding spec_bndrs core_app arity_decrease fn_unf
704 705 706
             spec_id   = mkLocalId spec_name spec_ty
                            `setInlinePragma` inl_prag
                            `setIdUnfolding`  spec_unf
Simon Peyton Jones's avatar
Simon Peyton Jones committed
707 708
             arity_decrease = count isValArg args - count isId spec_bndrs

709
       ; rule <- dsMkUserRule this_mod is_local_id
Ian Lynagh's avatar
Ian Lynagh committed
710
                        (mkFastString ("SPEC " ++ showPpr dflags poly_name))
711 712
                        rule_act poly_name
                        rule_bndrs args
Simon Peyton Jones's avatar
Simon Peyton Jones committed
713
                        (mkVarApps (Var spec_id) spec_bndrs)
714

Simon Peyton Jones's avatar
Simon Peyton Jones committed
715
       ; let spec_rhs = mkLams spec_bndrs (core_app poly_rhs)
716

717 718
-- Commented out: see Note [SPECIALISE on INLINE functions]
--       ; when (isInlinePragma id_inl)
719
--              (warnDs $ text "SPECIALISE pragma on INLINE function probably won't fire:"
720
--                        <+> quotes (ppr poly_name))
Simon Peyton Jones's avatar
Simon Peyton Jones committed
721 722 723 724 725

       ; 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
726 727 728 729
       } } }
  where
    is_local_id = isJust mb_poly_rhs
    poly_rhs | Just rhs <-  mb_poly_rhs
730
             = rhs          -- Local Id; this is its rhs
731 732
             | Just unfolding <- maybeUnfoldingTemplate (realIdUnfolding poly_id)
             = unfolding    -- Imported Id; this is its unfolding
733 734 735
                            -- Use realIdUnfolding so we get the unfolding
                            -- even when it is a loop breaker.
                            -- We want to specialise recursive functions!
736
             | otherwise = pprPanic "dsImpSpecs" (ppr poly_id)
737
                            -- The type checker has checked that it *has* an unfolding
738

739 740 741 742 743
    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]
744
                                 -- in OccurAnal
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
             , 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


762 763 764 765 766 767
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) $
768
        warnDs (Reason Opt_WarnOrphans) (ruleOrphWarn rule)
769 770 771
    return rule

ruleOrphWarn :: CoreRule -> SDoc
772
ruleOrphWarn rule = text "Orphan rule:" <+> ppr rule
773

774 775 776 777 778 779 780 781 782 783 784 785 786
{- 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.

787 788 789 790 791 792 793 794
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:

795
* spec_fn's inline pragma: inherited from f's inline pragma (ignoring
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
                           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
817
SPEC [n] f :: ty            [n]   INLINE [k]
818 819 820 821 822 823 824 825 826 827
                                  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
828 829
************************************************************************
*                                                                      *
830
\subsection{Adding inline pragmas}
Austin Seipp's avatar
Austin Seipp committed
831 832 833
*                                                                      *
************************************************************************
-}
834

835
decomposeRuleLhs :: [Var] -> CoreExpr -> Either SDoc ([Var], Id, [CoreExpr])
unknown's avatar
unknown committed
836 837
-- (decomposeRuleLhs bndrs lhs) takes apart the LHS of a RULE,
-- The 'bndrs' are the quantified binders of the rules, but decomposeRuleLhs
838
-- may add some extra dictionary binders (see Note [Free dictionaries])
unknown's avatar
unknown committed
839
--
840
-- Returns an error message if the LHS isn't of the expected shape
841 842 843 844 845
-- 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))
846 847 848
  | Var funId <- fun2
  , Just con <- isDataConId_maybe funId
  = Left (constructor_msg con) -- See Note [No RULES on datacons]
849
  | Just (fn_id, args) <- decompose fun2 args2
850
  , let extra_bndrs = mk_extra_bndrs fn_id args
851 852 853 854 855 856
  = -- pprTrace "decmposeRuleLhs" (vcat [ text "orig_bndrs:" <+> ppr orig_bndrs
    --                                  , text "orig_lhs:" <+> ppr orig_lhs
    --                                  , text "lhs1:"     <+> ppr lhs1
    --                                  , text "extra_dict_bndrs:" <+> ppr extra_dict_bndrs
    --                                  , text "fn_id:" <+> ppr fn_id
    --                                  , text "args:"   <+> ppr args]) $
857
    Right (orig_bndrs ++ extra_bndrs, fn_id, args)
858

859
  | otherwise
860
  = Left bad_shape_msg
861
 where
862 863 864 865
   lhs1         = drop_dicts orig_lhs
   lhs2         = simpleOptExpr lhs1  -- See Note [Simplify rule LHS]
   (fun2,args2) = collectArgs lhs2

866 867
   lhs_fvs    = exprFreeVars lhs2
   unbound    = filterOut (`elemVarSet` lhs_fvs) orig_bndrs
868

869
   orig_bndr_set = mkVarSet orig_bndrs
870

871 872 873 874 875 876 877 878 879 880 881 882 883
        -- Add extra tyvar binders: Note [Free tyvars in rule LHS]
        -- and extra dict binders: Note [Free dictionaries in rule LHS]
   mk_extra_bndrs fn_id args
     = toposortTyVars unbound_tvs ++ unbound_dicts
     where
       unbound_tvs   = [ v | v <- unbound_vars, isTyVar v ]
       unbound_dicts = [ mkLocalId (localiseName (idName d)) (idType d)
                       | d <- unbound_vars, isDictId d ]
       unbound_vars  = [ v | v <- exprsFreeVarsList args
                           , not (v `elemVarSet` orig_bndr_set)
                           , not (v == fn_id) ]
         -- fn_id: do not quantify over the function itself, which may
         -- itself be a dictionary (in pathological cases, Trac #10251)
884 885 886 887 888 889

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

   decompose _ _ = Nothing
890

891
   bad_shape_msg = hang (text "RULE left-hand side too complicated to desugar")
892 893
                      2 (vcat [ text "Optimised lhs:" <+> ppr lhs2
                              , text "Orig lhs:" <+> ppr orig_lhs])
894 895
   dead_msg bndr = hang (sep [ text "Forall'd" <+> pp_bndr bndr
                             , text "is not bound in RULE lhs"])
896 897 898
                      2 (vcat [ text "Orig bndrs:" <+> ppr orig_bndrs
                              , text "Orig lhs:" <+> ppr orig_lhs
                              , text "optimised lhs:" <+> ppr lhs2 ])
899
   pp_bndr bndr
900 901 902
    | isTyVar bndr                      = text "type variable" <+> quotes (ppr bndr)
    | Just pred <- evVarPred_maybe bndr = text "constraint" <+> quotes (ppr pred)
    | otherwise                         = text "variable" <+> quotes (ppr bndr)
903

904 905 906 907 908
   constructor_msg con = vcat
     [ text "A constructor," <+> ppr con <>
         text ", appears as outermost match in RULE lhs."
     , text "This rule will be ignored." ]

909
   drop_dicts :: CoreExpr -> CoreExpr
910
   drop_dicts e
911 912 913
       = wrap_lets needed bnds body
     where
       needed = orig_bndr_set `minusVarSet` exprFreeVars body
914
       (bnds, body) = split_lets (occurAnalyseExpr e)
915
           -- The occurAnalyseExpr drops dead bindings which is
916 917
           -- crucial to ensure that every binding is used later;
           -- which in turn makes wrap_lets work right
918 919

   split_lets :: CoreExpr -> ([(DictId,CoreExpr)], CoreExpr)
920 921
   split_lets (Let (NonRec d r) body)
     | isDictId d
922
     = ((d,r):bs, body')
923 924 925 926 927 928 929 930 931
     where (bs, body') = split_lets body

    -- handle "unlifted lets" too, needed for "map/coerce"
   split_lets (Case r d _ [(DEFAULT, _, body)])
     | isCoVar d
     = ((d,r):bs, body')
     where (bs, body') = split_lets body

   split_lets e = ([], e)
932 933 934 935

   wrap_lets :: VarSet -> [(DictId,CoreExpr)] -> CoreExpr -> CoreExpr
   wrap_lets _ [] body = body
   wrap_lets needed ((d, r) : bs) body
936
     | rhs_fvs `intersectsVarSet` needed = mkCoreLet (NonRec d r) (wrap_lets needed' bs body)
937 938 939 940
     | otherwise                         = wrap_lets needed bs body
     where
       rhs_fvs = exprFreeVars r
       needed' = (needed `minusVarSet` rhs_fvs) `extendVarSet` d
941

Austin Seipp's avatar
Austin Seipp committed
942
{-
943
Note [Decomposing the left-hand side of a RULE]
944
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
945
There are several things going on here.
946 947
* drop_dicts: see Note [Drop dictionary bindings on rule LHS]
* simpleOptExpr: see Note [Simplify rule LHS]
948
* extra_dict_bndrs: see Note [Free dictionaries]
949

950 951 952 953 954 955 956 957 958 959 960 961 962
Note [Free tyvars on rule LHS]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
  data T a = C

  foo :: T a -> Int
  foo C = 1

  {-# RULES "myrule"  foo C = 1 #-}

After type checking the LHS becomes (foo alpha (C alpha)), where alpha
is an unbound meta-tyvar.  The zonker in TcHsSyn is careful not to
turn the free alpha into Any (as it usually does).  Instead it turns it
963
into a TyVar 'a'.  See TcHsSyn Note [Zonking the LHS of a RULE].
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997

Now we must quantify over that 'a'.  It's /really/ inconvenient to do that
in the zonker, because the HsExpr data type is very large.  But it's /easy/
to do it here in the desugarer.

Moreover, we have to do something rather similar for dictionaries;
see Note [Free dictionaries on rule LHS].   So that's why we look for
type variables free on the LHS, and quantify over them.

Note [Free dictionaries on rule LHS]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
over it too.  *Any* dict with that type will do.

So for example when you have
        f :: Eq a => a -> a
        f = <rhs>
        ... SPECIALISE f :: Int -> Int ...

Then we get the SpecPrag
        SpecPrag (f Int dInt)

And from that we want the rule

        RULE forall dInt. f Int dInt = f_spec
        f_spec = let f = <rhs> in f Int dInt

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.

Simon Peyton Jones's avatar