DriverPipeline.hs 76 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 (
Ian Lynagh's avatar
Ian Lynagh committed
13 14
        -- Run a series of compilation steps in a pipeline, for a
        -- collection of source files.
15
   oneShot, compileFile,
16

Ian Lynagh's avatar
Ian Lynagh committed
17
        -- Interfaces for the batch-mode driver
18
   linkBinary,
19

Ian Lynagh's avatar
Ian Lynagh committed
20 21
        -- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess,
22
   compile, compile',
Ian Lynagh's avatar
Ian Lynagh committed
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
Ian Lynagh's avatar
Ian Lynagh committed
38
import UniqFM           ( eltsUFM )
39
import ErrUtils
40
import DynFlags
41
import StaticFlags      ( v_Ld_inputs, opt_PIC, opt_Static, WayName(..) )
42
import Config
43
import Panic
44
import Util
Ian Lynagh's avatar
Ian Lynagh committed
45 46 47 48
import StringBuffer     ( hGetStringBuffer )
import BasicTypes       ( SuccessFlag(..) )
import Maybes           ( expectJust )
import ParserCoreUtils  ( getCoreModuleName )
49
import SrcLoc
50
import FastString
51
import LlvmCodeGen      ( llvmFixupAsm )
52
import MonadUtils
53

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

67 68
-- ---------------------------------------------------------------------------
-- Pre-process
69

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

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

84
-- ---------------------------------------------------------------------------
85

86 87
-- | Compile
--
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
92 93 94
-- reading the OPTIONS pragma from the source file, converting the
-- C or assembly that GHC produces into an object file, and compiling
-- FFI stub files.
95
--
96 97
-- NB.  No old interface can also mean that the source has changed.

98
compile :: HscEnv
99 100 101 102 103
        -> ModSummary      -- ^ summary for module being compiled
        -> Int             -- ^ module N ...
        -> Int             -- ^ ... of M
        -> Maybe ModIface  -- ^ old interface, if we have one
        -> Maybe Linkable  -- ^ old linkable, if we have one
104
        -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful
105

106 107
compile = compile' (hscCompileNothing, hscCompileInteractive, hscCompileBatch)

108 109 110 111
compile' :: 
           (Compiler (HscStatus, ModIface, ModDetails),
            Compiler (InteractiveStatus, ModIface, ModDetails),
            Compiler (HscStatus, ModIface, ModDetails))
112 113 114 115 116 117
        -> HscEnv
        -> ModSummary      -- ^ summary for module being compiled
        -> Int             -- ^ module N ...
        -> Int             -- ^ ... of M
        -> Maybe ModIface  -- ^ old interface, if we have one
        -> Maybe Linkable  -- ^ old linkable, if we have one
118
        -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful
119 120 121

compile' (nothingCompiler, interactiveCompiler, batchCompiler)
        hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
122 123 124 125
 = do
   let dflags0     = ms_hspp_opts summary
       this_mod    = ms_mod summary
       src_flavour = ms_hsc_src summary
Ian Lynagh's avatar
Ian Lynagh committed
126 127
       location    = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location)
128
       input_fnpp  = ms_hspp_file summary
129

130
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
131

Ian Lynagh's avatar
Ian Lynagh committed
132
   let basename = dropExtension input_fn
133

134 135 136
  -- 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
137 138 139
   let current_dir = case takeDirectory basename of
                     "" -> "." -- XXX Hack
                     d -> d
140 141
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
142
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
143

144
   -- Figure out what lang we're generating
145
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
146
   -- ... and what the next phase should be
147
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
148
   -- ... and what file to generate the output into
149
   output_fn <- getOutputFilename next_phase
Ian Lynagh's avatar
Ian Lynagh committed
150
                        Temporary basename dflags next_phase (Just location)
151

152
   let dflags' = dflags { hscTarget = hsc_lang,
Ian Lynagh's avatar
Ian Lynagh committed
153 154
                                hscOutName = output_fn,
                                extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
155
   let hsc_env' = hsc_env { hsc_dflags = dflags' }
156

157
   -- -fforce-recomp should also work with --make
158 159
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
160
       object_filename = ml_obj_file location
161

162 163
   let getStubLinkable False = return []
       getStubLinkable True
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
164
           = do stub_o <- compileStub hsc_env' this_mod location
165 166
                return [ DotO stub_o ]

167
       handleBatch HscNoRecomp
168
           = ASSERT (isJust maybe_old_linkable)
169 170
             return maybe_old_linkable

Thomas Schilling's avatar
Thomas Schilling committed
171
       handleBatch (HscRecomp hasStub _)
172
           | isHsBoot src_flavour
173
               = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
174
                       liftIO $ SysTools.touch dflags' "Touching object file"
175
                                   object_filename
176 177
                    return maybe_old_linkable

178 179 180 181 182
           | otherwise
               = do stub_unlinked <- getStubLinkable hasStub
                    (hs_unlinked, unlinked_time) <-
                        case hsc_lang of
                          HscNothing
183
                            -> return ([], ms_hs_date summary)
184 185
                          -- We're in --make mode: finish the compilation pipeline.
                          _other
186
                            -> do _ <- runPipeline StopLn hsc_env' (output_fn,Nothing)
Simon Marlow's avatar
Simon Marlow committed
187 188
                                              (Just basename)
                                              Persistent
189 190
                                              (Just location)
                                  -- The object filename comes from the ModLocation
191
                                  o_time <- getModificationTime object_filename
192 193
                                  return ([DotO object_filename], o_time)
                    let linkable = LM unlinked_time this_mod
Ian Lynagh's avatar
Ian Lynagh committed
194
                                   (hs_unlinked ++ stub_unlinked)
195
                    return (Just linkable)
196

Thomas Schilling's avatar
Thomas Schilling committed
197
       handleInterpreted HscNoRecomp
198
           = ASSERT (isJust maybe_old_linkable)
199
             return maybe_old_linkable
200 201 202 203
       handleInterpreted (HscRecomp _hasStub Nothing)
           = ASSERT (isHsBoot src_flavour)
             return maybe_old_linkable
       handleInterpreted (HscRecomp hasStub (Just (comp_bc, modBreaks)))
204
           = do stub_unlinked <- getStubLinkable hasStub
205
                let hs_unlinked = [BCOs comp_bc modBreaks]
206
                    unlinked_time = ms_hs_date summary
207 208 209 210 211 212 213 214
                  -- 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)
215
                return (Just linkable)
216

217
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
218
       --            -> m HomeModInfo
219
       runCompiler compiler handle
220 221 222 223 224 225 226
           = do (result, iface, details)
                    <- compiler hsc_env' summary source_unchanged mb_old_iface
                                (Just (mod_index, nmods))
                linkable <- handle result
                return (HomeModInfo{ hm_details  = details,
                                     hm_iface    = iface,
                                     hm_linkable = linkable })
227
   -- run the compiler
228
   case hsc_lang of
229 230 231
      HscInterpreted -> runCompiler interactiveCompiler handleInterpreted
      HscNothing     -> runCompiler nothingCompiler     handleBatch
      _other         -> runCompiler batchCompiler       handleBatch
232

233
-----------------------------------------------------------------------------
234 235
-- stub .h and .c files (for foreign export support)

236 237 238
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
239
-- Consequently, we derive the _stub.o filename from the haskell object
Ian Lynagh's avatar
Ian Lynagh committed
240
-- filename.
241 242 243 244 245 246
--
-- 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
Ian Lynagh's avatar
Ian Lynagh committed
247
--
248 249 250 251
-- 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.

252
compileStub :: HscEnv -> Module -> ModLocation -> IO FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
253
compileStub hsc_env mod location = do
Ian Lynagh's avatar
Ian Lynagh committed
254 255
        -- compile the _stub.c file w/ gcc
        let (stub_c,_,stub_o) = mkStubPaths (hsc_dflags hsc_env)
256 257
                                   (moduleName mod) location

Ian Lynagh's avatar
Ian Lynagh committed
258 259
        _ <- runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
                (SpecificFile stub_o) Nothing{-no ModLocation-}
260

Ian Lynagh's avatar
Ian Lynagh committed
261
        return stub_o
262 263


264 265
-- ---------------------------------------------------------------------------
-- Link
266

Ian Lynagh's avatar
Ian Lynagh committed
267 268 269 270
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
271 272 273 274 275 276 277 278 279 280
     -> 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
281
link LinkInMemory _ _ _
282
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
283
         return Succeeded
284 285
#endif

286
link NoLink _ _ _
287 288
   = return Succeeded

289
link LinkBinary dflags batch_attempt_linking hpt
290 291 292 293 294
   = link' dflags batch_attempt_linking hpt

link LinkDynLib dflags batch_attempt_linking hpt
   = link' dflags batch_attempt_linking hpt

Simon Marlow's avatar
Simon Marlow committed
295
#ifndef GHCI
296 297
-- warning suppression
link other _ _ _ = panicBadLink other
Simon Marlow's avatar
Simon Marlow committed
298
#endif
299 300 301 302 303 304 305 306 307 308 309

panicBadLink :: GhcLink -> a
panicBadLink other = panic ("link: GHC not built to link this way: " ++
                            show other)

link' :: DynFlags                -- dynamic flags
      -> Bool                    -- attempt linking in batch mode?
      -> HomePackageTable        -- what to link
      -> IO SuccessFlag

link' dflags batch_attempt_linking hpt
310
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
311 312 313
   = do
        let
            home_mod_infos = eltsUFM hpt
314

Ian Lynagh's avatar
Ian Lynagh committed
315 316
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
317

Ian Lynagh's avatar
Ian Lynagh committed
318 319
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
320

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

Ian Lynagh's avatar
Ian Lynagh committed
323 324 325 326 327
        -- 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
328

Ian Lynagh's avatar
Ian Lynagh committed
329 330
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
331

Ian Lynagh's avatar
Ian Lynagh committed
332
            exe_file = exeFileName dflags
333

334
        linking_needed <- linkingNeeded dflags linkables pkg_deps
335

Ian Lynagh's avatar
Ian Lynagh committed
336
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
337
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
338 339
                   return Succeeded
           else do
340

341
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
342
                                 <+> text "...")
343

Ian Lynagh's avatar
Ian Lynagh committed
344 345 346 347
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
348
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
349
        link dflags obj_files pkg_deps
350

351
        debugTraceMsg dflags 3 (text "link: done")
352

Ian Lynagh's avatar
Ian Lynagh committed
353
        -- linkBinary only returns if it succeeds
354 355 356
        return Succeeded

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

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377

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
Ian Lynagh's avatar
Ian Lynagh committed
378
            then return True
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
            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)

405 406 407
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

408
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
409 410
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
411
  doLink (hsc_dflags hsc_env) stop_phase o_files
412

413
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
414
compileFile hsc_env stop_phase (src, mb_phase) = do
415
   exists <- doesFileExist src
Ian Lynagh's avatar
Ian Lynagh committed
416 417 418
   when (not exists) $
        ghcError (CmdLineError ("does not exist: " ++ src))

419
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
420
        dflags = hsc_dflags hsc_env
Ian Lynagh's avatar
Ian Lynagh committed
421 422 423
        split     = dopt Opt_SplitObjs dflags
        mb_o_file = outputFile dflags
        ghc_link  = ghcLink dflags      -- Set by -c or -no-link
424

Ian Lynagh's avatar
Ian Lynagh committed
425 426
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
427
        output
Ian Lynagh's avatar
Ian Lynagh committed
428 429 430 431 432 433 434 435
         | 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
436
                        _          -> stop_phase
437

438 439 440
   ( _, out_file) <- runPipeline stop_phase' hsc_env
                            (src, mb_phase) Nothing output
                            Nothing{-no ModLocation-}
441 442 443 444 445 446
   return out_file


doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
doLink dflags stop_phase o_files
  | not (isStopLn stop_phase)
Ian Lynagh's avatar
Ian Lynagh committed
447
  = return ()           -- We stopped before the linking phase
448 449 450

  | otherwise
  = case ghcLink dflags of
Ian Lynagh's avatar
Ian Lynagh committed
451
        NoLink     -> return ()
452
        LinkBinary -> linkBinary dflags o_files []
Ian Lynagh's avatar
Ian Lynagh committed
453
        LinkDynLib -> linkDynLib dflags o_files []
454
        other      -> panicBadLink other
455 456


457
-- ---------------------------------------------------------------------------
458

Ian Lynagh's avatar
Ian Lynagh committed
459
data PipelineOutput
460
  = Temporary
Ian Lynagh's avatar
Ian Lynagh committed
461 462
        -- ^ Output should be to a temporary file: we're going to
        -- run more compilation steps on this output later.
463
  | Persistent
Ian Lynagh's avatar
Ian Lynagh committed
464 465 466
        -- ^ 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.
467
  | SpecificFile FilePath
Ian Lynagh's avatar
Ian Lynagh committed
468
        -- ^ The output must go into the specified file.
469

470 471 472 473 474 475 476
-- | Run a compilation pipeline, consisting of multiple phases.
--
-- 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.
--
-- The DynFlags can be modified by phases in the pipeline (eg. by
Ian Lynagh's avatar
Ian Lynagh committed
477
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
478
-- pipeline.
479
runPipeline
480
  :: Phase                      -- ^ When to stop
481 482 483
  -> HscEnv                     -- ^ Compilation environment
  -> (FilePath,Maybe Phase)     -- ^ Input filename (and maybe -x suffix)
  -> Maybe FilePath             -- ^ original basename (if different from ^^^)
Ian Lynagh's avatar
Ian Lynagh committed
484
  -> PipelineOutput             -- ^ Output filename
485
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
486
  -> IO (DynFlags, FilePath)     -- ^ (final flags, output filename)
487

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
488
runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
489
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
490
  let dflags0 = hsc_dflags hsc_env0
Ian Lynagh's avatar
Ian Lynagh committed
491 492
      (input_basename, suffix) = splitExtension input_fn
      suffix' = drop 1 suffix -- strip off the .
Simon Marlow's avatar
Simon Marlow committed
493 494
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
495

496 497
      -- 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
498
      hsc_env = hsc_env0 {hsc_dflags = dflags}
499

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

503 504 505 506 507 508
  -- 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.
509

510
  when (not (start_phase `happensBefore` stop_phase)) $
Ian Lynagh's avatar
Ian Lynagh committed
511 512 513
        ghcError (UsageError
                    ("cannot compile this file to desired target: "
                       ++ input_fn))
514

515 516
  -- 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)
517
  let get_output_fn = getOutputFilename stop_phase output basename
518

519
  -- Execute the pipeline...
Ian Lynagh's avatar
Ian Lynagh committed
520 521 522
  (dflags', output_fn, maybe_loc) <-
        pipeLoop hsc_env start_phase stop_phase input_fn
                 basename suffix' get_output_fn maybe_loc
523

524
  -- Sometimes, a compilation phase doesn't actually generate any output
525 526
  -- (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
527 528
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
529
  case output of
Ian Lynagh's avatar
Ian Lynagh committed
530 531
    Temporary ->
        return (dflags', output_fn)
532
    _other -> 
Ian Lynagh's avatar
Ian Lynagh committed
533 534
        do final_fn <- get_output_fn dflags' stop_phase maybe_loc
           when (final_fn /= output_fn) $ do
535 536
              let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
                  line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
Ian Lynagh's avatar
Ian Lynagh committed
537 538
              copyWithHeader dflags msg line_prag output_fn final_fn
           return (dflags', final_fn)
539

540 541


542
pipeLoop :: HscEnv -> Phase -> Phase
Ian Lynagh's avatar
Ian Lynagh committed
543 544 545
         -> FilePath  -> String -> Suffix
         -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
         -> Maybe ModLocation
546
         -> IO (DynFlags, FilePath, Maybe ModLocation)
547

Ian Lynagh's avatar
Ian Lynagh committed
548 549 550
pipeLoop hsc_env phase stop_phase
         input_fn orig_basename orig_suff
         orig_get_output_fn maybe_loc
551

Ian Lynagh's avatar
Ian Lynagh committed
552
  | phase `eqPhase` stop_phase            -- All done
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
553
  = return (hsc_dflags hsc_env, input_fn, maybe_loc)
554

555
  | not (phase `happensBefore` stop_phase)
Ian Lynagh's avatar
Ian Lynagh committed
556 557 558 559 560 561 562 563
        -- 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 #-}.
  = panic ("pipeLoop: at phase " ++ show phase ++
           " but I wanted to stop at phase " ++ show stop_phase)

  | otherwise
564 565
  = do debugTraceMsg (hsc_dflags hsc_env) 4
                         (ptext (sLit "Running phase") <+> ppr phase)
566
       (next_phase, dflags', maybe_loc, output_fn)
Ian Lynagh's avatar
Ian Lynagh committed
567
          <- runPhase phase stop_phase hsc_env orig_basename
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
568 569 570 571
                      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
572

573
getOutputFilename
574 575 576
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
577 578
 = func
 where
Ian Lynagh's avatar
Ian Lynagh committed
579 580 581 582 583 584 585 586 587 588 589 590
        func dflags next_phase maybe_location
           | is_last_phase, Persistent <- output     = persistent_fn
           | is_last_phase, SpecificFile f <- output = return f
           | keep_this_output                        = persistent_fn
           | otherwise                               = newTempName dflags suffix
           where
                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
591
                keep_bc    = dopt Opt_KeepLlvmFiles dflags
Ian Lynagh's avatar
Ian Lynagh committed
592 593 594 595 596 597 598 599 600 601

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

                is_last_phase = next_phase `eqPhase` stop_phase

                -- sometimes, we keep output from intermediate stages
                keep_this_output =
                     case next_phase of
602 603 604
                             StopLn               -> True
                             Mangle  | keep_raw_s -> True
                             As      | keep_s     -> True
605
                             LlvmOpt | keep_bc    -> True
606 607
                             HCc     | keep_hc    -> True
                             _other               -> False
Ian Lynagh's avatar
Ian Lynagh committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621

                suffix = myPhaseInputExt next_phase

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

                persistent = basename <.> suffix

                odir_persistent
                   | Just loc <- maybe_location = ml_obj_file loc
                   | Just d <- odir = d </> persistent
                   | otherwise      = persistent
622

623

624
-- -----------------------------------------------------------------------------
625
-- | Each phase in the pipeline returns the next phase to execute, and the
626 627 628 629 630 631 632
-- 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.
633
--
634
runPhase :: Phase       -- ^ Do this phase first
Ian Lynagh's avatar
Ian Lynagh committed
635 636 637 638 639 640 641 642
         -> Phase       -- ^ Stop just before this phase
         -> HscEnv
         -> String      -- ^ basename of original input source
         -> String      -- ^ its extension
         -> FilePath    -- ^ name of file which contains the input to this phase.
         -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
                        -- ^ how to calculate the output filename
         -> Maybe ModLocation           -- ^ the ModLocation, if we have one
643 644 645 646
         -> IO (Phase,                   -- next phase
                DynFlags,                -- new dynamic flags
                Maybe ModLocation,       -- the ModLocation, if we have one
                FilePath)                -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
647 648 649 650

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

652
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
653
-- Unlit phase
654

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
655
runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
656
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
657
       let dflags = hsc_dflags hsc_env
658
       output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
659

660 661 662 663 664 665 666 667 668 669 670 671
       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
                   ]

672
       SysTools.runUnlit dflags flags
673

674
       return (Cpp sf, dflags, maybe_loc, output_fn)
675 676

-------------------------------------------------------------------------------
677
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
678
--             (b) runs cpp if necessary
679

680
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
681
  = do let dflags0 = hsc_dflags hsc_env
682
       src_opts <- getOptionsFromFile dflags0 input_fn
683
       (dflags1, unhandled_flags, warns)
684
           <- parseDynamicNoPackageFlags dflags0 src_opts
685
       checkProcessArgsResult unhandled_flags
686

687
       if not (xopt Opt_Cpp dflags1) then do
688
           -- we have to be careful to emit warnings only once.
689
           unless (dopt Opt_Pp dflags1) $ handleFlagWarnings dflags1 warns
690

sof's avatar
sof committed
691
           -- no need to preprocess CPP, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
692
           -- to the next phase of the pipeline.
693
           return (HsPp sf, dflags1, maybe_loc, input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
694
        else do
695 696
            output_fn <- get_output_fn dflags1 (HsPp sf) maybe_loc
            doCpp dflags1 True{-raw-} False{-no CC opts-} input_fn output_fn
697 698
            -- re-read the pragmas now that we've preprocessed the file
            -- See #2464,#3457
699
            src_opts <- getOptionsFromFile dflags0 output_fn
700
            (dflags2, unhandled_flags, warns)
701
                <- parseDynamicNoPackageFlags dflags0 src_opts
702
            unless (dopt Opt_Pp dflags2) $ handleFlagWarnings dflags2 warns
703 704 705
            -- the HsPp pass below will emit warnings
            checkProcessArgsResult unhandled_flags

Ian Lynagh's avatar
Ian Lynagh committed
706
            return (HsPp sf, dflags2, maybe_loc, output_fn)
707

sof's avatar
sof committed
708
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
709
-- HsPp phase
sof's avatar
sof committed
710

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
711 712 713
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
714
           -- no need to preprocess, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
715
           -- to the next phase of the pipeline.
716
          return (Hsc sf, dflags, maybe_loc, input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
717 718 719
        else do
            let hspp_opts = getOpts dflags opt_F
            let orig_fn = basename <.> suff
720 721
            output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
            SysTools.runPp dflags
Ian Lynagh's avatar
Ian Lynagh committed
722 723 724 725 726 727
                           ( [ SysTools.Option     orig_fn
                             , SysTools.Option     input_fn
                             , SysTools.FileOption "" output_fn
                             ] ++
                             map SysTools.Option hspp_opts
                           )
728 729

            -- re-read pragmas now that we've parsed the file (see #3674)
730
            src_opts <- getOptionsFromFile dflags output_fn
731
            (dflags1, unhandled_flags, warns)
732
                <- parseDynamicNoPackageFlags dflags src_opts
733
            handleFlagWarnings dflags1 warns
734 735
            checkProcessArgsResult unhandled_flags

736
            return (Hsc sf, dflags1, maybe_loc, output_fn)
737

738 739 740
-----------------------------------------------------------------------------
-- Hsc phase

741 742
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
Ian Lynagh's avatar
Ian Lynagh committed
743 744
runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc
 = do   -- normal Hsc mode, not mkdependHS
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
745
        let dflags0 = hsc_dflags hsc_env
746

747
  -- we add the current directory (i.e. the directory in which
748
  -- the .hs files resides) to the include path, since this is
749
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
750
        let current_dir = case takeDirectory basename of
Ian Lynagh's avatar
Ian Lynagh committed
751 752
                      "" -> "." -- XXX Hack
                      d -> d
Ian Lynagh's avatar
Ian Lynagh committed
753 754 755 756

            paths = includePaths dflags0
            dflags = dflags0 { includePaths = current_dir : paths }

757
  -- gather the imports and module name
Ian Lynagh's avatar
Ian Lynagh committed
758
        (hspp_buf,mod_name,imps,src_imps) <-
759
            case src_flavour of
760
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
761
                    m <- getCoreModuleName input_fn
762
                    return (Nothing, mkModuleName m, [], [])
763

764
                _           -> do
765
                    buf <- hGetStringBuffer input_fn
766 767
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
768 769 770

  -- Build a ModLocation to pass to hscMain.
  -- The source filename is rather irrelevant by now, but it's used
Ian Lynagh's avatar
Ian Lynagh committed
771
  -- by hscMain for messages.  hscMain also needs
772
  -- the .hi and .o filenames, and this is as good a way
Ian Lynagh's avatar
Ian Lynagh committed
773
  -- as any to generate them, and better than most. (e.g. takes
774
  -- into accout the -osuf flags)
775
        location1 <- mkHomeModLocation2 dflags mod_name basename suff
776 777

  -- Boot-ify it if necessary
Ian Lynagh's avatar
Ian Lynagh committed
778 779 780
        let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
                      | otherwise            = location1

781 782 783 784

  -- Take -ohi into account if present
  -- This can't be done in mkHomeModuleLocation because
  -- it only applies to the module being compiles
Ian Lynagh's avatar
Ian Lynagh committed
785 786 787
        let ohi = outputHi dflags
            location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
                      | otherwise      = location2
788 789 790 791 792 793

  -- 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
Ian Lynagh's avatar
Ian Lynagh committed
794 795 796 797 798
        let expl_o_file = outputFile dflags
            location4 | Just ofile <- expl_o_file
                      , isNoLink (ghcLink dflags)
                      = location3 { ml_obj_file = ofile }
                      | otherwise = location3
799

Ian Lynagh's avatar
Ian Lynagh committed
800
            o_file = ml_obj_file location4      -- The real object file
801 802 803


  -- Figure out if the source has changed, for recompilation avoidance.
804
  --