DriverPipeline.hs 50.9 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
   staticLink,
16

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

rrt's avatar
rrt committed
22
        -- DLL building
23
24
   doMkDLL,

25
26
   getOptionsFromStringBuffer,	-- used in module GHC
   optionsErrorMsgs,	  	-- ditto
27
28
29
30
  ) where

#include "HsVersions.h"

31
import Packages
32
import GetImports
33
import DriverPhases
sof's avatar
sof committed
34
import SysTools		( newTempName, addFilesToClean, getSysMan, copy )
35
import qualified SysTools	
36
import HscMain
37
import Finder
38
39
40
import HscTypes
import Outputable
import Module
41
import ErrUtils
42
43
import DynFlags
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
44
import Config
45
import Panic
46
import Util
47
import StringBuffer	( hGetStringBuffer )
48
import BasicTypes	( SuccessFlag(..) )
49
import Maybes		( expectJust )
50
import Ctype		( is_ident )
51
52
import StringBuffer	( StringBuffer(..), lexemeToString )
import ParserCoreUtils	( getCoreModuleName )
53
54
55
import SrcLoc		( srcLocSpan, mkSrcLoc )
import FastString	( mkFastString )
import Bag		( listToBag, emptyBag )
56
import SrcLoc		( Located(..) )
57

58
59
import Distribution.Compiler ( extensionsToGHCFlag )

60
import EXCEPTION
61
import DATA_IOREF	( readIORef, writeIORef, IORef )
62
import GLAEXTS		( Int(..) )
63

64
65
import Directory
import System
66
67
68
69
import IO
import Monad
import Maybe

70

71
72
-- ---------------------------------------------------------------------------
-- Pre-process
73
74
75

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

80
81
82
83
preprocess :: DynFlags -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
preprocess dflags (filename, mb_phase) =
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
  runPipeline anyHsc dflags (filename, mb_phase) Temporary Nothing{-no ModLocation-}
84

85
86
-- ---------------------------------------------------------------------------
-- Compile
87
88
89
90
91
92
93
94
95
96

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

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

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

109
   | CompErrs 
110
111


112
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
113

114
   let dflags0     = hsc_dflags hsc_env
115
116
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
117

118
119
120
121
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

122
   showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
123

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

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

130
131
132
   -- Add in the OPTIONS from the source file
   -- This is nasty: we've done this once already, in the compilation manager
   -- It might be better to cache the flags in the ml_hspp_file field,say
133
   let hspp_buf = expectJust "compile:hspp_buf" (ms_hspp_buf mod_summary)
134
       opts = getOptionsFromStringBuffer hspp_buf input_fn
135
136
   (dflags1,unhandled_flags) <- parseDynamicFlags dflags0 (map snd opts)
   if (not (null unhandled_flags))
137
	then do printErrorsAndWarnings dflags1 (optionsErrorMsgs unhandled_flags opts input_fn)
138
139
		return CompErrs
	else do
140

141
   let (basename, _) = splitFilename input_fn
142

143
144
145
146
  -- 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
147
148
       old_paths   = includePaths dflags1
       dflags      = dflags1 { includePaths = current_dir : old_paths }
149

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

158
   let dflags' = dflags { hscTarget = hsc_lang,
159
				hscOutName = output_fn,
160
161
162
163
164
				hscStubCOutName = basename ++ "_stub.c",
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
165
   let do_recomp = dopt Opt_RecompChecking dflags
166
       source_unchanged = isJust maybe_old_linkable && do_recomp
167
       hsc_env' = hsc_env { hsc_dflags = dflags' }
168
       object_filename = ml_obj_file location
169
170

   -- run the compiler
171
   hsc_result <- hscMain hsc_env' mod_summary
172
			 source_unchanged have_object old_iface
173
                         (Just (mod_index, nmods))
174
175

   case hsc_result of
176
      HscFail -> return CompErrs
177

178
179
180
      HscNoRecomp details iface -> 
	  ASSERT(isJust maybe_old_linkable)
	  return (CompOK details iface maybe_old_linkable)
181

182
      HscRecomp details iface stub_h_exists stub_c_exists maybe_interpreted_code 
183
184

	| isHsBoot src_flavour	-- No further compilation to do
185
186
187
188
189
	-> do	case hsc_lang of
		   HscInterpreted -> return ()
		   _other -> SysTools.touch dflags' "Touching object file" 
					    object_filename
		return (CompOK details iface Nothing)
190

191
	| otherwise	-- Normal source file
192
	-> do
193
194
195
196
197
198
	   stub_unlinked <-
	     if stub_c_exists then do
		stub_o <- compileStub dflags' object_filename
		return [ DotO stub_o ]
	     else
		return []
199
200
201
202
203
204

	   (hs_unlinked, unlinked_time) <-
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
205
206
		HscInterpreted
		  -> case maybe_interpreted_code of
207
#ifdef GHCI
208
		       Just comp_bc -> return ([BCOs comp_bc], ms_hs_date mod_summary)
209
210
211
212
213
214
			-- 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.
215
216
217
#endif
		       Nothing -> panic "compile: no interpreted code"

218
219
220
		HscNothing
		  -> return ([], ms_hs_date mod_summary)

221
222
		-- We're in --make mode: finish the compilation pipeline.
		_other
223
		  -> do	runPipeline StopLn dflags (output_fn,Nothing) Persistent
224
225
				    (Just location)
				-- The object filename comes from the ModLocation
226

227
228
			o_time <- getModificationTime object_filename
			return ([DotO object_filename], o_time)
229

230
	   let linkable = LM unlinked_time this_mod
231
232
			     (hs_unlinked ++ stub_unlinked)

233
	   return (CompOK details iface (Just linkable))
234

235
-----------------------------------------------------------------------------
236
237
-- stub .h and .c files (for foreign export support)

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
-- The _stub.c file is derived from the haskell source file (but stored
-- in hscStubCOutName in the dflags for some reason, probably historical).
-- 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.

compileStub dflags object_filename = do
	let (o_base, o_ext) = splitFilename object_filename
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

257
258
	-- compile the _stub.c file w/ gcc
	let stub_c = hscStubCOutName dflags
259
260
261
262
	runPipeline StopLn dflags (stub_c,Nothing) 
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
263
264


265
266
-- ---------------------------------------------------------------------------
-- Link
267

268
link :: GhcMode			-- interactive or batch
269
270
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
271
     -> HomePackageTable	-- what to link
272
273
274
275
276
277
278
279
280
281
     -> 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
282
283
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
284
285
286
	 return Succeeded
#endif

287
288
289
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

290
link BatchCompile dflags batch_attempt_linking hpt
291
   | batch_attempt_linking
292
   = do 
293
294
295
296
297
298
299
	let 
	    home_mod_infos = moduleEnvElts hpt

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

	    -- the linkables to link
300
	    linkables = map (fromJust.hm_linkable) home_mod_infos
301

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

304
	-- check for the -no-link flag
305
	if isNoLink (ghcLink dflags)
306
	  then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
307
308
309
	          return Succeeded
	  else do

310
311
312
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

313
314
315
316
317
318
319
320
321
322
323
324
	    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)

	if dopt Opt_RecompChecking dflags && not linking_needed
325
	   then do debugTraceMsg dflags 1 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
326
327
328
		   return Succeeded
	   else do

329
330
	debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
				 <+> text "...")
331

332
	-- Don't showPass in Batch mode; doLink will do that for us.
333
        staticLink dflags obj_files pkg_deps
334

335
        debugTraceMsg dflags 3 (text "link: done")
336
337
338
339
340

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
341
342
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
343
        return Succeeded
344
      
345
346
347
348

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

349
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
350
351
352
353
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

354
355
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
   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
379
			  (src, mb_phase) output Nothing{-no ModLocation-}
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
   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 ()
	StaticLink -> staticLink dflags o_files link_pkgs
	MkDLL      -> doMkDLL dflags o_files link_pkgs
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
    link_pkgs
	  | ExtPackage h98_id <- haskell98PackageId (pkgState dflags) = [h98_id]
	  | otherwise = []


401
402
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
403

404
405
406
407
-- 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.

408
-- The DynFlags can be modified by phases in the pipeline (eg. by
409
410
411
412
413
414
415
416
417
418
419
420
421
-- 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.
422

423
runPipeline
424
425
426
427
428
  :: Phase		        -- When to stop
  -> DynFlags		        -- Dynamic flags
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
429
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
430

431
runPipeline stop_phase dflags (input_fn, mb_phase) output maybe_loc
432
433
  = do
  let (basename, suffix) = splitFilename input_fn
434
435
436
437
438

	-- If we were given a -x flag, then use that phase to start from
      start_phase
	| Just x_phase <- mb_phase = x_phase
	| otherwise                = startPhase suffix
439

440
441
442
443
444
445
  -- 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.
446

447
448
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
449
450
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
451

452
453
454
  -- 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)
  let get_output_fn = getOutputFilename dflags stop_phase output basename
455

456
  -- Execute the pipeline...
457
458
459
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
460

461
  -- Sometimes, a compilation phase doesn't actually generate any output
462
463
464
  -- (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
  -- copy the file.
465
466
467
468
469
470
471
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
	do final_fn <- get_output_fn stop_phase maybe_loc
	   when (final_fn /= output_fn) $
		  copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
472
			++ "'") output_fn final_fn
473
474
	   return (dflags', final_fn)
	        
475
476


477
pipeLoop :: DynFlags -> Phase -> Phase 
478
479
480
481
	 -> FilePath  -> String -> Suffix
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
482

483
pipeLoop dflags phase stop_phase 
484
485
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
486

487
488
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
489

490
  | not (phase `happensBefore` stop_phase)
491
492
493
494
	-- 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 #-}.
495
496
497
498
499
  = 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)
500
		<- runPhase phase stop_phase dflags orig_basename 
501
			    orig_suff input_fn orig_get_output_fn maybe_loc
502
	; pipeLoop dflags' next_phase stop_phase output_fn
503
504
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

505
506
507
508
getOutputFilename
  :: DynFlags -> Phase -> PipelineOutput -> String
  -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename dflags stop_phase output basename
509
510
511
512
513
514
515
516
517
 = func
 where
	hcsuf      = hcSuf dflags
	odir       = outputDir dflags
	osuf       = objectSuf dflags
	keep_hc    = dopt Opt_KeepHcFiles dflags
	keep_raw_s = dopt Opt_KeepRawSFiles dflags
	keep_s     = dopt Opt_KeepSFiles dflags

518
519
520
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
521

522
	func next_phase maybe_location
523
524
525
526
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
527
	   where
528
		is_last_phase = next_phase `eqPhase` stop_phase
529
530
531
532

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

539
		suffix = myPhaseInputExt next_phase
540
541
542

		-- persistent object files get put in odir
	        persistent_fn 
543
544
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
545

546
		persistent = basename `joinFileExt` suffix
547

548
		odir_persistent
549
		   | Just loc <- maybe_location = ml_obj_file loc
550
		   | Just d <- odir = d `joinFileName` persistent
551
552
		   | otherwise      = persistent

553

554
555
556
557
558
559
560
561
562
563
-- -----------------------------------------------------------------------------
-- 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.

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

578
579
580
581
	-- 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 

582
583
584
-------------------------------------------------------------------------------
-- Unlit phase 

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

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

598
       return (Cpp sf, dflags, maybe_loc, output_fn)
599
600

-------------------------------------------------------------------------------
601
602
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
603

604
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
605
  = do src_opts <- getOptionsFromSource input_fn
606
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
607
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
608

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

sof's avatar
sof committed
618
619
620
-------------------------------------------------------------------------------
-- HsPp phase 

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

639
640
641
-----------------------------------------------------------------------------
-- Hsc phase

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

647
648
649
  -- 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.
650
	let current_dir = directoryOf basename
651
	
652
653
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
654
	
655
  -- gather the imports and module name
656
        (hspp_buf,mod_name) <- 
657
658
659
660
661
662
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
			          ; return (Nothing, mkModule m) }

		other -> do { buf <- hGetStringBuffer input_fn
663
			    ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
664
665
666
667
668
669
670
671
			    ; 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)
672
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
673
674
675
676
677
678
679
680
681

  -- 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
682
683
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
684
685
686
687
688
689
690
		      | 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
691
692
693
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
694
695
696
697
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

  -- Make the ModSummary to hand to hscMain
698
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)
699
700
701
702
703
704
705
706
707
	let
	    unused_field = panic "runPhase:ModSummary field"
		-- Some fields are not looked at by hscMain
	    mod_summary = ModSummary {	ms_mod 	     = mod_name, 
					ms_hsc_src   = src_flavour,
				 	ms_hspp_file = Just input_fn,
					ms_hspp_buf  = hspp_buf,
					ms_location  = location4,
					ms_hs_date   = src_timestamp,
sof's avatar
sof committed
708
					ms_obj_date  = Nothing,
709
710
711
712
713
714
715
					ms_imps	     = unused_field,
					ms_srcimps   = unused_field }

	    o_file = ml_obj_file location4 	-- The real object file


  -- Figure out if the source has changed, for recompilation avoidance.
716
  --
717
  -- Setting source_unchanged to True means that M.o seems
718
719
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
720
  -- Setting source_unchanged to False tells the compiler that M.o is out of
721
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
722
	let do_recomp = dopt Opt_RecompChecking dflags
723
	source_unchanged <- 
724
          if not do_recomp || not (isStopLn stop)
725
726
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
727
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
728
729
	     then return False	
		-- Otherwise look at file modification dates
730
	     else do o_file_exists <- doesFileExist o_file
731
		     if not o_file_exists
732
		        then return False	-- Need to recompile
733
			else do t2 <- getModificationTime o_file
734
			        if t2 > src_timestamp
735
736
				  then return True
				  else return False
737

738
  -- get the DynFlags
739
740
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
741
	output_fn  <- get_output_fn next_phase (Just location4)
742

743
        let dflags' = dflags { hscTarget = hsc_lang,
744
745
746
747
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
748

749
	hsc_env <- newHscEnv dflags'
750

751
752
753
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

754
  -- run the compiler!
755
	result <- hscMain hsc_env
756
757
758
			  mod_summary source_unchanged 
			  False		-- No object file
			  Nothing	-- No iface
759
                          Nothing       -- No "module i of n" progress info
760

761
	case result of
762

763
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
764

765
            HscNoRecomp details iface -> do
766
		SysTools.touch dflags' "Touching object file" o_file
767
768
769
			-- 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).
770
		return (StopLn, dflags', Just location4, o_file)
771

772
	    HscRecomp _details _iface 
773
		      stub_h_exists stub_c_exists
774
		      _maybe_interpreted_code -> do
775

776
777
778
		when stub_c_exists $ do
			stub_o <- compileStub dflags' o_file
			consIORef v_Ld_inputs stub_o
779
780
781
782
783
784
785
786

		-- In the case of hs-boot files, generate a dummy .o-boot 
		-- stamp file for the benefit of Make
		case src_flavour of
		  HsBootFile -> SysTools.touch dflags' "Touching object file" o_file
		  other	     -> return ()

		return (next_phase, dflags', Just location4, output_fn)
787

788
789
790
-----------------------------------------------------------------------------
-- Cmm phase

791
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
792
793
  = do
       output_fn <- get_output_fn Cmm maybe_loc
794
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
795
       return (Cmm, dflags, maybe_loc, output_fn)
796

797
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
798
  = do
799
800
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
801
802
	output_fn <- get_output_fn next_phase maybe_loc

803
        let dflags' = dflags { hscTarget = hsc_lang,
804
805
806
807
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
808

809
	ok <- hscCmmFile dflags' input_fn
810
811
812

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

813
	return (next_phase, dflags, maybe_loc, output_fn)
814

815
816
817
818
819
820
-----------------------------------------------------------------------------
-- 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.

821
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
822
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
823
   = do	let cc_opts = getOpts dflags opt_c
824
	    hcc = cc_phase `eqPhase` HCc
825

826
       	let cmdline_include_paths = includePaths dflags
827

828
829
830
831
832
833
	-- 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 :)
834
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
835
836
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
837

838
839
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
840

841
        let verb = getVerbFlag dflags
842

843
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
844

845
846
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
847
		      | otherwise         = [ ]
848

849
	let excessPrecision = dopt Opt_ExcessPrecision dflags
850

851
	-- Decide next phase
852
853
854
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
855
856
857
858
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

859
860
861
862
863
864
	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.
			[ SysTools.Option "-x", SysTools.Option "c"] ++
865
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
866
			, SysTools.Option "-o"
sof's avatar
sof committed
867
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
868
869
870
			]
		       ++ map SysTools.Option (
		          md_c_flags
871
                       ++ pic_c_flags
872
		       ++ (if hcc && mangle
873
874
		  	     then md_regd_c_flags
		  	     else [])
875
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
876
877
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
878
		       ++ split_opt
879
880
881
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
882
		       ))
883

884
	return (next_phase, dflags, maybe_loc, output_fn)
885
886
887
888
889
890

	-- ToDo: postprocess the output from gcc

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

891
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
892
   = do let mangler_opts = getOpts dflags opt_m
893
894
895
896
897
898

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

900
901
	let split = dopt Opt_SplitObjs dflags
            next_phase
902
903
		| split = SplitMangle
		| otherwise = As
904
	output_fn <- get_output_fn next_phase maybe_loc
905

906
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
907
908
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
909
910
			     ]
			  ++ map SysTools.Option machdep_opts)
911

912
	return (next_phase, dflags, maybe_loc, output_fn)
913
914
915
916

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

917
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
918
919
  = 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)
920
	split_s_prefix <- SysTools.newTempName dflags "split"
921
	let n_files_fn = split_s_prefix
922

923
924
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
925
926
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
927
			  ]
928
929
930
931
932
933
934
935
936

	-- Save the number of split files for future references
	s <- readFile n_files_fn
	let n_files = read s :: Int
	writeIORef v_Split_info (split_s_prefix, n_files)

	-- Remember to delete all these files
	addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
			| n <- [1..n_files]]
937

938
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
939
	  -- we don't use the filename
940
941
942
943

-----------------------------------------------------------------------------
-- As phase

944
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
simonmar's avatar