DynFlags.hs 94.4 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
156
157
158
159
160
   | 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
   | 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
161
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
162
   | Opt_D_dump_rtti
163
164
165
166
167
168
   | 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
169
   | Opt_D_dump_mod_cycles
170
   | Opt_D_dump_view_pattern_commoning
171
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
172
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
173
   | Opt_D_no_debug_output
174
175
176
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
177
   | Opt_DoAsmLinting
178

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

213
214
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

294
295
data Language = Haskell98 | Haskell2010

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

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

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

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

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

403
404
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  haddockOptions :: Maybe String
520
521
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        hpcDir                  = ".hpc",

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

912
913
914
915
-- 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}
916
917
addOptP   f d = d{ opt_P   = f : opt_P d}

918

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

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

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

944
945
946
-- -----------------------------------------------------------------------------
-- Command-line options

947
-- | When invoking external tools as part of the compilation pipeline, we
948
949
-- 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
950
-- between filepaths and 'other stuff'. The reason for this is that
951
-- this type gives us a handle on transforming filenames, and filenames only,
952
-- to whatever format they're expected to be on a particular platform.
953
954
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
955
956
957
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
958
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
959

Ian Lynagh's avatar
Ian Lynagh committed
960
961
962
963
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

964
965
966
967
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags