1 -----------------------------------------------------------------------------
2 -- Access to system tools: gcc, cp, rm etc
4 -- (c) The University of Glasgow 2000
6 -----------------------------------------------------------------------------
12 setPgm, -- String -> IO ()
13 -- Command-line override
16 packageConfigPath, -- IO String
17 -- Where package.conf is
19 -- Interface to system tools
20 runUnlit, runCpp, runCc, -- [String] -> IO ()
21 runMangle, runSplit, -- [String] -> IO ()
22 runAs, runLink, -- [String] -> IO ()
25 touch, -- String -> String -> IO ()
26 copy, -- String -> String -> String -> IO ()
27 unDosifyPath, -- String -> String
29 -- Temporary-file management
32 cleanTempFiles, cleanTempFilesExcept, removeTmpFiles,
36 getProcessID, -- IO Int
37 system, -- String -> IO Int
40 showGhcUsage, -- IO () Shows usage message and exits
41 getSysMan -- IO String Parallel system only
48 import Panic ( progName, GhcException(..) )
49 import Util ( global )
50 import CmdLineOpts ( dynFlag, verbosity )
52 import Exception ( throwDyn, catchAllIO )
54 import Directory ( doesFileExist, removeFile )
55 import IOExts ( IORef, readIORef, writeIORef )
56 import Monad ( when, unless )
57 import System ( system, ExitCode(..), exitWith, getEnv )
59 #include "../includes/config.h"
61 #if !defined(mingw32_TARGET_OS)
62 import qualified Posix
65 import List ( isPrefixOf, isSuffixOf )
68 #include "HsVersions.h"
73 The configuration story
74 ~~~~~~~~~~~~~~~~~~~~~~~
76 GHC needs various support files (library packages, RTS etc), plus
77 various auxiliary programs (cp, gcc, etc). It finds these in one
80 * When running as an *installed program*, GHC finds most of this support
81 stuff in the installed library tree. The path to this tree is passed
82 to GHC via the -B flag, and given to initSysTools .
84 * When running *in-place* in a build tree, GHC finds most of this support
85 stuff in the build tree. The path to the build tree is, again passed
88 GHC tells which of the two is the case by seeing whether package.conf
89 is in TopDir [installed] or in TopDir/ghc/driver [inplace] (what a hack).
92 SysTools.initSysProgs figures out exactly where all the auxiliary programs
93 are, and initialises mutable variables to make it easy to call them.
94 To to this, it makes use of definitions in Config.hs, which is a Haskell
95 file containing variables whose value is figured out by the build system.
97 Config.hs contains two sorts of things
99 cGCC, The *names* of the programs
102 etc They do *not* include paths
105 cUNLIT_DIR The *path* to the directory containing unlit, split etc
106 cSPLIT_DIR *relative* to the root of the build tree,
107 for use when running *in-place* in a build tree (only)
111 ---------------------------------------------
112 NOTES for an ALTERNATIVE scheme (i.e *not* what is currently implemented):
114 Another hair-brained scheme for simplifying the current tool location
115 nightmare in GHC: Simon originally suggested using another
116 configuration file along the lines of GCC's specs file - which is fine
117 except that it means adding code to read yet another configuration
118 file. What I didn't notice is that the current package.conf is
119 general enough to do this:
122 {name = "tools", import_dirs = [], source_dirs = [],
123 library_dirs = [], hs_libraries = [], extra_libraries = [],
124 include_dirs = [], c_includes = [], package_deps = [],
125 extra_ghc_opts = ["-pgmc/usr/bin/gcc","-pgml${libdir}/bin/unlit", ... etc.],
126 extra_cc_opts = [], extra_ld_opts = []}
128 Which would have the advantage that we get to collect together in one
129 place the path-specific package stuff with the path-specific tool
132 ---------------------------------------------
135 %************************************************************************
137 \subsection{Global variables to contain system programs}
139 %************************************************************************
141 All these pathnames are maintained IN THE NATIVE FORMAT OF THE HOST MACHINE.
142 (See remarks under pathnames below)
145 GLOBAL_VAR(v_Pgm_L, error "pgm_L", String) -- unlit
146 GLOBAL_VAR(v_Pgm_P, error "pgm_P", String) -- cpp
147 GLOBAL_VAR(v_Pgm_c, error "pgm_c", String) -- gcc
148 GLOBAL_VAR(v_Pgm_m, error "pgm_m", String) -- asm code mangler
149 GLOBAL_VAR(v_Pgm_s, error "pgm_s", String) -- asm code splitter
150 GLOBAL_VAR(v_Pgm_a, error "pgm_a", String) -- as
151 GLOBAL_VAR(v_Pgm_l, error "pgm_l", String) -- ld
152 GLOBAL_VAR(v_Pgm_MkDLL, error "pgm_dll", String) -- mkdll
154 GLOBAL_VAR(v_Pgm_T, error "pgm_T", String) -- touch
155 GLOBAL_VAR(v_Pgm_CP, error "pgm_CP", String) -- cp
157 GLOBAL_VAR(v_Path_package_config, error "path_package_config", String)
158 GLOBAL_VAR(v_Path_usage, error "ghc_usage.txt", String)
160 -- Parallel system only
161 GLOBAL_VAR(v_Pgm_sysman, error "pgm_sysman", String) -- system manager
165 %************************************************************************
167 \subsection{Initialisation}
169 %************************************************************************
172 initSysTools :: [String] -- Command-line arguments starting "-B"
174 -> IO String -- Set all the mutable variables above, holding
175 -- (a) the system programs
176 -- (b) the package-config file
177 -- (c) the GHC usage message
181 initSysTools minusB_args
182 = do { (am_installed, top_dir) <- getTopDir minusB_args
184 -- for "installed" this is the root of GHC's support files
185 -- for "in-place" it is the root of the build tree
186 -- NB: top_dir is assumed to be in standard Unix format '/' separated
188 ; let installed, installed_bin :: FilePath -> FilePath
189 installed_bin pgm = pgmPath (top_dir `slash` "extra-bin") pgm
190 installed file = pgmPath top_dir file
191 inplace dir pgm = pgmPath (top_dir `slash` dir) pgm
194 | am_installed = installed "package.conf"
195 | otherwise = inplace cGHC_DRIVER_DIR "package.conf.inplace"
198 | am_installed = installed "ghc-usage.txt"
199 | otherwise = inplace cGHC_DRIVER_DIR "ghc-usage.txt"
201 -- For all systems, unlit, split, mangle are GHC utilities
202 -- architecture-specific stuff is done when building Config.hs
204 | am_installed = installed_bin cGHC_UNLIT
205 | otherwise = inplace cGHC_UNLIT_DIR cGHC_UNLIT
207 -- split and mangle are Perl scripts
209 | am_installed = installed_bin cGHC_SPLIT
210 | otherwise = inplace cGHC_SPLIT_DIR cGHC_SPLIT
213 | am_installed = installed_bin cGHC_MANGLER
214 | otherwise = inplace cGHC_MANGLER_DIR cGHC_MANGLER
216 #ifndef mingw32_TARGET_OS
217 -- check whether TMPDIR is set in the environment
218 ; IO.try (do dir <- getEnv "TMPDIR" -- fails if not set
224 -- Check that the package config exists
225 ; config_exists <- doesFileExist pkgconfig_path
226 ; when (not config_exists) $
227 throwDyn (InstallationError
228 ("Can't find package.conf as " ++ pkgconfig_path))
230 #if defined(mingw32_TARGET_OS)
231 -- WINDOWS-SPECIFIC STUFF
232 -- On Windows, gcc and friends are distributed with GHC,
233 -- so when "installed" we look in TopDir/bin
234 -- When "in-place" we look wherever the build-time configure
236 -- When "install" we tell gcc where its specs file + exes are (-B)
237 -- and also some places to pick up include files. We need
238 -- to be careful to put all necessary exes in the -B place
239 -- (as, ld, cc1, etc) since if they don't get found there, gcc
240 -- then tries to run unadorned "as", "ld", etc, and will
241 -- pick up whatever happens to be lying around in the path,
242 -- possibly including those from a cygwin install on the target,
243 -- which is exactly what we're trying to avoid.
244 ; let gcc_path | am_installed = installed_bin ("gcc -B\"" ++ installed "gcc-lib\\\"")
246 -- The trailing "\\" is absolutely essential; gcc seems
247 -- to construct file names simply by concatenating to this
248 -- -B path with no extra slash.
249 -- We use "\\" rather than "/" because gcc_path is in NATIVE format
250 -- (see comments with declarations of global variables)
252 -- The quotes round the -B argument are in case TopDir has spaces in it
254 perl_path | am_installed = installed_bin cGHC_PERL
255 | otherwise = cGHC_PERL
257 -- 'touch' is a GHC util for Windows, and similarly unlit, mangle
258 ; let touch_path | am_installed = installed_bin cGHC_TOUCHY
259 | otherwise = inplace cGHC_TOUCHY_DIR cGHC_TOUCHY
261 -- On Win32 we don't want to rely on #!/bin/perl, so we prepend
262 -- a call to Perl to get the invocation of split and mangle
263 ; let split_path = perl_path ++ " " ++ split_script
264 mangle_path = perl_path ++ " " ++ mangle_script
266 ; let mkdll_path = cMKDLL
268 -- UNIX-SPECIFIC STUFF
269 -- On Unix, the "standard" tools are assumed to be
270 -- in the same place whether we are running "in-place" or "installed"
271 -- That place is wherever the build-time configure script found them.
272 ; let gcc_path = cGCC
273 touch_path = cGHC_TOUCHY
274 mkdll_path = panic "Can't build DLLs on a non-Win32 system"
276 -- On Unix, scripts are invoked using the '#!' method. Binary
277 -- installations of GHC on Unix place the correct line on the front
278 -- of the script at installation time, so we don't want to wire-in
279 -- our knowledge of $(PERL) on the host system here.
280 ; let split_path = split_script
281 mangle_path = mangle_script
284 -- cpp is derived from gcc on all platforms
285 ; let cpp_path = gcc_path ++ " -E " ++ cRAWCPP_FLAGS
287 -- For all systems, copy and remove are provided by the host
288 -- system; architecture-specific stuff is done when building Config.hs
289 ; let cp_path = cGHC_CP
291 -- Other things being equal, as and ld are simply gcc
292 ; let as_path = gcc_path
296 -- Initialise the global vars
297 ; writeIORef v_Path_package_config pkgconfig_path
298 ; writeIORef v_Path_usage ghc_usage_msg_path
300 ; writeIORef v_Pgm_sysman (top_dir ++ "/ghc/rts/parallel/SysMan")
301 -- Hans: this isn't right in general, but you can
302 -- elaborate it in the same way as the others
304 ; writeIORef v_Pgm_L unlit_path
305 ; writeIORef v_Pgm_P cpp_path
306 ; writeIORef v_Pgm_c gcc_path
307 ; writeIORef v_Pgm_m mangle_path
308 ; writeIORef v_Pgm_s split_path
309 ; writeIORef v_Pgm_a as_path
310 ; writeIORef v_Pgm_l ld_path
311 ; writeIORef v_Pgm_MkDLL mkdll_path
312 ; writeIORef v_Pgm_T touch_path
313 ; writeIORef v_Pgm_CP cp_path
319 setPgm is called when a command-line option like
321 is used to override a particular program with a new onw
324 setPgm :: String -> IO ()
325 -- The string is the flag, minus the '-pgm' prefix
326 -- So the first character says which program to override
328 setPgm ('P' : pgm) = writeIORef v_Pgm_P pgm
329 setPgm ('c' : pgm) = writeIORef v_Pgm_c pgm
330 setPgm ('m' : pgm) = writeIORef v_Pgm_m pgm
331 setPgm ('s' : pgm) = writeIORef v_Pgm_s pgm
332 setPgm ('a' : pgm) = writeIORef v_Pgm_a pgm
333 setPgm ('l' : pgm) = writeIORef v_Pgm_l pgm
334 setPgm pgm = unknownFlagErr ("-pgm" ++ pgm)
340 -- for "installed" this is the root of GHC's support files
341 -- for "in-place" it is the root of the build tree
344 -- 1. Set proto_top_dir
345 -- a) look for (the last) -B flag, and use it
346 -- b) if there are no -B flags, get the directory
347 -- where GHC is running (only on Windows)
349 -- 2. If package.conf exists in proto_top_dir, we are running
350 -- installed; and TopDir = proto_top_dir
352 -- 3. Otherwise we are running in-place, so
353 -- proto_top_dir will be /...stuff.../ghc/compiler
354 -- Set TopDir to /...stuff..., which is the root of the build tree
356 -- This is very gruesome indeed
358 getTopDir :: [String]
359 -> IO (Bool, -- True <=> am installed, False <=> in-place
360 String) -- TopDir (in Unix format '/' separated)
363 = do { top_dir <- get_proto
364 -- Discover whether we're running in a build tree or in an installation,
365 -- by looking for the package configuration file.
366 ; am_installed <- doesFileExist (top_dir `slash` "package.conf")
368 ; return (am_installed, top_dir)
371 -- get_proto returns a Unix-format path (relying on getExecDir to do so too)
372 get_proto | not (null minusbs)
373 = return (unDosifyPath (drop 2 (last minusbs))) -- 2 for "-B"
375 = do { maybe_exec_dir <- getExecDir -- Get directory of executable
376 ; case maybe_exec_dir of -- (only works on Windows;
377 -- returns Nothing on Unix)
378 Nothing -> throwDyn (InstallationError "missing -B<dir> option")
379 Just dir -> return dir
384 %************************************************************************
386 \subsection{Running an external program}
388 %************************************************************************
392 runUnlit :: [String] -> IO ()
393 runUnlit args = do p <- readIORef v_Pgm_L
394 runSomething "Literate pre-processor" p args
396 runCpp :: [String] -> IO ()
397 runCpp args = do p <- readIORef v_Pgm_P
398 runSomething "C pre-processor" p args
400 runCc :: [String] -> IO ()
401 runCc args = do p <- readIORef v_Pgm_c
402 runSomething "C Compiler" p args
404 runMangle :: [String] -> IO ()
405 runMangle args = do p <- readIORef v_Pgm_m
406 runSomething "Mangler" p args
408 runSplit :: [String] -> IO ()
409 runSplit args = do p <- readIORef v_Pgm_s
410 runSomething "Splitter" p args
412 runAs :: [String] -> IO ()
413 runAs args = do p <- readIORef v_Pgm_a
414 runSomething "Assembler" p args
416 runLink :: [String] -> IO ()
417 runLink args = do p <- readIORef v_Pgm_l
418 runSomething "Linker" p args
420 runMkDLL :: [String] -> IO ()
421 runMkDLL args = do p <- readIORef v_Pgm_MkDLL
422 runSomething "Make DLL" p args
424 touch :: String -> String -> IO ()
425 touch purpose arg = do p <- readIORef v_Pgm_T
426 runSomething purpose p [arg]
428 copy :: String -> String -> String -> IO ()
429 copy purpose from to = do
430 verb <- dynFlag verbosity
431 when (verb >= 2) $ hPutStrLn stderr ("*** " ++ purpose)
433 h <- openFile to WriteMode
434 ls <- readFile from -- inefficient, but it'll do for now.
435 -- ToDo: speed up via slurping.
441 getSysMan :: IO String -- How to invoke the system manager
442 -- (parallel system only)
443 getSysMan = readIORef v_Pgm_sysman
446 %************************************************************************
448 \subsection{GHC Usage message}
450 %************************************************************************
452 Show the usage message and exit
455 showGhcUsage = do { usage_path <- readIORef v_Path_usage
456 ; usage <- readFile usage_path
458 ; exitWith ExitSuccess }
461 dump ('$':'$':s) = hPutStr stderr progName >> dump s
462 dump (c:s) = hPutChar stderr c >> dump s
464 packageConfigPath = readIORef v_Path_package_config
468 %************************************************************************
470 \subsection{Managing temporary files
472 %************************************************************************
475 GLOBAL_VAR(v_FilesToClean, [], [String] )
476 GLOBAL_VAR(v_TmpDir, cDEFAULT_TMPDIR, String )
477 -- v_TmpDir has no closing '/'
481 setTmpDir dir = writeIORef v_TmpDir dir
483 cleanTempFiles :: Int -> IO ()
484 cleanTempFiles verb = do fs <- readIORef v_FilesToClean
485 removeTmpFiles verb fs
487 cleanTempFilesExcept :: Int -> [FilePath] -> IO ()
488 cleanTempFilesExcept verb dont_delete
489 = do fs <- readIORef v_FilesToClean
490 let leftovers = filter (`notElem` dont_delete) fs
491 removeTmpFiles verb leftovers
492 writeIORef v_FilesToClean dont_delete
495 -- find a temporary name that doesn't already exist.
496 newTempName :: Suffix -> IO FilePath
498 = do x <- getProcessID
499 tmp_dir <- readIORef v_TmpDir
500 findTempName tmp_dir x
502 findTempName tmp_dir x
503 = do let filename = tmp_dir ++ "/ghc" ++ show x ++ '.':extn
504 b <- doesFileExist filename
505 if b then findTempName tmp_dir (x+1)
506 else do add v_FilesToClean filename -- clean it up later
509 addFilesToClean :: [FilePath] -> IO ()
510 -- May include wildcards [used by DriverPipeline.run_phase SplitMangle]
511 addFilesToClean files = mapM_ (add v_FilesToClean) files
513 removeTmpFiles :: Int -> [FilePath] -> IO ()
514 removeTmpFiles verb fs
515 = traceCmd "Deleting temp files"
516 ("Deleting: " ++ unwords fs)
519 rm f = removeFile f `catchAllIO`
522 hPutStrLn stderr ("Warning: deleting non-existent " ++ f)
528 %************************************************************************
530 \subsection{Running a program}
532 %************************************************************************
535 GLOBAL_VAR(v_Dry_run, False, Bool)
538 setDryRun = writeIORef v_Dry_run True
540 -----------------------------------------------------------------------------
541 -- Running an external program
543 runSomething :: String -- For -v message
544 -> String -- Command name (possibly a full path)
545 -- assumed already dos-ified
546 -> [String] -- Arguments
547 -- runSomething will dos-ify them
550 runSomething phase_name pgm args
551 = traceCmd phase_name cmd_line $
552 do { exit_code <- system cmd_line
553 ; if exit_code /= ExitSuccess
554 then throwDyn (PhaseFailed phase_name exit_code)
558 cmd_line = unwords (pgm : dosifyPaths (map quote args))
559 -- The pgm is already in native format (appropriate dir separators)
561 quote s = "\"" ++ s ++ "\""
563 traceCmd :: String -> String -> IO () -> IO ()
564 -- a) trace the command (at two levels of verbosity)
565 -- b) don't do it at all if dry-run is set
566 traceCmd phase_name cmd_line action
567 = do { verb <- dynFlag verbosity
568 ; when (verb >= 2) $ hPutStrLn stderr ("*** " ++ phase_name)
569 ; when (verb >= 3) $ hPutStrLn stderr cmd_line
573 ; n <- readIORef v_Dry_run
577 ; action `catchAllIO` handle_exn verb
580 handle_exn verb exn = do { when (verb >= 2) (hPutStr stderr "\n")
581 ; when (verb >= 3) (hPutStrLn stderr ("Failed: " ++ cmd_line))
582 ; throwDyn (PhaseFailed phase_name (ExitFailure 1)) }
586 %************************************************************************
588 \subsection{Path names}
590 %************************************************************************
592 We maintain path names in Unix form ('/'-separated) right until
593 the last moment. On Windows we dos-ify them just before passing them
594 to the Windows command.
596 The alternative, of using '/' consistently on Unix and '\' on Windows,
597 proved quite awkward. There were a lot more calls to dosifyPath,
598 and even on Windows we might invoke a unix-like utility (eg 'sh'), which
599 interpreted a command line 'foo\baz' as 'foobaz'.
602 -----------------------------------------------------------------------------
603 -- Convert filepath into MSDOS form.
605 dosifyPaths :: [String] -> [String]
606 -- dosifyPaths does two things
607 -- a) change '/' to '\'
608 -- b) remove initial '/cygdrive/'
610 unDosifyPath :: String -> String
611 -- Just change '\' to '/'
613 pgmPath :: String -- Directory string in Unix format
614 -> String -- Program name with no directory separators
616 -> String -- Program invocation string in native format
620 #if defined(mingw32_TARGET_OS)
622 --------------------- Windows version ------------------
623 dosifyPaths xs = map dosifyPath xs
625 unDosifyPath xs = subst '\\' '/' xs
627 pgmPath dir pgm = dosifyPath dir ++ '\\' : pgm
630 = subst '/' '\\' real_stuff
632 -- fully convince myself that /cygdrive/ prefixes cannot
633 -- really appear here.
634 cygdrive_prefix = "/cygdrive/"
637 | cygdrive_prefix `isPrefixOf` stuff = drop (length cygdrive_prefix) stuff
642 --------------------- Unix version ---------------------
645 pgmPath dir pgm = dir ++ '/' : pgm
646 --------------------------------------------------------
649 subst a b ls = map (\ x -> if x == a then b else x) ls
653 -----------------------------------------------------------------------------
654 Path name construction
657 slash :: String -> String -> String
658 absPath, relPath :: [String] -> String
661 isSlash other = False
664 relPath xs = foldr1 slash xs
666 absPath xs = "" `slash` relPath xs
668 slash s1 s2 = s1 ++ ('/' : s2)
672 %************************************************************************
674 \subsection{Support code}
676 %************************************************************************
679 -----------------------------------------------------------------------------
680 -- Define getExecDir :: IO (Maybe String)
682 #if defined(mingw32_TARGET_OS)
683 getExecDir :: IO (Maybe String)
684 getExecDir = do h <- getModuleHandle Nothing
685 n <- getModuleFileName h
686 return (Just (reverse (drop (length "/bin/ghc.exe") (reverse (unDosifyPath n)))))
688 getExecDir :: IO (Maybe String) = do return Nothing
691 #ifdef mingw32_TARGET_OS
692 foreign import "_getpid" getProcessID :: IO Int -- relies on Int == Int32 on Windows
694 getProcessID :: IO Int
695 getProcessID = Posix.getProcessID