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 HscMain
34
import Finder
35 36 37
import HscTypes
import Outputable
import Module
Simon Marlow's avatar
Simon Marlow committed
38
import UniqFM		( eltsUFM )
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

Simon Marlow's avatar
Simon Marlow committed
52 53 54 55 56 57 58
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
59
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
60 61 62
import Data.Maybe
import System.Exit
import System.Environment
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
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
76 77
  runPipeline anyHsc dflags (filename, mb_phase) 
        Nothing Temporary Nothing{-no ModLocation-}
78

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

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

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

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

103
   | CompErrs 
104 105


106
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
107

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

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

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

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

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

125
   let (basename, _) = splitFilename input_fn
126

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

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

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

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

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

157
       handleBatch (HscNoRecomp, iface, details)
158 159
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
160
       handleBatch (HscRecomp hasStub, iface, details)
161 162 163 164 165 166 167 168 169 170
           | 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
171 172 173
                            -> do runPipeline StopLn dflags (output_fn,Nothing)
                                              (Just basename)
                                              Persistent
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
                                              (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
201
                                     source_unchanged old_iface
202 203 204 205
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
206
   -- run the compiler
207 208 209 210
   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
211 212
     HscNothing
         -> runCompiler hscCompileNothing handleBatch
213
     _other
214
         -> runCompiler hscCompileBatch handleBatch
215

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

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

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

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

	return stub_o
246 247


248 249
-- ---------------------------------------------------------------------------
-- Link
250

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

270
link NoLink dflags batch_attempt_linking hpt
271 272
   = return Succeeded

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

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

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

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

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

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

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

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

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

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

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

	-- staticLink only returns if it succeeds
        return Succeeded

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

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

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

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


386 387
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
388

389 390 391 392
-- 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.

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

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

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

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

426 427 428 429 430 431
  -- 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.
432

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

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

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

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

463 464


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

471
pipeLoop dflags phase stop_phase 
472 473
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
474

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

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

493
getOutputFilename
494 495 496
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
497 498
 = func
 where
499
	func dflags next_phase maybe_location
500 501 502 503
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
504
	   where
505 506 507 508 509 510 511 512 513 514 515
		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

516
		is_last_phase = next_phase `eqPhase` stop_phase
517 518 519 520

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

527
		suffix = myPhaseInputExt next_phase
528 529 530

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

534
		persistent = basename `joinFileExt` suffix
535

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

541

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

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

566 567 568 569
	-- 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 

570 571 572
-------------------------------------------------------------------------------
-- Unlit phase 

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

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

586
       return (Cpp sf, dflags, maybe_loc, output_fn)
587 588

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

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

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

sof's avatar
sof committed
606 607 608
-------------------------------------------------------------------------------
-- HsPp phase 

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

627 628 629
-----------------------------------------------------------------------------
-- Hsc phase

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

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

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

  -- 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
670 671
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
672 673 674 675 676 677 678
		      | 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
679 680 681
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
682 683 684 685 686 687 688
		      = 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.
689
  --
690
  -- Setting source_unchanged to True means that M.o seems
691 692
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
693
  -- Setting source_unchanged to False tells the compiler that M.o is out of
694
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Simon Marlow's avatar
Simon Marlow committed
695 696
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)

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

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

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

722
	hsc_env <- newHscEnv dflags'
723

724
  -- Tell the finder cache about this module
Simon Marlow's avatar
Simon Marlow committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
	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 }
741

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

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

766 767 768
-----------------------------------------------------------------------------
-- Cmm phase

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

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

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

785
	ok <- hscCmmFile dflags' input_fn
786 787 788

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

789
	return (next_phase, dflags, maybe_loc, output_fn)
790

791 792 793 794 795 796
-----------------------------------------------------------------------------
-- 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.

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

802
       	let cmdline_include_paths = includePaths dflags
803

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

814 815
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
816

817
        let verb = getVerbFlag dflags
818

819
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
820

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

825
	let excessPrecision = dopt Opt_ExcessPrecision dflags
826

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

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

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



855 856 857 858 859
	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.
860 861
			[ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
                                                then SysTools.Option "c++" else SysTools.Option "c"] ++
862