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 %************************************************************************
125 \subsection{Global variables to contain system programs}
127 %************************************************************************
129 All these pathnames are maintained IN THE NATIVE FORMAT OF THE HOST MACHINE.
130 (See remarks under pathnames below)
133 GLOBAL_VAR(v_Pgm_L, error "pgm_L", String) -- unlit
134 GLOBAL_VAR(v_Pgm_P, error "pgm_P", String) -- cpp
135 GLOBAL_VAR(v_Pgm_c, error "pgm_c", String) -- gcc
136 GLOBAL_VAR(v_Pgm_m, error "pgm_m", String) -- asm code mangler
137 GLOBAL_VAR(v_Pgm_s, error "pgm_s", String) -- asm code splitter
138 GLOBAL_VAR(v_Pgm_a, error "pgm_a", String) -- as
139 GLOBAL_VAR(v_Pgm_l, error "pgm_l", String) -- ld
140 GLOBAL_VAR(v_Pgm_MkDLL, error "pgm_dll", String) -- mkdll
142 GLOBAL_VAR(v_Pgm_T, error "pgm_T", String) -- touch
143 GLOBAL_VAR(v_Pgm_CP, error "pgm_CP", String) -- cp
145 GLOBAL_VAR(v_Path_package_config, error "path_package_config", String)
146 GLOBAL_VAR(v_Path_usage, error "ghc_usage.txt", String)
148 -- Parallel system only
149 GLOBAL_VAR(v_Pgm_sysman, error "pgm_sysman", String) -- system manager
153 %************************************************************************
155 \subsection{Initialisation}
157 %************************************************************************
160 initSysTools :: [String] -- Command-line arguments starting "-B"
162 -> IO String -- Set all the mutable variables above, holding
163 -- (a) the system programs
164 -- (b) the package-config file
165 -- (c) the GHC usage message
169 initSysTools minusB_args
170 = do { (am_installed, top_dir) <- getTopDir minusB_args
172 -- for "installed" this is the root of GHC's support files
173 -- for "in-place" it is the root of the build tree
174 -- NB: top_dir is assumed to be in standard Unix format '/' separated
176 ; let installed_bin pgm = pgmPath (top_dir `slash` "bin") pgm
177 installed file = pgmPath top_dir file
178 inplace dir pgm = pgmPath (top_dir `slash` dir) pgm
181 | am_installed = installed "package.conf"
182 | otherwise = inplace cGHC_DRIVER_DIR "package.conf.inplace"
185 | am_installed = installed "ghc-usage.txt"
186 | otherwise = inplace cGHC_DRIVER_DIR "ghc-usage.txt"
188 -- For all systems, unlit, split, mangle are GHC utilities
189 -- architecture-specific stuff is done when building Config.hs
191 | am_installed = installed_bin cGHC_UNLIT
192 | otherwise = inplace cGHC_UNLIT_DIR cGHC_UNLIT
194 -- split and mangle are Perl scripts
196 | am_installed = installed_bin cGHC_SPLIT
197 | otherwise = inplace cGHC_SPLIT_DIR cGHC_SPLIT
200 | am_installed = installed_bin cGHC_MANGLER
201 | otherwise = inplace cGHC_MANGLER_DIR cGHC_MANGLER
203 -- Check that the package config exists
204 ; config_exists <- doesFileExist pkgconfig_path
205 ; when (not config_exists) $
206 throwDyn (InstallationError
207 ("Can't find package.conf as " ++ pkgconfig_path))
209 #if defined(mingw32_TARGET_OS)
210 -- WINDOWS-SPECIFIC STUFF
211 -- On Windows, gcc and friends are distributed with GHC,
212 -- so when "installed" we look in TopDir/bin
213 -- When "in-place" we look wherever the build-time configure
215 ; let cpp_path | am_installed = installed cRAWCPP
216 | otherwise = cRAWCPP
217 gcc_path | am_installed = installed cGCC
219 perl_path | am_installed = installed cGHC_PERL
220 | otherwise = cGHC_PERL
222 -- 'touch' is a GHC util for Windows, and similarly unlit, mangle
223 ; let touch_path | am_installed = installed cGHC_TOUCHY
224 | otherwise = inplace cGHC_TOUCHY_DIR cGHC_TOUCHY
226 -- On Win32 we don't want to rely on #!/bin/perl, so we prepend
227 -- a call to Perl to get the invocation of split and mangle
228 ; let split_path = perl_path ++ " " ++ split_script
229 mangle_path = perl_path ++ " " ++ mangle_script
231 ; let mkdll_path = cMKDLL
233 -- UNIX-SPECIFIC STUFF
234 -- On Unix, the "standard" tools are assumed to be
235 -- in the same place whether we are running "in-place" or "installed"
236 -- That place is wherever the build-time configure script found them.
237 ; let cpp_path = cRAWCPP
239 touch_path = cGHC_TOUCHY
240 mkdll_path = panic "Can't build DLLs on a non-Win32 system"
242 -- On Unix, scripts are invoked using the '#!' method. Binary
243 -- installations of GHC on Unix place the correct line on the front
244 -- of the script at installation time, so we don't want to wire-in
245 -- our knowledge of $(PERL) on the host system here.
246 ; let split_path = split_script
247 mangle_path = mangle_script
251 -- For all systems, copy and remove are provided by the host
252 -- system; architecture-specific stuff is done when building Config.hs
253 ; let cp_path = cGHC_CP
255 -- Other things being equal, as and ld are simply gcc
256 ; let as_path = gcc_path
260 -- Initialise the global vars
261 ; writeIORef v_Path_package_config pkgconfig_path
262 ; writeIORef v_Path_usage ghc_usage_msg_path
264 ; writeIORef v_Pgm_sysman (top_dir ++ "/ghc/rts/parallel/SysMan")
265 -- Hans: this isn't right in general, but you can
266 -- elaborate it in the same way as the others
268 ; writeIORef v_Pgm_L unlit_path
269 ; writeIORef v_Pgm_P cpp_path
270 ; writeIORef v_Pgm_c gcc_path
271 ; writeIORef v_Pgm_m mangle_path
272 ; writeIORef v_Pgm_s split_path
273 ; writeIORef v_Pgm_a as_path
274 ; writeIORef v_Pgm_l ld_path
275 ; writeIORef v_Pgm_MkDLL mkdll_path
276 ; writeIORef v_Pgm_T touch_path
277 ; writeIORef v_Pgm_CP cp_path
283 setPgm is called when a command-line option like
285 is used to override a particular program with a new onw
288 setPgm :: String -> IO ()
289 -- The string is the flag, minus the '-pgm' prefix
290 -- So the first character says which program to override
292 setPgm ('P' : pgm) = writeIORef v_Pgm_P pgm
293 setPgm ('c' : pgm) = writeIORef v_Pgm_c pgm
294 setPgm ('m' : pgm) = writeIORef v_Pgm_m pgm
295 setPgm ('s' : pgm) = writeIORef v_Pgm_s pgm
296 setPgm ('a' : pgm) = writeIORef v_Pgm_a pgm
297 setPgm ('l' : pgm) = writeIORef v_Pgm_l pgm
298 setPgm pgm = unknownFlagErr ("-pgm" ++ pgm)
304 -- for "installed" this is the root of GHC's support files
305 -- for "in-place" it is the root of the build tree
308 -- 1. Set proto_top_dir
309 -- a) look for (the last) -B flag, and use it
310 -- b) if there are no -B flags, get the directory
311 -- where GHC is running (only on Windows)
313 -- 2. If package.conf exists in proto_top_dir, we are running
314 -- installed; and TopDir = proto_top_dir
316 -- 3. Otherwise we are running in-place, so
317 -- proto_top_dir will be /...stuff.../ghc/compiler
318 -- Set TopDir to /...stuff..., which is the root of the build tree
320 -- This is very gruesome indeed
322 getTopDir :: [String]
323 -> IO (Bool, -- True <=> am installed, False <=> in-place
324 String) -- TopDir (in Unix format '/' separated)
327 = do { top_dir <- get_proto
329 ; if "/ghc/compiler" `isSuffixOf` top_dir then print (remove_suffix top_dir) else print "not"
331 -- Discover whether we're running in a build tree or in an installation,
332 -- by looking for the package configuration file.
333 ; am_installed <- doesFileExist (top_dir `slash` "package.conf")
335 ; return (am_installed, top_dir)
338 -- get_proto returns a Unix-format path
339 get_proto | not (null minusbs)
340 = return (unDosifyPath (drop 2 (last minusbs))) -- 2 for "-B"
342 = do { maybe_exec_dir <- getExecDir -- Get directory of executable
343 ; case maybe_exec_dir of -- (only works on Windows;
344 -- returns Nothing on Unix)
345 Nothing -> throwDyn (InstallationError "missing -B<dir> option")
346 Just dir -> return (remove_suffix (unDosifyPath dir))
349 -- In an installed tree, the ghc binary lives in $libexecdir, which
350 -- is normally $libdir/bin. So we strip off a /bin suffix here.
351 -- In a build tree, the ghc binary lives in $fptools/ghc/compiler,
352 -- so we strip off the /ghc/compiler suffix here too, leaving a
354 remove_suffix ghc_bin_dir -- ghc_bin_dir is in standard Unix format
355 | "/ghc/compiler" `isSuffixOf` ghc_bin_dir = back_two
356 | "/bin" `isSuffixOf` ghc_bin_dir = back_one
357 | otherwise = ghc_bin_dir
359 p1 = dropWhile (not . isSlash) (reverse ghc_bin_dir)
360 p2 = dropWhile (not . isSlash) (tail p1) -- head is '/'
361 back_two = reverse (tail p2) -- head is '/'
362 back_one = reverse (tail p1)
366 %************************************************************************
368 \subsection{Running an external program}
370 %************************************************************************
374 runUnlit :: [String] -> IO ()
375 runUnlit args = do p <- readIORef v_Pgm_L
376 runSomething "Literate pre-processor" p args
378 runCpp :: [String] -> IO ()
379 runCpp args = do p <- readIORef v_Pgm_P
380 runSomething "C pre-processor" p args
382 runCc :: [String] -> IO ()
383 runCc args = do p <- readIORef v_Pgm_c
384 runSomething "C Compiler" p args
386 runMangle :: [String] -> IO ()
387 runMangle args = do p <- readIORef v_Pgm_m
388 runSomething "Mangler" p args
390 runSplit :: [String] -> IO ()
391 runSplit args = do p <- readIORef v_Pgm_s
392 runSomething "Splitter" p args
394 runAs :: [String] -> IO ()
395 runAs args = do p <- readIORef v_Pgm_a
396 runSomething "Assembler" p args
398 runLink :: [String] -> IO ()
399 runLink args = do p <- readIORef v_Pgm_l
400 runSomething "Linker" p args
402 runMkDLL :: [String] -> IO ()
403 runMkDLL args = do p <- readIORef v_Pgm_MkDLL
404 runSomething "Make DLL" p args
406 touch :: String -> String -> IO ()
407 touch purpose arg = do p <- readIORef v_Pgm_T
408 runSomething purpose p [arg]
410 copy :: String -> String -> String -> IO ()
411 copy purpose from to =
413 h <- openFile to WriteMode
414 ls <- readFile from -- inefficient, but it'll do for now.
415 -- ToDo: speed up via slurping.
417 hClose h) `catchAllIO`
418 (\_ -> throwDyn (PhaseFailed purpose (ExitFailure 1)))
422 getSysMan :: IO String -- How to invoke the system manager
423 -- (parallel system only)
424 getSysMan = readIORef v_Pgm_sysman
427 %************************************************************************
429 \subsection{GHC Usage message}
431 %************************************************************************
433 Show the usage message and exit
436 showGhcUsage = do { usage_path <- readIORef v_Path_usage
437 ; usage <- readFile usage_path
439 ; exitWith ExitSuccess }
442 dump ('$':'$':s) = hPutStr stderr progName >> dump s
443 dump (c:s) = hPutChar stderr c >> dump s
445 packageConfigPath = readIORef v_Path_package_config
449 %************************************************************************
451 \subsection{Managing temporary files
453 %************************************************************************
456 GLOBAL_VAR(v_FilesToClean, [], [String] )
457 GLOBAL_VAR(v_TmpDir, cDEFAULT_TMPDIR, String )
458 -- v_TmpDir has no closing '/'
462 setTmpDir dir = writeIORef v_TmpDir dir
464 cleanTempFiles :: Int -> IO ()
465 cleanTempFiles verb = do fs <- readIORef v_FilesToClean
466 removeTmpFiles verb fs
468 cleanTempFilesExcept :: Int -> [FilePath] -> IO ()
469 cleanTempFilesExcept verb dont_delete
470 = do fs <- readIORef v_FilesToClean
471 let leftovers = filter (`notElem` dont_delete) fs
472 removeTmpFiles verb leftovers
473 writeIORef v_FilesToClean dont_delete
476 -- find a temporary name that doesn't already exist.
477 newTempName :: Suffix -> IO FilePath
479 = do x <- getProcessID
480 tmp_dir <- readIORef v_TmpDir
481 findTempName tmp_dir x
483 findTempName tmp_dir x
484 = do let filename = tmp_dir ++ "/ghc" ++ show x ++ '.':extn
485 b <- doesFileExist filename
486 if b then findTempName tmp_dir (x+1)
487 else do add v_FilesToClean filename -- clean it up later
490 addFilesToClean :: [FilePath] -> IO ()
491 -- May include wildcards [used by DriverPipeline.run_phase SplitMangle]
492 addFilesToClean files = mapM_ (add v_FilesToClean) files
494 removeTmpFiles :: Int -> [FilePath] -> IO ()
495 removeTmpFiles verb fs
496 = traceCmd "Deleting temp files"
497 ("Deleting: " ++ unwords fs)
500 rm f = removeFile f `catchAllIO`
501 (\exn -> hPutStrLn stderr ("Warning: deleting non-existent " ++ f) >>
507 %************************************************************************
509 \subsection{Running a program}
511 %************************************************************************
514 GLOBAL_VAR(v_Dry_run, False, Bool)
517 setDryRun = writeIORef v_Dry_run True
519 -----------------------------------------------------------------------------
520 -- Running an external program
522 runSomething :: String -- For -v message
523 -> String -- Command name (possibly a full path)
524 -- assumed already dos-ified
525 -> [String] -- Arguments
526 -- runSomething will dos-ify them
529 runSomething phase_name pgm args
530 = traceCmd phase_name cmd_line $
531 do { exit_code <- system cmd_line
532 ; if exit_code /= ExitSuccess
533 then throwDyn (PhaseFailed phase_name exit_code)
537 cmd_line = unwords (pgm : dosifyPaths args)
538 -- The pgm is already in native format (appropriate dir separators)
540 traceCmd :: String -> String -> IO () -> IO ()
541 -- a) trace the command (at two levels of verbosity)
542 -- b) don't do it at all if dry-run is set
543 traceCmd phase_name cmd_line action
544 = do { verb <- dynFlag verbosity
545 ; when (verb >= 2) $ hPutStrLn stderr ("*** " ++ phase_name)
546 ; when (verb >= 3) $ hPutStrLn stderr cmd_line
550 ; n <- readIORef v_Dry_run
554 ; action `catchAllIO` handle_exn verb
557 handle_exn verb exn = do { when (verb >= 2) (hPutStr stderr "\n")
558 ; when (verb >= 3) (hPutStrLn stderr ("Failed: " ++ cmd_line))
559 ; throwDyn (PhaseFailed phase_name (ExitFailure 1)) }
563 %************************************************************************
565 \subsection{Path names}
567 %************************************************************************
569 We maintain path names in Unix form ('/'-separated) right until
570 the last moment. On Windows we dos-ify them just before passing them
571 to the Windows command.
573 The alternative, of using '/' consistently on Unix and '\' on Windows,
574 proved quite awkward. There were a lot more calls to dosifyPath,
575 and even on Windows we might invoke a unix-like utility (eg 'sh'), which
576 interpreted a command line 'foo\baz' as 'foobaz'.
579 -----------------------------------------------------------------------------
580 -- Convert filepath into MSDOS form.
582 dosifyPaths :: [String] -> [String]
583 -- dosifyPaths does two things
584 -- a) change '/' to '\'
585 -- b) remove initial '/cygdrive/'
587 unDosifyPath :: String -> String
588 -- Just change '\' to '/'
590 pgmPath :: String -- Directory string in Unix format
591 -> String -- Program name with no directory separators
593 -> String -- Program invocation string in native format
597 #if defined(mingw32_TARGET_OS)
599 --------------------- Windows version ------------------
602 dosifyPaths xs = map dosifyPath xs
604 pgmPath dir pgm = dosifyPath dir ++ '\\' : pgm
607 = subst '/' '\\' real_stuff
609 -- fully convince myself that /cygdrive/ prefixes cannot
610 -- really appear here.
611 cygdrive_prefix = "/cygdrive/"
614 | cygdrive_prefix `isPrefixOf` stuff = drop (length cygdrive_prefix) stuff
619 --------------------- Unix version ---------------------
621 unDosifyPath xs = subst '\\' '/' xs
622 pgmPath dir pgm = dir ++ '/' : pgm
623 --------------------------------------------------------
626 subst a b ls = map (\ x -> if x == a then b else x) ls
630 -----------------------------------------------------------------------------
631 Path name construction
634 slash :: String -> String -> String
635 absPath, relPath :: [String] -> String
638 isSlash other = False
641 relPath xs = foldr1 slash xs
643 absPath xs = "" `slash` relPath xs
645 slash s1 s2 = s1 ++ ('/' : s2)
649 %************************************************************************
651 \subsection{Support code}
653 %************************************************************************
656 -----------------------------------------------------------------------------
657 -- Define myGetProcessId :: IO Int
658 -- getExecDir :: IO (Maybe String)
660 #ifdef mingw32_TARGET_OS
661 foreign import "_getpid" getProcessID :: IO Int -- relies on Int == Int32 on Windows
663 #if __GLASGOW_HASKELL__ >= 500
664 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> CString -> IO Int32
665 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectoryLen :: Int32 -> Addr -> IO Int32
666 getExecDir :: IO (Maybe String)
667 getExecDir = do len <- getCurrentDirectoryLen 0 nullAddr
668 buf <- mallocArray (fromIntegral len)
669 ret <- getCurrentDirectory len buf
670 if ret == 0 then return Nothing
671 else do s <- peekCString buf
672 destructArray (fromIntegral len) buf
675 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> Addr -> IO Int32
676 getExecDir :: IO (Maybe String)
677 getExecDir = do len <- getCurrentDirectory 0 nullAddr
678 buf <- malloc (fromIntegral len)
679 ret <- getCurrentDirectory len buf
680 if ret == 0 then return Nothing
681 else do s <- unpackCStringIO buf
686 getProcessID :: IO Int
687 getProcessID = Posix.getProcessID
688 getExecDir :: IO (Maybe String) = do return Nothing