-----------------------------------------------------------------------------
--- $Id: DriverPipeline.hs,v 1.11 2000/10/30 11:18:14 sewardj Exp $
--
-- GHC Driver
--
--- (c) Simon Marlow 2000
+-- (c) The University of Glasgow 2002
--
-----------------------------------------------------------------------------
+#include "../includes/ghcconfig.h"
+
module DriverPipeline (
- -- interfaces for the batch-mode driver
- GhcMode(..), getGhcMode, v_GhcMode,
- genPipeline, runPipeline,
+ -- Interfaces for the batch-mode driver
+ runPipeline, staticLink,
- -- interfaces for the compilation manager (interpreted/batch-mode)
- preprocess, compile,
+ -- Interfaces for the compilation manager (interpreted/batch-mode)
+ preprocess,
+ compile, CompResult(..),
+ link,
- -- batch-mode linking interface
- doLink,
+ -- DLL building
+ doMkDLL
) where
#include "HsVersions.h"
-import CmSummarise
-import CmLink
+import Packages
+import GetImports
import DriverState
import DriverUtil
import DriverMkDepend
import DriverPhases
import DriverFlags
+import SysTools ( newTempName, addFilesToClean, getSysMan, copy )
+import qualified SysTools
import HscMain
-import TmpFiles
+import Finder
import HscTypes
import Outputable
import Module
+import ErrUtils
import CmdLineOpts
import Config
+import RdrName ( GlobalRdrEnv )
+import Panic
import Util
-import MkIface ( pprIface )
+import BasicTypes ( SuccessFlag(..) )
+import Maybes ( expectJust )
+
+import ParserCoreUtils ( getCoreModuleName )
+import EXCEPTION
+import DATA_IOREF ( readIORef, writeIORef )
+
+import Time ( ClockTime )
import Directory
import System
-import IOExts
-import Exception
-
import IO
import Monad
import Maybe
------------------------------------------------------------------------------
--- GHC modes of operation
-
-data GhcMode
- = DoMkDependHS -- ghc -M
- | DoMkDLL -- ghc -mk-dll
- | StopBefore Phase -- ghc -E | -C | -S | -c
- | DoMake -- ghc --make
- | DoInteractive -- ghc --interactive
- | DoLink -- [ the default ]
- deriving (Eq)
-
-GLOBAL_VAR(v_GhcMode, error "todo", GhcMode)
-
-modeFlag :: String -> Maybe GhcMode
-modeFlag "-M" = Just $ DoMkDependHS
-modeFlag "-E" = Just $ StopBefore Hsc
-modeFlag "-C" = Just $ StopBefore HCc
-modeFlag "-S" = Just $ StopBefore As
-modeFlag "-c" = Just $ StopBefore Ln
-modeFlag "--make" = Just $ DoMake
-modeFlag "--interactive" = Just $ DoInteractive
-modeFlag _ = Nothing
-
-getGhcMode :: [String]
- -> IO ( [String] -- rest of command line
- , GhcMode
- , String -- "GhcMode" flag
- )
-getGhcMode flags
- = case my_partition modeFlag flags of
- ([] , rest) -> return (rest, DoLink, "") -- default is to do linking
- ([(flag,one)], rest) -> return (rest, one, flag)
- (_ , _ ) ->
- throwDyn (OtherError
- "only one of the flags -M, -E, -C, -S, -c, --make, --interactive is allowed")
------------------------------------------------------------------------------
--- genPipeline
+-- ---------------------------------------------------------------------------
+-- Pre-process
+
+-- Just preprocess a file, put the result in a temp. file (used by the
+-- compilation manager during the summary phase).
+
+preprocess :: FilePath -> IO FilePath
+preprocess filename =
+ ASSERT(isHaskellSrcFilename filename)
+ do restoreDynFlags -- Restore to state of last save
+ runPipeline (StopBefore Hsc) ("preprocess")
+ False{-temporary output file-}
+ Nothing{-no specific output file-}
+ filename
+ Nothing{-no ModLocation-}
+
+-- ---------------------------------------------------------------------------
+-- Compile
+
+-- Compile a single module, under the control of the compilation manager.
--
--- Herein is all the magic about which phases to run in which order, whether
--- the intermediate files should be in /tmp or in the current directory,
--- what the suffix of the intermediate files should be, etc.
-
--- The following compilation pipeline algorithm is fairly hacky. A
--- better way to do this would be to express the whole comilation as a
--- data flow DAG, where the nodes are the intermediate files and the
--- edges are the compilation phases. This framework would also work
--- nicely if a haskell dependency generator was included in the
--- driver.
-
--- It would also deal much more cleanly with compilation phases that
--- generate multiple intermediates, (eg. hsc generates .hc, .hi, and
--- possibly stub files), where some of the output files need to be
--- processed further (eg. the stub files need to be compiled by the C
--- compiler).
-
--- A cool thing to do would then be to execute the data flow graph
--- concurrently, automatically taking advantage of extra processors on
--- the host machine. For example, when compiling two Haskell files
--- where one depends on the other, the data flow graph would determine
--- that the C compiler from the first comilation can be overlapped
--- with the hsc comilation for the second file.
-
-data IntermediateFileType
- = Temporary
- | Persistent
- deriving (Eq)
-
-genPipeline
- :: GhcMode -- when to stop
- -> String -- "stop after" flag (for error messages)
- -> String -- original filename
- -> IO [ -- list of phases to run for this file
- (Phase,
- IntermediateFileType, -- keep the output from this phase?
- String) -- output file suffix
- ]
-
-genPipeline todo stop_flag filename
- = do
- split <- readIORef v_Split_object_files
- mangle <- readIORef v_Do_asm_mangling
- lang <- readIORef v_Hsc_Lang
- keep_hc <- readIORef v_Keep_hc_files
- keep_raw_s <- readIORef v_Keep_raw_s_files
- keep_s <- readIORef v_Keep_s_files
+-- 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, and passing the
+-- output of hsc through the C compiler.
- let
- ----------- ----- ---- --- -- -- - - -
- (_basename, suffix) = splitFilename filename
+-- The driver sits between 'compile' and 'hscMain', translating calls
+-- to the former into calls to the latter, and results from the latter
+-- into results from the former. It does things like preprocessing
+-- the .hs file if necessary, and compiling up the .stub_c files to
+-- generate Linkables.
- start_phase = startPhase suffix
+-- NB. No old interface can also mean that the source has changed.
- haskellish = haskellish_suffix suffix
- cish = cish_suffix suffix
+compile :: HscEnv
+ -> Module
+ -> ModLocation
+ -> ClockTime -- timestamp of original source file
+ -> Bool -- True <=> source unchanged
+ -> Bool -- True <=> have object
+ -> Maybe ModIface -- old interface, if available
+ -> IO CompResult
- -- for a .hc file, or if the -C flag is given, we need to force lang to HscC
- real_lang | suffix == "hc" = HscC
- | otherwise = lang
+data CompResult
+ = CompOK ModDetails -- New details
+ (Maybe GlobalRdrEnv) -- Lexical environment for the module
+ -- (Maybe because we may have loaded it from
+ -- its precompiled interface)
+ ModIface -- New iface
+ (Maybe Linkable) -- New code; Nothing => compilation was not reqd
+ -- (old code is still valid)
- let
- ----------- ----- ---- --- -- -- - - -
- pipeline
- | todo == DoMkDependHS = [ Unlit, Cpp, MkDependHS ]
+ | CompErrs
- | haskellish =
- case real_lang of
- HscC | split && mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle,
- SplitMangle, SplitAs ]
- | mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle, As ]
- | split -> not_valid
- | otherwise -> [ Unlit, Cpp, Hsc, HCc, As ]
- HscAsm | split -> [ Unlit, Cpp, Hsc, SplitMangle, SplitAs ]
- | otherwise -> [ Unlit, Cpp, Hsc, As ]
+compile hsc_env this_mod location src_timestamp
+ source_unchanged have_object
+ old_iface = do
- HscJava | split -> not_valid
- | otherwise -> error "not implemented: compiling via Java"
+ dyn_flags <- restoreDynFlags -- Restore to the state of the last save
- | cish = [ Cc, As ]
+ showPass dyn_flags
+ (showSDoc (text "Compiling" <+> ppr this_mod))
- | otherwise = [ ] -- just pass this file through to the linker
+ let verb = verbosity dyn_flags
+ let input_fn = expectJust "compile:hs" (ml_hs_file location)
+ let input_fnpp = expectJust "compile:hspp" (ml_hspp_file location)
+ let mod_name = moduleName this_mod
- -- ToDo: this is somewhat cryptic
- not_valid = throwDyn (OtherError ("invalid option combination"))
- ----------- ----- ---- --- -- -- - - -
+ when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
- -- this shouldn't happen.
- if start_phase /= Ln && start_phase `notElem` pipeline
- then throwDyn (OtherError ("can't find starting phase for "
- ++ filename))
- else do
+ opts <- getOptionsFromSource input_fnpp
+ processArgs dynamic_flags opts []
+ dyn_flags <- getDynFlags
+
+ let (basename, _) = splitFilename input_fn
+
+ -- figure out what lang we're generating
+ hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
+ -- figure out what the next phase should be
+ next_phase <- hscNextPhase hsc_lang
+ -- figure out what file to generate the output into
+ get_output_fn <- genOutputFilenameFunc False Nothing next_phase basename
+ output_fn <- get_output_fn next_phase (Just location)
+
+ let dyn_flags' = dyn_flags { hscLang = hsc_lang,
+ hscOutName = output_fn,
+ hscStubCOutName = basename ++ "_stub.c",
+ hscStubHOutName = basename ++ "_stub.h",
+ extCoreName = basename ++ ".hcr" }
+
+ -- -no-recomp should also work with --make
+ do_recomp <- readIORef v_Recomp
+ let source_unchanged' = source_unchanged && do_recomp
+ hsc_env' = hsc_env { hsc_dflags = dyn_flags' }
- -- if we can't find the phase we're supposed to stop before,
- -- something has gone wrong.
- case todo of
- StopBefore phase ->
- when (phase /= Ln
- && phase `notElem` pipeline
- && not (phase == As && SplitAs `elem` pipeline)) $
- throwDyn (OtherError
- ("flag " ++ stop_flag
- ++ " is incompatible with source file `" ++ filename ++ "'"))
- _ -> return ()
+ -- run the compiler
+ hsc_result <- hscMain hsc_env' printErrorsAndWarnings this_mod location
+ source_unchanged' have_object old_iface
- let
- ----------- ----- ---- --- -- -- - - -
- annotatePipeline
- :: [Phase] -- raw pipeline
- -> Phase -- phase to stop before
- -> [(Phase, IntermediateFileType, String{-file extension-})]
- annotatePipeline [] _ = []
- annotatePipeline (Ln:_) _ = []
- annotatePipeline (phase:next_phase:ps) stop =
- (phase, keep_this_output, phaseInputExt next_phase)
- : annotatePipeline (next_phase:ps) stop
- where
- keep_this_output
- | next_phase == stop = Persistent
- | otherwise =
- case next_phase of
- Ln -> Persistent
- Mangle | keep_raw_s -> Persistent
- As | keep_s -> Persistent
- HCc | keep_hc -> Persistent
- _other -> Temporary
-
- -- add information about output files to the pipeline
- -- the suffix on an output file is determined by the next phase
- -- in the pipeline, so we add linking to the end of the pipeline
- -- to force the output from the final phase to be a .o file.
- stop_phase = case todo of StopBefore phase -> phase
- DoMkDependHS -> Ln
- DoLink -> Ln
- annotated_pipeline = annotatePipeline (pipeline ++ [ Ln ]) stop_phase
-
- phase_ne p (p1,_,_) = (p1 /= p)
- ----------- ----- ---- --- -- -- - - -
-
- return $
- dropWhile (phase_ne start_phase) .
- foldr (\p ps -> if phase_ne stop_phase p then p:ps else []) []
- $ annotated_pipeline
+ case hsc_result of
+ HscFail -> return CompErrs
+
+ HscNoRecomp details iface -> return (CompOK details Nothing iface Nothing)
+
+ HscRecomp details rdr_env iface
+ stub_h_exists stub_c_exists maybe_interpreted_code -> do
+ let
+ maybe_stub_o <- compileStub dyn_flags' stub_c_exists
+ let stub_unlinked = case maybe_stub_o of
+ Nothing -> []
+ Just stub_o -> [ DotO stub_o ]
+
+ (hs_unlinked, unlinked_time) <-
+ case hsc_lang of
+ -- in interpreted mode, just return the compiled code
+ -- as our "unlinked" object.
+ HscInterpreted ->
+ case maybe_interpreted_code of
+#ifdef GHCI
+ Just comp_bc -> return ([BCOs comp_bc], src_timestamp)
+ -- 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.
+#endif
+ Nothing -> panic "compile: no interpreted code"
+
+ -- we're in batch mode: finish the compilation pipeline.
+ _other -> do
+ let object_filename = ml_obj_file location
+
+ runPipeline (StopBefore Ln) ""
+ True Nothing output_fn (Just location)
+ -- the object filename comes from the ModLocation
+
+ o_time <- getModificationTime object_filename
+ return ([DotO object_filename], o_time)
+
+ let linkable = LM unlinked_time mod_name
+ (hs_unlinked ++ stub_unlinked)
+
+ return (CompOK details rdr_env iface (Just linkable))
+
+-----------------------------------------------------------------------------
+-- stub .h and .c files (for foreign export support)
+
+compileStub dflags stub_c_exists
+ | not stub_c_exists = return Nothing
+ | stub_c_exists = do
+ -- compile the _stub.c file w/ gcc
+ let stub_c = hscStubCOutName dflags
+ stub_o <- runPipeline (StopBefore Ln) "stub-compile"
+ True{-persistent output-}
+ Nothing{-no specific output file-}
+ stub_c
+ Nothing{-no ModLocation-}
+ return (Just stub_o)
+
+
+-- ---------------------------------------------------------------------------
+-- Link
+
+link :: GhciMode -- 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.
+
+#ifdef GHCI
+link Interactive dflags batch_attempt_linking hpt
+ = do -- Not Linking...(demand linker will do the job)
+ return Succeeded
+#endif
+
+link Batch dflags batch_attempt_linking hpt
+ | batch_attempt_linking
+ = do
+ let
+ home_mod_infos = moduleEnvElts hpt
+
+ -- the packages we depend on
+ pkg_deps = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
+
+ -- the linkables to link
+ linkables = map hm_linkable home_mod_infos
+
+ when (verb >= 3) $ do
+ hPutStrLn stderr "link: linkables are ..."
+ hPutStrLn stderr (showSDoc (vcat (map ppr linkables)))
+
+ -- check for the -no-link flag
+ omit_linking <- readIORef v_NoLink
+ if omit_linking
+ then do when (verb >= 3) $
+ hPutStrLn stderr "link(batch): linking omitted (-no-link flag given)."
+ return Succeeded
+ else do
+
+ when (verb >= 1) $
+ hPutStrLn stderr "Linking ..."
+
+ let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
+ obj_files = concatMap getOfiles linkables
+
+ -- Don't showPass in Batch mode; doLink will do that for us.
+ staticLink obj_files pkg_deps
+
+ when (verb >= 3) (hPutStrLn stderr "link: done")
+
+ -- staticLink only returns if it succeeds
+ return Succeeded
+
+ | otherwise
+ = do when (verb >= 3) $ do
+ hPutStrLn stderr "link(batch): upsweep (partially) failed OR"
+ hPutStrLn stderr " Main.main not exported; not linking."
+ return Succeeded
+ where
+ verb = verbosity dflags
+
+-- ---------------------------------------------------------------------------
+-- Run a compilation pipeline, consisting of multiple phases.
runPipeline
- :: [ (Phase, IntermediateFileType, String) ] -- phases to run
- -> String -- input file
- -> Bool -- doing linking afterward?
- -> Bool -- take into account -o when generating output?
- -> IO String -- return final filename
-
-runPipeline pipeline input_fn do_linking use_ofile
- = pipeLoop pipeline input_fn do_linking use_ofile basename suffix
- where (basename, suffix) = splitFilename input_fn
-
-pipeLoop [] input_fn _ _ _ _ = return input_fn
-pipeLoop ((phase, keep, o_suffix):phases)
- input_fn do_linking use_ofile orig_basename orig_suffix
+ :: GhcMode -- when to stop
+ -> String -- "stop after" flag
+ -> Bool -- final output is persistent?
+ -> Maybe FilePath -- where to put the output, optionally
+ -> FilePath -- input filename
+ -> Maybe ModLocation -- a ModLocation for this module, if we have one
+ -> IO FilePath -- output filename
+
+runPipeline todo stop_flag keep_output maybe_output_filename input_fn maybe_loc
= do
+ split <- readIORef v_Split_object_files
+ let (basename, suffix) = splitFilename input_fn
+ start_phase = startPhase suffix
+
+ stop_phase = case todo of
+ StopBefore As | split -> SplitAs
+ StopBefore phase -> phase
+ DoMkDependHS -> Ln
+ DoLink -> Ln
+ DoMkDLL -> Ln
+
+ -- 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.
+ --
+ when (not (start_phase `happensBefore` stop_phase)) $
+ throwDyn (UsageError
+ ("flag `" ++ stop_flag
+ ++ "' is incompatible with source file `"
+ ++ input_fn ++ "'"))
+
+ -- generate a function which will be used to calculate output file names
+ -- as we go along.
+ get_output_fn <- genOutputFilenameFunc keep_output maybe_output_filename
+ stop_phase basename
+
+ -- and execute the pipeline...
+ (output_fn, maybe_loc) <-
+ pipeLoop start_phase stop_phase input_fn basename suffix
+ get_output_fn maybe_loc
+
+ -- 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.
+ if keep_output
+ then do final_fn <- get_output_fn stop_phase maybe_loc
+ when (final_fn /= output_fn) $
+ copy ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
+ ++ "'") output_fn final_fn
+ return final_fn
+ else
+ return output_fn
+
+
+pipeLoop :: Phase -> Phase -> FilePath -> String -> Suffix
+ -> (Phase -> Maybe ModLocation -> IO FilePath)
+ -> Maybe ModLocation -> IO (FilePath, Maybe ModLocation)
+
+pipeLoop phase stop_phase input_fn orig_basename orig_suff
+ get_output_fn maybe_loc
+
+ | phase == stop_phase = return (input_fn, maybe_loc) -- all done
+
+ | not (phase `happensBefore` stop_phase) =
+ -- 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 phase ++
+ " but I wanted to stop at phase " ++ show stop_phase)
+
+ | otherwise = do
+ maybe_next_phase <- runPhase phase orig_basename orig_suff input_fn
+ get_output_fn maybe_loc
+ case maybe_next_phase of
+ (Nothing, maybe_loc, output_fn) -> do
+ -- we stopped early, but return the *final* filename
+ -- (it presumably already exists)
+ final_fn <- get_output_fn stop_phase maybe_loc
+ return (final_fn, maybe_loc)
+ (Just next_phase, maybe_loc, output_fn) ->
+ pipeLoop next_phase stop_phase output_fn
+ orig_basename orig_suff get_output_fn maybe_loc
+
+
+genOutputFilenameFunc :: Bool -> Maybe FilePath -> Phase -> String
+ -> IO (Phase{-next phase-} -> Maybe ModLocation -> IO FilePath)
+genOutputFilenameFunc keep_final_output maybe_output_filename
+ stop_phase basename
+ = do
+ hcsuf <- readIORef v_HC_suf
+ odir <- readIORef v_Output_dir
+ osuf <- readIORef v_Object_suf
+ keep_hc <- readIORef v_Keep_hc_files
+#ifdef ILX
+ keep_il <- readIORef v_Keep_il_files
+ keep_ilx <- readIORef v_Keep_ilx_files
+#endif
+ keep_raw_s <- readIORef v_Keep_raw_s_files
+ keep_s <- readIORef v_Keep_s_files
+ let
+ myPhaseInputExt HCc | Just s <- hcsuf = s
+ myPhaseInputExt Ln = osuf
+ myPhaseInputExt other = phaseInputExt other
+
+ func next_phase maybe_location
+ | is_last_phase, Just f <- maybe_output_filename = return f
+ | is_last_phase && keep_final_output = persistent_fn
+ | keep_this_output = persistent_fn
+ | otherwise = newTempName suffix
+
+ where
+ is_last_phase = next_phase == stop_phase
+
+ -- sometimes, we keep output from intermediate stages
+ keep_this_output =
+ case next_phase of
+ Ln -> True
+ Mangle | keep_raw_s -> True
+ As | keep_s -> True
+ HCc | keep_hc -> True
+ _other -> False
+
+ suffix = myPhaseInputExt next_phase
+
+ -- persistent object files get put in odir
+ persistent_fn
+ | Ln <- next_phase = return odir_persistent
+ | otherwise = return persistent
+
+ persistent = basename ++ '.':suffix
+
+ odir_persistent
+ | Just loc <- maybe_location = ml_obj_file loc
+ | Just d <- odir = replaceFilenameDirectory persistent d
+ | otherwise = persistent
- output_fn <- outputFileName (null phases) keep o_suffix
-
- carry_on <- run_phase phase orig_basename orig_suffix input_fn output_fn
- -- sometimes we bail out early, eg. when the compiler's recompilation
- -- checker has determined that recompilation isn't necessary.
- if not carry_on
- then do let (_,keep,final_suffix) = last phases
- ofile <- outputFileName True keep final_suffix
- return ofile
- else do -- carry on ...
-
- -- sadly, ghc -E is supposed to write the file to stdout. We
- -- generate <file>.cpp, so we also have to cat the file here.
- when (null phases && phase == Cpp) $
- run_something "Dump pre-processed file to stdout"
- ("cat " ++ output_fn)
-
- pipeLoop phases output_fn do_linking use_ofile orig_basename orig_suffix
-
- where
- outputFileName last_phase keep suffix
- = do o_file <- readIORef v_Output_file
- if last_phase && not do_linking && use_ofile && isJust o_file
- then case o_file of
- Just s -> return s
- Nothing -> error "outputFileName"
- else if keep == Persistent
- then do f <- odir_ify (orig_basename ++ '.':suffix)
- osuf_ify f
- else newTempName suffix
+ return func
+
+
+-- -----------------------------------------------------------------------------
+-- 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 :: Phase
+ -> String -- basename of original input source
+ -> String -- its extension
+ -> FilePath -- name of file which contains the input to this phase.
+ -> (Phase -> Maybe ModLocation -> IO FilePath)
+ -- how to calculate the output filename
+ -> Maybe ModLocation -- the ModLocation, if we have one
+ -> IO (Maybe Phase, -- next phase
+ Maybe ModLocation, -- the ModLocation, if we have one
+ FilePath) -- output filename
-------------------------------------------------------------------------------
-- Unlit phase
-run_phase Unlit _basename _suff input_fn output_fn
- = do unlit <- readIORef v_Pgm_L
- unlit_flags <- getOpts opt_L
- run_something "Literate pre-processor"
- ("echo '# 1 \"" ++input_fn++"\"' > "++output_fn++" && "
- ++ unlit ++ ' ':input_fn ++ " - >> " ++ output_fn)
- return True
+runPhase Unlit _basename _suff input_fn get_output_fn maybe_loc
+ = do unlit_flags <- getOpts opt_L
+ -- The -h option passes the file name for unlit to put in a #line directive
+ output_fn <- get_output_fn Cpp maybe_loc
+
+ SysTools.runUnlit (map SysTools.Option unlit_flags ++
+ [ SysTools.Option "-h"
+ , SysTools.Option input_fn
+ , SysTools.FileOption "" input_fn
+ , SysTools.FileOption "" output_fn
+ ])
+
+ return (Just Cpp, maybe_loc, output_fn)
-------------------------------------------------------------------------------
-- Cpp phase
-run_phase Cpp _basename _suff input_fn output_fn
+runPhase Cpp basename suff input_fn get_output_fn maybe_loc
= do src_opts <- getOptionsFromSource input_fn
- _ <- processArgs dynamic_flags src_opts []
-
- do_cpp <- readState cpp_flag
- if do_cpp
- then do
- cpp <- readIORef v_Pgm_P
- hscpp_opts <- getOpts opt_P
- hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
-
- cmdline_include_paths <- readIORef v_Include_paths
- pkg_include_dirs <- getPackageIncludePath
- let include_paths = map (\p -> "-I"++p) (cmdline_include_paths
- ++ pkg_include_dirs)
-
- verb <- is_verbose
- run_something "C pre-processor"
- (unwords
- (["echo '{-# LINE 1 \"" ++ input_fn ++ "\" -}'", ">", output_fn, "&&",
- cpp, verb]
- ++ include_paths
- ++ hs_src_cpp_opts
- ++ hscpp_opts
- ++ [ "-x", "c", input_fn, ">>", output_fn ]
- ))
- else do
- run_something "Ineffective C pre-processor"
- ("echo '{-# LINE 1 \"" ++ input_fn ++ "\" -}' > "
- ++ output_fn ++ " && cat " ++ input_fn
- ++ " >> " ++ output_fn)
- return True
+ unhandled_flags <- processArgs dynamic_flags src_opts []
+ checkProcessArgsResult unhandled_flags basename suff
+
+ do_cpp <- dynFlag cppFlag
+ if not do_cpp then
+ -- no need to preprocess CPP, just pass input file along
+ -- to the next phase of the pipeline.
+ return (Just HsPp, maybe_loc, input_fn)
+ else do
+ output_fn <- get_output_fn HsPp maybe_loc
+ doCpp True{-raw-} False{-no CC opts-} input_fn output_fn
+ return (Just HsPp, maybe_loc, output_fn)
+
+-------------------------------------------------------------------------------
+-- HsPp phase
+
+runPhase HsPp basename suff input_fn get_output_fn maybe_loc
+ = do do_pp <- dynFlag ppFlag
+ if not do_pp then
+ -- no need to preprocess, just pass input file along
+ -- to the next phase of the pipeline.
+ return (Just Hsc, maybe_loc, input_fn)
+ else do
+ hspp_opts <- getOpts opt_F
+ hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
+ let orig_fn = basename ++ '.':suff
+ output_fn <- get_output_fn Hsc maybe_loc
+ SysTools.runPp ( [ SysTools.Option orig_fn
+ , SysTools.Option input_fn
+ , SysTools.FileOption "" output_fn
+ ] ++
+ map SysTools.Option hs_src_pp_opts ++
+ map SysTools.Option hspp_opts
+ )
+ return (Just Hsc, maybe_loc, output_fn)
------------------------------------------------------------------------------
--- MkDependHS phase
-
-run_phase MkDependHS basename suff input_fn _output_fn = do
- src <- readFile input_fn
- let imports = getImports src
-
- deps <- mapM (findDependency basename) imports
-
- osuf_opt <- readIORef v_Output_suf
- let osuf = case osuf_opt of
- Nothing -> "o"
- Just s -> s
-
- extra_suffixes <- readIORef v_Dep_suffixes
- let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
- ofiles = map (\suf -> basename ++ '.':suf) suffixes
-
- objs <- mapM odir_ify ofiles
-
- hdl <- readIORef v_Dep_tmp_hdl
-
- -- std dependeny of the object(s) on the source file
- hPutStrLn hdl (unwords objs ++ " : " ++ basename ++ '.':suff)
-
- let genDep (dep, False {- not an hi file -}) =
- hPutStrLn hdl (unwords objs ++ " : " ++ dep)
- genDep (dep, True {- is an hi file -}) = do
- hisuf <- readIORef v_Hi_suf
- let dep_base = remove_suffix '.' dep
- deps = (dep_base ++ hisuf)
- : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
- -- length objs should be == length deps
- sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)
-
- mapM genDep [ d | Just d <- deps ]
-
- return True
-
--- add the lines to dep_makefile:
- -- always:
- -- this.o : this.hs
-
- -- if the dependency is on something other than a .hi file:
- -- this.o this.p_o ... : dep
- -- otherwise
- -- if the import is {-# SOURCE #-}
- -- this.o this.p_o ... : dep.hi-boot[-$vers]
-
- -- else
- -- this.o ... : dep.hi
- -- this.p_o ... : dep.p_hi
- -- ...
-
- -- (where .o is $osuf, and the other suffixes come from
- -- the cmdline -s options).
-
-----------------------------------------------------------------------------
-- Hsc phase
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
-run_phase Hsc basename suff input_fn output_fn
- = do
-
+runPhase Hsc basename suff input_fn get_output_fn _maybe_loc = do
+ todo <- readIORef v_GhcMode
+ if todo == DoMkDependHS then do
+ locn <- doMkDependHSPhase basename suff input_fn
+ return (Nothing, Just locn, input_fn) -- Ln is a dummy stop phase
+
+ else do
+ -- normal Hsc mode, not mkdependHS
+
-- we add the current directory (i.e. the directory in which
-- the .hs files resides) to the import path, since this is
-- what gcc does, and it's probably what you want.
- let current_dir = getdir basename
+ let current_dir = directoryOf basename
paths <- readIORef v_Include_paths
writeIORef v_Include_paths (current_dir : paths)
- -- figure out where to put the .hi file
- ohi <- readIORef v_Output_hi
- hisuf <- readIORef v_Hi_suf
- let hifile = case ohi of
- Nothing -> current_dir ++ {-ToDo: modname!!-}basename
- ++ hisuf
- Just fn -> fn
+ -- gather the imports and module name
+ (_,_,mod_name) <-
+ if isExtCoreFilename ('.':suff)
+ then do
+ -- no explicit imports in ExtCore input.
+ m <- getCoreModuleName input_fn
+ return ([], [], mkModuleName m)
+ else
+ getImportsFromFile input_fn
+
+ -- build a ModLocation to pass to hscMain.
+ (mod, location') <- mkHomeModLocation mod_name (basename ++ '.':suff)
+
+ -- take -ohi into account if present
+ ohi <- readIORef v_Output_hi
+ let location | Just fn <- ohi = location'{ ml_hi_file = fn }
+ | otherwise = location'
-- figure out if the source has changed, for recompilation avoidance.
-- only do this if we're eventually going to generate a .o file.
-- (ToDo: do when generating .hc files too?)
--
- -- Setting source_unchanged to "-fsource-unchanged" means that M.o seems
+ -- 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 "" tells the compiler that M.o is out of
+ -- 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.
- do_recomp <- readIORef v_Recomp
- todo <- readIORef v_GhcMode
- o_file <- odir_ify (basename ++ '.':phaseInputExt Ln)
+ do_recomp <- readIORef v_Recomp
+ expl_o_file <- readIORef v_Output_file
+
+ let o_file -- if the -o option is given and IT IS THE OBJECT FILE FOR
+ -- THIS COMPILATION, then use that to determine if the
+ -- source is unchanged.
+ | Just x <- expl_o_file, todo == StopBefore Ln = x
+ | otherwise = ml_obj_file location
+
source_unchanged <-
if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
- then return ""
+ then return False
else do t1 <- getModificationTime (basename ++ '.':suff)
o_file_exists <- doesFileExist o_file
if not o_file_exists
- then return "" -- Need to recompile
+ then return False -- Need to recompile
else do t2 <- getModificationTime o_file
if t2 > t1
- then return "-fsource-unchanged"
- else return ""
-
- -- build a bogus ModSummary to pass to hscMain.
- let summary = ModSummary {
- ms_mod = (mkModuleInThisPackage . mkModuleName)
- {-ToDo: modname!!-}basename,
- ms_location = error "no loc",
- ms_ppsource = Just (input_fn, error "no fingerprint"),
- ms_imports = error "no imports"
- }
+ then return True
+ else return False
-- get the DynFlags
- dyn_flags <- readIORef v_DynFlags
+ dyn_flags <- getDynFlags
+ hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
+ next_phase <- hscNextPhase hsc_lang
+ output_fn <- get_output_fn next_phase (Just location)
+
+ let dyn_flags' = dyn_flags { hscLang = hsc_lang,
+ hscOutName = output_fn,
+ hscStubCOutName = basename ++ "_stub.c",
+ hscStubHOutName = basename ++ "_stub.h",
+ extCoreName = basename ++ ".hcr" }
+ hsc_env <- newHscEnv OneShot dyn_flags'
-- run the compiler!
- pcs <- initPersistentCompilerState
- result <- hscMain dyn_flags{ hscOutName = output_fn }
- (source_unchanged == "-fsource-unchanged")
- summary
+ result <- hscMain hsc_env printErrorsAndWarnings mod
+ location{ ml_hspp_file=Just input_fn }
+ source_unchanged
+ False
Nothing -- no iface
- emptyModuleEnv -- HomeSymbolTable
- emptyModuleEnv -- HomeIfaceTable
- pcs
- case result of {
+ case result of
- HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
+ HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
- HscOK details maybe_iface maybe_stub_h maybe_stub_c
- _maybe_interpreted_code pcs -> do
+ HscNoRecomp details iface -> do
+ SysTools.touch "Touching object file" o_file
+ return (Nothing, Just location, output_fn)
- -- deal with stubs
- maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
- case maybe_stub_o of
- Nothing -> return ()
- Just stub_o -> add v_Ld_inputs stub_o
+ HscRecomp _details _rdr_env _iface
+ stub_h_exists stub_c_exists
+ _maybe_interpreted_code -> do
- return True
- }
+ -- deal with stubs
+ maybe_stub_o <- compileStub dyn_flags' stub_c_exists
+ case maybe_stub_o of
+ Nothing -> return ()
+ Just stub_o -> add v_Ld_inputs stub_o
+ case hscLang dyn_flags of
+ HscNothing -> return (Nothing, Just location, output_fn)
+ _ -> return (Just next_phase, Just location, output_fn)
+
+-----------------------------------------------------------------------------
+-- Cmm phase
+
+runPhase CmmCpp basename suff input_fn get_output_fn maybe_loc
+ = do
+ output_fn <- get_output_fn Cmm maybe_loc
+ doCpp False{-not raw-} True{-include CC opts-} input_fn output_fn
+ return (Just Cmm, maybe_loc, output_fn)
+
+runPhase Cmm basename suff input_fn get_output_fn maybe_loc
+ = do
+ dyn_flags <- getDynFlags
+ hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
+ next_phase <- hscNextPhase hsc_lang
+ output_fn <- get_output_fn next_phase maybe_loc
+
+ let dyn_flags' = dyn_flags { hscLang = hsc_lang,
+ hscOutName = output_fn,
+ hscStubCOutName = basename ++ "_stub.c",
+ hscStubHOutName = basename ++ "_stub.h",
+ extCoreName = basename ++ ".hcr" }
+
+ ok <- hscCmmFile dyn_flags' input_fn
+
+ when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))
+
+ return (Just next_phase, maybe_loc, 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.
-run_phase cc_phase _basename _suff input_fn output_fn
+runPhase cc_phase basename suff input_fn get_output_fn maybe_loc
| cc_phase == Cc || cc_phase == HCc
- = do cc <- readIORef v_Pgm_c
- cc_opts <- (getOpts opt_c)
- cmdline_include_dirs <- readIORef v_Include_paths
+ = do cc_opts <- getOpts opt_c
+ cmdline_include_paths <- readIORef v_Include_paths
+
+ split <- readIORef v_Split_object_files
+ mangle <- readIORef v_Do_asm_mangling
let hcc = cc_phase == HCc
- -- 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 <- getPackageIncludePath
- let include_paths = map (\p -> "-I"++p) (cmdline_include_dirs
- ++ pkg_include_dirs)
-
- c_includes <- getPackageCIncludes
- cmdline_includes <- readState cmdline_hc_includes -- -#include options
-
- let cc_injects | hcc = unlines (map mk_include
- (c_includes ++ reverse cmdline_includes))
- | otherwise = ""
- mk_include h_file =
- case h_file of
- '"':_{-"-} -> "#include "++h_file
- '<':_ -> "#include "++h_file
- _ -> "#include \""++h_file++"\""
-
- cc_help <- newTempName "c"
- h <- openFile cc_help WriteMode
- hPutStr h cc_injects
- hPutStrLn h ("#include \"" ++ input_fn ++ "\"\n")
- hClose h
-
- ccout <- newTempName "ccout"
+ next_phase
+ | hcc && mangle = Mangle
+ | otherwise = As
+
+ output_fn <- get_output_fn next_phase maybe_loc
+
+ -- HC files have the dependent packages stamped into them
+ pkgs <- if hcc then 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 <- getPackageIncludePath pkgs
+ let include_paths = foldr (\ x xs -> "-I" : x : xs) []
+ (cmdline_include_paths ++ pkg_include_dirs)
mangle <- readIORef v_Do_asm_mangling
(md_c_flags, md_regd_c_flags) <- machdepCCOpts
- verb <- is_verbose
+ verb <- getVerbFlag
- o2 <- readIORef v_minus_o2_for_C
- let opt_flag | o2 = "-O2"
- | otherwise = "-O"
+ pkg_extra_cc_opts <- getPackageExtraCcOpts pkgs
- pkg_extra_cc_opts <- getPackageExtraCcOpts
+ split_objs <- readIORef v_Split_object_files
+ let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
+ | otherwise = [ ]
excessPrecision <- readIORef v_Excess_precision
- run_something "C Compiler"
- (unwords ([ cc, "-x", "c", cc_help, "-o", output_fn ]
- ++ md_c_flags
- ++ (if cc_phase == HCc && mangle
- then md_regd_c_flags
- else [])
- ++ [ verb, "-S", "-Wimplicit", opt_flag ]
- ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
- ++ cc_opts
-#ifdef mingw32_TARGET_OS
- ++ [" -mno-cygwin"]
-#endif
- ++ (if excessPrecision then [] else [ "-ffloat-store" ])
- ++ include_paths
- ++ pkg_extra_cc_opts
--- ++ [">", ccout]
- ))
- return True
+ -- force the C compiler to interpret this file as C when
+ -- compiling .hc files, by adding the -x c option.
+ let langopt
+ | cc_phase == HCc = [ SysTools.Option "-x", SysTools.Option "c"]
+ | otherwise = [ ]
+
+ SysTools.runCc (langopt ++
+ [ SysTools.FileOption "" input_fn
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" output_fn
+ ]
+ ++ map SysTools.Option (
+ md_c_flags
+ ++ (if cc_phase == HCc && mangle
+ then md_regd_c_flags
+ else [])
+ ++ [ verb, "-S", "-Wimplicit", "-O" ]
+ ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
+ ++ cc_opts
+ ++ split_opt
+ ++ (if excessPrecision then [] else [ "-ffloat-store" ])
+ ++ include_paths
+ ++ pkg_extra_cc_opts
+ ))
+
+ return (Just next_phase, maybe_loc, output_fn)
-- ToDo: postprocess the output from gcc
-----------------------------------------------------------------------------
-- Mangle phase
-run_phase Mangle _basename _suff input_fn output_fn
- = do mangler <- readIORef v_Pgm_m
- mangler_opts <- getOpts opt_m
- machdep_opts <-
- if (prefixMatch "i386" cTARGETPLATFORM)
- then do n_regs <- readState stolen_x86_regs
- return [ show n_regs ]
- else return []
- run_something "Assembly Mangler"
- (unwords (mangler :
- mangler_opts
- ++ [ input_fn, output_fn ]
- ++ machdep_opts
- ))
- return True
+runPhase Mangle _basename _suff input_fn get_output_fn maybe_loc
+ = do mangler_opts <- getOpts opt_m
+ machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
+ then do n_regs <- dynFlag stolen_x86_regs
+ return [ show n_regs ]
+ else return []
+
+ split <- readIORef v_Split_object_files
+ let next_phase
+ | split = SplitMangle
+ | otherwise = As
+ output_fn <- get_output_fn next_phase maybe_loc
+
+ SysTools.runMangle (map SysTools.Option mangler_opts
+ ++ [ SysTools.FileOption "" input_fn
+ , SysTools.FileOption "" output_fn
+ ]
+ ++ map SysTools.Option machdep_opts)
+
+ return (Just next_phase, maybe_loc, output_fn)
-----------------------------------------------------------------------------
-- Splitting phase
-run_phase SplitMangle _basename _suff input_fn _output_fn
- = do splitter <- readIORef v_Pgm_s
-
- -- this is the prefix used for the split .s files
- tmp_pfx <- readIORef v_TmpDir
- x <- myGetProcessID
- let split_s_prefix = tmp_pfx ++ "/ghc" ++ show x
- writeIORef v_Split_prefix split_s_prefix
- addFilesToClean [split_s_prefix ++ "__*"] -- d:-)
-
- -- allocate a tmp file to put the no. of split .s files in (sigh)
- n_files <- newTempName "n_files"
-
- run_something "Split Assembly File"
- (unwords [ splitter
- , input_fn
- , split_s_prefix
- , n_files ]
- )
-
- -- save the number of split files for future references
- s <- readFile n_files
- let n = read s :: Int
- writeIORef v_N_split_files n
- return True
+runPhase SplitMangle _basename _suff input_fn get_output_fn maybe_loc
+ = do -- tmp_pfx is the prefix used for the split .s files
+ -- We also use it as the file to contain the no. of split .s files (sigh)
+ split_s_prefix <- SysTools.newTempName "split"
+ let n_files_fn = split_s_prefix
+
+ SysTools.runSplit [ SysTools.FileOption "" input_fn
+ , SysTools.FileOption "" split_s_prefix
+ , SysTools.FileOption "" n_files_fn
+ ]
+
+ -- Save the number of split files for future references
+ s <- readFile n_files_fn
+ let n_files = read s :: Int
+ writeIORef v_Split_info (split_s_prefix, n_files)
+
+ -- Remember to delete all these files
+ addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
+ | n <- [1..n_files]]
+
+ return (Just SplitAs, maybe_loc, "**splitmangle**")
+ -- we don't use the filename
-----------------------------------------------------------------------------
-- As phase
-run_phase As _basename _suff input_fn output_fn
- = do as <- readIORef v_Pgm_a
- as_opts <- getOpts opt_a
-
+runPhase As _basename _suff input_fn get_output_fn maybe_loc
+ = do as_opts <- getOpts opt_a
cmdline_include_paths <- readIORef v_Include_paths
- let cmdline_include_flags = map (\p -> "-I"++p) cmdline_include_paths
- run_something "Assembler"
- (unwords (as : as_opts
- ++ cmdline_include_flags
- ++ [ "-c", input_fn, "-o", output_fn ]
- ))
- return True
-run_phase SplitAs basename _suff _input_fn _output_fn
- = do as <- readIORef v_Pgm_a
- as_opts <- getOpts opt_a
+ output_fn <- get_output_fn Ln maybe_loc
+
+ -- we create directories for the object file, because it
+ -- might be a hierarchical module.
+ createDirectoryHierarchy (directoryOf output_fn)
+
+ SysTools.runAs (map SysTools.Option as_opts
+ ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
+ ++ [ SysTools.Option "-c"
+ , SysTools.FileOption "" input_fn
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" output_fn
+ ])
+
+ return (Just Ln, maybe_loc, output_fn)
+
- split_s_prefix <- readIORef v_Split_prefix
- n <- readIORef v_N_split_files
+runPhase SplitAs basename _suff _input_fn get_output_fn maybe_loc
+ = do as_opts <- getOpts opt_a
+
+ (split_s_prefix, n) <- readIORef v_Split_info
odir <- readIORef v_Output_dir
let real_odir = case odir of
- Nothing -> basename
+ Nothing -> basename ++ "_split"
Just d -> d
- let assemble_file n = do
- let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
- let output_o = newdir real_odir
+ let assemble_file n
+ = do let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
+ let output_o = replaceFilenameDirectory
(basename ++ "__" ++ show n ++ ".o")
+ real_odir
real_o <- osuf_ify output_o
- run_something "Assembler"
- (unwords (as : as_opts
- ++ [ "-c", "-o", real_o, input_s ]
- ))
+ SysTools.runAs (map SysTools.Option as_opts ++
+ [ SysTools.Option "-c"
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" real_o
+ , SysTools.FileOption "" input_s
+ ])
mapM_ assemble_file [1..n]
+
+ output_fn <- get_output_fn Ln maybe_loc
+ return (Just Ln, maybe_loc, output_fn)
+
+#ifdef ILX
+-----------------------------------------------------------------------------
+-- Ilx2Il phase
+-- Run ilx2il over the ILX output, getting an IL file
+
+runPhase Ilx2Il _basename _suff input_fn get_output_fn maybe_loc
+ = do ilx2il_opts <- getOpts opt_I
+ SysTools.runIlx2il (map SysTools.Option ilx2il_opts
+ ++ [ SysTools.Option "--no-add-suffix-to-assembly",
+ SysTools.Option "mscorlib",
+ SysTools.Option "-o",
+ SysTools.FileOption "" output_fn,
+ SysTools.FileOption "" input_fn ])
return True
-----------------------------------------------------------------------------
--- Linking
+-- Ilasm phase
+-- Run ilasm over the IL, getting a DLL
+
+runPhase Ilasm _basename _suff input_fn get_output_fn maybe_loc
+ = do ilasm_opts <- getOpts opt_i
+ SysTools.runIlasm (map SysTools.Option ilasm_opts
+ ++ [ SysTools.Option "/QUIET",
+ SysTools.Option "/DLL",
+ SysTools.FileOption "/OUT=" output_fn,
+ SysTools.FileOption "" input_fn ])
+ return True
-doLink :: [String] -> IO ()
-doLink o_files = do
- ln <- readIORef v_Pgm_l
- verb <- is_verbose
- o_file <- readIORef v_Output_file
- let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
+#endif /* ILX */
- pkg_lib_paths <- getPackageLibraryPath
- let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
+-----------------------------------------------------------------------------
+-- MoveBinary sort-of-phase
+-- After having produced a binary, move it somewhere else and generate a
+-- wrapper script calling the binary. Currently, we need this only in
+-- a parallel way (i.e. in GUM), because PVM expects the binary in a
+-- central directory.
+-- This is called from staticLink below, after linking. I haven't made it
+-- a separate phase to minimise interfering with other modules, and
+-- we don't need the generality of a phase (MoveBinary is always
+-- done after linking and makes only sense in a parallel setup) -- HWL
+
+runPhase_MoveBinary input_fn
+ = do
+ sysMan <- getSysMan
+ pvm_root <- getEnv "PVM_ROOT"
+ pvm_arch <- getEnv "PVM_ARCH"
+ let
+ pvm_executable_base = "=" ++ input_fn
+ pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
+ -- nuke old binary; maybe use configur'ed names for cp and rm?
+ system ("rm -f " ++ pvm_executable)
+ -- move the newly created binary into PVM land
+ system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
+ -- generate a wrapper script for running a parallel prg under PVM
+ writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
+ return True
- lib_paths <- readIORef v_Library_paths
- let lib_path_opts = map ("-L"++) lib_paths
+-- generates a Perl skript starting a parallel prg under PVM
+mk_pvm_wrapper_script :: String -> String -> String -> String
+mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
+ [
+ "eval 'exec perl -S $0 ${1+\"$@\"}'",
+ " if $running_under_some_shell;",
+ "# =!=!=!=!=!=!=!=!=!=!=!",
+ "# This script is automatically generated: DO NOT EDIT!!!",
+ "# Generated by Glasgow Haskell Compiler",
+ "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
+ "#",
+ "$pvm_executable = '" ++ pvm_executable ++ "';",
+ "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
+ "$SysMan = '" ++ sysMan ++ "';",
+ "",
+ {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
+ "# first, some magical shortcuts to run "commands" on the binary",
+ "# (which is hidden)",
+ "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
+ " local($cmd) = $1;",
+ " system("$cmd $pvm_executable");",
+ " exit(0); # all done",
+ "}", -}
+ "",
+ "# Now, run the real binary; process the args first",
+ "$ENV{'PE'} = $pvm_executable_base;", -- ++ pvm_executable_base,
+ "$debug = '';",
+ "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
+ "@nonPVM_args = ();",
+ "$in_RTS_args = 0;",
+ "",
+ "args: while ($a = shift(@ARGV)) {",
+ " if ( $a eq '+RTS' ) {",
+ " $in_RTS_args = 1;",
+ " } elsif ( $a eq '-RTS' ) {",
+ " $in_RTS_args = 0;",
+ " }",
+ " if ( $a eq '-d' && $in_RTS_args ) {",
+ " $debug = '-';",
+ " } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
+ " $nprocessors = $1;",
+ " } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
+ " $nprocessors = $1;",
+ " } else {",
+ " push(@nonPVM_args, $a);",
+ " }",
+ "}",
+ "",
+ "local($return_val) = 0;",
+ "# Start the parallel execution by calling SysMan",
+ "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
+ "$return_val = $?;",
+ "# ToDo: fix race condition moving files and flushing them!!",
+ "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
+ "exit($return_val);"
+ ]
- pkg_libs <- getPackageLibraries
- let pkg_lib_opts = map (\lib -> "-l"++lib) pkg_libs
+-----------------------------------------------------------------------------
+-- Complain about non-dynamic flags in OPTIONS pragmas
- libs <- readIORef v_Cmdline_libraries
- let lib_opts = map ("-l"++) (reverse libs)
- -- reverse because they're added in reverse order from the cmd line
+checkProcessArgsResult flags basename suff
+ = do when (notNull flags) (throwDyn (ProgramError (
+ showSDoc (hang (text basename <> text ('.':suff) <> char ':')
+ 4 (text "unknown flags in {-# OPTIONS #-} pragma:" <+>
+ hsep (map text flags)))
+ )))
- pkg_extra_ld_opts <- getPackageExtraLdOpts
+-----------------------------------------------------------------------------
+-- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
+
+getHCFilePackages :: FilePath -> IO [PackageName]
+getHCFilePackages filename =
+ EXCEPTION.bracket (openFile filename ReadMode) hClose $ \h -> do
+ l <- hGetLine h
+ case l of
+ '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
+ return (map mkPackageName (words rest))
+ _other ->
+ return []
- -- probably _stub.o files
- extra_ld_inputs <- readIORef v_Ld_inputs
+-----------------------------------------------------------------------------
+-- Static linking, of .o files
- -- opts from -optl-<blah>
- extra_ld_opts <- getStaticOpts v_Opt_l
+-- The list of packages passed to link is the list of packages on
+-- which this program depends, as discovered by the compilation
+-- manager. It is combined with the list of packages that the user
+-- specifies on the command line with -package flags.
+--
+-- In one-shot linking mode, we can't discover the package
+-- dependencies (because we haven't actually done any compilation or
+-- read any interface files), so the user must explicitly specify all
+-- the packages.
- run_something "Linker"
- (unwords
- ([ ln, verb, "-o", output_fn ]
- ++ o_files
- ++ extra_ld_inputs
- ++ lib_path_opts
- ++ lib_opts
- ++ pkg_lib_path_opts
- ++ pkg_lib_opts
- ++ pkg_extra_ld_opts
- ++ extra_ld_opts
- )
- )
+staticLink :: [FilePath] -> [PackageName] -> IO ()
+staticLink o_files dep_packages = do
+ verb <- getVerbFlag
+ static <- readIORef v_Static
+ no_hs_main <- readIORef v_NoHsMain
------------------------------------------------------------------------------
--- Just preprocess a file, put the result in a temp. file (used by the
--- compilation manager during the summary phase).
+ -- get the full list of packages to link with, by combining the
+ -- explicit packages with the auto packages and all of their
+ -- dependencies, and eliminating duplicates.
-preprocess :: FilePath -> IO FilePath
-preprocess filename =
- ASSERT(haskellish_file filename)
- do pipeline <- genPipeline (StopBefore Hsc) ("preprocess") filename
- runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
+ o_file <- readIORef v_Output_file
+ let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
+ pkg_lib_paths <- getPackageLibraryPath dep_packages
+ let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
------------------------------------------------------------------------------
--- 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, and passing the
--- output of hsc through the C compiler.
+ lib_paths <- readIORef v_Library_paths
+ let lib_path_opts = map ("-L"++) lib_paths
--- The driver sits between 'compile' and 'hscMain', translating calls
--- to the former into calls to the latter, and results from the latter
--- into results from the former. It does things like preprocessing
--- the .hs file if necessary, and compiling up the .stub_c files to
--- generate Linkables.
+ pkg_link_opts <- getPackageLinkOpts dep_packages
-compile :: ModSummary -- summary, including source
- -> Maybe ModIface -- old interface, if available
- -> HomeSymbolTable -- for home module ModDetails
- -> HomeIfaceTable -- for home module Ifaces
- -> PersistentCompilerState -- persistent compiler state
- -> IO CompResult
+#ifdef darwin_TARGET_OS
+ pkg_framework_paths <- getPackageFrameworkPath dep_packages
+ let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
-data CompResult
- = CompOK ModDetails -- new details (HST additions)
- (Maybe (ModIface, Linkable))
- -- summary and code; Nothing => compilation not reqd
- -- (old summary and code are still valid)
- PersistentCompilerState -- updated PCS
+ framework_paths <- readIORef v_Framework_paths
+ let framework_path_opts = map ("-F"++) framework_paths
- | CompErrs PersistentCompilerState -- updated PCS
+ pkg_frameworks <- getPackageFrameworks dep_packages
+ let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
+ frameworks <- readIORef v_Cmdline_frameworks
+ let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
+ -- reverse because they're added in reverse order from the cmd line
+#endif
-compile summary old_iface hst hit pcs = do
- verb <- readIORef v_Verbose
- when verb (hPutStrLn stderr
- (showSDoc (text "compile: compiling"
- <+> ppr (name_of_summary summary))))
+ -- probably _stub.o files
+ extra_ld_inputs <- readIORef v_Ld_inputs
- init_dyn_flags <- readIORef v_InitDynFlags
- writeIORef v_DynFlags init_dyn_flags
-
- let input_fn = case ms_ppsource summary of
- Just (ppsource, fingerprint) -> ppsource
- Nothing -> hs_file (ms_location summary)
+ -- opts from -optl-<blah> (including -l<blah> options)
+ extra_ld_opts <- getStaticOpts v_Opt_l
- when verb (hPutStrLn stderr ("compile: input file " ++ input_fn))
+ [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
- opts <- getOptionsFromSource input_fn
- processArgs dynamic_flags opts []
- dyn_flags <- readIORef v_DynFlags
+ ways <- readIORef v_Ways
- hsc_lang <- readIORef v_Hsc_Lang
- output_fn <- case hsc_lang of
- HscAsm -> newTempName (phaseInputExt As)
- HscC -> newTempName (phaseInputExt HCc)
- HscJava -> newTempName "java" -- ToDo
- HscInterpreted -> return (error "no output file")
+ -- Here are some libs that need to be linked at the *end* of
+ -- the command line, because they contain symbols that are referred to
+ -- by the RTS. We can't therefore use the ordinary way opts for these.
+ let
+ debug_opts | WayDebug `elem` ways = [
+#if defined(HAVE_LIBBFD)
+ "-lbfd", "-liberty"
+#endif
+ ]
+ | otherwise = []
- -- run the compiler
- hsc_result <- hscMain dyn_flags{ hscOutName = output_fn }
- (panic "compile:source_unchanged")
- summary old_iface hst hit pcs
-
- case hsc_result of {
- HscFail pcs -> return (CompErrs pcs);
-
- HscOK details maybe_iface
- maybe_stub_h maybe_stub_c maybe_interpreted_code pcs -> do
-
- -- if no compilation happened, bail out early
- case maybe_iface of {
- Nothing -> return (CompOK details Nothing pcs);
- Just iface -> do
-
- let (basename, _) = splitFilename (hs_file (ms_location summary))
- maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
- let stub_unlinked = case maybe_stub_o of
- Nothing -> []
- Just stub_o -> [ DotO stub_o ]
+ let
+ thread_opts | WayThreaded `elem` ways = [
+#if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
+ "-lpthread"
+#endif
+#if defined(osf3_TARGET_OS)
+ , "-lexc"
+#endif
+ ]
+ | otherwise = []
+
+ let extra_os = if static || no_hs_main
+ then []
+ else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
+ head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
+
+ (md_c_flags, _) <- machdepCCOpts
+ SysTools.runLink ( [ SysTools.Option verb
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" output_fn
+ ]
+ ++ map SysTools.Option (
+ md_c_flags
+ ++ o_files
+ ++ extra_os
+ ++ extra_ld_inputs
+ ++ lib_path_opts
+ ++ extra_ld_opts
+#ifdef darwin_TARGET_OS
+ ++ framework_path_opts
+ ++ framework_opts
+#endif
+ ++ pkg_lib_path_opts
+ ++ pkg_link_opts
+#ifdef darwin_TARGET_OS
+ ++ pkg_framework_path_opts
+ ++ pkg_framework_opts
+#endif
+ ++ debug_opts
+ ++ thread_opts
+ ))
- hs_unlinked <-
- case hsc_lang of
+ -- parallel only: move binary to another dir -- HWL
+ ways_ <- readIORef v_Ways
+ when (WayPar `elem` ways_)
+ (do success <- runPhase_MoveBinary output_fn
+ if success then return ()
+ else throwDyn (InstallationError ("cannot move binary to PVM dir")))
- -- in interpreted mode, just return the compiled code
- -- as our "unlinked" object.
- HscInterpreted ->
- case maybe_interpreted_code of
- Just (code,itbl_env) -> return [Trees code itbl_env]
- Nothing -> panic "compile: no interpreted code"
+-----------------------------------------------------------------------------
+-- Making a DLL (only for Win32)
- -- we're in batch mode: finish the compilation pipeline.
- _other -> do pipe <- genPipeline (StopBefore Ln) "" output_fn
- o_file <- runPipeline pipe output_fn False False
- return [ DotO o_file ]
+doMkDLL :: [String] -> [PackageName] -> IO ()
+doMkDLL o_files dep_packages = do
+ verb <- getVerbFlag
+ static <- readIORef v_Static
+ no_hs_main <- readIORef v_NoHsMain
- let linkable = LM (moduleName (ms_mod summary))
- (hs_unlinked ++ stub_unlinked)
+ o_file <- readIORef v_Output_file
+ let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
- return (CompOK details (Just (iface, linkable)) pcs)
- }
- }
+ pkg_lib_paths <- getPackageLibraryPath dep_packages
+ let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
------------------------------------------------------------------------------
--- stub .h and .c files (for foreign export support)
+ lib_paths <- readIORef v_Library_paths
+ let lib_path_opts = map ("-L"++) lib_paths
-dealWithStubs basename maybe_stub_h maybe_stub_c
+ pkg_link_opts <- getPackageLinkOpts dep_packages
- = do let stub_h = basename ++ "_stub.h"
- let stub_c = basename ++ "_stub.c"
+ -- probably _stub.o files
+ extra_ld_inputs <- readIORef v_Ld_inputs
- -- copy the .stub_h file into the current dir if necessary
- case maybe_stub_h of
- Nothing -> return ()
- Just tmp_stub_h -> do
- run_something "Copy stub .h file"
- ("cp " ++ tmp_stub_h ++ ' ':stub_h)
-
- -- #include <..._stub.h> in .hc file
- addCmdlineHCInclude tmp_stub_h -- hack
-
- -- copy the .stub_c file into the current dir, and compile it, if necessary
- case maybe_stub_c of
- Nothing -> return Nothing
- Just tmp_stub_c -> do -- copy the _stub.c file into the current dir
- run_something "Copy stub .c file"
- (unwords [
- "rm -f", stub_c, "&&",
- "echo \'#include \""++stub_h++"\"\' >"++stub_c, " &&",
- "cat", tmp_stub_c, ">> ", stub_c
- ])
-
- -- compile the _stub.c file w/ gcc
- pipeline <- genPipeline (StopBefore Ln) "" stub_c
- stub_o <- runPipeline pipeline stub_c False{-no linking-}
- False{-no -o option-}
-
- return (Just stub_o)
+ -- opts from -optdll-<blah>
+ extra_ld_opts <- getStaticOpts v_Opt_dll
+
+ [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
+
+ let extra_os = if static || no_hs_main
+ then []
+ else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
+ head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
+
+ (md_c_flags, _) <- machdepCCOpts
+ SysTools.runMkDLL
+ ([ SysTools.Option verb
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" output_fn
+ ]
+ ++ map SysTools.Option (
+ md_c_flags
+ ++ o_files
+ ++ extra_os
+ ++ [ "--target=i386-mingw32" ]
+ ++ extra_ld_inputs
+ ++ lib_path_opts
+ ++ extra_ld_opts
+ ++ pkg_lib_path_opts
+ ++ pkg_link_opts
+ ++ (if "--def" `elem` (concatMap words extra_ld_opts)
+ then [ "" ]
+ else [ "--export-all" ])
+ ))
+
+-- -----------------------------------------------------------------------------
+-- Misc.
+
+doCpp :: Bool -> Bool -> FilePath -> FilePath -> IO ()
+doCpp raw include_cc_opts input_fn output_fn = do
+ hscpp_opts <- getOpts opt_P
+
+ cmdline_include_paths <- readIORef v_Include_paths
+
+ pkg_include_dirs <- getPackageIncludePath []
+ let include_paths = foldr (\ x xs -> "-I" : x : xs) []
+ (cmdline_include_paths ++ pkg_include_dirs)
+
+ verb <- getVerbFlag
+
+ cc_opts <- if not include_cc_opts
+ then return []
+ else do optc <- getOpts opt_c
+ (md_c_flags, _) <- machdepCCOpts
+ return (optc ++ md_c_flags)
+
+ let cpp_prog args | raw = SysTools.runCpp args
+ | otherwise = SysTools.runCc (SysTools.Option "-E" : args)
+
+ cpp_prog ([SysTools.Option verb]
+ ++ map SysTools.Option include_paths
+ ++ map SysTools.Option hsSourceCppOpts
+ ++ map SysTools.Option hscpp_opts
+ ++ map SysTools.Option cc_opts
+ ++ [ SysTools.Option "-x"
+ , SysTools.Option "c"
+ , SysTools.Option input_fn
+ -- We hackily use Option instead of FileOption here, so that the file
+ -- name is not back-slashed on Windows. cpp is capable of
+ -- dealing with / in filenames, so it works fine. Furthermore
+ -- if we put in backslashes, cpp outputs #line directives
+ -- with *double* backslashes. And that in turn means that
+ -- our error messages get double backslashes in them.
+ -- In due course we should arrange that the lexer deals
+ -- with these \\ escapes properly.
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" output_fn
+ ])
+
+-- -----------------------------------------------------------------------------
+-- Misc.
+
+hscNextPhase :: HscLang -> IO Phase
+hscNextPhase hsc_lang = do
+ split <- readIORef v_Split_object_files
+ return (case hsc_lang of
+ HscC -> HCc
+ HscAsm | split -> SplitMangle
+ | otherwise -> As
+ HscNothing -> HCc -- dummy (no output will be generated)
+ HscInterpreted -> HCc -- "" ""
+ _other -> HCc -- "" ""
+ )
+
+hscMaybeAdjustLang :: HscLang -> IO HscLang
+hscMaybeAdjustLang current_hsc_lang = do
+ todo <- readIORef v_GhcMode
+ keep_hc <- readIORef v_Keep_hc_files
+ let hsc_lang
+ -- don't change the lang if we're interpreting
+ | current_hsc_lang == HscInterpreted = current_hsc_lang
+ -- force -fvia-C if we are being asked for a .hc file
+ | todo == StopBefore HCc || keep_hc = HscC
+ -- otherwise, stick to the plan
+ | otherwise = current_hsc_lang
+ return hsc_lang