DriverPipeline.hs 76.1 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 61
import System.IO
import Control.Monad
Ian Lynagh's avatar
Ian Lynagh committed
62
import Data.List        ( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
63 64
import Data.Maybe
import System.Environment
65

66 67
-- ---------------------------------------------------------------------------
-- Pre-process
68

69
-- | Just preprocess a file, put the result in a temp. file (used by the
70
-- 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

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

83
-- ---------------------------------------------------------------------------
84

85 86
-- | Compile
--
87 88 89 90
-- 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
91 92 93
-- 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.
94
--
95 96
-- NB.  No old interface can also mean that the source has changed.

97
compile :: HscEnv
98 99 100 101 102
        -> 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
103
        -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful
104

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

107 108 109 110
compile' :: 
           (Compiler (HscStatus, ModIface, ModDetails),
            Compiler (InteractiveStatus, ModIface, ModDetails),
            Compiler (HscStatus, ModIface, ModDetails))
111 112 113 114 115 116
        -> 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
117
        -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful
118 119 120

compile' (nothingCompiler, interactiveCompiler, batchCompiler)
        hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
121 122 123 124
 = 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
125 126
       location    = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location)
127
       input_fnpp  = ms_hspp_file summary
128

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

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

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

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

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

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

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

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

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

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

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

216
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
217
       --            -> m HomeModInfo
218
       runCompiler compiler handle
219 220 221 222 223 224 225
           = 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 })
226
   -- run the compiler
227
   case hsc_lang of
228 229 230
      HscInterpreted -> runCompiler interactiveCompiler handleInterpreted
      HscNothing     -> runCompiler nothingCompiler     handleBatch
      _other         -> runCompiler batchCompiler       handleBatch
231

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

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

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

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

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


263 264
-- ---------------------------------------------------------------------------
-- Link
265

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

285
link NoLink _ _ _
286 287
   = return Succeeded

288
link LinkBinary dflags batch_attempt_linking hpt
289 290 291 292 293
   = 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
294
#ifndef GHCI
295 296
-- warning suppression
link other _ _ _ = panicBadLink other
Simon Marlow's avatar
Simon Marlow committed
297
#endif
298 299 300 301 302 303 304 305 306 307 308

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
309
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
310 311 312
   = do
        let
            home_mod_infos = eltsUFM hpt
313

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

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

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

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

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

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

333
        linking_needed <- linkingNeeded dflags linkables pkg_deps
334

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

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

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

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

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

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

360 361 362 363 364 365 366

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
367
  e_exe_time <- tryIO $ getModificationTime exe_file
368 369 370 371 372
  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
373
        e_extra_times <- mapM (tryIO . getModificationTime) extra_ld_inputs
374 375 376
        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
377
            then return True
378 379 380 381 382 383 384 385 386 387 388
            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
389
        e_lib_times <- mapM (tryIO . getModificationTime)
390 391 392 393 394 395 396 397 398 399 400 401 402 403
                          (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)

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

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

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

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

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

437 438 439
   ( _, out_file) <- runPipeline stop_phase' hsc_env
                            (src, mb_phase) Nothing output
                            Nothing{-no ModLocation-}
440 441 442 443 444 445
   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
446
  = return ()           -- We stopped before the linking phase
447 448 449

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


456
-- ---------------------------------------------------------------------------
457

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

469 470 471 472 473 474 475
-- | 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
476
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
477
-- pipeline.
478
runPipeline
479
  :: Phase                      -- ^ When to stop
480 481 482
  -> 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
483
  -> PipelineOutput             -- ^ Output filename
484
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
485
  -> IO (DynFlags, FilePath)     -- ^ (final flags, output filename)
486

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

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

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

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

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

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

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

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

539 540


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

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

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

554
  | not (phase `happensBefore` stop_phase)
Ian Lynagh's avatar
Ian Lynagh committed
555 556 557 558 559 560 561 562
        -- 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
563 564
  = do debugTraceMsg (hsc_dflags hsc_env) 4
                         (ptext (sLit "Running phase") <+> ppr phase)
565
       (next_phase, dflags', maybe_loc, output_fn)
Ian Lynagh's avatar
Ian Lynagh committed
566
          <- runPhase phase stop_phase hsc_env orig_basename
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
567 568 569 570
                      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
571

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

                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
601 602 603
                             StopLn               -> True
                             Mangle  | keep_raw_s -> True
                             As      | keep_s     -> True
604
                             LlvmOpt | keep_bc    -> True
605 606
                             HCc     | keep_hc    -> True
                             _other               -> False
Ian Lynagh's avatar
Ian Lynagh committed
607 608 609 610 611 612 613 614 615 616 617 618 619 620

                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
621

622

623
-- -----------------------------------------------------------------------------
624
-- | Each phase in the pipeline returns the next phase to execute, and the
625 626 627 628 629 630 631
-- 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.
632
--
633
runPhase :: Phase       -- ^ Do this phase first
Ian Lynagh's avatar
Ian Lynagh committed
634 635 636 637 638 639 640 641
         -> 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
642 643 644 645
         -> 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
646 647 648 649

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

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

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

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

671
       SysTools.runUnlit dflags flags
672

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

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

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

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

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

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

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

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

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

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

737 738 739
-----------------------------------------------------------------------------
-- Hsc phase

740 741
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
Ian Lynagh's avatar
Ian Lynagh committed
742 743
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
744
        let dflags0 = hsc_dflags hsc_env
745

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

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

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

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

  -- 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
770
  -- by hscMain for messages.  hscMain also needs
771
  -- the .hi and .o filenames, and this is as good a way
Ian Lynagh's avatar
Ian Lynagh committed
772
  -- as any to generate them, and better than most. (e.g. takes
773
  -- into accout the -osuf flags)
774
        location1 <- mkHomeModLocation2 dflags mod_name basename suff
775 776

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

780 781 782 783

  -- 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
784 785 786
        let ohi = outputHi dflags
            location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
                      | otherwise      = location2
787 788 789 790 791 792

  -- 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
793 794 795 796 797
        let expl_o_file = outputFile dflags
            location4 | Just ofile <- expl_o_file
                      , isNoLink (ghcLink dflags)
                      = location3 { ml_obj_file = ofile }
                      | otherwise = location3
798