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,
70 #include "HsVersions.h"
74 import FastString ( FastString, mkFastString )
76 import Maybes ( firstJust )
77 import Panic ( GhcException(..), ghcError )
79 import Control.Exception ( throwDyn )
81 import System.IO.Unsafe ( unsafePerformIO )
82 import Control.Monad ( when )
83 import Data.Char ( isDigit )
84 import Data.List ( sort, intersperse, nub )
86 -----------------------------------------------------------------------------
89 parseStaticFlags :: [String] -> IO [String]
90 parseStaticFlags args = do
91 (leftover, errs) <- processArgs static_flags args
92 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
94 -- deal with the way flags: the way (eg. prof) gives rise to
95 -- futher flags, some of which might be static.
96 way_flags <- findBuildTag
98 -- if we're unregisterised, add some more flags
99 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
102 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
104 -- TABLES_NEXT_TO_CODE affects the info table layout.
105 -- Be careful to do this *after* all processArgs,
106 -- because evaluating tablesNextToCode involves looking at the global
107 -- static flags. Those pesky global variables...
108 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
111 when (not (null errs)) $ ghcError (UsageError (unlines errs))
112 return (cg_flags++more_leftover++leftover)
115 -- note that ordering is important in the following list: any flag which
116 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
117 -- flags further down the list with the same prefix.
119 static_flags :: [(String, OptKind IO)]
121 ------- GHCi -------------------------------------------------------
122 ( "ignore-dot-ghci", PassFlag addOpt )
123 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
125 ------- ways --------------------------------------------------------
126 , ( "prof" , NoArg (addWay WayProf) )
127 , ( "unreg" , NoArg (addWay WayUnreg) )
128 , ( "ticky" , NoArg (addWay WayTicky) )
129 , ( "parallel" , NoArg (addWay WayPar) )
130 , ( "gransim" , NoArg (addWay WayGran) )
131 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
132 , ( "debug" , NoArg (addWay WayDebug) )
133 , ( "ndp" , NoArg (addWay WayNDP) )
134 , ( "threaded" , NoArg (addWay WayThreaded) )
137 ------ Debugging ----------------------------------------------------
138 , ( "dppr-noprags", PassFlag addOpt )
139 , ( "dppr-debug", PassFlag addOpt )
140 , ( "dppr-user-length", AnySuffix addOpt )
141 -- rest of the debugging flags are dynamic
143 --------- Profiling --------------------------------------------------
144 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
145 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
146 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
147 -- "ignore-sccs" doesn't work (ToDo)
149 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
150 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
151 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
153 ------- Miscellaneous -----------------------------------------------
154 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
156 ----- Linker --------------------------------------------------------
157 , ( "static" , PassFlag addOpt )
158 , ( "dynamic" , NoArg (removeOpt "-static") )
159 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
161 ----- RTS opts ------------------------------------------------------
162 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
163 , ( "Rghc-timing" , NoArg (enableTimingStats) )
165 ------ Compiler flags -----------------------------------------------
166 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
167 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
168 (\s -> removeOpt ("-f"++s)) )
170 -- Pass all remaining "-f<blah>" options to hsc
171 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
174 addOpt = consIORef v_opt_C
176 addWay = consIORef v_Ways
179 fs <- readIORef v_opt_C
180 writeIORef v_opt_C $! filter (/= f) fs
182 lookUp :: FastString -> Bool
183 lookup_def_int :: String -> Int -> Int
184 lookup_def_float :: String -> Float -> Float
185 lookup_str :: String -> Maybe String
187 -- holds the static opts while they're being collected, before
188 -- being unsafely read by unpacked_static_opts below.
189 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
190 staticFlags = unsafePerformIO (readIORef v_opt_C)
192 -- -static is the default
193 defaultStaticOpts = ["-static"]
195 packed_static_opts = map mkFastString staticFlags
197 lookUp sw = sw `elem` packed_static_opts
199 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
200 -- and returns the string X
202 = case firstJust (map (startsWith sw) staticFlags) of
203 Just ('=' : str) -> Just str
207 lookup_def_int sw def = case (lookup_str sw) of
208 Nothing -> def -- Use default
209 Just xx -> try_read sw xx
211 lookup_def_float sw def = case (lookup_str sw) of
212 Nothing -> def -- Use default
213 Just xx -> try_read sw xx
216 try_read :: Read a => String -> String -> a
217 -- (try_read sw str) tries to read s; if it fails, it
218 -- bleats about flag sw
221 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
222 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
223 -- ToDo: hack alert. We should really parse the arugments
224 -- and announce errors in a more civilised way.
228 Putting the compiler options into temporary at-files
229 may turn out to be necessary later on if we turn hsc into
230 a pure Win32 application where I think there's a command-line
231 length limit of 255. unpacked_opts understands the @ option.
233 unpacked_opts :: [String]
237 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
239 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
244 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
247 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
248 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
251 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
252 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
253 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
254 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
255 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
258 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
259 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
260 opt_Parallel = lookUp FSLIT("-fparallel")
261 opt_Flatten = lookUp FSLIT("-fflatten")
264 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
265 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
266 opt_CprOff = lookUp FSLIT("-fcpr-off")
267 opt_RulesOff = lookUp FSLIT("-frules-off")
268 -- Switch off CPR analysis in the new demand analyser
269 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
270 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
272 opt_GranMacros = lookUp FSLIT("-fgransim")
273 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
274 opt_HistorySize = lookup_def_int "-fhistory-size" 20
275 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
276 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
278 -- Simplifier switches
279 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
280 -- NoPreInlining is there just to see how bad things
281 -- get if you don't do it!
282 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
285 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
286 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
287 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
288 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
289 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
291 opt_UF_DearOp = ( 4 :: Int)
293 opt_Static = lookUp FSLIT("-static")
294 opt_Unregisterised = lookUp FSLIT("-funregisterised")
296 -- Derived, not a real option. Determines whether we will be compiling
297 -- info tables that reside just before the entry code, or with an
298 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
299 -- includes/InfoTables.h.
300 tablesNextToCode = not opt_Unregisterised
301 && cGhcEnableTablesNextToCode == "YES"
303 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
305 -- Include full span info in error messages, instead of just the start position.
306 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
308 opt_PIC = lookUp FSLIT("-fPIC")
310 -- object files and libraries to be linked in are collected here.
311 -- ToDo: perhaps this could be done without a global, it wasn't obvious
312 -- how to do it though --SDM.
313 GLOBAL_VAR(v_Ld_inputs, [], [String])
317 "fauto-sccs-on-all-toplevs",
318 "fauto-sccs-on-exported-toplevs",
319 "fauto-sccs-on-individual-cafs",
323 "firrefutable-tuples",
327 "fno-hi-version-check",
329 "fno-method-sharing",
334 "funfolding-update-in-place",
343 || any (flip prefixMatch f) [
344 "fliberate-case-threshold",
347 "funfolding-creation-threshold",
348 "funfolding-use-threshold",
349 "funfolding-fun-discount",
350 "funfolding-keeness-factor"
355 -- Misc functions for command-line options
357 startsWith :: String -> String -> Maybe String
358 -- startsWith pfx (pfx++rest) = Just rest
360 startsWith [] str = Just str
361 startsWith (c:cs) (s:ss)
362 = if c /= s then Nothing else startsWith cs ss
363 startsWith _ [] = Nothing
366 -----------------------------------------------------------------------------
367 -- convert sizes like "3.5M" into integers
369 decodeSize :: String -> Integer
371 | c == "" = truncate n
372 | c == "K" || c == "k" = truncate (n * 1000)
373 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
374 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
375 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
376 where (m, c) = span pred str
378 pred c = isDigit c || c == '.'
381 -----------------------------------------------------------------------------
384 #if __GLASGOW_HASKELL__ >= 504
385 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
386 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
388 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
389 foreign import "enableTimingStats" unsafe enableTimingStats :: IO ()
392 -----------------------------------------------------------------------------
395 -- The central concept of a "way" is that all objects in a given
396 -- program must be compiled in the same "way". Certain options change
397 -- parameters of the virtual machine, eg. profiling adds an extra word
398 -- to the object header, so profiling objects cannot be linked with
399 -- non-profiling objects.
401 -- After parsing the command-line options, we determine which "way" we
402 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
404 -- We then find the "build-tag" associated with this way, and this
405 -- becomes the suffix used to find .hi files and libraries used in
408 GLOBAL_VAR(v_Build_tag, "", String)
410 -- The RTS has its own build tag, because there are some ways that
411 -- affect the RTS only.
412 GLOBAL_VAR(v_RTS_Build_tag, "", String)
442 GLOBAL_VAR(v_Ways, [] ,[WayName])
444 allowed_combination way = and [ x `allowedWith` y
445 | x <- way, y <- way, x < y ]
447 -- Note ordering in these tests: the left argument is
448 -- <= the right argument, according to the Ord instance
451 -- debug is allowed with everything
452 _ `allowedWith` WayDebug = True
453 WayDebug `allowedWith` _ = True
455 WayProf `allowedWith` WayUnreg = True
456 WayProf `allowedWith` WayNDP = True
457 _ `allowedWith` _ = False
460 findBuildTag :: IO [String] -- new options
462 way_names <- readIORef v_Ways
463 let ws = sort (nub way_names)
464 if not (allowed_combination ws)
465 then throwDyn (CmdLineError $
466 "combination not supported: " ++
467 foldr1 (\a b -> a ++ '/':b)
468 (map (wayName . lkupWay) ws))
469 else let ways = map lkupWay ws
470 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
471 rts_tag = mkBuildTag ways
472 flags = map wayOpts ways
474 writeIORef v_Build_tag tag
475 writeIORef v_RTS_Build_tag rts_tag
476 return (concat flags)
478 mkBuildTag :: [Way] -> String
479 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
482 case lookup w way_details of
483 Nothing -> error "findBuildTag"
484 Just details -> details
493 way_details :: [ (WayName, Way) ]
495 [ (WayThreaded, Way "thr" True "Threaded" [
496 #if defined(freebsd_TARGET_OS)
499 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
500 -- which GHC has some problems with. It's currently not clear whether
501 -- the problems are our fault or theirs, but it seems that using the
502 -- alternative 1:1 threading library libthr works around it:
504 #elif defined(solaris2_TARGET_OS)
509 (WayDebug, Way "debug" True "Debug" [] ),
511 (WayProf, Way "p" False "Profiling"
514 , "-optc-DPROFILING" ]),
516 (WayTicky, Way "t" False "Ticky-ticky Profiling"
519 , "-optc-DTICKY_TICKY" ]),
521 (WayUnreg, Way "u" False "Unregisterised"
524 -- optl's below to tell linker where to find the PVM library -- HWL
525 (WayPar, Way "mp" False "Parallel"
527 , "-D__PARALLEL_HASKELL__"
529 , "-package concurrent"
531 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
535 -- at the moment we only change the RTS and could share compiler and libs!
536 (WayPar, Way "mt" False "Parallel ticky profiling"
538 , "-D__PARALLEL_HASKELL__"
541 , "-package concurrent"
543 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
547 (WayPar, Way "md" False "Distributed"
549 , "-D__PARALLEL_HASKELL__"
550 , "-D__DISTRIBUTED_HASKELL__"
553 , "-package concurrent"
555 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
559 (WayGran, Way "mg" False "GranSim"
563 , "-package concurrent" ]),
565 (WayNDP, Way "ndp" False "Nested data parallelism"
569 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
570 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
571 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
572 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
573 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
574 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
575 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
576 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
577 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
578 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
579 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
580 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
581 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
582 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
583 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
584 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
585 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
590 , "-optc-DUSE_MINIINTERPRETER"
591 , "-fno-asm-mangling"