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_MaxContextReductionDepth,
33 opt_IrrefutableTuples,
42 opt_LiberateCaseThreshold,
45 opt_SimplNoPreInlining,
46 opt_SimplExcessPrecision,
50 opt_UF_CreationThreshold,
52 opt_UF_FunAppDiscount,
72 #include "HsVersions.h"
74 import Util ( consIORef )
76 import Config ( cProjectVersionInt, cProjectPatchLevel,
78 import FastString ( FastString, mkFastString )
80 import Maybes ( firstJust )
81 import Panic ( GhcException(..), ghcError )
82 import Constants ( mAX_CONTEXT_REDUCTION_DEPTH )
84 import EXCEPTION ( throwDyn )
86 import UNSAFE_IO ( unsafePerformIO )
88 import Char ( isDigit )
89 import List ( sort, intersperse )
91 -----------------------------------------------------------------------------
94 parseStaticFlags :: [String] -> IO [String]
95 parseStaticFlags args = do
96 (leftover, errs) <- processArgs static_flags args
97 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
99 -- deal with the way flags: the way (eg. prof) gives rise to
100 -- futher flags, some of which might be static.
101 way_flags <- findBuildTag
103 -- if we're unregisterised, add some more flags
104 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
107 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
108 when (not (null errs)) $ ghcError (UsageError (unlines errs))
109 return (more_leftover++leftover)
112 -- note that ordering is important in the following list: any flag which
113 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
114 -- flags further down the list with the same prefix.
116 static_flags :: [(String, OptKind IO)]
118 ------- GHCi -------------------------------------------------------
119 ( "ignore-dot-ghci", PassFlag addOpt )
120 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
122 ------- ways --------------------------------------------------------
123 , ( "prof" , NoArg (addWay WayProf) )
124 , ( "unreg" , NoArg (addWay WayUnreg) )
125 , ( "ticky" , NoArg (addWay WayTicky) )
126 , ( "parallel" , NoArg (addWay WayPar) )
127 , ( "gransim" , NoArg (addWay WayGran) )
128 , ( "smp" , NoArg (addWay WaySMP) )
129 , ( "debug" , NoArg (addWay WayDebug) )
130 , ( "ndp" , NoArg (addWay WayNDP) )
131 , ( "threaded" , NoArg (addWay WayThreaded) )
134 ------ Debugging ----------------------------------------------------
135 , ( "dppr-noprags", PassFlag addOpt )
136 , ( "dppr-debug", PassFlag addOpt )
137 , ( "dppr-user-length", AnySuffix addOpt )
138 -- rest of the debugging flags are dynamic
140 --------- Profiling --------------------------------------------------
141 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
142 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
143 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
144 -- "ignore-sccs" doesn't work (ToDo)
146 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
147 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
148 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
150 ------- Miscellaneous -----------------------------------------------
151 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
153 ----- Linker --------------------------------------------------------
154 , ( "static" , PassFlag addOpt )
155 , ( "dynamic" , NoArg (removeOpt "-static") )
156 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
158 ----- RTS opts ------------------------------------------------------
159 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
160 , ( "Rghc-timing" , NoArg (enableTimingStats) )
162 ------ Compiler flags -----------------------------------------------
163 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
164 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
165 (\s -> removeOpt ("-f"++s)) )
167 -- Pass all remaining "-f<blah>" options to hsc
168 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
171 addOpt = consIORef v_opt_C
173 addWay = consIORef v_Ways
176 fs <- readIORef v_opt_C
177 writeIORef v_opt_C $! filter (/= f) fs
179 lookUp :: FastString -> Bool
180 lookup_def_int :: String -> Int -> Int
181 lookup_def_float :: String -> Float -> Float
182 lookup_str :: String -> Maybe String
184 -- holds the static opts while they're being collected, before
185 -- being unsafely read by unpacked_static_opts below.
186 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
187 staticFlags = unsafePerformIO (readIORef v_opt_C)
189 -- -static is the default
190 defaultStaticOpts = ["-static"]
192 packed_static_opts = map mkFastString staticFlags
194 lookUp sw = sw `elem` packed_static_opts
196 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
197 -- and returns the string X
199 = case firstJust (map (startsWith sw) staticFlags) of
200 Just ('=' : str) -> Just str
204 lookup_def_int sw def = case (lookup_str sw) of
205 Nothing -> def -- Use default
206 Just xx -> try_read sw xx
208 lookup_def_float sw def = case (lookup_str sw) of
209 Nothing -> def -- Use default
210 Just xx -> try_read sw xx
213 try_read :: Read a => String -> String -> a
214 -- (try_read sw str) tries to read s; if it fails, it
215 -- bleats about flag sw
218 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
219 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
220 -- ToDo: hack alert. We should really parse the arugments
221 -- and announce errors in a more civilised way.
225 Putting the compiler options into temporary at-files
226 may turn out to be necessary later on if we turn hsc into
227 a pure Win32 application where I think there's a command-line
228 length limit of 255. unpacked_opts understands the @ option.
230 unpacked_opts :: [String]
234 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
236 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
241 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
244 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
245 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
248 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
249 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
250 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
251 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
252 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
255 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
256 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
257 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
258 opt_Parallel = lookUp FSLIT("-fparallel")
259 opt_SMP = lookUp FSLIT("-fsmp")
260 opt_Flatten = lookUp FSLIT("-fflatten")
263 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
264 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
265 opt_CprOff = lookUp FSLIT("-fcpr-off")
266 opt_RulesOff = lookUp FSLIT("-frules-off")
267 -- Switch off CPR analysis in the new demand analyser
268 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
269 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
271 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
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")
295 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
297 -- Include full span info in error messages, instead of just the start position.
298 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
300 opt_PIC = lookUp FSLIT("-fPIC")
302 -- object files and libraries to be linked in are collected here.
303 -- ToDo: perhaps this could be done without a global, it wasn't obvious
304 -- how to do it though --SDM.
305 GLOBAL_VAR(v_Ld_inputs, [], [String])
309 "fauto-sccs-on-all-toplevs",
310 "fauto-sccs-on-exported-toplevs",
311 "fauto-sccs-on-individual-cafs",
316 "firrefutable-tuples",
322 "femit-extern-decls",
323 "fglobalise-toplev-names",
325 "fno-hi-version-check",
327 "fno-method-sharing",
332 "funfolding-update-in-place",
342 || 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)
443 GLOBAL_VAR(v_Ways, [] ,[WayName])
445 allowed_combination way = and [ x `allowedWith` y
446 | x <- way, y <- way, x < y ]
448 -- Note ordering in these tests: the left argument is
449 -- <= the right argument, according to the Ord instance
452 -- debug is allowed with everything
453 _ `allowedWith` WayDebug = True
454 WayDebug `allowedWith` _ = True
456 WayThreaded `allowedWith` WayProf = True
457 WayProf `allowedWith` WayUnreg = True
458 WayProf `allowedWith` WaySMP = True
459 WayProf `allowedWith` WayNDP = True
460 _ `allowedWith` _ = False
463 findBuildTag :: IO [String] -- new options
465 way_names <- readIORef v_Ways
466 let ws = sort way_names
467 if not (allowed_combination ws)
468 then throwDyn (CmdLineError $
469 "combination not supported: " ++
470 foldr1 (\a b -> a ++ '/':b)
471 (map (wayName . lkupWay) ws))
472 else let ways = map lkupWay ws
473 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
474 rts_tag = mkBuildTag ways
475 flags = map wayOpts ways
477 writeIORef v_Build_tag tag
478 writeIORef v_RTS_Build_tag rts_tag
479 return (concat flags)
481 mkBuildTag :: [Way] -> String
482 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
485 case lookup w way_details of
486 Nothing -> error "findBuildTag"
487 Just details -> details
496 way_details :: [ (WayName, Way) ]
498 [ (WayThreaded, Way "thr" True "Threaded" [
499 #if defined(freebsd_TARGET_OS)
505 (WayDebug, Way "debug" True "Debug" [] ),
507 (WayProf, Way "p" False "Profiling"
510 , "-optc-DPROFILING" ]),
512 (WayTicky, Way "t" False "Ticky-ticky Profiling"
515 , "-optc-DTICKY_TICKY" ]),
517 (WayUnreg, Way "u" False "Unregisterised"
520 -- optl's below to tell linker where to find the PVM library -- HWL
521 (WayPar, Way "mp" False "Parallel"
523 , "-D__PARALLEL_HASKELL__"
525 , "-package concurrent"
527 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
531 -- at the moment we only change the RTS and could share compiler and libs!
532 (WayPar, Way "mt" False "Parallel ticky profiling"
534 , "-D__PARALLEL_HASKELL__"
537 , "-package concurrent"
539 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
543 (WayPar, Way "md" False "Distributed"
545 , "-D__PARALLEL_HASKELL__"
546 , "-D__DISTRIBUTED_HASKELL__"
549 , "-package concurrent"
551 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
555 (WayGran, Way "mg" False "GranSim"
559 , "-package concurrent" ]),
561 (WaySMP, Way "s" False "SMP"
563 #if !defined(mingw32_TARGET_OS)
566 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
571 (WayNDP, Way "ndp" False "Nested data parallelism"
575 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
576 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
577 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
578 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
579 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
580 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
581 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
582 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
583 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
584 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
585 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
586 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
587 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
588 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
589 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
590 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
591 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
596 , "-optc-DUSE_MINIINTERPRETER"
597 , "-fno-asm-mangling"