ghc/compiler/main/Main.hs

   1 {-# OPTIONS -fno-warn-incomplete-patterns -optc-DNON_POSIX_SOURCE #-}
   2 -----------------------------------------------------------------------------
   3 --
   4 -- GHC Driver program
   5 --
   6 -- (c) The University of Glasgow 2005
   7 --
   8 -----------------------------------------------------------------------------
   9
  10 module Main (main) where
  11
  12 #include "HsVersions.h"
  13
  14 -- The official GHC API
  15 import qualified GHC
  16 import GHC              ( Session, DynFlags(..), GhcMode(..), HscTarget(..),
  17                           LoadHowMuch(..), dopt, DynFlag(..) )
  18 import CmdLineParser
  19
  20 -- Implementations of the various modes (--show-iface, mkdependHS. etc.)
  21 import MkIface          ( showIface )
  22 import DriverPipeline   ( oneShot, compileFile )
  23 import DriverMkDepend   ( doMkDependHS )
  24 import SysTools         ( getTopDir, getUsageMsgPaths )
  25 #ifdef GHCI
  26 import InteractiveUI    ( ghciWelcomeMsg, interactiveUI )
  27 #endif
  28
  29 -- Various other random stuff that we need
  30 import Config           ( cProjectVersion, cBooterVersion, cProjectName )
  31 import Packages         ( dumpPackages, initPackages )
  32 import DriverPhases     ( Phase(..), isSourceFilename, anyHsc,
  33                           startPhase, isHaskellSrcFilename )
  34 import StaticFlags      ( staticFlags, v_Ld_inputs, parseStaticFlags )
  35 import DynFlags         ( defaultDynFlags )
  36 import BasicTypes       ( failed )
  37 import ErrUtils         ( Message, debugTraceMsg, putMsg )
  38 import FastString       ( getFastStringTable, isZEncoded, hasZEncoding )
  39 import Outputable
  40 import Util
  41 import Panic
  42
  43 -- Standard Haskell libraries
  44 import EXCEPTION        ( throwDyn )
  45 import IO
  46 import Directory        ( doesDirectoryExist )
  47 import System           ( getArgs, exitWith, ExitCode(..) )
  48 import Monad
  49 import List
  50 import Maybe
  51
  52 -----------------------------------------------------------------------------
  53 -- ToDo:
  54
  55 -- time commands when run with -v
  56 -- user ways
  57 -- Win32 support: proper signal handling
  58 -- reading the package configuration file is too slow
  59 -- -K<size>
  60
  61 -----------------------------------------------------------------------------
  62 -- GHC's command-line interface
  63
  64 main =
  65   GHC.defaultErrorHandler defaultDynFlags $ do
  66
  67   argv0 <- getArgs
  68   argv1 <- parseStaticFlags =<< GHC.initFromArgs argv0
  69
  70   -- 2. Parse the "mode" flags (--make, --interactive etc.)
  71   (cli_mode, argv2) <- parseModeFlags argv1
  72
  73   let mode = case cli_mode of
  74                 DoInteractive   -> Interactive
  75                 DoEval _        -> Interactive
  76                 DoMake          -> BatchCompile
  77                 DoMkDependHS    -> MkDepend
  78                 _               -> OneShot
  79
  80   -- start our GHC session
  81   session <- GHC.newSession mode
  82
  83   dflags0 <- GHC.getSessionDynFlags session
  84
  85   -- set the default HscTarget.  The HscTarget can be further
  86   -- adjusted on a module by module basis, using only the -fvia-C and
  87   -- -fasm flags.  If the default HscTarget is not HscC or HscAsm,
  88   -- -fvia-C and -fasm have no effect.
  89   let lang = case cli_mode of
  90                  DoInteractive  -> HscInterpreted
  91                  DoEval _       -> HscInterpreted
  92                  _other         -> hscTarget dflags0
  93
  94   let dflags1 = dflags0{ ghcMode = mode,
  95                          hscTarget  = lang,
  96                          -- leave out hscOutName for now
  97                          hscOutName = panic "Main.main:hscOutName not set",
  98                          verbosity = case cli_mode of
  99                                          DoEval _ -> 0
 100                                          _other   -> 1
 101                         }
 102
 103         -- The rest of the arguments are "dynamic"
 104         -- Leftover ones are presumably files
 105   (dflags2, fileish_args) <- GHC.parseDynamicFlags dflags1 argv2
 106
 107         -- make sure we clean up after ourselves
 108   GHC.defaultCleanupHandler dflags2 $ do
 109
 110         -- Display banner
 111   showBanner cli_mode dflags2
 112
 113         -- Read the package config(s), and process the package-related
 114         -- command-line flags
 115   dflags <- initPackages dflags2
 116
 117   -- we've finished manipulating the DynFlags, update the session
 118   GHC.setSessionDynFlags session dflags
 119
 120   let
 121      -- To simplify the handling of filepaths, we normalise all filepaths right
 122      -- away - e.g., for win32 platforms, backslashes are converted
 123      -- into forward slashes.
 124     normal_fileish_paths = map normalisePath fileish_args
 125     (srcs, objs)         = partition_args normal_fileish_paths [] []
 126
 127   -- Note: have v_Ld_inputs maintain the order in which 'objs' occurred on
 128   --       the command-line.
 129   mapM_ (consIORef v_Ld_inputs) (reverse objs)
 130
 131         ---------------- Display configuration -----------
 132   when (verbosity dflags >= 4) $
 133         dumpPackages dflags
 134
 135   when (verbosity dflags >= 3) $ do
 136         hPutStrLn stderr ("Hsc static flags: " ++ unwords staticFlags)
 137
 138         ---------------- Final sanity checking -----------
 139   checkOptions cli_mode dflags srcs objs
 140
 141         ---------------- Do the business -----------
 142   case cli_mode of
 143         ShowUsage       -> showGhcUsage cli_mode
 144         PrintLibdir     -> do d <- getTopDir; putStrLn d
 145         ShowVersion     -> showVersion
 146         ShowNumVersion  -> putStrLn cProjectVersion
 147         ShowInterface f -> showIface f
 148         DoMake          -> doMake session srcs
 149         DoMkDependHS    -> doMkDependHS session (map fst srcs)
 150         StopBefore p
 151             -- Stop after compiling Haskell if we aren't
 152             -- interested in any further results.
 153             | HscNothing <- hscTarget dflags
 154                         -> oneShot dflags HCc srcs
 155             | otherwise
 156                         -> oneShot dflags p srcs
 157         DoInteractive   -> interactiveUI session srcs Nothing
 158         DoEval expr     -> interactiveUI session srcs (Just expr)
 159
 160   dumpFinalStats dflags
 161   exitWith ExitSuccess
 162
 163 #ifndef GHCI
 164 interactiveUI _ _ _ =
 165   throwDyn (CmdLineError "not built for interactive use")
 166 #endif
 167
 168 -- -----------------------------------------------------------------------------
 169 -- Splitting arguments into source files and object files.  This is where we
 170 -- interpret the -x <suffix> option, and attach a (Maybe Phase) to each source
 171 -- file indicating the phase specified by the -x option in force, if any.
 172
 173 partition_args [] srcs objs = (reverse srcs, reverse objs)
 174 partition_args ("-x":suff:args) srcs objs
 175   | "none" <- suff      = partition_args args srcs objs
 176   | StopLn <- phase     = partition_args args srcs (slurp ++ objs)
 177   | otherwise           = partition_args rest (these_srcs ++ srcs) objs
 178         where phase = startPhase suff
 179               (slurp,rest) = break (== "-x") args
 180               these_srcs = zip slurp (repeat (Just phase))
 181 partition_args (arg:args) srcs objs
 182   | looks_like_an_input arg = partition_args args ((arg,Nothing):srcs) objs
 183   | otherwise               = partition_args args srcs (arg:objs)
 184
 185     {-
 186       We split out the object files (.o, .dll) and add them
 187       to v_Ld_inputs for use by the linker.
 188
 189       The following things should be considered compilation manager inputs:
 190
 191        - haskell source files (strings ending in .hs, .lhs or other
 192          haskellish extension),
 193
 194        - module names (not forgetting hierarchical module names),
 195
 196        - and finally we consider everything not containing a '.' to be
 197          a comp manager input, as shorthand for a .hs or .lhs filename.
 198
 199       Everything else is considered to be a linker object, and passed
 200       straight through to the linker.
 201     -}
 202 looks_like_an_input m =  isSourceFilename m
 203                       || looksLikeModuleName m
 204                       || '.' `notElem` m
 205
 206 -- -----------------------------------------------------------------------------
 207 -- Option sanity checks
 208
 209 checkOptions :: CmdLineMode -> DynFlags -> [(String,Maybe Phase)] -> [String] -> IO ()
 210      -- Final sanity checking before kicking off a compilation (pipeline).
 211 checkOptions cli_mode dflags srcs objs = do
 212      -- Complain about any unknown flags
 213    let unknown_opts = [ f | (f@('-':_), _) <- srcs ]
 214    when (notNull unknown_opts) (unknownFlagsErr unknown_opts)
 215
 216         -- -prof and --interactive are not a good combination
 217    when (notNull (wayNames dflags)  && isInterpretiveMode cli_mode) $
 218       do throwDyn (UsageError
 219                    "--interactive can't be used with -prof, -ticky, -unreg or -smp.")
 220         -- -ohi sanity check
 221    if (isJust (outputHi dflags) &&
 222       (isCompManagerMode cli_mode || srcs `lengthExceeds` 1))
 223         then throwDyn (UsageError "-ohi can only be used when compiling a single source file")
 224         else do
 225
 226         -- -o sanity checking
 227    if (srcs `lengthExceeds` 1 && isJust (outputFile dflags)
 228          && not (isLinkMode cli_mode))
 229         then throwDyn (UsageError "can't apply -o to multiple source files")
 230         else do
 231
 232         -- Check that there are some input files
 233         -- (except in the interactive case)
 234    if null srcs && null objs && needsInputsMode cli_mode
 235         then throwDyn (UsageError "no input files")
 236         else do
 237
 238      -- Verify that output files point somewhere sensible.
 239    verifyOutputFiles dflags
 240
 241
 242 -- Compiler output options
 243
 244 -- called to verify that the output files & directories
 245 -- point somewhere valid.
 246 --
 247 -- The assumption is that the directory portion of these output
 248 -- options will have to exist by the time 'verifyOutputFiles'
 249 -- is invoked.
 250 --
 251 verifyOutputFiles :: DynFlags -> IO ()
 252 verifyOutputFiles dflags = do
 253   let odir = objectDir dflags
 254   when (isJust odir) $ do
 255      let dir = fromJust odir
 256      flg <- doesDirectoryExist dir
 257      when (not flg) (nonExistentDir "-odir" dir)
 258   let ofile = outputFile dflags
 259   when (isJust ofile) $ do
 260      let fn = fromJust ofile
 261      flg <- doesDirNameExist fn
 262      when (not flg) (nonExistentDir "-o" fn)
 263   let ohi = outputHi dflags
 264   when (isJust ohi) $ do
 265      let hi = fromJust ohi
 266      flg <- doesDirNameExist hi
 267      when (not flg) (nonExistentDir "-ohi" hi)
 268  where
 269    nonExistentDir flg dir =
 270      throwDyn (CmdLineError ("error: directory portion of " ++
 271                              show dir ++ " does not exist (used with " ++
 272                              show flg ++ " option.)"))
 273
 274 -----------------------------------------------------------------------------
 275 -- GHC modes of operation
 276
 277 data CmdLineMode
 278   = ShowUsage                   -- ghc -?
 279   | PrintLibdir                 -- ghc --print-libdir
 280   | ShowVersion                 -- ghc -V/--version
 281   | ShowNumVersion              -- ghc --numeric-version
 282   | ShowInterface String        -- ghc --show-iface
 283   | DoMkDependHS                -- ghc -M
 284   | StopBefore Phase            -- ghc -E | -C | -S
 285                                 -- StopBefore StopLn is the default
 286   | DoMake                      -- ghc --make
 287   | DoInteractive               -- ghc --interactive
 288   | DoEval String               -- ghc -e
 289   deriving (Show)
 290
 291 isInteractiveMode, isInterpretiveMode     :: CmdLineMode -> Bool
 292 isLinkMode, isCompManagerMode :: CmdLineMode -> Bool
 293
 294 isInteractiveMode DoInteractive = True
 295 isInteractiveMode _             = False
 296
 297 -- isInterpretiveMode: byte-code compiler involved
 298 isInterpretiveMode DoInteractive = True
 299 isInterpretiveMode (DoEval _)    = True
 300 isInterpretiveMode _             = False
 301
 302 needsInputsMode DoMkDependHS    = True
 303 needsInputsMode (StopBefore _)  = True
 304 needsInputsMode DoMake          = True
 305 needsInputsMode _               = False
 306
 307 -- True if we are going to attempt to link in this mode.
 308 -- (we might not actually link, depending on the GhcLink flag)
 309 isLinkMode (StopBefore StopLn) = True
 310 isLinkMode DoMake              = True
 311 isLinkMode _                   = False
 312
 313 isCompManagerMode DoMake        = True
 314 isCompManagerMode DoInteractive = True
 315 isCompManagerMode (DoEval _)    = True
 316 isCompManagerMode _             = False
 317
 318
 319 -- -----------------------------------------------------------------------------
 320 -- Parsing the mode flag
 321
 322 parseModeFlags :: [String] -> IO (CmdLineMode, [String])
 323 parseModeFlags args = do
 324   let ((leftover, errs), (mode, _, flags)) =
 325          runCmdLine (processArgs mode_flags args) (StopBefore StopLn, "", [])
 326   when (not (null errs)) $ do
 327     throwDyn (UsageError (unlines errs))
 328   return (mode, flags ++ leftover)
 329
 330 type ModeM a = CmdLineP (CmdLineMode, String, [String]) a
 331   -- mode flags sometimes give rise to new DynFlags (eg. -C, see below)
 332   -- so we collect the new ones and return them.
 333
 334 mode_flags :: [(String, OptKind (CmdLineP (CmdLineMode, String, [String])))]
 335 mode_flags =
 336   [  ------- help / version ----------------------------------------------
 337      ( "?"               , PassFlag (setMode ShowUsage))
 338   ,  ( "-help"           , PassFlag (setMode ShowUsage))
 339   ,  ( "-print-libdir"   , PassFlag (setMode PrintLibdir))
 340   ,  ( "V"               , PassFlag (setMode ShowVersion))
 341   ,  ( "-version"        , PassFlag (setMode ShowVersion))
 342   ,  ( "-numeric-version", PassFlag (setMode ShowNumVersion))
 343
 344       ------- interfaces ----------------------------------------------------
 345   ,  ( "-show-iface"     , HasArg (\f -> setMode (ShowInterface f)
 346                                           "--show-iface"))
 347
 348       ------- primary modes ------------------------------------------------
 349   ,  ( "M"              , PassFlag (setMode DoMkDependHS))
 350   ,  ( "E"              , PassFlag (setMode (StopBefore anyHsc)))
 351   ,  ( "C"              , PassFlag (\f -> do setMode (StopBefore HCc) f
 352                                              addFlag "-fvia-C"))
 353   ,  ( "S"              , PassFlag (setMode (StopBefore As)))
 354   ,  ( "-make"          , PassFlag (setMode DoMake))
 355   ,  ( "-interactive"   , PassFlag (setMode DoInteractive))
 356   ,  ( "e"              , HasArg   (\s -> setMode (DoEval s) "-e"))
 357   ]
 358
 359 setMode :: CmdLineMode -> String -> ModeM ()
 360 setMode m flag = do
 361   (old_mode, old_flag, flags) <- getCmdLineState
 362   when (notNull old_flag && flag /= old_flag) $
 363       throwDyn (UsageError
 364           ("cannot use `" ++ old_flag ++ "' with `" ++ flag ++ "'"))
 365   putCmdLineState (m, flag, flags)
 366
 367 addFlag :: String -> ModeM ()
 368 addFlag s = do
 369   (m, f, flags) <- getCmdLineState
 370   putCmdLineState (m, f, s:flags)
 371
 372
 373 -- ----------------------------------------------------------------------------
 374 -- Run --make mode
 375
 376 doMake :: Session -> [(String,Maybe Phase)] -> IO ()
 377 doMake sess []    = throwDyn (UsageError "no input files")
 378 doMake sess srcs  = do
 379     let (hs_srcs, non_hs_srcs) = partition haskellish srcs
 380
 381         haskellish (f,Nothing) =
 382           looksLikeModuleName f || isHaskellSrcFilename f || '.' `notElem` f
 383         haskellish (f,Just phase) =
 384           phase `notElem` [As, Cc, CmmCpp, Cmm, StopLn]
 385
 386     dflags <- GHC.getSessionDynFlags sess
 387     o_files <- mapM (compileFile dflags StopLn) non_hs_srcs
 388     mapM_ (consIORef v_Ld_inputs) (reverse o_files)
 389
 390     targets <- mapM (uncurry GHC.guessTarget) hs_srcs
 391     GHC.setTargets sess targets
 392     ok_flag <- GHC.load sess LoadAllTargets
 393     when (failed ok_flag) (exitWith (ExitFailure 1))
 394     return ()
 395
 396 -- ---------------------------------------------------------------------------
 397 -- Various banners and verbosity output.
 398
 399 showBanner :: CmdLineMode -> DynFlags -> IO ()
 400 showBanner cli_mode dflags = do
 401    let verb = verbosity dflags
 402         -- Show the GHCi banner
 403 #  ifdef GHCI
 404    when (isInteractiveMode cli_mode && verb >= 1) $
 405       hPutStrLn stdout ghciWelcomeMsg
 406 #  endif
 407
 408         -- Display details of the configuration in verbose mode
 409    when (not (isInteractiveMode cli_mode) && verb >= 2) $
 410         do hPutStr stderr "Glasgow Haskell Compiler, Version "
 411            hPutStr stderr cProjectVersion
 412            hPutStr stderr ", for Haskell 98, compiled by GHC version "
 413 #ifdef GHCI
 414            -- GHCI is only set when we are bootstrapping...
 415            hPutStrLn stderr cProjectVersion
 416 #else
 417            hPutStrLn stderr cBooterVersion
 418 #endif
 419
 420 showVersion :: IO ()
 421 showVersion = do
 422   putStrLn (cProjectName ++ ", version " ++ cProjectVersion)
 423   exitWith ExitSuccess
 424
 425 showGhcUsage cli_mode = do
 426   (ghc_usage_path,ghci_usage_path) <- getUsageMsgPaths
 427   let usage_path
 428         | DoInteractive <- cli_mode = ghci_usage_path
 429         | otherwise                 = ghc_usage_path
 430   usage <- readFile usage_path
 431   dump usage
 432   exitWith ExitSuccess
 433   where
 434      dump ""          = return ()
 435      dump ('$':'$':s) = putStr progName >> dump s
 436      dump (c:s)       = putChar c >> dump s
 437
 438 dumpFinalStats :: DynFlags -> IO ()
 439 dumpFinalStats dflags =
 440   when (dopt Opt_D_faststring_stats dflags) $ dumpFastStringStats dflags
 441
 442 dumpFastStringStats :: DynFlags -> IO ()
 443 dumpFastStringStats dflags = do
 444   buckets <- getFastStringTable
 445   let (entries, longest, is_z, has_z) = countFS 0 0 0 0 buckets
 446       msg = text "FastString stats:" $$
 447             nest 4 (vcat [text "size:           " <+> int (length buckets),
 448                           text "entries:        " <+> int entries,
 449                           text "longest chain:  " <+> int longest,
 450                           text "z-encoded:      " <+> (is_z `pcntOf` entries),
 451                           text "has z-encoding: " <+> (has_z `pcntOf` entries)
 452                          ])
 453         -- we usually get more "has z-encoding" than "z-encoded", because
 454         -- when we z-encode a string it might hash to the exact same string,
 455         -- which will is not counted as "z-encoded".  Only strings whose
 456         -- Z-encoding is different from the original string are counted in
 457         -- the "z-encoded" total.
 458   putMsg dflags msg
 459   where
 460    x `pcntOf` y = int ((x * 100) `quot` y) <> char '%'
 461
 462 countFS entries longest is_z has_z [] = (entries, longest, is_z, has_z)
 463 countFS entries longest is_z has_z (b:bs) =
 464   let
 465         len = length b
 466         longest' = max len longest
 467         entries' = entries + len
 468         is_zs = length (filter isZEncoded b)
 469         has_zs = length (filter hasZEncoding b)
 470   in
 471         countFS entries' longest' (is_z + is_zs) (has_z + has_zs) bs
 472
 473 -- -----------------------------------------------------------------------------
 474 -- Util
 475
 476 unknownFlagsErr :: [String] -> a
 477 unknownFlagsErr fs = throwDyn (UsageError ("unrecognised flags: " ++ unwords fs))