DriverPipeline.hs 62.7 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 Data.Either
53
import Exception
Simon Marlow's avatar
Simon Marlow committed
54 55 56
import Data.IORef	( readIORef, writeIORef, IORef )
import GHC.Exts		( Int(..) )
import System.Directory
Ian Lynagh's avatar
Ian Lynagh committed
57
import System.FilePath
Simon Marlow's avatar
Simon Marlow committed
58
import System.IO
59
import System.IO.Error as IO
Simon Marlow's avatar
Simon Marlow committed
60
import Control.Monad
61
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
62 63 64
import Data.Maybe
import System.Exit
import System.Environment
65

66 67
-- ---------------------------------------------------------------------------
-- Pre-process
68 69 70

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

220 221 222
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
223 224 225 226 227 228 229 230 231 232 233 234 235
-- 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
236 237
compileStub :: HscEnv -> Module -> ModLocation -> IO FilePath
compileStub hsc_env mod location = do
Ian Lynagh's avatar
Ian Lynagh committed
238 239
	let (o_base, o_ext) = splitExtension (ml_obj_file location)
	    stub_o = (o_base ++ "_stub") <.> o_ext
240

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

	return stub_o
247 248


249 250
-- ---------------------------------------------------------------------------
-- Link
251

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

271
link NoLink _ _ _
272 273
   = return Succeeded

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

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

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

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

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

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

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

299
        linking_needed <- linkingNeeded dflags linkables pkg_deps
300

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

306
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
307
                                 <+> text "...")
308

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

316
        debugTraceMsg dflags 3 (text "link: done")
317

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

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

326 327 328 329 330 331
-- warning suppression
link other _ _ _ = panicBadLink other

panicBadLink :: GhcLink -> a
panicBadLink other = panic ("link: GHC not built to link this way: " ++
                            show other)
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376


linkingNeeded :: DynFlags -> [Linkable] -> [PackageId] -> IO Bool
linkingNeeded dflags linkables pkg_deps = do
        -- if the modification time on the executable is later than the
        -- modification times on all of the objects and libraries, then omit
        -- linking (unless the -fforce-recomp flag was given).
  let exe_file = exeFileName dflags
  e_exe_time <- IO.try $ getModificationTime exe_file
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
        extra_ld_inputs <- readIORef v_Ld_inputs
        e_extra_times <- mapM (IO.try . getModificationTime) extra_ld_inputs
        let (errs,extra_times) = splitEithers e_extra_times
        let obj_times =  map linkableTime linkables ++ extra_times
        if not (null errs) || any (t <) obj_times
            then return True 
            else do

        -- next, check libraries. XXX this only checks Haskell libraries,
        -- not extra_libraries or -l things from the command line.
        let pkg_map = pkgIdMap (pkgState dflags)
            pkg_hslibs  = [ (libraryDirs c, lib)
                          | Just c <- map (lookupPackage pkg_map) pkg_deps,
                            lib <- packageHsLibs dflags c ]

        pkg_libfiles <- mapM (uncurry findHSLib) pkg_hslibs
        if any isNothing pkg_libfiles then return True else do
        e_lib_times <- mapM (IO.try . getModificationTime)
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
           else return False

findHSLib :: [String] -> String -> IO (Maybe FilePath)
findHSLib dirs lib = do
  let batch_lib_file = "lib" ++ lib <.> "a"
  found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
  case found of
    [] -> return Nothing
    (x:_) -> return (Just x)

377 378 379
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
380 381 382 383
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
384

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
385 386
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile hsc_env stop_phase (src, mb_phase) = do
387 388
   exists <- doesFileExist src
   when (not exists) $ 
389
   	ghcError (CmdLineError ("does not exist: " ++ src))
390 391
   
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
392
        dflags = hsc_dflags hsc_env
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
	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
408
                        _          -> stop_phase
409

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
410
   (_, out_file) <- runPipeline stop_phase' hsc_env
Simon Marlow's avatar
Simon Marlow committed
411 412
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
413 414 415 416 417 418 419 420 421 422 423
   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 ()
424 425
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
426
        other      -> panicBadLink other
427 428 429
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
430
    link_pkgs
431 432
     | dopt Opt_AutoLinkPackages dflags = [haskell98PackageId]
     | otherwise                        = []
433 434


435 436
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
437

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

442
-- The DynFlags can be modified by phases in the pipeline (eg. by
443 444 445 446 447 448 449 450 451 452 453 454 455
-- 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.
456

457
runPipeline
458
  :: Phase		        -- When to stop
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
459
  -> HscEnv                     -- Compilation environment
460
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
Simon Marlow's avatar
Simon Marlow committed
461
  -> Maybe FilePath             -- original basename (if different from ^^^)
462 463
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
464
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
465

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
466
runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
467
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
468
  let dflags0 = hsc_dflags hsc_env0
Ian Lynagh's avatar
Ian Lynagh committed
469 470
      (input_basename, suffix) = splitExtension input_fn
      suffix' = drop 1 suffix -- strip off the .
Simon Marlow's avatar
Simon Marlow committed
471 472
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
473

474 475
      -- 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
476
      hsc_env = hsc_env0 {hsc_dflags = dflags}
477

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

481 482 483 484 485 486
  -- 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.
487

488
  when (not (start_phase `happensBefore` stop_phase)) $
489
	ghcError (UsageError 
490 491
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
492

493 494
  -- 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)
495
  let get_output_fn = getOutputFilename stop_phase output basename
496

497
  -- Execute the pipeline...
498
  (dflags', output_fn, maybe_loc) <- 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
499
	pipeLoop hsc_env start_phase stop_phase input_fn 
Ian Lynagh's avatar
Ian Lynagh committed
500
	  	 basename suffix' get_output_fn maybe_loc
501

502
  -- Sometimes, a compilation phase doesn't actually generate any output
503 504
  -- (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
505 506
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
507 508 509 510
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
511
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
512 513 514 515
	   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
516
	   return (dflags', final_fn)
517

518 519


dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
520
pipeLoop :: HscEnv -> Phase -> Phase 
521
	 -> FilePath  -> String -> Suffix
522
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
523 524
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
525

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
526
pipeLoop hsc_env phase stop_phase 
527 528
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
529

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

533
  | not (phase `happensBefore` stop_phase)
534 535 536 537
	-- 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 #-}.
538 539 540 541
  = 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
542 543 544 545 546 547
  = 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
548

549
getOutputFilename
550 551 552
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
553 554
 = func
 where
555
	func dflags next_phase maybe_location
556 557 558 559
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
560
	   where
561 562 563 564 565 566 567 568 569 570 571
		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

572
		is_last_phase = next_phase `eqPhase` stop_phase
573 574 575 576

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
577
     			     StopLn              -> True
578 579 580 581 582
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

583
		suffix = myPhaseInputExt next_phase
584 585 586

		-- persistent object files get put in odir
	        persistent_fn 
587 588
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
589

Ian Lynagh's avatar
Ian Lynagh committed
590
		persistent = basename <.> suffix
591

592
		odir_persistent
593
		   | Just loc <- maybe_location = ml_obj_file loc
Ian Lynagh's avatar
Ian Lynagh committed
594
		   | Just d <- odir = d </> persistent
595 596
		   | otherwise      = persistent

597

598 599 600 601 602 603 604 605 606 607
-- -----------------------------------------------------------------------------
-- 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.

608 609
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
610
	 -> HscEnv
611 612 613
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
614
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
615
			-- how to calculate the output filename
616
	 -> Maybe ModLocation		-- the ModLocation, if we have one
617
	 -> IO (Phase,	  		-- next phase
618 619 620
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
621

622 623 624 625
	-- 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 

626 627 628
-------------------------------------------------------------------------------
-- Unlit phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
629
runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
630
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
631
       let dflags = hsc_dflags hsc_env
632
       output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
633

634 635 636 637 638 639 640 641 642 643 644 645 646
       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
647

648
       return (Cpp sf, dflags, maybe_loc, output_fn)
649 650

-------------------------------------------------------------------------------
651 652
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
653

654
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
655
  = do let dflags0 = hsc_dflags hsc_env
656
       src_opts <- getOptionsFromFile dflags0 input_fn
657
       (dflags, unhandled_flags, warns) <- parseDynamicFlags dflags0 src_opts
658
       handleFlagWarnings dflags warns
659
       checkProcessArgsResult unhandled_flags
660

661
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
662 663
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
664
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
665
	else do
666
	    output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
667
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
668
	    return (HsPp sf, dflags, maybe_loc, output_fn)
669

sof's avatar
sof committed
670 671 672
-------------------------------------------------------------------------------
-- HsPp phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
673 674 675
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
676 677
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
678
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
679
	else do
680
	    let hspp_opts = getOpts dflags opt_F
Ian Lynagh's avatar
Ian Lynagh committed
681
	    let orig_fn = basename <.> suff
682
	    output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
683 684
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
685 686 687 688 689
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
690
	    return (Hsc sf, dflags, maybe_loc, output_fn)
691

692 693 694
-----------------------------------------------------------------------------
-- Hsc phase

695 696
-- 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
697
runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc 
698
 = do	-- normal Hsc mode, not mkdependHS
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
699
        let dflags0 = hsc_dflags hsc_env
700

701
  -- we add the current directory (i.e. the directory in which
702
  -- the .hs files resides) to the include path, since this is
703
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
704 705 706
	let current_dir = case takeDirectory basename of
                      "" -> "." -- XXX Hack
                      d -> d
707
	
708 709
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
710
	
711
  -- gather the imports and module name
712
        (hspp_buf,mod_name,imps,src_imps) <- 
713 714 715
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
716
			          ; return (Nothing, mkModuleName m, [], []) }
717

718
		_           -> do { buf <- hGetStringBuffer input_fn
Ian Lynagh's avatar
Ian Lynagh committed
719
			    ; (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
720
			    ; return (Just buf, mod_name, imps, src_imps) }
721 722 723 724 725 726 727

  -- 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)
728
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
729 730 731 732 733 734 735 736 737

  -- 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
738 739
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
740 741 742 743 744 745 746
		      | 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
747 748 749
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
750 751 752 753 754 755 756
		      = 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.
757
  --
758
  -- Setting source_unchanged to True means that M.o seems
759 760
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
761
  -- Setting source_unchanged to False tells the compiler that M.o is out of
762
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Ian Lynagh's avatar
Ian Lynagh committed
763
	src_timestamp <- getModificationTime (basename <.> suff)
Simon Marlow's avatar
Simon Marlow committed
764

765
	let force_recomp = dopt Opt_ForceRecomp dflags
766
	source_unchanged <- 
767
          if force_recomp || not (isStopLn stop)
768 769
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
770
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
771 772
	     then return False	
		-- Otherwise look at file modification dates
773
	     else do o_file_exists <- doesFileExist o_file
774
		     if not o_file_exists
775
		        then return False	-- Need to recompile
776
			else do t2 <- getModificationTime o_file
777
			        if t2 > src_timestamp
778 779
				  then return True
				  else return False
780

781
  -- get the DynFlags
782
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
783
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
784
	output_fn  <- get_output_fn dflags next_phase (Just location4)
785

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

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

792
  -- Tell the finder cache about this module
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
793
	mod <- addHomeModuleToFinder hsc_env' mod_name location4
Simon Marlow's avatar
Simon Marlow committed
794 795 796 797 798 799 800 801 802 803 804

  -- 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,
805 806
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
807

808
  -- run the compiler!
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
809
	mbResult <- hscCompileOneShot hsc_env'
810 811
			  mod_summary source_unchanged 
			  Nothing	-- No iface
812
                          Nothing       -- No "module i of n" progress info
813

814
	case mbResult of
815
          Nothing -> ghcError (PhaseFailed "hsc" (ExitFailure 1))
816
          Just HscNoRecomp
817 818 819 820 821
              -> 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)
822
          Just (HscRecomp hasStub)
823
              -> do when hasStub $
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
824
                         do stub_o <- compileStub hsc_env' mod location4
825 826 827 828 829 830
                            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)
831

832 833 834
-----------------------------------------------------------------------------
-- Cmm phase

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
835
runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
836
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
837
       let dflags = hsc_dflags hsc_env
838
       output_fn <- get_output_fn dflags Cmm maybe_loc
839
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn