DynFlags.hs 93.8 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
17
        DOpt(..),
Ian Lynagh's avatar
Ian Lynagh committed
18
        DynFlag(..),
19 20 21
        ExtensionFlag(..),
        flattenExtensionFlags,
        ensureFlattenedExtensionFlags,
22 23
        lopt_set_flattened,
        lopt_unset_flattened,
Ian Lynagh's avatar
Ian Lynagh committed
24
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
25
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
26 27 28 29
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
30
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
31
        DynLibLoader(..),
32
        fFlags, fLangFlags, xFlags,
33
        dphPackage,
34
        wayNames,
35

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

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

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

52
        supportedLanguagesAndExtensions,
53 54

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

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

        -- * Compiler configuration suitable for display to the user
62
        Printable(..),
63
        compilerInfo, rtsIsProfiled
64 65 66 67
  ) where

#include "HsVersions.h"

68
#ifndef OMIT_NATIVE_CODEGEN
69
import Platform
70
#endif
71
import Module
Simon Marlow's avatar
Simon Marlow committed
72
import PackageConfig
73
import PrelNames        ( mAIN )
74
import StaticFlags
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 Util
82
import Maybes           ( orElse )
83
import SrcLoc
84
import FastString
85
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
86
import Outputable
87
import Foreign.C	( CInt )
Simon Marlow's avatar
Simon Marlow committed
88
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
89

90
import System.IO.Unsafe	( unsafePerformIO )
91
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
92
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
93

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

99 100 101
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

201 202
   | Opt_PrintExplicitForalls

203 204 205
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
206 207
   | Opt_FloatIn
   | Opt_Specialise
208
   | Opt_StaticArgumentTransformation
209
   | Opt_CSE
210 211
   | Opt_LiberateCase
   | Opt_SpecConstr
212 213 214 215 216
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
217
   | Opt_MethodSharing
218
   | Opt_DictsCheap
219
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
220
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
221 222
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
223

224 225 226 227 228
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
229 230 231 232 233
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

234 235
   -- misc opts
   | Opt_Pp
236
   | Opt_ForceRecomp
237 238 239
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
240
   | Opt_EagerBlackHoling
241 242 243 244
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
245
   | Opt_HideAllPackages
246
   | Opt_PrintBindResult
247
   | Opt_Haddock
David Waern's avatar
David Waern committed
248
   | Opt_HaddockOptions
249
   | Opt_Hpc_No_Auto
250
   | Opt_BreakOnException
251
   | Opt_BreakOnError
252
   | Opt_PrintEvldWithShow
253
   | Opt_PrintBindContents
254 255
   | Opt_GenManifest
   | Opt_EmbedManifest
256
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
257
   | Opt_SharedImplib
258
   | Opt_BuildingCabalPackage
259
   | Opt_SSE2
260 261 262

	-- temporary flags
   | Opt_RunCPS
263 264
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
265
   | Opt_AutoLinkPackages
266
   | Opt_ImplicitImportQualified
267
   | Opt_TryNewCodeGen
268 269 270 271 272 273 274

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
275
   | Opt_KeepRawTokenStream
276
   | Opt_KeepLlvmFiles
277

278
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
279

280 281
data Language = Haskell98 | Haskell2010

282
data ExtensionFlag
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | 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
   | Opt_RelaxedPolyRec
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
313
   | Opt_DoAndIfThenElse
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

   | 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_NewQualifiedOperators
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
   deriving (Eq, Show)

354 355
-- | 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
356
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
357 358 359
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
360
  hscOutName            :: String,      -- ^ Name of the output file
361
  extCoreName           :: String,      -- ^ Name of the .hcr output file
362
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
363 364 365
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
366
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
367
  ruleCheck             :: Maybe String,
368
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
369

370 371 372
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
373

374
#ifndef OMIT_NATIVE_CODEGEN
375
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
376
#endif
Ian Lynagh's avatar
Ian Lynagh committed
377
  stolen_x86_regs       :: Int,
378
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
379 380 381
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
382
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
383

384 385
  dphBackend            :: DPHBackend,

386
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
387 388

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

393 394 395
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

396
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
397
  objectDir             :: Maybe String,
398
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
399 400
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
401

Ian Lynagh's avatar
Ian Lynagh committed
402 403 404
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
405

Ian Lynagh's avatar
Ian Lynagh committed
406 407 408
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
409

410
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
411 412
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
413

414 415
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
416 417 418 419 420 421 422 423
  dumpPrefixForce       :: Maybe FilePath,

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

424 425
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
426
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
427
  rtsOptsEnabled        :: RtsOptsEnabled,
428

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

431
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
432 433 434 435 436 437 438 439
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
440 441
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
442 443

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
444 445 446 447 448 449 450 451 452
  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]),
453 454
  pgm_T                 :: String,
  pgm_sysman            :: String,
455
  pgm_windres           :: String,
456 457
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
458

459 460 461 462 463 464
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

465
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
466
  extraPkgConfs         :: [FilePath],
467 468
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
469
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
470
        -- they appeared.
471

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

475
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
476
  -- NB. do not modify this field, it is calculated by
477
  -- Packages.initPackages and Packages.updatePackages.
478
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
479
  pkgState              :: PackageState,
480

481 482 483 484 485 486
  -- 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),

487
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
488
  flags                 :: [DynFlag],
489
  language              :: Maybe Language,
490 491
  extensionFlags        :: Either [OnOff ExtensionFlag]
                                  [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
492

493
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
494 495 496
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
497 498
 }

499 500 501
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

502 503
-- | The target code type of the compilation (if any).
--
504 505 506
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
507 508 509 510
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
511 512 513
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
514
--
515 516 517 518 519 520
--  * 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.)
521
--
522
data HscTarget
523 524
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
525
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
526 527 528
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
529 530
  deriving (Eq, Show)

531
-- | Will this target result in an object file on the disk?
532 533 534
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
535
isObjectTarget HscLlvm  = True
536 537 538 539 540 541 542 543
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.
544
data GhcMode
545 546 547
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
548 549
  deriving Eq

550 551 552 553 554
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

555 556 557 558
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

559 560 561 562
-- | 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
563 564
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
565
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
566
  deriving (Eq, Show)
567 568 569

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

572 573 574
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
575 576 577
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.
578

579 580
data PackageFlag
  = ExposePackage  String
581
  | ExposePackageId String
582 583
  | HidePackage    String
  | IgnorePackage  String
584
  deriving Eq
585

twanvl's avatar
twanvl committed
586
defaultHscTarget :: HscTarget
587 588
defaultHscTarget = defaultObjectTarget

589
-- | The 'HscTarget' value corresponding to the default way to create
590
-- object files on the current platform.
twanvl's avatar
twanvl committed
591
defaultObjectTarget :: HscTarget
592
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
593 594
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
595

596 597 598 599 600 601
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
602 603
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

604
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
605
initDynFlags :: DynFlags -> IO DynFlags
606 607 608
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
609 610
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
611
 return dflags{
612 613 614
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
615 616
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
617
        }
618

619 620
-- | 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
621
defaultDynFlags :: DynFlags
622 623
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
624 625 626 627 628 629 630
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
631
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
632
        maxSimplIterations      = 4,
633
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
634 635 636
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
637
        liberateCaseThreshold   = Just 200,
638 639
        strictnessBefore        = [],

640
#ifndef OMIT_NATIVE_CODEGEN
641
        targetPlatform          = defaultTargetPlatform,
642
#endif
Ian Lynagh's avatar
Ian Lynagh committed
643 644 645 646 647 648 649
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

650 651
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
652 653 654
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
655
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
656 657 658 659 660 661 662 663 664
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
665
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
666 667 668 669 670 671 672
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
673
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
674
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
675 676 677 678 679

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
680
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
681 682 683 684 685 686
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
687
        opt_windres             = [],
688 689
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
690 691 692

        extraPkgConfs           = [],
        packageFlags            = [],
693 694
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
695
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
696 697
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
698
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
699 700 701 702
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
703
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
704 705 706 707 708 709 710 711 712 713 714 715
        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",
716 717
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
718
        -- end of initSysTools values
719 720 721 722 723 724
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
725 726
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
727
        haddockOptions = Nothing,
728
        flags = [
729
            Opt_AutoLinkPackages,
730 731
            Opt_ReadUserPackageConf,

732 733
            Opt_MethodSharing,

734 735
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
736 737
            Opt_SharedImplib,

738
            Opt_GenManifest,
739 740
            Opt_EmbedManifest,
            Opt_PrintBindContents
741 742 743 744 745
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

746
        language = Nothing,
747
        extensionFlags = Left [],
748

Ian Lynagh's avatar
Ian Lynagh committed
749
        log_action = \severity srcSpan style msg ->
750
                        case severity of
751 752 753 754
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
755 756 757 758 759
                                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.
760 761
      }

Ian Lynagh's avatar
Ian Lynagh committed
762
{-
763 764
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
765
    0   |   print errors & warnings only
766 767 768 769 770 771 772
    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"
-}

773 774 775
data OnOff a = On a
             | Off a

776 777 778
flattenExtensionFlags :: DynFlags -> DynFlags
flattenExtensionFlags dflags
    = case extensionFlags dflags of
779 780
      Left onoffs ->
          dflags {
781
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
782 783
          }
      Right _ ->
784
          panic "Flattening already-flattened extension flags"
785

786 787 788
ensureFlattenedExtensionFlags :: DynFlags -> DynFlags
ensureFlattenedExtensionFlags dflags
    = case extensionFlags dflags of
789 790
      Left onoffs ->
          dflags {
791
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
792 793 794 795 796 797
          }
      Right _ ->
          dflags

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
798 799 800
flattenExtensionFlags' :: Maybe Language -> [OnOff ExtensionFlag]
                       -> [ExtensionFlag]
flattenExtensionFlags' ml = foldr f defaultExtensionFlags
801 802
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
languageExtensions Nothing
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
    : languageExtensions (Just Haskell2010)
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
       Opt_DatatypeContexts]
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
823
       Opt_DoAndIfThenElse,
824
       Opt_RelaxedPolyRec]
825

826 827 828 829 830 831 832 833 834 835 836 837
-- The DOpt class is a temporary workaround, to avoid having to do
-- a mass-renaming dopt->lopt at the moment
class DOpt a where
    dopt :: a -> DynFlags -> Bool
    dopt_set :: DynFlags -> a -> DynFlags
    dopt_unset :: DynFlags -> a -> DynFlags

instance DOpt DynFlag where
    dopt = dopt'
    dopt_set = dopt_set'
    dopt_unset = dopt_unset'

838
instance DOpt ExtensionFlag where
839 840 841 842
    dopt = lopt
    dopt_set = lopt_set
    dopt_unset = lopt_unset

843
-- | Test whether a 'DynFlag' is set
844 845
dopt' :: DynFlag -> DynFlags -> Bool
dopt' f dflags  = f `elem` (flags dflags)
846

847
-- | Set a 'DynFlag'
848 849
dopt_set' :: DynFlags -> DynFlag -> DynFlags
dopt_set' dfs f = dfs{ flags = f : flags dfs }
850

851
-- | Unset a 'DynFlag'
852 853 854
dopt_unset' :: DynFlags -> DynFlag -> DynFlags
dopt_unset' dfs f = dfs{ flags = filter (/= f) (flags dfs) }

855 856 857 858
-- | Test whether a 'ExtensionFlag' is set
lopt :: ExtensionFlag -> DynFlags -> Bool
lopt f dflags = case extensionFlags dflags of
                Left _ -> panic ("Testing for extension flag " ++ show f ++ " before flattening")
859
                Right flags -> f `elem` flags
860

861 862 863 864 865
-- | Set a 'ExtensionFlag'
lopt_set :: DynFlags -> ExtensionFlag -> DynFlags
lopt_set dfs f = case extensionFlags dfs of
                 Left onoffs -> dfs { extensionFlags = Left (On f : onoffs) }
                 Right _ -> panic ("Setting extension flag " ++ show f ++ " after flattening")
866

867 868 869
-- | Set a 'ExtensionFlag'
lopt_set_flattened :: DynFlags -> ExtensionFlag -> DynFlags
lopt_set_flattened dfs f = case extensionFlags dfs of
870
                           Left _ ->
871
                               panic ("Setting extension flag " ++ show f ++ " before flattening, but expected flattened")
872
                           Right flags ->
873
                               dfs { extensionFlags = Right (f : delete f flags) }
874

875 876 877 878 879
-- | Unset a 'ExtensionFlag'
lopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset dfs f = case extensionFlags dfs of
                   Left onoffs -> dfs { extensionFlags = Left (Off f : onoffs) }
                   Right _ -> panic ("Unsetting extension flag " ++ show f ++ " after flattening")
880

881 882 883
-- | Unset a 'ExtensionFlag'
lopt_unset_flattened :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset_flattened dfs f = case extensionFlags dfs of
884
                             Left _ ->
885
                                 panic ("Unsetting extension flag " ++ show f ++ " before flattening, but expected flattened")
886
                             Right flags ->
887
                                 dfs { extensionFlags = Right (delete f flags) }
888

889 890 891 892
-- | 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
893
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
894
        -- We add to the options from the front, so we need to reverse the list
895

896 897
-- | 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
898
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
899 900
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
901 902
  | otherwise =  ""

903
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
904
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
905
         setPgmP, addOptl, addOptP,
906
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
907 908 909 910
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

911 912 913 914
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
915
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
916
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
917
setDylibInstallName  f d = d{ dylibInstallName = Just f}
918

919 920
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
921 922 923 924
setHcSuf      f d =