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

85
-- ---------------------------------------------------------------------------
86

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

98 99 100 101 102 103 104 105
compile :: GhcMonad m =>
           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
        -> m HomeModInfo   -- ^ the complete HomeModInfo, if successful
106

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
compile = compile' (hscCompileNothing, hscCompileInteractive, hscCompileBatch)

type Compiler m a = HscEnv -> ModSummary -> Bool
                  -> Maybe ModIface -> Maybe (Int, Int)
                  -> m a

compile' :: GhcMonad m =>
           (Compiler m (HscStatus, ModIface, ModDetails),
            Compiler m (InteractiveStatus, ModIface, ModDetails),
            Compiler m (HscStatus, ModIface, ModDetails))
        -> 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
        -> m HomeModInfo   -- ^ the complete HomeModInfo, if successful

compile' (nothingCompiler, interactiveCompiler, batchCompiler)
        hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
127 128 129 130
 = 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
131 132
       location    = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location)
133
       input_fnpp  = ms_hspp_file summary
134

135
   liftIO $ debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
136

Ian Lynagh's avatar
Ian Lynagh committed
137
   let basename = dropExtension input_fn
138

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

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

157
   let dflags' = dflags { hscTarget = hsc_lang,
Ian Lynagh's avatar
Ian Lynagh committed
158 159
                                hscOutName = output_fn,
                                extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
160
   let hsc_env' = hsc_env { hsc_dflags = dflags' }
161

162
   -- -fforce-recomp should also work with --make
163 164
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
165
       object_filename = ml_obj_file location
166

167 168
   let getStubLinkable False = return []
       getStubLinkable True
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
169
           = do stub_o <- compileStub hsc_env' this_mod location
170 171
                return [ DotO stub_o ]

172
       handleBatch HscNoRecomp
173
           = ASSERT (isJust maybe_old_linkable)
174 175
             return maybe_old_linkable

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

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

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

222
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
223
       --            -> m HomeModInfo
224
       runCompiler compiler handle
225 226 227 228 229 230 231
           = 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 })
232
   -- run the compiler
233
   case hsc_lang of
234 235
      HscInterpreted ->
                runCompiler interactiveCompiler handleInterpreted
Ian Lynagh's avatar
Ian Lynagh committed
236
      HscNothing ->
237
                runCompiler nothingCompiler handleBatch
Ian Lynagh's avatar
Ian Lynagh committed
238
      _other ->
239 240
                runCompiler batchCompiler handleBatch

241

242
-----------------------------------------------------------------------------
243 244
-- stub .h and .c files (for foreign export support)

245 246 247
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
248
-- Consequently, we derive the _stub.o filename from the haskell object
Ian Lynagh's avatar
Ian Lynagh committed
249
-- filename.
250 251 252 253 254 255
--
-- 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
256
--
257 258 259 260
-- 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.

261 262
compileStub :: GhcMonad m => HscEnv -> Module -> ModLocation
            -> m FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
263
compileStub hsc_env mod location = do
Ian Lynagh's avatar
Ian Lynagh committed
264 265
        -- compile the _stub.c file w/ gcc
        let (stub_c,_,stub_o) = mkStubPaths (hsc_dflags hsc_env)
266 267
                                   (moduleName mod) location

Ian Lynagh's avatar
Ian Lynagh committed
268 269
        _ <- runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
                (SpecificFile stub_o) Nothing{-no ModLocation-}
270

Ian Lynagh's avatar
Ian Lynagh committed
271
        return stub_o
272 273


274 275
-- ---------------------------------------------------------------------------
-- Link
276

Ian Lynagh's avatar
Ian Lynagh committed
277 278 279 280
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
281 282 283 284 285 286 287 288 289 290
     -> 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
291
link LinkInMemory _ _ _
292
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
293
         return Succeeded
294 295
#endif

296
link NoLink _ _ _
297 298
   = return Succeeded

299
link LinkBinary dflags batch_attempt_linking hpt
300 301 302 303 304
   = 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
305
#ifndef GHCI
306 307
-- warning suppression
link other _ _ _ = panicBadLink other
Simon Marlow's avatar
Simon Marlow committed
308
#endif
309 310 311 312 313 314 315 316 317 318 319

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
320
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
321 322 323
   = do
        let
            home_mod_infos = eltsUFM hpt
324

Ian Lynagh's avatar
Ian Lynagh committed
325 326
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
327

Ian Lynagh's avatar
Ian Lynagh committed
328 329
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
330

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

Ian Lynagh's avatar
Ian Lynagh committed
333 334 335 336 337
        -- 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
338

Ian Lynagh's avatar
Ian Lynagh committed
339 340
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
341

Ian Lynagh's avatar
Ian Lynagh committed
342
            exe_file = exeFileName dflags
343

344
        linking_needed <- linkingNeeded dflags linkables pkg_deps
345

Ian Lynagh's avatar
Ian Lynagh committed
346
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
347
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
348 349
                   return Succeeded
           else do
350

351
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
352
                                 <+> text "...")
353

Ian Lynagh's avatar
Ian Lynagh committed
354 355 356 357
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
358
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
359
        link dflags obj_files pkg_deps
360

361
        debugTraceMsg dflags 3 (text "link: done")
362

Ian Lynagh's avatar
Ian Lynagh committed
363
        -- linkBinary only returns if it succeeds
364 365 366
        return Succeeded

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

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387

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
388
            then return True
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
            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)

415 416 417
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

418 419
oneShot :: GhcMonad m =>
           HscEnv -> Phase -> [(String, Maybe Phase)] -> m ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
420 421
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
422
  liftIO $ doLink (hsc_dflags hsc_env) stop_phase o_files
423

424 425
compileFile :: GhcMonad m =>
               HscEnv -> Phase -> (FilePath, Maybe Phase) -> m FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
426
compileFile hsc_env stop_phase (src, mb_phase) = do
427
   exists <- liftIO $ doesFileExist src
Ian Lynagh's avatar
Ian Lynagh committed
428 429 430
   when (not exists) $
        ghcError (CmdLineError ("does not exist: " ++ src))

431
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
432
        dflags = hsc_dflags hsc_env
Ian Lynagh's avatar
Ian Lynagh committed
433 434 435
        split     = dopt Opt_SplitObjs dflags
        mb_o_file = outputFile dflags
        ghc_link  = ghcLink dflags      -- Set by -c or -no-link
436

Ian Lynagh's avatar
Ian Lynagh committed
437 438
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
439
        output
Ian Lynagh's avatar
Ian Lynagh committed
440 441 442 443 444 445 446 447
         | 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
448
                        _          -> stop_phase
449

450 451 452
   ( _, out_file) <- runPipeline stop_phase' hsc_env
                            (src, mb_phase) Nothing output
                            Nothing{-no ModLocation-}
453 454 455 456 457 458
   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
459
  = return ()           -- We stopped before the linking phase
460 461 462

  | otherwise
  = case ghcLink dflags of
Ian Lynagh's avatar
Ian Lynagh committed
463
        NoLink     -> return ()
464
        LinkBinary -> linkBinary dflags o_files []
Ian Lynagh's avatar
Ian Lynagh committed
465
        LinkDynLib -> linkDynLib dflags o_files []
466
        other      -> panicBadLink other
467 468


469
-- ---------------------------------------------------------------------------
470

Ian Lynagh's avatar
Ian Lynagh committed
471
data PipelineOutput
472
  = Temporary
Ian Lynagh's avatar
Ian Lynagh committed
473 474
        -- ^ Output should be to a temporary file: we're going to
        -- run more compilation steps on this output later.
475
  | Persistent
Ian Lynagh's avatar
Ian Lynagh committed
476 477 478
        -- ^ 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.
479
  | SpecificFile FilePath
Ian Lynagh's avatar
Ian Lynagh committed
480
        -- ^ The output must go into the specified file.
481

482 483 484 485 486 487 488
-- | 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
489
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
490
-- pipeline.
491
runPipeline
492
  :: GhcMonad m =>
Ian Lynagh's avatar
Ian Lynagh committed
493
     Phase                      -- ^ When to stop
494 495 496
  -> 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
497
  -> PipelineOutput             -- ^ Output filename
498
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
Ian Lynagh's avatar
Ian Lynagh committed
499
  -> m (DynFlags, FilePath)     -- ^ (final flags, output filename)
500

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
501
runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
502
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
503
  let dflags0 = hsc_dflags hsc_env0
Ian Lynagh's avatar
Ian Lynagh committed
504 505
      (input_basename, suffix) = splitExtension input_fn
      suffix' = drop 1 suffix -- strip off the .
Simon Marlow's avatar
Simon Marlow committed
506 507
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
508

509 510
      -- 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
511
      hsc_env = hsc_env0 {hsc_dflags = dflags}
512

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

516 517 518 519 520 521
  -- 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.
522

523
  when (not (start_phase `happensBefore` stop_phase)) $
Ian Lynagh's avatar
Ian Lynagh committed
524 525 526
        ghcError (UsageError
                    ("cannot compile this file to desired target: "
                       ++ input_fn))
527

528 529
  -- 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)
530
  let get_output_fn = getOutputFilename stop_phase output basename
531

532
  -- Execute the pipeline...
Ian Lynagh's avatar
Ian Lynagh committed
533 534 535
  (dflags', output_fn, maybe_loc) <-
        pipeLoop hsc_env start_phase stop_phase input_fn
                 basename suffix' get_output_fn maybe_loc
536

537
  -- Sometimes, a compilation phase doesn't actually generate any output
538 539
  -- (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
540 541
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
542
  case output of
Ian Lynagh's avatar
Ian Lynagh committed
543 544
    Temporary ->
        return (dflags', output_fn)
545
    _other -> liftIO $
Ian Lynagh's avatar
Ian Lynagh committed
546 547
        do final_fn <- get_output_fn dflags' stop_phase maybe_loc
           when (final_fn /= output_fn) $ do
548 549
              let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
                  line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
Ian Lynagh's avatar
Ian Lynagh committed
550 551
              copyWithHeader dflags msg line_prag output_fn final_fn
           return (dflags', final_fn)
552

553 554


555 556
pipeLoop :: GhcMonad m =>
            HscEnv -> Phase -> Phase
Ian Lynagh's avatar
Ian Lynagh committed
557 558 559 560
         -> FilePath  -> String -> Suffix
         -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
         -> Maybe ModLocation
         -> m (DynFlags, FilePath, Maybe ModLocation)
561

Ian Lynagh's avatar
Ian Lynagh committed
562 563 564
pipeLoop hsc_env phase stop_phase
         input_fn orig_basename orig_suff
         orig_get_output_fn maybe_loc
565

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

569
  | not (phase `happensBefore` stop_phase)
Ian Lynagh's avatar
Ian Lynagh committed
570 571 572 573 574 575 576 577
        -- 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
578 579 580
  = do liftIO $ debugTraceMsg (hsc_dflags hsc_env) 4
                              (ptext (sLit "Running phase") <+> ppr phase)
       (next_phase, dflags', maybe_loc, output_fn)
Ian Lynagh's avatar
Ian Lynagh committed
581
          <- runPhase phase stop_phase hsc_env orig_basename
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
582 583 584 585
                      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
586

587
getOutputFilename
588 589 590
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
591 592
 = func
 where
Ian Lynagh's avatar
Ian Lynagh committed
593 594 595 596 597 598 599 600 601 602 603 604
        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
605
                keep_bc    = dopt Opt_KeepLlvmFiles dflags
Ian Lynagh's avatar
Ian Lynagh committed
606 607 608 609 610 611 612 613 614 615

                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
616 617 618
                             StopLn               -> True
                             Mangle  | keep_raw_s -> True
                             As      | keep_s     -> True
619
                             LlvmOpt | keep_bc    -> True
620 621
                             HCc     | keep_hc    -> True
                             _other               -> False
Ian Lynagh's avatar
Ian Lynagh committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635

                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
636

637

638
-- -----------------------------------------------------------------------------
639
-- | Each phase in the pipeline returns the next phase to execute, and the
640 641 642 643 644 645 646
-- 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.
647 648
--
runPhase :: GhcMonad m =>
Ian Lynagh's avatar
Ian Lynagh committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
            Phase       -- ^ Do this phase first
         -> 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
         -> m (Phase,                   -- next phase
               DynFlags,                -- new dynamic flags
               Maybe ModLocation,       -- the ModLocation, if we have one
               FilePath)                -- output filename

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

667
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
668
-- Unlit phase
669

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
670
runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
671
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
672
       let dflags = hsc_dflags hsc_env
673
       output_fn <- liftIO $ get_output_fn dflags (Cpp sf) maybe_loc
674

675 676 677 678 679 680 681 682 683 684 685 686
       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
                   ]

687
       liftIO $ SysTools.runUnlit dflags flags
688

689
       return (Cpp sf, dflags, maybe_loc, output_fn)
690 691

-------------------------------------------------------------------------------
692
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
693
--             (b) runs cpp if necessary
694

695
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
696
  = do let dflags0 = hsc_dflags hsc_env
697
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
698
       (dflags1, unhandled_flags, warns)
699
           <- liftIO $ parseDynamicNoPackageFlags dflags0 src_opts
700
       checkProcessArgsResult unhandled_flags
701

702
       if not (xopt Opt_Cpp dflags1) then do
703
           -- we have to be careful to emit warnings only once.
704
           unless (dopt Opt_Pp dflags1) $ handleFlagWarnings dflags1 warns
705

sof's avatar
sof committed
706
           -- no need to preprocess CPP, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
707
           -- to the next phase of the pipeline.
708
           return (HsPp sf, dflags1, maybe_loc, input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
709
        else do
710 711
            output_fn <- liftIO $ get_output_fn dflags1 (HsPp sf) maybe_loc
            liftIO $ doCpp dflags1 True{-raw-} False{-no CC opts-} input_fn output_fn
712 713
            -- re-read the pragmas now that we've preprocessed the file
            -- See #2464,#3457
714
            src_opts <- liftIO $ getOptionsFromFile dflags0 output_fn
715 716
            (dflags2, unhandled_flags, warns)
                <- liftIO $ parseDynamicNoPackageFlags dflags0 src_opts
717
            unless (dopt Opt_Pp dflags2) $ handleFlagWarnings dflags2 warns
718 719 720
            -- the HsPp pass below will emit warnings
            checkProcessArgsResult unhandled_flags

Ian Lynagh's avatar
Ian Lynagh committed
721
            return (HsPp sf, dflags2, maybe_loc, output_fn)
722

sof's avatar
sof committed
723
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
724
-- HsPp phase
sof's avatar
sof committed
725

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
726 727 728
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
729
           -- no need to preprocess, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
730
           -- to the next phase of the pipeline.
731
          return (Hsc sf, dflags, maybe_loc, input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
732 733 734 735 736 737 738 739 740 741 742
        else do
            let hspp_opts = getOpts dflags opt_F
            let orig_fn = basename <.> suff
            output_fn <- liftIO $ get_output_fn dflags (Hsc sf) maybe_loc
            liftIO $ SysTools.runPp dflags
                           ( [ SysTools.Option     orig_fn
                             , SysTools.Option     input_fn
                             , SysTools.FileOption "" output_fn
                             ] ++
                             map SysTools.Option hspp_opts
                           )
743 744

            -- re-read pragmas now that we've parsed the file (see #3674)
745
            src_opts <- liftIO $ getOptionsFromFile dflags output_fn
746 747
            (dflags1, unhandled_flags, warns)
                <- liftIO $ parseDynamicNoPackageFlags dflags src_opts
748
            handleFlagWarnings dflags1 warns
749 750
            checkProcessArgsResult unhandled_flags

751
            return (Hsc sf, dflags1, maybe_loc, output_fn)
752

753 754 755
-----------------------------------------------------------------------------
-- Hsc phase

756 757
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
Ian Lynagh's avatar
Ian Lynagh committed
758 759
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
760
        let dflags0 = hsc_dflags hsc_env
761

762
  -- we add the current directory (i.e. the directory in which
763
  -- the .hs files resides) to the include path, since this is
764
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
765
        let current_dir = case takeDirectory basename of
Ian Lynagh's avatar
Ian Lynagh committed
766 767
                      "" -> "." -- XXX Hack
                      d -> d
Ian Lynagh's avatar
Ian Lynagh committed
768 769 770 771

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

772
  -- gather the imports and module name
Ian Lynagh's avatar
Ian Lynagh committed
773
        (hspp_buf,mod_name,imps,src_imps) <-
774
            case src_flavour of
775 776 777
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
                    m <- liftIO $ getCoreModuleName input_fn
                    return (Nothing, mkModuleName m, [], [])
778

779 780
                _           -> do
                    buf <- liftIO $ hGetStringBuffer input_fn
781 782
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
783 784 785

  -- 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
786
  -- by hscMain for messages.  hscMain also needs
787
  -- the .hi and .o filenames, and this is as good a way
Ian Lynagh's avatar
Ian Lynagh committed
788
  -- as any to generate them, and better than most. (e.g. takes
789
  -- into accout the -osuf flags)
Ian Lynagh's avatar
Ian Lynagh committed
790
        location1 <- liftIO $ mkHomeModLocation2 dflags mod_name basename suff
791 792

  -- Boot-ify it if necessary
Ian Lynagh's avatar
Ian Lynagh committed
793 794 795
        let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
                      | otherwise            = location1

796 797 798 799

  -- 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
800 801 802
        let ohi = outputHi dflags
            location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
                      | otherwise      = location2
803 804 805 806 807 808

  -- 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
809 810 811 812 813
        let expl_o_file = outputFile dflags
            location4 | Just ofile <- expl_o_file
                      , isNoLink (ghcLink dflags)
                      = location3 { ml_obj_file = ofile }
                      | otherwise = location3
814

Ian Lynagh's avatar
Ian Lynagh committed
815
            o_file = ml_obj_file location4      -- The real object file
816 817 818


  -- Figure out if the source has changed, for recompilation avoidance.
819
  --
820
  -- Setting source_unchanged to True means that M.o seems
821 822
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
823
  -- Setting source_unchanged to False tells the compiler that M.o is out of
824
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Ian Lynagh's avatar
Ian Lynagh committed
825
        src_timestamp <- liftIO $ getModificationTime (basename <.> suff)
Simon Marlow's avatar
Simon Marlow committed
826

Ian Lynagh's avatar
Ian Lynagh committed
827 828 829
        let force_recomp = dopt Opt_ForceRecomp dflags
            hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
        source_unchanged <-
830
          if force_recomp || not (isStopLn stop)