DriverPipeline.hs 50.8 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
32
import SysTools
33
import qualified SysTools	
34
import HscMain
35
import Finder
36
37
38
import HscTypes
import Outputable
import Module
Simon Marlow's avatar
Simon Marlow committed
39
import UniqFM		( eltsUFM )
40
import ErrUtils
41
42
import DynFlags
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
43
import Config
44
import Panic
45
import Util
46
import StringBuffer	( hGetStringBuffer )
47
import BasicTypes	( SuccessFlag(..) )
48
import Maybes		( expectJust )
49
import ParserCoreUtils	( getCoreModuleName )
50
import SrcLoc		( unLoc )
51
import SrcLoc		( Located(..) )
52

Simon Marlow's avatar
Simon Marlow committed
53
54
55
56
57
58
59
import Control.Exception as Exception
import Data.IORef	( readIORef, writeIORef, IORef )
import GHC.Exts		( Int(..) )
import System.Directory
import System.IO
import SYSTEM_IO_ERROR as IO
import Control.Monad
60
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
61
62
63
64
import Data.Maybe
import System.Exit
import System.Cmd
import System.Environment
65

66
67
-- ---------------------------------------------------------------------------
-- Pre-process
68
69
70

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

75
76
77
preprocess :: DynFlags -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
preprocess dflags (filename, mb_phase) =
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
Simon Marlow's avatar
Simon Marlow committed
78
79
  runPipeline anyHsc dflags (filename, mb_phase) 
        Nothing Temporary Nothing{-no ModLocation-}
80

81
82
-- ---------------------------------------------------------------------------
-- Compile
83
84
85
86
87
88
89
90
91
92

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

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

data CompResult
101
102
103
   = CompOK   ModDetails 	-- New details
              ModIface		-- New iface
              (Maybe Linkable)	-- a Maybe, for the same reasons as hm_linkable
104

105
   | CompErrs 
106
107


108
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
109

110
   let dflags0     = ms_hspp_opts mod_summary
111
112
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
113

114
115
116
117
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

118
119
   -- 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)
120

121
   let location	  = ms_location mod_summary
122
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
123
   let input_fnpp = ms_hspp_file mod_summary
124

125
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
126

127
   let (basename, _) = splitFilename input_fn
128

129
130
131
132
  -- 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
133
134
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
135

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

144
   let dflags' = dflags { hscTarget = hsc_lang,
145
				hscOutName = output_fn,
146
147
148
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
149
150
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
151
       hsc_env' = hsc_env { hsc_dflags = dflags' }
152
       object_filename = ml_obj_file location
153

154
155
156
157
158
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

159
       handleBatch (HscNoRecomp, iface, details)
160
161
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
162
       handleBatch (HscRecomp hasStub, iface, details)
163
164
165
166
167
168
169
170
171
172
           | 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
Simon Marlow's avatar
Simon Marlow committed
173
174
175
                            -> do runPipeline StopLn dflags (output_fn,Nothing)
                                              (Just basename)
                                              Persistent
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
                                              (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
203
                                     source_unchanged old_iface
204
205
206
207
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
208
   -- run the compiler
209
210
211
212
   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
213
214
     HscNothing
         -> runCompiler hscCompileNothing handleBatch
215
     _other
216
         -> runCompiler hscCompileBatch handleBatch
217

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

221
222
223
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
224
225
226
227
228
229
230
231
232
233
234
235
236
-- 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.

237
238
239
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
	let (o_base, o_ext) = splitFilename (ml_obj_file location)
240
241
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

242
	-- compile the _stub.c file w/ gcc
Simon Marlow's avatar
Simon Marlow committed
243
	let (stub_c,_) = mkStubPaths dflags (moduleName mod) location
Simon Marlow's avatar
Simon Marlow committed
244
	runPipeline StopLn dflags (stub_c,Nothing)  Nothing
245
246
247
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
248
249


250
251
-- ---------------------------------------------------------------------------
-- Link
252

253
link :: GhcMode			-- interactive or batch
254
255
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
256
     -> HomePackageTable	-- what to link
257
258
259
260
261
262
263
264
265
266
     -> 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
267
268
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
269
270
271
	 return Succeeded
#endif

272
273
274
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

275
link BatchCompile dflags batch_attempt_linking hpt
276
   | batch_attempt_linking
277
   = do 
278
	let 
Simon Marlow's avatar
Simon Marlow committed
279
	    home_mod_infos = eltsUFM hpt
280
281
282
283
284

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

	    -- the linkables to link
285
	    linkables = map (expectJust "link".hm_linkable) home_mod_infos
286

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

289
	-- check for the -no-link flag
290
	if isNoLink (ghcLink dflags)
291
	  then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
292
293
294
	          return Succeeded
	  else do

295
296
297
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

298
299
300
301
302
303
304
305
306
307
308
	    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)

309
	if not (dopt Opt_ForceRecomp dflags) && not linking_needed
310
	   then do debugTraceMsg dflags 2 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
311
312
313
		   return Succeeded
	   else do

314
315
	debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
				 <+> text "...")
316

317
	-- Don't showPass in Batch mode; doLink will do that for us.
318
319
320
321
	let link = case ghcLink dflags of
	        MkDLL       -> doMkDLL
	        StaticLink  -> staticLink
	link dflags obj_files pkg_deps
322

323
        debugTraceMsg dflags 3 (text "link: done")
324
325
326
327
328

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
329
330
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
331
        return Succeeded
332
      
333
334
335
336

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

337
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
338
339
340
341
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

342
343
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
   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
Simon Marlow's avatar
Simon Marlow committed
367
368
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
   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.
Simon Marlow's avatar
Simon Marlow committed
385
    link_pkgs = [haskell98PackageId]
386
387


388
389
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
390

391
392
393
394
-- 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.

395
-- The DynFlags can be modified by phases in the pipeline (eg. by
396
397
398
399
400
401
402
403
404
405
406
407
408
-- 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.
409

410
runPipeline
411
412
413
  :: Phase		        -- When to stop
  -> DynFlags		        -- Dynamic flags
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
Simon Marlow's avatar
Simon Marlow committed
414
  -> Maybe FilePath             -- original basename (if different from ^^^)
415
416
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
417
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
418

Simon Marlow's avatar
Simon Marlow committed
419
runPipeline stop_phase dflags (input_fn, mb_phase) mb_basename output maybe_loc
420
  = do
Simon Marlow's avatar
Simon Marlow committed
421
422
423
  let (input_basename, suffix) = splitFilename input_fn
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
424
425

	-- If we were given a -x flag, then use that phase to start from
basvandijk@home.nl's avatar
basvandijk@home.nl committed
426
      start_phase = fromMaybe (startPhase suffix) mb_phase
427

428
429
430
431
432
433
  -- 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.
434

435
436
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
437
438
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
439

440
441
  -- 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)
442
  let get_output_fn = getOutputFilename stop_phase output basename
443

444
  -- Execute the pipeline...
445
446
447
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
448

449
  -- Sometimes, a compilation phase doesn't actually generate any output
450
451
  -- (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
452
453
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
454
455
456
457
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
458
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
459
460
461
462
	   when (final_fn /= output_fn) $ do
              let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
                  line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
	      copyWithHeader dflags msg line_prag output_fn final_fn
463
	   return (dflags', final_fn)
464

465
466


467
pipeLoop :: DynFlags -> Phase -> Phase 
468
	 -> FilePath  -> String -> Suffix
469
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
470
471
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
472

473
pipeLoop dflags phase stop_phase 
474
475
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
476

477
478
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
479

480
  | not (phase `happensBefore` stop_phase)
481
482
483
484
	-- 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 #-}.
485
486
487
488
489
  = 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)
490
		<- runPhase phase stop_phase dflags orig_basename 
491
			    orig_suff input_fn orig_get_output_fn maybe_loc
492
	; pipeLoop dflags' next_phase stop_phase output_fn
493
494
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

495
getOutputFilename
496
497
498
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
499
500
 = func
 where
501
	func dflags next_phase maybe_location
502
503
504
505
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
506
	   where
507
508
509
510
511
512
513
514
515
516
517
		hcsuf      = hcSuf dflags
		odir       = objectDir dflags
		osuf       = objectSuf dflags
		keep_hc    = dopt Opt_KeepHcFiles dflags
		keep_raw_s = dopt Opt_KeepRawSFiles dflags
		keep_s     = dopt Opt_KeepSFiles dflags

		myPhaseInputExt HCc    = hcsuf
		myPhaseInputExt StopLn = osuf
		myPhaseInputExt other  = phaseInputExt other

518
		is_last_phase = next_phase `eqPhase` stop_phase
519
520
521
522

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
523
     			     StopLn              -> True
524
525
526
527
528
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

529
		suffix = myPhaseInputExt next_phase
530
531
532

		-- persistent object files get put in odir
	        persistent_fn 
533
534
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
535

536
		persistent = basename `joinFileExt` suffix
537

538
		odir_persistent
539
		   | Just loc <- maybe_location = ml_obj_file loc
540
		   | Just d <- odir = d `joinFileName` persistent
541
542
		   | otherwise      = persistent

543

544
545
546
547
548
549
550
551
552
553
-- -----------------------------------------------------------------------------
-- 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.

554
555
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
556
557
558
559
	 -> DynFlags
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
560
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
561
			-- how to calculate the output filename
562
	 -> Maybe ModLocation		-- the ModLocation, if we have one
563
	 -> IO (Phase,	  		-- next phase
564
565
566
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
567

568
569
570
571
	-- 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 

572
573
574
-------------------------------------------------------------------------------
-- Unlit phase 

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

580
581
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
582
583
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
584
585
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
586
			  ])
587

588
       return (Cpp sf, dflags, maybe_loc, output_fn)
589
590

-------------------------------------------------------------------------------
591
592
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
593

594
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
595
596
  = do src_opts <- getOptionsFromFile input_fn
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
597
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
598

599
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
600
601
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
602
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
603
	else do
604
	    output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
605
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
606
	    return (HsPp sf, dflags, maybe_loc, output_fn)
607

sof's avatar
sof committed
608
609
610
-------------------------------------------------------------------------------
-- HsPp phase 

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

629
630
631
-----------------------------------------------------------------------------
-- Hsc phase

632
633
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
634
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
635
 = do	-- normal Hsc mode, not mkdependHS
636

637
638
639
  -- 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.
640
	let current_dir = directoryOf basename
641
	
642
643
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
644
	
645
  -- gather the imports and module name
646
        (hspp_buf,mod_name) <- 
647
648
649
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
Simon Marlow's avatar
Simon Marlow committed
650
			          ; return (Nothing, mkModuleName m) }
651
652

		other -> do { buf <- hGetStringBuffer input_fn
653
			    ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
654
655
656
657
658
659
660
661
			    ; 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)
662
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
663
664
665
666
667
668
669
670
671

  -- 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
672
673
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
674
675
676
677
678
679
680
		      | 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
681
682
683
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
684
685
686
687
688
689
690
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

	    o_file = ml_obj_file location4 	-- The real object file


  -- Figure out if the source has changed, for recompilation avoidance.
691
  --
692
  -- Setting source_unchanged to True means that M.o seems
693
694
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
695
  -- Setting source_unchanged to False tells the compiler that M.o is out of
696
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Simon Marlow's avatar
Simon Marlow committed
697
698
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)

699
	let force_recomp = dopt Opt_ForceRecomp dflags
700
	source_unchanged <- 
701
          if force_recomp || not (isStopLn stop)
702
703
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
704
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
705
706
	     then return False	
		-- Otherwise look at file modification dates
707
	     else do o_file_exists <- doesFileExist o_file
708
		     if not o_file_exists
709
		        then return False	-- Need to recompile
710
			else do t2 <- getModificationTime o_file
711
			        if t2 > src_timestamp
712
713
				  then return True
				  else return False
714

715
  -- get the DynFlags
716
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
717
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
718
	output_fn  <- get_output_fn dflags next_phase (Just location4)
719

720
        let dflags' = dflags { hscTarget = hsc_lang,
721
722
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
723

724
	hsc_env <- newHscEnv dflags'
725

726
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
	mod <- addHomeModuleToFinder hsc_env mod_name location4

  -- Make the ModSummary to hand to hscMain
	let
	    unused_field = panic "runPhase:ModSummary field"
		-- Some fields are not looked at by hscMain
	    mod_summary = ModSummary {	ms_mod 	     = mod, 
					ms_hsc_src   = src_flavour,
				 	ms_hspp_file = input_fn,
                                        ms_hspp_opts = dflags,
					ms_hspp_buf  = hspp_buf,
					ms_location  = location4,
					ms_hs_date   = src_timestamp,
					ms_obj_date  = Nothing,
					ms_imps	     = unused_field,
					ms_srcimps   = unused_field }
743

744
  -- run the compiler!
745
	mbResult <- hscCompileOneShot hsc_env
746
747
			  mod_summary source_unchanged 
			  Nothing	-- No iface
748
                          Nothing       -- No "module i of n" progress info
749

750
751
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
752
          Just HscNoRecomp
753
754
755
756
757
              -> 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)
758
          Just (HscRecomp hasStub)
759
              -> do when hasStub $
Simon Marlow's avatar
Simon Marlow committed
760
                         do stub_o <- compileStub dflags' mod location4
761
762
763
764
765
766
                            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)
767

768
769
770
-----------------------------------------------------------------------------
-- Cmm phase

771
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
772
  = do
773
       output_fn <- get_output_fn dflags Cmm maybe_loc
774
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
775
       return (Cmm, dflags, maybe_loc, output_fn)
776

777
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
778
  = do
779
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
780
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
781
	output_fn <- get_output_fn dflags next_phase maybe_loc
782

783
        let dflags' = dflags { hscTarget = hsc_lang,
784
785
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
786

787
	ok <- hscCmmFile dflags' input_fn
788
789
790

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

791
	return (next_phase, dflags, maybe_loc, output_fn)
792

793
794
795
796
797
798
-----------------------------------------------------------------------------
-- 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.

799
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
800
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
801
   = do	let cc_opts = getOpts dflags opt_c
802
	    hcc = cc_phase `eqPhase` HCc
803

804
       	let cmdline_include_paths = includePaths dflags
805

806
807
808
809
810
811
	-- 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 :)
812
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
813
814
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
815

816
817
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
818

819
        let verb = getVerbFlag dflags
820

821
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
822

823
824
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
825
		      | otherwise         = [ ]
826

827
	let excessPrecision = dopt Opt_ExcessPrecision dflags
828

Simon Marlow's avatar
Simon Marlow committed
829
830
831
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

832
	-- Decide next phase
833
834
835
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
836
837
		| hcc && mangle     = Mangle
		| otherwise         = As
838
	output_fn <- get_output_fn dflags next_phase maybe_loc
839

840
841
	let
	  more_hcc_opts =
842
#if i386_TARGET_ARCH
843
844
845
846
847
848
849
850
851
852
853
854
855
856
	   	-- 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"]



857
858
859
860
861
	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.
862
863
			[ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
                                                then SysTools.Option "c++" else SysTools.Option "c"] ++
864
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
865
			, SysTools.Option "-o"
sof's avatar
sof committed
866
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
867
868
869
			]
		       ++ map SysTools.Option (
		          md_c_flags
870
                       ++ pic_c_flags
871
872
873
874
875
876
877
878
879
#ifdef sparc_TARGET_ARCH
        -- We only support SparcV9 and better because V8 lacks an atomic CAS
        -- instruction. Note that the user can still override this
	-- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
	-- regardless of the ordering.
        --
        -- This is a temporary hack.
                       ++ ["-mcpu=v9"]
#endif
880
		       ++ (if hcc && mangle
881
882
		  	     then md_regd_c_flags
		  	     else [])
883
884
885
		       ++ (if hcc 
			     then more_hcc_opts
			     else [])
Simon Marlow's avatar
Simon Marlow committed
886
		       ++ [ verb, "-S", "-Wimplicit", cc_opt ]
887
888
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
889
		       ++ split_opt
890
891
		       ++ include_paths
		       ++ pkg_extra_cc_opts
892
893
894
895
#ifdef HAVE_GCC_HAS_WRAPV
                  -- We need consistent integer overflow (trac #952)
               ++ ["-fwrapv"]
#endif
sof's avatar
sof committed
896
		       ))
897

898
	return (next_phase, dflags, maybe_loc, output_fn)
899
900
901
902
903
904

	-- ToDo: postprocess the output from gcc

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

905
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
906
   = do let mangler_opts = getOpts dflags opt_m
907
908
909
910
911
912

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

914
915
	let split = dopt Opt_SplitObjs dflags
            next_phase
916
917
		| split = SplitMangle
		| otherwise = As
918
	output_fn <- get_output_fn dflags next_phase maybe_loc
919

920
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
921
922
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
923
924
			     ]
			  ++ map SysTools.Option machdep_opts)
925

926
	return (next_phase, dflags, maybe_loc, output_fn)
927
928
929
930

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

931
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
932
933
  = 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)
934
	split_s_prefix <- SysTools.newTempName dflags "split"
935
	let n_files_fn = split_s_prefix
936

937
938
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
939
940
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
941
			  ]
942
943
944
945
946
947
948
949
950

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