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,
44 opt_LiberateCaseThreshold,
47 opt_SimplNoPreInlining,
48 opt_SimplExcessPrecision,
52 opt_UF_CreationThreshold,
54 opt_UF_FunAppDiscount,
76 #include "HsVersions.h"
80 import FastString ( FastString, mkFastString )
82 import Maybes ( firstJust )
83 import Panic ( GhcException(..), ghcError )
85 import Control.Exception ( throwDyn )
87 import System.IO.Unsafe ( unsafePerformIO )
88 import Control.Monad ( when )
89 import Data.Char ( isDigit )
90 import Data.List ( sort, intersperse, nub )
92 -----------------------------------------------------------------------------
95 parseStaticFlags :: [String] -> IO [String]
96 parseStaticFlags args = do
97 (leftover, errs) <- processArgs static_flags args
98 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
100 -- deal with the way flags: the way (eg. prof) gives rise to
101 -- futher flags, some of which might be static.
102 way_flags <- findBuildTag
104 -- if we're unregisterised, add some more flags
105 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
108 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
110 -- TABLES_NEXT_TO_CODE affects the info table layout.
111 -- Be careful to do this *after* all processArgs,
112 -- because evaluating tablesNextToCode involves looking at the global
113 -- static flags. Those pesky global variables...
114 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
117 when (not (null errs)) $ ghcError (UsageError (unlines errs))
118 return (cg_flags++more_leftover++leftover)
121 static_flags :: [(String, OptKind IO)]
122 -- All the static flags should appear in this list. It describes how each
123 -- static flag should be processed. Two main purposes:
124 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
125 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
127 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
128 -- things that are searched up by the top-level definitions like
129 -- opt_foo = lookUp FSLIT("-dfoo")
131 -- Note that ordering is important in the following list: any flag which
132 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
133 -- flags further down the list with the same prefix.
136 ------- GHCi -------------------------------------------------------
137 ( "ignore-dot-ghci", PassFlag addOpt )
138 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
140 ------- ways --------------------------------------------------------
141 , ( "prof" , NoArg (addWay WayProf) )
142 , ( "unreg" , NoArg (addWay WayUnreg) )
143 , ( "ticky" , NoArg (addWay WayTicky) )
144 , ( "parallel" , NoArg (addWay WayPar) )
145 , ( "gransim" , NoArg (addWay WayGran) )
146 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
147 , ( "debug" , NoArg (addWay WayDebug) )
148 , ( "ndp" , NoArg (addWay WayNDP) )
149 , ( "threaded" , NoArg (addWay WayThreaded) )
152 ------ Debugging ----------------------------------------------------
153 , ( "dppr-debug", PassFlag addOpt )
154 , ( "dppr-user-length", AnySuffix addOpt )
155 -- rest of the debugging flags are dynamic
157 --------- Haskell Program Coverage -----------------------------------
159 , ( "fhpc" , PassFlag addOpt )
160 , ( "fhpc-tracer" , PassFlag addOpt )
162 --------- Profiling --------------------------------------------------
163 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
164 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
165 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
166 -- "ignore-sccs" doesn't work (ToDo)
168 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
169 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
170 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
172 ------- Miscellaneous -----------------------------------------------
173 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
175 ----- Linker --------------------------------------------------------
176 , ( "static" , PassFlag addOpt )
177 , ( "dynamic" , NoArg (removeOpt "-static") )
178 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
180 ----- RTS opts ------------------------------------------------------
181 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
182 , ( "Rghc-timing" , NoArg (enableTimingStats) )
184 ------ Compiler flags -----------------------------------------------
185 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
186 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
187 (\s -> removeOpt ("-f"++s)) )
189 -- Pass all remaining "-f<blah>" options to hsc
190 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
193 addOpt = consIORef v_opt_C
195 addWay = consIORef v_Ways
198 fs <- readIORef v_opt_C
199 writeIORef v_opt_C $! filter (/= f) fs
201 lookUp :: FastString -> Bool
202 lookup_def_int :: String -> Int -> Int
203 lookup_def_float :: String -> Float -> Float
204 lookup_str :: String -> Maybe String
206 -- holds the static opts while they're being collected, before
207 -- being unsafely read by unpacked_static_opts below.
208 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
209 staticFlags = unsafePerformIO (readIORef v_opt_C)
211 -- -static is the default
212 defaultStaticOpts = ["-static"]
214 packed_static_opts = map mkFastString staticFlags
216 lookUp sw = sw `elem` packed_static_opts
218 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
219 -- and returns the string X
221 = case firstJust (map (startsWith sw) staticFlags) of
222 Just ('=' : str) -> Just str
226 lookup_def_int sw def = case (lookup_str sw) of
227 Nothing -> def -- Use default
228 Just xx -> try_read sw xx
230 lookup_def_float sw def = case (lookup_str sw) of
231 Nothing -> def -- Use default
232 Just xx -> try_read sw xx
235 try_read :: Read a => String -> String -> a
236 -- (try_read sw str) tries to read s; if it fails, it
237 -- bleats about flag sw
240 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
241 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
242 -- ToDo: hack alert. We should really parse the arugments
243 -- and announce errors in a more civilised way.
247 Putting the compiler options into temporary at-files
248 may turn out to be necessary later on if we turn hsc into
249 a pure Win32 application where I think there's a command-line
250 length limit of 255. unpacked_opts understands the @ option.
252 unpacked_opts :: [String]
256 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
258 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
263 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
266 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
267 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
270 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
271 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
272 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
273 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
274 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
279 opt_Hpc = lookUp FSLIT("-fhpc")
281 opt_Hpc_Tracer = lookUp FSLIT("-fhpc-tracer")
284 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
285 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
286 opt_Parallel = lookUp FSLIT("-fparallel")
287 opt_Flatten = lookUp FSLIT("-fflatten")
290 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
291 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
292 opt_CprOff = lookUp FSLIT("-fcpr-off")
293 opt_RulesOff = lookUp FSLIT("-frules-off")
294 -- Switch off CPR analysis in the new demand analyser
295 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
296 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
298 opt_GranMacros = lookUp FSLIT("-fgransim")
299 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
300 opt_HistorySize = lookup_def_int "-fhistory-size" 20
301 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
302 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
304 -- Simplifier switches
305 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
306 -- NoPreInlining is there just to see how bad things
307 -- get if you don't do it!
308 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
311 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
312 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
313 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
314 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
315 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
317 opt_UF_DearOp = ( 4 :: Int)
319 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
322 opt_PIC = lookUp FSLIT("-fPIC")
324 opt_Static = lookUp FSLIT("-static")
325 opt_Unregisterised = lookUp FSLIT("-funregisterised")
327 -- Derived, not a real option. Determines whether we will be compiling
328 -- info tables that reside just before the entry code, or with an
329 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
330 -- includes/InfoTables.h.
331 tablesNextToCode = not opt_Unregisterised
332 && cGhcEnableTablesNextToCode == "YES"
334 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
336 -- Include full span info in error messages, instead of just the start position.
337 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
340 -- object files and libraries to be linked in are collected here.
341 -- ToDo: perhaps this could be done without a global, it wasn't obvious
342 -- how to do it though --SDM.
343 GLOBAL_VAR(v_Ld_inputs, [], [String])
347 "fauto-sccs-on-all-toplevs",
348 "fauto-sccs-on-exported-toplevs",
349 "fauto-sccs-on-individual-cafs",
353 "firrefutable-tuples",
357 "fno-hi-version-check",
359 "fno-method-sharing",
364 "funfolding-update-in-place",
373 || any (flip prefixMatch f) [
374 "fliberate-case-threshold",
377 "funfolding-creation-threshold",
378 "funfolding-use-threshold",
379 "funfolding-fun-discount",
380 "funfolding-keeness-factor"
385 -- Misc functions for command-line options
387 startsWith :: String -> String -> Maybe String
388 -- startsWith pfx (pfx++rest) = Just rest
390 startsWith [] str = Just str
391 startsWith (c:cs) (s:ss)
392 = if c /= s then Nothing else startsWith cs ss
393 startsWith _ [] = Nothing
396 -----------------------------------------------------------------------------
397 -- convert sizes like "3.5M" into integers
399 decodeSize :: String -> Integer
401 | c == "" = truncate n
402 | c == "K" || c == "k" = truncate (n * 1000)
403 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
404 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
405 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
406 where (m, c) = span pred str
408 pred c = isDigit c || c == '.'
411 -----------------------------------------------------------------------------
414 #if __GLASGOW_HASKELL__ >= 504
415 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
416 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
418 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
419 foreign import "enableTimingStats" unsafe enableTimingStats :: IO ()
422 -----------------------------------------------------------------------------
425 -- The central concept of a "way" is that all objects in a given
426 -- program must be compiled in the same "way". Certain options change
427 -- parameters of the virtual machine, eg. profiling adds an extra word
428 -- to the object header, so profiling objects cannot be linked with
429 -- non-profiling objects.
431 -- After parsing the command-line options, we determine which "way" we
432 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
434 -- We then find the "build-tag" associated with this way, and this
435 -- becomes the suffix used to find .hi files and libraries used in
438 GLOBAL_VAR(v_Build_tag, "", String)
440 -- The RTS has its own build tag, because there are some ways that
441 -- affect the RTS only.
442 GLOBAL_VAR(v_RTS_Build_tag, "", String)
472 GLOBAL_VAR(v_Ways, [] ,[WayName])
474 allowed_combination way = and [ x `allowedWith` y
475 | x <- way, y <- way, x < y ]
477 -- Note ordering in these tests: the left argument is
478 -- <= the right argument, according to the Ord instance
481 -- debug is allowed with everything
482 _ `allowedWith` WayDebug = True
483 WayDebug `allowedWith` _ = True
485 WayProf `allowedWith` WayUnreg = True
486 WayProf `allowedWith` WayNDP = True
487 _ `allowedWith` _ = False
490 findBuildTag :: IO [String] -- new options
492 way_names <- readIORef v_Ways
493 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)
508 mkBuildTag :: [Way] -> String
509 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
512 case lookup w way_details of
513 Nothing -> error "findBuildTag"
514 Just details -> details
523 way_details :: [ (WayName, Way) ]
525 [ (WayThreaded, Way "thr" True "Threaded" [
526 #if defined(freebsd_TARGET_OS)
529 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
530 -- which GHC has some problems with. It's currently not clear whether
531 -- the problems are our fault or theirs, but it seems that using the
532 -- alternative 1:1 threading library libthr works around it:
534 #elif defined(solaris2_TARGET_OS)
539 (WayDebug, Way "debug" True "Debug" [] ),
541 (WayProf, Way "p" False "Profiling"
544 , "-optc-DPROFILING" ]),
546 (WayTicky, Way "t" False "Ticky-ticky Profiling"
549 , "-optc-DTICKY_TICKY" ]),
551 (WayUnreg, Way "u" False "Unregisterised"
554 -- optl's below to tell linker where to find the PVM library -- HWL
555 (WayPar, Way "mp" False "Parallel"
557 , "-D__PARALLEL_HASKELL__"
559 , "-package concurrent"
561 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
565 -- at the moment we only change the RTS and could share compiler and libs!
566 (WayPar, Way "mt" False "Parallel ticky profiling"
568 , "-D__PARALLEL_HASKELL__"
571 , "-package concurrent"
573 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
577 (WayPar, Way "md" False "Distributed"
579 , "-D__PARALLEL_HASKELL__"
580 , "-D__DISTRIBUTED_HASKELL__"
583 , "-package concurrent"
585 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
589 (WayGran, Way "mg" False "GranSim"
593 , "-package concurrent" ]),
595 (WayNDP, Way "ndp" False "Nested data parallelism"
599 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
600 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
601 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
602 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
603 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
604 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
605 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
606 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
607 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
608 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
609 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
610 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
611 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
612 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
613 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
614 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
615 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
620 , "-optc-DUSE_MINIINTERPRETER"
621 , "-fno-asm-mangling"