DynFlags.hs 78 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
Ian Lynagh's avatar
Ian Lynagh committed
225
   | Opt_PatternGuards
226
   | Opt_LiberalTypeSynonyms
227 228
   | Opt_Rank2Types
   | Opt_RankNTypes
229
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
230
   | Opt_TypeOperators
231

232 233
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

316 317
  dphBackend            :: DPHBackend,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

509 510
        dphBackend              = DPHPar,

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

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

583 584
            Opt_MethodSharing,

585 586
            Opt_DoAsmMangling,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

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


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

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

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

862
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
863

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

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


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

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

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

891

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

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

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

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

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

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

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

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

936
        simpl_phases,
937

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

Ian Lynagh's avatar
Ian Lynagh committed
941 942 943 944 945 946 947 948
                -- At least 3 iterations because otherwise we land up with
                -- huge dead expressions because of an infelicity in the