DynFlags.hs 129 KB
Newer Older
dterei's avatar
dterei committed
1
-------------------------------------------------------------------------------
2
--
dterei's avatar
dterei committed
3
4
5
6
7
8
-- | Dynamic flags
--
-- Most flags are dynamic flags, which means they can change from 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.
9
10
11
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
12
-------------------------------------------------------------------------------
13

14
15
16
{-# OPTIONS_GHC -fno-warn-missing-fields #-}
-- So that tracingSettings works properly

17
module DynFlags (
18
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
19
        DynFlag(..),
20
        WarningFlag(..),
21
        ExtensionFlag(..),
22
        Language(..),
23
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
24
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
25
        ProfAuto(..),
26
        glasgowExtsFlags,
27
28
29
        dopt,
        dopt_set,
        dopt_unset,
30
31
32
        wopt,
        wopt_set,
        wopt_unset,
33
34
35
        xopt,
        xopt_set,
        xopt_unset,
36
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
37
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
38
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
39
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
40
        HscTarget(..), isObjectTarget, defaultObjectTarget,
41
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
42
43
44
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
45
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
46
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
47
        DynLibLoader(..),
48
        fFlags, fWarningFlags, fLangFlags, xFlags,
49
        dynFlagDependencies,
50
        tablesNextToCode, mkTablesNextToCode,
51

52
53
        printOutputForUser, printInfoForUser,

ian@well-typed.com's avatar
ian@well-typed.com committed
54
55
        Way(..), mkBuildTag, wayRTSOnly,

56
        -- ** Safe Haskell
57
        SafeHaskellMode(..),
58
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
59
        packageTrustOn,
60
        safeDirectImpsReq, safeImplicitImpsReq,
61
        unsafeFlags,
62

63
        -- ** System tool settings and locations
64
        Settings(..),
65
        targetPlatform,
66
67
68
69
        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
70
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
71
        opt_windres, opt_lo, opt_lc,
72
73


74
        -- ** Manipulating DynFlags
75
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
76
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
77
        defaultFatalMessager,
78
        defaultLogAction,
79
        defaultLogActionHPrintDoc,
80
81
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
82

83
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
84
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
85
86
87
88
        updOptLevel,
        setTmpDir,
        setPackageName,

89
        -- ** Parsing DynFlags
90
91
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
92
93
94
        parseDynamicFlagsFull,

        -- ** Available DynFlags
95
        allFlags,
96
97
98
        flagsAll,
        flagsDynamic,
        flagsPackage,
99

100
        supportedLanguagesAndExtensions,
101
102

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
103
        picCCOpts, picPOpts,
104
105
106
107
108
109

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

        -- * Compiler configuration suitable for display to the user
110
111
        compilerInfo,

112
#ifdef GHCI
dterei's avatar
dterei committed
113
-- Only in stage 2 can we be sure that the RTS
114
-- exposes the appropriate runtime boolean
115
        rtsIsProfiled,
116
#endif
117
118

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
119
        bLOCK_SIZE_W,
120
        wORD_SIZE_IN_BITS,
121
122
        tAG_MASK,
        mAX_PTR_TAG,
123
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
124
125
126
127
  ) where

#include "HsVersions.h"

128
import Platform
129
import Module
Simon Marlow's avatar
Simon Marlow committed
130
import PackageConfig
131
import PrelNames        ( mAIN )
132
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
133
import DriverPhases     ( Phase(..), phaseInputExt )
134
135
import Config
import CmdLineParser
136
import Constants
137
import Panic
138
import StaticFlags
139
import Util
140
import Maybes           ( orElse )
141
import MonadUtils
142
import qualified Pretty
143
import SrcLoc
144
import FastString
Simon Marlow's avatar
Simon Marlow committed
145
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
146
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
147
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
148
#endif
149
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
150

Ian Lynagh's avatar
Ian Lynagh committed
151
#ifdef GHCI
152
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
153
#endif
154
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
155
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
156

157
import Data.Bits
158
import Data.Char
159
import Data.Int
160
import Data.List
161
162
import Data.Map (Map)
import qualified Data.Map as Map
163
164
import Data.Set (Set)
import qualified Data.Set as Set
165
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
166
import System.FilePath
167
import System.IO
168

169
170
171
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

172
173
174
-- -----------------------------------------------------------------------------
-- DynFlags

175
-- | Enumerates the simple on-or-off dynamic flags
176
177
178
179
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
180
   | Opt_D_dump_raw_cmm
181
   | Opt_D_dump_cmmz
182
183
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
Simon Marlow's avatar
Simon Marlow committed
184
   | Opt_D_dump_cmmz_cfg
185
186
187
188
189
190
191
192
193
194
195
196
197
   | 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
198
   | Opt_D_dump_cps_cmm
199
   | Opt_D_dump_cvt_cmm
200
   | Opt_D_dump_asm
201
202
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
203
   | Opt_D_dump_asm_coalesce
204
205
206
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
207
   | Opt_D_dump_asm_stats
208
   | Opt_D_dump_asm_expanded
209
   | Opt_D_dump_llvm
210
   | Opt_D_dump_core_stats
211
212
213
214
215
216
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
217
   | Opt_D_dump_rule_firings
218
   | Opt_D_dump_rule_rewrites
219
220
221
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
222
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
223
224
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
225
   | Opt_D_dump_simpl_phases
226
227
228
229
230
231
232
233
234
235
236
237
238
   | 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
239
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
240
241
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
242
   | Opt_D_dump_vt_trace
243
244
245
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
246
   | Opt_D_dump_avoid_vect
247
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
248
   | Opt_D_dump_rtti
249
250
251
252
253
254
   | 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
255
   | Opt_D_dump_mod_cycles
256
   | Opt_D_dump_view_pattern_commoning
257
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
258
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
259
   | Opt_D_no_debug_output
260
261
262
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
263
   | Opt_DoAsmLinting
264
   | Opt_NoLlvmMangler                 -- hidden flag
265

Ian Lynagh's avatar
Ian Lynagh committed
266
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
267

268
269
   | Opt_PrintExplicitForalls

270
271
272
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
273
274
   | Opt_FloatIn
   | Opt_Specialise
275
   | Opt_StaticArgumentTransformation
276
   | Opt_CSE
277
278
   | Opt_LiberateCase
   | Opt_SpecConstr
279
280
281
282
283
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
284
   | Opt_DictsCheap
285
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
286
   | Opt_Vectorise
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
287
   | Opt_AvoidVect
Ian Lynagh's avatar
Ian Lynagh committed
288
289
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
290
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
291
292
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
   | Opt_RegLiveness                    -- Use the STG Reg liveness information (hidden flag)
293
   | Opt_IrrefutableTuples
294
   | Opt_CmmSink
295
   | Opt_CmmElimCommonBlocks
296
   | Opt_OmitYields
297

298
299
300
301
302
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
303
304
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
305
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
306

307
308
   -- misc opts
   | Opt_Pp
309
   | Opt_ForceRecomp
310
   | Opt_ExcessPrecision
311
   | Opt_EagerBlackHoling
312
313
314
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
315
   | Opt_HideAllPackages
316
   | Opt_PrintBindResult
317
   | Opt_Haddock
David Waern's avatar
David Waern committed
318
   | Opt_HaddockOptions
319
   | Opt_Hpc_No_Auto
320
   | Opt_BreakOnException
321
   | Opt_BreakOnError
322
   | Opt_PrintEvldWithShow
323
   | Opt_PrintBindContents
324
325
   | Opt_GenManifest
   | Opt_EmbedManifest
326
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
327
   | Opt_SharedImplib
328
   | Opt_BuildingCabalPackage
329
   | Opt_SSE2
tibbe's avatar
tibbe committed
330
   | Opt_SSE4_2
331
   | Opt_IgnoreDotGhci
332
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
333
   | Opt_GhciHistory
334
   | Opt_HelpfulErrors
335
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
336
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
337
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
338
   | Opt_PIC
339
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
340
341
   | Opt_Ticky
   | Opt_Static
342
   | Opt_RPath
343
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
344
   | Opt_Hpc
345

346
   -- output style opts
347
348
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
349
   | Opt_PprCaseAsLet
350

351
   -- temporary flags
352
   | Opt_RunCPS
353
   | Opt_RunCPSZ
354
   | Opt_AutoLinkPackages
355
   | Opt_ImplicitImportQualified
356
357
358
359
360
361

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
362
   | Opt_KeepRawTokenStream
363
   | Opt_KeepLlvmFiles
364

365
   -- safe haskell flags
dterei's avatar
dterei committed
366
   | Opt_DistrustAllPackages
367
368
   | Opt_PackageTrust

369
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
370

371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
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
404
405
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
406
   | Opt_WarnPointlessPragmas
407
   | Opt_WarnUnsupportedCallingConventions
408
   | Opt_WarnInlineRuleShadowing
409
   deriving (Eq, Show, Enum)
410

411
data Language = Haskell98 | Haskell2010
412
   deriving Enum
413

414
-- | The various Safe Haskell modes
415
416
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
417
   | Sf_Unsafe
418
419
   | Sf_Trustworthy
   | Sf_Safe
420
   | Sf_SafeInferred
421
422
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
423
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
424
425
426
427
428
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
    show Sf_SafeInferred = "Safe-Inferred"
Ian Lynagh's avatar
Ian Lynagh committed
429

430
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
431
    ppr = text . show
432

433
data ExtensionFlag
434
435
436
437
438
439
440
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
441
442
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
443
444
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
445
   | Opt_InterruptibleFFI
446
   | Opt_CApiFFI
447
   | Opt_GHCForeignImportPrim
448
449
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
450
451
452
453
454
455
456
457
458
459
460
461
462
463
   | 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
464
   | Opt_GADTSyntax
465
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
466
   | Opt_DoAndIfThenElse
467
   | Opt_RebindableSyntax
468
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
469
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
470
   | Opt_DataKinds                -- Datatype promotion
471
472
   | Opt_InstanceSigs
 
473
474
475
476
477
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
478
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
479
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494

   | 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
495
   | Opt_MonadComprehensions
496
497
498
499
500
501
502
503
504
505
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
506
   | Opt_ExplicitNamespaces
507
508
509
510
511
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
512
   | Opt_NondecreasingIndentation
513
   | Opt_RelaxedLayout
514
   | Opt_TraditionalRecordSyntax
515
   | Opt_LambdaCase
516
   | Opt_MultiWayIf
517
   | Opt_TypeHoles
518
   deriving (Eq, Enum, Show)
519

520
521
-- | 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
522
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
523
524
525
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
526
  settings              :: Settings,
527
  hscOutName            :: String,      -- ^ Name of the output file
528
  extCoreName           :: String,      -- ^ Name of the .hcr output file
529
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
530
531
532
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
533
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
534
  ruleCheck             :: Maybe String,
535
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
536

537
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
538
539
540
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
541
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
542
                                        --   See CoreMonad.FloatOutSwitches
543
  historySize           :: Int,
544

545
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
546
547
548
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
549
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
550

551
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
552
553

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

558
559
560
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

561
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
562
  objectDir             :: Maybe String,
563
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
564
565
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
566
  dumpDir               :: Maybe String,
567

Ian Lynagh's avatar
Ian Lynagh committed
568
569
570
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
571

Ian Lynagh's avatar
Ian Lynagh committed
572
573
574
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
575

576
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
577
578
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
579

580
581
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
582
583
  dumpPrefixForce       :: Maybe FilePath,

584
585
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
586
587
588
589
590
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

591
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
592
  rtsOptsEnabled        :: RtsOptsEnabled,
593

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

596
597
598
599
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

600
601
602
603
604
605
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

606
  --  Package flags
607
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
608
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
609
        -- they appeared.
610

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

614
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
615
  -- NB. do not modify this field, it is calculated by
616
  -- Packages.initPackages and Packages.updatePackages.
617
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
618
  pkgState              :: PackageState,
619

620
621
622
623
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
624
  dirsToClean           :: IORef (Map FilePath FilePath),
625

626
627
628
629
630
  -- 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),

631
  -- hsc dynamic flags
632
633
  flags                 :: IntSet,
  warningFlags          :: IntSet,
634
  -- Don't change this without updating extensionFlags:
635
  language              :: Maybe Language,
636
637
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
638
639
640
  -- We store the location of where some extension and flags were turned on so
  -- we can produce accurate error messages when Safe Haskell fails due to
  -- them.
641
642
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
643
  pkgTrustOnLoc         :: SrcSpan,
644
645
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
646
647
648
649
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
650
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
651

652
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
653
  log_action            :: LogAction,
654
655
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
656

657
  haddockOptions        :: Maybe String,
658
  ghciScripts           :: [String],
659

660
661
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
662
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
663
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
664
665

  -- | what kind of {-# SCC #-} to add automatically
666
667
  profAuto              :: ProfAuto,

668
  interactivePrint      :: Maybe String,
669

670
  llvmVersion           :: IORef (Int)
671
672
 }

673
674
675
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
676
677
678
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

679
680
681
682
683
data ProfAuto
  = NoProfAuto         -- ^ no SCC annotations added
  | ProfAutoAll        -- ^ top-level and nested functions are annotated
  | ProfAutoTop        -- ^ top-level functions annotated only
  | ProfAutoExports    -- ^ exported functions annotated only
684
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
685
  deriving (Enum)
686

687
data Settings = Settings {
688
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
689
690
691
692
693
694
695
696
697
  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,
698
699
700
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
701
702
703
704
705
706
707
708
709
710
711
712
713
  -- 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
714
715
716
717
718
719
720
721
722
723
  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
724
  sOpt_lc                :: [String], -- LLVM: llc static compiler
725

726
  sPlatformConstants     :: PlatformConstants
727
728
 }

729
730
731
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
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)
772
773
774
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
775
776
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
777
778
779
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
780
781
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
782
783
784
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
785
786
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
787
788
789
790
791
792
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)
793

794
795
-- | The target code type of the compilation (if any).
--
796
797
798
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
799
800
801
802
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
803
804
805
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
806
--
807
808
809
810
--  * 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
Simon Hengel's avatar
Simon Hengel committed
811
--    different target or avoid typechecking such modules.  (The latter may be
812
--    preferable for security reasons.)
813
--
814
data HscTarget
815
816
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
817
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
818
819
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
820
821
  deriving (Eq, Show)

822
-- | Will this target result in an object file on the disk?
823
824
825
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
826
isObjectTarget HscLlvm  = True
827
828
isObjectTarget _        = False

829
830
831
832
833
834
835
836
837
838
839
-- | Does this target retain *all* top-level bindings for a module,
-- rather than just the exported bindings, in the TypeEnv and compiled
-- code (if any)?  In interpreted mode we do this, so that GHCi can
-- call functions inside a module.  In HscNothing mode we also do it,
-- so that Haddock can get access to the GlobalRdrEnv for a module
-- after typechecking it.
targetRetainsAllBindings :: HscTarget -> Bool
targetRetainsAllBindings HscInterpreted = True
targetRetainsAllBindings HscNothing     = True
targetRetainsAllBindings _              = False

840
841
842
843
844
845
-- | 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.
846
data GhcMode
847
848
849
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
850
851
  deriving Eq

852
853
854
855
856
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

857
858
859
860
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

861
862
863
864
-- | 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
865
866
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
867
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
868
  deriving (Eq, Show)
869
870
871

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
872
isNoLink _      = False
873
874

data PackageFlag
875
  = ExposePackage   String
876
  | ExposePackageId String
877
878
879
880
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
881
  deriving Eq
882

883
defaultHscTarget :: Platform -> HscTarget
884
885
defaultHscTarget = defaultObjectTarget

886
-- | The 'HscTarget' value corresponding to the default way to create
887
-- object files on the current platform.
888
889
890
defaultObjectTarget :: Platform -> HscTarget
defaultObjectTarget platform
  | platformUnregisterised platform     =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
891
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
892
  | otherwise                           =  HscLlvm
893

894
895
896
897
898
tablesNextToCode :: DynFlags -> Bool
tablesNextToCode dflags
    = mkTablesNextToCode (platformUnregisterised (targetPlatform dflags))

-- Determines whether we will be compiling
899
900
901
-- info tables that reside just before the entry code, or with an
-- indirection to the entry code.  See TABLES_NEXT_TO_CODE in
-- includes/rts/storage/InfoTables.h.
902
903
904
mkTablesNextToCode :: Bool -> Bool
mkTablesNextToCode unregisterised
    = not unregisterised && cGhcEnableTablesNextToCode == "YES"
905

906
907
908
909
910
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
911
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
912
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
913

ian@well-typed.com's avatar
ian@well-typed.com committed
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
-----------------------------------------------------------------------------
-- Ways

-- The central concept of a "way" is that all objects in a given
-- program must be compiled in the same "way".  Certain options change
-- parameters of the virtual machine, eg. profiling adds an extra word
-- to the object header, so profiling objects cannot be linked with
-- non-profiling objects.

-- After parsing the command-line options, we determine which "way" we
-- are building - this might be a combination way, eg. profiling+threaded.

-- We then find the "build-tag" associated with this way, and this
-- becomes the suffix used to find .hi files and libraries used in
-- this compilation.

data Way
  = WayThreaded
  | WayDebug
  | WayProf
  | WayEventLog
  | WayPar
  | WayGran
  | WayNDP
  | WayDyn
  deriving (Eq,Ord)

allowed_combination :: [Way] -> Bool
allowed_combination way = and [ x `allowedWith` y
                              | x <- way, y <- way, x < y ]
  where
        -- Note ordering in these tests: the left argument is
        -- <= the right argument, according to the Ord instance
        -- on Way above.

        -- dyn is allowed with everything
        _ `allowedWith` WayDyn                  = True
        WayDyn `allowedWith` _                  = True

        -- debug is allowed with everything
        _ `allowedWith` WayDebug                = True
        WayDebug `allowedWith` _                = True

        WayProf `allowedWith` WayNDP            = True
        WayThreaded `allowedWith` WayProf       = True
        WayThreaded `allowedWith` WayEventLog   = True
        _ `allowedWith` _                       = False

mkBuildTag :: [Way] -> String
mkBuildTag ways = concat (intersperse "_" (map wayTag ways))

wayTag :: Way -> String
wayTag WayThreaded = "thr"
wayTag WayDebug    = "debug"
wayTag WayDyn      = "dyn"
wayTag WayProf     = "p"
wayTag WayEventLog = "l"
wayTag WayPar      = "mp"
wayTag WayGran     = "mg"
wayTag WayNDP      = "ndp"

wayRTSOnly :: Way -> Bool
wayRTSOnly WayThreaded = True
wayRTSOnly WayDebug    = True
wayRTSOnly WayDyn      = False
wayRTSOnly WayProf     = False
wayRTSOnly WayEventLog = True
wayRTSOnly WayPar      = False
wayRTSOnly WayGran     = False
wayRTSOnly WayNDP      = False

wayDesc :: Way -> String
wayDesc WayThreaded = "Threaded"
wayDesc WayDebug    = "Debug"
wayDesc WayDyn      = "Dynamic"
wayDesc WayProf     = "Profiling"
wayDesc WayEventLog = "RTS Event Logging"
wayDesc WayPar      = "Parallel"
wayDesc WayGran     = "GranSim"
wayDesc WayNDP      = "Nested data parallelism"