DriverPipeline.hs 49.9 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		( newTempName, addFilesToClean, copy )
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

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

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

64

65 66
-- ---------------------------------------------------------------------------
-- Pre-process
67 68 69

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

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) 
  runPipeline anyHsc dflags (filename, mb_phase) 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
   let do_recomp = dopt Opt_RecompChecking dflags
148
       source_unchanged = isJust maybe_old_linkable && do_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 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
           | 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
199
                                     source_unchanged old_iface
200 201 202 203
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
204
   -- run the compiler
205 206 207 208
   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
209 210
     HscNothing
         -> runCompiler hscCompileNothing handleBatch
211
     _other
212
         -> runCompiler hscCompileBatch handleBatch
213

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

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

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

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

	return stub_o
244 245


246 247
-- ---------------------------------------------------------------------------
-- Link
248

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

268 269 270
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

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

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

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

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

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

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

294 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)

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

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

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

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

	-- staticLink only returns if it succeeds
        return Succeeded

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

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

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

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


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

386 387 388 389
-- 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.

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

405
runPipeline
406 407 408 409 410
  :: 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
411
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
412

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

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

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

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

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

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

443
  -- Sometimes, a compilation phase doesn't actually generate any output
444 445 446
  -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
  -- stage, but we wanted to keep the output, then we have to explicitly
  -- copy the file.
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
	   when (final_fn /= output_fn) $
		  copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
454
			++ "'") output_fn final_fn
455 456
	   return (dflags', final_fn)
	        
457 458


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

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

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

472
  | not (phase `happensBefore` stop_phase)
473 474 475 476
	-- 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 #-}.
477 478 479 480 481
  = 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)
482
		<- runPhase phase stop_phase dflags orig_basename 
483
			    orig_suff input_fn orig_get_output_fn maybe_loc
484
	; pipeLoop dflags' next_phase stop_phase output_fn
485 486
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

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

510
		is_last_phase = next_phase `eqPhase` stop_phase
511 512 513 514

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

521
		suffix = myPhaseInputExt next_phase
522 523 524

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

528
		persistent = basename `joinFileExt` suffix
529

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

535

536 537 538 539 540 541 542 543 544 545
-- -----------------------------------------------------------------------------
-- 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.

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

560 561 562 563
	-- 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 

564 565 566
-------------------------------------------------------------------------------
-- Unlit phase 

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

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

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

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

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

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

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

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

621 622 623
-----------------------------------------------------------------------------
-- Hsc phase

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

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

		other -> do { buf <- hGetStringBuffer input_fn
645
			    ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
646 647 648 649 650 651 652 653
			    ; 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)
654
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
655 656 657 658 659 660 661 662 663

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

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

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

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

716
	hsc_env <- newHscEnv dflags'
717

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

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

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

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

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

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

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

779
	ok <- hscCmmFile dflags' input_fn
780 781 782

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

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

785 786 787 788 789 790
-----------------------------------------------------------------------------
-- Cc phase

-- we don't support preprocessing .c files (with -E) now.  Doing so introduces
-- way too many hacks, and I can't say I've ever used it anyway.

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

796
       	let cmdline_include_paths = includePaths dflags
797

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

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

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

811
        let verb = getVerbFlag dflags
812

813
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
814

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

819
	let excessPrecision = dopt Opt_ExcessPrecision dflags
820

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

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

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



849 850 851 852 853 854
	SysTools.runCc dflags (
		-- force the C compiler to interpret this file as C when
		-- compiling .hc files, by adding the -x c option.
		-- Also useful for plain .c files, just in case GHC saw a 
		-- -x c option.
			[ SysTools.Option "-x", SysTools.Option "c"] ++
855
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
856
			, SysTools.Option "-o"
sof's avatar
sof committed
857
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
858 859 860
			]
		       ++ map SysTools.Option (
		          md_c_flags
861
                       ++ pic_c_flags
862 863 864 865 866 867 868 869 870
#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
871
		       ++ (if hcc && mangle
872 873
		  	     then md_regd_c_flags
		  	     else [])
874 875 876