compiler/main/DynFlags.hs

   1 -- |
   2 -- Dynamic flags
   3 --
   4 --
   5 -- (c) The University of Glasgow 2005
   6 --
   7
   8 -- Most flags are dynamic flags, which means they can change from
   9 -- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
  10 -- multi-session GHC each session can be using different dynamic
  11 -- flags.  Dynamic flags can also be set at the prompt in GHCi.
  12 module DynFlags (
  13         -- * Dynamic flags and associated configuration types
  14         DynFlag(..),
  15         DynFlags(..),
  16         HscTarget(..), isObjectTarget, defaultObjectTarget,
  17         GhcMode(..), isOneShot,
  18         GhcLink(..), isNoLink,
  19         PackageFlag(..),
  20         Option(..), showOpt,
  21         DynLibLoader(..),
  22         fFlags, xFlags,
  23         dphPackage,
  24         wayNames,
  25
  26         -- ** Manipulating DynFlags
  27         defaultDynFlags,                -- DynFlags
  28         initDynFlags,                   -- DynFlags -> IO DynFlags
  29
  30         dopt,                           -- DynFlag -> DynFlags -> Bool
  31         dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
  32         getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
  33         getVerbFlag,
  34         updOptLevel,
  35         setTmpDir,
  36         setPackageName,
  37         doingTickyProfiling,
  38
  39         -- ** Parsing DynFlags
  40         parseDynamicFlags,
  41         parseDynamicNoPackageFlags,
  42         allFlags,
  43
  44         supportedLanguages, languageOptions,
  45
  46         -- ** DynFlag C compiler options
  47         machdepCCOpts, picCCOpts,
  48
  49         -- * Configuration of the core-to-core passes
  50         CoreToDo(..),
  51         SimplifierMode(..),
  52         SimplifierSwitch(..),
  53         FloatOutSwitches(..),
  54         getCoreToDo,
  55
  56         -- * Configuration of the stg-to-stg passes
  57         StgToDo(..),
  58         getStgToDo,
  59
  60         -- * Compiler configuration suitable for display to the user
  61         Printable(..),
  62         compilerInfo
  63   ) where
  64
  65 #include "HsVersions.h"
  66
  67 #ifndef OMIT_NATIVE_CODEGEN
  68 import Platform
  69 #endif
  70 import Module
  71 import PackageConfig
  72 import PrelNames        ( mAIN )
  73 import StaticFlags
  74 import {-# SOURCE #-} Packages (PackageState)
  75 import DriverPhases     ( Phase(..), phaseInputExt )
  76 import Config
  77 import CmdLineParser
  78 import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
  79 import Panic
  80 import Util
  81 import Maybes           ( orElse )
  82 import SrcLoc
  83 import FastString
  84 import FiniteMap
  85 import Outputable
  86 import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
  87
  88 import Data.IORef
  89 import Control.Monad    ( when )
  90
  91 import Data.Char
  92 import Data.List
  93 import System.FilePath
  94 import System.IO        ( stderr, hPutChar )
  95
  96 -- -----------------------------------------------------------------------------
  97 -- DynFlags
  98
  99 -- | Enumerates the simple on-or-off dynamic flags
 100 data DynFlag
 101
 102    -- debugging flags
 103    = Opt_D_dump_cmm
 104    | Opt_D_dump_cmmz
 105    | Opt_D_dump_cmmz_pretty
 106    | Opt_D_dump_cps_cmm
 107    | Opt_D_dump_cvt_cmm
 108    | Opt_D_dump_asm
 109    | Opt_D_dump_asm_native
 110    | Opt_D_dump_asm_liveness
 111    | Opt_D_dump_asm_coalesce
 112    | Opt_D_dump_asm_regalloc
 113    | Opt_D_dump_asm_regalloc_stages
 114    | Opt_D_dump_asm_conflicts
 115    | Opt_D_dump_asm_stats
 116    | Opt_D_dump_asm_expanded
 117    | Opt_D_dump_cpranal
 118    | Opt_D_dump_deriv
 119    | Opt_D_dump_ds
 120    | Opt_D_dump_flatC
 121    | Opt_D_dump_foreign
 122    | Opt_D_dump_inlinings
 123    | Opt_D_dump_rule_firings
 124    | Opt_D_dump_occur_anal
 125    | Opt_D_dump_parsed
 126    | Opt_D_dump_rn
 127    | Opt_D_dump_simpl
 128    | Opt_D_dump_simpl_iterations
 129    | Opt_D_dump_simpl_phases
 130    | Opt_D_dump_spec
 131    | Opt_D_dump_prep
 132    | Opt_D_dump_stg
 133    | Opt_D_dump_stranal
 134    | Opt_D_dump_tc
 135    | Opt_D_dump_types
 136    | Opt_D_dump_rules
 137    | Opt_D_dump_cse
 138    | Opt_D_dump_worker_wrapper
 139    | Opt_D_dump_rn_trace
 140    | Opt_D_dump_rn_stats
 141    | Opt_D_dump_opt_cmm
 142    | Opt_D_dump_simpl_stats
 143    | Opt_D_dump_tc_trace
 144    | Opt_D_dump_if_trace
 145    | Opt_D_dump_splices
 146    | Opt_D_dump_BCOs
 147    | Opt_D_dump_vect
 148    | Opt_D_dump_hpc
 149    | Opt_D_dump_rtti
 150    | Opt_D_source_stats
 151    | Opt_D_verbose_core2core
 152    | Opt_D_verbose_stg2stg
 153    | Opt_D_dump_hi
 154    | Opt_D_dump_hi_diffs
 155    | Opt_D_dump_minimal_imports
 156    | Opt_D_dump_mod_cycles
 157    | Opt_D_dump_view_pattern_commoning
 158    | Opt_D_faststring_stats
 159    | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
 160    | Opt_D_no_debug_output
 161    | Opt_DoCoreLinting
 162    | Opt_DoStgLinting
 163    | Opt_DoCmmLinting
 164    | Opt_DoAsmLinting
 165
 166    | Opt_WarnIsError                    -- -Werror; makes warnings fatal
 167    | Opt_WarnDuplicateExports
 168    | Opt_WarnHiShadows
 169    | Opt_WarnImplicitPrelude
 170    | Opt_WarnIncompletePatterns
 171    | Opt_WarnIncompletePatternsRecUpd
 172    | Opt_WarnMissingFields
 173    | Opt_WarnMissingMethods
 174    | Opt_WarnMissingSigs
 175    | Opt_WarnNameShadowing
 176    | Opt_WarnOverlappingPatterns
 177    | Opt_WarnSimplePatterns
 178    | Opt_WarnTypeDefaults
 179    | Opt_WarnMonomorphism
 180    | Opt_WarnUnusedBinds
 181    | Opt_WarnUnusedImports
 182    | Opt_WarnUnusedMatches
 183    | Opt_WarnWarningsDeprecations
 184    | Opt_WarnDeprecatedFlags
 185    | Opt_WarnDodgyExports
 186    | Opt_WarnDodgyImports
 187    | Opt_WarnOrphans
 188    | Opt_WarnTabs
 189    | Opt_WarnUnrecognisedPragmas
 190    | Opt_WarnDodgyForeignImports
 191    | Opt_WarnLazyUnliftedBindings
 192    | Opt_WarnUnusedDoBind
 193    | Opt_WarnWrongDoBind
 194
 195
 196    -- language opts
 197    | Opt_OverlappingInstances
 198    | Opt_UndecidableInstances
 199    | Opt_IncoherentInstances
 200    | Opt_MonomorphismRestriction
 201    | Opt_MonoPatBinds
 202    | Opt_MonoLocalBinds
 203    | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
 204    | Opt_ForeignFunctionInterface
 205    | Opt_UnliftedFFITypes
 206    | Opt_GHCForeignImportPrim
 207    | Opt_PArr                           -- Syntactic support for parallel arrays
 208    | Opt_Arrows                         -- Arrow-notation syntax
 209    | Opt_TemplateHaskell
 210    | Opt_QuasiQuotes
 211    | Opt_ImplicitParams
 212    | Opt_Generics                       -- "Derivable type classes"
 213    | Opt_ImplicitPrelude
 214    | Opt_ScopedTypeVariables
 215    | Opt_UnboxedTuples
 216    | Opt_BangPatterns
 217    | Opt_TypeFamilies
 218    | Opt_OverloadedStrings
 219    | Opt_DisambiguateRecordFields
 220    | Opt_RecordWildCards
 221    | Opt_RecordPuns
 222    | Opt_ViewPatterns
 223    | Opt_GADTs
 224    | Opt_RelaxedPolyRec
 225    | Opt_NPlusKPatterns
 226
 227    | Opt_StandaloneDeriving
 228    | Opt_DeriveDataTypeable
 229    | Opt_DeriveFunctor
 230    | Opt_DeriveTraversable
 231    | Opt_DeriveFoldable
 232
 233    | Opt_TypeSynonymInstances
 234    | Opt_FlexibleContexts
 235    | Opt_FlexibleInstances
 236    | Opt_ConstrainedClassMethods
 237    | Opt_MultiParamTypeClasses
 238    | Opt_FunctionalDependencies
 239    | Opt_UnicodeSyntax
 240    | Opt_PolymorphicComponents
 241    | Opt_ExistentialQuantification
 242    | Opt_MagicHash
 243    | Opt_EmptyDataDecls
 244    | Opt_KindSignatures
 245    | Opt_ParallelListComp
 246    | Opt_TransformListComp
 247    | Opt_GeneralizedNewtypeDeriving
 248    | Opt_RecursiveDo
 249    | Opt_DoRec
 250    | Opt_PostfixOperators
 251    | Opt_TupleSections
 252    | Opt_PatternGuards
 253    | Opt_LiberalTypeSynonyms
 254    | Opt_Rank2Types
 255    | Opt_RankNTypes
 256    | Opt_ImpredicativeTypes
 257    | Opt_TypeOperators
 258    | Opt_PackageImports
 259    | Opt_NewQualifiedOperators
 260    | Opt_ExplicitForAll
 261
 262    | Opt_PrintExplicitForalls
 263
 264    -- optimisation opts
 265    | Opt_Strictness
 266    | Opt_FullLaziness
 267    | Opt_FloatIn
 268    | Opt_Specialise
 269    | Opt_StaticArgumentTransformation
 270    | Opt_CSE
 271    | Opt_LiberateCase
 272    | Opt_SpecConstr
 273    | Opt_IgnoreInterfacePragmas
 274    | Opt_OmitInterfacePragmas
 275    | Opt_DoLambdaEtaExpansion
 276    | Opt_IgnoreAsserts
 277    | Opt_DoEtaReduction
 278    | Opt_CaseMerge
 279    | Opt_UnboxStrictFields
 280    | Opt_MethodSharing
 281    | Opt_DictsCheap
 282    | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
 283    | Opt_Vectorise
 284    | Opt_RegsGraph                      -- do graph coloring register allocation
 285    | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
 286
 287    -- profiling opts
 288    | Opt_AutoSccsOnAllToplevs
 289    | Opt_AutoSccsOnExportedToplevs
 290    | Opt_AutoSccsOnIndividualCafs
 291
 292    -- misc opts
 293    | Opt_Cpp
 294    | Opt_Pp
 295    | Opt_ForceRecomp
 296    | Opt_DryRun
 297    | Opt_DoAsmMangling
 298    | Opt_ExcessPrecision
 299    | Opt_EagerBlackHoling
 300    | Opt_ReadUserPackageConf
 301    | Opt_NoHsMain
 302    | Opt_SplitObjs
 303    | Opt_StgStats
 304    | Opt_HideAllPackages
 305    | Opt_PrintBindResult
 306    | Opt_Haddock
 307    | Opt_HaddockOptions
 308    | Opt_Hpc_No_Auto
 309    | Opt_BreakOnException
 310    | Opt_BreakOnError
 311    | Opt_PrintEvldWithShow
 312    | Opt_PrintBindContents
 313    | Opt_GenManifest
 314    | Opt_EmbedManifest
 315    | Opt_EmitExternalCore
 316    | Opt_SharedImplib
 317    | Opt_BuildingCabalPackage
 318
 319         -- temporary flags
 320    | Opt_RunCPS
 321    | Opt_RunCPSZ
 322    | Opt_ConvertToZipCfgAndBack
 323    | Opt_AutoLinkPackages
 324    | Opt_ImplicitImportQualified
 325    | Opt_TryNewCodeGen
 326
 327    -- keeping stuff
 328    | Opt_KeepHiDiffs
 329    | Opt_KeepHcFiles
 330    | Opt_KeepSFiles
 331    | Opt_KeepRawSFiles
 332    | Opt_KeepTmpFiles
 333    | Opt_KeepRawTokenStream
 334
 335    deriving (Eq, Show)
 336
 337 -- | Contains not only a collection of 'DynFlag's but also a plethora of
 338 -- information relating to the compilation of a single file or GHC session
 339 data DynFlags = DynFlags {
 340   ghcMode               :: GhcMode,
 341   ghcLink               :: GhcLink,
 342   coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
 343   stgToDo               :: Maybe [StgToDo],  -- similarly
 344   hscTarget             :: HscTarget,
 345   hscOutName            :: String,      -- ^ Name of the output file
 346   extCoreName           :: String,      -- ^ Name of the .hcr output file
 347   verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
 348   optLevel              :: Int,         -- ^ Optimisation level
 349   simplPhases           :: Int,         -- ^ Number of simplifier phases
 350   maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
 351   shouldDumpSimplPhase  :: SimplifierMode -> Bool,
 352   ruleCheck             :: Maybe String,
 353   strictnessBefore      :: [Int],       -- ^ Additional demand analysis
 354
 355   specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
 356   specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
 357   liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
 358
 359 #ifndef OMIT_NATIVE_CODEGEN
 360   targetPlatform        :: Platform,    -- ^ The platform we're compiling for. Used by the NCG.
 361 #endif
 362   stolen_x86_regs       :: Int,
 363   cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
 364   importPaths           :: [FilePath],
 365   mainModIs             :: Module,
 366   mainFunIs             :: Maybe String,
 367   ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
 368
 369   dphBackend            :: DPHBackend,
 370
 371   thisPackage           :: PackageId,   -- ^ name of package currently being compiled
 372
 373   -- ways
 374   ways                  :: [Way],       -- ^ Way flags from the command line
 375   buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
 376   rtsBuildTag           :: String,      -- ^ The RTS \"way\"
 377
 378   -- For object splitting
 379   splitInfo             :: Maybe (String,Int),
 380
 381   -- paths etc.
 382   objectDir             :: Maybe String,
 383   hiDir                 :: Maybe String,
 384   stubDir               :: Maybe String,
 385
 386   objectSuf             :: String,
 387   hcSuf                 :: String,
 388   hiSuf                 :: String,
 389
 390   outputFile            :: Maybe String,
 391   outputHi              :: Maybe String,
 392   dynLibLoader          :: DynLibLoader,
 393
 394   -- | This is set by 'DriverPipeline.runPipeline' based on where
 395   --    its output is going.
 396   dumpPrefix            :: Maybe FilePath,
 397
 398   -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
 399   --    Set by @-ddump-file-prefix@
 400   dumpPrefixForce       :: Maybe FilePath,
 401
 402   includePaths          :: [String],
 403   libraryPaths          :: [String],
 404   frameworkPaths        :: [String],    -- used on darwin only
 405   cmdlineFrameworks     :: [String],    -- ditto
 406   tmpDir                :: String,      -- no trailing '/'
 407
 408   ghcUsagePath          :: FilePath,    -- Filled in by SysTools
 409   ghciUsagePath         :: FilePath,    -- ditto
 410
 411   hpcDir                :: String,      -- ^ Path to store the .mix files
 412
 413   -- options for particular phases
 414   opt_L                 :: [String],
 415   opt_P                 :: [String],
 416   opt_F                 :: [String],
 417   opt_c                 :: [String],
 418   opt_m                 :: [String],
 419   opt_a                 :: [String],
 420   opt_l                 :: [String],
 421   opt_windres           :: [String],
 422
 423   -- commands for particular phases
 424   pgm_L                 :: String,
 425   pgm_P                 :: (String,[Option]),
 426   pgm_F                 :: String,
 427   pgm_c                 :: (String,[Option]),
 428   pgm_m                 :: (String,[Option]),
 429   pgm_s                 :: (String,[Option]),
 430   pgm_a                 :: (String,[Option]),
 431   pgm_l                 :: (String,[Option]),
 432   pgm_dll               :: (String,[Option]),
 433   pgm_T                 :: String,
 434   pgm_sysman            :: String,
 435   pgm_windres           :: String,
 436
 437   --  For ghc -M
 438   depMakefile           :: FilePath,
 439   depIncludePkgDeps     :: Bool,
 440   depExcludeMods        :: [ModuleName],
 441   depSuffixes           :: [String],
 442
 443   --  Package flags
 444   extraPkgConfs         :: [FilePath],
 445   topDir                :: FilePath,    -- filled in by SysTools
 446   systemPackageConfig   :: FilePath,    -- ditto
 447         -- ^ The @-package-conf@ flags given on the command line, in the order
 448         -- they appeared.
 449
 450   packageFlags          :: [PackageFlag],
 451         -- ^ The @-package@ and @-hide-package@ flags from the command-line
 452
 453   -- Package state
 454   -- NB. do not modify this field, it is calculated by
 455   -- Packages.initPackages and Packages.updatePackages.
 456   pkgDatabase           :: Maybe [PackageConfig],
 457   pkgState              :: PackageState,
 458
 459   -- Temporary files
 460   -- These have to be IORefs, because the defaultCleanupHandler needs to
 461   -- know what to clean when an exception happens
 462   filesToClean          :: IORef [FilePath],
 463   dirsToClean           :: IORef (FiniteMap FilePath FilePath),
 464
 465   -- hsc dynamic flags
 466   flags                 :: [DynFlag],
 467
 468   -- | Message output action: use "ErrUtils" instead of this if you can
 469   log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),
 470
 471   haddockOptions :: Maybe String
 472  }
 473
 474 wayNames :: DynFlags -> [WayName]
 475 wayNames = map wayName . ways
 476
 477 -- | The target code type of the compilation (if any).
 478 --
 479 -- Whenever you change the target, also make sure to set 'ghcLink' to
 480 -- something sensible.
 481 --
 482 -- 'HscNothing' can be used to avoid generating any output, however, note
 483 -- that:
 484 --
 485 --  * This will not run the desugaring step, thus no warnings generated in
 486 --    this step will be output.  In particular, this includes warnings related
 487 --    to pattern matching.  You can run the desugarer manually using
 488 --    'GHC.desugarModule'.
 489 --
 490 --  * If a program uses Template Haskell the typechecker may try to run code
 491 --    from an imported module.  This will fail if no code has been generated
 492 --    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
 493 --    whether this might be the case and choose to either switch to a
 494 --    different target or avoid typechecking such modules.  (The latter may
 495 --    preferable for security reasons.)
 496 --
 497 data HscTarget
 498   = HscC           -- ^ Generate C code.
 499   | HscAsm         -- ^ Generate assembly using the native code generator.
 500   | HscJava        -- ^ Generate Java bytecode.
 501   | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
 502   | HscNothing     -- ^ Don't generate any code.  See notes above.
 503   deriving (Eq, Show)
 504
 505 -- | Will this target result in an object file on the disk?
 506 isObjectTarget :: HscTarget -> Bool
 507 isObjectTarget HscC     = True
 508 isObjectTarget HscAsm   = True
 509 isObjectTarget _        = False
 510
 511 -- | The 'GhcMode' tells us whether we're doing multi-module
 512 -- compilation (controlled via the "GHC" API) or one-shot
 513 -- (single-module) compilation.  This makes a difference primarily to
 514 -- the "Finder": in one-shot mode we look for interface files for
 515 -- imported modules, but in multi-module mode we look for source files
 516 -- in order to check whether they need to be recompiled.
 517 data GhcMode
 518   = CompManager         -- ^ @\-\-make@, GHCi, etc.
 519   | OneShot             -- ^ @ghc -c Foo.hs@
 520   | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
 521   deriving Eq
 522
 523 instance Outputable GhcMode where
 524   ppr CompManager = ptext (sLit "CompManager")
 525   ppr OneShot     = ptext (sLit "OneShot")
 526   ppr MkDepend    = ptext (sLit "MkDepend")
 527
 528 isOneShot :: GhcMode -> Bool
 529 isOneShot OneShot = True
 530 isOneShot _other  = False
 531
 532 -- | What to do in the link step, if there is one.
 533 data GhcLink
 534   = NoLink              -- ^ Don't link at all
 535   | LinkBinary          -- ^ Link object code into a binary
 536   | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
 537                         --   bytecode and object code).
 538   | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
 539   deriving (Eq, Show)
 540
 541 isNoLink :: GhcLink -> Bool
 542 isNoLink NoLink = True
 543 isNoLink _      = False
 544
 545 -- Is it worth evaluating this Bool and caching it in the DynFlags value
 546 -- during initDynFlags?
 547 doingTickyProfiling :: DynFlags -> Bool
 548 doingTickyProfiling _ = opt_Ticky
 549   -- XXX -ticky is a static flag, because it implies -debug which is also
 550   -- static.  If the way flags were made dynamic, we could fix this.
 551
 552 data PackageFlag
 553   = ExposePackage  String
 554   | ExposePackageId String
 555   | HidePackage    String
 556   | IgnorePackage  String
 557   deriving Eq
 558
 559 defaultHscTarget :: HscTarget
 560 defaultHscTarget = defaultObjectTarget
 561
 562 -- | The 'HscTarget' value corresponding to the default way to create
 563 -- object files on the current platform.
 564 defaultObjectTarget :: HscTarget
 565 defaultObjectTarget
 566   | cGhcWithNativeCodeGen == "YES"      =  HscAsm
 567   | otherwise                           =  HscC
 568
 569 data DynLibLoader
 570   = Deployable
 571   | Wrapped (Maybe String)
 572   | SystemDependent
 573   deriving Eq
 574
 575 -- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
 576 initDynFlags :: DynFlags -> IO DynFlags
 577 initDynFlags dflags = do
 578  -- someday these will be dynamic flags
 579  ways <- readIORef v_Ways
 580  refFilesToClean <- newIORef []
 581  refDirsToClean <- newIORef emptyFM
 582  return dflags{
 583         ways            = ways,
 584         buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
 585         rtsBuildTag     = mkBuildTag ways,
 586         filesToClean    = refFilesToClean,
 587         dirsToClean     = refDirsToClean
 588         }
 589
 590 -- | The normal 'DynFlags'. Note that they is not suitable for use in this form
 591 -- and must be fully initialized by 'GHC.newSession' first.
 592 defaultDynFlags :: DynFlags
 593 defaultDynFlags =
 594      DynFlags {
 595         ghcMode                 = CompManager,
 596         ghcLink                 = LinkBinary,
 597         coreToDo                = Nothing,
 598         stgToDo                 = Nothing,
 599         hscTarget               = defaultHscTarget,
 600         hscOutName              = "",
 601         extCoreName             = "",
 602         verbosity               = 0,
 603         optLevel                = 0,
 604         simplPhases             = 2,
 605         maxSimplIterations      = 4,
 606         shouldDumpSimplPhase    = const False,
 607         ruleCheck               = Nothing,
 608         specConstrThreshold     = Just 200,
 609         specConstrCount         = Just 3,
 610         liberateCaseThreshold   = Just 200,
 611         strictnessBefore        = [],
 612
 613 #ifndef OMIT_NATIVE_CODEGEN
 614         targetPlatform          = defaultTargetPlatform,
 615 #endif
 616         stolen_x86_regs         = 4,
 617         cmdlineHcIncludes       = [],
 618         importPaths             = ["."],
 619         mainModIs               = mAIN,
 620         mainFunIs               = Nothing,
 621         ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,
 622
 623         dphBackend              = DPHPar,
 624
 625         thisPackage             = mainPackageId,
 626
 627         objectDir               = Nothing,
 628         hiDir                   = Nothing,
 629         stubDir                 = Nothing,
 630
 631         objectSuf               = phaseInputExt StopLn,
 632         hcSuf                   = phaseInputExt HCc,
 633         hiSuf                   = "hi",
 634
 635         outputFile              = Nothing,
 636         outputHi                = Nothing,
 637         dynLibLoader            = SystemDependent,
 638         dumpPrefix              = Nothing,
 639         dumpPrefixForce         = Nothing,
 640         includePaths            = [],
 641         libraryPaths            = [],
 642         frameworkPaths          = [],
 643         cmdlineFrameworks       = [],
 644         tmpDir                  = cDEFAULT_TMPDIR,
 645
 646         hpcDir                  = ".hpc",
 647
 648         opt_L                   = [],
 649         opt_P                   = (if opt_PIC
 650                                    then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
 651                                    else []),
 652         opt_F                   = [],
 653         opt_c                   = [],
 654         opt_a                   = [],
 655         opt_m                   = [],
 656         opt_l                   = [],
 657         opt_windres             = [],
 658
 659         extraPkgConfs           = [],
 660         packageFlags            = [],
 661         pkgDatabase             = Nothing,
 662         pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
 663         ways                    = panic "defaultDynFlags: No ways",
 664         buildTag                = panic "defaultDynFlags: No buildTag",
 665         rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
 666         splitInfo               = Nothing,
 667         -- initSysTools fills all these in
 668         ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
 669         ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
 670         topDir                  = panic "defaultDynFlags: No topDir",
 671         systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
 672         pgm_L                   = panic "defaultDynFlags: No pgm_L",
 673         pgm_P                   = panic "defaultDynFlags: No pgm_P",
 674         pgm_F                   = panic "defaultDynFlags: No pgm_F",
 675         pgm_c                   = panic "defaultDynFlags: No pgm_c",
 676         pgm_m                   = panic "defaultDynFlags: No pgm_m",
 677         pgm_s                   = panic "defaultDynFlags: No pgm_s",
 678         pgm_a                   = panic "defaultDynFlags: No pgm_a",
 679         pgm_l                   = panic "defaultDynFlags: No pgm_l",
 680         pgm_dll                 = panic "defaultDynFlags: No pgm_dll",
 681         pgm_T                   = panic "defaultDynFlags: No pgm_T",
 682         pgm_sysman              = panic "defaultDynFlags: No pgm_sysman",
 683         pgm_windres             = panic "defaultDynFlags: No pgm_windres",
 684         -- end of initSysTools values
 685         -- ghc -M values
 686         depMakefile       = "Makefile",
 687         depIncludePkgDeps = False,
 688         depExcludeMods    = [],
 689         depSuffixes       = [],
 690         -- end of ghc -M values
 691         filesToClean   = panic "defaultDynFlags: No filesToClean",
 692         dirsToClean    = panic "defaultDynFlags: No dirsToClean",
 693         haddockOptions = Nothing,
 694         flags = [
 695             Opt_AutoLinkPackages,
 696             Opt_ReadUserPackageConf,
 697
 698             Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
 699                                 -- behaviour the default, to see if anyone notices
 700                                 -- SLPJ July 06
 701
 702             Opt_ImplicitPrelude,
 703             Opt_MonomorphismRestriction,
 704             Opt_NPlusKPatterns,
 705
 706             Opt_MethodSharing,
 707
 708             Opt_DoAsmMangling,
 709
 710             Opt_SharedImplib,
 711
 712             Opt_GenManifest,
 713             Opt_EmbedManifest,
 714             Opt_PrintBindContents
 715             ]
 716             ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
 717                     -- The default -O0 options
 718             ++ standardWarnings,
 719
 720         log_action = \severity srcSpan style msg ->
 721                         case severity of
 722                           SevInfo  -> printErrs (msg style)
 723                           SevFatal -> printErrs (msg style)
 724                           _        -> do
 725                                 hPutChar stderr '\n'
 726                                 printErrs ((mkLocMessage srcSpan msg) style)
 727                      -- careful (#2302): printErrs prints in UTF-8, whereas
 728                      -- converting to string first and using hPutStr would
 729                      -- just emit the low 8 bits of each unicode char.
 730       }
 731
 732 {-
 733 Note [Verbosity levels]
 734 ~~~~~~~~~~~~~~~~~~~~~~~
 735     0   |   print errors & warnings only
 736     1   |   minimal verbosity: print "compiling M ... done." for each module.
 737     2   |   equivalent to -dshow-passes
 738     3   |   equivalent to existing "ghc -v"
 739     4   |   "ghc -v -ddump-most"
 740     5   |   "ghc -v -ddump-all"
 741 -}
 742
 743 -- | Test whether a 'DynFlag' is set
 744 dopt :: DynFlag -> DynFlags -> Bool
 745 dopt f dflags  = f `elem` (flags dflags)
 746
 747 -- | Set a 'DynFlag'
 748 dopt_set :: DynFlags -> DynFlag -> DynFlags
 749 dopt_set dfs f = dfs{ flags = f : flags dfs }
 750
 751 -- | Unset a 'DynFlag'
 752 dopt_unset :: DynFlags -> DynFlag -> DynFlags
 753 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
 754
 755 -- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
 756 getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
 757         -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
 758         -> [a]                  -- ^ Correctly ordered extracted options
 759 getOpts dflags opts = reverse (opts dflags)
 760         -- We add to the options from the front, so we need to reverse the list
 761
 762 -- | Gets the verbosity flag for the current verbosity level. This is fed to
 763 -- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
 764 getVerbFlag :: DynFlags -> String
 765 getVerbFlag dflags
 766   | verbosity dflags >= 3  = "-v"
 767   | otherwise =  ""
 768
 769 setObjectDir, setHiDir, setStubDir, setOutputDir,
 770          setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
 771          setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
 772          addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
 773          addCmdlineFramework, addHaddockOpts
 774    :: String -> DynFlags -> DynFlags
 775 setOutputFile, setOutputHi, setDumpPrefixForce
 776    :: Maybe String -> DynFlags -> DynFlags
 777
 778 setObjectDir  f d = d{ objectDir  = Just f}
 779 setHiDir      f d = d{ hiDir      = Just f}
 780 setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
 781   -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
 782   -- \#included from the .hc file when compiling with -fvia-C.
 783 setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
 784
 785 setObjectSuf  f d = d{ objectSuf  = f}
 786 setHiSuf      f d = d{ hiSuf      = f}
 787 setHcSuf      f d = d{ hcSuf      = f}
 788
 789 setOutputFile f d = d{ outputFile = f}
 790 setOutputHi   f d = d{ outputHi   = f}
 791
 792 parseDynLibLoaderMode f d =
 793  case splitAt 8 f of
 794    ("deploy", "")       -> d{ dynLibLoader = Deployable }
 795    ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
 796    ("wrapped", "")      -> d{ dynLibLoader = Wrapped Nothing }
 797    ("wrapped:", "hard") -> d{ dynLibLoader = Wrapped Nothing }
 798    ("wrapped:", flex)   -> d{ dynLibLoader = Wrapped (Just flex) }
 799    _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
 800
 801 setDumpPrefixForce f d = d { dumpPrefixForce = f}
 802
 803 -- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
 804 -- Config.hs should really use Option.
 805 setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}
 806
 807 setPgmL   f d = d{ pgm_L   = f}
 808 setPgmF   f d = d{ pgm_F   = f}
 809 setPgmc   f d = d{ pgm_c   = (f,[])}
 810 setPgmm   f d = d{ pgm_m   = (f,[])}
 811 setPgms   f d = d{ pgm_s   = (f,[])}
 812 setPgma   f d = d{ pgm_a   = (f,[])}
 813 setPgml   f d = d{ pgm_l   = (f,[])}
 814 setPgmdll f d = d{ pgm_dll = (f,[])}
 815 setPgmwindres f d = d{ pgm_windres = f}
 816
 817 addOptL   f d = d{ opt_L   = f : opt_L d}
 818 addOptP   f d = d{ opt_P   = f : opt_P d}
 819 addOptF   f d = d{ opt_F   = f : opt_F d}
 820 addOptc   f d = d{ opt_c   = f : opt_c d}
 821 addOptm   f d = d{ opt_m   = f : opt_m d}
 822 addOpta   f d = d{ opt_a   = f : opt_a d}
 823 addOptl   f d = d{ opt_l   = f : opt_l d}
 824 addOptwindres f d = d{ opt_windres = f : opt_windres d}
 825
 826 setDepMakefile :: FilePath -> DynFlags -> DynFlags
 827 setDepMakefile f d = d { depMakefile = deOptDep f }
 828
 829 setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
 830 setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }
 831
 832 addDepExcludeMod :: String -> DynFlags -> DynFlags
 833 addDepExcludeMod m d
 834     = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }
 835
 836 addDepSuffix :: FilePath -> DynFlags -> DynFlags
 837 addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }
 838
 839 -- XXX Legacy code:
 840 -- We used to use "-optdep-flag -optdeparg", so for legacy applications
 841 -- we need to strip the "-optdep" off of the arg
 842 deOptDep :: String -> String
 843 deOptDep x = case stripPrefix "-optdep" x of
 844              Just rest -> rest
 845              Nothing -> x
 846
 847 addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}
 848
 849 addHaddockOpts f d = d{ haddockOptions = Just f}
 850
 851 -- -----------------------------------------------------------------------------
 852 -- Command-line options
 853
 854 -- | When invoking external tools as part of the compilation pipeline, we
 855 -- pass these a sequence of options on the command-line. Rather than
 856 -- just using a list of Strings, we use a type that allows us to distinguish
 857 -- between filepaths and 'other stuff'. The reason for this is that
 858 -- this type gives us a handle on transforming filenames, and filenames only,
 859 -- to whatever format they're expected to be on a particular platform.
 860 data Option
 861  = FileOption -- an entry that _contains_ filename(s) / filepaths.
 862               String  -- a non-filepath prefix that shouldn't be
 863                       -- transformed (e.g., "/out=")
 864               String  -- the filepath/filename portion
 865  | Option     String
 866
 867 showOpt :: Option -> String
 868 showOpt (FileOption pre f) = pre ++ f
 869 showOpt (Option s)  = s
 870
 871 -----------------------------------------------------------------------------
 872 -- Setting the optimisation level
 873
 874 updOptLevel :: Int -> DynFlags -> DynFlags
 875 -- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
 876 updOptLevel n dfs
 877   = dfs2{ optLevel = final_n }
 878   where
 879    final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
 880    dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
 881    dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts
 882
 883    extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
 884    remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
 885
 886 optLevelFlags :: [([Int], DynFlag)]
 887 optLevelFlags
 888   = [ ([0],     Opt_IgnoreInterfacePragmas)
 889     , ([0],     Opt_OmitInterfacePragmas)
 890
 891     , ([1,2],   Opt_IgnoreAsserts)
 892     , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
 893                                          --              in PrelRules
 894     , ([1,2],   Opt_DoEtaReduction)
 895     , ([1,2],   Opt_CaseMerge)
 896     , ([1,2],   Opt_Strictness)
 897     , ([1,2],   Opt_CSE)
 898     , ([1,2],   Opt_FullLaziness)
 899     , ([1,2],   Opt_Specialise)
 900     , ([1,2],   Opt_FloatIn)
 901
 902     , ([2],     Opt_LiberateCase)
 903     , ([2],     Opt_SpecConstr)
 904
 905 --     , ([2],     Opt_StaticArgumentTransformation)
 906 -- Max writes: I think it's probably best not to enable SAT with -O2 for the
 907 -- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
 908 -- several improvements to the heuristics, and I'm concerned that without
 909 -- those changes SAT will interfere with some attempts to write "high
 910 -- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
 911 -- this year. In particular, the version in HEAD lacks the tail call
 912 -- criterion, so many things that look like reasonable loops will be
 913 -- turned into functions with extra (unneccesary) thunk creation.
 914
 915     , ([0,1,2], Opt_DoLambdaEtaExpansion)
 916                 -- This one is important for a tiresome reason:
 917                 -- we want to make sure that the bindings for data
 918                 -- constructors are eta-expanded.  This is probably
 919                 -- a good thing anyway, but it seems fragile.
 920     ]
 921
 922 -- -----------------------------------------------------------------------------
 923 -- Standard sets of warning options
 924
 925 standardWarnings :: [DynFlag]
 926 standardWarnings
 927     = [ Opt_WarnWarningsDeprecations,
 928         Opt_WarnDeprecatedFlags,
 929         Opt_WarnUnrecognisedPragmas,
 930         Opt_WarnOverlappingPatterns,
 931         Opt_WarnMissingFields,
 932         Opt_WarnMissingMethods,
 933         Opt_WarnDuplicateExports,
 934         Opt_WarnLazyUnliftedBindings,
 935         Opt_WarnDodgyForeignImports,
 936         Opt_WarnWrongDoBind
 937       ]
 938
 939 minusWOpts :: [DynFlag]
 940 minusWOpts
 941     = standardWarnings ++
 942       [ Opt_WarnUnusedBinds,
 943         Opt_WarnUnusedMatches,
 944         Opt_WarnUnusedImports,
 945         Opt_WarnIncompletePatterns,
 946         Opt_WarnDodgyExports,
 947         Opt_WarnDodgyImports
 948       ]
 949
 950 minusWallOpts :: [DynFlag]
 951 minusWallOpts
 952     = minusWOpts ++
 953       [ Opt_WarnTypeDefaults,
 954         Opt_WarnNameShadowing,
 955         Opt_WarnMissingSigs,
 956         Opt_WarnHiShadows,
 957         Opt_WarnOrphans,
 958         Opt_WarnUnusedDoBind
 959       ]
 960
 961 -- minuswRemovesOpts should be every warning option
 962 minuswRemovesOpts :: [DynFlag]
 963 minuswRemovesOpts
 964     = minusWallOpts ++
 965       [Opt_WarnImplicitPrelude,
 966        Opt_WarnIncompletePatternsRecUpd,
 967        Opt_WarnSimplePatterns,
 968        Opt_WarnMonomorphism,
 969        Opt_WarnUnrecognisedPragmas,
 970        Opt_WarnTabs
 971       ]
 972
 973 -- -----------------------------------------------------------------------------
 974 -- CoreToDo:  abstraction of core-to-core passes to run.
 975
 976 data CoreToDo           -- These are diff core-to-core passes,
 977                         -- which may be invoked in any order,
 978                         -- as many times as you like.
 979
 980   = CoreDoSimplify      -- The core-to-core simplifier.
 981         SimplifierMode
 982         [SimplifierSwitch]
 983                         -- Each run of the simplifier can take a different
 984                         -- set of simplifier-specific flags.
 985   | CoreDoFloatInwards
 986   | CoreDoFloatOutwards FloatOutSwitches
 987   | CoreLiberateCase
 988   | CoreDoPrintCore
 989   | CoreDoStaticArgs
 990   | CoreDoStrictness
 991   | CoreDoWorkerWrapper
 992   | CoreDoSpecialising
 993   | CoreDoSpecConstr
 994   | CoreDoOldStrictness
 995   | CoreDoGlomBinds
 996   | CoreCSE
 997   | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
 998                                                 -- matching this string
 999   | CoreDoVectorisation PackageId
1000   | CoreDoNothing                -- Useful when building up
1001   | CoreDoPasses [CoreToDo]      -- lists of these things
1002
1003
1004 data SimplifierMode             -- See comments in SimplMonad
1005   = SimplGently
1006         { sm_rules :: Bool      -- Whether RULES are enabled
1007         , sm_inline :: Bool }   -- Whether inlining is enabled
1008
1009   | SimplPhase
1010         { sm_num :: Int           -- Phase number; counts downward so 0 is last phase
1011         , sm_names :: [String] }  -- Name(s) of the phase
1012
1013 instance Outputable SimplifierMode where
1014     ppr (SimplPhase { sm_num = n, sm_names = ss })
1015        = int n <+> brackets (text (concat $ intersperse "," ss))
1016     ppr (SimplGently { sm_rules = r, sm_inline = i })
1017        = ptext (sLit "gentle") <>
1018            brackets (pp_flag r (sLit "rules") <> comma <>
1019                      pp_flag i (sLit "inline"))
1020          where
1021            pp_flag f s = ppUnless f (ptext (sLit "no")) <+> ptext s
1022
1023 data SimplifierSwitch
1024   = MaxSimplifierIterations Int
1025   | NoCaseOfCase
1026
1027 data FloatOutSwitches = FloatOutSwitches {
1028         floatOutLambdas :: Bool,     -- ^ True <=> float lambdas to top level
1029         floatOutConstants :: Bool    -- ^ True <=> float constants to top level,
1030                                      --            even if they do not escape a lambda
1031     }
1032
1033 instance Outputable FloatOutSwitches where
1034     ppr = pprFloatOutSwitches
1035
1036 pprFloatOutSwitches :: FloatOutSwitches -> SDoc
1037 pprFloatOutSwitches sw = pp_not (floatOutLambdas sw) <+> text "lambdas" <> comma
1038                      <+> pp_not (floatOutConstants sw) <+> text "constants"
1039   where
1040     pp_not True  = empty
1041     pp_not False = text "not"
1042
1043 -- | Switches that specify the minimum amount of floating out
1044 -- gentleFloatOutSwitches :: FloatOutSwitches
1045 -- gentleFloatOutSwitches = FloatOutSwitches False False
1046
1047 -- | Switches that do not specify floating out of lambdas, just of constants
1048 constantsOnlyFloatOutSwitches :: FloatOutSwitches
1049 constantsOnlyFloatOutSwitches = FloatOutSwitches False True
1050
1051
1052 -- The core-to-core pass ordering is derived from the DynFlags:
1053 runWhen :: Bool -> CoreToDo -> CoreToDo
1054 runWhen True  do_this = do_this
1055 runWhen False _       = CoreDoNothing
1056
1057 runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
1058 runMaybe (Just x) f = f x
1059 runMaybe Nothing  _ = CoreDoNothing
1060
1061 getCoreToDo :: DynFlags -> [CoreToDo]
1062 getCoreToDo dflags
1063   | Just todo <- coreToDo dflags = todo -- set explicitly by user
1064   | otherwise = core_todo
1065   where
1066     opt_level     = optLevel dflags
1067     phases        = simplPhases dflags
1068     max_iter      = maxSimplIterations dflags
1069     strictness    = dopt Opt_Strictness dflags
1070     full_laziness = dopt Opt_FullLaziness dflags
1071     do_specialise = dopt Opt_Specialise dflags
1072     do_float_in   = dopt Opt_FloatIn dflags
1073     cse           = dopt Opt_CSE dflags
1074     spec_constr   = dopt Opt_SpecConstr dflags
1075     liberate_case = dopt Opt_LiberateCase dflags
1076     rule_check    = ruleCheck dflags
1077     static_args   = dopt Opt_StaticArgumentTransformation dflags
1078
1079     maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
1080
1081     maybe_strictness_before phase
1082       = runWhen (phase `elem` strictnessBefore dflags) CoreDoStrictness
1083
1084     simpl_phase phase names iter
1085       = CoreDoPasses
1086           [ maybe_strictness_before phase,
1087             CoreDoSimplify (SimplPhase phase names) [
1088               MaxSimplifierIterations iter
1089             ],
1090             maybe_rule_check phase
1091           ]
1092
1093     vectorisation
1094       = runWhen (dopt Opt_Vectorise dflags)
1095         $ CoreDoPasses [ simpl_gently, CoreDoVectorisation (dphPackage dflags) ]
1096
1097
1098                 -- By default, we have 2 phases before phase 0.
1099
1100                 -- Want to run with inline phase 2 after the specialiser to give
1101                 -- maximum chance for fusion to work before we inline build/augment
1102                 -- in phase 1.  This made a difference in 'ansi' where an
1103                 -- overloaded function wasn't inlined till too late.
1104
1105                 -- Need phase 1 so that build/augment get
1106                 -- inlined.  I found that spectral/hartel/genfft lost some useful
1107                 -- strictness in the function sumcode' if augment is not inlined
1108                 -- before strictness analysis runs
1109     simpl_phases = CoreDoPasses [ simpl_phase phase ["main"] max_iter
1110                                   | phase <- [phases, phases-1 .. 1] ]
1111
1112
1113         -- initial simplify: mk specialiser happy: minimum effort please
1114     simpl_gently = CoreDoSimplify
1115                        (SimplGently { sm_rules = True, sm_inline = False })
1116                        [
1117                         --      Simplify "gently"
1118                         -- Don't inline anything till full laziness has bitten
1119                         -- In particular, inlining wrappers inhibits floating
1120                         -- e.g. ...(case f x of ...)...
1121                         --  ==> ...(case (case x of I# x# -> fw x#) of ...)...
1122                         --  ==> ...(case x of I# x# -> case fw x# of ...)...
1123                         -- and now the redex (f x) isn't floatable any more
1124                         -- Similarly, don't apply any rules until after full
1125                         -- laziness.  Notably, list fusion can prevent floating.
1126
1127             NoCaseOfCase,       -- Don't do case-of-case transformations.
1128                                 -- This makes full laziness work better
1129             MaxSimplifierIterations max_iter
1130         ]
1131
1132     core_todo =
1133      if opt_level == 0 then
1134        [vectorisation,
1135         simpl_phase 0 ["final"] max_iter]
1136      else {- opt_level >= 1 -} [
1137
1138     -- We want to do the static argument transform before full laziness as it
1139     -- may expose extra opportunities to float things outwards. However, to fix
1140     -- up the output of the transformation we need at do at least one simplify
1141     -- after this before anything else
1142         runWhen static_args (CoreDoPasses [ simpl_gently, CoreDoStaticArgs ]),
1143
1144         -- We run vectorisation here for now, but we might also try to run
1145         -- it later
1146         vectorisation,
1147
1148         -- initial simplify: mk specialiser happy: minimum effort please
1149         simpl_gently,
1150
1151         -- Specialisation is best done before full laziness
1152         -- so that overloaded functions have all their dictionary lambdas manifest
1153         runWhen do_specialise CoreDoSpecialising,
1154
1155         runWhen full_laziness (CoreDoFloatOutwards constantsOnlyFloatOutSwitches),
1156                 -- Was: gentleFloatOutSwitches
1157                 -- I have no idea why, but not floating constants to top level is
1158                 -- very bad in some cases.
1159                 -- Notably: p_ident in spectral/rewrite
1160                 --          Changing from "gentle" to "constantsOnly" improved
1161                 --          rewrite's allocation by 19%, and made  0.0% difference
1162                 --          to any other nofib benchmark
1163
1164         runWhen do_float_in CoreDoFloatInwards,
1165
1166         simpl_phases,
1167
1168                 -- Phase 0: allow all Ids to be inlined now
1169                 -- This gets foldr inlined before strictness analysis
1170
1171                 -- At least 3 iterations because otherwise we land up with
1172                 -- huge dead expressions because of an infelicity in the
1173                 -- simpifier.
1174                 --      let k = BIG in foldr k z xs
1175                 -- ==>  let k = BIG in letrec go = \xs -> ...(k x).... in go xs
1176                 -- ==>  let k = BIG in letrec go = \xs -> ...(BIG x).... in go xs
1177                 -- Don't stop now!
1178         simpl_phase 0 ["main"] (max max_iter 3),
1179
1180
1181 #ifdef OLD_STRICTNESS
1182         CoreDoOldStrictness,
1183 #endif
1184         runWhen strictness (CoreDoPasses [
1185                 CoreDoStrictness,
1186                 CoreDoWorkerWrapper,
1187                 CoreDoGlomBinds,
1188                 simpl_phase 0 ["post-worker-wrapper"] max_iter
1189                 ]),
1190
1191         runWhen full_laziness
1192           (CoreDoFloatOutwards constantsOnlyFloatOutSwitches),
1193                 -- nofib/spectral/hartel/wang doubles in speed if you
1194                 -- do full laziness late in the day.  It only happens
1195                 -- after fusion and other stuff, so the early pass doesn't
1196                 -- catch it.  For the record, the redex is
1197                 --        f_el22 (f_el21 r_midblock)
1198
1199
1200         runWhen cse CoreCSE,
1201                 -- We want CSE to follow the final full-laziness pass, because it may
1202                 -- succeed in commoning up things floated out by full laziness.
1203                 -- CSE used to rely on the no-shadowing invariant, but it doesn't any more
1204
1205         runWhen do_float_in CoreDoFloatInwards,
1206
1207         maybe_rule_check 0,
1208
1209                 -- Case-liberation for -O2.  This should be after
1210                 -- strictness analysis and the simplification which follows it.
1211         runWhen liberate_case (CoreDoPasses [
1212             CoreLiberateCase,
1213             simpl_phase 0 ["post-liberate-case"] max_iter
1214             ]),         -- Run the simplifier after LiberateCase to vastly
1215                         -- reduce the possiblility of shadowing
1216                         -- Reason: see Note [Shadowing] in SpecConstr.lhs
1217
1218         runWhen spec_constr CoreDoSpecConstr,
1219
1220         maybe_rule_check 0,
1221
1222         -- Final clean-up simplification:
1223         simpl_phase 0 ["final"] max_iter
1224      ]
1225
1226 -- -----------------------------------------------------------------------------
1227 -- StgToDo:  abstraction of stg-to-stg passes to run.
1228
1229 data StgToDo
1230   = StgDoMassageForProfiling  -- should be (next to) last
1231   -- There's also setStgVarInfo, but its absolute "lastness"
1232   -- is so critical that it is hardwired in (no flag).
1233   | D_stg_stats
1234
1235 getStgToDo :: DynFlags -> [StgToDo]
1236 getStgToDo dflags
1237   | Just todo <- stgToDo dflags = todo -- set explicitly by user
1238   | otherwise = todo2
1239   where
1240         stg_stats = dopt Opt_StgStats dflags
1241
1242         todo1 = if stg_stats then [D_stg_stats] else []
1243
1244         todo2 | WayProf `elem` wayNames dflags
1245               = StgDoMassageForProfiling : todo1
1246               | otherwise
1247               = todo1
1248
1249 -- -----------------------------------------------------------------------------
1250 -- DynFlags parser
1251
1252 allFlags :: [String]
1253 allFlags = map ('-':) $
1254            [ flagName flag | flag <- dynamic_flags, ok (flagOptKind flag) ] ++
1255            map ("fno-"++) flags ++
1256            map ("f"++) flags ++
1257            map ("X"++) supportedLanguages ++
1258            map ("XNo"++) supportedLanguages
1259     where ok (PrefixPred _ _) = False
1260           ok _ = True
1261           flags = [ name | (name, _, _) <- fFlags ]
1262
1263 dynamic_flags :: [Flag DynP]
1264 dynamic_flags = [
1265     Flag "n"              (NoArg  (setDynFlag Opt_DryRun)) Supported
1266   , Flag "cpp"            (NoArg  (setDynFlag Opt_Cpp)) Supported
1267   , Flag "F"              (NoArg  (setDynFlag Opt_Pp)) Supported
1268   , Flag "#include"       (HasArg (addCmdlineHCInclude))
1269                              (Deprecated "No longer has any effect")
1270   , Flag "v"              (OptIntSuffix setVerbosity) Supported
1271
1272         ------- Specific phases  --------------------------------------------
1273   , Flag "pgmL"           (HasArg (upd . setPgmL)) Supported
1274   , Flag "pgmP"           (HasArg (upd . setPgmP)) Supported
1275   , Flag "pgmF"           (HasArg (upd . setPgmF)) Supported
1276   , Flag "pgmc"           (HasArg (upd . setPgmc)) Supported
1277   , Flag "pgmm"           (HasArg (upd . setPgmm)) Supported
1278   , Flag "pgms"           (HasArg (upd . setPgms)) Supported
1279   , Flag "pgma"           (HasArg (upd . setPgma)) Supported
1280   , Flag "pgml"           (HasArg (upd . setPgml)) Supported
1281   , Flag "pgmdll"         (HasArg (upd . setPgmdll)) Supported
1282   , Flag "pgmwindres"     (HasArg (upd . setPgmwindres)) Supported
1283
1284   , Flag "optL"           (HasArg (upd . addOptL)) Supported
1285   , Flag "optP"           (HasArg (upd . addOptP)) Supported
1286   , Flag "optF"           (HasArg (upd . addOptF)) Supported
1287   , Flag "optc"           (HasArg (upd . addOptc)) Supported
1288   , Flag "optm"           (HasArg (upd . addOptm)) Supported
1289   , Flag "opta"           (HasArg (upd . addOpta)) Supported
1290   , Flag "optl"           (HasArg (upd . addOptl)) Supported
1291   , Flag "optwindres"     (HasArg (upd . addOptwindres)) Supported
1292
1293   , Flag "split-objs"
1294          (NoArg (if can_split then setDynFlag Opt_SplitObjs else return ()))
1295          Supported
1296
1297         -------- ghc -M -----------------------------------------------------
1298   , Flag "dep-suffix"               (HasArg (upd . addDepSuffix)) Supported
1299   , Flag "optdep-s"                 (HasArg (upd . addDepSuffix))
1300          (Deprecated "Use -dep-suffix instead")
1301   , Flag "dep-makefile"             (HasArg (upd . setDepMakefile)) Supported
1302   , Flag "optdep-f"                 (HasArg (upd . setDepMakefile))
1303          (Deprecated "Use -dep-makefile instead")
1304   , Flag "optdep-w"                 (NoArg  (return ()))
1305          (Deprecated "-optdep-w doesn't do anything")
1306   , Flag "include-pkg-deps" (NoArg  (upd (setDepIncludePkgDeps True))) Supported
1307   , Flag "optdep--include-prelude"  (NoArg  (upd (setDepIncludePkgDeps True)))
1308          (Deprecated "Use -include-pkg-deps instead")
1309   , Flag "optdep--include-pkg-deps" (NoArg  (upd (setDepIncludePkgDeps True)))
1310          (Deprecated "Use -include-pkg-deps instead")
1311   , Flag "exclude-module"           (HasArg (upd . addDepExcludeMod)) Supported
1312   , Flag "optdep--exclude-module"   (HasArg (upd . addDepExcludeMod))
1313          (Deprecated "Use -exclude-module instead")
1314   , Flag "optdep-x"                 (HasArg (upd . addDepExcludeMod))
1315          (Deprecated "Use -exclude-module instead")
1316
1317         -------- Linking ----------------------------------------------------
1318   , Flag "c"              (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
1319          Supported
1320   , Flag "no-link"        (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
1321          (Deprecated "Use -c instead")
1322   , Flag "shared"         (NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
1323          Supported
1324   , Flag "dynload"        (HasArg (upd . parseDynLibLoaderMode))
1325          Supported
1326
1327         ------- Libraries ---------------------------------------------------
1328   , Flag "L"              (Prefix addLibraryPath ) Supported
1329   , Flag "l"              (AnySuffix (\s -> do upd (addOptl s))) Supported
1330
1331         ------- Frameworks --------------------------------------------------
1332         -- -framework-path should really be -F ...
1333   , Flag "framework-path" (HasArg addFrameworkPath ) Supported
1334   , Flag "framework"      (HasArg (upd . addCmdlineFramework)) Supported
1335
1336         ------- Output Redirection ------------------------------------------
1337   , Flag "odir"           (HasArg (upd . setObjectDir)) Supported
1338   , Flag "o"              (SepArg (upd . setOutputFile . Just)) Supported
1339   , Flag "ohi"            (HasArg (upd . setOutputHi   . Just )) Supported
1340   , Flag "osuf"           (HasArg (upd . setObjectSuf)) Supported
1341   , Flag "hcsuf"          (HasArg (upd . setHcSuf)) Supported
1342   , Flag "hisuf"          (HasArg (upd . setHiSuf)) Supported
1343   , Flag "hidir"          (HasArg (upd . setHiDir)) Supported
1344   , Flag "tmpdir"         (HasArg (upd . setTmpDir)) Supported
1345   , Flag "stubdir"        (HasArg (upd . setStubDir)) Supported
1346   , Flag "outputdir"      (HasArg (upd . setOutputDir)) Supported
1347   , Flag "ddump-file-prefix" (HasArg (upd . setDumpPrefixForce . Just))
1348          Supported
1349
1350         ------- Keeping temporary files -------------------------------------
1351      -- These can be singular (think ghc -c) or plural (think ghc --make)
1352   , Flag "keep-hc-file"     (NoArg (setDynFlag Opt_KeepHcFiles)) Supported
1353   , Flag "keep-hc-files"    (NoArg (setDynFlag Opt_KeepHcFiles)) Supported
1354   , Flag "keep-s-file"      (NoArg (setDynFlag Opt_KeepSFiles)) Supported
1355   , Flag "keep-s-files"     (NoArg (setDynFlag Opt_KeepSFiles)) Supported
1356   , Flag "keep-raw-s-file"  (NoArg (setDynFlag Opt_KeepRawSFiles)) Supported
1357   , Flag "keep-raw-s-files" (NoArg (setDynFlag Opt_KeepRawSFiles)) Supported
1358      -- This only makes sense as plural
1359   , Flag "keep-tmp-files"   (NoArg (setDynFlag Opt_KeepTmpFiles)) Supported
1360
1361         ------- Miscellaneous ----------------------------------------------
1362   , Flag "no-auto-link-packages" (NoArg (unSetDynFlag Opt_AutoLinkPackages)) Supported
1363   , Flag "no-hs-main"     (NoArg (setDynFlag Opt_NoHsMain)) Supported
1364   , Flag "main-is"        (SepArg setMainIs ) Supported
1365   , Flag "haddock"        (NoArg (setDynFlag Opt_Haddock)) Supported
1366   , Flag "haddock-opts"   (HasArg (upd . addHaddockOpts)) Supported
1367   , Flag "hpcdir"         (SepArg setOptHpcDir) Supported
1368
1369         ------- recompilation checker --------------------------------------
1370   , Flag "recomp"         (NoArg (unSetDynFlag Opt_ForceRecomp))
1371          (Deprecated "Use -fno-force-recomp instead")
1372   , Flag "no-recomp"      (NoArg (setDynFlag   Opt_ForceRecomp))
1373          (Deprecated "Use -fforce-recomp instead")
1374
1375         ------ HsCpp opts ---------------------------------------------------
1376   , Flag "D"              (AnySuffix (upd . addOptP)) Supported
1377   , Flag "U"              (AnySuffix (upd . addOptP)) Supported
1378
1379         ------- Include/Import Paths ----------------------------------------
1380   , Flag "I"              (Prefix    addIncludePath) Supported
1381   , Flag "i"              (OptPrefix addImportPath ) Supported
1382
1383         ------ Debugging ----------------------------------------------------
1384   , Flag "dstg-stats"     (NoArg (setDynFlag Opt_StgStats)) Supported
1385
1386   , Flag "ddump-cmm"               (setDumpFlag Opt_D_dump_cmm)
1387          Supported
1388   , Flag "ddump-cmmz"              (setDumpFlag Opt_D_dump_cmmz)
1389          Supported
1390   , Flag "ddump-cmmz-pretty"       (setDumpFlag Opt_D_dump_cmmz_pretty)
1391          Supported
1392   , Flag "ddump-cps-cmm"           (setDumpFlag Opt_D_dump_cps_cmm)
1393          Supported
1394   , Flag "ddump-cvt-cmm"           (setDumpFlag Opt_D_dump_cvt_cmm)
1395          Supported
1396   , Flag "ddump-asm"               (setDumpFlag Opt_D_dump_asm)
1397          Supported
1398   , Flag "ddump-asm-native"        (setDumpFlag Opt_D_dump_asm_native)
1399          Supported
1400   , Flag "ddump-asm-liveness"      (setDumpFlag Opt_D_dump_asm_liveness)
1401          Supported
1402   , Flag "ddump-asm-coalesce"      (setDumpFlag Opt_D_dump_asm_coalesce)
1403          Supported
1404   , Flag "ddump-asm-regalloc"      (setDumpFlag Opt_D_dump_asm_regalloc)
1405          Supported
1406   , Flag "ddump-asm-conflicts"     (setDumpFlag Opt_D_dump_asm_conflicts)
1407          Supported
1408   , Flag "ddump-asm-regalloc-stages"
1409                                  (setDumpFlag Opt_D_dump_asm_regalloc_stages)
1410          Supported
1411   , Flag "ddump-asm-stats"         (setDumpFlag Opt_D_dump_asm_stats)
1412          Supported
1413   , Flag "ddump-asm-expanded"      (setDumpFlag Opt_D_dump_asm_expanded)
1414          Supported
1415   , Flag "ddump-cpranal"           (setDumpFlag Opt_D_dump_cpranal)
1416          Supported
1417   , Flag "ddump-deriv"             (setDumpFlag Opt_D_dump_deriv)
1418          Supported
1419   , Flag "ddump-ds"                (setDumpFlag Opt_D_dump_ds)
1420          Supported
1421   , Flag "ddump-flatC"             (setDumpFlag Opt_D_dump_flatC)
1422          Supported
1423   , Flag "ddump-foreign"           (setDumpFlag Opt_D_dump_foreign)
1424          Supported
1425   , Flag "ddump-inlinings"         (setDumpFlag Opt_D_dump_inlinings)
1426          Supported
1427   , Flag "ddump-rule-firings"      (setDumpFlag Opt_D_dump_rule_firings)
1428          Supported
1429   , Flag "ddump-occur-anal"        (setDumpFlag Opt_D_dump_occur_anal)
1430          Supported
1431   , Flag "ddump-parsed"            (setDumpFlag Opt_D_dump_parsed)
1432          Supported
1433   , Flag "ddump-rn"                (setDumpFlag Opt_D_dump_rn)
1434          Supported
1435   , Flag "ddump-simpl"             (setDumpFlag Opt_D_dump_simpl)
1436          Supported
1437   , Flag "ddump-simpl-iterations"  (setDumpFlag Opt_D_dump_simpl_iterations)
1438          Supported
1439   , Flag "ddump-simpl-phases"      (OptPrefix setDumpSimplPhases)
1440          Supported
1441   , Flag "ddump-spec"              (setDumpFlag Opt_D_dump_spec)
1442          Supported
1443   , Flag "ddump-prep"              (setDumpFlag Opt_D_dump_prep)
1444          Supported
1445   , Flag "ddump-stg"               (setDumpFlag Opt_D_dump_stg)
1446          Supported
1447   , Flag "ddump-stranal"           (setDumpFlag Opt_D_dump_stranal)
1448          Supported
1449   , Flag "ddump-tc"                (setDumpFlag Opt_D_dump_tc)
1450          Supported
1451   , Flag "ddump-types"             (setDumpFlag Opt_D_dump_types)
1452          Supported
1453   , Flag "ddump-rules"             (setDumpFlag Opt_D_dump_rules)
1454          Supported
1455   , Flag "ddump-cse"               (setDumpFlag Opt_D_dump_cse)
1456          Supported
1457   , Flag "ddump-worker-wrapper"    (setDumpFlag Opt_D_dump_worker_wrapper)
1458          Supported
1459   , Flag "ddump-rn-trace"          (setDumpFlag Opt_D_dump_rn_trace)
1460          Supported
1461   , Flag "ddump-if-trace"          (setDumpFlag Opt_D_dump_if_trace)
1462          Supported
1463   , Flag "ddump-tc-trace"          (setDumpFlag Opt_D_dump_tc_trace)
1464          Supported
1465   , Flag "ddump-splices"           (setDumpFlag Opt_D_dump_splices)
1466          Supported
1467   , Flag "ddump-rn-stats"          (setDumpFlag Opt_D_dump_rn_stats)
1468          Supported
1469   , Flag "ddump-opt-cmm"           (setDumpFlag Opt_D_dump_opt_cmm)
1470          Supported
1471   , Flag "ddump-simpl-stats"       (setDumpFlag Opt_D_dump_simpl_stats)
1472          Supported
1473   , Flag "ddump-bcos"              (setDumpFlag Opt_D_dump_BCOs)
1474          Supported
1475   , Flag "dsource-stats"           (setDumpFlag Opt_D_source_stats)
1476          Supported
1477   , Flag "dverbose-core2core"      (NoArg (do { setVerbosity (Just 2)
1478                                               ; setVerboseCore2Core }))
1479          Supported
1480   , Flag "dverbose-stg2stg"        (setDumpFlag Opt_D_verbose_stg2stg)
1481          Supported
1482   , Flag "ddump-hi"                (setDumpFlag Opt_D_dump_hi)
1483          Supported
1484   , Flag "ddump-minimal-imports"   (setDumpFlag Opt_D_dump_minimal_imports)
1485          Supported
1486   , Flag "ddump-vect"              (setDumpFlag Opt_D_dump_vect)
1487          Supported
1488   , Flag "ddump-hpc"               (setDumpFlag Opt_D_dump_hpc)
1489          Supported
1490   , Flag "ddump-mod-cycles"        (setDumpFlag Opt_D_dump_mod_cycles)
1491          Supported
1492   , Flag "ddump-view-pattern-commoning" (setDumpFlag Opt_D_dump_view_pattern_commoning)
1493          Supported
1494   , Flag "ddump-to-file"           (setDumpFlag Opt_DumpToFile)
1495          Supported
1496   , Flag "ddump-hi-diffs"          (setDumpFlag Opt_D_dump_hi_diffs)
1497          Supported
1498   , Flag "ddump-rtti"              (setDumpFlag Opt_D_dump_rtti)
1499          Supported
1500
1501   , Flag "dcore-lint"              (NoArg (setDynFlag Opt_DoCoreLinting))
1502          Supported
1503   , Flag "dstg-lint"               (NoArg (setDynFlag Opt_DoStgLinting))
1504          Supported
1505   , Flag "dcmm-lint"               (NoArg (setDynFlag Opt_DoCmmLinting))
1506          Supported
1507   , Flag "dasm-lint"               (NoArg (setDynFlag Opt_DoAsmLinting))
1508          Supported
1509   , Flag "dshow-passes"
1510          (NoArg (do forceRecompile
1511                     setVerbosity (Just 2)))
1512          Supported
1513   , Flag "dfaststring-stats"       (NoArg (setDynFlag Opt_D_faststring_stats))
1514          Supported
1515
1516         ------ Machine dependant (-m<blah>) stuff ---------------------------
1517
1518   , Flag "monly-2-regs" (NoArg (upd (\s -> s{stolen_x86_regs = 2}) ))
1519          Supported
1520   , Flag "monly-3-regs" (NoArg (upd (\s -> s{stolen_x86_regs = 3}) ))
1521          Supported
1522   , Flag "monly-4-regs" (NoArg (upd (\s -> s{stolen_x86_regs = 4}) ))
1523          Supported
1524
1525      ------ Warning opts -------------------------------------------------
1526   , Flag "W"      (NoArg (mapM_ setDynFlag   minusWOpts))
1527          Supported
1528   , Flag "Werror" (NoArg (setDynFlag         Opt_WarnIsError))
1529          Supported
1530   , Flag "Wwarn"  (NoArg (unSetDynFlag       Opt_WarnIsError))
1531          Supported
1532   , Flag "Wall"   (NoArg (mapM_ setDynFlag   minusWallOpts))
1533          Supported
1534   , Flag "Wnot"   (NoArg (mapM_ unSetDynFlag minusWallOpts))
1535          (Deprecated "Use -w instead")
1536   , Flag "w"      (NoArg (mapM_ unSetDynFlag minuswRemovesOpts))
1537          Supported
1538
1539         ------ Optimisation flags ------------------------------------------
1540   , Flag "O"      (NoArg (upd (setOptLevel 1))) Supported
1541   , Flag "Onot"   (NoArg (upd (setOptLevel 0)))
1542          (Deprecated "Use -O0 instead")
1543   , Flag "Odph"   (NoArg (upd setDPHOpt)) Supported
1544   , Flag "O"      (OptIntSuffix (\mb_n -> upd (setOptLevel (mb_n `orElse` 1))))
1545          Supported
1546                 -- If the number is missing, use 1
1547
1548   , Flag "fsimplifier-phases"
1549          (IntSuffix (\n -> upd (\dfs -> dfs{ simplPhases = n })))
1550          Supported
1551   , Flag "fmax-simplifier-iterations"
1552          (IntSuffix (\n -> upd (\dfs -> dfs{ maxSimplIterations = n })))
1553          Supported
1554
1555   , Flag "fspec-constr-threshold"
1556          (IntSuffix (\n -> upd (\dfs -> dfs{ specConstrThreshold = Just n })))
1557          Supported
1558   , Flag "fno-spec-constr-threshold"
1559          (NoArg (upd (\dfs -> dfs{ specConstrThreshold = Nothing })))
1560          Supported
1561   , Flag "fspec-constr-count"
1562          (IntSuffix (\n -> upd (\dfs -> dfs{ specConstrCount = Just n })))
1563          Supported
1564   , Flag "fno-spec-constr-count"
1565          (NoArg (upd (\dfs -> dfs{ specConstrCount = Nothing })))
1566          Supported
1567   , Flag "fliberate-case-threshold"
1568          (IntSuffix (\n -> upd (\dfs -> dfs{ liberateCaseThreshold = Just n })))
1569          Supported
1570   , Flag "fno-liberate-case-threshold"
1571          (NoArg (upd (\dfs -> dfs{ liberateCaseThreshold = Nothing })))
1572          Supported
1573
1574   , Flag "frule-check"
1575          (SepArg (\s -> upd (\dfs -> dfs{ ruleCheck = Just s })))
1576          Supported
1577   , Flag "fcontext-stack"
1578          (IntSuffix $ \n -> upd $ \dfs -> dfs{ ctxtStkDepth = n })
1579          Supported
1580
1581   , Flag "fstrictness-before"
1582          (IntSuffix (\n -> upd (\dfs -> dfs{ strictnessBefore = n : strictnessBefore dfs })))
1583          Supported
1584
1585         ------ Profiling ----------------------------------------------------
1586
1587   -- XXX Should the -f* flags be deprecated?
1588   -- They don't seem to be documented
1589   , Flag "fauto-sccs-on-all-toplevs"
1590          (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1591          Supported
1592   , Flag "auto-all"
1593          (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1594          Supported
1595   , Flag "no-auto-all"
1596          (NoArg (unSetDynFlag Opt_AutoSccsOnAllToplevs))
1597          Supported
1598   , Flag "fauto-sccs-on-exported-toplevs"
1599          (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1600          Supported
1601   , Flag "auto"
1602          (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1603          Supported
1604   , Flag "no-auto"
1605          (NoArg (unSetDynFlag Opt_AutoSccsOnExportedToplevs))
1606          Supported
1607   , Flag "fauto-sccs-on-individual-cafs"
1608          (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1609          Supported
1610   , Flag "caf-all"
1611          (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1612          Supported
1613   , Flag "no-caf-all"
1614          (NoArg (unSetDynFlag Opt_AutoSccsOnIndividualCafs))
1615          Supported
1616
1617         ------ DPH flags ----------------------------------------------------
1618
1619   , Flag "fdph-seq"
1620          (NoArg (setDPHBackend DPHSeq))
1621          Supported
1622   , Flag "fdph-par"
1623          (NoArg (setDPHBackend DPHPar))
1624          Supported
1625   , Flag "fdph-this"
1626          (NoArg (setDPHBackend DPHThis))
1627          Supported
1628
1629         ------ Compiler flags -----------------------------------------------
1630
1631   , Flag "fasm"             (NoArg (setObjTarget HscAsm)) Supported
1632   , Flag "fvia-c"           (NoArg (setObjTarget HscC)) Supported
1633   , Flag "fvia-C"           (NoArg (setObjTarget HscC)) Supported
1634
1635   , Flag "fno-code"         (NoArg (setTarget HscNothing)) Supported
1636   , Flag "fbyte-code"       (NoArg (setTarget HscInterpreted)) Supported
1637   , Flag "fobject-code"     (NoArg (setTarget defaultHscTarget)) Supported
1638
1639   , Flag "fglasgow-exts"    (NoArg (mapM_ setDynFlag   glasgowExtsFlags))
1640          Supported
1641   , Flag "fno-glasgow-exts" (NoArg (mapM_ unSetDynFlag glasgowExtsFlags))
1642          Supported
1643  ]
1644  ++ map (mkFlag True  "f"    setDynFlag  ) fFlags
1645  ++ map (mkFlag False "fno-" unSetDynFlag) fFlags
1646  ++ map (mkFlag True  "X"    setDynFlag  ) xFlags
1647  ++ map (mkFlag False "XNo"  unSetDynFlag) xFlags
1648
1649 package_flags :: [Flag DynP]
1650 package_flags = [
1651         ------- Packages ----------------------------------------------------
1652     Flag "package-conf"   (HasArg extraPkgConf_) Supported
1653   , Flag "no-user-package-conf" (NoArg (unSetDynFlag Opt_ReadUserPackageConf))
1654          Supported
1655   , Flag "package-name"   (HasArg (upd . setPackageName)) Supported
1656   , Flag "package-id"     (HasArg exposePackageId) Supported
1657   , Flag "package"        (HasArg exposePackage) Supported
1658   , Flag "hide-package"   (HasArg hidePackage) Supported
1659   , Flag "hide-all-packages" (NoArg (setDynFlag Opt_HideAllPackages))
1660          Supported
1661   , Flag "ignore-package" (HasArg ignorePackage)
1662          Supported
1663   , Flag "syslib"         (HasArg exposePackage)
1664          (Deprecated "Use -package instead")
1665   ]
1666
1667 mkFlag :: Bool                  -- ^ True <=> it should be turned on
1668        -> String                -- ^ The flag prefix
1669        -> (DynFlag -> DynP ())
1670        -> (String, DynFlag, Bool -> Deprecated)
1671        -> Flag DynP
1672 mkFlag turnOn flagPrefix f (name, dynflag, deprecated)
1673     = Flag (flagPrefix ++ name) (NoArg (f dynflag)) (deprecated turnOn)
1674
1675 deprecatedForLanguage :: String -> Bool -> Deprecated
1676 deprecatedForLanguage lang turn_on
1677     = Deprecated ("use -X"  ++ flag ++ " or pragma {-# LANGUAGE " ++ flag ++ " #-} instead")
1678     where
1679       flag | turn_on    = lang
1680            | otherwise = "No"++lang
1681
1682 useInstead :: String -> Bool -> Deprecated
1683 useInstead flag turn_on
1684   = Deprecated ("Use -f" ++ no ++ flag ++ " instead")
1685   where
1686     no = if turn_on then "" else "no-"
1687
1688 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
1689 fFlags :: [(String, DynFlag, Bool -> Deprecated)]
1690 fFlags = [
1691   ( "warn-dodgy-foreign-imports",       Opt_WarnDodgyForeignImports, const Supported ),
1692   ( "warn-dodgy-exports",               Opt_WarnDodgyExports, const Supported ),
1693   ( "warn-dodgy-imports",               Opt_WarnDodgyImports, const Supported ),
1694   ( "warn-duplicate-exports",           Opt_WarnDuplicateExports, const Supported ),
1695   ( "warn-hi-shadowing",                Opt_WarnHiShadows, const Supported ),
1696   ( "warn-implicit-prelude",            Opt_WarnImplicitPrelude, const Supported ),
1697   ( "warn-incomplete-patterns",         Opt_WarnIncompletePatterns, const Supported ),
1698   ( "warn-incomplete-record-updates",   Opt_WarnIncompletePatternsRecUpd, const Supported ),
1699   ( "warn-missing-fields",              Opt_WarnMissingFields, const Supported ),
1700   ( "warn-missing-methods",             Opt_WarnMissingMethods, const Supported ),
1701   ( "warn-missing-signatures",          Opt_WarnMissingSigs, const Supported ),
1702   ( "warn-name-shadowing",              Opt_WarnNameShadowing, const Supported ),
1703   ( "warn-overlapping-patterns",        Opt_WarnOverlappingPatterns, const Supported ),
1704   ( "warn-simple-patterns",             Opt_WarnSimplePatterns, const Supported ),
1705   ( "warn-type-defaults",               Opt_WarnTypeDefaults, const Supported ),
1706   ( "warn-monomorphism-restriction",    Opt_WarnMonomorphism, const Supported ),
1707   ( "warn-unused-binds",                Opt_WarnUnusedBinds, const Supported ),
1708   ( "warn-unused-imports",              Opt_WarnUnusedImports, const Supported ),
1709   ( "warn-unused-matches",              Opt_WarnUnusedMatches, const Supported ),
1710   ( "warn-warnings-deprecations",       Opt_WarnWarningsDeprecations, const Supported ),
1711   ( "warn-deprecations",                Opt_WarnWarningsDeprecations, const Supported ),
1712   ( "warn-deprecated-flags",            Opt_WarnDeprecatedFlags, const Supported ),
1713   ( "warn-orphans",                     Opt_WarnOrphans, const Supported ),
1714   ( "warn-tabs",                        Opt_WarnTabs, const Supported ),
1715   ( "warn-unrecognised-pragmas",        Opt_WarnUnrecognisedPragmas, const Supported ),
1716   ( "warn-lazy-unlifted-bindings",      Opt_WarnLazyUnliftedBindings,
1717     const $ Deprecated "lazy unlifted bindings will be an error in GHC 6.14, and this flag will no longer exist"),
1718   ( "warn-unused-do-bind",              Opt_WarnUnusedDoBind, const Supported ),
1719   ( "warn-wrong-do-bind",               Opt_WarnWrongDoBind, const Supported ),
1720   ( "print-explicit-foralls",           Opt_PrintExplicitForalls, const Supported ),
1721   ( "strictness",                       Opt_Strictness, const Supported ),
1722   ( "specialise",                       Opt_Specialise, const Supported ),
1723   ( "float-in",                         Opt_FloatIn, const Supported ),
1724   ( "static-argument-transformation",   Opt_StaticArgumentTransformation, const Supported ),
1725   ( "full-laziness",                    Opt_FullLaziness, const Supported ),
1726   ( "liberate-case",                    Opt_LiberateCase, const Supported ),
1727   ( "spec-constr",                      Opt_SpecConstr, const Supported ),
1728   ( "cse",                              Opt_CSE, const Supported ),
1729   ( "ignore-interface-pragmas",         Opt_IgnoreInterfacePragmas, const Supported ),
1730   ( "omit-interface-pragmas",           Opt_OmitInterfacePragmas, const Supported ),
1731   ( "do-lambda-eta-expansion",          Opt_DoLambdaEtaExpansion, const Supported ),
1732   ( "ignore-asserts",                   Opt_IgnoreAsserts, const Supported ),
1733   ( "do-eta-reduction",                 Opt_DoEtaReduction, const Supported ),
1734   ( "case-merge",                       Opt_CaseMerge, const Supported ),
1735   ( "unbox-strict-fields",              Opt_UnboxStrictFields, const Supported ),
1736   ( "method-sharing",                   Opt_MethodSharing, const Supported ),
1737   ( "dicts-cheap",                      Opt_DictsCheap, const Supported ),
1738   ( "excess-precision",                 Opt_ExcessPrecision, const Supported ),
1739   ( "eager-blackholing",                Opt_EagerBlackHoling, const Supported ),
1740   ( "asm-mangling",                     Opt_DoAsmMangling, const Supported ),
1741   ( "print-bind-result",                Opt_PrintBindResult, const Supported ),
1742   ( "force-recomp",                     Opt_ForceRecomp, const Supported ),
1743   ( "hpc-no-auto",                      Opt_Hpc_No_Auto, const Supported ),
1744   ( "rewrite-rules",                    Opt_EnableRewriteRules, useInstead "enable-rewrite-rules" ),
1745   ( "enable-rewrite-rules",             Opt_EnableRewriteRules, const Supported ),
1746   ( "break-on-exception",               Opt_BreakOnException, const Supported ),
1747   ( "break-on-error",                   Opt_BreakOnError, const Supported ),
1748   ( "print-evld-with-show",             Opt_PrintEvldWithShow, const Supported ),
1749   ( "print-bind-contents",              Opt_PrintBindContents, const Supported ),
1750   ( "run-cps",                          Opt_RunCPS, const Supported ),
1751   ( "run-cpsz",                         Opt_RunCPSZ, const Supported ),
1752   ( "new-codegen",                      Opt_TryNewCodeGen, const Supported ),
1753   ( "convert-to-zipper-and-back",       Opt_ConvertToZipCfgAndBack, const Supported ),
1754   ( "vectorise",                        Opt_Vectorise, const Supported ),
1755   ( "regs-graph",                       Opt_RegsGraph, const Supported ),
1756   ( "regs-iterative",                   Opt_RegsIterative, const Supported ),
1757   ( "th",                               Opt_TemplateHaskell,
1758     deprecatedForLanguage "TemplateHaskell" ),
1759   ( "fi",                               Opt_ForeignFunctionInterface,
1760     deprecatedForLanguage "ForeignFunctionInterface" ),
1761   ( "ffi",                              Opt_ForeignFunctionInterface,
1762     deprecatedForLanguage "ForeignFunctionInterface" ),
1763   ( "arrows",                           Opt_Arrows,
1764     deprecatedForLanguage "Arrows" ),
1765   ( "generics",                         Opt_Generics,
1766     deprecatedForLanguage "Generics" ),
1767   ( "implicit-prelude",                 Opt_ImplicitPrelude,
1768     deprecatedForLanguage "ImplicitPrelude" ),
1769   ( "bang-patterns",                    Opt_BangPatterns,
1770     deprecatedForLanguage "BangPatterns" ),
1771   ( "monomorphism-restriction",         Opt_MonomorphismRestriction,
1772     deprecatedForLanguage "MonomorphismRestriction" ),
1773   ( "mono-pat-binds",                   Opt_MonoPatBinds,
1774     deprecatedForLanguage "MonoPatBinds" ),
1775   ( "extended-default-rules",           Opt_ExtendedDefaultRules,
1776     deprecatedForLanguage "ExtendedDefaultRules" ),
1777   ( "implicit-params",                  Opt_ImplicitParams,
1778     deprecatedForLanguage "ImplicitParams" ),
1779   ( "scoped-type-variables",            Opt_ScopedTypeVariables,
1780     deprecatedForLanguage "ScopedTypeVariables" ),
1781   ( "parr",                             Opt_PArr,
1782     deprecatedForLanguage "PArr" ),
1783   ( "allow-overlapping-instances",      Opt_OverlappingInstances,
1784     deprecatedForLanguage "OverlappingInstances" ),
1785   ( "allow-undecidable-instances",      Opt_UndecidableInstances,
1786     deprecatedForLanguage "UndecidableInstances" ),
1787   ( "allow-incoherent-instances",       Opt_IncoherentInstances,
1788     deprecatedForLanguage "IncoherentInstances" ),
1789   ( "gen-manifest",                     Opt_GenManifest, const Supported ),
1790   ( "embed-manifest",                   Opt_EmbedManifest, const Supported ),
1791   ( "ext-core",                         Opt_EmitExternalCore, const Supported ),
1792   ( "shared-implib",                    Opt_SharedImplib, const Supported ),
1793   ( "building-cabal-package",           Opt_BuildingCabalPackage, const Supported ),
1794   ( "implicit-import-qualified",        Opt_ImplicitImportQualified, const Supported )
1795   ]
1796
1797 supportedLanguages :: [String]
1798 supportedLanguages = [ name | (name, _, _) <- xFlags ]
1799
1800 -- This may contain duplicates
1801 languageOptions :: [DynFlag]
1802 languageOptions = [ dynFlag | (_, dynFlag, _) <- xFlags ]
1803
1804 -- | These -X<blah> flags can all be reversed with -XNo<blah>
1805 xFlags :: [(String, DynFlag, Bool -> Deprecated)]
1806 xFlags = [
1807   ( "CPP",                              Opt_Cpp, const Supported ),
1808   ( "PostfixOperators",                 Opt_PostfixOperators, const Supported ),
1809   ( "TupleSections",                    Opt_TupleSections, const Supported ),
1810   ( "PatternGuards",                    Opt_PatternGuards, const Supported ),
1811   ( "UnicodeSyntax",                    Opt_UnicodeSyntax, const Supported ),
1812   ( "MagicHash",                        Opt_MagicHash, const Supported ),
1813   ( "PolymorphicComponents",            Opt_PolymorphicComponents, const Supported ),
1814   ( "ExistentialQuantification",        Opt_ExistentialQuantification, const Supported ),
1815   ( "KindSignatures",                   Opt_KindSignatures, const Supported ),
1816   ( "EmptyDataDecls",                   Opt_EmptyDataDecls, const Supported ),
1817   ( "ParallelListComp",                 Opt_ParallelListComp, const Supported ),
1818   ( "TransformListComp",                Opt_TransformListComp, const Supported ),
1819   ( "ForeignFunctionInterface",         Opt_ForeignFunctionInterface, const Supported ),
1820   ( "UnliftedFFITypes",                 Opt_UnliftedFFITypes, const Supported ),
1821   ( "GHCForeignImportPrim",             Opt_GHCForeignImportPrim, const Supported ),
1822   ( "LiberalTypeSynonyms",              Opt_LiberalTypeSynonyms, const Supported ),
1823   ( "Rank2Types",                       Opt_Rank2Types, const Supported ),
1824   ( "RankNTypes",                       Opt_RankNTypes, const Supported ),
1825   ( "ImpredicativeTypes",               Opt_ImpredicativeTypes,
1826         const $ Deprecated "impredicative polymorphism will be simplified or removed in GHC 6.14" ),
1827   ( "TypeOperators",                    Opt_TypeOperators, const Supported ),
1828   ( "RecursiveDo",                      Opt_RecursiveDo,
1829     deprecatedForLanguage "DoRec"),
1830   ( "DoRec",                            Opt_DoRec, const Supported ),
1831   ( "Arrows",                           Opt_Arrows, const Supported ),
1832   ( "PArr",                             Opt_PArr, const Supported ),
1833   ( "TemplateHaskell",                  Opt_TemplateHaskell, const Supported ),
1834   ( "QuasiQuotes",                      Opt_QuasiQuotes, const Supported ),
1835   ( "Generics",                         Opt_Generics, const Supported ),
1836   -- On by default:
1837   ( "ImplicitPrelude",                  Opt_ImplicitPrelude, const Supported ),
1838   ( "RecordWildCards",                  Opt_RecordWildCards, const Supported ),
1839   ( "NamedFieldPuns",                   Opt_RecordPuns, const Supported ),
1840   ( "RecordPuns",                       Opt_RecordPuns,
1841     deprecatedForLanguage "NamedFieldPuns" ),
1842   ( "DisambiguateRecordFields",         Opt_DisambiguateRecordFields, const Supported ),
1843   ( "OverloadedStrings",                Opt_OverloadedStrings, const Supported ),
1844   ( "GADTs",                            Opt_GADTs, const Supported ),
1845   ( "ViewPatterns",                     Opt_ViewPatterns, const Supported ),
1846   ( "TypeFamilies",                     Opt_TypeFamilies, const Supported ),
1847   ( "BangPatterns",                     Opt_BangPatterns, const Supported ),
1848   -- On by default:
1849   ( "MonomorphismRestriction",          Opt_MonomorphismRestriction, const Supported ),
1850   -- On by default:
1851   ( "NPlusKPatterns",                   Opt_NPlusKPatterns, const Supported ),
1852   -- On by default (which is not strictly H98):
1853   ( "MonoPatBinds",                     Opt_MonoPatBinds, const Supported ),
1854   ( "ExplicitForAll",                   Opt_ExplicitForAll, const Supported ),
1855   ( "MonoLocalBinds",                   Opt_MonoLocalBinds, const Supported ),
1856   ( "RelaxedPolyRec",                   Opt_RelaxedPolyRec, const Supported ),
1857   ( "ExtendedDefaultRules",             Opt_ExtendedDefaultRules, const Supported ),
1858   ( "ImplicitParams",                   Opt_ImplicitParams, const Supported ),
1859   ( "ScopedTypeVariables",              Opt_ScopedTypeVariables, const Supported ),
1860
1861   ( "PatternSignatures",                Opt_ScopedTypeVariables,
1862     deprecatedForLanguage "ScopedTypeVariables" ),
1863
1864   ( "UnboxedTuples",                    Opt_UnboxedTuples, const Supported ),
1865   ( "StandaloneDeriving",               Opt_StandaloneDeriving, const Supported ),
1866   ( "DeriveDataTypeable",               Opt_DeriveDataTypeable, const Supported ),
1867   ( "DeriveFunctor",                    Opt_DeriveFunctor, const Supported ),
1868   ( "DeriveTraversable",                Opt_DeriveTraversable, const Supported ),
1869   ( "DeriveFoldable",                   Opt_DeriveFoldable, const Supported ),
1870   ( "TypeSynonymInstances",             Opt_TypeSynonymInstances, const Supported ),
1871   ( "FlexibleContexts",                 Opt_FlexibleContexts, const Supported ),
1872   ( "FlexibleInstances",                Opt_FlexibleInstances, const Supported ),
1873   ( "ConstrainedClassMethods",          Opt_ConstrainedClassMethods, const Supported ),
1874   ( "MultiParamTypeClasses",            Opt_MultiParamTypeClasses, const Supported ),
1875   ( "FunctionalDependencies",           Opt_FunctionalDependencies, const Supported ),
1876   ( "GeneralizedNewtypeDeriving",       Opt_GeneralizedNewtypeDeriving, const Supported ),
1877   ( "OverlappingInstances",             Opt_OverlappingInstances, const Supported ),
1878   ( "UndecidableInstances",             Opt_UndecidableInstances, const Supported ),
1879   ( "IncoherentInstances",              Opt_IncoherentInstances, const Supported ),
1880   ( "PackageImports",                   Opt_PackageImports, const Supported ),
1881   ( "NewQualifiedOperators",            Opt_NewQualifiedOperators, const Supported )
1882   ]
1883
1884 impliedFlags :: [(DynFlag, DynFlag)]
1885 impliedFlags
1886   = [ (Opt_RankNTypes,                Opt_ExplicitForAll)
1887     , (Opt_Rank2Types,                Opt_ExplicitForAll)
1888     , (Opt_ScopedTypeVariables,       Opt_ExplicitForAll)
1889     , (Opt_LiberalTypeSynonyms,       Opt_ExplicitForAll)
1890     , (Opt_ExistentialQuantification, Opt_ExplicitForAll)
1891     , (Opt_PolymorphicComponents,     Opt_ExplicitForAll)
1892
1893     , (Opt_GADTs,               Opt_RelaxedPolyRec)  -- We want type-sig variables to
1894                                                      --      be completely rigid for GADTs
1895
1896     , (Opt_TypeFamilies,        Opt_RelaxedPolyRec)  -- Trac #2944 gives a nice example
1897     , (Opt_TypeFamilies,        Opt_KindSignatures)  -- Type families use kind signatures
1898                                                      -- all over the place
1899
1900     , (Opt_ScopedTypeVariables, Opt_RelaxedPolyRec)  -- Ditto for scoped type variables; see
1901                                                      --      Note [Scoped tyvars] in TcBinds
1902     , (Opt_ImpredicativeTypes,  Opt_RankNTypes)
1903
1904         -- Record wild-cards implies field disambiguation
1905         -- Otherwise if you write (C {..}) you may well get
1906         -- stuff like " 'a' not in scope ", which is a bit silly
1907         -- if the compiler has just filled in field 'a' of constructor 'C'
1908     , (Opt_RecordWildCards,     Opt_DisambiguateRecordFields)
1909   ]
1910
1911 glasgowExtsFlags :: [DynFlag]
1912 glasgowExtsFlags = [
1913              Opt_PrintExplicitForalls
1914            , Opt_ForeignFunctionInterface
1915            , Opt_UnliftedFFITypes
1916            , Opt_GADTs
1917            , Opt_ImplicitParams
1918            , Opt_ScopedTypeVariables
1919            , Opt_UnboxedTuples
1920            , Opt_TypeSynonymInstances
1921            , Opt_StandaloneDeriving
1922            , Opt_DeriveDataTypeable
1923            , Opt_DeriveFunctor
1924            , Opt_DeriveFoldable
1925            , Opt_DeriveTraversable
1926            , Opt_FlexibleContexts
1927            , Opt_FlexibleInstances
1928            , Opt_ConstrainedClassMethods
1929            , Opt_MultiParamTypeClasses
1930            , Opt_FunctionalDependencies
1931            , Opt_MagicHash
1932            , Opt_PolymorphicComponents
1933            , Opt_ExistentialQuantification
1934            , Opt_UnicodeSyntax
1935            , Opt_PostfixOperators
1936            , Opt_PatternGuards
1937            , Opt_LiberalTypeSynonyms
1938            , Opt_RankNTypes
1939            , Opt_TypeOperators
1940            , Opt_DoRec
1941            , Opt_ParallelListComp
1942            , Opt_EmptyDataDecls
1943            , Opt_KindSignatures
1944            , Opt_GeneralizedNewtypeDeriving
1945            , Opt_TypeFamilies ]
1946
1947 -- -----------------------------------------------------------------------------
1948 -- Parsing the dynamic flags.
1949
1950 -- | Parse dynamic flags from a list of command line arguments.  Returns the
1951 -- the parsed 'DynFlags', the left-over arguments, and a list of warnings.
1952 -- Throws a 'UsageError' if errors occurred during parsing (such as unknown
1953 -- flags or missing arguments).
1954 parseDynamicFlags :: Monad m =>
1955                      DynFlags -> [Located String]
1956                   -> m (DynFlags, [Located String], [Located String])
1957                      -- ^ Updated 'DynFlags', left-over arguments, and
1958                      -- list of warnings.
1959 parseDynamicFlags dflags args = parseDynamicFlags_ dflags args True
1960
1961 -- | Like 'parseDynamicFlags' but does not allow the package flags (-package,
1962 -- -hide-package, -ignore-package, -hide-all-packages, -package-conf).
1963 parseDynamicNoPackageFlags :: Monad m =>
1964                      DynFlags -> [Located String]
1965                   -> m (DynFlags, [Located String], [Located String])
1966                      -- ^ Updated 'DynFlags', left-over arguments, and
1967                      -- list of warnings.
1968 parseDynamicNoPackageFlags dflags args = parseDynamicFlags_ dflags args False
1969
1970 parseDynamicFlags_ :: Monad m =>
1971                       DynFlags -> [Located String] -> Bool
1972                   -> m (DynFlags, [Located String], [Located String])
1973 parseDynamicFlags_ dflags0 args pkg_flags = do
1974   -- XXX Legacy support code
1975   -- We used to accept things like
1976   --     optdep-f  -optdepdepend
1977   --     optdep-f  -optdep depend
1978   --     optdep -f -optdepdepend
1979   --     optdep -f -optdep depend
1980   -- but the spaces trip up proper argument handling. So get rid of them.
1981   let f (L p "-optdep" : L _ x : xs) = (L p ("-optdep" ++ x)) : f xs
1982       f (x : xs) = x : f xs
1983       f xs = xs
1984       args' = f args
1985
1986       -- Note: -ignore-package (package_flags) must precede -i* (dynamic_flags)
1987       flag_spec | pkg_flags = package_flags ++ dynamic_flags
1988                 | otherwise = dynamic_flags
1989
1990   let ((leftover, errs, warns), dflags1)
1991           = runCmdLine (processArgs flag_spec args') dflags0
1992   when (not (null errs)) $ ghcError $ errorsToGhcException errs
1993
1994   -- Cannot use -fPIC with registerised -fvia-C, because the mangler
1995   -- isn't up to the job.  We know that if hscTarget == HscC, then the
1996   -- user has explicitly used -fvia-C, because -fasm is the default,
1997   -- unless there is no NCG on this platform.  The latter case is
1998   -- checked when the -fPIC flag is parsed.
1999   --
2000   let (pic_warns, dflags2) =
2001         if opt_PIC && hscTarget dflags1 == HscC && cGhcUnregisterised == "NO"
2002           then ([L noSrcSpan $ "Warning: -fvia-C is incompatible with -fPIC; ignoring -fvia-C"],
2003                 dflags1{ hscTarget = HscAsm })
2004           else ([], dflags1)
2005
2006   return (dflags2, leftover, pic_warns ++ warns)
2007
2008 type DynP = CmdLineP DynFlags
2009
2010 upd :: (DynFlags -> DynFlags) -> DynP ()
2011 upd f = do
2012    dfs <- getCmdLineState
2013    putCmdLineState $! (f dfs)
2014
2015 --------------------------
2016 setDynFlag, unSetDynFlag :: DynFlag -> DynP ()
2017 setDynFlag f = do { upd (\dfs -> dopt_set dfs f)
2018                   ; mapM_ setDynFlag deps }
2019   where
2020     deps = [ d | (f', d) <- impliedFlags, f' == f ]
2021         -- When you set f, set the ones it implies
2022         -- NB: use setDynFlag recursively, in case the implied flags
2023         --     implies further flags
2024         -- When you un-set f, however, we don't un-set the things it implies
2025         --      (except for -fno-glasgow-exts, which is treated specially)
2026
2027 unSetDynFlag f = upd (\dfs -> dopt_unset dfs f)
2028
2029 --------------------------
2030 setDumpFlag :: DynFlag -> OptKind DynP
2031 setDumpFlag dump_flag
2032   = NoArg (do { setDynFlag dump_flag
2033               ; when want_recomp forceRecompile })
2034   where
2035         -- Certain dumpy-things are really interested in what's going
2036         -- on during recompilation checking, so in those cases we
2037         -- don't want to turn it off.
2038     want_recomp = dump_flag `notElem` [Opt_D_dump_if_trace,
2039                                        Opt_D_dump_hi_diffs]
2040
2041 forceRecompile :: DynP ()
2042 -- Whenver we -ddump, force recompilation (by switching off the
2043 -- recompilation checker), else you don't see the dump! However,
2044 -- don't switch it off in --make mode, else *everything* gets
2045 -- recompiled which probably isn't what you want
2046 forceRecompile = do { dfs <- getCmdLineState
2047                     ; when (force_recomp dfs) (setDynFlag Opt_ForceRecomp) }
2048         where
2049           force_recomp dfs = isOneShot (ghcMode dfs)
2050
2051 setVerboseCore2Core :: DynP ()
2052 setVerboseCore2Core = do setDynFlag Opt_D_verbose_core2core
2053                          forceRecompile
2054                          upd (\s -> s { shouldDumpSimplPhase = const True })
2055
2056 setDumpSimplPhases :: String -> DynP ()
2057 setDumpSimplPhases s = do forceRecompile
2058                           upd (\s -> s { shouldDumpSimplPhase = spec })
2059   where
2060     spec :: SimplifierMode -> Bool
2061     spec = join (||)
2062          . map (join (&&) . map match . split ':')
2063          . split ','
2064          $ case s of
2065              '=' : s' -> s'
2066              _        -> s
2067
2068     join :: (Bool -> Bool -> Bool)
2069          -> [SimplifierMode -> Bool]
2070          -> SimplifierMode -> Bool
2071     join _  [] = const True
2072     join op ss = foldr1 (\f g x -> f x `op` g x) ss
2073
2074     match :: String -> SimplifierMode -> Bool
2075     match "" = const True
2076     match s  = case reads s of
2077                 [(n,"")] -> phase_num  n
2078                 _        -> phase_name s
2079
2080     phase_num :: Int -> SimplifierMode -> Bool
2081     phase_num n (SimplPhase k _) = n == k
2082     phase_num _ _                = False
2083
2084     phase_name :: String -> SimplifierMode -> Bool
2085     phase_name s (SimplGently {})               = s == "gentle"
2086     phase_name s (SimplPhase { sm_names = ss }) = s `elem` ss
2087
2088 setVerbosity :: Maybe Int -> DynP ()
2089 setVerbosity mb_n = upd (\dfs -> dfs{ verbosity = mb_n `orElse` 3 })
2090
2091 addCmdlineHCInclude :: String -> DynP ()
2092 addCmdlineHCInclude a = upd (\s -> s{cmdlineHcIncludes =  a : cmdlineHcIncludes s})
2093
2094 extraPkgConf_ :: FilePath -> DynP ()
2095 extraPkgConf_  p = upd (\s -> s{ extraPkgConfs = p : extraPkgConfs s })
2096
2097 exposePackage, exposePackageId, hidePackage, ignorePackage :: String -> DynP ()
2098 exposePackage p =
2099   upd (\s -> s{ packageFlags = ExposePackage p : packageFlags s })
2100 exposePackageId p =
2101   upd (\s -> s{ packageFlags = ExposePackageId p : packageFlags s })
2102 hidePackage p =
2103   upd (\s -> s{ packageFlags = HidePackage p : packageFlags s })
2104 ignorePackage p =
2105   upd (\s -> s{ packageFlags = IgnorePackage p : packageFlags s })
2106
2107 setPackageName :: String -> DynFlags -> DynFlags
2108 setPackageName p s =  s{ thisPackage = stringToPackageId p }
2109
2110 -- If we're linking a binary, then only targets that produce object
2111 -- code are allowed (requests for other target types are ignored).
2112 setTarget :: HscTarget -> DynP ()
2113 setTarget l = upd set
2114   where
2115    set dfs
2116      | ghcLink dfs /= LinkBinary || isObjectTarget l  = dfs{ hscTarget = l }
2117      | otherwise = dfs
2118
2119 -- Changes the target only if we're compiling object code.  This is
2120 -- used by -fasm and -fvia-C, which switch from one to the other, but
2121 -- not from bytecode to object-code.  The idea is that -fasm/-fvia-C
2122 -- can be safely used in an OPTIONS_GHC pragma.
2123 setObjTarget :: HscTarget -> DynP ()
2124 setObjTarget l = upd set
2125   where
2126    set dfs
2127      | isObjectTarget (hscTarget dfs) = dfs { hscTarget = l }
2128      | otherwise = dfs
2129
2130 setOptLevel :: Int -> DynFlags -> DynFlags
2131 setOptLevel n dflags
2132    | hscTarget dflags == HscInterpreted && n > 0
2133         = dflags
2134             -- not in IO any more, oh well:
2135             -- putStr "warning: -O conflicts with --interactive; -O ignored.\n"
2136    | otherwise
2137         = updOptLevel n dflags
2138
2139
2140 -- -Odph is equivalent to
2141 --
2142 --    -O2                               optimise as much as possible
2143 --    -fno-method-sharing               sharing specialisation defeats fusion
2144 --                                      sometimes
2145 --    -fdicts-cheap                     always inline dictionaries
2146 --    -fmax-simplifier-iterations20     this is necessary sometimes
2147 --    -fsimplifier-phases=3             we use an additional simplifier phase
2148 --                                      for fusion
2149 --    -fno-spec-constr-threshold        run SpecConstr even for big loops
2150 --    -fno-spec-constr-count            SpecConstr as much as possible
2151 --    -finline-enough-args              hack to prevent excessive inlining
2152 --
2153 setDPHOpt :: DynFlags -> DynFlags
2154 setDPHOpt dflags = setOptLevel 2 (dflags { maxSimplIterations  = 20
2155                                          , simplPhases         = 3
2156                                          , specConstrThreshold = Nothing
2157                                          , specConstrCount     = Nothing
2158                                          })
2159                    `dopt_set`   Opt_DictsCheap
2160                    `dopt_unset` Opt_MethodSharing
2161
2162 data DPHBackend = DPHPar
2163                 | DPHSeq
2164                 | DPHThis
2165         deriving(Eq, Ord, Enum, Show)
2166
2167 setDPHBackend :: DPHBackend -> DynP ()
2168 setDPHBackend backend
2169   = do
2170       upd $ \dflags -> dflags { dphBackend = backend }
2171       mapM_ exposePackage (dph_packages backend)
2172   where
2173     dph_packages DPHThis = []
2174     dph_packages DPHPar  = ["dph-prim-par", "dph-par"]
2175     dph_packages DPHSeq  = ["dph-prim-seq", "dph-seq"]
2176
2177 dphPackage :: DynFlags -> PackageId
2178 dphPackage dflags = case dphBackend dflags of
2179                       DPHPar  -> dphParPackageId
2180                       DPHSeq  -> dphSeqPackageId
2181                       DPHThis -> thisPackage dflags
2182
2183 setMainIs :: String -> DynP ()
2184 setMainIs arg
2185   | not (null main_fn) && isLower (head main_fn)
2186      -- The arg looked like "Foo.Bar.baz"
2187   = upd $ \d -> d{ mainFunIs = Just main_fn,
2188                    mainModIs = mkModule mainPackageId (mkModuleName main_mod) }
2189
2190   | isUpper (head arg)  -- The arg looked like "Foo" or "Foo.Bar"
2191   = upd $ \d -> d{ mainModIs = mkModule mainPackageId (mkModuleName arg) }
2192
2193   | otherwise                   -- The arg looked like "baz"
2194   = upd $ \d -> d{ mainFunIs = Just arg }
2195   where
2196     (main_mod, main_fn) = splitLongestPrefix arg (== '.')
2197
2198 -----------------------------------------------------------------------------
2199 -- Paths & Libraries
2200
2201 addImportPath, addLibraryPath, addIncludePath, addFrameworkPath :: FilePath -> DynP ()
2202
2203 -- -i on its own deletes the import paths
2204 addImportPath "" = upd (\s -> s{importPaths = []})
2205 addImportPath p  = upd (\s -> s{importPaths = importPaths s ++ splitPathList p})
2206
2207
2208 addLibraryPath p =
2209   upd (\s -> s{libraryPaths = libraryPaths s ++ splitPathList p})
2210
2211 addIncludePath p =
2212   upd (\s -> s{includePaths = includePaths s ++ splitPathList p})
2213
2214 addFrameworkPath p =
2215   upd (\s -> s{frameworkPaths = frameworkPaths s ++ splitPathList p})
2216
2217 #ifndef mingw32_TARGET_OS
2218 split_marker :: Char
2219 split_marker = ':'   -- not configurable (ToDo)
2220 #endif
2221
2222 splitPathList :: String -> [String]
2223 splitPathList s = filter notNull (splitUp s)
2224                 -- empty paths are ignored: there might be a trailing
2225                 -- ':' in the initial list, for example.  Empty paths can
2226                 -- cause confusion when they are translated into -I options
2227                 -- for passing to gcc.
2228   where
2229 #ifndef mingw32_TARGET_OS
2230     splitUp xs = split split_marker xs
2231 #else
2232      -- Windows: 'hybrid' support for DOS-style paths in directory lists.
2233      --
2234      -- That is, if "foo:bar:baz" is used, this interpreted as
2235      -- consisting of three entries, 'foo', 'bar', 'baz'.
2236      -- However, with "c:/foo:c:\\foo;x:/bar", this is interpreted
2237      -- as 3 elts, "c:/foo", "c:\\foo", "x:/bar"
2238      --
2239      -- Notice that no attempt is made to fully replace the 'standard'
2240      -- split marker ':' with the Windows / DOS one, ';'. The reason being
2241      -- that this will cause too much breakage for users & ':' will
2242      -- work fine even with DOS paths, if you're not insisting on being silly.
2243      -- So, use either.
2244     splitUp []             = []
2245     splitUp (x:':':div:xs) | div `elem` dir_markers
2246                            = ((x:':':div:p): splitUp rs)
2247                            where
2248                               (p,rs) = findNextPath xs
2249           -- we used to check for existence of the path here, but that
2250           -- required the IO monad to be threaded through the command-line
2251           -- parser which is quite inconvenient.  The
2252     splitUp xs = cons p (splitUp rs)
2253                where
2254                  (p,rs) = findNextPath xs
2255
2256                  cons "" xs = xs
2257                  cons x  xs = x:xs
2258
2259     -- will be called either when we've consumed nought or the
2260     -- "<Drive>:/" part of a DOS path, so splitting is just a Q of
2261     -- finding the next split marker.
2262     findNextPath xs =
2263         case break (`elem` split_markers) xs of
2264            (p, _:ds) -> (p, ds)
2265            (p, xs)   -> (p, xs)
2266
2267     split_markers :: [Char]
2268     split_markers = [':', ';']
2269
2270     dir_markers :: [Char]
2271     dir_markers = ['/', '\\']
2272 #endif
2273
2274 -- -----------------------------------------------------------------------------
2275 -- tmpDir, where we store temporary files.
2276
2277 setTmpDir :: FilePath -> DynFlags -> DynFlags
2278 setTmpDir dir dflags = dflags{ tmpDir = normalise dir }
2279   -- we used to fix /cygdrive/c/.. on Windows, but this doesn't
2280   -- seem necessary now --SDM 7/2/2008
2281
2282 -----------------------------------------------------------------------------
2283 -- Hpc stuff
2284
2285 setOptHpcDir :: String -> DynP ()
2286 setOptHpcDir arg  = upd $ \ d -> d{hpcDir = arg}
2287
2288 -----------------------------------------------------------------------------
2289 -- Via-C compilation stuff
2290
2291 -- There are some options that we need to pass to gcc when compiling
2292 -- Haskell code via C, but are only supported by recent versions of
2293 -- gcc.  The configure script decides which of these options we need,
2294 -- and puts them in the file "extra-gcc-opts" in $topdir, which is
2295 -- read before each via-C compilation.  The advantage of having these
2296 -- in a separate file is that the file can be created at install-time
2297 -- depending on the available gcc version, and even re-generated  later
2298 -- if gcc is upgraded.
2299 --
2300 -- The options below are not dependent on the version of gcc, only the
2301 -- platform.
2302
2303 machdepCCOpts :: DynFlags -> ([String], -- flags for all C compilations
2304                               [String]) -- for registerised HC compilations
2305 machdepCCOpts _dflags
2306 #if alpha_TARGET_ARCH
2307         =       ( ["-w", "-mieee"
2308 #ifdef HAVE_THREADED_RTS_SUPPORT
2309                     , "-D_REENTRANT"
2310 #endif
2311                    ], [] )
2312         -- For now, to suppress the gcc warning "call-clobbered
2313         -- register used for global register variable", we simply
2314         -- disable all warnings altogether using the -w flag. Oh well.
2315
2316 #elif hppa_TARGET_ARCH
2317         -- ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
2318         -- (very nice, but too bad the HP /usr/include files don't agree.)
2319         = ( ["-D_HPUX_SOURCE"], [] )
2320
2321 #elif m68k_TARGET_ARCH
2322       -- -fno-defer-pop : for the .hc files, we want all the pushing/
2323       --    popping of args to routines to be explicit; if we let things
2324       --    be deferred 'til after an STGJUMP, imminent death is certain!
2325       --
2326       -- -fomit-frame-pointer : *don't*
2327       --     It's better to have a6 completely tied up being a frame pointer
2328       --     rather than let GCC pick random things to do with it.
2329       --     (If we want to steal a6, then we would try to do things
2330       --     as on iX86, where we *do* steal the frame pointer [%ebp].)
2331         = ( [], ["-fno-defer-pop", "-fno-omit-frame-pointer"] )
2332
2333 #elif i386_TARGET_ARCH
2334       -- -fno-defer-pop : basically the same game as for m68k
2335       --
2336       -- -fomit-frame-pointer : *must* in .hc files; because we're stealing
2337       --   the fp (%ebp) for our register maps.
2338         =  let n_regs = stolen_x86_regs _dflags
2339            in
2340                     (
2341 #if darwin_TARGET_OS
2342                       -- By default, gcc on OS X will generate SSE
2343                       -- instructions, which need things 16-byte aligned,
2344                       -- but we don't 16-byte align things. Thus drop
2345                       -- back to generic i686 compatibility. Trac #2983.
2346                       --
2347                       -- Since Snow Leopard (10.6), gcc defaults to x86_64.
2348                       ["-march=i686", "-m32"],
2349 #else
2350                       [ if opt_Static then "-DDONT_WANT_WIN32_DLL_SUPPORT" else ""
2351                       ],
2352 #endif
2353                       [ "-fno-defer-pop",
2354                         "-fomit-frame-pointer",
2355                         -- we want -fno-builtin, because when gcc inlines
2356                         -- built-in functions like memcpy() it tends to
2357                         -- run out of registers, requiring -monly-n-regs
2358                         "-fno-builtin",
2359                         "-DSTOLEN_X86_REGS="++show n_regs ]
2360                     )
2361
2362 #elif ia64_TARGET_ARCH
2363         = ( [], ["-fomit-frame-pointer", "-G0"] )
2364
2365 #elif x86_64_TARGET_ARCH
2366         = (
2367 #if darwin_TARGET_OS
2368             ["-m64"],
2369 #else
2370             [],
2371 #endif
2372                 ["-fomit-frame-pointer",
2373                  "-fno-asynchronous-unwind-tables",
2374                         -- the unwind tables are unnecessary for HC code,
2375                         -- and get in the way of -split-objs.  Another option
2376                         -- would be to throw them away in the mangler, but this
2377                         -- is easier.
2378                  "-fno-builtin"
2379                         -- calling builtins like strlen() using the FFI can
2380                         -- cause gcc to run out of regs, so use the external
2381                         -- version.
2382                 ] )
2383
2384 #elif sparc_TARGET_ARCH
2385         = ( [], ["-w"] )
2386         -- For now, to suppress the gcc warning "call-clobbered
2387         -- register used for global register variable", we simply
2388         -- disable all warnings altogether using the -w flag. Oh well.
2389
2390 #elif powerpc_apple_darwin_TARGET
2391       -- -no-cpp-precomp:
2392       --     Disable Apple's precompiling preprocessor. It's a great thing
2393       --     for "normal" programs, but it doesn't support register variable
2394       --     declarations.
2395         = ( [], ["-no-cpp-precomp"] )
2396 #else
2397         = ( [], [] )
2398 #endif
2399
2400 picCCOpts :: DynFlags -> [String]
2401 picCCOpts _dflags
2402 #if darwin_TARGET_OS
2403       -- Apple prefers to do things the other way round.
2404       -- PIC is on by default.
2405       -- -mdynamic-no-pic:
2406       --     Turn off PIC code generation.
2407       -- -fno-common:
2408       --     Don't generate "common" symbols - these are unwanted
2409       --     in dynamic libraries.
2410
2411     | opt_PIC
2412         = ["-fno-common", "-U __PIC__","-D__PIC__"]
2413     | otherwise
2414         = ["-mdynamic-no-pic"]
2415 #elif mingw32_TARGET_OS
2416       -- no -fPIC for Windows
2417     | opt_PIC
2418         = ["-U __PIC__","-D__PIC__"]
2419     | otherwise
2420         = []
2421 #else
2422     | opt_PIC || not opt_Static
2423         = ["-fPIC", "-U __PIC__", "-D__PIC__"]
2424     | otherwise
2425         = []
2426 #endif
2427
2428 -- -----------------------------------------------------------------------------
2429 -- Splitting
2430
2431 can_split :: Bool
2432 can_split = cSplitObjs == "YES"
2433
2434 -- -----------------------------------------------------------------------------
2435 -- Compiler Info
2436
2437 data Printable = String String
2438                | FromDynFlags (DynFlags -> String)
2439
2440 compilerInfo :: [(String, Printable)]
2441 compilerInfo = [("Project name",                String cProjectName),
2442                 ("Project version",             String cProjectVersion),
2443                 ("Booter version",              String cBooterVersion),
2444                 ("Stage",                       String cStage),
2445                 ("Have interpreter",            String cGhcWithInterpreter),
2446                 ("Object splitting",            String cSplitObjs),
2447                 ("Have native code generator",  String cGhcWithNativeCodeGen),
2448                 ("Support SMP",                 String cGhcWithSMP),
2449                 ("Unregisterised",              String cGhcUnregisterised),
2450                 ("Tables next to code",         String cGhcEnableTablesNextToCode),
2451                 ("Win32 DLLs",                  String cEnableWin32DLLs),
2452                 ("RTS ways",                    String cGhcRTSWays),
2453                 ("Leading underscore",          String cLeadingUnderscore),
2454                 ("Debug on",                    String (show debugIsOn)),
2455                 ("LibDir",                      FromDynFlags topDir)
2456                ]
2457