[project @ 2003-07-21 15:14:18 by ross]
[ghc-hetmet.git] / ghc / compiler / main / Main.hs
index 21b506d..7da0074 100644 (file)
@@ -1,10 +1,11 @@
-{-# OPTIONS -fno-warn-incomplete-patterns #-}
+{-# OPTIONS -fno-warn-incomplete-patterns -optc-DNON_POSIX_SOURCE #-}
+
 -----------------------------------------------------------------------------
--- $Id: Main.hs,v 1.40 2000/12/18 15:18:11 simonmar Exp $
+-- $Id: Main.hs,v 1.131 2003/07/21 15:14:18 ross Exp $
 --
 -- GHC Driver program
 --
--- (c) Simon Marlow 2000
+-- (c) The University of Glasgow 2002
 --
 -----------------------------------------------------------------------------
 
@@ -17,73 +18,74 @@ module Main (main) where
 
 
 #ifdef GHCI
-import Interpreter
-import InteractiveUI
+import InteractiveUI( ghciWelcomeMsg, interactiveUI )
 #endif
 
-#ifndef mingw32_TARGET_OS
-import Dynamic
-import Posix
-#endif
 
-import CompManager
-import DriverPipeline
-import DriverState
-import DriverFlags
-import DriverMkDepend
-import DriverUtil
-import Panic
-import DriverPhases    ( Phase(..) )
-import CmdLineOpts     ( HscLang(..), DynFlags(..), v_Static_hsc_opts )
-import TmpFiles
-import Finder          ( initFinder )
-import CmStaticInfo
-import Config
+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     ( buildCoreToDo, buildStgToDo,
+                         findBuildTag, 
+                         getPackageExtraGhcOpts, unregFlags, 
+                         v_GhcMode, v_GhcModeFlag, GhcMode(..),
+                         v_Keep_tmp_files, v_Ld_inputs, v_Ways, 
+                         v_OptLevel, 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    ( isSourceFile )
+
+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) )
 
-
-import Concurrent
-import Directory
-import IOExts
-import Exception
-
+-- 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
--- -ddump-all doesn't do anything
+-- -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 -Ofile
 
 -----------------------------------------------------------------------------
@@ -91,148 +93,261 @@ import Maybe
 
 main =
   -- top-level exception handler: any unrecognised exception is a compiler bug.
-  handle (\exception -> hPutStr stderr (show (Panic (show exception)))) $ do
+  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 :: GhcException))
-                                 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 <- dynFlag verbosity
-             cleanTempFiles (verb >= 2)
+             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
-
-   argv   <- getArgs
+   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_opt_level <- readIORef v_OptLevel
+   when (orig_opt_level > 0 && mode == DoInteractive) $
+      do putStr "warning: -O conflicts with --interactive; -O turned off.\n"
+         writeIORef v_OptLevel 0
+   orig_ways <- readIORef v_Ways
+   when (notNull orig_ways && mode == DoInteractive) $
+      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
 
-       -- grab any -B options from the command line first
-   argv'  <- setTopDir argv
-   top_dir <- readIORef v_TopDir
+   -- build the default DynFlags (these may be adjusted on a per
+   -- module basis by OPTIONS pragmas and settings in the interpreter).
 
-   let installed s = top_dir ++ '/':s
-       inplace s   = top_dir ++ '/':cCURRENT_DIR ++ '/':s
+   core_todo <- buildCoreToDo
+   stg_todo  <- buildStgToDo
 
-       installed_pkgconfig = installed ("package.conf")
-       inplace_pkgconfig   = inplace (cGHC_DRIVER_DIR ++ "/package.conf.inplace")
+   -- 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
+   build_tag <- readIORef v_Build_tag
+   let lang = case mode of 
+                DoInteractive  -> HscInterpreted
+                _other | build_tag /= "" -> HscC
+                       | otherwise       -> hscLang dyn_flags
+               -- for ways other that the normal way, we must 
+               -- compile via C.
+
+   setDynFlags (dyn_flags{ coreToDo = core_todo,
+                          stgToDo  = stg_todo,
+                          hscLang  = lang,
+                          -- leave out hscOutName for now
+                          hscOutName = panic "Main.main:hscOutName not set",
+                          verbosity = 1
+                       })
+
+       -- The rest of the arguments are "dynamic"
+       -- Leftover ones are presumably files
+   fileish_args <- processArgs dynamic_flags (extra_non_static ++ non_static) []
 
-       -- 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
+       -- 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 =  isSourceFile 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
+
+   mapM_ (add v_Ld_inputs) 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) }
 
-   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")
+#ifndef GHCI
+       DoInteractive -> throwDyn (CmdLineError "not built for interactive use")
+#else
+       DoInteractive -> interactiveUI srcs
+#endif
 
-       -- 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")
+-- -----------------------------------------------------------------------------
+-- 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 || mode == DoInteractive || srcs `lengthExceeds` 1))
+       then throwDyn (UsageError "-ohi can only be used when compiling a single source file")
+       else do
 
-       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)
+       -- -o sanity checking
+   o_file <- readIORef v_Output_file
+   if (srcs `lengthExceeds` 1 && isJust o_file && mode /= DoLink && mode /= DoMkDLL)
+       then throwDyn (UsageError "can't apply -o to multiple source files")
+       else do
 
-       -- 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
+       -- Check that there are some input files (except in the interactive 
+       -- case)
+   if null srcs && null objs && mode /= DoInteractive
+       then throwDyn (UsageError "no input files")
+       else do
 
-       -- find the phase to stop after (i.e. -E, -C, -c, -S flags)
-   (flags2, mode, stop_flag) <- getGhcMode argv'
-   writeIORef v_GhcMode mode
+     -- Verify that output files point somewhere sensible.
+   verifyOutputFiles
 
-       -- 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 []
+-- -----------------------------------------------------------------------------
+-- Compile files in one-shot mode.
 
-       -- give the static flags to hsc
-   static_opts <- buildStaticHscOpts
-   writeIORef v_Static_hsc_opts static_opts
+compileFiles :: GhcMode 
+            -> [String]        -- Source files
+            -> IO [String]     -- Object files
+compileFiles mode srcs = do
+   stop_flag <- readIORef v_GhcModeFlag
+   mapM (compileFile mode stop_flag) srcs
 
-       -- warnings
-   warn_level <- readIORef v_Warning_opt
 
-   let warn_opts =  case warn_level of
-                       W_default -> standardWarnings
-                       W_        -> minusWOpts
-                       W_all     -> minusWallOpts
-                       W_not     -> []
+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
 
-       -- build the default DynFlags (these may be adjusted on a per
-       -- module basis by OPTIONS pragmas and settings in the interpreter).
+   runPipeline mode stop_flag True maybe_o_file src Nothing{-no ModLocation-}
 
-   core_todo <- buildCoreToDo
-   stg_todo  <- buildStgToDo
 
-   -- 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.
-   opt_level  <- readIORef v_OptLevel
-   let lang = case mode of 
-                StopBefore HCc -> HscC
-                DoInteractive  -> HscInterpreted
-                _other        | opt_level >= 1  -> HscC  -- -O implies -fvia-C 
-                              | otherwise       -> defaultHscLang
-
-   writeIORef v_DynFlags 
-       DynFlags{ coreToDo = core_todo,
-                 stgToDo  = stg_todo,
-                  hscLang  = lang,
-                 -- leave out hscOutName for now
-                  hscOutName = panic "Main.main:hscOutName not set",
-
-                 verbosity = case mode of
-                               DoInteractive -> 1
-                               DoMake        -> 1
-                               _other        -> 0,
-
-                 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
+-- ----------------------------------------------------------------------------
+-- Run --make mode
 
-       -- complain about any unknown flags
-   mapM unknownFlagErr [ f | f@('-':_) <- srcs ]
+doMake :: [String] -> IO ()
+doMake []    = throwDyn (UsageError "no input files")
+doMake srcs  = do 
+    dflags <- getDynFlags 
+    state  <- cmInit Batch
+    graph  <- cmDepAnal state dflags srcs
+    (_, ok_flag, _) <- cmLoadModules state dflags graph
+    when (failed ok_flag) (exitWith (ExitFailure 1))
+    return ()
 
-       -- 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
-   writeIORef v_InitDriverState saved_driver_state
+-- ---------------------------------------------------------------------------
+-- 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
@@ -242,72 +357,8 @@ main =
    when (verb >= 2) 
        (hPutStrLn stderr ("Using package config file: " ++ conf_file))
 
-       -- initialise the finder
-   pkg_avails <- getPackageInfo
-   initFinder pkg_avails
-
-       -- 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
-
-       -- for each source file, find which phases to run
-   let lang = hscLang init_dyn_flags
-   pipelines <- mapM (genPipeline mode stop_flag True lang) srcs
-   let src_pipelines = zip srcs pipelines
+   pkg_details <- getPackageConfigMap
+   showPackages pkg_details
 
-       -- sanity checking
-   o_file <- readIORef v_Output_file
-   ohi    <- readIORef v_Output_hi
-   if length srcs > 1 && (isJust ohi || (isJust o_file && mode /= DoLink))
-       then throwDyn (UsageError "can't apply -o or -ohi options to multiple source files")
-       else do
-
-   if null srcs then throwDyn (UsageError "no input files") else do
-
-   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 :: [String] -> IO ()
-beginMake mods
-  = do case mods of
-        []    -> throwDyn (UsageError "no input files")
-        [mod] -> do state <- cmInit Batch
-                    cmLoadModule state mod
-                    return ()
-        _     -> throwDyn (UsageError "only one module allowed with --make")
-
-
-beginInteractive :: [String] -> IO ()
-#ifndef GHCI
-beginInteractive = throwDyn (OtherError "not build for interactive use")
-#else
-beginInteractive mods
-  = do state <- cmInit Interactive
-       let mod = case mods of
-               []    -> Nothing
-               [mod] -> Just mod
-               _     -> throwDyn (UsageError 
-                                   "only one module allowed with --interactive")
-       interactiveUI state mod
-#endif
+   when (verb >= 3) 
+       (hPutStrLn stderr ("Hsc static flags: " ++ unwords static_opts))