DynFlags.hs 87.3 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
   | Opt_SSE2
316
317
318

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

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

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

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

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

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

365
366
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

456
457
458
459
460
461
  -- 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),

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

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

  haddockOptions :: Maybe String
469
470
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

618
619
        dphBackend              = DPHPar,

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

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

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

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

        hpcDir                  = ".hpc",

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

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

702
703
            Opt_MethodSharing,

704
705
            Opt_DoAsmMangling,

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

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

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

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

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

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

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

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

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

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

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

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

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

789
790
791
792
793
794
795
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) }
796
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
797

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

800
801
802
803
804
805
806
807
808
809
810
811
-- 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,[])}
812
setPgmwindres f d = d{ pgm_windres = f}
813
814
815
816
817
818
819
820

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

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

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

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

848
849
850
-- -----------------------------------------------------------------------------
-- Command-line options

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

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

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

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

880
881
   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
882

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

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

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

--     , ([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.
911
912

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
913
914
915
916
                -- 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.
917
918
919
920
921
    ]

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

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

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

twanvl's avatar
twanvl committed
947
minusWallOpts :: [DynFlag]
948
949
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
950
951
952