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 )
88 import Data.List ( sort, intersperse, nub )
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 when (not (null errs)) $ ghcError (UsageError (unlines errs))
122 return (cg_flags++more_leftover++leftover)
124 initStaticOpts :: IO ()
125 initStaticOpts = writeIORef v_opt_C_ready True
127 static_flags :: [(String, OptKind IO)]
128 -- All the static flags should appear in this list. It describes how each
129 -- static flag should be processed. Two main purposes:
130 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
131 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
133 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
134 -- things that are searched up by the top-level definitions like
135 -- opt_foo = lookUp FSLIT("-dfoo")
137 -- Note that ordering is important in the following list: any flag which
138 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
139 -- flags further down the list with the same prefix.
142 ------- GHCi -------------------------------------------------------
143 ( "ignore-dot-ghci", PassFlag addOpt )
144 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
146 ------- ways --------------------------------------------------------
147 , ( "prof" , NoArg (addWay WayProf) )
148 , ( "unreg" , NoArg (addWay WayUnreg) )
149 , ( "ticky" , NoArg (addWay WayTicky) )
150 , ( "parallel" , NoArg (addWay WayPar) )
151 , ( "gransim" , NoArg (addWay WayGran) )
152 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
153 , ( "debug" , NoArg (addWay WayDebug) )
154 , ( "ndp" , NoArg (addWay WayNDP) )
155 , ( "threaded" , NoArg (addWay WayThreaded) )
158 ------ Debugging ----------------------------------------------------
159 , ( "dppr-debug", PassFlag addOpt )
160 , ( "dppr-user-length", AnySuffix addOpt )
161 -- rest of the debugging flags are dynamic
163 --------- Profiling --------------------------------------------------
164 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
165 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
166 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
167 -- "ignore-sccs" doesn't work (ToDo)
169 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
170 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
171 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
173 ------- Miscellaneous -----------------------------------------------
174 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
176 ----- Linker --------------------------------------------------------
177 , ( "static" , PassFlag addOpt )
178 , ( "dynamic" , NoArg (removeOpt "-static") )
179 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
181 ----- RTS opts ------------------------------------------------------
182 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
183 , ( "Rghc-timing" , NoArg (enableTimingStats) )
185 ------ Compiler flags -----------------------------------------------
186 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
187 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
188 (\s -> removeOpt ("-f"++s)) )
190 -- Pass all remaining "-f<blah>" options to hsc
191 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
194 addOpt = consIORef v_opt_C
196 addWay = consIORef v_Ways
199 fs <- readIORef v_opt_C
200 writeIORef v_opt_C $! filter (/= f) fs
202 lookUp :: FastString -> Bool
203 lookup_def_int :: String -> Int -> Int
204 lookup_def_float :: String -> Float -> Float
205 lookup_str :: String -> Maybe String
207 -- holds the static opts while they're being collected, before
208 -- being unsafely read by unpacked_static_opts below.
209 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
210 GLOBAL_VAR(v_opt_C_ready, False, Bool)
211 staticFlags = unsafePerformIO $ do
212 ready <- readIORef v_opt_C_ready
214 then panic "a static opt was looked at too early!"
215 else readIORef v_opt_C
217 -- -static is the default
218 defaultStaticOpts = ["-static"]
220 packed_static_opts = map mkFastString staticFlags
222 lookUp sw = sw `elem` packed_static_opts
224 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
225 -- and returns the string X
227 = case firstJust (map (startsWith sw) staticFlags) of
228 Just ('=' : str) -> Just str
232 lookup_def_int sw def = case (lookup_str sw) of
233 Nothing -> def -- Use default
234 Just xx -> try_read sw xx
236 lookup_def_float sw def = case (lookup_str sw) of
237 Nothing -> def -- Use default
238 Just xx -> try_read sw xx
241 try_read :: Read a => String -> String -> a
242 -- (try_read sw str) tries to read s; if it fails, it
243 -- bleats about flag sw
246 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
247 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
248 -- ToDo: hack alert. We should really parse the arugments
249 -- and announce errors in a more civilised way.
253 Putting the compiler options into temporary at-files
254 may turn out to be necessary later on if we turn hsc into
255 a pure Win32 application where I think there's a command-line
256 length limit of 255. unpacked_opts understands the @ option.
258 unpacked_opts :: [String]
262 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
264 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
269 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
272 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
273 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
276 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
277 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
278 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
279 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
280 opt_DoTickyProfiling = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
283 opt_Hpc = lookUp FSLIT("-fhpc")
286 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
287 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
288 opt_Parallel = lookUp FSLIT("-fparallel")
289 opt_Flatten = lookUp FSLIT("-fflatten")
292 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
293 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
294 opt_CprOff = lookUp FSLIT("-fcpr-off")
295 -- Switch off CPR analysis in the new demand analyser
296 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
298 opt_GranMacros = lookUp FSLIT("-fgransim")
299 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
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",
352 "firrefutable-tuples",
356 "fno-hi-version-check",
358 "fno-method-sharing",
363 "funfolding-update-in-place",
372 || any (flip prefixMatch f) [
373 "fliberate-case-threshold",
376 "funfolding-creation-threshold",
377 "funfolding-use-threshold",
378 "funfolding-fun-discount",
379 "funfolding-keeness-factor"
384 -- Misc functions for command-line options
386 startsWith :: String -> String -> Maybe String
387 -- startsWith pfx (pfx++rest) = Just rest
389 startsWith [] str = Just str
390 startsWith (c:cs) (s:ss)
391 = if c /= s then Nothing else startsWith cs ss
392 startsWith _ [] = Nothing
395 -----------------------------------------------------------------------------
396 -- convert sizes like "3.5M" into integers
398 decodeSize :: String -> Integer
400 | c == "" = truncate n
401 | c == "K" || c == "k" = truncate (n * 1000)
402 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
403 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
404 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
405 where (m, c) = span pred str
407 pred c = isDigit c || c == '.'
410 -----------------------------------------------------------------------------
413 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
414 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
416 -----------------------------------------------------------------------------
419 -- The central concept of a "way" is that all objects in a given
420 -- program must be compiled in the same "way". Certain options change
421 -- parameters of the virtual machine, eg. profiling adds an extra word
422 -- to the object header, so profiling objects cannot be linked with
423 -- non-profiling objects.
425 -- After parsing the command-line options, we determine which "way" we
426 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
428 -- We then find the "build-tag" associated with this way, and this
429 -- becomes the suffix used to find .hi files and libraries used in
432 GLOBAL_VAR(v_Build_tag, "", String)
434 -- The RTS has its own build tag, because there are some ways that
435 -- affect the RTS only.
436 GLOBAL_VAR(v_RTS_Build_tag, "", String)
466 GLOBAL_VAR(v_Ways, [] ,[WayName])
468 allowed_combination way = and [ x `allowedWith` y
469 | x <- way, y <- way, x < y ]
471 -- Note ordering in these tests: the left argument is
472 -- <= the right argument, according to the Ord instance
475 -- debug is allowed with everything
476 _ `allowedWith` WayDebug = True
477 WayDebug `allowedWith` _ = True
479 WayProf `allowedWith` WayUnreg = True
480 WayProf `allowedWith` WayNDP = True
481 _ `allowedWith` _ = False
484 findBuildTag :: IO [String] -- new options
486 way_names <- readIORef v_Ways
487 let ws = sort (nub way_names)
489 if not (allowed_combination ws)
490 then throwDyn (CmdLineError $
491 "combination not supported: " ++
492 foldr1 (\a b -> a ++ '/':b)
493 (map (wayName . lkupWay) ws))
494 else let ways = map lkupWay ws
495 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
496 rts_tag = mkBuildTag ways
497 flags = map wayOpts ways
499 writeIORef v_Build_tag tag
500 writeIORef v_RTS_Build_tag rts_tag
501 return (concat flags)
505 mkBuildTag :: [Way] -> String
506 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
509 case lookup w way_details of
510 Nothing -> error "findBuildTag"
511 Just details -> details
513 isRTSWay = wayRTSOnly . lkupWay
522 way_details :: [ (WayName, Way) ]
524 [ (WayThreaded, Way "thr" True "Threaded" [
525 #if defined(freebsd_TARGET_OS)
528 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
529 -- which GHC has some problems with. It's currently not clear whether
530 -- the problems are our fault or theirs, but it seems that using the
531 -- alternative 1:1 threading library libthr works around it:
533 #elif defined(solaris2_TARGET_OS)
538 (WayDebug, Way "debug" True "Debug" [] ),
540 (WayProf, Way "p" False "Profiling"
543 , "-optc-DPROFILING" ]),
545 (WayTicky, Way "t" True "Ticky-ticky Profiling"
547 , "-optc-DTICKY_TICKY" ]),
549 (WayUnreg, Way "u" False "Unregisterised"
552 -- optl's below to tell linker where to find the PVM library -- HWL
553 (WayPar, Way "mp" False "Parallel"
555 , "-D__PARALLEL_HASKELL__"
557 , "-package concurrent"
559 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
563 -- at the moment we only change the RTS and could share compiler and libs!
564 (WayPar, Way "mt" False "Parallel ticky profiling"
566 , "-D__PARALLEL_HASKELL__"
569 , "-package concurrent"
571 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
575 (WayPar, Way "md" False "Distributed"
577 , "-D__PARALLEL_HASKELL__"
578 , "-D__DISTRIBUTED_HASKELL__"
581 , "-package concurrent"
583 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
587 (WayGran, Way "mg" False "GranSim"
591 , "-package concurrent" ]),
593 (WayNDP, Way "ndp" False "Nested data parallelism"
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"]),
599 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
600 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
601 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
602 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
603 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
604 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
605 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
606 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
607 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
608 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
609 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
610 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
611 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
612 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
613 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
618 , "-optc-DUSE_MINIINTERPRETER"
619 , "-fno-asm-mangling"