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

module DriverPipeline (
10
11
12
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
   oneShot,
13

14
	-- Interfaces for the batch-mode driver
15
   staticLink,
16

17
18
19
20
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
   compile, CompResult(..), 
   link, 
21

rrt's avatar
rrt committed
22
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
90
91
92
	-> ModSummary
	-> Bool			-- True <=> source unchanged
	-> Bool			-- True <=> have object
        -> Maybe ModIface       -- Old interface, if available
93
94
95
        -> IO CompResult

data CompResult
96
   = CompOK   ModDetails 		-- New details
97
98
99
100
              ModIface			-- New iface
              (Maybe Linkable)	-- New code; Nothing => compilation was not reqd
		                --			(old code is still valid)

101
   | CompErrs 
102
103


104
105
compile hsc_env mod_summary
	source_unchanged have_object old_iface = do 
106

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

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

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

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

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

127
   let (basename, _) = splitFilename input_fn
128

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

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

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

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

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

   case hsc_result of
160
      HscFail -> return CompErrs
161

162
      HscNoRecomp details iface -> return (CompOK details iface Nothing)
163

164
      HscRecomp details iface
165
166
167
		stub_h_exists stub_c_exists maybe_interpreted_code 

	| isHsBoot src_flavour	-- No further compilation to do
168
	-> return (CompOK details iface Nothing)
169
170
171

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

		-- we're in batch mode: finish the compilation pipeline.
197
198
199
		_other -> do
		   let object_filename = ml_obj_file location

200
201
		   runPipeline StopLn dflags output_fn Persistent
			       (Just location)
202
			-- the object filename comes from the ModLocation
203
204
205

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

207
	   let linkable = LM unlinked_time this_mod
208
209
			     (hs_unlinked ++ stub_unlinked)

210
	   return (CompOK details iface (Just linkable))
211

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


225
226
-- ---------------------------------------------------------------------------
-- Link
227

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

247
link BatchCompile dflags batch_attempt_linking hpt
248
   | batch_attempt_linking
249
   = do 
250
251
252
253
254
255
256
257
258
259
260
261
262
	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
	    linkables = map hm_linkable home_mod_infos

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

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

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

273
274
275
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

276
	-- Don't showPass in Batch mode; doLink will do that for us.
277
        staticLink dflags obj_files pkg_deps
278
279

        when (verb >= 3) (hPutStrLn stderr "link: done")
280
281
282
283
284
285
286
287
288
289
290

	-- 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
291
      
292
293
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

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


348
349
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
350

351
352
353
354
-- 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.

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

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

378
runPipeline stop_phase dflags input_fn output maybe_loc
379
380
381
  = do
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
382

383
384
385
386
387
388
  -- 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.
389

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

395
396
397
  -- 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
398

399
  -- Execute the pipeline...
400
401
402
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
403

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


420
pipeLoop :: DynFlags -> Phase -> Phase 
421
422
423
424
	 -> FilePath  -> String -> Suffix
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
425

426
pipeLoop dflags phase stop_phase 
427
428
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
429

430
431
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
432

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

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

461
462
463
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
464

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

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

482
		suffix = myPhaseInputExt next_phase
483
484
485

		-- persistent object files get put in odir
	        persistent_fn 
486
487
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
488

489
		persistent = basename ++ '.':suffix
490

491
		odir_persistent
492
		   | Just loc <- maybe_location = ml_obj_file loc
493
494
495
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

496

497
498
499
500
501
502
503
504
505
506
-- -----------------------------------------------------------------------------
-- 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.

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

521
522
523
524
	-- 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 

525
526
527
-------------------------------------------------------------------------------
-- Unlit phase 

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

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

541
       return (Cpp sf, dflags, maybe_loc, output_fn)
542
543

-------------------------------------------------------------------------------
544
545
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
546

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

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

sof's avatar
sof committed
561
562
563
-------------------------------------------------------------------------------
-- HsPp phase 

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

582
583
584
-----------------------------------------------------------------------------
-- Hsc phase

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

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

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

680
  -- get the DynFlags
681
682
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
683
	output_fn  <- get_output_fn next_phase (Just location4)
684

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

691
	hsc_env <- newHscEnv dflags'
692

693
694
695
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

696
  -- run the compiler!
697
698
699
700
	result <- hscMain hsc_env printErrorsAndWarnings
			  mod_summary source_unchanged 
			  False		-- No object file
			  Nothing	-- No iface
701

702
	case result of
703

704
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
705

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

710
	    HscRecomp _details _iface 
711
		      stub_h_exists stub_c_exists
712
		      _maybe_interpreted_code -> do
713

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

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

728
729
730
-----------------------------------------------------------------------------
-- Cmm phase

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

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

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

749
	ok <- hscCmmFile dflags' input_fn
750
751
752

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

753
	return (next_phase, dflags, maybe_loc, output_fn)
754

755
756
757
758
759
760
-----------------------------------------------------------------------------
-- 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.

761
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
762
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
763
   = do	let cc_opts = getOpts dflags opt_c
764
	    hcc = cc_phase `eqPhase` HCc
765

766
       	let cmdline_include_paths = includePaths dflags
767

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

778
779
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
780

781
        let verb = getVerbFlag dflags
782

783
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
784

785
786
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
787
		      | otherwise         = [ ]
788

789
	let excessPrecision = dopt Opt_ExcessPrecision dflags
790

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

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

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

824
	return (next_phase, dflags, maybe_loc, output_fn)
825
826
827
828
829
830

	-- ToDo: postprocess the output from gcc

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

831
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
832
   = do let mangler_opts = getOpts dflags opt_m
833
834
835
836
837
838

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

840
841
	let split = dopt Opt_SplitObjs dflags
            next_phase
842
843
		| split = SplitMangle
		| otherwise = As
844
	output_fn <- get_output_fn next_phase maybe_loc
845

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

852
	return (next_phase, dflags, maybe_loc, output_fn)
853
854
855
856

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

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

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

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

878
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
879
	  -- we don't use the filename
880
881
882
883

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

884
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
885
  = do	let as_opts =  getOpts dflags opt_a
886
        let cmdline_include_paths = includePaths dflags
887

888
	output_fn <- get_output_fn StopLn maybe_loc
889

890
891
892
893
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

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

903
	return (StopLn, dflags, maybe_loc, output_fn)
904
905


906
runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
907
  = do  let as_opts = getOpts dflags opt_a
908

909
	(split_s_prefix, n) <- readIORef v_Split_info
910

911
912
913
	let real_odir
		| Just d <- outputDir dflags = d
		| otherwise                  = basename ++ "_split"
914

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

932
933
	output_fn <- get_output_fn StopLn maybe_loc
	return (StopLn, dflags, maybe_loc, output_fn)
934

935
936
937
938
939
940
-----------------------------------------------------------------------------
-- 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.
941
-- This is called from staticLink below, after linking. I haven't made it
942
943
944
945
-- 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

946
runPhase_MoveBinary input_fn
947
  = do	
948
        sysMan   <- getSysMan
949
950
951
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
        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\";",
  "exit($return_val);"
 ]

1019
1020
1021
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

1022
checkProcessArgsResult flags filename
sof's avatar
sof committed
1023
  = do when (notNull flags) (throwDyn (ProgramError (
1024
	  showSDoc (hang (text filename <> char ':')
1025