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 ()
28 -- Temporary-file management
31 cleanTempFiles, cleanTempFilesExcept, removeTmpFiles,
35 getProcessID, -- IO Int
36 system, -- String -> IO Int
39 showGhcUsage, -- IO () Shows usage message and exits
40 getSysMan, -- IO String Parallel system only
42 runSomething -- ToDo: make private
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 )
61 #if __GLASGOW_HASKELL__ < 500
67 #include "../includes/config.h"
69 #if !defined(mingw32_TARGET_OS)
70 import qualified Posix
73 import List ( isPrefixOf )
76 import List ( isSuffixOf )
78 #include "HsVersions.h"
80 {-# DEPRECATED runSomething "runSomething should be private to SysTools" #-}
85 The configuration story
86 ~~~~~~~~~~~~~~~~~~~~~~~
88 GHC needs various support files (library packages, RTS etc), plus
89 various auxiliary programs (cp, gcc, etc). It finds these in one
92 * When running as an *installed program*, GHC finds most of this support
93 stuff in the installed library tree. The path to this tree is passed
94 to GHC via the -B flag, and given to initSysTools .
96 * When running *in-place* in a build tree, GHC finds most of this support
97 stuff in the build tree. The path to the build tree is, again passed
100 GHC tells which of the two is the case by seeing whether package.conf
101 is in TopDir [installed] or in TopDir/ghc/driver [inplace] (what a hack).
104 SysTools.initSysProgs figures out exactly where all the auxiliary programs
105 are, and initialises mutable variables to make it easy to call them.
106 To to this, it makes use of definitions in Config.hs, which is a Haskell
107 file containing variables whose value is figured out by the build system.
109 Config.hs contains two sorts of things
111 cGCC, The *names* of the programs
114 etc They do *not* include paths
117 cUNLIT_DIR The *path* to the directory containing unlit, split etc
118 cSPLIT_DIR *relative* to the root of the build tree,
119 for use when running *in-place* in a build tree (only)
123 ---------------------------------------------
124 NOTES for an ALTERNATIVE scheme (i.e *not* what is currently implemented):
126 Another hair-brained scheme for simplifying the current tool location
127 nightmare in GHC: Simon originally suggested using another
128 configuration file along the lines of GCC's specs file - which is fine
129 except that it means adding code to read yet another configuration
130 file. What I didn't notice is that the current package.conf is
131 general enough to do this:
134 {name = "tools", import_dirs = [], source_dirs = [],
135 library_dirs = [], hs_libraries = [], extra_libraries = [],
136 include_dirs = [], c_includes = [], package_deps = [],
137 extra_ghc_opts = ["-pgmc/usr/bin/gcc","-pgml${libdir}/bin/unlit", ... etc.],
138 extra_cc_opts = [], extra_ld_opts = []}
140 Which would have the advantage that we get to collect together in one
141 place the path-specific package stuff with the path-specific tool
144 ---------------------------------------------
147 %************************************************************************
149 \subsection{Global variables to contain system programs}
151 %************************************************************************
153 All these pathnames are maintained IN THE NATIVE FORMAT OF THE HOST MACHINE.
154 (See remarks under pathnames below)
157 GLOBAL_VAR(v_Pgm_L, error "pgm_L", String) -- unlit
158 GLOBAL_VAR(v_Pgm_P, error "pgm_P", String) -- cpp
159 GLOBAL_VAR(v_Pgm_c, error "pgm_c", String) -- gcc
160 GLOBAL_VAR(v_Pgm_m, error "pgm_m", String) -- asm code mangler
161 GLOBAL_VAR(v_Pgm_s, error "pgm_s", String) -- asm code splitter
162 GLOBAL_VAR(v_Pgm_a, error "pgm_a", String) -- as
163 GLOBAL_VAR(v_Pgm_l, error "pgm_l", String) -- ld
164 GLOBAL_VAR(v_Pgm_MkDLL, error "pgm_dll", String) -- mkdll
166 GLOBAL_VAR(v_Pgm_T, error "pgm_T", String) -- touch
167 GLOBAL_VAR(v_Pgm_CP, error "pgm_CP", String) -- cp
169 GLOBAL_VAR(v_Path_package_config, error "path_package_config", String)
170 GLOBAL_VAR(v_Path_usage, error "ghc_usage.txt", String)
172 -- Parallel system only
173 GLOBAL_VAR(v_Pgm_sysman, error "pgm_sysman", String) -- system manager
177 %************************************************************************
179 \subsection{Initialisation}
181 %************************************************************************
184 initSysTools :: [String] -- Command-line arguments starting "-B"
186 -> IO String -- Set all the mutable variables above, holding
187 -- (a) the system programs
188 -- (b) the package-config file
189 -- (c) the GHC usage message
193 initSysTools minusB_args
194 = do { (am_installed, top_dir) <- getTopDir minusB_args
196 -- for "installed" this is the root of GHC's support files
197 -- for "in-place" it is the root of the build tree
198 -- NB: top_dir is assumed to be in standard Unix format '/' separated
200 ; let installed_bin pgm = pgmPath (top_dir `slash` "bin") pgm
201 installed file = pgmPath top_dir file
202 inplace dir pgm = pgmPath (top_dir `slash` dir) pgm
205 | am_installed = installed "package.conf"
206 | otherwise = inplace cGHC_DRIVER_DIR "package.conf.inplace"
209 | am_installed = installed "ghc-usage.txt"
210 | otherwise = inplace cGHC_DRIVER_DIR "ghc-usage.txt"
212 -- For all systems, unlit, split, mangle are GHC utilities
213 -- architecture-specific stuff is done when building Config.hs
215 | am_installed = installed_bin cGHC_UNLIT
216 | otherwise = inplace cGHC_UNLIT_DIR cGHC_UNLIT
218 -- split and mangle are Perl scripts
220 | am_installed = installed_bin cGHC_SPLIT
221 | otherwise = inplace cGHC_SPLIT_DIR cGHC_SPLIT
224 | am_installed = installed_bin cGHC_MANGLER
225 | otherwise = inplace cGHC_MANGLER_DIR cGHC_MANGLER
227 -- Check that the package config exists
228 ; config_exists <- doesFileExist pkgconfig_path
229 ; when (not config_exists) $
230 throwDyn (InstallationError
231 ("Can't find package.conf as " ++ pkgconfig_path))
233 #if defined(mingw32_TARGET_OS)
234 -- WINDOWS-SPECIFIC STUFF
235 -- On Windows, gcc and friends are distributed with GHC,
236 -- so when "installed" we look in TopDir/bin
237 -- When "in-place" we look wherever the build-time configure
239 ; let cpp_path | am_installed = installed cRAWCPP
240 | otherwise = cRAWCPP
241 gcc_path | am_installed = installed cGCC
243 perl_path | am_installed = installed cGHC_PERL
244 | otherwise = cGHC_PERL
246 -- 'touch' is a GHC util for Windows, and similarly unlit, mangle
247 ; let touch_path | am_installed = installed cGHC_TOUCHY
248 | otherwise = inplace cGHC_TOUCHY_DIR cGHC_TOUCHY
250 -- On Win32 we don't want to rely on #!/bin/perl, so we prepend
251 -- a call to Perl to get the invocation of split and mangle
252 ; let split_path = perl_path ++ " " ++ split_script
253 mangle_path = perl_path ++ " " ++ mangle_script
255 ; let mkdll_path = cMKDLL
257 -- UNIX-SPECIFIC STUFF
258 -- On Unix, the "standard" tools are assumed to be
259 -- in the same place whether we are running "in-place" or "installed"
260 -- That place is wherever the build-time configure script found them.
261 ; let cpp_path = cRAWCPP
263 touch_path = cGHC_TOUCHY
264 mkdll_path = panic "Can't build DLLs on a non-Win32 system"
266 -- On Unix, scripts are invoked using the '#!' method. Binary
267 -- installations of GHC on Unix place the correct line on the front
268 -- of the script at installation time, so we don't want to wire-in
269 -- our knowledge of $(PERL) on the host system here.
270 ; let split_path = split_script
271 mangle_path = mangle_script
274 -- For all systems, copy and remove are provided by the host
275 -- system; architecture-specific stuff is done when building Config.hs
276 ; let cp_path = cGHC_CP
278 -- Other things being equal, as and ld are simply gcc
279 ; let as_path = gcc_path
283 -- Initialise the global vars
284 ; writeIORef v_Path_package_config pkgconfig_path
285 ; writeIORef v_Path_usage ghc_usage_msg_path
287 ; writeIORef v_Pgm_sysman (top_dir ++ "/ghc/rts/parallel/SysMan")
288 -- Hans: this isn't right in general, but you can
289 -- elaborate it in the same way as the others
291 ; writeIORef v_Pgm_L unlit_path
292 ; writeIORef v_Pgm_P cpp_path
293 ; writeIORef v_Pgm_c gcc_path
294 ; writeIORef v_Pgm_m mangle_path
295 ; writeIORef v_Pgm_s split_path
296 ; writeIORef v_Pgm_a as_path
297 ; writeIORef v_Pgm_l ld_path
298 ; writeIORef v_Pgm_MkDLL mkdll_path
299 ; writeIORef v_Pgm_T touch_path
300 ; writeIORef v_Pgm_CP cp_path
306 setPgm is called when a command-line option like
308 is used to override a particular program with a new onw
311 setPgm :: String -> IO ()
312 -- The string is the flag, minus the '-pgm' prefix
313 -- So the first character says which program to override
315 setPgm ('P' : pgm) = writeIORef v_Pgm_P pgm
316 setPgm ('c' : pgm) = writeIORef v_Pgm_c pgm
317 setPgm ('m' : pgm) = writeIORef v_Pgm_m pgm
318 setPgm ('s' : pgm) = writeIORef v_Pgm_s pgm
319 setPgm ('a' : pgm) = writeIORef v_Pgm_a pgm
320 setPgm ('l' : pgm) = writeIORef v_Pgm_l pgm
321 setPgm pgm = unknownFlagErr ("-pgm" ++ pgm)
327 -- for "installed" this is the root of GHC's support files
328 -- for "in-place" it is the root of the build tree
331 -- 1. Set proto_top_dir
332 -- a) look for (the last) -B flag, and use it
333 -- b) if there are no -B flags, get the directory
334 -- where GHC is running (only on Windows)
336 -- 2. If package.conf exists in proto_top_dir, we are running
337 -- installed; and TopDir = proto_top_dir
339 -- 3. Otherwise we are running in-place, so
340 -- proto_top_dir will be /...stuff.../ghc/compiler
341 -- Set TopDir to /...stuff..., which is the root of the build tree
343 -- This is very gruesome indeed
345 getTopDir :: [String]
346 -> IO (Bool, -- True <=> am installed, False <=> in-place
347 String) -- TopDir (in Unix format '/' separated)
350 = do { top_dir <- get_proto
351 -- Discover whether we're running in a build tree or in an installation,
352 -- by looking for the package configuration file.
353 ; am_installed <- doesFileExist (top_dir `slash` "package.conf")
355 ; return (am_installed, top_dir)
358 -- get_proto returns a Unix-format path
359 get_proto | not (null minusbs)
360 = return (unDosifyPath (drop 2 (last minusbs))) -- 2 for "-B"
362 = do { maybe_exec_dir <- getExecDir -- Get directory of executable
363 ; case maybe_exec_dir of -- (only works on Windows;
364 -- returns Nothing on Unix)
365 Nothing -> throwDyn (InstallationError "missing -B<dir> option")
366 Just dir -> return (remove_suffix (unDosifyPath dir))
369 -- In an installed tree, the ghc binary lives in $libexecdir, which
370 -- is normally $libdir/bin. So we strip off a /bin suffix here.
371 -- In a build tree, the ghc binary lives in $fptools/ghc/compiler,
372 -- so we strip off the /ghc/compiler suffix here too, leaving a
374 remove_suffix ghc_bin_dir -- ghc_bin_dir is in standard Unix format
375 | "/ghc/compiler" `isSuffixOf` ghc_bin_dir = back_two
376 | "/bin" `isSuffixOf` ghc_bin_dir = back_one
377 | otherwise = ghc_bin_dir
379 p1 = dropWhile (not . isSlash) (reverse ghc_bin_dir)
380 p2 = dropWhile (not . isSlash) (tail p1) -- head is '/'
381 back_two = reverse (tail p2) -- head is '/'
382 back_one = reverse (tail p1)
386 %************************************************************************
388 \subsection{Running an external program}
390 %************************************************************************
394 runUnlit :: [String] -> IO ()
395 runUnlit args = do p <- readIORef v_Pgm_L
396 runSomething "Literate pre-processor" p args
398 runCpp :: [String] -> IO ()
399 runCpp args = do p <- readIORef v_Pgm_P
400 runSomething "C pre-processor" p args
402 runCc :: [String] -> IO ()
403 runCc args = do p <- readIORef v_Pgm_c
404 runSomething "C Compiler" p args
406 runMangle :: [String] -> IO ()
407 runMangle args = do p <- readIORef v_Pgm_m
408 runSomething "Mangler" p args
410 runSplit :: [String] -> IO ()
411 runSplit args = do p <- readIORef v_Pgm_s
412 runSomething "Splitter" p args
414 runAs :: [String] -> IO ()
415 runAs args = do p <- readIORef v_Pgm_a
416 runSomething "Assembler" p args
418 runLink :: [String] -> IO ()
419 runLink args = do p <- readIORef v_Pgm_l
420 runSomething "Linker" p args
422 runMkDLL :: [String] -> IO ()
423 runMkDLL args = do p <- readIORef v_Pgm_MkDLL
424 runSomething "Make DLL" p args
426 touch :: String -> String -> IO ()
427 touch purpose arg = do p <- readIORef v_Pgm_T
428 runSomething purpose p [arg]
430 copy :: String -> String -> String -> IO ()
431 copy purpose from to = do
432 verb <- dynFlag verbosity
433 when (verb >= 2) $ hPutStrLn stderr ("*** " ++ purpose)
435 h <- openFile to WriteMode
436 ls <- readFile from -- inefficient, but it'll do for now.
437 -- ToDo: speed up via slurping.
443 getSysMan :: IO String -- How to invoke the system manager
444 -- (parallel system only)
445 getSysMan = readIORef v_Pgm_sysman
448 %************************************************************************
450 \subsection{GHC Usage message}
452 %************************************************************************
454 Show the usage message and exit
457 showGhcUsage = do { usage_path <- readIORef v_Path_usage
458 ; usage <- readFile usage_path
460 ; exitWith ExitSuccess }
463 dump ('$':'$':s) = hPutStr stderr progName >> dump s
464 dump (c:s) = hPutChar stderr c >> dump s
466 packageConfigPath = readIORef v_Path_package_config
470 %************************************************************************
472 \subsection{Managing temporary files
474 %************************************************************************
477 GLOBAL_VAR(v_FilesToClean, [], [String] )
478 GLOBAL_VAR(v_TmpDir, cDEFAULT_TMPDIR, String )
479 -- v_TmpDir has no closing '/'
483 setTmpDir dir = writeIORef v_TmpDir dir
485 cleanTempFiles :: Int -> IO ()
486 cleanTempFiles verb = do fs <- readIORef v_FilesToClean
487 removeTmpFiles verb fs
489 cleanTempFilesExcept :: Int -> [FilePath] -> IO ()
490 cleanTempFilesExcept verb dont_delete
491 = do fs <- readIORef v_FilesToClean
492 let leftovers = filter (`notElem` dont_delete) fs
493 removeTmpFiles verb leftovers
494 writeIORef v_FilesToClean dont_delete
497 -- find a temporary name that doesn't already exist.
498 newTempName :: Suffix -> IO FilePath
500 = do x <- getProcessID
501 tmp_dir <- readIORef v_TmpDir
502 findTempName tmp_dir x
504 findTempName tmp_dir x
505 = do let filename = tmp_dir ++ "/ghc" ++ show x ++ '.':extn
506 b <- doesFileExist filename
507 if b then findTempName tmp_dir (x+1)
508 else do add v_FilesToClean filename -- clean it up later
511 addFilesToClean :: [FilePath] -> IO ()
512 -- May include wildcards [used by DriverPipeline.run_phase SplitMangle]
513 addFilesToClean files = mapM_ (add v_FilesToClean) files
515 removeTmpFiles :: Int -> [FilePath] -> IO ()
516 removeTmpFiles verb fs
517 = traceCmd "Deleting temp files"
518 ("Deleting: " ++ unwords fs)
521 rm f = removeFile f `catchAllIO`
524 hPutStrLn stderr ("Warning: deleting non-existent " ++ f)
530 %************************************************************************
532 \subsection{Running a program}
534 %************************************************************************
537 GLOBAL_VAR(v_Dry_run, False, Bool)
540 setDryRun = writeIORef v_Dry_run True
542 -----------------------------------------------------------------------------
543 -- Running an external program
545 runSomething :: String -- For -v message
546 -> String -- Command name (possibly a full path)
547 -- assumed already dos-ified
548 -> [String] -- Arguments
549 -- runSomething will dos-ify them
552 runSomething phase_name pgm args
553 = traceCmd phase_name cmd_line $
554 do { exit_code <- system cmd_line
555 ; if exit_code /= ExitSuccess
556 then throwDyn (PhaseFailed phase_name exit_code)
560 cmd_line = unwords (pgm : dosifyPaths args)
561 -- The pgm is already in native format (appropriate dir separators)
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 ------------------
625 dosifyPaths xs = map dosifyPath 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 ---------------------
644 unDosifyPath xs = subst '\\' '/' xs
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 myGetProcessId :: IO Int
681 -- getExecDir :: IO (Maybe String)
683 #ifdef mingw32_TARGET_OS
684 foreign import "_getpid" getProcessID :: IO Int -- relies on Int == Int32 on Windows
686 #if __GLASGOW_HASKELL__ >= 500
687 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> CString -> IO Int32
688 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectoryLen :: Int32 -> Addr -> IO Int32
689 getExecDir :: IO (Maybe String)
690 getExecDir = do len <- getCurrentDirectoryLen 0 nullAddr
691 buf <- mallocArray (fromIntegral len)
692 ret <- getCurrentDirectory len buf
693 if ret == 0 then return Nothing
694 else do s <- peekCString buf
695 destructArray (fromIntegral len) buf
698 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> Addr -> IO Int32
699 getExecDir :: IO (Maybe String)
700 getExecDir = do len <- getCurrentDirectory 0 nullAddr
701 buf <- malloc (fromIntegral len)
702 ret <- getCurrentDirectory len buf
703 if ret == 0 then return Nothing
704 else do s <- unpackCStringIO buf
709 getProcessID :: IO Int
710 getProcessID = Posix.getProcessID
711 getExecDir :: IO (Maybe String) = do return Nothing