DriverPipeline.hs 57.1 KB
Newer Older
1 2 3 4
-----------------------------------------------------------------------------
--
-- GHC Driver
--
5
-- (c) The University of Glasgow 2005
6 7 8 9
--
-----------------------------------------------------------------------------

module DriverPipeline (
10 11
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
12
   oneShot, compileFile,
13

14
	-- Interfaces for the batch-mode driver
15
   linkBinary,
16

17 18
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
19
   compile,
20
   link, 
21

22 23 24 25
  ) where

#include "HsVersions.h"

26
import Packages
27
import HeaderInfo
28
import DriverPhases
29
import SysTools
30
import HscMain
31
import Finder
32 33 34
import HscTypes
import Outputable
import Module
Simon Marlow's avatar
Simon Marlow committed
35
import UniqFM		( eltsUFM )
36
import ErrUtils
37
import DynFlags
38
import StaticFlags	( v_Ld_inputs, opt_Static, opt_HardwireLibPaths, WayName(..) )
39
import Config
40
import Panic
41
import Util
42
import StringBuffer	( hGetStringBuffer )
43
import BasicTypes	( SuccessFlag(..) )
44
import Maybes		( expectJust )
45
import ParserCoreUtils	( getCoreModuleName )
46
import SrcLoc		( unLoc )
47
import SrcLoc		( Located(..) )
48

Simon Marlow's avatar
Simon Marlow committed
49 50 51 52 53 54 55
import Control.Exception as Exception
import Data.IORef	( readIORef, writeIORef, IORef )
import GHC.Exts		( Int(..) )
import System.Directory
import System.IO
import SYSTEM_IO_ERROR as IO
import Control.Monad
56
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
57 58 59
import Data.Maybe
import System.Exit
import System.Environment
60

61 62
-- ---------------------------------------------------------------------------
-- Pre-process
63 64 65

-- Just preprocess a file, put the result in a temp. file (used by the
-- compilation manager during the summary phase).
66 67 68
--
-- We return the augmented DynFlags, because they contain the result
-- of slurping in the OPTIONS pragmas
69

70 71 72
preprocess :: DynFlags -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
preprocess dflags (filename, mb_phase) =
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
Simon Marlow's avatar
Simon Marlow committed
73 74
  runPipeline anyHsc dflags (filename, mb_phase) 
        Nothing Temporary Nothing{-no ModLocation-}
75

76 77
-- ---------------------------------------------------------------------------
-- Compile
78 79 80 81 82 83 84 85 86 87

-- Compile a single module, under the control of the compilation manager.
--
-- This is the interface between the compilation manager and the
-- compiler proper (hsc), where we deal with tedious details like
-- reading the OPTIONS pragma from the source file, and passing the
-- output of hsc through the C compiler.

-- NB.  No old interface can also mean that the source has changed.

88
compile :: HscEnv
89 90 91 92 93 94 95 96 97 98 99
        -> ModSummary                   -- summary for module being compiled
        -> Int -> Int                   -- module N of M
        -> Maybe ModIface               -- old interface, if we have one
        -> Maybe Linkable               -- old linkable, if we have one
        -> IO (Maybe HomeModInfo)       -- the complete HomeModInfo, if successful

compile hsc_env summary mod_index nmods mb_old_iface maybe_old_linkable
 = do
   let dflags0     = ms_hspp_opts summary
       this_mod    = ms_mod summary
       src_flavour = ms_hsc_src summary
100 101 102
       location	   = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location) 
       input_fnpp  = ms_hspp_file summary
103

104
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
105

106
   let (basename, _) = splitFilename input_fn
107

108 109 110 111
  -- We add the directory in which the .hs files resides) to the import path.
  -- This is needed when we try to compile the .hc file later, if it
  -- imports a _stub.h file that we created here.
   let current_dir = directoryOf basename
112 113
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
114

115
   -- Figure out what lang we're generating
116
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
117
   -- ... and what the next phase should be
118
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
119
   -- ... and what file to generate the output into
120 121
   output_fn <- getOutputFilename next_phase 
			Temporary basename dflags next_phase (Just location)
122

123
   let dflags' = dflags { hscTarget = hsc_lang,
124
				hscOutName = output_fn,
125 126 127
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
128 129
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
130
       hsc_env' = hsc_env { hsc_dflags = dflags' }
131
       object_filename = ml_obj_file location
132

133 134 135 136 137
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

138
       handleBatch HscNoRecomp
139
           = ASSERT (isJust maybe_old_linkable)
140 141 142
             return maybe_old_linkable

       handleBatch (HscRecomp hasStub)
143
           | isHsBoot src_flavour
144 145
               = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
                       SysTools.touch dflags' "Touching object file"
146
                                   object_filename
147 148
                    return maybe_old_linkable

149 150 151 152 153
           | otherwise
               = do stub_unlinked <- getStubLinkable hasStub
                    (hs_unlinked, unlinked_time) <-
                        case hsc_lang of
                          HscNothing
154
                            -> return ([], ms_hs_date summary)
155 156
                          -- We're in --make mode: finish the compilation pipeline.
                          _other
Simon Marlow's avatar
Simon Marlow committed
157 158 159
                            -> do runPipeline StopLn dflags (output_fn,Nothing)
                                              (Just basename)
                                              Persistent
160 161 162 163 164 165
                                              (Just location)
                                  -- The object filename comes from the ModLocation
                                  o_time <- getModificationTime object_filename
                                  return ([DotO object_filename], o_time)
                    let linkable = LM unlinked_time this_mod
			           (hs_unlinked ++ stub_unlinked)
166
                    return (Just linkable)
167

168
       handleInterpreted InteractiveNoRecomp
169
           = ASSERT (isJust maybe_old_linkable)
170 171
             return maybe_old_linkable
       handleInterpreted (InteractiveRecomp hasStub comp_bc modBreaks)
172
           = do stub_unlinked <- getStubLinkable hasStub
173
                let hs_unlinked = [BCOs comp_bc modBreaks]
174
                    unlinked_time = ms_hs_date summary
175 176 177 178 179 180 181 182
                  -- Why do we use the timestamp of the source file here,
                  -- rather than the current time?  This works better in
                  -- the case where the local clock is out of sync
                  -- with the filesystem's clock.  It's just as accurate:
                  -- if the source is modified, then the linkable will
                  -- be out of date.
                let linkable = LM unlinked_time this_mod
                               (hs_unlinked ++ stub_unlinked)
183
                return (Just linkable)
184

185 186 187 188
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
       --            -> IO (Maybe HomeModInfo)
       runCompiler compiler handle
           = do mbResult <- compiler hsc_env' summary source_unchanged mb_old_iface
189 190
                                     (Just (mod_index, nmods))
                case mbResult of
191 192 193 194 195 196
                  Nothing -> return Nothing
                  Just (result, iface, details) -> do
                        linkable <- handle result
                        return (Just HomeModInfo{ hm_details  = details,
                                                  hm_iface    = iface,
                                                  hm_linkable = linkable })
197
   -- run the compiler
198
   case hsc_lang of
199 200 201 202 203 204 205 206 207
      HscInterpreted
        | isHsBoot src_flavour -> 
                runCompiler hscCompileNothing handleBatch
        | otherwise -> 
                runCompiler hscCompileInteractive handleInterpreted
      HscNothing -> 
                runCompiler hscCompileNothing handleBatch
      _other -> 
                runCompiler hscCompileBatch handleBatch
208

209
-----------------------------------------------------------------------------
210 211
-- stub .h and .c files (for foreign export support)

212 213 214
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
215 216 217 218 219 220 221 222 223 224 225 226 227
-- Consequently, we derive the _stub.o filename from the haskell object
-- filename.  
--
-- This isn't necessarily the same as the object filename we
-- would get if we just compiled the _stub.c file using the pipeline.
-- For example:
--
--    ghc src/A.hs -odir obj
-- 
-- results in obj/A.o, and src/A_stub.c.  If we compile src/A_stub.c with
-- -odir obj, we would get obj/src/A_stub.o, which is wrong; we want
-- obj/A_stub.o.

228 229 230
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
	let (o_base, o_ext) = splitFilename (ml_obj_file location)
231 232
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

233
	-- compile the _stub.c file w/ gcc
234
	let (stub_c,_,_) = mkStubPaths dflags (moduleName mod) location
Simon Marlow's avatar
Simon Marlow committed
235
	runPipeline StopLn dflags (stub_c,Nothing)  Nothing
236 237 238
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
239 240


241 242
-- ---------------------------------------------------------------------------
-- Link
243

Ian Lynagh's avatar
Ian Lynagh committed
244 245 246 247
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
248 249 250 251 252 253 254 255 256 257
     -> IO SuccessFlag

-- For the moment, in the batch linker, we don't bother to tell doLink
-- which packages to link -- it just tries all that are available.
-- batch_attempt_linking should only be *looked at* in batch mode.  It
-- should only be True if the upsweep was successful and someone
-- exports main, i.e., we have good reason to believe that linking
-- will succeed.

#ifdef GHCI
258
link LinkInMemory _ _ _
259
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
260
         return Succeeded
261 262
#endif

263
link NoLink _ _ _
264 265
   = return Succeeded

266
link LinkBinary dflags batch_attempt_linking hpt
267
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
268 269 270
   = do
        let
            home_mod_infos = eltsUFM hpt
271

Ian Lynagh's avatar
Ian Lynagh committed
272 273
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
274

Ian Lynagh's avatar
Ian Lynagh committed
275 276
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
277

278
        debugTraceMsg dflags 3 (text "link: linkables are ..." $$ vcat (map ppr linkables))
279

Ian Lynagh's avatar
Ian Lynagh committed
280 281 282 283 284
        -- check for the -no-link flag
        if isNoLink (ghcLink dflags)
          then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
                  return Succeeded
          else do
285

Ian Lynagh's avatar
Ian Lynagh committed
286 287
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
288

Ian Lynagh's avatar
Ian Lynagh committed
289
            exe_file = exeFileName dflags
290

Ian Lynagh's avatar
Ian Lynagh committed
291 292 293 294
        -- if the modification time on the executable is later than the
        -- modification times on all of the objects, then omit linking
        -- (unless the -no-recomp flag was given).
        e_exe_time <- IO.try $ getModificationTime exe_file
295 296 297 298
        extra_ld_inputs <- readIORef v_Ld_inputs
        extra_times <- mapM (IO.try . getModificationTime) extra_ld_inputs
        let other_times = map linkableTime linkables
                       ++ [ t' | Right t' <- extra_times ]
299 300 301
            linking_needed = case e_exe_time of
                               Left _  -> True
                               Right t -> any (t <) other_times
302

Ian Lynagh's avatar
Ian Lynagh committed
303 304 305 306
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
                   return Succeeded
           else do
307

Ian Lynagh's avatar
Ian Lynagh committed
308 309
        debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
                                 <+> text "...")
310

Ian Lynagh's avatar
Ian Lynagh committed
311 312 313 314
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
315
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
316
        link dflags obj_files pkg_deps
317

318
        debugTraceMsg dflags 3 (text "link: done")
319

Ian Lynagh's avatar
Ian Lynagh committed
320
        -- linkBinary only returns if it succeeds
321 322 323
        return Succeeded

   | otherwise
324 325
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
326
        return Succeeded
Ian Lynagh's avatar
Ian Lynagh committed
327

328 329 330 331 332 333
-- warning suppression
link other _ _ _ = panicBadLink other

panicBadLink :: GhcLink -> a
panicBadLink other = panic ("link: GHC not built to link this way: " ++
                            show other)
334 335 336
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

337
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
338 339 340 341
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

342 343
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
   exists <- doesFileExist src
   when (not exists) $ 
   	throwDyn (CmdLineError ("does not exist: " ++ src))
   
   let
	split     = dopt Opt_SplitObjs dflags
	mb_o_file = outputFile dflags
	ghc_link  = ghcLink dflags	-- Set by -c or -no-link

	-- When linking, the -o argument refers to the linker's output.	
	-- otherwise, we use it as the name for the pipeline's output.
        output
	 | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
		-- -o foo applies to linker
	 | Just o_file <- mb_o_file = SpecificFile o_file
		-- -o foo applies to the file we are compiling now
	 | otherwise = Persistent

        stop_phase' = case stop_phase of 
			As | split -> SplitAs
364
                        _          -> stop_phase
365 366

   (_, out_file) <- runPipeline stop_phase' dflags
Simon Marlow's avatar
Simon Marlow committed
367 368
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
369 370 371 372 373 374 375 376 377 378 379
   return out_file


doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
doLink dflags stop_phase o_files
  | not (isStopLn stop_phase)
  = return ()		-- We stopped before the linking phase

  | otherwise
  = case ghcLink dflags of
	NoLink     -> return ()
380 381
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
382
        other      -> panicBadLink other
383 384 385
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
Simon Marlow's avatar
Simon Marlow committed
386
    link_pkgs = [haskell98PackageId]
387 388


389 390
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
391

392 393 394 395
-- This is the interface to the compilation pipeline, which runs
-- a series of compilation steps on a single source file, specifying
-- at which stage to stop.

396
-- The DynFlags can be modified by phases in the pipeline (eg. by
397 398 399 400 401 402 403 404 405 406 407 408 409
-- GHC_OPTIONS pragmas), and the changes affect later phases in the
-- pipeline.

data PipelineOutput 
  = Temporary
	-- output should be to a temporary file: we're going to
	-- run more compilation steps on this output later
  | Persistent
	-- we want a persistent file, i.e. a file in the current directory
	-- derived from the input filename, but with the appropriate extension.
	-- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
  | SpecificFile FilePath
	-- the output must go into the specified file.
410

411
runPipeline
412 413 414
  :: Phase		        -- When to stop
  -> DynFlags		        -- Dynamic flags
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
Simon Marlow's avatar
Simon Marlow committed
415
  -> Maybe FilePath             -- original basename (if different from ^^^)
416 417
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
418
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
419

420
runPipeline stop_phase dflags0 (input_fn, mb_phase) mb_basename output maybe_loc
421
  = do
422 423
  let
      (input_basename, suffix) = splitFilename input_fn
Simon Marlow's avatar
Simon Marlow committed
424 425
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
426

427 428 429
      -- Decide where dump files should go based on the pipeline output
      dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }

430
	-- If we were given a -x flag, then use that phase to start from
basvandijk@home.nl's avatar
basvandijk@home.nl committed
431
      start_phase = fromMaybe (startPhase suffix) mb_phase
432

433 434 435 436 437 438
  -- We want to catch cases of "you can't get there from here" before
  -- we start the pipeline, because otherwise it will just run off the
  -- end.
  --
  -- There is a partial ordering on phases, where A < B iff A occurs
  -- before B in a normal compilation pipeline.
439

440 441
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
442 443
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
444

445 446
  -- this is a function which will be used to calculate output file names
  -- as we go along (we partially apply it to some of its inputs here)
447
  let get_output_fn = getOutputFilename stop_phase output basename
448

449
  -- Execute the pipeline...
450 451 452
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
453

454
  -- Sometimes, a compilation phase doesn't actually generate any output
455 456
  -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
  -- stage, but we wanted to keep the output, then we have to explicitly
457 458
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
459 460 461 462
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
463
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
464 465 466 467
	   when (final_fn /= output_fn) $ do
              let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
                  line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
	      copyWithHeader dflags msg line_prag output_fn final_fn
468
	   return (dflags', final_fn)
469

470 471


472
pipeLoop :: DynFlags -> Phase -> Phase 
473
	 -> FilePath  -> String -> Suffix
474
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
475 476
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
477

478
pipeLoop dflags phase stop_phase 
479 480
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
481

482 483
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
484

485
  | not (phase `happensBefore` stop_phase)
486 487 488 489
	-- Something has gone wrong.  We'll try to cover all the cases when
	-- this could happen, so if we reach here it is a panic.
	-- eg. it might happen if the -C flag is used on a source file that
	-- has {-# OPTIONS -fasm #-}.
490 491 492 493 494
  = panic ("pipeLoop: at phase " ++ show phase ++ 
	   " but I wanted to stop at phase " ++ show stop_phase)

  | otherwise 
  = do	{ (next_phase, dflags', maybe_loc, output_fn)
495
		<- runPhase phase stop_phase dflags orig_basename 
496
			    orig_suff input_fn orig_get_output_fn maybe_loc
497
	; pipeLoop dflags' next_phase stop_phase output_fn
498 499
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

500
getOutputFilename
501 502 503
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
504 505
 = func
 where
506
	func dflags next_phase maybe_location
507 508 509 510
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
511
	   where
512 513 514 515 516 517 518 519 520 521 522
		hcsuf      = hcSuf dflags
		odir       = objectDir dflags
		osuf       = objectSuf dflags
		keep_hc    = dopt Opt_KeepHcFiles dflags
		keep_raw_s = dopt Opt_KeepRawSFiles dflags
		keep_s     = dopt Opt_KeepSFiles dflags

		myPhaseInputExt HCc    = hcsuf
		myPhaseInputExt StopLn = osuf
		myPhaseInputExt other  = phaseInputExt other

523
		is_last_phase = next_phase `eqPhase` stop_phase
524 525 526 527

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
528
     			     StopLn              -> True
529 530 531 532 533
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

534
		suffix = myPhaseInputExt next_phase
535 536 537

		-- persistent object files get put in odir
	        persistent_fn 
538 539
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
540

541
		persistent = basename `joinFileExt` suffix
542

543
		odir_persistent
544
		   | Just loc <- maybe_location = ml_obj_file loc
545
		   | Just d <- odir = d `joinFileName` persistent
546 547
		   | otherwise      = persistent

548

549 550 551 552 553 554 555 556 557 558
-- -----------------------------------------------------------------------------
-- Each phase in the pipeline returns the next phase to execute, and the
-- name of the file in which the output was placed.
--
-- We must do things dynamically this way, because we often don't know
-- what the rest of the phases will be until part-way through the
-- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
-- of a source file can change the latter stages of the pipeline from
-- taking the via-C route to using the native code generator.

559 560
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
561 562 563 564
	 -> DynFlags
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
565
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
566
			-- how to calculate the output filename
567
	 -> Maybe ModLocation		-- the ModLocation, if we have one
568
	 -> IO (Phase,	  		-- next phase
569 570 571
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
572

573 574 575 576
	-- Invariant: the output filename always contains the output
	-- Interesting case: Hsc when there is no recompilation to do
	--		     Then the output filename is still a .o file 

577 578 579
-------------------------------------------------------------------------------
-- Unlit phase 

580
runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
581
  = do let unlit_flags = getOpts dflags opt_L
rrt's avatar
rrt committed
582
       -- The -h option passes the file name for unlit to put in a #line directive
583
       output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
584

585 586
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
587 588
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
589 590
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
591
			  ])
592

593
       return (Cpp sf, dflags, maybe_loc, output_fn)
594 595

-------------------------------------------------------------------------------
596 597
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
598

599
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
600 601
  = do src_opts <- getOptionsFromFile input_fn
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
602
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
603

604
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
605 606
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
607
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
608
	else do
609
	    output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
610
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
611
	    return (HsPp sf, dflags, maybe_loc, output_fn)
612

sof's avatar
sof committed
613 614 615
-------------------------------------------------------------------------------
-- HsPp phase 

616
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
617
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
618 619
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
620
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
621
	else do
622
	    let hspp_opts = getOpts dflags opt_F
623
	    let orig_fn = basename `joinFileExt` suff
624
	    output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
625 626
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
627 628 629 630 631
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
632
	    return (Hsc sf, dflags, maybe_loc, output_fn)
633

634 635 636
-----------------------------------------------------------------------------
-- Hsc phase

637 638
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
639
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
640
 = do	-- normal Hsc mode, not mkdependHS
641

642
  -- we add the current directory (i.e. the directory in which
643
  -- the .hs files resides) to the include path, since this is
644
  -- what gcc does, and it's probably what you want.
645
	let current_dir = directoryOf basename
646
	
647 648
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
649
	
650
  -- gather the imports and module name
651
        (hspp_buf,mod_name,imps,src_imps) <- 
652 653 654
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
655
			          ; return (Nothing, mkModuleName m, [], []) }
656

657
		_           -> do { buf <- hGetStringBuffer input_fn
658
			    ; (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename `joinFileExt` suff)
659
			    ; return (Just buf, mod_name, imps, src_imps) }
660 661 662 663 664 665 666

  -- Build a ModLocation to pass to hscMain.
  -- The source filename is rather irrelevant by now, but it's used
  -- by hscMain for messages.  hscMain also needs 
  -- the .hi and .o filenames, and this is as good a way
  -- as any to generate them, and better than most. (e.g. takes 
  -- into accout the -osuf flags)
667
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
668 669 670 671 672 673 674 675 676

  -- Boot-ify it if necessary
	let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
		      | otherwise	     = location1 
					

  -- Take -ohi into account if present
  -- This can't be done in mkHomeModuleLocation because
  -- it only applies to the module being compiles
677 678
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
679 680 681 682 683 684 685
		      | otherwise      = location2

  -- Take -o into account if present
  -- Very like -ohi, but we must *only* do this if we aren't linking
  -- (If we're linking then the -o applies to the linked thing, not to
  -- the object file for one module.)
  -- Note the nasty duplication with the same computation in compileFile above
686 687 688
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
689 690 691 692 693 694 695
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

	    o_file = ml_obj_file location4 	-- The real object file


  -- Figure out if the source has changed, for recompilation avoidance.
696
  --
697
  -- Setting source_unchanged to True means that M.o seems
698 699
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
700
  -- Setting source_unchanged to False tells the compiler that M.o is out of
701
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Simon Marlow's avatar
Simon Marlow committed
702 703
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)

704
	let force_recomp = dopt Opt_ForceRecomp dflags
705
	source_unchanged <- 
706
          if force_recomp || not (isStopLn stop)
707 708
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
709
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
710 711
	     then return False	
		-- Otherwise look at file modification dates
712
	     else do o_file_exists <- doesFileExist o_file
713
		     if not o_file_exists
714
		        then return False	-- Need to recompile
715
			else do t2 <- getModificationTime o_file
716
			        if t2 > src_timestamp
717 718
				  then return True
				  else return False
719

720
  -- get the DynFlags
721
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
722
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
723
	output_fn  <- get_output_fn dflags next_phase (Just location4)
724

725
        let dflags' = dflags { hscTarget = hsc_lang,
726 727
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
728

729
	hsc_env <- newHscEnv dflags'
730

731
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
732 733 734 735 736 737 738 739 740 741 742 743
	mod <- addHomeModuleToFinder hsc_env mod_name location4

  -- Make the ModSummary to hand to hscMain
	let
	    mod_summary = ModSummary {	ms_mod 	     = mod, 
					ms_hsc_src   = src_flavour,
				 	ms_hspp_file = input_fn,
                                        ms_hspp_opts = dflags,
					ms_hspp_buf  = hspp_buf,
					ms_location  = location4,
					ms_hs_date   = src_timestamp,
					ms_obj_date  = Nothing,
744 745
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
746

747
  -- run the compiler!
748
	mbResult <- hscCompileOneShot hsc_env
749 750
			  mod_summary source_unchanged 
			  Nothing	-- No iface
751
                          Nothing       -- No "module i of n" progress info
752

753 754
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
755
          Just HscNoRecomp
756 757 758 759 760
              -> do SysTools.touch dflags' "Touching object file" o_file
                    -- The .o file must have a later modification date
                    -- than the source file (else we wouldn't be in HscNoRecomp)
                    -- but we touch it anyway, to keep 'make' happy (we think).
                    return (StopLn, dflags', Just location4, o_file)
761
          Just (HscRecomp hasStub)
762
              -> do when hasStub $
Simon Marlow's avatar
Simon Marlow committed
763
                         do stub_o <- compileStub dflags' mod location4
764 765 766 767 768 769
                            consIORef v_Ld_inputs stub_o
                    -- In the case of hs-boot files, generate a dummy .o-boot 
                    -- stamp file for the benefit of Make
                    when (isHsBoot src_flavour) $
                      SysTools.touch dflags' "Touching object file" o_file
                    return (next_phase, dflags', Just location4, output_fn)
770

771 772 773
-----------------------------------------------------------------------------
-- Cmm phase

774
runPhase CmmCpp _stop dflags _basename _suff input_fn get_output_fn maybe_loc
775
  = do
776
       output_fn <- get_output_fn dflags Cmm maybe_loc
777
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
778
       return (Cmm, dflags, maybe_loc, output_fn)
779

780
runPhase Cmm stop dflags basename _ input_fn get_output_fn maybe_loc
781
  = do
782
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
783
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
784
	output_fn <- get_output_fn dflags next_phase maybe_loc
785

786
        let dflags' = dflags { hscTarget = hsc_lang,
787 788
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
789

790
	ok <- hscCmmFile dflags' input_fn
791 792 793

	when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))

794
	return (next_phase, dflags, maybe_loc, output_fn)
795

796 797 798 799 800 801
-----------------------------------------------------------------------------
-- Cc phase

-- we don't support preprocessing .c files (with -E) now.  Doing so introduces
-- way too many hacks, and I can't say I've ever used it anyway.

802
runPhase cc_phase _stop dflags _basename _suff input_fn get_output_fn maybe_loc
803
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
804
   = do	let cc_opts = getOpts dflags opt_c
805
	    hcc = cc_phase `eqPhase` HCc
806

807
       	let cmdline_include_paths = includePaths dflags
808

809 810 811 812 813 814
	-- HC files have the dependent packages stamped into them
	pkgs <- if hcc then getHCFilePackages input_fn else return []

	-- add package include paths even if we're just compiling .c
	-- files; this is the Value Add(TM) that using ghc instead of
	-- gcc gives you :)
815
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
816 817
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
818

819
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
820
        gcc_extra_viac_flags <- getExtraViaCOpts dflags
821
        let pic_c_flags = picCCOpts dflags
822

823
        let verb = getVerbFlag dflags
824

825
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
826

827 828
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
829
		      | otherwise         = [ ]
830

Simon Marlow's avatar
Simon Marlow committed
831 832 833
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

834
	-- Decide next phase
835 836 837
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
838 839
		| hcc && mangle     = Mangle
		| otherwise         = As
840
	output_fn <- get_output_fn dflags next_phase maybe_loc
841

842 843
	let
	  more_hcc_opts =
844
#if i386_TARGET_ARCH
845 846 847 848
	   	-- on x86 the floating point regs have greater precision
	     	-- than a double, which leads to unpredictable results.
		-- By default, we turn this off with -ffloat-store unless
		-- the user specified -fexcess-precision.
849 850 851
		(if dopt Opt_ExcessPrecision dflags 
                        then [] 
                        else [ "-ffloat-store" ]) ++
852 853 854 855 856 857 858 859 860
#endif
		-- gcc's -fstrict-aliasing allows two accesses to memory
		-- to be considered non-aliasing if they have different types.
		-- This interacts badly with the C code we generate, which is
		-- very weakly typed, being derived from C--.
		["-fno-strict-aliasing"]



861 862 863 864 865
	SysTools.runCc dflags (
		-- force the C compiler to interpret this file as C when
		-- compiling .hc files, by adding the -x c option.
		-- Also useful for plain .c files, just in case GHC saw a 
		-- -x c option.
866 867
			[ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
                                                then SysTools.Option "c++" else SysTools.Option "c"] ++
868
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
869
			, SysTools.Option "-o"
sof's avatar
sof committed
870
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
871 872 873
			]
		       ++ map SysTools.Option (
		          md_c_flags
874
                       ++ pic_c_flags
875 876 877 878 879 880 881