compiler/main/DynFlags.hs

   1 {-# OPTIONS -fno-warn-missing-fields #-}
   2 -----------------------------------------------------------------------------
   3 --
   4 -- Dynamic flags
   5 --
   6 -- Most flags are dynamic flags, which means they can change from
   7 -- compilation to compilation using OPTIONS_GHC pragmas, and in a
   8 -- multi-session GHC each session can be using different dynamic
   9 -- flags.  Dynamic flags can also be set at the prompt in GHCi.
  10 --
  11 -- (c) The University of Glasgow 2005
  12 --
  13 -----------------------------------------------------------------------------
  14
  15 module DynFlags (
  16         -- Dynamic flags
  17         DynFlag(..),
  18         DynFlags(..),
  19         HscTarget(..),
  20         GhcMode(..), isOneShot,
  21         GhcLink(..), isNoLink,
  22         PackageFlag(..),
  23         Option(..),
  24
  25         -- Configuration of the core-to-core and stg-to-stg phases
  26         CoreToDo(..),
  27         StgToDo(..),
  28         SimplifierSwitch(..),
  29         SimplifierMode(..), FloatOutSwitches(..),
  30         getCoreToDo, getStgToDo,
  31
  32         -- Manipulating DynFlags
  33         defaultDynFlags,                -- DynFlags
  34         initDynFlags,                   -- DynFlags -> IO DynFlags
  35
  36         dopt,                           -- DynFlag -> DynFlags -> Bool
  37         dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
  38         getOpts,                        -- (DynFlags -> [a]) -> IO [a]
  39         getVerbFlag,
  40         updOptLevel,
  41         setTmpDir,
  42         setPackageName,
  43
  44         -- parsing DynFlags
  45         parseDynamicFlags,
  46         allFlags,
  47
  48         -- misc stuff
  49         machdepCCOpts, picCCOpts
  50   ) where
  51
  52 #include "HsVersions.h"
  53
  54 import Module           ( Module, mkModuleName, mkModule )
  55 import PackageConfig
  56 import PrelNames        ( mAIN )
  57 #ifdef i386_TARGET_ARCH
  58 import StaticFlags      ( opt_Static )
  59 #endif
  60 import StaticFlags      ( opt_PIC, WayName(..), v_Ways, v_Build_tag,
  61                           v_RTS_Build_tag )
  62 import {-# SOURCE #-} Packages (PackageState)
  63 import DriverPhases     ( Phase(..), phaseInputExt )
  64 import Config
  65 import CmdLineParser
  66 import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
  67 import Panic            ( panic, GhcException(..) )
  68 import UniqFM           ( UniqFM )
  69 import Util             ( notNull, splitLongestPrefix, normalisePath )
  70 import Maybes           ( fromJust, orElse )
  71 import SrcLoc           ( SrcSpan )
  72
  73 import DATA_IOREF       ( readIORef )
  74 import EXCEPTION        ( throwDyn )
  75 import Monad            ( when )
  76 #ifdef mingw32_TARGET_OS
  77 import Data.List        ( isPrefixOf )
  78 #else
  79 import Util             ( split )
  80 #endif
  81
  82 import Char             ( isDigit, isUpper )
  83 import Outputable
  84 import System.IO        ( hPutStrLn, stderr )
  85 import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
  86
  87 -- -----------------------------------------------------------------------------
  88 -- DynFlags
  89
  90 data DynFlag
  91
  92    -- debugging flags
  93    = Opt_D_dump_cmm
  94    | Opt_D_dump_asm
  95    | Opt_D_dump_cpranal
  96    | Opt_D_dump_deriv
  97    | Opt_D_dump_ds
  98    | Opt_D_dump_flatC
  99    | Opt_D_dump_foreign
 100    | Opt_D_dump_inlinings
 101    | Opt_D_dump_occur_anal
 102    | Opt_D_dump_parsed
 103    | Opt_D_dump_rn
 104    | Opt_D_dump_simpl
 105    | Opt_D_dump_simpl_iterations
 106    | Opt_D_dump_spec
 107    | Opt_D_dump_prep
 108    | Opt_D_dump_stg
 109    | Opt_D_dump_stranal
 110    | Opt_D_dump_tc
 111    | Opt_D_dump_types
 112    | Opt_D_dump_rules
 113    | Opt_D_dump_cse
 114    | Opt_D_dump_worker_wrapper
 115    | Opt_D_dump_rn_trace
 116    | Opt_D_dump_rn_stats
 117    | Opt_D_dump_opt_cmm
 118    | Opt_D_dump_simpl_stats
 119    | Opt_D_dump_tc_trace
 120    | Opt_D_dump_if_trace
 121    | Opt_D_dump_splices
 122    | Opt_D_dump_BCOs
 123    | Opt_D_dump_vect
 124    | Opt_D_source_stats
 125    | Opt_D_verbose_core2core
 126    | Opt_D_verbose_stg2stg
 127    | Opt_D_dump_hi
 128    | Opt_D_dump_hi_diffs
 129    | Opt_D_dump_minimal_imports
 130    | Opt_D_faststring_stats
 131    | Opt_DoCoreLinting
 132    | Opt_DoStgLinting
 133    | Opt_DoCmmLinting
 134
 135    | Opt_WarnIsError            -- -Werror; makes warnings fatal
 136    | Opt_WarnDuplicateExports
 137    | Opt_WarnHiShadows
 138    | Opt_WarnIncompletePatterns
 139    | Opt_WarnIncompletePatternsRecUpd
 140    | Opt_WarnMissingFields
 141    | Opt_WarnMissingMethods
 142    | Opt_WarnMissingSigs
 143    | Opt_WarnNameShadowing
 144    | Opt_WarnOverlappingPatterns
 145    | Opt_WarnSimplePatterns
 146    | Opt_WarnTypeDefaults
 147    | Opt_WarnUnusedBinds
 148    | Opt_WarnUnusedImports
 149    | Opt_WarnUnusedMatches
 150    | Opt_WarnDeprecations
 151    | Opt_WarnDodgyImports
 152    | Opt_WarnOrphans
 153
 154    -- language opts
 155    | Opt_AllowOverlappingInstances
 156    | Opt_AllowUndecidableInstances
 157    | Opt_AllowIncoherentInstances
 158    | Opt_MonomorphismRestriction
 159    | Opt_MonoPatBinds
 160    | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
 161    | Opt_GlasgowExts
 162    | Opt_FFI
 163    | Opt_PArr                           -- Syntactic support for parallel arrays
 164    | Opt_Arrows                         -- Arrow-notation syntax
 165    | Opt_TH
 166    | Opt_ImplicitParams
 167    | Opt_Generics
 168    | Opt_ImplicitPrelude
 169    | Opt_ScopedTypeVariables
 170    | Opt_BangPatterns
 171    | Opt_IndexedTypes
 172
 173    -- optimisation opts
 174    | Opt_Strictness
 175    | Opt_FullLaziness
 176    | Opt_CSE
 177    | Opt_IgnoreInterfacePragmas
 178    | Opt_OmitInterfacePragmas
 179    | Opt_DoLambdaEtaExpansion
 180    | Opt_IgnoreAsserts
 181    | Opt_IgnoreBreakpoints
 182    | Opt_DoEtaReduction
 183    | Opt_CaseMerge
 184    | Opt_UnboxStrictFields
 185    | Opt_DictsCheap
 186
 187    -- misc opts
 188    | Opt_Cpp
 189    | Opt_Pp
 190    | Opt_ForceRecomp
 191    | Opt_DryRun
 192    | Opt_DoAsmMangling
 193    | Opt_ExcessPrecision
 194    | Opt_ReadUserPackageConf
 195    | Opt_NoHsMain
 196    | Opt_SplitObjs
 197    | Opt_StgStats
 198    | Opt_HideAllPackages
 199    | Opt_PrintBindResult
 200    | Opt_Haddock
 201
 202    -- keeping stuff
 203    | Opt_KeepHiDiffs
 204    | Opt_KeepHcFiles
 205    | Opt_KeepSFiles
 206    | Opt_KeepRawSFiles
 207    | Opt_KeepTmpFiles
 208
 209    deriving (Eq)
 210
 211 data DynFlags = DynFlags {
 212   ghcMode               :: GhcMode,
 213   ghcLink               :: GhcLink,
 214   coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
 215   stgToDo               :: Maybe [StgToDo],  -- similarly
 216   hscTarget             :: HscTarget,
 217   hscOutName            :: String,      -- name of the output file
 218   extCoreName           :: String,      -- name of the .core output file
 219   verbosity             :: Int,         -- verbosity level
 220   optLevel              :: Int,         -- optimisation level
 221   maxSimplIterations    :: Int,         -- max simplifier iterations
 222   ruleCheck             :: Maybe String,
 223   stolen_x86_regs       :: Int,
 224   cmdlineHcIncludes     :: [String],    -- -#includes
 225   importPaths           :: [FilePath],
 226   mainModIs             :: Module,
 227   mainFunIs             :: Maybe String,
 228   ctxtStkDepth          :: Int,         -- Typechecker context stack depth
 229
 230   thisPackage           :: PackageId,
 231
 232   -- ways
 233   wayNames              :: [WayName],   -- way flags from the cmd line
 234   buildTag              :: String,      -- the global "way" (eg. "p" for prof)
 235   rtsBuildTag           :: String,      -- the RTS "way"
 236
 237   -- paths etc.
 238   objectDir             :: Maybe String,
 239   hiDir                 :: Maybe String,
 240   stubDir               :: Maybe String,
 241
 242   objectSuf             :: String,
 243   hcSuf                 :: String,
 244   hiSuf                 :: String,
 245
 246   outputFile            :: Maybe String,
 247   outputHi              :: Maybe String,
 248
 249   includePaths          :: [String],
 250   libraryPaths          :: [String],
 251   frameworkPaths        :: [String],    -- used on darwin only
 252   cmdlineFrameworks     :: [String],    -- ditto
 253   tmpDir                :: String,      -- no trailing '/'
 254
 255   ghcUsagePath          :: FilePath,    -- Filled in by SysTools
 256   ghciUsagePath         :: FilePath,    -- ditto
 257
 258   -- options for particular phases
 259   opt_L                 :: [String],
 260   opt_P                 :: [String],
 261   opt_F                 :: [String],
 262   opt_c                 :: [String],
 263   opt_m                 :: [String],
 264   opt_a                 :: [String],
 265   opt_l                 :: [String],
 266   opt_dll               :: [String],
 267   opt_dep               :: [String],
 268
 269   -- commands for particular phases
 270   pgm_L                 :: String,
 271   pgm_P                 :: (String,[Option]),
 272   pgm_F                 :: String,
 273   pgm_c                 :: (String,[Option]),
 274   pgm_m                 :: (String,[Option]),
 275   pgm_s                 :: (String,[Option]),
 276   pgm_a                 :: (String,[Option]),
 277   pgm_l                 :: (String,[Option]),
 278   pgm_dll               :: (String,[Option]),
 279   pgm_T                 :: String,
 280   pgm_sysman            :: String,
 281
 282   --  Package flags
 283   extraPkgConfs         :: [FilePath],
 284   topDir                :: FilePath,    -- filled in by SysTools
 285   systemPackageConfig   :: FilePath,    -- ditto
 286         -- The -package-conf flags given on the command line, in the order
 287         -- they appeared.
 288
 289   packageFlags          :: [PackageFlag],
 290         -- The -package and -hide-package flags from the command-line
 291
 292   -- Package state
 293   -- NB. do not modify this field, it is calculated by
 294   -- Packages.initPackages and Packages.updatePackages.
 295   pkgDatabase           :: Maybe (UniqFM InstalledPackageInfo),
 296   pkgState              :: PackageState,
 297
 298   -- hsc dynamic flags
 299   flags                 :: [DynFlag],
 300
 301   -- message output
 302   log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO ()
 303  }
 304
 305 data HscTarget
 306   = HscC
 307   | HscAsm
 308   | HscJava
 309   | HscInterpreted
 310   | HscNothing
 311   deriving (Eq, Show)
 312
 313 data GhcMode
 314   = BatchCompile        -- | @ghc --make Main@
 315   | Interactive         -- | @ghc --interactive@
 316   | OneShot             -- | @ghc -c Foo.hs@
 317   | JustTypecheck       -- | Development environemnts, refactorer, etc.
 318   | MkDepend
 319   deriving Eq
 320
 321 isOneShot :: GhcMode -> Bool
 322 isOneShot OneShot = True
 323 isOneShot _other  = False
 324
 325 data GhcLink    -- What to do in the link step, if there is one
 326   =             -- Only relevant for modes
 327                 --      DoMake and StopBefore StopLn
 328     NoLink              -- Don't link at all
 329   | StaticLink          -- Ordinary linker [the default]
 330   | MkDLL               -- Make a DLL
 331
 332 isNoLink :: GhcLink -> Bool
 333 isNoLink NoLink = True
 334 isNoLink other  = False
 335
 336 data PackageFlag
 337   = ExposePackage  String
 338   | HidePackage    String
 339   | IgnorePackage  String
 340   deriving Eq
 341
 342 defaultHscTarget
 343   | cGhcWithNativeCodeGen == "YES"      =  HscAsm
 344   | otherwise                           =  HscC
 345
 346 initDynFlags dflags = do
 347  -- someday these will be dynamic flags
 348  ways <- readIORef v_Ways
 349  build_tag <- readIORef v_Build_tag
 350  rts_build_tag <- readIORef v_RTS_Build_tag
 351  return dflags{
 352         wayNames        = ways,
 353         buildTag        = build_tag,
 354         rtsBuildTag     = rts_build_tag
 355         }
 356
 357 defaultDynFlags =
 358      DynFlags {
 359         ghcMode                 = OneShot,
 360         ghcLink                 = StaticLink,
 361         coreToDo                = Nothing,
 362         stgToDo                 = Nothing,
 363         hscTarget               = defaultHscTarget,
 364         hscOutName              = "",
 365         extCoreName             = "",
 366         verbosity               = 0,
 367         optLevel                = 0,
 368         maxSimplIterations      = 4,
 369         ruleCheck               = Nothing,
 370         stolen_x86_regs         = 4,
 371         cmdlineHcIncludes       = [],
 372         importPaths             = ["."],
 373         mainModIs               = mAIN,
 374         mainFunIs               = Nothing,
 375         ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,
 376
 377         thisPackage             = mainPackageId,
 378
 379         objectDir               = Nothing,
 380         hiDir                   = Nothing,
 381         stubDir                 = Nothing,
 382
 383         objectSuf               = phaseInputExt StopLn,
 384         hcSuf                   = phaseInputExt HCc,
 385         hiSuf                   = "hi",
 386
 387         outputFile              = Nothing,
 388         outputHi                = Nothing,
 389         includePaths            = [],
 390         libraryPaths            = [],
 391         frameworkPaths          = [],
 392         cmdlineFrameworks       = [],
 393         tmpDir                  = cDEFAULT_TMPDIR,
 394
 395         opt_L                   = [],
 396         opt_P                   = [],
 397         opt_F                   = [],
 398         opt_c                   = [],
 399         opt_a                   = [],
 400         opt_m                   = [],
 401         opt_l                   = [],
 402         opt_dll                 = [],
 403         opt_dep                 = [],
 404
 405         extraPkgConfs           = [],
 406         packageFlags            = [],
 407         pkgDatabase             = Nothing,
 408         pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
 409
 410         flags = [
 411             Opt_ReadUserPackageConf,
 412
 413             Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
 414                                 -- behaviour the default, to see if anyone notices
 415                                 -- SLPJ July 06
 416
 417             Opt_ImplicitPrelude,
 418             Opt_MonomorphismRestriction,
 419             Opt_Strictness,
 420                         -- strictness is on by default, but this only
 421                         -- applies to -O.
 422             Opt_CSE,            -- similarly for CSE.
 423             Opt_FullLaziness,   -- ...and for full laziness
 424
 425             Opt_DoLambdaEtaExpansion,
 426                         -- This one is important for a tiresome reason:
 427                         -- we want to make sure that the bindings for data
 428                         -- constructors are eta-expanded.  This is probably
 429                         -- a good thing anyway, but it seems fragile.
 430
 431             Opt_DoAsmMangling,
 432
 433             -- and the default no-optimisation options:
 434             Opt_IgnoreInterfacePragmas,
 435             Opt_OmitInterfacePragmas,
 436
 437             -- on by default:
 438             Opt_PrintBindResult
 439                ] ++ standardWarnings,
 440
 441         log_action = \severity srcSpan style msg ->
 442                         case severity of
 443                           SevInfo  -> hPutStrLn stderr (show (msg style))
 444                           SevFatal -> hPutStrLn stderr (show (msg style))
 445                           _        -> hPutStrLn stderr ('\n':show ((mkLocMessage srcSpan msg) style))
 446       }
 447
 448 {-
 449     Verbosity levels:
 450
 451     0   |   print errors & warnings only
 452     1   |   minimal verbosity: print "compiling M ... done." for each module.
 453     2   |   equivalent to -dshow-passes
 454     3   |   equivalent to existing "ghc -v"
 455     4   |   "ghc -v -ddump-most"
 456     5   |   "ghc -v -ddump-all"
 457 -}
 458
 459 dopt :: DynFlag -> DynFlags -> Bool
 460 dopt f dflags  = f `elem` (flags dflags)
 461
 462 dopt_set :: DynFlags -> DynFlag -> DynFlags
 463 dopt_set dfs f = dfs{ flags = f : flags dfs }
 464
 465 dopt_unset :: DynFlags -> DynFlag -> DynFlags
 466 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
 467
 468 getOpts :: DynFlags -> (DynFlags -> [a]) -> [a]
 469 getOpts dflags opts = reverse (opts dflags)
 470         -- We add to the options from the front, so we need to reverse the list
 471
 472 getVerbFlag :: DynFlags -> String
 473 getVerbFlag dflags
 474   | verbosity dflags >= 3  = "-v"
 475   | otherwise =  ""
 476
 477 setObjectDir  f d = d{ objectDir  = f}
 478 setHiDir      f d = d{ hiDir      = f}
 479 setStubDir    f d = d{ stubDir    = f}
 480
 481 setObjectSuf  f d = d{ objectSuf  = f}
 482 setHiSuf      f d = d{ hiSuf      = f}
 483 setHcSuf      f d = d{ hcSuf      = f}
 484
 485 setOutputFile f d = d{ outputFile = f}
 486 setOutputHi   f d = d{ outputHi   = f}
 487
 488 -- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
 489 -- Config.hs should really use Option.
 490 setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}
 491
 492 setPgmL   f d = d{ pgm_L   = f}
 493 setPgmF   f d = d{ pgm_F   = f}
 494 setPgmc   f d = d{ pgm_c   = (f,[])}
 495 setPgmm   f d = d{ pgm_m   = (f,[])}
 496 setPgms   f d = d{ pgm_s   = (f,[])}
 497 setPgma   f d = d{ pgm_a   = (f,[])}
 498 setPgml   f d = d{ pgm_l   = (f,[])}
 499 setPgmdll f d = d{ pgm_dll = (f,[])}
 500
 501 addOptL   f d = d{ opt_L   = f : opt_L d}
 502 addOptP   f d = d{ opt_P   = f : opt_P d}
 503 addOptF   f d = d{ opt_F   = f : opt_F d}
 504 addOptc   f d = d{ opt_c   = f : opt_c d}
 505 addOptm   f d = d{ opt_m   = f : opt_m d}
 506 addOpta   f d = d{ opt_a   = f : opt_a d}
 507 addOptl   f d = d{ opt_l   = f : opt_l d}
 508 addOptdll f d = d{ opt_dll = f : opt_dll d}
 509 addOptdep f d = d{ opt_dep = f : opt_dep d}
 510
 511 addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}
 512
 513 -- -----------------------------------------------------------------------------
 514 -- Command-line options
 515
 516 -- When invoking external tools as part of the compilation pipeline, we
 517 -- pass these a sequence of options on the command-line. Rather than
 518 -- just using a list of Strings, we use a type that allows us to distinguish
 519 -- between filepaths and 'other stuff'. [The reason being, of course, that
 520 -- this type gives us a handle on transforming filenames, and filenames only,
 521 -- to whatever format they're expected to be on a particular platform.]
 522
 523 data Option
 524  = FileOption -- an entry that _contains_ filename(s) / filepaths.
 525               String  -- a non-filepath prefix that shouldn't be
 526                       -- transformed (e.g., "/out=")
 527               String  -- the filepath/filename portion
 528  | Option     String
 529
 530 -----------------------------------------------------------------------------
 531 -- Setting the optimisation level
 532
 533 updOptLevel :: Int -> DynFlags -> DynFlags
 534 -- Set dynflags appropriate to the optimisation level
 535 updOptLevel n dfs
 536   = if (n >= 1)
 537      then dfs2{ hscTarget = HscC, optLevel = n } -- turn on -fvia-C with -O
 538      else dfs2{ optLevel = n }
 539   where
 540    dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
 541    dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts
 542
 543    extra_dopts
 544         | n == 0    = opt_0_dopts
 545         | otherwise = opt_1_dopts
 546
 547    remove_dopts
 548         | n == 0    = opt_1_dopts
 549         | otherwise = opt_0_dopts
 550
 551 opt_0_dopts =  [
 552         Opt_IgnoreInterfacePragmas,
 553         Opt_OmitInterfacePragmas
 554     ]
 555
 556 opt_1_dopts = [
 557         Opt_IgnoreAsserts,
 558         Opt_DoEtaReduction,
 559         Opt_CaseMerge
 560      ]
 561
 562 -- -----------------------------------------------------------------------------
 563 -- Standard sets of warning options
 564
 565 standardWarnings
 566     = [ Opt_WarnDeprecations,
 567         Opt_WarnOverlappingPatterns,
 568         Opt_WarnMissingFields,
 569         Opt_WarnMissingMethods,
 570         Opt_WarnDuplicateExports
 571       ]
 572
 573 minusWOpts
 574     = standardWarnings ++
 575       [ Opt_WarnUnusedBinds,
 576         Opt_WarnUnusedMatches,
 577         Opt_WarnUnusedImports,
 578         Opt_WarnIncompletePatterns,
 579         Opt_WarnDodgyImports
 580       ]
 581
 582 minusWallOpts
 583     = minusWOpts ++
 584       [ Opt_WarnTypeDefaults,
 585         Opt_WarnNameShadowing,
 586         Opt_WarnMissingSigs,
 587         Opt_WarnHiShadows,
 588         Opt_WarnOrphans
 589       ]
 590
 591 -- -----------------------------------------------------------------------------
 592 -- CoreToDo:  abstraction of core-to-core passes to run.
 593
 594 data CoreToDo           -- These are diff core-to-core passes,
 595                         -- which may be invoked in any order,
 596                         -- as many times as you like.
 597
 598   = CoreDoSimplify      -- The core-to-core simplifier.
 599         SimplifierMode
 600         [SimplifierSwitch]
 601                         -- Each run of the simplifier can take a different
 602                         -- set of simplifier-specific flags.
 603   | CoreDoFloatInwards
 604   | CoreDoFloatOutwards FloatOutSwitches
 605   | CoreLiberateCase
 606   | CoreDoPrintCore
 607   | CoreDoStaticArgs
 608   | CoreDoStrictness
 609   | CoreDoWorkerWrapper
 610   | CoreDoSpecialising
 611   | CoreDoSpecConstr
 612   | CoreDoOldStrictness
 613   | CoreDoGlomBinds
 614   | CoreCSE
 615   | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
 616                                                 -- matching this string
 617
 618   | CoreDoNothing        -- useful when building up lists of these things
 619
 620 data SimplifierMode             -- See comments in SimplMonad
 621   = SimplGently
 622   | SimplPhase Int
 623
 624 data SimplifierSwitch
 625   = MaxSimplifierIterations Int
 626   | NoCaseOfCase
 627
 628 data FloatOutSwitches
 629   = FloatOutSw  Bool    -- True <=> float lambdas to top level
 630                 Bool    -- True <=> float constants to top level,
 631                         --          even if they do not escape a lambda
 632
 633
 634 -- The core-to-core pass ordering is derived from the DynFlags:
 635
 636 getCoreToDo :: DynFlags -> [CoreToDo]
 637 getCoreToDo dflags
 638   | Just todo <- coreToDo dflags = todo -- set explicitly by user
 639   | otherwise = core_todo
 640   where
 641     opt_level     = optLevel dflags
 642     max_iter      = maxSimplIterations dflags
 643     strictness    = dopt Opt_Strictness dflags
 644     full_laziness = dopt Opt_FullLaziness dflags
 645     cse           = dopt Opt_CSE dflags
 646     rule_check    = ruleCheck dflags
 647
 648     core_todo =
 649      if opt_level == 0 then
 650       [
 651         CoreDoSimplify (SimplPhase 0) [
 652             MaxSimplifierIterations max_iter
 653         ]
 654       ]
 655      else {- opt_level >= 1 -} [
 656
 657         -- initial simplify: mk specialiser happy: minimum effort please
 658         CoreDoSimplify SimplGently [
 659                         --      Simplify "gently"
 660                         -- Don't inline anything till full laziness has bitten
 661                         -- In particular, inlining wrappers inhibits floating
 662                         -- e.g. ...(case f x of ...)...
 663                         --  ==> ...(case (case x of I# x# -> fw x#) of ...)...
 664                         --  ==> ...(case x of I# x# -> case fw x# of ...)...
 665                         -- and now the redex (f x) isn't floatable any more
 666                         -- Similarly, don't apply any rules until after full
 667                         -- laziness.  Notably, list fusion can prevent floating.
 668
 669             NoCaseOfCase,       -- Don't do case-of-case transformations.
 670                                 -- This makes full laziness work better
 671             MaxSimplifierIterations max_iter
 672         ],
 673
 674         -- Specialisation is best done before full laziness
 675         -- so that overloaded functions have all their dictionary lambdas manifest
 676         CoreDoSpecialising,
 677
 678         if full_laziness then CoreDoFloatOutwards (FloatOutSw False False)
 679                          else CoreDoNothing,
 680
 681         CoreDoFloatInwards,
 682
 683         CoreDoSimplify (SimplPhase 2) [
 684                 -- Want to run with inline phase 2 after the specialiser to give
 685                 -- maximum chance for fusion to work before we inline build/augment
 686                 -- in phase 1.  This made a difference in 'ansi' where an
 687                 -- overloaded function wasn't inlined till too late.
 688            MaxSimplifierIterations max_iter
 689         ],
 690         case rule_check of { Just pat -> CoreDoRuleCheck 2 pat; Nothing -> CoreDoNothing },
 691
 692         CoreDoSimplify (SimplPhase 1) [
 693                 -- Need inline-phase2 here so that build/augment get
 694                 -- inlined.  I found that spectral/hartel/genfft lost some useful
 695                 -- strictness in the function sumcode' if augment is not inlined
 696                 -- before strictness analysis runs
 697            MaxSimplifierIterations max_iter
 698         ],
 699         case rule_check of { Just pat -> CoreDoRuleCheck 1 pat; Nothing -> CoreDoNothing },
 700
 701         CoreDoSimplify (SimplPhase 0) [
 702                 -- Phase 0: allow all Ids to be inlined now
 703                 -- This gets foldr inlined before strictness analysis
 704
 705            MaxSimplifierIterations 3
 706                 -- At least 3 iterations because otherwise we land up with
 707                 -- huge dead expressions because of an infelicity in the
 708                 -- simpifier.
 709                 --      let k = BIG in foldr k z xs
 710                 -- ==>  let k = BIG in letrec go = \xs -> ...(k x).... in go xs
 711                 -- ==>  let k = BIG in letrec go = \xs -> ...(BIG x).... in go xs
 712                 -- Don't stop now!
 713
 714         ],
 715         case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
 716
 717 #ifdef OLD_STRICTNESS
 718         CoreDoOldStrictness
 719 #endif
 720         if strictness then CoreDoStrictness else CoreDoNothing,
 721         CoreDoWorkerWrapper,
 722         CoreDoGlomBinds,
 723
 724         CoreDoSimplify (SimplPhase 0) [
 725            MaxSimplifierIterations max_iter
 726         ],
 727
 728         if full_laziness then
 729           CoreDoFloatOutwards (FloatOutSw False   -- Not lambdas
 730                                           True)   -- Float constants
 731         else CoreDoNothing,
 732                 -- nofib/spectral/hartel/wang doubles in speed if you
 733                 -- do full laziness late in the day.  It only happens
 734                 -- after fusion and other stuff, so the early pass doesn't
 735                 -- catch it.  For the record, the redex is
 736                 --        f_el22 (f_el21 r_midblock)
 737
 738
 739         -- We want CSE to follow the final full-laziness pass, because it may
 740         -- succeed in commoning up things floated out by full laziness.
 741         -- CSE used to rely on the no-shadowing invariant, but it doesn't any more
 742
 743         if cse then CoreCSE else CoreDoNothing,
 744
 745         CoreDoFloatInwards,
 746
 747 -- Case-liberation for -O2.  This should be after
 748 -- strictness analysis and the simplification which follows it.
 749
 750         case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing }
 751      ]
 752
 753         ++
 754
 755      (if opt_level >= 2 then
 756            [  CoreLiberateCase,
 757               CoreDoSimplify (SimplPhase 0) [
 758                   MaxSimplifierIterations max_iter
 759               ],        -- Run the simplifier after LiberateCase to vastly
 760                         -- reduce the possiblility of shadowing
 761                         -- Reason: see Note [Shadowing] in SpecConstr.lhs
 762              CoreDoSpecConstr
 763            ]
 764       else
 765            [])
 766
 767         ++
 768
 769         -- Final clean-up simplification:
 770      [  CoreDoSimplify (SimplPhase 0) [
 771           MaxSimplifierIterations max_iter
 772         ]
 773      ]
 774
 775 -- -----------------------------------------------------------------------------
 776 -- StgToDo:  abstraction of stg-to-stg passes to run.
 777
 778 data StgToDo
 779   = StgDoMassageForProfiling  -- should be (next to) last
 780   -- There's also setStgVarInfo, but its absolute "lastness"
 781   -- is so critical that it is hardwired in (no flag).
 782   | D_stg_stats
 783
 784 getStgToDo :: DynFlags -> [StgToDo]
 785 getStgToDo dflags
 786   | Just todo <- stgToDo dflags = todo -- set explicitly by user
 787   | otherwise = todo2
 788   where
 789         stg_stats = dopt Opt_StgStats dflags
 790
 791         todo1 = if stg_stats then [D_stg_stats] else []
 792
 793         todo2 | WayProf `elem` wayNames dflags
 794               = StgDoMassageForProfiling : todo1
 795               | otherwise
 796               = todo1
 797
 798 -- -----------------------------------------------------------------------------
 799 -- DynFlags parser
 800
 801 allFlags :: [String]
 802 allFlags = map ('-':) $
 803            [ name | (name, optkind) <- dynamic_flags, ok optkind ] ++
 804            map ("fno-"++) flags ++
 805            map ("f"++) flags
 806     where ok (PrefixPred _ _) = False
 807           ok _ = True
 808           flags = map fst fFlags
 809
 810 dynamic_flags :: [(String, OptKind DynP)]
 811 dynamic_flags = [
 812      ( "n"              , NoArg  (setDynFlag Opt_DryRun) )
 813   ,  ( "cpp"            , NoArg  (setDynFlag Opt_Cpp))
 814   ,  ( "F"              , NoArg  (setDynFlag Opt_Pp))
 815   ,  ( "#include"       , HasArg (addCmdlineHCInclude) )
 816   ,  ( "v"              , OptIntSuffix setVerbosity )
 817         ------- Specific phases  --------------------------------------------
 818   ,  ( "pgmL"           , HasArg (upd . setPgmL) )
 819   ,  ( "pgmP"           , HasArg (upd . setPgmP) )
 820   ,  ( "pgmF"           , HasArg (upd . setPgmF) )
 821   ,  ( "pgmc"           , HasArg (upd . setPgmc) )
 822   ,  ( "pgmm"           , HasArg (upd . setPgmm) )
 823   ,  ( "pgms"           , HasArg (upd . setPgms) )
 824   ,  ( "pgma"           , HasArg (upd . setPgma) )
 825   ,  ( "pgml"           , HasArg (upd . setPgml) )
 826   ,  ( "pgmdll"         , HasArg (upd . setPgmdll) )
 827
 828   ,  ( "optL"           , HasArg (upd . addOptL) )
 829   ,  ( "optP"           , HasArg (upd . addOptP) )
 830   ,  ( "optF"           , HasArg (upd . addOptF) )
 831   ,  ( "optc"           , HasArg (upd . addOptc) )
 832   ,  ( "optm"           , HasArg (upd . addOptm) )
 833   ,  ( "opta"           , HasArg (upd . addOpta) )
 834   ,  ( "optl"           , HasArg (upd . addOptl) )
 835   ,  ( "optdll"         , HasArg (upd . addOptdll) )
 836   ,  ( "optdep"         , HasArg (upd . addOptdep) )
 837
 838   ,  ( "split-objs"     , NoArg (if can_split
 839                                     then setDynFlag Opt_SplitObjs
 840                                     else return ()) )
 841
 842         -------- Linking ----------------------------------------------------
 843   ,  ( "c"              , NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
 844   ,  ( "no-link"        , NoArg (upd $ \d -> d{ ghcLink=NoLink } )) -- Dep.
 845   ,  ( "-mk-dll"        , NoArg (upd $ \d -> d{ ghcLink=MkDLL } ))
 846
 847         ------- Libraries ---------------------------------------------------
 848   ,  ( "L"              , Prefix addLibraryPath )
 849   ,  ( "l"              , AnySuffix (\s -> do upd (addOptl s)
 850                                               upd (addOptdll s)))
 851
 852         ------- Frameworks --------------------------------------------------
 853         -- -framework-path should really be -F ...
 854   ,  ( "framework-path" , HasArg addFrameworkPath )
 855   ,  ( "framework"      , HasArg (upd . addCmdlineFramework) )
 856
 857         ------- Output Redirection ------------------------------------------
 858   ,  ( "odir"           , HasArg (upd . setObjectDir  . Just))
 859   ,  ( "o"              , SepArg (upd . setOutputFile . Just))
 860   ,  ( "ohi"            , HasArg (upd . setOutputHi   . Just ))
 861   ,  ( "osuf"           , HasArg (upd . setObjectSuf))
 862   ,  ( "hcsuf"          , HasArg (upd . setHcSuf))
 863   ,  ( "hisuf"          , HasArg (upd . setHiSuf))
 864   ,  ( "hidir"          , HasArg (upd . setHiDir . Just))
 865   ,  ( "tmpdir"         , HasArg (upd . setTmpDir))
 866   ,  ( "stubdir"        , HasArg (upd . setStubDir . Just))
 867
 868         ------- Keeping temporary files -------------------------------------
 869   ,  ( "keep-hc-file"   , AnySuffix (\_ -> setDynFlag Opt_KeepHcFiles))
 870   ,  ( "keep-s-file"    , AnySuffix (\_ -> setDynFlag Opt_KeepSFiles))
 871   ,  ( "keep-raw-s-file", AnySuffix (\_ -> setDynFlag Opt_KeepRawSFiles))
 872   ,  ( "keep-tmp-files" , AnySuffix (\_ -> setDynFlag Opt_KeepTmpFiles))
 873
 874         ------- Miscellaneous ----------------------------------------------
 875   ,  ( "no-hs-main"     , NoArg (setDynFlag Opt_NoHsMain))
 876   ,  ( "main-is"        , SepArg setMainIs )
 877   ,  ( "haddock"        , NoArg (setDynFlag Opt_Haddock) )
 878
 879         ------- recompilation checker (DEPRECATED, use -fforce-recomp) -----
 880   ,  ( "recomp"         , NoArg (unSetDynFlag Opt_ForceRecomp) )
 881   ,  ( "no-recomp"      , NoArg (setDynFlag   Opt_ForceRecomp) )
 882
 883         ------- Packages ----------------------------------------------------
 884   ,  ( "package-conf"   , HasArg extraPkgConf_ )
 885   ,  ( "no-user-package-conf", NoArg (unSetDynFlag Opt_ReadUserPackageConf) )
 886   ,  ( "package-name"   , HasArg (upd . setPackageName) )
 887   ,  ( "package"        , HasArg exposePackage )
 888   ,  ( "hide-package"   , HasArg hidePackage )
 889   ,  ( "hide-all-packages", NoArg (setDynFlag Opt_HideAllPackages) )
 890   ,  ( "ignore-package" , HasArg ignorePackage )
 891   ,  ( "syslib"         , HasArg exposePackage )  -- for compatibility
 892
 893         ------ HsCpp opts ---------------------------------------------------
 894   ,  ( "D",             AnySuffix (upd . addOptP) )
 895   ,  ( "U",             AnySuffix (upd . addOptP) )
 896
 897         ------- Include/Import Paths ----------------------------------------
 898   ,  ( "I"              , Prefix    addIncludePath)
 899   ,  ( "i"              , OptPrefix addImportPath )
 900
 901         ------ Debugging ----------------------------------------------------
 902   ,  ( "dstg-stats",    NoArg (setDynFlag Opt_StgStats))
 903
 904   ,  ( "ddump-cmm",              setDumpFlag Opt_D_dump_cmm)
 905   ,  ( "ddump-asm",              setDumpFlag Opt_D_dump_asm)
 906   ,  ( "ddump-cpranal",          setDumpFlag Opt_D_dump_cpranal)
 907   ,  ( "ddump-deriv",            setDumpFlag Opt_D_dump_deriv)
 908   ,  ( "ddump-ds",               setDumpFlag Opt_D_dump_ds)
 909   ,  ( "ddump-flatC",            setDumpFlag Opt_D_dump_flatC)
 910   ,  ( "ddump-foreign",          setDumpFlag Opt_D_dump_foreign)
 911   ,  ( "ddump-inlinings",        setDumpFlag Opt_D_dump_inlinings)
 912   ,  ( "ddump-occur-anal",       setDumpFlag Opt_D_dump_occur_anal)
 913   ,  ( "ddump-parsed",           setDumpFlag Opt_D_dump_parsed)
 914   ,  ( "ddump-rn",               setDumpFlag Opt_D_dump_rn)
 915   ,  ( "ddump-simpl",            setDumpFlag Opt_D_dump_simpl)
 916   ,  ( "ddump-simpl-iterations", setDumpFlag Opt_D_dump_simpl_iterations)
 917   ,  ( "ddump-spec",             setDumpFlag Opt_D_dump_spec)
 918   ,  ( "ddump-prep",             setDumpFlag Opt_D_dump_prep)
 919   ,  ( "ddump-stg",              setDumpFlag Opt_D_dump_stg)
 920   ,  ( "ddump-stranal",          setDumpFlag Opt_D_dump_stranal)
 921   ,  ( "ddump-tc",               setDumpFlag Opt_D_dump_tc)
 922   ,  ( "ddump-types",            setDumpFlag Opt_D_dump_types)
 923   ,  ( "ddump-rules",            setDumpFlag Opt_D_dump_rules)
 924   ,  ( "ddump-cse",              setDumpFlag Opt_D_dump_cse)
 925   ,  ( "ddump-worker-wrapper",   setDumpFlag Opt_D_dump_worker_wrapper)
 926   ,  ( "ddump-rn-trace",         NoArg (setDynFlag Opt_D_dump_rn_trace))
 927   ,  ( "ddump-if-trace",         NoArg (setDynFlag Opt_D_dump_if_trace))
 928   ,  ( "ddump-tc-trace",         setDumpFlag Opt_D_dump_tc_trace)
 929   ,  ( "ddump-splices",          setDumpFlag Opt_D_dump_splices)
 930   ,  ( "ddump-rn-stats",         NoArg (setDynFlag Opt_D_dump_rn_stats))
 931   ,  ( "ddump-opt-cmm",          setDumpFlag Opt_D_dump_opt_cmm)
 932   ,  ( "ddump-simpl-stats",      setDumpFlag Opt_D_dump_simpl_stats)
 933   ,  ( "ddump-bcos",             setDumpFlag Opt_D_dump_BCOs)
 934   ,  ( "dsource-stats",          setDumpFlag Opt_D_source_stats)
 935   ,  ( "dverbose-core2core",     setDumpFlag Opt_D_verbose_core2core)
 936   ,  ( "dverbose-stg2stg",       setDumpFlag Opt_D_verbose_stg2stg)
 937   ,  ( "ddump-hi-diffs",         NoArg (setDynFlag Opt_D_dump_hi_diffs))
 938   ,  ( "ddump-hi",               setDumpFlag Opt_D_dump_hi)
 939   ,  ( "ddump-minimal-imports",  NoArg (setDynFlag Opt_D_dump_minimal_imports))
 940   ,  ( "ddump-vect",             setDumpFlag Opt_D_dump_vect)
 941   ,  ( "dcore-lint",             NoArg (setDynFlag Opt_DoCoreLinting))
 942   ,  ( "dstg-lint",              NoArg (setDynFlag Opt_DoStgLinting))
 943   ,  ( "dcmm-lint",              NoArg (setDynFlag Opt_DoCmmLinting))
 944   ,  ( "dshow-passes",           NoArg (do setDynFlag Opt_ForceRecomp
 945                                            setVerbosity (Just 2)) )
 946   ,  ( "dfaststring-stats",      NoArg (setDynFlag Opt_D_faststring_stats))
 947
 948         ------ Machine dependant (-m<blah>) stuff ---------------------------
 949
 950   ,  ( "monly-2-regs",  NoArg (upd (\s -> s{stolen_x86_regs = 2}) ))
 951   ,  ( "monly-3-regs",  NoArg (upd (\s -> s{stolen_x86_regs = 3}) ))
 952   ,  ( "monly-4-regs",  NoArg (upd (\s -> s{stolen_x86_regs = 4}) ))
 953
 954         ------ Warning opts -------------------------------------------------
 955   ,  ( "W"              , NoArg (mapM_ setDynFlag   minusWOpts)    )
 956   ,  ( "Werror"         , NoArg (setDynFlag         Opt_WarnIsError) )
 957   ,  ( "Wall"           , NoArg (mapM_ setDynFlag   minusWallOpts) )
 958   ,  ( "Wnot"           , NoArg (mapM_ unSetDynFlag minusWallOpts) ) /* DEPREC */
 959   ,  ( "w"              , NoArg (mapM_ unSetDynFlag minusWallOpts) )
 960
 961         ------ Optimisation flags ------------------------------------------
 962   ,  ( "O"                 , NoArg (upd (setOptLevel 1)))
 963   ,  ( "Onot"              , NoArg (upd (setOptLevel 0)))
 964   ,  ( "O"                 , PrefixPred (all isDigit)
 965                                 (\f -> upd (setOptLevel (read f))))
 966
 967   ,  ( "fmax-simplifier-iterations",
 968                 PrefixPred (all isDigit)
 969                   (\n -> upd (\dfs ->
 970                         dfs{ maxSimplIterations = read n })) )
 971
 972   ,  ( "frule-check",
 973                 SepArg (\s -> upd (\dfs -> dfs{ ruleCheck = Just s })))
 974
 975         ------ Compiler flags -----------------------------------------------
 976
 977   ,  ( "fno-code",      NoArg (setTarget HscNothing))
 978   ,  ( "fasm",          AnySuffix (\_ -> setTarget HscAsm) )
 979   ,  ( "fvia-c",        NoArg (setTarget HscC) )
 980   ,  ( "fvia-C",        NoArg (setTarget HscC) )
 981
 982   ,  ( "fglasgow-exts",    NoArg (mapM_ setDynFlag   glasgowExtsFlags) )
 983   ,  ( "fno-glasgow-exts", NoArg (mapM_ unSetDynFlag glasgowExtsFlags) )
 984
 985   ,  ( "fcontext-stack" , OptIntSuffix $ \mb_n -> upd $ \dfs ->
 986                           dfs{ ctxtStkDepth = mb_n `orElse` 3 })
 987
 988         -- the rest of the -f* and -fno-* flags
 989   ,  ( "fno-",          PrefixPred (\f -> isFFlag f) (\f -> unSetDynFlag (getFFlag f)) )
 990   ,  ( "f",             PrefixPred (\f -> isFFlag f) (\f -> setDynFlag (getFFlag f)) )
 991  ]
 992
 993 -- these -f<blah> flags can all be reversed with -fno-<blah>
 994
 995 fFlags = [
 996   ( "warn-duplicate-exports",           Opt_WarnDuplicateExports ),
 997   ( "warn-hi-shadowing",                Opt_WarnHiShadows ),
 998   ( "warn-incomplete-patterns",         Opt_WarnIncompletePatterns ),
 999   ( "warn-incomplete-record-updates",   Opt_WarnIncompletePatternsRecUpd ),
1000   ( "warn-missing-fields",              Opt_WarnMissingFields ),
1001   ( "warn-missing-methods",             Opt_WarnMissingMethods ),
1002   ( "warn-missing-signatures",          Opt_WarnMissingSigs ),
1003   ( "warn-name-shadowing",              Opt_WarnNameShadowing ),
1004   ( "warn-overlapping-patterns",        Opt_WarnOverlappingPatterns ),
1005   ( "warn-simple-patterns",             Opt_WarnSimplePatterns ),
1006   ( "warn-type-defaults",               Opt_WarnTypeDefaults ),
1007   ( "warn-unused-binds",                Opt_WarnUnusedBinds ),
1008   ( "warn-unused-imports",              Opt_WarnUnusedImports ),
1009   ( "warn-unused-matches",              Opt_WarnUnusedMatches ),
1010   ( "warn-deprecations",                Opt_WarnDeprecations ),
1011   ( "warn-orphans",                     Opt_WarnOrphans ),
1012   ( "fi",                               Opt_FFI ),  -- support `-ffi'...
1013   ( "ffi",                              Opt_FFI ),  -- ...and also `-fffi'
1014   ( "arrows",                           Opt_Arrows ), -- arrow syntax
1015   ( "parr",                             Opt_PArr ),
1016   ( "th",                               Opt_TH ),
1017   ( "implicit-prelude",                 Opt_ImplicitPrelude ),
1018   ( "scoped-type-variables",            Opt_ScopedTypeVariables ),
1019   ( "bang-patterns",                    Opt_BangPatterns ),
1020   ( "indexed-types",                    Opt_IndexedTypes ),
1021   ( "monomorphism-restriction",         Opt_MonomorphismRestriction ),
1022   ( "mono-pat-binds",                   Opt_MonoPatBinds ),
1023   ( "extended-default-rules",           Opt_ExtendedDefaultRules ),
1024   ( "implicit-params",                  Opt_ImplicitParams ),
1025   ( "allow-overlapping-instances",      Opt_AllowOverlappingInstances ),
1026   ( "allow-undecidable-instances",      Opt_AllowUndecidableInstances ),
1027   ( "allow-incoherent-instances",       Opt_AllowIncoherentInstances ),
1028   ( "generics",                         Opt_Generics ),
1029   ( "strictness",                       Opt_Strictness ),
1030   ( "full-laziness",                    Opt_FullLaziness ),
1031   ( "cse",                              Opt_CSE ),
1032   ( "ignore-interface-pragmas",         Opt_IgnoreInterfacePragmas ),
1033   ( "omit-interface-pragmas",           Opt_OmitInterfacePragmas ),
1034   ( "do-lambda-eta-expansion",          Opt_DoLambdaEtaExpansion ),
1035   ( "ignore-asserts",                   Opt_IgnoreAsserts ),
1036   ( "ignore-breakpoints",               Opt_IgnoreBreakpoints),
1037   ( "do-eta-reduction",                 Opt_DoEtaReduction ),
1038   ( "case-merge",                       Opt_CaseMerge ),
1039   ( "unbox-strict-fields",              Opt_UnboxStrictFields ),
1040   ( "dicts-cheap",                      Opt_DictsCheap ),
1041   ( "excess-precision",                 Opt_ExcessPrecision ),
1042   ( "asm-mangling",                     Opt_DoAsmMangling ),
1043   ( "print-bind-result",                Opt_PrintBindResult ),
1044   ( "force-recomp",                     Opt_ForceRecomp )
1045   ]
1046
1047
1048 glasgowExtsFlags = [
1049   Opt_GlasgowExts,
1050   Opt_FFI,
1051   Opt_ImplicitParams,
1052   Opt_ScopedTypeVariables,
1053   Opt_IndexedTypes ]
1054
1055 isFFlag f = f `elem` (map fst fFlags)
1056 getFFlag f = fromJust (lookup f fFlags)
1057
1058 -- -----------------------------------------------------------------------------
1059 -- Parsing the dynamic flags.
1060
1061 parseDynamicFlags :: DynFlags -> [String] -> IO (DynFlags,[String])
1062 parseDynamicFlags dflags args = do
1063   let ((leftover,errs),dflags')
1064           = runCmdLine (processArgs dynamic_flags args) dflags
1065   when (not (null errs)) $ do
1066     throwDyn (UsageError (unlines errs))
1067   return (dflags', leftover)
1068
1069
1070 type DynP = CmdLineP DynFlags
1071
1072 upd :: (DynFlags -> DynFlags) -> DynP ()
1073 upd f = do
1074    dfs <- getCmdLineState
1075    putCmdLineState $! (f dfs)
1076
1077 setDynFlag, unSetDynFlag :: DynFlag -> DynP ()
1078 setDynFlag f   = upd (\dfs -> dopt_set dfs f)
1079 unSetDynFlag f = upd (\dfs -> dopt_unset dfs f)
1080
1081 setDumpFlag :: DynFlag -> OptKind DynP
1082 setDumpFlag dump_flag
1083   = NoArg (setDynFlag Opt_ForceRecomp >> setDynFlag dump_flag)
1084         -- Whenver we -ddump, switch off the recompilation checker,
1085         -- else you don't see the dump!
1086
1087 setVerbosity :: Maybe Int -> DynP ()
1088 setVerbosity mb_n = upd (\dfs -> dfs{ verbosity = mb_n `orElse` 3 })
1089
1090 addCmdlineHCInclude a = upd (\s -> s{cmdlineHcIncludes =  a : cmdlineHcIncludes s})
1091
1092 extraPkgConf_  p = upd (\s -> s{ extraPkgConfs = p : extraPkgConfs s })
1093
1094 exposePackage p =
1095   upd (\s -> s{ packageFlags = ExposePackage p : packageFlags s })
1096 hidePackage p =
1097   upd (\s -> s{ packageFlags = HidePackage p : packageFlags s })
1098 ignorePackage p =
1099   upd (\s -> s{ packageFlags = IgnorePackage p : packageFlags s })
1100
1101 setPackageName p
1102   | Nothing <- unpackPackageId pid
1103   = throwDyn (CmdLineError ("cannot parse \'" ++ p ++ "\' as a package identifier"))
1104   | otherwise
1105   = \s -> s{ thisPackage = pid }
1106   where
1107         pid = stringToPackageId p
1108
1109 -- we can only switch between HscC, and HscAsmm with dynamic flags
1110 -- (-fvia-C, -fasm, -filx respectively).
1111 setTarget l = upd (\dfs -> case hscTarget dfs of
1112                                         HscC   -> dfs{ hscTarget = l }
1113                                         HscAsm -> dfs{ hscTarget = l }
1114                                         _      -> dfs)
1115
1116 setOptLevel :: Int -> DynFlags -> DynFlags
1117 setOptLevel n dflags
1118    | hscTarget dflags == HscInterpreted && n > 0
1119         = dflags
1120             -- not in IO any more, oh well:
1121             -- putStr "warning: -O conflicts with --interactive; -O ignored.\n"
1122    | otherwise
1123         = updOptLevel n dflags
1124
1125
1126 setMainIs :: String -> DynP ()
1127 setMainIs arg
1128   | not (null main_fn)          -- The arg looked like "Foo.baz"
1129   = upd $ \d -> d{ mainFunIs = Just main_fn,
1130                    mainModIs = mkModule mainPackageId (mkModuleName main_mod) }
1131
1132   | isUpper (head main_mod)     -- The arg looked like "Foo"
1133   = upd $ \d -> d{ mainModIs = mkModule mainPackageId (mkModuleName main_mod) }
1134
1135   | otherwise                   -- The arg looked like "baz"
1136   = upd $ \d -> d{ mainFunIs = Just main_mod }
1137   where
1138     (main_mod, main_fn) = splitLongestPrefix arg (== '.')
1139
1140 -----------------------------------------------------------------------------
1141 -- Paths & Libraries
1142
1143 -- -i on its own deletes the import paths
1144 addImportPath "" = upd (\s -> s{importPaths = []})
1145 addImportPath p  = upd (\s -> s{importPaths = importPaths s ++ splitPathList p})
1146
1147
1148 addLibraryPath p =
1149   upd (\s -> s{libraryPaths = libraryPaths s ++ splitPathList p})
1150
1151 addIncludePath p =
1152   upd (\s -> s{includePaths = includePaths s ++ splitPathList p})
1153
1154 addFrameworkPath p =
1155   upd (\s -> s{frameworkPaths = frameworkPaths s ++ splitPathList p})
1156
1157 split_marker = ':'   -- not configurable (ToDo)
1158
1159 splitPathList :: String -> [String]
1160 splitPathList s = filter notNull (splitUp s)
1161                 -- empty paths are ignored: there might be a trailing
1162                 -- ':' in the initial list, for example.  Empty paths can
1163                 -- cause confusion when they are translated into -I options
1164                 -- for passing to gcc.
1165   where
1166 #ifndef mingw32_TARGET_OS
1167     splitUp xs = split split_marker xs
1168 #else
1169      -- Windows: 'hybrid' support for DOS-style paths in directory lists.
1170      --
1171      -- That is, if "foo:bar:baz" is used, this interpreted as
1172      -- consisting of three entries, 'foo', 'bar', 'baz'.
1173      -- However, with "c:/foo:c:\\foo;x:/bar", this is interpreted
1174      -- as 3 elts, "c:/foo", "c:\\foo", "x:/bar"
1175      --
1176      -- Notice that no attempt is made to fully replace the 'standard'
1177      -- split marker ':' with the Windows / DOS one, ';'. The reason being
1178      -- that this will cause too much breakage for users & ':' will
1179      -- work fine even with DOS paths, if you're not insisting on being silly.
1180      -- So, use either.
1181     splitUp []             = []
1182     splitUp (x:':':div:xs) | div `elem` dir_markers
1183                            = ((x:':':div:p): splitUp rs)
1184                            where
1185                               (p,rs) = findNextPath xs
1186           -- we used to check for existence of the path here, but that
1187           -- required the IO monad to be threaded through the command-line
1188           -- parser which is quite inconvenient.  The
1189     splitUp xs = cons p (splitUp rs)
1190                where
1191                  (p,rs) = findNextPath xs
1192
1193                  cons "" xs = xs
1194                  cons x  xs = x:xs
1195
1196     -- will be called either when we've consumed nought or the
1197     -- "<Drive>:/" part of a DOS path, so splitting is just a Q of
1198     -- finding the next split marker.
1199     findNextPath xs =
1200         case break (`elem` split_markers) xs of
1201            (p, d:ds) -> (p, ds)
1202            (p, xs)   -> (p, xs)
1203
1204     split_markers :: [Char]
1205     split_markers = [':', ';']
1206
1207     dir_markers :: [Char]
1208     dir_markers = ['/', '\\']
1209 #endif
1210
1211 -- -----------------------------------------------------------------------------
1212 -- tmpDir, where we store temporary files.
1213
1214 setTmpDir :: FilePath -> DynFlags -> DynFlags
1215 setTmpDir dir dflags = dflags{ tmpDir = canonicalise dir }
1216   where
1217 #if !defined(mingw32_HOST_OS)
1218      canonicalise p = normalisePath p
1219 #else
1220         -- Canonicalisation of temp path under win32 is a bit more
1221         -- involved: (a) strip trailing slash,
1222         --           (b) normalise slashes
1223         --           (c) just in case, if there is a prefix /cygdrive/x/, change to x:
1224         --
1225      canonicalise path = normalisePath (xltCygdrive (removeTrailingSlash path))
1226
1227         -- if we're operating under cygwin, and TMP/TEMP is of
1228         -- the form "/cygdrive/drive/path", translate this to
1229         -- "drive:/path" (as GHC isn't a cygwin app and doesn't
1230         -- understand /cygdrive paths.)
1231      xltCygdrive path
1232       | "/cygdrive/" `isPrefixOf` path =
1233           case drop (length "/cygdrive/") path of
1234             drive:xs@('/':_) -> drive:':':xs
1235             _ -> path
1236       | otherwise = path
1237
1238         -- strip the trailing backslash (awful, but we only do this once).
1239      removeTrailingSlash path =
1240        case last path of
1241          '/'  -> init path
1242          '\\' -> init path
1243          _    -> path
1244 #endif
1245
1246 -----------------------------------------------------------------------------
1247 -- Via-C compilation stuff
1248
1249 machdepCCOpts :: DynFlags -> ([String], -- flags for all C compilations
1250                               [String]) -- for registerised HC compilations
1251 machdepCCOpts dflags
1252 #if alpha_TARGET_ARCH
1253         =       ( ["-w", "-mieee"
1254 #ifdef HAVE_THREADED_RTS_SUPPORT
1255                     , "-D_REENTRANT"
1256 #endif
1257                    ], [] )
1258         -- For now, to suppress the gcc warning "call-clobbered
1259         -- register used for global register variable", we simply
1260         -- disable all warnings altogether using the -w flag. Oh well.
1261
1262 #elif hppa_TARGET_ARCH
1263         -- ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1264         -- (very nice, but too bad the HP /usr/include files don't agree.)
1265         = ( ["-D_HPUX_SOURCE"], [] )
1266
1267 #elif m68k_TARGET_ARCH
1268       -- -fno-defer-pop : for the .hc files, we want all the pushing/
1269       --    popping of args to routines to be explicit; if we let things
1270       --    be deferred 'til after an STGJUMP, imminent death is certain!
1271       --
1272       -- -fomit-frame-pointer : *don't*
1273       --     It's better to have a6 completely tied up being a frame pointer
1274       --     rather than let GCC pick random things to do with it.
1275       --     (If we want to steal a6, then we would try to do things
1276       --     as on iX86, where we *do* steal the frame pointer [%ebp].)
1277         = ( [], ["-fno-defer-pop", "-fno-omit-frame-pointer"] )
1278
1279 #elif i386_TARGET_ARCH
1280       -- -fno-defer-pop : basically the same game as for m68k
1281       --
1282       -- -fomit-frame-pointer : *must* in .hc files; because we're stealing
1283       --   the fp (%ebp) for our register maps.
1284         =  let n_regs = stolen_x86_regs dflags
1285                sta = opt_Static
1286            in
1287                     ( [ if sta then "-DDONT_WANT_WIN32_DLL_SUPPORT" else ""
1288 --                    , if suffixMatch "mingw32" cTARGETPLATFORM then "-mno-cygwin" else ""
1289                       ],
1290                       [ "-fno-defer-pop",
1291 #ifdef HAVE_GCC_MNO_OMIT_LFPTR
1292                         -- Some gccs are configured with
1293                         -- -momit-leaf-frame-pointer on by default, and it
1294                         -- apparently takes precedence over
1295                         -- -fomit-frame-pointer, so we disable it first here.
1296                         "-mno-omit-leaf-frame-pointer",
1297 #endif
1298 #ifdef HAVE_GCC_HAS_NO_UNIT_AT_A_TIME
1299                         "-fno-unit-at-a-time",
1300                         -- unit-at-a-time doesn't do us any good, and screws
1301                         -- up -split-objs by moving the split markers around.
1302                         -- It's only turned on with -O2, but put it here just
1303                         -- in case someone uses -optc-O2.
1304 #endif
1305                         "-fomit-frame-pointer",
1306                         -- we want -fno-builtin, because when gcc inlines
1307                         -- built-in functions like memcpy() it tends to
1308                         -- run out of registers, requiring -monly-n-regs
1309                         "-fno-builtin",
1310                         "-DSTOLEN_X86_REGS="++show n_regs ]
1311                     )
1312
1313 #elif ia64_TARGET_ARCH
1314         = ( [], ["-fomit-frame-pointer", "-G0"] )
1315
1316 #elif x86_64_TARGET_ARCH
1317         = ( [], ["-fomit-frame-pointer",
1318                  "-fno-asynchronous-unwind-tables",
1319                         -- the unwind tables are unnecessary for HC code,
1320                         -- and get in the way of -split-objs.  Another option
1321                         -- would be to throw them away in the mangler, but this
1322                         -- is easier.
1323 #ifdef HAVE_GCC_HAS_NO_UNIT_AT_A_TIME
1324                  "-fno-unit-at-a-time",
1325                         -- unit-at-a-time doesn't do us any good, and screws
1326                         -- up -split-objs by moving the split markers around.
1327                         -- It's only turned on with -O2, but put it here just
1328                         -- in case someone uses -optc-O2.
1329 #endif
1330                  "-fno-builtin"
1331                         -- calling builtins like strlen() using the FFI can
1332                         -- cause gcc to run out of regs, so use the external
1333                         -- version.
1334                 ] )
1335
1336 #elif mips_TARGET_ARCH
1337         = ( ["-static"], [] )
1338
1339 #elif sparc_TARGET_ARCH
1340         = ( [], ["-w"] )
1341         -- For now, to suppress the gcc warning "call-clobbered
1342         -- register used for global register variable", we simply
1343         -- disable all warnings altogether using the -w flag. Oh well.
1344
1345 #elif powerpc_apple_darwin_TARGET
1346       -- -no-cpp-precomp:
1347       --     Disable Apple's precompiling preprocessor. It's a great thing
1348       --     for "normal" programs, but it doesn't support register variable
1349       --     declarations.
1350         = ( [], ["-no-cpp-precomp"] )
1351 #else
1352         = ( [], [] )
1353 #endif
1354
1355 picCCOpts :: DynFlags -> [String]
1356 picCCOpts dflags
1357 #if darwin_TARGET_OS
1358       -- Apple prefers to do things the other way round.
1359       -- PIC is on by default.
1360       -- -mdynamic-no-pic:
1361       --     Turn off PIC code generation.
1362       -- -fno-common:
1363       --     Don't generate "common" symbols - these are unwanted
1364       --     in dynamic libraries.
1365
1366     | opt_PIC
1367         = ["-fno-common"]
1368     | otherwise
1369         = ["-mdynamic-no-pic"]
1370 #elif mingw32_TARGET_OS
1371       -- no -fPIC for Windows
1372         = []
1373 #else
1374     | opt_PIC
1375         = ["-fPIC"]
1376     | otherwise
1377         = []
1378 #endif
1379
1380 -- -----------------------------------------------------------------------------
1381 -- Splitting
1382
1383 can_split :: Bool
1384 can_split =
1385 #if    defined(i386_TARGET_ARCH)     \
1386     || defined(x86_64_TARGET_ARCH)   \
1387     || defined(alpha_TARGET_ARCH)    \
1388     || defined(hppa_TARGET_ARCH)     \
1389     || defined(m68k_TARGET_ARCH)     \
1390     || defined(mips_TARGET_ARCH)     \
1391     || defined(powerpc_TARGET_ARCH)  \
1392     || defined(rs6000_TARGET_ARCH)   \
1393     || defined(sparc_TARGET_ARCH)
1394    True
1395 #else
1396    False
1397 #endif
1398