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

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

11
-- Most flags are dynamic flags, which means they can change from
12 13 14
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
17
        DOpt(..),
Ian Lynagh's avatar
Ian Lynagh committed
18
        DynFlag(..),
19
        ExtensionFlag(..),
20
        glasgowExtsFlags,
21 22
        flattenExtensionFlags,
        ensureFlattenedExtensionFlags,
23 24
        lopt_set_flattened,
        lopt_unset_flattened,
Ian Lynagh's avatar
Ian Lynagh committed
25
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
26
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
27 28 29 30
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
31
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
32
        DynLibLoader(..),
33
        fFlags, fLangFlags, xFlags,
34
        dphPackage,
35
        wayNames,
36

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

41
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
42 43 44 45
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
46
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
47

48
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
49
        parseDynamicFlags,
50
        parseDynamicNoPackageFlags,
51
        allFlags,
52

53
        supportedLanguagesAndExtensions,
54 55

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
56
        machdepCCOpts, picCCOpts,
57 58 59 60 61 62

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

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

#include "HsVersions.h"

74
#ifndef OMIT_NATIVE_CODEGEN
75
import Platform
76
#endif
77
import Module
Simon Marlow's avatar
Simon Marlow committed
78
import PackageConfig
79
import PrelNames        ( mAIN )
80
import StaticFlags
81
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
82
import DriverPhases     ( Phase(..), phaseInputExt )
83 84
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
85
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
86
import Panic
87
import Util
88
import Maybes           ( orElse )
89
import SrcLoc
90
import FastString
91
import FiniteMap
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
Ian Lynagh's avatar
Ian Lynagh committed
102
import System.FilePath
103
import System.IO        ( stderr, hPutChar )
104

105 106 107
-- -----------------------------------------------------------------------------
-- DynFlags

108
-- | Enumerates the simple on-or-off dynamic flags
109 110 111 112
data DynFlag

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

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

207 208
   | Opt_PrintExplicitForalls

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

230 231 232 233 234
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
235 236 237 238 239
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
269 270
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
271
   | Opt_AutoLinkPackages
272
   | Opt_ImplicitImportQualified
273
   | Opt_TryNewCodeGen
274 275 276 277 278 279 280

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
281
   | Opt_KeepRawTokenStream
282
   | Opt_KeepLlvmFiles
283

284
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
285

286 287
data Language = Haskell98 | Haskell2010

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

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

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

376 377 378
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
379

380
#ifndef OMIT_NATIVE_CODEGEN
381
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
382
#endif
Ian Lynagh's avatar
Ian Lynagh committed
383
  stolen_x86_regs       :: Int,
384
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
385 386 387
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
388
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
389

390 391
  dphBackend            :: DPHBackend,

392
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
393 394

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

399 400 401
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

402
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
403
  objectDir             :: Maybe String,
404
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
405 406
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
407

Ian Lynagh's avatar
Ian Lynagh committed
408 409 410
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
411

Ian Lynagh's avatar
Ian Lynagh committed
412 413 414
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
415

416
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
417 418
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
419

420 421
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
422 423 424 425 426 427 428 429
  dumpPrefixForce       :: Maybe FilePath,

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

430 431
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
432
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
433
  rtsOptsEnabled        :: RtsOptsEnabled,
434

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

437
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
438 439 440 441 442 443 444 445
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
446 447
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
448 449

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
450 451 452 453 454 455 456 457 458
  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]),
459 460
  pgm_T                 :: String,
  pgm_sysman            :: String,
461
  pgm_windres           :: String,
462 463
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
464

465 466 467 468 469 470
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

471
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
472
  extraPkgConfs         :: [FilePath],
473 474
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
475
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
476
        -- they appeared.
477

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

481
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
482
  -- NB. do not modify this field, it is calculated by
483
  -- Packages.initPackages and Packages.updatePackages.
484
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
485
  pkgState              :: PackageState,
486

487 488 489 490 491 492
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
  dirsToClean           :: IORef (FiniteMap FilePath FilePath),

493
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
494
  flags                 :: [DynFlag],
495
  language              :: Maybe Language,
496 497
  extensionFlags        :: Either [OnOff ExtensionFlag]
                                  [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
498

499
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
500 501 502
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
503 504
 }

505 506 507
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

556 557 558 559 560
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

561 562 563 564
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

565 566 567 568
-- | 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
569 570
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
571
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
572
  deriving (Eq, Show)
573 574 575

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

578 579 580
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
581 582 583
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.
584

585 586
data PackageFlag
  = ExposePackage  String
587
  | ExposePackageId String
588 589
  | HidePackage    String
  | IgnorePackage  String
590
  deriving Eq
591

twanvl's avatar
twanvl committed
592
defaultHscTarget :: HscTarget
593 594
defaultHscTarget = defaultObjectTarget

595
-- | The 'HscTarget' value corresponding to the default way to create
596
-- object files on the current platform.
twanvl's avatar
twanvl committed
597
defaultObjectTarget :: HscTarget
598
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
599 600
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
601

602 603 604 605 606
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
607 608
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

609
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
610
initDynFlags :: DynFlags -> IO DynFlags
611 612 613
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
614 615
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
616
 return dflags{
617 618 619
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
620 621
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
622
        }
623

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

645
#ifndef OMIT_NATIVE_CODEGEN
646
        targetPlatform          = defaultTargetPlatform,
647
#endif
Ian Lynagh's avatar
Ian Lynagh committed
648 649 650 651 652 653 654
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

655 656
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
657 658 659
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
660
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
661 662 663 664 665 666 667 668 669
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
670
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
671 672 673 674 675 676 677
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
678
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
679
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
680 681 682 683 684

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
685
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
686 687 688 689 690 691
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
692
        opt_windres             = [],
693 694
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
695 696 697

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

Ian Lynagh's avatar
Ian Lynagh committed
737
        log_action = \severity srcSpan style msg ->
738
                        case severity of
739 740 741 742
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
743 744 745 746 747
                                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.
748 749
      }

Ian Lynagh's avatar
Ian Lynagh committed
750
{-
751 752
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
753
    0   |   print errors & warnings only
754 755 756 757 758 759 760
    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"
-}

761 762 763
data OnOff a = On a
             | Off a

764 765 766
flattenExtensionFlags :: DynFlags -> DynFlags
flattenExtensionFlags dflags
    = case extensionFlags dflags of
767 768
      Left onoffs ->
          dflags {
769
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
770 771
          }
      Right _ ->
772
          panic "Flattening already-flattened extension flags"
773

774 775 776
ensureFlattenedExtensionFlags :: DynFlags -> DynFlags
ensureFlattenedExtensionFlags dflags
    = case extensionFlags dflags of
777 778
      Left onoffs ->
          dflags {
779
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
780 781 782 783 784 785
          }
      Right _ ->
          dflags

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
786 787 788
flattenExtensionFlags' :: Maybe Language -> [OnOff ExtensionFlag]
                       -> [ExtensionFlag]
flattenExtensionFlags' ml = foldr f defaultExtensionFlags
789 790
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
791 792 793 794 795 796 797
          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
798 799
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
      -- SLPJ September 2010
800 801 802 803 804 805 806 807 808 809 810 811 812
    : 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
813
       Opt_DoAndIfThenElse,
814
       Opt_RelaxedPolyRec]
815

816 817 818 819 820 821 822 823 824 825 826 827
-- The DOpt class is a temporary workaround, to avoid having to do
-- a mass-renaming dopt->lopt at the moment
class DOpt a where
    dopt :: a -> DynFlags -> Bool
    dopt_set :: DynFlags -> a -> DynFlags
    dopt_unset :: DynFlags -> a -> DynFlags

instance DOpt DynFlag where
    dopt = dopt'
    dopt_set = dopt_set'
    dopt_unset = dopt_unset'

828
instance DOpt ExtensionFlag where
829 830 831 832
    dopt = lopt
    dopt_set = lopt_set
    dopt_unset = lopt_unset

833
-- | Test whether a 'DynFlag' is set
834 835
dopt' :: DynFlag -> DynFlags -> Bool
dopt' f dflags  = f `elem` (flags dflags)
836

837
-- | Set a 'DynFlag'
838 839
dopt_set' :: DynFlags -> DynFlag -> DynFlags
dopt_set' dfs f = dfs{ flags = f : flags dfs }
840

841
-- | Unset a 'DynFlag'
842 843 844
dopt_unset' :: DynFlags -> DynFlag -> DynFlags
dopt_unset' dfs f = dfs{ flags = filter (/= f) (flags dfs) }

845 846 847 848
-- | Test whether a 'ExtensionFlag' is set
lopt :: ExtensionFlag -> DynFlags -> Bool
lopt f dflags = case extensionFlags dflags of
                Left _ -> panic ("Testing for extension flag " ++ show f ++ " before flattening")
849
                Right flags -> f `elem` flags
850

851 852 853 854 855
-- | Set a 'ExtensionFlag'
lopt_set :: DynFlags -> ExtensionFlag -> DynFlags
lopt_set dfs f = case extensionFlags dfs of
                 Left onoffs -> dfs { extensionFlags = Left (On f : onoffs) }
                 Right _ -> panic ("Setting extension flag " ++ show f ++ " after flattening")
856

857 858 859
-- | Set a 'ExtensionFlag'
lopt_set_flattened :: DynFlags -> ExtensionFlag -> DynFlags
lopt_set_flattened dfs f = case extensionFlags dfs of
860
                           Left _ ->
861
                               panic ("Setting extension flag " ++ show f ++ " before flattening, but expected flattened")
862
                           Right flags ->
863
                               dfs { extensionFlags = Right (f : delete f flags) }
864

865 866 867 868 869
-- | Unset a 'ExtensionFlag'
lopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset dfs f = case extensionFlags dfs of
                   Left onoffs -> dfs { extensionFlags = Left (Off f : onoffs) }
                   Right _ -> panic ("Unsetting extension flag " ++ show f ++ " after flattening")
870

871 872 873
-- | Unset a 'ExtensionFlag'
lopt_unset_flattened :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset_flattened dfs f = case extensionFlags dfs of
874
                             Left _ ->
875
                                 panic ("Unsetting extension flag " ++ show f ++ " before flattening, but expected flattened")
876
                             Right flags ->
877
                                 dfs { extensionFlags = Right (delete f flags) }
878

879 880 881 882
-- | 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
883
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
884
        -- We add to the options from the front, so we need to reverse the list
885

886 887
-- | 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
888
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
889 890
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
891 892
  | otherwise =  ""

893
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
894
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
895
         setPgmP, addOptl, addOptP,
896
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
897 898 899 900
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

901 902 903 904
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
905
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
906
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
907
setDylibInstallName  f d = d{ dylibInstallName = Just f}
908

909 910
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
911 912 913 914
setHcSuf      f d = d{ hcSuf      = f}

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

916 917 918 919
parseDynLibLoaderMode f d =
 case splitAt 8 f of