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

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

module DriverPipeline (
Ian Lynagh's avatar
Ian Lynagh committed
14 15
        -- Run a series of compilation steps in a pipeline, for a
        -- collection of source files.
16
   oneShot, compileFile,
17

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

Ian Lynagh's avatar
Ian Lynagh committed
21 22
        -- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess,
23
   compile, compile',
Ian Lynagh's avatar
Ian Lynagh committed
24
   link,
25

26 27 28 29
  ) where

#include "HsVersions.h"

30
import Packages
31
import HeaderInfo
32
import DriverPhases
33
import SysTools
34
import HscMain
35
import Finder
36 37 38
import HscTypes
import Outputable
import Module
Ian Lynagh's avatar
Ian Lynagh committed
39
import UniqFM           ( eltsUFM )
40
import ErrUtils
41
import DynFlags
42
import StaticFlags      ( v_Ld_inputs, opt_PIC, opt_Static, WayName(..) )
43
import Config
44
import Panic
45
import Util
Ian Lynagh's avatar
Ian Lynagh committed
46 47 48 49
import StringBuffer     ( hGetStringBuffer )
import BasicTypes       ( SuccessFlag(..) )
import Maybes           ( expectJust )
import ParserCoreUtils  ( getCoreModuleName )
50
import SrcLoc
51
import FastString
52
import LlvmCodeGen      ( llvmFixupAsm )
53
import MonadUtils
54
import Platform
55

56
import Exception
Ian Lynagh's avatar
Ian Lynagh committed
57
import Data.IORef       ( readIORef )
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
import Data.Char
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)
82
        Nothing Temporary Nothing{-no ModLocation-} Nothing{-no stub-}
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 = 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
   let handleBatch HscNoRecomp
163
           = ASSERT (isJust maybe_old_linkable)
164 165
             return maybe_old_linkable

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

173
           | otherwise
174
               = do (hs_unlinked, unlinked_time) <-
175
                        case hsc_lang of
176 177
                          HscNothing ->
                            return ([], ms_hs_date summary)
178
                          -- We're in --make mode: finish the compilation pipeline.
179 180 181 182 183 184 185
                          _other -> do
                            maybe_stub_o <- case hasStub of
                               Nothing -> return Nothing
                               Just stub_c -> do
                                 stub_o <- compileStub hsc_env' stub_c
                                 return (Just stub_o)
                            _ <- runPipeline StopLn hsc_env' (output_fn,Nothing)
Simon Marlow's avatar
Simon Marlow committed
186 187
                                              (Just basename)
                                              Persistent
188
                                              (Just location)
189
                                              maybe_stub_o
190
                                  -- The object filename comes from the ModLocation
191 192 193 194
                            o_time <- getModificationTime object_filename
                            return ([DotO object_filename], o_time)
                    
                    let linkable = LM unlinked_time this_mod hs_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 205 206 207 208 209
           = do stub_o <- case hasStub of
                            Nothing -> return []
                            Just stub_c -> do
                              stub_o <- compileStub hsc_env' stub_c
                              return [DotO stub_o]

210
                let hs_unlinked = [BCOs comp_bc modBreaks]
211
                    unlinked_time = ms_hs_date summary
212 213 214 215 216 217 218
                  -- 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
219
                               (hs_unlinked ++ stub_o)
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 236
      HscInterpreted -> runCompiler interactiveCompiler handleInterpreted
      HscNothing     -> runCompiler nothingCompiler     handleBatch
      _other         -> runCompiler batchCompiler       handleBatch
237

238
-----------------------------------------------------------------------------
239 240
-- stub .h and .c files (for foreign export support)

241 242 243
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
244 245 246
-- The object file created by compiling the _stub.c file is put into a
-- temporary file, which will be later combined with the main .o file
-- (see the MergeStubs phase).
247

248 249 250 251
compileStub :: HscEnv -> FilePath -> IO FilePath
compileStub hsc_env stub_c = do
        (_, stub_o) <- runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
                                   Temporary Nothing{-no ModLocation-} Nothing
252

Ian Lynagh's avatar
Ian Lynagh committed
253
        return stub_o
254

255 256
-- ---------------------------------------------------------------------------
-- Link
257

Ian Lynagh's avatar
Ian Lynagh committed
258 259 260 261
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
262 263 264 265 266 267 268 269 270
     -> 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.

271
link LinkInMemory _ _ _
272 273 274 275
    = if cGhcWithInterpreter == "YES"
      then -- Not Linking...(demand linker will do the job)
           return Succeeded
      else panicBadLink LinkInMemory
276

277
link NoLink _ _ _
278 279
   = return Succeeded

280
link LinkBinary dflags batch_attempt_linking hpt
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
   = link' dflags batch_attempt_linking hpt

link LinkDynLib dflags batch_attempt_linking hpt
   = link' dflags batch_attempt_linking hpt

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
296
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
297 298 299
   = do
        let
            home_mod_infos = eltsUFM hpt
300

Ian Lynagh's avatar
Ian Lynagh committed
301
            -- the packages we depend on
302
            pkg_deps  = concatMap (map fst . dep_pkgs . mi_deps . hm_iface) home_mod_infos
303

Ian Lynagh's avatar
Ian Lynagh committed
304 305
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
306

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

Ian Lynagh's avatar
Ian Lynagh committed
309 310 311 312 313
        -- 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
314

Ian Lynagh's avatar
Ian Lynagh committed
315 316
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
317

Ian Lynagh's avatar
Ian Lynagh committed
318
            exe_file = exeFileName dflags
319

320
        linking_needed <- linkingNeeded dflags linkables pkg_deps
321

Ian Lynagh's avatar
Ian Lynagh committed
322
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
323
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
324 325
                   return Succeeded
           else do
326

327
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
328
                                 <+> text "...")
329

Ian Lynagh's avatar
Ian Lynagh committed
330 331 332 333
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
334
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
335
        link dflags obj_files pkg_deps
336

337
        debugTraceMsg dflags 3 (text "link: done")
338

Ian Lynagh's avatar
Ian Lynagh committed
339
        -- linkBinary only returns if it succeeds
340 341 342
        return Succeeded

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

347 348 349 350 351 352 353

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
354
  e_exe_time <- tryIO $ getModificationTime exe_file
355 356 357 358 359
  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
360
        e_extra_times <- mapM (tryIO . getModificationTime) extra_ld_inputs
361 362 363
        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
364
            then return True
365 366 367 368 369 370 371 372 373 374 375
            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
376
        e_lib_times <- mapM (tryIO . getModificationTime)
377 378 379 380
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
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 checkLinkInfo dflags pkg_deps exe_file

-- Returns 'False' if it was, and we can avoid linking, because the
-- previous binary was linked with "the same options".
checkLinkInfo :: DynFlags -> [PackageId] -> FilePath -> IO Bool
checkLinkInfo dflags pkg_deps exe_file
 | isWindowsTarget || isDarwinTarget
 -- ToDo: Windows and OS X do not use the ELF binary format, so
 -- readelf does not work there.  We need to find another way to do
 -- this.
 = return False -- conservatively we should return True, but not
                -- linking in this case was the behaviour for a long
                -- time so we leave it as-is.
 | otherwise
 = do
   link_info <- getLinkInfo dflags pkg_deps
   debugTraceMsg dflags 3 $ text ("Link info: " ++ link_info)
   m_exe_link_info <- readElfSection dflags ghcLinkInfoSectionName exe_file
   debugTraceMsg dflags 3 $ text ("Exe link info: " ++ show m_exe_link_info)
   return (Just link_info /= m_exe_link_info)

ghcLinkInfoSectionName :: String
ghcLinkInfoSectionName = ".debug-ghc-link-info"
   -- if we use the ".debug" prefix, then strip will strip it by default
405 406 407 408 409 410 411 412 413

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)

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

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

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

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

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

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

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


466
-- ---------------------------------------------------------------------------
467

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

479 480 481 482 483 484 485
-- | 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
486
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
487
-- pipeline.
488
runPipeline
489
  :: Phase                      -- ^ When to stop
490 491 492
  -> 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
493
  -> PipelineOutput             -- ^ Output filename
494
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
495
  -> Maybe FilePath             -- ^ stub object, if we have one
496
  -> IO (DynFlags, FilePath)     -- ^ (final flags, output filename)
497

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

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

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

514 515 516 517 518 519
  -- 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.
520

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

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

530
  -- Execute the pipeline...
531 532 533 534 535 536 537 538 539 540 541
  let env   = PipeEnv{ stop_phase,
                       src_basename = basename,
                       src_suffix = suffix',
                       output_spec = output }

      state = PipeState{ hsc_env, maybe_loc, maybe_stub_o = maybe_stub_o }

  (state', output_fn) <- unP (pipeLoop start_phase input_fn) env state

  let PipeState{ hsc_env=hsc_env', maybe_loc } = state'
      dflags' = hsc_dflags hsc_env'
542

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

559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
-- -----------------------------------------------------------------------------
-- The pipeline uses a monad to carry around various bits of information

-- PipeEnv: invariant information passed down
data PipeEnv = PipeEnv {
       stop_phase   :: Phase,       -- ^ Stop just before this phase
       src_basename :: String,      -- ^ basename of original input source
       src_suffix   :: String,      -- ^ its extension
       output_spec  :: PipelineOutput -- ^ says where to put the pipeline output
  }

-- PipeState: information that might change during a pipeline run
data PipeState = PipeState {
       hsc_env   :: HscEnv,
          -- ^ only the DynFlags change in the HscEnv.  The DynFlags change
          -- at various points, for example when we read the OPTIONS_GHC
          -- pragmas in the Cpp phase.
       maybe_loc :: Maybe ModLocation,
          -- ^ the ModLocation.  This is discovered during compilation,
          -- in the Hsc phase where we read the module header.
       maybe_stub_o :: Maybe FilePath
          -- ^ the stub object.  This is set by the Hsc phase if a stub
          -- object was created.  The stub object will be joined with
          -- the main compilation object using "ld -r" at the end.
  }

getPipeEnv :: CompPipeline PipeEnv
getPipeEnv = P $ \env state -> return (state, env)

getPipeState :: CompPipeline PipeState
getPipeState = P $ \_env state -> return (state, state)

getDynFlags :: CompPipeline DynFlags
getDynFlags = P $ \_env state -> return (state, hsc_dflags (hsc_env state))

setDynFlags :: DynFlags -> CompPipeline ()
setDynFlags dflags = P $ \_env state ->
  return (state{hsc_env= (hsc_env state){ hsc_dflags = dflags }}, ())

setModLocation :: ModLocation -> CompPipeline ()
setModLocation loc = P $ \_env state ->
  return (state{ maybe_loc = Just loc }, ())

setStubO :: FilePath -> CompPipeline ()
setStubO stub_o = P $ \_env state ->
  return (state{ maybe_stub_o = Just stub_o }, ())

newtype CompPipeline a = P { unP :: PipeEnv -> PipeState -> IO (PipeState, a) }

instance Monad CompPipeline where
  return a = P $ \_env state -> return (state, a)
  P m >>= k = P $ \env state -> do (state',a) <- m env state
                                   unP (k a) env state'

io :: IO a -> CompPipeline a
io m = P $ \_env state -> do a <- m; return (state, a)

phaseOutputFilename :: Phase{-next phase-} -> CompPipeline FilePath
phaseOutputFilename next_phase = do
  PipeEnv{stop_phase, src_basename, output_spec} <- getPipeEnv
  PipeState{maybe_loc, hsc_env} <- getPipeState
  let dflags = hsc_dflags hsc_env
  io $ getOutputFilename stop_phase output_spec
                         src_basename dflags next_phase maybe_loc
623

624 625 626 627 628 629 630 631 632 633 634 635 636
-- ---------------------------------------------------------------------------
-- outer pipeline loop

-- | pipeLoop runs phases until we reach the stop phase
pipeLoop :: Phase -> FilePath -> CompPipeline FilePath
pipeLoop phase input_fn = do
  PipeEnv{stop_phase} <- getPipeEnv
  PipeState{hsc_env}  <- getPipeState
  case () of
   _ | phase `eqPhase` stop_phase            -- All done
     -> return input_fn

     | not (phase `happensBefore` stop_phase)
Ian Lynagh's avatar
Ian Lynagh committed
637 638 639 640
        -- 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 #-}.
641
     -> panic ("pipeLoop: at phase " ++ show phase ++
Ian Lynagh's avatar
Ian Lynagh committed
642 643
           " but I wanted to stop at phase " ++ show stop_phase)

644 645
     | otherwise
     -> do io $ debugTraceMsg (hsc_dflags hsc_env) 4
646
                         (ptext (sLit "Running phase") <+> ppr phase)
647 648 649 650 651 652 653 654
           dflags <- getDynFlags
           (next_phase, output_fn) <- runPhase phase input_fn dflags
           pipeLoop next_phase output_fn

-- -----------------------------------------------------------------------------
-- In each phase, we need to know into what filename to generate the
-- output.  All the logic about which filenames we generate output
-- into is embodied in the following function.
655

656
getOutputFilename
657 658 659
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
660 661
 = func
 where
Ian Lynagh's avatar
Ian Lynagh committed
662 663 664 665 666 667 668 669 670 671 672
        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_s     = dopt Opt_KeepSFiles dflags
673
                keep_bc    = dopt Opt_KeepLlvmFiles dflags
Ian Lynagh's avatar
Ian Lynagh committed
674

675 676 677 678
                myPhaseInputExt HCc       = hcsuf
                myPhaseInputExt MergeStub = osuf
                myPhaseInputExt StopLn    = osuf
                myPhaseInputExt other     = phaseInputExt other
Ian Lynagh's avatar
Ian Lynagh committed
679 680 681 682 683 684

                is_last_phase = next_phase `eqPhase` stop_phase

                -- sometimes, we keep output from intermediate stages
                keep_this_output =
                     case next_phase of
685
                             As      | keep_s     -> True
686
                             LlvmOpt | keep_bc    -> True
687 688
                             HCc     | keep_hc    -> True
                             _other               -> False
Ian Lynagh's avatar
Ian Lynagh committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702

                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
703

704

705
-- -----------------------------------------------------------------------------
706
-- | Each phase in the pipeline returns the next phase to execute, and the
707 708 709 710 711 712 713
-- 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.
714
--
715 716 717 718 719
runPhase :: Phase       -- ^ Run this phase
         -> FilePath    -- ^ name of the input file
         -> DynFlags    -- ^ for convenience, we pass the current dflags in
         -> CompPipeline (Phase,               -- next phase to run
                          FilePath)            -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
720 721 722 723

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

725

726
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
727
-- Unlit phase
728

729
runPhase (Unlit sf) input_fn dflags
730
  = do
731
       output_fn <- phaseOutputFilename (Cpp sf)
732

733 734 735 736 737 738 739 740 741 742 743 744
       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
                   ]

745
       io $ SysTools.runUnlit dflags flags
746

747
       return (Cpp sf, output_fn)
748 749

-------------------------------------------------------------------------------
750
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
751
--             (b) runs cpp if necessary
752

753 754 755
runPhase (Cpp sf) input_fn dflags0
  = do
       src_opts <- io $ getOptionsFromFile dflags0 input_fn
756
       (dflags1, unhandled_flags, warns)
757
           <- io $ parseDynamicFilePragma dflags0 src_opts
758 759
       setDynFlags dflags1
       io $ checkProcessArgsResult unhandled_flags
760

761
       if not (xopt Opt_Cpp dflags1) then do
762
           -- we have to be careful to emit warnings only once.
763
           unless (dopt Opt_Pp dflags1) $ io $ handleFlagWarnings dflags1 warns
764

sof's avatar
sof committed
765
           -- no need to preprocess CPP, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
766
           -- to the next phase of the pipeline.
767
           return (HsPp sf, input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
768
        else do
769 770
            output_fn <- phaseOutputFilename (HsPp sf)
            io $ doCpp dflags1 True{-raw-} False{-no CC opts-} input_fn output_fn
771 772
            -- re-read the pragmas now that we've preprocessed the file
            -- See #2464,#3457
773
            src_opts <- io $ getOptionsFromFile dflags0 output_fn
774
            (dflags2, unhandled_flags, warns)
775
                <- io $ parseDynamicFilePragma dflags0 src_opts
dterei's avatar
dterei committed
776
            io $ checkProcessArgsResult unhandled_flags
777
            unless (dopt Opt_Pp dflags2) $ io $ handleFlagWarnings dflags2 warns
778
            -- the HsPp pass below will emit warnings
779 780

            setDynFlags dflags2
781

782
            return (HsPp sf, output_fn)
783

sof's avatar
sof committed
784
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
785
-- HsPp phase
sof's avatar
sof committed
786

787 788
runPhase (HsPp sf) input_fn dflags
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
789
       if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
790
           -- no need to preprocess, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
791
           -- to the next phase of the pipeline.
792
          return (Hsc sf, input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
793 794
        else do
            let hspp_opts = getOpts dflags opt_F
795 796 797 798
            PipeEnv{src_basename, src_suffix} <- getPipeEnv
            let orig_fn = src_basename <.> src_suffix
            output_fn <- phaseOutputFilename (Hsc sf)
            io $ SysTools.runPp dflags
Ian Lynagh's avatar
Ian Lynagh committed
799 800 801 802 803 804
                           ( [ SysTools.Option     orig_fn
                             , SysTools.Option     input_fn
                             , SysTools.FileOption "" output_fn
                             ] ++
                             map SysTools.Option hspp_opts
                           )
805 806

            -- re-read pragmas now that we've parsed the file (see #3674)
807
            src_opts <- io $ getOptionsFromFile dflags output_fn
808
            (dflags1, unhandled_flags, warns)
809
                <- io $ parseDynamicFilePragma dflags src_opts
810 811
            setDynFlags dflags1
            io $ checkProcessArgsResult unhandled_flags
dterei's avatar
dterei committed
812
            io $ handleFlagWarnings dflags1 warns
813

814
            return (Hsc sf, output_fn)
815

816 817 818
-----------------------------------------------------------------------------
-- Hsc phase

819 820
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
821
runPhase (Hsc src_flavour) input_fn dflags0
Ian Lynagh's avatar
Ian Lynagh committed
822
 = do   -- normal Hsc mode, not mkdependHS
823 824 825 826

        PipeEnv{ stop_phase=stop,
                 src_basename=basename,
                 src_suffix=suff } <- getPipeEnv
827

828
  -- we add the current directory (i.e. the directory in which
829
  -- the .hs files resides) to the include path, since this is
830
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
831
        let current_dir = case takeDirectory basename of
Ian Lynagh's avatar
Ian Lynagh committed
832 833
                      "" -> "." -- XXX Hack
                      d -> d
Ian Lynagh's avatar
Ian Lynagh committed
834 835 836 837

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

838 839
        setDynFlags dflags

840
  -- gather the imports and module name
841
        (hspp_buf,mod_name,imps,src_imps) <- io $
842
            case src_flavour of
843
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
844
                    m <- getCoreModuleName input_fn
845
                    return (Nothing, mkModuleName m, [], [])
846

847
                _           -> do
848
                    buf <- hGetStringBuffer input_fn
849 850
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
851 852 853

  -- 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
854
  -- by hscMain for messages.  hscMain also needs
855
  -- the .hi and .o filenames, and this is as good a way
Ian Lynagh's avatar
Ian Lynagh committed
856
  -- as any to generate them, and better than most. (e.g. takes
857
  -- into accout the -osuf flags)
858
        location1 <- io $ mkHomeModLocation2 dflags mod_name basename suff
859 860

  -- Boot-ify it if necessary
Ian Lynagh's avatar
Ian Lynagh committed
861 862 863
        let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
                      | otherwise            = location1

864 865 866 867

  -- 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
868 869 870
        let ohi = outputHi dflags
            location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
                      | otherwise      = location2
871 872 873 874 875 876

  -- 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
877 878 879 880 881
        let expl_o_file = outputFile dflags
            location4 | Just ofile <- expl_o_file
                      , isNoLink (ghcLink dflags)
                      = location3 { ml_obj_file = ofile }
                      | otherwise = location3
882

Ian Lynagh's avatar
Ian Lynagh committed
883
            o_file = ml_obj_file location4      -- The real object file
884

885
        setModLocation location4
886 887

  -- Figure out if the source has changed, for recompilation avoidance.
888
  --
889
  -- Setting source_unchanged to True means that M.o seems
890 891
  -- to b