DynFlags.hs 93.3 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
Ian Lynagh's avatar
Ian Lynagh committed
206 207
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
208
   | Opt_TemplateHaskell
209
   | Opt_QuasiQuotes
210
   | Opt_ImplicitParams
211
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
212
   | Opt_ImplicitPrelude
213
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
214
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
215
   | Opt_BangPatterns
216
   | Opt_TypeFamilies
217
   | Opt_OverloadedStrings
218
   | Opt_DisambiguateRecordFields
219
   | Opt_RecordWildCards
220
   | Opt_RecordPuns
221
   | Opt_ViewPatterns
222
   | Opt_GADTs
223
   | Opt_RelaxedPolyRec
224

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

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

257 258
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

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

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

359 360
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
462 463
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

607 608
        dphBackend              = DPHPar,

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

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

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

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

        hpcDir                  = ".hpc",

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

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

689 690
            Opt_MethodSharing,

691 692
            Opt_DoAsmMangling,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

833 834 835
-- -----------------------------------------------------------------------------
-- Command-line options

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

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

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

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

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

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

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

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

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

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

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