DynFlags.hs 89.7 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 271 272 273

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

	-- temporary flags
   | Opt_RunCPS
297 298
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
299
   | Opt_AutoLinkPackages
300
   | Opt_ImplicitImportQualified
301
   | Opt_TryNewCodeGen
302 303 304 305 306 307 308

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
309
   | Opt_KeepRawTokenStream
310

311
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
312

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

330 331 332
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
333

Ian Lynagh's avatar
Ian Lynagh committed
334
  stolen_x86_regs       :: Int,
335
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
336 337 338
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
339
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
340

341 342
  dphBackend            :: DPHBackend,

343
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
344 345

  -- ways
346 347 348
  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
349

350 351 352
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

353
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
354 355 356
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
357

Ian Lynagh's avatar
Ian Lynagh committed
358 359 360
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
361

Ian Lynagh's avatar
Ian Lynagh committed
362 363 364
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
365

366
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
367 368
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
369

370 371
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
372 373 374 375 376 377 378 379
  dumpPrefixForce       :: Maybe FilePath,

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

380 381 382
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

385
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
386 387 388 389 390 391 392 393
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
394 395

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
396 397 398 399 400 401 402 403 404
  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]),
405 406
  pgm_T                 :: String,
  pgm_sysman            :: String,
407
  pgm_windres           :: String,
408

409 410 411 412 413 414
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

415
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
416
  extraPkgConfs         :: [FilePath],
417 418
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
419
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
420
        -- they appeared.
421

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

425
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
426
  -- NB. do not modify this field, it is calculated by
427
  -- Packages.initPackages and Packages.updatePackages.
428
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
429
  pkgState              :: PackageState,
430 431

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
432 433
  flags                 :: [DynFlag],

434
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
435 436 437
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
438 439
 }

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

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

486 487 488 489 490
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

491 492 493 494
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
506
isNoLink _      = False
507 508 509 510 511

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
512
  deriving Eq
513

twanvl's avatar
twanvl committed
514
defaultHscTarget :: HscTarget
515 516
defaultHscTarget = defaultObjectTarget

517
-- | The 'HscTarget' value corresponding to the default way to create
518
-- object files on the current platform.
twanvl's avatar
twanvl committed
519
defaultObjectTarget :: HscTarget
520
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
521 522
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
523

524 525 526 527 528 529
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

530
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
531
initDynFlags :: DynFlags -> IO DynFlags
532 533 534 535 536 537
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
538 539 540 541
        wayNames        = ways,
        buildTag        = build_tag,
        rtsBuildTag     = rts_build_tag
        }
542

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

571 572
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
        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
598
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
599 600 601 602 603 604
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
605
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
606 607 608

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

651 652
            Opt_MethodSharing,

653 654
            Opt_DoAsmMangling,

655
            Opt_GenManifest,
656 657
            Opt_EmbedManifest,
            Opt_PrintBindContents
658 659 660 661 662
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
663
        log_action = \severity srcSpan style msg ->
664
                        case severity of
665 666 667 668 669 670 671 672
                          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.
673 674
      }

Ian Lynagh's avatar
Ian Lynagh committed
675
{-
676
    #verbosity_levels#
677
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
678 679

    0   |   print errors & warnings only
680 681 682 683 684 685 686
    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"
-}

687
-- | Test whether a 'DynFlag' is set
688 689 690
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

691
-- | Set a 'DynFlag'
692 693 694
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

695
-- | Unset a 'DynFlag'
696 697 698
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

699 700 701 702
-- | 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
703
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
704
        -- We add to the options from the front, so we need to reverse the list
705

706 707
-- | 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
708
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
709 710
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
711 712
  | otherwise =  ""

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

722 723 724 725
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
726
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
727
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
728

729 730
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
731 732 733 734
setHcSuf      f d = d{ hcSuf      = f}

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

736 737 738 739 740 741 742
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) }
743
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
744

745 746
setDumpPrefixForce f d = d { dumpPrefixForce = f}

747 748 749 750 751 752 753 754 755 756 757 758
-- 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,[])}
759
setPgmwindres f d = d{ pgm_windres = f}
760 761 762 763 764 765 766 767

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

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
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

791 792
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
793 794
addHaddockOpts f d = d{ haddockOptions = Just f}

795 796 797
-- -----------------------------------------------------------------------------
-- Command-line options

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

811 812 813 814
-----------------------------------------------------------------------------
-- Setting the optimisation level

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

823 824
   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
825

826 827
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
828
  = [ ([0],     Opt_IgnoreInterfacePragmas)
829
    , ([0],     Opt_OmitInterfacePragmas)
830

Ian Lynagh's avatar
Ian Lynagh committed
831
    , ([1,2],   Opt_IgnoreAsserts)
832 833
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
834 835 836 837 838
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
839

Ian Lynagh's avatar
Ian Lynagh committed
840 841
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
842 843 844 845 846 847 848 849 850 851

--     , ([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.
852 853

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
854 855 856 857
                -- 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.
858 859 860 861 862
    ]

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

twanvl's avatar
twanvl committed
863
standardWarnings :: [DynFlag]
864
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
865
    = [ Opt_WarnWarningsDeprecations,
866
        Opt_WarnDeprecatedFlags,
867
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
868 869 870
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
871 872
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
873 874
      ]

twanvl's avatar
twanvl committed
875
minusWOpts :: [DynFlag]
876
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
877 878 879 880 881 882
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
883 884
      ]

twanvl's avatar
twanvl committed
885
minusWallOpts :: [DynFlag]
886 887
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
888 889 890 891 892
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
893 894
      ]

895
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
896
minuswRemovesOpts :: [DynFlag]
897 898 899 900 901 902
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
903
       Opt_WarnUnrecognisedPragmas,
904 905 906
       Opt_WarnTabs
      ]

907 908 909
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
910 911 912
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
913

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

937

Ian Lynagh's avatar
Ian Lynagh committed
938
data SimplifierMode             -- See comments in SimplMonad
939
  = SimplGently
940
  | SimplPhase Int [String]
941