DriverPipeline.hs 61.1 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
   linkBinary,
16

17
18
	-- Interfaces for the compilation manager (interpreted/batch-mode)
   preprocess, 
19
   compile,
20
   link, 
21

22
23
24
25
  ) where

#include "HsVersions.h"

26
import Packages
27
import HeaderInfo
28
import DriverPhases
29
import SysTools
30
import HscMain
31
import Finder
32
33
34
import HscTypes
import Outputable
import Module
35
import LazyUniqFM		( eltsUFM )
36
import ErrUtils
37
import DynFlags
38
import StaticFlags	( v_Ld_inputs, opt_Static, WayName(..) )
39
import Config
40
import Panic
41
import Util
42
import StringBuffer	( hGetStringBuffer )
43
import BasicTypes	( SuccessFlag(..) )
44
import Maybes		( expectJust )
45
import ParserCoreUtils	( getCoreModuleName )
46
import SrcLoc		( unLoc )
47
import SrcLoc		( Located(..) )
48
import FastString
49

Simon Marlow's avatar
Simon Marlow committed
50
51
52
53
import Control.Exception as Exception
import Data.IORef	( readIORef, writeIORef, IORef )
import GHC.Exts		( Int(..) )
import System.Directory
Ian Lynagh's avatar
Ian Lynagh committed
54
import System.FilePath
Simon Marlow's avatar
Simon Marlow committed
55
56
57
import System.IO
import SYSTEM_IO_ERROR as IO
import Control.Monad
58
import Data.List	( isSuffixOf )
Simon Marlow's avatar
Simon Marlow committed
59
60
61
import Data.Maybe
import System.Exit
import System.Environment
62

63
64
-- ---------------------------------------------------------------------------
-- Pre-process
65
66
67

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

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
72
73
preprocess :: HscEnv -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
preprocess hsc_env (filename, mb_phase) =
74
  ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
75
  runPipeline anyHsc hsc_env (filename, mb_phase) 
Simon Marlow's avatar
Simon Marlow committed
76
        Nothing Temporary Nothing{-no ModLocation-}
77

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

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

90
compile :: HscEnv
91
92
93
94
95
96
        -> ModSummary                   -- summary for module being compiled
        -> Int -> Int                   -- module N of M
        -> Maybe ModIface               -- old interface, if we have one
        -> Maybe Linkable               -- old linkable, if we have one
        -> IO (Maybe HomeModInfo)       -- the complete HomeModInfo, if successful

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
97
compile hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
98
99
100
101
 = do
   let dflags0     = ms_hspp_opts summary
       this_mod    = ms_mod summary
       src_flavour = ms_hsc_src summary
102
103
104
       location	   = ms_location summary
       input_fn    = expectJust "compile:hs" (ml_hs_file location) 
       input_fnpp  = ms_hspp_file summary
105

106
   debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
107

Ian Lynagh's avatar
Ian Lynagh committed
108
   let basename = dropExtension input_fn
109

110
111
112
  -- 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.
Ian Lynagh's avatar
Ian Lynagh committed
113
114
115
   let current_dir = case takeDirectory basename of
                     "" -> "." -- XXX Hack
                     d -> d
116
117
       old_paths   = includePaths dflags0
       dflags      = dflags0 { includePaths = current_dir : old_paths }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
118
       hsc_env     = hsc_env0 {hsc_dflags = dflags}
119

120
   -- Figure out what lang we're generating
121
   let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
122
   -- ... and what the next phase should be
123
   let next_phase = hscNextPhase dflags src_flavour hsc_lang
124
   -- ... and what file to generate the output into
125
126
   output_fn <- getOutputFilename next_phase 
			Temporary basename dflags next_phase (Just location)
127

128
   let dflags' = dflags { hscTarget = hsc_lang,
129
				hscOutName = output_fn,
130
				extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
131
   let hsc_env' = hsc_env { hsc_dflags = dflags' }
132
133

   -- -no-recomp should also work with --make
134
135
   let force_recomp = dopt Opt_ForceRecomp dflags
       source_unchanged = isJust maybe_old_linkable && not force_recomp
136
       object_filename = ml_obj_file location
137

138
139
   let getStubLinkable False = return []
       getStubLinkable True
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
140
           = do stub_o <- compileStub hsc_env' this_mod location
141
142
                return [ DotO stub_o ]

143
       handleBatch HscNoRecomp
144
           = ASSERT (isJust maybe_old_linkable)
145
146
147
             return maybe_old_linkable

       handleBatch (HscRecomp hasStub)
148
           | isHsBoot src_flavour
149
150
               = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
                       SysTools.touch dflags' "Touching object file"
151
                                   object_filename
152
153
                    return maybe_old_linkable

154
155
156
157
158
           | otherwise
               = do stub_unlinked <- getStubLinkable hasStub
                    (hs_unlinked, unlinked_time) <-
                        case hsc_lang of
                          HscNothing
159
                            -> return ([], ms_hs_date summary)
160
161
                          -- We're in --make mode: finish the compilation pipeline.
                          _other
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
162
                            -> do runPipeline StopLn hsc_env' (output_fn,Nothing)
Simon Marlow's avatar
Simon Marlow committed
163
164
                                              (Just basename)
                                              Persistent
165
166
167
168
169
170
                                              (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)
171
                    return (Just linkable)
172

173
       handleInterpreted InteractiveNoRecomp
174
           = ASSERT (isJust maybe_old_linkable)
175
176
             return maybe_old_linkable
       handleInterpreted (InteractiveRecomp hasStub comp_bc modBreaks)
177
           = do stub_unlinked <- getStubLinkable hasStub
178
                let hs_unlinked = [BCOs comp_bc modBreaks]
179
                    unlinked_time = ms_hs_date summary
180
181
182
183
184
185
186
187
                  -- 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)
188
                return (Just linkable)
189

190
191
192
193
   let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
       --            -> IO (Maybe HomeModInfo)
       runCompiler compiler handle
           = do mbResult <- compiler hsc_env' summary source_unchanged mb_old_iface
194
195
                                     (Just (mod_index, nmods))
                case mbResult of
196
197
198
199
200
201
                  Nothing -> return Nothing
                  Just (result, iface, details) -> do
                        linkable <- handle result
                        return (Just HomeModInfo{ hm_details  = details,
                                                  hm_iface    = iface,
                                                  hm_linkable = linkable })
202
   -- run the compiler
203
   case hsc_lang of
204
205
206
207
208
209
210
211
212
      HscInterpreted
        | isHsBoot src_flavour -> 
                runCompiler hscCompileNothing handleBatch
        | otherwise -> 
                runCompiler hscCompileInteractive handleInterpreted
      HscNothing -> 
                runCompiler hscCompileNothing handleBatch
      _other -> 
                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.

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
233
234
compileStub :: HscEnv -> Module -> ModLocation -> IO FilePath
compileStub hsc_env mod location = do
Ian Lynagh's avatar
Ian Lynagh committed
235
236
	let (o_base, o_ext) = splitExtension (ml_obj_file location)
	    stub_o = (o_base ++ "_stub") <.> o_ext
237

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

	return stub_o
244
245


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

Ian Lynagh's avatar
Ian Lynagh committed
249
250
251
252
link :: GhcLink                 -- interactive or batch
     -> DynFlags                -- dynamic flags
     -> Bool                    -- attempt linking in batch mode?
     -> 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
link LinkInMemory _ _ _
264
    = do -- Not Linking...(demand linker will do the job)
Ian Lynagh's avatar
Ian Lynagh committed
265
         return Succeeded
266
267
#endif

268
link NoLink _ _ _
269
270
   = return Succeeded

271
link LinkBinary dflags batch_attempt_linking hpt
272
   | batch_attempt_linking
Ian Lynagh's avatar
Ian Lynagh committed
273
274
275
   = do
        let
            home_mod_infos = eltsUFM hpt
276

Ian Lynagh's avatar
Ian Lynagh committed
277
278
            -- the packages we depend on
            pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
279

Ian Lynagh's avatar
Ian Lynagh committed
280
281
            -- the linkables to link
            linkables = map (expectJust "link".hm_linkable) home_mod_infos
282

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

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

Ian Lynagh's avatar
Ian Lynagh committed
291
292
        let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
            obj_files = concatMap getOfiles linkables
293

Ian Lynagh's avatar
Ian Lynagh committed
294
            exe_file = exeFileName dflags
295

Ian Lynagh's avatar
Ian Lynagh committed
296
297
298
299
        -- 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
300
301
302
303
        extra_ld_inputs <- readIORef v_Ld_inputs
        extra_times <- mapM (IO.try . getModificationTime) extra_ld_inputs
        let other_times = map linkableTime linkables
                       ++ [ t' | Right t' <- extra_times ]
304
305
306
            linking_needed = case e_exe_time of
                               Left _  -> True
                               Right t -> any (t <) other_times
307

Ian Lynagh's avatar
Ian Lynagh committed
308
        if not (dopt Opt_ForceRecomp dflags) && not linking_needed
309
           then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
Ian Lynagh's avatar
Ian Lynagh committed
310
311
                   return Succeeded
           else do
312

313
        debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
Ian Lynagh's avatar
Ian Lynagh committed
314
                                 <+> text "...")
315

Ian Lynagh's avatar
Ian Lynagh committed
316
317
318
319
        -- Don't showPass in Batch mode; doLink will do that for us.
        let link = case ghcLink dflags of
                LinkBinary  -> linkBinary
                LinkDynLib  -> linkDynLib
320
                other       -> panicBadLink other
Ian Lynagh's avatar
Ian Lynagh committed
321
        link dflags obj_files pkg_deps
322

323
        debugTraceMsg dflags 3 (text "link: done")
324

Ian Lynagh's avatar
Ian Lynagh committed
325
        -- linkBinary only returns if it succeeds
326
327
328
        return Succeeded

   | otherwise
329
330
   = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
                                text "   Main.main not exported; not linking.")
331
        return Succeeded
Ian Lynagh's avatar
Ian Lynagh committed
332

333
334
335
336
337
338
-- warning suppression
link other _ _ _ = panicBadLink other

panicBadLink :: GhcLink -> a
panicBadLink other = panic ("link: GHC not built to link this way: " ++
                            show other)
339
340
341
-- -----------------------------------------------------------------------------
-- Compile files in one-shot mode.

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
342
343
344
345
oneShot :: HscEnv -> Phase -> [(String, Maybe Phase)] -> IO ()
oneShot hsc_env stop_phase srcs = do
  o_files <- mapM (compileFile hsc_env stop_phase) srcs
  doLink (hsc_dflags hsc_env) stop_phase o_files
346

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
347
348
compileFile :: HscEnv -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
compileFile hsc_env stop_phase (src, mb_phase) = do
349
350
351
352
353
   exists <- doesFileExist src
   when (not exists) $ 
   	throwDyn (CmdLineError ("does not exist: " ++ src))
   
   let
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
354
        dflags = hsc_dflags hsc_env
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
	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
370
                        _          -> stop_phase
371

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
372
   (_, out_file) <- runPipeline stop_phase' hsc_env
Simon Marlow's avatar
Simon Marlow committed
373
374
			  (src, mb_phase) Nothing output 
                          Nothing{-no ModLocation-}
375
376
377
378
379
380
381
382
383
384
385
   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 ()
386
387
	LinkBinary -> linkBinary dflags o_files link_pkgs
	LinkDynLib -> linkDynLib dflags o_files []
388
        other      -> panicBadLink other
389
390
391
  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
392
    link_pkgs = [haskell98PackageId]
393
394


395
396
-- ---------------------------------------------------------------------------
-- Run a compilation pipeline, consisting of multiple phases.
397

398
399
400
401
-- 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.

402
-- The DynFlags can be modified by phases in the pipeline (eg. by
403
404
405
406
407
408
409
410
411
412
413
414
415
-- 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.
416

417
runPipeline
418
  :: Phase		        -- When to stop
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
419
  -> HscEnv                     -- Compilation environment
420
  -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
Simon Marlow's avatar
Simon Marlow committed
421
  -> Maybe FilePath             -- original basename (if different from ^^^)
422
423
  -> PipelineOutput	        -- Output filename
  -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
424
  -> IO (DynFlags, FilePath)	-- (final flags, output filename)
425

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
426
runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
427
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
428
  let dflags0 = hsc_dflags hsc_env0
Ian Lynagh's avatar
Ian Lynagh committed
429
430
      (input_basename, suffix) = splitExtension input_fn
      suffix' = drop 1 suffix -- strip off the .
Simon Marlow's avatar
Simon Marlow committed
431
432
      basename | Just b <- mb_basename = b
               | otherwise             = input_basename
433

434
435
      -- Decide where dump files should go based on the pipeline output
      dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
436
      hsc_env = hsc_env0 {hsc_dflags = dflags}
437

438
	-- If we were given a -x flag, then use that phase to start from
Ian Lynagh's avatar
Ian Lynagh committed
439
      start_phase = fromMaybe (startPhase suffix') mb_phase
440

441
442
443
444
445
446
  -- 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.
447

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

453
454
  -- 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)
455
  let get_output_fn = getOutputFilename stop_phase output basename
456

457
  -- Execute the pipeline...
458
  (dflags', output_fn, maybe_loc) <- 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
459
	pipeLoop hsc_env start_phase stop_phase input_fn 
Ian Lynagh's avatar
Ian Lynagh committed
460
	  	 basename suffix' get_output_fn maybe_loc
461

462
  -- Sometimes, a compilation phase doesn't actually generate any output
463
464
  -- (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
465
466
  -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
  -- further compilation stages can tell what the original filename was.
467
468
469
470
  case output of
    Temporary -> 
	return (dflags', output_fn)
    _other ->
471
	do final_fn <- get_output_fn dflags' stop_phase maybe_loc
472
473
474
475
	   when (final_fn /= output_fn) $ do
              let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
                  line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
	      copyWithHeader dflags msg line_prag output_fn final_fn
476
	   return (dflags', final_fn)
477

478
479


dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
480
pipeLoop :: HscEnv -> Phase -> Phase 
481
	 -> FilePath  -> String -> Suffix
482
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
483
484
	 -> Maybe ModLocation
	 -> IO (DynFlags, FilePath, Maybe ModLocation)
485

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
486
pipeLoop hsc_env phase stop_phase 
487
488
	 input_fn orig_basename orig_suff 
	 orig_get_output_fn maybe_loc
489

490
  | phase `eqPhase` stop_phase		  -- All done
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
491
  = return (hsc_dflags hsc_env, input_fn, maybe_loc)
492

493
  | not (phase `happensBefore` stop_phase)
494
495
496
497
	-- 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 #-}.
498
499
500
501
  = panic ("pipeLoop: at phase " ++ show phase ++ 
	   " but I wanted to stop at phase " ++ show stop_phase)

  | otherwise 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
502
503
504
505
506
507
  = do (next_phase, dflags', maybe_loc, output_fn)
          <- runPhase phase stop_phase hsc_env orig_basename 
                      orig_suff input_fn orig_get_output_fn maybe_loc
       let hsc_env' = hsc_env {hsc_dflags = dflags'}
       pipeLoop hsc_env' next_phase stop_phase output_fn
                orig_basename orig_suff orig_get_output_fn maybe_loc
508

509
getOutputFilename
510
511
512
  :: Phase -> PipelineOutput -> String
  -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
getOutputFilename stop_phase output basename
513
514
 = func
 where
515
	func dflags next_phase maybe_location
516
517
518
519
	   | is_last_phase, Persistent <- output     = persistent_fn
	   | is_last_phase, SpecificFile f <- output = return f
	   | keep_this_output	   		     = persistent_fn
     	   | otherwise        	   		     = newTempName dflags suffix
520
	   where
521
522
523
524
525
526
527
528
529
530
531
		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

532
		is_last_phase = next_phase `eqPhase` stop_phase
533
534
535
536

		-- sometimes, we keep output from intermediate stages
		keep_this_output = 
     		     case next_phase of
537
     			     StopLn              -> True
538
539
540
541
542
     			     Mangle | keep_raw_s -> True
     			     As     | keep_s     -> True
     			     HCc    | keep_hc    -> True
     			     _other              -> False

543
		suffix = myPhaseInputExt next_phase
544
545
546

		-- persistent object files get put in odir
	        persistent_fn 
547
548
		   | StopLn <- next_phase = return odir_persistent
		   | otherwise            = return persistent
549

Ian Lynagh's avatar
Ian Lynagh committed
550
		persistent = basename <.> suffix
551

552
		odir_persistent
553
		   | Just loc <- maybe_location = ml_obj_file loc
Ian Lynagh's avatar
Ian Lynagh committed
554
		   | Just d <- odir = d </> persistent
555
556
		   | otherwise      = persistent

557

558
559
560
561
562
563
564
565
566
567
-- -----------------------------------------------------------------------------
-- 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.

568
569
runPhase :: Phase	-- Do this phase first
	 -> Phase	-- Stop just before this phase
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
570
	 -> HscEnv
571
572
573
	 -> String	-- basename of original input source
	 -> String	-- its extension
	 -> FilePath	-- name of file which contains the input to this phase.
574
	 -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
575
			-- how to calculate the output filename
576
	 -> Maybe ModLocation		-- the ModLocation, if we have one
577
	 -> IO (Phase,	  		-- next phase
578
579
580
		DynFlags,		-- new dynamic flags
		Maybe ModLocation,	-- the ModLocation, if we have one
		FilePath)		-- output filename
581

582
583
584
585
	-- 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 

586
587
588
-------------------------------------------------------------------------------
-- Unlit phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
589
runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
590
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
591
       let dflags = hsc_dflags hsc_env
592
       output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
593

594
595
596
597
598
599
600
601
602
603
604
605
606
       let unlit_flags = getOpts dflags opt_L
           flags = map SysTools.Option unlit_flags ++
                   [ -- The -h option passes the file name for unlit to
                     -- put in a #line directive
                     SysTools.Option     "-h"
                     -- cpp interprets \b etc as escape sequences,
                     -- so we use / for filenames in pragmas
                   , SysTools.Option $ reslash Forwards $ normalise input_fn
                   , SysTools.FileOption "" input_fn
                   , SysTools.FileOption "" output_fn
                   ]

       SysTools.runUnlit dflags flags
607

608
       return (Cpp sf, dflags, maybe_loc, output_fn)
609
610

-------------------------------------------------------------------------------
611
612
-- Cpp phase : (a) gets OPTIONS out of file
--	       (b) runs cpp if necessary
613

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
614
615
runPhase (Cpp sf) _stop hsc_env basename suff input_fn get_output_fn maybe_loc
  = do let dflags0 = hsc_dflags hsc_env
616
       src_opts <- getOptionsFromFile dflags0 input_fn
617
       (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
Ian Lynagh's avatar
Ian Lynagh committed
618
       checkProcessArgsResult unhandled_flags (basename <.> suff)
619

620
       if not (dopt Opt_Cpp dflags) then
sof's avatar
sof committed
621
622
           -- no need to preprocess CPP, just pass input file along
	   -- to the next phase of the pipeline.
623
          return (HsPp sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
624
	else do
625
	    output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
626
	    doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
627
	    return (HsPp sf, dflags, maybe_loc, output_fn)
628

sof's avatar
sof committed
629
630
631
-------------------------------------------------------------------------------
-- HsPp phase 

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
632
633
634
runPhase (HsPp sf) _stop hsc_env basename suff input_fn get_output_fn maybe_loc
  = do let dflags = hsc_dflags hsc_env
       if not (dopt Opt_Pp dflags) then
sof's avatar
sof committed
635
636
           -- no need to preprocess, just pass input file along
	   -- to the next phase of the pipeline.
637
          return (Hsc sf, dflags, maybe_loc, input_fn)
sof's avatar
sof committed
638
	else do
639
	    let hspp_opts = getOpts dflags opt_F
Ian Lynagh's avatar
Ian Lynagh committed
640
	    let orig_fn = basename <.> suff
641
	    output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
642
643
	    SysTools.runPp dflags
			   ( [ SysTools.Option     orig_fn
sof's avatar
sof committed
644
645
646
647
648
			     , SysTools.Option     input_fn
			     , SysTools.FileOption "" output_fn
			     ] ++
			     map SysTools.Option hspp_opts
			   )
649
	    return (Hsc sf, dflags, maybe_loc, output_fn)
650

651
652
653
-----------------------------------------------------------------------------
-- Hsc phase

654
655
-- Compilation of a single module, in "legacy" mode (_not_ under
-- the direction of the compilation manager).
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
656
runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc 
657
 = do	-- normal Hsc mode, not mkdependHS
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
658
        let dflags0 = hsc_dflags hsc_env
659

660
  -- we add the current directory (i.e. the directory in which
661
  -- the .hs files resides) to the include path, since this is
662
  -- what gcc does, and it's probably what you want.
Ian Lynagh's avatar
Ian Lynagh committed
663
664
665
	let current_dir = case takeDirectory basename of
                      "" -> "." -- XXX Hack
                      d -> d
666
	
667
668
	    paths = includePaths dflags0
	    dflags = dflags0 { includePaths = current_dir : paths }
669
	
670
  -- gather the imports and module name
671
        (hspp_buf,mod_name,imps,src_imps) <- 
672
673
674
            case src_flavour of
		ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
			          ; m <- getCoreModuleName input_fn
675
			          ; return (Nothing, mkModuleName m, [], []) }
676

677
		_           -> do { buf <- hGetStringBuffer input_fn
Ian Lynagh's avatar
Ian Lynagh committed
678
			    ; (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
679
			    ; return (Just buf, mod_name, imps, src_imps) }
680
681
682
683
684
685
686

  -- 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)
687
	location1 <- mkHomeModLocation2 dflags mod_name basename suff
688
689
690
691
692
693
694
695
696

  -- 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
697
698
	let ohi = outputHi dflags
	    location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
699
700
701
702
703
704
705
		      | 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
706
707
708
	let expl_o_file = outputFile dflags
	    location4 | Just ofile <- expl_o_file
		      , isNoLink (ghcLink dflags)
709
710
711
712
713
714
715
		      = 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.
716
  --
717
  -- Setting source_unchanged to True means that M.o seems
718
719
  -- to be up to date wrt M.hs; so no need to recompile unless imports have
  -- changed (which the compiler itself figures out).
720
  -- Setting source_unchanged to False tells the compiler that M.o is out of
721
  -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
Ian Lynagh's avatar
Ian Lynagh committed
722
	src_timestamp <- getModificationTime (basename <.> suff)
Simon Marlow's avatar
Simon Marlow committed
723

724
	let force_recomp = dopt Opt_ForceRecomp dflags
725
	source_unchanged <- 
726
          if force_recomp || not (isStopLn stop)
727
728
		-- Set source_unchanged to False unconditionally if
		--	(a) recompilation checker is off, or
729
		-- 	(b) we aren't going all the way to .o file (e.g. ghc -S)
730
731
	     then return False	
		-- Otherwise look at file modification dates
732
	     else do o_file_exists <- doesFileExist o_file
733
		     if not o_file_exists
734
		        then return False	-- Need to recompile
735
			else do t2 <- getModificationTime o_file
736
			        if t2 > src_timestamp
737
738
				  then return True
				  else return False
739

740
  -- get the DynFlags
741
	let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
742
	let next_phase = hscNextPhase dflags src_flavour hsc_lang
743
	output_fn  <- get_output_fn dflags next_phase (Just location4)
744

745
        let dflags' = dflags { hscTarget = hsc_lang,
746
747
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
748

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
749
        let hsc_env' = hsc_env {hsc_dflags = dflags'}
750

751
  -- Tell the finder cache about this module
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
752
	mod <- addHomeModuleToFinder hsc_env' mod_name location4
Simon Marlow's avatar
Simon Marlow committed
753
754
755
756
757
758
759
760
761
762
763

  -- Make the ModSummary to hand to hscMain
	let
	    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,
764
765
					ms_imps	     = imps,
					ms_srcimps   = src_imps }
766

767
  -- run the compiler!
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
768
	mbResult <- hscCompileOneShot hsc_env'
769
770
			  mod_summary source_unchanged 
			  Nothing	-- No iface
771
                          Nothing       -- No "module i of n" progress info
772

773
774
	case mbResult of
          Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
775
          Just HscNoRecomp
776
777
778
779
780
              -> 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)
781
          Just (HscRecomp hasStub)
782
              -> do when hasStub $
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
783
                         do stub_o <- compileStub hsc_env' mod location4
784
785
786
787
788
789
                            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)
790

791
792
793
-----------------------------------------------------------------------------
-- Cmm phase

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
794
runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
795
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
796
       let dflags = hsc_dflags hsc_env
797
       output_fn <- get_output_fn dflags Cmm maybe_loc
798
       doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn	
799
       return (Cmm, dflags, maybe_loc, output_fn)
800

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
801
runPhase Cmm stop hsc_env basename _ input_fn get_output_fn maybe_loc
802
  = do
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
803
        let dflags = hsc_dflags hsc_env
804
	let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
805
	let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
806
	output_fn <- get_output_fn dflags next_phase maybe_loc
807

808
        let dflags' = dflags { hscTarget = hsc_lang,
809
810
			       hscOutName = output_fn,
			       extCoreName = basename ++ ".hcr" }
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
811
        let hsc_env' = hsc_env {hsc_dflags = dflags'}
812

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
813
	ok <- hscCmmFile hsc_env' input_fn
814
815
816

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

817
	return (next_phase, dflags, maybe_loc, output_fn)
818

819
820
821
822
823
824
-----------------------------------------------------------------------------
-- 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.

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
825
runPhase cc_phase _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
826
   | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
827
828
   = do	let dflags = hsc_dflags hsc_env
        let cc_opts = getOpts dflags opt_c
829
	    hcc = cc_phase `eqPhase` HCc
830

831
       	let cmdline_include_paths = includePaths dflags
832

833
834
835
836
837
838
	-- 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 :)
839
        pkg_include_dirs <- getPackageIncludePath dflags pkgs
rrt's avatar
rrt committed
840
841
        let include_paths = foldr (\ x xs -> "-I" : x : xs) []
			      (cmdline_include_paths ++ pkg_include_dirs)
842

843
	let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
844
        gcc_extra_viac_flags <- getExtraViaCOpts dflags
845
        let pic_c_flags = picCCOpts dflags
846

847
        let verb = getVerbFlag dflags
848

849
	pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
850

851
852
853
854
855
856
857
#ifdef darwin_TARGET_OS
        pkg_framework_paths <- getPackageFrameworkPath dflags pkgs
        let cmdline_framework_paths = frameworkPaths dflags
        let framework_paths = map ("-F"++) 
                        (cmdline_framework_paths ++ pkg_framework_paths)
#endif

858
859
	let split_objs = dopt Opt_SplitObjs dflags
	    split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
sof's avatar
sof committed
860
		      | otherwise         = [ ]
861

Simon Marlow's avatar
Simon Marlow committed
862
863
864
	let cc_opt | optLevel dflags >= 2 = "-O2"
		   | otherwise            = "-O"

865
	-- Decide next phase
866
867
868
	
        let mangle = dopt Opt_DoAsmMangling dflags
            next_phase
869
870
		| hcc && mangle     = Mangle
		| otherwise         = As
871
	output_fn <- get_output_fn dflags next_phase maybe_loc
872

873
874
	let
	  more_hcc_opts =
875
#if i386_TARGET_ARCH
876
877
878
879
	   	-- 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.
880
881
882
		(if dopt Opt_ExcessPrecision dflags 
                        then [] 
                        else [ "-ffloat-store" ]) ++
883
884
885
886
887
888
889
890
891
#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"]



892
893
894
895
896
	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