DynFlags.hs 93.9 KB
Newer Older
1
2
3
{-# OPTIONS_GHC -w #-}
-- Temporary, until rtsIsProfiled is fixed

4
-- |
5
6
7
8
9
10
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

11
-- Most flags are dynamic flags, which means they can change from
12
13
14
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
17
        DynFlag(..),
18
        ExtensionFlag(..),
19
        glasgowExtsFlags,
20
21
22
23
24
25
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
26
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
28
29
30
31
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynLibLoader(..),
34
        fFlags, fLangFlags, xFlags,
35
        DPHBackend(..), dphPackageMaybe,
36
        wayNames,
37

38
39
40
41
42
        Settings(..),
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
        pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
43
44
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
45
46


47
        -- ** Manipulating DynFlags
48
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
49
50
        initDynFlags,                   -- DynFlags -> IO DynFlags

51
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
52
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
53
54
55
        updOptLevel,
        setTmpDir,
        setPackageName,
56
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
57

58
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
59
        parseDynamicFlags,
60
        parseDynamicNoPackageFlags,
61
        allFlags,
62

63
        supportedLanguagesAndExtensions,
64
65

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
66
        machdepCCOpts, picCCOpts,
67
68
69
70
71
72

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

        -- * Compiler configuration suitable for display to the user
73
74
75
76
77
78
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
79
80
81
82
  ) where

#include "HsVersions.h"

83
#ifndef OMIT_NATIVE_CODEGEN
84
import Platform
85
#endif
86
import Module
Simon Marlow's avatar
Simon Marlow committed
87
import PackageConfig
88
import PrelNames        ( mAIN )
89
import StaticFlags
90
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
91
import DriverPhases     ( Phase(..), phaseInputExt )
92
93
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
94
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
95
import Panic
96
import Util
97
import Maybes           ( orElse )
98
import SrcLoc
99
import FastString
Simon Marlow's avatar
Simon Marlow committed
100
import Outputable
101
import Foreign.C	( CInt )
Simon Marlow's avatar
Simon Marlow committed
102
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
103

104
import System.IO.Unsafe	( unsafePerformIO )
105
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
106
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
107

108
import Data.Char
109
import Data.List
110
111
import Data.Map (Map)
import qualified Data.Map as Map
112
import Data.Maybe
Ian Lynagh's avatar
Ian Lynagh committed
113
import System.FilePath
114
import System.IO        ( stderr, hPutChar )
115

116
117
118
-- -----------------------------------------------------------------------------
-- DynFlags

119
-- | Enumerates the simple on-or-off dynamic flags
120
121
122
123
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
192
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
193
194
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
195
   | Opt_WarnImplicitPrelude
196
   | Opt_WarnIncompletePatterns
197
   | Opt_WarnIncompleteUniPatterns
198
199
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
200
   | Opt_WarnMissingImportList
201
202
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
203
   | Opt_WarnMissingLocalSigs
204
205
206
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
207
   | Opt_WarnMonomorphism
208
209
210
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
211
   | Opt_WarnWarningsDeprecations
212
   | Opt_WarnDeprecatedFlags
213
   | Opt_WarnDodgyExports
214
215
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
216
   | Opt_WarnAutoOrphans
217
   | Opt_WarnIdentities
218
   | Opt_WarnTabs
219
   | Opt_WarnUnrecognisedPragmas
220
   | Opt_WarnDodgyForeignImports
221
   | Opt_WarnLazyUnliftedBindings
222
223
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
224
   | Opt_WarnAlternativeLayoutRuleTransitional
225

226
227
   | Opt_PrintExplicitForalls

228
229
230
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
231
232
   | Opt_FloatIn
   | Opt_Specialise
233
   | Opt_StaticArgumentTransformation
234
   | Opt_CSE
235
236
   | Opt_LiberateCase
   | Opt_SpecConstr
237
238
239
240
241
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
242
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
243
   | Opt_DictsCheap
244
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
245
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
246
247
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
248

249
250
251
252
253
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
254
255
256
257
258
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

259
260
   -- misc opts
   | Opt_Pp
261
   | Opt_ForceRecomp
262
263
   | Opt_DryRun
   | Opt_ExcessPrecision
264
   | Opt_EagerBlackHoling
265
266
267
268
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
269
   | Opt_HideAllPackages
270
   | Opt_PrintBindResult
271
   | Opt_Haddock
David Waern's avatar
David Waern committed
272
   | Opt_HaddockOptions
273
   | Opt_Hpc_No_Auto
274
   | Opt_BreakOnException
275
   | Opt_BreakOnError
276
   | Opt_PrintEvldWithShow
277
   | Opt_PrintBindContents
278
279
   | Opt_GenManifest
   | Opt_EmbedManifest
280
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
281
   | Opt_SharedImplib
282
   | Opt_BuildingCabalPackage
283
   | Opt_SSE2
284
   | Opt_GhciSandbox
285
   | Opt_HelpfulErrors
286
287
288

	-- temporary flags
   | Opt_RunCPS
289
290
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
291
   | Opt_AutoLinkPackages
292
   | Opt_ImplicitImportQualified
293
   | Opt_TryNewCodeGen
294
295
296
297
298
299

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
300
   | Opt_KeepRawTokenStream
301
   | Opt_KeepLlvmFiles
302

303
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
304

305
306
data Language = Haskell98 | Haskell2010

307
data ExtensionFlag
308
309
310
311
312
313
314
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
315
   | Opt_RelaxedPolyRec		-- Deprecated
316
317
318
319
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
320
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_Generics			-- "Derivable type classes"
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
337
   | Opt_GADTSyntax
338
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
339
   | Opt_DoAndIfThenElse
340
   | Opt_RebindableSyntax
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
378
   | Opt_NondecreasingIndentation
379
   | Opt_RelaxedLayout
380
381
   deriving (Eq, Show)

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

398
399
400
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
401
402
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
403

404
#ifndef OMIT_NATIVE_CODEGEN
405
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
406
#endif
407
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
408
409
410
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
411
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
412

413
414
  dphBackend            :: DPHBackend,

415
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
416
417

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

422
423
424
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

425
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
426
  objectDir             :: Maybe String,
427
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
428
429
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
430

Ian Lynagh's avatar
Ian Lynagh committed
431
432
433
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
434

Ian Lynagh's avatar
Ian Lynagh committed
435
436
437
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
438

439
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
440
441
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
442

443
444
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
445
446
447
448
449
450
451
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

452
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
453
  rtsOptsEnabled        :: RtsOptsEnabled,
454

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

457
  settings              :: Settings,
458

459
460
461
462
463
464
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

465
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
466
  extraPkgConfs         :: [FilePath],
467
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
468
        -- they appeared.
469

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

473
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
474
  -- NB. do not modify this field, it is calculated by
475
  -- Packages.initPackages and Packages.updatePackages.
476
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
477
  pkgState              :: PackageState,
478

479
480
481
482
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
483
  dirsToClean           :: IORef (Map FilePath FilePath),
484

485
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
486
  flags                 :: [DynFlag],
487
  -- Don't change this without updating extensionFlags:
488
  language              :: Maybe Language,
489
490
491
492
493
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
494

495
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
496
497
498
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
499
500
 }

501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
data Settings = Settings {
  sGhcUsagePath          :: FilePath,    -- Filled in by SysTools
  sGhciUsagePath         :: FilePath,    -- ditto
  sTopDir                :: FilePath,
  sTmpDir                :: String,      -- no trailing '/'
  -- You shouldn't need to look things up in rawSettings directly.
  -- They should have their own fields instead.
  sRawSettings           :: [(String, String)],
  sExtraGccViaCFlags     :: [String],
  sSystemPackageConfig   :: FilePath,
  -- commands for particular phases
  sPgm_L                 :: String,
  sPgm_P                 :: (String,[Option]),
  sPgm_F                 :: String,
  sPgm_c                 :: (String,[Option]),
  sPgm_s                 :: (String,[Option]),
  sPgm_a                 :: (String,[Option]),
  sPgm_l                 :: (String,[Option]),
  sPgm_dll               :: (String,[Option]),
  sPgm_T                 :: String,
  sPgm_sysman            :: String,
  sPgm_windres           :: String,
  sPgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
524
525
526
527
528
529
530
531
532
533
534
535
536
  sPgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
  -- options for particular phases
  sOpt_L                 :: [String],
  sOpt_P                 :: [String],
  sOpt_F                 :: [String],
  sOpt_c                 :: [String],
  sOpt_m                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 }

ghcUsagePath          :: DynFlags -> FilePath
ghcUsagePath dflags = sGhcUsagePath (settings dflags)
ghciUsagePath         :: DynFlags -> FilePath
ghciUsagePath dflags = sGhciUsagePath (settings dflags)
topDir                :: DynFlags -> FilePath
topDir dflags = sTopDir (settings dflags)
tmpDir                :: DynFlags -> String
tmpDir dflags = sTmpDir (settings dflags)
rawSettings           :: DynFlags -> [(String, String)]
rawSettings dflags = sRawSettings (settings dflags)
extraGccViaCFlags     :: DynFlags -> [String]
extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
systemPackageConfig   :: DynFlags -> FilePath
systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
pgm_L                 :: DynFlags -> String
pgm_L dflags = sPgm_L (settings dflags)
pgm_P                 :: DynFlags -> (String,[Option])
pgm_P dflags = sPgm_P (settings dflags)
pgm_F                 :: DynFlags -> String
pgm_F dflags = sPgm_F (settings dflags)
pgm_c                 :: DynFlags -> (String,[Option])
pgm_c dflags = sPgm_c (settings dflags)
pgm_s                 :: DynFlags -> (String,[Option])
pgm_s dflags = sPgm_s (settings dflags)
pgm_a                 :: DynFlags -> (String,[Option])
pgm_a dflags = sPgm_a (settings dflags)
pgm_l                 :: DynFlags -> (String,[Option])
pgm_l dflags = sPgm_l (settings dflags)
pgm_dll               :: DynFlags -> (String,[Option])
pgm_dll dflags = sPgm_dll (settings dflags)
pgm_T                 :: DynFlags -> String
pgm_T dflags = sPgm_T (settings dflags)
pgm_sysman            :: DynFlags -> String
pgm_sysman dflags = sPgm_sysman (settings dflags)
pgm_windres           :: DynFlags -> String
pgm_windres dflags = sPgm_windres (settings dflags)
pgm_lo                :: DynFlags -> (String,[Option])
pgm_lo dflags = sPgm_lo (settings dflags)
pgm_lc                :: DynFlags -> (String,[Option])
pgm_lc dflags = sPgm_lc (settings dflags)
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
opt_P dflags = sOpt_P (settings dflags)
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
opt_c dflags = sOpt_c (settings dflags)
opt_m                 :: DynFlags -> [String]
opt_m dflags = sOpt_m (settings dflags)
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
opt_l dflags = sOpt_l (settings dflags)
opt_windres           :: DynFlags -> [String]
opt_windres dflags = sOpt_windres (settings dflags)
opt_lo                :: DynFlags -> [String]
opt_lo dflags = sOpt_lo (settings dflags)
opt_lc                :: DynFlags -> [String]
opt_lc dflags = sOpt_lc (settings dflags)
599

600
601
602
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

603
604
-- | The target code type of the compilation (if any).
--
605
606
607
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
608
609
610
611
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
612
613
614
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
615
--
616
617
618
619
620
621
--  * 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.)
622
--
623
data HscTarget
624
625
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
626
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
627
628
629
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
630
631
  deriving (Eq, Show)

632
-- | Will this target result in an object file on the disk?
633
634
635
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
636
isObjectTarget HscLlvm  = True
637
638
639
640
641
642
643
644
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.
645
data GhcMode
646
647
648
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
649
650
  deriving Eq

651
652
653
654
655
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

656
657
658
659
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

660
661
662
663
-- | 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
664
665
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
666
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
667
  deriving (Eq, Show)
668
669
670

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

673
674
675
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
676
677
678
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.
679

680
681
data PackageFlag
  = ExposePackage  String
682
  | ExposePackageId String
683
684
  | HidePackage    String
  | IgnorePackage  String
685
  deriving Eq
686

twanvl's avatar
twanvl committed
687
defaultHscTarget :: HscTarget
688
689
defaultHscTarget = defaultObjectTarget

690
-- | The 'HscTarget' value corresponding to the default way to create
691
-- object files on the current platform.
twanvl's avatar
twanvl committed
692
defaultObjectTarget :: HscTarget
693
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
694
695
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
696

697
698
699
700
701
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
702
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
703
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
704

705
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
706
initDynFlags :: DynFlags -> IO DynFlags
707
708
709
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
710
 refFilesToClean <- newIORef []
711
 refDirsToClean <- newIORef Map.empty
712
 return dflags{
713
714
715
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
716
717
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
718
        }
719

720
721
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
722
723
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
724
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
725
726
727
728
729
730
731
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
732
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
733
        maxSimplIterations      = 4,
734
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
735
736
737
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
738
        liberateCaseThreshold   = Just 200,
739
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
740
741
        strictnessBefore        = [],

742
#ifndef OMIT_NATIVE_CODEGEN
743
        targetPlatform          = defaultTargetPlatform,
744
#endif
Ian Lynagh's avatar
Ian Lynagh committed
745
746
747
748
749
750
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
751
        dphBackend              = DPHNone,
752

Ian Lynagh's avatar
Ian Lynagh committed
753
754
755
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
756
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
757
758
759
760
761
762
763
764
765
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
766
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
767
768
769
770
771
772
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
773
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
774
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
775
776
777
778
779

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
780
781
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
782
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
783
784
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
785
        splitInfo               = Nothing,
786
        settings                = mySettings,
787
788
789
790
791
792
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
793
794
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
795
        haddockOptions = Nothing,
796
        flags = defaultFlags,
797
        language = Nothing,
798
799
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
800

Ian Lynagh's avatar
Ian Lynagh committed
801
        log_action = \severity srcSpan style msg ->
802
                        case severity of
803
804
805
806
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
807
808
809
810
811
                                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.
812
813
      }

Ian Lynagh's avatar
Ian Lynagh committed
814
{-
815
816
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
817
    0   |   print errors & warnings only
818
819
820
821
822
823
824
    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"
-}

825
826
827
828
829
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
830
831
832
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
833
834
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
835
836
837
          defaultExtensionFlags = languageExtensions ml

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

839
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
840
    -- Nothing => the default case
841
842
843
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
844
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
845
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
846
      -- SLPJ September 2010
847
    : Opt_NondecreasingIndentation -- This has been on by default for some time
848
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
849

850
851
852
853
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
854
855
856
857
858
859
860
861
       Opt_DatatypeContexts,
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
862

863
864
865
866
867
868
869
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
870
       Opt_DoAndIfThenElse,
871
       Opt_RelaxedPolyRec]
872

873
-- | Test whether a 'DynFlag' is set
874
875
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
876

877
-- | Set a 'DynFlag'
878
879
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
880

881
-- | Unset a 'DynFlag'
882
883
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
884

885
-- | Test whether a 'ExtensionFlag' is set
886
xopt :: ExtensionFlag -> DynFlags -> Bool
887
xopt f dflags = f `elem` extensionFlags dflags
888

889
-- | Set a 'ExtensionFlag'
890
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
891
892
893
894
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
895

896
-- | Unset a 'ExtensionFlag'
897
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
898
899
900
901
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
902

903
904
905
906
907
908
909
910
setLanguage :: Language -> DynP ()
setLanguage l = upd f
    where f dfs = let mLang = Just l
                      oneoffs = extensions dfs
                  in dfs {
                         language = mLang,
                         extensionFlags = flattenExtensionFlags mLang oneoffs
                     }
911

912
913
914
915
-- | 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
916
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
917
        -- We add to the options from the front, so we need to reverse the list
918

919
920
-- | 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
921
922
923
924
getVerbFlags :: DynFlags -> [String]
getVerbFlags dflags
  | verbosity dflags >= 4 = ["-v"]
  | otherwise             = []
925

926
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
927
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
928
         setPgmP, addOptl, addOptP,
929
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
930
931
932
933
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

934
935
936
937
setObjectDir  f d = d{ objectDir  = Just f}
setHiDir      f d = d{ hiDir      = Just f}
setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
  -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
Ian Lynagh's avatar
Ian Lynagh committed
938
939
  -- \#included from the .hc file when compiling via C (i.e. unregisterised
  -- builds).
Simon Marlow's avatar
Simon Marlow committed
940
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
941
setDylibInstallName  f d = d{ dylibInstallName = Just f}
942

943
944
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
945
946
947
948
setHcSuf      f d = d{ hcSuf      = f}

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

950
951
952
953
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
954
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
955

956
957
setDumpPrefixForce f d = d { dumpPrefixForce = f}

958
959
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
960
setPgmP   f = let (pgm:args) = words f in alterSettings (\s -> s { sPgm_P   = (pgm, map Option args)})
961
962
addOptl   f = alterSettings (\s -> s { sOpt_l   = f : sOpt_l s})
addOptP   f = alterSettings (\s -> s { sOpt_P   = f : sOpt_P s})
963

964

965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
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
982
deOptDep x = case stripPrefix "-optdep" x of
983
984
985
             Just rest -> rest
             Nothing -> x

986
987
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
988
989
addHaddockOpts f d = d{ haddockOptions = Just f}

990
991
992
-- -----------------------------------------------------------------------------
-- Command-line options