DynFlags.hs 92 KB
Newer Older
1 2 3
{-# OPTIONS_GHC -w #-}
-- Temporary, until rtsIsProfiled is fixed

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

11
-- Most flags are dynamic flags, which means they can change from
12 13 14
-- 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.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
17
        DynFlag(..),
18
        ExtensionFlag(..),
19
        glasgowExtsFlags,
20 21 22 23 24 25
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
26
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
28 29 30 31
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynLibLoader(..),
34
        fFlags, fLangFlags, xFlags,
35
        DPHBackend(..), dphPackageMaybe,
36
        wayNames,
37

38
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
39 40 41
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

42
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
43
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
44 45 46
        updOptLevel,
        setTmpDir,
        setPackageName,
47
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
48

49
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
50
        parseDynamicFlags,
51
        parseDynamicNoPackageFlags,
52
        allFlags,
53

54
        supportedLanguagesAndExtensions,
55 56

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
57
        machdepCCOpts, picCCOpts,
58 59 60 61 62 63

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

        -- * Compiler configuration suitable for display to the user
64 65 66 67 68 69
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
70 71 72 73
  ) where

#include "HsVersions.h"

74
#ifndef OMIT_NATIVE_CODEGEN
75
import Platform
76
#endif
77
import Module
Simon Marlow's avatar
Simon Marlow committed
78
import PackageConfig
79
import PrelNames        ( mAIN )
80
import StaticFlags
81
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
82
import DriverPhases     ( Phase(..), phaseInputExt )
83 84
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
85
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
86
import Panic
87
import Util
88
import Maybes           ( orElse )
89
import SrcLoc
90
import FastString
Simon Marlow's avatar
Simon Marlow committed
91
import Outputable
92
import Foreign.C	( CInt )
Simon Marlow's avatar
Simon Marlow committed
93
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
94

95
import System.IO.Unsafe	( unsafePerformIO )
96
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
97
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
98

99
import Data.Char
100
import Data.List
101 102
import Data.Map (Map)
import qualified Data.Map as Map
103
import Data.Maybe
Ian Lynagh's avatar
Ian Lynagh committed
104
import System.FilePath
105
import System.IO        ( stderr, hPutChar )
106

107 108 109
-- -----------------------------------------------------------------------------
-- DynFlags

110
-- | Enumerates the simple on-or-off dynamic flags
111 112 113 114
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
115
   | Opt_D_dump_raw_cmm
116
   | Opt_D_dump_cmmz
117
   | Opt_D_dump_cmmz_pretty
118
   | Opt_D_dump_cps_cmm
119
   | Opt_D_dump_cvt_cmm
120
   | Opt_D_dump_asm
121 122
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
123
   | Opt_D_dump_asm_coalesce
124 125 126
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
127
   | Opt_D_dump_asm_stats
128
   | Opt_D_dump_asm_expanded
129
   | Opt_D_dump_llvm
130
   | Opt_D_dump_core_stats
131 132 133 134 135 136
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
137
   | Opt_D_dump_rule_firings
138
   | Opt_D_dump_rule_rewrites
139 140 141 142 143
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
144
   | Opt_D_dump_simpl_phases
145 146 147 148 149 150 151 152 153 154 155 156 157
   | 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
158
   | Opt_D_dump_cs_trace	-- Constraint solver in type checker
159 160
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
161
   | Opt_D_dump_vt_trace
162 163 164
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
165
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
166
   | Opt_D_dump_rtti
167 168 169 170 171 172
   | 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
173
   | Opt_D_dump_mod_cycles
174
   | Opt_D_dump_view_pattern_commoning
175
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
176
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
177
   | Opt_D_no_debug_output
178 179 180
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
181
   | Opt_DoAsmLinting
182

Ian Lynagh's avatar
Ian Lynagh committed
183
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
184 185
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
186
   | Opt_WarnImplicitPrelude
187
   | Opt_WarnIncompletePatterns
188
   | Opt_WarnIncompleteUniPatterns
189 190
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
191
   | Opt_WarnMissingImportList
192 193
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
194
   | Opt_WarnMissingLocalSigs
195 196 197
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
198
   | Opt_WarnMonomorphism
199 200 201
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
202
   | Opt_WarnWarningsDeprecations
203
   | Opt_WarnDeprecatedFlags
204
   | Opt_WarnDodgyExports
205 206
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
207
   | Opt_WarnAutoOrphans
208
   | Opt_WarnIdentities
209
   | Opt_WarnTabs
210
   | Opt_WarnUnrecognisedPragmas
211
   | Opt_WarnDodgyForeignImports
212
   | Opt_WarnLazyUnliftedBindings
213 214
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
215
   | Opt_WarnAlternativeLayoutRuleTransitional
216

217 218
   | Opt_PrintExplicitForalls

219 220 221
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
222 223
   | Opt_FloatIn
   | Opt_Specialise
224
   | Opt_StaticArgumentTransformation
225
   | Opt_CSE
226 227
   | Opt_LiberateCase
   | Opt_SpecConstr
228 229 230 231 232
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
233
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
234
   | Opt_DictsCheap
235
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
236
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
237 238
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
239

240 241 242 243 244
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
245 246 247 248 249
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

250 251
   -- misc opts
   | Opt_Pp
252
   | Opt_ForceRecomp
253 254
   | Opt_DryRun
   | Opt_ExcessPrecision
255
   | Opt_EagerBlackHoling
256 257 258 259
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
260
   | Opt_HideAllPackages
261
   | Opt_PrintBindResult
262
   | Opt_Haddock
David Waern's avatar
David Waern committed
263
   | Opt_HaddockOptions
264
   | Opt_Hpc_No_Auto
265
   | Opt_BreakOnException
266
   | Opt_BreakOnError
267
   | Opt_PrintEvldWithShow
268
   | Opt_PrintBindContents
269 270
   | Opt_GenManifest
   | Opt_EmbedManifest
271
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
272
   | Opt_SharedImplib
273
   | Opt_BuildingCabalPackage
274
   | Opt_SSE2
275
   | Opt_GhciSandbox
276
   | Opt_HelpfulErrors
277 278 279

	-- temporary flags
   | Opt_RunCPS
280 281
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
282
   | Opt_AutoLinkPackages
283
   | Opt_ImplicitImportQualified
284
   | Opt_TryNewCodeGen
285 286 287 288 289 290

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
291
   | Opt_KeepRawTokenStream
292
   | Opt_KeepLlvmFiles
293

294
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
295

296 297
data Language = Haskell98 | Haskell2010

298
data ExtensionFlag
299 300 301 302 303 304 305
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
306
   | Opt_RelaxedPolyRec		-- Deprecated
307 308 309 310
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
311
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_Generics			-- "Derivable type classes"
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
328
   | Opt_GADTSyntax
329
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
330
   | Opt_DoAndIfThenElse
331
   | Opt_RebindableSyntax
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
369
   | Opt_NondecreasingIndentation
370
   | Opt_RelaxedLayout
371 372
   deriving (Eq, Show)

373 374
-- | 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
375
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
376 377 378
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
379
  hscOutName            :: String,      -- ^ Name of the output file
380
  extCoreName           :: String,      -- ^ Name of the .hcr output file
381
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
382 383 384
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
385
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
386
  ruleCheck             :: Maybe String,
387
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
388

389 390 391
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
392 393
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
394

395
#ifndef OMIT_NATIVE_CODEGEN
396
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
397
#endif
398
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
399 400 401
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
402
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
403

404 405
  dphBackend            :: DPHBackend,

406
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
407 408

  -- ways
409
  ways                  :: [Way],       -- ^ Way flags from the command line
410 411
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
412

413 414 415
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

416
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
417
  objectDir             :: Maybe String,
418
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
419 420
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
421

Ian Lynagh's avatar
Ian Lynagh committed
422 423 424
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
425

Ian Lynagh's avatar
Ian Lynagh committed
426 427 428
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
429

430
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
431 432
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
433

434 435
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
436 437 438 439 440 441 442 443
  dumpPrefixForce       :: Maybe FilePath,

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

444 445
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
446
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
447
  rtsOptsEnabled        :: RtsOptsEnabled,
448

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

451
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
452 453 454 455 456 457 458 459
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
460 461
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
462 463

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
464 465 466 467 468 469 470 471
  pgm_L                 :: String,
  pgm_P                 :: (String,[Option]),
  pgm_F                 :: String,
  pgm_c                 :: (String,[Option]),
  pgm_s                 :: (String,[Option]),
  pgm_a                 :: (String,[Option]),
  pgm_l                 :: (String,[Option]),
  pgm_dll               :: (String,[Option]),
472 473
  pgm_T                 :: String,
  pgm_sysman            :: String,
474
  pgm_windres           :: String,
475 476
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
477

478 479 480 481 482 483
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

484
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
485
  extraPkgConfs         :: [FilePath],
486
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
487
        -- they appeared.
488 489 490 491
  topDir                :: FilePath,           -- filled in by SysTools
  settings              :: [(String, String)], -- filled in by SysTools
  extraGccViaCFlags     :: [String],           -- filled in by SysTools
  systemPackageConfig   :: FilePath,           -- filled in by SysTools
492

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

496
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
497
  -- NB. do not modify this field, it is calculated by
498
  -- Packages.initPackages and Packages.updatePackages.
499
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
500
  pkgState              :: PackageState,
501

502 503 504 505
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
506
  dirsToClean           :: IORef (Map FilePath FilePath),
507

508
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
509
  flags                 :: [DynFlag],
510
  -- Don't change this without updating extensionFlags:
511
  language              :: Maybe Language,
512 513 514 515 516
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
517

518
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
519 520 521
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
522 523
 }

524 525 526
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

527 528
-- | The target code type of the compilation (if any).
--
529 530 531
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
532 533 534 535
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
536 537 538
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
539
--
540 541 542 543 544 545
--  * 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.)
546
--
547
data HscTarget
548 549
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
550
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
551 552 553
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
554 555
  deriving (Eq, Show)

556
-- | Will this target result in an object file on the disk?
557 558 559
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
560
isObjectTarget HscLlvm  = True
561 562 563 564 565 566 567 568
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.
569
data GhcMode
570 571 572
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
573 574
  deriving Eq

575 576 577 578 579
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

580 581 582 583
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

584 585 586 587
-- | 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
588 589
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
590
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
591
  deriving (Eq, Show)
592 593 594

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

597 598 599
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
600 601 602
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
603

604 605
data PackageFlag
  = ExposePackage  String
606
  | ExposePackageId String
607 608
  | HidePackage    String
  | IgnorePackage  String
609
  deriving Eq
610

twanvl's avatar
twanvl committed
611
defaultHscTarget :: HscTarget
612 613
defaultHscTarget = defaultObjectTarget

614
-- | The 'HscTarget' value corresponding to the default way to create
615
-- object files on the current platform.
twanvl's avatar
twanvl committed
616
defaultObjectTarget :: HscTarget
617
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
618 619
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
620

621 622 623 624 625
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
626
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
627
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
628

629
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
630
initDynFlags :: DynFlags -> IO DynFlags
631 632 633
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
634
 refFilesToClean <- newIORef []
635
 refDirsToClean <- newIORef Map.empty
636
 return dflags{
637 638 639
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
640 641
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
642
        }
643

644 645
-- | 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
646
defaultDynFlags :: DynFlags
647 648
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
649 650 651 652 653 654 655
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
656
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
657
        maxSimplIterations      = 4,
658
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
659 660 661
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
662
        liberateCaseThreshold   = Just 200,
663
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
664 665
        strictnessBefore        = [],

666
#ifndef OMIT_NATIVE_CODEGEN
667
        targetPlatform          = defaultTargetPlatform,
668
#endif
Ian Lynagh's avatar
Ian Lynagh committed
669 670 671 672 673 674
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
675
        dphBackend              = DPHNone,
676

Ian Lynagh's avatar
Ian Lynagh committed
677 678 679
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
680
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
681 682 683 684 685 686 687 688 689
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
690
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
691 692 693 694 695 696 697
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
698
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
699
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
700 701 702 703 704

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
705
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
706 707 708 709 710 711
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
712
        opt_windres             = [],
713 714
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
715 716 717

        extraPkgConfs           = [],
        packageFlags            = [],
718 719
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
720
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
721 722
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
723
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
724 725 726 727
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
728 729
        settings                = panic "defaultDynFlags: No settings",
        extraGccViaCFlags       = panic "defaultDynFlags: No extraGccViaCFlags",
730
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
731 732 733 734 735 736 737 738 739 740 741
        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_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",
742 743
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
744
        -- end of initSysTools values
745 746 747 748 749 750
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
751 752
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
753
        haddockOptions = Nothing,
754
        flags = defaultFlags,
755
        language = Nothing,
756 757
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
758

Ian Lynagh's avatar
Ian Lynagh committed
759
        log_action = \severity srcSpan style msg ->
760
                        case severity of
761 762 763 764
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
765 766 767 768 769
                                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.
770 771
      }

Ian Lynagh's avatar
Ian Lynagh committed
772
{-
773 774
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
775
    0   |   print errors & warnings only
776 777 778 779 780 781 782
    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"
-}

783 784 785 786 787
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
788 789 790
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
791 792
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
793 794 795
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
796

797
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
798
    -- Nothing => the default case
799 800 801
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
802
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
803
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
804
      -- SLPJ September 2010
805
    : Opt_NondecreasingIndentation -- This has been on by default for some time
806
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
807

808 809 810 811
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
812 813 814 815 816 817 818 819
       Opt_DatatypeContexts,
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
820

821 822 823 824 825 826 827
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
828
       Opt_DoAndIfThenElse,
829
       Opt_RelaxedPolyRec]
830

831
-- | Test whether a 'DynFlag' is set
832 833
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
834

835
-- | Set a 'DynFlag'
836 837
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
838

839
-- | Unset a 'DynFlag'
840 841
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
842

843
-- | Test whether a 'ExtensionFlag' is set
844
xopt :: ExtensionFlag -> DynFlags -> Bool
845
xopt f dflags = f `elem` extensionFlags dflags
846

847
-- | Set a 'ExtensionFlag'
848
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
849 850 851 852
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
853

854
-- | Unset a 'ExtensionFlag'
855
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
856 857 858 859
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
860

861 862 863 864 865 866 867 868
setLanguage :: Language -> DynP ()
setLanguage l = upd f
    where f dfs = let mLang = Just l
                      oneoffs = extensions dfs
                  in dfs {
                         language = mLang,
                         extensionFlags = flattenExtensionFlags mLang oneoffs
                     }
869

870 871 872 873
-- | 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
874
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
875
        -- We add to the options from the front, so we need to reverse the list
876

877 878
-- | 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
879 880 881 882
getVerbFlags :: DynFlags -> [String]
getVerbFlags dflags
  | verbosity dflags >= 4 = ["-v"]
  | otherwise             = []
883

884
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,