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

module DriverPipeline (
10 11 12
	-- Run a series of compilation steps in a pipeline, for a
	-- collection of source files.
   oneShot,
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
   getOptionsFromStringBuffer, -- used in module GHC
26 27 28 29
  ) where

#include "HsVersions.h"

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

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

58 59
import Directory
import System
60 61 62 63
import IO
import Monad
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
preprocess :: DynFlags -> FilePath -> IO (DynFlags, FilePath)
75
preprocess dflags filename =
76
  ASSERT2(isHaskellSrcFilename filename, text filename) 
77
  runPipeline anyHsc dflags filename 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 96 97
        -> IO CompResult

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

102
   | CompErrs 
103 104


105
compile hsc_env mod_summary maybe_old_linkable old_iface = do 
106

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

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

115
   showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
116

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

121
   debugTraceMsg dflags0 2 ("compile: input file " ++ input_fnpp)
122

123 124 125
   -- Add in the OPTIONS from the source file
   -- This is nasty: we've done this once already, in the compilation manager
   -- It might be better to cache the flags in the ml_hspp_file field,say
126 127
   let hspp_buf = expectJust "compile:hspp_buf" (ms_hspp_buf mod_summary)
       opts = getOptionsFromStringBuffer hspp_buf
128
   (dflags1,unhandled_flags) <- parseDynamicFlags dflags0 opts
129
   checkProcessArgsResult unhandled_flags input_fn
130

131
   let (basename, _) = splitFilename input_fn
132

133 134 135 136
  -- 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
137 138
       old_paths   = includePaths dflags1
       dflags      = dflags1 { includePaths = current_dir : old_paths }
139

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

148
   let dflags' = dflags { hscTarget = hsc_lang,
149
				hscOutName = output_fn,
150 151 152 153 154
				hscStubCOutName = basename ++ "_stub.c",
				hscStubHOutName = basename ++ "_stub.h",
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
155
   let do_recomp = dopt Opt_RecompChecking dflags
156
       source_unchanged = isJust maybe_old_linkable && do_recomp
157
       hsc_env' = hsc_env { hsc_dflags = dflags' }
158 159

   -- run the compiler
160
   hsc_result <- hscMain hsc_env' printErrorsAndWarnings mod_summary
161
			 source_unchanged have_object old_iface
162 163

   case hsc_result of
164
      HscFail -> return CompErrs
165

166 167 168
      HscNoRecomp details iface -> 
	  ASSERT(isJust maybe_old_linkable)
	  return (CompOK details iface maybe_old_linkable)
169

170
      HscRecomp details iface
171 172 173
		stub_h_exists stub_c_exists maybe_interpreted_code 

	| isHsBoot src_flavour	-- No further compilation to do
174
	-> return (CompOK details iface Nothing)
175 176 177

	| otherwise		-- Normal Haskell source files
	-> do
178
	   maybe_stub_o <- compileStub dflags' stub_c_exists
179 180 181 182 183 184 185 186 187 188 189 190
	   let stub_unlinked = case maybe_stub_o of
				  Nothing -> []
				  Just stub_o -> [ DotO stub_o ]

	   (hs_unlinked, unlinked_time) <-
	     case hsc_lang of

		-- in interpreted mode, just return the compiled code
		-- as our "unlinked" object.
		HscInterpreted -> 
		    case maybe_interpreted_code of
#ifdef GHCI
191
		       Just comp_bc -> return ([BCOs comp_bc], ms_hs_date mod_summary)
192 193 194 195 196 197
			-- 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.
198 199 200 201
#endif
		       Nothing -> panic "compile: no interpreted code"

		-- we're in batch mode: finish the compilation pipeline.
202 203 204
		_other -> do
		   let object_filename = ml_obj_file location

205 206
		   runPipeline StopLn dflags output_fn Persistent
			       (Just location)
207
			-- the object filename comes from the ModLocation
208 209 210

		   o_time <- getModificationTime object_filename
		   return ([DotO object_filename], o_time)
211

212
	   let linkable = LM unlinked_time this_mod
213 214
			     (hs_unlinked ++ stub_unlinked)

215
	   return (CompOK details iface (Just linkable))
216

217
-----------------------------------------------------------------------------
218 219 220 221 222 223 224
-- stub .h and .c files (for foreign export support)

compileStub dflags stub_c_exists
  | not stub_c_exists = return Nothing
  | stub_c_exists = do
	-- compile the _stub.c file w/ gcc
	let stub_c = hscStubCOutName dflags
225
	(_, stub_o) <- runPipeline StopLn dflags
226
			    stub_c Persistent Nothing{-no ModLocation-}
227 228 229
	return (Just stub_o)


230 231
-- ---------------------------------------------------------------------------
-- Link
232

233
link :: GhcMode			-- interactive or batch
234 235
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
236
     -> HomePackageTable	-- what to link
237 238 239 240 241 242 243 244 245 246
     -> 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
247 248
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
249 250 251
	 return Succeeded
#endif

252 253 254
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

255
link BatchCompile dflags batch_attempt_linking hpt
256
   | batch_attempt_linking
257
   = do 
258 259 260 261 262 263 264
	let 
	    home_mod_infos = moduleEnvElts hpt

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

	    -- the linkables to link
265
	    linkables = map (fromJust.hm_linkable) home_mod_infos
266

267 268
        debugTraceMsg dflags 3 "link: linkables are ..."
        debugTraceMsg dflags 3 (showSDoc (vcat (map ppr linkables)))
269

270
	-- check for the -no-link flag
271
	if isNoLink (ghcLink dflags)
272
	  then do debugTraceMsg dflags 3 "link(batch): linking omitted (-c flag given)."
273 274 275
	          return Succeeded
	  else do

276
	debugTraceMsg dflags 1 "Linking ..."
277

278 279 280
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

281
	-- Don't showPass in Batch mode; doLink will do that for us.
282
        staticLink dflags obj_files pkg_deps
283

284
        debugTraceMsg dflags 3 "link: done"
285 286 287 288 289

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
290 291
   = do debugTraceMsg dflags 3 "link(batch): upsweep (partially) failed OR"
        debugTraceMsg dflags 3 "   Main.main not exported; not linking."
292
        return Succeeded
293
      
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

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

oneShot :: DynFlags -> Phase -> [String] -> IO ()
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

compileFile :: DynFlags -> Phase -> FilePath -> IO FilePath
compileFile dflags stop_phase src = do
   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
			  src output Nothing{-no ModLocation-}
   return out_file


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

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


350 351
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
352

353 354 355 356
-- 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.

357
-- The DynFlags can be modified by phases in the pipeline (eg. by
358 359 360 361 362 363 364 365 366 367 368 369 370
-- 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.
371

372
runPipeline
373 374 375
  :: Phase		-- When to stop
  -> DynFlags		-- Dynamic flags
  -> FilePath 		-- Input filename
376 377
  -> PipelineOutput	-- Output filename
  -> Maybe ModLocation  -- A ModLocation, if this is a Haskell module
378
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
379

380
runPipeline stop_phase dflags input_fn output maybe_loc
381 382 383
  = do
  let (basename, suffix) = splitFilename input_fn
      start_phase = startPhase suffix
384

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

392 393
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
394 395
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
396

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

401
  -- Execute the pipeline...
402 403 404
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
405

406
  -- Sometimes, a compilation phase doesn't actually generate any output
407 408 409
  -- (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.
410 411 412 413 414 415 416
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
	do final_fn <- get_output_fn stop_phase maybe_loc
	   when (final_fn /= output_fn) $
		  copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
417
			++ "'") output_fn final_fn
418 419
	   return (dflags', final_fn)
	        
420 421


422
pipeLoop :: DynFlags -> Phase -> Phase 
423 424 425 426
	 -> FilePath  -> String -> Suffix
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
427

428
pipeLoop dflags phase stop_phase 
429 430
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
431

432 433
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
434

435
  | not (phase `happensBefore` stop_phase)
436 437 438 439
	-- 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 #-}.
440 441 442 443 444
  = 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)
445
		<- runPhase phase stop_phase dflags orig_basename 
446
			    orig_suff input_fn orig_get_output_fn maybe_loc
447
	; pipeLoop dflags' next_phase stop_phase output_fn
448 449
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

450 451 452 453
getOutputFilename
  :: DynFlags -> Phase -> PipelineOutput -> String
  -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename dflags stop_phase output basename
454 455 456 457 458 459 460 461 462
 = func
 where
	hcsuf      = hcSuf dflags
	odir       = outputDir dflags
	osuf       = objectSuf dflags
	keep_hc    = dopt Opt_KeepHcFiles dflags
	keep_raw_s = dopt Opt_KeepRawSFiles dflags
	keep_s     = dopt Opt_KeepSFiles dflags

463 464 465
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
466

467
	func next_phase maybe_location
468 469 470 471
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
472
	   where
473
		is_last_phase = next_phase `eqPhase` stop_phase
474 475 476 477

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
478
     			     StopLn              -> True
479 480 481 482 483
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

484
		suffix = myPhaseInputExt next_phase
485 486 487

		-- persistent object files get put in odir
	        persistent_fn 
488 489
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
490

491
		persistent = basename ++ '.':suffix
492

493
		odir_persistent
494
		   | Just loc <- maybe_location = ml_obj_file loc
495 496 497
		   | Just d <- odir = replaceFilenameDirectory persistent d
		   | otherwise      = persistent

498

499 500 501 502 503 504 505 506 507 508
-- -----------------------------------------------------------------------------
-- 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.

509 510
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
511 512 513 514 515
	 -> DynFlags
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
516
			-- how to calculate the output filename
517
	 -> Maybe ModLocation		-- the ModLocation, if we have one
518
	 -> IO (Phase,	  		-- next phase
519 520 521
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
522

523 524 525 526
	-- 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 

527 528 529
-------------------------------------------------------------------------------
-- Unlit phase 

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

535 536
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
537 538
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
539 540
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
541
			  ])
542

543
       return (Cpp sf, dflags, maybe_loc, output_fn)
544 545

-------------------------------------------------------------------------------
546 547
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
548

549
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
550
  = do src_opts <- getOptionsFromSource input_fn
551
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
552
       checkProcessArgsResult unhandled_flags (basename++'.':suff)
553

554
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
555 556
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
557
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
558
	else do
559
	    output_fn <- get_output_fn (HsPp sf) maybe_loc
560
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
561
	    return (HsPp sf, dflags, maybe_loc, output_fn)
562

sof's avatar
sof committed
563 564 565
-------------------------------------------------------------------------------
-- HsPp phase 

566
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
567
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
568 569
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
570
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
571
	else do
572
	    let hspp_opts = getOpts dflags opt_F
573
	    let orig_fn = basename ++ '.':suff
574
	    output_fn <- get_output_fn (Hsc sf) maybe_loc
575 576
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
577 578 579 580 581
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
582
	    return (Hsc sf, dflags, maybe_loc, output_fn)
583

584 585 586
-----------------------------------------------------------------------------
-- Hsc phase

587 588
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
589
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
590
 = do	-- normal Hsc mode, not mkdependHS
591

592 593 594
  -- 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.
595
	let current_dir = directoryOf basename
596
	
597 598
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
599
	
600
  -- gather the imports and module name
601
        (hspp_buf,mod_name) <- 
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
			          ; return (Nothing, mkModule m) }

		other -> do { buf <- hGetStringBuffer input_fn
			    ; (_,_,mod_name) <- getImports dflags buf input_fn
			    ; 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)
617
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
618 619 620 621 622 623 624 625 626

  -- 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
627 628
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
629 630 631 632 633 634 635
		      | 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
636 637 638
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
639 640 641 642 643 644 645 646 647 648 649 650 651 652
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

  -- Make the ModSummary to hand to hscMain
	src_timestamp <- getModificationTime (basename ++ '.':suff)
	let
	    unused_field = panic "runPhase:ModSummary field"
		-- Some fields are not looked at by hscMain
	    mod_summary = ModSummary {	ms_mod 	     = mod_name, 
					ms_hsc_src   = src_flavour,
				 	ms_hspp_file = Just input_fn,
					ms_hspp_buf  = hspp_buf,
					ms_location  = location4,
					ms_hs_date   = src_timestamp,
sof's avatar
sof committed
653
					ms_obj_date  = Nothing,
654 655 656 657 658 659 660
					ms_imps	     = unused_field,
					ms_srcimps   = unused_field }

	    o_file = ml_obj_file location4 	-- The real object file


  -- Figure out if the source has changed, for recompilation avoidance.
661
  --
662
  -- Setting source_unchanged to True means that M.o seems
663 664
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
665
  -- Setting source_unchanged to False tells the compiler that M.o is out of
666
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
667
	let do_recomp = dopt Opt_RecompChecking dflags
668
	source_unchanged <- 
669
          if not do_recomp || not (isStopLn stop)
670 671
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
672
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
673 674
	     then return False	
		-- Otherwise look at file modification dates
675
	     else do o_file_exists <- doesFileExist o_file
676
		     if not o_file_exists
677
		        then return False	-- Need to recompile
678
			else do t2 <- getModificationTime o_file
679
			        if t2 > src_timestamp
680 681
				  then return True
				  else return False
682

683
  -- get the DynFlags
684 685
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
686
	output_fn  <- get_output_fn next_phase (Just location4)
687

688
        let dflags' = dflags { hscTarget = hsc_lang,
689 690 691 692
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
693

694
	hsc_env <- newHscEnv dflags'
695

696 697 698
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

699
  -- run the compiler!
700 701 702 703
	result <- hscMain hsc_env printErrorsAndWarnings
			  mod_summary source_unchanged 
			  False		-- No object file
			  Nothing	-- No iface
704

705
	case result of
706

707
	    HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
708

709
            HscNoRecomp details iface -> do
710
		SysTools.touch dflags' "Touching object file" o_file
711
		return (StopLn, dflags', Just location4, o_file)
712

713
	    HscRecomp _details _iface 
714
		      stub_h_exists stub_c_exists
715
		      _maybe_interpreted_code -> do
716

717
		-- Deal with stubs 
718
		maybe_stub_o <- compileStub dflags' stub_c_exists
719
		case maybe_stub_o of
720
		      Nothing     -> return ()
721
		      Just stub_o -> consIORef v_Ld_inputs stub_o
722 723 724 725 726 727 728 729

		-- In the case of hs-boot files, generate a dummy .o-boot 
		-- stamp file for the benefit of Make
		case src_flavour of
		  HsBootFile -> SysTools.touch dflags' "Touching object file" o_file
		  other	     -> return ()

		return (next_phase, dflags', Just location4, output_fn)
730

731 732 733
-----------------------------------------------------------------------------
-- Cmm phase

734
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
735 736
  = do
       output_fn <- get_output_fn Cmm maybe_loc
737
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
738
       return (Cmm, dflags, maybe_loc, output_fn)
739

740
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
741
  = do
742 743
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
744 745
	output_fn <- get_output_fn next_phase maybe_loc

746
        let dflags' = dflags { hscTarget = hsc_lang,
747 748 749 750
			       hscOutName = output_fn,
		   	       hscStubCOutName = basename ++ "_stub.c",
			       hscStubHOutName = basename ++ "_stub.h",
			       extCoreName = basename ++ ".hcr" }
751

752
	ok <- hscCmmFile dflags' input_fn
753 754 755

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

756
	return (next_phase, dflags, maybe_loc, output_fn)
757

758 759 760 761 762 763
-----------------------------------------------------------------------------
-- 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.

764
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
765
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
766
   = do	let cc_opts = getOpts dflags opt_c
767
	    hcc = cc_phase `eqPhase` HCc
768

769
       	let cmdline_include_paths = includePaths dflags
770

771 772 773 774 775 776
	-- 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 :)
777
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
778 779
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
780

781 782
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
783

784
        let verb = getVerbFlag dflags
785

786
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
787

788 789
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
790
		      | otherwise         = [ ]
791

792
	let excessPrecision = dopt Opt_ExcessPrecision dflags
793

794
	-- Decide next phase
795 796 797
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
798 799 800 801
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

802 803
	-- force the C compiler to interpret this file as C when
	-- compiling .hc files, by adding the -x c option.
804 805
	let langopt | hcc = [ SysTools.Option "-x", SysTools.Option "c"]
		    | otherwise = [ ]
806

807
	SysTools.runCc dflags (langopt ++
808
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
809
			, SysTools.Option "-o"
sof's avatar
sof committed
810
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
811 812 813
			]
		       ++ map SysTools.Option (
		          md_c_flags
814
                       ++ pic_c_flags
815
		       ++ (if hcc && mangle
816 817
		  	     then md_regd_c_flags
		  	     else [])
818
		       ++ [ verb, "-S", "-Wimplicit", "-O" ]
819 820
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
821
		       ++ split_opt
822 823 824
		       ++ (if excessPrecision then [] else [ "-ffloat-store" ])
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
825
		       ))
826

827
	return (next_phase, dflags, maybe_loc, output_fn)
828 829 830 831 832 833

	-- ToDo: postprocess the output from gcc

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

834
runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
835
   = do let mangler_opts = getOpts dflags opt_m
836 837 838 839 840 841

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