DriverPipeline.hs 93.6 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
   compileOne, compileOne',
Ian Lynagh's avatar
Ian Lynagh committed
24
   link,
25

26 27 28 29 30 31 32 33
        -- 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,
   linkingNeeded, checkLinkInfo
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 57
import StringBuffer     ( hGetStringBuffer )
import BasicTypes       ( SuccessFlag(..) )
import Maybes           ( expectJust )
import ParserCoreUtils  ( getCoreModuleName )
58
import SrcLoc
59
import FastString
60
import LlvmCodeGen      ( llvmFixupAsm )
61
import MonadUtils
62
import Platform
63
import TcRnTypes
64
import Hooks
65

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

77 78
-- ---------------------------------------------------------------------------
-- Pre-process
79

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

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

94
-- ---------------------------------------------------------------------------
95

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

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

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

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

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

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

169
   let extCore_filename = basename ++ ".hcr"
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 174 175
       source_modified
         | force_recomp || isNothing maybe_old_linkable = SourceModified
         | 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 200
              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
                   HsBootFile ->
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 207 208
                   _ -> do guts0 <- hscDesugar hsc_env summary tc_result
                           guts <- hscSimplify hsc_env guts0
                           (iface, _changed, details, cgguts) <- hscNormalIface hsc_env extCore_filename guts mb_old_hash
                           (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 234 235 236 237 238 239 240 241
                      let linkable = if isHsBoot src_flavour
                                     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
                   HsBootFile ->
242 243 244
                       do (iface, changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
                          hscWriteIface dflags iface changed summary
                          touchObjectFile dflags object_filename
245 246 247 248
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })

249 250 251 252
                   _ -> do guts0 <- hscDesugar hsc_env summary tc_result
                           guts <- hscSimplify hsc_env guts0
                           (iface, changed, details, cgguts) <- hscNormalIface hsc_env extCore_filename guts mb_old_hash
                           hscWriteIface dflags iface changed summary
253 254

                           -- We're in --make mode: finish the compilation pipeline.
255
                           let mod_name = ms_mod_name summary
256
                           _ <- runPipeline StopLn hsc_env
257 258
                                             (output_fn,
                                              Just (HscOut src_flavour mod_name (HscRecomp cgguts summary)))
259 260 261
                                             (Just basename)
                                             Persistent
                                             (Just location)
262
                                             Nothing
263 264 265 266 267 268 269
                                 -- 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 })
270

271
-----------------------------------------------------------------------------
272 273
-- stub .h and .c files (for foreign export support)

274 275 276
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
277 278 279
-- 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).
280

281 282 283 284
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
285

Ian Lynagh's avatar
Ian Lynagh committed
286
        return stub_o
287

288 289
-- ---------------------------------------------------------------------------
-- Link
290

Ian Lynagh's avatar
Ian Lynagh committed
291 292 293 294
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
295 296 297 298 299 300 301 302 303
     -> 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.

304 305 306 307 308 309 310 311
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
312

313 314
    l NoLink _ _ _
      = return Succeeded
315

316 317
    l LinkBinary dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
318

319 320
    l LinkStaticLib dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
321

322 323
    l LinkDynLib dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
324 325 326 327 328 329 330 331 332 333 334

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
335
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
336 337
   = do
        let
338 339 340 341
            staticLink = case ghcLink dflags of
                          LinkStaticLib -> True
                          _ -> platformBinariesAreStaticLibs (targetPlatform dflags)

Ian Lynagh's avatar
Ian Lynagh committed
342
            home_mod_infos = eltsUFM hpt
343

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

Ian Lynagh's avatar
Ian Lynagh committed
347 348
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
349

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

Ian Lynagh's avatar
Ian Lynagh committed
352 353 354 355 356
        -- 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
357

Ian Lynagh's avatar
Ian Lynagh committed
358 359
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
360

361
            exe_file = exeFileName staticLink dflags
362

363
        linking_needed <- linkingNeeded dflags staticLink linkables pkg_deps
364

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

Ian Lynagh's avatar
Ian Lynagh committed
370
        compilationProgressMsg dflags ("Linking " ++ exe_file ++ " ...")
371

Ian Lynagh's avatar
Ian Lynagh committed
372 373
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
374 375 376 377
                LinkBinary    -> linkBinary
                LinkStaticLib -> linkStaticLibCheck
                LinkDynLib    -> linkDynLibCheck
                other         -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
378
        link dflags obj_files pkg_deps
379

380
        debugTraceMsg dflags 3 (text "link: done")
381

Ian Lynagh's avatar
Ian Lynagh committed
382
        -- linkBinary only returns if it succeeds
383 384 385
        return Succeeded

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

390

391 392
linkingNeeded :: DynFlags -> Bool -> [Linkable] -> [PackageId] -> IO Bool
linkingNeeded dflags staticLink linkables pkg_deps = do
393 394 395
        -- 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).
396
  let exe_file = exeFileName staticLink dflags
397
  e_exe_time <- tryIO $ getModificationUTCTime exe_file
398 399 400 401
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
402
        let extra_ld_inputs = [ f | FileOption _ f <- ldInputs dflags ]
403
        e_extra_times <- mapM (tryIO . getModificationUTCTime) extra_ld_inputs
404 405 406
        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
407
            then return True
408 409 410 411 412 413 414 415 416
            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 ]

417
        pkg_libfiles <- mapM (uncurry (findHSLib dflags)) pkg_hslibs
418
        if any isNothing pkg_libfiles then return True else do
419
        e_lib_times <- mapM (tryIO . getModificationUTCTime)
420 421 422 423
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
424 425 426 427 428 429
           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
430
 | not (platformSupportsSavingLinkOpts (platformOS (targetPlatform dflags)))
431 432 433 434 435 436 437 438 439 440 441 442 443 444
 -- 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)

445 446 447 448 449
platformSupportsSavingLinkOpts :: OS -> Bool
platformSupportsSavingLinkOpts os
  | os == OSSolaris2 = False -- see #5382
  | otherwise        = osElfTarget os

450 451 452
ghcLinkInfoSectionName :: String
ghcLinkInfoSectionName = ".debug-ghc-link-info"
   -- if we use the ".debug" prefix, then strip will strip it by default
453

454 455
findHSLib :: DynFlags -> [String] -> String -> IO (Maybe FilePath)
findHSLib dflags dirs lib = do
ian@well-typed.com's avatar
ian@well-typed.com committed
456
  let batch_lib_file = if gopt Opt_Static dflags
457 458
                       then "lib" ++ lib <.> "a"
                       else mkSOName (targetPlatform dflags) lib
459 460 461 462 463
  found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
  case found of
    [] -> return Nothing
    (x:_) -> return (Just x)

464 465 466
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

467
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
468 469
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
470
  doLink (hsc_dflags hsc_env) stop_phase o_files
471

472
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
473
compileFile hsc_env stop_phase (src, mb_phase) = do
474
   exists <- doesFileExist src
Ian Lynagh's avatar
Ian Lynagh committed
475
   when (not exists) $
476
        throwGhcExceptionIO (CmdLineError ("does not exist: " ++ src))
Ian Lynagh's avatar
Ian Lynagh committed
477

478
   let
Austin Seipp's avatar
Austin Seipp committed
479
        dflags    = hsc_dflags hsc_env
ian@well-typed.com's avatar
ian@well-typed.com committed
480
        split     = gopt Opt_SplitObjs dflags
Ian Lynagh's avatar
Ian Lynagh committed
481 482
        mb_o_file = outputFile dflags
        ghc_link  = ghcLink dflags      -- Set by -c or -no-link
483

Ian Lynagh's avatar
Ian Lynagh committed
484 485
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
486
        output
487 488 489 490
         -- 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
491 492
         | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
                -- -o foo applies to linker
493
         | isJust mb_o_file = SpecificFile
Ian Lynagh's avatar
Ian Lynagh committed
494 495 496 497 498
                -- -o foo applies to the file we are compiling now
         | otherwise = Persistent

        stop_phase' = case stop_phase of
                        As | split -> SplitAs
499
                        _          -> stop_phase
500

501
   ( _, out_file) <- runPipeline stop_phase' hsc_env
502
                            (src, fmap RealPhase mb_phase) Nothing output
503
                            Nothing{-no ModLocation-} Nothing
504 505 506 507 508 509
   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
510
  = return ()           -- We stopped before the linking phase
511 512 513

  | otherwise
  = case ghcLink dflags of
514 515 516 517 518
        NoLink        -> return ()
        LinkBinary    -> linkBinary         dflags o_files []
        LinkStaticLib -> linkStaticLibCheck dflags o_files []
        LinkDynLib    -> linkDynLibCheck    dflags o_files []
        other         -> panicBadLink other
519 520


521
-- ---------------------------------------------------------------------------
522

523 524 525 526 527 528 529
-- | 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
530
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
531
-- pipeline.
532
runPipeline
533
  :: Phase                      -- ^ When to stop
534
  -> HscEnv                     -- ^ Compilation environment
535
  -> (FilePath,Maybe PhasePlus) -- ^ Input filename (and maybe -x suffix)
536
  -> Maybe FilePath             -- ^ original basename (if different from ^^^)
Ian Lynagh's avatar
Ian Lynagh committed
537
  -> PipelineOutput             -- ^ Output filename
538
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
539
  -> Maybe FilePath             -- ^ stub object, if we have one
540
  -> IO (DynFlags, FilePath)    -- ^ (final flags, output filename)
541
runPipeline stop_phase hsc_env0 (input_fn, mb_phase)
542
             mb_basename output maybe_loc maybe_stub_o
543 544 545 546 547 548 549 550 551 552 553 554 555

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

559 560 561 562 563 564
             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
565 566 567 568 569

             isHaskellishFile = isHaskell start_phase

             env = PipeEnv{ pe_isHaskellishFile = isHaskellishFile,
                            stop_phase,
570
                            src_filename = input_fn,
571 572 573 574 575 576 577 578 579 580 581
                            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.

582
         let happensBefore' = happensBefore dflags
583 584 585 586 587 588 589
         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 ()
590

ian@well-typed.com's avatar
ian@well-typed.com committed
591
         debugTraceMsg dflags 4 (text "Running the pipeline")
592
         r <- runPipeline' start_phase hsc_env env input_fn
593
                           maybe_loc maybe_stub_o
ian@well-typed.com's avatar
ian@well-typed.com committed
594 595 596 597

         -- 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
598
         let dflags = extractDynFlags hsc_env
Austin Seipp's avatar
Austin Seipp committed
599 600 601 602 603 604 605 606 607 608
         -- 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 ()
609 610 611
         return r

runPipeline'
612
  :: PhasePlus                  -- ^ When to start
613
  -> HscEnv                     -- ^ Compilation environment
614 615
  -> PipeEnv
  -> FilePath                   -- ^ Input filename
616 617
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
  -> Maybe FilePath             -- ^ stub object, if we have one
618
  -> IO (DynFlags, FilePath)    -- ^ (final flags, output filename)
619
runPipeline' start_phase hsc_env env input_fn
620
             maybe_loc maybe_stub_o
621
  = do
622
  -- Execute the pipeline...
623
  let state = PipeState{ hsc_env, maybe_loc, maybe_stub_o = maybe_stub_o }
624

625
  evalP (pipeLoop start_phase input_fn) env state
626

627 628 629 630
-- ---------------------------------------------------------------------------
-- outer pipeline loop

-- | pipeLoop runs phases until we reach the stop phase
631
pipeLoop :: PhasePlus -> FilePath -> CompPipeline (DynFlags, FilePath)
632
pipeLoop phase input_fn = do
633
  env <- getPipeEnv
634 635
  dflags <- getDynFlags
  let happensBefore' = happensBefore dflags
636
      stopPhase = stop_phase env
637 638
  case phase of
   RealPhase realPhase | realPhase `eqPhase` stopPhase            -- All done
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
     -> -- 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)


659
     | not (realPhase `happensBefore'` stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
660 661 662 663
        -- 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 #-}.
664
     -> panic ("pipeLoop: at phase " ++ show realPhase ++
665
           " but I wanted to stop at phase " ++ show stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
666

667
   _
668
     -> do liftIO $ debugTraceMsg dflags 4
669
                                  (ptext (sLit "Running phase") <+> ppr phase)
670
           (next_phase, output_fn) <- runHookedPhase phase input_fn dflags
671
           r <- pipeLoop next_phase output_fn
672
           case phase of
673 674
               HscOut {} ->
                   whenGeneratingDynamicToo dflags $ do
675
                       setDynFlags $ dynamicTooMkDynamicDynFlags dflags
676
                       -- TODO shouldn't ignore result:
677
                       _ <- pipeLoop phase input_fn
678 679 680 681
                       return ()
               _ ->
                   return ()
           return r
682

683 684 685 686 687
runHookedPhase :: PhasePlus -> FilePath -> DynFlags
               -> CompPipeline (PhasePlus, FilePath)
runHookedPhase pp input dflags =
  lookupHook runPhaseHook runPhase dflags pp input dflags

688 689 690 691
-- -----------------------------------------------------------------------------
-- 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.
692

693 694 695 696 697 698 699 700
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

701
getOutputFilename
702 703
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
704
getOutputFilename stop_phase output basename dflags next_phase maybe_location
705 706 707 708 709 710 711
 | 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
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
    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
                       As      | keep_s     -> True
                       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
748

749
-- -----------------------------------------------------------------------------
750
-- | Each phase in the pipeline returns the next phase to execute, and the
751 752 753 754 755 756
-- 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
757
-- taking the LLVM route to using the native code generator.
758
--
759
runPhase :: PhasePlus   -- ^ Run this phase
760 761
         -> FilePath    -- ^ name of the input file
         -> DynFlags    -- ^ for convenience, we pass the current dflags in
762
         -> CompPipeline (PhasePlus,           -- next phase to run
763
                          FilePath)            -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
764 765 766 767

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

769

770
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
771
-- Unlit phase
772

773
runPhase (RealPhase (Unlit sf)) input_fn dflags
774
  = do
775
       output_fn <- phaseOutputFilename (Cpp sf)
776

777
       let flags = [ -- The -h option passes the file name for unlit to
778 779
                     -- put in a #line directive
                     SysTools.Option     "-h"
780
                   , SysTools.Option $ escape $ normalise input_fn
781 782 783 784
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

785
       liftIO $ SysTools.runUnlit dflags flags
786

787
       return (RealPhase (Cpp sf), output_fn)
788 789 790 791 792 793 794 795 796 797 798 799 800
  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
       -- Coverage.addTicksToBinds where we check that the filename in
       -- a SrcLoc is the same as the source filenaame, the two will
       -- look bogusly different. See test:
       -- libraries/hpc/tests/function/subdir/tough2.lhs
       escape ('\\':cs) = '\\':'\\': escape cs
       escape ('\"':cs) = '\\':'\"': escape cs
       escape ('\'':cs) = '\\':'\'': escape cs
       escape (c:cs)    = c : escape cs
       escape []        = []
801 802

-------------------------------------------------------------------------------
803
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
804
--             (b) runs cpp if necessary
805

806
runPhase (RealPhase (Cpp sf)) input_fn dflags0
807
  = do
808
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
809
       (dflags1, unhandled_flags, warns)
810
           <- liftIO $ parseDynamicFilePragma dflags0 src_opts
811
       setDynFlags dflags1
812
       liftIO $ checkProcessArgsResult dflags1 unhandled_flags
813

814
       if not (xopt Opt_Cpp dflags1) then do
815
           -- we have to be careful to emit warnings only once.
816 817
           unless (gopt Opt_Pp dflags1) $
               liftIO $ handleFlagWarnings dflags1 warns
818

sof's avatar
sof committed
819
           -- no need to preprocess CPP, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
820
           -- to the next phase of the pipeline.
821
           return (RealPhase (HsPp sf), input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
822
        else do
823
            output_fn <- phaseOutputFilename (HsPp sf)
824
            liftIO $ doCpp dflags1 True{-raw-}
825
                           input_fn output_fn
826 827
            -- re-read the pragmas now that we've preprocessed the file
            -- See #2464,#3457
828
            src_opts <- liftIO $ getOptionsFromFile dflags0 output_fn
829
            (dflags2, unhandled_flags, warns)
830 831 832 833
                <- liftIO $ parseDynamicFilePragma dflags0 src_opts
            liftIO $ checkProcessArgsResult dflags2 unhandled_flags
            unless (gopt Opt_Pp dflags2) $
                liftIO $ handleFlagWarnings dflags2 warns
834
            -- the HsPp pass below will emit warnings
835 836

            setDynFlags dflags2
837

838
            return (RealPhase (HsPp sf), output_fn)
839

sof's avatar
sof committed
840
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
841
-- HsPp phase
sof's avatar
sof committed
842

843
runPhase (RealPhase (HsPp sf)) input_fn dflags
844
  = do
ian@well-typed.com's avatar
ian@well-typed.com committed