DriverPipeline.hs 49.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
	-- 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
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
79
80
81
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-}
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
193
194
195
196
197
	   stub_unlinked <-
	     if stub_c_exists then do
		stub_o <- compileStub dflags' object_filename
		return [ DotO stub_o ]
	     else
		return []
198
199
200
201
202
203

	   (hs_unlinked, unlinked_time) <-
	     case hsc_lang of

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

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

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

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

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

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

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

237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
-- 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

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

	return stub_o
262
263


264
265
-- ---------------------------------------------------------------------------
-- Link
266

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

286
287
288
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

289
link BatchCompile dflags batch_attempt_linking hpt
290
   | batch_attempt_linking
291
   = do 
292
293
294
295
296
297
298
	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
299
	    linkables = map (fromJust.hm_linkable) home_mod_infos
300

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

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

310
	debugTraceMsg dflags 1 "Linking ..."
311

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

315
	-- Don't showPass in Batch mode; doLink will do that for us.
316
        staticLink dflags obj_files pkg_deps
317

318
        debugTraceMsg dflags 3 "link: done"
319
320
321
322
323

	-- staticLink only returns if it succeeds
        return Succeeded

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

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

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

337
338
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
   exists <- doesFileExist src
   when (not exists) $ 
   	throwDyn (CmdLineError ("does not exist: " ++ src))
   
   let
	split     = dopt Opt_SplitObjs dflags
	mb_o_file = outputFile dflags
	ghc_link  = ghcLink dflags	-- Set by -c or -no-link

	-- When linking, the -o argument refers to the linker's output.	
	-- otherwise, we use it as the name for the pipeline's output.
        output
	 | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
		-- -o foo applies to linker
	 | Just o_file <- mb_o_file = SpecificFile o_file
		-- -o foo applies to the file we are compiling now
	 | otherwise = Persistent

        stop_phase' = case stop_phase of 
			As | split -> SplitAs
			other      -> stop_phase

   (_, out_file) <- runPipeline stop_phase' dflags
362
			  (src, mb_phase) output Nothing{-no ModLocation-}
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
   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 = []


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

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

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

406
runPipeline
407
408
409
410
411
  :: 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
412
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
413

414
runPipeline stop_phase dflags (input_fn, mb_phase) output maybe_loc
415
416
  = do
  let (basename, suffix) = splitFilename input_fn
417
418
419
420
421

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

423
424
425
426
427
428
  -- We want to catch cases of "you can't get there from here" before
  -- we start the pipeline, because otherwise it will just run off the
  -- end.
  --
  -- There is a partial ordering on phases, where A < B iff A occurs
  -- before B in a normal compilation pipeline.
429

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

435
436
437
  -- 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
438

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

444
  -- Sometimes, a compilation phase doesn't actually generate any output
445
446
447
  -- (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.
448
449
450
451
452
453
454
  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
455
			++ "'") output_fn final_fn
456
457
	   return (dflags', final_fn)
	        
458
459


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

466
pipeLoop dflags phase stop_phase 
467
468
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
469

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

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

488
489
490
491
getOutputFilename
  :: DynFlags -> Phase -> PipelineOutput -> String
  -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename dflags stop_phase output basename
492
493
494
495
496
497
498
499
500
 = 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

501
502
503
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
504

505
	func next_phase maybe_location
506
507
508
509
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
510
	   where
511
		is_last_phase = next_phase `eqPhase` stop_phase
512
513
514
515

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

522
		suffix = myPhaseInputExt next_phase
523
524
525

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

529
		persistent = basename `joinFileExt` suffix
530

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

536

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

547
548
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
549
550
551
552
553
	 -> 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)
554
			-- how to calculate the output filename
555
	 -> Maybe ModLocation		-- the ModLocation, if we have one
556
	 -> IO (Phase,	  		-- next phase
557
558
559
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
560

561
562
563
564
	-- 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 

565
566
567
-------------------------------------------------------------------------------
-- Unlit phase 

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

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

581
       return (Cpp sf, dflags, maybe_loc, output_fn)
582
583

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

587
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
588
  = do src_opts <- getOptionsFromSource input_fn
589
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
590
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
591

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

sof's avatar
sof committed
601
602
603
-------------------------------------------------------------------------------
-- HsPp phase 

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

622
623
624
-----------------------------------------------------------------------------
-- Hsc phase

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

630
631
632
  -- 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.
633
	let current_dir = directoryOf basename
634
	
635
636
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
637
	
638
  -- gather the imports and module name
639
        (hspp_buf,mod_name) <- 
640
641
642
643
644
645
            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
646
			    ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
647
648
649
650
651
652
653
654
			    ; 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)
655
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
656
657
658
659
660
661
662
663
664

  -- 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
665
666
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
667
668
669
670
671
672
673
		      | 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
674
675
676
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
677
678
679
680
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

  -- Make the ModSummary to hand to hscMain
681
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)
682
683
684
685
686
687
688
689
690
	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
691
					ms_obj_date  = Nothing,
692
693
694
695
696
697
698
					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.
699
  --
700
  -- Setting source_unchanged to True means that M.o seems
701
702
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
703
  -- Setting source_unchanged to False tells the compiler that M.o is out of
704
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
705
	let do_recomp = dopt Opt_RecompChecking dflags
706
	source_unchanged <- 
707
          if not do_recomp || not (isStopLn stop)
708
709
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
710
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
711
712
	     then return False	
		-- Otherwise look at file modification dates
713
	     else do o_file_exists <- doesFileExist o_file
714
		     if not o_file_exists
715
		        then return False	-- Need to recompile
716
			else do t2 <- getModificationTime o_file
717
			        if t2 > src_timestamp
718
719
				  then return True
				  else return False
720

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

726
        let dflags' = dflags { hscTarget = hsc_lang,
727
728
729
730
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
731

732
	hsc_env <- newHscEnv dflags'
733

734
735
736
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

737
  -- run the compiler!
738
739
740
741
	result <- hscMain hsc_env printErrorsAndWarnings
			  mod_summary source_unchanged 
			  False		-- No object file
			  Nothing	-- No iface
742
                          Nothing       -- No "module i of n" progress info
743

744
	case result of
745

746
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
747

748
            HscNoRecomp details iface -> do
749
		SysTools.touch dflags' "Touching object file" o_file
750
751
752
			-- 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).
753
		return (StopLn, dflags', Just location4, o_file)
754

755
	    HscRecomp _details _iface 
756
		      stub_h_exists stub_c_exists
757
		      _maybe_interpreted_code -> do
758

759
760
761
		when stub_c_exists $ do
			stub_o <- compileStub dflags' o_file
			consIORef v_Ld_inputs stub_o
762
763
764
765
766
767
768
769

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

771
772
773
-----------------------------------------------------------------------------
-- Cmm phase

774
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
775
776
  = do
       output_fn <- get_output_fn Cmm maybe_loc
777
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
778
       return (Cmm, dflags, maybe_loc, output_fn)
779

780
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
781
  = do
782
783
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
784
785
	output_fn <- get_output_fn next_phase maybe_loc

786
        let dflags' = dflags { hscTarget = hsc_lang,
787
788
789
790
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
791

792
	ok <- hscCmmFile dflags' input_fn
793
794
795

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

796
	return (next_phase, dflags, maybe_loc, output_fn)
797

798
799
800
801
802
803
-----------------------------------------------------------------------------
-- 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.

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

809
       	let cmdline_include_paths = includePaths dflags
810

811
812
813
814
815
816
	-- 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 :)
817
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
818
819
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
820

821
822
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
823

824
        let verb = getVerbFlag dflags
825

826
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
827

828
829
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
830
		      | otherwise         = [ ]
831

832
	let excessPrecision = dopt Opt_ExcessPrecision dflags
833

834
	-- Decide next phase
835
836
837
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
838
839
840
841
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

842
843
844
845
846
847
	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"] ++
848
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
849
			, SysTools.Option "-o"
sof's avatar
sof committed
850
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
851
852
853
			]
		       ++ map SysTools.Option (
		          md_c_flags
854
                       ++ pic_c_flags
855
		       ++ (if hcc && mangle
856
857
		  	     then md_regd_c_flags
		  	     else [])
858
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
859
860
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
861
		       ++ split_opt
862
863
864
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
865
		       ))
866

867
	return (next_phase, dflags, maybe_loc, output_fn)
868
869
870
871
872
873

	-- ToDo: postprocess the output from gcc

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

874
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
875
   = do let mangler_opts = getOpts dflags opt_m
876
877
878
879
880
881

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

883
884
	let split = dopt Opt_SplitObjs dflags
            next_phase
885
886
		| split = SplitMangle
		| otherwise = As
887
	output_fn <- get_output_fn next_phase maybe_loc
888

889
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
890
891
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
892
893
			     ]
			  ++ map SysTools.Option machdep_opts)
894

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

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

900
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
901
902
  = 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)
903
	split_s_prefix <- SysTools.newTempName dflags "split"
904
	let n_files_fn = split_s_prefix
905

906
907
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
908
909
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
910
			  ]
911
912
913
914
915
916
917
918
919

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

921
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
922
	  -- we don't use the filename
923
924
925
926

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

927
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
928
  = do	let as_opts =  getOpts dflags opt_a
929
        let cmdline_include_paths = includePaths dflags
930

931
	output_fn <- get_output_fn StopLn maybe_loc
932

933
934
935
936
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

937
938
	SysTools.runAs dflags	
		       (map SysTools.Option as_opts
sof's avatar
sof committed
939
940
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"