1 -----------------------------------------------------------------------------
2 -- $Id: DriverState.hs,v 1.28 2001/02/20 15:44:26 simonpj Exp $
4 -- Settings for the driver
6 -- (c) The University of Glasgow 2000
8 -----------------------------------------------------------------------------
10 module DriverState where
12 #include "HsVersions.h"
21 #ifdef mingw32_TARGET_OS
22 import TmpFiles ( newTempName )
23 import Directory ( removeFile )
31 -----------------------------------------------------------------------------
32 -- non-configured things
34 cHaskell1Version = "5" -- i.e., Haskell 98
36 -----------------------------------------------------------------------------
37 -- Global compilation flags
39 -- location of compiler-related files
40 GLOBAL_VAR(v_TopDir, clibdir, String)
43 v_Hs_source_cpp_opts = global
44 [ "-D__HASKELL1__="++cHaskell1Version
45 , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
47 , "-D__CONCURRENT_HASKELL__"
49 {-# NOINLINE v_Hs_source_cpp_opts #-}
51 -- Keep output from intermediate phases
52 GLOBAL_VAR(v_Keep_hi_diffs, False, Bool)
53 GLOBAL_VAR(v_Keep_hc_files, False, Bool)
54 GLOBAL_VAR(v_Keep_s_files, False, Bool)
55 GLOBAL_VAR(v_Keep_raw_s_files, False, Bool)
56 GLOBAL_VAR(v_Keep_tmp_files, False, Bool)
59 GLOBAL_VAR(v_Scale_sizes_by, 1.0, Double)
60 GLOBAL_VAR(v_Dry_run, False, Bool)
61 GLOBAL_VAR(v_Static, True, Bool)
62 GLOBAL_VAR(v_NoHsMain, False, Bool)
63 GLOBAL_VAR(v_Recomp, True, Bool)
64 GLOBAL_VAR(v_Collect_ghc_timing, False, Bool)
65 GLOBAL_VAR(v_Do_asm_mangling, True, Bool)
66 GLOBAL_VAR(v_Excess_precision, False, Bool)
68 -----------------------------------------------------------------------------
69 -- Splitting object files (for libraries)
71 GLOBAL_VAR(v_Split_object_files, False, Bool)
72 GLOBAL_VAR(v_Split_prefix, "", String)
73 GLOBAL_VAR(v_N_split_files, 0, Int)
76 can_split = prefixMatch "i386" cTARGETPLATFORM
77 || prefixMatch "alpha" cTARGETPLATFORM
78 || prefixMatch "hppa" cTARGETPLATFORM
79 || prefixMatch "m68k" cTARGETPLATFORM
80 || prefixMatch "mips" cTARGETPLATFORM
81 || prefixMatch "powerpc" cTARGETPLATFORM
82 || prefixMatch "rs6000" cTARGETPLATFORM
83 || prefixMatch "sparc" cTARGETPLATFORM
85 -----------------------------------------------------------------------------
86 -- Compiler output options
89 | cGhcWithNativeCodeGen == "YES" &&
90 (prefixMatch "i386" cTARGETPLATFORM ||
91 prefixMatch "sparc" cTARGETPLATFORM) = HscAsm
94 GLOBAL_VAR(v_Output_dir, Nothing, Maybe String)
95 GLOBAL_VAR(v_Object_suf, Nothing, Maybe String)
96 GLOBAL_VAR(v_Output_file, Nothing, Maybe String)
97 GLOBAL_VAR(v_Output_hi, Nothing, Maybe String)
99 GLOBAL_VAR(v_Ld_inputs, [], [String])
101 odir_ify :: String -> IO String
103 odir_opt <- readIORef v_Output_dir
106 Just d -> return (newdir d f)
108 osuf_ify :: String -> IO String
110 osuf_opt <- readIORef v_Object_suf
113 Just s -> return (newsuf s f)
115 -----------------------------------------------------------------------------
118 GLOBAL_VAR(v_Hi_on_stdout, False, Bool)
119 GLOBAL_VAR(v_Hi_suf, "hi", String)
121 -----------------------------------------------------------------------------
122 -- Compiler optimisation options
124 GLOBAL_VAR(v_OptLevel, 0, Int)
126 setOptLevel :: String -> IO ()
127 setOptLevel "" = do { writeIORef v_OptLevel 1 }
128 setOptLevel "not" = writeIORef v_OptLevel 0
129 setOptLevel [c] | isDigit c = do
130 let level = ord c - ord '0'
131 writeIORef v_OptLevel level
132 setOptLevel s = unknownFlagErr ("-O"++s)
134 GLOBAL_VAR(v_minus_o2_for_C, False, Bool)
135 GLOBAL_VAR(v_MaxSimplifierIterations, 4, Int)
136 GLOBAL_VAR(v_StgStats, False, Bool)
137 GLOBAL_VAR(v_UsageSPInf, False, Bool) -- Off by default
138 GLOBAL_VAR(v_Strictness, True, Bool)
139 GLOBAL_VAR(v_CPR, True, Bool)
140 GLOBAL_VAR(v_CSE, True, Bool)
142 -- these are the static flags you get without -O.
145 "-fignore-interface-pragmas",
146 "-fomit-interface-pragmas",
147 "-fdo-lambda-eta-expansion", -- This one is important for a tiresome reason:
148 -- we want to make sure that the bindings for data
149 -- constructors are eta-expanded. This is probably
150 -- a good thing anyway, but it seems fragile.
154 -- these are the static flags you get when -O is on.
158 "-fdo-eta-reduction",
159 "-fdo-lambda-eta-expansion",
165 hsc_minusO2_flags = hsc_minusO_flags -- for now
167 getStaticOptimisationFlags 0 = hsc_minusNoO_flags
168 getStaticOptimisationFlags 1 = hsc_minusO_flags
169 getStaticOptimisationFlags n = hsc_minusO2_flags
171 buildCoreToDo :: IO [CoreToDo]
173 opt_level <- readIORef v_OptLevel
174 max_iter <- readIORef v_MaxSimplifierIterations
175 usageSP <- readIORef v_UsageSPInf
176 strictness <- readIORef v_Strictness
177 cpr <- readIORef v_CPR
178 cse <- readIORef v_CSE
180 if opt_level == 0 then return
182 CoreDoSimplify (isAmongSimpl [
183 MaxSimplifierIterations max_iter
187 else {- opt_level >= 1 -} return [
189 -- initial simplify: mk specialiser happy: minimum effort please
190 CoreDoSimplify (isAmongSimpl [
192 -- Don't inline anything till full laziness has bitten
193 -- In particular, inlining wrappers inhibits floating
194 -- e.g. ...(case f x of ...)...
195 -- ==> ...(case (case x of I# x# -> fw x#) of ...)...
196 -- ==> ...(case x of I# x# -> case fw x# of ...)...
197 -- and now the redex (f x) isn't floatable any more
199 -- Similarly, don't apply any rules until after full
200 -- laziness. Notably, list fusion can prevent floating.
202 -- Don't do case-of-case transformations.
203 -- This makes full laziness work better
204 MaxSimplifierIterations max_iter
207 -- Specialisation is best done before full laziness
208 -- so that overloaded functions have all their dictionary lambdas manifest
211 CoreDoFloatOutwards False{-not full-},
214 CoreDoSimplify (isAmongSimpl [
216 -- Want to run with inline phase 1 after the specialiser to give
217 -- maximum chance for fusion to work before we inline build/augment
218 -- in phase 2. This made a difference in 'ansi' where an
219 -- overloaded function wasn't inlined till too late.
220 MaxSimplifierIterations max_iter
223 -- infer usage information here in case we need it later.
224 -- (add more of these where you need them --KSW 1999-04)
225 if usageSP then CoreDoUSPInf else CoreDoNothing,
227 CoreDoSimplify (isAmongSimpl [
228 -- Need inline-phase2 here so that build/augment get
229 -- inlined. I found that spectral/hartel/genfft lost some useful
230 -- strictness in the function sumcode' if augment is not inlined
231 -- before strictness analysis runs
233 MaxSimplifierIterations max_iter
236 CoreDoSimplify (isAmongSimpl [
237 MaxSimplifierIterations 2
238 -- No -finline-phase: allow all Ids to be inlined now
239 -- This gets foldr inlined before strictness analysis
242 if strictness then CoreDoStrictness else CoreDoNothing,
243 if cpr then CoreDoCPResult else CoreDoNothing,
247 CoreDoSimplify (isAmongSimpl [
248 MaxSimplifierIterations max_iter
249 -- No -finline-phase: allow all Ids to be inlined now
252 CoreDoFloatOutwards False{-not full-},
253 -- nofib/spectral/hartel/wang doubles in speed if you
254 -- do full laziness late in the day. It only happens
255 -- after fusion and other stuff, so the early pass doesn't
256 -- catch it. For the record, the redex is
257 -- f_el22 (f_el21 r_midblock)
260 -- Leave out lambda lifting for now
261 -- "-fsimplify", -- Tidy up results of full laziness
263 -- "-fmax-simplifier-iterations2",
265 -- "-ffloat-outwards-full",
267 -- We want CSE to follow the final full-laziness pass, because it may
268 -- succeed in commoning up things floated out by full laziness.
269 -- CSE used to rely on the no-shadowing invariant, but it doesn't any more
271 if cse then CoreCSE else CoreDoNothing,
275 -- Case-liberation for -O2. This should be after
276 -- strictness analysis and the simplification which follows it.
278 if opt_level >= 2 then
283 -- Final clean-up simplification:
284 CoreDoSimplify (isAmongSimpl [
285 MaxSimplifierIterations max_iter
286 -- No -finline-phase: allow all Ids to be inlined now
290 buildStgToDo :: IO [ StgToDo ]
292 stg_stats <- readIORef v_StgStats
293 let flags1 | stg_stats = [ D_stg_stats ]
297 ways_ <- readIORef v_Ways
298 let flags2 | WayProf `elem` ways_ = StgDoMassageForProfiling : flags1
303 -----------------------------------------------------------------------------
306 split_marker = ':' -- not configurable (ToDo)
308 v_Import_paths, v_Include_paths, v_Library_paths :: IORef [String]
309 GLOBAL_VAR(v_Import_paths, ["."], [String])
310 GLOBAL_VAR(v_Include_paths, ["."], [String])
311 GLOBAL_VAR(v_Library_paths, [], [String])
313 GLOBAL_VAR(v_Cmdline_libraries, [], [String])
315 addToDirList :: IORef [String] -> String -> IO ()
316 addToDirList ref path
317 = do paths <- readIORef ref
318 writeIORef ref (paths ++ split split_marker path)
320 -----------------------------------------------------------------------------
323 GLOBAL_VAR(v_Path_package_config, error "path_package_config", String)
325 -- package list is maintained in dependency order
326 GLOBAL_VAR(v_Packages, ("std":"rts":"gmp":[]), [String])
328 addPackage :: String -> IO ()
330 = do pkg_details <- readIORef v_Package_details
331 case lookupPkg package pkg_details of
332 Nothing -> throwDyn (OtherError ("unknown package name: " ++ package))
334 ps <- readIORef v_Packages
335 unless (package `elem` ps) $ do
336 mapM_ addPackage (package_deps details)
337 ps <- readIORef v_Packages
338 writeIORef v_Packages (package:ps)
340 getPackageImportPath :: IO [String]
341 getPackageImportPath = do
343 return (nub (concat (map import_dirs ps)))
345 getPackageIncludePath :: IO [String]
346 getPackageIncludePath = do
348 return (nub (filter (not.null) (concatMap include_dirs ps)))
350 -- includes are in reverse dependency order (i.e. rts first)
351 getPackageCIncludes :: IO [String]
352 getPackageCIncludes = do
354 return (reverse (nub (filter (not.null) (concatMap c_includes ps))))
356 getPackageLibraryPath :: IO [String]
357 getPackageLibraryPath = do
359 return (nub (concat (map library_dirs ps)))
361 getPackageLibraries :: IO [String]
362 getPackageLibraries = do
364 tag <- readIORef v_Build_tag
365 let suffix = if null tag then "" else '_':tag
367 map (\p -> map (++suffix) (hs_libraries p) ++ extra_libraries p) ps
370 getPackageExtraGhcOpts :: IO [String]
371 getPackageExtraGhcOpts = do
373 return (concatMap extra_ghc_opts ps)
375 getPackageExtraCcOpts :: IO [String]
376 getPackageExtraCcOpts = do
378 return (concatMap extra_cc_opts ps)
380 getPackageExtraLdOpts :: IO [String]
381 getPackageExtraLdOpts = do
383 return (concatMap extra_ld_opts ps)
385 getPackageInfo :: IO [Package]
387 ps <- readIORef v_Packages
390 getPackageDetails :: [String] -> IO [Package]
391 getPackageDetails ps = do
392 pkg_details <- readIORef v_Package_details
393 return [ pkg | p <- ps, Just pkg <- [ lookupPkg p pkg_details ] ]
395 GLOBAL_VAR(v_Package_details, (error "package_details"), [Package])
397 lookupPkg :: String -> [Package] -> Maybe Package
399 = case [p | p <- ps, name p == nm] of
402 -----------------------------------------------------------------------------
405 -- The central concept of a "way" is that all objects in a given
406 -- program must be compiled in the same "way". Certain options change
407 -- parameters of the virtual machine, eg. profiling adds an extra word
408 -- to the object header, so profiling objects cannot be linked with
409 -- non-profiling objects.
411 -- After parsing the command-line options, we determine which "way" we
412 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
414 -- We then find the "build-tag" associated with this way, and this
415 -- becomes the suffix used to find .hi files and libraries used in
418 GLOBAL_VAR(v_Build_tag, "", String)
447 GLOBAL_VAR(v_Ways, [] ,[WayName])
449 allowed_combination way = way `elem` combs
450 where -- the sub-lists must be ordered according to WayName,
451 -- because findBuildTag sorts them
452 combs = [ [WayProf,WayUnreg], [WayProf,WaySMP] ]
454 findBuildTag :: IO [String] -- new options
456 way_names <- readIORef v_Ways
457 case sort way_names of
458 [] -> do writeIORef v_Build_tag ""
461 [w] -> do let details = lkupWay w
462 writeIORef v_Build_tag (wayTag details)
463 return (wayOpts details)
465 ws -> if not (allowed_combination ws)
466 then throwDyn (OtherError $
467 "combination not supported: " ++
468 foldr1 (\a b -> a ++ '/':b)
469 (map (wayName . lkupWay) ws))
470 else let stuff = map lkupWay ws
471 tag = concat (map wayTag stuff)
472 flags = map wayOpts stuff
474 writeIORef v_Build_tag tag
475 return (concat flags)
478 case lookup w way_details of
479 Nothing -> error "findBuildTag"
480 Just details -> details
488 way_details :: [ (WayName, Way) ]
490 [ (WayProf, Way "p" "Profiling"
496 (WayTicky, Way "t" "Ticky-ticky Profiling"
499 , "-optc-DTICKY_TICKY"
502 (WayUnreg, Way "u" "Unregisterised"
505 (WayPar, Way "mp" "Parallel"
507 , "-D__PARALLEL_HASKELL__"
509 , "-package concurrent"
512 (WayGran, Way "mg" "Gransim"
516 , "-package concurrent"
519 (WaySMP, Way "s" "SMP"
526 (WayUser_a, Way "a" "User way 'a'" ["$WAY_a_REAL_OPTS"]),
527 (WayUser_b, Way "b" "User way 'b'" ["$WAY_b_REAL_OPTS"]),
528 (WayUser_c, Way "c" "User way 'c'" ["$WAY_c_REAL_OPTS"]),
529 (WayUser_d, Way "d" "User way 'd'" ["$WAY_d_REAL_OPTS"]),
530 (WayUser_e, Way "e" "User way 'e'" ["$WAY_e_REAL_OPTS"]),
531 (WayUser_f, Way "f" "User way 'f'" ["$WAY_f_REAL_OPTS"]),
532 (WayUser_g, Way "g" "User way 'g'" ["$WAY_g_REAL_OPTS"]),
533 (WayUser_h, Way "h" "User way 'h'" ["$WAY_h_REAL_OPTS"]),
534 (WayUser_i, Way "i" "User way 'i'" ["$WAY_i_REAL_OPTS"]),
535 (WayUser_j, Way "j" "User way 'j'" ["$WAY_j_REAL_OPTS"]),
536 (WayUser_k, Way "k" "User way 'k'" ["$WAY_k_REAL_OPTS"]),
537 (WayUser_l, Way "l" "User way 'l'" ["$WAY_l_REAL_OPTS"]),
538 (WayUser_m, Way "m" "User way 'm'" ["$WAY_m_REAL_OPTS"]),
539 (WayUser_n, Way "n" "User way 'n'" ["$WAY_n_REAL_OPTS"]),
540 (WayUser_o, Way "o" "User way 'o'" ["$WAY_o_REAL_OPTS"]),
541 (WayUser_A, Way "A" "User way 'A'" ["$WAY_A_REAL_OPTS"]),
542 (WayUser_B, Way "B" "User way 'B'" ["$WAY_B_REAL_OPTS"])
547 , "-optc-DUSE_MINIINTERPRETER"
548 , "-fno-asm-mangling"
552 -----------------------------------------------------------------------------
553 -- Programs for particular phases
555 GLOBAL_VAR(v_Pgm_L, error "pgm_L", String)
556 GLOBAL_VAR(v_Pgm_P, cRAWCPP, String)
557 GLOBAL_VAR(v_Pgm_c, cGCC, String)
558 GLOBAL_VAR(v_Pgm_m, error "pgm_m", String)
559 GLOBAL_VAR(v_Pgm_s, error "pgm_s", String)
560 GLOBAL_VAR(v_Pgm_a, cGCC, String)
561 GLOBAL_VAR(v_Pgm_l, cGCC, String)
562 GLOBAL_VAR(v_Pgm_dll, cMkDLL, String)
564 GLOBAL_VAR(v_Opt_dep, [], [String])
565 GLOBAL_VAR(v_Anti_opt_C, [], [String])
566 GLOBAL_VAR(v_Opt_C, [], [String])
567 GLOBAL_VAR(v_Opt_l, [], [String])
568 GLOBAL_VAR(v_Opt_dll, [], [String])
570 getStaticOpts :: IORef [String] -> IO [String]
571 getStaticOpts ref = readIORef ref >>= return . reverse