clash/CLasH/Normalize.hs

   1 --
   2 -- Functions to bring a Core expression in normal form. This module provides a
   3 -- top level function "normalize", and defines the actual transformation passes that
   4 -- are performed.
   5 --
   6 module CLasH.Normalize (getNormalized, normalizeExpr, splitNormalized) where
   7
   8 -- Standard modules
   9 import Debug.Trace
  10 import qualified Maybe
  11 import qualified List
  12 import qualified Control.Monad.Trans.Class as Trans
  13 import qualified Control.Monad as Monad
  14 import qualified Control.Monad.Trans.Writer as Writer
  15 import qualified Data.Accessor.Monad.Trans.State as MonadState
  16 import qualified Data.Monoid as Monoid
  17 import qualified Data.Map as Map
  18
  19 -- GHC API
  20 import CoreSyn
  21 import qualified CoreUtils
  22 import qualified BasicTypes
  23 import qualified Type
  24 import qualified TysWiredIn
  25 import qualified Id
  26 import qualified Var
  27 import qualified Name
  28 import qualified DataCon
  29 import qualified VarSet
  30 import qualified CoreFVs
  31 import qualified Class
  32 import qualified MkCore
  33 import Outputable ( showSDoc, ppr, nest )
  34
  35 -- Local imports
  36 import CLasH.Normalize.NormalizeTypes
  37 import CLasH.Translator.TranslatorTypes
  38 import CLasH.Normalize.NormalizeTools
  39 import CLasH.VHDL.Constants (builtinIds)
  40 import qualified CLasH.Utils as Utils
  41 import CLasH.Utils.Core.CoreTools
  42 import CLasH.Utils.Core.BinderTools
  43 import CLasH.Utils.Pretty
  44
  45 ----------------------------------------------------------------
  46 -- Cleanup transformations
  47 ----------------------------------------------------------------
  48
  49 --------------------------------
  50 -- β-reduction
  51 --------------------------------
  52 beta :: Transform
  53 -- Substitute arg for x in expr. For value lambda's, also clone before
  54 -- substitution.
  55 beta c (App (Lam x expr) arg) | CoreSyn.isTyVar x = setChanged >> substitute x arg c expr
  56                               | otherwise         = setChanged >> substitute_clone x arg c expr
  57 -- Leave all other expressions unchanged
  58 beta c expr = return expr
  59
  60 --------------------------------
  61 -- Unused let binding removal
  62 --------------------------------
  63 letremoveunused :: Transform
  64 letremoveunused c expr@(Let (NonRec b bound) res) = do
  65   let used = expr_uses_binders [b] res
  66   if used
  67     then return expr
  68     else change res
  69 letremoveunused c expr@(Let (Rec binds) res) = do
  70   -- Filter out all unused binds.
  71   let binds' = filter dobind binds
  72   -- Only set the changed flag if binds got removed
  73   changeif (length binds' /= length binds) (Let (Rec binds') res)
  74     where
  75       bound_exprs = map snd binds
  76       -- For each bind check if the bind is used by res or any of the bound
  77       -- expressions
  78       dobind (bndr, _) = any (expr_uses_binders [bndr]) (res:bound_exprs)
  79 -- Leave all other expressions unchanged
  80 letremoveunused c expr = return expr
  81
  82 --------------------------------
  83 -- empty let removal
  84 --------------------------------
  85 -- Remove empty (recursive) lets
  86 letremove :: Transform
  87 letremove c (Let (Rec []) res) = change res
  88 -- Leave all other expressions unchanged
  89 letremove c expr = return expr
  90
  91 --------------------------------
  92 -- Simple let binding removal
  93 --------------------------------
  94 -- Remove a = b bindings from let expressions everywhere
  95 letremovesimple :: Transform
  96 letremovesimple = inlinebind (\(b, e) -> Trans.lift $ is_local_var e)
  97
  98 --------------------------------
  99 -- Cast propagation
 100 --------------------------------
 101 -- Try to move casts as much downward as possible.
 102 castprop :: Transform
 103 castprop c (Cast (Let binds expr) ty) = change $ Let binds (Cast expr ty)
 104 castprop c expr@(Cast (Case scrut b _ alts) ty) = change (Case scrut b ty alts')
 105   where
 106     alts' = map (\(con, bndrs, expr) -> (con, bndrs, (Cast expr ty))) alts
 107 -- Leave all other expressions unchanged
 108 castprop c expr = return expr
 109
 110 --------------------------------
 111 -- Cast simplification. Mostly useful for state packing and unpacking, but
 112 -- perhaps for others as well.
 113 --------------------------------
 114 castsimpl :: Transform
 115 castsimpl c expr@(Cast val ty) = do
 116   -- Don't extract values that are already simpl
 117   local_var <- Trans.lift $ is_local_var val
 118   -- Don't extract values that are not representable, to prevent loops with
 119   -- inlinenonrep
 120   repr <- isRepr val
 121   if (not local_var) && repr
 122     then do
 123       -- Generate a binder for the expression
 124       id <- Trans.lift $ mkBinderFor val "castval"
 125       -- Extract the expression
 126       change $ Let (NonRec id val) (Cast (Var id) ty)
 127     else
 128       return expr
 129 -- Leave all other expressions unchanged
 130 castsimpl c expr = return expr
 131
 132 --------------------------------
 133 -- Top level function inlining
 134 --------------------------------
 135 -- This transformation inlines simple top level bindings. Simple
 136 -- currently means that the body is only a single application (though
 137 -- the complexity of the arguments is not currently checked) or that the
 138 -- normalized form only contains a single binding. This should catch most of the
 139 -- cases where a top level function is created that simply calls a type class
 140 -- method with a type and dictionary argument, e.g.
 141 --   fromInteger = GHC.Num.fromInteger (SizedWord D8) $dNum
 142 -- which is later called using simply
 143 --   fromInteger (smallInteger 10)
 144 --
 145 -- These useless wrappers are created by GHC automatically. If we don't
 146 -- inline them, we get loads of useless components cluttering the
 147 -- generated VHDL.
 148 --
 149 -- Note that the inlining could also inline simple functions defined by
 150 -- the user, not just GHC generated functions. It turns out to be near
 151 -- impossible to reliably determine what functions are generated and
 152 -- what functions are user-defined. Instead of guessing (which will
 153 -- inline less than we want) we will just inline all simple functions.
 154 --
 155 -- Only functions that are actually completely applied and bound by a
 156 -- variable in a let expression are inlined. These are the expressions
 157 -- that will eventually generate instantiations of trivial components.
 158 -- By not inlining any other reference, we also prevent looping problems
 159 -- with funextract and inlinedict.
 160 inlinetoplevel :: Transform
 161 inlinetoplevel (LetBinding:_) expr | not (is_fun expr) =
 162   case collectArgs expr of
 163         (Var f, args) -> do
 164           body_maybe <- needsInline f
 165           case body_maybe of
 166                 Just body -> do
 167                         -- Regenerate all uniques in the to-be-inlined expression
 168                         body_uniqued <- Trans.lift $ genUniques body
 169                         -- And replace the variable reference with the unique'd body.
 170                         change (mkApps body_uniqued args)
 171                         -- No need to inline
 172                 Nothing -> return expr
 173         -- This is not an application of a binder, leave it unchanged.
 174         _ -> return expr
 175
 176 -- Leave all other expressions unchanged
 177 inlinetoplevel c expr = return expr
 178
 179 -- | Does the given binder need to be inlined? If so, return the body to
 180 -- be used for inlining.
 181 needsInline :: CoreBndr -> TransformMonad (Maybe CoreExpr)
 182 needsInline f = do
 183   body_maybe <- Trans.lift $ getGlobalBind f
 184   case body_maybe of
 185     -- No body available?
 186     Nothing -> return Nothing
 187     Just body -> case CoreSyn.collectArgs body of
 188       -- The body is some (top level) binder applied to 0 or more
 189       -- arguments. That should be simple enough to inline.
 190       (Var f, args) -> return $ Just body
 191       -- Body is more complicated, try normalizing it
 192       _ -> do
 193         norm_maybe <- Trans.lift $ getNormalized_maybe False f
 194         case norm_maybe of
 195           -- Noth normalizeable
 196           Nothing -> return Nothing
 197           Just norm -> case splitNormalizedNonRep norm of
 198             -- The function has just a single binding, so that's simple
 199             -- enough to inline.
 200             (args, [bind], Var res) -> return $ Just norm
 201             -- More complicated function, don't inline
 202             _ -> return Nothing
 203
 204
 205 ----------------------------------------------------------------
 206 -- Program structure transformations
 207 ----------------------------------------------------------------
 208
 209 --------------------------------
 210 -- η expansion
 211 --------------------------------
 212 -- Make sure all parameters to the normalized functions are named by top
 213 -- level lambda expressions. For this we apply η expansion to the
 214 -- function body (possibly enclosed in some lambda abstractions) while
 215 -- it has a function type. Eventually this will result in a function
 216 -- body consisting of a bunch of nested lambdas containing a
 217 -- non-function value (e.g., a complete application).
 218 eta :: Transform
 219 eta (AppFirst:_) expr = return expr
 220 -- Also don't apply to arguments, since this can cause loops with
 221 -- funextract. This isn't the proper solution, but due to an
 222 -- implementation bug in notappargs, this is how it used to work so far.
 223 eta (AppSecond:_) expr = return expr
 224 eta c expr | is_fun expr && not (is_lam expr) = do
 225  let arg_ty = (fst . Type.splitFunTy . CoreUtils.exprType) expr
 226  id <- Trans.lift $ mkInternalVar "param" arg_ty
 227  change (Lam id (App expr (Var id)))
 228 -- Leave all other expressions unchanged
 229 eta c e = return e
 230
 231 --------------------------------
 232 -- Application propagation
 233 --------------------------------
 234 -- Move applications into let and case expressions.
 235 appprop :: Transform
 236 -- Propagate the application into the let
 237 appprop c (App (Let binds expr) arg) = change $ Let binds (App expr arg)
 238 -- Propagate the application into each of the alternatives
 239 appprop c (App (Case scrut b ty alts) arg) = change $ Case scrut b ty' alts'
 240   where
 241     alts' = map (\(con, bndrs, expr) -> (con, bndrs, (App expr arg))) alts
 242     ty' = CoreUtils.applyTypeToArg ty arg
 243 -- Leave all other expressions unchanged
 244 appprop c expr = return expr
 245
 246 --------------------------------
 247 -- Let recursification
 248 --------------------------------
 249 -- Make all lets recursive, so other transformations don't need to
 250 -- handle non-recursive lets
 251 letrec :: Transform
 252 letrec c expr@(Let (NonRec bndr val) res) =
 253   change $ Let (Rec [(bndr, val)]) res
 254
 255 -- Leave all other expressions unchanged
 256 letrec c expr = return expr
 257
 258 --------------------------------
 259 -- let flattening
 260 --------------------------------
 261 -- Takes a let that binds another let, and turns that into two nested lets.
 262 -- e.g., from:
 263 -- let b = (let b' = expr' in res') in res
 264 -- to:
 265 -- let b' = expr' in (let b = res' in res)
 266 letflat :: Transform
 267 -- Turn a nonrec let that binds a let into two nested lets.
 268 letflat c (Let (NonRec b (Let binds  res')) res) =
 269   change $ Let binds (Let (NonRec b res') res)
 270 letflat c (Let (Rec binds) expr) = do
 271   -- Flatten each binding.
 272   binds' <- Utils.concatM $ Monad.mapM flatbind binds
 273   -- Return the new let. We don't use change here, since possibly nothing has
 274   -- changed. If anything has changed, flatbind has already flagged that
 275   -- change.
 276   return $ Let (Rec binds') expr
 277   where
 278     -- Turns a binding of a let into a multiple bindings, or any other binding
 279     -- into a list with just that binding
 280     flatbind :: (CoreBndr, CoreExpr) -> TransformMonad [(CoreBndr, CoreExpr)]
 281     flatbind (b, Let (Rec binds) expr) = change ((b, expr):binds)
 282     flatbind (b, Let (NonRec b' expr') expr) = change [(b, expr), (b', expr')]
 283     flatbind (b, expr) = return [(b, expr)]
 284 -- Leave all other expressions unchanged
 285 letflat c expr = return expr
 286
 287 --------------------------------
 288 -- Return value simplification
 289 --------------------------------
 290 -- Ensure the return value of a function follows proper normal form. eta
 291 -- expansion ensures the body starts with lambda abstractions, this
 292 -- transformation ensures that the lambda abstractions always contain a
 293 -- recursive let and that, when the return value is representable, the
 294 -- let contains a local variable reference in its body.
 295
 296 -- Extract the return value from the body of the top level lambdas (of
 297 -- which ther could be zero), unless it is a let expression (in which
 298 -- case the next clause applies).
 299 retvalsimpl c expr | all (== LambdaBody) c && not (is_lam expr) && not (is_let expr) = do
 300   local_var <- Trans.lift $ is_local_var expr
 301   repr <- isRepr expr
 302   if not local_var && repr
 303     then do
 304       id <- Trans.lift $ mkBinderFor expr "res"
 305       change $ Let (Rec [(id, expr)]) (Var id)
 306     else
 307       return expr
 308 -- Extract the return value from the body of a let expression, which is
 309 -- itself the body of the top level lambdas (of which there could be
 310 -- zero).
 311 retvalsimpl c expr@(Let (Rec binds) body) | all (== LambdaBody) c = do
 312   -- Don't extract values that are already a local variable, to prevent
 313   -- loops with ourselves.
 314   local_var <- Trans.lift $ is_local_var body
 315   -- Don't extract values that are not representable, to prevent loops with
 316   -- inlinenonrep
 317   repr <- isRepr body
 318   if not local_var && repr
 319     then do
 320       id <- Trans.lift $ mkBinderFor body "res"
 321       change $ Let (Rec ((id, body):binds)) (Var id)
 322     else
 323       return expr
 324 -- Leave all other expressions unchanged
 325 retvalsimpl c expr = return expr
 326
 327 --------------------------------
 328 -- Representable arguments simplification
 329 --------------------------------
 330 -- Make sure that all arguments of a representable type are simple variables.
 331 appsimpl :: Transform
 332 -- Simplify all representable arguments. Do this by introducing a new Let
 333 -- that binds the argument and passing the new binder in the application.
 334 appsimpl c expr@(App f arg) = do
 335   -- Check runtime representability
 336   repr <- isRepr arg
 337   local_var <- Trans.lift $ is_local_var arg
 338   if repr && not local_var
 339     then do -- Extract representable arguments
 340       id <- Trans.lift $ mkBinderFor arg "arg"
 341       change $ Let (NonRec id arg) (App f (Var id))
 342     else -- Leave non-representable arguments unchanged
 343       return expr
 344 -- Leave all other expressions unchanged
 345 appsimpl c expr = return expr
 346
 347 ----------------------------------------------------------------
 348 -- Built-in function transformations
 349 ----------------------------------------------------------------
 350
 351 --------------------------------
 352 -- Function-typed argument extraction
 353 --------------------------------
 354 -- This transform takes any function-typed argument that cannot be propagated
 355 -- (because the function that is applied to it is a builtin function), and
 356 -- puts it in a brand new top level binder. This allows us to for example
 357 -- apply map to a lambda expression This will not conflict with inlinenonrep,
 358 -- since that only inlines local let bindings, not top level bindings.
 359 funextract :: Transform
 360 funextract c expr@(App _ _) | is_var fexpr = do
 361   body_maybe <- Trans.lift $ getGlobalBind f
 362   case body_maybe of
 363     -- We don't have a function body for f, so we can perform this transform.
 364     Nothing -> do
 365       -- Find the new arguments
 366       args' <- mapM doarg args
 367       -- And update the arguments. We use return instead of changed, so the
 368       -- changed flag doesn't get set if none of the args got changed.
 369       return $ MkCore.mkCoreApps fexpr args'
 370     -- We have a function body for f, leave this application to funprop
 371     Just _ -> return expr
 372   where
 373     -- Find the function called and the arguments
 374     (fexpr, args) = collectArgs expr
 375     Var f = fexpr
 376     -- Change any arguments that have a function type, but are not simple yet
 377     -- (ie, a variable or application). This means to create a new function
 378     -- for map (\f -> ...) b, but not for map (foo a) b.
 379     --
 380     -- We could use is_applicable here instead of is_fun, but I think
 381     -- arguments to functions could only have forall typing when existential
 382     -- typing is enabled. Not sure, though.
 383     doarg arg | not (is_simple arg) && is_fun arg = do
 384       -- Create a new top level binding that binds the argument. Its body will
 385       -- be extended with lambda expressions, to take any free variables used
 386       -- by the argument expression.
 387       let free_vars = VarSet.varSetElems $ CoreFVs.exprFreeVars arg
 388       let body = MkCore.mkCoreLams free_vars arg
 389       id <- Trans.lift $ mkBinderFor body "fun"
 390       Trans.lift $ addGlobalBind id body
 391       -- Replace the argument with a reference to the new function, applied to
 392       -- all vars it uses.
 393       change $ MkCore.mkCoreApps (Var id) (map Var free_vars)
 394     -- Leave all other arguments untouched
 395     doarg arg = return arg
 396
 397 -- Leave all other expressions unchanged
 398 funextract c expr = return expr
 399
 400
 401
 402
 403 ----------------------------------------------------------------
 404 -- Case normalization transformations
 405 ----------------------------------------------------------------
 406
 407 --------------------------------
 408 -- Scrutinee simplification
 409 --------------------------------
 410 -- Make sure the scrutinee of a case expression is a local variable
 411 -- reference.
 412 scrutsimpl :: Transform
 413 -- Don't touch scrutinees that are already simple
 414 scrutsimpl c expr@(Case (Var _) _ _ _) = return expr
 415 -- Replace all other cases with a let that binds the scrutinee and a new
 416 -- simple scrutinee, but only when the scrutinee is representable (to prevent
 417 -- loops with inlinenonrep, though I don't think a non-representable scrutinee
 418 -- will be supported anyway...)
 419 scrutsimpl c expr@(Case scrut b ty alts) = do
 420   repr <- isRepr scrut
 421   if repr
 422     then do
 423       id <- Trans.lift $ mkBinderFor scrut "scrut"
 424       change $ Let (NonRec id scrut) (Case (Var id) b ty alts)
 425     else
 426       return expr
 427 -- Leave all other expressions unchanged
 428 scrutsimpl c expr = return expr
 429
 430 --------------------------------
 431 -- Scrutinee binder removal
 432 --------------------------------
 433 -- A case expression can have an extra binder, to which the scrutinee is bound
 434 -- after bringing it to WHNF. This is used for forcing evaluation of strict
 435 -- arguments. Since strictness does not matter for us (rather, everything is
 436 -- sort of strict), this binder is ignored when generating VHDL, and must thus
 437 -- be wild in the normal form.
 438 scrutbndrremove :: Transform
 439 -- If the scrutinee is already simple, and the bndr is not wild yet, replace
 440 -- all occurences of the binder with the scrutinee variable.
 441 scrutbndrremove c (Case (Var scrut) bndr ty alts) | bndr_used = do
 442     alts' <- mapM subs_bndr alts
 443     change $ Case (Var scrut) wild ty alts'
 444   where
 445     is_used (_, _, expr) = expr_uses_binders [bndr] expr
 446     bndr_used = or $ map is_used alts
 447     subs_bndr (con, bndrs, expr) = do
 448       expr' <- substitute bndr (Var scrut) c expr
 449       return (con, bndrs, expr')
 450     wild = MkCore.mkWildBinder (Id.idType bndr)
 451 -- Leave all other expressions unchanged
 452 scrutbndrremove c expr = return expr
 453
 454 --------------------------------
 455 -- Case normalization
 456 --------------------------------
 457 -- Turn a case expression with any number of alternatives with any
 458 -- number of non-wild binders into as set of case and let expressions,
 459 -- all of which are in normal form (e.g., a bunch of extractor case
 460 -- expressions to extract all fields from the scrutinee, a number of let
 461 -- bindings to bind each alternative and a single selector case to
 462 -- select the right value.
 463 casesimpl :: Transform
 464 -- This is already a selector case (or, if x does not appear in bndrs, a very
 465 -- simple case statement that will be removed by caseremove below). Just leave
 466 -- it be.
 467 casesimpl c expr@(Case scrut b ty [(con, bndrs, Var x)]) = return expr
 468 -- Make sure that all case alternatives have only wild binders and simple
 469 -- expressions.
 470 -- This is done by creating a new let binding for each non-wild binder, which
 471 -- is bound to a new simple selector case statement and for each complex
 472 -- expression. We do this only for representable types, to prevent loops with
 473 -- inlinenonrep.
 474 casesimpl c expr@(Case scrut bndr ty alts) | not bndr_used = do
 475   (bindingss, alts') <- (Monad.liftM unzip) $ mapM doalt alts
 476   let bindings = concat bindingss
 477   -- Replace the case with a let with bindings and a case
 478   let newlet = mkNonRecLets bindings (Case scrut bndr ty alts')
 479   -- If there are no non-wild binders, or this case is already a simple
 480   -- selector (i.e., a single alt with exactly one binding), already a simple
 481   -- selector altan no bindings (i.e., no wild binders in the original case),
 482   -- don't change anything, otherwise, replace the case.
 483   if null bindings then return expr else change newlet
 484   where
 485   -- Check if the scrutinee binder is used
 486   is_used (_, _, expr) = expr_uses_binders [bndr] expr
 487   bndr_used = or $ map is_used alts
 488   -- Generate a single wild binder, since they are all the same
 489   wild = MkCore.mkWildBinder
 490   -- Wilden the binders of one alt, producing a list of bindings as a
 491   -- sideeffect.
 492   doalt :: CoreAlt -> TransformMonad ([(CoreBndr, CoreExpr)], CoreAlt)
 493   doalt (con, bndrs, expr) = do
 494     -- Make each binder wild, if possible
 495     bndrs_res <- Monad.zipWithM dobndr bndrs [0..]
 496     let (newbndrs, bindings_maybe) = unzip bndrs_res
 497     -- Extract a complex expression, if possible. For this we check if any of
 498     -- the new list of bndrs are used by expr. We can't use free_vars here,
 499     -- since that looks at the old bndrs.
 500     let uses_bndrs = not $ VarSet.isEmptyVarSet $ CoreFVs.exprSomeFreeVars (`elem` newbndrs) expr
 501     (exprbinding_maybe, expr') <- doexpr expr uses_bndrs
 502     -- Create a new alternative
 503     let newalt = (con, newbndrs, expr')
 504     let bindings = Maybe.catMaybes (bindings_maybe ++ [exprbinding_maybe])
 505     return (bindings, newalt)
 506     where
 507       -- Make wild alternatives for each binder
 508       wildbndrs = map (\bndr -> MkCore.mkWildBinder (Id.idType bndr)) bndrs
 509       -- A set of all the binders that are used by the expression
 510       free_vars = CoreFVs.exprSomeFreeVars (`elem` bndrs) expr
 511       -- Look at the ith binder in the case alternative. Return a new binder
 512       -- for it (either the same one, or a wild one) and optionally a let
 513       -- binding containing a case expression.
 514       dobndr :: CoreBndr -> Int -> TransformMonad (CoreBndr, Maybe (CoreBndr, CoreExpr))
 515       dobndr b i = do
 516         repr <- isRepr b
 517         -- Is b wild (e.g., not a free var of expr. Since b is only in scope
 518         -- in expr, this means that b is unused if expr does not use it.)
 519         let wild = not (VarSet.elemVarSet b free_vars)
 520         -- Create a new binding for any representable binder that is not
 521         -- already wild and is representable (to prevent loops with
 522         -- inlinenonrep).
 523         if (not wild) && repr
 524           then do
 525             caseexpr <- Trans.lift $ mkSelCase scrut i
 526             -- Create a new binder that will actually capture a value in this
 527             -- case statement, and return it.
 528             return (wildbndrs!!i, Just (b, caseexpr))
 529           else
 530             -- Just leave the original binder in place, and don't generate an
 531             -- extra selector case.
 532             return (b, Nothing)
 533       -- Process the expression of a case alternative. Accepts an expression
 534       -- and whether this expression uses any of the binders in the
 535       -- alternative. Returns an optional new binding and a new expression.
 536       doexpr :: CoreExpr -> Bool -> TransformMonad (Maybe (CoreBndr, CoreExpr), CoreExpr)
 537       doexpr expr uses_bndrs = do
 538         local_var <- Trans.lift $ is_local_var expr
 539         repr <- isRepr expr
 540         -- Extract any expressions that do not use any binders from this
 541         -- alternative, is not a local var already and is representable (to
 542         -- prevent loops with inlinenonrep).
 543         if (not uses_bndrs) && (not local_var) && repr
 544           then do
 545             id <- Trans.lift $ mkBinderFor expr "caseval"
 546             -- We don't flag a change here, since casevalsimpl will do that above
 547             -- based on Just we return here.
 548             return (Just (id, expr), Var id)
 549           else
 550             -- Don't simplify anything else
 551             return (Nothing, expr)
 552 -- Leave all other expressions unchanged
 553 casesimpl c expr = return expr
 554
 555 --------------------------------
 556 -- Case removal
 557 --------------------------------
 558 -- Remove case statements that have only a single alternative and only wild
 559 -- binders.
 560 caseremove :: Transform
 561 -- Replace a useless case by the value of its single alternative
 562 caseremove c (Case scrut b ty [(con, bndrs, expr)]) | not usesvars = change expr
 563     -- Find if any of the binders are used by expr
 564     where usesvars = (not . VarSet.isEmptyVarSet . (CoreFVs.exprSomeFreeVars (`elem` b:bndrs))) expr
 565 -- Leave all other expressions unchanged
 566 caseremove c expr = return expr
 567
 568 --------------------------------
 569 -- Case of known constructor simplification
 570 --------------------------------
 571 -- If a case expressions scrutinizes a datacon application, we can
 572 -- determine which alternative to use and remove the case alltogether.
 573 -- We replace it with a let expression the binds every binder in the
 574 -- alternative bound to the corresponding argument of the datacon. We do
 575 -- this instead of substituting the binders, to prevent duplication of
 576 -- work and preserve sharing wherever appropriate.
 577 knowncase :: Transform
 578 knowncase context expr@(Case scrut@(App _ _) bndr ty alts) | not bndr_used = do
 579     case collectArgs scrut of
 580       (Var f, args) -> case Id.isDataConId_maybe f of
 581         -- Not a dataconstructor? Don't change anything (probably a
 582         -- function, then)
 583         Nothing -> return expr
 584         Just dc -> do
 585           let (altcon, bndrs, res) =  case List.find (\(altcon, bndrs, res) -> altcon == (DataAlt dc)) alts of
 586                 Just alt -> alt -- Return the alternative found
 587                 Nothing -> head alts -- If the datacon is not present, the first must be the default alternative
 588           -- Double check if we have either the correct alternative, or
 589           -- the default.
 590           if altcon /= (DataAlt dc) && altcon /= DEFAULT then error ("Normalize.knowncase: Invalid core, datacon not found in alternatives and DEFAULT alternative is not first? " ++ pprString expr) else return ()
 591           -- Find out how many arguments to drop (type variables and
 592           -- predicates like dictionaries).
 593           let (tvs, preds, _, _) = DataCon.dataConSig dc
 594           let count = length tvs + length preds
 595           -- Create a let expression that binds each of the binders in
 596           -- this alternative to the corresponding argument of the data
 597           -- constructor.
 598           let binds = zip bndrs (drop count args)
 599           change $ Let (Rec binds) res
 600       _ -> return expr -- Scrutinee is not an application of a var
 601   where
 602     is_used (_, _, expr) = expr_uses_binders [bndr] expr
 603     bndr_used = or $ map is_used alts
 604
 605 -- Leave all other expressions unchanged
 606 knowncase c expr = return expr
 607
 608
 609
 610
 611 ----------------------------------------------------------------
 612 -- Unrepresentable value removal transformations
 613 ----------------------------------------------------------------
 614
 615 --------------------------------
 616 -- Non-representable binding inlining
 617 --------------------------------
 618 -- Remove a = B bindings, with B of a non-representable type, from let
 619 -- expressions everywhere. This means that any value that we can't generate a
 620 -- signal for, will be inlined and hopefully turned into something we can
 621 -- represent.
 622 --
 623 -- This is a tricky function, which is prone to create loops in the
 624 -- transformations. To fix this, we make sure that no transformation will
 625 -- create a new let binding with a non-representable type. These other
 626 -- transformations will just not work on those function-typed values at first,
 627 -- but the other transformations (in particular β-reduction) should make sure
 628 -- that the type of those values eventually becomes representable.
 629 inlinenonrep :: Transform
 630 inlinenonrep = inlinebind ((Monad.liftM not) . isRepr . snd)
 631
 632 --------------------------------
 633 -- Function specialization
 634 --------------------------------
 635 -- Remove all applications to non-representable arguments, by duplicating the
 636 -- function called with the non-representable parameter replaced by the free
 637 -- variables of the argument passed in.
 638 argprop :: Transform
 639 -- Transform any application of a named function (i.e., skip applications of
 640 -- lambda's). Also skip applications that have arguments with free type
 641 -- variables, since we can't inline those.
 642 argprop c expr@(App _ _) | is_var fexpr = do
 643   -- Find the body of the function called
 644   body_maybe <- Trans.lift $ getGlobalBind f
 645   case body_maybe of
 646     Just body -> do
 647       -- Process each of the arguments in turn
 648       (args', changed) <- Writer.listen $ mapM doarg args
 649       -- See if any of the arguments changed
 650       case Monoid.getAny changed of
 651         True -> do
 652           let (newargs', newparams', oldargs) = unzip3 args'
 653           let newargs = concat newargs'
 654           let newparams = concat newparams'
 655           -- Create a new body that consists of a lambda for all new arguments and
 656           -- the old body applied to some arguments.
 657           let newbody = MkCore.mkCoreLams newparams (MkCore.mkCoreApps body oldargs)
 658           -- Create a new function with the same name but a new body
 659           newf <- Trans.lift $ mkFunction f newbody
 660
 661           Trans.lift $ MonadState.modify tsInitStates (\ismap ->
 662             let init_state_maybe = Map.lookup f ismap in
 663             case init_state_maybe of
 664               Nothing -> ismap
 665               Just init_state -> Map.insert newf init_state ismap)
 666           -- Replace the original application with one of the new function to the
 667           -- new arguments.
 668           change $ MkCore.mkCoreApps (Var newf) newargs
 669         False ->
 670           -- Don't change the expression if none of the arguments changed
 671           return expr
 672
 673     -- If we don't have a body for the function called, leave it unchanged (it
 674     -- should be a primitive function then).
 675     Nothing -> return expr
 676   where
 677     -- Find the function called and the arguments
 678     (fexpr, args) = collectArgs expr
 679     Var f = fexpr
 680
 681     -- Process a single argument and return (args, bndrs, arg), where args are
 682     -- the arguments to replace the given argument in the original
 683     -- application, bndrs are the binders to include in the top-level lambda
 684     -- in the new function body, and arg is the argument to apply to the old
 685     -- function body.
 686     doarg :: CoreExpr -> TransformMonad ([CoreExpr], [CoreBndr], CoreExpr)
 687     doarg arg = do
 688       repr <- isRepr arg
 689       bndrs <- Trans.lift getGlobalBinders
 690       let interesting var = Var.isLocalVar var && (var `notElem` bndrs)
 691       if not repr && not (is_var arg && interesting (exprToVar arg)) && not (has_free_tyvars arg)
 692         then do
 693           -- Propagate all complex arguments that are not representable, but not
 694           -- arguments with free type variables (since those would require types
 695           -- not known yet, which will always be known eventually).
 696           -- Find interesting free variables, each of which should be passed to
 697           -- the new function instead of the original function argument.
 698           --
 699           -- Interesting vars are those that are local, but not available from the
 700           -- top level scope (functions from this module are defined as local, but
 701           -- they're not local to this function, so we can freely move references
 702           -- to them into another function).
 703           let free_vars = VarSet.varSetElems $ CoreFVs.exprSomeFreeVars interesting arg
 704           -- Mark the current expression as changed
 705           setChanged
 706           -- TODO: Clone the free_vars (and update references in arg), since
 707           -- this might cause conflicts if two arguments that are propagated
 708           -- share a free variable. Also, we are now introducing new variables
 709           -- into a function that are not fresh, which violates the binder
 710           -- uniqueness invariant.
 711           return (map Var free_vars, free_vars, arg)
 712         else do
 713           -- Representable types will not be propagated, and arguments with free
 714           -- type variables will be propagated later.
 715           -- Note that we implicitly remove any type variables in the type of
 716           -- the original argument by using the type of the actual argument
 717           -- for the new formal parameter.
 718           -- TODO: preserve original naming?
 719           id <- Trans.lift $ mkBinderFor arg "param"
 720           -- Just pass the original argument to the new function, which binds it
 721           -- to a new id and just pass that new id to the old function body.
 722           return ([arg], [id], mkReferenceTo id)
 723 -- Leave all other expressions unchanged
 724 argprop c expr = return expr
 725
 726 --------------------------------
 727 -- Non-representable result inlining
 728 --------------------------------
 729 -- This transformation takes a function (top level binding) that has a
 730 -- non-representable result (e.g., a tuple containing a function, or an
 731 -- Integer. The latter can occur in some cases as the result of the
 732 -- fromIntegerT function) and inlines enough of the function to make the
 733 -- result representable again.
 734 --
 735 -- This is done by first normalizing the function and then "inlining"
 736 -- the result. Since no unrepresentable let bindings are allowed in
 737 -- normal form, we can be sure that all free variables of the result
 738 -- expression will be representable (Note that we probably can't
 739 -- guarantee that all representable parts of the expression will be free
 740 -- variables, so we might inline more than strictly needed).
 741 --
 742 -- The new function result will be a tuple containing all free variables
 743 -- of the old result, so the old result can be rebuild at the caller.
 744 --
 745 -- We take care not to inline dictionary id's, which are top level
 746 -- bindings with a non-representable result type as well, since those
 747 -- will never become VHDL signals directly. There is a separate
 748 -- transformation (inlinedict) that specifically inlines dictionaries
 749 -- only when it is useful.
 750 inlinenonrepresult :: Transform
 751
 752 -- Apply to any (application of) a reference to a top level function
 753 -- that is fully applied (i.e., dos not have a function type) but is not
 754 -- representable. We apply in any context, since non-representable
 755 -- expressions are generally left alone and can occur anywhere.
 756 inlinenonrepresult context expr | not (is_fun expr) =
 757   case collectArgs expr of
 758     (Var f, args) | not (Id.isDictId f) -> do
 759       repr <- isRepr expr
 760       if not repr
 761         then do
 762           body_maybe <- Trans.lift $ getNormalized_maybe True f
 763           case body_maybe of
 764             Just body -> do
 765               let (bndrs, binds, res) = splitNormalizedNonRep body
 766               if has_free_tyvars res
 767                 then
 768                   -- Don't touch anything with free type variables, since
 769                   -- we can't return those. We'll wait until argprop
 770                   -- removed those variables.
 771                   return expr
 772                 else do
 773                   -- Get the free local variables of res
 774                   global_bndrs <- Trans.lift getGlobalBinders
 775                   let interesting var = Var.isLocalVar var && (var `notElem` global_bndrs)
 776                   let free_vars = VarSet.varSetElems $ CoreFVs.exprSomeFreeVars interesting res
 777                   let free_var_types = map Id.idType free_vars
 778                   let n_free_vars = length free_vars
 779                   -- Get a tuple datacon to wrap around the free variables
 780                   let fvs_datacon = TysWiredIn.tupleCon BasicTypes.Boxed n_free_vars
 781                   let fvs_datacon_id = DataCon.dataConWorkId fvs_datacon
 782                   -- Let the function now return a tuple with references to
 783                   -- all free variables of the old return value. First pass
 784                   -- all the types of the variables, since tuple
 785                   -- constructors are polymorphic.
 786                   let newres = mkApps (Var fvs_datacon_id) (map Type free_var_types ++  map Var free_vars)
 787                   -- Recreate the function body with the changed return value
 788                   let newbody = mkLams bndrs (Let (Rec binds) newres)
 789                   -- Create the new function
 790                   f' <- Trans.lift $ mkFunction f newbody
 791
 792                   -- Call the new function
 793                   let newapp = mkApps (Var f') args
 794                   res_bndr <- Trans.lift $ mkBinderFor newapp "res"
 795                   -- Create extractor case expressions to extract each of the
 796                   -- free variables from the tuple.
 797                   sel_cases <- Trans.lift $ mapM (mkSelCase (Var res_bndr)) [0..n_free_vars-1]
 798
 799                   -- Bind the res_bndr to the result of the new application
 800                   -- and each of the free variables to the corresponding
 801                   -- selector case. Replace the let body with the original
 802                   -- body of the called function (which can still access all
 803                   -- of its free variables, from the let).
 804                   let binds = (res_bndr, newapp):(zip free_vars sel_cases)
 805                   let letexpr = Let (Rec binds) res
 806
 807                   -- Finally, regenarate all uniques in the new expression,
 808                   -- since the free variables could otherwise become
 809                   -- duplicated. It is not strictly necessary to regenerate
 810                   -- res, since we're moving that expression, but it won't
 811                   -- hurt.
 812                   letexpr_uniqued <- Trans.lift $ genUniques letexpr
 813                   change letexpr_uniqued
 814             Nothing -> return expr
 815         else
 816           -- Don't touch representable expressions or (applications of)
 817           -- dictionary ids.
 818           return expr
 819     -- Not a reference to or application of a top level function
 820     _ -> return expr
 821 -- Leave all other expressions unchanged
 822 inlinenonrepresult c expr = return expr
 823
 824 --------------------------------
 825 -- ClassOp resolution
 826 --------------------------------
 827 -- Resolves any class operation to the actual operation whenever
 828 -- possible. Class methods (as well as parent dictionary selectors) are
 829 -- special "functions" that take a type and a dictionary and evaluate to
 830 -- the corresponding method. A dictionary is nothing more than a
 831 -- special dataconstructor applied to the type the dictionary is for,
 832 -- each of the superclasses and all of the class method definitions for
 833 -- that particular type. Since dictionaries all always inlined (top
 834 -- levels dictionaries are inlined by inlinedict, local dictionaries are
 835 -- inlined by inlinenonrep), we will eventually have something like:
 836 --
 837 --   baz
 838 --     @ CLasH.HardwareTypes.Bit
 839 --     (D:Baz @ CLasH.HardwareTypes.Bit bitbaz)
 840 --
 841 -- Here, baz is the method selector for the baz method, while
 842 -- D:Baz is the dictionary constructor for the Baz and bitbaz is the baz
 843 -- method defined in the Baz Bit instance declaration.
 844 --
 845 -- To resolve this, we can look at the ClassOp IdInfo from the baz Id,
 846 -- which contains the Class it is defined for. From the Class, we can
 847 -- get a list of all selectors (both parent class selectors as well as
 848 -- method selectors). Since the arguments to D:Baz (after the type
 849 -- argument) correspond exactly to this list, we then look up baz in
 850 -- that list and replace the entire expression by the corresponding
 851 -- argument to D:Baz.
 852 --
 853 -- We don't resolve methods that have a builtin translation (such as
 854 -- ==), since the actual implementation is not always (easily)
 855 -- translateable. For example, when deriving ==, GHC generates code
 856 -- using $con2tag functions to translate a datacon to an int and compare
 857 -- that with GHC.Prim.==# . Better to avoid that for now.
 858 classopresolution :: Transform
 859 classopresolution c expr@(App (App (Var sel) ty) dict) | not is_builtin =
 860   case Id.isClassOpId_maybe sel of
 861     -- Not a class op selector
 862     Nothing -> return expr
 863     Just cls -> case collectArgs dict of
 864       (_, []) -> return expr -- Dict is not an application (e.g., not inlined yet)
 865       (Var dictdc, (ty':selectors)) | not (Maybe.isJust (Id.isDataConId_maybe dictdc)) -> return expr -- Dictionary is not a datacon yet (but e.g., a top level binder)
 866                                 | tyargs_neq ty ty' -> error $ "Normalize.classopresolution: Applying class selector to dictionary without matching type?\n" ++ pprString expr
 867                                 | otherwise ->
 868         let selector_ids = Class.classSelIds cls in
 869         -- Find the selector used in the class' list of selectors
 870         case List.elemIndex sel selector_ids of
 871           Nothing -> error $ "Normalize.classopresolution: Selector not found in class' selector list? This should not happen!\nExpression: " ++ pprString expr ++ "\nClass: " ++ show cls ++ "\nSelectors: " ++ show selector_ids
 872           -- Get the corresponding argument from the dictionary
 873           Just n -> change (selectors!!n)
 874       (_, _) -> return expr -- Not applying a variable? Don't touch
 875   where
 876     -- Compare two type arguments, returning True if they are _not_
 877     -- equal
 878     tyargs_neq (Type ty1) (Type ty2) = not $ Type.coreEqType ty1 ty2
 879     tyargs_neq _ _ = True
 880     -- Is this a builtin function / method?
 881     is_builtin = elem (Name.getOccString sel) builtinIds
 882
 883 -- Leave all other expressions unchanged
 884 classopresolution c expr = return expr
 885
 886 --------------------------------
 887 -- Dictionary inlining
 888 --------------------------------
 889 -- Inline all top level dictionaries, that are in a position where
 890 -- classopresolution can actually resolve them. This makes this
 891 -- transformation look similar to classoperesolution below, but we'll
 892 -- keep them separated for clarity. By not inlining other dictionaries,
 893 -- we prevent expression sizes exploding when huge type level integer
 894 -- dictionaries are inlined which can never be expanded (in casts, for
 895 -- example).
 896 inlinedict c expr@(App (App (Var sel) ty) (Var dict)) | not is_builtin && is_classop = do
 897   body_maybe <- Trans.lift $ getGlobalBind dict
 898   case body_maybe of
 899     -- No body available (no source available, or a local variable /
 900     -- argument)
 901     Nothing -> return expr
 902     Just body -> change (App (App (Var sel) ty) body)
 903   where
 904     -- Is this a builtin function / method?
 905     is_builtin = elem (Name.getOccString sel) builtinIds
 906     -- Are we dealing with a class operation selector?
 907     is_classop = Maybe.isJust (Id.isClassOpId_maybe sel)
 908
 909 -- Leave all other expressions unchanged
 910 inlinedict c expr = return expr
 911
 912
 913 {-
 914 --------------------------------
 915 -- Identical let binding merging
 916 --------------------------------
 917 -- Merge two bindings in a let if they are identical
 918 -- TODO: We would very much like to use GHC's CSE module for this, but that
 919 -- doesn't track if something changed or not, so we can't use it properly.
 920 letmerge :: Transform
 921 letmerge c expr@(Let _ _) = do
 922   let (binds, res) = flattenLets expr
 923   binds' <- domerge binds
 924   return $ mkNonRecLets binds' res
 925   where
 926     domerge :: [(CoreBndr, CoreExpr)] -> TransformMonad [(CoreBndr, CoreExpr)]
 927     domerge [] = return []
 928     domerge (e:es) = do
 929       es' <- mapM (mergebinds e) es
 930       es'' <- domerge es'
 931       return (e:es'')
 932
 933     -- Uses the second bind to simplify the second bind, if applicable.
 934     mergebinds :: (CoreBndr, CoreExpr) -> (CoreBndr, CoreExpr) -> TransformMonad (CoreBndr, CoreExpr)
 935     mergebinds (b1, e1) (b2, e2)
 936       -- Identical expressions? Replace the second binding with a reference to
 937       -- the first binder.
 938       | CoreUtils.cheapEqExpr e1 e2 = change $ (b2, Var b1)
 939       -- Different expressions? Don't change
 940       | otherwise = return (b2, e2)
 941 -- Leave all other expressions unchanged
 942 letmerge c expr = return expr
 943 -}
 944
 945 --------------------------------
 946 -- End of transformations
 947 --------------------------------
 948
 949
 950
 951
 952 -- What transforms to run?
 953 transforms = [ ("inlinedict", inlinedict)
 954              , ("inlinetoplevel", inlinetoplevel)
 955              -- , ("inlinenonrepresult", inlinenonrepresult)
 956              , ("knowncase", knowncase)
 957              , ("classopresolution", classopresolution)
 958              , ("argprop", argprop)
 959              , ("funextract", funextract)
 960              , ("eta", eta)
 961              , ("beta", beta)
 962              , ("appprop", appprop)
 963              , ("castprop", castprop)
 964              , ("letremovesimple", letremovesimple)
 965              , ("letrec", letrec)
 966              , ("letremove", letremove)
 967              , ("retvalsimpl", retvalsimpl)
 968              , ("letflat", letflat)
 969              , ("scrutsimpl", scrutsimpl)
 970              , ("scrutbndrremove", scrutbndrremove)
 971              , ("casesimpl", casesimpl)
 972              , ("caseremove", caseremove)
 973              , ("inlinenonrep", inlinenonrep)
 974              , ("appsimpl", appsimpl)
 975              , ("letremoveunused", letremoveunused)
 976              , ("castsimpl", castsimpl)
 977              ]
 978
 979 -- | Returns the normalized version of the given function, or an error
 980 -- if it is not a known global binder.
 981 getNormalized ::
 982   Bool -- ^ Allow the result to be unrepresentable?
 983   -> CoreBndr -- ^ The function to get
 984   -> TranslatorSession CoreExpr -- The normalized function body
 985 getNormalized result_nonrep bndr = do
 986   norm <- getNormalized_maybe result_nonrep bndr
 987   return $ Maybe.fromMaybe
 988     (error $ "Normalize.getNormalized: Unknown or non-representable function requested: " ++ show bndr)
 989     norm
 990
 991 -- | Returns the normalized version of the given function, or Nothing
 992 -- when the binder is not a known global binder or is not normalizeable.
 993 getNormalized_maybe ::
 994   Bool -- ^ Allow the result to be unrepresentable?
 995   -> CoreBndr -- ^ The function to get
 996   -> TranslatorSession (Maybe CoreExpr) -- The normalized function body
 997
 998 getNormalized_maybe result_nonrep bndr = do
 999     expr_maybe <- getGlobalBind bndr
1000     normalizeable <- isNormalizeable result_nonrep bndr
1001     if not normalizeable || Maybe.isNothing expr_maybe
1002       then
1003         -- Binder not normalizeable or not found
1004         return Nothing
1005       else do
1006         -- Binder found and is monomorphic. Normalize the expression
1007         -- and cache the result.
1008         normalized <- Utils.makeCached bndr tsNormalized $
1009           normalizeExpr (show bndr) (Maybe.fromJust expr_maybe)
1010         return (Just normalized)
1011
1012 -- | Normalize an expression
1013 normalizeExpr ::
1014   String -- ^ What are we normalizing? For debug output only.
1015   -> CoreSyn.CoreExpr -- ^ The expression to normalize
1016   -> TranslatorSession CoreSyn.CoreExpr -- ^ The normalized expression
1017
1018 normalizeExpr what expr = do
1019       startcount <- MonadState.get tsTransformCounter
1020       expr_uniqued <- genUniques expr
1021       -- Do a debug print, if requested
1022       let expr_uniqued' = Utils.traceIf (normalize_debug >= NormDbgFinal) (what ++ " before normalization:\n\n" ++ showSDoc ( ppr expr_uniqued ) ++ "\n") expr_uniqued
1023       -- Normalize this expression
1024       expr' <- dotransforms transforms expr_uniqued'
1025       endcount <- MonadState.get tsTransformCounter
1026       -- Do a debug print, if requested
1027       Utils.traceIf (normalize_debug >= NormDbgFinal)  (what ++ " after normalization:\n\n" ++ showSDoc ( ppr expr') ++ "\nNeeded " ++ show (endcount - startcount) ++ " transformations to normalize " ++ what) $
1028         return expr'
1029
1030 -- | Split a normalized expression into the argument binders, top level
1031 --   bindings and the result binder. This function returns an error if
1032 --   the type of the expression is not representable.
1033 splitNormalized ::
1034   CoreExpr -- ^ The normalized expression
1035   -> ([CoreBndr], [Binding], CoreBndr)
1036 splitNormalized expr =
1037   case splitNormalizedNonRep expr of
1038     (args, binds, Var res) -> (args, binds, res)
1039     _ -> error $ "Normalize.splitNormalized: Not in normal form: " ++ pprString expr ++ "\n"
1040
1041 -- Split a normalized expression, whose type can be unrepresentable.
1042 splitNormalizedNonRep::
1043   CoreExpr -- ^ The normalized expression
1044   -> ([CoreBndr], [Binding], CoreExpr)
1045 splitNormalizedNonRep expr = (args, binds, resexpr)
1046   where
1047     (args, letexpr) = CoreSyn.collectBinders expr
1048     (binds, resexpr) = flattenLets letexpr