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 c expr | not (null c) && is_letbinding_ctx (head c) && 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 c expr | not (null c) && is_appfirst_ctx (head c) = 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            | not (null c) && is_appsecond_ctx (head c) = return expr
 224            | 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 is_lambdabody_ctx 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 is_lambdabody_ctx 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 && not (has_free_tyvars 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 -- Replace a case expression with a let that binds the scrutinee and a new
 414 -- simple scrutinee, but only when the scrutinee is representable (to prevent
 415 -- loops with inlinenonrep, though I don't think a non-representable scrutinee
 416 -- will be supported anyway...) and is not a local variable already.
 417 scrutsimpl c expr@(Case scrut b ty alts) = do
 418   repr <- isRepr scrut
 419   local_var <- Trans.lift $ is_local_var scrut
 420   if repr && not local_var
 421     then do
 422       id <- Trans.lift $ mkBinderFor scrut "scrut"
 423       change $ Let (NonRec id scrut) (Case (Var id) b ty alts)
 424     else
 425       return expr
 426 -- Leave all other expressions unchanged
 427 scrutsimpl c expr = return expr
 428
 429 --------------------------------
 430 -- Scrutinee binder removal
 431 --------------------------------
 432 -- A case expression can have an extra binder, to which the scrutinee is bound
 433 -- after bringing it to WHNF. This is used for forcing evaluation of strict
 434 -- arguments. Since strictness does not matter for us (rather, everything is
 435 -- sort of strict), this binder is ignored when generating VHDL, and must thus
 436 -- be wild in the normal form.
 437 scrutbndrremove :: Transform
 438 -- If the scrutinee is already simple, and the bndr is not wild yet, replace
 439 -- all occurences of the binder with the scrutinee variable.
 440 scrutbndrremove c (Case (Var scrut) bndr ty alts) | bndr_used = do
 441     alts' <- mapM subs_bndr alts
 442     change $ Case (Var scrut) wild ty alts'
 443   where
 444     is_used (_, _, expr) = expr_uses_binders [bndr] expr
 445     bndr_used = or $ map is_used alts
 446     subs_bndr (con, bndrs, expr) = do
 447       expr' <- substitute bndr (Var scrut) c expr
 448       return (con, bndrs, expr')
 449     wild = MkCore.mkWildBinder (Id.idType bndr)
 450 -- Leave all other expressions unchanged
 451 scrutbndrremove c expr = return expr
 452
 453 --------------------------------
 454 -- Case normalization
 455 --------------------------------
 456 -- Turn a case expression with any number of alternatives with any
 457 -- number of non-wild binders into as set of case and let expressions,
 458 -- all of which are in normal form (e.g., a bunch of extractor case
 459 -- expressions to extract all fields from the scrutinee, a number of let
 460 -- bindings to bind each alternative and a single selector case to
 461 -- select the right value.
 462 casesimpl :: Transform
 463 -- This is already a selector case (or, if x does not appear in bndrs, a very
 464 -- simple case statement that will be removed by caseremove below). Just leave
 465 -- it be.
 466 casesimpl c expr@(Case scrut b ty [(con, bndrs, Var x)]) = return expr
 467 -- Make sure that all case alternatives have only wild binders and simple
 468 -- expressions.
 469 -- This is done by creating a new let binding for each non-wild binder, which
 470 -- is bound to a new simple selector case statement and for each complex
 471 -- expression. We do this only for representable types, to prevent loops with
 472 -- inlinenonrep.
 473 casesimpl c expr@(Case scrut bndr ty alts) | not bndr_used = do
 474   (bindingss, alts') <- (Monad.liftM unzip) $ mapM doalt alts
 475   let bindings = concat bindingss
 476   -- Replace the case with a let with bindings and a case
 477   let newlet = mkNonRecLets bindings (Case scrut bndr ty alts')
 478   -- If there are no non-wild binders, or this case is already a simple
 479   -- selector (i.e., a single alt with exactly one binding), already a simple
 480   -- selector altan no bindings (i.e., no wild binders in the original case),
 481   -- don't change anything, otherwise, replace the case.
 482   if null bindings then return expr else change newlet
 483   where
 484   -- Check if the scrutinee binder is used
 485   is_used (_, _, expr) = expr_uses_binders [bndr] expr
 486   bndr_used = or $ map is_used alts
 487   -- Generate a single wild binder, since they are all the same
 488   wild = MkCore.mkWildBinder
 489   -- Wilden the binders of one alt, producing a list of bindings as a
 490   -- sideeffect.
 491   doalt :: CoreAlt -> TransformMonad ([(CoreBndr, CoreExpr)], CoreAlt)
 492   doalt (LitAlt _, _, _) = error $ "Don't know how to handle LitAlt in case expression: " ++ pprString expr
 493   doalt alt@(DEFAULT, [], expr) = do
 494     local_var <- Trans.lift $ is_local_var expr
 495     repr <- isRepr expr
 496     -- Extract any expressions that is not a local var already and is
 497     -- representable (to prevent loops with inlinenonrep).
 498     (exprbinding_maybe, expr') <- if (not local_var) && repr
 499       then do
 500         id <- Trans.lift $ mkBinderFor expr "caseval"
 501         -- We don't flag a change here, since casevalsimpl will do that above
 502         -- based on Just we return here.
 503         return (Just (id, expr), Var id)
 504       else
 505         -- Don't simplify anything else
 506         return (Nothing, expr)
 507     let newalt = (DEFAULT, [], expr')
 508     let bindings = Maybe.catMaybes [exprbinding_maybe]
 509     return (bindings, newalt)
 510   doalt (DataAlt dc, bndrs, expr) = do
 511     -- Make each binder wild, if possible
 512     bndrs_res <- Monad.zipWithM dobndr bndrs [0..]
 513     let (newbndrs, bindings_maybe) = unzip bndrs_res
 514     -- Extract a complex expression, if possible. For this we check if any of
 515     -- the new list of bndrs are used by expr. We can't use free_vars here,
 516     -- since that looks at the old bndrs.
 517     let uses_bndrs = not $ VarSet.isEmptyVarSet $ CoreFVs.exprSomeFreeVars (`elem` newbndrs) expr
 518     (exprbinding_maybe, expr') <- doexpr expr uses_bndrs
 519     -- Create a new alternative
 520     let newalt = (DataAlt dc, newbndrs, expr')
 521     let bindings = Maybe.catMaybes (bindings_maybe ++ [exprbinding_maybe])
 522     return (bindings, newalt)
 523     where
 524       -- Make wild alternatives for each binder
 525       wildbndrs = map (\bndr -> MkCore.mkWildBinder (Id.idType bndr)) bndrs
 526       -- A set of all the binders that are used by the expression
 527       free_vars = CoreFVs.exprSomeFreeVars (`elem` bndrs) expr
 528       -- Look at the ith binder in the case alternative. Return a new binder
 529       -- for it (either the same one, or a wild one) and optionally a let
 530       -- binding containing a case expression.
 531       dobndr :: CoreBndr -> Int -> TransformMonad (CoreBndr, Maybe (CoreBndr, CoreExpr))
 532       dobndr b i = do
 533         repr <- isRepr b
 534         -- Is b wild (e.g., not a free var of expr. Since b is only in scope
 535         -- in expr, this means that b is unused if expr does not use it.)
 536         let wild = not (VarSet.elemVarSet b free_vars)
 537         -- Create a new binding for any representable binder that is not
 538         -- already wild and is representable (to prevent loops with
 539         -- inlinenonrep).
 540         if (not wild) && repr
 541           then do
 542             let dc_i = datacon_index (CoreUtils.exprType scrut) dc
 543             caseexpr <- Trans.lift $ mkSelCase scrut dc_i i
 544             -- Create a new binder that will actually capture a value in this
 545             -- case statement, and return it.
 546             return (wildbndrs!!i, Just (b, caseexpr))
 547           else
 548             -- Just leave the original binder in place, and don't generate an
 549             -- extra selector case.
 550             return (b, Nothing)
 551       -- Process the expression of a case alternative. Accepts an expression
 552       -- and whether this expression uses any of the binders in the
 553       -- alternative. Returns an optional new binding and a new expression.
 554       doexpr :: CoreExpr -> Bool -> TransformMonad (Maybe (CoreBndr, CoreExpr), CoreExpr)
 555       doexpr expr uses_bndrs = do
 556         local_var <- Trans.lift $ is_local_var expr
 557         repr <- isRepr expr
 558         -- Extract any expressions that do not use any binders from this
 559         -- alternative, is not a local var already and is representable (to
 560         -- prevent loops with inlinenonrep).
 561         if (not uses_bndrs) && (not local_var) && repr
 562           then do
 563             id <- Trans.lift $ mkBinderFor expr "caseval"
 564             -- We don't flag a change here, since casevalsimpl will do that above
 565             -- based on Just we return here.
 566             return (Just (id, expr), Var id)
 567           else
 568             -- Don't simplify anything else
 569             return (Nothing, expr)
 570 -- Leave all other expressions unchanged
 571 casesimpl c expr = return expr
 572
 573 --------------------------------
 574 -- Case removal
 575 --------------------------------
 576 -- Remove case statements that have only a single alternative and only wild
 577 -- binders.
 578 caseremove :: Transform
 579 -- Replace a useless case by the value of its single alternative
 580 caseremove c (Case scrut b ty [(con, bndrs, expr)]) | not usesvars = change expr
 581     -- Find if any of the binders are used by expr
 582     where usesvars = (not . VarSet.isEmptyVarSet . (CoreFVs.exprSomeFreeVars (`elem` b:bndrs))) expr
 583 -- Leave all other expressions unchanged
 584 caseremove c expr = return expr
 585
 586 --------------------------------
 587 -- Case of known constructor simplification
 588 --------------------------------
 589 -- If a case expressions scrutinizes a datacon application, we can
 590 -- determine which alternative to use and remove the case alltogether.
 591 -- We replace it with a let expression the binds every binder in the
 592 -- alternative bound to the corresponding argument of the datacon. We do
 593 -- this instead of substituting the binders, to prevent duplication of
 594 -- work and preserve sharing wherever appropriate.
 595 knowncase :: Transform
 596 knowncase context expr@(Case scrut@(App _ _) bndr ty alts) | not bndr_used = do
 597     case collectArgs scrut of
 598       (Var f, args) -> case Id.isDataConId_maybe f of
 599         -- Not a dataconstructor? Don't change anything (probably a
 600         -- function, then)
 601         Nothing -> return expr
 602         Just dc -> do
 603           let (altcon, bndrs, res) =  case List.find (\(altcon, bndrs, res) -> altcon == (DataAlt dc)) alts of
 604                 Just alt -> alt -- Return the alternative found
 605                 Nothing -> head alts -- If the datacon is not present, the first must be the default alternative
 606           -- Double check if we have either the correct alternative, or
 607           -- the default.
 608           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 ()
 609           -- Find out how many arguments to drop (type variables and
 610           -- predicates like dictionaries).
 611           let (tvs, preds, _, _) = DataCon.dataConSig dc
 612           let count = length tvs + length preds
 613           -- Create a let expression that binds each of the binders in
 614           -- this alternative to the corresponding argument of the data
 615           -- constructor.
 616           let binds = zip bndrs (drop count args)
 617           change $ Let (Rec binds) res
 618       _ -> return expr -- Scrutinee is not an application of a var
 619   where
 620     is_used (_, _, expr) = expr_uses_binders [bndr] expr
 621     bndr_used = or $ map is_used alts
 622
 623 -- Leave all other expressions unchanged
 624 knowncase c expr = return expr
 625
 626
 627
 628
 629 ----------------------------------------------------------------
 630 -- Unrepresentable value removal transformations
 631 ----------------------------------------------------------------
 632
 633 --------------------------------
 634 -- Non-representable binding inlining
 635 --------------------------------
 636 -- Remove a = B bindings, with B of a non-representable type, from let
 637 -- expressions everywhere. This means that any value that we can't generate a
 638 -- signal for, will be inlined and hopefully turned into something we can
 639 -- represent.
 640 --
 641 -- This is a tricky function, which is prone to create loops in the
 642 -- transformations. To fix this, we make sure that no transformation will
 643 -- create a new let binding with a non-representable type. These other
 644 -- transformations will just not work on those function-typed values at first,
 645 -- but the other transformations (in particular β-reduction) should make sure
 646 -- that the type of those values eventually becomes representable.
 647 inlinenonrep :: Transform
 648 inlinenonrep = inlinebind ((Monad.liftM not) . isRepr . snd)
 649
 650 --------------------------------
 651 -- Function specialization
 652 --------------------------------
 653 -- Remove all applications to non-representable arguments, by duplicating the
 654 -- function called with the non-representable parameter replaced by the free
 655 -- variables of the argument passed in.
 656 argprop :: Transform
 657 -- Transform any application of a named function (i.e., skip applications of
 658 -- lambda's). Also skip applications that have arguments with free type
 659 -- variables, since we can't inline those.
 660 argprop c expr@(App _ _) | is_var fexpr = do
 661   -- Find the body of the function called
 662   body_maybe <- Trans.lift $ getGlobalBind f
 663   case body_maybe of
 664     Just body -> do
 665       -- Process each of the arguments in turn
 666       (args', changed) <- Writer.listen $ mapM doarg args
 667       -- See if any of the arguments changed
 668       case Monoid.getAny changed of
 669         True -> do
 670           let (newargs', newparams', oldargs) = unzip3 args'
 671           let newargs = concat newargs'
 672           let newparams = concat newparams'
 673           -- Create a new body that consists of a lambda for all new arguments and
 674           -- the old body applied to some arguments.
 675           let newbody = MkCore.mkCoreLams newparams (MkCore.mkCoreApps body oldargs)
 676           -- Create a new function with the same name but a new body
 677           newf <- Trans.lift $ mkFunction f newbody
 678
 679           Trans.lift $ MonadState.modify tsInitStates (\ismap ->
 680             let init_state_maybe = Map.lookup f ismap in
 681             case init_state_maybe of
 682               Nothing -> ismap
 683               Just init_state -> Map.insert newf init_state ismap)
 684           -- Replace the original application with one of the new function to the
 685           -- new arguments.
 686           change $ MkCore.mkCoreApps (Var newf) newargs
 687         False ->
 688           -- Don't change the expression if none of the arguments changed
 689           return expr
 690
 691     -- If we don't have a body for the function called, leave it unchanged (it
 692     -- should be a primitive function then).
 693     Nothing -> return expr
 694   where
 695     -- Find the function called and the arguments
 696     (fexpr, args) = collectArgs expr
 697     Var f = fexpr
 698
 699     -- Process a single argument and return (args, bndrs, arg), where args are
 700     -- the arguments to replace the given argument in the original
 701     -- application, bndrs are the binders to include in the top-level lambda
 702     -- in the new function body, and arg is the argument to apply to the old
 703     -- function body.
 704     doarg :: CoreExpr -> TransformMonad ([CoreExpr], [CoreBndr], CoreExpr)
 705     doarg arg = do
 706       repr <- isRepr arg
 707       bndrs <- Trans.lift getGlobalBinders
 708       let interesting var = Var.isLocalVar var && (var `notElem` bndrs)
 709       if not repr && not (is_var arg && interesting (exprToVar arg)) && not (has_free_tyvars arg)
 710         then do
 711           -- Propagate all complex arguments that are not representable, but not
 712           -- arguments with free type variables (since those would require types
 713           -- not known yet, which will always be known eventually).
 714           -- Find interesting free variables, each of which should be passed to
 715           -- the new function instead of the original function argument.
 716           --
 717           -- Interesting vars are those that are local, but not available from the
 718           -- top level scope (functions from this module are defined as local, but
 719           -- they're not local to this function, so we can freely move references
 720           -- to them into another function).
 721           let free_vars = VarSet.varSetElems $ CoreFVs.exprSomeFreeVars interesting arg
 722           -- Mark the current expression as changed
 723           setChanged
 724           -- TODO: Clone the free_vars (and update references in arg), since
 725           -- this might cause conflicts if two arguments that are propagated
 726           -- share a free variable. Also, we are now introducing new variables
 727           -- into a function that are not fresh, which violates the binder
 728           -- uniqueness invariant.
 729           return (map Var free_vars, free_vars, arg)
 730         else do
 731           -- Representable types will not be propagated, and arguments with free
 732           -- type variables will be propagated later.
 733           -- Note that we implicitly remove any type variables in the type of
 734           -- the original argument by using the type of the actual argument
 735           -- for the new formal parameter.
 736           -- TODO: preserve original naming?
 737           id <- Trans.lift $ mkBinderFor arg "param"
 738           -- Just pass the original argument to the new function, which binds it
 739           -- to a new id and just pass that new id to the old function body.
 740           return ([arg], [id], mkReferenceTo id)
 741 -- Leave all other expressions unchanged
 742 argprop c expr = return expr
 743
 744 --------------------------------
 745 -- Non-representable result inlining
 746 --------------------------------
 747 -- This transformation takes a function (top level binding) that has a
 748 -- non-representable result (e.g., a tuple containing a function, or an
 749 -- Integer. The latter can occur in some cases as the result of the
 750 -- fromIntegerT function) and inlines enough of the function to make the
 751 -- result representable again.
 752 --
 753 -- This is done by first normalizing the function and then "inlining"
 754 -- the result. Since no unrepresentable let bindings are allowed in
 755 -- normal form, we can be sure that all free variables of the result
 756 -- expression will be representable (Note that we probably can't
 757 -- guarantee that all representable parts of the expression will be free
 758 -- variables, so we might inline more than strictly needed).
 759 --
 760 -- The new function result will be a tuple containing all free variables
 761 -- of the old result, so the old result can be rebuild at the caller.
 762 --
 763 -- We take care not to inline dictionary id's, which are top level
 764 -- bindings with a non-representable result type as well, since those
 765 -- will never become VHDL signals directly. There is a separate
 766 -- transformation (inlinedict) that specifically inlines dictionaries
 767 -- only when it is useful.
 768 inlinenonrepresult :: Transform
 769
 770 -- Apply to any (application of) a reference to a top level function
 771 -- that is fully applied (i.e., dos not have a function type) but is not
 772 -- representable. We apply in any context, since non-representable
 773 -- expressions are generally left alone and can occur anywhere.
 774 inlinenonrepresult context expr | not (is_applicable expr) && not (has_free_tyvars expr) =
 775   case collectArgs expr of
 776     (Var f, args) | not (Id.isDictId f) -> do
 777       repr <- isRepr expr
 778       if not repr
 779         then do
 780           body_maybe <- Trans.lift $ getNormalized_maybe True f
 781           case body_maybe of
 782             Just body -> do
 783               let (bndrs, binds, res) = splitNormalizedNonRep body
 784               if has_free_tyvars res
 785                 then
 786                   -- Don't touch anything with free type variables, since
 787                   -- we can't return those. We'll wait until argprop
 788                   -- removed those variables.
 789                   return expr
 790                 else do
 791                   -- Get the free local variables of res
 792                   global_bndrs <- Trans.lift getGlobalBinders
 793                   let interesting var = Var.isLocalVar var && (var `notElem` global_bndrs)
 794                   let free_vars = VarSet.varSetElems $ CoreFVs.exprSomeFreeVars interesting res
 795                   let free_var_types = map Id.idType free_vars
 796                   let n_free_vars = length free_vars
 797                   -- Get a tuple datacon to wrap around the free variables
 798                   let fvs_datacon = TysWiredIn.tupleCon BasicTypes.Boxed n_free_vars
 799                   let fvs_datacon_id = DataCon.dataConWorkId fvs_datacon
 800                   -- Let the function now return a tuple with references to
 801                   -- all free variables of the old return value. First pass
 802                   -- all the types of the variables, since tuple
 803                   -- constructors are polymorphic.
 804                   let newres = mkApps (Var fvs_datacon_id) (map Type free_var_types ++  map Var free_vars)
 805                   -- Recreate the function body with the changed return value
 806                   let newbody = mkLams bndrs (Let (Rec binds) newres)
 807                   -- Create the new function
 808                   f' <- Trans.lift $ mkFunction f newbody
 809
 810                   -- Call the new function
 811                   let newapp = mkApps (Var f') args
 812                   res_bndr <- Trans.lift $ mkBinderFor newapp "res"
 813                   -- Create extractor case expressions to extract each of the
 814                   -- free variables from the tuple.
 815                   sel_cases <- Trans.lift $ mapM (mkSelCase (Var res_bndr) 0) [0..n_free_vars-1]
 816
 817                   -- Bind the res_bndr to the result of the new application
 818                   -- and each of the free variables to the corresponding
 819                   -- selector case. Replace the let body with the original
 820                   -- body of the called function (which can still access all
 821                   -- of its free variables, from the let).
 822                   let binds = (res_bndr, newapp):(zip free_vars sel_cases)
 823                   let letexpr = Let (Rec binds) res
 824
 825                   -- Finally, regenarate all uniques in the new expression,
 826                   -- since the free variables could otherwise become
 827                   -- duplicated. It is not strictly necessary to regenerate
 828                   -- res, since we're moving that expression, but it won't
 829                   -- hurt.
 830                   letexpr_uniqued <- Trans.lift $ genUniques letexpr
 831                   change letexpr_uniqued
 832             Nothing -> return expr
 833         else
 834           -- Don't touch representable expressions or (applications of)
 835           -- dictionary ids.
 836           return expr
 837     -- Not a reference to or application of a top level function
 838     _ -> return expr
 839 -- Leave all other expressions unchanged
 840 inlinenonrepresult c expr = return expr
 841
 842 ----------------------------------------------------------------
 843 -- Type-class transformations
 844 ----------------------------------------------------------------
 845
 846 --------------------------------
 847 -- ClassOp resolution
 848 --------------------------------
 849 -- Resolves any class operation to the actual operation whenever
 850 -- possible. Class methods (as well as parent dictionary selectors) are
 851 -- special "functions" that take a type and a dictionary and evaluate to
 852 -- the corresponding method. A dictionary is nothing more than a
 853 -- special dataconstructor applied to the type the dictionary is for,
 854 -- each of the superclasses and all of the class method definitions for
 855 -- that particular type. Since dictionaries all always inlined (top
 856 -- levels dictionaries are inlined by inlinedict, local dictionaries are
 857 -- inlined by inlinenonrep), we will eventually have something like:
 858 --
 859 --   baz
 860 --     @ CLasH.HardwareTypes.Bit
 861 --     (D:Baz @ CLasH.HardwareTypes.Bit bitbaz)
 862 --
 863 -- Here, baz is the method selector for the baz method, while
 864 -- D:Baz is the dictionary constructor for the Baz and bitbaz is the baz
 865 -- method defined in the Baz Bit instance declaration.
 866 --
 867 -- To resolve this, we can look at the ClassOp IdInfo from the baz Id,
 868 -- which contains the Class it is defined for. From the Class, we can
 869 -- get a list of all selectors (both parent class selectors as well as
 870 -- method selectors). Since the arguments to D:Baz (after the type
 871 -- argument) correspond exactly to this list, we then look up baz in
 872 -- that list and replace the entire expression by the corresponding
 873 -- argument to D:Baz.
 874 --
 875 -- We don't resolve methods that have a builtin translation (such as
 876 -- ==), since the actual implementation is not always (easily)
 877 -- translateable. For example, when deriving ==, GHC generates code
 878 -- using $con2tag functions to translate a datacon to an int and compare
 879 -- that with GHC.Prim.==# . Better to avoid that for now.
 880 classopresolution :: Transform
 881 classopresolution c expr@(App (App (Var sel) ty) dict) | not is_builtin =
 882   case Id.isClassOpId_maybe sel of
 883     -- Not a class op selector
 884     Nothing -> return expr
 885     Just cls -> case collectArgs dict of
 886       (_, []) -> return expr -- Dict is not an application (e.g., not inlined yet)
 887       (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)
 888                                 | tyargs_neq ty ty' -> error $ "Normalize.classopresolution: Applying class selector to dictionary without matching type?\n" ++ pprString expr
 889                                 | otherwise ->
 890         let selector_ids = Class.classSelIds cls in
 891         -- Find the selector used in the class' list of selectors
 892         case List.elemIndex sel selector_ids of
 893           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
 894           -- Get the corresponding argument from the dictionary
 895           Just n -> change (selectors!!n)
 896       (_, _) -> return expr -- Not applying a variable? Don't touch
 897   where
 898     -- Compare two type arguments, returning True if they are _not_
 899     -- equal
 900     tyargs_neq (Type ty1) (Type ty2) = not $ Type.coreEqType ty1 ty2
 901     tyargs_neq _ _ = True
 902     -- Is this a builtin function / method?
 903     is_builtin = elem (Name.getOccString sel) builtinIds
 904
 905 -- Leave all other expressions unchanged
 906 classopresolution c expr = return expr
 907
 908 --------------------------------
 909 -- Dictionary inlining
 910 --------------------------------
 911 -- Inline all top level dictionaries, that are in a position where
 912 -- classopresolution can actually resolve them. This makes this
 913 -- transformation look similar to classoperesolution below, but we'll
 914 -- keep them separated for clarity. By not inlining other dictionaries,
 915 -- we prevent expression sizes exploding when huge type level integer
 916 -- dictionaries are inlined which can never be expanded (in casts, for
 917 -- example).
 918 inlinedict c expr@(App (App (Var sel) ty) (Var dict)) | not is_builtin && is_classop = do
 919   body_maybe <- Trans.lift $ getGlobalBind dict
 920   case body_maybe of
 921     -- No body available (no source available, or a local variable /
 922     -- argument)
 923     Nothing -> return expr
 924     Just body -> change (App (App (Var sel) ty) body)
 925   where
 926     -- Is this a builtin function / method?
 927     is_builtin = elem (Name.getOccString sel) builtinIds
 928     -- Are we dealing with a class operation selector?
 929     is_classop = Maybe.isJust (Id.isClassOpId_maybe sel)
 930
 931 -- Leave all other expressions unchanged
 932 inlinedict c expr = return expr
 933
 934
 935 {-
 936 --------------------------------
 937 -- Identical let binding merging
 938 --------------------------------
 939 -- Merge two bindings in a let if they are identical
 940 -- TODO: We would very much like to use GHC's CSE module for this, but that
 941 -- doesn't track if something changed or not, so we can't use it properly.
 942 letmerge :: Transform
 943 letmerge c expr@(Let _ _) = do
 944   let (binds, res) = flattenLets expr
 945   binds' <- domerge binds
 946   return $ mkNonRecLets binds' res
 947   where
 948     domerge :: [(CoreBndr, CoreExpr)] -> TransformMonad [(CoreBndr, CoreExpr)]
 949     domerge [] = return []
 950     domerge (e:es) = do
 951       es' <- mapM (mergebinds e) es
 952       es'' <- domerge es'
 953       return (e:es'')
 954
 955     -- Uses the second bind to simplify the second bind, if applicable.
 956     mergebinds :: (CoreBndr, CoreExpr) -> (CoreBndr, CoreExpr) -> TransformMonad (CoreBndr, CoreExpr)
 957     mergebinds (b1, e1) (b2, e2)
 958       -- Identical expressions? Replace the second binding with a reference to
 959       -- the first binder.
 960       | CoreUtils.cheapEqExpr e1 e2 = change $ (b2, Var b1)
 961       -- Different expressions? Don't change
 962       | otherwise = return (b2, e2)
 963 -- Leave all other expressions unchanged
 964 letmerge c expr = return expr
 965 -}
 966
 967 --------------------------------
 968 -- End of transformations
 969 --------------------------------
 970
 971
 972
 973
 974 -- What transforms to run?
 975 transforms = [ ("inlinedict", inlinedict)
 976              , ("inlinetoplevel", inlinetoplevel)
 977              , ("inlinenonrepresult", inlinenonrepresult)
 978              , ("knowncase", knowncase)
 979              , ("classopresolution", classopresolution)
 980              , ("argprop", argprop)
 981              , ("funextract", funextract)
 982              , ("eta", eta)
 983              , ("beta", beta)
 984              , ("appprop", appprop)
 985              , ("castprop", castprop)
 986              , ("letremovesimple", letremovesimple)
 987              , ("letrec", letrec)
 988              , ("letremove", letremove)
 989              , ("retvalsimpl", retvalsimpl)
 990              , ("letflat", letflat)
 991              , ("scrutsimpl", scrutsimpl)
 992              , ("scrutbndrremove", scrutbndrremove)
 993              , ("casesimpl", casesimpl)
 994              , ("caseremove", caseremove)
 995              , ("inlinenonrep", inlinenonrep)
 996              , ("appsimpl", appsimpl)
 997              , ("letremoveunused", letremoveunused)
 998              , ("castsimpl", castsimpl)
 999              ]
1000
1001 -- | Returns the normalized version of the given function, or an error
1002 -- if it is not a known global binder.
1003 getNormalized ::
1004   Bool -- ^ Allow the result to be unrepresentable?
1005   -> CoreBndr -- ^ The function to get
1006   -> TranslatorSession CoreExpr -- The normalized function body
1007 getNormalized result_nonrep bndr = do
1008   norm <- getNormalized_maybe result_nonrep bndr
1009   return $ Maybe.fromMaybe
1010     (error $ "Normalize.getNormalized: Unknown or non-representable function requested: " ++ show bndr)
1011     norm
1012
1013 -- | Returns the normalized version of the given function, or Nothing
1014 -- when the binder is not a known global binder or is not normalizeable.
1015 getNormalized_maybe ::
1016   Bool -- ^ Allow the result to be unrepresentable?
1017   -> CoreBndr -- ^ The function to get
1018   -> TranslatorSession (Maybe CoreExpr) -- The normalized function body
1019
1020 getNormalized_maybe result_nonrep bndr = do
1021     expr_maybe <- getGlobalBind bndr
1022     normalizeable <- isNormalizeable result_nonrep bndr
1023     if not normalizeable || Maybe.isNothing expr_maybe
1024       then
1025         -- Binder not normalizeable or not found
1026         return Nothing
1027       else do
1028         -- Binder found and is monomorphic. Normalize the expression
1029         -- and cache the result.
1030         normalized <- Utils.makeCached bndr tsNormalized $
1031           normalizeExpr (show bndr) (Maybe.fromJust expr_maybe)
1032         return (Just normalized)
1033
1034 -- | Normalize an expression
1035 normalizeExpr ::
1036   String -- ^ What are we normalizing? For debug output only.
1037   -> CoreSyn.CoreExpr -- ^ The expression to normalize
1038   -> TranslatorSession CoreSyn.CoreExpr -- ^ The normalized expression
1039
1040 normalizeExpr what expr = do
1041       startcount <- MonadState.get tsTransformCounter
1042       expr_uniqued <- genUniques expr
1043       -- Do a debug print, if requested
1044       let expr_uniqued' = Utils.traceIf (normalize_debug >= NormDbgFinal) (what ++ " before normalization:\n\n" ++ showSDoc ( ppr expr_uniqued ) ++ "\n") expr_uniqued
1045       -- Normalize this expression
1046       expr' <- dotransforms transforms expr_uniqued'
1047       endcount <- MonadState.get tsTransformCounter
1048       -- Do a debug print, if requested
1049       Utils.traceIf (normalize_debug >= NormDbgFinal)  (what ++ " after normalization:\n\n" ++ showSDoc ( ppr expr') ++ "\nNeeded " ++ show (endcount - startcount) ++ " transformations to normalize " ++ what) $
1050         return expr'
1051
1052 -- | Split a normalized expression into the argument binders, top level
1053 --   bindings and the result binder. This function returns an error if
1054 --   the type of the expression is not representable.
1055 splitNormalized ::
1056   CoreExpr -- ^ The normalized expression
1057   -> ([CoreBndr], [Binding], CoreBndr)
1058 splitNormalized expr =
1059   case splitNormalizedNonRep expr of
1060     (args, binds, Var res) -> (args, binds, res)
1061     _ -> error $ "Normalize.splitNormalized: Not in normal form: " ++ pprString expr ++ "\n"
1062
1063 -- Split a normalized expression, whose type can be unrepresentable.
1064 splitNormalizedNonRep::
1065   CoreExpr -- ^ The normalized expression
1066   -> ([CoreBndr], [Binding], CoreExpr)
1067 splitNormalizedNonRep expr = (args, binds, resexpr)
1068   where
1069     (args, letexpr) = CoreSyn.collectBinders expr
1070     (binds, resexpr) = flattenLets letexpr