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 -----------------------------------------------------------------------------
17 WayName(..), v_Ways, v_Build_tag, v_RTS_Build_tag,
19 -- Output style options
24 opt_AutoSccsOnAllToplevs,
25 opt_AutoSccsOnExportedToplevs,
26 opt_AutoSccsOnIndividualCafs,
32 opt_MaxContextReductionDepth,
33 opt_IrrefutableTuples,
42 opt_LiberateCaseThreshold,
45 opt_SimplNoPreInlining,
46 opt_SimplExcessPrecision,
50 opt_UF_CreationThreshold,
52 opt_UF_FunAppDiscount,
73 #include "HsVersions.h"
76 import Util ( consIORef )
78 import Config ( cProjectVersionInt, cProjectPatchLevel,
80 import FastString ( FastString, mkFastString )
82 import Maybes ( firstJust )
83 import Panic ( GhcException(..), ghcError )
84 import Constants ( mAX_CONTEXT_REDUCTION_DEPTH )
86 import EXCEPTION ( throwDyn )
88 import UNSAFE_IO ( unsafePerformIO )
90 import Char ( isDigit )
91 import IO ( hPutStrLn, stderr ) -- ToDo: should use errorMsg
92 import List ( sort, intersperse )
94 -----------------------------------------------------------------------------
97 parseStaticFlags :: [String] -> IO [String]
98 parseStaticFlags args = do
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 -- futher 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)
111 when (not (null errs)) $ ghcError (UsageError (unlines errs))
112 return (more_leftover++leftover)
115 -- note that ordering is important in the following list: any flag which
116 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
117 -- flags further down the list with the same prefix.
119 static_flags :: [(String, OptKind IO)]
121 ------- GHCi -------------------------------------------------------
122 ( "ignore-dot-ghci", PassFlag addOpt )
123 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
125 ------- ways --------------------------------------------------------
126 , ( "prof" , NoArg (addWay WayProf) )
127 , ( "unreg" , NoArg (addWay WayUnreg) )
128 , ( "ticky" , NoArg (addWay WayTicky) )
129 , ( "parallel" , NoArg (addWay WayPar) )
130 , ( "gransim" , NoArg (addWay WayGran) )
131 , ( "smp" , NoArg (addWay WaySMP) )
132 , ( "debug" , NoArg (addWay WayDebug) )
133 , ( "ndp" , NoArg (addWay WayNDP) )
134 , ( "threaded" , NoArg (addWay WayThreaded) )
137 ------ Debugging ----------------------------------------------------
138 , ( "dppr-noprags", PassFlag addOpt )
139 , ( "dppr-debug", PassFlag addOpt )
140 , ( "dppr-user-length", AnySuffix addOpt )
141 -- rest of the debugging flags are dynamic
143 --------- Profiling --------------------------------------------------
144 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
145 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
146 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
147 -- "ignore-sccs" doesn't work (ToDo)
149 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
150 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
151 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
153 ------- Miscellaneous -----------------------------------------------
154 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
156 , ( "split-objs" , NoArg (if can_split
157 then addOpt "-split-objs"
158 else hPutStrLn stderr
159 "warning: don't know how to split object files on this architecture"
162 ----- Linker --------------------------------------------------------
163 , ( "static" , PassFlag addOpt )
164 , ( "dynamic" , NoArg (removeOpt "-static") )
165 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
167 ----- RTS opts ------------------------------------------------------
168 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
169 , ( "Rghc-timing" , NoArg (enableTimingStats) )
171 ------ Compiler flags -----------------------------------------------
172 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
173 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
174 (\s -> removeOpt ("-f"++s)) )
176 -- Pass all remaining "-f<blah>" options to hsc
177 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
180 addOpt = consIORef v_opt_C
182 addWay = consIORef v_Ways
185 fs <- readIORef v_opt_C
186 writeIORef v_opt_C $! filter (/= f) fs
188 lookUp :: FastString -> Bool
189 lookup_def_int :: String -> Int -> Int
190 lookup_def_float :: String -> Float -> Float
191 lookup_str :: String -> Maybe String
193 -- holds the static opts while they're being collected, before
194 -- being unsafely read by unpacked_static_opts below.
195 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
196 staticFlags = unsafePerformIO (readIORef v_opt_C)
198 -- -static is the default
199 defaultStaticOpts = ["-static"]
201 packed_static_opts = map mkFastString staticFlags
203 lookUp sw = sw `elem` packed_static_opts
205 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
206 -- and returns the string X
208 = case firstJust (map (startsWith sw) staticFlags) of
209 Just ('=' : str) -> Just str
213 lookup_def_int sw def = case (lookup_str sw) of
214 Nothing -> def -- Use default
215 Just xx -> try_read sw xx
217 lookup_def_float sw def = case (lookup_str sw) of
218 Nothing -> def -- Use default
219 Just xx -> try_read sw xx
222 try_read :: Read a => String -> String -> a
223 -- (try_read sw str) tries to read s; if it fails, it
224 -- bleats about flag sw
227 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
228 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
229 -- ToDo: hack alert. We should really parse the arugments
230 -- and announce errors in a more civilised way.
234 Putting the compiler options into temporary at-files
235 may turn out to be necessary later on if we turn hsc into
236 a pure Win32 application where I think there's a command-line
237 length limit of 255. unpacked_opts understands the @ option.
239 unpacked_opts :: [String]
243 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
245 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
250 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
253 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
254 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
257 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
258 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
259 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
260 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
261 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
264 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
265 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
266 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
267 opt_Parallel = lookUp FSLIT("-fparallel")
268 opt_SMP = lookUp FSLIT("-fsmp")
269 opt_Flatten = lookUp FSLIT("-fflatten")
272 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
273 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
274 opt_CprOff = lookUp FSLIT("-fcpr-off")
275 opt_RulesOff = lookUp FSLIT("-frules-off")
276 -- Switch off CPR analysis in the new demand analyser
277 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
278 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
280 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
281 opt_SplitObjs = lookUp FSLIT("-split-objs")
282 opt_GranMacros = lookUp FSLIT("-fgransim")
283 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
284 opt_HistorySize = lookup_def_int "-fhistory-size" 20
285 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
286 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
288 -- Simplifier switches
289 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
290 -- NoPreInlining is there just to see how bad things
291 -- get if you don't do it!
292 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
295 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
296 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
297 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
298 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
299 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
301 opt_UF_DearOp = ( 4 :: Int)
303 opt_Static = lookUp FSLIT("-static")
304 opt_Unregisterised = lookUp FSLIT("-funregisterised")
305 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
307 -- Include full span info in error messages, instead of just the start position.
308 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
310 opt_PIC = lookUp FSLIT("-fPIC")
312 -- object files and libraries to be linked in are collected here.
313 -- ToDo: perhaps this could be done without a global, it wasn't obvious
314 -- how to do it though --SDM.
315 GLOBAL_VAR(v_Ld_inputs, [], [String])
319 "fauto-sccs-on-all-toplevs",
320 "fauto-sccs-on-exported-toplevs",
321 "fauto-sccs-on-individual-cafs",
326 "firrefutable-tuples",
332 "femit-extern-decls",
333 "fglobalise-toplev-names",
335 "fno-hi-version-check",
337 "fno-method-sharing",
342 "funfolding-update-in-place",
352 || any (flip prefixMatch f) [
354 "fliberate-case-threshold",
357 "funfolding-creation-threshold",
358 "funfolding-use-threshold",
359 "funfolding-fun-discount",
360 "funfolding-keeness-factor"
365 -- Misc functions for command-line options
367 startsWith :: String -> String -> Maybe String
368 -- startsWith pfx (pfx++rest) = Just rest
370 startsWith [] str = Just str
371 startsWith (c:cs) (s:ss)
372 = if c /= s then Nothing else startsWith cs ss
373 startsWith _ [] = Nothing
376 -----------------------------------------------------------------------------
377 -- convert sizes like "3.5M" into integers
379 decodeSize :: String -> Integer
381 | c == "" = truncate n
382 | c == "K" || c == "k" = truncate (n * 1000)
383 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
384 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
385 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
386 where (m, c) = span pred str
388 pred c = isDigit c || c == '.'
391 -----------------------------------------------------------------------------
394 #if __GLASGOW_HASKELL__ >= 504
395 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
396 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
398 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
399 foreign import "enableTimingStats" unsafe enableTimingStats :: IO ()
402 -- -----------------------------------------------------------------------------
407 #if defined(i386_TARGET_ARCH) \
408 || defined(alpha_TARGET_ARCH) \
409 || defined(hppa_TARGET_ARCH) \
410 || defined(m68k_TARGET_ARCH) \
411 || defined(mips_TARGET_ARCH) \
412 || defined(powerpc_TARGET_ARCH) \
413 || defined(rs6000_TARGET_ARCH) \
414 || defined(sparc_TARGET_ARCH)
420 -----------------------------------------------------------------------------
423 -- The central concept of a "way" is that all objects in a given
424 -- program must be compiled in the same "way". Certain options change
425 -- parameters of the virtual machine, eg. profiling adds an extra word
426 -- to the object header, so profiling objects cannot be linked with
427 -- non-profiling objects.
429 -- After parsing the command-line options, we determine which "way" we
430 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
432 -- We then find the "build-tag" associated with this way, and this
433 -- becomes the suffix used to find .hi files and libraries used in
436 GLOBAL_VAR(v_Build_tag, "", String)
438 -- The RTS has its own build tag, because there are some ways that
439 -- affect the RTS only.
440 GLOBAL_VAR(v_RTS_Build_tag, "", String)
471 GLOBAL_VAR(v_Ways, [] ,[WayName])
473 allowed_combination way = and [ x `allowedWith` y
474 | x <- way, y <- way, x < y ]
476 -- Note ordering in these tests: the left argument is
477 -- <= the right argument, according to the Ord instance
480 -- debug is allowed with everything
481 _ `allowedWith` WayDebug = True
482 WayDebug `allowedWith` _ = True
484 WayThreaded `allowedWith` WayProf = True
485 WayProf `allowedWith` WayUnreg = True
486 WayProf `allowedWith` WaySMP = True
487 WayProf `allowedWith` WayNDP = True
488 _ `allowedWith` _ = False
491 findBuildTag :: IO [String] -- new options
493 way_names <- readIORef v_Ways
494 let ws = sort 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)
509 mkBuildTag :: [Way] -> String
510 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
513 case lookup w way_details of
514 Nothing -> error "findBuildTag"
515 Just details -> details
524 way_details :: [ (WayName, Way) ]
526 [ (WayThreaded, Way "thr" True "Threaded" [
527 #if defined(freebsd_TARGET_OS)
533 (WayDebug, Way "debug" True "Debug" [] ),
535 (WayProf, Way "p" False "Profiling"
541 (WayTicky, Way "t" False "Ticky-ticky Profiling"
544 , "-optc-DTICKY_TICKY"
547 (WayUnreg, Way "u" False "Unregisterised"
550 -- optl's below to tell linker where to find the PVM library -- HWL
551 (WayPar, Way "mp" False "Parallel"
553 , "-D__PARALLEL_HASKELL__"
555 , "-package concurrent"
557 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
562 -- at the moment we only change the RTS and could share compiler and libs!
563 (WayPar, Way "mt" False "Parallel ticky profiling"
565 , "-D__PARALLEL_HASKELL__"
568 , "-package concurrent"
570 , "-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}"
588 (WayGran, Way "mg" False "GranSim"
592 , "-package concurrent"
595 (WaySMP, Way "s" False "SMP"
598 #ifndef freebsd_TARGET_OS
604 (WayNDP, Way "ndp" False "Nested data parallelism"
608 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
609 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
610 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
611 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
612 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
613 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
614 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
615 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
616 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
617 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
618 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
619 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
620 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
621 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
622 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
623 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
624 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
629 , "-optc-DUSE_MINIINTERPRETER"
630 , "-fno-asm-mangling"