cλash/CLasH/Normalize.hs

   1 {-# LANGUAGE PackageImports #-}
   2 --
   3 -- Functions to bring a Core expression in normal form. This module provides a
   4 -- top level function "normalize", and defines the actual transformation passes that
   5 -- are performed.
   6 --
   7 module CLasH.Normalize (getNormalized, normalizeExpr, splitNormalized) where
   8
   9 -- Standard modules
  10 import Debug.Trace
  11 import qualified Maybe
  12 import qualified List
  13 import qualified "transformers" Control.Monad.Trans as Trans
  14 import qualified Control.Monad as Monad
  15 import qualified Control.Monad.Trans.Writer as Writer
  16 import qualified Data.Map as Map
  17 import qualified Data.Monoid as Monoid
  18 import Data.Accessor
  19
  20 -- GHC API
  21 import CoreSyn
  22 import qualified UniqSupply
  23 import qualified CoreUtils
  24 import qualified Type
  25 import qualified TcType
  26 import qualified Name
  27 import qualified Id
  28 import qualified Var
  29 import qualified VarSet
  30 import qualified NameSet
  31 import qualified CoreFVs
  32 import qualified CoreUtils
  33 import qualified MkCore
  34 import qualified HscTypes
  35 import Outputable ( showSDoc, ppr, nest )
  36
  37 -- Local imports
  38 import CLasH.Normalize.NormalizeTypes
  39 import CLasH.Translator.TranslatorTypes
  40 import CLasH.Normalize.NormalizeTools
  41 import CLasH.VHDL.VHDLTypes
  42 import qualified CLasH.Utils as Utils
  43 import CLasH.Utils.Core.CoreTools
  44 import CLasH.Utils.Core.BinderTools
  45 import CLasH.Utils.Pretty
  46
  47 --------------------------------
  48 -- Start of transformations
  49 --------------------------------
  50
  51 --------------------------------
  52 -- η abstraction
  53 --------------------------------
  54 eta, etatop :: Transform
  55 eta expr | is_fun expr && not (is_lam expr) = do
  56   let arg_ty = (fst . Type.splitFunTy . CoreUtils.exprType) expr
  57   id <- Trans.lift $ mkInternalVar "param" arg_ty
  58   change (Lam id (App expr (Var id)))
  59 -- Leave all other expressions unchanged
  60 eta e = return e
  61 etatop = notappargs ("eta", eta)
  62
  63 --------------------------------
  64 -- β-reduction
  65 --------------------------------
  66 beta, betatop :: Transform
  67 -- Substitute arg for x in expr. For value lambda's, also clone before
  68 -- substitution.
  69 beta (App (Lam x expr) arg) | CoreSyn.isTyVar x = setChanged >> substitute x arg expr
  70                             | otherwise      = setChanged >> substitute_clone x arg expr
  71 -- Propagate the application into the let
  72 beta (App (Let binds expr) arg) = change $ Let binds (App expr arg)
  73 -- Propagate the application into each of the alternatives
  74 beta (App (Case scrut b ty alts) arg) = change $ Case scrut b ty' alts'
  75   where
  76     alts' = map (\(con, bndrs, expr) -> (con, bndrs, (App expr arg))) alts
  77     ty' = CoreUtils.applyTypeToArg ty arg
  78 -- Leave all other expressions unchanged
  79 beta expr = return expr
  80 -- Perform this transform everywhere
  81 betatop = everywhere ("beta", beta)
  82
  83 --------------------------------
  84 -- Cast propagation
  85 --------------------------------
  86 -- Try to move casts as much downward as possible.
  87 castprop, castproptop :: Transform
  88 castprop (Cast (Let binds expr) ty) = change $ Let binds (Cast expr ty)
  89 castprop expr@(Cast (Case scrut b _ alts) ty) = change (Case scrut b ty alts')
  90   where
  91     alts' = map (\(con, bndrs, expr) -> (con, bndrs, (Cast expr ty))) alts
  92 -- Leave all other expressions unchanged
  93 castprop expr = return expr
  94 -- Perform this transform everywhere
  95 castproptop = everywhere ("castprop", castprop)
  96
  97 --------------------------------
  98 -- Cast simplification. Mostly useful for state packing and unpacking, but
  99 -- perhaps for others as well.
 100 --------------------------------
 101 castsimpl, castsimpltop :: Transform
 102 castsimpl expr@(Cast val ty) = do
 103   -- Don't extract values that are already simpl
 104   local_var <- Trans.lift $ is_local_var val
 105   -- Don't extract values that are not representable, to prevent loops with
 106   -- inlinenonrep
 107   repr <- isRepr val
 108   if (not local_var) && repr
 109     then do
 110       -- Generate a binder for the expression
 111       id <- Trans.lift $ mkBinderFor val "castval"
 112       -- Extract the expression
 113       change $ Let (NonRec id val) (Cast (Var id) ty)
 114     else
 115       return expr
 116 -- Leave all other expressions unchanged
 117 castsimpl expr = return expr
 118 -- Perform this transform everywhere
 119 castsimpltop = everywhere ("castsimpl", castsimpl)
 120
 121
 122 --------------------------------
 123 -- Lambda simplication
 124 --------------------------------
 125 -- Ensure that a lambda always evaluates to a let expressions or a simple
 126 -- variable reference.
 127 lambdasimpl, lambdasimpltop :: Transform
 128 -- Don't simplify a lambda that evaluates to let, since this is already
 129 -- normal form (and would cause infinite loops).
 130 lambdasimpl expr@(Lam _ (Let _ _)) = return expr
 131 -- Put the of a lambda in its own binding, but not when the expression is
 132 -- already a local variable, or not representable (to prevent loops with
 133 -- inlinenonrep).
 134 lambdasimpl expr@(Lam bndr res) = do
 135   repr <- isRepr res
 136   local_var <- Trans.lift $ is_local_var res
 137   if not local_var && repr
 138     then do
 139       id <- Trans.lift $ mkBinderFor res "res"
 140       change $ Lam bndr (Let (NonRec id res) (Var id))
 141     else
 142       -- If the result is already a local var or not representable, don't
 143       -- extract it.
 144       return expr
 145
 146 -- Leave all other expressions unchanged
 147 lambdasimpl expr = return expr
 148 -- Perform this transform everywhere
 149 lambdasimpltop = everywhere ("lambdasimpl", lambdasimpl)
 150
 151 --------------------------------
 152 -- let derecursification
 153 --------------------------------
 154 letderec, letderectop :: Transform
 155 letderec expr@(Let (Rec binds) res) = case liftable of
 156   -- Nothing is liftable, just return
 157   [] -> return expr
 158   -- Something can be lifted, generate a new let expression
 159   _ -> change $ mkNonRecLets liftable (Let (Rec nonliftable) res)
 160   where
 161     -- Make a list of all the binders bound in this recursive let
 162     bndrs = map fst binds
 163     -- See which bindings are liftable
 164     (liftable, nonliftable) = List.partition canlift binds
 165     -- Any expression that does not use any of the binders in this recursive let
 166     -- can be lifted into a nonrec let. It can't use its own binder either,
 167     -- since that would mean the binding is self-recursive and should be in a
 168     -- single bind recursive let.
 169     canlift (bndr, e) = not $ expr_uses_binders bndrs e
 170 -- Leave all other expressions unchanged
 171 letderec expr = return expr
 172 -- Perform this transform everywhere
 173 letderectop = everywhere ("letderec", letderec)
 174
 175 --------------------------------
 176 -- let simplification
 177 --------------------------------
 178 letsimpl, letsimpltop :: Transform
 179 -- Don't simplify a let that evaluates to another let, since this is already
 180 -- normal form (and would cause infinite loops with letflat below).
 181 letsimpl expr@(Let _ (Let _ _)) = return expr
 182 -- Put the "in ..." value of a let in its own binding, but not when the
 183 -- expression is already a local variable, or not representable (to prevent loops with inlinenonrep).
 184 letsimpl expr@(Let binds res) = do
 185   repr <- isRepr res
 186   local_var <- Trans.lift $ is_local_var res
 187   if not local_var && repr
 188     then do
 189       -- If the result is not a local var already (to prevent loops with
 190       -- ourselves), extract it.
 191       id <- Trans.lift $ mkBinderFor res "foo"
 192       change $ Let binds (Let (NonRec id  res) (Var id))
 193     else
 194       -- If the result is already a local var, don't extract it.
 195       return expr
 196
 197 -- Leave all other expressions unchanged
 198 letsimpl expr = return expr
 199 -- Perform this transform everywhere
 200 letsimpltop = everywhere ("letsimpl", letsimpl)
 201
 202 --------------------------------
 203 -- let flattening
 204 --------------------------------
 205 -- Takes a let that binds another let, and turns that into two nested lets.
 206 -- e.g., from:
 207 -- let b = (let b' = expr' in res') in res
 208 -- to:
 209 -- let b' = expr' in (let b = res' in res)
 210 letflat, letflattop :: Transform
 211 -- Turn a nonrec let that binds a let into two nested lets.
 212 letflat (Let (NonRec b (Let binds  res')) res) =
 213   change $ Let binds (Let (NonRec b res') res)
 214 letflat (Let (Rec binds) expr) = do
 215   -- Flatten each binding.
 216   binds' <- Utils.concatM $ Monad.mapM flatbind binds
 217   -- Return the new let. We don't use change here, since possibly nothing has
 218   -- changed. If anything has changed, flatbind has already flagged that
 219   -- change.
 220   return $ Let (Rec binds') expr
 221   where
 222     -- Turns a binding of a let into a multiple bindings, or any other binding
 223     -- into a list with just that binding
 224     flatbind :: (CoreBndr, CoreExpr) -> TransformMonad [(CoreBndr, CoreExpr)]
 225     flatbind (b, Let (Rec binds) expr) = change ((b, expr):binds)
 226     flatbind (b, Let (NonRec b' expr') expr) = change [(b, expr), (b', expr')]
 227     flatbind (b, expr) = return [(b, expr)]
 228 -- Leave all other expressions unchanged
 229 letflat expr = return expr
 230 -- Perform this transform everywhere
 231 letflattop = everywhere ("letflat", letflat)
 232
 233 --------------------------------
 234 -- empty let removal
 235 --------------------------------
 236 -- Remove empty (recursive) lets
 237 letremove, letremovetop :: Transform
 238 letremove (Let (Rec []) res) = change $ res
 239 -- Leave all other expressions unchanged
 240 letremove expr = return expr
 241 -- Perform this transform everywhere
 242 letremovetop = everywhere ("letremove", letremove)
 243
 244 --------------------------------
 245 -- Simple let binding removal
 246 --------------------------------
 247 -- Remove a = b bindings from let expressions everywhere
 248 letremovesimpletop :: Transform
 249 letremovesimpletop = everywhere ("letremovesimple", inlinebind (\(b, e) -> Trans.lift $ is_local_var e))
 250
 251 --------------------------------
 252 -- Unused let binding removal
 253 --------------------------------
 254 letremoveunused, letremoveunusedtop :: Transform
 255 letremoveunused expr@(Let (NonRec b bound) res) = do
 256   let used = expr_uses_binders [b] res
 257   if used
 258     then return expr
 259     else change res
 260 letremoveunused expr@(Let (Rec binds) res) = do
 261   -- Filter out all unused binds.
 262   let binds' = filter dobind binds
 263   -- Only set the changed flag if binds got removed
 264   changeif (length binds' /= length binds) (Let (Rec binds') res)
 265     where
 266       bound_exprs = map snd binds
 267       -- For each bind check if the bind is used by res or any of the bound
 268       -- expressions
 269       dobind (bndr, _) = any (expr_uses_binders [bndr]) (res:bound_exprs)
 270 -- Leave all other expressions unchanged
 271 letremoveunused expr = return expr
 272 letremoveunusedtop = everywhere ("letremoveunused", letremoveunused)
 273
 274 {-
 275 --------------------------------
 276 -- Identical let binding merging
 277 --------------------------------
 278 -- Merge two bindings in a let if they are identical
 279 -- TODO: We would very much like to use GHC's CSE module for this, but that
 280 -- doesn't track if something changed or not, so we can't use it properly.
 281 letmerge, letmergetop :: Transform
 282 letmerge expr@(Let _ _) = do
 283   let (binds, res) = flattenLets expr
 284   binds' <- domerge binds
 285   return $ mkNonRecLets binds' res
 286   where
 287     domerge :: [(CoreBndr, CoreExpr)] -> TransformMonad [(CoreBndr, CoreExpr)]
 288     domerge [] = return []
 289     domerge (e:es) = do
 290       es' <- mapM (mergebinds e) es
 291       es'' <- domerge es'
 292       return (e:es'')
 293
 294     -- Uses the second bind to simplify the second bind, if applicable.
 295     mergebinds :: (CoreBndr, CoreExpr) -> (CoreBndr, CoreExpr) -> TransformMonad (CoreBndr, CoreExpr)
 296     mergebinds (b1, e1) (b2, e2)
 297       -- Identical expressions? Replace the second binding with a reference to
 298       -- the first binder.
 299       | CoreUtils.cheapEqExpr e1 e2 = change $ (b2, Var b1)
 300       -- Different expressions? Don't change
 301       | otherwise = return (b2, e2)
 302 -- Leave all other expressions unchanged
 303 letmerge expr = return expr
 304 letmergetop = everywhere ("letmerge", letmerge)
 305 -}
 306
 307 --------------------------------
 308 -- Non-representable binding inlining
 309 --------------------------------
 310 -- Remove a = B bindings, with B of a non-representable type, from let
 311 -- expressions everywhere. This means that any value that we can't generate a
 312 -- signal for, will be inlined and hopefully turned into something we can
 313 -- represent.
 314 --
 315 -- This is a tricky function, which is prone to create loops in the
 316 -- transformations. To fix this, we make sure that no transformation will
 317 -- create a new let binding with a non-representable type. These other
 318 -- transformations will just not work on those function-typed values at first,
 319 -- but the other transformations (in particular β-reduction) should make sure
 320 -- that the type of those values eventually becomes representable.
 321 inlinenonreptop :: Transform
 322 inlinenonreptop = everywhere ("inlinenonrep", inlinebind ((Monad.liftM not) . isRepr . snd))
 323
 324 inlinetoplevel, inlinetopleveltop :: Transform
 325 -- Any system name is candidate for inlining. Never inline user-defined
 326 -- functions, to preserve structure.
 327 inlinetoplevel expr@(Var f) | not $ isUserDefined f = do
 328   norm <- isNormalizeable f
 329   -- See if this is a top level binding for which we have a body
 330   body_maybe <- Trans.lift $ getGlobalBind f
 331   if norm && Maybe.isJust body_maybe
 332     then do
 333       -- Get the normalized version
 334       norm <- Trans.lift $ getNormalized f
 335       if needsInline norm
 336         then do
 337           -- Regenerate all uniques in the to-be-inlined expression
 338           norm_uniqued <- Trans.lift $ genUniques norm
 339           change norm_uniqued
 340         else
 341           return expr
 342     else
 343       -- No body or not normalizeable.
 344       return expr
 345 -- Leave all other expressions unchanged
 346 inlinetoplevel expr = return expr
 347 inlinetopleveltop = everywhere ("inlinetoplevel", inlinetoplevel)
 348
 349 needsInline :: CoreExpr -> Bool
 350 needsInline expr = case splitNormalized expr of
 351   -- Inline any function that only has a single definition, it is probably
 352   -- simple enough. This might inline some stuff that it shouldn't though it
 353   -- will never inline user-defined functions (inlinetoplevel only tries
 354   -- system names) and inlining should never break things.
 355   (args, [bind], res) -> True
 356   _ -> False
 357
 358 --------------------------------
 359 -- Scrutinee simplification
 360 --------------------------------
 361 scrutsimpl,scrutsimpltop :: Transform
 362 -- Don't touch scrutinees that are already simple
 363 scrutsimpl expr@(Case (Var _) _ _ _) = return expr
 364 -- Replace all other cases with a let that binds the scrutinee and a new
 365 -- simple scrutinee, but only when the scrutinee is representable (to prevent
 366 -- loops with inlinenonrep, though I don't think a non-representable scrutinee
 367 -- will be supported anyway...)
 368 scrutsimpl expr@(Case scrut b ty alts) = do
 369   repr <- isRepr scrut
 370   if repr
 371     then do
 372       id <- Trans.lift $ mkBinderFor scrut "scrut"
 373       change $ Let (NonRec id scrut) (Case (Var id) b ty alts)
 374     else
 375       return expr
 376 -- Leave all other expressions unchanged
 377 scrutsimpl expr = return expr
 378 -- Perform this transform everywhere
 379 scrutsimpltop = everywhere ("scrutsimpl", scrutsimpl)
 380
 381 --------------------------------
 382 -- Case binder wildening
 383 --------------------------------
 384 casesimpl, casesimpltop :: Transform
 385 -- This is already a selector case (or, if x does not appear in bndrs, a very
 386 -- simple case statement that will be removed by caseremove below). Just leave
 387 -- it be.
 388 casesimpl expr@(Case scrut b ty [(con, bndrs, Var x)]) = return expr
 389 -- Make sure that all case alternatives have only wild binders and simple
 390 -- expressions.
 391 -- This is done by creating a new let binding for each non-wild binder, which
 392 -- is bound to a new simple selector case statement and for each complex
 393 -- expression. We do this only for representable types, to prevent loops with
 394 -- inlinenonrep.
 395 casesimpl expr@(Case scrut b ty alts) = do
 396   (bindingss, alts') <- (Monad.liftM unzip) $ mapM doalt alts
 397   let bindings = concat bindingss
 398   -- Replace the case with a let with bindings and a case
 399   let newlet = mkNonRecLets bindings (Case scrut b ty alts')
 400   -- If there are no non-wild binders, or this case is already a simple
 401   -- selector (i.e., a single alt with exactly one binding), already a simple
 402   -- selector altan no bindings (i.e., no wild binders in the original case),
 403   -- don't change anything, otherwise, replace the case.
 404   if null bindings then return expr else change newlet
 405   where
 406   -- Generate a single wild binder, since they are all the same
 407   wild = MkCore.mkWildBinder
 408   -- Wilden the binders of one alt, producing a list of bindings as a
 409   -- sideeffect.
 410   doalt :: CoreAlt -> TransformMonad ([(CoreBndr, CoreExpr)], CoreAlt)
 411   doalt (con, bndrs, expr) = do
 412     -- Make each binder wild, if possible
 413     bndrs_res <- Monad.zipWithM dobndr bndrs [0..]
 414     let (newbndrs, bindings_maybe) = unzip bndrs_res
 415     -- Extract a complex expression, if possible. For this we check if any of
 416     -- the new list of bndrs are used by expr. We can't use free_vars here,
 417     -- since that looks at the old bndrs.
 418     let uses_bndrs = not $ VarSet.isEmptyVarSet $ CoreFVs.exprSomeFreeVars (`elem` newbndrs) $ expr
 419     (exprbinding_maybe, expr') <- doexpr expr uses_bndrs
 420     -- Create a new alternative
 421     let newalt = (con, newbndrs, expr')
 422     let bindings = Maybe.catMaybes (bindings_maybe ++ [exprbinding_maybe])
 423     return (bindings, newalt)
 424     where
 425       -- Make wild alternatives for each binder
 426       wildbndrs = map (\bndr -> MkCore.mkWildBinder (Id.idType bndr)) bndrs
 427       -- A set of all the binders that are used by the expression
 428       free_vars = CoreFVs.exprSomeFreeVars (`elem` bndrs) expr
 429       -- Look at the ith binder in the case alternative. Return a new binder
 430       -- for it (either the same one, or a wild one) and optionally a let
 431       -- binding containing a case expression.
 432       dobndr :: CoreBndr -> Int -> TransformMonad (CoreBndr, Maybe (CoreBndr, CoreExpr))
 433       dobndr b i = do
 434         repr <- isRepr b
 435         -- Is b wild (e.g., not a free var of expr. Since b is only in scope
 436         -- in expr, this means that b is unused if expr does not use it.)
 437         let wild = not (VarSet.elemVarSet b free_vars)
 438         -- Create a new binding for any representable binder that is not
 439         -- already wild and is representable (to prevent loops with
 440         -- inlinenonrep).
 441         if (not wild) && repr
 442           then do
 443             -- Create on new binder that will actually capture a value in this
 444             -- case statement, and return it.
 445             let bty = (Id.idType b)
 446             id <- Trans.lift $ mkInternalVar "sel" bty
 447             let binders = take i wildbndrs ++ [id] ++ drop (i+1) wildbndrs
 448             let caseexpr = Case scrut b bty [(con, binders, Var id)]
 449             return (wildbndrs!!i, Just (b, caseexpr))
 450           else
 451             -- Just leave the original binder in place, and don't generate an
 452             -- extra selector case.
 453             return (b, Nothing)
 454       -- Process the expression of a case alternative. Accepts an expression
 455       -- and whether this expression uses any of the binders in the
 456       -- alternative. Returns an optional new binding and a new expression.
 457       doexpr :: CoreExpr -> Bool -> TransformMonad (Maybe (CoreBndr, CoreExpr), CoreExpr)
 458       doexpr expr uses_bndrs = do
 459         local_var <- Trans.lift $ is_local_var expr
 460         repr <- isRepr expr
 461         -- Extract any expressions that do not use any binders from this
 462         -- alternative, is not a local var already and is representable (to
 463         -- prevent loops with inlinenonrep).
 464         if (not uses_bndrs) && (not local_var) && repr
 465           then do
 466             id <- Trans.lift $ mkBinderFor expr "caseval"
 467             -- We don't flag a change here, since casevalsimpl will do that above
 468             -- based on Just we return here.
 469             return $ (Just (id, expr), Var id)
 470           else
 471             -- Don't simplify anything else
 472             return (Nothing, expr)
 473 -- Leave all other expressions unchanged
 474 casesimpl expr = return expr
 475 -- Perform this transform everywhere
 476 casesimpltop = everywhere ("casesimpl", casesimpl)
 477
 478 --------------------------------
 479 -- Case removal
 480 --------------------------------
 481 -- Remove case statements that have only a single alternative and only wild
 482 -- binders.
 483 caseremove, caseremovetop :: Transform
 484 -- Replace a useless case by the value of its single alternative
 485 caseremove (Case scrut b ty [(con, bndrs, expr)]) | not usesvars = change expr
 486     -- Find if any of the binders are used by expr
 487     where usesvars = (not . VarSet.isEmptyVarSet . (CoreFVs.exprSomeFreeVars (`elem` bndrs))) expr
 488 -- Leave all other expressions unchanged
 489 caseremove expr = return expr
 490 -- Perform this transform everywhere
 491 caseremovetop = everywhere ("caseremove", caseremove)
 492
 493 --------------------------------
 494 -- Argument extraction
 495 --------------------------------
 496 -- Make sure that all arguments of a representable type are simple variables.
 497 appsimpl, appsimpltop :: Transform
 498 -- Simplify all representable arguments. Do this by introducing a new Let
 499 -- that binds the argument and passing the new binder in the application.
 500 appsimpl expr@(App f arg) = do
 501   -- Check runtime representability
 502   repr <- isRepr arg
 503   local_var <- Trans.lift $ is_local_var arg
 504   if repr && not local_var
 505     then do -- Extract representable arguments
 506       id <- Trans.lift $ mkBinderFor arg "arg"
 507       change $ Let (NonRec id arg) (App f (Var id))
 508     else -- Leave non-representable arguments unchanged
 509       return expr
 510 -- Leave all other expressions unchanged
 511 appsimpl expr = return expr
 512 -- Perform this transform everywhere
 513 appsimpltop = everywhere ("appsimpl", appsimpl)
 514
 515 --------------------------------
 516 -- Function-typed argument propagation
 517 --------------------------------
 518 -- Remove all applications to function-typed arguments, by duplication the
 519 -- function called with the function-typed parameter replaced by the free
 520 -- variables of the argument passed in.
 521 argprop, argproptop :: Transform
 522 -- Transform any application of a named function (i.e., skip applications of
 523 -- lambda's). Also skip applications that have arguments with free type
 524 -- variables, since we can't inline those.
 525 argprop expr@(App _ _) | is_var fexpr = do
 526   -- Find the body of the function called
 527   body_maybe <- Trans.lift $ getGlobalBind f
 528   case body_maybe of
 529     Just body -> do
 530       -- Process each of the arguments in turn
 531       (args', changed) <- Writer.listen $ mapM doarg args
 532       -- See if any of the arguments changed
 533       case Monoid.getAny changed of
 534         True -> do
 535           let (newargs', newparams', oldargs) = unzip3 args'
 536           let newargs = concat newargs'
 537           let newparams = concat newparams'
 538           -- Create a new body that consists of a lambda for all new arguments and
 539           -- the old body applied to some arguments.
 540           let newbody = MkCore.mkCoreLams newparams (MkCore.mkCoreApps body oldargs)
 541           -- Create a new function with the same name but a new body
 542           newf <- Trans.lift $ mkFunction f newbody
 543           -- Replace the original application with one of the new function to the
 544           -- new arguments.
 545           change $ MkCore.mkCoreApps (Var newf) newargs
 546         False ->
 547           -- Don't change the expression if none of the arguments changed
 548           return expr
 549
 550     -- If we don't have a body for the function called, leave it unchanged (it
 551     -- should be a primitive function then).
 552     Nothing -> return expr
 553   where
 554     -- Find the function called and the arguments
 555     (fexpr, args) = collectArgs expr
 556     Var f = fexpr
 557
 558     -- Process a single argument and return (args, bndrs, arg), where args are
 559     -- the arguments to replace the given argument in the original
 560     -- application, bndrs are the binders to include in the top-level lambda
 561     -- in the new function body, and arg is the argument to apply to the old
 562     -- function body.
 563     doarg :: CoreExpr -> TransformMonad ([CoreExpr], [CoreBndr], CoreExpr)
 564     doarg arg = do
 565       repr <- isRepr arg
 566       bndrs <- Trans.lift getGlobalBinders
 567       let interesting var = Var.isLocalVar var && (not $ var `elem` bndrs)
 568       if not repr && not (is_var arg && interesting (exprToVar arg)) && not (has_free_tyvars arg)
 569         then do
 570           -- Propagate all complex arguments that are not representable, but not
 571           -- arguments with free type variables (since those would require types
 572           -- not known yet, which will always be known eventually).
 573           -- Find interesting free variables, each of which should be passed to
 574           -- the new function instead of the original function argument.
 575           --
 576           -- Interesting vars are those that are local, but not available from the
 577           -- top level scope (functions from this module are defined as local, but
 578           -- they're not local to this function, so we can freely move references
 579           -- to them into another function).
 580           let free_vars = VarSet.varSetElems $ CoreFVs.exprSomeFreeVars interesting arg
 581           -- Mark the current expression as changed
 582           setChanged
 583           return (map Var free_vars, free_vars, arg)
 584         else do
 585           -- Representable types will not be propagated, and arguments with free
 586           -- type variables will be propagated later.
 587           -- TODO: preserve original naming?
 588           id <- Trans.lift $ mkBinderFor arg "param"
 589           -- Just pass the original argument to the new function, which binds it
 590           -- to a new id and just pass that new id to the old function body.
 591           return ([arg], [id], mkReferenceTo id)
 592 -- Leave all other expressions unchanged
 593 argprop expr = return expr
 594 -- Perform this transform everywhere
 595 argproptop = everywhere ("argprop", argprop)
 596
 597 --------------------------------
 598 -- Function-typed argument extraction
 599 --------------------------------
 600 -- This transform takes any function-typed argument that cannot be propagated
 601 -- (because the function that is applied to it is a builtin function), and
 602 -- puts it in a brand new top level binder. This allows us to for example
 603 -- apply map to a lambda expression This will not conflict with inlinenonrep,
 604 -- since that only inlines local let bindings, not top level bindings.
 605 funextract, funextracttop :: Transform
 606 funextract expr@(App _ _) | is_var fexpr = do
 607   body_maybe <- Trans.lift $ getGlobalBind f
 608   case body_maybe of
 609     -- We don't have a function body for f, so we can perform this transform.
 610     Nothing -> do
 611       -- Find the new arguments
 612       args' <- mapM doarg args
 613       -- And update the arguments. We use return instead of changed, so the
 614       -- changed flag doesn't get set if none of the args got changed.
 615       return $ MkCore.mkCoreApps fexpr args'
 616     -- We have a function body for f, leave this application to funprop
 617     Just _ -> return expr
 618   where
 619     -- Find the function called and the arguments
 620     (fexpr, args) = collectArgs expr
 621     Var f = fexpr
 622     -- Change any arguments that have a function type, but are not simple yet
 623     -- (ie, a variable or application). This means to create a new function
 624     -- for map (\f -> ...) b, but not for map (foo a) b.
 625     --
 626     -- We could use is_applicable here instead of is_fun, but I think
 627     -- arguments to functions could only have forall typing when existential
 628     -- typing is enabled. Not sure, though.
 629     doarg arg | not (is_simple arg) && is_fun arg = do
 630       -- Create a new top level binding that binds the argument. Its body will
 631       -- be extended with lambda expressions, to take any free variables used
 632       -- by the argument expression.
 633       let free_vars = VarSet.varSetElems $ CoreFVs.exprFreeVars arg
 634       let body = MkCore.mkCoreLams free_vars arg
 635       id <- Trans.lift $ mkBinderFor body "fun"
 636       Trans.lift $ addGlobalBind id body
 637       -- Replace the argument with a reference to the new function, applied to
 638       -- all vars it uses.
 639       change $ MkCore.mkCoreApps (Var id) (map Var free_vars)
 640     -- Leave all other arguments untouched
 641     doarg arg = return arg
 642
 643 -- Leave all other expressions unchanged
 644 funextract expr = return expr
 645 -- Perform this transform everywhere
 646 funextracttop = everywhere ("funextract", funextract)
 647
 648 --------------------------------
 649 -- Ensure that a function that just returns another function (or rather,
 650 -- another top-level binder) is still properly normalized. This is a temporary
 651 -- solution, we should probably integrate this pass with lambdasimpl and
 652 -- letsimpl instead.
 653 --------------------------------
 654 simplrestop expr@(Lam _ _) = return expr
 655 simplrestop expr@(Let _ _) = return expr
 656 simplrestop expr = do
 657   local_var <- Trans.lift $ is_local_var expr
 658   -- Don't extract values that are not representable, to prevent loops with
 659   -- inlinenonrep
 660   repr <- isRepr expr
 661   if local_var || not repr
 662     then
 663       return expr
 664     else do
 665       id <- Trans.lift $ mkBinderFor expr "res"
 666       change $ Let (NonRec id expr) (Var id)
 667 --------------------------------
 668 -- End of transformations
 669 --------------------------------
 670
 671
 672
 673
 674 -- What transforms to run?
 675 transforms = [inlinetopleveltop, argproptop, funextracttop, etatop, betatop, castproptop, letremovesimpletop, letderectop, letremovetop, letsimpltop, letflattop, scrutsimpltop, casesimpltop, caseremovetop, inlinenonreptop, appsimpltop, letremoveunusedtop, castsimpltop, lambdasimpltop, simplrestop]
 676
 677 -- | Returns the normalized version of the given function.
 678 getNormalized ::
 679   CoreBndr -- ^ The function to get
 680   -> TranslatorSession CoreExpr -- The normalized function body
 681
 682 getNormalized bndr = Utils.makeCached bndr tsNormalized $ do
 683   if is_poly (Var bndr)
 684     then
 685       -- This should really only happen at the top level... TODO: Give
 686       -- a different error if this happens down in the recursion.
 687       error $ "\nNormalize.normalizeBind: Function " ++ show bndr ++ " is polymorphic, can't normalize"
 688     else do
 689       expr <- getBinding bndr
 690       normalizeExpr (show bndr) expr
 691
 692 -- | Normalize an expression
 693 normalizeExpr ::
 694   String -- ^ What are we normalizing? For debug output only.
 695   -> CoreSyn.CoreExpr -- ^ The expression to normalize
 696   -> TranslatorSession CoreSyn.CoreExpr -- ^ The normalized expression
 697
 698 normalizeExpr what expr = do
 699       expr_uniqued <- genUniques expr
 700       -- Normalize this expression
 701       trace (what ++ " before normalization:\n\n" ++ showSDoc ( ppr expr_uniqued ) ++ "\n") $ return ()
 702       expr' <- dotransforms transforms expr_uniqued
 703       trace ("\n" ++ what ++ " after normalization:\n\n" ++ showSDoc ( ppr expr')) $ return ()
 704       return expr'
 705
 706 -- | Get the value that is bound to the given binder at top level. Fails when
 707 --   there is no such binding.
 708 getBinding ::
 709   CoreBndr -- ^ The binder to get the expression for
 710   -> TranslatorSession CoreExpr -- ^ The value bound to the binder
 711
 712 getBinding bndr = Utils.makeCached bndr tsBindings $ do
 713   -- If the binding isn't in the "cache" (bindings map), then we can't create
 714   -- it out of thin air, so return an error.
 715   error $ "Normalize.getBinding: Unknown function requested: " ++ show bndr
 716
 717 -- | Split a normalized expression into the argument binders, top level
 718 --   bindings and the result binder.
 719 splitNormalized ::
 720   CoreExpr -- ^ The normalized expression
 721   -> ([CoreBndr], [Binding], CoreBndr)
 722 splitNormalized expr = (args, binds, res)
 723   where
 724     (args, letexpr) = CoreSyn.collectBinders expr
 725     (binds, resexpr) = flattenLets letexpr
 726     res = case resexpr of
 727       (Var x) -> x
 728       _ -> error $ "Normalize.splitNormalized: Not in normal form: " ++ pprString expr ++ "\n"