DynFlags.hs 96.6 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
14
        DOpt(..),
Ian Lynagh's avatar
Ian Lynagh committed
15
        DynFlag(..),
16 17 18
        ExtensionFlag(..),
        flattenExtensionFlags,
        ensureFlattenedExtensionFlags,
19 20
        lopt_set_flattened,
        lopt_unset_flattened,
Ian Lynagh's avatar
Ian Lynagh committed
21
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
22
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
23 24 25 26
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
28
        DynLibLoader(..),
29
        fFlags, fLangFlags, xFlags,
30
        dphPackage,
31
        wayNames,
32

33
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
34 35 36
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

37
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
38 39 40 41
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
42
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
43

44
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
45
        parseDynamicFlags,
46
        parseDynamicNoPackageFlags,
47
        allFlags,
48

49
        supportedLanguagesAndExtensions,
50 51

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
52
        machdepCCOpts, picCCOpts,
53 54 55 56 57 58

        -- * Configuration of the stg-to-stg passes
        StgToDo(..),
        getStgToDo,

        -- * Compiler configuration suitable for display to the user
59
        Printable(..),
60
        compilerInfo
61 62 63 64
  ) where

#include "HsVersions.h"

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

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

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

94 95 96
-- -----------------------------------------------------------------------------
-- DynFlags

97
-- | Enumerates the simple on-or-off dynamic flags
98 99 100 101
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
165
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
166 167
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
168
   | Opt_WarnImplicitPrelude
169 170 171
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
172
   | Opt_WarnMissingImportList
173 174 175 176 177 178
   | 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
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
194
   | Opt_WarnAlternativeLayoutRuleTransitional
195

196 197
   | Opt_PrintExplicitForalls

198 199 200
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
201 202
   | Opt_FloatIn
   | Opt_Specialise
203
   | Opt_StaticArgumentTransformation
204
   | Opt_CSE
205 206
   | Opt_LiberateCase
   | Opt_SpecConstr
207 208 209 210 211
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
212
   | Opt_MethodSharing
213
   | Opt_DictsCheap
214
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
215
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
216 217
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
218

219 220 221 222 223
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
224 225 226 227 228
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

229 230
   -- misc opts
   | Opt_Pp
231
   | Opt_ForceRecomp
232 233 234
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
235
   | Opt_EagerBlackHoling
236 237 238 239
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
240
   | Opt_HideAllPackages
241
   | Opt_PrintBindResult
242
   | Opt_Haddock
David Waern's avatar
David Waern committed
243
   | Opt_HaddockOptions
244
   | Opt_Hpc_No_Auto
245
   | Opt_BreakOnException
246
   | Opt_BreakOnError
247
   | Opt_PrintEvldWithShow
248
   | Opt_PrintBindContents
249 250
   | Opt_GenManifest
   | Opt_EmbedManifest
251
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
252
   | Opt_SharedImplib
253
   | Opt_BuildingCabalPackage
254
   | Opt_SSE2
255 256 257

	-- temporary flags
   | Opt_RunCPS
258 259
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
260
   | Opt_AutoLinkPackages
261
   | Opt_ImplicitImportQualified
262
   | Opt_TryNewCodeGen
263 264 265 266 267 268 269

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
270
   | Opt_KeepRawTokenStream
271
   | Opt_KeepLlvmFiles
272

273
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
274

275 276
data Language = Haskell98 | Haskell2010

277
data ExtensionFlag
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_Generics			-- "Derivable type classes"
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
   | Opt_RelaxedPolyRec
   | Opt_NPlusKPatterns

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_NewQualifiedOperators
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
   deriving (Eq, Show)

348 349
-- | 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
350
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
351 352 353
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
354
  hscOutName            :: String,      -- ^ Name of the output file
355
  extCoreName           :: String,      -- ^ Name of the .hcr output file
356
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
357 358 359
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
360
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
361
  ruleCheck             :: Maybe String,
362
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
363

364 365 366
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
367

368
#ifndef OMIT_NATIVE_CODEGEN
369
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
370
#endif
Ian Lynagh's avatar
Ian Lynagh committed
371
  stolen_x86_regs       :: Int,
372
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
373 374 375
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
376
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
377

378 379
  dphBackend            :: DPHBackend,

380
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
381 382

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

387 388 389
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

390
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
391
  objectDir             :: Maybe String,
392
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
393 394
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
395

Ian Lynagh's avatar
Ian Lynagh committed
396 397 398
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
399

Ian Lynagh's avatar
Ian Lynagh committed
400 401 402
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
403

404
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
405 406
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
407

408 409
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
410 411 412 413 414 415 416 417
  dumpPrefixForce       :: Maybe FilePath,

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

418 419
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
420
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
421
  rtsOptsEnabled        :: RtsOptsEnabled,
422

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

425
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
426 427 428 429 430 431 432 433
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
434 435
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
436 437

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
438 439 440 441 442 443 444 445 446
  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]),
447 448
  pgm_T                 :: String,
  pgm_sysman            :: String,
449
  pgm_windres           :: String,
450 451
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
452

453 454 455 456 457 458
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

459
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
460
  extraPkgConfs         :: [FilePath],
461 462
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
463
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
464
        -- they appeared.
465

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

469
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
470
  -- NB. do not modify this field, it is calculated by
471
  -- Packages.initPackages and Packages.updatePackages.
472
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
473
  pkgState              :: PackageState,
474

475 476 477 478 479 480
  -- 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),

481
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
482
  flags                 :: [DynFlag],
483
  language              :: Maybe Language,
484 485
  extensionFlags        :: Either [OnOff ExtensionFlag]
                                  [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
486

487
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
488 489 490
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
491 492
 }

493 494 495
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

496 497
-- | The target code type of the compilation (if any).
--
498 499 500
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
501 502 503 504
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
505 506 507
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
508
--
509 510 511 512 513 514
--  * 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.)
515
--
516
data HscTarget
517 518
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
519
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
520 521 522
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
523 524
  deriving (Eq, Show)

525
-- | Will this target result in an object file on the disk?
526 527 528
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
529
isObjectTarget HscLlvm  = True
530 531 532 533 534 535 536 537
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.
538
data GhcMode
539 540 541
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
542 543
  deriving Eq

544 545 546 547 548
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

549 550 551 552
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

553 554 555 556
-- | 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
557 558
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
559
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
560
  deriving (Eq, Show)
561 562 563

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

566 567 568
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
569 570 571
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
572

573 574
data PackageFlag
  = ExposePackage  String
575
  | ExposePackageId String
576 577
  | HidePackage    String
  | IgnorePackage  String
578
  deriving Eq
579

twanvl's avatar
twanvl committed
580
defaultHscTarget :: HscTarget
581 582
defaultHscTarget = defaultObjectTarget

583
-- | The 'HscTarget' value corresponding to the default way to create
584
-- object files on the current platform.
twanvl's avatar
twanvl committed
585
defaultObjectTarget :: HscTarget
586
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
587 588
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
589

590 591 592 593 594 595
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
596 597
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

598
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
599
initDynFlags :: DynFlags -> IO DynFlags
600 601 602
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
603 604
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
605
 return dflags{
606 607 608
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
609 610
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
611
        }
612

613 614
-- | 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
615
defaultDynFlags :: DynFlags
616 617
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
618 619 620 621 622 623 624
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
625
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
626
        maxSimplIterations      = 4,
627
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
628 629 630
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
631
        liberateCaseThreshold   = Just 200,
632 633
        strictnessBefore        = [],

634
#ifndef OMIT_NATIVE_CODEGEN
635
        targetPlatform          = defaultTargetPlatform,
636
#endif
Ian Lynagh's avatar
Ian Lynagh committed
637 638 639 640 641 642 643
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

644 645
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
646 647 648
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
649
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
650 651 652 653 654 655 656 657 658
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
659
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
660 661 662 663 664 665 666
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
667
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
668
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
669 670 671 672 673

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
674
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
675 676 677 678 679 680
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
681
        opt_windres             = [],
682 683
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
684 685 686

        extraPkgConfs           = [],
        packageFlags            = [],
687 688
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
689
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
690 691
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
692
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
693 694 695 696
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
697
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
698 699 700 701 702 703 704 705 706 707 708 709
        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",
710 711
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
712
        -- end of initSysTools values
713 714 715 716 717 718
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
719 720
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
721
        haddockOptions = Nothing,
722
        flags = [
723
            Opt_AutoLinkPackages,
724 725
            Opt_ReadUserPackageConf,

726 727
            Opt_MethodSharing,

728 729
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
730 731
            Opt_SharedImplib,

732
            Opt_GenManifest,
733 734
            Opt_EmbedManifest,
            Opt_PrintBindContents
735 736 737 738 739
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

740
        language = Nothing,
741
        extensionFlags = Left [],
742

Ian Lynagh's avatar
Ian Lynagh committed
743
        log_action = \severity srcSpan style msg ->
744
                        case severity of
745 746 747 748
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
749 750 751 752 753
                                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.
754 755
      }

Ian Lynagh's avatar
Ian Lynagh committed
756
{-
757 758
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
759
    0   |   print errors & warnings only
760 761 762 763 764 765 766
    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"
-}

767 768 769
data OnOff a = On a
             | Off a

770 771 772
flattenExtensionFlags :: DynFlags -> DynFlags
flattenExtensionFlags dflags
    = case extensionFlags dflags of
773 774
      Left onoffs ->
          dflags {
775
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
776 777
          }
      Right _ ->
778
          panic "Flattening already-flattened extension flags"
779

780 781 782
ensureFlattenedExtensionFlags :: DynFlags -> DynFlags
ensureFlattenedExtensionFlags dflags
    = case extensionFlags dflags of
783 784
      Left onoffs ->
          dflags {
785
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
786 787 788 789 790 791
          }
      Right _ ->
          dflags

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
792 793 794
flattenExtensionFlags' :: Maybe Language -> [OnOff ExtensionFlag]
                       -> [ExtensionFlag]
flattenExtensionFlags' ml = foldr f defaultExtensionFlags
795 796
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
languageExtensions Nothing
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
    : languageExtensions (Just Haskell2010)
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
       Opt_DatatypeContexts]
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
       Opt_RelaxedPolyRec]
818

819 820 821 822 823 824 825 826 827 828 829 830
-- The DOpt class is a temporary workaround, to avoid having to do
-- a mass-renaming dopt->lopt at the moment
class DOpt a where
    dopt :: a -> DynFlags -> Bool
    dopt_set :: DynFlags -> a -> DynFlags
    dopt_unset :: DynFlags -> a -> DynFlags

instance DOpt DynFlag where
    dopt = dopt'
    dopt_set = dopt_set'
    dopt_unset = dopt_unset'

831
instance DOpt ExtensionFlag where
832 833 834 835
    dopt = lopt
    dopt_set = lopt_set
    dopt_unset = lopt_unset

836
-- | Test whether a 'DynFlag' is set
837 838
dopt' :: DynFlag -> DynFlags -> Bool
dopt' f dflags  = f `elem` (flags dflags)
839

840
-- | Set a 'DynFlag'
841 842
dopt_set' :: DynFlags -> DynFlag -> DynFlags
dopt_set' dfs f = dfs{ flags = f : flags dfs }
843

844
-- | Unset a 'DynFlag'
845 846 847
dopt_unset' :: DynFlags -> DynFlag -> DynFlags
dopt_unset' dfs f = dfs{ flags = filter (/= f) (flags dfs) }

848 849 850 851
-- | Test whether a 'ExtensionFlag' is set
lopt :: ExtensionFlag -> DynFlags -> Bool
lopt f dflags = case extensionFlags dflags of
                Left _ -> panic ("Testing for extension flag " ++ show f ++ " before flattening")
852
                Right flags -> f `elem` flags
853

854 855 856 857 858
-- | Set a 'ExtensionFlag'
lopt_set :: DynFlags -> ExtensionFlag -> DynFlags
lopt_set dfs f = case extensionFlags dfs of
                 Left onoffs -> dfs { extensionFlags = Left (On f : onoffs) }
                 Right _ -> panic ("Setting extension flag " ++ show f ++ " after flattening")
859

860 861 862
-- | Set a 'ExtensionFlag'
lopt_set_flattened :: DynFlags -> ExtensionFlag -> DynFlags
lopt_set_flattened dfs f = case extensionFlags dfs of
863
                           Left _ ->
864
                               panic ("Setting extension flag " ++ show f ++ " before flattening, but expected flattened")
865
                           Right flags ->
866
                               dfs { extensionFlags = Right (f : delete f flags) }
867

868 869 870 871 872
-- | Unset a 'ExtensionFlag'
lopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset dfs f = case extensionFlags dfs of
                   Left onoffs -> dfs { extensionFlags = Left (Off f : onoffs) }
                   Right _ -> panic ("Unsetting extension flag " ++ show f ++ " after flattening")
873

874 875 876
-- | Unset a 'ExtensionFlag'
lopt_unset_flattened :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset_flattened dfs f = case extensionFlags dfs of
877
                             Left _ ->
878
                                 panic ("Unsetting extension flag " ++ show f ++ " before flattening, but expected flattened")
879
                             Right flags ->
880
                                 dfs { extensionFlags = Right (delete f flags) }
881

882 883 884 885
-- | 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
886
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
887
        -- We add to the options from the front, so we need to reverse the list
888

889 890
-- | 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
891
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
892 893
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
894 895
  | otherwise =  ""

896
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
897
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
898
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
899 900 901
         setPgmlo, setPgmlc,
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres, addOptlo, addOptlc,
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
902 903 904 905
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

906 907 908 909
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
910
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
911
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
912
setDylibInstallName  f d = d{ dylibInstallName = Just f}
913

914 915
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
916 917 918 919
setHcSuf      f d = d{ hcSuf      = f}

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

921 922 923 924 925 926 927
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) }
928
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
929