DriverPipeline.hs 89.5 KB
Newer Older
1
{-# OPTIONS -fno-cse #-}
2
{-# LANGUAGE NamedFieldPuns #-}
3
4
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

5
6
7
8
-----------------------------------------------------------------------------
--
-- GHC Driver
--
9
-- (c) The University of Glasgow 2005
10
11
12
13
--
-----------------------------------------------------------------------------

module DriverPipeline (
Ian Lynagh's avatar
Ian Lynagh committed
14
15
        -- Run a series of compilation steps in a pipeline, for a
        -- collection of source files.
16
   oneShot, compileFile,
17

Ian Lynagh's avatar
Ian Lynagh committed
18
        -- Interfaces for the batch-mode driver
19
   linkBinary,
20

Ian Lynagh's avatar
Ian Lynagh committed
21
22
        -- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess,
23
   compile, compile',
Ian Lynagh's avatar
Ian Lynagh committed
24
   link,
25

26
27
28
29
  ) where

#include "HsVersions.h"

30
import Packages
31
import HeaderInfo
32
import DriverPhases
33
import SysTools
34
import HscMain
35
import Finder
36
37
38
import HscTypes
import Outputable
import Module
Ian Lynagh's avatar
Ian Lynagh committed
39
import UniqFM           ( eltsUFM )
40
import ErrUtils
41
import DynFlags
42
import 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

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

66
67
-- ---------------------------------------------------------------------------
-- Pre-process
68

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

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

83
-- ---------------------------------------------------------------------------
84

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

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

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

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

compile' (nothingCompiler, interactiveCompiler, batchCompiler)
        hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
123
        source_modified0
124
125
126
127
 = 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
128
129
       location    = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location)
130
       input_fnpp  = ms_hspp_file summary
131

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

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

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

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

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

157
   -- -fforce-recomp should also work with --make
158
   let force_recomp = dopt Opt_ForceRecomp dflags
159
160
161
       source_modified
         | force_recomp || isNothing maybe_old_linkable = SourceModified
         | otherwise = source_modified0
162
       object_filename = ml_obj_file location
163

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

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

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

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

211
                let hs_unlinked = [BCOs comp_bc modBreaks]
212
                    unlinked_time = ms_hs_date summary
213
214
215
216
217
218
219
                  -- Why do we use the timestamp of the source file here,
                  -- rather than the current time?  This works better in
                  -- the case where the local clock is out of sync
                  -- with the filesystem's clock.  It's just as accurate:
                  -- if the source is modified, then the linkable will
                  -- be out of date.
                let linkable = LM unlinked_time this_mod
220
                               (hs_unlinked ++ stub_o)
221
                return (Just linkable)
222

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

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

242
243
244
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
245
246
247
-- The object file created by compiling the _stub.c file is put into a
-- temporary file, which will be later combined with the main .o file
-- (see the MergeStubs phase).
248

249
250
251
252
compileStub :: HscEnv -> FilePath -> IO FilePath
compileStub hsc_env stub_c = do
        (_, stub_o) <- runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
                                   Temporary Nothing{-no ModLocation-} Nothing
253

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

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

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

272
link LinkInMemory _ _ _
273
274
275
276
    = if cGhcWithInterpreter == "YES"
      then -- Not Linking...(demand linker will do the job)
           return Succeeded
      else panicBadLink LinkInMemory
277

278
link NoLink _ _ _
279
280
   = return Succeeded

281
link LinkBinary dflags batch_attempt_linking hpt
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
   = 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
297
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
298
299
300
   = do
        let
            home_mod_infos = eltsUFM hpt
301

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

Ian Lynagh's avatar
Ian Lynagh committed
305
306
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
307

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

Ian Lynagh's avatar
Ian Lynagh committed
310
311
312
313
314
        -- 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
315

Ian Lynagh's avatar
Ian Lynagh committed
316
317
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
318

Ian Lynagh's avatar
Ian Lynagh committed
319
            exe_file = exeFileName dflags
320

321
        linking_needed <- linkingNeeded dflags linkables pkg_deps
322

Ian Lynagh's avatar
Ian Lynagh committed
323
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
324
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
325
326
                   return Succeeded
           else do
327

Ian Lynagh's avatar
Ian Lynagh committed
328
        compilationProgressMsg dflags ("Linking " ++ exe_file ++ " ...")
329

Ian Lynagh's avatar
Ian Lynagh committed
330
331
332
333
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
334
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
335
        link dflags obj_files pkg_deps
336

337
        debugTraceMsg dflags 3 (text "link: done")
338

Ian Lynagh's avatar
Ian Lynagh committed
339
        -- linkBinary only returns if it succeeds
340
341
342
        return Succeeded

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

347
348
349
350
351
352
353

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
354
  e_exe_time <- tryIO $ getModificationUTCTime exe_file
355
356
357
358
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
359
        let extra_ld_inputs = ldInputs dflags
360
        e_extra_times <- mapM (tryIO . getModificationUTCTime) extra_ld_inputs
361
362
363
        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
364
            then return True
365
366
367
368
369
370
371
372
373
374
375
            else do

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

        pkg_libfiles <- mapM (uncurry findHSLib) pkg_hslibs
        if any isNothing pkg_libfiles then return True else do
376
        e_lib_times <- mapM (tryIO . getModificationUTCTime)
377
378
379
380
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
381
382
383
384
385
386
           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
387
 | not (platformSupportsSavingLinkOpts (platformOS (targetPlatform dflags)))
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 -- 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)

402
403
404
405
406
platformSupportsSavingLinkOpts :: OS -> Bool
platformSupportsSavingLinkOpts os
  | os == OSSolaris2 = False -- see #5382
  | otherwise        = osElfTarget os

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

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

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

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

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

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

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

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

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

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


471
-- ---------------------------------------------------------------------------
472

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

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

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

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

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

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

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

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

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

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

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

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

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

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
-- -----------------------------------------------------------------------------
-- The pipeline uses a monad to carry around various bits of information

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

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

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

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

596
597
instance HasDynFlags CompPipeline where
    getDynFlags = P $ \_env state -> return (state, hsc_dflags (hsc_env state))
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                is_last_phase = next_phase `eqPhase` stop_phase

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

                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
708

709

710
-- -----------------------------------------------------------------------------
711
-- | Each phase in the pipeline returns the next phase to execute, and the
712
713
714
715
716
717
718
-- 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.
719
--
720
721
722
723
724
runPhase :: Phase       -- ^ Run this phase
         -> FilePath    -- ^ name of the input file
         -> DynFlags    -- ^ for convenience, we pass the current dflags in
         -> CompPipeline (Phase,               -- next phase to run
                          FilePath)            -- output filename
Ian Lynagh's avatar
Ian Lynagh committed
725
726
727
728

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

730

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

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

738
739
740
741
742
       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"
743
                   , SysTools.Option $ escape $ normalise input_fn
744
745
746
747
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

748
       io $ SysTools.runUnlit dflags flags
749

750
       return (Cpp sf, output_fn)
751
752
753
754
755
756
757
758
759
760
761
762
763
  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 []        = []
764
765

-------------------------------------------------------------------------------
766
-- Cpp phase : (a) gets OPTIONS out of file
Ian Lynagh's avatar
Ian Lynagh committed
767
--             (b) runs cpp if necessary
768

769
770
771
runPhase (Cpp sf) input_fn dflags0
  = do
       src_opts <- io $ getOptionsFromFile dflags0 input_fn
772
       (dflags1, unhandled_flags, warns)
773
           <- io $ parseDynamicFilePragma dflags0 src_opts
774
       setDynFlags dflags1
Ian Lynagh's avatar
Ian Lynagh committed
775
       io $ checkProcessArgsResult dflags1 unhandled_flags
776

777
       if not (xopt Opt_Cpp dflags1) then do
778
           -- we have to be careful to emit warnings only once.
779
           unless (dopt Opt_Pp dflags1) $ io $ handleFlagWarnings dflags1 warns
780

sof's avatar
sof committed
781
           -- no need to preprocess CPP, just pass input file along
Ian Lynagh's avatar
Ian Lynagh committed
782
           -- to the next phase of the pipeline.
783
           return (HsPp sf, input_fn)
Ian Lynagh's avatar
Ian Lynagh committed
784
        else do
785
786
            output_fn <- phaseOutputFilename (HsPp sf)
            io $ doCpp dflags1 True{-raw-} False{-no CC opts-} input_fn output_fn
787
788
            -- re-read the pragmas now that we've preprocessed the file
            -- See #2464,#3457
789
            src_opts <- io $ getOptionsFromFile dflags0 output_fn
790
            (dflags2, unhandled_flags, warns)
791
                <- io $ parseDynamicFilePragma dflags0 src_opts
Ian Lynagh's avatar
Ian Lynagh committed
792
            io $ checkProcessArgsResult dflags2 unhandled_flags
793
            unless (dopt Opt_Pp dflags2) $ io $ handleFlagWarnings dflags2 warns
794
            -- the HsPp pass below will emit warnings
795
796

            setDynFlags dflags2
797

798
            return (HsPp sf, output_fn)
799

sof's avatar
sof committed
800
-------------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
801
-- HsPp phase
sof's avatar
sof committed
802

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

            -- re-read pragmas now that we've parsed the file (see #3674)
823
            src_opts <- io $ getOptionsFromFile dflags output_fn
824
            (dflags1, unhandled_flags, warns)
825
                <- io $ parseDynamicFilePragma dflags src_opts
826
            setDynFlags dflags1
Ian Lynagh's avatar
Ian Lynagh committed
827
            io $ checkProcessArgsResult dflags1 unhandled_flags
dterei's avatar
dterei committed
828
            io $ handleFlagWarnings dflags1 warns
829

830
            return (Hsc sf, output_fn)
831

832
833
834
-----------------------------------------------------------------------------
-- Hsc phase

835
836
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
837
runPhase (Hsc src_flavour) input_fn dflags0
Ian Lynagh's avatar
Ian Lynagh committed
838
 = do   -- normal Hsc mode, not mkdependHS
839
840
841
842

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

844
  -- we add the current directory (i.e. the directory in which
845
  -- the .hs files resides) to the include path, since this is
846
  -- what gcc does, and it's probably what you want.
847
        let current_dir = takeDirectory basename
Ian Lynagh's avatar
Ian Lynagh committed
848
849
850
            paths = includePaths dflags0
            dflags = dflags0 { includePaths = current_dir : paths }

851
852
        setDynFlags dflags

853
  -- gather the imports and module name
854
        (hspp_buf,mod_name,imps,src_imps) <- io $
855
            case src_flavour of
856
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
857
                    m <- getCoreModuleName input_fn
858
                    return (Nothing, mkModuleName m, [], [])
859

860
                _           -> do
861
                    buf <- hGetStringBuffer input_fn
862
863
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
864
865
866

  -- Build a ModLocation to pass to hscMain.
  -- The source filename is rather irrelevant by now, but it's used
Ian Lynagh's avatar
Ian Lynagh committed
867
  -- by hscMain for messages.  hscMain also needs
868
  -- the .hi and .o filenames, and this is as good a way
Ian Lynagh's avatar
Ian Lynagh committed
869
  -- as any to generate them, and better than most. (e.g. takes
870
  -- into accout the -osuf flags)
871
        location1 <- io $ mkHomeModLocation2 dflags mod_name basename suff
872
873

  -- Boot-ify it if necessary
Ian Lynagh's avatar
Ian Lynagh committed
874
875
876
        let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
                      | otherwise            = location1

877
878
879
880

  -- Take -ohi into account if present
  -- This can't be done in mkHomeModuleLocation because
  -- it only applies to the module being compiles
Ian Lynagh's avatar
Ian Lynagh committed
881
882
883
        let ohi = outputHi dflags
            location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
                      | otherwise      = location2
884
885
886
887
888
889

  -- 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
Ian Lynagh's avatar
Ian Lynagh committed
890
891
892
893
894
        let expl_o_file = outputFile dflags
            location4 | Just ofile <- expl_o_file
                      , isNoLink (ghcLink dflags)
                      = location3 { ml_obj_file = ofile }
                      | otherwise = location3
895

Ian Lynagh's avatar
Ian Lynagh committed
896
            o_file = ml_obj_file location4      -- The real object file
897

898
        setModLocation location4
899
900

  -- Figure out if the source has changed, for recompilation avoidance.
901
  --
902
  -- Setting source_unchanged to True means that M.o seems
903
904
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
905
  -- Setting source_unchanged to False tells the compiler that M.o is out of
906
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
907
        src_timestamp <- io $ getModificationUTCTime (basename <.> suff)
Simon Marlow's avatar
Simon Marlow committed
908

909
        let hsc_lang = hscTarget dflags
910
        source_unchanged <- io $
911
912
          if not (isStopLn stop)
                -- SourceModified unconditionally if
Ian Lynagh's avatar
Ian Lynagh committed
913
914
                --      (a) recompilation checker is off, or
                --      (b) we aren't going all the way to .o file (e.g. ghc -S)
915
             then return SourceModified
Ian Lynagh's avatar
Ian Lynagh committed
916
                -- Otherwise look at file modification dates
917
             else do o_file_exists <- doesFileExist o_file
Ian Lynagh's avatar
Ian Lynagh committed
918
                     if not o_file_exists
919
                        then return SourceModified       -- Need to recompile
920
                        else do t2 <- getModificationUTCTime o_file
Ian Lynagh's avatar
Ian Lynagh committed
921
                                if t2 > src_timestamp
922
923
                                  then return SourceUnmodified
                                  else return SourceModified
924

925
  -- get the DynFlags
dterei's avatar
dterei committed
926
        let next_phase = hscPostBackendPhase dflags src_flavour hsc_lang
927
        output_fn  <- phaseOutputFilename next_phase
928

929
        let dflags' = dflags { hscTarget = hsc_lang,
Ian Lynagh's avatar
Ian Lynagh committed
930
931
                               hscOutName = output_fn,
                               extCoreName = basename ++ ".hcr" }
932

933
934
        setDynFlags dflags'
        PipeState{hsc_env=hsc_env'} <- getPipeState
935

936
  -- Tell the finder cache about this module