DriverPipeline.hs 28.7 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- $Id: DriverPipeline.hs,v 1.33 2000/11/20 17:42:00 sewardj Exp $
3
4
5
6
7
8
9
10
--
-- GHC Driver
--
-- (c) Simon Marlow 2000
--
-----------------------------------------------------------------------------

module DriverPipeline (
11
12

	-- interfaces for the batch-mode driver
13
14
   GhcMode(..), getGhcMode, v_GhcMode,
   genPipeline, runPipeline,
15
16

	-- interfaces for the compilation manager (interpreted/batch-mode)
17
   preprocess, compile, CompResult(..),
18
19

	-- batch-mode linking interface
20
   doLink
21
22
23
24
  ) where

#include "HsVersions.h"

25
import CmStaticInfo ( GhciMode(..) )
26
27
import CmTypes
import GetImports
28
29
30
import DriverState
import DriverUtil
import DriverMkDepend
31
import DriverPhases
32
import DriverFlags
33
import HscMain
34
import TmpFiles
35
36
37
38
import HscTypes
import Outputable
import Module
import CmdLineOpts
39
40
41
import Config
import Util

42
import Time 		( getClockTime )
43
44
import Directory
import System
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
import IOExts
import Exception

import IO
import Monad
import Maybe

-----------------------------------------------------------------------------
-- GHC modes of operation

data GhcMode
  = DoMkDependHS			-- ghc -M
  | DoMkDLL				-- ghc -mk-dll
  | StopBefore Phase			-- ghc -E | -C | -S | -c
  | DoMake				-- ghc --make
  | DoInteractive			-- ghc --interactive
  | DoLink				-- [ the default ]
  deriving (Eq)

GLOBAL_VAR(v_GhcMode, error "todo", GhcMode)

modeFlag :: String -> Maybe GhcMode
modeFlag "-M" 		 = Just $ DoMkDependHS
modeFlag "-E" 		 = Just $ StopBefore Hsc
modeFlag "-C" 		 = Just $ StopBefore HCc
modeFlag "-S" 		 = Just $ StopBefore As
modeFlag "-c" 		 = Just $ StopBefore Ln
modeFlag "--make"        = Just $ DoMake
modeFlag "--interactive" = Just $ DoInteractive
modeFlag _               = Nothing

getGhcMode :: [String]
	 -> IO ( [String]   -- rest of command line
	       , GhcMode
	       , String	    -- "GhcMode" flag
	       )
getGhcMode flags 
  = case my_partition modeFlag flags of
	([]   , rest) -> return (rest, DoLink,  "") -- default is to do linking
	([(flag,one)], rest) -> return (rest, one, flag)
	(_    , _   ) -> 
	  throwDyn (OtherError 
		"only one of the flags -M, -E, -C, -S, -c, --make, --interactive is allowed")

-----------------------------------------------------------------------------
-- genPipeline
--
-- Herein is all the magic about which phases to run in which order, whether
-- the intermediate files should be in /tmp or in the current directory,
-- what the suffix of the intermediate files should be, etc.

-- The following compilation pipeline algorithm is fairly hacky.  A
-- better way to do this would be to express the whole comilation as a
-- 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
-- that the C compiler from the first comilation can be overlapped
-- with the hsc comilation for the second file.

data IntermediateFileType
  = Temporary
  | Persistent
119
  deriving (Eq, Show)
120
121
122
123

genPipeline
   :: GhcMode		-- when to stop
   -> String		-- "stop after" flag (for error messages)
124
   -> Bool		-- True => output is persistent
125
   -> HscLang		-- preferred output language for hsc
126
127
128
129
130
131
132
   -> String		-- original filename
   -> IO [ 		-- list of phases to run for this file
	     (Phase,
	      IntermediateFileType,  -- keep the output from this phase?
	      String)   	     -- output file suffix
         ]	

133
genPipeline todo stop_flag persistent_output lang filename 
134
 = do
135
136
137
138
139
   split      <- readIORef v_Split_object_files
   mangle     <- readIORef v_Do_asm_mangling
   keep_hc    <- readIORef v_Keep_hc_files
   keep_raw_s <- readIORef v_Keep_raw_s_files
   keep_s     <- readIORef v_Keep_s_files
140
   osuf       <- readIORef v_Object_suf
141
142
143
144
145
146
147
148
149
150

   let
   ----------- -----  ----   ---   --   --  -  -  -
    (_basename, suffix) = splitFilename filename

    start_phase = startPhase suffix

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

151
152
153
   -- for a .hc file we need to force lang to HscC
    real_lang | start_phase == HCc  = HscC
	      | otherwise           = lang
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

   let
   ----------- -----  ----   ---   --   --  -  -  -
    pipeline
      | todo == DoMkDependHS = [ Unlit, Cpp, MkDependHS ]

      | haskellish = 
       case real_lang of
	HscC    | split && mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle, 
					SplitMangle, SplitAs ]
	        | mangle          -> [ Unlit, Cpp, Hsc, HCc, Mangle, As ]
	        | split	       	  -> not_valid
	        | otherwise       -> [ Unlit, Cpp, Hsc, HCc, As ]

	HscAsm  | split           -> [ Unlit, Cpp, Hsc, SplitMangle, SplitAs ]
	        | otherwise       -> [ Unlit, Cpp, Hsc, As ]

	HscJava	| split	          -> not_valid
		| otherwise       -> error "not implemented: compiling via Java"

      | cish      = [ Cc, As ]

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

	-- ToDo: this is somewhat cryptic
    not_valid = throwDyn (OtherError ("invalid option combination"))
   ----------- -----  ----   ---   --   --  -  -  -

	-- this shouldn't happen.
   if start_phase /= Ln && start_phase `notElem` pipeline
	then throwDyn (OtherError ("can't find starting phase for "
				    ++ filename))
	else do

	-- if we can't find the phase we're supposed to stop before,
	-- something has gone wrong.
   case todo of
	StopBefore phase -> 
	   when (phase /= Ln 
		 && phase `notElem` pipeline
	   	 && not (phase == As && SplitAs `elem` pipeline)) $
	      throwDyn (OtherError 
		("flag " ++ stop_flag
		 ++ " is incompatible with source file `" ++ filename ++ "'"))
	_ -> return ()

   let
   ----------- -----  ----   ---   --   --  -  -  -
202
203
204
205
      myPhaseInputExt Ln = case osuf of Nothing -> phaseInputExt Ln
					Just s  -> s
      myPhaseInputExt other = phaseInputExt other

206
207
208
209
210
211
212
      annotatePipeline
	 :: [Phase]		-- raw pipeline
	 -> Phase		-- phase to stop before
     	 -> [(Phase, IntermediateFileType, String{-file extension-})]
      annotatePipeline []     _    = []
      annotatePipeline (Ln:_) _    = []
      annotatePipeline (phase:next_phase:ps) stop = 
213
     	  (phase, keep_this_output, myPhaseInputExt next_phase)
214
215
216
	     : annotatePipeline (next_phase:ps) stop
     	  where
     		keep_this_output
217
218
219
220
     		     | next_phase == stop 
                     = if persistent_output then Persistent else Temporary
     		     | otherwise
     		     = case next_phase of
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
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
273
274
275
     			     Ln -> Persistent
     			     Mangle | keep_raw_s -> Persistent
     			     As     | keep_s     -> Persistent
     			     HCc    | keep_hc    -> Persistent
     			     _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.
      stop_phase = case todo of StopBefore phase -> phase
				DoMkDependHS	 -> Ln
				DoLink           -> Ln
      annotated_pipeline = annotatePipeline (pipeline ++ [ Ln ]) stop_phase

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

   return $
     dropWhile (phase_ne start_phase) . 
	foldr (\p ps -> if phase_ne stop_phase p then p:ps else [])  []
		$ annotated_pipeline


runPipeline
  :: [ (Phase, IntermediateFileType, String) ] -- phases to run
  -> String			-- input file
  -> Bool			-- doing linking afterward?
  -> Bool			-- take into account -o when generating output?
  -> IO String			-- return final filename

runPipeline pipeline input_fn do_linking use_ofile
  = pipeLoop pipeline input_fn do_linking use_ofile basename suffix
  where (basename, suffix) = splitFilename input_fn

pipeLoop [] input_fn _ _ _ _ = return input_fn
pipeLoop ((phase, keep, o_suffix):phases) 
	input_fn do_linking use_ofile orig_basename orig_suffix
  = do

     output_fn <- outputFileName (null phases) keep o_suffix

     carry_on <- run_phase phase orig_basename orig_suffix input_fn output_fn
	-- sometimes we bail out early, eg. when the compiler's recompilation
	-- checker has determined that recompilation isn't necessary.
     if not carry_on 
	then do let (_,keep,final_suffix) = last phases
	        ofile <- outputFileName True keep final_suffix
		return ofile
	else do -- carry on ...

     pipeLoop phases output_fn do_linking use_ofile orig_basename orig_suffix

  where
     outputFileName last_phase keep suffix
276
  	= do o_file <- readIORef v_Output_file
277
278
279
280
281
   	     if last_phase && not do_linking && use_ofile && isJust o_file
   	       then case o_file of 
   		       Just s  -> return s
   		       Nothing -> error "outputFileName"
   	       else if keep == Persistent
282
   			   then odir_ify (orig_basename ++ '.':suffix)
283
284
285
286
287
288
   			   else newTempName suffix

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

run_phase Unlit _basename _suff input_fn output_fn
289
  = do unlit <- readIORef v_Pgm_L
290
291
292
293
294
295
296
297
298
       unlit_flags <- getOpts opt_L
       run_something "Literate pre-processor"
	  ("echo '# 1 \"" ++input_fn++"\"' > "++output_fn++" && "
	   ++ unlit ++ ' ':input_fn ++ " - >> " ++ output_fn)
       return True

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

299
run_phase Cpp basename suff input_fn output_fn
300
  = do src_opts <- getOptionsFromSource input_fn
301
302
303
304
305
306
307
       unhandled_flags <- processArgs dynamic_flags src_opts []

       when (not (null unhandled_flags)) 
            (throwDyn (OtherError (
                          basename ++ "." ++ suff 
                          ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t" 
                          ++ unwords unhandled_flags)) (ExitFailure 1))
308
309
310
311

       do_cpp <- readState cpp_flag
       if do_cpp
          then do
312
       	    cpp <- readIORef v_Pgm_P
313
	    hscpp_opts <- getOpts opt_P
314
       	    hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
315

316
	    cmdline_include_paths <- readIORef v_Include_paths
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
	    pkg_include_dirs <- getPackageIncludePath
	    let include_paths = map (\p -> "-I"++p) (cmdline_include_paths
							++ pkg_include_dirs)

	    verb <- is_verbose
	    run_something "C pre-processor" 
		(unwords
       	    	   (["echo '{-# LINE 1 \"" ++ input_fn ++ "\" -}'", ">", output_fn, "&&",
		     cpp, verb] 
		    ++ include_paths
		    ++ hs_src_cpp_opts
		    ++ hscpp_opts
		    ++ [ "-x", "c", input_fn, ">>", output_fn ]
		   ))
	  else do
	    run_something "Ineffective C pre-processor"
	           ("echo '{-# LINE 1 \""  ++ input_fn ++ "\" -}' > " 
		    ++ output_fn ++ " && cat " ++ input_fn
		    ++ " >> " ++ output_fn)
       return True

-----------------------------------------------------------------------------
-- MkDependHS phase

run_phase MkDependHS basename suff input_fn _output_fn = do 
   src <- readFile input_fn
343
   let (import_sources, import_normals, module_name) = getImports src
344

345
346
347
   deps_sources <- mapM (findDependency True basename)  import_sources
   deps_normals <- mapM (findDependency False basename) import_normals
   let deps = deps_sources ++ deps_normals
348

349
   osuf_opt <- readIORef v_Object_suf
350
   let osuf = case osuf_opt of
351
			Nothing -> phaseInputExt Ln
352
353
			Just s  -> s

354
   extra_suffixes <- readIORef v_Dep_suffixes
355
356
357
358
359
   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
       ofiles = map (\suf -> basename ++ '.':suf) suffixes
   	   
   objs <- mapM odir_ify ofiles
   
360
   hdl <- readIORef v_Dep_tmp_hdl
361

362
	-- std dependency of the object(s) on the source file
363
364
365
366
367
   hPutStrLn hdl (unwords objs ++ " : " ++ basename ++ '.':suff)

   let genDep (dep, False {- not an hi file -}) = 
	  hPutStrLn hdl (unwords objs ++ " : " ++ dep)
       genDep (dep, True  {- is an hi file -}) = do
368
	  hisuf <- readIORef v_Hi_suf
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
	  let dep_base = remove_suffix '.' dep
	      deps = (dep_base ++ hisuf)
		     : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
		  -- length objs should be == length deps
	  sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)

   mapM genDep [ d | Just d <- deps ]

   return True

-- 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).
   
-----------------------------------------------------------------------------
-- Hsc phase

400
401
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
402
run_phase Hsc basename suff input_fn output_fn
403
  = do
404
405
406
407
408
409
	
  -- 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.
	let current_dir = getdir basename
	
410
411
	paths <- readIORef v_Include_paths
	writeIORef v_Include_paths (current_dir : paths)
412
413
	
  -- figure out where to put the .hi file
414
415
	ohi    <- readIORef v_Output_hi
	hisuf  <- readIORef v_Hi_suf
416
	let hifile = case ohi of
417
			   Nothing -> basename ++ '.':hisuf
418
			   Just fn -> fn
419
420
421
422
423

  -- 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?)
  --
424
  -- Setting source_unchanged to True means that M.o seems
425
426
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
427
  -- Setting source_unchanged to False tells the compiler that M.o is out of
428
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
429
	do_recomp <- readIORef v_Recomp
430
	todo <- readIORef v_GhcMode
431
        o_file <- odir_ify (basename ++ '.':phaseInputExt Ln)
432
433
	source_unchanged <- 
          if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
434
	     then return False
435
436
437
	     else do t1 <- getModificationTime (basename ++ '.':suff)
		     o_file_exists <- doesFileExist o_file
		     if not o_file_exists
438
		        then return False	-- Need to recompile
439
440
			else do t2 <- getModificationTime o_file
			        if t2 > t1
441
442
				  then return True
				  else return False
443

444
   -- build a ModuleLocation to pass to hscMain.
445
        let location = ModuleLocation {
446
447
448
449
                          ml_hs_file   = Nothing,
                          ml_hspp_file = Just input_fn,
                          ml_hi_file   = Just hifile,
                          ml_obj_file  = Just o_file
450
                       }
451

452
453
454
  -- get the DynFlags
        dyn_flags <- readIORef v_DynFlags

455
  -- run the compiler!
456
        pcs <- initPersistentCompilerState
457
458
	result <- hscMain OneShot
                          dyn_flags{ hscOutName = output_fn }
459
			  source_unchanged
460
			  location
461
462
463
464
			  Nothing	 -- no iface
			  emptyModuleEnv -- HomeSymbolTable
			  emptyModuleEnv -- HomeIfaceTable
			  pcs
465
466
467

	case result of {

468
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
469

470
471
472
473
            HscNoRecomp pcs details iface -> return False;

	    HscRecomp pcs details iface maybe_stub_h maybe_stub_c 
		      _maybe_interpreted_code -> do
474

475
	    -- deal with stubs
476
	maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
477
	case maybe_stub_o of
478
		Nothing -> return ()
479
		Just stub_o -> add v_Ld_inputs stub_o
480

481
	return True
482
    }
483
484
485
486
487
488
489
490
491

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

run_phase cc_phase _basename _suff input_fn output_fn
   | cc_phase == Cc || cc_phase == HCc
492
   = do	cc <- readIORef v_Pgm_c
493
       	cc_opts <- (getOpts opt_c)
494
       	cmdline_include_dirs <- readIORef v_Include_paths
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524

        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
	let include_paths = map (\p -> "-I"++p) (cmdline_include_dirs 
							++ pkg_include_dirs)

	c_includes <- getPackageCIncludes
	cmdline_includes <- readState cmdline_hc_includes -- -#include options

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

	cc_help <- newTempName "c"
	h <- openFile cc_help WriteMode
	hPutStr h cc_injects
	hPutStrLn h ("#include \"" ++ input_fn ++ "\"\n")
	hClose h

	ccout <- newTempName "ccout"

525
	mangle <- readIORef v_Do_asm_mangling
526
527
528
529
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

        verb <- is_verbose

530
	o2 <- readIORef v_minus_o2_for_C
531
532
533
534
535
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

536
537
538
539
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

540
	excessPrecision <- readIORef v_Excess_precision
541
542
543
544
545
546
547
548
549
550

	run_something "C Compiler"
	 (unwords ([ cc, "-x", "c", cc_help, "-o", output_fn ]
		   ++ md_c_flags
		   ++ (if cc_phase == HCc && mangle
			 then md_regd_c_flags
			 else [])
		   ++ [ verb, "-S", "-Wimplicit", opt_flag ]
		   ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		   ++ cc_opts
551
		   ++ split_opt
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
#ifdef mingw32_TARGET_OS
                   ++ [" -mno-cygwin"]
#endif
		   ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		   ++ include_paths
		   ++ pkg_extra_cc_opts
--		   ++ [">", ccout]
		   ))
	return True

	-- ToDo: postprocess the output from gcc

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

run_phase Mangle _basename _suff input_fn output_fn
568
  = do mangler <- readIORef v_Pgm_m
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
       mangler_opts <- getOpts opt_m
       machdep_opts <-
	 if (prefixMatch "i386" cTARGETPLATFORM)
	    then do n_regs <- readState stolen_x86_regs
		    return [ show n_regs ]
	    else return []
       run_something "Assembly Mangler"
	(unwords (mangler : 
		     mangler_opts
		  ++ [ input_fn, output_fn ]
		  ++ machdep_opts
		))
       return True

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

run_phase SplitMangle _basename _suff input_fn _output_fn
587
  = do  splitter <- readIORef v_Pgm_s
588
589
590

	-- this is the prefix used for the split .s files
	tmp_pfx <- readIORef v_TmpDir
591
	x <- myGetProcessID
592
	let split_s_prefix = tmp_pfx ++ "/ghc" ++ show x
593
	writeIORef v_Split_prefix split_s_prefix
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
	addFilesToClean [split_s_prefix ++ "__*"] -- d:-)

	-- allocate a tmp file to put the no. of split .s files in (sigh)
	n_files <- newTempName "n_files"

	run_something "Split Assembly File"
	 (unwords [ splitter
		  , input_fn
		  , split_s_prefix
		  , n_files ]
	 )

	-- save the number of split files for future references
	s <- readFile n_files
	let n = read s :: Int
609
	writeIORef v_N_split_files n
610
611
612
613
614
615
	return True

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

run_phase As _basename _suff input_fn output_fn
616
  = do	as <- readIORef v_Pgm_a
617
618
        as_opts <- getOpts opt_a

619
        cmdline_include_paths <- readIORef v_Include_paths
620
621
622
623
624
625
626
627
628
        let cmdline_include_flags = map (\p -> "-I"++p) cmdline_include_paths
        run_something "Assembler"
	   (unwords (as : as_opts
		       ++ cmdline_include_flags
		       ++ [ "-c", input_fn, "-o",  output_fn ]
		    ))
	return True

run_phase SplitAs basename _suff _input_fn _output_fn
629
  = do  as <- readIORef v_Pgm_a
630
631
        as_opts <- getOpts opt_a

632
633
	split_s_prefix <- readIORef v_Split_prefix
	n <- readIORef v_N_split_files
634

635
	odir <- readIORef v_Output_dir
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
	let real_odir = case odir of
				Nothing -> basename
				Just d  -> d

	let assemble_file n = do
		    let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
		    let output_o = newdir real_odir 
					(basename ++ "__" ++ show n ++ ".o")
		    real_o <- osuf_ify output_o
		    run_something "Assembler" 
			    (unwords (as : as_opts
				      ++ [ "-c", "-o", real_o, input_s ]
			    ))
	
	mapM_ assemble_file [1..n]
	return True

-----------------------------------------------------------------------------
-- Linking

doLink :: [String] -> IO ()
doLink o_files = do
658
    ln <- readIORef v_Pgm_l
659
    verb <- is_verbose
660
661
662
663
    static <- readIORef v_Static
    let imp = if static then "" else "_imp"
    no_hs_main <- readIORef v_NoHsMain

664
    o_file <- readIORef v_Output_file
665
666
667
668
669
    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

670
    lib_paths <- readIORef v_Library_paths
671
672
673
    let lib_path_opts = map ("-L"++) lib_paths

    pkg_libs <- getPackageLibraries
674
    let pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
675

676
    libs <- readIORef v_Cmdline_libraries
677
678
679
680
681
682
    let lib_opts = map ("-l"++) (reverse libs)
	 -- reverse because they're added in reverse order from the cmd line

    pkg_extra_ld_opts <- getPackageExtraLdOpts

	-- probably _stub.o files
683
    extra_ld_inputs <- readIORef v_Ld_inputs
684
685

	-- opts from -optl-<blah>
686
    extra_ld_opts <- getStaticOpts v_Opt_l
687

688
689
690
691
692
    rts_pkg <- getPackageDetails ["rts"]
    std_pkg <- getPackageDetails ["std"]
#ifdef mingw32_TARGET_OS
    let extra_os = if static || no_hs_main
                   then []
693
694
695
--                   else [ head (lib_paths (head rts_pkg)) ++ "/Main.dll_o",
--                          head (lib_paths (head std_pkg)) ++ "/PrelMain.dll_o" ]
		     else []
696
697
#endif
    (md_c_flags, _) <- machdepCCOpts
698
    run_something "Linker"
699
       (unwords
700
	 ([ ln, verb, "-o", output_fn ]
701
	 ++ md_c_flags
702
	 ++ o_files
703
704
705
#ifdef mingw32_TARGET_OS
	 ++ extra_os
#endif
706
707
708
709
710
711
712
	 ++ extra_ld_inputs
	 ++ lib_path_opts
	 ++ lib_opts
	 ++ pkg_lib_path_opts
	 ++ pkg_lib_opts
	 ++ pkg_extra_ld_opts
	 ++ extra_ld_opts
713
714
715
716
717
#ifdef mingw32_TARGET_OS
         ++ if static then [ "-u _PrelMain_mainIO_closure" , "-u ___init_PrelMain"] else []
#else
	 ++ [ "-u PrelMain_mainIO_closure" , "-u __init_PrelMain"]
#endif
718
719
720
721
722
723
724
725
726
727
	)
       )

-----------------------------------------------------------------------------
-- 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_file filename) 
728
729
730
731
  do init_driver_state <- readIORef v_InitDriverState
     writeIORef v_Driver_state init_driver_state

     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
732
			defaultHscLang filename
733
     runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
734

735

736
-----------------------------------------------------------------------------
737
-- Compile a single module, under the control of the compilation manager.
738
739
740
741
742
743
--
-- 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.

744
745
746
747
748
749
-- 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.

750
751
752
753
754
-- NB.  No old interface can also mean that the source has changed.

compile :: GhciMode                -- distinguish batch from interactive
        -> ModSummary              -- summary, including source
	-> Bool			   -- source unchanged?
755
        -> Maybe ModIface          -- old interface, if available
756
757
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
758
759
760
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

761
data CompResult
762
763
764
765
766
767
   = CompOK   PersistentCompilerState	-- updated PCS
              ModDetails  -- new details (HST additions)
              ModIface    -- new iface   (HIT additions)
              (Maybe Linkable)
                       -- new code; Nothing => compilation was not reqd
                       -- (old code is still valid)
768
769
770
771

   | CompErrs PersistentCompilerState	-- updated PCS


772
compile ghci_mode summary source_unchanged old_iface hst hit pcs = do 
773
774
775
776
   verb <- readIORef v_Verbose
   when verb (hPutStrLn stderr 
                 (showSDoc (text "compile: compiling" 
                            <+> ppr (name_of_summary summary))))
777
778
779

   init_dyn_flags <- readIORef v_InitDynFlags
   writeIORef v_DynFlags init_dyn_flags
780
781
   init_driver_state <- readIORef v_InitDriverState
   writeIORef v_Driver_state init_driver_state
782

783
   let location   = ms_location summary   
784
785
   let input_fn   = unJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
786

787
   when verb (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
788

789
   opts <- getOptionsFromSource input_fnpp
790
791
792
   processArgs dynamic_flags opts []
   dyn_flags <- readIORef v_DynFlags

793
   let hsc_lang = hscLang dyn_flags
794
795
796
797
   output_fn <- case hsc_lang of
		    HscAsm         -> newTempName (phaseInputExt As)
		    HscC           -> newTempName (phaseInputExt HCc)
        	    HscJava        -> newTempName "java" -- ToDo
798
		    HscInterpreted -> return (error "no output file")
799
800

   -- run the compiler
801
802
   hsc_result <- hscMain ghci_mode dyn_flags{ hscOutName = output_fn } 
			 source_unchanged
803
                         location old_iface hst hit pcs
804

805
806
   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)
807

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

810
811
812
      HscRecomp pcs details iface
	maybe_stub_h maybe_stub_c maybe_interpreted_code -> do
	   
813
	   let (basename, _) = splitFilename input_fn
814
	   maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
815
816
817
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]
818

819
	   (hs_unlinked, unlinked_time) <-
820
821
822
823
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
824
		HscInterpreted -> 
825
		    case maybe_interpreted_code of
826
827
828
		       Just (code,itbl_env) -> do tm <- getClockTime 
                                                  return ([Trees code itbl_env], tm)
		       Nothing -> panic "compile: no interpreted code"
829
830

		-- we're in batch mode: finish the compilation pipeline.
831
832
		_other -> do pipe <- genPipeline (StopBefore Ln) "" True 
					hsc_lang output_fn
833
834
835
836
                             -- 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
837
838
839
840
			     o_file <- pipeLoop pipe output_fn False False 
                                                basename suffix
                             o_time <- getModificationTime o_file
			     return ([DotO o_file], o_time)
841

842
843
	   let linkable = LM unlinked_time (moduleName (ms_mod summary)) 
			     (hs_unlinked ++ stub_unlinked)
844

845
846
	   return (CompOK pcs details iface (Just linkable))

847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877

-----------------------------------------------------------------------------
-- stub .h and .c files (for foreign export support)

dealWithStubs basename maybe_stub_h maybe_stub_c

 = do	let stub_h = basename ++ "_stub.h"
	let stub_c = basename ++ "_stub.c"

  -- copy the .stub_h file into the current dir if necessary
	case maybe_stub_h of
	   Nothing -> return ()
	   Just tmp_stub_h -> do
	      	run_something "Copy stub .h file"
				("cp " ++ tmp_stub_h ++ ' ':stub_h)
	
			-- #include <..._stub.h> in .hc file
		addCmdlineHCInclude tmp_stub_h	-- hack

  -- copy the .stub_c file into the current dir, and compile it, if necessary
	case maybe_stub_c of
	   Nothing -> return Nothing
	   Just tmp_stub_c -> do  -- copy the _stub.c file into the current dir
		run_something "Copy stub .c file" 
		    (unwords [ 
			"rm -f", stub_c, "&&",
			"echo \'#include \""++stub_h++"\"\' >"++stub_c, " &&",
			"cat", tmp_stub_c, ">> ", stub_c
			])

			-- compile the _stub.c file w/ gcc
878
879
		pipeline <- genPipeline (StopBefore Ln) "" True 
				defaultHscLang stub_c
880
881
882
883
		stub_o <- runPipeline pipeline stub_c False{-no linking-} 
				False{-no -o option-}

		return (Just stub_o)