DynFlags.hs 91.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
        updOptLevel,
        setTmpDir,
        setPackageName,
38
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
39

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

45 46 47
        supportedLanguages, languageOptions,

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

        -- * 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
63 64 65 66
  ) where

#include "HsVersions.h"

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

92
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
93
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
94

95
import Data.Char
96
import Data.List        ( intersperse )
Ian Lynagh's avatar
Ian Lynagh committed
97
import System.FilePath
98
import System.IO        ( stderr, hPutChar )
99

100 101 102
-- -----------------------------------------------------------------------------
-- DynFlags

103
-- | Enumerates the simple on-or-off dynamic flags
104 105 106 107
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
108
   | Opt_D_dump_cmmz
109
   | Opt_D_dump_cmmz_pretty
110
   | Opt_D_dump_cps_cmm
111
   | Opt_D_dump_cvt_cmm
112
   | Opt_D_dump_asm
113 114
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
115
   | Opt_D_dump_asm_coalesce
116 117 118
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
119
   | Opt_D_dump_asm_stats
120 121 122 123 124 125
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
126
   | Opt_D_dump_rule_firings
127 128 129 130 131
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
132
   | Opt_D_dump_simpl_phases
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
   | 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
151
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
152
   | Opt_D_dump_rtti
153 154 155 156 157 158
   | 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
159
   | Opt_D_dump_mod_cycles
160
   | Opt_D_dump_view_pattern_commoning
161
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
162
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
163
   | Opt_D_no_debug_output
164 165 166
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
167
   | Opt_DoAsmLinting
168

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

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

249 250
   | Opt_PrintExplicitForalls

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

Ian Lynagh's avatar
Ian Lynagh committed
273 274 275 276 277
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

278 279 280
   -- misc opts
   | Opt_Cpp
   | Opt_Pp
281
   | Opt_ForceRecomp
282 283 284
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
285
   | Opt_EagerBlackHoling
286 287 288 289
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
290
   | Opt_HideAllPackages
291
   | Opt_PrintBindResult
292
   | Opt_Haddock
David Waern's avatar
David Waern committed
293
   | Opt_HaddockOptions
294
   | Opt_Hpc_No_Auto
295
   | Opt_BreakOnException
296
   | Opt_BreakOnError
297
   | Opt_PrintEvldWithShow
298
   | Opt_PrintBindContents
299 300
   | Opt_GenManifest
   | Opt_EmbedManifest
301 302 303

	-- temporary flags
   | Opt_RunCPS
304 305
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
306
   | Opt_AutoLinkPackages
307
   | Opt_ImplicitImportQualified
308
   | Opt_TryNewCodeGen
309 310 311 312 313 314 315

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
316
   | Opt_KeepRawTokenStream
317

318
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
319

320 321
-- | 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
322
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
323 324 325 326 327
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
328
  hscOutName            :: String,      -- ^ Name of the output file
329
  extCoreName           :: String,      -- ^ Name of the .hcr output file
330 331 332 333
  verbosity             :: Int,         -- ^ Verbosity level: see "DynFlags#verbosity_levels"
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
334
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
335
  ruleCheck             :: Maybe String,
336

337 338 339
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
340

Ian Lynagh's avatar
Ian Lynagh committed
341
  stolen_x86_regs       :: Int,
342
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
343 344 345
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
346
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
347

348 349
  dphBackend            :: DPHBackend,

350
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
351 352

  -- ways
353 354 355
  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
356

357 358 359
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

360
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
361 362 363
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
364

Ian Lynagh's avatar
Ian Lynagh committed
365 366 367
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
368

Ian Lynagh's avatar
Ian Lynagh committed
369 370 371
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
372

373
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
374 375
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
376

377 378
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
379 380 381 382 383 384 385 386
  dumpPrefixForce       :: Maybe FilePath,

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

387 388 389
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

392
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
393 394 395 396 397 398 399 400
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
401 402

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
403 404 405 406 407 408 409 410 411
  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]),
412 413
  pgm_T                 :: String,
  pgm_sysman            :: String,
414
  pgm_windres           :: String,
415

416 417 418 419 420 421
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

422
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
423
  extraPkgConfs         :: [FilePath],
424 425
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
426
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
427
        -- they appeared.
428

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

432
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
433
  -- NB. do not modify this field, it is calculated by
434
  -- Packages.initPackages and Packages.updatePackages.
435
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
436
  pkgState              :: PackageState,
437

438 439 440 441 442 443
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
  dirsToClean           :: IORef (FiniteMap FilePath FilePath),

444
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
445 446
  flags                 :: [DynFlag],

447
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
448 449 450
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
451 452
 }

453 454
-- | The target code type of the compilation (if any).
--
455 456 457
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
458 459 460 461
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
462 463 464
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
465
--
466 467 468 469 470 471
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
472
--
473
data HscTarget
474 475 476 477 478
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
479 480
  deriving (Eq, Show)

481
-- | Will this target result in an object file on the disk?
482 483 484 485 486 487 488 489 490 491 492
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.
493
data GhcMode
494 495 496
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
497 498
  deriving Eq

499 500 501 502 503
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

504 505 506 507
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

508 509 510 511
-- | 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
512 513
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
514
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
515
  deriving (Eq, Show)
516 517 518

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
519
isNoLink _      = False
520

521 522 523 524 525
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

526 527 528 529
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
530
  deriving Eq
531

twanvl's avatar
twanvl committed
532
defaultHscTarget :: HscTarget
533 534
defaultHscTarget = defaultObjectTarget

535
-- | The 'HscTarget' value corresponding to the default way to create
536
-- object files on the current platform.
twanvl's avatar
twanvl committed
537
defaultObjectTarget :: HscTarget
538
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
539 540
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
541

542 543 544 545 546 547
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

548
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
549
initDynFlags :: DynFlags -> IO DynFlags
550 551 552 553 554
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
555 556
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
557
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
558 559
        wayNames        = ways,
        buildTag        = build_tag,
560 561 562
        rtsBuildTag     = rts_build_tag,
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
563
        }
564

565 566
-- | 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
567
defaultDynFlags :: DynFlags
568 569
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
570 571 572 573 574 575 576 577 578
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
579
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
580
        maxSimplIterations      = 4,
581
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
582 583 584
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
585
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
586 587 588 589 590 591 592
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

593 594
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
        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
620
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
621 622 623 624 625 626
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
627
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
628 629 630

        extraPkgConfs           = [],
        packageFlags            = [],
631 632
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
633 634 635
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
636
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
637 638 639 640
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
641
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
642 643 644 645 646 647 648 649 650 651 652 653 654
        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
655 656 657 658 659 660
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
661 662
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
663
        haddockOptions = Nothing,
664
        flags = [
665
            Opt_AutoLinkPackages,
666 667 668 669 670 671 672 673 674
            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,

675 676
            Opt_MethodSharing,

677 678
            Opt_DoAsmMangling,

679
            Opt_GenManifest,
680 681
            Opt_EmbedManifest,
            Opt_PrintBindContents
682 683 684 685 686
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
687
        log_action = \severity srcSpan style msg ->
688
                        case severity of
689 690 691 692 693 694 695 696
                          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.
697 698
      }

Ian Lynagh's avatar
Ian Lynagh committed
699
{-
700
    #verbosity_levels#
701
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
702 703

    0   |   print errors & warnings only
704 705 706 707 708 709 710
    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"
-}

711
-- | Test whether a 'DynFlag' is set
712 713 714
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

715
-- | Set a 'DynFlag'
716 717 718
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

719
-- | Unset a 'DynFlag'
720 721 722
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

723 724 725 726
-- | 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
727
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
728
        -- We add to the options from the front, so we need to reverse the list
729

730 731
-- | 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
732
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
733 734
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
735 736
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
737 738
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
739
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
740
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
741 742 743 744 745
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

746 747 748 749
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
750
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
751
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
752

753 754
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
755 756 757 758
setHcSuf      f d = d{ hcSuf      = f}

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

760 761 762 763 764 765 766
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) }
767
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
768

769 770
setDumpPrefixForce f d = d { dumpPrefixForce = f}

771 772 773 774 775 776 777 778 779 780 781 782
-- 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,[])}
783
setPgmwindres f d = d{ pgm_windres = f}
784 785 786 787 788 789 790 791

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}
792
addOptwindres f d = d{ opt_windres = f : opt_windres d}
793

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
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 }

-- 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

815 816
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
817 818
addHaddockOpts f d = d{ haddockOptions = Just f}

819 820 821
-- -----------------------------------------------------------------------------
-- Command-line options

822
-- | When invoking external tools as part of the compilation pipeline, we
823 824
-- 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
825
-- between filepaths and 'other stuff'. The reason for this is that
826
-- this type gives us a handle on transforming filenames, and filenames only,
827
-- to whatever format they're expected to be on a particular platform.
828 829
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
830 831 832
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
833
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
834

835 836 837 838
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
839
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
840
updOptLevel n dfs
841
  = dfs2{ optLevel = final_n }
842
  where
Ian Lynagh's avatar
Ian Lynagh committed
843
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
844 845 846
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

847 848
   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
849

850 851
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
852
  = [ ([0],     Opt_IgnoreInterfacePragmas)
853
    , ([0],     Opt_OmitInterfacePragmas)
854

Ian Lynagh's avatar
Ian Lynagh committed
855
    , ([1,2],   Opt_IgnoreAsserts)
856 857
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
858 859 860 861 862
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
863

Ian Lynagh's avatar
Ian Lynagh committed
864 865
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
866 867 868 869 870 871 872 873 874 875

--     , ([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.
876 877

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
878 879 880 881
                -- 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.
882 883 884 885 886
    ]

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

twanvl's avatar
twanvl committed
887
standardWarnings :: [DynFlag]
888
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
889
    = [ Opt_WarnWarningsDeprecations,
890
        Opt_WarnDeprecatedFlags,
891
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
892 893 894
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
895 896
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
897 898
      ]

twanvl's avatar
twanvl committed
899
minusWOpts :: [DynFlag]
900
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
901 902 903 904 905 906
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
907 908
      ]

twanvl's avatar
twanvl committed
909
minusWallOpts :: [DynFlag]
910 911
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
912 913 914 915 916
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
917 918
      ]

919
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
920
minuswRemovesOpts :: [DynFlag]
921 922 923 924 925 926
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
927
       Opt_WarnUnrecognisedPragmas,
928 929 930
       Opt_WarnTabs
      ]