DynFlags.hs 88.3 KB
Newer Older
1

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

9
-- Most flags are dynamic flags, which means they can change from
10
11
12
-- 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.
13
module DynFlags (
14
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
15
16
17
18
19
20
21
22
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
23
        fFlags, xFlags,
24
        dphPackage,
25

26
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
27
28
29
30
31
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

        dopt,                           -- DynFlag -> DynFlags -> Bool
        dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
32
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
33
        getVerbFlag,
34
        getMainFun,
Ian Lynagh's avatar
Ian Lynagh committed
35
36
37
38
        updOptLevel,
        setTmpDir,
        setPackageName,

39
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
40
        parseDynamicFlags,
41
        parseDynamicNoPackageFlags,
42
        allFlags,
43

44
45
46
        supportedLanguages, languageOptions,

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
47
        machdepCCOpts, picCCOpts,
48
49
50
51
52
53
54
55
56
57
58
59
60
61

        -- * Configuration of the core-to-core passes
        CoreToDo(..),
        SimplifierMode(..),
        SimplifierSwitch(..),
        FloatOutSwitches(..),
        getCoreToDo,

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

        -- * Compiler configuration suitable for display to the user
        compilerInfo
62
63
64
65
  ) where

#include "HsVersions.h"

66
import Module
Simon Marlow's avatar
Simon Marlow committed
67
import PackageConfig
68
69
70
import PrelNames        ( mAIN, main_RDR_Unqual )
import RdrName          ( RdrName, mkRdrUnqual )
import OccName          ( mkVarOccFS )
Simon Marlow's avatar
Simon Marlow committed
71
#ifdef i386_TARGET_ARCH
Ian Lynagh's avatar
Ian Lynagh committed
72
import StaticFlags      ( opt_Static )
Simon Marlow's avatar
Simon Marlow committed
73
#endif
Ian Lynagh's avatar
Ian Lynagh committed
74
75
import StaticFlags      ( opt_PIC, WayName(..), v_Ways, v_Build_tag,
                          v_RTS_Build_tag )
76
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
77
import DriverPhases     ( Phase(..), phaseInputExt )
78
79
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
80
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
81
import Panic
82
import UniqFM           ( UniqFM )
83
import Util
84
import Maybes           ( orElse )
85
import SrcLoc
86
import FastString
Simon Marlow's avatar
Simon Marlow committed
87
88
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
89

Ian Lynagh's avatar
Ian Lynagh committed
90
91
import Data.IORef       ( readIORef )
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
92

93
import Data.Char
94
import Data.List        ( intersperse )
Ian Lynagh's avatar
Ian Lynagh committed
95
import System.FilePath
96
import System.IO        ( stderr, hPutChar )
97

98
99
100
-- -----------------------------------------------------------------------------
-- DynFlags

101
-- | Enumerates the simple on-or-off dynamic flags
102
103
104
105
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
167
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
168
169
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
170
   | Opt_WarnImplicitPrelude
171
172
173
174
175
176
177
178
179
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
180
   | Opt_WarnMonomorphism
181
182
183
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
184
   | Opt_WarnWarningsDeprecations
185
   | Opt_WarnDeprecatedFlags
186
187
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
188
   | Opt_WarnTabs
189
   | Opt_WarnUnrecognisedPragmas
190
   | Opt_WarnDodgyForeignImports
191
192

   -- language opts
193
194
195
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
196
   | Opt_MonomorphismRestriction
197
   | Opt_MonoPatBinds
Ian Lynagh's avatar
Ian Lynagh committed
198
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
199
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
200
   | Opt_UnliftedFFITypes
Ian Lynagh's avatar
Ian Lynagh committed
201
202
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
203
   | Opt_TemplateHaskell
204
   | Opt_QuasiQuotes
205
   | Opt_ImplicitParams
206
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
207
   | Opt_ImplicitPrelude
208
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
209
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
210
   | Opt_BangPatterns
211
   | Opt_TypeFamilies
212
   | Opt_OverloadedStrings
213
   | Opt_DisambiguateRecordFields
214
   | Opt_RecordWildCards
215
   | Opt_RecordPuns
216
   | Opt_ViewPatterns
217
   | Opt_GADTs
218
   | Opt_RelaxedPolyRec
219
   | Opt_StandaloneDeriving
220
   | Opt_DeriveDataTypeable
221
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
222
   | Opt_FlexibleContexts
223
   | Opt_FlexibleInstances
224
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
225
   | Opt_MultiParamTypeClasses
226
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
227
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
228
   | Opt_PolymorphicComponents
229
   | Opt_ExistentialQuantification
230
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
231
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
232
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
233
   | Opt_ParallelListComp
234
   | Opt_TransformListComp
235
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
236
   | Opt_RecursiveDo
237
   | Opt_PostfixOperators
Ian Lynagh's avatar
Ian Lynagh committed
238
   | Opt_PatternGuards
239
   | Opt_LiberalTypeSynonyms
240
241
   | Opt_Rank2Types
   | Opt_RankNTypes
242
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
243
   | Opt_TypeOperators
244
   | Opt_PackageImports
245
   | Opt_NewQualifiedOperators
246

247
248
   | Opt_PrintExplicitForalls

249
250
251
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
252
   | Opt_StaticArgumentTransformation
253
   | Opt_CSE
254
255
   | Opt_LiberateCase
   | Opt_SpecConstr
256
257
258
259
260
261
262
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
263
   | Opt_MethodSharing
264
   | Opt_DictsCheap
265
   | Opt_InlineIfEnoughArgs
266
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
267
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
268
269
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
270
271
272
273

   -- misc opts
   | Opt_Cpp
   | Opt_Pp
274
   | Opt_ForceRecomp
275
276
277
278
279
280
281
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
282
   | Opt_HideAllPackages
283
   | Opt_PrintBindResult
284
   | Opt_Haddock
David Waern's avatar
David Waern committed
285
   | Opt_HaddockOptions
286
   | Opt_Hpc_No_Auto
287
   | Opt_BreakOnException
288
   | Opt_BreakOnError
289
   | Opt_PrintEvldWithShow
290
   | Opt_PrintBindContents
291
292
   | Opt_GenManifest
   | Opt_EmbedManifest
293
294
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
295
   | Opt_AutoLinkPackages
296
   | Opt_ImplicitImportQualified
297
298
299
300
301
302
303

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
304
   | Opt_KeepRawTokenStream
305

306
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
307

308
309
-- | Contains not only a collection of 'DynFlag's but also a plethora of
-- information relating to the compilation of a single file or GHC session
310
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
311
312
313
314
315
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
316
  hscOutName            :: String,      -- ^ Name of the output file
317
  extCoreName           :: String,      -- ^ Name of the .hcr output file
318
319
320
321
  verbosity             :: Int,         -- ^ Verbosity level: see "DynFlags#verbosity_levels"
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
322
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
323
  ruleCheck             :: Maybe String,
324

325
326
327
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
328

Ian Lynagh's avatar
Ian Lynagh committed
329
  stolen_x86_regs       :: Int,
330
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
331
332
333
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
334
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
335

336
337
  dphBackend            :: DPHBackend,

338
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
339
340

  -- ways
341
342
343
  wayNames              :: [WayName],   -- ^ Way flags from the command line
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
344

345
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
346
347
348
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
349

Ian Lynagh's avatar
Ian Lynagh committed
350
351
352
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
353

Ian Lynagh's avatar
Ian Lynagh committed
354
355
356
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
357

358
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
359
360
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
361

362
363
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
364
365
366
367
368
369
370
371
  dumpPrefixForce       :: Maybe FilePath,

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

372
373
374
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

377
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
378
379
380
381
382
383
384
385
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
386
387

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
388
389
390
391
392
393
394
395
396
  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]),
397
398
  pgm_T                 :: String,
  pgm_sysman            :: String,
399
  pgm_windres           :: String,
400

401
402
403
404
405
406
407
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],
  depWarnings           :: Bool,

408
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
409
  extraPkgConfs         :: [FilePath],
410
411
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
412
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
413
        -- they appeared.
414

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

418
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
419
  -- NB. do not modify this field, it is calculated by
420
  -- Packages.initPackages and Packages.updatePackages.
421
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
422
  pkgState              :: PackageState,
423
424

  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
425
426
  flags                 :: [DynFlag],

427
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
428
429
430
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
431
432
433
434
435
436
437
438
439
440
 }

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

441
-- | Will this target result in an object file on the disk?
442
443
444
445
446
447
448
449
450
451
452
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.
453
data GhcMode
454
455
456
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
457
458
  deriving Eq

459
460
461
462
463
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

464
465
466
467
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

468
469
470
471
472
473
-- | What to do in the link step, if there is one.
data GhcLink
  = NoLink              -- ^ Don't link at all
  | LinkBinary          -- ^ Link object code into a binary
  | LinkInMemory        -- ^ Use the in-memory dynamic linker
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
474
  deriving (Eq, Show)
475
476
477

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
478
isNoLink _      = False
479
480
481
482
483

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
484
  deriving Eq
485

twanvl's avatar
twanvl committed
486
defaultHscTarget :: HscTarget
487
488
defaultHscTarget = defaultObjectTarget

489
-- | The 'HscTarget' value corresponding to the default way to create
490
-- object files on the current platform.
twanvl's avatar
twanvl committed
491
defaultObjectTarget :: HscTarget
492
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
493
494
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
495

496
497
498
499
500
501
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

502
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
503
initDynFlags :: DynFlags -> IO DynFlags
504
505
506
507
508
509
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
510
511
512
513
        wayNames        = ways,
        buildTag        = build_tag,
        rtsBuildTag     = rts_build_tag
        }
514

515
516
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
twanvl's avatar
twanvl committed
517
defaultDynFlags :: DynFlags
518
519
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
520
521
522
523
524
525
526
527
528
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
529
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
530
        maxSimplIterations      = 4,
531
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
532
533
534
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
535
        liberateCaseThreshold   = Just 200,
Ian Lynagh's avatar
Ian Lynagh committed
536
537
538
539
540
541
542
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

543
544
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
        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
570
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
571
572
573
574
575
576
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
577
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
578
579
580

        extraPkgConfs           = [],
        packageFlags            = [],
581
582
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
583
584
585
586
587
588
589
        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",
590
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
591
592
593
594
595
596
597
598
599
600
601
602
603
        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
604
605
606
607
608
609
610
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        depWarnings       = True,
        -- end of ghc -M values
Ian Lynagh's avatar
Ian Lynagh committed
611
        haddockOptions = Nothing,
612
        flags = [
613
            Opt_AutoLinkPackages,
614
615
616
617
618
619
620
621
622
            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,

623
624
            Opt_MethodSharing,

625
626
            Opt_DoAsmMangling,

627
            Opt_GenManifest,
628
629
            Opt_EmbedManifest,
            Opt_PrintBindContents
630
631
632
633
634
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
635
        log_action = \severity srcSpan style msg ->
636
                        case severity of
637
638
639
640
641
642
643
644
                          SevInfo  -> printErrs (msg style)
                          SevFatal -> printErrs (msg style)
                          _        -> do 
                                hPutChar stderr '\n'
                                printErrs ((mkLocMessage srcSpan msg) style)
                     -- careful (#2302): printErrs prints in UTF-8, whereas
                     -- converting to string first and using hPutStr would
                     -- just emit the low 8 bits of each unicode char.
645
646
      }

Ian Lynagh's avatar
Ian Lynagh committed
647
{-
648
    #verbosity_levels#
649
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
650
651

    0   |   print errors & warnings only
652
653
654
655
656
657
658
    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"
-}

659
-- | Test whether a 'DynFlag' is set
660
661
662
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

663
-- | Set a 'DynFlag'
664
665
666
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

667
-- | Unset a 'DynFlag'
668
669
670
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

671
672
673
674
-- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
        -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
        -> [a]                  -- ^ Correctly ordered extracted options
675
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
676
        -- We add to the options from the front, so we need to reverse the list
677

678
679
-- | Gets the verbosity flag for the current verbosity level. This is fed to
-- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
680
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
681
682
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
683
684
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
685
686
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
687
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
688
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
689
690
691
692
693
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

694
695
696
697
setObjectDir  f d = d{ objectDir  = Just f}
setHiDir      f d = d{ hiDir      = Just f}
setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
  -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
Thomas Schilling's avatar
Thomas Schilling committed
698
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
699
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
700

701
702
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
703
704
705
706
setHcSuf      f d = d{ hcSuf      = f}

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

708
709
710
711
712
713
714
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) }
715
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
716

717
718
setDumpPrefixForce f d = d { dumpPrefixForce = f}

719
720
721
722
723
724
725
726
727
728
729
730
-- 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,[])}
731
setPgmwindres f d = d{ pgm_windres = f}
732
733
734
735
736
737
738
739

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}
740
addOptwindres f d = d{ opt_windres = f : opt_windres d}
741

742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }

addDepExcludeMod :: String -> DynFlags -> DynFlags
addDepExcludeMod m d
    = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }

addDepSuffix :: FilePath -> DynFlags -> DynFlags
addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }

setDepWarnings :: Bool -> DynFlags -> DynFlags
setDepWarnings b d = d { depWarnings = b }

-- XXX Legacy code:
-- We used to use "-optdep-flag -optdeparg", so for legacy applications
-- we need to strip the "-optdep" off of the arg
deOptDep :: String -> String
deOptDep x = case maybePrefixMatch "-optdep" x of
             Just rest -> rest
             Nothing -> x

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

David Waern's avatar
David Waern committed
768
769
addHaddockOpts f d = d{ haddockOptions = Just f}

770
771
772
-- -----------------------------------------------------------------------------
-- Command-line options

773
-- | When invoking external tools as part of the compilation pipeline, we
774
775
-- 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
776
-- between filepaths and 'other stuff'. The reason for this is that
777
-- this type gives us a handle on transforming filenames, and filenames only,
778
-- to whatever format they're expected to be on a particular platform.
779
780
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
781
782
783
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
784
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
785

786
787
788
789
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
790
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
791
updOptLevel n dfs
792
  = dfs2{ optLevel = final_n }
793
  where
Ian Lynagh's avatar
Ian Lynagh committed
794
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
795
796
797
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

798
799
   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
800

801
802
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
803
  = [ ([0],     Opt_IgnoreInterfacePragmas)
804
    , ([0],     Opt_OmitInterfacePragmas)
805

Ian Lynagh's avatar
Ian Lynagh committed
806
    , ([1,2],   Opt_IgnoreAsserts)
807
808
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
809
810
811
812
813
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
814

Ian Lynagh's avatar
Ian Lynagh committed
815
816
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
817
818
819
820
821
822
823
824
825
826

--     , ([2],     Opt_StaticArgumentTransformation)
-- Max writes: I think it's probably best not to enable SAT with -O2 for the
-- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
-- several improvements to the heuristics, and I'm concerned that without
-- those changes SAT will interfere with some attempts to write "high
-- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
-- this year. In particular, the version in HEAD lacks the tail call
-- criterion, so many things that look like reasonable loops will be
-- turned into functions with extra (unneccesary) thunk creation.
827
828

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
829
830
831
832
                -- 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.
833
834
835
836
837
    ]

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

twanvl's avatar
twanvl committed
838
standardWarnings :: [DynFlag]
839
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
840
    = [ Opt_WarnWarningsDeprecations,
841
        Opt_WarnDeprecatedFlags,
842
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
843
844
845
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
846
847
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
848
849
      ]

twanvl's avatar
twanvl committed
850
minusWOpts :: [DynFlag]
851
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
852
853
854
855
856
857
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
858
859
      ]

twanvl's avatar
twanvl committed
860
minusWallOpts :: [DynFlag]
861
862
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
863
864
865
866
867
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
868
869
      ]

870
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
871
minuswRemovesOpts :: [DynFlag]
872
873
874
875
876
877
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
878
       Opt_WarnUnrecognisedPragmas,
879
880
881
       Opt_WarnTabs
      ]

882
883
884
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
885
886
887
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
888

Ian Lynagh's avatar
Ian Lynagh committed
889
890
891
892
893
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
894
895
896
897
898
899
900
901
902
903
904
905
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
906
907
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
908
  | CoreDoVectorisation PackageId
Ian Lynagh's avatar
Ian Lynagh committed
909
910
  | CoreDoNothing                -- Useful when building up
  | CoreDoPasses [CoreToDo]      -- lists of these things
911

912

Ian Lynagh's avatar
Ian Lynagh committed
913
data SimplifierMode             -- See comments in SimplMonad
914
  = SimplGently
915
  | SimplPhase Int [String]
916

917
918
919
920
921
instance Outputable SimplifierMode where
    ppr SimplGently       = ptext (sLit "gentle")
    ppr (SimplPhase n ss) = int n <+> brackets (text (concat $ intersperse "," ss))


922
923
924
925
data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949

data FloatOutSwitches = FloatOutSwitches {
        floatOutLambdas :: Bool,     -- ^ True <=> float lambdas to top level
        floatOutConstants :: Bool    -- ^ True <=> float constants to top level,
                                     --            even if they do not escape a lambda
    }

instance Outputable FloatOutSwitches where
    ppr = pprFloatOutSwitches

pprFloatOutSwitches :: FloatOutSwitches -> SDoc
pprFloatOutSwitches sw = pp_not (floatOutLambdas sw) <+> text "lambdas" <> comma
                     <+> pp_not (floatOutConstants sw) <+> text "constants"
  where
    pp_not True  = empty
    pp_not False = text "not"

-- | Switches that specify the minimum amount of floating out
gentleFloatOutSwitches :: FloatOutSwitches
gentleFloatOutSwitches = FloatOutSwitches False False

-- | Switches that do not specify floating out of lambdas, just of constants
constantsOnlyFloatOutSwitches :: FloatOutSwitches
constantsOnlyFloatOutSwitches = FloatOutSwitches False True
950
951
952


-- The core-to-core pass ordering is derived from the DynFlags:
953
954
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
twanvl's avatar
twanvl committed
955
runWhen False _       = CoreDoNothing
956

957
958
959
960
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

961
962
963
964
965
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
966
    opt_level     = optLevel dflags
967
    phases        = simplPhases dflags
Ian Lynagh's avatar
Ian Lynagh committed
968
    max_iter      = maxSimplIterations dflags
969
970
971
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
972
973
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
974
    rule_check    = ruleCheck dflags
975
    static_args   = dopt Opt_StaticArgumentTransformation dflags
976

977
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
978

979
980
981
982
983
984
985
    simpl_phase phase names iter
      = CoreDoPasses
          [ CoreDoSimplify (SimplPhase phase names) [
              MaxSimplifierIterations iter
            ],
            maybe_rule_check phase
          ]
986

987
988
    vectorisation
      = runWhen (dopt Opt_Vectorise dflags)
989
        $ CoreDoPasses [ simpl_gently, CoreDoVectorisation (dphPackage dflags) ]
990
991


992
993
                -- By default, we have 2 phases before phase 0.

Ian Lynagh's avatar
Ian Lynagh committed
994
995
996
997
                -- 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.
998

Ian Lynagh's avatar
Ian Lynagh committed
999
1000
1001
1002
                -- 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
1003
    simpl_phases = CoreDoPasses [ simpl_phase phase ["main"] max_iter
1004
1005
                                  | phase <- [phases, phases-1 .. 1] ]

1006

Ian Lynagh's avatar
Ian Lynagh committed
1007
        -- initial simplify: mk specialiser happy: minimum effort please
1008
    simpl_gently = CoreDoSimplify SimplGently [
Ian Lynagh's avatar
Ian Lynagh committed
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
                        --      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
        ]
1023

rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
1024
    core_todo =
1025
     if opt_level == 0 then
1026
       [vectorisation,
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
1027
        simpl_phase 0 ["final"] max_iter]
Ian Lynagh's avatar
Ian Lynagh committed
1028
     else {- opt_level >= 1 -} [
1029

1030
1031
1032
1033
    -- 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
1034
        runWhen static_args (CoreDoPasses [ simpl_gently, CoreDoStaticArgs ]),
1035

1036
1037
        -- We run vectorisation here for now, but we might also try to run
        -- it later
1038
1039
1040
1041
        vectorisation,

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

Ian Lynagh's avatar
Ian Lynagh committed
1043
1044
1045
        -- Specialisation is best done before full laziness
        -- so that overloaded functions have all their dictionary lambdas manifest
        CoreDoSpecialising,
1046

1047
        runWhen full_laziness (CoreDoFloatOutwards gentleFloatOutSwitches),