2 -- The above warning supression flag is a temporary kludge.
3 -- While working on this module you are encouraged to remove it and fix
4 -- any warnings in the module. See
5 -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
8 -----------------------------------------------------------------------------
12 -- Static flags can only be set once, on the command-line. Inside GHC,
13 -- each static flag corresponds to a top-level value, usually of type Bool.
15 -- (c) The University of Glasgow 2005
17 -----------------------------------------------------------------------------
25 WayName(..), v_Ways, v_Build_tag, v_RTS_Build_tag, isRTSWay,
27 -- Output style options
33 opt_AutoSccsOnAllToplevs,
34 opt_AutoSccsOnExportedToplevs,
35 opt_AutoSccsOnIndividualCafs,
44 opt_IrrefutableTuples,
51 opt_SpecInlineJoinPoints,
53 opt_SimplNoPreInlining,
54 opt_SimplExcessPrecision,
58 opt_UF_CreationThreshold,
60 opt_UF_FunAppDiscount,
81 #include "HsVersions.h"
85 import FastString ( FastString, mkFastString )
87 import Maybes ( firstJust )
90 import Control.Exception ( throwDyn )
92 import System.IO.Unsafe ( unsafePerformIO )
93 import Control.Monad ( when )
94 import Data.Char ( isDigit )
97 -----------------------------------------------------------------------------
100 parseStaticFlags :: [String] -> IO [String]
101 parseStaticFlags args = do
102 ready <- readIORef v_opt_C_ready
103 when ready $ throwDyn (ProgramError "Too late for parseStaticFlags: call it before newSession")
105 (leftover, errs) <- processArgs static_flags args
106 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
108 -- deal with the way flags: the way (eg. prof) gives rise to
109 -- further flags, some of which might be static.
110 way_flags <- findBuildTag
112 -- if we're unregisterised, add some more flags
113 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
116 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
118 -- see sanity code in staticOpts
119 writeIORef v_opt_C_ready True
121 -- TABLES_NEXT_TO_CODE affects the info table layout.
122 -- Be careful to do this *after* all processArgs,
123 -- because evaluating tablesNextToCode involves looking at the global
124 -- static flags. Those pesky global variables...
125 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
128 -- HACK: -fexcess-precision is both a static and a dynamic flag. If
129 -- the static flag parser has slurped it, we must return it as a
130 -- leftover too. ToDo: make -fexcess-precision dynamic only.
131 let excess_prec | opt_SimplExcessPrecision = ["-fexcess-precision"]
134 when (not (null errs)) $ ghcError (UsageError (unlines errs))
135 return (excess_prec++cg_flags++more_leftover++leftover)
137 initStaticOpts :: IO ()
138 initStaticOpts = writeIORef v_opt_C_ready True
140 static_flags :: [(String, OptKind IO)]
141 -- All the static flags should appear in this list. It describes how each
142 -- static flag should be processed. Two main purposes:
143 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
144 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
146 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
147 -- things that are searched up by the top-level definitions like
148 -- opt_foo = lookUp FSLIT("-dfoo")
150 -- Note that ordering is important in the following list: any flag which
151 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
152 -- flags further down the list with the same prefix.
155 ------- GHCi -------------------------------------------------------
156 ( "ignore-dot-ghci", PassFlag addOpt )
157 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
159 ------- ways --------------------------------------------------------
160 , ( "prof" , NoArg (addWay WayProf) )
161 , ( "ticky" , NoArg (addWay WayTicky) )
162 , ( "parallel" , NoArg (addWay WayPar) )
163 , ( "gransim" , NoArg (addWay WayGran) )
164 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
165 , ( "debug" , NoArg (addWay WayDebug) )
166 , ( "ndp" , NoArg (addWay WayNDP) )
167 , ( "threaded" , NoArg (addWay WayThreaded) )
170 ------ Debugging ----------------------------------------------------
171 , ( "dppr-debug", PassFlag addOpt )
172 , ( "dsuppress-uniques", PassFlag addOpt )
173 , ( "dppr-user-length", AnySuffix addOpt )
174 -- rest of the debugging flags are dynamic
176 --------- Profiling --------------------------------------------------
177 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
178 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
179 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
180 -- "ignore-sccs" doesn't work (ToDo)
182 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
183 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
184 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
186 ------- Miscellaneous -----------------------------------------------
187 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
189 ----- Linker --------------------------------------------------------
190 , ( "static" , PassFlag addOpt )
191 , ( "dynamic" , NoArg (removeOpt "-static") )
192 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
194 ----- RTS opts ------------------------------------------------------
195 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
196 , ( "Rghc-timing" , NoArg (enableTimingStats) )
198 ------ Compiler flags -----------------------------------------------
199 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
200 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
201 (\s -> removeOpt ("-f"++s)) )
203 -- Pass all remaining "-f<blah>" options to hsc
204 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
207 addOpt = consIORef v_opt_C
209 addWay = consIORef v_Ways
212 fs <- readIORef v_opt_C
213 writeIORef v_opt_C $! filter (/= f) fs
215 lookUp :: FastString -> Bool
216 lookup_def_int :: String -> Int -> Int
217 lookup_def_float :: String -> Float -> Float
218 lookup_str :: String -> Maybe String
220 -- holds the static opts while they're being collected, before
221 -- being unsafely read by unpacked_static_opts below.
222 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
223 GLOBAL_VAR(v_opt_C_ready, False, Bool)
224 staticFlags = unsafePerformIO $ do
225 ready <- readIORef v_opt_C_ready
227 then panic "Static flags have not been initialised!\n Please call GHC.newSession or GHC.parseStaticFlags early enough."
228 else readIORef v_opt_C
230 -- -static is the default
231 defaultStaticOpts = ["-static"]
233 packed_static_opts = map mkFastString staticFlags
235 lookUp sw = sw `elem` packed_static_opts
237 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
238 -- and returns the string X
240 = case firstJust (map (startsWith sw) staticFlags) of
241 Just ('=' : str) -> Just str
245 lookup_def_int sw def = case (lookup_str sw) of
246 Nothing -> def -- Use default
247 Just xx -> try_read sw xx
249 lookup_def_float sw def = case (lookup_str sw) of
250 Nothing -> def -- Use default
251 Just xx -> try_read sw xx
254 try_read :: Read a => String -> String -> a
255 -- (try_read sw str) tries to read s; if it fails, it
256 -- bleats about flag sw
259 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
260 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
261 -- ToDo: hack alert. We should really parse the arugments
262 -- and announce errors in a more civilised way.
266 Putting the compiler options into temporary at-files
267 may turn out to be necessary later on if we turn hsc into
268 a pure Win32 application where I think there's a command-line
269 length limit of 255. unpacked_opts understands the @ option.
271 unpacked_opts :: [String]
275 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
277 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
282 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
285 opt_SuppressUniques = lookUp FSLIT("-dsuppress-uniques")
286 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
287 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
290 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
291 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
292 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
293 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
294 opt_DoTickyProfiling = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
297 opt_Hpc = lookUp FSLIT("-fhpc")
300 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
301 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
302 opt_Parallel = lookUp FSLIT("-fparallel")
305 opt_SpecInlineJoinPoints = lookUp FSLIT("-fspec-inline-join-points")
306 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
307 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
308 opt_CprOff = lookUp FSLIT("-fcpr-off")
309 -- Switch off CPR analysis in the new demand analyser
310 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
312 opt_GranMacros = lookUp FSLIT("-fgransim")
313 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
314 opt_HistorySize = lookup_def_int "-fhistory-size" 20
315 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
316 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
318 -- Simplifier switches
319 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
320 -- NoPreInlining is there just to see how bad things
321 -- get if you don't do it!
322 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
325 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
326 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
327 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
328 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
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 "fspec-inline-join-points",
366 "firrefutable-tuples",
369 "fno-hi-version-check",
371 "fno-method-sharing",
377 "fhardwire-lib-paths",
385 || any (`isPrefixOf` f) [
386 "fliberate-case-threshold",
389 "funfolding-creation-threshold",
390 "funfolding-use-threshold",
391 "funfolding-fun-discount",
392 "funfolding-keeness-factor"
397 -- Misc functions for command-line options
399 startsWith :: String -> String -> Maybe String
400 -- startsWith pfx (pfx++rest) = Just rest
402 startsWith [] str = Just str
403 startsWith (c:cs) (s:ss)
404 = if c /= s then Nothing else startsWith cs ss
405 startsWith _ [] = Nothing
408 -----------------------------------------------------------------------------
409 -- convert sizes like "3.5M" into integers
411 decodeSize :: String -> Integer
413 | c == "" = truncate n
414 | c == "K" || c == "k" = truncate (n * 1000)
415 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
416 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
417 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
418 where (m, c) = span pred str
420 pred c = isDigit c || c == '.'
423 -----------------------------------------------------------------------------
426 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
427 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
429 -----------------------------------------------------------------------------
432 -- The central concept of a "way" is that all objects in a given
433 -- program must be compiled in the same "way". Certain options change
434 -- parameters of the virtual machine, eg. profiling adds an extra word
435 -- to the object header, so profiling objects cannot be linked with
436 -- non-profiling objects.
438 -- After parsing the command-line options, we determine which "way" we
439 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
441 -- We then find the "build-tag" associated with this way, and this
442 -- becomes the suffix used to find .hi files and libraries used in
445 GLOBAL_VAR(v_Build_tag, "", String)
447 -- The RTS has its own build tag, because there are some ways that
448 -- affect the RTS only.
449 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` WayNDP = True
492 WayThreaded `allowedWith` WayProf = 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 -- optl's below to tell linker where to find the PVM library -- HWL
562 (WayPar, Way "mp" False "Parallel"
564 , "-D__PARALLEL_HASKELL__"
566 , "-package concurrent"
568 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
572 -- at the moment we only change the RTS and could share compiler and libs!
573 (WayPar, Way "mt" False "Parallel ticky profiling"
575 , "-D__PARALLEL_HASKELL__"
578 , "-package concurrent"
580 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
584 (WayPar, Way "md" False "Distributed"
586 , "-D__PARALLEL_HASKELL__"
587 , "-D__DISTRIBUTED_HASKELL__"
590 , "-package concurrent"
592 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
596 (WayGran, Way "mg" False "GranSim"
600 , "-package concurrent" ]),
602 (WayNDP, Way "ndp" False "Nested data parallelism"
606 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
607 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
608 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
609 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
610 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
611 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
612 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
613 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
614 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
615 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
616 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
617 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
618 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
619 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
620 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
621 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
622 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
627 , "-optc-DUSE_MINIINTERPRETER"
628 , "-fno-asm-mangling"