DynFlags.hs 93.7 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 20 21
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
22
        fFlags, xFlags,
23
        dphPackage,
24

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

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

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

43 44 45
        supportedLanguages, languageOptions,

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
46
        machdepCCOpts, picCCOpts,
47 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
        compilerInfo
61 62 63 64
  ) where

#include "HsVersions.h"

65
#ifndef OMIT_NATIVE_CODEGEN
66
import Platform
67
#endif
68
import Module
Simon Marlow's avatar
Simon Marlow committed
69
import PackageConfig
70
import PrelNames        ( mAIN )
Ian Lynagh's avatar
Ian Lynagh committed
71
#if defined(i386_TARGET_ARCH) || (!defined(mingw32_TARGET_OS) && !defined(darwin_TARGET_OS))
Ian Lynagh's avatar
Ian Lynagh committed
72
import StaticFlags      ( opt_Static )
Simon Marlow's avatar
Simon Marlow committed
73
#endif
Ian Lynagh's avatar
Ian Lynagh committed
74 75
import StaticFlags      ( opt_PIC, WayName(..), v_Ways, v_Build_tag,
                          v_RTS_Build_tag )
76
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
77
import DriverPhases     ( Phase(..), phaseInputExt )
78 79
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
80
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
81
import Panic
82
import UniqFM           ( UniqFM )
83
import Util
84
import Maybes           ( orElse )
85
import SrcLoc
86
import FastString
87
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
88 89
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
90

91
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
92
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
93

94
import Data.Char
95
import Data.List        ( intersperse )
Ian Lynagh's avatar
Ian Lynagh committed
96
import System.FilePath
97
import System.IO        ( stderr, hPutChar )
98

99 100 101
-- -----------------------------------------------------------------------------
-- DynFlags

102
-- | Enumerates the simple on-or-off dynamic flags
103 104 105 106
data DynFlag

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

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

197 198

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

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

234
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
235
   | Opt_FlexibleContexts
236
   | Opt_FlexibleInstances
237
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
238
   | Opt_MultiParamTypeClasses
239
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
240
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
241
   | Opt_PolymorphicComponents
242
   | Opt_ExistentialQuantification
243
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
244
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
245
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
246
   | Opt_ParallelListComp
247
   | Opt_TransformListComp
248
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
249
   | Opt_RecursiveDo
250
   | Opt_PostfixOperators
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 313 314

	-- temporary flags
   | Opt_RunCPS
315 316
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
317
   | Opt_AutoLinkPackages
318
   | Opt_ImplicitImportQualified
319
   | Opt_TryNewCodeGen
320 321 322 323 324 325 326

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
327
   | Opt_KeepRawTokenStream
328

329
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
330

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

348 349 350
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
351

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

362 363
  dphBackend            :: DPHBackend,

364
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
365 366

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

371 372 373
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

374
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
375 376 377
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
378

Ian Lynagh's avatar
Ian Lynagh committed
379 380 381
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
382

Ian Lynagh's avatar
Ian Lynagh committed
383 384 385
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
386

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

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

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

401 402 403
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

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

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

430 431 432 433 434 435
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

446
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
447
  -- NB. do not modify this field, it is calculated by
448
  -- Packages.initPackages and Packages.updatePackages.
449
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
450
  pkgState              :: PackageState,
451

452 453 454 455 456 457
  -- 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),

458
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
459 460
  flags                 :: [DynFlag],

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

  haddockOptions :: Maybe String
465 466
 }

467 468
-- | The target code type of the compilation (if any).
--
469 470 471
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
472 473 474 475
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
476 477 478
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
479
--
480 481 482 483 484 485
--  * 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.)
486
--
487
data HscTarget
488 489 490 491 492
  = 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.
493 494
  deriving (Eq, Show)

495
-- | Will this target result in an object file on the disk?
496 497 498 499 500 501 502 503 504 505 506
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.
507
data GhcMode
508 509 510
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
511 512
  deriving Eq

513 514 515 516 517
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

518 519 520 521
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

522 523 524 525
-- | 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
526 527
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
528
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
529
  deriving (Eq, Show)
530 531 532

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

535 536 537 538 539
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

540 541 542 543
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
544
  deriving Eq
545

twanvl's avatar
twanvl committed
546
defaultHscTarget :: HscTarget
547 548
defaultHscTarget = defaultObjectTarget

549
-- | The 'HscTarget' value corresponding to the default way to create
550
-- object files on the current platform.
twanvl's avatar
twanvl committed
551
defaultObjectTarget :: HscTarget
552
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
553 554
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
555

556 557 558 559 560 561
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

562
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
563
initDynFlags :: DynFlags -> IO DynFlags
564 565 566 567 568
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
 build_tag <- readIORef v_Build_tag
 rts_build_tag <- readIORef v_RTS_Build_tag
569 570
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
571
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
572 573
        wayNames        = ways,
        buildTag        = build_tag,
574 575 576
        rtsBuildTag     = rts_build_tag,
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
577
        }
578

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

610 611
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
612 613 614 615 616 617 618 619 620 621 622 623
        thisPackage             = mainPackageId,

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

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

        outputFile              = Nothing,
        outputHi                = Nothing,
624
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
625 626 627 628 629 630 631 632 633 634 635 636
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
637
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
638 639 640 641 642 643
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
644
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
645 646 647

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

692 693
            Opt_MethodSharing,

694 695
            Opt_DoAsmMangling,

696
            Opt_GenManifest,
697 698
            Opt_EmbedManifest,
            Opt_PrintBindContents
699 700 701 702 703
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
704
        log_action = \severity srcSpan style msg ->
705
                        case severity of
706 707 708 709 710 711 712 713
                          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.
714 715
      }

Ian Lynagh's avatar
Ian Lynagh committed
716
{-
717
    #verbosity_levels#
718
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
719 720

    0   |   print errors & warnings only
721 722 723 724 725 726 727
    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"
-}

728
-- | Test whether a 'DynFlag' is set
729 730 731
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

732
-- | Set a 'DynFlag'
733 734 735
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

736
-- | Unset a 'DynFlag'
737 738 739
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

740 741 742 743
-- | 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
744
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
745
        -- We add to the options from the front, so we need to reverse the list
746

747 748
-- | 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
749
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
750 751
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
752 753
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
754 755
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
756
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
757
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
758 759 760 761 762
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

763 764 765 766
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
767
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
768
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
769

770 771
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
772 773 774 775
setHcSuf      f d = d{ hcSuf      = f}

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

777 778 779 780 781 782 783
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) }
784
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
785

786 787
setDumpPrefixForce f d = d { dumpPrefixForce = f}

788 789 790 791 792 793 794 795 796 797 798 799
-- 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,[])}
800
setPgmwindres f d = d{ pgm_windres = f}
801 802 803 804 805 806 807 808

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}
809
addOptwindres f d = d{ opt_windres = f : opt_windres d}
810

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
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
deOptDep x = case maybePrefixMatch "-optdep" x of
             Just rest -> rest
             Nothing -> x

832 833
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
834 835
addHaddockOpts f d = d{ haddockOptions = Just f}

836 837 838
-- -----------------------------------------------------------------------------
-- Command-line options

839
-- | When invoking external tools as part of the compilation pipeline, we
840 841
-- 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
842
-- between filepaths and 'other stuff'. The reason for this is that
843
-- this type gives us a handle on transforming filenames, and filenames only,
844
-- to whatever format they're expected to be on a particular platform.
845 846
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
847 848 849
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
850
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
851

852 853 854 855
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
856
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
857
updOptLevel n dfs
858
  = dfs2{ optLevel = final_n }
859
  where
Ian Lynagh's avatar
Ian Lynagh committed
860
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
861 862 863
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

864 865
   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
866

867 868
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
869
  = [ ([0],     Opt_IgnoreInterfacePragmas)
870
    , ([0],     Opt_OmitInterfacePragmas)
871

Ian Lynagh's avatar
Ian Lynagh committed
872
    , ([1,2],   Opt_IgnoreAsserts)
873 874
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
875 876 877 878 879
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
880

Ian Lynagh's avatar
Ian Lynagh committed
881 882
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
883 884 885 886 887 888 889 890 891 892

--     , ([2],     Opt_StaticArgumentTransformation)
-- Max writes: I think it's probably best not to enable SAT with -O2 for the
-- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
-- several improvements to the heuristics, and I'm concerned that without
-- those changes SAT will interfere with some attempts to write "high
-- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
-- this year. In particular, the version in HEAD lacks the tail call
-- criterion, so many things that look like reasonable loops will be
-- turned into functions with extra (unneccesary) thunk creation.
893 894

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
895 896 897 898
                -- This one is important for a tiresome reason:
                -- we want to make sure that the bindings for data
                -- constructors are eta-expanded.  This is probably
                -- a good thing anyway, but it seems fragile.
899 900 901 902 903
    ]

-- -----------------------------------------------------------------------------
-- Standard sets of warning options

twanvl's avatar
twanvl committed
904
standardWarnings :: [DynFlag]
905
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
906
    = [ Opt_WarnWarningsDeprecations,
907
        Opt_WarnDeprecatedFlags,
908
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
909 910 911
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
912
        Opt_WarnDuplicateExports,
913
        Opt_WarnLazyUnliftedBindings,