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,
75 #include "HsVersions.h"
79 import FastString ( FastString, mkFastString )
81 import Maybes ( firstJust )
84 import Control.Exception ( throwDyn )
86 import System.IO.Unsafe ( unsafePerformIO )
87 import Control.Monad ( when )
88 import Data.Char ( isDigit )
91 -----------------------------------------------------------------------------
94 parseStaticFlags :: [String] -> IO [String]
95 parseStaticFlags args = do
96 ready <- readIORef v_opt_C_ready
97 when ready $ throwDyn (ProgramError "Too late for parseStaticFlags: call it before newSession")
99 (leftover, errs) <- processArgs static_flags args
100 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
102 -- deal with the way flags: the way (eg. prof) gives rise to
103 -- further flags, some of which might be static.
104 way_flags <- findBuildTag
106 -- if we're unregisterised, add some more flags
107 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
110 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
112 -- see sanity code in staticOpts
113 writeIORef v_opt_C_ready True
115 -- TABLES_NEXT_TO_CODE affects the info table layout.
116 -- Be careful to do this *after* all processArgs,
117 -- because evaluating tablesNextToCode involves looking at the global
118 -- static flags. Those pesky global variables...
119 let cg_flags | tablesNextToCode = ["-optc-DTABLES_NEXT_TO_CODE"]
122 -- HACK: -fexcess-precision is both a static and a dynamic flag. If
123 -- the static flag parser has slurped it, we must return it as a
124 -- leftover too. ToDo: make -fexcess-precision dynamic only.
125 let excess_prec | opt_SimplExcessPrecision = ["-fexcess-precision"]
128 when (not (null errs)) $ ghcError (UsageError (unlines errs))
129 return (excess_prec++cg_flags++more_leftover++leftover)
131 initStaticOpts :: IO ()
132 initStaticOpts = writeIORef v_opt_C_ready True
134 static_flags :: [(String, OptKind IO)]
135 -- All the static flags should appear in this list. It describes how each
136 -- static flag should be processed. Two main purposes:
137 -- (a) if a command-line flag doesn't appear in the list, GHC can complain
138 -- (b) a command-line flag may remove, or add, other flags; e.g. the "-fno-X" things
140 -- The common (PassFlag addOpt) action puts the static flag into the bunch of
141 -- things that are searched up by the top-level definitions like
142 -- opt_foo = lookUp FSLIT("-dfoo")
144 -- Note that ordering is important in the following list: any flag which
145 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
146 -- flags further down the list with the same prefix.
149 ------- GHCi -------------------------------------------------------
150 ( "ignore-dot-ghci", PassFlag addOpt )
151 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
153 ------- ways --------------------------------------------------------
154 , ( "prof" , NoArg (addWay WayProf) )
155 , ( "unreg" , NoArg (addWay WayUnreg) )
156 , ( "ticky" , NoArg (addWay WayTicky) )
157 , ( "parallel" , NoArg (addWay WayPar) )
158 , ( "gransim" , NoArg (addWay WayGran) )
159 , ( "smp" , NoArg (addWay WayThreaded) ) -- backwards compat.
160 , ( "debug" , NoArg (addWay WayDebug) )
161 , ( "ndp" , NoArg (addWay WayNDP) )
162 , ( "threaded" , NoArg (addWay WayThreaded) )
165 ------ Debugging ----------------------------------------------------
166 , ( "dppr-debug", PassFlag addOpt )
167 , ( "dppr-user-length", AnySuffix addOpt )
168 -- rest of the debugging flags are dynamic
170 --------- Profiling --------------------------------------------------
171 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
172 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
173 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
174 -- "ignore-sccs" doesn't work (ToDo)
176 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
177 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
178 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
180 ------- Miscellaneous -----------------------------------------------
181 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
183 ----- Linker --------------------------------------------------------
184 , ( "static" , PassFlag addOpt )
185 , ( "dynamic" , NoArg (removeOpt "-static") )
186 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
188 ----- RTS opts ------------------------------------------------------
189 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
190 , ( "Rghc-timing" , NoArg (enableTimingStats) )
192 ------ Compiler flags -----------------------------------------------
193 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
194 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
195 (\s -> removeOpt ("-f"++s)) )
197 -- Pass all remaining "-f<blah>" options to hsc
198 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
201 addOpt = consIORef v_opt_C
203 addWay = consIORef v_Ways
206 fs <- readIORef v_opt_C
207 writeIORef v_opt_C $! filter (/= f) fs
209 lookUp :: FastString -> Bool
210 lookup_def_int :: String -> Int -> Int
211 lookup_def_float :: String -> Float -> Float
212 lookup_str :: String -> Maybe String
214 -- holds the static opts while they're being collected, before
215 -- being unsafely read by unpacked_static_opts below.
216 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
217 GLOBAL_VAR(v_opt_C_ready, False, Bool)
218 staticFlags = unsafePerformIO $ do
219 ready <- readIORef v_opt_C_ready
221 then panic "a static opt was looked at too early!"
222 else readIORef v_opt_C
224 -- -static is the default
225 defaultStaticOpts = ["-static"]
227 packed_static_opts = map mkFastString staticFlags
229 lookUp sw = sw `elem` packed_static_opts
231 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
232 -- and returns the string X
234 = case firstJust (map (startsWith sw) staticFlags) of
235 Just ('=' : str) -> Just str
239 lookup_def_int sw def = case (lookup_str sw) of
240 Nothing -> def -- Use default
241 Just xx -> try_read sw xx
243 lookup_def_float sw def = case (lookup_str sw) of
244 Nothing -> def -- Use default
245 Just xx -> try_read sw xx
248 try_read :: Read a => String -> String -> a
249 -- (try_read sw str) tries to read s; if it fails, it
250 -- bleats about flag sw
253 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
254 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
255 -- ToDo: hack alert. We should really parse the arugments
256 -- and announce errors in a more civilised way.
260 Putting the compiler options into temporary at-files
261 may turn out to be necessary later on if we turn hsc into
262 a pure Win32 application where I think there's a command-line
263 length limit of 255. unpacked_opts understands the @ option.
265 unpacked_opts :: [String]
269 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
271 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
276 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
279 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
280 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
283 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
284 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
285 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
286 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
287 opt_DoTickyProfiling = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
290 opt_Hpc = lookUp FSLIT("-fhpc")
293 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
294 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
295 opt_Parallel = lookUp FSLIT("-fparallel")
296 opt_Flatten = lookUp FSLIT("-fflatten")
299 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
300 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
301 opt_CprOff = lookUp FSLIT("-fcpr-off")
302 -- Switch off CPR analysis in the new demand analyser
303 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
305 opt_GranMacros = lookUp FSLIT("-fgransim")
306 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
307 opt_HistorySize = lookup_def_int "-fhistory-size" 20
308 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
309 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
311 -- Simplifier switches
312 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
313 -- NoPreInlining is there just to see how bad things
314 -- get if you don't do it!
315 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
318 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
319 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
320 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
321 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
322 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
324 opt_UF_DearOp = ( 4 :: Int)
326 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
329 opt_PIC = lookUp FSLIT("-fPIC")
331 opt_Static = lookUp FSLIT("-static")
332 opt_HardwireLibPaths = lookUp FSLIT("-fhardwire-lib-paths")
333 opt_Unregisterised = lookUp FSLIT("-funregisterised")
335 -- Derived, not a real option. Determines whether we will be compiling
336 -- info tables that reside just before the entry code, or with an
337 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
338 -- includes/InfoTables.h.
339 tablesNextToCode = not opt_Unregisterised
340 && cGhcEnableTablesNextToCode == "YES"
342 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
344 -- Include full span info in error messages, instead of just the start position.
345 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
348 -- object files and libraries to be linked in are collected here.
349 -- ToDo: perhaps this could be done without a global, it wasn't obvious
350 -- how to do it though --SDM.
351 GLOBAL_VAR(v_Ld_inputs, [], [String])
355 "fauto-sccs-on-all-toplevs",
356 "fauto-sccs-on-exported-toplevs",
357 "fauto-sccs-on-individual-cafs",
360 "firrefutable-tuples",
364 "fno-hi-version-check",
366 "fno-method-sharing",
371 "funfolding-update-in-place",
373 "fhardwire-lib-paths",
381 || any (`isPrefixOf` f) [
382 "fliberate-case-threshold",
385 "funfolding-creation-threshold",
386 "funfolding-use-threshold",
387 "funfolding-fun-discount",
388 "funfolding-keeness-factor"
393 -- Misc functions for command-line options
395 startsWith :: String -> String -> Maybe String
396 -- startsWith pfx (pfx++rest) = Just rest
398 startsWith [] str = Just str
399 startsWith (c:cs) (s:ss)
400 = if c /= s then Nothing else startsWith cs ss
401 startsWith _ [] = Nothing
404 -----------------------------------------------------------------------------
405 -- convert sizes like "3.5M" into integers
407 decodeSize :: String -> Integer
409 | c == "" = truncate n
410 | c == "K" || c == "k" = truncate (n * 1000)
411 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
412 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
413 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
414 where (m, c) = span pred str
416 pred c = isDigit c || c == '.'
419 -----------------------------------------------------------------------------
422 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
423 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
425 -----------------------------------------------------------------------------
428 -- The central concept of a "way" is that all objects in a given
429 -- program must be compiled in the same "way". Certain options change
430 -- parameters of the virtual machine, eg. profiling adds an extra word
431 -- to the object header, so profiling objects cannot be linked with
432 -- non-profiling objects.
434 -- After parsing the command-line options, we determine which "way" we
435 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
437 -- We then find the "build-tag" associated with this way, and this
438 -- becomes the suffix used to find .hi files and libraries used in
441 GLOBAL_VAR(v_Build_tag, "", String)
443 -- The RTS has its own build tag, because there are some ways that
444 -- affect the RTS only.
445 GLOBAL_VAR(v_RTS_Build_tag, "", String)
475 GLOBAL_VAR(v_Ways, [] ,[WayName])
477 allowed_combination way = and [ x `allowedWith` y
478 | x <- way, y <- way, x < y ]
480 -- Note ordering in these tests: the left argument is
481 -- <= the right argument, according to the Ord instance
484 -- debug is allowed with everything
485 _ `allowedWith` WayDebug = True
486 WayDebug `allowedWith` _ = True
488 WayProf `allowedWith` WayUnreg = True
489 WayProf `allowedWith` WayNDP = True
490 _ `allowedWith` _ = False
493 findBuildTag :: IO [String] -- new options
495 way_names <- readIORef v_Ways
496 let ws = sort (nub way_names)
498 if not (allowed_combination ws)
499 then throwDyn (CmdLineError $
500 "combination not supported: " ++
501 foldr1 (\a b -> a ++ '/':b)
502 (map (wayName . lkupWay) ws))
503 else let ways = map lkupWay ws
504 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
505 rts_tag = mkBuildTag ways
506 flags = map wayOpts ways
508 writeIORef v_Build_tag tag
509 writeIORef v_RTS_Build_tag rts_tag
510 return (concat flags)
514 mkBuildTag :: [Way] -> String
515 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
518 case lookup w way_details of
519 Nothing -> error "findBuildTag"
520 Just details -> details
522 isRTSWay = wayRTSOnly . lkupWay
531 way_details :: [ (WayName, Way) ]
533 [ (WayThreaded, Way "thr" True "Threaded" [
534 #if defined(freebsd_TARGET_OS)
537 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
538 -- which GHC has some problems with. It's currently not clear whether
539 -- the problems are our fault or theirs, but it seems that using the
540 -- alternative 1:1 threading library libthr works around it:
542 #elif defined(solaris2_TARGET_OS)
547 (WayDebug, Way "debug" True "Debug" [] ),
549 (WayProf, Way "p" False "Profiling"
552 , "-optc-DPROFILING" ]),
554 (WayTicky, Way "t" True "Ticky-ticky Profiling"
556 , "-optc-DTICKY_TICKY" ]),
558 (WayUnreg, Way "u" False "Unregisterised"
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"