1 -----------------------------------------------------------------------------
5 -- Static flags can only be set once, on the command-line. Inside GHC,
6 -- each static flag corresponds to a top-level value, usually of type Bool.
8 -- (c) The University of Glasgow 2005
10 -----------------------------------------------------------------------------
13 -- The above warning supression flag is a temporary kludge.
14 -- While working on this module you are encouraged to remove it and fix
15 -- any warnings in the module. See
16 -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
25 WayName(..), v_Ways, v_Build_tag, v_RTS_Build_tag, isRTSWay,
27 -- Output style options
32 opt_AutoSccsOnAllToplevs,
33 opt_AutoSccsOnExportedToplevs,
34 opt_AutoSccsOnIndividualCafs,
43 opt_IrrefutableTuples,
52 opt_SimplNoPreInlining,
53 opt_SimplExcessPrecision,
57 opt_UF_CreationThreshold,
59 opt_UF_FunAppDiscount,
82 #include "HsVersions.h"
86 import FastString ( FastString, mkFastString )
88 import Maybes ( firstJust )
91 import Control.Exception ( throwDyn )
93 import System.IO.Unsafe ( unsafePerformIO )
94 import Control.Monad ( when )
95 import Data.Char ( isDigit )
98 -----------------------------------------------------------------------------
101 parseStaticFlags :: [String] -> IO [String]
102 parseStaticFlags args = do
103 ready <- readIORef v_opt_C_ready
104 when ready $ throwDyn (ProgramError "Too late for parseStaticFlags: call it before newSession")
106 (leftover, errs) <- processArgs static_flags args
107 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
109 -- deal with the way flags: the way (eg. prof) gives rise to
110 -- further flags, some of which might be static.
111 way_flags <- findBuildTag
113 -- if we're unregisterised, add some more flags
114 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
117 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
119 -- see sanity code in staticOpts
120 writeIORef v_opt_C_ready True
122 -- TABLES_NEXT_TO_CODE affects the info table layout.
123 -- Be careful to do this *after* all processArgs,
124 -- because evaluating tablesNextToCode involves looking at the global
125 -- static flags. Those pesky global variables...
126 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
129 -- HACK: -fexcess-precision is both a static and a dynamic flag. If
130 -- the static flag parser has slurped it, we must return it as a
131 -- leftover too. ToDo: make -fexcess-precision dynamic only.
132 let excess_prec | opt_SimplExcessPrecision = ["-fexcess-precision"]
135 when (not (null errs)) $ ghcError (UsageError (unlines errs))
136 return (excess_prec++cg_flags++more_leftover++leftover)
138 initStaticOpts :: IO ()
139 initStaticOpts = writeIORef v_opt_C_ready True
141 static_flags :: [(String, OptKind IO)]
142 -- All the static flags should appear in this list. It describes how each
143 -- static flag should be processed. Two main purposes:
144 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
145 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
147 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
148 -- things that are searched up by the top-level definitions like
149 -- opt_foo = lookUp FSLIT("-dfoo")
151 -- Note that ordering is important in the following list: any flag which
152 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
153 -- flags further down the list with the same prefix.
156 ------- GHCi -------------------------------------------------------
157 ( "ignore-dot-ghci", PassFlag addOpt )
158 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
160 ------- ways --------------------------------------------------------
161 , ( "prof" , NoArg (addWay WayProf) )
162 , ( "unreg" , NoArg (addWay WayUnreg) )
163 , ( "ticky" , NoArg (addWay WayTicky) )
164 , ( "parallel" , NoArg (addWay WayPar) )
165 , ( "gransim" , NoArg (addWay WayGran) )
166 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
167 , ( "debug" , NoArg (addWay WayDebug) )
168 , ( "ndp" , NoArg (addWay WayNDP) )
169 , ( "threaded" , NoArg (addWay WayThreaded) )
172 ------ Debugging ----------------------------------------------------
173 , ( "dppr-debug", PassFlag addOpt )
174 , ( "dppr-user-length", AnySuffix addOpt )
175 -- rest of the debugging flags are dynamic
177 --------- Profiling --------------------------------------------------
178 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
179 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
180 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
181 -- "ignore-sccs" doesn't work (ToDo)
183 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
184 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
185 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
187 ------- Miscellaneous -----------------------------------------------
188 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
190 ----- Linker --------------------------------------------------------
191 , ( "static" , PassFlag addOpt )
192 , ( "dynamic" , NoArg (removeOpt "-static") )
193 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
195 ----- RTS opts ------------------------------------------------------
196 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
197 , ( "Rghc-timing" , NoArg (enableTimingStats) )
199 ------ Compiler flags -----------------------------------------------
200 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
201 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
202 (\s -> removeOpt ("-f"++s)) )
204 -- Pass all remaining "-f<blah>" options to hsc
205 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
208 addOpt = consIORef v_opt_C
210 addWay = consIORef v_Ways
213 fs <- readIORef v_opt_C
214 writeIORef v_opt_C $! filter (/= f) fs
216 lookUp :: FastString -> Bool
217 lookup_def_int :: String -> Int -> Int
218 lookup_def_float :: String -> Float -> Float
219 lookup_str :: String -> Maybe String
221 -- holds the static opts while they're being collected, before
222 -- being unsafely read by unpacked_static_opts below.
223 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
224 GLOBAL_VAR(v_opt_C_ready, False, Bool)
225 staticFlags = unsafePerformIO $ do
226 ready <- readIORef v_opt_C_ready
228 then panic "a static opt was looked at too early!"
229 else readIORef v_opt_C
231 -- -static is the default
232 defaultStaticOpts = ["-static"]
234 packed_static_opts = map mkFastString staticFlags
236 lookUp sw = sw `elem` packed_static_opts
238 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
239 -- and returns the string X
241 = case firstJust (map (startsWith sw) staticFlags) of
242 Just ('=' : str) -> Just str
246 lookup_def_int sw def = case (lookup_str sw) of
247 Nothing -> def -- Use default
248 Just xx -> try_read sw xx
250 lookup_def_float sw def = case (lookup_str sw) of
251 Nothing -> def -- Use default
252 Just xx -> try_read sw xx
255 try_read :: Read a => String -> String -> a
256 -- (try_read sw str) tries to read s; if it fails, it
257 -- bleats about flag sw
260 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
261 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
262 -- ToDo: hack alert. We should really parse the arugments
263 -- and announce errors in a more civilised way.
267 Putting the compiler options into temporary at-files
268 may turn out to be necessary later on if we turn hsc into
269 a pure Win32 application where I think there's a command-line
270 length limit of 255. unpacked_opts understands the @ option.
272 unpacked_opts :: [String]
276 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
278 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
283 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
286 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
287 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
290 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
291 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
292 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
293 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
294 opt_DoTickyProfiling = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
297 opt_Hpc = lookUp FSLIT("-fhpc")
300 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
301 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
302 opt_Parallel = lookUp FSLIT("-fparallel")
303 opt_Flatten = lookUp FSLIT("-fflatten")
306 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
307 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
308 opt_CprOff = lookUp FSLIT("-fcpr-off")
309 -- Switch off CPR analysis in the new demand analyser
310 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
312 opt_GranMacros = lookUp FSLIT("-fgransim")
313 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
314 opt_HistorySize = lookup_def_int "-fhistory-size" 20
315 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
316 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
318 -- Simplifier switches
319 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
320 -- NoPreInlining is there just to see how bad things
321 -- get if you don't do it!
322 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
325 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
326 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
327 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
328 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
329 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
331 opt_UF_DearOp = ( 4 :: Int)
333 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
336 opt_PIC = lookUp FSLIT("-fPIC")
338 opt_Static = lookUp FSLIT("-static")
339 opt_HardwireLibPaths = lookUp FSLIT("-fhardwire-lib-paths")
340 opt_Unregisterised = lookUp FSLIT("-funregisterised")
342 -- Derived, not a real option. Determines whether we will be compiling
343 -- info tables that reside just before the entry code, or with an
344 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
345 -- includes/InfoTables.h.
346 tablesNextToCode = not opt_Unregisterised
347 && cGhcEnableTablesNextToCode == "YES"
349 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
351 -- Include full span info in error messages, instead of just the start position.
352 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
355 -- object files and libraries to be linked in are collected here.
356 -- ToDo: perhaps this could be done without a global, it wasn't obvious
357 -- how to do it though --SDM.
358 GLOBAL_VAR(v_Ld_inputs, [], [String])
362 "fauto-sccs-on-all-toplevs",
363 "fauto-sccs-on-exported-toplevs",
364 "fauto-sccs-on-individual-cafs",
367 "firrefutable-tuples",
371 "fno-hi-version-check",
373 "fno-method-sharing",
378 "funfolding-update-in-place",
380 "fhardwire-lib-paths",
388 || any (`isPrefixOf` f) [
389 "fliberate-case-threshold",
392 "funfolding-creation-threshold",
393 "funfolding-use-threshold",
394 "funfolding-fun-discount",
395 "funfolding-keeness-factor"
400 -- Misc functions for command-line options
402 startsWith :: String -> String -> Maybe String
403 -- startsWith pfx (pfx++rest) = Just rest
405 startsWith [] str = Just str
406 startsWith (c:cs) (s:ss)
407 = if c /= s then Nothing else startsWith cs ss
408 startsWith _ [] = Nothing
411 -----------------------------------------------------------------------------
412 -- convert sizes like "3.5M" into integers
414 decodeSize :: String -> Integer
416 | c == "" = truncate n
417 | c == "K" || c == "k" = truncate (n * 1000)
418 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
419 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
420 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
421 where (m, c) = span pred str
423 pred c = isDigit c || c == '.'
426 -----------------------------------------------------------------------------
429 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
430 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
432 -----------------------------------------------------------------------------
435 -- The central concept of a "way" is that all objects in a given
436 -- program must be compiled in the same "way". Certain options change
437 -- parameters of the virtual machine, eg. profiling adds an extra word
438 -- to the object header, so profiling objects cannot be linked with
439 -- non-profiling objects.
441 -- After parsing the command-line options, we determine which "way" we
442 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
444 -- We then find the "build-tag" associated with this way, and this
445 -- becomes the suffix used to find .hi files and libraries used in
448 GLOBAL_VAR(v_Build_tag, "", String)
450 -- The RTS has its own build tag, because there are some ways that
451 -- affect the RTS only.
452 GLOBAL_VAR(v_RTS_Build_tag, "", String)
482 GLOBAL_VAR(v_Ways, [] ,[WayName])
484 allowed_combination way = and [ x `allowedWith` y
485 | x <- way, y <- way, x < y ]
487 -- Note ordering in these tests: the left argument is
488 -- <= the right argument, according to the Ord instance
491 -- debug is allowed with everything
492 _ `allowedWith` WayDebug = True
493 WayDebug `allowedWith` _ = True
495 WayProf `allowedWith` WayUnreg = True
496 WayProf `allowedWith` WayNDP = True
497 _ `allowedWith` _ = False
500 findBuildTag :: IO [String] -- new options
502 way_names <- readIORef v_Ways
503 let ws = sort (nub way_names)
505 if not (allowed_combination ws)
506 then throwDyn (CmdLineError $
507 "combination not supported: " ++
508 foldr1 (\a b -> a ++ '/':b)
509 (map (wayName . lkupWay) ws))
510 else let ways = map lkupWay ws
511 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
512 rts_tag = mkBuildTag ways
513 flags = map wayOpts ways
515 writeIORef v_Build_tag tag
516 writeIORef v_RTS_Build_tag rts_tag
517 return (concat flags)
521 mkBuildTag :: [Way] -> String
522 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
525 case lookup w way_details of
526 Nothing -> error "findBuildTag"
527 Just details -> details
529 isRTSWay = wayRTSOnly . lkupWay
538 way_details :: [ (WayName, Way) ]
540 [ (WayThreaded, Way "thr" True "Threaded" [
541 #if defined(freebsd_TARGET_OS)
544 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
545 -- which GHC has some problems with. It's currently not clear whether
546 -- the problems are our fault or theirs, but it seems that using the
547 -- alternative 1:1 threading library libthr works around it:
549 #elif defined(solaris2_TARGET_OS)
554 (WayDebug, Way "debug" True "Debug" [] ),
556 (WayProf, Way "p" False "Profiling"
559 , "-optc-DPROFILING" ]),
561 (WayTicky, Way "t" True "Ticky-ticky Profiling"
563 , "-optc-DTICKY_TICKY" ]),
565 (WayUnreg, Way "u" False "Unregisterised"
568 -- optl's below to tell linker where to find the PVM library -- HWL
569 (WayPar, Way "mp" False "Parallel"
571 , "-D__PARALLEL_HASKELL__"
573 , "-package concurrent"
575 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
579 -- at the moment we only change the RTS and could share compiler and libs!
580 (WayPar, Way "mt" False "Parallel ticky profiling"
582 , "-D__PARALLEL_HASKELL__"
585 , "-package concurrent"
587 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
591 (WayPar, Way "md" False "Distributed"
593 , "-D__PARALLEL_HASKELL__"
594 , "-D__DISTRIBUTED_HASKELL__"
597 , "-package concurrent"
599 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
603 (WayGran, Way "mg" False "GranSim"
607 , "-package concurrent" ]),
609 (WayNDP, Way "ndp" False "Nested data parallelism"
613 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
614 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
615 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
616 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
617 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
618 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
619 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
620 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
621 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
622 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
623 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
624 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
625 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
626 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
627 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
628 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
629 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
634 , "-optc-DUSE_MINIINTERPRETER"
635 , "-fno-asm-mangling"