DriverPipeline.hs 99.1 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
        -- Exports for hooks to override runPhase and link
   PhasePlus(..), CompPipeline(..), PipeEnv(..), PipeState(..),
   phaseOutputFilename, getPipeState, getPipeEnv,
   hscPostBackendPhase, getLocation, setModLocation, setDynFlags,
   runPhase, exeFileName,
   mkExtraObjToLinkIntoBinary, mkNoteObjsToLinkIntoBinary,
thomie's avatar
thomie committed
32
   maybeCreateManifest,
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
import Data.Maybe
73
import Data.Char
74

75 76
-- ---------------------------------------------------------------------------
-- Pre-process
77

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

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

92
-- ---------------------------------------------------------------------------
93

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

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
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
131 132 133 134
 = 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
135 136
       location    = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location)
137
       input_fnpp  = ms_hspp_file summary
Austin Seipp's avatar
Austin Seipp committed
138 139
       mod_graph   = hsc_mod_graph hsc_env0
       needsTH     = any (xopt Opt_TemplateHaskell . ms_hspp_opts) mod_graph
140 141
       needsQQ     = any (xopt Opt_QuasiQuotes     . ms_hspp_opts) mod_graph
       needsLinker = needsTH || needsQQ
142
       isDynWay    = any (== WayDyn) (ways dflags0)
Austin Seipp's avatar
Austin Seipp committed
143
       isProfWay   = any (== WayProf) (ways dflags0)
Austin Seipp's avatar
Austin Seipp committed
144 145
   -- #8180 - when using TemplateHaskell, switch on -dynamic-too so
   -- the linker can correctly load the object files.
146
   let dflags1 = if needsLinker && dynamicGhc && not isDynWay && not isProfWay
Austin Seipp's avatar
Austin Seipp committed
147 148 149 150
                  then gopt_set dflags0 Opt_BuildDynamicToo
                  else dflags0

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

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

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

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

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

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

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

   case e of
       Left iface ->
           do details <- genModDetails hsc_env iface
189
              MASSERT(isJust maybe_old_linkable || isNoLink (ghcLink dflags))
190 191 192 193 194 195 196 197 198
              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
199
                   t | isHsBootOrSig t ->
200
                       do (iface, _changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
201 202 203
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })
204 205
                   _ -> do guts0 <- hscDesugar hsc_env summary tc_result
                           guts <- hscSimplify hsc_env guts0
Austin Seipp's avatar
Austin Seipp committed
206
                           (iface, _changed, details, cgguts) <- hscNormalIface hsc_env guts mb_old_hash
207
                           (hasStub, comp_bc, modBreaks) <- hscInteractive hsc_env cgguts summary
208 209 210 211

                           stub_o <- case hasStub of
                                     Nothing -> return []
                                     Just stub_c -> do
212
                                         stub_o <- compileStub hsc_env stub_c
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
                                         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 ->
230
                   do (iface, changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
231 232
                      when (gopt Opt_WriteInterface dflags) $
                         hscWriteIface dflags iface changed summary
233
                      let linkable = if isHsBootOrSig src_flavour
234 235 236 237 238 239 240 241
                                     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
242
                   HsBootFile ->
243 244 245
                       do (iface, changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
                          hscWriteIface dflags iface changed summary
                          touchObjectFile dflags object_filename
246 247 248 249
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
                   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
267
                           guts <- hscSimplify hsc_env guts0
Austin Seipp's avatar
Austin Seipp committed
268
                           (iface, changed, details, cgguts) <- hscNormalIface hsc_env guts mb_old_hash
269
                           hscWriteIface dflags iface changed summary
270 271

                           -- We're in --make mode: finish the compilation pipeline.
272
                           let mod_name = ms_mod_name summary
273
                           _ <- runPipeline StopLn hsc_env
274 275
                                             (output_fn,
                                              Just (HscOut src_flavour mod_name (HscRecomp cgguts summary)))
276 277 278
                                             (Just basename)
                                             Persistent
                                             (Just location)
279
                                             Nothing
280 281 282 283 284 285 286
                                 -- 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 })
287

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

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

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

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

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
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 ()

320 321
-- ---------------------------------------------------------------------------
-- Link
322

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

336 337 338 339 340 341 342 343
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
344

345 346
    l NoLink _ _ _
      = return Succeeded
347

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

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

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

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

374
            home_mod_infos = eltsUFM hpt
375

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

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

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

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

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

393
            exe_file = exeFileName staticLink dflags
394

395
        linking_needed <- linkingNeeded dflags staticLink linkables pkg_deps
396

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

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

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

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

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

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

422

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

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

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

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

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

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
515 516
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
517
        output
518 519 520 521
         -- 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
522 523
         | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
                -- -o foo applies to linker
524
         | isJust mb_o_file = SpecificFile
Ian Lynagh's avatar
Ian Lynagh committed
525 526 527 528
                -- -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
529 530
                        As _ | split -> SplitAs
                        _            -> stop_phase
531

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

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


552
-- ---------------------------------------------------------------------------
553

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

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

590 591 592 593 594 595
             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
596 597 598

             isHaskellishFile = isHaskell start_phase

599
             env = PipeEnv{ stop_phase,
600
                            src_filename = input_fn,
601 602 603 604 605 606 607
                            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.
608
         let happensBefore' = happensBefore dflags
609 610
         case start_phase of
             RealPhase start_phase' ->
611 612 613 614
                 -- See Note [Partial ordering on phases]
                 -- Not the same as: (stop_phase `happensBefore` start_phase')
                 when (not (start_phase' `happensBefore'` stop_phase ||
                            start_phase' `eqPhase` stop_phase)) $
615 616 617 618
                       throwGhcExceptionIO (UsageError
                                   ("cannot compile this file to desired target: "
                                      ++ input_fn))
             HscOut {} -> return ()
619

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

         -- 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
627
         let dflags = extractDynFlags hsc_env
Austin Seipp's avatar
Austin Seipp committed
628 629 630 631 632 633 634 635 636 637
         -- 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 ()
638 639 640
         return r

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

654
  evalP (pipeLoop start_phase input_fn) env state
655

656 657 658 659
-- ---------------------------------------------------------------------------
-- outer pipeline loop

-- | pipeLoop runs phases until we reach the stop phase
660
pipeLoop :: PhasePlus -> FilePath -> CompPipeline (DynFlags, FilePath)
661
pipeLoop phase input_fn = do
662
  env <- getPipeEnv
663
  dflags <- getDynFlags
664
  -- See Note [Partial ordering on phases]
665
  let happensBefore' = happensBefore dflags
666
      stopPhase = stop_phase env
667 668
  case phase of
   RealPhase realPhase | realPhase `eqPhase` stopPhase            -- All done
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
     -> -- 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)


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

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

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

718 719 720 721
-- -----------------------------------------------------------------------------
-- 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.
722

723 724 725 726 727 728 729 730
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

731
getOutputFilename
732 733
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
734
getOutputFilename stop_phase output basename dflags next_phase maybe_location
735 736 737 738 739 740 741
 | 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
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
    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
760
                       As _    | keep_s     -> True
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
                       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
778

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

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

799

800
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
801
-- Unlit phase
802

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

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

816
       liftIO $ SysTools.runUnlit dflags flags
817

818
       return (RealPhase (Cpp sf), output_fn)
819 820 821 822
  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
823
       -- Coverage.isGoodTickSrcSpan where we check that the filename in
824 825
       -- a SrcLoc is the same as the source filenaame, the two will
       -- look bogusly different. See test:
826
       -- libraries/hpc/tests/function/subdir/tough2.hs
827 828 829 830 831
       escape ('\\':cs) = '\\':'\\': escape cs
       escape ('\"':cs) = '\\':'\"': escape cs
       escape ('\'':cs) = '\\':'\'': escape cs
       escape (c:cs)    = c : escape cs
       escape []        = []
832 833

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

837
runPhase (RealPhase (Cpp sf)) input_fn dflags0
838
  = do
839
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
840
       (dflags1, unhandled_flags, warns)
841 <