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 -----------------------------------------------------------------------------
17 WayName(..), v_Ways, v_Build_tag, v_RTS_Build_tag,
19 -- Output style options
24 opt_AutoSccsOnAllToplevs,
25 opt_AutoSccsOnExportedToplevs,
26 opt_AutoSccsOnIndividualCafs,
32 opt_IrrefutableTuples,
40 opt_LiberateCaseThreshold,
43 opt_SimplNoPreInlining,
44 opt_SimplExcessPrecision,
48 opt_UF_CreationThreshold,
50 opt_UF_FunAppDiscount,
72 #include "HsVersions.h"
76 import FastString ( FastString, mkFastString )
78 import Maybes ( firstJust )
79 import Panic ( GhcException(..), ghcError )
81 import Control.Exception ( throwDyn )
83 import System.IO.Unsafe ( unsafePerformIO )
84 import Control.Monad ( when )
85 import Data.Char ( isDigit )
86 import Data.List ( sort, intersperse, nub )
88 -----------------------------------------------------------------------------
91 parseStaticFlags :: [String] -> IO [String]
92 parseStaticFlags args = do
93 (leftover, errs) <- processArgs static_flags args
94 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
96 -- deal with the way flags: the way (eg. prof) gives rise to
97 -- futher flags, some of which might be static.
98 way_flags <- findBuildTag
100 -- if we're unregisterised, add some more flags
101 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
104 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
106 -- TABLES_NEXT_TO_CODE affects the info table layout.
107 -- Be careful to do this *after* all processArgs,
108 -- because evaluating tablesNextToCode involves looking at the global
109 -- static flags. Those pesky global variables...
110 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
113 when (not (null errs)) $ ghcError (UsageError (unlines errs))
114 return (cg_flags++more_leftover++leftover)
117 static_flags :: [(String, OptKind IO)]
118 -- All the static flags should appear in this list. It describes how each
119 -- static flag should be processed. Two main purposes:
120 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
121 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
123 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
124 -- things that are searched up by the top-level definitions like
125 -- opt_foo = lookUp FSLIT("-dfoo")
127 -- Note that ordering is important in the following list: any flag which
128 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
129 -- flags further down the list with the same prefix.
132 ------- GHCi -------------------------------------------------------
133 ( "ignore-dot-ghci", PassFlag addOpt )
134 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
136 ------- ways --------------------------------------------------------
137 , ( "prof" , NoArg (addWay WayProf) )
138 , ( "unreg" , NoArg (addWay WayUnreg) )
139 , ( "ticky" , NoArg (addWay WayTicky) )
140 , ( "parallel" , NoArg (addWay WayPar) )
141 , ( "gransim" , NoArg (addWay WayGran) )
142 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
143 , ( "debug" , NoArg (addWay WayDebug) )
144 , ( "ndp" , NoArg (addWay WayNDP) )
145 , ( "threaded" , NoArg (addWay WayThreaded) )
148 ------ Debugging ----------------------------------------------------
149 , ( "dppr-debug", PassFlag addOpt )
150 , ( "dppr-user-length", AnySuffix addOpt )
151 -- rest of the debugging flags are dynamic
153 --------- Profiling --------------------------------------------------
154 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
155 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
156 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
157 -- "ignore-sccs" doesn't work (ToDo)
159 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
160 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
161 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
163 ------- Miscellaneous -----------------------------------------------
164 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
166 ----- Linker --------------------------------------------------------
167 , ( "static" , PassFlag addOpt )
168 , ( "dynamic" , NoArg (removeOpt "-static") )
169 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
171 ----- RTS opts ------------------------------------------------------
172 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
173 , ( "Rghc-timing" , NoArg (enableTimingStats) )
175 ------ Compiler flags -----------------------------------------------
176 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
177 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
178 (\s -> removeOpt ("-f"++s)) )
180 -- Pass all remaining "-f<blah>" options to hsc
181 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
184 addOpt = consIORef v_opt_C
186 addWay = consIORef v_Ways
189 fs <- readIORef v_opt_C
190 writeIORef v_opt_C $! filter (/= f) fs
192 lookUp :: FastString -> Bool
193 lookup_def_int :: String -> Int -> Int
194 lookup_def_float :: String -> Float -> Float
195 lookup_str :: String -> Maybe String
197 -- holds the static opts while they're being collected, before
198 -- being unsafely read by unpacked_static_opts below.
199 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
200 staticFlags = unsafePerformIO (readIORef v_opt_C)
202 -- -static is the default
203 defaultStaticOpts = ["-static"]
205 packed_static_opts = map mkFastString staticFlags
207 lookUp sw = sw `elem` packed_static_opts
209 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
210 -- and returns the string X
212 = case firstJust (map (startsWith sw) staticFlags) of
213 Just ('=' : str) -> Just str
217 lookup_def_int sw def = case (lookup_str sw) of
218 Nothing -> def -- Use default
219 Just xx -> try_read sw xx
221 lookup_def_float sw def = case (lookup_str sw) of
222 Nothing -> def -- Use default
223 Just xx -> try_read sw xx
226 try_read :: Read a => String -> String -> a
227 -- (try_read sw str) tries to read s; if it fails, it
228 -- bleats about flag sw
231 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
232 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
233 -- ToDo: hack alert. We should really parse the arugments
234 -- and announce errors in a more civilised way.
238 Putting the compiler options into temporary at-files
239 may turn out to be necessary later on if we turn hsc into
240 a pure Win32 application where I think there's a command-line
241 length limit of 255. unpacked_opts understands the @ option.
243 unpacked_opts :: [String]
247 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
249 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
254 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
257 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
258 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
261 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
262 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
263 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
264 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
265 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
268 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
269 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
270 opt_Parallel = lookUp FSLIT("-fparallel")
271 opt_Flatten = lookUp FSLIT("-fflatten")
274 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
275 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
276 opt_CprOff = lookUp FSLIT("-fcpr-off")
277 opt_RulesOff = lookUp FSLIT("-frules-off")
278 -- Switch off CPR analysis in the new demand analyser
279 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
280 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
282 opt_GranMacros = lookUp FSLIT("-fgransim")
283 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
284 opt_HistorySize = lookup_def_int "-fhistory-size" 20
285 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
286 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
288 -- Simplifier switches
289 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
290 -- NoPreInlining is there just to see how bad things
291 -- get if you don't do it!
292 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
295 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
296 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
297 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
298 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
299 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
301 opt_UF_DearOp = ( 4 :: Int)
303 opt_PIC = lookUp FSLIT("-fPIC")
304 opt_Static = lookUp FSLIT("-static")
305 opt_Unregisterised = lookUp FSLIT("-funregisterised")
307 -- Derived, not a real option. Determines whether we will be compiling
308 -- info tables that reside just before the entry code, or with an
309 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
310 -- includes/InfoTables.h.
311 tablesNextToCode = not opt_Unregisterised
312 && cGhcEnableTablesNextToCode == "YES"
314 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
316 -- Include full span info in error messages, instead of just the start position.
317 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
320 -- object files and libraries to be linked in are collected here.
321 -- ToDo: perhaps this could be done without a global, it wasn't obvious
322 -- how to do it though --SDM.
323 GLOBAL_VAR(v_Ld_inputs, [], [String])
327 "fauto-sccs-on-all-toplevs",
328 "fauto-sccs-on-exported-toplevs",
329 "fauto-sccs-on-individual-cafs",
333 "firrefutable-tuples",
337 "fno-hi-version-check",
339 "fno-method-sharing",
344 "funfolding-update-in-place",
353 || any (flip prefixMatch f) [
354 "fliberate-case-threshold",
357 "funfolding-creation-threshold",
358 "funfolding-use-threshold",
359 "funfolding-fun-discount",
360 "funfolding-keeness-factor"
365 -- Misc functions for command-line options
367 startsWith :: String -> String -> Maybe String
368 -- startsWith pfx (pfx++rest) = Just rest
370 startsWith [] str = Just str
371 startsWith (c:cs) (s:ss)
372 = if c /= s then Nothing else startsWith cs ss
373 startsWith _ [] = Nothing
376 -----------------------------------------------------------------------------
377 -- convert sizes like "3.5M" into integers
379 decodeSize :: String -> Integer
381 | c == "" = truncate n
382 | c == "K" || c == "k" = truncate (n * 1000)
383 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
384 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
385 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
386 where (m, c) = span pred str
388 pred c = isDigit c || c == '.'
391 -----------------------------------------------------------------------------
394 #if __GLASGOW_HASKELL__ >= 504
395 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
396 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
398 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
399 foreign import "enableTimingStats" unsafe enableTimingStats :: IO ()
402 -----------------------------------------------------------------------------
405 -- The central concept of a "way" is that all objects in a given
406 -- program must be compiled in the same "way". Certain options change
407 -- parameters of the virtual machine, eg. profiling adds an extra word
408 -- to the object header, so profiling objects cannot be linked with
409 -- non-profiling objects.
411 -- After parsing the command-line options, we determine which "way" we
412 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
414 -- We then find the "build-tag" associated with this way, and this
415 -- becomes the suffix used to find .hi files and libraries used in
418 GLOBAL_VAR(v_Build_tag, "", String)
420 -- The RTS has its own build tag, because there are some ways that
421 -- affect the RTS only.
422 GLOBAL_VAR(v_RTS_Build_tag, "", String)
452 GLOBAL_VAR(v_Ways, [] ,[WayName])
454 allowed_combination way = and [ x `allowedWith` y
455 | x <- way, y <- way, x < y ]
457 -- Note ordering in these tests: the left argument is
458 -- <= the right argument, according to the Ord instance
461 -- debug is allowed with everything
462 _ `allowedWith` WayDebug = True
463 WayDebug `allowedWith` _ = True
465 WayProf `allowedWith` WayUnreg = True
466 WayProf `allowedWith` WayNDP = True
467 _ `allowedWith` _ = False
470 findBuildTag :: IO [String] -- new options
472 way_names <- readIORef v_Ways
473 let ws = sort (nub way_names)
474 if not (allowed_combination ws)
475 then throwDyn (CmdLineError $
476 "combination not supported: " ++
477 foldr1 (\a b -> a ++ '/':b)
478 (map (wayName . lkupWay) ws))
479 else let ways = map lkupWay ws
480 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
481 rts_tag = mkBuildTag ways
482 flags = map wayOpts ways
484 writeIORef v_Build_tag tag
485 writeIORef v_RTS_Build_tag rts_tag
486 return (concat flags)
488 mkBuildTag :: [Way] -> String
489 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
492 case lookup w way_details of
493 Nothing -> error "findBuildTag"
494 Just details -> details
503 way_details :: [ (WayName, Way) ]
505 [ (WayThreaded, Way "thr" True "Threaded" [
506 #if defined(freebsd_TARGET_OS)
509 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
510 -- which GHC has some problems with. It's currently not clear whether
511 -- the problems are our fault or theirs, but it seems that using the
512 -- alternative 1:1 threading library libthr works around it:
514 #elif defined(solaris2_TARGET_OS)
519 (WayDebug, Way "debug" True "Debug" [] ),
521 (WayProf, Way "p" False "Profiling"
524 , "-optc-DPROFILING" ]),
526 (WayTicky, Way "t" False "Ticky-ticky Profiling"
529 , "-optc-DTICKY_TICKY" ]),
531 (WayUnreg, Way "u" False "Unregisterised"
534 -- optl's below to tell linker where to find the PVM library -- HWL
535 (WayPar, Way "mp" False "Parallel"
537 , "-D__PARALLEL_HASKELL__"
539 , "-package concurrent"
541 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
545 -- at the moment we only change the RTS and could share compiler and libs!
546 (WayPar, Way "mt" False "Parallel ticky profiling"
548 , "-D__PARALLEL_HASKELL__"
551 , "-package concurrent"
553 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
557 (WayPar, Way "md" False "Distributed"
559 , "-D__PARALLEL_HASKELL__"
560 , "-D__DISTRIBUTED_HASKELL__"
563 , "-package concurrent"
565 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
569 (WayGran, Way "mg" False "GranSim"
573 , "-package concurrent" ]),
575 (WayNDP, Way "ndp" False "Nested data parallelism"
579 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
580 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
581 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
582 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
583 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
584 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
585 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
586 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
587 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
588 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
589 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
590 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
591 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
592 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
593 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
594 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
595 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
600 , "-optc-DUSE_MINIINTERPRETER"
601 , "-fno-asm-mangling"