DriverPipeline.hs 60.3 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
35
import LazyUniqFM		( eltsUFM )
36
import ErrUtils
37
import DynFlags
38
import StaticFlags	( v_Ld_inputs, opt_Static, 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
import FastString
49

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

63 64
-- ---------------------------------------------------------------------------
-- Pre-process
65 66 67

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

72 73 74
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
75 76
  runPipeline anyHsc dflags (filename, mb_phase) 
        Nothing Temporary Nothing{-no ModLocation-}
77

78 79
-- ---------------------------------------------------------------------------
-- Compile
80 81 82 83 84 85 86 87 88 89

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

90
compile :: HscEnv
91 92 93 94 95 96 97 98 99 100 101
        -> 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
102 103 104
       location	   = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location) 
       input_fnpp  = ms_hspp_file summary
105

106
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
107

Ian Lynagh's avatar
Ian Lynagh committed
108
   let basename = dropExtension input_fn
109

110 111 112
  -- 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.
Ian Lynagh's avatar
Ian Lynagh committed
113 114 115
   let current_dir = case takeDirectory basename of
                     "" -> "." -- XXX Hack
                     d -> d
116 117
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
118

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

127
   let dflags' = dflags { hscTarget = hsc_lang,
128
				hscOutName = output_fn,
129 130 131
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
132 133
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
134
       hsc_env' = hsc_env { hsc_dflags = dflags' }
135
       object_filename = ml_obj_file location
136

137 138 139 140 141
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

142
       handleBatch HscNoRecomp
143
           = ASSERT (isJust maybe_old_linkable)
144 145 146
             return maybe_old_linkable

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

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

172
       handleInterpreted InteractiveNoRecomp
173
           = ASSERT (isJust maybe_old_linkable)
174 175
             return maybe_old_linkable
       handleInterpreted (InteractiveRecomp hasStub comp_bc modBreaks)
176
           = do stub_unlinked <- getStubLinkable hasStub
177
                let hs_unlinked = [BCOs comp_bc modBreaks]
178
                    unlinked_time = ms_hs_date summary
179 180 181 182 183 184 185 186
                  -- 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)
187
                return (Just linkable)
188

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

213
-----------------------------------------------------------------------------
214 215
-- stub .h and .c files (for foreign export support)

216 217 218
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
219 220 221 222 223 224 225 226 227 228 229 230 231
-- 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.

232 233
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
Ian Lynagh's avatar
Ian Lynagh committed
234 235
	let (o_base, o_ext) = splitExtension (ml_obj_file location)
	    stub_o = (o_base ++ "_stub") <.> o_ext
236

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

	return stub_o
243 244


245 246
-- ---------------------------------------------------------------------------
-- Link
247

Ian Lynagh's avatar
Ian Lynagh committed
248 249 250 251
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
252 253 254 255 256 257 258 259 260 261
     -> 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
262
link LinkInMemory _ _ _
263
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
264
         return Succeeded
265 266
#endif

267
link NoLink _ _ _
268 269
   = return Succeeded

270
link LinkBinary dflags batch_attempt_linking hpt
271
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
272 273 274
   = do
        let
            home_mod_infos = eltsUFM hpt
275

Ian Lynagh's avatar
Ian Lynagh committed
276 277
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
278

Ian Lynagh's avatar
Ian Lynagh committed
279 280
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
281

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

Ian Lynagh's avatar
Ian Lynagh committed
284 285 286 287 288
        -- 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
289

Ian Lynagh's avatar
Ian Lynagh committed
290 291
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
292

Ian Lynagh's avatar
Ian Lynagh committed
293
            exe_file = exeFileName dflags
294

Ian Lynagh's avatar
Ian Lynagh committed
295 296 297 298
        -- 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
299 300 301 302
        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 ]
303 304 305
            linking_needed = case e_exe_time of
                               Left _  -> True
                               Right t -> any (t <) other_times
306

Ian Lynagh's avatar
Ian Lynagh committed
307
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
308
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
309 310
                   return Succeeded
           else do
311

312
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
313
                                 <+> text "...")
314

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

322
        debugTraceMsg dflags 3 (text "link: done")
323

Ian Lynagh's avatar
Ian Lynagh committed
324
        -- linkBinary only returns if it succeeds
325 326 327
        return Succeeded

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

332 333 334 335 336 337
-- warning suppression
link other _ _ _ = panicBadLink other

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

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

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

   (_, out_file) <- runPipeline stop_phase' dflags
Simon Marlow's avatar
Simon Marlow committed
371 372
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
373 374 375 376 377 378 379 380 381 382 383
   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 ()
384 385
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
386
        other      -> panicBadLink other
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
  let
Ian Lynagh's avatar
Ian Lynagh committed
427 428
      (input_basename, suffix) = splitExtension input_fn
      suffix' = drop 1 suffix -- strip off the .
Simon Marlow's avatar
Simon Marlow committed
429 430
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
431

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

435
	-- If we were given a -x flag, then use that phase to start from
Ian Lynagh's avatar
Ian Lynagh committed
436
      start_phase = fromMaybe (startPhase suffix') mb_phase
437

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

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

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

454
  -- Execute the pipeline...
455 456
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
Ian Lynagh's avatar
Ian Lynagh committed
457
	  	 basename suffix' get_output_fn maybe_loc
458

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

475 476


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

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

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

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

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

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

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

539
		suffix = myPhaseInputExt next_phase
540 541 542

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

Ian Lynagh's avatar
Ian Lynagh committed
546
		persistent = basename <.> suffix
547

548
		odir_persistent
549
		   | Just loc <- maybe_location = ml_obj_file loc
Ian Lynagh's avatar
Ian Lynagh committed
550
		   | Just d <- odir = d </> persistent
551 552
		   | otherwise      = persistent

553

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

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

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

582 583 584
-------------------------------------------------------------------------------
-- Unlit phase 

585
runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
586
  = do
587
       output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
588

589 590 591 592 593 594 595 596 597 598 599 600 601
       let unlit_flags = getOpts dflags opt_L
           flags = map SysTools.Option unlit_flags ++
                   [ -- The -h option passes the file name for unlit to
                     -- put in a #line directive
                     SysTools.Option     "-h"
                     -- cpp interprets \b etc as escape sequences,
                     -- so we use / for filenames in pragmas
                   , SysTools.Option $ reslash Forwards $ normalise input_fn
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

       SysTools.runUnlit dflags flags
602

603
       return (Cpp sf, dflags, maybe_loc, output_fn)
604 605

-------------------------------------------------------------------------------
606 607
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
608

609
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
610 611
  = do src_opts <- getOptionsFromFile input_fn
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
Ian Lynagh's avatar
Ian Lynagh committed
612
       checkProcessArgsResult unhandled_flags (basename <.> suff)
613

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

sof's avatar
sof committed
623 624 625
-------------------------------------------------------------------------------
-- HsPp phase 

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

644 645 646
-----------------------------------------------------------------------------
-- Hsc phase

647 648
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
649
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
650
 = do	-- normal Hsc mode, not mkdependHS
651

652
  -- we add the current directory (i.e. the directory in which
653
  -- the .hs files resides) to the include path, since this is
654
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
655 656 657
	let current_dir = case takeDirectory basename of
                      "" -> "." -- XXX Hack
                      d -> d
658
	
659 660
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
661
	
662
  -- gather the imports and module name
663
        (hspp_buf,mod_name,imps,src_imps) <- 
664 665 666
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
667
			          ; return (Nothing, mkModuleName m, [], []) }
668

669
		_           -> do { buf <- hGetStringBuffer input_fn
Ian Lynagh's avatar
Ian Lynagh committed
670
			    ; (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
671
			    ; return (Just buf, mod_name, imps, src_imps) }
672 673 674 675 676 677 678

  -- 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)
679
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
680 681 682 683 684 685 686 687 688

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

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

732
  -- get the DynFlags
733
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
734
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
735
	output_fn  <- get_output_fn dflags next_phase (Just location4)
736

737
        let dflags' = dflags { hscTarget = hsc_lang,
738 739
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
740

741
	hsc_env <- newHscEnv dflags'
742

743
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
744 745 746 747 748 749 750 751 752 753 754 755
	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,
756 757
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
758

759
  -- run the compiler!
760
	mbResult <- hscCompileOneShot hsc_env
761 762
			  mod_summary source_unchanged 
			  Nothing	-- No iface
763
                          Nothing       -- No "module i of n" progress info
764

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

783 784 785
-----------------------------------------------------------------------------
-- Cmm phase

786
runPhase CmmCpp _stop dflags _basename _suff input_fn get_output_fn maybe_loc
787
  = do
788
       output_fn <- get_output_fn dflags Cmm maybe_loc
789
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
790
       return (Cmm, dflags, maybe_loc, output_fn)
791

792
runPhase Cmm stop dflags basename _ input_fn get_output_fn maybe_loc
793
  = do
794
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
795
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
796
	output_fn <- get_output_fn dflags next_phase maybe_loc
797

798
        let dflags' = dflags { hscTarget = hsc_lang,
799 800
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
801

802
	ok <- hscCmmFile dflags' input_fn
803 804 805

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

806
	return (next_phase, dflags, maybe_loc, output_fn)
807

808 809 810 811 812 813
-----------------------------------------------------------------------------
-- 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.

814
runPhase cc_phase _stop dflags _basename _suff input_fn get_output_fn maybe_loc
815
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
816
   = do	let cc_opts = getOpts dflags opt_c
817
	    hcc = cc_phase `eqPhase` HCc
818

819
       	let cmdline_include_paths = includePaths dflags
820

821 822 823 824 825 826
	-- 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 :)
827
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
828 829
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
830

831
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
832
        gcc_extra_viac_flags <- getExtraViaCOpts dflags
833
        let pic_c_flags = picCCOpts dflags
834

835
        let verb = getVerbFlag dflags
836