/compiler/llvmGen/LlvmCodeGen/Base.hs
Haskell | 242 lines | 125 code | 52 blank | 65 comment | 1 complexity | fa7dd1436ce9f4cda1b6131adb16c670 MD5 | raw file
Possible License(s): BSD-3-Clause, BSD-2-Clause, LGPL-3.0
- -- ----------------------------------------------------------------------------
- -- | Base LLVM Code Generation module
- --
- -- Contains functions useful through out the code generator.
- --
- module LlvmCodeGen.Base (
- LlvmCmmDecl, LlvmBasicBlock,
- LlvmUnresData, LlvmData, UnresLabel, UnresStatic,
- LlvmVersion, defaultLlvmVersion,
- LlvmEnv, initLlvmEnv, clearVars, varLookup, varInsert,
- funLookup, funInsert, getLlvmVer, setLlvmVer, getLlvmPlatform,
- ghcInternalFunctions,
- cmmToLlvmType, widthToLlvmFloat, widthToLlvmInt, llvmFunTy,
- llvmFunSig, llvmStdFunAttrs, llvmFunAlign, llvmInfAlign,
- llvmPtrBits, mkLlvmFunc, tysToParams,
- strCLabel_llvm, genCmmLabelRef, genStringLabelRef
- ) where
- #include "HsVersions.h"
- import Llvm
- import LlvmCodeGen.Regs
- import CLabel
- import CgUtils ( activeStgRegs )
- import Config
- import Constants
- import FastString
- import OldCmm
- import qualified Outputable as Outp
- import Platform
- import UniqFM
- import Unique
- -- ----------------------------------------------------------------------------
- -- * Some Data Types
- --
- type LlvmCmmDecl = GenCmmDecl [LlvmData] (Maybe CmmStatics) (ListGraph LlvmStatement)
- type LlvmBasicBlock = GenBasicBlock LlvmStatement
- -- | Unresolved code.
- -- Of the form: (data label, data type, unresolved data)
- type LlvmUnresData = (CLabel, Section, LlvmType, [UnresStatic])
- -- | Top level LLVM Data (globals and type aliases)
- type LlvmData = ([LMGlobal], [LlvmType])
- -- | An unresolved Label.
- --
- -- Labels are unresolved when we haven't yet determined if they are defined in
- -- the module we are currently compiling, or an external one.
- type UnresLabel = CmmLit
- type UnresStatic = Either UnresLabel LlvmStatic
- -- ----------------------------------------------------------------------------
- -- * Type translations
- --
- -- | Translate a basic CmmType to an LlvmType.
- cmmToLlvmType :: CmmType -> LlvmType
- cmmToLlvmType ty | isFloatType ty = widthToLlvmFloat $ typeWidth ty
- | otherwise = widthToLlvmInt $ typeWidth ty
- -- | Translate a Cmm Float Width to a LlvmType.
- widthToLlvmFloat :: Width -> LlvmType
- widthToLlvmFloat W32 = LMFloat
- widthToLlvmFloat W64 = LMDouble
- widthToLlvmFloat W80 = LMFloat80
- widthToLlvmFloat W128 = LMFloat128
- widthToLlvmFloat w = panic $ "widthToLlvmFloat: Bad float size: " ++ show w
- -- | Translate a Cmm Bit Width to a LlvmType.
- widthToLlvmInt :: Width -> LlvmType
- widthToLlvmInt w = LMInt $ widthInBits w
- -- | GHC Call Convention for LLVM
- llvmGhcCC :: LlvmCallConvention
- llvmGhcCC | cGhcUnregisterised == "NO" = CC_Ncc 10
- | otherwise = CC_Ccc
- -- | Llvm Function type for Cmm function
- llvmFunTy :: LlvmType
- llvmFunTy = LMFunction $ llvmFunSig' (fsLit "a") ExternallyVisible
- -- | Llvm Function signature
- llvmFunSig :: LlvmEnv -> CLabel -> LlvmLinkageType -> LlvmFunctionDecl
- llvmFunSig env lbl link = llvmFunSig' (strCLabel_llvm env lbl) link
- llvmFunSig' :: LMString -> LlvmLinkageType -> LlvmFunctionDecl
- llvmFunSig' lbl link
- = let toParams x | isPointer x = (x, [NoAlias, NoCapture])
- | otherwise = (x, [])
- in LlvmFunctionDecl lbl link llvmGhcCC LMVoid FixedArgs
- (map (toParams . getVarType) llvmFunArgs) llvmFunAlign
- -- | Create a Haskell function in LLVM.
- mkLlvmFunc :: LlvmEnv -> CLabel -> LlvmLinkageType -> LMSection -> LlvmBlocks
- -> LlvmFunction
- mkLlvmFunc env lbl link sec blks
- = let funDec = llvmFunSig env lbl link
- funArgs = map (fsLit . getPlainName) llvmFunArgs
- in LlvmFunction funDec funArgs llvmStdFunAttrs sec blks
- -- | Alignment to use for functions
- llvmFunAlign :: LMAlign
- llvmFunAlign = Just wORD_SIZE
- -- | Alignment to use for into tables
- llvmInfAlign :: LMAlign
- llvmInfAlign = Just wORD_SIZE
- -- | A Function's arguments
- llvmFunArgs :: [LlvmVar]
- llvmFunArgs = map lmGlobalRegArg activeStgRegs
- -- | Llvm standard fun attributes
- llvmStdFunAttrs :: [LlvmFuncAttr]
- llvmStdFunAttrs = [NoUnwind]
- -- | Convert a list of types to a list of function parameters
- -- (each with no parameter attributes)
- tysToParams :: [LlvmType] -> [LlvmParameter]
- tysToParams = map (\ty -> (ty, []))
- -- | Pointer width
- llvmPtrBits :: Int
- llvmPtrBits = widthInBits $ typeWidth gcWord
- -- ----------------------------------------------------------------------------
- -- * Llvm Version
- --
- -- | LLVM Version Number
- type LlvmVersion = Int
- -- | The LLVM Version we assume if we don't know
- defaultLlvmVersion :: LlvmVersion
- defaultLlvmVersion = 28
- -- ----------------------------------------------------------------------------
- -- * Environment Handling
- --
- -- two maps, one for functions and one for local vars.
- newtype LlvmEnv = LlvmEnv (LlvmEnvMap, LlvmEnvMap, LlvmVersion, Platform)
- type LlvmEnvMap = UniqFM LlvmType
- -- | Get initial Llvm environment.
- initLlvmEnv :: Platform -> LlvmEnv
- initLlvmEnv platform = LlvmEnv (initFuncs, emptyUFM, defaultLlvmVersion, platform)
- where initFuncs = listToUFM $ [ (n, LMFunction ty) | (n, ty) <- ghcInternalFunctions ]
- -- | Here we pre-initialise some functions that are used internally by GHC
- -- so as to make sure they have the most general type in the case that
- -- user code also uses these functions but with a different type than GHC
- -- internally. (Main offender is treating return type as 'void' instead of
- -- 'void *'. Fixes trac #5486.
- ghcInternalFunctions :: [(LMString, LlvmFunctionDecl)]
- ghcInternalFunctions =
- [ mk "memcpy" i8Ptr [i8Ptr, i8Ptr, llvmWord]
- , mk "memmove" i8Ptr [i8Ptr, i8Ptr, llvmWord]
- , mk "memset" i8Ptr [i8Ptr, llvmWord, llvmWord]
- , mk "newSpark" llvmWord [i8Ptr, i8Ptr]
- ]
- where
- mk n ret args =
- let n' = fsLit n
- in (n', LlvmFunctionDecl n' ExternallyVisible CC_Ccc ret
- FixedArgs (tysToParams args) Nothing)
- -- | Clear variables from the environment.
- clearVars :: LlvmEnv -> LlvmEnv
- clearVars (LlvmEnv (e1, _, n, p)) = {-# SCC "llvm_env_clear" #-}
- LlvmEnv (e1, emptyUFM, n, p)
- -- | Insert local variables into the environment.
- varInsert :: Uniquable key => key -> LlvmType -> LlvmEnv -> LlvmEnv
- varInsert s t (LlvmEnv (e1, e2, n, p)) = {-# SCC "llvm_env_vinsert" #-}
- LlvmEnv (e1, addToUFM e2 s t, n, p)
- -- | Insert functions into the environment.
- funInsert :: Uniquable key => key -> LlvmType -> LlvmEnv -> LlvmEnv
- funInsert s t (LlvmEnv (e1, e2, n, p)) = {-# SCC "llvm_env_finsert" #-}
- LlvmEnv (addToUFM e1 s t, e2, n, p)
- -- | Lookup local variables in the environment.
- varLookup :: Uniquable key => key -> LlvmEnv -> Maybe LlvmType
- varLookup s (LlvmEnv (_, e2, _, _)) = {-# SCC "llvm_env_vlookup" #-}
- lookupUFM e2 s
- -- | Lookup functions in the environment.
- funLookup :: Uniquable key => key -> LlvmEnv -> Maybe LlvmType
- funLookup s (LlvmEnv (e1, _, _, _)) = {-# SCC "llvm_env_flookup" #-}
- lookupUFM e1 s
- -- | Get the LLVM version we are generating code for
- getLlvmVer :: LlvmEnv -> LlvmVersion
- getLlvmVer (LlvmEnv (_, _, n, _)) = n
- -- | Set the LLVM version we are generating code for
- setLlvmVer :: LlvmVersion -> LlvmEnv -> LlvmEnv
- setLlvmVer n (LlvmEnv (e1, e2, _, p)) = LlvmEnv (e1, e2, n, p)
- -- | Get the platform we are generating code for
- getLlvmPlatform :: LlvmEnv -> Platform
- getLlvmPlatform (LlvmEnv (_, _, _, p)) = p
- -- ----------------------------------------------------------------------------
- -- * Label handling
- --
- -- | Pretty print a 'CLabel'.
- strCLabel_llvm :: LlvmEnv -> CLabel -> LMString
- strCLabel_llvm env l = {-# SCC "llvm_strCLabel" #-}
- (fsLit . show . llvmSDoc . pprCLabel (getLlvmPlatform env)) l
- -- | Create an external definition for a 'CLabel' defined in another module.
- genCmmLabelRef :: LlvmEnv -> CLabel -> LMGlobal
- genCmmLabelRef env = genStringLabelRef . strCLabel_llvm env
- -- | As above ('genCmmLabelRef') but taking a 'LMString', not 'CLabel'.
- genStringLabelRef :: LMString -> LMGlobal
- genStringLabelRef cl
- = let ty = LMPointer $ LMArray 0 llvmWord
- in (LMGlobalVar cl ty External Nothing Nothing False, Nothing)
- -- ----------------------------------------------------------------------------
- -- * Misc
- --
- -- | Error function
- panic :: String -> a
- panic s = Outp.panic $ "LlvmCodeGen.Base." ++ s