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
 420         | Just x_phase <- mb_phase = x_phase
 421         | otherwise                = startPhase suffix
 422
 423   -- We want to catch cases of "you can't get there from here" before
 424   -- we start the pipeline, because otherwise it will just run off the
 425   -- end.
 426   --
 427   -- There is a partial ordering on phases, where A < B iff A occurs
 428   -- before B in a normal compilation pipeline.
 429
 430   when (not (start_phase `happensBefore` stop_phase)) $
 431         throwDyn (UsageError
 432                     ("cannot compile this file to desired target: "
 433                        ++ input_fn))
 434
 435   -- this is a function which will be used to calculate output file names
 436   -- as we go along (we partially apply it to some of its inputs here)
 437   let get_output_fn = getOutputFilename stop_phase output basename
 438
 439   -- Execute the pipeline...
 440   (dflags', output_fn, maybe_loc) <-
 441         pipeLoop dflags start_phase stop_phase input_fn
 442                  basename suffix get_output_fn maybe_loc
 443
 444   -- Sometimes, a compilation phase doesn't actually generate any output
 445   -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
 446   -- stage, but we wanted to keep the output, then we have to explicitly
 447   -- copy the file.
 448   case output of
 449     Temporary ->
 450         return (dflags', output_fn)
 451     _other ->
 452         do final_fn <- get_output_fn dflags' stop_phase maybe_loc
 453            when (final_fn /= output_fn) $
 454                   copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
 455                         ++ "'") output_fn final_fn
 456            return (dflags', final_fn)
 457
 458
 459
 460 pipeLoop :: DynFlags -> Phase -> Phase
 461          -> FilePath  -> String -> Suffix
 462          -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
 463          -> Maybe ModLocation
 464          -> IO (DynFlags, FilePath, Maybe ModLocation)
 465
 466 pipeLoop dflags phase stop_phase
 467          input_fn orig_basename orig_suff
 468          orig_get_output_fn maybe_loc
 469
 470   | phase `eqPhase` stop_phase            -- All done
 471   = return (dflags, input_fn, maybe_loc)
 472
 473   | not (phase `happensBefore` stop_phase)
 474         -- Something has gone wrong.  We'll try to cover all the cases when
 475         -- this could happen, so if we reach here it is a panic.
 476         -- eg. it might happen if the -C flag is used on a source file that
 477         -- has {-# OPTIONS -fasm #-}.
 478   = panic ("pipeLoop: at phase " ++ show phase ++
 479            " but I wanted to stop at phase " ++ show stop_phase)
 480
 481   | otherwise
 482   = do  { (next_phase, dflags', maybe_loc, output_fn)
 483                 <- runPhase phase stop_phase dflags orig_basename
 484                             orig_suff input_fn orig_get_output_fn maybe_loc
 485         ; pipeLoop dflags' next_phase stop_phase output_fn
 486                    orig_basename orig_suff orig_get_output_fn maybe_loc }
 487
 488 getOutputFilename
 489   :: Phase -> PipelineOutput -> String
 490   -> DynFlags -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
 491 getOutputFilename stop_phase output basename
 492  = func
 493  where
 494         func dflags next_phase maybe_location
 495            | is_last_phase, Persistent <- output     = persistent_fn
 496            | is_last_phase, SpecificFile f <- output = return f
 497            | keep_this_output                        = persistent_fn
 498            | otherwise                               = newTempName dflags suffix
 499            where
 500                 hcsuf      = hcSuf dflags
 501                 odir       = objectDir dflags
 502                 osuf       = objectSuf dflags
 503                 keep_hc    = dopt Opt_KeepHcFiles dflags
 504                 keep_raw_s = dopt Opt_KeepRawSFiles dflags
 505                 keep_s     = dopt Opt_KeepSFiles dflags
 506
 507                 myPhaseInputExt HCc    = hcsuf
 508                 myPhaseInputExt StopLn = osuf
 509                 myPhaseInputExt other  = phaseInputExt other
 510
 511                 is_last_phase = next_phase `eqPhase` stop_phase
 512
 513                 -- sometimes, we keep output from intermediate stages
 514                 keep_this_output =
 515                      case next_phase of
 516                              StopLn              -> True
 517                              Mangle | keep_raw_s -> True
 518                              As     | keep_s     -> True
 519                              HCc    | keep_hc    -> True
 520                              _other              -> False
 521
 522                 suffix = myPhaseInputExt next_phase
 523
 524                 -- persistent object files get put in odir
 525                 persistent_fn
 526                    | StopLn <- next_phase = return odir_persistent
 527                    | otherwise            = return persistent
 528
 529                 persistent = basename `joinFileExt` suffix
 530
 531                 odir_persistent
 532                    | Just loc <- maybe_location = ml_obj_file loc
 533                    | Just d <- odir = d `joinFileName` persistent
 534                    | otherwise      = persistent
 535
 536
 537 -- -----------------------------------------------------------------------------
 538 -- Each phase in the pipeline returns the next phase to execute, and the
 539 -- name of the file in which the output was placed.
 540 --
 541 -- We must do things dynamically this way, because we often don't know
 542 -- what the rest of the phases will be until part-way through the
 543 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
 544 -- of a source file can change the latter stages of the pipeline from
 545 -- taking the via-C route to using the native code generator.
 546
 547 runPhase :: Phase       -- Do this phase first
 548          -> Phase       -- Stop just before this phase
 549          -> DynFlags
 550          -> String      -- basename of original input source
 551          -> String      -- its extension
 552          -> FilePath    -- name of file which contains the input to this phase.
 553          -> (DynFlags -> Phase -> Maybe ModLocation -> IO FilePath)
 554                         -- how to calculate the output filename
 555          -> Maybe ModLocation           -- the ModLocation, if we have one
 556          -> IO (Phase,                  -- next phase
 557                 DynFlags,               -- new dynamic flags
 558                 Maybe ModLocation,      -- the ModLocation, if we have one
 559                 FilePath)               -- output filename
 560
 561         -- Invariant: the output filename always contains the output
 562         -- Interesting case: Hsc when there is no recompilation to do
 563         --                   Then the output filename is still a .o file
 564
 565 -------------------------------------------------------------------------------
 566 -- Unlit phase
 567
 568 runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
 569   = do let unlit_flags = getOpts dflags opt_L
 570        -- The -h option passes the file name for unlit to put in a #line directive
 571        output_fn <- get_output_fn dflags (Cpp sf) maybe_loc
 572
 573        SysTools.runUnlit dflags
 574                 (map SysTools.Option unlit_flags ++
 575                           [ SysTools.Option     "-h"
 576                           , SysTools.Option     input_fn
 577                           , SysTools.FileOption "" input_fn
 578                           , SysTools.FileOption "" output_fn
 579                           ])
 580
 581        return (Cpp sf, dflags, maybe_loc, output_fn)
 582
 583 -------------------------------------------------------------------------------
 584 -- Cpp phase : (a) gets OPTIONS out of file
 585 --             (b) runs cpp if necessary
 586
 587 runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
 588   = do src_opts <- getOptionsFromFile input_fn
 589        (dflags,unhandled_flags) <- parseDynamicFlags dflags0 (map unLoc src_opts)
 590        checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
 591
 592        if not (dopt Opt_Cpp dflags) then
 593            -- no need to preprocess CPP, just pass input file along
 594            -- to the next phase of the pipeline.
 595           return (HsPp sf, dflags, maybe_loc, input_fn)
 596         else do
 597             output_fn <- get_output_fn dflags (HsPp sf) maybe_loc
 598             doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
 599             return (HsPp sf, dflags, maybe_loc, output_fn)
 600
 601 -------------------------------------------------------------------------------
 602 -- HsPp phase
 603
 604 runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
 605   = do if not (dopt Opt_Pp dflags) then
 606            -- no need to preprocess, just pass input file along
 607            -- to the next phase of the pipeline.
 608           return (Hsc sf, dflags, maybe_loc, input_fn)
 609         else do
 610             let hspp_opts = getOpts dflags opt_F
 611             let orig_fn = basename `joinFileExt` suff
 612             output_fn <- get_output_fn dflags (Hsc sf) maybe_loc
 613             SysTools.runPp dflags
 614                            ( [ SysTools.Option     orig_fn
 615                              , SysTools.Option     input_fn
 616                              , SysTools.FileOption "" output_fn
 617                              ] ++
 618                              map SysTools.Option hspp_opts
 619                            )
 620             return (Hsc sf, dflags, maybe_loc, output_fn)
 621
 622 -----------------------------------------------------------------------------
 623 -- Hsc phase
 624
 625 -- Compilation of a single module, in "legacy" mode (_not_ under
 626 -- the direction of the compilation manager).
 627 runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc
 628  = do   -- normal Hsc mode, not mkdependHS
 629
 630   -- we add the current directory (i.e. the directory in which
 631   -- the .hs files resides) to the import path, since this is
 632   -- what gcc does, and it's probably what you want.
 633         let current_dir = directoryOf basename
 634
 635             paths = includePaths dflags0
 636             dflags = dflags0 { includePaths = current_dir : paths }
 637
 638   -- gather the imports and module name
 639         (hspp_buf,mod_name) <-
 640             case src_flavour of
 641                 ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
 642                                   ; m <- getCoreModuleName input_fn
 643                                   ; return (Nothing, mkModuleName m) }
 644
 645                 other -> do { buf <- hGetStringBuffer input_fn
 646                             ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
 647                             ; return (Just buf, mod_name) }
 648
 649   -- Build a ModLocation to pass to hscMain.
 650   -- The source filename is rather irrelevant by now, but it's used
 651   -- by hscMain for messages.  hscMain also needs
 652   -- the .hi and .o filenames, and this is as good a way
 653   -- as any to generate them, and better than most. (e.g. takes
 654   -- into accout the -osuf flags)
 655         location1 <- mkHomeModLocation2 dflags mod_name basename suff
 656
 657   -- Boot-ify it if necessary
 658         let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
 659                       | otherwise            = location1
 660
 661
 662   -- Take -ohi into account if present
 663   -- This can't be done in mkHomeModuleLocation because
 664   -- it only applies to the module being compiles
 665         let ohi = outputHi dflags
 666             location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
 667                       | otherwise      = location2
 668
 669   -- Take -o into account if present
 670   -- Very like -ohi, but we must *only* do this if we aren't linking
 671   -- (If we're linking then the -o applies to the linked thing, not to
 672   -- the object file for one module.)
 673   -- Note the nasty duplication with the same computation in compileFile above
 674         let expl_o_file = outputFile dflags
 675             location4 | Just ofile <- expl_o_file
 676                       , isNoLink (ghcLink dflags)
 677                       = location3 { ml_obj_file = ofile }
 678                       | otherwise = location3
 679
 680             o_file = ml_obj_file location4      -- The real object file
 681
 682
 683   -- Figure out if the source has changed, for recompilation avoidance.
 684   --
 685   -- Setting source_unchanged to True means that M.o seems
 686   -- to be up to date wrt M.hs; so no need to recompile unless imports have
 687   -- changed (which the compiler itself figures out).
 688   -- Setting source_unchanged to False tells the compiler that M.o is out of
 689   -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
 690         src_timestamp <- getModificationTime (basename `joinFileExt` suff)
 691
 692         let force_recomp = dopt Opt_ForceRecomp dflags
 693         source_unchanged <-
 694           if force_recomp || not (isStopLn stop)
 695                 -- Set source_unchanged to False unconditionally if
 696                 --      (a) recompilation checker is off, or
 697                 --      (b) we aren't going all the way to .o file (e.g. ghc -S)
 698              then return False
 699                 -- Otherwise look at file modification dates
 700              else do o_file_exists <- doesFileExist o_file
 701                      if not o_file_exists
 702                         then return False       -- Need to recompile
 703                         else do t2 <- getModificationTime o_file
 704                                 if t2 > src_timestamp
 705                                   then return True
 706                                   else return False
 707
 708   -- get the DynFlags
 709         let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
 710         let next_phase = hscNextPhase dflags src_flavour hsc_lang
 711         output_fn  <- get_output_fn dflags next_phase (Just location4)
 712
 713         let dflags' = dflags { hscTarget = hsc_lang,
 714                                hscOutName = output_fn,
 715                                extCoreName = basename ++ ".hcr" }
 716
 717         hsc_env <- newHscEnv dflags'
 718
 719   -- Tell the finder cache about this module
 720         mod <- addHomeModuleToFinder hsc_env mod_name location4
 721
 722   -- Make the ModSummary to hand to hscMain
 723         let
 724             unused_field = panic "runPhase:ModSummary field"
 725                 -- Some fields are not looked at by hscMain
 726             mod_summary = ModSummary {  ms_mod       = mod,
 727                                         ms_hsc_src   = src_flavour,
 728                                         ms_hspp_file = input_fn,
 729                                         ms_hspp_opts = dflags,
 730                                         ms_hspp_buf  = hspp_buf,
 731                                         ms_location  = location4,
 732                                         ms_hs_date   = src_timestamp,
 733                                         ms_obj_date  = Nothing,
 734                                         ms_imps      = unused_field,
 735                                         ms_srcimps   = unused_field }
 736
 737   -- run the compiler!
 738         mbResult <- hscCompileOneShot hsc_env
 739                           mod_summary source_unchanged
 740                           Nothing       -- No iface
 741                           Nothing       -- No "module i of n" progress info
 742
 743         case mbResult of
 744           Nothing -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
 745           Just HscNoRecomp
 746               -> do SysTools.touch dflags' "Touching object file" o_file
 747                     -- The .o file must have a later modification date
 748                     -- than the source file (else we wouldn't be in HscNoRecomp)
 749                     -- but we touch it anyway, to keep 'make' happy (we think).
 750                     return (StopLn, dflags', Just location4, o_file)
 751           Just (HscRecomp hasStub)
 752               -> do when hasStub $
 753                          do stub_o <- compileStub dflags' mod location4
 754                             consIORef v_Ld_inputs stub_o
 755                     -- In the case of hs-boot files, generate a dummy .o-boot
 756                     -- stamp file for the benefit of Make
 757                     when (isHsBoot src_flavour) $
 758                       SysTools.touch dflags' "Touching object file" o_file
 759                     return (next_phase, dflags', Just location4, output_fn)
 760
 761 -----------------------------------------------------------------------------
 762 -- Cmm phase
 763
 764 runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
 765   = do
 766        output_fn <- get_output_fn dflags Cmm maybe_loc
 767        doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn
 768        return (Cmm, dflags, maybe_loc, output_fn)
 769
 770 runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
 771   = do
 772         let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
 773         let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
 774         output_fn <- get_output_fn dflags next_phase maybe_loc
 775
 776         let dflags' = dflags { hscTarget = hsc_lang,
 777                                hscOutName = output_fn,
 778                                extCoreName = basename ++ ".hcr" }
 779
 780         ok <- hscCmmFile dflags' input_fn
 781
 782         when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))
 783
 784         return (next_phase, dflags, maybe_loc, output_fn)
 785
 786 -----------------------------------------------------------------------------
 787 -- Cc phase
 788
 789 -- we don't support preprocessing .c files (with -E) now.  Doing so introduces
 790 -- way too many hacks, and I can't say I've ever used it anyway.
 791
 792 runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
 793    | cc_phase `eqPhase` Cc || cc_phase `eqPhase` Ccpp || cc_phase `eqPhase` HCc
 794    = do let cc_opts = getOpts dflags opt_c
 795             hcc = cc_phase `eqPhase` HCc
 796
 797         let cmdline_include_paths = includePaths dflags
 798
 799         -- HC files have the dependent packages stamped into them
 800         pkgs <- if hcc then getHCFilePackages input_fn else return []
 801
 802         -- add package include paths even if we're just compiling .c
 803         -- files; this is the Value Add(TM) that using ghc instead of
 804         -- gcc gives you :)
 805         pkg_include_dirs <- getPackageIncludePath dflags pkgs
 806         let include_paths = foldr (\ x xs -> "-I" : x : xs) []
 807                               (cmdline_include_paths ++ pkg_include_dirs)
 808
 809         let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
 810         let pic_c_flags = picCCOpts dflags
 811
 812         let verb = getVerbFlag dflags
 813
 814         pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
 815
 816         let split_objs = dopt Opt_SplitObjs dflags
 817             split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
 818                       | otherwise         = [ ]
 819
 820         let excessPrecision = dopt Opt_ExcessPrecision dflags
 821
 822         let cc_opt | optLevel dflags >= 2 = "-O2"
 823                    | otherwise            = "-O"
 824
 825         -- Decide next phase
 826
 827         let mangle = dopt Opt_DoAsmMangling dflags
 828             next_phase
 829                 | hcc && mangle     = Mangle
 830                 | otherwise         = As
 831         output_fn <- get_output_fn dflags next_phase maybe_loc
 832
 833         let
 834           more_hcc_opts =
 835 #if i386_TARGET_ARCH
 836                 -- on x86 the floating point regs have greater precision
 837                 -- than a double, which leads to unpredictable results.
 838                 -- By default, we turn this off with -ffloat-store unless
 839                 -- the user specified -fexcess-precision.
 840                 (if excessPrecision then [] else [ "-ffloat-store" ]) ++
 841 #endif
 842                 -- gcc's -fstrict-aliasing allows two accesses to memory
 843                 -- to be considered non-aliasing if they have different types.
 844                 -- This interacts badly with the C code we generate, which is
 845                 -- very weakly typed, being derived from C--.
 846                 ["-fno-strict-aliasing"]
 847
 848
 849
 850         SysTools.runCc dflags (
 851                 -- force the C compiler to interpret this file as C when
 852                 -- compiling .hc files, by adding the -x c option.
 853                 -- Also useful for plain .c files, just in case GHC saw a
 854                 -- -x c option.
 855                         [ SysTools.Option "-x", if cc_phase `eqPhase` Ccpp
 856                                                 then SysTools.Option "c++" else SysTools.Option "c"] ++
 857                         [ SysTools.FileOption "" input_fn
 858                         , SysTools.Option "-o"
 859                         , SysTools.FileOption "" output_fn
 860                         ]
 861                        ++ map SysTools.Option (
 862                           md_c_flags
 863                        ++ pic_c_flags
 864 #ifdef sparc_TARGET_ARCH
 865         -- We only support SparcV9 and better because V8 lacks an atomic CAS
 866         -- instruction. Note that the user can still override this
 867         -- (e.g., -mcpu=ultrasparc) as GCC picks the "best" -mcpu flag
 868         -- regardless of the ordering.
 869         --
 870         -- This is a temporary hack.
 871                        ++ ["-mcpu=v9"]
 872 #endif
 873                        ++ (if hcc && mangle
 874                              then md_regd_c_flags
 875                              else [])
 876                        ++ (if hcc
 877                              then more_hcc_opts
 878                              else [])
 879                        ++ [ verb, "-S", "-Wimplicit", cc_opt ]
 880                        ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
 881                        ++ cc_opts
 882                        ++ split_opt
 883                        ++ include_paths
 884                        ++ pkg_extra_cc_opts
 885                        ))
 886
 887         return (next_phase, dflags, maybe_loc, output_fn)
 888
 889         -- ToDo: postprocess the output from gcc
 890
 891 -----------------------------------------------------------------------------
 892 -- Mangle phase
 893
 894 runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
 895    = do let mangler_opts = getOpts dflags opt_m
 896
 897 #if i386_TARGET_ARCH
 898         machdep_opts <- return [ show (stolen_x86_regs dflags) ]
 899 #else
 900         machdep_opts <- return []
 901 #endif
 902
 903         let split = dopt Opt_SplitObjs dflags
 904             next_phase
 905                 | split = SplitMangle
 906                 | otherwise = As
 907         output_fn <- get_output_fn dflags next_phase maybe_loc
 908
 909         SysTools.runMangle dflags (map SysTools.Option mangler_opts
 910                           ++ [ SysTools.FileOption "" input_fn
 911                              , SysTools.FileOption "" output_fn
 912                              ]
 913                           ++ map SysTools.Option machdep_opts)
 914
 915         return (next_phase, dflags, maybe_loc, output_fn)
 916
 917 -----------------------------------------------------------------------------
 918 -- Splitting phase
 919
 920 runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
 921   = do  -- tmp_pfx is the prefix used for the split .s files
 922         -- We also use it as the file to contain the no. of split .s files (sigh)
 923         split_s_prefix <- SysTools.newTempName dflags "split"
 924         let n_files_fn = split_s_prefix
 925
 926         SysTools.runSplit dflags
 927                           [ SysTools.FileOption "" input_fn
 928                           , SysTools.FileOption "" split_s_prefix
 929                           , SysTools.FileOption "" n_files_fn
 930                           ]
 931
 932         -- Save the number of split files for future references
 933         s <- readFile n_files_fn
 934         let n_files = read s :: Int
 935         writeIORef v_Split_info (split_s_prefix, n_files)
 936
 937         -- Remember to delete all these files
 938         addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
 939                         | n <- [1..n_files]]
 940
 941         return (SplitAs, dflags, maybe_loc, "**splitmangle**")
 942           -- we don't use the filename
 943
 944 -----------------------------------------------------------------------------
 945 -- As phase
 946
 947 runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
 948   = do  let as_opts =  getOpts dflags opt_a
 949         let cmdline_include_paths = includePaths dflags
 950
 951         output_fn <- get_output_fn dflags StopLn maybe_loc
 952
 953         -- we create directories for the object file, because it
 954         -- might be a hierarchical module.
 955         createDirectoryHierarchy (directoryOf output_fn)
 956
 957         SysTools.runAs dflags
 958                        (map SysTools.Option as_opts
 959                        ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
 960 #ifdef sparc_TARGET_ARCH
 961         -- We only support SparcV9 and better because V8 lacks an atomic CAS
 962         -- instruction so we have to make sure that the assembler accepts the
 963         -- instruction set. Note that the user can still override this
 964         -- (e.g., -mcpu=ultrasparc). GCC picks the "best" -mcpu flag
 965         -- regardless of the ordering.
 966         --
 967         -- This is a temporary hack.
 968                        ++ [ SysTools.Option "-mcpu=v9" ]
 969 #endif
 970                        ++ [ SysTools.Option "-c"
 971                           , SysTools.FileOption "" input_fn
 972                           , SysTools.Option "-o"
 973                           , SysTools.FileOption "" output_fn
 974                           ])
 975
 976         return (StopLn, dflags, maybe_loc, output_fn)
 977
 978
 979 runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
 980   = do
 981         output_fn <- get_output_fn dflags StopLn maybe_loc
 982
 983         let (base_o, _) = splitFilename output_fn
 984             split_odir  = base_o ++ "_split"
 985             osuf = objectSuf dflags
 986
 987         createDirectoryHierarchy split_odir
 988
 989         -- remove M_split/ *.o, because we're going to archive M_split/ *.o
 990         -- later and we don't want to pick up any old objects.
 991         fs <- getDirectoryContents split_odir
 992         mapM_ removeFile $ map (split_odir `joinFileName`)
 993                          $ filter (osuf `isSuffixOf`) fs
 994
 995         let as_opts = getOpts dflags opt_a
 996
 997         (split_s_prefix, n) <- readIORef v_Split_info
 998
 999         let split_s   n = split_s_prefix ++ "__" ++ show n `joinFileExt` "s"
1000             split_obj n = split_odir `joinFileName`
1001                                 filenameOf base_o ++ "__" ++ show n
1002                                         `joinFileExt` osuf
1003
1004         let assemble_file n
1005               = SysTools.runAs dflags
1006                          (map SysTools.Option as_opts ++
1007                          [ SysTools.Option "-c"
1008                          , SysTools.Option "-o"
1009                          , SysTools.FileOption "" (split_obj n)
1010                          , SysTools.FileOption "" (split_s n)
1011                          ])
1012
1013         mapM_ assemble_file [1..n]
1014
1015         -- and join the split objects into a single object file:
1016         let ld_r args = SysTools.runLink dflags ([
1017                                 SysTools.Option "-nostdlib",
1018                                 SysTools.Option "-nodefaultlibs",
1019                                 SysTools.Option "-Wl,-r",
1020                                 SysTools.Option ld_x_flag,
1021                                 SysTools.Option "-o",
1022                                 SysTools.FileOption "" output_fn ] ++ args)
1023             ld_x_flag | null cLD_X = ""
1024                       | otherwise  = "-Wl,-x"
1025
1026         if cLdIsGNULd == "YES"
1027             then do
1028                   let script = split_odir `joinFileName` "ld.script"
1029                   writeFile script $
1030                       "INPUT(" ++ unwords (map split_obj [1..n]) ++ ")"
1031                   ld_r [SysTools.FileOption "" script]
1032             else do
1033                   ld_r (map (SysTools.FileOption "" . split_obj) [1..n])
1034
1035         return (StopLn, dflags, maybe_loc, output_fn)
1036
1037
1038 -----------------------------------------------------------------------------
1039 -- MoveBinary sort-of-phase
1040 -- After having produced a binary, move it somewhere else and generate a
1041 -- wrapper script calling the binary. Currently, we need this only in
1042 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
1043 -- central directory.
1044 -- This is called from staticLink below, after linking. I haven't made it
1045 -- a separate phase to minimise interfering with other modules, and
1046 -- we don't need the generality of a phase (MoveBinary is always
1047 -- done after linking and makes only sense in a parallel setup)   -- HWL
1048
1049 runPhase_MoveBinary dflags input_fn
1050   = do
1051         let sysMan = pgm_sysman dflags
1052         pvm_root <- getEnv "PVM_ROOT"
1053         pvm_arch <- getEnv "PVM_ARCH"
1054         let
1055            pvm_executable_base = "=" ++ input_fn
1056            pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
1057         -- nuke old binary; maybe use configur'ed names for cp and rm?
1058         system ("rm -f " ++ pvm_executable)
1059         -- move the newly created binary into PVM land
1060         system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
1061         -- generate a wrapper script for running a parallel prg under PVM
1062         writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
1063         return True
1064
1065 -- generates a Perl skript starting a parallel prg under PVM
1066 mk_pvm_wrapper_script :: String -> String -> String -> String
1067 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
1068  [
1069   "eval 'exec perl -S $0 ${1+\"$@\"}'",
1070   "  if $running_under_some_shell;",
1071   "# =!=!=!=!=!=!=!=!=!=!=!",
1072   "# This script is automatically generated: DO NOT EDIT!!!",
1073   "# Generated by Glasgow Haskell Compiler",
1074   "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
1075   "#",
1076   "$pvm_executable      = '" ++ pvm_executable ++ "';",
1077   "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
1078   "$SysMan = '" ++ sysMan ++ "';",
1079   "",
1080   {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
1081   "# first, some magical shortcuts to run "commands" on the binary",
1082   "# (which is hidden)",
1083   "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
1084   "    local($cmd) = $1;",
1085   "    system("$cmd $pvm_executable");",
1086   "    exit(0); # all done",
1087   "}", -}
1088   "",
1089   "# Now, run the real binary; process the args first",
1090   "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
1091   "$debug = '';",
1092   "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
1093   "@nonPVM_args = ();",
1094   "$in_RTS_args = 0;",
1095   "",
1096   "args: while ($a = shift(@ARGV)) {",
1097   "    if ( $a eq '+RTS' ) {",
1098   "     $in_RTS_args = 1;",
1099   "    } elsif ( $a eq '-RTS' ) {",
1100   "     $in_RTS_args = 0;",
1101   "    }",
1102   "    if ( $a eq '-d' && $in_RTS_args ) {",
1103   "     $debug = '-';",
1104   "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
1105   "     $nprocessors = $1;",
1106   "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
1107   "     $nprocessors = $1;",
1108   "    } else {",
1109   "     push(@nonPVM_args, $a);",
1110   "    }",
1111   "}",
1112   "",
1113   "local($return_val) = 0;",
1114   "# Start the parallel execution by calling SysMan",
1115   "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
1116   "$return_val = $?;",
1117   "# ToDo: fix race condition moving files and flushing them!!",
1118   "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
1119   "exit($return_val);"
1120  ]
1121
1122 -----------------------------------------------------------------------------
1123 -- Complain about non-dynamic flags in OPTIONS pragmas
1124
1125 checkProcessArgsResult flags filename
1126   = do when (notNull flags) (throwDyn (ProgramError (
1127           showSDoc (hang (text filename <> char ':')
1128                       4 (text "unknown flags in  {-# OPTIONS #-} pragma:" <+>
1129                           hsep (map text flags)))
1130         )))
1131
1132 -----------------------------------------------------------------------------
1133 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
1134
1135 getHCFilePackages :: FilePath -> IO [PackageId]
1136 getHCFilePackages filename =
1137   Exception.bracket (openFile filename ReadMode) hClose $ \h -> do
1138     l <- hGetLine h
1139     case l of
1140       '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
1141           return (map stringToPackageId (words rest))
1142       _other ->
1143           return []
1144
1145 -----------------------------------------------------------------------------
1146 -- Static linking, of .o files
1147
1148 -- The list of packages passed to link is the list of packages on
1149 -- which this program depends, as discovered by the compilation
1150 -- manager.  It is combined with the list of packages that the user
1151 -- specifies on the command line with -package flags.
1152 --
1153 -- In one-shot linking mode, we can't discover the package
1154 -- dependencies (because we haven't actually done any compilation or
1155 -- read any interface files), so the user must explicitly specify all
1156 -- the packages.
1157
1158 staticLink :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
1159 staticLink dflags o_files dep_packages = do
1160     let verb = getVerbFlag dflags
1161         output_fn = exeFileName dflags
1162
1163     -- get the full list of packages to link with, by combining the
1164     -- explicit packages with the auto packages and all of their
1165     -- dependencies, and eliminating duplicates.
1166
1167     pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1168     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1169
1170     let lib_paths = libraryPaths dflags
1171     let lib_path_opts = map ("-L"++) lib_paths
1172
1173     pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1174
1175 #ifdef darwin_TARGET_OS
1176     pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1177     let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1178
1179     let framework_paths = frameworkPaths dflags
1180         framework_path_opts = map ("-F"++) framework_paths
1181
1182     pkg_frameworks <- getPackageFrameworks dflags dep_packages
1183     let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1184
1185     let frameworks = cmdlineFrameworks dflags
1186         framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1187          -- reverse because they're added in reverse order from the cmd line
1188 #endif
1189
1190         -- probably _stub.o files
1191     extra_ld_inputs <- readIORef v_Ld_inputs
1192
1193         -- opts from -optl-<blah> (including -l<blah> options)
1194     let extra_ld_opts = getOpts dflags opt_l
1195
1196     let ways = wayNames dflags
1197
1198     -- Here are some libs that need to be linked at the *end* of
1199     -- the command line, because they contain symbols that are referred to
1200     -- by the RTS.  We can't therefore use the ordinary way opts for these.
1201     let
1202         debug_opts | WayDebug `elem` ways = [
1203 #if defined(HAVE_LIBBFD)
1204                         "-lbfd", "-liberty"
1205 #endif
1206                          ]
1207                    | otherwise            = []
1208
1209     let
1210         thread_opts | WayThreaded `elem` ways = [
1211 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1212                         "-lpthread"
1213 #endif
1214 #if defined(osf3_TARGET_OS)
1215                         , "-lexc"
1216 #endif
1217                         ]
1218                     | otherwise               = []
1219
1220     let (md_c_flags, _) = machdepCCOpts dflags
1221     SysTools.runLink dflags (
1222                        [ SysTools.Option verb
1223                        , SysTools.Option "-o"
1224                        , SysTools.FileOption "" output_fn
1225                        ]
1226                       ++ map SysTools.Option (
1227                          md_c_flags
1228                       ++ o_files
1229                       ++ extra_ld_inputs
1230                       ++ lib_path_opts
1231                       ++ extra_ld_opts
1232 #ifdef darwin_TARGET_OS
1233                       ++ framework_path_opts
1234                       ++ framework_opts
1235 #endif
1236                       ++ pkg_lib_path_opts
1237                       ++ pkg_link_opts
1238 #ifdef darwin_TARGET_OS
1239                       ++ pkg_framework_path_opts
1240                       ++ pkg_framework_opts
1241 #endif
1242                       ++ debug_opts
1243                       ++ thread_opts
1244                     ))
1245
1246     -- parallel only: move binary to another dir -- HWL
1247     when (WayPar `elem` ways)
1248          (do success <- runPhase_MoveBinary dflags output_fn
1249              if success then return ()
1250                         else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1251
1252
1253 exeFileName :: DynFlags -> FilePath
1254 exeFileName dflags
1255   | Just s <- outputFile dflags =
1256 #if defined(mingw32_HOST_OS)
1257       if null (suffixOf s)
1258         then s `joinFileExt` "exe"
1259         else s
1260 #else
1261       s
1262 #endif
1263   | otherwise =
1264 #if defined(mingw32_HOST_OS)
1265         "main.exe"
1266 #else
1267         "a.out"
1268 #endif
1269
1270 -----------------------------------------------------------------------------
1271 -- Making a DLL (only for Win32)
1272
1273 doMkDLL :: DynFlags -> [String] -> [PackageId] -> IO ()
1274 doMkDLL dflags o_files dep_packages = do
1275     let verb = getVerbFlag dflags
1276     let static = opt_Static
1277     let no_hs_main = dopt Opt_NoHsMain dflags
1278     let o_file = outputFile dflags
1279     let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1280
1281     pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1282     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1283
1284     let lib_paths = libraryPaths dflags
1285     let lib_path_opts = map ("-L"++) lib_paths
1286
1287     pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1288
1289         -- probably _stub.o files
1290     extra_ld_inputs <- readIORef v_Ld_inputs
1291
1292         -- opts from -optdll-<blah>
1293     let extra_ld_opts = getOpts dflags opt_dll
1294
1295     let pstate = pkgState dflags
1296         rts_pkg  = getPackageDetails pstate rtsPackageId
1297         base_pkg = getPackageDetails pstate basePackageId
1298
1299     let extra_os = if static || no_hs_main
1300                    then []
1301                    else [ head (libraryDirs rts_pkg) ++ "/Main.dll_o",
1302                           head (libraryDirs base_pkg) ++ "/PrelMain.dll_o" ]
1303
1304     let (md_c_flags, _) = machdepCCOpts dflags
1305     SysTools.runMkDLL dflags
1306          ([ SysTools.Option verb
1307           , SysTools.Option "-o"
1308           , SysTools.FileOption "" output_fn
1309           ]
1310          ++ map SysTools.Option (
1311             md_c_flags
1312          ++ o_files
1313          ++ extra_os
1314          ++ [ "--target=i386-mingw32" ]
1315          ++ extra_ld_inputs
1316          ++ lib_path_opts
1317          ++ extra_ld_opts
1318          ++ pkg_lib_path_opts
1319          ++ pkg_link_opts
1320          ++ (if "--def" `elem` (concatMap words extra_ld_opts)
1321                then [ "" ]
1322                else [ "--export-all" ])
1323         ))
1324
1325 -- -----------------------------------------------------------------------------
1326 -- Running CPP
1327
1328 doCpp :: DynFlags -> Bool -> Bool -> FilePath -> FilePath -> IO ()
1329 doCpp dflags raw include_cc_opts input_fn output_fn = do
1330     let hscpp_opts = getOpts dflags opt_P
1331     let cmdline_include_paths = includePaths dflags
1332
1333     pkg_include_dirs <- getPackageIncludePath dflags []
1334     let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1335                           (cmdline_include_paths ++ pkg_include_dirs)
1336
1337     let verb = getVerbFlag dflags
1338
1339     let cc_opts
1340           | not include_cc_opts = []
1341           | otherwise           = (optc ++ md_c_flags)
1342                 where
1343                       optc = getOpts dflags opt_c
1344                       (md_c_flags, _) = machdepCCOpts dflags
1345
1346     let cpp_prog args | raw       = SysTools.runCpp dflags args
1347                       | otherwise = SysTools.runCc dflags (SysTools.Option "-E" : args)
1348
1349     let target_defs =
1350           [ "-D" ++ HOST_OS     ++ "_BUILD_OS=1",
1351             "-D" ++ HOST_ARCH   ++ "_BUILD_ARCH=1",
1352             "-D" ++ TARGET_OS   ++ "_HOST_OS=1",
1353             "-D" ++ TARGET_ARCH ++ "_HOST_ARCH=1" ]
1354         -- remember, in code we *compile*, the HOST is the same our TARGET,
1355         -- and BUILD is the same as our HOST.
1356
1357     cpp_prog       ([SysTools.Option verb]
1358                     ++ map SysTools.Option include_paths
1359                     ++ map SysTools.Option hsSourceCppOpts
1360                     ++ map SysTools.Option hscpp_opts
1361                     ++ map SysTools.Option cc_opts
1362                     ++ map SysTools.Option target_defs
1363                     ++ [ SysTools.Option     "-x"
1364                        , SysTools.Option     "c"
1365                        , SysTools.Option     input_fn
1366         -- We hackily use Option instead of FileOption here, so that the file
1367         -- name is not back-slashed on Windows.  cpp is capable of
1368         -- dealing with / in filenames, so it works fine.  Furthermore
1369         -- if we put in backslashes, cpp outputs #line directives
1370         -- with *double* backslashes.   And that in turn means that
1371         -- our error messages get double backslashes in them.
1372         -- In due course we should arrange that the lexer deals
1373         -- with these \\ escapes properly.
1374                        , SysTools.Option     "-o"
1375                        , SysTools.FileOption "" output_fn
1376                        ])
1377
1378 cHaskell1Version = "5" -- i.e., Haskell 98
1379
1380 -- Default CPP defines in Haskell source
1381 hsSourceCppOpts =
1382         [ "-D__HASKELL1__="++cHaskell1Version
1383         , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
1384         , "-D__HASKELL98__"
1385         , "-D__CONCURRENT_HASKELL__"
1386         ]
1387
1388
1389 -- -----------------------------------------------------------------------------
1390 -- Misc.
1391
1392 hscNextPhase :: DynFlags -> HscSource -> HscTarget -> Phase
1393 hscNextPhase dflags HsBootFile hsc_lang  =  StopLn
1394 hscNextPhase dflags other hsc_lang =
1395   case hsc_lang of
1396         HscC -> HCc
1397         HscAsm | dopt Opt_SplitObjs dflags -> SplitMangle
1398                | otherwise -> As
1399         HscNothing     -> StopLn
1400         HscInterpreted -> StopLn
1401         _other         -> StopLn
1402
1403
1404 hscMaybeAdjustTarget :: DynFlags -> Phase -> HscSource -> HscTarget -> HscTarget
1405 hscMaybeAdjustTarget dflags stop HsBootFile current_hsc_lang
1406   = HscNothing          -- No output (other than Foo.hi-boot) for hs-boot files
1407 hscMaybeAdjustTarget dflags stop other current_hsc_lang
1408   = hsc_lang
1409   where
1410         keep_hc = dopt Opt_KeepHcFiles dflags
1411         hsc_lang
1412                 -- don't change the lang if we're interpreting
1413                  | current_hsc_lang == HscInterpreted = current_hsc_lang
1414
1415                 -- force -fvia-C if we are being asked for a .hc file
1416                  | HCc <- stop = HscC
1417                  | keep_hc     = HscC
1418                 -- otherwise, stick to the plan
1419                  | otherwise = current_hsc_lang
1420
1421 GLOBAL_VAR(v_Split_info, ("",0), (String,Int))
1422         -- The split prefix and number of files