DynFlags.hs 91.5 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
87
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
88 89
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
90

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

94
import Data.Char
95
import Data.List        ( intersperse )
Ian Lynagh's avatar
Ian Lynagh committed
96
import System.FilePath
97
import System.IO        ( stderr, hPutChar )
98

99 100 101
-- -----------------------------------------------------------------------------
-- DynFlags

102
-- | Enumerates the simple on-or-off dynamic flags
103 104 105 106
data DynFlag

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

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

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

248 249
   | Opt_PrintExplicitForalls

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

Ian Lynagh's avatar
Ian Lynagh committed
272 273 274 275 276
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
303 304
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
305
   | Opt_AutoLinkPackages
306
   | Opt_ImplicitImportQualified
307
   | Opt_TryNewCodeGen
308 309 310 311 312 313 314

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
315
   | Opt_KeepRawTokenStream
316

317
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
318

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

336 337 338
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
339

Ian Lynagh's avatar
Ian Lynagh committed
340
  stolen_x86_regs       :: Int,
341
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
342 343 344
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
345
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
346

347 348
  dphBackend            :: DPHBackend,

349
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
350 351

  -- ways
352 353 354
  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
355

356 357 358
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

359
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
360 361 362
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
363

Ian Lynagh's avatar
Ian Lynagh committed
364 365 366
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
367

Ian Lynagh's avatar
Ian Lynagh committed
368 369 370
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
371

372
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
373 374
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
375

376 377
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
378 379 380 381 382 383 384 385
  dumpPrefixForce       :: Maybe FilePath,

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

386 387 388
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

391
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
392 393 394 395 396 397 398 399
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
400 401

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
402 403 404 405 406 407 408 409 410
  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]),
411 412
  pgm_T                 :: String,
  pgm_sysman            :: String,
413
  pgm_windres           :: String,
414

415 416 417 418 419 420
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

421
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
422
  extraPkgConfs         :: [FilePath],
423 424
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
425
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
426
        -- they appeared.
427

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

431
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
432
  -- NB. do not modify this field, it is calculated by
433
  -- Packages.initPackages and Packages.updatePackages.
434
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
435
  pkgState              :: PackageState,
436

437 438 439 440 441 442
  -- 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),

443
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
444 445
  flags                 :: [DynFlag],

446
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
447 448 449
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
450 451
 }

452 453
-- | The target code type of the compilation (if any).
--
454 455 456
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
457 458 459 460
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
461 462 463
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
464
--
465 466 467 468 469 470
--  * 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.)
471
--
472
data HscTarget
473 474 475 476 477
  = 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.
478 479
  deriving (Eq, Show)

480
-- | Will this target result in an object file on the disk?
481 482 483 484 485 486 487 488 489 490 491
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.
492
data GhcMode
493 494 495
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
496 497
  deriving Eq

498 499 500 501 502
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

503 504 505 506
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

507 508 509 510
-- | 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
511 512
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
513
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
514
  deriving (Eq, Show)
515 516 517

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
518
isNoLink _      = False
519 520 521 522 523

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
524
  deriving Eq
525

twanvl's avatar
twanvl committed
526
defaultHscTarget :: HscTarget
527 528
defaultHscTarget = defaultObjectTarget

529
-- | The 'HscTarget' value corresponding to the default way to create
530
-- object files on the current platform.
twanvl's avatar
twanvl committed
531
defaultObjectTarget :: HscTarget
532
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
533 534
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
535

536 537 538 539 540 541
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

542
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
543
initDynFlags :: DynFlags -> IO DynFlags
544 545 546 547 548
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
549 550
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
551
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
552 553
        wayNames        = ways,
        buildTag        = build_tag,
554 555 556
        rtsBuildTag     = rts_build_tag,
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
557
        }
558

559 560
-- | 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
561
defaultDynFlags :: DynFlags
562 563
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
564 565 566 567 568 569 570 571 572
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
573
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
574
        maxSimplIterations      = 4,
575
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
576 577 578
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
579
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
580 581 582 583 584 585 586
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

587 588
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
        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
614
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
615 616 617 618 619 620
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
621
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
622 623 624

        extraPkgConfs           = [],
        packageFlags            = [],
625 626
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
627 628 629
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
630
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
631 632 633 634
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
635
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
636 637 638 639 640 641 642 643 644 645 646 647 648
        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
649 650 651 652 653 654
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
655 656
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
657
        haddockOptions = Nothing,
658
        flags = [
659
            Opt_AutoLinkPackages,
660 661 662 663 664 665 666 667 668
            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,

669 670
            Opt_MethodSharing,

671 672
            Opt_DoAsmMangling,

673
            Opt_GenManifest,
674 675
            Opt_EmbedManifest,
            Opt_PrintBindContents
676 677 678 679 680
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
681
        log_action = \severity srcSpan style msg ->
682
                        case severity of
683 684 685 686 687 688 689 690
                          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.
691 692
      }

Ian Lynagh's avatar
Ian Lynagh committed
693
{-
694
    #verbosity_levels#
695
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
696 697

    0   |   print errors & warnings only
698 699 700 701 702 703 704
    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"
-}

705
-- | Test whether a 'DynFlag' is set
706 707 708
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

709
-- | Set a 'DynFlag'
710 711 712
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

713
-- | Unset a 'DynFlag'
714 715 716
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

717 718 719 720
-- | 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
721
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
722
        -- We add to the options from the front, so we need to reverse the list
723

724 725
-- | 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
726
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
727 728
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
729 730
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
731 732
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
733
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
734
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
735 736 737 738 739
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

740 741 742 743
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
744
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
745
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
746

747 748
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
749 750 751 752
setHcSuf      f d = d{ hcSuf      = f}

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

754 755 756 757 758 759 760
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) }
761
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
762

763 764
setDumpPrefixForce f d = d { dumpPrefixForce = f}

765 766 767 768 769 770 771 772 773 774 775 776
-- 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,[])}
777
setPgmwindres f d = d{ pgm_windres = f}
778 779 780 781 782 783 784 785

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

788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
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

809 810
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
811 812
addHaddockOpts f d = d{ haddockOptions = Just f}

813 814 815
-- -----------------------------------------------------------------------------
-- Command-line options

816
-- | When invoking external tools as part of the compilation pipeline, we
817 818
-- 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
819
-- between filepaths and 'other stuff'. The reason for this is that
820
-- this type gives us a handle on transforming filenames, and filenames only,
821
-- to whatever format they're expected to be on a particular platform.
822 823
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
824 825 826
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
827
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
828

829 830 831 832
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
833
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
834
updOptLevel n dfs
835
  = dfs2{ optLevel = final_n }
836
  where
Ian Lynagh's avatar
Ian Lynagh committed
837
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
838 839 840
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

841 842
   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
843

844 845
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
846
  = [ ([0],     Opt_IgnoreInterfacePragmas)
847
    , ([0],     Opt_OmitInterfacePragmas)
848

Ian Lynagh's avatar
Ian Lynagh committed
849
    , ([1,2],   Opt_IgnoreAsserts)
850 851
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
852 853 854 855 856
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
857

Ian Lynagh's avatar
Ian Lynagh committed
858 859
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
860 861 862 863 864 865 866 867 868 869

--     , ([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