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,
36 opt_IrrefutableTuples,
46 opt_SimplNoPreInlining,
47 opt_SimplExcessPrecision,
51 opt_UF_CreationThreshold,
53 opt_UF_FunAppDiscount,
75 #include "HsVersions.h"
79 import FastString ( FastString, mkFastString )
81 import Maybes ( firstJust )
84 import Control.Exception ( throwDyn )
86 import System.IO.Unsafe ( unsafePerformIO )
87 import Control.Monad ( when )
88 import Data.Char ( isDigit )
89 import Data.List ( sort, intersperse, nub )
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 -- further 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)
109 -- see sanity code in staticOpts
110 writeIORef v_opt_C_ready True
112 -- TABLES_NEXT_TO_CODE affects the info table layout.
113 -- Be careful to do this *after* all processArgs,
114 -- because evaluating tablesNextToCode involves looking at the global
115 -- static flags. Those pesky global variables...
116 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
119 when (not (null errs)) $ ghcError (UsageError (unlines errs))
120 return (cg_flags++more_leftover++leftover)
123 static_flags :: [(String, OptKind IO)]
124 -- All the static flags should appear in this list. It describes how each
125 -- static flag should be processed. Two main purposes:
126 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
127 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
129 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
130 -- things that are searched up by the top-level definitions like
131 -- opt_foo = lookUp FSLIT("-dfoo")
133 -- Note that ordering is important in the following list: any flag which
134 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
135 -- flags further down the list with the same prefix.
138 ------- GHCi -------------------------------------------------------
139 ( "ignore-dot-ghci", PassFlag addOpt )
140 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
142 ------- ways --------------------------------------------------------
143 , ( "prof" , NoArg (addWay WayProf) )
144 , ( "unreg" , NoArg (addWay WayUnreg) )
145 , ( "ticky" , NoArg (addWay WayTicky) )
146 , ( "parallel" , NoArg (addWay WayPar) )
147 , ( "gransim" , NoArg (addWay WayGran) )
148 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
149 , ( "debug" , NoArg (addWay WayDebug) )
150 , ( "ndp" , NoArg (addWay WayNDP) )
151 , ( "threaded" , NoArg (addWay WayThreaded) )
154 ------ Debugging ----------------------------------------------------
155 , ( "dppr-debug", PassFlag addOpt )
156 , ( "dppr-user-length", AnySuffix addOpt )
157 -- rest of the debugging flags are dynamic
159 --------- Haskell Program Coverage -----------------------------------
161 , ( "fhpc" , PassFlag addOpt )
162 , ( "fhpc-tracer" , PassFlag addOpt )
164 --------- Profiling --------------------------------------------------
165 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
166 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
167 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
168 -- "ignore-sccs" doesn't work (ToDo)
170 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
171 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
172 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
174 ------- Miscellaneous -----------------------------------------------
175 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
177 ----- Linker --------------------------------------------------------
178 , ( "static" , PassFlag addOpt )
179 , ( "dynamic" , NoArg (removeOpt "-static") )
180 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
182 ----- RTS opts ------------------------------------------------------
183 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
184 , ( "Rghc-timing" , NoArg (enableTimingStats) )
186 ------ Compiler flags -----------------------------------------------
187 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
188 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
189 (\s -> removeOpt ("-f"++s)) )
191 -- Pass all remaining "-f<blah>" options to hsc
192 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
195 addOpt = consIORef v_opt_C
197 addWay = consIORef v_Ways
200 fs <- readIORef v_opt_C
201 writeIORef v_opt_C $! filter (/= f) fs
203 lookUp :: FastString -> Bool
204 lookup_def_int :: String -> Int -> Int
205 lookup_def_float :: String -> Float -> Float
206 lookup_str :: String -> Maybe String
208 -- holds the static opts while they're being collected, before
209 -- being unsafely read by unpacked_static_opts below.
210 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
211 GLOBAL_VAR(v_opt_C_ready, False, Bool)
212 staticFlags = unsafePerformIO $ do
213 ready <- readIORef v_opt_C_ready
215 then panic "a static opt was looked at too early!"
216 else readIORef v_opt_C
218 -- -static is the default
219 defaultStaticOpts = ["-static"]
221 packed_static_opts = map mkFastString staticFlags
223 lookUp sw = sw `elem` packed_static_opts
225 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
226 -- and returns the string X
228 = case firstJust (map (startsWith sw) staticFlags) of
229 Just ('=' : str) -> Just str
233 lookup_def_int sw def = case (lookup_str sw) of
234 Nothing -> def -- Use default
235 Just xx -> try_read sw xx
237 lookup_def_float sw def = case (lookup_str sw) of
238 Nothing -> def -- Use default
239 Just xx -> try_read sw xx
242 try_read :: Read a => String -> String -> a
243 -- (try_read sw str) tries to read s; if it fails, it
244 -- bleats about flag sw
247 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
248 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
249 -- ToDo: hack alert. We should really parse the arugments
250 -- and announce errors in a more civilised way.
254 Putting the compiler options into temporary at-files
255 may turn out to be necessary later on if we turn hsc into
256 a pure Win32 application where I think there's a command-line
257 length limit of 255. unpacked_opts understands the @ option.
259 unpacked_opts :: [String]
263 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
265 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
270 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
273 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
274 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
277 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
278 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
279 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
280 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
281 opt_DoTickyProfiling = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
285 opt_Hpc = lookUp FSLIT("-fhpc")
287 opt_Hpc_Tracer = lookUp FSLIT("-fhpc-tracer")
290 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
291 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
292 opt_Parallel = lookUp FSLIT("-fparallel")
293 opt_Flatten = lookUp FSLIT("-fflatten")
296 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
297 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
298 opt_CprOff = lookUp FSLIT("-fcpr-off")
299 opt_RulesOff = lookUp FSLIT("-frules-off")
300 -- Switch off CPR analysis in the new demand analyser
301 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
303 opt_GranMacros = lookUp FSLIT("-fgransim")
304 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
305 opt_HistorySize = lookup_def_int "-fhistory-size" 20
306 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
307 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
309 -- Simplifier switches
310 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
311 -- NoPreInlining is there just to see how bad things
312 -- get if you don't do it!
313 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
316 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
317 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
318 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
319 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
320 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
322 opt_UF_DearOp = ( 4 :: Int)
324 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
327 opt_PIC = lookUp FSLIT("-fPIC")
329 opt_Static = lookUp FSLIT("-static")
330 opt_Unregisterised = lookUp FSLIT("-funregisterised")
332 -- Derived, not a real option. Determines whether we will be compiling
333 -- info tables that reside just before the entry code, or with an
334 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
335 -- includes/InfoTables.h.
336 tablesNextToCode = not opt_Unregisterised
337 && cGhcEnableTablesNextToCode == "YES"
339 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
341 -- Include full span info in error messages, instead of just the start position.
342 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
345 -- object files and libraries to be linked in are collected here.
346 -- ToDo: perhaps this could be done without a global, it wasn't obvious
347 -- how to do it though --SDM.
348 GLOBAL_VAR(v_Ld_inputs, [], [String])
352 "fauto-sccs-on-all-toplevs",
353 "fauto-sccs-on-exported-toplevs",
354 "fauto-sccs-on-individual-cafs",
357 "firrefutable-tuples",
361 "fno-hi-version-check",
363 "fno-method-sharing",
368 "funfolding-update-in-place",
377 || any (flip prefixMatch f) [
378 "fliberate-case-threshold",
381 "funfolding-creation-threshold",
382 "funfolding-use-threshold",
383 "funfolding-fun-discount",
384 "funfolding-keeness-factor"
389 -- Misc functions for command-line options
391 startsWith :: String -> String -> Maybe String
392 -- startsWith pfx (pfx++rest) = Just rest
394 startsWith [] str = Just str
395 startsWith (c:cs) (s:ss)
396 = if c /= s then Nothing else startsWith cs ss
397 startsWith _ [] = Nothing
400 -----------------------------------------------------------------------------
401 -- convert sizes like "3.5M" into integers
403 decodeSize :: String -> Integer
405 | c == "" = truncate n
406 | c == "K" || c == "k" = truncate (n * 1000)
407 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
408 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
409 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
410 where (m, c) = span pred str
412 pred c = isDigit c || c == '.'
415 -----------------------------------------------------------------------------
418 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
419 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
421 -----------------------------------------------------------------------------
424 -- The central concept of a "way" is that all objects in a given
425 -- program must be compiled in the same "way". Certain options change
426 -- parameters of the virtual machine, eg. profiling adds an extra word
427 -- to the object header, so profiling objects cannot be linked with
428 -- non-profiling objects.
430 -- After parsing the command-line options, we determine which "way" we
431 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
433 -- We then find the "build-tag" associated with this way, and this
434 -- becomes the suffix used to find .hi files and libraries used in
437 GLOBAL_VAR(v_Build_tag, "", String)
439 -- The RTS has its own build tag, because there are some ways that
440 -- affect the RTS only.
441 GLOBAL_VAR(v_RTS_Build_tag, "", String)
471 GLOBAL_VAR(v_Ways, [] ,[WayName])
473 allowed_combination way = and [ x `allowedWith` y
474 | x <- way, y <- way, x < y ]
476 -- Note ordering in these tests: the left argument is
477 -- <= the right argument, according to the Ord instance
480 -- debug is allowed with everything
481 _ `allowedWith` WayDebug = True
482 WayDebug `allowedWith` _ = True
484 WayProf `allowedWith` WayUnreg = True
485 WayProf `allowedWith` WayNDP = True
486 _ `allowedWith` _ = False
489 findBuildTag :: IO [String] -- new options
491 way_names <- readIORef v_Ways
492 let ws = sort (nub way_names)
494 if not (allowed_combination ws)
495 then throwDyn (CmdLineError $
496 "combination not supported: " ++
497 foldr1 (\a b -> a ++ '/':b)
498 (map (wayName . lkupWay) ws))
499 else let ways = map lkupWay ws
500 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
501 rts_tag = mkBuildTag ways
502 flags = map wayOpts ways
504 writeIORef v_Build_tag tag
505 writeIORef v_RTS_Build_tag rts_tag
506 return (concat flags)
510 mkBuildTag :: [Way] -> String
511 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
514 case lookup w way_details of
515 Nothing -> error "findBuildTag"
516 Just details -> details
525 way_details :: [ (WayName, Way) ]
527 [ (WayThreaded, Way "thr" True "Threaded" [
528 #if defined(freebsd_TARGET_OS)
531 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
532 -- which GHC has some problems with. It's currently not clear whether
533 -- the problems are our fault or theirs, but it seems that using the
534 -- alternative 1:1 threading library libthr works around it:
536 #elif defined(solaris2_TARGET_OS)
541 (WayDebug, Way "debug" True "Debug" [] ),
543 (WayProf, Way "p" False "Profiling"
546 , "-optc-DPROFILING" ]),
548 (WayTicky, Way "t" True "Ticky-ticky Profiling"
550 , "-optc-DTICKY_TICKY" ]),
552 (WayUnreg, Way "u" False "Unregisterised"
555 -- optl's below to tell linker where to find the PVM library -- HWL
556 (WayPar, Way "mp" False "Parallel"
558 , "-D__PARALLEL_HASKELL__"
560 , "-package concurrent"
562 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
566 -- at the moment we only change the RTS and could share compiler and libs!
567 (WayPar, Way "mt" False "Parallel ticky profiling"
569 , "-D__PARALLEL_HASKELL__"
572 , "-package concurrent"
574 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
578 (WayPar, Way "md" False "Distributed"
580 , "-D__PARALLEL_HASKELL__"
581 , "-D__DISTRIBUTED_HASKELL__"
584 , "-package concurrent"
586 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
590 (WayGran, Way "mg" False "GranSim"
594 , "-package concurrent" ]),
596 (WayNDP, Way "ndp" False "Nested data parallelism"
600 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
601 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
602 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
603 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
604 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
605 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
606 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
607 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
608 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
609 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
610 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
611 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
612 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
613 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
614 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
615 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
616 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
621 , "-optc-DUSE_MINIINTERPRETER"
622 , "-fno-asm-mangling"