DynFlags.hs 66.9 KB
Newer Older
1

2
{-# OPTIONS -fno-warn-missing-fields #-}
3 4 5 6 7 8
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
-- for details

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
-----------------------------------------------------------------------------
--
-- 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 (
	-- Dynamic flags
	DynFlag(..),
	DynFlags(..),
26
	HscTarget(..), isObjectTarget, defaultObjectTarget,
27 28 29 30
	GhcMode(..), isOneShot,
	GhcLink(..), isNoLink,
	PackageFlag(..),
	Option(..),
31
	DynLibLoader(..),
32
        fFlags, xFlags,
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

	-- 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,
50
	setTmpDir,
51
	setPackageName,
52 53 54
	
	-- parsing DynFlags
	parseDynamicFlags,
55
        allFlags,
56 57

	-- misc stuff
Ian Lynagh's avatar
Ian Lynagh committed
58 59
	machdepCCOpts, picCCOpts,
    supportedLanguages,
60
    compilerInfo,
61 62 63 64
  ) where

#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
86 87 88
import Data.IORef	( readIORef )
import Control.Exception ( throwDyn )
import Control.Monad	( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
89

90
import Data.Char
Ian Lynagh's avatar
Ian Lynagh committed
91
import System.FilePath
92 93
import System.IO        ( hPutStrLn, stderr )

94 95 96 97 98 99 100
-- -----------------------------------------------------------------------------
-- DynFlags

data DynFlag

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

161
   | Opt_WarnIsError			-- -Werror; makes warnings fatal
162 163
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
164
   | Opt_WarnImplicitPrelude
165 166 167 168 169 170 171 172 173
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
174
   | Opt_WarnMonomorphism
175 176 177 178 179 180
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnDeprecations
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
181
   | Opt_WarnTabs
182 183

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

236 237
   | Opt_PrintExplicitForalls

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

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

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

291
   deriving (Eq, Show)
292
 
293 294 295 296 297 298 299 300 301 302
data DynFlags = DynFlags {
  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
303
  simplPhases           :: Int,         -- number of simplifier phases
304
  maxSimplIterations    :: Int,		-- max simplifier iterations
305
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
306
  ruleCheck		:: Maybe String,
307

308
  specConstrThreshold   :: Maybe Int,	-- Threshold for SpecConstr
309
  specConstrCount	:: Maybe Int,	-- Max number of specialisations for any one function
310
  liberateCaseThreshold :: Maybe Int,   -- Threshold for LiberateCase 
311

312 313 314
  stolen_x86_regs	:: Int,		
  cmdlineHcIncludes	:: [String],	-- -#includes
  importPaths		:: [FilePath],
315
  mainModIs		:: Module,
316
  mainFunIs		:: Maybe String,
317 318
  ctxtStkDepth	        :: Int,		-- Typechecker context stack depth

Simon Marlow's avatar
Simon Marlow committed
319
  thisPackage		:: PackageId,
320 321 322 323 324 325 326

  -- ways
  wayNames		:: [WayName],	-- way flags from the cmd line
  buildTag		:: String,	-- the global "way" (eg. "p" for prof)
  rtsBuildTag		:: String,	-- the RTS "way"
  
  -- paths etc.
327 328 329 330
  objectDir		:: Maybe String,
  hiDir			:: Maybe String,
  stubDir		:: Maybe String,

331 332 333
  objectSuf		:: String,
  hcSuf			:: String,
  hiSuf			:: String,
334 335 336

  outputFile		:: Maybe String,
  outputHi		:: Maybe String,
337
  dynLibLoader		:: DynLibLoader,
338

339 340 341 342 343 344 345 346
  -- | This is set by DriverPipeline.runPipeline based on where
  --	its output is going.
  dumpPrefix		:: Maybe FilePath,

  -- | Override the dumpPrefix set by runPipeline.
  --	Set by -ddump-file-prefix
  dumpPrefixForce	:: Maybe FilePath,

347 348 349 350
  includePaths		:: [String],
  libraryPaths		:: [String],
  frameworkPaths	:: [String],  	-- used on darwin only
  cmdlineFrameworks	:: [String],	-- ditto
351
  tmpDir		:: String,	-- no trailing '/'
352
  
353 354 355
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

358 359 360 361 362 363 364 365 366
  -- options for particular phases
  opt_L			:: [String],
  opt_P			:: [String],
  opt_F			:: [String],
  opt_c			:: [String],
  opt_m			:: [String],
  opt_a			:: [String],
  opt_l			:: [String],
  opt_dep		:: [String],
367
  opt_windres		:: [String],
368 369 370 371 372 373 374 375 376 377 378

  -- commands for particular phases
  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
384
  extraPkgConfs		:: [FilePath],
385 386
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
387 388 389 390 391 392
	-- The -package-conf flags given on the command line, in the order
	-- they appeared.

  packageFlags		:: [PackageFlag],
	-- The -package and -hide-package flags from the command-line

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

  -- hsc dynamic flags
400 401 402
  flags      		:: [DynFlag],
  
  -- 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 430 431
  = CompManager         -- ^ --make, GHCi, etc.
  | OneShot		-- ^ ghc -c Foo.hs
  | 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.
439
data GhcLink	-- What to do in the link step, if there is one
440 441 442
  = NoLink		-- Don't link at all
  | LinkBinary		-- Link object code into a binary
  | LinkInMemory        -- Use the in-memory dynamic linker
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
463 464 465
  | cGhcWithNativeCodeGen == "YES" 	=  HscAsm
  | otherwise				=  HscC

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 479 480 481 482 483
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{
	wayNames	= ways,
	buildTag	= build_tag,
	rtsBuildTag	= rts_build_tag
	}

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

Simon Marlow's avatar
Simon Marlow committed
510
	thisPackage		= mainPackageId,
511

512 513 514 515
	objectDir		= Nothing,
	hiDir			= Nothing,
	stubDir			= Nothing,

516 517 518
	objectSuf		= phaseInputExt StopLn,
	hcSuf			= phaseInputExt HCc,
	hiSuf			= "hi",
519 520 521

	outputFile		= Nothing,
	outputHi		= Nothing,
522
	dynLibLoader		= Deployable,
523 524
	dumpPrefix		= Nothing,
	dumpPrefixForce		= Nothing,
525 526 527 528
	includePaths		= [],
	libraryPaths		= [],
	frameworkPaths		= [],
	cmdlineFrameworks	= [],
529
	tmpDir			= cDEFAULT_TMPDIR,
530
	
andy@galois.com's avatar
andy@galois.com committed
531 532
        hpcDir		        = ".hpc",

533
	opt_L			= [],
534 535 536
	opt_P			= (if opt_PIC
				   then ["-D__PIC__"]
				   else []),
537 538 539 540 541 542
	opt_F			= [],
	opt_c			= [],
	opt_a			= [],
	opt_m			= [],
	opt_l			= [],
	opt_dep			= [],
543
        opt_windres             = [],
544 545 546
	
	extraPkgConfs		= [],
	packageFlags		= [],
547 548
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
David Waern's avatar
David Waern committed
549
  haddockOptions = Nothing,
550 551 552 553 554 555 556 557 558 559
        flags = [
            Opt_ReadUserPackageConf,

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

            Opt_ImplicitPrelude,
            Opt_MonomorphismRestriction,

560 561
            Opt_MethodSharing,

562 563
            Opt_DoAsmMangling,

564
            Opt_GenManifest,
565 566
            Opt_EmbedManifest,
            Opt_PrintBindContents
567 568 569 570 571
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

572 573 574 575 576
        log_action = \severity srcSpan style msg -> 
                        case severity of
                          SevInfo  -> hPutStrLn stderr (show (msg style))
                          SevFatal -> hPutStrLn stderr (show (msg style))
                          _        -> hPutStrLn stderr ('\n':show ((mkLocMessage srcSpan msg) style))
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
      }

{- 
    Verbosity levels:
	
    0	|   print errors & warnings only
    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)
	-- We add to the options from the front, so we need to reverse the list

getVerbFlag :: DynFlags -> String
getVerbFlag dflags 
  | verbosity dflags >= 3  = "-v" 
  | otherwise =  ""

twanvl's avatar
twanvl committed
608 609 610 611 612 613 614 615
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

616 617 618 619 620
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.
621

622 623
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
624 625 626 627
setHcSuf      f d = d{ hcSuf      = f}

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

629 630 631 632 633 634 635 636 637
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"

638 639
setDumpPrefixForce f d = d { dumpPrefixForce = f}

640 641 642 643 644 645 646 647 648 649 650 651
-- 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,[])}
652
setPgmwindres f d = d{ pgm_windres = f}
653 654 655 656 657 658 659 660 661

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}
662
addOptwindres f d = d{ opt_windres = f : opt_windres d}
663 664 665

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

David Waern's avatar
David Waern committed
666 667
addHaddockOpts f d = d{ haddockOptions = Just f}

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
-- -----------------------------------------------------------------------------
-- 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.
              String  -- a non-filepath prefix that shouldn't be 
		      -- transformed (e.g., "/out=")
 	      String  -- the filepath/filename portion
 | Option     String
 
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
-- Set dynflags appropriate to the optimisation level
updOptLevel n dfs
691
  = dfs2{ optLevel = final_n }
692
  where
693
   final_n = max 0 (min 2 n)	-- Clamp to 0 <= n <= 2
694 695 696
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

697 698
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
699
	
700 701 702 703
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
  = [ ([0],	Opt_IgnoreInterfacePragmas)
    , ([0],     Opt_OmitInterfacePragmas)
704

705
    , ([1,2],	Opt_IgnoreAsserts)
706 707
    , ([1,2],	Opt_RewriteRules)	-- Off for -O0; see Note [Scoping for Builtin rules]
					-- 		in PrelRules
708 709 710 711 712
    , ([1,2],	Opt_DoEtaReduction)
    , ([1,2],	Opt_CaseMerge)
    , ([1,2],	Opt_Strictness)
    , ([1,2],	Opt_CSE)
    , ([1,2],	Opt_FullLaziness)
713

714 715
    , ([2],	Opt_LiberateCase)
    , ([2],	Opt_SpecConstr)
716
    , ([2],	Opt_StaticArgumentTransformation)
717 718 719 720 721 722

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
		-- 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.
723 724 725 726 727
    ]

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

twanvl's avatar
twanvl committed
728
standardWarnings :: [DynFlag]
729 730 731 732 733 734 735 736
standardWarnings
    = [ Opt_WarnDeprecations,
	Opt_WarnOverlappingPatterns,
	Opt_WarnMissingFields,
	Opt_WarnMissingMethods,
	Opt_WarnDuplicateExports
      ]

twanvl's avatar
twanvl committed
737
minusWOpts :: [DynFlag]
738 739 740 741 742 743 744 745 746
minusWOpts
    = standardWarnings ++ 
      [	Opt_WarnUnusedBinds,
	Opt_WarnUnusedMatches,
	Opt_WarnUnusedImports,
	Opt_WarnIncompletePatterns,
	Opt_WarnDodgyImports
      ]

twanvl's avatar
twanvl committed
747
minusWallOpts :: [DynFlag]
748 749 750 751 752 753 754 755 756
minusWallOpts
    = minusWOpts ++
      [	Opt_WarnTypeDefaults,
	Opt_WarnNameShadowing,
	Opt_WarnMissingSigs,
	Opt_WarnHiShadows,
	Opt_WarnOrphans
      ]

757
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
758
minuswRemovesOpts :: [DynFlag]
759 760 761 762 763 764 765 766 767
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
       Opt_WarnTabs
      ]

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

data CoreToDo		-- These are diff core-to-core passes,
			-- which may be invoked in any order,
  			-- as many times as you like.

  = CoreDoSimplify	-- The core-to-core simplifier.
	SimplifierMode
	[SimplifierSwitch]
			-- Each run of the simplifier can take a different
			-- set of simplifier-specific flags.
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
  | CoreDoRuleCheck Int{-CompilerPhase-} String	-- Check for non-application of rules 
						-- matching this string
794
  | CoreDoVectorisation
795 796
  | CoreDoNothing 		 -- Useful when building up 
  | CoreDoPasses [CoreToDo] 	 -- lists of these things
797 798 799

data SimplifierMode 		-- See comments in SimplMonad
  = SimplGently
800
  | SimplPhase Int [String]
801 802 803 804 805 806 807 808 809 810 811 812

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

data FloatOutSwitches
  = FloatOutSw  Bool 	-- True <=> float lambdas to top level
		Bool	-- True <=> float constants to top level,
			-- 	    even if they do not escape a lambda


-- The core-to-core pass ordering is derived from the DynFlags:
813 814
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
twanvl's avatar
twanvl committed
815
runWhen False _       = CoreDoNothing
816

817 818 819 820
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

821 822 823 824 825 826
getCoreToDo :: DynFlags -> [CoreToDo]
getCoreToDo dflags
  | Just todo <- coreToDo dflags = todo -- set explicitly by user
  | otherwise = core_todo
  where
    opt_level  	  = optLevel dflags
827
    phases        = simplPhases dflags
828 829 830 831
    max_iter   	  = maxSimplIterations dflags
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
832 833
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
834
    rule_check    = ruleCheck dflags
835
    vectorisation = dopt Opt_Vectorise dflags
Simon Marlow's avatar
Simon Marlow committed
836
    -- static_args   = dopt Opt_StaticArgumentTransformation dflags
837

838
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
839

840 841 842 843 844 845 846
    simpl_phase phase names iter
      = CoreDoPasses
          [ CoreDoSimplify (SimplPhase phase names) [
              MaxSimplifierIterations iter
            ],
            maybe_rule_check phase
          ]
847

848 849 850 851 852 853 854 855 856 857 858
                -- By default, we have 2 phases before phase 0.

		-- 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.

		-- 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
859
    simpl_phases = CoreDoPasses [ simpl_phase phase ["main"] max_iter
860 861
                                  | phase <- [phases, phases-1 .. 1] ]

862 863

	-- initial simplify: mk specialiser happy: minimum effort please
864
    simpl_gently = CoreDoSimplify SimplGently [
865 866 867 868 869 870 871 872 873 874
			-- 	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.

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
875 876
            NoCaseOfCase,	-- Don't do case-of-case transformations.
				-- This makes full laziness work better
877
	    MaxSimplifierIterations max_iter
878 879
	]

rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
880
    core_todo =
881
     if opt_level == 0 then
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
882 883
       [runWhen vectorisation (CoreDoPasses [ simpl_gently, CoreDoVectorisation ]),
        simpl_phase 0 ["final"] max_iter]
884
     else {- opt_level >= 1 -} [ 
885

886 887 888 889
    -- 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
Simon Marlow's avatar
Simon Marlow committed
890 891
	    -- runWhen static_args CoreDoStaticArgs,
            -- XXX disabled, see #2321
892

893 894
	-- initial simplify: mk specialiser happy: minimum effort please
        simpl_gently,
895 896 897

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

900 901 902 903
	-- Specialisation is best done before full laziness
	-- so that overloaded functions have all their dictionary lambdas manifest
	CoreDoSpecialising,

904
	runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
905 906 907

	CoreDoFloatInwards,

908
        simpl_phases,
909 910 911 912 913 914 915 916 917 918 919

		-- Phase 0: allow all Ids to be inlined now
		-- This gets foldr inlined before strictness analysis

		-- 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!
920
	simpl_phase 0 ["main"] (max max_iter 3),
921 922 923


#ifdef OLD_STRICTNESS
924
	CoreDoOldStrictness,
925
#endif
926 927 928 929
	runWhen strictness (CoreDoPasses [
		CoreDoStrictness,
		CoreDoWorkerWrapper,
		CoreDoGlomBinds,
930
                simpl_phase 0 ["post-worker-wrapper"] max_iter
931
                ]),
932 933 934 935

	runWhen full_laziness 
	  (CoreDoFloatOutwards (FloatOutSw False    -- Not lambdas
					   True)),  -- Float constants
936 937 938 939 940 941 942
		-- 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)


943 944 945 946
	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
947 948 949

	CoreDoFloatInwards,

950
	maybe_rule_check 0,
951

952 953 954 955
		-- Case-liberation for -O2.  This should be after
		-- strictness analysis and the simplification which follows it.
	runWhen liberate_case (CoreDoPasses [
	    CoreLiberateCase,
956
            simpl_phase 0 ["post-liberate-case"] max_iter
957
            ]),         -- Run the simplifier after LiberateCase to vastly 
958 959 960
			-- reduce the possiblility of shadowing
			-- Reason: see Note [Shadowing] in SpecConstr.lhs

961
	runWhen spec_constr CoreDoSpecConstr,
962

963
        maybe_rule_check 0,
964

965
	-- Final clean-up simplification:
966
        simpl_phase 0 ["final"] max_iter
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
     ]

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

	todo1 = if stg_stats then [D_stg_stats] else []

	todo2 | WayProf `elem` wayNames dflags
	      = StgDoMassageForProfiling : todo1
	      | otherwise
	      = todo1

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

995 996 997 998
allFlags :: [String]
allFlags = map ('-':) $
           [ name | (name, optkind) <- dynamic_flags, ok optkind ] ++
           map ("fno-"++) flags ++
999 1000 1001
           map ("f"++) flags ++
           map ("X"++) xs ++
           map ("XNo"++) xs
1002 1003 1004
    where ok (PrefixPred _ _) = False
          ok _ = True
          flags = map fst fFlags
1005
          xs = map fst xFlags
1006

1007 1008 1009 1010 1011 1012
dynamic_flags :: [(String, OptKind DynP)]
dynamic_flags = [
     ( "n"              , NoArg  (setDynFlag Opt_DryRun) )
  ,  ( "cpp"		, NoArg  (setDynFlag Opt_Cpp))
  ,  ( "F"		, NoArg  (setDynFlag Opt_Pp))
  ,  ( "#include"	, HasArg (addCmdlineHCInclude) )
1013
  ,  ( "v"		, OptIntSuffix setVerbosity )
1014

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
        ------- Specific phases  --------------------------------------------
  ,  ( "pgmL"           , HasArg (upd . setPgmL) )  
  ,  ( "pgmP"           , HasArg (upd . setPgmP) )  
  ,  ( "pgmF"           , HasArg (upd . setPgmF) )  
  ,  ( "pgmc"           , HasArg (upd . setPgmc) )  
  ,  ( "pgmm"           , HasArg (upd . setPgmm) )  
  ,  ( "pgms"           , HasArg (upd . setPgms) )  
  ,  ( "pgma"           , HasArg (upd . setPgma) )  
  ,  ( "pgml"           , HasArg (upd . setPgml) )  
  ,  ( "pgmdll"		, HasArg (upd . setPgmdll) )
1025
  ,  ( "pgmwindres"     , HasArg (upd . setPgmwindres) )
1026 1027 1028 1029

  ,  ( "optL"		, HasArg (upd . addOptL) )  
  ,  ( "optP"		, HasArg (upd . addOptP) )  
  ,  ( "optF"           , HasArg (upd . addOptF) )  
1030
  ,  ( "optc"		, HasArg (upd . addOptc) )  
1031 1032 1033 1034
  ,  ( "optm"		, HasArg (upd . addOptm) )  
  ,  ( "opta"		, HasArg (upd . addOpta) )  
  ,  ( "optl"		, HasArg (upd . addOptl) )  
  ,  ( "optdep"		, HasArg (upd . addOptdep) )
1035
  ,  ( "optwindres"     , HasArg (upd . addOptwindres) )
1036

1037 1038 1039 1040
  ,  ( "split-objs"	, NoArg (if can_split
				    then setDynFlag Opt_SplitObjs
				    else return ()) )

1041 1042 1043
	-------- Linking ----------------------------------------------------
  ,  ( "c"		, NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
  ,  ( "no-link"	, NoArg (upd $ \d -> d{ ghcLink=NoLink } )) -- Dep.
1044
  ,  ( "shared"		, NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
1045
  ,  ( "dynload"	, HasArg (upd . parseDynLibLoaderMode))
1046 1047 1048

	------- Libraries ---------------------------------------------------
  ,  ( "L"		, Prefix addLibraryPath )
1049
  ,  ( "l"		, AnySuffix (\s -> do upd (addOptl s)))
1050 1051 1052 1053 1054 1055 1056

	------- Frameworks --------------------------------------------------
        -- -framework-path should really be -F ...
  ,  ( "framework-path" , HasArg addFrameworkPath )
  ,  ( "framework"	, HasArg (upd . addCmdlineFramework) )

	------- Output Redirection ------------------------------------------
1057
  ,  ( "odir"		, HasArg (upd . setObjectDir))
1058 1059 1060 1061 1062
  ,  ( "o"		, SepArg (upd . setOutputFile . Just))
  ,  ( "ohi"		, HasArg (upd . setOutputHi   . Just ))
  ,  ( "osuf"		, HasArg (upd . setObjectSuf))
  ,  ( "hcsuf"		, HasArg (upd . setHcSuf))
  ,  ( "hisuf"		, HasArg (upd . setHiSuf))
1063
  ,  ( "hidir"		, HasArg (upd . setHiDir))
1064
  ,  ( "tmpdir"		, HasArg (upd . setTmpDir))
1065
  ,  ( "stubdir"	, HasArg (upd . setStubDir))
1066
  ,  ( "ddump-file-prefix", HasArg (upd . setDumpPrefixForce . Just))
1067 1068

	------- Keeping temporary files -------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
1069 1070 1071 1072 1073 1074 1075 1076 1077
     -- These can be singular (think ghc -c) or plural (think ghc --make)
  ,  ( "keep-hc-file"    , NoArg (setDynFlag Opt_KeepHcFiles))
  ,  ( "keep-hc-files"   , NoArg (setDynFlag Opt_KeepHcFiles))
  ,  ( "keep-s-file"     , NoArg (setDynFlag Opt_KeepSFiles))
  ,  ( "keep-s-files"    , NoArg (setDynFlag Opt_KeepSFiles))
  ,  ( "keep-raw-s-file" , NoArg (setDynFlag Opt_