DynFlags.hs 90.9 KB
Newer Older
1

2
-- |
3 4 5 6 7 8
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

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

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

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

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 61

        -- * Configuration of the core-to-core passes
        CoreToDo(..),
        SimplifierMode(..),
        SimplifierSwitch(..),
        FloatOutSwitches(..),
        getCoreToDo,

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

        -- * Compiler configuration suitable for display to the user
        compilerInfo
62 63 64 65
  ) where

#include "HsVersions.h"

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

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

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

98 99 100
-- -----------------------------------------------------------------------------
-- DynFlags

101
-- | Enumerates the simple on-or-off dynamic flags
102 103 104 105
data DynFlag

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

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

   -- language opts
193 194 195
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
196
   | Opt_MonomorphismRestriction
197
   | Opt_MonoPatBinds
Ian Lynagh's avatar
Ian Lynagh committed
198
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
199
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
200
   | Opt_UnliftedFFITypes
Ian Lynagh's avatar
Ian Lynagh committed
201 202
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
203
   | Opt_TemplateHaskell
204
   | Opt_QuasiQuotes
205
   | Opt_ImplicitParams
206
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
207
   | Opt_ImplicitPrelude
208
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
209
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
210
   | Opt_BangPatterns
211
   | Opt_TypeFamilies
212
   | Opt_OverloadedStrings
213
   | Opt_DisambiguateRecordFields
214
   | Opt_RecordWildCards
215
   | Opt_RecordPuns
216
   | Opt_ViewPatterns
217
   | Opt_GADTs
218
   | Opt_RelaxedPolyRec
219
   | Opt_StandaloneDeriving
220
   | Opt_DeriveDataTypeable
221
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
222
   | Opt_FlexibleContexts
223
   | Opt_FlexibleInstances
224
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
225
   | Opt_MultiParamTypeClasses
226
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
227
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
228
   | Opt_PolymorphicComponents
229
   | Opt_ExistentialQuantification
230
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
231
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
232
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
233
   | Opt_ParallelListComp
234
   | Opt_TransformListComp
235
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
236
   | Opt_RecursiveDo
237
   | Opt_PostfixOperators
Ian Lynagh's avatar
Ian Lynagh committed
238
   | Opt_PatternGuards
239
   | Opt_LiberalTypeSynonyms
240 241
   | Opt_Rank2Types
   | Opt_RankNTypes
242
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
243
   | Opt_TypeOperators
244
   | Opt_PackageImports
245
   | Opt_NewQualifiedOperators
246

247 248
   | Opt_PrintExplicitForalls

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

Ian Lynagh's avatar
Ian Lynagh committed
271 272 273 274 275
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
302 303
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
304
   | Opt_AutoLinkPackages
305
   | Opt_ImplicitImportQualified
306
   | Opt_TryNewCodeGen
307 308 309 310 311 312 313

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
314
   | Opt_KeepRawTokenStream
315

316
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
317

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

335 336 337
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
338

Ian Lynagh's avatar
Ian Lynagh committed
339
  stolen_x86_regs       :: Int,
340
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
341 342 343
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
344
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
345

346 347
  dphBackend            :: DPHBackend,

348
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
349 350

  -- ways
351 352 353
  wayNames              :: [WayName],   -- ^ Way flags from the command line
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
354

355 356 357
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

358
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
359 360 361
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
362

Ian Lynagh's avatar
Ian Lynagh committed
363 364 365
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
366

Ian Lynagh's avatar
Ian Lynagh committed
367 368 369
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
370

371
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
372 373
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
374

375 376
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
377 378 379 380 381 382 383 384
  dumpPrefixForce       :: Maybe FilePath,

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

385 386 387
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

390
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
391 392 393 394 395 396 397 398
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
399 400

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
401 402 403 404 405 406 407 408 409
  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]),
410 411
  pgm_T                 :: String,
  pgm_sysman            :: String,
412
  pgm_windres           :: String,
413

414 415 416 417 418 419
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

420
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
421
  extraPkgConfs         :: [FilePath],
422 423
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
424
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
425
        -- they appeared.
426

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

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

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
437 438
  flags                 :: [DynFlag],

439
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
440 441 442
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
443 444
 }

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

473
-- | Will this target result in an object file on the disk?
474 475 476 477 478 479 480 481 482 483 484
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.
485
data GhcMode
486 487 488
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
489 490
  deriving Eq

491 492 493 494 495
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

496 497 498 499
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

500 501 502 503
-- | 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
504 505
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
506
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
507
  deriving (Eq, Show)
508 509 510

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
511
isNoLink _      = False
512 513 514 515 516

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
517
  deriving Eq
518

twanvl's avatar
twanvl committed
519
defaultHscTarget :: HscTarget
520 521
defaultHscTarget = defaultObjectTarget

522
-- | The 'HscTarget' value corresponding to the default way to create
523
-- object files on the current platform.
twanvl's avatar
twanvl committed
524
defaultObjectTarget :: HscTarget
525
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
526 527
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
528

529 530 531 532 533 534
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

535
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
536
initDynFlags :: DynFlags -> IO DynFlags
537 538 539 540 541 542
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
 build_tag <- readIORef v_Build_tag
 rts_build_tag <- readIORef v_RTS_Build_tag
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
543 544 545 546
        wayNames        = ways,
        buildTag        = build_tag,
        rtsBuildTag     = rts_build_tag
        }
547

548 549
-- | 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
550
defaultDynFlags :: DynFlags
551 552
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
553 554 555 556 557 558 559 560 561
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
562
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
563
        maxSimplIterations      = 4,
564
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
565 566 567
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
568
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
569 570 571 572 573 574 575
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

576 577
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
        thisPackage             = mainPackageId,

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

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

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

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
603
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
604 605 606 607 608 609
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
610
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
611 612 613

        extraPkgConfs           = [],
        packageFlags            = [],
614 615
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
616 617 618
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
619
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
620 621 622 623
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
624
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
625 626 627 628 629 630 631 632 633 634 635 636 637
        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
638 639 640 641 642 643
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
Ian Lynagh's avatar
Ian Lynagh committed
644
        haddockOptions = Nothing,
645
        flags = [
646
            Opt_AutoLinkPackages,
647 648 649 650 651 652 653 654 655
            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,

656 657
            Opt_MethodSharing,

658 659
            Opt_DoAsmMangling,

660
            Opt_GenManifest,
661 662
            Opt_EmbedManifest,
            Opt_PrintBindContents
663 664 665 666 667
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
668
        log_action = \severity srcSpan style msg ->
669
                        case severity of
670 671 672 673 674 675 676 677
                          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.
678 679
      }

Ian Lynagh's avatar
Ian Lynagh committed
680
{-
681
    #verbosity_levels#
682
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
683 684

    0   |   print errors & warnings only
685 686 687 688 689 690 691
    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"
-}

692
-- | Test whether a 'DynFlag' is set
693 694 695
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

696
-- | Set a 'DynFlag'
697 698 699
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

700
-- | Unset a 'DynFlag'
701 702 703
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

704 705 706 707
-- | 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
708
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
709
        -- We add to the options from the front, so we need to reverse the list
710

711 712
-- | 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
713
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
714 715
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
716 717
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
718 719
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
720
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
721
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
722 723 724 725 726
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

727 728 729 730
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
731
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
732
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
733

734 735
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
736 737 738 739
setHcSuf      f d = d{ hcSuf      = f}

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

741 742 743 744 745 746 747
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) }
748
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
749

750 751
setDumpPrefixForce f d = d { dumpPrefixForce = f}

752 753 754 755 756 757 758 759 760 761 762 763
-- 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,[])}
764
setPgmwindres f d = d{ pgm_windres = f}
765 766 767 768 769 770 771 772

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

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }

addDepExcludeMod :: String -> DynFlags -> DynFlags
addDepExcludeMod m d
    = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }

addDepSuffix :: FilePath -> DynFlags -> DynFlags
addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }

-- XXX Legacy code:
-- We used to use "-optdep-flag -optdeparg", so for legacy applications
-- we need to strip the "-optdep" off of the arg
deOptDep :: String -> String
deOptDep x = case maybePrefixMatch "-optdep" x of
             Just rest -> rest
             Nothing -> x

796 797
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
798 799
addHaddockOpts f d = d{ haddockOptions = Just f}

800 801 802
-- -----------------------------------------------------------------------------
-- Command-line options

803
-- | When invoking external tools as part of the compilation pipeline, we
804 805
-- 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
806
-- between filepaths and 'other stuff'. The reason for this is that
807
-- this type gives us a handle on transforming filenames, and filenames only,
808
-- to whatever format they're expected to be on a particular platform.
809 810
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
811 812 813
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
814
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
815

816 817 818 819
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
820
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
821
updOptLevel n dfs
822
  = dfs2{ optLevel = final_n }
823
  where
Ian Lynagh's avatar
Ian Lynagh committed
824
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
825 826 827
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

828 829
   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
830

831 832
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
833
  = [ ([0],     Opt_IgnoreInterfacePragmas)
834
    , ([0],     Opt_OmitInterfacePragmas)
835

Ian Lynagh's avatar
Ian Lynagh committed
836
    , ([1,2],   Opt_IgnoreAsserts)
837 838
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
839 840 841 842 843
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
844

Ian Lynagh's avatar
Ian Lynagh committed
845 846
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
847 848 849 850 851 852 853 854 855 856

--     , ([2],     Opt_StaticArgumentTransformation)
-- Max writes: I think it's probably best not to enable SAT with -O2 for the
-- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
-- several improvements to the heuristics, and I'm concerned that without
-- those changes SAT will interfere with some attempts to write "high
-- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
-- this year. In particular, the version in HEAD lacks the tail call
-- criterion, so many things that look like reasonable loops will be
-- turned into functions with extra (unneccesary) thunk creation.
857 858

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
859 860 861 862
                -- This one is important for a tiresome reason:
                -- we want to make sure that the bindings for data
                -- constructors are eta-expanded.  This is probably
                -- a good thing anyway, but it seems fragile.
863 864 865 866 867
    ]

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

twanvl's avatar
twanvl committed
868
standardWarnings :: [DynFlag]
869
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
870
    = [ Opt_WarnWarningsDeprecations,
871
        Opt_WarnDeprecatedFlags,
872
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
873 874 875
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
876 877
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
878 879
      ]

twanvl's avatar
twanvl committed
880
minusWOpts :: [DynFlag]
881
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
882 883 884 885 886 887
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
888 889
      ]

twanvl's avatar
twanvl committed
890
minusWallOpts :: [DynFlag]
891 892
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
893 894 895 896 897
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
898 899
      ]

900
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
901
minuswRemovesOpts :: [DynFlag]
902 903 904 905 906 907
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
908
       Opt_WarnUnrecognisedPragmas,
909 910 911
       Opt_WarnTabs
      ]

912 913 914
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
915 916 917
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
918

Ian Lynagh's avatar
Ian Lynagh committed
919 920 921 922 923
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
924 925 926 927 928 929 930 931 932 933 934 935
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
936 937
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
938
  | CoreDoVectorisation PackageId
Ian Lynagh's avatar
Ian Lynagh committed
939 940
  | CoreDoNothing                -- Useful when building up
  | CoreDoPasses [CoreToDo]      -- lists of these things
941

942

Ian Lynagh's avatar
Ian Lynagh committed
943
data SimplifierMode             -- See comments in SimplMonad