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

module DriverPipeline (
10
11
12
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
   oneShot,
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 RdrName		( GlobalRdrEnv )
46
import Panic
47
import Util
48
import StringBuffer	( hGetStringBuffer )
49
import BasicTypes	( SuccessFlag(..) )
50
import Maybes		( expectJust )
51
import Ctype		( is_ident )
52
53
import StringBuffer	( StringBuffer(..), lexemeToString )
import ParserCoreUtils	( getCoreModuleName )
54
55
56
import SrcLoc		( srcLocSpan, mkSrcLoc )
import FastString	( mkFastString )
import Bag		( listToBag, emptyBag )
57

58
import EXCEPTION
59
import DATA_IOREF	( readIORef, writeIORef, IORef )
60
import GLAEXTS		( Int(..) )
61

62
63
import Directory
import System
64
65
66
67
import IO
import Monad
import Maybe

68

69
70
-- ---------------------------------------------------------------------------
-- Pre-process
71
72
73

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

78
preprocess :: DynFlags -> FilePath -> IO (DynFlags, FilePath)
79
preprocess dflags filename =
80
  ASSERT2(isHaskellSrcFilename filename, text filename) 
81
  runPipeline anyHsc dflags filename 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
	-> (Messages -> IO ())	-- error message callback
97
	-> ModSummary
98
	-> Maybe Linkable	-- Just linkable <=> source unchanged
99
        -> Maybe ModIface       -- Old interface, if available
100
        -> Int -> Int
101
102
103
        -> IO CompResult

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

108
   | CompErrs 
109
110


111
compile hsc_env msg_act mod_summary maybe_old_linkable old_iface mod_index nmods = do 
112

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

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

121
   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 = expectJust "compile:hspp" (ms_hspp_file mod_summary)
126

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

129
130
131
   -- 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
132
133
   let hspp_buf = expectJust "compile:hspp_buf" (ms_hspp_buf mod_summary)
       opts = getOptionsFromStringBuffer hspp_buf
134
135
136
137
138
   (dflags1,unhandled_flags) <- parseDynamicFlags dflags0 (map snd opts)
   if (not (null unhandled_flags))
	then do msg_act (optionsErrorMsgs unhandled_flags opts input_fn)
		return CompErrs
	else do
139

140
   let (basename, _) = splitFilename input_fn
141

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

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

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

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

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

   case hsc_result of
174
      HscFail -> return CompErrs
175

176
177
178
      HscNoRecomp details iface -> 
	  ASSERT(isJust maybe_old_linkable)
	  return (CompOK details iface maybe_old_linkable)
179

180
      HscRecomp details iface
181
182
183
		stub_h_exists stub_c_exists maybe_interpreted_code 

	| isHsBoot src_flavour	-- No further compilation to do
184
	-> return (CompOK details iface Nothing)
185
186
187

	| otherwise		-- Normal Haskell source files
	-> do
188
	   maybe_stub_o <- compileStub dflags' stub_c_exists
189
190
191
192
193
194
195
196
197
198
199
200
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]

	   (hs_unlinked, unlinked_time) <-
	     case hsc_lang of

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

		-- we're in batch mode: finish the compilation pipeline.
212
213
214
		_other -> do
		   let object_filename = ml_obj_file location

215
216
		   runPipeline StopLn dflags output_fn Persistent
			       (Just location)
217
			-- the object filename comes from the ModLocation
218
219
220

		   o_time <- getModificationTime object_filename
		   return ([DotO object_filename], o_time)
221

222
	   let linkable = LM unlinked_time this_mod
223
224
			     (hs_unlinked ++ stub_unlinked)

225
	   return (CompOK details iface (Just linkable))
226

227
-----------------------------------------------------------------------------
228
229
230
231
232
233
234
-- stub .h and .c files (for foreign export support)

compileStub dflags stub_c_exists
  | not stub_c_exists = return Nothing
  | stub_c_exists = do
	-- compile the _stub.c file w/ gcc
	let stub_c = hscStubCOutName dflags
235
	(_, stub_o) <- runPipeline StopLn dflags
236
			    stub_c Persistent Nothing{-no ModLocation-}
237
238
239
	return (Just stub_o)


240
241
-- ---------------------------------------------------------------------------
-- Link
242

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

262
263
264
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

265
link BatchCompile dflags batch_attempt_linking hpt
266
   | batch_attempt_linking
267
   = do 
268
269
270
271
272
273
274
	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
275
	    linkables = map (fromJust.hm_linkable) home_mod_infos
276

277
278
        debugTraceMsg dflags 3 "link: linkables are ..."
        debugTraceMsg dflags 3 (showSDoc (vcat (map ppr linkables)))
279

280
	-- check for the -no-link flag
281
	if isNoLink (ghcLink dflags)
282
	  then do debugTraceMsg dflags 3 "link(batch): linking omitted (-c flag given)."
283
284
285
	          return Succeeded
	  else do

286
	debugTraceMsg dflags 1 "Linking ..."
287

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

291
	-- Don't showPass in Batch mode; doLink will do that for us.
292
        staticLink dflags obj_files pkg_deps
293

294
        debugTraceMsg dflags 3 "link: done"
295
296
297
298
299

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
300
301
   = do debugTraceMsg dflags 3 "link(batch): upsweep (partially) failed OR"
        debugTraceMsg dflags 3 "   Main.main not exported; not linking."
302
        return Succeeded
303
      
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

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

oneShot :: DynFlags -> Phase -> [String] -> IO ()
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

compileFile :: DynFlags -> Phase -> FilePath -> IO FilePath
compileFile dflags stop_phase src = do
   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
			  src output Nothing{-no ModLocation-}
   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 = []


360
361
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
362

363
364
365
366
-- 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.

367
-- The DynFlags can be modified by phases in the pipeline (eg. by
368
369
370
371
372
373
374
375
376
377
378
379
380
-- 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.
381

382
runPipeline
383
384
385
  :: Phase		-- When to stop
  -> DynFlags		-- Dynamic flags
  -> FilePath 		-- Input filename
386
387
  -> PipelineOutput	-- Output filename
  -> Maybe ModLocation  -- A ModLocation, if this is a Haskell module
388
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
389

390
runPipeline stop_phase dflags input_fn output maybe_loc
391
392
393
  = do
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
394

395
396
397
398
399
400
  -- 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.
401

402
403
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
404
405
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
406

407
408
409
  -- 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
410

411
  -- Execute the pipeline...
412
413
414
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
415

416
  -- Sometimes, a compilation phase doesn't actually generate any output
417
418
419
  -- (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.
420
421
422
423
424
425
426
  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
427
			++ "'") output_fn final_fn
428
429
	   return (dflags', final_fn)
	        
430
431


432
pipeLoop :: DynFlags -> Phase -> Phase 
433
434
435
436
	 -> FilePath  -> String -> Suffix
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
437

438
pipeLoop dflags phase stop_phase 
439
440
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
441

442
443
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
444

445
  | not (phase `happensBefore` stop_phase)
446
447
448
449
	-- 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 #-}.
450
451
452
453
454
  = 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)
455
		<- runPhase phase stop_phase dflags orig_basename 
456
			    orig_suff input_fn orig_get_output_fn maybe_loc
457
	; pipeLoop dflags' next_phase stop_phase output_fn
458
459
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

460
461
462
463
getOutputFilename
  :: DynFlags -> Phase -> PipelineOutput -> String
  -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename dflags stop_phase output basename
464
465
466
467
468
469
470
471
472
 = 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

473
474
475
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
476

477
	func next_phase maybe_location
478
479
480
481
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
482
	   where
483
		is_last_phase = next_phase `eqPhase` stop_phase
484
485
486
487

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
488
     			     StopLn              -> True
489
490
491
492
493
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

494
		suffix = myPhaseInputExt next_phase
495
496
497

		-- persistent object files get put in odir
	        persistent_fn 
498
499
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
500

501
		persistent = basename ++ '.':suffix
502

503
		odir_persistent
504
		   | Just loc <- maybe_location = ml_obj_file loc
505
506
507
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

508

509
510
511
512
513
514
515
516
517
518
-- -----------------------------------------------------------------------------
-- 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.

519
520
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
521
522
523
524
525
	 -> 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)
526
			-- how to calculate the output filename
527
	 -> Maybe ModLocation		-- the ModLocation, if we have one
528
	 -> IO (Phase,	  		-- next phase
529
530
531
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
532

533
534
535
536
	-- 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 

537
538
539
-------------------------------------------------------------------------------
-- Unlit phase 

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

545
546
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
547
548
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
549
550
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
551
			  ])
552

553
       return (Cpp sf, dflags, maybe_loc, output_fn)
554
555

-------------------------------------------------------------------------------
556
557
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
558

559
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
560
  = do src_opts <- getOptionsFromSource input_fn
561
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
562
       checkProcessArgsResult unhandled_flags (basename++'.':suff)
563

564
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
565
566
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
567
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
568
	else do
569
	    output_fn <- get_output_fn (HsPp sf) maybe_loc
570
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
571
	    return (HsPp sf, dflags, maybe_loc, output_fn)
572

sof's avatar
sof committed
573
574
575
-------------------------------------------------------------------------------
-- HsPp phase 

576
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
577
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
578
579
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
580
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
581
	else do
582
	    let hspp_opts = getOpts dflags opt_F
583
	    let orig_fn = basename ++ '.':suff
584
	    output_fn <- get_output_fn (Hsc sf) maybe_loc
585
586
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
587
588
589
590
591
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
592
	    return (Hsc sf, dflags, maybe_loc, output_fn)
593

594
595
596
-----------------------------------------------------------------------------
-- Hsc phase

597
598
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
599
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
600
 = do	-- normal Hsc mode, not mkdependHS
601

602
603
604
  -- 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.
605
	let current_dir = directoryOf basename
606
	
607
608
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
609
	
610
  -- gather the imports and module name
611
        (hspp_buf,mod_name) <- 
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
            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
			    ; (_,_,mod_name) <- getImports dflags buf input_fn
			    ; 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)
627
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
628
629
630
631
632
633
634
635
636

  -- 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
637
638
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
639
640
641
642
643
644
645
		      | 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
646
647
648
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
649
650
651
652
653
654
655
656
657
658
659
660
661
662
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

  -- Make the ModSummary to hand to hscMain
	src_timestamp <- getModificationTime (basename ++ '.':suff)
	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
663
					ms_obj_date  = Nothing,
664
665
666
667
668
669
670
					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.
671
  --
672
  -- Setting source_unchanged to True means that M.o seems
673
674
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
675
  -- Setting source_unchanged to False tells the compiler that M.o is out of
676
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
677
	let do_recomp = dopt Opt_RecompChecking dflags
678
	source_unchanged <- 
679
          if not do_recomp || not (isStopLn stop)
680
681
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
682
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
683
684
	     then return False	
		-- Otherwise look at file modification dates
685
	     else do o_file_exists <- doesFileExist o_file
686
		     if not o_file_exists
687
		        then return False	-- Need to recompile
688
			else do t2 <- getModificationTime o_file
689
			        if t2 > src_timestamp
690
691
				  then return True
				  else return False
692

693
  -- get the DynFlags
694
695
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
696
	output_fn  <- get_output_fn next_phase (Just location4)
697

698
        let dflags' = dflags { hscTarget = hsc_lang,
699
700
701
702
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
703

704
	hsc_env <- newHscEnv dflags'
705

706
707
708
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

709
  -- run the compiler!
710
711
712
713
	result <- hscMain hsc_env printErrorsAndWarnings
			  mod_summary source_unchanged 
			  False		-- No object file
			  Nothing	-- No iface
714
                          Nothing       -- No "module i of n" progress info
715

716
	case result of
717

718
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
719

720
            HscNoRecomp details iface -> do
721
		SysTools.touch dflags' "Touching object file" o_file
722
		return (StopLn, dflags', Just location4, o_file)
723

724
	    HscRecomp _details _iface 
725
		      stub_h_exists stub_c_exists
726
		      _maybe_interpreted_code -> do
727

728
		-- Deal with stubs 
729
		maybe_stub_o <- compileStub dflags' stub_c_exists
730
		case maybe_stub_o of
731
		      Nothing     -> return ()
732
		      Just stub_o -> consIORef v_Ld_inputs stub_o
733
734
735
736
737
738
739
740

		-- 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)
741

742
743
744
-----------------------------------------------------------------------------
-- Cmm phase

745
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
746
747
  = do
       output_fn <- get_output_fn Cmm maybe_loc
748
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
749
       return (Cmm, dflags, maybe_loc, output_fn)
750

751
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
752
  = do
753
754
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
755
756
	output_fn <- get_output_fn next_phase maybe_loc

757
        let dflags' = dflags { hscTarget = hsc_lang,
758
759
760
761
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
762

763
	ok <- hscCmmFile dflags' input_fn
764
765
766

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

767
	return (next_phase, dflags, maybe_loc, output_fn)
768

769
770
771
772
773
774
-----------------------------------------------------------------------------
-- 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.

775
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
776
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
777
   = do	let cc_opts = getOpts dflags opt_c
778
	    hcc = cc_phase `eqPhase` HCc
779

780
       	let cmdline_include_paths = includePaths dflags
781

782
783
784
785
786
787
	-- 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 :)
788
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
789
790
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
791

792
793
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
794

795
        let verb = getVerbFlag dflags
796

797
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
798

799
800
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
801
		      | otherwise         = [ ]
802

803
	let excessPrecision = dopt Opt_ExcessPrecision dflags
804

805
	-- Decide next phase
806
807
808
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
809
810
811
812
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

813
814
	-- force the C compiler to interpret this file as C when
	-- compiling .hc files, by adding the -x c option.
815
816
	let langopt | hcc = [ SysTools.Option "-x", SysTools.Option "c"]
		    | otherwise = [ ]
817

818
	SysTools.runCc dflags (langopt ++
819
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
820
			, SysTools.Option "-o"
sof's avatar
sof committed
821
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
822
823
824
			]
		       ++ map SysTools.Option (
		          md_c_flags
825
                       ++ pic_c_flags
826
		       ++ (if hcc && mangle
827
828
		  	     then md_regd_c_flags
		  	     else [])
829
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
830
831
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
832
		       ++ split_opt
833
834
835
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
836
		       ))
837

838
	return (next_phase, dflags, maybe_loc, output_fn)
839
840
841
842
843
844

	-- ToDo: postprocess the output from gcc

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

845
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
846
   = do let mangler_opts = getOpts dflags opt_m
847
848
849
850
851
852

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

854
855
	let split = dopt Opt_SplitObjs dflags
            next_phase
856
857
		| split = SplitMangle
		| otherwise = As
858
	output_fn <- get_output_fn next_phase maybe_loc
859

860
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
861
862
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
863
864
			     ]
			  ++ map SysTools.Option machdep_opts)
865

866
	return (next_phase, dflags, maybe_loc, output_fn)
867
868
869
870

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

871
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
872
873
  = 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)
874
	split_s_prefix <- SysTools.newTempName dflags "split"
875
	let n_files_fn = split_s_prefix
876

877
878
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
879
880
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
881
			  ]
882
883
884
885
886
887
888
889
890

	-- 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]]
891

892
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
893
	  -- we don't use the filename
894
895
896
897

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

898
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
899
  = do	let as_opts =  getOpts dflags opt_a
900
        let cmdline_include_paths = includePaths dflags
901

902
	output_fn <- get_output_fn StopLn maybe_loc
903

904
905
906
907
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

908
909
	SysTools.runAs dflags	
		       (map SysTools.Option as_opts
sof's avatar
sof committed
910
911
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
912
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
913
			  , SysTools.Option "-o"
sof's avatar
sof committed
914
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
915
			  ])
916

917
	return (StopLn, dflags, maybe_loc, output_fn)
918
919


920
runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
921
  = do  let as_opts = getOpts dflags opt_a
922

923
	(split_s_prefix, n) <- readIORef v_Split_info
924

925
926
927
	let real_odir
		| Just d <- outputDir dflags = d
		| otherwise                  = basename ++ "_split"
928

929
930