DriverPipeline.hs 93 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
  ) where

#include "HsVersions.h"

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

56
import Exception
Ian Lynagh's avatar
Ian Lynagh committed
57
import Data.IORef       ( readIORef )
Simon Marlow's avatar
Simon Marlow committed
58
import System.Directory
Ian Lynagh's avatar
Ian Lynagh committed
59
import System.FilePath
Simon Marlow's avatar
Simon Marlow committed
60 61
import System.IO
import Control.Monad
thoughtpolice's avatar
thoughtpolice committed
62
import Data.List        ( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
63 64
import Data.Maybe
import System.Environment
65
import Data.Char
66

67 68
-- ---------------------------------------------------------------------------
-- Pre-process
69

70
-- | Just preprocess a file, put the result in a temp. file (used by the
71
-- compilation manager during the summary phase).
72 73 74
--
-- We return the augmented DynFlags, because they contain the result
-- of slurping in the OPTIONS pragmas
75

76
preprocess :: HscEnv
77
           -> (FilePath, Maybe Phase) -- ^ filename and starting phase
78
           -> IO (DynFlags, FilePath)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
79
preprocess hsc_env (filename, mb_phase) =
Ian Lynagh's avatar
Ian Lynagh committed
80
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename)
81
  runPipeline anyHsc hsc_env (filename, fmap RealPhase mb_phase)
82
        Nothing Temporary Nothing{-no ModLocation-} Nothing{-no stub-}
83

84
-- ---------------------------------------------------------------------------
85

86 87
-- | Compile
--
88 89 90 91
-- Compile a single module, under the control of the compilation manager.
--
-- This is the interface between the compilation manager and the
-- compiler proper (hsc), where we deal with tedious details like
92 93 94
-- reading the OPTIONS pragma from the source file, converting the
-- C or assembly that GHC produces into an object file, and compiling
-- FFI stub files.
95
--
96 97
-- NB.  No old interface can also mean that the source has changed.

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
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
123 124 125 126
 = 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
127 128
       location    = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location)
129
       input_fnpp  = ms_hspp_file summary
130

131
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
132

Ian Lynagh's avatar
Ian Lynagh committed
133
   let basename = dropExtension input_fn
134

135 136 137
  -- 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.
138
   let current_dir = takeDirectory basename
139 140
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
141
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
142

143
   -- Figure out what lang we're generating
144
   let hsc_lang = hscTarget dflags
145
   -- ... and what the next phase should be
dterei's avatar
dterei committed
146
   let next_phase = hscPostBackendPhase dflags src_flavour hsc_lang
147
   -- ... and what file to generate the output into
148
   output_fn <- getOutputFilename next_phase
Ian Lynagh's avatar
Ian Lynagh committed
149
                        Temporary basename dflags next_phase (Just location)
150

151
   let extCore_filename = basename ++ ".hcr"
152

153
   -- -fforce-recomp should also work with --make
ian@well-typed.com's avatar
ian@well-typed.com committed
154
   let force_recomp = gopt Opt_ForceRecomp dflags
155 156 157
       source_modified
         | force_recomp || isNothing maybe_old_linkable = SourceModified
         | otherwise = source_modified0
158
       object_filename = ml_obj_file location
159

160 161 162 163 164 165 166
   let always_do_basic_recompilation_check = case hsc_lang of
                                             HscInterpreted -> True
                                             _ -> False

   e <- genericHscCompileGetFrontendResult
            always_do_basic_recompilation_check
            m_tc_result mHscMessage
167
            hsc_env summary source_modified mb_old_iface (mod_index, nmods)
168 169 170 171

   case e of
       Left iface ->
           do details <- genModDetails hsc_env iface
172
              MASSERT(isJust maybe_old_linkable)
173 174 175 176 177 178 179 180 181 182
              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 ->
183
                       do (iface, _changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
184 185 186
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })
187 188 189 190
                   _ -> 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
191 192 193 194

                           stub_o <- case hasStub of
                                     Nothing -> return []
                                     Just stub_c -> do
195
                                         stub_o <- compileStub hsc_env stub_c
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
                                         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 ->
213
                   do (iface, _changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
214 215 216 217 218 219 220 221 222 223
                      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 ->
224 225 226
                       do (iface, changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
                          hscWriteIface dflags iface changed summary
                          touchObjectFile dflags object_filename
227 228 229 230
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })

231 232 233 234
                   _ -> 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
235 236

                           -- We're in --make mode: finish the compilation pipeline.
237
                           let mod_name = ms_mod_name summary
238
                           _ <- runPipeline StopLn hsc_env
239 240
                                             (output_fn,
                                              Just (HscOut src_flavour mod_name (HscRecomp cgguts summary)))
241 242 243
                                             (Just basename)
                                             Persistent
                                             (Just location)
244
                                             Nothing
245 246 247 248 249 250 251
                                 -- 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 })
252

253
-----------------------------------------------------------------------------
254 255
-- stub .h and .c files (for foreign export support)

256 257 258
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
259 260 261
-- 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).
262

263 264 265 266
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
267

Ian Lynagh's avatar
Ian Lynagh committed
268
        return stub_o
269

270 271
-- ---------------------------------------------------------------------------
-- Link
272

Ian Lynagh's avatar
Ian Lynagh committed
273 274 275 276
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
277 278 279 280 281 282 283 284 285
     -> 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.

286
link LinkInMemory _ _ _
287 288 289 290
    = if cGhcWithInterpreter == "YES"
      then -- Not Linking...(demand linker will do the job)
           return Succeeded
      else panicBadLink LinkInMemory
291

292
link NoLink _ _ _
293 294
   = return Succeeded

295
link LinkBinary dflags batch_attempt_linking hpt
296 297
   = link' dflags batch_attempt_linking hpt

298 299 300
link LinkStaticLib dflags batch_attempt_linking hpt
   = link' dflags batch_attempt_linking hpt

301 302 303 304 305 306 307 308 309 310 311 312 313
link LinkDynLib dflags batch_attempt_linking hpt
   = link' dflags batch_attempt_linking hpt

panicBadLink :: GhcLink -> a
panicBadLink other = panic ("link: GHC not built to link this way: " ++
                            show other)

link' :: DynFlags                -- dynamic flags
      -> Bool                    -- attempt linking in batch mode?
      -> HomePackageTable        -- what to link
      -> IO SuccessFlag

link' dflags batch_attempt_linking hpt
314
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
315 316
   = do
        let
317 318 319 320
            staticLink = case ghcLink dflags of
                          LinkStaticLib -> True
                          _ -> platformBinariesAreStaticLibs (targetPlatform dflags)

Ian Lynagh's avatar
Ian Lynagh committed
321
            home_mod_infos = eltsUFM hpt
322

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

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

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

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

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

340
            exe_file = exeFileName staticLink dflags
341

342
        linking_needed <- linkingNeeded dflags staticLink linkables pkg_deps
343

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

Ian Lynagh's avatar
Ian Lynagh committed
349
        compilationProgressMsg dflags ("Linking " ++ exe_file ++ " ...")
350

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

359
        debugTraceMsg dflags 3 (text "link: done")
360

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

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

369

370 371
linkingNeeded :: DynFlags -> Bool -> [Linkable] -> [PackageId] -> IO Bool
linkingNeeded dflags staticLink linkables pkg_deps = do
372 373 374
        -- 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).
375
  let exe_file = exeFileName staticLink dflags
376
  e_exe_time <- tryIO $ getModificationUTCTime exe_file
377 378 379 380
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
381
        let extra_ld_inputs = [ f | FileOption _ f <- ldInputs dflags ]
382
        e_extra_times <- mapM (tryIO . getModificationUTCTime) extra_ld_inputs
383 384 385
        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
386
            then return True
387 388 389 390 391 392 393 394 395
            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 ]

396
        pkg_libfiles <- mapM (uncurry (findHSLib dflags)) pkg_hslibs
397
        if any isNothing pkg_libfiles then return True else do
398
        e_lib_times <- mapM (tryIO . getModificationUTCTime)
399 400 401 402
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
403 404 405 406 407 408
           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
409
 | not (platformSupportsSavingLinkOpts (platformOS (targetPlatform dflags)))
410 411 412 413 414 415 416 417 418 419 420 421 422 423
 -- 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)

424 425 426 427 428
platformSupportsSavingLinkOpts :: OS -> Bool
platformSupportsSavingLinkOpts os
  | os == OSSolaris2 = False -- see #5382
  | otherwise        = osElfTarget os

429 430 431
ghcLinkInfoSectionName :: String
ghcLinkInfoSectionName = ".debug-ghc-link-info"
   -- if we use the ".debug" prefix, then strip will strip it by default
432

433 434
findHSLib :: DynFlags -> [String] -> String -> IO (Maybe FilePath)
findHSLib dflags dirs lib = do
ian@well-typed.com's avatar
ian@well-typed.com committed
435
  let batch_lib_file = if gopt Opt_Static dflags
436 437
                       then "lib" ++ lib <.> "a"
                       else mkSOName (targetPlatform dflags) lib
438 439 440 441 442
  found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
  case found of
    [] -> return Nothing
    (x:_) -> return (Just x)

443 444 445
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

446
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
447 448
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
449
  doLink (hsc_dflags hsc_env) stop_phase o_files
450

451
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
452
compileFile hsc_env stop_phase (src, mb_phase) = do
453
   exists <- doesFileExist src
Ian Lynagh's avatar
Ian Lynagh committed
454
   when (not exists) $
455
        throwGhcExceptionIO (CmdLineError ("does not exist: " ++ src))
Ian Lynagh's avatar
Ian Lynagh committed
456

457
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
458
        dflags = hsc_dflags hsc_env
ian@well-typed.com's avatar
ian@well-typed.com committed
459
        split     = gopt Opt_SplitObjs dflags
Ian Lynagh's avatar
Ian Lynagh committed
460 461
        mb_o_file = outputFile dflags
        ghc_link  = ghcLink dflags      -- Set by -c or -no-link
462

Ian Lynagh's avatar
Ian Lynagh committed
463 464
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
465
        output
466 467 468 469
         -- 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
470 471
         | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
                -- -o foo applies to linker
472
         | isJust mb_o_file = SpecificFile
Ian Lynagh's avatar
Ian Lynagh committed
473 474 475 476 477
                -- -o foo applies to the file we are compiling now
         | otherwise = Persistent

        stop_phase' = case stop_phase of
                        As | split -> SplitAs
478
                        _          -> stop_phase
479

480
   ( _, out_file) <- runPipeline stop_phase' hsc_env
481
                            (src, fmap RealPhase mb_phase) Nothing output
482
                            Nothing{-no ModLocation-} Nothing
483 484 485 486 487 488
   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
489
  = return ()           -- We stopped before the linking phase
490 491 492

  | otherwise
  = case ghcLink dflags of
493 494 495 496 497
        NoLink        -> return ()
        LinkBinary    -> linkBinary         dflags o_files []
        LinkStaticLib -> linkStaticLibCheck dflags o_files []
        LinkDynLib    -> linkDynLibCheck    dflags o_files []
        other         -> panicBadLink other
498 499


500
-- ---------------------------------------------------------------------------
501

Ian Lynagh's avatar
Ian Lynagh committed
502
data PipelineOutput
503
  = Temporary
Ian Lynagh's avatar
Ian Lynagh committed
504 505
        -- ^ Output should be to a temporary file: we're going to
        -- run more compilation steps on this output later.
506
  | Persistent
Ian Lynagh's avatar
Ian Lynagh committed
507 508 509
        -- ^ We want a persistent file, i.e. a file in the current directory
        -- derived from the input filename, but with the appropriate extension.
        -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
510 511 512 513
  | SpecificFile
        -- ^ The output must go into the specific outputFile in DynFlags.
        -- We don't store the filename in the constructor as it changes
        -- when doing -dynamic-too.
ian@well-typed.com's avatar
ian@well-typed.com committed
514
    deriving Show
515

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

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

552 553 554 555 556 557
             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
558 559 560 561 562

             isHaskellishFile = isHaskell start_phase

             env = PipeEnv{ pe_isHaskellishFile = isHaskellishFile,
                            stop_phase,
563
                            src_filename = input_fn,
564 565 566 567 568 569 570 571 572 573 574
                            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.

575
         let happensBefore' = happensBefore dflags
576 577 578 579 580 581 582
         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 ()
583

ian@well-typed.com's avatar
ian@well-typed.com committed
584
         debugTraceMsg dflags 4 (text "Running the pipeline")
585
         r <- runPipeline' start_phase hsc_env env input_fn
586
                           maybe_loc maybe_stub_o
ian@well-typed.com's avatar
ian@well-typed.com committed
587 588 589 590

         -- 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
591
         let dflags = extractDynFlags hsc_env
ian@well-typed.com's avatar
ian@well-typed.com committed
592 593 594
         when isHaskellishFile $ whenCannotGenerateDynamicToo dflags $ do
             debugTraceMsg dflags 4
                 (text "Running the pipeline again for -dynamic-too")
595
             let dflags' = dynamicTooMkDynamicDynFlags dflags
596
             hsc_env' <- newHscEnv dflags'
597
             _ <- runPipeline' start_phase hsc_env' env input_fn
598
                               maybe_loc maybe_stub_o
599 600 601 602
             return ()
         return r

runPipeline'
603
  :: PhasePlus                  -- ^ When to start
604
  -> HscEnv                     -- ^ Compilation environment
605 606
  -> PipeEnv
  -> FilePath                   -- ^ Input filename
607 608
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
  -> Maybe FilePath             -- ^ stub object, if we have one
609
  -> IO (DynFlags, FilePath)    -- ^ (final flags, output filename)
610
runPipeline' start_phase hsc_env env input_fn
611
             maybe_loc maybe_stub_o
612
  = do
613
  -- Execute the pipeline...
614
  let state = PipeState{ hsc_env, maybe_loc, maybe_stub_o = maybe_stub_o }
615

616
  evalP (pipeLoop start_phase input_fn) env state
617

618 619 620 621 622
-- -----------------------------------------------------------------------------
-- The pipeline uses a monad to carry around various bits of information

-- PipeEnv: invariant information passed down
data PipeEnv = PipeEnv {
ian@well-typed.com's avatar
ian@well-typed.com committed
623
       pe_isHaskellishFile :: Bool,
624
       stop_phase   :: Phase,       -- ^ Stop just before this phase
625
       src_filename :: String,      -- ^ basename of original input source
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
       src_basename :: String,      -- ^ basename of original input source
       src_suffix   :: String,      -- ^ its extension
       output_spec  :: PipelineOutput -- ^ says where to put the pipeline output
  }

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

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

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

652 653
instance HasDynFlags CompPipeline where
    getDynFlags = P $ \_env state -> return (state, hsc_dflags (hsc_env state))
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668

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

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

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

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

669 670 671
evalP :: CompPipeline a -> PipeEnv -> PipeState -> IO a
evalP f env st = liftM snd $ unP f env st

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

677 678
instance MonadIO CompPipeline where
    liftIO m = P $ \_env state -> do a <- m; return (state, a)
679 680 681 682 683 684

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
685 686
  liftIO $ getOutputFilename stop_phase output_spec
                             src_basename dflags next_phase maybe_loc
687

688 689 690 691
-- ---------------------------------------------------------------------------
-- outer pipeline loop

-- | pipeLoop runs phases until we reach the stop phase
692
pipeLoop :: PhasePlus -> FilePath -> CompPipeline (DynFlags, FilePath)
693
pipeLoop phase input_fn = do
694
  env <- getPipeEnv
695 696
  dflags <- getDynFlags
  let happensBefore' = happensBefore dflags
697
      stopPhase = stop_phase env
698 699
  case phase of
   RealPhase realPhase | realPhase `eqPhase` stopPhase            -- All done
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
     -> -- 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)


720
     | not (realPhase `happensBefore'` stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
721 722 723 724
        -- 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 #-}.
725
     -> panic ("pipeLoop: at phase " ++ show realPhase ++
726
           " but I wanted to stop at phase " ++ show stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
727

728
   _
729
     -> do liftIO $ debugTraceMsg dflags 4
730
                                  (ptext (sLit "Running phase") <+> ppr phase)
731
           (next_phase, output_fn) <- runPhase phase input_fn dflags
732
           r <- pipeLoop next_phase output_fn
733
           case phase of
734 735
               HscOut {} ->
                   whenGeneratingDynamicToo dflags $ do
736
                       setDynFlags $ dynamicTooMkDynamicDynFlags dflags
737
                       -- TODO shouldn't ignore result:
738
                       _ <- pipeLoop phase input_fn
739 740 741 742
                       return ()
               _ ->
                   return ()
           return r
743 744 745 746 747

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

749
getOutputFilename
750 751
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
752
getOutputFilename stop_phase output basename dflags next_phase maybe_location
753 754 755 756 757 758 759
 | 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
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
    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
796

797 798 799 800 801 802
data PhasePlus = RealPhase Phase
               | HscOut HscSource ModuleName HscStatus

instance Outputable PhasePlus where
    ppr (RealPhase p) = ppr p
    ppr (HscOut {}) = text "HscOut"
803

804
-- -----------------------------------------------------------------------------
805
-- | Each phase in the pipeline returns the next phase to execute, and the
806 807 808 809 810 811
-- 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
812
-- taking the LLVM route to using the native code generator.
813
--
814
runPhase :: PhasePlus   -- ^ Run this phase
815 816
         -> FilePath    -- ^ name of the input file
         -> DynFlags    -- ^ for convenience, we pass the current dflags in
817
         -> CompPipeline (PhasePlus,           -- next phase to run
818
                          FilePath)            -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
819 820 821 822

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

824

825
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
826
-- Unlit phase
827

828
runPhase (RealPhase (Unlit sf)) input_fn dflags
829
  = do
830
       output_fn <- phaseOutputFilename (Cpp sf)
831

832
       let flags = [ -- The -h option passes the file name for unlit to
833 834
                     -- put in a #line directive
                     SysTools.Option     "-h"
835
                   , SysTools.Option $ escape $ normalise input_fn
836 837 838 839
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

840
       liftIO $ SysTools.runUnlit dflags flags
841

842
       return (RealPhase (Cpp sf), output_fn)
843 844 845 846 847 848 849 850 851 852 853 854 855
  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 []        = []
856 857

-------------------------------------------------------------------------------
858
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
859
--             (b) runs cpp if necessary
860

861
runPhase (RealPhase (Cpp sf)) input_fn dflags0
862
  = do
863
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
864
       (dflags1, unhandled_flags, warns)
865
           <- liftIO $ parseDynamicFilePragma dflags0 src_opts
866
       setDynFlags dflags1
867
       liftIO $ checkProcessArgsResult dflags1 unhandled_flags
868

869
       if not (xopt Opt_Cpp dflags1) then do
870
           -- we have to be careful to emit warnings only once.
871 872
           unless (gopt Opt_Pp dflags1) $
               liftIO $ handleFlagWarnings dflags1 warns
873

sof's avatar
sof committed
874
           -- no need to preprocess CPP, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
875
           -- to the next phase of the pipeline.
876
           return (RealPhase (HsPp sf), input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
877
        else do
878
            output_fn <- phaseOutputFilename (HsPp sf)
879
            liftIO $ doCpp dflags1 True{-raw-}
880
                           input_fn output_fn
881 882
            -- re-read the pragmas now that we've preprocessed the file
            -- See #2464,#3457
883
            src_opts <- liftIO $ getOptionsFromFile dflags0 output_fn
884
            (dflags2, unhandled_flags, warns)
885 886 887 888
                <- liftIO $ parseDynamicFilePragma dflags0 src_opts
            liftIO $ checkProcessArgsResult dflags2 unhandled_flags
            unless (gopt Opt_Pp dflags2) $
                liftIO $ handleFlagWarnings dflags2 warns