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

35
36
37
38
39
        Settings(..),
        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,
40
41
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
42
43


44
        -- ** Manipulating DynFlags
45
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
46
47
        initDynFlags,                   -- DynFlags -> IO DynFlags

48
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
49
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
50
51
52
        updOptLevel,
        setTmpDir,
        setPackageName,
53
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
54

55
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
56
        parseDynamicFlags,
57
        parseDynamicNoPackageFlags,
58
        allFlags,
59

60
        supportedLanguagesAndExtensions,
61
62

        -- ** DynFlag C compiler options
63
        picCCOpts,
64
65
66
67
68
69

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

        -- * Compiler configuration suitable for display to the user
70
71
72
73
74
75
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
76
77
78
79
  ) where

#include "HsVersions.h"

80
import Platform
81
import Module
Simon Marlow's avatar
Simon Marlow committed
82
import PackageConfig
83
import PrelNames        ( mAIN )
84
import StaticFlags
85
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
86
import DriverPhases     ( Phase(..), phaseInputExt )
87
88
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
89
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
90
import Panic
91
import Util
92
import Maybes           ( orElse )
93
import SrcLoc
94
import FastString
Simon Marlow's avatar
Simon Marlow committed
95
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
96
#ifdef GHCI
97
import Foreign.C	( CInt )
Ian Lynagh's avatar
Ian Lynagh committed
98
#endif
Simon Marlow's avatar
Simon Marlow committed
99
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
100

Ian Lynagh's avatar
Ian Lynagh committed
101
#ifdef GHCI
102
import System.IO.Unsafe	( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
103
#endif
104
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
105
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
106

107
import Data.Char
108
import Data.List
109
110
import Data.Map (Map)
import qualified Data.Map as Map
111
112
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
113
import System.FilePath
114
import System.IO        ( stderr, hPutChar )
115

116
117
118
-- -----------------------------------------------------------------------------
-- DynFlags

119
-- | Enumerates the simple on-or-off dynamic flags
120
121
122
123
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
124
   | Opt_D_dump_raw_cmm
125
   | Opt_D_dump_cmmz
126
   | Opt_D_dump_cmmz_pretty
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
   -- 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
142
   | Opt_D_dump_cps_cmm
143
   | Opt_D_dump_cvt_cmm
144
   | Opt_D_dump_asm
145
146
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
147
   | Opt_D_dump_asm_coalesce
148
149
150
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
151
   | Opt_D_dump_asm_stats
152
   | Opt_D_dump_asm_expanded
153
   | Opt_D_dump_llvm
154
   | Opt_D_dump_core_stats
155
156
157
158
159
160
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
161
   | Opt_D_dump_rule_firings
162
   | Opt_D_dump_rule_rewrites
163
164
165
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
166
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
167
168
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
169
   | Opt_D_dump_simpl_phases
170
171
172
173
174
175
176
177
178
179
180
181
182
   | 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
183
   | Opt_D_dump_cs_trace	-- Constraint solver in type checker
184
185
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
186
   | Opt_D_dump_vt_trace
187
188
189
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
190
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
191
   | Opt_D_dump_rtti
192
193
194
195
196
197
   | 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
198
   | Opt_D_dump_mod_cycles
199
   | Opt_D_dump_view_pattern_commoning
200
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
201
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
202
   | Opt_D_no_debug_output
203
204
205
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
206
   | Opt_DoAsmLinting
207

Ian Lynagh's avatar
Ian Lynagh committed
208
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
209
210
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
211
   | Opt_WarnImplicitPrelude
212
   | Opt_WarnIncompletePatterns
213
   | Opt_WarnIncompleteUniPatterns
214
215
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
216
   | Opt_WarnMissingImportList
217
218
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
219
   | Opt_WarnMissingLocalSigs
220
221
222
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
223
   | Opt_WarnMonomorphism
224
225
226
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
227
   | Opt_WarnWarningsDeprecations
228
   | Opt_WarnDeprecatedFlags
229
   | Opt_WarnDodgyExports
230
231
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
232
   | Opt_WarnAutoOrphans
233
   | Opt_WarnIdentities
234
   | Opt_WarnTabs
235
   | Opt_WarnUnrecognisedPragmas
236
   | Opt_WarnDodgyForeignImports
237
   | Opt_WarnLazyUnliftedBindings
238
239
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
240
   | Opt_WarnAlternativeLayoutRuleTransitional
241

242
243
   | Opt_PrintExplicitForalls

244
245
246
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
247
248
   | Opt_FloatIn
   | Opt_Specialise
249
   | Opt_StaticArgumentTransformation
250
   | Opt_CSE
251
252
   | Opt_LiberateCase
   | Opt_SpecConstr
253
254
255
256
257
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
258
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
259
   | Opt_DictsCheap
260
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
261
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
262
263
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
264

265
266
267
268
269
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

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

275
276
   -- misc opts
   | Opt_Pp
277
   | Opt_ForceRecomp
278
   | Opt_ExcessPrecision
279
   | Opt_EagerBlackHoling
280
281
282
283
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
284
   | Opt_HideAllPackages
285
   | Opt_PrintBindResult
286
   | Opt_Haddock
David Waern's avatar
David Waern committed
287
   | Opt_HaddockOptions
288
   | Opt_Hpc_No_Auto
289
   | Opt_BreakOnException
290
   | Opt_BreakOnError
291
   | Opt_PrintEvldWithShow
292
   | Opt_PrintBindContents
293
294
   | Opt_GenManifest
   | Opt_EmbedManifest
295
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
296
   | Opt_SharedImplib
297
   | Opt_BuildingCabalPackage
298
   | Opt_SSE2
299
   | Opt_GhciSandbox
300
   | Opt_HelpfulErrors
301
302
303

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

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

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

320
321
data Language = Haskell98 | Haskell2010

322
data ExtensionFlag
323
324
325
326
327
328
329
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
330
   | Opt_RelaxedPolyRec		-- Deprecated
331
332
333
334
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
335
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
   | Opt_Arrows                         -- Arrow-notation syntax
   | 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
351
   | Opt_GADTSyntax
352
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
353
   | Opt_DoAndIfThenElse
354
   | Opt_RebindableSyntax
355
356
357
358
359
360

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
361
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
362
363
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
   | Opt_Generics                 -- Old generic classes, now deprecated
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378

   | 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
379
   | Opt_MonadComprehensions
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
   | 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
396
   | Opt_NondecreasingIndentation
397
   | Opt_RelaxedLayout
398
399
   deriving (Eq, Show)

400
401
-- | 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
402
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
403
404
405
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
406
  hscOutName            :: String,      -- ^ Name of the output file
407
  extCoreName           :: String,      -- ^ Name of the .hcr output file
408
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
409
410
411
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
412
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
413
  ruleCheck             :: Maybe String,
414
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
415

416
417
418
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
419
420
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
421

Ian Lynagh's avatar
Ian Lynagh committed
422
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
423
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
424
425
426
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
427
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
428

429
430
  dphBackend            :: DPHBackend,

431
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
432
433

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

438
439
440
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

441
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
442
  objectDir             :: Maybe String,
443
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
444
445
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
446

Ian Lynagh's avatar
Ian Lynagh committed
447
448
449
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
450

Ian Lynagh's avatar
Ian Lynagh committed
451
452
453
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
454

455
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
456
457
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
458

459
460
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
461
462
463
464
465
466
467
  dumpPrefixForce       :: Maybe FilePath,

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

468
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
469
  rtsOptsEnabled        :: RtsOptsEnabled,
470

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

473
474
475
476
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

477
  settings              :: Settings,
478

479
480
481
482
483
484
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

485
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
486
  extraPkgConfs         :: [FilePath],
487
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
488
        -- they appeared.
489

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

493
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
494
  -- NB. do not modify this field, it is calculated by
495
  -- Packages.initPackages and Packages.updatePackages.
496
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
497
  pkgState              :: PackageState,
498

499
500
501
502
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
503
  dirsToClean           :: IORef (Map FilePath FilePath),
504

505
506
507
508
509
  -- 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),

510
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
511
  flags                 :: [DynFlag],
512
  -- Don't change this without updating extensionFlags:
513
  language              :: Maybe Language,
514
515
516
517
518
  -- 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
519

520
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
521
522
523
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
524
525
 }

526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
data Settings = Settings {
  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
549
550
551
552
553
554
555
556
557
558
559
560
561
  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_m                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 }

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)
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
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_m                 :: DynFlags -> [String]
opt_m dflags = sOpt_m (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)
624

625
626
627
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

628
629
-- | The target code type of the compilation (if any).
--
630
631
632
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
633
634
635
636
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
637
638
639
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
640
--
641
642
643
644
645
646
--  * 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.)
647
--
648
data HscTarget
649
650
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
651
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
652
653
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
654
655
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
656
657
658
659
660
661
662
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

663
-- | Will this target result in an object file on the disk?
664
665
666
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
667
isObjectTarget HscLlvm  = True
668
669
670
671
672
673
674
675
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.
676
data GhcMode
677
678
679
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
680
681
  deriving Eq

682
683
684
685
686
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

687
688
689
690
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

691
692
693
694
-- | 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
695
696
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
697
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
698
  deriving (Eq, Show)
699
700
701

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

704
705
706
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
707
708
709
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.
710

711
712
data PackageFlag
  = ExposePackage  String
713
  | ExposePackageId String
714
715
  | HidePackage    String
  | IgnorePackage  String
716
  deriving Eq
717

twanvl's avatar
twanvl committed
718
defaultHscTarget :: HscTarget
719
720
defaultHscTarget = defaultObjectTarget

721
-- | The 'HscTarget' value corresponding to the default way to create
722
-- object files on the current platform.
twanvl's avatar
twanvl committed
723
defaultObjectTarget :: HscTarget
724
defaultObjectTarget
725
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
726
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
727
  | otherwise                           =  HscLlvm
728

729
730
731
732
733
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
734
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
735
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
736

737
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
738
initDynFlags :: DynFlags -> IO DynFlags
739
740
741
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
742
 refFilesToClean <- newIORef []
743
 refDirsToClean <- newIORef Map.empty
744
 refGeneratedDumps <- newIORef Set.empty
745
 return dflags{
746
747
748
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
749
        filesToClean    = refFilesToClean,
750
751
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
752
        }
753

754
755
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
756
757
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
758
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
759
760
761
762
763
764
765
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
766
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
767
        maxSimplIterations      = 4,
768
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
769
        ruleCheck               = Nothing,
770
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
771
        specConstrCount         = Just 3,
772
        liberateCaseThreshold   = Just 2000,
773
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
774
775
        strictnessBefore        = [],

776
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
777
778
779
780
781
782
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
783
        dphBackend              = DPHNone,
784

Ian Lynagh's avatar
Ian Lynagh committed
785
786
787
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
788
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
789
790
791
792
793
794
795
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

796
797
798
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
799
800
        outputFile              = Nothing,
        outputHi                = Nothing,
801
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
802
803
804
805
806
807
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
808
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
809
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
810
811
812
813
814

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
815
816
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
817
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
818
819
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
820
        splitInfo               = Nothing,
821
        settings                = mySettings,
822
823
824
825
826
827
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
828
829
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
830
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
831
        haddockOptions = Nothing,
832
        flags = defaultFlags,
833
        language = Nothing,
834
835
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
836

Ian Lynagh's avatar
Ian Lynagh committed
837
        log_action = \severity srcSpan style msg ->
838
                        case severity of
839
840
841
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
842
                          _         -> do 
843
                                hPutChar stderr '\n'
844
                                printErrs (mkLocMessage srcSpan msg) style
845
846
847
                     -- 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.
848
849
      }

Ian Lynagh's avatar
Ian Lynagh committed
850
{-
851
852
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
853
    0   |   print errors & warnings only
854
855
856
857
858
859
860
    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"
-}

861
862
863
864
865
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
866
867
868
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
869
870
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
871
872
873
          defaultExtensionFlags = languageExtensions ml

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

875
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
876
    -- Nothing => the default case
877
878
879
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
880
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
881
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
882
      -- SLPJ September 2010
883
    : Opt_NondecreasingIndentation -- This has been on by default for some time
884
885
886
887
888
    : 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
889

890
891
892
893
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
894
895
896
897
898
899
900
901
       Opt_DatatypeContexts,
       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
902

903
904
905
906
907
908
909
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
910
       Opt_DoAndIfThenElse,
911
       Opt_RelaxedPolyRec]
912

913
-- | Test whether a 'DynFlag' is set
914
915
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
916

917
-- | Set a 'DynFlag'
918
919
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
920

921
-- | Unset a 'DynFlag'
922
923
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
924

925
-- | Test whether a 'ExtensionFlag' is set
926
xopt :: ExtensionFlag -> DynFlags -> Bool
927
xopt f dflags = f `elem` extensionFlags dflags
928

929
-- | Set a 'ExtensionFlag'
930
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
931
932
933
934
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
935

936
-- | Unset a 'ExtensionFlag'
937
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
938
939
940
941
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
942

943
944
945
946
947
948
949
950
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
                     }
951

952
953
954
955
-- | 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
956
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
957
        -- We add to the options from the front, so we need to reverse the list
958

959
960
-- | 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
961
962
963
964
getVerbFlags :: DynFlags -> [String]
getVerbFlags dflags
  | verbosity dflags >= 4 = ["-v"]
  | otherwise             = []
965

966
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
967
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
968
         setPgmP, addOptl, addOptP,
969
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
970
971
972
973
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

974
975
976
977
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
Ian Lynagh's avatar
Ian Lynagh committed
978
979
  -- \#included from the .hc file when compiling via C (i.e. unregisterised
  -- builds).
Simon Marlow's avatar
Simon Marlow committed
980
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
981
setDylibInstallName  f d = d{ dylibInstallName = Just f}
982

983
984
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}