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