DriverPipeline.hs 38.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
#ifdef GHCI
56
import Time 		( getClockTime )
57
#endif
58
59
import Directory
import System
60
61
62
63
import IO
import Monad
import Maybe

64

65
66
-- ---------------------------------------------------------------------------
-- Pre-process
67
68
69
70
71
72

-- 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 =
73
  ASSERT(isHaskellSrcFilename filename) 
74
  do restoreDynFlags	-- Restore to state of last save
75
76
77
78
     runPipeline (StopBefore Hsc) ("preprocess") 
	False{-temporary output file-}
	Nothing{-no specific output file-}
	filename
79
	Nothing{-no ModLocation-}
80

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

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

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

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

116
   | CompErrs 
117
118


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

   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

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

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

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

   case hsc_result of
165
      HscFail -> return CompErrs
166

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

169
      HscRecomp details rdr_env iface
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
	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
		       Just comp_bc -> do tm <- getClockTime 
                                          return ([BCOs comp_bc], tm)
#endif
		       Nothing -> panic "compile: no interpreted code"

		-- we're in batch mode: finish the compilation pipeline.
191
192
193
194
		_other -> do
		   let object_filename = ml_obj_file location

		   runPipeline (StopBefore Ln) ""
195
196
			True Nothing output_fn (Just location)
			-- the object filename comes from the ModLocation
197
198
199

		   o_time <- getModificationTime object_filename
		   return ([DotO object_filename], o_time)
200
201
202
203

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

204
	   return (CompOK details rdr_env iface (Just linkable))
205

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


222
223
-- ---------------------------------------------------------------------------
-- Link
224
225
226
227

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

244
link Batch dflags batch_attempt_linking hpt
245
   | batch_attempt_linking
246
   = do 
247
248
249
250
251
252
253
254
255
256
257
258
259
	let 
	    home_mod_infos = moduleEnvElts hpt

	    -- the packages we depend on
	    pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos

	    -- the linkables to link
	    linkables = map hm_linkable home_mod_infos

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

260
261
262
263
264
265
266
267
268
269
	-- 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 ..."
270

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

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

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

	-- 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
289
      
290
291
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
292

293
294
295
296
297
298
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
299
  -> Maybe ModLocation  -- a ModLocation for this module, if we have one
300
301
  -> IO FilePath	-- output filename

302
runPipeline todo stop_flag keep_output maybe_output_filename input_fn maybe_loc
303
304
305
306
  = do
  split <- readIORef v_Split_object_files
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
307

308
309
310
311
312
313
      stop_phase = case todo of 
			StopBefore As | split -> SplitAs
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
			DoMkDLL               -> Ln
314

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

  -- 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
343
	then do final_fn <- get_output_fn stop_phase maybe_loc
344
345
346
347
348
349
350
351
352
	        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
353
354
  -> (Phase -> Maybe ModLocation -> IO FilePath)
  -> Maybe ModLocation -> IO (FilePath, Maybe ModLocation)
355

356
357
358
359
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
360
361
362
363
364
365
366
367
368

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

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

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

403
	func next_phase maybe_location
404
405
406
407
408
		| 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

409
	   where
410
411
412
413
414
415
416
417
418
419
420
		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

421
		suffix = myPhaseInputExt next_phase
422
423
424
425
426
427

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

428
		persistent = basename ++ '.':suffix
429

430
		odir_persistent
431
		   | Just loc <- maybe_location = ml_obj_file loc
432
433
434
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

435
   return func
436
437


438
439
440
441
442
443
444
445
446
447
448
449
450
451
-- -----------------------------------------------------------------------------
-- 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.
452
453
454
455
456
457
	  -> (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
458
459
460
461

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

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

sof's avatar
sof committed
467
468
469
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
470
471
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
472
			  ])
473

474
       return (Just Cpp, maybe_loc, output_fn)
475
476
477
478

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

479
runPhase Cpp basename suff input_fn get_output_fn maybe_loc
480
  = do src_opts <- getOptionsFromSource input_fn
481
       unhandled_flags <- processArgs dynamic_flags src_opts []
482
       checkProcessArgsResult unhandled_flags basename suff
483

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

493
	    cmdline_include_paths <- readIORef v_Include_paths
494
495

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

499
	    verb <- getVerbFlag
rrt's avatar
rrt committed
500
	    (md_c_flags, _) <- machdepCCOpts
501

502
	    output_fn <- get_output_fn HsPp maybe_loc
503

sof's avatar
sof committed
504
505
506
507
508
	    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
509
510
			    ++ [ SysTools.Option     "-x"
			       , SysTools.Option     "c"
511
512
513
514
515
516
517
518
519
			       , 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
520
			       , SysTools.Option     "-o"
sof's avatar
sof committed
521
			       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
522
			       ])
523

524
	    return (Just HsPp, maybe_loc, output_fn)
525

sof's avatar
sof committed
526
527
528
-------------------------------------------------------------------------------
-- HsPp phase 

529
runPhase HsPp basename suff input_fn get_output_fn maybe_loc
530
  = do do_pp   <- dynFlag ppFlag
sof's avatar
sof committed
531
532
533
       if not do_pp then
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
534
          return (Just Hsc, maybe_loc, input_fn)
sof's avatar
sof committed
535
536
537
	else do
	    hspp_opts	   <- getOpts opt_F
       	    hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
538
	    let orig_fn = basename ++ '.':suff
539
	    output_fn <- get_output_fn Hsc maybe_loc
sof's avatar
sof committed
540
541
542
543
544
545
546
	    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
			   )
547
	    return (Just Hsc, maybe_loc, output_fn)
548

549
550
551
-----------------------------------------------------------------------------
-- Hsc phase

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

   else do
      -- normal Hsc mode, not mkdependHS

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

581
  -- build a ModLocation to pass to hscMain.
582
	(mod, location') <- mkHomeModLocation mod_name (basename ++ '.':suff)
583
584
585
586
587
588

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

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

	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
605
		| otherwise = ml_obj_file location
606

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

619
  -- get the DynFlags
620
        dyn_flags <- getDynFlags
621
622
	hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
	next_phase <- hscNextPhase hsc_lang
623
	output_fn <- get_output_fn next_phase (Just location)
624

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

632
  -- run the compiler!
633
	result <- hscMain hsc_env mod
634
			  location{ ml_hspp_file=Just input_fn }
635
			  source_unchanged
636
			  False
637
			  Nothing	 -- no iface
638

639
	case result of
640

641
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
642

643
            HscNoRecomp details iface -> do
644
		SysTools.touch "Touching object file" o_file
645
		return (Nothing, Just location, output_fn)
646

647
648
	    HscRecomp _details _rdr_env _iface 
		      stub_h_exists stub_c_exists
649
		      _maybe_interpreted_code -> do
650

651
652
653
654
655
656
		-- 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
657
658
                      HscNothing -> return (Nothing, Just location, output_fn)
		      _ -> return (Just next_phase, Just location, output_fn)
659
660
661
662
663
664
665

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

666
runPhase cc_phase basename suff input_fn get_output_fn maybe_loc
667
   | cc_phase == Cc || cc_phase == HCc
668
   = do	cc_opts <- getOpts opt_c
rrt's avatar
rrt committed
669
       	cmdline_include_paths <- readIORef v_Include_paths
670

671
672
673
	split  <- readIORef v_Split_object_files
	mangle <- readIORef v_Do_asm_mangling

674
675
        let hcc = cc_phase == HCc

676
677
678
679
	    next_phase
		| hcc && mangle     = Mangle
		| otherwise         = As

680
	output_fn <- get_output_fn next_phase maybe_loc
681

682
683
684
685
686
687
688
	-- 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
689
690
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
691

692
	mangle <- readIORef v_Do_asm_mangling
693
694
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

695
        verb <- getVerbFlag
696

697
	pkg_extra_cc_opts <- getPackageExtraCcOpts pkgs
698

699
	split_objs <- readIORef v_Split_object_files
sof's avatar
sof committed
700
701
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]
702

703
	excessPrecision <- readIORef v_Excess_precision
704
705
706
707
708
709
710
711
712

	-- 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
713
			, SysTools.Option "-o"
sof's avatar
sof committed
714
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
715
716
717
			]
		       ++ map SysTools.Option (
		          md_c_flags
718
719
720
		       ++ (if cc_phase == HCc && mangle
		  	     then md_regd_c_flags
		  	     else [])
721
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
722
723
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
724
		       ++ split_opt
725
726
727
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
728
		       ))
729

730
	return (Just next_phase, maybe_loc, output_fn)
731
732
733
734
735
736

	-- ToDo: postprocess the output from gcc

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

737
runPhase Mangle _basename _suff input_fn get_output_fn maybe_loc
738
739
740
741
742
743
744
745
746
747
   = 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
748
	output_fn <- get_output_fn next_phase maybe_loc
749

750
	SysTools.runMangle (map SysTools.Option mangler_opts
sof's avatar
sof committed
751
752
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
753
754
			     ]
			  ++ map SysTools.Option machdep_opts)
755

756
	return (Just next_phase, maybe_loc, output_fn)
757
758
759
760

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

761
runPhase SplitMangle _basename _suff input_fn get_output_fn maybe_loc
762
763
764
765
  = 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
766

sof's avatar
sof committed
767
768
769
	SysTools.runSplit [ SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
770
			  ]
771
772
773
774
775
776
777
778
779

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

781
782
	return (Just SplitAs, maybe_loc, "**splitmangle**")
	  -- we don't use the filename
783
784
785
786

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

787
runPhase As _basename _suff input_fn get_output_fn maybe_loc
788
  = do	as_opts		      <- getOpts opt_a
789
        cmdline_include_paths <- readIORef v_Include_paths
790

791
	output_fn <- get_output_fn Ln maybe_loc
792

793
794
795
796
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

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

805
	return (Just Ln, maybe_loc, output_fn)
806
807


808
runPhase SplitAs basename _suff _input_fn get_output_fn maybe_loc
809
  = do  as_opts <- getOpts opt_a
810

811
	(split_s_prefix, n) <- readIORef v_Split_info
812

813
	odir <- readIORef v_Output_dir
814
	let real_odir = case odir of
815
				Nothing -> basename ++ "_split"
816
817
				Just d  -> d

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

833
834
	output_fn <- get_output_fn Ln maybe_loc
	return (Just Ln, maybe_loc, output_fn)
835

rrt's avatar
rrt committed
836
837
838
839
840
#ifdef ILX
-----------------------------------------------------------------------------
-- Ilx2Il phase
-- Run ilx2il over the ILX output, getting an IL file

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

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

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

ross's avatar
ross committed
864
#endif /* ILX */
rrt's avatar
rrt committed
865

866
867
868
869
870
871
-----------------------------------------------------------------------------
-- 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.
872
-- This is called from staticLink below, after linking. I haven't made it
873
874
875
876
-- 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

877
runPhase_MoveBinary input_fn
878
  = do	
879
        sysMan   <- getSysMan
880
881
882
883
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
        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);"
 ]

950
951
952
953
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
sof's avatar
sof committed
954
  = do when (notNull flags) (throwDyn (ProgramError (
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
	  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 []
972

973
-----------------------------------------------------------------------------
974
-- Static linking, of .o files
975

976
977
978
979
980
981
982
983
984
985
986
987
-- 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
988
989
    verb       <- getVerbFlag
    static     <- readIORef v_Static
990
991
    no_hs_main <- readIORef v_NoHsMain

992
993
994
995
    -- 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.

996
    o_file <- readIORef v_Output_file
997
998
    let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }

999
    pkg_lib_paths <- getPackageLibraryPath dep_packages
1000
1001
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

1002
    lib_paths <- readIORef v_Library_paths
1003
1004
    let lib_path_opts = map ("-L"++) lib_paths

1005
    pkg_link_opts <- getPackageLinkOpts dep_packages
1006

1007
#ifdef darwin_TARGET_OS
1008
    pkg_framework_paths <- getPackageFrameworkPath dep_packages
1009
1010
1011
1012
1013
    let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths

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

1014
    pkg_frameworks <- getPackageFrameworks dep_packages
1015
    let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1016
1017

    frameworks <- readIORef v_Cmdline_frameworks
1018
    let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1019
1020
1021
	 -- reverse because they're added in reverse order from the cmd line
#endif

1022
	-- probably _stub.o files
1023
    extra_ld_inputs <- readIORef v_Ld_inputs
1024

1025
	-- opts from -optl-<blah> (including -l<blah> options)
1026
    extra_ld_opts <- getStaticOpts v_Opt_l
1027

1028
    [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1029

1030
1031
    let extra_os = if static || no_hs_main
                   then []
1032
1033
                   else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
                          head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1034

1035
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
1036
1037
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
sof's avatar
sof committed
1038
		       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
1039
1040
1041
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
1042
1043
1044
1045
	 	      ++ o_files
		      ++ extra_os
		      ++ extra_ld_inputs
	 	      ++ lib_path_opts
1046
	 	      ++ extra_ld_opts
1047
1048
1049
1050
#ifdef darwin_TARGET_OS
	 	      ++ framework_path_opts
	 	      ++ framework_opts
#endif
1051
	 	      ++ pkg_lib_path_opts
1052
	 	      ++ pkg_link_opts
1053
1054
1055
1056
#ifdef darwin_TARGET_OS
	 	      ++ pkg_framework_path_opts
	 	      ++ pkg_framework_opts
#endif
1057
		    ))
1058

1059
1060
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
1061
    when (WayPar `elem` ways_)
1062
	 (do success <- runPhase_MoveBinary output_fn
1063
1064
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1065

rrt's avatar
rrt committed
1066
-----------------------------------------------------------------------------
1067
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
1068

sof's avatar
sof committed
1069
1070
doMkDLL :: [String] -> [PackageName] -> IO ()
doMkDLL o_files dep_packages = do
1071
1072
    verb       <- getVerbFlag
    static     <- readIORef v_Static
rrt's avatar
rrt committed
1073
1074
1075
1076
1077
    no_hs_main <- readIORef v_NoHsMain

    o_file <- readIORef v_Output_file
    let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }

sof's avatar
sof committed
1078
    pkg_lib_paths <- getPackageLibraryPath dep_packages
rrt's avatar
rrt committed
1079
1080
1081
1082
1083
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

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

sof's avatar
sof committed
1084
    pkg_link_opts <- getPackageLinkOpts dep_packages