Moduleghc-10.0.0.20260917GHC2024

GHC.Driver.Pipeline

Contents

Run a series of compilation steps in a pipeline, for a
Interfaces for the compilation manager (interpreted/batch-mode)
Linking
PipeEnv
Running individual phases
Constructing Pipelines
Default method of running a pipeline

Synopsis

value oneShot
value compileFile
value preprocess
value compileOne
value compileOne'
value compileForeign
value compileEmptyStub
value link
value checkLinkInfo
data PipeEnv
value mkPipeEnv
value phaseOutputFilenameNew
data TPhase
value runPhase
value hscPostBackendPhase
type TPipelineClass
class MonadUse
value preprocessPipeline
value fullPipeline
value hscPipeline
value hscBackendPipeline
value hscPostBackendPipeline
value hscGenBackendPipeline
value asPipeline
value viaCPipeline
value cmmCppPipeline
value cmmPipeline
value jsPipeline
value llvmPipeline
value llvmLlcPipeline
value llvmManglePipeline
value pipelineStart
value runPipeline

Packageghc-10.0.0.20260917
Exports33
LanguageGHC2024
LicenceBSD-3-Clause
SourcePipeline.hs

Run a series of compilation steps in a pipeline, for a

valueoneShot :: HscEnv -> StopPhase -> [(String, Maybe Phase)] -> IO ()

valuecompileFile

:: HscEnv
-> StopPhase
-> (FilePath, Maybe Phase)
-> IO (Maybe FilePath)

Interfaces for the compilation manager (interpreted/batch-mode)

valuepreprocess

:: HscEnv
-> FilePath
input filename
-> Maybe InputFileBuffer
optional buffer to use instead of reading the input file
-> Maybe Phase
starting phase
-> IO (Either DriverMessages (DynFlags, FilePath))

Source#

Just preprocess a file, put the result in a temp. file (used by the compilation manager during the summary phase).

We return the augmented DynFlags, because they contain the result of slurping in the OPTIONS pragmas

valuecompileOne

:: HscEnv
-> ModSummary
summary for module being compiled
-> Int
module N ...
-> Int
... of M
-> Maybe ModIface
old interface, if we have one
-> HomeModLinkable
old linkable, if we have one
-> IO HomeModInfo
the complete HomeModInfo, if successful

Source#

Compile

Compile a single module, under the control of the compilation manager.

This is the interface between the compilation manager and the compiler proper (hsc), where we deal with tedious details like reading the OPTIONS pragma from the source file, converting the C or assembly that GHC produces into an object file, and compiling FFI stub files.

NB. No old interface can also mean that the source has changed.

valuecompileOne'

:: Maybe Messager
-> HscEnv
-> ModSummary
summary for module being compiled
-> Int
module N ...
-> Int
... of M
-> Maybe ModIface
old interface, if we have one
-> HomeModLinkable
-> IO HomeModInfo
the complete HomeModInfo, if successful

valuecompileForeign :: HscEnv -> ForeignSrcLang -> FilePath -> IO FilePath

valuecompileEmptyStub

:: DynFlags
-> HscEnv
-> FilePath
-> ModLocation
-> ModuleName
-> IO ()

Linking

valuelink

:: GhcLink
interactive or batch
-> HscEnv
-> Bool
attempt linking in batch mode?
-> Maybe (RecompileRequired -> IO ())
-> HomePackageTable
what to link
-> IO SuccessFlag

valuecheckLinkInfo

:: Logger
-> ExecutableLinkOpts
-> UnitEnv
-> [UnitId]
-> FilePath
-> IO Bool

PipeEnv

datadata PipeEnv

Constructors

PipeEnv
- stop_phase :: StopPhase
  Stop just after this phase
- src_filename :: String
  basename of original input source
- src_basename :: String
  basename of original input source
- src_suffix :: String
  its extension
- start_phase :: Phase
- output_spec :: PipelineOutput
  says where to put the pipeline output

valuemkPipeEnv

valuephaseOutputFilenameNew

:: Phase
The next phase
-> PipeEnv
-> HscEnv
-> Maybe ModLocation
A ModLocation, if we are compiling a Haskell source file
-> IO FilePath

Running individual phases

datadata TPhase res where

Constructors

T_Unlit :: PipeEnv -> HscEnv -> FilePath -> TPhase [Char]
T_FileArgs :: HscEnv -> FilePath -> TPhase (DynFlags, Messages PsMessage, Messages DriverMessage)
T_Cpp :: PipeEnv -> HscEnv -> FilePath -> TPhase [Char]
T_HsPp :: PipeEnv -> HscEnv -> FilePath -> FilePath -> TPhase [Char]
T_HscRecomp :: PipeEnv -> HscEnv -> FilePath -> HscSource -> TPhase (HscEnv, ModSummary, HscRecompStatus)
T_Hsc :: HscEnv -> ModSummary -> TPhase (FrontendResult, Messages GhcMessage)
Parse/rename/typecheck compilation phase.
NB: the consumer of the returned FrontendResult is responsible for shutting down all TcM plugins (e.g. by calling shutdownTcMPluginsIO). In particular, the HscPostTc phase shuts down TcM plugins.
T_HscPostTc :: HscEnv -> ModSummary -> FrontendResult -> Messages GhcMessage -> Maybe Fingerprint -> TPhase HscBackendAction
T_HscBackend :: PipeEnv -> HscEnv -> ModuleName -> HscSource -> ModLocation -> HscBackendAction -> TPhase ([FilePath], ModIface, HomeModLinkable, FilePath)
T_CmmCpp :: PipeEnv -> HscEnv -> FilePath -> TPhase [Char]
T_Cmm :: PipeEnv -> HscEnv -> FilePath -> TPhase ([FilePath], FilePath)
T_Cc :: Phase -> PipeEnv -> HscEnv -> Maybe ModLocation -> FilePath -> TPhase [Char]
T_As :: Bool -> PipeEnv -> HscEnv -> Maybe ModLocation -> FilePath -> TPhase [Char]
T_Js :: PipeEnv -> HscEnv -> Maybe ModLocation -> FilePath -> TPhase [Char]
T_ForeignJs :: PipeEnv -> HscEnv -> Maybe ModLocation -> FilePath -> TPhase [Char]
T_LlvmOpt :: PipeEnv -> HscEnv -> FilePath -> TPhase [Char]
T_LlvmLlc :: PipeEnv -> HscEnv -> FilePath -> TPhase [Char]
T_LlvmAs :: Bool -> PipeEnv -> HscEnv -> Maybe ModLocation -> FilePath -> TPhase [Char]
T_LlvmMangle :: PipeEnv -> HscEnv -> FilePath -> TPhase [Char]
T_MergeForeign :: PipeEnv -> HscEnv -> FilePath -> [FilePath] -> TPhase [Char]

Instances1MonadUse

MonadUse TPhase HookedUseDefined in ghc-10.0.0.20260917 · GHC.Driver.Pipeline.Execute

valuerunPhase :: TPhase out -> IO out

Source#

Default interpretation of each phase, in terms of IO.

valuehscPostBackendPhase :: HscSource -> Backend -> Phase

Source#

What phase to run after one of the backend code generators has run

Constructing Pipelines

type

type TPipelineClass (f :: Type -> Type) (m :: Type -> Type) = (Functor m, MonadIO m, Applicative m, Monad m, MonadMask m, MonadUse f m)

classclass MonadUse (f :: k -> Type) (m :: k -> Type) where

Source#

Lift a f action into an m action.

Methods

use :: f a -> m a

Instances1MonadUse

MonadUse TPhase HookedUseDefined in ghc-10.0.0.20260917 · GHC.Driver.Pipeline.Execute

valuepreprocessPipeline

:: P m
=> PipeEnv
-> HscEnv
-> FilePath
-> m (DynFlags, FilePath)

Source#

The preprocessor pipeline

valuefullPipeline

:: P m
=> PipeEnv
-> HscEnv
-> FilePath
-> HscSource
-> m (ModIface, RecompLinkables)

Source#

The complete compilation pipeline, from start to finish

valuehscPipeline

:: P m
=> PipeEnv
-> (HscEnv, ModSummary, HscRecompStatus)
-> m (ModIface, RecompLinkables)

Source#

Everything after preprocess

valuehscBackendPipeline

:: P m
=> PipeEnv
-> HscEnv
-> ModSummary
-> HscBackendAction
-> m (ModIface, RecompLinkables)

valuehscPostBackendPipeline

:: P m
=> PipeEnv
-> HscEnv
-> HscSource
-> Backend
-> Maybe ModLocation
-> FilePath
-> m (Maybe FilePath)

valuehscGenBackendPipeline

:: P m
=> PipeEnv
-> HscEnv
-> ModSummary
-> HscBackendAction
-> m (ModIface, RecompLinkables)

valueasPipeline

:: P m
=> Bool
-> PipeEnv
-> HscEnv
-> Maybe ModLocation
-> FilePath
-> m (Maybe ObjFile)

valueviaCPipeline

:: P m
=> Phase
-> PipeEnv
-> HscEnv
-> Maybe ModLocation
-> FilePath
-> m (Maybe FilePath)

valuecmmCppPipeline :: P m => PipeEnv -> HscEnv -> FilePath -> m (Maybe FilePath)

valuecmmPipeline :: P m => PipeEnv -> HscEnv -> FilePath -> m (Maybe FilePath)

valuejsPipeline

:: P m
=> PipeEnv
-> HscEnv
-> Maybe ModLocation
-> FilePath
-> m FilePath

valuellvmPipeline

:: P m
=> PipeEnv
-> HscEnv
-> Maybe ModLocation
-> FilePath
-> m (Maybe FilePath)

valuellvmLlcPipeline

:: P m
=> PipeEnv
-> HscEnv
-> Maybe ModLocation
-> FilePath
-> m (Maybe FilePath)

valuellvmManglePipeline

:: P m
=> PipeEnv
-> HscEnv
-> Maybe ModLocation
-> FilePath
-> m (Maybe FilePath)

valuepipelineStart

:: P m
=> PipeEnv
-> HscEnv
-> FilePath
-> Maybe Phase
-> m (Maybe FilePath)

Default method of running a pipeline

valuerunPipeline :: Hooks -> HookedUse a -> IO a

Source#

The default mechanism to run a pipeline, see Note [The Pipeline Monad]