ghc/compiler/specialise/Specialise.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section[Specialise]{Stamping out overloading, and (optionally) polymorphism}
   5
   6 \begin{code}
   7 module Specialise ( specProgram ) where
   8
   9 #include "HsVersions.h"
  10
  11 import CmdLineOpts      ( opt_D_verbose_core2core, opt_D_dump_spec, opt_D_dump_rules )
  12 import Id               ( Id, idName, idType, mkTemplateLocals, mkUserLocal,
  13                           idSpecialisation, setIdNoDiscard, isExportedId,
  14                           modifyIdInfo, idUnfolding
  15                         )
  16 import IdInfo           ( zapSpecPragInfo )
  17 import VarSet
  18 import VarEnv
  19
  20 import Type             ( Type, mkTyVarTy, splitSigmaTy, splitFunTysN,
  21                           tyVarsOfType, tyVarsOfTypes, tyVarsOfTheta, applyTys,
  22                           mkForAllTys, boxedTypeKind
  23                         )
  24 import PprType          ( {- instance Outputable Type -} )
  25 import Subst            ( Subst, mkSubst, substTy, mkSubst, substBndrs, extendSubstList,
  26                           substId, substAndCloneId, substAndCloneIds, lookupIdSubst, substInScope
  27                         )
  28 import Var              ( TyVar, mkSysTyVar, setVarUnique )
  29 import VarSet
  30 import VarEnv
  31 import CoreSyn
  32 import CoreUtils        ( applyTypeToArgs )
  33 import CoreUnfold       ( certainlyWillInline )
  34 import CoreFVs          ( exprFreeVars, exprsFreeVars )
  35 import CoreLint         ( beginPass, endPass )
  36 import PprCore          ( pprCoreRules )
  37 import Rules            ( addIdSpecialisations, lookupRule )
  38
  39 import UniqSupply       ( UniqSupply,
  40                           UniqSM, initUs_, thenUs, thenUs_, returnUs, getUniqueUs,
  41                           getUs, setUs, uniqFromSupply, splitUniqSupply, mapUs
  42                         )
  43 import Name             ( nameOccName, mkSpecOcc, getSrcLoc )
  44 import FiniteMap
  45 import Maybes           ( MaybeErr(..), catMaybes, maybeToBool )
  46 import ErrUtils         ( dumpIfSet )
  47 import Bag
  48 import List             ( partition )
  49 import Util             ( zipEqual, zipWithEqual, mapAccumL )
  50 import Outputable
  51
  52
  53 infixr 9 `thenSM`
  54 \end{code}
  55
  56 %************************************************************************
  57 %*                                                                      *
  58 \subsection[notes-Specialise]{Implementation notes [SLPJ, Aug 18 1993]}
  59 %*                                                                      *
  60 %************************************************************************
  61
  62 These notes describe how we implement specialisation to eliminate
  63 overloading.
  64
  65 The specialisation pass works on Core
  66 syntax, complete with all the explicit dictionary application,
  67 abstraction and construction as added by the type checker.  The
  68 existing type checker remains largely as it is.
  69
  70 One important thought: the {\em types} passed to an overloaded
  71 function, and the {\em dictionaries} passed are mutually redundant.
  72 If the same function is applied to the same type(s) then it is sure to
  73 be applied to the same dictionary(s)---or rather to the same {\em
  74 values}.  (The arguments might look different but they will evaluate
  75 to the same value.)
  76
  77 Second important thought: we know that we can make progress by
  78 treating dictionary arguments as static and worth specialising on.  So
  79 we can do without binding-time analysis, and instead specialise on
  80 dictionary arguments and no others.
  81
  82 The basic idea
  83 ~~~~~~~~~~~~~~
  84 Suppose we have
  85
  86         let f = <f_rhs>
  87         in <body>
  88
  89 and suppose f is overloaded.
  90
  91 STEP 1: CALL-INSTANCE COLLECTION
  92
  93 We traverse <body>, accumulating all applications of f to types and
  94 dictionaries.
  95
  96 (Might there be partial applications, to just some of its types and
  97 dictionaries?  In principle yes, but in practice the type checker only
  98 builds applications of f to all its types and dictionaries, so partial
  99 applications could only arise as a result of transformation, and even
 100 then I think it's unlikely.  In any case, we simply don't accumulate such
 101 partial applications.)
 102
 103
 104 STEP 2: EQUIVALENCES
 105
 106 So now we have a collection of calls to f:
 107         f t1 t2 d1 d2
 108         f t3 t4 d3 d4
 109         ...
 110 Notice that f may take several type arguments.  To avoid ambiguity, we
 111 say that f is called at type t1/t2 and t3/t4.
 112
 113 We take equivalence classes using equality of the *types* (ignoring
 114 the dictionary args, which as mentioned previously are redundant).
 115
 116 STEP 3: SPECIALISATION
 117
 118 For each equivalence class, choose a representative (f t1 t2 d1 d2),
 119 and create a local instance of f, defined thus:
 120
 121         f@t1/t2 = <f_rhs> t1 t2 d1 d2
 122
 123 f_rhs presumably has some big lambdas and dictionary lambdas, so lots
 124 of simplification will now result.  However we don't actually *do* that
 125 simplification.  Rather, we leave it for the simplifier to do.  If we
 126 *did* do it, though, we'd get more call instances from the specialised
 127 RHS.  We can work out what they are by instantiating the call-instance
 128 set from f's RHS with the types t1, t2.
 129
 130 Add this new id to f's IdInfo, to record that f has a specialised version.
 131
 132 Before doing any of this, check that f's IdInfo doesn't already
 133 tell us about an existing instance of f at the required type/s.
 134 (This might happen if specialisation was applied more than once, or
 135 it might arise from user SPECIALIZE pragmas.)
 136
 137 Recursion
 138 ~~~~~~~~~
 139 Wait a minute!  What if f is recursive?  Then we can't just plug in
 140 its right-hand side, can we?
 141
 142 But it's ok.  The type checker *always* creates non-recursive definitions
 143 for overloaded recursive functions.  For example:
 144
 145         f x = f (x+x)           -- Yes I know its silly
 146
 147 becomes
 148
 149         f a (d::Num a) = let p = +.sel a d
 150                          in
 151                          letrec fl (y::a) = fl (p y y)
 152                          in
 153                          fl
 154
 155 We still have recusion for non-overloaded functions which we
 156 speciailise, but the recursive call should get specialised to the
 157 same recursive version.
 158
 159
 160 Polymorphism 1
 161 ~~~~~~~~~~~~~~
 162
 163 All this is crystal clear when the function is applied to *constant
 164 types*; that is, types which have no type variables inside.  But what if
 165 it is applied to non-constant types?  Suppose we find a call of f at type
 166 t1/t2.  There are two possibilities:
 167
 168 (a) The free type variables of t1, t2 are in scope at the definition point
 169 of f.  In this case there's no problem, we proceed just as before.  A common
 170 example is as follows.  Here's the Haskell:
 171
 172         g y = let f x = x+x
 173               in f y + f y
 174
 175 After typechecking we have
 176
 177         g a (d::Num a) (y::a) = let f b (d'::Num b) (x::b) = +.sel b d' x x
 178                                 in +.sel a d (f a d y) (f a d y)
 179
 180 Notice that the call to f is at type type "a"; a non-constant type.
 181 Both calls to f are at the same type, so we can specialise to give:
 182
 183         g a (d::Num a) (y::a) = let f@a (x::a) = +.sel a d x x
 184                                 in +.sel a d (f@a y) (f@a y)
 185
 186
 187 (b) The other case is when the type variables in the instance types
 188 are *not* in scope at the definition point of f.  The example we are
 189 working with above is a good case.  There are two instances of (+.sel a d),
 190 but "a" is not in scope at the definition of +.sel.  Can we do anything?
 191 Yes, we can "common them up", a sort of limited common sub-expression deal.
 192 This would give:
 193
 194         g a (d::Num a) (y::a) = let +.sel@a = +.sel a d
 195                                     f@a (x::a) = +.sel@a x x
 196                                 in +.sel@a (f@a y) (f@a y)
 197
 198 This can save work, and can't be spotted by the type checker, because
 199 the two instances of +.sel weren't originally at the same type.
 200
 201 Further notes on (b)
 202
 203 * There are quite a few variations here.  For example, the defn of
 204   +.sel could be floated ouside the \y, to attempt to gain laziness.
 205   It certainly mustn't be floated outside the \d because the d has to
 206   be in scope too.
 207
 208 * We don't want to inline f_rhs in this case, because
 209 that will duplicate code.  Just commoning up the call is the point.
 210
 211 * Nothing gets added to +.sel's IdInfo.
 212
 213 * Don't bother unless the equivalence class has more than one item!
 214
 215 Not clear whether this is all worth it.  It is of course OK to
 216 simply discard call-instances when passing a big lambda.
 217
 218 Polymorphism 2 -- Overloading
 219 ~~~~~~~~~~~~~~
 220 Consider a function whose most general type is
 221
 222         f :: forall a b. Ord a => [a] -> b -> b
 223
 224 There is really no point in making a version of g at Int/Int and another
 225 at Int/Bool, because it's only instancing the type variable "a" which
 226 buys us any efficiency. Since g is completely polymorphic in b there
 227 ain't much point in making separate versions of g for the different
 228 b types.
 229
 230 That suggests that we should identify which of g's type variables
 231 are constrained (like "a") and which are unconstrained (like "b").
 232 Then when taking equivalence classes in STEP 2, we ignore the type args
 233 corresponding to unconstrained type variable.  In STEP 3 we make
 234 polymorphic versions.  Thus:
 235
 236         f@t1/ = /\b -> <f_rhs> t1 b d1 d2
 237
 238 We do this.
 239
 240
 241 Dictionary floating
 242 ~~~~~~~~~~~~~~~~~~~
 243 Consider this
 244
 245         f a (d::Num a) = let g = ...
 246                          in
 247                          ...(let d1::Ord a = Num.Ord.sel a d in g a d1)...
 248
 249 Here, g is only called at one type, but the dictionary isn't in scope at the
 250 definition point for g.  Usually the type checker would build a
 251 definition for d1 which enclosed g, but the transformation system
 252 might have moved d1's defn inward.  Solution: float dictionary bindings
 253 outwards along with call instances.
 254
 255 Consider
 256
 257         f x = let g p q = p==q
 258                   h r s = (r+s, g r s)
 259               in
 260               h x x
 261
 262
 263 Before specialisation, leaving out type abstractions we have
 264
 265         f df x = let g :: Eq a => a -> a -> Bool
 266                      g dg p q = == dg p q
 267                      h :: Num a => a -> a -> (a, Bool)
 268                      h dh r s = let deq = eqFromNum dh
 269                                 in (+ dh r s, g deq r s)
 270               in
 271               h df x x
 272
 273 After specialising h we get a specialised version of h, like this:
 274
 275                     h' r s = let deq = eqFromNum df
 276                              in (+ df r s, g deq r s)
 277
 278 But we can't naively make an instance for g from this, because deq is not in scope
 279 at the defn of g.  Instead, we have to float out the (new) defn of deq
 280 to widen its scope.  Notice that this floating can't be done in advance -- it only
 281 shows up when specialisation is done.
 282
 283 User SPECIALIZE pragmas
 284 ~~~~~~~~~~~~~~~~~~~~~~~
 285 Specialisation pragmas can be digested by the type checker, and implemented
 286 by adding extra definitions along with that of f, in the same way as before
 287
 288         f@t1/t2 = <f_rhs> t1 t2 d1 d2
 289
 290 Indeed the pragmas *have* to be dealt with by the type checker, because
 291 only it knows how to build the dictionaries d1 and d2!  For example
 292
 293         g :: Ord a => [a] -> [a]
 294         {-# SPECIALIZE f :: [Tree Int] -> [Tree Int] #-}
 295
 296 Here, the specialised version of g is an application of g's rhs to the
 297 Ord dictionary for (Tree Int), which only the type checker can conjure
 298 up.  There might not even *be* one, if (Tree Int) is not an instance of
 299 Ord!  (All the other specialision has suitable dictionaries to hand
 300 from actual calls.)
 301
 302 Problem.  The type checker doesn't have to hand a convenient <f_rhs>, because
 303 it is buried in a complex (as-yet-un-desugared) binding group.
 304 Maybe we should say
 305
 306         f@t1/t2 = f* t1 t2 d1 d2
 307
 308 where f* is the Id f with an IdInfo which says "inline me regardless!".
 309 Indeed all the specialisation could be done in this way.
 310 That in turn means that the simplifier has to be prepared to inline absolutely
 311 any in-scope let-bound thing.
 312
 313
 314 Again, the pragma should permit polymorphism in unconstrained variables:
 315
 316         h :: Ord a => [a] -> b -> b
 317         {-# SPECIALIZE h :: [Int] -> b -> b #-}
 318
 319 We *insist* that all overloaded type variables are specialised to ground types,
 320 (and hence there can be no context inside a SPECIALIZE pragma).
 321 We *permit* unconstrained type variables to be specialised to
 322         - a ground type
 323         - or left as a polymorphic type variable
 324 but nothing in between.  So
 325
 326         {-# SPECIALIZE h :: [Int] -> [c] -> [c] #-}
 327
 328 is *illegal*.  (It can be handled, but it adds complication, and gains the
 329 programmer nothing.)
 330
 331
 332 SPECIALISING INSTANCE DECLARATIONS
 333 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 334 Consider
 335
 336         instance Foo a => Foo [a] where
 337                 ...
 338         {-# SPECIALIZE instance Foo [Int] #-}
 339
 340 The original instance decl creates a dictionary-function
 341 definition:
 342
 343         dfun.Foo.List :: forall a. Foo a -> Foo [a]
 344
 345 The SPECIALIZE pragma just makes a specialised copy, just as for
 346 ordinary function definitions:
 347
 348         dfun.Foo.List@Int :: Foo [Int]
 349         dfun.Foo.List@Int = dfun.Foo.List Int dFooInt
 350
 351 The information about what instance of the dfun exist gets added to
 352 the dfun's IdInfo in the same way as a user-defined function too.
 353
 354
 355 Automatic instance decl specialisation?
 356 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 357 Can instance decls be specialised automatically?  It's tricky.
 358 We could collect call-instance information for each dfun, but
 359 then when we specialised their bodies we'd get new call-instances
 360 for ordinary functions; and when we specialised their bodies, we might get
 361 new call-instances of the dfuns, and so on.  This all arises because of
 362 the unrestricted mutual recursion between instance decls and value decls.
 363
 364 Still, there's no actual problem; it just means that we may not do all
 365 the specialisation we could theoretically do.
 366
 367 Furthermore, instance decls are usually exported and used non-locally,
 368 so we'll want to compile enough to get those specialisations done.
 369
 370 Lastly, there's no such thing as a local instance decl, so we can
 371 survive solely by spitting out *usage* information, and then reading that
 372 back in as a pragma when next compiling the file.  So for now,
 373 we only specialise instance decls in response to pragmas.
 374
 375
 376 SPITTING OUT USAGE INFORMATION
 377 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 378
 379 To spit out usage information we need to traverse the code collecting
 380 call-instance information for all imported (non-prelude?) functions
 381 and data types. Then we equivalence-class it and spit it out.
 382
 383 This is done at the top-level when all the call instances which escape
 384 must be for imported functions and data types.
 385
 386 *** Not currently done ***
 387
 388
 389 Partial specialisation by pragmas
 390 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 391 What about partial specialisation:
 392
 393         k :: (Ord a, Eq b) => [a] -> b -> b -> [a]
 394         {-# SPECIALIZE k :: Eq b => [Int] -> b -> b -> [a] #-}
 395
 396 or even
 397
 398         {-# SPECIALIZE k :: Eq b => [Int] -> [b] -> [b] -> [a] #-}
 399
 400 Seems quite reasonable.  Similar things could be done with instance decls:
 401
 402         instance (Foo a, Foo b) => Foo (a,b) where
 403                 ...
 404         {-# SPECIALIZE instance Foo a => Foo (a,Int) #-}
 405         {-# SPECIALIZE instance Foo b => Foo (Int,b) #-}
 406
 407 Ho hum.  Things are complex enough without this.  I pass.
 408
 409
 410 Requirements for the simplifer
 411 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 412 The simplifier has to be able to take advantage of the specialisation.
 413
 414 * When the simplifier finds an application of a polymorphic f, it looks in
 415 f's IdInfo in case there is a suitable instance to call instead.  This converts
 416
 417         f t1 t2 d1 d2   ===>   f_t1_t2
 418
 419 Note that the dictionaries get eaten up too!
 420
 421 * Dictionary selection operations on constant dictionaries must be
 422   short-circuited:
 423
 424         +.sel Int d     ===>  +Int
 425
 426 The obvious way to do this is in the same way as other specialised
 427 calls: +.sel has inside it some IdInfo which tells that if it's applied
 428 to the type Int then it should eat a dictionary and transform to +Int.
 429
 430 In short, dictionary selectors need IdInfo inside them for constant
 431 methods.
 432
 433 * Exactly the same applies if a superclass dictionary is being
 434   extracted:
 435
 436         Eq.sel Int d   ===>   dEqInt
 437
 438 * Something similar applies to dictionary construction too.  Suppose
 439 dfun.Eq.List is the function taking a dictionary for (Eq a) to
 440 one for (Eq [a]).  Then we want
 441
 442         dfun.Eq.List Int d      ===> dEq.List_Int
 443
 444 Where does the Eq [Int] dictionary come from?  It is built in
 445 response to a SPECIALIZE pragma on the Eq [a] instance decl.
 446
 447 In short, dfun Ids need IdInfo with a specialisation for each
 448 constant instance of their instance declaration.
 449
 450 All this uses a single mechanism: the SpecEnv inside an Id
 451
 452
 453 What does the specialisation IdInfo look like?
 454 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 455
 456 The SpecEnv of an Id maps a list of types (the template) to an expression
 457
 458         [Type]  |->  Expr
 459
 460 For example, if f has this SpecInfo:
 461
 462         [Int, a]  ->  \d:Ord Int. f' a
 463
 464 it means that we can replace the call
 465
 466         f Int t  ===>  (\d. f' t)
 467
 468 This chucks one dictionary away and proceeds with the
 469 specialised version of f, namely f'.
 470
 471
 472 What can't be done this way?
 473 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 474 There is no way, post-typechecker, to get a dictionary for (say)
 475 Eq a from a dictionary for Eq [a].  So if we find
 476
 477         ==.sel [t] d
 478
 479 we can't transform to
 480
 481         eqList (==.sel t d')
 482
 483 where
 484         eqList :: (a->a->Bool) -> [a] -> [a] -> Bool
 485
 486 Of course, we currently have no way to automatically derive
 487 eqList, nor to connect it to the Eq [a] instance decl, but you
 488 can imagine that it might somehow be possible.  Taking advantage
 489 of this is permanently ruled out.
 490
 491 Still, this is no great hardship, because we intend to eliminate
 492 overloading altogether anyway!
 493
 494
 495
 496 A note about non-tyvar dictionaries
 497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 498 Some Ids have types like
 499
 500         forall a,b,c. Eq a -> Ord [a] -> tau
 501
 502 This seems curious at first, because we usually only have dictionary
 503 args whose types are of the form (C a) where a is a type variable.
 504 But this doesn't hold for the functions arising from instance decls,
 505 which sometimes get arguements with types of form (C (T a)) for some
 506 type constructor T.
 507
 508 Should we specialise wrt this compound-type dictionary?  We used to say
 509 "no", saying:
 510         "This is a heuristic judgement, as indeed is the fact that we
 511         specialise wrt only dictionaries.  We choose *not* to specialise
 512         wrt compound dictionaries because at the moment the only place
 513         they show up is in instance decls, where they are simply plugged
 514         into a returned dictionary.  So nothing is gained by specialising
 515         wrt them."
 516
 517 But it is simpler and more uniform to specialise wrt these dicts too;
 518 and in future GHC is likely to support full fledged type signatures
 519 like
 520         f ;: Eq [(a,b)] => ...
 521
 522
 523 %************************************************************************
 524 %*                                                                      *
 525 \subsubsection{The new specialiser}
 526 %*                                                                      *
 527 %************************************************************************
 528
 529 Our basic game plan is this.  For let(rec) bound function
 530         f :: (C a, D c) => (a,b,c,d) -> Bool
 531
 532 * Find any specialised calls of f, (f ts ds), where
 533   ts are the type arguments t1 .. t4, and
 534   ds are the dictionary arguments d1 .. d2.
 535
 536 * Add a new definition for f1 (say):
 537
 538         f1 = /\ b d -> (..body of f..) t1 b t3 d d1 d2
 539
 540   Note that we abstract over the unconstrained type arguments.
 541
 542 * Add the mapping
 543
 544         [t1,b,t3,d]  |->  \d1 d2 -> f1 b d
 545
 546   to the specialisations of f.  This will be used by the
 547   simplifier to replace calls
 548                 (f t1 t2 t3 t4) da db
 549   by
 550                 (\d1 d1 -> f1 t2 t4) da db
 551
 552   All the stuff about how many dictionaries to discard, and what types
 553   to apply the specialised function to, are handled by the fact that the
 554   SpecEnv contains a template for the result of the specialisation.
 555
 556 We don't build *partial* specialisations for f.  For example:
 557
 558   f :: Eq a => a -> a -> Bool
 559   {-# SPECIALISE f :: (Eq b, Eq c) => (b,c) -> (b,c) -> Bool #-}
 560
 561 Here, little is gained by making a specialised copy of f.
 562 There's a distinct danger that the specialised version would
 563 first build a dictionary for (Eq b, Eq c), and then select the (==)
 564 method from it!  Even if it didn't, not a great deal is saved.
 565
 566 We do, however, generate polymorphic, but not overloaded, specialisations:
 567
 568   f :: Eq a => [a] -> b -> b -> b
 569   {#- SPECIALISE f :: [Int] -> b -> b -> b #-}
 570
 571 Hence, the invariant is this:
 572
 573         *** no specialised version is overloaded ***
 574
 575
 576 %************************************************************************
 577 %*                                                                      *
 578 \subsubsection{The exported function}
 579 %*                                                                      *
 580 %************************************************************************
 581
 582 \begin{code}
 583 specProgram :: UniqSupply -> [CoreBind] -> IO [CoreBind]
 584 specProgram us binds
 585   = do
 586         beginPass "Specialise"
 587
 588         let binds' = initSM us (go binds        `thenSM` \ (binds', uds') ->
 589                                 returnSM (dumpAllDictBinds uds' binds'))
 590
 591         endPass "Specialise" (opt_D_dump_spec || opt_D_verbose_core2core) binds'
 592
 593         dumpIfSet opt_D_dump_rules "Top-level specialisations"
 594                   (vcat (map dump_specs (concat (map bindersOf binds'))))
 595
 596         return binds'
 597   where
 598         -- We need to start with a Subst that knows all the things
 599         -- that are in scope, so that the substitution engine doesn't
 600         -- accidentally re-use a unique that's already in use
 601         -- Easiest thing is to do it all at once, as if all the top-level
 602         -- decls were mutually recursive
 603     top_subst       = mkSubst (mkVarSet (bindersOfBinds binds)) emptySubstEnv
 604
 605     go []           = returnSM ([], emptyUDs)
 606     go (bind:binds) = go binds                          `thenSM` \ (binds', uds) ->
 607                       specBind top_subst bind uds       `thenSM` \ (bind', uds') ->
 608                       returnSM (bind' ++ binds', uds')
 609
 610 dump_specs var = pprCoreRules var (idSpecialisation var)
 611 \end{code}
 612
 613 %************************************************************************
 614 %*                                                                      *
 615 \subsubsection{@specExpr@: the main function}
 616 %*                                                                      *
 617 %************************************************************************
 618
 619 \begin{code}
 620 specVar :: Subst -> Id -> CoreExpr
 621 specVar subst v = case lookupIdSubst subst v of
 622                         DoneEx e   -> e
 623                         DoneId v _ -> Var v
 624
 625 specExpr :: Subst -> CoreExpr -> SpecM (CoreExpr, UsageDetails)
 626 -- We carry a substitution down:
 627 --      a) we must clone any binding that might flaot outwards,
 628 --         to avoid name clashes
 629 --      b) we carry a type substitution to use when analysing
 630 --         the RHS of specialised bindings (no type-let!)
 631
 632 ---------------- First the easy cases --------------------
 633 specExpr subst (Type ty) = returnSM (Type (substTy subst ty), emptyUDs)
 634 specExpr subst (Var v)   = returnSM (specVar subst v,         emptyUDs)
 635 specExpr subst (Lit lit) = returnSM (Lit lit,                 emptyUDs)
 636
 637 specExpr subst (Note note body)
 638   = specExpr subst body         `thenSM` \ (body', uds) ->
 639     returnSM (Note (specNote subst note) body', uds)
 640
 641
 642 ---------------- Applications might generate a call instance --------------------
 643 specExpr subst expr@(App fun arg)
 644   = go expr []
 645   where
 646     go (App fun arg) args = specExpr subst arg  `thenSM` \ (arg', uds_arg) ->
 647                             go fun (arg':args)  `thenSM` \ (fun', uds_app) ->
 648                             returnSM (App fun' arg', uds_arg `plusUDs` uds_app)
 649
 650     go (Var f)       args = case specVar subst f of
 651                                 Var f' -> returnSM (Var f', mkCallUDs subst f' args)
 652                                 e'     -> returnSM (e', emptyUDs)       -- I don't expect this!
 653     go other         args = specExpr subst other
 654
 655 ---------------- Lambda/case require dumping of usage details --------------------
 656 specExpr subst e@(Lam _ _)
 657   = specExpr subst' body        `thenSM` \ (body', uds) ->
 658     let
 659         (filtered_uds, body'') = dumpUDs bndrs' uds body'
 660     in
 661     returnSM (mkLams bndrs' body'', filtered_uds)
 662   where
 663     (bndrs, body) = collectBinders e
 664     (subst', bndrs') = substBndrs subst bndrs
 665         -- More efficient to collect a group of binders together all at once
 666         -- and we don't want to split a lambda group with dumped bindings
 667
 668 specExpr subst (Case scrut case_bndr alts)
 669   = specExpr subst scrut                        `thenSM` \ (scrut', uds_scrut) ->
 670     mapAndCombineSM spec_alt alts       `thenSM` \ (alts', uds_alts) ->
 671     returnSM (Case scrut' case_bndr' alts', uds_scrut `plusUDs` uds_alts)
 672   where
 673     (subst_alt, case_bndr') = substId subst case_bndr
 674         -- No need to clone case binder; it can't float like a let(rec)
 675
 676     spec_alt (con, args, rhs)
 677         = specExpr subst_rhs rhs                `thenSM` \ (rhs', uds) ->
 678           let
 679              (uds', rhs'') = dumpUDs args uds rhs'
 680           in
 681           returnSM ((con, args', rhs''), uds')
 682         where
 683           (subst_rhs, args') = substBndrs subst_alt args
 684
 685 ---------------- Finally, let is the interesting case --------------------
 686 specExpr subst (Let bind body)
 687   =     -- Clone binders
 688     cloneBindSM subst bind                      `thenSM` \ (rhs_subst, body_subst, bind') ->
 689
 690         -- Deal with the body
 691     specExpr body_subst body                    `thenSM` \ (body', body_uds) ->
 692
 693         -- Deal with the bindings
 694     specBind rhs_subst bind' body_uds           `thenSM` \ (binds', uds) ->
 695
 696         -- All done
 697     returnSM (foldr Let body' binds', uds)
 698
 699 -- Must apply the type substitution to coerceions
 700 specNote subst (Coerce t1 t2) = Coerce (substTy subst t1) (substTy subst t2)
 701 specNote subst note           = note
 702 \end{code}
 703
 704 %************************************************************************
 705 %*                                                                      *
 706 \subsubsection{Dealing with a binding}
 707 %*                                                                      *
 708 %************************************************************************
 709
 710 \begin{code}
 711 specBind :: Subst                       -- Use this for RHSs
 712          -> CoreBind
 713          -> UsageDetails                -- Info on how the scope of the binding
 714          -> SpecM ([CoreBind],          -- New bindings
 715                    UsageDetails)        -- And info to pass upstream
 716
 717 specBind rhs_subst bind body_uds
 718   = specBindItself rhs_subst bind (calls body_uds)      `thenSM` \ (bind', bind_uds) ->
 719     let
 720         bndrs   = bindersOf bind
 721         all_uds = zapCalls bndrs (body_uds `plusUDs` bind_uds)
 722                         -- It's important that the `plusUDs` is this way round,
 723                         -- because body_uds may bind dictionaries that are
 724                         -- used in the calls passed to specDefn.  So the
 725                         -- dictionary bindings in bind_uds may mention
 726                         -- dictionaries bound in body_uds.
 727     in
 728     case splitUDs bndrs all_uds of
 729
 730         (_, ([],[]))    -- This binding doesn't bind anything needed
 731                         -- in the UDs, so put the binding here
 732                         -- This is the case for most non-dict bindings, except
 733                         -- for the few that are mentioned in a dict binding
 734                         -- that is floating upwards in body_uds
 735                 -> returnSM ([bind'], all_uds)
 736
 737         (float_uds, (dict_binds, calls))        -- This binding is needed in the UDs, so float it out
 738                 -> returnSM ([], float_uds `plusUDs` mkBigUD bind' dict_binds calls)
 739
 740
 741 -- A truly gruesome function
 742 mkBigUD bind@(NonRec _ _) dbs calls
 743   =     -- Common case: non-recursive and no specialisations
 744         -- (if there were any specialistions it would have been made recursive)
 745     MkUD { dict_binds = listToBag (mkDB bind : dbs),
 746            calls = listToCallDetails calls }
 747
 748 mkBigUD bind dbs calls
 749   =     -- General case
 750     MkUD { dict_binds = unitBag (mkDB (Rec (bind_prs bind ++ dbsToPairs dbs))),
 751                         -- Make a huge Rec
 752            calls = listToCallDetails calls }
 753   where
 754     bind_prs (NonRec b r) = [(b,r)]
 755     bind_prs (Rec prs)    = prs
 756
 757     dbsToPairs []             = []
 758     dbsToPairs ((bind,_):dbs) = bind_prs bind ++ dbsToPairs dbs
 759
 760 -- specBindItself deals with the RHS, specialising it according
 761 -- to the calls found in the body (if any)
 762 specBindItself rhs_subst (NonRec bndr rhs) call_info
 763   = specDefn rhs_subst call_info (bndr,rhs)     `thenSM` \ ((bndr',rhs'), spec_defns, spec_uds) ->
 764     let
 765         new_bind | null spec_defns = NonRec bndr' rhs'
 766                  | otherwise       = Rec ((bndr',rhs'):spec_defns)
 767                 -- bndr' mentions the spec_defns in its SpecEnv
 768                 -- Not sure why we couln't just put the spec_defns first
 769     in
 770     returnSM (new_bind, spec_uds)
 771
 772 specBindItself rhs_subst (Rec pairs) call_info
 773   = mapSM (specDefn rhs_subst call_info) pairs  `thenSM` \ stuff ->
 774     let
 775         (pairs', spec_defns_s, spec_uds_s) = unzip3 stuff
 776         spec_defns = concat spec_defns_s
 777         spec_uds   = plusUDList spec_uds_s
 778         new_bind   = Rec (spec_defns ++ pairs')
 779     in
 780     returnSM (new_bind, spec_uds)
 781
 782
 783 specDefn :: Subst                       -- Subst to use for RHS
 784          -> CallDetails                 -- Info on how it is used in its scope
 785          -> (Id, CoreExpr)              -- The thing being bound and its un-processed RHS
 786          -> SpecM ((Id, CoreExpr),      -- The thing and its processed RHS
 787                                         --      the Id may now have specialisations attached
 788                    [(Id,CoreExpr)],     -- Extra, specialised bindings
 789                    UsageDetails         -- Stuff to fling upwards from the RHS and its
 790             )                           --      specialised versions
 791
 792 specDefn subst calls (fn, rhs)
 793         -- The first case is the interesting one
 794   |  n_tyvars == length rhs_tyvars      -- Rhs of fn's defn has right number of big lambdas
 795   && n_dicts  <= length rhs_bndrs       -- and enough dict args
 796   && not (null calls_for_me)            -- And there are some calls to specialise
 797   && not (certainlyWillInline fn)       -- And it's not small
 798                                         -- If it's small, it's better just to inline
 799                                         -- it than to construct lots of specialisations
 800   =   -- Specialise the body of the function
 801     specExpr subst rhs                                  `thenSM` \ (rhs', rhs_uds) ->
 802
 803       -- Make a specialised version for each call in calls_for_me
 804     mapSM spec_call calls_for_me                `thenSM` \ stuff ->
 805     let
 806         (spec_defns, spec_uds, spec_env_stuff) = unzip3 stuff
 807
 808         fn' = addIdSpecialisations zapped_fn spec_env_stuff
 809     in
 810     returnSM ((fn',rhs'),
 811               spec_defns,
 812               rhs_uds `plusUDs` plusUDList spec_uds)
 813
 814   | otherwise   -- No calls or RHS doesn't fit our preconceptions
 815   = specExpr subst rhs                  `thenSM` \ (rhs', rhs_uds) ->
 816     returnSM ((zapped_fn, rhs'), [], rhs_uds)
 817
 818   where
 819     zapped_fn            = modifyIdInfo zapSpecPragInfo fn
 820         -- If the fn is a SpecPragmaId, make it discardable
 821         -- It's role as a holder for a call instance is o'er
 822         -- But it might be alive for some other reason by now.
 823
 824     fn_type              = idType fn
 825     (tyvars, theta, tau) = splitSigmaTy fn_type
 826     n_tyvars             = length tyvars
 827     n_dicts              = length theta
 828
 829     (rhs_tyvars, rhs_ids, rhs_body) = collectTyAndValBinders rhs
 830     rhs_dicts = take n_dicts rhs_ids
 831     rhs_bndrs = rhs_tyvars ++ rhs_dicts
 832     body      = mkLams (drop n_dicts rhs_ids) rhs_body
 833                 -- Glue back on the non-dict lambdas
 834
 835     calls_for_me = case lookupFM calls fn of
 836                         Nothing -> []
 837                         Just cs -> fmToList cs
 838
 839     ----------------------------------------------------------
 840         -- Specialise to one particular call pattern
 841     spec_call :: ([Maybe Type], ([DictExpr], VarSet))           -- Call instance
 842               -> SpecM ((Id,CoreExpr),                          -- Specialised definition
 843                         UsageDetails,                           -- Usage details from specialised body
 844                         ([CoreBndr], [CoreExpr], CoreExpr))     -- Info for the Id's SpecEnv
 845     spec_call (call_ts, (call_ds, call_fvs))
 846       = ASSERT( length call_ts == n_tyvars && length call_ds == n_dicts )
 847                 -- Calls are only recorded for properly-saturated applications
 848
 849         -- Suppose f's defn is  f = /\ a b c d -> \ d1 d2 -> rhs
 850         -- Supppose the call is for f [Just t1, Nothing, Just t3, Nothing] [dx1, dx2]
 851
 852         -- Construct the new binding
 853         --      f1 = SUBST[a->t1,c->t3, d1->d1', d2->d2'] (/\ b d -> rhs)
 854         -- PLUS the usage-details
 855         --      { d1' = dx1; d2' = dx2 }
 856         -- where d1', d2' are cloned versions of d1,d2, with the type substitution applied.
 857         --
 858         -- Note that the substitution is applied to the whole thing.
 859         -- This is convenient, but just slightly fragile.  Notably:
 860         --      * There had better be no name clashes in a/b/c/d
 861         --
 862         let
 863                 -- poly_tyvars = [b,d] in the example above
 864                 -- spec_tyvars = [a,c]
 865                 -- ty_args     = [t1,b,t3,d]
 866            poly_tyvars = [tv | (tv, Nothing) <- rhs_tyvars `zip` call_ts]
 867            spec_tyvars = [tv | (tv, Just _)  <- rhs_tyvars `zip` call_ts]
 868            ty_args     = zipWithEqual "spec_call" mk_ty_arg rhs_tyvars call_ts
 869                        where
 870                          mk_ty_arg rhs_tyvar Nothing   = Type (mkTyVarTy rhs_tyvar)
 871                          mk_ty_arg rhs_tyvar (Just ty) = Type ty
 872            rhs_subst  = extendSubstList subst spec_tyvars [DoneTy ty | Just ty <- call_ts]
 873         in
 874         cloneBinders rhs_subst rhs_dicts                `thenSM` \ (rhs_subst', rhs_dicts') ->
 875         let
 876            inst_args = ty_args ++ map Var rhs_dicts'
 877
 878                 -- Figure out the type of the specialised function
 879            spec_id_ty = mkForAllTys poly_tyvars (applyTypeToArgs rhs fn_type inst_args)
 880         in
 881         newIdSM fn spec_id_ty                           `thenSM` \ spec_f ->
 882         specExpr rhs_subst' (mkLams poly_tyvars body)   `thenSM` \ (spec_rhs, rhs_uds) ->
 883         let
 884                 -- The rule to put in the function's specialisation is:
 885                 --      forall b,d, d1',d2'.  f t1 b t3 d d1' d2' = f1 b d
 886            spec_env_rule = (poly_tyvars ++ rhs_dicts',
 887                             inst_args,
 888                             mkTyApps (Var spec_f) (map mkTyVarTy poly_tyvars))
 889
 890                 -- Add the { d1' = dx1; d2' = dx2 } usage stuff
 891            final_uds = foldr addDictBind rhs_uds (my_zipEqual "spec_call" rhs_dicts' call_ds)
 892         in
 893         returnSM ((spec_f, spec_rhs),
 894                   final_uds,
 895                   spec_env_rule)
 896
 897       where
 898         my_zipEqual doc xs ys
 899          | length xs /= length ys = pprPanic "my_zipEqual" (ppr xs $$ ppr ys $$ (ppr fn <+> ppr call_ts) $$ ppr rhs)
 900          | otherwise              = zipEqual doc xs ys
 901 \end{code}
 902
 903 %************************************************************************
 904 %*                                                                      *
 905 \subsubsection{UsageDetails and suchlike}
 906 %*                                                                      *
 907 %************************************************************************
 908
 909 \begin{code}
 910 data UsageDetails
 911   = MkUD {
 912         dict_binds :: !(Bag DictBind),
 913                         -- Floated dictionary bindings
 914                         -- The order is important;
 915                         -- in ds1 `union` ds2, bindings in ds2 can depend on those in ds1
 916                         -- (Remember, Bags preserve order in GHC.)
 917
 918         calls     :: !CallDetails
 919     }
 920
 921 type DictBind = (CoreBind, VarSet)
 922         -- The set is the free vars of the binding
 923         -- both tyvars and dicts
 924
 925 type DictExpr = CoreExpr
 926
 927 emptyUDs = MkUD { dict_binds = emptyBag, calls = emptyFM }
 928
 929 type ProtoUsageDetails = ([DictBind],
 930                           [(Id, [Maybe Type], ([DictExpr], VarSet))]
 931                          )
 932
 933 ------------------------------------------------------------
 934 type CallDetails  = FiniteMap Id CallInfo
 935 type CallInfo     = FiniteMap [Maybe Type]                      -- Nothing => unconstrained type argument
 936                               ([DictExpr], VarSet)              -- Dict args and the vars of the whole
 937                                                                 -- call (including tyvars)
 938                                                                 -- [*not* include the main id itself, of course]
 939         -- The finite maps eliminate duplicates
 940         -- The list of types and dictionaries is guaranteed to
 941         -- match the type of f
 942
 943 unionCalls :: CallDetails -> CallDetails -> CallDetails
 944 unionCalls c1 c2 = plusFM_C plusFM c1 c2
 945
 946 singleCall :: Id -> [Maybe Type] -> [DictExpr] -> CallDetails
 947 singleCall id tys dicts
 948   = unitFM id (unitFM tys (dicts, call_fvs))
 949   where
 950     call_fvs = exprsFreeVars dicts `unionVarSet` tys_fvs
 951     tys_fvs  = tyVarsOfTypes (catMaybes tys)
 952         -- The type args (tys) are guaranteed to be part of the dictionary
 953         -- types, because they are just the constrained types,
 954         -- and the dictionary is therefore sure to be bound
 955         -- inside the binding for any type variables free in the type;
 956         -- hence it's safe to neglect tyvars free in tys when making
 957         -- the free-var set for this call
 958         -- BUT I don't trust this reasoning; play safe and include tys_fvs
 959         --
 960         -- We don't include the 'id' itself.
 961
 962 listToCallDetails calls
 963   = foldr (unionCalls . mk_call) emptyFM calls
 964   where
 965     mk_call (id, tys, dicts_w_fvs) = unitFM id (unitFM tys dicts_w_fvs)
 966         -- NB: the free vars of the call are provided
 967
 968 callDetailsToList calls = [ (id,tys,dicts)
 969                           | (id,fm) <- fmToList calls,
 970                             (tys,dicts) <- fmToList fm
 971                           ]
 972
 973 mkCallUDs subst f args
 974   | null theta
 975   || length spec_tys /= n_tyvars
 976   || length dicts    /= n_dicts
 977   || maybeToBool (lookupRule (substInScope subst) f args)
 978         -- There's already a rule covering this call.  A typical case
 979         -- is where there's an explicit user-provided rule.  Then
 980         -- we don't want to create a specialised version
 981         -- of the function that overlaps.
 982   = emptyUDs    -- Not overloaded, or no specialisation wanted
 983
 984   | otherwise
 985   = MkUD {dict_binds = emptyBag,
 986           calls      = singleCall f spec_tys dicts
 987     }
 988   where
 989     (tyvars, theta, tau) = splitSigmaTy (idType f)
 990     constrained_tyvars   = tyVarsOfTheta theta
 991     n_tyvars             = length tyvars
 992     n_dicts              = length theta
 993
 994     spec_tys = [mk_spec_ty tv ty | (tv, Type ty) <- tyvars `zip` args]
 995     dicts    = [dict_expr | (_, dict_expr) <- theta `zip` (drop n_tyvars args)]
 996
 997     mk_spec_ty tyvar ty | tyvar `elemVarSet` constrained_tyvars
 998                         = Just ty
 999                         | otherwise
1000                         = Nothing
1001
1002 ------------------------------------------------------------
1003 plusUDs :: UsageDetails -> UsageDetails -> UsageDetails
1004 plusUDs (MkUD {dict_binds = db1, calls = calls1})
1005         (MkUD {dict_binds = db2, calls = calls2})
1006   = MkUD {dict_binds = d, calls = c}
1007   where
1008     d = db1    `unionBags`   db2
1009     c = calls1 `unionCalls`  calls2
1010
1011 plusUDList = foldr plusUDs emptyUDs
1012
1013 -- zapCalls deletes calls to ids from uds
1014 zapCalls ids uds = uds {calls = delListFromFM (calls uds) ids}
1015
1016 mkDB bind = (bind, bind_fvs bind)
1017
1018 bind_fvs (NonRec bndr rhs) = exprFreeVars rhs
1019 bind_fvs (Rec prs)         = foldl delVarSet rhs_fvs bndrs
1020                            where
1021                              bndrs = map fst prs
1022                              rhs_fvs = unionVarSets [exprFreeVars rhs | (bndr,rhs) <- prs]
1023
1024 addDictBind (dict,rhs) uds = uds { dict_binds = mkDB (NonRec dict rhs) `consBag` dict_binds uds }
1025
1026 dumpAllDictBinds (MkUD {dict_binds = dbs}) binds
1027   = foldrBag add binds dbs
1028   where
1029     add (bind,_) binds = bind : binds
1030
1031 dumpUDs :: [CoreBndr]
1032         -> UsageDetails -> CoreExpr
1033         -> (UsageDetails, CoreExpr)
1034 dumpUDs bndrs uds body
1035   = (free_uds, foldr add_let body dict_binds)
1036   where
1037     (free_uds, (dict_binds, _)) = splitUDs bndrs uds
1038     add_let (bind,_) body       = Let bind body
1039
1040 splitUDs :: [CoreBndr]
1041          -> UsageDetails
1042          -> (UsageDetails,              -- These don't mention the binders
1043              ProtoUsageDetails)         -- These do
1044
1045 splitUDs bndrs uds@(MkUD {dict_binds = orig_dbs,
1046                           calls      = orig_calls})
1047
1048   = if isEmptyBag dump_dbs && null dump_calls then
1049         -- Common case: binder doesn't affect floats
1050         (uds, ([],[]))
1051
1052     else
1053         -- Binders bind some of the fvs of the floats
1054         (MkUD {dict_binds = free_dbs,
1055                calls      = listToCallDetails free_calls},
1056          (bagToList dump_dbs, dump_calls)
1057         )
1058
1059   where
1060     bndr_set = mkVarSet bndrs
1061
1062     (free_dbs, dump_dbs, dump_idset)
1063           = foldlBag dump_db (emptyBag, emptyBag, bndr_set) orig_dbs
1064                 -- Important that it's foldl not foldr;
1065                 -- we're accumulating the set of dumped ids in dump_set
1066
1067         -- Filter out any calls that mention things that are being dumped
1068     orig_call_list                 = callDetailsToList orig_calls
1069     (dump_calls, free_calls)       = partition captured orig_call_list
1070     captured (id,tys,(dicts, fvs)) =  fvs `intersectsVarSet` dump_idset
1071                                    || id `elemVarSet` dump_idset
1072
1073     dump_db (free_dbs, dump_dbs, dump_idset) db@(bind, fvs)
1074         | dump_idset `intersectsVarSet` fvs     -- Dump it
1075         = (free_dbs, dump_dbs `snocBag` db,
1076            dump_idset `unionVarSet` mkVarSet (bindersOf bind))
1077
1078         | otherwise     -- Don't dump it
1079         = (free_dbs `snocBag` db, dump_dbs, dump_idset)
1080 \end{code}
1081
1082
1083 %************************************************************************
1084 %*                                                                      *
1085 \subsubsection{Boring helper functions}
1086 %*                                                                      *
1087 %************************************************************************
1088
1089 \begin{code}
1090 lookupId:: IdEnv Id -> Id -> Id
1091 lookupId env id = case lookupVarEnv env id of
1092                         Nothing  -> id
1093                         Just id' -> id'
1094
1095 ----------------------------------------
1096 type SpecM a = UniqSM a
1097
1098 thenSM    = thenUs
1099 thenSM_    = thenUs_
1100 returnSM  = returnUs
1101 getUniqSM = getUniqueUs
1102 getUniqSupplySM = getUs
1103 setUniqSupplySM = setUs
1104 mapSM     = mapUs
1105 initSM    = initUs_
1106
1107 mapAndCombineSM f []     = returnSM ([], emptyUDs)
1108 mapAndCombineSM f (x:xs) = f x  `thenSM` \ (y, uds1) ->
1109                            mapAndCombineSM f xs `thenSM` \ (ys, uds2) ->
1110                            returnSM (y:ys, uds1 `plusUDs` uds2)
1111
1112 cloneBindSM :: Subst -> CoreBind -> SpecM (Subst, Subst, CoreBind)
1113 -- Clone the binders of the bind; return new bind with the cloned binders
1114 -- Return the substitution to use for RHSs, and the one to use for the body
1115 cloneBindSM subst (NonRec bndr rhs)
1116   = getUs       `thenUs` \ us ->
1117     let
1118         (subst', us', bndr') = substAndCloneId subst us bndr
1119     in
1120     setUs us'   `thenUs_`
1121     returnUs (subst, subst', NonRec bndr' rhs)
1122
1123 cloneBindSM subst (Rec pairs)
1124   = getUs       `thenUs` \ us ->
1125     let
1126         (subst', us', bndrs') = substAndCloneIds subst us (map fst pairs)
1127     in
1128     setUs us'   `thenUs_`
1129     returnUs (subst', subst', Rec (bndrs' `zip` map snd pairs))
1130
1131 cloneBinders subst bndrs
1132   = getUs       `thenUs` \ us ->
1133     let
1134         (subst', us', bndrs') = substAndCloneIds subst us bndrs
1135     in
1136     setUs us'   `thenUs_`
1137     returnUs (subst', bndrs')
1138
1139
1140 newIdSM old_id new_ty
1141   = getUniqSM           `thenSM` \ uniq ->
1142     let
1143         -- Give the new Id a similar occurrence name to the old one
1144         name   = idName old_id
1145         new_id = mkUserLocal (mkSpecOcc (nameOccName name)) uniq new_ty (getSrcLoc name)
1146
1147         -- If the old Id was exported, make the new one non-discardable,
1148         -- else we will discard it since it doesn't seem to be called.
1149         new_id' | isExportedId old_id = setIdNoDiscard new_id
1150                 | otherwise           = new_id
1151     in
1152     returnSM new_id'
1153
1154 newTyVarSM
1155   = getUniqSM           `thenSM` \ uniq ->
1156     returnSM (mkSysTyVar uniq boxedTypeKind)
1157 \end{code}
1158
1159
1160                 Old (but interesting) stuff about unboxed bindings
1161                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1162
1163 What should we do when a value is specialised to a *strict* unboxed value?
1164
1165         map_*_* f (x:xs) = let h = f x
1166                                t = map f xs
1167                            in h:t
1168
1169 Could convert let to case:
1170
1171         map_*_Int# f (x:xs) = case f x of h# ->
1172                               let t = map f xs
1173                               in h#:t
1174
1175 This may be undesirable since it forces evaluation here, but the value
1176 may not be used in all branches of the body. In the general case this
1177 transformation is impossible since the mutual recursion in a letrec
1178 cannot be expressed as a case.
1179
1180 There is also a problem with top-level unboxed values, since our
1181 implementation cannot handle unboxed values at the top level.
1182
1183 Solution: Lift the binding of the unboxed value and extract it when it
1184 is used:
1185
1186         map_*_Int# f (x:xs) = let h = case (f x) of h# -> _Lift h#
1187                                   t = map f xs
1188                               in case h of
1189                                  _Lift h# -> h#:t
1190
1191 Now give it to the simplifier and the _Lifting will be optimised away.
1192
1193 The benfit is that we have given the specialised "unboxed" values a
1194 very simplep lifted semantics and then leave it up to the simplifier to
1195 optimise it --- knowing that the overheads will be removed in nearly
1196 all cases.
1197
1198 In particular, the value will only be evaluted in the branches of the
1199 program which use it, rather than being forced at the point where the
1200 value is bound. For example:
1201
1202         filtermap_*_* p f (x:xs)
1203           = let h = f x
1204                 t = ...
1205             in case p x of
1206                 True  -> h:t
1207                 False -> t
1208    ==>
1209         filtermap_*_Int# p f (x:xs)
1210           = let h = case (f x) of h# -> _Lift h#
1211                 t = ...
1212             in case p x of
1213                 True  -> case h of _Lift h#
1214                            -> h#:t
1215                 False -> t
1216
1217 The binding for h can still be inlined in the one branch and the
1218 _Lifting eliminated.
1219
1220
1221 Question: When won't the _Lifting be eliminated?
1222
1223 Answer: When they at the top-level (where it is necessary) or when
1224 inlining would duplicate work (or possibly code depending on
1225 options). However, the _Lifting will still be eliminated if the
1226 strictness analyser deems the lifted binding strict.
1227