ghc/compiler/main/DriverPipeline.hs

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