DriverPipeline.hs 61.4 KB
Newer Older
1 2 3
{-# OPTIONS -fno-cse #-}
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

4 5 6 7
-----------------------------------------------------------------------------
--
-- GHC Driver
--
8
-- (c) The University of Glasgow 2005
9 10 11 12
--
-----------------------------------------------------------------------------

module DriverPipeline (
13 14
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
15
   oneShot, compileFile,
16

17
	-- Interfaces for the batch-mode driver
18
   linkBinary,
19

20 21
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
22
   compile,
23
   link, 
24

25 26 27 28
  ) where

#include "HsVersions.h"

29
import Packages
30
import HeaderInfo
31
import DriverPhases
32
import SysTools
33
import HscMain
34
import Finder
35 36 37
import HscTypes
import Outputable
import Module
38
import LazyUniqFM		( eltsUFM )
39
import ErrUtils
40
import DynFlags
41
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
42
import Config
43
import Panic
44
import Util
45
import StringBuffer	( hGetStringBuffer )
46
import BasicTypes	( SuccessFlag(..) )
47
import Maybes		( expectJust )
48
import ParserCoreUtils	( getCoreModuleName )
49
import SrcLoc
50
import FastString
51

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

65 66
-- ---------------------------------------------------------------------------
-- Pre-process
67 68 69

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

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
74 75
preprocess :: HscEnv -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
preprocess hsc_env (filename, mb_phase) =
76
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
77
  runPipeline anyHsc hsc_env (filename, mb_phase) 
Simon Marlow's avatar
Simon Marlow committed
78
        Nothing Temporary Nothing{-no ModLocation-}
79

80 81
-- ---------------------------------------------------------------------------
-- Compile
82 83 84 85 86 87 88 89 90 91

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

92
compile :: HscEnv
93 94 95 96 97 98
        -> 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

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
99
compile hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
100 101 102 103
 = do
   let dflags0     = ms_hspp_opts summary
       this_mod    = ms_mod summary
       src_flavour = ms_hsc_src summary
104 105 106
       location	   = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location) 
       input_fnpp  = ms_hspp_file summary
107

108
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
109

Ian Lynagh's avatar
Ian Lynagh committed
110
   let basename = dropExtension input_fn
111

112 113 114
  -- 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
115 116 117
   let current_dir = case takeDirectory basename of
                     "" -> "." -- XXX Hack
                     d -> d
118 119
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
120
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
121

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

130
   let dflags' = dflags { hscTarget = hsc_lang,
131
				hscOutName = output_fn,
132
				extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
133
   let hsc_env' = hsc_env { hsc_dflags = dflags' }
134

135
   -- -fforce-recomp should also work with --make
136 137
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
138
       object_filename = ml_obj_file location
139

140 141
   let getStubLinkable False = return []
       getStubLinkable True
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
142
           = do stub_o <- compileStub hsc_env' this_mod location
143 144
                return [ DotO stub_o ]

145
       handleBatch HscNoRecomp
146
           = ASSERT (isJust maybe_old_linkable)
147 148 149
             return maybe_old_linkable

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

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

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

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

216
-----------------------------------------------------------------------------
217 218
-- stub .h and .c files (for foreign export support)

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

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
235 236
compileStub :: HscEnv -> Module -> ModLocation -> IO FilePath
compileStub hsc_env mod location = do
Ian Lynagh's avatar
Ian Lynagh committed
237 238
	let (o_base, o_ext) = splitExtension (ml_obj_file location)
	    stub_o = (o_base ++ "_stub") <.> o_ext
239

240
	-- compile the _stub.c file w/ gcc
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
241 242
	let (stub_c,_,_) = mkStubPaths (hsc_dflags hsc_env) (moduleName mod) location
	runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
243 244 245
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
246 247


248 249
-- ---------------------------------------------------------------------------
-- Link
250

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

270
link NoLink _ _ _
271 272
   = return Succeeded

273
link LinkBinary dflags batch_attempt_linking hpt
274
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
275 276 277
   = do
        let
            home_mod_infos = eltsUFM hpt
278

Ian Lynagh's avatar
Ian Lynagh committed
279 280
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
281

Ian Lynagh's avatar
Ian Lynagh committed
282 283
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
284

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

Ian Lynagh's avatar
Ian Lynagh committed
287 288 289 290 291
        -- 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
292

Ian Lynagh's avatar
Ian Lynagh committed
293 294
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
295

Ian Lynagh's avatar
Ian Lynagh committed
296
            exe_file = exeFileName dflags
297

Ian Lynagh's avatar
Ian Lynagh committed
298 299
        -- if the modification time on the executable is later than the
        -- modification times on all of the objects, then omit linking
300
        -- (unless the -fforce-recomp flag was given).
Ian Lynagh's avatar
Ian Lynagh committed
301
        e_exe_time <- IO.try $ getModificationTime exe_file
302 303 304 305
        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 ]
306 307 308
            linking_needed = case e_exe_time of
                               Left _  -> True
                               Right t -> any (t <) other_times
309

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

315
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
316
                                 <+> text "...")
317

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

325
        debugTraceMsg dflags 3 (text "link: done")
326

Ian Lynagh's avatar
Ian Lynagh committed
327
        -- linkBinary only returns if it succeeds
328 329 330
        return Succeeded

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

335 336 337 338 339 340
-- warning suppression
link other _ _ _ = panicBadLink other

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

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
344 345 346 347
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
  doLink (hsc_dflags hsc_env) stop_phase o_files
348

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
349 350
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile hsc_env stop_phase (src, mb_phase) = do
351 352
   exists <- doesFileExist src
   when (not exists) $ 
353
   	ghcError (CmdLineError ("does not exist: " ++ src))
354 355
   
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
356
        dflags = hsc_dflags hsc_env
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
	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
372
                        _          -> stop_phase
373

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
374
   (_, out_file) <- runPipeline stop_phase' hsc_env
Simon Marlow's avatar
Simon Marlow committed
375 376
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
377 378 379 380 381 382 383 384 385 386 387
   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 ()
388 389
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
390
        other      -> panicBadLink other
391 392 393
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
394
    link_pkgs
395 396
     | dopt Opt_AutoLinkPackages dflags = [haskell98PackageId]
     | otherwise                        = []
397 398


399 400
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
401

402 403 404 405
-- 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.

406
-- The DynFlags can be modified by phases in the pipeline (eg. by
407 408 409 410 411 412 413 414 415 416 417 418 419
-- 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.
420

421
runPipeline
422
  :: Phase		        -- When to stop
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
423
  -> HscEnv                     -- Compilation environment
424
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
Simon Marlow's avatar
Simon Marlow committed
425
  -> Maybe FilePath             -- original basename (if different from ^^^)
426 427
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
428
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
429

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
430
runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
431
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
432
  let dflags0 = hsc_dflags hsc_env0
Ian Lynagh's avatar
Ian Lynagh committed
433 434
      (input_basename, suffix) = splitExtension input_fn
      suffix' = drop 1 suffix -- strip off the .
Simon Marlow's avatar
Simon Marlow committed
435 436
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
437

438 439
      -- Decide where dump files should go based on the pipeline output
      dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
440
      hsc_env = hsc_env0 {hsc_dflags = dflags}
441

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

445 446 447 448 449 450
  -- 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.
451

452
  when (not (start_phase `happensBefore` stop_phase)) $
453
	ghcError (UsageError 
454 455
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
456

457 458
  -- 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)
459
  let get_output_fn = getOutputFilename stop_phase output basename
460

461
  -- Execute the pipeline...
462
  (dflags', output_fn, maybe_loc) <- 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
463
	pipeLoop hsc_env start_phase stop_phase input_fn 
Ian Lynagh's avatar
Ian Lynagh committed
464
	  	 basename suffix' get_output_fn maybe_loc
465

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

482 483


dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
484
pipeLoop :: HscEnv -> Phase -> Phase 
485
	 -> FilePath  -> String -> Suffix
486
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
487 488
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
489

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
490
pipeLoop hsc_env phase stop_phase 
491 492
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
493

494
  | phase `eqPhase` stop_phase		  -- All done
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
495
  = return (hsc_dflags hsc_env, input_fn, maybe_loc)
496

497
  | not (phase `happensBefore` stop_phase)
498 499 500 501
	-- 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 #-}.
502 503 504 505
  = panic ("pipeLoop: at phase " ++ show phase ++ 
	   " but I wanted to stop at phase " ++ show stop_phase)

  | otherwise 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
506 507 508 509 510 511
  = do (next_phase, dflags', maybe_loc, output_fn)
          <- runPhase phase stop_phase hsc_env orig_basename 
                      orig_suff input_fn orig_get_output_fn maybe_loc
       let hsc_env' = hsc_env {hsc_dflags = dflags'}
       pipeLoop hsc_env' next_phase stop_phase output_fn
                orig_basename orig_suff orig_get_output_fn maybe_loc
512

513
getOutputFilename
514 515 516
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
517 518
 = func
 where
519
	func dflags next_phase maybe_location
520 521 522 523
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
524
	   where
525 526 527 528 529 530 531 532 533 534 535
		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

536
		is_last_phase = next_phase `eqPhase` stop_phase
537 538 539 540

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
541
     			     StopLn              -> True
542 543 544 545 546
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

547
		suffix = myPhaseInputExt next_phase
548 549 550

		-- persistent object files get put in odir
	        persistent_fn 
551 552
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
553

Ian Lynagh's avatar
Ian Lynagh committed
554
		persistent = basename <.> suffix
555

556
		odir_persistent
557
		   | Just loc <- maybe_location = ml_obj_file loc
Ian Lynagh's avatar
Ian Lynagh committed
558
		   | Just d <- odir = d </> persistent
559 560
		   | otherwise      = persistent

561

562 563 564 565 566 567 568 569 570 571
-- -----------------------------------------------------------------------------
-- 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.

572 573
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
574
	 -> HscEnv
575 576 577
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
578
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
579
			-- how to calculate the output filename
580
	 -> Maybe ModLocation		-- the ModLocation, if we have one
581
	 -> IO (Phase,	  		-- next phase
582 583 584
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
585

586 587 588 589
	-- 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 

590 591 592
-------------------------------------------------------------------------------
-- Unlit phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
593
runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
594
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
595
       let dflags = hsc_dflags hsc_env
596
       output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
597

598 599 600 601 602 603 604 605 606 607 608 609 610
       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
611

612
       return (Cpp sf, dflags, maybe_loc, output_fn)
613 614

-------------------------------------------------------------------------------
615 616
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
617

618
runPhase (Cpp sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
619
  = do let dflags0 = hsc_dflags hsc_env
620
       src_opts <- getOptionsFromFile dflags0 input_fn
621
       (dflags, unhandled_flags, warns) <- parseDynamicFlags dflags0 src_opts
622
       handleFlagWarnings dflags warns
623
       checkProcessArgsResult unhandled_flags
624

625
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
626 627
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
628
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
629
	else do
630
	    output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
631
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
632
	    return (HsPp sf, dflags, maybe_loc, output_fn)
633

sof's avatar
sof committed
634 635 636
-------------------------------------------------------------------------------
-- HsPp phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
637 638 639
runPhase (HsPp sf) _stop hsc_env basename suff input_fn get_output_fn maybe_loc
  = do let dflags = hsc_dflags hsc_env
       if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
640 641
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
642
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
643
	else do
644
	    let hspp_opts = getOpts dflags opt_F
Ian Lynagh's avatar
Ian Lynagh committed
645
	    let orig_fn = basename <.> suff
646
	    output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
647 648
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
649 650 651 652 653
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
654
	    return (Hsc sf, dflags, maybe_loc, output_fn)
655

656 657 658
-----------------------------------------------------------------------------
-- Hsc phase

659 660
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
661
runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc 
662
 = do	-- normal Hsc mode, not mkdependHS
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
663
        let dflags0 = hsc_dflags hsc_env
664

665
  -- we add the current directory (i.e. the directory in which
666
  -- the .hs files resides) to the include path, since this is
667
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
668 669 670
	let current_dir = case takeDirectory basename of
                      "" -> "." -- XXX Hack
                      d -> d
671
	
672 673
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
674
	
675
  -- gather the imports and module name
676
        (hspp_buf,mod_name,imps,src_imps) <- 
677 678 679
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
680
			          ; return (Nothing, mkModuleName m, [], []) }
681

682
		_           -> do { buf <- hGetStringBuffer input_fn
Ian Lynagh's avatar
Ian Lynagh committed
683
			    ; (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
684
			    ; return (Just buf, mod_name, imps, src_imps) }
685 686 687 688 689 690 691

  -- 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)
692
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
693 694 695 696 697 698 699 700 701

  -- 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
702 703
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
704 705 706 707 708 709 710
		      | 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
711 712 713
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
714 715 716 717 718 719 720
		      = 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.
721
  --
722
  -- Setting source_unchanged to True means that M.o seems
723 724
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
725
  -- Setting source_unchanged to False tells the compiler that M.o is out of
726
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Ian Lynagh's avatar
Ian Lynagh committed
727
	src_timestamp <- getModificationTime (basename <.> suff)
Simon Marlow's avatar
Simon Marlow committed
728

729
	let force_recomp = dopt Opt_ForceRecomp dflags
730
	source_unchanged <- 
731
          if force_recomp || not (isStopLn stop)
732 733
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
734
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
735 736
	     then return False	
		-- Otherwise look at file modification dates
737
	     else do o_file_exists <- doesFileExist o_file
738
		     if not o_file_exists
739
		        then return False	-- Need to recompile
740
			else do t2 <- getModificationTime o_file
741
			        if t2 > src_timestamp
742 743
				  then return True
				  else return False
744

745
  -- get the DynFlags
746
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
747
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
748
	output_fn  <- get_output_fn dflags next_phase (Just location4)
749

750
        let dflags' = dflags { hscTarget = hsc_lang,
751 752
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
753

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
754
        let hsc_env' = hsc_env {hsc_dflags = dflags'}
755

756
  -- Tell the finder cache about this module
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
757
	mod <- addHomeModuleToFinder hsc_env' mod_name location4
Simon Marlow's avatar
Simon Marlow committed
758 759 760 761 762 763 764 765 766 767 768

  -- 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,
769 770
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
771

772
  -- run the compiler!
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
773
	mbResult <- hscCompileOneShot hsc_env'
774 775
			  mod_summary source_unchanged 
			  Nothing	-- No iface
776
                          Nothing       -- No "module i of n" progress info
777

778
	case mbResult of
779
          Nothing -> ghcError (PhaseFailed "hsc" (ExitFailure 1))
780
          Just HscNoRecomp
781 782 783 784 785
              -> 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)
786
          Just (HscRecomp hasStub)
787
              -> do when hasStub $
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
788
                         do stub_o <- compileStub hsc_env' mod location4
789 790 791 792 793 794
                            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)
795

796 797 798
-----------------------------------------------------------------------------
-- Cmm phase

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
799
runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
800
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
801
       let dflags = hsc_dflags hsc_env
802
       output_fn <- get_output_fn dflags Cmm maybe_loc
803
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
804
       return (Cmm, dflags, maybe_loc, output_fn)
805

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
806
runPhase Cmm stop hsc_env basename _ input_fn get_output_fn maybe_loc
807
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
808
        let dflags = hsc_dflags hsc_env
809
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
810
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang