DynFlags.hs 93.8 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
17
        DOpt(..),
Ian Lynagh's avatar
Ian Lynagh committed
18
        DynFlag(..),
19
        ExtensionFlag(..),
20
        glasgowExtsFlags,
21
22
        flattenExtensionFlags,
        ensureFlattenedExtensionFlags,
23
24
        lopt_set_flattened,
        lopt_unset_flattened,
Ian Lynagh's avatar
Ian Lynagh committed
25
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
26
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
28
29
30
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
31
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
32
        DynLibLoader(..),
33
        fFlags, fLangFlags, xFlags,
34
        dphPackage,
35
        wayNames,
36

37
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
38
39
40
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

41
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
42
43
44
45
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
46
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
47

48
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
49
        parseDynamicFlags,
50
        parseDynamicNoPackageFlags,
51
        allFlags,
52

53
        supportedLanguagesAndExtensions,
54
55

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
56
        machdepCCOpts, picCCOpts,
57
58
59
60
61
62

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

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

#include "HsVersions.h"

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

95
import System.IO.Unsafe	( unsafePerformIO )
96
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
97
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
98

99
import Data.Char
100
import Data.List
101
102
import Data.Map (Map)
import qualified Data.Map as Map
Ian Lynagh's avatar
Ian Lynagh committed
103
import System.FilePath
104
import System.IO        ( stderr, hPutChar )
105

106
107
108
-- -----------------------------------------------------------------------------
-- DynFlags

109
-- | Enumerates the simple on-or-off dynamic flags
110
111
112
113
data DynFlag

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

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

208
209
   | Opt_PrintExplicitForalls

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

231
232
233
234
235
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
236
237
238
239
240
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
270
271
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
272
   | Opt_AutoLinkPackages
273
   | Opt_ImplicitImportQualified
274
   | Opt_TryNewCodeGen
275
276
277
278
279
280
281

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
282
   | Opt_KeepRawTokenStream
283
   | Opt_KeepLlvmFiles
284

285
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
286

287
288
data Language = Haskell98 | Haskell2010

289
data ExtensionFlag
290
291
292
293
294
295
296
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
297
   | Opt_RelaxedPolyRec		-- Deprecated
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
   | 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
320
   | Opt_DoAndIfThenElse
321
322
323
324
325
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

   | 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)

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

377
378
379
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
380

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

391
392
  dphBackend            :: DPHBackend,

393
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
394
395

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

400
401
402
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

403
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
404
  objectDir             :: Maybe String,
405
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
406
407
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
408

Ian Lynagh's avatar
Ian Lynagh committed
409
410
411
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
412

Ian Lynagh's avatar
Ian Lynagh committed
413
414
415
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
416

417
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
418
419
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
420

421
422
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
423
424
425
426
427
428
429
430
  dumpPrefixForce       :: Maybe FilePath,

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

431
432
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
433
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
434
  rtsOptsEnabled        :: RtsOptsEnabled,
435

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

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

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

466
467
468
469
470
471
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

472
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
473
  extraPkgConfs         :: [FilePath],
474
475
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
476
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
477
        -- they appeared.
478

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

482
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
483
  -- NB. do not modify this field, it is calculated by
484
  -- Packages.initPackages and Packages.updatePackages.
485
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
486
  pkgState              :: PackageState,
487

488
489
490
491
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
492
  dirsToClean           :: IORef (Map FilePath FilePath),
493

494
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
495
  flags                 :: [DynFlag],
496
  language              :: Maybe Language,
497
498
  extensionFlags        :: Either [OnOff ExtensionFlag]
                                  [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
499

500
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
501
502
503
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
504
505
 }

506
507
508
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

557
558
559
560
561
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

562
563
564
565
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

579
580
581
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
582
583
584
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.
585

586
587
data PackageFlag
  = ExposePackage  String
588
  | ExposePackageId String
589
590
  | HidePackage    String
  | IgnorePackage  String
591
  deriving Eq
592

twanvl's avatar
twanvl committed
593
defaultHscTarget :: HscTarget
594
595
defaultHscTarget = defaultObjectTarget

596
-- | The 'HscTarget' value corresponding to the default way to create
597
-- object files on the current platform.
twanvl's avatar
twanvl committed
598
defaultObjectTarget :: HscTarget
599
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
600
601
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
602

603
604
605
606
607
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
608
609
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

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

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

646
#ifndef OMIT_NATIVE_CODEGEN
647
        targetPlatform          = defaultTargetPlatform,
648
#endif
Ian Lynagh's avatar
Ian Lynagh committed
649
650
651
652
653
654
655
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

656
657
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
658
659
660
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
661
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
662
663
664
665
666
667
668
669
670
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
671
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
672
673
674
675
676
677
678
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
679
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
680
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
681
682
683
684
685

        hpcDir                  = ".hpc",

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
751
{-
752
753
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
754
    0   |   print errors & warnings only
755
756
757
758
759
760
761
    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"
-}

762
763
764
data OnOff a = On a
             | Off a

765
766
767
flattenExtensionFlags :: DynFlags -> DynFlags
flattenExtensionFlags dflags
    = case extensionFlags dflags of
768
769
      Left onoffs ->
          dflags {
770
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
771
772
          }
      Right _ ->
773
          panic "Flattening already-flattened extension flags"
774

775
776
777
ensureFlattenedExtensionFlags :: DynFlags -> DynFlags
ensureFlattenedExtensionFlags dflags
    = case extensionFlags dflags of
778
779
      Left onoffs ->
          dflags {
780
              extensionFlags = Right $ flattenExtensionFlags' (language dflags) onoffs
781
782
783
784
785
786
          }
      Right _ ->
          dflags

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
787
788
789
flattenExtensionFlags' :: Maybe Language -> [OnOff ExtensionFlag]
                       -> [ExtensionFlag]
flattenExtensionFlags' ml = foldr f defaultExtensionFlags
790
791
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
792
793
794
795
796
797
798
          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
799
800
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
      -- SLPJ September 2010
801
802
803
804
805
806
807
808
809
810
811
812
813
    : 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
814
       Opt_DoAndIfThenElse,
815
       Opt_RelaxedPolyRec]
816

817
818
819
820
821
822
823
824
825
826
827
828
-- The DOpt class is a temporary workaround, to avoid having to do
-- a mass-renaming dopt->lopt at the moment
class DOpt a where
    dopt :: a -> DynFlags -> Bool
    dopt_set :: DynFlags -> a -> DynFlags
    dopt_unset :: DynFlags -> a -> DynFlags

instance DOpt DynFlag where
    dopt = dopt'
    dopt_set = dopt_set'
    dopt_unset = dopt_unset'

829
instance DOpt ExtensionFlag where
830
831
832
833
    dopt = lopt
    dopt_set = lopt_set
    dopt_unset = lopt_unset

834
-- | Test whether a 'DynFlag' is set
835
836
dopt' :: DynFlag -> DynFlags -> Bool
dopt' f dflags  = f `elem` (flags dflags)
837

838
-- | Set a 'DynFlag'
839
840
dopt_set' :: DynFlags -> DynFlag -> DynFlags
dopt_set' dfs f = dfs{ flags = f : flags dfs }
841

842
-- | Unset a 'DynFlag'
843
844
845
dopt_unset' :: DynFlags -> DynFlag -> DynFlags
dopt_unset' dfs f = dfs{ flags = filter (/= f) (flags dfs) }

846
847
848
849
-- | Test whether a 'ExtensionFlag' is set
lopt :: ExtensionFlag -> DynFlags -> Bool
lopt f dflags = case extensionFlags dflags of
                Left _ -> panic ("Testing for extension flag " ++ show f ++ " before flattening")
850
                Right flags -> f `elem` flags
851

852
853
854
855
856
-- | Set a 'ExtensionFlag'
lopt_set :: DynFlags -> ExtensionFlag -> DynFlags
lopt_set dfs f = case extensionFlags dfs of
                 Left onoffs -> dfs { extensionFlags = Left (On f : onoffs) }
                 Right _ -> panic ("Setting extension flag " ++ show f ++ " after flattening")
857

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

866
867
868
869
870
-- | Unset a 'ExtensionFlag'
lopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset dfs f = case extensionFlags dfs of
                   Left onoffs -> dfs { extensionFlags = Left (Off f : onoffs) }
                   Right _ -> panic ("Unsetting extension flag " ++ show f ++ " after flattening")
871

872
873
874
-- | Unset a 'ExtensionFlag'
lopt_unset_flattened :: DynFlags -> ExtensionFlag -> DynFlags
lopt_unset_flattened dfs f = case extensionFlags dfs of
875
                             Left _ ->
876
                                 panic ("Unsetting extension flag " ++ show f ++ " before flattening, but expected flattened")
877
                             Right flags ->
878
                                 dfs { extensionFlags = Right (delete f flags) }
879

880
881
882
883
-- | 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
884
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
885
        -- We add to the options from the front, so we need to reverse the list
886

887
888
-- | 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
889
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
890
891
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
892
893
  | otherwise =  ""

894
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
895
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
896
         setPgmP, addOptl, addOptP,
897
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
898
899
900
901
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

902
903
904
905
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
906
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
907
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
908
setDylibInstallName  f d = d{ dylibInstallName = Just f}
909

910
911
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
912
913
914
915
setHcSuf      f d = d{ hcSuf      = f}

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

917
918
919
920
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
921
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
922

923
924
setDumpPrefixForce f d = d { dumpPrefixForce = f}

925
926
927
928
-- 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}
929
930
addOptP   f d = d{ opt_P   = f : opt_P d}

931

932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
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
949
deOptDep x = case stripPrefix "-optdep" x of
950
951
952
             Just rest -> rest
             Nothing -> x

953
954
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
955
956
addHaddockOpts f d = d{ haddockOptions = Just f}

957
958
959
-- -----------------------------------------------------------------------------
-- Command-line options

960
-- | When invoking external tools as part of the compilation pipeline, we
961
962
-- 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
963
-- between filepaths and 'other stuff'. The reason for this is that
964
-- this type gives us a handle on transforming filenames, and filenames only,
965
-- to whatever format they're expected to be on a particular platform.
966
967
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
968
969
970
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
971
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
972

Ian Lynagh's avatar
Ian Lynagh committed
973
974
975
976
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

977
978
979
980
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
981
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
982
updOptLevel n dfs
983
  = dfs2{ optLevel = final_n }
984
  where
Ian Lynagh's avatar
Ian Lynagh committed
985
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
986
987
988
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

989