DynFlags.hs 97.3 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
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
20
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
21
        DynLibLoader(..),
22
        fFlags, xFlags,
23
        dphPackage,
24
        wayNames,
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

        -- * 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
61
        Printable(..),
62
        compilerInfo
63 64 65 66
  ) where

#include "HsVersions.h"

67
#ifndef OMIT_NATIVE_CODEGEN
68
import Platform
69
#endif
70
import Module
Simon Marlow's avatar
Simon Marlow committed
71
import PackageConfig
72
import PrelNames        ( mAIN )
73
import StaticFlags
74
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
75
import DriverPhases     ( Phase(..), phaseInputExt )
76 77
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
78
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
79
import Panic
80
import Util
81
import Maybes           ( orElse )
82
import SrcLoc
83
import FastString
84
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
85 86
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
87

88
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
89
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
90

91
import Data.Char
92
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
93
import System.FilePath
94
import System.IO        ( stderr, hPutChar )
95

96 97 98
-- -----------------------------------------------------------------------------
-- DynFlags

99
-- | Enumerates the simple on-or-off dynamic flags
100 101 102 103
data DynFlag

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

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

195 196

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

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

233
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
234
   | Opt_FlexibleContexts
235
   | Opt_FlexibleInstances
236
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_MultiParamTypeClasses
238
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
239
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
240
   | Opt_PolymorphicComponents
241
   | Opt_ExistentialQuantification
242
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
243
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
244
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
245
   | Opt_ParallelListComp
246
   | Opt_TransformListComp
247
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
248
   | Opt_RecursiveDo
249
   | Opt_DoRec
250
   | Opt_PostfixOperators
251
   | Opt_TupleSections
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
   | Opt_ExplicitForAll
261

262 263
   | Opt_PrintExplicitForalls

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

Ian Lynagh's avatar
Ian Lynagh committed
288 289 290 291 292
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
322 323
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
324
   | Opt_AutoLinkPackages
325
   | Opt_ImplicitImportQualified
326
   | Opt_TryNewCodeGen
327 328 329 330 331 332 333

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
334
   | Opt_KeepRawTokenStream
335

336
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
337

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

356 357 358
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
359

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

370 371
  dphBackend            :: DPHBackend,

372
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
373 374

  -- ways
375
  ways                  :: [Way],       -- ^ Way flags from the command line
376 377
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
378

379 380 381
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

382
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
383 384 385
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
386

Ian Lynagh's avatar
Ian Lynagh committed
387 388 389
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
390

Ian Lynagh's avatar
Ian Lynagh committed
391 392 393
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
394

395
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
396 397
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
398

399 400
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
401 402 403 404 405 406 407 408
  dumpPrefixForce       :: Maybe FilePath,

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

409 410 411
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

414
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
415 416 417 418 419 420 421 422
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
423 424

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
425 426 427 428 429 430 431 432 433
  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]),
434 435
  pgm_T                 :: String,
  pgm_sysman            :: String,
436
  pgm_windres           :: String,
437

438 439 440 441 442 443
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

444
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
445
  extraPkgConfs         :: [FilePath],
446 447
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
448
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
449
        -- they appeared.
450

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

454
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
455
  -- NB. do not modify this field, it is calculated by
456
  -- Packages.initPackages and Packages.updatePackages.
457
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
458
  pkgState              :: PackageState,
459

460 461 462 463 464 465
  -- 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),

466
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
467 468
  flags                 :: [DynFlag],

469
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
470 471 472
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
473 474
 }

475 476 477
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

506
-- | Will this target result in an object file on the disk?
507 508 509 510 511 512 513 514 515 516 517
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.
518
data GhcMode
519 520 521
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
522 523
  deriving Eq

524 525 526 527 528
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

529 530 531 532
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

533 534 535 536
-- | 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
537 538
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
539
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
540
  deriving (Eq, Show)
541 542 543

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

546 547 548 549 550
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

551 552
data PackageFlag
  = ExposePackage  String
553
  | ExposePackageId String
554 555
  | HidePackage    String
  | IgnorePackage  String
556
  deriving Eq
557

twanvl's avatar
twanvl committed
558
defaultHscTarget :: HscTarget
559 560
defaultHscTarget = defaultObjectTarget

561
-- | The 'HscTarget' value corresponding to the default way to create
562
-- object files on the current platform.
twanvl's avatar
twanvl committed
563
defaultObjectTarget :: HscTarget
564
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
565 566
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
567

568 569 570 571 572 573
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

574
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
575
initDynFlags :: DynFlags -> IO DynFlags
576 577 578
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
579 580
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
581
 return dflags{
582 583 584
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
585 586
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
587
        }
588

589 590
-- | 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
591
defaultDynFlags :: DynFlags
592 593
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
594 595 596 597 598 599 600 601 602
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
603
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
604
        maxSimplIterations      = 4,
605
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
606 607 608
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
609
        liberateCaseThreshold   = Just 200,
610 611
        strictnessBefore        = [],

612
#ifndef OMIT_NATIVE_CODEGEN
613
        targetPlatform          = defaultTargetPlatform,
614
#endif
Ian Lynagh's avatar
Ian Lynagh committed
615 616 617 618 619 620 621
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

622 623
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
624 625 626 627 628 629 630 631 632 633 634 635
        thisPackage             = mainPackageId,

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

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

        outputFile              = Nothing,
        outputHi                = Nothing,
636
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
637 638 639 640 641 642 643 644 645 646 647 648
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
649
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
650 651 652 653 654 655
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
656
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
657 658 659

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

705 706
            Opt_MethodSharing,

707 708
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
709 710
            Opt_SharedImplib,

711
            Opt_GenManifest,
712 713
            Opt_EmbedManifest,
            Opt_PrintBindContents
714 715 716 717 718
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
719
        log_action = \severity srcSpan style msg ->
720
                        case severity of
721 722 723 724 725 726 727 728
                          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.
729 730
      }

Ian Lynagh's avatar
Ian Lynagh committed
731
{-
732
    #verbosity_levels#
733
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
734 735

    0   |   print errors & warnings only
736 737 738 739 740 741 742
    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"
-}

743
-- | Test whether a 'DynFlag' is set
744 745 746
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

747
-- | Set a 'DynFlag'
748 749 750
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

751
-- | Unset a 'DynFlag'
752 753 754
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

755 756 757 758
-- | 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
759
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
760
        -- We add to the options from the front, so we need to reverse the list
761

762 763
-- | 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
764
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
765 766
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
767 768
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
769 770
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
771
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
772
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
773 774 775 776 777
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

778 779 780 781
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
782
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
783
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
784

785 786
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
787 788 789 790
setHcSuf      f d = d{ hcSuf      = f}

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

792 793 794 795 796 797 798
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) }
799
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
800

801 802
setDumpPrefixForce f d = d { dumpPrefixForce = f}

803 804 805 806 807 808 809 810 811 812 813 814
-- 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,[])}
815
setPgmwindres f d = d{ pgm_windres = f}
816 817 818 819 820 821 822 823

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

826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
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