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

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

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

42
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
43
44
45
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

46
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
47
48
49
50
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
51
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
52

53
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
54
        parseDynamicFlags,
55
        parseDynamicNoPackageFlags,
56
        allFlags,
57

58
        supportedLanguagesAndExtensions,
59
60

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
61
        machdepCCOpts, picCCOpts,
62
63
64
65
66
67

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

        -- * Compiler configuration suitable for display to the user
68
        Printable(..),
69
70
71
72
73
74
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
75
76
77
78
  ) where

#include "HsVersions.h"

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

100
import System.IO.Unsafe	( unsafePerformIO )
101
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
102
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
103

104
import Data.Char
105
import Data.List
106
107
import Data.Map (Map)
import qualified Data.Map as Map
Ian Lynagh's avatar
Ian Lynagh committed
108
import System.FilePath
109
import System.IO        ( stderr, hPutChar )
110

111
112
113
-- -----------------------------------------------------------------------------
-- DynFlags

114
-- | Enumerates the simple on-or-off dynamic flags
115
116
117
118
data DynFlag

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

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

213
214
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

290
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
291

292
293
data Language = Haskell98 | Haskell2010

294
data ExtensionFlag
295
296
297
298
299
300
301
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
302
   | Opt_RelaxedPolyRec		-- Deprecated
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | 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
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
325
   | Opt_DoAndIfThenElse
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365

   | 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_NewQualifiedOperators
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
   deriving (Eq, Show)

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

382
383
384
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
385

386
#ifndef OMIT_NATIVE_CODEGEN
387
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
388
#endif
Ian Lynagh's avatar
Ian Lynagh committed
389
  stolen_x86_regs       :: Int,
390
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
391
392
393
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
394
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
395

396
397
  dphBackend            :: DPHBackend,

398
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
399
400

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

405
406
407
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

408
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
409
  objectDir             :: Maybe String,
410
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
411
412
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
413

Ian Lynagh's avatar
Ian Lynagh committed
414
415
416
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
417

Ian Lynagh's avatar
Ian Lynagh committed
418
419
420
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
421

422
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
423
424
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
425

426
427
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
428
429
430
431
432
433
434
435
  dumpPrefixForce       :: Maybe FilePath,

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

436
437
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
438
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
439
  rtsOptsEnabled        :: RtsOptsEnabled,
440

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

443
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
444
445
446
447
448
449
450
451
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
452
453
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
454
455

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
456
457
458
459
460
461
462
463
464
  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]),
465
466
  pgm_T                 :: String,
  pgm_sysman            :: String,
467
  pgm_windres           :: String,
468
469
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
470

471
472
473
474
475
476
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

477
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
478
  extraPkgConfs         :: [FilePath],
479
480
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
481
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
482
        -- they appeared.
483

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

487
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
488
  -- NB. do not modify this field, it is calculated by
489
  -- Packages.initPackages and Packages.updatePackages.
490
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
491
  pkgState              :: PackageState,
492

493
494
495
496
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
497
  dirsToClean           :: IORef (Map FilePath FilePath),
498

499
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
500
  flags                 :: [DynFlag],
501
  language              :: Maybe Language,
502
503
  extensionFlags        :: Either [OnOff ExtensionFlag]
                                  [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
504

505
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
506
507
508
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
509
510
 }

511
512
513
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

543
-- | Will this target result in an object file on the disk?
544
545
546
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
547
isObjectTarget HscLlvm  = True
548
549
550
551
552
553
554
555
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.
556
data GhcMode
557
558
559
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
560
561
  deriving Eq

562
563
564
565
566
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

567
568
569
570
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

571
572
573
574
-- | 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
575
576
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
577
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
578
  deriving (Eq, Show)
579
580
581

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

584
585
586
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
587
588
589
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.
590

591
592
data PackageFlag
  = ExposePackage  String
593
  | ExposePackageId String
594
595
  | HidePackage    String
  | IgnorePackage  String
596
  deriving Eq
597

twanvl's avatar
twanvl committed
598
defaultHscTarget :: HscTarget
599
600
defaultHscTarget = defaultObjectTarget

601
-- | The 'HscTarget' value corresponding to the default way to create
602
-- object files on the current platform.
twanvl's avatar
twanvl committed
603
defaultObjectTarget :: HscTarget
604
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
605
606
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
607

608
609
610
611
612
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
613
614
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

615
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
616
initDynFlags :: DynFlags -> IO DynFlags
617
618
619
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
620
 refFilesToClean <- newIORef []
621
 refDirsToClean <- newIORef Map.empty
622
 return dflags{
623
624
625
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
626
627
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
628
        }
629

630
631
-- | 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
632
defaultDynFlags :: DynFlags
633
634
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
635
636
637
638
639
640
641
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
642
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
643
        maxSimplIterations      = 4,
644
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
645
646
647
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
648
        liberateCaseThreshold   = Just 200,
649
650
        strictnessBefore        = [],

651
#ifndef OMIT_NATIVE_CODEGEN
652
        targetPlatform          = defaultTargetPlatform,
653
#endif
Ian Lynagh's avatar
Ian Lynagh committed
654
655
656
657
658
659
660
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

661
662
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
663
664
665
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
666
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
667
668
669
670
671
672
673
674
675
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
676
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
677
678
679
680
681
682
683
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
684
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
685
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
686
687
688
689
690

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
691
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
692
693
694
695
696
697
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
698
        opt_windres             = [],
699
700
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
701
702
703

        extraPkgConfs           = [],
        packageFlags            = [],
704
705
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
706
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
707
708
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
709
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
710
711
712
713
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
714
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
715
716
717
718
719
720
721
722
723
724
725
726
        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",
727
728
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
729
        -- end of initSysTools values
730
731
732
733
734
735
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
736
737
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
738
        haddockOptions = Nothing,
739
        flags = defaultFlags,
740
        language = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
741
        extensionFlags = Left [],
742

Ian Lynagh's avatar
Ian Lynagh committed
743
        log_action = \severity srcSpan style msg ->
744
                        case severity of
745
746
747
748
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
749
750
751
752
753
                                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.
754
755
      }

Ian Lynagh's avatar
Ian Lynagh committed
756
{-
757
758
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
759
    0   |   print errors & warnings only
760
761
762
763
764
765
766
    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"
-}

767
768
769
data OnOff a = On a
             | Off a

770
771
772
flattenExtensionFlags :: DynFlags -> DynFlags
flattenExtensionFlags dflags
    = case extensionFlags dflags of
773
774
      Left onoffs ->
          dflags {
775
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
776
777
          }
      Right _ ->
778
          panic "Flattening already-flattened extension flags"
779

780
781
782
ensureFlattenedExtensionFlags :: DynFlags -> DynFlags
ensureFlattenedExtensionFlags dflags
    = case extensionFlags dflags of
783
784
      Left onoffs ->
          dflags {
785
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
786
787
788
789
790
791
          }
      Right _ ->
          dflags

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
792
793
794
flattenExtensionFlags' :: Maybe Language -> [OnOff ExtensionFlag]
                       -> [ExtensionFlag]
flattenExtensionFlags' ml = foldr f defaultExtensionFlags
795
796
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
797
798
799
800
801
802
803
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
languageExtensions Nothing
    = 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
804
805
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
      -- SLPJ September 2010
806
807
808
809
810
811
812
813
814
815
816
817
818
    : languageExtensions (Just Haskell2010)
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
       Opt_DatatypeContexts]
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
819
       Opt_DoAndIfThenElse,
820
       Opt_RelaxedPolyRec]
821

822
-- | Test whether a 'DynFlag' is set
823
824
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
825

826
-- | Set a 'DynFlag'
827
828
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
829

830
-- | Unset a 'DynFlag'
831
832
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
833

834
-- | Test whether a 'ExtensionFlag' is set
835
836
xopt :: ExtensionFlag -> DynFlags -> Bool
xopt f dflags = case extensionFlags dflags of
837
                Left _ -> panic ("Testing for extension flag " ++ show f ++ " before flattening")
838
                Right flags -> f `elem` flags
839

840
-- | Set a 'ExtensionFlag'
841
842
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
xopt_set dfs f = case extensionFlags dfs of
843
844
                 Left onoffs -> dfs { extensionFlags = Left (On f : onoffs) }
                 Right _ -> panic ("Setting extension flag " ++ show f ++ " after flattening")
845

846
-- | Set a 'ExtensionFlag'
847
848
xopt_set_flattened :: DynFlags -> ExtensionFlag -> DynFlags
xopt_set_flattened dfs f = case extensionFlags dfs of
849
                           Left _ ->
850
                               panic ("Setting extension flag " ++ show f ++ " before flattening, but expected flattened")
851
                           Right flags ->
852
                               dfs { extensionFlags = Right (f : delete f flags) }
853

854
-- | Unset a 'ExtensionFlag'
855
856
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
xopt_unset dfs f = case extensionFlags dfs of
857
858
                   Left onoffs -> dfs { extensionFlags = Left (Off f : onoffs) }
                   Right _ -> panic ("Unsetting extension flag " ++ show f ++ " after flattening")
859

860
-- | Unset a 'ExtensionFlag'
861
862
xopt_unset_flattened :: DynFlags -> ExtensionFlag -> DynFlags
xopt_unset_flattened dfs f = case extensionFlags dfs of
863
                             Left _ ->
864
                                 panic ("Unsetting extension flag " ++ show f ++ " before flattening, but expected flattened")
865
                             Right flags ->
866
                                 dfs { extensionFlags = Right (delete f flags) }
867

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

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

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

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

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

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

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

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

913
914
915
916
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}
addOptl   f d = d{ opt_l   = f : opt_l d}
917
918
addOptP   f d = d{ opt_P   = f : opt_P d}

919

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

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

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

945
946
947
-- -----------------------------------------------------------------------------
-- Command-line options

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

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

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

updOptLevel :: Int -> DynFlags -> DynFlags
969
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
970
updOptLevel n dfs
971
  = dfs2{ optLevel = final_n }