DynFlags.hs 91.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 22 23 24 25
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
26
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
28 29 30 31
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynLibLoader(..),
34
        fFlags, fLangFlags, xFlags,
35
        DPHBackend(..), dphPackageMaybe,
36
        wayNames,
37

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

42
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
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
104
import Data.Maybe
Ian Lynagh's avatar
Ian Lynagh committed
105
import System.FilePath
106
import System.IO        ( stderr, hPutChar )
107

108 109 110
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

218 219
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

297 298
data Language = Haskell98 | Haskell2010

299
data ExtensionFlag
300 301 302 303 304 305 306
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
307
   | Opt_RelaxedPolyRec		-- Deprecated
308 309 310 311
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
312
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_Generics			-- "Derivable type classes"
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
329
   | Opt_GADTSyntax
330
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
331
   | Opt_DoAndIfThenElse
332
   | Opt_RebindableSyntax
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 369

   | 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
370
   | Opt_NondecreasingIndentation
371
   | Opt_RelaxedLayout
372 373
   deriving (Eq, Show)

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

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

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

405 406
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
521 522
 }

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

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

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

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

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

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

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

596 597 598
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
599 600 601
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.
602

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

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

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

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

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

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

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

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

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

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

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

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

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

        hpcDir                  = ".hpc",

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

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

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

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

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

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

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

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

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

828
-- | Test whether a 'DynFlag' is set
829 830
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
831

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

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

840
-- | Test whether a 'ExtensionFlag' is set
841
xopt :: ExtensionFlag -> DynFlags -> Bool
842
xopt f dflags = f `elem` extensionFlags dflags
843

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

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

858 859 860 861 862 863 864 865
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
                     }
866

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

874 875
-- | 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
876
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
877 878
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
879 880
  | otherwise =  ""

881
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
882
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
883
         setPgmP, addOptl, addOptP,