DynFlags.hs 95.5 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
Ian Lynagh's avatar
Ian Lynagh committed
111
import System.FilePath
112
import System.IO        ( stderr, hPutChar )
113

114
115
116
-- -----------------------------------------------------------------------------
-- DynFlags

117
-- | Enumerates the simple on-or-off dynamic flags
118
119
120
121
data DynFlag

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

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

239
240
   | Opt_PrintExplicitForalls

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

262
263
264
265
266
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
267
268
269
270
271
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

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

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

316
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
317

318
319
data Language = Haskell98 | Haskell2010

320
data ExtensionFlag
321
322
323
324
325
326
327
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
328
   | Opt_RelaxedPolyRec		-- Deprecated
329
330
331
332
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
333
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_Generics			-- "Derivable type classes"
   | 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
350
   | Opt_GADTSyntax
351
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
352
   | Opt_DoAndIfThenElse
353
   | Opt_RebindableSyntax
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

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

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

412
413
414
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
415
416
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
417

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

425
426
  dphBackend            :: DPHBackend,

427
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
428
429

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

434
435
436
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

437
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
438
  objectDir             :: Maybe String,
439
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
440
441
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
442

Ian Lynagh's avatar
Ian Lynagh committed
443
444
445
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
446

Ian Lynagh's avatar
Ian Lynagh committed
447
448
449
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
450

451
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
452
453
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
454

455
456
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
457
458
459
460
461
462
463
  dumpPrefixForce       :: Maybe FilePath,

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

464
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
465
  rtsOptsEnabled        :: RtsOptsEnabled,
466

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

469
  settings              :: Settings,
470

471
472
473
474
475
476
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

477
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
478
  extraPkgConfs         :: [FilePath],
479
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
480
        -- they appeared.
481

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

485
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
486
  -- NB. do not modify this field, it is calculated by
487
  -- Packages.initPackages and Packages.updatePackages.
488
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
489
  pkgState              :: PackageState,
490

491
492
493
494
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
495
  dirsToClean           :: IORef (Map FilePath FilePath),
496

497
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
498
  flags                 :: [DynFlag],
499
  -- Don't change this without updating extensionFlags:
500
  language              :: Maybe Language,
501
502
503
504
505
  -- 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
506

507
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
508
509
510
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
511
512
 }

513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
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
536
537
538
539
540
541
542
543
544
545
546
547
548
  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

549
550
551
552
553
554
555
556
557
558
559
560
561
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
 }

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)
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
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)
611

612
613
614
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
644
645
646
647
648
649
650
651
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscJava        = panic "No flag for HscJava"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

652
-- | Will this target result in an object file on the disk?
653
654
655
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
656
isObjectTarget HscLlvm  = True
657
658
659
660
661
662
663
664
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.
665
data GhcMode
666
667
668
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
669
670
  deriving Eq

671
672
673
674
675
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

676
677
678
679
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

680
681
682
683
-- | 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
684
685
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
686
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
687
  deriving (Eq, Show)
688
689
690

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

693
694
695
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
696
697
698
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.
699

700
701
data PackageFlag
  = ExposePackage  String
702
  | ExposePackageId String
703
704
  | HidePackage    String
  | IgnorePackage  String
705
  deriving Eq
706

twanvl's avatar
twanvl committed
707
defaultHscTarget :: HscTarget
708
709
defaultHscTarget = defaultObjectTarget

710
-- | The 'HscTarget' value corresponding to the default way to create
711
-- object files on the current platform.
twanvl's avatar
twanvl committed
712
defaultObjectTarget :: HscTarget
713
defaultObjectTarget
714
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
715
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
716
  | otherwise                           =  HscLlvm
717

718
719
720
721
722
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
723
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
724
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
725

726
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
727
initDynFlags :: DynFlags -> IO DynFlags
728
729
730
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
731
 refFilesToClean <- newIORef []
732
 refDirsToClean <- newIORef Map.empty
733
 return dflags{
734
735
736
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
737
738
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
739
        }
740

741
742
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
743
744
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
745
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
746
747
748
749
750
751
752
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
753
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
754
        maxSimplIterations      = 4,
755
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
756
757
758
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
759
        liberateCaseThreshold   = Just 200,
760
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
761
762
        strictnessBefore        = [],

763
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
764
765
766
767
768
769
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
770
        dphBackend              = DPHNone,
771

Ian Lynagh's avatar
Ian Lynagh committed
772
773
774
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
775
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
776
777
778
779
780
781
782
783
784
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
785
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
786
787
788
789
790
791
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
792
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
793
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
794
795
796
797
798

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
799
800
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
801
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
802
803
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
804
        splitInfo               = Nothing,
805
        settings                = mySettings,
806
807
808
809
810
811
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
812
813
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
814
        haddockOptions = Nothing,
815
        flags = defaultFlags,
816
        language = Nothing,
817
818
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
819

Ian Lynagh's avatar
Ian Lynagh committed
820
        log_action = \severity srcSpan style msg ->
821
                        case severity of
822
823
824
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
825
                          _         -> do 
826
                                hPutChar stderr '\n'
827
                                printErrs (mkLocMessage srcSpan msg) style
828
829
830
                     -- 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.
831
832
      }

Ian Lynagh's avatar
Ian Lynagh committed
833
{-
834
835
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
836
    0   |   print errors & warnings only
837
838
839
840
841
842
843
    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"
-}

844
845
846
847
848
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
849
850
851
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
852
853
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
854
855
856
          defaultExtensionFlags = languageExtensions ml

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

858
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
859
    -- Nothing => the default case
860
861
862
    = 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
863
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
864
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
865
      -- SLPJ September 2010
866
    : Opt_NondecreasingIndentation -- This has been on by default for some time
867
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
868

869
870
871
872
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
873
874
875
876
877
878
879
880
       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
881

882
883
884
885
886
887
888
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
889
       Opt_DoAndIfThenElse,
890
       Opt_RelaxedPolyRec]
891

892
-- | Test whether a 'DynFlag' is set
893
894
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
895

896
-- | Set a 'DynFlag'
897
898
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
899

900
-- | Unset a 'DynFlag'
901
902
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
903

904
-- | Test whether a 'ExtensionFlag' is set
905
xopt :: ExtensionFlag -> DynFlags -> Bool
906
xopt f dflags = f `elem` extensionFlags dflags
907

908
-- | Set a 'ExtensionFlag'
909
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
910
911
912
913
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
914

915
-- | Unset a 'ExtensionFlag'
916
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
917
918
919
920
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
921

922
923
924
925
926
927
928
929
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
                     }
930

931
932
933
934
-- | 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
935
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
936
        -- We add to the options from the front, so we need to reverse the list
937

938
939
-- | 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
940
941
942
943
getVerbFlags :: DynFlags -> [String]
getVerbFlags dflags
  | verbosity dflags >= 4 = ["-v"]
  | otherwise             = []
944

945
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
946
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
947
         setPgmP, addOptl, addOptP,
948
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
949
950
951
952
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

953
954
955
956
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
957
958
  -- \#included from the .hc file when compiling via C (i.e. unregisterised
  -- builds).
Simon Marlow's avatar
Simon Marlow committed
959
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
960
setDylibInstallName  f d = d{ dylibInstallName = Just f}
961

962
963
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
964
965
966
967
setHcSuf      f d = d{ hcSuf      = f}

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

969
970
971
972
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
973
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
974

975
976
setDumpPrefixForce f d = d { dumpPrefixForce = f}

977
978
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
979
setPgmP   f = let (pgm:args) = words f in alterSettings (\s -> s { sPgm_P   = (pgm, map Option args)})
980
981
addOptl   f = alterSettings (\s -> s { sOpt_l   = f : sOpt_l s})
addOptP   f = alterSettings (\s -> s { sOpt_P   = f : sOpt_P s})
982

983

984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }