ghc/compiler/main/DriverPipeline.hs

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