DynFlags.hs 63.2 KB
Newer Older
1

2
{-# OPTIONS -fno-warn-missing-fields #-}
3 4 5 6 7 8 9
{-# OPTIONS -w #-}
-- 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

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

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

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

#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
87 88 89
import Data.IORef	( readIORef )
import Control.Exception ( throwDyn )
import Control.Monad	( when )
90
#ifdef mingw32_TARGET_OS
91
import Data.List	( isPrefixOf )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
92 93
#else
import Util		( split )
94
#endif
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
95

96
import Data.Char
Ian Lynagh's avatar
Ian Lynagh committed
97
import System.FilePath
98 99
import System.IO        ( hPutStrLn, stderr )

100 101 102 103 104 105 106
-- -----------------------------------------------------------------------------
-- DynFlags

data DynFlag

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

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

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

241 242
   | Opt_PrintExplicitForalls

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

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

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

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

310 311
  specConstrThreshold   :: Maybe Int,	-- Threshold for SpecConstr
  liberateCaseThreshold :: Maybe Int,   -- Threshold for LiberateCase 
312

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

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

  -- 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.
328 329 330 331
  objectDir		:: Maybe String,
  hiDir			:: Maybe String,
  stubDir		:: Maybe String,

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

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

340 341 342 343 344 345 346 347
  -- | 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,

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

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

359 360 361 362 363 364 365 366 367
  -- 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],
368
  opt_windres		:: [String],
369 370 371 372 373 374 375 376 377 378 379

  -- 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]),
380 381
  pgm_T                 :: String,
  pgm_sysman            :: String,
382
  pgm_windres           :: String,
383

384
  --  Package flags
385
  extraPkgConfs		:: [FilePath],
386 387
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
388 389 390 391 392 393
	-- 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

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

  -- hsc dynamic flags
401 402 403
  flags      		:: [DynFlag],
  
  -- message output
David Waern's avatar
David Waern committed
404 405 406
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

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

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

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

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

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

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
isNoLink other  = False

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

457 458 459 460 461
defaultHscTarget = defaultObjectTarget

-- | the 'HscTarget' value corresponding to the default way to create
-- object files on the current platform.
defaultObjectTarget
462 463 464
  | cGhcWithNativeCodeGen == "YES" 	=  HscAsm
  | otherwise				=  HscC

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

471 472 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
	}

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

601 602 603 604 605
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.
606

607 608
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
609 610 611 612
setHcSuf      f d = d{ hcSuf      = f}

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

614 615 616 617 618 619 620 621 622
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"

623 624
setDumpPrefixForce f d = d { dumpPrefixForce = f}

625 626 627 628 629 630 631 632 633 634 635 636
-- 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,[])}
637
setPgmwindres f d = d{ pgm_windres = f}
638 639 640 641 642 643 644 645 646

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}
647
addOptwindres f d = d{ opt_windres = f : opt_windres d}
648 649 650

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

David Waern's avatar
David Waern committed
651 652
addHaddockOpts f d = d{ haddockOptions = Just f}

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
-- -----------------------------------------------------------------------------
-- 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
676
  = dfs2{ optLevel = final_n }
677
  where
678
   final_n = max 0 (min 2 n)	-- Clamp to 0 <= n <= 2
679 680 681
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

682 683
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
684
	
685 686 687 688
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
  = [ ([0],	Opt_IgnoreInterfacePragmas)
    , ([0],     Opt_OmitInterfacePragmas)
689

690
    , ([1,2],	Opt_IgnoreAsserts)
691 692
    , ([1,2],	Opt_RewriteRules)	-- Off for -O0; see Note [Scoping for Builtin rules]
					-- 		in PrelRules
693 694 695 696 697
    , ([1,2],	Opt_DoEtaReduction)
    , ([1,2],	Opt_CaseMerge)
    , ([1,2],	Opt_Strictness)
    , ([1,2],	Opt_CSE)
    , ([1,2],	Opt_FullLaziness)
698

699 700 701 702 703 704 705 706
    , ([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.
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
    ]

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

standardWarnings
    = [ Opt_WarnDeprecations,
	Opt_WarnOverlappingPatterns,
	Opt_WarnMissingFields,
	Opt_WarnMissingMethods,
	Opt_WarnDuplicateExports
      ]

minusWOpts
    = standardWarnings ++ 
      [	Opt_WarnUnusedBinds,
	Opt_WarnUnusedMatches,
	Opt_WarnUnusedImports,
	Opt_WarnIncompletePatterns,
	Opt_WarnDodgyImports
      ]

minusWallOpts
    = minusWOpts ++
      [	Opt_WarnTypeDefaults,
	Opt_WarnNameShadowing,
	Opt_WarnMissingSigs,
	Opt_WarnHiShadows,
	Opt_WarnOrphans
      ]

738 739 740 741 742 743 744 745 746 747
-- minuswRemovesOpts should be every warning option
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
       Opt_WarnTabs
      ]

748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
-- -----------------------------------------------------------------------------
-- 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
774
  | CoreDoVectorisation
775 776
  | CoreDoNothing 		 -- Useful when building up 
  | CoreDoPasses [CoreToDo] 	 -- lists of these things
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792

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:
793 794 795
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
runWhen False do_this = CoreDoNothing
796

797 798 799 800
runMaybe :: Maybe a -> (a -> CoreToDo) -> CoreToDo
runMaybe (Just x) f = f x
runMaybe Nothing  _ = CoreDoNothing

801 802 803 804 805 806
getCoreToDo :: DynFlags -> [CoreToDo]
getCoreToDo dflags
  | Just todo <- coreToDo dflags = todo -- set explicitly by user
  | otherwise = core_todo
  where
    opt_level  	  = optLevel dflags
807
    phases        = simplPhases dflags
808 809 810 811
    max_iter   	  = maxSimplIterations dflags
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
812 813
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
814
    rule_check    = ruleCheck dflags
815
    vectorisation = dopt Opt_Vectorise dflags
816

817
    maybe_rule_check phase = runMaybe rule_check (CoreDoRuleCheck phase)
818 819 820 821 822 823 824 825

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

826 827 828 829 830 831 832 833 834 835 836 837 838 839
                -- 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] ]

840 841

	-- initial simplify: mk specialiser happy: minimum effort please
842
    simpl_gently = CoreDoSimplify SimplGently [
843 844 845 846 847 848 849 850 851 852
			-- 	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
853 854
            NoCaseOfCase,	-- Don't do case-of-case transformations.
				-- This makes full laziness work better
855
	    MaxSimplifierIterations max_iter
856 857 858 859 860 861
	]

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

863 864
	-- initial simplify: mk specialiser happy: minimum effort please
        simpl_gently,
865 866 867

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

870 871 872 873
	-- Specialisation is best done before full laziness
	-- so that overloaded functions have all their dictionary lambdas manifest
	CoreDoSpecialising,

874
	runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
875 876 877

	CoreDoFloatInwards,

878
        simpl_phases,
879 880 881 882 883 884 885 886 887 888 889

		-- 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!
890
	simpl_phase 0 (max max_iter 3),
891 892 893


#ifdef OLD_STRICTNESS
894
	CoreDoOldStrictness,
895
#endif
896 897 898 899
	runWhen strictness (CoreDoPasses [
		CoreDoStrictness,
		CoreDoWorkerWrapper,
		CoreDoGlomBinds,
900 901
                simpl_phase 0 max_iter
                ]),
902 903 904 905

	runWhen full_laziness 
	  (CoreDoFloatOutwards (FloatOutSw False    -- Not lambdas
					   True)),  -- Float constants
906 907 908 909 910 911 912
		-- 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)


913 914 915 916
	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
917 918 919

	CoreDoFloatInwards,

920
	maybe_rule_check 0,
921

922 923 924 925
		-- Case-liberation for -O2.  This should be after
		-- strictness analysis and the simplification which follows it.
	runWhen liberate_case (CoreDoPasses [
	    CoreLiberateCase,
926 927
            simpl_phase 0 max_iter
            ]),         -- Run the simplifier after LiberateCase to vastly 
928 929 930
			-- reduce the possiblility of shadowing
			-- Reason: see Note [Shadowing] in SpecConstr.lhs

931
	runWhen spec_constr CoreDoSpecConstr,
932

933
        maybe_rule_check 0,
934

935
	-- Final clean-up simplification:
936
        simpl_phase 0 max_iter
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
     ]

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

965 966 967 968
allFlags :: [String]
allFlags = map ('-':) $
           [ name | (name, optkind) <- dynamic_flags, ok optkind ] ++
           map ("fno-"++) flags ++
969 970 971
           map ("f"++) flags ++
           map ("X"++) xs ++
           map ("XNo"++) xs
972 973 974
    where ok (PrefixPred _ _) = False
          ok _ = True
          flags = map fst fFlags
975
          xs = map fst xFlags
976

977 978 979 980 981 982
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) )
983
  ,  ( "v"		, OptIntSuffix setVerbosity )
984

985 986 987 988 989 990 991 992 993 994
        ------- 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) )
995
  ,  ( "pgmwindres"     , HasArg (upd . setPgmwindres) )
996 997 998 999

  ,  ( "optL"		, HasArg (upd . addOptL) )  
  ,  ( "optP"		, HasArg (upd . addOptP) )  
  ,  ( "optF"           , HasArg (upd . addOptF) )  
1000
  ,  ( "optc"		, HasArg (upd . addOptc) )  
1001 1002 1003 1004
  ,  ( "optm"		, HasArg (upd . addOptm) )  
  ,  ( "opta"		, HasArg (upd . addOpta) )  
  ,  ( "optl"		, HasArg (upd . addOptl) )  
  ,  ( "optdep"		, HasArg (upd . addOptdep) )
1005
  ,  ( "optwindres"     , HasArg (upd . addOptwindres) )
1006

1007 1008 1009 1010
  ,  ( "split-objs"	, NoArg (if can_split
				    then setDynFlag Opt_SplitObjs
				    else return ()) )

1011 1012 1013
	-------- Linking ----------------------------------------------------
  ,  ( "c"		, NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
  ,  ( "no-link"	, NoArg (upd $ \d -> d{ ghcLink=NoLink } )) -- Dep.
1014
  ,  ( "shared"		, NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
1015
  ,  ( "dynload"	, HasArg (upd . parseDynLibLoaderMode))
1016 1017 1018

	------- Libraries ---------------------------------------------------
  ,  ( "L"		, Prefix addLibraryPath )
1019
  ,  ( "l"		, AnySuffix (\s -> do upd (addOptl s)))
1020 1021 1022 1023 1024 1025 1026

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

	------- Output Redirection ------------------------------------------
1027
  ,  ( "odir"		, HasArg (upd . setObjectDir))
1028 1029 1030 1031 1032
  ,  ( "o"		, SepArg (upd . setOutputFile . Just))
  ,  ( "ohi"		, HasArg (upd . setOutputHi   . Just ))
  ,  ( "osuf"		, HasArg (upd . setObjectSuf))
  ,  ( "hcsuf"		, HasArg (upd . setHcSuf))
  ,  ( "hisuf"		, HasArg (upd . setHiSuf))
1033
  ,  ( "hidir"		, HasArg (upd . setHiDir))
1034
  ,  ( "tmpdir"		, HasArg (upd . setTmpDir))
1035
  ,  ( "stubdir"	, HasArg (upd . setStubDir))
1036
  ,  ( "ddump-file-prefix", HasArg (upd . setDumpPrefixForce . Just))
1037 1038

	------- Keeping temporary files -------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
1039 1040 1041 1042 1043 1044 1045 1046 1047
     -- 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_KeepRawSFiles))
  ,  ( "keep-raw-s-files", NoArg (setDynFlag Opt_KeepRawSFiles))
     -- This only makes sense as plural
  ,  ( "keep-tmp-files"  , NoArg (setDynFlag Opt_KeepTmpFiles))
1048 1049 1050 1051

	------- Miscellaneous ----------------------------------------------
  ,  ( "no-hs-main"     , NoArg (setDynFlag Opt_NoHsMain))
  ,  ( "main-is"   	, SepArg setMainIs )
1052
  ,  ( "haddock"	, NoArg (setDynFlag Opt_Haddock) )