1 -----------------------------------------------------------------------------
5 -- (c) Simon Marlow 2000
7 -----------------------------------------------------------------------------
9 #include "../includes/config.h"
11 module DriverPipeline (
13 -- interfaces for the batch-mode driver
14 GhcMode(..), getGhcMode, v_GhcMode,
15 genPipeline, runPipeline, pipeLoop,
17 -- interfaces for the compilation manager (interpreted/batch-mode)
18 preprocess, compile, CompResult(..),
20 -- batch-mode linking interface
26 #include "HsVersions.h"
36 import SysTools ( newTempName, addFilesToClean, getSysMan )
37 import qualified SysTools
49 import Time ( getClockTime )
62 -----------------------------------------------------------------------------
63 -- GHC modes of operation
65 modeFlag :: String -> Maybe GhcMode
66 modeFlag "-M" = Just $ DoMkDependHS
67 modeFlag "--mk-dll" = Just $ DoMkDLL
68 modeFlag "-E" = Just $ StopBefore Hsc
69 modeFlag "-C" = Just $ StopBefore HCc
70 modeFlag "-S" = Just $ StopBefore As
71 modeFlag "-c" = Just $ StopBefore Ln
72 modeFlag "--make" = Just $ DoMake
73 modeFlag "--interactive" = Just $ DoInteractive
76 getGhcMode :: [String]
77 -> IO ( [String] -- rest of command line
79 , String -- "GhcMode" flag
82 = case my_partition modeFlag flags of
83 ([] , rest) -> return (rest, DoLink, "") -- default is to do linking
84 ([(flag,one)], rest) -> return (rest, one, flag)
87 "only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
89 -----------------------------------------------------------------------------
92 -- Herein is all the magic about which phases to run in which order, whether
93 -- the intermediate files should be in TMPDIR or in the current directory,
94 -- what the suffix of the intermediate files should be, etc.
96 -- The following compilation pipeline algorithm is fairly hacky. A
97 -- better way to do this would be to express the whole compilation as a
98 -- data flow DAG, where the nodes are the intermediate files and the
99 -- edges are the compilation phases. This framework would also work
100 -- nicely if a haskell dependency generator was included in the
103 -- It would also deal much more cleanly with compilation phases that
104 -- generate multiple intermediates, (eg. hsc generates .hc, .hi, and
105 -- possibly stub files), where some of the output files need to be
106 -- processed further (eg. the stub files need to be compiled by the C
109 -- A cool thing to do would then be to execute the data flow graph
110 -- concurrently, automatically taking advantage of extra processors on
111 -- the host machine. For example, when compiling two Haskell files
112 -- where one depends on the other, the data flow graph would determine
113 -- that the C compiler from the first compilation can be overlapped
114 -- with the hsc compilation for the second file.
116 data IntermediateFileType
122 :: GhcMode -- when to stop
123 -> String -- "stop after" flag (for error messages)
124 -> Bool -- True => output is persistent
125 -> HscLang -- preferred output language for hsc
126 -> (FilePath, String) -- original filename & its suffix
127 -> IO [ -- list of phases to run for this file
129 IntermediateFileType, -- keep the output from this phase?
130 String) -- output file suffix
133 genPipeline todo stop_flag persistent_output lang (filename,suffix)
135 split <- readIORef v_Split_object_files
136 mangle <- readIORef v_Do_asm_mangling
137 keep_hc <- readIORef v_Keep_hc_files
138 keep_il <- readIORef v_Keep_il_files
139 keep_raw_s <- readIORef v_Keep_raw_s_files
140 keep_s <- readIORef v_Keep_s_files
141 osuf <- readIORef v_Object_suf
142 hcsuf <- readIORef v_HC_suf
145 ----------- ----- ---- --- -- -- - - -
146 start = startPhase suffix
148 -- special case for mkdependHS: .hspp files go through MkDependHS
149 start_phase | todo == DoMkDependHS && start == Hsc = MkDependHS
152 haskellish = haskellish_suffix suffix
153 cish = cish_suffix suffix
155 -- for a .hc file we need to force lang to HscC
156 real_lang | start_phase == HCc || start_phase == Mangle = HscC
160 ----------- ----- ---- --- -- -- - - -
162 | todo == DoMkDependHS = [ Unlit, Cpp, MkDependHS ]
166 HscC | split && mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle,
167 SplitMangle, SplitAs ]
168 | mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle, As ]
170 | otherwise -> [ Unlit, Cpp, Hsc, HCc, As ]
172 HscAsm | split -> [ Unlit, Cpp, Hsc, SplitMangle, SplitAs ]
173 | otherwise -> [ Unlit, Cpp, Hsc, As ]
175 HscJava | split -> not_valid
176 | otherwise -> error "not implemented: compiling via Java"
178 HscILX | split -> not_valid
179 | otherwise -> [ Unlit, Cpp, Hsc, Ilx2Il, Ilasm ]
181 HscNothing -> [ Unlit, Cpp, Hsc ]
185 | otherwise = [ ] -- just pass this file through to the linker
187 -- ToDo: this is somewhat cryptic
188 not_valid = throwDyn (UsageError ("invalid option combination"))
190 stop_phase = case todo of
191 StopBefore As | split -> SplitAs
193 | real_lang == HscILX -> Ilasm
195 StopBefore phase -> phase
198 ----------- ----- ---- --- -- -- - - -
200 -- this shouldn't happen.
201 if start_phase /= Ln && start_phase `notElem` pipeline
202 then throwDyn (CmdLineError ("can't find starting phase for "
206 -- if we can't find the phase we're supposed to stop before,
207 -- something has gone wrong. This test carefully avoids the
208 -- case where we aren't supposed to do any compilation, because the file
209 -- is already in linkable form (for example).
210 if start_phase `elem` pipeline &&
211 (stop_phase /= Ln && stop_phase `notElem` pipeline)
212 then throwDyn (UsageError
213 ("flag " ++ stop_flag
214 ++ " is incompatible with source file `" ++ filename ++ "'"))
218 -- .o and .hc suffixes can be overriden by command-line options:
219 myPhaseInputExt Ln | Just s <- osuf = s
220 myPhaseInputExt HCc | Just s <- hcsuf = s
221 myPhaseInputExt other = phaseInputExt other
224 :: [Phase] -- raw pipeline
225 -> Phase -- phase to stop before
226 -> [(Phase, IntermediateFileType, String{-file extension-})]
227 annotatePipeline [] _ = []
228 annotatePipeline (Ln:_) _ = []
229 annotatePipeline (phase:next_phase:ps) stop =
230 (phase, keep_this_output, myPhaseInputExt next_phase)
231 : annotatePipeline (next_phase:ps) stop
235 = if persistent_output then Persistent else Temporary
239 Mangle | keep_raw_s -> Persistent
240 As | keep_s -> Persistent
241 HCc | keep_hc -> Persistent
243 Ilasm | keep_il -> Persistent
247 -- add information about output files to the pipeline
248 -- the suffix on an output file is determined by the next phase
249 -- in the pipeline, so we add linking to the end of the pipeline
250 -- to force the output from the final phase to be a .o file.
252 annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
254 phase_ne p (p1,_,_) = (p1 /= p)
255 ----------- ----- ---- --- -- -- - - -
258 takeWhile (phase_ne stop_phase ) $
259 dropWhile (phase_ne start_phase) $
265 :: [ (Phase, IntermediateFileType, String) ] -- phases to run
266 -> (String,String) -- input file
267 -> Bool -- doing linking afterward?
268 -> Bool -- take into account -o when generating output?
269 -> IO (String, String) -- return final filename
271 runPipeline pipeline (input_fn,suffix) do_linking use_ofile
272 = pipeLoop pipeline (input_fn,suffix) do_linking use_ofile basename suffix
273 where (basename, _) = splitFilename input_fn
275 pipeLoop [] input_fn _ _ _ _ = return input_fn
276 pipeLoop (all_phases@((phase, keep, o_suffix):phases))
277 (input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
280 output_fn <- outputFileName (null phases) keep o_suffix
282 mbCarryOn <- run_phase phase orig_basename orig_suffix input_fn output_fn
283 -- sometimes we bail out early, eg. when the compiler's recompilation
284 -- checker has determined that recompilation isn't necessary.
287 let (_,keep,final_suffix) = last all_phases
288 ofile <- outputFileName True keep final_suffix
289 return (ofile, final_suffix)
293 Notice that in order to keep the invariant that we can
294 determine a compilation pipeline's 'start phase' just
295 by looking at the input filename, the input filename
296 to the next stage/phase is associated here with the suffix
297 of the output file, *even* if it does not have that
300 Why is this important? Because we may run a compilation
301 pipeline in stages (cf. Main.main.compileFile's two stages),
302 so when generating the next stage we need to be precise
303 about what kind of file (=> suffix) is given as input.
305 [Not having to generate a pipeline in stages seems like
306 the right way to go, but I've punted on this for now --sof]
309 pipeLoop phases (fn, o_suffix) do_linking use_ofile
310 orig_basename orig_suffix
312 outputFileName last_phase keep suffix
313 = do o_file <- readIORef v_Output_file
314 if last_phase && not do_linking && use_ofile && isJust o_file
317 Nothing -> error "outputFileName"
318 else if keep == Persistent
319 then odir_ify (orig_basename ++ '.':suffix)
320 else newTempName suffix
323 -> String -- basename of original input source
324 -> String -- its extension
325 -> FilePath -- name of file which contains the input to this phase.
326 -> FilePath -- where to stick the result.
327 -> IO (Maybe FilePath)
328 -- Nothing => stop the compilation pipeline
329 -- Just fn => the result of this phase can be found in 'fn'
330 -- (this can either be 'input_fn' or 'output_fn').
331 -------------------------------------------------------------------------------
334 run_phase Unlit _basename _suff input_fn output_fn
335 = do unlit_flags <- getOpts opt_L
336 -- The -h option passes the file name for unlit to put in a #line directive
337 SysTools.runUnlit (map SysTools.Option unlit_flags ++
338 [ SysTools.Option "-h"
339 , SysTools.Option input_fn
340 , SysTools.FileOption "" input_fn
341 , SysTools.FileOption "" output_fn
343 return (Just output_fn)
345 -------------------------------------------------------------------------------
348 run_phase Cpp basename suff input_fn output_fn
349 = do src_opts <- getOptionsFromSource input_fn
350 unhandled_flags <- processArgs dynamic_flags src_opts []
351 checkProcessArgsResult unhandled_flags basename suff
353 do_cpp <- dynFlag cppFlag
355 -- no need to preprocess CPP, just pass input file along
356 -- to the next phase of the pipeline.
357 return (Just input_fn)
359 hscpp_opts <- getOpts opt_P
360 hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
362 cmdline_include_paths <- readIORef v_Include_paths
363 pkg_include_dirs <- getPackageIncludePath
364 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
365 (cmdline_include_paths ++ pkg_include_dirs)
368 (md_c_flags, _) <- machdepCCOpts
370 SysTools.runCpp ([SysTools.Option verb]
371 ++ map SysTools.Option include_paths
372 ++ map SysTools.Option hs_src_cpp_opts
373 ++ map SysTools.Option hscpp_opts
374 ++ map SysTools.Option md_c_flags
375 ++ [ SysTools.Option "-x"
376 , SysTools.Option "c"
377 , SysTools.FileOption "" input_fn
378 , SysTools.Option "-o"
379 , SysTools.FileOption "" output_fn
381 return (Just output_fn)
383 -----------------------------------------------------------------------------
386 run_phase MkDependHS basename suff input_fn output_fn = do
387 src <- readFile input_fn
388 let (import_sources, import_normals, _) = getImports src
390 let orig_fn = basename ++ '.':suff
391 deps_sources <- mapM (findDependency True orig_fn) import_sources
392 deps_normals <- mapM (findDependency False orig_fn) import_normals
393 let deps = deps_sources ++ deps_normals
395 osuf_opt <- readIORef v_Object_suf
396 let osuf = case osuf_opt of
397 Nothing -> phaseInputExt Ln
400 extra_suffixes <- readIORef v_Dep_suffixes
401 let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
402 ofiles = map (\suf -> basename ++ '.':suf) suffixes
404 objs <- mapM odir_ify ofiles
406 -- Handle for file that accumulates dependencies
407 hdl <- readIORef v_Dep_tmp_hdl
409 -- std dependency of the object(s) on the source file
410 hPutStrLn hdl (unwords objs ++ " : " ++ basename ++ '.':suff)
412 let genDep (dep, False {- not an hi file -}) =
413 hPutStrLn hdl (unwords objs ++ " : " ++ dep)
414 genDep (dep, True {- is an hi file -}) = do
415 hisuf <- readIORef v_Hi_suf
416 let dep_base = remove_suffix '.' dep
417 deps = (dep_base ++ hisuf)
418 : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
419 -- length objs should be == length deps
420 sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)
422 mapM genDep [ d | Just d <- deps ]
424 return (Just output_fn)
426 -- add the lines to dep_makefile:
430 -- if the dependency is on something other than a .hi file:
431 -- this.o this.p_o ... : dep
433 -- if the import is {-# SOURCE #-}
434 -- this.o this.p_o ... : dep.hi-boot[-$vers]
437 -- this.o ... : dep.hi
438 -- this.p_o ... : dep.p_hi
441 -- (where .o is $osuf, and the other suffixes come from
442 -- the cmdline -s options).
444 -----------------------------------------------------------------------------
447 -- Compilation of a single module, in "legacy" mode (_not_ under
448 -- the direction of the compilation manager).
449 run_phase Hsc basename suff input_fn output_fn
452 -- we add the current directory (i.e. the directory in which
453 -- the .hs files resides) to the import path, since this is
454 -- what gcc does, and it's probably what you want.
455 let current_dir = getdir basename
457 paths <- readIORef v_Include_paths
458 writeIORef v_Include_paths (current_dir : paths)
460 -- figure out which header files to #include in a generated .hc file
461 c_includes <- getPackageCIncludes
462 cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
464 let cc_injects = unlines (map mk_include
465 (c_includes ++ reverse cmdline_includes))
468 '"':_{-"-} -> "#include "++h_file
469 '<':_ -> "#include "++h_file
470 _ -> "#include \""++h_file++"\""
472 writeIORef v_HCHeader cc_injects
474 -- gather the imports and module name
475 (srcimps,imps,mod_name) <- getImportsFromFile input_fn
477 -- build a ModuleLocation to pass to hscMain.
479 <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)
481 -- take -ohi into account if present
482 ohi <- readIORef v_Output_hi
483 let location | Just fn <- ohi = location'{ ml_hi_file = fn }
484 | otherwise = location'
486 -- figure out if the source has changed, for recompilation avoidance.
487 -- only do this if we're eventually going to generate a .o file.
488 -- (ToDo: do when generating .hc files too?)
490 -- Setting source_unchanged to True means that M.o seems
491 -- to be up to date wrt M.hs; so no need to recompile unless imports have
492 -- changed (which the compiler itself figures out).
493 -- Setting source_unchanged to False tells the compiler that M.o is out of
494 -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
495 do_recomp <- readIORef v_Recomp
496 todo <- readIORef v_GhcMode
497 expl_o_file <- readIORef v_Output_file
500 Nothing -> unJust "source_unchanged" (ml_obj_file location)
503 if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
505 else do t1 <- getModificationTime (basename ++ '.':suff)
506 o_file_exists <- doesFileExist o_file
508 then return False -- Need to recompile
509 else do t2 <- getModificationTime o_file
515 dyn_flags <- getDynFlags
517 let dyn_flags' = dyn_flags { hscOutName = output_fn,
518 hscStubCOutName = basename ++ "_stub.c",
519 hscStubHOutName = basename ++ "_stub.h",
520 extCoreName = basename ++ ".hcr" }
523 pcs <- initPersistentCompilerState
524 result <- hscMain OneShot
526 location{ ml_hspp_file=Just input_fn }
530 emptyModuleEnv -- HomeSymbolTable
531 emptyModuleEnv -- HomeIfaceTable
536 HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
538 HscNoRecomp pcs details iface -> do { SysTools.touch "Touching object file" o_file
541 HscRecomp pcs details iface stub_h_exists stub_c_exists
542 _maybe_interpreted_code -> do
545 maybe_stub_o <- compileStub dyn_flags' stub_c_exists
548 Just stub_o -> add v_Ld_inputs stub_o
549 case hscLang dyn_flags of
550 HscNothing -> return Nothing
551 _ -> return (Just output_fn)
554 -----------------------------------------------------------------------------
557 -- we don't support preprocessing .c files (with -E) now. Doing so introduces
558 -- way too many hacks, and I can't say I've ever used it anyway.
560 run_phase cc_phase basename suff input_fn output_fn
561 | cc_phase == Cc || cc_phase == HCc
562 = do cc_opts <- getOpts opt_c
563 cmdline_include_paths <- readIORef v_Include_paths
565 let hcc = cc_phase == HCc
567 -- add package include paths even if we're just compiling
568 -- .c files; this is the Value Add(TM) that using
569 -- ghc instead of gcc gives you :)
570 pkg_include_dirs <- getPackageIncludePath
571 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
572 (cmdline_include_paths ++ pkg_include_dirs)
574 mangle <- readIORef v_Do_asm_mangling
575 (md_c_flags, md_regd_c_flags) <- machdepCCOpts
579 o2 <- readIORef v_minus_o2_for_C
580 let opt_flag | o2 = "-O2"
583 pkg_extra_cc_opts <- getPackageExtraCcOpts
585 split_objs <- readIORef v_Split_object_files
586 let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
589 excessPrecision <- readIORef v_Excess_precision
590 SysTools.runCc ([ SysTools.Option "-x", SysTools.Option "c"
591 , SysTools.FileOption "" input_fn
592 , SysTools.Option "-o"
593 , SysTools.FileOption "" output_fn
595 ++ map SysTools.Option (
597 ++ (if cc_phase == HCc && mangle
600 ++ [ verb, "-S", "-Wimplicit", opt_flag ]
601 ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
604 ++ (if excessPrecision then [] else [ "-ffloat-store" ])
608 return (Just output_fn)
610 -- ToDo: postprocess the output from gcc
612 -----------------------------------------------------------------------------
615 run_phase Mangle _basename _suff input_fn output_fn
616 = do mangler_opts <- getOpts opt_m
617 machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
618 then do n_regs <- dynFlag stolen_x86_regs
619 return [ show n_regs ]
622 SysTools.runMangle (map SysTools.Option mangler_opts
623 ++ [ SysTools.FileOption "" input_fn
624 , SysTools.FileOption "" output_fn
626 ++ map SysTools.Option machdep_opts)
627 return (Just output_fn)
629 -----------------------------------------------------------------------------
632 run_phase SplitMangle _basename _suff input_fn output_fn
633 = do -- tmp_pfx is the prefix used for the split .s files
634 -- We also use it as the file to contain the no. of split .s files (sigh)
635 split_s_prefix <- SysTools.newTempName "split"
636 let n_files_fn = split_s_prefix
638 SysTools.runSplit [ SysTools.FileOption "" input_fn
639 , SysTools.FileOption "" split_s_prefix
640 , SysTools.FileOption "" n_files_fn
643 -- Save the number of split files for future references
644 s <- readFile n_files_fn
645 let n_files = read s :: Int
646 writeIORef v_Split_info (split_s_prefix, n_files)
648 -- Remember to delete all these files
649 addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
652 return (Just output_fn)
654 -----------------------------------------------------------------------------
657 run_phase As _basename _suff input_fn output_fn
658 = do as_opts <- getOpts opt_a
659 cmdline_include_paths <- readIORef v_Include_paths
661 SysTools.runAs (map SysTools.Option as_opts
662 ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
663 ++ [ SysTools.Option "-c"
664 , SysTools.FileOption "" input_fn
665 , SysTools.Option "-o"
666 , SysTools.FileOption "" output_fn
668 return (Just output_fn)
670 run_phase SplitAs basename _suff _input_fn output_fn
671 = do as_opts <- getOpts opt_a
673 (split_s_prefix, n) <- readIORef v_Split_info
675 odir <- readIORef v_Output_dir
676 let real_odir = case odir of
681 = do let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
682 let output_o = newdir real_odir
683 (basename ++ "__" ++ show n ++ ".o")
684 real_o <- osuf_ify output_o
685 SysTools.runAs (map SysTools.Option as_opts ++
686 [ SysTools.Option "-c"
687 , SysTools.Option "-o"
688 , SysTools.FileOption "" real_o
689 , SysTools.FileOption "" input_s
692 mapM_ assemble_file [1..n]
693 return (Just output_fn)
696 -----------------------------------------------------------------------------
698 -- Run ilx2il over the ILX output, getting an IL file
700 run_phase Ilx2Il _basename _suff input_fn output_fn
701 = do ilx2il_opts <- getOpts opt_I
702 SysTools.runIlx2il (map SysTools.Option ilx2il_opts
703 ++ [ SysTools.Option "--no-add-suffix-to-assembly",
704 SysTools.Option "mscorlib",
705 SysTools.Option "-o",
706 SysTools.FileOption "" output_fn,
707 SysTools.FileOption "" input_fn ])
708 return (Just output_fn)
710 -----------------------------------------------------------------------------
712 -- Run ilasm over the IL, getting a DLL
714 run_phase Ilasm _basename _suff input_fn output_fn
715 = do ilasm_opts <- getOpts opt_i
716 SysTools.runIlasm (map SysTools.Option ilasm_opts
717 ++ [ SysTools.Option "/QUIET",
718 SysTools.Option "/DLL",
719 SysTools.FileOption "/OUT=" output_fn,
720 SysTools.FileOption "" input_fn ])
721 return (Just output_fn)
725 -----------------------------------------------------------------------------
726 -- MoveBinary sort-of-phase
727 -- After having produced a binary, move it somewhere else and generate a
728 -- wrapper script calling the binary. Currently, we need this only in
729 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
730 -- central directory.
731 -- This is called from doLink below, after linking. I haven't made it
732 -- a separate phase to minimise interfering with other modules, and
733 -- we don't need the generality of a phase (MoveBinary is always
734 -- done after linking and makes only sense in a parallel setup) -- HWL
736 run_phase_MoveBinary input_fn
739 pvm_root <- getEnv "PVM_ROOT"
740 pvm_arch <- getEnv "PVM_ARCH"
742 pvm_executable_base = "=" ++ input_fn
743 pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
744 -- nuke old binary; maybe use configur'ed names for cp and rm?
745 system ("rm -f " ++ pvm_executable)
746 -- move the newly created binary into PVM land
747 system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
748 -- generate a wrapper script for running a parallel prg under PVM
749 writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
752 -- generates a Perl skript starting a parallel prg under PVM
753 mk_pvm_wrapper_script :: String -> String -> String -> String
754 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
756 "eval 'exec perl -S $0 ${1+\"$@\"}'",
757 " if $running_under_some_shell;",
758 "# =!=!=!=!=!=!=!=!=!=!=!",
759 "# This script is automatically generated: DO NOT EDIT!!!",
760 "# Generated by Glasgow Haskell Compiler",
761 "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
763 "$pvm_executable = '" ++ pvm_executable ++ "';",
764 "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
765 "$SysMan = '" ++ sysMan ++ "';",
767 {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
768 "# first, some magical shortcuts to run "commands" on the binary",
769 "# (which is hidden)",
770 "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
771 " local($cmd) = $1;",
772 " system("$cmd $pvm_executable");",
773 " exit(0); # all done",
776 "# Now, run the real binary; process the args first",
777 "$ENV{'PE'} = $pvm_executable_base;", -- ++ pvm_executable_base,
779 "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
780 "@nonPVM_args = ();",
783 "args: while ($a = shift(@ARGV)) {",
784 " if ( $a eq '+RTS' ) {",
785 " $in_RTS_args = 1;",
786 " } elsif ( $a eq '-RTS' ) {",
787 " $in_RTS_args = 0;",
789 " if ( $a eq '-d' && $in_RTS_args ) {",
791 " } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
792 " $nprocessors = $1;",
793 " } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
794 " $nprocessors = $1;",
796 " push(@nonPVM_args, $a);",
800 "local($return_val) = 0;",
801 "# Start the parallel execution by calling SysMan",
802 "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
804 "# ToDo: fix race condition moving files and flushing them!!",
805 "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
809 -----------------------------------------------------------------------------
810 -- Complain about non-dynamic flags in OPTIONS pragmas
812 checkProcessArgsResult flags basename suff
813 = do when (not (null flags)) (throwDyn (ProgramError (
814 basename ++ "." ++ suff
815 ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t"
816 ++ unwords flags)) (ExitFailure 1))
818 -----------------------------------------------------------------------------
821 doLink :: [String] -> IO ()
824 static <- readIORef v_Static
825 no_hs_main <- readIORef v_NoHsMain
827 o_file <- readIORef v_Output_file
828 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
830 pkg_lib_paths <- getPackageLibraryPath
831 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
833 lib_paths <- readIORef v_Library_paths
834 let lib_path_opts = map ("-L"++) lib_paths
836 pkg_libs <- getPackageLibraries
837 let imp = if static then "" else "_imp"
838 pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
840 libs <- readIORef v_Cmdline_libraries
841 let lib_opts = map ("-l"++) (reverse libs)
842 -- reverse because they're added in reverse order from the cmd line
844 pkg_extra_ld_opts <- getPackageExtraLdOpts
846 -- probably _stub.o files
847 extra_ld_inputs <- readIORef v_Ld_inputs
849 -- opts from -optl-<blah>
850 extra_ld_opts <- getStaticOpts v_Opt_l
852 rts_pkg <- getPackageDetails ["rts"]
853 std_pkg <- getPackageDetails ["std"]
854 let extra_os = if static || no_hs_main
856 else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
857 head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
859 (md_c_flags, _) <- machdepCCOpts
860 SysTools.runLink ( [ SysTools.Option verb
861 , SysTools.Option "-o"
862 , SysTools.FileOption "" output_fn
864 ++ map SysTools.Option (
875 ++ if static && not no_hs_main then
876 [ "-u", prefixUnderscore "PrelMain_mainIO_closure",
877 "-u", prefixUnderscore "__stginit_PrelMain"]
880 -- parallel only: move binary to another dir -- HWL
881 ways_ <- readIORef v_Ways
882 when (WayPar `elem` ways_)
883 (do success <- run_phase_MoveBinary output_fn
884 if success then return ()
885 else throwDyn (InstallationError ("cannot move binary to PVM dir")))
887 -----------------------------------------------------------------------------
888 -- Making a DLL (only for Win32)
890 doMkDLL :: [String] -> IO ()
893 static <- readIORef v_Static
894 no_hs_main <- readIORef v_NoHsMain
896 o_file <- readIORef v_Output_file
897 let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
899 pkg_lib_paths <- getPackageLibraryPath
900 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
902 lib_paths <- readIORef v_Library_paths
903 let lib_path_opts = map ("-L"++) lib_paths
905 pkg_libs <- getPackageLibraries
906 let imp = if static then "" else "_imp"
907 pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
909 libs <- readIORef v_Cmdline_libraries
910 let lib_opts = map ("-l"++) (reverse libs)
911 -- reverse because they're added in reverse order from the cmd line
913 pkg_extra_ld_opts <- getPackageExtraLdOpts
915 -- probably _stub.o files
916 extra_ld_inputs <- readIORef v_Ld_inputs
918 -- opts from -optdll-<blah>
919 extra_ld_opts <- getStaticOpts v_Opt_dll
921 rts_pkg <- getPackageDetails ["rts"]
922 std_pkg <- getPackageDetails ["std"]
924 let extra_os = if static || no_hs_main
926 else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
927 head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
929 (md_c_flags, _) <- machdepCCOpts
931 ([ SysTools.Option verb
932 , SysTools.Option "-o"
933 , SysTools.FileOption "" output_fn
935 ++ map SysTools.Option (
939 ++ [ "--target=i386-mingw32" ]
946 ++ (case findPS (packString (concat extra_ld_opts)) (packString "--def") of
947 Nothing -> [ "--export-all" ]
952 -----------------------------------------------------------------------------
953 -- Just preprocess a file, put the result in a temp. file (used by the
954 -- compilation manager during the summary phase).
956 preprocess :: FilePath -> IO FilePath
957 preprocess filename =
958 ASSERT(haskellish_src_file filename)
959 do restoreDynFlags -- Restore to state of last save
960 pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False
961 defaultHscLang (filename, getFileSuffix filename)
962 (fn,_) <- runPipeline pipeline (filename,getFileSuffix filename)
963 False{-no linking-} False{-no -o flag-}
966 -----------------------------------------------------------------------------
967 -- Compile a single module, under the control of the compilation manager.
969 -- This is the interface between the compilation manager and the
970 -- compiler proper (hsc), where we deal with tedious details like
971 -- reading the OPTIONS pragma from the source file, and passing the
972 -- output of hsc through the C compiler.
974 -- The driver sits between 'compile' and 'hscMain', translating calls
975 -- to the former into calls to the latter, and results from the latter
976 -- into results from the former. It does things like preprocessing
977 -- the .hs file if necessary, and compiling up the .stub_c files to
978 -- generate Linkables.
980 -- NB. No old interface can also mean that the source has changed.
982 compile :: GhciMode -- distinguish batch from interactive
983 -> ModSummary -- summary, including source
984 -> Bool -- True <=> source unchanged
985 -> Bool -- True <=> have object
986 -> Maybe ModIface -- old interface, if available
987 -> HomeSymbolTable -- for home module ModDetails
988 -> HomeIfaceTable -- for home module Ifaces
989 -> PersistentCompilerState -- persistent compiler state
993 = CompOK PersistentCompilerState -- updated PCS
994 ModDetails -- new details (HST additions)
995 ModIface -- new iface (HIT additions)
997 -- new code; Nothing => compilation was not reqd
998 -- (old code is still valid)
1000 | CompErrs PersistentCompilerState -- updated PCS
1003 compile ghci_mode summary source_unchanged have_object
1004 old_iface hst hit pcs = do
1005 dyn_flags <- restoreDynFlags -- Restore to the state of the last save
1009 (showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
1011 let verb = verbosity dyn_flags
1012 let location = ms_location summary
1013 let input_fn = unJust "compile:hs" (ml_hs_file location)
1014 let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
1016 when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
1018 opts <- getOptionsFromSource input_fnpp
1019 processArgs dynamic_flags opts []
1020 dyn_flags <- getDynFlags
1022 let hsc_lang = hscLang dyn_flags
1023 (basename, _) = splitFilename input_fn
1025 keep_hc <- readIORef v_Keep_hc_files
1026 keep_il <- readIORef v_Keep_il_files
1027 keep_s <- readIORef v_Keep_s_files
1031 HscAsm | keep_s -> return (basename ++ '.':phaseInputExt As)
1032 | otherwise -> newTempName (phaseInputExt As)
1033 HscC | keep_hc -> return (basename ++ '.':phaseInputExt HCc)
1034 | otherwise -> newTempName (phaseInputExt HCc)
1035 HscJava -> newTempName "java" -- ToDo
1037 HscILX | keep_il -> return (basename ++ '.':phaseInputExt Ilasm)
1038 | otherwise -> newTempName (phaseInputExt Ilx2Il)
1040 HscInterpreted -> return (error "no output file")
1041 HscNothing -> return (error "no output file")
1043 let dyn_flags' = dyn_flags { hscOutName = output_fn,
1044 hscStubCOutName = basename ++ "_stub.c",
1045 hscStubHOutName = basename ++ "_stub.h",
1046 extCoreName = basename ++ ".hcr" }
1048 -- figure out which header files to #include in a generated .hc file
1049 c_includes <- getPackageCIncludes
1050 cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
1052 let cc_injects = unlines (map mk_include
1053 (c_includes ++ reverse cmdline_includes))
1056 '"':_{-"-} -> "#include "++h_file
1057 '<':_ -> "#include "++h_file
1058 _ -> "#include \""++h_file++"\""
1060 writeIORef v_HCHeader cc_injects
1062 -- -no-recomp should also work with --make
1063 do_recomp <- readIORef v_Recomp
1064 let source_unchanged' = source_unchanged && do_recomp
1067 hsc_result <- hscMain ghci_mode dyn_flags'
1068 (ms_mod summary) location
1069 source_unchanged' have_object old_iface hst hit pcs
1072 HscFail pcs -> return (CompErrs pcs)
1074 HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
1076 HscRecomp pcs details iface
1077 stub_h_exists stub_c_exists maybe_interpreted_code -> do
1080 maybe_stub_o <- compileStub dyn_flags' stub_c_exists
1081 let stub_unlinked = case maybe_stub_o of
1083 Just stub_o -> [ DotO stub_o ]
1085 (hs_unlinked, unlinked_time) <-
1088 -- in interpreted mode, just return the compiled code
1089 -- as our "unlinked" object.
1091 case maybe_interpreted_code of
1093 Just (bcos,itbl_env) -> do tm <- getClockTime
1094 return ([BCOs bcos itbl_env], tm)
1096 Nothing -> panic "compile: no interpreted code"
1098 -- we're in batch mode: finish the compilation pipeline.
1099 _other -> do pipe <- genPipeline (StopBefore Ln) "" True
1100 hsc_lang (output_fn, getFileSuffix output_fn)
1101 -- runPipeline takes input_fn so it can split off
1102 -- the base name and use it as the base of
1103 -- the output object file.
1104 let (basename, suffix) = splitFilename input_fn
1106 pipeLoop pipe (output_fn, getFileSuffix output_fn)
1109 o_time <- getModificationTime o_file
1110 return ([DotO o_file], o_time)
1112 let linkable = LM unlinked_time (moduleName (ms_mod summary))
1113 (hs_unlinked ++ stub_unlinked)
1115 return (CompOK pcs details iface (Just linkable))
1118 -----------------------------------------------------------------------------
1119 -- stub .h and .c files (for foreign export support)
1121 compileStub dflags stub_c_exists
1122 | not stub_c_exists = return Nothing
1123 | stub_c_exists = do
1124 -- compile the _stub.c file w/ gcc
1125 let stub_c = hscStubCOutName dflags
1126 pipeline <- genPipeline (StopBefore Ln) "" True defaultHscLang (stub_c,"c")
1127 (stub_o,_) <- runPipeline pipeline (stub_c,"c") False{-no linking-}
1128 False{-no -o option-}
1129 return (Just stub_o)