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 )
53 import IO ( hPutStr, hPutChar, hPutStrLn, hFlush, stderr )
54 import Directory ( doesFileExist, removeFile )
55 import IOExts ( IORef, readIORef, writeIORef )
56 import Monad ( when, unless )
57 import System ( system, ExitCode(..), exitWith )
60 #if __GLASGOW_HASKELL__ < 500
66 #include "../includes/config.h"
68 #if !defined(mingw32_TARGET_OS)
69 import qualified Posix
71 import Addr ( nullAddr )
72 import List ( isPrefixOf )
75 #include "HsVersions.h"
77 {-# DEPRECATED runSomething "runSomething should be private to SysTools" #-}
82 The configuration story
83 ~~~~~~~~~~~~~~~~~~~~~~~
85 GHC needs various support files (library packages, RTS etc), plus
86 various auxiliary programs (cp, gcc, etc). It finds these in one
89 * When running as an *installed program*, GHC finds most of this support
90 stuff in the installed library tree. The path to this tree is passed
91 to GHC via the -B flag, and given to initSysTools .
93 * When running *in-place* in a build tree, GHC finds most of this support
94 stuff in the build tree. The path to the build tree is, again passed
97 GHC tells which of the two is the case by seeing whether package.conf
98 is in TopDir [installed] or in TopDir/ghc/driver [inplace] (what a hack).
101 SysTools.initSysProgs figures out exactly where all the auxiliary programs
102 are, and initialises mutable variables to make it easy to call them.
103 To to this, it makes use of definitions in Config.hs, which is a Haskell
104 file containing variables whose value is figured out by the build system.
106 Config.hs contains two sorts of things
108 cGCC, The *names* of the programs
111 etc They do *not* include paths
114 cUNLIT_DIR The *path* to the directory containing unlit, split etc
115 cSPLIT_DIR *relative* to the root of the build tree,
116 for use when running *in-place* in a build tree (only)
120 %************************************************************************
122 \subsection{Global variables to contain system programs}
124 %************************************************************************
126 All these pathnames are maintained IN THE NATIVE FORMAT OF THE HOST MACHINE.
127 (See remarks under pathnames below)
130 GLOBAL_VAR(v_Pgm_L, error "pgm_L", String) -- unlit
131 GLOBAL_VAR(v_Pgm_P, error "pgm_P", String) -- cpp
132 GLOBAL_VAR(v_Pgm_c, error "pgm_c", String) -- gcc
133 GLOBAL_VAR(v_Pgm_m, error "pgm_m", String) -- asm code mangler
134 GLOBAL_VAR(v_Pgm_s, error "pgm_s", String) -- asm code splitter
135 GLOBAL_VAR(v_Pgm_a, error "pgm_a", String) -- as
136 GLOBAL_VAR(v_Pgm_l, error "pgm_l", String) -- ld
137 GLOBAL_VAR(v_Pgm_MkDLL, error "pgm_dll", String) -- mkdll
139 GLOBAL_VAR(v_Pgm_T, error "pgm_T", String) -- touch
140 GLOBAL_VAR(v_Pgm_CP, error "pgm_CP", String) -- cp
142 GLOBAL_VAR(v_Path_package_config, error "path_package_config", String)
143 GLOBAL_VAR(v_Path_usage, error "ghc_usage.txt", String)
145 -- Parallel system only
146 GLOBAL_VAR(v_Pgm_sysman, error "pgm_sysman", String) -- system manager
150 %************************************************************************
152 \subsection{Initialisation}
154 %************************************************************************
157 initSysTools :: [String] -- Command-line arguments starting "-B"
159 -> IO String -- Set all the mutable variables above, holding
160 -- (a) the system programs
161 -- (b) the package-config file
162 -- (c) the GHC usage message
166 initSysTools minusB_args
167 = do { (am_installed, top_dir) <- getTopDir minusB_args
169 -- for "installed" this is the root of GHC's support files
170 -- for "in-place" it is the root of the build tree
171 -- NB: top_dir is assumed to be in standard Unix format '/' separated
173 ; let installed_bin pgm = pgmPath (top_dir `slash` "bin") pgm
174 installed file = pgmPath top_dir file
175 inplace dir pgm = pgmPath (top_dir `slash` dir) pgm
178 | am_installed = installed "package.conf"
179 | otherwise = inplace cGHC_DRIVER_DIR "package.conf.inplace"
182 | am_installed = installed "ghc-usage.txt"
183 | otherwise = inplace cGHC_DRIVER_DIR "ghc-usage.txt"
185 -- For all systems, unlit, split, mangle are GHC utilities
186 -- architecture-specific stuff is done when building Config.hs
188 | am_installed = installed_bin cGHC_UNLIT
189 | otherwise = inplace cGHC_UNLIT_DIR cGHC_UNLIT
191 -- split and mangle are Perl scripts
193 | am_installed = installed_bin cGHC_SPLIT
194 | otherwise = inplace cGHC_SPLIT_DIR cGHC_SPLIT
197 | am_installed = installed_bin cGHC_MANGLER
198 | otherwise = inplace cGHC_MANGLER_DIR cGHC_MANGLER
200 -- Check that the package config exists
201 ; config_exists <- doesFileExist pkgconfig_path
202 ; when (not config_exists) $
203 throwDyn (InstallationError
204 ("Can't find package.conf in " ++ pkgconfig_path))
206 #if defined(mingw32_TARGET_OS)
207 -- WINDOWS-SPECIFIC STUFF
208 -- On Windows, gcc and friends are distributed with GHC,
209 -- so when "installed" we look in TopDir/bin
210 -- When "in-place" we look wherever the build-time configure
212 ; let cpp_path | am_installed = installed cRAWCPP
213 | otherwise = cRAWCPP
214 gcc_path | am_installed = installed cGCC
216 perl_path | am_installed = installed cGHC_PERL
217 | otherwise = cGHC_PERL
219 -- 'touch' is a GHC util for Windows, and similarly unlit, mangle
220 ; let touch_path | am_installed = installed cGHC_TOUCHY
221 | otherwise = inplace cGHC_TOUCHY_DIR cGHC_TOUCHY
223 -- On Win32 we don't want to rely on #!/bin/perl, so we prepend
224 -- a call to Perl to get the invocation of split and mangle
225 ; let split_path = perl_path ++ " " ++ split_script
226 mangle_path = perl_path ++ " " ++ mangle_script
228 ; let mkdll_path = cMKDLL
230 -- UNIX-SPECIFIC STUFF
231 -- On Unix, the "standard" tools are assumed to be
232 -- in the same place whether we are running "in-place" or "installed"
233 -- That place is wherever the build-time configure script found them.
234 ; let cpp_path = cRAWCPP
236 touch_path = cGHC_TOUCHY
237 mkdll_path = panic "Can't build DLLs on a non-Win32 system"
239 -- On Unix, scripts are invoked using the '#!' method. Binary
240 -- installations of GHC on Unix place the correct line on the front
241 -- of the script at installation time, so we don't want to wire-in
242 -- our knowledge of $(PERL) on the host system here.
243 ; let split_path = split_script
244 mangle_path = mangle_script
248 -- For all systems, copy and remove are provided by the host
249 -- system; architecture-specific stuff is done when building Config.hs
250 ; let cp_path = cGHC_CP
252 -- Other things being equal, as and ld are simply gcc
253 ; let as_path = gcc_path
257 -- Initialise the global vars
258 ; writeIORef v_Path_package_config pkgconfig_path
259 ; writeIORef v_Path_usage ghc_usage_msg_path
261 ; writeIORef v_Pgm_sysman (top_dir ++ "/ghc/rts/parallel/SysMan")
262 -- Hans: this isn't right in general, but you can
263 -- elaborate it in the same way as the others
265 ; writeIORef v_Pgm_L unlit_path
266 ; writeIORef v_Pgm_P cpp_path
267 ; writeIORef v_Pgm_c gcc_path
268 ; writeIORef v_Pgm_m mangle_path
269 ; writeIORef v_Pgm_s split_path
270 ; writeIORef v_Pgm_a as_path
271 ; writeIORef v_Pgm_l ld_path
272 ; writeIORef v_Pgm_MkDLL mkdll_path
273 ; writeIORef v_Pgm_T touch_path
274 ; writeIORef v_Pgm_CP cp_path
280 setPgm is called when a command-line option like
282 is used to override a particular program with a new onw
285 setPgm :: String -> IO ()
286 -- The string is the flag, minus the '-pgm' prefix
287 -- So the first character says which program to override
289 setPgm ('P' : pgm) = writeIORef v_Pgm_P pgm
290 setPgm ('c' : pgm) = writeIORef v_Pgm_c pgm
291 setPgm ('m' : pgm) = writeIORef v_Pgm_m pgm
292 setPgm ('s' : pgm) = writeIORef v_Pgm_s pgm
293 setPgm ('a' : pgm) = writeIORef v_Pgm_a pgm
294 setPgm ('l' : pgm) = writeIORef v_Pgm_l pgm
295 setPgm pgm = unknownFlagErr ("-pgm" ++ pgm)
301 -- for "installed" this is the root of GHC's support files
302 -- for "in-place" it is the root of the build tree
305 -- 1. Set proto_top_dir
306 -- a) look for (the last) -B flag, and use it
307 -- b) if there are no -B flags, get the directory
308 -- where GHC is running
310 -- 2. If package.conf exists in proto_top_dir, we are running
311 -- installed; and TopDir = proto_top_dir
313 -- 3. Otherwise we are running in-place, so
314 -- proto_top_dir will be /...stuff.../ghc/compiler
315 -- Set TopDir to /...stuff..., which is the root of the build tree
317 -- This is very gruesome indeed
319 getTopDir :: [String]
320 -> IO (Bool, -- True <=> am installed, False <=> in-place
321 String) -- TopDir (in Unix format '/' separated)
324 = do { top_dir1 <- get_proto
325 ; let top_dir2 = unDosifyPath top_dir1 -- Convert to standard internal form
327 -- Discover whether we're running in a build tree or in an installation,
328 -- by looking for the package configuration file.
329 ; am_installed <- doesFileExist (top_dir2 `slash` "package.conf")
331 ; if am_installed then
332 return (True, top_dir2)
334 return (False, remove_suffix top_dir2)
337 get_proto | not (null minusbs)
338 = return (drop 2 (last minusbs)) -- 2 for "-B"
340 = do { maybe_exec_dir <- getExecDir -- Get directory of executable
341 ; case maybe_exec_dir of -- (only works on Windows;
342 -- returns Nothing on Unix)
343 Nothing -> throwDyn (InstallationError "missing -B<dir> option")
344 Just dir -> return dir
347 remove_suffix dir -- "/...stuff.../ghc/compiler" --> "/...stuff..."
348 = ASSERT2( not (null p1) &&
350 dir == top_dir ++ "/ghc/compiler",
354 p1 = dropWhile (not . isSlash) (reverse dir)
355 p2 = dropWhile (not . isSlash) (tail p1) -- head is '/'
356 top_dir = reverse (tail p2) -- head is '/'
360 %************************************************************************
362 \subsection{Running an external program}
364 %************************************************************************
368 runUnlit :: [String] -> IO ()
369 runUnlit args = do p <- readIORef v_Pgm_L
370 runSomething "Literate pre-processor" p args
372 runCpp :: [String] -> IO ()
373 runCpp args = do p <- readIORef v_Pgm_P
374 runSomething "C pre-processor" p args
376 runCc :: [String] -> IO ()
377 runCc args = do p <- readIORef v_Pgm_c
378 runSomething "C Compiler" p args
380 runMangle :: [String] -> IO ()
381 runMangle args = do p <- readIORef v_Pgm_m
382 runSomething "Mangler" p args
384 runSplit :: [String] -> IO ()
385 runSplit args = do p <- readIORef v_Pgm_s
386 runSomething "Splitter" p args
388 runAs :: [String] -> IO ()
389 runAs args = do p <- readIORef v_Pgm_a
390 runSomething "Assembler" p args
392 runLink :: [String] -> IO ()
393 runLink args = do p <- readIORef v_Pgm_l
394 runSomething "Linker" p args
396 runMkDLL :: [String] -> IO ()
397 runMkDLL args = do p <- readIORef v_Pgm_MkDLL
398 runSomething "Make DLL" p args
400 touch :: String -> String -> IO ()
401 touch purpose arg = do p <- readIORef v_Pgm_T
402 runSomething purpose p [arg]
404 copy :: String -> String -> String -> IO ()
405 copy purpose from to = do p <- readIORef v_Pgm_CP
406 runSomething purpose p [from,to]
410 getSysMan :: IO String -- How to invoke the system manager
411 -- (parallel system only)
412 getSysMan = readIORef v_Pgm_sysman
415 %************************************************************************
417 \subsection{GHC Usage message}
419 %************************************************************************
421 Show the usage message and exit
424 showGhcUsage = do { usage_path <- readIORef v_Path_usage
425 ; usage <- readFile usage_path
427 ; exitWith ExitSuccess }
430 dump ('$':'$':s) = hPutStr stderr progName >> dump s
431 dump (c:s) = hPutChar stderr c >> dump s
433 packageConfigPath = readIORef v_Path_package_config
437 %************************************************************************
439 \subsection{Managing temporary files
441 %************************************************************************
444 GLOBAL_VAR(v_FilesToClean, [], [String] )
445 GLOBAL_VAR(v_TmpDir, cDEFAULT_TMPDIR, String )
446 -- v_TmpDir has no closing '/'
450 setTmpDir dir = writeIORef v_TmpDir dir
452 cleanTempFiles :: Int -> IO ()
453 cleanTempFiles verb = do fs <- readIORef v_FilesToClean
454 removeTmpFiles verb fs
456 cleanTempFilesExcept :: Int -> [FilePath] -> IO ()
457 cleanTempFilesExcept verb dont_delete
458 = do fs <- readIORef v_FilesToClean
459 let leftovers = filter (`notElem` dont_delete) fs
460 removeTmpFiles verb leftovers
461 writeIORef v_FilesToClean dont_delete
464 -- find a temporary name that doesn't already exist.
465 newTempName :: Suffix -> IO FilePath
467 = do x <- getProcessID
468 tmp_dir <- readIORef v_TmpDir
469 findTempName tmp_dir x
471 findTempName tmp_dir x
472 = do let filename = tmp_dir ++ "/ghc" ++ show x ++ '.':extn
473 b <- doesFileExist filename
474 if b then findTempName tmp_dir (x+1)
475 else do add v_FilesToClean filename -- clean it up later
478 addFilesToClean :: [FilePath] -> IO ()
479 -- May include wildcards [used by DriverPipeline.run_phase SplitMangle]
480 addFilesToClean files = mapM_ (add v_FilesToClean) files
482 removeTmpFiles :: Int -> [FilePath] -> IO ()
483 removeTmpFiles verb fs
484 = traceCmd "Deleting temp files"
485 ("Deleting: " ++ unwords fs)
488 rm f = removeFile f `catchAllIO`
489 (\exn -> hPutStrLn stderr ("Warning: deleting non-existent " ++ f) >>
495 %************************************************************************
497 \subsection{Running a program}
499 %************************************************************************
502 GLOBAL_VAR(v_Dry_run, False, Bool)
505 setDryRun = writeIORef v_Dry_run True
507 -----------------------------------------------------------------------------
508 -- Running an external program
510 runSomething :: String -- For -v message
511 -> String -- Command name (possibly a full path)
512 -- assumed already dos-ified
513 -> [String] -- Arguments
514 -- runSomething will dos-ify them
517 runSomething phase_name pgm args
518 = traceCmd phase_name cmd_line $
519 do { exit_code <- system cmd_line
520 ; if exit_code /= ExitSuccess
521 then throwDyn (PhaseFailed phase_name exit_code)
525 cmd_line = unwords (pgm : dosifyPaths args)
526 -- The pgm is already in native format
528 traceCmd :: String -> String -> IO () -> IO ()
529 -- a) trace the command (at two levels of verbosity)
530 -- b) don't do it at all if dry-run is set
531 traceCmd phase_name cmd_line action
532 = do { verb <- dynFlag verbosity
533 ; when (verb >= 2) $ hPutStrLn stderr ("*** " ++ phase_name)
534 ; when (verb >= 3) $ hPutStrLn stderr cmd_line
538 ; n <- readIORef v_Dry_run
542 ; action `catchAllIO` handle_exn verb
545 handle_exn verb exn = do { when (verb >= 2) (hPutStr stderr "\n")
546 ; when (verb >= 3) (hPutStrLn stderr ("Failed: " ++ cmd_line))
547 ; throwDyn (PhaseFailed phase_name (ExitFailure 1)) }
551 %************************************************************************
553 \subsection{Path names}
555 %************************************************************************
557 We maintain path names in Unix form ('/'-separated) right until
558 the last moment. On Windows we dos-ify them just before passing them
559 to the Windows command.
561 The alternative, of using '/' consistently on Unix and '\' on Windows,
562 proved quite awkward. There were a lot more calls to dosifyPath,
563 and even on Windows we might invoke a unix-like utility (eg 'sh'), which
564 interpreted a command line 'foo\baz' as 'foobaz'.
567 -----------------------------------------------------------------------------
568 -- Convert filepath into MSDOS form.
570 dosifyPaths :: [String] -> [String]
571 -- dosifyPaths does two things
572 -- a) change '/' to '\'
573 -- b) remove initial '/cygdrive/'
575 unDosifyPath :: String -> String
576 -- Just change '\' to '/'
578 pgmPath :: String -- Directory string in Unix format
579 -> String -- Program name with no directory separators
581 -> String -- Program invocation string in native format
585 #if defined(mingw32_TARGET_OS)
587 --------------------- Windows version ------------------
590 dosifyPaths xs = map dosifyPath xs
592 pgmPath dir pgm = dosifyPath dir ++ '\\' : pgm
595 = subst '/' '\\' real_stuff
597 -- fully convince myself that /cygdrive/ prefixes cannot
598 -- really appear here.
599 cygdrive_prefix = "/cygdrive/"
602 | cygdrive_prefix `isPrefixOf` stuff = drop (length cygdrive_prefix) stuff
607 --------------------- Unix version ---------------------
609 unDosifyPath xs = subst '\\' '/' xs
610 pgmPath dir pgm = dir ++ '/' : pgm
611 --------------------------------------------------------
614 subst a b ls = map (\ x -> if x == a then b else x) ls
618 -----------------------------------------------------------------------------
619 Path name construction
622 slash :: String -> String -> String
623 absPath, relPath :: [String] -> String
626 isSlash other = False
629 relPath xs = foldr1 slash xs
631 absPath xs = "" `slash` relPath xs
633 slash s1 s2 = s1 ++ ('/' : s2)
637 %************************************************************************
639 \subsection{Support code}
641 %************************************************************************
644 -----------------------------------------------------------------------------
645 -- Define myGetProcessId :: IO Int
646 -- getExecDir :: IO (Maybe String)
648 #ifdef mingw32_TARGET_OS
649 foreign import "_getpid" getProcessID :: IO Int -- relies on Int == Int32 on Windows
651 #if __GLASGOW_HASKELL__ >= 500
652 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> CString -> IO Int32
653 getExecDir :: IO (Maybe String)
654 getExecDir = do len <- getCurrentDirectory 0 nullAddr
655 buf <- mallocArray (fromIntegral len)
656 ret <- getCurrentDirectory len buf
657 if ret == 0 then return Nothing
658 else do s <- peekCString buf
659 destructArray (fromIntegral len) buf
662 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> Addr -> IO Int32
663 getExecDir :: IO (Maybe String)
664 getExecDir = do len <- getCurrentDirectory 0 nullAddr
665 buf <- malloc (fromIntegral len)
666 ret <- getCurrentDirectory len buf
667 if ret == 0 then return Nothing
668 else do s <- unpackCStringIO buf
673 getProcessID :: IO Int
674 getProcessID = Posix.getProcessID
675 getExecDir :: IO (Maybe String) = do return Nothing