[project @ 2003-06-25 08:20:20 by simonpj]
[ghc-hetmet.git] / ghc / compiler / main / DriverState.hs
1 -----------------------------------------------------------------------------
2 -- $Id: DriverState.hs,v 1.94 2003/06/25 08:20:21 simonpj Exp $
3 --
4 -- Settings for the driver
5 --
6 -- (c) The University of Glasgow 2002
7 --
8 -----------------------------------------------------------------------------
9
10 module DriverState where
11
12 #include "../includes/config.h"
13 #include "HsVersions.h"
14
15 import ParsePkgConf     ( loadPackageConfig )
16 import SysTools         ( getTopDir )
17 import Packages
18 import CmdLineOpts
19 import DriverPhases
20 import DriverUtil
21 import UniqFM           ( eltsUFM )
22 import Util
23 import Config
24 import Panic
25
26 import DATA_IOREF       ( IORef, readIORef, writeIORef )
27 import EXCEPTION
28
29 import List
30 import Char  
31 import Monad
32 import Maybe            ( fromJust, isJust )
33 import Directory        ( doesDirectoryExist )
34
35 -----------------------------------------------------------------------------
36 -- non-configured things
37
38 cHaskell1Version = "5" -- i.e., Haskell 98
39
40 -----------------------------------------------------------------------------
41 -- GHC modes of operation
42
43 data GhcMode
44   = DoMkDependHS                        -- ghc -M
45   | DoMkDLL                             -- ghc --mk-dll
46   | StopBefore Phase                    -- ghc -E | -C | -S | -c
47   | DoMake                              -- ghc --make
48   | DoInteractive                       -- ghc --interactive
49   | DoLink                              -- [ the default ]
50   deriving (Eq,Show)
51
52 GLOBAL_VAR(v_GhcMode,     DoLink, GhcMode)
53 GLOBAL_VAR(v_GhcModeFlag, "",     String)
54
55 setMode :: GhcMode -> String -> IO ()
56 setMode m flag = do
57   old_mode <- readIORef v_GhcMode
58   old_flag <- readIORef v_GhcModeFlag
59   when (notNull old_flag && flag /= old_flag) $
60       throwDyn (UsageError 
61           ("cannot use `" ++ old_flag ++ "' with `" ++ flag ++ "'"))
62   writeIORef v_GhcMode m
63   writeIORef v_GhcModeFlag flag
64
65 isCompManagerMode DoMake        = True
66 isCompManagerMode DoInteractive = True
67 isCompManagerMode _             = False
68
69 -----------------------------------------------------------------------------
70 -- Global compilation flags
71
72 -- Cpp-related flags
73 v_Hs_source_cpp_opts = global
74         [ "-D__HASKELL1__="++cHaskell1Version
75         , "-D__GLASGOW_HASKELL__="++cProjectVersionInt                          
76         , "-D__HASKELL98__"
77         , "-D__CONCURRENT_HASKELL__"
78         ]
79 {-# NOINLINE v_Hs_source_cpp_opts #-}
80
81
82 -- Keep output from intermediate phases
83 GLOBAL_VAR(v_Keep_hi_diffs,             False,          Bool)
84 GLOBAL_VAR(v_Keep_hc_files,             False,          Bool)
85 GLOBAL_VAR(v_Keep_s_files,              False,          Bool)
86 GLOBAL_VAR(v_Keep_raw_s_files,          False,          Bool)
87 GLOBAL_VAR(v_Keep_tmp_files,            False,          Bool)
88 #ifdef ILX
89 GLOBAL_VAR(v_Keep_il_files,             False,          Bool)
90 GLOBAL_VAR(v_Keep_ilx_files,            False,          Bool)
91 #endif
92
93 -- Misc
94 GLOBAL_VAR(v_Scale_sizes_by,            1.0,            Double)
95 GLOBAL_VAR(v_Static,                    True,           Bool)
96 GLOBAL_VAR(v_NoLink,                    False,          Bool)
97 GLOBAL_VAR(v_NoHsMain,                  False,          Bool)
98 GLOBAL_VAR(v_MainModIs,                 Nothing,        Maybe String)
99 GLOBAL_VAR(v_MainFunIs,                 Nothing,        Maybe String)
100 GLOBAL_VAR(v_Recomp,                    True,           Bool)
101 GLOBAL_VAR(v_Collect_ghc_timing,        False,          Bool)
102 GLOBAL_VAR(v_Do_asm_mangling,           True,           Bool)
103 GLOBAL_VAR(v_Excess_precision,          False,          Bool)
104 GLOBAL_VAR(v_Read_DotGHCi,              True,           Bool)
105
106 -- Preprocessor flags
107 GLOBAL_VAR(v_Hs_source_pp_opts, [], [String])
108
109 -----------------------------------------------------------------------------
110 -- Splitting object files (for libraries)
111
112 GLOBAL_VAR(v_Split_object_files,        False,          Bool)
113 GLOBAL_VAR(v_Split_info,                ("",0),         (String,Int))
114         -- The split prefix and number of files
115
116         
117 can_split :: Bool
118 can_split =  prefixMatch "i386"    cTARGETPLATFORM
119           || prefixMatch "alpha"   cTARGETPLATFORM
120           || prefixMatch "hppa"    cTARGETPLATFORM
121           || prefixMatch "m68k"    cTARGETPLATFORM
122           || prefixMatch "mips"    cTARGETPLATFORM
123           || prefixMatch "powerpc" cTARGETPLATFORM
124           || prefixMatch "rs6000"  cTARGETPLATFORM
125           || prefixMatch "sparc"   cTARGETPLATFORM
126
127 -----------------------------------------------------------------------------
128 -- Compiler output options
129
130 GLOBAL_VAR(v_Output_dir,  Nothing, Maybe String)
131 GLOBAL_VAR(v_Output_file, Nothing, Maybe String)
132 GLOBAL_VAR(v_Output_hi,   Nothing, Maybe String)
133
134 -- called to verify that the output files & directories
135 -- point somewhere valid. 
136 --
137 -- The assumption is that the directory portion of these output
138 -- options will have to exist by the time 'verifyOutputFiles'
139 -- is invoked.
140 -- 
141 verifyOutputFiles :: IO ()
142 verifyOutputFiles = do
143   odir <- readIORef v_Output_dir
144   when (isJust odir) $ do
145      let dir = fromJust odir
146      flg <- doesDirectoryExist dir
147      when (not flg) (nonExistentDir "-odir" dir)
148   ofile <- readIORef v_Output_file
149   when (isJust ofile) $ do
150      let fn = fromJust ofile
151      flg <- doesDirNameExist fn
152      when (not flg) (nonExistentDir "-o" fn)
153   ohi <- readIORef v_Output_hi
154   when (isJust ohi) $ do
155      let hi = fromJust ohi
156      flg <- doesDirNameExist hi
157      when (not flg) (nonExistentDir "-ohi" hi)
158  where
159    nonExistentDir flg dir = 
160      throwDyn (CmdLineError ("error: directory portion of " ++ 
161                              show dir ++ " does not exist (used with " ++ 
162                              show flg ++ " option.)"))
163
164 GLOBAL_VAR(v_Object_suf,  phaseInputExt Ln, String)
165 GLOBAL_VAR(v_HC_suf,      Nothing, Maybe String)
166 GLOBAL_VAR(v_Hi_dir,      Nothing, Maybe String)
167 GLOBAL_VAR(v_Hi_suf,      "hi",    String)
168
169 GLOBAL_VAR(v_Ld_inputs, [],      [String])
170
171 odir_ify :: String -> IO String
172 odir_ify f = do
173   odir_opt <- readIORef v_Output_dir
174   case odir_opt of
175         Nothing -> return f
176         Just d  -> return (replaceFilenameDirectory f d)
177
178 osuf_ify :: String -> IO String
179 osuf_ify f = do
180   osuf <- readIORef v_Object_suf
181   return (replaceFilenameSuffix f osuf)
182
183 -----------------------------------------------------------------------------
184 -- Compiler optimisation options
185
186 GLOBAL_VAR(v_OptLevel, 0, Int)
187
188 setOptLevel :: Int -> IO ()
189 setOptLevel n = do
190   when (n >= 1) $ setLang HscC          -- turn on -fvia-C with -O
191   writeIORef v_OptLevel n
192
193 GLOBAL_VAR(v_minus_o2_for_C,            False, Bool)
194 GLOBAL_VAR(v_MaxSimplifierIterations,   4,     Int)
195 GLOBAL_VAR(v_StgStats,                  False, Bool)
196 GLOBAL_VAR(v_Strictness,                True,  Bool)
197 GLOBAL_VAR(v_CSE,                       True,  Bool)
198 GLOBAL_VAR(v_RuleCheck,                 Nothing,  Maybe String)
199
200 -- these are the static flags you get without -O.
201 hsc_minusNoO_flags =
202        [ 
203         "-fignore-interface-pragmas",
204         "-fomit-interface-pragmas",
205         "-fdo-lambda-eta-expansion",    -- This one is important for a tiresome reason:
206                                         -- we want to make sure that the bindings for data 
207                                         -- constructors are eta-expanded.  This is probably
208                                         -- a good thing anyway, but it seems fragile.
209         "-flet-no-escape"
210         ]
211
212 -- these are the static flags you get when -O is on.
213 hsc_minusO_flags =
214   [ 
215         "-fignore-asserts",
216         "-fdo-eta-reduction",
217         "-fdo-lambda-eta-expansion",
218         "-fcase-merge",
219         "-flet-to-case",
220         "-flet-no-escape"
221    ]
222
223 hsc_minusO2_flags = hsc_minusO_flags    -- for now
224
225 getStaticOptimisationFlags 0 = hsc_minusNoO_flags
226 getStaticOptimisationFlags 1 = hsc_minusO_flags
227 getStaticOptimisationFlags n = hsc_minusO2_flags
228
229 buildCoreToDo :: IO [CoreToDo]
230 buildCoreToDo = do
231    opt_level  <- readIORef v_OptLevel
232    max_iter   <- readIORef v_MaxSimplifierIterations
233    strictness <- readIORef v_Strictness
234    cse        <- readIORef v_CSE
235    rule_check <- readIORef v_RuleCheck
236
237    if opt_level == 0 then return
238       [
239         CoreDoSimplify (SimplPhase 0) [
240             MaxSimplifierIterations max_iter
241         ]
242       ]
243
244     else {- opt_level >= 1 -} return [ 
245
246         -- initial simplify: mk specialiser happy: minimum effort please
247         CoreDoSimplify SimplGently [
248                         --      Simplify "gently"
249                         -- Don't inline anything till full laziness has bitten
250                         -- In particular, inlining wrappers inhibits floating
251                         -- e.g. ...(case f x of ...)...
252                         --  ==> ...(case (case x of I# x# -> fw x#) of ...)...
253                         --  ==> ...(case x of I# x# -> case fw x# of ...)...
254                         -- and now the redex (f x) isn't floatable any more
255                         -- Similarly, don't apply any rules until after full 
256                         -- laziness.  Notably, list fusion can prevent floating.
257
258             NoCaseOfCase,
259                         -- Don't do case-of-case transformations.
260                         -- This makes full laziness work better
261             MaxSimplifierIterations max_iter
262         ],
263
264         -- Specialisation is best done before full laziness
265         -- so that overloaded functions have all their dictionary lambdas manifest
266         CoreDoSpecialising,
267
268         CoreDoFloatOutwards (FloatOutSw False False),
269         CoreDoFloatInwards,
270
271         CoreDoSimplify (SimplPhase 2) [
272                 -- Want to run with inline phase 2 after the specialiser to give
273                 -- maximum chance for fusion to work before we inline build/augment
274                 -- in phase 1.  This made a difference in 'ansi' where an 
275                 -- overloaded function wasn't inlined till too late.
276            MaxSimplifierIterations max_iter
277         ],
278         case rule_check of { Just pat -> CoreDoRuleCheck 2 pat; Nothing -> CoreDoNothing },
279
280         CoreDoSimplify (SimplPhase 1) [
281                 -- Need inline-phase2 here so that build/augment get 
282                 -- inlined.  I found that spectral/hartel/genfft lost some useful
283                 -- strictness in the function sumcode' if augment is not inlined
284                 -- before strictness analysis runs
285            MaxSimplifierIterations max_iter
286         ],
287         case rule_check of { Just pat -> CoreDoRuleCheck 1 pat; Nothing -> CoreDoNothing },
288
289         CoreDoSimplify (SimplPhase 0) [
290                 -- Phase 0: allow all Ids to be inlined now
291                 -- This gets foldr inlined before strictness analysis
292
293            MaxSimplifierIterations 3
294                 -- At least 3 iterations because otherwise we land up with
295                 -- huge dead expressions because of an infelicity in the 
296                 -- simpifier.   
297                 --      let k = BIG in foldr k z xs
298                 -- ==>  let k = BIG in letrec go = \xs -> ...(k x).... in go xs
299                 -- ==>  let k = BIG in letrec go = \xs -> ...(BIG x).... in go xs
300                 -- Don't stop now!
301
302         ],
303         case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
304
305 #ifdef OLD_STRICTNESS
306         CoreDoOldStrictness
307 #endif
308         if strictness then CoreDoStrictness else CoreDoNothing,
309         CoreDoWorkerWrapper,
310         CoreDoGlomBinds,
311
312         CoreDoSimplify (SimplPhase 0) [
313            MaxSimplifierIterations max_iter
314         ],
315
316         CoreDoFloatOutwards (FloatOutSw False   -- Not lambdas
317                                         True),  -- Float constants
318                 -- nofib/spectral/hartel/wang doubles in speed if you
319                 -- do full laziness late in the day.  It only happens
320                 -- after fusion and other stuff, so the early pass doesn't
321                 -- catch it.  For the record, the redex is 
322                 --        f_el22 (f_el21 r_midblock)
323
324
325         -- We want CSE to follow the final full-laziness pass, because it may
326         -- succeed in commoning up things floated out by full laziness.
327         -- CSE used to rely on the no-shadowing invariant, but it doesn't any more
328
329         if cse then CoreCSE else CoreDoNothing,
330
331         CoreDoFloatInwards,
332
333 -- Case-liberation for -O2.  This should be after
334 -- strictness analysis and the simplification which follows it.
335
336         case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
337
338         if opt_level >= 2 then
339            CoreLiberateCase
340         else
341            CoreDoNothing,
342         if opt_level >= 2 then
343            CoreDoSpecConstr
344         else
345            CoreDoNothing,
346
347         -- Final clean-up simplification:
348         CoreDoSimplify (SimplPhase 0) [
349           MaxSimplifierIterations max_iter
350         ]
351      ]
352
353 buildStgToDo :: IO [ StgToDo ]
354 buildStgToDo = do
355   stg_stats <- readIORef v_StgStats
356   let flags1 | stg_stats = [ D_stg_stats ]
357              | otherwise = [ ]
358
359         -- STG passes
360   ways_ <- readIORef v_Ways
361   let flags2 | WayProf `elem` ways_ = StgDoMassageForProfiling : flags1
362              | otherwise            = flags1
363
364   return flags2
365
366 -----------------------------------------------------------------------------
367 -- Paths & Libraries
368
369 split_marker = ':'   -- not configurable (ToDo)
370
371 v_Import_paths, v_Include_paths, v_Library_paths :: IORef [String]
372 GLOBAL_VAR(v_Import_paths,  ["."], [String])
373 GLOBAL_VAR(v_Include_paths, ["."], [String])
374 GLOBAL_VAR(v_Library_paths, [],  [String])
375
376 #ifdef darwin_TARGET_OS
377 GLOBAL_VAR(v_Framework_paths, [], [String])
378 GLOBAL_VAR(v_Cmdline_frameworks, [], [String])
379 #endif
380
381 addToDirList :: IORef [String] -> String -> IO ()
382 addToDirList ref path
383   = do paths           <- readIORef ref
384        shiny_new_ones  <- splitUp path
385        writeIORef ref (paths ++ filter notNull shiny_new_ones)
386                 -- empty paths are ignored: there might be a trailing
387                 -- ':' in the initial list, for example.  Empty paths can
388                 -- cause confusion when they are translated into -I options
389                 -- for passing to gcc.
390   where
391     splitUp ::String -> IO [String]
392 #ifdef mingw32_TARGET_OS
393      -- 'hybrid' support for DOS-style paths in directory lists.
394      -- 
395      -- That is, if "foo:bar:baz" is used, this interpreted as
396      -- consisting of three entries, 'foo', 'bar', 'baz'.
397      -- However, with "c:/foo:c:\\foo;x:/bar", this is interpreted
398      -- as four elts, "c:/foo", "c:\\foo", "x", and "/bar" --
399      -- *provided* c:/foo exists and x:/bar doesn't.
400      --
401      -- Notice that no attempt is made to fully replace the 'standard'
402      -- split marker ':' with the Windows / DOS one, ';'. The reason being
403      -- that this will cause too much breakage for users & ':' will
404      -- work fine even with DOS paths, if you're not insisting on being silly.
405      -- So, use either.
406     splitUp []         = return []
407     splitUp (x:':':div:xs) 
408       | div `elem` dir_markers = do
409           let (p,rs) = findNextPath xs
410           ps  <- splitUp rs
411            {-
412              Consult the file system to check the interpretation
413              of (x:':':div:p) -- this is arguably excessive, we
414              could skip this test & just say that it is a valid
415              dir path.
416            -}
417           flg <- doesDirectoryExist (x:':':div:p)
418           if flg then
419              return ((x:':':div:p):ps)
420            else
421              return ([x]:(div:p):ps)
422     splitUp xs = do
423       let (p,rs) = findNextPath xs
424       ps <- splitUp rs
425       return (cons p ps)
426     
427     cons "" xs = xs
428     cons x  xs = x:xs
429
430     -- will be called either when we've consumed nought or the "<Drive>:/" part of
431     -- a DOS path, so splitting is just a Q of finding the next split marker.
432     findNextPath xs = 
433         case break (`elem` split_markers) xs of
434            (p, d:ds) -> (p, ds)
435            (p, xs)   -> (p, xs)
436
437     split_markers :: [Char]
438     split_markers = [':', ';']
439
440     dir_markers :: [Char]
441     dir_markers = ['/', '\\']
442
443 #else
444     splitUp xs = return (split split_marker xs)
445 #endif
446
447 -- ----------------------------------------------------------------------------
448 -- Loading the package config file
449
450 readPackageConf :: String -> IO ()
451 readPackageConf conf_file = do
452   proto_pkg_configs <- loadPackageConfig conf_file
453   top_dir           <- getTopDir
454   let pkg_configs = mungePackagePaths top_dir proto_pkg_configs
455   extendPackageConfigMap pkg_configs
456
457 mungePackagePaths :: String -> [PackageConfig] -> [PackageConfig]
458 -- Replace the string "$libdir" at the beginning of a path
459 -- with the current libdir (obtained from the -B option).
460 mungePackagePaths top_dir ps = map munge_pkg ps
461  where 
462   munge_pkg p = p{ import_dirs  = munge_paths (import_dirs p),
463                    include_dirs = munge_paths (include_dirs p),
464                    library_dirs = munge_paths (library_dirs p),
465                    framework_dirs = munge_paths (framework_dirs p) }
466
467   munge_paths = map munge_path
468
469   munge_path p 
470           | Just p' <- my_prefix_match "$libdir" p = top_dir ++ p'
471           | otherwise                              = p
472
473
474 -- -----------------------------------------------------------------------------
475 -- The list of packages requested on the command line
476
477 -- The package list reflects what packages were given as command-line options,
478 -- plus their dependent packages.  It is maintained in dependency order;
479 -- earlier packages may depend on later ones, but not vice versa
480 GLOBAL_VAR(v_ExplicitPackages, initPackageList, [PackageName])
481
482 initPackageList = [basePackage, rtsPackage]
483         -- basePackage is part of this list entirely because of 
484         -- wired-in names in GHCi.  See the notes on wired-in names in
485         -- Linker.linkExpr.  By putting the base backage in initPackageList
486         -- we make sure that it'll always by linked.
487
488
489 -- add a package requested from the command-line
490 addPackage :: String -> IO ()
491 addPackage package = do
492   pkg_details <- getPackageConfigMap
493   ps  <- readIORef v_ExplicitPackages
494   ps' <- add_package pkg_details ps (mkPackageName package)
495                 -- Throws an exception if it fails
496   writeIORef v_ExplicitPackages ps'
497
498 -- internal helper
499 add_package :: PackageConfigMap -> [PackageName]
500             -> PackageName -> IO [PackageName]
501 add_package pkg_details ps p    
502   | p `elem` ps -- Check if we've already added this package
503   = return ps
504   | Just details <- lookupPkg pkg_details p
505   -- Add the package's dependents also
506   = do ps' <- foldM (add_package pkg_details) ps (packageDependents details)
507        return (p : ps')
508   | otherwise
509   = throwDyn (CmdLineError ("unknown package name: " ++ packageNameString p))
510
511
512 -- -----------------------------------------------------------------------------
513 -- Extracting information from the packages in scope
514
515 -- Many of these functions take a list of packages: in those cases,
516 -- the list is expected to contain the "dependent packages",
517 -- i.e. those packages that were found to be depended on by the
518 -- current module/program.  These can be auto or non-auto packages, it
519 -- doesn't really matter.  The list is always combined with the list
520 -- of explicit (command-line) packages to determine which packages to
521 -- use.
522
523 getPackageImportPath :: IO [String]
524 getPackageImportPath = do
525   ps <- getExplicitAndAutoPackageConfigs
526                   -- import dirs are always derived from the 'auto' 
527                   -- packages as well as the explicit ones
528   return (nub (filter notNull (concatMap import_dirs ps)))
529
530 getPackageIncludePath :: [PackageName] -> IO [String]
531 getPackageIncludePath pkgs = do
532   ps <- getExplicitPackagesAnd pkgs
533   return (nub (filter notNull (concatMap include_dirs ps)))
534
535         -- includes are in reverse dependency order (i.e. rts first)
536 getPackageCIncludes :: [PackageConfig] -> IO [String]
537 getPackageCIncludes pkg_configs = do
538   return (reverse (nub (filter notNull (concatMap c_includes pkg_configs))))
539
540 getPackageLibraryPath :: [PackageName] -> IO [String]
541 getPackageLibraryPath pkgs = do 
542   ps <- getExplicitPackagesAnd pkgs
543   return (nub (filter notNull (concatMap library_dirs ps)))
544
545 getPackageLinkOpts :: [PackageName] -> IO [String]
546 getPackageLinkOpts pkgs = do
547   ps <- getExplicitPackagesAnd pkgs
548   tag <- readIORef v_Build_tag
549   static <- readIORef v_Static
550   let 
551         imp        = if static then "" else "_imp"
552         suffix     = if null tag then "" else '_':tag
553         libs p     = map (++suffix) (hACK (hs_libraries p)) ++ extra_libraries p
554         imp_libs p = map (++imp) (libs p)
555         all_opts p = map ("-l" ++) (imp_libs p) ++ extra_ld_opts p
556
557   return (concat (map all_opts ps))
558   where
559      -- This is a totally horrible (temporary) hack, for Win32.  Problem is
560      -- that package.conf for Win32 says that the main prelude lib is 
561      -- split into HSbase1, HSbase2 and HSbase3, which is needed due to a bug
562      -- in the GNU linker (PEi386 backend). However, we still only
563      -- have HSbase.a for static linking, not HSbase{1,2,3}.a
564      -- getPackageLibraries is called to find the .a's to add to the static
565      -- link line.  On Win32, this hACK detects HSbase{1,2,3} and 
566      -- replaces them with HSbase, so static linking still works.
567      -- Libraries needed for dynamic (GHCi) linking are discovered via
568      -- different route (in InteractiveUI.linkPackage).
569      -- See driver/PackageSrc.hs for the HSbase1/HSbase2 split definition.
570      -- THIS IS A STRICTLY TEMPORARY HACK (famous last words ...)
571      -- JRS 04 Sept 01: Same appalling hack for HSwin32[1,2]
572      -- KAA 29 Mar  02: Same appalling hack for HSobjectio[1,2,3,4]
573      hACK libs
574 #      if !defined(mingw32_TARGET_OS) && !defined(cygwin32_TARGET_OS)
575        = libs
576 #      else
577        = if   "HSbase1" `elem` libs && "HSbase2" `elem` libs && "HSbase3" `elem` libs
578          then "HSbase" : filter (not.(isPrefixOf "HSbase")) libs
579          else
580          if   "HSwin321" `elem` libs && "HSwin322" `elem` libs
581          then "HSwin32" : filter (not.(isPrefixOf "HSwin32")) libs
582          else 
583          if   "HSobjectio1" `elem` libs && "HSobjectio2" `elem` libs && "HSobjectio3" `elem` libs && "HSobjectio4" `elem` libs
584          then "HSobjectio" : filter (not.(isPrefixOf "HSobjectio")) libs
585          else 
586          libs
587 #      endif
588
589 getPackageExtraGhcOpts :: IO [String]
590 getPackageExtraGhcOpts = do
591   ps <- getExplicitAndAutoPackageConfigs
592   return (concatMap extra_ghc_opts ps)
593
594 getPackageExtraCcOpts :: [PackageName] -> IO [String]
595 getPackageExtraCcOpts pkgs = do
596   ps <- getExplicitPackagesAnd pkgs
597   return (concatMap extra_cc_opts ps)
598
599 #ifdef darwin_TARGET_OS
600 getPackageFrameworkPath  :: [PackageName] -> IO [String]
601 getPackageFrameworkPath pkgs = do
602   ps <- getExplicitPackagesAnd pkgs
603   return (nub (filter notNull (concatMap framework_dirs ps)))
604
605 getPackageFrameworks  :: [PackageName] -> IO [String]
606 getPackageFrameworks pkgs = do
607   ps <- getExplicitPackagesAnd pkgs
608   return (concatMap extra_frameworks ps)
609 #endif
610
611 -- -----------------------------------------------------------------------------
612 -- Package Utils
613
614 getExplicitPackagesAnd :: [PackageName] -> IO [PackageConfig]
615 getExplicitPackagesAnd pkg_names = do
616   pkg_map <- getPackageConfigMap
617   expl <- readIORef v_ExplicitPackages
618   all_pkgs <- foldM (add_package pkg_map) expl pkg_names
619   getPackageDetails all_pkgs
620
621 -- return all packages, including both the auto packages and the explicit ones
622 getExplicitAndAutoPackageConfigs :: IO [PackageConfig]
623 getExplicitAndAutoPackageConfigs = do
624   pkg_map <- getPackageConfigMap
625   let auto_packages = [ mkPackageName (name p) | p <- eltsUFM pkg_map, auto p ]
626   getExplicitPackagesAnd auto_packages
627
628 -----------------------------------------------------------------------------
629 -- Ways
630
631 -- The central concept of a "way" is that all objects in a given
632 -- program must be compiled in the same "way".  Certain options change
633 -- parameters of the virtual machine, eg. profiling adds an extra word
634 -- to the object header, so profiling objects cannot be linked with
635 -- non-profiling objects.
636
637 -- After parsing the command-line options, we determine which "way" we
638 -- are building - this might be a combination way, eg. profiling+ticky-ticky.
639
640 -- We then find the "build-tag" associated with this way, and this
641 -- becomes the suffix used to find .hi files and libraries used in
642 -- this compilation.
643
644 GLOBAL_VAR(v_Build_tag, "", String)
645
646 data WayName
647   = WayProf
648   | WayUnreg
649   | WayTicky
650   | WayPar
651   | WayGran
652   | WaySMP
653   | WayNDP
654   | WayDebug
655   | WayUser_a
656   | WayUser_b
657   | WayUser_c
658   | WayUser_d
659   | WayUser_e
660   | WayUser_f
661   | WayUser_g
662   | WayUser_h
663   | WayUser_i
664   | WayUser_j
665   | WayUser_k
666   | WayUser_l
667   | WayUser_m
668   | WayUser_n
669   | WayUser_o
670   | WayUser_A
671   | WayUser_B
672   deriving (Eq,Ord)
673
674 GLOBAL_VAR(v_Ways, [] ,[WayName])
675
676 allowed_combination way = way `elem` combs
677   where  -- the sub-lists must be ordered according to WayName, 
678          -- because findBuildTag sorts them
679     combs                = [ [WayProf, WayUnreg], 
680                              [WayProf, WaySMP]  ,
681                              [WayProf, WayNDP]  ]
682
683 findBuildTag :: IO [String]  -- new options
684 findBuildTag = do
685   way_names <- readIORef v_Ways
686   case sort way_names of
687      []  -> do  -- writeIORef v_Build_tag ""
688                 return []
689
690      [w] -> do let details = lkupWay w
691                writeIORef v_Build_tag (wayTag details)
692                return (wayOpts details)
693
694      ws  -> if not (allowed_combination ws)
695                 then throwDyn (CmdLineError $
696                                 "combination not supported: "  ++
697                                 foldr1 (\a b -> a ++ '/':b) 
698                                 (map (wayName . lkupWay) ws))
699                 else let stuff = map lkupWay ws
700                          tag   = concat (map wayTag stuff)
701                          flags = map wayOpts stuff
702                      in do
703                      writeIORef v_Build_tag tag
704                      return (concat flags)
705
706 lkupWay w = 
707    case lookup w way_details of
708         Nothing -> error "findBuildTag"
709         Just details -> details
710
711 data Way = Way {
712   wayTag   :: String,
713   wayName  :: String,
714   wayOpts  :: [String]
715   }
716
717 way_details :: [ (WayName, Way) ]
718 way_details =
719   [ (WayProf, Way  "p" "Profiling"  
720         [ "-fscc-profiling"
721         , "-DPROFILING"
722         , "-optc-DPROFILING"
723         , "-fvia-C" ]),
724
725     (WayTicky, Way  "t" "Ticky-ticky Profiling"  
726         [ "-fticky-ticky"
727         , "-DTICKY_TICKY"
728         , "-optc-DTICKY_TICKY"
729         , "-fvia-C" ]),
730
731     (WayUnreg, Way  "u" "Unregisterised" 
732         unregFlags ),
733
734     -- optl's below to tell linker where to find the PVM library -- HWL
735     (WayPar, Way  "mp" "Parallel" 
736         [ "-fparallel"
737         , "-D__PARALLEL_HASKELL__"
738         , "-optc-DPAR"
739         , "-package concurrent"
740         , "-optc-w"
741         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
742         , "-optl-lpvm3"
743         , "-optl-lgpvm3"
744         , "-fvia-C" ]),
745
746     -- at the moment we only change the RTS and could share compiler and libs!
747     (WayPar, Way  "mt" "Parallel ticky profiling" 
748         [ "-fparallel"
749         , "-D__PARALLEL_HASKELL__"
750         , "-optc-DPAR"
751         , "-optc-DPAR_TICKY"
752         , "-package concurrent"
753         , "-optc-w"
754         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
755         , "-optl-lpvm3"
756         , "-optl-lgpvm3"
757         , "-fvia-C" ]),
758
759     (WayPar, Way  "md" "Distributed" 
760         [ "-fparallel"
761         , "-D__PARALLEL_HASKELL__"
762         , "-D__DISTRIBUTED_HASKELL__"
763         , "-optc-DPAR"
764         , "-optc-DDIST"
765         , "-package concurrent"
766         , "-optc-w"
767         , "-optl-L${PVM_ROOT}/lib/${PVM_ARCH}"
768         , "-optl-lpvm3"
769         , "-optl-lgpvm3"
770         , "-fvia-C" ]),
771
772     (WayGran, Way  "mg" "GranSim" 
773         [ "-fgransim"
774         , "-D__GRANSIM__"
775         , "-optc-DGRAN"
776         , "-package concurrent"
777         , "-fvia-C" ]),
778
779     (WaySMP, Way  "s" "SMP"
780         [ "-fsmp"
781         , "-optc-pthread"
782 #ifndef freebsd_TARGET_OS
783         , "-optl-pthread"
784 #endif
785         , "-optc-DSMP"
786         , "-fvia-C" ]),
787
788     (WayNDP, Way  "ndp" "Nested data parallelism"
789         [ "-fparr"
790         , "-fflatten"]),
791
792     (WayUser_a,  Way  "a"  "User way 'a'"  ["$WAY_a_REAL_OPTS"]),       
793     (WayUser_b,  Way  "b"  "User way 'b'"  ["$WAY_b_REAL_OPTS"]),       
794     (WayUser_c,  Way  "c"  "User way 'c'"  ["$WAY_c_REAL_OPTS"]),       
795     (WayUser_d,  Way  "d"  "User way 'd'"  ["$WAY_d_REAL_OPTS"]),       
796     (WayUser_e,  Way  "e"  "User way 'e'"  ["$WAY_e_REAL_OPTS"]),       
797     (WayUser_f,  Way  "f"  "User way 'f'"  ["$WAY_f_REAL_OPTS"]),       
798     (WayUser_g,  Way  "g"  "User way 'g'"  ["$WAY_g_REAL_OPTS"]),       
799     (WayUser_h,  Way  "h"  "User way 'h'"  ["$WAY_h_REAL_OPTS"]),       
800     (WayUser_i,  Way  "i"  "User way 'i'"  ["$WAY_i_REAL_OPTS"]),       
801     (WayUser_j,  Way  "j"  "User way 'j'"  ["$WAY_j_REAL_OPTS"]),       
802     (WayUser_k,  Way  "k"  "User way 'k'"  ["$WAY_k_REAL_OPTS"]),       
803     (WayUser_l,  Way  "l"  "User way 'l'"  ["$WAY_l_REAL_OPTS"]),       
804     (WayUser_m,  Way  "m"  "User way 'm'"  ["$WAY_m_REAL_OPTS"]),       
805     (WayUser_n,  Way  "n"  "User way 'n'"  ["$WAY_n_REAL_OPTS"]),       
806     (WayUser_o,  Way  "o"  "User way 'o'"  ["$WAY_o_REAL_OPTS"]),       
807     (WayUser_A,  Way  "A"  "User way 'A'"  ["$WAY_A_REAL_OPTS"]),       
808     (WayUser_B,  Way  "B"  "User way 'B'"  ["$WAY_B_REAL_OPTS"]) 
809   ]
810
811 unregFlags = 
812    [ "-optc-DNO_REGS"
813    , "-optc-DUSE_MINIINTERPRETER"
814    , "-fno-asm-mangling"
815    , "-funregisterised"
816    , "-fvia-C" ]
817
818 -----------------------------------------------------------------------------
819 -- Options for particular phases
820
821 GLOBAL_VAR(v_Opt_dep,    [], [String])
822 GLOBAL_VAR(v_Anti_opt_C, [], [String])
823 GLOBAL_VAR(v_Opt_C,      [], [String])
824 GLOBAL_VAR(v_Opt_l,      [], [String])
825 GLOBAL_VAR(v_Opt_dll,    [], [String])
826
827 getStaticOpts :: IORef [String] -> IO [String]
828 getStaticOpts ref = readIORef ref >>= return . reverse