cλash/CLasH/Translator/TranslatorTypes.hs

   1 --
   2 -- Simple module providing some types used by Translator. These are in a
   3 -- separate module to prevent circular dependencies in Pretty for example.
   4 --
   5 {-# LANGUAGE TemplateHaskell #-}
   6 module CLasH.Translator.TranslatorTypes where
   7
   8 -- Standard modules
   9 import qualified Control.Monad.Trans.State as State
  10 import qualified Data.Map as Map
  11 import qualified Data.Accessor.Template
  12 import Data.Accessor
  13
  14 -- GHC API
  15 import qualified GHC
  16 import qualified CoreSyn
  17 import qualified Type
  18 import qualified HscTypes
  19 import qualified UniqSupply
  20
  21 -- ForSyDe
  22 import qualified Language.VHDL.AST as AST
  23
  24 -- Local imports
  25 import CLasH.VHDL.VHDLTypes
  26
  27 -- | A specification of an entity we can generate VHDL for. Consists of the
  28 --   binder of the top level entity, an optional initial state and an optional
  29 --   test input.
  30 type EntitySpec = (CoreSyn.CoreBndr, Maybe CoreSyn.CoreExpr, Maybe CoreSyn.CoreExpr)
  31
  32 -- | A function that knows which parts of a module to compile
  33 type Finder =
  34   HscTypes.CoreModule -- ^ The module to look at
  35   -> GHC.Ghc [EntitySpec]
  36
  37 -----------------------------------------------------------------------------
  38 -- The TranslatorSession
  39 -----------------------------------------------------------------------------
  40
  41 -- A orderable equivalent of CoreSyn's Type for use as a map key
  42 newtype OrdType = OrdType { getType :: Type.Type }
  43 instance Eq OrdType where
  44   (OrdType a) == (OrdType b) = Type.tcEqType a b
  45 instance Ord OrdType where
  46   compare (OrdType a) (OrdType b) = Type.tcCmpType a b
  47
  48 data HType = StdType OrdType |
  49              ADTType String [HType] |
  50              VecType Int HType |
  51              SizedWType Int |
  52              RangedWType Int |
  53              SizedIType Int |
  54              BuiltinType String
  55   deriving (Eq, Ord)
  56
  57 -- A map of a Core type to the corresponding type name
  58 type TypeMap = Map.Map HType (AST.VHDLId, Either AST.TypeDef AST.SubtypeIn)
  59
  60 -- A map of a vector Core element type and function name to the coressponding
  61 -- VHDLId of the function and the function body.
  62 type TypeFunMap = Map.Map (OrdType, String) (AST.VHDLId, AST.SubProgBody)
  63
  64 type TfpIntMap = Map.Map OrdType Int
  65 -- A substate that deals with type generation
  66 data TypeState = TypeState {
  67   -- | A map of Core type -> VHDL Type
  68   tsTypes_      :: TypeMap,
  69   -- | A list of type declarations
  70   tsTypeDecls_  :: [AST.PackageDecItem],
  71   -- | A map of vector Core type -> VHDL type function
  72   tsTypeFuns_   :: TypeFunMap,
  73   tsTfpInts_    :: TfpIntMap,
  74   tsHscEnv_     :: HscTypes.HscEnv
  75 }
  76
  77 -- Derive accessors
  78 $( Data.Accessor.Template.deriveAccessors ''TypeState )
  79
  80 -- Define a session
  81 type TypeSession = State.State TypeState
  82 -- A global state for the translator
  83 data TranslatorState = TranslatorState {
  84     tsUniqSupply_ :: UniqSupply.UniqSupply
  85   , tsType_ :: TypeState
  86   , tsBindings_ :: Map.Map CoreSyn.CoreBndr CoreSyn.CoreExpr
  87   , tsNormalized_ :: Map.Map CoreSyn.CoreBndr CoreSyn.CoreExpr
  88   , tsEntities_ :: Map.Map CoreSyn.CoreBndr Entity
  89   , tsArchitectures_ :: Map.Map CoreSyn.CoreBndr (Architecture, [CoreSyn.CoreBndr])
  90 }
  91
  92 -- Derive accessors
  93 $( Data.Accessor.Template.deriveAccessors ''TranslatorState )
  94
  95 type TranslatorSession = State.State TranslatorState
  96
  97 -----------------------------------------------------------------------------
  98 -- Some accessors
  99 -----------------------------------------------------------------------------
 100
 101 -- Does the given binder reference a top level binder in the current
 102 -- module(s)?
 103 isTopLevelBinder :: CoreSyn.CoreBndr -> TranslatorSession Bool
 104 isTopLevelBinder bndr = do
 105   bindings <- getA tsBindings
 106   return $ Map.member bndr bindings
 107
 108 -- Finds the value of a global binding, if available
 109 getGlobalBind :: CoreSyn.CoreBndr -> TranslatorSession (Maybe CoreSyn.CoreExpr)
 110 getGlobalBind bndr = do
 111   bindings <- getA tsBindings
 112   return $ Map.lookup bndr bindings
 113
 114 -- Adds a new global binding with the given value
 115 addGlobalBind :: CoreSyn.CoreBndr -> CoreSyn.CoreExpr -> TranslatorSession ()
 116 addGlobalBind bndr expr = modA tsBindings (Map.insert bndr expr)
 117
 118 -- Returns a list of all global binders
 119 getGlobalBinders :: TranslatorSession [CoreSyn.CoreBndr]
 120 getGlobalBinders = do
 121   bindings <- getA tsBindings
 122   return $ Map.keys bindings
 123
 124 -- vim: set ts=8 sw=2 sts=2 expandtab: