DynFlags.hs 94.4 KB
Newer Older
1
-- |
2 3 4 5 6 7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

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

25
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
26 27 28 29 30
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

        dopt,                           -- DynFlag -> DynFlags -> Bool
        dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
31
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
32 33 34 35
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
36
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
37

38
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
39
        parseDynamicFlags,
40
        parseDynamicNoPackageFlags,
41
        allFlags,
42

43 44 45
        supportedLanguages, languageOptions,

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

        -- * 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
60
        Printable(..),
61
        compilerInfo
62 63 64 65
  ) where

#include "HsVersions.h"

66
#ifndef OMIT_NATIVE_CODEGEN
67
import Platform
68
#endif
69
import Module
Simon Marlow's avatar
Simon Marlow committed
70
import PackageConfig
71
import PrelNames        ( mAIN )
Ian Lynagh's avatar
Ian Lynagh committed
72
#if defined(i386_TARGET_ARCH) || (!defined(mingw32_TARGET_OS) && !defined(darwin_TARGET_OS))
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
87
import FastString
88
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
89 90
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
91

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

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

100 101 102
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

199 200

   -- language opts
201 202 203
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
204
   | Opt_MonomorphismRestriction
205
   | Opt_MonoPatBinds
206
   | Opt_MonoLocalBinds
Ian Lynagh's avatar
Ian Lynagh committed
207
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
208
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
209
   | Opt_UnliftedFFITypes
210
   | Opt_GHCForeignImportPrim
Ian Lynagh's avatar
Ian Lynagh committed
211 212
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
213
   | Opt_TemplateHaskell
214
   | Opt_QuasiQuotes
215
   | Opt_ImplicitParams
216
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
217
   | Opt_ImplicitPrelude
218
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
219
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
220
   | Opt_BangPatterns
221
   | Opt_TypeFamilies
222
   | Opt_OverloadedStrings
223
   | Opt_DisambiguateRecordFields
224
   | Opt_RecordWildCards
225
   | Opt_RecordPuns
226
   | Opt_ViewPatterns
227
   | Opt_GADTs
228
   | Opt_RelaxedPolyRec
229

230
   | Opt_StandaloneDeriving
231
   | Opt_DeriveDataTypeable
232
   | Opt_DeriveFunctor
233 234 235
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

236
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_FlexibleContexts
238
   | Opt_FlexibleInstances
239
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
240
   | Opt_MultiParamTypeClasses
241
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
242
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
243
   | Opt_PolymorphicComponents
244
   | Opt_ExistentialQuantification
245
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
246
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
247
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
248
   | Opt_ParallelListComp
249
   | Opt_TransformListComp
250
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
251
   | Opt_RecursiveDo
252
   | Opt_PostfixOperators
253
   | Opt_TupleSections
Ian Lynagh's avatar
Ian Lynagh committed
254
   | Opt_PatternGuards
255
   | Opt_LiberalTypeSynonyms
256 257
   | Opt_Rank2Types
   | Opt_RankNTypes
258
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
259
   | Opt_TypeOperators
260
   | Opt_PackageImports
261
   | Opt_NewQualifiedOperators
262

263 264
   | Opt_PrintExplicitForalls

265 266 267
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
268
   | Opt_StaticArgumentTransformation
269
   | Opt_CSE
270 271
   | Opt_LiberateCase
   | Opt_SpecConstr
272 273 274 275 276 277 278
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
279
   | Opt_MethodSharing
280
   | Opt_DictsCheap
281
   | Opt_InlineIfEnoughArgs
282
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
283
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
284 285
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
286

Ian Lynagh's avatar
Ian Lynagh committed
287 288 289 290 291
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

292 293 294
   -- misc opts
   | Opt_Cpp
   | Opt_Pp
295
   | Opt_ForceRecomp
296 297 298
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
299
   | Opt_EagerBlackHoling
300 301 302 303
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
304
   | Opt_HideAllPackages
305
   | Opt_PrintBindResult
306
   | Opt_Haddock
David Waern's avatar
David Waern committed
307
   | Opt_HaddockOptions
308
   | Opt_Hpc_No_Auto
309
   | Opt_BreakOnException
310
   | Opt_BreakOnError
311
   | Opt_PrintEvldWithShow
312
   | Opt_PrintBindContents
313 314
   | Opt_GenManifest
   | Opt_EmbedManifest
315
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
316
   | Opt_SharedImplib
317 318 319

	-- temporary flags
   | Opt_RunCPS
320 321
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
322
   | Opt_AutoLinkPackages
323
   | Opt_ImplicitImportQualified
324
   | Opt_TryNewCodeGen
325 326 327 328 329 330 331

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
332
   | Opt_KeepRawTokenStream
333

334
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
335

336 337
-- | 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
338
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
339 340 341 342 343
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
344
  hscOutName            :: String,      -- ^ Name of the output file
345
  extCoreName           :: String,      -- ^ Name of the .hcr output file
346 347 348 349
  verbosity             :: Int,         -- ^ Verbosity level: see "DynFlags#verbosity_levels"
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
350
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
351
  ruleCheck             :: Maybe String,
352

353 354 355
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
356

357
#ifndef OMIT_NATIVE_CODEGEN
358
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
359
#endif
Ian Lynagh's avatar
Ian Lynagh committed
360
  stolen_x86_regs       :: Int,
361
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
362 363 364
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
365
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
366

367 368
  dphBackend            :: DPHBackend,

369
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
370 371

  -- ways
372 373 374
  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
375

376 377 378
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

379
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
380 381 382
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
383

Ian Lynagh's avatar
Ian Lynagh committed
384 385 386
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
387

Ian Lynagh's avatar
Ian Lynagh committed
388 389 390
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
391

392
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
393 394
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
395

396 397
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
398 399 400 401 402 403 404 405
  dumpPrefixForce       :: Maybe FilePath,

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

406 407 408
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

411
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
412 413 414 415 416 417 418 419
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
420 421

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
422 423 424 425 426 427 428 429 430
  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]),
431 432
  pgm_T                 :: String,
  pgm_sysman            :: String,
433
  pgm_windres           :: String,
434

435 436 437 438 439 440
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

441
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
442
  extraPkgConfs         :: [FilePath],
443 444
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
445
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
446
        -- they appeared.
447

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

451
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
452
  -- NB. do not modify this field, it is calculated by
453
  -- Packages.initPackages and Packages.updatePackages.
454
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
455
  pkgState              :: PackageState,
456

457 458 459 460 461 462
  -- 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),

463
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
464 465
  flags                 :: [DynFlag],

466
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
467 468 469
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
470 471
 }

472 473
-- | The target code type of the compilation (if any).
--
474 475 476
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
477 478 479 480
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
481 482 483
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
484
--
485 486 487 488 489 490
--  * 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.)
491
--
492
data HscTarget
493 494 495 496 497
  = 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.
498 499
  deriving (Eq, Show)

500
-- | Will this target result in an object file on the disk?
501 502 503 504 505 506 507 508 509 510 511
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.
512
data GhcMode
513 514 515
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
516 517
  deriving Eq

518 519 520 521 522
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

523 524 525 526
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

527 528 529 530
-- | 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
531 532
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
533
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
534
  deriving (Eq, Show)
535 536 537

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

540 541 542 543 544
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

545 546 547 548
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
549
  deriving Eq
550

twanvl's avatar
twanvl committed
551
defaultHscTarget :: HscTarget
552 553
defaultHscTarget = defaultObjectTarget

554
-- | The 'HscTarget' value corresponding to the default way to create
555
-- object files on the current platform.
twanvl's avatar
twanvl committed
556
defaultObjectTarget :: HscTarget
557
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
558 559
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
560

561 562 563 564 565 566
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

567
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
568
initDynFlags :: DynFlags -> IO DynFlags
569 570 571 572 573
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
574 575
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
576
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
577 578
        wayNames        = ways,
        buildTag        = build_tag,
579 580 581
        rtsBuildTag     = rts_build_tag,
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
582
        }
583

584 585
-- | 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
586
defaultDynFlags :: DynFlags
587 588
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
589 590 591 592 593 594 595 596 597
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
598
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
599
        maxSimplIterations      = 4,
600
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
601 602 603
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
604
        liberateCaseThreshold   = Just 200,
605
#ifndef OMIT_NATIVE_CODEGEN
606
        targetPlatform          = defaultTargetPlatform,
607
#endif
Ian Lynagh's avatar
Ian Lynagh committed
608 609 610 611 612 613 614
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

615 616
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
617 618 619 620 621 622 623 624 625 626 627 628
        thisPackage             = mainPackageId,

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

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

        outputFile              = Nothing,
        outputHi                = Nothing,
629
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
630 631 632 633 634 635 636 637 638 639 640 641
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
642
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
643 644 645 646 647 648
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
649
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
650 651 652

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

697 698
            Opt_MethodSharing,

699 700
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
701 702
            Opt_SharedImplib,

703
            Opt_GenManifest,
704 705
            Opt_EmbedManifest,
            Opt_PrintBindContents
706 707 708 709 710
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
711
        log_action = \severity srcSpan style msg ->
712
                        case severity of
713 714 715 716 717 718 719 720
                          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.
721 722
      }

Ian Lynagh's avatar
Ian Lynagh committed
723
{-
724
    #verbosity_levels#
725
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
726 727

    0   |   print errors & warnings only
728 729 730 731 732 733 734
    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"
-}

735
-- | Test whether a 'DynFlag' is set
736 737 738
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

739
-- | Set a 'DynFlag'
740 741 742
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

743
-- | Unset a 'DynFlag'
744 745 746
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

747 748 749 750
-- | 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
751
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
752
        -- We add to the options from the front, so we need to reverse the list
753

754 755
-- | 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
756
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
757 758
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
759 760
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
761 762
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
763
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
764
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
765 766 767 768 769
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

770 771 772 773
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
774
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
775
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
776

777 778
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
779 780 781 782
setHcSuf      f d = d{ hcSuf      = f}

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

784 785 786 787 788 789 790
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) }
791
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
792

793 794
setDumpPrefixForce f d = d { dumpPrefixForce = f}

795 796 797 798 799 800 801 802 803 804 805 806
-- 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,[])}
807
setPgmwindres f d = d{ pgm_windres = f}
808 809 810 811 812 813 814 815

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

818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
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
835
deOptDep x = case stripPrefix "-optdep" x of
836 837 838
             Just rest -> rest
             Nothing -> x

839 840
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
841 842
addHaddockOpts f d = d{ haddockOptions = Just f}

843 844 845
-- -----------------------------------------------------------------------------
-- Command-line options

846
-- | When invoking external tools as part of the compilation pipeline, we
847 848
-- 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
849
-- between filepaths and 'other stuff'. The reason for this is that
850
-- this type gives us a handle on transforming filenames, and filenames only,
851
-- to whatever format they're expected to be on a particular platform.
852 853
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
854 855 856
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
857
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
858

Ian Lynagh's avatar
Ian Lynagh committed
859 860 861 862
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

863 864 865 866
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
867
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
868
updOptLevel n dfs
869
  = dfs2{ optLevel = final_n }
870
  where
Ian Lynagh's avatar
Ian Lynagh committed
871
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
872 873 874
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

875 876
   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
877

878 879
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
880
  = [ ([0],     Opt_IgnoreInterfacePragmas)
881
    , ([0],     Opt_OmitInterfacePragmas)
882

Ian Lynagh's avatar
Ian Lynagh committed
883
    , ([1,2],   Opt_IgnoreAsserts)
884 885
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
886 887 888 889 890
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
891

Ian Lynagh's avatar
Ian Lynagh committed
892 893
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
894 895 896 897 898 899 900 901 902 903

--     , ([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.
904 905

    , ([0,1,2], Opt_DoLambdaEtaExpansion)