/compiler/main/DriverPipeline.hs
Haskell | 2167 lines | 1369 code | 333 blank | 465 comment | 142 complexity | 3deaaf6a63c69ff7425dd39863e85813 MD5 | raw file
Large files files are truncated, but you can click here to view the full file
- {-# OPTIONS -fno-cse #-}
- {-# LANGUAGE NamedFieldPuns #-}
- -- -fno-cse is needed for GLOBAL_VAR's to behave properly
- -----------------------------------------------------------------------------
- --
- -- GHC Driver
- --
- -- (c) The University of Glasgow 2005
- --
- -----------------------------------------------------------------------------
- module DriverPipeline (
- -- Run a series of compilation steps in a pipeline, for a
- -- collection of source files.
- oneShot, compileFile,
- -- Interfaces for the batch-mode driver
- linkBinary,
- -- Interfaces for the compilation manager (interpreted/batch-mode)
- preprocess,
- compileOne, compileOne',
- link,
- ) where
- #include "HsVersions.h"
- import Packages
- import HeaderInfo
- import DriverPhases
- import SysTools
- import HscMain
- import Finder
- import HscTypes
- import Outputable
- import Module
- import UniqFM ( eltsUFM )
- import ErrUtils
- import DynFlags
- import Config
- import Panic
- import Util
- import StringBuffer ( hGetStringBuffer )
- import BasicTypes ( SuccessFlag(..) )
- import Maybes ( expectJust )
- import ParserCoreUtils ( getCoreModuleName )
- import SrcLoc
- import FastString
- import LlvmCodeGen ( llvmFixupAsm )
- import MonadUtils
- import Platform
- import TcRnTypes
- import Exception
- import Data.IORef ( readIORef )
- import System.Directory
- import System.FilePath
- import System.IO
- import Control.Monad
- import Data.List ( isSuffixOf )
- import Data.Maybe
- import System.Environment
- import Data.Char
- -- ---------------------------------------------------------------------------
- -- Pre-process
- -- | 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
- preprocess :: HscEnv
- -> (FilePath, Maybe Phase) -- ^ filename and starting phase
- -> IO (DynFlags, FilePath)
- preprocess hsc_env (filename, mb_phase) =
- ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename)
- runPipeline anyHsc hsc_env (filename, fmap RealPhase mb_phase)
- Nothing Temporary Nothing{-no ModLocation-} Nothing{-no stub-}
- -- ---------------------------------------------------------------------------
- -- | 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.
- compileOne :: HscEnv
- -> ModSummary -- ^ summary for module being compiled
- -> Int -- ^ module N ...
- -> Int -- ^ ... of M
- -> Maybe ModIface -- ^ old interface, if we have one
- -> Maybe Linkable -- ^ old linkable, if we have one
- -> SourceModified
- -> IO HomeModInfo -- ^ the complete HomeModInfo, if successful
- compileOne = compileOne' Nothing (Just batchMsg)
- compileOne' :: Maybe TcGblEnv
- -> Maybe Messager
- -> HscEnv
- -> ModSummary -- ^ summary for module being compiled
- -> Int -- ^ module N ...
- -> Int -- ^ ... of M
- -> Maybe ModIface -- ^ old interface, if we have one
- -> Maybe Linkable -- ^ old linkable, if we have one
- -> SourceModified
- -> IO HomeModInfo -- ^ the complete HomeModInfo, if successful
- compileOne' m_tc_result mHscMessage
- hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
- source_modified0
- = do
- let dflags0 = ms_hspp_opts summary
- this_mod = ms_mod summary
- src_flavour = ms_hsc_src summary
- location = ms_location summary
- input_fn = expectJust "compile:hs" (ml_hs_file location)
- input_fnpp = ms_hspp_file summary
- debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
- let basename = dropExtension input_fn
- -- We add the directory in which the .hs files resides) to the import path.
- -- This is needed when we try to compile the .hc file later, if it
- -- imports a _stub.h file that we created here.
- let current_dir = takeDirectory basename
- old_paths = includePaths dflags0
- dflags = dflags0 { includePaths = current_dir : old_paths }
- hsc_env = hsc_env0 {hsc_dflags = dflags}
- -- Figure out what lang we're generating
- let hsc_lang = hscTarget dflags
- -- ... and what the next phase should be
- let next_phase = hscPostBackendPhase dflags src_flavour hsc_lang
- -- ... and what file to generate the output into
- output_fn <- getOutputFilename next_phase
- Temporary basename dflags next_phase (Just location)
- let extCore_filename = basename ++ ".hcr"
- -- -fforce-recomp should also work with --make
- let force_recomp = gopt Opt_ForceRecomp dflags
- source_modified
- | force_recomp || isNothing maybe_old_linkable = SourceModified
- | otherwise = source_modified0
- object_filename = ml_obj_file location
- let always_do_basic_recompilation_check = case hsc_lang of
- HscInterpreted -> True
- _ -> False
- e <- genericHscCompileGetFrontendResult
- always_do_basic_recompilation_check
- m_tc_result mHscMessage
- hsc_env summary source_modified mb_old_iface (mod_index, nmods)
- case e of
- Left iface ->
- do details <- genModDetails hsc_env iface
- MASSERT (isJust maybe_old_linkable)
- return (HomeModInfo{ hm_details = details,
- hm_iface = iface,
- hm_linkable = maybe_old_linkable })
- Right (tc_result, mb_old_hash) ->
- -- run the compiler
- case hsc_lang of
- HscInterpreted ->
- case ms_hsc_src summary of
- HsBootFile ->
- do (iface, _changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
- return (HomeModInfo{ hm_details = details,
- hm_iface = iface,
- hm_linkable = maybe_old_linkable })
- _ -> do guts0 <- hscDesugar hsc_env summary tc_result
- guts <- hscSimplify hsc_env guts0
- (iface, _changed, details, cgguts) <- hscNormalIface hsc_env extCore_filename guts mb_old_hash
- (hasStub, comp_bc, modBreaks) <- hscInteractive hsc_env cgguts summary
- stub_o <- case hasStub of
- Nothing -> return []
- Just stub_c -> do
- stub_o <- compileStub hsc_env stub_c
- return [DotO stub_o]
- let hs_unlinked = [BCOs comp_bc modBreaks]
- unlinked_time = ms_hs_date summary
- -- Why do we use the timestamp of the source file here,
- -- rather than the current time? This works better in
- -- the case where the local clock is out of sync
- -- with the filesystem's clock. It's just as accurate:
- -- if the source is modified, then the linkable will
- -- be out of date.
- let linkable = LM unlinked_time this_mod
- (hs_unlinked ++ stub_o)
- return (HomeModInfo{ hm_details = details,
- hm_iface = iface,
- hm_linkable = Just linkable })
- HscNothing ->
- do (iface, _changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
- let linkable = if isHsBoot src_flavour
- then maybe_old_linkable
- else Just (LM (ms_hs_date summary) this_mod [])
- return (HomeModInfo{ hm_details = details,
- hm_iface = iface,
- hm_linkable = linkable })
- _ ->
- case ms_hsc_src summary of
- HsBootFile ->
- do (iface, changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
- hscWriteIface dflags iface changed summary
- touchObjectFile dflags object_filename
- return (HomeModInfo{ hm_details = details,
- hm_iface = iface,
- hm_linkable = maybe_old_linkable })
- _ -> do guts0 <- hscDesugar hsc_env summary tc_result
- guts <- hscSimplify hsc_env guts0
- (iface, changed, details, cgguts) <- hscNormalIface hsc_env extCore_filename guts mb_old_hash
- hscWriteIface dflags iface changed summary
- -- We're in --make mode: finish the compilation pipeline.
- let mod_name = ms_mod_name summary
- _ <- runPipeline StopLn hsc_env
- (output_fn,
- Just (HscOut src_flavour mod_name (HscRecomp cgguts summary)))
- (Just basename)
- Persistent
- (Just location)
- Nothing
- -- The object filename comes from the ModLocation
- o_time <- getModificationUTCTime object_filename
- let linkable = LM o_time this_mod [DotO object_filename]
- return (HomeModInfo{ hm_details = details,
- hm_iface = iface,
- hm_linkable = Just linkable })
- -----------------------------------------------------------------------------
- -- stub .h and .c files (for foreign export support)
- -- The _stub.c file is derived from the haskell source file, possibly taking
- -- into account the -stubdir option.
- --
- -- The object file created by compiling the _stub.c file is put into a
- -- temporary file, which will be later combined with the main .o file
- -- (see the MergeStubs phase).
- compileStub :: HscEnv -> FilePath -> IO FilePath
- compileStub hsc_env stub_c = do
- (_, stub_o) <- runPipeline StopLn hsc_env (stub_c,Nothing) Nothing
- Temporary Nothing{-no ModLocation-} Nothing
- return stub_o
- -- ---------------------------------------------------------------------------
- -- Link
- link :: GhcLink -- interactive or batch
- -> DynFlags -- dynamic flags
- -> Bool -- attempt linking in batch mode?
- -> HomePackageTable -- what to link
- -> IO SuccessFlag
- -- For the moment, in the batch linker, we don't bother to tell doLink
- -- which packages to link -- it just tries all that are available.
- -- batch_attempt_linking should only be *looked at* in batch mode. It
- -- should only be True if the upsweep was successful and someone
- -- exports main, i.e., we have good reason to believe that linking
- -- will succeed.
- link LinkInMemory _ _ _
- = if cGhcWithInterpreter == "YES"
- then -- Not Linking...(demand linker will do the job)
- return Succeeded
- else panicBadLink LinkInMemory
- link NoLink _ _ _
- = return Succeeded
- link LinkBinary dflags batch_attempt_linking hpt
- = link' dflags batch_attempt_linking hpt
- link LinkDynLib dflags batch_attempt_linking hpt
- = link' dflags batch_attempt_linking hpt
- panicBadLink :: GhcLink -> a
- panicBadLink other = panic ("link: GHC not built to link this way: " ++
- show other)
- link' :: DynFlags -- dynamic flags
- -> Bool -- attempt linking in batch mode?
- -> HomePackageTable -- what to link
- -> IO SuccessFlag
- link' dflags batch_attempt_linking hpt
- | batch_attempt_linking
- = do
- let
- home_mod_infos = eltsUFM hpt
- -- the packages we depend on
- pkg_deps = concatMap (map fst . dep_pkgs . mi_deps . hm_iface) home_mod_infos
- -- the linkables to link
- linkables = map (expectJust "link".hm_linkable) home_mod_infos
- debugTraceMsg dflags 3 (text "link: linkables are ..." $$ vcat (map ppr linkables))
- -- check for the -no-link flag
- if isNoLink (ghcLink dflags)
- then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
- return Succeeded
- else do
- let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
- obj_files = concatMap getOfiles linkables
- exe_file = exeFileName dflags
- linking_needed <- linkingNeeded dflags linkables pkg_deps
- if not (gopt Opt_ForceRecomp dflags) && not linking_needed
- then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
- return Succeeded
- else do
- compilationProgressMsg dflags ("Linking " ++ exe_file ++ " ...")
- -- Don't showPass in Batch mode; doLink will do that for us.
- let link = case ghcLink dflags of
- LinkBinary -> linkBinary
- LinkDynLib -> linkDynLibCheck
- other -> panicBadLink other
- link dflags obj_files pkg_deps
- debugTraceMsg dflags 3 (text "link: done")
- -- linkBinary only returns if it succeeds
- return Succeeded
- | otherwise
- = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
- text " Main.main not exported; not linking.")
- return Succeeded
- linkingNeeded :: DynFlags -> [Linkable] -> [PackageId] -> IO Bool
- linkingNeeded dflags linkables pkg_deps = do
- -- if the modification time on the executable is later than the
- -- modification times on all of the objects and libraries, then omit
- -- linking (unless the -fforce-recomp flag was given).
- let exe_file = exeFileName dflags
- e_exe_time <- tryIO $ getModificationUTCTime exe_file
- case e_exe_time of
- Left _ -> return True
- Right t -> do
- -- first check object files and extra_ld_inputs
- let extra_ld_inputs = ldInputs dflags
- e_extra_times <- mapM (tryIO . getModificationUTCTime) extra_ld_inputs
- let (errs,extra_times) = splitEithers e_extra_times
- let obj_times = map linkableTime linkables ++ extra_times
- if not (null errs) || any (t <) obj_times
- then return True
- else do
- -- next, check libraries. XXX this only checks Haskell libraries,
- -- not extra_libraries or -l things from the command line.
- let pkg_map = pkgIdMap (pkgState dflags)
- pkg_hslibs = [ (libraryDirs c, lib)
- | Just c <- map (lookupPackage pkg_map) pkg_deps,
- lib <- packageHsLibs dflags c ]
- pkg_libfiles <- mapM (uncurry (findHSLib dflags)) pkg_hslibs
- if any isNothing pkg_libfiles then return True else do
- e_lib_times <- mapM (tryIO . getModificationUTCTime)
- (catMaybes pkg_libfiles)
- let (lib_errs,lib_times) = splitEithers e_lib_times
- if not (null lib_errs) || any (t <) lib_times
- then return True
- else checkLinkInfo dflags pkg_deps exe_file
- -- Returns 'False' if it was, and we can avoid linking, because the
- -- previous binary was linked with "the same options".
- checkLinkInfo :: DynFlags -> [PackageId] -> FilePath -> IO Bool
- checkLinkInfo dflags pkg_deps exe_file
- | not (platformSupportsSavingLinkOpts (platformOS (targetPlatform dflags)))
- -- ToDo: Windows and OS X do not use the ELF binary format, so
- -- readelf does not work there. We need to find another way to do
- -- this.
- = return False -- conservatively we should return True, but not
- -- linking in this case was the behaviour for a long
- -- time so we leave it as-is.
- | otherwise
- = do
- link_info <- getLinkInfo dflags pkg_deps
- debugTraceMsg dflags 3 $ text ("Link info: " ++ link_info)
- m_exe_link_info <- readElfSection dflags ghcLinkInfoSectionName exe_file
- debugTraceMsg dflags 3 $ text ("Exe link info: " ++ show m_exe_link_info)
- return (Just link_info /= m_exe_link_info)
- platformSupportsSavingLinkOpts :: OS -> Bool
- platformSupportsSavingLinkOpts os
- | os == OSSolaris2 = False -- see #5382
- | otherwise = osElfTarget os
- ghcLinkInfoSectionName :: String
- ghcLinkInfoSectionName = ".debug-ghc-link-info"
- -- if we use the ".debug" prefix, then strip will strip it by default
- findHSLib :: DynFlags -> [String] -> String -> IO (Maybe FilePath)
- findHSLib dflags dirs lib = do
- let batch_lib_file = if gopt Opt_Static dflags
- then "lib" ++ lib <.> "a"
- else mkSOName (targetPlatform dflags) lib
- found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
- case found of
- [] -> return Nothing
- (x:_) -> return (Just x)
- -- -----------------------------------------------------------------------------
- -- Compile files in one-shot mode.
- oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
- oneShot hsc_env stop_phase srcs = do
- o_files <- mapM (compileFile hsc_env stop_phase) srcs
- doLink (hsc_dflags hsc_env) stop_phase o_files
- compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
- compileFile hsc_env stop_phase (src, mb_phase) = do
- exists <- doesFileExist src
- when (not exists) $
- throwGhcExceptionIO (CmdLineError ("does not exist: " ++ src))
- let
- dflags = hsc_dflags hsc_env
- split = gopt Opt_SplitObjs dflags
- mb_o_file = outputFile dflags
- ghc_link = ghcLink dflags -- Set by -c or -no-link
- -- When linking, the -o argument refers to the linker's output.
- -- otherwise, we use it as the name for the pipeline's output.
- output
- -- If we are dong -fno-code, then act as if the output is
- -- 'Temporary'. This stops GHC trying to copy files to their
- -- final location.
- | HscNothing <- hscTarget dflags = Temporary
- | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
- -- -o foo applies to linker
- | isJust mb_o_file = SpecificFile
- -- -o foo applies to the file we are compiling now
- | otherwise = Persistent
- stop_phase' = case stop_phase of
- As | split -> SplitAs
- _ -> stop_phase
- ( _, out_file) <- runPipeline stop_phase' hsc_env
- (src, fmap RealPhase mb_phase) Nothing output
- Nothing{-no ModLocation-} Nothing
- return out_file
- doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
- doLink dflags stop_phase o_files
- | not (isStopLn stop_phase)
- = return () -- We stopped before the linking phase
- | otherwise
- = case ghcLink dflags of
- NoLink -> return ()
- LinkBinary -> linkBinary dflags o_files []
- LinkDynLib -> linkDynLibCheck dflags o_files []
- other -> panicBadLink other
- -- ---------------------------------------------------------------------------
- data PipelineOutput
- = Temporary
- -- ^ Output should be to a temporary file: we're going to
- -- run more compilation steps on this output later.
- | Persistent
- -- ^ We want a persistent file, i.e. a file in the current directory
- -- derived from the input filename, but with the appropriate extension.
- -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
- | SpecificFile
- -- ^ The output must go into the specific outputFile in DynFlags.
- -- We don't store the filename in the constructor as it changes
- -- when doing -dynamic-too.
- deriving Show
- -- | Run a compilation pipeline, consisting of multiple phases.
- --
- -- This is the interface to the compilation pipeline, which runs
- -- a series of compilation steps on a single source file, specifying
- -- at which stage to stop.
- --
- -- The DynFlags can be modified by phases in the pipeline (eg. by
- -- OPTIONS_GHC pragmas), and the changes affect later phases in the
- -- pipeline.
- runPipeline
- :: Phase -- ^ When to stop
- -> HscEnv -- ^ Compilation environment
- -> (FilePath,Maybe PhasePlus) -- ^ Input filename (and maybe -x suffix)
- -> Maybe FilePath -- ^ original basename (if different from ^^^)
- -> PipelineOutput -- ^ Output filename
- -> Maybe ModLocation -- ^ A ModLocation, if this is a Haskell module
- -> Maybe FilePath -- ^ stub object, if we have one
- -> IO (DynFlags, FilePath) -- ^ (final flags, output filename)
- runPipeline stop_phase hsc_env0 (input_fn, mb_phase)
- mb_basename output maybe_loc maybe_stub_o
- = do let
- dflags0 = hsc_dflags hsc_env0
- -- Decide where dump files should go based on the pipeline output
- dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
- hsc_env = hsc_env0 {hsc_dflags = dflags}
- (input_basename, suffix) = splitExtension input_fn
- suffix' = drop 1 suffix -- strip off the .
- basename | Just b <- mb_basename = b
- | otherwise = input_basename
- -- If we were given a -x flag, then use that phase to start from
- start_phase = fromMaybe (RealPhase (startPhase suffix')) mb_phase
- isHaskell (RealPhase (Unlit _)) = True
- isHaskell (RealPhase (Cpp _)) = True
- isHaskell (RealPhase (HsPp _)) = True
- isHaskell (RealPhase (Hsc _)) = True
- isHaskell (HscOut {}) = True
- isHaskell _ = False
- isHaskellishFile = isHaskell start_phase
- env = PipeEnv{ pe_isHaskellishFile = isHaskellishFile,
- stop_phase,
- src_filename = input_fn,
- src_basename = basename,
- src_suffix = suffix',
- output_spec = output }
- -- We want to catch cases of "you can't get there from here" before
- -- we start the pipeline, because otherwise it will just run off the
- -- end.
- --
- -- There is a partial ordering on phases, where A < B iff A occurs
- -- before B in a normal compilation pipeline.
- let happensBefore' = happensBefore dflags
- case start_phase of
- RealPhase start_phase' ->
- when (not (start_phase' `happensBefore'` stop_phase)) $
- throwGhcExceptionIO (UsageError
- ("cannot compile this file to desired target: "
- ++ input_fn))
- HscOut {} -> return ()
- debugTraceMsg dflags 4 (text "Running the pipeline")
- r <- runPipeline' start_phase hsc_env env input_fn
- maybe_loc maybe_stub_o
- -- If we are compiling a Haskell module, and doing
- -- -dynamic-too, but couldn't do the -dynamic-too fast
- -- path, then rerun the pipeline for the dyn way
- let dflags = extractDynFlags hsc_env
- when isHaskellishFile $ whenCannotGenerateDynamicToo dflags $ do
- debugTraceMsg dflags 4
- (text "Running the pipeline again for -dynamic-too")
- let dflags' = doDynamicToo dflags
- hsc_env' <- newHscEnv dflags'
- _ <- runPipeline' start_phase hsc_env' env input_fn
- maybe_loc maybe_stub_o
- return ()
- return r
- runPipeline'
- :: PhasePlus -- ^ When to start
- -> HscEnv -- ^ Compilation environment
- -> PipeEnv
- -> FilePath -- ^ Input filename
- -> Maybe ModLocation -- ^ A ModLocation, if this is a Haskell module
- -> Maybe FilePath -- ^ stub object, if we have one
- -> IO (DynFlags, FilePath) -- ^ (final flags, output filename)
- runPipeline' start_phase hsc_env env input_fn
- maybe_loc maybe_stub_o
- = do
- -- Execute the pipeline...
- let state = PipeState{ hsc_env, maybe_loc, maybe_stub_o = maybe_stub_o }
- evalP (pipeLoop start_phase input_fn) env state
- -- -----------------------------------------------------------------------------
- -- The pipeline uses a monad to carry around various bits of information
- -- PipeEnv: invariant information passed down
- data PipeEnv = PipeEnv {
- pe_isHaskellishFile :: Bool,
- stop_phase :: Phase, -- ^ Stop just before this phase
- src_filename :: String, -- ^ basename of original input source
- src_basename :: String, -- ^ basename of original input source
- src_suffix :: String, -- ^ its extension
- output_spec :: PipelineOutput -- ^ says where to put the pipeline output
- }
- -- PipeState: information that might change during a pipeline run
- data PipeState = PipeState {
- hsc_env :: HscEnv,
- -- ^ only the DynFlags change in the HscEnv. The DynFlags change
- -- at various points, for example when we read the OPTIONS_GHC
- -- pragmas in the Cpp phase.
- maybe_loc :: Maybe ModLocation,
- -- ^ the ModLocation. This is discovered during compilation,
- -- in the Hsc phase where we read the module header.
- maybe_stub_o :: Maybe FilePath
- -- ^ the stub object. This is set by the Hsc phase if a stub
- -- object was created. The stub object will be joined with
- -- the main compilation object using "ld -r" at the end.
- }
- getPipeEnv :: CompPipeline PipeEnv
- getPipeEnv = P $ \env state -> return (state, env)
- getPipeState :: CompPipeline PipeState
- getPipeState = P $ \_env state -> return (state, state)
- instance HasDynFlags CompPipeline where
- getDynFlags = P $ \_env state -> return (state, hsc_dflags (hsc_env state))
- setDynFlags :: DynFlags -> CompPipeline ()
- setDynFlags dflags = P $ \_env state ->
- return (state{hsc_env= (hsc_env state){ hsc_dflags = dflags }}, ())
- setModLocation :: ModLocation -> CompPipeline ()
- setModLocation loc = P $ \_env state ->
- return (state{ maybe_loc = Just loc }, ())
- setStubO :: FilePath -> CompPipeline ()
- setStubO stub_o = P $ \_env state ->
- return (state{ maybe_stub_o = Just stub_o }, ())
- newtype CompPipeline a = P { unP :: PipeEnv -> PipeState -> IO (PipeState, a) }
- evalP :: CompPipeline a -> PipeEnv -> PipeState -> IO a
- evalP f env st = liftM snd $ unP f env st
- instance Monad CompPipeline where
- return a = P $ \_env state -> return (state, a)
- P m >>= k = P $ \env state -> do (state',a) <- m env state
- unP (k a) env state'
- instance MonadIO CompPipeline where
- liftIO m = P $ \_env state -> do a <- m; return (state, a)
- phaseOutputFilename :: Phase{-next phase-} -> CompPipeline FilePath
- phaseOutputFilename next_phase = do
- PipeEnv{stop_phase, src_basename, output_spec} <- getPipeEnv
- PipeState{maybe_loc, hsc_env} <- getPipeState
- let dflags = hsc_dflags hsc_env
- liftIO $ getOutputFilename stop_phase output_spec
- src_basename dflags next_phase maybe_loc
- -- ---------------------------------------------------------------------------
- -- outer pipeline loop
- -- | pipeLoop runs phases until we reach the stop phase
- pipeLoop :: PhasePlus -> FilePath -> CompPipeline (DynFlags, FilePath)
- pipeLoop phase input_fn = do
- env <- getPipeEnv
- dflags <- getDynFlags
- let happensBefore' = happensBefore dflags
- stopPhase = stop_phase env
- case phase of
- RealPhase realPhase | realPhase `eqPhase` stopPhase -- All done
- -> -- Sometimes, a compilation phase doesn't actually generate any output
- -- (eg. the CPP phase when -fcpp is not turned on). If we end on this
- -- stage, but we wanted to keep the output, then we have to explicitly
- -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
- -- further compilation stages can tell what the original filename was.
- case output_spec env of
- Temporary ->
- return (dflags, input_fn)
- output ->
- do pst <- getPipeState
- final_fn <- liftIO $ getOutputFilename
- stopPhase output (src_basename env)
- dflags stopPhase (maybe_loc pst)
- when (final_fn /= input_fn) $ do
- let msg = ("Copying `" ++ input_fn ++"' to `" ++ final_fn ++ "'")
- line_prag = Just ("{-# LINE 1 \"" ++ src_filename env ++ "\" #-}\n")
- liftIO $ copyWithHeader dflags msg line_prag input_fn final_fn
- return (dflags, final_fn)
- | not (realPhase `happensBefore'` stopPhase)
- -- Something has gone wrong. We'll try to cover all the cases when
- -- this could happen, so if we reach here it is a panic.
- -- eg. it might happen if the -C flag is used on a source file that
- -- has {-# OPTIONS -fasm #-}.
- -> panic ("pipeLoop: at phase " ++ show realPhase ++
- " but I wanted to stop at phase " ++ show stopPhase)
- _
- -> do liftIO $ debugTraceMsg dflags 4
- (ptext (sLit "Running phase") <+> ppr phase)
- (next_phase, output_fn) <- runPhase phase input_fn dflags
- r <- pipeLoop next_phase output_fn
- case phase of
- HscOut {} ->
- whenGeneratingDynamicToo dflags $ do
- setDynFlags $ doDynamicToo dflags
- -- TODO shouldn't ignore result:
- _ <- pipeLoop phase input_fn
- return ()
- _ ->
- return ()
- return r
- -- -----------------------------------------------------------------------------
- -- In each phase, we need to know into what filename to generate the
- -- output. All the logic about which filenames we generate output
- -- into is embodied in the following function.
- getOutputFilename
- :: Phase -> PipelineOutput -> String
- -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
- getOutputFilename stop_phase output basename dflags next_phase maybe_location
- | is_last_phase, Persistent <- output = persistent_fn
- | is_last_phase, SpecificFile <- output = case outputFile dflags of
- Just f -> return f
- Nothing ->
- panic "SpecificFile: No filename"
- | keep_this_output = persistent_fn
- | otherwise = newTempName dflags suffix
- where
- hcsuf = hcSuf dflags
- odir = objectDir dflags
- osuf = objectSuf dflags
- keep_hc = gopt Opt_KeepHcFiles dflags
- keep_s = gopt Opt_KeepSFiles dflags
- keep_bc = gopt Opt_KeepLlvmFiles dflags
- myPhaseInputExt HCc = hcsuf
- myPhaseInputExt MergeStub = osuf
- myPhaseInputExt StopLn = osuf
- myPhaseInputExt other = phaseInputExt other
- is_last_phase = next_phase `eqPhase` stop_phase
- -- sometimes, we keep output from intermediate stages
- keep_this_output =
- case next_phase of
- As | keep_s -> True
- LlvmOpt | keep_bc -> True
- HCc | keep_hc -> True
- _other -> False
- suffix = myPhaseInputExt next_phase
- -- persistent object files get put in odir
- persistent_fn
- | StopLn <- next_phase = return odir_persistent
- | otherwise = return persistent
- persistent = basename <.> suffix
- odir_persistent
- | Just loc <- maybe_location = ml_obj_file loc
- | Just d <- odir = d </> persistent
- | otherwise = persistent
- data PhasePlus = RealPhase Phase
- | HscOut HscSource ModuleName HscStatus
- instance Outputable PhasePlus where
- ppr (RealPhase p) = ppr p
- ppr (HscOut {}) = text "HscOut"
- -- -----------------------------------------------------------------------------
- -- | Each phase in the pipeline returns the next phase to execute, and the
- -- name of the file in which the output was placed.
- --
- -- We must do things dynamically this way, because we often don't know
- -- what the rest of the phases will be until part-way through the
- -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
- -- of a source file can change the latter stages of the pipeline from
- -- taking the via-C route to using the native code generator.
- --
- runPhase :: PhasePlus -- ^ Run this phase
- -> FilePath -- ^ name of the input file
- -> DynFlags -- ^ for convenience, we pass the current dflags in
- -> CompPipeline (PhasePlus, -- next phase to run
- FilePath) -- output filename
- -- Invariant: the output filename always contains the output
- -- Interesting case: Hsc when there is no recompilation to do
- -- Then the output filename is still a .o file
- -------------------------------------------------------------------------------
- -- Unlit phase
- runPhase (RealPhase (Unlit sf)) input_fn dflags
- = do
- output_fn <- phaseOutputFilename (Cpp sf)
- let unlit_flags = getOpts dflags opt_L
- flags = map SysTools.Option unlit_flags ++
- [ -- The -h option passes the file name for unlit to
- -- put in a #line directive
- SysTools.Option "-h"
- , SysTools.Option $ escape $ normalise input_fn
- , SysTools.FileOption "" input_fn
- , SysTools.FileOption "" output_fn
- ]
- liftIO $ SysTools.runUnlit dflags flags
- return (RealPhase (Cpp sf), output_fn)
- where
- -- escape the characters \, ", and ', but don't try to escape
- -- Unicode or anything else (so we don't use Util.charToC
- -- here). If we get this wrong, then in
- -- Coverage.addTicksToBinds where we check that the filename in
- -- a SrcLoc is the same as the source filenaame, the two will
- -- look bogusly different. See test:
- -- libraries/hpc/tests/function/subdir/tough2.lhs
- escape ('\\':cs) = '\\':'\\': escape cs
- escape ('\"':cs) = '\\':'\"': escape cs
- escape ('\'':cs) = '\\':'\'': escape cs
- escape (c:cs) = c : escape cs
- escape [] = []
- -------------------------------------------------------------------------------
- -- Cpp phase : (a) gets OPTIONS out of file
- -- (b) runs cpp if necessary
- runPhase (RealPhase (Cpp sf)) input_fn dflags0
- = do
- src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
- (dflags1, unhandled_flags, warns)
- <- liftIO $ parseDynamicFilePragma dflags0 src_opts
- setDynFlags dflags1
- liftIO $ checkProcessArgsResult dflags1 unhandled_flags
- if not (xopt Opt_Cpp dflags1) then do
- -- we have to be careful to emit warnings only once.
- unless (gopt Opt_Pp dflags1) $
- liftIO $ handleFlagWarnings dflags1 warns
- -- no need to preprocess CPP, just pass input file along
- -- to the next phase of the pipeline.
- return (RealPhase (HsPp sf), input_fn)
- else do
- output_fn <- phaseOutputFilename (HsPp sf)
- liftIO $ doCpp dflags1 True{-raw-} False{-no CC opts-}
- input_fn output_fn
- -- re-read the pragmas now that we've preprocessed the file
- -- See #2464,#3457
- src_opts <- liftIO $ getOptionsFromFile dflags0 output_fn
- (dflags2, unhandled_flags, warns)
- <- liftIO $ parseDynamicFilePragma dflags0 src_opts
- liftIO $ checkProcessArgsResult dflags2 unhandled_flags
- unless (gopt Opt_Pp dflags2) $
- liftIO $ handleFlagWarnings dflags2 warns
- -- the HsPp pass below will emit warnings
- setDynFlags dflags2
- return (RealPhase (HsPp sf), output_fn)
- -------------------------------------------------------------------------------
- -- HsPp phase
- runPhase (RealPhase (HsPp sf)) input_fn dflags
- = do
- if not (gopt Opt_Pp dflags) then
- -- no need to preprocess, just pass input file along
- -- to the next phase of the pipeline.
- return (RealPhase (Hsc sf), input_fn)
- else do
- let hspp_opts = getOpts dflags opt_F
- PipeEnv{src_basename, src_suffix} <- getPipeEnv
- let orig_fn = src_basename <.> src_suffix
- output_fn <- phaseOutputFilename (Hsc sf)
- liftIO $ SysTools.runPp dflags
- ( [ SysTools.Option orig_fn
- , SysTools.Option input_fn
- , SysTools.FileOption "" output_fn
- ] ++
- map SysTools.Option hspp_opts
- )
- -- re-read pragmas now that we've parsed the file (see #3674)
- src_opts <- liftIO $ getOptionsFromFile dflags output_fn
- (dflags1, unhandled_flags, warns)
- <- liftIO $ parseDynamicFilePragma dflags src_opts
- setDynFlags dflags1
- liftIO $ checkProcessArgsResult dflags1 unhandled_flags
- liftIO $ handleFlagWarnings dflags1 warns
- return (RealPhase (Hsc sf), output_fn)
- -----------------------------------------------------------------------------
- -- Hsc phase
- -- Compilation of a single module, in "legacy" mode (_not_ under
- -- the direction of the compilation manager).
- runPhase (RealPhase (Hsc src_flavour)) input_fn dflags0
- = do -- normal Hsc mode, not mkdependHS
- PipeEnv{ stop_phase=stop,
- src_basename=basename,
- src_suffix=suff } <- getPipeEnv
- -- we add the current directory (i.e. the directory in which
- -- the .hs files resides) to the include path, since this is
- -- what gcc does, and it's probably what you want.
- let current_dir = takeDirectory basename
- paths = includePaths dflags0
- dflags = dflags0 { includePaths = current_dir : paths }
- setDynFlags dflags
- -- gather the imports and module name
- (hspp_buf,mod_name,imps,src_imps) <- liftIO $
- case src_flavour of
- ExtCoreFile -> do -- no explicit imports in ExtCore input.
- m <- getCoreModuleName input_fn
- return (Nothing, mkModuleName m, [], [])
- _ -> do
- buf <- hGetStringBuffer input_fn
- (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
- return (Just buf, mod_name, imps, src_imps)
- -- Take -o into account if present
- -- Very like -ohi, but we must *only* do this if we aren't linking
- -- (If we're linking then the -o applies to the linked thing, not to
- -- the object file for one module.)
- -- Note the nasty duplication with the same computation in compileFile above
- location <- getLocation src_flavour mod_name
- let o_file = ml_obj_file location -- The real object file
- -- Figure out if the source has changed, for recompilation avoidance.
- --
- -- Setting source_unchanged to True means that M.o seems
- -- to be up to date wrt M.hs; so no need to recompile unless imports have
- -- changed (which the compiler itself figures out).
- -- Setting source_unchanged to False tells the compiler that M.o is out of
- -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
- src_timestamp <- liftIO $ getModificationUTCTime (basename <.> suff)
- source_unchanged <- liftIO $
- if not (isStopLn stop)
- -- SourceModified unconditionally if
- -- (a) recompilation checker is off, or
- -- (b) we aren't going all the way to .o file (e.g. ghc -S)
- then return SourceModified
- -- Otherwise look at file modification dates
- else do o_file_exists <- doesFileExist o_file
- if not o_file_exists
- then return SourceModified -- Need to recompile
- else do t2 <- getModificationUTCTime o_file
- if t2 > src_timestamp
- then return SourceUnmodified
- else return SourceModified
- let extCore_filename = basename ++ ".hcr"
- PipeState{hsc_env=hsc_env'} <- getPipeState
- -- Tell the finder cache about this module
- mod <- liftIO $ addHomeModuleToFinder hsc_env' mod_name location
- -- Make the ModSummary to hand to hscMain
- let
- mod_summary = ModSummary { ms_mod = mod,
- ms_hsc_src = src_flavour,
- ms_hspp_file = input_fn,
- ms_hspp_opts = dflags,
- ms_hspp_buf = hspp_buf,
- ms_location = location,
- ms_hs_date = src_timestamp,
- ms_obj_date = Nothing,
- ms_textual_imps = imps,
- ms_srcimps = src_imps }
- -- run the compiler!
- result <- liftIO $ hscCompileOneShot hsc_env' extCore_filename
- mod_summary source_unchanged
- return (HscOut src_flavour mod_name result,
- panic "HscOut doesn't have an input filename")
- runPhase (HscOut src_flavour mod_name result) _ dflags = do
- location <- getLocation src_flavour mod_name
- setModLocation location
- let o_file = ml_obj_file location -- The real object file
- hsc_lang = hscTarget dflags
- next_phase = hscPostBackendPhase dflags src_flavour hsc_lang
- case result of
- HscNotGeneratingCode ->
- return (RealPhase next_phase,
- panic "No output filename from Hsc when no-code")
- HscUpToDate ->
- do liftIO $ touchObjectFile dflags o_file
- -- The .o file must have a later modification date
- -- than the source file (else we wouldn't get Nothing)
- -- but we touch it anyway, to keep 'make' happy (we think).
- return (RealPhase StopLn, o_file)
- HscUpdateBoot ->
- do -- In the case of hs-boot files, generate a dummy .o-boot
- -- stamp file for the benefit of Make
- liftIO $ touchObjectFile dflags o_file
- return (RealPhase next_phase, o_file)
- HscRecomp cgguts mod_summary
- -> do output_fn <- phaseOutputFilename next_phase
- PipeState{hsc_env=hsc_env'} <- getPipeState
- (outputFilename, mStub) <- liftIO $ hscGenHardCode hsc_env' cgguts mod_summary output_fn
- case mStub of
- Nothing -> return ()
- Just stub_c ->
- do stub_o <- liftIO $ compileStub hsc_env' stub_c
- setStubO stub_o
- return (RealPhase next_phase, outputFilename)
- -----------------------------------------------------------------------------
- -- Cmm phase
- runPhase (RealPhase CmmCpp) input_fn dflags
- = do
- output_fn <- phaseOutputFilename Cmm
- liftIO $ doCpp dflags False{-not raw-} True{-include CC opts-}
- input_fn output_fn
- return (RealPhase Cmm, output_fn)
- runPhase (RealPhase Cmm) input_fn dflags
- = do
- let hsc_lang = hscTarget dflags
- let next_phase = hscPostBackendPhase dflags HsSrcFile hsc_lang
- output_fn <- phaseOutputFilename next_phase
- PipeState{hsc_env} <- getPipeState
- liftIO $ hscCompileCmmFile hsc_env input_fn output_fn
- return (RealPhase next_phase, output_fn)
- -----------------------------------------------------------------------------
- -- Cc phase
- -- we don't support preprocessing .c files (with -E) now. Doing so introduces
- -- way too many hacks, and I can't say I've ever used it anyway.
- runPhase (RealPhase cc_phase) input_fn dflags
- | any (cc_phase `eqPhase`) [Cc, Ccpp, HCc, Cobjc, Cobjcpp]
- = do
- let platform = targetPlatform dflags
- cc_opts = getOpts dflags opt_c
- hcc = cc_phase `eqPhase` HCc
- let cmdline_include_paths = includePaths dflags
- -- HC files have the dependent packages stamped into them
- pkgs <- if hcc then liftIO $ getHCFilePackages input_fn else return []
- -- add package include paths even if we're just compiling .c
- -- files; this is the Value Add(TM) that using ghc instead of
- -- gcc gives you :)
- pkg_include_dirs <- liftIO $ getPackageIncludePath dflags pkgs
- let include_paths = foldr (\ x xs -> "-I" : x : xs) []
- (cmdline_include_paths ++ pkg_include_dirs)
- let gcc_extra_viac_flags = extraGccViaCFlags dflags
- let pic_c_flags = picCCOpts dflags
- let verbFlags = getVerbFlags dflags
- -- cc-options are not passed when compiling .hc files. Our
- -- hc code doesn't not #include any header files anyway, so these
- -- options aren't necessary.
- pkg_extra_cc_opts <- liftIO $
- if cc_phase `eqPhase` HCc
- then return []
- else getPackageExtraCcOpts dflags pkgs
- framework_paths <-
- if platformUsesFrameworks platform
- then do pkgFrameworkPaths <- liftIO $ getPackageFrameworkPath dflags pkgs
- let cmdlineFrameworkPaths = frameworkPaths dflags
- return $ map ("-F"++)
- (cmdlineFrameworkPaths ++ pkgFrameworkPaths)
- else return []
- let split_objs = gopt Opt_SplitObjs dflags
- split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
- | otherwise = [ ]
- let cc_opt | optLevel dflags >= 2 = "-O2"
- | otherwise = "-O"
- -- Decide next phase
- let next_phase = As
- output_fn <- phaseOutputFilename next_phase
- let
- more_hcc_opts =
- -- on x86 the floating point regs have greater precision
- -- than a double, which leads to unpredictable results.
- -- By default, we turn this off with -ffloat-store unless
- -- the user specified -fexcess-precision.
- (if platformArch platform == ArchX86 &&
- not (gopt Opt_ExcessPrecision dflags)
- then [ "-ffloat-store" ]
- else []) ++
- -- gcc's -fstrict-aliasing allows two accesses to memory
- -- to be considered non-aliasing if they have different types.
- -- This interacts badly with the C code we generate, which is
- -- very weakly typed, being derived from C--.
- ["-fno-strict-aliasing"]
- let gcc_lang_opt | cc_phase `eqPhase` Ccpp = "c++"
- | cc_phase `eqPhase` Cobjc = "objective-c"
- | cc_phase `eqPhase` Cobjcpp = "objective-c++"
- | otherwise = "c"
- liftIO $ SysTools.runCc dflags (
- -- force the C compiler to interpret this file as C when
- -- compiling .hc files, by adding the -x c option.
- -- Also useful for plain .c files, just in case GHC saw a
- -- -x c option.
- [ SysTools.Option "-x", SysTools.Option gcc_lang_opt
- , SysTools.FileOption "" input_fn
- , SysTools.Option "-o"
- , SysTools.FileOption "" output_fn
- ]
- ++ map SysTools.Option (
- pic_c_flags
- -- Stub files generated for foreign exports references the runIO_closure
- -- and runNonIO_closure symbols, which are defined in the base package.
- -- These symbols are imported into the stub.c file via RtsAPI.h…
Large files files are truncated, but you can click here to view the full file