DynFlags.hs 92.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
        LanguageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
17 18 19 20 21
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
22
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
23
        DynLibLoader(..),
24
        fFlags, fLangFlags, xFlags,
25
        dphPackage,
26
        wayNames,
27

28
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
29 30 31
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO 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

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

        -- * Compiler configuration suitable for display to the user
54
        Printable(..),
55
        compilerInfo
56 57 58 59
  ) where

#include "HsVersions.h"

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

81
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
82
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
83

84
import Data.Char
85
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
86
import System.FilePath
87
import System.IO        ( stderr, hPutChar )
88

89 90 91
-- -----------------------------------------------------------------------------
-- DynFlags

92
-- | Enumerates the simple on-or-off dynamic flags
93 94 95 96
data DynFlag

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

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

191 192
   | Opt_PrintExplicitForalls

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

214 215 216 217 218
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
219 220 221 222 223
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
254 255
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
256
   | Opt_AutoLinkPackages
257
   | Opt_ImplicitImportQualified
258
   | Opt_TryNewCodeGen
259 260 261 262 263 264 265

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
266
   | Opt_KeepRawTokenStream
267
   | Opt_KeepLlvmFiles
268

269
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
270

271 272 273 274 275 276 277 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
data LanguageFlag
   = 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)

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

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

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

372 373
  dphBackend            :: DPHBackend,

374
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
375 376

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

381 382 383
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

384
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
385
  objectDir             :: Maybe String,
386
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
387 388
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
389

Ian Lynagh's avatar
Ian Lynagh committed
390 391 392
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
393

Ian Lynagh's avatar
Ian Lynagh committed
394 395 396
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
397

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

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

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

412 413
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
414
  rtsOpts               :: Maybe String,
415

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

418
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
419 420 421 422 423 424 425 426
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
427 428
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
429 430

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
431 432 433 434 435 436 437 438 439
  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]),
440 441
  pgm_T                 :: String,
  pgm_sysman            :: String,
442
  pgm_windres           :: String,
443 444
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
445

446 447 448 449 450 451
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

452
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
453
  extraPkgConfs         :: [FilePath],
454 455
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
456
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
457
        -- they appeared.
458

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

462
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
463
  -- NB. do not modify this field, it is calculated by
464
  -- Packages.initPackages and Packages.updatePackages.
465
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
466
  pkgState              :: PackageState,
467

468 469 470 471 472 473
  -- 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),

474
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
475
  flags                 :: [DynFlag],
476
  languageFlags         :: [LanguageFlag],
Ian Lynagh's avatar
Ian Lynagh committed
477

478
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
479 480 481
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
482 483
 }

484 485 486
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

516
-- | Will this target result in an object file on the disk?
517 518 519
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
520
isObjectTarget HscLlvm  = True
521 522 523 524 525 526 527 528
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.
529
data GhcMode
530 531 532
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
533 534
  deriving Eq

535 536 537 538 539
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

540 541 542 543
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

544 545 546 547
-- | 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
548 549
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
550
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
551
  deriving (Eq, Show)
552 553 554

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

557 558 559
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
560 561 562
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.
563

564 565
data PackageFlag
  = ExposePackage  String
566
  | ExposePackageId String
567 568
  | HidePackage    String
  | IgnorePackage  String
569
  deriving Eq
570

twanvl's avatar
twanvl committed
571
defaultHscTarget :: HscTarget
572 573
defaultHscTarget = defaultObjectTarget

574
-- | The 'HscTarget' value corresponding to the default way to create
575
-- object files on the current platform.
twanvl's avatar
twanvl committed
576
defaultObjectTarget :: HscTarget
577
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
578 579
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
580

581 582 583 584 585 586
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

587
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
588
initDynFlags :: DynFlags -> IO DynFlags
589 590 591
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
592 593
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
594
 return dflags{
595 596 597
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
598 599
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
600
        }
601

602 603
-- | 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
604
defaultDynFlags :: DynFlags
605 606
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
607 608 609 610 611 612 613
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
614
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
615
        maxSimplIterations      = 4,
616
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
617 618 619
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
620
        liberateCaseThreshold   = Just 200,
621 622
        strictnessBefore        = [],

623
#ifndef OMIT_NATIVE_CODEGEN
624
        targetPlatform          = defaultTargetPlatform,
625
#endif
Ian Lynagh's avatar
Ian Lynagh committed
626 627 628 629 630 631 632
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

633 634
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
635 636 637
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
638
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
639 640 641 642 643 644 645 646 647
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
648
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
649 650 651 652 653 654 655
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
656
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
657 658 659 660 661

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
662
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
663 664 665 666 667 668
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
669
        opt_windres             = [],
670 671
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
672 673 674

        extraPkgConfs           = [],
        packageFlags            = [],
675 676
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
677
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
678 679
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
680
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
681 682 683 684
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
685
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
686 687 688 689 690 691 692 693 694 695 696 697
        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",
698 699
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
700
        -- end of initSysTools values
701 702 703 704 705 706
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
707 708
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
709
        haddockOptions = Nothing,
710
        flags = [
711
            Opt_AutoLinkPackages,
712 713
            Opt_ReadUserPackageConf,

714 715
            Opt_MethodSharing,

716 717
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
718 719
            Opt_SharedImplib,

720
            Opt_GenManifest,
721 722
            Opt_EmbedManifest,
            Opt_PrintBindContents
723 724 725 726 727
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

728 729 730 731 732 733 734 735 736 737 738
        languageFlags = [
            Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
                                -- behaviour the default, to see if anyone notices
                                -- SLPJ July 06

            Opt_ImplicitPrelude,
            Opt_MonomorphismRestriction,
            Opt_NPlusKPatterns,
            Opt_DatatypeContexts
            ],

Ian Lynagh's avatar
Ian Lynagh committed
739
        log_action = \severity srcSpan style msg ->
740
                        case severity of
741 742 743 744 745 746 747 748
                          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.
749 750
      }

Ian Lynagh's avatar
Ian Lynagh committed
751
{-
752 753
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
754
    0   |   print errors & warnings only
755 756 757 758 759 760 761
    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"
-}

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
-- 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'

instance DOpt LanguageFlag where
    dopt = lopt
    dopt_set = lopt_set
    dopt_unset = lopt_unset

779
-- | Test whether a 'DynFlag' is set
780 781
dopt' :: DynFlag -> DynFlags -> Bool
dopt' f dflags  = f `elem` (flags dflags)
782

783
-- | Set a 'DynFlag'
784 785
dopt_set' :: DynFlags -> DynFlag -> DynFlags
dopt_set' dfs f = dfs{ flags = f : flags dfs }
786

787
-- | Unset a 'DynFlag'
788 789 790 791 792 793 794 795 796 797 798 799 800 801
dopt_unset' :: DynFlags -> DynFlag -> DynFlags
dopt_unset' dfs f = dfs{ flags = filter (/= f) (flags dfs) }

-- | Test whether a 'LanguageFlag' is set
lopt :: LanguageFlag -> DynFlags -> Bool
lopt f dflags  = f `elem` languageFlags dflags

-- | Set a 'LanguageFlag'
lopt_set :: DynFlags -> LanguageFlag -> DynFlags
lopt_set dfs f = dfs{ languageFlags = f : languageFlags dfs }

-- | Unset a 'LanguageFlag'
lopt_unset :: DynFlags -> LanguageFlag -> DynFlags
lopt_unset dfs f = dfs{ languageFlags = filter (/= f) (languageFlags dfs) }
802

803 804 805 806
-- | 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
807
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
808
        -- We add to the options from the front, so we need to reverse the list
809

810 811
-- | 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
812
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
813 814
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
815 816
  | otherwise =  ""

817
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
818
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
819
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
820 821 822
         setPgmlo, setPgmlc,
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres, addOptlo, addOptlc,
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
823 824 825 826
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

827 828 829 830
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
831
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
832
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
833
setDylibInstallName  f d = d{ dylibInstallName = Just f}
834

835 836
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
837 838 839 840
setHcSuf      f d = d{ hcSuf      = f}

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

842 843 844 845 846 847 848
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) }
849
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
850

851 852
setDumpPrefixForce f d = d { dumpPrefixForce = f}

853 854 855 856 857 858 859 860 861 862 863 864
-- 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,[])}
865
setPgmwindres f d = d{ pgm_windres = f}
866 867
setPgmlo  f d = d{ pgm_lo  = (f,[])}
setPgmlc  f d = d{ pgm_lc  = (f,[])}
868 869 870 871 872 873 874 875

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}
876
addOptwindres f d = d{ opt_windres = f : opt_windres d}
877 878
addOptlo  f d = d{ opt_lo  = f : opt_lo d}
addOptlc  f d = d{ opt_lc  = f : opt_lc d}
879

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
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
897
deOptDep x = case stripPrefix "-optdep" x of
898 899 900
             Just rest -> rest
             Nothing -> x

901 902
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
903 904
addHaddockOpts f d = d{ haddockOptions = Just f}

905 906 907
-- -----------------------------------------------------------------------------
-- Command-line options

908
-- | When invoking external tools as part of the compilation pipeline, we
909 910
-- 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
911
-- between filepaths and 'other stuff'. The reason for this is that
912
-- this type gives us a handle on transforming filenames, and filenames only,
913
-- to whatever format they're expected to be on a particular platform.
914 915
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
916 917 918
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
919
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
920

Ian Lynagh's avatar
Ian Lynagh committed
921 922 923 924
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

925 926 927 928
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
929
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
930
updOptLevel n dfs
931
  = dfs2{ optLevel = final_n }
932
  where
Ian Lynagh's avatar
Ian Lynagh committed
933
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
934 935 936
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

937 938
   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
939

940 941
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
942
  = [ ([0],     Opt_IgnoreInterfacePragmas)
943
    , ([0],     Opt_OmitInterfacePragmas)
944

Ian Lynagh's avatar
Ian Lynagh committed
945
    , ([1,2],   Opt_IgnoreAsserts)
946 947
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules