cλash/CLasH/Translator.hs

   1 module CLasH.Translator
   2   ( makeVHDLStrings
   3   , makeVHDLAnnotations
   4   ) where
   5
   6 -- Standard Modules
   7 import qualified System.Directory as Directory
   8 import qualified Maybe
   9 import qualified Monad
  10 import qualified System.FilePath as FilePath
  11 import qualified Control.Monad.Trans.State as State
  12 import Text.PrettyPrint.HughesPJ (render)
  13 import Data.Accessor
  14 import qualified Data.Map as Map
  15
  16 -- GHC API
  17 import qualified CoreSyn
  18 import qualified GHC
  19 import qualified HscTypes
  20 import qualified UniqSupply
  21
  22 -- VHDL Imports
  23 import qualified Language.VHDL.AST as AST
  24 import qualified Language.VHDL.FileIO
  25 import qualified Language.VHDL.Ppr as Ppr
  26
  27 -- Local Imports
  28 import CLasH.Normalize
  29 import CLasH.Translator.TranslatorTypes
  30 import CLasH.Translator.Annotations
  31 import CLasH.Utils
  32 import CLasH.Utils.Core.CoreTools
  33 import CLasH.Utils.GhcTools
  34 import CLasH.VHDL
  35 import CLasH.VHDL.Testbench
  36
  37 -- | Turn Haskell to VHDL, Usings Strings to indicate the Top Entity, Initial
  38 --   State and Test Inputs.
  39 makeVHDLStrings ::
  40   FilePath      -- ^ The GHC Library Dir
  41   -> [FilePath] -- ^ The FileNames
  42   -> String     -- ^ The TopEntity
  43   -> String     -- ^ The InitState
  44   -> String     -- ^ The TestInput
  45   -> IO ()
  46 makeVHDLStrings libdir filenames topentity initstate testinput = do
  47   makeVHDL libdir filenames finder
  48     where
  49       finder = findSpec (hasVarName topentity)
  50                         (hasVarName initstate)
  51                         (hasVarName testinput)
  52
  53 -- | Turn Haskell to VHDL, Using the Annotations for Top Entity, Initial State
  54 --   and Test Inputs found in the Files.
  55 makeVHDLAnnotations ::
  56   FilePath      -- ^ The GHC Library Dir
  57   -> [FilePath] -- ^ The FileNames
  58   -> IO ()
  59 makeVHDLAnnotations libdir filenames = do
  60   makeVHDL libdir filenames finder
  61     where
  62       finder = findSpec (hasCLasHAnnotation isTopEntity)
  63                         (hasCLasHAnnotation isInitState)
  64                         (hasCLasHAnnotation isTestInput)
  65
  66 -- | Turn Haskell to VHDL, using the given finder functions to find the Top
  67 --   Entity, Initial State and Test Inputs in the Haskell Files.
  68 makeVHDL ::
  69   FilePath      -- ^ The GHC Library Dir
  70   -> [FilePath] -- ^ The Filenames
  71   -> Finder
  72   -> IO ()
  73 makeVHDL libdir filenames finder = do
  74   -- Load the modules
  75   (cores, env, specs) <- loadModules libdir filenames (Just finder)
  76   -- Translate to VHDL
  77   vhdl <- moduleToVHDL env cores specs
  78   -- Write VHDL to file. Just use the first entity for the name
  79   let top_entity = (\(t, _, _) -> t) $ head specs
  80   let dir = "./vhdl/" ++ (show top_entity) ++ "/"
  81   prepareDir dir
  82   mapM (writeVHDL dir) vhdl
  83   return ()
  84
  85 -- | Translate the specified entities in the given modules to VHDL.
  86 moduleToVHDL ::
  87   HscTypes.HscEnv             -- ^ The GHC Environment
  88   -> [HscTypes.CoreModule]    -- ^ The Core Modules
  89   -> [EntitySpec]             -- ^ The entities to generate
  90   -> IO [(AST.VHDLId, AST.DesignFile)]
  91 moduleToVHDL env cores specs = do
  92   vhdl <- runTranslatorSession env $ do
  93     let all_bindings = concat (map (\x -> CoreSyn.flattenBinds (HscTypes.cm_binds x)) cores)
  94     -- Store the bindings we loaded
  95     tsBindings %= Map.fromList all_bindings
  96     test_binds <- catMaybesM $ Monad.mapM mkTest specs
  97     let topbinds = map (\(top, _, _) -> top) specs
  98     createDesignFiles (topbinds ++ test_binds)
  99   mapM (putStr . render . Ppr.ppr . snd) vhdl
 100   return vhdl
 101   where
 102     mkTest :: EntitySpec -> TranslatorSession (Maybe CoreSyn.CoreBndr)
 103     -- Create a testbench for any entry that has test input
 104     mkTest (_, _, Nothing) = return Nothing
 105     mkTest (top, _, Just input) = do
 106       bndr <- createTestbench Nothing input top
 107       return $ Just bndr
 108
 109 -- Run the given translator session. Generates a new UniqSupply for that
 110 -- session.
 111 runTranslatorSession :: HscTypes.HscEnv -> TranslatorSession a -> IO a
 112 runTranslatorSession env session = do
 113   -- Generate a UniqSupply
 114   -- Running
 115   --    egrep -r "(initTcRnIf|mkSplitUniqSupply)" .
 116   -- on the compiler dir of ghc suggests that 'z' is not used to generate
 117   -- a unique supply anywhere.
 118   uniqSupply <- UniqSupply.mkSplitUniqSupply 'z'
 119   let init_typestate = TypeState Map.empty [] Map.empty Map.empty env
 120   let init_state = TranslatorState uniqSupply init_typestate Map.empty Map.empty Map.empty Map.empty
 121   return $ State.evalState session init_state
 122
 123 -- | Prepares the directory for writing VHDL files. This means creating the
 124 --   dir if it does not exist and removing all existing .vhdl files from it.
 125 prepareDir :: String -> IO()
 126 prepareDir dir = do
 127   -- Create the dir if needed
 128   Directory.createDirectoryIfMissing True dir
 129   -- Find all .vhdl files in the directory
 130   files <- Directory.getDirectoryContents dir
 131   let to_remove = filter ((==".vhdl") . FilePath.takeExtension) files
 132   -- Prepend the dirname to the filenames
 133   let abs_to_remove = map (FilePath.combine dir) to_remove
 134   -- Remove the files
 135   mapM_ Directory.removeFile abs_to_remove
 136
 137 -- | Write the given design file to a file with the given name inside the
 138 --   given dir
 139 writeVHDL :: String -> (AST.VHDLId, AST.DesignFile) -> IO ()
 140 writeVHDL dir (name, vhdl) = do
 141   -- Find the filename
 142   let fname = dir ++ (AST.fromVHDLId name) ++ ".vhdl"
 143   -- Write the file
 144   Language.VHDL.FileIO.writeDesignFile vhdl fname
 145
 146 -- vim: set ts=8 sw=2 sts=2 expandtab: