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

module DriverPipeline (
10
11
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
12
   oneShot, compileFile,
13

14
	-- Interfaces for the batch-mode driver
15
   staticLink,
16

17
18
19
20
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
   compile, CompResult(..), 
   link, 
21

rrt's avatar
rrt committed
22
        -- DLL building
23
24
   doMkDLL,

25
26
27
28
  ) where

#include "HsVersions.h"

29
import Packages
30
import HeaderInfo
31
import DriverPhases
sof's avatar
sof committed
32
import SysTools		( newTempName, addFilesToClean, getSysMan, copy )
33
import qualified SysTools	
34
import HscMain
35
import Finder
36
37
38
import HscTypes
import Outputable
import Module
39
import ErrUtils
40
41
import DynFlags
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
42
import Config
43
import Panic
44
import Util
45
import StringBuffer	( hGetStringBuffer )
46
import BasicTypes	( SuccessFlag(..) )
47
import Maybes		( expectJust )
48
import ParserCoreUtils	( getCoreModuleName )
49
import SrcLoc		( unLoc )
50
import SrcLoc		( Located(..) )
51

52
import EXCEPTION
53
import DATA_IOREF	( readIORef, writeIORef, IORef )
54
import GLAEXTS		( Int(..) )
55

56
57
import Directory
import System
58
59
import IO
import Monad
60
import Data.List	( isSuffixOf )
61
62
import Maybe

63

64
65
-- ---------------------------------------------------------------------------
-- Pre-process
66
67
68

-- Just preprocess a file, put the result in a temp. file (used by the
-- compilation manager during the summary phase).
69
70
71
--
-- We return the augmented DynFlags, because they contain the result
-- of slurping in the OPTIONS pragmas
72

73
74
75
76
preprocess :: DynFlags -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
preprocess dflags (filename, mb_phase) =
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
  runPipeline anyHsc dflags (filename, mb_phase) Temporary Nothing{-no ModLocation-}
77

78
79
-- ---------------------------------------------------------------------------
-- Compile
80
81
82
83
84
85
86
87
88
89

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

-- NB.  No old interface can also mean that the source has changed.

90
compile :: HscEnv
91
	-> ModSummary
92
	-> Maybe Linkable	-- Just linkable <=> source unchanged
93
        -> Maybe ModIface       -- Old interface, if available
94
        -> Int -> Int
95
96
97
        -> IO CompResult

data CompResult
98
99
100
   = CompOK   ModDetails 	-- New details
              ModIface		-- New iface
              (Maybe Linkable)	-- a Maybe, for the same reasons as hm_linkable
101

102
   | CompErrs 
103
104


105
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
106

107
   let dflags0     = ms_hspp_opts mod_summary
108
109
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
110

111
112
113
114
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

115
116
   -- FIXME: We need to know whether or not we're recompiling the file. Move this to HscMain?
   --showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
117

118
   let location	  = ms_location mod_summary
119
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
120
   let input_fnpp = ms_hspp_file mod_summary
121

122
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
123

124
   let (basename, _) = splitFilename input_fn
125

126
127
128
129
  -- We add the directory in which the .hs files resides) to the import path.
  -- This is needed when we try to compile the .hc file later, if it
  -- imports a _stub.h file that we created here.
   let current_dir = directoryOf basename
130
131
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
132

133
   -- Figure out what lang we're generating
134
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
135
   -- ... and what the next phase should be
136
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
137
   -- ... and what file to generate the output into
138
139
   output_fn <- getOutputFilename dflags next_phase 
			Temporary basename next_phase (Just location)
140

141
   let dflags' = dflags { hscTarget = hsc_lang,
142
				hscOutName = output_fn,
143
144
145
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
146
   let do_recomp = dopt Opt_RecompChecking dflags
147
       source_unchanged = isJust maybe_old_linkable && do_recomp
148
       hsc_env' = hsc_env { hsc_dflags = dflags' }
149
       object_filename = ml_obj_file location
150

151
152
153
154
155
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

156
       handleBatch (HscNoRecomp, iface, details)
157
158
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
159
       handleBatch (HscRecomp hasStub, iface, details)
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
           | isHsBoot src_flavour
               = return (CompOK details iface Nothing)
           | otherwise
               = do stub_unlinked <- getStubLinkable hasStub
                    (hs_unlinked, unlinked_time) <-
                        case hsc_lang of
                          HscNothing
                            -> return ([], ms_hs_date mod_summary)
                          -- We're in --make mode: finish the compilation pipeline.
                          _other
                            -> do runPipeline StopLn dflags (output_fn,Nothing) Persistent
                                              (Just location)
                                  -- The object filename comes from the ModLocation
                                  o_time <- getModificationTime object_filename
                                  return ([DotO object_filename], o_time)
                    let linkable = LM unlinked_time this_mod
			           (hs_unlinked ++ stub_unlinked)
                    return (CompOK details iface (Just linkable))

       handleInterpreted (InteractiveNoRecomp, iface, details)
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
       handleInterpreted (InteractiveRecomp hasStub comp_bc, iface, details)
           = do stub_unlinked <- getStubLinkable hasStub
                let hs_unlinked = [BCOs comp_bc]
                    unlinked_time = ms_hs_date mod_summary
                  -- Why do we use the timestamp of the source file here,
                  -- rather than the current time?  This works better in
                  -- the case where the local clock is out of sync
                  -- with the filesystem's clock.  It's just as accurate:
                  -- if the source is modified, then the linkable will
                  -- be out of date.
                let linkable = LM unlinked_time this_mod
                               (hs_unlinked ++ stub_unlinked)
                return (CompOK details iface (Just linkable))

   let runCompiler compiler handle
           = do mbResult <- compiler hsc_env' mod_summary
198
                                     source_unchanged old_iface
199
200
201
202
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
203
   -- run the compiler
204
205
206
207
   case hsc_lang of
     HscInterpreted | not (isHsBoot src_flavour) -- We can't compile boot files to
                                                 -- bytecode so don't even try.
         -> runCompiler hscCompileInteractive handleInterpreted
208
209
     HscNothing
         -> runCompiler hscCompileNothing handleBatch
210
     _other
211
         -> runCompiler hscCompileBatch handleBatch
212

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

216
217
218
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
219
220
221
222
223
224
225
226
227
228
229
230
231
-- Consequently, we derive the _stub.o filename from the haskell object
-- filename.  
--
-- This isn't necessarily the same as the object filename we
-- would get if we just compiled the _stub.c file using the pipeline.
-- For example:
--
--    ghc src/A.hs -odir obj
-- 
-- results in obj/A.o, and src/A_stub.c.  If we compile src/A_stub.c with
-- -odir obj, we would get obj/src/A_stub.o, which is wrong; we want
-- obj/A_stub.o.

232
233
234
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
	let (o_base, o_ext) = splitFilename (ml_obj_file location)
235
236
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

237
	-- compile the _stub.c file w/ gcc
238
	let (stub_c,_) = mkStubPaths dflags mod location
239
240
241
242
	runPipeline StopLn dflags (stub_c,Nothing) 
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
243
244


245
246
-- ---------------------------------------------------------------------------
-- Link
247

248
link :: GhcMode			-- interactive or batch
249
250
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
251
     -> HomePackageTable	-- what to link
252
253
254
255
256
257
258
259
260
261
     -> IO SuccessFlag

-- For the moment, in the batch linker, we don't bother to tell doLink
-- which packages to link -- it just tries all that are available.
-- batch_attempt_linking should only be *looked at* in batch mode.  It
-- should only be True if the upsweep was successful and someone
-- exports main, i.e., we have good reason to believe that linking
-- will succeed.

#ifdef GHCI
262
263
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
264
265
266
	 return Succeeded
#endif

267
268
269
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

270
link BatchCompile dflags batch_attempt_linking hpt
271
   | batch_attempt_linking
272
   = do 
273
274
275
276
277
278
279
	let 
	    home_mod_infos = moduleEnvElts hpt

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

	    -- the linkables to link
280
	    linkables = map (expectJust "link".hm_linkable) home_mod_infos
281

282
        debugTraceMsg dflags 3 (text "link: linkables are ..." $$ vcat (map ppr linkables))
283

284
	-- check for the -no-link flag
285
	if isNoLink (ghcLink dflags)
286
	  then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
287
288
289
	          return Succeeded
	  else do

290
291
292
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

293
294
295
296
297
298
299
300
301
302
303
304
	    exe_file = exeFileName dflags

	-- if the modification time on the executable is later than the
	-- modification times on all of the objects, then omit linking
	-- (unless the -no-recomp flag was given).
	e_exe_time <- IO.try $ getModificationTime exe_file
	let linking_needed 
		| Left _  <- e_exe_time = True
		| Right t <- e_exe_time = 
			any (t <) (map linkableTime linkables)

	if dopt Opt_RecompChecking dflags && not linking_needed
305
	   then do debugTraceMsg dflags 2 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
306
307
308
		   return Succeeded
	   else do

309
310
	debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
				 <+> text "...")
311

312
	-- Don't showPass in Batch mode; doLink will do that for us.
313
314
315
316
	let link = case ghcLink dflags of
	        MkDLL       -> doMkDLL
	        StaticLink  -> staticLink
	link dflags obj_files pkg_deps
317

318
        debugTraceMsg dflags 3 (text "link: done")
319
320
321
322
323

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
324
325
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
326
        return Succeeded
327
      
328
329
330
331

-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

332
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
333
334
335
336
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

337
338
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
   exists <- doesFileExist src
   when (not exists) $ 
   	throwDyn (CmdLineError ("does not exist: " ++ src))
   
   let
	split     = dopt Opt_SplitObjs dflags
	mb_o_file = outputFile dflags
	ghc_link  = ghcLink dflags	-- Set by -c or -no-link

	-- When linking, the -o argument refers to the linker's output.	
	-- otherwise, we use it as the name for the pipeline's output.
        output
	 | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
		-- -o foo applies to linker
	 | Just o_file <- mb_o_file = SpecificFile o_file
		-- -o foo applies to the file we are compiling now
	 | otherwise = Persistent

        stop_phase' = case stop_phase of 
			As | split -> SplitAs
			other      -> stop_phase

   (_, out_file) <- runPipeline stop_phase' dflags
362
			  (src, mb_phase) output Nothing{-no ModLocation-}
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
   return out_file


doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
doLink dflags stop_phase o_files
  | not (isStopLn stop_phase)
  = return ()		-- We stopped before the linking phase

  | otherwise
  = case ghcLink dflags of
	NoLink     -> return ()
	StaticLink -> staticLink dflags o_files link_pkgs
	MkDLL      -> doMkDLL dflags o_files link_pkgs
  where
   -- Always link in the haskell98 package for static linking.  Other
   -- packages have to be specified via the -package flag.
    link_pkgs
	  | ExtPackage h98_id <- haskell98PackageId (pkgState dflags) = [h98_id]
	  | otherwise = []


384
385
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
386

387
388
389
390
-- This is the interface to the compilation pipeline, which runs
-- a series of compilation steps on a single source file, specifying
-- at which stage to stop.

391
-- The DynFlags can be modified by phases in the pipeline (eg. by
392
393
394
395
396
397
398
399
400
401
402
403
404
-- GHC_OPTIONS pragmas), and the changes affect later phases in the
-- pipeline.

data PipelineOutput 
  = Temporary
	-- output should be to a temporary file: we're going to
	-- run more compilation steps on this output later
  | Persistent
	-- we want a persistent file, i.e. a file in the current directory
	-- derived from the input filename, but with the appropriate extension.
	-- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
  | SpecificFile FilePath
	-- the output must go into the specified file.
405

406
runPipeline
407
408
409
410
411
  :: Phase		        -- When to stop
  -> DynFlags		        -- Dynamic flags
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
412
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
413

414
runPipeline stop_phase dflags (input_fn, mb_phase) output maybe_loc
415
416
  = do
  let (basename, suffix) = splitFilename input_fn
417
418
419
420
421

	-- If we were given a -x flag, then use that phase to start from
      start_phase
	| Just x_phase <- mb_phase = x_phase
	| otherwise                = startPhase suffix
422

423
424
425
426
427
428
  -- We want to catch cases of "you can't get there from here" before
  -- we start the pipeline, because otherwise it will just run off the
  -- end.
  --
  -- There is a partial ordering on phases, where A < B iff A occurs
  -- before B in a normal compilation pipeline.
429

430
431
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
432
433
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
434

435
436
437
  -- this is a function which will be used to calculate output file names
  -- as we go along (we partially apply it to some of its inputs here)
  let get_output_fn = getOutputFilename dflags stop_phase output basename
438

439
  -- Execute the pipeline...
440
441
442
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
443

444
  -- Sometimes, a compilation phase doesn't actually generate any output
445
446
447
  -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
  -- stage, but we wanted to keep the output, then we have to explicitly
  -- copy the file.
448
449
450
451
452
453
454
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
	do final_fn <- get_output_fn stop_phase maybe_loc
	   when (final_fn /= output_fn) $
		  copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
455
			++ "'") output_fn final_fn
456
457
	   return (dflags', final_fn)
	        
458
459


460
pipeLoop :: DynFlags -> Phase -> Phase 
461
462
463
464
	 -> FilePath  -> String -> Suffix
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
465

466
pipeLoop dflags phase stop_phase 
467
468
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
469

470
471
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
472

473
  | not (phase `happensBefore` stop_phase)
474
475
476
477
	-- Something has gone wrong.  We'll try to cover all the cases when
	-- this could happen, so if we reach here it is a panic.
	-- eg. it might happen if the -C flag is used on a source file that
	-- has {-# OPTIONS -fasm #-}.
478
479
480
481
482
  = panic ("pipeLoop: at phase " ++ show phase ++ 
	   " but I wanted to stop at phase " ++ show stop_phase)

  | otherwise 
  = do	{ (next_phase, dflags', maybe_loc, output_fn)
483
		<- runPhase phase stop_phase dflags orig_basename 
484
			    orig_suff input_fn orig_get_output_fn maybe_loc
485
	; pipeLoop dflags' next_phase stop_phase output_fn
486
487
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

488
489
490
491
getOutputFilename
  :: DynFlags -> Phase -> PipelineOutput -> String
  -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename dflags stop_phase output basename
492
493
494
 = func
 where
	hcsuf      = hcSuf dflags
495
	odir       = objectDir dflags
496
497
498
499
500
	osuf       = objectSuf dflags
	keep_hc    = dopt Opt_KeepHcFiles dflags
	keep_raw_s = dopt Opt_KeepRawSFiles dflags
	keep_s     = dopt Opt_KeepSFiles dflags

501
502
503
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
504

505
	func next_phase maybe_location
506
507
508
509
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
510
	   where
511
		is_last_phase = next_phase `eqPhase` stop_phase
512
513
514
515

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
516
     			     StopLn              -> True
517
518
519
520
521
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

522
		suffix = myPhaseInputExt next_phase
523
524
525

		-- persistent object files get put in odir
	        persistent_fn 
526
527
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
528

529
		persistent = basename `joinFileExt` suffix
530

531
		odir_persistent
532
		   | Just loc <- maybe_location = ml_obj_file loc
533
		   | Just d <- odir = d `joinFileName` persistent
534
535
		   | otherwise      = persistent

536

537
538
539
540
541
542
543
544
545
546
-- -----------------------------------------------------------------------------
-- Each phase in the pipeline returns the next phase to execute, and the
-- name of the file in which the output was placed.
--
-- We must do things dynamically this way, because we often don't know
-- what the rest of the phases will be until part-way through the
-- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
-- of a source file can change the latter stages of the pipeline from
-- taking the via-C route to using the native code generator.

547
548
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
549
550
551
552
553
	 -> DynFlags
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
554
			-- how to calculate the output filename
555
	 -> Maybe ModLocation		-- the ModLocation, if we have one
556
	 -> IO (Phase,	  		-- next phase
557
558
559
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
560

561
562
563
564
	-- Invariant: the output filename always contains the output
	-- Interesting case: Hsc when there is no recompilation to do
	--		     Then the output filename is still a .o file 

565
566
567
-------------------------------------------------------------------------------
-- Unlit phase 

568
runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
569
  = do let unlit_flags = getOpts dflags opt_L
rrt's avatar
rrt committed
570
       -- The -h option passes the file name for unlit to put in a #line directive
571
       output_fn <- get_output_fn (Cpp sf) maybe_loc
572

573
574
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
575
576
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
577
578
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
579
			  ])
580

581
       return (Cpp sf, dflags, maybe_loc, output_fn)
582
583

-------------------------------------------------------------------------------
584
585
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
586

587
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
588
589
  = do src_opts <- getOptionsFromFile input_fn
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
590
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
591

592
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
593
594
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
595
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
596
	else do
597
	    output_fn <- get_output_fn (HsPp sf) maybe_loc
598
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
599
	    return (HsPp sf, dflags, maybe_loc, output_fn)
600

sof's avatar
sof committed
601
602
603
-------------------------------------------------------------------------------
-- HsPp phase 

604
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
605
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
606
607
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
608
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
609
	else do
610
	    let hspp_opts = getOpts dflags opt_F
611
	    let orig_fn = basename `joinFileExt` suff
612
	    output_fn <- get_output_fn (Hsc sf) maybe_loc
613
614
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
615
616
617
618
619
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
620
	    return (Hsc sf, dflags, maybe_loc, output_fn)
621

622
623
624
-----------------------------------------------------------------------------
-- Hsc phase

625
626
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
627
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
628
 = do	-- normal Hsc mode, not mkdependHS
629

630
631
632
  -- 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.
633
	let current_dir = directoryOf basename
634
	
635
636
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
637
	
638
  -- gather the imports and module name
639
        (hspp_buf,mod_name) <- 
640
641
642
643
644
645
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
			          ; return (Nothing, mkModule m) }

		other -> do { buf <- hGetStringBuffer input_fn
646
			    ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
647
648
649
650
651
652
653
654
			    ; return (Just buf, mod_name) }

  -- Build a ModLocation to pass to hscMain.
  -- The source filename is rather irrelevant by now, but it's used
  -- by hscMain for messages.  hscMain also needs 
  -- the .hi and .o filenames, and this is as good a way
  -- as any to generate them, and better than most. (e.g. takes 
  -- into accout the -osuf flags)
655
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
656
657
658
659
660
661
662
663
664

  -- Boot-ify it if necessary
	let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
		      | otherwise	     = location1 
					

  -- Take -ohi into account if present
  -- This can't be done in mkHomeModuleLocation because
  -- it only applies to the module being compiles
665
666
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
667
668
669
670
671
672
673
		      | otherwise      = location2

  -- Take -o into account if present
  -- Very like -ohi, but we must *only* do this if we aren't linking
  -- (If we're linking then the -o applies to the linked thing, not to
  -- the object file for one module.)
  -- Note the nasty duplication with the same computation in compileFile above
674
675
676
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
677
678
679
680
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

  -- Make the ModSummary to hand to hscMain
681
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)
682
683
684
685
686
	let
	    unused_field = panic "runPhase:ModSummary field"
		-- Some fields are not looked at by hscMain
	    mod_summary = ModSummary {	ms_mod 	     = mod_name, 
					ms_hsc_src   = src_flavour,
687
688
				 	ms_hspp_file = input_fn,
                                        ms_hspp_opts = dflags,
689
690
691
					ms_hspp_buf  = hspp_buf,
					ms_location  = location4,
					ms_hs_date   = src_timestamp,
sof's avatar
sof committed
692
					ms_obj_date  = Nothing,
693
694
695
696
697
698
699
					ms_imps	     = unused_field,
					ms_srcimps   = unused_field }

	    o_file = ml_obj_file location4 	-- The real object file


  -- Figure out if the source has changed, for recompilation avoidance.
700
  --
701
  -- Setting source_unchanged to True means that M.o seems
702
703
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
704
  -- Setting source_unchanged to False tells the compiler that M.o is out of
705
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
706
	let do_recomp = dopt Opt_RecompChecking dflags
707
	source_unchanged <- 
708
          if not do_recomp || not (isStopLn stop)
709
710
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
711
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
712
713
	     then return False	
		-- Otherwise look at file modification dates
714
	     else do o_file_exists <- doesFileExist o_file
715
		     if not o_file_exists
716
		        then return False	-- Need to recompile
717
			else do t2 <- getModificationTime o_file
718
			        if t2 > src_timestamp
719
720
				  then return True
				  else return False
721

722
  -- get the DynFlags
723
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
724
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
725
	output_fn  <- get_output_fn next_phase (Just location4)
726

727
        let dflags' = dflags { hscTarget = hsc_lang,
728
729
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
730

731
	hsc_env <- newHscEnv dflags'
732

733
734
735
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

736
  -- run the compiler!
737
	mbResult <- hscCompileOneShot hsc_env
738
739
			  mod_summary source_unchanged 
			  Nothing	-- No iface
740
                          Nothing       -- No "module i of n" progress info
741

742
743
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
744
          Just HscNoRecomp
745
746
747
748
749
              -> do SysTools.touch dflags' "Touching object file" o_file
                    -- The .o file must have a later modification date
                    -- than the source file (else we wouldn't be in HscNoRecomp)
                    -- but we touch it anyway, to keep 'make' happy (we think).
                    return (StopLn, dflags', Just location4, o_file)
750
          Just (HscRecomp hasStub)
751
752
753
754
755
756
757
758
              -> do when hasStub $
                         do stub_o <- compileStub dflags' mod_name location4
                            consIORef v_Ld_inputs stub_o
                    -- In the case of hs-boot files, generate a dummy .o-boot 
                    -- stamp file for the benefit of Make
                    when (isHsBoot src_flavour) $
                      SysTools.touch dflags' "Touching object file" o_file
                    return (next_phase, dflags', Just location4, output_fn)
759

760
761
762
-----------------------------------------------------------------------------
-- Cmm phase

763
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
764
765
  = do
       output_fn <- get_output_fn Cmm maybe_loc
766
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
767
       return (Cmm, dflags, maybe_loc, output_fn)
768

769
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
770
  = do
771
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
772
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
773
774
	output_fn <- get_output_fn next_phase maybe_loc

775
        let dflags' = dflags { hscTarget = hsc_lang,
776
777
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
778

779
	ok <- hscCmmFile dflags' input_fn
780
781
782

	when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))

783
	return (next_phase, dflags, maybe_loc, output_fn)
784

785
786
787
788
789
790
-----------------------------------------------------------------------------
-- 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.

791
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
792
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
793
   = do	let cc_opts = getOpts dflags opt_c
794
	    hcc = cc_phase `eqPhase` HCc
795

796
       	let cmdline_include_paths = includePaths dflags
797

798
799
800
801
802
803
	-- HC files have the dependent packages stamped into them
	pkgs <- if hcc then getHCFilePackages input_fn else return []

	-- add package include paths even if we're just compiling .c
	-- files; this is the Value Add(TM) that using ghc instead of
	-- gcc gives you :)
804
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
805
806
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
807

808
809
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
810

811
        let verb = getVerbFlag dflags
812

813
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
814

815
816
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
817
		      | otherwise         = [ ]
818

819
	let excessPrecision = dopt Opt_ExcessPrecision dflags
820

Simon Marlow's avatar
Simon Marlow committed
821
822
823
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

824
	-- Decide next phase
825
826
827
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
828
829
830
831
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

832
833
	let
	  more_hcc_opts =
834
#if i386_TARGET_ARCH
835
836
837
838
839
840
841
842
843
844
845
846
847
848
	   	-- on x86 the floating point regs have greater precision
	     	-- than a double, which leads to unpredictable results.
		-- By default, we turn this off with -ffloat-store unless
		-- the user specified -fexcess-precision.
		(if excessPrecision then [] else [ "-ffloat-store" ]) ++
#endif
		-- gcc's -fstrict-aliasing allows two accesses to memory
		-- to be considered non-aliasing if they have different types.
		-- This interacts badly with the C code we generate, which is
		-- very weakly typed, being derived from C--.
		["-fno-strict-aliasing"]



849
850
851
852
853
854
	SysTools.runCc dflags (
		-- force the C compiler to interpret this file as C when
		-- compiling .hc files, by adding the -x c option.
		-- Also useful for plain .c files, just in case GHC saw a 
		-- -x c option.
			[ SysTools.Option "-x", SysTools.Option "c"] ++
855
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
856
			, SysTools.Option "-o"
sof's avatar
sof committed
857
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
858
859
860
			]
		       ++ map SysTools.Option (
		          md_c_flags
861
                       ++ pic_c_flags
862
		       ++ (if hcc && mangle
863
864
		  	     then md_regd_c_flags
		  	     else [])
865
866
867
		       ++ (if hcc 
			     then more_hcc_opts
			     else [])
Simon Marlow's avatar
Simon Marlow committed
868
		       ++ [ verb, "-S", "-Wimplicit", cc_opt ]
869
870
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
871
		       ++ split_opt
872
873
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
874
		       ))
875

876
	return (next_phase, dflags, maybe_loc, output_fn)
877
878
879
880
881
882

	-- ToDo: postprocess the output from gcc

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

883
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
884
   = do let mangler_opts = getOpts dflags opt_m
885
886
887
888
889
890

#if i386_TARGET_ARCH
        machdep_opts <- return [ show (stolen_x86_regs dflags) ]
#else
	machdep_opts <- return []
#endif
891

892
893
	let split = dopt Opt_SplitObjs dflags
            next_phase
894
895
		| split = SplitMangle
		| otherwise = As
896
	output_fn <- get_output_fn next_phase maybe_loc
897

898
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
899
900
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
901
902
			     ]
			  ++ map SysTools.Option machdep_opts)
903

904
	return (next_phase, dflags, maybe_loc, output_fn)
905
906
907
908

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

909
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
910
911
  = 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)
912
	split_s_prefix <- SysTools.newTempName dflags "split"
913
	let n_files_fn = split_s_prefix
914

915
916
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
917
918
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
919
			  ]
920
921
922
923
924
925
926
927
928

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

930
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
931
	  -- we don't use the filename
932
933
934
935

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

936
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
937
  = do	let as_opts =  getOpts dflags opt_a
938
        let cmdline_include_paths = includePaths dflags
939

940
	output_fn <- get_output_fn StopLn maybe_loc
941

942
943
944
945
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

946
947
	SysTools.runAs dflags	
		       (map SysTools.Option as_opts
sof's avatar
sof committed
948
949
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
950
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
951
			  , SysTools.Option "-o"
sof's avatar
sof committed
952
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
953
			  ])
954

955
	return (StopLn, dflags, maybe_loc, output_fn)
956
957


958
runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973