DriverPipeline.hs 28.7 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- $Id: DriverPipeline.hs,v 1.40 2000/12/07 16:39:40 simonmar 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
import HscTypes
import Outputable
import Module
38
import ErrUtils
39
import CmdLineOpts
40
41
42
import Config
import Util

43
import Time 		( getClockTime )
44
45
import Directory
import System
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
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
rrt's avatar
rrt committed
98
-- better way to do this would be to express the whole compilation as a
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
-- 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
114
115
-- that the C compiler from the first compilation can be overlapped
-- with the hsc compilation for the second file.
116
117
118
119

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

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

134
genPipeline todo stop_flag persistent_output lang filename 
135
 = do
136
137
138
139
140
   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
141
   osuf       <- readIORef v_Object_suf
142
143
144
145
146
147
148
149
150
151

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

    start_phase = startPhase suffix

    haskellish = haskellish_suffix suffix
    cish = cish_suffix suffix

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

   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
   ----------- -----  ----   ---   --   --  -  -  -
203
204
205
206
      myPhaseInputExt Ln = case osuf of Nothing -> phaseInputExt Ln
					Just s  -> s
      myPhaseInputExt other = phaseInputExt other

207
208
209
210
211
212
213
      annotatePipeline
	 :: [Phase]		-- raw pipeline
	 -> Phase		-- phase to stop before
     	 -> [(Phase, IntermediateFileType, String{-file extension-})]
      annotatePipeline []     _    = []
      annotatePipeline (Ln:_) _    = []
      annotatePipeline (phase:next_phase:ps) stop = 
214
     	  (phase, keep_this_output, myPhaseInputExt next_phase)
215
216
217
	     : annotatePipeline (next_phase:ps) stop
     	  where
     		keep_this_output
218
219
220
221
     		     | next_phase == stop 
                     = if persistent_output then Persistent else Temporary
     		     | otherwise
     		     = case next_phase of
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
276
     			     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
277
  	= do o_file <- readIORef v_Output_file
278
279
280
281
282
   	     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
283
   			   then odir_ify (orig_basename ++ '.':suffix)
284
285
286
287
288
289
   			   else newTempName suffix

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

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

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

300
run_phase Cpp basename suff input_fn output_fn
301
  = do src_opts <- getOptionsFromSource input_fn
302
303
304
305
306
307
308
       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))
309
310
311
312

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

317
	    cmdline_include_paths <- readIORef v_Include_paths
318
319
320
321
	    pkg_include_dirs <- getPackageIncludePath
	    let include_paths = map (\p -> "-I"++p) (cmdline_include_paths
							++ pkg_include_dirs)

322
323
324
	    verb <- getVerbFlag

	    runSomething "C pre-processor" 
325
326
327
328
329
330
331
332
333
		(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
334
	    runSomething "Ineffective C pre-processor"
335
336
337
338
339
340
341
342
343
344
	           ("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
345
   let (import_sources, import_normals, module_name) = getImports src
346

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

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

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

364
	-- std dependency of the object(s) on the source file
365
366
367
368
369
   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
370
	  hisuf <- readIORef v_Hi_suf
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
400
401
	  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

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

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

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

455
456
457
  -- get the DynFlags
        dyn_flags <- readIORef v_DynFlags

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

	case result of {

471
	    HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
472

473
474
475
476
477
            HscNoRecomp pcs details iface -> 
	        do {
		  runSomething "Touching object file" ("touch " ++ o_file);
		  return False;
		};
478
479
480

	    HscRecomp pcs details iface maybe_stub_h maybe_stub_c 
		      _maybe_interpreted_code -> do
481

482
	    -- deal with stubs
483
	maybe_stub_o <- dealWithStubs basename maybe_stub_h maybe_stub_c
484
	case maybe_stub_o of
485
		Nothing -> return ()
486
		Just stub_o -> add v_Ld_inputs stub_o
487

488
	return True
489
    }
490
491
492
493
494
495
496
497
498

-----------------------------------------------------------------------------
-- 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
499
   = do	cc <- readIORef v_Pgm_c
500
       	cc_opts <- (getOpts opt_c)
501
       	cmdline_include_dirs <- readIORef v_Include_paths
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531

        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"

532
	mangle <- readIORef v_Do_asm_mangling
533
534
	(md_c_flags, md_regd_c_flags) <- machdepCCOpts

535
        verb <- getVerbFlag
536

537
	o2 <- readIORef v_minus_o2_for_C
538
539
540
541
542
	let opt_flag | o2        = "-O2"
		     | otherwise = "-O"

	pkg_extra_cc_opts <- getPackageExtraCcOpts

543
544
545
546
	split_objs <- readIORef v_Split_object_files
	let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
		      | otherwise         = [ ]

547
	excessPrecision <- readIORef v_Excess_precision
548

549
	runSomething "C Compiler"
550
551
552
553
554
555
556
557
	 (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
558
		   ++ split_opt
559
560
561
562
563
564
565
566
567
568
569
570
571
		   ++ (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
572
  = do mangler <- readIORef v_Pgm_m
573
574
575
576
577
578
       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 []
579
       runSomething "Assembly Mangler"
580
581
582
583
584
585
586
587
588
589
590
	(unwords (mangler : 
		     mangler_opts
		  ++ [ input_fn, output_fn ]
		  ++ machdep_opts
		))
       return True

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

run_phase SplitMangle _basename _suff input_fn _output_fn
591
  = do  splitter <- readIORef v_Pgm_s
592
593
594

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

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

603
	runSomething "Split Assembly File"
604
605
606
607
608
609
610
611
612
	 (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
613
	writeIORef v_N_split_files n
614
615
616
617
618
619
	return True

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

run_phase As _basename _suff input_fn output_fn
620
  = do	as <- readIORef v_Pgm_a
621
622
        as_opts <- getOpts opt_a

623
        cmdline_include_paths <- readIORef v_Include_paths
624
        let cmdline_include_flags = map (\p -> "-I"++p) cmdline_include_paths
625
        runSomething "Assembler"
626
627
628
629
630
631
632
	   (unwords (as : as_opts
		       ++ cmdline_include_flags
		       ++ [ "-c", input_fn, "-o",  output_fn ]
		    ))
	return True

run_phase SplitAs basename _suff _input_fn _output_fn
633
  = do  as <- readIORef v_Pgm_a
634
635
        as_opts <- getOpts opt_a

636
637
	split_s_prefix <- readIORef v_Split_prefix
	n <- readIORef v_N_split_files
638

639
	odir <- readIORef v_Output_dir
640
641
642
643
644
645
646
647
648
	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
649
		    runSomething "Assembler" 
650
651
652
653
654
655
656
657
658
659
660
661
			    (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
662
    ln <- readIORef v_Pgm_l
663
    verb <- getVerbFlag
664
665
666
667
    static <- readIORef v_Static
    let imp = if static then "" else "_imp"
    no_hs_main <- readIORef v_NoHsMain

668
    o_file <- readIORef v_Output_file
669
670
671
672
673
    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

674
    lib_paths <- readIORef v_Library_paths
675
676
677
    let lib_path_opts = map ("-L"++) lib_paths

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

680
    libs <- readIORef v_Cmdline_libraries
681
682
683
684
685
686
    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
687
    extra_ld_inputs <- readIORef v_Ld_inputs
688
689

	-- opts from -optl-<blah>
690
    extra_ld_opts <- getStaticOpts v_Opt_l
691

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

-----------------------------------------------------------------------------
-- 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) 
732
733
734
735
  do init_driver_state <- readIORef v_InitDriverState
     writeIORef v_Driver_state init_driver_state

     pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
736
			defaultHscLang filename
737
     runPipeline pipeline filename False{-no linking-} False{-no -o flag-}
738

739

740
-----------------------------------------------------------------------------
741
-- Compile a single module, under the control of the compilation manager.
742
743
744
745
746
747
--
-- 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.

748
749
750
751
752
753
-- 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.

754
755
756
757
758
-- 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?
759
        -> Maybe ModIface          -- old interface, if available
760
761
        -> HomeSymbolTable         -- for home module ModDetails
	-> HomeIfaceTable	   -- for home module Ifaces
762
763
764
        -> PersistentCompilerState -- persistent compiler state
        -> IO CompResult

765
data CompResult
766
767
768
769
770
771
   = 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)
772
773
774
775

   | CompErrs PersistentCompilerState	-- updated PCS


776
compile ghci_mode summary source_unchanged old_iface hst hit pcs = do 
777
778
   init_dyn_flags <- readIORef v_InitDynFlags
   writeIORef v_DynFlags init_dyn_flags
779
780
   init_driver_state <- readIORef v_InitDriverState
   writeIORef v_Driver_state init_driver_state
781

782
783
   showPass init_dyn_flags 
	(showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
784
785

   let verb = verbosity init_dyn_flags
786
   let location   = ms_location summary
787
788
   let input_fn   = unJust "compile:hs" (ml_hs_file location) 
   let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
789

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

792
   opts <- getOptionsFromSource input_fnpp
793
794
795
   processArgs dynamic_flags opts []
   dyn_flags <- readIORef v_DynFlags

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

   -- run the compiler
804
805
   hsc_result <- hscMain ghci_mode dyn_flags{ hscOutName = output_fn } 
			 source_unchanged
806
                         location old_iface hst hit pcs
807

808
809
   case hsc_result of
      HscFail pcs -> return (CompErrs pcs)
810

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

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

822
	   (hs_unlinked, unlinked_time) <-
823
824
825
826
	     case hsc_lang of

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

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

845
846
	   let linkable = LM unlinked_time (moduleName (ms_mod summary)) 
			     (hs_unlinked ++ stub_unlinked)
847

848
849
	   return (CompOK pcs details iface (Just linkable))

850
851
852
853
854
855
856
857
858
859
860
861
862

-----------------------------------------------------------------------------
-- 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
863
	      	runSomething "Copy stub .h file"
864
865
866
867
868
869
870
871
872
				("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
873
		runSomething "Copy stub .c file" 
874
875
		    (unwords [ 
			"rm -f", stub_c, "&&",
rrt's avatar
rrt committed
876
			"echo \'#include \"Stg.h\"\n#include \""++stub_h++"\"\' >"++stub_c, " &&",
877
878
879
880
			"cat", tmp_stub_c, ">> ", stub_c
			])

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

		return (Just stub_o)