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,
72 #include "HsVersions.h"
75 import Util ( consIORef )
77 import Config ( cProjectVersionInt, cProjectPatchLevel,
79 import FastString ( FastString, mkFastString )
81 import Maybes ( firstJust )
82 import Panic ( GhcException(..), ghcError )
83 import Constants ( mAX_CONTEXT_REDUCTION_DEPTH )
85 import EXCEPTION ( throwDyn )
87 import UNSAFE_IO ( unsafePerformIO )
89 import Char ( isDigit )
90 import List ( sort, intersperse )
92 -----------------------------------------------------------------------------
95 parseStaticFlags :: [String] -> IO [String]
96 parseStaticFlags args = do
97 (leftover, errs) <- processArgs static_flags args
98 when (not (null errs)) $ throwDyn (UsageError (unlines errs))
100 -- deal with the way flags: the way (eg. prof) gives rise to
101 -- futher flags, some of which might be static.
102 way_flags <- findBuildTag
104 -- if we're unregisterised, add some more flags
105 let unreg_flags | cGhcUnregisterised == "YES" = unregFlags
108 (more_leftover, errs) <- processArgs static_flags (unreg_flags ++ way_flags)
109 when (not (null errs)) $ ghcError (UsageError (unlines errs))
110 return (more_leftover++leftover)
113 -- note that ordering is important in the following list: any flag which
114 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
115 -- flags further down the list with the same prefix.
117 static_flags :: [(String, OptKind IO)]
119 ------- GHCi -------------------------------------------------------
120 ( "ignore-dot-ghci", PassFlag addOpt )
121 , ( "read-dot-ghci" , NoArg (removeOpt "-ignore-dot-ghci") )
123 ------- ways --------------------------------------------------------
124 , ( "prof" , NoArg (addWay WayProf) )
125 , ( "unreg" , NoArg (addWay WayUnreg) )
126 , ( "ticky" , NoArg (addWay WayTicky) )
127 , ( "parallel" , NoArg (addWay WayPar) )
128 , ( "gransim" , NoArg (addWay WayGran) )
129 , ( "smp" , NoArg (addWay WaySMP) )
130 , ( "debug" , NoArg (addWay WayDebug) )
131 , ( "ndp" , NoArg (addWay WayNDP) )
132 , ( "threaded" , NoArg (addWay WayThreaded) )
135 ------ Debugging ----------------------------------------------------
136 , ( "dppr-noprags", PassFlag addOpt )
137 , ( "dppr-debug", PassFlag addOpt )
138 , ( "dppr-user-length", AnySuffix addOpt )
139 -- rest of the debugging flags are dynamic
141 --------- Profiling --------------------------------------------------
142 , ( "auto-all" , NoArg (addOpt "-fauto-sccs-on-all-toplevs") )
143 , ( "auto" , NoArg (addOpt "-fauto-sccs-on-exported-toplevs") )
144 , ( "caf-all" , NoArg (addOpt "-fauto-sccs-on-individual-cafs") )
145 -- "ignore-sccs" doesn't work (ToDo)
147 , ( "no-auto-all" , NoArg (removeOpt "-fauto-sccs-on-all-toplevs") )
148 , ( "no-auto" , NoArg (removeOpt "-fauto-sccs-on-exported-toplevs") )
149 , ( "no-caf-all" , NoArg (removeOpt "-fauto-sccs-on-individual-cafs") )
151 ------- Miscellaneous -----------------------------------------------
152 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
154 ----- Linker --------------------------------------------------------
155 , ( "static" , PassFlag addOpt )
156 , ( "dynamic" , NoArg (removeOpt "-static") )
157 , ( "rdynamic" , NoArg (return ()) ) -- ignored for compat w/ gcc
159 ----- RTS opts ------------------------------------------------------
160 , ( "H" , HasArg (setHeapSize . fromIntegral . decodeSize) )
161 , ( "Rghc-timing" , NoArg (enableTimingStats) )
163 ------ Compiler flags -----------------------------------------------
164 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
165 , ( "fno-", PrefixPred (\s -> isStaticFlag ("f"++s))
166 (\s -> removeOpt ("-f"++s)) )
168 -- Pass all remaining "-f<blah>" options to hsc
169 , ( "f", AnySuffixPred (isStaticFlag) addOpt )
172 addOpt = consIORef v_opt_C
174 addWay = consIORef v_Ways
177 fs <- readIORef v_opt_C
178 writeIORef v_opt_C $! filter (/= f) fs
180 lookUp :: FastString -> Bool
181 lookup_def_int :: String -> Int -> Int
182 lookup_def_float :: String -> Float -> Float
183 lookup_str :: String -> Maybe String
185 -- holds the static opts while they're being collected, before
186 -- being unsafely read by unpacked_static_opts below.
187 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
188 staticFlags = unsafePerformIO (readIORef v_opt_C)
190 -- -static is the default
191 defaultStaticOpts = ["-static"]
193 packed_static_opts = map mkFastString staticFlags
195 lookUp sw = sw `elem` packed_static_opts
197 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
198 -- and returns the string X
200 = case firstJust (map (startsWith sw) staticFlags) of
201 Just ('=' : str) -> Just str
205 lookup_def_int sw def = case (lookup_str sw) of
206 Nothing -> def -- Use default
207 Just xx -> try_read sw xx
209 lookup_def_float sw def = case (lookup_str sw) of
210 Nothing -> def -- Use default
211 Just xx -> try_read sw xx
214 try_read :: Read a => String -> String -> a
215 -- (try_read sw str) tries to read s; if it fails, it
216 -- bleats about flag sw
219 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
220 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
221 -- ToDo: hack alert. We should really parse the arugments
222 -- and announce errors in a more civilised way.
226 Putting the compiler options into temporary at-files
227 may turn out to be necessary later on if we turn hsc into
228 a pure Win32 application where I think there's a command-line
229 length limit of 255. unpacked_opts understands the @ option.
231 unpacked_opts :: [String]
235 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
237 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
242 opt_IgnoreDotGhci = lookUp FSLIT("-ignore-dot-ghci")
245 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
246 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
249 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
250 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
251 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
252 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
253 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
256 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
257 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
258 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
259 opt_Parallel = lookUp FSLIT("-fparallel")
260 opt_SMP = lookUp FSLIT("-fsmp")
261 opt_Flatten = lookUp FSLIT("-fflatten")
264 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
265 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
266 opt_CprOff = lookUp FSLIT("-fcpr-off")
267 opt_RulesOff = lookUp FSLIT("-frules-off")
268 -- Switch off CPR analysis in the new demand analyser
269 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
270 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
272 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
273 opt_GranMacros = lookUp FSLIT("-fgransim")
274 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
275 opt_HistorySize = lookup_def_int "-fhistory-size" 20
276 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
277 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
279 -- Simplifier switches
280 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
281 -- NoPreInlining is there just to see how bad things
282 -- get if you don't do it!
283 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
286 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
287 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
288 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
289 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
290 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
292 opt_UF_DearOp = ( 4 :: Int)
294 opt_Static = lookUp FSLIT("-static")
295 opt_Unregisterised = lookUp FSLIT("-funregisterised")
296 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
298 -- Include full span info in error messages, instead of just the start position.
299 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
301 opt_PIC = lookUp FSLIT("-fPIC")
303 -- object files and libraries to be linked in are collected here.
304 -- ToDo: perhaps this could be done without a global, it wasn't obvious
305 -- how to do it though --SDM.
306 GLOBAL_VAR(v_Ld_inputs, [], [String])
310 "fauto-sccs-on-all-toplevs",
311 "fauto-sccs-on-exported-toplevs",
312 "fauto-sccs-on-individual-cafs",
317 "firrefutable-tuples",
323 "femit-extern-decls",
324 "fglobalise-toplev-names",
326 "fno-hi-version-check",
328 "fno-method-sharing",
333 "funfolding-update-in-place",
343 || any (flip prefixMatch f) [
345 "fliberate-case-threshold",
348 "funfolding-creation-threshold",
349 "funfolding-use-threshold",
350 "funfolding-fun-discount",
351 "funfolding-keeness-factor"
356 -- Misc functions for command-line options
358 startsWith :: String -> String -> Maybe String
359 -- startsWith pfx (pfx++rest) = Just rest
361 startsWith [] str = Just str
362 startsWith (c:cs) (s:ss)
363 = if c /= s then Nothing else startsWith cs ss
364 startsWith _ [] = Nothing
367 -----------------------------------------------------------------------------
368 -- convert sizes like "3.5M" into integers
370 decodeSize :: String -> Integer
372 | c == "" = truncate n
373 | c == "K" || c == "k" = truncate (n * 1000)
374 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
375 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
376 | otherwise = throwDyn (CmdLineError ("can't decode size: " ++ str))
377 where (m, c) = span pred str
379 pred c = isDigit c || c == '.'
382 -----------------------------------------------------------------------------
385 #if __GLASGOW_HASKELL__ >= 504
386 foreign import ccall unsafe "setHeapSize" setHeapSize :: Int -> IO ()
387 foreign import ccall unsafe "enableTimingStats" enableTimingStats :: IO ()
389 foreign import "setHeapSize" unsafe setHeapSize :: Int -> IO ()
390 foreign import "enableTimingStats" unsafe enableTimingStats :: IO ()
393 -----------------------------------------------------------------------------
396 -- The central concept of a "way" is that all objects in a given
397 -- program must be compiled in the same "way". Certain options change
398 -- parameters of the virtual machine, eg. profiling adds an extra word
399 -- to the object header, so profiling objects cannot be linked with
400 -- non-profiling objects.
402 -- After parsing the command-line options, we determine which "way" we
403 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
405 -- We then find the "build-tag" associated with this way, and this
406 -- becomes the suffix used to find .hi files and libraries used in
409 GLOBAL_VAR(v_Build_tag, "", String)
411 -- The RTS has its own build tag, because there are some ways that
412 -- affect the RTS only.
413 GLOBAL_VAR(v_RTS_Build_tag, "", String)
444 GLOBAL_VAR(v_Ways, [] ,[WayName])
446 allowed_combination way = and [ x `allowedWith` y
447 | x <- way, y <- way, x < y ]
449 -- Note ordering in these tests: the left argument is
450 -- <= the right argument, according to the Ord instance
453 -- debug is allowed with everything
454 _ `allowedWith` WayDebug = True
455 WayDebug `allowedWith` _ = True
457 WayThreaded `allowedWith` WayProf = True
458 WayProf `allowedWith` WayUnreg = True
459 WayProf `allowedWith` WaySMP = True
460 WayProf `allowedWith` WayNDP = True
461 _ `allowedWith` _ = False
464 findBuildTag :: IO [String] -- new options
466 way_names <- readIORef v_Ways
467 let ws = sort way_names
468 if not (allowed_combination ws)
469 then throwDyn (CmdLineError $
470 "combination not supported: " ++
471 foldr1 (\a b -> a ++ '/':b)
472 (map (wayName . lkupWay) ws))
473 else let ways = map lkupWay ws
474 tag = mkBuildTag (filter (not.wayRTSOnly) ways)
475 rts_tag = mkBuildTag ways
476 flags = map wayOpts ways
478 writeIORef v_Build_tag tag
479 writeIORef v_RTS_Build_tag rts_tag
480 return (concat flags)
482 mkBuildTag :: [Way] -> String
483 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
486 case lookup w way_details of
487 Nothing -> error "findBuildTag"
488 Just details -> details
497 way_details :: [ (WayName, Way) ]
499 [ (WayThreaded, Way "thr" True "Threaded" [
500 #if defined(freebsd_TARGET_OS)
506 (WayDebug, Way "debug" True "Debug" [] ),
508 (WayProf, Way "p" False "Profiling"
514 (WayTicky, Way "t" False "Ticky-ticky Profiling"
517 , "-optc-DTICKY_TICKY"
520 (WayUnreg, Way "u" False "Unregisterised"
523 -- optl's below to tell linker where to find the PVM library -- HWL
524 (WayPar, Way "mp" False "Parallel"
526 , "-D__PARALLEL_HASKELL__"
528 , "-package concurrent"
530 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
535 -- at the moment we only change the RTS and could share compiler and libs!
536 (WayPar, Way "mt" False "Parallel ticky profiling"
538 , "-D__PARALLEL_HASKELL__"
541 , "-package concurrent"
543 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
548 (WayPar, Way "md" False "Distributed"
550 , "-D__PARALLEL_HASKELL__"
551 , "-D__DISTRIBUTED_HASKELL__"
554 , "-package concurrent"
556 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
561 (WayGran, Way "mg" False "GranSim"
565 , "-package concurrent"
568 (WaySMP, Way "s" False "SMP"
571 #ifndef freebsd_TARGET_OS
577 (WayNDP, Way "ndp" False "Nested data parallelism"
581 (WayUser_a, Way "a" False "User way 'a'" ["$WAY_a_REAL_OPTS"]),
582 (WayUser_b, Way "b" False "User way 'b'" ["$WAY_b_REAL_OPTS"]),
583 (WayUser_c, Way "c" False "User way 'c'" ["$WAY_c_REAL_OPTS"]),
584 (WayUser_d, Way "d" False "User way 'd'" ["$WAY_d_REAL_OPTS"]),
585 (WayUser_e, Way "e" False "User way 'e'" ["$WAY_e_REAL_OPTS"]),
586 (WayUser_f, Way "f" False "User way 'f'" ["$WAY_f_REAL_OPTS"]),
587 (WayUser_g, Way "g" False "User way 'g'" ["$WAY_g_REAL_OPTS"]),
588 (WayUser_h, Way "h" False "User way 'h'" ["$WAY_h_REAL_OPTS"]),
589 (WayUser_i, Way "i" False "User way 'i'" ["$WAY_i_REAL_OPTS"]),
590 (WayUser_j, Way "j" False "User way 'j'" ["$WAY_j_REAL_OPTS"]),
591 (WayUser_k, Way "k" False "User way 'k'" ["$WAY_k_REAL_OPTS"]),
592 (WayUser_l, Way "l" False "User way 'l'" ["$WAY_l_REAL_OPTS"]),
593 (WayUser_m, Way "m" False "User way 'm'" ["$WAY_m_REAL_OPTS"]),
594 (WayUser_n, Way "n" False "User way 'n'" ["$WAY_n_REAL_OPTS"]),
595 (WayUser_o, Way "o" False "User way 'o'" ["$WAY_o_REAL_OPTS"]),
596 (WayUser_A, Way "A" False "User way 'A'" ["$WAY_A_REAL_OPTS"]),
597 (WayUser_B, Way "B" False "User way 'B'" ["$WAY_B_REAL_OPTS"])
602 , "-optc-DUSE_MINIINTERPRETER"
603 , "-fno-asm-mangling"