DynFlags.hs 86.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
Ian Lynagh's avatar
Ian Lynagh committed
94
import System.FilePath
95
import System.IO        ( stderr, hPutChar )
96

97 98 99
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

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

246 247
   | Opt_PrintExplicitForalls

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

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

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
302
   | Opt_KeepRawTokenStream
303

304
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
305

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

323 324 325
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
326

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

334 335
  dphBackend            :: DPHBackend,

336
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
337 338

  -- ways
339 340 341
  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
342

343
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
344 345 346
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
347

Ian Lynagh's avatar
Ian Lynagh committed
348 349 350
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
351

Ian Lynagh's avatar
Ian Lynagh committed
352 353 354
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
355

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

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

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

370 371 372
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

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

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

399 400 401 402 403 404 405
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],
  depWarnings           :: Bool,

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

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

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

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
423 424
  flags                 :: [DynFlag],

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

  haddockOptions :: Maybe String
429 430 431 432 433 434 435 436 437 438
 }

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

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

457 458 459 460 461
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

462 463 464 465
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

466 467 468 469 470 471
-- | 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)
472
  deriving (Eq, Show)
473 474 475

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
476
isNoLink _      = False
477 478 479 480 481

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
482
  deriving Eq
483

twanvl's avatar
twanvl committed
484
defaultHscTarget :: HscTarget
485 486
defaultHscTarget = defaultObjectTarget

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

494 495 496 497 498 499
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

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

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

541 542
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
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 572 573 574
        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                   = [],
575
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
576 577 578

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

621 622
            Opt_MethodSharing,

623 624
            Opt_DoAsmMangling,

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

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

Ian Lynagh's avatar
Ian Lynagh committed
645
{-
646
    #verbosity_levels#
647
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
648 649

    0   |   print errors & warnings only
650 651 652 653 654 655 656
    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"
-}

657
-- | Test whether a 'DynFlag' is set
658 659 660
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

661
-- | Set a 'DynFlag'
662 663 664
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

665
-- | Unset a 'DynFlag'
666 667 668
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

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

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

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

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

697 698
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
699 700 701 702
setHcSuf      f d = d{ hcSuf      = f}

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

704 705 706 707 708 709 710 711 712
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"

713 714
setDumpPrefixForce f d = d { dumpPrefixForce = f}

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

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

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

762 763
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
764 765
addHaddockOpts f d = d{ haddockOptions = Just f}

766 767 768
-- -----------------------------------------------------------------------------
-- Command-line options

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

782 783 784 785
-----------------------------------------------------------------------------
-- Setting the optimisation level

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

794 795
   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
796

797 798
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
799
  = [ ([0],     Opt_IgnoreInterfacePragmas)
800
    , ([0],     Opt_OmitInterfacePragmas)
801

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

Ian Lynagh's avatar
Ian Lynagh committed
811 812
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
813 814 815 816 817 818 819 820 821 822

--     , ([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.
823 824

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

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

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

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

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

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

878 879 880
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

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

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

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

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

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


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

927 928 929 930
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

931 932 933 934 935
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
936
    opt_level     = optLevel dflags
937
    phases        = simplPhases dflags
Ian Lynagh's avatar
Ian Lynagh committed
938
    max_iter      = maxSimplIterations dflags
939 940 941
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
942 943
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
944
    rule_check    = ruleCheck dflags
945
    static_args   = dopt Opt_StaticArgumentTransformation dflags
946

947
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
948

949 950 951 952 953 954 955
    simpl_phase phase names iter
      = CoreDoPasses
          [ CoreDoSimplify (SimplPhase phase names) [
              MaxSimplifierIterations iter
            ],
            maybe_rule_check phase
          ]
956

957 958
    vectorisation
      = runWhen (dopt Opt_Vectorise dflags)
959
        $ CoreDoPasses [ simpl_gently, CoreDoVectorisation (dphPackage dflags) ]
960 961


rl@cse.unsw.edu.au's avatar