DynFlags.hs 78.1 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
        DPHBackend(..),
27

Ian Lynagh's avatar
Ian Lynagh committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
        -- 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,
49
        allFlags,
50

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

#include "HsVersions.h"

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

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

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

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

data DynFlag

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

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

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

233
234
   | Opt_PrintExplicitForalls

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

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

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

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

291
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
292
293
294
295
296
297
298
299
300
  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
301
  simplPhases           :: Int,         -- number of simplifier phases
Ian Lynagh's avatar
Ian Lynagh committed
302
  maxSimplIterations    :: Int,         -- max simplifier iterations
303
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
304
  ruleCheck             :: Maybe String,
305

Ian Lynagh's avatar
Ian Lynagh committed
306
307
308
  specConstrThreshold   :: Maybe Int,   -- Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- Threshold for LiberateCase
309

Ian Lynagh's avatar
Ian Lynagh committed
310
311
312
313
314
315
  stolen_x86_regs       :: Int,
  cmdlineHcIncludes     :: [String],    -- -#includes
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
  ctxtStkDepth          :: Int,         -- Typechecker context stack depth
316

317
318
  dphBackend            :: DPHBackend,

Ian Lynagh's avatar
Ian Lynagh committed
319
  thisPackage           :: PackageId,
320
321

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

326
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
327
328
329
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
330

Ian Lynagh's avatar
Ian Lynagh committed
331
332
333
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
334

Ian Lynagh's avatar
Ian Lynagh committed
335
336
337
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
338

339
  -- | This is set by DriverPipeline.runPipeline based on where
Ian Lynagh's avatar
Ian Lynagh committed
340
341
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
342
343

  -- | Override the dumpPrefix set by runPipeline.
Ian Lynagh's avatar
Ian Lynagh committed
344
345
346
347
348
349
350
351
352
  --    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 '/'

353
354
355
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

358
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
359
360
361
362
363
364
365
366
367
  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],
368
369

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
370
371
372
373
374
375
376
377
378
  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]),
379
380
  pgm_T                 :: String,
  pgm_sysman            :: String,
381
  pgm_windres           :: String,
382

383
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
384
  extraPkgConfs         :: [FilePath],
385
386
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
Ian Lynagh's avatar
Ian Lynagh committed
387
388
        -- The -package-conf flags given on the command line, in the order
        -- they appeared.
389

Ian Lynagh's avatar
Ian Lynagh committed
390
391
  packageFlags          :: [PackageFlag],
        -- The -package and -hide-package flags from the command-line
392

393
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
394
  -- NB. do not modify this field, it is calculated by
395
  -- Packages.initPackages and Packages.updatePackages.
396
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
397
  pkgState              :: PackageState,
398
399

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
400
401
  flags                 :: [DynFlag],

402
  -- message output
David Waern's avatar
David Waern committed
403
404
405
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
406
407
408
409
410
411
412
413
414
415
 }

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

416
417
418
419
420
421
422
423
424
425
426
427
-- | 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.
428
data GhcMode
429
  = CompManager         -- ^ --make, GHCi, etc.
Ian Lynagh's avatar
Ian Lynagh committed
430
  | OneShot             -- ^ ghc -c Foo.hs
431
  | MkDepend            -- ^ ghc -M, see Finder for why we need this
432
433
434
435
436
437
  deriving Eq

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

438
-- | What kind of linking to do.
Ian Lynagh's avatar
Ian Lynagh committed
439
440
441
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
442
  | LinkInMemory        -- Use the in-memory dynamic linker
Ian Lynagh's avatar
Ian Lynagh committed
443
  | LinkDynLib          -- Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
444
  deriving (Eq, Show)
445
446
447

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
448
isNoLink _      = False
449
450
451
452
453

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
454
  deriving Eq
455

twanvl's avatar
twanvl committed
456
defaultHscTarget :: HscTarget
457
458
459
460
defaultHscTarget = defaultObjectTarget

-- | the 'HscTarget' value corresponding to the default way to create
-- object files on the current platform.
twanvl's avatar
twanvl committed
461
defaultObjectTarget :: HscTarget
462
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
463
464
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
465

466
467
468
469
470
471
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

twanvl's avatar
twanvl committed
472
initDynFlags :: DynFlags -> IO DynFlags
473
474
475
476
477
478
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
479
480
481
482
        wayNames        = ways,
        buildTag        = build_tag,
        rtsBuildTag     = rts_build_tag
        }
483

twanvl's avatar
twanvl committed
484
defaultDynFlags :: DynFlags
485
486
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
487
488
489
490
491
492
493
494
495
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
496
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
497
        maxSimplIterations      = 4,
498
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
499
500
501
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
502
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
503
504
505
506
507
508
509
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

510
511
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
        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                 = [],
545
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
546
547
548

        extraPkgConfs           = [],
        packageFlags            = [],
549
550
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
        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,
573
        flags = [
574
            Opt_AutoLinkPackages,
575
576
577
578
579
580
581
582
583
            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,

584
585
            Opt_MethodSharing,

586
587
            Opt_DoAsmMangling,

588
            Opt_GenManifest,
589
590
            Opt_EmbedManifest,
            Opt_PrintBindContents
591
592
593
594
595
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
596
        log_action = \severity srcSpan style msg ->
597
598
599
600
                        case severity of
                          SevInfo  -> hPutStrLn stderr (show (msg style))
                          SevFatal -> hPutStrLn stderr (show (msg style))
                          _        -> hPutStrLn stderr ('\n':show ((mkLocMessage srcSpan msg) style))
601
602
      }

Ian Lynagh's avatar
Ian Lynagh committed
603
{-
604
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
605
606

    0   |   print errors & warnings only
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
    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
625
        -- We add to the options from the front, so we need to reverse the list
626
627

getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
628
629
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
630
631
  | otherwise =  ""

twanvl's avatar
twanvl committed
632
633
634
635
636
637
638
639
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

640
641
642
643
644
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.
645

646
647
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
648
649
650
651
setHcSuf      f d = d{ hcSuf      = f}

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

653
654
655
656
657
658
659
660
661
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"

662
663
setDumpPrefixForce f d = d { dumpPrefixForce = f}

664
665
666
667
668
669
670
671
672
673
674
675
-- 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,[])}
676
setPgmwindres f d = d{ pgm_windres = f}
677
678
679
680
681
682
683
684
685

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}
686
addOptwindres f d = d{ opt_windres = f : opt_windres d}
687
688
689

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

David Waern's avatar
David Waern committed
690
691
addHaddockOpts f d = d{ haddockOptions = Just f}

692
693
694
695
696
697
698
699
700
701
702
703
-- -----------------------------------------------------------------------------
-- 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
704
705
706
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
707
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
708

709
710
711
712
713
714
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
-- Set dynflags appropriate to the optimisation level
updOptLevel n dfs
715
  = dfs2{ optLevel = final_n }
716
  where
Ian Lynagh's avatar
Ian Lynagh committed
717
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
718
719
720
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

721
722
   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
723

724
725
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
726
  = [ ([0],     Opt_IgnoreInterfacePragmas)
727
    , ([0],     Opt_OmitInterfacePragmas)
728

Ian Lynagh's avatar
Ian Lynagh committed
729
730
731
732
733
734
735
736
    , ([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)
737

Ian Lynagh's avatar
Ian Lynagh committed
738
739
740
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
    , ([2],     Opt_StaticArgumentTransformation)
741
742

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
743
744
745
746
                -- 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.
747
748
749
750
751
    ]

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

twanvl's avatar
twanvl committed
752
standardWarnings :: [DynFlag]
753
754
standardWarnings
    = [ Opt_WarnDeprecations,
755
        Opt_WarnDeprecatedFlags,
Ian Lynagh's avatar
Ian Lynagh committed
756
757
758
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
759
760
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
761
762
      ]

twanvl's avatar
twanvl committed
763
minusWOpts :: [DynFlag]
764
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
765
766
767
768
769
770
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
771
772
      ]

twanvl's avatar
twanvl committed
773
minusWallOpts :: [DynFlag]
774
775
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
776
777
778
779
780
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
781
782
      ]

783
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
784
minuswRemovesOpts :: [DynFlag]
785
786
787
788
789
790
791
792
793
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
       Opt_WarnTabs
      ]

794
795
796
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
797
798
799
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
800

Ian Lynagh's avatar
Ian Lynagh committed
801
802
803
804
805
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
806
807
808
809
810
811
812
813
814
815
816
817
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
818
819
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
820
  | CoreDoVectorisation DPHBackend
Ian Lynagh's avatar
Ian Lynagh committed
821
822
  | CoreDoNothing                -- Useful when building up
  | CoreDoPasses [CoreToDo]      -- lists of these things
823

Ian Lynagh's avatar
Ian Lynagh committed
824
data SimplifierMode             -- See comments in SimplMonad
825
  = SimplGently
826
  | SimplPhase Int [String]
827
828
829
830
831
832

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

data FloatOutSwitches
Ian Lynagh's avatar
Ian Lynagh committed
833
834
835
  = FloatOutSw  Bool    -- True <=> float lambdas to top level
                Bool    -- True <=> float constants to top level,
                        --          even if they do not escape a lambda
836
837
838


-- The core-to-core pass ordering is derived from the DynFlags:
839
840
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
twanvl's avatar
twanvl committed
841
runWhen False _       = CoreDoNothing
842

843
844
845
846
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

847
848
849
850
851
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
852
    opt_level     = optLevel dflags
853
    phases        = simplPhases dflags
Ian Lynagh's avatar
Ian Lynagh committed
854
    max_iter      = maxSimplIterations dflags
855
856
857
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
858
859
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
860
    rule_check    = ruleCheck dflags
861
    static_args   = dopt Opt_StaticArgumentTransformation dflags
862

863
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
864

865
866
867
868
869
870
871
    simpl_phase phase names iter
      = CoreDoPasses
          [ CoreDoSimplify (SimplPhase phase names) [
              MaxSimplifierIterations iter
            ],
            maybe_rule_check phase
          ]
872

873
874
875
876
877
    vectorisation
      = runWhen (dopt Opt_Vectorise dflags)
        $ CoreDoPasses [ simpl_gently, CoreDoVectorisation (dphBackend dflags) ]


878
879
                -- By default, we have 2 phases before phase 0.

Ian Lynagh's avatar
Ian Lynagh committed
880
881
882
883
                -- 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.
884

Ian Lynagh's avatar
Ian Lynagh committed
885
886
887
888
                -- 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
889
    simpl_phases = CoreDoPasses [ simpl_phase phase ["main"] max_iter
890
891
                                  | phase <- [phases, phases-1 .. 1] ]

892

Ian Lynagh's avatar
Ian Lynagh committed
893
        -- initial simplify: mk specialiser happy: minimum effort please
894
    simpl_gently = CoreDoSimplify SimplGently [
Ian Lynagh's avatar
Ian Lynagh committed
895
896
897
898
899
900
901
902
903
904
905
906
907
908
                        --      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
        ]
909

rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
910
    core_todo =
911
     if opt_level == 0 then
912
       [vectorisation,
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
913
        simpl_phase 0 ["final"] max_iter]
Ian Lynagh's avatar
Ian Lynagh committed
914
     else {- opt_level >= 1 -} [
915

916
917
918
919
    -- 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
920
        runWhen static_args (CoreDoPasses [ simpl_gently, CoreDoStaticArgs ]),
921

922
923
        -- We run vectorisation here for now, but we might also try to run
        -- it later
924
925
926
927
        vectorisation,

        -- initial simplify: mk specialiser happy: minimum effort please
        simpl_gently,
928

Ian Lynagh's avatar
Ian Lynagh committed
929
930
931
        -- Specialisation is best done before full laziness
        -- so that overloaded functions have all their dictionary lambdas manifest
        CoreDoSpecialising,
932

Ian Lynagh's avatar
Ian Lynagh committed
933
        runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
934

Ian Lynagh's avatar
Ian Lynagh committed
935
        CoreDoFloatInwards,
936

937
        simpl_phases,
938

Ian Lynagh's avatar
Ian Lynagh committed
939
940
                -- Phase 0: allow all Ids to be inlined now
                -- This gets foldr inlined before strictness analysis
941

Ian Lynagh's avatar
Ian Lynagh committed
942
943
944
945
946
947
948
949
                -- 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),
950
951
952


#ifdef OLD_STRICTNESS
Ian Lynagh's avatar
Ian Lynagh committed
953
        CoreDoOldStrictness,
954
#endif
Ian Lynagh's avatar
Ian Lynagh committed
955
956
957
958
        runWhen strictness (CoreDoPasses [
                CoreDoStrictness,
                CoreDoWorkerWrapper,
                CoreDoGlomBinds,
959
                simpl_phase 0 ["post-worker-wrapper"] max_iter
960
                ]),
961

Ian Lynagh's avatar
Ian Lynagh committed
962
963
964
965
966
967
968
969
        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)
970
971


Ian Lynagh's avatar
Ian Lynagh committed
972
973
974
975
        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
976

Ian Lynagh's avatar
Ian Lynagh committed
977
        CoreDoFloatInwards,
978

Ian Lynagh's avatar
Ian Lynagh committed
979
        maybe_rule_check 0,
980

Ian Lynagh's avatar
Ian Lynagh committed
981
982
983
984
                -- Case-liberation for -O2.  This should be after
                -- strictness analysis and the simplification which follows it.
        runWhen liberate_case (CoreDoPasses [
            CoreLiberateCase,
985
            simpl_phase 0 ["post-liberate-case"] max_iter
Ian Lynagh's avatar
Ian Lynagh committed
986
987
988
            ]),         -- Run the simplifier after LiberateCase to vastly
                        -- reduce the possiblility of shadowing
                        -- Reason: see Note [Shadowing] in SpecConstr.lhs
989

Ian Lynagh's avatar
Ian Lynagh committed
990
        runWhen spec_constr CoreDoSpecConstr,
991

992
        maybe_rule_check 0,
993

Ian Lynagh's avatar
Ian Lynagh committed
994
        -- Final clean-up simplification:
995
        simpl_phase 0 ["final"] max_iter
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
     ]

-- -----------------------------------------------------------------------------
-- 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
1012
        stg_stats = dopt Opt_StgStats dflags
1013

Ian Lynagh's avatar
Ian Lynagh committed
1014
        todo1 = if stg_stats then [D_stg_stats] else []
1015

Ian Lynagh's avatar
Ian Lynagh committed
1016
1017
1018
1019
        todo2 | WayProf `elem` wayNames dflags
              = StgDoMassageForProfiling : todo1
              | otherwise
              = todo1
1020
1021
1022
1023

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

1024
1025
allFlags :: [String]
allFlags = map ('-':) $
1026
           [ flagName flag | flag <- dynamic_flags, ok (flagOptKind flag) ] ++
1027
           map ("fno-"++) flags ++
1028
           map ("f"++) flags ++
1029
1030
           map ("X"++) supportedLanguages ++
           map ("XNo"++) supportedLanguages
1031
1032
    where ok (PrefixPred _ _) = False
          ok _ = True
1033
          flags = [ name | (name, _, _) <- fFlags ]
1034

1035
dynamic_flags :: [Flag DynP]
1036
dynamic_flags = [
1037
1038
1039
1040
1041
    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
1042

1043
        ------- Specific phases  --------------------------------------------
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
  , 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
1064
1065
1066

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

Ian Lynagh's avatar
Ian Lynagh committed
1069
        -------- Linking ----------------------------------------------------
1070
  , Flag "c"              (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
1071
1072
1073
         Supported
  , Flag "no-link"        (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
         (Deprecated "Use -c instead")
1074
  , Flag "shared"         (NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
1075
         Supported
1076
  , Flag "dynload"        (HasArg (upd . parseDynLibLoaderMode))
1077
         Supported
1078

Ian Lynagh's avatar
Ian Lynagh committed
1079
        ------- Libraries ---------------------------------------------------
1080
1081
  , Flag "L"              (Prefix addLibraryPath ) Supported
  , Flag "l"              (AnySuffix (\s -> do upd (addOptl s))) Supported
1082

Ian Lynagh's avatar
Ian Lynagh committed
1083
        ------- Frameworks --------------------------------------------------
1084
        -- -framework-path should really be -F ...
1085
1086
  , Flag "framework-path" (HasArg addFrameworkPath ) Supported
  , Flag "framework"