DynFlags.hs 93.4 KB
Newer Older
1

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

9
-- Most flags are dynamic flags, which means they can change from
10 11 12
-- 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.
13
module DynFlags (
14
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
15 16 17 18 19 20 21 22
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
23
        fFlags, xFlags,
24
        dphPackage,
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 61

        -- * 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
62 63 64 65
  ) where

#include "HsVersions.h"

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

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

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

100 101 102
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

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

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

258 259
   | Opt_PrintExplicitForalls

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

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

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

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

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
325
   | Opt_KeepRawTokenStream
326

327
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
328

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

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

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

360 361
  dphBackend            :: DPHBackend,

362
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
363 364

  -- ways
365 366 367
  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
368

369 370 371
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
377 378 379
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
380

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

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

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

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

399 400 401
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

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

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

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

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

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

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

450 451 452 453 454 455
  -- 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),

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

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

  haddockOptions :: Maybe String
463 464
 }

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

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

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

516 517 518 519
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

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

538 539 540 541
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
542
  deriving Eq
543

twanvl's avatar
twanvl committed
544
defaultHscTarget :: HscTarget
545 546
defaultHscTarget = defaultObjectTarget

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

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

560
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
561
initDynFlags :: DynFlags -> IO DynFlags
562 563 564 565 566
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
567 568
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
569
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
570 571
        wayNames        = ways,
        buildTag        = build_tag,
572 573 574
        rtsBuildTag     = rts_build_tag,
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
575
        }
576

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

608 609
        dphBackend              = DPHPar,

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

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

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

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

        hpcDir                  = ".hpc",

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

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

690 691
            Opt_MethodSharing,

692 693
            Opt_DoAsmMangling,

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

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

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

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

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

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

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

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

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

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

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

768 769
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
770 771 772 773
setHcSuf      f d = d{ hcSuf      = f}

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

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

784 785
setDumpPrefixForce f d = d { dumpPrefixForce = f}

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

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

809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
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

830 831
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
832 833
addHaddockOpts f d = d{ haddockOptions = Just f}

834 835 836
-- -----------------------------------------------------------------------------
-- Command-line options

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

850 851 852 853
-----------------------------------------------------------------------------
-- Setting the optimisation level

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

862 863
   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
864

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

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

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

--     , ([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.
891 892

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
893 894 895 896
                -- 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.
897 898 899 900 901
    ]

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

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