{-| Copyright : (C) 2013-2016, University of Twente, 2017, QBayLogic, Google Inc. License : BSD2 (see the file LICENSE) Maintainer : Christiaan Baaij -} {-# LANGUAGE CPP #-} {-# LANGUAGE LambdaCase #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} module Clash.GHC.GenerateBindings (generateBindings) where import Control.Arrow ((***), first) import Control.DeepSeq (deepseq) import Control.Lens ((%~),(&),(.~)) import Control.Monad (unless) import qualified Control.Monad.State as State import qualified Control.Monad.RWS.Strict as RWS import Data.Coerce (coerce) import Data.Either (partitionEithers, lefts, rights) import Data.IntMap.Strict (IntMap) import qualified Data.IntMap.Strict as IMS import qualified Data.HashMap.Strict as HashMap import Data.List (isPrefixOf) import qualified Data.Text as Text import qualified Data.Time.Clock as Clock import qualified GHC as GHC (Ghc) #if MIN_VERSION_ghc(9,0,0) import qualified GHC.Types.Basic as GHC import qualified GHC.Core as GHC import qualified GHC.Types.Demand as GHC import qualified GHC.Driver.Session as GHC import qualified GHC.Types.Id.Info as GHC import qualified GHC.Utils.Outputable as GHC import qualified GHC.Types.Name as GHC hiding (varName) import qualified GHC.Core.FamInstEnv as GHC import qualified GHC.Core.TyCon as GHC import qualified GHC.Core.Type as GHC import qualified GHC.Builtin.Types as GHC import qualified GHC.Utils.Misc as GHC import qualified GHC.Settings.Constants as GHC import qualified GHC.Types.Var as GHC import qualified GHC.Types.SrcLoc as GHC #else import qualified BasicTypes as GHC import qualified Constants as GHC import qualified CoreSyn as GHC import qualified Demand as GHC import qualified DynFlags as GHC import qualified FamInstEnv as GHC import qualified IdInfo as GHC import qualified Outputable as GHC import qualified Name as GHC hiding (varName) import qualified TyCon as GHC import qualified Type as GHC import qualified TysWiredIn as GHC import qualified Util as GHC import qualified Var as GHC import qualified SrcLoc as GHC #endif import Clash.Annotations.BitRepresentation.Internal (DataRepr') import Clash.Annotations.Primitive (HDL, extractPrim) import Clash.Signal.Internal import Clash.Core.Subst (extendGblSubstList, mkSubst, substTm) import Clash.Core.Term (Term (..), mkLams, mkTyLams) import Clash.Core.Type (Type (..), TypeView (..), mkFunTy, splitFunForallTy, tyView) import Clash.Core.TyCon (TyConMap, TyConName, isNewTypeTc) import Clash.Core.TysPrim (tysPrimMap) import Clash.Core.Util (mkInternalVar, mkSelectorCase) import Clash.Core.Var (Var (..), Id, IdScope (..), setIdScope) import Clash.Core.VarEnv (InScopeSet, VarEnv, emptyInScopeSet, extendInScopeSet, mkInScopeSet ,mkVarEnv, unionVarEnv, elemVarSet, mkVarSet) import Clash.Debug (traceIf) import Clash.Driver (compilePrimitive) import Clash.Driver.Types (BindingMap, Binding(..), IsPrim(..)) import Clash.GHC.GHC2Core (C2C, GHC2CoreState, GHC2CoreEnv (..), tyConMap, coreToId, coreToName, coreToTerm, makeAllTyCons, qualifiedNameString, emptyGHC2CoreState, srcSpan) import Clash.GHC.LoadModules (ghcLibDir, loadModules) import Clash.Netlist.BlackBox.Util (getUsedArguments) import Clash.Netlist.Types (TopEntityT(..)) import Clash.Primitives.Types (Primitive (..), CompiledPrimMap) import Clash.Primitives.Util (generatePrimMap) import Clash.Unique (listToUniqMap, lookupUniqMap, mapUniqMap, unionUniqMap, uniqMapToUniqSet) import Clash.Util (reportTimeDiff) -- | Safe indexing, returns a 'Nothing' if the index does not exist indexMaybe :: [a] -> Int -> Maybe a indexMaybe [] _ = Nothing indexMaybe (x:_) 0 = Just x indexMaybe (_:xs) n = indexMaybe xs (n-1) generateBindings :: GHC.Ghc () -- ^ Allows us to have some initial action, such as sharing a linker state -- See https://github.com/clash-lang/clash-compiler/issues/1686 and -- https://mail.haskell.org/pipermail/ghc-devs/2021-March/019605.html -> GHC.OverridingBool -- ^ Use color -> [FilePath] -- ^ primitives (blackbox) directories -> [FilePath] -- ^ import directories (-i flag) -> [FilePath] -- ^ Package database -> HDL -- ^ HDL target -> String -> Maybe GHC.DynFlags -> IO ( BindingMap , TyConMap , IntMap TyConName , [TopEntityT] , CompiledPrimMap -- The primitives found in '.' and 'primDir' , [DataRepr'] , HashMap.HashMap Text.Text VDomainConfiguration ) generateBindings startAction useColor primDirs importDirs dbs hdl modName dflagsM = do ( bindings , clsOps , unlocatable , fiEnvs , topEntities , partitionEithers -> (unresolvedPrims, pFP) , customBitRepresentations , primGuards , domainConfs ) <- loadModules startAction useColor hdl modName dflagsM importDirs primMapR <- generatePrimMap unresolvedPrims primGuards (concat [pFP, primDirs, importDirs]) tdir <- maybe ghcLibDir (pure . GHC.topDir) dflagsM startTime <- Clock.getCurrentTime primMapC <- sequence $ HashMap.map (sequence . fmap (compilePrimitive importDirs dbs tdir)) primMapR let ((bindingsMap,clsVMap),tcMap,_) = RWS.runRWS (mkBindings primMapC bindings clsOps unlocatable) (GHC2CoreEnv GHC.noSrcSpan fiEnvs) emptyGHC2CoreState (tcMap',tupTcCache) = mkTupTyCons tcMap tcCache = makeAllTyCons tcMap' fiEnvs allTcCache = tysPrimMap `unionUniqMap` tcCache inScope0 = mkInScopeSet (uniqMapToUniqSet ((mapUniqMap (coerce . bindingId) bindingsMap) `unionUniqMap` (mapUniqMap (coerce . bindingId) clsMap))) clsMap = mapUniqMap (\(v,i) -> (Binding v GHC.noSrcSpan GHC.Inline IsFun (mkClassSelector inScope0 allTcCache (varType v) i))) clsVMap allBindings = bindingsMap `unionVarEnv` clsMap topEntities' = (\m -> fst (RWS.evalRWS m (GHC2CoreEnv GHC.noSrcSpan fiEnvs) tcMap')) $ mapM (\(topEnt,annM,isTb) -> do topEnt' <- coreToName GHC.varName GHC.varUnique qualifiedNameString topEnt return (topEnt', annM, isTb)) topEntities topEntities'' = map (\(topEnt, annM, isTb) -> case lookupUniqMap topEnt allBindings of Just b -> TopEntityT (bindingId b) annM isTb Nothing -> error "This shouldn't happen" ) topEntities' -- Parsing / compiling primitives: prepTime <- startTime `deepseq` primMapC `seq` Clock.getCurrentTime let prepStartDiff = reportTimeDiff prepTime startTime putStrLn $ "Clash: Parsing and compiling primitives took " ++ prepStartDiff let allBindings' = setNoInlineTopEntities allBindings topEntities'' return ( allBindings' , allTcCache , tupTcCache , topEntities'' , primMapC , customBitRepresentations , domainConfs ) setNoInlineTopEntities :: BindingMap -> [TopEntityT] -> BindingMap setNoInlineTopEntities bm tes = fmap go bm where ids = mkVarSet (fmap topId tes) go b@Binding{bindingId} | bindingId `elemVarSet` ids = b { bindingSpec = GHC.NoInline } | otherwise = b -- TODO This function should be changed to provide the information that -- Clash.Core.Termination.mkRecInfo provides. To achieve this, it should also -- be changed to no longer flatten recursive groups (see the documentation for -- mkRecInfo for an explanation of these). -- mkBindings :: CompiledPrimMap -> [GHC.CoreBind] -- Binders -> [(GHC.CoreBndr,Int)] -- Class operations -> [GHC.CoreBndr] -- Unlocatable Expressions -> C2C ( BindingMap , VarEnv (Id,Int) ) mkBindings primMap bindings clsOps unlocatable = do bindingsList <- mapM (\case GHC.NonRec v e -> do let sp = GHC.getSrcSpan v inl = GHC.inlinePragmaSpec . GHC.inlinePragInfo $ GHC.idInfo v tm <- RWS.local (srcSpan .~ sp) (coreToTerm primMap unlocatable e) v' <- coreToId v nm <- qualifiedNameString (GHC.varName v) let pr = if HashMap.member nm primMap then IsPrim else IsFun checkPrimitive primMap v return [(v', (Binding v' sp inl pr tm))] GHC.Rec bs -> do tms <- mapM (\(v,e) -> do let sp = GHC.getSrcSpan v inl = GHC.inlinePragmaSpec . GHC.inlinePragInfo $ GHC.idInfo v tm <- RWS.local (srcSpan .~ sp) (coreToTerm primMap unlocatable e) v' <- coreToId v nm <- qualifiedNameString (GHC.varName v) let pr = if HashMap.member nm primMap then IsPrim else IsFun checkPrimitive primMap v return (Binding v' sp inl pr tm) ) bs case tms of [Binding v sp inl pr tm] -> return [(v, Binding v sp inl pr tm)] _ -> let vsL = map (setIdScope LocalId . bindingId) tms vsV = map Var vsL subst = extendGblSubstList (mkSubst emptyInScopeSet) (zip vsL vsV) lbs = zipWith (\b vL -> (vL,substTm "mkBindings" subst (bindingTerm b))) tms vsL tms1 = zipWith (\b (_, e) -> (bindingId b, b { bindingTerm = Letrec lbs e })) tms lbs in return tms1 ) bindings clsOpList <- mapM (\(v,i) -> do v' <- coreToId v return (v', (v',i)) ) clsOps return (mkVarEnv (concat bindingsList), mkVarEnv clsOpList) -- | If this CoreBndr is a primitive, check it's Haskell definition -- for potential problems. -- -- Warns when a primitive: -- * isn't marked NOINLINE -- * produces an error when evaluating its result to WHNF -- * isn't using all its arguments checkPrimitive :: CompiledPrimMap -> GHC.CoreBndr -> C2C () checkPrimitive primMap v = do nm <- qualifiedNameString (GHC.varName v) case HashMap.lookup nm primMap >>= extractPrim of Just (BlackBox{resultNames, resultInits, template, includes}) -> do let info = GHC.idInfo v inline = GHC.inlinePragmaSpec $ GHC.inlinePragInfo info strictness = GHC.strictnessInfo info ty = GHC.varType v (argTys,_resTy) = GHC.splitFunTys . snd . GHC.splitForAllTys $ ty (dmdArgs,_dmdRes) = GHC.splitStrictSig strictness nrOfArgs = length argTys loc = case GHC.getSrcLoc v of GHC.UnhelpfulLoc _ -> "" #if MIN_VERSION_ghc(9,0,0) GHC.RealSrcLoc l _ -> showPpr l ++ ": " #else GHC.RealSrcLoc l -> showPpr l ++ ": " #endif warnIf cond msg = traceIf cond ("\n"++loc++"Warning: "++msg) return () qName <- Text.unpack <$> qualifiedNameString (GHC.varName v) let primStr = "primitive " ++ qName ++ " " let usedArgs = concat [ concatMap getUsedArguments resultNames , concatMap getUsedArguments resultInits , getUsedArguments template , concatMap (getUsedArguments . snd) includes ] let warnArgs [] = return () warnArgs (x:xs) = do warnIf (maybe False GHC.isAbsDmd (indexMaybe dmdArgs x)) ("The Haskell implementation of " ++ primStr ++ "isn't using argument #" ++ show x ++ ", but the corresponding primitive blackbox does.\n" ++ "This can lead to incorrect HDL output because GHC can replace these " ++ "arguments by an undefined value.") warnArgs xs unless (qName == "Clash.XException.errorX" || "GHC." `isPrefixOf` qName) $ do warnIf (inline /= GHC.NoInline) (primStr ++ "isn't marked NOINLINE." ++ "\nThis might make Clash ignore this primitive.") #if MIN_VERSION_ghc(9,0,0) warnIf (GHC.appIsDeadEnd strictness nrOfArgs) #else warnIf (GHC.appIsBottom strictness nrOfArgs) #endif ("The Haskell implementation of " ++ primStr ++ "produces a result that always results in an error.\n" ++ "This can lead to compile failures because GHC can replace entire " ++ "calls to this primitive by an undefined value.") warnArgs usedArgs _ -> return () where showPpr :: GHC.Outputable a => a -> String showPpr = GHC.showSDocUnsafe . GHC.ppr mkClassSelector :: InScopeSet -> TyConMap -> Type -> Int -> Term mkClassSelector inScope0 tcm ty sel = newExpr where ((tvs,dictTy:_),_) = first (lefts *** rights) $ first (span (\l -> case l of Left _ -> True _ -> False)) $ splitFunForallTy ty newExpr = case tyView dictTy of (TyConApp tcNm _) | Just tc <- lookupUniqMap tcNm tcm , not (isNewTypeTc tc) -> flip State.evalState (0 :: Int) $ do dcId <- mkInternalVar inScope0 "dict" dictTy let inScope1 = extendInScopeSet inScope0 dcId selE <- mkSelectorCase "mkClassSelector" inScope1 tcm (Var dcId) 1 sel return (mkTyLams (mkLams selE [dcId]) tvs) (FunTy arg res) -> flip State.evalState (0 :: Int) $ do dcId <- mkInternalVar inScope0 "dict" (mkFunTy arg res) return (mkTyLams (mkLams (Var dcId) [dcId]) tvs) _ -> flip State.evalState (0 :: Int) $ do dcId <- mkInternalVar inScope0 "dict" dictTy return (mkTyLams (mkLams (Var dcId) [dcId]) tvs) mkTupTyCons :: GHC2CoreState -> (GHC2CoreState,IntMap TyConName) mkTupTyCons tcMap = (tcMap'',tupTcCache) where tupTyCons = GHC.boolTyCon : GHC.promotedTrueDataCon : GHC.promotedFalseDataCon : map (GHC.tupleTyCon GHC.Boxed) [2..GHC.mAX_TUPLE_SIZE] (tcNames,tcMap',_) = RWS.runRWS (mapM (\tc -> coreToName GHC.tyConName GHC.tyConUnique qualifiedNameString tc) tupTyCons) (GHC2CoreEnv GHC.noSrcSpan GHC.emptyFamInstEnvs) tcMap tupTcCache = IMS.fromList (zip [2..GHC.mAX_TUPLE_SIZE] (drop 3 tcNames)) tupHM = listToUniqMap (zip tcNames tupTyCons) tcMap'' = tcMap' & tyConMap %~ (`unionUniqMap` tupHM)