DynFlags.hs 93.1 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
        updOptLevel,
        setTmpDir,
        setPackageName,
38
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
39

40
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
41
        parseDynamicFlags,
42
        parseDynamicNoPackageFlags,
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
#ifndef OMIT_NATIVE_CODEGEN
68
import Platform
69
#endif
70
import Module
Simon Marlow's avatar
Simon Marlow committed
71
import PackageConfig
72 73 74
import PrelNames        ( mAIN, main_RDR_Unqual )
import RdrName          ( RdrName, mkRdrUnqual )
import OccName          ( mkVarOccFS )
Ian Lynagh's avatar
Ian Lynagh committed
75
#if defined(i386_TARGET_ARCH) || (!defined(mingw32_TARGET_OS) && !defined(darwin_TARGET_OS))
Ian Lynagh's avatar
Ian Lynagh committed
76
import StaticFlags      ( opt_Static )
Simon Marlow's avatar
Simon Marlow committed
77
#endif
Ian Lynagh's avatar
Ian Lynagh committed
78 79
import StaticFlags      ( opt_PIC, WayName(..), v_Ways, v_Build_tag,
                          v_RTS_Build_tag )
80
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
81
import DriverPhases     ( Phase(..), phaseInputExt )
82 83
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
84
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
85
import Panic
86
import UniqFM           ( UniqFM )
87
import Util
88
import Maybes           ( orElse )
89
import SrcLoc
90
import FastString
91
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
92 93
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
94

95
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
96
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
97

98
import Data.Char
99
import Data.List        ( intersperse )
Ian Lynagh's avatar
Ian Lynagh committed
100
import System.FilePath
101
import System.IO        ( stderr, hPutChar )
102

103 104 105
-- -----------------------------------------------------------------------------
-- DynFlags

106
-- | Enumerates the simple on-or-off dynamic flags
107 108 109 110
data DynFlag

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

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

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

254 255
   | Opt_PrintExplicitForalls

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

Ian Lynagh's avatar
Ian Lynagh committed
278 279 280 281 282
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

283 284 285
   -- misc opts
   | Opt_Cpp
   | Opt_Pp
286
   | Opt_ForceRecomp
287 288 289
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
290
   | Opt_EagerBlackHoling
291 292 293 294
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
295
   | Opt_HideAllPackages
296
   | Opt_PrintBindResult
297
   | Opt_Haddock
David Waern's avatar
David Waern committed
298
   | Opt_HaddockOptions
299
   | Opt_Hpc_No_Auto
300
   | Opt_BreakOnException
301
   | Opt_BreakOnError
302
   | Opt_PrintEvldWithShow
303
   | Opt_PrintBindContents
304 305
   | Opt_GenManifest
   | Opt_EmbedManifest
306 307 308

	-- temporary flags
   | Opt_RunCPS
309 310
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
311
   | Opt_AutoLinkPackages
312
   | Opt_ImplicitImportQualified
313
   | Opt_TryNewCodeGen
314 315 316 317 318 319 320

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
321
   | Opt_KeepRawTokenStream
322

323
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
324

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

342 343 344
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
345

346
#ifndef OMIT_NATIVE_CODEGEN
347
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
348
#endif
Ian Lynagh's avatar
Ian Lynagh committed
349
  stolen_x86_regs       :: Int,
350
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
351 352 353
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
354
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
355

356 357
  dphBackend            :: DPHBackend,

358
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
359 360

  -- ways
361 362 363
  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
364

365 366 367
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

368
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
369 370 371
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
372

Ian Lynagh's avatar
Ian Lynagh committed
373 374 375
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
376

Ian Lynagh's avatar
Ian Lynagh committed
377 378 379
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
380

381
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
382 383
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
384

385 386
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
387 388 389 390 391 392 393 394
  dumpPrefixForce       :: Maybe FilePath,

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

395 396 397
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

400
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
401 402 403 404 405 406 407 408
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
409 410

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
411 412 413 414 415 416 417 418 419
  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]),
420 421
  pgm_T                 :: String,
  pgm_sysman            :: String,
422
  pgm_windres           :: String,
423

424 425 426 427 428 429
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

430
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
431
  extraPkgConfs         :: [FilePath],
432 433
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
434
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
435
        -- they appeared.
436

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

440
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
441
  -- NB. do not modify this field, it is calculated by
442
  -- Packages.initPackages and Packages.updatePackages.
443
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
444
  pkgState              :: PackageState,
445

446 447 448 449 450 451
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
  dirsToClean           :: IORef (FiniteMap FilePath FilePath),

452
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
453 454
  flags                 :: [DynFlag],

455
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
456 457 458
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
459 460
 }

461 462
-- | The target code type of the compilation (if any).
--
463 464 465
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
466 467 468 469
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
470 471 472
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
473
--
474 475 476 477 478 479
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
480
--
481
data HscTarget
482 483 484 485 486
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
487 488
  deriving (Eq, Show)

489
-- | Will this target result in an object file on the disk?
490 491 492 493 494 495 496 497 498 499 500
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.
501
data GhcMode
502 503 504
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
505 506
  deriving Eq

507 508 509 510 511
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

512 513 514 515
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

516 517 518 519
-- | 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
520 521
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
522
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
523
  deriving (Eq, Show)
524 525 526

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
527
isNoLink _      = False
528

529 530 531 532 533
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

534 535 536 537
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
538
  deriving Eq
539

twanvl's avatar
twanvl committed
540
defaultHscTarget :: HscTarget
541 542
defaultHscTarget = defaultObjectTarget

543
-- | The 'HscTarget' value corresponding to the default way to create
544
-- object files on the current platform.
twanvl's avatar
twanvl committed
545
defaultObjectTarget :: HscTarget
546
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
547 548
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
549

550 551 552 553 554 555
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

556
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
557
initDynFlags :: DynFlags -> IO DynFlags
558 559 560 561 562
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
563 564
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
565
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
566 567
        wayNames        = ways,
        buildTag        = build_tag,
568 569 570
        rtsBuildTag     = rts_build_tag,
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
571
        }
572

573 574
-- | 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
575
defaultDynFlags :: DynFlags
576 577
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
578 579 580 581 582 583 584 585 586
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
587
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
588
        maxSimplIterations      = 4,
589
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
590 591 592
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
593
        liberateCaseThreshold   = Just 200,
594
#ifndef OMIT_NATIVE_CODEGEN
595
        targetPlatform          = defaultTargetPlatform,
596
#endif
Ian Lynagh's avatar
Ian Lynagh committed
597 598 599 600 601 602 603
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

604 605
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
606 607 608 609 610 611 612 613 614 615 616 617
        thisPackage             = mainPackageId,

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

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

        outputFile              = Nothing,
        outputHi                = Nothing,
618
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
619 620 621 622 623 624 625 626 627 628 629 630
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
631
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
632 633 634 635 636 637
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
638
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
639 640 641

        extraPkgConfs           = [],
        packageFlags            = [],
642 643
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
644 645 646
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
647
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
648 649 650 651
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
652
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
653 654 655 656 657 658 659 660 661 662 663 664 665
        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
666 667 668 669 670 671
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
672 673
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
674
        haddockOptions = Nothing,
675
        flags = [
676
            Opt_AutoLinkPackages,
677 678 679 680 681 682 683 684 685
            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,

686 687
            Opt_MethodSharing,

688 689
            Opt_DoAsmMangling,

690
            Opt_GenManifest,
691 692
            Opt_EmbedManifest,
            Opt_PrintBindContents
693 694 695 696 697
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
698
        log_action = \severity srcSpan style msg ->
699
                        case severity of
700 701 702 703 704 705 706 707
                          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.
708 709
      }

Ian Lynagh's avatar
Ian Lynagh committed
710
{-
711
    #verbosity_levels#
712
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
713 714

    0   |   print errors & warnings only
715 716 717 718 719 720 721
    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"
-}

722
-- | Test whether a 'DynFlag' is set
723 724 725
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

726
-- | Set a 'DynFlag'
727 728 729
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

730
-- | Unset a 'DynFlag'
731 732 733
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

734 735 736 737
-- | 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
738
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
739
        -- We add to the options from the front, so we need to reverse the list
740

741 742
-- | 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
743
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
744 745
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
746 747
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
748 749
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
750
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
751
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
752 753 754 755 756
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

757 758 759 760
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
761
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
762
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
763

764 765
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
766 767 768 769
setHcSuf      f d = d{ hcSuf      = f}

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

771 772 773 774 775 776 777
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) }
778
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
779

780 781
setDumpPrefixForce f d = d { dumpPrefixForce = f}

782 783 784 785 786 787 788 789 790 791 792 793
-- 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,[])}
794
setPgmwindres f d = d{ pgm_windres = f}
795 796 797 798 799 800 801 802

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

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

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

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

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

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

826 827
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
828 829
addHaddockOpts f d = d{ haddockOptions = Just f}

830 831 832
-- -----------------------------------------------------------------------------
-- Command-line options

833
-- | When invoking external tools as part of the compilation pipeline, we
834 835
-- 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
836
-- between filepaths and 'other stuff'. The reason for this is that
837
-- this type gives us a handle on transforming filenames, and filenames only,
838
-- to whatever format they're expected to be on a particular platform.
839 840
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
841 842 843
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
844
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
845

846 847 848 849
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
850
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
851
updOptLevel n dfs
852
  = dfs2{ optLevel = final_n }
853
  where
Ian Lynagh's avatar
Ian Lynagh committed
854
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
855 856 857
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

858 859
   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
860

861 862
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
863
  = [ ([0],     Opt_IgnoreInterfacePragmas)
864
    , ([0],     Opt_OmitInterfacePragmas)
865

Ian Lynagh's avatar
Ian Lynagh committed
866
    , ([1,2],   Opt_IgnoreAsserts)
867 868
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
869 870 871 872 873
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
874

Ian Lynagh's avatar
Ian Lynagh committed
875 876
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
877 878 879 880 881 882 883 884 885 886

--     , ([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.
887 888

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
889 890 891 892
                -- 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.
893 894 895 896 897
    ]

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

twanvl's avatar
twanvl committed
898
standardWarnings :: [DynFlag]
899
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
900
    = [ Opt_WarnWarningsDeprecations,
901
        Opt_WarnDeprecatedFlags,
902
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
903 904 905
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
906 907
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
908 909
      ]

twanvl's avatar
twanvl committed
910
minusWOpts :: [DynFlag]
911
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
912 913 914 915 916 917
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports