DynFlags.hs 93 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 195

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

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

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

256 257
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

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

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

358 359
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
461 462
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

606 607
        dphBackend              = DPHPar,

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

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

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

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

        hpcDir                  = ".hpc",

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

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

688 689
            Opt_MethodSharing,

690 691
            Opt_DoAsmMangling,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

832 833 834
-- -----------------------------------------------------------------------------
-- Command-line options

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

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

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

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

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

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

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

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

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

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

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

twanvl's avatar
twanvl committed
912
minusWOpts :: [DynFlag]
913
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
914 915