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

module DriverPipeline (
10
11
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
12
   oneShot, compileFile,
13

14
	-- Interfaces for the batch-mode driver
15
   linkBinary,
16

17
18
19
20
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
   compile, CompResult(..), 
   link, 
21

22
23
24
25
  ) where

#include "HsVersions.h"

26
import Packages
27
import HeaderInfo
28
import DriverPhases
29
import SysTools
30
import HscMain
31
import Finder
32
33
34
import HscTypes
import Outputable
import Module
Simon Marlow's avatar
Simon Marlow committed
35
import UniqFM		( eltsUFM )
36
import ErrUtils
37
38
import DynFlags
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
39
import Config
40
import Panic
41
import Util
42
import StringBuffer	( hGetStringBuffer )
43
import BasicTypes	( SuccessFlag(..) )
44
import Maybes		( expectJust )
45
import ParserCoreUtils	( getCoreModuleName )
46
import SrcLoc		( unLoc )
47
import SrcLoc		( Located(..) )
48

Simon Marlow's avatar
Simon Marlow committed
49
50
51
52
53
54
55
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
56
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
57
58
59
import Data.Maybe
import System.Exit
import System.Environment
60

61
62
-- ---------------------------------------------------------------------------
-- Pre-process
63
64
65

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

70
71
72
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
73
74
  runPipeline anyHsc dflags (filename, mb_phase) 
        Nothing Temporary Nothing{-no ModLocation-}
75

76
77
-- ---------------------------------------------------------------------------
-- Compile
78
79
80
81
82
83
84
85
86
87

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

88
compile :: HscEnv
89
	-> ModSummary
90
	-> Maybe Linkable	-- Just linkable <=> source unchanged
91
        -> Maybe ModIface       -- Old interface, if available
92
        -> Int -> Int
93
94
95
        -> IO CompResult

data CompResult
96
97
98
   = CompOK   ModDetails 	-- New details
              ModIface		-- New iface
              (Maybe Linkable)	-- a Maybe, for the same reasons as hm_linkable
99

100
   | CompErrs 
101
102


103
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
104

105
   let dflags0     = ms_hspp_opts mod_summary
106
107
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
108

109
110
111
112
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

113
114
   -- 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)
115

116
   let location	  = ms_location mod_summary
117
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
118
   let input_fnpp = ms_hspp_file mod_summary
119

120
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
121

122
   let (basename, _) = splitFilename input_fn
123

124
125
126
127
  -- 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
128
129
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
130

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

139
   let dflags' = dflags { hscTarget = hsc_lang,
140
				hscOutName = output_fn,
141
142
143
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
144
145
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
146
       hsc_env' = hsc_env { hsc_dflags = dflags' }
147
       object_filename = ml_obj_file location
148

149
150
151
152
153
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

154
       handleBatch (HscNoRecomp, iface, details)
155
156
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
157
       handleBatch (HscRecomp hasStub, iface, details)
158
159
160
161
162
163
164
165
166
167
           | isHsBoot src_flavour
               = return (CompOK details iface Nothing)
           | 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
168
169
170
                            -> do runPipeline StopLn dflags (output_fn,Nothing)
                                              (Just basename)
                                              Persistent
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
                                              (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
198
                                     source_unchanged old_iface
199
200
201
202
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
203
   -- run the compiler
204
205
206
207
   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
208
209
     HscNothing
         -> runCompiler hscCompileNothing handleBatch
210
     _other
211
         -> runCompiler hscCompileBatch handleBatch
212

213
-----------------------------------------------------------------------------
214
215
-- stub .h and .c files (for foreign export support)

216
217
218
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
219
220
221
222
223
224
225
226
227
228
229
230
231
-- 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.

232
233
234
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
	let (o_base, o_ext) = splitFilename (ml_obj_file location)
235
236
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

237
	-- compile the _stub.c file w/ gcc
Simon Marlow's avatar
Simon Marlow committed
238
	let (stub_c,_) = mkStubPaths dflags (moduleName mod) location
Simon Marlow's avatar
Simon Marlow committed
239
	runPipeline StopLn dflags (stub_c,Nothing)  Nothing
240
241
242
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
243
244


245
246
-- ---------------------------------------------------------------------------
-- Link
247

248
link :: GhcLink			-- interactive or batch
249
250
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
251
     -> HomePackageTable	-- what to link
252
253
254
255
256
257
258
259
260
261
     -> 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
262
link LinkInMemory dflags batch_attempt_linking hpt
263
    = do -- Not Linking...(demand linker will do the job)
264
265
266
	 return Succeeded
#endif

267
link NoLink dflags batch_attempt_linking hpt
268
269
   = return Succeeded

270
link LinkBinary dflags batch_attempt_linking hpt
271
   | batch_attempt_linking
272
   = do 
273
	let 
Simon Marlow's avatar
Simon Marlow committed
274
	    home_mod_infos = eltsUFM hpt
275
276
277
278
279

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

	    -- the linkables to link
280
	    linkables = map (expectJust "link".hm_linkable) home_mod_infos
281

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

284
	-- check for the -no-link flag
285
	if isNoLink (ghcLink dflags)
286
	  then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
287
288
289
	          return Succeeded
	  else do

290
291
292
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

293
294
295
296
297
298
299
300
301
302
303
	    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)

304
	if not (dopt Opt_ForceRecomp dflags) && not linking_needed
305
	   then do debugTraceMsg dflags 2 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
306
307
308
		   return Succeeded
	   else do

309
310
	debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
				 <+> text "...")
311

312
	-- Don't showPass in Batch mode; doLink will do that for us.
313
	let link = case ghcLink dflags of
314
315
	        LinkBinary  -> linkBinary
	        LinkDynLib  -> linkDynLib
316
	link dflags obj_files pkg_deps
317

318
        debugTraceMsg dflags 3 (text "link: done")
319

320
	-- linkBinary only returns if it succeeds
321
322
323
        return Succeeded

   | otherwise
324
325
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
326
        return Succeeded
327
      
328
329
330
331

-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

332
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
333
334
335
336
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

337
338
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
   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
362
363
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
364
365
366
367
368
369
370
371
372
373
374
   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 ()
375
376
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
377
378
379
  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
380
    link_pkgs = [haskell98PackageId]
381
382


383
384
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
385

386
387
388
389
-- 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.

390
-- The DynFlags can be modified by phases in the pipeline (eg. by
391
392
393
394
395
396
397
398
399
400
401
402
403
-- 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.
404

405
runPipeline
406
407
408
  :: Phase		        -- When to stop
  -> DynFlags		        -- Dynamic flags
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
Simon Marlow's avatar
Simon Marlow committed
409
  -> Maybe FilePath             -- original basename (if different from ^^^)
410
411
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
412
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
413

Simon Marlow's avatar
Simon Marlow committed
414
runPipeline stop_phase dflags (input_fn, mb_phase) mb_basename output maybe_loc
415
  = do
Simon Marlow's avatar
Simon Marlow committed
416
417
418
  let (input_basename, suffix) = splitFilename input_fn
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
419
420

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

423
424
425
426
427
428
  -- 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.
429

430
431
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
432
433
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
434

435
436
  -- 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)
437
  let get_output_fn = getOutputFilename stop_phase output basename
438

439
  -- Execute the pipeline...
440
441
442
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
443

444
  -- Sometimes, a compilation phase doesn't actually generate any output
445
446
  -- (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
447
448
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
449
450
451
452
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
453
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
454
455
456
457
	   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
458
	   return (dflags', final_fn)
459

460
461


462
pipeLoop :: DynFlags -> Phase -> Phase 
463
	 -> FilePath  -> String -> Suffix
464
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
465
466
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
467

468
pipeLoop dflags phase stop_phase 
469
470
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
471

472
473
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
474

475
  | not (phase `happensBefore` stop_phase)
476
477
478
479
	-- 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 #-}.
480
481
482
483
484
  = 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)
485
		<- runPhase phase stop_phase dflags orig_basename 
486
			    orig_suff input_fn orig_get_output_fn maybe_loc
487
	; pipeLoop dflags' next_phase stop_phase output_fn
488
489
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

490
getOutputFilename
491
492
493
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
494
495
 = func
 where
496
	func dflags next_phase maybe_location
497
498
499
500
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
501
	   where
502
503
504
505
506
507
508
509
510
511
512
		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

513
		is_last_phase = next_phase `eqPhase` stop_phase
514
515
516
517

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
518
     			     StopLn              -> True
519
520
521
522
523
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

524
		suffix = myPhaseInputExt next_phase
525
526
527

		-- persistent object files get put in odir
	        persistent_fn 
528
529
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
530

531
		persistent = basename `joinFileExt` suffix
532

533
		odir_persistent
534
		   | Just loc <- maybe_location = ml_obj_file loc
535
		   | Just d <- odir = d `joinFileName` persistent
536
537
		   | otherwise      = persistent

538

539
540
541
542
543
544
545
546
547
548
-- -----------------------------------------------------------------------------
-- 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.

549
550
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
551
552
553
554
	 -> DynFlags
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
555
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
556
			-- how to calculate the output filename
557
	 -> Maybe ModLocation		-- the ModLocation, if we have one
558
	 -> IO (Phase,	  		-- next phase
559
560
561
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
562

563
564
565
566
	-- 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 

567
568
569
-------------------------------------------------------------------------------
-- Unlit phase 

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

575
576
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
577
578
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
579
580
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
581
			  ])
582

583
       return (Cpp sf, dflags, maybe_loc, output_fn)
584
585

-------------------------------------------------------------------------------
586
587
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
588

589
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
590
591
  = do src_opts <- getOptionsFromFile input_fn
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
592
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
593

594
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
595
596
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
597
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
598
	else do
599
	    output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
600
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
601
	    return (HsPp sf, dflags, maybe_loc, output_fn)
602

sof's avatar
sof committed
603
604
605
-------------------------------------------------------------------------------
-- HsPp phase 

606
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
607
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
608
609
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
610
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
611
	else do
612
	    let hspp_opts = getOpts dflags opt_F
613
	    let orig_fn = basename `joinFileExt` suff
614
	    output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
615
616
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
617
618
619
620
621
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
622
	    return (Hsc sf, dflags, maybe_loc, output_fn)
623

624
625
626
-----------------------------------------------------------------------------
-- Hsc phase

627
628
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
629
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
630
 = do	-- normal Hsc mode, not mkdependHS
631

632
633
634
  -- 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.
635
	let current_dir = directoryOf basename
636
	
637
638
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
639
	
640
  -- gather the imports and module name
641
        (hspp_buf,mod_name) <- 
642
643
644
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
Simon Marlow's avatar
Simon Marlow committed
645
			          ; return (Nothing, mkModuleName m) }
646
647

		other -> do { buf <- hGetStringBuffer input_fn
648
			    ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
649
650
651
652
653
654
655
656
			    ; return (Just buf, mod_name) }

  -- 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)
657
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
658
659
660
661
662
663
664
665
666

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

694
	let force_recomp = dopt Opt_ForceRecomp dflags
695
	source_unchanged <- 
696
          if force_recomp || not (isStopLn stop)
697
698
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
699
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
700
701
	     then return False	
		-- Otherwise look at file modification dates
702
	     else do o_file_exists <- doesFileExist o_file
703
		     if not o_file_exists
704
		        then return False	-- Need to recompile
705
			else do t2 <- getModificationTime o_file
706
			        if t2 > src_timestamp
707
708
				  then return True
				  else return False
709

710
  -- get the DynFlags
711
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
712
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
713
	output_fn  <- get_output_fn dflags next_phase (Just location4)
714

715
        let dflags' = dflags { hscTarget = hsc_lang,
716
717
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
718

719
	hsc_env <- newHscEnv dflags'
720

721
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
	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,
					ms_imps	     = unused_field,
					ms_srcimps   = unused_field }
738

739
  -- run the compiler!
740
	mbResult <- hscCompileOneShot hsc_env
741
742
			  mod_summary source_unchanged 
			  Nothing	-- No iface
743
                          Nothing       -- No "module i of n" progress info
744

745
746
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
747
          Just HscNoRecomp
748
749
750
751
752
              -> 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)
753
          Just (HscRecomp hasStub)
754
              -> do when hasStub $
Simon Marlow's avatar
Simon Marlow committed
755
                         do stub_o <- compileStub dflags' mod location4
756
757
758
759
760
761
                            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)
762

763
764
765
-----------------------------------------------------------------------------
-- Cmm phase

766
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
767
  = do
768
       output_fn <- get_output_fn dflags Cmm maybe_loc
769
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
770
       return (Cmm, dflags, maybe_loc, output_fn)
771

772
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
773
  = do
774
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
775
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
776
	output_fn <- get_output_fn dflags next_phase maybe_loc
777

778
        let dflags' = dflags { hscTarget = hsc_lang,
779
780
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
781

782
	ok <- hscCmmFile dflags' input_fn
783
784
785

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

786
	return (next_phase, dflags, maybe_loc, output_fn)
787

788
789
790
791
792
793
-----------------------------------------------------------------------------
-- 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.

794
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
795
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
796
   = do	let cc_opts = getOpts dflags opt_c
797
	    hcc = cc_phase `eqPhase` HCc
798

799
       	let cmdline_include_paths = includePaths dflags
800

801
802
803
804
805
806
	-- 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 :)
807
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
808
809
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
810

811
812
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
813

814
        let verb = getVerbFlag dflags
815

816
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
817

818
819
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
820
		      | otherwise         = [ ]
821

822
	let excessPrecision = dopt Opt_ExcessPrecision dflags
823

Simon Marlow's avatar
Simon Marlow committed
824
825
826
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

827
	-- Decide next phase
828
829
830
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
831
832
		| hcc && mangle     = Mangle
		| otherwise         = As
833
	output_fn <- get_output_fn dflags next_phase maybe_loc
834

835
836
	let
	  more_hcc_opts =
837
#if i386_TARGET_ARCH
838
839
840
841
842
843
844
845
846
847
848
849
850
851
	   	-- 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"]



852
853
854
855
856
	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.
857
858
			[ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
                                                then SysTools.Option "c++" else SysTools.Option "c"] ++
859
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
860
			, SysTools.Option "-o"
sof's avatar
sof committed
861
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
862
863
864
			]
		       ++ map SysTools.Option (
		          md_c_flags
865
                       ++ pic_c_flags
866
867
868
869
870
871
872
873
874
#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
875
		       ++ (if hcc && mangle
876
877
		  	     then md_regd_c_flags
		  	     else [])
878
879
880
		       ++ (if hcc 
			     then more_hcc_opts
			     else [])
Simon Marlow's avatar
Simon Marlow committed
881
		       ++ [ verb, "-S", "-Wimplicit", cc_opt ]
882
883
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
884
		       ++ split_opt
885
886
		       ++ include_paths
		       ++ pkg_extra_cc_opts
887
888
889
890
#ifdef HAVE_GCC_HAS_WRAPV
                  -- We need consistent integer overflow (trac #952)
               ++ ["-fwrapv"]
#endif
sof's avatar
sof committed
891
		       ))
892

893
	return (next_phase, dflags, maybe_loc, output_fn)
894
895
896
897
898
899

	-- ToDo: postprocess the output from gcc

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

900
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
901
   = do let mangler_opts = getOpts dflags opt_m
902
903
904
905
906
907

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

909
910
	let split = dopt Opt_SplitObjs dflags
            next_phase
911
912
		| split = SplitMangle
		| otherwise = As
913
	output_fn <- get_output_fn dflags next_phase maybe_loc
914

915
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
916
917
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
918
919
			     ]
			  ++ map SysTools.Option machdep_opts)
920

921
	return (next_phase, dflags, maybe_loc, output_fn)
922
923
924
925

-----------------------------------------------------------------------------
-- Splitting phase

926
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
927
928
  = do  -- tmp_pfx is the prefix used for the split .s files
	-- We also use it as the file to contain the no. of split .s files (sigh)
929
	split_s_prefix <- SysTools.newTempName dflags "split"
930
	let n_files_fn = split_s_prefix
931

932
933
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
934
935
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn