DynFlags.hs 87.2 KB
Newer Older
1
-- |
2
3
4
5
6
7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

8
-- Most flags are dynamic flags, which means they can change from
9
10
11
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
12
module DynFlags (
13
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
14
15
16
17
18
19
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
20
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
21
        DynLibLoader(..),
22
        fFlags, xFlags,
23
        dphPackage,
24
        wayNames,
25

26
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
27
28
29
30
31
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

        dopt,                           -- DynFlag -> DynFlags -> Bool
        dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
32
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
33
34
35
36
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
37
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
38

39
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
40
        parseDynamicFlags,
41
        parseDynamicNoPackageFlags,
42
        allFlags,
43

44
45
46
        supportedLanguages, languageOptions,

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
47
        machdepCCOpts, picCCOpts,
48
49
50
51
52
53

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

        -- * Compiler configuration suitable for display to the user
54
        Printable(..),
55
        compilerInfo
56
57
58
59
  ) where

#include "HsVersions.h"

60
#ifndef OMIT_NATIVE_CODEGEN
61
import Platform
62
#endif
63
import Module
Simon Marlow's avatar
Simon Marlow committed
64
import PackageConfig
65
import PrelNames        ( mAIN )
66
import StaticFlags
67
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
68
import DriverPhases     ( Phase(..), phaseInputExt )
69
70
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
71
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
72
import Panic
73
import Util
74
import Maybes           ( orElse )
75
import SrcLoc
76
import FastString
77
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
78
79
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
80

81
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
82
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
83

84
import Data.Char
85
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
86
import System.FilePath
87
import System.IO        ( stderr, hPutChar )
88

89
90
91
-- -----------------------------------------------------------------------------
-- DynFlags

92
-- | Enumerates the simple on-or-off dynamic flags
93
94
95
96
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
97
   | Opt_D_dump_cmmz
98
   | Opt_D_dump_cmmz_pretty
99
   | Opt_D_dump_cps_cmm
100
   | Opt_D_dump_cvt_cmm
101
   | Opt_D_dump_asm
102
103
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
104
   | Opt_D_dump_asm_coalesce
105
106
107
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
108
   | Opt_D_dump_asm_stats
109
   | Opt_D_dump_asm_expanded
110
111
112
113
114
115
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
116
   | Opt_D_dump_rule_firings
117
118
119
120
121
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
122
   | Opt_D_dump_simpl_phases
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
   | 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
141
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
142
   | Opt_D_dump_rtti
143
144
145
146
147
148
   | 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
149
   | Opt_D_dump_mod_cycles
150
   | Opt_D_dump_view_pattern_commoning
151
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
152
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
153
   | Opt_D_no_debug_output
154
155
156
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
157
   | Opt_DoAsmLinting
158

Ian Lynagh's avatar
Ian Lynagh committed
159
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
160
161
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
162
   | Opt_WarnImplicitPrelude
163
164
165
166
167
168
169
170
171
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
172
   | Opt_WarnMonomorphism
173
174
175
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
176
   | Opt_WarnWarningsDeprecations
177
   | Opt_WarnDeprecatedFlags
178
   | Opt_WarnDodgyExports
179
180
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
181
   | Opt_WarnTabs
182
   | Opt_WarnUnrecognisedPragmas
183
   | Opt_WarnDodgyForeignImports
184
   | Opt_WarnLazyUnliftedBindings
185
186
187
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind

188
189

   -- language opts
190
191
192
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
193
   | Opt_MonomorphismRestriction
194
   | Opt_MonoPatBinds
195
   | Opt_MonoLocalBinds
Ian Lynagh's avatar
Ian Lynagh committed
196
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
197
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
198
   | Opt_UnliftedFFITypes
199
   | Opt_GHCForeignImportPrim
Ian Lynagh's avatar
Ian Lynagh committed
200
201
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
202
   | Opt_TemplateHaskell
203
   | Opt_QuasiQuotes
204
   | Opt_ImplicitParams
205
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
206
   | Opt_ImplicitPrelude
207
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
208
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
209
   | Opt_BangPatterns
210
   | Opt_TypeFamilies
211
   | Opt_OverloadedStrings
212
   | Opt_DisambiguateRecordFields
213
   | Opt_RecordWildCards
214
   | Opt_RecordPuns
215
   | Opt_ViewPatterns
216
   | Opt_GADTs
217
   | Opt_RelaxedPolyRec
218
   | Opt_NPlusKPatterns
219

220
   | Opt_StandaloneDeriving
221
   | Opt_DeriveDataTypeable
222
   | Opt_DeriveFunctor
223
224
225
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

226
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
227
   | Opt_FlexibleContexts
228
   | Opt_FlexibleInstances
229
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
230
   | Opt_MultiParamTypeClasses
231
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
232
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
233
   | Opt_PolymorphicComponents
234
   | Opt_ExistentialQuantification
235
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
236
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
238
   | Opt_ParallelListComp
239
   | Opt_TransformListComp
240
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
241
   | Opt_RecursiveDo
242
   | Opt_DoRec
243
   | Opt_PostfixOperators
244
   | Opt_TupleSections
Ian Lynagh's avatar
Ian Lynagh committed
245
   | Opt_PatternGuards
246
   | Opt_LiberalTypeSynonyms
247
248
   | Opt_Rank2Types
   | Opt_RankNTypes
249
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
250
   | Opt_TypeOperators
251
   | Opt_PackageImports
252
   | Opt_NewQualifiedOperators
253
   | Opt_ExplicitForAll
254
   | Opt_AlternativeLayoutRule
255

256
257
   | Opt_PrintExplicitForalls

258
259
260
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
261
262
   | Opt_FloatIn
   | Opt_Specialise
263
   | Opt_StaticArgumentTransformation
264
   | Opt_CSE
265
266
   | Opt_LiberateCase
   | Opt_SpecConstr
267
268
269
270
271
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
272
   | Opt_MethodSharing
273
   | Opt_DictsCheap
274
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
275
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
276
277
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
278

279
280
281
282
283
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
284
285
286
287
288
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

289
290
291
   -- misc opts
   | Opt_Cpp
   | Opt_Pp
292
   | Opt_ForceRecomp
293
294
295
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
296
   | Opt_EagerBlackHoling
297
298
299
300
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
301
   | Opt_HideAllPackages
302
   | Opt_PrintBindResult
303
   | Opt_Haddock
David Waern's avatar
David Waern committed
304
   | Opt_HaddockOptions
305
   | Opt_Hpc_No_Auto
306
   | Opt_BreakOnException
307
   | Opt_BreakOnError
308
   | Opt_PrintEvldWithShow
309
   | Opt_PrintBindContents
310
311
   | Opt_GenManifest
   | Opt_EmbedManifest
312
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
313
   | Opt_SharedImplib
314
   | Opt_BuildingCabalPackage
315
316
317

	-- temporary flags
   | Opt_RunCPS
318
319
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
320
   | Opt_AutoLinkPackages
321
   | Opt_ImplicitImportQualified
322
   | Opt_TryNewCodeGen
323
324
325
326
327
328
329

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
330
   | Opt_KeepRawTokenStream
331

332
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
333

334
335
-- | 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
336
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
337
338
339
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
340
  hscOutName            :: String,      -- ^ Name of the output file
341
  extCoreName           :: String,      -- ^ Name of the .hcr output file
342
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
343
344
345
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
346
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
347
  ruleCheck             :: Maybe String,
348
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
349

350
351
352
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
353

354
#ifndef OMIT_NATIVE_CODEGEN
355
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
356
#endif
Ian Lynagh's avatar
Ian Lynagh committed
357
  stolen_x86_regs       :: Int,
358
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
359
360
361
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
362
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
363

364
365
  dphBackend            :: DPHBackend,

366
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
367
368

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

373
374
375
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

376
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
377
  objectDir             :: Maybe String,
378
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
379
380
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
381

Ian Lynagh's avatar
Ian Lynagh committed
382
383
384
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
385

Ian Lynagh's avatar
Ian Lynagh committed
386
387
388
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
389

390
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
391
392
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
393

394
395
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
396
397
398
399
400
401
402
403
  dumpPrefixForce       :: Maybe FilePath,

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

404
405
406
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

409
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
410
411
412
413
414
415
416
417
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
418
419

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
420
421
422
423
424
425
426
427
428
  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]),
429
430
  pgm_T                 :: String,
  pgm_sysman            :: String,
431
  pgm_windres           :: String,
432

433
434
435
436
437
438
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

439
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
440
  extraPkgConfs         :: [FilePath],
441
442
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
443
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
444
        -- they appeared.
445

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

449
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
450
  -- NB. do not modify this field, it is calculated by
451
  -- Packages.initPackages and Packages.updatePackages.
452
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
453
  pkgState              :: PackageState,
454

455
456
457
458
459
460
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
  dirsToClean           :: IORef (FiniteMap FilePath FilePath),

461
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
462
463
  flags                 :: [DynFlag],

464
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
465
466
467
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
468
469
 }

470
471
472
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

473
474
-- | The target code type of the compilation (if any).
--
475
476
477
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
478
479
480
481
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
482
483
484
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
485
--
486
487
488
489
490
491
--  * 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.)
492
--
493
data HscTarget
494
495
496
497
498
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
499
500
  deriving (Eq, Show)

501
-- | Will this target result in an object file on the disk?
502
503
504
505
506
507
508
509
510
511
512
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
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.
513
data GhcMode
514
515
516
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
517
518
  deriving Eq

519
520
521
522
523
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

524
525
526
527
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

528
529
530
531
-- | 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
532
533
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
534
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
535
  deriving (Eq, Show)
536
537
538

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

541
542
543
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
544
545
546
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.
547

548
549
data PackageFlag
  = ExposePackage  String
550
  | ExposePackageId String
551
552
  | HidePackage    String
  | IgnorePackage  String
553
  deriving Eq
554

twanvl's avatar
twanvl committed
555
defaultHscTarget :: HscTarget
556
557
defaultHscTarget = defaultObjectTarget

558
-- | The 'HscTarget' value corresponding to the default way to create
559
-- object files on the current platform.
twanvl's avatar
twanvl committed
560
defaultObjectTarget :: HscTarget
561
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
562
563
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
564

565
566
567
568
569
570
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

571
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
572
initDynFlags :: DynFlags -> IO DynFlags
573
574
575
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
576
577
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
578
 return dflags{
579
580
581
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
582
583
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
584
        }
585

586
587
-- | 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
588
defaultDynFlags :: DynFlags
589
590
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
591
592
593
594
595
596
597
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
598
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
599
        maxSimplIterations      = 4,
600
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
601
602
603
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
604
        liberateCaseThreshold   = Just 200,
605
606
        strictnessBefore        = [],

607
#ifndef OMIT_NATIVE_CODEGEN
608
        targetPlatform          = defaultTargetPlatform,
609
#endif
Ian Lynagh's avatar
Ian Lynagh committed
610
611
612
613
614
615
616
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

617
618
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
619
620
621
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
622
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
623
624
625
626
627
628
629
630
631
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
632
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
633
634
635
636
637
638
639
640
641
642
643
644
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
645
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
646
647
648
649
650
651
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
652
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
653
654
655

        extraPkgConfs           = [],
        packageFlags            = [],
656
657
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
658
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
659
660
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
661
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
662
663
664
665
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
666
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
667
668
669
670
671
672
673
674
675
676
677
678
679
        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",
        -- end of initSysTools values
680
681
682
683
684
685
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
686
687
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
688
        haddockOptions = Nothing,
689
        flags = [
690
            Opt_AutoLinkPackages,
691
692
693
694
695
696
697
698
            Opt_ReadUserPackageConf,

            Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
                                -- behaviour the default, to see if anyone notices
                                -- SLPJ July 06

            Opt_ImplicitPrelude,
            Opt_MonomorphismRestriction,
699
            Opt_NPlusKPatterns,
700

701
702
            Opt_MethodSharing,

703
704
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
705
706
            Opt_SharedImplib,

707
            Opt_GenManifest,
708
709
            Opt_EmbedManifest,
            Opt_PrintBindContents
710
711
712
713
714
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
715
        log_action = \severity srcSpan style msg ->
716
                        case severity of
717
718
719
720
721
722
723
724
                          SevInfo  -> printErrs (msg style)
                          SevFatal -> printErrs (msg style)
                          _        -> do 
                                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.
725
726
      }

Ian Lynagh's avatar
Ian Lynagh committed
727
{-
728
729
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
730
    0   |   print errors & warnings only
731
732
733
734
735
736
737
    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"
-}

738
-- | Test whether a 'DynFlag' is set
739
740
741
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

742
-- | Set a 'DynFlag'
743
744
745
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

746
-- | Unset a 'DynFlag'
747
748
749
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

750
751
752
753
-- | 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
754
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
755
        -- We add to the options from the front, so we need to reverse the list
756

757
758
-- | 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
759
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
760
761
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
762
763
  | otherwise =  ""

764
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
765
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
766
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
767
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
768
769
770
771
772
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

773
774
775
776
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
777
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
778
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
779
setDylibInstallName  f d = d{ dylibInstallName = Just f}
780

781
782
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
783
784
785
786
setHcSuf      f d = d{ hcSuf      = f}

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

788
789
790
791
792
793
794
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
   ("wrapped", "")      -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", "hard") -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", flex)   -> d{ dynLibLoader = Wrapped (Just flex) }
795
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
796

797
798
setDumpPrefixForce f d = d { dumpPrefixForce = f}

799
800
801
802
803
804
805
806
807
808
809
810
-- 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)}

setPgmL   f d = d{ pgm_L   = f}
setPgmF   f d = d{ pgm_F   = f}
setPgmc   f d = d{ pgm_c   = (f,[])}
setPgmm   f d = d{ pgm_m   = (f,[])}
setPgms   f d = d{ pgm_s   = (f,[])}
setPgma   f d = d{ pgm_a   = (f,[])}
setPgml   f d = d{ pgm_l   = (f,[])}
setPgmdll f d = d{ pgm_dll = (f,[])}
811
setPgmwindres f d = d{ pgm_windres = f}
812
813
814
815
816
817
818
819

addOptL   f d = d{ opt_L   = f : opt_L d}
addOptP   f d = d{ opt_P   = f : opt_P d}
addOptF   f d = d{ opt_F   = f : opt_F d}
addOptc   f d = d{ opt_c   = f : opt_c d}
addOptm   f d = d{ opt_m   = f : opt_m d}
addOpta   f d = d{ opt_a   = f : opt_a d}
addOptl   f d = d{ opt_l   = f : opt_l d}
820
addOptwindres f d = d{ opt_windres = f : opt_windres d}
821

822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
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
839
deOptDep x = case stripPrefix "-optdep" x of
840
841
842
             Just rest -> rest
             Nothing -> x

843
844
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
845
846
addHaddockOpts f d = d{ haddockOptions = Just f}

847
848
849
-- -----------------------------------------------------------------------------
-- Command-line options

850
-- | When invoking external tools as part of the compilation pipeline, we
851
852
-- 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
853
-- between filepaths and 'other stuff'. The reason for this is that
854
-- this type gives us a handle on transforming filenames, and filenames only,
855
-- to whatever format they're expected to be on a particular platform.
856
857
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
858
859
860
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
861
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
862

Ian Lynagh's avatar
Ian Lynagh committed
863
864
865
866
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

867
868
869
870
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
871
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
872
updOptLevel n dfs
873
  = dfs2{ optLevel = final_n }
874
  where
Ian Lynagh's avatar
Ian Lynagh committed
875
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
876
877
878
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

879
880
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
Ian Lynagh's avatar
Ian Lynagh committed
881

882
883
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
884
  = [ ([0],     Opt_IgnoreInterfacePragmas)
885
    , ([0],     Opt_OmitInterfacePragmas)
886

Ian Lynagh's avatar
Ian Lynagh committed
887
    , ([1,2],   Opt_IgnoreAsserts)
888
889
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
890
891
892
893
894
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
895
896
    , ([1,2],   Opt_Specialise)
    , ([1,2],   Opt_FloatIn)
897

Ian Lynagh's avatar
Ian Lynagh committed
898
899
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
900
901
902
903
904
905
906
907
908
909

--     , ([2],     Opt_StaticArgumentTransformation)
-- Max writes: I think it's probably best not to enable SAT with -O2 for the
-- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
-- several improvements to the heuristics, and I'm concerned that without
-- those changes SAT will interfere with some attempts to write "high
-- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
-- this year. In particular, the version in HEAD lacks the tail call
-- criterion, so many things that look like reasonable loops will be
-- turned into functions with extra (unneccesary) thunk creation.
910
911

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
912
913
914
915
                -- This one is important for a tiresome reason:
                -- we want to make sure that the bindings for data
                -- constructors are eta-expanded.  This is probably
                -- a good thing anyway, but it seems fragile.
916
917
918
919
920
    ]

-- -----------------------------------------------------------------------------
-- Standard sets of warning options

twanvl's avatar
twanvl committed
921
standardWarnings :: [DynFlag]
922
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
923
    = [ Opt_WarnWarningsDeprecations,
924
        Opt_WarnDeprecatedFlags,
925
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
926
927
928
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
929
        Opt_WarnDuplicateExports,
930
        Opt_WarnLazyUnliftedBindings,
931
932
        Opt_WarnDodgyForeignImports,
        Opt_WarnWrongDoBind
933
934
      ]

twanvl's avatar
twanvl committed
935
minusWOpts :: [DynFlag]
936
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
937
938
939
940
941
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
942
        Opt_WarnDodgyExports,
Ian Lynagh's avatar
Ian Lynagh committed
943
        Opt_WarnDodgyImports
944
945
      ]

twanvl's avatar
twanvl committed
946
minusWallOpts :: [DynFlag]
947
948
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
949
950
951
952
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,