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 genPipeline, runPipeline, pipeLoop,
16 -- interfaces for the compilation manager (interpreted/batch-mode)
17 preprocess, compile, CompResult(..),
19 -- batch-mode linking interface
25 #include "HsVersions.h"
35 import SysTools ( newTempName, addFilesToClean, getSysMan, copy )
36 import qualified SysTools
47 import Maybes ( expectJust )
49 import ParserCoreUtils ( getCoreModuleName )
52 import DATA_IOREF ( readIORef, writeIORef )
55 import Time ( getClockTime )
63 -----------------------------------------------------------------------------
66 -- Herein is all the magic about which phases to run in which order, whether
67 -- the intermediate files should be in TMPDIR or in the current directory,
68 -- what the suffix of the intermediate files should be, etc.
70 -- The following compilation pipeline algorithm is fairly hacky. A
71 -- better way to do this would be to express the whole compilation as a
72 -- data flow DAG, where the nodes are the intermediate files and the
73 -- edges are the compilation phases. This framework would also work
74 -- nicely if a haskell dependency generator was included in the
77 -- It would also deal much more cleanly with compilation phases that
78 -- generate multiple intermediates, (eg. hsc generates .hc, .hi, and
79 -- possibly stub files), where some of the output files need to be
80 -- processed further (eg. the stub files need to be compiled by the C
83 -- A cool thing to do would then be to execute the data flow graph
84 -- concurrently, automatically taking advantage of extra processors on
85 -- the host machine. For example, when compiling two Haskell files
86 -- where one depends on the other, the data flow graph would determine
87 -- that the C compiler from the first compilation can be overlapped
88 -- with the hsc compilation for the second file.
90 data IntermediateFileType
96 :: GhcMode -- when to stop
97 -> String -- "stop after" flag (for error messages)
98 -> Bool -- True => output is persistent
99 -> HscLang -- preferred output language for hsc
100 -> (FilePath, String) -- original filename & its suffix
101 -> IO [ -- list of phases to run for this file
103 IntermediateFileType, -- keep the output from this phase?
104 String) -- output file suffix
107 genPipeline todo stop_flag persistent_output lang (filename,suffix)
109 split <- readIORef v_Split_object_files
110 mangle <- readIORef v_Do_asm_mangling
111 keep_hc <- readIORef v_Keep_hc_files
113 keep_il <- readIORef v_Keep_il_files
114 keep_ilx <- readIORef v_Keep_ilx_files
116 keep_raw_s <- readIORef v_Keep_raw_s_files
117 keep_s <- readIORef v_Keep_s_files
118 osuf <- readIORef v_Object_suf
119 hcsuf <- readIORef v_HC_suf
122 ----------- ----- ---- --- -- -- - - -
123 start = startPhase suffix
125 -- special case for mkdependHS: .hspp files go through MkDependHS
126 start_phase | todo == DoMkDependHS && start == Hsc = MkDependHS
129 haskellish = haskellish_suffix suffix
130 cish = cish_suffix suffix
132 -- for a .hc file we need to force lang to HscC
133 real_lang | start_phase == HCc || start_phase == Mangle = HscC
137 ----------- ----- ---- --- -- -- - - -
138 pipeline = preprocess ++ compile
141 | haskellish = [ Unlit, Cpp, HsPp ]
145 | todo == DoMkDependHS = [ MkDependHS ]
151 HscC | split && mangle -> [ Hsc, HCc, Mangle, SplitMangle, SplitAs ]
152 | mangle -> [ Hsc, HCc, Mangle, As ]
154 | otherwise -> [ Hsc, HCc, As ]
156 HscAsm | split -> [ Hsc, SplitMangle, SplitAs ]
157 | otherwise -> [ Hsc, As ]
159 HscJava | split -> not_valid
160 | otherwise -> error "not implemented: compiling via Java"
162 HscILX | split -> not_valid
163 | otherwise -> [ Hsc, Ilx2Il, Ilasm ]
165 HscNothing -> [ Hsc, HCc ] -- HCc is a dummy stop phase
167 | otherwise = [ ] -- just pass this file through to the linker
169 -- ToDo: this is somewhat cryptic
170 not_valid = throwDyn (UsageError ("invalid option combination"))
172 stop_phase = case todo of
173 StopBefore As | split -> SplitAs
175 | real_lang == HscILX -> Ilasm
177 StopBefore phase -> phase
181 ----------- ----- ---- --- -- -- - - -
183 -- this shouldn't happen.
184 when (start_phase /= Ln && start_phase `notElem` pipeline)
185 (throwDyn (CmdLineError ("can't find starting phase for "
187 -- if we can't find the phase we're supposed to stop before,
188 -- something has gone wrong. This test carefully avoids the
189 -- case where we aren't supposed to do any compilation, because the file
190 -- is already in linkable form (for example).
191 -- hPutStrLn stderr (show ((start_phase `elem` pipeline,stop_phase /= Ln,stop_phase `notElem` pipeline), start_phase, stop_phase, pipeline,todo))
193 when (start_phase `elem` pipeline &&
194 (stop_phase /= Ln && stop_phase `notElem` pipeline))
197 ("flag `" ++ stop_flag
198 ++ "' is incompatible with source file `"
199 ++ filename ++ "'" ++ show pipeline ++ show stop_phase)))
201 -- .o and .hc suffixes can be overriden by command-line options:
202 myPhaseInputExt Ln | Just s <- osuf = s
203 myPhaseInputExt HCc | Just s <- hcsuf = s
204 myPhaseInputExt other = phaseInputExt other
207 :: [Phase] -- raw pipeline
208 -> Phase -- phase to stop before
209 -> [(Phase, IntermediateFileType, String{-file extension-})]
210 annotatePipeline [] _ = []
211 annotatePipeline (Ln:_) _ = []
212 annotatePipeline (phase:next_phase:ps) stop =
213 (phase, keep_this_output, myPhaseInputExt next_phase)
214 : annotatePipeline (next_phase:ps) stop
218 = if persistent_output then Persistent else Temporary
222 Mangle | keep_raw_s -> Persistent
223 As | keep_s -> Persistent
224 HCc | keep_hc -> Persistent
226 Ilx2Il | keep_ilx -> Persistent
227 Ilasm | keep_il -> Persistent
231 -- add information about output files to the pipeline
232 -- the suffix on an output file is determined by the next phase
233 -- in the pipeline, so we add linking to the end of the pipeline
234 -- to force the output from the final phase to be a .o file.
236 annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
238 phase_ne p (p1,_,_) = (p1 /= p)
239 ----------- ----- ---- --- -- -- - - -
242 takeWhile (phase_ne stop_phase ) $
243 dropWhile (phase_ne start_phase) $
249 :: [ (Phase, IntermediateFileType, String) ] -- phases to run
250 -> (String,String) -- input file
251 -> Bool -- doing linking afterward?
252 -> Bool -- take into account -o when generating output?
253 -> IO (String, String) -- return final filename
255 runPipeline pipeline (input_fn,suffix) do_linking use_ofile
256 = pipeLoop pipeline (input_fn,suffix) do_linking use_ofile basename suffix
257 where (basename, _) = splitFilename input_fn
259 pipeLoop [] input_fn _ _ _ _ = return input_fn
260 pipeLoop (all_phases@((phase, keep, o_suffix):phases))
261 (input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
264 output_fn <- outputFileName (null phases) keep o_suffix
266 mbCarryOn <- run_phase phase orig_basename orig_suffix
268 -- sometimes we bail out early, eg. when the compiler's recompilation
269 -- checker has determined that recompilation isn't necessary.
272 let (_,keep,final_suffix) = last all_phases
273 ofile <- outputFileName True keep final_suffix
274 return (ofile, final_suffix)
278 Check to see whether we've reached the end of the
279 pipeline, but did so with an ineffective last stage.
280 (i.e., it returned the input_fn as the output filename).
282 If we did and the output is persistent, copy the contents
283 of input_fn into the file where the pipeline's output is
286 atEnd <- finalStage (null phases)
287 when (atEnd && fn == input_fn)
288 (copy "Saving away compilation pipeline's output"
292 Notice that in order to keep the invariant that we can
293 determine a compilation pipeline's 'start phase' just
294 by looking at the input filename, the input filename
295 to the next stage/phase is associated here with the suffix
296 of the output file, *even* if it does not have that
299 Why is this important? Because we may run a compilation
300 pipeline in stages (cf. Main.main.compileFile's two stages),
301 so when generating the next stage we need to be precise
302 about what kind of file (=> suffix) is given as input.
304 [Not having to generate a pipeline in stages seems like
305 the right way to go, but I've punted on this for now --sof]
308 pipeLoop phases (fn, o_suffix) do_linking use_ofile
309 orig_basename orig_suffix
311 finalStage lastPhase = do
312 o_file <- readIORef v_Output_file
313 return (lastPhase && not do_linking && use_ofile && isJust o_file)
315 outputFileName last_phase keep suffix
316 = do o_file <- readIORef v_Output_file
317 atEnd <- finalStage last_phase
321 Nothing -> error "outputFileName"
322 else if keep == Persistent
323 then odir_ify (orig_basename ++ '.':suffix)
324 else newTempName suffix
327 -> String -- basename of original input source
328 -> String -- its extension
329 -> FilePath -- name of file which contains the input to this phase.
330 -> FilePath -- where to stick the result.
331 -> IO (Maybe FilePath)
332 -- Nothing => stop the compilation pipeline
333 -- Just fn => the result of this phase can be found in 'fn'
334 -- (this can either be 'input_fn' or 'output_fn').
335 -------------------------------------------------------------------------------
338 run_phase Unlit _basename _suff input_fn output_fn
339 = do unlit_flags <- getOpts opt_L
340 -- The -h option passes the file name for unlit to put in a #line directive
341 SysTools.runUnlit (map SysTools.Option unlit_flags ++
342 [ SysTools.Option "-h"
343 , SysTools.Option input_fn
344 , SysTools.FileOption "" input_fn
345 , SysTools.FileOption "" output_fn
347 return (Just output_fn)
349 -------------------------------------------------------------------------------
352 run_phase Cpp basename suff input_fn output_fn
353 = do src_opts <- getOptionsFromSource input_fn
354 unhandled_flags <- processArgs dynamic_flags src_opts []
355 checkProcessArgsResult unhandled_flags basename suff
357 do_cpp <- dynFlag cppFlag
359 -- no need to preprocess CPP, just pass input file along
360 -- to the next phase of the pipeline.
361 return (Just input_fn)
363 hscpp_opts <- getOpts opt_P
364 hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
366 cmdline_include_paths <- readIORef v_Include_paths
367 pkg_include_dirs <- getPackageIncludePath
368 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
369 (cmdline_include_paths ++ pkg_include_dirs)
372 (md_c_flags, _) <- machdepCCOpts
374 SysTools.runCpp ([SysTools.Option verb]
375 ++ map SysTools.Option include_paths
376 ++ map SysTools.Option hs_src_cpp_opts
377 ++ map SysTools.Option hscpp_opts
378 ++ map SysTools.Option md_c_flags
379 ++ [ SysTools.Option "-x"
380 , SysTools.Option "c"
381 , SysTools.Option input_fn
382 -- We hackily use Option instead of FileOption here, so that the file
383 -- name is not back-slashed on Windows. cpp is capable of
384 -- dealing with / in filenames, so it works fine. Furthermore
385 -- if we put in backslashes, cpp outputs #line directives
386 -- with *double* backslashes. And that in turn means that
387 -- our error messages get double backslashes in them.
388 -- In due course we should arrange that the lexer deals
389 -- with these \\ escapes properly.
390 , SysTools.Option "-o"
391 , SysTools.FileOption "" output_fn
393 return (Just output_fn)
395 -------------------------------------------------------------------------------
398 run_phase HsPp basename suff input_fn output_fn
399 = do let orig_fn = basename ++ '.':suff
400 do_pp <- dynFlag ppFlag
402 -- no need to preprocess, just pass input file along
403 -- to the next phase of the pipeline.
404 return (Just input_fn)
406 hspp_opts <- getOpts opt_F
407 hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
408 SysTools.runPp ( [ SysTools.Option orig_fn
409 , SysTools.Option input_fn
410 , SysTools.FileOption "" output_fn
412 map SysTools.Option hs_src_pp_opts ++
413 map SysTools.Option hspp_opts
415 return (Just output_fn)
417 -----------------------------------------------------------------------------
420 run_phase MkDependHS basename suff input_fn output_fn
421 = do src <- readFile input_fn
422 let (import_sources, import_normals, _) = getImports src
423 let orig_fn = basename ++ '.':suff
424 deps_sources <- mapM (findDependency True orig_fn) import_sources
425 deps_normals <- mapM (findDependency False orig_fn) import_normals
426 let deps = deps_sources ++ deps_normals
428 osuf_opt <- readIORef v_Object_suf
429 let osuf = case osuf_opt of
430 Nothing -> phaseInputExt Ln
433 extra_suffixes <- readIORef v_Dep_suffixes
434 let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
435 ofiles = map (\suf -> basename ++ '.':suf) suffixes
437 objs <- mapM odir_ify ofiles
439 -- Handle for file that accumulates dependencies
440 hdl <- readIORef v_Dep_tmp_hdl
442 -- std dependency of the object(s) on the source file
443 hPutStrLn hdl (unwords (map escapeSpaces objs) ++ " : " ++
444 escapeSpaces (basename ++ '.':suff))
446 let genDep (dep, False {- not an hi file -}) =
447 hPutStrLn hdl (unwords (map escapeSpaces objs) ++ " : " ++
449 genDep (dep, True {- is an hi file -}) = do
450 hisuf <- readIORef v_Hi_suf
451 let dep_base = remove_suffix '.' dep
452 deps = (dep_base ++ hisuf)
453 : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
454 -- length objs should be == length deps
455 sequence_ (zipWith (\o d -> hPutStrLn hdl (escapeSpaces o ++ " : " ++ escapeSpaces d)) objs deps)
457 sequence_ (map genDep [ d | Just d <- deps ])
458 return (Just output_fn)
460 -- add the lines to dep_makefile:
464 -- if the dependency is on something other than a .hi file:
465 -- this.o this.p_o ... : dep
467 -- if the import is {-# SOURCE #-}
468 -- this.o this.p_o ... : dep.hi-boot[-$vers]
471 -- this.o ... : dep.hi
472 -- this.p_o ... : dep.p_hi
475 -- (where .o is $osuf, and the other suffixes come from
476 -- the cmdline -s options).
479 -----------------------------------------------------------------------------
482 -- Compilation of a single module, in "legacy" mode (_not_ under
483 -- the direction of the compilation manager).
484 run_phase Hsc basename suff input_fn output_fn
487 -- we add the current directory (i.e. the directory in which
488 -- the .hs files resides) to the import path, since this is
489 -- what gcc does, and it's probably what you want.
490 let current_dir = getdir basename
492 paths <- readIORef v_Include_paths
493 writeIORef v_Include_paths (current_dir : paths)
495 -- figure out which header files to #include in a generated .hc file
496 c_includes <- getPackageCIncludes
497 cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
499 let cc_injects = unlines (map mk_include
500 (c_includes ++ reverse cmdline_includes))
503 '"':_{-"-} -> "#include "++h_file
504 '<':_ -> "#include "++h_file
505 _ -> "#include \""++h_file++"\""
507 writeIORef v_HCHeader cc_injects
509 -- gather the imports and module name
510 (srcimps,imps,mod_name) <-
511 if extcoreish_suffix suff
513 -- no explicit imports in ExtCore input.
514 m <- getCoreModuleName input_fn
515 return ([], [], mkModuleName m)
517 getImportsFromFile input_fn
519 -- build a ModuleLocation to pass to hscMain.
521 <- mkHomeModuleLocn mod_name basename (basename ++ '.':suff)
523 -- take -ohi into account if present
524 ohi <- readIORef v_Output_hi
525 let location | Just fn <- ohi = location'{ ml_hi_file = fn }
526 | otherwise = location'
528 -- figure out if the source has changed, for recompilation avoidance.
529 -- only do this if we're eventually going to generate a .o file.
530 -- (ToDo: do when generating .hc files too?)
532 -- Setting source_unchanged to True means that M.o seems
533 -- to be up to date wrt M.hs; so no need to recompile unless imports have
534 -- changed (which the compiler itself figures out).
535 -- Setting source_unchanged to False tells the compiler that M.o is out of
536 -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
537 do_recomp <- readIORef v_Recomp
538 todo <- readIORef v_GhcMode
539 expl_o_file <- readIORef v_Output_file
541 let o_file -- if the -o option is given and IT IS THE OBJECT FILE FOR
542 -- THIS COMPILATION, then use that to determine if the
543 -- source is unchanged.
544 | Just x <- expl_o_file, todo == StopBefore Ln = x
545 | otherwise = expectJust "source_unchanged" (ml_obj_file location)
548 if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
550 else do t1 <- getModificationTime (basename ++ '.':suff)
551 o_file_exists <- doesFileExist o_file
553 then return False -- Need to recompile
554 else do t2 <- getModificationTime o_file
560 dyn_flags <- getDynFlags
562 let dyn_flags' = dyn_flags { hscOutName = output_fn,
563 hscStubCOutName = basename ++ "_stub.c",
564 hscStubHOutName = basename ++ "_stub.h",
565 extCoreName = basename ++ ".hcr" }
568 pcs <- initPersistentCompilerState
569 result <- hscMain OneShot
571 location{ ml_hspp_file=Just input_fn }
575 emptyModuleEnv -- HomeSymbolTable
576 emptyModuleEnv -- HomeIfaceTable
581 HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
583 HscNoRecomp pcs details iface -> do { SysTools.touch "Touching object file" o_file
586 HscRecomp pcs details iface stub_h_exists stub_c_exists
587 _maybe_interpreted_code -> do
590 maybe_stub_o <- compileStub dyn_flags' stub_c_exists
593 Just stub_o -> add v_Ld_inputs stub_o
594 case hscLang dyn_flags of
595 HscNothing -> return Nothing
596 _ -> return (Just output_fn)
599 -----------------------------------------------------------------------------
602 -- we don't support preprocessing .c files (with -E) now. Doing so introduces
603 -- way too many hacks, and I can't say I've ever used it anyway.
605 run_phase cc_phase basename suff input_fn output_fn
606 | cc_phase == Cc || cc_phase == HCc
607 = do cc_opts <- getOpts opt_c
608 cmdline_include_paths <- readIORef v_Include_paths
610 let hcc = cc_phase == HCc
612 -- add package include paths even if we're just compiling
613 -- .c files; this is the Value Add(TM) that using
614 -- ghc instead of gcc gives you :)
615 pkg_include_dirs <- getPackageIncludePath
616 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
617 (cmdline_include_paths ++ pkg_include_dirs)
619 mangle <- readIORef v_Do_asm_mangling
620 (md_c_flags, md_regd_c_flags) <- machdepCCOpts
624 o2 <- readIORef v_minus_o2_for_C
625 let opt_flag | o2 = "-O2"
628 pkg_extra_cc_opts <- getPackageExtraCcOpts
630 split_objs <- readIORef v_Split_object_files
631 let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
634 excessPrecision <- readIORef v_Excess_precision
636 -- force the C compiler to interpret this file as C when
637 -- compiling .hc files, by adding the -x c option.
639 | cc_phase == HCc = [ SysTools.Option "-x", SysTools.Option "c"]
642 SysTools.runCc (langopt ++
643 [ SysTools.FileOption "" input_fn
644 , SysTools.Option "-o"
645 , SysTools.FileOption "" output_fn
647 ++ map SysTools.Option (
649 ++ (if cc_phase == HCc && mangle
652 ++ [ verb, "-S", "-Wimplicit", opt_flag ]
653 ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
656 ++ (if excessPrecision then [] else [ "-ffloat-store" ])
660 return (Just output_fn)
662 -- ToDo: postprocess the output from gcc
664 -----------------------------------------------------------------------------
667 run_phase Mangle _basename _suff input_fn output_fn
668 = do mangler_opts <- getOpts opt_m
669 machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
670 then do n_regs <- dynFlag stolen_x86_regs
671 return [ show n_regs ]
674 SysTools.runMangle (map SysTools.Option mangler_opts
675 ++ [ SysTools.FileOption "" input_fn
676 , SysTools.FileOption "" output_fn
678 ++ map SysTools.Option machdep_opts)
679 return (Just output_fn)
681 -----------------------------------------------------------------------------
684 run_phase SplitMangle _basename _suff input_fn output_fn
685 = do -- tmp_pfx is the prefix used for the split .s files
686 -- We also use it as the file to contain the no. of split .s files (sigh)
687 split_s_prefix <- SysTools.newTempName "split"
688 let n_files_fn = split_s_prefix
690 SysTools.runSplit [ SysTools.FileOption "" input_fn
691 , SysTools.FileOption "" split_s_prefix
692 , SysTools.FileOption "" n_files_fn
695 -- Save the number of split files for future references
696 s <- readFile n_files_fn
697 let n_files = read s :: Int
698 writeIORef v_Split_info (split_s_prefix, n_files)
700 -- Remember to delete all these files
701 addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
704 return (Just output_fn)
706 -----------------------------------------------------------------------------
709 run_phase As _basename _suff input_fn output_fn
710 = do as_opts <- getOpts opt_a
711 cmdline_include_paths <- readIORef v_Include_paths
713 SysTools.runAs (map SysTools.Option as_opts
714 ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
715 ++ [ SysTools.Option "-c"
716 , SysTools.FileOption "" input_fn
717 , SysTools.Option "-o"
718 , SysTools.FileOption "" output_fn
720 return (Just output_fn)
722 run_phase SplitAs basename _suff _input_fn output_fn
723 = do as_opts <- getOpts opt_a
725 (split_s_prefix, n) <- readIORef v_Split_info
727 odir <- readIORef v_Output_dir
728 let real_odir = case odir of
729 Nothing -> basename ++ "_split"
733 = do let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
734 let output_o = newdir real_odir
735 (basename ++ "__" ++ show n ++ ".o")
736 real_o <- osuf_ify output_o
737 SysTools.runAs (map SysTools.Option as_opts ++
738 [ SysTools.Option "-c"
739 , SysTools.Option "-o"
740 , SysTools.FileOption "" real_o
741 , SysTools.FileOption "" input_s
744 mapM_ assemble_file [1..n]
745 return (Just output_fn)
748 -----------------------------------------------------------------------------
750 -- Run ilx2il over the ILX output, getting an IL file
752 run_phase Ilx2Il _basename _suff input_fn output_fn
753 = do ilx2il_opts <- getOpts opt_I
754 SysTools.runIlx2il (map SysTools.Option ilx2il_opts
755 ++ [ SysTools.Option "--no-add-suffix-to-assembly",
756 SysTools.Option "mscorlib",
757 SysTools.Option "-o",
758 SysTools.FileOption "" output_fn,
759 SysTools.FileOption "" input_fn ])
760 return (Just output_fn)
762 -----------------------------------------------------------------------------
764 -- Run ilasm over the IL, getting a DLL
766 run_phase Ilasm _basename _suff input_fn output_fn
767 = do ilasm_opts <- getOpts opt_i
768 SysTools.runIlasm (map SysTools.Option ilasm_opts
769 ++ [ SysTools.Option "/QUIET",
770 SysTools.Option "/DLL",
771 SysTools.FileOption "/OUT=" output_fn,
772 SysTools.FileOption "" input_fn ])
773 return (Just output_fn)
777 -----------------------------------------------------------------------------
778 -- MoveBinary sort-of-phase
779 -- After having produced a binary, move it somewhere else and generate a
780 -- wrapper script calling the binary. Currently, we need this only in
781 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
782 -- central directory.
783 -- This is called from doLink below, after linking. I haven't made it
784 -- a separate phase to minimise interfering with other modules, and
785 -- we don't need the generality of a phase (MoveBinary is always
786 -- done after linking and makes only sense in a parallel setup) -- HWL
788 run_phase_MoveBinary input_fn
791 pvm_root <- getEnv "PVM_ROOT"
792 pvm_arch <- getEnv "PVM_ARCH"
794 pvm_executable_base = "=" ++ input_fn
795 pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
796 -- nuke old binary; maybe use configur'ed names for cp and rm?
797 system ("rm -f " ++ pvm_executable)
798 -- move the newly created binary into PVM land
799 system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
800 -- generate a wrapper script for running a parallel prg under PVM
801 writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
804 -- generates a Perl skript starting a parallel prg under PVM
805 mk_pvm_wrapper_script :: String -> String -> String -> String
806 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
808 "eval 'exec perl -S $0 ${1+\"$@\"}'",
809 " if $running_under_some_shell;",
810 "# =!=!=!=!=!=!=!=!=!=!=!",
811 "# This script is automatically generated: DO NOT EDIT!!!",
812 "# Generated by Glasgow Haskell Compiler",
813 "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
815 "$pvm_executable = '" ++ pvm_executable ++ "';",
816 "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
817 "$SysMan = '" ++ sysMan ++ "';",
819 {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
820 "# first, some magical shortcuts to run "commands" on the binary",
821 "# (which is hidden)",
822 "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
823 " local($cmd) = $1;",
824 " system("$cmd $pvm_executable");",
825 " exit(0); # all done",
828 "# Now, run the real binary; process the args first",
829 "$ENV{'PE'} = $pvm_executable_base;", -- ++ pvm_executable_base,
831 "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
832 "@nonPVM_args = ();",
835 "args: while ($a = shift(@ARGV)) {",
836 " if ( $a eq '+RTS' ) {",
837 " $in_RTS_args = 1;",
838 " } elsif ( $a eq '-RTS' ) {",
839 " $in_RTS_args = 0;",
841 " if ( $a eq '-d' && $in_RTS_args ) {",
843 " } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
844 " $nprocessors = $1;",
845 " } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
846 " $nprocessors = $1;",
848 " push(@nonPVM_args, $a);",
852 "local($return_val) = 0;",
853 "# Start the parallel execution by calling SysMan",
854 "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
856 "# ToDo: fix race condition moving files and flushing them!!",
857 "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
861 -----------------------------------------------------------------------------
862 -- Complain about non-dynamic flags in OPTIONS pragmas
864 checkProcessArgsResult flags basename suff
865 = do when (notNull flags) (throwDyn (ProgramError (
866 basename ++ "." ++ suff
867 ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t"
868 ++ unwords flags)) (ExitFailure 1))
870 -----------------------------------------------------------------------------
873 doLink :: [String] -> IO ()
876 static <- readIORef v_Static
877 no_hs_main <- readIORef v_NoHsMain
879 o_file <- readIORef v_Output_file
880 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
882 pkg_lib_paths <- getPackageLibraryPath
883 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
885 lib_paths <- readIORef v_Library_paths
886 let lib_path_opts = map ("-L"++) lib_paths
888 pkg_libs <- getPackageLibraries
889 let imp = if static then "" else "_imp"
890 pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
892 libs <- readIORef v_Cmdline_libraries
893 let lib_opts = map ("-l"++) (reverse libs)
894 -- reverse because they're added in reverse order from the cmd line
896 #ifdef darwin_TARGET_OS
897 pkg_framework_paths <- getPackageFrameworkPath
898 let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
900 framework_paths <- readIORef v_Framework_paths
901 let framework_path_opts = map ("-F"++) framework_paths
903 pkg_frameworks <- getPackageFrameworks
904 let pkg_framework_opts = map ("-framework " ++) pkg_frameworks
906 frameworks <- readIORef v_Cmdline_frameworks
907 let framework_opts = map ("-framework "++) (reverse frameworks)
908 -- reverse because they're added in reverse order from the cmd line
911 pkg_extra_ld_opts <- getPackageExtraLdOpts
913 -- probably _stub.o files
914 extra_ld_inputs <- readIORef v_Ld_inputs
916 -- opts from -optl-<blah>
917 extra_ld_opts <- getStaticOpts v_Opt_l
919 rts_pkg <- getPackageDetails ["rts"]
920 std_pkg <- getPackageDetails ["std"]
921 let extra_os = if static || no_hs_main
923 else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
924 head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
926 (md_c_flags, _) <- machdepCCOpts
927 SysTools.runLink ( [ SysTools.Option verb
928 , SysTools.Option "-o"
929 , SysTools.FileOption "" output_fn
931 ++ map SysTools.Option (
938 #ifdef darwin_TARGET_OS
939 ++ framework_path_opts
944 #ifdef darwin_TARGET_OS
945 ++ pkg_framework_path_opts
946 ++ pkg_framework_opts
950 ++ if static && not no_hs_main then
951 [ "-u", prefixUnderscore "Main_zdmain_closure"]
954 -- parallel only: move binary to another dir -- HWL
955 ways_ <- readIORef v_Ways
956 when (WayPar `elem` ways_)
957 (do success <- run_phase_MoveBinary output_fn
958 if success then return ()
959 else throwDyn (InstallationError ("cannot move binary to PVM dir")))
961 -----------------------------------------------------------------------------
962 -- Making a DLL (only for Win32)
964 doMkDLL :: [String] -> IO ()
967 static <- readIORef v_Static
968 no_hs_main <- readIORef v_NoHsMain
970 o_file <- readIORef v_Output_file
971 let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
973 pkg_lib_paths <- getPackageLibraryPath
974 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
976 lib_paths <- readIORef v_Library_paths
977 let lib_path_opts = map ("-L"++) lib_paths
979 pkg_libs <- getPackageLibraries
980 let imp = if static then "" else "_imp"
981 pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
983 libs <- readIORef v_Cmdline_libraries
984 let lib_opts = map ("-l"++) (reverse libs)
985 -- reverse because they're added in reverse order from the cmd line
987 pkg_extra_ld_opts <- getPackageExtraLdOpts
989 -- probably _stub.o files
990 extra_ld_inputs <- readIORef v_Ld_inputs
992 -- opts from -optdll-<blah>
993 extra_ld_opts <- getStaticOpts v_Opt_dll
995 rts_pkg <- getPackageDetails ["rts"]
996 std_pkg <- getPackageDetails ["std"]
998 let extra_os = if static || no_hs_main
1000 else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
1001 head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
1003 (md_c_flags, _) <- machdepCCOpts
1005 ([ SysTools.Option verb
1006 , SysTools.Option "-o"
1007 , SysTools.FileOption "" output_fn
1009 ++ map SysTools.Option (
1013 ++ [ "--target=i386-mingw32" ]
1017 ++ pkg_lib_path_opts
1019 ++ pkg_extra_ld_opts
1020 ++ (if "--def" `elem` (concatMap words extra_ld_opts)
1022 else [ "--export-all" ])
1026 -----------------------------------------------------------------------------
1027 -- Just preprocess a file, put the result in a temp. file (used by the
1028 -- compilation manager during the summary phase).
1030 preprocess :: FilePath -> IO FilePath
1031 preprocess filename =
1032 ASSERT(haskellish_src_file filename)
1033 do restoreDynFlags -- Restore to state of last save
1034 let fInfo = (filename, getFileSuffix filename)
1035 pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False
1036 defaultHscLang fInfo
1037 (fn,_) <- runPipeline pipeline fInfo
1038 False{-no linking-} False{-no -o flag-}
1041 -----------------------------------------------------------------------------
1042 -- Compile a single module, under the control of the compilation manager.
1044 -- This is the interface between the compilation manager and the
1045 -- compiler proper (hsc), where we deal with tedious details like
1046 -- reading the OPTIONS pragma from the source file, and passing the
1047 -- output of hsc through the C compiler.
1049 -- The driver sits between 'compile' and 'hscMain', translating calls
1050 -- to the former into calls to the latter, and results from the latter
1051 -- into results from the former. It does things like preprocessing
1052 -- the .hs file if necessary, and compiling up the .stub_c files to
1053 -- generate Linkables.
1055 -- NB. No old interface can also mean that the source has changed.
1057 compile :: GhciMode -- distinguish batch from interactive
1058 -> ModSummary -- summary, including source
1059 -> Bool -- True <=> source unchanged
1060 -> Bool -- True <=> have object
1061 -> Maybe ModIface -- old interface, if available
1062 -> HomeSymbolTable -- for home module ModDetails
1063 -> HomeIfaceTable -- for home module Ifaces
1064 -> PersistentCompilerState -- persistent compiler state
1068 = CompOK PersistentCompilerState -- updated PCS
1069 ModDetails -- new details (HST additions)
1070 ModIface -- new iface (HIT additions)
1072 -- new code; Nothing => compilation was not reqd
1073 -- (old code is still valid)
1075 | CompErrs PersistentCompilerState -- updated PCS
1078 compile ghci_mode summary source_unchanged have_object
1079 old_iface hst hit pcs = do
1080 dyn_flags <- restoreDynFlags -- Restore to the state of the last save
1084 (showSDoc (text "Compiling" <+> ppr (modSummaryName summary)))
1086 let verb = verbosity dyn_flags
1087 let location = ms_location summary
1088 let input_fn = expectJust "compile:hs" (ml_hs_file location)
1089 let input_fnpp = expectJust "compile:hspp" (ml_hspp_file location)
1091 when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
1093 opts <- getOptionsFromSource input_fnpp
1094 processArgs dynamic_flags opts []
1095 dyn_flags <- getDynFlags
1097 let hsc_lang = hscLang dyn_flags
1098 (basename, _) = splitFilename input_fn
1100 keep_hc <- readIORef v_Keep_hc_files
1102 keep_il <- readIORef v_Keep_il_files
1104 keep_s <- readIORef v_Keep_s_files
1108 HscAsm | keep_s -> return (basename ++ '.':phaseInputExt As)
1109 | otherwise -> newTempName (phaseInputExt As)
1110 HscC | keep_hc -> return (basename ++ '.':phaseInputExt HCc)
1111 | otherwise -> newTempName (phaseInputExt HCc)
1112 HscJava -> newTempName "java" -- ToDo
1114 HscILX | keep_il -> return (basename ++ '.':phaseInputExt Ilasm)
1115 | otherwise -> newTempName (phaseInputExt Ilx2Il)
1117 HscInterpreted -> return (error "no output file")
1118 HscNothing -> return (error "no output file")
1120 let dyn_flags' = dyn_flags { hscOutName = output_fn,
1121 hscStubCOutName = basename ++ "_stub.c",
1122 hscStubHOutName = basename ++ "_stub.h",
1123 extCoreName = basename ++ ".hcr" }
1125 -- figure out which header files to #include in a generated .hc file
1126 c_includes <- getPackageCIncludes
1127 cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
1129 let cc_injects = unlines (map mk_include
1130 (c_includes ++ reverse cmdline_includes))
1133 '"':_{-"-} -> "#include "++h_file
1134 '<':_ -> "#include "++h_file
1135 _ -> "#include \""++h_file++"\""
1137 writeIORef v_HCHeader cc_injects
1139 -- -no-recomp should also work with --make
1140 do_recomp <- readIORef v_Recomp
1141 let source_unchanged' = source_unchanged && do_recomp
1144 hsc_result <- hscMain ghci_mode dyn_flags'
1145 (ms_mod summary) location
1146 source_unchanged' have_object old_iface hst hit pcs
1149 HscFail pcs -> return (CompErrs pcs)
1151 HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
1153 HscRecomp pcs details iface
1154 stub_h_exists stub_c_exists maybe_interpreted_code -> do
1156 maybe_stub_o <- compileStub dyn_flags' stub_c_exists
1157 let stub_unlinked = case maybe_stub_o of
1159 Just stub_o -> [ DotO stub_o ]
1161 (hs_unlinked, unlinked_time) <-
1164 -- in interpreted mode, just return the compiled code
1165 -- as our "unlinked" object.
1167 case maybe_interpreted_code of
1169 Just (bcos,itbl_env) -> do tm <- getClockTime
1170 return ([BCOs bcos itbl_env], tm)
1172 Nothing -> panic "compile: no interpreted code"
1174 -- we're in batch mode: finish the compilation pipeline.
1175 _other -> do pipe <- genPipeline (StopBefore Ln) "" True
1176 hsc_lang (output_fn, getFileSuffix output_fn)
1177 -- runPipeline takes input_fn so it can split off
1178 -- the base name and use it as the base of
1179 -- the output object file.
1180 let (basename, suffix) = splitFilename input_fn
1182 pipeLoop pipe (output_fn, getFileSuffix output_fn)
1185 o_time <- getModificationTime o_file
1186 return ([DotO o_file], o_time)
1188 let linkable = LM unlinked_time (modSummaryName summary)
1189 (hs_unlinked ++ stub_unlinked)
1191 return (CompOK pcs details iface (Just linkable))
1194 -----------------------------------------------------------------------------
1195 -- stub .h and .c files (for foreign export support)
1197 compileStub dflags stub_c_exists
1198 | not stub_c_exists = return Nothing
1199 | stub_c_exists = do
1200 -- compile the _stub.c file w/ gcc
1201 let stub_c = hscStubCOutName dflags
1202 pipeline <- genPipeline (StopBefore Ln) "" True defaultHscLang (stub_c,"c")
1203 (stub_o,_) <- runPipeline pipeline (stub_c,"c") False{-no linking-}
1204 False{-no -o option-}
1205 return (Just stub_o)