DriverPipeline.hs 46.5 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
25
   doMkDLL,

   matchOptions, -- used in module GHC
26
27
28
29
  ) where

#include "HsVersions.h"

30
import Packages
31
import GetImports
32
import DriverPhases
sof's avatar
sof committed
33
import SysTools		( newTempName, addFilesToClean, getSysMan, copy )
34
import qualified SysTools	
35
import HscMain
36
import Finder
37
38
39
import HscTypes
import Outputable
import Module
40
import ErrUtils
41
42
import DynFlags
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
43
import Config
44
import RdrName		( GlobalRdrEnv )
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
53
import ParserCoreUtils ( getCoreModuleName )

54
import EXCEPTION
55
import DATA_IOREF	( readIORef, writeIORef, IORef )
56

57
58
import Directory
import System
59
60
61
62
import IO
import Monad
import Maybe

63

64
65
-- ---------------------------------------------------------------------------
-- Pre-process
66
67
68

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

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

78
79
-- ---------------------------------------------------------------------------
-- Compile
80
81
82
83
84
85
86
87
88
89

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

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

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

101
   | CompErrs 
102
103


104
compile hsc_env mod_summary maybe_old_linkable old_iface = do 
105

106
   let dflags0     = hsc_dflags hsc_env
107
108
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
109

110
111
112
113
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

114
   showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
115

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

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

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

130
   let (basename, _) = splitFilename input_fn
131

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

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

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

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

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

   case hsc_result of
163
      HscFail -> return CompErrs
164

165
166
167
      HscNoRecomp details iface -> 
	  ASSERT(isJust maybe_old_linkable)
	  return (CompOK details iface maybe_old_linkable)
168

169
      HscRecomp details iface
170
171
172
		stub_h_exists stub_c_exists maybe_interpreted_code 

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

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

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

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

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

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

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

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


229
230
-- ---------------------------------------------------------------------------
-- Link
231

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

486
		suffix = myPhaseInputExt next_phase
487
488
489

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

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

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

500

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

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

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

529
530
531
-------------------------------------------------------------------------------
-- Unlit phase 

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

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

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

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

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

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

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

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

586
587
588
-----------------------------------------------------------------------------
-- Hsc phase

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

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

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

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

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

696
	hsc_env <- newHscEnv dflags'
697

698
699
700
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

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

707
	case result of
708

709
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
710

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

715
	    HscRecomp _details _iface 
716
		      stub_h_exists stub_c_exists
717
		      _maybe_interpreted_code -> do
718

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

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

733
734
735
-----------------------------------------------------------------------------
-- Cmm phase

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

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

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

754
	ok <- hscCmmFile dflags' input_fn
755
756
757

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

758
	return (next_phase, dflags, maybe_loc, output_fn)
759

760
761
762
763
764
765
-----------------------------------------------------------------------------
-- 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.

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

771
       	let cmdline_include_paths = includePaths dflags
772

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

783
784
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
785

786
        let verb = getVerbFlag dflags
787

788
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
789

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

794
	let excessPrecision = dopt Opt_ExcessPrecision dflags
795

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

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

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

829
	return (next_phase, dflags, maybe_loc, output_fn)
830
831
832
833
834
835

	-- ToDo: postprocess the output from gcc

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

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

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

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

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

857
	return (next_phase, dflags, maybe_loc, output_fn)
858
859
860
861

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

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

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

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

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

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

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

893
	output_fn <- get_output_fn StopLn maybe_loc
894

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

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

908
	return (StopLn, dflags, maybe_loc, output_fn)
909
910


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

914
	(split_s_prefix, n) <- readIORef v_Split_info
915

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

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

937
938
	output_fn <- get_output_fn StopLn maybe_loc
	return (StopLn, dflags, maybe_loc, output_fn)
939

940
941
942
943
944
945
-----------------------------------------------------------------------------
-- 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.
946
-- This is called from staticLink below, after linking. I haven't made it
947
948
949
950
-- 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

951
runPhase_MoveBinary input_fn
952
  = do	
953
        sysMan   <- getSysMan
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
1022
1023
        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)) {"