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

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

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

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

53
        supportedLanguagesAndExtensions,
54 55

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

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

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

#include "HsVersions.h"

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

91
import System.IO.Unsafe	( unsafePerformIO )
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
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
   | Opt_D_dump_asm_expanded
121
   | Opt_D_dump_llvm
122 123 124 125 126 127
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
128
   | Opt_D_dump_rule_firings
129 130 131 132 133
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
134
   | Opt_D_dump_simpl_phases
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
   | 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
153
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
154
   | Opt_D_dump_rtti
155 156 157 158 159 160
   | 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
161
   | Opt_D_dump_mod_cycles
162
   | Opt_D_dump_view_pattern_commoning
163
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
164
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
165
   | Opt_D_no_debug_output
166 167 168
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
169
   | Opt_DoAsmLinting
170

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

202 203
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

281 282
data Language = Haskell98 | Haskell2010

283
data ExtensionFlag
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 313
   = 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
314
   | Opt_DoAndIfThenElse
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 354

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

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

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

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

385 386
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
498 499
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

651 652
        dphBackend              = DPHPar,

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

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

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

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

        hpcDir                  = ".hpc",

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

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

733 734
            Opt_MethodSharing,

735 736
            Opt_DoAsmMangling,

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

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

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

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

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

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

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

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

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

827 828 829 830 831 832 833 834 835 836 837 838
-- 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'

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

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

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

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

856 857 858 859
-- | 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")
860
                Right flags -> f `elem` flags
861

862 863 864 865 866
-- | 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")
867

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

876 877 878 879 880
-- | 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")
881

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

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

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

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

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

simonmar's avatar