module Flatten where
import CoreSyn
+import Control.Monad
+import qualified Var
import qualified Type
import qualified Name
-import qualified TyCon
import qualified Maybe
+import qualified Control.Arrow as Arrow
import qualified DataCon
import qualified CoreUtils
+import qualified Data.Traversable as Traversable
+import qualified Data.Foldable as Foldable
+import Control.Applicative
import Outputable ( showSDoc, ppr )
import qualified Control.Monad.State as State
--- | A datatype that maps each of the single values in a haskell structure to
--- a mapto. The map has the same structure as the haskell type mapped, ie
--- nested tuples etc.
-data HsValueMap mapto =
- Tuple [HsValueMap mapto]
- | Single mapto
- deriving (Show, Eq)
-
-instance Functor HsValueMap where
- fmap f (Single s) = Single (f s)
- fmap f (Tuple maps) = Tuple (fmap (fmap f) maps)
-
--- | Creates a HsValueMap with the same structure as the given type, using the
--- given function for mapping the single types.
-mkHsValueMap ::
- Type.Type -- ^ The type to map to a HsValueMap
- -> HsValueMap Type.Type -- ^ The resulting map and state
-
-mkHsValueMap ty =
- case Type.splitTyConApp_maybe ty of
- Just (tycon, args) ->
- if (TyCon.isTupleTyCon tycon)
- then
- Tuple (map mkHsValueMap args)
- else
- Single ty
- Nothing -> Single ty
+import HsValueMap
+import TranslatorTypes
+import FlattenTypes
-- Extract the arguments from a data constructor application (that is, the
-- normal args, leaving out the type args).
where
tycount = length $ DataCon.dataConAllTyVars dc
-
-
-data FlatFunction = FlatFunction {
- args :: [SignalDefMap],
- res :: SignalUseMap,
- --sigs :: [SignalDef],
- apps :: [FApp],
- conds :: [CondDef]
-} deriving (Show, Eq)
-
-type SignalUseMap = HsValueMap SignalUse
-type SignalDefMap = HsValueMap SignalDef
-
-useMapToDefMap :: SignalUseMap -> SignalDefMap
-useMapToDefMap = fmap (\(SignalUse u) -> SignalDef u)
-
-defMapToUseMap :: SignalDefMap -> SignalUseMap
-defMapToUseMap = fmap (\(SignalDef u) -> SignalUse u)
-
-
-type SignalId = Int
-data SignalUse = SignalUse {
- sigUseId :: SignalId
-} deriving (Show, Eq)
-
-data SignalDef = SignalDef {
- sigDefId :: SignalId
-} deriving (Show, Eq)
-
-data FApp = FApp {
- appFunc :: HsFunction,
- appArgs :: [SignalUseMap],
- appRes :: SignalDefMap
-} deriving (Show, Eq)
-
-data CondDef = CondDef {
- cond :: SignalUse,
- high :: SignalUse,
- low :: SignalUse,
- condRes :: SignalDef
-} deriving (Show, Eq)
-
--- | How is a given (single) value in a function's type (ie, argument or
--- return value) used?
-data HsValueUse =
- Port -- ^ Use it as a port (input or output)
- | State Int -- ^ Use it as state (input or output). The int is used to
- -- match input state to output state.
- | HighOrder { -- ^ Use it as a high order function input
- hoName :: String, -- ^ Which function is passed in?
- hoArgs :: [HsUseMap] -- ^ Which arguments are already applied? This
- -- ^ map should only contain Port and other
- -- HighOrder values.
- }
- deriving (Show, Eq)
-
-type HsUseMap = HsValueMap HsValueUse
-
-data HsFunction = HsFunction {
- hsFuncName :: String,
- hsFuncArgs :: [HsUseMap],
- hsFuncRes :: HsUseMap
-} deriving (Show, Eq)
-
-type BindMap = [(
- CoreBndr, -- ^ The bind name
- Either -- ^ The bind value which is either
- SignalUseMap -- ^ a signal
- (
- HsValueUse, -- ^ or a HighOrder function
- [SignalUse] -- ^ With these signals already applied to it
- )
- )]
-
-type FlattenState = State.State ([FApp], [CondDef], SignalId)
-
--- | Add an application to the current FlattenState
-addApp :: FApp -> FlattenState ()
-addApp a = do
- (apps, conds, n) <- State.get
- State.put (a:apps, conds, n)
-
--- | Add a conditional definition to the current FlattenState
-addCondDef :: CondDef -> FlattenState ()
-addCondDef c = do
- (apps, conds, n) <- State.get
- State.put (apps, c:conds, n)
-
--- | Generates a new signal id, which is unique within the current flattening.
-genSignalId :: FlattenState SignalId
-genSignalId = do
- (apps, conds, n) <- State.get
- State.put (apps, conds, n+1)
- return n
-
-genSignalUses ::
+genSignals ::
Type.Type
- -> FlattenState SignalUseMap
-
-genSignalUses ty = do
- typeMapToUseMap tymap
+ -> FlattenState (SignalMap UnnamedSignal)
+
+genSignals ty =
+ -- First generate a map with the right structure containing the types, and
+ -- generate signals for each of them.
+ Traversable.mapM (\ty -> genSignalId SigInternal ty) (mkHsValueMap ty)
+
+-- | Marks a signal as the given SigUse, if its id is in the list of id's
+-- given.
+markSignals :: SigUse -> [UnnamedSignal] -> (UnnamedSignal, SignalInfo) -> (UnnamedSignal, SignalInfo)
+markSignals use ids (id, info) =
+ (id, info')
where
- -- First generate a map with the right structure containing the types
- tymap = mkHsValueMap ty
-
-typeMapToUseMap ::
- HsValueMap Type.Type
- -> FlattenState SignalUseMap
-
-typeMapToUseMap (Single ty) = do
- id <- genSignalId
- return $ Single (SignalUse id)
+ info' = if id `elem` ids then info { sigUse = use} else info
-typeMapToUseMap (Tuple tymaps) = do
- usemaps <- mapM typeMapToUseMap tymaps
- return $ Tuple usemaps
+markSignal :: SigUse -> UnnamedSignal -> (UnnamedSignal, SignalInfo) -> (UnnamedSignal, SignalInfo)
+markSignal use id = markSignals use [id]
-- | Flatten a haskell function
flattenFunction ::
flattenFunction _ (Rec _) = error "Recursive binders not supported"
flattenFunction hsfunc bind@(NonRec var expr) =
- FlatFunction args res apps conds
+ FlatFunction args res apps conds sigs''''
where
- init_state = ([], [], 0)
+ init_state = ([], [], [], 0)
(fres, end_state) = State.runState (flattenExpr [] expr) init_state
+ (apps, conds, sigs, _) = end_state
(args, res) = fres
- (apps, conds, _) = end_state
+ arg_ports = concat (map Foldable.toList args)
+ res_ports = Foldable.toList res
+ -- Mark args and result signals as input and output ports resp.
+ sigs' = fmap (markSignals SigPortIn arg_ports) sigs
+ sigs'' = fmap (markSignals SigPortOut res_ports) sigs'
+ -- Mark args and result states as old and new state resp.
+ args_states = concat $ zipWith stateList (hsFuncArgs hsfunc) args
+ sigs''' = foldl (\s (num, id) -> map (markSignal (SigStateOld num) id) s) sigs'' args_states
+ res_states = stateList (hsFuncRes hsfunc) res
+ sigs'''' = foldl (\s (num, id) -> map (markSignal (SigStateNew num) id) s) sigs''' res_states
flattenExpr ::
BindMap
-> CoreExpr
- -> FlattenState ([SignalDefMap], SignalUseMap)
+ -> FlattenState ([SignalMap UnnamedSignal], (SignalMap UnnamedSignal))
flattenExpr binds lam@(Lam b expr) = do
-- Find the type of the binder
let (arg_ty, _) = Type.splitFunTy (CoreUtils.exprType lam)
-- Create signal names for the binder
- defs <- genSignalUses arg_ty
+ defs <- genSignals arg_ty
let binds' = (b, Left defs):binds
(args, res) <- flattenExpr binds' expr
- return ((useMapToDefMap defs) : args, res)
+ return (defs : args, res)
flattenExpr binds (Var id) =
case bind of
let ((Var f), args) = collectArgs app in
flattenApplicationExpr binds (CoreUtils.exprType app) f args
where
- flattenBuildTupleExpr = error $ "Tuple construction not supported: " ++ (showSDoc $ ppr app)
- flattenApplicationExpr binds ty f args = error $ "Function application not supported: " ++ (showSDoc $ ppr app)
-
+ flattenBuildTupleExpr binds args = do
+ -- Flatten each of our args
+ flat_args <- (State.mapM (flattenExpr binds) args)
+ -- Check and split each of the arguments
+ let (_, arg_ress) = unzip (zipWith checkArg args flat_args)
+ let res = Tuple arg_ress
+ return ([], res)
+
+ -- | Flatten a normal application expression
+ flattenApplicationExpr binds ty f args = do
+ -- Find the function to call
+ let func = appToHsFunction ty f args
+ -- Flatten each of our args
+ flat_args <- (State.mapM (flattenExpr binds) args)
+ -- Check and split each of the arguments
+ let (_, arg_ress) = unzip (zipWith checkArg args flat_args)
+ -- Generate signals for our result
+ res <- genSignals ty
+ -- Create the function application
+ let app = FApp {
+ appFunc = func,
+ appArgs = arg_ress,
+ appRes = res
+ }
+ addApp app
+ return ([], res)
+ -- | Check a flattened expression to see if it is valid to use as a
+ -- function argument. The first argument is the original expression for
+ -- use in the error message.
+ checkArg arg flat =
+ let (args, res) = flat in
+ if not (null args)
+ then error $ "Passing lambda expression or function as a function argument not supported: " ++ (showSDoc $ ppr arg)
+ else flat
+
+flattenExpr binds l@(Let (NonRec b bexpr) expr) = do
+ (b_args, b_res) <- flattenExpr binds bexpr
+ if not (null b_args)
+ then
+ error $ "Higher order functions not supported in let expression: " ++ (showSDoc $ ppr l)
+ else
+ let binds' = (b, Left b_res) : binds in
+ flattenExpr binds' expr
+
+flattenExpr binds l@(Let (Rec _) _) = error $ "Recursive let definitions not supported: " ++ (showSDoc $ ppr l)
+
+flattenExpr binds expr@(Case (Var v) b _ alts) =
+ case alts of
+ [alt] -> flattenSingleAltCaseExpr binds v b alt
+ otherwise -> error $ "Multiple alternative case expression not supported: " ++ (showSDoc $ ppr expr)
+ where
+ flattenSingleAltCaseExpr ::
+ BindMap
+ -- A list of bindings in effect
+ -> Var.Var -- The scrutinee
+ -> CoreBndr -- The binder to bind the scrutinee to
+ -> CoreAlt -- The single alternative
+ -> FlattenState ( [SignalMap UnnamedSignal], SignalMap UnnamedSignal)
+ -- See expandExpr
+ flattenSingleAltCaseExpr binds v b alt@(DataAlt datacon, bind_vars, expr) =
+ if not (DataCon.isTupleCon datacon)
+ then
+ error $ "Dataconstructors other than tuple constructors not supported in case pattern of alternative: " ++ (showSDoc $ ppr alt)
+ else
+ let
+ -- Lookup the scrutinee (which must be a variable bound to a tuple) in
+ -- the existing bindings list and get the portname map for each of
+ -- it's elements.
+ Left (Tuple tuple_sigs) = Maybe.fromMaybe
+ (error $ "Case expression uses unknown scrutinee " ++ Name.getOccString v)
+ (lookup v binds)
+ -- TODO include b in the binds list
+ -- Merge our existing binds with the new binds.
+ binds' = (zip bind_vars (map Left tuple_sigs)) ++ binds
+ in
+ -- Expand the expression with the new binds list
+ flattenExpr binds' expr
+ flattenSingleAltCaseExpr _ _ _ alt = error $ "Case patterns other than data constructors not supported in case alternative: " ++ (showSDoc $ ppr alt)
+
+
+
flattenExpr _ _ = do
return ([], Tuple [])
+appToHsFunction ::
+ Type.Type -- ^ The return type
+ -> Var.Var -- ^ The function to call
+ -> [CoreExpr] -- ^ The function arguments
+ -> HsFunction -- ^ The needed HsFunction
+appToHsFunction ty f args =
+ HsFunction hsname hsargs hsres
+ where
+ hsname = Name.getOccString f
+ hsargs = map (useAsPort . mkHsValueMap . CoreUtils.exprType) args
+ hsres = useAsPort (mkHsValueMap ty)
+
+-- | Filters non-state signals and returns the state number and signal id for
+-- state values.
+filterState ::
+ UnnamedSignal -- | The signal id to look at
+ -> HsValueUse -- | How is this signal used?
+ -> Maybe (Int, UnnamedSignal ) -- | The state num and signal id, if this
+ -- signal was used as state
+
+filterState id (State num) =
+ Just (num, id)
+filterState _ _ = Nothing
+
+-- | Returns a list of the state number and signal id of all used-as-state
+-- signals in the given maps.
+stateList ::
+ HsUseMap
+ -> (SignalMap UnnamedSignal)
+ -> [(Int, UnnamedSignal)]
+
+stateList uses signals =
+ Maybe.catMaybes $ Foldable.toList $ zipValueMapsWith filterState signals uses
+
+-- | Returns pairs of signals that should be mapped to state in this function.
+getOwnStates ::
+ HsFunction -- | The function to look at
+ -> FlatFunction -- | The function to look at
+ -> [(Int, SignalInfo, SignalInfo)]
+ -- | The state signals. The first is the state number, the second the
+ -- signal to assign the current state to, the last is the signal
+ -- that holds the new state.
+
+getOwnStates hsfunc flatfunc =
+ [(old_num, old_info, new_info)
+ | (old_num, old_info) <- args_states
+ , (new_num, new_info) <- res_states
+ , old_num == new_num]
+ where
+ sigs = flat_sigs flatfunc
+ -- Translate args and res to lists of (statenum, sigid)
+ args = concat $ zipWith stateList (hsFuncArgs hsfunc) (flat_args flatfunc)
+ res = stateList (hsFuncRes hsfunc) (flat_res flatfunc)
+ -- Replace the second tuple element with the corresponding SignalInfo
+ args_states = map (Arrow.second $ signalInfo sigs) args
+ res_states = map (Arrow.second $ signalInfo sigs) res
+
+
-- vim: set ts=8 sw=2 sts=2 expandtab: