RTS tidyup sweep, first phase
[ghc-hetmet.git] / compiler / main / StaticFlags.hs
index 039051b..b13661e 100644 (file)
@@ -1,9 +1,5 @@
-{-# OPTIONS -w #-}
--- The above warning supression flag is a temporary kludge.
--- While working on this module you are encouraged to remove it and fix
--- any warnings in the module. See
---     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
--- for details
+{-# OPTIONS -fno-cse #-}
+-- -fno-cse is needed for GLOBAL_VAR's to behave properly
 
 -----------------------------------------------------------------------------
 --
@@ -17,7 +13,6 @@
 -----------------------------------------------------------------------------
 
 module StaticFlags (
-       parseStaticFlags,
        staticFlags,
         initStaticOpts,
 
@@ -28,13 +23,10 @@ module StaticFlags (
        opt_PprUserLength,
        opt_SuppressUniques,
        opt_PprStyle_Debug,
+        opt_NoDebugOutput,
 
        -- profiling opts
-       opt_AutoSccsOnAllToplevs,
-       opt_AutoSccsOnExportedToplevs,
-       opt_AutoSccsOnIndividualCafs,
        opt_SccProfilingOn,
-       opt_DoTickyProfiling,
 
         -- Hpc opts
        opt_Hpc,
@@ -43,12 +35,12 @@ module StaticFlags (
        opt_DictsStrict,
        opt_IrrefutableTuples,
        opt_Parallel,
-       opt_RuntimeTypes,
-       opt_Flatten,
 
        -- optimisation opts
-       opt_NoMethodSharing, 
+       opt_DsMultiTyVar,
        opt_NoStateHack,
+        opt_SimpleListLiterals,
+       opt_SpecInlineJoinPoints,
        opt_CprOff,
        opt_SimplNoPreInlining,
        opt_SimplExcessPrecision,
@@ -59,13 +51,14 @@ module StaticFlags (
        opt_UF_UseThreshold,
        opt_UF_FunAppDiscount,
        opt_UF_KeenessFactor,
-       opt_UF_UpdateInPlace,
        opt_UF_DearOp,
 
+       -- Optimization fuel controls
+       opt_Fuel,
+
        -- Related to linking
        opt_PIC,
        opt_Static,
-       opt_HardwireLibPaths,
 
        -- misc opts
        opt_IgnoreDotGhci,
@@ -75,141 +68,39 @@ module StaticFlags (
        opt_HistorySize,
        opt_OmitBlackHoling,
        opt_Unregisterised,
-       opt_EmitExternalCore,
        v_Ld_inputs,
-       tablesNextToCode
+       tablesNextToCode,
+        opt_StubDeadValues,
+
+    -- For the parser
+    addOpt, removeOpt, addWay, findBuildTag, v_opt_C_ready
   ) where
 
 #include "HsVersions.h"
 
-import CmdLineParser
 import Config
-import FastString      ( FastString, mkFastString )
+import FastString
 import Util
 import Maybes          ( firstJust )
 import Panic
 
-import Control.Exception ( throwDyn )
 import Data.IORef
 import System.IO.Unsafe        ( unsafePerformIO )
-import Control.Monad   ( when )
-import Data.Char       ( isDigit )
 import Data.List
 
 -----------------------------------------------------------------------------
 -- Static flags
 
-parseStaticFlags :: [String] -> IO [String]
-parseStaticFlags args = do
-  ready <- readIORef v_opt_C_ready
-  when ready $ throwDyn (ProgramError "Too late for parseStaticFlags: call it before newSession")
-
-  (leftover, errs) <- processArgs static_flags args
-  when (not (null errs)) $ throwDyn (UsageError (unlines errs))
-
-    -- deal with the way flags: the way (eg. prof) gives rise to
-    -- further flags, some of which might be static.
-  way_flags <- findBuildTag
-
-    -- if we're unregisterised, add some more flags
-  let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
-                 | otherwise = []
-
-  (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
-
-    -- see sanity code in staticOpts
-  writeIORef v_opt_C_ready True
-
-    -- TABLES_NEXT_TO_CODE affects the info table layout.
-    -- Be careful to do this *after* all processArgs,
-    -- because evaluating tablesNextToCode involves looking at the global
-    -- static flags.  Those pesky global variables...
-  let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
-              | otherwise        = []
-
-    -- HACK: -fexcess-precision is both a static and a dynamic flag.  If
-    -- the static flag parser has slurped it, we must return it as a 
-    -- leftover too.  ToDo: make -fexcess-precision dynamic only.
-  let excess_prec | opt_SimplExcessPrecision = ["-fexcess-precision"]
-                  | otherwise                = []
-
-  when (not (null errs)) $ ghcError (UsageError (unlines errs))
-  return (excess_prec++cg_flags++more_leftover++leftover)
-
 initStaticOpts :: IO ()
 initStaticOpts = writeIORef v_opt_C_ready True
 
-static_flags :: [(String, OptKind IO)]
--- All the static flags should appear in this list.  It describes how each
--- static flag should be processed.  Two main purposes:
--- (a) if a command-line flag doesn't appear in the list, GHC can complain
--- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
---
--- The common (PassFlag addOpt) action puts the static flag into the bunch of
--- things that are searched up by the top-level definitions like
---     opt_foo = lookUp FSLIT("-dfoo")
-
--- Note that ordering is important in the following list: any flag which
--- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
--- flags further down the list with the same prefix.
-
-static_flags = [
-       ------- GHCi -------------------------------------------------------
-     ( "ignore-dot-ghci", PassFlag addOpt )
-  ,  ( "read-dot-ghci"  , NoArg (removeOpt "-ignore-dot-ghci") )
-
-       ------- ways --------------------------------------------------------
-  ,  ( "prof"          , NoArg (addWay WayProf) )
-  ,  ( "ticky"         , NoArg (addWay WayTicky) )
-  ,  ( "parallel"      , NoArg (addWay WayPar) )
-  ,  ( "gransim"       , NoArg (addWay WayGran) )
-  ,  ( "smp"           , NoArg (addWay WayThreaded) ) -- backwards compat.
-  ,  ( "debug"         , NoArg (addWay WayDebug) )
-  ,  ( "ndp"           , NoArg (addWay WayNDP) )
-  ,  ( "threaded"      , NoArg (addWay WayThreaded) )
-       -- ToDo: user ways
-
-       ------ Debugging ----------------------------------------------------
-  ,  ( "dppr-debug",        PassFlag addOpt )
-  ,  ( "dsuppress-uniques", PassFlag addOpt )
-  ,  ( "dppr-user-length",  AnySuffix addOpt )
-      -- rest of the debugging flags are dynamic
-
-       --------- Profiling --------------------------------------------------
-  ,  ( "auto-all"      , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
-  ,  ( "auto"          , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
-  ,  ( "caf-all"       , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
-         -- "ignore-sccs"  doesn't work  (ToDo)
-
-  ,  ( "no-auto-all"   , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
-  ,  ( "no-auto"       , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
-  ,  ( "no-caf-all"    , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
-
-       ------- Miscellaneous -----------------------------------------------
-  ,  ( "no-link-chk"    , NoArg (return ()) ) -- ignored for backwards compat
-
-       ----- Linker --------------------------------------------------------
-  ,  ( "static"        , PassFlag addOpt )
-  ,  ( "dynamic"        , NoArg (removeOpt "-static") )
-  ,  ( "rdynamic"       , NoArg (return ()) ) -- ignored for compat w/ gcc
-
-       ----- RTS opts ------------------------------------------------------
-  ,  ( "H"                 , HasArg (setHeapSize . fromIntegral . decodeSize) )
-  ,  ( "Rghc-timing"      , NoArg  (enableTimingStats) )
-
-        ------ Compiler flags -----------------------------------------------
-       -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
-  ,  ( "fno-",                 PrefixPred (\s -> isStaticFlag ("f"++s))
-                                   (\s -> removeOpt ("-f"++s)) )
-
-       -- Pass all remaining "-f<blah>" options to hsc
-  ,  ( "f",                    AnySuffixPred (isStaticFlag) addOpt )
-  ]
-
+addOpt :: String -> IO ()
 addOpt = consIORef v_opt_C
 
+addWay :: WayName -> IO ()
 addWay = consIORef v_Ways
 
+removeOpt :: String -> IO ()
 removeOpt f = do
   fs <- readIORef v_opt_C
   writeIORef v_opt_C $! filter (/= f) fs    
@@ -223,15 +114,19 @@ lookup_str       :: String -> Maybe String
 -- being unsafely read by unpacked_static_opts below.
 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
 GLOBAL_VAR(v_opt_C_ready, False, Bool)
+
+staticFlags :: [String]
 staticFlags = unsafePerformIO $ do
   ready <- readIORef v_opt_C_ready
   if (not ready)
-        then panic "a static opt was looked at too early!"
+        then panic "Static flags have not been initialised!\n        Please call GHC.newSession or GHC.parseStaticFlags early enough."
         else readIORef v_opt_C
 
 -- -static is the default
+defaultStaticOpts :: [String]
 defaultStaticOpts = ["-static"]
 
+packed_static_opts :: [FastString]
 packed_static_opts   = map mkFastString staticFlags
 
 lookUp     sw = sw `elem` packed_static_opts
@@ -239,7 +134,7 @@ lookUp     sw = sw `elem` packed_static_opts
 -- (lookup_str "foo") looks for the flag -foo=X or -fooX, 
 -- and returns the string X
 lookup_str sw 
-   = case firstJust (map (startsWith sw) staticFlags) of
+   = case firstJust (map (stripPrefix sw) staticFlags) of
        Just ('=' : str) -> Just str
        Just str         -> Just str
        Nothing          -> Nothing     
@@ -280,78 +175,114 @@ unpacked_opts =
    expandAts l = [l]
 -}
 
-
-opt_IgnoreDotGhci              = lookUp FSLIT("-ignore-dot-ghci")
+opt_IgnoreDotGhci :: Bool
+opt_IgnoreDotGhci              = lookUp (fsLit "-ignore-dot-ghci")
 
 -- debugging opts
-opt_SuppressUniques            = lookUp  FSLIT("-dsuppress-uniques")
-opt_PprStyle_Debug             = lookUp  FSLIT("-dppr-debug")
+opt_SuppressUniques :: Bool
+opt_SuppressUniques            = lookUp  (fsLit "-dsuppress-uniques")
+opt_PprStyle_Debug  :: Bool
+opt_PprStyle_Debug             = lookUp  (fsLit "-dppr-debug")
+opt_PprUserLength   :: Int
 opt_PprUserLength              = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
+opt_Fuel            :: Int
+opt_Fuel                        = lookup_def_int "-dopt-fuel" maxBound
+opt_NoDebugOutput   :: Bool
+opt_NoDebugOutput               = lookUp  (fsLit "-dno-debug-output")
+
 
 -- profiling opts
-opt_AutoSccsOnAllToplevs       = lookUp  FSLIT("-fauto-sccs-on-all-toplevs")
-opt_AutoSccsOnExportedToplevs  = lookUp  FSLIT("-fauto-sccs-on-exported-toplevs")
-opt_AutoSccsOnIndividualCafs   = lookUp  FSLIT("-fauto-sccs-on-individual-cafs")
-opt_SccProfilingOn             = lookUp  FSLIT("-fscc-profiling")
-opt_DoTickyProfiling            = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
+opt_SccProfilingOn :: Bool
+opt_SccProfilingOn             = lookUp  (fsLit "-fscc-profiling")
 
 -- Hpc opts
-opt_Hpc                                = lookUp FSLIT("-fhpc")  
+opt_Hpc :: Bool
+opt_Hpc                                = lookUp (fsLit "-fhpc")  
 
 -- language opts
-opt_DictsStrict                        = lookUp  FSLIT("-fdicts-strict")
-opt_IrrefutableTuples          = lookUp  FSLIT("-firrefutable-tuples")
-opt_Parallel                   = lookUp  FSLIT("-fparallel")
-opt_Flatten                    = lookUp  FSLIT("-fflatten")
+opt_DictsStrict :: Bool
+opt_DictsStrict                        = lookUp  (fsLit "-fdicts-strict")
+opt_IrrefutableTuples :: Bool
+opt_IrrefutableTuples          = lookUp  (fsLit "-firrefutable-tuples")
+opt_Parallel :: Bool
+opt_Parallel                   = lookUp  (fsLit "-fparallel")
 
 -- optimisation opts
-opt_NoStateHack                        = lookUp  FSLIT("-fno-state-hack")
-opt_NoMethodSharing            = lookUp  FSLIT("-fno-method-sharing")
-opt_CprOff                     = lookUp  FSLIT("-fcpr-off")
+opt_DsMultiTyVar :: Bool
+opt_DsMultiTyVar               = not (lookUp (fsLit "-fno-ds-multi-tyvar"))
+       -- On by default
+
+opt_SpecInlineJoinPoints :: Bool
+opt_SpecInlineJoinPoints       = lookUp  (fsLit "-fspec-inline-join-points")
+
+opt_SimpleListLiterals :: Bool
+opt_SimpleListLiterals         = lookUp  (fsLit "-fsimple-list-literals")
+
+opt_NoStateHack :: Bool
+opt_NoStateHack                        = lookUp  (fsLit "-fno-state-hack")
+
+opt_CprOff :: Bool
+opt_CprOff                     = lookUp  (fsLit "-fcpr-off")
        -- Switch off CPR analysis in the new demand analyser
+opt_MaxWorkerArgs :: Int
 opt_MaxWorkerArgs              = lookup_def_int "-fmax-worker-args" (10::Int)
 
-opt_GranMacros                 = lookUp  FSLIT("-fgransim")
+opt_GranMacros :: Bool
+opt_GranMacros                 = lookUp  (fsLit "-fgransim")
+opt_HiVersion :: Integer
 opt_HiVersion                  = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
+opt_HistorySize :: Int
 opt_HistorySize                        = lookup_def_int "-fhistory-size" 20
-opt_OmitBlackHoling            = lookUp  FSLIT("-dno-black-holing")
-opt_RuntimeTypes               = lookUp  FSLIT("-fruntime-types")
+opt_OmitBlackHoling :: Bool
+opt_OmitBlackHoling            = lookUp  (fsLit "-dno-black-holing")
+opt_StubDeadValues  :: Bool
+opt_StubDeadValues             = lookUp  (fsLit "-dstub-dead-values")
 
 -- Simplifier switches
-opt_SimplNoPreInlining         = lookUp  FSLIT("-fno-pre-inlining")
+opt_SimplNoPreInlining :: Bool
+opt_SimplNoPreInlining         = lookUp  (fsLit "-fno-pre-inlining")
        -- NoPreInlining is there just to see how bad things
        -- get if you don't do it!
-opt_SimplExcessPrecision       = lookUp  FSLIT("-fexcess-precision")
+opt_SimplExcessPrecision :: Bool
+opt_SimplExcessPrecision       = lookUp  (fsLit "-fexcess-precision")
 
 -- Unfolding control
+opt_UF_CreationThreshold :: Int
 opt_UF_CreationThreshold       = lookup_def_int "-funfolding-creation-threshold"  (45::Int)
-opt_UF_UseThreshold            = lookup_def_int "-funfolding-use-threshold"       (8::Int)     -- Discounts can be big
+opt_UF_UseThreshold :: Int
+opt_UF_UseThreshold            = lookup_def_int "-funfolding-use-threshold"       (6::Int)     -- Discounts can be big
+opt_UF_FunAppDiscount :: Int
 opt_UF_FunAppDiscount          = lookup_def_int "-funfolding-fun-discount"        (6::Int)     -- It's great to inline a fn
+opt_UF_KeenessFactor :: Float
 opt_UF_KeenessFactor           = lookup_def_float "-funfolding-keeness-factor"    (1.5::Float)
-opt_UF_UpdateInPlace           = lookUp  FSLIT("-funfolding-update-in-place")
 
+opt_UF_DearOp :: Int
 opt_UF_DearOp   = ( 4 :: Int)
-                       
+
+
+-- Related to linking
+opt_PIC :: Bool
 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
 opt_PIC                         = True
 #else
-opt_PIC                         = lookUp FSLIT("-fPIC")
+opt_PIC                         = lookUp (fsLit "-fPIC")
 #endif
-opt_Static                     = lookUp  FSLIT("-static")
-opt_HardwireLibPaths           = lookUp  FSLIT("-fhardwire-lib-paths")
-opt_Unregisterised             = lookUp  FSLIT("-funregisterised")
+opt_Static :: Bool
+opt_Static                     = lookUp  (fsLit "-static")
+opt_Unregisterised :: Bool
+opt_Unregisterised             = lookUp  (fsLit "-funregisterised")
 
 -- Derived, not a real option.  Determines whether we will be compiling
 -- info tables that reside just before the entry code, or with an
 -- indirection to the entry code.  See TABLES_NEXT_TO_CODE in 
--- includes/InfoTables.h.
+-- includes/rts/storage/InfoTables.h.
+tablesNextToCode :: Bool
 tablesNextToCode               = not opt_Unregisterised
                                  && cGhcEnableTablesNextToCode == "YES"
 
-opt_EmitExternalCore           = lookUp  FSLIT("-fext-core")
-
 -- Include full span info in error messages, instead of just the start position.
-opt_ErrorSpans                 = lookUp FSLIT("-ferror-spans")
+opt_ErrorSpans :: Bool
+opt_ErrorSpans                 = lookUp (fsLit "-ferror-spans")
 
 
 -- object files and libraries to be linked in are collected here.
@@ -359,78 +290,6 @@ opt_ErrorSpans                     = lookUp FSLIT("-ferror-spans")
 -- how to do it though --SDM.
 GLOBAL_VAR(v_Ld_inputs,        [],      [String])
 
-isStaticFlag f =
-  f `elem` [
-       "fauto-sccs-on-all-toplevs",
-       "fauto-sccs-on-exported-toplevs",
-       "fauto-sccs-on-individual-cafs",
-       "fscc-profiling",
-       "fdicts-strict",
-       "firrefutable-tuples",
-       "fparallel",
-       "fflatten",
-       "fgransim",
-       "fno-hi-version-check",
-       "dno-black-holing",
-       "fno-method-sharing",
-       "fno-state-hack",
-       "fruntime-types",
-       "fno-pre-inlining",
-       "fexcess-precision",
-       "funfolding-update-in-place",
-       "static",
-       "fhardwire-lib-paths",
-       "funregisterised",
-       "fext-core",
-       "fcpr-off",
-       "ferror-spans",
-       "fPIC",
-       "fhpc"
-       ]
-  || any (`isPrefixOf` f) [
-       "fliberate-case-threshold",
-       "fmax-worker-args",
-       "fhistory-size",
-       "funfolding-creation-threshold",
-       "funfolding-use-threshold",
-       "funfolding-fun-discount",
-       "funfolding-keeness-factor"
-     ]
-
-
-
--- Misc functions for command-line options
-
-startsWith :: String -> String -> Maybe String
--- startsWith pfx (pfx++rest) = Just rest
-
-startsWith []     str = Just str
-startsWith (c:cs) (s:ss)
-  = if c /= s then Nothing else startsWith cs ss
-startsWith  _    []  = Nothing
-
-
------------------------------------------------------------------------------
--- convert sizes like "3.5M" into integers
-
-decodeSize :: String -> Integer
-decodeSize str
-  | c == ""             = truncate n
-  | c == "K" || c == "k" = truncate (n * 1000)
-  | c == "M" || c == "m" = truncate (n * 1000 * 1000)
-  | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
-  | otherwise            = throwDyn (CmdLineError ("can't decode size: " ++ str))
-  where (m, c) = span pred str
-        n      = readRational m
-       pred c = isDigit c || c == '.'
-
-
------------------------------------------------------------------------------
--- RTS Hooks
-
-foreign import ccall unsafe "setHeapSize"       setHeapSize       :: Int -> IO ()
-foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
-
 -----------------------------------------------------------------------------
 -- Ways
 
@@ -457,6 +316,7 @@ data WayName
   = WayThreaded
   | WayDebug
   | WayProf
+  | WayEventLog
   | WayTicky
   | WayPar
   | WayGran
@@ -482,6 +342,7 @@ data WayName
 
 GLOBAL_VAR(v_Ways, [] ,[WayName])
 
+allowed_combination :: [WayName] -> Bool
 allowed_combination way = and [ x `allowedWith` y 
                              | x <- way, y <- way, x < y ]
   where
@@ -494,6 +355,8 @@ allowed_combination way = and [ x `allowedWith` y
        WayDebug `allowedWith` _                = True
 
        WayProf `allowedWith` WayNDP            = True
+       WayThreaded `allowedWith` WayProf       = True
+       WayThreaded `allowedWith` WayEventLog   = True
        _ `allowedWith` _                       = False
 
 
@@ -503,7 +366,7 @@ findBuildTag = do
   let ws = sort (nub way_names)
 
   if not (allowed_combination ws)
-      then throwDyn (CmdLineError $
+      then ghcError (CmdLineError $
                    "combination not supported: "  ++
                    foldr1 (\a b -> a ++ '/':b) 
                    (map (wayName . lkupWay) ws))
@@ -521,11 +384,13 @@ findBuildTag = do
 mkBuildTag :: [Way] -> String
 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
 
+lkupWay :: WayName -> Way
 lkupWay w = 
    case lookup w way_details of
        Nothing -> error "findBuildTag"
        Just details -> details
 
+isRTSWay :: WayName -> Bool
 isRTSWay = wayRTSOnly . lkupWay 
 
 data Way = Way {
@@ -558,6 +423,10 @@ way_details =
        , "-DPROFILING"
        , "-optc-DPROFILING" ]),
 
+    (WayEventLog, Way  "l" True "RTS Event Logging"
+       [ "-DEVENTLOG"
+       , "-optc-DEVENTLOG" ]),
+
     (WayTicky, Way  "t" True "Ticky-ticky Profiling"  
        [ "-DTICKY_TICKY"
        , "-optc-DTICKY_TICKY" ]),
@@ -604,8 +473,8 @@ way_details =
        , "-package concurrent" ]),
 
     (WayNDP, Way  "ndp" False "Nested data parallelism"
-       [ "-fparr"
-       , "-fflatten"]),
+       [ "-XParr"
+       , "-fvectorise"]),
 
     (WayUser_a,  Way  "a"  False "User way 'a'"  ["$WAY_a_REAL_OPTS"]),        
     (WayUser_b,  Way  "b"  False "User way 'b'"  ["$WAY_b_REAL_OPTS"]),        
@@ -626,9 +495,3 @@ way_details =
     (WayUser_B,  Way  "B"  False "User way 'B'"  ["$WAY_B_REAL_OPTS"]) 
   ]
 
-unregFlags = 
-   [ "-optc-DNO_REGS"
-   , "-optc-DUSE_MINIINTERPRETER"
-   , "-fno-asm-mangling"
-   , "-funregisterised"
-   , "-fvia-C" ]