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

Ian Lynagh's avatar
Ian Lynagh committed
190
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
191
192
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
193
   | Opt_WarnImplicitPrelude
194
   | Opt_WarnIncompletePatterns
195
   | Opt_WarnIncompleteUniPatterns
196
197
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
198
   | Opt_WarnMissingImportList
199
200
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
201
   | Opt_WarnMissingLocalSigs
202
203
204
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
205
   | Opt_WarnMonomorphism
206
207
208
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
209
   | Opt_WarnWarningsDeprecations
210
   | Opt_WarnDeprecatedFlags
211
   | Opt_WarnDodgyExports
212
213
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
214
   | Opt_WarnAutoOrphans
215
   | Opt_WarnIdentities
216
   | Opt_WarnTabs
217
   | Opt_WarnUnrecognisedPragmas
218
   | Opt_WarnDodgyForeignImports
219
   | Opt_WarnLazyUnliftedBindings
220
221
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
222
   | Opt_WarnAlternativeLayoutRuleTransitional
223

224
225
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

301
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
302

303
304
data Language = Haskell98 | Haskell2010

305
data ExtensionFlag
306
307
308
309
310
311
312
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
313
   | Opt_RelaxedPolyRec		-- Deprecated
314
315
316
317
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
318
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
   | 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
335
   | Opt_GADTSyntax
336
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
337
   | Opt_DoAndIfThenElse
338
   | Opt_RebindableSyntax
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

   | 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
360
   | Opt_MonadComprehensions
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
   | 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
377
   | Opt_NondecreasingIndentation
378
   | Opt_RelaxedLayout
379
380
   deriving (Eq, Show)

381
382
-- | 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
383
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
384
385
386
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
387
  hscOutName            :: String,      -- ^ Name of the output file
388
  extCoreName           :: String,      -- ^ Name of the .hcr output file
389
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
390
391
392
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
393
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
394
  ruleCheck             :: Maybe String,
395
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
396

397
398
399
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
400
401
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
402

Ian Lynagh's avatar
Ian Lynagh committed
403
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
404
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
405
406
407
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
408
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
409

410
411
  dphBackend            :: DPHBackend,

412
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
413
414

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

419
420
421
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

422
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
423
  objectDir             :: Maybe String,
424
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
425
426
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
427

Ian Lynagh's avatar
Ian Lynagh committed
428
429
430
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
431

Ian Lynagh's avatar
Ian Lynagh committed
432
433
434
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
435

436
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
437
438
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
439

440
441
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
442
443
444
445
446
447
448
  dumpPrefixForce       :: Maybe FilePath,

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

449
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
450
  rtsOptsEnabled        :: RtsOptsEnabled,
451

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

454
  settings              :: Settings,
455

456
457
458
459
460
461
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

462
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
463
  extraPkgConfs         :: [FilePath],
464
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
465
        -- they appeared.
466

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

470
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
471
  -- NB. do not modify this field, it is calculated by
472
  -- Packages.initPackages and Packages.updatePackages.
473
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
474
  pkgState              :: PackageState,
475

476
477
478
479
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
480
  dirsToClean           :: IORef (Map FilePath FilePath),
481

482
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
483
  flags                 :: [DynFlag],
484
  -- Don't change this without updating extensionFlags:
485
  language              :: Maybe Language,
486
487
488
489
490
  -- 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
491

492
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
493
494
495
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
496
497
 }

498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
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
521
522
523
524
525
526
527
528
529
530
531
532
533
  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

534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
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
 }

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)
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
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)
596

597
598
599
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

600
601
-- | The target code type of the compilation (if any).
--
602
603
604
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
605
606
607
608
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
609
610
611
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
612
--
613
614
615
616
617
618
--  * 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.)
619
--
620
data HscTarget
621
622
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
623
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
624
625
626
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
627
628
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
629
630
631
632
633
634
635
636
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"

637
-- | Will this target result in an object file on the disk?
638
639
640
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
641
isObjectTarget HscLlvm  = True
642
643
644
645
646
647
648
649
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.
650
data GhcMode
651
652
653
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
654
655
  deriving Eq

656
657
658
659
660
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

661
662
663
664
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

665
666
667
668
-- | 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
669
670
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
671
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
672
  deriving (Eq, Show)
673
674
675

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

678
679
680
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
681
682
683
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.
684

685
686
data PackageFlag
  = ExposePackage  String
687
  | ExposePackageId String
688
689
  | HidePackage    String
  | IgnorePackage  String
690
  deriving Eq
691

twanvl's avatar
twanvl committed
692
defaultHscTarget :: HscTarget
693
694
defaultHscTarget = defaultObjectTarget

695
-- | The 'HscTarget' value corresponding to the default way to create
696
-- object files on the current platform.
twanvl's avatar
twanvl committed
697
defaultObjectTarget :: HscTarget
698
defaultObjectTarget
699
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
700
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
701
  | otherwise                           =  HscLlvm
702

703
704
705
706
707
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
708
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
709
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
710

711
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
712
initDynFlags :: DynFlags -> IO DynFlags
713
714
715
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
716
 refFilesToClean <- newIORef []
717
 refDirsToClean <- newIORef Map.empty
718
 return dflags{
719
720
721
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
722
723
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
724
        }
725

726
727
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
728
729
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
730
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
731
732
733
734
735
736
737
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
738
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
739
        maxSimplIterations      = 4,
740
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
741
742
743
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
744
        liberateCaseThreshold   = Just 200,
745
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
746
747
        strictnessBefore        = [],

748
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
749
750
751
752
753
754
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
755
        dphBackend              = DPHNone,
756

Ian Lynagh's avatar
Ian Lynagh committed
757
758
759
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
760
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
761
762
763
764
765
766
767
768
769
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
770
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
771
772
773
774
775
776
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
777
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
778
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
779
780
781
782
783

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
784
785
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
786
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
787
788
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
789
        splitInfo               = Nothing,
790
        settings                = mySettings,
791
792
793
794
795
796
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
797
798
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
799
        haddockOptions = Nothing,
800
        flags = defaultFlags,
801
        language = Nothing,
802
803
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
804

Ian Lynagh's avatar
Ian Lynagh committed
805
        log_action = \severity srcSpan style msg ->
806
                        case severity of
807
808
809
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
810
                          _         -> do 
811
                                hPutChar stderr '\n'
812
                                printErrs (mkLocMessage srcSpan msg) style
813
814
815
                     -- 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.
816
817
      }

Ian Lynagh's avatar
Ian Lynagh committed
818
{-
819
820
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
821
    0   |   print errors & warnings only
822
823
824
825
826
827
828
    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"
-}

829
830
831
832
833
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
834
835
836
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
837
838
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
839
840
841
          defaultExtensionFlags = languageExtensions ml

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

843
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
844
    -- Nothing => the default case
845
846
847
    = 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
848
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
849
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
850
      -- SLPJ September 2010
851
    : Opt_NondecreasingIndentation -- This has been on by default for some time
852
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
853

854
855
856
857
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
858
859
860
861
862
863
864
865
       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
866

867
868
869
870
871
872
873
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
874
       Opt_DoAndIfThenElse,
875
       Opt_RelaxedPolyRec]
876

877
-- | Test whether a 'DynFlag' is set
878
879
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
880

881
-- | Set a 'DynFlag'
882
883
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
884

885
-- | Unset a 'DynFlag'
886
887
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
888

889
-- | Test whether a 'ExtensionFlag' is set
890
xopt :: ExtensionFlag -> DynFlags -> Bool
891
xopt f dflags = f `elem` extensionFlags dflags
892

893
-- | Set a 'ExtensionFlag'
894
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
895
896
897
898
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
899

900
-- | Unset a 'ExtensionFlag'
901
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
902
903
904
905
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
906

907
908
909
910
911
912
913
914
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
                     }
915

916
917
918
919
-- | 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
920
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
921
        -- We add to the options from the front, so we need to reverse the list
922

923
924
-- | 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
925
926
927
928
getVerbFlags :: DynFlags -> [String]
getVerbFlags dflags
  | verbosity dflags >= 4 = ["-v"]
  | otherwise             = []
929

930
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
931
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
932
         setPgmP, addOptl, addOptP,
933
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
934
935
936
937
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

938
939
940
941
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
942
943
  -- \#included from the .hc file when compiling via C (i.e. unregisterised
  -- builds).
Simon Marlow's avatar
Simon Marlow committed
944
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
945
setDylibInstallName  f d = d{ dylibInstallName = Just f}
946

947
948
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
949
950
951
952
setHcSuf      f d = d{ hcSuf      = f}

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

954
955
956
957
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
958
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
959

960
961
setDumpPrefixForce f d = d { dumpPrefixForce = f}

962
963
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
964
setPgmP   f = let (pgm:args) = words f in alterSettings (\s -> s { sPgm_P   = (pgm, map Option args)})
965
966
addOptl   f = alterSettings (\s -> s { sOpt_l   = f : sOpt_l s})
addOptP   f = alterSettings (\s -> s { sOpt_P   = f : sOpt_P s})
967

968

969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

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

addDepExcludeMod :: String -> DynFlags -> DynFlags
addDepExcludeMod m d
    = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }

addDepSuffix :: FilePath -> DynFlags -> DynFlags
addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }

-- XXX Legacy code:
-- We used to use "-optdep-flag -optdeparg", so for legacy applications
-- we need to strip the "-optdep" off of the arg
deOptDep :: String -> String
986
deOptDep x = case stripPrefix "-optdep" x of
987