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 -----------------------------------------------------------------------------
18 WayName(..), v_Ways, v_Build_tag, v_RTS_Build_tag, isRTSWay,
20 -- Output style options
25 opt_AutoSccsOnAllToplevs,
26 opt_AutoSccsOnExportedToplevs,
27 opt_AutoSccsOnIndividualCafs,
36 opt_IrrefutableTuples,
45 opt_SimplNoPreInlining,
46 opt_SimplExcessPrecision,
50 opt_UF_CreationThreshold,
52 opt_UF_FunAppDiscount,
74 #include "HsVersions.h"
78 import FastString ( FastString, mkFastString )
80 import Maybes ( firstJust )
83 import Control.Exception ( throwDyn )
85 import System.IO.Unsafe ( unsafePerformIO )
86 import Control.Monad ( when )
87 import Data.Char ( isDigit )
90 -----------------------------------------------------------------------------
93 parseStaticFlags :: [String] -> IO [String]
94 parseStaticFlags args = do
95 ready <- readIORef v_opt_C_ready
96 when ready $ throwDyn (ProgramError "Too late for parseStaticFlags: call it before newSession")
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 -- further 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)
111 -- see sanity code in staticOpts
112 writeIORef v_opt_C_ready True
114 -- TABLES_NEXT_TO_CODE affects the info table layout.
115 -- Be careful to do this *after* all processArgs,
116 -- because evaluating tablesNextToCode involves looking at the global
117 -- static flags. Those pesky global variables...
118 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
121 -- HACK: -fexcess-precision is both a static and a dynamic flag. If
122 -- the static flag parser has slurped it, we must return it as a
123 -- leftover too. ToDo: make -fexcess-precision dynamic only.
124 let excess_prec | opt_SimplExcessPrecision = ["-fexcess-precision"]
127 when (not (null errs)) $ ghcError (UsageError (unlines errs))
128 return (excess_prec++cg_flags++more_leftover++leftover)
130 initStaticOpts :: IO ()
131 initStaticOpts = writeIORef v_opt_C_ready True
133 static_flags :: [(String, OptKind IO)]
134 -- All the static flags should appear in this list. It describes how each
135 -- static flag should be processed. Two main purposes:
136 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
137 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
139 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
140 -- things that are searched up by the top-level definitions like
141 -- opt_foo = lookUp FSLIT("-dfoo")
143 -- Note that ordering is important in the following list: any flag which
144 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
145 -- flags further down the list with the same prefix.
148 ------- GHCi -------------------------------------------------------
149 ( "ignore-dot-ghci", PassFlag addOpt )
150 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
152 ------- ways --------------------------------------------------------
153 , ( "prof" , NoArg (addWay WayProf) )
154 , ( "unreg" , NoArg (addWay WayUnreg) )
155 , ( "ticky" , NoArg (addWay WayTicky) )
156 , ( "parallel" , NoArg (addWay WayPar) )
157 , ( "gransim" , NoArg (addWay WayGran) )
158 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
159 , ( "debug" , NoArg (addWay WayDebug) )
160 , ( "ndp" , NoArg (addWay WayNDP) )
161 , ( "threaded" , NoArg (addWay WayThreaded) )
164 ------ Debugging ----------------------------------------------------
165 , ( "dppr-debug", PassFlag addOpt )
166 , ( "dppr-user-length", AnySuffix addOpt )
167 -- rest of the debugging flags are dynamic
169 --------- Profiling --------------------------------------------------
170 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
171 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
172 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
173 -- "ignore-sccs" doesn't work (ToDo)
175 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
176 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
177 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
179 ------- Miscellaneous -----------------------------------------------
180 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
182 ----- Linker --------------------------------------------------------
183 , ( "static" , PassFlag addOpt )
184 , ( "dynamic" , NoArg (removeOpt "-static") )
185 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
187 ----- RTS opts ------------------------------------------------------
188 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
189 , ( "Rghc-timing" , NoArg (enableTimingStats) )
191 ------ Compiler flags -----------------------------------------------
192 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
193 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
194 (\s -> removeOpt ("-f"++s)) )
196 -- Pass all remaining "-f<blah>" options to hsc
197 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
200 addOpt = consIORef v_opt_C
202 addWay = consIORef v_Ways
205 fs <- readIORef v_opt_C
206 writeIORef v_opt_C $! filter (/= f) fs
208 lookUp :: FastString -> Bool
209 lookup_def_int :: String -> Int -> Int
210 lookup_def_float :: String -> Float -> Float
211 lookup_str :: String -> Maybe String
213 -- holds the static opts while they're being collected, before
214 -- being unsafely read by unpacked_static_opts below.
215 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
216 GLOBAL_VAR(v_opt_C_ready, False, Bool)
217 staticFlags = unsafePerformIO $ do
218 ready <- readIORef v_opt_C_ready
220 then panic "a static opt was looked at too early!"
221 else readIORef v_opt_C
223 -- -static is the default
224 defaultStaticOpts = ["-static"]
226 packed_static_opts = map mkFastString staticFlags
228 lookUp sw = sw `elem` packed_static_opts
230 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
231 -- and returns the string X
233 = case firstJust (map (startsWith sw) staticFlags) of
234 Just ('=' : str) -> Just str
238 lookup_def_int sw def = case (lookup_str sw) of
239 Nothing -> def -- Use default
240 Just xx -> try_read sw xx
242 lookup_def_float sw def = case (lookup_str sw) of
243 Nothing -> def -- Use default
244 Just xx -> try_read sw xx
247 try_read :: Read a => String -> String -> a
248 -- (try_read sw str) tries to read s; if it fails, it
249 -- bleats about flag sw
252 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
253 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
254 -- ToDo: hack alert. We should really parse the arugments
255 -- and announce errors in a more civilised way.
259 Putting the compiler options into temporary at-files
260 may turn out to be necessary later on if we turn hsc into
261 a pure Win32 application where I think there's a command-line
262 length limit of 255. unpacked_opts understands the @ option.
264 unpacked_opts :: [String]
268 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
270 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
275 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
278 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
279 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
282 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
283 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
284 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
285 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
286 opt_DoTickyProfiling = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
289 opt_Hpc = lookUp FSLIT("-fhpc")
292 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
293 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
294 opt_Parallel = lookUp FSLIT("-fparallel")
295 opt_Flatten = lookUp FSLIT("-fflatten")
298 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
299 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
300 opt_CprOff = lookUp FSLIT("-fcpr-off")
301 -- Switch off CPR analysis in the new demand analyser
302 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
304 opt_GranMacros = lookUp FSLIT("-fgransim")
305 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
306 opt_HistorySize = lookup_def_int "-fhistory-size" 20
307 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
308 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
310 -- Simplifier switches
311 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
312 -- NoPreInlining is there just to see how bad things
313 -- get if you don't do it!
314 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
317 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
318 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
319 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
320 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
321 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
323 opt_UF_DearOp = ( 4 :: Int)
325 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
328 opt_PIC = lookUp FSLIT("-fPIC")
330 opt_Static = lookUp FSLIT("-static")
331 opt_Unregisterised = lookUp FSLIT("-funregisterised")
333 -- Derived, not a real option. Determines whether we will be compiling
334 -- info tables that reside just before the entry code, or with an
335 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
336 -- includes/InfoTables.h.
337 tablesNextToCode = not opt_Unregisterised
338 && cGhcEnableTablesNextToCode == "YES"
340 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
342 -- Include full span info in error messages, instead of just the start position.
343 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
346 -- object files and libraries to be linked in are collected here.
347 -- ToDo: perhaps this could be done without a global, it wasn't obvious
348 -- how to do it though --SDM.
349 GLOBAL_VAR(v_Ld_inputs, [], [String])
353 "fauto-sccs-on-all-toplevs",
354 "fauto-sccs-on-exported-toplevs",
355 "fauto-sccs-on-individual-cafs",
358 "firrefutable-tuples",
362 "fno-hi-version-check",
364 "fno-method-sharing",
369 "funfolding-update-in-place",
378 || any (`isPrefixOf` f) [
379 "fliberate-case-threshold",
382 "funfolding-creation-threshold",
383 "funfolding-use-threshold",
384 "funfolding-fun-discount",
385 "funfolding-keeness-factor"
390 -- Misc functions for command-line options
392 startsWith :: String -> String -> Maybe String
393 -- startsWith pfx (pfx++rest) = Just rest
395 startsWith [] str = Just str
396 startsWith (c:cs) (s:ss)
397 = if c /= s then Nothing else startsWith cs ss
398 startsWith _ [] = Nothing
401 -----------------------------------------------------------------------------
402 -- convert sizes like "3.5M" into integers
404 decodeSize :: String -> Integer
406 | c == "" = truncate n
407 | c == "K" || c == "k" = truncate (n * 1000)
408 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
409 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
410 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
411 where (m, c) = span pred str
413 pred c = isDigit c || c == '.'
416 -----------------------------------------------------------------------------
419 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
420 foreign import ccall unsafe "enableTimingStats" 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)
495 if not (allowed_combination ws)
496 then throwDyn (CmdLineError $
497 "combination not supported: " ++
498 foldr1 (\a b -> a ++ '/':b)
499 (map (wayName . lkupWay) ws))
500 else let ways = map lkupWay ws
501 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
502 rts_tag = mkBuildTag ways
503 flags = map wayOpts ways
505 writeIORef v_Build_tag tag
506 writeIORef v_RTS_Build_tag rts_tag
507 return (concat flags)
511 mkBuildTag :: [Way] -> String
512 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
515 case lookup w way_details of
516 Nothing -> error "findBuildTag"
517 Just details -> details
519 isRTSWay = wayRTSOnly . lkupWay
528 way_details :: [ (WayName, Way) ]
530 [ (WayThreaded, Way "thr" True "Threaded" [
531 #if defined(freebsd_TARGET_OS)
534 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
535 -- which GHC has some problems with. It's currently not clear whether
536 -- the problems are our fault or theirs, but it seems that using the
537 -- alternative 1:1 threading library libthr works around it:
539 #elif defined(solaris2_TARGET_OS)
544 (WayDebug, Way "debug" True "Debug" [] ),
546 (WayProf, Way "p" False "Profiling"
549 , "-optc-DPROFILING" ]),
551 (WayTicky, Way "t" True "Ticky-ticky Profiling"
553 , "-optc-DTICKY_TICKY" ]),
555 (WayUnreg, Way "u" False "Unregisterised"
558 -- optl's below to tell linker where to find the PVM library -- HWL
559 (WayPar, Way "mp" False "Parallel"
561 , "-D__PARALLEL_HASKELL__"
563 , "-package concurrent"
565 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
569 -- at the moment we only change the RTS and could share compiler and libs!
570 (WayPar, Way "mt" False "Parallel ticky profiling"
572 , "-D__PARALLEL_HASKELL__"
575 , "-package concurrent"
577 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
581 (WayPar, Way "md" False "Distributed"
583 , "-D__PARALLEL_HASKELL__"
584 , "-D__DISTRIBUTED_HASKELL__"
587 , "-package concurrent"
589 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
593 (WayGran, Way "mg" False "GranSim"
597 , "-package concurrent" ]),
599 (WayNDP, Way "ndp" False "Nested data parallelism"
603 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
604 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
605 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
606 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
607 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
608 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
609 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
610 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
611 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
612 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
613 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
614 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
615 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
616 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
617 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
618 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
619 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
624 , "-optc-DUSE_MINIINTERPRETER"
625 , "-fno-asm-mangling"