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