DynFlags.hs 88.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
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
187
   | Opt_WarnAlternativeLayoutRuleTransitional
188

189
190

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

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

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

258
259
   | Opt_PrintExplicitForalls

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

281
282
283
284
285
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

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

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

	-- temporary flags
   | Opt_RunCPS
322
323
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
324
   | Opt_AutoLinkPackages
325
   | Opt_ImplicitImportQualified
326
   | Opt_TryNewCodeGen
327
328
329
330
331
332
333

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
334
   | Opt_KeepRawTokenStream
335

336
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
337

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

354
355
356
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
357

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

368
369
  dphBackend            :: DPHBackend,

370
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
371
372

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

377
378
379
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

380
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
381
  objectDir             :: Maybe String,
382
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
383
384
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
385

Ian Lynagh's avatar
Ian Lynagh committed
386
387
388
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
389

Ian Lynagh's avatar
Ian Lynagh committed
390
391
392
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
393

394
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
395
396
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
397

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

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

408
409
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
410
  rtsOpts               :: Maybe String,
411

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

414
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
415
416
417
418
419
420
421
422
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
423
424

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
425
426
427
428
429
430
431
432
433
  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]),
434
435
  pgm_T                 :: String,
  pgm_sysman            :: String,
436
  pgm_windres           :: String,
437

438
439
440
441
442
443
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

444
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
445
  extraPkgConfs         :: [FilePath],
446
447
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
448
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
449
        -- they appeared.
450

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

454
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
455
  -- NB. do not modify this field, it is calculated by
456
  -- Packages.initPackages and Packages.updatePackages.
457
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
458
  pkgState              :: PackageState,
459

460
461
462
463
464
465
  -- 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),

466
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
467
468
  flags                 :: [DynFlag],

469
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
470
471
472
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
473
474
 }

475
476
477
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

478
479
-- | The target code type of the compilation (if any).
--
480
481
482
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
483
484
485
486
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
487
488
489
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
490
--
491
492
493
494
495
496
--  * 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.)
497
--
498
data HscTarget
499
500
501
502
503
  = 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.
504
505
  deriving (Eq, Show)

506
-- | Will this target result in an object file on the disk?
507
508
509
510
511
512
513
514
515
516
517
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.
518
data GhcMode
519
520
521
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
522
523
  deriving Eq

524
525
526
527
528
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

529
530
531
532
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

546
547
548
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
549
550
551
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.
552

553
554
data PackageFlag
  = ExposePackage  String
555
  | ExposePackageId String
556
557
  | HidePackage    String
  | IgnorePackage  String
558
  deriving Eq
559

twanvl's avatar
twanvl committed
560
defaultHscTarget :: HscTarget
561
562
defaultHscTarget = defaultObjectTarget

563
-- | The 'HscTarget' value corresponding to the default way to create
564
-- object files on the current platform.
twanvl's avatar
twanvl committed
565
defaultObjectTarget :: HscTarget
566
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
567
568
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
569

570
571
572
573
574
575
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

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

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

612
#ifndef OMIT_NATIVE_CODEGEN
613
        targetPlatform          = defaultTargetPlatform,
614
#endif
Ian Lynagh's avatar
Ian Lynagh committed
615
616
617
618
619
620
621
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

622
623
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
624
625
626
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
627
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
628
629
630
631
632
633
634
635
636
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
637
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
638
639
640
641
642
643
644
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
645
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
646
647
648
649
650

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
651
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
652
653
654
655
656
657
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
658
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
659
660
661

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

707
708
            Opt_MethodSharing,

709
710
            Opt_DoAsmMangling,

Ian Lynagh's avatar
Ian Lynagh committed
711
712
            Opt_SharedImplib,

713
            Opt_GenManifest,
714
715
            Opt_EmbedManifest,
            Opt_PrintBindContents
716
717
718
719
720
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
721
        log_action = \severity srcSpan style msg ->
722
                        case severity of
723
724
725
726
727
728
729
730
                          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.
731
732
      }

Ian Lynagh's avatar
Ian Lynagh committed
733
{-
734
735
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
736
    0   |   print errors & warnings only
737
738
739
740
741
742
743
    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"
-}

744
-- | Test whether a 'DynFlag' is set
745
746
747
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

748
-- | Set a 'DynFlag'
749
750
751
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

752
-- | Unset a 'DynFlag'
753
754
755
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

756
757
758
759
-- | 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
760
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
761
        -- We add to the options from the front, so we need to reverse the list
762

763
764
-- | 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
765
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
766
767
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
768
769
  | otherwise =  ""

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

779
780
781
782
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
783
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
784
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
785
setDylibInstallName  f d = d{ dylibInstallName = Just f}
786

787
788
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
789
790
791
792
setHcSuf      f d = d{ hcSuf      = f}

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

794
795
796
797
798
799
800
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) }
801
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
802

803
804
setDumpPrefixForce f d = d { dumpPrefixForce = f}

805
806
807
808
809
810
811
812
813
814
815
816
-- 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,[])}
817
setPgmwindres f d = d{ pgm_windres = f}
818
819
820
821
822
823
824
825

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}
826
addOptwindres f d = d{ opt_windres = f : opt_windres d}
827

828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
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
845
deOptDep x = case stripPrefix "-optdep" x of
846
847
848
             Just rest -> rest
             Nothing -> x

849
850
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
851
852
addHaddockOpts f d = d{ haddockOptions = Just f}

853
854
855
-- -----------------------------------------------------------------------------
-- Command-line options

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

Ian Lynagh's avatar
Ian Lynagh committed
869
870
871
872
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

873
874
875
876
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
877
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
878
updOptLevel n dfs
879
  = dfs2{ optLevel = final_n }
880
  where
Ian Lynagh's avatar
Ian Lynagh committed
881
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
882
883
884
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

885
886
   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
887

888
889
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
890
  = [ ([0],     Opt_IgnoreInterfacePragmas)
891
    , ([0],     Opt_OmitInterfacePragmas)
892

Ian Lynagh's avatar
Ian Lynagh committed
893
    , ([1,2],   Opt_IgnoreAsserts)
894
895
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
896
897
898
899
900
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
901
902
    , ([1,2],   Opt_Specialise)
    , ([1,2],   Opt_FloatIn)
903

Ian Lynagh's avatar
Ian Lynagh committed
904
905
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
906
907
908
909
910
911
912
913
914
915

--     , ([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.
916
917

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
918
919
920
921
                -- 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.
922
923
924
925
926
    ]

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

twanvl's avatar
twanvl committed
927
standardWarnings :: [DynFlag]
928
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
929
    = [ Opt_WarnWarningsDeprecations,
930
        Opt_WarnDeprecatedFlags,
931
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
932
933
934
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
935
        Opt_WarnDuplicateExports,
936
        Opt_WarnLazyUnliftedBindings,
937
        Opt_WarnDodgyForeignImports,
938
939
        Opt_WarnWrongDoBind,
        Opt_WarnAlternativeLayoutRuleTransitional
940
941
      ]