DynFlags.hs 95.9 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
Ian Lynagh's avatar
Ian Lynagh committed
14 15 16 17 18 19
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
20
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
21
        DynLibLoader(..),
22
        fFlags, xFlags,
23
        dphPackage,
24
        wayNames,
25

26
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
27 28 29 30 31
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

        dopt,                           -- DynFlag -> DynFlags -> Bool
        dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
32
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
33 34 35 36
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
37
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
38

39
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
40
        parseDynamicFlags,
41
        parseDynamicNoPackageFlags,
42
        allFlags,
43

44 45 46
        supportedLanguages, languageOptions,

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
47
        machdepCCOpts, picCCOpts,
48 49 50 51 52 53 54 55 56 57 58 59 60

        -- * Configuration of the core-to-core passes
        CoreToDo(..),
        SimplifierMode(..),
        SimplifierSwitch(..),
        FloatOutSwitches(..),
        getCoreToDo,

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

        -- * Compiler configuration suitable for display to the user
61
        Printable(..),
62
        compilerInfo
63 64 65 66
  ) where

#include "HsVersions.h"

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

88
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
89
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
90

91
import Data.Char
92
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
93
import System.FilePath
94
import System.IO        ( stderr, hPutChar )
95

96 97 98
-- -----------------------------------------------------------------------------
-- DynFlags

99
-- | Enumerates the simple on-or-off dynamic flags
100 101 102 103
data DynFlag

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

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

195 196

   -- language opts
197 198 199
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
200
   | Opt_MonomorphismRestriction
201
   | Opt_MonoPatBinds
202
   | Opt_MonoLocalBinds
Ian Lynagh's avatar
Ian Lynagh committed
203
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
204
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
205
   | Opt_UnliftedFFITypes
206
   | Opt_GHCForeignImportPrim
Ian Lynagh's avatar
Ian Lynagh committed
207 208
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
209
   | Opt_TemplateHaskell
210
   | Opt_QuasiQuotes
211
   | Opt_ImplicitParams
212
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
213
   | Opt_ImplicitPrelude
214
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
215
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
216
   | Opt_BangPatterns
217
   | Opt_TypeFamilies
218
   | Opt_OverloadedStrings
219
   | Opt_DisambiguateRecordFields
220
   | Opt_RecordWildCards
221
   | Opt_RecordPuns
222
   | Opt_ViewPatterns
223
   | Opt_GADTs
224
   | Opt_RelaxedPolyRec
225
   | Opt_NPlusKPatterns
226

227
   | Opt_StandaloneDeriving
228
   | Opt_DeriveDataTypeable
229
   | Opt_DeriveFunctor
230 231 232
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

233
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
234
   | Opt_FlexibleContexts
235
   | Opt_FlexibleInstances
236
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_MultiParamTypeClasses
238
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
239
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
240
   | Opt_PolymorphicComponents
241
   | Opt_ExistentialQuantification
242
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
243
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
244
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
245
   | Opt_ParallelListComp
246
   | Opt_TransformListComp
247
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
248
   | Opt_RecursiveDo
249
   | Opt_PostfixOperators
250
   | Opt_TupleSections
Ian Lynagh's avatar
Ian Lynagh committed
251
   | Opt_PatternGuards
252
   | Opt_LiberalTypeSynonyms
253 254
   | Opt_Rank2Types
   | Opt_RankNTypes
255
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
256
   | Opt_TypeOperators
257
   | Opt_PackageImports
258
   | Opt_NewQualifiedOperators
259

260 261
   | Opt_PrintExplicitForalls

262 263 264
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
265
   | Opt_StaticArgumentTransformation
266
   | Opt_CSE
267 268
   | Opt_LiberateCase
   | Opt_SpecConstr
269 270 271 272 273 274 275
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
276
   | Opt_MethodSharing
277
   | Opt_DictsCheap
278
   | Opt_InlineIfEnoughArgs
279
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
280
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
281 282
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
283

Ian Lynagh's avatar
Ian Lynagh committed
284 285 286 287 288
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

289 290 291
   -- misc opts
   | Opt_Cpp
   | Opt_Pp
292
   | Opt_ForceRecomp
293 294 295
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
296
   | Opt_EagerBlackHoling
297 298 299 300
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
301
   | Opt_HideAllPackages
302
   | Opt_PrintBindResult
303
   | Opt_Haddock
David Waern's avatar
David Waern committed
304
   | Opt_HaddockOptions
305
   | Opt_Hpc_No_Auto
306
   | Opt_BreakOnException
307
   | Opt_BreakOnError
308
   | Opt_PrintEvldWithShow
309
   | Opt_PrintBindContents
310 311
   | Opt_GenManifest
   | Opt_EmbedManifest
312
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
313
   | Opt_SharedImplib
314
   | Opt_BuildingCabalPackage
315 316 317

	-- temporary flags
   | Opt_RunCPS
318 319
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
320
   | Opt_AutoLinkPackages
321
   | Opt_ImplicitImportQualified
322
   | Opt_TryNewCodeGen
323 324 325 326 327 328 329

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
330
   | Opt_KeepRawTokenStream
331

332
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
333

334 335
-- | 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
336
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
337 338 339 340 341
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
342
  hscOutName            :: String,      -- ^ Name of the output file
343
  extCoreName           :: String,      -- ^ Name of the .hcr output file
344 345 346 347
  verbosity             :: Int,         -- ^ Verbosity level: see "DynFlags#verbosity_levels"
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
348
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
349
  ruleCheck             :: Maybe String,
350

351 352 353
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
354

355
#ifndef OMIT_NATIVE_CODEGEN
356
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
357
#endif
Ian Lynagh's avatar
Ian Lynagh committed
358
  stolen_x86_regs       :: Int,
359
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
360 361 362
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
363
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
364

365 366
  dphBackend            :: DPHBackend,

367
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
368 369

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

374 375 376
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

377
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
378 379 380
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
381

Ian Lynagh's avatar
Ian Lynagh committed
382 383 384
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
385

Ian Lynagh's avatar
Ian Lynagh committed
386 387 388
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
389

390
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
391 392
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
393

394 395
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
396 397 398 399 400 401 402 403
  dumpPrefixForce       :: Maybe FilePath,

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

404 405 406
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

409
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
410 411 412 413 414 415 416 417
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
418 419

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
420 421 422 423 424 425 426 427 428
  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]),
429 430
  pgm_T                 :: String,
  pgm_sysman            :: String,
431
  pgm_windres           :: String,
432

433 434 435 436 437 438
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

439
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
440
  extraPkgConfs         :: [FilePath],
441 442
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
443
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
444
        -- they appeared.
445

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

449
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
450
  -- NB. do not modify this field, it is calculated by
451
  -- Packages.initPackages and Packages.updatePackages.
452
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
453
  pkgState              :: PackageState,
454

455 456 457 458 459 460
  -- 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),

461
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
462 463
  flags                 :: [DynFlag],

464
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
465 466 467
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
468 469
 }

470 471 472
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

473 474
-- | The target code type of the compilation (if any).
--
475 476 477
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
478 479 480 481
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
482 483 484
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
485
--
486 487 488 489 490 491
--  * 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.)
492
--
493
data HscTarget
494 495 496 497 498
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
499 500
  deriving (Eq, Show)

501
-- | Will this target result in an object file on the disk?
502 503 504 505 506 507 508 509 510 511 512
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
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.
513
data GhcMode
514 515 516
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
517 518
  deriving Eq

519 520 521 522 523
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

524 525 526 527
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

528 529 530 531
-- | 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
532 533
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
534
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
535
  deriving (Eq, Show)
536 537 538

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

541 542 543 544 545
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

546 547
data PackageFlag
  = ExposePackage  String
548
  | ExposePackageId String
549 550
  | HidePackage    String
  | IgnorePackage  String
551
  deriving Eq
552

twanvl's avatar
twanvl committed
553
defaultHscTarget :: HscTarget
554 555
defaultHscTarget = defaultObjectTarget

556
-- | The 'HscTarget' value corresponding to the default way to create
557
-- object files on the current platform.
twanvl's avatar
twanvl committed
558
defaultObjectTarget :: HscTarget
559
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
560 561
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
562

563 564 565 566 567 568
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

569
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
570
initDynFlags :: DynFlags -> IO DynFlags
571 572 573
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
574 575
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
576
 return dflags{
577 578 579
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
580 581
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
582
        }
583

584 585
-- | 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
586
defaultDynFlags :: DynFlags
587 588
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
589 590 591 592 593 594 595 596 597
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
598
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
599
        maxSimplIterations      = 4,
600
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
601 602 603
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
604
        liberateCaseThreshold   = Just 200,
605
#ifndef OMIT_NATIVE_CODEGEN
606
        targetPlatform          = defaultTargetPlatform,
607
#endif
Ian Lynagh's avatar
Ian Lynagh committed
608 609 610 611 612 613 614
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

615 616
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
617 618 619 620 621 622 623 624 625 626 627 628
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
629
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
630 631 632 633 634 635 636 637 638 639 640 641
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
642
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
643 644 645 646 647 648
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
649
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
650 651 652

        extraPkgConfs           = [],
        packageFlags            = [],
653 654
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
655
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
656 657
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
658
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
659 660 661 662
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
663
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
664 665 666 667 668 669 670 671 672 673 674 675 676
        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",
        -- end of initSysTools values
677 678 679 680 681 682
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
683 684
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
685
        haddockOptions = Nothing,
686
        flags = [
687
            Opt_AutoLinkPackages,
688 689 690 691 692 693 694 695
            Opt_ReadUserPackageConf,

            Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
                                -- behaviour the default, to see if anyone notices
                                -- SLPJ July 06

            Opt_ImplicitPrelude,
            Opt_MonomorphismRestriction,
696
            Opt_NPlusKPatterns,
697

698 699
            Opt_MethodSharing,

700 701
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
702 703
            Opt_SharedImplib,

704
            Opt_GenManifest,
705 706
            Opt_EmbedManifest,
            Opt_PrintBindContents
707 708 709 710 711
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
712
        log_action = \severity srcSpan style msg ->
713
                        case severity of
714 715 716 717 718 719 720 721
                          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.
722 723
      }

Ian Lynagh's avatar
Ian Lynagh committed
724
{-
725
    #verbosity_levels#
726
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
727 728

    0   |   print errors & warnings only
729 730 731 732 733 734 735
    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"
-}

736
-- | Test whether a 'DynFlag' is set
737 738 739
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

740
-- | Set a 'DynFlag'
741 742 743
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

744
-- | Unset a 'DynFlag'
745 746 747
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

748 749 750 751
-- | 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
752
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
753
        -- We add to the options from the front, so we need to reverse the list
754

755 756
-- | 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
757
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
758 759
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
760 761
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
762 763
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
764
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
765
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
766 767 768 769 770
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

771 772 773 774
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
775
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
776
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
777

778 779
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
780 781 782 783
setHcSuf      f d = d{ hcSuf      = f}

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

785 786 787 788 789 790 791
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) }
792
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
793

794 795
setDumpPrefixForce f d = d { dumpPrefixForce = f}

796 797 798 799 800 801 802 803 804 805 806 807
-- 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, map Option args)}

setPgmL   f d = d{ pgm_L   = f}
setPgmF   f d = d{ pgm_F   = f}
setPgmc   f d = d{ pgm_c   = (f,[])}
setPgmm   f d = d{ pgm_m   = (f,[])}
setPgms   f d = d{ pgm_s   = (f,[])}
setPgma   f d = d{ pgm_a   = (f,[])}
setPgml   f d = d{ pgm_l   = (f,[])}
setPgmdll f d = d{ pgm_dll = (f,[])}
808
setPgmwindres f d = d{ pgm_windres = f}
809 810 811 812 813 814 815 816

addOptL   f d = d{ opt_L   = f : opt_L d}
addOptP   f d = d{ opt_P   = f : opt_P d}
addOptF   f d = d{ opt_F   = f : opt_F d}
addOptc   f d = d{ opt_c   = f : opt_c d}
addOptm   f d = d{ opt_m   = f : opt_m d}
addOpta   f d = d{ opt_a   = f : opt_a d}
addOptl   f d = d{ opt_l   = f : opt_l d}
817
addOptwindres f d = d{ opt_windres = f : opt_windres d}
818

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }

addDepExcludeMod :: String -> DynFlags -> DynFlags
addDepExcludeMod m d
    = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }

addDepSuffix :: FilePath -> DynFlags -> DynFlags
addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }

-- XXX Legacy code:
-- We used to use "-optdep-flag -optdeparg", so for legacy applications
-- we need to strip the "-optdep" off of the arg
deOptDep :: String -> String
836
deOptDep x = case stripPrefix "-optdep" x of
837 838 839
             Just rest -> rest
             Nothing -> x

840 841
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
842 843
addHaddockOpts f d = d{ haddockOptions = Just f}

844 845 846
-- -----------------------------------------------------------------------------
-- Command-line options

847
-- | When invoking external tools as part of the compilation pipeline, we
848 849
-- pass these a sequence of options on the command-line. Rather than
-- just using a list of Strings, we use a type that allows us to distinguish
850
-- between filepaths and 'other stuff'. The reason for this is that
851
-- this type gives us a handle on transforming filenames, and filenames only,
852
-- to whatever format they're expected to be on a particular platform.
853 854
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
855 856 857
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
858
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
859

Ian Lynagh's avatar
Ian Lynagh committed
860 861 862 863
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

864 865 866 867
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
868
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
869
updOptLevel n dfs
870
  = dfs2{ optLevel = final_n }
871
  where
Ian Lynagh's avatar
Ian Lynagh committed
872
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
873 874 875
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

876 877
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
Ian Lynagh's avatar
Ian Lynagh committed
878

879 880
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
881
  = [ ([0],     Opt_IgnoreInterfacePragmas)
882
    , ([0],     Opt_OmitInterfacePragmas)
883

Ian Lynagh's avatar
Ian Lynagh committed
884
    , ([1,2],   Opt_IgnoreAsserts)
885 886
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
887 888 889 890 891
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
892

Ian Lynagh's avatar
Ian Lynagh committed
893 894
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)