1 -----------------------------------------------------------------------------
2 -- $Id: DriverState.hs,v 1.61 2001/10/26 00:53:27 sof Exp $
4 -- Settings for the driver
6 -- (c) The University of Glasgow 2000
8 -----------------------------------------------------------------------------
10 module DriverState where
12 #include "../includes/config.h"
13 #include "HsVersions.h"
15 import SysTools ( getTopDir )
16 import ParsePkgConf ( loadPackageConfig )
17 import Packages ( PackageConfig(..), mungePackagePaths )
30 import Directory ( doesDirectoryExist )
32 -----------------------------------------------------------------------------
33 -- non-configured things
35 cHaskell1Version = "5" -- i.e., Haskell 98
37 -----------------------------------------------------------------------------
38 -- GHC modes of operation
41 = DoMkDependHS -- ghc -M
42 | DoMkDLL -- ghc --mk-dll
43 | StopBefore Phase -- ghc -E | -C | -S | -c
44 | DoMake -- ghc --make
45 | DoInteractive -- ghc --interactive
46 | DoLink -- [ the default ]
49 GLOBAL_VAR(v_GhcMode, error "mode not set", GhcMode)
51 isCompManagerMode DoMake = True
52 isCompManagerMode DoInteractive = True
53 isCompManagerMode _ = False
55 -----------------------------------------------------------------------------
56 -- Global compilation flags
59 v_Hs_source_cpp_opts = global
60 [ "-D__HASKELL1__="++cHaskell1Version
61 , "-D__GLASGOW_HASKELL__="++cProjectVersionInt
63 , "-D__CONCURRENT_HASKELL__"
65 {-# NOINLINE v_Hs_source_cpp_opts #-}
68 -- Keep output from intermediate phases
69 GLOBAL_VAR(v_Keep_hi_diffs, False, Bool)
70 GLOBAL_VAR(v_Keep_hc_files, False, Bool)
71 GLOBAL_VAR(v_Keep_il_files, False, Bool)
72 GLOBAL_VAR(v_Keep_s_files, False, Bool)
73 GLOBAL_VAR(v_Keep_raw_s_files, False, Bool)
74 GLOBAL_VAR(v_Keep_tmp_files, False, Bool)
77 GLOBAL_VAR(v_Scale_sizes_by, 1.0, Double)
78 GLOBAL_VAR(v_Static, True, Bool)
79 GLOBAL_VAR(v_NoHsMain, False, Bool)
80 GLOBAL_VAR(v_Recomp, True, Bool)
81 GLOBAL_VAR(v_Collect_ghc_timing, False, Bool)
82 GLOBAL_VAR(v_Do_asm_mangling, True, Bool)
83 GLOBAL_VAR(v_Excess_precision, False, Bool)
84 GLOBAL_VAR(v_Read_DotGHCi, True, Bool)
87 GLOBAL_VAR(v_Hs_source_pp_opts, [], [String])
89 -----------------------------------------------------------------------------
90 -- Splitting object files (for libraries)
92 GLOBAL_VAR(v_Split_object_files, False, Bool)
93 GLOBAL_VAR(v_Split_info, ("",0), (String,Int))
94 -- The split prefix and number of files
98 can_split = prefixMatch "i386" cTARGETPLATFORM
99 || prefixMatch "alpha" cTARGETPLATFORM
100 || prefixMatch "hppa" cTARGETPLATFORM
101 || prefixMatch "m68k" cTARGETPLATFORM
102 || prefixMatch "mips" cTARGETPLATFORM
103 || prefixMatch "powerpc" cTARGETPLATFORM
104 || prefixMatch "rs6000" cTARGETPLATFORM
105 || prefixMatch "sparc" cTARGETPLATFORM
107 -----------------------------------------------------------------------------
108 -- Compiler output options
111 | cGhcWithNativeCodeGen == "YES" &&
112 (prefixMatch "i386" cTARGETPLATFORM ||
113 prefixMatch "sparc" cTARGETPLATFORM) = HscAsm
116 GLOBAL_VAR(v_Output_dir, Nothing, Maybe String)
117 GLOBAL_VAR(v_Output_file, Nothing, Maybe String)
118 GLOBAL_VAR(v_Output_hi, Nothing, Maybe String)
120 GLOBAL_VAR(v_Object_suf, Nothing, Maybe String)
121 GLOBAL_VAR(v_HC_suf, Nothing, Maybe String)
122 GLOBAL_VAR(v_Hi_dir, Nothing, Maybe String)
123 GLOBAL_VAR(v_Hi_suf, "hi", String)
125 GLOBAL_VAR(v_Ld_inputs, [], [String])
127 odir_ify :: String -> IO String
129 odir_opt <- readIORef v_Output_dir
132 Just d -> return (newdir d f)
134 osuf_ify :: String -> IO String
136 osuf_opt <- readIORef v_Object_suf
139 Just s -> return (newsuf s f)
141 -----------------------------------------------------------------------------
142 -- Compiler optimisation options
144 GLOBAL_VAR(v_OptLevel, 0, Int)
146 setOptLevel :: String -> IO ()
147 setOptLevel "" = do { writeIORef v_OptLevel 1 }
148 setOptLevel "not" = writeIORef v_OptLevel 0
149 setOptLevel [c] | isDigit c = do
150 let level = ord c - ord '0'
151 writeIORef v_OptLevel level
152 setOptLevel s = unknownFlagErr ("-O"++s)
154 GLOBAL_VAR(v_minus_o2_for_C, False, Bool)
155 GLOBAL_VAR(v_MaxSimplifierIterations, 4, Int)
156 GLOBAL_VAR(v_StgStats, False, Bool)
157 GLOBAL_VAR(v_UsageSPInf, False, Bool) -- Off by default
158 GLOBAL_VAR(v_Strictness, True, Bool)
159 GLOBAL_VAR(v_CPR, True, Bool)
160 GLOBAL_VAR(v_CSE, True, Bool)
161 GLOBAL_VAR(v_RuleCheck, Nothing, Maybe String)
163 -- these are the static flags you get without -O.
166 "-fignore-interface-pragmas",
167 "-fomit-interface-pragmas",
168 "-fdo-lambda-eta-expansion", -- This one is important for a tiresome reason:
169 -- we want to make sure that the bindings for data
170 -- constructors are eta-expanded. This is probably
171 -- a good thing anyway, but it seems fragile.
175 -- these are the static flags you get when -O is on.
180 "-fdo-eta-reduction",
181 "-fdo-lambda-eta-expansion",
187 hsc_minusO2_flags = hsc_minusO_flags -- for now
189 getStaticOptimisationFlags 0 = hsc_minusNoO_flags
190 getStaticOptimisationFlags 1 = hsc_minusO_flags
191 getStaticOptimisationFlags n = hsc_minusO2_flags
193 buildCoreToDo :: IO [CoreToDo]
195 opt_level <- readIORef v_OptLevel
196 max_iter <- readIORef v_MaxSimplifierIterations
197 usageSP <- readIORef v_UsageSPInf
198 strictness <- readIORef v_Strictness
199 cpr <- readIORef v_CPR
200 cse <- readIORef v_CSE
201 rule_check <- readIORef v_RuleCheck
203 if opt_level == 0 then return
205 CoreDoSimplify (SimplPhase 0) [
206 MaxSimplifierIterations max_iter
210 else {- opt_level >= 1 -} return [
212 -- initial simplify: mk specialiser happy: minimum effort please
213 CoreDoSimplify SimplGently [
215 -- Don't inline anything till full laziness has bitten
216 -- In particular, inlining wrappers inhibits floating
217 -- e.g. ...(case f x of ...)...
218 -- ==> ...(case (case x of I# x# -> fw x#) of ...)...
219 -- ==> ...(case x of I# x# -> case fw x# of ...)...
220 -- and now the redex (f x) isn't floatable any more
221 -- Similarly, don't apply any rules until after full
222 -- laziness. Notably, list fusion can prevent floating.
225 -- Don't do case-of-case transformations.
226 -- This makes full laziness work better
227 MaxSimplifierIterations max_iter
230 -- Specialisation is best done before full laziness
231 -- so that overloaded functions have all their dictionary lambdas manifest
234 CoreDoFloatOutwards False{-not full-},
237 CoreDoSimplify (SimplPhase 2) [
238 -- Want to run with inline phase 2 after the specialiser to give
239 -- maximum chance for fusion to work before we inline build/augment
240 -- in phase 1. This made a difference in 'ansi' where an
241 -- overloaded function wasn't inlined till too late.
242 MaxSimplifierIterations max_iter
244 case rule_check of { Just pat -> CoreDoRuleCheck 2 pat; Nothing -> CoreDoNothing },
246 -- infer usage information here in case we need it later.
247 -- (add more of these where you need them --KSW 1999-04)
248 if usageSP then CoreDoUSPInf else CoreDoNothing,
250 CoreDoSimplify (SimplPhase 1) [
251 -- Need inline-phase2 here so that build/augment get
252 -- inlined. I found that spectral/hartel/genfft lost some useful
253 -- strictness in the function sumcode' if augment is not inlined
254 -- before strictness analysis runs
255 MaxSimplifierIterations max_iter
257 case rule_check of { Just pat -> CoreDoRuleCheck 1 pat; Nothing -> CoreDoNothing },
259 CoreDoSimplify (SimplPhase 0) [
260 -- Phase 0: allow all Ids to be inlined now
261 -- This gets foldr inlined before strictness analysis
263 MaxSimplifierIterations 3
264 -- At least 3 iterations because otherwise we land up with
265 -- huge dead expressions because of an infelicity in the
267 -- let k = BIG in foldr k z xs
268 -- ==> let k = BIG in letrec go = \xs -> ...(k x).... in go xs
269 -- ==> let k = BIG in letrec go = \xs -> ...(BIG x).... in go xs
273 case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
275 if cpr then CoreDoCPResult else CoreDoNothing,
276 if strictness then CoreDoStrictness else CoreDoNothing,
280 CoreDoSimplify (SimplPhase 0) [
281 MaxSimplifierIterations max_iter
284 CoreDoFloatOutwards False{-not full-},
285 -- nofib/spectral/hartel/wang doubles in speed if you
286 -- do full laziness late in the day. It only happens
287 -- after fusion and other stuff, so the early pass doesn't
288 -- catch it. For the record, the redex is
289 -- f_el22 (f_el21 r_midblock)
292 -- Leave out lambda lifting for now
293 -- "-fsimplify", -- Tidy up results of full laziness
295 -- "-fmax-simplifier-iterations2",
297 -- "-ffloat-outwards-full",
299 -- We want CSE to follow the final full-laziness pass, because it may
300 -- succeed in commoning up things floated out by full laziness.
301 -- CSE used to rely on the no-shadowing invariant, but it doesn't any more
303 if cse then CoreCSE else CoreDoNothing,
307 -- Case-liberation for -O2. This should be after
308 -- strictness analysis and the simplification which follows it.
310 case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
312 if opt_level >= 2 then
316 if opt_level >= 2 then
321 -- Final clean-up simplification:
322 CoreDoSimplify (SimplPhase 0) [
323 MaxSimplifierIterations max_iter
327 buildStgToDo :: IO [ StgToDo ]
329 stg_stats <- readIORef v_StgStats
330 let flags1 | stg_stats = [ D_stg_stats ]
334 ways_ <- readIORef v_Ways
335 let flags2 | WayProf `elem` ways_ = StgDoMassageForProfiling : flags1
340 -----------------------------------------------------------------------------
343 split_marker = ':' -- not configurable (ToDo)
345 v_Import_paths, v_Include_paths, v_Library_paths :: IORef [String]
346 GLOBAL_VAR(v_Import_paths, ["."], [String])
347 GLOBAL_VAR(v_Include_paths, ["."], [String])
348 GLOBAL_VAR(v_Library_paths, [], [String])
350 GLOBAL_VAR(v_Cmdline_libraries, [], [String])
352 addToDirList :: IORef [String] -> String -> IO ()
353 addToDirList ref path
354 = do paths <- readIORef ref
355 shiny_new_ones <- splitUp path
356 writeIORef ref (paths ++ shiny_new_ones)
359 splitUp ::String -> IO [String]
360 #ifdef mingw32_TARGET_OS
361 -- 'hybrid' support for DOS-style paths in directory lists.
363 -- That is, if "foo:bar:baz" is used, this interpreted as
364 -- consisting of three entries, 'foo', 'bar', 'baz'.
365 -- However, with "c:/foo:c:\\foo;x:/bar", this is interpreted
366 -- as four elts, "c:/foo", "c:\\foo", "x", and "/bar" --
367 -- *provided* c:/foo exists and x:/bar doesn't.
369 -- Notice that no attempt is made to fully replace the 'standard'
370 -- split marker ':' with the Windows / DOS one, ';'. The reason being
371 -- that this will cause too much breakage for users & ':' will
372 -- work fine even with DOS paths, if you're not insisting on being silly.
374 splitUp [] = return []
375 splitUp (x:':':div:xs)
376 | div `elem` dir_markers = do
377 let (p,rs) = findNextPath xs
380 Consult the file system to check the interpretation
381 of (x:':':div:p) -- this is arguably excessive, we
382 could skip this test & just say that it is a valid
385 flg <- doesDirectoryExist (x:':':div:p)
387 return ((x:':':div:p):ps)
389 return ([x]:(div:p):ps)
391 let (p,rs) = findNextPath xs
398 -- will be called either when we've consumed nought or the "<Drive>:/" part of
399 -- a DOS path, so splitting is just a Q of finding the next split marker.
401 case break (`elem` split_markers) xs of
405 split_markers :: [Char]
406 split_markers = [':', ';']
408 dir_markers :: [Char]
409 dir_markers = ['/', '\\']
412 splitUp xs = return (split split_marker xs)
415 GLOBAL_VAR(v_HCHeader, "", String)
417 -----------------------------------------------------------------------------
420 -- package list is maintained in dependency order
421 GLOBAL_VAR(v_Packages, ("std":"rts":"gmp":[]), [String])
423 readPackageConf :: String -> IO ()
424 readPackageConf conf_file = do
425 proto_pkg_details <- loadPackageConfig conf_file
427 let pkg_details = mungePackagePaths top_dir proto_pkg_details
428 old_pkg_details <- readIORef v_Package_details
429 let intersection = filter (`elem` map name old_pkg_details)
430 (map name pkg_details)
431 if (not (null intersection))
432 then throwDyn (InstallationError ("package `" ++ head intersection ++ "' is already defined"))
434 writeIORef v_Package_details (pkg_details ++ old_pkg_details)
436 addPackage :: String -> IO ()
438 = do pkg_details <- readIORef v_Package_details
439 case lookupPkg package pkg_details of
440 Nothing -> throwDyn (CmdLineError ("unknown package name: " ++ package))
442 ps <- readIORef v_Packages
443 unless (package `elem` ps) $ do
444 mapM_ addPackage (package_deps details)
445 ps <- readIORef v_Packages
446 writeIORef v_Packages (package:ps)
448 getPackageImportPath :: IO [String]
449 getPackageImportPath = do
451 return (nub (filter (not.null) (concatMap import_dirs ps)))
453 getPackageIncludePath :: IO [String]
454 getPackageIncludePath = do
456 return (nub (filter (not.null) (concatMap include_dirs ps)))
458 -- includes are in reverse dependency order (i.e. rts first)
459 getPackageCIncludes :: IO [String]
460 getPackageCIncludes = do
462 return (reverse (nub (filter (not.null) (concatMap c_includes ps))))
464 getPackageLibraryPath :: IO [String]
465 getPackageLibraryPath = do
467 return (nub (filter (not.null) (concatMap library_dirs ps)))
469 getPackageLibraries :: IO [String]
470 getPackageLibraries = do
472 tag <- readIORef v_Build_tag
473 let suffix = if null tag then "" else '_':tag
475 map (\p -> map (++suffix) (hACK (hs_libraries p)) ++ extra_libraries p) ps
478 -- This is a totally horrible (temporary) hack, for Win32. Problem is
479 -- that package.conf for Win32 says that the main prelude lib is
480 -- split into HSstd1 and HSstd2, which is needed due to limitations in
481 -- the PEi386 file format, to make GHCi work. However, we still only
482 -- have HSstd.a for static linking, not HSstd1.a and HSstd2.a.
483 -- getPackageLibraries is called to find the .a's to add to the static
484 -- link line. On Win32, this hACK detects HSstd1 and HSstd2 and
485 -- replaces them with HSstd, so static linking still works.
486 -- Libraries needed for dynamic (GHCi) linking are discovered via
487 -- different route (in InteractiveUI.linkPackage).
488 -- See driver/PackageSrc.hs for the HSstd1/HSstd2 split definition.
489 -- THIS IS A STRICTLY TEMPORARY HACK (famous last words ...)
490 -- JRS 04 Sept 01: Same appalling hack for HSwin32[1,2]
492 # ifndef mingw32_TARGET_OS
495 = if "HSstd1" `elem` libs && "HSstd2" `elem` libs
496 then "HSstd" : filter ((/= "HSstd").(take 5)) libs
498 if "HSwin321" `elem` libs && "HSwin322" `elem` libs
499 then "HSwin32" : filter ((/= "HSwin32").(take 7)) libs
504 getPackageExtraGhcOpts :: IO [String]
505 getPackageExtraGhcOpts = do
507 return (concatMap extra_ghc_opts ps)
509 getPackageExtraCcOpts :: IO [String]
510 getPackageExtraCcOpts = do
512 return (concatMap extra_cc_opts ps)
514 getPackageExtraLdOpts :: IO [String]
515 getPackageExtraLdOpts = do
517 return (concatMap extra_ld_opts ps)
519 getPackageInfo :: IO [PackageConfig]
521 ps <- readIORef v_Packages
524 getPackageDetails :: [String] -> IO [PackageConfig]
525 getPackageDetails ps = do
526 pkg_details <- readIORef v_Package_details
527 return [ pkg | p <- ps, Just pkg <- [ lookupPkg p pkg_details ] ]
529 GLOBAL_VAR(v_Package_details, [], [PackageConfig])
531 lookupPkg :: String -> [PackageConfig] -> Maybe PackageConfig
533 = case [p | p <- ps, name p == nm] of
537 -----------------------------------------------------------------------------
540 -- The central concept of a "way" is that all objects in a given
541 -- program must be compiled in the same "way". Certain options change
542 -- parameters of the virtual machine, eg. profiling adds an extra word
543 -- to the object header, so profiling objects cannot be linked with
544 -- non-profiling objects.
546 -- After parsing the command-line options, we determine which "way" we
547 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
549 -- We then find the "build-tag" associated with this way, and this
550 -- becomes the suffix used to find .hi files and libraries used in
553 GLOBAL_VAR(v_Build_tag, "", String)
582 GLOBAL_VAR(v_Ways, [] ,[WayName])
584 allowed_combination way = way `elem` combs
585 where -- the sub-lists must be ordered according to WayName,
586 -- because findBuildTag sorts them
587 combs = [ [WayProf,WayUnreg], [WayProf,WaySMP] ]
589 findBuildTag :: IO [String] -- new options
591 way_names <- readIORef v_Ways
592 case sort way_names of
593 [] -> do -- writeIORef v_Build_tag ""
596 [w] -> do let details = lkupWay w
597 writeIORef v_Build_tag (wayTag details)
598 return (wayOpts details)
600 ws -> if not (allowed_combination ws)
601 then throwDyn (CmdLineError $
602 "combination not supported: " ++
603 foldr1 (\a b -> a ++ '/':b)
604 (map (wayName . lkupWay) ws))
605 else let stuff = map lkupWay ws
606 tag = concat (map wayTag stuff)
607 flags = map wayOpts stuff
609 writeIORef v_Build_tag tag
610 return (concat flags)
613 case lookup w way_details of
614 Nothing -> error "findBuildTag"
615 Just details -> details
623 way_details :: [ (WayName, Way) ]
625 [ (WayProf, Way "p" "Profiling"
631 (WayTicky, Way "t" "Ticky-ticky Profiling"
634 , "-optc-DTICKY_TICKY"
637 (WayUnreg, Way "u" "Unregisterised"
640 -- optl's below to tell linker where to find the PVM library -- HWL
641 (WayPar, Way "mp" "Parallel"
643 , "-D__PARALLEL_HASKELL__"
645 , "-package concurrent"
647 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
652 -- at the moment we only change the RTS and could share compiler and libs!
653 (WayPar, Way "mt" "Parallel ticky profiling"
655 , "-D__PARALLEL_HASKELL__"
658 , "-package concurrent"
660 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
665 (WayPar, Way "md" "Distributed"
667 , "-D__PARALLEL_HASKELL__"
668 , "-D__DISTRIBUTED_HASKELL__"
671 , "-package concurrent"
673 , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
678 (WayGran, Way "mg" "GranSim"
682 , "-package concurrent"
685 (WaySMP, Way "s" "SMP"
692 (WayUser_a, Way "a" "User way 'a'" ["$WAY_a_REAL_OPTS"]),
693 (WayUser_b, Way "b" "User way 'b'" ["$WAY_b_REAL_OPTS"]),
694 (WayUser_c, Way "c" "User way 'c'" ["$WAY_c_REAL_OPTS"]),
695 (WayUser_d, Way "d" "User way 'd'" ["$WAY_d_REAL_OPTS"]),
696 (WayUser_e, Way "e" "User way 'e'" ["$WAY_e_REAL_OPTS"]),
697 (WayUser_f, Way "f" "User way 'f'" ["$WAY_f_REAL_OPTS"]),
698 (WayUser_g, Way "g" "User way 'g'" ["$WAY_g_REAL_OPTS"]),
699 (WayUser_h, Way "h" "User way 'h'" ["$WAY_h_REAL_OPTS"]),
700 (WayUser_i, Way "i" "User way 'i'" ["$WAY_i_REAL_OPTS"]),
701 (WayUser_j, Way "j" "User way 'j'" ["$WAY_j_REAL_OPTS"]),
702 (WayUser_k, Way "k" "User way 'k'" ["$WAY_k_REAL_OPTS"]),
703 (WayUser_l, Way "l" "User way 'l'" ["$WAY_l_REAL_OPTS"]),
704 (WayUser_m, Way "m" "User way 'm'" ["$WAY_m_REAL_OPTS"]),
705 (WayUser_n, Way "n" "User way 'n'" ["$WAY_n_REAL_OPTS"]),
706 (WayUser_o, Way "o" "User way 'o'" ["$WAY_o_REAL_OPTS"]),
707 (WayUser_A, Way "A" "User way 'A'" ["$WAY_A_REAL_OPTS"]),
708 (WayUser_B, Way "B" "User way 'B'" ["$WAY_B_REAL_OPTS"])
713 , "-optc-DUSE_MINIINTERPRETER"
714 , "-fno-asm-mangling"
718 -----------------------------------------------------------------------------
719 -- Options for particular phases
721 GLOBAL_VAR(v_Opt_dep, [], [String])
722 GLOBAL_VAR(v_Anti_opt_C, [], [String])
723 GLOBAL_VAR(v_Opt_C, [], [String])
724 GLOBAL_VAR(v_Opt_l, [], [String])
725 GLOBAL_VAR(v_Opt_dll, [], [String])
727 getStaticOpts :: IORef [String] -> IO [String]
728 getStaticOpts ref = readIORef ref >>= return . reverse