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

26 27 28 29
  ) where

#include "HsVersions.h"

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

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

68 69
-- ---------------------------------------------------------------------------
-- Pre-process
70

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

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

85
-- ---------------------------------------------------------------------------
86

87 88
-- | Compile
--
89 90 91 92
-- 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
93 94 95
-- 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.
96
--
97 98
-- NB.  No old interface can also mean that the source has changed.

99
compile :: HscEnv
100 101 102 103 104
        -> 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
105
        -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful
106

107 108
compile = compile' (hscCompileNothing, hscCompileInteractive, hscCompileBatch)

109 110 111 112
compile' :: 
           (Compiler (HscStatus, ModIface, ModDetails),
            Compiler (InteractiveStatus, ModIface, ModDetails),
            Compiler (HscStatus, ModIface, ModDetails))
113 114 115 116 117 118
        -> 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
119
        -> IO HomeModInfo   -- ^ the complete HomeModInfo, if successful
120 121 122

compile' (nothingCompiler, interactiveCompiler, batchCompiler)
        hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
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.
Ian Lynagh's avatar
Ian Lynagh committed
138 139 140
   let current_dir = case takeDirectory basename of
                     "" -> "." -- XXX Hack
                     d -> d
141 142
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
143
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
144

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

153
   let dflags' = dflags { hscTarget = hsc_lang,
Ian Lynagh's avatar
Ian Lynagh committed
154 155
                                hscOutName = output_fn,
                                extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
156
   let hsc_env' = hsc_env { hsc_dflags = dflags' }
157

158
   -- -fforce-recomp should also work with --make
159 160
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
161
       object_filename = ml_obj_file location
162

163
   let handleBatch HscNoRecomp
164
           = ASSERT (isJust maybe_old_linkable)
165 166
             return maybe_old_linkable

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

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

Thomas Schilling's avatar
Thomas Schilling committed
198
       handleInterpreted HscNoRecomp
199
           = ASSERT (isJust maybe_old_linkable)
200
             return maybe_old_linkable
201 202 203 204
       handleInterpreted (HscRecomp _hasStub Nothing)
           = ASSERT (isHsBoot src_flavour)
             return maybe_old_linkable
       handleInterpreted (HscRecomp hasStub (Just (comp_bc, modBreaks)))
205 206 207 208 209 210
           = do stub_o <- case hasStub of
                            Nothing -> return []
                            Just stub_c -> do
                              stub_o <- compileStub hsc_env' stub_c
                              return [DotO stub_o]

211
                let hs_unlinked = [BCOs comp_bc modBreaks]
212
                    unlinked_time = ms_hs_date summary
213 214 215 216 217 218 219
                  -- 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
220
                               (hs_unlinked ++ stub_o)
221
                return (Just linkable)
222

223
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
224
       --            -> m HomeModInfo
225
       runCompiler compiler handle
226 227 228 229 230 231 232
           = do (result, iface, details)
                    <- compiler hsc_env' summary source_unchanged mb_old_iface
                                (Just (mod_index, nmods))
                linkable <- handle result
                return (HomeModInfo{ hm_details  = details,
                                     hm_iface    = iface,
                                     hm_linkable = linkable })
233
   -- run the compiler
234
   case hsc_lang of
235 236 237
      HscInterpreted -> runCompiler interactiveCompiler handleInterpreted
      HscNothing     -> runCompiler nothingCompiler     handleBatch
      _other         -> runCompiler batchCompiler       handleBatch
238

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

242 243 244
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
245 246 247
-- 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).
248

249 250 251 252
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
253

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

256 257
-- ---------------------------------------------------------------------------
-- Link
258

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

#ifdef GHCI
273
link LinkInMemory _ _ _
274
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
275
         return Succeeded
276 277
#endif

278
link NoLink _ _ _
279 280
   = return Succeeded

281
link LinkBinary dflags batch_attempt_linking hpt
282 283 284 285 286
   = link' dflags batch_attempt_linking hpt

link LinkDynLib dflags batch_attempt_linking hpt
   = link' dflags batch_attempt_linking hpt

Simon Marlow's avatar
Simon Marlow committed
287
#ifndef GHCI
288 289
-- warning suppression
link other _ _ _ = panicBadLink other
Simon Marlow's avatar
Simon Marlow committed
290
#endif
291 292 293 294 295 296 297 298 299 300 301

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
302
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
303 304 305
   = do
        let
            home_mod_infos = eltsUFM hpt
306

Ian Lynagh's avatar
Ian Lynagh committed
307 308
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
309

Ian Lynagh's avatar
Ian Lynagh committed
310 311
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
312

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

Ian Lynagh's avatar
Ian Lynagh committed
315 316 317 318 319
        -- 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
320

Ian Lynagh's avatar
Ian Lynagh committed
321 322
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
323

Ian Lynagh's avatar
Ian Lynagh committed
324
            exe_file = exeFileName dflags
325

326
        linking_needed <- linkingNeeded dflags linkables pkg_deps
327

Ian Lynagh's avatar
Ian Lynagh committed
328
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
329
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
330 331
                   return Succeeded
           else do
332

333
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
334
                                 <+> text "...")
335

Ian Lynagh's avatar
Ian Lynagh committed
336 337 338 339
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
340
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
341
        link dflags obj_files pkg_deps
342

343
        debugTraceMsg dflags 3 (text "link: done")
344

Ian Lynagh's avatar
Ian Lynagh committed
345
        -- linkBinary only returns if it succeeds
346 347 348
        return Succeeded

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

353 354 355 356 357 358 359

linkingNeeded :: DynFlags -> [Linkable] -> [PackageId] -> IO Bool
linkingNeeded dflags linkables pkg_deps = do
        -- if the modification time on the executable is later than the
        -- modification times on all of the objects and libraries, then omit
        -- linking (unless the -fforce-recomp flag was given).
  let exe_file = exeFileName dflags
360
  e_exe_time <- tryIO $ getModificationTime exe_file
361 362 363 364 365
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
        extra_ld_inputs <- readIORef v_Ld_inputs
366
        e_extra_times <- mapM (tryIO . getModificationTime) extra_ld_inputs
367 368 369
        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
370
            then return True
371 372 373 374 375 376 377 378 379 380 381
            else do

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

        pkg_libfiles <- mapM (uncurry findHSLib) pkg_hslibs
        if any isNothing pkg_libfiles then return True else do
382
        e_lib_times <- mapM (tryIO . getModificationTime)
383 384 385 386
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
           else checkLinkInfo dflags pkg_deps exe_file

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

ghcLinkInfoSectionName :: String
ghcLinkInfoSectionName = ".debug-ghc-link-info"
   -- if we use the ".debug" prefix, then strip will strip it by default
411 412 413 414 415 416 417 418 419

findHSLib :: [String] -> String -> IO (Maybe FilePath)
findHSLib dirs lib = do
  let batch_lib_file = "lib" ++ lib <.> "a"
  found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
  case found of
    [] -> return Nothing
    (x:_) -> return (Just x)

420 421 422
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

423
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
424 425
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
426
  doLink (hsc_dflags hsc_env) stop_phase o_files
427

428
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
429
compileFile hsc_env stop_phase (src, mb_phase) = do
430
   exists <- doesFileExist src
Ian Lynagh's avatar
Ian Lynagh committed
431 432 433
   when (not exists) $
        ghcError (CmdLineError ("does not exist: " ++ src))

434
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
435
        dflags = hsc_dflags hsc_env
Ian Lynagh's avatar
Ian Lynagh committed
436 437 438
        split     = dopt Opt_SplitObjs dflags
        mb_o_file = outputFile dflags
        ghc_link  = ghcLink dflags      -- Set by -c or -no-link
439

Ian Lynagh's avatar
Ian Lynagh committed
440 441
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
442
        output
Ian Lynagh's avatar
Ian Lynagh committed
443 444 445 446 447 448 449 450
         | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
                -- -o foo applies to linker
         | Just o_file <- mb_o_file = SpecificFile o_file
                -- -o foo applies to the file we are compiling now
         | otherwise = Persistent

        stop_phase' = case stop_phase of
                        As | split -> SplitAs
451
                        _          -> stop_phase
452

453 454
   ( _, out_file) <- runPipeline stop_phase' hsc_env
                            (src, mb_phase) Nothing output
455
                            Nothing{-no ModLocation-} Nothing
456 457 458 459 460 461
   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
462
  = return ()           -- We stopped before the linking phase
463 464 465

  | otherwise
  = case ghcLink dflags of
Ian Lynagh's avatar
Ian Lynagh committed
466
        NoLink     -> return ()
467
        LinkBinary -> linkBinary dflags o_files []
Ian Lynagh's avatar
Ian Lynagh committed
468
        LinkDynLib -> linkDynLib dflags o_files []
469
        other      -> panicBadLink other
470 471


472
-- ---------------------------------------------------------------------------
473

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

485 486 487 488 489 490 491
-- | 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
492
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
493
-- pipeline.
494
runPipeline
495
  :: Phase                      -- ^ When to stop
496 497 498
  -> HscEnv                     -- ^ Compilation environment
  -> (FilePath,Maybe Phase)     -- ^ Input filename (and maybe -x suffix)
  -> Maybe FilePath             -- ^ original basename (if different from ^^^)
Ian Lynagh's avatar
Ian Lynagh committed
499
  -> PipelineOutput             -- ^ Output filename
500
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
501
  -> Maybe FilePath             -- ^ stub object, if we have one
502
  -> IO (DynFlags, FilePath)     -- ^ (final flags, output filename)
503

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

513 514
      -- Decide where dump files should go based on the pipeline output
      dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
515
      hsc_env = hsc_env0 {hsc_dflags = dflags}
516

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

520 521 522 523 524 525
  -- 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.
526

527
  when (not (start_phase `happensBefore` stop_phase)) $
Ian Lynagh's avatar
Ian Lynagh committed
528 529 530
        ghcError (UsageError
                    ("cannot compile this file to desired target: "
                       ++ input_fn))
531

532 533
  -- this is a function which will be used to calculate output file names
  -- as we go along (we partially apply it to some of its inputs here)
534
  let get_output_fn = getOutputFilename stop_phase output basename
535

536
  -- Execute the pipeline...
537 538 539 540 541 542 543 544 545 546 547
  let env   = PipeEnv{ stop_phase,
                       src_basename = basename,
                       src_suffix = suffix',
                       output_spec = output }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

630 631 632 633 634 635 636 637 638 639 640 641 642
-- ---------------------------------------------------------------------------
-- outer pipeline loop

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

     | not (phase `happensBefore` stop_phase)
Ian Lynagh's avatar
Ian Lynagh committed
643 644 645 646
        -- 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 #-}.
647
     -> panic ("pipeLoop: at phase " ++ show phase ++
Ian Lynagh's avatar
Ian Lynagh committed
648 649
           " but I wanted to stop at phase " ++ show stop_phase)

650 651
     | otherwise
     -> do io $ debugTraceMsg (hsc_dflags hsc_env) 4
652
                         (ptext (sLit "Running phase") <+> ppr phase)
653 654 655 656 657 658 659 660
           dflags <- getDynFlags
           (next_phase, output_fn) <- runPhase phase input_fn dflags
           pipeLoop next_phase output_fn

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

662
getOutputFilename
663 664 665
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
666 667
 = func
 where
Ian Lynagh's avatar
Ian Lynagh committed
668 669 670 671 672 673 674 675 676 677 678
        func dflags next_phase maybe_location
           | is_last_phase, Persistent <- output     = persistent_fn
           | is_last_phase, SpecificFile f <- output = return f
           | keep_this_output                        = persistent_fn
           | otherwise                               = newTempName dflags suffix
           where
                hcsuf      = hcSuf dflags
                odir       = objectDir dflags
                osuf       = objectSuf dflags
                keep_hc    = dopt Opt_KeepHcFiles dflags
                keep_s     = dopt Opt_KeepSFiles dflags
679
                keep_bc    = dopt Opt_KeepLlvmFiles dflags
Ian Lynagh's avatar
Ian Lynagh committed
680

681 682 683 684
                myPhaseInputExt HCc       = hcsuf
                myPhaseInputExt MergeStub = osuf
                myPhaseInputExt StopLn    = osuf
                myPhaseInputExt other     = phaseInputExt other
Ian Lynagh's avatar
Ian Lynagh committed
685 686 687 688 689 690

                is_last_phase = next_phase `eqPhase` stop_phase

                -- sometimes, we keep output from intermediate stages
                keep_this_output =
                     case next_phase of
691
                             As      | keep_s     -> True
692
                             LlvmOpt | keep_bc    -> True
693 694
                             HCc     | keep_hc    -> True
                             _other               -> False
Ian Lynagh's avatar
Ian Lynagh committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708

                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
709

710

711
-- -----------------------------------------------------------------------------
712
-- | Each phase in the pipeline returns the next phase to execute, and the
713 714 715 716 717 718 719
-- name of the file in which the output was placed.
--
-- We must do things dynamically this way, because we often don't know
-- what the rest of the phases will be until part-way through the
-- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
-- of a source file can change the latter stages of the pipeline from
-- taking the via-C route to using the native code generator.
720
--
721 722 723 724 725
runPhase :: Phase       -- ^ Run this phase
         -> FilePath    -- ^ name of the input file
         -> DynFlags    -- ^ for convenience, we pass the current dflags in
         -> CompPipeline (Phase,               -- next phase to run
                          FilePath)            -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
726 727 728 729

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

731

732
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
733
-- Unlit phase
734

735
runPhase (Unlit sf) input_fn dflags
736
  = do
737
       output_fn <- phaseOutputFilename (Cpp sf)
738

739 740 741 742 743 744 745 746 747 748 749 750
       let unlit_flags = getOpts dflags opt_L
           flags = map SysTools.Option unlit_flags ++
                   [ -- The -h option passes the file name for unlit to
                     -- put in a #line directive
                     SysTools.Option     "-h"
                     -- cpp interprets \b etc as escape sequences,
                     -- so we use / for filenames in pragmas
                   , SysTools.Option $ reslash Forwards $ normalise input_fn
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

751
       io $ SysTools.runUnlit dflags flags
752

753
       return (Cpp sf, output_fn)
754 755

-------------------------------------------------------------------------------
756
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
757
--             (b) runs cpp if necessary
758

759 760 761
runPhase (Cpp sf) input_fn dflags0
  = do
       src_opts <- io $ getOptionsFromFile dflags0 input_fn
762
       (dflags1, unhandled_flags, warns)
763 764 765
           <- io $ parseDynamicNoPackageFlags dflags0 src_opts
       setDynFlags dflags1
       io $ checkProcessArgsResult unhandled_flags
766

767
       if not (xopt Opt_Cpp dflags1) then do
768
           -- we have to be careful to emit warnings only once.
769
           unless (dopt Opt_Pp dflags1) $ io $ handleFlagWarnings dflags1 warns
770

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

            setDynFlags dflags2
787

788
            return (HsPp sf, output_fn)
789

sof's avatar
sof committed
790
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
791
-- HsPp phase
sof's avatar
sof committed
792

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

            -- re-read pragmas now that we've parsed the file (see #3674)
813
            src_opts <- io $ getOptionsFromFile dflags output_fn
814
            (dflags1, unhandled_flags, warns)
815 816 817
                <- io $ parseDynamicNoPackageFlags dflags src_opts
            setDynFlags dflags1
            io $ checkProcessArgsResult unhandled_flags
dterei's avatar
dterei committed
818
            io $ handleFlagWarnings dflags1 warns
819

820
            return (Hsc sf, output_fn)
821

822 823 824
-----------------------------------------------------------------------------
-- Hsc phase

825 826
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
827
runPhase (Hsc src_flavour) input_fn dflags0
Ian Lynagh's avatar
Ian Lynagh committed
828
 = do   -- normal Hsc mode, not mkdependHS
829 830 831 832

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

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

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

844 845
        setDynFlags dflags

846
  -- gather the imports and module name
847
        (hspp_buf,mod_name,imps,src_imps) <- io $
848
            case src_flavour of
849
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
850
                    m <- getCoreModuleName input_fn
851
                    return (Nothing, mkModuleName m, [], [])
852

853
                _           -> do
854
                    buf <- hGetStringBuffer input_fn