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

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

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
69
70

-- Just preprocess a file, put the result in a temp. file (used by the
-- compilation manager during the summary phase).

preprocess :: FilePath -> IO FilePath
preprocess filename =
71
  ASSERT(isHaskellSrcFilename filename) 
72
  do restoreDynFlags	-- Restore to state of last save
73
74
75
76
     runPipeline (StopBefore Hsc) ("preprocess") 
	False{-temporary output file-}
	Nothing{-no specific output file-}
	filename
77
	Nothing{-no ModLocation-}
78

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

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

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

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

115
   | CompErrs 
116
117


118
compile hsc_env this_mod location src_timestamp
119
	source_unchanged have_object 
120
	old_iface = do 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

   dyn_flags <- restoreDynFlags		-- Restore to the state of the last save

   showPass dyn_flags 
	(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)
   let mod_name   = moduleName this_mod

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

   opts <- getOptionsFromSource input_fnpp
   processArgs dynamic_flags opts []
   dyn_flags <- getDynFlags

138
   let (basename, _) = splitFilename input_fn
139
       
140
141
142
143
144
145
   -- 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
146
   output_fn <- get_output_fn next_phase (Just location)
147
148
149

   let dyn_flags' = dyn_flags { hscLang = hsc_lang,
				hscOutName = output_fn,
150
151
152
153
154
155
156
				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
157
       hsc_env' = hsc_env { hsc_dflags = dyn_flags' }
158
159

   -- run the compiler
160
   hsc_result <- hscMain hsc_env' printErrorsAndWarnings this_mod location
161
162
163
			 source_unchanged' have_object old_iface

   case hsc_result of
164
      HscFail -> return CompErrs
165

166
      HscNoRecomp details iface -> return (CompOK details Nothing iface Nothing)
167

168
      HscRecomp details rdr_env iface
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
	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
184
185
186
187
188
189
190
		       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.
191
192
193
194
#endif
		       Nothing -> panic "compile: no interpreted code"

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

		   runPipeline (StopBefore Ln) ""
199
200
			True Nothing output_fn (Just location)
			-- the object filename comes from the ModLocation
201
202
203

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

	   let linkable = LM unlinked_time mod_name
			     (hs_unlinked ++ stub_unlinked)

208
	   return (CompOK details rdr_env iface (Just linkable))
209

210
-----------------------------------------------------------------------------
211
212
213
214
215
216
217
-- 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
218
219
220
221
	stub_o <- runPipeline (StopBefore Ln) "stub-compile"
			True{-persistent output-} 
			Nothing{-no specific output file-}
			stub_c
222
			Nothing{-no ModLocation-}
223
224
225
	return (Just stub_o)


226
227
-- ---------------------------------------------------------------------------
-- Link
228
229
230
231

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

248
link Batch dflags batch_attempt_linking hpt
249
   | batch_attempt_linking
250
   = do 
251
252
253
254
255
256
257
258
259
260
261
262
263
	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)))

264
265
266
267
268
269
270
271
272
273
	-- 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 ..."
274

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

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

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

	-- 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
293
      
294
295
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
296

297
298
299
300
301
302
runPipeline
  :: GhcMode		-- when to stop
  -> String		-- "stop after" flag
  -> Bool		-- final output is persistent?
  -> Maybe FilePath	-- where to put the output, optionally
  -> FilePath 		-- input filename
303
  -> Maybe ModLocation  -- a ModLocation for this module, if we have one
304
305
  -> IO FilePath	-- output filename

306
runPipeline todo stop_flag keep_output maybe_output_filename input_fn maybe_loc
307
308
309
310
  = do
  split <- readIORef v_Split_object_files
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
311

312
313
314
315
316
317
      stop_phase = case todo of 
			StopBefore As | split -> SplitAs
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
			DoMkDLL               -> Ln
318

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
  -- 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...
338
339
340
  (output_fn, maybe_loc) <- 
	pipeLoop start_phase stop_phase input_fn basename suffix 
		 get_output_fn maybe_loc
341
342
343
344
345
346

  -- 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
347
	then do final_fn <- get_output_fn stop_phase maybe_loc
348
349
350
351
352
353
354
355
356
	        when (final_fn /= output_fn) $
	 	  copy ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
			++ "'") output_fn final_fn
	        return final_fn
	else
	     return output_fn


pipeLoop :: Phase -> Phase -> FilePath -> String -> Suffix
357
358
  -> (Phase -> Maybe ModLocation -> IO FilePath)
  -> Maybe ModLocation -> IO (FilePath, Maybe ModLocation)
359

360
361
362
363
pipeLoop phase stop_phase input_fn orig_basename orig_suff 
	get_output_fn maybe_loc

  | phase == stop_phase  =  return (input_fn, maybe_loc)  -- all done
364
365
366
367
368
369
370
371
372

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

373
374
  | otherwise = do
	maybe_next_phase <- runPhase phase orig_basename orig_suff input_fn
375
				get_output_fn maybe_loc
376
	case maybe_next_phase of
377
	  (Nothing, maybe_loc, output_fn) -> do
378
379
		-- we stopped early, but return the *final* filename
		-- (it presumably already exists)
380
381
382
		final_fn <- get_output_fn stop_phase maybe_loc
		return (final_fn, maybe_loc)
	  (Just next_phase, maybe_loc, output_fn) ->
383
		pipeLoop next_phase stop_phase output_fn
384
			orig_basename orig_suff get_output_fn maybe_loc
385
386
387

  
genOutputFilenameFunc :: Bool -> Maybe FilePath -> Phase -> String
388
  -> IO (Phase{-next phase-} -> Maybe ModLocation -> IO FilePath)
389
390
genOutputFilenameFunc keep_final_output maybe_output_filename 
		stop_phase basename
391
 = do
392
   hcsuf      <- readIORef v_HC_suf
393
   odir       <- readIORef v_Output_dir
394
   osuf       <- readIORef v_Object_suf
395
   keep_hc    <- readIORef v_Keep_hc_files
sof's avatar
sof committed
396
#ifdef ILX
rrt's avatar
rrt committed
397
   keep_il    <- readIORef v_Keep_il_files
sof's avatar
sof committed
398
399
   keep_ilx   <- readIORef v_Keep_ilx_files
#endif
400
401
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
402
   let
403
404
405
406
        myPhaseInputExt HCc | Just s <- hcsuf = s
        myPhaseInputExt Ln    = osuf
        myPhaseInputExt other = phaseInputExt other

407
	func next_phase maybe_location
408
409
410
411
412
		| 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

413
	   where
414
415
416
417
418
419
420
421
422
423
424
		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

425
		suffix = myPhaseInputExt next_phase
426
427
428
429
430
431

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

432
		persistent = basename ++ '.':suffix
433

434
		odir_persistent
435
		   | Just loc <- maybe_location = ml_obj_file loc
436
437
438
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

439
   return func
440
441


442
443
444
445
446
447
448
449
450
451
452
453
454
455
-- -----------------------------------------------------------------------------
-- 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
	  -> String	-- basename of original input source
	  -> String	-- its extension
	  -> FilePath	-- name of file which contains the input to this phase.
456
457
458
459
460
461
	  -> (Phase -> Maybe ModLocation -> IO FilePath)
			-- how to calculate the output filename
	  -> Maybe ModLocation		-- the ModLocation, if we have one
	  -> IO (Maybe Phase,  		-- next phase
		 Maybe ModLocation,	-- the ModLocation, if we have one
		 FilePath)		-- output filename
462
463
464
465

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

466
runPhase Unlit _basename _suff input_fn get_output_fn maybe_loc
467
  = do unlit_flags <- getOpts opt_L
rrt's avatar
rrt committed
468
       -- The -h option passes the file name for unlit to put in a #line directive
469
       output_fn <- get_output_fn Cpp maybe_loc
470

sof's avatar
sof committed
471
472
473
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
474
475
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
476
			  ])
477

478
       return (Just Cpp, maybe_loc, output_fn)
479
480
481
482

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

483
runPhase Cpp basename suff input_fn get_output_fn maybe_loc
484
  = do src_opts <- getOptionsFromSource input_fn
485
       unhandled_flags <- processArgs dynamic_flags src_opts []
486
       checkProcessArgsResult unhandled_flags basename suff
487

488
       do_cpp <- dynFlag cppFlag
sof's avatar
sof committed
489
490
491
       if not do_cpp then
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
492
          return (Just HsPp, maybe_loc, input_fn)
sof's avatar
sof committed
493
	else do
494
	    hscpp_opts	    <- getOpts opt_P
495
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
496

497
	    cmdline_include_paths <- readIORef v_Include_paths
498
499

	    pkg_include_dirs <- getPackageIncludePath []
rrt's avatar
rrt committed
500
501
	    let include_paths = foldr (\ x xs -> "-I" : x : xs) []
				  (cmdline_include_paths ++ pkg_include_dirs)
502

503
	    verb <- getVerbFlag
rrt's avatar
rrt committed
504
	    (md_c_flags, _) <- machdepCCOpts
505

506
	    output_fn <- get_output_fn HsPp maybe_loc
507

sof's avatar
sof committed
508
509
510
511
512
	    SysTools.runCpp ([SysTools.Option verb]
			    ++ map SysTools.Option include_paths
			    ++ map SysTools.Option hs_src_cpp_opts
			    ++ map SysTools.Option hscpp_opts
			    ++ map SysTools.Option md_c_flags
sof's avatar
sof committed
513
514
			    ++ [ SysTools.Option     "-x"
			       , SysTools.Option     "c"
515
516
517
518
519
520
521
522
523
			       , SysTools.Option     input_fn
	-- We hackily use Option instead of FileOption here, so that the file
	-- name is not back-slashed on Windows.  cpp is capable of
	-- dealing with / in filenames, so it works fine.  Furthermore
	-- if we put in backslashes, cpp outputs #line directives
	-- with *double* backslashes.   And that in turn means that
	-- our error messages get double backslashes in them.
	-- In due course we should arrange that the lexer deals
	-- with these \\ escapes properly.
sof's avatar
sof committed
524
			       , SysTools.Option     "-o"
sof's avatar
sof committed
525
			       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
526
			       ])
527

528
	    return (Just HsPp, maybe_loc, output_fn)
529

sof's avatar
sof committed
530
531
532
-------------------------------------------------------------------------------
-- HsPp phase 

533
runPhase HsPp basename suff input_fn get_output_fn maybe_loc
534
  = do do_pp   <- dynFlag ppFlag
sof's avatar
sof committed
535
536
537
       if not do_pp then
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
538
          return (Just Hsc, maybe_loc, input_fn)
sof's avatar
sof committed
539
540
541
	else do
	    hspp_opts	   <- getOpts opt_F
       	    hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
542
	    let orig_fn = basename ++ '.':suff
543
	    output_fn <- get_output_fn Hsc maybe_loc
sof's avatar
sof committed
544
545
546
547
548
549
550
	    SysTools.runPp ( [ SysTools.Option     orig_fn
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hs_src_pp_opts ++
			     map SysTools.Option hspp_opts
			   )
551
	    return (Just Hsc, maybe_loc, output_fn)
552

553
554
555
-----------------------------------------------------------------------------
-- Hsc phase

556
557
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
558
runPhase Hsc basename suff input_fn get_output_fn _maybe_loc = do
559
560
  todo <- readIORef v_GhcMode
  if todo == DoMkDependHS then do
561
562
       locn <- doMkDependHSPhase basename suff input_fn
       return (Nothing, Just locn, input_fn)  -- Ln is a dummy stop phase 
563
564
565
566

   else do
      -- normal Hsc mode, not mkdependHS

567
568
569
  -- 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.
570
	let current_dir = directoryOf basename
571
	
572
573
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
574
	
575
  -- gather the imports and module name
576
        (_,_,mod_name) <- 
577
            if isExtCoreFilename ('.':suff)
578
579
580
581
582
583
	     then do
               -- no explicit imports in ExtCore input.
	       m <- getCoreModuleName input_fn
	       return ([], [], mkModuleName m)
	     else 
  	       getImportsFromFile input_fn
584

585
  -- build a ModLocation to pass to hscMain.
586
	(mod, location') <- mkHomeModLocation mod_name (basename ++ '.':suff)
587
588
589
590
591
592

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

593
594
595
596
  -- 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?)
  --
597
  -- Setting source_unchanged to True means that M.o seems
598
599
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
600
  -- Setting source_unchanged to False tells the compiler that M.o is out of
601
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
602
603
	do_recomp   <- readIORef v_Recomp
	expl_o_file <- readIORef v_Output_file
604
605
606
607
608

	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
609
		| otherwise = ml_obj_file location
610

611
612
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
613
	     then return False
614
615
616
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
617
		        then return False	-- Need to recompile
618
619
			else do t2 <- getModificationTime o_file
			        if t2 > t1
620
621
				  then return True
				  else return False
622

623
  -- get the DynFlags
624
        dyn_flags <- getDynFlags
625
626
	hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
	next_phase <- hscNextPhase hsc_lang
627
	output_fn <- get_output_fn next_phase (Just location)
628

629
630
        let dyn_flags' = dyn_flags { hscLang = hsc_lang,
				     hscOutName = output_fn,
631
		   		     hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
632
				     hscStubHOutName = basename ++ "_stub.h",
apt's avatar
apt committed
633
				     extCoreName = basename ++ ".hcr" }
634
	hsc_env <- newHscEnv OneShot dyn_flags'
635

636
  -- run the compiler!
637
	result <- hscMain hsc_env printErrorsAndWarnings mod
638
			  location{ ml_hspp_file=Just input_fn }
639
			  source_unchanged
640
			  False
641
			  Nothing	 -- no iface
642

643
	case result of
644

645
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
646

647
            HscNoRecomp details iface -> do
648
		SysTools.touch "Touching object file" o_file
649
		return (Nothing, Just location, output_fn)
650

651
652
	    HscRecomp _details _rdr_env _iface 
		      stub_h_exists stub_c_exists
653
		      _maybe_interpreted_code -> do
654

655
656
657
658
659
660
		-- deal with stubs
		maybe_stub_o <- compileStub dyn_flags' stub_c_exists
		case maybe_stub_o of
		      Nothing -> return ()
		      Just stub_o -> add v_Ld_inputs stub_o
		case hscLang dyn_flags of
661
662
                      HscNothing -> return (Nothing, Just location, output_fn)
		      _ -> return (Just next_phase, Just location, output_fn)
663
664
665
666
667
668
669

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

670
runPhase cc_phase basename suff input_fn get_output_fn maybe_loc
671
   | cc_phase == Cc || cc_phase == HCc
672
   = do	cc_opts <- getOpts opt_c
rrt's avatar
rrt committed
673
       	cmdline_include_paths <- readIORef v_Include_paths
674

675
676
677
	split  <- readIORef v_Split_object_files
	mangle <- readIORef v_Do_asm_mangling

678
679
        let hcc = cc_phase == HCc

680
681
682
683
	    next_phase
		| hcc && mangle     = Mangle
		| otherwise         = As

684
	output_fn <- get_output_fn next_phase maybe_loc
685

686
687
688
689
690
691
692
	-- 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 :)
        pkg_include_dirs <- getPackageIncludePath pkgs
rrt's avatar
rrt committed
693
694
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
695

696
	mangle <- readIORef v_Do_asm_mangling
697
698
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

699
        verb <- getVerbFlag
700

701
	pkg_extra_cc_opts <- getPackageExtraCcOpts pkgs
702

703
	split_objs <- readIORef v_Split_object_files
sof's avatar
sof committed
704
705
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]
706

707
	excessPrecision <- readIORef v_Excess_precision
708
709
710
711
712
713
714
715
716

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

	SysTools.runCc (langopt ++
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
717
			, SysTools.Option "-o"
sof's avatar
sof committed
718
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
719
720
721
			]
		       ++ map SysTools.Option (
		          md_c_flags
722
723
724
		       ++ (if cc_phase == HCc && mangle
		  	     then md_regd_c_flags
		  	     else [])
725
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
726
727
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
728
		       ++ split_opt
729
730
731
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
732
		       ))
733

734
	return (Just next_phase, maybe_loc, output_fn)
735
736
737
738
739
740

	-- ToDo: postprocess the output from gcc

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

741
runPhase Mangle _basename _suff input_fn get_output_fn maybe_loc
742
743
744
745
746
747
748
749
750
751
   = do mangler_opts <- getOpts opt_m
        machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
			  then do n_regs <- dynFlag stolen_x86_regs
			          return [ show n_regs ]
		          else return []

	split <- readIORef v_Split_object_files
	let next_phase
		| split = SplitMangle
		| otherwise = As
752
	output_fn <- get_output_fn next_phase maybe_loc
753

754
	SysTools.runMangle (map SysTools.Option mangler_opts
sof's avatar
sof committed
755
756
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
757
758
			     ]
			  ++ map SysTools.Option machdep_opts)
759

760
	return (Just next_phase, maybe_loc, output_fn)
761
762
763
764

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

765
runPhase SplitMangle _basename _suff input_fn get_output_fn maybe_loc
766
767
768
769
  = 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
770

sof's avatar
sof committed
771
772
773
	SysTools.runSplit [ SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
774
			  ]
775
776
777
778
779
780
781
782
783

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

785
786
	return (Just SplitAs, maybe_loc, "**splitmangle**")
	  -- we don't use the filename
787
788
789
790

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

791
runPhase As _basename _suff input_fn get_output_fn maybe_loc
792
  = do	as_opts		      <- getOpts opt_a
793
        cmdline_include_paths <- readIORef v_Include_paths
794

795
	output_fn <- get_output_fn Ln maybe_loc
796

797
798
799
800
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

sof's avatar
sof committed
801
802
803
	SysTools.runAs (map SysTools.Option as_opts
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
804
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
805
			  , SysTools.Option "-o"
sof's avatar
sof committed
806
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
807
			  ])
808

809
	return (Just Ln, maybe_loc, output_fn)
810
811


812
runPhase SplitAs basename _suff _input_fn get_output_fn maybe_loc
813
  = do  as_opts <- getOpts opt_a
814

815
	(split_s_prefix, n) <- readIORef v_Split_info
816

817
	odir <- readIORef v_Output_dir
818
	let real_odir = case odir of
819
				Nothing -> basename ++ "_split"
820
821
				Just d  -> d

822
823
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
824
		    let output_o = replaceFilenameDirectory
825
					(basename ++ "__" ++ show n ++ ".o")
826
					 real_odir
827
		    real_o <- osuf_ify output_o
sof's avatar
sof committed
828
829
830
		    SysTools.runAs (map SysTools.Option as_opts ++
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
sof's avatar
sof committed
831
832
				    , SysTools.FileOption "" real_o
				    , SysTools.FileOption "" input_s
sof's avatar
sof committed
833
				    ])
834
835
	
	mapM_ assemble_file [1..n]
836

837
838
	output_fn <- get_output_fn Ln maybe_loc
	return (Just Ln, maybe_loc, output_fn)
839

rrt's avatar
rrt committed
840
841
842
843
844
#ifdef ILX
-----------------------------------------------------------------------------
-- Ilx2Il phase
-- Run ilx2il over the ILX output, getting an IL file

845
runPhase Ilx2Il _basename _suff input_fn get_output_fn maybe_loc
rrt's avatar
rrt committed
846
  = do	ilx2il_opts <- getOpts opt_I
rrt's avatar
rrt committed
847
848
849
850
        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
851
852
				SysTools.FileOption "" output_fn,
				SysTools.FileOption "" input_fn ])
853
	return True
rrt's avatar
rrt committed
854
855
856
857
858

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

859
runPhase Ilasm _basename _suff input_fn get_output_fn maybe_loc
rrt's avatar
rrt committed
860
  = do	ilasm_opts <- getOpts opt_i
rrt's avatar
rrt committed
861
862
863
        SysTools.runIlasm (map SysTools.Option ilasm_opts
		           ++ [ SysTools.Option "/QUIET",
				SysTools.Option "/DLL",
sof's avatar
sof committed
864
865
				SysTools.FileOption "/OUT=" output_fn,
				SysTools.FileOption "" input_fn ])
866
	return True
rrt's avatar
rrt committed
867

ross's avatar
ross committed
868
#endif /* ILX */
rrt's avatar
rrt committed
869

870
871
872
873
874
875
-----------------------------------------------------------------------------
-- 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.
876
-- This is called from staticLink below, after linking. I haven't made it
877
878
879
880
-- 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

881
runPhase_MoveBinary input_fn
882
  = do	
883
        sysMan   <- getSysMan
884
885
886
887
888
889
890
891
892
893
894
895
896
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
        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);"
 ]

954
955
956
957
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
sof's avatar
sof committed
958
  = do when (notNull flags) (throwDyn (ProgramError (
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
	  showSDoc (hang (text basename <> text ('.':suff) <> char ':')
		      4 (text "unknown flags in  {-# OPTIONS #-} pragma:" <+>
			  hsep (map text flags)))
	)))

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

getHCFilePackages :: FilePath -> IO [PackageName]
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 ->
	  return (map mkPackageName (words rest))
      _other ->
	  return []
976

977
-----------------------------------------------------------------------------
978
-- Static linking, of .o files
979

980
981
982
983
984
985
986
987
988
989
990
991
-- 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.

staticLink :: [FilePath] -> [PackageName] -> IO ()
staticLink o_files dep_packages = do
992
993
    verb       <- getVerbFlag
    static     <- readIORef v_Static
994
995
    no_hs_main <- readIORef v_NoHsMain

996
997
998
999
    -- 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.

1000
    o_file <- readIORef v_Output_file
1001
1002
    let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }

1003
    pkg_lib_paths <- getPackageLibraryPath dep_packages
1004
1005
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

1006
    lib_paths <- readIORef v_Library_paths
1007
1008
    let lib_path_opts = map ("-L"++) lib_paths

1009
    pkg_link_opts <- getPackageLinkOpts dep_packages
1010

1011
#ifdef darwin_TARGET_OS
1012
    pkg_framework_paths <- getPackageFrameworkPath dep_packages
1013
1014
1015
1016
1017
    let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths

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

1018
    pkg_frameworks <- getPackageFrameworks dep_packages
1019
    let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1020
1021

    frameworks <- readIORef v_Cmdline_frameworks
1022
    let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1023
1024
1025
	 -- reverse because they're added in reverse order from the cmd line
#endif

1026
	-- probably _stub.o files
1027
    extra_ld_inputs <- readIORef v_Ld_inputs
1028

1029
	-- opts from -optl-<blah> (including -l<blah> options)
1030
    extra_ld_opts <- getStaticOpts v_Opt_l
1031

1032
    [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1033

1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
    ways <- readIORef v_Ways

    -- Here are some libs that need to be linked at the *end* of
    -- the command line, because they contain symbols that are referred to
    -- by the RTS.  We can't therefore use the ordinary way opts for these.
    let
	debug_opts | WayDebug `elem` ways = [ 
#if defined(HAVE_LIBBFD)
			"-lbfd", "-liberty"
#endif
			 ]
		   | otherwise            = []

    let
	thread_opts | WayThreaded `elem` ways = [ 
#if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
			"-lpthread"
#endif
#if defined(osf3_TARGET_OS)
			, "-lexc"
#endif
			]
		    | otherwise               = []

1058
1059
    let extra_os = if static || no_hs_main
                   then []
1060
1061
                   else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
                          head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1062

1063
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
1064
1065
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
sof's avatar
sof committed
1066
		       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
1067
1068
1069
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
1070
1071
1072
1073
	 	      ++ o_files
		      ++ extra_os
		      ++ extra_ld_inputs
	 	      ++ lib_path_opts
1074
	 	      ++ extra_ld_opts
1075
1076
1077
1078
#ifdef darwin_TARGET_OS
	 	      ++ framework_path_opts
	 	      ++ framework_opts
#endif
1079
	 	      ++ pkg_lib_path_opts
1080
	 	      ++ pkg_link_opts
1081
1082
1083
1084
#ifdef darwin_TARGET_OS
	 	      ++ pkg_framework_path_opts
	 	      ++ pkg_framework_opts
#endif
1085
1086
		      ++ debug_opts
		      ++ thread_opts
1087
		    ))
1088

1089
1090
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
1091
    when (WayPar `elem` ways_)
1092
	 (do success <- runPhase_MoveBinary output_fn
1093
1094
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1095

rrt's avatar
rrt committed
1096
-----------------------------------------------------------------------------
1097
-- Making a DLL (only for Win32)