DynFlags.hs 98.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
        wayNames,
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 34 35 36
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
37
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
38

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

        -- * 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
61
        Printable(..),
62
        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
import PrelNames        ( mAIN )
73
import StaticFlags
74
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
75
import DriverPhases     ( Phase(..), phaseInputExt )
76 77
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
78
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
79
import Panic
80
import Util
81
import Maybes           ( orElse )
82
import SrcLoc
83
import FastString
84
import FiniteMap
85
import BasicTypes	( CompilerPhase )
Simon Marlow's avatar
Simon Marlow committed
86 87
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
88

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

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

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

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

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

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

196 197

   -- language opts
198 199 200
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
201
   | Opt_MonomorphismRestriction
202
   | Opt_MonoPatBinds
203
   | Opt_MonoLocalBinds
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
207
   | Opt_GHCForeignImportPrim
Ian Lynagh's avatar
Ian Lynagh committed
208 209
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
210
   | Opt_TemplateHaskell
211
   | Opt_QuasiQuotes
212
   | Opt_ImplicitParams
213
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
214
   | Opt_ImplicitPrelude
215
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
216
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
217
   | Opt_BangPatterns
218
   | Opt_TypeFamilies
219
   | Opt_OverloadedStrings
220
   | Opt_DisambiguateRecordFields
221
   | Opt_RecordWildCards
222
   | Opt_RecordPuns
223
   | Opt_ViewPatterns
224
   | Opt_GADTs
225
   | Opt_RelaxedPolyRec
226
   | Opt_NPlusKPatterns
227

228
   | Opt_StandaloneDeriving
229
   | Opt_DeriveDataTypeable
230
   | Opt_DeriveFunctor
231 232 233
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

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

264 265
   | Opt_PrintExplicitForalls

266 267 268
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
269 270
   | Opt_FloatIn
   | Opt_Specialise
271
   | Opt_StaticArgumentTransformation
272
   | Opt_CSE
273 274
   | Opt_LiberateCase
   | Opt_SpecConstr
275 276 277 278 279
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
280
   | Opt_MethodSharing
281
   | Opt_DictsCheap
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

287 288 289 290 291
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
292 293 294 295 296
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
326 327
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
328
   | Opt_AutoLinkPackages
329
   | Opt_ImplicitImportQualified
330
   | Opt_TryNewCodeGen
331 332 333 334 335 336 337

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
338
   | Opt_KeepRawTokenStream
339

340
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
341

342 343
-- | 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
344
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
345 346 347 348 349
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
350
  hscOutName            :: String,      -- ^ Name of the output file
351
  extCoreName           :: String,      -- ^ Name of the .hcr output file
352
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
353 354 355
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
356
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
357
  ruleCheck             :: Maybe String,
358
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
359

360 361 362
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
363

364
#ifndef OMIT_NATIVE_CODEGEN
365
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
366
#endif
Ian Lynagh's avatar
Ian Lynagh committed
367
  stolen_x86_regs       :: Int,
368
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
369 370 371
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
372
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
373

374 375
  dphBackend            :: DPHBackend,

376
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
377 378

  -- ways
379
  ways                  :: [Way],       -- ^ Way flags from the command line
380 381
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
382

383 384 385
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

386
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
387
  objectDir             :: Maybe String,
388
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
389 390
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
391

Ian Lynagh's avatar
Ian Lynagh committed
392 393 394
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
395

Ian Lynagh's avatar
Ian Lynagh committed
396 397 398
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
399

400
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
401 402
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
403

404 405
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
406 407 408 409 410 411 412 413
  dumpPrefixForce       :: Maybe FilePath,

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

414 415 416
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

419
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
420 421 422 423 424 425 426 427
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
428 429

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
430 431 432 433 434 435 436 437 438
  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]),
439 440
  pgm_T                 :: String,
  pgm_sysman            :: String,
441
  pgm_windres           :: String,
442

443 444 445 446 447 448
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

449
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
450
  extraPkgConfs         :: [FilePath],
451 452
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
453
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
454
        -- they appeared.
455

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

459
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
460
  -- NB. do not modify this field, it is calculated by
461
  -- Packages.initPackages and Packages.updatePackages.
462
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
463
  pkgState              :: PackageState,
464

465 466 467 468 469 470
  -- 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),

471
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
472 473
  flags                 :: [DynFlag],

474
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
475 476 477
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
478 479
 }

480 481 482
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

511
-- | Will this target result in an object file on the disk?
512 513 514 515 516 517 518 519 520 521 522
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.
523
data GhcMode
524 525 526
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
527 528
  deriving Eq

529 530 531 532 533
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

534 535 536 537
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

538 539 540 541
-- | 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
542 543
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
544
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
545
  deriving (Eq, Show)
546 547 548

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

551 552 553
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
554 555 556
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
557

558 559
data PackageFlag
  = ExposePackage  String
560
  | ExposePackageId String
561 562
  | HidePackage    String
  | IgnorePackage  String
563
  deriving Eq
564

twanvl's avatar
twanvl committed
565
defaultHscTarget :: HscTarget
566 567
defaultHscTarget = defaultObjectTarget

568
-- | The 'HscTarget' value corresponding to the default way to create
569
-- object files on the current platform.
twanvl's avatar
twanvl committed
570
defaultObjectTarget :: HscTarget
571
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
572 573
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
574

575 576 577 578 579 580
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

581
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
582
initDynFlags :: DynFlags -> IO DynFlags
583 584 585
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
586 587
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
588
 return dflags{
589 590 591
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
592 593
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
594
        }
595

596 597
-- | 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
598
defaultDynFlags :: DynFlags
599 600
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
601 602 603 604 605 606 607 608 609
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
610
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
611
        maxSimplIterations      = 4,
612
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
613 614 615
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
616
        liberateCaseThreshold   = Just 200,
617 618
        strictnessBefore        = [],

619
#ifndef OMIT_NATIVE_CODEGEN
620
        targetPlatform          = defaultTargetPlatform,
621
#endif
Ian Lynagh's avatar
Ian Lynagh committed
622 623 624 625 626 627 628
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

629 630
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
631 632 633
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
634
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
635 636 637 638 639 640 641 642 643
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
644
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
645 646 647 648 649 650 651 652 653 654 655 656
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
657
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
658 659 660 661 662 663
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
664
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
665 666 667

        extraPkgConfs           = [],
        packageFlags            = [],
668 669
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
670
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
671 672
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
673
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
674 675 676 677
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
678
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
679 680 681 682 683 684 685 686 687 688 689 690 691
        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
692 693 694 695 696 697
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
698 699
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
700
        haddockOptions = Nothing,
701
        flags = [
702
            Opt_AutoLinkPackages,
703 704 705 706 707 708 709 710
            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,
711
            Opt_NPlusKPatterns,
712

713 714
            Opt_MethodSharing,

715 716
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
717 718
            Opt_SharedImplib,

719
            Opt_GenManifest,
720 721
            Opt_EmbedManifest,
            Opt_PrintBindContents
722 723 724 725 726
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
727
        log_action = \severity srcSpan style msg ->
728
                        case severity of
729 730 731 732 733 734 735 736
                          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.
737 738
      }

Ian Lynagh's avatar
Ian Lynagh committed
739
{-
740 741
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
742
    0   |   print errors & warnings only
743 744 745 746 747 748 749
    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"
-}

750
-- | Test whether a 'DynFlag' is set
751 752 753
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

754
-- | Set a 'DynFlag'
755 756 757
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

758
-- | Unset a 'DynFlag'
759 760 761
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

762 763 764 765
-- | 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
766
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
767
        -- We add to the options from the front, so we need to reverse the list
768

769 770
-- | 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
771
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
772 773
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
774 775
  | otherwise =  ""

776
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
777
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
778
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
779
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
780 781 782 783 784
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

785 786 787 788
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
789
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
790
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
791
setDylibInstallName  f d = d{ dylibInstallName = Just f}
792

793 794
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
795 796 797 798
setHcSuf      f d = d{ hcSuf      = f}

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

800 801 802 803 804 805 806
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) }
807
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
808

809 810
setDumpPrefixForce f d = d { dumpPrefixForce = f}

811 812 813 814 815 816 817 818 819 820 821 822
-- 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,[])}
823
setPgmwindres f d = d{ pgm_windres = f}
824 825 826 827 828 829 830 831

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

834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
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
851
deOptDep x = case stripPrefix "-optdep" x of
852 853 854
             Just rest -> rest
             Nothing -> x

855 856
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
857 858
addHaddockOpts f d = d{ haddockOptions = Just f}

859 860 861
-- -----------------------------------------------------------------------------
-- Command-line options

862
-- | When invoking external tools as part of the compilation pipeline, we
863 864
-- 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
865
-- between filepaths and 'other stuff'. The reason for this is that
866
-- this type gives us a handle on transforming filenames, and filenames only,
867
-- to whatever format they're expected to be on a particular platform.
868 869
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
870 871 872
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
873
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
874

Ian Lynagh's avatar
Ian Lynagh committed
875 876 877 878
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

879 880 881 882
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
883
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
884
updOptLevel n dfs
885
  = dfs2{ optLevel = final_n }
886
  where