DriverPipeline.hs 43.8 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
14
	-- Interfaces for the batch-mode driver
   genPipeline, runPipeline, pipeLoop, 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 Panic
45
import Util
46
import BasicTypes	( SuccessFlag(..) )
47
import Maybes		( expectJust )
48

49
50
import ParserCoreUtils ( getCoreModuleName )

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

54
#ifdef GHCI
55
import Time 		( getClockTime )
56
#endif
57
58
import Directory
import System
59
60
61
62
import IO
import Monad
import Maybe

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

-----------------------------------------------------------------------------
--			Pre process
-----------------------------------------------------------------------------

-- 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 =
  ASSERT(haskellish_src_file filename) 
  do restoreDynFlags	-- Restore to state of last save
     let fInfo = (filename, getFileSuffix filename)
     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
			     defaultHscLang fInfo
     (fn,_)   <- runPipeline pipeline fInfo
     	                     False{-no linking-} False{-no -o flag-}
     return fn

-----------------------------------------------------------------------------
--			Compile
-----------------------------------------------------------------------------

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

compile :: GhciMode                -- distinguish batch from interactive
	-> Module
	-> ModLocation
	-> Bool			   -- True <=> source unchanged
	-> Bool			   -- True <=> have object
        -> Maybe ModIface          -- old interface, if available
        -> HomePackageTable        -- For home-module stuff
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

data CompResult
   = CompOK   PersistentCompilerState	-- Updated PCS
              ModDetails 		-- New details
              ModIface			-- New iface
              (Maybe Linkable)	-- New code; Nothing => compilation was not reqd
		                --			(old code is still valid)

   | CompErrs PersistentCompilerState	-- Updated PCS


compile ghci_mode this_mod location
	source_unchanged have_object 
	old_iface hpt pcs = do 

   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

   let hsc_lang      = hscLang dyn_flags
       (basename, _) = splitFilename input_fn
       
   keep_hc <- readIORef v_Keep_hc_files
#ifdef ILX
   keep_il <- readIORef v_Keep_il_files
#endif
   keep_s  <- readIORef v_Keep_s_files

   output_fn <- 
	case hsc_lang of
	   HscAsm  | keep_s    -> return (basename ++ '.':phaseInputExt As)
		   | otherwise -> newTempName (phaseInputExt As)
	   HscC    | keep_hc   -> return (basename ++ '.':phaseInputExt HCc)
		   | otherwise -> newTempName (phaseInputExt HCc)
           HscJava             -> newTempName "java" -- ToDo
#ifdef ILX
	   HscILX  | keep_il   -> return (basename ++ '.':phaseInputExt Ilasm)
                   | otherwise -> newTempName (phaseInputExt Ilx2Il) 	
#endif
	   HscInterpreted      -> return (error "no output file")
           HscNothing	       -> return (error "no output file")

   let dyn_flags' = dyn_flags { hscOutName = output_fn,
				hscStubCOutName = basename ++ "_stub.c",
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".hcr" }

   -- figure out which header files to #include in a generated .hc file
   c_includes <- getPackageCIncludes
   cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options

   let cc_injects = unlines (map mk_include 
                                 (c_includes ++ reverse cmdline_includes))
       mk_include h_file = 
	case h_file of 
           '"':_{-"-} -> "#include "++h_file
           '<':_      -> "#include "++h_file
           _          -> "#include \""++h_file++"\""

   writeIORef v_HCHeader cc_injects

   -- -no-recomp should also work with --make
   do_recomp <- readIORef v_Recomp
   let source_unchanged' = source_unchanged && do_recomp
       hsc_env = HscEnv { hsc_mode = ghci_mode,
			  hsc_dflags = dyn_flags',
			  hsc_HPT    = hpt }

   -- run the compiler
   hsc_result <- hscMain hsc_env pcs this_mod location
			 source_unchanged' have_object old_iface

   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)

      HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)

      HscRecomp pcs details iface
	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.
		_other -> do pipe <- genPipeline (StopBefore Ln) "" True 
					hsc_lang (output_fn, getFileSuffix output_fn)
                             -- runPipeline takes input_fn so it can split off 
                             -- the base name and use it as the base of 
                             -- the output object file.
                             let (basename, suffix) = splitFilename input_fn
			     (o_file,_) <- 
			         pipeLoop pipe (output_fn, getFileSuffix output_fn)
			     		       False False 
                                               basename suffix
                             o_time <- getModificationTime o_file
			     return ([DotO o_file], o_time)

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

	   return (CompOK pcs details iface (Just linkable))

240
-----------------------------------------------------------------------------
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
-- 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
	pipeline   <- genPipeline (StopBefore Ln) "" True defaultHscLang (stub_c,"c")
	(stub_o,_) <- runPipeline pipeline (stub_c,"c") False{-no linking-} 
			          False{-no -o option-}
	return (Just stub_o)


-----------------------------------------------------------------------------
--			Link
-----------------------------------------------------------------------------

link :: GhciMode		-- interactive or batch
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
     -> [Linkable]
     -> 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.

-- There will be (ToDo: are) two lists passed to link.  These
-- correspond to
273
--
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
--	1. The list of all linkables in the current home package.  This is
--	   used by the batch linker to link the program, and by the interactive
--	   linker to decide which modules from the previous link it can
--	   throw away.
--	2. The list of modules on which we just called "compile".  This list
--	   is used by the interactive linker to decide which modules need
--	   to be actually linked this time around (or unlinked and re-linked
--	   if the module was recompiled).

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

	res <- link' mode dflags batch_attempt_linking linkables

        when (verb >= 3) (hPutStrLn stderr "link: done")

	return res

#ifdef GHCI
link' Interactive dflags batch_attempt_linking linkables
    = do showPass dflags "Not Linking...(demand linker will do the job)"
	 -- linkModules dflags linkables
	 return Succeeded
#endif

link' Batch dflags batch_attempt_linking linkables
   | batch_attempt_linking
304
305
306
307
308
309
310
311
312
313
314
   = do 
	-- 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 ..."
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

	-- Don't showPass in Batch mode; doLink will do that for us.
        staticLink (concatMap getOfiles linkables)

	-- 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
      getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)



-----------------------------------------------------------------------------
--			genPipeline: Pipeline construction
-----------------------------------------------------------------------------

337
-- Herein is all the magic about which phases to run in which order, whether
rrt's avatar
rrt committed
338
-- the intermediate files should be in TMPDIR or in the current directory,
339
340
341
-- what the suffix of the intermediate files should be, etc.

-- The following compilation pipeline algorithm is fairly hacky.  A
rrt's avatar
rrt committed
342
-- better way to do this would be to express the whole compilation as a
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
-- data flow DAG, where the nodes are the intermediate files and the
-- edges are the compilation phases.  This framework would also work
-- nicely if a haskell dependency generator was included in the
-- driver.

-- It would also deal much more cleanly with compilation phases that
-- generate multiple intermediates, (eg. hsc generates .hc, .hi, and
-- possibly stub files), where some of the output files need to be
-- processed further (eg. the stub files need to be compiled by the C
-- compiler).

-- A cool thing to do would then be to execute the data flow graph
-- concurrently, automatically taking advantage of extra processors on
-- the host machine.  For example, when compiling two Haskell files
-- where one depends on the other, the data flow graph would determine
rrt's avatar
rrt committed
358
359
-- that the C compiler from the first compilation can be overlapped
-- with the hsc compilation for the second file.
360
361
362
363

data IntermediateFileType
  = Temporary
  | Persistent
364
  deriving (Eq, Show)
365
366

genPipeline
sof's avatar
sof committed
367
368
369
370
371
   :: GhcMode		 -- when to stop
   -> String		 -- "stop after" flag (for error messages)
   -> Bool		 -- True => output is persistent
   -> HscLang		 -- preferred output language for hsc
   -> (FilePath, String) -- original filename & its suffix 
372
373
374
375
376
377
   -> IO [ 		-- list of phases to run for this file
	     (Phase,
	      IntermediateFileType,  -- keep the output from this phase?
	      String)   	     -- output file suffix
         ]	

sof's avatar
sof committed
378
genPipeline todo stop_flag persistent_output lang (filename,suffix)
379
 = do
380
381
382
   split      <- readIORef v_Split_object_files
   mangle     <- readIORef v_Do_asm_mangling
   keep_hc    <- readIORef v_Keep_hc_files
sof's avatar
sof committed
383
#ifdef ILX
rrt's avatar
rrt committed
384
   keep_il    <- readIORef v_Keep_il_files
sof's avatar
sof committed
385
386
   keep_ilx   <- readIORef v_Keep_ilx_files
#endif
387
388
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
389
   osuf       <- readIORef v_Object_suf
390
   hcsuf      <- readIORef v_HC_suf
391
392
393

   let
   ----------- -----  ----   ---   --   --  -  -  -
394
395
396
397
398
    start = startPhase suffix

      -- special case for mkdependHS: .hspp files go through MkDependHS
    start_phase | todo == DoMkDependHS && start == Hsc  = MkDependHS
	        | otherwise = start
399
400
401
402

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

403
       -- for a .hc file we need to force lang to HscC
404
405
    real_lang | start_phase == HCc || start_phase == Mangle = HscC
	      | otherwise                                   = lang
406
407
408

   let
   ----------- -----  ----   ---   --   --  -  -  -
409
410
411
412
413
414
415
416
417
418
    pipeline = preprocess ++ compile

    preprocess
	| haskellish = [ Unlit, Cpp, HsPp ]
	| otherwise  = [ ]

    compile
      | todo == DoMkDependHS = [ MkDependHS ]

      | cish = [ Cc, As ]
419
420
421

      | haskellish = 
       case real_lang of
422
423
	HscC    | split && mangle -> [ Hsc, HCc, Mangle, SplitMangle, SplitAs ]
	        | mangle          -> [ Hsc, HCc, Mangle, As ]
424
	        | split	       	  -> not_valid
425
	        | otherwise       -> [ Hsc, HCc, As ]
426

427
428
	HscAsm  | split           -> [ Hsc, SplitMangle, SplitAs ]
	        | otherwise       -> [ Hsc, As ]
429
430
431

	HscJava	| split	          -> not_valid
		| otherwise       -> error "not implemented: compiling via Java"
432
#ifdef ILX
rrt's avatar
rrt committed
433
	HscILX  | split           -> not_valid
434
		| otherwise       -> [ Hsc, Ilx2Il, Ilasm ]
435
#endif
436
	HscNothing		  -> [ Hsc, HCc ] -- HCc is a dummy stop phase
437
438
439
440

      | otherwise = [ ]  -- just pass this file through to the linker

	-- ToDo: this is somewhat cryptic
441
    not_valid = throwDyn (UsageError ("invalid option combination"))
442
443
444

    stop_phase = case todo of 
			StopBefore As | split -> SplitAs
445
#ifdef ILX
rrt's avatar
rrt committed
446
                                      | real_lang == HscILX -> Ilasm
447
#endif
448
449
450
			StopBefore phase      -> phase
			DoMkDependHS	      -> Ln
			DoLink                -> Ln
sof's avatar
sof committed
451
			DoMkDLL               -> Ln
452
453
454
   ----------- -----  ----   ---   --   --  -  -  -

	-- this shouldn't happen.
sof's avatar
sof committed
455
456
457
   when (start_phase /= Ln && start_phase `notElem` pipeline)
	(throwDyn (CmdLineError ("can't find starting phase for "
			         ++ filename)))
458
459
460
461
	-- if we can't find the phase we're supposed to stop before,
	-- something has gone wrong.  This test carefully avoids the
	-- case where we aren't supposed to do any compilation, because the file
	-- is already in linkable form (for example).
sof's avatar
sof committed
462
463
--   hPutStrLn stderr (show ((start_phase `elem` pipeline,stop_phase /= Ln,stop_phase `notElem` pipeline), start_phase, stop_phase, pipeline,todo))
--   hFlush stderr
sof's avatar
sof committed
464
465
   when (start_phase `elem` pipeline && 
   	 (stop_phase /= Ln && stop_phase `notElem` pipeline))
sof's avatar
sof committed
466
467
        (do
	  throwDyn (UsageError 
468
469
470
		    ("flag `" ++ stop_flag
		     ++ "' is incompatible with source file `"
		     ++ filename ++ "'" ++ show pipeline ++ show stop_phase)))
471
   let
472
473
	-- .o and .hc suffixes can be overriden by command-line options:
      myPhaseInputExt HCc | Just s <- hcsuf = s
474
475
      myPhaseInputExt Ln    = osuf
      myPhaseInputExt other = phaseInputExt other
476

477
478
479
480
481
482
483
      annotatePipeline
	 :: [Phase]		-- raw pipeline
	 -> Phase		-- phase to stop before
     	 -> [(Phase, IntermediateFileType, String{-file extension-})]
      annotatePipeline []     _    = []
      annotatePipeline (Ln:_) _    = []
      annotatePipeline (phase:next_phase:ps) stop = 
484
     	  (phase, keep_this_output, myPhaseInputExt next_phase)
485
486
487
	     : annotatePipeline (next_phase:ps) stop
     	  where
     		keep_this_output
488
489
490
491
     		     | next_phase == stop 
                     = if persistent_output then Persistent else Temporary
     		     | otherwise
     		     = case next_phase of
492
493
494
495
     			     Ln -> Persistent
     			     Mangle | keep_raw_s -> Persistent
     			     As     | keep_s     -> Persistent
     			     HCc    | keep_hc    -> Persistent
496
#ifdef ILX
sof's avatar
sof committed
497
			     Ilx2Il | keep_ilx   -> Persistent
rrt's avatar
rrt committed
498
			     Ilasm  | keep_il    -> Persistent
499
#endif
500
501
502
503
504
505
     			     _other              -> Temporary

	-- add information about output files to the pipeline
	-- the suffix on an output file is determined by the next phase
	-- in the pipeline, so we add linking to the end of the pipeline
	-- to force the output from the final phase to be a .o file.
506
507

      annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
508
509
510
511

      phase_ne p (p1,_,_) = (p1 /= p)
   ----------- -----  ----   ---   --   --  -  -  -

512
513
514
515
516
   return (
     takeWhile (phase_ne stop_phase ) $
     dropWhile (phase_ne start_phase) $
     annotated_pipeline
    )
517
518
519
520


runPipeline
  :: [ (Phase, IntermediateFileType, String) ] -- phases to run
sof's avatar
sof committed
521
  -> (String,String)		-- input file
522
523
  -> Bool			-- doing linking afterward?
  -> Bool			-- take into account -o when generating output?
sof's avatar
sof committed
524
  -> IO (String, String)	-- return final filename
525

sof's avatar
sof committed
526
527
528
runPipeline pipeline (input_fn,suffix) do_linking use_ofile
  = pipeLoop pipeline (input_fn,suffix) do_linking use_ofile basename suffix
  where (basename, _) = splitFilename input_fn
529
530

pipeLoop [] input_fn _ _ _ _ = return input_fn
apt's avatar
apt committed
531
pipeLoop (all_phases@((phase, keep, o_suffix):phases))
sof's avatar
sof committed
532
	(input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
533
534
535
536
  = do

     output_fn <- outputFileName (null phases) keep o_suffix

sof's avatar
sof committed
537
538
     mbCarryOn <- run_phase phase orig_basename orig_suffix
     			    input_fn output_fn 
539
540
	-- sometimes we bail out early, eg. when the compiler's recompilation
	-- checker has determined that recompilation isn't necessary.
sof's avatar
sof committed
541
542
     case mbCarryOn of
       Nothing -> do
apt's avatar
apt committed
543
	      let (_,keep,final_suffix) = last all_phases
sof's avatar
sof committed
544
	      ofile <- outputFileName True keep final_suffix
sof's avatar
sof committed
545
	      return (ofile, final_suffix)
sof's avatar
sof committed
546
          -- carry on ...
sof's avatar
sof committed
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
       Just fn -> do
		{-
		  Check to see whether we've reached the end of the
		  pipeline, but did so with an ineffective last stage.
		  (i.e., it returned the input_fn as the output filename).
		  
		  If we did and the output is persistent, copy the contents
		  of input_fn into the file where the pipeline's output is
		  expected to end up.
		-}
	      atEnd <- finalStage (null phases)
	      when (atEnd && fn == input_fn)
	      	   (copy "Saving away compilation pipeline's output"
		   	 input_fn
			 output_fn)
sof's avatar
sof committed
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
              {-
	       Notice that in order to keep the invariant that we can
	       determine a compilation pipeline's 'start phase' just
	       by looking at the input filename, the input filename
	       to the next stage/phase is associated here with the suffix
	       of the output file, *even* if it does not have that
	       suffix in reality.
	       
	       Why is this important? Because we may run a compilation
	       pipeline in stages (cf. Main.main.compileFile's two stages),
	       so when generating the next stage we need to be precise
	       about what kind of file (=> suffix) is given as input.

	       [Not having to generate a pipeline in stages seems like
	        the right way to go, but I've punted on this for now --sof]
	       
	      -}
              pipeLoop phases (fn, o_suffix) do_linking use_ofile
       			orig_basename orig_suffix
581
  where
sof's avatar
sof committed
582
583
584
585
     finalStage lastPhase = do
       o_file <- readIORef v_Output_file
       return (lastPhase && not do_linking && use_ofile && isJust o_file)

586
     outputFileName last_phase keep suffix
587
  	= do o_file <- readIORef v_Output_file
sof's avatar
sof committed
588
589
	     atEnd  <- finalStage last_phase
   	     if atEnd
590
591
592
593
   	       then case o_file of 
   		       Just s  -> return s
   		       Nothing -> error "outputFileName"
   	       else if keep == Persistent
594
   			   then odir_ify (orig_basename ++ '.':suffix)
595
596
   			   else newTempName suffix

sof's avatar
sof committed
597
598
599
600
601
602
603
604
605
run_phase :: Phase
	  -> String                -- basename of original input source
	  -> String		   -- its extension
	  -> FilePath		   -- name of file which contains the input to this phase.
	  -> FilePath              -- where to stick the result.
	  -> IO (Maybe FilePath)
	  	  -- Nothing => stop the compilation pipeline
		  -- Just fn => the result of this phase can be found in 'fn'
		  --            (this can either be 'input_fn' or 'output_fn').
606
607
608
609
-------------------------------------------------------------------------------
-- Unlit phase 

run_phase Unlit _basename _suff input_fn output_fn
610
  = do unlit_flags <- getOpts opt_L
rrt's avatar
rrt committed
611
       -- The -h option passes the file name for unlit to put in a #line directive
sof's avatar
sof committed
612
613
614
       SysTools.runUnlit (map SysTools.Option unlit_flags ++
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
615
616
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
617
			  ])
sof's avatar
sof committed
618
       return (Just output_fn)
619
620
621
622

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

623
run_phase Cpp basename suff input_fn output_fn
624
  = do src_opts <- getOptionsFromSource input_fn
625
       unhandled_flags <- processArgs dynamic_flags src_opts []
626
       checkProcessArgsResult unhandled_flags basename suff
627

628
       do_cpp <- dynFlag cppFlag
sof's avatar
sof committed
629
630
631
632
633
       if not do_cpp then
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
          return (Just input_fn)
	else do
634
	    hscpp_opts	    <- getOpts opt_P
635
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
636

637
	    cmdline_include_paths <- readIORef v_Include_paths
638
	    pkg_include_dirs <- getPackageIncludePath
rrt's avatar
rrt committed
639
640
	    let include_paths = foldr (\ x xs -> "-I" : x : xs) []
				  (cmdline_include_paths ++ pkg_include_dirs)
641

642
	    verb <- getVerbFlag
rrt's avatar
rrt committed
643
	    (md_c_flags, _) <- machdepCCOpts
644

sof's avatar
sof committed
645
646
647
648
649
	    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
650
651
			    ++ [ SysTools.Option     "-x"
			       , SysTools.Option     "c"
652
653
654
655
656
657
658
659
660
			       , 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
661
			       , SysTools.Option     "-o"
sof's avatar
sof committed
662
			       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
663
			       ])
sof's avatar
sof committed
664
	    return (Just output_fn)
665

sof's avatar
sof committed
666
667
668
-------------------------------------------------------------------------------
-- HsPp phase 

669
670
run_phase HsPp basename suff input_fn output_fn
  = do let orig_fn = basename ++ '.':suff
sof's avatar
sof committed
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
       do_pp   <- dynFlag ppFlag
       if not do_pp then
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
          return (Just input_fn)
	else do
	    hspp_opts	   <- getOpts opt_F
       	    hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
	    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
			   )
	    return (Just output_fn)

688
689
690
-----------------------------------------------------------------------------
-- MkDependHS phase

sof's avatar
sof committed
691
692
693
694
695
696
697
698
run_phase MkDependHS basename suff input_fn output_fn 
 = do src <- readFile input_fn
      let (import_sources, import_normals, _) = getImports src
      let orig_fn = basename ++ '.':suff
      deps_sources <- mapM (findDependency True  orig_fn) import_sources
      deps_normals <- mapM (findDependency False orig_fn) import_normals
      let deps = deps_sources ++ deps_normals

699
      osuf <- readIORef v_Object_suf
sof's avatar
sof committed
700
701
702
703
704
705
706

      extra_suffixes <- readIORef v_Dep_suffixes
      let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
          ofiles = map (\suf -> basename ++ '.':suf) suffixes

      objs <- mapM odir_ify ofiles

707
	-- Handle for file that accumulates dependencies 
sof's avatar
sof committed
708
      hdl <- readIORef v_Dep_tmp_hdl
709

710
	-- std dependency of the object(s) on the source file
711
712
      hPutStrLn hdl (unwords (map escapeSpaces objs) ++ " : " ++
		     escapeSpaces (basename ++ '.':suff))
sof's avatar
sof committed
713
714

      let genDep (dep, False {- not an hi file -}) = 
715
716
	     hPutStrLn hdl (unwords (map escapeSpaces objs) ++ " : " ++
			    escapeSpaces dep)
sof's avatar
sof committed
717
718
719
720
721
          genDep (dep, True  {- is an hi file -}) = do
	     hisuf <- readIORef v_Hi_suf
	     let dep_base = remove_suffix '.' dep
	         deps = (dep_base ++ hisuf)
		        : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
722
		  -- length objs should be == length deps
723
	     sequence_ (zipWith (\o d -> hPutStrLn hdl (escapeSpaces o ++ " : " ++ escapeSpaces d)) objs deps)
724

sof's avatar
sof committed
725
726
      sequence_ (map genDep [ d | Just d <- deps ])
      return (Just output_fn)
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745

-- add the lines to dep_makefile:
	   -- always:
		   -- this.o : this.hs

  	   -- if the dependency is on something other than a .hi file:
   		   -- this.o this.p_o ... : dep
   	   -- otherwise
   		   -- if the import is {-# SOURCE #-}
   			   -- this.o this.p_o ... : dep.hi-boot[-$vers]
   			   
   		   -- else
   			   -- this.o ...   : dep.hi
   			   -- this.p_o ... : dep.p_hi
   			   -- ...
   
   	   -- (where .o is $osuf, and the other suffixes come from
   	   -- the cmdline -s options).
   
746

747
748
749
-----------------------------------------------------------------------------
-- Hsc phase

750
751
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
752
run_phase Hsc basename suff input_fn output_fn
753
  = do
754
755
756
757
	
  -- 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.
758
	let current_dir = directoryOf basename
759
	
760
761
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
762
	
763
764
765
766
767
  -- figure out which header files to #include in a generated .hc file
	c_includes <- getPackageCIncludes
	cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options

	let cc_injects = unlines (map mk_include 
768
				 (c_includes ++ reverse cmdline_includes))
769
770
771
772
773
774
775
776
	    mk_include h_file = 
		case h_file of 
		   '"':_{-"-} -> "#include "++h_file
		   '<':_      -> "#include "++h_file
		   _          -> "#include \""++h_file++"\""

	writeIORef v_HCHeader cc_injects

777
  -- gather the imports and module name
778
779
780
781
782
783
784
785
        (srcimps,imps,mod_name) <- 
            if extcoreish_suffix suff
	     then do
               -- no explicit imports in ExtCore input.
	       m <- getCoreModuleName input_fn
	       return ([], [], mkModuleName m)
	     else 
  	       getImportsFromFile input_fn
786

787
  -- build a ModLocation to pass to hscMain.
788
789
	let (path,file) = splitFilenameDir basename
	(mod, location') <- mkHomeModLocation mod_name True path file suff
790
791
792
793
794
795

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

796
797
798
799
  -- 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?)
  --
800
  -- Setting source_unchanged to True means that M.o seems
801
802
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
803
  -- Setting source_unchanged to False tells the compiler that M.o is out of
804
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
sof's avatar
sof committed
805
806
807
	do_recomp   <- readIORef v_Recomp
	todo        <- readIORef v_GhcMode
	expl_o_file <- readIORef v_Output_file
808
809
810
811
812

	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
813
		| otherwise = expectJust "source_unchanged" (ml_obj_file location)
814

815
816
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
817
	     then return False
818
819
820
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
821
		        then return False	-- Need to recompile
822
823
			else do t2 <- getModificationTime o_file
			        if t2 > t1
824
825
				  then return True
				  else return False
826

827
  -- get the DynFlags
828
        dyn_flags <- getDynFlags
829

830
831
        let dyn_flags' = dyn_flags { hscOutName = output_fn,
		   		     hscStubCOutName = basename ++ "_stub.c",
apt's avatar
apt committed
832
				     hscStubHOutName = basename ++ "_stub.h",
apt's avatar
apt committed
833
				     extCoreName = basename ++ ".hcr" }
834
835
836
837
	    hsc_env = HscEnv { hsc_mode = OneShot,
			       hsc_dflags = dyn_flags',
			       hsc_HPT    = emptyHomePackageTable }
			
838

839
  -- run the compiler!
840
        pcs <- initPersistentCompilerState
841
	result <- hscMain hsc_env pcs mod
842
			  location{ ml_hspp_file=Just input_fn }
843
			  source_unchanged
844
			  False
845
			  Nothing	 -- no iface
846
847
848

	case result of {

849
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
850

851
            HscNoRecomp pcs details iface -> do { SysTools.touch "Touching object file" o_file
sof's avatar
sof committed
852
						; return Nothing } ;
853

854
	    HscRecomp pcs details iface stub_h_exists stub_c_exists
855
		      _maybe_interpreted_code -> do
856

apt's avatar
apt committed
857
858
859
860
861
862
863
864
			    -- 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
                              HscNothing -> return Nothing
			      _ -> return (Just output_fn)
865
    }
866
867
868
869
870
871
872

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

873
run_phase cc_phase basename suff input_fn output_fn
874
   | cc_phase == Cc || cc_phase == HCc
875
   = do	cc_opts		     <- getOpts opt_c
rrt's avatar
rrt committed
876
       	cmdline_include_paths <- readIORef v_Include_paths
877
878
879
880
881
882
883

        let hcc = cc_phase == HCc

		-- 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
rrt's avatar
rrt committed
884
885
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
886

887
	mangle <- readIORef v_Do_asm_mangling
888
889
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

890
        verb <- getVerbFlag
891

892
	o2 <- readIORef v_minus_o2_for_C
893
894
895
896
897
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

898
	split_objs <- readIORef v_Split_object_files
sof's avatar
sof committed
899
900
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]
901

902
	excessPrecision <- readIORef v_Excess_precision
903
904
905
906
907
908
909
910
911

	-- 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
912
			, SysTools.Option "-o"
sof's avatar
sof committed
913
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
914
915
916
			]
		       ++ map SysTools.Option (
		          md_c_flags
917
918
919
920
921
922
		       ++ (if cc_phase == HCc && mangle
		  	     then md_regd_c_flags
		  	     else [])
		       ++ [ verb, "-S", "-Wimplicit", opt_flag ]
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
923
		       ++ split_opt
924
925
926
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
927
		       ))
sof's avatar
sof committed
928
	return (Just output_fn)
929
930
931
932
933
934
935

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
936
937
938
939
940
941
  = 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 []

sof's avatar
sof committed
942
       SysTools.runMangle (map SysTools.Option mangler_opts
sof's avatar
sof committed
943
944
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
945
946
			     ]
			  ++ map SysTools.Option machdep_opts)
sof's avatar
sof committed
947
       return (Just output_fn)
948
949
950
951

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

sof's avatar
sof committed
952
run_phase SplitMangle _basename _suff input_fn output_fn
953
954
955
956
  = 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
957

sof's avatar
sof committed
958
959
960
	SysTools.runSplit [ SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
961
			  ]
962
963
964
965
966
967
968
969
970

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

sof's avatar
sof committed
972
	return (Just output_fn)
973
974
975
976
977

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

run_phase As _basename _suff input_fn output_fn
978
  = do	as_opts		      <- getOpts opt_a
979
        cmdline_include_paths <- readIORef v_Include_paths
980

sof's avatar
sof committed
981
982
983
	SysTools.runAs (map SysTools.Option as_opts
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
984
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
985
			  , SysTools.Option "-o"
sof's avatar
sof committed
986
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
987
			  ])
sof's avatar
sof committed
988
	return (Just output_fn)
989

sof's avatar
sof committed
990
run_phase SplitAs basename _suff _input_fn output_fn
991
  = do  as_opts <- getOpts opt_a
992

993
	(split_s_prefix, n) <- readIORef v_Split_info
994

995
	odir <- readIORef v_Output_dir
996
	let real_odir = case odir of
997
				Nothing -> basename ++ "_split"
998
999
				Just d  -> d

1000
1001
	let assemble_file n
	      = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
1002
		    let output_o = replaceFilenameDirectory
1003
					(basename ++ "__" ++ show n ++ ".o")
1004
					 real_odir
1005
		    real_o <- osuf_ify output_o
sof's avatar
sof committed
1006
1007
1008
		    SysTools.runAs (map SysTools.Option as_opts ++
		    		    [ SysTools.Option "-c"
				    , SysTools.Option "-o"
sof's avatar
sof committed
1009
1010
				    , SysTools.FileOption "" real_o
				    , SysTools.FileOption "" input_s
sof's avatar
sof committed
1011
				    ])
1012
1013
	
	mapM_ assemble_file [1..n]
sof's avatar
sof committed
1014
	return (Just output_fn)
1015

rrt's avatar
rrt committed
1016
1017
1018
1019
1020
1021
1022
#ifdef ILX
-----------------------------------------------------------------------------
-- Ilx2Il phase
-- Run ilx2il over the ILX output, getting an IL file

run_phase Ilx2Il _basename _suff input_fn output_fn
  = do	ilx2il_opts <- getOpts opt_I
rrt's avatar
rrt committed
1023
1024
1025
1026
        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
1027
1028
				SysTools.FileOption "" output_fn,
				SysTools.FileOption "" input_fn ])
rrt's avatar
rrt committed
1029
1030
1031
1032
1033
1034
1035
1036
	return (Just output_fn)

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

run_phase Ilasm _basename _suff input_fn output_fn
  = do	ilasm_opts <- getOpts opt_i
rrt's avatar
rrt committed
1037
1038
1039
        SysTools.runIlasm (map SysTools.Option ilasm_opts
		           ++ [ SysTools.Option "/QUIET",
				SysTools.Option "/DLL",
sof's avatar
sof committed
1040
1041
				SysTools.FileOption "/OUT=" output_fn,
				SysTools.FileOption "" input_fn ])
rrt's avatar
rrt committed
1042
1043
1044
1045
	return (Just output_fn)

#endif -- ILX

1046
1047
1048
1049
1050
1051
-----------------------------------------------------------------------------
-- 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.
1052
-- This is called from staticLink below, after linking. I haven't made it
1053
1054
1055
1056
1057
1058
-- 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

run_phase_MoveBinary input_fn
  = do	
1059
        sysMan   <- getSysMan
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
        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);"
 ]

1130
1131
1132
1133
-----------------------------------------------------------------------------
-- Complain about non-dynamic flags in OPTIONS pragmas

checkProcessArgsResult flags basename suff
sof's avatar
sof committed
1134
  = do when (notNull flags) (throwDyn (ProgramError (
1135
1136
1137
1138
           basename ++ "." ++ suff 
           ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
           ++ unwords flags)) (ExitFailure 1))

1139
-----------------------------------------------------------------------------
1140
-- Static linking, of .o files
1141

1142
1143
staticLink :: [String] -> IO ()
staticLink o_files = do
1144
1145
    verb       <- getVerbFlag
    static     <- readIORef v_Static
1146
1147
    no_hs_main <- readIORef v_NoHsMain

1148
    o_file <- readIORef v_Output_file
1149
1150
1151
1152
1153
    let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }

    pkg_lib_paths <- getPackageLibraryPath
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

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

1157
    pkg_link_opts <- getPackageLinkOpts
1158

1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
#ifdef darwin_TARGET_OS
    pkg_framework_paths <- getPackageFrameworkPath
    let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths

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

    pkg_frameworks <- getPackageFrameworks
    let pkg_framework_opts = map ("-framework " ++) pkg_frameworks

    frameworks <- readIORef v_Cmdline_frameworks
    let framework_opts = map ("-framework "++) (reverse frameworks)
	 -- reverse because they're added in reverse order from the cmd line
#endif

1174
	-- probably _stub.o files
1175
    extra_ld_inputs <- readIORef v_Ld_inputs
1176

1177
	-- opts from -optl-<blah> (including -l<blah> options)
1178
    extra_ld_opts <- getStaticOpts v_Opt_l
1179

1180
    [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1181

1182
1183
    let extra_os = if static || no_hs_main
                   then []
1184
1185
                   else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
                          head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1186

1187
    (md_c_flags, _) <- machdepCCOpts
sof's avatar
sof committed
1188
1189
    SysTools.runLink ( [ SysTools.Option verb
    		       , SysTools.Option "-o"
sof's avatar
sof committed
1190
		       , SysTools.FileOption "" output_fn
sof's avatar
sof committed
1191
1192
1193
		       ]
		      ++ map SysTools.Option (
		         md_c_flags
1194
1195
1196
1197
	 	      ++ o_files
		      ++ extra_os
		      ++ extra_ld_inputs
	 	      ++ lib_path_opts
1198
	 	      ++ extra_ld_opts
1199
1200
1201
1202
#ifdef darwin_TARGET_OS
	 	      ++ framework_path_opts
	 	      ++ framework_opts
#endif
1203
	 	      ++ pkg_lib_path_opts
1204
	 	      ++ pkg_link_opts
1205
1206
1207
1208
#ifdef darwin_TARGET_OS
	 	      ++ pkg_framework_path_opts
	 	      ++ pkg_framework_opts
#endif
sof's avatar
sof committed
1209
	              ++ if static && not no_hs_main then
1210
			    [ "-u", prefixUnderscore "Main_zdmain_closure"] 
sof's avatar
sof committed
1211
			 else []))
1212

1213
1214
    -- parallel only: move binary to another dir -- HWL
    ways_ <- readIORef v_Ways
1215
1216
1217
1218
    when (WayPar `elem` ways_)
	 (do success <- run_phase_MoveBinary output_fn
             if success then return ()
                        else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1219

rrt's avatar
rrt committed
1220
-----------------------------------------------------------------------------
1221
-- Making a DLL (only for Win32)
rrt's avatar
rrt committed
1222
1223
1224

doMkDLL :: [String] -> IO ()
doMkDLL o_files = do
1225
1226
    verb       <- getVerbFlag
    static     <- readIORef v_Static
rrt's avatar
rrt committed
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
    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"; }

    pkg_lib_paths <- getPackageLibraryPath
    let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths

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

1238
    pkg_link_opts <- getPackageLinkOpts
rrt's avatar
rrt committed
1239
1240
1241
1242
1243
1244
1245

	-- probably _stub.o files
    extra_ld_inputs <- readIORef v_Ld_inputs

	-- opts from -optdll-<blah>
    extra_ld_opts <- getStaticOpts v_Opt_dll

1246
    [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1247

rrt's avatar
rrt committed
1248
1249
    let extra_os = if static || no_hs_main
                   then []
1250
1251
                   else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
                          head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1252

rrt's avatar
rrt committed
1253
    (md_c_flags, _) <- machdepCCOpts
1254
    SysTools.runMkDLL
sof's avatar
sof committed
1255
1256
	 ([ SysTools.Option verb
	  , SysTools.Option "-o"
sof's avatar
sof committed
1257
	  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
1258
1259
1260
	  ]
	 ++ map SysTools.Option (
	    md_c_flags
rrt's avatar
rrt committed