DynFlags.hs 105 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
        DynFlag(..),
15
        WarningFlag(..),
16
        ExtensionFlag(..),
17
        LogAction,
18
        glasgowExtsFlags,
19
20
21
        dopt,
        dopt_set,
        dopt_unset,
22
23
24
        wopt,
        wopt_set,
        wopt_unset,
25
26
27
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
28
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
29
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
30
31
32
33
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
34
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
35
        DynLibLoader(..),
36
        fFlags, fWarningFlags, fLangFlags, xFlags,
37
        DPHBackend(..), dphPackageMaybe,
38
        wayNames, dynFlagDependencies,
39

40
        -- ** Safe Haskell
41
        SafeHaskellMode(..),
42
43
        safeHaskellOn, safeLanguageOn,
        safeDirectImpsReq, safeImplicitImpsReq,
44
        packageTrustOn,
45

46
        -- ** System tool settings and locations
47
        Settings(..),
48
        targetPlatform,
49
50
51
52
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
        pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
53
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
54
        opt_windres, opt_lo, opt_lc,
55
56


57
        -- ** Manipulating DynFlags
58
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
59
        initDynFlags,                   -- DynFlags -> IO DynFlags
60
        defaultLogAction,
Ian Lynagh's avatar
Ian Lynagh committed
61

62
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
63
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
64
65
66
        updOptLevel,
        setTmpDir,
        setPackageName,
67
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
68

69
        -- ** Parsing DynFlags
70
71
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
72
        allFlags,
73

74
        supportedLanguagesAndExtensions,
75
76

        -- ** DynFlag C compiler options
77
        picCCOpts,
78
79
80
81
82
83

        -- * Configuration of the stg-to-stg passes
        StgToDo(..),
        getStgToDo,

        -- * Compiler configuration suitable for display to the user
84
85
        compilerInfo
#ifdef GHCI
dterei's avatar
dterei committed
86
-- Only in stage 2 can we be sure that the RTS
87
88
89
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
90
91
92
93
  ) where

#include "HsVersions.h"

94
import Platform
95
import Module
Simon Marlow's avatar
Simon Marlow committed
96
import PackageConfig
97
import PrelNames        ( mAIN )
98
import StaticFlags
99
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
100
import DriverPhases     ( Phase(..), phaseInputExt )
101
102
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
103
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
104
import Panic
105
import Util
106
import Maybes           ( orElse )
107
import SrcLoc
108
import FastString
Simon Marlow's avatar
Simon Marlow committed
109
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
110
#ifdef GHCI
111
import Foreign.C        ( CInt )
Ian Lynagh's avatar
Ian Lynagh committed
112
#endif
Simon Marlow's avatar
Simon Marlow committed
113
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
114

Ian Lynagh's avatar
Ian Lynagh committed
115
#ifdef GHCI
116
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
117
#endif
118
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
119
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
120

121
import Data.Char
122
import Data.List
123
124
import Data.Map (Map)
import qualified Data.Map as Map
125
126
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
127
import System.FilePath
128
import System.IO        ( stderr, hPutChar )
129

130
131
132
-- -----------------------------------------------------------------------------
-- DynFlags

133
-- | Enumerates the simple on-or-off dynamic flags
134
135
136
137
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
138
   | Opt_D_dump_raw_cmm
139
   | Opt_D_dump_cmmz
140
   | Opt_D_dump_cmmz_pretty
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_spills
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_dead
   | Opt_D_dump_cmmz_stub
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_lower
   | Opt_D_dump_cmmz_info
   | Opt_D_dump_cmmz_cafs
   -- end cmmz subflags
156
   | Opt_D_dump_cps_cmm
157
   | Opt_D_dump_cvt_cmm
158
   | Opt_D_dump_asm
159
160
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
161
   | Opt_D_dump_asm_coalesce
162
163
164
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
165
   | Opt_D_dump_asm_stats
166
   | Opt_D_dump_asm_expanded
167
   | Opt_D_dump_llvm
168
   | Opt_D_dump_core_stats
169
170
171
172
173
174
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
175
   | Opt_D_dump_rule_firings
176
   | Opt_D_dump_rule_rewrites
177
178
179
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
180
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
181
182
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
183
   | Opt_D_dump_simpl_phases
184
185
186
187
188
189
190
191
192
193
194
195
196
   | 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
197
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
198
199
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
200
   | Opt_D_dump_vt_trace
201
202
203
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
204
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
205
   | Opt_D_dump_rtti
206
207
208
209
210
211
   | 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
212
   | Opt_D_dump_mod_cycles
213
   | Opt_D_dump_view_pattern_commoning
214
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
215
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
216
   | Opt_D_no_debug_output
217
218
219
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
220
   | Opt_DoAsmLinting
221

Ian Lynagh's avatar
Ian Lynagh committed
222
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
223

224
225
   | Opt_PrintExplicitForalls

226
227
228
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
229
230
   | Opt_FloatIn
   | Opt_Specialise
231
   | Opt_StaticArgumentTransformation
232
   | Opt_CSE
233
234
   | Opt_LiberateCase
   | Opt_SpecConstr
235
236
237
238
239
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
240
   | Opt_DictsCheap
241
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
242
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
243
244
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
245

246
247
248
249
250
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
251
252
253
254
255
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

256
257
   -- misc opts
   | Opt_Pp
258
   | Opt_ForceRecomp
259
   | Opt_ExcessPrecision
260
   | Opt_EagerBlackHoling
261
262
263
264
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
265
   | Opt_HideAllPackages
266
   | Opt_DistrustAllPackages
267
   | Opt_PrintBindResult
268
   | Opt_Haddock
David Waern's avatar
David Waern committed
269
   | Opt_HaddockOptions
270
   | Opt_Hpc_No_Auto
271
   | Opt_BreakOnException
272
   | Opt_BreakOnError
273
   | Opt_PrintEvldWithShow
274
   | Opt_PrintBindContents
275
276
   | Opt_GenManifest
   | Opt_EmbedManifest
277
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
278
   | Opt_SharedImplib
279
   | Opt_BuildingCabalPackage
280
   | Opt_SSE2
tibbe's avatar
tibbe committed
281
   | Opt_SSE4_2
282
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
283
   | Opt_GhciHistory
284
   | Opt_HelpfulErrors
285

286
   -- temporary flags
287
   | Opt_RunCPS
288
   | Opt_RunCPSZ
289
   | Opt_AutoLinkPackages
290
   | Opt_ImplicitImportQualified
291
   | Opt_TryNewCodeGen
292
293
294
295
296
297

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
298
   | Opt_KeepRawTokenStream
299
   | Opt_KeepLlvmFiles
300

301
302
303
   -- safe haskell flags
   | Opt_PackageTrust

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

306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
data WarningFlag =
     Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
   deriving (Eq, Show)

341
342
data Language = Haskell98 | Haskell2010

343
-- | The various Safe Haskell modes
344
345
346
347
348
349
350
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

351
352
353
354
355
instance Outputable SafeHaskellMode where
    ppr Sf_None = ptext $ sLit "None"
    ppr Sf_SafeImports = ptext $ sLit "SafeImports"
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
    ppr Sf_Safe = ptext $ sLit "Safe"
356

357
data ExtensionFlag
358
359
360
361
362
363
364
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
365
366
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
367
368
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
369
   | Opt_InterruptibleFFI
370
   | Opt_GHCForeignImportPrim
371
372
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
373
374
375
376
377
378
379
380
381
382
383
384
385
386
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
387
   | Opt_GADTSyntax
388
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
389
   | Opt_DoAndIfThenElse
390
   | Opt_RebindableSyntax
391
   | Opt_ConstraintKinds
dterei's avatar
dterei committed
392

393
394
395
396
397
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
398
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
399
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
415
   | Opt_MonadComprehensions
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
432
   | Opt_NondecreasingIndentation
433
   | Opt_RelaxedLayout
434
   | Opt_TraditionalRecordSyntax
435
436
   deriving (Eq, Show)

437
438
-- | 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
439
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
440
441
442
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
443
  hscOutName            :: String,      -- ^ Name of the output file
444
  extCoreName           :: String,      -- ^ Name of the .hcr output file
445
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
446
447
448
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
449
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
450
  ruleCheck             :: Maybe String,
451
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
452

453
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
454
455
456
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
457
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
458
                                        --   See CoreMonad.FloatOutSwitches
459

460
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
461
462
463
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
464
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
465

466
467
  dphBackend            :: DPHBackend,

468
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
469
470

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

475
476
477
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

478
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
479
  objectDir             :: Maybe String,
480
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
481
482
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
483

Ian Lynagh's avatar
Ian Lynagh committed
484
485
486
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
487

Ian Lynagh's avatar
Ian Lynagh committed
488
489
490
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
491

492
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
493
494
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
495

496
497
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
498
499
500
501
502
503
504
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

505
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
506
  rtsOptsEnabled        :: RtsOptsEnabled,
507

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

510
511
512
513
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

514
  settings              :: Settings,
515

516
517
518
519
520
521
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

522
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
523
  extraPkgConfs         :: [FilePath],
524
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
525
        -- they appeared.
526

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

530
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
531
  -- NB. do not modify this field, it is calculated by
532
  -- Packages.initPackages and Packages.updatePackages.
533
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
534
  pkgState              :: PackageState,
535

536
537
538
539
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
540
  dirsToClean           :: IORef (Map FilePath FilePath),
541

542
543
544
545
546
  -- Names of files which were generated from -ddump-to-file; used to
  -- track which ones we need to truncate because it's our first run
  -- through
  generatedDumps        :: IORef (Set FilePath),

547
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
548
  flags                 :: [DynFlag],
549
  warningFlags          :: [WarningFlag],
550
  -- Don't change this without updating extensionFlags:
551
  language              :: Maybe Language,
552
553
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
554
555
556
557
558
  -- We store the location of where template haskell and newtype deriving were
  -- turned on so we can produce accurate error messages when Safe Haskell turns
  -- them off.
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
559
560
561
562
563
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
564

565
  -- | Message output action: use "ErrUtils" instead of this if you can
566
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
567
568

  haddockOptions :: Maybe String
569
570
 }

571
data Settings = Settings {
572
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
  sGhcUsagePath          :: FilePath,    -- Filled in by SysTools
  sGhciUsagePath         :: FilePath,    -- ditto
  sTopDir                :: FilePath,
  sTmpDir                :: String,      -- no trailing '/'
  -- You shouldn't need to look things up in rawSettings directly.
  -- They should have their own fields instead.
  sRawSettings           :: [(String, String)],
  sExtraGccViaCFlags     :: [String],
  sSystemPackageConfig   :: FilePath,
  -- commands for particular phases
  sPgm_L                 :: String,
  sPgm_P                 :: (String,[Option]),
  sPgm_F                 :: String,
  sPgm_c                 :: (String,[Option]),
  sPgm_s                 :: (String,[Option]),
  sPgm_a                 :: (String,[Option]),
  sPgm_l                 :: (String,[Option]),
  sPgm_dll               :: (String,[Option]),
  sPgm_T                 :: String,
  sPgm_sysman            :: String,
  sPgm_windres           :: String,
  sPgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
595
596
597
598
599
600
601
602
603
604
605
606
  sPgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
  -- options for particular phases
  sOpt_L                 :: [String],
  sOpt_P                 :: [String],
  sOpt_F                 :: [String],
  sOpt_c                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

607
608
 }

609
610
611
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
ghcUsagePath          :: DynFlags -> FilePath
ghcUsagePath dflags = sGhcUsagePath (settings dflags)
ghciUsagePath         :: DynFlags -> FilePath
ghciUsagePath dflags = sGhciUsagePath (settings dflags)
topDir                :: DynFlags -> FilePath
topDir dflags = sTopDir (settings dflags)
tmpDir                :: DynFlags -> String
tmpDir dflags = sTmpDir (settings dflags)
rawSettings           :: DynFlags -> [(String, String)]
rawSettings dflags = sRawSettings (settings dflags)
extraGccViaCFlags     :: DynFlags -> [String]
extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
systemPackageConfig   :: DynFlags -> FilePath
systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
pgm_L                 :: DynFlags -> String
pgm_L dflags = sPgm_L (settings dflags)
pgm_P                 :: DynFlags -> (String,[Option])
pgm_P dflags = sPgm_P (settings dflags)
pgm_F                 :: DynFlags -> String
pgm_F dflags = sPgm_F (settings dflags)
pgm_c                 :: DynFlags -> (String,[Option])
pgm_c dflags = sPgm_c (settings dflags)
pgm_s                 :: DynFlags -> (String,[Option])
pgm_s dflags = sPgm_s (settings dflags)
pgm_a                 :: DynFlags -> (String,[Option])
pgm_a dflags = sPgm_a (settings dflags)
pgm_l                 :: DynFlags -> (String,[Option])
pgm_l dflags = sPgm_l (settings dflags)
pgm_dll               :: DynFlags -> (String,[Option])
pgm_dll dflags = sPgm_dll (settings dflags)
pgm_T                 :: DynFlags -> String
pgm_T dflags = sPgm_T (settings dflags)
pgm_sysman            :: DynFlags -> String
pgm_sysman dflags = sPgm_sysman (settings dflags)
pgm_windres           :: DynFlags -> String
pgm_windres dflags = sPgm_windres (settings dflags)
pgm_lo                :: DynFlags -> (String,[Option])
pgm_lo dflags = sPgm_lo (settings dflags)
pgm_lc                :: DynFlags -> (String,[Option])
pgm_lc dflags = sPgm_lc (settings dflags)
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
opt_P dflags = sOpt_P (settings dflags)
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
opt_c dflags = sOpt_c (settings dflags)
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
opt_l dflags = sOpt_l (settings dflags)
opt_windres           :: DynFlags -> [String]
opt_windres dflags = sOpt_windres (settings dflags)
opt_lo                :: DynFlags -> [String]
opt_lo dflags = sOpt_lo (settings dflags)
opt_lc                :: DynFlags -> [String]
opt_lc dflags = sOpt_lc (settings dflags)
670

671
672
673
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

674
675
-- | The target code type of the compilation (if any).
--
676
677
678
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
679
680
681
682
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
683
684
685
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
686
--
687
688
689
690
691
692
--  * 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.)
693
--
694
data HscTarget
695
696
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
697
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
698
699
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
700
701
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
702
703
704
705
706
707
708
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

709
-- | Will this target result in an object file on the disk?
710
711
712
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
713
isObjectTarget HscLlvm  = True
714
715
716
717
718
719
720
721
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.
722
data GhcMode
723
724
725
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
726
727
  deriving Eq

728
729
730
731
732
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

733
734
735
736
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

737
738
739
740
-- | 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
741
742
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
743
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
744
  deriving (Eq, Show)
745
746
747

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

750
751
752
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
753
754
755
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.
756

757
data PackageFlag
758
  = ExposePackage   String
759
  | ExposePackageId String
760
761
762
763
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
764
  deriving Eq
765

twanvl's avatar
twanvl committed
766
defaultHscTarget :: HscTarget
767
768
defaultHscTarget = defaultObjectTarget

769
-- | The 'HscTarget' value corresponding to the default way to create
770
-- object files on the current platform.
twanvl's avatar
twanvl committed
771
defaultObjectTarget :: HscTarget
772
defaultObjectTarget
773
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
774
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
775
  | otherwise                           =  HscLlvm
776

777
778
779
780
781
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
782
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
783
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
784

785
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
786
initDynFlags :: DynFlags -> IO DynFlags
787
788
789
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
790
 refFilesToClean <- newIORef []
791
 refDirsToClean <- newIORef Map.empty
792
 refGeneratedDumps <- newIORef Set.empty
793
 return dflags{
794
795
796
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
797
        filesToClean    = refFilesToClean,
798
799
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
800
        }
801

802
803
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
804
805
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
806
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
807
808
809
810
811
812
813
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
814
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
815
        maxSimplIterations      = 4,
816
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
817
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
818
        simplTickFactor         = 100,
819
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
820
        specConstrCount         = Just 3,
821
        liberateCaseThreshold   = Just 2000,
822
        floatLamArgs            = Just 0, -- Default: float only if no fvs
823
824
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
825
826
827
828
829
830
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
831
        dphBackend              = DPHNone,
832

Ian Lynagh's avatar
Ian Lynagh committed
833
834
835
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
836
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
837
838
839
840
841
842
843
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

844
845
846
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
847
848
        outputFile              = Nothing,
        outputHi                = Nothing,
849
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
850
851
852
853
854
855
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
856
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
857
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
858
859
860
861
862

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
863
864
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
865
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
866
867
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
868
        splitInfo               = Nothing,
869
        settings                = mySettings,
870
871
872
873
874
875
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
876
877
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
878
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
879
        haddockOptions = Nothing,
880
        flags = defaultFlags,
881
        warningFlags = standardWarnings,
882
        language = Nothing,
883
        safeHaskell = Sf_None,
884
885
        thOnLoc = noSrcSpan,
        newDerivOnLoc = noSrcSpan,
886
887
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
888
        log_action = defaultLogAction
889
890
      }

891
892
893
894
895
896
897
898
899
900
901
902
903
904
type LogAction = Severity -> SrcSpan -> PprStyle -> Message -> IO ()

defaultLogAction :: LogAction
defaultLogAction severity srcSpan style msg
 = case severity of
   SevOutput -> printSDoc msg style
   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.

Ian Lynagh's avatar
Ian Lynagh committed
905
{-
906
907
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
908
    0   |   print errors & warnings only
909
910
911
912
913
914
915
    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"
-}

916
917
918
919
920
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
921
922
923
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
924
925
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
926
927
928
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
929

930
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
931
    -- Nothing => the default case
932
    = Opt_NondecreasingIndentation -- This has been on by default for some time
933
934
935
936
937
    : delete Opt_DatatypeContexts  -- The Haskell' committee decided to
                                   -- remove datatype contexts from the
                                   -- language:
   -- http://www.haskell.org/pipermail/haskell-prime/2011-January/003335.html
      (languageExtensions (Just Haskell2010))
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
938

939
940
   -- NB: MonoPatBinds is no longer the default

941
942
943
944
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
945
       Opt_DatatypeContexts,
946
       Opt_TraditionalRecordSyntax,
947
948
949
950
951
952
953
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
954

955
956
957
958
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
959
       Opt_TraditionalRecordSyntax,
960
961
962
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
963
       Opt_DoAndIfThenElse,
964
       Opt_RelaxedPolyRec]
965

966
-- | Test whether a 'DynFlag' is set
967
968
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
969

970
-- | Set a 'DynFlag'
971
972
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
973

974
-- | Unset a 'DynFlag'
975
976
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
977

978
979
980
981
982
983
984
985
986
987
988
989
-- | Test whether a 'WarningFlag' is set
wopt :: WarningFlag -> DynFlags -> Bool
wopt f dflags  = f `elem` (warningFlags dflags)

-- | Set a 'WarningFlag'
wopt_set :: DynFlags -> WarningFlag -> DynFlags
wopt_set dfs f = dfs{ warningFlags = f : warningFlags dfs }

-- | Unset a 'WarningFlag'
wopt_unset :: DynFlags -> WarningFlag -> DynFlags
wopt_unset dfs f = dfs{ warningFlags = filter (/= f) (warningFlags dfs) }

990
-- | Test whether a 'ExtensionFlag' is set
991
xopt :: ExtensionFlag -> DynFlags -> Bool
992
xopt f dflags = f `elem` extensionFlags dflags
993

994
-- | Set a 'ExtensionFlag'
995
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
996
997
998
999
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
1000

1001
-- | Unset a 'ExtensionFlag'
1002
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
1003
1004
1005
1006
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
1007

1008
-- | Set the Haskell language standard to use
1009
1010
1011
1012
1013
1014
1015
1016
setLanguage :: Language -> DynP ()
setLanguage l = upd f
    where f dfs = let mLang = Just l
                      oneoffs = extensions dfs
                  in dfs {
                         language = mLang,
                         extensionFlags = flattenExtensionFlags mLang oneoffs
                     }
1017

1018
1019
1020
1021
-- | Some modules have dependencies on others through the DynFlags rather than textual imports
dynFlagDependencies :: DynFlags -> [ModuleName]
dynFlagDependencies = pluginModNames