1 -----------------------------------------------------------------------------
5 -- (c) The University of Glasgow 2005
7 -----------------------------------------------------------------------------
9 module DriverPipeline (
10 -- Run a series of compilation steps in a pipeline, for a
11 -- collection of source files.
14 -- Interfaces for the batch-mode driver
17 -- Interfaces for the compilation manager (interpreted/batch-mode)
19 compile, CompResult(..),
26 #include "HsVersions.h"
31 import SysTools ( newTempName, addFilesToClean, getSysMan, copy )
32 import qualified SysTools
40 import StaticFlags ( v_Ld_inputs, opt_Static, WayName(..) )
42 import RdrName ( GlobalRdrEnv )
45 import StringBuffer ( hGetStringBuffer )
46 import BasicTypes ( SuccessFlag(..) )
47 import Maybes ( expectJust )
48 import Ctype ( is_ident )
50 import ParserCoreUtils ( getCoreModuleName )
53 import DATA_IOREF ( readIORef, writeIORef, IORef )
62 -- ---------------------------------------------------------------------------
65 -- Just preprocess a file, put the result in a temp. file (used by the
66 -- compilation manager during the summary phase).
68 -- We return the augmented DynFlags, because they contain the result
69 -- of slurping in the OPTIONS pragmas
71 preprocess :: DynFlags -> FilePath -> IO (DynFlags, FilePath)
72 preprocess dflags filename =
73 ASSERT2(isHaskellSrcFilename filename, text filename)
74 runPipeline anyHsc dflags filename Temporary Nothing{-no ModLocation-}
76 -- ---------------------------------------------------------------------------
79 -- Compile a single module, under the control of the compilation manager.
81 -- This is the interface between the compilation manager and the
82 -- compiler proper (hsc), where we deal with tedious details like
83 -- reading the OPTIONS pragma from the source file, and passing the
84 -- output of hsc through the C compiler.
86 -- NB. No old interface can also mean that the source has changed.
90 -> Maybe Linkable -- Just linkable <=> source unchanged
91 -> Maybe ModIface -- Old interface, if available
95 = CompOK ModDetails -- New details
97 (Maybe Linkable) -- a Maybe, for the same reasons as hm_linkable
102 compile hsc_env mod_summary maybe_old_linkable old_iface = do
104 let dflags0 = hsc_dflags hsc_env
105 this_mod = ms_mod mod_summary
106 src_flavour = ms_hsc_src mod_summary
109 | Just l <- maybe_old_linkable, isObjectLinkable l = True
112 showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
114 let verb = verbosity dflags0
115 let location = ms_location mod_summary
116 let input_fn = expectJust "compile:hs" (ml_hs_file location)
117 let input_fnpp = expectJust "compile:hspp" (ms_hspp_file mod_summary)
119 when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
121 -- Add in the OPTIONS from the source file
122 -- This is nasty: we've done this once already, in the compilation manager
123 -- It might be better to cache the flags in the ml_hspp_file field,say
124 opts <- getOptionsFromSource input_fnpp
125 (dflags1,unhandled_flags) <- parseDynamicFlags dflags0 opts
126 checkProcessArgsResult unhandled_flags input_fn
128 let (basename, _) = splitFilename input_fn
130 -- We add the directory in which the .hs files resides) to the import path.
131 -- This is needed when we try to compile the .hc file later, if it
132 -- imports a _stub.h file that we created here.
133 let current_dir = directoryOf basename
134 old_paths = includePaths dflags1
135 dflags = dflags1 { includePaths = current_dir : old_paths }
137 -- Figure out what lang we're generating
138 let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
139 -- ... and what the next phase should be
140 let next_phase = hscNextPhase dflags src_flavour hsc_lang
141 -- ... and what file to generate the output into
142 output_fn <- getOutputFilename dflags next_phase
143 Temporary basename next_phase (Just location)
145 let dflags' = dflags { hscTarget = hsc_lang,
146 hscOutName = output_fn,
147 hscStubCOutName = basename ++ "_stub.c",
148 hscStubHOutName = basename ++ "_stub.h",
149 extCoreName = basename ++ ".hcr" }
151 -- -no-recomp should also work with --make
152 let do_recomp = dopt Opt_RecompChecking dflags
153 source_unchanged = isJust maybe_old_linkable && do_recomp
154 hsc_env' = hsc_env { hsc_dflags = dflags' }
157 hsc_result <- hscMain hsc_env' printErrorsAndWarnings mod_summary
158 source_unchanged have_object old_iface
161 HscFail -> return CompErrs
163 HscNoRecomp details iface ->
164 ASSERT(isJust maybe_old_linkable)
165 return (CompOK details iface maybe_old_linkable)
167 HscRecomp details iface
168 stub_h_exists stub_c_exists maybe_interpreted_code
170 | isHsBoot src_flavour -- No further compilation to do
171 -> return (CompOK details iface Nothing)
173 | otherwise -- Normal Haskell source files
176 maybe_stub_o <- compileStub dflags' stub_c_exists
177 let stub_unlinked = case maybe_stub_o of
179 Just stub_o -> [ DotO stub_o ]
181 (hs_unlinked, unlinked_time) <-
184 -- in interpreted mode, just return the compiled code
185 -- as our "unlinked" object.
187 case maybe_interpreted_code of
189 Just comp_bc -> return ([BCOs comp_bc], ms_hs_date mod_summary)
190 -- Why do we use the timestamp of the source file here,
191 -- rather than the current time? This works better in
192 -- the case where the local clock is out of sync
193 -- with the filesystem's clock. It's just as accurate:
194 -- if the source is modified, then the linkable will
197 Nothing -> panic "compile: no interpreted code"
199 -- we're in batch mode: finish the compilation pipeline.
201 let object_filename = ml_obj_file location
203 runPipeline StopLn dflags output_fn Persistent
205 -- the object filename comes from the ModLocation
207 o_time <- getModificationTime object_filename
208 return ([DotO object_filename], o_time)
210 let linkable = LM unlinked_time this_mod
211 (hs_unlinked ++ stub_unlinked)
213 return (CompOK details iface (Just linkable))
215 -----------------------------------------------------------------------------
216 -- stub .h and .c files (for foreign export support)
218 compileStub dflags stub_c_exists
219 | not stub_c_exists = return Nothing
221 -- compile the _stub.c file w/ gcc
222 let stub_c = hscStubCOutName dflags
223 (_, stub_o) <- runPipeline StopLn dflags
224 stub_c Persistent Nothing{-no ModLocation-}
228 -- ---------------------------------------------------------------------------
231 link :: GhcMode -- interactive or batch
232 -> DynFlags -- dynamic flags
233 -> Bool -- attempt linking in batch mode?
234 -> HomePackageTable -- what to link
237 -- For the moment, in the batch linker, we don't bother to tell doLink
238 -- which packages to link -- it just tries all that are available.
239 -- batch_attempt_linking should only be *looked at* in batch mode. It
240 -- should only be True if the upsweep was successful and someone
241 -- exports main, i.e., we have good reason to believe that linking
245 link Interactive dflags batch_attempt_linking hpt
246 = do -- Not Linking...(demand linker will do the job)
250 link BatchCompile dflags batch_attempt_linking hpt
251 | batch_attempt_linking
254 home_mod_infos = moduleEnvElts hpt
256 -- the packages we depend on
257 pkg_deps = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
259 -- the linkables to link
260 linkables = map (fromJust.hm_linkable) home_mod_infos
262 when (verb >= 3) $ do
263 hPutStrLn stderr "link: linkables are ..."
264 hPutStrLn stderr (showSDoc (vcat (map ppr linkables)))
266 -- check for the -no-link flag
267 if isNoLink (ghcLink dflags)
268 then do when (verb >= 3) $
269 hPutStrLn stderr "link(batch): linking omitted (-c flag given)."
274 hPutStrLn stderr "Linking ..."
276 let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
277 obj_files = concatMap getOfiles linkables
279 -- Don't showPass in Batch mode; doLink will do that for us.
280 staticLink dflags obj_files pkg_deps
282 when (verb >= 3) (hPutStrLn stderr "link: done")
284 -- staticLink only returns if it succeeds
288 = do when (verb >= 3) $ do
289 hPutStrLn stderr "link(batch): upsweep (partially) failed OR"
290 hPutStrLn stderr " Main.main not exported; not linking."
293 verb = verbosity dflags
296 -- -----------------------------------------------------------------------------
297 -- Compile files in one-shot mode.
299 oneShot :: DynFlags -> Phase -> [String] -> IO ()
300 oneShot dflags stop_phase srcs = do
301 o_files <- mapM (compileFile dflags stop_phase) srcs
302 doLink dflags stop_phase o_files
304 compileFile :: DynFlags -> Phase -> FilePath -> IO FilePath
305 compileFile dflags stop_phase src = do
306 exists <- doesFileExist src
308 throwDyn (CmdLineError ("does not exist: " ++ src))
311 split = dopt Opt_SplitObjs dflags
312 mb_o_file = outputFile dflags
313 ghc_link = ghcLink dflags -- Set by -c or -no-link
315 -- When linking, the -o argument refers to the linker's output.
316 -- otherwise, we use it as the name for the pipeline's output.
318 | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
319 -- -o foo applies to linker
320 | Just o_file <- mb_o_file = SpecificFile o_file
321 -- -o foo applies to the file we are compiling now
322 | otherwise = Persistent
324 stop_phase' = case stop_phase of
325 As | split -> SplitAs
328 (_, out_file) <- runPipeline stop_phase' dflags
329 src output Nothing{-no ModLocation-}
333 doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
334 doLink dflags stop_phase o_files
335 | not (isStopLn stop_phase)
336 = return () -- We stopped before the linking phase
339 = case ghcLink dflags of
341 StaticLink -> staticLink dflags o_files link_pkgs
342 MkDLL -> doMkDLL dflags o_files link_pkgs
344 -- Always link in the haskell98 package for static linking. Other
345 -- packages have to be specified via the -package flag.
347 | ExtPackage h98_id <- haskell98PackageId (pkgState dflags) = [h98_id]
351 -- ---------------------------------------------------------------------------
352 -- Run a compilation pipeline, consisting of multiple phases.
354 -- This is the interface to the compilation pipeline, which runs
355 -- a series of compilation steps on a single source file, specifying
356 -- at which stage to stop.
358 -- The DynFlags can be modified by phases in the pipeline (eg. by
359 -- GHC_OPTIONS pragmas), and the changes affect later phases in the
364 -- output should be to a temporary file: we're going to
365 -- run more compilation steps on this output later
367 -- we want a persistent file, i.e. a file in the current directory
368 -- derived from the input filename, but with the appropriate extension.
369 -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
370 | SpecificFile FilePath
371 -- the output must go into the specified file.
374 :: Phase -- When to stop
375 -> DynFlags -- Dynamic flags
376 -> FilePath -- Input filename
377 -> PipelineOutput -- Output filename
378 -> Maybe ModLocation -- A ModLocation, if this is a Haskell module
379 -> IO (DynFlags, FilePath) -- (final flags, output filename)
381 runPipeline stop_phase dflags input_fn output maybe_loc
383 let (basename, suffix) = splitFilename input_fn
384 start_phase = startPhase suffix
386 -- We want to catch cases of "you can't get there from here" before
387 -- we start the pipeline, because otherwise it will just run off the
390 -- There is a partial ordering on phases, where A < B iff A occurs
391 -- before B in a normal compilation pipeline.
393 when (not (start_phase `happensBefore` stop_phase)) $
395 ("cannot compile this file to desired target: "
398 -- this is a function which will be used to calculate output file names
399 -- as we go along (we partially apply it to some of its inputs here)
400 let get_output_fn = getOutputFilename dflags stop_phase output basename
402 -- Execute the pipeline...
403 (dflags', output_fn, maybe_loc) <-
404 pipeLoop dflags start_phase stop_phase input_fn
405 basename suffix get_output_fn maybe_loc
407 -- Sometimes, a compilation phase doesn't actually generate any output
408 -- (eg. the CPP phase when -fcpp is not turned on). If we end on this
409 -- stage, but we wanted to keep the output, then we have to explicitly
413 return (dflags', output_fn)
415 do final_fn <- get_output_fn stop_phase maybe_loc
416 when (final_fn /= output_fn) $
417 copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
418 ++ "'") output_fn final_fn
419 return (dflags', final_fn)
423 pipeLoop :: DynFlags -> Phase -> Phase
424 -> FilePath -> String -> Suffix
425 -> (Phase -> Maybe ModLocation -> IO FilePath)
427 -> IO (DynFlags, FilePath, Maybe ModLocation)
429 pipeLoop dflags phase stop_phase
430 input_fn orig_basename orig_suff
431 orig_get_output_fn maybe_loc
433 | phase `eqPhase` stop_phase -- All done
434 = return (dflags, input_fn, maybe_loc)
436 | not (phase `happensBefore` stop_phase)
437 -- Something has gone wrong. We'll try to cover all the cases when
438 -- this could happen, so if we reach here it is a panic.
439 -- eg. it might happen if the -C flag is used on a source file that
440 -- has {-# OPTIONS -fasm #-}.
441 = panic ("pipeLoop: at phase " ++ show phase ++
442 " but I wanted to stop at phase " ++ show stop_phase)
445 = do { (next_phase, dflags', maybe_loc, output_fn)
446 <- runPhase phase stop_phase dflags orig_basename
447 orig_suff input_fn orig_get_output_fn maybe_loc
448 ; pipeLoop dflags' next_phase stop_phase output_fn
449 orig_basename orig_suff orig_get_output_fn maybe_loc }
452 :: DynFlags -> Phase -> PipelineOutput -> String
453 -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
454 getOutputFilename dflags stop_phase output basename
458 odir = outputDir dflags
459 osuf = objectSuf dflags
460 keep_hc = dopt Opt_KeepHcFiles dflags
461 keep_raw_s = dopt Opt_KeepRawSFiles dflags
462 keep_s = dopt Opt_KeepSFiles dflags
464 myPhaseInputExt HCc = hcsuf
465 myPhaseInputExt StopLn = osuf
466 myPhaseInputExt other = phaseInputExt other
468 func next_phase maybe_location
469 | is_last_phase, Persistent <- output = persistent_fn
470 | is_last_phase, SpecificFile f <- output = return f
471 | keep_this_output = persistent_fn
472 | otherwise = newTempName dflags suffix
474 is_last_phase = next_phase `eqPhase` stop_phase
476 -- sometimes, we keep output from intermediate stages
480 Mangle | keep_raw_s -> True
482 HCc | keep_hc -> True
485 suffix = myPhaseInputExt next_phase
487 -- persistent object files get put in odir
489 | StopLn <- next_phase = return odir_persistent
490 | otherwise = return persistent
492 persistent = basename ++ '.':suffix
495 | Just loc <- maybe_location = ml_obj_file loc
496 | Just d <- odir = replaceFilenameDirectory persistent d
497 | otherwise = persistent
500 -- -----------------------------------------------------------------------------
501 -- Each phase in the pipeline returns the next phase to execute, and the
502 -- name of the file in which the output was placed.
504 -- We must do things dynamically this way, because we often don't know
505 -- what the rest of the phases will be until part-way through the
506 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
507 -- of a source file can change the latter stages of the pipeline from
508 -- taking the via-C route to using the native code generator.
510 runPhase :: Phase -- Do this phase first
511 -> Phase -- Stop just before this phase
513 -> String -- basename of original input source
514 -> String -- its extension
515 -> FilePath -- name of file which contains the input to this phase.
516 -> (Phase -> Maybe ModLocation -> IO FilePath)
517 -- how to calculate the output filename
518 -> Maybe ModLocation -- the ModLocation, if we have one
519 -> IO (Phase, -- next phase
520 DynFlags, -- new dynamic flags
521 Maybe ModLocation, -- the ModLocation, if we have one
522 FilePath) -- output filename
524 -- Invariant: the output filename always contains the output
525 -- Interesting case: Hsc when there is no recompilation to do
526 -- Then the output filename is still a .o file
528 -------------------------------------------------------------------------------
531 runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
532 = do let unlit_flags = getOpts dflags opt_L
533 -- The -h option passes the file name for unlit to put in a #line directive
534 output_fn <- get_output_fn (Cpp sf) maybe_loc
536 SysTools.runUnlit dflags
537 (map SysTools.Option unlit_flags ++
538 [ SysTools.Option "-h"
539 , SysTools.Option input_fn
540 , SysTools.FileOption "" input_fn
541 , SysTools.FileOption "" output_fn
544 return (Cpp sf, dflags, maybe_loc, output_fn)
546 -------------------------------------------------------------------------------
547 -- Cpp phase : (a) gets OPTIONS out of file
548 -- (b) runs cpp if necessary
550 runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
551 = do src_opts <- getOptionsFromSource input_fn
552 (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
553 checkProcessArgsResult unhandled_flags (basename++'.':suff)
555 if not (dopt Opt_Cpp dflags) then
556 -- no need to preprocess CPP, just pass input file along
557 -- to the next phase of the pipeline.
558 return (HsPp sf, dflags, maybe_loc, input_fn)
560 output_fn <- get_output_fn (HsPp sf) maybe_loc
561 doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
562 return (HsPp sf, dflags, maybe_loc, output_fn)
564 -------------------------------------------------------------------------------
567 runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
568 = do if not (dopt Opt_Pp dflags) then
569 -- no need to preprocess, just pass input file along
570 -- to the next phase of the pipeline.
571 return (Hsc sf, dflags, maybe_loc, input_fn)
573 let hspp_opts = getOpts dflags opt_F
574 let orig_fn = basename ++ '.':suff
575 output_fn <- get_output_fn (Hsc sf) maybe_loc
576 SysTools.runPp dflags
577 ( [ SysTools.Option orig_fn
578 , SysTools.Option input_fn
579 , SysTools.FileOption "" output_fn
581 map SysTools.Option hspp_opts
583 return (Hsc sf, dflags, maybe_loc, output_fn)
585 -----------------------------------------------------------------------------
588 -- Compilation of a single module, in "legacy" mode (_not_ under
589 -- the direction of the compilation manager).
590 runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc
591 = do -- normal Hsc mode, not mkdependHS
593 -- we add the current directory (i.e. the directory in which
594 -- the .hs files resides) to the import path, since this is
595 -- what gcc does, and it's probably what you want.
596 let current_dir = directoryOf basename
598 paths = includePaths dflags0
599 dflags = dflags0 { includePaths = current_dir : paths }
601 -- gather the imports and module name
602 (hspp_buf,mod_name) <-
604 ExtCoreFile -> do { -- no explicit imports in ExtCore input.
605 ; m <- getCoreModuleName input_fn
606 ; return (Nothing, mkModule m) }
608 other -> do { buf <- hGetStringBuffer input_fn
609 ; (_,_,mod_name) <- getImports dflags buf input_fn
610 ; return (Just buf, mod_name) }
612 -- Build a ModLocation to pass to hscMain.
613 -- The source filename is rather irrelevant by now, but it's used
614 -- by hscMain for messages. hscMain also needs
615 -- the .hi and .o filenames, and this is as good a way
616 -- as any to generate them, and better than most. (e.g. takes
617 -- into accout the -osuf flags)
618 location1 <- mkHomeModLocation2 dflags mod_name basename suff
620 -- Boot-ify it if necessary
621 let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
622 | otherwise = location1
625 -- Take -ohi into account if present
626 -- This can't be done in mkHomeModuleLocation because
627 -- it only applies to the module being compiles
628 let ohi = outputHi dflags
629 location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
630 | otherwise = location2
632 -- Take -o into account if present
633 -- Very like -ohi, but we must *only* do this if we aren't linking
634 -- (If we're linking then the -o applies to the linked thing, not to
635 -- the object file for one module.)
636 -- Note the nasty duplication with the same computation in compileFile above
637 let expl_o_file = outputFile dflags
638 location4 | Just ofile <- expl_o_file
639 , isNoLink (ghcLink dflags)
640 = location3 { ml_obj_file = ofile }
641 | otherwise = location3
643 -- Make the ModSummary to hand to hscMain
644 src_timestamp <- getModificationTime (basename ++ '.':suff)
646 unused_field = panic "runPhase:ModSummary field"
647 -- Some fields are not looked at by hscMain
648 mod_summary = ModSummary { ms_mod = mod_name,
649 ms_hsc_src = src_flavour,
650 ms_hspp_file = Just input_fn,
651 ms_hspp_buf = hspp_buf,
652 ms_location = location4,
653 ms_hs_date = src_timestamp,
654 ms_imps = unused_field,
655 ms_srcimps = unused_field }
657 o_file = ml_obj_file location4 -- The real object file
660 -- Figure out if the source has changed, for recompilation avoidance.
662 -- Setting source_unchanged to True means that M.o seems
663 -- to be up to date wrt M.hs; so no need to recompile unless imports have
664 -- changed (which the compiler itself figures out).
665 -- Setting source_unchanged to False tells the compiler that M.o is out of
666 -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
667 let do_recomp = dopt Opt_RecompChecking dflags
669 if not do_recomp || not (isStopLn stop)
670 -- Set source_unchanged to False unconditionally if
671 -- (a) recompilation checker is off, or
672 -- (b) we aren't going all the way to .o file (e.g. ghc -S)
674 -- Otherwise look at file modification dates
675 else do o_file_exists <- doesFileExist o_file
677 then return False -- Need to recompile
678 else do t2 <- getModificationTime o_file
679 if t2 > src_timestamp
684 let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
685 let next_phase = hscNextPhase dflags src_flavour hsc_lang
686 output_fn <- get_output_fn next_phase (Just location4)
688 let dflags' = dflags { hscTarget = hsc_lang,
689 hscOutName = output_fn,
690 hscStubCOutName = basename ++ "_stub.c",
691 hscStubHOutName = basename ++ "_stub.h",
692 extCoreName = basename ++ ".hcr" }
694 hsc_env <- newHscEnv dflags'
696 -- Tell the finder cache about this module
697 addHomeModuleToFinder hsc_env mod_name location4
700 result <- hscMain hsc_env printErrorsAndWarnings
701 mod_summary source_unchanged
702 False -- No object file
707 HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
709 HscNoRecomp details iface -> do
710 SysTools.touch dflags' "Touching object file" o_file
711 return (StopLn, dflags', Just location4, o_file)
713 HscRecomp _details _iface
714 stub_h_exists stub_c_exists
715 _maybe_interpreted_code -> do
718 maybe_stub_o <- compileStub dflags' stub_c_exists
721 Just stub_o -> consIORef v_Ld_inputs stub_o
723 -- In the case of hs-boot files, generate a dummy .o-boot
724 -- stamp file for the benefit of Make
726 HsBootFile -> SysTools.touch dflags' "Touching object file" o_file
729 return (next_phase, dflags', Just location4, output_fn)
731 -----------------------------------------------------------------------------
734 runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
736 output_fn <- get_output_fn Cmm maybe_loc
737 doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
738 return (Cmm, dflags, maybe_loc, output_fn)
740 runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
742 let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
743 let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
744 output_fn <- get_output_fn next_phase maybe_loc
746 let dflags' = dflags { hscTarget = hsc_lang,
747 hscOutName = output_fn,
748 hscStubCOutName = basename ++ "_stub.c",
749 hscStubHOutName = basename ++ "_stub.h",
750 extCoreName = basename ++ ".hcr" }
752 ok <- hscCmmFile dflags' input_fn
754 when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))
756 return (next_phase, dflags, maybe_loc, output_fn)
758 -----------------------------------------------------------------------------
761 -- we don't support preprocessing .c files (with -E) now. Doing so introduces
762 -- way too many hacks, and I can't say I've ever used it anyway.
764 runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
765 | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
766 = do let cc_opts = getOpts dflags opt_c
767 hcc = cc_phase `eqPhase` HCc
769 let cmdline_include_paths = includePaths dflags
771 -- HC files have the dependent packages stamped into them
772 pkgs <- if hcc then getHCFilePackages input_fn else return []
774 -- add package include paths even if we're just compiling .c
775 -- files; this is the Value Add(TM) that using ghc instead of
777 pkg_include_dirs <- getPackageIncludePath dflags pkgs
778 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
779 (cmdline_include_paths ++ pkg_include_dirs)
781 let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
782 let pic_c_flags = picCCOpts dflags
784 let verb = getVerbFlag dflags
786 pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
788 let split_objs = dopt Opt_SplitObjs dflags
789 split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
792 let excessPrecision = dopt Opt_ExcessPrecision dflags
796 let mangle = dopt Opt_DoAsmMangling dflags
798 | hcc && mangle = Mangle
800 output_fn <- get_output_fn next_phase maybe_loc
802 -- force the C compiler to interpret this file as C when
803 -- compiling .hc files, by adding the -x c option.
804 let langopt | hcc = [ SysTools.Option "-x", SysTools.Option "c"]
807 SysTools.runCc dflags (langopt ++
808 [ SysTools.FileOption "" input_fn
809 , SysTools.Option "-o"
810 , SysTools.FileOption "" output_fn
812 ++ map SysTools.Option (
818 ++ [ verb, "-S", "-Wimplicit", "-O" ]
819 ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
822 ++ (if excessPrecision then [] else [ "-ffloat-store" ])
827 return (next_phase, dflags, maybe_loc, output_fn)
829 -- ToDo: postprocess the output from gcc
831 -----------------------------------------------------------------------------
834 runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
835 = do let mangler_opts = getOpts dflags opt_m
838 machdep_opts <- return [ show (stolen_x86_regs dflags) ]
840 machdep_opts <- return []
843 let split = dopt Opt_SplitObjs dflags
845 | split = SplitMangle
847 output_fn <- get_output_fn next_phase maybe_loc
849 SysTools.runMangle dflags (map SysTools.Option mangler_opts
850 ++ [ SysTools.FileOption "" input_fn
851 , SysTools.FileOption "" output_fn
853 ++ map SysTools.Option machdep_opts)
855 return (next_phase, dflags, maybe_loc, output_fn)
857 -----------------------------------------------------------------------------
860 runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
861 = do -- tmp_pfx is the prefix used for the split .s files
862 -- We also use it as the file to contain the no. of split .s files (sigh)
863 split_s_prefix <- SysTools.newTempName dflags "split"
864 let n_files_fn = split_s_prefix
866 SysTools.runSplit dflags
867 [ SysTools.FileOption "" input_fn
868 , SysTools.FileOption "" split_s_prefix
869 , SysTools.FileOption "" n_files_fn
872 -- Save the number of split files for future references
873 s <- readFile n_files_fn
874 let n_files = read s :: Int
875 writeIORef v_Split_info (split_s_prefix, n_files)
877 -- Remember to delete all these files
878 addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
881 return (SplitAs, dflags, maybe_loc, "**splitmangle**")
882 -- we don't use the filename
884 -----------------------------------------------------------------------------
887 runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
888 = do let as_opts = getOpts dflags opt_a
889 let cmdline_include_paths = includePaths dflags
891 output_fn <- get_output_fn StopLn maybe_loc
893 -- we create directories for the object file, because it
894 -- might be a hierarchical module.
895 createDirectoryHierarchy (directoryOf output_fn)
897 SysTools.runAs dflags
898 (map SysTools.Option as_opts
899 ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
900 ++ [ SysTools.Option "-c"
901 , SysTools.FileOption "" input_fn
902 , SysTools.Option "-o"
903 , SysTools.FileOption "" output_fn
906 return (StopLn, dflags, maybe_loc, output_fn)
909 runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
910 = do let as_opts = getOpts dflags opt_a
912 (split_s_prefix, n) <- readIORef v_Split_info
915 | Just d <- outputDir dflags = d
916 | otherwise = basename ++ "_split"
919 = do let input_s = split_s_prefix ++ "__" ++ show n ++ ".s"
920 let output_o = replaceFilenameDirectory
921 (basename ++ "__" ++ show n ++ ".o")
923 let osuf = objectSuf dflags
924 let real_o = replaceFilenameSuffix output_o osuf
925 SysTools.runAs dflags
926 (map SysTools.Option as_opts ++
927 [ SysTools.Option "-c"
928 , SysTools.Option "-o"
929 , SysTools.FileOption "" real_o
930 , SysTools.FileOption "" input_s
933 mapM_ assemble_file [1..n]
935 output_fn <- get_output_fn StopLn maybe_loc
936 return (StopLn, dflags, maybe_loc, output_fn)
938 -----------------------------------------------------------------------------
939 -- MoveBinary sort-of-phase
940 -- After having produced a binary, move it somewhere else and generate a
941 -- wrapper script calling the binary. Currently, we need this only in
942 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
943 -- central directory.
944 -- This is called from staticLink below, after linking. I haven't made it
945 -- a separate phase to minimise interfering with other modules, and
946 -- we don't need the generality of a phase (MoveBinary is always
947 -- done after linking and makes only sense in a parallel setup) -- HWL
949 runPhase_MoveBinary input_fn
952 pvm_root <- getEnv "PVM_ROOT"
953 pvm_arch <- getEnv "PVM_ARCH"
955 pvm_executable_base = "=" ++ input_fn
956 pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
957 -- nuke old binary; maybe use configur'ed names for cp and rm?
958 system ("rm -f " ++ pvm_executable)
959 -- move the newly created binary into PVM land
960 system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
961 -- generate a wrapper script for running a parallel prg under PVM
962 writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
965 -- generates a Perl skript starting a parallel prg under PVM
966 mk_pvm_wrapper_script :: String -> String -> String -> String
967 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
969 "eval 'exec perl -S $0 ${1+\"$@\"}'",
970 " if $running_under_some_shell;",
971 "# =!=!=!=!=!=!=!=!=!=!=!",
972 "# This script is automatically generated: DO NOT EDIT!!!",
973 "# Generated by Glasgow Haskell Compiler",
974 "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
976 "$pvm_executable = '" ++ pvm_executable ++ "';",
977 "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
978 "$SysMan = '" ++ sysMan ++ "';",
980 {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
981 "# first, some magical shortcuts to run "commands" on the binary",
982 "# (which is hidden)",
983 "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
984 " local($cmd) = $1;",
985 " system("$cmd $pvm_executable");",
986 " exit(0); # all done",
989 "# Now, run the real binary; process the args first",
990 "$ENV{'PE'} = $pvm_executable_base;", -- ++ pvm_executable_base,
992 "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
993 "@nonPVM_args = ();",
996 "args: while ($a = shift(@ARGV)) {",
997 " if ( $a eq '+RTS' ) {",
998 " $in_RTS_args = 1;",
999 " } elsif ( $a eq '-RTS' ) {",
1000 " $in_RTS_args = 0;",
1002 " if ( $a eq '-d' && $in_RTS_args ) {",
1004 " } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
1005 " $nprocessors = $1;",
1006 " } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
1007 " $nprocessors = $1;",
1009 " push(@nonPVM_args, $a);",
1013 "local($return_val) = 0;",
1014 "# Start the parallel execution by calling SysMan",
1015 "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
1016 "$return_val = $?;",
1017 "# ToDo: fix race condition moving files and flushing them!!",
1018 "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
1019 "exit($return_val);"
1022 -----------------------------------------------------------------------------
1023 -- Complain about non-dynamic flags in OPTIONS pragmas
1025 checkProcessArgsResult flags filename
1026 = do when (notNull flags) (throwDyn (ProgramError (
1027 showSDoc (hang (text filename <> char ':')
1028 4 (text "unknown flags in {-# OPTIONS #-} pragma:" <+>
1029 hsep (map text flags)))
1032 -----------------------------------------------------------------------------
1033 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
1035 getHCFilePackages :: FilePath -> IO [PackageId]
1036 getHCFilePackages filename =
1037 EXCEPTION.bracket (openFile filename ReadMode) hClose $ \h -> do
1040 '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
1041 return (map stringToPackageId (words rest))
1045 -----------------------------------------------------------------------------
1046 -- Static linking, of .o files
1048 -- The list of packages passed to link is the list of packages on
1049 -- which this program depends, as discovered by the compilation
1050 -- manager. It is combined with the list of packages that the user
1051 -- specifies on the command line with -package flags.
1053 -- In one-shot linking mode, we can't discover the package
1054 -- dependencies (because we haven't actually done any compilation or
1055 -- read any interface files), so the user must explicitly specify all
1058 staticLink :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
1059 staticLink dflags o_files dep_packages = do
1060 let verb = getVerbFlag dflags
1062 -- get the full list of packages to link with, by combining the
1063 -- explicit packages with the auto packages and all of their
1064 -- dependencies, and eliminating duplicates.
1066 let o_file = outputFile dflags
1067 #if defined(mingw32_HOST_OS)
1068 let output_fn = case o_file of { Just s -> s; Nothing -> "main.exe"; }
1070 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1073 pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1074 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1076 let lib_paths = libraryPaths dflags
1077 let lib_path_opts = map ("-L"++) lib_paths
1079 pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1081 #ifdef darwin_TARGET_OS
1082 pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1083 let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1085 framework_paths <- readIORef v_Framework_paths
1086 let framework_path_opts = map ("-F"++) framework_paths
1088 pkg_frameworks <- getPackageFrameworks dflags dep_packages
1089 let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1090 frameworks <- readIORef v_Cmdline_frameworks
1091 let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1092 -- reverse because they're added in reverse order from the cmd line
1095 -- probably _stub.o files
1096 extra_ld_inputs <- readIORef v_Ld_inputs
1098 -- opts from -optl-<blah> (including -l<blah> options)
1099 let extra_ld_opts = getOpts dflags opt_l
1101 let ways = wayNames dflags
1103 -- Here are some libs that need to be linked at the *end* of
1104 -- the command line, because they contain symbols that are referred to
1105 -- by the RTS. We can't therefore use the ordinary way opts for these.
1107 debug_opts | WayDebug `elem` ways = [
1108 #if defined(HAVE_LIBBFD)
1115 thread_opts | WayThreaded `elem` ways = [
1116 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1119 #if defined(osf3_TARGET_OS)
1125 let (md_c_flags, _) = machdepCCOpts dflags
1126 SysTools.runLink dflags (
1127 [ SysTools.Option verb
1128 , SysTools.Option "-o"
1129 , SysTools.FileOption "" output_fn
1131 ++ map SysTools.Option (
1137 #ifdef darwin_TARGET_OS
1138 ++ framework_path_opts
1141 ++ pkg_lib_path_opts
1143 #ifdef darwin_TARGET_OS
1144 ++ pkg_framework_path_opts
1145 ++ pkg_framework_opts
1151 -- parallel only: move binary to another dir -- HWL
1152 when (WayPar `elem` ways)
1153 (do success <- runPhase_MoveBinary output_fn
1154 if success then return ()
1155 else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1157 -----------------------------------------------------------------------------
1158 -- Making a DLL (only for Win32)
1160 doMkDLL :: DynFlags -> [String] -> [PackageId] -> IO ()
1161 doMkDLL dflags o_files dep_packages = do
1162 let verb = getVerbFlag dflags
1163 let static = opt_Static
1164 let no_hs_main = dopt Opt_NoHsMain dflags
1165 let o_file = outputFile dflags
1166 let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1168 pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1169 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1171 let lib_paths = libraryPaths dflags
1172 let lib_path_opts = map ("-L"++) lib_paths
1174 pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1176 -- probably _stub.o files
1177 extra_ld_inputs <- readIORef v_Ld_inputs
1179 -- opts from -optdll-<blah>
1180 let extra_ld_opts = getOpts dflags opt_dll
1182 let pstate = pkgState dflags
1183 rts_id | ExtPackage id <- rtsPackageId pstate = id
1184 | otherwise = panic "staticLink: rts package missing"
1185 base_id | ExtPackage id <- basePackageId pstate = id
1186 | otherwise = panic "staticLink: base package missing"
1187 rts_pkg = getPackageDetails pstate rts_id
1188 base_pkg = getPackageDetails pstate base_id
1190 let extra_os = if static || no_hs_main
1192 else [ head (libraryDirs rts_pkg) ++ "/Main.dll_o",
1193 head (libraryDirs base_pkg) ++ "/PrelMain.dll_o" ]
1195 let (md_c_flags, _) = machdepCCOpts dflags
1196 SysTools.runMkDLL dflags
1197 ([ SysTools.Option verb
1198 , SysTools.Option "-o"
1199 , SysTools.FileOption "" output_fn
1201 ++ map SysTools.Option (
1205 ++ [ "--target=i386-mingw32" ]
1209 ++ pkg_lib_path_opts
1211 ++ (if "--def" `elem` (concatMap words extra_ld_opts)
1213 else [ "--export-all" ])
1216 -- -----------------------------------------------------------------------------
1219 doCpp :: DynFlags -> Bool -> Bool -> FilePath -> FilePath -> IO ()
1220 doCpp dflags raw include_cc_opts input_fn output_fn = do
1221 let hscpp_opts = getOpts dflags opt_P
1222 let cmdline_include_paths = includePaths dflags
1224 pkg_include_dirs <- getPackageIncludePath dflags []
1225 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1226 (cmdline_include_paths ++ pkg_include_dirs)
1228 let verb = getVerbFlag dflags
1231 | not include_cc_opts = []
1232 | otherwise = (optc ++ md_c_flags)
1234 optc = getOpts dflags opt_c
1235 (md_c_flags, _) = machdepCCOpts dflags
1237 let cpp_prog args | raw = SysTools.runCpp dflags args
1238 | otherwise = SysTools.runCc dflags (SysTools.Option "-E" : args)
1241 [ "-D" ++ HOST_OS ++ "_BUILD_OS=1",
1242 "-D" ++ HOST_ARCH ++ "_BUILD_ARCH=1",
1243 "-D" ++ TARGET_OS ++ "_HOST_OS=1",
1244 "-D" ++ TARGET_ARCH ++ "_HOST_ARCH=1" ]
1245 -- remember, in code we *compile*, the HOST is the same our TARGET,
1246 -- and BUILD is the same as our HOST.
1248 cpp_prog ([SysTools.Option verb]
1249 ++ map SysTools.Option include_paths
1250 ++ map SysTools.Option hsSourceCppOpts
1251 ++ map SysTools.Option hscpp_opts
1252 ++ map SysTools.Option cc_opts
1253 ++ map SysTools.Option target_defs
1254 ++ [ SysTools.Option "-x"
1255 , SysTools.Option "c"
1256 , SysTools.Option input_fn
1257 -- We hackily use Option instead of FileOption here, so that the file
1258 -- name is not back-slashed on Windows. cpp is capable of
1259 -- dealing with / in filenames, so it works fine. Furthermore
1260 -- if we put in backslashes, cpp outputs #line directives
1261 -- with *double* backslashes. And that in turn means that
1262 -- our error messages get double backslashes in them.
1263 -- In due course we should arrange that the lexer deals
1264 -- with these \\ escapes properly.
1265 , SysTools.Option "-o"
1266 , SysTools.FileOption "" output_fn
1269 cHaskell1Version = "5" -- i.e., Haskell 98
1271 -- Default CPP defines in Haskell source
1273 [ "-D__HASKELL1__="++cHaskell1Version
1274 , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
1276 , "-D__CONCURRENT_HASKELL__"
1279 -----------------------------------------------------------------------------
1280 -- Reading OPTIONS pragmas
1282 getOptionsFromSource
1283 :: String -- input file
1284 -> IO [String] -- options, if any
1285 getOptionsFromSource file
1286 = do h <- openFile file ReadMode
1287 look h `finally` hClose h
1290 r <- tryJust ioErrors (hGetLine h)
1292 Left e | isEOFError e -> return []
1293 | otherwise -> ioError e
1295 let l = removeSpaces l'
1297 () | null l -> look h
1298 | prefixMatch "#" l -> look h
1299 | prefixMatch "{-# LINE" l -> look h -- -}
1300 | Just opts <- matchOptions l
1301 -> do rest <- look h
1302 return (opts ++ rest)
1303 | otherwise -> return []
1305 -- detect {-# OPTIONS_GHC ... #-}. For the time being, we accept OPTIONS
1306 -- instead of OPTIONS_GHC, but that is deprecated.
1308 | Just s1 <- maybePrefixMatch "{-#" s -- -}
1309 = matchOptions1 (removeSpaces s1)
1314 | Just s2 <- maybePrefixMatch "OPTIONS" s
1316 _ | Just s3 <- maybePrefixMatch "_GHC" s2, not (is_ident (head s3))
1318 | not (is_ident (head s2))
1321 -> Just [] -- OPTIONS_anything is ignored, not treated as start of source
1322 | Just s2 <- maybePrefixMatch "INCLUDE" s, not (is_ident (head s2)),
1323 Just s3 <- maybePrefixMatch "}-#" (reverse s2)
1324 = Just ["-#include", removeSpaces (reverse s3)]
1325 | otherwise = Nothing
1327 | Just s3 <- maybePrefixMatch "}-#" (reverse s) = Just (words (reverse s3))
1328 | otherwise = Nothing
1331 -- -----------------------------------------------------------------------------
1334 hscNextPhase :: DynFlags -> HscSource -> HscTarget -> Phase
1335 hscNextPhase dflags HsBootFile hsc_lang = StopLn
1336 hscNextPhase dflags other hsc_lang =
1339 HscAsm | dopt Opt_SplitObjs dflags -> SplitMangle
1341 HscNothing -> StopLn
1342 HscInterpreted -> StopLn
1346 hscMaybeAdjustTarget :: DynFlags -> Phase -> HscSource -> HscTarget -> HscTarget
1347 hscMaybeAdjustTarget dflags stop HsBootFile current_hsc_lang
1348 = HscNothing -- No output (other than Foo.hi-boot) for hs-boot files
1349 hscMaybeAdjustTarget dflags stop other current_hsc_lang
1352 keep_hc = dopt Opt_KeepHcFiles dflags
1354 -- don't change the lang if we're interpreting
1355 | current_hsc_lang == HscInterpreted = current_hsc_lang
1357 -- force -fvia-C if we are being asked for a .hc file
1358 | HCc <- stop = HscC
1360 -- otherwise, stick to the plan
1361 | otherwise = current_hsc_lang
1363 GLOBAL_VAR(v_Split_info, ("",0), (String,Int))
1364 -- The split prefix and number of files