ghc/compiler/main/DriverPipeline.hs

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