ghc/compiler/main/DriverPipeline.hs

   1 -----------------------------------------------------------------------------
   2 -- $Id: DriverPipeline.hs,v 1.89 2001/07/11 19:48:07 sof Exp $
   3 --
   4 -- GHC Driver
   5 --
   6 -- (c) Simon Marlow 2000
   7 --
   8 -----------------------------------------------------------------------------
   9
  10 #include "../includes/config.h"
  11
  12 module DriverPipeline (
  13
  14         -- interfaces for the batch-mode driver
  15    GhcMode(..), getGhcMode, v_GhcMode,
  16    genPipeline, runPipeline, pipeLoop,
  17
  18         -- interfaces for the compilation manager (interpreted/batch-mode)
  19    preprocess, compile, CompResult(..),
  20
  21         -- batch-mode linking interface
  22    doLink,
  23         -- DLL building
  24    doMkDLL
  25   ) where
  26
  27 #include "HsVersions.h"
  28
  29 import Packages
  30 import CmTypes
  31 import GetImports
  32 import DriverState
  33 import DriverUtil
  34 import DriverMkDepend
  35 import DriverPhases
  36 import DriverFlags
  37 import SysTools         ( newTempName, addFilesToClean, getSysMan )
  38 import qualified SysTools
  39 import HscMain
  40 import Finder
  41 import HscTypes
  42 import Outputable
  43 import Module
  44 import ErrUtils
  45 import CmdLineOpts
  46 import Config
  47 import Panic
  48 import Util
  49
  50 import Time             ( getClockTime )
  51 import Directory
  52 import System
  53 import IOExts
  54 import Exception
  55
  56 import IO
  57 import Monad
  58 import Maybe
  59
  60 import PackedString
  61 import MatchPS
  62
  63 -----------------------------------------------------------------------------
  64 -- GHC modes of operation
  65
  66 modeFlag :: String -> Maybe GhcMode
  67 modeFlag "-M"            = Just $ DoMkDependHS
  68 modeFlag "--mk-dll"      = Just $ DoMkDLL
  69 modeFlag "-E"            = Just $ StopBefore Hsc
  70 modeFlag "-C"            = Just $ StopBefore HCc
  71 modeFlag "-S"            = Just $ StopBefore As
  72 modeFlag "-c"            = Just $ StopBefore Ln
  73 modeFlag "--make"        = Just $ DoMake
  74 modeFlag "--interactive" = Just $ DoInteractive
  75 modeFlag _               = Nothing
  76
  77 getGhcMode :: [String]
  78          -> IO ( [String]   -- rest of command line
  79                , GhcMode
  80                , String     -- "GhcMode" flag
  81                )
  82 getGhcMode flags
  83   = case my_partition modeFlag flags of
  84         ([]   , rest) -> return (rest, DoLink,  "") -- default is to do linking
  85         ([(flag,one)], rest) -> return (rest, one, flag)
  86         (_    , _   ) ->
  87           throwDyn (UsageError
  88                 "only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
  89
  90 -----------------------------------------------------------------------------
  91 -- genPipeline
  92 --
  93 -- Herein is all the magic about which phases to run in which order, whether
  94 -- the intermediate files should be in TMPDIR or in the current directory,
  95 -- what the suffix of the intermediate files should be, etc.
  96
  97 -- The following compilation pipeline algorithm is fairly hacky.  A
  98 -- better way to do this would be to express the whole compilation as a
  99 -- data flow DAG, where the nodes are the intermediate files and the
 100 -- edges are the compilation phases.  This framework would also work
 101 -- nicely if a haskell dependency generator was included in the
 102 -- driver.
 103
 104 -- It would also deal much more cleanly with compilation phases that
 105 -- generate multiple intermediates, (eg. hsc generates .hc, .hi, and
 106 -- possibly stub files), where some of the output files need to be
 107 -- processed further (eg. the stub files need to be compiled by the C
 108 -- compiler).
 109
 110 -- A cool thing to do would then be to execute the data flow graph
 111 -- concurrently, automatically taking advantage of extra processors on
 112 -- the host machine.  For example, when compiling two Haskell files
 113 -- where one depends on the other, the data flow graph would determine
 114 -- that the C compiler from the first compilation can be overlapped
 115 -- with the hsc compilation for the second file.
 116
 117 data IntermediateFileType
 118   = Temporary
 119   | Persistent
 120   deriving (Eq, Show)
 121
 122 genPipeline
 123    :: GhcMode            -- when to stop
 124    -> String             -- "stop after" flag (for error messages)
 125    -> Bool               -- True => output is persistent
 126    -> HscLang            -- preferred output language for hsc
 127    -> (FilePath, String) -- original filename & its suffix
 128    -> IO [              -- list of phases to run for this file
 129              (Phase,
 130               IntermediateFileType,  -- keep the output from this phase?
 131               String)                -- output file suffix
 132          ]
 133
 134 genPipeline todo stop_flag persistent_output lang (filename,suffix)
 135  = do
 136    split      <- readIORef v_Split_object_files
 137    mangle     <- readIORef v_Do_asm_mangling
 138    keep_hc    <- readIORef v_Keep_hc_files
 139    keep_raw_s <- readIORef v_Keep_raw_s_files
 140    keep_s     <- readIORef v_Keep_s_files
 141    osuf       <- readIORef v_Object_suf
 142    hcsuf      <- readIORef v_HC_suf
 143
 144    let
 145    ----------- -----  ----   ---   --   --  -  -  -
 146     start = startPhase suffix
 147
 148       -- special case for mkdependHS: .hspp files go through MkDependHS
 149     start_phase | todo == DoMkDependHS && start == Hsc  = MkDependHS
 150                 | otherwise = start
 151
 152     haskellish = haskellish_suffix suffix
 153     cish = cish_suffix suffix
 154
 155        -- for a .hc file we need to force lang to HscC
 156     real_lang | start_phase == HCc || start_phase == Mangle = HscC
 157               | otherwise                                   = lang
 158
 159    let
 160    ----------- -----  ----   ---   --   --  -  -  -
 161     pipeline
 162       | todo == DoMkDependHS = [ Unlit, Cpp, MkDependHS ]
 163
 164       | haskellish =
 165        case real_lang of
 166         HscC    | split && mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle,
 167                                         SplitMangle, SplitAs ]
 168                 | mangle          -> [ Unlit, Cpp, Hsc, HCc, Mangle, As ]
 169                 | split           -> not_valid
 170                 | otherwise       -> [ Unlit, Cpp, Hsc, HCc, As ]
 171
 172         HscAsm  | split           -> [ Unlit, Cpp, Hsc, SplitMangle, SplitAs ]
 173                 | otherwise       -> [ Unlit, Cpp, Hsc, As ]
 174
 175         HscJava | split           -> not_valid
 176                 | otherwise       -> error "not implemented: compiling via Java"
 177         HscILX  | split           -> not_valid
 178                 | otherwise       -> [ Unlit, Cpp, Hsc ]
 179
 180       | cish      = [ Cc, As ]
 181
 182       | otherwise = [ ]  -- just pass this file through to the linker
 183
 184         -- ToDo: this is somewhat cryptic
 185     not_valid = throwDyn (UsageError ("invalid option combination"))
 186
 187     stop_phase = case todo of
 188                         StopBefore As | split -> SplitAs
 189                         StopBefore phase      -> phase
 190                         DoMkDependHS          -> Ln
 191                         DoLink                -> Ln
 192    ----------- -----  ----   ---   --   --  -  -  -
 193
 194         -- this shouldn't happen.
 195    if start_phase /= Ln && start_phase `notElem` pipeline
 196         then throwDyn (CmdLineError ("can't find starting phase for "
 197                                      ++ filename))
 198         else do
 199
 200         -- if we can't find the phase we're supposed to stop before,
 201         -- something has gone wrong.  This test carefully avoids the
 202         -- case where we aren't supposed to do any compilation, because the file
 203         -- is already in linkable form (for example).
 204    if start_phase `elem` pipeline &&
 205         (stop_phase /= Ln && stop_phase `notElem` pipeline)
 206       then throwDyn (UsageError
 207                 ("flag " ++ stop_flag
 208                  ++ " is incompatible with source file `" ++ filename ++ "'"))
 209       else do
 210
 211    let
 212         -- .o and .hc suffixes can be overriden by command-line options:
 213       myPhaseInputExt Ln  | Just s <- osuf  = s
 214       myPhaseInputExt HCc | Just s <- hcsuf = s
 215       myPhaseInputExt other                 = phaseInputExt other
 216
 217       annotatePipeline
 218          :: [Phase]             -- raw pipeline
 219          -> Phase               -- phase to stop before
 220          -> [(Phase, IntermediateFileType, String{-file extension-})]
 221       annotatePipeline []     _    = []
 222       annotatePipeline (Ln:_) _    = []
 223       annotatePipeline (phase:next_phase:ps) stop =
 224           (phase, keep_this_output, myPhaseInputExt next_phase)
 225              : annotatePipeline (next_phase:ps) stop
 226           where
 227                 keep_this_output
 228                      | next_phase == stop
 229                      = if persistent_output then Persistent else Temporary
 230                      | otherwise
 231                      = case next_phase of
 232                              Ln -> Persistent
 233                              Mangle | keep_raw_s -> Persistent
 234                              As     | keep_s     -> Persistent
 235                              HCc    | keep_hc    -> Persistent
 236                              _other              -> Temporary
 237
 238         -- add information about output files to the pipeline
 239         -- the suffix on an output file is determined by the next phase
 240         -- in the pipeline, so we add linking to the end of the pipeline
 241         -- to force the output from the final phase to be a .o file.
 242
 243       annotated_pipeline = annotatePipeline (pipeline ++ [Ln]) stop_phase
 244
 245       phase_ne p (p1,_,_) = (p1 /= p)
 246    ----------- -----  ----   ---   --   --  -  -  -
 247
 248    return (
 249      takeWhile (phase_ne stop_phase ) $
 250      dropWhile (phase_ne start_phase) $
 251      annotated_pipeline
 252     )
 253
 254
 255 runPipeline
 256   :: [ (Phase, IntermediateFileType, String) ] -- phases to run
 257   -> (String,String)            -- input file
 258   -> Bool                       -- doing linking afterward?
 259   -> Bool                       -- take into account -o when generating output?
 260   -> IO (String, String)        -- return final filename
 261
 262 runPipeline pipeline (input_fn,suffix) do_linking use_ofile
 263   = pipeLoop pipeline (input_fn,suffix) do_linking use_ofile basename suffix
 264   where (basename, _) = splitFilename input_fn
 265
 266 pipeLoop [] input_fn _ _ _ _ = return input_fn
 267 pipeLoop ((phase, keep, o_suffix):phases)
 268         (input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
 269   = do
 270
 271      output_fn <- outputFileName (null phases) keep o_suffix
 272
 273      mbCarryOn <- run_phase phase orig_basename orig_suffix input_fn output_fn
 274         -- sometimes we bail out early, eg. when the compiler's recompilation
 275         -- checker has determined that recompilation isn't necessary.
 276      case mbCarryOn of
 277        Nothing -> do
 278               let (_,keep,final_suffix) = last phases
 279               ofile <- outputFileName True keep final_suffix
 280               return (ofile, final_suffix)
 281           -- carry on ...
 282        Just fn ->
 283               {-
 284                Notice that in order to keep the invariant that we can
 285                determine a compilation pipeline's 'start phase' just
 286                by looking at the input filename, the input filename
 287                to the next stage/phase is associated here with the suffix
 288                of the output file, *even* if it does not have that
 289                suffix in reality.
 290
 291                Why is this important? Because we may run a compilation
 292                pipeline in stages (cf. Main.main.compileFile's two stages),
 293                so when generating the next stage we need to be precise
 294                about what kind of file (=> suffix) is given as input.
 295
 296                [Not having to generate a pipeline in stages seems like
 297                 the right way to go, but I've punted on this for now --sof]
 298
 299               -}
 300               pipeLoop phases (fn, o_suffix) do_linking use_ofile
 301                         orig_basename orig_suffix
 302   where
 303      outputFileName last_phase keep suffix
 304         = do o_file <- readIORef v_Output_file
 305              if last_phase && not do_linking && use_ofile && isJust o_file
 306                then case o_file of
 307                        Just s  -> return s
 308                        Nothing -> error "outputFileName"
 309                else if keep == Persistent
 310                            then odir_ify (orig_basename ++ '.':suffix)
 311                            else newTempName suffix
 312
 313 run_phase :: Phase
 314           -> String                -- basename of original input source
 315           -> String                -- its extension
 316           -> FilePath              -- name of file which contains the input to this phase.
 317           -> FilePath              -- where to stick the result.
 318           -> IO (Maybe FilePath)
 319                   -- Nothing => stop the compilation pipeline
 320                   -- Just fn => the result of this phase can be found in 'fn'
 321                   --            (this can either be 'input_fn' or 'output_fn').
 322 -------------------------------------------------------------------------------
 323 -- Unlit phase
 324
 325 run_phase Unlit _basename _suff input_fn output_fn
 326   = do unlit_flags <- getOpts opt_L
 327        SysTools.runUnlit (unlit_flags ++ ["-h", input_fn, input_fn, output_fn])
 328        return (Just output_fn)
 329
 330 -------------------------------------------------------------------------------
 331 -- Cpp phase
 332
 333 run_phase Cpp basename suff input_fn output_fn
 334   = do src_opts <- getOptionsFromSource input_fn
 335        unhandled_flags <- processArgs dynamic_flags src_opts []
 336        checkProcessArgsResult unhandled_flags basename suff
 337
 338        do_cpp <- dynFlag cppFlag
 339        if not do_cpp then
 340            -- no need to preprocess CPP, just pass input file along
 341            -- to the next phase of the pipeline.
 342           return (Just input_fn)
 343         else do
 344             hscpp_opts      <- getOpts opt_P
 345             hs_src_cpp_opts <- readIORef v_Hs_source_cpp_opts
 346
 347             cmdline_include_paths <- readIORef v_Include_paths
 348             pkg_include_dirs <- getPackageIncludePath
 349             let include_paths = map (\p -> "-I"++p) (cmdline_include_paths
 350                                                         ++ pkg_include_dirs)
 351
 352             verb <- getVerbFlag
 353             (md_c_flags, _) <- machdepCCOpts
 354
 355             SysTools.runCpp ([verb]
 356                             ++ include_paths
 357                             ++ hs_src_cpp_opts
 358                             ++ hscpp_opts
 359                             ++ md_c_flags
 360                             ++ [ "-x", "c", input_fn, "-o", output_fn ])
 361             return (Just output_fn)
 362
 363 -----------------------------------------------------------------------------
 364 -- MkDependHS phase
 365
 366 run_phase MkDependHS basename suff input_fn output_fn = do
 367    src <- readFile input_fn
 368    let (import_sources, import_normals, _) = getImports src
 369
 370    let orig_fn = basename ++ '.':suff
 371    deps_sources <- mapM (findDependency True  orig_fn) import_sources
 372    deps_normals <- mapM (findDependency False orig_fn) import_normals
 373    let deps = deps_sources ++ deps_normals
 374
 375    osuf_opt <- readIORef v_Object_suf
 376    let osuf = case osuf_opt of
 377                         Nothing -> phaseInputExt Ln
 378                         Just s  -> s
 379
 380    extra_suffixes <- readIORef v_Dep_suffixes
 381    let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
 382        ofiles = map (\suf -> basename ++ '.':suf) suffixes
 383
 384    objs <- mapM odir_ify ofiles
 385
 386         -- Handle for file that accumulates dependencies
 387    hdl <- readIORef v_Dep_tmp_hdl
 388
 389         -- std dependency of the object(s) on the source file
 390    hPutStrLn hdl (unwords objs ++ " : " ++ basename ++ '.':suff)
 391
 392    let genDep (dep, False {- not an hi file -}) =
 393           hPutStrLn hdl (unwords objs ++ " : " ++ dep)
 394        genDep (dep, True  {- is an hi file -}) = do
 395           hisuf <- readIORef v_Hi_suf
 396           let dep_base = remove_suffix '.' dep
 397               deps = (dep_base ++ hisuf)
 398                      : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
 399                   -- length objs should be == length deps
 400           sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)
 401
 402    mapM genDep [ d | Just d <- deps ]
 403
 404    return (Just output_fn)
 405
 406 -- add the lines to dep_makefile:
 407            -- always:
 408                    -- this.o : this.hs
 409
 410            -- if the dependency is on something other than a .hi file:
 411                    -- this.o this.p_o ... : dep
 412            -- otherwise
 413                    -- if the import is {-# SOURCE #-}
 414                            -- this.o this.p_o ... : dep.hi-boot[-$vers]
 415
 416                    -- else
 417                            -- this.o ...   : dep.hi
 418                            -- this.p_o ... : dep.p_hi
 419                            -- ...
 420
 421            -- (where .o is $osuf, and the other suffixes come from
 422            -- the cmdline -s options).
 423
 424 -----------------------------------------------------------------------------
 425 -- Hsc phase
 426
 427 -- Compilation of a single module, in "legacy" mode (_not_ under
 428 -- the direction of the compilation manager).
 429 run_phase Hsc basename suff input_fn output_fn
 430   = do
 431
 432   -- we add the current directory (i.e. the directory in which
 433   -- the .hs files resides) to the import path, since this is
 434   -- what gcc does, and it's probably what you want.
 435         let current_dir = getdir basename
 436
 437         paths <- readIORef v_Include_paths
 438         writeIORef v_Include_paths (current_dir : paths)
 439
 440   -- figure out which header files to #include in a generated .hc file
 441         c_includes <- getPackageCIncludes
 442         cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
 443
 444         let cc_injects = unlines (map mk_include
 445                                  (c_includes ++ reverse cmdline_includes))
 446             mk_include h_file =
 447                 case h_file of
 448                    '"':_{-"-} -> "#include "++h_file
 449                    '<':_      -> "#include "++h_file
 450                    _          -> "#include \""++h_file++"\""
 451
 452         writeIORef v_HCHeader cc_injects
 453
 454   -- gather the imports and module name
 455         (srcimps,imps,mod_name) <- getImportsFromFile input_fn
 456
 457   -- build a ModuleLocation to pass to hscMain.
 458         Just (mod, location')
 459            <- mkHomeModuleLocn mod_name basename (Just (basename ++ '.':suff))
 460
 461   -- take -ohi into account if present
 462         ohi <- readIORef v_Output_hi
 463         let location | Just fn <- ohi = location'{ ml_hi_file = fn }
 464                      | otherwise      = location'
 465
 466   -- figure out if the source has changed, for recompilation avoidance.
 467   -- only do this if we're eventually going to generate a .o file.
 468   -- (ToDo: do when generating .hc files too?)
 469   --
 470   -- Setting source_unchanged to True means that M.o seems
 471   -- to be up to date wrt M.hs; so no need to recompile unless imports have
 472   -- changed (which the compiler itself figures out).
 473   -- Setting source_unchanged to False tells the compiler that M.o is out of
 474   -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
 475         do_recomp   <- readIORef v_Recomp
 476         todo        <- readIORef v_GhcMode
 477         expl_o_file <- readIORef v_Output_file
 478         let o_file =
 479                 case expl_o_file of
 480                   Nothing -> unJust "source_unchanged" (ml_obj_file location)
 481                   Just x  -> x
 482         source_unchanged <-
 483           if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
 484              then return False
 485              else do t1 <- getModificationTime (basename ++ '.':suff)
 486                      o_file_exists <- doesFileExist o_file
 487                      if not o_file_exists
 488                         then return False       -- Need to recompile
 489                         else do t2 <- getModificationTime o_file
 490                                 if t2 > t1
 491                                   then return True
 492                                   else return False
 493
 494   -- get the DynFlags
 495         dyn_flags <- getDynFlags
 496
 497         let dyn_flags' = dyn_flags { hscOutName = output_fn,
 498                                      hscStubCOutName = basename ++ "_stub.c",
 499                                      hscStubHOutName = basename ++ "_stub.h",
 500                                      extCoreName = basename ++ ".core" }
 501
 502   -- run the compiler!
 503         pcs <- initPersistentCompilerState
 504         result <- hscMain OneShot
 505                           dyn_flags' mod
 506                           location{ ml_hspp_file=Just input_fn }
 507                           source_unchanged
 508                           False
 509                           Nothing        -- no iface
 510                           emptyModuleEnv -- HomeSymbolTable
 511                           emptyModuleEnv -- HomeIfaceTable
 512                           pcs
 513
 514         case result of {
 515
 516             HscFail pcs -> throwDyn (PhaseFailed "hsc" (ExitFailure 1));
 517
 518             HscNoRecomp pcs details iface -> do { SysTools.touch "Touching object file" o_file
 519                                                 ; return Nothing } ;
 520
 521             HscRecomp pcs details iface stub_h_exists stub_c_exists
 522                       _maybe_interpreted_code -> do
 523
 524             -- deal with stubs
 525         maybe_stub_o <- compileStub dyn_flags' stub_c_exists
 526         case maybe_stub_o of
 527                 Nothing -> return ()
 528                 Just stub_o -> add v_Ld_inputs stub_o
 529
 530         return (Just output_fn)
 531     }
 532
 533 -----------------------------------------------------------------------------
 534 -- Cc phase
 535
 536 -- we don't support preprocessing .c files (with -E) now.  Doing so introduces
 537 -- way too many hacks, and I can't say I've ever used it anyway.
 538
 539 run_phase cc_phase basename suff input_fn output_fn
 540    | cc_phase == Cc || cc_phase == HCc
 541    = do cc_opts              <- getOpts opt_c
 542         cmdline_include_dirs <- readIORef v_Include_paths
 543
 544         let hcc = cc_phase == HCc
 545
 546                 -- add package include paths even if we're just compiling
 547                 -- .c files; this is the Value Add(TM) that using
 548                 -- ghc instead of gcc gives you :)
 549         pkg_include_dirs <- getPackageIncludePath
 550         let include_paths = map (\p -> "-I"++p) (cmdline_include_dirs
 551                                                         ++ pkg_include_dirs)
 552
 553         mangle <- readIORef v_Do_asm_mangling
 554         (md_c_flags, md_regd_c_flags) <- machdepCCOpts
 555
 556         verb <- getVerbFlag
 557
 558         o2 <- readIORef v_minus_o2_for_C
 559         let opt_flag | o2        = "-O2"
 560                      | otherwise = "-O"
 561
 562         pkg_extra_cc_opts <- getPackageExtraCcOpts
 563
 564         split_objs <- readIORef v_Split_object_files
 565         let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
 566                       | otherwise         = [ ]
 567
 568         excessPrecision <- readIORef v_Excess_precision
 569         SysTools.runCc ([ "-x", "c", input_fn, "-o", output_fn ]
 570                        ++ md_c_flags
 571                        ++ (if cc_phase == HCc && mangle
 572                              then md_regd_c_flags
 573                              else [])
 574                        ++ [ verb, "-S", "-Wimplicit", opt_flag ]
 575                        ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
 576                        ++ cc_opts
 577                        ++ split_opt
 578                        ++ (if excessPrecision then [] else [ "-ffloat-store" ])
 579                        ++ include_paths
 580                        ++ pkg_extra_cc_opts
 581                        )
 582         return (Just output_fn)
 583
 584         -- ToDo: postprocess the output from gcc
 585
 586 -----------------------------------------------------------------------------
 587 -- Mangle phase
 588
 589 run_phase Mangle _basename _suff input_fn output_fn
 590   = do mangler_opts <- getOpts opt_m
 591        machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
 592                        then do n_regs <- dynFlag stolen_x86_regs
 593                                return [ show n_regs ]
 594                        else return []
 595
 596        SysTools.runMangle (mangler_opts
 597                           ++ [ input_fn, output_fn ]
 598                           ++ machdep_opts)
 599        return (Just output_fn)
 600
 601 -----------------------------------------------------------------------------
 602 -- Splitting phase
 603
 604 run_phase SplitMangle _basename _suff input_fn output_fn
 605   = do  -- tmp_pfx is the prefix used for the split .s files
 606         -- We also use it as the file to contain the no. of split .s files (sigh)
 607         split_s_prefix <- SysTools.newTempName "split"
 608         let n_files_fn = split_s_prefix
 609
 610         SysTools.runSplit [input_fn, split_s_prefix, n_files_fn]
 611
 612         -- Save the number of split files for future references
 613         s <- readFile n_files_fn
 614         let n_files = read s :: Int
 615         writeIORef v_Split_info (split_s_prefix, n_files)
 616
 617         -- Remember to delete all these files
 618         addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
 619                         | n <- [1..n_files]]
 620
 621         return (Just output_fn)
 622
 623 -----------------------------------------------------------------------------
 624 -- As phase
 625
 626 run_phase As _basename _suff input_fn output_fn
 627   = do  as_opts               <- getOpts opt_a
 628         cmdline_include_paths <- readIORef v_Include_paths
 629
 630         SysTools.runAs (as_opts
 631                        ++ [ "-I" ++ p | p <- cmdline_include_paths ]
 632                        ++ [ "-c", input_fn, "-o",  output_fn ])
 633         return (Just output_fn)
 634
 635 run_phase SplitAs basename _suff _input_fn output_fn
 636   = do  as_opts <- getOpts opt_a
 637
 638         (split_s_prefix, n) <- readIORef v_Split_info
 639
 640         odir <- readIORef v_Output_dir
 641         let real_odir = case odir of
 642                                 Nothing -> basename
 643                                 Just d  -> d
 644
 645         let assemble_file n
 646               = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
 647                     let output_o = newdir real_odir
 648                                         (basename ++ "__" ++ show n ++ ".o")
 649                     real_o <- osuf_ify output_o
 650                     SysTools.runAs (as_opts ++ ["-c", "-o", real_o, input_s])
 651
 652         mapM_ assemble_file [1..n]
 653         return (Just output_fn)
 654
 655 -----------------------------------------------------------------------------
 656 -- MoveBinary sort-of-phase
 657 -- After having produced a binary, move it somewhere else and generate a
 658 -- wrapper script calling the binary. Currently, we need this only in
 659 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
 660 -- central directory.
 661 -- This is called from doLink below, after linking. I haven't made it
 662 -- a separate phase to minimise interfering with other modules, and
 663 -- we don't need the generality of a phase (MoveBinary is always
 664 -- done after linking and makes only sense in a parallel setup)   -- HWL
 665
 666 run_phase_MoveBinary input_fn
 667   = do
 668         sysMan   <- getSysMan
 669         pvm_root <- getEnv "PVM_ROOT"
 670         pvm_arch <- getEnv "PVM_ARCH"
 671         let
 672            pvm_executable_base = "=" ++ input_fn
 673            pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
 674         -- nuke old binary; maybe use configur'ed names for cp and rm?
 675         system ("rm -f " ++ pvm_executable)
 676         -- move the newly created binary into PVM land
 677         system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
 678         -- generate a wrapper script for running a parallel prg under PVM
 679         writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
 680         return True
 681
 682 -- generates a Perl skript starting a parallel prg under PVM
 683 mk_pvm_wrapper_script :: String -> String -> String -> String
 684 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
 685  [
 686   "eval 'exec perl -S $0 ${1+\"$@\"}'",
 687   "  if $running_under_some_shell;",
 688   "# =!=!=!=!=!=!=!=!=!=!=!",
 689   "# This script is automatically generated: DO NOT EDIT!!!",
 690   "# Generated by Glasgow Haskell Compiler",
 691   "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
 692   "#",
 693   "$pvm_executable      = '" ++ pvm_executable ++ "';",
 694   "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
 695   "$SysMan = '" ++ sysMan ++ "';",
 696   "",
 697   {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
 698   "# first, some magical shortcuts to run "commands" on the binary",
 699   "# (which is hidden)",
 700   "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
 701   "    local($cmd) = $1;",
 702   "    system("$cmd $pvm_executable");",
 703   "    exit(0); # all done",
 704   "}", -}
 705   "",
 706   "# Now, run the real binary; process the args first",
 707   "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
 708   "$debug = '';",
 709   "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
 710   "@nonPVM_args = ();",
 711   "$in_RTS_args = 0;",
 712   "",
 713   "args: while ($a = shift(@ARGV)) {",
 714   "    if ( $a eq '+RTS' ) {",
 715   "     $in_RTS_args = 1;",
 716   "    } elsif ( $a eq '-RTS' ) {",
 717   "     $in_RTS_args = 0;",
 718   "    }",
 719   "    if ( $a eq '-d' && $in_RTS_args ) {",
 720   "     $debug = '-';",
 721   "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
 722   "     $nprocessors = $1;",
 723   "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
 724   "     $nprocessors = $1;",
 725   "    } else {",
 726   "     push(@nonPVM_args, $a);",
 727   "    }",
 728   "}",
 729   "",
 730   "local($return_val) = 0;",
 731   "# Start the parallel execution by calling SysMan",
 732   "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
 733   "$return_val = $?;",
 734   "# ToDo: fix race condition moving files and flushing them!!",
 735   "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
 736   "exit($return_val);"
 737  ]
 738
 739 -----------------------------------------------------------------------------
 740 -- Complain about non-dynamic flags in OPTIONS pragmas
 741
 742 checkProcessArgsResult flags basename suff
 743   = do when (not (null flags)) (throwDyn (ProgramError (
 744            basename ++ "." ++ suff
 745            ++ ": static flags are not allowed in {-# OPTIONS #-} pragmas:\n\t"
 746            ++ unwords flags)) (ExitFailure 1))
 747
 748 -----------------------------------------------------------------------------
 749 -- Linking
 750
 751 doLink :: [String] -> IO ()
 752 doLink o_files = do
 753     verb       <- getVerbFlag
 754     static     <- readIORef v_Static
 755     no_hs_main <- readIORef v_NoHsMain
 756
 757     o_file <- readIORef v_Output_file
 758     let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
 759
 760     pkg_lib_paths <- getPackageLibraryPath
 761     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
 762
 763     lib_paths <- readIORef v_Library_paths
 764     let lib_path_opts = map ("-L"++) lib_paths
 765
 766     pkg_libs <- getPackageLibraries
 767     let imp          = if static then "" else "_imp"
 768         pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
 769
 770     libs <- readIORef v_Cmdline_libraries
 771     let lib_opts = map ("-l"++) (reverse libs)
 772          -- reverse because they're added in reverse order from the cmd line
 773
 774     pkg_extra_ld_opts <- getPackageExtraLdOpts
 775
 776         -- probably _stub.o files
 777     extra_ld_inputs <- readIORef v_Ld_inputs
 778
 779         -- opts from -optl-<blah>
 780     extra_ld_opts <- getStaticOpts v_Opt_l
 781
 782     rts_pkg <- getPackageDetails ["rts"]
 783     std_pkg <- getPackageDetails ["std"]
 784     let extra_os = if static || no_hs_main
 785                    then []
 786                    else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
 787                           head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
 788
 789     (md_c_flags, _) <- machdepCCOpts
 790     SysTools.runLink ( [verb, "-o", output_fn]
 791                       ++ md_c_flags
 792                       ++ o_files
 793                       ++ extra_os
 794                       ++ extra_ld_inputs
 795                       ++ lib_path_opts
 796                       ++ lib_opts
 797                       ++ pkg_lib_path_opts
 798                       ++ pkg_lib_opts
 799                       ++ pkg_extra_ld_opts
 800                       ++ extra_ld_opts
 801                       ++ if static && not no_hs_main then
 802 #ifdef LEADING_UNDERSCORE
 803                             [ "-u _PrelMain_mainIO_closure" ,
 804                               "-u ___init_PrelMain"]
 805 #else
 806                             [ "-u PrelMain_mainIO_closure" ,
 807                               "-u __init_PrelMain"]
 808 #endif
 809                          else [])
 810
 811     -- parallel only: move binary to another dir -- HWL
 812     ways_ <- readIORef v_Ways
 813     when (WayPar `elem` ways_)
 814          (do success <- run_phase_MoveBinary output_fn
 815              if success then return ()
 816                         else throwDyn (InstallationError ("cannot move binary to PVM dir")))
 817
 818 -----------------------------------------------------------------------------
 819 -- Making a DLL (only for Win32)
 820
 821 doMkDLL :: [String] -> IO ()
 822 doMkDLL o_files = do
 823     verb       <- getVerbFlag
 824     static     <- readIORef v_Static
 825     no_hs_main <- readIORef v_NoHsMain
 826
 827     o_file <- readIORef v_Output_file
 828     let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
 829
 830     pkg_lib_paths <- getPackageLibraryPath
 831     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
 832
 833     lib_paths <- readIORef v_Library_paths
 834     let lib_path_opts = map ("-L"++) lib_paths
 835
 836     pkg_libs <- getPackageLibraries
 837     let imp = if static then "" else "_imp"
 838         pkg_lib_opts = map (\lib -> "-l" ++ lib ++ imp) pkg_libs
 839
 840     libs <- readIORef v_Cmdline_libraries
 841     let lib_opts = map ("-l"++) (reverse libs)
 842          -- reverse because they're added in reverse order from the cmd line
 843
 844     pkg_extra_ld_opts <- getPackageExtraLdOpts
 845
 846         -- probably _stub.o files
 847     extra_ld_inputs <- readIORef v_Ld_inputs
 848
 849         -- opts from -optdll-<blah>
 850     extra_ld_opts <- getStaticOpts v_Opt_dll
 851
 852     rts_pkg <- getPackageDetails ["rts"]
 853     std_pkg <- getPackageDetails ["std"]
 854
 855     let extra_os = if static || no_hs_main
 856                    then []
 857                    else [ head (library_dirs (head rts_pkg)) ++ "/Main.dll_o",
 858                           head (library_dirs (head std_pkg)) ++ "/PrelMain.dll_o" ]
 859
 860     (md_c_flags, _) <- machdepCCOpts
 861     SysTools.runMkDLL
 862          ([ verb, "-o", output_fn ]
 863          ++ md_c_flags
 864          ++ o_files
 865          ++ extra_os
 866          ++ [ "--target=i386-mingw32" ]
 867          ++ extra_ld_inputs
 868          ++ lib_path_opts
 869          ++ lib_opts
 870          ++ pkg_lib_path_opts
 871          ++ pkg_lib_opts
 872          ++ pkg_extra_ld_opts
 873          ++ (case findPS (packString (concat extra_ld_opts)) (packString "--def") of
 874                Nothing -> [ "--export-all" ]
 875                Just _  -> [ "" ])
 876          ++ extra_ld_opts
 877         )
 878
 879 -----------------------------------------------------------------------------
 880 -- Just preprocess a file, put the result in a temp. file (used by the
 881 -- compilation manager during the summary phase).
 882
 883 preprocess :: FilePath -> IO FilePath
 884 preprocess filename =
 885   ASSERT(haskellish_src_file filename)
 886   do restoreDynFlags    -- Restore to state of last save
 887      pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False
 888                              defaultHscLang (filename, getFileSuffix filename)
 889      (fn,_)   <- runPipeline pipeline (filename,getFileSuffix filename)
 890                              False{-no linking-} False{-no -o flag-}
 891      return fn
 892
 893 -----------------------------------------------------------------------------
 894 -- Compile a single module, under the control of the compilation manager.
 895 --
 896 -- This is the interface between the compilation manager and the
 897 -- compiler proper (hsc), where we deal with tedious details like
 898 -- reading the OPTIONS pragma from the source file, and passing the
 899 -- output of hsc through the C compiler.
 900
 901 -- The driver sits between 'compile' and 'hscMain', translating calls
 902 -- to the former into calls to the latter, and results from the latter
 903 -- into results from the former.  It does things like preprocessing
 904 -- the .hs file if necessary, and compiling up the .stub_c files to
 905 -- generate Linkables.
 906
 907 -- NB.  No old interface can also mean that the source has changed.
 908
 909 compile :: GhciMode                -- distinguish batch from interactive
 910         -> ModSummary              -- summary, including source
 911         -> Bool                    -- True <=> source unchanged
 912         -> Bool                    -- True <=> have object
 913         -> Maybe ModIface          -- old interface, if available
 914         -> HomeSymbolTable         -- for home module ModDetails
 915         -> HomeIfaceTable          -- for home module Ifaces
 916         -> PersistentCompilerState -- persistent compiler state
 917         -> IO CompResult
 918
 919 data CompResult
 920    = CompOK   PersistentCompilerState   -- updated PCS
 921               ModDetails  -- new details (HST additions)
 922               ModIface    -- new iface   (HIT additions)
 923               (Maybe Linkable)
 924                        -- new code; Nothing => compilation was not reqd
 925                        -- (old code is still valid)
 926
 927    | CompErrs PersistentCompilerState   -- updated PCS
 928
 929
 930 compile ghci_mode summary source_unchanged have_object
 931         old_iface hst hit pcs = do
 932    dyn_flags <- restoreDynFlags         -- Restore to the state of the last save
 933
 934
 935    showPass dyn_flags
 936         (showSDoc (text "Compiling" <+> ppr (name_of_summary summary)))
 937
 938    let verb       = verbosity dyn_flags
 939    let location   = ms_location summary
 940    let input_fn   = unJust "compile:hs" (ml_hs_file location)
 941    let input_fnpp = unJust "compile:hspp" (ml_hspp_file location)
 942
 943    when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
 944
 945    opts <- getOptionsFromSource input_fnpp
 946    processArgs dynamic_flags opts []
 947    dyn_flags <- getDynFlags
 948
 949    let hsc_lang      = hscLang dyn_flags
 950        (basename, _) = splitFilename input_fn
 951
 952    output_fn <- case hsc_lang of
 953                     HscAsm         -> newTempName (phaseInputExt As)
 954                     HscC           -> newTempName (phaseInputExt HCc)
 955                     HscJava        -> newTempName "java" -- ToDo
 956                     HscILX         -> return (basename ++ ".ilx")       -- newTempName "ilx"    -- ToDo
 957                     HscInterpreted -> return (error "no output file")
 958
 959    let dyn_flags' = dyn_flags { hscOutName = output_fn,
 960                                 hscStubCOutName = basename ++ "_stub.c",
 961                                 hscStubHOutName = basename ++ "_stub.h",
 962                                 extCoreName = basename ++ ".core" }
 963
 964    -- figure out which header files to #include in a generated .hc file
 965    c_includes <- getPackageCIncludes
 966    cmdline_includes <- dynFlag cmdlineHcIncludes -- -#include options
 967
 968    let cc_injects = unlines (map mk_include
 969                                  (c_includes ++ reverse cmdline_includes))
 970        mk_include h_file =
 971         case h_file of
 972            '"':_{-"-} -> "#include "++h_file
 973            '<':_      -> "#include "++h_file
 974            _          -> "#include \""++h_file++"\""
 975
 976    writeIORef v_HCHeader cc_injects
 977
 978    -- run the compiler
 979    hsc_result <- hscMain ghci_mode dyn_flags'
 980                          (ms_mod summary) location
 981                          source_unchanged have_object old_iface hst hit pcs
 982
 983    case hsc_result of
 984       HscFail pcs -> return (CompErrs pcs)
 985
 986       HscNoRecomp pcs details iface -> return (CompOK pcs details iface Nothing)
 987
 988       HscRecomp pcs details iface
 989         stub_h_exists stub_c_exists maybe_interpreted_code -> do
 990
 991            let
 992            maybe_stub_o <- compileStub dyn_flags' stub_c_exists
 993            let stub_unlinked = case maybe_stub_o of
 994                                   Nothing -> []
 995                                   Just stub_o -> [ DotO stub_o ]
 996
 997            (hs_unlinked, unlinked_time) <-
 998              case hsc_lang of
 999
1000                 -- in interpreted mode, just return the compiled code
1001                 -- as our "unlinked" object.
1002                 HscInterpreted ->
1003                     case maybe_interpreted_code of
1004                        Just (bcos,itbl_env) -> do tm <- getClockTime
1005                                                   return ([BCOs bcos itbl_env], tm)
1006                        Nothing -> panic "compile: no interpreted code"
1007
1008                 -- we're in batch mode: finish the compilation pipeline.
1009                 _other -> do pipe <- genPipeline (StopBefore Ln) "" True
1010                                         hsc_lang (output_fn, getFileSuffix output_fn)
1011                              -- runPipeline takes input_fn so it can split off
1012                              -- the base name and use it as the base of
1013                              -- the output object file.
1014                              let (basename, suffix) = splitFilename input_fn
1015                              (o_file,_) <-
1016                                  pipeLoop pipe (output_fn, getFileSuffix output_fn)
1017                                                False False
1018                                                basename suffix
1019                              o_time <- getModificationTime o_file
1020                              return ([DotO o_file], o_time)
1021
1022            let linkable = LM unlinked_time (moduleName (ms_mod summary))
1023                              (hs_unlinked ++ stub_unlinked)
1024
1025            return (CompOK pcs details iface (Just linkable))
1026
1027
1028 -----------------------------------------------------------------------------
1029 -- stub .h and .c files (for foreign export support)
1030
1031 compileStub dflags stub_c_exists
1032   | not stub_c_exists = return Nothing
1033   | stub_c_exists = do
1034         -- compile the _stub.c file w/ gcc
1035         let stub_c = hscStubCOutName dflags
1036         pipeline   <- genPipeline (StopBefore Ln) "" True defaultHscLang (stub_c,"c")
1037         (stub_o,_) <- runPipeline pipeline (stub_c,"c") False{-no linking-}
1038                                   False{-no -o option-}
1039         return (Just stub_o)