DynFlags.hs 92.1 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
        getVerbFlag,
34
        getMainFun,
Ian Lynagh's avatar
Ian Lynagh committed
35 36 37
        updOptLevel,
        setTmpDir,
        setPackageName,
38
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
39

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

45 46 47
        supportedLanguages, languageOptions,

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

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

#include "HsVersions.h"

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

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

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

101 102 103
-- -----------------------------------------------------------------------------
-- DynFlags

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

   -- debugging flags
   = Opt_D_dump_cmm
109
   | Opt_D_dump_cmmz
110
   | Opt_D_dump_cmmz_pretty
111
   | Opt_D_dump_cps_cmm
112
   | Opt_D_dump_cvt_cmm
113
   | Opt_D_dump_asm
114 115
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
116
   | Opt_D_dump_asm_coalesce
117 118 119
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
120
   | Opt_D_dump_asm_stats
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
Ian Lynagh's avatar
Ian Lynagh committed
201
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
202
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
203
   | Opt_UnliftedFFITypes
Ian Lynagh's avatar
Ian Lynagh committed
204 205
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
206
   | Opt_TemplateHaskell
207
   | Opt_QuasiQuotes
208
   | Opt_ImplicitParams
209
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
210
   | Opt_ImplicitPrelude
211
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
212
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
213
   | Opt_BangPatterns
214
   | Opt_TypeFamilies
215
   | Opt_OverloadedStrings
216
   | Opt_DisambiguateRecordFields
217
   | Opt_RecordWildCards
218
   | Opt_RecordPuns
219
   | Opt_ViewPatterns
220
   | Opt_GADTs
221
   | Opt_RelaxedPolyRec
222
   | Opt_StandaloneDeriving
223
   | Opt_DeriveDataTypeable
224
   | Opt_DeriveFunctor
225
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
226
   | Opt_FlexibleContexts
227
   | Opt_FlexibleInstances
228
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
229
   | Opt_MultiParamTypeClasses
230
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
231
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
232
   | Opt_PolymorphicComponents
233
   | Opt_ExistentialQuantification
234
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
235
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
236
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_ParallelListComp
238
   | Opt_TransformListComp
239
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
240
   | Opt_RecursiveDo
241
   | Opt_PostfixOperators
Ian Lynagh's avatar
Ian Lynagh committed
242
   | Opt_PatternGuards
243
   | Opt_LiberalTypeSynonyms
244 245
   | Opt_Rank2Types
   | Opt_RankNTypes
246
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
247
   | Opt_TypeOperators
248
   | Opt_PackageImports
249
   | Opt_NewQualifiedOperators
250

251 252
   | Opt_PrintExplicitForalls

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

Ian Lynagh's avatar
Ian Lynagh committed
275 276 277 278 279
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
306 307
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
308
   | Opt_AutoLinkPackages
309
   | Opt_ImplicitImportQualified
310
   | Opt_TryNewCodeGen
311 312 313 314 315 316 317

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
318
   | Opt_KeepRawTokenStream
319

320
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
321

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

339 340 341
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
342

343
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
Ian Lynagh's avatar
Ian Lynagh committed
344
  stolen_x86_regs       :: Int,
345
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
346 347 348
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
349
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
350

351 352
  dphBackend            :: DPHBackend,

353
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
354 355

  -- ways
356 357 358
  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
359

360 361 362
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

363
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
364 365 366
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
367

Ian Lynagh's avatar
Ian Lynagh committed
368 369 370
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
371

Ian Lynagh's avatar
Ian Lynagh committed
372 373 374
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
375

376
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
377 378
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
379

380 381
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
382 383 384 385 386 387 388 389
  dumpPrefixForce       :: Maybe FilePath,

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

390 391 392
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

395
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
396 397 398 399 400 401 402 403
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
404 405

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
406 407 408 409 410 411 412 413 414
  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]),
415 416
  pgm_T                 :: String,
  pgm_sysman            :: String,
417
  pgm_windres           :: String,
418

419 420 421 422 423 424
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

425
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
426
  extraPkgConfs         :: [FilePath],
427 428
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
429
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
430
        -- they appeared.
431

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

435
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
436
  -- NB. do not modify this field, it is calculated by
437
  -- Packages.initPackages and Packages.updatePackages.
438
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
439
  pkgState              :: PackageState,
440

441 442 443 444 445 446
  -- 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),

447
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
448 449
  flags                 :: [DynFlag],

450
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
451 452 453
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
454 455
 }

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

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

502 503 504 505 506
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

507 508 509 510
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

511 512 513 514
-- | 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
515 516
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
517
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
518
  deriving (Eq, Show)
519 520 521

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

524 525 526 527 528
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

529 530 531 532
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
533
  deriving Eq
534

twanvl's avatar
twanvl committed
535
defaultHscTarget :: HscTarget
536 537
defaultHscTarget = defaultObjectTarget

538
-- | The 'HscTarget' value corresponding to the default way to create
539
-- object files on the current platform.
twanvl's avatar
twanvl committed
540
defaultObjectTarget :: HscTarget
541
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
542 543
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
544

545 546 547 548 549 550
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

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

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

597 598
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
        thisPackage             = mainPackageId,

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

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

        outputFile              = Nothing,
        outputHi                = Nothing,
        dynLibLoader            = Deployable,
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
624
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
625 626 627 628 629 630
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
631
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
632 633 634

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

679 680
            Opt_MethodSharing,

681 682
            Opt_DoAsmMangling,

683
            Opt_GenManifest,
684 685
            Opt_EmbedManifest,
            Opt_PrintBindContents
686 687 688 689 690
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
691
        log_action = \severity srcSpan style msg ->
692
                        case severity of
693 694 695 696 697 698 699 700
                          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.
701 702
      }

Ian Lynagh's avatar
Ian Lynagh committed
703
{-
704
    #verbosity_levels#
705
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
706 707

    0   |   print errors & warnings only
708 709 710 711 712 713 714
    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"
-}

715
-- | Test whether a 'DynFlag' is set
716 717 718
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

719
-- | Set a 'DynFlag'
720 721 722
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

723
-- | Unset a 'DynFlag'
724 725 726
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

727 728 729 730
-- | 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
731
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
732
        -- We add to the options from the front, so we need to reverse the list
733

734 735
-- | 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
736
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
737 738
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
739 740
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
741 742
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
743
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
744
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
745 746 747 748 749
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

750 751 752 753
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
754
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
755
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
756

757 758
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
759 760 761 762
setHcSuf      f d = d{ hcSuf      = f}

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

764 765 766 767 768 769 770
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) }
771
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
772

773 774
setDumpPrefixForce f d = d { dumpPrefixForce = f}

775 776 777 778 779 780 781 782 783 784 785 786
-- 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,[])}
787
setPgmwindres f d = d{ pgm_windres = f}
788 789 790 791 792 793 794 795

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

798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
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

819 820
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
821 822
addHaddockOpts f d = d{ haddockOptions = Just f}

823 824 825
-- -----------------------------------------------------------------------------
-- Command-line options

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

839 840 841 842
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
843
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
844
updOptLevel n dfs
845
  = dfs2{ optLevel = final_n }
846
  where
Ian Lynagh's avatar
Ian Lynagh committed
847
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
848 849 850
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

851 852
   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
853

854 855
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
856
  = [ ([0],     Opt_IgnoreInterfacePragmas)
857
    , ([0],     Opt_OmitInterfacePragmas)
858

Ian Lynagh's avatar
Ian Lynagh committed
859
    , ([1,2],   Opt_IgnoreAsserts)
860 861
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
862 863 864 865 866
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
867

Ian Lynagh's avatar
Ian Lynagh committed
868 869
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
870 871 872 873 874 875 876 877 878 879

--     , ([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.
880 881

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
882 883 884 885
                -- 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.
886 887 888 889 890
    ]

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

twanvl's avatar
twanvl committed
891
standardWarnings :: [DynFlag]
892
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
893
    = [ Opt_WarnWarningsDeprecations,
894
        Opt_WarnDeprecatedFlags,
895
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
896 897 898
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
899 900
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
901 902
      ]

twanvl's avatar
twanvl committed
903
minusWOpts :: [DynFlag]
904
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
905 906 907 908 909 910
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
911 912
      ]

twanvl's avatar
twanvl committed
913
minusWallOpts :: [DynFlag]
914 915
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
916 917 918 919 920
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
921 922
      ]

923
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
924
minuswRemovesOpts :: [DynFlag]