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 -- compile the _stub.c file w/ gcc
264 let (stub_c,_,stub_o) = mkStubPaths (hsc_dflags hsc_env)
265 (moduleName mod) location
267 runPipeline StopLn hsc_env (stub_c,Nothing) Nothing
268 (SpecificFile stub_o) Nothing{-no ModLocation-}
273 -- ---------------------------------------------------------------------------
276 link :: GhcLink -- interactive or batch
277 -> DynFlags -- dynamic flags
278 -> Bool -- attempt linking in batch mode?
279 -> HomePackageTable -- what to link
282 -- For the moment, in the batch linker, we don't bother to tell doLink
283 -- which packages to link -- it just tries all that are available.
284 -- batch_attempt_linking should only be *looked at* in batch mode. It
285 -- should only be True if the upsweep was successful and someone
286 -- exports main, i.e., we have good reason to believe that linking
290 link LinkInMemory _ _ _
291 = do -- Not Linking...(demand linker will do the job)
298 link LinkBinary dflags batch_attempt_linking hpt
299 | batch_attempt_linking
302 home_mod_infos = eltsUFM hpt
304 -- the packages we depend on
305 pkg_deps = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
307 -- the linkables to link
308 linkables = map (expectJust "link".hm_linkable) home_mod_infos
310 debugTraceMsg dflags 3 (text "link: linkables are ..." $$ vcat (map ppr linkables))
312 -- check for the -no-link flag
313 if isNoLink (ghcLink dflags)
314 then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
318 let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
319 obj_files = concatMap getOfiles linkables
321 exe_file = exeFileName dflags
323 linking_needed <- linkingNeeded dflags linkables pkg_deps
325 if not (dopt Opt_ForceRecomp dflags) && not linking_needed
326 then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
330 debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
333 -- Don't showPass in Batch mode; doLink will do that for us.
334 let link = case ghcLink dflags of
335 LinkBinary -> linkBinary
336 LinkDynLib -> linkDynLib
337 other -> panicBadLink other
338 link dflags obj_files pkg_deps
340 debugTraceMsg dflags 3 (text "link: done")
342 -- linkBinary only returns if it succeeds
346 = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
347 text " Main.main not exported; not linking.")
350 -- warning suppression
351 link other _ _ _ = panicBadLink other
353 panicBadLink :: GhcLink -> a
354 panicBadLink other = panic ("link: GHC not built to link this way: " ++
358 linkingNeeded :: DynFlags -> [Linkable] -> [PackageId] -> IO Bool
359 linkingNeeded dflags linkables pkg_deps = do
360 -- if the modification time on the executable is later than the
361 -- modification times on all of the objects and libraries, then omit
362 -- linking (unless the -fforce-recomp flag was given).
363 let exe_file = exeFileName dflags
364 e_exe_time <- IO.try $ getModificationTime exe_file
366 Left _ -> return True
368 -- first check object files and extra_ld_inputs
369 extra_ld_inputs <- readIORef v_Ld_inputs
370 e_extra_times <- mapM (IO.try . getModificationTime) extra_ld_inputs
371 let (errs,extra_times) = splitEithers e_extra_times
372 let obj_times = map linkableTime linkables ++ extra_times
373 if not (null errs) || any (t <) obj_times
377 -- next, check libraries. XXX this only checks Haskell libraries,
378 -- not extra_libraries or -l things from the command line.
379 let pkg_map = pkgIdMap (pkgState dflags)
380 pkg_hslibs = [ (libraryDirs c, lib)
381 | Just c <- map (lookupPackage pkg_map) pkg_deps,
382 lib <- packageHsLibs dflags c ]
384 pkg_libfiles <- mapM (uncurry findHSLib) pkg_hslibs
385 if any isNothing pkg_libfiles then return True else do
386 e_lib_times <- mapM (IO.try . getModificationTime)
387 (catMaybes pkg_libfiles)
388 let (lib_errs,lib_times) = splitEithers e_lib_times
389 if not (null lib_errs) || any (t <) lib_times
393 findHSLib :: [String] -> String -> IO (Maybe FilePath)
394 findHSLib dirs lib = do
395 let batch_lib_file = "lib" ++ lib <.> "a"
396 found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
399 (x:_) -> return (Just x)
401 -- -----------------------------------------------------------------------------
402 -- Compile files in one-shot mode.
404 oneShot :: GhcMonad m =>
405 HscEnv -> Phase -> [(String, Maybe Phase)] -> m ()
406 oneShot hsc_env stop_phase srcs = do
407 o_files <- mapM (compileFile hsc_env stop_phase) srcs
408 liftIO $ doLink (hsc_dflags hsc_env) stop_phase o_files
410 compileFile :: GhcMonad m =>
411 HscEnv -> Phase -> (FilePath, Maybe Phase) -> m FilePath
412 compileFile hsc_env stop_phase (src, mb_phase) = do
413 exists <- liftIO $ doesFileExist src
415 ghcError (CmdLineError ("does not exist: " ++ src))
418 dflags = hsc_dflags hsc_env
419 split = dopt Opt_SplitObjs dflags
420 mb_o_file = outputFile dflags
421 ghc_link = ghcLink dflags -- Set by -c or -no-link
423 -- When linking, the -o argument refers to the linker's output.
424 -- otherwise, we use it as the name for the pipeline's output.
426 | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
427 -- -o foo applies to linker
428 | Just o_file <- mb_o_file = SpecificFile o_file
429 -- -o foo applies to the file we are compiling now
430 | otherwise = Persistent
432 stop_phase' = case stop_phase of
433 As | split -> SplitAs
436 ( _, out_file) <- runPipeline stop_phase' hsc_env
437 (src, mb_phase) Nothing output
438 Nothing{-no ModLocation-}
442 doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
443 doLink dflags stop_phase o_files
444 | not (isStopLn stop_phase)
445 = return () -- We stopped before the linking phase
448 = case ghcLink dflags of
450 LinkBinary -> linkBinary dflags o_files link_pkgs
451 LinkDynLib -> linkDynLib dflags o_files []
452 other -> panicBadLink other
454 -- Always link in the haskell98 package for static linking. Other
455 -- packages have to be specified via the -package flag.
457 | dopt Opt_AutoLinkPackages dflags = [haskell98PackageId]
461 -- ---------------------------------------------------------------------------
465 -- ^ Output should be to a temporary file: we're going to
466 -- run more compilation steps on this output later.
468 -- ^ We want a persistent file, i.e. a file in the current directory
469 -- derived from the input filename, but with the appropriate extension.
470 -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
471 | SpecificFile FilePath
472 -- ^ The output must go into the specified file.
474 -- | Run a compilation pipeline, consisting of multiple phases.
476 -- This is the interface to the compilation pipeline, which runs
477 -- a series of compilation steps on a single source file, specifying
478 -- at which stage to stop.
480 -- The DynFlags can be modified by phases in the pipeline (eg. by
481 -- GHC_OPTIONS pragmas), and the changes affect later phases in the
485 Phase -- ^ When to stop
486 -> HscEnv -- ^ Compilation environment
487 -> (FilePath,Maybe Phase) -- ^ Input filename (and maybe -x suffix)
488 -> Maybe FilePath -- ^ original basename (if different from ^^^)
489 -> PipelineOutput -- ^ Output filename
490 -> Maybe ModLocation -- ^ A ModLocation, if this is a Haskell module
491 -> m (DynFlags, FilePath) -- ^ (final flags, output filename)
493 runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
495 let dflags0 = hsc_dflags hsc_env0
496 (input_basename, suffix) = splitExtension input_fn
497 suffix' = drop 1 suffix -- strip off the .
498 basename | Just b <- mb_basename = b
499 | otherwise = input_basename
501 -- Decide where dump files should go based on the pipeline output
502 dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
503 hsc_env = hsc_env0 {hsc_dflags = dflags}
505 -- If we were given a -x flag, then use that phase to start from
506 start_phase = fromMaybe (startPhase suffix') mb_phase
508 -- We want to catch cases of "you can't get there from here" before
509 -- we start the pipeline, because otherwise it will just run off the
512 -- There is a partial ordering on phases, where A < B iff A occurs
513 -- before B in a normal compilation pipeline.
515 when (not (start_phase `happensBefore` stop_phase)) $
517 ("cannot compile this file to desired target: "
520 -- this is a function which will be used to calculate output file names
521 -- as we go along (we partially apply it to some of its inputs here)
522 let get_output_fn = getOutputFilename stop_phase output basename
524 -- Execute the pipeline...
525 (dflags', output_fn, maybe_loc) <-
526 pipeLoop hsc_env start_phase stop_phase input_fn
527 basename suffix' get_output_fn maybe_loc
529 -- Sometimes, a compilation phase doesn't actually generate any output
530 -- (eg. the CPP phase when -fcpp is not turned on). If we end on this
531 -- stage, but we wanted to keep the output, then we have to explicitly
532 -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
533 -- further compilation stages can tell what the original filename was.
536 return (dflags', output_fn)
538 do final_fn <- get_output_fn dflags' stop_phase maybe_loc
539 when (final_fn /= output_fn) $ do
540 let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
541 line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
542 copyWithHeader dflags msg line_prag output_fn final_fn
543 return (dflags', final_fn)
547 pipeLoop :: GhcMonad m =>
548 HscEnv -> Phase -> Phase
549 -> FilePath -> String -> Suffix
550 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
552 -> m (DynFlags, FilePath, Maybe ModLocation)
554 pipeLoop hsc_env phase stop_phase
555 input_fn orig_basename orig_suff
556 orig_get_output_fn maybe_loc
558 | phase `eqPhase` stop_phase -- All done
559 = return (hsc_dflags hsc_env, input_fn, maybe_loc)
561 | not (phase `happensBefore` stop_phase)
562 -- Something has gone wrong. We'll try to cover all the cases when
563 -- this could happen, so if we reach here it is a panic.
564 -- eg. it might happen if the -C flag is used on a source file that
565 -- has {-# OPTIONS -fasm #-}.
566 = panic ("pipeLoop: at phase " ++ show phase ++
567 " but I wanted to stop at phase " ++ show stop_phase)
570 = do (next_phase, dflags', maybe_loc, output_fn)
571 <- runPhase phase stop_phase hsc_env orig_basename
572 orig_suff input_fn orig_get_output_fn maybe_loc
573 let hsc_env' = hsc_env {hsc_dflags = dflags'}
574 pipeLoop hsc_env' next_phase stop_phase output_fn
575 orig_basename orig_suff orig_get_output_fn maybe_loc
578 :: Phase -> PipelineOutput -> String
579 -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
580 getOutputFilename stop_phase output basename
583 func dflags next_phase maybe_location
584 | is_last_phase, Persistent <- output = persistent_fn
585 | is_last_phase, SpecificFile f <- output = return f
586 | keep_this_output = persistent_fn
587 | otherwise = newTempName dflags suffix
590 odir = objectDir dflags
591 osuf = objectSuf dflags
592 keep_hc = dopt Opt_KeepHcFiles dflags
593 keep_raw_s = dopt Opt_KeepRawSFiles dflags
594 keep_s = dopt Opt_KeepSFiles dflags
596 myPhaseInputExt HCc = hcsuf
597 myPhaseInputExt StopLn = osuf
598 myPhaseInputExt other = phaseInputExt other
600 is_last_phase = next_phase `eqPhase` stop_phase
602 -- sometimes, we keep output from intermediate stages
606 Mangle | keep_raw_s -> True
608 HCc | keep_hc -> True
611 suffix = myPhaseInputExt next_phase
613 -- persistent object files get put in odir
615 | StopLn <- next_phase = return odir_persistent
616 | otherwise = return persistent
618 persistent = basename <.> suffix
621 | Just loc <- maybe_location = ml_obj_file loc
622 | Just d <- odir = d </> persistent
623 | otherwise = persistent
626 -- -----------------------------------------------------------------------------
627 -- | Each phase in the pipeline returns the next phase to execute, and the
628 -- name of the file in which the output was placed.
630 -- We must do things dynamically this way, because we often don't know
631 -- what the rest of the phases will be until part-way through the
632 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
633 -- of a source file can change the latter stages of the pipeline from
634 -- taking the via-C route to using the native code generator.
636 runPhase :: GhcMonad m =>
637 Phase -- ^ Do this phase first
638 -> Phase -- ^ Stop just before this phase
640 -> String -- ^ basename of original input source
641 -> String -- ^ its extension
642 -> FilePath -- ^ name of file which contains the input to this phase.
643 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
644 -- ^ how to calculate the output filename
645 -> Maybe ModLocation -- ^ the ModLocation, if we have one
646 -> m (Phase, -- next phase
647 DynFlags, -- new dynamic flags
648 Maybe ModLocation, -- the ModLocation, if we have one
649 FilePath) -- output filename
651 -- Invariant: the output filename always contains the output
652 -- Interesting case: Hsc when there is no recompilation to do
653 -- Then the output filename is still a .o file
655 -------------------------------------------------------------------------------
658 runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
660 let dflags = hsc_dflags hsc_env
661 output_fn <- liftIO $ get_output_fn dflags (Cpp sf) maybe_loc
663 let unlit_flags = getOpts dflags opt_L
664 flags = map SysTools.Option unlit_flags ++
665 [ -- The -h option passes the file name for unlit to
666 -- put in a #line directive
668 -- cpp interprets \b etc as escape sequences,
669 -- so we use / for filenames in pragmas
670 , SysTools.Option $ reslash Forwards $ normalise input_fn
671 , SysTools.FileOption "" input_fn
672 , SysTools.FileOption "" output_fn
675 liftIO $ SysTools.runUnlit dflags flags
677 return (Cpp sf, dflags, maybe_loc, output_fn)
679 -------------------------------------------------------------------------------
680 -- Cpp phase : (a) gets OPTIONS out of file
681 -- (b) runs cpp if necessary
683 runPhase (Cpp sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
684 = do let dflags0 = hsc_dflags hsc_env
685 src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
686 (dflags, unhandled_flags, warns)
687 <- liftIO $ parseDynamicNoPackageFlags dflags0 src_opts
688 handleFlagWarnings dflags warns
689 checkProcessArgsResult unhandled_flags
691 if not (dopt Opt_Cpp dflags) then
692 -- no need to preprocess CPP, just pass input file along
693 -- to the next phase of the pipeline.
694 return (HsPp sf, dflags, maybe_loc, input_fn)
696 output_fn <- liftIO $ get_output_fn dflags (HsPp sf) maybe_loc
697 liftIO $ doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
698 return (HsPp sf, dflags, maybe_loc, output_fn)
700 -------------------------------------------------------------------------------
703 runPhase (HsPp sf) _stop hsc_env basename suff input_fn get_output_fn maybe_loc
704 = do let dflags = hsc_dflags hsc_env
705 if not (dopt Opt_Pp dflags) then
706 -- no need to preprocess, just pass input file along
707 -- to the next phase of the pipeline.
708 return (Hsc sf, dflags, maybe_loc, input_fn)
710 let hspp_opts = getOpts dflags opt_F
711 let orig_fn = basename <.> suff
712 output_fn <- liftIO $ get_output_fn dflags (Hsc sf) maybe_loc
713 liftIO $ SysTools.runPp dflags
714 ( [ SysTools.Option orig_fn
715 , SysTools.Option input_fn
716 , SysTools.FileOption "" output_fn
718 map SysTools.Option hspp_opts
720 return (Hsc sf, dflags, maybe_loc, output_fn)
722 -----------------------------------------------------------------------------
725 -- Compilation of a single module, in "legacy" mode (_not_ under
726 -- the direction of the compilation manager).
727 runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc
728 = do -- normal Hsc mode, not mkdependHS
729 let dflags0 = hsc_dflags hsc_env
731 -- we add the current directory (i.e. the directory in which
732 -- the .hs files resides) to the include path, since this is
733 -- what gcc does, and it's probably what you want.
734 let current_dir = case takeDirectory basename of
735 "" -> "." -- XXX Hack
738 paths = includePaths dflags0
739 dflags = dflags0 { includePaths = current_dir : paths }
741 -- gather the imports and module name
742 (hspp_buf,mod_name,imps,src_imps) <-
744 ExtCoreFile -> do -- no explicit imports in ExtCore input.
745 m <- liftIO $ getCoreModuleName input_fn
746 return (Nothing, mkModuleName m, [], [])
749 buf <- liftIO $ hGetStringBuffer input_fn
750 (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
751 return (Just buf, mod_name, imps, src_imps)
753 -- Build a ModLocation to pass to hscMain.
754 -- The source filename is rather irrelevant by now, but it's used
755 -- by hscMain for messages. hscMain also needs
756 -- the .hi and .o filenames, and this is as good a way
757 -- as any to generate them, and better than most. (e.g. takes
758 -- into accout the -osuf flags)
759 location1 <- liftIO $ mkHomeModLocation2 dflags mod_name basename suff
761 -- Boot-ify it if necessary
762 let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
763 | otherwise = location1
766 -- Take -ohi into account if present
767 -- This can't be done in mkHomeModuleLocation because
768 -- it only applies to the module being compiles
769 let ohi = outputHi dflags
770 location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
771 | otherwise = location2
773 -- Take -o into account if present
774 -- Very like -ohi, but we must *only* do this if we aren't linking
775 -- (If we're linking then the -o applies to the linked thing, not to
776 -- the object file for one module.)
777 -- Note the nasty duplication with the same computation in compileFile above
778 let expl_o_file = outputFile dflags
779 location4 | Just ofile <- expl_o_file
780 , isNoLink (ghcLink dflags)
781 = location3 { ml_obj_file = ofile }
782 | otherwise = location3
784 o_file = ml_obj_file location4 -- The real object file
787 -- Figure out if the source has changed, for recompilation avoidance.
789 -- Setting source_unchanged to True means that M.o seems
790 -- to be up to date wrt M.hs; so no need to recompile unless imports have
791 -- changed (which the compiler itself figures out).
792 -- Setting source_unchanged to False tells the compiler that M.o is out of
793 -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
794 src_timestamp <- liftIO $ getModificationTime (basename <.> suff)
796 let force_recomp = dopt Opt_ForceRecomp dflags
798 if force_recomp || not (isStopLn stop)
799 -- Set source_unchanged to False unconditionally if
800 -- (a) recompilation checker is off, or
801 -- (b) we aren't going all the way to .o file (e.g. ghc -S)
803 -- Otherwise look at file modification dates
804 else do o_file_exists <- liftIO $ doesFileExist o_file
806 then return False -- Need to recompile
807 else do t2 <- liftIO $ getModificationTime o_file
808 if t2 > src_timestamp
813 let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
814 let next_phase = hscNextPhase dflags src_flavour hsc_lang
815 output_fn <- liftIO $ get_output_fn dflags next_phase (Just location4)
817 let dflags' = dflags { hscTarget = hsc_lang,
818 hscOutName = output_fn,
819 extCoreName = basename ++ ".hcr" }
821 let hsc_env' = hsc_env {hsc_dflags = dflags'}
823 -- Tell the finder cache about this module
824 mod <- liftIO $ addHomeModuleToFinder hsc_env' mod_name location4
826 -- Make the ModSummary to hand to hscMain
828 mod_summary = ModSummary { ms_mod = mod,
829 ms_hsc_src = src_flavour,
830 ms_hspp_file = input_fn,
831 ms_hspp_opts = dflags,
832 ms_hspp_buf = hspp_buf,
833 ms_location = location4,
834 ms_hs_date = src_timestamp,
835 ms_obj_date = Nothing,
837 ms_srcimps = src_imps }
840 result <- hscCompileOneShot hsc_env'
841 mod_summary source_unchanged
843 Nothing -- No "module i of n" progress info
847 -> do liftIO $ SysTools.touch dflags' "Touching object file" o_file
848 -- The .o file must have a later modification date
849 -- than the source file (else we wouldn't be in HscNoRecomp)
850 -- but we touch it anyway, to keep 'make' happy (we think).
851 return (StopLn, dflags', Just location4, o_file)
852 (HscRecomp hasStub _)
854 do stub_o <- compileStub hsc_env' mod location4
855 liftIO $ consIORef v_Ld_inputs stub_o
856 -- In the case of hs-boot files, generate a dummy .o-boot
857 -- stamp file for the benefit of Make
858 when (isHsBoot src_flavour) $
859 liftIO $ SysTools.touch dflags' "Touching object file" o_file
860 return (next_phase, dflags', Just location4, output_fn)
862 -----------------------------------------------------------------------------
865 runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
867 let dflags = hsc_dflags hsc_env
868 output_fn <- liftIO $ get_output_fn dflags Cmm maybe_loc
869 liftIO $ doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
870 return (Cmm, dflags, maybe_loc, output_fn)
872 runPhase Cmm stop hsc_env basename _ input_fn get_output_fn maybe_loc
874 let dflags = hsc_dflags hsc_env
875 let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
876 let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
877 output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
879 let dflags' = dflags { hscTarget = hsc_lang,
880 hscOutName = output_fn,
881 extCoreName = basename ++ ".hcr" }
882 let hsc_env' = hsc_env {hsc_dflags = dflags'}
884 hscCmmFile hsc_env' input_fn
886 -- XXX: catch errors above and convert them into ghcError? Original
889 --when (not ok) $ ghcError (PhaseFailed "cmm" (ExitFailure 1))
891 return (next_phase, dflags, maybe_loc, output_fn)
893 -----------------------------------------------------------------------------
896 -- we don't support preprocessing .c files (with -E) now. Doing so introduces
897 -- way too many hacks, and I can't say I've ever used it anyway.
899 runPhase cc_phase _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
900 | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
901 = do let dflags = hsc_dflags hsc_env
902 let cc_opts = getOpts dflags opt_c
903 hcc = cc_phase `eqPhase` HCc
905 let cmdline_include_paths = includePaths dflags
907 -- HC files have the dependent packages stamped into them
908 pkgs <- if hcc then liftIO (getHCFilePackages input_fn) else return []
910 -- add package include paths even if we're just compiling .c
911 -- files; this is the Value Add(TM) that using ghc instead of
913 pkg_include_dirs <- liftIO $ getPackageIncludePath dflags pkgs
914 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
915 (cmdline_include_paths ++ pkg_include_dirs)
917 let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
918 gcc_extra_viac_flags <- liftIO $ getExtraViaCOpts dflags
919 let pic_c_flags = picCCOpts dflags
921 let verb = getVerbFlag dflags
923 -- cc-options are not passed when compiling .hc files. Our
924 -- hc code doesn't not #include any header files anyway, so these
925 -- options aren't necessary.
927 if cc_phase `eqPhase` HCc
929 else liftIO $ getPackageExtraCcOpts dflags pkgs
931 #ifdef darwin_TARGET_OS
932 pkg_framework_paths <- liftIO $ getPackageFrameworkPath dflags pkgs
933 let cmdline_framework_paths = frameworkPaths dflags
934 let framework_paths = map ("-F"++)
935 (cmdline_framework_paths ++ pkg_framework_paths)
938 let split_objs = dopt Opt_SplitObjs dflags
939 split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
942 let cc_opt | optLevel dflags >= 2 = "-O2"
947 let mangle = dopt Opt_DoAsmMangling dflags
949 | hcc && mangle = Mangle
951 output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
956 -- on x86 the floating point regs have greater precision
957 -- than a double, which leads to unpredictable results.
958 -- By default, we turn this off with -ffloat-store unless
959 -- the user specified -fexcess-precision.
960 (if dopt Opt_ExcessPrecision dflags
962 else [ "-ffloat-store" ]) ++
964 -- gcc's -fstrict-aliasing allows two accesses to memory
965 -- to be considered non-aliasing if they have different types.
966 -- This interacts badly with the C code we generate, which is
967 -- very weakly typed, being derived from C--.
968 ["-fno-strict-aliasing"]
972 liftIO $ SysTools.runCc dflags (
973 -- force the C compiler to interpret this file as C when
974 -- compiling .hc files, by adding the -x c option.
975 -- Also useful for plain .c files, just in case GHC saw a
977 [ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
978 then SysTools.Option "c++" else SysTools.Option "c"] ++
979 [ SysTools.FileOption "" input_fn
980 , SysTools.Option "-o"
981 , SysTools.FileOption "" output_fn
983 ++ map SysTools.Option (
986 #ifdef sparc_TARGET_ARCH
987 -- We only support SparcV9 and better because V8 lacks an atomic CAS
988 -- instruction. Note that the user can still override this
989 -- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
990 -- regardless of the ordering.
992 -- This is a temporary hack.
995 #if defined(darwin_TARGET_OS) && defined(i386_TARGET_ARCH)
996 -- By default, gcc on OS X will generate SSE
997 -- instructions, which need things 16-byte aligned,
998 -- but we don't 16-byte align things. Thus drop
999 -- back to generic i686 compatibility. Trac #2983.
1002 ++ (if hcc && mangle
1003 then md_regd_c_flags
1007 then gcc_extra_viac_flags
1008 else filter (=="-fwrapv")
1009 gcc_extra_viac_flags
1010 -- still want -fwrapv even for unreg'd
1015 ++ [ verb, "-S", "-Wimplicit", cc_opt ]
1016 ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
1017 #ifdef darwin_TARGET_OS
1023 ++ pkg_extra_cc_opts
1026 return (next_phase, dflags, maybe_loc, output_fn)
1028 -- ToDo: postprocess the output from gcc
1030 -----------------------------------------------------------------------------
1033 runPhase Mangle _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
1034 = do let dflags = hsc_dflags hsc_env
1035 let mangler_opts = getOpts dflags opt_m
1037 #if i386_TARGET_ARCH
1038 machdep_opts <- return [ show (stolen_x86_regs dflags) ]
1040 machdep_opts <- return []
1043 let split = dopt Opt_SplitObjs dflags
1045 | split = SplitMangle
1047 output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
1049 liftIO $ SysTools.runMangle dflags (map SysTools.Option mangler_opts
1050 ++ [ SysTools.FileOption "" input_fn
1051 , SysTools.FileOption "" output_fn
1053 ++ map SysTools.Option machdep_opts)
1055 return (next_phase, dflags, maybe_loc, output_fn)
1057 -----------------------------------------------------------------------------
1060 runPhase SplitMangle _stop hsc_env _basename _suff input_fn _get_output_fn maybe_loc
1062 do -- tmp_pfx is the prefix used for the split .s files
1063 -- We also use it as the file to contain the no. of split .s files (sigh)
1064 let dflags = hsc_dflags hsc_env
1065 split_s_prefix <- SysTools.newTempName dflags "split"
1066 let n_files_fn = split_s_prefix
1068 SysTools.runSplit dflags
1069 [ SysTools.FileOption "" input_fn
1070 , SysTools.FileOption "" split_s_prefix
1071 , SysTools.FileOption "" n_files_fn
1074 -- Save the number of split files for future references
1075 s <- readFile n_files_fn
1076 let n_files = read s :: Int
1077 dflags' = dflags { splitInfo = Just (split_s_prefix, n_files) }
1079 -- Remember to delete all these files
1080 addFilesToClean dflags' [ split_s_prefix ++ "__" ++ show n ++ ".s"
1081 | n <- [1..n_files]]
1083 return (SplitAs, dflags', maybe_loc, "**splitmangle**")
1084 -- we don't use the filename
1086 -----------------------------------------------------------------------------
1089 runPhase As _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
1091 do let dflags = hsc_dflags hsc_env
1092 let as_opts = getOpts dflags opt_a
1093 let cmdline_include_paths = includePaths dflags
1095 output_fn <- get_output_fn dflags StopLn maybe_loc
1097 -- we create directories for the object file, because it
1098 -- might be a hierarchical module.
1099 createDirectoryHierarchy (takeDirectory output_fn)
1101 SysTools.runAs dflags
1102 (map SysTools.Option as_opts
1103 ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
1104 #ifdef sparc_TARGET_ARCH
1105 -- We only support SparcV9 and better because V8 lacks an atomic CAS
1106 -- instruction so we have to make sure that the assembler accepts the
1107 -- instruction set. Note that the user can still override this
1108 -- (e.g., -mcpu=ultrasparc). GCC picks the "best" -mcpu flag
1109 -- regardless of the ordering.
1111 -- This is a temporary hack.
1112 ++ [ SysTools.Option "-mcpu=v9" ]
1114 ++ [ SysTools.Option "-c"
1115 , SysTools.FileOption "" input_fn
1116 , SysTools.Option "-o"
1117 , SysTools.FileOption "" output_fn
1120 return (StopLn, dflags, maybe_loc, output_fn)
1123 runPhase SplitAs _stop hsc_env _basename _suff _input_fn get_output_fn maybe_loc
1125 let dflags = hsc_dflags hsc_env
1126 output_fn <- get_output_fn dflags StopLn maybe_loc
1128 let base_o = dropExtension output_fn
1129 split_odir = base_o ++ "_split"
1130 osuf = objectSuf dflags
1132 createDirectoryHierarchy split_odir
1134 -- remove M_split/ *.o, because we're going to archive M_split/ *.o
1135 -- later and we don't want to pick up any old objects.
1136 fs <- getDirectoryContents split_odir
1137 mapM_ removeFile $ map (split_odir </>) $ filter (osuf `isSuffixOf`) fs
1139 let as_opts = getOpts dflags opt_a
1141 let (split_s_prefix, n) = case splitInfo dflags of
1142 Nothing -> panic "No split info"
1145 let split_s n = split_s_prefix ++ "__" ++ show n <.> "s"
1146 split_obj n = split_odir </>
1147 takeFileName base_o ++ "__" ++ show n <.> osuf
1150 = SysTools.runAs dflags
1151 (map SysTools.Option as_opts ++
1152 #ifdef sparc_TARGET_ARCH
1153 -- We only support SparcV9 and better because V8 lacks an atomic CAS
1154 -- instruction so we have to make sure that the assembler accepts the
1155 -- instruction set. Note that the user can still override this
1156 -- (e.g., -mcpu=ultrasparc). GCC picks the "best" -mcpu flag
1157 -- regardless of the ordering.
1159 -- This is a temporary hack.
1160 [ SysTools.Option "-mcpu=v9" ] ++
1162 [ SysTools.Option "-c"
1163 , SysTools.Option "-o"
1164 , SysTools.FileOption "" (split_obj n)
1165 , SysTools.FileOption "" (split_s n)
1168 mapM_ assemble_file [1..n]
1170 -- and join the split objects into a single object file:
1171 let ld_r args = SysTools.runLink dflags ([
1172 SysTools.Option "-nostdlib",
1173 SysTools.Option "-nodefaultlibs",
1174 SysTools.Option "-Wl,-r",
1175 SysTools.Option ld_x_flag,
1176 SysTools.Option "-o",
1177 SysTools.FileOption "" output_fn ] ++ args)
1178 ld_x_flag | null cLD_X = ""
1179 | otherwise = "-Wl,-x"
1181 if cLdIsGNULd == "YES"
1183 let script = split_odir </> "ld.script"
1185 "INPUT(" ++ unwords (map split_obj [1..n]) ++ ")"
1186 ld_r [SysTools.FileOption "" script]
1188 ld_r (map (SysTools.FileOption "" . split_obj) [1..n])
1190 return (StopLn, dflags, maybe_loc, output_fn)
1192 -- warning suppression
1193 runPhase other _stop _dflags _basename _suff _input_fn _get_output_fn _maybe_loc =
1194 panic ("runPhase: don't know how to run phase " ++ show other)
1195 -----------------------------------------------------------------------------
1196 -- MoveBinary sort-of-phase
1197 -- After having produced a binary, move it somewhere else and generate a
1198 -- wrapper script calling the binary. Currently, we need this only in
1199 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
1200 -- central directory.
1201 -- This is called from linkBinary below, after linking. I haven't made it
1202 -- a separate phase to minimise interfering with other modules, and
1203 -- we don't need the generality of a phase (MoveBinary is always
1204 -- done after linking and makes only sense in a parallel setup) -- HWL
1206 runPhase_MoveBinary :: DynFlags -> FilePath -> [PackageId] -> IO Bool
1207 runPhase_MoveBinary dflags input_fn dep_packages
1208 | WayPar `elem` (wayNames dflags) && not opt_Static =
1209 panic ("Don't know how to combine PVM wrapper and dynamic wrapper")
1210 | WayPar `elem` (wayNames dflags) = do
1211 let sysMan = pgm_sysman dflags
1212 pvm_root <- getEnv "PVM_ROOT"
1213 pvm_arch <- getEnv "PVM_ARCH"
1215 pvm_executable_base = "=" ++ input_fn
1216 pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
1217 -- nuke old binary; maybe use configur'ed names for cp and rm?
1218 tryIO (removeFile pvm_executable)
1219 -- move the newly created binary into PVM land
1220 copy dflags "copying PVM executable" input_fn pvm_executable
1221 -- generate a wrapper script for running a parallel prg under PVM
1222 writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
1225 case (dynLibLoader dflags) of
1228 let (o_base, o_ext) = splitExtension input_fn
1229 let wrapped_executable | o_ext == "exe" = (o_base ++ ".dyn") <.> o_ext
1230 | otherwise = input_fn ++ ".dyn"
1231 behaviour <- wrapper_behaviour dflags wrapmode dep_packages
1233 -- THINKME isn't this possible to do a bit nicer?
1234 let behaviour' = concatMap (\x -> if x=='\\' then "\\\\" else [x]) behaviour
1235 renameFile input_fn wrapped_executable
1236 let rtsDetails = (getPackageDetails (pkgState dflags) rtsPackageId);
1237 SysTools.runCc dflags
1238 ([ SysTools.FileOption "" ((head (libraryDirs rtsDetails)) ++ "/dyn-wrapper.c")
1239 , SysTools.Option ("-DBEHAVIOUR=\"" ++ behaviour' ++ "\"")
1240 , SysTools.Option "-o"
1241 , SysTools.FileOption "" input_fn
1242 ] ++ map (SysTools.FileOption "-I") (includeDirs rtsDetails))
1245 | otherwise = return True
1247 wrapper_behaviour :: DynFlags -> Maybe [Char] -> [PackageId] -> IO [Char]
1248 wrapper_behaviour dflags mode dep_packages =
1249 let seperateBySemiColon strs = tail $ concatMap (';':) strs
1252 pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1253 return ('H' : (seperateBySemiColon pkg_lib_paths))
1255 allpkg <- getPreloadPackagesAnd dflags dep_packages
1256 putStrLn (unwords (map (packageIdString . packageConfigId) allpkg))
1257 return $ 'F':s ++ ';':(seperateBySemiColon (map (packageIdString . packageConfigId) allpkg))
1259 -- generates a Perl skript starting a parallel prg under PVM
1260 mk_pvm_wrapper_script :: String -> String -> String -> String
1261 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
1263 "eval 'exec perl -S $0 ${1+\"$@\"}'",
1264 " if $running_under_some_shell;",
1265 "# =!=!=!=!=!=!=!=!=!=!=!",
1266 "# This script is automatically generated: DO NOT EDIT!!!",
1267 "# Generated by Glasgow Haskell Compiler",
1268 "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
1270 "$pvm_executable = '" ++ pvm_executable ++ "';",
1271 "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
1272 "$SysMan = '" ++ sysMan ++ "';",
1274 {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
1275 "# first, some magical shortcuts to run "commands" on the binary",
1276 "# (which is hidden)",
1277 "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
1278 " local($cmd) = $1;",
1279 " system("$cmd $pvm_executable");",
1280 " exit(0); # all done",
1283 "# Now, run the real binary; process the args first",
1284 "$ENV{'PE'} = $pvm_executable_base;", -- ++ pvm_executable_base,
1286 "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
1287 "@nonPVM_args = ();",
1288 "$in_RTS_args = 0;",
1290 "args: while ($a = shift(@ARGV)) {",
1291 " if ( $a eq '+RTS' ) {",
1292 " $in_RTS_args = 1;",
1293 " } elsif ( $a eq '-RTS' ) {",
1294 " $in_RTS_args = 0;",
1296 " if ( $a eq '-d' && $in_RTS_args ) {",
1298 " } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
1299 " $nprocessors = $1;",
1300 " } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
1301 " $nprocessors = $1;",
1303 " push(@nonPVM_args, $a);",
1307 "local($return_val) = 0;",
1308 "# Start the parallel execution by calling SysMan",
1309 "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
1310 "$return_val = $?;",
1311 "# ToDo: fix race condition moving files and flushing them!!",
1312 "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
1313 "exit($return_val);"
1316 -----------------------------------------------------------------------------
1317 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
1319 getHCFilePackages :: FilePath -> IO [PackageId]
1320 getHCFilePackages filename =
1321 Exception.bracket (openFile filename ReadMode) hClose $ \h -> do
1324 '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
1325 return (map stringToPackageId (words rest))
1329 -----------------------------------------------------------------------------
1330 -- Static linking, of .o files
1332 -- The list of packages passed to link is the list of packages on
1333 -- which this program depends, as discovered by the compilation
1334 -- manager. It is combined with the list of packages that the user
1335 -- specifies on the command line with -package flags.
1337 -- In one-shot linking mode, we can't discover the package
1338 -- dependencies (because we haven't actually done any compilation or
1339 -- read any interface files), so the user must explicitly specify all
1342 linkBinary :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
1343 linkBinary dflags o_files dep_packages = do
1344 let verb = getVerbFlag dflags
1345 output_fn = exeFileName dflags
1347 -- get the full list of packages to link with, by combining the
1348 -- explicit packages with the auto packages and all of their
1349 -- dependencies, and eliminating duplicates.
1351 pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1352 let pkg_lib_path_opts = concat (map get_pkg_lib_path_opts pkg_lib_paths)
1353 #ifdef linux_TARGET_OS
1354 get_pkg_lib_path_opts l | (dynLibLoader dflags)==SystemDependent && not opt_Static = ["-L" ++ l, "-Wl,-rpath", "-Wl," ++ l]
1355 | otherwise = ["-L" ++ l]
1357 get_pkg_lib_path_opts l = ["-L" ++ l]
1360 let lib_paths = libraryPaths dflags
1361 let lib_path_opts = map ("-L"++) lib_paths
1363 pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1365 #ifdef darwin_TARGET_OS
1366 pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1367 let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1369 let framework_paths = frameworkPaths dflags
1370 framework_path_opts = map ("-F"++) framework_paths
1372 pkg_frameworks <- getPackageFrameworks dflags dep_packages
1373 let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1375 let frameworks = cmdlineFrameworks dflags
1376 framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1377 -- reverse because they're added in reverse order from the cmd line
1379 #ifdef mingw32_TARGET_OS
1380 let dynMain = if not opt_Static then
1381 (head (libraryDirs (getPackageDetails (pkgState dflags) rtsPackageId))) ++ "/Main.dyn_o"
1385 -- probably _stub.o files
1386 extra_ld_inputs <- readIORef v_Ld_inputs
1388 -- opts from -optl-<blah> (including -l<blah> options)
1389 let extra_ld_opts = getOpts dflags opt_l
1391 let ways = wayNames dflags
1393 -- Here are some libs that need to be linked at the *end* of
1394 -- the command line, because they contain symbols that are referred to
1395 -- by the RTS. We can't therefore use the ordinary way opts for these.
1397 debug_opts | WayDebug `elem` ways = [
1398 #if defined(HAVE_LIBBFD)
1405 thread_opts | WayThreaded `elem` ways = [
1406 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1409 #if defined(osf3_TARGET_OS)
1415 rc_objs <- maybeCreateManifest dflags output_fn
1417 let (md_c_flags, _) = machdepCCOpts dflags
1418 SysTools.runLink dflags (
1419 [ SysTools.Option verb
1420 , SysTools.Option "-o"
1421 , SysTools.FileOption "" output_fn
1423 ++ map SysTools.Option (
1426 #ifdef mingw32_TARGET_OS
1433 #ifdef darwin_TARGET_OS
1434 ++ framework_path_opts
1437 ++ pkg_lib_path_opts
1439 #ifdef darwin_TARGET_OS
1440 ++ pkg_framework_path_opts
1441 ++ pkg_framework_opts
1447 -- parallel only: move binary to another dir -- HWL
1448 success <- runPhase_MoveBinary dflags output_fn dep_packages
1449 if success then return ()
1450 else ghcError (InstallationError ("cannot move binary"))
1453 exeFileName :: DynFlags -> FilePath
1455 | Just s <- outputFile dflags =
1456 #if defined(mingw32_HOST_OS)
1457 if null (takeExtension s)
1464 #if defined(mingw32_HOST_OS)
1472 -> FilePath -- filename of executable
1473 -> IO [FilePath] -- extra objects to embed, maybe
1474 #ifndef mingw32_TARGET_OS
1475 maybeCreateManifest _ _ = do
1478 maybeCreateManifest dflags exe_filename = do
1479 if not (dopt Opt_GenManifest dflags) then return [] else do
1481 let manifest_filename = exe_filename <.> "manifest"
1483 writeFile manifest_filename $
1484 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n"++
1485 " <assembly xmlns=\"urn:schemas-microsoft-com:asm.v1\" manifestVersion=\"1.0\">\n"++
1486 " <assemblyIdentity version=\"1.0.0.0\"\n"++
1487 " processorArchitecture=\"X86\"\n"++
1488 " name=\"" ++ dropExtension exe_filename ++ "\"\n"++
1489 " type=\"win32\"/>\n\n"++
1490 " <trustInfo xmlns=\"urn:schemas-microsoft-com:asm.v3\">\n"++
1492 " <requestedPrivileges>\n"++
1493 " <requestedExecutionLevel level=\"asInvoker\" uiAccess=\"false\"/>\n"++
1494 " </requestedPrivileges>\n"++
1499 -- Windows will find the manifest file if it is named foo.exe.manifest.
1500 -- However, for extra robustness, and so that we can move the binary around,
1501 -- we can embed the manifest in the binary itself using windres:
1502 if not (dopt Opt_EmbedManifest dflags) then return [] else do
1504 rc_filename <- newTempName dflags "rc"
1505 rc_obj_filename <- newTempName dflags (objectSuf dflags)
1507 writeFile rc_filename $
1508 "1 24 MOVEABLE PURE " ++ show manifest_filename ++ "\n"
1509 -- magic numbers :-)
1510 -- show is a bit hackish above, but we need to escape the
1511 -- backslashes in the path.
1513 let wr_opts = getOpts dflags opt_windres
1514 runWindres dflags $ map SysTools.Option $
1515 ["--input="++rc_filename,
1516 "--output="++rc_obj_filename,
1517 "--output-format=coff"]
1519 -- no FileOptions here: windres doesn't like seeing
1520 -- backslashes, apparently
1522 removeFile manifest_filename
1524 return [rc_obj_filename]
1528 linkDynLib :: DynFlags -> [String] -> [PackageId] -> IO ()
1529 linkDynLib dflags o_files dep_packages = do
1530 let verb = getVerbFlag dflags
1531 let o_file = outputFile dflags
1533 -- We don't want to link our dynamic libs against the RTS package,
1534 -- because the RTS lib comes in several flavours and we want to be
1535 -- able to pick the flavour when a binary is linked.
1536 pkgs <- getPreloadPackagesAnd dflags dep_packages
1538 -- On Windows we need to link the RTS import lib as Windows does
1539 -- not allow undefined symbols.
1540 #if !defined(mingw32_HOST_OS)
1541 let pkgs_no_rts = filter ((/= rtsPackageId) . packageConfigId) pkgs
1543 let pkgs_no_rts = pkgs
1545 let pkg_lib_paths = collectLibraryPaths pkgs_no_rts
1546 let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1548 let lib_paths = libraryPaths dflags
1549 let lib_path_opts = map ("-L"++) lib_paths
1551 let pkg_link_opts = collectLinkOpts dflags pkgs_no_rts
1553 -- probably _stub.o files
1554 extra_ld_inputs <- readIORef v_Ld_inputs
1556 let (md_c_flags, _) = machdepCCOpts dflags
1557 let extra_ld_opts = getOpts dflags opt_l
1558 #if defined(mingw32_HOST_OS)
1559 -----------------------------------------------------------------------------
1561 -----------------------------------------------------------------------------
1562 let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1564 SysTools.runLink dflags
1565 ([ SysTools.Option verb
1566 , SysTools.Option "-o"
1567 , SysTools.FileOption "" output_fn
1568 , SysTools.Option "-shared"
1569 , SysTools.FileOption "-Wl,--out-implib=" (output_fn ++ ".a")
1571 ++ map (SysTools.FileOption "") o_files
1572 ++ map SysTools.Option (
1577 ++ pkg_lib_path_opts
1580 #elif defined(darwin_TARGET_OS)
1581 -----------------------------------------------------------------------------
1582 -- Making a darwin dylib
1583 -----------------------------------------------------------------------------
1584 -- About the options used for Darwin:
1586 -- Apple's way of saying -shared
1587 -- -undefined dynamic_lookup:
1588 -- Without these options, we'd have to specify the correct dependencies
1589 -- for each of the dylibs. Note that we could (and should) do without this
1590 -- for all libraries except the RTS; all we need to do is to pass the
1591 -- correct HSfoo_dyn.dylib files to the link command.
1592 -- This feature requires Mac OS X 10.3 or later; there is a similar feature,
1593 -- -flat_namespace -undefined suppress, which works on earlier versions,
1594 -- but it has other disadvantages.
1596 -- Build the dynamic library as a single "module", i.e. no dynamic binding
1597 -- nonsense when referring to symbols from within the library. The NCG
1598 -- assumes that this option is specified (on i386, at least).
1599 -- -Wl,-macosx_version_min -Wl,10.3
1600 -- Tell the linker its safe to assume that the library will run on 10.3 or
1601 -- later, so that it will not complain about the use of the option
1602 -- -undefined dynamic_lookup above.
1604 -- Causes the dynamic linker to ignore the DYLD_LIBRARY_PATH when loading
1605 -- this lib and instead look for it at its absolute path.
1606 -- When installing the .dylibs (see target.mk), we'll change that path to
1607 -- point to the place they are installed. Therefore, we won't have to set
1608 -- up DYLD_LIBRARY_PATH specifically for ghc.
1609 -----------------------------------------------------------------------------
1611 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1613 pwd <- getCurrentDirectory
1614 SysTools.runLink dflags
1615 ([ SysTools.Option verb
1616 , SysTools.Option "-dynamiclib"
1617 , SysTools.Option "-o"
1618 , SysTools.FileOption "" output_fn
1620 ++ map SysTools.Option (
1623 ++ [ "-undefined", "dynamic_lookup", "-single_module", "-Wl,-macosx_version_min","-Wl,10.3", "-install_name " ++ (pwd </> output_fn) ]
1627 ++ pkg_lib_path_opts
1631 -----------------------------------------------------------------------------
1633 -----------------------------------------------------------------------------
1635 let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1637 SysTools.runLink dflags
1638 ([ SysTools.Option verb
1639 , SysTools.Option "-o"
1640 , SysTools.FileOption "" output_fn
1642 ++ map SysTools.Option (
1645 ++ [ "-shared", "-Wl,-Bsymbolic" ] -- we need symbolic linking to resolve non-PIC intra-package-relocations
1649 ++ pkg_lib_path_opts
1653 -- -----------------------------------------------------------------------------
1656 doCpp :: DynFlags -> Bool -> Bool -> FilePath -> FilePath -> IO ()
1657 doCpp dflags raw include_cc_opts input_fn output_fn = do
1658 let hscpp_opts = getOpts dflags opt_P
1659 let cmdline_include_paths = includePaths dflags
1661 pkg_include_dirs <- getPackageIncludePath dflags []
1662 let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1663 (cmdline_include_paths ++ pkg_include_dirs)
1665 let verb = getVerbFlag dflags
1668 | not include_cc_opts = []
1669 | otherwise = (optc ++ md_c_flags)
1671 optc = getOpts dflags opt_c
1672 (md_c_flags, _) = machdepCCOpts dflags
1674 let cpp_prog args | raw = SysTools.runCpp dflags args
1675 | otherwise = SysTools.runCc dflags (SysTools.Option "-E" : args)
1678 [ "-D" ++ HOST_OS ++ "_BUILD_OS=1",
1679 "-D" ++ HOST_ARCH ++ "_BUILD_ARCH=1",
1680 "-D" ++ TARGET_OS ++ "_HOST_OS=1",
1681 "-D" ++ TARGET_ARCH ++ "_HOST_ARCH=1" ]
1682 -- remember, in code we *compile*, the HOST is the same our TARGET,
1683 -- and BUILD is the same as our HOST.
1685 cpp_prog ([SysTools.Option verb]
1686 ++ map SysTools.Option include_paths
1687 ++ map SysTools.Option hsSourceCppOpts
1688 ++ map SysTools.Option hscpp_opts
1689 ++ map SysTools.Option cc_opts
1690 ++ map SysTools.Option target_defs
1691 ++ [ SysTools.Option "-x"
1692 , SysTools.Option "c"
1693 , SysTools.Option input_fn
1694 -- We hackily use Option instead of FileOption here, so that the file
1695 -- name is not back-slashed on Windows. cpp is capable of
1696 -- dealing with / in filenames, so it works fine. Furthermore
1697 -- if we put in backslashes, cpp outputs #line directives
1698 -- with *double* backslashes. And that in turn means that
1699 -- our error messages get double backslashes in them.
1700 -- In due course we should arrange that the lexer deals
1701 -- with these \\ escapes properly.
1702 , SysTools.Option "-o"
1703 , SysTools.FileOption "" output_fn
1706 cHaskell1Version :: String
1707 cHaskell1Version = "5" -- i.e., Haskell 98
1709 hsSourceCppOpts :: [String]
1710 -- Default CPP defines in Haskell source
1712 [ "-D__HASKELL1__="++cHaskell1Version
1713 , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
1715 , "-D__CONCURRENT_HASKELL__"
1719 -- -----------------------------------------------------------------------------
1722 hscNextPhase :: DynFlags -> HscSource -> HscTarget -> Phase
1723 hscNextPhase _ HsBootFile _ = StopLn
1724 hscNextPhase dflags _ hsc_lang =
1727 HscAsm | dopt Opt_SplitObjs dflags -> SplitMangle
1729 HscNothing -> StopLn
1730 HscInterpreted -> StopLn
1734 hscMaybeAdjustTarget :: DynFlags -> Phase -> HscSource -> HscTarget -> HscTarget
1735 hscMaybeAdjustTarget dflags stop _ current_hsc_lang
1738 keep_hc = dopt Opt_KeepHcFiles dflags
1740 -- don't change the lang if we're interpreting
1741 | current_hsc_lang == HscInterpreted = current_hsc_lang
1743 -- force -fvia-C if we are being asked for a .hc file
1744 | HCc <- stop = HscC
1746 -- otherwise, stick to the plan
1747 | otherwise = current_hsc_lang