DynFlags.hs 75.8 KB
Newer Older
1

2
3
4
5
6
7
8
9
10
11
12
13
14
15
-----------------------------------------------------------------------------
--
-- Dynamic flags
--
-- Most flags are dynamic flags, which means they can change from
-- 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.
--
-- (c) The University of Glasgow 2005
--
-----------------------------------------------------------------------------

module DynFlags (
Ian Lynagh's avatar
Ian Lynagh committed
16
17
18
19
20
21
22
23
24
        -- Dynamic flags
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
25
        fFlags, xFlags,
26

Ian Lynagh's avatar
Ian Lynagh committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
        -- Configuration of the core-to-core and stg-to-stg phases
        CoreToDo(..),
        StgToDo(..),
        SimplifierSwitch(..),
        SimplifierMode(..), FloatOutSwitches(..),
        getCoreToDo, getStgToDo,

        -- Manipulating DynFlags
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

        dopt,                           -- DynFlag -> DynFlags -> Bool
        dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
        getOpts,                        -- (DynFlags -> [a]) -> IO [a]
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,

        -- parsing DynFlags
        parseDynamicFlags,
48
        allFlags,
49

Ian Lynagh's avatar
Ian Lynagh committed
50
51
        -- misc stuff
        machdepCCOpts, picCCOpts,
Ian Lynagh's avatar
Ian Lynagh committed
52
    supportedLanguages,
53
    compilerInfo,
54
55
56
57
  ) where

#include "HsVersions.h"

58
import Module
Simon Marlow's avatar
Simon Marlow committed
59
import PackageConfig
Ian Lynagh's avatar
Ian Lynagh committed
60
import PrelNames        ( mAIN )
Simon Marlow's avatar
Simon Marlow committed
61
#ifdef i386_TARGET_ARCH
Ian Lynagh's avatar
Ian Lynagh committed
62
import StaticFlags      ( opt_Static )
Simon Marlow's avatar
Simon Marlow committed
63
#endif
Ian Lynagh's avatar
Ian Lynagh committed
64
65
import StaticFlags      ( opt_PIC, WayName(..), v_Ways, v_Build_tag,
                          v_RTS_Build_tag )
66
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
67
import DriverPhases     ( Phase(..), phaseInputExt )
68
69
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
70
71
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
import Panic            ( panic, GhcException(..) )
72
import UniqFM           ( UniqFM )
73
import Util
Ian Lynagh's avatar
Ian Lynagh committed
74
import Maybes           ( orElse, fromJust )
75
import SrcLoc           ( SrcSpan )
Simon Marlow's avatar
Simon Marlow committed
76
77
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
78

Ian Lynagh's avatar
Ian Lynagh committed
79
import Data.IORef       ( readIORef )
Simon Marlow's avatar
Simon Marlow committed
80
import Control.Exception ( throwDyn )
Ian Lynagh's avatar
Ian Lynagh committed
81
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
82

83
import Data.Char
Ian Lynagh's avatar
Ian Lynagh committed
84
import System.FilePath
85
86
import System.IO        ( hPutStrLn, stderr )

87
88
89
90
91
92
93
-- -----------------------------------------------------------------------------
-- DynFlags

data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
94
   | Opt_D_dump_cmmz
95
   | Opt_D_dump_cmmz_pretty
96
   | Opt_D_dump_cps_cmm
97
   | Opt_D_dump_cvt_cmm
98
   | Opt_D_dump_asm
99
100
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
101
   | Opt_D_dump_asm_coalesce
102
103
104
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
105
   | Opt_D_dump_asm_stats
106
107
108
109
110
111
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
112
   | Opt_D_dump_rule_firings
113
114
115
116
117
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
118
   | Opt_D_dump_simpl_phases
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
   | 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
137
   | Opt_D_dump_hpc
138
139
140
141
142
143
   | 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
144
   | Opt_D_dump_mod_cycles
145
   | Opt_D_dump_view_pattern_commoning
146
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
147
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
148
   | Opt_D_no_debug_output
149
150
151
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
152
   | Opt_DoAsmLinting
153

Ian Lynagh's avatar
Ian Lynagh committed
154
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
155
156
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
157
   | Opt_WarnImplicitPrelude
158
159
160
161
162
163
164
165
166
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
167
   | Opt_WarnMonomorphism
168
169
170
171
172
173
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnDeprecations
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
174
   | Opt_WarnTabs
175
176

   -- language opts
177
178
179
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
180
   | Opt_MonomorphismRestriction
181
   | Opt_MonoPatBinds
Ian Lynagh's avatar
Ian Lynagh committed
182
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
183
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
184
   | Opt_UnliftedFFITypes
Ian Lynagh's avatar
Ian Lynagh committed
185
186
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
187
   | Opt_TemplateHaskell
188
   | Opt_QuasiQuotes
189
190
   | Opt_ImplicitParams
   | Opt_Generics
Ian Lynagh's avatar
Ian Lynagh committed
191
   | Opt_ImplicitPrelude
192
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
193
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
194
   | Opt_BangPatterns
195
   | Opt_TypeFamilies
196
   | Opt_OverloadedStrings
197
   | Opt_DisambiguateRecordFields
198
   | Opt_RecordWildCards
199
   | Opt_RecordPuns
200
   | Opt_ViewPatterns
201
   | Opt_GADTs
202
   | Opt_RelaxedPolyRec
203
   | Opt_StandaloneDeriving
204
   | Opt_DeriveDataTypeable
205
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
206
   | Opt_FlexibleContexts
207
   | Opt_FlexibleInstances
208
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
209
   | Opt_MultiParamTypeClasses
210
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
211
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
212
   | Opt_PolymorphicComponents
213
   | Opt_ExistentialQuantification
214
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
215
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
216
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
217
   | Opt_PatternSignatures
Ian Lynagh's avatar
Ian Lynagh committed
218
   | Opt_ParallelListComp
219
   | Opt_TransformListComp
220
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
221
   | Opt_RecursiveDo
Ian Lynagh's avatar
Ian Lynagh committed
222
   | Opt_PatternGuards
223
   | Opt_LiberalTypeSynonyms
224
225
   | Opt_Rank2Types
   | Opt_RankNTypes
226
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
227
   | Opt_TypeOperators
228

229
230
   | Opt_PrintExplicitForalls

231
232
233
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
234
   | Opt_StaticArgumentTransformation
235
   | Opt_CSE
236
237
   | Opt_LiberateCase
   | Opt_SpecConstr
238
239
240
241
242
243
244
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
245
   | Opt_MethodSharing
246
   | Opt_DictsCheap
247
   | Opt_RewriteRules
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
248
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
249
250
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
251
252
253
254

   -- misc opts
   | Opt_Cpp
   | Opt_Pp
255
   | Opt_ForceRecomp
256
257
258
259
260
261
262
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
263
   | Opt_HideAllPackages
264
   | Opt_PrintBindResult
265
   | Opt_Haddock
David Waern's avatar
David Waern committed
266
   | Opt_HaddockOptions
267
   | Opt_Hpc_No_Auto
268
   | Opt_BreakOnException
269
   | Opt_BreakOnError
270
   | Opt_PrintEvldWithShow
271
   | Opt_PrintBindContents
272
273
   | Opt_GenManifest
   | Opt_EmbedManifest
274
275
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
276
277
278
279
280
281
282
283

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles

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

286
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
287
288
289
290
291
292
293
294
295
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
  hscOutName            :: String,      -- name of the output file
  extCoreName           :: String,      -- name of the .core output file
  verbosity             :: Int,         -- verbosity level
  optLevel              :: Int,         -- optimisation level
296
  simplPhases           :: Int,         -- number of simplifier phases
Ian Lynagh's avatar
Ian Lynagh committed
297
  maxSimplIterations    :: Int,         -- max simplifier iterations
298
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
299
  ruleCheck             :: Maybe String,
300

Ian Lynagh's avatar
Ian Lynagh committed
301
302
303
  specConstrThreshold   :: Maybe Int,   -- Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- Threshold for LiberateCase
304

Ian Lynagh's avatar
Ian Lynagh committed
305
306
307
308
309
310
  stolen_x86_regs       :: Int,
  cmdlineHcIncludes     :: [String],    -- -#includes
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
  ctxtStkDepth          :: Int,         -- Typechecker context stack depth
311

Ian Lynagh's avatar
Ian Lynagh committed
312
  thisPackage           :: PackageId,
313
314

  -- ways
Ian Lynagh's avatar
Ian Lynagh committed
315
316
317
318
  wayNames              :: [WayName],   -- way flags from the cmd line
  buildTag              :: String,      -- the global "way" (eg. "p" for prof)
  rtsBuildTag           :: String,      -- the RTS "way"

319
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
320
321
322
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
323

Ian Lynagh's avatar
Ian Lynagh committed
324
325
326
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
327

Ian Lynagh's avatar
Ian Lynagh committed
328
329
330
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
331

332
  -- | This is set by DriverPipeline.runPipeline based on where
Ian Lynagh's avatar
Ian Lynagh committed
333
334
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
335
336

  -- | Override the dumpPrefix set by runPipeline.
Ian Lynagh's avatar
Ian Lynagh committed
337
338
339
340
341
342
343
344
345
  --    Set by -ddump-file-prefix
  dumpPrefixForce       :: Maybe FilePath,

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

346
347
348
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

Ian Lynagh's avatar
Ian Lynagh committed
349
  hpcDir                :: String,      -- ^ path to store the .mix files
andy@galois.com's avatar
andy@galois.com committed
350

351
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
352
353
354
355
356
357
358
359
360
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_dep               :: [String],
  opt_windres           :: [String],
361
362

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
363
364
365
366
367
368
369
370
371
  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]),
372
373
  pgm_T                 :: String,
  pgm_sysman            :: String,
374
  pgm_windres           :: String,
375

376
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
377
  extraPkgConfs         :: [FilePath],
378
379
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
Ian Lynagh's avatar
Ian Lynagh committed
380
381
        -- The -package-conf flags given on the command line, in the order
        -- they appeared.
382

Ian Lynagh's avatar
Ian Lynagh committed
383
384
  packageFlags          :: [PackageFlag],
        -- The -package and -hide-package flags from the command-line
385

386
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
387
  -- NB. do not modify this field, it is calculated by
388
  -- Packages.initPackages and Packages.updatePackages.
389
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
390
  pkgState              :: PackageState,
391
392

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
393
394
  flags                 :: [DynFlag],

395
  -- message output
David Waern's avatar
David Waern committed
396
397
398
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
399
400
401
402
403
404
405
406
407
408
 }

data HscTarget
  = HscC
  | HscAsm
  | HscJava
  | HscInterpreted
  | HscNothing
  deriving (Eq, Show)

409
410
411
412
413
414
415
416
417
418
419
420
-- | will this target result in an object file on the disk?
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
isObjectTarget _        = False

-- | The 'GhcMode' tells us whether we're doing multi-module
-- compilation (controlled via the "GHC" API) or one-shot
-- (single-module) compilation.  This makes a difference primarily to
-- the "Finder": in one-shot mode we look for interface files for
-- imported modules, but in multi-module mode we look for source files
-- in order to check whether they need to be recompiled.
421
data GhcMode
422
  = CompManager         -- ^ --make, GHCi, etc.
Ian Lynagh's avatar
Ian Lynagh committed
423
  | OneShot             -- ^ ghc -c Foo.hs
424
  | MkDepend            -- ^ ghc -M, see Finder for why we need this
425
426
427
428
429
430
  deriving Eq

isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

431
-- | What kind of linking to do.
Ian Lynagh's avatar
Ian Lynagh committed
432
433
434
data GhcLink    -- What to do in the link step, if there is one
  = NoLink              -- Don't link at all
  | LinkBinary          -- Link object code into a binary
435
  | LinkInMemory        -- Use the in-memory dynamic linker
Ian Lynagh's avatar
Ian Lynagh committed
436
  | LinkDynLib          -- Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
437
  deriving (Eq, Show)
438
439
440

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
441
isNoLink _      = False
442
443
444
445
446

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
447
  deriving Eq
448

twanvl's avatar
twanvl committed
449
defaultHscTarget :: HscTarget
450
451
452
453
defaultHscTarget = defaultObjectTarget

-- | the 'HscTarget' value corresponding to the default way to create
-- object files on the current platform.
twanvl's avatar
twanvl committed
454
defaultObjectTarget :: HscTarget
455
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
456
457
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
458

459
460
461
462
463
464
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

twanvl's avatar
twanvl committed
465
initDynFlags :: DynFlags -> IO DynFlags
466
467
468
469
470
471
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
 build_tag <- readIORef v_Build_tag
 rts_build_tag <- readIORef v_RTS_Build_tag
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
472
473
474
475
        wayNames        = ways,
        buildTag        = build_tag,
        rtsBuildTag     = rts_build_tag
        }
476

twanvl's avatar
twanvl committed
477
defaultDynFlags :: DynFlags
478
479
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
480
481
482
483
484
485
486
487
488
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
489
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
490
        maxSimplIterations      = 4,
491
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
492
493
494
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
495
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
        dynLibLoader            = Deployable,
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
                                   then ["-D__PIC__"]
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
        opt_dep                 = [],
536
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
537
538
539

        extraPkgConfs           = [],
        packageFlags            = [],
540
541
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
        systemPackageConfig     = panic "defaultDynFlags: No systemPackageConfig",
        pgm_L                   = panic "defaultDynFlags: No pgm_L",
        pgm_P                   = panic "defaultDynFlags: No pgm_P",
        pgm_F                   = panic "defaultDynFlags: No pgm_F",
        pgm_c                   = panic "defaultDynFlags: No pgm_c",
        pgm_m                   = panic "defaultDynFlags: No pgm_m",
        pgm_s                   = panic "defaultDynFlags: No pgm_s",
        pgm_a                   = panic "defaultDynFlags: No pgm_a",
        pgm_l                   = panic "defaultDynFlags: No pgm_l",
        pgm_dll                 = panic "defaultDynFlags: No pgm_dll",
        pgm_T                   = panic "defaultDynFlags: No pgm_T",
        pgm_sysman              = panic "defaultDynFlags: No pgm_sysman",
        pgm_windres             = panic "defaultDynFlags: No pgm_windres",
        -- end of initSysTools values
        haddockOptions = Nothing,
564
565
566
567
568
569
570
571
572
573
        flags = [
            Opt_ReadUserPackageConf,

            Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
                                -- behaviour the default, to see if anyone notices
                                -- SLPJ July 06

            Opt_ImplicitPrelude,
            Opt_MonomorphismRestriction,

574
575
            Opt_MethodSharing,

576
577
            Opt_DoAsmMangling,

578
            Opt_GenManifest,
579
580
            Opt_EmbedManifest,
            Opt_PrintBindContents
581
582
583
584
585
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
586
        log_action = \severity srcSpan style msg ->
587
588
589
590
                        case severity of
                          SevInfo  -> hPutStrLn stderr (show (msg style))
                          SevFatal -> hPutStrLn stderr (show (msg style))
                          _        -> hPutStrLn stderr ('\n':show ((mkLocMessage srcSpan msg) style))
591
592
      }

Ian Lynagh's avatar
Ian Lynagh committed
593
{-
594
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
595
596

    0   |   print errors & warnings only
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
    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"
-}

dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

getOpts :: DynFlags -> (DynFlags -> [a]) -> [a]
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
615
        -- We add to the options from the front, so we need to reverse the list
616
617

getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
618
619
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
620
621
  | otherwise =  ""

twanvl's avatar
twanvl committed
622
623
624
625
626
627
628
629
setObjectDir, setHiDir, setStubDir, setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptdep, addOptwindres,
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

630
631
632
633
634
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
  -- #included from the .hc file when compiling with -fvia-C.
635

636
637
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
638
639
640
641
setHcSuf      f d = d{ hcSuf      = f}

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

643
644
645
646
647
648
649
650
651
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
   ("wrapped", "")      -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", "hard") -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", flex)   -> d{ dynLibLoader = Wrapped (Just flex) }
   (_,_)                -> error "Unknown dynlib loader"

652
653
setDumpPrefixForce f d = d { dumpPrefixForce = f}

654
655
656
657
658
659
660
661
662
663
664
665
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}

setPgmL   f d = d{ pgm_L   = f}
setPgmF   f d = d{ pgm_F   = f}
setPgmc   f d = d{ pgm_c   = (f,[])}
setPgmm   f d = d{ pgm_m   = (f,[])}
setPgms   f d = d{ pgm_s   = (f,[])}
setPgma   f d = d{ pgm_a   = (f,[])}
setPgml   f d = d{ pgm_l   = (f,[])}
setPgmdll f d = d{ pgm_dll = (f,[])}
666
setPgmwindres f d = d{ pgm_windres = f}
667
668
669
670
671
672
673
674
675

addOptL   f d = d{ opt_L   = f : opt_L d}
addOptP   f d = d{ opt_P   = f : opt_P d}
addOptF   f d = d{ opt_F   = f : opt_F d}
addOptc   f d = d{ opt_c   = f : opt_c d}
addOptm   f d = d{ opt_m   = f : opt_m d}
addOpta   f d = d{ opt_a   = f : opt_a d}
addOptl   f d = d{ opt_l   = f : opt_l d}
addOptdep f d = d{ opt_dep = f : opt_dep d}
676
addOptwindres f d = d{ opt_windres = f : opt_windres d}
677
678
679

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

David Waern's avatar
David Waern committed
680
681
addHaddockOpts f d = d{ haddockOptions = Just f}

682
683
684
685
686
687
688
689
690
691
692
693
-- -----------------------------------------------------------------------------
-- Command-line options

-- When invoking external tools as part of the compilation pipeline, we
-- 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
-- between filepaths and 'other stuff'. [The reason being, of course, that
-- this type gives us a handle on transforming filenames, and filenames only,
-- to whatever format they're expected to be on a particular platform.]

data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
694
695
696
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
697
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
698

699
700
701
702
703
704
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
-- Set dynflags appropriate to the optimisation level
updOptLevel n dfs
705
  = dfs2{ optLevel = final_n }
706
  where
Ian Lynagh's avatar
Ian Lynagh committed
707
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
708
709
710
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

711
712
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
Ian Lynagh's avatar
Ian Lynagh committed
713

714
715
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
716
  = [ ([0],     Opt_IgnoreInterfacePragmas)
717
    , ([0],     Opt_OmitInterfacePragmas)
718

Ian Lynagh's avatar
Ian Lynagh committed
719
720
721
722
723
724
725
726
    , ([1,2],   Opt_IgnoreAsserts)
    , ([1,2],   Opt_RewriteRules)       -- Off for -O0; see Note [Scoping for Builtin rules]
                                        --              in PrelRules
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
727

Ian Lynagh's avatar
Ian Lynagh committed
728
729
730
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
    , ([2],     Opt_StaticArgumentTransformation)
731
732

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
733
734
735
736
                -- This one is important for a tiresome reason:
                -- we want to make sure that the bindings for data
                -- constructors are eta-expanded.  This is probably
                -- a good thing anyway, but it seems fragile.
737
738
739
740
741
    ]

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

twanvl's avatar
twanvl committed
742
standardWarnings :: [DynFlag]
743
744
standardWarnings
    = [ Opt_WarnDeprecations,
Ian Lynagh's avatar
Ian Lynagh committed
745
746
747
748
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
        Opt_WarnDuplicateExports
749
750
      ]

twanvl's avatar
twanvl committed
751
minusWOpts :: [DynFlag]
752
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
753
754
755
756
757
758
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
759
760
      ]

twanvl's avatar
twanvl committed
761
minusWallOpts :: [DynFlag]
762
763
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
764
765
766
767
768
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
769
770
      ]

771
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
772
minuswRemovesOpts :: [DynFlag]
773
774
775
776
777
778
779
780
781
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
       Opt_WarnTabs
      ]

782
783
784
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
785
786
787
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
788

Ian Lynagh's avatar
Ian Lynagh committed
789
790
791
792
793
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
794
795
796
797
798
799
800
801
802
803
804
805
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
806
807
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
808
  | CoreDoVectorisation
Ian Lynagh's avatar
Ian Lynagh committed
809
810
  | CoreDoNothing                -- Useful when building up
  | CoreDoPasses [CoreToDo]      -- lists of these things
811

Ian Lynagh's avatar
Ian Lynagh committed
812
data SimplifierMode             -- See comments in SimplMonad
813
  = SimplGently
814
  | SimplPhase Int [String]
815
816
817
818
819
820

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

data FloatOutSwitches
Ian Lynagh's avatar
Ian Lynagh committed
821
822
823
  = FloatOutSw  Bool    -- True <=> float lambdas to top level
                Bool    -- True <=> float constants to top level,
                        --          even if they do not escape a lambda
824
825
826


-- The core-to-core pass ordering is derived from the DynFlags:
827
828
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
twanvl's avatar
twanvl committed
829
runWhen False _       = CoreDoNothing
830

831
832
833
834
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

835
836
837
838
839
getCoreToDo :: DynFlags -> [CoreToDo]
getCoreToDo dflags
  | Just todo <- coreToDo dflags = todo -- set explicitly by user
  | otherwise = core_todo
  where
Ian Lynagh's avatar
Ian Lynagh committed
840
    opt_level     = optLevel dflags
841
    phases        = simplPhases dflags
Ian Lynagh's avatar
Ian Lynagh committed
842
    max_iter      = maxSimplIterations dflags
843
844
845
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
846
847
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
848
    rule_check    = ruleCheck dflags
849
    vectorisation = dopt Opt_Vectorise dflags
Simon Marlow's avatar
Simon Marlow committed
850
    -- static_args   = dopt Opt_StaticArgumentTransformation dflags
851

852
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
853

854
855
856
857
858
859
860
    simpl_phase phase names iter
      = CoreDoPasses
          [ CoreDoSimplify (SimplPhase phase names) [
              MaxSimplifierIterations iter
            ],
            maybe_rule_check phase
          ]
861

862
863
                -- By default, we have 2 phases before phase 0.

Ian Lynagh's avatar
Ian Lynagh committed
864
865
866
867
                -- Want to run with inline phase 2 after the specialiser to give
                -- maximum chance for fusion to work before we inline build/augment
                -- in phase 1.  This made a difference in 'ansi' where an
                -- overloaded function wasn't inlined till too late.
868

Ian Lynagh's avatar
Ian Lynagh committed
869
870
871
872
                -- Need phase 1 so that build/augment get
                -- inlined.  I found that spectral/hartel/genfft lost some useful
                -- strictness in the function sumcode' if augment is not inlined
                -- before strictness analysis runs
873
    simpl_phases = CoreDoPasses [ simpl_phase phase ["main"] max_iter
874
875
                                  | phase <- [phases, phases-1 .. 1] ]

876

Ian Lynagh's avatar
Ian Lynagh committed
877
        -- initial simplify: mk specialiser happy: minimum effort please
878
    simpl_gently = CoreDoSimplify SimplGently [
Ian Lynagh's avatar
Ian Lynagh committed
879
880
881
882
883
884
885
886
887
888
889
890
891
892
                        --      Simplify "gently"
                        -- Don't inline anything till full laziness has bitten
                        -- In particular, inlining wrappers inhibits floating
                        -- e.g. ...(case f x of ...)...
                        --  ==> ...(case (case x of I# x# -> fw x#) of ...)...
                        --  ==> ...(case x of I# x# -> case fw x# of ...)...
                        -- and now the redex (f x) isn't floatable any more
                        -- Similarly, don't apply any rules until after full
                        -- laziness.  Notably, list fusion can prevent floating.

            NoCaseOfCase,       -- Don't do case-of-case transformations.
                                -- This makes full laziness work better
            MaxSimplifierIterations max_iter
        ]
893

rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
894
    core_todo =
895
     if opt_level == 0 then
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
896
897
       [runWhen vectorisation (CoreDoPasses [ simpl_gently, CoreDoVectorisation ]),
        simpl_phase 0 ["final"] max_iter]
Ian Lynagh's avatar
Ian Lynagh committed
898
     else {- opt_level >= 1 -} [
899

900
901
902
903
    -- We want to do the static argument transform before full laziness as it
    -- may expose extra opportunities to float things outwards. However, to fix
    -- up the output of the transformation we need at do at least one simplify
    -- after this before anything else
Ian Lynagh's avatar
Ian Lynagh committed
904
            -- runWhen static_args CoreDoStaticArgs,
Simon Marlow's avatar
Simon Marlow committed
905
            -- XXX disabled, see #2321
906

Ian Lynagh's avatar
Ian Lynagh committed
907
        -- initial simplify: mk specialiser happy: minimum effort please
908
        simpl_gently,
909
910
911

        -- We run vectorisation here for now, but we might also try to run
        -- it later
912
        runWhen vectorisation (CoreDoPasses [ CoreDoVectorisation, simpl_gently ]),
913

Ian Lynagh's avatar
Ian Lynagh committed
914
915
916
        -- Specialisation is best done before full laziness
        -- so that overloaded functions have all their dictionary lambdas manifest
        CoreDoSpecialising,
917

Ian Lynagh's avatar
Ian Lynagh committed
918
        runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
919

Ian Lynagh's avatar
Ian Lynagh committed
920
        CoreDoFloatInwards,
921

922
        simpl_phases,
923

Ian Lynagh's avatar
Ian Lynagh committed
924
925
                -- Phase 0: allow all Ids to be inlined now
                -- This gets foldr inlined before strictness analysis
926

Ian Lynagh's avatar
Ian Lynagh committed
927
928
929
930
931
932
933
934
                -- At least 3 iterations because otherwise we land up with
                -- huge dead expressions because of an infelicity in the
                -- simpifier.
                --      let k = BIG in foldr k z xs
                -- ==>  let k = BIG in letrec go = \xs -> ...(k x).... in go xs
                -- ==>  let k = BIG in letrec go = \xs -> ...(BIG x).... in go xs
                -- Don't stop now!
        simpl_phase 0 ["main"] (max max_iter 3),
935
936
937


#ifdef OLD_STRICTNESS
Ian Lynagh's avatar
Ian Lynagh committed
938
        CoreDoOldStrictness,
939
#endif
Ian Lynagh's avatar
Ian Lynagh committed
940
941
942
943
        runWhen strictness (CoreDoPasses [
                CoreDoStrictness,
                CoreDoWorkerWrapper,
                CoreDoGlomBinds,
944
                simpl_phase 0 ["post-worker-wrapper"] max_iter
945
                ]),
946

Ian Lynagh's avatar
Ian Lynagh committed
947
948
949
950
951
952
953
954
        runWhen full_laziness
          (CoreDoFloatOutwards (FloatOutSw False    -- Not lambdas
                                           True)),  -- Float constants
                -- nofib/spectral/hartel/wang doubles in speed if you
                -- do full laziness late in the day.  It only happens
                -- after fusion and other stuff, so the early pass doesn't
                -- catch it.  For the record, the redex is
                --        f_el22 (f_el21 r_midblock)
955
956


Ian Lynagh's avatar
Ian Lynagh committed
957
958
959
960
        runWhen cse CoreCSE,
                -- We want CSE to follow the final full-laziness pass, because it may
                -- succeed in commoning up things floated out by full laziness.
                -- CSE used to rely on the no-shadowing invariant, but it doesn't any more
961

Ian Lynagh's avatar
Ian Lynagh committed
962
        CoreDoFloatInwards,
963

Ian Lynagh's avatar
Ian Lynagh committed
964
        maybe_rule_check 0,
965

Ian Lynagh's avatar
Ian Lynagh committed
966
967
968
969
                -- Case-liberation for -O2.  This should be after
                -- strictness analysis and the simplification which follows it.
        runWhen liberate_case (CoreDoPasses [
            CoreLiberateCase,
970
            simpl_phase 0 ["post-liberate-case"] max_iter
Ian Lynagh's avatar
Ian Lynagh committed
971
972
973
            ]),         -- Run the simplifier after LiberateCase to vastly
                        -- reduce the possiblility of shadowing
                        -- Reason: see Note [Shadowing] in SpecConstr.lhs
974

Ian Lynagh's avatar
Ian Lynagh committed
975
        runWhen spec_constr CoreDoSpecConstr,
976

977
        maybe_rule_check 0,
978

Ian Lynagh's avatar
Ian Lynagh committed
979
        -- Final clean-up simplification:
980
        simpl_phase 0 ["final"] max_iter
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
     ]

-- -----------------------------------------------------------------------------
-- StgToDo:  abstraction of stg-to-stg passes to run.

data StgToDo
  = StgDoMassageForProfiling  -- should be (next to) last
  -- There's also setStgVarInfo, but its absolute "lastness"
  -- is so critical that it is hardwired in (no flag).
  | D_stg_stats

getStgToDo :: DynFlags -> [StgToDo]
getStgToDo dflags
  | Just todo <- stgToDo dflags = todo -- set explicitly by user
  | otherwise = todo2
  where
Ian Lynagh's avatar
Ian Lynagh committed
997
        stg_stats = dopt Opt_StgStats dflags
998

Ian Lynagh's avatar
Ian Lynagh committed
999
        todo1 = if stg_stats then [D_stg_stats] else []
1000

Ian Lynagh's avatar
Ian Lynagh committed
1001
1002
1003
1004
        todo2 | WayProf `elem` wayNames dflags
              = StgDoMassageForProfiling : todo1
              | otherwise
              = todo1
1005
1006
1007
1008

-- -----------------------------------------------------------------------------
-- DynFlags parser

1009
1010
allFlags :: [String]
allFlags = map ('-':) $
1011
           [ flagName flag | flag <- dynamic_flags, ok (flagOptKind flag) ] ++
1012
           map ("fno-"++) flags ++
1013
1014
1015
           map ("f"++) flags ++
           map ("X"++) xs ++
           map ("XNo"++) xs
1016
1017
1018
    where ok (PrefixPred _ _) = False
          ok _ = True
          flags = map fst fFlags
1019
          xs = map fst xFlags
1020

1021
dynamic_flags :: [Flag DynP]
1022
dynamic_flags = [
1023
1024
1025
1026
1027
    Flag "n"              (NoArg  (setDynFlag Opt_DryRun)) Supported
  , Flag "cpp"            (NoArg  (setDynFlag Opt_Cpp)) Supported
  , Flag "F"              (NoArg  (setDynFlag Opt_Pp)) Supported
  , Flag "#include"       (HasArg (addCmdlineHCInclude)) Supported
  , Flag "v"              (OptIntSuffix setVerbosity) Supported
1028

1029
        ------- Specific phases  --------------------------------------------
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
  , Flag "pgmL"           (HasArg (upd . setPgmL)) Supported
  , Flag "pgmP"           (HasArg (upd . setPgmP)) Supported
  , Flag "pgmF"           (HasArg (upd . setPgmF)) Supported
  , Flag "pgmc"           (HasArg (upd . setPgmc)) Supported
  , Flag "pgmm"           (HasArg (upd . setPgmm)) Supported
  , Flag "pgms"           (HasArg (upd . setPgms)) Supported
  , Flag "pgma"           (HasArg (upd . setPgma)) Supported
  , Flag "pgml"           (HasArg (upd . setPgml)) Supported
  , Flag "pgmdll"         (HasArg (upd . setPgmdll)) Supported
  , Flag "pgmwindres"     (HasArg (upd . setPgmwindres)) Supported

  , Flag "optL"           (HasArg (upd . addOptL)) Supported
  , Flag "optP"           (HasArg (upd . addOptP)) Supported
  , Flag "optF"           (HasArg (upd . addOptF)) Supported
  , Flag "optc"           (HasArg (upd . addOptc)) Supported
  , Flag "optm"           (HasArg (upd . addOptm)) Supported
  , Flag "opta"           (HasArg (upd . addOpta)) Supported
  , Flag "optl"           (HasArg (upd . addOptl)) Supported
  , Flag "optdep"         (HasArg (upd . addOptdep)) Supported
  , Flag "optwindres"     (HasArg (upd . addOptwindres)) Supported
1050
1051
1052

  , Flag "split-objs"
         (NoArg (if can_split then setDynFlag Opt_SplitObjs else return ()))
1053
         Supported
1054

Ian Lynagh's avatar
Ian Lynagh committed
1055
        -------- Linking ----------------------------------------------------
1056
  , Flag "c"              (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
1057
1058
1059
         Supported
  , Flag "no-link"        (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
         (Deprecated "Use -c instead")
1060
  , Flag "shared"         (NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
1061
         Supported
1062
  , Flag "dynload"        (HasArg (upd . parseDynLibLoaderMode))
1063
         Supported
1064

Ian Lynagh's avatar
Ian Lynagh committed
1065
        ------- Libraries ---------------------------------------------------
1066
1067
  , Flag "L"              (Prefix addLibraryPath ) Supported
  , Flag "l"              (AnySuffix (\s -> do upd (addOptl s))) Supported
1068

Ian Lynagh's avatar
Ian Lynagh committed
1069
        ------- Frameworks --------------------------------------------------
1070
        -- -framework-path should really be -F ...
1071
1072
  , Flag "framework-path" (HasArg addFrameworkPath ) Supported
  , Flag "framework"      (HasArg (upd . addCmdlineFramework)) Supported
Ian Lynagh's avatar
Ian Lynagh committed
1073
1074

        ------- Output Redirection ------------------------------------------
1075
1076
1077
1078
1079
1080
1081
1082
1083
  , Flag "odir"           (HasArg (upd . setObjectDir)) Supported
  , Flag "o"              (SepArg (upd . setOutputFile . Just)) Supported
  , Flag "ohi"            (HasArg (upd . setOutputHi   . Just )) Supported
  , Flag "osuf"           (HasArg (upd . setObjectSuf)) Supported
  , Flag "hcsuf"          (HasArg (upd . setHcSuf)) Supported
  , Flag "hisuf"          (HasArg (upd . setHiSuf)) Supported
  , Flag "hidir"          (HasArg (upd . setHiDir)) Supported
  , Flag "tmpdir"         (HasArg (upd . setTmpDir)) Supported
  , Flag "stubdir"        (HasArg (upd . setStubDir)) Supported
1084
  , Flag "ddump-file-prefix" (HasArg (upd . setDumpPrefixForce . Just))
1085
         Supported
1086

Ian Lynagh's avatar
Ian Lynagh committed
1087
        ------- Keeping temporary files -------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
1088
     -- These can be singular (think ghc -c) or plural (think ghc --make)
1089
1090
1091
1092
1093
1094
  , Flag "keep-hc-file"     (NoArg (setDynFlag Opt_KeepHcFiles)) Supported
  , Flag "keep-hc-files"    (NoArg (setDynFlag Opt_KeepHcFiles)) Supported
  , Flag "keep-s-file"      (NoArg (setDynFlag Opt_KeepSFiles)) Supported
  , Flag "keep-s-files"     (NoArg (setDynFlag Opt_KeepSFiles)) Supported
  , Flag "keep-raw-s-file"  (NoArg (setDynFlag Opt_KeepRawSFiles)) Supported
  , Flag "keep-raw-s-files" (NoArg (setDynFlag Opt_KeepRawSFiles)) Supported
Ian Lynagh's avatar
Ian Lynagh committed
1095
     -- This only makes sense as plural
1096
  , Flag "keep-tmp-files"   (NoArg (setDynFlag Opt_KeepTmpFiles)) Supported
1097

Ian Lynagh's avatar
Ian Lynagh committed
1098
        ------- Miscellaneous ----------------------------------------------
Ian Lynagh's avatar