DriverPipeline.hs 94.8 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
143
       needsQQ     = any (xopt Opt_QuasiQuotes     . ms_hspp_opts) mod_graph
       needsLinker = needsTH || needsQQ
144
       isDynWay    = any (== WayDyn) (ways dflags0)
Austin Seipp's avatar
Austin Seipp committed
145
       isProfWay   = any (== WayProf) (ways dflags0)
Austin Seipp's avatar
Austin Seipp committed
146
147
   -- #8180 - when using TemplateHaskell, switch on -dynamic-too so
   -- the linker can correctly load the object files.
148
   let dflags1 = if needsLinker && dynamicGhc && not isDynWay && not isProfWay
Austin Seipp's avatar
Austin Seipp committed
149
150
151
152
                  then gopt_set dflags0 Opt_BuildDynamicToo
                  else dflags0

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

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

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

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

172
   let extCore_filename = basename ++ ".hcr"
173

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

181
182
183
184
185
186
187
   let always_do_basic_recompilation_check = case hsc_lang of
                                             HscInterpreted -> True
                                             _ -> False

   e <- genericHscCompileGetFrontendResult
            always_do_basic_recompilation_check
            m_tc_result mHscMessage
188
            hsc_env summary source_modified mb_old_iface (mod_index, nmods)
189
190
191
192

   case e of
       Left iface ->
           do details <- genModDetails hsc_env iface
193
              MASSERT(isJust maybe_old_linkable)
194
195
196
197
198
199
200
201
202
203
              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 ->
204
                       do (iface, _changed, details) <- hscSimpleIface hsc_env tc_result mb_old_hash
205
206
207
                          return (HomeModInfo{ hm_details  = details,
                                               hm_iface    = iface,
                                               hm_linkable = maybe_old_linkable })
208
209
210
211
                   _ -> 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
212
213
214
215

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

252
253
254
255
                   _ -> 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
256
257

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

274
-----------------------------------------------------------------------------
275
276
-- stub .h and .c files (for foreign export support)

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

284
285
286
287
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
288

Ian Lynagh's avatar
Ian Lynagh committed
289
        return stub_o
290

291
292
-- ---------------------------------------------------------------------------
-- Link
293

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

307
308
309
310
311
312
313
314
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
315

316
317
    l NoLink _ _ _
      = return Succeeded
318

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

322
323
    l LinkStaticLib dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
324

325
326
    l LinkDynLib dflags batch_attempt_linking hpt
      = link' dflags batch_attempt_linking hpt
327
328
329
330
331
332
333
334
335
336
337

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

Ian Lynagh's avatar
Ian Lynagh committed
345
            home_mod_infos = eltsUFM hpt
346

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

Ian Lynagh's avatar
Ian Lynagh committed
350
351
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
352

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

Ian Lynagh's avatar
Ian Lynagh committed
355
356
357
358
359
        -- 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
360

Ian Lynagh's avatar
Ian Lynagh committed
361
362
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
363

364
            exe_file = exeFileName staticLink dflags
365

366
        linking_needed <- linkingNeeded dflags staticLink linkables pkg_deps
367

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

Ian Lynagh's avatar
Ian Lynagh committed
373
        compilationProgressMsg dflags ("Linking " ++ exe_file ++ " ...")
374

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

383
        debugTraceMsg dflags 3 (text "link: done")
384

Ian Lynagh's avatar
Ian Lynagh committed
385
        -- linkBinary only returns if it succeeds
386
387
388
        return Succeeded

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

393

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

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

448
449
450
451
452
platformSupportsSavingLinkOpts :: OS -> Bool
platformSupportsSavingLinkOpts os
  | os == OSSolaris2 = False -- see #5382
  | otherwise        = osElfTarget os

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

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

467
468
469
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

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

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

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

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

        stop_phase' = case stop_phase of
Simon Marlow's avatar
Simon Marlow committed
501
502
                        As _ | split -> SplitAs
                        _            -> stop_phase
503

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

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


524
-- ---------------------------------------------------------------------------
525

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

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

562
563
564
565
566
567
             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
568
569
570
571
572

             isHaskellishFile = isHaskell start_phase

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

585
         let happensBefore' = happensBefore dflags
586
587
588
589
590
591
592
         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 ()
593

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

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

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

628
  evalP (pipeLoop start_phase input_fn) env state
629

630
631
632
633
-- ---------------------------------------------------------------------------
-- outer pipeline loop

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


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

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

686
687
688
689
690
runHookedPhase :: PhasePlus -> FilePath -> DynFlags
               -> CompPipeline (PhasePlus, FilePath)
runHookedPhase pp input dflags =
  lookupHook runPhaseHook runPhase dflags pp input dflags

691
692
693
694
-- -----------------------------------------------------------------------------
-- 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.
695

696
697
698
699
700
701
702
703
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

704
getOutputFilename
705
706
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
707
getOutputFilename stop_phase output basename dflags next_phase maybe_location
708
709
710
711
712
713
714
 | 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
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
    where
          hcsuf      = hcSuf dflags
          odir       = objectDir dflags
          osuf       = objectSuf dflags
          keep_hc    = gopt Opt_KeepHcFiles dflags
          keep_s     = gopt Opt_KeepSFiles dflags
          keep_bc    = gopt Opt_KeepLlvmFiles dflags

          myPhaseInputExt HCc       = hcsuf
          myPhaseInputExt MergeStub = osuf
          myPhaseInputExt StopLn    = osuf
          myPhaseInputExt other     = phaseInputExt other

          is_last_phase = next_phase `eqPhase` stop_phase

          -- sometimes, we keep output from intermediate stages
          keep_this_output =
               case next_phase of
Simon Marlow's avatar
Simon Marlow committed
733
                       As _    | keep_s     -> True
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
                       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
751

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

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

772

773
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
774
-- Unlit phase
775

776
runPhase (RealPhase (Unlit sf)) input_fn dflags
777
  = do
778
       output_fn <- phaseOutputFilename (Cpp sf)
779

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

788
       liftIO $ SysTools.runUnlit dflags flags
789

790
       return (RealPhase (Cpp sf), output_fn)
791
792
793
794
795
796
797
798
799
800
801
802
803
  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 []        = []
804
805

-------------------------------------------------------------------------------
806
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
807
--             (b) runs cpp if necessary
808

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

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

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

            setDynFlags dflags2
840

841
            return (RealPhase (HsPp sf), output_fn)
842

sof's avatar
sof committed
843
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
844
-- HsPp phase
sof's avatar
sof committed
845

846
runPhase (RealPhase (HsPp sf)) input_fn dflags
847
  = do
ian@well-typed.com's avatar
ian@well-typed.com committed
848
       if not (gopt Opt_Pp dflags) then
sof's avatar
sof committed
849
           -- no need to preprocess, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
850
           -- to the next phase of the pipeline.
851
          return (RealPhase (Hsc sf), input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
852
        else do
853
854
855
            PipeEnv{src_basename, src_suffix} <- getPipeEnv
            let orig_fn = src_basename <.> src_suffix
            output_fn <- phaseOutputFilename (Hsc sf)
856
            liftIO $ SysTools.runPp dflags
Ian Lynagh's avatar
Ian Lynagh committed
857
858
859
                           ( [ SysTools.Option     orig_fn
                             , SysTools.Option     input_fn
                             , SysTools.FileOption "" output_fn
860
                             ]
Ian Lynagh's avatar
Ian Lynagh committed
861
                           )
862
863

            -- re-read pragmas now that we've parsed the file (see #3674)
864
            src_opts <- liftIO $ getOptionsFromFile dflags output_fn
865
            (dflags1, unhandled_flags, warns)
866
                <- liftIO $ parseDynamicFilePragma dflags src_opts
867
            setDynFlags dflags1
868
869
            liftIO $ checkProcessArgsResult dflags1 unhandled_flags
            liftIO $ handleFlagWarnings dflags1 warns
870

871
            return (RealPhase (Hsc sf), output_fn)
872

873
874
875
-----------------------------------------------------------------------------
-- Hsc phase

876
877
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
878
runPhase (RealPhase (Hsc src_flavour)) input_fn dflags0
Ian Lynagh's avatar
Ian Lynagh committed
879
 = do   -- normal Hsc mode, not mkdependHS
880
881
882
883

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

885
  -- we add the current directory (i.e. the directory in which
886
  -- the .hs files resides) to the include path, since this is
887
  -- what gcc does, and it's probably what you want.
888
        let current_dir = takeDirectory basename
Ian Lynagh's avatar
Ian Lynagh committed
889
890
891
            paths = includePaths dflags0
            dflags = dflags0 { includePaths = current_dir : paths }

892
893
        setDynFlags dflags

894
  -- gather the imports and module name
895
        (hspp_buf,mod_name,imps,src_imps) <- liftIO $
896
            case src_flavour of
897
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
898
                    m <- getCoreModuleName input_fn
899
                    return (Nothing, mkModuleName m, [], [])
900

901
                _           -> do
902
                    buf <- hGetStringBuffer input_fn
903
904
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
905
906
907
908
909
910

  -- Take -o into account if present
  -- Very like -ohi, but we must *only* do this if we aren't linking
  -- (If we're linking then the -o applies to the linked thing, not to
  -- the object file for one module.)
  -- Note the nasty duplication with the same computation in compileFile above
911
        location <- getLocation src_flavour mod_name
912

913
        let o_file = ml_obj_file location -- The real object file
914
915

  -- Figure out if the source has changed, for recompilation avoidance.
916
  --
917
  -- Setting source_unchanged to True means that M.o seems