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,
37 opt_IrrefutableTuples,
46 opt_SimplNoPreInlining,
47 opt_SimplExcessPrecision,
51 opt_UF_CreationThreshold,
53 opt_UF_FunAppDiscount,
76 #include "HsVersions.h"
80 import FastString ( FastString, mkFastString )
82 import Maybes ( firstJust )
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 ready <- readIORef v_opt_C_ready
98 when ready $ throwDyn (ProgramError "Too late for parseStaticFlags: call it before newSession")
100 (leftover, errs) <- processArgs static_flags args
101 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
103 -- deal with the way flags: the way (eg. prof) gives rise to
104 -- further flags, some of which might be static.
105 way_flags <- findBuildTag
107 -- if we're unregisterised, add some more flags
108 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
111 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
113 -- see sanity code in staticOpts
114 writeIORef v_opt_C_ready True
116 -- TABLES_NEXT_TO_CODE affects the info table layout.
117 -- Be careful to do this *after* all processArgs,
118 -- because evaluating tablesNextToCode involves looking at the global
119 -- static flags. Those pesky global variables...
120 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
123 when (not (null errs)) $ ghcError (UsageError (unlines errs))
124 return (cg_flags++more_leftover++leftover)
126 initStaticOpts :: IO ()
127 initStaticOpts = writeIORef v_opt_C_ready True
129 static_flags :: [(String, OptKind IO)]
130 -- All the static flags should appear in this list. It describes how each
131 -- static flag should be processed. Two main purposes:
132 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
133 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
135 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
136 -- things that are searched up by the top-level definitions like
137 -- opt_foo = lookUp FSLIT("-dfoo")
139 -- Note that ordering is important in the following list: any flag which
140 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
141 -- flags further down the list with the same prefix.
144 ------- GHCi -------------------------------------------------------
145 ( "ignore-dot-ghci", PassFlag addOpt )
146 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
147 , ( "short-ghci-banner", PassFlag addOpt )
148 , ( "long-ghci-banner" , NoArg (removeOpt "-short-ghci-banner") )
150 ------- ways --------------------------------------------------------
151 , ( "prof" , NoArg (addWay WayProf) )
152 , ( "unreg" , NoArg (addWay WayUnreg) )
153 , ( "ticky" , NoArg (addWay WayTicky) )
154 , ( "parallel" , NoArg (addWay WayPar) )
155 , ( "gransim" , NoArg (addWay WayGran) )
156 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
157 , ( "debug" , NoArg (addWay WayDebug) )
158 , ( "ndp" , NoArg (addWay WayNDP) )
159 , ( "threaded" , NoArg (addWay WayThreaded) )
162 ------ Debugging ----------------------------------------------------
163 , ( "dppr-debug", PassFlag addOpt )
164 , ( "dppr-user-length", AnySuffix addOpt )
165 -- rest of the debugging flags are dynamic
167 --------- Haskell Program Coverage -----------------------------------
169 , ( "fhpc" , PassFlag addOpt )
170 , ( "fhpc-tracer" , PassFlag addOpt )
172 --------- Profiling --------------------------------------------------
173 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
174 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
175 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
176 -- "ignore-sccs" doesn't work (ToDo)
178 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
179 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
180 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
182 ------- Miscellaneous -----------------------------------------------
183 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
185 ----- Linker --------------------------------------------------------
186 , ( "static" , PassFlag addOpt )
187 , ( "dynamic" , NoArg (removeOpt "-static") )
188 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
190 ----- RTS opts ------------------------------------------------------
191 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
192 , ( "Rghc-timing" , NoArg (enableTimingStats) )
194 ------ Compiler flags -----------------------------------------------
195 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
196 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
197 (\s -> removeOpt ("-f"++s)) )
199 -- Pass all remaining "-f<blah>" options to hsc
200 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
203 addOpt = consIORef v_opt_C
205 addWay = consIORef v_Ways
208 fs <- readIORef v_opt_C
209 writeIORef v_opt_C $! filter (/= f) fs
211 lookUp :: FastString -> Bool
212 lookup_def_int :: String -> Int -> Int
213 lookup_def_float :: String -> Float -> Float
214 lookup_str :: String -> Maybe String
216 -- holds the static opts while they're being collected, before
217 -- being unsafely read by unpacked_static_opts below.
218 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
219 GLOBAL_VAR(v_opt_C_ready, False, Bool)
220 staticFlags = unsafePerformIO $ do
221 ready <- readIORef v_opt_C_ready
223 then panic "a static opt was looked at too early!"
224 else readIORef v_opt_C
226 -- -static is the default
227 defaultStaticOpts = ["-static"]
229 packed_static_opts = map mkFastString staticFlags
231 lookUp sw = sw `elem` packed_static_opts
233 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
234 -- and returns the string X
236 = case firstJust (map (startsWith sw) staticFlags) of
237 Just ('=' : str) -> Just str
241 lookup_def_int sw def = case (lookup_str sw) of
242 Nothing -> def -- Use default
243 Just xx -> try_read sw xx
245 lookup_def_float sw def = case (lookup_str sw) of
246 Nothing -> def -- Use default
247 Just xx -> try_read sw xx
250 try_read :: Read a => String -> String -> a
251 -- (try_read sw str) tries to read s; if it fails, it
252 -- bleats about flag sw
255 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
256 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
257 -- ToDo: hack alert. We should really parse the arugments
258 -- and announce errors in a more civilised way.
262 Putting the compiler options into temporary at-files
263 may turn out to be necessary later on if we turn hsc into
264 a pure Win32 application where I think there's a command-line
265 length limit of 255. unpacked_opts understands the @ option.
267 unpacked_opts :: [String]
271 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
273 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
278 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
279 opt_ShortGhciBanner = lookUp FSLIT("-short-ghci-banner")
282 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
283 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
286 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
287 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
288 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
289 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
290 opt_DoTickyProfiling = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
294 opt_Hpc = lookUp FSLIT("-fhpc")
296 opt_Hpc_Tracer = lookUp FSLIT("-fhpc-tracer")
299 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
300 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
301 opt_Parallel = lookUp FSLIT("-fparallel")
302 opt_Flatten = lookUp FSLIT("-fflatten")
305 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
306 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
307 opt_CprOff = lookUp FSLIT("-fcpr-off")
308 -- Switch off CPR analysis in the new demand analyser
309 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
311 opt_GranMacros = lookUp FSLIT("-fgransim")
312 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
313 opt_HistorySize = lookup_def_int "-fhistory-size" 20
314 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
315 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
317 -- Simplifier switches
318 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
319 -- NoPreInlining is there just to see how bad things
320 -- get if you don't do it!
321 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
324 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
325 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
326 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
327 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
328 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
330 opt_UF_DearOp = ( 4 :: Int)
332 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
335 opt_PIC = lookUp FSLIT("-fPIC")
337 opt_Static = lookUp FSLIT("-static")
338 opt_Unregisterised = lookUp FSLIT("-funregisterised")
340 -- Derived, not a real option. Determines whether we will be compiling
341 -- info tables that reside just before the entry code, or with an
342 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
343 -- includes/InfoTables.h.
344 tablesNextToCode = not opt_Unregisterised
345 && cGhcEnableTablesNextToCode == "YES"
347 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
349 -- Include full span info in error messages, instead of just the start position.
350 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
353 -- object files and libraries to be linked in are collected here.
354 -- ToDo: perhaps this could be done without a global, it wasn't obvious
355 -- how to do it though --SDM.
356 GLOBAL_VAR(v_Ld_inputs, [], [String])
360 "fauto-sccs-on-all-toplevs",
361 "fauto-sccs-on-exported-toplevs",
362 "fauto-sccs-on-individual-cafs",
365 "firrefutable-tuples",
369 "fno-hi-version-check",
371 "fno-method-sharing",
376 "funfolding-update-in-place",
384 || any (flip prefixMatch f) [
385 "fliberate-case-threshold",
388 "funfolding-creation-threshold",
389 "funfolding-use-threshold",
390 "funfolding-fun-discount",
391 "funfolding-keeness-factor"
396 -- Misc functions for command-line options
398 startsWith :: String -> String -> Maybe String
399 -- startsWith pfx (pfx++rest) = Just rest
401 startsWith [] str = Just str
402 startsWith (c:cs) (s:ss)
403 = if c /= s then Nothing else startsWith cs ss
404 startsWith _ [] = Nothing
407 -----------------------------------------------------------------------------
408 -- convert sizes like "3.5M" into integers
410 decodeSize :: String -> Integer
412 | c == "" = truncate n
413 | c == "K" || c == "k" = truncate (n * 1000)
414 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
415 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
416 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
417 where (m, c) = span pred str
419 pred c = isDigit c || c == '.'
422 -----------------------------------------------------------------------------
425 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
426 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
428 -----------------------------------------------------------------------------
431 -- The central concept of a "way" is that all objects in a given
432 -- program must be compiled in the same "way". Certain options change
433 -- parameters of the virtual machine, eg. profiling adds an extra word
434 -- to the object header, so profiling objects cannot be linked with
435 -- non-profiling objects.
437 -- After parsing the command-line options, we determine which "way" we
438 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
440 -- We then find the "build-tag" associated with this way, and this
441 -- becomes the suffix used to find .hi files and libraries used in
444 GLOBAL_VAR(v_Build_tag, "", String)
446 -- The RTS has its own build tag, because there are some ways that
447 -- affect the RTS only.
448 GLOBAL_VAR(v_RTS_Build_tag, "", String)
478 GLOBAL_VAR(v_Ways, [] ,[WayName])
480 allowed_combination way = and [ x `allowedWith` y
481 | x <- way, y <- way, x < y ]
483 -- Note ordering in these tests: the left argument is
484 -- <= the right argument, according to the Ord instance
487 -- debug is allowed with everything
488 _ `allowedWith` WayDebug = True
489 WayDebug `allowedWith` _ = True
491 WayProf `allowedWith` WayUnreg = True
492 WayProf `allowedWith` WayNDP = True
493 _ `allowedWith` _ = False
496 findBuildTag :: IO [String] -- new options
498 way_names <- readIORef v_Ways
499 let ws = sort (nub way_names)
501 if not (allowed_combination ws)
502 then throwDyn (CmdLineError $
503 "combination not supported: " ++
504 foldr1 (\a b -> a ++ '/':b)
505 (map (wayName . lkupWay) ws))
506 else let ways = map lkupWay ws
507 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
508 rts_tag = mkBuildTag ways
509 flags = map wayOpts ways
511 writeIORef v_Build_tag tag
512 writeIORef v_RTS_Build_tag rts_tag
513 return (concat flags)
517 mkBuildTag :: [Way] -> String
518 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
521 case lookup w way_details of
522 Nothing -> error "findBuildTag"
523 Just details -> details
525 isRTSWay = wayRTSOnly . lkupWay
534 way_details :: [ (WayName, Way) ]
536 [ (WayThreaded, Way "thr" True "Threaded" [
537 #if defined(freebsd_TARGET_OS)
540 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
541 -- which GHC has some problems with. It's currently not clear whether
542 -- the problems are our fault or theirs, but it seems that using the
543 -- alternative 1:1 threading library libthr works around it:
545 #elif defined(solaris2_TARGET_OS)
550 (WayDebug, Way "debug" True "Debug" [] ),
552 (WayProf, Way "p" False "Profiling"
555 , "-optc-DPROFILING" ]),
557 (WayTicky, Way "t" True "Ticky-ticky Profiling"
559 , "-optc-DTICKY_TICKY" ]),
561 (WayUnreg, Way "u" False "Unregisterised"
564 -- optl's below to tell linker where to find the PVM library -- HWL
565 (WayPar, Way "mp" False "Parallel"
567 , "-D__PARALLEL_HASKELL__"
569 , "-package concurrent"
571 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
575 -- at the moment we only change the RTS and could share compiler and libs!
576 (WayPar, Way "mt" False "Parallel ticky profiling"
578 , "-D__PARALLEL_HASKELL__"
581 , "-package concurrent"
583 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
587 (WayPar, Way "md" False "Distributed"
589 , "-D__PARALLEL_HASKELL__"
590 , "-D__DISTRIBUTED_HASKELL__"
593 , "-package concurrent"
595 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
599 (WayGran, Way "mg" False "GranSim"
603 , "-package concurrent" ]),
605 (WayNDP, Way "ndp" False "Nested data parallelism"
609 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
610 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
611 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
612 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
613 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
614 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
615 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
616 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
617 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
618 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
619 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
620 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
621 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
622 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
623 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
624 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
625 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
630 , "-optc-DUSE_MINIINTERPRETER"
631 , "-fno-asm-mangling"