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

9
#include "../includes/ghcconfig.h"
rrt's avatar
rrt committed
10

11
module DriverPipeline (
12

13
	-- Interfaces for the batch-mode driver
14
   runPipeline, staticLink,
15

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

rrt's avatar
rrt committed
21
22
        -- DLL building
   doMkDLL
23
24
25
26
  ) where

#include "HsVersions.h"

27
import Packages
28
import GetImports
29
30
31
import DriverState
import DriverUtil
import DriverMkDepend
32
import DriverPhases
33
import DriverFlags
sof's avatar
sof committed
34
import SysTools		( newTempName, addFilesToClean, getSysMan, copy )
35
import qualified SysTools	
36
import HscMain
37
import Finder
38
39
40
import HscTypes
import Outputable
import Module
41
import ErrUtils
42
import CmdLineOpts
43
import Config
44
import RdrName		( GlobalRdrEnv )
45
import Panic
46
import Util
47
import BasicTypes	( SuccessFlag(..) )
48
import Maybes		( expectJust )
49

50
51
import ParserCoreUtils ( getCoreModuleName )

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

55
import Time 		( ClockTime )
56
57
import Directory
import System
58
59
60
61
import IO
import Monad
import Maybe

62

63
64
-- ---------------------------------------------------------------------------
-- Pre-process
65
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
preprocess :: DynFlags -> FilePath -> IO FilePath
preprocess dflags filename =
71
  ASSERT(isHaskellSrcFilename filename) 
72
  do runPipeline (StopBefore Hsc) dflags ("preprocess") 
73
74
75
	False{-temporary output file-}
	Nothing{-no specific output file-}
	filename
76
	Nothing{-no ModLocation-}
77

78
79
-- ---------------------------------------------------------------------------
-- Compile
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

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

-- The driver sits between 'compile' and 'hscMain', translating calls
-- to the former into calls to the latter, and results from the latter
-- into results from the former.  It does things like preprocessing
-- the .hs file if necessary, and compiling up the .stub_c files to
-- generate Linkables.

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

96
compile :: HscEnv
97
98
	-> Module
	-> ModLocation
99
	-> ClockTime		   -- timestamp of original source file
100
101
102
103
104
105
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
        -> Maybe ModIface          -- old interface, if available
        -> IO CompResult

data CompResult
106
107
108
109
   = CompOK   ModDetails 		-- New details
	      (Maybe GlobalRdrEnv)	-- Lexical environment for the module
					-- (Maybe because we may have loaded it from
					--  its precompiled interface)
110
111
112
113
              ModIface			-- New iface
              (Maybe Linkable)	-- New code; Nothing => compilation was not reqd
		                --			(old code is still valid)

114
   | CompErrs 
115
116


117
compile hsc_env this_mod location src_timestamp
118
	source_unchanged have_object 
119
	old_iface = do 
120

121
   let dyn_flags = hsc_dflags hsc_env
122

123
   showPass dyn_flags
124
125
126
127
128
129
130
131
	(showSDoc (text "Compiling" <+> ppr this_mod))

   let verb	  = verbosity dyn_flags
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = expectJust "compile:hspp" (ml_hspp_file location)

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

132
   -- add in the OPTIONS from the source file
133
   opts <- getOptionsFromSource input_fnpp
134
135
   (dyn_flags,unhandled_flags) <- processDynamicFlags opts dyn_flags
   checkProcessArgsResult unhandled_flags input_fn
136

137
   let (basename, _) = splitFilename input_fn
138

139
140
141
142
143
144
145
146
147
  -- 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
   old_paths <- readIORef v_Include_paths
   writeIORef v_Include_paths (current_dir : old_paths)
   -- put back the old include paths afterward.
   later (writeIORef v_Include_paths old_paths) $ do

148
149
150
151
152
153
   -- figure out what lang we're generating
   hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
   -- figure out what the next phase should be
   next_phase <- hscNextPhase hsc_lang
   -- figure out what file to generate the output into
   get_output_fn <- genOutputFilenameFunc False Nothing next_phase basename
154
   output_fn <- get_output_fn next_phase (Just location)
155
156
157

   let dyn_flags' = dyn_flags { hscLang = hsc_lang,
				hscOutName = output_fn,
158
159
160
161
162
163
164
				hscStubCOutName = basename ++ "_stub.c",
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
   do_recomp <- readIORef v_Recomp
   let source_unchanged' = source_unchanged && do_recomp
165
       hsc_env' = hsc_env { hsc_dflags = dyn_flags' }
166
167

   -- run the compiler
168
   hsc_result <- hscMain hsc_env' printErrorsAndWarnings this_mod location
169
170
171
			 source_unchanged' have_object old_iface

   case hsc_result of
172
      HscFail -> return CompErrs
173

174
      HscNoRecomp details iface -> return (CompOK details Nothing iface Nothing)
175

176
      HscRecomp details rdr_env iface
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
	stub_h_exists stub_c_exists maybe_interpreted_code -> do
	   let 
	   maybe_stub_o <- compileStub dyn_flags' stub_c_exists
	   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
192
193
194
195
196
197
198
		       Just comp_bc -> return ([BCOs comp_bc], src_timestamp)
			-- 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.
199
200
201
202
#endif
		       Nothing -> panic "compile: no interpreted code"

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

206
		   runPipeline (StopBefore Ln) dyn_flags ""
207
208
			True Nothing output_fn (Just location)
			-- the object filename comes from the ModLocation
209
210
211

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

213
	   let linkable = LM unlinked_time this_mod
214
215
			     (hs_unlinked ++ stub_unlinked)

216
	   return (CompOK details rdr_env iface (Just linkable))
217

218
-----------------------------------------------------------------------------
219
220
221
222
223
224
225
-- 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
226
	stub_o <- runPipeline (StopBefore Ln) dflags "stub-compile"
227
228
229
			True{-persistent output-} 
			Nothing{-no specific output file-}
			stub_c
230
			Nothing{-no ModLocation-}
231
232
233
	return (Just stub_o)


234
235
-- ---------------------------------------------------------------------------
-- Link
236
237
238
239

link :: GhciMode		-- interactive or batch
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
240
     -> HomePackageTable	-- what to link
241
242
243
244
245
246
247
248
249
250
     -> 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
251
252
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
253
254
255
	 return Succeeded
#endif

256
link Batch dflags batch_attempt_linking hpt
257
   | batch_attempt_linking
258
   = do 
259
260
261
262
263
264
265
266
267
268
269
270
271
	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)))

272
273
274
275
276
277
278
279
280
281
	-- check for the -no-link flag
	omit_linking <- readIORef v_NoLink
	if omit_linking 
	  then do when (verb >= 3) $
		    hPutStrLn stderr "link(batch): linking omitted (-no-link flag given)."
	          return Succeeded
	  else do

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

283
284
285
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

286
	-- Don't showPass in Batch mode; doLink will do that for us.
287
        staticLink dflags obj_files pkg_deps
288
289

        when (verb >= 3) (hPutStrLn stderr "link: done")
290
291
292
293
294
295
296
297
298
299
300

	-- 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
301
      
302
303
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
304

305
306
307
308
-- The DynFlags can be modified by phases in the pipeline (eg. by
-- OPTIONS pragmas), and the changes affect later phases in the
-- pipeline, but we throw away the resulting DynFlags at the end.

309
310
runPipeline
  :: GhcMode		-- when to stop
311
  -> DynFlags		-- dynamic flags
312
313
314
315
  -> String		-- "stop after" flag
  -> Bool		-- final output is persistent?
  -> Maybe FilePath	-- where to put the output, optionally
  -> FilePath 		-- input filename
316
  -> Maybe ModLocation  -- a ModLocation for this module, if we have one
317
318
  -> IO FilePath	-- output filename

319
320
runPipeline todo dflags stop_flag keep_output 
  maybe_output_filename input_fn maybe_loc
321
322
323
324
  = do
  split <- readIORef v_Split_object_files
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
325

326
327
328
329
330
331
      stop_phase = case todo of 
			StopBefore As | split -> SplitAs
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
			DoMkDLL               -> Ln
332

333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
  -- 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.
  --
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
		    ("flag `" ++ stop_flag
		     ++ "' is incompatible with source file `"
		     ++ input_fn ++ "'"))

  -- generate a function which will be used to calculate output file names
  -- as we go along.
  get_output_fn <- genOutputFilenameFunc keep_output maybe_output_filename
			stop_phase basename

  -- and execute the pipeline...
352
  (output_fn, maybe_loc) <- 
353
	pipeLoop dflags start_phase stop_phase input_fn basename suffix 
354
		 get_output_fn maybe_loc
355
356
357
358
359
360

  -- sometimes, a compilation phase doesn't actually generate any output
  -- (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.
  if keep_output
361
	then do final_fn <- get_output_fn stop_phase maybe_loc
362
	        when (final_fn /= output_fn) $
363
	 	  copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
364
365
366
367
368
369
			++ "'") output_fn final_fn
	        return final_fn
	else
	     return output_fn


370
pipeLoop :: DynFlags -> Phase -> Phase -> FilePath -> String -> Suffix
371
372
  -> (Phase -> Maybe ModLocation -> IO FilePath)
  -> Maybe ModLocation -> IO (FilePath, Maybe ModLocation)
373

374
pipeLoop dflags phase stop_phase input_fn orig_basename orig_suff 
375
376
377
	get_output_fn maybe_loc

  | phase == stop_phase  =  return (input_fn, maybe_loc)  -- all done
378
379
380
381
382
383
384
385
386

  | not (phase `happensBefore` stop_phase)  = 
	-- 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 #-}.
	panic ("pipeLoop: at phase " ++ show phase ++ 
		" but I wanted to stop at phase " ++ show stop_phase)

387
  | otherwise = do
388
389
	maybe_next_phase <- runPhase phase dflags orig_basename 
				orig_suff input_fn get_output_fn maybe_loc
390
	case maybe_next_phase of
391
	  (Nothing, dflags, maybe_loc, output_fn) -> do
392
393
		-- we stopped early, but return the *final* filename
		-- (it presumably already exists)
394
395
		final_fn <- get_output_fn stop_phase maybe_loc
		return (final_fn, maybe_loc)
396
397
	  (Just next_phase, dflags', maybe_loc, output_fn) ->
		pipeLoop dflags' next_phase stop_phase output_fn
398
			orig_basename orig_suff get_output_fn maybe_loc
399
400
401

  
genOutputFilenameFunc :: Bool -> Maybe FilePath -> Phase -> String
402
  -> IO (Phase{-next phase-} -> Maybe ModLocation -> IO FilePath)
403
404
genOutputFilenameFunc keep_final_output maybe_output_filename 
		stop_phase basename
405
 = do
406
   hcsuf      <- readIORef v_HC_suf
407
   odir       <- readIORef v_Output_dir
408
   osuf       <- readIORef v_Object_suf
409
   keep_hc    <- readIORef v_Keep_hc_files
sof's avatar
sof committed
410
#ifdef ILX
rrt's avatar
rrt committed
411
   keep_il    <- readIORef v_Keep_il_files
sof's avatar
sof committed
412
413
   keep_ilx   <- readIORef v_Keep_ilx_files
#endif
414
415
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
416
   let
417
418
419
420
        myPhaseInputExt HCc | Just s <- hcsuf = s
        myPhaseInputExt Ln    = osuf
        myPhaseInputExt other = phaseInputExt other

421
	func next_phase maybe_location
422
423
424
425
426
		| is_last_phase, Just f <- maybe_output_filename = return f
		| is_last_phase && keep_final_output = persistent_fn
		| keep_this_output 		     = persistent_fn
     		| otherwise        		     = newTempName suffix

427
	   where
428
429
430
431
432
433
434
435
436
437
438
		is_last_phase = next_phase == stop_phase

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
     			     Ln                  -> True
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

439
		suffix = myPhaseInputExt next_phase
440
441
442
443
444
445

		-- persistent object files get put in odir
	        persistent_fn 
		   | Ln <- next_phase  = return odir_persistent
		   | otherwise         = return persistent

446
		persistent = basename ++ '.':suffix
447

448
		odir_persistent
449
		   | Just loc <- maybe_location = ml_obj_file loc
450
451
452
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

453
   return func
454
455


456
457
458
459
460
461
462
463
464
465
466
-- -----------------------------------------------------------------------------
-- 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.

runPhase :: Phase
467
468
469
470
471
	 -> 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)
472
			-- how to calculate the output filename
473
474
475
476
477
	 -> Maybe ModLocation		-- the ModLocation, if we have one
	 -> IO (Maybe Phase,  		-- next phase
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
478
479
480
481

-------------------------------------------------------------------------------
-- Unlit phase 

482
483
runPhase Unlit dflags _basename _suff input_fn get_output_fn maybe_loc
  = do let unlit_flags = getOpts dflags opt_L
rrt's avatar
rrt committed
484
       -- The -h option passes the file name for unlit to put in a #line directive
485
       output_fn <- get_output_fn Cpp maybe_loc
486

487
488
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
489
490
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
491
492
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
493
			  ])
494

495
       return (Just Cpp, dflags, maybe_loc, output_fn)
496
497
498
499

-------------------------------------------------------------------------------
-- Cpp phase 

500
runPhase Cpp dflags basename suff input_fn get_output_fn maybe_loc
501
  = do src_opts <- getOptionsFromSource input_fn
502
503
       (dflags,unhandled_flags) <- processDynamicFlags src_opts dflags
       checkProcessArgsResult unhandled_flags (basename++'.':suff)
504

505
       if not (cppFlag dflags) then
sof's avatar
sof committed
506
507
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
508
          return (Just HsPp, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
509
	else do
510
	    output_fn <- get_output_fn HsPp maybe_loc
511
512
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
	    return (Just HsPp, dflags, maybe_loc, output_fn)
513

sof's avatar
sof committed
514
515
516
-------------------------------------------------------------------------------
-- HsPp phase 

517
518
runPhase HsPp dflags basename suff input_fn get_output_fn maybe_loc
  = do if not (ppFlag dflags) then
sof's avatar
sof committed
519
520
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
521
          return (Just Hsc, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
522
	else do
523
	    let hspp_opts = getOpts dflags opt_F
sof's avatar
sof committed
524
       	    hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
525
	    let orig_fn = basename ++ '.':suff
526
	    output_fn <- get_output_fn Hsc maybe_loc
527
528
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
529
530
531
532
533
534
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hs_src_pp_opts ++
			     map SysTools.Option hspp_opts
			   )
535
	    return (Just Hsc, dflags, maybe_loc, output_fn)
536

537
538
539
-----------------------------------------------------------------------------
-- Hsc phase

540
541
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
542
runPhase Hsc dflags basename suff input_fn get_output_fn _maybe_loc = do
543
544
  todo <- readIORef v_GhcMode
  if todo == DoMkDependHS then do
545
546
       locn <- doMkDependHSPhase dflags basename suff input_fn
       return (Nothing, dflags, Just locn, input_fn)  -- Ln is a dummy stop phase 
547
548
549
550

   else do
      -- normal Hsc mode, not mkdependHS

551
552
553
  -- 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.
554
	let current_dir = directoryOf basename
555
	
556
557
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
558
	
559
  -- gather the imports and module name
560
        (_,_,mod_name) <- 
561
            if isExtCoreFilename ('.':suff)
562
563
564
	     then do
               -- no explicit imports in ExtCore input.
	       m <- getCoreModuleName input_fn
565
	       return ([], [], mkModule m)
566
567
	     else 
  	       getImportsFromFile input_fn
568

569
  -- build a ModLocation to pass to hscMain.
570
	location' <- mkHomeModLocation mod_name (basename ++ '.':suff)
571
572
573
574
575
576

  -- take -ohi into account if present
	ohi <- readIORef v_Output_hi
	let location | Just fn <- ohi = location'{ ml_hi_file = fn }
		     | otherwise      = location'

577
578
579
580
  -- figure out if the source has changed, for recompilation avoidance.
  -- only do this if we're eventually going to generate a .o file.
  -- (ToDo: do when generating .hc files too?)
  --
581
  -- Setting source_unchanged to True means that M.o seems
582
583
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
584
  -- Setting source_unchanged to False tells the compiler that M.o is out of
585
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
586
587
	do_recomp   <- readIORef v_Recomp
	expl_o_file <- readIORef v_Output_file
588
589
590
591
592

	let o_file -- if the -o option is given and IT IS THE OBJECT FILE FOR
		   -- THIS COMPILATION, then use that to determine if the 
		   -- source is unchanged.
		| Just x <- expl_o_file, todo == StopBefore Ln  =  x
593
		| otherwise = ml_obj_file location
594

595
596
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
597
	     then return False
598
599
600
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
601
		        then return False	-- Need to recompile
602
603
			else do t2 <- getModificationTime o_file
			        if t2 > t1
604
605
				  then return True
				  else return False
606

607
  -- get the DynFlags
608
	hsc_lang <- hscMaybeAdjustLang (hscLang dflags)
609
	next_phase <- hscNextPhase hsc_lang
610
	output_fn <- get_output_fn next_phase (Just location)
611

612
613
614
615
616
617
        let dflags' = dflags { hscLang = hsc_lang,
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
	hsc_env <- newHscEnv OneShot dflags'
618

619
  -- run the compiler!
620
	result <- hscMain hsc_env printErrorsAndWarnings mod_name
621
			  location{ ml_hspp_file=Just input_fn }
622
			  source_unchanged
623
			  False
624
			  Nothing	 -- no iface
625

626
	case result of
627

628
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
629

630
            HscNoRecomp details iface -> do
631
632
		SysTools.touch dflags' "Touching object file" o_file
		return (Nothing, dflags', Just location, output_fn)
633

634
635
	    HscRecomp _details _rdr_env _iface 
		      stub_h_exists stub_c_exists
636
		      _maybe_interpreted_code -> do
637

638
		-- deal with stubs
639
		maybe_stub_o <- compileStub dflags' stub_c_exists
640
641
642
		case maybe_stub_o of
		      Nothing -> return ()
		      Just stub_o -> add v_Ld_inputs stub_o
643
644
645
		case hscLang dflags' of
                      HscNothing -> return (Nothing, dflags', Just location, output_fn)
		      _ -> return (Just next_phase, dflags', Just location, output_fn)
646

647
648
649
-----------------------------------------------------------------------------
-- Cmm phase

650
runPhase CmmCpp dflags basename suff input_fn get_output_fn maybe_loc
651
652
  = do
       output_fn <- get_output_fn Cmm maybe_loc
653
654
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
       return (Just Cmm, dflags, maybe_loc, output_fn)
655

656
runPhase Cmm dflags basename suff input_fn get_output_fn maybe_loc
657
  = do
658
	hsc_lang <- hscMaybeAdjustLang (hscLang dflags)
659
660
661
	next_phase <- hscNextPhase hsc_lang
	output_fn <- get_output_fn next_phase maybe_loc

662
663
664
665
666
        let dflags' = dflags { hscLang = hsc_lang,
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
667

668
	ok <- hscCmmFile dflags' input_fn
669
670
671

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

672
	return (Just next_phase, dflags, maybe_loc, output_fn)
673

674
675
676
677
678
679
-----------------------------------------------------------------------------
-- 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.

680
runPhase cc_phase dflags basename suff input_fn get_output_fn maybe_loc
681
   | cc_phase == Cc || cc_phase == HCc
682
   = do	let cc_opts = getOpts dflags opt_c
rrt's avatar
rrt committed
683
       	cmdline_include_paths <- readIORef v_Include_paths
684

685
686
687
	split  <- readIORef v_Split_object_files
	mangle <- readIORef v_Do_asm_mangling

688
689
        let hcc = cc_phase == HCc

690
691
692
693
	    next_phase
		| hcc && mangle     = Mangle
		| otherwise         = As

694
	output_fn <- get_output_fn next_phase maybe_loc
695

696
697
698
699
700
701
	-- 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 :)
702
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
703
704
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
705

706
	mangle <- readIORef v_Do_asm_mangling
707
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts dflags
708

709
        let verb = getVerbFlag dflags
710

711
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
712

713
	split_objs <- readIORef v_Split_object_files
sof's avatar
sof committed
714
715
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]
716

717
	excessPrecision <- readIORef v_Excess_precision
718
719
720
721
722
723
724

	-- force the C compiler to interpret this file as C when
	-- compiling .hc files, by adding the -x c option.
	let langopt
		| cc_phase == HCc = [ SysTools.Option "-x", SysTools.Option "c"]
		| otherwise       = [ ]

725
	SysTools.runCc dflags (langopt ++
726
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
727
			, SysTools.Option "-o"
sof's avatar
sof committed
728
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
729
730
731
			]
		       ++ map SysTools.Option (
		          md_c_flags
732
733
734
		       ++ (if cc_phase == HCc && mangle
		  	     then md_regd_c_flags
		  	     else [])
735
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
736
737
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
738
		       ++ split_opt
739
740
741
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
742
		       ))
743

744
	return (Just next_phase, dflags, maybe_loc, output_fn)
745
746
747
748
749
750

	-- ToDo: postprocess the output from gcc

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

751
752
runPhase Mangle dflags _basename _suff input_fn get_output_fn maybe_loc
   = do let mangler_opts = getOpts dflags opt_m
753
        machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
754
			  then do let n_regs = stolen_x86_regs dflags
755
756
757
758
759
760
761
			          return [ show n_regs ]
		          else return []

	split <- readIORef v_Split_object_files
	let next_phase
		| split = SplitMangle
		| otherwise = As
762
	output_fn <- get_output_fn next_phase maybe_loc
763

764
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
765
766
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
767
768
			     ]
			  ++ map SysTools.Option machdep_opts)
769

770
	return (Just next_phase, dflags, maybe_loc, output_fn)
771
772
773
774

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

775
runPhase SplitMangle dflags _basename _suff input_fn get_output_fn maybe_loc
776
777
778
779
  = 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)
	split_s_prefix <- SysTools.newTempName "split"
	let n_files_fn = split_s_prefix
780

781
782
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
783
784
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
785
			  ]
786
787
788
789
790
791
792
793
794

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

796
	return (Just SplitAs, dflags, maybe_loc, "**splitmangle**")
797
	  -- we don't use the filename
798
799
800
801

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

802
803
runPhase As dflags _basename _suff input_fn get_output_fn maybe_loc
  = do	let as_opts =  getOpts dflags opt_a
804
        cmdline_include_paths <- readIORef v_Include_paths
805

806
	output_fn <- get_output_fn Ln maybe_loc
807

808
809
810
811
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

812
813
	SysTools.runAs dflags	
		       (map SysTools.Option as_opts
sof's avatar
sof committed
814
815
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
816
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
817
			  , SysTools.Option "-o"
sof's avatar
sof committed
818
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
819
			  ])
820

821
	return (Just Ln, dflags, maybe_loc, output_fn)
822
823


824
825
runPhase SplitAs dflags basename _suff _input_fn get_output_fn maybe_loc
  = do  let as_opts = getOpts dflags opt_a
826

827
	(split_s_prefix, n) <- readIORef v_Split_info
828

829
	odir <- readIORef v_Output_dir
830
	let real_odir = case odir of
831
				Nothing -> basename ++ "_split"
832
833
				Just d  -> d

834
835
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
836
		    let output_o = replaceFilenameDirectory
837
					(basename ++ "__" ++ show n ++ ".o")
838
					 real_odir
839
		    real_o <- osuf_ify output_o
840
841
		    SysTools.runAs dflags
				 (map SysTools.Option as_opts ++
sof's avatar
sof committed
842
843
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
sof's avatar
sof committed
844
845
				    , SysTools.FileOption "" real_o
				    , SysTools.FileOption "" input_s
sof's avatar
sof committed
846
				    ])
847
848
	
	mapM_ assemble_file [1..n]
849

850
	output_fn <- get_output_fn Ln maybe_loc
851
	return (Just Ln, dflags, maybe_loc, output_fn)
852

rrt's avatar
rrt committed
853
854
855
856
857
#ifdef ILX
-----------------------------------------------------------------------------
-- Ilx2Il phase
-- Run ilx2il over the ILX output, getting an IL file

858
859
runPhase Ilx2Il dflags _basename _suff input_fn get_output_fn maybe_loc
  = do	let ilx2il_opts = getOpts dflags opt_I
rrt's avatar
rrt committed
860
861
862
863
        SysTools.runIlx2il (map SysTools.Option ilx2il_opts
                           ++ [ SysTools.Option "--no-add-suffix-to-assembly",
				SysTools.Option "mscorlib",
				SysTools.Option "-o",
sof's avatar
sof committed
864
865
				SysTools.FileOption "" output_fn,
				SysTools.FileOption "" input_fn ])
866
	return True
rrt's avatar
rrt committed
867
868
869
870
871

-----------------------------------------------------------------------------
-- Ilasm phase
-- Run ilasm over the IL, getting a DLL

872
873
runPhase Ilasm dflags _basename _suff input_fn get_output_fn maybe_loc
  = do	let ilasm_opts = getOpts dflags opt_i
rrt's avatar
rrt committed
874
875
876
        SysTools.runIlasm (map SysTools.Option ilasm_opts
		           ++ [ SysTools.Option "/QUIET",
				SysTools.Option "/DLL",
sof's avatar
sof committed
877
878
				SysTools.FileOption "/OUT=" output_fn,
				SysTools.FileOption "" input_fn ])
879
	return True
rrt's avatar
rrt committed
880

ross's avatar
ross committed
881
#endif /* ILX */
rrt's avatar
rrt committed
882

883
884
885
886
887
888
-----------------------------------------------------------------------------
-- 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.
889
-- This is called from staticLink below, after linking. I haven't made it
890
891
892
893
-- 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

894
runPhase_MoveBinary input_fn
895
  = do	
896
        sysMan   <- getSysMan
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
        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);"
 ]

967
968
969
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

970
checkProcessArgsResult flags filename
sof's avatar
sof committed
971
  = do when (notNull flags) (throwDyn (ProgramError (
972
	  showSDoc (hang (text filename <> char ':')
973
974
975
976
977
978
979
		      4 (text "unknown flags in  {-# OPTIONS #-} pragma:" <+>
			  hsep (map text flags)))
	)))

-----------------------------------------------------------------------------
-- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file

980
getHCFilePackages :: FilePath -> IO [PackageId]
981
982
983
984
985
getHCFilePackages filename =
  EXCEPTION.bracket (openFile filename ReadMode) hClose $ \h -> do
    l <- hGetLine h
    case l of
      '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
986
	  return (map stringToPackageId (words rest))
987
988
      _other ->
	  return []
989

990
-----------------------------------------------------------------------------
991
-- Static linking, of .o files
992

993
994
995
996
997
998
999
1000
1001
1002
-- The list of packages passed to link is the list of packages on
-- which this program depends, as discovered by the compilation
-- manager.  It is combined with the list of packages that the user
-- specifies on the command line with -package flags.  
--
-- In one-shot linking mode, we can't discover the package
-- dependencies (because we haven't actually done any compilation or
-- read any interface files), so the user must explicitly specify all
-- the packages.

1003
1004
1005
staticLink :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
staticLink dflags o_files dep_packages = do
    let verb = getVerbFlag dflags
1006
    static     <- readIORef v_Static
1007
1008
    no_hs_main <- readIORef v_NoHsMain

1009
1010
1011
1012
    -- get the full list of packages to link with, by combining the
    -- explicit packages with the auto packages and all of their
    -- dependencies, and eliminating duplicates.

1013
    o_file <- readIORef v_Output_file
1014
1015
1016
#if defined(mingw32_HOST_OS)
    let output_fn = case o_file of { Just s -> s; Nothing -> "main.exe"; }
#else
1017
    let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1018
#endif
1019

1020
    pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1021
1022
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

1023
    lib_paths <- readIORef v_Library_paths
1024
1025
    let lib_path_opts = map ("-L"++) lib_paths

1026
    pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1027

1028
#ifdef darwin_TARGET_OS
1029
    pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1030
1031
1032
1033
1034
    let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths

    framework_paths <- readIORef v_Framework_paths
    let framework_path_opts = map ("-F"++) framework_paths

1035
    pkg_frameworks <- getPackageFrameworks dflags dep_packages
1036
    let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1037
1038

    frameworks <- readIORef v_Cmdline_frameworks
1039
    let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1040
1041
1042
	 -- reverse because they're added in reverse order from the cmd line
#endif