-{-# OPTIONS -W -fno-warn-incomplete-patterns #-}
+{-# OPTIONS -fno-warn-incomplete-patterns -optc-DNON_POSIX_SOURCE #-}
+
-----------------------------------------------------------------------------
--- $Id: Main.hs,v 1.17 2000/11/03 10:42:39 simonmar Exp $
+-- $Id: Main.hs,v 1.138 2004/08/13 13:07:05 simonmar Exp $
--
-- GHC Driver program
--
--- (c) Simon Marlow 2000
+-- (c) The University of Glasgow 2002
--
-----------------------------------------------------------------------------
-- with path so that ghc -M can find config.h
-#include "../includes/config.h"
+#include "../includes/ghcconfig.h"
module Main (main) where
#include "HsVersions.h"
-import CompManager
-import DriverPipeline
-import DriverState
-import DriverFlags
-import DriverMkDepend
-import DriverUtil
-import DriverPhases ( Phase(..) )
-import CmdLineOpts ( HscLang(..), DynFlags(..), v_Static_hsc_opts )
-import TmpFiles
-import Finder ( initFinder )
-import CmStaticInfo
-import Config
-import Util
-import Panic
-import Concurrent
-#ifndef mingw32_TARGET_OS
-import Posix
+#ifdef GHCI
+import InteractiveUI( ghciWelcomeMsg, interactiveUI )
#endif
-import Directory
-import IOExts
-import Exception
-import Dynamic
+
+import CompManager ( cmInit, cmLoadModules, cmDepAnal )
+import HscTypes ( GhciMode(..) )
+import Config ( cBooterVersion, cGhcUnregisterised, cProjectVersion )
+import SysTools ( getPackageConfigPath, initSysTools, cleanTempFiles,
+ normalisePath )
+import Packages ( showPackages, getPackageConfigMap, basePackage,
+ haskell98Package
+ )
+import DriverPipeline ( staticLink, doMkDLL, runPipeline )
+import DriverState ( buildStgToDo,
+ findBuildTag,
+ getPackageExtraGhcOpts, unregFlags,
+ v_GhcMode, v_GhcModeFlag, GhcMode(..),
+ v_Keep_tmp_files, v_Ld_inputs, v_Ways,
+ v_Output_file, v_Output_hi,
+ readPackageConf, verifyOutputFiles, v_NoLink,
+ v_Build_tag
+ )
+import DriverFlags ( buildStaticHscOpts,
+ dynamic_flags, processArgs, static_flags)
+
+import DriverMkDepend ( beginMkDependHS, endMkDependHS )
+import DriverPhases ( isSourceFilename )
+
+import DriverUtil ( add, handle, handleDyn, later, unknownFlagsErr )
+import CmdLineOpts ( dynFlag, restoreDynFlags,
+ saveDynFlags, setDynFlags, getDynFlags, dynFlag,
+ DynFlags(..), HscLang(..), v_Static_hsc_opts
+ )
+import BasicTypes ( failed )
+import Outputable
+import Util
+import Panic ( GhcException(..), panic, installSignalHandlers )
+
+import DATA_IOREF ( readIORef, writeIORef )
+import EXCEPTION ( throwDyn, Exception(..),
+ AsyncException(StackOverflow) )
+
+-- Standard Haskell libraries
import IO
+import Directory ( doesFileExist )
+import System ( getArgs, exitWith, ExitCode(..) )
import Monad
import List
-import System
import Maybe
-
------------------------------------------------------------------------------
--- Changes:
-
--- * -fglasgow-exts NO LONGER IMPLIES -package lang!!! (-fglasgow-exts is a
--- dynamic flag whereas -package is a static flag.)
-
-----------------------------------------------------------------------------
-- ToDo:
--- -nohi doesn't work
-- new mkdependHS doesn't support all the options that the old one did (-X et al.)
-- time commands when run with -v
-- split marker
--- mkDLL
-- java generation
-- user ways
-- Win32 support: proper signal handling
-- make sure OPTIONS in .hs file propogate to .hc file if -C or -keep-hc-file-too
-- reading the package configuration file is too slow
--- -H, -K, -Rghc-timing
--- hi-diffs
+-- -K<size>
-----------------------------------------------------------------------------
-- Differences vs. old driver:
-- No more "Enter your Haskell program, end with ^D (on a line of its own):"
-- consistency checking removed (may do this properly later)
--- removed -noC
--- no hi diffs (could be added later)
-- no -Ofile
-----------------------------------------------------------------------------
-- Main loop
main =
+ -- top-level exception handler: any unrecognised exception is a compiler bug.
+ handle (\exception -> do
+ hFlush stdout
+ case exception of
+ -- an IO exception probably isn't our fault, so don't panic
+ IOException _ -> hPutStrLn stderr (show exception)
+ AsyncException StackOverflow ->
+ hPutStrLn stderr "stack overflow: use +RTS -K<size> to increase it"
+ _other -> hPutStr stderr (show (Panic (show exception)))
+ exitWith (ExitFailure 1)
+ ) $ do
+
-- all error messages are propagated as exceptions
- handleDyn (\dyn -> case dyn of
- PhaseFailed _phase code -> exitWith code
- Interrupted -> exitWith (ExitFailure 1)
- _ -> do hPutStrLn stderr (show (dyn :: BarfKind))
- exitWith (ExitFailure 1)
- ) $ do
+ handleDyn (\dyn -> do
+ hFlush stdout
+ case dyn of
+ PhaseFailed _ code -> exitWith code
+ Interrupted -> exitWith (ExitFailure 1)
+ _ -> do hPutStrLn stderr (show (dyn :: GhcException))
+ exitWith (ExitFailure 1)
+ ) $ do
-- make sure we clean up after ourselves
later (do forget_it <- readIORef v_Keep_tmp_files
unless forget_it $ do
- verb <- readIORef v_Verbose
+ verb <- dynFlag verbosity
cleanTempFiles verb
) $ do
-- exceptions will be blocked while we clean the temporary files,
-- so there shouldn't be any difficulty if we receive further
-- signals.
- -- install signal handlers
- main_thread <- myThreadId
-#ifndef mingw32_TARGET_OS
- let sig_handler = Catch (throwTo main_thread
- (DynException (toDyn Interrupted)))
- installHandler sigQUIT sig_handler Nothing
- installHandler sigINT sig_handler Nothing
-#endif
-
- pgm <- getProgName
- writeIORef v_Prog_name pgm
-
- argv <- getArgs
-
- -- grab any -B options from the command line first
- argv' <- setTopDir argv
- top_dir <- readIORef v_TopDir
-
- let installed s = top_dir ++ '/':s
- inplace s = top_dir ++ '/':cCURRENT_DIR ++ '/':s
-
- installed_pkgconfig = installed ("package.conf")
- inplace_pkgconfig = inplace (cGHC_DRIVER_DIR ++ "/package.conf.inplace")
-
- -- discover whether we're running in a build tree or in an installation,
- -- by looking for the package configuration file.
- am_installed <- doesFileExist installed_pkgconfig
-
- if am_installed
- then writeIORef v_Path_package_config installed_pkgconfig
- else do am_inplace <- doesFileExist inplace_pkgconfig
- if am_inplace
- then writeIORef v_Path_package_config inplace_pkgconfig
- else throwDyn (OtherError "can't find package.conf")
-
- -- set the location of our various files
- if am_installed
- then do writeIORef v_Path_usage (installed "ghc-usage.txt")
- writeIORef v_Pgm_L (installed "unlit")
- writeIORef v_Pgm_m (installed "ghc-asm")
- writeIORef v_Pgm_s (installed "ghc-split")
-
- else do writeIORef v_Path_usage (inplace (cGHC_DRIVER_DIR ++ "/ghc-usage.txt"))
- writeIORef v_Pgm_L (inplace cGHC_UNLIT)
- writeIORef v_Pgm_m (inplace cGHC_MANGLER)
- writeIORef v_Pgm_s (inplace cGHC_SPLIT)
-
- -- read the package configuration
- conf_file <- readIORef v_Path_package_config
- contents <- readFile conf_file
- let pkg_details = read contents -- ToDo: faster
- writeIORef v_Package_details pkg_details
-
- -- find the phase to stop after (i.e. -E, -C, -c, -S flags)
- (flags2, mode, stop_flag) <- getGhcMode argv'
- writeIORef v_GhcMode mode
-
- -- force lang to "C" if the -C flag was given
- case mode of StopBefore HCc -> writeIORef v_Hsc_Lang HscC
- _ -> return ()
-
- -- process all the other arguments, and get the source files
- non_static <- processArgs static_flags flags2 []
-
- -- find the build tag, and re-process the build-specific options
- more_opts <- findBuildTag
- way_non_static <- processArgs static_flags more_opts []
-
- -- give the static flags to hsc
+ installSignalHandlers
+
+ argv <- getArgs
+ let (minusB_args, argv') = partition (prefixMatch "-B") argv
+ top_dir <- initSysTools minusB_args
+
+ -- Read the package configuration
+ conf_file <- getPackageConfigPath
+ readPackageConf conf_file
+
+ -- Process all the other arguments, and get the source files
+ non_static <- processArgs static_flags argv' []
+ mode <- readIORef v_GhcMode
+
+ -- -O and --interactive are not a good combination
+ -- ditto with any kind of way selection
+ orig_ways <- readIORef v_Ways
+ when (notNull orig_ways && isInteractive mode) $
+ do throwDyn (UsageError
+ "--interactive can't be used with -prof, -ticky, -unreg or -smp.")
+
+ -- Find the build tag, and re-process the build-specific options.
+ -- Also add in flags for unregisterised compilation, if
+ -- GhcUnregisterised=YES.
+ way_opts <- findBuildTag
+ let unreg_opts | cGhcUnregisterised == "YES" = unregFlags
+ | otherwise = []
+ pkg_extra_opts <- getPackageExtraGhcOpts
+ extra_non_static <- processArgs static_flags
+ (unreg_opts ++ way_opts ++ pkg_extra_opts) []
+
+ -- Give the static flags to hsc
static_opts <- buildStaticHscOpts
writeIORef v_Static_hsc_opts static_opts
- -- warnings
- warn_level <- readIORef v_Warning_opt
-
- let warn_opts = case warn_level of
- W_default -> standardWarnings
- W_ -> minusWOpts
- W_all -> minusWallOpts
- W_not -> []
-
- -- build the default DynFlags (these may be adjusted on a per
- -- module basis by OPTIONS pragmas and settings in the interpreter).
+ -- build the default DynFlags (these may be adjusted on a per
+ -- module basis by OPTIONS pragmas and settings in the interpreter).
- core_todo <- buildCoreToDo
stg_todo <- buildStgToDo
- lang <- readIORef v_Hsc_Lang
- writeIORef v_DynFlags
- DynFlags{ coreToDo = core_todo,
- stgToDo = stg_todo,
- hscLang = lang,
- -- leave out hscOutName for now
- flags = [] }
-
- -- the rest of the arguments are "dynamic"
- srcs <- processArgs dynamic_flags (way_non_static ++
- non_static ++ warn_opts) []
- -- save the "initial DynFlags" away
- init_dyn_flags <- readIORef v_DynFlags
- writeIORef v_InitDynFlags init_dyn_flags
-
- -- complain about any unknown flags
- mapM unknownFlagErr [ f | f@('-':_) <- srcs ]
+ -- set the "global" HscLang. The HscLang can be further adjusted on a module
+ -- by module basis, using only the -fvia-C and -fasm flags. If the global
+ -- HscLang is not HscC or HscAsm, -fvia-C and -fasm have no effect.
+ dyn_flags <- getDynFlags
+ let lang = case mode of
+ DoInteractive -> HscInterpreted
+ DoEval _ -> HscInterpreted
+ _other -> hscLang dyn_flags
+
+ setDynFlags (dyn_flags{ stgToDo = stg_todo,
+ hscLang = lang,
+ -- leave out hscOutName for now
+ hscOutName = panic "Main.main:hscOutName not set",
+ verbosity = case mode of
+ DoEval _ -> 0
+ _other -> 1
+ })
+
+ -- The rest of the arguments are "dynamic"
+ -- Leftover ones are presumably files
+ fileish_args <- processArgs dynamic_flags (extra_non_static ++ non_static) []
- -- get the -v flag
- verb <- readIORef v_Verbose
-
- when verb (do hPutStr stderr "Glasgow Haskell Compiler, Version "
- hPutStr stderr version_str
- hPutStr stderr ", for Haskell 98, compiled by GHC version "
- hPutStrLn stderr booter_version)
-
- when verb (hPutStrLn stderr ("Using package config file: " ++ conf_file))
-
- -- initialise the finder
- initFinder pkg_details
-
- -- mkdependHS is special
- when (mode == DoMkDependHS) beginMkDependHS
-
- -- make/interactive require invoking the compilation manager
- if (mode == DoMake) then beginMake srcs else do
- if (mode == DoInteractive) then beginInteractive srcs else do
+ -- save the "initial DynFlags" away
+ saveDynFlags
+
+ let
+ {-
+ We split out the object files (.o, .dll) and add them
+ to v_Ld_inputs for use by the linker.
+
+ The following things should be considered compilation manager inputs:
+
+ - haskell source files (strings ending in .hs, .lhs or other
+ haskellish extension),
+
+ - module names (not forgetting hierarchical module names),
+
+ - and finally we consider everything not containing a '.' to be
+ a comp manager input, as shorthand for a .hs or .lhs filename.
+
+ Everything else is considered to be a linker object, and passed
+ straight through to the linker.
+ -}
+ looks_like_an_input m = isSourceFilename m
+ || looksLikeModuleName m
+ || '.' `notElem` m
+
+ -- To simplify the handling of filepaths, we normalise all filepaths right
+ -- away - e.g., for win32 platforms, backslashes are converted
+ -- into forward slashes.
+ normal_fileish_paths = map normalisePath fileish_args
+ (srcs, objs) = partition looks_like_an_input normal_fileish_paths
+
+ -- Note: have v_Ld_inputs maintain the order in which 'objs' occurred on
+ -- the command-line.
+ mapM_ (add v_Ld_inputs) (reverse objs)
+
+ ---------------- Display banners and configuration -----------
+ showBanners mode conf_file static_opts
+
+ ---------------- Final sanity checking -----------
+ checkOptions mode srcs objs
+
+ -- We always link in the base package in
+ -- one-shot linking. Any other packages
+ -- required must be given using -package
+ -- options on the command-line.
+ let def_hs_pkgs = [basePackage, haskell98Package]
+
+ ---------------- Do the business -----------
+ case mode of
+ DoMake -> doMake srcs
+
+ DoMkDependHS -> do { beginMkDependHS ;
+ compileFiles mode srcs;
+ endMkDependHS }
+ StopBefore p -> do { compileFiles mode srcs; return () }
+ DoMkDLL -> do { o_files <- compileFiles mode srcs;
+ doMkDLL o_files def_hs_pkgs }
+ DoLink -> do { o_files <- compileFiles mode srcs;
+ omit_linking <- readIORef v_NoLink;
+ when (not omit_linking)
+ (staticLink o_files def_hs_pkgs) }
+
+#ifndef GHCI
+ DoInteractive -> noInteractiveError
+ DoEval _ -> noInteractiveError
+ where
+ noInteractiveError = throwDyn (CmdLineError "not built for interactive use")
+#else
+ DoInteractive -> interactiveUI srcs Nothing
+ DoEval expr -> interactiveUI srcs (Just expr)
+#endif
- -- for each source file, find which phases to run
- pipelines <- mapM (genPipeline mode stop_flag) srcs
- let src_pipelines = zip srcs pipelines
+-- -----------------------------------------------------------------------------
+-- Option sanity checks
+
+checkOptions :: GhcMode -> [String] -> [String] -> IO ()
+ -- Final sanity checking before kicking off a compilation (pipeline).
+checkOptions mode srcs objs = do
+ -- Complain about any unknown flags
+ let unknown_opts = [ f | f@('-':_) <- srcs ]
+ when (notNull unknown_opts) (unknownFlagsErr unknown_opts)
+
+ -- -ohi sanity check
+ ohi <- readIORef v_Output_hi
+ if (isJust ohi &&
+ (mode == DoMake || isInteractive mode || srcs `lengthExceeds` 1))
+ then throwDyn (UsageError "-ohi can only be used when compiling a single source file")
+ else do
+ -- -o sanity checking
o_file <- readIORef v_Output_file
- if isJust o_file && mode /= DoLink && length srcs > 1
- then throwDyn (UsageError "can't apply -o option to multiple source files")
+ if (srcs `lengthExceeds` 1 && isJust o_file && mode /= DoLink && mode /= DoMkDLL)
+ then throwDyn (UsageError "can't apply -o to multiple source files")
+ else do
+
+ -- Check that there are some input files (except in the interactive
+ -- case)
+ if null srcs && null objs && not (isInteractive mode)
+ then throwDyn (UsageError "no input files")
else do
- if null srcs then throwDyn (UsageError "no input files") else do
-
- -- save the flag state, because this could be modified by OPTIONS
- -- pragmas during the compilation, and we'll need to restore it
- -- before starting the next compilation.
- saved_driver_state <- readIORef v_Driver_state
-
- let compileFile (src, phases) = do
- writeIORef v_Driver_state saved_driver_state
- writeIORef v_DynFlags init_dyn_flags
- r <- runPipeline phases src (mode==DoLink) True
- return r
-
- o_files <- mapM compileFile src_pipelines
-
- when (mode == DoMkDependHS) endMkDependHS
- when (mode == DoLink) (doLink o_files)
-
- -- grab the last -B option on the command line, and
- -- set topDir to its value.
-setTopDir :: [String] -> IO [String]
-setTopDir args = do
- let (minusbs, others) = partition (prefixMatch "-B") args
- (case minusbs of
- [] -> writeIORef v_TopDir clibdir
- some -> writeIORef v_TopDir (drop 2 (last some)))
- return others
-
-beginMake [] = throwDyn (UsageError "no input files")
-beginMake (_:_:_) = throwDyn (UsageError "only one module allowed with --make")
-{-
-beginMake [mod] = do
- state <- cmInit ""{-ToDo:remove-} pkg_details
- cmLoadModule state (mkModuleName mod)
--}
-
-beginInteractive srcs = panic "`ghc --interactive' unimplemented"
+ -- Verify that output files point somewhere sensible.
+ verifyOutputFiles
+
+isInteractive DoInteractive = True
+isInteractive (DoEval _) = True
+isInteractive _ = False
+
+-- -----------------------------------------------------------------------------
+-- Compile files in one-shot mode.
+
+compileFiles :: GhcMode
+ -> [String] -- Source files
+ -> IO [String] -- Object files
+compileFiles mode srcs = do
+ stop_flag <- readIORef v_GhcModeFlag
+ mapM (compileFile mode stop_flag) srcs
+
+
+compileFile mode stop_flag src = do
+ restoreDynFlags
+
+ exists <- doesFileExist src
+ when (not exists) $
+ throwDyn (CmdLineError ("file `" ++ src ++ "' does not exist"))
+
+ o_file <- readIORef v_Output_file
+ -- when linking, the -o argument refers to the linker's output.
+ -- otherwise, we use it as the name for the pipeline's output.
+ let maybe_o_file
+ | mode==DoLink || mode==DoMkDLL = Nothing
+ | otherwise = o_file
+
+ runPipeline mode stop_flag True maybe_o_file src Nothing{-no ModLocation-}
+
+
+-- ----------------------------------------------------------------------------
+-- Run --make mode
+
+doMake :: [String] -> IO ()
+doMake [] = throwDyn (UsageError "no input files")
+doMake srcs = do
+ dflags <- getDynFlags
+ state <- cmInit Batch dflags
+ graph <- cmDepAnal state srcs
+ (_, ok_flag, _) <- cmLoadModules state graph
+ when (failed ok_flag) (exitWith (ExitFailure 1))
+ return ()
+
+-- ---------------------------------------------------------------------------
+-- Various banners and verbosity output.
+
+showBanners :: GhcMode -> FilePath -> [String] -> IO ()
+showBanners mode conf_file static_opts = do
+ verb <- dynFlag verbosity
+
+ -- Show the GHCi banner
+# ifdef GHCI
+ when (mode == DoInteractive && verb >= 1) $
+ hPutStrLn stdout ghciWelcomeMsg
+# endif
+
+ -- Display details of the configuration in verbose mode
+ when (verb >= 2)
+ (do hPutStr stderr "Glasgow Haskell Compiler, Version "
+ hPutStr stderr cProjectVersion
+ hPutStr stderr ", for Haskell 98, compiled by GHC version "
+ hPutStrLn stderr cBooterVersion)
+
+ when (verb >= 2)
+ (hPutStrLn stderr ("Using package config file: " ++ conf_file))
+
+ pkg_details <- getPackageConfigMap
+ showPackages pkg_details
+
+ when (verb >= 3)
+ (hPutStrLn stderr ("Hsc static flags: " ++ unwords static_opts))