FlattenTypes.hs

   1 module FlattenTypes where
   2
   3 import qualified Maybe
   4 import Data.Traversable
   5 import qualified Data.Foldable as Foldable
   6 import qualified Control.Monad.State as State
   7
   8 import CoreSyn
   9 import qualified Type
  10
  11 import HsValueMap
  12
  13 -- | A signal identifier
  14 type SignalId = Int
  15
  16 -- | A map of a Haskell value to signal ids
  17 type SignalMap = HsValueMap SignalId
  18
  19 -- | A state identifier
  20 type StateId = Int
  21
  22 -- | How is a given (single) value in a function's type (ie, argument or
  23 --   return value) used?
  24 data HsValueUse =
  25   Port           -- ^ Use it as a port (input or output)
  26   | State StateId -- ^ Use it as state (input or output). The int is used to
  27                  --   match input state to output state.
  28   | HighOrder {  -- ^ Use it as a high order function input
  29     hoName :: String,  -- ^ Which function is passed in?
  30     hoArgs :: [HsUseMap]   -- ^ Which arguments are already applied? This
  31                          -- ^ map should only contain Port and other
  32                          --   HighOrder values.
  33   }
  34   deriving (Show, Eq, Ord)
  35
  36 -- | Is this HsValueUse a state use?
  37 isStateUse :: HsValueUse -> Bool
  38 isStateUse (State _) = True
  39 isStateUse _         = False
  40
  41 -- | A map from a Haskell value to the use of each single value
  42 type HsUseMap = HsValueMap HsValueUse
  43
  44 -- | Builds a HsUseMap with the same structure has the given HsValueMap in
  45 --   which all the Single elements are marked as State, with increasing state
  46 --   numbers.
  47 useAsState :: HsValueMap a -> HsUseMap
  48 useAsState map =
  49   map'
  50   where
  51     -- Traverse the existing map, resulting in a function that maps an initial
  52     -- state number to the final state number and the new map
  53     PassState f = traverse asState map
  54     -- Run this function to get the new map
  55     (_, map')   = f 0
  56     -- This function maps each element to a State with a unique number, by
  57     -- incrementing the state count.
  58     asState x   = PassState (\s -> (s+1, State s))
  59
  60 -- | Builds a HsUseMap with the same structure has the given HsValueMap in
  61 --   which all the Single elements are marked as Port.
  62 useAsPort :: HsValueMap a -> HsUseMap
  63 useAsPort map = fmap (\x -> Port) map
  64
  65 -- | A Haskell function with a specific signature. The signature defines what
  66 --   use the arguments and return value of the function get.
  67 data HsFunction = HsFunction {
  68   hsFuncName :: String,
  69   hsFuncArgs :: [HsUseMap],
  70   hsFuncRes  :: HsUseMap
  71 } deriving (Show, Eq, Ord)
  72
  73 hasState :: HsFunction -> Bool
  74 hasState hsfunc =
  75   any (Foldable.any isStateUse) (hsFuncArgs hsfunc)
  76   || Foldable.any isStateUse (hsFuncRes hsfunc)
  77
  78 -- | Something that defines a signal
  79 data SigDef =
  80   -- | A flattened function application
  81   FApp {
  82     appFunc :: HsFunction,
  83     appArgs :: [SignalMap],
  84     appRes  :: SignalMap
  85   }
  86   -- | A conditional signal definition
  87   | CondDef {
  88     cond    :: SignalId,
  89     high    :: SignalId,
  90     low     :: SignalId,
  91     condRes :: SignalId
  92   }
  93   -- | Unconditional signal definition
  94   | UncondDef {
  95     defSrc :: Either SignalId SignalExpr,
  96     defDst :: SignalId
  97   } deriving (Show, Eq)
  98
  99 -- | An expression on signals
 100 data SignalExpr =
 101   EqLit SignalId String -- ^ Is the given signal equal to the given (VHDL) literal
 102   | Literal String -- ^ A literal value
 103   | Eq SignalId SignalId -- ^ A comparison between to signals
 104   deriving (Show, Eq)
 105
 106 -- Returns the function used by the given SigDef, if any
 107 usedHsFunc :: SigDef -> Maybe HsFunction
 108 usedHsFunc (FApp hsfunc _ _) = Just hsfunc
 109 usedHsFunc _ = Nothing
 110
 111 -- | How is a given signal used in the resulting VHDL?
 112 data SigUse =
 113   SigPortIn          -- | Use as an input port
 114   | SigPortOut       -- | Use as an input port
 115   | SigInternal      -- | Use as an internal signal
 116   | SigStateOld StateId  -- | Use as the current internal state
 117   | SigStateNew StateId  -- | Use as the new internal state
 118   | SigSubState      -- | Do not use, state variable is used in a subcircuit
 119
 120 -- | Is this a port signal use?
 121 isPortSigUse :: SigUse -> Bool
 122 isPortSigUse SigPortIn = True
 123 isPortSigUse SigPortOut = True
 124 isPortSigUse _ = False
 125
 126 -- | Is this a state signal use? Returns false for substate.
 127 isStateSigUse :: SigUse -> Bool
 128 isStateSigUse (SigStateOld _) = True
 129 isStateSigUse (SigStateNew _) = True
 130 isStateSigUse _ = False
 131
 132 -- | Is this an internal signal use?
 133 isInternalSigUse :: SigUse -> Bool
 134 isInternalSigUse SigInternal = True
 135 isInternalSigUse _ = False
 136
 137 -- | Information on a signal definition
 138 data SignalInfo = SignalInfo {
 139   sigName :: Maybe String,
 140   sigUse  :: SigUse,
 141   sigTy   :: Type.Type,
 142   nameHints :: [String]
 143 }
 144
 145 -- | A flattened function
 146 data FlatFunction = FlatFunction {
 147   flat_args   :: [SignalMap],
 148   flat_res    :: SignalMap,
 149   flat_defs   :: [SigDef],
 150   flat_sigs   :: [(SignalId, SignalInfo)]
 151 }
 152
 153 -- | Lookup a given signal id in a signal map, and return the associated
 154 --   SignalInfo. Errors out if the signal was not found.
 155 signalInfo :: [(SignalId, SignalInfo)] -> SignalId -> SignalInfo
 156 signalInfo sigs id = Maybe.fromJust $ lookup id sigs
 157
 158 -- | A list of binds in effect at a particular point of evaluation
 159 type BindMap = [(
 160   CoreBndr,            -- ^ The bind name
 161   BindValue            -- ^ The value bound to it
 162   )]
 163
 164 type BindValue =
 165   Either               -- ^ The bind value which is either
 166     (SignalMap)
 167                        -- ^ a signal
 168     (
 169       HsValueUse,      -- ^ or a HighOrder function
 170       [SignalId]       -- ^ With these signals already applied to it
 171     )
 172
 173 -- | The state during the flattening of a single function
 174 type FlattenState = State.State ([SigDef], [(SignalId, SignalInfo)], SignalId)
 175
 176 -- | Add an application to the current FlattenState
 177 addDef :: SigDef -> FlattenState ()
 178 addDef d = do
 179   (defs, sigs, n) <- State.get
 180   State.put (d:defs, sigs, n)
 181
 182 -- | Generates a new signal id, which is unique within the current flattening.
 183 genSignalId :: SigUse -> Type.Type -> FlattenState SignalId
 184 genSignalId use ty = do
 185   (defs, sigs, n) <- State.get
 186   -- Generate a new numbered but unnamed signal
 187   let s = (n, SignalInfo Nothing use ty [])
 188   State.put (defs, s:sigs, n+1)
 189   return n
 190
 191 -- | Add a name hint to the given signal
 192 addNameHint :: String -> SignalId -> FlattenState ()
 193 addNameHint hint id = do
 194   info <- getSignalInfo id
 195   let hints = nameHints info
 196   if hint `elem` hints
 197     then do
 198       return ()
 199     else do
 200       let hints' = (hint:hints)
 201       setSignalInfo id (info {nameHints = hints'})
 202
 203 -- | Returns the SignalInfo for the given signal. Errors if the signal is not
 204 --   known in the session.
 205 getSignalInfo :: SignalId -> FlattenState SignalInfo
 206 getSignalInfo id = do
 207   (defs, sigs, n) <- State.get
 208   return $ signalInfo sigs id
 209
 210 setSignalInfo :: SignalId -> SignalInfo -> FlattenState ()
 211 setSignalInfo id' info' = do
 212   (defs, sigs, n) <- State.get
 213   let sigs' = map (\(id, info) -> (id, if id == id' then info' else info)) sigs
 214   State.put (defs, sigs', n)