compiler/main/StaticFlags.hs

   1 {-# OPTIONS -fno-cse #-}
   2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
   3
   4 -----------------------------------------------------------------------------
   5 --
   6 -- Static flags
   7 --
   8 -- Static flags can only be set once, on the command-line.  Inside GHC,
   9 -- each static flag corresponds to a top-level value, usually of type Bool.
  10 --
  11 -- (c) The University of Glasgow 2005
  12 --
  13 -----------------------------------------------------------------------------
  14
  15 module StaticFlags (
  16         staticFlags,
  17         initStaticOpts,
  18
  19         -- Ways
  20         WayName(..), Way(..), v_Ways, isRTSWay, mkBuildTag,
  21
  22         -- Output style options
  23         opt_PprUserLength,
  24         opt_SuppressUniques,
  25         opt_SuppressCoercions,
  26         opt_PprStyle_Debug,
  27         opt_NoDebugOutput,
  28
  29         -- profiling opts
  30         opt_SccProfilingOn,
  31
  32         -- Hpc opts
  33         opt_Hpc,
  34
  35         -- language opts
  36         opt_DictsStrict,
  37         opt_IrrefutableTuples,
  38         opt_Parallel,
  39
  40         -- optimisation opts
  41         opt_DsMultiTyVar,
  42         opt_NoStateHack,
  43         opt_SimpleListLiterals,
  44         opt_SpecInlineJoinPoints,
  45         opt_CprOff,
  46         opt_SimplNoPreInlining,
  47         opt_SimplExcessPrecision,
  48         opt_MaxWorkerArgs,
  49
  50         -- Unfolding control
  51         opt_UF_CreationThreshold,
  52         opt_UF_UseThreshold,
  53         opt_UF_FunAppDiscount,
  54         opt_UF_DictDiscount,
  55         opt_UF_KeenessFactor,
  56         opt_UF_DearOp,
  57
  58         -- Optimization fuel controls
  59         opt_Fuel,
  60
  61         -- Related to linking
  62         opt_PIC,
  63         opt_Static,
  64
  65         -- misc opts
  66         opt_IgnoreDotGhci,
  67         opt_ErrorSpans,
  68         opt_GranMacros,
  69         opt_HiVersion,
  70         opt_HistorySize,
  71         opt_OmitBlackHoling,
  72         opt_Unregisterised,
  73         v_Ld_inputs,
  74         tablesNextToCode,
  75         opt_StubDeadValues,
  76         opt_Ticky,
  77
  78     -- For the parser
  79     addOpt, removeOpt, addWay, getWayFlags, v_opt_C_ready
  80   ) where
  81
  82 #include "HsVersions.h"
  83
  84 import Config
  85 import FastString
  86 import Util
  87 import Maybes           ( firstJust )
  88 import Panic
  89
  90 import Data.Maybe       ( listToMaybe )
  91 import Data.IORef
  92 import System.IO.Unsafe ( unsafePerformIO )
  93 import Data.List
  94
  95 -----------------------------------------------------------------------------
  96 -- Static flags
  97
  98 initStaticOpts :: IO ()
  99 initStaticOpts = writeIORef v_opt_C_ready True
 100
 101 addOpt :: String -> IO ()
 102 addOpt = consIORef v_opt_C
 103
 104 addWay :: WayName -> IO ()
 105 addWay = consIORef v_Ways . lkupWay
 106
 107 removeOpt :: String -> IO ()
 108 removeOpt f = do
 109   fs <- readIORef v_opt_C
 110   writeIORef v_opt_C $! filter (/= f) fs
 111
 112 lookUp           :: FastString -> Bool
 113 lookup_def_int   :: String -> Int -> Int
 114 lookup_def_float :: String -> Float -> Float
 115 lookup_str       :: String -> Maybe String
 116
 117 -- holds the static opts while they're being collected, before
 118 -- being unsafely read by unpacked_static_opts below.
 119 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
 120 GLOBAL_VAR(v_opt_C_ready, False, Bool)
 121
 122 staticFlags :: [String]
 123 staticFlags = unsafePerformIO $ do
 124   ready <- readIORef v_opt_C_ready
 125   if (not ready)
 126         then panic "Static flags have not been initialised!\n        Please call GHC.newSession or GHC.parseStaticFlags early enough."
 127         else readIORef v_opt_C
 128
 129 -- -static is the default
 130 defaultStaticOpts :: [String]
 131 defaultStaticOpts = ["-static"]
 132
 133 packed_static_opts :: [FastString]
 134 packed_static_opts   = map mkFastString staticFlags
 135
 136 lookUp     sw = sw `elem` packed_static_opts
 137
 138 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
 139 -- and returns the string X
 140 lookup_str sw
 141    = case firstJust (map (stripPrefix sw) staticFlags) of
 142         Just ('=' : str) -> Just str
 143         Just str         -> Just str
 144         Nothing          -> Nothing
 145
 146 lookup_def_int sw def = case (lookup_str sw) of
 147                             Nothing -> def              -- Use default
 148                             Just xx -> try_read sw xx
 149
 150 lookup_def_float sw def = case (lookup_str sw) of
 151                             Nothing -> def              -- Use default
 152                             Just xx -> try_read sw xx
 153
 154
 155 try_read :: Read a => String -> String -> a
 156 -- (try_read sw str) tries to read s; if it fails, it
 157 -- bleats about flag sw
 158 try_read sw str
 159   = case reads str of
 160         ((x,_):_) -> x  -- Be forgiving: ignore trailing goop, and alternative parses
 161         []        -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
 162                         -- ToDo: hack alert. We should really parse the arugments
 163                         --       and announce errors in a more civilised way.
 164
 165
 166 {-
 167  Putting the compiler options into temporary at-files
 168  may turn out to be necessary later on if we turn hsc into
 169  a pure Win32 application where I think there's a command-line
 170  length limit of 255. unpacked_opts understands the @ option.
 171
 172 unpacked_opts :: [String]
 173 unpacked_opts =
 174   concat $
 175   map (expandAts) $
 176   map unpackFS argv  -- NOT ARGV any more: v_Static_hsc_opts
 177   where
 178    expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
 179    expandAts l = [l]
 180 -}
 181
 182 opt_IgnoreDotGhci :: Bool
 183 opt_IgnoreDotGhci               = lookUp (fsLit "-ignore-dot-ghci")
 184
 185 -- debugging opts
 186 opt_SuppressUniques :: Bool
 187 opt_SuppressUniques             = lookUp  (fsLit "-dsuppress-uniques")
 188 opt_SuppressCoercions :: Bool
 189 opt_SuppressCoercions           = lookUp  (fsLit "-dsuppress-coercions")
 190 opt_PprStyle_Debug  :: Bool
 191 opt_PprStyle_Debug              = lookUp  (fsLit "-dppr-debug")
 192 opt_PprUserLength   :: Int
 193 opt_PprUserLength               = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
 194 opt_Fuel            :: Int
 195 opt_Fuel                        = lookup_def_int "-dopt-fuel" maxBound
 196 opt_NoDebugOutput   :: Bool
 197 opt_NoDebugOutput               = lookUp  (fsLit "-dno-debug-output")
 198
 199
 200 -- profiling opts
 201 opt_SccProfilingOn :: Bool
 202 opt_SccProfilingOn              = lookUp  (fsLit "-fscc-profiling")
 203
 204 -- Hpc opts
 205 opt_Hpc :: Bool
 206 opt_Hpc                         = lookUp (fsLit "-fhpc")
 207
 208 -- language opts
 209 opt_DictsStrict :: Bool
 210 opt_DictsStrict                 = lookUp  (fsLit "-fdicts-strict")
 211 opt_IrrefutableTuples :: Bool
 212 opt_IrrefutableTuples           = lookUp  (fsLit "-firrefutable-tuples")
 213 opt_Parallel :: Bool
 214 opt_Parallel                    = lookUp  (fsLit "-fparallel")
 215
 216 -- optimisation opts
 217 opt_DsMultiTyVar :: Bool
 218 opt_DsMultiTyVar                = not (lookUp (fsLit "-fno-ds-multi-tyvar"))
 219         -- On by default
 220
 221 opt_SpecInlineJoinPoints :: Bool
 222 opt_SpecInlineJoinPoints        = lookUp  (fsLit "-fspec-inline-join-points")
 223
 224 opt_SimpleListLiterals :: Bool
 225 opt_SimpleListLiterals          = lookUp  (fsLit "-fsimple-list-literals")
 226
 227 opt_NoStateHack :: Bool
 228 opt_NoStateHack                 = lookUp  (fsLit "-fno-state-hack")
 229
 230 opt_CprOff :: Bool
 231 opt_CprOff                      = lookUp  (fsLit "-fcpr-off")
 232         -- Switch off CPR analysis in the new demand analyser
 233 opt_MaxWorkerArgs :: Int
 234 opt_MaxWorkerArgs               = lookup_def_int "-fmax-worker-args" (10::Int)
 235
 236 opt_GranMacros :: Bool
 237 opt_GranMacros                  = lookUp  (fsLit "-fgransim")
 238 opt_HiVersion :: Integer
 239 opt_HiVersion                   = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
 240 opt_HistorySize :: Int
 241 opt_HistorySize                 = lookup_def_int "-fhistory-size" 20
 242 opt_OmitBlackHoling :: Bool
 243 opt_OmitBlackHoling             = lookUp  (fsLit "-dno-black-holing")
 244 opt_StubDeadValues  :: Bool
 245 opt_StubDeadValues              = lookUp  (fsLit "-dstub-dead-values")
 246
 247 -- Simplifier switches
 248 opt_SimplNoPreInlining :: Bool
 249 opt_SimplNoPreInlining          = lookUp  (fsLit "-fno-pre-inlining")
 250         -- NoPreInlining is there just to see how bad things
 251         -- get if you don't do it!
 252 opt_SimplExcessPrecision :: Bool
 253 opt_SimplExcessPrecision        = lookUp  (fsLit "-fexcess-precision")
 254
 255 -- Unfolding control
 256 -- See Note [Discounts and thresholds] in CoreUnfold
 257
 258 opt_UF_CreationThreshold, opt_UF_UseThreshold :: Int
 259 opt_UF_DearOp, opt_UF_FunAppDiscount, opt_UF_DictDiscount :: Int
 260 opt_UF_KeenessFactor :: Float
 261
 262 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
 263 opt_UF_UseThreshold      = lookup_def_int "-funfolding-use-threshold"      (6::Int)
 264 opt_UF_FunAppDiscount    = lookup_def_int "-funfolding-fun-discount"       (6::Int)
 265 opt_UF_DictDiscount      = lookup_def_int "-funfolding-dict-discount"      (1::Int)
 266 opt_UF_KeenessFactor     = lookup_def_float "-funfolding-keeness-factor"   (1.5::Float)
 267 opt_UF_DearOp            = ( 4 :: Int)
 268
 269
 270 -- Related to linking
 271 opt_PIC :: Bool
 272 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
 273 opt_PIC                         = True
 274 #else
 275 opt_PIC                         = lookUp (fsLit "-fPIC")
 276 #endif
 277 opt_Static :: Bool
 278 opt_Static                      = lookUp  (fsLit "-static")
 279 opt_Unregisterised :: Bool
 280 opt_Unregisterised              = lookUp  (fsLit "-funregisterised")
 281
 282 -- Derived, not a real option.  Determines whether we will be compiling
 283 -- info tables that reside just before the entry code, or with an
 284 -- indirection to the entry code.  See TABLES_NEXT_TO_CODE in
 285 -- includes/rts/storage/InfoTables.h.
 286 tablesNextToCode :: Bool
 287 tablesNextToCode                = not opt_Unregisterised
 288                                   && cGhcEnableTablesNextToCode == "YES"
 289
 290 -- Include full span info in error messages, instead of just the start position.
 291 opt_ErrorSpans :: Bool
 292 opt_ErrorSpans                  = lookUp (fsLit "-ferror-spans")
 293
 294 opt_Ticky :: Bool
 295 opt_Ticky                       = lookUp (fsLit "-ticky")
 296
 297 -- object files and libraries to be linked in are collected here.
 298 -- ToDo: perhaps this could be done without a global, it wasn't obvious
 299 -- how to do it though --SDM.
 300 GLOBAL_VAR(v_Ld_inputs, [],      [String])
 301
 302 -----------------------------------------------------------------------------
 303 -- Ways
 304
 305 -- The central concept of a "way" is that all objects in a given
 306 -- program must be compiled in the same "way".  Certain options change
 307 -- parameters of the virtual machine, eg. profiling adds an extra word
 308 -- to the object header, so profiling objects cannot be linked with
 309 -- non-profiling objects.
 310
 311 -- After parsing the command-line options, we determine which "way" we
 312 -- are building - this might be a combination way, eg. profiling+threaded.
 313
 314 -- We then find the "build-tag" associated with this way, and this
 315 -- becomes the suffix used to find .hi files and libraries used in
 316 -- this compilation.
 317
 318 data WayName
 319   = WayThreaded
 320   | WayDebug
 321   | WayProf
 322   | WayEventLog
 323   | WayPar
 324   | WayGran
 325   | WayNDP
 326   | WayDyn
 327   deriving (Eq,Ord)
 328
 329 GLOBAL_VAR(v_Ways, [] ,[Way])
 330
 331 allowed_combination :: [WayName] -> Bool
 332 allowed_combination way = and [ x `allowedWith` y
 333                               | x <- way, y <- way, x < y ]
 334   where
 335         -- Note ordering in these tests: the left argument is
 336         -- <= the right argument, according to the Ord instance
 337         -- on Way above.
 338
 339         -- dyn is allowed with everything
 340         _ `allowedWith` WayDyn                  = True
 341         WayDyn `allowedWith` _                  = True
 342
 343         -- debug is allowed with everything
 344         _ `allowedWith` WayDebug                = True
 345         WayDebug `allowedWith` _                = True
 346
 347         WayProf `allowedWith` WayNDP            = True
 348         WayThreaded `allowedWith` WayProf       = True
 349         WayThreaded `allowedWith` WayEventLog   = True
 350         _ `allowedWith` _                       = False
 351
 352
 353 getWayFlags :: IO [String]  -- new options
 354 getWayFlags = do
 355   unsorted <- readIORef v_Ways
 356   let ways = sortBy (compare `on` wayName) $
 357              nubBy  ((==) `on` wayName) $ unsorted
 358   writeIORef v_Ways ways
 359
 360   if not (allowed_combination (map wayName ways))
 361       then ghcError (CmdLineError $
 362                     "combination not supported: "  ++
 363                     foldr1 (\a b -> a ++ '/':b)
 364                     (map wayDesc ways))
 365       else
 366            return (concatMap wayOpts ways)
 367
 368 mkBuildTag :: [Way] -> String
 369 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
 370
 371 lkupWay :: WayName -> Way
 372 lkupWay w =
 373    case listToMaybe (filter ((==) w . wayName) way_details) of
 374         Nothing -> error "findBuildTag"
 375         Just details -> details
 376
 377 isRTSWay :: WayName -> Bool
 378 isRTSWay = wayRTSOnly . lkupWay
 379
 380 data Way = Way {
 381   wayName    :: WayName,
 382   wayTag     :: String,
 383   wayRTSOnly :: Bool,
 384   wayDesc    :: String,
 385   wayOpts    :: [String]
 386   }
 387
 388 way_details :: [ Way ]
 389 way_details =
 390   [ Way WayThreaded "thr" True "Threaded" [
 391 #if defined(freebsd_TARGET_OS)
 392 --        "-optc-pthread"
 393 --      , "-optl-pthread"
 394         -- FreeBSD's default threading library is the KSE-based M:N libpthread,
 395         -- which GHC has some problems with.  It's currently not clear whether
 396         -- the problems are our fault or theirs, but it seems that using the
 397         -- alternative 1:1 threading library libthr works around it:
 398           "-optl-lthr"
 399 #elif defined(solaris2_TARGET_OS)
 400           "-optl-lrt"
 401 #endif
 402         ],
 403
 404     Way WayDebug "debug" True "Debug" [],
 405
 406     Way WayDyn "dyn" False "Dynamic"
 407         [ "-DDYNAMIC"
 408         , "-optc-DDYNAMIC" ],
 409
 410     Way WayProf "p" False "Profiling"
 411         [ "-fscc-profiling"
 412         , "-DPROFILING"
 413         , "-optc-DPROFILING" ],
 414
 415     Way WayEventLog "l" True "RTS Event Logging"
 416         [ "-DTRACING"
 417         , "-optc-DTRACING" ],
 418
 419     Way WayPar "mp" False "Parallel"
 420         [ "-fparallel"
 421         , "-D__PARALLEL_HASKELL__"
 422         , "-optc-DPAR"
 423         , "-package concurrent"
 424         , "-optc-w"
 425         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
 426         , "-optl-lpvm3"
 427         , "-optl-lgpvm3" ],
 428
 429     -- at the moment we only change the RTS and could share compiler and libs!
 430     Way WayPar "mt" False "Parallel ticky profiling"
 431         [ "-fparallel"
 432         , "-D__PARALLEL_HASKELL__"
 433         , "-optc-DPAR"
 434         , "-optc-DPAR_TICKY"
 435         , "-package concurrent"
 436         , "-optc-w"
 437         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
 438         , "-optl-lpvm3"
 439         , "-optl-lgpvm3" ],
 440
 441     Way WayPar "md" False "Distributed"
 442         [ "-fparallel"
 443         , "-D__PARALLEL_HASKELL__"
 444         , "-D__DISTRIBUTED_HASKELL__"
 445         , "-optc-DPAR"
 446         , "-optc-DDIST"
 447         , "-package concurrent"
 448         , "-optc-w"
 449         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
 450         , "-optl-lpvm3"
 451         , "-optl-lgpvm3" ],
 452
 453     Way WayGran "mg" False "GranSim"
 454         [ "-fgransim"
 455         , "-D__GRANSIM__"
 456         , "-optc-DGRAN"
 457         , "-package concurrent" ],
 458
 459     Way WayNDP "ndp" False "Nested data parallelism"
 460         [ "-XParr"
 461         , "-fvectorise"]
 462   ]