DynFlags.hs 94.2 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,
35
        DPHBackend(..), dphPackageMaybe,
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
104
import Data.Maybe
Ian Lynagh's avatar
Ian Lynagh committed
105
import System.FilePath
106
import System.IO        ( stderr, hPutChar )
107

108
109
110
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

217
218
   | Opt_PrintExplicitForalls

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

240
241
242
243
244
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
245
246
247
248
249
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
281
282
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
283
   | Opt_AutoLinkPackages
284
   | Opt_ImplicitImportQualified
285
   | Opt_TryNewCodeGen
286
287
288
289
290
291
292

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
293
   | Opt_KeepRawTokenStream
294
   | Opt_KeepLlvmFiles
295

296
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
297

298
299
data Language = Haskell98 | Haskell2010

300
data ExtensionFlag
301
302
303
304
305
306
307
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
308
   | Opt_RelaxedPolyRec		-- Deprecated
309
310
311
312
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
313
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
   | 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
330
   | Opt_GADTSyntax
331
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
332
   | Opt_DoAndIfThenElse
333
   | Opt_RebindableSyntax
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
368
369
370

   | 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
371
   | Opt_NondecreasingIndentation
372
   | Opt_RelaxedLayout
373
374
   deriving (Eq, Show)

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

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

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

407
408
  dphBackend            :: DPHBackend,

409
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
410
411

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

416
417
418
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

419
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
420
  objectDir             :: Maybe String,
421
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
422
423
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
424

Ian Lynagh's avatar
Ian Lynagh committed
425
426
427
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
428

Ian Lynagh's avatar
Ian Lynagh committed
429
430
431
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
432

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

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

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

447
448
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- 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
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
455
456
457
458
459
460
461
462
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
463
464
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
465
466

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
467
468
469
470
471
472
473
474
475
  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]),
476
477
  pgm_T                 :: String,
  pgm_sysman            :: String,
478
  pgm_windres           :: String,
479
480
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
481

482
483
484
485
486
487
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

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

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

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

  haddockOptions :: Maybe String
524
525
 }

526
527
528
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

577
578
579
580
581
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

582
583
584
585
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

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

606
607
data PackageFlag
  = ExposePackage  String
608
  | ExposePackageId String
609
610
  | HidePackage    String
  | IgnorePackage  String
611
  deriving Eq
612

twanvl's avatar
twanvl committed
613
defaultHscTarget :: HscTarget
614
615
defaultHscTarget = defaultObjectTarget

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

623
624
625
626
627
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
628
629
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

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

645
646
-- | 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
647
defaultDynFlags :: DynFlags
648
649
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
650
651
652
653
654
655
656
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
657
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
658
        maxSimplIterations      = 4,
659
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
660
661
662
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
663
        liberateCaseThreshold   = Just 200,
664
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
665
666
        strictnessBefore        = [],

667
#ifndef OMIT_NATIVE_CODEGEN
668
        targetPlatform          = defaultTargetPlatform,
669
#endif
Ian Lynagh's avatar
Ian Lynagh committed
670
671
672
673
674
675
676
        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
677
        dphBackend              = DPHNone,
678

Ian Lynagh's avatar
Ian Lynagh committed
679
680
681
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
682
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
683
684
685
686
687
688
689
690
691
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

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

        hpcDir                  = ".hpc",

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

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

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

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

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

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

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

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

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

832
-- | Test whether a 'DynFlag' is set
833
834
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
835

836
-- | Set a 'DynFlag'
837
838
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
839

840
-- | Unset a 'DynFlag'
841
842
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
843

844
-- | Test whether a 'ExtensionFlag' is set
845
xopt :: ExtensionFlag -> DynFlags -> Bool
846
xopt f dflags = f `elem` extensionFlags dflags
847

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

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

862
863
864
865
866
867
868
869
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
                     }
870

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

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

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

893
894
895
896
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
897
898
  -- \#included from the .hc file when compiling via C (i.e. unregisterised
  -- builds).
Simon Marlow's avatar
Simon Marlow committed
899
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
900
setDylibInstallName  f d = d{ dylibInstallName = Just f}
901

902
903
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
904
905
906
907
setHcSuf      f d = d{ hcSuf      = f}

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

909
910
911
912
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
913
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
914

915
916
setDumpPrefixForce f d = d { dumpPrefixForce = f}

917
918
919
920
-- 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}
921
922
addOptP   f d = d{ opt_P   = f : opt_P d}

923

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

945
946
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
947
948
addHaddockOpts f d = d{ haddockOptions = Just f}

949
950
951
-- -----------------------------------------------------------------------------
-- Command-line options

952
-- | When invoking external tools as part of the compilation pipeline, we
953
954
-- 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
955
-- between filepaths and 'other stuff'. The reason for this is that
956
-- this type gives us a handle on transforming filenames, and filenames only,
957
-- to whatever format they're expected to be on a particular platform.
958
959
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.