DynFlags.hs 94.5 KB
Newer Older
1
2
3
{-# OPTIONS_GHC -w #-}
-- Temporary, until rtsIsProfiled is fixed

4
-- |
5
6
7
8
9
10
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

11
-- Most flags are dynamic flags, which means they can change from
12
13
14
-- 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.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
17
        DynFlag(..),
18
        ExtensionFlag(..),
19
        glasgowExtsFlags,
20
21
22
23
24
25
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
26
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
28
29
30
31
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynLibLoader(..),
34
        fFlags, fLangFlags, xFlags,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
35
        DPHBackend(..), dphPackage,
36
        wayNames,
37

38
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
39
40
41
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

42
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
43
44
45
46
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
47
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
48

49
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
50
        parseDynamicFlags,
51
        parseDynamicNoPackageFlags,
52
        allFlags,
53

54
        supportedLanguagesAndExtensions,
55
56

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
57
        machdepCCOpts, picCCOpts,
58
59
60
61
62
63

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

        -- * Compiler configuration suitable for display to the user
64
        Printable(..),
65
66
67
68
69
70
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
71
72
73
74
  ) where

#include "HsVersions.h"

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

96
import System.IO.Unsafe	( unsafePerformIO )
97
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
98
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
99

100
import Data.Char
101
import Data.List
102
103
import Data.Map (Map)
import qualified Data.Map as Map
Ian Lynagh's avatar
Ian Lynagh committed
104
import System.FilePath
105
import System.IO        ( stderr, hPutChar )
106

107
108
109
-- -----------------------------------------------------------------------------
-- DynFlags

110
-- | Enumerates the simple on-or-off dynamic flags
111
112
113
114
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
180
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
181
182
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
183
   | Opt_WarnImplicitPrelude
184
   | Opt_WarnIncompletePatterns
185
   | Opt_WarnIncompleteUniPatterns
186
187
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
188
   | Opt_WarnMissingImportList
189
190
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
191
   | Opt_WarnMissingLocalSigs
192
193
194
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
195
   | Opt_WarnMonomorphism
196
197
198
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
199
   | Opt_WarnWarningsDeprecations
200
   | Opt_WarnDeprecatedFlags
201
   | Opt_WarnDodgyExports
202
203
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
204
   | Opt_WarnAutoOrphans
205
   | Opt_WarnIdentities
206
   | Opt_WarnTabs
207
   | Opt_WarnUnrecognisedPragmas
208
   | Opt_WarnDodgyForeignImports
209
   | Opt_WarnLazyUnliftedBindings
210
211
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
212
   | Opt_WarnAlternativeLayoutRuleTransitional
213

214
215
   | Opt_PrintExplicitForalls

216
217
218
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
219
220
   | Opt_FloatIn
   | Opt_Specialise
221
   | Opt_StaticArgumentTransformation
222
   | Opt_CSE
223
224
   | Opt_LiberateCase
   | Opt_SpecConstr
225
226
227
228
229
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
230
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
231
   | Opt_DictsCheap
232
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
233
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
234
235
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
236

237
238
239
240
241
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
242
243
244
245
246
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

247
248
   -- misc opts
   | Opt_Pp
249
   | Opt_ForceRecomp
250
251
252
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
253
   | Opt_EagerBlackHoling
254
255
256
257
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
258
   | Opt_HideAllPackages
259
   | Opt_PrintBindResult
260
   | Opt_Haddock
David Waern's avatar
David Waern committed
261
   | Opt_HaddockOptions
262
   | Opt_Hpc_No_Auto
263
   | Opt_BreakOnException
264
   | Opt_BreakOnError
265
   | Opt_PrintEvldWithShow
266
   | Opt_PrintBindContents
267
268
   | Opt_GenManifest
   | Opt_EmbedManifest
269
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
270
   | Opt_SharedImplib
271
   | Opt_BuildingCabalPackage
272
   | Opt_SSE2
273
   | Opt_GhciSandbox
274
   | Opt_HelpfulErrors
275
276
277

	-- temporary flags
   | Opt_RunCPS
278
279
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
280
   | Opt_AutoLinkPackages
281
   | Opt_ImplicitImportQualified
282
   | Opt_TryNewCodeGen
283
284
285
286
287
288
289

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
290
   | Opt_KeepRawTokenStream
291
   | Opt_KeepLlvmFiles
292

293
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
294

295
296
data Language = Haskell98 | Haskell2010

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

   | 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
   | 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
368
   | Opt_NondecreasingIndentation
369
   | Opt_RelaxedLayout
370
371
   deriving (Eq, Show)

372
373
-- | 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
374
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
375
376
377
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
378
  hscOutName            :: String,      -- ^ Name of the output file
379
  extCoreName           :: String,      -- ^ Name of the .hcr output file
380
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
381
382
383
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
384
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
385
  ruleCheck             :: Maybe String,
386
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
387

388
389
390
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
391
392
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
393

394
#ifndef OMIT_NATIVE_CODEGEN
395
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
396
#endif
Ian Lynagh's avatar
Ian Lynagh committed
397
  stolen_x86_regs       :: Int,
398
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
399
400
401
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
402
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
403

404
405
  dphBackend            :: DPHBackend,

406
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
407
408

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

413
414
415
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

416
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
417
  objectDir             :: Maybe String,
418
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
419
420
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
421

Ian Lynagh's avatar
Ian Lynagh committed
422
423
424
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
425

Ian Lynagh's avatar
Ian Lynagh committed
426
427
428
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
429

430
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
431
432
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
433

434
435
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
436
437
438
439
440
441
442
443
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto
  tmpDir                :: String,      -- no trailing '/'

444
445
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
446
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
447
  rtsOptsEnabled        :: RtsOptsEnabled,
448

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

451
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
452
453
454
455
456
457
458
459
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
460
461
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
462
463

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
464
465
466
467
468
469
470
471
472
  pgm_L                 :: String,
  pgm_P                 :: (String,[Option]),
  pgm_F                 :: String,
  pgm_c                 :: (String,[Option]),
  pgm_m                 :: (String,[Option]),
  pgm_s                 :: (String,[Option]),
  pgm_a                 :: (String,[Option]),
  pgm_l                 :: (String,[Option]),
  pgm_dll               :: (String,[Option]),
473
474
  pgm_T                 :: String,
  pgm_sysman            :: String,
475
  pgm_windres           :: String,
476
477
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
478

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
521
522
 }

523
524
525
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

526
527
-- | The target code type of the compilation (if any).
--
528
529
530
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
531
532
533
534
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
535
536
537
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
538
--
539
540
541
542
543
544
--  * 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.)
545
--
546
data HscTarget
547
548
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
549
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
550
551
552
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
553
554
  deriving (Eq, Show)

555
-- | Will this target result in an object file on the disk?
556
557
558
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
559
isObjectTarget HscLlvm  = True
560
561
562
563
564
565
566
567
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.
568
data GhcMode
569
570
571
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
572
573
  deriving Eq

574
575
576
577
578
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

579
580
581
582
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

583
584
585
586
-- | 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
587
588
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
589
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
590
  deriving (Eq, Show)
591
592
593

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

596
597
598
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
599
600
601
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.
602

603
604
data PackageFlag
  = ExposePackage  String
605
  | ExposePackageId String
606
607
  | HidePackage    String
  | IgnorePackage  String
608
  deriving Eq
609

twanvl's avatar
twanvl committed
610
defaultHscTarget :: HscTarget
611
612
defaultHscTarget = defaultObjectTarget

613
-- | The 'HscTarget' value corresponding to the default way to create
614
-- object files on the current platform.
twanvl's avatar
twanvl committed
615
defaultObjectTarget :: HscTarget
616
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
617
618
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
619

620
621
622
623
624
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
625
626
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

627
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
628
initDynFlags :: DynFlags -> IO DynFlags
629
630
631
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
632
 refFilesToClean <- newIORef []
633
 refDirsToClean <- newIORef Map.empty
634
 return dflags{
635
636
637
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
638
639
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
640
        }
641

642
643
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
twanvl's avatar
twanvl committed
644
defaultDynFlags :: DynFlags
645
646
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
647
648
649
650
651
652
653
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
654
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
655
        maxSimplIterations      = 4,
656
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
657
658
659
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
660
        liberateCaseThreshold   = Just 200,
661
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
662
663
        strictnessBefore        = [],

664
#ifndef OMIT_NATIVE_CODEGEN
665
        targetPlatform          = defaultTargetPlatform,
666
#endif
Ian Lynagh's avatar
Ian Lynagh committed
667
668
669
670
671
672
673
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
674
        dphBackend              = DPHNone,
675

Ian Lynagh's avatar
Ian Lynagh committed
676
677
678
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
679
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
680
681
682
683
684
685
686
687
688
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
689
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
690
691
692
693
694
695
696
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
697
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
698
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
699
700
701
702
703

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
704
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
705
706
707
708
709
710
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
711
        opt_windres             = [],
712
713
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
714
715
716

        extraPkgConfs           = [],
        packageFlags            = [],
717
718
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
719
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
720
721
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
722
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
723
724
725
726
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
727
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
728
729
730
731
732
733
734
735
736
737
738
739
        pgm_L                   = panic "defaultDynFlags: No pgm_L",
        pgm_P                   = panic "defaultDynFlags: No pgm_P",
        pgm_F                   = panic "defaultDynFlags: No pgm_F",
        pgm_c                   = panic "defaultDynFlags: No pgm_c",
        pgm_m                   = panic "defaultDynFlags: No pgm_m",
        pgm_s                   = panic "defaultDynFlags: No pgm_s",
        pgm_a                   = panic "defaultDynFlags: No pgm_a",
        pgm_l                   = panic "defaultDynFlags: No pgm_l",
        pgm_dll                 = panic "defaultDynFlags: No pgm_dll",
        pgm_T                   = panic "defaultDynFlags: No pgm_T",
        pgm_sysman              = panic "defaultDynFlags: No pgm_sysman",
        pgm_windres             = panic "defaultDynFlags: No pgm_windres",
740
741
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
742
        -- end of initSysTools values
743
744
745
746
747
748
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
749
750
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
751
        haddockOptions = Nothing,
752
        flags = defaultFlags,
753
        language = Nothing,
754
755
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
756

Ian Lynagh's avatar
Ian Lynagh committed
757
        log_action = \severity srcSpan style msg ->
758
                        case severity of
759
760
761
762
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
763
764
765
766
767
                                hPutChar stderr '\n'
                                printErrs ((mkLocMessage srcSpan msg) style)
                     -- 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.
768
769
      }

Ian Lynagh's avatar
Ian Lynagh committed
770
{-
771
772
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
773
    0   |   print errors & warnings only
774
775
776
777
778
779
780
    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"
-}

781
782
783
784
785
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
786
787
788
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
789
790
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
791
792
793
          defaultExtensionFlags = languageExtensions ml

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

795
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
796
    -- Nothing => the default case
797
798
799
    = 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
800
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
801
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
802
      -- SLPJ September 2010
803
    : Opt_NondecreasingIndentation -- This has been on by default for some time
804
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
805

806
807
808
809
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
810
811
812
813
814
815
816
817
       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
818

819
820
821
822
823
824
825
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
826
       Opt_DoAndIfThenElse,
827
       Opt_RelaxedPolyRec]
828

829
-- | Test whether a 'DynFlag' is set
830
831
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
832

833
-- | Set a 'DynFlag'
834
835
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
836

837
-- | Unset a 'DynFlag'
838
839
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
840

841
-- | Test whether a 'ExtensionFlag' is set
842
xopt :: ExtensionFlag -> DynFlags -> Bool
843
xopt f dflags = f `elem` extensionFlags dflags
844

845
-- | Set a 'ExtensionFlag'
846
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
847
848
849
850
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
851

852
-- | Unset a 'ExtensionFlag'
853
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
854
855
856
857
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
858

859
860
861
862
863
864
865
866
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
                     }
867

868
869
870
871
-- | 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
872
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
873
        -- We add to the options from the front, so we need to reverse the list
874

875
876
-- | 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
877
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
878
879
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
880
881
  | otherwise =  ""

882
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
883
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
884
         setPgmP, addOptl, addOptP,
885
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
886
887
888
889
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

890
891
892
893
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
Thomas Schilling's avatar
Thomas Schilling committed
894
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
895
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
896
setDylibInstallName  f d = d{ dylibInstallName = Just f}
897

898
899
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
900
901
902
903
setHcSuf      f d = d{ hcSuf      = f}

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

905
906
907
908
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
909
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
910

911
912
setDumpPrefixForce f d = d { dumpPrefixForce = f}

913
914
915
916
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}
addOptl   f d = d{ opt_l   = f : opt_l d}
917
918
addOptP   f d = d{ opt_P   = f : opt_P d}

919

920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
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
937
deOptDep x = case stripPrefix "-optdep" x of
938
939
940
             Just rest -> rest
             Nothing -> x

941
942
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
943
944
addHaddockOpts f d = d{ haddockOptions = Just f}

945
946
947
-- -----------------------------------------------------------------------------
-- Command-line options

948
-- | When invoking external tools as part of the compilation pipeline, we
949
950
-- pass these a sequence of options on the command-line. Rather than
-- just using a list of Strings, we use a type that allows us to distinguish
951
-- between filepaths and 'other stuff'. The reason for this is that
952
-- this type gives us a handle on transforming filenames, and filenames only,
953
-- to whatever format they're expected to be on a particular platform.
954
955
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
956
957
958
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
959
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
960

Ian Lynagh's avatar
Ian Lynagh committed
961
962
963
964
showOpt :: Option -> String
showOpt (F