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
Ian Lynagh's avatar
Ian Lynagh committed
17
        DynFlag(..),
18
        ExtensionFlag(..),
19
        glasgowExtsFlags,
20 21
        flattenExtensionFlags,
        ensureFlattenedExtensionFlags,
22 23 24 25 26 27 28 29
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
        xopt_set_flattened,
        xopt_unset_flattened,
Ian Lynagh's avatar
Ian Lynagh committed
30
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
31
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
32 33 34 35
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
36
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
37
        DynLibLoader(..),
38
        fFlags, fLangFlags, xFlags,
39
        dphPackage,
40
        wayNames,
41

42
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
43 44 45
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

46
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
47 48 49 50
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
51
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
52

53
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
54
        parseDynamicFlags,
55
        parseDynamicNoPackageFlags,
56
        allFlags,
57

58
        supportedLanguagesAndExtensions,
59 60

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
61
        machdepCCOpts, picCCOpts,
62 63 64 65 66 67

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

        -- * Compiler configuration suitable for display to the user
68
        Printable(..),
69 70 71 72 73 74
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
75 76 77 78
  ) where

#include "HsVersions.h"

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

100
import System.IO.Unsafe	( unsafePerformIO )
101
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
102
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
103

104
import Data.Char
105
import Data.List
106 107
import Data.Map (Map)
import qualified Data.Map as Map
Ian Lynagh's avatar
Ian Lynagh committed
108
import System.FilePath
109
import System.IO        ( stderr, hPutChar )
110

111 112 113
-- -----------------------------------------------------------------------------
-- DynFlags

114
-- | Enumerates the simple on-or-off dynamic flags
115 116 117 118
data DynFlag

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

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

214 215
   | Opt_PrintExplicitForalls

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

237 238 239 240 241
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

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

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

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

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

292
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
293

294 295
data Language = Haskell98 | Haskell2010

296
data ExtensionFlag
297 298 299 300 301 302 303
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
304
   | Opt_RelaxedPolyRec		-- Deprecated
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
   | 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_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
327
   | Opt_DoAndIfThenElse
328
   | Opt_RebindableSyntax
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 364 365 366 367 368

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

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

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

385 386 387
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
388

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

399 400
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

502
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
503
  flags                 :: [DynFlag],
504
  language              :: Maybe Language,
505 506
  extensionFlags        :: Either [OnOff ExtensionFlag]
                                  [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
507

508
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
509 510 511
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
512 513
 }

514 515 516
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

565 566 567 568 569
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

570 571 572 573
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

587 588 589
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
590 591 592
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.
593

594 595
data PackageFlag
  = ExposePackage  String
596
  | ExposePackageId String
597 598
  | HidePackage    String
  | IgnorePackage  String
599
  deriving Eq
600

twanvl's avatar
twanvl committed
601
defaultHscTarget :: HscTarget
602 603
defaultHscTarget = defaultObjectTarget

604
-- | The 'HscTarget' value corresponding to the default way to create
605
-- object files on the current platform.
twanvl's avatar
twanvl committed
606
defaultObjectTarget :: HscTarget
607
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
608 609
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
610

611 612 613 614 615
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
616 617
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

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

633 634
-- | 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
635
defaultDynFlags :: DynFlags
636 637
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
638 639 640 641 642 643 644
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
645
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
646
        maxSimplIterations      = 4,
647
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
648 649 650
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
651
        liberateCaseThreshold   = Just 200,
652 653
        strictnessBefore        = [],

654
#ifndef OMIT_NATIVE_CODEGEN
655
        targetPlatform          = defaultTargetPlatform,
656
#endif
Ian Lynagh's avatar
Ian Lynagh committed
657 658 659 660 661 662 663
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

664 665
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
666 667 668
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
669
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
670 671 672 673 674 675 676 677 678
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
679
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
680 681 682 683 684 685 686
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
687
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
688
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
689 690 691 692 693

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
694
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
695 696 697 698 699 700
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
701
        opt_windres             = [],
702 703
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
704 705 706

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

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

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

770 771 772
data OnOff a = On a
             | Off a

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

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

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
795 796 797
flattenExtensionFlags' :: Maybe Language -> [OnOff ExtensionFlag]
                       -> [ExtensionFlag]
flattenExtensionFlags' ml = foldr f defaultExtensionFlags
798 799
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
800 801 802 803 804 805 806
          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
Ian Lynagh's avatar
Ian Lynagh committed
807
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
808
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
809
      -- SLPJ September 2010
810 811 812 813 814 815 816 817 818 819 820 821 822
    : 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
-- | Test whether a 'DynFlag' is set
827 828
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
829

830
-- | Set a 'DynFlag'
831 832
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
833

834
-- | Unset a 'DynFlag'
835 836
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
837

838
-- | Test whether a 'ExtensionFlag' is set
839 840
xopt :: ExtensionFlag -> DynFlags -> Bool
xopt f dflags = case extensionFlags dflags of
841
                Left _ -> panic ("Testing for extension flag " ++ show f ++ " before flattening")
842
                Right flags -> f `elem` flags
843

844
-- | Set a 'ExtensionFlag'
845 846
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
xopt_set dfs f = case extensionFlags dfs of
847 848
                 Left onoffs -> dfs { extensionFlags = Left (On f : onoffs) }
                 Right _ -> panic ("Setting extension flag " ++ show f ++ " after flattening")
849

850
-- | Set a 'ExtensionFlag'
851 852
xopt_set_flattened :: DynFlags -> ExtensionFlag -> DynFlags
xopt_set_flattened dfs f = case extensionFlags dfs of
853
                           Left _ ->
854
                               panic ("Setting extension flag " ++ show f ++ " before flattening, but expected flattened")
855
                           Right flags ->
856
                               dfs { extensionFlags = Right (f : delete f flags) }
857

858
-- | Unset a 'ExtensionFlag'
859 860
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
xopt_unset dfs f = case extensionFlags dfs of
861 862
                   Left onoffs -> dfs { extensionFlags = Left (Off f : onoffs) }
                   Right _ -> panic ("Unsetting extension flag " ++ show f ++ " after flattening")
863

864
-- | Unset a 'ExtensionFlag'
865 866
xopt_unset_flattened :: DynFlags -> ExtensionFlag -> DynFlags
xopt_unset_flattened dfs f = case extensionFlags dfs of
867
                             Left _ ->
868
                                 panic ("Unsetting extension flag " ++ show f ++ " before flattening, but expected flattened")
869
                             Right flags ->
870
                                 dfs { extensionFlags = Right (delete f flags) }
871

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

879 880
-- | 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
881
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
882 883
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
884 885
  | otherwise =  ""

886
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
887
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
888
         setPgmP, addOptl, addOptP,
889
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
890 891 892 893
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

894 895 896 897
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