DriverPipeline.hs 56.3 KB
Newer Older
1
2
3
4
-----------------------------------------------------------------------------
--
-- GHC Driver
--
5
-- (c) The University of Glasgow 2005
6
7
8
--
-----------------------------------------------------------------------------

9
{-# OPTIONS -w #-}
10
11
12
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
Ian Lynagh's avatar
Ian Lynagh committed
13
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
14
15
-- for details

16
module DriverPipeline (
17
18
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
19
   oneShot, compileFile,
20

21
	-- Interfaces for the batch-mode driver
22
   linkBinary,
23

24
25
26
27
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
   compile, CompResult(..), 
   link, 
28

29
30
31
32
  ) where

#include "HsVersions.h"

33
import Packages
34
import HeaderInfo
35
import DriverPhases
36
import SysTools
37
import HscMain
38
import Finder
39
40
41
import HscTypes
import Outputable
import Module
Simon Marlow's avatar
Simon Marlow committed
42
import UniqFM		( eltsUFM )
43
import ErrUtils
44
import DynFlags
45
import StaticFlags	( v_Ld_inputs, opt_Static, opt_HardwireLibPaths, WayName(..) )
46
import Config
47
import Panic
48
import Util
49
import StringBuffer	( hGetStringBuffer )
50
import BasicTypes	( SuccessFlag(..) )
51
import Maybes		( expectJust )
52
import ParserCoreUtils	( getCoreModuleName )
53
import SrcLoc		( unLoc )
54
import SrcLoc		( Located(..) )
55

Simon Marlow's avatar
Simon Marlow committed
56
57
58
59
60
61
62
import Control.Exception as Exception
import Data.IORef	( readIORef, writeIORef, IORef )
import GHC.Exts		( Int(..) )
import System.Directory
import System.IO
import SYSTEM_IO_ERROR as IO
import Control.Monad
63
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
64
65
66
import Data.Maybe
import System.Exit
import System.Environment
67

68
69
-- ---------------------------------------------------------------------------
-- Pre-process
70
71
72

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

77
78
79
preprocess :: DynFlags -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
preprocess dflags (filename, mb_phase) =
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
Simon Marlow's avatar
Simon Marlow committed
80
81
  runPipeline anyHsc dflags (filename, mb_phase) 
        Nothing Temporary Nothing{-no ModLocation-}
82

83
84
-- ---------------------------------------------------------------------------
-- Compile
85
86
87
88
89
90
91
92
93
94

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

-- NB.  No old interface can also mean that the source has changed.

95
compile :: HscEnv
96
	-> ModSummary
97
	-> Maybe Linkable	-- Just linkable <=> source unchanged
98
        -> Maybe ModIface       -- Old interface, if available
99
        -> Int -> Int
100
101
102
        -> IO CompResult

data CompResult
103
104
105
   = CompOK   ModDetails 	-- New details
              ModIface		-- New iface
              (Maybe Linkable)	-- a Maybe, for the same reasons as hm_linkable
106

107
   | CompErrs 
108
109


110
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
111

112
   let dflags0     = ms_hspp_opts mod_summary
113
114
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
115

116
117
118
119
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

120
121
   -- FIXME: We need to know whether or not we're recompiling the file. Move this to HscMain?
   --showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
122

123
   let location	  = ms_location mod_summary
124
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
125
   let input_fnpp = ms_hspp_file mod_summary
126

127
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
128

129
   let (basename, _) = splitFilename input_fn
130

131
132
133
134
  -- 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.
   let current_dir = directoryOf basename
135
136
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
137

138
   -- Figure out what lang we're generating
139
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
140
   -- ... and what the next phase should be
141
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
142
   -- ... and what file to generate the output into
143
144
   output_fn <- getOutputFilename next_phase 
			Temporary basename dflags next_phase (Just location)
145

146
   let dflags' = dflags { hscTarget = hsc_lang,
147
				hscOutName = output_fn,
148
149
150
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
151
152
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
153
       hsc_env' = hsc_env { hsc_dflags = dflags' }
154
       object_filename = ml_obj_file location
155

156
157
158
159
160
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

161
       handleBatch (HscNoRecomp, iface, details)
162
163
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
164
       handleBatch (HscRecomp hasStub, iface, details)
165
           | isHsBoot src_flavour
166
167
168
               = do SysTools.touch dflags' "Touching object file"
                                   object_filename
                    return (CompOK details iface Nothing)
169
170
171
172
173
174
175
176
           | otherwise
               = do stub_unlinked <- getStubLinkable hasStub
                    (hs_unlinked, unlinked_time) <-
                        case hsc_lang of
                          HscNothing
                            -> return ([], ms_hs_date mod_summary)
                          -- We're in --make mode: finish the compilation pipeline.
                          _other
Simon Marlow's avatar
Simon Marlow committed
177
178
179
                            -> do runPipeline StopLn dflags (output_fn,Nothing)
                                              (Just basename)
                                              Persistent
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
                                              (Just location)
                                  -- The object filename comes from the ModLocation
                                  o_time <- getModificationTime object_filename
                                  return ([DotO object_filename], o_time)
                    let linkable = LM unlinked_time this_mod
			           (hs_unlinked ++ stub_unlinked)
                    return (CompOK details iface (Just linkable))

       handleInterpreted (InteractiveNoRecomp, iface, details)
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
       handleInterpreted (InteractiveRecomp hasStub comp_bc, iface, details)
           = do stub_unlinked <- getStubLinkable hasStub
                let hs_unlinked = [BCOs comp_bc]
                    unlinked_time = ms_hs_date mod_summary
                  -- Why do we use the timestamp of the source file here,
                  -- rather than the current time?  This works better in
                  -- the case where the local clock is out of sync
                  -- with the filesystem's clock.  It's just as accurate:
                  -- if the source is modified, then the linkable will
                  -- be out of date.
                let linkable = LM unlinked_time this_mod
                               (hs_unlinked ++ stub_unlinked)
                return (CompOK details iface (Just linkable))

   let runCompiler compiler handle
           = do mbResult <- compiler hsc_env' mod_summary
207
                                     source_unchanged old_iface
208
209
210
211
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
212
   -- run the compiler
213
214
215
216
   case hsc_lang of
     HscInterpreted | not (isHsBoot src_flavour) -- We can't compile boot files to
                                                 -- bytecode so don't even try.
         -> runCompiler hscCompileInteractive handleInterpreted
217
218
     HscNothing
         -> runCompiler hscCompileNothing handleBatch
219
     _other
220
         -> runCompiler hscCompileBatch handleBatch
221

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

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

241
242
243
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
	let (o_base, o_ext) = splitFilename (ml_obj_file location)
244
245
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

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

	return stub_o
252
253


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

257
link :: GhcLink			-- interactive or batch
258
259
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
260
     -> 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 dflags batch_attempt_linking hpt
272
    = do -- Not Linking...(demand linker will do the job)
273
274
275
	 return Succeeded
#endif

276
link NoLink dflags batch_attempt_linking hpt
277
278
   = return Succeeded

279
link LinkBinary dflags batch_attempt_linking hpt
280
   | batch_attempt_linking
281
   = do 
282
	let 
Simon Marlow's avatar
Simon Marlow committed
283
	    home_mod_infos = eltsUFM hpt
284
285
286
287
288

	    -- the packages we depend on
	    pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos

	    -- the linkables to link
289
	    linkables = map (expectJust "link".hm_linkable) home_mod_infos
290

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

293
	-- check for the -no-link flag
294
	if isNoLink (ghcLink dflags)
295
	  then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
296
297
298
	          return Succeeded
	  else do

299
300
301
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

302
303
304
305
306
307
308
309
310
311
312
	    exe_file = exeFileName dflags

	-- if the modification time on the executable is later than the
	-- modification times on all of the objects, then omit linking
	-- (unless the -no-recomp flag was given).
	e_exe_time <- IO.try $ getModificationTime exe_file
	let linking_needed 
		| Left _  <- e_exe_time = True
		| Right t <- e_exe_time = 
			any (t <) (map linkableTime linkables)

313
	if not (dopt Opt_ForceRecomp dflags) && not linking_needed
314
	   then do debugTraceMsg dflags 2 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
315
316
317
		   return Succeeded
	   else do

318
319
	debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
				 <+> text "...")
320

321
	-- Don't showPass in Batch mode; doLink will do that for us.
322
	let link = case ghcLink dflags of
323
324
	        LinkBinary  -> linkBinary
	        LinkDynLib  -> linkDynLib
325
	link dflags obj_files pkg_deps
326

327
        debugTraceMsg dflags 3 (text "link: done")
328

329
	-- linkBinary only returns if it succeeds
330
331
332
        return Succeeded

   | otherwise
333
334
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
335
        return Succeeded
336
      
337
338
339
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

340
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
341
342
343
344
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

345
346
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
   exists <- doesFileExist src
   when (not exists) $ 
   	throwDyn (CmdLineError ("does not exist: " ++ src))
   
   let
	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
			other      -> stop_phase

   (_, out_file) <- runPipeline stop_phase' dflags
Simon Marlow's avatar
Simon Marlow committed
370
371
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
372
373
374
375
376
377
378
379
380
381
382
   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 ()
383
384
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
385
386
387
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
Simon Marlow's avatar
Simon Marlow committed
388
    link_pkgs = [haskell98PackageId]
389
390


391
392
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
393

394
395
396
397
-- 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.

398
-- The DynFlags can be modified by phases in the pipeline (eg. by
399
400
401
402
403
404
405
406
407
408
409
410
411
-- GHC_OPTIONS pragmas), and the changes affect later phases in the
-- pipeline.

data PipelineOutput 
  = Temporary
	-- output should be to a temporary file: we're going to
	-- run more compilation steps on this output later
  | Persistent
	-- 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.
  | SpecificFile FilePath
	-- the output must go into the specified file.
412

413
runPipeline
414
415
416
  :: Phase		        -- When to stop
  -> DynFlags		        -- Dynamic flags
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
Simon Marlow's avatar
Simon Marlow committed
417
  -> Maybe FilePath             -- original basename (if different from ^^^)
418
419
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
420
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
421

422
runPipeline stop_phase dflags0 (input_fn, mb_phase) mb_basename output maybe_loc
423
  = do
424
425
  let
      (input_basename, suffix) = splitFilename input_fn
Simon Marlow's avatar
Simon Marlow committed
426
427
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
428

429
430
431
      -- Decide where dump files should go based on the pipeline output
      dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }

432
	-- If we were given a -x flag, then use that phase to start from
basvandijk@home.nl's avatar
basvandijk@home.nl committed
433
      start_phase = fromMaybe (startPhase suffix) mb_phase
434

435
436
437
438
439
440
  -- 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.
441

442
443
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
444
445
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
446

447
448
  -- 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)
449
  let get_output_fn = getOutputFilename stop_phase output basename
450

451
  -- Execute the pipeline...
452
453
454
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
455

456
  -- Sometimes, a compilation phase doesn't actually generate any output
457
458
  -- (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
459
460
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
461
462
463
464
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
465
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
466
467
468
469
	   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
470
	   return (dflags', final_fn)
471

472
473


474
pipeLoop :: DynFlags -> Phase -> Phase 
475
	 -> FilePath  -> String -> Suffix
476
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
477
478
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
479

480
pipeLoop dflags phase stop_phase 
481
482
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
483

484
485
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
486

487
  | not (phase `happensBefore` stop_phase)
488
489
490
491
	-- 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 #-}.
492
493
494
495
496
  = panic ("pipeLoop: at phase " ++ show phase ++ 
	   " but I wanted to stop at phase " ++ show stop_phase)

  | otherwise 
  = do	{ (next_phase, dflags', maybe_loc, output_fn)
497
		<- runPhase phase stop_phase dflags orig_basename 
498
			    orig_suff input_fn orig_get_output_fn maybe_loc
499
	; pipeLoop dflags' next_phase stop_phase output_fn
500
501
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

502
getOutputFilename
503
504
505
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
506
507
 = func
 where
508
	func dflags next_phase maybe_location
509
510
511
512
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
513
	   where
514
515
516
517
518
519
520
521
522
523
524
		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

525
		is_last_phase = next_phase `eqPhase` stop_phase
526
527
528
529

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
530
     			     StopLn              -> True
531
532
533
534
535
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

536
		suffix = myPhaseInputExt next_phase
537
538
539

		-- persistent object files get put in odir
	        persistent_fn 
540
541
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
542

543
		persistent = basename `joinFileExt` suffix
544

545
		odir_persistent
546
		   | Just loc <- maybe_location = ml_obj_file loc
547
		   | Just d <- odir = d `joinFileName` persistent
548
549
		   | otherwise      = persistent

550

551
552
553
554
555
556
557
558
559
560
-- -----------------------------------------------------------------------------
-- Each phase in the pipeline returns the next phase to execute, and the
-- 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.

561
562
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
563
564
565
566
	 -> DynFlags
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
567
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
568
			-- how to calculate the output filename
569
	 -> Maybe ModLocation		-- the ModLocation, if we have one
570
	 -> IO (Phase,	  		-- next phase
571
572
573
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
574

575
576
577
578
	-- 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 

579
580
581
-------------------------------------------------------------------------------
-- Unlit phase 

582
runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
583
  = do let unlit_flags = getOpts dflags opt_L
rrt's avatar
rrt committed
584
       -- The -h option passes the file name for unlit to put in a #line directive
585
       output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
586

587
588
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
589
590
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
591
592
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
593
			  ])
594

595
       return (Cpp sf, dflags, maybe_loc, output_fn)
596
597

-------------------------------------------------------------------------------
598
599
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
600

601
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
602
603
  = do src_opts <- getOptionsFromFile input_fn
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
604
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
605

606
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
607
608
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
609
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
610
	else do
611
	    output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
612
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
613
	    return (HsPp sf, dflags, maybe_loc, output_fn)
614

sof's avatar
sof committed
615
616
617
-------------------------------------------------------------------------------
-- HsPp phase 

618
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
619
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
620
621
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
622
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
623
	else do
624
	    let hspp_opts = getOpts dflags opt_F
625
	    let orig_fn = basename `joinFileExt` suff
626
	    output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
627
628
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
629
630
631
632
633
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
634
	    return (Hsc sf, dflags, maybe_loc, output_fn)
635

636
637
638
-----------------------------------------------------------------------------
-- Hsc phase

639
640
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
641
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
642
 = do	-- normal Hsc mode, not mkdependHS
643

644
645
646
  -- we add the current directory (i.e. the directory in which
  -- the .hs files resides) to the import path, since this is
  -- what gcc does, and it's probably what you want.
647
	let current_dir = directoryOf basename
648
	
649
650
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
651
	
652
  -- gather the imports and module name
653
        (hspp_buf,mod_name,imps,src_imps) <- 
654
655
656
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
657
			          ; return (Nothing, mkModuleName m, [], []) }
658
659

		other -> do { buf <- hGetStringBuffer input_fn
660
661
			    ; (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn
			    ; return (Just buf, mod_name, imps, src_imps) }
662
663
664
665
666
667
668

  -- 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)
669
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
670
671
672
673
674
675
676
677
678

  -- 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
679
680
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
681
682
683
684
685
686
687
		      | 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
688
689
690
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
691
692
693
694
695
696
697
		      = 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.
698
  --
699
  -- Setting source_unchanged to True means that M.o seems
700
701
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
702
  -- Setting source_unchanged to False tells the compiler that M.o is out of
703
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Simon Marlow's avatar
Simon Marlow committed
704
705
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)

706
	let force_recomp = dopt Opt_ForceRecomp dflags
707
	source_unchanged <- 
708
          if force_recomp || not (isStopLn stop)
709
710
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
711
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
712
713
	     then return False	
		-- Otherwise look at file modification dates
714
	     else do o_file_exists <- doesFileExist o_file
715
		     if not o_file_exists
716
		        then return False	-- Need to recompile
717
			else do t2 <- getModificationTime o_file
718
			        if t2 > src_timestamp
719
720
				  then return True
				  else return False
721

722
  -- get the DynFlags
723
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
724
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
725
	output_fn  <- get_output_fn dflags next_phase (Just location4)
726

727
        let dflags' = dflags { hscTarget = hsc_lang,
728
729
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
730

731
	hsc_env <- newHscEnv dflags'
732

733
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
734
735
736
737
738
739
740
741
742
743
744
745
746
747
	mod <- addHomeModuleToFinder hsc_env mod_name location4

  -- Make the ModSummary to hand to hscMain
	let
	    unused_field = panic "runPhase:ModSummary field"
		-- Some fields are not looked at by hscMain
	    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,
748
749
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
750

751
  -- run the compiler!
752
	mbResult <- hscCompileOneShot hsc_env
753
754
			  mod_summary source_unchanged 
			  Nothing	-- No iface
755
                          Nothing       -- No "module i of n" progress info
756

757
758
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
759
          Just HscNoRecomp
760
761
762
763
764
              -> do SysTools.touch dflags' "Touching object file" o_file
                    -- 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)
765
          Just (HscRecomp hasStub)
766
              -> do when hasStub $
Simon Marlow's avatar
Simon Marlow committed
767
                         do stub_o <- compileStub dflags' mod location4
768
769
770
771
772
773
                            consIORef v_Ld_inputs stub_o
                    -- In the case of hs-boot files, generate a dummy .o-boot 
                    -- stamp file for the benefit of Make
                    when (isHsBoot src_flavour) $
                      SysTools.touch dflags' "Touching object file" o_file
                    return (next_phase, dflags', Just location4, output_fn)
774

775
776
777
-----------------------------------------------------------------------------
-- Cmm phase

778
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
779
  = do
780
       output_fn <- get_output_fn dflags Cmm maybe_loc
781
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
782
       return (Cmm, dflags, maybe_loc, output_fn)
783

784
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
785
  = do
786
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
787
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
788
	output_fn <- get_output_fn dflags next_phase maybe_loc
789

790
        let dflags' = dflags { hscTarget = hsc_lang,
791
792
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
793

794
	ok <- hscCmmFile dflags' input_fn
795
796
797

	when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))

798
	return (next_phase, dflags, maybe_loc, output_fn)
799

800
801
802
803
804
805
-----------------------------------------------------------------------------
-- 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.

806
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
807
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
808
   = do	let cc_opts = getOpts dflags opt_c
809
	    hcc = cc_phase `eqPhase` HCc
810

811
       	let cmdline_include_paths = includePaths dflags
812

813
814
815
816
817
818
	-- HC files have the dependent packages stamped into them
	pkgs <- if hcc then getHCFilePackages input_fn else return []

	-- add package include paths even if we're just compiling .c
	-- files; this is the Value Add(TM) that using ghc instead of
	-- gcc gives you :)
819
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
820
821
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
822

823
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
824
        gcc_extra_viac_flags <- getExtraViaCOpts dflags
825
        let pic_c_flags = picCCOpts dflags
826

827
        let verb = getVerbFlag dflags
828

829
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
830

831
832
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
833
		      | otherwise         = [ ]
834

835
	let excessPrecision = dopt Opt_ExcessPrecision dflags
836

Simon Marlow's avatar
Simon Marlow committed
837
838
839
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

840
	-- Decide next phase
841
842
843
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
844
845
		| hcc && mangle     = Mangle
		| otherwise         = As
846
	output_fn <- get_output_fn dflags next_phase maybe_loc
847

848
849
	let
	  more_hcc_opts =
850
#if i386_TARGET_ARCH
851
852
853
854
855
856
857
858
859
860
861
862
863
864
	   	-- on x86 the floating point regs have greater precision
	     	-- than a double, which leads to unpredictable results.
		-- By default, we turn this off with -ffloat-store unless
		-- the user specified -fexcess-precision.
		(if excessPrecision then [] else [ "-ffloat-store" ]) ++
#endif
		-- gcc's -fstrict-aliasing allows two accesses to memory
		-- to be considered non-aliasing if they have different types.
		-- This interacts badly with the C code we generate, which is
		-- very weakly typed, being derived from C--.
		["-fno-strict-aliasing"]



865
866
867
868
869
	SysTools.runCc dflags (
		-- force the C compiler to interpret this file as C when
		-- compiling .hc files, by adding the -x c option.
		-- Also useful for plain .c files, just in case GHC saw a 
		-- -x c option.
870
871
			[ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
                                                then SysTools.Option "c++" else SysTools.Option "c"] ++
872
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
873
			, SysTools.Option "-o"
sof's avatar
sof committed
874
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
875
876
877
			]
		       ++ map SysTools.Option (
		          md_c_flags
878
                       ++ pic_c_flags
879
880
881
882
883
884
885
886
887
#ifdef sparc_TARGET_ARCH
        -- We only support SparcV9 and better because V8 lacks an atomic CAS
        -- instruction. Note that the user can still override this
	-- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
	-- regardless of the ordering.
        --
        -- This is a temporary hack.
                       ++ ["-mcpu=v9"]
#endif
888
		       ++ (if hcc && mangle
889
890
		  	     then md_regd_c_flags
		  	     else [])
891
892
893
894
895
896
897
		       ++ (if hcc
		  	     then if mangle 
                                     then gcc_extra_viac_flags
                                     else filter (=="-fwrapv")
                                                gcc_extra_viac_flags
                                -- still want -fwrapv even for unreg'd
		  	     else [])
898
899
900
		       ++ (if hcc 
			     then more_hcc_opts
			     else [])
Simon Marlow's avatar
Simon Marlow committed
901
		       ++ [ verb, "-S", "-Wimplicit", cc_opt ]
902
903
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
904
		       ++ split_opt
905
906
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
907
		       ))
908

909
	return (next_phase, dflags, maybe_loc, output_fn)
910
911
912
913
914
915

	-- ToDo: postprocess the output from gcc

-----------------------------------------------------------------------------
-- Mangle phase

916
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
917
   = do let mangler_opts = getOpts dflags opt_m
918
919
920
921
922
923

#if i386_TARGET_ARCH
        machdep_opts <- return [ show (stolen_x86_regs dflags) ]
#else
	machdep_opts <- return []
#endif
924

925
926
	let split = dopt Opt_SplitObjs dflags
            next_phase
927
928
		| split = SplitMangle
		| otherwise = As
929
	output_fn <- get_output_fn dflags next_phase maybe_loc
930