DriverPipeline.hs 63.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,
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
Simon Marlow's avatar
Simon Marlow committed
55
56
57
import Data.IORef	( readIORef, writeIORef, IORef )
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

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
106
compile hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
107
108
109
110
 = do
   let dflags0     = ms_hspp_opts summary
       this_mod    = ms_mod summary
       src_flavour = ms_hsc_src summary
111
112
113
       location	   = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location) 
       input_fnpp  = ms_hspp_file summary
114

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

Ian Lynagh's avatar
Ian Lynagh committed
117
   let basename = dropExtension input_fn
118

119
120
121
  -- 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
122
123
124
   let current_dir = case takeDirectory basename of
                     "" -> "." -- XXX Hack
                     d -> d
125
126
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
127
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
128

129
   -- Figure out what lang we're generating
130
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
131
   -- ... and what the next phase should be
132
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
133
   -- ... and what file to generate the output into
134
   output_fn <- liftIO $ getOutputFilename next_phase
135
			Temporary basename dflags next_phase (Just location)
136

137
   let dflags' = dflags { hscTarget = hsc_lang,
138
				hscOutName = output_fn,
139
				extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
140
   let hsc_env' = hsc_env { hsc_dflags = dflags' }
141

142
   -- -fforce-recomp should also work with --make
143
144
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
145
       object_filename = ml_obj_file location
146

147
148
   let getStubLinkable False = return []
       getStubLinkable True
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
149
           = do stub_o <- compileStub hsc_env' this_mod location
150
151
                return [ DotO stub_o ]

152
       handleBatch HscNoRecomp
153
           = ASSERT (isJust maybe_old_linkable)
154
155
156
             return maybe_old_linkable

       handleBatch (HscRecomp hasStub)
157
           | isHsBoot src_flavour
158
               = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
159
                       liftIO $ SysTools.touch dflags' "Touching object file"
160
                                   object_filename
161
162
                    return maybe_old_linkable

163
164
165
166
167
           | otherwise
               = do stub_unlinked <- getStubLinkable hasStub
                    (hs_unlinked, unlinked_time) <-
                        case hsc_lang of
                          HscNothing
168
                            -> return ([], ms_hs_date summary)
169
170
                          -- We're in --make mode: finish the compilation pipeline.
                          _other
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
171
                            -> do runPipeline StopLn hsc_env' (output_fn,Nothing)
Simon Marlow's avatar
Simon Marlow committed
172
173
                                              (Just basename)
                                              Persistent
174
175
                                              (Just location)
                                  -- The object filename comes from the ModLocation
176
                                  o_time <- liftIO $ getModificationTime object_filename
177
178
179
                                  return ([DotO object_filename], o_time)
                    let linkable = LM unlinked_time this_mod
			           (hs_unlinked ++ stub_unlinked)
180
                    return (Just linkable)
181

182
       handleInterpreted InteractiveNoRecomp
183
           = ASSERT (isJust maybe_old_linkable)
184
185
             return maybe_old_linkable
       handleInterpreted (InteractiveRecomp hasStub comp_bc modBreaks)
186
           = do stub_unlinked <- getStubLinkable hasStub
187
                let hs_unlinked = [BCOs comp_bc modBreaks]
188
                    unlinked_time = ms_hs_date summary
189
190
191
192
193
194
195
196
                  -- 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)
197
                return (Just linkable)
198

199
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
200
       --            -> m HomeModInfo
201
       runCompiler compiler handle
202
203
204
205
206
207
208
           = 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 })
209
   -- run the compiler
210
   case hsc_lang of
211
212
213
214
215
216
217
218
219
      HscInterpreted
        | isHsBoot src_flavour -> 
                runCompiler hscCompileNothing handleBatch
        | otherwise -> 
                runCompiler hscCompileInteractive handleInterpreted
      HscNothing -> 
                runCompiler hscCompileNothing handleBatch
      _other -> 
                runCompiler hscCompileBatch handleBatch
220

221
-----------------------------------------------------------------------------
222
223
-- stub .h and .c files (for foreign export support)

224
225
226
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
227
228
229
230
231
232
233
234
235
236
237
238
239
-- 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.

240
241
compileStub :: GhcMonad m => HscEnv -> Module -> ModLocation
            -> m FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
242
compileStub hsc_env mod location = do
Ian Lynagh's avatar
Ian Lynagh committed
243
244
	let (o_base, o_ext) = splitExtension (ml_obj_file location)
	    stub_o = (o_base ++ "_stub") <.> o_ext
245

246
	-- compile the _stub.c file w/ gcc
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
247
248
	let (stub_c,_,_) = mkStubPaths (hsc_dflags hsc_env) (moduleName mod) location
	runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
249
250
251
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
252
253


254
255
-- ---------------------------------------------------------------------------
-- Link
256

Ian Lynagh's avatar
Ian Lynagh committed
257
258
259
260
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> HomePackageTable        -- what to link
261
262
263
264
265
266
267
268
269
270
     -> 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
271
link LinkInMemory _ _ _
272
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
273
         return Succeeded
274
275
#endif

276
link NoLink _ _ _
277
278
   = return Succeeded

279
link LinkBinary dflags batch_attempt_linking hpt
280
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
281
282
283
   = do
        let
            home_mod_infos = eltsUFM hpt
284

Ian Lynagh's avatar
Ian Lynagh committed
285
286
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
287

Ian Lynagh's avatar
Ian Lynagh committed
288
289
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
290

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

Ian Lynagh's avatar
Ian Lynagh committed
293
294
295
296
297
        -- 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
298

Ian Lynagh's avatar
Ian Lynagh committed
299
300
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
301

Ian Lynagh's avatar
Ian Lynagh committed
302
            exe_file = exeFileName dflags
303

304
        linking_needed <- linkingNeeded dflags linkables pkg_deps
305

Ian Lynagh's avatar
Ian Lynagh committed
306
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
307
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
308
309
                   return Succeeded
           else do
310

311
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
312
                                 <+> text "...")
313

Ian Lynagh's avatar
Ian Lynagh committed
314
315
316
317
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
318
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
319
        link dflags obj_files pkg_deps
320

321
        debugTraceMsg dflags 3 (text "link: done")
322

Ian Lynagh's avatar
Ian Lynagh committed
323
        -- linkBinary only returns if it succeeds
324
325
326
        return Succeeded

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

331
332
333
334
335
336
-- warning suppression
link other _ _ _ = panicBadLink other

panicBadLink :: GhcLink -> a
panicBadLink other = panic ("link: GHC not built to link this way: " ++
                            show other)
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381


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)

382
383
384
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

385
386
oneShot :: GhcMonad m =>
           HscEnv -> Phase -> [(String, Maybe Phase)] -> m ()
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
387
388
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
389
  liftIO $ doLink (hsc_dflags hsc_env) stop_phase o_files
390

391
392
compileFile :: GhcMonad m =>
               HscEnv -> Phase -> (FilePath, Maybe Phase) -> m FilePath
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
393
compileFile hsc_env stop_phase (src, mb_phase) = do
394
   exists <- liftIO $ doesFileExist src
395
   when (not exists) $ 
396
   	ghcError (CmdLineError ("does not exist: " ++ src))
397
398
   
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
399
        dflags = hsc_dflags hsc_env
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
	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
415
                        _          -> stop_phase
416

417
418
419
   ( _, out_file) <- runPipeline stop_phase' hsc_env
                            (src, mb_phase) Nothing output
                            Nothing{-no ModLocation-}
420
421
422
423
424
425
426
427
428
429
430
   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 ()
431
432
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
433
        other      -> panicBadLink other
434
435
436
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
437
    link_pkgs
438
439
     | dopt Opt_AutoLinkPackages dflags = [haskell98PackageId]
     | otherwise                        = []
440
441


442
-- ---------------------------------------------------------------------------
443
444
445

data PipelineOutput 
  = Temporary
446
447
	-- ^ Output should be to a temporary file: we're going to
	-- run more compilation steps on this output later.
448
  | Persistent
449
	-- ^ We want a persistent file, i.e. a file in the current directory
450
451
452
	-- derived from the input filename, but with the appropriate extension.
	-- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
  | SpecificFile FilePath
453
	-- ^ The output must go into the specified file.
454

455
456
457
458
459
460
461
462
463
-- | 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
-- GHC_OPTIONS pragmas), and the changes affect later phases in the
-- pipeline.
464
runPipeline
465
466
467
468
469
470
471
472
  :: 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)
473

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
474
runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
475
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
476
  let dflags0 = hsc_dflags hsc_env0
Ian Lynagh's avatar
Ian Lynagh committed
477
478
      (input_basename, suffix) = splitExtension input_fn
      suffix' = drop 1 suffix -- strip off the .
Simon Marlow's avatar
Simon Marlow committed
479
480
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
481

482
483
      -- 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
484
      hsc_env = hsc_env0 {hsc_dflags = dflags}
485

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

489
490
491
492
493
494
  -- 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.
495

496
  when (not (start_phase `happensBefore` stop_phase)) $
497
	ghcError (UsageError 
498
499
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
500

501
502
  -- 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)
503
  let get_output_fn = getOutputFilename stop_phase output basename
504

505
  -- Execute the pipeline...
506
  (dflags', output_fn, maybe_loc) <- 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
507
	pipeLoop hsc_env start_phase stop_phase input_fn 
Ian Lynagh's avatar
Ian Lynagh committed
508
	  	 basename suffix' get_output_fn maybe_loc
509

510
  -- Sometimes, a compilation phase doesn't actually generate any output
511
512
  -- (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
513
514
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
515
516
517
  case output of
    Temporary -> 
	return (dflags', output_fn)
518
    _other -> liftIO $
519
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
520
521
522
523
	   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
524
	   return (dflags', final_fn)
525

526
527


528
529
pipeLoop :: GhcMonad m =>
            HscEnv -> Phase -> Phase
530
	 -> FilePath  -> String -> Suffix
531
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
532
	 -> Maybe ModLocation
533
	 -> m (DynFlags, FilePath, Maybe ModLocation)
534

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
535
pipeLoop hsc_env phase stop_phase 
536
537
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
538

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

542
  | not (phase `happensBefore` stop_phase)
543
544
545
546
	-- 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 #-}.
547
548
549
550
  = 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
551
552
553
554
555
556
  = 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
557

558
getOutputFilename
559
560
561
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
562
563
 = func
 where
564
	func dflags next_phase maybe_location
565
566
567
568
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
569
	   where
570
571
572
573
574
575
576
577
578
579
580
		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

581
		is_last_phase = next_phase `eqPhase` stop_phase
582
583
584
585

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
586
     			     StopLn              -> True
587
588
589
590
591
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

592
		suffix = myPhaseInputExt next_phase
593
594
595

		-- persistent object files get put in odir
	        persistent_fn 
596
597
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
598

Ian Lynagh's avatar
Ian Lynagh committed
599
		persistent = basename <.> suffix
600

601
		odir_persistent
602
		   | Just loc <- maybe_location = ml_obj_file loc
Ian Lynagh's avatar
Ian Lynagh committed
603
		   | Just d <- odir = d </> persistent
604
605
		   | otherwise      = persistent

606

607
-- -----------------------------------------------------------------------------
608
-- | Each phase in the pipeline returns the next phase to execute, and the
609
610
611
612
613
614
615
-- 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.
616
617
618
619
--
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
620
	 -> HscEnv
621
622
623
	 -> String	-- ^ basename of original input source
	 -> String	-- ^ its extension
	 -> FilePath	-- ^ name of file which contains the input to this phase.
624
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
625
626
627
628
629
630
			-- ^ 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
631

632
633
634
635
	-- 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 

636
637
638
-------------------------------------------------------------------------------
-- Unlit phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
639
runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
640
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
641
       let dflags = hsc_dflags hsc_env
642
       output_fn <- liftIO $ get_output_fn dflags (Cpp sf) maybe_loc
643

644
645
646
647
648
649
650
651
652
653
654
655
       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
                   ]

656
       liftIO $ SysTools.runUnlit dflags flags
657

658
       return (Cpp sf, dflags, maybe_loc, output_fn)
659
660

-------------------------------------------------------------------------------
661
662
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
663

664
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
665
  = do let dflags0 = hsc_dflags hsc_env
666
667
668
669
670
       src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
       (dflags, unhandled_flags, warns)
           <- liftIO $ parseDynamicFlags dflags0 src_opts
       liftIO $ handleFlagWarnings dflags warns  -- XXX: may exit the program
       liftIO $ checkProcessArgsResult unhandled_flags -- XXX: may throw program error
671

672
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
673
674
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
675
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
676
	else do
677
678
	    output_fn <- liftIO $ get_output_fn dflags (HsPp sf) maybe_loc
	    liftIO $ doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
679
	    return (HsPp sf, dflags, maybe_loc, output_fn)
680

sof's avatar
sof committed
681
682
683
-------------------------------------------------------------------------------
-- HsPp phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
684
685
686
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
687
688
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
689
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
690
	else do
691
	    let hspp_opts = getOpts dflags opt_F
Ian Lynagh's avatar
Ian Lynagh committed
692
	    let orig_fn = basename <.> suff
693
694
	    output_fn <- liftIO $ get_output_fn dflags (Hsc sf) maybe_loc
	    liftIO $ SysTools.runPp dflags
695
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
696
697
698
699
700
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
701
	    return (Hsc sf, dflags, maybe_loc, output_fn)
702

703
704
705
-----------------------------------------------------------------------------
-- Hsc phase

706
707
-- 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
708
runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc 
709
 = do	-- normal Hsc mode, not mkdependHS
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
710
        let dflags0 = hsc_dflags hsc_env
711

712
  -- we add the current directory (i.e. the directory in which
713
  -- the .hs files resides) to the include path, since this is
714
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
715
716
717
	let current_dir = case takeDirectory basename of
                      "" -> "." -- XXX Hack
                      d -> d
718
	
719
720
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
721
	
722
  -- gather the imports and module name
723
        (hspp_buf,mod_name,imps,src_imps) <- 
724
            case src_flavour of
725
726
727
                ExtCoreFile -> do  -- no explicit imports in ExtCore input.
                    m <- liftIO $ getCoreModuleName input_fn
                    return (Nothing, mkModuleName m, [], [])
728

729
730
731
732
                _           -> liftIO $ do
                    buf <- hGetStringBuffer input_fn
                    (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
                    return (Just buf, mod_name, imps, src_imps)
733
734
735
736
737
738
739

  -- 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)
740
	location1 <- liftIO $ mkHomeModLocation2 dflags mod_name basename suff
741
742
743
744
745
746
747
748
749

  -- 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
750
751
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
752
753
754
755
756
757
758
		      | 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
759
760
761
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
762
763
764
765
766
767
768
		      = 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.
769
  --
770
  -- Setting source_unchanged to True means that M.o seems
771
772
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
773
  -- Setting source_unchanged to False tells the compiler that M.o is out of
774
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
775
	src_timestamp <- liftIO $ getModificationTime (basename <.> suff)
Simon Marlow's avatar
Simon Marlow committed
776

777
	let force_recomp = dopt Opt_ForceRecomp dflags
778
	source_unchanged <-
779
          if force_recomp || not (isStopLn stop)
780
781
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
782
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
783
784
	     then return False	
		-- Otherwise look at file modification dates
785
	     else do o_file_exists <- liftIO $ doesFileExist o_file
786
		     if not o_file_exists
787
		        then return False	-- Need to recompile
788
			else do t2 <- liftIO $ getModificationTime o_file
789
			        if t2 > src_timestamp
790
791
				  then return True
				  else return False
792

793
  -- get the DynFlags
794
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
795
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
796
	output_fn  <- liftIO $ get_output_fn dflags next_phase (Just location4)
797

798
        let dflags' = dflags { hscTarget = hsc_lang,
799
800
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
801

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

804
  -- Tell the finder cache about this module
805
	mod <- liftIO $ addHomeModuleToFinder hsc_env' mod_name location4
Simon Marlow's avatar
Simon Marlow committed
806
807
808
809
810
811
812
813
814
815
816

  -- 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,
817
818
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
819

820
  -- run the compiler!
821
	result <- hscCompileOneShot hsc_env'
822
823
			  mod_summary source_unchanged 
			  Nothing	-- No iface
824
                          Nothing       -- No "module i of n" progress info
825

826
827
828
	case result of
          HscNoRecomp
              -> do liftIO $ SysTools.touch dflags' "Touching object file" o_file
829
830
831
832
                    -- 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)
833
          (HscRecomp hasStub)
834
              -> do when hasStub $
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
835
                         do stub_o <- compileStub hsc_env' mod location4
836
                            liftIO $ consIORef v_Ld_inputs stub_o
837
838
839
                    -- In the case of hs-boot files, generate a dummy .o-boot 
                    -- stamp file for the benefit of Make
                    when (isHsBoot src_flavour) $
840
                      liftIO $ SysTools.touch dflags' "Touching object file" o_file
841
                    return (next_phase, dflags', Just location4, output_fn)
842

843
844
845
-----------------------------------------------------------------------------
-- Cmm phase

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
846
runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
847
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
848
       let dflags = hsc_dflags hsc_env
849
850
       output_fn <- liftIO $ get_output_fn dflags Cmm maybe_loc
       liftIO $ doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
851
       return (Cmm, dflags, maybe_loc, output_fn)
852

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
853
runPhase Cmm stop hsc_env basename _ input_fn get_output_fn maybe_loc
854
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
855
        let dflags = hsc_dflags hsc_env
856
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
857
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
858
	output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
859

860
        let dflags' = dflags { hscTarget = hsc_lang,
861
862
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
863
        let hsc_env' = hsc_env {hsc_dflags = dflags'}
864

865
	hscCmmFile hsc_env' input_fn
866

867
868
869
870
        -- XXX: catch errors above and convert them into ghcError?  Original
        -- code was:
        --
	--when (not ok) $ ghcError (PhaseFailed "cmm" (ExitFailure 1))
871

872
	return (next_phase, dflags, maybe_loc, output_fn)
873

874
875
876
877
878
879
-----------------------------------------------------------------------------
-- Cc phase

-- we don't support preprocessing .c files (with -E) now.  Doing so introduces
-- way too many hacks, and I can't say I've ever used it anyway.

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
880
runPhase cc_phase _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
881
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
882
883
   = do	let dflags = hsc_dflags hsc_env
        let cc_opts = getOpts dflags opt_c
884
	    hcc = cc_phase `eqPhase` HCc
885

886