compiler/main/DriverPipeline.hs

   1 -----------------------------------------------------------------------------
   2 --
   3 -- GHC Driver
   4 --
   5 -- (c) The University of Glasgow 2005
   6 --
   7 -----------------------------------------------------------------------------
   8
   9 module DriverPipeline (
  10         -- Run a series of compilation steps in a pipeline, for a
  11         -- collection of source files.
  12    oneShot, compileFile,
  13
  14         -- Interfaces for the batch-mode driver
  15    staticLink,
  16
  17         -- Interfaces for the compilation manager (interpreted/batch-mode)
  18    preprocess,
  19    compile, CompResult(..),
  20    link,
  21
  22         -- DLL building
  23    doMkDLL,
  24
  25   ) where
  26
  27 #include "HsVersions.h"
  28
  29 import Packages
  30 import HeaderInfo
  31 import DriverPhases
  32 import SysTools         ( newTempName, addFilesToClean, copy )
  33 import qualified SysTools
  34 import HscMain
  35 import Finder
  36 import HscTypes
  37 import Outputable
  38 import Module
  39 import UniqFM           ( eltsUFM )
  40 import ErrUtils
  41 import DynFlags
  42 import StaticFlags      ( v_Ld_inputs, opt_Static, WayName(..) )
  43 import Config
  44 import Panic
  45 import Util
  46 import StringBuffer     ( hGetStringBuffer )
  47 import BasicTypes       ( SuccessFlag(..) )
  48 import Maybes           ( expectJust )
  49 import ParserCoreUtils  ( getCoreModuleName )
  50 import SrcLoc           ( unLoc )
  51 import SrcLoc           ( Located(..) )
  52
  53 import Control.Exception as Exception
  54 import Data.IORef       ( readIORef, writeIORef, IORef )
  55 import GHC.Exts         ( Int(..) )
  56 import System.Directory
  57 import System.IO
  58 import SYSTEM_IO_ERROR as IO
  59 import Control.Monad
  60 import Data.List        ( isSuffixOf )
  61 import Data.Maybe
  62 import System.Exit
  63 import System.Cmd
  64 import System.Environment
  65
  66 -- ---------------------------------------------------------------------------
  67 -- Pre-process
  68
  69 -- Just preprocess a file, put the result in a temp. file (used by the
  70 -- compilation manager during the summary phase).
  71 --
  72 -- We return the augmented DynFlags, because they contain the result
  73 -- of slurping in the OPTIONS pragmas
  74
  75 preprocess :: DynFlags -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
  76 preprocess dflags (filename, mb_phase) =
  77   ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename)
  78   runPipeline anyHsc dflags (filename, mb_phase) Temporary Nothing{-no ModLocation-}
  79
  80 -- ---------------------------------------------------------------------------
  81 -- Compile
  82
  83 -- Compile a single module, under the control of the compilation manager.
  84 --
  85 -- This is the interface between the compilation manager and the
  86 -- compiler proper (hsc), where we deal with tedious details like
  87 -- reading the OPTIONS pragma from the source file, and passing the
  88 -- output of hsc through the C compiler.
  89
  90 -- NB.  No old interface can also mean that the source has changed.
  91
  92 compile :: HscEnv
  93         -> ModSummary
  94         -> Maybe Linkable       -- Just linkable <=> source unchanged
  95         -> Maybe ModIface       -- Old interface, if available
  96         -> Int -> Int
  97         -> IO CompResult
  98
  99 data CompResult
 100    = CompOK   ModDetails        -- New details
 101               ModIface          -- New iface
 102               (Maybe Linkable)  -- a Maybe, for the same reasons as hm_linkable
 103
 104    | CompErrs
 105
 106
 107 compile hsc_env mod_summary maybe_old_linkable old_iface mod_index nmods = do
 108
 109    let dflags0     = ms_hspp_opts mod_summary
 110        this_mod    = ms_mod mod_summary
 111        src_flavour = ms_hsc_src mod_summary
 112
 113        have_object
 114                | Just l <- maybe_old_linkable, isObjectLinkable l = True
 115                | otherwise = False
 116
 117    -- FIXME: We need to know whether or not we're recompiling the file. Move this to HscMain?
 118    --showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
 119
 120    let location   = ms_location mod_summary
 121    let input_fn   = expectJust "compile:hs" (ml_hs_file location)
 122    let input_fnpp = ms_hspp_file mod_summary
 123
 124    debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
 125
 126    let (basename, _) = splitFilename input_fn
 127
 128   -- We add the directory in which the .hs files resides) to the import path.
 129   -- This is needed when we try to compile the .hc file later, if it
 130   -- imports a _stub.h file that we created here.
 131    let current_dir = directoryOf basename
 132        old_paths   = includePaths dflags0
 133        dflags      = dflags0 { includePaths = current_dir : old_paths }
 134
 135    -- Figure out what lang we're generating
 136    let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
 137    -- ... and what the next phase should be
 138    let next_phase = hscNextPhase dflags src_flavour hsc_lang
 139    -- ... and what file to generate the output into
 140    output_fn <- getOutputFilename next_phase
 141                         Temporary basename dflags next_phase (Just location)
 142
 143    let dflags' = dflags { hscTarget = hsc_lang,
 144                                 hscOutName = output_fn,
 145                                 extCoreName = basename ++ ".hcr" }
 146
 147    -- -no-recomp should also work with --make
 148    let force_recomp = dopt Opt_ForceRecomp dflags
 149        source_unchanged = isJust maybe_old_linkable && not force_recomp
 150        hsc_env' = hsc_env { hsc_dflags = dflags' }
 151        object_filename = ml_obj_file location
 152
 153    let getStubLinkable False = return []
 154        getStubLinkable True
 155            = do stub_o <- compileStub dflags' this_mod location
 156                 return [ DotO stub_o ]
 157
 158        handleBatch (HscNoRecomp, iface, details)
 159            = ASSERT (isJust maybe_old_linkable)
 160              return (CompOK details iface maybe_old_linkable)
 161        handleBatch (HscRecomp hasStub, iface, details)
 162            | isHsBoot src_flavour
 163                = return (CompOK details iface Nothing)
 164            | otherwise
 165                = do stub_unlinked <- getStubLinkable hasStub
 166                     (hs_unlinked, unlinked_time) <-
 167                         case hsc_lang of
 168                           HscNothing
 169                             -> return ([], ms_hs_date mod_summary)
 170                           -- We're in --make mode: finish the compilation pipeline.
 171                           _other
 172                             -> do runPipeline StopLn dflags (output_fn,Nothing) Persistent
 173                                               (Just location)
 174                                   -- The object filename comes from the ModLocation
 175                                   o_time <- getModificationTime object_filename
 176                                   return ([DotO object_filename], o_time)
 177                     let linkable = LM unlinked_time this_mod
 178                                    (hs_unlinked ++ stub_unlinked)
 179                     return (CompOK details iface (Just linkable))
 180
 181        handleInterpreted (InteractiveNoRecomp, iface, details)
 182            = ASSERT (isJust maybe_old_linkable)
 183              return (CompOK details iface maybe_old_linkable)
 184        handleInterpreted (InteractiveRecomp hasStub comp_bc, iface, details)
 185            = do stub_unlinked <- getStubLinkable hasStub
 186                 let hs_unlinked = [BCOs comp_bc]
 187                     unlinked_time = ms_hs_date mod_summary
 188                   -- Why do we use the timestamp of the source file here,
 189                   -- rather than the current time?  This works better in
 190                   -- the case where the local clock is out of sync
 191                   -- with the filesystem's clock.  It's just as accurate:
 192                   -- if the source is modified, then the linkable will
 193                   -- be out of date.
 194                 let linkable = LM unlinked_time this_mod
 195                                (hs_unlinked ++ stub_unlinked)
 196                 return (CompOK details iface (Just linkable))
 197
 198    let runCompiler compiler handle
 199            = do mbResult <- compiler hsc_env' mod_summary
 200                                      source_unchanged old_iface
 201                                      (Just (mod_index, nmods))
 202                 case mbResult of
 203                   Nothing     -> return CompErrs
 204                   Just result -> handle result
 205    -- run the compiler
 206    case hsc_lang of
 207      HscInterpreted | not (isHsBoot src_flavour) -- We can't compile boot files to
 208                                                  -- bytecode so don't even try.
 209          -> runCompiler hscCompileInteractive handleInterpreted
 210      HscNothing
 211          -> runCompiler hscCompileNothing handleBatch
 212      _other
 213          -> runCompiler hscCompileBatch handleBatch
 214
 215 -----------------------------------------------------------------------------
 216 -- stub .h and .c files (for foreign export support)
 217
 218 -- The _stub.c file is derived from the haskell source file, possibly taking
 219 -- into account the -stubdir option.
 220 --
 221 -- Consequently, we derive the _stub.o filename from the haskell object
 222 -- filename.
 223 --
 224 -- This isn't necessarily the same as the object filename we
 225 -- would get if we just compiled the _stub.c file using the pipeline.
 226 -- For example:
 227 --
 228 --    ghc src/A.hs -odir obj
 229 --
 230 -- results in obj/A.o, and src/A_stub.c.  If we compile src/A_stub.c with
 231 -- -odir obj, we would get obj/src/A_stub.o, which is wrong; we want
 232 -- obj/A_stub.o.
 233
 234 compileStub :: DynFlags -> Module -> ModLocation -> IO FilePath
 235 compileStub dflags mod location = do
 236         let (o_base, o_ext) = splitFilename (ml_obj_file location)
 237             stub_o = o_base ++ "_stub" `joinFileExt` o_ext
 238
 239         -- compile the _stub.c file w/ gcc
 240         let (stub_c,_) = mkStubPaths dflags (moduleName mod) location
 241         runPipeline StopLn dflags (stub_c,Nothing)
 242                 (SpecificFile stub_o) Nothing{-no ModLocation-}
 243
 244         return stub_o
 245
 246
 247 -- ---------------------------------------------------------------------------
 248 -- Link
 249
 250 link :: GhcMode                 -- interactive or batch
 251      -> DynFlags                -- dynamic flags
 252      -> Bool                    -- attempt linking in batch mode?
 253      -> HomePackageTable        -- what to link
 254      -> IO SuccessFlag
 255
 256 -- For the moment, in the batch linker, we don't bother to tell doLink
 257 -- which packages to link -- it just tries all that are available.
 258 -- batch_attempt_linking should only be *looked at* in batch mode.  It
 259 -- should only be True if the upsweep was successful and someone
 260 -- exports main, i.e., we have good reason to believe that linking
 261 -- will succeed.
 262
 263 #ifdef GHCI
 264 link Interactive dflags batch_attempt_linking hpt
 265     = do -- Not Linking...(demand linker will do the job)
 266          return Succeeded
 267 #endif
 268
 269 link JustTypecheck dflags batch_attempt_linking hpt
 270    = return Succeeded
 271
 272 link BatchCompile dflags batch_attempt_linking hpt
 273    | batch_attempt_linking
 274    = do
 275         let
 276             home_mod_infos = eltsUFM hpt
 277
 278             -- the packages we depend on
 279             pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
 280
 281             -- the linkables to link
 282             linkables = map (expectJust "link".hm_linkable) home_mod_infos
 283
 284         debugTraceMsg dflags 3 (text "link: linkables are ..." $$ vcat (map ppr linkables))
 285
 286         -- check for the -no-link flag
 287         if isNoLink (ghcLink dflags)
 288           then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
 289                   return Succeeded
 290           else do
 291
 292         let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
 293             obj_files = concatMap getOfiles linkables
 294
 295             exe_file = exeFileName dflags
 296
 297         -- if the modification time on the executable is later than the
 298         -- modification times on all of the objects, then omit linking
 299         -- (unless the -no-recomp flag was given).
 300         e_exe_time <- IO.try $ getModificationTime exe_file
 301         let linking_needed
 302                 | Left _  <- e_exe_time = True
 303                 | Right t <- e_exe_time =
 304                         any (t <) (map linkableTime linkables)
 305
 306         if not (dopt Opt_ForceRecomp dflags) && not linking_needed
 307            then do debugTraceMsg dflags 2 (text exe_file <+> ptext SLIT("is up to date, linking not required."))
 308                    return Succeeded
 309            else do
 310
 311         debugTraceMsg dflags 1 (ptext SLIT("Linking") <+> text exe_file
 312                                  <+> text "...")
 313
 314         -- Don't showPass in Batch mode; doLink will do that for us.
 315         let link = case ghcLink dflags of
 316                 MkDLL       -> doMkDLL
 317                 StaticLink  -> staticLink
 318         link dflags obj_files pkg_deps
 319
 320         debugTraceMsg dflags 3 (text "link: done")
 321
 322         -- staticLink only returns if it succeeds
 323         return Succeeded
 324
 325    | otherwise
 326    = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
 327                                 text "   Main.main not exported; not linking.")
 328         return Succeeded
 329
 330
 331 -- -----------------------------------------------------------------------------
 332 -- Compile files in one-shot mode.
 333
 334 oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
 335 oneShot dflags stop_phase srcs = do
 336   o_files <- mapM (compileFile dflags stop_phase) srcs
 337   doLink dflags stop_phase o_files
 338
 339 compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
 340 compileFile dflags stop_phase (src, mb_phase) = do
 341    exists <- doesFileExist src
 342    when (not exists) $
 343         throwDyn (CmdLineError ("does not exist: " ++ src))
 344
 345    let
 346         split     = dopt Opt_SplitObjs dflags
 347         mb_o_file = outputFile dflags
 348         ghc_link  = ghcLink dflags      -- Set by -c or -no-link
 349
 350         -- When linking, the -o argument refers to the linker's output.
 351         -- otherwise, we use it as the name for the pipeline's output.
 352         output
 353          | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
 354                 -- -o foo applies to linker
 355          | Just o_file <- mb_o_file = SpecificFile o_file
 356                 -- -o foo applies to the file we are compiling now
 357          | otherwise = Persistent
 358
 359         stop_phase' = case stop_phase of
 360                         As | split -> SplitAs
 361                         other      -> stop_phase
 362
 363    (_, out_file) <- runPipeline stop_phase' dflags
 364                           (src, mb_phase) output Nothing{-no ModLocation-}
 365    return out_file
 366
 367
 368 doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
 369 doLink dflags stop_phase o_files
 370   | not (isStopLn stop_phase)
 371   = return ()           -- We stopped before the linking phase
 372
 373   | otherwise
 374   = case ghcLink dflags of
 375         NoLink     -> return ()
 376         StaticLink -> staticLink dflags o_files link_pkgs
 377         MkDLL      -> doMkDLL dflags o_files link_pkgs
 378   where
 379    -- Always link in the haskell98 package for static linking.  Other
 380    -- packages have to be specified via the -package flag.
 381     link_pkgs = [haskell98PackageId]
 382
 383
 384 -- ---------------------------------------------------------------------------
 385 -- Run a compilation pipeline, consisting of multiple phases.
 386
 387 -- This is the interface to the compilation pipeline, which runs
 388 -- a series of compilation steps on a single source file, specifying
 389 -- at which stage to stop.
 390
 391 -- The DynFlags can be modified by phases in the pipeline (eg. by
 392 -- GHC_OPTIONS pragmas), and the changes affect later phases in the
 393 -- pipeline.
 394
 395 data PipelineOutput
 396   = Temporary
 397         -- output should be to a temporary file: we're going to
 398         -- run more compilation steps on this output later
 399   | Persistent
 400         -- we want a persistent file, i.e. a file in the current directory
 401         -- derived from the input filename, but with the appropriate extension.
 402         -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
 403   | SpecificFile FilePath
 404         -- the output must go into the specified file.
 405
 406 runPipeline
 407   :: Phase                      -- When to stop
 408   -> DynFlags                   -- Dynamic flags
 409   -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
 410   -> PipelineOutput             -- Output filename
 411   -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
 412   -> IO (DynFlags, FilePath)    -- (final flags, output filename)
 413
 414 runPipeline stop_phase dflags (input_fn, mb_phase) output maybe_loc
 415   = do
 416   let (basename, suffix) = splitFilename input_fn
 417
 418         -- If we were given a -x flag, then use that phase to start from
 419       start_phase = fromMaybe (startPhase suffix) mb_phase
 420
 421   -- We want to catch cases of "you can't get there from here" before
 422   -- we start the pipeline, because otherwise it will just run off the
 423   -- end.
 424   --
 425   -- There is a partial ordering on phases, where A < B iff A occurs
 426   -- before B in a normal compilation pipeline.
 427
 428   when (not (start_phase `happensBefore` stop_phase)) $
 429         throwDyn (UsageError
 430                     ("cannot compile this file to desired target: "
 431                        ++ input_fn))
 432
 433   -- this is a function which will be used to calculate output file names
 434   -- as we go along (we partially apply it to some of its inputs here)
 435   let get_output_fn = getOutputFilename stop_phase output basename
 436
 437   -- Execute the pipeline...
 438   (dflags', output_fn, maybe_loc) <-
 439         pipeLoop dflags start_phase stop_phase input_fn
 440                  basename suffix get_output_fn maybe_loc
 441
 442   -- Sometimes, a compilation phase doesn't actually generate any output
 443   -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
 444   -- stage, but we wanted to keep the output, then we have to explicitly
 445   -- copy the file.
 446   case output of
 447     Temporary ->
 448         return (dflags', output_fn)
 449     _other ->
 450         do final_fn <- get_output_fn dflags' stop_phase maybe_loc
 451            when (final_fn /= output_fn) $
 452                   copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
 453                         ++ "'") output_fn final_fn
 454            return (dflags', final_fn)
 455
 456
 457
 458 pipeLoop :: DynFlags -> Phase -> Phase
 459          -> FilePath  -> String -> Suffix
 460          -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
 461          -> Maybe ModLocation
 462          -> IO (DynFlags, FilePath, Maybe ModLocation)
 463
 464 pipeLoop dflags phase stop_phase
 465          input_fn orig_basename orig_suff
 466          orig_get_output_fn maybe_loc
 467
 468   | phase `eqPhase` stop_phase            -- All done
 469   = return (dflags, input_fn, maybe_loc)
 470
 471   | not (phase `happensBefore` stop_phase)
 472         -- Something has gone wrong.  We'll try to cover all the cases when
 473         -- this could happen, so if we reach here it is a panic.
 474         -- eg. it might happen if the -C flag is used on a source file that
 475         -- has {-# OPTIONS -fasm #-}.
 476   = panic ("pipeLoop: at phase " ++ show phase ++
 477            " but I wanted to stop at phase " ++ show stop_phase)
 478
 479   | otherwise
 480   = do  { (next_phase, dflags', maybe_loc, output_fn)
 481                 <- runPhase phase stop_phase dflags orig_basename
 482                             orig_suff input_fn orig_get_output_fn maybe_loc
 483         ; pipeLoop dflags' next_phase stop_phase output_fn
 484                    orig_basename orig_suff orig_get_output_fn maybe_loc }
 485
 486 getOutputFilename
 487   :: Phase -> PipelineOutput -> String
 488   -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
 489 getOutputFilename stop_phase output basename
 490  = func
 491  where
 492         func dflags next_phase maybe_location
 493            | is_last_phase, Persistent <- output     = persistent_fn
 494            | is_last_phase, SpecificFile f <- output = return f
 495            | keep_this_output                        = persistent_fn
 496            | otherwise                               = newTempName dflags suffix
 497            where
 498                 hcsuf      = hcSuf dflags
 499                 odir       = objectDir dflags
 500                 osuf       = objectSuf dflags
 501                 keep_hc    = dopt Opt_KeepHcFiles dflags
 502                 keep_raw_s = dopt Opt_KeepRawSFiles dflags
 503                 keep_s     = dopt Opt_KeepSFiles dflags
 504
 505                 myPhaseInputExt HCc    = hcsuf
 506                 myPhaseInputExt StopLn = osuf
 507                 myPhaseInputExt other  = phaseInputExt other
 508
 509                 is_last_phase = next_phase `eqPhase` stop_phase
 510
 511                 -- sometimes, we keep output from intermediate stages
 512                 keep_this_output =
 513                      case next_phase of
 514                              StopLn              -> True
 515                              Mangle | keep_raw_s -> True
 516                              As     | keep_s     -> True
 517                              HCc    | keep_hc    -> True
 518                              _other              -> False
 519
 520                 suffix = myPhaseInputExt next_phase
 521
 522                 -- persistent object files get put in odir
 523                 persistent_fn
 524                    | StopLn <- next_phase = return odir_persistent
 525                    | otherwise            = return persistent
 526
 527                 persistent = basename `joinFileExt` suffix
 528
 529                 odir_persistent
 530                    | Just loc <- maybe_location = ml_obj_file loc
 531                    | Just d <- odir = d `joinFileName` persistent
 532                    | otherwise      = persistent
 533
 534
 535 -- -----------------------------------------------------------------------------
 536 -- Each phase in the pipeline returns the next phase to execute, and the
 537 -- name of the file in which the output was placed.
 538 --
 539 -- We must do things dynamically this way, because we often don't know
 540 -- what the rest of the phases will be until part-way through the
 541 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
 542 -- of a source file can change the latter stages of the pipeline from
 543 -- taking the via-C route to using the native code generator.
 544
 545 runPhase :: Phase       -- Do this phase first
 546          -> Phase       -- Stop just before this phase
 547          -> DynFlags
 548          -> String      -- basename of original input source
 549          -> String      -- its extension
 550          -> FilePath    -- name of file which contains the input to this phase.
 551          -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
 552                         -- how to calculate the output filename
 553          -> Maybe ModLocation           -- the ModLocation, if we have one
 554          -> IO (Phase,                  -- next phase
 555                 DynFlags,               -- new dynamic flags
 556                 Maybe ModLocation,      -- the ModLocation, if we have one
 557                 FilePath)               -- output filename
 558
 559         -- Invariant: the output filename always contains the output
 560         -- Interesting case: Hsc when there is no recompilation to do
 561         --                   Then the output filename is still a .o file
 562
 563 -------------------------------------------------------------------------------
 564 -- Unlit phase
 565
 566 runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
 567   = do let unlit_flags = getOpts dflags opt_L
 568        -- The -h option passes the file name for unlit to put in a #line directive
 569        output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
 570
 571        SysTools.runUnlit dflags
 572                 (map SysTools.Option unlit_flags ++
 573                           [ SysTools.Option     "-h"
 574                           , SysTools.Option     input_fn
 575                           , SysTools.FileOption "" input_fn
 576                           , SysTools.FileOption "" output_fn
 577                           ])
 578
 579        return (Cpp sf, dflags, maybe_loc, output_fn)
 580
 581 -------------------------------------------------------------------------------
 582 -- Cpp phase : (a) gets OPTIONS out of file
 583 --             (b) runs cpp if necessary
 584
 585 runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
 586   = do src_opts <- getOptionsFromFile input_fn
 587        (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
 588        checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
 589
 590        if not (dopt Opt_Cpp dflags) then
 591            -- no need to preprocess CPP, just pass input file along
 592            -- to the next phase of the pipeline.
 593           return (HsPp sf, dflags, maybe_loc, input_fn)
 594         else do
 595             output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
 596             doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
 597             return (HsPp sf, dflags, maybe_loc, output_fn)
 598
 599 -------------------------------------------------------------------------------
 600 -- HsPp phase
 601
 602 runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
 603   = do if not (dopt Opt_Pp dflags) then
 604            -- no need to preprocess, just pass input file along
 605            -- to the next phase of the pipeline.
 606           return (Hsc sf, dflags, maybe_loc, input_fn)
 607         else do
 608             let hspp_opts = getOpts dflags opt_F
 609             let orig_fn = basename `joinFileExt` suff
 610             output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
 611             SysTools.runPp dflags
 612                            ( [ SysTools.Option     orig_fn
 613                              , SysTools.Option     input_fn
 614                              , SysTools.FileOption "" output_fn
 615                              ] ++
 616                              map SysTools.Option hspp_opts
 617                            )
 618             return (Hsc sf, dflags, maybe_loc, output_fn)
 619
 620 -----------------------------------------------------------------------------
 621 -- Hsc phase
 622
 623 -- Compilation of a single module, in "legacy" mode (_not_ under
 624 -- the direction of the compilation manager).
 625 runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc
 626  = do   -- normal Hsc mode, not mkdependHS
 627
 628   -- we add the current directory (i.e. the directory in which
 629   -- the .hs files resides) to the import path, since this is
 630   -- what gcc does, and it's probably what you want.
 631         let current_dir = directoryOf basename
 632
 633             paths = includePaths dflags0
 634             dflags = dflags0 { includePaths = current_dir : paths }
 635
 636   -- gather the imports and module name
 637         (hspp_buf,mod_name) <-
 638             case src_flavour of
 639                 ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
 640                                   ; m <- getCoreModuleName input_fn
 641                                   ; return (Nothing, mkModuleName m) }
 642
 643                 other -> do { buf <- hGetStringBuffer input_fn
 644                             ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
 645                             ; return (Just buf, mod_name) }
 646
 647   -- Build a ModLocation to pass to hscMain.
 648   -- The source filename is rather irrelevant by now, but it's used
 649   -- by hscMain for messages.  hscMain also needs
 650   -- the .hi and .o filenames, and this is as good a way
 651   -- as any to generate them, and better than most. (e.g. takes
 652   -- into accout the -osuf flags)
 653         location1 <- mkHomeModLocation2 dflags mod_name basename suff
 654
 655   -- Boot-ify it if necessary
 656         let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
 657                       | otherwise            = location1
 658
 659
 660   -- Take -ohi into account if present
 661   -- This can't be done in mkHomeModuleLocation because
 662   -- it only applies to the module being compiles
 663         let ohi = outputHi dflags
 664             location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
 665                       | otherwise      = location2
 666
 667   -- Take -o into account if present
 668   -- Very like -ohi, but we must *only* do this if we aren't linking
 669   -- (If we're linking then the -o applies to the linked thing, not to
 670   -- the object file for one module.)
 671   -- Note the nasty duplication with the same computation in compileFile above
 672         let expl_o_file = outputFile dflags
 673             location4 | Just ofile <- expl_o_file
 674                       , isNoLink (ghcLink dflags)
 675                       = location3 { ml_obj_file = ofile }
 676                       | otherwise = location3
 677
 678             o_file = ml_obj_file location4      -- The real object file
 679
 680
 681   -- Figure out if the source has changed, for recompilation avoidance.
 682   --
 683   -- Setting source_unchanged to True means that M.o seems
 684   -- to be up to date wrt M.hs; so no need to recompile unless imports have
 685   -- changed (which the compiler itself figures out).
 686   -- Setting source_unchanged to False tells the compiler that M.o is out of
 687   -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
 688         src_timestamp <- getModificationTime (basename `joinFileExt` suff)
 689
 690         let force_recomp = dopt Opt_ForceRecomp dflags
 691         source_unchanged <-
 692           if force_recomp || not (isStopLn stop)
 693                 -- Set source_unchanged to False unconditionally if
 694                 --      (a) recompilation checker is off, or
 695                 --      (b) we aren't going all the way to .o file (e.g. ghc -S)
 696              then return False
 697                 -- Otherwise look at file modification dates
 698              else do o_file_exists <- doesFileExist o_file
 699                      if not o_file_exists
 700                         then return False       -- Need to recompile
 701                         else do t2 <- getModificationTime o_file
 702                                 if t2 > src_timestamp
 703                                   then return True
 704                                   else return False
 705
 706   -- get the DynFlags
 707         let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
 708         let next_phase = hscNextPhase dflags src_flavour hsc_lang
 709         output_fn  <- get_output_fn dflags next_phase (Just location4)
 710
 711         let dflags' = dflags { hscTarget = hsc_lang,
 712                                hscOutName = output_fn,
 713                                extCoreName = basename ++ ".hcr" }
 714
 715         hsc_env <- newHscEnv dflags'
 716
 717   -- Tell the finder cache about this module
 718         mod <- addHomeModuleToFinder hsc_env mod_name location4
 719
 720   -- Make the ModSummary to hand to hscMain
 721         let
 722             unused_field = panic "runPhase:ModSummary field"
 723                 -- Some fields are not looked at by hscMain
 724             mod_summary = ModSummary {  ms_mod       = mod,
 725                                         ms_hsc_src   = src_flavour,
 726                                         ms_hspp_file = input_fn,
 727                                         ms_hspp_opts = dflags,
 728                                         ms_hspp_buf  = hspp_buf,
 729                                         ms_location  = location4,
 730                                         ms_hs_date   = src_timestamp,
 731                                         ms_obj_date  = Nothing,
 732                                         ms_imps      = unused_field,
 733                                         ms_srcimps   = unused_field }
 734
 735   -- run the compiler!
 736         mbResult <- hscCompileOneShot hsc_env
 737                           mod_summary source_unchanged
 738                           Nothing       -- No iface
 739                           Nothing       -- No "module i of n" progress info
 740
 741         case mbResult of
 742           Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
 743           Just HscNoRecomp
 744               -> do SysTools.touch dflags' "Touching object file" o_file
 745                     -- The .o file must have a later modification date
 746                     -- than the source file (else we wouldn't be in HscNoRecomp)
 747                     -- but we touch it anyway, to keep 'make' happy (we think).
 748                     return (StopLn, dflags', Just location4, o_file)
 749           Just (HscRecomp hasStub)
 750               -> do when hasStub $
 751                          do stub_o <- compileStub dflags' mod location4
 752                             consIORef v_Ld_inputs stub_o
 753                     -- In the case of hs-boot files, generate a dummy .o-boot
 754                     -- stamp file for the benefit of Make
 755                     when (isHsBoot src_flavour) $
 756                       SysTools.touch dflags' "Touching object file" o_file
 757                     return (next_phase, dflags', Just location4, output_fn)
 758
 759 -----------------------------------------------------------------------------
 760 -- Cmm phase
 761
 762 runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
 763   = do
 764        output_fn <- get_output_fn dflags Cmm maybe_loc
 765        doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
 766        return (Cmm, dflags, maybe_loc, output_fn)
 767
 768 runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
 769   = do
 770         let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
 771         let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
 772         output_fn <- get_output_fn dflags next_phase maybe_loc
 773
 774         let dflags' = dflags { hscTarget = hsc_lang,
 775                                hscOutName = output_fn,
 776                                extCoreName = basename ++ ".hcr" }
 777
 778         ok <- hscCmmFile dflags' input_fn
 779
 780         when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))
 781
 782         return (next_phase, dflags, maybe_loc, output_fn)
 783
 784 -----------------------------------------------------------------------------
 785 -- Cc phase
 786
 787 -- we don't support preprocessing .c files (with -E) now.  Doing so introduces
 788 -- way too many hacks, and I can't say I've ever used it anyway.
 789
 790 runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
 791    | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
 792    = do let cc_opts = getOpts dflags opt_c
 793             hcc = cc_phase `eqPhase` HCc
 794
 795         let cmdline_include_paths = includePaths dflags
 796
 797         -- HC files have the dependent packages stamped into them
 798         pkgs <- if hcc then getHCFilePackages input_fn else return []
 799
 800         -- add package include paths even if we're just compiling .c
 801         -- files; this is the Value Add(TM) that using ghc instead of
 802         -- gcc gives you :)
 803         pkg_include_dirs <- getPackageIncludePath dflags pkgs
 804         let include_paths = foldr (\ x xs -> "-I" : x : xs) []
 805                               (cmdline_include_paths ++ pkg_include_dirs)
 806
 807         let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
 808         let pic_c_flags = picCCOpts dflags
 809
 810         let verb = getVerbFlag dflags
 811
 812         pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
 813
 814         let split_objs = dopt Opt_SplitObjs dflags
 815             split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
 816                       | otherwise         = [ ]
 817
 818         let excessPrecision = dopt Opt_ExcessPrecision dflags
 819
 820         let cc_opt | optLevel dflags >= 2 = "-O2"
 821                    | otherwise            = "-O"
 822
 823         -- Decide next phase
 824
 825         let mangle = dopt Opt_DoAsmMangling dflags
 826             next_phase
 827                 | hcc && mangle     = Mangle
 828                 | otherwise         = As
 829         output_fn <- get_output_fn dflags next_phase maybe_loc
 830
 831         let
 832           more_hcc_opts =
 833 #if i386_TARGET_ARCH
 834                 -- on x86 the floating point regs have greater precision
 835                 -- than a double, which leads to unpredictable results.
 836                 -- By default, we turn this off with -ffloat-store unless
 837                 -- the user specified -fexcess-precision.
 838                 (if excessPrecision then [] else [ "-ffloat-store" ]) ++
 839 #endif
 840                 -- gcc's -fstrict-aliasing allows two accesses to memory
 841                 -- to be considered non-aliasing if they have different types.
 842                 -- This interacts badly with the C code we generate, which is
 843                 -- very weakly typed, being derived from C--.
 844                 ["-fno-strict-aliasing"]
 845
 846
 847
 848         SysTools.runCc dflags (
 849                 -- force the C compiler to interpret this file as C when
 850                 -- compiling .hc files, by adding the -x c option.
 851                 -- Also useful for plain .c files, just in case GHC saw a
 852                 -- -x c option.
 853                         [ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
 854                                                 then SysTools.Option "c++" else SysTools.Option "c"] ++
 855                         [ SysTools.FileOption "" input_fn
 856                         , SysTools.Option "-o"
 857                         , SysTools.FileOption "" output_fn
 858                         ]
 859                        ++ map SysTools.Option (
 860                           md_c_flags
 861                        ++ pic_c_flags
 862 #ifdef sparc_TARGET_ARCH
 863         -- We only support SparcV9 and better because V8 lacks an atomic CAS
 864         -- instruction. Note that the user can still override this
 865         -- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
 866         -- regardless of the ordering.
 867         --
 868         -- This is a temporary hack.
 869                        ++ ["-mcpu=v9"]
 870 #endif
 871                        ++ (if hcc && mangle
 872                              then md_regd_c_flags
 873                              else [])
 874                        ++ (if hcc
 875                              then more_hcc_opts
 876                              else [])
 877                        ++ [ verb, "-S", "-Wimplicit", cc_opt ]
 878                        ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
 879                        ++ cc_opts
 880                        ++ split_opt
 881                        ++ include_paths
 882                        ++ pkg_extra_cc_opts
 883 #ifdef HAVE_GCC_HAS_WRAPV
 884                   -- We need consistent integer overflow (trac #952)
 885                ++ ["-fwrapv"]
 886 #endif
 887                        ))
 888
 889         return (next_phase, dflags, maybe_loc, output_fn)
 890
 891         -- ToDo: postprocess the output from gcc
 892
 893 -----------------------------------------------------------------------------
 894 -- Mangle phase
 895
 896 runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
 897    = do let mangler_opts = getOpts dflags opt_m
 898
 899 #if i386_TARGET_ARCH
 900         machdep_opts <- return [ show (stolen_x86_regs dflags) ]
 901 #else
 902         machdep_opts <- return []
 903 #endif
 904
 905         let split = dopt Opt_SplitObjs dflags
 906             next_phase
 907                 | split = SplitMangle
 908                 | otherwise = As
 909         output_fn <- get_output_fn dflags next_phase maybe_loc
 910
 911         SysTools.runMangle dflags (map SysTools.Option mangler_opts
 912                           ++ [ SysTools.FileOption "" input_fn
 913                              , SysTools.FileOption "" output_fn
 914                              ]
 915                           ++ map SysTools.Option machdep_opts)
 916
 917         return (next_phase, dflags, maybe_loc, output_fn)
 918
 919 -----------------------------------------------------------------------------
 920 -- Splitting phase
 921
 922 runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
 923   = do  -- tmp_pfx is the prefix used for the split .s files
 924         -- We also use it as the file to contain the no. of split .s files (sigh)
 925         split_s_prefix <- SysTools.newTempName dflags "split"
 926         let n_files_fn = split_s_prefix
 927
 928         SysTools.runSplit dflags
 929                           [ SysTools.FileOption "" input_fn
 930                           , SysTools.FileOption "" split_s_prefix
 931                           , SysTools.FileOption "" n_files_fn
 932                           ]
 933
 934         -- Save the number of split files for future references
 935         s <- readFile n_files_fn
 936         let n_files = read s :: Int
 937         writeIORef v_Split_info (split_s_prefix, n_files)
 938
 939         -- Remember to delete all these files
 940         addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
 941                         | n <- [1..n_files]]
 942
 943         return (SplitAs, dflags, maybe_loc, "**splitmangle**")
 944           -- we don't use the filename
 945
 946 -----------------------------------------------------------------------------
 947 -- As phase
 948
 949 runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
 950   = do  let as_opts =  getOpts dflags opt_a
 951         let cmdline_include_paths = includePaths dflags
 952
 953         output_fn <- get_output_fn dflags StopLn maybe_loc
 954
 955         -- we create directories for the object file, because it
 956         -- might be a hierarchical module.
 957         createDirectoryHierarchy (directoryOf output_fn)
 958
 959         SysTools.runAs dflags
 960                        (map SysTools.Option as_opts
 961                        ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
 962 #ifdef sparc_TARGET_ARCH
 963         -- We only support SparcV9 and better because V8 lacks an atomic CAS
 964         -- instruction so we have to make sure that the assembler accepts the
 965         -- instruction set. Note that the user can still override this
 966         -- (e.g., -mcpu=ultrasparc). GCC picks the "best" -mcpu flag
 967         -- regardless of the ordering.
 968         --
 969         -- This is a temporary hack.
 970                        ++ [ SysTools.Option "-mcpu=v9" ]
 971 #endif
 972                        ++ [ SysTools.Option "-c"
 973                           , SysTools.FileOption "" input_fn
 974                           , SysTools.Option "-o"
 975                           , SysTools.FileOption "" output_fn
 976                           ])
 977
 978         return (StopLn, dflags, maybe_loc, output_fn)
 979
 980
 981 runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
 982   = do
 983         output_fn <- get_output_fn dflags StopLn maybe_loc
 984
 985         let (base_o, _) = splitFilename output_fn
 986             split_odir  = base_o ++ "_split"
 987             osuf = objectSuf dflags
 988
 989         createDirectoryHierarchy split_odir
 990
 991         -- remove M_split/ *.o, because we're going to archive M_split/ *.o
 992         -- later and we don't want to pick up any old objects.
 993         fs <- getDirectoryContents split_odir
 994         mapM_ removeFile $ map (split_odir `joinFileName`)
 995                          $ filter (osuf `isSuffixOf`) fs
 996
 997         let as_opts = getOpts dflags opt_a
 998
 999         (split_s_prefix, n) <- readIORef v_Split_info
1000
1001         let split_s   n = split_s_prefix ++ "__" ++ show n `joinFileExt` "s"
1002             split_obj n = split_odir `joinFileName`
1003                                 filenameOf base_o ++ "__" ++ show n
1004                                         `joinFileExt` osuf
1005
1006         let assemble_file n
1007               = SysTools.runAs dflags
1008                          (map SysTools.Option as_opts ++
1009                          [ SysTools.Option "-c"
1010                          , SysTools.Option "-o"
1011                          , SysTools.FileOption "" (split_obj n)
1012                          , SysTools.FileOption "" (split_s n)
1013                          ])
1014
1015         mapM_ assemble_file [1..n]
1016
1017         -- and join the split objects into a single object file:
1018         let ld_r args = SysTools.runLink dflags ([
1019                                 SysTools.Option "-nostdlib",
1020                                 SysTools.Option "-nodefaultlibs",
1021                                 SysTools.Option "-Wl,-r",
1022                                 SysTools.Option ld_x_flag,
1023                                 SysTools.Option "-o",
1024                                 SysTools.FileOption "" output_fn ] ++ args)
1025             ld_x_flag | null cLD_X = ""
1026                       | otherwise  = "-Wl,-x"
1027
1028         if cLdIsGNULd == "YES"
1029             then do
1030                   let script = split_odir `joinFileName` "ld.script"
1031                   writeFile script $
1032                       "INPUT(" ++ unwords (map split_obj [1..n]) ++ ")"
1033                   ld_r [SysTools.FileOption "" script]
1034             else do
1035                   ld_r (map (SysTools.FileOption "" . split_obj) [1..n])
1036
1037         return (StopLn, dflags, maybe_loc, output_fn)
1038
1039
1040 -----------------------------------------------------------------------------
1041 -- MoveBinary sort-of-phase
1042 -- After having produced a binary, move it somewhere else and generate a
1043 -- wrapper script calling the binary. Currently, we need this only in
1044 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
1045 -- central directory.
1046 -- This is called from staticLink below, after linking. I haven't made it
1047 -- a separate phase to minimise interfering with other modules, and
1048 -- we don't need the generality of a phase (MoveBinary is always
1049 -- done after linking and makes only sense in a parallel setup)   -- HWL
1050
1051 runPhase_MoveBinary dflags input_fn
1052   = do
1053         let sysMan = pgm_sysman dflags
1054         pvm_root <- getEnv "PVM_ROOT"
1055         pvm_arch <- getEnv "PVM_ARCH"
1056         let
1057            pvm_executable_base = "=" ++ input_fn
1058            pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
1059         -- nuke old binary; maybe use configur'ed names for cp and rm?
1060         system ("rm -f " ++ pvm_executable)
1061         -- move the newly created binary into PVM land
1062         system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
1063         -- generate a wrapper script for running a parallel prg under PVM
1064         writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
1065         return True
1066
1067 -- generates a Perl skript starting a parallel prg under PVM
1068 mk_pvm_wrapper_script :: String -> String -> String -> String
1069 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
1070  [
1071   "eval 'exec perl -S $0 ${1+\"$@\"}'",
1072   "  if $running_under_some_shell;",
1073   "# =!=!=!=!=!=!=!=!=!=!=!",
1074   "# This script is automatically generated: DO NOT EDIT!!!",
1075   "# Generated by Glasgow Haskell Compiler",
1076   "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
1077   "#",
1078   "$pvm_executable      = '" ++ pvm_executable ++ "';",
1079   "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
1080   "$SysMan = '" ++ sysMan ++ "';",
1081   "",
1082   {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
1083   "# first, some magical shortcuts to run "commands" on the binary",
1084   "# (which is hidden)",
1085   "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
1086   "    local($cmd) = $1;",
1087   "    system("$cmd $pvm_executable");",
1088   "    exit(0); # all done",
1089   "}", -}
1090   "",
1091   "# Now, run the real binary; process the args first",
1092   "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
1093   "$debug = '';",
1094   "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
1095   "@nonPVM_args = ();",
1096   "$in_RTS_args = 0;",
1097   "",
1098   "args: while ($a = shift(@ARGV)) {",
1099   "    if ( $a eq '+RTS' ) {",
1100   "     $in_RTS_args = 1;",
1101   "    } elsif ( $a eq '-RTS' ) {",
1102   "     $in_RTS_args = 0;",
1103   "    }",
1104   "    if ( $a eq '-d' && $in_RTS_args ) {",
1105   "     $debug = '-';",
1106   "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
1107   "     $nprocessors = $1;",
1108   "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
1109   "     $nprocessors = $1;",
1110   "    } else {",
1111   "     push(@nonPVM_args, $a);",
1112   "    }",
1113   "}",
1114   "",
1115   "local($return_val) = 0;",
1116   "# Start the parallel execution by calling SysMan",
1117   "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
1118   "$return_val = $?;",
1119   "# ToDo: fix race condition moving files and flushing them!!",
1120   "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
1121   "exit($return_val);"
1122  ]
1123
1124 -----------------------------------------------------------------------------
1125 -- Complain about non-dynamic flags in OPTIONS pragmas
1126
1127 checkProcessArgsResult flags filename
1128   = do when (notNull flags) (throwDyn (ProgramError (
1129           showSDoc (hang (text filename <> char ':')
1130                       4 (text "unknown flags in  {-# OPTIONS #-} pragma:" <+>
1131                           hsep (map text flags)))
1132         )))
1133
1134 -----------------------------------------------------------------------------
1135 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
1136
1137 getHCFilePackages :: FilePath -> IO [PackageId]
1138 getHCFilePackages filename =
1139   Exception.bracket (openFile filename ReadMode) hClose $ \h -> do
1140     l <- hGetLine h
1141     case l of
1142       '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
1143           return (map stringToPackageId (words rest))
1144       _other ->
1145           return []
1146
1147 -----------------------------------------------------------------------------
1148 -- Static linking, of .o files
1149
1150 -- The list of packages passed to link is the list of packages on
1151 -- which this program depends, as discovered by the compilation
1152 -- manager.  It is combined with the list of packages that the user
1153 -- specifies on the command line with -package flags.
1154 --
1155 -- In one-shot linking mode, we can't discover the package
1156 -- dependencies (because we haven't actually done any compilation or
1157 -- read any interface files), so the user must explicitly specify all
1158 -- the packages.
1159
1160 staticLink :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
1161 staticLink dflags o_files dep_packages = do
1162     let verb = getVerbFlag dflags
1163         output_fn = exeFileName dflags
1164
1165     -- get the full list of packages to link with, by combining the
1166     -- explicit packages with the auto packages and all of their
1167     -- dependencies, and eliminating duplicates.
1168
1169     pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1170     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1171
1172     let lib_paths = libraryPaths dflags
1173     let lib_path_opts = map ("-L"++) lib_paths
1174
1175     pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1176
1177 #ifdef darwin_TARGET_OS
1178     pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1179     let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1180
1181     let framework_paths = frameworkPaths dflags
1182         framework_path_opts = map ("-F"++) framework_paths
1183
1184     pkg_frameworks <- getPackageFrameworks dflags dep_packages
1185     let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1186
1187     let frameworks = cmdlineFrameworks dflags
1188         framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1189          -- reverse because they're added in reverse order from the cmd line
1190 #endif
1191
1192         -- probably _stub.o files
1193     extra_ld_inputs <- readIORef v_Ld_inputs
1194
1195         -- opts from -optl-<blah> (including -l<blah> options)
1196     let extra_ld_opts = getOpts dflags opt_l
1197
1198     let ways = wayNames dflags
1199
1200     -- Here are some libs that need to be linked at the *end* of
1201     -- the command line, because they contain symbols that are referred to
1202     -- by the RTS.  We can't therefore use the ordinary way opts for these.
1203     let
1204         debug_opts | WayDebug `elem` ways = [
1205 #if defined(HAVE_LIBBFD)
1206                         "-lbfd", "-liberty"
1207 #endif
1208                          ]
1209                    | otherwise            = []
1210
1211     let
1212         thread_opts | WayThreaded `elem` ways = [
1213 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1214                         "-lpthread"
1215 #endif
1216 #if defined(osf3_TARGET_OS)
1217                         , "-lexc"
1218 #endif
1219                         ]
1220                     | otherwise               = []
1221
1222     let (md_c_flags, _) = machdepCCOpts dflags
1223     SysTools.runLink dflags (
1224                        [ SysTools.Option verb
1225                        , SysTools.Option "-o"
1226                        , SysTools.FileOption "" output_fn
1227                        ]
1228                       ++ map SysTools.Option (
1229                          md_c_flags
1230                       ++ o_files
1231                       ++ extra_ld_inputs
1232                       ++ lib_path_opts
1233                       ++ extra_ld_opts
1234 #ifdef darwin_TARGET_OS
1235                       ++ framework_path_opts
1236                       ++ framework_opts
1237 #endif
1238                       ++ pkg_lib_path_opts
1239                       ++ pkg_link_opts
1240 #ifdef darwin_TARGET_OS
1241                       ++ pkg_framework_path_opts
1242                       ++ pkg_framework_opts
1243 #endif
1244                       ++ debug_opts
1245                       ++ thread_opts
1246                     ))
1247
1248     -- parallel only: move binary to another dir -- HWL
1249     when (WayPar `elem` ways)
1250          (do success <- runPhase_MoveBinary dflags output_fn
1251              if success then return ()
1252                         else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1253
1254
1255 exeFileName :: DynFlags -> FilePath
1256 exeFileName dflags
1257   | Just s <- outputFile dflags =
1258 #if defined(mingw32_HOST_OS)
1259       if null (suffixOf s)
1260         then s `joinFileExt` "exe"
1261         else s
1262 #else
1263       s
1264 #endif
1265   | otherwise =
1266 #if defined(mingw32_HOST_OS)
1267         "main.exe"
1268 #else
1269         "a.out"
1270 #endif
1271
1272 -----------------------------------------------------------------------------
1273 -- Making a DLL (only for Win32)
1274
1275 doMkDLL :: DynFlags -> [String] -> [PackageId] -> IO ()
1276 doMkDLL dflags o_files dep_packages = do
1277     let verb = getVerbFlag dflags
1278     let static = opt_Static
1279     let no_hs_main = dopt Opt_NoHsMain dflags
1280     let o_file = outputFile dflags
1281     let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1282
1283     pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1284     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1285
1286     let lib_paths = libraryPaths dflags
1287     let lib_path_opts = map ("-L"++) lib_paths
1288
1289     pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1290
1291         -- probably _stub.o files
1292     extra_ld_inputs <- readIORef v_Ld_inputs
1293
1294         -- opts from -optdll-<blah>
1295     let extra_ld_opts = getOpts dflags opt_dll
1296
1297     let pstate = pkgState dflags
1298         rts_pkg  = getPackageDetails pstate rtsPackageId
1299         base_pkg = getPackageDetails pstate basePackageId
1300
1301     let extra_os = if static || no_hs_main
1302                    then []
1303                    else [ head (libraryDirs rts_pkg) ++ "/Main.dll_o",
1304                           head (libraryDirs base_pkg) ++ "/PrelMain.dll_o" ]
1305
1306     let (md_c_flags, _) = machdepCCOpts dflags
1307     SysTools.runMkDLL dflags
1308          ([ SysTools.Option verb
1309           , SysTools.Option "-o"
1310           , SysTools.FileOption "" output_fn
1311           ]
1312          ++ map SysTools.Option (
1313             md_c_flags
1314          ++ o_files
1315          ++ extra_os
1316          ++ [ "--target=i386-mingw32" ]
1317          ++ extra_ld_inputs
1318          ++ lib_path_opts
1319          ++ extra_ld_opts
1320          ++ pkg_lib_path_opts
1321          ++ pkg_link_opts
1322          ++ (if "--def" `elem` (concatMap words extra_ld_opts)
1323                then [ "" ]
1324                else [ "--export-all" ])
1325         ))
1326
1327 -- -----------------------------------------------------------------------------
1328 -- Running CPP
1329
1330 doCpp :: DynFlags -> Bool -> Bool -> FilePath -> FilePath -> IO ()
1331 doCpp dflags raw include_cc_opts input_fn output_fn = do
1332     let hscpp_opts = getOpts dflags opt_P
1333     let cmdline_include_paths = includePaths dflags
1334
1335     pkg_include_dirs <- getPackageIncludePath dflags []
1336     let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1337                           (cmdline_include_paths ++ pkg_include_dirs)
1338
1339     let verb = getVerbFlag dflags
1340
1341     let cc_opts
1342           | not include_cc_opts = []
1343           | otherwise           = (optc ++ md_c_flags)
1344                 where
1345                       optc = getOpts dflags opt_c
1346                       (md_c_flags, _) = machdepCCOpts dflags
1347
1348     let cpp_prog args | raw       = SysTools.runCpp dflags args
1349                       | otherwise = SysTools.runCc dflags (SysTools.Option "-E" : args)
1350
1351     let target_defs =
1352           [ "-D" ++ HOST_OS     ++ "_BUILD_OS=1",
1353             "-D" ++ HOST_ARCH   ++ "_BUILD_ARCH=1",
1354             "-D" ++ TARGET_OS   ++ "_HOST_OS=1",
1355             "-D" ++ TARGET_ARCH ++ "_HOST_ARCH=1" ]
1356         -- remember, in code we *compile*, the HOST is the same our TARGET,
1357         -- and BUILD is the same as our HOST.
1358
1359     cpp_prog       ([SysTools.Option verb]
1360                     ++ map SysTools.Option include_paths
1361                     ++ map SysTools.Option hsSourceCppOpts
1362                     ++ map SysTools.Option hscpp_opts
1363                     ++ map SysTools.Option cc_opts
1364                     ++ map SysTools.Option target_defs
1365                     ++ [ SysTools.Option     "-x"
1366                        , SysTools.Option     "c"
1367                        , SysTools.Option     input_fn
1368         -- We hackily use Option instead of FileOption here, so that the file
1369         -- name is not back-slashed on Windows.  cpp is capable of
1370         -- dealing with / in filenames, so it works fine.  Furthermore
1371         -- if we put in backslashes, cpp outputs #line directives
1372         -- with *double* backslashes.   And that in turn means that
1373         -- our error messages get double backslashes in them.
1374         -- In due course we should arrange that the lexer deals
1375         -- with these \\ escapes properly.
1376                        , SysTools.Option     "-o"
1377                        , SysTools.FileOption "" output_fn
1378                        ])
1379
1380 cHaskell1Version = "5" -- i.e., Haskell 98
1381
1382 -- Default CPP defines in Haskell source
1383 hsSourceCppOpts =
1384         [ "-D__HASKELL1__="++cHaskell1Version
1385         , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
1386         , "-D__HASKELL98__"
1387         , "-D__CONCURRENT_HASKELL__"
1388         ]
1389
1390
1391 -- -----------------------------------------------------------------------------
1392 -- Misc.
1393
1394 hscNextPhase :: DynFlags -> HscSource -> HscTarget -> Phase
1395 hscNextPhase dflags HsBootFile hsc_lang  =  StopLn
1396 hscNextPhase dflags other hsc_lang =
1397   case hsc_lang of
1398         HscC -> HCc
1399         HscAsm | dopt Opt_SplitObjs dflags -> SplitMangle
1400                | otherwise -> As
1401         HscNothing     -> StopLn
1402         HscInterpreted -> StopLn
1403         _other         -> StopLn
1404
1405
1406 hscMaybeAdjustTarget :: DynFlags -> Phase -> HscSource -> HscTarget -> HscTarget
1407 hscMaybeAdjustTarget dflags stop HsBootFile current_hsc_lang
1408   = HscNothing          -- No output (other than Foo.hi-boot) for hs-boot files
1409 hscMaybeAdjustTarget dflags stop other current_hsc_lang
1410   = hsc_lang
1411   where
1412         keep_hc = dopt Opt_KeepHcFiles dflags
1413         hsc_lang
1414                 -- don't change the lang if we're interpreting
1415                  | current_hsc_lang == HscInterpreted = current_hsc_lang
1416
1417                 -- force -fvia-C if we are being asked for a .hc file
1418                  | HCc <- stop = HscC
1419                  | keep_hc     = HscC
1420                 -- otherwise, stick to the plan
1421                  | otherwise = current_hsc_lang
1422
1423 GLOBAL_VAR(v_Split_info, ("",0), (String,Int))
1424         -- The split prefix and number of files