DynFlags.hs 85.8 KB
Newer Older
1

2
-- |
3 4 5 6 7 8
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

9
-- Most flags are dynamic flags, which means they can change from
10 11 12
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
13
module DynFlags (
14
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
15 16 17 18 19 20 21 22
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
23
        fFlags, xFlags,
24
        dphPackage,
25

26
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
27 28 29 30 31
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

        dopt,                           -- DynFlag -> DynFlags -> Bool
        dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
32
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
33
        getVerbFlag,
34
        getMainFun,
Ian Lynagh's avatar
Ian Lynagh committed
35 36 37 38
        updOptLevel,
        setTmpDir,
        setPackageName,

39
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
40
        parseDynamicFlags,
41
        allFlags,
42

43 44 45
        supportedLanguages, languageOptions,

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
46
        machdepCCOpts, picCCOpts,
47 48 49 50 51 52 53 54 55 56 57 58 59 60

        -- * Configuration of the core-to-core passes
        CoreToDo(..),
        SimplifierMode(..),
        SimplifierSwitch(..),
        FloatOutSwitches(..),
        getCoreToDo,

        -- * Configuration of the stg-to-stg passes
        StgToDo(..),
        getStgToDo,

        -- * Compiler configuration suitable for display to the user
        compilerInfo
61 62 63 64
  ) where

#include "HsVersions.h"

65
import Module
Simon Marlow's avatar
Simon Marlow committed
66
import PackageConfig
67 68 69
import PrelNames        ( mAIN, main_RDR_Unqual )
import RdrName          ( RdrName, mkRdrUnqual )
import OccName          ( mkVarOccFS )
Simon Marlow's avatar
Simon Marlow committed
70
#ifdef i386_TARGET_ARCH
Ian Lynagh's avatar
Ian Lynagh committed
71
import StaticFlags      ( opt_Static )
Simon Marlow's avatar
Simon Marlow committed
72
#endif
Ian Lynagh's avatar
Ian Lynagh committed
73 74
import StaticFlags      ( opt_PIC, WayName(..), v_Ways, v_Build_tag,
                          v_RTS_Build_tag )
75
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
76
import DriverPhases     ( Phase(..), phaseInputExt )
77 78
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
79
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
80
import Panic
81
import UniqFM           ( UniqFM )
82
import Util
83
import Maybes           ( orElse )
84
import SrcLoc
85
import FastString
Simon Marlow's avatar
Simon Marlow committed
86 87
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
88

Ian Lynagh's avatar
Ian Lynagh committed
89 90
import Data.IORef       ( readIORef )
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
91

92
import Data.Char
Ian Lynagh's avatar
Ian Lynagh committed
93
import System.FilePath
94
import System.IO        ( stderr, hPutChar )
95

96 97 98
-- -----------------------------------------------------------------------------
-- DynFlags

99
-- | Enumerates the simple on-or-off dynamic flags
100 101 102 103
data DynFlag

   -- debugging flags
   = 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 110
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
111
   | Opt_D_dump_asm_coalesce
112 113 114
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
115
   | Opt_D_dump_asm_stats
116 117 118 119 120 121
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
122
   | Opt_D_dump_rule_firings
123 124 125 126 127
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
128
   | Opt_D_dump_simpl_phases
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
   | Opt_D_dump_stranal
   | Opt_D_dump_tc
   | Opt_D_dump_types
   | Opt_D_dump_rules
   | Opt_D_dump_cse
   | Opt_D_dump_worker_wrapper
   | Opt_D_dump_rn_trace
   | Opt_D_dump_rn_stats
   | Opt_D_dump_opt_cmm
   | Opt_D_dump_simpl_stats
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
147
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
148
   | Opt_D_dump_rtti
149 150 151 152 153 154
   | Opt_D_source_stats
   | Opt_D_verbose_core2core
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
   | Opt_D_dump_minimal_imports
155
   | Opt_D_dump_mod_cycles
156
   | Opt_D_dump_view_pattern_commoning
157
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
158
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
159
   | Opt_D_no_debug_output
160 161 162
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
163
   | Opt_DoAsmLinting
164

Ian Lynagh's avatar
Ian Lynagh committed
165
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
166 167
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
168
   | Opt_WarnImplicitPrelude
169 170 171 172 173 174 175 176 177
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
178
   | Opt_WarnMonomorphism
179 180 181
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
182
   | Opt_WarnWarningsDeprecations
183
   | Opt_WarnDeprecatedFlags
184 185
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
186
   | Opt_WarnTabs
187
   | Opt_WarnUnrecognisedPragmas
188
   | Opt_WarnDodgyForeignImports
189 190

   -- language opts
191 192 193
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
194
   | Opt_MonomorphismRestriction
195
   | Opt_MonoPatBinds
Ian Lynagh's avatar
Ian Lynagh committed
196
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
197
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
198
   | Opt_UnliftedFFITypes
Ian Lynagh's avatar
Ian Lynagh committed
199 200
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
201
   | Opt_TemplateHaskell
202
   | Opt_QuasiQuotes
203
   | Opt_ImplicitParams
204
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
205
   | Opt_ImplicitPrelude
206
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
207
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
208
   | Opt_BangPatterns
209
   | Opt_TypeFamilies
210
   | Opt_OverloadedStrings
211
   | Opt_DisambiguateRecordFields
212
   | Opt_RecordWildCards
213
   | Opt_RecordPuns
214
   | Opt_ViewPatterns
215
   | Opt_GADTs
216
   | Opt_RelaxedPolyRec
217
   | Opt_StandaloneDeriving
218
   | Opt_DeriveDataTypeable
219
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
220
   | Opt_FlexibleContexts
221
   | Opt_FlexibleInstances
222
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
223
   | Opt_MultiParamTypeClasses
224
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
225
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
226
   | Opt_PolymorphicComponents
227
   | Opt_ExistentialQuantification
228
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
229
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
230
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
231
   | Opt_ParallelListComp
232
   | Opt_TransformListComp
233
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
234
   | Opt_RecursiveDo
235
   | Opt_PostfixOperators
Ian Lynagh's avatar
Ian Lynagh committed
236
   | Opt_PatternGuards
237
   | Opt_LiberalTypeSynonyms
238 239
   | Opt_Rank2Types
   | Opt_RankNTypes
240
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
241
   | Opt_TypeOperators
242
   | Opt_PackageImports
243

244 245
   | Opt_PrintExplicitForalls

246 247 248
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
249
   | Opt_StaticArgumentTransformation
250
   | Opt_CSE
251 252
   | Opt_LiberateCase
   | Opt_SpecConstr
253 254 255 256 257 258 259
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
260
   | Opt_MethodSharing
261
   | Opt_DictsCheap
262
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
263
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
264 265
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
266 267 268 269

   -- misc opts
   | Opt_Cpp
   | Opt_Pp
270
   | Opt_ForceRecomp
271 272 273 274 275 276 277
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
278
   | Opt_HideAllPackages
279
   | Opt_PrintBindResult
280
   | Opt_Haddock
David Waern's avatar
David Waern committed
281
   | Opt_HaddockOptions
282
   | Opt_Hpc_No_Auto
283
   | Opt_BreakOnException
284
   | Opt_BreakOnError
285
   | Opt_PrintEvldWithShow
286
   | Opt_PrintBindContents
287 288
   | Opt_GenManifest
   | Opt_EmbedManifest
289 290
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
291
   | Opt_AutoLinkPackages
292
   | Opt_ImplicitImportQualified
293 294 295 296 297 298 299

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
300
   | Opt_KeepRawTokenStream
301

302
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
303

304 305
-- | Contains not only a collection of 'DynFlag's but also a plethora of
-- information relating to the compilation of a single file or GHC session
306
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
307 308 309 310 311
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
312
  hscOutName            :: String,      -- ^ Name of the output file
313
  extCoreName           :: String,      -- ^ Name of the .hcr output file
314 315 316 317
  verbosity             :: Int,         -- ^ Verbosity level: see "DynFlags#verbosity_levels"
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
318
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
319
  ruleCheck             :: Maybe String,
320

321 322 323
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
324

Ian Lynagh's avatar
Ian Lynagh committed
325
  stolen_x86_regs       :: Int,
326
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
327 328 329
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
330
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
331

332 333
  dphBackend            :: DPHBackend,

334
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
335 336

  -- ways
337 338 339
  wayNames              :: [WayName],   -- ^ Way flags from the command line
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
340

341
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
342 343 344
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
345

Ian Lynagh's avatar
Ian Lynagh committed
346 347 348
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
349

Ian Lynagh's avatar
Ian Lynagh committed
350 351 352
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
353

354
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
355 356
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
357

358 359
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
360 361 362 363 364 365 366 367
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto
  tmpDir                :: String,      -- no trailing '/'

368 369 370
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

371
  hpcDir                :: String,      -- ^ Path to store the .mix files
andy@galois.com's avatar
andy@galois.com committed
372

373
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
374 375 376 377 378 379 380 381
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
382 383

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
384 385 386 387 388 389 390 391 392
  pgm_L                 :: String,
  pgm_P                 :: (String,[Option]),
  pgm_F                 :: String,
  pgm_c                 :: (String,[Option]),
  pgm_m                 :: (String,[Option]),
  pgm_s                 :: (String,[Option]),
  pgm_a                 :: (String,[Option]),
  pgm_l                 :: (String,[Option]),
  pgm_dll               :: (String,[Option]),
393 394
  pgm_T                 :: String,
  pgm_sysman            :: String,
395
  pgm_windres           :: String,
396

397 398 399 400 401 402 403
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],
  depWarnings           :: Bool,

404
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
405
  extraPkgConfs         :: [FilePath],
406 407
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
408
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
409
        -- they appeared.
410

Ian Lynagh's avatar
Ian Lynagh committed
411
  packageFlags          :: [PackageFlag],
412
        -- ^ The @-package@ and @-hide-package@ flags from the command-line
413

414
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
415
  -- NB. do not modify this field, it is calculated by
416
  -- Packages.initPackages and Packages.updatePackages.
417
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
418
  pkgState              :: PackageState,
419 420

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
421 422
  flags                 :: [DynFlag],

423
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
424 425 426
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
427 428 429 430 431 432 433 434 435 436
 }

data HscTarget
  = HscC
  | HscAsm
  | HscJava
  | HscInterpreted
  | HscNothing
  deriving (Eq, Show)

437
-- | Will this target result in an object file on the disk?
438 439 440 441 442 443 444 445 446 447 448
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
isObjectTarget _        = False

-- | The 'GhcMode' tells us whether we're doing multi-module
-- compilation (controlled via the "GHC" API) or one-shot
-- (single-module) compilation.  This makes a difference primarily to
-- the "Finder": in one-shot mode we look for interface files for
-- imported modules, but in multi-module mode we look for source files
-- in order to check whether they need to be recompiled.
449
data GhcMode
450 451 452
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
453 454
  deriving Eq

455 456 457 458 459
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

460 461 462 463
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

464 465 466 467 468 469
-- | What to do in the link step, if there is one.
data GhcLink
  = NoLink              -- ^ Don't link at all
  | LinkBinary          -- ^ Link object code into a binary
  | LinkInMemory        -- ^ Use the in-memory dynamic linker
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
470
  deriving (Eq, Show)
471 472 473

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
474
isNoLink _      = False
475 476 477 478 479

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
480
  deriving Eq
481

twanvl's avatar
twanvl committed
482
defaultHscTarget :: HscTarget
483 484
defaultHscTarget = defaultObjectTarget

485
-- | The 'HscTarget' value corresponding to the default way to create
486
-- object files on the current platform.
twanvl's avatar
twanvl committed
487
defaultObjectTarget :: HscTarget
488
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
489 490
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
491

492 493 494 495 496 497
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

498
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
499
initDynFlags :: DynFlags -> IO DynFlags
500 501 502 503 504 505
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
 build_tag <- readIORef v_Build_tag
 rts_build_tag <- readIORef v_RTS_Build_tag
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
506 507 508 509
        wayNames        = ways,
        buildTag        = build_tag,
        rtsBuildTag     = rts_build_tag
        }
510

511 512
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
twanvl's avatar
twanvl committed
513
defaultDynFlags :: DynFlags
514 515
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
516 517 518 519 520 521 522 523 524
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
525
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
526
        maxSimplIterations      = 4,
527
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
528 529 530
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
531
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
532 533 534 535 536 537 538
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

539 540
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
        hiDir                   = Nothing,
        stubDir                 = Nothing,

        objectSuf               = phaseInputExt StopLn,
        hcSuf                   = phaseInputExt HCc,
        hiSuf                   = "hi",

        outputFile              = Nothing,
        outputHi                = Nothing,
        dynLibLoader            = Deployable,
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
                                   then ["-D__PIC__"]
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
573
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
574 575 576

        extraPkgConfs           = [],
        packageFlags            = [],
577 578
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
579 580 581 582 583 584 585
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
586
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
587 588 589 590 591 592 593 594 595 596 597 598 599
        pgm_L                   = panic "defaultDynFlags: No pgm_L",
        pgm_P                   = panic "defaultDynFlags: No pgm_P",
        pgm_F                   = panic "defaultDynFlags: No pgm_F",
        pgm_c                   = panic "defaultDynFlags: No pgm_c",
        pgm_m                   = panic "defaultDynFlags: No pgm_m",
        pgm_s                   = panic "defaultDynFlags: No pgm_s",
        pgm_a                   = panic "defaultDynFlags: No pgm_a",
        pgm_l                   = panic "defaultDynFlags: No pgm_l",
        pgm_dll                 = panic "defaultDynFlags: No pgm_dll",
        pgm_T                   = panic "defaultDynFlags: No pgm_T",
        pgm_sysman              = panic "defaultDynFlags: No pgm_sysman",
        pgm_windres             = panic "defaultDynFlags: No pgm_windres",
        -- end of initSysTools values
600 601 602 603 604 605 606
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        depWarnings       = True,
        -- end of ghc -M values
Ian Lynagh's avatar
Ian Lynagh committed
607
        haddockOptions = Nothing,
608
        flags = [
609
            Opt_AutoLinkPackages,
610 611 612 613 614 615 616 617 618
            Opt_ReadUserPackageConf,

            Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
                                -- behaviour the default, to see if anyone notices
                                -- SLPJ July 06

            Opt_ImplicitPrelude,
            Opt_MonomorphismRestriction,

619 620
            Opt_MethodSharing,

621 622
            Opt_DoAsmMangling,

623
            Opt_GenManifest,
624 625
            Opt_EmbedManifest,
            Opt_PrintBindContents
626 627 628 629 630
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
631
        log_action = \severity srcSpan style msg ->
632
                        case severity of
633 634 635 636 637 638 639 640
                          SevInfo  -> printErrs (msg style)
                          SevFatal -> printErrs (msg style)
                          _        -> do 
                                hPutChar stderr '\n'
                                printErrs ((mkLocMessage srcSpan msg) style)
                     -- careful (#2302): printErrs prints in UTF-8, whereas
                     -- converting to string first and using hPutStr would
                     -- just emit the low 8 bits of each unicode char.
641 642
      }

Ian Lynagh's avatar
Ian Lynagh committed
643
{-
644
    #verbosity_levels#
645
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
646 647

    0   |   print errors & warnings only
648 649 650 651 652 653 654
    1   |   minimal verbosity: print "compiling M ... done." for each module.
    2   |   equivalent to -dshow-passes
    3   |   equivalent to existing "ghc -v"
    4   |   "ghc -v -ddump-most"
    5   |   "ghc -v -ddump-all"
-}

655
-- | Test whether a 'DynFlag' is set
656 657 658
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

659
-- | Set a 'DynFlag'
660 661 662
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

663
-- | Unset a 'DynFlag'
664 665 666
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

667 668 669 670
-- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
        -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
        -> [a]                  -- ^ Correctly ordered extracted options
671
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
672
        -- We add to the options from the front, so we need to reverse the list
673

674 675
-- | Gets the verbosity flag for the current verbosity level. This is fed to
-- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
676
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
677 678
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
679 680
  | otherwise =  ""

twanvl's avatar
twanvl committed
681 682
setObjectDir, setHiDir, setStubDir, setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
683
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
684 685 686 687 688
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

689 690 691 692
setObjectDir  f d = d{ objectDir  = Just f}
setHiDir      f d = d{ hiDir      = Just f}
setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
  -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
Thomas Schilling's avatar
Thomas Schilling committed
693
  -- \#included from the .hc file when compiling with -fvia-C.
694

695 696
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
697 698 699 700
setHcSuf      f d = d{ hcSuf      = f}

setOutputFile f d = d{ outputFile = f}
setOutputHi   f d = d{ outputHi   = f}
701

702 703 704 705 706 707 708 709 710
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
   ("wrapped", "")      -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", "hard") -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", flex)   -> d{ dynLibLoader = Wrapped (Just flex) }
   (_,_)                -> error "Unknown dynlib loader"

711 712
setDumpPrefixForce f d = d { dumpPrefixForce = f}

713 714 715 716 717 718 719 720 721 722 723 724
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}

setPgmL   f d = d{ pgm_L   = f}
setPgmF   f d = d{ pgm_F   = f}
setPgmc   f d = d{ pgm_c   = (f,[])}
setPgmm   f d = d{ pgm_m   = (f,[])}
setPgms   f d = d{ pgm_s   = (f,[])}
setPgma   f d = d{ pgm_a   = (f,[])}
setPgml   f d = d{ pgm_l   = (f,[])}
setPgmdll f d = d{ pgm_dll = (f,[])}
725
setPgmwindres f d = d{ pgm_windres = f}
726 727 728 729 730 731 732 733

addOptL   f d = d{ opt_L   = f : opt_L d}
addOptP   f d = d{ opt_P   = f : opt_P d}
addOptF   f d = d{ opt_F   = f : opt_F d}
addOptc   f d = d{ opt_c   = f : opt_c d}
addOptm   f d = d{ opt_m   = f : opt_m d}
addOpta   f d = d{ opt_a   = f : opt_a d}
addOptl   f d = d{ opt_l   = f : opt_l d}
734
addOptwindres f d = d{ opt_windres = f : opt_windres d}
735

736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }

addDepExcludeMod :: String -> DynFlags -> DynFlags
addDepExcludeMod m d
    = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }

addDepSuffix :: FilePath -> DynFlags -> DynFlags
addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }

setDepWarnings :: Bool -> DynFlags -> DynFlags
setDepWarnings b d = d { depWarnings = b }

-- XXX Legacy code:
-- We used to use "-optdep-flag -optdeparg", so for legacy applications
-- we need to strip the "-optdep" off of the arg
deOptDep :: String -> String
deOptDep x = case maybePrefixMatch "-optdep" x of
             Just rest -> rest
             Nothing -> x

760 761
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
762 763
addHaddockOpts f d = d{ haddockOptions = Just f}

764 765 766
-- -----------------------------------------------------------------------------
-- Command-line options

767
-- | When invoking external tools as part of the compilation pipeline, we
768 769
-- pass these a sequence of options on the command-line. Rather than
-- just using a list of Strings, we use a type that allows us to distinguish
770
-- between filepaths and 'other stuff'. The reason for this is that
771
-- this type gives us a handle on transforming filenames, and filenames only,
772
-- to whatever format they're expected to be on a particular platform.
773 774
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
775 776 777
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
778
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
779

780 781 782 783
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
784
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
785
updOptLevel n dfs
786
  = dfs2{ optLevel = final_n }
787
  where
Ian Lynagh's avatar
Ian Lynagh committed
788
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
789 790 791
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

792 793
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
Ian Lynagh's avatar
Ian Lynagh committed
794

795 796
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
797
  = [ ([0],     Opt_IgnoreInterfacePragmas)
798
    , ([0],     Opt_OmitInterfacePragmas)
799

Ian Lynagh's avatar
Ian Lynagh committed
800
    , ([1,2],   Opt_IgnoreAsserts)
801 802
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
803 804 805 806 807
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
808

Ian Lynagh's avatar
Ian Lynagh committed
809 810
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
811 812 813 814 815 816 817 818 819 820

--     , ([2],     Opt_StaticArgumentTransformation)
-- Max writes: I think it's probably best not to enable SAT with -O2 for the
-- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
-- several improvements to the heuristics, and I'm concerned that without
-- those changes SAT will interfere with some attempts to write "high
-- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
-- this year. In particular, the version in HEAD lacks the tail call
-- criterion, so many things that look like reasonable loops will be
-- turned into functions with extra (unneccesary) thunk creation.
821 822

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
823 824 825 826
                -- This one is important for a tiresome reason:
                -- we want to make sure that the bindings for data
                -- constructors are eta-expanded.  This is probably
                -- a good thing anyway, but it seems fragile.
827 828 829 830 831
    ]

-- -----------------------------------------------------------------------------
-- Standard sets of warning options

twanvl's avatar
twanvl committed
832
standardWarnings :: [DynFlag]
833
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
834
    = [ Opt_WarnWarningsDeprecations,
835
        Opt_WarnDeprecatedFlags,
836
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
837 838 839
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
840 841
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
842 843
      ]

twanvl's avatar
twanvl committed
844
minusWOpts :: [DynFlag]
845
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
846 847 848 849 850 851
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
852 853
      ]

twanvl's avatar
twanvl committed
854
minusWallOpts :: [DynFlag]
855 856
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
857 858 859 860 861
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
862 863
      ]

864
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
865
minuswRemovesOpts :: [DynFlag]
866 867 868 869 870 871
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
872
       Opt_WarnUnrecognisedPragmas,
873 874 875
       Opt_WarnTabs
      ]

876 877 878
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
879 880 881
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
882

Ian Lynagh's avatar
Ian Lynagh committed
883 884 885 886 887
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
888 889 890 891 892 893 894 895 896 897 898 899
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
900 901
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
902
  | CoreDoVectorisation PackageId