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"
72 import Util ( consIORef )
74 import Config ( cProjectVersionInt, cProjectPatchLevel,
76 import FastString ( FastString, mkFastString )
78 import Maybes ( firstJust )
79 import Panic ( GhcException(..), ghcError )
81 import EXCEPTION ( throwDyn )
83 import UNSAFE_IO ( unsafePerformIO )
85 import 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)
105 when (not (null errs)) $ ghcError (UsageError (unlines errs))
106 return (more_leftover++leftover)
109 -- note that ordering is important in the following list: any flag which
110 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
111 -- flags further down the list with the same prefix.
113 static_flags :: [(String, OptKind IO)]
115 ------- GHCi -------------------------------------------------------
116 ( "ignore-dot-ghci", PassFlag addOpt )
117 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
119 ------- ways --------------------------------------------------------
120 , ( "prof" , NoArg (addWay WayProf) )
121 , ( "unreg" , NoArg (addWay WayUnreg) )
122 , ( "ticky" , NoArg (addWay WayTicky) )
123 , ( "parallel" , NoArg (addWay WayPar) )
124 , ( "gransim" , NoArg (addWay WayGran) )
125 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
126 , ( "debug" , NoArg (addWay WayDebug) )
127 , ( "ndp" , NoArg (addWay WayNDP) )
128 , ( "threaded" , NoArg (addWay WayThreaded) )
131 ------ Debugging ----------------------------------------------------
132 , ( "dppr-noprags", PassFlag addOpt )
133 , ( "dppr-debug", PassFlag addOpt )
134 , ( "dppr-user-length", AnySuffix addOpt )
135 -- rest of the debugging flags are dynamic
137 --------- Profiling --------------------------------------------------
138 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
139 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
140 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
141 -- "ignore-sccs" doesn't work (ToDo)
143 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
144 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
145 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
147 ------- Miscellaneous -----------------------------------------------
148 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
150 ----- Linker --------------------------------------------------------
151 , ( "static" , PassFlag addOpt )
152 , ( "dynamic" , NoArg (removeOpt "-static") )
153 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
155 ----- RTS opts ------------------------------------------------------
156 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
157 , ( "Rghc-timing" , NoArg (enableTimingStats) )
159 ------ Compiler flags -----------------------------------------------
160 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
161 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
162 (\s -> removeOpt ("-f"++s)) )
164 -- Pass all remaining "-f<blah>" options to hsc
165 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
168 addOpt = consIORef v_opt_C
170 addWay = consIORef v_Ways
173 fs <- readIORef v_opt_C
174 writeIORef v_opt_C $! filter (/= f) fs
176 lookUp :: FastString -> Bool
177 lookup_def_int :: String -> Int -> Int
178 lookup_def_float :: String -> Float -> Float
179 lookup_str :: String -> Maybe String
181 -- holds the static opts while they're being collected, before
182 -- being unsafely read by unpacked_static_opts below.
183 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
184 staticFlags = unsafePerformIO (readIORef v_opt_C)
186 -- -static is the default
187 defaultStaticOpts = ["-static"]
189 packed_static_opts = map mkFastString staticFlags
191 lookUp sw = sw `elem` packed_static_opts
193 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
194 -- and returns the string X
196 = case firstJust (map (startsWith sw) staticFlags) of
197 Just ('=' : str) -> Just str
201 lookup_def_int sw def = case (lookup_str sw) of
202 Nothing -> def -- Use default
203 Just xx -> try_read sw xx
205 lookup_def_float sw def = case (lookup_str sw) of
206 Nothing -> def -- Use default
207 Just xx -> try_read sw xx
210 try_read :: Read a => String -> String -> a
211 -- (try_read sw str) tries to read s; if it fails, it
212 -- bleats about flag sw
215 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
216 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
217 -- ToDo: hack alert. We should really parse the arugments
218 -- and announce errors in a more civilised way.
222 Putting the compiler options into temporary at-files
223 may turn out to be necessary later on if we turn hsc into
224 a pure Win32 application where I think there's a command-line
225 length limit of 255. unpacked_opts understands the @ option.
227 unpacked_opts :: [String]
231 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
233 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
238 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
241 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
242 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
245 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
246 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
247 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
248 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
249 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
252 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
253 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
254 opt_Parallel = lookUp FSLIT("-fparallel")
255 opt_Flatten = lookUp FSLIT("-fflatten")
258 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
259 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
260 opt_CprOff = lookUp FSLIT("-fcpr-off")
261 opt_RulesOff = lookUp FSLIT("-frules-off")
262 -- Switch off CPR analysis in the new demand analyser
263 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
264 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
266 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
267 opt_GranMacros = lookUp FSLIT("-fgransim")
268 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
269 opt_HistorySize = lookup_def_int "-fhistory-size" 20
270 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
271 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
273 -- Simplifier switches
274 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
275 -- NoPreInlining is there just to see how bad things
276 -- get if you don't do it!
277 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
280 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
281 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
282 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
283 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
284 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
286 opt_UF_DearOp = ( 4 :: Int)
288 opt_Static = lookUp FSLIT("-static")
289 opt_Unregisterised = lookUp FSLIT("-funregisterised")
290 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
292 -- Include full span info in error messages, instead of just the start position.
293 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
295 opt_PIC = lookUp FSLIT("-fPIC")
297 -- object files and libraries to be linked in are collected here.
298 -- ToDo: perhaps this could be done without a global, it wasn't obvious
299 -- how to do it though --SDM.
300 GLOBAL_VAR(v_Ld_inputs, [], [String])
304 "fauto-sccs-on-all-toplevs",
305 "fauto-sccs-on-exported-toplevs",
306 "fauto-sccs-on-individual-cafs",
311 "firrefutable-tuples",
316 "femit-extern-decls",
318 "fno-hi-version-check",
320 "fno-method-sharing",
325 "funfolding-update-in-place",
335 || any (flip prefixMatch f) [
336 "fliberate-case-threshold",
339 "funfolding-creation-threshold",
340 "funfolding-use-threshold",
341 "funfolding-fun-discount",
342 "funfolding-keeness-factor"
347 -- Misc functions for command-line options
349 startsWith :: String -> String -> Maybe String
350 -- startsWith pfx (pfx++rest) = Just rest
352 startsWith [] str = Just str
353 startsWith (c:cs) (s:ss)
354 = if c /= s then Nothing else startsWith cs ss
355 startsWith _ [] = Nothing
358 -----------------------------------------------------------------------------
359 -- convert sizes like "3.5M" into integers
361 decodeSize :: String -> Integer
363 | c == "" = truncate n
364 | c == "K" || c == "k" = truncate (n * 1000)
365 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
366 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
367 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
368 where (m, c) = span pred str
370 pred c = isDigit c || c == '.'
373 -----------------------------------------------------------------------------
376 #if __GLASGOW_HASKELL__ >= 504
377 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
378 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
380 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
381 foreign import "enableTimingStats" unsafe enableTimingStats :: IO ()
384 -----------------------------------------------------------------------------
387 -- The central concept of a "way" is that all objects in a given
388 -- program must be compiled in the same "way". Certain options change
389 -- parameters of the virtual machine, eg. profiling adds an extra word
390 -- to the object header, so profiling objects cannot be linked with
391 -- non-profiling objects.
393 -- After parsing the command-line options, we determine which "way" we
394 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
396 -- We then find the "build-tag" associated with this way, and this
397 -- becomes the suffix used to find .hi files and libraries used in
400 GLOBAL_VAR(v_Build_tag, "", String)
402 -- The RTS has its own build tag, because there are some ways that
403 -- affect the RTS only.
404 GLOBAL_VAR(v_RTS_Build_tag, "", String)
434 GLOBAL_VAR(v_Ways, [] ,[WayName])
436 allowed_combination way = and [ x `allowedWith` y
437 | x <- way, y <- way, x < y ]
439 -- Note ordering in these tests: the left argument is
440 -- <= the right argument, according to the Ord instance
443 -- debug is allowed with everything
444 _ `allowedWith` WayDebug = True
445 WayDebug `allowedWith` _ = True
447 WayProf `allowedWith` WayUnreg = True
448 WayProf `allowedWith` WayNDP = True
449 _ `allowedWith` _ = False
452 findBuildTag :: IO [String] -- new options
454 way_names <- readIORef v_Ways
455 let ws = sort (nub way_names)
456 if not (allowed_combination ws)
457 then throwDyn (CmdLineError $
458 "combination not supported: " ++
459 foldr1 (\a b -> a ++ '/':b)
460 (map (wayName . lkupWay) ws))
461 else let ways = map lkupWay ws
462 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
463 rts_tag = mkBuildTag ways
464 flags = map wayOpts ways
466 writeIORef v_Build_tag tag
467 writeIORef v_RTS_Build_tag rts_tag
468 return (concat flags)
470 mkBuildTag :: [Way] -> String
471 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
474 case lookup w way_details of
475 Nothing -> error "findBuildTag"
476 Just details -> details
485 way_details :: [ (WayName, Way) ]
487 [ (WayThreaded, Way "thr" True "Threaded" [
488 #if defined(freebsd_TARGET_OS)
491 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
492 -- which GHC has some problems with. It's currently not clear whether
493 -- the problems are our fault or theirs, but it seems that using the
494 -- alternative 1:1 threading library libthr works around it:
496 #elif defined(solaris2_TARGET_OS)
501 (WayDebug, Way "debug" True "Debug" [] ),
503 (WayProf, Way "p" False "Profiling"
506 , "-optc-DPROFILING" ]),
508 (WayTicky, Way "t" False "Ticky-ticky Profiling"
511 , "-optc-DTICKY_TICKY" ]),
513 (WayUnreg, Way "u" False "Unregisterised"
516 -- optl's below to tell linker where to find the PVM library -- HWL
517 (WayPar, Way "mp" False "Parallel"
519 , "-D__PARALLEL_HASKELL__"
521 , "-package concurrent"
523 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
527 -- at the moment we only change the RTS and could share compiler and libs!
528 (WayPar, Way "mt" False "Parallel ticky profiling"
530 , "-D__PARALLEL_HASKELL__"
533 , "-package concurrent"
535 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
539 (WayPar, Way "md" False "Distributed"
541 , "-D__PARALLEL_HASKELL__"
542 , "-D__DISTRIBUTED_HASKELL__"
545 , "-package concurrent"
547 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
551 (WayGran, Way "mg" False "GranSim"
555 , "-package concurrent" ]),
557 (WayNDP, Way "ndp" False "Nested data parallelism"
561 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
562 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
563 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
564 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
565 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
566 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
567 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
568 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
569 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
570 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
571 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
572 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
573 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
574 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
575 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
576 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
577 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
582 , "-optc-DUSE_MINIINTERPRETER"
583 , "-fno-asm-mangling"