DriverPipeline.hs 48.3 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
       object_filename = ml_obj_file location
168
169

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

   case hsc_result of
175
      HscFail -> return CompErrs
176

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

181
      HscRecomp details iface stub_h_exists stub_c_exists maybe_interpreted_code 
182
183

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

190
	| otherwise	-- Normal source file
191
	-> do
192
	   maybe_stub_o <- compileStub dflags' stub_c_exists
193
194
195
196
197
198
199
200
201
	   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.
202
203
		HscInterpreted
		  -> case maybe_interpreted_code of
204
#ifdef GHCI
205
		       Just comp_bc -> return ([BCOs comp_bc], ms_hs_date mod_summary)
206
207
208
209
210
211
			-- 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.
212
213
214
#endif
		       Nothing -> panic "compile: no interpreted code"

215
216
217
218
219
		-- We're in --make mode: finish the compilation pipeline.
		_other
		  -> do	runPipeline StopLn dflags output_fn Persistent
				    (Just location)
				-- The object filename comes from the ModLocation
220

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

224
	   let linkable = LM unlinked_time this_mod
225
226
			     (hs_unlinked ++ stub_unlinked)

227
	   return (CompOK details iface (Just linkable))
228

229
-----------------------------------------------------------------------------
230
231
232
233
234
235
236
-- 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
237
	(_, stub_o) <- runPipeline StopLn dflags
238
			    stub_c Persistent Nothing{-no ModLocation-}
239
240
241
	return (Just stub_o)


242
243
-- ---------------------------------------------------------------------------
-- Link
244

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

264
265
266
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

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

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

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

288
	debugTraceMsg dflags 1 "Linking ..."
289

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

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

296
        debugTraceMsg dflags 3 "link: done"
297
298
299
300
301

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
302
303
   = do debugTraceMsg dflags 3 "link(batch): upsweep (partially) failed OR"
        debugTraceMsg dflags 3 "   Main.main not exported; not linking."
304
        return Succeeded
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
360
361

-- -----------------------------------------------------------------------------
-- 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 = []


362
363
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
364

365
366
367
368
-- 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.

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

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

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

397
398
399
400
401
402
  -- 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.
403

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

409
410
411
  -- 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
412

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

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


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

440
pipeLoop dflags phase stop_phase 
441
442
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
443

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

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

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

475
476
477
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
478

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

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

496
		suffix = myPhaseInputExt next_phase
497
498
499

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

503
		persistent = basename ++ '.':suffix
504

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

510

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

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

535
536
537
538
	-- 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 

539
540
541
-------------------------------------------------------------------------------
-- Unlit phase 

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

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

555
       return (Cpp sf, dflags, maybe_loc, output_fn)
556
557

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

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

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

sof's avatar
sof committed
575
576
577
-------------------------------------------------------------------------------
-- HsPp phase 

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

596
597
598
-----------------------------------------------------------------------------
-- Hsc phase

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

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

  -- 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
639
640
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
641
642
643
644
645
646
647
		      | 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
648
649
650
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
651
652
653
654
655
656
657
658
659
660
661
662
663
664
		      = 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
665
					ms_obj_date  = Nothing,
666
667
668
669
670
671
672
					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.
673
  --
674
  -- Setting source_unchanged to True means that M.o seems
675
676
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
677
  -- Setting source_unchanged to False tells the compiler that M.o is out of
678
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
679
	let do_recomp = dopt Opt_RecompChecking dflags
680
	source_unchanged <- 
681
          if not do_recomp || not (isStopLn stop)
682
683
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
684
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
685
686
	     then return False	
		-- Otherwise look at file modification dates
687
	     else do o_file_exists <- doesFileExist o_file
688
		     if not o_file_exists
689
		        then return False	-- Need to recompile
690
			else do t2 <- getModificationTime o_file
691
			        if t2 > src_timestamp
692
693
				  then return True
				  else return False
694

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

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

706
	hsc_env <- newHscEnv dflags'
707

708
709
710
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

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

718
	case result of
719

720
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
721

722
            HscNoRecomp details iface -> do
723
		SysTools.touch dflags' "Touching object file" o_file
724
725
726
			-- 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).
727
		return (StopLn, dflags', Just location4, o_file)
728

729
	    HscRecomp _details _iface 
730
		      stub_h_exists stub_c_exists
731
		      _maybe_interpreted_code -> do
732

733
		-- Deal with stubs 
734
		maybe_stub_o <- compileStub dflags' stub_c_exists
735
		case maybe_stub_o of
736
		      Nothing     -> return ()
737
		      Just stub_o -> consIORef v_Ld_inputs stub_o
738
739
740
741
742
743
744
745

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

747
748
749
-----------------------------------------------------------------------------
-- Cmm phase

750
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
751
752
  = do
       output_fn <- get_output_fn Cmm maybe_loc
753
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
754
       return (Cmm, dflags, maybe_loc, output_fn)
755

756
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
757
  = do
758
759
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
760
761
	output_fn <- get_output_fn next_phase maybe_loc

762
        let dflags' = dflags { hscTarget = hsc_lang,
763
764
765
766
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
767

768
	ok <- hscCmmFile dflags' input_fn
769
770
771

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

772
	return (next_phase, dflags, maybe_loc, output_fn)
773

774
775
776
777
778
779
-----------------------------------------------------------------------------
-- 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.

780
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
781
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
782
   = do	let cc_opts = getOpts dflags opt_c
783
	    hcc = cc_phase `eqPhase` HCc
784

785
       	let cmdline_include_paths = includePaths dflags
786

787
788
789
790
791
792
	-- 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 :)
793
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
794
795
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
796

797
798
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
799

800
        let verb = getVerbFlag dflags
801

802
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
803

804
805
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
806
		      | otherwise         = [ ]
807

808
	let excessPrecision = dopt Opt_ExcessPrecision dflags
809

810
	-- Decide next phase
811
812
813
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
814
815
816
817
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

818
819
	-- force the C compiler to interpret this file as C when
	-- compiling .hc files, by adding the -x c option.
820
821
	let langopt | hcc = [ SysTools.Option "-x", SysTools.Option "c"]
		    | otherwise = [ ]
822

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

843
	return (next_phase, dflags, maybe_loc, output_fn)
844
845
846
847
848
849

	-- ToDo: postprocess the output from gcc

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

850
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
851
   = do let mangler_opts = getOpts dflags opt_m
852
853
854
855
856
857

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

859
860
	let split = dopt Opt_SplitObjs dflags
            next_phase
861
862
		| split = SplitMangle
		| otherwise = As
863
	output_fn <- get_output_fn next_phase maybe_loc
864

865
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
866
867
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
868
869
			     ]
			  ++ map SysTools.Option machdep_opts)
870

871
	return (next_phase, dflags, maybe_loc, output_fn)
872
873
874
875

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

876
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
877
878
  = 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)
879
	split_s_prefix <- SysTools.newTempName dflags "split"
880
	let n_files_fn = split_s_prefix
881

882
883
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
884
885
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
886
			  ]
887
888
889
890
891
892
893
894
895

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

897
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
898
	  -- we don't use the filename
899
900
901
902

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

903
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
904
  = do	let as_opts =  getOpts dflags opt_a
905
        let cmdline_include_paths = includePaths dflags
906

907
	output_fn <- get_output_fn StopLn maybe_loc
908

909
910
911
912
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

913
914
	SysTools.runAs dflags	
		       (map SysTools.Option as_opts
sof's avatar
sof committed
915
916
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
917
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
918
			  , SysTools.Option "-o"
sof's avatar
sof committed
919
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
920
			  ])
921

922
	return (StopLn, dflags, maybe_loc, output_fn)
923
924


925
runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
926
  = do  let as_opts = getOpts dflags opt_a