DynFlags.hs 85.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
        allFlags,
42

43 44 45
        supportedLanguages, languageOptions,

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
46
        machdepCCOpts, picCCOpts,
47 48 49 50 51 52 53 54 55 56 57 58 59 60

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

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

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

#include "HsVersions.h"

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

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

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

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

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

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

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

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

243 244
   | Opt_PrintExplicitForalls

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

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

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
299
   | Opt_KeepRawTokenStream
300

301
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
302

303 304
-- | 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
305
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
306 307 308 309 310
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
311
  hscOutName            :: String,      -- ^ Name of the output file
312
  extCoreName           :: String,      -- ^ Name of the .hcr output file
313 314 315 316
  verbosity             :: Int,         -- ^ Verbosity level: see "DynFlags#verbosity_levels"
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
317
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
318
  ruleCheck             :: Maybe String,
319

320 321 322
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
323

Ian Lynagh's avatar
Ian Lynagh committed
324
  stolen_x86_regs       :: Int,
325
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
326 327 328
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
329
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
330

331 332
  dphBackend            :: DPHBackend,

333
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
334 335

  -- ways
336 337 338
  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
339

340
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
341 342 343
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
344

Ian Lynagh's avatar
Ian Lynagh committed
345 346 347
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
348

Ian Lynagh's avatar
Ian Lynagh committed
349 350 351
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
352

353
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
354 355
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
356

357 358
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
359 360 361 362 363 364 365 366
  dumpPrefixForce       :: Maybe FilePath,

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

367 368 369
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

372
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
373 374 375 376 377 378 379 380
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
381 382

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
383 384 385 386 387 388 389 390 391
  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]),
392 393
  pgm_T                 :: String,
  pgm_sysman            :: String,
394
  pgm_windres           :: String,
395

396 397 398 399 400 401 402
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],
  depWarnings           :: Bool,

403
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
404
  extraPkgConfs         :: [FilePath],
405 406
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
407
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
408
        -- they appeared.
409

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

413
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
414
  -- NB. do not modify this field, it is calculated by
415
  -- Packages.initPackages and Packages.updatePackages.
416
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
417
  pkgState              :: PackageState,
418 419

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
420 421
  flags                 :: [DynFlag],

422
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
423 424 425
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
426 427 428 429 430 431 432 433 434 435
 }

data HscTarget
  = HscC
  | HscAsm
  | HscJava
  | HscInterpreted
  | HscNothing
  deriving (Eq, Show)

436
-- | Will this target result in an object file on the disk?
437 438 439 440 441 442 443 444 445 446 447
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.
448
data GhcMode
449 450 451
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
452 453
  deriving Eq

454 455 456 457 458
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

459 460 461 462
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

463 464 465 466 467 468
-- | 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
  | LinkInMemory        -- ^ Use the in-memory dynamic linker
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
469
  deriving (Eq, Show)
470 471 472

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
473
isNoLink _      = False
474 475 476 477 478

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
479
  deriving Eq
480

twanvl's avatar
twanvl committed
481
defaultHscTarget :: HscTarget
482 483
defaultHscTarget = defaultObjectTarget

484
-- | The 'HscTarget' value corresponding to the default way to create
485
-- object files on the current platform.
twanvl's avatar
twanvl committed
486
defaultObjectTarget :: HscTarget
487
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
488 489
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
490

491 492 493 494 495 496
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

497
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
498
initDynFlags :: DynFlags -> IO DynFlags
499 500 501 502 503 504
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
505 506 507 508
        wayNames        = ways,
        buildTag        = build_tag,
        rtsBuildTag     = rts_build_tag
        }
509

510 511
-- | 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
512
defaultDynFlags :: DynFlags
513 514
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
515 516 517 518 519 520 521 522 523
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
524
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
525
        maxSimplIterations      = 4,
526
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
527 528 529
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
530
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
531 532 533 534 535 536 537
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

538 539
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
        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
                                   then ["-D__PIC__"]
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
572
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
573 574 575

        extraPkgConfs           = [],
        packageFlags            = [],
576 577
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
578 579 580 581 582 583 584
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
585
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
586 587 588 589 590 591 592 593 594 595 596 597 598
        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
599 600 601 602 603 604 605
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        depWarnings       = True,
        -- end of ghc -M values
Ian Lynagh's avatar
Ian Lynagh committed
606
        haddockOptions = Nothing,
607
        flags = [
608
            Opt_AutoLinkPackages,
609 610 611 612 613 614 615 616 617
            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,

618 619
            Opt_MethodSharing,

620 621
            Opt_DoAsmMangling,

622
            Opt_GenManifest,
623 624
            Opt_EmbedManifest,
            Opt_PrintBindContents
625 626 627 628 629
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
630
        log_action = \severity srcSpan style msg ->
631
                        case severity of
632 633 634 635 636 637 638 639
                          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.
640 641
      }

Ian Lynagh's avatar
Ian Lynagh committed
642
{-
643
    #verbosity_levels#
644
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
645 646

    0   |   print errors & warnings only
647 648 649 650 651 652 653
    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"
-}

654
-- | Test whether a 'DynFlag' is set
655 656 657
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

658
-- | Set a 'DynFlag'
659 660 661
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

662
-- | Unset a 'DynFlag'
663 664 665
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

666 667 668 669
-- | 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
670
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
671
        -- We add to the options from the front, so we need to reverse the list
672

673 674
-- | 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
675
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
676 677
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
678 679
  | otherwise =  ""

twanvl's avatar
twanvl committed
680 681
setObjectDir, setHiDir, setStubDir, setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
682
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
683 684 685 686 687
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

688 689 690 691
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
692
  -- \#included from the .hc file when compiling with -fvia-C.
693

694 695
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
696 697 698 699
setHcSuf      f d = d{ hcSuf      = f}

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

701 702 703 704 705 706 707 708 709
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) }
   (_,_)                -> error "Unknown dynlib loader"

710 711
setDumpPrefixForce f d = d { dumpPrefixForce = f}

712 713 714 715 716 717 718 719 720 721 722 723
-- 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,[])}
724
setPgmwindres f d = d{ pgm_windres = f}
725 726 727 728 729 730 731 732

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

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
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 }

setDepWarnings :: Bool -> DynFlags -> DynFlags
setDepWarnings b d = d { depWarnings = b }

-- 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

759 760
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
761 762
addHaddockOpts f d = d{ haddockOptions = Just f}

763 764 765
-- -----------------------------------------------------------------------------
-- Command-line options

766
-- | When invoking external tools as part of the compilation pipeline, we
767 768
-- 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
769
-- between filepaths and 'other stuff'. The reason for this is that
770
-- this type gives us a handle on transforming filenames, and filenames only,
771
-- to whatever format they're expected to be on a particular platform.
772 773
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
774 775 776
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
777
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
778

779 780 781 782
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
783
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
784
updOptLevel n dfs
785
  = dfs2{ optLevel = final_n }
786
  where
Ian Lynagh's avatar
Ian Lynagh committed
787
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
788 789 790
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

791 792
   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
793

794 795
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
796
  = [ ([0],     Opt_IgnoreInterfacePragmas)
797
    , ([0],     Opt_OmitInterfacePragmas)
798

Ian Lynagh's avatar
Ian Lynagh committed
799
    , ([1,2],   Opt_IgnoreAsserts)
800 801
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
802 803 804 805 806
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
807

Ian Lynagh's avatar
Ian Lynagh committed
808 809
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
810 811 812 813 814 815 816 817 818 819

--     , ([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.
820 821

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
822 823 824 825
                -- 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.
826 827 828 829 830
    ]

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

twanvl's avatar
twanvl committed
831
standardWarnings :: [DynFlag]
832
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
833
    = [ Opt_WarnWarningsDeprecations,
834
        Opt_WarnDeprecatedFlags,
835
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
836 837 838
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
839 840
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
841 842
      ]

twanvl's avatar
twanvl committed
843
minusWOpts :: [DynFlag]
844
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
845 846 847 848 849 850
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
851 852
      ]

twanvl's avatar
twanvl committed
853
minusWallOpts :: [DynFlag]
854 855
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
856 857 858 859 860
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
861 862
      ]

863
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
864
minuswRemovesOpts :: [DynFlag]
865 866 867 868 869 870
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
871
       Opt_WarnUnrecognisedPragmas,
872 873 874
       Opt_WarnTabs
      ]

875 876 877
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
878 879 880
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
881

Ian Lynagh's avatar
Ian Lynagh committed
882 883 884 885 886
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
887 888 889 890 891 892 893 894 895 896 897 898
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
899 900
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
901
  | CoreDoVectorisation PackageId
Ian Lynagh's avatar
Ian Lynagh committed
902 903
  | CoreDoNothing                -- Useful when building up
  | CoreDoPasses [CoreToDo]      -- lists of these things
904

Ian Lynagh's avatar
Ian Lynagh committed
905
data SimplifierMode             -- See comments in SimplMonad
906
  = SimplGently
907
  | SimplPhase Int [String]
908 909 910 911 912 913

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

data FloatOutSwitches
Ian Lynagh's avatar
Ian Lynagh committed
914 915 916
  = FloatOutSw  Bool    -- True <=> float lambdas to top level
                Bool    -- True <=> float constants to top level,
                        --          even if they do not escape a lambda
917 918 919


-- The core-to-core pass ordering is derived from the DynFlags:
920 921
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
twanvl's avatar
twanvl committed
922
runWhen False _       = CoreDoNothing
923

924 925 926 927
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

928 929 930 931 932
getCoreToDo :: DynFlags -> [CoreToDo]
getCoreToDo dflags
  | Just todo <- coreToDo dflags = todo -- set explicitly by user
  | otherwise = core_todo
  where
Ian Lynagh's avatar
Ian Lynagh committed
933
    opt_level     = optLevel dflags
934
    phases        = simplPhases dflags
Ian Lynagh's avatar
Ian Lynagh committed
935
    max_iter      = maxSimplIterations dflags
936 937 938
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
939 940
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
941
    rule_check    = ruleCheck dflags
942
    static_args   = dopt Opt_StaticArgumentTransformation dflags
943

944
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
945

946 947 948 949 950 951 952
    simpl_phase phase names iter
      = CoreDoPasses
          [ CoreDoSimplify (SimplPhase phase names) [
              MaxSimplifierIterations iter
            ],
            maybe_rule_check phase
          ]
953

954 955
    vectorisation
      = runWhen (dopt Opt_Vectorise dflags)
956
        $ CoreDoPasses [ simpl_gently, CoreDoVectorisation (dphPackage dflags) ]
957 958


959 960
                -- By default, we have 2 phases before phase 0.

Ian Lynagh's avatar
Ian Lynagh committed
961 962 963 964
                -- Want to run with inline phase 2 after the specialiser to give
                -- maximum chance for fusion to work before we inline build/augment
                -- in phase 1.  This made a difference in 'ansi' where an
                -- overloaded function wasn't inlined till too late.
965