DynFlags.hs 93.3 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 137 138 139 140
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
141
   | Opt_D_dump_simpl_phases
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
   | 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
160
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
161
   | Opt_D_dump_rtti
162 163 164 165 166 167
   | 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
168
   | Opt_D_dump_mod_cycles
169
   | Opt_D_dump_view_pattern_commoning
170
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
171
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
172
   | Opt_D_no_debug_output
173 174 175
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
176
   | Opt_DoAsmLinting
177

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

211 212
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

291 292
data Language = Haskell98 | Haskell2010

293
data ExtensionFlag
294 295 296 297 298 299 300
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
301
   | Opt_RelaxedPolyRec		-- Deprecated
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
   | 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
324
   | Opt_DoAndIfThenElse
325
   | Opt_RebindableSyntax
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

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

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

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

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

398 399
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
515 516
 }

517 518 519
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

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

573 574 575 576
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

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

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

twanvl's avatar
twanvl committed
604
defaultHscTarget :: HscTarget
605 606
defaultHscTarget = defaultObjectTarget

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

614 615 616 617 618
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
619 620
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

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

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

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

668 669
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
670 671 672
        thisPackage             = mainPackageId,

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

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

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

        hpcDir                  = ".hpc",

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

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

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

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

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

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

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

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

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

815
-- | Test whether a 'DynFlag' is set
816 817
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
818

819
-- | Set a 'DynFlag'
820 821
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
822

823
-- | Unset a 'DynFlag'
824 825
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
826

827
-- | Test whether a 'ExtensionFlag' is set
828
xopt :: ExtensionFlag -> DynFlags -> Bool
829
xopt f dflags = f `elem` extensionFlags dflags
830

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

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

845 846 847 848 849 850 851 852
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
                     }
853

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

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

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

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

884 885
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
886 887 888 889
setHcSuf      f d = d{ hcSuf      = f}

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

891 892 893 894
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
895
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
896

897 898
setDumpPrefixForce f d = d { dumpPrefixForce = f}

899 900 901 902
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
setPgmP   f d = let (pgm:args) = words f in