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"
75 import Util ( consIORef )
77 import Config ( cProjectVersionInt, cProjectPatchLevel,
79 import FastString ( FastString, mkFastString )
81 import Maybes ( firstJust )
82 import Panic ( GhcException(..), ghcError )
83 import Constants ( mAX_CONTEXT_REDUCTION_DEPTH )
85 import EXCEPTION ( throwDyn )
87 import UNSAFE_IO ( unsafePerformIO )
89 import Char ( isDigit )
90 import IO ( hPutStrLn, stderr ) -- ToDo: should use errorMsg
91 import List ( sort, intersperse )
93 -----------------------------------------------------------------------------
96 parseStaticFlags :: [String] -> IO [String]
97 parseStaticFlags args = do
98 (leftover, errs) <- processArgs static_flags args
99 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
101 -- deal with the way flags: the way (eg. prof) gives rise to
102 -- futher flags, some of which might be static.
103 way_flags <- findBuildTag
105 -- if we're unregisterised, add some more flags
106 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
109 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
110 when (not (null errs)) $ ghcError (UsageError (unlines errs))
111 return (more_leftover++leftover)
114 -- note that ordering is important in the following list: any flag which
115 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
116 -- flags further down the list with the same prefix.
118 static_flags :: [(String, OptKind IO)]
120 ------- GHCi -------------------------------------------------------
121 ( "ignore-dot-ghci", PassFlag addOpt )
122 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
124 ------- ways --------------------------------------------------------
125 , ( "prof" , NoArg (addWay WayProf) )
126 , ( "unreg" , NoArg (addWay WayUnreg) )
127 , ( "ticky" , NoArg (addWay WayTicky) )
128 , ( "parallel" , NoArg (addWay WayPar) )
129 , ( "gransim" , NoArg (addWay WayGran) )
130 , ( "smp" , NoArg (addWay WaySMP) )
131 , ( "debug" , NoArg (addWay WayDebug) )
132 , ( "ndp" , NoArg (addWay WayNDP) )
133 , ( "threaded" , NoArg (addWay WayThreaded) )
136 ------ Debugging ----------------------------------------------------
137 , ( "dppr-noprags", PassFlag addOpt )
138 , ( "dppr-debug", PassFlag addOpt )
139 , ( "dppr-user-length", AnySuffix addOpt )
140 -- rest of the debugging flags are dynamic
142 --------- Profiling --------------------------------------------------
143 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
144 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
145 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
146 -- "ignore-sccs" doesn't work (ToDo)
148 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
149 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
150 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
152 ------- Miscellaneous -----------------------------------------------
153 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
155 ----- Linker --------------------------------------------------------
156 , ( "static" , PassFlag addOpt )
157 , ( "dynamic" , NoArg (removeOpt "-static") )
158 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
160 ----- RTS opts ------------------------------------------------------
161 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
162 , ( "Rghc-timing" , NoArg (enableTimingStats) )
164 ------ Compiler flags -----------------------------------------------
165 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
166 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
167 (\s -> removeOpt ("-f"++s)) )
169 -- Pass all remaining "-f<blah>" options to hsc
170 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
173 addOpt = consIORef v_opt_C
175 addWay = consIORef v_Ways
178 fs <- readIORef v_opt_C
179 writeIORef v_opt_C $! filter (/= f) fs
181 lookUp :: FastString -> Bool
182 lookup_def_int :: String -> Int -> Int
183 lookup_def_float :: String -> Float -> Float
184 lookup_str :: String -> Maybe String
186 -- holds the static opts while they're being collected, before
187 -- being unsafely read by unpacked_static_opts below.
188 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
189 staticFlags = unsafePerformIO (readIORef v_opt_C)
191 -- -static is the default
192 defaultStaticOpts = ["-static"]
194 packed_static_opts = map mkFastString staticFlags
196 lookUp sw = sw `elem` packed_static_opts
198 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
199 -- and returns the string X
201 = case firstJust (map (startsWith sw) staticFlags) of
202 Just ('=' : str) -> Just str
206 lookup_def_int sw def = case (lookup_str sw) of
207 Nothing -> def -- Use default
208 Just xx -> try_read sw xx
210 lookup_def_float sw def = case (lookup_str sw) of
211 Nothing -> def -- Use default
212 Just xx -> try_read sw xx
215 try_read :: Read a => String -> String -> a
216 -- (try_read sw str) tries to read s; if it fails, it
217 -- bleats about flag sw
220 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
221 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
222 -- ToDo: hack alert. We should really parse the arugments
223 -- and announce errors in a more civilised way.
227 Putting the compiler options into temporary at-files
228 may turn out to be necessary later on if we turn hsc into
229 a pure Win32 application where I think there's a command-line
230 length limit of 255. unpacked_opts understands the @ option.
232 unpacked_opts :: [String]
236 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
238 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
243 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
246 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
247 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
250 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
251 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
252 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
253 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
254 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
257 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
258 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
259 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
260 opt_Parallel = lookUp FSLIT("-fparallel")
261 opt_SMP = lookUp FSLIT("-fsmp")
262 opt_Flatten = lookUp FSLIT("-fflatten")
265 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
266 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
267 opt_CprOff = lookUp FSLIT("-fcpr-off")
268 opt_RulesOff = lookUp FSLIT("-frules-off")
269 -- Switch off CPR analysis in the new demand analyser
270 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
271 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
273 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
274 opt_GranMacros = lookUp FSLIT("-fgransim")
275 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
276 opt_HistorySize = lookup_def_int "-fhistory-size" 20
277 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
278 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
280 -- Simplifier switches
281 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
282 -- NoPreInlining is there just to see how bad things
283 -- get if you don't do it!
284 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
287 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
288 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
289 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
290 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
291 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
293 opt_UF_DearOp = ( 4 :: Int)
295 opt_Static = lookUp FSLIT("-static")
296 opt_Unregisterised = lookUp FSLIT("-funregisterised")
297 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
299 -- Include full span info in error messages, instead of just the start position.
300 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
302 opt_PIC = lookUp FSLIT("-fPIC")
304 -- object files and libraries to be linked in are collected here.
305 -- ToDo: perhaps this could be done without a global, it wasn't obvious
306 -- how to do it though --SDM.
307 GLOBAL_VAR(v_Ld_inputs, [], [String])
311 "fauto-sccs-on-all-toplevs",
312 "fauto-sccs-on-exported-toplevs",
313 "fauto-sccs-on-individual-cafs",
318 "firrefutable-tuples",
324 "femit-extern-decls",
325 "fglobalise-toplev-names",
327 "fno-hi-version-check",
329 "fno-method-sharing",
334 "funfolding-update-in-place",
344 || any (flip prefixMatch f) [
346 "fliberate-case-threshold",
349 "funfolding-creation-threshold",
350 "funfolding-use-threshold",
351 "funfolding-fun-discount",
352 "funfolding-keeness-factor"
357 -- Misc functions for command-line options
359 startsWith :: String -> String -> Maybe String
360 -- startsWith pfx (pfx++rest) = Just rest
362 startsWith [] str = Just str
363 startsWith (c:cs) (s:ss)
364 = if c /= s then Nothing else startsWith cs ss
365 startsWith _ [] = Nothing
368 -----------------------------------------------------------------------------
369 -- convert sizes like "3.5M" into integers
371 decodeSize :: String -> Integer
373 | c == "" = truncate n
374 | c == "K" || c == "k" = truncate (n * 1000)
375 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
376 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
377 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
378 where (m, c) = span pred str
380 pred c = isDigit c || c == '.'
383 -----------------------------------------------------------------------------
386 #if __GLASGOW_HASKELL__ >= 504
387 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
388 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
390 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
391 foreign import "enableTimingStats" unsafe enableTimingStats :: IO ()
394 -----------------------------------------------------------------------------
397 -- The central concept of a "way" is that all objects in a given
398 -- program must be compiled in the same "way". Certain options change
399 -- parameters of the virtual machine, eg. profiling adds an extra word
400 -- to the object header, so profiling objects cannot be linked with
401 -- non-profiling objects.
403 -- After parsing the command-line options, we determine which "way" we
404 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
406 -- We then find the "build-tag" associated with this way, and this
407 -- becomes the suffix used to find .hi files and libraries used in
410 GLOBAL_VAR(v_Build_tag, "", String)
412 -- The RTS has its own build tag, because there are some ways that
413 -- affect the RTS only.
414 GLOBAL_VAR(v_RTS_Build_tag, "", String)
445 GLOBAL_VAR(v_Ways, [] ,[WayName])
447 allowed_combination way = and [ x `allowedWith` y
448 | x <- way, y <- way, x < y ]
450 -- Note ordering in these tests: the left argument is
451 -- <= the right argument, according to the Ord instance
454 -- debug is allowed with everything
455 _ `allowedWith` WayDebug = True
456 WayDebug `allowedWith` _ = True
458 WayThreaded `allowedWith` WayProf = True
459 WayProf `allowedWith` WayUnreg = True
460 WayProf `allowedWith` WaySMP = True
461 WayProf `allowedWith` WayNDP = True
462 _ `allowedWith` _ = False
465 findBuildTag :: IO [String] -- new options
467 way_names <- readIORef v_Ways
468 let ws = sort way_names
469 if not (allowed_combination ws)
470 then throwDyn (CmdLineError $
471 "combination not supported: " ++
472 foldr1 (\a b -> a ++ '/':b)
473 (map (wayName . lkupWay) ws))
474 else let ways = map lkupWay ws
475 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
476 rts_tag = mkBuildTag ways
477 flags = map wayOpts ways
479 writeIORef v_Build_tag tag
480 writeIORef v_RTS_Build_tag rts_tag
481 return (concat flags)
483 mkBuildTag :: [Way] -> String
484 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
487 case lookup w way_details of
488 Nothing -> error "findBuildTag"
489 Just details -> details
498 way_details :: [ (WayName, Way) ]
500 [ (WayThreaded, Way "thr" True "Threaded" [
501 #if defined(freebsd_TARGET_OS)
507 (WayDebug, Way "debug" True "Debug" [] ),
509 (WayProf, Way "p" False "Profiling"
515 (WayTicky, Way "t" False "Ticky-ticky Profiling"
518 , "-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}"
536 -- at the moment we only change the RTS and could share compiler and libs!
537 (WayPar, Way "mt" False "Parallel ticky profiling"
539 , "-D__PARALLEL_HASKELL__"
542 , "-package concurrent"
544 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
549 (WayPar, Way "md" False "Distributed"
551 , "-D__PARALLEL_HASKELL__"
552 , "-D__DISTRIBUTED_HASKELL__"
555 , "-package concurrent"
557 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
562 (WayGran, Way "mg" False "GranSim"
566 , "-package concurrent"
569 (WaySMP, Way "s" False "SMP"
572 #ifndef freebsd_TARGET_OS
578 (WayNDP, Way "ndp" False "Nested data parallelism"
582 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
583 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
584 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
585 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
586 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
587 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
588 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
589 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
590 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
591 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
592 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
593 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
594 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
595 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
596 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
597 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
598 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
603 , "-optc-DUSE_MINIINTERPRETER"
604 , "-fno-asm-mangling"