DynFlags.hs 128 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
        -- ** Only for use in the tracing functions in Outputable
        tracingDynFlags,
119
120

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

#include "HsVersions.h"

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

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

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

166
167
168
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

169
170
171
-- -----------------------------------------------------------------------------
-- DynFlags

172
-- | Enumerates the simple on-or-off dynamic flags
173
174
175
176
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
263
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
264

265
266
   | Opt_PrintExplicitForalls

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

294
295
296
297
298
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
299
300
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
301
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
302

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

340
341
   -- output style opts
   | Opt_PprCaseAsLet
342

343
   -- temporary flags
344
   | Opt_RunCPS
345
   | Opt_RunCPSZ
346
   | Opt_AutoLinkPackages
347
   | Opt_ImplicitImportQualified
348
   | Opt_TryNewCodeGen
349
350
351
352
353
354

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
355
   | Opt_KeepRawTokenStream
356
   | Opt_KeepLlvmFiles
357

358
   -- safe haskell flags
dterei's avatar
dterei committed
359
   | Opt_DistrustAllPackages
360
361
   | Opt_PackageTrust

362
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
363

364
365
366
367
368
369
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
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
397
398
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
399
   | Opt_WarnPointlessPragmas
400
   | Opt_WarnUnsupportedCallingConventions
401
   | Opt_WarnInlineRuleShadowing
402
   deriving (Eq, Show, Enum)
403

404
data Language = Haskell98 | Haskell2010
405
   deriving Enum
406

407
-- | The various Safe Haskell modes
408
409
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
410
   | Sf_Unsafe
411
412
   | Sf_Trustworthy
   | Sf_Safe
413
   | Sf_SafeInferred
414
415
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
416
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
417
418
419
420
421
    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
422

423
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
424
    ppr = text . show
425

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

   | 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
488
   | Opt_MonadComprehensions
489
490
491
492
493
494
495
496
497
498
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
499
   | Opt_ExplicitNamespaces
500
501
502
503
504
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
505
   | Opt_NondecreasingIndentation
506
   | Opt_RelaxedLayout
507
   | Opt_TraditionalRecordSyntax
508
   | Opt_LambdaCase
509
   | Opt_MultiWayIf
510
   deriving (Eq, Enum, Show)
511

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

529
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
530
531
532
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
533
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
534
                                        --   See CoreMonad.FloatOutSwitches
535
  historySize           :: Int,
536

537
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
538
539
540
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
541
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
542

543
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
544
545

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

550
551
552
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

553
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
554
  objectDir             :: Maybe String,
555
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
556
557
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
558
  dumpDir               :: Maybe String,
559

Ian Lynagh's avatar
Ian Lynagh committed
560
561
562
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
563

Ian Lynagh's avatar
Ian Lynagh committed
564
565
566
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
567

568
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
569
570
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
571

572
573
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
574
575
  dumpPrefixForce       :: Maybe FilePath,

576
577
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
578
579
580
581
582
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

583
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
584
  rtsOptsEnabled        :: RtsOptsEnabled,
585

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

588
589
590
591
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

592
593
594
595
596
597
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

598
  --  Package flags
599
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
600
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
601
        -- they appeared.
602

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

606
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
607
  -- NB. do not modify this field, it is calculated by
608
  -- Packages.initPackages and Packages.updatePackages.
609
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
610
  pkgState              :: PackageState,
611

612
613
614
615
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
616
  dirsToClean           :: IORef (Map FilePath FilePath),
617

618
619
620
621
622
  -- 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),

623
  -- hsc dynamic flags
624
625
  flags                 :: IntSet,
  warningFlags          :: IntSet,
626
  -- Don't change this without updating extensionFlags:
627
  language              :: Maybe Language,
628
629
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
630
631
632
  -- 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.
633
634
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
635
  pkgTrustOnLoc         :: SrcSpan,
636
637
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
638
639
640
641
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
642
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
643

644
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
645
  log_action            :: LogAction,
646
647
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
648

649
  haddockOptions        :: Maybe String,
650
  ghciScripts           :: [String],
651

652
653
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
654
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
655
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
656
657

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

660
  interactivePrint      :: Maybe String,
661

662
  llvmVersion           :: IORef (Int)
663
664
 }

665
666
667
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
668
669
670
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

671
672
673
674
675
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
676
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
677
  deriving (Enum)
678

679
data Settings = Settings {
680
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
681
682
683
684
685
686
687
688
689
  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,
690
691
692
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
693
694
695
696
697
698
699
700
701
702
703
704
705
  -- 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
706
707
708
709
710
711
712
713
714
715
  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
716
  sOpt_lc                :: [String], -- LLVM: llc static compiler
717

718
  sPlatformConstants     :: PlatformConstants
719
720
 }

721
722
723
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

724
725
726
727
728
729
730
731
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
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)
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
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)
782

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

Ian Lynagh's avatar
Ian Lynagh committed
811
812
813
814
815
816
817
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

818
-- | Will this target result in an object file on the disk?
819
820
821
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
822
isObjectTarget HscLlvm  = True
823
824
isObjectTarget _        = False

825
826
827
828
829
830
831
832
833
834
835
-- | 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

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

848
849
850
851
852
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

853
854
855
856
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
868
isNoLink _      = False
869
870

data PackageFlag
871
  = ExposePackage   String
872
  | ExposePackageId String
873
874
875
876
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
877
  deriving Eq
878

879
defaultHscTarget :: Platform -> HscTarget
880
881
defaultHscTarget = defaultObjectTarget

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

890
891
892
893
894
tablesNextToCode :: DynFlags -> Bool
tablesNextToCode dflags
    = mkTablesNextToCode (platformUnregisterised (targetPlatform dflags))

-- Determines whether we will be compiling
895
896
897
-- 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.
898
899
900
mkTablesNextToCode :: Bool -> Bool
mkTablesNextToCode unregisterised
    = not unregisterised && cGhcEnableTablesNextToCode == "YES"
901

902
903
904
905
906
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
907
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
908
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
909

ian@well-typed.com's avatar
ian@well-typed.com committed
910
911
912
913
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
995
996
-----------------------------------------------------------------------------
-- 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 WayPar      = "mt"
-- wayTag WayPar      = "md"
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 WayPar      = False
-- 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 WayPar      = "Parallel ticky profiling"
-- wayDesc WayPar      = "Distributed"
wayDesc WayGran     = "GranSim"
wayDesc WayNDP      = "Nested data parallelism"

997
998
wayOpts :: Platform -> Way -> DynP ()