DriverPipeline.hs 103 KB
Newer Older
1 2
{-# LANGUAGE CPP, NamedFieldPuns, NondecreasingIndentation #-}
{-# OPTIONS_GHC -fno-cse #-}
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
   compileOne, compileOne',
Ian Lynagh's avatar
Ian Lynagh committed
24
   link,
25

26 27 28 29 30 31 32
        -- Exports for hooks to override runPhase and link
   PhasePlus(..), CompPipeline(..), PipeEnv(..), PipeState(..),
   phaseOutputFilename, getPipeState, getPipeEnv,
   hscPostBackendPhase, getLocation, setModLocation, setDynFlags,
   runPhase, exeFileName,
   mkExtraObjToLinkIntoBinary, mkNoteObjsToLinkIntoBinary,
   maybeCreateManifest, runPhase_MoveBinary,
33
   linkingNeeded, checkLinkInfo, writeInterfaceOnlyMode
34 35 36 37
  ) where

#include "HsVersions.h"

38
import PipelineMonad
39
import Packages
40
import HeaderInfo
41
import DriverPhases
42
import SysTools
43
import HscMain
44
import Finder
45
import HscTypes hiding ( Hsc )
46 47
import Outputable
import Module
Ian Lynagh's avatar
Ian Lynagh committed
48
import UniqFM           ( eltsUFM )
49
import ErrUtils
50
import DynFlags
51
import Config
52
import Panic
53
import Util
Ian Lynagh's avatar
Ian Lynagh committed
54 55 56
import StringBuffer     ( hGetStringBuffer )
import BasicTypes       ( SuccessFlag(..) )
import Maybes           ( expectJust )
57
import SrcLoc
58
import FastString
59
import LlvmCodeGen      ( llvmFixupAsm )
60
import MonadUtils
61
import Platform
62
import TcRnTypes
63
import Hooks
64

65
import Exception
Ian Lynagh's avatar
Ian Lynagh committed
66
import Data.IORef       ( readIORef )
Simon Marlow's avatar
Simon Marlow committed
67
import System.Directory
Ian Lynagh's avatar
Ian Lynagh committed
68
import System.FilePath
Simon Marlow's avatar
Simon Marlow committed
69 70
import System.IO
import Control.Monad
thoughtpolice's avatar
thoughtpolice committed
71
import Data.List        ( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
72 73
import Data.Maybe
import System.Environment
74
import Data.Char
75

76 77
-- ---------------------------------------------------------------------------
-- Pre-process
78

79
-- | Just preprocess a file, put the result in a temp. file (used by the
80
-- compilation manager during the summary phase).
81 82 83
--
-- We return the augmented DynFlags, because they contain the result
-- of slurping in the OPTIONS pragmas
84

85
preprocess :: HscEnv
86
           -> (FilePath, Maybe Phase) -- ^ filename and starting phase
87
           -> IO (DynFlags, FilePath)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
88
preprocess hsc_env (filename, mb_phase) =
Ian Lynagh's avatar
Ian Lynagh committed
89
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename)
90
  runPipeline anyHsc hsc_env (filename, fmap RealPhase mb_phase)
91
        Nothing Temporary Nothing{-no ModLocation-} Nothing{-no stub-}
92

93
-- ---------------------------------------------------------------------------
94

95 96
-- | Compile
--
97 98 99 100
-- 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
101 102 103
-- 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.
104
--
105 106
-- NB.  No old interface can also mean that the source has changed.

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
compileOne :: 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
           -> SourceModified
           -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful

compileOne = compileOne' Nothing (Just batchMsg)

compileOne' :: Maybe TcGblEnv
            -> Maybe Messager
            -> 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
            -> SourceModified
            -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful

compileOne' m_tc_result mHscMessage
            hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
            source_modified0
132 133 134 135
 = 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
136 137
       location    = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location)
138
       input_fnpp  = ms_hspp_file summary
Austin Seipp's avatar
Austin Seipp committed
139 140
       mod_graph   = hsc_mod_graph hsc_env0
       needsTH     = any (xopt Opt_TemplateHaskell . ms_hspp_opts) mod_graph
141 142
       needsQQ     = any (xopt Opt_QuasiQuotes     . ms_hspp_opts) mod_graph
       needsLinker = needsTH || needsQQ
143
       isDynWay    = any (== WayDyn) (ways dflags0)
Austin Seipp's avatar
Austin Seipp committed
144
       isProfWay   = any (== WayProf) (ways dflags0)
Austin Seipp's avatar
Austin Seipp committed
145 146
   -- #8180 - when using TemplateHaskell, switch on -dynamic-too so
   -- the linker can correctly load the object files.
147
   let dflags1 = if needsLinker && dynamicGhc && not isDynWay && not isProfWay
Austin Seipp's avatar
Austin Seipp committed
148 149 150 151
                  then gopt_set dflags0 Opt_BuildDynamicToo
                  else dflags0

   debugTraceMsg dflags1 2 (text "compile: input file" <+> text input_fnpp)
152

Ian Lynagh's avatar
Ian Lynagh committed
153
   let basename = dropExtension input_fn
154

155 156 157
  -- 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.
158
   let current_dir = takeDirectory basename
Austin Seipp's avatar
Austin Seipp committed
159 160
       old_paths   = includePaths dflags1
       dflags      = dflags1 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
161
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
162

163
   -- Figure out what lang we're generating
164
   let hsc_lang = hscTarget dflags
165
   -- ... and what the next phase should be
dterei's avatar
dterei committed
166
   let next_phase = hscPostBackendPhase dflags src_flavour hsc_lang
167
   -- ... and what file to generate the output into
168
   output_fn <- getOutputFilename next_phase
Ian Lynagh's avatar
Ian Lynagh committed
169
                        Temporary basename dflags next_phase (Just location)
170

171
   -- -fforce-recomp should also work with --make
ian@well-typed.com's avatar
ian@well-typed.com committed
172
   let force_recomp = gopt Opt_ForceRecomp dflags
173
       source_modified
174
         | force_recomp = SourceModified
175
         | otherwise = source_modified0
176
       object_filename = ml_obj_file location
177

178 179 180 181 182 183 184
   let always_do_basic_recompilation_check = case hsc_lang of
                                             HscInterpreted -> True
                                             _ -> False

   e <- genericHscCompileGetFrontendResult
            always_do_basic_recompilation_check
            m_tc_result mHscMessage
185
            hsc_env summary source_modified mb_old_iface (mod_index, nmods)
186 187 188 189

   case e of
       Left iface ->
           do details <- genModDetails hsc_env iface
190
              MASSERT(isJust maybe_old_linkable)
191 192 193 194 195 196 197 198 199
              return (HomeModInfo{ hm_details  = details,
                                   hm_iface    = iface,
                                   hm_linkable = maybe_old_linkable })

       Right (tc_result, mb_old_hash) ->
           -- run the compiler
           case hsc_lang of
               HscInterpreted ->
                   case ms_hsc_src summary of
200
                   t | isHsBootOrSig t ->
201
                       do (iface, _changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
202 203 204
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })
205 206
                   _ -> do guts0 <- hscDesugar hsc_env summary tc_result
                           guts <- hscSimplify hsc_env guts0
Austin Seipp's avatar
Austin Seipp committed
207
                           (iface, _changed, details, cgguts) <- hscNormalIface hsc_env guts mb_old_hash
208
                           (hasStub, comp_bc, modBreaks) <- hscInteractive hsc_env cgguts summary
209 210 211 212

                           stub_o <- case hasStub of
                                     Nothing -> return []
                                     Just stub_c -> do
213
                                         stub_o <- compileStub hsc_env stub_c
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
                                         return [DotO stub_o]

                           let hs_unlinked = [BCOs comp_bc modBreaks]
                               unlinked_time = ms_hs_date summary
                             -- 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_o)

                           return (HomeModInfo{ hm_details  = details,
                                                hm_iface    = iface,
                                                hm_linkable = Just linkable })
               HscNothing ->
231
                   do (iface, changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
232 233
                      when (gopt Opt_WriteInterface dflags) $
                         hscWriteIface dflags iface changed summary
234
                      let linkable = if isHsBootOrSig src_flavour
235 236 237 238 239 240 241 242
                                     then maybe_old_linkable
                                     else Just (LM (ms_hs_date summary) this_mod [])
                      return (HomeModInfo{ hm_details  = details,
                                           hm_iface    = iface,
                                           hm_linkable = linkable })

               _ ->
                   case ms_hsc_src summary of
243
                   HsBootFile ->
244 245 246
                       do (iface, changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
                          hscWriteIface dflags iface changed summary
                          touchObjectFile dflags object_filename
247 248 249 250
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
                   HsigFile ->
                       do (iface, changed, details) <-
                                    hscSimpleIface hsc_env tc_result mb_old_hash
                          hscWriteIface dflags iface changed summary
                          compileEmptyStub dflags hsc_env basename location

                          -- Same as Hs
                          o_time <- getModificationUTCTime object_filename
                          let linkable =
                                  LM o_time this_mod [DotO object_filename]

                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = Just linkable })

                   HsSrcFile ->
                        do guts0 <- hscDesugar hsc_env summary tc_result
268
                           guts <- hscSimplify hsc_env guts0
Austin Seipp's avatar
Austin Seipp committed
269
                           (iface, changed, details, cgguts) <- hscNormalIface hsc_env guts mb_old_hash
270
                           hscWriteIface dflags iface changed summary
271 272

                           -- We're in --make mode: finish the compilation pipeline.
273
                           let mod_name = ms_mod_name summary
274
                           _ <- runPipeline StopLn hsc_env
275 276
                                             (output_fn,
                                              Just (HscOut src_flavour mod_name (HscRecomp cgguts summary)))
277 278 279
                                             (Just basename)
                                             Persistent
                                             (Just location)
280
                                             Nothing
281 282 283 284 285 286 287
                                 -- The object filename comes from the ModLocation
                           o_time <- getModificationUTCTime object_filename
                           let linkable = LM o_time this_mod [DotO object_filename]

                           return (HomeModInfo{ hm_details  = details,
                                                hm_iface    = iface,
                                                hm_linkable = Just linkable })
288

289
-----------------------------------------------------------------------------
290 291
-- stub .h and .c files (for foreign export support)

292 293 294
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
295 296 297
-- 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).
298

299 300 301 302
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
303

Ian Lynagh's avatar
Ian Lynagh committed
304
        return stub_o
305

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
compileEmptyStub :: DynFlags -> HscEnv -> FilePath -> ModLocation -> IO ()
compileEmptyStub dflags hsc_env basename location = do
  -- To maintain the invariant that every Haskell file
  -- compiles to object code, we make an empty (but
  -- valid) stub object file for signatures
  empty_stub <- newTempName dflags "c"
  writeFile empty_stub ""
  _ <- runPipeline StopLn hsc_env
                  (empty_stub, Nothing)
                  (Just basename)
                  Persistent
                  (Just location)
                  Nothing
  return ()

321 322
-- ---------------------------------------------------------------------------
-- Link
323

Ian Lynagh's avatar
Ian Lynagh committed
324 325 326 327
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
328 329 330 331 332 333 334 335 336
     -> 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.

337 338 339 340 341 342 343 344
link ghcLink dflags
  = lookupHook linkHook l dflags ghcLink dflags
  where
    l LinkInMemory _ _ _
      = if cGhcWithInterpreter == "YES"
        then -- Not Linking...(demand linker will do the job)
             return Succeeded
        else panicBadLink LinkInMemory
345

346 347
    l NoLink _ _ _
      = return Succeeded
348

349 350
    l LinkBinary dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
351

352 353
    l LinkStaticLib dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
354

355 356
    l LinkDynLib dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
357 358 359 360 361 362 363 364 365 366 367

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
368
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
369 370
   = do
        let
371 372 373 374
            staticLink = case ghcLink dflags of
                          LinkStaticLib -> True
                          _ -> platformBinariesAreStaticLibs (targetPlatform dflags)

375
            home_mod_infos = eltsUFM hpt
376

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

Ian Lynagh's avatar
Ian Lynagh committed
380 381
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
382

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

Ian Lynagh's avatar
Ian Lynagh committed
385 386 387 388 389
        -- 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
390

Ian Lynagh's avatar
Ian Lynagh committed
391 392
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
393

394
            exe_file = exeFileName staticLink dflags
395

396
        linking_needed <- linkingNeeded dflags staticLink linkables pkg_deps
397

ian@well-typed.com's avatar
ian@well-typed.com committed
398
        if not (gopt Opt_ForceRecomp dflags) && not linking_needed
399
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
400 401
                   return Succeeded
           else do
402

Ian Lynagh's avatar
Ian Lynagh committed
403
        compilationProgressMsg dflags ("Linking " ++ exe_file ++ " ...")
404

Ian Lynagh's avatar
Ian Lynagh committed
405 406
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
407 408 409 410
                LinkBinary    -> linkBinary
                LinkStaticLib -> linkStaticLibCheck
                LinkDynLib    -> linkDynLibCheck
                other         -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
411
        link dflags obj_files pkg_deps
412

413
        debugTraceMsg dflags 3 (text "link: done")
414

Ian Lynagh's avatar
Ian Lynagh committed
415
        -- linkBinary only returns if it succeeds
416 417 418
        return Succeeded

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

423

424
linkingNeeded :: DynFlags -> Bool -> [Linkable] -> [PackageKey] -> IO Bool
425
linkingNeeded dflags staticLink linkables pkg_deps = do
426 427 428
        -- 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).
429
  let exe_file = exeFileName staticLink dflags
430
  e_exe_time <- tryIO $ getModificationUTCTime exe_file
431 432 433 434
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
435
        let extra_ld_inputs = [ f | FileOption _ f <- ldInputs dflags ]
436
        e_extra_times <- mapM (tryIO . getModificationUTCTime) extra_ld_inputs
437 438 439
        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
440
            then return True
441 442 443 444
            else do

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

449
        pkg_libfiles <- mapM (uncurry (findHSLib dflags)) pkg_hslibs
450
        if any isNothing pkg_libfiles then return True else do
451
        e_lib_times <- mapM (tryIO . getModificationUTCTime)
452 453 454 455
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
456 457 458 459
           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".
460
checkLinkInfo :: DynFlags -> [PackageKey] -> FilePath -> IO Bool
461
checkLinkInfo dflags pkg_deps exe_file
462
 | not (platformSupportsSavingLinkOpts (platformOS (targetPlatform dflags)))
463 464 465 466 467 468 469 470 471 472 473 474 475 476
 -- 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)

477 478 479 480 481
platformSupportsSavingLinkOpts :: OS -> Bool
platformSupportsSavingLinkOpts os
  | os == OSSolaris2 = False -- see #5382
  | otherwise        = osElfTarget os

482 483 484
ghcLinkInfoSectionName :: String
ghcLinkInfoSectionName = ".debug-ghc-link-info"
   -- if we use the ".debug" prefix, then strip will strip it by default
485

486 487
findHSLib :: DynFlags -> [String] -> String -> IO (Maybe FilePath)
findHSLib dflags dirs lib = do
ian@well-typed.com's avatar
ian@well-typed.com committed
488
  let batch_lib_file = if gopt Opt_Static dflags
489 490
                       then "lib" ++ lib <.> "a"
                       else mkSOName (targetPlatform dflags) lib
491 492 493 494 495
  found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
  case found of
    [] -> return Nothing
    (x:_) -> return (Just x)

496 497 498
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

499
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
500 501
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
502
  doLink (hsc_dflags hsc_env) stop_phase o_files
503

504
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
505
compileFile hsc_env stop_phase (src, mb_phase) = do
506
   exists <- doesFileExist src
Ian Lynagh's avatar
Ian Lynagh committed
507
   when (not exists) $
508
        throwGhcExceptionIO (CmdLineError ("does not exist: " ++ src))
Ian Lynagh's avatar
Ian Lynagh committed
509

510
   let
Austin Seipp's avatar
Austin Seipp committed
511
        dflags    = hsc_dflags hsc_env
ian@well-typed.com's avatar
ian@well-typed.com committed
512
        split     = gopt Opt_SplitObjs dflags
Ian Lynagh's avatar
Ian Lynagh committed
513 514
        mb_o_file = outputFile dflags
        ghc_link  = ghcLink dflags      -- Set by -c or -no-link
515

Ian Lynagh's avatar
Ian Lynagh committed
516 517
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
518
        output
519 520 521 522
         -- If we are dong -fno-code, then act as if the output is
         -- 'Temporary'. This stops GHC trying to copy files to their
         -- final location.
         | HscNothing <- hscTarget dflags = Temporary
Ian Lynagh's avatar
Ian Lynagh committed
523 524
         | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
                -- -o foo applies to linker
525
         | isJust mb_o_file = SpecificFile
Ian Lynagh's avatar
Ian Lynagh committed
526 527 528 529
                -- -o foo applies to the file we are compiling now
         | otherwise = Persistent

        stop_phase' = case stop_phase of
Simon Marlow's avatar
Simon Marlow committed
530 531
                        As _ | split -> SplitAs
                        _            -> stop_phase
532

533
   ( _, out_file) <- runPipeline stop_phase' hsc_env
534
                            (src, fmap RealPhase mb_phase) Nothing output
535
                            Nothing{-no ModLocation-} Nothing
536 537 538 539 540 541
   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
542
  = return ()           -- We stopped before the linking phase
543 544 545

  | otherwise
  = case ghcLink dflags of
546 547 548 549 550
        NoLink        -> return ()
        LinkBinary    -> linkBinary         dflags o_files []
        LinkStaticLib -> linkStaticLibCheck dflags o_files []
        LinkDynLib    -> linkDynLibCheck    dflags o_files []
        other         -> panicBadLink other
551 552


553
-- ---------------------------------------------------------------------------
554

555 556 557 558 559 560 561
-- | 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
562
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
563
-- pipeline.
564
runPipeline
565
  :: Phase                      -- ^ When to stop
566
  -> HscEnv                     -- ^ Compilation environment
567
  -> (FilePath,Maybe PhasePlus) -- ^ Input filename (and maybe -x suffix)
568
  -> Maybe FilePath             -- ^ original basename (if different from ^^^)
Ian Lynagh's avatar
Ian Lynagh committed
569
  -> PipelineOutput             -- ^ Output filename
570
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
571
  -> Maybe FilePath             -- ^ stub object, if we have one
572
  -> IO (DynFlags, FilePath)    -- ^ (final flags, output filename)
573
runPipeline stop_phase hsc_env0 (input_fn, mb_phase)
574
             mb_basename output maybe_loc maybe_stub_o
575 576 577 578 579 580 581 582 583 584 585 586 587

    = do let
             dflags0 = hsc_dflags hsc_env0

             -- Decide where dump files should go based on the pipeline output
             dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
             hsc_env = hsc_env0 {hsc_dflags = dflags}

             (input_basename, suffix) = splitExtension input_fn
             suffix' = drop 1 suffix -- strip off the .
             basename | Just b <- mb_basename = b
                      | otherwise             = input_basename

ian@well-typed.com's avatar
ian@well-typed.com committed
588
             -- If we were given a -x flag, then use that phase to start from
589
             start_phase = fromMaybe (RealPhase (startPhase suffix')) mb_phase
ian@well-typed.com's avatar
ian@well-typed.com committed
590

591 592 593 594 595 596
             isHaskell (RealPhase (Unlit _)) = True
             isHaskell (RealPhase (Cpp   _)) = True
             isHaskell (RealPhase (HsPp  _)) = True
             isHaskell (RealPhase (Hsc   _)) = True
             isHaskell (HscOut {})           = True
             isHaskell _                     = False
ian@well-typed.com's avatar
ian@well-typed.com committed
597 598 599 600 601

             isHaskellishFile = isHaskell start_phase

             env = PipeEnv{ pe_isHaskellishFile = isHaskellishFile,
                            stop_phase,
602
                            src_filename = input_fn,
603 604 605 606 607 608 609 610 611 612 613
                            src_basename = basename,
                            src_suffix = suffix',
                            output_spec = output }

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

614
         let happensBefore' = happensBefore dflags
615 616 617 618 619 620 621
         case start_phase of
             RealPhase start_phase' ->
                 when (not (start_phase' `happensBefore'` stop_phase)) $
                       throwGhcExceptionIO (UsageError
                                   ("cannot compile this file to desired target: "
                                      ++ input_fn))
             HscOut {} -> return ()
622

ian@well-typed.com's avatar
ian@well-typed.com committed
623
         debugTraceMsg dflags 4 (text "Running the pipeline")
624
         r <- runPipeline' start_phase hsc_env env input_fn
625
                           maybe_loc maybe_stub_o
ian@well-typed.com's avatar
ian@well-typed.com committed
626 627 628 629

         -- If we are compiling a Haskell module, and doing
         -- -dynamic-too, but couldn't do the -dynamic-too fast
         -- path, then rerun the pipeline for the dyn way
630
         let dflags = extractDynFlags hsc_env
Austin Seipp's avatar
Austin Seipp committed
631 632 633 634 635 636 637 638 639 640
         -- NB: Currently disabled on Windows (ref #7134, #8228, and #5987)
         when (not $ platformOS (targetPlatform dflags) == OSMinGW32) $ do
           when isHaskellishFile $ whenCannotGenerateDynamicToo dflags $ do
               debugTraceMsg dflags 4
                   (text "Running the pipeline again for -dynamic-too")
               let dflags' = dynamicTooMkDynamicDynFlags dflags
               hsc_env' <- newHscEnv dflags'
               _ <- runPipeline' start_phase hsc_env' env input_fn
                                 maybe_loc maybe_stub_o
               return ()
641 642 643
         return r

runPipeline'
644
  :: PhasePlus                  -- ^ When to start
645
  -> HscEnv                     -- ^ Compilation environment
646 647
  -> PipeEnv
  -> FilePath                   -- ^ Input filename
648 649
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
  -> Maybe FilePath             -- ^ stub object, if we have one
650
  -> IO (DynFlags, FilePath)    -- ^ (final flags, output filename)
651
runPipeline' start_phase hsc_env env input_fn
652
             maybe_loc maybe_stub_o
653
  = do
654
  -- Execute the pipeline...
655
  let state = PipeState{ hsc_env, maybe_loc, maybe_stub_o = maybe_stub_o }
656

657
  evalP (pipeLoop start_phase input_fn) env state
658

659 660 661 662
-- ---------------------------------------------------------------------------
-- outer pipeline loop

-- | pipeLoop runs phases until we reach the stop phase
663
pipeLoop :: PhasePlus -> FilePath -> CompPipeline (DynFlags, FilePath)
664
pipeLoop phase input_fn = do
665
  env <- getPipeEnv
666 667
  dflags <- getDynFlags
  let happensBefore' = happensBefore dflags
668
      stopPhase = stop_phase env
669 670
  case phase of
   RealPhase realPhase | realPhase `eqPhase` stopPhase            -- All done
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
     -> -- Sometimes, a compilation phase doesn't actually generate any output
        -- (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
        -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
        -- further compilation stages can tell what the original filename was.
        case output_spec env of
        Temporary ->
            return (dflags, input_fn)
        output ->
            do pst <- getPipeState
               final_fn <- liftIO $ getOutputFilename
                                        stopPhase output (src_basename env)
                                        dflags stopPhase (maybe_loc pst)
               when (final_fn /= input_fn) $ do
                  let msg = ("Copying `" ++ input_fn ++"' to `" ++ final_fn ++ "'")
                      line_prag = Just ("{-# LINE 1 \"" ++ src_filename env ++ "\" #-}\n")
                  liftIO $ copyWithHeader dflags msg line_prag input_fn final_fn
               return (dflags, final_fn)


691
     | not (realPhase `happensBefore'` stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
692 693 694 695
        -- 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 #-}.
696
     -> panic ("pipeLoop: at phase " ++ show realPhase ++
697
           " but I wanted to stop at phase " ++ show stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
698

699
   _
700
     -> do liftIO $ debugTraceMsg dflags 4
701
                                  (ptext (sLit "Running phase") <+> ppr phase)
702
           (next_phase, output_fn) <- runHookedPhase phase input_fn dflags
703
           r <- pipeLoop next_phase output_fn
704
           case phase of
705 706
               HscOut {} ->
                   whenGeneratingDynamicToo dflags $ do
707
                       setDynFlags $ dynamicTooMkDynamicDynFlags dflags
708
                       -- TODO shouldn't ignore result:
709
                       _ <- pipeLoop phase input_fn
710 711 712 713
                       return ()
               _ ->
                   return ()
           return r
714

715 716 717 718 719
runHookedPhase :: PhasePlus -> FilePath -> DynFlags
               -> CompPipeline (PhasePlus, FilePath)
runHookedPhase pp input dflags =
  lookupHook runPhaseHook runPhase dflags pp input dflags

720 721 722 723
-- -----------------------------------------------------------------------------
-- 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.
724

725 726 727 728 729 730 731 732
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
  liftIO $ getOutputFilename stop_phase output_spec
                             src_basename dflags next_phase maybe_loc

733
getOutputFilename
734 735
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
736
getOutputFilename stop_phase output basename dflags next_phase maybe_location
737 738 739 740 741 742 743
 | is_last_phase, Persistent   <- output = persistent_fn
 | is_last_phase, SpecificFile <- output = case outputFile dflags of
                                           Just f -> return f
                                           Nothing ->
                                               panic "SpecificFile: No filename"
 | keep_this_output                      = persistent_fn
 | otherwise                             = newTempName dflags suffix
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
    where
          hcsuf      = hcSuf dflags
          odir       = objectDir dflags
          osuf       = objectSuf dflags
          keep_hc    = gopt Opt_KeepHcFiles dflags
          keep_s     = gopt Opt_KeepSFiles dflags
          keep_bc    = gopt Opt_KeepLlvmFiles dflags

          myPhaseInputExt HCc       = hcsuf
          myPhaseInputExt MergeStub = osuf
          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
Simon Marlow's avatar
Simon Marlow committed
762
                       As _    | keep_s     -> True
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
                       LlvmOpt | keep_bc    -> True
                       HCc     | keep_hc    -> True
                       _other               -> False

          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
780

781
-- -----------------------------------------------------------------------------
782
-- | Each phase in the pipeline returns the next phase to execute, and the
783 784 785 786 787 788
-- 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
789
-- taking the LLVM route to using the native code generator.
790
--
791
runPhase :: PhasePlus   -- ^ Run this phase
792 793
         -> FilePath    -- ^ name of the input file
         -> DynFlags    -- ^ for convenience, we pass the current dflags in
794
         -> CompPipeline (PhasePlus,           -- next phase to run
795
                          FilePath)            -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
796 797 798 799

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

801

802
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
803
-- Unlit phase
804

805
runPhase (RealPhase (Unlit sf)) input_fn dflags
806
  = do
807
       output_fn <- phaseOutputFilename (Cpp sf)
808

809
       let flags = [ -- The -h option passes the file name for unlit to
810 811
                     -- put in a #line directive
                     SysTools.Option     "-h"
812 813
                     -- See Note [Don't normalise input filenames].
                   , SysTools.Option $ escape input_fn
814 815 816 817
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

818
       liftIO $ SysTools.runUnlit dflags flags
819

820
       return (RealPhase (Cpp sf), output_fn)
821 822 823 824
  where
       -- escape the characters \, ", and ', but don't try to escape
       -- Unicode or anything else (so we don't use Util.charToC
       -- here).  If we get this wrong, then in
825
       -- Coverage.isGoodTickSrcSpan where we check that the filename in
826 827
       -- a SrcLoc is the same as the source filenaame, the two will
       -- look bogusly different. See test:
828
       -- libraries/hpc/tests/function/subdir/tough2.hs
829 830 831 832 833
       escape ('\\':cs) = '\\':'\\': escape cs
       escape ('\"':cs) = '\\':'\"': escape cs
       escape ('\'':cs) = '\\':'\'': escape cs
       escape (c:cs)    = c : escape cs
       escape []        = []
834 835

-------------------------------------------------------------------------------
836
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
837
--             (b) runs cpp if necessary
838

839
runPhase (RealPhase (Cpp sf)) input_fn dflags0
840
  = do
841
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
842
       (dflags1, unhandled_flags, warns)
843
           <- liftIO $ parseDynamicFilePragma dflags0 src_opts
844
       setDynFlags dflags1
845
       liftIO $ checkProcessArgsResult dflags1 unhandled_flags
846

847
       if not (xopt Opt_Cpp dflags1) then do
848
           -- we have to be careful to emit warnings only once.
849 850
           unless (gopt Opt_Pp dflags1) $
               liftIO $ handleFlagWarnings dflags1 warns