DriverPipeline.hs 46.4 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
23
        -- DLL building
   doMkDLL
24
25
26
27
  ) where

#include "HsVersions.h"

28
import Packages
29
import GetImports
30
import DriverPhases
sof's avatar
sof committed
31
import SysTools		( newTempName, addFilesToClean, getSysMan, copy )
32
import qualified SysTools	
33
import HscMain
34
import Finder
35
36
37
import HscTypes
import Outputable
import Module
38
import ErrUtils
39
40
import DynFlags
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
41
import Config
42
import RdrName		( GlobalRdrEnv )
43
import Panic
44
import Util
45
import StringBuffer	( hGetStringBuffer )
46
import BasicTypes	( SuccessFlag(..) )
47
import Maybes		( expectJust )
48
import Ctype		( is_ident )
49

50
51
import ParserCoreUtils ( getCoreModuleName )

52
import EXCEPTION
53
import DATA_IOREF	( readIORef, writeIORef, IORef )
54

55
56
import Directory
import System
57
58
59
60
import IO
import Monad
import Maybe

61

62
63
-- ---------------------------------------------------------------------------
-- Pre-process
64
65
66

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

71
preprocess :: DynFlags -> FilePath -> IO (DynFlags, FilePath)
72
preprocess dflags filename =
73
  ASSERT2(isHaskellSrcFilename filename, text filename) 
74
  runPipeline anyHsc dflags filename Temporary Nothing{-no ModLocation-}
75

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

-- Compile a single module, under the control of the compilation manager.
--
-- This is the interface between the compilation manager and the
-- compiler proper (hsc), where we deal with tedious details like
-- reading the OPTIONS pragma from the source file, and passing the
-- output of hsc through the C compiler.

-- NB.  No old interface can also mean that the source has changed.

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

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

99
   | CompErrs 
100
101


102
compile hsc_env mod_summary maybe_old_linkable old_iface = do 
103

104
   let dflags0     = hsc_dflags hsc_env
105
106
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
107

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

112
   showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
113

114
   let verb	  = verbosity dflags0
115
   let location	  = ms_location mod_summary
116
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
117
   let input_fnpp = expectJust "compile:hspp" (ms_hspp_file mod_summary)
118
119
120

   when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))

121
122
123
   -- 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
124
   opts <- getOptionsFromSource input_fnpp
125
   (dflags1,unhandled_flags) <- parseDynamicFlags dflags0 opts
126
   checkProcessArgsResult unhandled_flags input_fn
127

128
   let (basename, _) = splitFilename input_fn
129

130
131
132
133
  -- 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
134
135
       old_paths   = includePaths dflags1
       dflags      = dflags1 { includePaths = current_dir : old_paths }
136

137
   -- Figure out what lang we're generating
138
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
139
   -- ... and what the next phase should be
140
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
141
   -- ... and what file to generate the output into
142
143
   output_fn <- getOutputFilename dflags next_phase 
			Temporary basename next_phase (Just location)
144

145
   let dflags' = dflags { hscTarget = hsc_lang,
146
				hscOutName = output_fn,
147
148
149
150
151
				hscStubCOutName = basename ++ "_stub.c",
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
152
   let do_recomp = dopt Opt_RecompChecking dflags
153
       source_unchanged = isJust maybe_old_linkable && do_recomp
154
       hsc_env' = hsc_env { hsc_dflags = dflags' }
155
156

   -- run the compiler
157
   hsc_result <- hscMain hsc_env' printErrorsAndWarnings mod_summary
158
			 source_unchanged have_object old_iface
159
160

   case hsc_result of
161
      HscFail -> return CompErrs
162

163
164
165
      HscNoRecomp details iface -> 
	  ASSERT(isJust maybe_old_linkable)
	  return (CompOK details iface maybe_old_linkable)
166

167
      HscRecomp details iface
168
169
170
		stub_h_exists stub_c_exists maybe_interpreted_code 

	| isHsBoot src_flavour	-- No further compilation to do
171
	-> return (CompOK details iface Nothing)
172
173
174

	| otherwise		-- Normal Haskell source files
	-> do
175
	   let 
176
	   maybe_stub_o <- compileStub dflags' stub_c_exists
177
178
179
180
181
182
183
184
185
186
187
188
	   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
189
		       Just comp_bc -> return ([BCOs comp_bc], ms_hs_date mod_summary)
190
191
192
193
194
195
			-- 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.
196
197
198
199
#endif
		       Nothing -> panic "compile: no interpreted code"

		-- we're in batch mode: finish the compilation pipeline.
200
201
202
		_other -> do
		   let object_filename = ml_obj_file location

203
204
		   runPipeline StopLn dflags output_fn Persistent
			       (Just location)
205
			-- the object filename comes from the ModLocation
206
207
208

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

210
	   let linkable = LM unlinked_time this_mod
211
212
			     (hs_unlinked ++ stub_unlinked)

213
	   return (CompOK details iface (Just linkable))
214

215
-----------------------------------------------------------------------------
216
217
218
219
220
221
222
-- 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
223
	(_, stub_o) <- runPipeline StopLn dflags
224
			    stub_c Persistent Nothing{-no ModLocation-}
225
226
227
	return (Just stub_o)


228
229
-- ---------------------------------------------------------------------------
-- Link
230

231
link :: GhcMode			-- interactive or batch
232
233
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
234
     -> HomePackageTable	-- what to link
235
236
237
238
239
240
241
242
243
244
     -> 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
245
246
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
247
248
249
	 return Succeeded
#endif

250
link BatchCompile dflags batch_attempt_linking hpt
251
   | batch_attempt_linking
252
   = do 
253
254
255
256
257
258
259
	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
260
	    linkables = map (fromJust.hm_linkable) home_mod_infos
261
262
263
264
265

        when (verb >= 3) $ do
	     hPutStrLn stderr "link: linkables are ..."
             hPutStrLn stderr (showSDoc (vcat (map ppr linkables)))

266
	-- check for the -no-link flag
267
	if isNoLink (ghcLink dflags)
268
	  then do when (verb >= 3) $
269
		    hPutStrLn stderr "link(batch): linking omitted (-c flag given)."
270
271
272
273
274
	          return Succeeded
	  else do

	when (verb >= 1) $
             hPutStrLn stderr "Linking ..."
275

276
277
278
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

279
	-- Don't showPass in Batch mode; doLink will do that for us.
280
        staticLink dflags obj_files pkg_deps
281
282

        when (verb >= 3) (hPutStrLn stderr "link: done")
283
284
285
286
287
288
289
290
291
292
293

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
   = do when (verb >= 3) $ do
	    hPutStrLn stderr "link(batch): upsweep (partially) failed OR"
            hPutStrLn stderr "   Main.main not exported; not linking."
        return Succeeded
   where
      verb = verbosity dflags
294
      
295
296
297
298
299
300
301
302
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

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


351
352
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
353

354
355
356
357
-- 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.

358
-- The DynFlags can be modified by phases in the pipeline (eg. by
359
360
361
362
363
364
365
366
367
368
369
370
371
-- 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.
372

373
runPipeline
374
375
376
  :: Phase		-- When to stop
  -> DynFlags		-- Dynamic flags
  -> FilePath 		-- Input filename
377
378
  -> PipelineOutput	-- Output filename
  -> Maybe ModLocation  -- A ModLocation, if this is a Haskell module
379
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
380

381
runPipeline stop_phase dflags input_fn output maybe_loc
382
383
384
  = do
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
385

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

393
394
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
395
396
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
397

398
399
400
  -- 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
401

402
  -- Execute the pipeline...
403
404
405
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
406

407
  -- Sometimes, a compilation phase doesn't actually generate any output
408
409
410
  -- (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.
411
412
413
414
415
416
417
  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
418
			++ "'") output_fn final_fn
419
420
	   return (dflags', final_fn)
	        
421
422


423
pipeLoop :: DynFlags -> Phase -> Phase 
424
425
426
427
	 -> FilePath  -> String -> Suffix
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
428

429
pipeLoop dflags phase stop_phase 
430
431
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
432

433
434
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
435

436
  | not (phase `happensBefore` stop_phase)
437
438
439
440
	-- 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 #-}.
441
442
443
444
445
  = 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)
446
		<- runPhase phase stop_phase dflags orig_basename 
447
			    orig_suff input_fn orig_get_output_fn maybe_loc
448
	; pipeLoop dflags' next_phase stop_phase output_fn
449
450
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

451
452
453
454
getOutputFilename
  :: DynFlags -> Phase -> PipelineOutput -> String
  -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename dflags stop_phase output basename
455
456
457
458
459
460
461
462
463
 = 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

464
465
466
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
467

468
	func next_phase maybe_location
469
470
471
472
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
473
	   where
474
		is_last_phase = next_phase `eqPhase` stop_phase
475
476
477
478

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
479
     			     StopLn              -> True
480
481
482
483
484
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

485
		suffix = myPhaseInputExt next_phase
486
487
488

		-- persistent object files get put in odir
	        persistent_fn 
489
490
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
491

492
		persistent = basename ++ '.':suffix
493

494
		odir_persistent
495
		   | Just loc <- maybe_location = ml_obj_file loc
496
497
498
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

499

500
501
502
503
504
505
506
507
508
509
-- -----------------------------------------------------------------------------
-- 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.

510
511
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
512
513
514
515
516
	 -> 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)
517
			-- how to calculate the output filename
518
	 -> Maybe ModLocation		-- the ModLocation, if we have one
519
	 -> IO (Phase,	  		-- next phase
520
521
522
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
523

524
525
526
527
	-- 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 

528
529
530
-------------------------------------------------------------------------------
-- Unlit phase 

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

536
537
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
538
539
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
540
541
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
542
			  ])
543

544
       return (Cpp sf, dflags, maybe_loc, output_fn)
545
546

-------------------------------------------------------------------------------
547
548
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
549

550
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
551
  = do src_opts <- getOptionsFromSource input_fn
552
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
553
       checkProcessArgsResult unhandled_flags (basename++'.':suff)
554

555
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
556
557
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
558
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
559
	else do
560
	    output_fn <- get_output_fn (HsPp sf) maybe_loc
561
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
562
	    return (HsPp sf, dflags, maybe_loc, output_fn)
563

sof's avatar
sof committed
564
565
566
-------------------------------------------------------------------------------
-- HsPp phase 

567
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
568
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
569
570
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
571
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
572
	else do
573
	    let hspp_opts = getOpts dflags opt_F
574
	    let orig_fn = basename ++ '.':suff
575
	    output_fn <- get_output_fn (Hsc sf) maybe_loc
576
577
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
578
579
580
581
582
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
583
	    return (Hsc sf, dflags, maybe_loc, output_fn)
584

585
586
587
-----------------------------------------------------------------------------
-- Hsc phase

588
589
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
590
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
591
 = do	-- normal Hsc mode, not mkdependHS
592

593
594
595
  -- 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.
596
	let current_dir = directoryOf basename
597
	
598
599
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
600
	
601
  -- gather the imports and module name
602
        (hspp_buf,mod_name) <- 
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
            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)
618
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
619
620
621
622
623
624
625
626
627

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

683
  -- get the DynFlags
684
685
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
686
	output_fn  <- get_output_fn next_phase (Just location4)
687

688
        let dflags' = dflags { hscTarget = hsc_lang,
689
690
691
692
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
693

694
	hsc_env <- newHscEnv dflags'
695

696
697
698
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

699
  -- run the compiler!
700
701
702
703
	result <- hscMain hsc_env printErrorsAndWarnings
			  mod_summary source_unchanged 
			  False		-- No object file
			  Nothing	-- No iface
704

705
	case result of
706

707
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
708

709
            HscNoRecomp details iface -> do
710
		SysTools.touch dflags' "Touching object file" o_file
711
		return (StopLn, dflags', Just location4, o_file)
712

713
	    HscRecomp _details _iface 
714
		      stub_h_exists stub_c_exists
715
		      _maybe_interpreted_code -> do
716

717
		-- Deal with stubs 
718
		maybe_stub_o <- compileStub dflags' stub_c_exists
719
		case maybe_stub_o of
720
		      Nothing     -> return ()
721
		      Just stub_o -> consIORef v_Ld_inputs stub_o
722
723
724
725
726
727
728
729

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

731
732
733
-----------------------------------------------------------------------------
-- Cmm phase

734
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
735
736
  = do
       output_fn <- get_output_fn Cmm maybe_loc
737
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
738
       return (Cmm, dflags, maybe_loc, output_fn)
739

740
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
741
  = do
742
743
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
744
745
	output_fn <- get_output_fn next_phase maybe_loc

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

752
	ok <- hscCmmFile dflags' input_fn
753
754
755

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

756
	return (next_phase, dflags, maybe_loc, output_fn)
757

758
759
760
761
762
763
-----------------------------------------------------------------------------
-- 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.

764
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
765
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
766
   = do	let cc_opts = getOpts dflags opt_c
767
	    hcc = cc_phase `eqPhase` HCc
768

769
       	let cmdline_include_paths = includePaths dflags
770

771
772
773
774
775
776
	-- 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 :)
777
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
778
779
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
780

781
782
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
783

784
        let verb = getVerbFlag dflags
785

786
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
787

788
789
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
790
		      | otherwise         = [ ]
791

792
	let excessPrecision = dopt Opt_ExcessPrecision dflags
793

794
	-- Decide next phase
795
796
797
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
798
799
800
801
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

802
803
	-- force the C compiler to interpret this file as C when
	-- compiling .hc files, by adding the -x c option.
804
805
	let langopt | hcc = [ SysTools.Option "-x", SysTools.Option "c"]
		    | otherwise = [ ]
806

807
	SysTools.runCc dflags (langopt ++
808
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
809
			, SysTools.Option "-o"
sof's avatar
sof committed
810
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
811
812
813
			]
		       ++ map SysTools.Option (
		          md_c_flags
814
                       ++ pic_c_flags
815
		       ++ (if hcc && mangle
816
817
		  	     then md_regd_c_flags
		  	     else [])
818
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
819
820
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
821
		       ++ split_opt
822
823
824
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
825
		       ))
826

827
	return (next_phase, dflags, maybe_loc, output_fn)
828
829
830
831
832
833

	-- ToDo: postprocess the output from gcc

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

834
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
835
   = do let mangler_opts = getOpts dflags opt_m
836
837
838
839
840
841

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

843
844
	let split = dopt Opt_SplitObjs dflags
            next_phase
845
846
		| split = SplitMangle
		| otherwise = As
847
	output_fn <- get_output_fn next_phase maybe_loc
848

849
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
850
851
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
852
853
			     ]
			  ++ map SysTools.Option machdep_opts)
854

855
	return (next_phase, dflags, maybe_loc, output_fn)
856
857
858
859

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

860
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
861
862
  = 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)
863
	split_s_prefix <- SysTools.newTempName dflags "split"
864
	let n_files_fn = split_s_prefix
865

866
867
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
868
869
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
870
			  ]
871
872
873
874
875
876
877
878
879

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

881
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
882
	  -- we don't use the filename
883
884
885
886

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

887
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
888
  = do	let as_opts =  getOpts dflags opt_a
889
        let cmdline_include_paths = includePaths dflags
890

891
	output_fn <- get_output_fn StopLn maybe_loc
892

893
894
895
896
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

897
898
	SysTools.runAs dflags	
		       (map SysTools.Option as_opts
sof's avatar
sof committed
899
900
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
901
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
902
			  , SysTools.Option "-o"
sof's avatar
sof committed
903
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
904
			  ])
905

906
	return (StopLn, dflags, maybe_loc, output_fn)
907
908


909
runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
910
  = do  let as_opts = getOpts dflags opt_a
911

912
	(split_s_prefix, n) <- readIORef v_Split_info
913

914
915
916
	let real_odir
		| Just d <- outputDir dflags = d
		| otherwise                  = basename ++ "_split"
917

918
919
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
920
		    let output_o = replaceFilenameDirectory
921
					(basename ++ "__" ++ show n ++ ".o")
922
					 real_odir
923
924
		    let osuf = objectSuf dflags
		    let real_o = replaceFilenameSuffix output_o osuf
925
926
		    SysTools.runAs dflags
				 (map SysTools.Option as_opts ++
sof's avatar
sof committed
927
928
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
sof's avatar
sof committed
929
930
				    , SysTools.FileOption "" real_o
				    , SysTools.FileOption "" input_s
sof's avatar
sof committed
931
				    ])
932
933
	
	mapM_ assemble_file [1..n]
934

935
936
	output_fn <- get_output_fn StopLn maybe_loc
	return (StopLn, dflags, maybe_loc, output_fn)
937

938
939
940
941
942
943
-----------------------------------------------------------------------------
-- MoveBinary sort-of-phase
-- After having produced a binary, move it somewhere else and generate a
-- wrapper script calling the binary. Currently, we need this only in 
-- a parallel way (i.e. in GUM), because PVM expects the binary in a
-- central directory.
944
-- This is called from staticLink below, after linking. I haven't made it
945
946
947
948
-- a separate phase to minimise interfering with other modules, and
-- we don't need the generality of a phase (MoveBinary is always
-- done after linking and makes only sense in a parallel setup)   -- HWL

949
runPhase_MoveBinary input_fn
950
  = do	
951
        sysMan   <- getSysMan
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
        pvm_root <- getEnv "PVM_ROOT"
        pvm_arch <- getEnv "PVM_ARCH"
        let 
           pvm_executable_base = "=" ++ input_fn
           pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
        -- nuke old binary; maybe use configur'ed names for cp and rm?
        system ("rm -f " ++ pvm_executable)
        -- move the newly created binary into PVM land
        system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
        -- generate a wrapper script for running a parallel prg under PVM
        writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
	return True

-- generates a Perl skript starting a parallel prg under PVM
mk_pvm_wrapper_script :: String -> String -> String -> String
mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
 [
  "eval 'exec perl -S $0 ${1+\"$@\"}'", 
  "  if $running_under_some_shell;",
  "# =!=!=!=!=!=!=!=!=!=!=!",
  "# This script is automatically generated: DO NOT EDIT!!!",
  "# Generated by Glasgow Haskell Compiler",
  "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
  "#",
  "$pvm_executable      = '" ++ pvm_executable ++ "';",
  "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
  "$SysMan = '" ++ sysMan ++ "';",
  "",
  {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
  "# first, some magical shortcuts to run "commands" on the binary",
  "# (which is hidden)",
  "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
  "    local($cmd) = $1;",
  "    system("$cmd $pvm_executable");",
  "    exit(0); # all done",
  "}", -}
  "",
  "# Now, run the real binary; process the args first",
  "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
  "$debug = '';",
  "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
  "@nonPVM_args = ();",
  "$in_RTS_args = 0;",
  "",
  "args: while ($a = shift(@ARGV)) {",
  "    if ( $a eq '+RTS' ) {",
  "	$in_RTS_args = 1;",
  "    } elsif ( $a eq '-RTS' ) {",
  "	$in_RTS_args = 0;",
  "    }",
  "    if ( $a eq '-d' && $in_RTS_args ) {",
  "	$debug = '-';",
  "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
  "	$nprocessors = $1;",
  "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
  "	$nprocessors = $1;",
  "    } else {",
  "	push(@nonPVM_args, $a);",
  "    }",
  "}",
  "",
  "local($return_val) = 0;",
  "# Start the parallel execution by calling SysMan",
  "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
  "$return_val = $?;",
  "# ToDo: fix race condition moving files and flushing them!!",
  "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";"<