DynFlags.hs 93.6 KB
Newer Older
1 2 3
{-# OPTIONS_GHC -w #-}
-- Temporary, until rtsIsProfiled is fixed

4
-- |
5 6 7 8 9 10
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

11
-- Most flags are dynamic flags, which means they can change from
12 13 14
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
17
        DynFlag(..),
18
        ExtensionFlag(..),
19
        glasgowExtsFlags,
20 21
        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 274 275

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

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

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

293 294
data Language = Haskell98 | Haskell2010

295
data ExtensionFlag
296 297 298 299 300 301 302
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
303
   | Opt_RelaxedPolyRec		-- Deprecated
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
   | 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
326
   | Opt_DoAndIfThenElse
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 366

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

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

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

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

397 398
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
510 511
 }

512 513 514
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

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

568 569 570 571
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

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

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

twanvl's avatar
twanvl committed
599
defaultHscTarget :: HscTarget
600 601
defaultHscTarget = defaultObjectTarget

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

609 610 611 612 613
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
614 615
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

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

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

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

662 663
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
664 665 666
        thisPackage             = mainPackageId,

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

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

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

        hpcDir                  = ".hpc",

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

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

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

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

768 769 770
data OnOff a = On a
             | Off a

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

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

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

824
-- | Test whether a 'DynFlag' is set
825 826
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
827

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

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

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

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

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

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

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

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

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

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

892 893 894 895
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
896
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
897
setOutputDir  f = setObjectDir f . setHiDir