DriverPipeline.hs 57 KB
Newer Older
1 2 3 4 5 6 7
{-# OPTIONS -w #-}
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
-- for details

8 9 10 11
-----------------------------------------------------------------------------
--
-- GHC Driver
--
12
-- (c) The University of Glasgow 2005
13 14 15 16
--
-----------------------------------------------------------------------------

module DriverPipeline (
17 18
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
19
   oneShot, compileFile,
20

21
	-- Interfaces for the batch-mode driver
22
   linkBinary,
23

24 25
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
26
   compile,
27
   link, 
28

29 30 31 32
  ) where

#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
56 57 58 59 60 61 62
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
63
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
64 65 66
import Data.Maybe
import System.Exit
import System.Environment
67

68 69
-- ---------------------------------------------------------------------------
-- Pre-process
70 71 72

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

77 78 79
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
80 81
  runPipeline anyHsc dflags (filename, mb_phase) 
        Nothing Temporary Nothing{-no ModLocation-}
82

83 84
-- ---------------------------------------------------------------------------
-- Compile
85 86 87 88 89 90 91 92 93 94

-- 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.

95
compile :: HscEnv
96 97 98 99 100 101 102 103 104 105 106
        -> 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
107

108 109 110 111
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

112
   let location	  = ms_location summary
113
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
114
   let input_fnpp = ms_hspp_file summary
115

116
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
117

118
   let (basename, _) = splitFilename input_fn
119

120 121 122 123
  -- 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
124 125
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
126

127
   -- Figure out what lang we're generating
128
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
129
   -- ... and what the next phase should be
130
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
131
   -- ... and what file to generate the output into
132 133
   output_fn <- getOutputFilename next_phase 
			Temporary basename dflags next_phase (Just location)
134

135
   let dflags' = dflags { hscTarget = hsc_lang,
136
				hscOutName = output_fn,
137 138 139
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
140 141
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
142
       hsc_env' = hsc_env { hsc_dflags = dflags' }
143
       object_filename = ml_obj_file location
144

145 146 147 148 149
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

150
       handleBatch HscNoRecomp
151
           = ASSERT (isJust maybe_old_linkable)
152 153 154
             return maybe_old_linkable

       handleBatch (HscRecomp hasStub)
155
           | isHsBoot src_flavour
156 157
               = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
                       SysTools.touch dflags' "Touching object file"
158
                                   object_filename
159 160
                    return maybe_old_linkable

161 162 163 164 165
           | otherwise
               = do stub_unlinked <- getStubLinkable hasStub
                    (hs_unlinked, unlinked_time) <-
                        case hsc_lang of
                          HscNothing
166
                            -> return ([], ms_hs_date summary)
167 168
                          -- We're in --make mode: finish the compilation pipeline.
                          _other
Simon Marlow's avatar
Simon Marlow committed
169 170 171
                            -> do runPipeline StopLn dflags (output_fn,Nothing)
                                              (Just basename)
                                              Persistent
172 173 174 175 176 177
                                              (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)
178
                    return (Just linkable)
179

180
       handleInterpreted InteractiveNoRecomp
181
           = ASSERT (isJust maybe_old_linkable)
182 183
             return maybe_old_linkable
       handleInterpreted (InteractiveRecomp hasStub comp_bc modBreaks)
184
           = do stub_unlinked <- getStubLinkable hasStub
185
                let hs_unlinked = [BCOs comp_bc modBreaks]
186
                    unlinked_time = ms_hs_date summary
187 188 189 190 191 192 193 194
                  -- 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)
195
                return (Just linkable)
196

197 198 199 200
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
       --            -> IO (Maybe HomeModInfo)
       runCompiler compiler handle
           = do mbResult <- compiler hsc_env' summary source_unchanged mb_old_iface
201 202
                                     (Just (mod_index, nmods))
                case mbResult of
203 204 205 206 207 208
                  Nothing -> return Nothing
                  Just (result, iface, details) -> do
                        linkable <- handle result
                        return (Just HomeModInfo{ hm_details  = details,
                                                  hm_iface    = iface,
                                                  hm_linkable = linkable })
209
   -- run the compiler
210
   case hsc_lang of
211 212 213 214 215 216 217 218 219
      HscInterpreted
        | isHsBoot src_flavour -> 
                runCompiler hscCompileNothing handleBatch
        | otherwise -> 
                runCompiler hscCompileInteractive handleInterpreted
      HscNothing -> 
                runCompiler hscCompileNothing handleBatch
      _other -> 
                runCompiler hscCompileBatch handleBatch
220

221
-----------------------------------------------------------------------------
222 223
-- stub .h and .c files (for foreign export support)

224 225 226
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
227 228 229 230 231 232 233 234 235 236 237 238 239
-- 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.

240 241 242
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
	let (o_base, o_ext) = splitFilename (ml_obj_file location)
243 244
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

245
	-- compile the _stub.c file w/ gcc
Simon Marlow's avatar
Simon Marlow committed
246
	let (stub_c,_) = mkStubPaths dflags (moduleName mod) location
Simon Marlow's avatar
Simon Marlow committed
247
	runPipeline StopLn dflags (stub_c,Nothing)  Nothing
248 249 250
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
251 252


253 254
-- ---------------------------------------------------------------------------
-- Link
255

Ian Lynagh's avatar
Ian Lynagh committed
256 257 258 259
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
260 261 262 263 264 265 266 267 268 269
     -> 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
270
link LinkInMemory dflags batch_attempt_linking hpt
271
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
272
         return Succeeded
273 274
#endif

275
link NoLink dflags batch_attempt_linking hpt
276 277
   = return Succeeded

278
link LinkBinary dflags batch_attempt_linking hpt
279
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
280 281 282
   = do
        let
            home_mod_infos = eltsUFM hpt
283

Ian Lynagh's avatar
Ian Lynagh committed
284 285
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
286

Ian Lynagh's avatar
Ian Lynagh committed
287 288
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
289

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

Ian Lynagh's avatar
Ian Lynagh committed
292 293 294 295 296
        -- 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
297

Ian Lynagh's avatar
Ian Lynagh committed
298 299
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
300

Ian Lynagh's avatar
Ian Lynagh committed
301
            exe_file = exeFileName dflags
302

Ian Lynagh's avatar
Ian Lynagh committed
303 304 305 306
        -- 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
307 308 309 310 311
        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 ]
            linking_needed
Ian Lynagh's avatar
Ian Lynagh committed
312
                | Left _  <- e_exe_time = True
313
                | Right t <- e_exe_time = any (t <) other_times
314

Ian Lynagh's avatar
Ian Lynagh committed
315 316 317 318
        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
319

Ian Lynagh's avatar
Ian Lynagh committed
320 321
        debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
                                 <+> text "...")
322

Ian Lynagh's avatar
Ian Lynagh committed
323 324 325 326 327
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
        link dflags obj_files pkg_deps
328

329
        debugTraceMsg dflags 3 (text "link: done")
330

Ian Lynagh's avatar
Ian Lynagh committed
331
        -- linkBinary only returns if it succeeds
332 333 334
        return Succeeded

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

339 340 341
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

342
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
343 344 345 346
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

347 348
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
   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
			other      -> stop_phase

   (_, out_file) <- runPipeline stop_phase' dflags
Simon Marlow's avatar
Simon Marlow committed
372 373
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
374 375 376 377 378 379 380 381 382 383 384
   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 ()
385 386
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
387 388 389
  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
390
    link_pkgs = [haskell98PackageId]
391 392


393 394
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
395

396 397 398 399
-- 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.

400
-- The DynFlags can be modified by phases in the pipeline (eg. by
401 402 403 404 405 406 407 408 409 410 411 412 413
-- 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.
414

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

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

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

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

437 438 439 440 441 442
  -- 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.
443

444 445
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
446 447
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
448

449 450
  -- 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)
451
  let get_output_fn = getOutputFilename stop_phase output basename
452

453
  -- Execute the pipeline...
454 455 456
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
457

458
  -- Sometimes, a compilation phase doesn't actually generate any output
459 460
  -- (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
461 462
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
463 464 465 466
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
467
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
468 469 470 471
	   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
472
	   return (dflags', final_fn)
473

474 475


476
pipeLoop :: DynFlags -> Phase -> Phase 
477
	 -> FilePath  -> String -> Suffix
478
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
479 480
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
481

482
pipeLoop dflags phase stop_phase 
483 484
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
485

486 487
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
488

489
  | not (phase `happensBefore` stop_phase)
490 491 492 493
	-- 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 #-}.
494 495 496 497 498
  = 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)
499
		<- runPhase phase stop_phase dflags orig_basename 
500
			    orig_suff input_fn orig_get_output_fn maybe_loc
501
	; pipeLoop dflags' next_phase stop_phase output_fn
502 503
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

504
getOutputFilename
505 506 507
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
508 509
 = func
 where
510
	func dflags next_phase maybe_location
511 512 513 514
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
515
	   where
516 517 518 519 520 521 522 523 524 525 526
		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

527
		is_last_phase = next_phase `eqPhase` stop_phase
528 529 530 531

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
532
     			     StopLn              -> True
533 534 535 536 537
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

538
		suffix = myPhaseInputExt next_phase
539 540 541

		-- persistent object files get put in odir
	        persistent_fn 
542 543
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
544

545
		persistent = basename `joinFileExt` suffix
546

547
		odir_persistent
548
		   | Just loc <- maybe_location = ml_obj_file loc
549
		   | Just d <- odir = d `joinFileName` persistent
550 551
		   | otherwise      = persistent

552

553 554 555 556 557 558 559 560 561 562
-- -----------------------------------------------------------------------------
-- 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.

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

577 578 579 580
	-- 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 

581 582 583
-------------------------------------------------------------------------------
-- Unlit phase 

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

589 590
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
591 592
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
593 594
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
595
			  ])
596

597
       return (Cpp sf, dflags, maybe_loc, output_fn)
598 599

-------------------------------------------------------------------------------
600 601
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
602

603
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
604 605
  = do src_opts <- getOptionsFromFile input_fn
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
606
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
607

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

sof's avatar
sof committed
617 618 619
-------------------------------------------------------------------------------
-- HsPp phase 

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

638 639 640
-----------------------------------------------------------------------------
-- Hsc phase

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

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

		other -> do { buf <- hGetStringBuffer input_fn
662
			    ; (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename `joinFileExt` suff)
663
			    ; return (Just buf, mod_name, imps, src_imps) }
664 665 666 667 668 669 670

  -- 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)
671
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
672 673 674 675 676 677 678 679 680

  -- 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
681 682
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
683 684 685 686 687 688 689
		      | 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
690 691 692
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
693 694 695 696 697 698 699
		      = 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.
700
  --
701
  -- Setting source_unchanged to True means that M.o seems
702 703
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
704
  -- Setting source_unchanged to False tells the compiler that M.o is out of
705
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Simon Marlow's avatar
Simon Marlow committed
706 707
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)

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

724
  -- get the DynFlags
725
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
726
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
727
	output_fn  <- get_output_fn dflags next_phase (Just location4)
728

729
        let dflags' = dflags { hscTarget = hsc_lang,
730 731
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
732

733
	hsc_env <- newHscEnv dflags'
734

735
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
736 737 738 739 740 741 742 743 744 745 746 747 748 749
	mod <- addHomeModuleToFinder hsc_env mod_name location4

  -- Make the ModSummary to hand to hscMain
	let
	    unused_field = panic "runPhase:ModSummary field"
		-- Some fields are not looked at by hscMain
	    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,
750 751
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
752

753
  -- run the compiler!
754
	mbResult <- hscCompileOneShot hsc_env
755 756
			  mod_summary source_unchanged 
			  Nothing	-- No iface
757
                          Nothing       -- No "module i of n" progress info
758

759 760
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
761
          Just HscNoRecomp
762 763 764 765 766
              -> 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)
767
          Just (HscRecomp hasStub)
768
              -> do when hasStub $
Simon Marlow's avatar
Simon Marlow committed
769
                         do stub_o <- compileStub dflags' mod location4
770 771 772 773 774 775
                            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)
776

777 778 779
-----------------------------------------------------------------------------
-- Cmm phase

780
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
781
  = do
782
       output_fn <- get_output_fn dflags Cmm maybe_loc
783
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
784
       return (Cmm, dflags, maybe_loc, output_fn)
785

786
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
787
  = do
788
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
789
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
790
	output_fn <- get_output_fn dflags next_phase maybe_loc
791

792
        let dflags' = dflags { hscTarget = hsc_lang,
793 794
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
795

796
	ok <- hscCmmFile dflags' input_fn
797 798 799

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

800
	return (next_phase, dflags, maybe_loc, output_fn)
801

802 803 804 805 806 807
-----------------------------------------------------------------------------
-- 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.

808
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
809
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
810
   = do	let cc_opts = getOpts dflags opt_c
811
	    hcc = cc_phase `eqPhase` HCc
812

813
       	let cmdline_include_paths = includePaths dflags
814

815 816 817 818 819 820
	-- 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 :)
821
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
822 823
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
824

825
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
826
        gcc_extra_viac_flags <- getExtraViaCOpts dflags
827
        let pic_c_flags = picCCOpts dflags
828

829
        let verb = getVerbFlag dflags
830

831
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
832

833 834
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
835
		      | otherwise         = [ ]
836

837
	let excessPrecision = dopt Opt_ExcessPrecision dflags
838

Simon Marlow's avatar
Simon Marlow committed
839 840 841
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

842
	-- Decide next phase
843 844 845
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
846 847
		| hcc && mangle     = Mangle
		| otherwise         = As
848
	output_fn <- get_output_fn dflags next_phase maybe_loc
849

850 851
	let
	  more_hcc_opts =
852
#if i386_TARGET_ARCH
853 854 855 856 857 858 859 860 861 862 863 864 865 866
	   	-- 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.
		(if excessPrecision then [] else [ "-ffloat-store" ]) ++
#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"]



867 868 869 870 871
	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.
872 873
			[ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
                                                then SysTools.Option "c++" else SysTools.Option "c"] ++
874
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
875
			, SysTools.Option "-o"
sof's avatar
sof committed
876
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
877 878 879
			]
		       ++ map SysTools.Option (
		          md_c_flags
880
                       ++ pic_c_flags
881 882 883 884 885 886 887 888 889
#ifdef sparc_TARGET_ARCH
        -- We only support SparcV9 and better because V8 lacks an atomic CAS
        -- instruction. Note that the user can still override this
	-- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
	-- regardless of the ordering.
        --
        -- This is a temporary hack.
                       ++ ["-mcpu=v9"]
#endif
890
		       ++ (