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