DynFlags.hs 83.4 KB
Newer Older
1

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

11 12 13 14
-- | Most flags are dynamic flags, which means they can change from
-- 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.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
17 18 19 20 21 22 23 24
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
25
        fFlags, xFlags,
26
        DPHBackend(..),
27

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

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

41
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
42
        parseDynamicFlags,
43
        allFlags,
44

45 46 47
        supportedLanguages, languageOptions,

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

        -- * 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
63 64 65 66
  ) where

#include "HsVersions.h"

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

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

94
import Data.Char
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
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 205
   | Opt_ImplicitParams
   | Opt_Generics
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_PatternSignatures
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

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

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles

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

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

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

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

333 334
  dphBackend            :: DPHBackend,

Ian Lynagh's avatar
Ian Lynagh committed
335
  thisPackage           :: PackageId,
336 337

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

460 461 462 463 464 465
-- | 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)
466
  deriving (Eq, Show)
467 468 469

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
470
isNoLink _      = False
471 472 473 474 475

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
476
  deriving Eq
477

twanvl's avatar
twanvl committed
478
defaultHscTarget :: HscTarget
479 480
defaultHscTarget = defaultObjectTarget

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

488 489 490 491 492 493
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

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

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

535 536
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
537 538 539 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
        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                   = [],
569
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
570 571 572

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

615 616
            Opt_MethodSharing,

617 618
            Opt_DoAsmMangling,

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

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

Ian Lynagh's avatar
Ian Lynagh committed
639
{-
640
    #verbosity_levels#
641
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
642 643

    0   |   print errors & warnings only
644 645 646 647 648 649 650
    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"
-}

651
-- | Test whether a 'DynFlag' is set
652 653 654
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

655
-- | Set a 'DynFlag'
656 657 658
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

659
-- | Unset a 'DynFlag'
660 661 662
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

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

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

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

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

691 692
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
693 694 695 696
setHcSuf      f d = d{ hcSuf      = f}

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

698 699 700 701 702 703 704 705 706
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"

707 708
setDumpPrefixForce f d = d { dumpPrefixForce = f}

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

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

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

756 757
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
758 759
addHaddockOpts f d = d{ haddockOptions = Just f}

760 761 762
-- -----------------------------------------------------------------------------
-- Command-line options

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

776 777 778 779
-----------------------------------------------------------------------------
-- Setting the optimisation level

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

788 789
   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
790

791 792
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
793
  = [ ([0],     Opt_IgnoreInterfacePragmas)
794
    , ([0],     Opt_OmitInterfacePragmas)
795

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

Ian Lynagh's avatar
Ian Lynagh committed
805 806 807
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
    , ([2],     Opt_StaticArgumentTransformation)
808 809

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
810 811 812 813
                -- 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.
814 815 816 817 818
    ]

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

twanvl's avatar
twanvl committed
819
standardWarnings :: [DynFlag]
820
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
821
    = [ Opt_WarnWarningsDeprecations,
822
        Opt_WarnDeprecatedFlags,
823
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
824 825 826
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
827 828
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
829 830
      ]

twanvl's avatar
twanvl committed
831
minusWOpts :: [DynFlag]
832
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
833 834 835 836 837 838
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
839 840
      ]

twanvl's avatar
twanvl committed
841
minusWallOpts :: [DynFlag]
842 843
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
844 845 846 847 848
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
849 850
      ]

851
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
852
minuswRemovesOpts :: [DynFlag]
853 854 855 856 857 858
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
859
       Opt_WarnUnrecognisedPragmas,
860 861 862
       Opt_WarnTabs
      ]

863 864 865
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
866 867 868
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
869

Ian Lynagh's avatar
Ian Lynagh committed
870 871 872 873 874
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
875 876 877 878 879 880 881 882 883 884 885 886
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
887 888
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
889
  | CoreDoVectorisation DPHBackend
Ian Lynagh's avatar
Ian Lynagh committed
890 891
  | CoreDoNothing                -- Useful when building up
  | CoreDoPasses [CoreToDo]      -- lists of these things
892

Ian Lynagh's avatar
Ian Lynagh committed
893
data SimplifierMode             -- See comments in SimplMonad
894
  = SimplGently
895
  | SimplPhase Int [String]
896 897 898 899 900 901

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

data FloatOutSwitches
Ian Lynagh's avatar
Ian Lynagh committed
902 903 904
  = FloatOutSw  Bool    -- True <=> float lambdas to top level
                Bool    -- True <=> float constants to top level,
                        --          even if they do not escape a lambda
905 906 907


-- The core-to-core pass ordering is derived from the DynFlags:
908 909
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
twanvl's avatar
twanvl committed
910
runWhen False _       = CoreDoNothing
911

912 913 914 915
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

916 917 918 919 920
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
921
    opt_level     = optLevel dflags
922
    phases        = simplPhases dflags
Ian Lynagh's avatar
Ian Lynagh committed
923
    max_iter      = maxSimplIterations dflags
924 925 926
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
927 928
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
929
    rule_check    = ruleCheck dflags
930
    static_args   = dopt Opt_StaticArgumentTransformation dflags
931

932
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
933

934 935 936 937 938 939 940
    simpl_phase phase names iter
      = CoreDoPasses
          [ CoreDoSimplify (SimplPhase phase names) [
              MaxSimplifierIterations iter
            ],
            maybe_rule_check phase
          ]
941

942 943 944 945 946
    vectorisation
      = runWhen (dopt Opt_Vectorise dflags)
        $ CoreDoPasses [ simpl_gently, CoreDoVectorisation (dphBackend dflags) ]


947 948
                -- By default, we have 2 phases before phase 0.

Ian Lynagh's avatar
Ian Lynagh committed
949 950 951 952
                -- 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.
953

Ian Lynagh's avatar
Ian Lynagh committed
954 955 956 957
                -- Need phase 1 so that build/augment get
                -- inlined.  I found that spectral/hartel/genfft lost some useful
                -- strictness in the function sumcode' if augment is not inlined
                -- before strictness analysis runs
958
    simpl_phases = CoreDoPasses [ simpl_phase phase ["main"] max_iter
959 960
                                  | phase <- [phases, phases-1 .. 1] ]

961

Ian Lynagh's avatar
Ian Lynagh committed
962
        -- initial simplify: mk specialiser happy: minimum effort please
963
    simpl_gently = CoreDoSimplify SimplGently [
Ian Lynagh's avatar
Ian Lynagh committed
964 965 966 967 968 969 970 971 972 973 974 975 976 977
                        --      Simplify "gently"
                        -- Don't inline anything till full laziness has bitten
                        -- In particular, inlining wrappers inhibits floating
                        -- e.g. ...(case f x of ...)...
                        --  ==> ...(case (case x of I# x# -> fw x#) of ...)...
                        --  ==> ...(case x of I# x# -> case fw x# of ...)...
                        -- and now the redex (f x) isn't floatable any more
                        -- Similarly, don't apply any rules until after full
                        -- laziness.  Notably, list fusion can prevent floating.

            NoCaseOfCase,       -- Don't do case-of-case transformations.
                                -- This makes full laziness work better
            MaxSimplifierIterations max_iter
        ]
978

rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
979
    core_todo =
980
     if opt_level == 0 then