DynFlags.hs 94.2 KB
Newer Older
1
-- |
2 3 4 5 6 7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

8
-- Most flags are dynamic flags, which means they can change from
9 10 11
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
12
module DynFlags (
13
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
14 15 16 17 18 19 20 21
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
22
        fFlags, xFlags,
23
        dphPackage,
24

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

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

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

43 44 45
        supportedLanguages, languageOptions,

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

        -- * 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
60
        Printable(..),
61
        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
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 197
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind

198 199

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

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

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

261 262
   | Opt_PrintExplicitForalls

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

Ian Lynagh's avatar
Ian Lynagh committed
285 286 287 288 289
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
318 319
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
320
   | Opt_AutoLinkPackages
321
   | Opt_ImplicitImportQualified
322
   | Opt_TryNewCodeGen
323 324 325 326 327 328 329

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
330
   | Opt_KeepRawTokenStream
331

332
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
333

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

351 352 353
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
354

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

365 366
  dphBackend            :: DPHBackend,

367
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
368 369

  -- ways
370 371 372
  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
373

374 375 376
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

377
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
378 379 380
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
381

Ian Lynagh's avatar
Ian Lynagh committed
382 383 384
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
385

Ian Lynagh's avatar
Ian Lynagh committed
386 387 388
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
389

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

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

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

404 405 406
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

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

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

433 434 435 436 437 438
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

455 456 457 458 459 460
  -- 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),

461
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
462 463
  flags                 :: [DynFlag],

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

  haddockOptions :: Maybe String
468 469
 }

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

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

516 517 518 519 520
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

521 522 523 524
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

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

543 544 545 546
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
547
  deriving Eq
548

twanvl's avatar
twanvl committed
549
defaultHscTarget :: HscTarget
550 551
defaultHscTarget = defaultObjectTarget

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

559 560 561 562 563 564
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

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

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

613 614
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
615 616 617 618 619 620 621 622 623 624 625 626
        thisPackage             = mainPackageId,

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

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

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

        hpcDir                  = ".hpc",

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

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

695 696
            Opt_MethodSharing,

697 698
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
699 700
            Opt_SharedImplib,

701
            Opt_GenManifest,
702 703
            Opt_EmbedManifest,
            Opt_PrintBindContents
704 705 706 707 708
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
709
        log_action = \severity srcSpan style msg ->
710
                        case severity of
711 712 713 714 715 716 717 718
                          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.
719 720
      }

Ian Lynagh's avatar
Ian Lynagh committed
721
{-
722
    #verbosity_levels#
723
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
724 725

    0   |   print errors & warnings only
726 727 728 729 730 731 732
    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"
-}

733
-- | Test whether a 'DynFlag' is set
734 735 736
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

737
-- | Set a 'DynFlag'
738 739 740
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

741
-- | Unset a 'DynFlag'
742 743 744
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

745 746 747 748
-- | 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
749
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
750
        -- We add to the options from the front, so we need to reverse the list
751

752 753
-- | 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
754
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
755 756
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
757 758
  | otherwise =  ""

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

768 769 770 771
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
772
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
773
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
774

775 776
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
777 778 779 780
setHcSuf      f d = d{ hcSuf      = f}

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

782 783 784 785 786 787 788
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) }
789
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
790

791 792
setDumpPrefixForce f d = d { dumpPrefixForce = f}

793 794 795 796 797 798 799 800 801 802 803 804
-- 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,[])}
805
setPgmwindres f d = d{ pgm_windres = f}
806 807 808 809 810 811 812 813

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

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
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
833
deOptDep x = case stripPrefix "-optdep" x of
834 835 836
             Just rest -> rest
             Nothing -> x

837 838
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
839 840
addHaddockOpts f d = d{ haddockOptions = Just f}

841 842 843
-- -----------------------------------------------------------------------------
-- Command-line options

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

857 858 859 860
-----------------------------------------------------------------------------
-- Setting the optimisation level

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

869 870
   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
871

872 873
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
874
  = [ ([0],     Opt_IgnoreInterfacePragmas)
875
    , ([0],     Opt_OmitInterfacePragmas)
876

Ian Lynagh's avatar
Ian Lynagh committed
877
    , ([1,2],   Opt_IgnoreAsserts)
878 879
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
880 881 882 883 884
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
885

Ian Lynagh's avatar
Ian Lynagh committed
886 887
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
888 889 890 891 892 893 894 895 896 897

--     , ([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.
898 899

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
900 901 902 903
                -- 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.
904 905 906 907 908
    ]

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

twanvl's avatar
twanvl committed
909
standardWarnings :: [DynFlag]
910
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed