ghc/compiler/main/Main.hs

   1 {-# OPTIONS -fno-warn-incomplete-patterns -optc-DNON_POSIX_SOURCE #-}
   2
   3 -----------------------------------------------------------------------------
   4 -- $Id: Main.hs,v 1.138 2004/08/13 13:07:05 simonmar Exp $
   5 --
   6 -- GHC Driver program
   7 --
   8 -- (c) The University of Glasgow 2002
   9 --
  10 -----------------------------------------------------------------------------
  11
  12 -- with path so that ghc -M can find config.h
  13 #include "../includes/ghcconfig.h"
  14
  15 module Main (main) where
  16
  17 #include "HsVersions.h"
  18
  19
  20 #ifdef GHCI
  21 import InteractiveUI( ghciWelcomeMsg, interactiveUI )
  22 #endif
  23
  24
  25 import CompManager      ( cmInit, cmLoadModules, cmDepAnal )
  26 import HscTypes         ( GhciMode(..) )
  27 import Config           ( cBooterVersion, cGhcUnregisterised, cProjectVersion )
  28 import SysTools         ( getPackageConfigPath, initSysTools, cleanTempFiles,
  29                           normalisePath )
  30 import Packages         ( showPackages, getPackageConfigMap, basePackage,
  31                           haskell98Package
  32                         )
  33 import DriverPipeline   ( staticLink, doMkDLL, runPipeline )
  34 import DriverState      ( buildStgToDo,
  35                           findBuildTag,
  36                           getPackageExtraGhcOpts, unregFlags,
  37                           v_GhcMode, v_GhcModeFlag, GhcMode(..),
  38                           v_Keep_tmp_files, v_Ld_inputs, v_Ways,
  39                           v_Output_file, v_Output_hi,
  40                           readPackageConf, verifyOutputFiles, v_NoLink,
  41                           v_Build_tag
  42                         )
  43 import DriverFlags      ( buildStaticHscOpts,
  44                           dynamic_flags, processArgs, static_flags)
  45
  46 import DriverMkDepend   ( beginMkDependHS, endMkDependHS )
  47 import DriverPhases     ( isSourceFilename )
  48
  49 import DriverUtil       ( add, handle, handleDyn, later, unknownFlagsErr )
  50 import CmdLineOpts      ( dynFlag, restoreDynFlags,
  51                           saveDynFlags, setDynFlags, getDynFlags, dynFlag,
  52                           DynFlags(..), HscLang(..), v_Static_hsc_opts
  53                         )
  54 import BasicTypes       ( failed )
  55 import Outputable
  56 import Util
  57 import Panic            ( GhcException(..), panic, installSignalHandlers )
  58
  59 import DATA_IOREF       ( readIORef, writeIORef )
  60 import EXCEPTION        ( throwDyn, Exception(..),
  61                           AsyncException(StackOverflow) )
  62
  63 -- Standard Haskell libraries
  64 import IO
  65 import Directory        ( doesFileExist )
  66 import System           ( getArgs, exitWith, ExitCode(..) )
  67 import Monad
  68 import List
  69 import Maybe
  70
  71 -----------------------------------------------------------------------------
  72 -- ToDo:
  73
  74 -- new mkdependHS doesn't support all the options that the old one did (-X et al.)
  75 -- time commands when run with -v
  76 -- split marker
  77 -- java generation
  78 -- user ways
  79 -- Win32 support: proper signal handling
  80 -- make sure OPTIONS in .hs file propogate to .hc file if -C or -keep-hc-file-too
  81 -- reading the package configuration file is too slow
  82 -- -K<size>
  83
  84 -----------------------------------------------------------------------------
  85 -- Differences vs. old driver:
  86
  87 -- No more "Enter your Haskell program, end with ^D (on a line of its own):"
  88 -- consistency checking removed (may do this properly later)
  89 -- no -Ofile
  90
  91 -----------------------------------------------------------------------------
  92 -- Main loop
  93
  94 main =
  95   -- top-level exception handler: any unrecognised exception is a compiler bug.
  96   handle (\exception -> do
  97            hFlush stdout
  98            case exception of
  99                 -- an IO exception probably isn't our fault, so don't panic
 100                 IOException _ ->  hPutStrLn stderr (show exception)
 101                 AsyncException StackOverflow ->
 102                         hPutStrLn stderr "stack overflow: use +RTS -K<size> to increase it"
 103                 _other ->  hPutStr stderr (show (Panic (show exception)))
 104            exitWith (ExitFailure 1)
 105          ) $ do
 106
 107   -- all error messages are propagated as exceptions
 108   handleDyn (\dyn -> do
 109                 hFlush stdout
 110                 case dyn of
 111                      PhaseFailed _ code -> exitWith code
 112                      Interrupted -> exitWith (ExitFailure 1)
 113                      _ -> do hPutStrLn stderr (show (dyn :: GhcException))
 114                              exitWith (ExitFailure 1)
 115             ) $ do
 116
 117    -- make sure we clean up after ourselves
 118    later (do  forget_it <- readIORef v_Keep_tmp_files
 119               unless forget_it $ do
 120               verb <- dynFlag verbosity
 121               cleanTempFiles verb
 122      ) $ do
 123         -- exceptions will be blocked while we clean the temporary files,
 124         -- so there shouldn't be any difficulty if we receive further
 125         -- signals.
 126
 127    installSignalHandlers
 128
 129    argv <- getArgs
 130    let (minusB_args, argv') = partition (prefixMatch "-B") argv
 131    top_dir <- initSysTools minusB_args
 132
 133         -- Read the package configuration
 134    conf_file <- getPackageConfigPath
 135    readPackageConf conf_file
 136
 137         -- Process all the other arguments, and get the source files
 138    non_static <- processArgs static_flags argv' []
 139    mode <- readIORef v_GhcMode
 140
 141         -- -O and --interactive are not a good combination
 142         -- ditto with any kind of way selection
 143    orig_ways <- readIORef v_Ways
 144    when (notNull orig_ways && isInteractive mode) $
 145       do throwDyn (UsageError
 146                    "--interactive can't be used with -prof, -ticky, -unreg or -smp.")
 147
 148         -- Find the build tag, and re-process the build-specific options.
 149         -- Also add in flags for unregisterised compilation, if
 150         -- GhcUnregisterised=YES.
 151    way_opts <- findBuildTag
 152    let unreg_opts | cGhcUnregisterised == "YES" = unregFlags
 153                   | otherwise = []
 154    pkg_extra_opts <- getPackageExtraGhcOpts
 155    extra_non_static <- processArgs static_flags
 156                            (unreg_opts ++ way_opts ++ pkg_extra_opts) []
 157
 158         -- Give the static flags to hsc
 159    static_opts <- buildStaticHscOpts
 160    writeIORef v_Static_hsc_opts static_opts
 161
 162    -- build the default DynFlags (these may be adjusted on a per
 163    -- module basis by OPTIONS pragmas and settings in the interpreter).
 164
 165    stg_todo  <- buildStgToDo
 166
 167    -- set the "global" HscLang.  The HscLang can be further adjusted on a module
 168    -- by module basis, using only the -fvia-C and -fasm flags.  If the global
 169    -- HscLang is not HscC or HscAsm, -fvia-C and -fasm have no effect.
 170    dyn_flags <- getDynFlags
 171    let lang = case mode of
 172                  DoInteractive  -> HscInterpreted
 173                  DoEval _       -> HscInterpreted
 174                  _other         -> hscLang dyn_flags
 175
 176    setDynFlags (dyn_flags{ stgToDo  = stg_todo,
 177                            hscLang  = lang,
 178                            -- leave out hscOutName for now
 179                            hscOutName = panic "Main.main:hscOutName not set",
 180                            verbosity = case mode of
 181                                          DoEval _ -> 0
 182                                          _other   -> 1
 183                         })
 184
 185         -- The rest of the arguments are "dynamic"
 186         -- Leftover ones are presumably files
 187    fileish_args <- processArgs dynamic_flags (extra_non_static ++ non_static) []
 188
 189         -- save the "initial DynFlags" away
 190    saveDynFlags
 191
 192    let
 193     {-
 194       We split out the object files (.o, .dll) and add them
 195       to v_Ld_inputs for use by the linker.
 196
 197       The following things should be considered compilation manager inputs:
 198
 199        - haskell source files (strings ending in .hs, .lhs or other
 200          haskellish extension),
 201
 202        - module names (not forgetting hierarchical module names),
 203
 204        - and finally we consider everything not containing a '.' to be
 205          a comp manager input, as shorthand for a .hs or .lhs filename.
 206
 207       Everything else is considered to be a linker object, and passed
 208       straight through to the linker.
 209     -}
 210     looks_like_an_input m =  isSourceFilename m
 211                           || looksLikeModuleName m
 212                           || '.' `notElem` m
 213
 214      -- To simplify the handling of filepaths, we normalise all filepaths right
 215      -- away - e.g., for win32 platforms, backslashes are converted
 216      -- into forward slashes.
 217     normal_fileish_paths = map normalisePath fileish_args
 218     (srcs, objs)         = partition looks_like_an_input normal_fileish_paths
 219
 220     -- Note: have v_Ld_inputs maintain the order in which 'objs' occurred on
 221     --       the command-line.
 222    mapM_ (add v_Ld_inputs) (reverse objs)
 223
 224         ---------------- Display banners and configuration -----------
 225    showBanners mode conf_file static_opts
 226
 227         ---------------- Final sanity checking -----------
 228    checkOptions mode srcs objs
 229
 230     -- We always link in the base package in
 231     -- one-shot linking.  Any other packages
 232     -- required must be given using -package
 233     -- options on the command-line.
 234    let def_hs_pkgs = [basePackage, haskell98Package]
 235
 236         ---------------- Do the business -----------
 237    case mode of
 238         DoMake         -> doMake srcs
 239
 240         DoMkDependHS   -> do { beginMkDependHS ;
 241                                compileFiles mode srcs;
 242                                endMkDependHS }
 243         StopBefore p   -> do { compileFiles mode srcs; return () }
 244         DoMkDLL        -> do { o_files <- compileFiles mode srcs;
 245                                doMkDLL o_files def_hs_pkgs }
 246         DoLink         -> do { o_files <- compileFiles mode srcs;
 247                                omit_linking <- readIORef v_NoLink;
 248                                when (not omit_linking)
 249                                     (staticLink o_files def_hs_pkgs) }
 250
 251 #ifndef GHCI
 252         DoInteractive -> noInteractiveError
 253         DoEval _      -> noInteractiveError
 254      where
 255        noInteractiveError = throwDyn (CmdLineError "not built for interactive use")
 256 #else
 257         DoInteractive -> interactiveUI srcs Nothing
 258         DoEval expr   -> interactiveUI srcs (Just expr)
 259 #endif
 260
 261 -- -----------------------------------------------------------------------------
 262 -- Option sanity checks
 263
 264 checkOptions :: GhcMode -> [String] -> [String] -> IO ()
 265      -- Final sanity checking before kicking off a compilation (pipeline).
 266 checkOptions mode srcs objs = do
 267      -- Complain about any unknown flags
 268    let unknown_opts = [ f | f@('-':_) <- srcs ]
 269    when (notNull unknown_opts) (unknownFlagsErr unknown_opts)
 270
 271         -- -ohi sanity check
 272    ohi <- readIORef v_Output_hi
 273    if (isJust ohi &&
 274       (mode == DoMake || isInteractive mode || srcs `lengthExceeds` 1))
 275         then throwDyn (UsageError "-ohi can only be used when compiling a single source file")
 276         else do
 277
 278         -- -o sanity checking
 279    o_file <- readIORef v_Output_file
 280    if (srcs `lengthExceeds` 1 && isJust o_file && mode /= DoLink && mode /= DoMkDLL)
 281         then throwDyn (UsageError "can't apply -o to multiple source files")
 282         else do
 283
 284         -- Check that there are some input files (except in the interactive
 285         -- case)
 286    if null srcs && null objs && not (isInteractive mode)
 287         then throwDyn (UsageError "no input files")
 288         else do
 289
 290      -- Verify that output files point somewhere sensible.
 291    verifyOutputFiles
 292
 293 isInteractive DoInteractive = True
 294 isInteractive (DoEval _)    = True
 295 isInteractive _             = False
 296
 297 -- -----------------------------------------------------------------------------
 298 -- Compile files in one-shot mode.
 299
 300 compileFiles :: GhcMode
 301              -> [String]        -- Source files
 302              -> IO [String]     -- Object files
 303 compileFiles mode srcs = do
 304    stop_flag <- readIORef v_GhcModeFlag
 305    mapM (compileFile mode stop_flag) srcs
 306
 307
 308 compileFile mode stop_flag src = do
 309    restoreDynFlags
 310
 311    exists <- doesFileExist src
 312    when (not exists) $
 313         throwDyn (CmdLineError ("file `" ++ src ++ "' does not exist"))
 314
 315    o_file   <- readIORef v_Output_file
 316         -- when linking, the -o argument refers to the linker's output.
 317         -- otherwise, we use it as the name for the pipeline's output.
 318    let maybe_o_file
 319           | mode==DoLink || mode==DoMkDLL  = Nothing
 320           | otherwise                      = o_file
 321
 322    runPipeline mode stop_flag True maybe_o_file src Nothing{-no ModLocation-}
 323
 324
 325 -- ----------------------------------------------------------------------------
 326 -- Run --make mode
 327
 328 doMake :: [String] -> IO ()
 329 doMake []    = throwDyn (UsageError "no input files")
 330 doMake srcs  = do
 331     dflags <- getDynFlags
 332     state  <- cmInit Batch dflags
 333     graph  <- cmDepAnal state srcs
 334     (_, ok_flag, _) <- cmLoadModules state graph
 335     when (failed ok_flag) (exitWith (ExitFailure 1))
 336     return ()
 337
 338 -- ---------------------------------------------------------------------------
 339 -- Various banners and verbosity output.
 340
 341 showBanners :: GhcMode -> FilePath -> [String] -> IO ()
 342 showBanners mode conf_file static_opts = do
 343    verb <- dynFlag verbosity
 344
 345         -- Show the GHCi banner
 346 #  ifdef GHCI
 347    when (mode == DoInteractive && verb >= 1) $
 348       hPutStrLn stdout ghciWelcomeMsg
 349 #  endif
 350
 351         -- Display details of the configuration in verbose mode
 352    when (verb >= 2)
 353         (do hPutStr stderr "Glasgow Haskell Compiler, Version "
 354             hPutStr stderr cProjectVersion
 355             hPutStr stderr ", for Haskell 98, compiled by GHC version "
 356             hPutStrLn stderr cBooterVersion)
 357
 358    when (verb >= 2)
 359         (hPutStrLn stderr ("Using package config file: " ++ conf_file))
 360
 361    pkg_details <- getPackageConfigMap
 362    showPackages pkg_details
 363
 364    when (verb >= 3)
 365         (hPutStrLn stderr ("Hsc static flags: " ++ unwords static_opts))