DriverPipeline.hs 50.4 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
78
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-}
79

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

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

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

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

104
   | CompErrs 
105
106


107
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
108

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

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

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

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

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

126
   let (basename, _) = splitFilename input_fn
127

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

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

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

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

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

158
       handleBatch (HscNoRecomp, iface, details)
159
160
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
161
       handleBatch (HscRecomp hasStub, iface, details)
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
           | 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
200
                                     source_unchanged old_iface
201
202
203
204
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
205
   -- run the compiler
206
207
208
209
   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
210
211
     HscNothing
         -> runCompiler hscCompileNothing handleBatch
212
     _other
213
         -> runCompiler hscCompileBatch handleBatch
214

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

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

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

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

	return stub_o
245
246


247
248
-- ---------------------------------------------------------------------------
-- Link
249

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

269
270
271
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

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

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

	    -- the linkables to link
282
	    linkables = map (expectJust "link".hm_linkable) home_mod_infos
283

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

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

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

295
296
297
298
299
300
301
302
303
304
305
	    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)

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

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

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

320
        debugTraceMsg dflags 3 (text "link: done")
321
322
323
324
325

	-- staticLink only returns if it succeeds
        return Succeeded

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

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

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

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


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

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

421
422
423
424
425
426
  -- 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.
427

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

433
434
  -- 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)
435
  let get_output_fn = getOutputFilename stop_phase output basename
436

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

442
  -- Sometimes, a compilation phase doesn't actually generate any output
443
444
  -- (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
445
446
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
447
448
449
450
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
451
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
452
453
454
455
	   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
456
	   return (dflags', final_fn)
457

458
459


460
pipeLoop :: DynFlags -> Phase -> Phase 
461
	 -> FilePath  -> String -> Suffix
462
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
463
464
	 -> 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
getOutputFilename
489
490
491
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
492
493
 = func
 where
494
	func dflags next_phase maybe_location
495
496
497
498
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
499
	   where
500
501
502
503
504
505
506
507
508
509
510
		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

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
	 -> DynFlags
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
553
	 -> (DynFlags -> 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 dflags (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 dflags (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 dflags (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
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
Simon Marlow's avatar
Simon Marlow committed
643
			          ; return (Nothing, mkModuleName m) }
644
645

		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
681
682
683
		      = 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.
684
  --
685
  -- Setting source_unchanged to True means that M.o seems
686
687
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
688
  -- Setting source_unchanged to False tells the compiler that M.o is out of
689
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Simon Marlow's avatar
Simon Marlow committed
690
691
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)

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

708
  -- get the DynFlags
709
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
710
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
711
	output_fn  <- get_output_fn dflags next_phase (Just location4)
712

713
        let dflags' = dflags { hscTarget = hsc_lang,
714
715
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
716

717
	hsc_env <- newHscEnv dflags'
718

719
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
	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 }
736

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

743
744
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
745
          Just HscNoRecomp
746
747
748
749
750
              -> 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)
751
          Just (HscRecomp hasStub)
752
              -> do when hasStub $
Simon Marlow's avatar
Simon Marlow committed
753
                         do stub_o <- compileStub dflags' mod location4
754
755
756
757
758
759
                            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)
760

761
762
763
-----------------------------------------------------------------------------
-- Cmm phase

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

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

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

780
	ok <- hscCmmFile dflags' input_fn
781
782
783

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

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

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

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

797
       	let cmdline_include_paths = includePaths dflags
798

799
800
801
802
803
804
	-- 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 :)
805
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
806
807
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
808

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

812
        let verb = getVerbFlag dflags
813

814
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
815

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

820
	let excessPrecision = dopt Opt_ExcessPrecision dflags
821

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

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

833
834
	let
	  more_hcc_opts =
835
#if i386_TARGET_ARCH
836
837
838
839
840
841
842
843
844
845
846
847
848
849
	   	-- 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"]



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.
855
856
			[ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
                                                then SysTools.Option "c++" else SysTools.Option "c"] ++
857
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
858
			, SysTools.Option "-o"
sof's avatar
sof committed
859
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
860
861
862
			]
		       ++ map SysTools.Option (
		          md_c_flags
863
                       ++ pic_c_flags
864
865
866
867
868
869
870
871
872
#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
873
		       ++ (if hcc && mangle
874
875
		  	     then md_regd_c_flags
		  	     else [])
876
877
878
		       ++ (if hcc 
			     then more_hcc_opts
			     else [])
Simon Marlow's avatar
Simon Marlow committed
879
		       ++ [ verb, "-S", "-Wimplicit", cc_opt ]
880
881
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
882
		       ++ split_opt
883
884
		       ++ include_paths
		       ++ pkg_extra_cc_opts
885
886
887
888
#ifdef HAVE_GCC_HAS_WRAPV
                  -- We need consistent integer overflow (trac #952)
               ++ ["-fwrapv"]
#endif
sof's avatar
sof committed
889
		       ))
890

891
	return (next_phase, dflags, maybe_loc, output_fn)
892
893
894
895
896
897

	-- ToDo: postprocess the output from gcc

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

898
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
899
   = do let mangler_opts = getOpts dflags opt_m
900
901
902
903
904
905

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

907
908
	let split = dopt Opt_SplitObjs dflags
            next_phase
909
910
		| split = SplitMangle
		| otherwise = As
911
	output_fn <- get_output_fn dflags next_phase maybe_loc
912

913
	SysTools.runMangle dflags (map SysTools.Option mangler_opts
sof's avatar
sof committed
914
915
		          ++ [ SysTools.FileOption "" input_fn
			     , SysTools.FileOption "" output_fn
sof's avatar
sof committed
916
917
			     ]
			  ++ map SysTools.Option machdep_opts)
918

919
	return (next_phase, dflags, maybe_loc, output_fn)
920
921
922
923

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

924
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
925
926
  = 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)
927
	split_s_prefix <- SysTools.newTempName dflags "split"
928
	let n_files_fn = split_s_prefix
929

930
931
	SysTools.runSplit dflags
			  [ SysTools.FileOption "" input_fn
sof's avatar
sof committed
932
933
			  , SysTools.FileOption "" split_s_prefix
			  , SysTools.FileOption "" n_files_fn
sof's avatar
sof committed
934
			  ]
935
936
937
938
939
940
941
942
943

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

945
	return (SplitAs, dflags, maybe_loc, "**splitmangle**")
946
	  -- we don't use the filename
947
948
949
950

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

951
runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
952
  = do	let as_opts =  getOpts dflags opt_a
953
        let cmdline_include_paths = includePaths dflags