compiler/simplCore/SetLevels.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section{SetLevels}
   5
   6                 ***************************
   7                         Overview
   8                 ***************************
   9
  10 1. We attach binding levels to Core bindings, in preparation for floating
  11    outwards (@FloatOut@).
  12
  13 2. We also let-ify many expressions (notably case scrutinees), so they
  14    will have a fighting chance of being floated sensible.
  15
  16 3. We clone the binders of any floatable let-binding, so that when it is
  17    floated out it will be unique.  (This used to be done by the simplifier
  18    but the latter now only ensures that there's no shadowing; indeed, even
  19    that may not be true.)
  20
  21    NOTE: this can't be done using the uniqAway idea, because the variable
  22          must be unique in the whole program, not just its current scope,
  23          because two variables in different scopes may float out to the
  24          same top level place
  25
  26    NOTE: Very tiresomely, we must apply this substitution to
  27          the rules stored inside a variable too.
  28
  29    We do *not* clone top-level bindings, because some of them must not change,
  30    but we *do* clone bindings that are heading for the top level
  31
  32 4. In the expression
  33         case x of wild { p -> ...wild... }
  34    we substitute x for wild in the RHS of the case alternatives:
  35         case x of wild { p -> ...x... }
  36    This means that a sub-expression involving x is not "trapped" inside the RHS.
  37    And it's not inconvenient because we already have a substitution.
  38
  39   Note that this is EXACTLY BACKWARDS from the what the simplifier does.
  40   The simplifier tries to get rid of occurrences of x, in favour of wild,
  41   in the hope that there will only be one remaining occurrence of x, namely
  42   the scrutinee of the case, and we can inline it.
  43
  44 \begin{code}
  45 module SetLevels (
  46         setLevels,
  47
  48         Level(..), tOP_LEVEL,
  49         LevelledBind, LevelledExpr,
  50
  51         incMinorLvl, ltMajLvl, ltLvl, isTopLvl, isInlineCtxt
  52     ) where
  53
  54 #include "HsVersions.h"
  55
  56 import CoreSyn
  57
  58 import DynFlags         ( FloatOutSwitches(..) )
  59 import CoreUtils        ( exprType, exprIsTrivial, mkPiTypes )
  60 import CoreFVs          -- all of it
  61 import CoreSubst        ( Subst, emptySubst, extendInScope, extendIdSubst,
  62                           cloneIdBndr, cloneRecIdBndrs )
  63 import Id               ( Id, idType, mkSysLocal, isOneShotLambda,
  64                           zapDemandIdInfo, transferPolyIdInfo,
  65                           idSpecialisation, idWorkerInfo, setIdInfo
  66                         )
  67 import IdInfo
  68 import Var
  69 import VarSet
  70 import VarEnv
  71 import Name             ( getOccName )
  72 import OccName          ( occNameString )
  73 import Type             ( isUnLiftedType, Type )
  74 import BasicTypes       ( TopLevelFlag(..) )
  75 import UniqSupply
  76 import Util             ( sortLe, isSingleton, count )
  77 import Outputable
  78 import FastString
  79 \end{code}
  80
  81 %************************************************************************
  82 %*                                                                      *
  83 \subsection{Level numbers}
  84 %*                                                                      *
  85 %************************************************************************
  86
  87 \begin{code}
  88 data Level = InlineCtxt -- A level that's used only for
  89                         -- the context parameter ctxt_lvl
  90            | Level Int  -- Level number of enclosing lambdas
  91                    Int  -- Number of big-lambda and/or case expressions between
  92                         -- here and the nearest enclosing lambda
  93 \end{code}
  94
  95 The {\em level number} on a (type-)lambda-bound variable is the
  96 nesting depth of the (type-)lambda which binds it.  The outermost lambda
  97 has level 1, so (Level 0 0) means that the variable is bound outside any lambda.
  98
  99 On an expression, it's the maximum level number of its free
 100 (type-)variables.  On a let(rec)-bound variable, it's the level of its
 101 RHS.  On a case-bound variable, it's the number of enclosing lambdas.
 102
 103 Top-level variables: level~0.  Those bound on the RHS of a top-level
 104 definition but ``before'' a lambda; e.g., the \tr{x} in (levels shown
 105 as ``subscripts'')...
 106 \begin{verbatim}
 107 a_0 = let  b_? = ...  in
 108            x_1 = ... b ... in ...
 109 \end{verbatim}
 110
 111 The main function @lvlExpr@ carries a ``context level'' (@ctxt_lvl@).
 112 That's meant to be the level number of the enclosing binder in the
 113 final (floated) program.  If the level number of a sub-expression is
 114 less than that of the context, then it might be worth let-binding the
 115 sub-expression so that it will indeed float.
 116
 117 If you can float to level @Level 0 0@ worth doing so because then your
 118 allocation becomes static instead of dynamic.  We always start with
 119 context @Level 0 0@.
 120
 121
 122 Note [FloatOut inside INLINE]
 123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 124 @InlineCtxt@ very similar to @Level 0 0@, but is used for one purpose:
 125 to say "don't float anything out of here".  That's exactly what we
 126 want for the body of an INLINE, where we don't want to float anything
 127 out at all.  See notes with lvlMFE below.
 128
 129 But, check this out:
 130
 131 -- At one time I tried the effect of not float anything out of an InlineMe,
 132 -- but it sometimes works badly.  For example, consider PrelArr.done.  It
 133 -- has the form         __inline (\d. e)
 134 -- where e doesn't mention d.  If we float this to
 135 --      __inline (let x = e in \d. x)
 136 -- things are bad.  The inliner doesn't even inline it because it doesn't look
 137 -- like a head-normal form.  So it seems a lesser evil to let things float.
 138 -- In SetLevels we do set the context to (Level 0 0) when we get to an InlineMe
 139 -- which discourages floating out.
 140
 141 So the conclusion is: don't do any floating at all inside an InlineMe.
 142 (In the above example, don't float the {x=e} out of the \d.)
 143
 144 One particular case is that of workers: we don't want to float the
 145 call to the worker outside the wrapper, otherwise the worker might get
 146 inlined into the floated expression, and an importing module won't see
 147 the worker at all.
 148
 149 \begin{code}
 150 type LevelledExpr  = TaggedExpr Level
 151 type LevelledBind  = TaggedBind Level
 152
 153 tOP_LEVEL, iNLINE_CTXT :: Level
 154 tOP_LEVEL   = Level 0 0
 155 iNLINE_CTXT = InlineCtxt
 156
 157 incMajorLvl :: Level -> Level
 158 -- For InlineCtxt we ignore any inc's; we don't want
 159 -- to do any floating at all; see notes above
 160 incMajorLvl InlineCtxt      = InlineCtxt
 161 incMajorLvl (Level major _) = Level (major + 1) 0
 162
 163 incMinorLvl :: Level -> Level
 164 incMinorLvl InlineCtxt          = InlineCtxt
 165 incMinorLvl (Level major minor) = Level major (minor+1)
 166
 167 maxLvl :: Level -> Level -> Level
 168 maxLvl InlineCtxt l2  = l2
 169 maxLvl l1  InlineCtxt = l1
 170 maxLvl l1@(Level maj1 min1) l2@(Level maj2 min2)
 171   | (maj1 > maj2) || (maj1 == maj2 && min1 > min2) = l1
 172   | otherwise                                      = l2
 173
 174 ltLvl :: Level -> Level -> Bool
 175 ltLvl _          InlineCtxt  = False
 176 ltLvl InlineCtxt (Level _ _) = True
 177 ltLvl (Level maj1 min1) (Level maj2 min2)
 178   = (maj1 < maj2) || (maj1 == maj2 && min1 < min2)
 179
 180 ltMajLvl :: Level -> Level -> Bool
 181     -- Tells if one level belongs to a difft *lambda* level to another
 182 ltMajLvl _              InlineCtxt     = False
 183 ltMajLvl InlineCtxt     (Level maj2 _) = 0 < maj2
 184 ltMajLvl (Level maj1 _) (Level maj2 _) = maj1 < maj2
 185
 186 isTopLvl :: Level -> Bool
 187 isTopLvl (Level 0 0) = True
 188 isTopLvl _           = False
 189
 190 isInlineCtxt :: Level -> Bool
 191 isInlineCtxt InlineCtxt = True
 192 isInlineCtxt _          = False
 193
 194 instance Outputable Level where
 195   ppr InlineCtxt      = text "<INLINE>"
 196   ppr (Level maj min) = hcat [ char '<', int maj, char ',', int min, char '>' ]
 197
 198 instance Eq Level where
 199   InlineCtxt        == InlineCtxt        = True
 200   (Level maj1 min1) == (Level maj2 min2) = maj1 == maj2 && min1 == min2
 201   _                 == _                 = False
 202 \end{code}
 203
 204
 205 %************************************************************************
 206 %*                                                                      *
 207 \subsection{Main level-setting code}
 208 %*                                                                      *
 209 %************************************************************************
 210
 211 \begin{code}
 212 setLevels :: FloatOutSwitches
 213           -> [CoreBind]
 214           -> UniqSupply
 215           -> [LevelledBind]
 216
 217 setLevels float_lams binds us
 218   = initLvl us (do_them binds)
 219   where
 220     -- "do_them"'s main business is to thread the monad along
 221     -- It gives each top binding the same empty envt, because
 222     -- things unbound in the envt have level number zero implicitly
 223     do_them :: [CoreBind] -> LvlM [LevelledBind]
 224
 225     do_them [] = return []
 226     do_them (b:bs) = do
 227         (lvld_bind, _) <- lvlTopBind init_env b
 228         lvld_binds <- do_them bs
 229         return (lvld_bind : lvld_binds)
 230
 231     init_env = initialEnv float_lams
 232
 233 lvlTopBind :: LevelEnv -> Bind Id -> LvlM (LevelledBind, LevelEnv)
 234 lvlTopBind env (NonRec binder rhs)
 235   = lvlBind TopLevel tOP_LEVEL env (AnnNonRec binder (freeVars rhs))
 236                                         -- Rhs can have no free vars!
 237
 238 lvlTopBind env (Rec pairs)
 239   = lvlBind TopLevel tOP_LEVEL env (AnnRec [(b,freeVars rhs) | (b,rhs) <- pairs])
 240 \end{code}
 241
 242 %************************************************************************
 243 %*                                                                      *
 244 \subsection{Setting expression levels}
 245 %*                                                                      *
 246 %************************************************************************
 247
 248 \begin{code}
 249 lvlExpr :: Level                -- ctxt_lvl: Level of enclosing expression
 250         -> LevelEnv             -- Level of in-scope names/tyvars
 251         -> CoreExprWithFVs      -- input expression
 252         -> LvlM LevelledExpr    -- Result expression
 253 \end{code}
 254
 255 The @ctxt_lvl@ is, roughly, the level of the innermost enclosing
 256 binder.  Here's an example
 257
 258         v = \x -> ...\y -> let r = case (..x..) of
 259                                         ..x..
 260                            in ..
 261
 262 When looking at the rhs of @r@, @ctxt_lvl@ will be 1 because that's
 263 the level of @r@, even though it's inside a level-2 @\y@.  It's
 264 important that @ctxt_lvl@ is 1 and not 2 in @r@'s rhs, because we
 265 don't want @lvlExpr@ to turn the scrutinee of the @case@ into an MFE
 266 --- because it isn't a *maximal* free expression.
 267
 268 If there were another lambda in @r@'s rhs, it would get level-2 as well.
 269
 270 \begin{code}
 271 lvlExpr _ _ (  _, AnnType ty) = return (Type ty)
 272 lvlExpr _ env (_, AnnVar v)   = return (lookupVar env v)
 273 lvlExpr _ _   (_, AnnLit lit) = return (Lit lit)
 274
 275 lvlExpr ctxt_lvl env (_, AnnApp fun arg) = do
 276     fun' <- lvl_fun fun
 277     arg' <- lvlMFE  False ctxt_lvl env arg
 278     return (App fun' arg')
 279   where
 280 -- gaw 2004
 281     lvl_fun (_, AnnCase _ _ _ _) = lvlMFE True ctxt_lvl env fun
 282     lvl_fun _                    = lvlExpr ctxt_lvl env fun
 283         -- We don't do MFE on partial applications generally,
 284         -- but we do if the function is big and hairy, like a case
 285
 286 lvlExpr _ env (_, AnnNote InlineMe expr) = do
 287 -- Don't float anything out of an InlineMe; hence the iNLINE_CTXT
 288     expr' <- lvlExpr iNLINE_CTXT env expr
 289     return (Note InlineMe expr')
 290
 291 lvlExpr ctxt_lvl env (_, AnnNote note expr) = do
 292     expr' <- lvlExpr ctxt_lvl env expr
 293     return (Note note expr')
 294
 295 lvlExpr ctxt_lvl env (_, AnnCast expr co) = do
 296     expr' <- lvlExpr ctxt_lvl env expr
 297     return (Cast expr' co)
 298
 299 -- We don't split adjacent lambdas.  That is, given
 300 --      \x y -> (x+1,y)
 301 -- we don't float to give
 302 --      \x -> let v = x+y in \y -> (v,y)
 303 -- Why not?  Because partial applications are fairly rare, and splitting
 304 -- lambdas makes them more expensive.
 305
 306 lvlExpr ctxt_lvl env expr@(_, AnnLam {}) = do
 307     new_body <- lvlMFE True new_lvl new_env body
 308     return (mkLams new_bndrs new_body)
 309   where
 310     (bndrs, body)        = collectAnnBndrs expr
 311     (new_lvl, new_bndrs) = lvlLamBndrs ctxt_lvl bndrs
 312     new_env              = extendLvlEnv env new_bndrs
 313         -- At one time we called a special verion of collectBinders,
 314         -- which ignored coercions, because we don't want to split
 315         -- a lambda like this (\x -> coerce t (\s -> ...))
 316         -- This used to happen quite a bit in state-transformer programs,
 317         -- but not nearly so much now non-recursive newtypes are transparent.
 318         -- [See SetLevels rev 1.50 for a version with this approach.]
 319
 320 lvlExpr ctxt_lvl env (_, AnnLet (AnnNonRec bndr rhs) body)
 321   | isUnLiftedType (idType bndr) = do
 322         -- Treat unlifted let-bindings (let x = b in e) just like (case b of x -> e)
 323         -- That is, leave it exactly where it is
 324         -- We used to float unlifted bindings too (e.g. to get a cheap primop
 325         -- outside a lambda (to see how, look at lvlBind in rev 1.58)
 326         -- but an unrelated change meant that these unlifed bindings
 327         -- could get to the top level which is bad.  And there's not much point;
 328         -- unlifted bindings are always cheap, and so hardly worth floating.
 329     rhs'  <- lvlExpr ctxt_lvl env rhs
 330     body' <- lvlExpr incd_lvl env' body
 331     return (Let (NonRec bndr' rhs') body')
 332   where
 333     incd_lvl = incMinorLvl ctxt_lvl
 334     bndr' = TB bndr incd_lvl
 335     env'  = extendLvlEnv env [bndr']
 336
 337 lvlExpr ctxt_lvl env (_, AnnLet bind body) = do
 338     (bind', new_env) <- lvlBind NotTopLevel ctxt_lvl env bind
 339     body' <- lvlExpr ctxt_lvl new_env body
 340     return (Let bind' body')
 341
 342 lvlExpr ctxt_lvl env (_, AnnCase expr case_bndr ty alts) = do
 343     expr' <- lvlMFE True ctxt_lvl env expr
 344     let alts_env = extendCaseBndrLvlEnv env expr' case_bndr incd_lvl
 345     alts' <- mapM (lvl_alt alts_env) alts
 346     return (Case expr' (TB case_bndr incd_lvl) ty alts')
 347   where
 348       incd_lvl  = incMinorLvl ctxt_lvl
 349
 350       lvl_alt alts_env (con, bs, rhs) = do
 351           rhs' <- lvlMFE True incd_lvl new_env rhs
 352           return (con, bs', rhs')
 353         where
 354           bs'     = [ TB b incd_lvl | b <- bs ]
 355           new_env = extendLvlEnv alts_env bs'
 356 \end{code}
 357
 358 @lvlMFE@ is just like @lvlExpr@, except that it might let-bind
 359 the expression, so that it can itself be floated.
 360
 361 [NOTE: unlifted MFEs]
 362 We don't float unlifted MFEs, which potentially loses big opportunites.
 363 For example:
 364         \x -> f (h y)
 365 where h :: Int -> Int# is expensive. We'd like to float the (h y) outside
 366 the \x, but we don't because it's unboxed.  Possible solution: box it.
 367
 368 \begin{code}
 369 lvlMFE ::  Bool                 -- True <=> strict context [body of case or let]
 370         -> Level                -- Level of innermost enclosing lambda/tylam
 371         -> LevelEnv             -- Level of in-scope names/tyvars
 372         -> CoreExprWithFVs      -- input expression
 373         -> LvlM LevelledExpr    -- Result expression
 374
 375 lvlMFE _ _ _ (_, AnnType ty)
 376   = return (Type ty)
 377
 378
 379 lvlMFE strict_ctxt ctxt_lvl env ann_expr@(fvs, _)
 380   |  isUnLiftedType ty                  -- Can't let-bind it; see [NOTE: unlifted MFEs]
 381   || isInlineCtxt ctxt_lvl              -- Don't float out of an __inline__ context
 382   || exprIsTrivial expr                 -- Never float if it's trivial
 383   || not good_destination
 384   =     -- Don't float it out
 385     lvlExpr ctxt_lvl env ann_expr
 386
 387   | otherwise   -- Float it out!
 388   = do expr' <- lvlFloatRhs abs_vars dest_lvl env ann_expr
 389        var <- newLvlVar "lvl" abs_vars ty
 390        return (Let (NonRec (TB var dest_lvl) expr')
 391                    (mkVarApps (Var var) abs_vars))
 392   where
 393     expr     = deAnnotate ann_expr
 394     ty       = exprType expr
 395     dest_lvl = destLevel env fvs (isFunction ann_expr)
 396     abs_vars = abstractVars dest_lvl env fvs
 397
 398         -- A decision to float entails let-binding this thing, and we only do
 399         -- that if we'll escape a value lambda, or will go to the top level.
 400     good_destination
 401         | dest_lvl `ltMajLvl` ctxt_lvl          -- Escapes a value lambda
 402         = True
 403         -- OLD CODE: not (exprIsCheap expr) || isTopLvl dest_lvl
 404         --           see Note [Escaping a value lambda]
 405
 406         | otherwise             -- Does not escape a value lambda
 407         = isTopLvl dest_lvl     -- Only float if we are going to the top level
 408         && floatConsts env      --   and the floatConsts flag is on
 409         && not strict_ctxt      -- Don't float from a strict context
 410           -- We are keen to float something to the top level, even if it does not
 411           -- escape a lambda, because then it needs no allocation.  But it's controlled
 412           -- by a flag, because doing this too early loses opportunities for RULES
 413           -- which (needless to say) are important in some nofib programs
 414           -- (gcd is an example).
 415           --
 416           -- Beware:
 417           --    concat = /\ a -> foldr ..a.. (++) []
 418           -- was getting turned into
 419           --    concat = /\ a -> lvl a
 420           --    lvl    = /\ a -> foldr ..a.. (++) []
 421           -- which is pretty stupid.  Hence the strict_ctxt test
 422 \end{code}
 423
 424 Note [Escaping a value lambda]
 425 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 426 We want to float even cheap expressions out of value lambdas,
 427 because that saves allocation.  Consider
 428         f = \x.  .. (\y.e) ...
 429 Then we'd like to avoid allocating the (\y.e) every time we call f,
 430 (assuming e does not mention x).
 431
 432 An example where this really makes a difference is simplrun009.
 433
 434 Another reason it's good is because it makes SpecContr fire on functions.
 435 Consider
 436         f = \x. ....(f (\y.e))....
 437 After floating we get
 438         lvl = \y.e
 439         f = \x. ....(f lvl)...
 440 and that is much easier for SpecConstr to generate a robust specialisation for.
 441
 442 The OLD CODE (given where this Note is referred to) prevents floating
 443 of the example above, so I just don't understand the old code.  I
 444 don't understand the old comment either (which appears below).  I
 445 measured the effect on nofib of changing OLD CODE to 'True', and got
 446 zeros everywhere, but a 4% win for 'puzzle'.  Very small 0.5% loss for
 447 'cse'; turns out to be because our arity analysis isn't good enough
 448 yet (mentioned in Simon-nofib-notes).
 449
 450 OLD comment was:
 451          Even if it escapes a value lambda, we only
 452          float if it's not cheap (unless it'll get all the
 453          way to the top).  I've seen cases where we
 454          float dozens of tiny free expressions, which cost
 455          more to allocate than to evaluate.
 456          NB: exprIsCheap is also true of bottom expressions, which
 457              is good; we don't want to share them
 458
 459         It's only Really Bad to float a cheap expression out of a
 460         strict context, because that builds a thunk that otherwise
 461         would never be built.  So another alternative would be to
 462         add
 463                 || (strict_ctxt && not (exprIsBottom expr))
 464         to the condition above. We should really try this out.
 465
 466
 467 %************************************************************************
 468 %*                                                                      *
 469 \subsection{Bindings}
 470 %*                                                                      *
 471 %************************************************************************
 472
 473 The binding stuff works for top level too.
 474
 475 \begin{code}
 476 lvlBind :: TopLevelFlag         -- Used solely to decide whether to clone
 477         -> Level                -- Context level; might be Top even for bindings nested in the RHS
 478                                 -- of a top level binding
 479         -> LevelEnv
 480         -> CoreBindWithFVs
 481         -> LvlM (LevelledBind, LevelEnv)
 482
 483 lvlBind top_lvl ctxt_lvl env (AnnNonRec bndr rhs@(rhs_fvs,_))
 484   | isInlineCtxt ctxt_lvl               -- Don't do anything inside InlineMe
 485   = do rhs' <- lvlExpr ctxt_lvl env rhs
 486        return (NonRec (TB bndr ctxt_lvl) rhs', env)
 487
 488   | null abs_vars
 489   = do  -- No type abstraction; clone existing binder
 490        rhs' <- lvlExpr dest_lvl env rhs
 491        (env', bndr') <- cloneVar top_lvl env bndr ctxt_lvl dest_lvl
 492        return (NonRec (TB bndr' dest_lvl) rhs', env')
 493
 494   | otherwise
 495   = do  -- Yes, type abstraction; create a new binder, extend substitution, etc
 496        rhs' <- lvlFloatRhs abs_vars dest_lvl env rhs
 497        (env', [bndr']) <- newPolyBndrs dest_lvl env abs_vars [bndr]
 498        return (NonRec (TB bndr' dest_lvl) rhs', env')
 499
 500   where
 501     bind_fvs = rhs_fvs `unionVarSet` idFreeVars bndr
 502     abs_vars = abstractVars dest_lvl env bind_fvs
 503     dest_lvl = destLevel env bind_fvs (isFunction rhs)
 504 \end{code}
 505
 506
 507 \begin{code}
 508 lvlBind top_lvl ctxt_lvl env (AnnRec pairs)
 509   | isInlineCtxt ctxt_lvl       -- Don't do anything inside InlineMe
 510   = do rhss' <- mapM (lvlExpr ctxt_lvl env) rhss
 511        return (Rec ([TB b ctxt_lvl | b <- bndrs] `zip` rhss'), env)
 512
 513   | null abs_vars
 514   = do (new_env, new_bndrs) <- cloneRecVars top_lvl env bndrs ctxt_lvl dest_lvl
 515        new_rhss <- mapM (lvlExpr ctxt_lvl new_env) rhss
 516        return (Rec ([TB b dest_lvl | b <- new_bndrs] `zip` new_rhss), new_env)
 517
 518   | isSingleton pairs && count isId abs_vars > 1
 519   = do  -- Special case for self recursion where there are
 520         -- several variables carried around: build a local loop:
 521         --      poly_f = \abs_vars. \lam_vars . letrec f = \lam_vars. rhs in f lam_vars
 522         -- This just makes the closures a bit smaller.  If we don't do
 523         -- this, allocation rises significantly on some programs
 524         --
 525         -- We could elaborate it for the case where there are several
 526         -- mutually functions, but it's quite a bit more complicated
 527         --
 528         -- This all seems a bit ad hoc -- sigh
 529     let
 530         (bndr,rhs) = head pairs
 531         (rhs_lvl, abs_vars_w_lvls) = lvlLamBndrs dest_lvl abs_vars
 532         rhs_env = extendLvlEnv env abs_vars_w_lvls
 533     (rhs_env', new_bndr) <- cloneVar NotTopLevel rhs_env bndr rhs_lvl rhs_lvl
 534     let
 535         (lam_bndrs, rhs_body)     = collectAnnBndrs rhs
 536         (body_lvl, new_lam_bndrs) = lvlLamBndrs rhs_lvl lam_bndrs
 537         body_env                  = extendLvlEnv rhs_env' new_lam_bndrs
 538     new_rhs_body <- lvlExpr body_lvl body_env rhs_body
 539     (poly_env, [poly_bndr]) <- newPolyBndrs dest_lvl env abs_vars [bndr]
 540     return (Rec [(TB poly_bndr dest_lvl,
 541                mkLams abs_vars_w_lvls $
 542                mkLams new_lam_bndrs $
 543                Let (Rec [(TB new_bndr rhs_lvl, mkLams new_lam_bndrs new_rhs_body)])
 544                    (mkVarApps (Var new_bndr) lam_bndrs))],
 545                poly_env)
 546
 547   | otherwise = do  -- Non-null abs_vars
 548     (new_env, new_bndrs) <- newPolyBndrs dest_lvl env abs_vars bndrs
 549     new_rhss <- mapM (lvlFloatRhs abs_vars dest_lvl new_env) rhss
 550     return (Rec ([TB b dest_lvl | b <- new_bndrs] `zip` new_rhss), new_env)
 551
 552   where
 553     (bndrs,rhss) = unzip pairs
 554
 555         -- Finding the free vars of the binding group is annoying
 556     bind_fvs        = (unionVarSets [ idFreeVars bndr `unionVarSet` rhs_fvs
 557                                     | (bndr, (rhs_fvs,_)) <- pairs])
 558                       `minusVarSet`
 559                       mkVarSet bndrs
 560
 561     dest_lvl = destLevel env bind_fvs (all isFunction rhss)
 562     abs_vars = abstractVars dest_lvl env bind_fvs
 563
 564 ----------------------------------------------------
 565 -- Three help functons for the type-abstraction case
 566
 567 lvlFloatRhs :: [CoreBndr] -> Level -> LevelEnv -> CoreExprWithFVs
 568             -> UniqSM (Expr (TaggedBndr Level))
 569 lvlFloatRhs abs_vars dest_lvl env rhs = do
 570     rhs' <- lvlExpr rhs_lvl rhs_env rhs
 571     return (mkLams abs_vars_w_lvls rhs')
 572   where
 573     (rhs_lvl, abs_vars_w_lvls) = lvlLamBndrs dest_lvl abs_vars
 574     rhs_env = extendLvlEnv env abs_vars_w_lvls
 575 \end{code}
 576
 577
 578 %************************************************************************
 579 %*                                                                      *
 580 \subsection{Deciding floatability}
 581 %*                                                                      *
 582 %************************************************************************
 583
 584 \begin{code}
 585 lvlLamBndrs :: Level -> [CoreBndr] -> (Level, [TaggedBndr Level])
 586 -- Compute the levels for the binders of a lambda group
 587 -- The binders returned are exactly the same as the ones passed,
 588 -- but they are now paired with a level
 589 lvlLamBndrs lvl []
 590   = (lvl, [])
 591
 592 lvlLamBndrs lvl bndrs
 593   = go  (incMinorLvl lvl)
 594         False   -- Havn't bumped major level in this group
 595         [] bndrs
 596   where
 597     go old_lvl bumped_major rev_lvld_bndrs (bndr:bndrs)
 598         | isId bndr &&                  -- Go to the next major level if this is a value binder,
 599           not bumped_major &&           -- and we havn't already gone to the next level (one jump per group)
 600           not (isOneShotLambda bndr)    -- and it isn't a one-shot lambda
 601         = go new_lvl True (TB bndr new_lvl : rev_lvld_bndrs) bndrs
 602
 603         | otherwise
 604         = go old_lvl bumped_major (TB bndr old_lvl : rev_lvld_bndrs) bndrs
 605
 606         where
 607           new_lvl = incMajorLvl old_lvl
 608
 609     go old_lvl _ rev_lvld_bndrs []
 610         = (old_lvl, reverse rev_lvld_bndrs)
 611         -- a lambda like this (\x -> coerce t (\s -> ...))
 612         -- This happens quite a bit in state-transformer programs
 613 \end{code}
 614
 615 \begin{code}
 616   -- Destintion level is the max Id level of the expression
 617   -- (We'll abstract the type variables, if any.)
 618 destLevel :: LevelEnv -> VarSet -> Bool -> Level
 619 destLevel env fvs is_function
 620   |  floatLams env
 621   && is_function = tOP_LEVEL            -- Send functions to top level; see
 622                                         -- the comments with isFunction
 623   | otherwise    = maxIdLevel env fvs
 624
 625 isFunction :: CoreExprWithFVs -> Bool
 626 -- The idea here is that we want to float *functions* to
 627 -- the top level.  This saves no work, but
 628 --      (a) it can make the host function body a lot smaller,
 629 --              and hence inlinable.
 630 --      (b) it can also save allocation when the function is recursive:
 631 --          h = \x -> letrec f = \y -> ...f...y...x...
 632 --                    in f x
 633 --     becomes
 634 --          f = \x y -> ...(f x)...y...x...
 635 --          h = \x -> f x x
 636 --     No allocation for f now.
 637 -- We may only want to do this if there are sufficiently few free
 638 -- variables.  We certainly only want to do it for values, and not for
 639 -- constructors.  So the simple thing is just to look for lambdas
 640 isFunction (_, AnnLam b e) | isId b    = True
 641                            | otherwise = isFunction e
 642 isFunction (_, AnnNote _ e)            = isFunction e
 643 isFunction _                           = False
 644 \end{code}
 645
 646
 647 %************************************************************************
 648 %*                                                                      *
 649 \subsection{Free-To-Level Monad}
 650 %*                                                                      *
 651 %************************************************************************
 652
 653 \begin{code}
 654 type LevelEnv = (FloatOutSwitches,
 655                  VarEnv Level,                  -- Domain is *post-cloned* TyVars and Ids
 656                  Subst,                         -- Domain is pre-cloned Ids; tracks the in-scope set
 657                                                 --      so that subtitution is capture-avoiding
 658                  IdEnv ([Var], LevelledExpr))   -- Domain is pre-cloned Ids
 659         -- We clone let-bound variables so that they are still
 660         -- distinct when floated out; hence the SubstEnv/IdEnv.
 661         -- (see point 3 of the module overview comment).
 662         -- We also use these envs when making a variable polymorphic
 663         -- because we want to float it out past a big lambda.
 664         --
 665         -- The Subst and IdEnv always implement the same mapping, but the
 666         -- Subst maps to CoreExpr and the IdEnv to LevelledExpr
 667         -- Since the range is always a variable or type application,
 668         -- there is never any difference between the two, but sadly
 669         -- the types differ.  The SubstEnv is used when substituting in
 670         -- a variable's IdInfo; the IdEnv when we find a Var.
 671         --
 672         -- In addition the IdEnv records a list of tyvars free in the
 673         -- type application, just so we don't have to call freeVars on
 674         -- the type application repeatedly.
 675         --
 676         -- The domain of the both envs is *pre-cloned* Ids, though
 677         --
 678         -- The domain of the VarEnv Level is the *post-cloned* Ids
 679
 680 initialEnv :: FloatOutSwitches -> LevelEnv
 681 initialEnv float_lams = (float_lams, emptyVarEnv, emptySubst, emptyVarEnv)
 682
 683 floatLams :: LevelEnv -> Bool
 684 floatLams (FloatOutSw float_lams _, _, _, _) = float_lams
 685
 686 floatConsts :: LevelEnv -> Bool
 687 floatConsts (FloatOutSw _ float_consts, _, _, _) = float_consts
 688
 689 extendLvlEnv :: LevelEnv -> [TaggedBndr Level] -> LevelEnv
 690 -- Used when *not* cloning
 691 extendLvlEnv (float_lams, lvl_env, subst, id_env) prs
 692   = (float_lams,
 693      foldl add_lvl lvl_env prs,
 694      foldl del_subst subst prs,
 695      foldl del_id id_env prs)
 696   where
 697     add_lvl   env (TB v l) = extendVarEnv env v l
 698     del_subst env (TB v _) = extendInScope env v
 699     del_id    env (TB v _) = delVarEnv env v
 700   -- We must remove any clone for this variable name in case of
 701   -- shadowing.  This bit me in the following case
 702   -- (in nofib/real/gg/Spark.hs):
 703   --
 704   --   case ds of wild {
 705   --     ... -> case e of wild {
 706   --              ... -> ... wild ...
 707   --            }
 708   --   }
 709   --
 710   -- The inside occurrence of @wild@ was being replaced with @ds@,
 711   -- incorrectly, because the SubstEnv was still lying around.  Ouch!
 712   -- KSW 2000-07.
 713
 714 -- extendCaseBndrLvlEnv adds the mapping case-bndr->scrut-var if it can
 715 -- (see point 4 of the module overview comment)
 716 extendCaseBndrLvlEnv :: LevelEnv -> Expr (TaggedBndr Level) -> Var -> Level
 717                      -> LevelEnv
 718 extendCaseBndrLvlEnv (float_lams, lvl_env, subst, id_env) (Var scrut_var) case_bndr lvl
 719   = (float_lams,
 720      extendVarEnv lvl_env case_bndr lvl,
 721      extendIdSubst subst case_bndr (Var scrut_var),
 722      extendVarEnv id_env case_bndr ([scrut_var], Var scrut_var))
 723
 724 extendCaseBndrLvlEnv env _scrut case_bndr lvl
 725   = extendLvlEnv          env [TB case_bndr lvl]
 726
 727 extendPolyLvlEnv :: Level -> LevelEnv -> [Var] -> [(Var, Var)] -> LevelEnv
 728 extendPolyLvlEnv dest_lvl (float_lams, lvl_env, subst, id_env) abs_vars bndr_pairs
 729   = (float_lams,
 730      foldl add_lvl   lvl_env bndr_pairs,
 731      foldl add_subst subst   bndr_pairs,
 732      foldl add_id    id_env  bndr_pairs)
 733   where
 734      add_lvl   env (_, v') = extendVarEnv env v' dest_lvl
 735      add_subst env (v, v') = extendIdSubst env v (mkVarApps (Var v') abs_vars)
 736      add_id    env (v, v') = extendVarEnv env v ((v':abs_vars), mkVarApps (Var v') abs_vars)
 737
 738 extendCloneLvlEnv :: Level -> LevelEnv -> Subst -> [(Var, Var)] -> LevelEnv
 739 extendCloneLvlEnv lvl (float_lams, lvl_env, _, id_env) new_subst bndr_pairs
 740   = (float_lams,
 741      foldl add_lvl   lvl_env bndr_pairs,
 742      new_subst,
 743      foldl add_id    id_env  bndr_pairs)
 744   where
 745      add_lvl env (_, v') = extendVarEnv env v' lvl
 746      add_id  env (v, v') = extendVarEnv env v ([v'], Var v')
 747
 748
 749 maxIdLevel :: LevelEnv -> VarSet -> Level
 750 maxIdLevel (_, lvl_env,_,id_env) var_set
 751   = foldVarSet max_in tOP_LEVEL var_set
 752   where
 753     max_in in_var lvl = foldr max_out lvl (case lookupVarEnv id_env in_var of
 754                                                 Just (abs_vars, _) -> abs_vars
 755                                                 Nothing            -> [in_var])
 756
 757     max_out out_var lvl
 758         | isId out_var = case lookupVarEnv lvl_env out_var of
 759                                 Just lvl' -> maxLvl lvl' lvl
 760                                 Nothing   -> lvl
 761         | otherwise    = lvl    -- Ignore tyvars in *maxIdLevel*
 762
 763 lookupVar :: LevelEnv -> Id -> LevelledExpr
 764 lookupVar (_, _, _, id_env) v = case lookupVarEnv id_env v of
 765                                        Just (_, expr) -> expr
 766                                        _              -> Var v
 767
 768 abstractVars :: Level -> LevelEnv -> VarSet -> [Var]
 769         -- Find the variables in fvs, free vars of the target expresion,
 770         -- whose level is greater than the destination level
 771         -- These are the ones we are going to abstract out
 772 abstractVars dest_lvl (_, lvl_env, _, id_env) fvs
 773   = map zap $ uniq $ sortLe le
 774         [var | fv <- varSetElems fvs
 775              , var <- absVarsOf id_env fv
 776              , abstract_me var ]
 777         -- NB: it's important to call abstract_me only on the OutIds the
 778         -- come from absVarsOf (not on fv, which is an InId)
 779   where
 780         -- Sort the variables so the true type variables come first;
 781         -- the tyvars scope over Ids and coercion vars
 782     v1 `le` v2 = case (is_tv v1, is_tv v2) of
 783                    (True, False) -> True
 784                    (False, True) -> False
 785                    _             -> v1 <= v2    -- Same family
 786
 787     is_tv v = isTyVar v && not (isCoVar v)
 788
 789     uniq :: [Var] -> [Var]
 790         -- Remove adjacent duplicates; the sort will have brought them together
 791     uniq (v1:v2:vs) | v1 == v2  = uniq (v2:vs)
 792                     | otherwise = v1 : uniq (v2:vs)
 793     uniq vs = vs
 794
 795     abstract_me v = case lookupVarEnv lvl_env v of
 796                         Just lvl -> dest_lvl `ltLvl` lvl
 797                         Nothing  -> False
 798
 799         -- We are going to lambda-abstract, so nuke any IdInfo,
 800         -- and add the tyvars of the Id (if necessary)
 801     zap v | isId v = WARN( workerExists (idWorkerInfo v) ||
 802                            not (isEmptySpecInfo (idSpecialisation v)),
 803                            text "absVarsOf: discarding info on" <+> ppr v )
 804                      setIdInfo v vanillaIdInfo
 805           | otherwise = v
 806
 807 absVarsOf :: IdEnv ([Var], LevelledExpr) -> Var -> [Var]
 808         -- If f is free in the expression, and f maps to poly_f a b c in the
 809         -- current substitution, then we must report a b c as candidate type
 810         -- variables
 811         --
 812         -- Also, if x::a is an abstracted variable, then so is a; that is,
 813         --      we must look in x's type
 814         -- And similarly if x is a coercion variable.
 815 absVarsOf id_env v
 816   | isId v    = [av2 | av1 <- lookup_avs v
 817                      , av2 <- add_tyvars av1]
 818   | isCoVar v = add_tyvars v
 819   | otherwise = [v]
 820
 821   where
 822     lookup_avs v = case lookupVarEnv id_env v of
 823                         Just (abs_vars, _) -> abs_vars
 824                         Nothing            -> [v]
 825
 826     add_tyvars v = v : varSetElems (varTypeTyVars v)
 827 \end{code}
 828
 829 \begin{code}
 830 type LvlM result = UniqSM result
 831
 832 initLvl :: UniqSupply -> UniqSM a -> a
 833 initLvl = initUs_
 834 \end{code}
 835
 836
 837 \begin{code}
 838 newPolyBndrs :: Level -> LevelEnv -> [Var] -> [Id] -> UniqSM (LevelEnv, [Id])
 839 newPolyBndrs dest_lvl env abs_vars bndrs = do
 840     uniqs <- getUniquesM
 841     let new_bndrs = zipWith mk_poly_bndr bndrs uniqs
 842     return (extendPolyLvlEnv dest_lvl env abs_vars (bndrs `zip` new_bndrs), new_bndrs)
 843   where
 844     mk_poly_bndr bndr uniq = transferPolyIdInfo bndr $  -- Note [transferPolyIdInfo] in Id.lhs
 845                              mkSysLocal (mkFastString str) uniq poly_ty
 846                            where
 847                              str     = "poly_" ++ occNameString (getOccName bndr)
 848                              poly_ty = mkPiTypes abs_vars (idType bndr)
 849
 850 newLvlVar :: String
 851           -> [CoreBndr] -> Type         -- Abstract wrt these bndrs
 852           -> LvlM Id
 853 newLvlVar str vars body_ty = do
 854     uniq <- getUniqueM
 855     return (mkSysLocal (mkFastString str) uniq (mkPiTypes vars body_ty))
 856
 857 -- The deeply tiresome thing is that we have to apply the substitution
 858 -- to the rules inside each Id.  Grr.  But it matters.
 859
 860 cloneVar :: TopLevelFlag -> LevelEnv -> Id -> Level -> Level -> LvlM (LevelEnv, Id)
 861 cloneVar TopLevel env v _ _
 862   = return (env, v)     -- Don't clone top level things
 863 cloneVar NotTopLevel env@(_,_,subst,_) v ctxt_lvl dest_lvl
 864   = ASSERT( isId v ) do
 865     us <- getUniqueSupplyM
 866     let
 867       (subst', v1) = cloneIdBndr subst us v
 868       v2           = zap_demand ctxt_lvl dest_lvl v1
 869       env'         = extendCloneLvlEnv dest_lvl env subst' [(v,v2)]
 870     return (env', v2)
 871
 872 cloneRecVars :: TopLevelFlag -> LevelEnv -> [Id] -> Level -> Level -> LvlM (LevelEnv, [Id])
 873 cloneRecVars TopLevel env vs _ _
 874   = return (env, vs)    -- Don't clone top level things
 875 cloneRecVars NotTopLevel env@(_,_,subst,_) vs ctxt_lvl dest_lvl
 876   = ASSERT( all isId vs ) do
 877     us <- getUniqueSupplyM
 878     let
 879       (subst', vs1) = cloneRecIdBndrs subst us vs
 880       vs2           = map (zap_demand ctxt_lvl dest_lvl) vs1
 881       env'          = extendCloneLvlEnv dest_lvl env subst' (vs `zip` vs2)
 882     return (env', vs2)
 883
 884         -- VERY IMPORTANT: we must zap the demand info
 885         -- if the thing is going to float out past a lambda,
 886         -- or if it's going to top level (where things can't be strict)
 887 zap_demand :: Level -> Level -> Id -> Id
 888 zap_demand dest_lvl ctxt_lvl id
 889   | ctxt_lvl == dest_lvl,
 890     not (isTopLvl dest_lvl) = id        -- Stays, and not going to top level
 891   | otherwise               = zapDemandIdInfo id        -- Floats out
 892 \end{code}
 893