DriverPipeline.hs 53.6 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
   getOptionsFromStringBuffer,	-- used in module GHC
   optionsErrorMsgs,	  	-- ditto
27
28
29
30
  ) where

#include "HsVersions.h"

31
import Packages
32
import GetImports
33
import DriverPhases
sof's avatar
sof committed
34
import SysTools		( newTempName, addFilesToClean, getSysMan, copy )
35
import qualified SysTools	
36
import HscMain
37
import Finder
38
39
40
import HscTypes
import Outputable
import Module
41
import ErrUtils
42
43
import DynFlags
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
44
import Config
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
55
import SrcLoc		( srcLocSpan, mkSrcLoc )
import FastString	( mkFastString )
import Bag		( listToBag, emptyBag )
56
import SrcLoc		( Located(..) )
57

58
59
import Distribution.Compiler ( extensionsToGHCFlag )

60
import EXCEPTION
61
import DATA_IOREF	( readIORef, writeIORef, IORef )
62
import GLAEXTS		( Int(..) )
63

64
65
import Directory
import System
66
67
import IO
import Monad
68
import Data.List	( isSuffixOf )
69
70
import Maybe

71

72
73
-- ---------------------------------------------------------------------------
-- Pre-process
74
75
76

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

81
82
83
84
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-}
85

86
87
-- ---------------------------------------------------------------------------
-- Compile
88
89
90
91
92
93
94
95
96
97

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

98
compile :: HscEnv
99
	-> ModSummary
100
	-> Maybe Linkable	-- Just linkable <=> source unchanged
101
        -> Maybe ModIface       -- Old interface, if available
102
        -> Int -> Int
103
104
105
        -> IO CompResult

data CompResult
106
107
108
   = CompOK   ModDetails 	-- New details
              ModIface		-- New iface
              (Maybe Linkable)	-- a Maybe, for the same reasons as hm_linkable
109

110
   | CompErrs 
111
112


113
compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do 
114

115
   let dflags0     = hsc_dflags hsc_env
116
117
       this_mod    = ms_mod mod_summary
       src_flavour = ms_hsc_src mod_summary
118

119
120
121
122
       have_object 
	       | Just l <- maybe_old_linkable, isObjectLinkable l = True
	       | otherwise = False

123
   showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
124

125
   let location	  = ms_location mod_summary
126
   let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
127
   let input_fnpp = expectJust "compile:hspp" (ms_hspp_file mod_summary)
128

129
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
130

131
132
133
   -- 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
134
   let hspp_buf = expectJust "compile:hspp_buf" (ms_hspp_buf mod_summary)
135
       opts = getOptionsFromStringBuffer hspp_buf input_fn
136
137
   (dflags1,unhandled_flags) <- parseDynamicFlags dflags0 (map snd opts)
   if (not (null unhandled_flags))
138
	then do printErrorsAndWarnings dflags1 (optionsErrorMsgs unhandled_flags opts input_fn)
139
140
		return CompErrs
	else do
141

142
   let (basename, _) = splitFilename input_fn
143

144
145
146
147
  -- 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
148
149
       old_paths   = includePaths dflags1
       dflags      = dflags1 { includePaths = current_dir : old_paths }
150

151
   -- Figure out what lang we're generating
152
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
153
   -- ... and what the next phase should be
154
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
155
   -- ... and what file to generate the output into
156
157
   output_fn <- getOutputFilename dflags next_phase 
			Temporary basename next_phase (Just location)
158

159
   let dflags' = dflags { hscTarget = hsc_lang,
160
				hscOutName = output_fn,
161
162
163
				extCoreName = basename ++ ".hcr" }

   -- -no-recomp should also work with --make
164
   let do_recomp = dopt Opt_RecompChecking dflags
165
       source_unchanged = isJust maybe_old_linkable && do_recomp
166
       hsc_env' = hsc_env { hsc_dflags = dflags' }
167
       object_filename = ml_obj_file location
168

169
170
171
172
173
   let getStubLinkable False = return []
       getStubLinkable True
           = do stub_o <- compileStub dflags' this_mod location
                return [ DotO stub_o ]

174
       handleMake (HscNoRecomp, iface, details)
175
176
           = ASSERT (isJust maybe_old_linkable)
             return (CompOK details iface maybe_old_linkable)
177
       handleMake (HscRecomp hasStub, iface, details)
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
           | 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
216
                                     source_unchanged old_iface
217
218
219
220
                                     (Just (mod_index, nmods))
                case mbResult of
                  Nothing     -> return CompErrs
                  Just result -> handle result
221
   -- run the compiler
222
223
224
225
226
227
   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
     _other
         -> runCompiler hscCompileMake handleMake
228

229
-----------------------------------------------------------------------------
230
231
-- stub .h and .c files (for foreign export support)

232
233
234
-- The _stub.c file is derived from the haskell source file, possibly taking
-- into account the -stubdir option.
--
235
236
237
238
239
240
241
242
243
244
245
246
247
-- 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.

248
249
250
compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
compileStub dflags mod location = do
	let (o_base, o_ext) = splitFilename (ml_obj_file location)
251
252
	    stub_o = o_base ++ "_stub" `joinFileExt` o_ext

253
	-- compile the _stub.c file w/ gcc
254
	let (stub_c,_) = mkStubPaths dflags mod location
255
256
257
258
	runPipeline StopLn dflags (stub_c,Nothing) 
		(SpecificFile stub_o) Nothing{-no ModLocation-}

	return stub_o
259
260


261
262
-- ---------------------------------------------------------------------------
-- Link
263

264
link :: GhcMode			-- interactive or batch
265
266
     -> DynFlags		-- dynamic flags
     -> Bool			-- attempt linking in batch mode?
267
     -> HomePackageTable	-- what to link
268
269
270
271
272
273
274
275
276
277
     -> 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
278
279
link Interactive dflags batch_attempt_linking hpt
    = do -- Not Linking...(demand linker will do the job)
280
281
282
	 return Succeeded
#endif

283
284
285
link JustTypecheck dflags batch_attempt_linking hpt
   = return Succeeded

286
link BatchCompile dflags batch_attempt_linking hpt
287
   | batch_attempt_linking
288
   = do 
289
290
291
292
293
294
295
	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
296
	    linkables = map (expectJust "link".hm_linkable) home_mod_infos
297

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

300
	-- check for the -no-link flag
301
	if isNoLink (ghcLink dflags)
302
	  then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
303
304
305
	          return Succeeded
	  else do

306
307
308
	let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
	    obj_files = concatMap getOfiles linkables

309
310
311
312
313
314
315
316
317
318
319
320
	    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
321
	   then do debugTraceMsg dflags 1 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
322
323
324
		   return Succeeded
	   else do

325
326
	debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
				 <+> text "...")
327

328
	-- Don't showPass in Batch mode; doLink will do that for us.
329
330
331
332
	let link = case ghcLink dflags of
	        MkDLL       -> doMkDLL
	        StaticLink  -> staticLink
	link dflags obj_files pkg_deps
333

334
        debugTraceMsg dflags 3 (text "link: done")
335
336
337
338
339

	-- staticLink only returns if it succeeds
        return Succeeded

   | otherwise
340
341
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
342
        return Succeeded
343
      
344
345
346
347

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

348
oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
349
350
351
352
oneShot dflags stop_phase srcs = do
  o_files <- mapM (compileFile dflags stop_phase) srcs
  doLink dflags stop_phase o_files

353
354
compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile dflags stop_phase (src, mb_phase) = do
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
   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
378
			  (src, mb_phase) output Nothing{-no ModLocation-}
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
   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 = []


400
401
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
402

403
404
405
406
-- 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.

407
-- The DynFlags can be modified by phases in the pipeline (eg. by
408
409
410
411
412
413
414
415
416
417
418
419
420
-- 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.
421

422
runPipeline
423
424
425
426
427
  :: 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
428
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
429

430
runPipeline stop_phase dflags (input_fn, mb_phase) output maybe_loc
431
432
  = do
  let (basename, suffix) = splitFilename input_fn
433
434
435
436
437

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

439
440
441
442
443
444
  -- 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.
445

446
447
  when (not (start_phase `happensBefore` stop_phase)) $
	throwDyn (UsageError 
448
449
		    ("cannot compile this file to desired target: "
		       ++ input_fn))
450

451
452
453
  -- 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
454

455
  -- Execute the pipeline...
456
457
458
  (dflags', output_fn, maybe_loc) <- 
	pipeLoop dflags start_phase stop_phase input_fn 
	  	 basename suffix get_output_fn maybe_loc
459

460
  -- Sometimes, a compilation phase doesn't actually generate any output
461
462
463
  -- (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.
464
465
466
467
468
469
470
  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
471
			++ "'") output_fn final_fn
472
473
	   return (dflags', final_fn)
	        
474
475


476
pipeLoop :: DynFlags -> Phase -> Phase 
477
478
479
480
	 -> FilePath  -> String -> Suffix
	 -> (Phase -> Maybe ModLocation -> IO FilePath)
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
481

482
pipeLoop dflags phase stop_phase 
483
484
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
485

486
487
  | phase `eqPhase` stop_phase		  -- All done
  = return (dflags, input_fn, maybe_loc)
488

489
  | not (phase `happensBefore` stop_phase)
490
491
492
493
	-- 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 #-}.
494
495
496
497
498
  = 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)
499
		<- runPhase phase stop_phase dflags orig_basename 
500
			    orig_suff input_fn orig_get_output_fn maybe_loc
501
	; pipeLoop dflags' next_phase stop_phase output_fn
502
503
		   orig_basename orig_suff orig_get_output_fn maybe_loc }

504
505
506
507
getOutputFilename
  :: DynFlags -> Phase -> PipelineOutput -> String
  -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename dflags stop_phase output basename
508
509
510
 = func
 where
	hcsuf      = hcSuf dflags
511
	odir       = objectDir dflags
512
513
514
515
516
	osuf       = objectSuf dflags
	keep_hc    = dopt Opt_KeepHcFiles dflags
	keep_raw_s = dopt Opt_KeepRawSFiles dflags
	keep_s     = dopt Opt_KeepSFiles dflags

517
518
519
        myPhaseInputExt HCc    = hcsuf
        myPhaseInputExt StopLn = osuf
        myPhaseInputExt other  = phaseInputExt other
520

521
	func next_phase maybe_location
522
523
524
525
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
526
	   where
527
		is_last_phase = next_phase `eqPhase` stop_phase
528
529
530
531

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
532
     			     StopLn              -> True
533
534
535
536
537
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

538
		suffix = myPhaseInputExt next_phase
539
540
541

		-- persistent object files get put in odir
	        persistent_fn 
542
543
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
544

545
		persistent = basename `joinFileExt` suffix
546

547
		odir_persistent
548
		   | Just loc <- maybe_location = ml_obj_file loc
549
		   | Just d <- odir = d `joinFileName` persistent
550
551
		   | otherwise      = persistent

552

553
554
555
556
557
558
559
560
561
562
-- -----------------------------------------------------------------------------
-- 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.

563
564
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
565
566
567
568
569
	 -> 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)
570
			-- how to calculate the output filename
571
	 -> Maybe ModLocation		-- the ModLocation, if we have one
572
	 -> IO (Phase,	  		-- next phase
573
574
575
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
576

577
578
579
580
	-- 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 

581
582
583
-------------------------------------------------------------------------------
-- Unlit phase 

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

589
590
       SysTools.runUnlit dflags 
		(map SysTools.Option unlit_flags ++
sof's avatar
sof committed
591
592
       			  [ SysTools.Option     "-h"
 			  , SysTools.Option     input_fn
sof's avatar
sof committed
593
594
			  , SysTools.FileOption "" input_fn
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
595
			  ])
596

597
       return (Cpp sf, dflags, maybe_loc, output_fn)
598
599

-------------------------------------------------------------------------------
600
601
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
602

603
runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
604
  = do src_opts <- getOptionsFromSource input_fn
605
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
606
       checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
607

608
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
609
610
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
611
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
612
	else do
613
	    output_fn <- get_output_fn (HsPp sf) maybe_loc
614
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
615
	    return (HsPp sf, dflags, maybe_loc, output_fn)
616

sof's avatar
sof committed
617
618
619
-------------------------------------------------------------------------------
-- HsPp phase 

620
runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
621
  = do if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
622
623
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
624
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
625
	else do
626
	    let hspp_opts = getOpts dflags opt_F
627
	    let orig_fn = basename `joinFileExt` suff
628
	    output_fn <- get_output_fn (Hsc sf) maybe_loc
629
630
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
631
632
633
634
635
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
636
	    return (Hsc sf, dflags, maybe_loc, output_fn)
637

638
639
640
-----------------------------------------------------------------------------
-- Hsc phase

641
642
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
643
runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
644
 = do	-- normal Hsc mode, not mkdependHS
645

646
647
648
  -- 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.
649
	let current_dir = directoryOf basename
650
	
651
652
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
653
	
654
  -- gather the imports and module name
655
        (hspp_buf,mod_name) <- 
656
657
658
659
660
661
            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
662
			    ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
663
664
665
666
667
668
669
670
			    ; 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)
671
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
672
673
674
675
676
677
678
679
680

  -- 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
681
682
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
683
684
685
686
687
688
689
		      | 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
690
691
692
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
693
694
695
696
		      = location3 { ml_obj_file = ofile }
		      | otherwise = location3

  -- Make the ModSummary to hand to hscMain
697
	src_timestamp <- getModificationTime (basename `joinFileExt` suff)
698
699
700
701
702
703
704
705
706
	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
707
					ms_obj_date  = Nothing,
708
709
710
711
712
713
714
					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.
715
  --
716
  -- Setting source_unchanged to True means that M.o seems
717
718
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
719
  -- Setting source_unchanged to False tells the compiler that M.o is out of
720
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
721
	let do_recomp = dopt Opt_RecompChecking dflags
722
	source_unchanged <- 
723
          if not do_recomp || not (isStopLn stop)
724
725
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
726
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
727
728
	     then return False	
		-- Otherwise look at file modification dates
729
	     else do o_file_exists <- doesFileExist o_file
730
		     if not o_file_exists
731
		        then return False	-- Need to recompile
732
			else do t2 <- getModificationTime o_file
733
			        if t2 > src_timestamp
734
735
				  then return True
				  else return False
736

737
  -- get the DynFlags
738
739
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
740
	output_fn  <- get_output_fn next_phase (Just location4)
741

742
        let dflags' = dflags { hscTarget = hsc_lang,
743
744
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
745

746
	hsc_env <- newHscEnv dflags'
747

748
749
750
  -- Tell the finder cache about this module
	addHomeModuleToFinder hsc_env mod_name location4

751
  -- run the compiler!
752
	mbResult <- hscCompileOneShot hsc_env
753
754
			  mod_summary source_unchanged 
			  Nothing	-- No iface
755
                          Nothing       -- No "module i of n" progress info
756

757
758
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
759
          Just HscNoRecomp
760
761
762
763
764
              -> 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)
765
          Just (HscRecomp hasStub)
766
767
768
769
770
771
772
773
              -> do when hasStub $
                         do stub_o <- compileStub dflags' mod_name location4
                            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)
774

775
776
777
-----------------------------------------------------------------------------
-- Cmm phase

778
runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
779
780
  = do
       output_fn <- get_output_fn Cmm maybe_loc
781
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
782
       return (Cmm, dflags, maybe_loc, output_fn)
783

784
runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
785
  = do
786
787
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
788
789
	output_fn <- get_output_fn next_phase maybe_loc

790
        let dflags' = dflags { hscTarget = hsc_lang,
791
792
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
793

794
	ok <- hscCmmFile dflags' input_fn
795
796
797

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

798
	return (next_phase, dflags, maybe_loc, output_fn)
799

800
801
802
803
804
805
-----------------------------------------------------------------------------
-- 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.

806
runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
807
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
808
   = do	let cc_opts = getOpts dflags opt_c
809
	    hcc = cc_phase `eqPhase` HCc
810

811
       	let cmdline_include_paths = includePaths dflags
812

813
814
815
816
817
818
	-- 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 :)
819
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
820
821
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
822

823
824
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
        let pic_c_flags = picCCOpts dflags
825

826
        let verb = getVerbFlag dflags
827

828
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
829

830
831
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
832
		      | otherwise         = [ ]
833

834
	let excessPrecision = dopt Opt_ExcessPrecision dflags
835

Simon Marlow's avatar
Simon Marlow committed
836
837
838
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

839
	-- Decide next phase
840
841
842
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
843
844
845
846
		| hcc && mangle     = Mangle
		| otherwise         = As
	output_fn <- get_output_fn next_phase maybe_loc

847
848
	let
	  more_hcc_opts =
849
#if i386_TARGET_ARCH
850
851
852
853
854
855
856
857
858
859
860
861
862
863
	   	-- 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"]



864
865
866
867
868
869
	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"] ++
870
			[ SysTools.FileOption "" input_fn
sof's avatar
sof committed
871
			, SysTools.Option "-o"
sof's avatar
sof committed
872
			, SysTools.FileOption "" output_fn
sof's avatar
sof committed
873
874
875
			]
		       ++ map SysTools.Option (
		          md_c_flags
876
                       ++ pic_c_flags
877
		       ++ (if hcc && mangle
878
879
		  	     then md_regd_c_flags
		  	     else [])
880
881
882
		       ++ (if hcc 
			     then more_hcc_opts
			     else [])
Simon Marlow's avatar
Simon Marlow committed
883
		       ++ [ verb, "-S", "-Wimplicit", cc_opt ]
884
885
		       ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
		       ++ cc_opts
sof's avatar
sof committed
886
		       ++ split_opt
887
888
		       ++ include_paths
		       ++ pkg_extra_cc_opts
sof's avatar
sof committed
889
		       ))
890

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

	-- ToDo: postprocess the output from gcc

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

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

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

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

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

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

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

924
runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
925
926
  = do  -- tmp_pfx is the prefix used for the split .s files
	-- We also use it as the file to contain the no. of split .s files (sigh)
927
	split_s_prefix <- SysTools.newTempName dflags "split"
928
	let n_files_fn = split_s_prefix
929

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

	-- Save the number of split files for future references
	s <- readFile n_files_fn
	let n_files = read s :: Int
	writeIORef v_Split_info (split_s_prefix, n_files)

	-- Remember to delete all these files
	addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
			| n <- [1..n_files]]
944

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

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

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

955
	output_fn <- get_output_fn StopLn maybe_loc
956

957
958
959
960
	-- we create directories for the object file, because it
	-- might be a hierarchical module.
	createDirectoryHierarchy (directoryOf output_fn)

961
962
	SysTools.runAs dflags	
		       (map SysTools.Option as_opts
sof's avatar
sof committed
963
964
		       ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
		       ++ [ SysTools.Option "-c"
sof's avatar
sof committed
965
		          , SysTools.FileOption "" input_fn
sof's avatar
sof committed
966
			  , SysTools.Option "-o"
sof's avatar
sof committed
967
			  , SysTools.FileOption "" output_fn
sof's avatar
sof committed
968
			  ])
969

970
	return (StopLn, dflags, maybe_loc, output_fn)
971
972


973
runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
  = do  
	output_fn <- get_output_fn StopLn maybe_loc

	let (base_o, _) = splitFilename output_fn
	    split_odir  = base_o ++ "_split"
	    osuf = objectSuf dflags

	createDirectoryHierarchy split_odir

	-- remove M_split/ *.o, because we're going to archive M_split/ *.o
	-- later and we don't want to pick up any old objects.
	fs <- getDirectoryContents split_odir 
	mapM_ removeFile $ map (split_odir `joinFileName`)
			 $ filter (osuf `isSuffixOf`) fs

	let as_opts = getOpts dflags opt_a
990

991
	(split_s_prefix, n) <- readIORef v_Split_info
992

993
994
995
996
	let split_s   n = split_s_prefix ++ "__" ++ show n `joinFileExt` "s"
	    split_obj n = split_odir `joinFileName`
				filenameOf base_o ++ "__" ++ show n
					`joinFileExt` osuf
997

998
	let assemble_file n
999
1000
1001
1002
1003
1004
1005
	      = SysTools.runAs dflags
			 (map SysTools.Option as_opts ++
		   	 [ SysTools.Option "-c"
			 , SysTools.Option "-o"
			 , SysTools.FileOption "" (split_obj n)
			 , SysTools.FileOption "" (split_s n)
			 ])</