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