Make some profiling flags dynamic
[ghc-hetmet.git] / compiler / main / StaticFlags.hs
1 {-# OPTIONS -fno-cse #-}
2 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
3
4 -----------------------------------------------------------------------------
5 --
6 -- Static flags
7 --
8 -- Static flags can only be set once, on the command-line.  Inside GHC,
9 -- each static flag corresponds to a top-level value, usually of type Bool.
10 --
11 -- (c) The University of Glasgow 2005
12 --
13 -----------------------------------------------------------------------------
14
15 module StaticFlags (
16         staticFlags,
17         initStaticOpts,
18
19         -- Ways
20         WayName(..), v_Ways, v_Build_tag, v_RTS_Build_tag, isRTSWay,
21
22         -- Output style options
23         opt_PprUserLength,
24         opt_SuppressUniques,
25         opt_PprStyle_Debug,
26         opt_NoDebugOutput,
27
28         -- profiling opts
29         opt_SccProfilingOn,
30         opt_DoTickyProfiling,
31
32         -- Hpc opts
33         opt_Hpc,
34
35         -- language opts
36         opt_DictsStrict,
37         opt_IrrefutableTuples,
38         opt_Parallel,
39
40         -- optimisation opts
41         opt_PassCaseBndrToJoinPoints,
42         opt_DsMultiTyVar,
43         opt_NoStateHack,
44         opt_SimpleListLiterals,
45         opt_SpecInlineJoinPoints,
46         opt_CprOff,
47         opt_SimplNoPreInlining,
48         opt_SimplExcessPrecision,
49         opt_MaxWorkerArgs,
50
51         -- Unfolding control
52         opt_UF_CreationThreshold,
53         opt_UF_UseThreshold,
54         opt_UF_FunAppDiscount,
55         opt_UF_KeenessFactor,
56         opt_UF_DearOp,
57
58         -- Optimization fuel controls
59         opt_Fuel,
60
61         -- Related to linking
62         opt_PIC,
63         opt_Static,
64
65         -- misc opts
66         opt_IgnoreDotGhci,
67         opt_ErrorSpans,
68         opt_GranMacros,
69         opt_HiVersion,
70         opt_HistorySize,
71         opt_OmitBlackHoling,
72         opt_Unregisterised,
73         opt_EmitExternalCore,
74         v_Ld_inputs,
75         tablesNextToCode,
76         opt_StubDeadValues,
77
78     -- For the parser
79     addOpt, removeOpt, addWay, findBuildTag, v_opt_C_ready
80   ) where
81
82 #include "HsVersions.h"
83
84 import Config
85 import FastString
86 import Util
87 import Maybes           ( firstJust )
88 import Panic
89
90 import Data.IORef
91 import System.IO.Unsafe ( unsafePerformIO )
92 import Data.List
93
94 -----------------------------------------------------------------------------
95 -- Static flags
96
97 initStaticOpts :: IO ()
98 initStaticOpts = writeIORef v_opt_C_ready True
99
100 addOpt :: String -> IO ()
101 addOpt = consIORef v_opt_C
102
103 addWay :: WayName -> IO ()
104 addWay = consIORef v_Ways
105
106 removeOpt :: String -> IO ()
107 removeOpt f = do
108   fs <- readIORef v_opt_C
109   writeIORef v_opt_C $! filter (/= f) fs    
110
111 lookUp           :: FastString -> Bool
112 lookup_def_int   :: String -> Int -> Int
113 lookup_def_float :: String -> Float -> Float
114 lookup_str       :: String -> Maybe String
115
116 -- holds the static opts while they're being collected, before
117 -- being unsafely read by unpacked_static_opts below.
118 GLOBAL_VAR(v_opt_C, defaultStaticOpts, [String])
119 GLOBAL_VAR(v_opt_C_ready, False, Bool)
120
121 staticFlags :: [String]
122 staticFlags = unsafePerformIO $ do
123   ready <- readIORef v_opt_C_ready
124   if (not ready)
125         then panic "Static flags have not been initialised!\n        Please call GHC.newSession or GHC.parseStaticFlags early enough."
126         else readIORef v_opt_C
127
128 -- -static is the default
129 defaultStaticOpts :: [String]
130 defaultStaticOpts = ["-static"]
131
132 packed_static_opts :: [FastString]
133 packed_static_opts   = map mkFastString staticFlags
134
135 lookUp     sw = sw `elem` packed_static_opts
136         
137 -- (lookup_str "foo") looks for the flag -foo=X or -fooX, 
138 -- and returns the string X
139 lookup_str sw 
140    = case firstJust (map (maybePrefixMatch sw) staticFlags) of
141         Just ('=' : str) -> Just str
142         Just str         -> Just str
143         Nothing          -> Nothing     
144
145 lookup_def_int sw def = case (lookup_str sw) of
146                             Nothing -> def              -- Use default
147                             Just xx -> try_read sw xx
148
149 lookup_def_float sw def = case (lookup_str sw) of
150                             Nothing -> def              -- Use default
151                             Just xx -> try_read sw xx
152
153
154 try_read :: Read a => String -> String -> a
155 -- (try_read sw str) tries to read s; if it fails, it
156 -- bleats about flag sw
157 try_read sw str
158   = case reads str of
159         ((x,_):_) -> x  -- Be forgiving: ignore trailing goop, and alternative parses
160         []        -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
161                         -- ToDo: hack alert. We should really parse the arugments
162                         --       and announce errors in a more civilised way.
163
164
165 {-
166  Putting the compiler options into temporary at-files
167  may turn out to be necessary later on if we turn hsc into
168  a pure Win32 application where I think there's a command-line
169  length limit of 255. unpacked_opts understands the @ option.
170
171 unpacked_opts :: [String]
172 unpacked_opts =
173   concat $
174   map (expandAts) $
175   map unpackFS argv  -- NOT ARGV any more: v_Static_hsc_opts
176   where
177    expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
178    expandAts l = [l]
179 -}
180
181 opt_IgnoreDotGhci :: Bool
182 opt_IgnoreDotGhci               = lookUp (fsLit "-ignore-dot-ghci")
183
184 -- debugging opts
185 opt_SuppressUniques :: Bool
186 opt_SuppressUniques             = lookUp  (fsLit "-dsuppress-uniques")
187 opt_PprStyle_Debug  :: Bool
188 opt_PprStyle_Debug              = lookUp  (fsLit "-dppr-debug")
189 opt_PprUserLength   :: Int
190 opt_PprUserLength               = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
191 opt_Fuel            :: Int
192 opt_Fuel                        = lookup_def_int "-dopt-fuel" maxBound
193 opt_NoDebugOutput   :: Bool
194 opt_NoDebugOutput               = lookUp  (fsLit "-dno-debug-output")
195
196
197 -- profiling opts
198 opt_SccProfilingOn :: Bool
199 opt_SccProfilingOn              = lookUp  (fsLit "-fscc-profiling")
200 opt_DoTickyProfiling :: Bool
201 opt_DoTickyProfiling            = WayTicky `elem` (unsafePerformIO $ readIORef v_Ways)
202
203 -- Hpc opts
204 opt_Hpc :: Bool
205 opt_Hpc                         = lookUp (fsLit "-fhpc")  
206
207 -- language opts
208 opt_DictsStrict :: Bool
209 opt_DictsStrict                 = lookUp  (fsLit "-fdicts-strict")
210 opt_IrrefutableTuples :: Bool
211 opt_IrrefutableTuples           = lookUp  (fsLit "-firrefutable-tuples")
212 opt_Parallel :: Bool
213 opt_Parallel                    = lookUp  (fsLit "-fparallel")
214
215 -- optimisation opts
216 opt_DsMultiTyVar :: Bool
217 opt_DsMultiTyVar                = not (lookUp (fsLit "-fno-ds-multi-tyvar"))
218         -- On by default
219
220 opt_PassCaseBndrToJoinPoints :: Bool
221 opt_PassCaseBndrToJoinPoints    = lookUp  (fsLit "-fpass-case-bndr-to-join-points")
222
223 opt_SpecInlineJoinPoints :: Bool
224 opt_SpecInlineJoinPoints        = lookUp  (fsLit "-fspec-inline-join-points")
225
226 opt_SimpleListLiterals :: Bool
227 opt_SimpleListLiterals          = lookUp  (fsLit "-fsimple-list-literals")
228
229 opt_NoStateHack :: Bool
230 opt_NoStateHack                 = lookUp  (fsLit "-fno-state-hack")
231
232 opt_CprOff :: Bool
233 opt_CprOff                      = lookUp  (fsLit "-fcpr-off")
234         -- Switch off CPR analysis in the new demand analyser
235 opt_MaxWorkerArgs :: Int
236 opt_MaxWorkerArgs               = lookup_def_int "-fmax-worker-args" (10::Int)
237
238 opt_GranMacros :: Bool
239 opt_GranMacros                  = lookUp  (fsLit "-fgransim")
240 opt_HiVersion :: Integer
241 opt_HiVersion                   = read (cProjectVersionInt ++ cProjectPatchLevel) :: Integer
242 opt_HistorySize :: Int
243 opt_HistorySize                 = lookup_def_int "-fhistory-size" 20
244 opt_OmitBlackHoling :: Bool
245 opt_OmitBlackHoling             = lookUp  (fsLit "-dno-black-holing")
246 opt_StubDeadValues  :: Bool
247 opt_StubDeadValues              = lookUp  (fsLit "-dstub-dead-values")
248
249 -- Simplifier switches
250 opt_SimplNoPreInlining :: Bool
251 opt_SimplNoPreInlining          = lookUp  (fsLit "-fno-pre-inlining")
252         -- NoPreInlining is there just to see how bad things
253         -- get if you don't do it!
254 opt_SimplExcessPrecision :: Bool
255 opt_SimplExcessPrecision        = lookUp  (fsLit "-fexcess-precision")
256
257 -- Unfolding control
258 opt_UF_CreationThreshold :: Int
259 opt_UF_CreationThreshold        = lookup_def_int "-funfolding-creation-threshold"  (45::Int)
260 opt_UF_UseThreshold :: Int
261 opt_UF_UseThreshold             = lookup_def_int "-funfolding-use-threshold"       (8::Int)     -- Discounts can be big
262 opt_UF_FunAppDiscount :: Int
263 opt_UF_FunAppDiscount           = lookup_def_int "-funfolding-fun-discount"        (6::Int)     -- It's great to inline a fn
264 opt_UF_KeenessFactor :: Float
265 opt_UF_KeenessFactor            = lookup_def_float "-funfolding-keeness-factor"    (1.5::Float)
266
267 opt_UF_DearOp :: Int
268 opt_UF_DearOp   = ( 4 :: Int)
269
270
271 -- Related to linking
272 opt_PIC :: Bool
273 #if darwin_TARGET_OS && x86_64_TARGET_ARCH
274 opt_PIC                         = True
275 #else
276 opt_PIC                         = lookUp (fsLit "-fPIC")
277 #endif
278 opt_Static :: Bool
279 opt_Static                      = lookUp  (fsLit "-static")
280 opt_Unregisterised :: Bool
281 opt_Unregisterised              = lookUp  (fsLit "-funregisterised")
282
283 -- Derived, not a real option.  Determines whether we will be compiling
284 -- info tables that reside just before the entry code, or with an
285 -- indirection to the entry code.  See TABLES_NEXT_TO_CODE in 
286 -- includes/InfoTables.h.
287 tablesNextToCode :: Bool
288 tablesNextToCode                = not opt_Unregisterised
289                                   && cGhcEnableTablesNextToCode == "YES"
290
291 opt_EmitExternalCore :: Bool
292 opt_EmitExternalCore            = lookUp  (fsLit "-fext-core")
293
294 -- Include full span info in error messages, instead of just the start position.
295 opt_ErrorSpans :: Bool
296 opt_ErrorSpans                  = lookUp (fsLit "-ferror-spans")
297
298
299 -- object files and libraries to be linked in are collected here.
300 -- ToDo: perhaps this could be done without a global, it wasn't obvious
301 -- how to do it though --SDM.
302 GLOBAL_VAR(v_Ld_inputs, [],      [String])
303
304 -----------------------------------------------------------------------------
305 -- Ways
306
307 -- The central concept of a "way" is that all objects in a given
308 -- program must be compiled in the same "way".  Certain options change
309 -- parameters of the virtual machine, eg. profiling adds an extra word
310 -- to the object header, so profiling objects cannot be linked with
311 -- non-profiling objects.
312
313 -- After parsing the command-line options, we determine which "way" we
314 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
315
316 -- We then find the "build-tag" associated with this way, and this
317 -- becomes the suffix used to find .hi files and libraries used in
318 -- this compilation.
319
320 GLOBAL_VAR(v_Build_tag, "", String)
321
322 -- The RTS has its own build tag, because there are some ways that
323 -- affect the RTS only.
324 GLOBAL_VAR(v_RTS_Build_tag, "", String)
325
326 data WayName
327   = WayThreaded
328   | WayDebug
329   | WayProf
330   | WayTicky
331   | WayPar
332   | WayGran
333   | WayNDP
334   | WayUser_a
335   | WayUser_b
336   | WayUser_c
337   | WayUser_d
338   | WayUser_e
339   | WayUser_f
340   | WayUser_g
341   | WayUser_h
342   | WayUser_i
343   | WayUser_j
344   | WayUser_k
345   | WayUser_l
346   | WayUser_m
347   | WayUser_n
348   | WayUser_o
349   | WayUser_A
350   | WayUser_B
351   deriving (Eq,Ord)
352
353 GLOBAL_VAR(v_Ways, [] ,[WayName])
354
355 allowed_combination :: [WayName] -> Bool
356 allowed_combination way = and [ x `allowedWith` y 
357                               | x <- way, y <- way, x < y ]
358   where
359         -- Note ordering in these tests: the left argument is
360         -- <= the right argument, according to the Ord instance
361         -- on Way above.
362
363         -- debug is allowed with everything
364         _ `allowedWith` WayDebug                = True
365         WayDebug `allowedWith` _                = True
366
367         WayProf `allowedWith` WayNDP            = True
368         WayThreaded `allowedWith` WayProf       = True
369         _ `allowedWith` _                       = False
370
371
372 findBuildTag :: IO [String]  -- new options
373 findBuildTag = do
374   way_names <- readIORef v_Ways
375   let ws = sort (nub way_names)
376
377   if not (allowed_combination ws)
378       then ghcError (CmdLineError $
379                     "combination not supported: "  ++
380                     foldr1 (\a b -> a ++ '/':b) 
381                     (map (wayName . lkupWay) ws))
382       else let ways    = map lkupWay ws
383                tag     = mkBuildTag (filter (not.wayRTSOnly) ways)
384                rts_tag = mkBuildTag ways
385                flags   = map wayOpts ways
386            in do
387            writeIORef v_Build_tag tag
388            writeIORef v_RTS_Build_tag rts_tag
389            return (concat flags)
390
391
392
393 mkBuildTag :: [Way] -> String
394 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
395
396 lkupWay :: WayName -> Way
397 lkupWay w = 
398    case lookup w way_details of
399         Nothing -> error "findBuildTag"
400         Just details -> details
401
402 isRTSWay :: WayName -> Bool
403 isRTSWay = wayRTSOnly . lkupWay 
404
405 data Way = Way {
406   wayTag     :: String,
407   wayRTSOnly :: Bool,
408   wayName    :: String,
409   wayOpts    :: [String]
410   }
411
412 way_details :: [ (WayName, Way) ]
413 way_details =
414   [ (WayThreaded, Way "thr" True "Threaded" [
415 #if defined(freebsd_TARGET_OS)
416 --        "-optc-pthread"
417 --      , "-optl-pthread"
418         -- FreeBSD's default threading library is the KSE-based M:N libpthread,
419         -- which GHC has some problems with.  It's currently not clear whether
420         -- the problems are our fault or theirs, but it seems that using the
421         -- alternative 1:1 threading library libthr works around it:
422           "-optl-lthr"
423 #elif defined(solaris2_TARGET_OS)
424           "-optl-lrt"
425 #endif
426         ] ),
427
428     (WayDebug, Way "debug" True "Debug" [] ),
429
430     (WayProf, Way  "p" False "Profiling"
431         [ "-fscc-profiling"
432         , "-DPROFILING"
433         , "-optc-DPROFILING" ]),
434
435     (WayTicky, Way  "t" True "Ticky-ticky Profiling"  
436         [ "-DTICKY_TICKY"
437         , "-optc-DTICKY_TICKY" ]),
438
439     -- optl's below to tell linker where to find the PVM library -- HWL
440     (WayPar, Way  "mp" False "Parallel" 
441         [ "-fparallel"
442         , "-D__PARALLEL_HASKELL__"
443         , "-optc-DPAR"
444         , "-package concurrent"
445         , "-optc-w"
446         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
447         , "-optl-lpvm3"
448         , "-optl-lgpvm3" ]),
449
450     -- at the moment we only change the RTS and could share compiler and libs!
451     (WayPar, Way  "mt" False "Parallel ticky profiling" 
452         [ "-fparallel"
453         , "-D__PARALLEL_HASKELL__"
454         , "-optc-DPAR"
455         , "-optc-DPAR_TICKY"
456         , "-package concurrent"
457         , "-optc-w"
458         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
459         , "-optl-lpvm3"
460         , "-optl-lgpvm3" ]),
461
462     (WayPar, Way  "md" False "Distributed" 
463         [ "-fparallel"
464         , "-D__PARALLEL_HASKELL__"
465         , "-D__DISTRIBUTED_HASKELL__"
466         , "-optc-DPAR"
467         , "-optc-DDIST"
468         , "-package concurrent"
469         , "-optc-w"
470         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
471         , "-optl-lpvm3"
472         , "-optl-lgpvm3" ]),
473
474     (WayGran, Way  "mg" False "GranSim"
475         [ "-fgransim"
476         , "-D__GRANSIM__"
477         , "-optc-DGRAN"
478         , "-package concurrent" ]),
479
480     (WayNDP, Way  "ndp" False "Nested data parallelism"
481         [ "-XParr"
482         , "-fvectorise"]),
483
484     (WayUser_a,  Way  "a"  False "User way 'a'"  ["$WAY_a_REAL_OPTS"]), 
485     (WayUser_b,  Way  "b"  False "User way 'b'"  ["$WAY_b_REAL_OPTS"]), 
486     (WayUser_c,  Way  "c"  False "User way 'c'"  ["$WAY_c_REAL_OPTS"]), 
487     (WayUser_d,  Way  "d"  False "User way 'd'"  ["$WAY_d_REAL_OPTS"]), 
488     (WayUser_e,  Way  "e"  False "User way 'e'"  ["$WAY_e_REAL_OPTS"]), 
489     (WayUser_f,  Way  "f"  False "User way 'f'"  ["$WAY_f_REAL_OPTS"]), 
490     (WayUser_g,  Way  "g"  False "User way 'g'"  ["$WAY_g_REAL_OPTS"]), 
491     (WayUser_h,  Way  "h"  False "User way 'h'"  ["$WAY_h_REAL_OPTS"]), 
492     (WayUser_i,  Way  "i"  False "User way 'i'"  ["$WAY_i_REAL_OPTS"]), 
493     (WayUser_j,  Way  "j"  False "User way 'j'"  ["$WAY_j_REAL_OPTS"]), 
494     (WayUser_k,  Way  "k"  False "User way 'k'"  ["$WAY_k_REAL_OPTS"]), 
495     (WayUser_l,  Way  "l"  False "User way 'l'"  ["$WAY_l_REAL_OPTS"]), 
496     (WayUser_m,  Way  "m"  False "User way 'm'"  ["$WAY_m_REAL_OPTS"]), 
497     (WayUser_n,  Way  "n"  False "User way 'n'"  ["$WAY_n_REAL_OPTS"]), 
498     (WayUser_o,  Way  "o"  False "User way 'o'"  ["$WAY_o_REAL_OPTS"]), 
499     (WayUser_A,  Way  "A"  False "User way 'A'"  ["$WAY_A_REAL_OPTS"]), 
500     (WayUser_B,  Way  "B"  False "User way 'B'"  ["$WAY_B_REAL_OPTS"]) 
501   ]
502