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
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,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
35
        DPHBackend(..), dphPackage,
36
        wayNames,
37

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

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

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

54
        supportedLanguagesAndExtensions,
55
56

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

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

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

#include "HsVersions.h"

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

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

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

107
108
109
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

212
213
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

293
294
data Language = Haskell98 | Haskell2010

295
data ExtensionFlag
296
297
298
299
300
301
302
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
303
   | Opt_RelaxedPolyRec		-- Deprecated
304
305
306
307
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
308
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
   | 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
325
   | Opt_GADTSyntax
326
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
327
   | Opt_DoAndIfThenElse
328
   | Opt_RebindableSyntax
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_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
366
   | Opt_NondecreasingIndentation
367
   | Opt_RelaxedLayout
368
369
   deriving (Eq, Show)

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

386
387
388
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
389
390
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
391

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

402
403
  dphBackend            :: DPHBackend,

404
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
405
406

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

411
412
413
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

414
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
415
  objectDir             :: Maybe String,
416
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
417
418
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
419

Ian Lynagh's avatar
Ian Lynagh committed
420
421
422
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
423

Ian Lynagh's avatar
Ian Lynagh committed
424
425
426
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
427

428
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
429
430
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
431

432
433
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
434
435
436
437
438
439
440
441
  dumpPrefixForce       :: Maybe FilePath,

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

442
443
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
444
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
445
  rtsOptsEnabled        :: RtsOptsEnabled,
446

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

449
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
450
451
452
453
454
455
456
457
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
458
459
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
460
461

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
462
463
464
465
466
467
468
469
470
  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]),
471
472
  pgm_T                 :: String,
  pgm_sysman            :: String,
473
  pgm_windres           :: String,
474
475
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
476

477
478
479
480
481
482
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

483
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
484
  extraPkgConfs         :: [FilePath],
485
486
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
487
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
488
        -- they appeared.
489

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

493
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
494
  -- NB. do not modify this field, it is calculated by
495
  -- Packages.initPackages and Packages.updatePackages.
496
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
497
  pkgState              :: PackageState,
498

499
500
501
502
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
503
  dirsToClean           :: IORef (Map FilePath FilePath),
504

505
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
506
  flags                 :: [DynFlag],
507
  -- Don't change this without updating extensionFlags:
508
  language              :: Maybe Language,
509
510
511
512
513
  -- 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
514

515
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
516
517
518
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
519
520
 }

521
522
523
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

553
-- | Will this target result in an object file on the disk?
554
555
556
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
557
isObjectTarget HscLlvm  = True
558
559
560
561
562
563
564
565
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.
566
data GhcMode
567
568
569
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
570
571
  deriving Eq

572
573
574
575
576
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

577
578
579
580
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

581
582
583
584
-- | 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
585
586
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
587
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
588
  deriving (Eq, Show)
589
590
591

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

594
595
596
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
597
598
599
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.
600

601
602
data PackageFlag
  = ExposePackage  String
603
  | ExposePackageId String
604
605
  | HidePackage    String
  | IgnorePackage  String
606
  deriving Eq
607

twanvl's avatar
twanvl committed
608
defaultHscTarget :: HscTarget
609
610
defaultHscTarget = defaultObjectTarget

611
-- | The 'HscTarget' value corresponding to the default way to create
612
-- object files on the current platform.
twanvl's avatar
twanvl committed
613
defaultObjectTarget :: HscTarget
614
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
615
616
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
617

618
619
620
621
622
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
623
624
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

625
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
626
initDynFlags :: DynFlags -> IO DynFlags
627
628
629
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
630
 refFilesToClean <- newIORef []
631
 refDirsToClean <- newIORef Map.empty
632
 return dflags{
633
634
635
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
636
637
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
638
        }
639

640
641
-- | 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
642
defaultDynFlags :: DynFlags
643
644
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
645
646
647
648
649
650
651
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
652
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
653
        maxSimplIterations      = 4,
654
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
655
656
657
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
658
        liberateCaseThreshold   = Just 200,
659
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
660
661
        strictnessBefore        = [],

662
#ifndef OMIT_NATIVE_CODEGEN
663
        targetPlatform          = defaultTargetPlatform,
664
#endif
Ian Lynagh's avatar
Ian Lynagh committed
665
666
667
668
669
670
671
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
672
        dphBackend              = DPHNone,
673

Ian Lynagh's avatar
Ian Lynagh committed
674
675
676
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
677
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
678
679
680
681
682
683
684
685
686
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
687
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
688
689
690
691
692
693
694
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
695
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
696
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
697
698
699
700
701

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
702
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
703
704
705
706
707
708
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
709
        opt_windres             = [],
710
711
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
712
713
714

        extraPkgConfs           = [],
        packageFlags            = [],
715
716
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
717
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
718
719
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
720
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
721
722
723
724
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
725
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
726
727
728
729
730
731
732
733
734
735
736
737
        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",
738
739
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
740
        -- end of initSysTools values
741
742
743
744
745
746
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
747
748
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
749
        haddockOptions = Nothing,
750
        flags = defaultFlags,
751
        language = Nothing,
752
753
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
754

Ian Lynagh's avatar
Ian Lynagh committed
755
        log_action = \severity srcSpan style msg ->
756
                        case severity of
757
758
759
760
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
761
762
763
764
765
                                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.
766
767
      }

Ian Lynagh's avatar
Ian Lynagh committed
768
{-
769
770
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
771
    0   |   print errors & warnings only
772
773
774
775
776
777
778
    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"
-}

779
780
781
782
783
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
784
785
786
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
787
788
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
789
790
791
          defaultExtensionFlags = languageExtensions ml

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

793
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
794
    -- Nothing => the default case
795
796
797
    = 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
798
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
799
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
800
      -- SLPJ September 2010
801
    : Opt_NondecreasingIndentation -- This has been on by default for some time
802
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
803

804
805
806
807
808
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
       Opt_DatatypeContexts]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
809

810
811
812
813
814
815
816
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
817
       Opt_DoAndIfThenElse,
818
       Opt_RelaxedPolyRec]
819

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

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

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

832
-- | Test whether a 'ExtensionFlag' is set
833
xopt :: ExtensionFlag -> DynFlags -> Bool
834
xopt f dflags = f `elem` extensionFlags dflags
835

836
-- | Set a 'ExtensionFlag'
837
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
838
839
840
841
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
842

843
-- | Unset a 'ExtensionFlag'
844
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
845
846
847
848
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
849

850
851
852
853
854
855
856
857
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
                     }
858

859
860
861
862
-- | 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
863
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
864
        -- We add to the options from the front, so we need to reverse the list
865

866
867
-- | 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
868
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
869
870
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
871
872
  | otherwise =  ""

873
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
874
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
875
         setPgmP, addOptl, addOptP,
876
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
877
878
879
880
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

881
882
883
884
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
885
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
886
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
887
setDylibInstallName  f d = d{ dylibInstallName = Just f}
888

889
890
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
891
892
893
894
setHcSuf      f d = d{ hcSuf      = f}

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

896
897
898
899
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
900
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
901

902
903
setDumpPrefixForce f d = d { dumpPrefixForce = f}

904
905
906
907
-- 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}
908
909
addOptP   f d = d{ opt_P   = f : opt_P d}

910

911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
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
928
deOptDep x = case stripPrefix "-optdep" x of
929
930
931
             Just rest -> rest
             Nothing -> x

932
933
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
934
935
addHaddockOpts f d = d{ haddockOptions = Just f}

936
937
938
-- -----------------------------------------------------------------------------
-- Command-line options

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

Ian Lynagh's avatar
Ian Lynagh committed
952
953
954
955
showOpt :: Option -> String
showOpt (FileOption pre f) = pre ++ f
showOpt (Option s)  = s

956
957
958
959
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
960
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
961
updOptLevel n dfs
962
  = dfs2{ optLevel = final_n }
963
  where