compiler/main/DriverPipeline.hs

   1 {-# OPTIONS -fno-cse #-}
   2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
   3
   4 -----------------------------------------------------------------------------
   5 --
   6 -- GHC Driver
   7 --
   8 -- (c) The University of Glasgow 2005
   9 --
  10 -----------------------------------------------------------------------------
  11
  12 module DriverPipeline (
  13         -- Run a series of compilation steps in a pipeline, for a
  14         -- collection of source files.
  15    oneShot, compileFile,
  16
  17         -- Interfaces for the batch-mode driver
  18    linkBinary,
  19
  20         -- Interfaces for the compilation manager (interpreted/batch-mode)
  21    preprocess,
  22    compile, compile',
  23    link,
  24
  25   ) where
  26
  27 #include "HsVersions.h"
  28
  29 import Packages
  30 import HeaderInfo
  31 import DriverPhases
  32 import SysTools
  33 import HscMain
  34 import Finder
  35 import HscTypes
  36 import Outputable
  37 import Module
  38 import LazyUniqFM               ( eltsUFM )
  39 import ErrUtils
  40 import DynFlags
  41 import StaticFlags      ( v_Ld_inputs, opt_Static, WayName(..) )
  42 import Config
  43 import Panic
  44 import Util
  45 import StringBuffer     ( hGetStringBuffer )
  46 import BasicTypes       ( SuccessFlag(..) )
  47 import Maybes           ( expectJust )
  48 import ParserCoreUtils  ( getCoreModuleName )
  49 import SrcLoc
  50 import FastString
  51 -- import MonadUtils
  52
  53 -- import Data.Either
  54 import Exception
  55 import Data.IORef       ( readIORef )
  56 -- import GHC.Exts              ( Int(..) )
  57 import System.Directory
  58 import System.FilePath
  59 import System.IO
  60 import System.IO.Error as IO
  61 import Control.Monad
  62 import Data.List        ( isSuffixOf )
  63 import Data.Maybe
  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 :: GhcMonad m =>
  76               HscEnv
  77            -> (FilePath, Maybe Phase) -- ^ filename and starting phase
  78            -> m (DynFlags, FilePath)
  79 preprocess hsc_env (filename, mb_phase) =
  80   ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename)
  81   runPipeline anyHsc hsc_env (filename, mb_phase)
  82         Nothing Temporary Nothing{-no ModLocation-}
  83
  84 -- ---------------------------------------------------------------------------
  85
  86 -- | Compile
  87 --
  88 -- Compile a single module, under the control of the compilation manager.
  89 --
  90 -- This is the interface between the compilation manager and the
  91 -- compiler proper (hsc), where we deal with tedious details like
  92 -- reading the OPTIONS pragma from the source file, and passing the
  93 -- output of hsc through the C compiler.
  94 --
  95 -- NB.  No old interface can also mean that the source has changed.
  96
  97 compile :: GhcMonad m =>
  98            HscEnv
  99         -> ModSummary      -- ^ summary for module being compiled
 100         -> Int             -- ^ module N ...
 101         -> Int             -- ^ ... of M
 102         -> Maybe ModIface  -- ^ old interface, if we have one
 103         -> Maybe Linkable  -- ^ old linkable, if we have one
 104         -> m HomeModInfo   -- ^ the complete HomeModInfo, if successful
 105
 106 compile = compile' (hscCompileNothing, hscCompileInteractive, hscCompileBatch)
 107
 108 type Compiler m a = HscEnv -> ModSummary -> Bool
 109                   -> Maybe ModIface -> Maybe (Int, Int)
 110                   -> m a
 111
 112 compile' :: GhcMonad m =>
 113            (Compiler m (HscStatus, ModIface, ModDetails),
 114             Compiler m (InteractiveStatus, ModIface, ModDetails),
 115             Compiler m (HscStatus, ModIface, ModDetails))
 116         -> HscEnv
 117         -> ModSummary      -- ^ summary for module being compiled
 118         -> Int             -- ^ module N ...
 119         -> Int             -- ^ ... of M
 120         -> Maybe ModIface  -- ^ old interface, if we have one
 121         -> Maybe Linkable  -- ^ old linkable, if we have one
 122         -> m HomeModInfo   -- ^ the complete HomeModInfo, if successful
 123
 124 compile' (nothingCompiler, interactiveCompiler, batchCompiler)
 125         hsc_env0 summary mod_index nmods mb_old_iface maybe_old_linkable
 126  = do
 127    let dflags0     = ms_hspp_opts summary
 128        this_mod    = ms_mod summary
 129        src_flavour = ms_hsc_src summary
 130        location    = ms_location summary
 131        input_fn    = expectJust "compile:hs" (ml_hs_file location)
 132        input_fnpp  = ms_hspp_file summary
 133
 134    liftIO $ debugTraceMsg dflags0 2 (text "compile: input file" <+> text input_fnpp)
 135
 136    let basename = dropExtension input_fn
 137
 138   -- We add the directory in which the .hs files resides) to the import path.
 139   -- This is needed when we try to compile the .hc file later, if it
 140   -- imports a _stub.h file that we created here.
 141    let current_dir = case takeDirectory basename of
 142                      "" -> "." -- XXX Hack
 143                      d -> d
 144        old_paths   = includePaths dflags0
 145        dflags      = dflags0 { includePaths = current_dir : old_paths }
 146        hsc_env     = hsc_env0 {hsc_dflags = dflags}
 147
 148    -- Figure out what lang we're generating
 149    let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
 150    -- ... and what the next phase should be
 151    let next_phase = hscNextPhase dflags src_flavour hsc_lang
 152    -- ... and what file to generate the output into
 153    output_fn <- liftIO $ getOutputFilename next_phase
 154                         Temporary basename dflags next_phase (Just location)
 155
 156    let dflags' = dflags { hscTarget = hsc_lang,
 157                                 hscOutName = output_fn,
 158                                 extCoreName = basename ++ ".hcr" }
 159    let hsc_env' = hsc_env { hsc_dflags = dflags' }
 160
 161    -- -fforce-recomp should also work with --make
 162    let force_recomp = dopt Opt_ForceRecomp dflags
 163        source_unchanged = isJust maybe_old_linkable && not force_recomp
 164        object_filename = ml_obj_file location
 165
 166    let getStubLinkable False = return []
 167        getStubLinkable True
 168            = do stub_o <- compileStub hsc_env' this_mod location
 169                 return [ DotO stub_o ]
 170
 171        handleBatch HscNoRecomp
 172            = ASSERT (isJust maybe_old_linkable)
 173              return maybe_old_linkable
 174
 175        handleBatch (HscRecomp hasStub _)
 176            | isHsBoot src_flavour
 177                = do when (isObjectTarget hsc_lang) $ -- interpreted reaches here too
 178                        liftIO $ SysTools.touch dflags' "Touching object file"
 179                                    object_filename
 180                     return maybe_old_linkable
 181
 182            | otherwise
 183                = do stub_unlinked <- getStubLinkable hasStub
 184                     (hs_unlinked, unlinked_time) <-
 185                         case hsc_lang of
 186                           HscNothing
 187                             -> return ([], ms_hs_date summary)
 188                           -- We're in --make mode: finish the compilation pipeline.
 189                           _other
 190                             -> do _ <- runPipeline StopLn hsc_env' (output_fn,Nothing)
 191                                               (Just basename)
 192                                               Persistent
 193                                               (Just location)
 194                                   -- The object filename comes from the ModLocation
 195                                   o_time <- liftIO $ getModificationTime object_filename
 196                                   return ([DotO object_filename], o_time)
 197                     let linkable = LM unlinked_time this_mod
 198                                    (hs_unlinked ++ stub_unlinked)
 199                     return (Just linkable)
 200
 201        handleInterpreted HscNoRecomp
 202            = ASSERT (isJust maybe_old_linkable)
 203              return maybe_old_linkable
 204        handleInterpreted (HscRecomp _hasStub Nothing)
 205            = ASSERT (isHsBoot src_flavour)
 206              return maybe_old_linkable
 207        handleInterpreted (HscRecomp hasStub (Just (comp_bc, modBreaks)))
 208            = do stub_unlinked <- getStubLinkable hasStub
 209                 let hs_unlinked = [BCOs comp_bc modBreaks]
 210                     unlinked_time = ms_hs_date summary
 211                   -- Why do we use the timestamp of the source file here,
 212                   -- rather than the current time?  This works better in
 213                   -- the case where the local clock is out of sync
 214                   -- with the filesystem's clock.  It's just as accurate:
 215                   -- if the source is modified, then the linkable will
 216                   -- be out of date.
 217                 let linkable = LM unlinked_time this_mod
 218                                (hs_unlinked ++ stub_unlinked)
 219                 return (Just linkable)
 220
 221    let -- runCompiler :: Compiler result -> (result -> Maybe Linkable)
 222        --            -> m HomeModInfo
 223        runCompiler compiler handle
 224            = do (result, iface, details)
 225                     <- compiler hsc_env' summary source_unchanged mb_old_iface
 226                                 (Just (mod_index, nmods))
 227                 linkable <- handle result
 228                 return (HomeModInfo{ hm_details  = details,
 229                                      hm_iface    = iface,
 230                                      hm_linkable = linkable })
 231    -- run the compiler
 232    case hsc_lang of
 233       HscInterpreted ->
 234                 runCompiler interactiveCompiler handleInterpreted
 235       HscNothing ->
 236                 runCompiler nothingCompiler handleBatch
 237       _other ->
 238                 runCompiler batchCompiler handleBatch
 239
 240
 241 -----------------------------------------------------------------------------
 242 -- stub .h and .c files (for foreign export support)
 243
 244 -- The _stub.c file is derived from the haskell source file, possibly taking
 245 -- into account the -stubdir option.
 246 --
 247 -- Consequently, we derive the _stub.o filename from the haskell object
 248 -- filename.
 249 --
 250 -- This isn't necessarily the same as the object filename we
 251 -- would get if we just compiled the _stub.c file using the pipeline.
 252 -- For example:
 253 --
 254 --    ghc src/A.hs -odir obj
 255 --
 256 -- results in obj/A.o, and src/A_stub.c.  If we compile src/A_stub.c with
 257 -- -odir obj, we would get obj/src/A_stub.o, which is wrong; we want
 258 -- obj/A_stub.o.
 259
 260 compileStub :: GhcMonad m => HscEnv -> Module -> ModLocation
 261             -> m FilePath
 262 compileStub hsc_env mod location = do
 263         -- compile the _stub.c file w/ gcc
 264         let (stub_c,_,stub_o) = mkStubPaths (hsc_dflags hsc_env)
 265                                    (moduleName mod) location
 266
 267         _ <- runPipeline StopLn hsc_env (stub_c,Nothing)  Nothing
 268                 (SpecificFile stub_o) Nothing{-no ModLocation-}
 269
 270         return stub_o
 271
 272
 273 -- ---------------------------------------------------------------------------
 274 -- Link
 275
 276 link :: GhcLink                 -- interactive or batch
 277      -> DynFlags                -- dynamic flags
 278      -> Bool                    -- attempt linking in batch mode?
 279      -> HomePackageTable        -- what to link
 280      -> IO SuccessFlag
 281
 282 -- For the moment, in the batch linker, we don't bother to tell doLink
 283 -- which packages to link -- it just tries all that are available.
 284 -- batch_attempt_linking should only be *looked at* in batch mode.  It
 285 -- should only be True if the upsweep was successful and someone
 286 -- exports main, i.e., we have good reason to believe that linking
 287 -- will succeed.
 288
 289 #ifdef GHCI
 290 link LinkInMemory _ _ _
 291     = do -- Not Linking...(demand linker will do the job)
 292          return Succeeded
 293 #endif
 294
 295 link NoLink _ _ _
 296    = return Succeeded
 297
 298 link LinkBinary dflags batch_attempt_linking hpt
 299    = link' dflags batch_attempt_linking hpt
 300
 301 link LinkDynLib dflags batch_attempt_linking hpt
 302    = link' dflags batch_attempt_linking hpt
 303
 304 #ifndef GHCI
 305 -- warning suppression
 306 link other _ _ _ = panicBadLink other
 307 #endif
 308
 309 panicBadLink :: GhcLink -> a
 310 panicBadLink other = panic ("link: GHC not built to link this way: " ++
 311                             show other)
 312
 313 link' :: DynFlags                -- dynamic flags
 314       -> Bool                    -- attempt linking in batch mode?
 315       -> HomePackageTable        -- what to link
 316       -> IO SuccessFlag
 317
 318 link' dflags batch_attempt_linking hpt
 319    | batch_attempt_linking
 320    = do
 321         let
 322             home_mod_infos = eltsUFM hpt
 323
 324             -- the packages we depend on
 325             pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
 326
 327             -- the linkables to link
 328             linkables = map (expectJust "link".hm_linkable) home_mod_infos
 329
 330         debugTraceMsg dflags 3 (text "link: linkables are ..." $$ vcat (map ppr linkables))
 331
 332         -- check for the -no-link flag
 333         if isNoLink (ghcLink dflags)
 334           then do debugTraceMsg dflags 3 (text "link(batch): linking omitted (-c flag given).")
 335                   return Succeeded
 336           else do
 337
 338         let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
 339             obj_files = concatMap getOfiles linkables
 340
 341             exe_file = exeFileName dflags
 342
 343         linking_needed <- linkingNeeded dflags linkables pkg_deps
 344
 345         if not (dopt Opt_ForceRecomp dflags) && not linking_needed
 346            then do debugTraceMsg dflags 2 (text exe_file <+> ptext (sLit "is up to date, linking not required."))
 347                    return Succeeded
 348            else do
 349
 350         debugTraceMsg dflags 1 (ptext (sLit "Linking") <+> text exe_file
 351                                  <+> text "...")
 352
 353         -- Don't showPass in Batch mode; doLink will do that for us.
 354         let link = case ghcLink dflags of
 355                 LinkBinary  -> linkBinary
 356                 LinkDynLib  -> linkDynLib
 357                 other       -> panicBadLink other
 358         link dflags obj_files pkg_deps
 359
 360         debugTraceMsg dflags 3 (text "link: done")
 361
 362         -- linkBinary only returns if it succeeds
 363         return Succeeded
 364
 365    | otherwise
 366    = do debugTraceMsg dflags 3 (text "link(batch): upsweep (partially) failed OR" $$
 367                                 text "   Main.main not exported; not linking.")
 368         return Succeeded
 369
 370
 371 linkingNeeded :: DynFlags -> [Linkable] -> [PackageId] -> IO Bool
 372 linkingNeeded dflags linkables pkg_deps = do
 373         -- if the modification time on the executable is later than the
 374         -- modification times on all of the objects and libraries, then omit
 375         -- linking (unless the -fforce-recomp flag was given).
 376   let exe_file = exeFileName dflags
 377   e_exe_time <- IO.try $ getModificationTime exe_file
 378   case e_exe_time of
 379     Left _  -> return True
 380     Right t -> do
 381         -- first check object files and extra_ld_inputs
 382         extra_ld_inputs <- readIORef v_Ld_inputs
 383         e_extra_times <- mapM (IO.try . getModificationTime) extra_ld_inputs
 384         let (errs,extra_times) = splitEithers e_extra_times
 385         let obj_times =  map linkableTime linkables ++ extra_times
 386         if not (null errs) || any (t <) obj_times
 387             then return True
 388             else do
 389
 390         -- next, check libraries. XXX this only checks Haskell libraries,
 391         -- not extra_libraries or -l things from the command line.
 392         let pkg_map = pkgIdMap (pkgState dflags)
 393             pkg_hslibs  = [ (libraryDirs c, lib)
 394                           | Just c <- map (lookupPackage pkg_map) pkg_deps,
 395                             lib <- packageHsLibs dflags c ]
 396
 397         pkg_libfiles <- mapM (uncurry findHSLib) pkg_hslibs
 398         if any isNothing pkg_libfiles then return True else do
 399         e_lib_times <- mapM (IO.try . getModificationTime)
 400                           (catMaybes pkg_libfiles)
 401         let (lib_errs,lib_times) = splitEithers e_lib_times
 402         if not (null lib_errs) || any (t <) lib_times
 403            then return True
 404            else return False
 405
 406 findHSLib :: [String] -> String -> IO (Maybe FilePath)
 407 findHSLib dirs lib = do
 408   let batch_lib_file = "lib" ++ lib <.> "a"
 409   found <- filterM doesFileExist (map (</> batch_lib_file) dirs)
 410   case found of
 411     [] -> return Nothing
 412     (x:_) -> return (Just x)
 413
 414 -- -----------------------------------------------------------------------------
 415 -- Compile files in one-shot mode.
 416
 417 oneShot :: GhcMonad m =>
 418            HscEnv -> Phase -> [(String, Maybe Phase)] -> m ()
 419 oneShot hsc_env stop_phase srcs = do
 420   o_files <- mapM (compileFile hsc_env stop_phase) srcs
 421   liftIO $ doLink (hsc_dflags hsc_env) stop_phase o_files
 422
 423 compileFile :: GhcMonad m =>
 424                HscEnv -> Phase -> (FilePath, Maybe Phase) -> m FilePath
 425 compileFile hsc_env stop_phase (src, mb_phase) = do
 426    exists <- liftIO $ doesFileExist src
 427    when (not exists) $
 428         ghcError (CmdLineError ("does not exist: " ++ src))
 429
 430    let
 431         dflags = hsc_dflags hsc_env
 432         split     = dopt Opt_SplitObjs dflags
 433         mb_o_file = outputFile dflags
 434         ghc_link  = ghcLink dflags      -- Set by -c or -no-link
 435
 436         -- When linking, the -o argument refers to the linker's output.
 437         -- otherwise, we use it as the name for the pipeline's output.
 438         output
 439          | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
 440                 -- -o foo applies to linker
 441          | Just o_file <- mb_o_file = SpecificFile o_file
 442                 -- -o foo applies to the file we are compiling now
 443          | otherwise = Persistent
 444
 445         stop_phase' = case stop_phase of
 446                         As | split -> SplitAs
 447                         _          -> stop_phase
 448
 449    ( _, out_file) <- runPipeline stop_phase' hsc_env
 450                             (src, mb_phase) Nothing output
 451                             Nothing{-no ModLocation-}
 452    return out_file
 453
 454
 455 doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
 456 doLink dflags stop_phase o_files
 457   | not (isStopLn stop_phase)
 458   = return ()           -- We stopped before the linking phase
 459
 460   | otherwise
 461   = case ghcLink dflags of
 462         NoLink     -> return ()
 463         LinkBinary -> linkBinary dflags o_files link_pkgs
 464         LinkDynLib -> linkDynLib dflags o_files []
 465         other      -> panicBadLink other
 466   where
 467    -- Always link in the haskell98 package for static linking.  Other
 468    -- packages have to be specified via the -package flag.
 469     link_pkgs
 470      | dopt Opt_AutoLinkPackages dflags = [haskell98PackageId]
 471      | otherwise                        = []
 472
 473
 474 -- ---------------------------------------------------------------------------
 475
 476 data PipelineOutput
 477   = Temporary
 478         -- ^ Output should be to a temporary file: we're going to
 479         -- run more compilation steps on this output later.
 480   | Persistent
 481         -- ^ We want a persistent file, i.e. a file in the current directory
 482         -- derived from the input filename, but with the appropriate extension.
 483         -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
 484   | SpecificFile FilePath
 485         -- ^ The output must go into the specified file.
 486
 487 -- | Run a compilation pipeline, consisting of multiple phases.
 488 --
 489 -- This is the interface to the compilation pipeline, which runs
 490 -- a series of compilation steps on a single source file, specifying
 491 -- at which stage to stop.
 492 --
 493 -- The DynFlags can be modified by phases in the pipeline (eg. by
 494 -- OPTIONS_GHC pragmas), and the changes affect later phases in the
 495 -- pipeline.
 496 runPipeline
 497   :: GhcMonad m =>
 498      Phase                      -- ^ When to stop
 499   -> HscEnv                     -- ^ Compilation environment
 500   -> (FilePath,Maybe Phase)     -- ^ Input filename (and maybe -x suffix)
 501   -> Maybe FilePath             -- ^ original basename (if different from ^^^)
 502   -> PipelineOutput             -- ^ Output filename
 503   -> Maybe ModLocation          -- ^ A ModLocation, if this is a Haskell module
 504   -> m (DynFlags, FilePath)     -- ^ (final flags, output filename)
 505
 506 runPipeline stop_phase hsc_env0 (input_fn, mb_phase) mb_basename output maybe_loc
 507   = do
 508   let dflags0 = hsc_dflags hsc_env0
 509       (input_basename, suffix) = splitExtension input_fn
 510       suffix' = drop 1 suffix -- strip off the .
 511       basename | Just b <- mb_basename = b
 512                | otherwise             = input_basename
 513
 514       -- Decide where dump files should go based on the pipeline output
 515       dflags = dflags0 { dumpPrefix = Just (basename ++ ".") }
 516       hsc_env = hsc_env0 {hsc_dflags = dflags}
 517
 518         -- If we were given a -x flag, then use that phase to start from
 519       start_phase = fromMaybe (startPhase suffix') mb_phase
 520
 521   -- We want to catch cases of "you can't get there from here" before
 522   -- we start the pipeline, because otherwise it will just run off the
 523   -- end.
 524   --
 525   -- There is a partial ordering on phases, where A < B iff A occurs
 526   -- before B in a normal compilation pipeline.
 527
 528   when (not (start_phase `happensBefore` stop_phase)) $
 529         ghcError (UsageError
 530                     ("cannot compile this file to desired target: "
 531                        ++ input_fn))
 532
 533   -- this is a function which will be used to calculate output file names
 534   -- as we go along (we partially apply it to some of its inputs here)
 535   let get_output_fn = getOutputFilename stop_phase output basename
 536
 537   -- Execute the pipeline...
 538   (dflags', output_fn, maybe_loc) <-
 539         pipeLoop hsc_env start_phase stop_phase input_fn
 540                  basename suffix' get_output_fn maybe_loc
 541
 542   -- Sometimes, a compilation phase doesn't actually generate any output
 543   -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
 544   -- stage, but we wanted to keep the output, then we have to explicitly
 545   -- copy the file, remembering to prepend a {-# LINE #-} pragma so that
 546   -- further compilation stages can tell what the original filename was.
 547   case output of
 548     Temporary ->
 549         return (dflags', output_fn)
 550     _other -> liftIO $
 551         do final_fn <- get_output_fn dflags' stop_phase maybe_loc
 552            when (final_fn /= output_fn) $ do
 553               let msg = ("Copying `" ++ output_fn ++"' to `" ++ final_fn ++ "'")
 554                   line_prag = Just ("{-# LINE 1 \"" ++ input_fn ++ "\" #-}\n")
 555               copyWithHeader dflags msg line_prag output_fn final_fn
 556            return (dflags', final_fn)
 557
 558
 559
 560 pipeLoop :: GhcMonad m =>
 561             HscEnv -> Phase -> Phase
 562          -> FilePath  -> String -> Suffix
 563          -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
 564          -> Maybe ModLocation
 565          -> m (DynFlags, FilePath, Maybe ModLocation)
 566
 567 pipeLoop hsc_env phase stop_phase
 568          input_fn orig_basename orig_suff
 569          orig_get_output_fn maybe_loc
 570
 571   | phase `eqPhase` stop_phase            -- All done
 572   = return (hsc_dflags hsc_env, input_fn, maybe_loc)
 573
 574   | not (phase `happensBefore` stop_phase)
 575         -- Something has gone wrong.  We'll try to cover all the cases when
 576         -- this could happen, so if we reach here it is a panic.
 577         -- eg. it might happen if the -C flag is used on a source file that
 578         -- has {-# OPTIONS -fasm #-}.
 579   = panic ("pipeLoop: at phase " ++ show phase ++
 580            " but I wanted to stop at phase " ++ show stop_phase)
 581
 582   | otherwise
 583   = do (next_phase, dflags', maybe_loc, output_fn)
 584           <- runPhase phase stop_phase hsc_env orig_basename
 585                       orig_suff input_fn orig_get_output_fn maybe_loc
 586        let hsc_env' = hsc_env {hsc_dflags = dflags'}
 587        pipeLoop hsc_env' next_phase stop_phase output_fn
 588                 orig_basename orig_suff orig_get_output_fn maybe_loc
 589
 590 getOutputFilename
 591   :: Phase -> PipelineOutput -> String
 592   -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
 593 getOutputFilename stop_phase output basename
 594  = func
 595  where
 596         func dflags next_phase maybe_location
 597            | is_last_phase, Persistent <- output     = persistent_fn
 598            | is_last_phase, SpecificFile f <- output = return f
 599            | keep_this_output                        = persistent_fn
 600            | otherwise                               = newTempName dflags suffix
 601            where
 602                 hcsuf      = hcSuf dflags
 603                 odir       = objectDir dflags
 604                 osuf       = objectSuf dflags
 605                 keep_hc    = dopt Opt_KeepHcFiles dflags
 606                 keep_raw_s = dopt Opt_KeepRawSFiles dflags
 607                 keep_s     = dopt Opt_KeepSFiles dflags
 608
 609                 myPhaseInputExt HCc    = hcsuf
 610                 myPhaseInputExt StopLn = osuf
 611                 myPhaseInputExt other  = phaseInputExt other
 612
 613                 is_last_phase = next_phase `eqPhase` stop_phase
 614
 615                 -- sometimes, we keep output from intermediate stages
 616                 keep_this_output =
 617                      case next_phase of
 618                              StopLn              -> True
 619                              Mangle | keep_raw_s -> True
 620                              As     | keep_s     -> True
 621                              HCc    | keep_hc    -> True
 622                              _other              -> False
 623
 624                 suffix = myPhaseInputExt next_phase
 625
 626                 -- persistent object files get put in odir
 627                 persistent_fn
 628                    | StopLn <- next_phase = return odir_persistent
 629                    | otherwise            = return persistent
 630
 631                 persistent = basename <.> suffix
 632
 633                 odir_persistent
 634                    | Just loc <- maybe_location = ml_obj_file loc
 635                    | Just d <- odir = d </> persistent
 636                    | otherwise      = persistent
 637
 638
 639 -- -----------------------------------------------------------------------------
 640 -- | Each phase in the pipeline returns the next phase to execute, and the
 641 -- name of the file in which the output was placed.
 642 --
 643 -- We must do things dynamically this way, because we often don't know
 644 -- what the rest of the phases will be until part-way through the
 645 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
 646 -- of a source file can change the latter stages of the pipeline from
 647 -- taking the via-C route to using the native code generator.
 648 --
 649 runPhase :: GhcMonad m =>
 650             Phase       -- ^ Do this phase first
 651          -> Phase       -- ^ Stop just before this phase
 652          -> HscEnv
 653          -> String      -- ^ basename of original input source
 654          -> String      -- ^ its extension
 655          -> FilePath    -- ^ name of file which contains the input to this phase.
 656          -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
 657                         -- ^ how to calculate the output filename
 658          -> Maybe ModLocation           -- ^ the ModLocation, if we have one
 659          -> m (Phase,                   -- next phase
 660                DynFlags,                -- new dynamic flags
 661                Maybe ModLocation,       -- the ModLocation, if we have one
 662                FilePath)                -- output filename
 663
 664         -- Invariant: the output filename always contains the output
 665         -- Interesting case: Hsc when there is no recompilation to do
 666         --                   Then the output filename is still a .o file
 667
 668 -------------------------------------------------------------------------------
 669 -- Unlit phase
 670
 671 runPhase (Unlit sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
 672   = do
 673        let dflags = hsc_dflags hsc_env
 674        output_fn <- liftIO $ get_output_fn dflags (Cpp sf) maybe_loc
 675
 676        let unlit_flags = getOpts dflags opt_L
 677            flags = map SysTools.Option unlit_flags ++
 678                    [ -- The -h option passes the file name for unlit to
 679                      -- put in a #line directive
 680                      SysTools.Option     "-h"
 681                      -- cpp interprets \b etc as escape sequences,
 682                      -- so we use / for filenames in pragmas
 683                    , SysTools.Option $ reslash Forwards $ normalise input_fn
 684                    , SysTools.FileOption "" input_fn
 685                    , SysTools.FileOption "" output_fn
 686                    ]
 687
 688        liftIO $ SysTools.runUnlit dflags flags
 689
 690        return (Cpp sf, dflags, maybe_loc, output_fn)
 691
 692 -------------------------------------------------------------------------------
 693 -- Cpp phase : (a) gets OPTIONS out of file
 694 --             (b) runs cpp if necessary
 695
 696 runPhase (Cpp sf) _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
 697   = do let dflags0 = hsc_dflags hsc_env
 698        src_opts <- liftIO $ getOptionsFromFile dflags0 input_fn
 699        (dflags, unhandled_flags, warns)
 700            <- liftIO $ parseDynamicNoPackageFlags dflags0 src_opts
 701        handleFlagWarnings dflags warns
 702        checkProcessArgsResult unhandled_flags
 703
 704        if not (dopt Opt_Cpp dflags) then
 705            -- no need to preprocess CPP, just pass input file along
 706            -- to the next phase of the pipeline.
 707           return (HsPp sf, dflags, maybe_loc, input_fn)
 708         else do
 709             output_fn <- liftIO $ get_output_fn dflags (HsPp sf) maybe_loc
 710             liftIO $ doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
 711             return (HsPp sf, dflags, maybe_loc, output_fn)
 712
 713 -------------------------------------------------------------------------------
 714 -- HsPp phase
 715
 716 runPhase (HsPp sf) _stop hsc_env basename suff input_fn get_output_fn maybe_loc
 717   = do let dflags = hsc_dflags hsc_env
 718        if not (dopt Opt_Pp dflags) then
 719            -- no need to preprocess, just pass input file along
 720            -- to the next phase of the pipeline.
 721           return (Hsc sf, dflags, maybe_loc, input_fn)
 722         else do
 723             let hspp_opts = getOpts dflags opt_F
 724             let orig_fn = basename <.> suff
 725             output_fn <- liftIO $ get_output_fn dflags (Hsc sf) maybe_loc
 726             liftIO $ SysTools.runPp dflags
 727                            ( [ SysTools.Option     orig_fn
 728                              , SysTools.Option     input_fn
 729                              , SysTools.FileOption "" output_fn
 730                              ] ++
 731                              map SysTools.Option hspp_opts
 732                            )
 733             return (Hsc sf, dflags, maybe_loc, output_fn)
 734
 735 -----------------------------------------------------------------------------
 736 -- Hsc phase
 737
 738 -- Compilation of a single module, in "legacy" mode (_not_ under
 739 -- the direction of the compilation manager).
 740 runPhase (Hsc src_flavour) stop hsc_env basename suff input_fn get_output_fn _maybe_loc
 741  = do   -- normal Hsc mode, not mkdependHS
 742         let dflags0 = hsc_dflags hsc_env
 743
 744   -- we add the current directory (i.e. the directory in which
 745   -- the .hs files resides) to the include path, since this is
 746   -- what gcc does, and it's probably what you want.
 747         let current_dir = case takeDirectory basename of
 748                       "" -> "." -- XXX Hack
 749                       d -> d
 750
 751             paths = includePaths dflags0
 752             dflags = dflags0 { includePaths = current_dir : paths }
 753
 754   -- gather the imports and module name
 755         (hspp_buf,mod_name,imps,src_imps) <-
 756             case src_flavour of
 757                 ExtCoreFile -> do  -- no explicit imports in ExtCore input.
 758                     m <- liftIO $ getCoreModuleName input_fn
 759                     return (Nothing, mkModuleName m, [], [])
 760
 761                 _           -> do
 762                     buf <- liftIO $ hGetStringBuffer input_fn
 763                     (src_imps,imps,L _ mod_name) <- getImports dflags buf input_fn (basename <.> suff)
 764                     return (Just buf, mod_name, imps, src_imps)
 765
 766   -- Build a ModLocation to pass to hscMain.
 767   -- The source filename is rather irrelevant by now, but it's used
 768   -- by hscMain for messages.  hscMain also needs
 769   -- the .hi and .o filenames, and this is as good a way
 770   -- as any to generate them, and better than most. (e.g. takes
 771   -- into accout the -osuf flags)
 772         location1 <- liftIO $ mkHomeModLocation2 dflags mod_name basename suff
 773
 774   -- Boot-ify it if necessary
 775         let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
 776                       | otherwise            = location1
 777
 778
 779   -- Take -ohi into account if present
 780   -- This can't be done in mkHomeModuleLocation because
 781   -- it only applies to the module being compiles
 782         let ohi = outputHi dflags
 783             location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
 784                       | otherwise      = location2
 785
 786   -- Take -o into account if present
 787   -- Very like -ohi, but we must *only* do this if we aren't linking
 788   -- (If we're linking then the -o applies to the linked thing, not to
 789   -- the object file for one module.)
 790   -- Note the nasty duplication with the same computation in compileFile above
 791         let expl_o_file = outputFile dflags
 792             location4 | Just ofile <- expl_o_file
 793                       , isNoLink (ghcLink dflags)
 794                       = location3 { ml_obj_file = ofile }
 795                       | otherwise = location3
 796
 797             o_file = ml_obj_file location4      -- The real object file
 798
 799
 800   -- Figure out if the source has changed, for recompilation avoidance.
 801   --
 802   -- Setting source_unchanged to True means that M.o seems
 803   -- to be up to date wrt M.hs; so no need to recompile unless imports have
 804   -- changed (which the compiler itself figures out).
 805   -- Setting source_unchanged to False tells the compiler that M.o is out of
 806   -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
 807         src_timestamp <- liftIO $ getModificationTime (basename <.> suff)
 808
 809         let force_recomp = dopt Opt_ForceRecomp dflags
 810         source_unchanged <-
 811           if force_recomp || not (isStopLn stop)
 812                 -- Set source_unchanged to False unconditionally if
 813                 --      (a) recompilation checker is off, or
 814                 --      (b) we aren't going all the way to .o file (e.g. ghc -S)
 815              then return False
 816                 -- Otherwise look at file modification dates
 817              else do o_file_exists <- liftIO $ doesFileExist o_file
 818                      if not o_file_exists
 819                         then return False       -- Need to recompile
 820                         else do t2 <- liftIO $ getModificationTime o_file
 821                                 if t2 > src_timestamp
 822                                   then return True
 823                                   else return False
 824
 825   -- get the DynFlags
 826         let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
 827         let next_phase = hscNextPhase dflags src_flavour hsc_lang
 828         output_fn  <- liftIO $ get_output_fn dflags next_phase (Just location4)
 829
 830         let dflags' = dflags { hscTarget = hsc_lang,
 831                                hscOutName = output_fn,
 832                                extCoreName = basename ++ ".hcr" }
 833
 834         let hsc_env' = hsc_env {hsc_dflags = dflags'}
 835
 836   -- Tell the finder cache about this module
 837         mod <- liftIO $ addHomeModuleToFinder hsc_env' mod_name location4
 838
 839   -- Make the ModSummary to hand to hscMain
 840         let
 841             mod_summary = ModSummary {  ms_mod       = mod,
 842                                         ms_hsc_src   = src_flavour,
 843                                         ms_hspp_file = input_fn,
 844                                         ms_hspp_opts = dflags,
 845                                         ms_hspp_buf  = hspp_buf,
 846                                         ms_location  = location4,
 847                                         ms_hs_date   = src_timestamp,
 848                                         ms_obj_date  = Nothing,
 849                                         ms_imps      = imps,
 850                                         ms_srcimps   = src_imps }
 851
 852   -- run the compiler!
 853         result <- hscCompileOneShot hsc_env'
 854                           mod_summary source_unchanged
 855                           Nothing       -- No iface
 856                           Nothing       -- No "module i of n" progress info
 857
 858         case result of
 859           HscNoRecomp
 860               -> do liftIO $ SysTools.touch dflags' "Touching object file" o_file
 861                     -- The .o file must have a later modification date
 862                     -- than the source file (else we wouldn't be in HscNoRecomp)
 863                     -- but we touch it anyway, to keep 'make' happy (we think).
 864                     return (StopLn, dflags', Just location4, o_file)
 865           (HscRecomp hasStub _)
 866               -> do when hasStub $
 867                          do stub_o <- compileStub hsc_env' mod location4
 868                             liftIO $ consIORef v_Ld_inputs stub_o
 869                     -- In the case of hs-boot files, generate a dummy .o-boot
 870                     -- stamp file for the benefit of Make
 871                     when (isHsBoot src_flavour) $
 872                       liftIO $ SysTools.touch dflags' "Touching object file" o_file
 873                     return (next_phase, dflags', Just location4, output_fn)
 874
 875 -----------------------------------------------------------------------------
 876 -- Cmm phase
 877
 878 runPhase CmmCpp _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
 879   = do
 880        let dflags = hsc_dflags hsc_env
 881        output_fn <- liftIO $ get_output_fn dflags Cmm maybe_loc
 882        liftIO $ doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
 883        return (Cmm, dflags, maybe_loc, output_fn)
 884
 885 runPhase Cmm stop hsc_env basename _ input_fn get_output_fn maybe_loc
 886   = do
 887         let dflags = hsc_dflags hsc_env
 888         let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
 889         let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
 890         output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
 891
 892         let dflags' = dflags { hscTarget = hsc_lang,
 893                                hscOutName = output_fn,
 894                                extCoreName = basename ++ ".hcr" }
 895         let hsc_env' = hsc_env {hsc_dflags = dflags'}
 896
 897         hscCmmFile hsc_env' input_fn
 898
 899         -- XXX: catch errors above and convert them into ghcError?  Original
 900         -- code was:
 901         --
 902         --when (not ok) $ ghcError (PhaseFailed "cmm" (ExitFailure 1))
 903
 904         return (next_phase, dflags, maybe_loc, output_fn)
 905
 906 -----------------------------------------------------------------------------
 907 -- Cc phase
 908
 909 -- we don't support preprocessing .c files (with -E) now.  Doing so introduces
 910 -- way too many hacks, and I can't say I've ever used it anyway.
 911
 912 runPhase cc_phase _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
 913    | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
 914    = do let dflags = hsc_dflags hsc_env
 915         let cc_opts = getOpts dflags opt_c
 916             hcc = cc_phase `eqPhase` HCc
 917
 918         let cmdline_include_paths = includePaths dflags
 919
 920         -- HC files have the dependent packages stamped into them
 921         pkgs <- if hcc then liftIO (getHCFilePackages input_fn) else return []
 922
 923         -- add package include paths even if we're just compiling .c
 924         -- files; this is the Value Add(TM) that using ghc instead of
 925         -- gcc gives you :)
 926         pkg_include_dirs <- liftIO $ getPackageIncludePath dflags pkgs
 927         let include_paths = foldr (\ x xs -> "-I" : x : xs) []
 928                               (cmdline_include_paths ++ pkg_include_dirs)
 929
 930         let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
 931         gcc_extra_viac_flags <- liftIO $ getExtraViaCOpts dflags
 932         let pic_c_flags = picCCOpts dflags
 933
 934         let verb = getVerbFlag dflags
 935
 936         -- cc-options are not passed when compiling .hc files.  Our
 937         -- hc code doesn't not #include any header files anyway, so these
 938         -- options aren't necessary.
 939         pkg_extra_cc_opts <-
 940           if cc_phase `eqPhase` HCc
 941              then return []
 942              else liftIO $ getPackageExtraCcOpts dflags pkgs
 943
 944 #ifdef darwin_TARGET_OS
 945         pkg_framework_paths <- liftIO $ getPackageFrameworkPath dflags pkgs
 946         let cmdline_framework_paths = frameworkPaths dflags
 947         let framework_paths = map ("-F"++)
 948                         (cmdline_framework_paths ++ pkg_framework_paths)
 949 #endif
 950
 951         let split_objs = dopt Opt_SplitObjs dflags
 952             split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
 953                       | otherwise         = [ ]
 954
 955         let cc_opt | optLevel dflags >= 2 = "-O2"
 956                    | otherwise            = "-O"
 957
 958         -- Decide next phase
 959
 960         let mangle = dopt Opt_DoAsmMangling dflags
 961             next_phase
 962                 | hcc && mangle     = Mangle
 963                 | otherwise         = As
 964         output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
 965
 966         let
 967           more_hcc_opts =
 968 #if i386_TARGET_ARCH
 969                 -- on x86 the floating point regs have greater precision
 970                 -- than a double, which leads to unpredictable results.
 971                 -- By default, we turn this off with -ffloat-store unless
 972                 -- the user specified -fexcess-precision.
 973                 (if dopt Opt_ExcessPrecision dflags
 974                         then []
 975                         else [ "-ffloat-store" ]) ++
 976 #endif
 977                 -- gcc's -fstrict-aliasing allows two accesses to memory
 978                 -- to be considered non-aliasing if they have different types.
 979                 -- This interacts badly with the C code we generate, which is
 980                 -- very weakly typed, being derived from C--.
 981                 ["-fno-strict-aliasing"]
 982
 983
 984
 985         liftIO $ SysTools.runCc dflags (
 986                 -- force the C compiler to interpret this file as C when
 987                 -- compiling .hc files, by adding the -x c option.
 988                 -- Also useful for plain .c files, just in case GHC saw a
 989                 -- -x c option.
 990                         [ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
 991                                                 then SysTools.Option "c++"
 992                                                 else SysTools.Option "c"] ++
 993                         [ SysTools.FileOption "" input_fn
 994                         , SysTools.Option "-o"
 995                         , SysTools.FileOption "" output_fn
 996                         ]
 997                        ++ map SysTools.Option (
 998                           md_c_flags
 999                        ++ pic_c_flags
1000 #ifdef sparc_TARGET_ARCH
1001         -- We only support SparcV9 and better because V8 lacks an atomic CAS
1002         -- instruction. Note that the user can still override this
1003         -- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
1004         -- regardless of the ordering.
1005         --
1006         -- This is a temporary hack.
1007                        ++ ["-mcpu=v9"]
1008 #endif
1009                        ++ (if hcc && mangle
1010                              then md_regd_c_flags
1011                              else [])
1012                        ++ (if hcc
1013                              then if mangle
1014                                      then gcc_extra_viac_flags
1015                                      else filter (=="-fwrapv")
1016                                                 gcc_extra_viac_flags
1017                                 -- still want -fwrapv even for unreg'd
1018                              else [])
1019                        ++ (if hcc
1020                              then more_hcc_opts
1021                              else [])
1022                        ++ [ verb, "-S", "-Wimplicit", cc_opt ]
1023                        ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
1024 #ifdef darwin_TARGET_OS
1025                        ++ framework_paths
1026 #endif
1027                        ++ cc_opts
1028                        ++ split_opt
1029                        ++ include_paths
1030                        ++ pkg_extra_cc_opts
1031                        ))
1032
1033         return (next_phase, dflags, maybe_loc, output_fn)
1034
1035         -- ToDo: postprocess the output from gcc
1036
1037 -----------------------------------------------------------------------------
1038 -- Mangle phase
1039
1040 runPhase Mangle _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
1041    = do let dflags = hsc_dflags hsc_env
1042         let mangler_opts = getOpts dflags opt_m
1043
1044 #if i386_TARGET_ARCH
1045         machdep_opts <- return [ show (stolen_x86_regs dflags) ]
1046 #else
1047         machdep_opts <- return []
1048 #endif
1049
1050         let split = dopt Opt_SplitObjs dflags
1051             next_phase
1052                 | split = SplitMangle
1053                 | otherwise = As
1054         output_fn <- liftIO $ get_output_fn dflags next_phase maybe_loc
1055
1056         liftIO $ SysTools.runMangle dflags (map SysTools.Option mangler_opts
1057                           ++ [ SysTools.FileOption "" input_fn
1058                              , SysTools.FileOption "" output_fn
1059                              ]
1060                           ++ map SysTools.Option machdep_opts)
1061
1062         return (next_phase, dflags, maybe_loc, output_fn)
1063
1064 -----------------------------------------------------------------------------
1065 -- Splitting phase
1066
1067 runPhase SplitMangle _stop hsc_env _basename _suff input_fn _get_output_fn maybe_loc
1068   = liftIO $
1069     do  -- tmp_pfx is the prefix used for the split .s files
1070         -- We also use it as the file to contain the no. of split .s files (sigh)
1071         let dflags = hsc_dflags hsc_env
1072         split_s_prefix <- SysTools.newTempName dflags "split"
1073         let n_files_fn = split_s_prefix
1074
1075         SysTools.runSplit dflags
1076                           [ SysTools.FileOption "" input_fn
1077                           , SysTools.FileOption "" split_s_prefix
1078                           , SysTools.FileOption "" n_files_fn
1079                           ]
1080
1081         -- Save the number of split files for future references
1082         s <- readFile n_files_fn
1083         let n_files = read s :: Int
1084             dflags' = dflags { splitInfo = Just (split_s_prefix, n_files) }
1085
1086         -- Remember to delete all these files
1087         addFilesToClean dflags' [ split_s_prefix ++ "__" ++ show n ++ ".s"
1088                                 | n <- [1..n_files]]
1089
1090         return (SplitAs, dflags', maybe_loc, "**splitmangle**")
1091           -- we don't use the filename
1092
1093 -----------------------------------------------------------------------------
1094 -- As phase
1095
1096 runPhase As _stop hsc_env _basename _suff input_fn get_output_fn maybe_loc
1097   = liftIO $
1098     do  let dflags = hsc_dflags hsc_env
1099         let as_opts =  getOpts dflags opt_a
1100         let cmdline_include_paths = includePaths dflags
1101
1102         output_fn <- get_output_fn dflags StopLn maybe_loc
1103
1104         -- we create directories for the object file, because it
1105         -- might be a hierarchical module.
1106         createDirectoryHierarchy (takeDirectory output_fn)
1107
1108         let (md_c_flags, _) = machdepCCOpts dflags
1109         SysTools.runAs dflags
1110                        (map SysTools.Option as_opts
1111                        ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
1112 #ifdef sparc_TARGET_ARCH
1113         -- We only support SparcV9 and better because V8 lacks an atomic CAS
1114         -- instruction so we have to make sure that the assembler accepts the
1115         -- instruction set. Note that the user can still override this
1116         -- (e.g., -mcpu=ultrasparc). GCC picks the "best" -mcpu flag
1117         -- regardless of the ordering.
1118         --
1119         -- This is a temporary hack.
1120                        ++ [ SysTools.Option "-mcpu=v9" ]
1121 #endif
1122                        ++ [ SysTools.Option "-c"
1123                           , SysTools.FileOption "" input_fn
1124                           , SysTools.Option "-o"
1125                           , SysTools.FileOption "" output_fn
1126                           ]
1127                        ++ map SysTools.Option md_c_flags)
1128
1129         return (StopLn, dflags, maybe_loc, output_fn)
1130
1131
1132 runPhase SplitAs _stop hsc_env _basename _suff _input_fn get_output_fn maybe_loc
1133   = liftIO $ do
1134         let dflags = hsc_dflags hsc_env
1135         output_fn <- get_output_fn dflags StopLn maybe_loc
1136
1137         let base_o = dropExtension output_fn
1138             osuf = objectSuf dflags
1139             split_odir  = base_o ++ "_" ++ osuf ++ "_split"
1140
1141         createDirectoryHierarchy split_odir
1142
1143         -- remove M_split/ *.o, because we're going to archive M_split/ *.o
1144         -- later and we don't want to pick up any old objects.
1145         fs <- getDirectoryContents split_odir
1146         mapM_ removeFile $ map (split_odir </>) $ filter (osuf `isSuffixOf`) fs
1147
1148         let as_opts = getOpts dflags opt_a
1149
1150         let (split_s_prefix, n) = case splitInfo dflags of
1151                                   Nothing -> panic "No split info"
1152                                   Just x -> x
1153
1154         let split_s   n = split_s_prefix ++ "__" ++ show n <.> "s"
1155             split_obj n = split_odir </>
1156                           takeFileName base_o ++ "__" ++ show n <.> osuf
1157
1158         let (md_c_flags, _) = machdepCCOpts dflags
1159         let assemble_file n
1160               = SysTools.runAs dflags
1161                          (map SysTools.Option as_opts ++
1162 #ifdef sparc_TARGET_ARCH
1163         -- We only support SparcV9 and better because V8 lacks an atomic CAS
1164         -- instruction so we have to make sure that the assembler accepts the
1165         -- instruction set. Note that the user can still override this
1166         -- (e.g., -mcpu=ultrasparc). GCC picks the "best" -mcpu flag
1167         -- regardless of the ordering.
1168         --
1169         -- This is a temporary hack.
1170                           [ SysTools.Option "-mcpu=v9" ] ++
1171 #endif
1172                           [ SysTools.Option "-c"
1173                           , SysTools.Option "-o"
1174                           , SysTools.FileOption "" (split_obj n)
1175                           , SysTools.FileOption "" (split_s n)
1176                           ]
1177                        ++ map SysTools.Option md_c_flags)
1178
1179         mapM_ assemble_file [1..n]
1180
1181         -- and join the split objects into a single object file:
1182         let ld_r args = SysTools.runLink dflags ([
1183                             SysTools.Option "-nostdlib",
1184                             SysTools.Option "-nodefaultlibs",
1185                             SysTools.Option "-Wl,-r",
1186                             SysTools.Option ld_x_flag,
1187                             SysTools.Option "-o",
1188                             SysTools.FileOption "" output_fn ]
1189                          ++ map SysTools.Option md_c_flags
1190                          ++ args)
1191             ld_x_flag | null cLD_X = ""
1192                       | otherwise  = "-Wl,-x"
1193
1194         if cLdIsGNULd == "YES"
1195             then do
1196                   let script = split_odir </> "ld.script"
1197                   writeFile script $
1198                       "INPUT(" ++ unwords (map split_obj [1..n]) ++ ")"
1199                   ld_r [SysTools.FileOption "" script]
1200             else do
1201                   ld_r (map (SysTools.FileOption "" . split_obj) [1..n])
1202
1203         return (StopLn, dflags, maybe_loc, output_fn)
1204
1205 -- warning suppression
1206 runPhase other _stop _dflags _basename _suff _input_fn _get_output_fn _maybe_loc =
1207    panic ("runPhase: don't know how to run phase " ++ show other)
1208 -----------------------------------------------------------------------------
1209 -- MoveBinary sort-of-phase
1210 -- After having produced a binary, move it somewhere else and generate a
1211 -- wrapper script calling the binary. Currently, we need this only in
1212 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
1213 -- central directory.
1214 -- This is called from linkBinary below, after linking. I haven't made it
1215 -- a separate phase to minimise interfering with other modules, and
1216 -- we don't need the generality of a phase (MoveBinary is always
1217 -- done after linking and makes only sense in a parallel setup)   -- HWL
1218
1219 runPhase_MoveBinary :: DynFlags -> FilePath -> [PackageId] -> IO Bool
1220 runPhase_MoveBinary dflags input_fn dep_packages
1221     | WayPar `elem` (wayNames dflags) && not opt_Static =
1222         panic ("Don't know how to combine PVM wrapper and dynamic wrapper")
1223     | WayPar `elem` (wayNames dflags) = do
1224         let sysMan = pgm_sysman dflags
1225         pvm_root <- getEnv "PVM_ROOT"
1226         pvm_arch <- getEnv "PVM_ARCH"
1227         let
1228            pvm_executable_base = "=" ++ input_fn
1229            pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
1230         -- nuke old binary; maybe use configur'ed names for cp and rm?
1231         _ <- tryIO (removeFile pvm_executable)
1232         -- move the newly created binary into PVM land
1233         copy dflags "copying PVM executable" input_fn pvm_executable
1234         -- generate a wrapper script for running a parallel prg under PVM
1235         writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
1236         return True
1237     | not opt_Static =
1238         case (dynLibLoader dflags) of
1239           Wrapped wrapmode ->
1240               do
1241                 let (o_base, o_ext) = splitExtension input_fn
1242                 let wrapped_executable | o_ext == "exe" = (o_base ++ ".dyn") <.> o_ext
1243                                        | otherwise = input_fn ++ ".dyn"
1244                 behaviour <- wrapper_behaviour dflags wrapmode dep_packages
1245
1246                 -- THINKME isn't this possible to do a bit nicer?
1247                 let behaviour' = concatMap (\x -> if x=='\\' then "\\\\" else [x]) behaviour
1248                 renameFile input_fn wrapped_executable
1249                 let rtsDetails = (getPackageDetails (pkgState dflags) rtsPackageId);
1250                 SysTools.runCc dflags
1251                   ([ SysTools.FileOption "" ((head (libraryDirs rtsDetails)) ++ "/dyn-wrapper.c")
1252                    , SysTools.Option ("-DBEHAVIOUR=\"" ++ behaviour' ++ "\"")
1253                    , SysTools.Option "-o"
1254                    , SysTools.FileOption "" input_fn
1255                    ] ++ map (SysTools.FileOption "-I") (includeDirs rtsDetails))
1256                 return True
1257           _ -> return True
1258     | otherwise = return True
1259
1260 wrapper_behaviour :: DynFlags -> Maybe [Char] -> [PackageId] -> IO [Char]
1261 wrapper_behaviour dflags mode dep_packages =
1262     let seperateBySemiColon strs = tail $ concatMap (';':) strs
1263     in case mode of
1264       Nothing -> do
1265                 pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1266                 return ('H' : (seperateBySemiColon pkg_lib_paths))
1267       Just s -> do
1268         allpkg <- getPreloadPackagesAnd dflags dep_packages
1269         putStrLn (unwords (map (packageIdString . packageConfigId) allpkg))
1270         return $ 'F':s ++ ';':(seperateBySemiColon (map (packageIdString . packageConfigId) allpkg))
1271
1272 -- generates a Perl skript starting a parallel prg under PVM
1273 mk_pvm_wrapper_script :: String -> String -> String -> String
1274 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
1275  [
1276   "eval 'exec perl -S $0 ${1+\"$@\"}'",
1277   "  if $running_under_some_shell;",
1278   "# =!=!=!=!=!=!=!=!=!=!=!",
1279   "# This script is automatically generated: DO NOT EDIT!!!",
1280   "# Generated by Glasgow Haskell Compiler",
1281   "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
1282   "#",
1283   "$pvm_executable      = '" ++ pvm_executable ++ "';",
1284   "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
1285   "$SysMan = '" ++ sysMan ++ "';",
1286   "",
1287   {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
1288   "# first, some magical shortcuts to run "commands" on the binary",
1289   "# (which is hidden)",
1290   "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
1291   "    local($cmd) = $1;",
1292   "    system("$cmd $pvm_executable");",
1293   "    exit(0); # all done",
1294   "}", -}
1295   "",
1296   "# Now, run the real binary; process the args first",
1297   "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
1298   "$debug = '';",
1299   "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
1300   "@nonPVM_args = ();",
1301   "$in_RTS_args = 0;",
1302   "",
1303   "args: while ($a = shift(@ARGV)) {",
1304   "    if ( $a eq '+RTS' ) {",
1305   "        $in_RTS_args = 1;",
1306   "    } elsif ( $a eq '-RTS' ) {",
1307   "        $in_RTS_args = 0;",
1308   "    }",
1309   "    if ( $a eq '-d' && $in_RTS_args ) {",
1310   "        $debug = '-';",
1311   "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
1312   "        $nprocessors = $1;",
1313   "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
1314   "        $nprocessors = $1;",
1315   "    } else {",
1316   "        push(@nonPVM_args, $a);",
1317   "    }",
1318   "}",
1319   "",
1320   "local($return_val) = 0;",
1321   "# Start the parallel execution by calling SysMan",
1322   "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
1323   "$return_val = $?;",
1324   "# ToDo: fix race condition moving files and flushing them!!",
1325   "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
1326   "exit($return_val);"
1327  ]
1328
1329 -----------------------------------------------------------------------------
1330 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
1331
1332 getHCFilePackages :: FilePath -> IO [PackageId]
1333 getHCFilePackages filename =
1334   Exception.bracket (openFile filename ReadMode) hClose $ \h -> do
1335     l <- hGetLine h
1336     case l of
1337       '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
1338           return (map stringToPackageId (words rest))
1339       _other ->
1340           return []
1341
1342 -----------------------------------------------------------------------------
1343 -- Static linking, of .o files
1344
1345 -- The list of packages passed to link is the list of packages on
1346 -- which this program depends, as discovered by the compilation
1347 -- manager.  It is combined with the list of packages that the user
1348 -- specifies on the command line with -package flags.
1349 --
1350 -- In one-shot linking mode, we can't discover the package
1351 -- dependencies (because we haven't actually done any compilation or
1352 -- read any interface files), so the user must explicitly specify all
1353 -- the packages.
1354
1355 linkBinary :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
1356 linkBinary dflags o_files dep_packages = do
1357     let verb = getVerbFlag dflags
1358         output_fn = exeFileName dflags
1359
1360     -- get the full list of packages to link with, by combining the
1361     -- explicit packages with the auto packages and all of their
1362     -- dependencies, and eliminating duplicates.
1363
1364     pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1365     let pkg_lib_path_opts = concat (map get_pkg_lib_path_opts pkg_lib_paths)
1366 #ifdef linux_TARGET_OS
1367         get_pkg_lib_path_opts l | (dynLibLoader dflags)==SystemDependent && not opt_Static = ["-L" ++ l, "-Wl,-rpath", "-Wl," ++ l]
1368                                 | otherwise = ["-L" ++ l]
1369 #else
1370         get_pkg_lib_path_opts l = ["-L" ++ l]
1371 #endif
1372
1373     let lib_paths = libraryPaths dflags
1374     let lib_path_opts = map ("-L"++) lib_paths
1375
1376     -- The C "main" function is not in the rts but in a separate static
1377     -- library libHSrtsmain.a that sits next to the rts lib files. Assuming
1378     -- we're using a Haskell main function then we need to link it in.
1379     let no_hs_main = dopt Opt_NoHsMain dflags
1380     let main_lib | no_hs_main = []
1381                  | otherwise  = [ "-lHSrtsmain" ]
1382
1383     pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1384
1385 #ifdef darwin_TARGET_OS
1386     pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1387     let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1388
1389     let framework_paths = frameworkPaths dflags
1390         framework_path_opts = map ("-F"++) framework_paths
1391
1392     pkg_frameworks <- getPackageFrameworks dflags dep_packages
1393     let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1394
1395     let frameworks = cmdlineFrameworks dflags
1396         framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1397          -- reverse because they're added in reverse order from the cmd line
1398 #endif
1399         -- probably _stub.o files
1400     extra_ld_inputs <- readIORef v_Ld_inputs
1401
1402         -- opts from -optl-<blah> (including -l<blah> options)
1403     let extra_ld_opts = getOpts dflags opt_l
1404
1405     let ways = wayNames dflags
1406
1407     -- Here are some libs that need to be linked at the *end* of
1408     -- the command line, because they contain symbols that are referred to
1409     -- by the RTS.  We can't therefore use the ordinary way opts for these.
1410     let
1411         debug_opts | WayDebug `elem` ways = [
1412 #if defined(HAVE_LIBBFD)
1413                         "-lbfd", "-liberty"
1414 #endif
1415                          ]
1416                    | otherwise            = []
1417
1418     let
1419         thread_opts | WayThreaded `elem` ways = [
1420 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1421                         "-lpthread"
1422 #endif
1423 #if defined(osf3_TARGET_OS)
1424                         , "-lexc"
1425 #endif
1426                         ]
1427                     | otherwise               = []
1428
1429     rc_objs <- maybeCreateManifest dflags output_fn
1430
1431     let (md_c_flags, _) = machdepCCOpts dflags
1432     SysTools.runLink dflags (
1433                        [ SysTools.Option verb
1434                        , SysTools.Option "-o"
1435                        , SysTools.FileOption "" output_fn
1436                        ]
1437                       ++ map SysTools.Option (
1438                          md_c_flags
1439                       ++ o_files
1440                       ++ extra_ld_inputs
1441                       ++ lib_path_opts
1442                       ++ extra_ld_opts
1443                       ++ rc_objs
1444 #ifdef darwin_TARGET_OS
1445                       ++ framework_path_opts
1446                       ++ framework_opts
1447 #endif
1448                       ++ pkg_lib_path_opts
1449                       ++ main_lib
1450                       ++ pkg_link_opts
1451 #ifdef darwin_TARGET_OS
1452                       ++ pkg_framework_path_opts
1453                       ++ pkg_framework_opts
1454 #endif
1455                       ++ debug_opts
1456                       ++ thread_opts
1457                     ))
1458
1459     -- parallel only: move binary to another dir -- HWL
1460     success <- runPhase_MoveBinary dflags output_fn dep_packages
1461     if success then return ()
1462                else ghcError (InstallationError ("cannot move binary"))
1463
1464
1465 exeFileName :: DynFlags -> FilePath
1466 exeFileName dflags
1467   | Just s <- outputFile dflags =
1468 #if defined(mingw32_HOST_OS)
1469       if null (takeExtension s)
1470         then s <.> "exe"
1471         else s
1472 #else
1473       s
1474 #endif
1475   | otherwise =
1476 #if defined(mingw32_HOST_OS)
1477         "main.exe"
1478 #else
1479         "a.out"
1480 #endif
1481
1482 maybeCreateManifest
1483    :: DynFlags
1484    -> FilePath                          -- filename of executable
1485    -> IO [FilePath]                     -- extra objects to embed, maybe
1486 #ifndef mingw32_TARGET_OS
1487 maybeCreateManifest _ _ = do
1488   return []
1489 #else
1490 maybeCreateManifest dflags exe_filename = do
1491   if not (dopt Opt_GenManifest dflags) then return [] else do
1492
1493   let manifest_filename = exe_filename <.> "manifest"
1494
1495   writeFile manifest_filename $
1496       "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n"++
1497       "  <assembly xmlns=\"urn:schemas-microsoft-com:asm.v1\" manifestVersion=\"1.0\">\n"++
1498       "  <assemblyIdentity version=\"1.0.0.0\"\n"++
1499       "     processorArchitecture=\"X86\"\n"++
1500       "     name=\"" ++ dropExtension exe_filename ++ "\"\n"++
1501       "     type=\"win32\"/>\n\n"++
1502       "  <trustInfo xmlns=\"urn:schemas-microsoft-com:asm.v3\">\n"++
1503       "    <security>\n"++
1504       "      <requestedPrivileges>\n"++
1505       "        <requestedExecutionLevel level=\"asInvoker\" uiAccess=\"false\"/>\n"++
1506       "        </requestedPrivileges>\n"++
1507       "       </security>\n"++
1508       "  </trustInfo>\n"++
1509       "</assembly>\n"
1510
1511   -- Windows will find the manifest file if it is named foo.exe.manifest.
1512   -- However, for extra robustness, and so that we can move the binary around,
1513   -- we can embed the manifest in the binary itself using windres:
1514   if not (dopt Opt_EmbedManifest dflags) then return [] else do
1515
1516   rc_filename <- newTempName dflags "rc"
1517   rc_obj_filename <- newTempName dflags (objectSuf dflags)
1518
1519   writeFile rc_filename $
1520       "1 24 MOVEABLE PURE " ++ show manifest_filename ++ "\n"
1521         -- magic numbers :-)
1522         -- show is a bit hackish above, but we need to escape the
1523         -- backslashes in the path.
1524
1525   let wr_opts = getOpts dflags opt_windres
1526   runWindres dflags $ map SysTools.Option $
1527         ["--input="++rc_filename,
1528          "--output="++rc_obj_filename,
1529          "--output-format=coff"]
1530         ++ wr_opts
1531         -- no FileOptions here: windres doesn't like seeing
1532         -- backslashes, apparently
1533
1534   removeFile manifest_filename
1535
1536   return [rc_obj_filename]
1537 #endif
1538
1539
1540 linkDynLib :: DynFlags -> [String] -> [PackageId] -> IO ()
1541 linkDynLib dflags o_files dep_packages = do
1542     let verb = getVerbFlag dflags
1543     let o_file = outputFile dflags
1544
1545     -- We don't want to link our dynamic libs against the RTS package,
1546     -- because the RTS lib comes in several flavours and we want to be
1547     -- able to pick the flavour when a binary is linked.
1548     pkgs <- getPreloadPackagesAnd dflags dep_packages
1549
1550     -- On Windows we need to link the RTS import lib as Windows does
1551     -- not allow undefined symbols.
1552 #if !defined(mingw32_HOST_OS)
1553     let pkgs_no_rts = filter ((/= rtsPackageId) . packageConfigId) pkgs
1554 #else
1555     let pkgs_no_rts = pkgs
1556 #endif
1557     let pkg_lib_paths = collectLibraryPaths pkgs_no_rts
1558     let pkg_lib_path_opts = concatMap get_pkg_lib_path_opts pkg_lib_paths
1559 #ifdef linux_TARGET_OS
1560         get_pkg_lib_path_opts l | (dynLibLoader dflags)==SystemDependent && not opt_Static = ["-L" ++ l, "-Wl,-rpath", "-Wl," ++ l]
1561                                 | otherwise = ["-L" ++ l]
1562 #else
1563         get_pkg_lib_path_opts l = ["-L" ++ l]
1564 #endif
1565
1566     let lib_paths = libraryPaths dflags
1567     let lib_path_opts = map ("-L"++) lib_paths
1568
1569     let pkg_link_opts = collectLinkOpts dflags pkgs_no_rts
1570
1571         -- probably _stub.o files
1572     extra_ld_inputs <- readIORef v_Ld_inputs
1573
1574     let (md_c_flags, _) = machdepCCOpts dflags
1575     let extra_ld_opts = getOpts dflags opt_l
1576 #if defined(mingw32_HOST_OS)
1577     -----------------------------------------------------------------------------
1578     -- Making a DLL
1579     -----------------------------------------------------------------------------
1580     let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1581
1582     SysTools.runLink dflags
1583          ([ SysTools.Option verb
1584           , SysTools.Option "-o"
1585           , SysTools.FileOption "" output_fn
1586           , SysTools.Option "-shared"
1587           ] ++
1588           [ SysTools.FileOption "-Wl,--out-implib=" (output_fn ++ ".a")
1589           | dopt Opt_SharedImplib dflags
1590           ]
1591          ++ map (SysTools.FileOption "") o_files
1592          ++ map SysTools.Option (
1593             md_c_flags
1594          ++ extra_ld_inputs
1595          ++ lib_path_opts
1596          ++ extra_ld_opts
1597          ++ pkg_lib_path_opts
1598          ++ pkg_link_opts
1599         ))
1600 #elif defined(darwin_TARGET_OS)
1601     -----------------------------------------------------------------------------
1602     -- Making a darwin dylib
1603     -----------------------------------------------------------------------------
1604     -- About the options used for Darwin:
1605     -- -dynamiclib
1606     --   Apple's way of saying -shared
1607     -- -undefined dynamic_lookup:
1608     --   Without these options, we'd have to specify the correct dependencies
1609     --   for each of the dylibs. Note that we could (and should) do without this
1610     --   for all libraries except the RTS; all we need to do is to pass the
1611     --   correct HSfoo_dyn.dylib files to the link command.
1612     --   This feature requires Mac OS X 10.3 or later; there is a similar feature,
1613     --   -flat_namespace -undefined suppress, which works on earlier versions,
1614     --   but it has other disadvantages.
1615     -- -single_module
1616     --   Build the dynamic library as a single "module", i.e. no dynamic binding
1617     --   nonsense when referring to symbols from within the library. The NCG
1618     --   assumes that this option is specified (on i386, at least).
1619     -- -Wl,-macosx_version_min -Wl,10.3
1620     --   Tell the linker its safe to assume that the library will run on 10.3 or
1621     --   later, so that it will not complain about the use of the option
1622     --   -undefined dynamic_lookup above.
1623     -- -install_name
1624     --   Causes the dynamic linker to ignore the DYLD_LIBRARY_PATH when loading
1625     --   this lib and instead look for it at its absolute path.
1626     --   When installing the .dylibs (see target.mk), we'll change that path to
1627     --   point to the place they are installed. Therefore, we won't have to set
1628     --   up DYLD_LIBRARY_PATH specifically for ghc.
1629     -----------------------------------------------------------------------------
1630
1631     let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1632
1633     pwd <- getCurrentDirectory
1634     SysTools.runLink dflags
1635          ([ SysTools.Option verb
1636           , SysTools.Option "-dynamiclib"
1637           , SysTools.Option "-o"
1638           , SysTools.FileOption "" output_fn
1639           ]
1640          ++ map SysTools.Option (
1641             md_c_flags
1642          ++ o_files
1643          ++ [ "-undefined", "dynamic_lookup", "-single_module", "-Wl,-macosx_version_min","-Wl,10.3", "-install_name " ++ (pwd </> output_fn) ]
1644          ++ extra_ld_inputs
1645          ++ lib_path_opts
1646          ++ extra_ld_opts
1647          ++ pkg_lib_path_opts
1648          ++ pkg_link_opts
1649         ))
1650 #else
1651     -----------------------------------------------------------------------------
1652     -- Making a DSO
1653     -----------------------------------------------------------------------------
1654
1655     let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
1656
1657     SysTools.runLink dflags
1658          ([ SysTools.Option verb
1659           , SysTools.Option "-o"
1660           , SysTools.FileOption "" output_fn
1661           ]
1662          ++ map SysTools.Option (
1663             md_c_flags
1664          ++ o_files
1665          ++ [ "-shared", "-Wl,-Bsymbolic" ] -- we need symbolic linking to resolve non-PIC intra-package-relocations
1666          ++ [ "-Wl,-soname," ++ takeFileName output_fn ] -- set the library soname
1667          ++ extra_ld_inputs
1668          ++ lib_path_opts
1669          ++ extra_ld_opts
1670          ++ pkg_lib_path_opts
1671          ++ pkg_link_opts
1672         ))
1673 #endif
1674 -- -----------------------------------------------------------------------------
1675 -- Running CPP
1676
1677 doCpp :: DynFlags -> Bool -> Bool -> FilePath -> FilePath -> IO ()
1678 doCpp dflags raw include_cc_opts input_fn output_fn = do
1679     let hscpp_opts = getOpts dflags opt_P
1680     let cmdline_include_paths = includePaths dflags
1681
1682     pkg_include_dirs <- getPackageIncludePath dflags []
1683     let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1684                           (cmdline_include_paths ++ pkg_include_dirs)
1685
1686     let verb = getVerbFlag dflags
1687
1688     let cc_opts
1689           | not include_cc_opts = []
1690           | otherwise           = (optc ++ md_c_flags)
1691                 where
1692                       optc = getOpts dflags opt_c
1693                       (md_c_flags, _) = machdepCCOpts dflags
1694
1695     let cpp_prog args | raw       = SysTools.runCpp dflags args
1696                       | otherwise = SysTools.runCc dflags (SysTools.Option "-E" : args)
1697
1698     let target_defs =
1699           [ "-D" ++ HOST_OS     ++ "_BUILD_OS=1",
1700             "-D" ++ HOST_ARCH   ++ "_BUILD_ARCH=1",
1701             "-D" ++ TARGET_OS   ++ "_HOST_OS=1",
1702             "-D" ++ TARGET_ARCH ++ "_HOST_ARCH=1" ]
1703         -- remember, in code we *compile*, the HOST is the same our TARGET,
1704         -- and BUILD is the same as our HOST.
1705
1706     cpp_prog       ([SysTools.Option verb]
1707                     ++ map SysTools.Option include_paths
1708                     ++ map SysTools.Option hsSourceCppOpts
1709                     ++ map SysTools.Option hscpp_opts
1710                     ++ map SysTools.Option cc_opts
1711                     ++ map SysTools.Option target_defs
1712                     ++ [ SysTools.Option     "-x"
1713                        , SysTools.Option     "c"
1714                        , SysTools.Option     input_fn
1715         -- We hackily use Option instead of FileOption here, so that the file
1716         -- name is not back-slashed on Windows.  cpp is capable of
1717         -- dealing with / in filenames, so it works fine.  Furthermore
1718         -- if we put in backslashes, cpp outputs #line directives
1719         -- with *double* backslashes.   And that in turn means that
1720         -- our error messages get double backslashes in them.
1721         -- In due course we should arrange that the lexer deals
1722         -- with these \\ escapes properly.
1723                        , SysTools.Option     "-o"
1724                        , SysTools.FileOption "" output_fn
1725                        ])
1726
1727 cHaskell1Version :: String
1728 cHaskell1Version = "5" -- i.e., Haskell 98
1729
1730 hsSourceCppOpts :: [String]
1731 -- Default CPP defines in Haskell source
1732 hsSourceCppOpts =
1733         [ "-D__HASKELL1__="++cHaskell1Version
1734         , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
1735         , "-D__HASKELL98__"
1736         , "-D__CONCURRENT_HASKELL__"
1737         ]
1738
1739
1740 -- -----------------------------------------------------------------------------
1741 -- Misc.
1742
1743 hscNextPhase :: DynFlags -> HscSource -> HscTarget -> Phase
1744 hscNextPhase _ HsBootFile _        =  StopLn
1745 hscNextPhase dflags _ hsc_lang =
1746   case hsc_lang of
1747         HscC -> HCc
1748         HscAsm | dopt Opt_SplitObjs dflags -> SplitMangle
1749                | otherwise -> As
1750         HscNothing     -> StopLn
1751         HscInterpreted -> StopLn
1752         _other         -> StopLn
1753
1754
1755 hscMaybeAdjustTarget :: DynFlags -> Phase -> HscSource -> HscTarget -> HscTarget
1756 hscMaybeAdjustTarget dflags stop _ current_hsc_lang
1757   = hsc_lang
1758   where
1759         keep_hc = dopt Opt_KeepHcFiles dflags
1760         hsc_lang
1761                 -- don't change the lang if we're interpreting
1762                  | current_hsc_lang == HscInterpreted = current_hsc_lang
1763
1764                 -- force -fvia-C if we are being asked for a .hc file
1765                  | HCc <- stop = HscC
1766                  | keep_hc     = HscC
1767                 -- otherwise, stick to the plan
1768                  | otherwise = current_hsc_lang
1769