-----------------------------------------------------------------------------
--- $Id: DriverPipeline.hs,v 1.41 2000/12/12 14:35:08 simonmar Exp $
--
-- GHC Driver
--
--
-----------------------------------------------------------------------------
+#include "../includes/config.h"
+
module DriverPipeline (
-- interfaces for the batch-mode driver
GhcMode(..), getGhcMode, v_GhcMode,
- genPipeline, runPipeline,
+ genPipeline, runPipeline, pipeLoop,
-- interfaces for the compilation manager (interpreted/batch-mode)
preprocess, compile, CompResult(..),
-- batch-mode linking interface
- doLink
+ doLink,
+ -- DLL building
+ doMkDLL
) where
#include "HsVersions.h"
-import CmStaticInfo ( GhciMode(..) )
+import Packages
import CmTypes
import GetImports
import DriverState
import DriverMkDepend
import DriverPhases
import DriverFlags
+import SysTools ( newTempName, addFilesToClean, getSysMan, unDosifyPath )
+import qualified SysTools
import HscMain
-import TmpFiles
+import Finder
import HscTypes
import Outputable
import Module
import Monad
import Maybe
+import PackedString
+import MatchPS
+
-----------------------------------------------------------------------------
-- 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 "--mk-dll" = Just $ DoMkDLL
modeFlag "-E" = Just $ StopBefore Hsc
modeFlag "-C" = Just $ StopBefore HCc
modeFlag "-S" = Just $ StopBefore As
([] , 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")
+ throwDyn (UsageError
+ "only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
-----------------------------------------------------------------------------
-- genPipeline
--
-- 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,
+-- the intermediate files should be in TMPDIR or in the current directory,
-- what the suffix of the intermediate files should be, etc.
-- The following compilation pipeline algorithm is fairly hacky. A
deriving (Eq, Show)
genPipeline
- :: GhcMode -- when to stop
- -> String -- "stop after" flag (for error messages)
- -> Bool -- True => output is persistent
- -> HscLang -- preferred output language for hsc
- -> String -- original filename
+ :: GhcMode -- when to stop
+ -> String -- "stop after" flag (for error messages)
+ -> Bool -- True => output is persistent
+ -> HscLang -- preferred output language for hsc
+ -> (FilePath, String) -- original filename & its suffix
-> 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 persistent_output lang filename
+genPipeline todo stop_flag persistent_output lang (filename,suffix)
= do
split <- readIORef v_Split_object_files
mangle <- readIORef v_Do_asm_mangling
keep_raw_s <- readIORef v_Keep_raw_s_files
keep_s <- readIORef v_Keep_s_files
osuf <- readIORef v_Object_suf
+ hcsuf <- readIORef v_HC_suf
let
----------- ----- ---- --- -- -- - - -
- (_basename, suffix) = splitFilename filename
+ start = startPhase suffix
- start_phase = startPhase suffix
+ -- special case for mkdependHS: .hspp files go through MkDependHS
+ start_phase | todo == DoMkDependHS && start == Hsc = MkDependHS
+ | otherwise = start
haskellish = haskellish_suffix suffix
cish = cish_suffix suffix
- -- for a .hc file we need to force lang to HscC
- real_lang | start_phase == HCc = HscC
- | otherwise = lang
+ -- for a .hc file we need to force lang to HscC
+ real_lang | start_phase == HCc || start_phase == Mangle = HscC
+ | otherwise = lang
let
----------- ----- ---- --- -- -- - - -
HscJava | split -> not_valid
| otherwise -> error "not implemented: compiling via Java"
+#ifdef ILX
+ HscILX | split -> not_valid
+ | otherwise -> [ Unlit, Cpp, Hsc, Ilx2Il, Ilasm ]
+#endif
+ HscNothing -> [ Unlit, Cpp, Hsc ]
| cish = [ Cc, As ]
| otherwise = [ ] -- just pass this file through to the linker
-- ToDo: this is somewhat cryptic
- not_valid = throwDyn (OtherError ("invalid option combination"))
+ not_valid = throwDyn (UsageError ("invalid option combination"))
+
+ stop_phase = case todo of
+ StopBefore As | split -> SplitAs
+ StopBefore phase -> phase
+ DoMkDependHS -> Ln
+ DoLink -> Ln
----------- ----- ---- --- -- -- - - -
-- this shouldn't happen.
if start_phase /= Ln && start_phase `notElem` pipeline
- then throwDyn (OtherError ("can't find starting phase for "
- ++ filename))
+ then throwDyn (CmdLineError ("can't find starting phase for "
+ ++ filename))
else do
-- 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
+ -- something has gone wrong. This test carefully avoids the
+ -- case where we aren't supposed to do any compilation, because the file
+ -- is already in linkable form (for example).
+ if start_phase `elem` pipeline &&
+ (stop_phase /= Ln && stop_phase `notElem` pipeline)
+ then throwDyn (UsageError
("flag " ++ stop_flag
++ " is incompatible with source file `" ++ filename ++ "'"))
- _ -> return ()
+ else do
let
- ----------- ----- ---- --- -- -- - - -
- myPhaseInputExt Ln = case osuf of Nothing -> phaseInputExt Ln
- Just s -> s
- myPhaseInputExt other = phaseInputExt other
+ -- .o and .hc suffixes can be overriden by command-line options:
+ myPhaseInputExt Ln | Just s <- osuf = s
+ myPhaseInputExt HCc | Just s <- hcsuf = s
+ myPhaseInputExt other = phaseInputExt other
annotatePipeline
:: [Phase] -- raw 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
+
+ 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
+ return (
+ takeWhile (phase_ne stop_phase ) $
+ dropWhile (phase_ne start_phase) $
+ annotated_pipeline
+ )
runPipeline
:: [ (Phase, IntermediateFileType, String) ] -- phases to run
- -> String -- input file
+ -> (String,String) -- input file
-> Bool -- doing linking afterward?
-> Bool -- take into account -o when generating output?
- -> IO String -- return final filename
+ -> IO (String, 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
+runPipeline pipeline (input_fn,suffix) do_linking use_ofile
+ = pipeLoop pipeline (input_fn,suffix) do_linking use_ofile basename suffix
+ where (basename, _) = 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
+pipeLoop (all_phases@((phase, keep, o_suffix):phases))
+ (input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
= do
output_fn <- outputFileName (null phases) keep o_suffix
- carry_on <- run_phase phase orig_basename orig_suffix input_fn output_fn
+ mbCarryOn <- 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 ...
-
- pipeLoop phases output_fn do_linking use_ofile orig_basename orig_suffix
-
+ case mbCarryOn of
+ Nothing -> do
+ let (_,keep,final_suffix) = last all_phases
+ ofile <- outputFileName True keep final_suffix
+ return (ofile, final_suffix)
+ -- carry on ...
+ Just fn ->
+ {-
+ Notice that in order to keep the invariant that we can
+ determine a compilation pipeline's 'start phase' just
+ by looking at the input filename, the input filename
+ to the next stage/phase is associated here with the suffix
+ of the output file, *even* if it does not have that
+ suffix in reality.
+
+ Why is this important? Because we may run a compilation
+ pipeline in stages (cf. Main.main.compileFile's two stages),
+ so when generating the next stage we need to be precise
+ about what kind of file (=> suffix) is given as input.
+
+ [Not having to generate a pipeline in stages seems like
+ the right way to go, but I've punted on this for now --sof]
+
+ -}
+ pipeLoop phases (fn, o_suffix) do_linking use_ofile
+ orig_basename orig_suffix
where
outputFileName last_phase keep suffix
= do o_file <- readIORef v_Output_file
then odir_ify (orig_basename ++ '.':suffix)
else newTempName suffix
+run_phase :: Phase
+ -> String -- basename of original input source
+ -> String -- its extension
+ -> FilePath -- name of file which contains the input to this phase.
+ -> FilePath -- where to stick the result.
+ -> IO (Maybe FilePath)
+ -- Nothing => stop the compilation pipeline
+ -- Just fn => the result of this phase can be found in 'fn'
+ -- (this can either be 'input_fn' or 'output_fn').
-------------------------------------------------------------------------------
-- Unlit phase
run_phase Unlit _basename _suff input_fn output_fn
- = do unlit <- readIORef v_Pgm_L
- unlit_flags <- getOpts opt_L
- runSomething "Literate pre-processor"
- ("echo '# 1 \"" ++input_fn++"\"' > "++output_fn++" && "
- ++ unlit ++ ' ':input_fn ++ " - >> " ++ output_fn)
- return True
+ = do unlit_flags <- getOpts opt_L
+ -- The -h option passes the file name for unlit to put in a #line directive;
+ -- we undosify it so that it doesn't contain backslashes in Windows, which
+ -- would disappear in error messages
+ SysTools.runUnlit (map SysTools.Option unlit_flags ++
+ [ SysTools.Option "-h"
+ , SysTools.Option input_fn
+ , SysTools.FileOption "" input_fn
+ , SysTools.FileOption "" output_fn
+ ])
+ return (Just output_fn)
-------------------------------------------------------------------------------
-- Cpp phase
run_phase Cpp basename suff input_fn output_fn
= do src_opts <- getOptionsFromSource input_fn
unhandled_flags <- processArgs dynamic_flags src_opts []
+ checkProcessArgsResult unhandled_flags basename suff
- when (not (null unhandled_flags))
- (throwDyn (OtherError (
- basename ++ "." ++ suff
- ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t"
- ++ unwords unhandled_flags)) (ExitFailure 1))
-
- do_cpp <- readState cpp_flag
- if do_cpp
- then do
- cpp <- readIORef v_Pgm_P
- hscpp_opts <- getOpts opt_P
+ 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 input_fn)
+ else do
+ 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)
+ let include_paths = foldr (\ x xs -> "-I" : x : xs) []
+ (cmdline_include_paths ++ pkg_include_dirs)
verb <- getVerbFlag
-
- runSomething "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
- runSomething "Ineffective C pre-processor"
- ("echo '{-# LINE 1 \"" ++ input_fn ++ "\" -}' > "
- ++ output_fn ++ " && cat " ++ input_fn
- ++ " >> " ++ output_fn)
- return True
+ (md_c_flags, _) <- machdepCCOpts
+
+ SysTools.runCpp ([SysTools.Option verb]
+ ++ map SysTools.Option include_paths
+ ++ map SysTools.Option hs_src_cpp_opts
+ ++ map SysTools.Option hscpp_opts
+ ++ map SysTools.Option md_c_flags
+ ++ [ SysTools.Option "-x"
+ , SysTools.Option "c"
+ , SysTools.FileOption "" input_fn
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" output_fn
+ ])
+ return (Just output_fn)
-----------------------------------------------------------------------------
-- MkDependHS phase
-run_phase MkDependHS basename suff input_fn _output_fn = do
+run_phase MkDependHS basename suff input_fn output_fn = do
src <- readFile input_fn
- let (import_sources, import_normals, module_name) = getImports src
+ let (import_sources, import_normals, _) = getImports src
- deps_sources <- mapM (findDependency True basename) import_sources
- deps_normals <- mapM (findDependency False basename) import_normals
+ let orig_fn = basename ++ '.':suff
+ deps_sources <- mapM (findDependency True orig_fn) import_sources
+ deps_normals <- mapM (findDependency False orig_fn) import_normals
let deps = deps_sources ++ deps_normals
osuf_opt <- readIORef v_Object_suf
objs <- mapM odir_ify ofiles
+ -- Handle for file that accumulates dependencies
hdl <- readIORef v_Dep_tmp_hdl
-- std dependency of the object(s) on the source file
mapM genDep [ d | Just d <- deps ]
- return True
+ return (Just output_fn)
-- add the lines to dep_makefile:
-- always:
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 -> basename ++ '.':hisuf
- Just fn -> fn
+ -- figure out which header files to #include in a generated .hc file
+ c_includes <- getPackageCIncludes
+ cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
+
+ let cc_injects = unlines (map mk_include
+ (c_includes ++ reverse cmdline_includes))
+ mk_include h_file =
+ case h_file of
+ '"':_{-"-} -> "#include "++h_file
+ '<':_ -> "#include "++h_file
+ _ -> "#include \""++h_file++"\""
+
+ writeIORef v_HCHeader cc_injects
+
+ -- gather the imports and module name
+ (srcimps,imps,mod_name) <- getImportsFromFile input_fn
+
+ -- build a ModuleLocation to pass to hscMain.
+ (mod, location')
+ <- mkHomeModuleLocn mod_name basename (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.
-- 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.
- do_recomp <- readIORef v_Recomp
- todo <- readIORef v_GhcMode
- o_file' <- odir_ify (basename ++ '.':phaseInputExt Ln)
- o_file <- osuf_ify o_file'
+ do_recomp <- readIORef v_Recomp
+ todo <- readIORef v_GhcMode
+ expl_o_file <- readIORef v_Output_file
+ let o_file =
+ case expl_o_file of
+ Nothing -> unJust "source_unchanged" (ml_obj_file location)
+ Just x -> x
source_unchanged <-
if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
then return False
then return True
else return False
- -- build a ModuleLocation to pass to hscMain.
- let location = ModuleLocation {
- ml_hs_file = Nothing,
- ml_hspp_file = Just input_fn,
- ml_hi_file = Just hifile,
- ml_obj_file = Just o_file
- }
-
-- get the DynFlags
- dyn_flags <- readIORef v_DynFlags
+ dyn_flags <- getDynFlags
+
+ let dyn_flags' = dyn_flags { hscOutName = output_fn,
+ hscStubCOutName = basename ++ "_stub.c",
+ hscStubHOutName = basename ++ "_stub.h",
+ extCoreName = basename ++ ".core" }
-- run the compiler!
pcs <- initPersistentCompilerState
result <- hscMain OneShot
- dyn_flags{ hscOutName = output_fn }
+ dyn_flags' mod
+ location{ ml_hspp_file=Just input_fn }
source_unchanged
- location
+ False
Nothing -- no iface
emptyModuleEnv -- HomeSymbolTable
emptyModuleEnv -- HomeIfaceTable
HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
- HscNoRecomp pcs details iface ->
- do {
- runSomething "Touching object file" ("touch " ++ o_file);
- return False;
- };
+ HscNoRecomp pcs details iface -> do { SysTools.touch "Touching object file" o_file
+ ; return Nothing } ;
- HscRecomp pcs details iface maybe_stub_h maybe_stub_c
+ HscRecomp pcs details iface stub_h_exists stub_c_exists
_maybe_interpreted_code -> do
- -- 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
-
- 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
+ _ -> return (Just output_fn)
}
-----------------------------------------------------------------------------
-- 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
+run_phase cc_phase basename suff input_fn output_fn
| 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
let hcc = cc_phase == HCc
-- .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"
+ 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
| otherwise = [ ]
excessPrecision <- readIORef v_Excess_precision
-
- runSomething "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
- ++ split_opt
- ++ (if excessPrecision then [] else [ "-ffloat-store" ])
- ++ include_paths
- ++ pkg_extra_cc_opts
--- ++ [">", ccout]
- ))
- return True
+ SysTools.runCc ([ SysTools.Option "-x", SysTools.Option "c"
+ , 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", opt_flag ]
+ ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
+ ++ cc_opts
+ ++ split_opt
+ ++ (if excessPrecision then [] else [ "-ffloat-store" ])
+ ++ include_paths
+ ++ pkg_extra_cc_opts
+ ))
+ return (Just 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 []
- runSomething "Assembly Mangler"
- (unwords (mangler :
- mangler_opts
- ++ [ input_fn, output_fn ]
- ++ machdep_opts
- ))
- return True
+ = 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 []
+
+ SysTools.runMangle (map SysTools.Option mangler_opts
+ ++ [ SysTools.FileOption "" input_fn
+ , SysTools.FileOption "" output_fn
+ ]
+ ++ map SysTools.Option machdep_opts)
+ return (Just 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"
-
- runSomething "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
+run_phase SplitMangle _basename _suff input_fn output_fn
+ = 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 output_fn)
-----------------------------------------------------------------------------
-- As phase
run_phase As _basename _suff input_fn output_fn
- = do as <- readIORef v_Pgm_a
- as_opts <- getOpts opt_a
-
+ = do as_opts <- getOpts opt_a
cmdline_include_paths <- readIORef v_Include_paths
- let cmdline_include_flags = map (\p -> "-I"++p) cmdline_include_paths
- runSomething "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
+ 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 output_fn)
- split_s_prefix <- readIORef v_Split_prefix
- n <- readIORef v_N_split_files
+run_phase SplitAs basename _suff _input_fn output_fn
+ = 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
Just d -> d
- let assemble_file n = do
- let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
+ let assemble_file n
+ = do let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
let output_o = newdir real_odir
(basename ++ "__" ++ show n ++ ".o")
real_o <- osuf_ify output_o
- runSomething "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]
+ return (Just output_fn)
+
+#ifdef ILX
+-----------------------------------------------------------------------------
+-- Ilx2Il phase
+-- Run ilx2il over the ILX output, getting an IL file
+
+run_phase Ilx2Il _basename _suff input_fn output_fn
+ = 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 (Just output_fn)
+
+-----------------------------------------------------------------------------
+-- Ilasm phase
+-- Run ilasm over the IL, getting a DLL
+
+run_phase Ilasm _basename _suff input_fn output_fn
+ = 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 (Just output_fn)
+
+#endif -- ILX
+
+-----------------------------------------------------------------------------
+-- 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 doLink 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
+
+run_phase_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
+-- 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);"
+ ]
+
+-----------------------------------------------------------------------------
+-- Complain about non-dynamic flags in OPTIONS pragmas
+
+checkProcessArgsResult flags basename suff
+ = do when (not (null flags)) (throwDyn (ProgramError (
+ basename ++ "." ++ suff
+ ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t"
+ ++ unwords flags)) (ExitFailure 1))
+
-----------------------------------------------------------------------------
-- Linking
doLink :: [String] -> IO ()
doLink o_files = do
- ln <- readIORef v_Pgm_l
- verb <- getVerbFlag
- static <- readIORef v_Static
- let imp = if static then "" else "_imp"
+ verb <- getVerbFlag
+ static <- readIORef v_Static
no_hs_main <- readIORef v_NoHsMain
o_file <- readIORef v_Output_file
let lib_path_opts = map ("-L"++) lib_paths
pkg_libs <- getPackageLibraries
- let pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
+ let imp = if static then "" else "_imp"
+ pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
libs <- readIORef v_Cmdline_libraries
let lib_opts = map ("-l"++) (reverse libs)
rts_pkg <- getPackageDetails ["rts"]
std_pkg <- getPackageDetails ["std"]
-#ifdef mingw32_TARGET_OS
let extra_os = if static || no_hs_main
then []
--- else [ head (lib_paths (head rts_pkg)) ++ "/Main.dll_o",
--- head (lib_paths (head std_pkg)) ++ "/PrelMain.dll_o" ]
- else []
-#endif
+ else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
+ head (library_dirs (head 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
+ ++ lib_opts
+ ++ pkg_lib_path_opts
+ ++ pkg_lib_opts
+ ++ pkg_extra_ld_opts
+ ++ extra_ld_opts
+ ++ if static && not no_hs_main then
+ [ "-u", prefixUnderscore "PrelMain_mainIO_closure",
+ "-u", prefixUnderscore "__stginit_PrelMain"]
+ else []))
+
+ -- parallel only: move binary to another dir -- HWL
+ ways_ <- readIORef v_Ways
+ when (WayPar `elem` ways_)
+ (do success <- run_phase_MoveBinary output_fn
+ if success then return ()
+ else throwDyn (InstallationError ("cannot move binary to PVM dir")))
+
+-----------------------------------------------------------------------------
+-- Making a DLL (only for Win32)
+
+doMkDLL :: [String] -> IO ()
+doMkDLL o_files = do
+ verb <- getVerbFlag
+ static <- readIORef v_Static
+ no_hs_main <- readIORef v_NoHsMain
+
+ o_file <- readIORef v_Output_file
+ let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
+
+ pkg_lib_paths <- getPackageLibraryPath
+ let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
+
+ lib_paths <- readIORef v_Library_paths
+ let lib_path_opts = map ("-L"++) lib_paths
+
+ pkg_libs <- getPackageLibraries
+ let imp = if static then "" else "_imp"
+ pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
+
+ libs <- readIORef v_Cmdline_libraries
+ let lib_opts = map ("-l"++) (reverse libs)
+ -- reverse because they're added in reverse order from the cmd line
+
+ pkg_extra_ld_opts <- getPackageExtraLdOpts
+
+ -- probably _stub.o files
+ extra_ld_inputs <- readIORef v_Ld_inputs
+
+ -- opts from -optdll-<blah>
+ extra_ld_opts <- getStaticOpts v_Opt_dll
+
+ rts_pkg <- getPackageDetails ["rts"]
+ std_pkg <- getPackageDetails ["std"]
+
+ let extra_os = if static || no_hs_main
+ then []
+ else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
+ head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
+
(md_c_flags, _) <- machdepCCOpts
- runSomething "Linker"
- (unwords
- ([ ln, verb, "-o", output_fn ]
- ++ md_c_flags
+ SysTools.runMkDLL
+ ([ SysTools.Option verb
+ , SysTools.Option "-o"
+ , SysTools.FileOption "" output_fn
+ ]
+ ++ map SysTools.Option (
+ md_c_flags
++ o_files
-#ifdef mingw32_TARGET_OS
++ extra_os
-#endif
+ ++ [ "--target=i386-mingw32" ]
++ extra_ld_inputs
++ lib_path_opts
++ lib_opts
++ pkg_lib_path_opts
++ pkg_lib_opts
++ pkg_extra_ld_opts
+ ++ (case findPS (packString (concat extra_ld_opts)) (packString "--def") of
+ Nothing -> [ "--export-all" ]
+ Just _ -> [ "" ])
++ extra_ld_opts
-#ifdef mingw32_TARGET_OS
- ++ if static then [ "-u _PrelMain_mainIO_closure" , "-u ___init_PrelMain"] else []
-#else
- ++ [ "-u PrelMain_mainIO_closure" , "-u __init_PrelMain"]
-#endif
- )
- )
+ ))
-----------------------------------------------------------------------------
-- Just preprocess a file, put the result in a temp. file (used by the
preprocess :: FilePath -> IO FilePath
preprocess filename =
- ASSERT(haskellish_file filename)
- do init_driver_state <- readIORef v_InitDriverState
- writeIORef v_Driver_state init_driver_state
-
+ ASSERT(haskellish_src_file filename)
+ do restoreDynFlags -- Restore to state of last save
pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False
- defaultHscLang filename
- runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
-
+ defaultHscLang (filename, getFileSuffix filename)
+ (fn,_) <- runPipeline pipeline (filename,getFileSuffix filename)
+ False{-no linking-} False{-no -o flag-}
+ return fn
-----------------------------------------------------------------------------
-- Compile a single module, under the control of the compilation manager.
compile :: GhciMode -- distinguish batch from interactive
-> ModSummary -- summary, including source
- -> Bool -- source unchanged?
+ -> Bool -- True <=> source unchanged
+ -> Bool -- True <=> have object
-> Maybe ModIface -- old interface, if available
-> HomeSymbolTable -- for home module ModDetails
-> HomeIfaceTable -- for home module Ifaces
| CompErrs PersistentCompilerState -- updated PCS
-compile ghci_mode summary source_unchanged old_iface hst hit pcs = do
- init_dyn_flags <- readIORef v_InitDynFlags
- writeIORef v_DynFlags init_dyn_flags
- init_driver_state <- readIORef v_InitDriverState
- writeIORef v_Driver_state init_driver_state
+compile ghci_mode summary source_unchanged have_object
+ old_iface hst hit pcs = do
+ dyn_flags <- restoreDynFlags -- Restore to the state of the last save
+
- showPass init_dyn_flags
+ showPass dyn_flags
(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
- let verb = verbosity init_dyn_flags
+ let verb = verbosity dyn_flags
let location = ms_location summary
let input_fn = unJust "compile:hs" (ml_hs_file location)
let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
opts <- getOptionsFromSource input_fnpp
processArgs dynamic_flags opts []
- dyn_flags <- readIORef v_DynFlags
+ dyn_flags <- getDynFlags
+
+ let hsc_lang = hscLang dyn_flags
+ (basename, _) = splitFilename input_fn
+
+ keep_hc <- readIORef v_Keep_hc_files
+ keep_s <- readIORef v_Keep_s_files
+
+ output_fn <-
+ case hsc_lang of
+ HscAsm | keep_s -> return (basename ++ '.':phaseInputExt As)
+ | otherwise -> newTempName (phaseInputExt As)
+ HscC | keep_hc -> return (basename ++ '.':phaseInputExt HCc)
+ | otherwise -> newTempName (phaseInputExt HCc)
+ HscJava -> newTempName "java" -- ToDo
+#ifdef ILX
+ HscILX -> return (phaseInputExt Ilx2Il)
+#endif
+ HscInterpreted -> return (error "no output file")
+ HscNothing -> return (error "no output file")
+
+ let dyn_flags' = dyn_flags { hscOutName = output_fn,
+ hscStubCOutName = basename ++ "_stub.c",
+ hscStubHOutName = basename ++ "_stub.h",
+ extCoreName = basename ++ ".core" }
+
+ -- figure out which header files to #include in a generated .hc file
+ c_includes <- getPackageCIncludes
+ cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
- let hsc_lang = hscLang dyn_flags
- output_fn <- case hsc_lang of
- HscAsm -> newTempName (phaseInputExt As)
- HscC -> newTempName (phaseInputExt HCc)
- HscJava -> newTempName "java" -- ToDo
- HscInterpreted -> return (error "no output file")
+ let cc_injects = unlines (map mk_include
+ (c_includes ++ reverse cmdline_includes))
+ mk_include h_file =
+ case h_file of
+ '"':_{-"-} -> "#include "++h_file
+ '<':_ -> "#include "++h_file
+ _ -> "#include \""++h_file++"\""
+
+ writeIORef v_HCHeader cc_injects
+
+ -- -no-recomp should also work with --make
+ do_recomp <- readIORef v_Recomp
+ let source_unchanged' = source_unchanged && do_recomp
-- run the compiler
- hsc_result <- hscMain ghci_mode dyn_flags{ hscOutName = output_fn }
- source_unchanged
- location old_iface hst hit pcs
+ hsc_result <- hscMain ghci_mode dyn_flags'
+ (ms_mod summary) location
+ source_unchanged' have_object old_iface hst hit pcs
case hsc_result of
HscFail pcs -> return (CompErrs pcs)
HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
HscRecomp pcs details iface
- maybe_stub_h maybe_stub_c maybe_interpreted_code -> do
+ stub_h_exists stub_c_exists maybe_interpreted_code -> do
- let (basename, _) = splitFilename input_fn
- maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
+ 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 ]
-- as our "unlinked" object.
HscInterpreted ->
case maybe_interpreted_code of
- Just (code,itbl_env) -> do tm <- getClockTime
- return ([Trees code itbl_env], tm)
+#ifdef GHCI
+ Just (bcos,itbl_env) -> do tm <- getClockTime
+ return ([BCOs bcos itbl_env], tm)
+#endif
Nothing -> panic "compile: no interpreted code"
-- we're in batch mode: finish the compilation pipeline.
_other -> do pipe <- genPipeline (StopBefore Ln) "" True
- hsc_lang output_fn
+ hsc_lang (output_fn, getFileSuffix output_fn)
-- runPipeline takes input_fn so it can split off
-- the base name and use it as the base of
-- the output object file.
let (basename, suffix) = splitFilename input_fn
- o_file <- pipeLoop pipe output_fn False False
- basename suffix
+ (o_file,_) <-
+ pipeLoop pipe (output_fn, getFileSuffix output_fn)
+ False False
+ basename suffix
o_time <- getModificationTime o_file
return ([DotO o_file], o_time)
-----------------------------------------------------------------------------
-- stub .h and .c files (for foreign export support)
-dealWithStubs basename maybe_stub_h maybe_stub_c
-
- = do let stub_h = basename ++ "_stub.h"
- let stub_c = basename ++ "_stub.c"
-
- -- copy the .stub_h file into the current dir if necessary
- case maybe_stub_h of
- Nothing -> return ()
- Just tmp_stub_h -> do
- runSomething "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
- runSomething "Copy stub .c file"
- (unwords [
- "rm -f", stub_c, "&&",
- "echo \'#include \"Stg.h\"\n#include \""++stub_h++"\"\' >"++stub_c, " &&",
- "cat", tmp_stub_c, ">> ", stub_c
- ])
-
- -- compile the _stub.c file w/ gcc
- pipeline <- genPipeline (StopBefore Ln) "" True
- defaultHscLang stub_c
- stub_o <- runPipeline pipeline stub_c False{-no linking-}
- False{-no -o option-}
-
- return (Just stub_o)
+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
+ pipeline <- genPipeline (StopBefore Ln) "" True defaultHscLang (stub_c,"c")
+ (stub_o,_) <- runPipeline pipeline (stub_c,"c") False{-no linking-}
+ False{-no -o option-}
+ return (Just stub_o)
projects / ghc-hetmet.git / blobdiff