DynFlags.hs 93.6 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
        dphPackage,
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]
Ian Lynagh's avatar
Ian Lynagh committed
43 44 45 46
        getVerbFlag,
        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
        Printable(..),
65 66 67 68 69 70
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
71 72 73 74
  ) where

#include "HsVersions.h"

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

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

100
import Data.Char
101
import Data.List
102 103
import Data.Map (Map)
import qualified Data.Map as Map
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_cmmz
116
   | Opt_D_dump_cmmz_pretty
117
   | Opt_D_dump_cps_cmm
118
   | Opt_D_dump_cvt_cmm
119
   | Opt_D_dump_asm
120 121
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
122
   | Opt_D_dump_asm_coalesce
123 124 125
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
126
   | Opt_D_dump_asm_stats
127
   | Opt_D_dump_asm_expanded
128
   | Opt_D_dump_llvm
129 130 131 132 133 134
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
135
   | Opt_D_dump_rule_firings
136
   | Opt_D_dump_rule_rewrites
137 138 139 140 141
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
142
   | Opt_D_dump_simpl_phases
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
   | 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
161
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
162
   | Opt_D_dump_rtti
163 164 165 166 167 168
   | 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
169
   | Opt_D_dump_mod_cycles
170
   | Opt_D_dump_view_pattern_commoning
171
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
172
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
173
   | Opt_D_no_debug_output
174 175 176
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
177
   | Opt_DoAsmLinting
178

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

212 213
   | Opt_PrintExplicitForalls

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

235 236 237 238 239
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
240 241 242 243 244
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
275 276
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
277
   | Opt_AutoLinkPackages
278
   | Opt_ImplicitImportQualified
279
   | Opt_TryNewCodeGen
280 281 282 283 284 285 286

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
287
   | Opt_KeepRawTokenStream
288
   | Opt_KeepLlvmFiles
289

290
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
291

292 293
data Language = Haskell98 | Haskell2010

294
data ExtensionFlag
295 296 297 298 299 300 301
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
302
   | Opt_RelaxedPolyRec		-- Deprecated
303 304 305 306
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
307
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
   | 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_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
325
   | Opt_DoAndIfThenElse
326
   | Opt_RebindableSyntax
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 355 356 357 358 359 360 361 362 363

   | 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
364
   | Opt_NondecreasingIndentation
365
   | Opt_RelaxedLayout
366 367
   deriving (Eq, Show)

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

384 385 386
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
387 388
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
389

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

400 401
  dphBackend            :: DPHBackend,

402
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
403 404

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

409 410 411
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

412
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
413
  objectDir             :: Maybe String,
414
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
415 416
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
417

Ian Lynagh's avatar
Ian Lynagh committed
418 419 420
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
421

Ian Lynagh's avatar
Ian Lynagh committed
422 423 424
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
425

426
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
427 428
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
429

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

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

440 441
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
442
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
443
  rtsOptsEnabled        :: RtsOptsEnabled,
444

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

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

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
460 461 462 463 464 465 466 467 468
  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]),
469 470
  pgm_T                 :: String,
  pgm_sysman            :: String,
471
  pgm_windres           :: String,
472 473
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
474

475 476 477 478 479 480
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

481
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
482
  extraPkgConfs         :: [FilePath],
483 484
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
485
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
486
        -- they appeared.
487

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

491
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
492
  -- NB. do not modify this field, it is calculated by
493
  -- Packages.initPackages and Packages.updatePackages.
494
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
495
  pkgState              :: PackageState,
496

497 498 499 500
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
501
  dirsToClean           :: IORef (Map FilePath FilePath),
502

503
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
504
  flags                 :: [DynFlag],
505
  -- Don't change this without updating extensionFlags:
506
  language              :: Maybe Language,
507 508 509 510 511
  -- 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
512

513
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
514 515 516
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
517 518
 }

519 520 521
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

570 571 572 573 574
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

575 576 577 578
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

592 593 594
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
595 596 597
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.
598

599 600
data PackageFlag
  = ExposePackage  String
601
  | ExposePackageId String
602 603
  | HidePackage    String
  | IgnorePackage  String
604
  deriving Eq
605

twanvl's avatar
twanvl committed
606
defaultHscTarget :: HscTarget
607 608
defaultHscTarget = defaultObjectTarget

609
-- | The 'HscTarget' value corresponding to the default way to create
610
-- object files on the current platform.
twanvl's avatar
twanvl committed
611
defaultObjectTarget :: HscTarget
612
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
613 614
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
615

616 617 618 619 620
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
621 622
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

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

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

660
#ifndef OMIT_NATIVE_CODEGEN
661
        targetPlatform          = defaultTargetPlatform,
662
#endif
Ian Lynagh's avatar
Ian Lynagh committed
663 664 665 666 667 668 669
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

670 671
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
672 673 674
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
675
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
676 677 678 679 680 681 682 683 684
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
685
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
686 687 688 689 690 691 692
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
693
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
694
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
695 696 697 698 699

        hpcDir                  = ".hpc",

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

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

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

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

777 778 779 780 781
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
782 783 784
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
785 786
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
787 788 789
          defaultExtensionFlags = languageExtensions ml

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

791
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
792
    -- Nothing => the default case
793 794 795
    = 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
796
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
797
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
798
      -- SLPJ September 2010
799
    : Opt_NondecreasingIndentation -- This has been on by default for some time
800
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
801

802 803 804 805 806
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
       Opt_DatatypeContexts]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
807

808 809 810 811 812 813 814
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
815
       Opt_DoAndIfThenElse,
816
       Opt_RelaxedPolyRec]
817

818
-- | Test whether a 'DynFlag' is set
819 820
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
821

822
-- | Set a 'DynFlag'
823 824
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
825

826
-- | Unset a 'DynFlag'
827 828
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
829

830
-- | Test whether a 'ExtensionFlag' is set
831
xopt :: ExtensionFlag -> DynFlags -> Bool
832
xopt f dflags = f `elem` extensionFlags dflags
833

834
-- | Set a 'ExtensionFlag'
835
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
836 837 838 839
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
840

841
-- | Unset a 'ExtensionFlag'
842
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
843 844 845 846
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
847

848 849 850 851 852 853 854 855
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
                     }
856

857 858 859 860
-- | 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
861
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
862
        -- We add to the options from the front, so we need to reverse the list
863

864 865
-- | 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
866
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
867 868
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
869 870
  | otherwise =  ""

871
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
872
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
873
         setPgmP, addOptl, addOptP,
874
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
875 876 877 878
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

879 880 881 882
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
883
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
884
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
885
setDylibInstallName  f d = d{ dylibInstallName = Just f}
886

887 888
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
889 890 891 892
setHcSuf      f d = d{ hcSuf      = f}

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