DriverPipeline.hs 91.2 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
Ian Lynagh's avatar
Ian Lynagh 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
172
173
174
175
176
177
178
179
180
181
182

   case e of
       Left iface ->
           do details <- genModDetails hsc_env iface
              MASSERT (isJust maybe_old_linkable)
              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
298
299
300
301
302
303
304
305
306
307
308
309
310
   = link' dflags batch_attempt_linking hpt

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
311
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
312
313
314
   = do
        let
            home_mod_infos = eltsUFM hpt
315

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

Ian Lynagh's avatar
Ian Lynagh committed
319
320
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
321

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

Ian Lynagh's avatar
Ian Lynagh committed
324
325
326
327
328
        -- 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
329

Ian Lynagh's avatar
Ian Lynagh committed
330
331
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
332

Ian Lynagh's avatar
Ian Lynagh committed
333
            exe_file = exeFileName dflags
334

335
        linking_needed <- linkingNeeded dflags linkables pkg_deps
336

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

Ian Lynagh's avatar
Ian Lynagh committed
342
        compilationProgressMsg dflags ("Linking " ++ exe_file ++ " ...")
343

Ian Lynagh's avatar
Ian Lynagh committed
344
345
346
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
347
                LinkDynLib  -> linkDynLibCheck
348
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
349
        link dflags obj_files pkg_deps
350

351
        debugTraceMsg dflags 3 (text "link: done")
352

Ian Lynagh's avatar
Ian Lynagh committed
353
        -- linkBinary only returns if it succeeds
354
355
356
        return Succeeded

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

361
362
363
364
365
366
367

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
368
  e_exe_time <- tryIO $ getModificationUTCTime exe_file
369
370
371
372
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
373
        let extra_ld_inputs = ldInputs dflags
374
        e_extra_times <- mapM (tryIO . getModificationUTCTime) extra_ld_inputs
375
376
377
        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
378
            then return True
379
380
381
382
383
384
385
386
387
            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 ]

388
        pkg_libfiles <- mapM (uncurry (findHSLib dflags)) pkg_hslibs
389
        if any isNothing pkg_libfiles then return True else do
390
        e_lib_times <- mapM (tryIO . getModificationUTCTime)
391
392
393
394
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
395
396
397
398
399
400
           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
401
 | not (platformSupportsSavingLinkOpts (platformOS (targetPlatform dflags)))
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 -- 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)

416
417
418
419
420
platformSupportsSavingLinkOpts :: OS -> Bool
platformSupportsSavingLinkOpts os
  | os == OSSolaris2 = False -- see #5382
  | otherwise        = osElfTarget os

421
422
423
ghcLinkInfoSectionName :: String
ghcLinkInfoSectionName = ".debug-ghc-link-info"
   -- if we use the ".debug" prefix, then strip will strip it by default
424

425
426
findHSLib :: DynFlags -> [String] -> String -> IO (Maybe FilePath)
findHSLib dflags dirs lib = do
ian@well-typed.com's avatar
ian@well-typed.com committed
427
  let batch_lib_file = if gopt Opt_Static dflags
428
429
                       then "lib" ++ lib <.> "a"
                       else mkSOName (targetPlatform dflags) lib
430
431
432
433
434
  found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
  case found of
    [] -> return Nothing
    (x:_) -> return (Just x)

435
436
437
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

438
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
439
440
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
441
  doLink (hsc_dflags hsc_env) stop_phase o_files
442

443
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
444
compileFile hsc_env stop_phase (src, mb_phase) = do
445
   exists <- doesFileExist src
Ian Lynagh's avatar
Ian Lynagh committed
446
   when (not exists) $
447
        throwGhcExceptionIO (CmdLineError ("does not exist: " ++ src))
Ian Lynagh's avatar
Ian Lynagh committed
448

449
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
450
        dflags = hsc_dflags hsc_env
ian@well-typed.com's avatar
ian@well-typed.com committed
451
        split     = gopt Opt_SplitObjs dflags
Ian Lynagh's avatar
Ian Lynagh committed
452
453
        mb_o_file = outputFile dflags
        ghc_link  = ghcLink dflags      -- Set by -c or -no-link
454

Ian Lynagh's avatar
Ian Lynagh committed
455
456
        -- When linking, the -o argument refers to the linker's output.
        -- otherwise, we use it as the name for the pipeline's output.
457
        output
458
459
460
461
         -- 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
462
463
         | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
                -- -o foo applies to linker
464
         | isJust mb_o_file = SpecificFile
Ian Lynagh's avatar
Ian Lynagh committed
465
466
467
468
469
                -- -o foo applies to the file we are compiling now
         | otherwise = Persistent

        stop_phase' = case stop_phase of
                        As | split -> SplitAs
470
                        _          -> stop_phase
471

472
   ( _, out_file) <- runPipeline stop_phase' hsc_env
473
                            (src, fmap RealPhase mb_phase) Nothing output
474
                            Nothing{-no ModLocation-} Nothing
475
476
477
478
479
480
   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
481
  = return ()           -- We stopped before the linking phase
482
483
484

  | otherwise
  = case ghcLink dflags of
Ian Lynagh's avatar
Ian Lynagh committed
485
        NoLink     -> return ()
486
487
        LinkBinary -> linkBinary      dflags o_files []
        LinkDynLib -> linkDynLibCheck dflags o_files []
488
        other      -> panicBadLink other
489
490


491
-- ---------------------------------------------------------------------------
492

Ian Lynagh's avatar
Ian Lynagh committed
493
data PipelineOutput
494
  = Temporary
Ian Lynagh's avatar
Ian Lynagh committed
495
496
        -- ^ Output should be to a temporary file: we're going to
        -- run more compilation steps on this output later.
497
  | Persistent
Ian Lynagh's avatar
Ian Lynagh committed
498
499
500
        -- ^ 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.
501
502
503
504
  | 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
505
    deriving Show
506

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

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

543
544
545
546
547
548
             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
549
550
551
552
553

             isHaskellishFile = isHaskell start_phase

             env = PipeEnv{ pe_isHaskellishFile = isHaskellishFile,
                            stop_phase,
554
                            src_filename = input_fn,
555
556
557
558
559
560
561
562
563
564
565
                            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.

566
         let happensBefore' = happensBefore dflags
567
568
569
570
571
572
573
         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 ()
574

ian@well-typed.com's avatar
ian@well-typed.com committed
575
         debugTraceMsg dflags 4 (text "Running the pipeline")
576
         r <- runPipeline' start_phase hsc_env env input_fn
577
                           maybe_loc maybe_stub_o
ian@well-typed.com's avatar
ian@well-typed.com committed
578
579
580
581

         -- 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
582
         let dflags = extractDynFlags hsc_env
ian@well-typed.com's avatar
ian@well-typed.com committed
583
584
585
         when isHaskellishFile $ whenCannotGenerateDynamicToo dflags $ do
             debugTraceMsg dflags 4
                 (text "Running the pipeline again for -dynamic-too")
586
             let dflags' = doDynamicToo dflags
587
             hsc_env' <- newHscEnv dflags'
588
             _ <- runPipeline' start_phase hsc_env' env input_fn
589
                               maybe_loc maybe_stub_o
590
591
592
593
             return ()
         return r

runPipeline'
594
  :: PhasePlus                  -- ^ When to start
595
  -> HscEnv                     -- ^ Compilation environment
596
597
  -> PipeEnv
  -> FilePath                   -- ^ Input filename
598
599
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
  -> Maybe FilePath             -- ^ stub object, if we have one
600
  -> IO (DynFlags, FilePath)    -- ^ (final flags, output filename)
601
runPipeline' start_phase hsc_env env input_fn
602
             maybe_loc maybe_stub_o
603
  = do
604
  -- Execute the pipeline...
605
  let state = PipeState{ hsc_env, maybe_loc, maybe_stub_o = maybe_stub_o }
606

607
  evalP (pipeLoop start_phase input_fn) env state
608

609
610
611
612
613
-- -----------------------------------------------------------------------------
-- 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
614
       pe_isHaskellishFile :: Bool,
615
       stop_phase   :: Phase,       -- ^ Stop just before this phase
616
       src_filename :: String,      -- ^ basename of original input source
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
       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)

643
644
instance HasDynFlags CompPipeline where
    getDynFlags = P $ \_env state -> return (state, hsc_dflags (hsc_env state))
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659

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) }

660
661
662
evalP :: CompPipeline a -> PipeEnv -> PipeState -> IO a
evalP f env st = liftM snd $ unP f env st

663
664
665
666
667
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'

668
669
instance MonadIO CompPipeline where
    liftIO m = P $ \_env state -> do a <- m; return (state, a)
670
671
672
673
674
675

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
676
677
  liftIO $ getOutputFilename stop_phase output_spec
                             src_basename dflags next_phase maybe_loc
678

679
680
681
682
-- ---------------------------------------------------------------------------
-- outer pipeline loop

-- | pipeLoop runs phases until we reach the stop phase
683
pipeLoop :: PhasePlus -> FilePath -> CompPipeline (DynFlags, FilePath)
684
pipeLoop phase input_fn = do
685
  env <- getPipeEnv
686
687
  dflags <- getDynFlags
  let happensBefore' = happensBefore dflags
688
      stopPhase = stop_phase env
689
690
  case phase of
   RealPhase realPhase | realPhase `eqPhase` stopPhase            -- All done
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
     -> -- 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)


711
     | not (realPhase `happensBefore'` stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
712
713
714
715
        -- 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 #-}.
716
     -> panic ("pipeLoop: at phase " ++ show realPhase ++
717
           " but I wanted to stop at phase " ++ show stopPhase)
Ian Lynagh's avatar
Ian Lynagh committed
718

719
   _
720
     -> do liftIO $ debugTraceMsg dflags 4
721
                                  (ptext (sLit "Running phase") <+> ppr phase)
722
           (next_phase, output_fn) <- runPhase phase input_fn dflags
723
           r <- pipeLoop next_phase output_fn
724
           case phase of
725
726
727
728
               HscOut {} ->
                   whenGeneratingDynamicToo dflags $ do
                       setDynFlags $ doDynamicToo dflags
                       -- TODO shouldn't ignore result:
729
                       _ <- pipeLoop phase input_fn
730
731
732
733
                       return ()
               _ ->
                   return ()
           return r
734
735
736
737
738

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

740
getOutputFilename
741
742
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
743
getOutputFilename stop_phase output basename dflags next_phase maybe_location
744
745
746
747
748
749
750
 | 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
751
752
753
754
755
756
757
758
759
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
    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
787

788
789
790
791
792
793
data PhasePlus = RealPhase Phase
               | HscOut HscSource ModuleName HscStatus

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

795
-- -----------------------------------------------------------------------------
796
-- | Each phase in the pipeline returns the next phase to execute, and the
797
798
799
800
801
802
803
-- 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.
804
--
805
runPhase :: PhasePlus   -- ^ Run this phase
806
807
         -> FilePath    -- ^ name of the input file
         -> DynFlags    -- ^ for convenience, we pass the current dflags in
808
         -> CompPipeline (PhasePlus,           -- next phase to run
809
                          FilePath)            -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
810
811
812
813

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

815

816
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
817
-- Unlit phase
818

819
runPhase (RealPhase (Unlit sf)) input_fn dflags
820
  = do
821
       output_fn <- phaseOutputFilename (Cpp sf)
822

823
824
825
826
827
       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"
828
                   , SysTools.Option $ escape $ normalise input_fn
829
830
831
832
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

833
       liftIO $ SysTools.runUnlit dflags flags
834

835
       return (RealPhase (Cpp sf), output_fn)
836
837
838
839
840
841
842
843
844
845
846
847
848
  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 []        = []
849
850

-------------------------------------------------------------------------------
851
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
852
--             (b) runs cpp if necessary
853

854
runPhase (RealPhase (Cpp sf)) input_fn dflags0
855
  = do
856
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
857
       (dflags1, unhandled_flags, warns)
858
           <- liftIO $ parseDynamicFilePragma dflags0 src_opts
859
       setDynFlags dflags1
860
       liftIO $ checkProcessArgsResult dflags1 unhandled_flags
861

862
       if not (xopt Opt_Cpp dflags1) then do
863
           -- we have to be careful to emit warnings only once.
864
865
           unless (gopt Opt_Pp dflags1) $
               liftIO $ handleFlagWarnings dflags1 warns
866

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

            setDynFlags dflags2
885

886
            return (RealPhase (HsPp sf), output_fn)
887

sof's avatar
sof committed
888
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
889
-- HsPp phase
sof's avatar
sof committed
890

891
runPhase (RealPhase (HsPp sf)) input_fn dflags
892
  = do
ian@well-typed.com's avatar
ian@well-typed.com committed
893
       if not (gopt Opt_Pp dflags) then
sof's avatar
sof committed
894
           -- no need to preprocess, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
895
           -- to the next phase of the pipeline.
896
          return (RealPhase (Hsc sf), input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
897
898
        else do
            let hspp_opts = getOpts dflags opt_F
899
900
901
            PipeEnv{src_basename, src_suffix} <- getPipeEnv
            let orig_fn = src_basename <.> src_suffix
            output_fn <- phaseOutputFilename (Hsc sf)
902
            liftIO $ SysTools.runPp dflags
Ian Lynagh's avatar
Ian Lynagh committed
903
904
905
906
907
908
                           ( [ SysTools.Option     orig_fn
                             , SysTools.Option     input_fn
                             , SysTools.FileOption "" output_fn
                             ] ++
                             map SysTools.Option hspp_opts
                           )
909
910

            -- re-read pragmas now that we've parsed the file (see #3674)
911
            src_opts <- liftIO $ getOptionsFromFile dflags output_fn
912
            (dflags1, unhandled_flags, warns)
913
                <- liftIO $ parseDynamicFilePragma dflags src_opts
914
            setDynFlags dflags1
915
916
            liftIO $ checkProcessArgsResult dflags1 unhandled_flags
            liftIO $ handleFlagWarnings dflags1 warns
917

918
            return (RealPhase (Hsc sf), output_fn)
919

920
921
922
-----------------------------------------------------------------------------
-- Hsc phase

923
924
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
925
runPhase (RealPhase (Hsc src_flavour)) input_fn dflags0
Ian Lynagh's avatar
Ian Lynagh committed
926
 = do   -- normal Hsc mode, not mkdependHS
927
928
929
930

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

932
  -- we add the current directory (i.e. the directory in which
933
  -- the .hs files resides) to the include path, since this is
934
  -- what gcc does, and it's probably what you want.
935
        let current_dir = takeDirectory basename
Ian Lynagh's avatar
Ian Lynagh committed
936
937
938
            paths = includePaths dflags0
            dflags = dflags0 { includePaths = current_dir : paths }

939
940
        setDynFlags dflags

941
  -- gather the imports and module name
942
        (hspp_buf,mod_name,imps,src_imps) <- liftIO $
943
            case src_flavour of
944
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
945
                    m <- getCoreModuleName input_fn
946
                    return (Nothing, mkModuleName m, [], [])
947

948
                _           -> do
949
                    buf <- hGetStringBuffer input_fn
950
951
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
952
953
954
955
956
957

  -- 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
958
        location <- getLocation src_flavour mod_name
959