DynFlags.hs 64.3 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
  ) where

twanvl's avatar
twanvl committed
63 64
-- XXX This define is a bit of a hack, and should be done more nicely
#define FAST_STRING_NOT_NEEDED 1
65 66
#include "HsVersions.h"

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

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

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

96 97 98 99 100 101 102
-- -----------------------------------------------------------------------------
-- DynFlags

data DynFlag

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

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

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

237 238
   | Opt_PrintExplicitForalls

239 240 241 242
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
   | 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_DictsCheap
253
   | Opt_RewriteRules
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
254
   | Opt_Vectorise
255 256
   | Opt_RegsGraph			-- do graph coloring register allocation
   | Opt_RegsIterative			-- do iterative coalescing graph coloring register allocation
257 258 259 260

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

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

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

306 307
  specConstrThreshold   :: Maybe Int,	-- Threshold for SpecConstr
  liberateCaseThreshold :: Maybe Int,   -- Threshold for LiberateCase 
308

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

Simon Marlow's avatar
Simon Marlow committed
316
  thisPackage		:: PackageId,
317 318 319 320 321 322 323

  -- 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.
324 325 326 327
  objectDir		:: Maybe String,
  hiDir			:: Maybe String,
  stubDir		:: Maybe String,

328 329 330
  objectSuf		:: String,
  hcSuf			:: String,
  hiSuf			:: String,
331 332 333

  outputFile		:: Maybe String,
  outputHi		:: Maybe String,
334
  dynLibLoader		:: DynLibLoader,
335

336 337 338 339 340 341 342 343
  -- | 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,

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

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

355 356 357 358 359 360 361 362 363
  -- 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],
364
  opt_windres		:: [String],
365 366 367 368 369 370 371 372 373 374 375

  -- 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]),
376 377
  pgm_T                 :: String,
  pgm_sysman            :: String,
378
  pgm_windres           :: String,
379

380
  --  Package flags
381
  extraPkgConfs		:: [FilePath],
382 383
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
384 385 386 387 388 389
	-- 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

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

  -- hsc dynamic flags
397 398 399
  flags      		:: [DynFlag],
  
  -- message output
David Waern's avatar
David Waern committed
400 401 402
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
403 404 405 406 407 408 409 410 411 412
 }

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

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

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

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

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

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
451
  deriving Eq
452

twanvl's avatar
twanvl committed
453
defaultHscTarget :: HscTarget
454 455 456 457
defaultHscTarget = defaultObjectTarget

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

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

twanvl's avatar
twanvl committed
469
initDynFlags :: DynFlags -> IO DynFlags
470 471 472 473 474 475 476 477 478 479 480
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
481
defaultDynFlags :: DynFlags
482 483
defaultDynFlags =
     DynFlags {
484 485
	ghcMode			= CompManager,
	ghcLink			= LinkBinary,
486 487 488 489 490 491 492
	coreToDo 		= Nothing,
	stgToDo			= Nothing, 
	hscTarget		= defaultHscTarget, 
	hscOutName		= "", 
	extCoreName		= "",
	verbosity		= 0, 
	optLevel		= 0,
493
        simplPhases             = 2,
494 495
	maxSimplIterations	= 4,
	ruleCheck		= Nothing,
496 497
	specConstrThreshold	= Just 200,
        liberateCaseThreshold   = Just 200,
498 499 500
	stolen_x86_regs		= 4,
	cmdlineHcIncludes	= [],
	importPaths		= ["."],
501
	mainModIs		= mAIN,
502
	mainFunIs		= Nothing,
503 504
	ctxtStkDepth		= mAX_CONTEXT_REDUCTION_DEPTH,

Simon Marlow's avatar
Simon Marlow committed
505
	thisPackage		= mainPackageId,
506

507 508 509 510
	objectDir		= Nothing,
	hiDir			= Nothing,
	stubDir			= Nothing,

511 512 513
	objectSuf		= phaseInputExt StopLn,
	hcSuf			= phaseInputExt HCc,
	hiSuf			= "hi",
514 515 516

	outputFile		= Nothing,
	outputHi		= Nothing,
517
	dynLibLoader		= Deployable,
518 519
	dumpPrefix		= Nothing,
	dumpPrefixForce		= Nothing,
520 521 522 523
	includePaths		= [],
	libraryPaths		= [],
	frameworkPaths		= [],
	cmdlineFrameworks	= [],
524
	tmpDir			= cDEFAULT_TMPDIR,
525
	
andy@galois.com's avatar
andy@galois.com committed
526 527
        hpcDir		        = ".hpc",

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

            Opt_DoAsmMangling,

557
            Opt_GenManifest,
558 559
            Opt_EmbedManifest,
            Opt_PrintBindContents
560 561 562 563 564
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

565 566 567 568 569
        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))
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
      }

{- 
    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
601 602 603 604 605 606 607 608
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

609 610 611 612 613
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.
614

615 616
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
617 618 619 620
setHcSuf      f d = d{ hcSuf      = f}

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

622 623 624 625 626 627 628 629 630
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"

631 632
setDumpPrefixForce f d = d { dumpPrefixForce = f}

633 634 635 636 637 638 639 640 641 642 643 644
-- 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,[])}
645
setPgmwindres f d = d{ pgm_windres = f}
646 647 648 649 650 651 652 653 654

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}
655
addOptwindres f d = d{ opt_windres = f : opt_windres d}
656 657 658

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

David Waern's avatar
David Waern committed
659 660
addHaddockOpts f d = d{ haddockOptions = Just f}

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
-- -----------------------------------------------------------------------------
-- 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
684
  = dfs2{ optLevel = final_n }
685
  where
686
   final_n = max 0 (min 2 n)	-- Clamp to 0 <= n <= 2
687 688 689
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

690 691
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
692
	
693 694 695 696
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
  = [ ([0],	Opt_IgnoreInterfacePragmas)
    , ([0],     Opt_OmitInterfacePragmas)
697

698
    , ([1,2],	Opt_IgnoreAsserts)
699 700
    , ([1,2],	Opt_RewriteRules)	-- Off for -O0; see Note [Scoping for Builtin rules]
					-- 		in PrelRules
701 702 703 704 705
    , ([1,2],	Opt_DoEtaReduction)
    , ([1,2],	Opt_CaseMerge)
    , ([1,2],	Opt_Strictness)
    , ([1,2],	Opt_CSE)
    , ([1,2],	Opt_FullLaziness)
706

707 708 709 710 711 712 713 714
    , ([2],	Opt_LiberateCase)
    , ([2],	Opt_SpecConstr)

    , ([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.
715 716 717 718 719
    ]

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

twanvl's avatar
twanvl committed
720
standardWarnings :: [DynFlag]
721 722 723 724 725 726 727 728
standardWarnings
    = [ Opt_WarnDeprecations,
	Opt_WarnOverlappingPatterns,
	Opt_WarnMissingFields,
	Opt_WarnMissingMethods,
	Opt_WarnDuplicateExports
      ]

twanvl's avatar
twanvl committed
729
minusWOpts :: [DynFlag]
730 731 732 733 734 735 736 737 738
minusWOpts
    = standardWarnings ++ 
      [	Opt_WarnUnusedBinds,
	Opt_WarnUnusedMatches,
	Opt_WarnUnusedImports,
	Opt_WarnIncompletePatterns,
	Opt_WarnDodgyImports
      ]

twanvl's avatar
twanvl committed
739
minusWallOpts :: [DynFlag]
740 741 742 743 744 745 746 747 748
minusWallOpts
    = minusWOpts ++
      [	Opt_WarnTypeDefaults,
	Opt_WarnNameShadowing,
	Opt_WarnMissingSigs,
	Opt_WarnHiShadows,
	Opt_WarnOrphans
      ]

749
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
750
minuswRemovesOpts :: [DynFlag]
751 752 753 754 755 756 757 758 759
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
       Opt_WarnTabs
      ]

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
-- -----------------------------------------------------------------------------
-- 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
786
  | CoreDoVectorisation
787 788
  | CoreDoNothing 		 -- Useful when building up 
  | CoreDoPasses [CoreToDo] 	 -- lists of these things
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804

data SimplifierMode 		-- See comments in SimplMonad
  = SimplGently
  | SimplPhase Int

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:
805 806
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
twanvl's avatar
twanvl committed
807
runWhen False _       = CoreDoNothing
808

809 810 811 812
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

813 814 815 816 817 818
getCoreToDo :: DynFlags -> [CoreToDo]
getCoreToDo dflags
  | Just todo <- coreToDo dflags = todo -- set explicitly by user
  | otherwise = core_todo
  where
    opt_level  	  = optLevel dflags
819
    phases        = simplPhases dflags
820 821 822 823
    max_iter   	  = maxSimplIterations dflags
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
824 825
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
826
    rule_check    = ruleCheck dflags
827
    vectorisation = dopt Opt_Vectorise dflags
828

829
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
830 831 832 833 834 835 836 837

    simpl_phase phase iter = CoreDoPasses
                               [ CoreDoSimplify (SimplPhase phase) [
                                   MaxSimplifierIterations iter
                                 ],
                                 maybe_rule_check phase
                               ]

838 839 840 841 842 843 844 845 846 847 848 849 850 851
                -- 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
    simpl_phases = CoreDoPasses [ simpl_phase phase max_iter
                                  | phase <- [phases, phases-1 .. 1] ]

852 853

	-- initial simplify: mk specialiser happy: minimum effort please
854
    simpl_gently = CoreDoSimplify SimplGently [
855 856 857 858 859 860 861 862 863 864
			-- 	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
865 866
            NoCaseOfCase,	-- Don't do case-of-case transformations.
				-- This makes full laziness work better
867
	    MaxSimplifierIterations max_iter
868 869 870 871 872 873
	]

    core_todo = 
     if opt_level == 0 then
       [simpl_phase 0 max_iter]
     else {- opt_level >= 1 -} [ 
874

875 876
	-- initial simplify: mk specialiser happy: minimum effort please
        simpl_gently,
877 878 879

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

882 883 884 885
	-- Specialisation is best done before full laziness
	-- so that overloaded functions have all their dictionary lambdas manifest
	CoreDoSpecialising,

886
	runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
887 888 889

	CoreDoFloatInwards,

890
        simpl_phases,
891 892 893 894 895 896 897 898 899 900 901

		-- 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!
902
	simpl_phase 0 (max max_iter 3),
903 904 905


#ifdef OLD_STRICTNESS
906
	CoreDoOldStrictness,
907
#endif
908 909 910 911
	runWhen strictness (CoreDoPasses [
		CoreDoStrictness,
		CoreDoWorkerWrapper,
		CoreDoGlomBinds,
912 913
                simpl_phase 0 max_iter
                ]),
914 915 916 917

	runWhen full_laziness 
	  (CoreDoFloatOutwards (FloatOutSw False    -- Not lambdas
					   True)),  -- Float constants
918 919 920 921 922 923 924
		-- 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)


925 926 927 928
	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
929 930 931

	CoreDoFloatInwards,

932
	maybe_rule_check 0,
933

934 935 936 937
		-- Case-liberation for -O2.  This should be after
		-- strictness analysis and the simplification which follows it.
	runWhen liberate_case (CoreDoPasses [
	    CoreLiberateCase,
938 939
            simpl_phase 0 max_iter
            ]),         -- Run the simplifier after LiberateCase to vastly 
940 941 942
			-- reduce the possiblility of shadowing
			-- Reason: see Note [Shadowing] in SpecConstr.lhs

943
	runWhen spec_constr CoreDoSpecConstr,
944

945
        maybe_rule_check 0,
946

947
	-- Final clean-up simplification:
948
        simpl_phase 0 max_iter
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
     ]

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

977 978 979 980
allFlags :: [String]
allFlags = map ('-':) $
           [ name | (name, optkind) <- dynamic_flags, ok optkind ] ++
           map ("fno-"++) flags ++
981 982 983
           map ("f"++) flags ++
           map ("X"++) xs ++
           map ("XNo"++) xs
984 985 986
    where ok (PrefixPred _ _) = False
          ok _ = True
          flags = map fst fFlags
987
          xs = map fst xFlags
988

989 990 991 992 993 994
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) )
995
  ,  ( "v"		, OptIntSuffix setVerbosity )
996

997 998 999 1000 1001 1002 1003 1004 1005 1006
        ------- 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) )
1007
  ,  ( "pgmwindres"     , HasArg (upd . setPgmwindres) )
1008 1009 1010 1011

  ,  ( "optL"		, HasArg (upd . addOptL) )  
  ,  ( "optP"		, HasArg (upd . addOptP) )  
  ,  ( "optF"           , HasArg (upd . addOptF) )  
1012
  ,  ( "optc"		, HasArg (upd . addOptc) )  
1013 1014 1015 1016
  ,  ( "optm"		, HasArg (upd . addOptm) )  
  ,  ( "opta"		, HasArg (upd . addOpta) )  
  ,  ( "optl"		, HasArg (upd . addOptl) )  
  ,  ( "optdep"		, HasArg (upd . addOptdep) )
1017
  ,  ( "optwindres"     , HasArg (upd . addOptwindres) )
1018

1019 1020 1021 1022
  ,  ( "split-objs"	, NoArg (if can_split
				    then setDynFlag Opt_SplitObjs
				    else return ()) )

1023 1024 1025
	-------- Linking ----------------------------------------------------
  ,  ( "c"		, NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
  ,  ( "no-link"	, NoArg (upd $ \d -> d{ ghcLink=NoLink } )) -- Dep.
1026
  ,  ( "shared"		, NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
1027
  ,  ( "dynload"	, HasArg (upd . parseDynLibLoaderMode))
1028 1029 1030

	------- Libraries ---------------------------------------------------
  ,  ( "L"		, Prefix addLibraryPath )
1031
  ,  ( "l"		, AnySuffix (\s -> do upd (addOptl s)))
1032 1033 1034 1035 1036 1037 1038

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

	------- Output Redirection ------------------------------------------