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

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

module DriverPipeline (
13
14
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
15
   oneShot, compileFile,
16

17
	-- Interfaces for the batch-mode driver
18
   linkBinary,
19

20
21
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
22
   compile, compile',
23
   link, 
24

25
26
27
28
  ) where

#include "HsVersions.h"

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

53
import Data.Either
54
import Exception
55
import Data.IORef	( readIORef )
Simon Marlow's avatar
Simon Marlow committed
56
57
import GHC.Exts		( Int(..) )
import System.Directory
Ian Lynagh's avatar
Ian Lynagh committed
58
import System.FilePath
Simon Marlow's avatar
Simon Marlow committed
59
import System.IO
60
import System.IO.Error as IO
Simon Marlow's avatar
Simon Marlow committed
61
import Control.Monad
62
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
63
64
import Data.Maybe
import System.Environment
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
76
77
78
preprocess :: GhcMonad m =>
              HscEnv
           -> (FilePath, Maybe Phase) -- ^ filename and starting phase
           -> m (DynFlags, FilePath)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
79
preprocess hsc_env (filename, mb_phase) =
80
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
81
  runPipeline anyHsc hsc_env (filename, mb_phase) 
Simon Marlow's avatar
Simon Marlow committed
82
        Nothing Temporary Nothing{-no ModLocation-}
83

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

86
87
-- | Compile
--
88
89
90
91
92
93
-- 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
-- reading the OPTIONS pragma from the source file, and passing the
-- output of hsc through the C compiler.
94
--
95
96
-- NB.  No old interface can also mean that the source has changed.

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

106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
compile = compile' (hscCompileNothing, hscCompileInteractive, hscCompileBatch)

type Compiler m a = HscEnv -> ModSummary -> Bool
                  -> Maybe ModIface -> Maybe (Int, Int)
                  -> m a

compile' :: GhcMonad m =>
           (Compiler m (HscStatus, ModIface, ModDetails),
            Compiler m (InteractiveStatus, ModIface, ModDetails),
            Compiler m (HscStatus, ModIface, ModDetails))
        -> 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
        -> m HomeModInfo   -- ^ the complete HomeModInfo, if successful

compile' (nothingCompiler, interactiveCompiler, batchCompiler)
        hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
126
127
128
129
 = do
   let dflags0     = ms_hspp_opts summary
       this_mod    = ms_mod summary
       src_flavour = ms_hsc_src summary
130
131
132
       location	   = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location) 
       input_fnpp  = ms_hspp_file summary
133

134
   liftIO $ debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
135

Ian Lynagh's avatar
Ian Lynagh committed
136
   let basename = dropExtension input_fn
137

138
139
140
  -- We add the directory in which the .hs files resides) to the import path.
  -- This is needed when we try to compile the .hc file later, if it
  -- imports a _stub.h file that we created here.
Ian Lynagh's avatar
Ian Lynagh committed
141
142
143
   let current_dir = case takeDirectory basename of
                     "" -> "." -- XXX Hack
                     d -> d
144
145
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
146
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
147

148
   -- Figure out what lang we're generating
149
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
150
   -- ... and what the next phase should be
151
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
152
   -- ... and what file to generate the output into
153
   output_fn <- liftIO $ getOutputFilename next_phase
154
			Temporary basename dflags next_phase (Just location)
155

156
   let dflags' = dflags { hscTarget = hsc_lang,
157
				hscOutName = output_fn,
158
				extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
159
   let hsc_env' = hsc_env { hsc_dflags = dflags' }
160

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

166
167
   let getStubLinkable False = return []
       getStubLinkable True
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
168
           = do stub_o <- compileStub hsc_env' this_mod location
169
170
                return [ DotO stub_o ]

171
       handleBatch HscNoRecomp
172
           = ASSERT (isJust maybe_old_linkable)
173
174
             return maybe_old_linkable

Thomas Schilling's avatar
Thomas Schilling committed
175
       handleBatch (HscRecomp hasStub _)
176
           | isHsBoot src_flavour
177
               = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
178
                       liftIO $ SysTools.touch dflags' "Touching object file"
179
                                   object_filename
180
181
                    return maybe_old_linkable

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

Thomas Schilling's avatar
Thomas Schilling committed
201
       handleInterpreted HscNoRecomp
202
           = ASSERT (isJust maybe_old_linkable)
203
             return maybe_old_linkable
204
205
206
207
       handleInterpreted (HscRecomp _hasStub Nothing)
           = ASSERT (isHsBoot src_flavour)
             return maybe_old_linkable
       handleInterpreted (HscRecomp hasStub (Just (comp_bc, modBreaks)))
208
           = do stub_unlinked <- getStubLinkable hasStub
209
                let hs_unlinked = [BCOs comp_bc modBreaks]
210
                    unlinked_time = ms_hs_date summary
211
212
213
214
215
216
217
218
                  -- 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_unlinked)
219
                return (Just linkable)
220

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

240

241
-----------------------------------------------------------------------------
242
243
-- stub .h and .c files (for foreign export support)

244
245
246
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
247
248
249
250
251
252
253
254
255
256
257
258
259
-- Consequently, we derive the _stub.o filename from the haskell object
-- filename.  
--
-- This isn't necessarily the same as the object filename we
-- would get if we just compiled the _stub.c file using the pipeline.
-- For example:
--
--    ghc src/A.hs -odir obj
-- 
-- results in obj/A.o, and src/A_stub.c.  If we compile src/A_stub.c with
-- -odir obj, we would get obj/src/A_stub.o, which is wrong; we want
-- obj/A_stub.o.

260
261
compileStub :: GhcMonad m => HscEnv -> Module -> ModLocation
            -> m FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
262
compileStub hsc_env mod location = do
263
	-- compile the _stub.c file w/ gcc
264
265
266
	let (stub_c,_,stub_o) = mkStubPaths (hsc_dflags hsc_env) 
                                   (moduleName mod) location

267
	_ <- runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
268
269
270
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
271
272


273
274
-- ---------------------------------------------------------------------------
-- Link
275

Ian Lynagh's avatar
Ian Lynagh committed
276
277
278
279
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
280
281
282
283
284
285
286
287
288
289
     -> IO SuccessFlag

-- For the moment, in the batch linker, we don't bother to tell doLink
-- which packages to link -- it just tries all that are available.
-- batch_attempt_linking should only be *looked at* in batch mode.  It
-- should only be True if the upsweep was successful and someone
-- exports main, i.e., we have good reason to believe that linking
-- will succeed.

#ifdef GHCI
290
link LinkInMemory _ _ _
291
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
292
         return Succeeded
293
294
#endif

295
link NoLink _ _ _
296
297
   = return Succeeded

298
link LinkBinary dflags batch_attempt_linking hpt
299
300
301
302
303
   = link' dflags batch_attempt_linking hpt

link LinkDynLib dflags batch_attempt_linking hpt
   = link' dflags batch_attempt_linking hpt

Simon Marlow's avatar
Simon Marlow committed
304
#ifndef GHCI
305
306
-- warning suppression
link other _ _ _ = panicBadLink other
Simon Marlow's avatar
Simon Marlow committed
307
#endif
308
309
310
311
312
313
314
315
316
317
318

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
319
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
320
321
322
   = do
        let
            home_mod_infos = eltsUFM hpt
323

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
341
            exe_file = exeFileName dflags
342

343
        linking_needed <- linkingNeeded dflags linkables pkg_deps
344

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

350
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
351
                                 <+> text "...")
352

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

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

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

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

370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413

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
  e_exe_time <- IO.try $ getModificationTime exe_file
  case e_exe_time of
    Left _  -> return True
    Right t -> do
        -- first check object files and extra_ld_inputs
        extra_ld_inputs <- readIORef v_Ld_inputs
        e_extra_times <- mapM (IO.try . getModificationTime) extra_ld_inputs
        let (errs,extra_times) = splitEithers e_extra_times
        let obj_times =  map linkableTime linkables ++ extra_times
        if not (null errs) || any (t <) obj_times
            then return True 
            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
        e_lib_times <- mapM (IO.try . getModificationTime)
                          (catMaybes pkg_libfiles)
        let (lib_errs,lib_times) = splitEithers e_lib_times
        if not (null lib_errs) || any (t <) lib_times
           then return True
           else return False

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)

414
415
416
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

417
418
oneShot :: GhcMonad m =>
           HscEnv -> Phase -> [(String, Maybe Phase)] -> m ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
419
420
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
421
  liftIO $ doLink (hsc_dflags hsc_env) stop_phase o_files
422

423
424
compileFile :: GhcMonad m =>
               HscEnv -> Phase -> (FilePath, Maybe Phase) -> m FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
425
compileFile hsc_env stop_phase (src, mb_phase) = do
426
   exists <- liftIO $ doesFileExist src
427
   when (not exists) $ 
428
   	ghcError (CmdLineError ("does not exist: " ++ src))
429
430
   
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
431
        dflags = hsc_dflags hsc_env
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
	split     = dopt Opt_SplitObjs dflags
	mb_o_file = outputFile dflags
	ghc_link  = ghcLink dflags	-- Set by -c or -no-link

	-- When linking, the -o argument refers to the linker's output.	
	-- otherwise, we use it as the name for the pipeline's output.
        output
	 | 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
447
                        _          -> stop_phase
448

449
450
451
   ( _, out_file) <- runPipeline stop_phase' hsc_env
                            (src, mb_phase) Nothing output
                            Nothing{-no ModLocation-}
452
453
454
455
456
457
458
459
460
461
462
   return out_file


doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
doLink dflags stop_phase o_files
  | not (isStopLn stop_phase)
  = return ()		-- We stopped before the linking phase

  | otherwise
  = case ghcLink dflags of
	NoLink     -> return ()
463
464
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
465
        other      -> panicBadLink other
466
467
468
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
469
    link_pkgs
470
471
     | dopt Opt_AutoLinkPackages dflags = [haskell98PackageId]
     | otherwise                        = []
472
473


474
-- ---------------------------------------------------------------------------
475
476
477

data PipelineOutput 
  = Temporary
478
479
	-- ^ Output should be to a temporary file: we're going to
	-- run more compilation steps on this output later.
480
  | Persistent
481
	-- ^ We want a persistent file, i.e. a file in the current directory
482
483
484
	-- derived from the input filename, but with the appropriate extension.
	-- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
  | SpecificFile FilePath
485
	-- ^ The output must go into the specified file.
486

487
488
489
490
491
492
493
-- | 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
494
-- OPTIONS_GHC pragmas), and the changes affect later phases in the
495
-- pipeline.
496
runPipeline
497
498
499
500
501
502
503
504
  :: GhcMonad m =>
     Phase		        -- ^ When to stop
  -> HscEnv                     -- ^ Compilation environment
  -> (FilePath,Maybe Phase)     -- ^ Input filename (and maybe -x suffix)
  -> Maybe FilePath             -- ^ original basename (if different from ^^^)
  -> PipelineOutput	        -- ^ Output filename
  -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
  -> m (DynFlags, FilePath)	-- ^ (final flags, output filename)
505

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

514
515
      -- 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
516
      hsc_env = hsc_env0 {hsc_dflags = dflags}
517

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

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

528
  when (not (start_phase `happensBefore` stop_phase)) $
529
	ghcError (UsageError 
530
531
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
532

533
534
  -- 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)
535
  let get_output_fn = getOutputFilename stop_phase output basename
536

537
  -- Execute the pipeline...
538
  (dflags', output_fn, maybe_loc) <- 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
539
	pipeLoop hsc_env start_phase stop_phase input_fn 
Ian Lynagh's avatar
Ian Lynagh committed
540
	  	 basename suffix' get_output_fn maybe_loc
541

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

558
559


560
561
pipeLoop :: GhcMonad m =>
            HscEnv -> Phase -> Phase
562
	 -> FilePath  -> String -> Suffix
563
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
564
	 -> Maybe ModLocation
565
	 -> m (DynFlags, FilePath, Maybe ModLocation)
566

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
567
pipeLoop hsc_env phase stop_phase 
568
569
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
570

571
  | phase `eqPhase` stop_phase		  -- All done
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
572
  = return (hsc_dflags hsc_env, input_fn, maybe_loc)
573

574
  | not (phase `happensBefore` stop_phase)
575
576
577
578
	-- 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 #-}.
579
580
581
582
  = panic ("pipeLoop: at phase " ++ show phase ++ 
	   " but I wanted to stop at phase " ++ show stop_phase)

  | otherwise 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
583
584
585
586
587
588
  = do (next_phase, dflags', maybe_loc, output_fn)
          <- runPhase phase stop_phase hsc_env orig_basename 
                      orig_suff input_fn orig_get_output_fn maybe_loc
       let hsc_env' = hsc_env {hsc_dflags = dflags'}
       pipeLoop hsc_env' next_phase stop_phase output_fn
                orig_basename orig_suff orig_get_output_fn maybe_loc
589

590
getOutputFilename
591
592
593
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
594
595
 = func
 where
596
	func dflags next_phase maybe_location
597
598
599
600
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
601
	   where
602
603
604
605
606
607
608
609
610
611
612
		hcsuf      = hcSuf dflags
		odir       = objectDir dflags
		osuf       = objectSuf dflags
		keep_hc    = dopt Opt_KeepHcFiles dflags
		keep_raw_s = dopt Opt_KeepRawSFiles dflags
		keep_s     = dopt Opt_KeepSFiles dflags

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

613
		is_last_phase = next_phase `eqPhase` stop_phase
614
615
616
617

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
618
     			     StopLn              -> True
619
620
621
622
623
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

624
		suffix = myPhaseInputExt next_phase
625
626
627

		-- persistent object files get put in odir
	        persistent_fn 
628
629
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
630

Ian Lynagh's avatar
Ian Lynagh committed
631
		persistent = basename <.> suffix
632

633
		odir_persistent
634
		   | Just loc <- maybe_location = ml_obj_file loc
Ian Lynagh's avatar
Ian Lynagh committed
635
		   | Just d <- odir = d </> persistent
636
637
		   | otherwise      = persistent

638

639
-- -----------------------------------------------------------------------------
640
-- | Each phase in the pipeline returns the next phase to execute, and the
641
642
643
644
645
646
647
-- 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.
648
649
650
651
--
runPhase :: GhcMonad m =>
            Phase	-- ^ Do this phase first
	 -> Phase	-- ^ Stop just before this phase
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
652
	 -> HscEnv
653
654
655
	 -> String	-- ^ basename of original input source
	 -> String	-- ^ its extension
	 -> FilePath	-- ^ name of file which contains the input to this phase.
656
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
657
658
659
660
661
662
			-- ^ how to calculate the output filename
	 -> Maybe ModLocation		-- ^ the ModLocation, if we have one
	 -> m (Phase,	  		-- next phase
               DynFlags,		-- new dynamic flags
	       Maybe ModLocation,	-- the ModLocation, if we have one
	       FilePath)		-- output filename
663

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

668
669
670
-------------------------------------------------------------------------------
-- Unlit phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
671
runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
672
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
673
       let dflags = hsc_dflags hsc_env
674
       output_fn <- liftIO $ get_output_fn dflags (Cpp sf) maybe_loc
675

676
677
678
679
680
681
682
683
684
685
686
687
       let unlit_flags = getOpts dflags opt_L
           flags = map SysTools.Option unlit_flags ++
                   [ -- The -h option passes the file name for unlit to
                     -- put in a #line directive
                     SysTools.Option     "-h"
                     -- cpp interprets \b etc as escape sequences,
                     -- so we use / for filenames in pragmas
                   , SysTools.Option $ reslash Forwards $ normalise input_fn
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

688
       liftIO $ SysTools.runUnlit dflags flags
689

690
       return (Cpp sf, dflags, maybe_loc, output_fn)
691
692

-------------------------------------------------------------------------------
693
694
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
695

696
runPhase (Cpp sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
697
  = do let dflags0 = hsc_dflags hsc_env
698
699
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
       (dflags, unhandled_flags, warns)
700
           <- liftIO $ parseDynamicNoPackageFlags dflags0 src_opts
701
       handleFlagWarnings dflags warns
702
       checkProcessArgsResult unhandled_flags
703

704
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
705
706
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
707
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
708
	else do
709
710
	    output_fn <- liftIO $ get_output_fn dflags (HsPp sf) maybe_loc
	    liftIO $ doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
711
	    return (HsPp sf, dflags, maybe_loc, output_fn)
712

sof's avatar
sof committed
713
714
715
-------------------------------------------------------------------------------
-- HsPp phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
716
717
718
runPhase (HsPp sf) _stop hsc_env basename suff input_fn get_output_fn maybe_loc
  = do let dflags = hsc_dflags hsc_env
       if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
719
720
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
721
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
722
	else do
723
	    let hspp_opts = getOpts dflags opt_F
Ian Lynagh's avatar
Ian Lynagh committed
724
	    let orig_fn = basename <.> suff
725
726
	    output_fn <- liftIO $ get_output_fn dflags (Hsc sf) maybe_loc
	    liftIO $ SysTools.runPp dflags
727
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
728
729
730
731
732
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
733
	    return (Hsc sf, dflags, maybe_loc, output_fn)
734

735
736
737
-----------------------------------------------------------------------------
-- Hsc phase

738
739
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
740
runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc 
741
 = do	-- normal Hsc mode, not mkdependHS
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
742
        let dflags0 = hsc_dflags hsc_env
743

744
  -- we add the current directory (i.e. the directory in which
745
  -- the .hs files resides) to the include path, since this is
746
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
747
748
749
	let current_dir = case takeDirectory basename of
                      "" -> "." -- XXX Hack
                      d -> d
750
	
751
752
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
753
	
754
  -- gather the imports and module name
755
        (hspp_buf,mod_name,imps,src_imps) <- 
756
            case src_flavour of
757
758
759
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
                    m <- liftIO $ getCoreModuleName input_fn
                    return (Nothing, mkModuleName m, [], [])
760

761
762
                _           -> do
                    buf <- liftIO $ hGetStringBuffer input_fn
763
764
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
765
766
767
768
769
770
771

  -- Build a ModLocation to pass to hscMain.
  -- The source filename is rather irrelevant by now, but it's used
  -- by hscMain for messages.  hscMain also needs 
  -- the .hi and .o filenames, and this is as good a way
  -- as any to generate them, and better than most. (e.g. takes 
  -- into accout the -osuf flags)
772
	location1 <- liftIO $ mkHomeModLocation2 dflags mod_name basename suff
773
774
775
776
777
778
779
780
781

  -- Boot-ify it if necessary
	let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
		      | otherwise	     = location1 
					

  -- Take -ohi into account if present
  -- This can't be done in mkHomeModuleLocation because
  -- it only applies to the module being compiles
782
783
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
784
785
786
787
788
789
790
		      | otherwise      = location2

  -- 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
791
792
793
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
794
795
796
797
798
799
800
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

	    o_file = ml_obj_file location4 	-- The real object file


  -- Figure out if the source has changed, for recompilation avoidance.
801
  --
802
  -- Setting source_unchanged to True means that M.o seems
803
804
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
805
  -- Setting source_unchanged to False tells the compiler that M.o is out of
806
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
807
	src_timestamp <- liftIO $ getModificationTime (basename <.> suff)
Simon Marlow's avatar
Simon Marlow committed
808

809
	let force_recomp = dopt Opt_ForceRecomp dflags
810
	source_unchanged <-
811
          if force_recomp || not (isStopLn stop)
812
813
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
814
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
815
816
	     then return False	
		-- Otherwise look at file modification dates
817
	     else do o_file_exists <- liftIO $ doesFileExist o_file
818
		     if not o_file_exists
819
		        then return False	-- Need to recompile
820
			else do t2 <- liftIO $ getModificationTime o_file
821
			        if t2 > src_timestamp
822
823
				  then return True
				  else return False
824

825
  -- get the DynFlags
826
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
827
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
828
	output_fn  <- liftIO $ get_output_fn dflags next_phase (Just location4)
829

830
        let dflags' = dflags { hscTarget = hsc_lang,
831
832
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
833

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
834
        let hsc_env' = hsc_env {hsc_dflags = dflags'}
835

836
  -- Tell the finder cache about this module
837
	mod <- liftIO $ addHomeModuleToFinder hsc_env' mod_name location4
Simon Marlow's avatar
Simon Marlow committed
838
839
840
841
842
843
844
845
846
847
848

  -- Make the ModSummary to hand to hscMain
	let
	    mod_summary = ModSummary {	ms_mod 	     = mod, 
					ms_hsc_src   = src_flavour,
				 	ms_hspp_file = input_fn,
                                        ms_hspp_opts = dflags,
					ms_hspp_buf  = hspp_buf,
					ms_location  = location4,
					ms_hs_date   = src_timestamp,
					ms_obj_date  = Nothing,
849
850
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
851

852
  -- run the compiler!
853
	result <- hscCompileOneShot hsc_env'
854
855
			  mod_summary source_unchanged 
			  Nothing	-- No iface
856
                          Nothing       -- No "module i of n" progress info
857

858
859
860
	case result of
          HscNoRecomp
              -> do liftIO $ SysTools.touch dflags' "Touching object file" o_file
861
862
863
864
                    -- The .o file must have a later modification date
                    -- than the source file (else we wouldn't be in HscNoRecomp)
                    -- but we touch it anyway, to keep 'make' happy (we think).
                    return (StopLn, dflags', Just location4, o_file)
Thomas Schilling's avatar
Thomas Schilling committed
865
          (HscRecomp hasStub _)
866
              -> do when hasStub $
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
867
                         do stub_o <- compileStub hsc_env' mod location4
868
                            liftIO $ consIORef v_Ld_inputs stub_o
869
870
871
                    -- In the case of hs-boot files, generate a dummy .o-boot 
                    -- stamp file for the benefit of Make
                    when (isHsBoot src_flavour) $
872
                      liftIO $ SysTools.touch dflags' "Touching object file" o_file
873
                    return (next_phase, dflags', Just location4, output_fn)
874

875
876
877
-----------------------------------------------------------------------------
-- Cmm phase

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
878
runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
879
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
880
       let dflags = hsc_dflags hsc_env
881
882
       output_fn <- liftIO $ get_output_fn dflags Cmm maybe_loc
       liftIO $ doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
883
       return (Cmm, dflags, maybe_loc, output_fn)
884

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
885
runPhase Cmm stop hsc_env basename _ input_fn get_output_fn maybe_loc
886
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
887
        let dflags = hsc_dflags hsc_env
888
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
889
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
890
	output_fn <-