1 -----------------------------------------------------------------------------
5 -- (c) The University of Glasgow 2002
7 -----------------------------------------------------------------------------
9 #include "../includes/config.h"
11 module DriverPipeline (
13 -- Interfaces for the batch-mode driver
14 runPipeline, staticLink,
16 -- Interfaces for the compilation manager (interpreted/batch-mode)
18 compile, CompResult(..),
25 #include "HsVersions.h"
34 import SysTools ( newTempName, addFilesToClean, getSysMan, copy )
35 import qualified SysTools
46 import BasicTypes ( SuccessFlag(..) )
47 import Maybes ( expectJust )
49 import ParserCoreUtils ( getCoreModuleName )
52 import DATA_IOREF ( readIORef, writeIORef )
55 import Time ( getClockTime )
64 -- ---------------------------------------------------------------------------
67 -- Just preprocess a file, put the result in a temp. file (used by the
68 -- compilation manager during the summary phase).
70 preprocess :: FilePath -> IO FilePath
72 ASSERT(haskellish_src_file filename)
73 do restoreDynFlags -- Restore to state of last save
74 runPipeline (StopBefore Hsc) ("preprocess")
75 False{-temporary output file-}
76 Nothing{-no specific output file-}
79 -- ---------------------------------------------------------------------------
82 -- Compile a single module, under the control of the compilation manager.
84 -- This is the interface between the compilation manager and the
85 -- compiler proper (hsc), where we deal with tedious details like
86 -- reading the OPTIONS pragma from the source file, and passing the
87 -- output of hsc through the C compiler.
89 -- The driver sits between 'compile' and 'hscMain', translating calls
90 -- to the former into calls to the latter, and results from the latter
91 -- into results from the former. It does things like preprocessing
92 -- the .hs file if necessary, and compiling up the .stub_c files to
93 -- generate Linkables.
95 -- NB. No old interface can also mean that the source has changed.
97 compile :: GhciMode -- distinguish batch from interactive
100 -> Bool -- True <=> source unchanged
101 -> Bool -- True <=> have object
102 -> Maybe ModIface -- old interface, if available
103 -> HomePackageTable -- For home-module stuff
104 -> PersistentCompilerState -- persistent compiler state
108 = CompOK PersistentCompilerState -- Updated PCS
109 ModDetails -- New details
110 ModIface -- New iface
111 (Maybe Linkable) -- New code; Nothing => compilation was not reqd
112 -- (old code is still valid)
114 | CompErrs PersistentCompilerState -- Updated PCS
117 compile ghci_mode this_mod location
118 source_unchanged have_object
119 old_iface hpt pcs = do
121 dyn_flags <- restoreDynFlags -- Restore to the state of the last save
124 (showSDoc (text "Compiling" <+> ppr this_mod))
126 let verb = verbosity dyn_flags
127 let input_fn = expectJust "compile:hs" (ml_hs_file location)
128 let input_fnpp = expectJust "compile:hspp" (ml_hspp_file location)
129 let mod_name = moduleName this_mod
131 when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
133 opts <- getOptionsFromSource input_fnpp
134 processArgs dynamic_flags opts []
135 dyn_flags <- getDynFlags
137 let (basename, _) = splitFilename input_fn
139 -- figure out what lang we're generating
140 hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
141 -- figure out what the next phase should be
142 next_phase <- hscNextPhase hsc_lang
143 -- figure out what file to generate the output into
144 get_output_fn <- genOutputFilenameFunc False Nothing next_phase basename
145 output_fn <- get_output_fn next_phase
147 let dyn_flags' = dyn_flags { hscLang = hsc_lang,
148 hscOutName = output_fn,
149 hscStubCOutName = basename ++ "_stub.c",
150 hscStubHOutName = basename ++ "_stub.h",
151 extCoreName = basename ++ ".hcr" }
153 -- -no-recomp should also work with --make
154 do_recomp <- readIORef v_Recomp
155 let source_unchanged' = source_unchanged && do_recomp
156 hsc_env = HscEnv { hsc_mode = ghci_mode,
157 hsc_dflags = dyn_flags',
161 hsc_result <- hscMain hsc_env pcs this_mod location
162 source_unchanged' have_object old_iface
165 HscFail pcs -> return (CompErrs pcs)
167 HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
169 HscRecomp pcs details iface
170 stub_h_exists stub_c_exists maybe_interpreted_code -> do
172 maybe_stub_o <- compileStub dyn_flags' stub_c_exists
173 let stub_unlinked = case maybe_stub_o of
175 Just stub_o -> [ DotO stub_o ]
177 (hs_unlinked, unlinked_time) <-
180 -- in interpreted mode, just return the compiled code
181 -- as our "unlinked" object.
183 case maybe_interpreted_code of
185 Just comp_bc -> do tm <- getClockTime
186 return ([BCOs comp_bc], tm)
188 Nothing -> panic "compile: no interpreted code"
190 -- we're in batch mode: finish the compilation pipeline.
192 let object_filename = ml_obj_file location
193 object_dir = directoryOf object_filename
195 -- create the object dir if it doesn't exist
196 createDirectoryHierarchy object_dir
198 runPipeline (StopBefore Ln) ""
199 True (Just object_filename) output_fn
201 o_time <- getModificationTime object_filename
202 return ([DotO object_filename], o_time)
204 let linkable = LM unlinked_time mod_name
205 (hs_unlinked ++ stub_unlinked)
207 return (CompOK pcs details iface (Just linkable))
209 -----------------------------------------------------------------------------
210 -- stub .h and .c files (for foreign export support)
212 compileStub dflags stub_c_exists
213 | not stub_c_exists = return Nothing
215 -- compile the _stub.c file w/ gcc
216 let stub_c = hscStubCOutName dflags
217 stub_o <- runPipeline (StopBefore Ln) "stub-compile"
218 True{-persistent output-}
219 Nothing{-no specific output file-}
224 -- ---------------------------------------------------------------------------
227 link :: GhciMode -- interactive or batch
228 -> DynFlags -- dynamic flags
229 -> Bool -- attempt linking in batch mode?
230 -> HomePackageTable -- what to link
233 -- For the moment, in the batch linker, we don't bother to tell doLink
234 -- which packages to link -- it just tries all that are available.
235 -- batch_attempt_linking should only be *looked at* in batch mode. It
236 -- should only be True if the upsweep was successful and someone
237 -- exports main, i.e., we have good reason to believe that linking
241 link Interactive dflags batch_attempt_linking hpt
242 = do -- Not Linking...(demand linker will do the job)
246 link Batch dflags batch_attempt_linking hpt
247 | batch_attempt_linking
250 home_mod_infos = moduleEnvElts hpt
252 -- the packages we depend on
253 pkg_deps = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
255 -- the linkables to link
256 linkables = map hm_linkable home_mod_infos
258 when (verb >= 3) $ do
259 hPutStrLn stderr "link: linkables are ..."
260 hPutStrLn stderr (showSDoc (vcat (map ppr linkables)))
262 -- check for the -no-link flag
263 omit_linking <- readIORef v_NoLink
265 then do when (verb >= 3) $
266 hPutStrLn stderr "link(batch): linking omitted (-no-link flag given)."
271 hPutStrLn stderr "Linking ..."
273 let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
274 obj_files = concatMap getOfiles linkables
276 -- Don't showPass in Batch mode; doLink will do that for us.
277 staticLink obj_files pkg_deps
279 when (verb >= 3) (hPutStrLn stderr "link: done")
281 -- staticLink only returns if it succeeds
285 = do when (verb >= 3) $ do
286 hPutStrLn stderr "link(batch): upsweep (partially) failed OR"
287 hPutStrLn stderr " Main.main not exported; not linking."
290 verb = verbosity dflags
292 -- ---------------------------------------------------------------------------
293 -- Run a compilation pipeline, consisting of multiple phases.
296 :: GhcMode -- when to stop
297 -> String -- "stop after" flag
298 -> Bool -- final output is persistent?
299 -> Maybe FilePath -- where to put the output, optionally
300 -> FilePath -- input filename
301 -> IO FilePath -- output filename
303 runPipeline todo stop_flag keep_output maybe_output_filename input_fn
305 split <- readIORef v_Split_object_files
306 let (basename, suffix) = splitFilename input_fn
307 start_phase = startPhase suffix
309 stop_phase = case todo of
310 StopBefore As | split -> SplitAs
311 StopBefore phase -> phase
316 -- We want to catch cases of "you can't get there from here" before
317 -- we start the pipeline, because otherwise it will just run off the
320 -- There is a partial ordering on phases, where A < B iff A occurs
321 -- before B in a normal compilation pipeline.
323 when (not (start_phase `happensBefore` stop_phase)) $
325 ("flag `" ++ stop_flag
326 ++ "' is incompatible with source file `"
329 -- generate a function which will be used to calculate output file names
331 get_output_fn <- genOutputFilenameFunc keep_output maybe_output_filename
334 -- and execute the pipeline...
335 output_fn <- pipeLoop start_phase stop_phase input_fn basename suffix
338 -- sometimes, a compilation phase doesn't actually generate any output
339 -- (eg. the CPP phase when -fcpp is not turned on). If we end on this
340 -- stage, but we wanted to keep the output, then we have to explicitly
343 then do final_fn <- get_output_fn stop_phase
344 when (final_fn /= output_fn) $
345 copy ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
346 ++ "'") output_fn final_fn
352 pipeLoop :: Phase -> Phase -> FilePath -> String -> Suffix
353 -> (Phase -> IO FilePath) -> IO FilePath
355 pipeLoop phase stop_phase input_fn orig_basename orig_suff get_output_fn
356 | phase == stop_phase = return input_fn -- all done
358 | not (phase `happensBefore` stop_phase) =
359 -- Something has gone wrong. We'll try to cover all the cases when
360 -- this could happen, so if we reach here it is a panic.
361 -- eg. it might happen if the -C flag is used on a source file that
362 -- has {-# OPTIONS -fasm #-}.
363 panic ("pipeLoop: at phase " ++ show phase ++
364 " but I wanted to stop at phase " ++ show stop_phase)
367 maybe_next_phase <- runPhase phase orig_basename orig_suff input_fn
369 case maybe_next_phase of
370 (Nothing, output_fn) ->
371 -- we stopped early, but return the *final* filename
372 -- (it presumably already exists)
373 get_output_fn stop_phase
374 (Just next_phase, output_fn) ->
375 pipeLoop next_phase stop_phase output_fn
376 orig_basename orig_suff get_output_fn
379 genOutputFilenameFunc :: Bool -> Maybe FilePath -> Phase -> String
380 -> IO (Phase{-next phase-} -> IO FilePath)
381 genOutputFilenameFunc keep_output maybe_output_filename stop_phase basename
383 hcsuf <- readIORef v_HC_suf
384 odir <- readIORef v_Output_dir
385 osuf <- readIORef v_Object_suf
386 keep_hc <- readIORef v_Keep_hc_files
388 keep_il <- readIORef v_Keep_il_files
389 keep_ilx <- readIORef v_Keep_ilx_files
391 keep_raw_s <- readIORef v_Keep_raw_s_files
392 keep_s <- readIORef v_Keep_s_files
394 myPhaseInputExt HCc | Just s <- hcsuf = s
395 myPhaseInputExt Ln = osuf
396 myPhaseInputExt other = phaseInputExt other
399 | next_phase == stop_phase
400 = case maybe_output_filename of
401 Just file -> return file
403 | Ln <- next_phase -> return odir_persistent
404 | keep_output -> return persistent
405 | otherwise -> newTempName suffix
406 -- sometimes, we keep output from intermediate stages
409 Ln -> return odir_persistent
410 Mangle | keep_raw_s -> return persistent
411 As | keep_s -> return persistent
412 HCc | keep_hc -> return persistent
413 _other -> newTempName suffix
415 suffix = myPhaseInputExt next_phase
416 persistent = basename ++ '.':suffix
419 | Just d <- odir = replaceFilenameDirectory persistent d
420 | otherwise = persistent
425 -- -----------------------------------------------------------------------------
426 -- Each phase in the pipeline returns the next phase to execute, and the
427 -- name of the file in which the output was placed.
429 -- We must do things dynamically this way, because we often don't know
430 -- what the rest of the phases will be until part-way through the
431 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
432 -- of a source file can change the latter stages of the pipeline from
433 -- taking the via-C route to using the native code generator.
436 -> String -- basename of original input source
437 -> String -- its extension
438 -> FilePath -- name of file which contains the input to this phase.
439 -> (Phase -> IO FilePath) -- how to calculate the output filename
440 -> IO (Maybe Phase, -- next phase
441 FilePath) -- output filename
443 -------------------------------------------------------------------------------
446 runPhase Unlit _basename _suff input_fn get_output_fn
447 = do unlit_flags <- getOpts opt_L
448 -- The -h option passes the file name for unlit to put in a #line directive
449 output_fn <- get_output_fn Cpp
451 SysTools.runUnlit (map SysTools.Option unlit_flags ++
452 [ SysTools.Option "-h"
453 , SysTools.Option input_fn
454 , SysTools.FileOption "" input_fn
455 , SysTools.FileOption "" output_fn
458 return (Just Cpp, output_fn)
460 -------------------------------------------------------------------------------
463 runPhase Cpp basename suff input_fn get_output_fn
464 = do src_opts <- getOptionsFromSource input_fn
465 unhandled_flags <- processArgs dynamic_flags src_opts []
466 checkProcessArgsResult unhandled_flags basename suff
468 do_cpp <- dynFlag cppFlag
470 -- no need to preprocess CPP, just pass input file along
471 -- to the next phase of the pipeline.
472 return (Just HsPp, input_fn)
474 hscpp_opts <- getOpts opt_P
475 hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
477 cmdline_include_paths <- readIORef v_Include_paths
479 pkg_include_dirs <- getPackageIncludePath []
480 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
481 (cmdline_include_paths ++ pkg_include_dirs)
484 (md_c_flags, _) <- machdepCCOpts
486 output_fn <- get_output_fn HsPp
488 SysTools.runCpp ([SysTools.Option verb]
489 ++ map SysTools.Option include_paths
490 ++ map SysTools.Option hs_src_cpp_opts
491 ++ map SysTools.Option hscpp_opts
492 ++ map SysTools.Option md_c_flags
493 ++ [ SysTools.Option "-x"
494 , SysTools.Option "c"
495 , SysTools.Option input_fn
496 -- We hackily use Option instead of FileOption here, so that the file
497 -- name is not back-slashed on Windows. cpp is capable of
498 -- dealing with / in filenames, so it works fine. Furthermore
499 -- if we put in backslashes, cpp outputs #line directives
500 -- with *double* backslashes. And that in turn means that
501 -- our error messages get double backslashes in them.
502 -- In due course we should arrange that the lexer deals
503 -- with these \\ escapes properly.
504 , SysTools.Option "-o"
505 , SysTools.FileOption "" output_fn
508 return (Just HsPp, output_fn)
510 -------------------------------------------------------------------------------
513 runPhase HsPp basename suff input_fn get_output_fn
514 = do do_pp <- dynFlag ppFlag
516 -- no need to preprocess, just pass input file along
517 -- to the next phase of the pipeline.
518 return (Just Hsc, input_fn)
520 hspp_opts <- getOpts opt_F
521 hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
522 let orig_fn = basename ++ '.':suff
523 output_fn <- get_output_fn Hsc
524 SysTools.runPp ( [ SysTools.Option orig_fn
525 , SysTools.Option input_fn
526 , SysTools.FileOption "" output_fn
528 map SysTools.Option hs_src_pp_opts ++
529 map SysTools.Option hspp_opts
531 return (Just Hsc, output_fn)
533 -----------------------------------------------------------------------------
536 -- Compilation of a single module, in "legacy" mode (_not_ under
537 -- the direction of the compilation manager).
538 runPhase Hsc basename suff input_fn get_output_fn = do
539 todo <- readIORef v_GhcMode
540 if todo == DoMkDependHS then do
541 doMkDependHSPhase basename suff input_fn
542 return (Nothing, input_fn) -- Ln is a dummy stop phase
545 -- normal Hsc mode, not mkdependHS
547 -- we add the current directory (i.e. the directory in which
548 -- the .hs files resides) to the import path, since this is
549 -- what gcc does, and it's probably what you want.
550 let current_dir = directoryOf basename
552 paths <- readIORef v_Include_paths
553 writeIORef v_Include_paths (current_dir : paths)
555 -- gather the imports and module name
557 if extcoreish_suffix suff
559 -- no explicit imports in ExtCore input.
560 m <- getCoreModuleName input_fn
561 return ([], [], mkModuleName m)
563 getImportsFromFile input_fn
565 -- build a ModLocation to pass to hscMain.
566 let (path,file) = splitFilenameDir basename
567 (mod, location') <- mkHomeModLocation mod_name True path file suff
569 -- take -ohi into account if present
570 ohi <- readIORef v_Output_hi
571 let location | Just fn <- ohi = location'{ ml_hi_file = fn }
572 | otherwise = location'
574 -- figure out if the source has changed, for recompilation avoidance.
575 -- only do this if we're eventually going to generate a .o file.
576 -- (ToDo: do when generating .hc files too?)
578 -- Setting source_unchanged to True means that M.o seems
579 -- to be up to date wrt M.hs; so no need to recompile unless imports have
580 -- changed (which the compiler itself figures out).
581 -- Setting source_unchanged to False tells the compiler that M.o is out of
582 -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
583 do_recomp <- readIORef v_Recomp
584 expl_o_file <- readIORef v_Output_file
586 let o_file -- if the -o option is given and IT IS THE OBJECT FILE FOR
587 -- THIS COMPILATION, then use that to determine if the
588 -- source is unchanged.
589 | Just x <- expl_o_file, todo == StopBefore Ln = x
590 | otherwise = ml_obj_file location
593 if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
595 else do t1 <- getModificationTime (basename ++ '.':suff)
596 o_file_exists <- doesFileExist o_file
598 then return False -- Need to recompile
599 else do t2 <- getModificationTime o_file
605 dyn_flags <- getDynFlags
606 hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
607 next_phase <- hscNextPhase hsc_lang
608 output_fn <- get_output_fn next_phase
610 let dyn_flags' = dyn_flags { hscLang = hsc_lang,
611 hscOutName = output_fn,
612 hscStubCOutName = basename ++ "_stub.c",
613 hscStubHOutName = basename ++ "_stub.h",
614 extCoreName = basename ++ ".hcr" }
615 hsc_env = HscEnv { hsc_mode = OneShot,
616 hsc_dflags = dyn_flags',
617 hsc_HPT = emptyHomePackageTable }
621 pcs <- initPersistentCompilerState
622 result <- hscMain hsc_env pcs mod
623 location{ ml_hspp_file=Just input_fn }
630 HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
632 HscNoRecomp pcs details iface -> do
633 SysTools.touch "Touching object file" o_file
634 return (Nothing, output_fn)
636 HscRecomp _pcs _details _iface stub_h_exists stub_c_exists
637 _maybe_interpreted_code -> do
640 maybe_stub_o <- compileStub dyn_flags' stub_c_exists
643 Just stub_o -> add v_Ld_inputs stub_o
644 case hscLang dyn_flags of
645 HscNothing -> return (Nothing, output_fn)
646 _ -> return (Just next_phase, output_fn)
648 -----------------------------------------------------------------------------
651 -- we don't support preprocessing .c files (with -E) now. Doing so introduces
652 -- way too many hacks, and I can't say I've ever used it anyway.
654 runPhase cc_phase basename suff input_fn get_output_fn
655 | cc_phase == Cc || cc_phase == HCc
656 = do cc_opts <- getOpts opt_c
657 cmdline_include_paths <- readIORef v_Include_paths
659 split <- readIORef v_Split_object_files
660 mangle <- readIORef v_Do_asm_mangling
662 let hcc = cc_phase == HCc
665 | hcc && mangle = Mangle
668 output_fn <- get_output_fn next_phase
670 -- HC files have the dependent packages stamped into them
671 pkgs <- if hcc then getHCFilePackages input_fn else return []
673 -- add package include paths even if we're just compiling .c
674 -- files; this is the Value Add(TM) that using ghc instead of
676 pkg_include_dirs <- getPackageIncludePath pkgs
677 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
678 (cmdline_include_paths ++ pkg_include_dirs)
680 mangle <- readIORef v_Do_asm_mangling
681 (md_c_flags, md_regd_c_flags) <- machdepCCOpts
685 o2 <- readIORef v_minus_o2_for_C
686 let opt_flag | o2 = "-O2"
689 pkg_extra_cc_opts <- getPackageExtraCcOpts pkgs
691 split_objs <- readIORef v_Split_object_files
692 let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
695 excessPrecision <- readIORef v_Excess_precision
697 -- force the C compiler to interpret this file as C when
698 -- compiling .hc files, by adding the -x c option.
700 | cc_phase == HCc = [ SysTools.Option "-x", SysTools.Option "c"]
703 SysTools.runCc (langopt ++
704 [ SysTools.FileOption "" input_fn
705 , SysTools.Option "-o"
706 , SysTools.FileOption "" output_fn
708 ++ map SysTools.Option (
710 ++ (if cc_phase == HCc && mangle
713 ++ [ verb, "-S", "-Wimplicit", opt_flag ]
714 ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
717 ++ (if excessPrecision then [] else [ "-ffloat-store" ])
722 return (Just next_phase, output_fn)
724 -- ToDo: postprocess the output from gcc
726 -----------------------------------------------------------------------------
729 runPhase Mangle _basename _suff input_fn get_output_fn
730 = do mangler_opts <- getOpts opt_m
731 machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
732 then do n_regs <- dynFlag stolen_x86_regs
733 return [ show n_regs ]
736 split <- readIORef v_Split_object_files
738 | split = SplitMangle
740 output_fn <- get_output_fn next_phase
742 SysTools.runMangle (map SysTools.Option mangler_opts
743 ++ [ SysTools.FileOption "" input_fn
744 , SysTools.FileOption "" output_fn
746 ++ map SysTools.Option machdep_opts)
748 return (Just next_phase, output_fn)
750 -----------------------------------------------------------------------------
753 runPhase SplitMangle _basename _suff input_fn get_output_fn
754 = do -- tmp_pfx is the prefix used for the split .s files
755 -- We also use it as the file to contain the no. of split .s files (sigh)
756 split_s_prefix <- SysTools.newTempName "split"
757 let n_files_fn = split_s_prefix
759 SysTools.runSplit [ SysTools.FileOption "" input_fn
760 , SysTools.FileOption "" split_s_prefix
761 , SysTools.FileOption "" n_files_fn
764 -- Save the number of split files for future references
765 s <- readFile n_files_fn
766 let n_files = read s :: Int
767 writeIORef v_Split_info (split_s_prefix, n_files)
769 -- Remember to delete all these files
770 addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
773 return (Just SplitAs, "**splitmangle**") -- we don't use the filename
775 -----------------------------------------------------------------------------
778 runPhase As _basename _suff input_fn get_output_fn
779 = do as_opts <- getOpts opt_a
780 cmdline_include_paths <- readIORef v_Include_paths
782 output_fn <- get_output_fn Ln
784 SysTools.runAs (map SysTools.Option as_opts
785 ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
786 ++ [ SysTools.Option "-c"
787 , SysTools.FileOption "" input_fn
788 , SysTools.Option "-o"
789 , SysTools.FileOption "" output_fn
792 return (Just Ln, output_fn)
795 runPhase SplitAs basename _suff _input_fn get_output_fn
796 = do as_opts <- getOpts opt_a
798 (split_s_prefix, n) <- readIORef v_Split_info
800 odir <- readIORef v_Output_dir
801 let real_odir = case odir of
802 Nothing -> basename ++ "_split"
806 = do let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
807 let output_o = replaceFilenameDirectory
808 (basename ++ "__" ++ show n ++ ".o")
810 real_o <- osuf_ify output_o
811 SysTools.runAs (map SysTools.Option as_opts ++
812 [ SysTools.Option "-c"
813 , SysTools.Option "-o"
814 , SysTools.FileOption "" real_o
815 , SysTools.FileOption "" input_s
818 mapM_ assemble_file [1..n]
820 output_fn <- get_output_fn Ln
821 return (Just Ln, output_fn)
824 -----------------------------------------------------------------------------
826 -- Run ilx2il over the ILX output, getting an IL file
828 runPhase Ilx2Il _basename _suff input_fn get_output_fn
829 = do ilx2il_opts <- getOpts opt_I
830 SysTools.runIlx2il (map SysTools.Option ilx2il_opts
831 ++ [ SysTools.Option "--no-add-suffix-to-assembly",
832 SysTools.Option "mscorlib",
833 SysTools.Option "-o",
834 SysTools.FileOption "" output_fn,
835 SysTools.FileOption "" input_fn ])
838 -----------------------------------------------------------------------------
840 -- Run ilasm over the IL, getting a DLL
842 runPhase Ilasm _basename _suff input_fn get_output_fn
843 = do ilasm_opts <- getOpts opt_i
844 SysTools.runIlasm (map SysTools.Option ilasm_opts
845 ++ [ SysTools.Option "/QUIET",
846 SysTools.Option "/DLL",
847 SysTools.FileOption "/OUT=" output_fn,
848 SysTools.FileOption "" input_fn ])
853 -----------------------------------------------------------------------------
854 -- MoveBinary sort-of-phase
855 -- After having produced a binary, move it somewhere else and generate a
856 -- wrapper script calling the binary. Currently, we need this only in
857 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
858 -- central directory.
859 -- This is called from staticLink below, after linking. I haven't made it
860 -- a separate phase to minimise interfering with other modules, and
861 -- we don't need the generality of a phase (MoveBinary is always
862 -- done after linking and makes only sense in a parallel setup) -- HWL
864 runPhase_MoveBinary input_fn
867 pvm_root <- getEnv "PVM_ROOT"
868 pvm_arch <- getEnv "PVM_ARCH"
870 pvm_executable_base = "=" ++ input_fn
871 pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
872 -- nuke old binary; maybe use configur'ed names for cp and rm?
873 system ("rm -f " ++ pvm_executable)
874 -- move the newly created binary into PVM land
875 system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
876 -- generate a wrapper script for running a parallel prg under PVM
877 writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
880 -- generates a Perl skript starting a parallel prg under PVM
881 mk_pvm_wrapper_script :: String -> String -> String -> String
882 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
884 "eval 'exec perl -S $0 ${1+\"$@\"}'",
885 " if $running_under_some_shell;",
886 "# =!=!=!=!=!=!=!=!=!=!=!",
887 "# This script is automatically generated: DO NOT EDIT!!!",
888 "# Generated by Glasgow Haskell Compiler",
889 "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
891 "$pvm_executable = '" ++ pvm_executable ++ "';",
892 "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
893 "$SysMan = '" ++ sysMan ++ "';",
895 {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
896 "# first, some magical shortcuts to run "commands" on the binary",
897 "# (which is hidden)",
898 "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
899 " local($cmd) = $1;",
900 " system("$cmd $pvm_executable");",
901 " exit(0); # all done",
904 "# Now, run the real binary; process the args first",
905 "$ENV{'PE'} = $pvm_executable_base;", -- ++ pvm_executable_base,
907 "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
908 "@nonPVM_args = ();",
911 "args: while ($a = shift(@ARGV)) {",
912 " if ( $a eq '+RTS' ) {",
913 " $in_RTS_args = 1;",
914 " } elsif ( $a eq '-RTS' ) {",
915 " $in_RTS_args = 0;",
917 " if ( $a eq '-d' && $in_RTS_args ) {",
919 " } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
920 " $nprocessors = $1;",
921 " } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
922 " $nprocessors = $1;",
924 " push(@nonPVM_args, $a);",
928 "local($return_val) = 0;",
929 "# Start the parallel execution by calling SysMan",
930 "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
932 "# ToDo: fix race condition moving files and flushing them!!",
933 "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
937 -----------------------------------------------------------------------------
938 -- Complain about non-dynamic flags in OPTIONS pragmas
940 checkProcessArgsResult flags basename suff
941 = do when (notNull flags) (throwDyn (ProgramError (
942 showSDoc (hang (text basename <> text ('.':suff) <> char ':')
943 4 (text "unknown flags in {-# OPTIONS #-} pragma:" <+>
944 hsep (map text flags)))
947 -----------------------------------------------------------------------------
948 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
950 getHCFilePackages :: FilePath -> IO [PackageName]
951 getHCFilePackages filename =
952 EXCEPTION.bracket (openFile filename ReadMode) hClose $ \h -> do
955 '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
956 return (map mkPackageName (words rest))
960 -----------------------------------------------------------------------------
961 -- Static linking, of .o files
963 -- The list of packages passed to link is the list of packages on
964 -- which this program depends, as discovered by the compilation
965 -- manager. It is combined with the list of packages that the user
966 -- specifies on the command line with -package flags.
968 -- In one-shot linking mode, we can't discover the package
969 -- dependencies (because we haven't actually done any compilation or
970 -- read any interface files), so the user must explicitly specify all
973 staticLink :: [FilePath] -> [PackageName] -> IO ()
974 staticLink o_files dep_packages = do
976 static <- readIORef v_Static
977 no_hs_main <- readIORef v_NoHsMain
979 -- get the full list of packages to link with, by combining the
980 -- explicit packages with the auto packages and all of their
981 -- dependencies, and eliminating duplicates.
983 o_file <- readIORef v_Output_file
984 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
986 pkg_lib_paths <- getPackageLibraryPath dep_packages
987 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
989 lib_paths <- readIORef v_Library_paths
990 let lib_path_opts = map ("-L"++) lib_paths
992 pkg_link_opts <- getPackageLinkOpts dep_packages
994 #ifdef darwin_TARGET_OS
995 pkg_framework_paths <- getPackageFrameworkPath dep_packages
996 let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
998 framework_paths <- readIORef v_Framework_paths
999 let framework_path_opts = map ("-F"++) framework_paths
1001 pkg_frameworks <- getPackageFrameworks dep_packages
1002 let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1004 frameworks <- readIORef v_Cmdline_frameworks
1005 let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1006 -- reverse because they're added in reverse order from the cmd line
1009 -- probably _stub.o files
1010 extra_ld_inputs <- readIORef v_Ld_inputs
1012 -- opts from -optl-<blah> (including -l<blah> options)
1013 extra_ld_opts <- getStaticOpts v_Opt_l
1015 [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1017 let extra_os = if static || no_hs_main
1019 else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
1020 head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1022 (md_c_flags, _) <- machdepCCOpts
1023 SysTools.runLink ( [ SysTools.Option verb
1024 , SysTools.Option "-o"
1025 , SysTools.FileOption "" output_fn
1027 ++ map SysTools.Option (
1034 #ifdef darwin_TARGET_OS
1035 ++ framework_path_opts
1038 ++ pkg_lib_path_opts
1040 #ifdef darwin_TARGET_OS
1041 ++ pkg_framework_path_opts
1042 ++ pkg_framework_opts
1044 ++ if static && not no_hs_main then
1045 [ "-u", prefixUnderscore "Main_zdmain_closure"]
1048 -- parallel only: move binary to another dir -- HWL
1049 ways_ <- readIORef v_Ways
1050 when (WayPar `elem` ways_)
1051 (do success <- runPhase_MoveBinary output_fn
1052 if success then return ()
1053 else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1055 -----------------------------------------------------------------------------
1056 -- Making a DLL (only for Win32)
1058 doMkDLL :: [String] -> [PackageName] -> IO ()
1059 doMkDLL o_files dep_packages = do
1061 static <- readIORef v_Static
1062 no_hs_main <- readIORef v_NoHsMain
1064 o_file <- readIORef v_Output_file
1065 let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1067 pkg_lib_paths <- getPackageLibraryPath dep_packages
1068 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1070 lib_paths <- readIORef v_Library_paths
1071 let lib_path_opts = map ("-L"++) lib_paths
1073 pkg_link_opts <- getPackageLinkOpts dep_packages
1075 -- probably _stub.o files
1076 extra_ld_inputs <- readIORef v_Ld_inputs
1078 -- opts from -optdll-<blah>
1079 extra_ld_opts <- getStaticOpts v_Opt_dll
1081 [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1083 let extra_os = if static || no_hs_main
1085 else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
1086 head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1088 (md_c_flags, _) <- machdepCCOpts
1090 ([ SysTools.Option verb
1091 , SysTools.Option "-o"
1092 , SysTools.FileOption "" output_fn
1094 ++ map SysTools.Option (
1098 ++ [ "--target=i386-mingw32" ]
1102 ++ pkg_lib_path_opts
1104 ++ (if "--def" `elem` (concatMap words extra_ld_opts)
1106 else [ "--export-all" ])
1109 -- -----------------------------------------------------------------------------
1112 hscNextPhase :: HscLang -> IO Phase
1113 hscNextPhase hsc_lang = do
1114 split <- readIORef v_Split_object_files
1115 return (case hsc_lang of
1117 HscAsm | split -> SplitMangle
1119 HscNothing -> HCc -- dummy (no output will be generated)
1120 HscInterpreted -> HCc -- "" ""
1121 _other -> HCc -- "" ""
1124 hscMaybeAdjustLang :: HscLang -> IO HscLang
1125 hscMaybeAdjustLang current_hsc_lang = do
1126 todo <- readIORef v_GhcMode
1127 keep_hc <- readIORef v_Keep_hc_files
1129 -- don't change the lang if we're interpreting
1130 | current_hsc_lang == HscInterpreted = current_hsc_lang
1131 -- force -fvia-C if we are being asked for a .hc file
1132 | todo == StopBefore HCc || keep_hc = HscC
1133 -- force -fvia-C when profiling or ticky-ticky is on
1134 | opt_SccProfilingOn || opt_DoTickyProfiling = HscC
1135 -- otherwise, stick to the plan
1136 | otherwise = current_hsc_lang