DynFlags.hs 96.1 KB
Newer Older
1
-- |
2 3 4 5 6 7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

8
-- Most flags are dynamic flags, which means they can change from
9 10 11
-- 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.
12
module DynFlags (
13
        -- * Dynamic flags and associated configuration types
14
        DOpt(..),
Ian Lynagh's avatar
Ian Lynagh committed
15
        DynFlag(..),
16 17 18
        ExtensionFlag(..),
        flattenExtensionFlags,
        ensureFlattenedExtensionFlags,
19 20
        lopt_set_flattened,
        lopt_unset_flattened,
Ian Lynagh's avatar
Ian Lynagh committed
21 22 23 24 25
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
26
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
27
        DynLibLoader(..),
28
        fFlags, fLangFlags, xFlags,
29
        dphPackage,
30
        wayNames,
31

32
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
33 34 35
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

36
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
37 38 39 40
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
41
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
42

43
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
44
        parseDynamicFlags,
45
        parseDynamicNoPackageFlags,
46
        allFlags,
47

48
        supportedLanguagesAndExtensions,
49 50

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
51
        machdepCCOpts, picCCOpts,
52 53 54 55 56 57

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

        -- * Compiler configuration suitable for display to the user
58
        Printable(..),
59
        compilerInfo
60 61 62 63
  ) where

#include "HsVersions.h"

64
#ifndef OMIT_NATIVE_CODEGEN
65
import Platform
66
#endif
67
import Module
Simon Marlow's avatar
Simon Marlow committed
68
import PackageConfig
69
import PrelNames        ( mAIN )
70
import StaticFlags
71
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
72
import DriverPhases     ( Phase(..), phaseInputExt )
73 74
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
75
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
76
import Panic
77
import Util
78
import Maybes           ( orElse )
79
import SrcLoc
80
import FastString
81
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
82 83
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
84

85
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
86
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
87

88
import Data.Char
89
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
90
import System.FilePath
91
import System.IO        ( stderr, hPutChar )
92

93 94 95
-- -----------------------------------------------------------------------------
-- DynFlags

96
-- | Enumerates the simple on-or-off dynamic flags
97 98 99 100
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
164
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
165 166
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
167
   | Opt_WarnImplicitPrelude
168 169 170
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
171
   | Opt_WarnMissingImportList
172 173 174 175 176 177
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
178
   | Opt_WarnMonomorphism
179 180 181
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
182
   | Opt_WarnWarningsDeprecations
183
   | Opt_WarnDeprecatedFlags
184
   | Opt_WarnDodgyExports
185 186
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
187
   | Opt_WarnTabs
188
   | Opt_WarnUnrecognisedPragmas
189
   | Opt_WarnDodgyForeignImports
190
   | Opt_WarnLazyUnliftedBindings
191 192
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
193
   | Opt_WarnAlternativeLayoutRuleTransitional
194

195 196
   | Opt_PrintExplicitForalls

197 198 199
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
200 201
   | Opt_FloatIn
   | Opt_Specialise
202
   | Opt_StaticArgumentTransformation
203
   | Opt_CSE
204 205
   | Opt_LiberateCase
   | Opt_SpecConstr
206 207 208 209 210
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
211
   | Opt_MethodSharing
212
   | Opt_DictsCheap
213
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
214
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
215 216
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
217

218 219 220 221 222
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
223 224 225 226 227
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

228 229
   -- misc opts
   | Opt_Pp
230
   | Opt_ForceRecomp
231 232 233
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
234
   | Opt_EagerBlackHoling
235 236
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
237
   | Opt_RtsOptsEnabled
238 239
   | Opt_SplitObjs
   | Opt_StgStats
240
   | Opt_HideAllPackages
241
   | Opt_PrintBindResult
242
   | Opt_Haddock
David Waern's avatar
David Waern committed
243
   | Opt_HaddockOptions
244
   | Opt_Hpc_No_Auto
245
   | Opt_BreakOnException
246
   | Opt_BreakOnError
247
   | Opt_PrintEvldWithShow
248
   | Opt_PrintBindContents
249 250
   | Opt_GenManifest
   | Opt_EmbedManifest
251
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
252
   | Opt_SharedImplib
253
   | Opt_BuildingCabalPackage
254
   | Opt_SSE2
255 256 257

	-- temporary flags
   | Opt_RunCPS
258 259
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
260
   | Opt_AutoLinkPackages
261
   | Opt_ImplicitImportQualified
262
   | Opt_TryNewCodeGen
263 264 265 266 267 268 269

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
270
   | Opt_KeepRawTokenStream
271
   | Opt_KeepLlvmFiles
272

273
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
274

275 276
data Language = Haskell98 | Haskell2010

277
data ExtensionFlag
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 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
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
   | 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_RelaxedPolyRec
   | Opt_NPlusKPatterns

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

348 349
-- | 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
350
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
351 352 353
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
354
  hscOutName            :: String,      -- ^ Name of the output file
355
  extCoreName           :: String,      -- ^ Name of the .hcr output file
356
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
357 358 359
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
360
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
361
  ruleCheck             :: Maybe String,
362
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
363

364 365 366
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
367

368
#ifndef OMIT_NATIVE_CODEGEN
369
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
370
#endif
Ian Lynagh's avatar
Ian Lynagh committed
371
  stolen_x86_regs       :: Int,
372
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
373 374 375
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
376
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
377

378 379
  dphBackend            :: DPHBackend,

380
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
381 382

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

387 388 389
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

390
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
391
  objectDir             :: Maybe String,
392
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
393 394
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
395

Ian Lynagh's avatar
Ian Lynagh committed
396 397 398
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
399

Ian Lynagh's avatar
Ian Lynagh committed
400 401 402
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
403

404
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
405 406
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
407

408 409
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
410 411 412 413 414 415 416 417
  dumpPrefixForce       :: Maybe FilePath,

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

418 419
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
420
  rtsOpts               :: Maybe String,
421

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

424
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
425 426 427 428 429 430 431 432
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
433 434
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
435 436

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
437 438 439 440 441 442 443 444 445
  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]),
446 447
  pgm_T                 :: String,
  pgm_sysman            :: String,
448
  pgm_windres           :: String,
449 450
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
451

452 453 454 455 456 457
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

458
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
459
  extraPkgConfs         :: [FilePath],
460 461
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
462
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
463
        -- they appeared.
464

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

468
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
469
  -- NB. do not modify this field, it is calculated by
470
  -- Packages.initPackages and Packages.updatePackages.
471
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
472
  pkgState              :: PackageState,
473

474 475 476 477 478 479
  -- 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),

480
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
481
  flags                 :: [DynFlag],
482
  language              :: Maybe Language,
483 484
  extensionFlags        :: Either [OnOff ExtensionFlag]
                                  [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
485

486
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
487 488 489
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
490 491
 }

492 493 494
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

524
-- | Will this target result in an object file on the disk?
525 526 527
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
528
isObjectTarget HscLlvm  = True
529 530 531 532 533 534 535 536
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.
537
data GhcMode
538 539 540
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
541 542
  deriving Eq

543 544 545 546 547
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

548 549 550 551
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

552 553 554 555
-- | 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
556 557
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
558
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
559
  deriving (Eq, Show)
560 561 562

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

565 566 567
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
568 569 570
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.
571

572 573
data PackageFlag
  = ExposePackage  String
574
  | ExposePackageId String
575 576
  | HidePackage    String
  | IgnorePackage  String
577
  deriving Eq
578

twanvl's avatar
twanvl committed
579
defaultHscTarget :: HscTarget
580 581
defaultHscTarget = defaultObjectTarget

582
-- | The 'HscTarget' value corresponding to the default way to create
583
-- object files on the current platform.
twanvl's avatar
twanvl committed
584
defaultObjectTarget :: HscTarget
585
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
586 587
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
588

589 590 591 592 593 594
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

595
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
596
initDynFlags :: DynFlags -> IO DynFlags
597 598 599
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
600 601
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
602
 return dflags{
603 604 605
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
606 607
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
608
        }
609

610 611
-- | 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
612
defaultDynFlags :: DynFlags
613 614
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
615 616 617 618 619 620 621
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
622
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
623
        maxSimplIterations      = 4,
624
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
625 626 627
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
628
        liberateCaseThreshold   = Just 200,
629 630
        strictnessBefore        = [],

631
#ifndef OMIT_NATIVE_CODEGEN
632
        targetPlatform          = defaultTargetPlatform,
633
#endif
Ian Lynagh's avatar
Ian Lynagh committed
634 635 636 637 638 639 640
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

641 642
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
643 644 645
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
646
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
647 648 649 650 651 652 653 654 655
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
656
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
657 658 659 660 661 662 663
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
664
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
665 666 667 668 669

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
670
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
671 672 673 674 675 676
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
677
        opt_windres             = [],
678 679
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
680 681 682

        extraPkgConfs           = [],
        packageFlags            = [],
683 684
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
685
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
686 687
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
688
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
689 690 691 692
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
693
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
694 695 696 697 698 699 700 701 702 703 704 705
        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",
706 707
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
708
        -- end of initSysTools values
709 710 711 712 713 714
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
715 716
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
717
        haddockOptions = Nothing,
718
        flags = [
719
            Opt_AutoLinkPackages,
720 721
            Opt_ReadUserPackageConf,

722 723
            Opt_MethodSharing,

724 725
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
726 727
            Opt_SharedImplib,

728
            Opt_GenManifest,
729 730
            Opt_EmbedManifest,
            Opt_PrintBindContents
731 732 733 734 735
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

736
        language = Nothing,
737
        extensionFlags = Left [],
738

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

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

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

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

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

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
787 788 789
flattenExtensionFlags' :: Maybe Language -> [OnOff ExtensionFlag]
                       -> [ExtensionFlag]
flattenExtensionFlags' ml = foldr f defaultExtensionFlags
790 791
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
          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
    : 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,
       Opt_RelaxedPolyRec]
813

814 815 816 817 818 819 820 821 822 823 824 825
-- 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'

826
instance DOpt ExtensionFlag where
827 828 829 830
    dopt = lopt
    dopt_set = lopt_set
    dopt_unset = lopt_unset

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

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

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

843 844 845 846
-- | 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")
847
                Right flags -> f `elem` flags
848

849 850 851 852 853
-- | 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")
854

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

863 864 865 866 867
-- | 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")
868

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

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

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

891
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
892
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
893
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
894 895 896
         setPgmlo, setPgmlc,
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres, addOptlo, addOptlc,
         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 920 921 922
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
   ("wrapped", "")      -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", "hard") -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", flex)   -> d{ dynLibLoader = Wrapped (Just flex) }
923
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
924

925 926
setDumpPrefixForce f d = d { dumpPrefixForce = f}

927 928 929 930 931 932 933 934 935 936 937 938
-- 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 d{ pgm_P   = (pgm,