1 {-# OPTIONS -fno-cse #-}
2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
4 -----------------------------------------------------------------------------
8 -- (c) The University of Glasgow 2005
10 -----------------------------------------------------------------------------
12 module DriverPipeline (
13 -- Run a series of compilation steps in a pipeline, for a
14 -- collection of source files.
17 -- Interfaces for the batch-mode driver
20 -- Interfaces for the compilation manager (interpreted/batch-mode)
27 #include "HsVersions.h"
38 import LazyUniqFM ( eltsUFM )
41 import StaticFlags ( v_Ld_inputs, opt_Static, WayName(..) )
45 import StringBuffer ( hGetStringBuffer )
46 import BasicTypes ( SuccessFlag(..) )
47 import Maybes ( expectJust )
48 import ParserCoreUtils ( getCoreModuleName )
55 import Data.IORef ( readIORef )
56 import GHC.Exts ( Int(..) )
57 import System.Directory
58 import System.FilePath
60 import System.IO.Error as IO
62 import Data.List ( isSuffixOf )
64 import System.Environment
66 -- ---------------------------------------------------------------------------
69 -- | Just preprocess a file, put the result in a temp. file (used by the
70 -- compilation manager during the summary phase).
72 -- We return the augmented DynFlags, because they contain the result
73 -- of slurping in the OPTIONS pragmas
75 preprocess :: GhcMonad m =>
77 -> (FilePath, Maybe Phase) -- ^ filename and starting phase
78 -> m (DynFlags, FilePath)
79 preprocess hsc_env (filename, mb_phase) =
80 ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename)
81 runPipeline anyHsc hsc_env (filename, mb_phase)
82 Nothing Temporary Nothing{-no ModLocation-}
84 -- ---------------------------------------------------------------------------
88 -- Compile a single module, under the control of the compilation manager.
90 -- This is the interface between the compilation manager and the
91 -- compiler proper (hsc), where we deal with tedious details like
92 -- reading the OPTIONS pragma from the source file, and passing the
93 -- output of hsc through the C compiler.
95 -- NB. No old interface can also mean that the source has changed.
97 compile :: GhcMonad m =>
99 -> ModSummary -- ^ summary for module being compiled
100 -> Int -- ^ module N ...
102 -> Maybe ModIface -- ^ old interface, if we have one
103 -> Maybe Linkable -- ^ old linkable, if we have one
104 -> m HomeModInfo -- ^ the complete HomeModInfo, if successful
106 compile = compile' (hscCompileNothing, hscCompileInteractive, hscCompileBatch)
108 type Compiler m a = HscEnv -> ModSummary -> Bool
109 -> Maybe ModIface -> Maybe (Int, Int)
112 compile' :: GhcMonad m =>
113 (Compiler m (HscStatus, ModIface, ModDetails),
114 Compiler m (InteractiveStatus, ModIface, ModDetails),
115 Compiler m (HscStatus, ModIface, ModDetails))
117 -> ModSummary -- ^ summary for module being compiled
118 -> Int -- ^ module N ...
120 -> Maybe ModIface -- ^ old interface, if we have one
121 -> Maybe Linkable -- ^ old linkable, if we have one
122 -> m HomeModInfo -- ^ the complete HomeModInfo, if successful
124 compile' (nothingCompiler, interactiveCompiler, batchCompiler)
125 hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
127 let dflags0 = ms_hspp_opts summary
128 this_mod = ms_mod summary
129 src_flavour = ms_hsc_src summary
130 location = ms_location summary
131 input_fn = expectJust "compile:hs" (ml_hs_file location)
132 input_fnpp = ms_hspp_file summary
134 liftIO $ debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
136 let basename = dropExtension input_fn
138 -- We add the directory in which the .hs files resides) to the import path.
139 -- This is needed when we try to compile the .hc file later, if it
140 -- imports a _stub.h file that we created here.
141 let current_dir = case takeDirectory basename of
142 "" -> "." -- XXX Hack
144 old_paths = includePaths dflags0
145 dflags = dflags0 { includePaths = current_dir : old_paths }
146 hsc_env = hsc_env0 {hsc_dflags = dflags}
148 -- Figure out what lang we're generating
149 let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
150 -- ... and what the next phase should be
151 let next_phase = hscNextPhase dflags src_flavour hsc_lang
152 -- ... and what file to generate the output into
153 output_fn <- liftIO $ getOutputFilename next_phase
154 Temporary basename dflags next_phase (Just location)
156 let dflags' = dflags { hscTarget = hsc_lang,
157 hscOutName = output_fn,
158 extCoreName = basename ++ ".hcr" }
159 let hsc_env' = hsc_env { hsc_dflags = dflags' }
161 -- -fforce-recomp should also work with --make
162 let force_recomp = dopt Opt_ForceRecomp dflags
163 source_unchanged = isJust maybe_old_linkable && not force_recomp
164 object_filename = ml_obj_file location
166 let getStubLinkable False = return []
168 = do stub_o <- compileStub hsc_env' this_mod location
169 return [ DotO stub_o ]
171 handleBatch HscNoRecomp
172 = ASSERT (isJust maybe_old_linkable)
173 return maybe_old_linkable
175 handleBatch (HscRecomp hasStub _)
176 | isHsBoot src_flavour
177 = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
178 liftIO $ SysTools.touch dflags' "Touching object file"
180 return maybe_old_linkable
183 = do stub_unlinked <- getStubLinkable hasStub
184 (hs_unlinked, unlinked_time) <-
187 -> return ([], ms_hs_date summary)
188 -- We're in --make mode: finish the compilation pipeline.
190 -> do runPipeline StopLn hsc_env' (output_fn,Nothing)
194 -- The object filename comes from the ModLocation
195 o_time <- liftIO $ getModificationTime object_filename
196 return ([DotO object_filename], o_time)
197 let linkable = LM unlinked_time this_mod
198 (hs_unlinked ++ stub_unlinked)
199 return (Just linkable)
201 handleInterpreted HscNoRecomp
202 = ASSERT (isJust maybe_old_linkable)
203 return maybe_old_linkable
204 handleInterpreted (HscRecomp _hasStub Nothing)
205 = ASSERT (isHsBoot src_flavour)
206 return maybe_old_linkable
207 handleInterpreted (HscRecomp hasStub (Just (comp_bc, modBreaks)))
208 = do stub_unlinked <- getStubLinkable hasStub
209 let hs_unlinked = [BCOs comp_bc modBreaks]
210 unlinked_time = ms_hs_date summary
211 -- Why do we use the timestamp of the source file here,
212 -- rather than the current time? This works better in
213 -- the case where the local clock is out of sync
214 -- with the filesystem's clock. It's just as accurate:
215 -- if the source is modified, then the linkable will
217 let linkable = LM unlinked_time this_mod
218 (hs_unlinked ++ stub_unlinked)
219 return (Just linkable)
221 let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
223 runCompiler compiler handle
224 = do (result, iface, details)
225 <- compiler hsc_env' summary source_unchanged mb_old_iface
226 (Just (mod_index, nmods))
227 linkable <- handle result
228 return (HomeModInfo{ hm_details = details,
230 hm_linkable = linkable })
234 runCompiler interactiveCompiler handleInterpreted
236 runCompiler nothingCompiler handleBatch
238 runCompiler batchCompiler handleBatch
241 -----------------------------------------------------------------------------
242 -- stub .h and .c files (for foreign export support)
244 -- The _stub.c file is derived from the haskell source file, possibly taking
245 -- into account the -stubdir option.
247 -- Consequently, we derive the _stub.o filename from the haskell object
250 -- This isn't necessarily the same as the object filename we
251 -- would get if we just compiled the _stub.c file using the pipeline.
254 -- ghc src/A.hs -odir obj
256 -- results in obj/A.o, and src/A_stub.c. If we compile src/A_stub.c with
257 -- -odir obj, we would get obj/src/A_stub.o, which is wrong; we want
260 compileStub :: GhcMonad m => HscEnv -> Module -> ModLocation
262 compileStub hsc_env mod location = do
263 let (o_base, o_ext) = splitExtension (ml_obj_file location)
264 stub_o = (o_base ++ "_stub") <.> o_ext
266 -- compile the _stub.c file w/ gcc
267 let (stub_c,_,_) = mkStubPaths (hsc_dflags hsc_env) (moduleName mod) location
268 runPipeline StopLn hsc_env (stub_c,Nothing) Nothing
269 (SpecificFile stub_o) Nothing{-no ModLocation-}
274 -- ---------------------------------------------------------------------------
277 link :: GhcLink -- interactive or batch
278 -> DynFlags -- dynamic flags
279 -> Bool -- attempt linking in batch mode?
280 -> HomePackageTable -- what to link
283 -- For the moment, in the batch linker, we don't bother to tell doLink
284 -- which packages to link -- it just tries all that are available.
285 -- batch_attempt_linking should only be *looked at* in batch mode. It
286 -- should only be True if the upsweep was successful and someone
287 -- exports main, i.e., we have good reason to believe that linking
291 link LinkInMemory _ _ _
292 = do -- Not Linking...(demand linker will do the job)
299 link LinkBinary dflags batch_attempt_linking hpt
300 | batch_attempt_linking
303 home_mod_infos = eltsUFM hpt
305 -- the packages we depend on
306 pkg_deps = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
308 -- the linkables to link
309 linkables = map (expectJust "link".hm_linkable) home_mod_infos
311 debugTraceMsg dflags 3 (text "link: linkables are ..." $$ vcat (map ppr linkables))
313 -- check for the -no-link flag
314 if isNoLink (ghcLink dflags)
315 then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
319 let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
320 obj_files = concatMap getOfiles linkables
322 exe_file = exeFileName dflags
324 linking_needed <- linkingNeeded dflags linkables pkg_deps
326 if not (dopt Opt_ForceRecomp dflags) && not linking_needed
327 then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
331 debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
334 -- Don't showPass in Batch mode; doLink will do that for us.
335 let link = case ghcLink dflags of
336 LinkBinary -> linkBinary
337 LinkDynLib -> linkDynLib
338 other -> panicBadLink other
339 link dflags obj_files pkg_deps
341 debugTraceMsg dflags 3 (text "link: done")
343 -- linkBinary only returns if it succeeds
347 = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
348 text " Main.main not exported; not linking.")
351 -- warning suppression
352 link other _ _ _ = panicBadLink other
354 panicBadLink :: GhcLink -> a
355 panicBadLink other = panic ("link: GHC not built to link this way: " ++
359 linkingNeeded :: DynFlags -> [Linkable] -> [PackageId] -> IO Bool
360 linkingNeeded dflags linkables pkg_deps = do
361 -- if the modification time on the executable is later than the
362 -- modification times on all of the objects and libraries, then omit
363 -- linking (unless the -fforce-recomp flag was given).
364 let exe_file = exeFileName dflags
365 e_exe_time <- IO.try $ getModificationTime exe_file
367 Left _ -> return True
369 -- first check object files and extra_ld_inputs
370 extra_ld_inputs <- readIORef v_Ld_inputs
371 e_extra_times <- mapM (IO.try . getModificationTime) extra_ld_inputs
372 let (errs,extra_times) = splitEithers e_extra_times
373 let obj_times = map linkableTime linkables ++ extra_times
374 if not (null errs) || any (t <) obj_times
378 -- next, check libraries. XXX this only checks Haskell libraries,
379 -- not extra_libraries or -l things from the command line.
380 let pkg_map = pkgIdMap (pkgState dflags)
381 pkg_hslibs = [ (libraryDirs c, lib)
382 | Just c <- map (lookupPackage pkg_map) pkg_deps,
383 lib <- packageHsLibs dflags c ]
385 pkg_libfiles <- mapM (uncurry findHSLib) pkg_hslibs
386 if any isNothing pkg_libfiles then return True else do
387 e_lib_times <- mapM (IO.try . getModificationTime)
388 (catMaybes pkg_libfiles)
389 let (lib_errs,lib_times) = splitEithers e_lib_times
390 if not (null lib_errs) || any (t <) lib_times
394 findHSLib :: [String] -> String -> IO (Maybe FilePath)
395 findHSLib dirs lib = do
396 let batch_lib_file = "lib" ++ lib <.> "a"
397 found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
400 (x:_) -> return (Just x)
402 -- -----------------------------------------------------------------------------
403 -- Compile files in one-shot mode.
405 oneShot :: GhcMonad m =>
406 HscEnv -> Phase -> [(String, Maybe Phase)] -> m ()
407 oneShot hsc_env stop_phase srcs = do
408 o_files <- mapM (compileFile hsc_env stop_phase) srcs
409 liftIO $ doLink (hsc_dflags hsc_env) stop_phase o_files
411 compileFile :: GhcMonad m =>
412 HscEnv -> Phase -> (FilePath, Maybe Phase) -> m FilePath
413 compileFile hsc_env stop_phase (src, mb_phase) = do
414 exists <- liftIO $ doesFileExist src
416 ghcError (CmdLineError ("does not exist: " ++ src))
419 dflags = hsc_dflags hsc_env
420 split = dopt Opt_SplitObjs dflags
421 mb_o_file = outputFile dflags
422 ghc_link = ghcLink dflags -- Set by -c or -no-link
424 -- When linking, the -o argument refers to the linker's output.
425 -- otherwise, we use it as the name for the pipeline's output.
427 | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
428 -- -o foo applies to linker
429 | Just o_file <- mb_o_file = SpecificFile o_file
430 -- -o foo applies to the file we are compiling now
431 | otherwise = Persistent
433 stop_phase' = case stop_phase of
434 As | split -> SplitAs
437 ( _, out_file) <- runPipeline stop_phase' hsc_env
438 (src, mb_phase) Nothing output
439 Nothing{-no ModLocation-}
443 doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
444 doLink dflags stop_phase o_files
445 | not (isStopLn stop_phase)
446 = return () -- We stopped before the linking phase
449 = case ghcLink dflags of
451 LinkBinary -> linkBinary dflags o_files link_pkgs
452 LinkDynLib -> linkDynLib dflags o_files []
453 other -> panicBadLink other
455 -- Always link in the haskell98 package for static linking. Other
456 -- packages have to be specified via the -package flag.
458 | dopt Opt_AutoLinkPackages dflags = [haskell98PackageId]
462 -- ---------------------------------------------------------------------------
466 -- ^ Output should be to a temporary file: we're going to
467 -- run more compilation steps on this output later.
469 -- ^ We want a persistent file, i.e. a file in the current directory
470 -- derived from the input filename, but with the appropriate extension.
471 -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
472 | SpecificFile FilePath
473 -- ^ The output must go into the specified file.
475 -- | Run a compilation pipeline, consisting of multiple phases.
477 -- This is the interface to the compilation pipeline, which runs
478 -- a series of compilation steps on a single source file, specifying
479 -- at which stage to stop.
481 -- The DynFlags can be modified by phases in the pipeline (eg. by
482 -- GHC_OPTIONS pragmas), and the changes affect later phases in the
486 Phase -- ^ When to stop
487 -> HscEnv -- ^ Compilation environment
488 -> (FilePath,Maybe Phase) -- ^ Input filename (and maybe -x suffix)
489 -> Maybe FilePath -- ^ original basename (if different from ^^^)
490 -> PipelineOutput -- ^ Output filename
491 -> Maybe ModLocation -- ^ A ModLocation, if this is a Haskell module
492 -> m (DynFlags, FilePath) -- ^ (final flags, output filename)
494 runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
496 let dflags0 = hsc_dflags hsc_env0
497 (input_basename, suffix) = splitExtension input_fn
498 suffix' = drop 1 suffix -- strip off the .
499 basename | Just b <- mb_basename = b
500 | otherwise = input_basename
502 -- Decide where dump files should go based on the pipeline output
503 dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
504 hsc_env = hsc_env0 {hsc_dflags = dflags}
506 -- If we were given a -x flag, then use that phase to start from
507 start_phase = fromMaybe (startPhase suffix') mb_phase
509 -- We want to catch cases of "you can't get there from here" before
510 -- we start the pipeline, because otherwise it will just run off the
513 -- There is a partial ordering on phases, where A < B iff A occurs
514 -- before B in a normal compilation pipeline.
516 when (not (start_phase `happensBefore` stop_phase)) $
518 ("cannot compile this file to desired target: "
521 -- this is a function which will be used to calculate output file names
522 -- as we go along (we partially apply it to some of its inputs here)
523 let get_output_fn = getOutputFilename stop_phase output basename
525 -- Execute the pipeline...
526 (dflags', output_fn, maybe_loc) <-
527 pipeLoop hsc_env start_phase stop_phase input_fn
528 basename suffix' get_output_fn maybe_loc
530 -- Sometimes, a compilation phase doesn't actually generate any output
531 -- (eg. the CPP phase when -fcpp is not turned on). If we end on this
532 -- stage, but we wanted to keep the output, then we have to explicitly
533 -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
534 -- further compilation stages can tell what the original filename was.
537 return (dflags', output_fn)
539 do final_fn <- get_output_fn dflags' stop_phase maybe_loc
540 when (final_fn /= output_fn) $ do
541 let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
542 line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
543 copyWithHeader dflags msg line_prag output_fn final_fn
544 return (dflags', final_fn)
548 pipeLoop :: GhcMonad m =>
549 HscEnv -> Phase -> Phase
550 -> FilePath -> String -> Suffix
551 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
553 -> m (DynFlags, FilePath, Maybe ModLocation)
555 pipeLoop hsc_env phase stop_phase
556 input_fn orig_basename orig_suff
557 orig_get_output_fn maybe_loc
559 | phase `eqPhase` stop_phase -- All done
560 = return (hsc_dflags hsc_env, input_fn, maybe_loc)
562 | not (phase `happensBefore` stop_phase)
563 -- Something has gone wrong. We'll try to cover all the cases when
564 -- this could happen, so if we reach here it is a panic.
565 -- eg. it might happen if the -C flag is used on a source file that
566 -- has {-# OPTIONS -fasm #-}.
567 = panic ("pipeLoop: at phase " ++ show phase ++
568 " but I wanted to stop at phase " ++ show stop_phase)
571 = do (next_phase, dflags', maybe_loc, output_fn)
572 <- runPhase phase stop_phase hsc_env orig_basename
573 orig_suff input_fn orig_get_output_fn maybe_loc
574 let hsc_env' = hsc_env {hsc_dflags = dflags'}
575 pipeLoop hsc_env' next_phase stop_phase output_fn
576 orig_basename orig_suff orig_get_output_fn maybe_loc
579 :: Phase -> PipelineOutput -> String
580 -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
581 getOutputFilename stop_phase output basename
584 func dflags next_phase maybe_location
585 | is_last_phase, Persistent <- output = persistent_fn
586 | is_last_phase, SpecificFile f <- output = return f
587 | keep_this_output = persistent_fn
588 | otherwise = newTempName dflags suffix
591 odir = objectDir dflags
592 osuf = objectSuf dflags
593 keep_hc = dopt Opt_KeepHcFiles dflags
594 keep_raw_s = dopt Opt_KeepRawSFiles dflags
595 keep_s = dopt Opt_KeepSFiles dflags
597 myPhaseInputExt HCc = hcsuf
598 myPhaseInputExt StopLn = osuf
599 myPhaseInputExt other = phaseInputExt other
601 is_last_phase = next_phase `eqPhase` stop_phase
603 -- sometimes, we keep output from intermediate stages
607 Mangle | keep_raw_s -> True
609 HCc | keep_hc -> True
612 suffix = myPhaseInputExt next_phase
614 -- persistent object files get put in odir
616 | StopLn <- next_phase = return odir_persistent
617 | otherwise = return persistent
619 persistent = basename <.> suffix
622 | Just loc <- maybe_location = ml_obj_file loc
623 | Just d <- odir = d </> persistent
624 | otherwise = persistent
627 -- -----------------------------------------------------------------------------
628 -- | Each phase in the pipeline returns the next phase to execute, and the
629 -- name of the file in which the output was placed.
631 -- We must do things dynamically this way, because we often don't know
632 -- what the rest of the phases will be until part-way through the
633 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
634 -- of a source file can change the latter stages of the pipeline from
635 -- taking the via-C route to using the native code generator.
637 runPhase :: GhcMonad m =>
638 Phase -- ^ Do this phase first
639 -> Phase -- ^ Stop just before this phase
641 -> String -- ^ basename of original input source
642 -> String -- ^ its extension
643 -> FilePath -- ^ name of file which contains the input to this phase.
644 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
645 -- ^ how to calculate the output filename
646 -> Maybe ModLocation -- ^ the ModLocation, if we have one
647 -> m (Phase, -- next phase
648 DynFlags, -- new dynamic flags
649 Maybe ModLocation, -- the ModLocation, if we have one
650 FilePath) -- output filename
652 -- Invariant: the output filename always contains the output
653 -- Interesting case: Hsc when there is no recompilation to do
654 -- Then the output filename is still a .o file
656 -------------------------------------------------------------------------------
659 runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
661 let dflags = hsc_dflags hsc_env
662 output_fn <- liftIO $ get_output_fn dflags (Cpp sf) maybe_loc
664 let unlit_flags = getOpts dflags opt_L
665 flags = map SysTools.Option unlit_flags ++
666 [ -- The -h option passes the file name for unlit to
667 -- put in a #line directive
669 -- cpp interprets \b etc as escape sequences,
670 -- so we use / for filenames in pragmas
671 , SysTools.Option $ reslash Forwards $ normalise input_fn
672 , SysTools.FileOption "" input_fn
673 , SysTools.FileOption "" output_fn
676 liftIO $ SysTools.runUnlit dflags flags
678 return (Cpp sf, dflags, maybe_loc, output_fn)
680 -------------------------------------------------------------------------------
681 -- Cpp phase : (a) gets OPTIONS out of file
682 -- (b) runs cpp if necessary
684 runPhase (Cpp sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
685 = do let dflags0 = hsc_dflags hsc_env
686 src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
687 (dflags, unhandled_flags, warns)
688 <- liftIO $ parseDynamicNoPackageFlags dflags0 src_opts
689 handleFlagWarnings dflags warns
690 checkProcessArgsResult unhandled_flags
692 if not (dopt Opt_Cpp dflags) then
693 -- no need to preprocess CPP, just pass input file along
694 -- to the next phase of the pipeline.
695 return (HsPp sf, dflags, maybe_loc, input_fn)
697 output_fn <- liftIO $ get_output_fn dflags (HsPp sf) maybe_loc
698 liftIO $ doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
699 return (HsPp sf, dflags, maybe_loc, output_fn)
701 -------------------------------------------------------------------------------
704 runPhase (HsPp sf) _stop hsc_env basename suff input_fn get_output_fn maybe_loc
705 = do let dflags = hsc_dflags hsc_env
706 if not (dopt Opt_Pp dflags) then
707 -- no need to preprocess, just pass input file along
708 -- to the next phase of the pipeline.
709 return (Hsc sf, dflags, maybe_loc, input_fn)
711 let hspp_opts = getOpts dflags opt_F
712 let orig_fn = basename <.> suff
713 output_fn <- liftIO $ get_output_fn dflags (Hsc sf) maybe_loc
714 liftIO $ SysTools.runPp dflags
715 ( [ SysTools.Option orig_fn
716 , SysTools.Option input_fn
717 , SysTools.FileOption "" output_fn
719 map SysTools.Option hspp_opts
721 return (Hsc sf, dflags, maybe_loc, output_fn)
723 -----------------------------------------------------------------------------
726 -- Compilation of a single module, in "legacy" mode (_not_ under
727 -- the direction of the compilation manager).
728 runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc
729 = do -- normal Hsc mode, not mkdependHS
730 let dflags0 = hsc_dflags hsc_env
732 -- we add the current directory (i.e. the directory in which
733 -- the .hs files resides) to the include path, since this is
734 -- what gcc does, and it's probably what you want.
735 let current_dir = case takeDirectory basename of
736 "" -> "." -- XXX Hack
739 paths = includePaths dflags0
740 dflags = dflags0 { includePaths = current_dir : paths }
742 -- gather the imports and module name
743 (hspp_buf,mod_name,imps,src_imps) <-
745 ExtCoreFile -> do -- no explicit imports in ExtCore input.
746 m <- liftIO $ getCoreModuleName input_fn
747 return (Nothing, mkModuleName m, [], [])
750 buf <- liftIO $ hGetStringBuffer input_fn
751 (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
752 return (Just buf, mod_name, imps, src_imps)
754 -- Build a ModLocation to pass to hscMain.
755 -- The source filename is rather irrelevant by now, but it's used
756 -- by hscMain for messages. hscMain also needs
757 -- the .hi and .o filenames, and this is as good a way
758 -- as any to generate them, and better than most. (e.g. takes
759 -- into accout the -osuf flags)
760 location1 <- liftIO $ mkHomeModLocation2 dflags mod_name basename suff
762 -- Boot-ify it if necessary
763 let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
764 | otherwise = location1
767 -- Take -ohi into account if present
768 -- This can't be done in mkHomeModuleLocation because
769 -- it only applies to the module being compiles
770 let ohi = outputHi dflags
771 location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
772 | otherwise = location2
774 -- Take -o into account if present
775 -- Very like -ohi, but we must *only* do this if we aren't linking
776 -- (If we're linking then the -o applies to the linked thing, not to
777 -- the object file for one module.)
778 -- Note the nasty duplication with the same computation in compileFile above
779 let expl_o_file = outputFile dflags
780 location4 | Just ofile <- expl_o_file
781 , isNoLink (ghcLink dflags)
782 = location3 { ml_obj_file = ofile }
783 | otherwise = location3
785 o_file = ml_obj_file location4 -- The real object file
788 -- Figure out if the source has changed, for recompilation avoidance.
790 -- Setting source_unchanged to True means that M.o seems
791 -- to be up to date wrt M.hs; so no need to recompile unless imports have
792 -- changed (which the compiler itself figures out).
793 -- Setting source_unchanged to False tells the compiler that M.o is out of
794 -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
795 src_timestamp <- liftIO $ getModificationTime (basename <.> suff)
797 let force_recomp = dopt Opt_ForceRecomp dflags
799 if force_recomp || not (isStopLn stop)
800 -- Set source_unchanged to False unconditionally if
801 -- (a) recompilation checker is off, or
802 -- (b) we aren't going all the way to .o file (e.g. ghc -S)
804 -- Otherwise look at file modification dates
805 else do o_file_exists <- liftIO $ doesFileExist o_file
807 then return False -- Need to recompile
808 else do t2 <- liftIO $ getModificationTime o_file
809 if t2 > src_timestamp
814 let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
815 let next_phase = hscNextPhase dflags src_flavour hsc_lang
816 output_fn <- liftIO $ get_output_fn dflags next_phase (Just location4)
818 let dflags' = dflags { hscTarget = hsc_lang,
819 hscOutName = output_fn,
820 extCoreName = basename ++ ".hcr" }
822 let hsc_env' = hsc_env {hsc_dflags = dflags'}
824 -- Tell the finder cache about this module
825 mod <- liftIO $ addHomeModuleToFinder hsc_env' mod_name location4
827 -- Make the ModSummary to hand to hscMain
829 mod_summary = ModSummary { ms_mod = mod,
830 ms_hsc_src = src_flavour,
831 ms_hspp_file = input_fn,
832 ms_hspp_opts = dflags,
833 ms_hspp_buf = hspp_buf,
834 ms_location = location4,
835 ms_hs_date = src_timestamp,
836 ms_obj_date = Nothing,
838 ms_srcimps = src_imps }
841 result <- hscCompileOneShot hsc_env'
842 mod_summary source_unchanged
844 Nothing -- No "module i of n" progress info
848 -> do liftIO $ SysTools.touch dflags' "Touching object file" o_file
849 -- The .o file must have a later modification date
850 -- than the source file (else we wouldn't be in HscNoRecomp)
851 -- but we touch it anyway, to keep 'make' happy (we think).
852 return (StopLn, dflags', Just location4, o_file)
853 (HscRecomp hasStub _)
855 do stub_o <- compileStub hsc_env' mod location4
856 liftIO $ consIORef v_Ld_inputs stub_o
857 -- In the case of hs-boot files, generate a dummy .o-boot
858 -- stamp file for the benefit of Make
859 when (isHsBoot src_flavour) $
860 liftIO $ SysTools.touch dflags' "Touching object file" o_file
861 return (next_phase, dflags', Just location4, output_fn)
863 -----------------------------------------------------------------------------
866 runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
868 let dflags = hsc_dflags hsc_env
869 output_fn <- liftIO $ get_output_fn dflags Cmm maybe_loc
870 liftIO $ doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
871 return (Cmm, dflags, maybe_loc, output_fn)
873 runPhase Cmm stop hsc_env basename _ input_fn get_output_fn maybe_loc
875 let dflags = hsc_dflags hsc_env
876 let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
877 let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
878 output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
880 let dflags' = dflags { hscTarget = hsc_lang,
881 hscOutName = output_fn,
882 extCoreName = basename ++ ".hcr" }
883 let hsc_env' = hsc_env {hsc_dflags = dflags'}
885 hscCmmFile hsc_env' input_fn
887 -- XXX: catch errors above and convert them into ghcError? Original
890 --when (not ok) $ ghcError (PhaseFailed "cmm" (ExitFailure 1))
892 return (next_phase, dflags, maybe_loc, output_fn)
894 -----------------------------------------------------------------------------
897 -- we don't support preprocessing .c files (with -E) now. Doing so introduces
898 -- way too many hacks, and I can't say I've ever used it anyway.
900 runPhase cc_phase _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
901 | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
902 = do let dflags = hsc_dflags hsc_env
903 let cc_opts = getOpts dflags opt_c
904 hcc = cc_phase `eqPhase` HCc
906 let cmdline_include_paths = includePaths dflags
908 -- HC files have the dependent packages stamped into them
909 pkgs <- if hcc then liftIO (getHCFilePackages input_fn) else return []
911 -- add package include paths even if we're just compiling .c
912 -- files; this is the Value Add(TM) that using ghc instead of
914 pkg_include_dirs <- liftIO $ getPackageIncludePath dflags pkgs
915 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
916 (cmdline_include_paths ++ pkg_include_dirs)
918 let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
919 gcc_extra_viac_flags <- liftIO $ getExtraViaCOpts dflags
920 let pic_c_flags = picCCOpts dflags
922 let verb = getVerbFlag dflags
924 -- cc-options are not passed when compiling .hc files. Our
925 -- hc code doesn't not #include any header files anyway, so these
926 -- options aren't necessary.
928 if cc_phase `eqPhase` HCc
930 else liftIO $ getPackageExtraCcOpts dflags pkgs
932 #ifdef darwin_TARGET_OS
933 pkg_framework_paths <- liftIO $ getPackageFrameworkPath dflags pkgs
934 let cmdline_framework_paths = frameworkPaths dflags
935 let framework_paths = map ("-F"++)
936 (cmdline_framework_paths ++ pkg_framework_paths)
939 let split_objs = dopt Opt_SplitObjs dflags
940 split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
943 let cc_opt | optLevel dflags >= 2 = "-O2"
948 let mangle = dopt Opt_DoAsmMangling dflags
950 | hcc && mangle = Mangle
952 output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
957 -- on x86 the floating point regs have greater precision
958 -- than a double, which leads to unpredictable results.
959 -- By default, we turn this off with -ffloat-store unless
960 -- the user specified -fexcess-precision.
961 (if dopt Opt_ExcessPrecision dflags
963 else [ "-ffloat-store" ]) ++
965 -- gcc's -fstrict-aliasing allows two accesses to memory
966 -- to be considered non-aliasing if they have different types.
967 -- This interacts badly with the C code we generate, which is
968 -- very weakly typed, being derived from C--.
969 ["-fno-strict-aliasing"]
973 liftIO $ SysTools.runCc dflags (
974 -- force the C compiler to interpret this file as C when
975 -- compiling .hc files, by adding the -x c option.
976 -- Also useful for plain .c files, just in case GHC saw a
978 [ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
979 then SysTools.Option "c++" else SysTools.Option "c"] ++
980 [ SysTools.FileOption "" input_fn
981 , SysTools.Option "-o"
982 , SysTools.FileOption "" output_fn
984 ++ map SysTools.Option (
987 #ifdef sparc_TARGET_ARCH
988 -- We only support SparcV9 and better because V8 lacks an atomic CAS
989 -- instruction. Note that the user can still override this
990 -- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
991 -- regardless of the ordering.
993 -- This is a temporary hack.
1001 then gcc_extra_viac_flags
1002 else filter (=="-fwrapv")
1003 gcc_extra_viac_flags
1004 -- still want -fwrapv even for unreg'd
1009 ++ [ verb, "-S", "-Wimplicit", cc_opt ]
1010 ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
1011 #ifdef darwin_TARGET_OS
1017 ++ pkg_extra_cc_opts
1020 return (next_phase, dflags, maybe_loc, output_fn)
1022 -- ToDo: postprocess the output from gcc
1024 -----------------------------------------------------------------------------
1027 runPhase Mangle _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
1028 = do let dflags = hsc_dflags hsc_env
1029 let mangler_opts = getOpts dflags opt_m
1031 #if i386_TARGET_ARCH
1032 machdep_opts <- return [ show (stolen_x86_regs dflags) ]
1034 machdep_opts <- return []
1037 let split = dopt Opt_SplitObjs dflags
1039 | split = SplitMangle
1041 output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
1043 liftIO $ SysTools.runMangle dflags (map SysTools.Option mangler_opts
1044 ++ [ SysTools.FileOption "" input_fn
1045 , SysTools.FileOption "" output_fn
1047 ++ map SysTools.Option machdep_opts)
1049 return (next_phase, dflags, maybe_loc, output_fn)
1051 -----------------------------------------------------------------------------
1054 runPhase SplitMangle _stop hsc_env _basename _suff input_fn _get_output_fn maybe_loc
1056 do -- tmp_pfx is the prefix used for the split .s files
1057 -- We also use it as the file to contain the no. of split .s files (sigh)
1058 let dflags = hsc_dflags hsc_env
1059 split_s_prefix <- SysTools.newTempName dflags "split"
1060 let n_files_fn = split_s_prefix
1062 SysTools.runSplit dflags
1063 [ SysTools.FileOption "" input_fn
1064 , SysTools.FileOption "" split_s_prefix
1065 , SysTools.FileOption "" n_files_fn
1068 -- Save the number of split files for future references
1069 s <- readFile n_files_fn
1070 let n_files = read s :: Int
1071 dflags' = dflags { splitInfo = Just (split_s_prefix, n_files) }
1073 -- Remember to delete all these files
1074 addFilesToClean dflags' [ split_s_prefix ++ "__" ++ show n ++ ".s"
1075 | n <- [1..n_files]]
1077 return (SplitAs, dflags', maybe_loc, "**splitmangle**")
1078 -- we don't use the filename
1080 -----------------------------------------------------------------------------
1083 runPhase As _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
1085 do let dflags = hsc_dflags hsc_env
1086 let as_opts = getOpts dflags opt_a
1087 let cmdline_include_paths = includePaths dflags
1089 output_fn <- get_output_fn dflags StopLn maybe_loc
1091 -- we create directories for the object file, because it
1092 -- might be a hierarchical module.
1093 createDirectoryHierarchy (takeDirectory output_fn)
1095 SysTools.runAs dflags
1096 (map SysTools.Option as_opts
1097 ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
1098 #ifdef sparc_TARGET_ARCH
1099 -- We only support SparcV9 and better because V8 lacks an atomic CAS
1100 -- instruction so we have to make sure that the assembler accepts the
1101 -- instruction set. Note that the user can still override this
1102 -- (e.g., -mcpu=ultrasparc). GCC picks the "best" -mcpu flag
1103 -- regardless of the ordering.
1105 -- This is a temporary hack.
1106 ++ [ SysTools.Option "-mcpu=v9" ]
1108 ++ [ SysTools.Option "-c"
1109 , SysTools.FileOption "" input_fn
1110 , SysTools.Option "-o"
1111 , SysTools.FileOption "" output_fn
1114 return (StopLn, dflags, maybe_loc, output_fn)
1117 runPhase SplitAs _stop hsc_env _basename _suff _input_fn get_output_fn maybe_loc
1119 let dflags = hsc_dflags hsc_env
1120 output_fn <- get_output_fn dflags StopLn maybe_loc
1122 let base_o = dropExtension output_fn
1123 split_odir = base_o ++ "_split"
1124 osuf = objectSuf dflags
1126 createDirectoryHierarchy split_odir
1128 -- remove M_split/ *.o, because we're going to archive M_split/ *.o
1129 -- later and we don't want to pick up any old objects.
1130 fs <- getDirectoryContents split_odir
1131 mapM_ removeFile $ map (split_odir </>) $ filter (osuf `isSuffixOf`) fs
1133 let as_opts = getOpts dflags opt_a
1135 let (split_s_prefix, n) = case splitInfo dflags of
1136 Nothing -> panic "No split info"
1139 let split_s n = split_s_prefix ++ "__" ++ show n <.> "s"
1140 split_obj n = split_odir </>
1141 takeFileName base_o ++ "__" ++ show n <.> osuf
1144 = SysTools.runAs dflags
1145 (map SysTools.Option as_opts ++
1146 [ SysTools.Option "-c"
1147 , SysTools.Option "-o"
1148 , SysTools.FileOption "" (split_obj n)
1149 , SysTools.FileOption "" (split_s n)
1152 mapM_ assemble_file [1..n]
1154 -- and join the split objects into a single object file:
1155 let ld_r args = SysTools.runLink dflags ([
1156 SysTools.Option "-nostdlib",
1157 SysTools.Option "-nodefaultlibs",
1158 SysTools.Option "-Wl,-r",
1159 SysTools.Option ld_x_flag,
1160 SysTools.Option "-o",
1161 SysTools.FileOption "" output_fn ] ++ args)
1162 ld_x_flag | null cLD_X = ""
1163 | otherwise = "-Wl,-x"
1165 if cLdIsGNULd == "YES"
1167 let script = split_odir </> "ld.script"
1169 "INPUT(" ++ unwords (map split_obj [1..n]) ++ ")"
1170 ld_r [SysTools.FileOption "" script]
1172 ld_r (map (SysTools.FileOption "" . split_obj) [1..n])
1174 return (StopLn, dflags, maybe_loc, output_fn)
1176 -- warning suppression
1177 runPhase other _stop _dflags _basename _suff _input_fn _get_output_fn _maybe_loc =
1178 panic ("runPhase: don't know how to run phase " ++ show other)
1179 -----------------------------------------------------------------------------
1180 -- MoveBinary sort-of-phase
1181 -- After having produced a binary, move it somewhere else and generate a
1182 -- wrapper script calling the binary. Currently, we need this only in
1183 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
1184 -- central directory.
1185 -- This is called from linkBinary below, after linking. I haven't made it
1186 -- a separate phase to minimise interfering with other modules, and
1187 -- we don't need the generality of a phase (MoveBinary is always
1188 -- done after linking and makes only sense in a parallel setup) -- HWL
1190 runPhase_MoveBinary :: DynFlags -> FilePath -> [PackageId] -> IO Bool
1191 runPhase_MoveBinary dflags input_fn dep_packages
1192 | WayPar `elem` (wayNames dflags) && not opt_Static =
1193 panic ("Don't know how to combine PVM wrapper and dynamic wrapper")
1194 | WayPar `elem` (wayNames dflags) = do
1195 let sysMan = pgm_sysman dflags
1196 pvm_root <- getEnv "PVM_ROOT"
1197 pvm_arch <- getEnv "PVM_ARCH"
1199 pvm_executable_base = "=" ++ input_fn
1200 pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
1201 -- nuke old binary; maybe use configur'ed names for cp and rm?
1202 tryIO (removeFile pvm_executable)
1203 -- move the newly created binary into PVM land
1204 copy dflags "copying PVM executable" input_fn pvm_executable
1205 -- generate a wrapper script for running a parallel prg under PVM
1206 writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
1209 case (dynLibLoader dflags) of
1212 let (o_base, o_ext) = splitExtension input_fn
1213 let wrapped_executable | o_ext == "exe" = (o_base ++ ".dyn") <.> o_ext
1214 | otherwise = input_fn ++ ".dyn"
1215 behaviour <- wrapper_behaviour dflags wrapmode dep_packages
1217 -- THINKME isn't this possible to do a bit nicer?
1218 let behaviour' = concatMap (\x -> if x=='\\' then "\\\\" else [x]) behaviour
1219 renameFile input_fn wrapped_executable
1220 let rtsDetails = (getPackageDetails (pkgState dflags) rtsPackageId);
1221 SysTools.runCc dflags
1222 ([ SysTools.FileOption "" ((head (libraryDirs rtsDetails)) ++ "/dyn-wrapper.c")
1223 , SysTools.Option ("-DBEHAVIOUR=\"" ++ behaviour' ++ "\"")
1224 , SysTools.Option "-o"
1225 , SysTools.FileOption "" input_fn
1226 ] ++ map (SysTools.FileOption "-I") (includeDirs rtsDetails))
1229 | otherwise = return True
1231 wrapper_behaviour :: DynFlags -> Maybe [Char] -> [PackageId] -> IO [Char]
1232 wrapper_behaviour dflags mode dep_packages =
1233 let seperateBySemiColon strs = tail $ concatMap (';':) strs
1236 pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1237 return ('H' : (seperateBySemiColon pkg_lib_paths))
1239 allpkg <- getPreloadPackagesAnd dflags dep_packages
1240 putStrLn (unwords (map (packageIdString . packageConfigId) allpkg))
1241 return $ 'F':s ++ ';':(seperateBySemiColon (map (packageIdString . packageConfigId) allpkg))
1243 -- generates a Perl skript starting a parallel prg under PVM
1244 mk_pvm_wrapper_script :: String -> String -> String -> String
1245 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
1247 "eval 'exec perl -S $0 ${1+\"$@\"}'",
1248 " if $running_under_some_shell;",
1249 "# =!=!=!=!=!=!=!=!=!=!=!",
1250 "# This script is automatically generated: DO NOT EDIT!!!",
1251 "# Generated by Glasgow Haskell Compiler",
1252 "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
1254 "$pvm_executable = '" ++ pvm_executable ++ "';",
1255 "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
1256 "$SysMan = '" ++ sysMan ++ "';",
1258 {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
1259 "# first, some magical shortcuts to run "commands" on the binary",
1260 "# (which is hidden)",
1261 "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
1262 " local($cmd) = $1;",
1263 " system("$cmd $pvm_executable");",
1264 " exit(0); # all done",
1267 "# Now, run the real binary; process the args first",
1268 "$ENV{'PE'} = $pvm_executable_base;", -- ++ pvm_executable_base,
1270 "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
1271 "@nonPVM_args = ();",
1272 "$in_RTS_args = 0;",
1274 "args: while ($a = shift(@ARGV)) {",
1275 " if ( $a eq '+RTS' ) {",
1276 " $in_RTS_args = 1;",
1277 " } elsif ( $a eq '-RTS' ) {",
1278 " $in_RTS_args = 0;",
1280 " if ( $a eq '-d' && $in_RTS_args ) {",
1282 " } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
1283 " $nprocessors = $1;",
1284 " } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
1285 " $nprocessors = $1;",
1287 " push(@nonPVM_args, $a);",
1291 "local($return_val) = 0;",
1292 "# Start the parallel execution by calling SysMan",
1293 "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
1294 "$return_val = $?;",
1295 "# ToDo: fix race condition moving files and flushing them!!",
1296 "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
1297 "exit($return_val);"
1300 -----------------------------------------------------------------------------
1301 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
1303 getHCFilePackages :: FilePath -> IO [PackageId]
1304 getHCFilePackages filename =
1305 Exception.bracket (openFile filename ReadMode) hClose $ \h -> do
1308 '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
1309 return (map stringToPackageId (words rest))
1313 -----------------------------------------------------------------------------
1314 -- Static linking, of .o files
1316 -- The list of packages passed to link is the list of packages on
1317 -- which this program depends, as discovered by the compilation
1318 -- manager. It is combined with the list of packages that the user
1319 -- specifies on the command line with -package flags.
1321 -- In one-shot linking mode, we can't discover the package
1322 -- dependencies (because we haven't actually done any compilation or
1323 -- read any interface files), so the user must explicitly specify all
1326 linkBinary :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
1327 linkBinary dflags o_files dep_packages = do
1328 let verb = getVerbFlag dflags
1329 output_fn = exeFileName dflags
1331 -- get the full list of packages to link with, by combining the
1332 -- explicit packages with the auto packages and all of their
1333 -- dependencies, and eliminating duplicates.
1335 pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1336 let pkg_lib_path_opts = concat (map get_pkg_lib_path_opts pkg_lib_paths)
1337 #ifdef linux_TARGET_OS
1338 get_pkg_lib_path_opts l | (dynLibLoader dflags)==SystemDependent && not opt_Static = ["-L" ++ l, "-Wl,-rpath", "-Wl," ++ l]
1339 | otherwise = ["-L" ++ l]
1341 get_pkg_lib_path_opts l = ["-L" ++ l]
1344 let lib_paths = libraryPaths dflags
1345 let lib_path_opts = map ("-L"++) lib_paths
1347 pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1349 #ifdef darwin_TARGET_OS
1350 pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1351 let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1353 let framework_paths = frameworkPaths dflags
1354 framework_path_opts = map ("-F"++) framework_paths
1356 pkg_frameworks <- getPackageFrameworks dflags dep_packages
1357 let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1359 let frameworks = cmdlineFrameworks dflags
1360 framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1361 -- reverse because they're added in reverse order from the cmd line
1363 #ifdef mingw32_TARGET_OS
1364 let dynMain = if not opt_Static then
1365 (head (libraryDirs (getPackageDetails (pkgState dflags) rtsPackageId))) ++ "/Main.dyn_o"
1369 -- probably _stub.o files
1370 extra_ld_inputs <- readIORef v_Ld_inputs
1372 -- opts from -optl-<blah> (including -l<blah> options)
1373 let extra_ld_opts = getOpts dflags opt_l
1375 let ways = wayNames dflags
1377 -- Here are some libs that need to be linked at the *end* of
1378 -- the command line, because they contain symbols that are referred to
1379 -- by the RTS. We can't therefore use the ordinary way opts for these.
1381 debug_opts | WayDebug `elem` ways = [
1382 #if defined(HAVE_LIBBFD)
1389 thread_opts | WayThreaded `elem` ways = [
1390 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1393 #if defined(osf3_TARGET_OS)
1399 rc_objs <- maybeCreateManifest dflags output_fn
1401 let (md_c_flags, _) = machdepCCOpts dflags
1402 SysTools.runLink dflags (
1403 [ SysTools.Option verb
1404 , SysTools.Option "-o"
1405 , SysTools.FileOption "" output_fn
1407 ++ map SysTools.Option (
1410 #ifdef mingw32_TARGET_OS
1417 #ifdef darwin_TARGET_OS
1418 ++ framework_path_opts
1421 ++ pkg_lib_path_opts
1423 #ifdef darwin_TARGET_OS
1424 ++ pkg_framework_path_opts
1425 ++ pkg_framework_opts
1431 -- parallel only: move binary to another dir -- HWL
1432 success <- runPhase_MoveBinary dflags output_fn dep_packages
1433 if success then return ()
1434 else ghcError (InstallationError ("cannot move binary"))
1437 exeFileName :: DynFlags -> FilePath
1439 | Just s <- outputFile dflags =
1440 #if defined(mingw32_HOST_OS)
1441 if null (takeExtension s)
1448 #if defined(mingw32_HOST_OS)
1456 -> FilePath -- filename of executable
1457 -> IO [FilePath] -- extra objects to embed, maybe
1458 #ifndef mingw32_TARGET_OS
1459 maybeCreateManifest _ _ = do
1462 maybeCreateManifest dflags exe_filename = do
1463 if not (dopt Opt_GenManifest dflags) then return [] else do
1465 let manifest_filename = exe_filename <.> "manifest"
1467 writeFile manifest_filename $
1468 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n"++
1469 " <assembly xmlns=\"urn:schemas-microsoft-com:asm.v1\" manifestVersion=\"1.0\">\n"++
1470 " <assemblyIdentity version=\"1.0.0.0\"\n"++
1471 " processorArchitecture=\"X86\"\n"++
1472 " name=\"" ++ dropExtension exe_filename ++ "\"\n"++
1473 " type=\"win32\"/>\n\n"++
1474 " <trustInfo xmlns=\"urn:schemas-microsoft-com:asm.v3\">\n"++
1476 " <requestedPrivileges>\n"++
1477 " <requestedExecutionLevel level=\"asInvoker\" uiAccess=\"false\"/>\n"++
1478 " </requestedPrivileges>\n"++
1483 -- Windows will find the manifest file if it is named foo.exe.manifest.
1484 -- However, for extra robustness, and so that we can move the binary around,
1485 -- we can embed the manifest in the binary itself using windres:
1486 if not (dopt Opt_EmbedManifest dflags) then return [] else do
1488 rc_filename <- newTempName dflags "rc"
1489 rc_obj_filename <- newTempName dflags (objectSuf dflags)
1491 writeFile rc_filename $
1492 "1 24 MOVEABLE PURE " ++ show manifest_filename ++ "\n"
1493 -- magic numbers :-)
1494 -- show is a bit hackish above, but we need to escape the
1495 -- backslashes in the path.
1497 let wr_opts = getOpts dflags opt_windres
1498 runWindres dflags $ map SysTools.Option $
1499 ["--input="++rc_filename,
1500 "--output="++rc_obj_filename,
1501 "--output-format=coff"]
1503 -- no FileOptions here: windres doesn't like seeing
1504 -- backslashes, apparently
1506 return [rc_obj_filename]
1510 linkDynLib :: DynFlags -> [String] -> [PackageId] -> IO ()
1511 linkDynLib dflags o_files dep_packages = do
1512 let verb = getVerbFlag dflags
1513 let o_file = outputFile dflags
1515 -- We don't want to link our dynamic libs against the RTS package,
1516 -- because the RTS lib comes in several flavours and we want to be
1517 -- able to pick the flavour when a binary is linked.
1518 pkgs <- getPreloadPackagesAnd dflags dep_packages
1520 -- On Windows we need to link the RTS import lib as Windows does
1521 -- not allow undefined symbols.
1522 #if !defined(mingw32_HOST_OS)
1523 let pkgs_no_rts = filter ((/= rtsPackageId) . packageConfigId) pkgs
1525 let pkgs_no_rts = pkgs
1527 let pkg_lib_paths = collectLibraryPaths pkgs_no_rts
1528 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1530 let lib_paths = libraryPaths dflags
1531 let lib_path_opts = map ("-L"++) lib_paths
1533 let pkg_link_opts = collectLinkOpts dflags pkgs_no_rts
1535 -- probably _stub.o files
1536 extra_ld_inputs <- readIORef v_Ld_inputs
1538 let (md_c_flags, _) = machdepCCOpts dflags
1539 let extra_ld_opts = getOpts dflags opt_l
1540 #if defined(mingw32_HOST_OS)
1541 -----------------------------------------------------------------------------
1543 -----------------------------------------------------------------------------
1544 let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1546 SysTools.runLink dflags
1547 ([ SysTools.Option verb
1548 , SysTools.Option "-o"
1549 , SysTools.FileOption "" output_fn
1550 , SysTools.Option "-shared"
1551 , SysTools.FileOption "-Wl,--out-implib=" (output_fn ++ ".a")
1553 ++ map (SysTools.FileOption "") o_files
1554 ++ map SysTools.Option (
1559 ++ pkg_lib_path_opts
1562 #elif defined(darwin_TARGET_OS)
1563 -----------------------------------------------------------------------------
1564 -- Making a darwin dylib
1565 -----------------------------------------------------------------------------
1566 -- About the options used for Darwin:
1568 -- Apple's way of saying -shared
1569 -- -undefined dynamic_lookup:
1570 -- Without these options, we'd have to specify the correct dependencies
1571 -- for each of the dylibs. Note that we could (and should) do without this
1572 -- for all libraries except the RTS; all we need to do is to pass the
1573 -- correct HSfoo_dyn.dylib files to the link command.
1574 -- This feature requires Mac OS X 10.3 or later; there is a similar feature,
1575 -- -flat_namespace -undefined suppress, which works on earlier versions,
1576 -- but it has other disadvantages.
1578 -- Build the dynamic library as a single "module", i.e. no dynamic binding
1579 -- nonsense when referring to symbols from within the library. The NCG
1580 -- assumes that this option is specified (on i386, at least).
1581 -- -Wl,-macosx_version_min -Wl,10.3
1582 -- Tell the linker its safe to assume that the library will run on 10.3 or
1583 -- later, so that it will not complain about the use of the option
1584 -- -undefined dynamic_lookup above.
1586 -- Causes the dynamic linker to ignore the DYLD_LIBRARY_PATH when loading
1587 -- this lib and instead look for it at its absolute path.
1588 -- When installing the .dylibs (see target.mk), we'll change that path to
1589 -- point to the place they are installed. Therefore, we won't have to set
1590 -- up DYLD_LIBRARY_PATH specifically for ghc.
1591 -----------------------------------------------------------------------------
1593 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1595 pwd <- getCurrentDirectory
1596 SysTools.runLink dflags
1597 ([ SysTools.Option verb
1598 , SysTools.Option "-dynamiclib"
1599 , SysTools.Option "-o"
1600 , SysTools.FileOption "" output_fn
1602 ++ map SysTools.Option (
1605 ++ [ "-undefined", "dynamic_lookup", "-single_module", "-Wl,-macosx_version_min","-Wl,10.3", "-install_name " ++ (pwd </> output_fn) ]
1609 ++ pkg_lib_path_opts
1613 -----------------------------------------------------------------------------
1615 -----------------------------------------------------------------------------
1617 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1619 SysTools.runLink dflags
1620 ([ SysTools.Option verb
1621 , SysTools.Option "-o"
1622 , SysTools.FileOption "" output_fn
1624 ++ map SysTools.Option (
1627 ++ [ "-shared", "-Wl,-Bsymbolic" ] -- we need symbolic linking to resolve non-PIC intra-package-relocations
1631 ++ pkg_lib_path_opts
1635 -- -----------------------------------------------------------------------------
1638 doCpp :: DynFlags -> Bool -> Bool -> FilePath -> FilePath -> IO ()
1639 doCpp dflags raw include_cc_opts input_fn output_fn = do
1640 let hscpp_opts = getOpts dflags opt_P
1641 let cmdline_include_paths = includePaths dflags
1643 pkg_include_dirs <- getPackageIncludePath dflags []
1644 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1645 (cmdline_include_paths ++ pkg_include_dirs)
1647 let verb = getVerbFlag dflags
1650 | not include_cc_opts = []
1651 | otherwise = (optc ++ md_c_flags)
1653 optc = getOpts dflags opt_c
1654 (md_c_flags, _) = machdepCCOpts dflags
1656 let cpp_prog args | raw = SysTools.runCpp dflags args
1657 | otherwise = SysTools.runCc dflags (SysTools.Option "-E" : args)
1660 [ "-D" ++ HOST_OS ++ "_BUILD_OS=1",
1661 "-D" ++ HOST_ARCH ++ "_BUILD_ARCH=1",
1662 "-D" ++ TARGET_OS ++ "_HOST_OS=1",
1663 "-D" ++ TARGET_ARCH ++ "_HOST_ARCH=1" ]
1664 -- remember, in code we *compile*, the HOST is the same our TARGET,
1665 -- and BUILD is the same as our HOST.
1667 cpp_prog ([SysTools.Option verb]
1668 ++ map SysTools.Option include_paths
1669 ++ map SysTools.Option hsSourceCppOpts
1670 ++ map SysTools.Option hscpp_opts
1671 ++ map SysTools.Option cc_opts
1672 ++ map SysTools.Option target_defs
1673 ++ [ SysTools.Option "-x"
1674 , SysTools.Option "c"
1675 , SysTools.Option input_fn
1676 -- We hackily use Option instead of FileOption here, so that the file
1677 -- name is not back-slashed on Windows. cpp is capable of
1678 -- dealing with / in filenames, so it works fine. Furthermore
1679 -- if we put in backslashes, cpp outputs #line directives
1680 -- with *double* backslashes. And that in turn means that
1681 -- our error messages get double backslashes in them.
1682 -- In due course we should arrange that the lexer deals
1683 -- with these \\ escapes properly.
1684 , SysTools.Option "-o"
1685 , SysTools.FileOption "" output_fn
1688 cHaskell1Version :: String
1689 cHaskell1Version = "5" -- i.e., Haskell 98
1691 hsSourceCppOpts :: [String]
1692 -- Default CPP defines in Haskell source
1694 [ "-D__HASKELL1__="++cHaskell1Version
1695 , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
1697 , "-D__CONCURRENT_HASKELL__"
1701 -- -----------------------------------------------------------------------------
1704 hscNextPhase :: DynFlags -> HscSource -> HscTarget -> Phase
1705 hscNextPhase _ HsBootFile _ = StopLn
1706 hscNextPhase dflags _ hsc_lang =
1709 HscAsm | dopt Opt_SplitObjs dflags -> SplitMangle
1711 HscNothing -> StopLn
1712 HscInterpreted -> StopLn
1716 hscMaybeAdjustTarget :: DynFlags -> Phase -> HscSource -> HscTarget -> HscTarget
1717 hscMaybeAdjustTarget dflags stop _ current_hsc_lang
1720 keep_hc = dopt Opt_KeepHcFiles dflags
1722 -- don't change the lang if we're interpreting
1723 | current_hsc_lang == HscInterpreted = current_hsc_lang
1725 -- force -fvia-C if we are being asked for a .hc file
1726 | HCc <- stop = HscC
1728 -- otherwise, stick to the plan
1729 | otherwise = current_hsc_lang