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 )
62 #if __GLASGOW_HASKELL__ < 500
68 #include "../includes/config.h"
70 #if !defined(mingw32_TARGET_OS)
71 import qualified Posix
73 import Addr ( nullAddr )
74 import List ( isPrefixOf )
77 #include "HsVersions.h"
79 {-# DEPRECATED runSomething "runSomething should be private to SysTools" #-}
84 The configuration story
85 ~~~~~~~~~~~~~~~~~~~~~~~
87 GHC needs various support files (library packages, RTS etc), plus
88 various auxiliary programs (cp, gcc, etc). It finds these in one
91 * When running as an *installed program*, GHC finds most of this support
92 stuff in the installed library tree. The path to this tree is passed
93 to GHC via the -B flag, and given to initSysTools .
95 * When running *in-place* in a build tree, GHC finds most of this support
96 stuff in the build tree. The path to the build tree is, again passed
99 GHC tells which of the two is the case by seeing whether package.conf
100 is in TopDir [installed] or in TopDir/ghc/driver [inplace] (what a hack).
103 SysTools.initSysProgs figures out exactly where all the auxiliary programs
104 are, and initialises mutable variables to make it easy to call them.
105 To to this, it makes use of definitions in Config.hs, which is a Haskell
106 file containing variables whose value is figured out by the build system.
108 Config.hs contains two sorts of things
110 cGCC, The *names* of the programs
113 etc They do *not* include paths
116 cUNLIT_DIR The *path* to the directory containing unlit, split etc
117 cSPLIT_DIR *relative* to the root of the build tree,
118 for use when running *in-place* in a build tree (only)
122 %************************************************************************
124 \subsection{Global variables to contain system programs}
126 %************************************************************************
128 All these pathnames are maintained IN THE NATIVE FORMAT OF THE HOST MACHINE.
129 (See remarks under pathnames below)
132 GLOBAL_VAR(v_Pgm_L, error "pgm_L", String) -- unlit
133 GLOBAL_VAR(v_Pgm_P, error "pgm_P", String) -- cpp
134 GLOBAL_VAR(v_Pgm_c, error "pgm_c", String) -- gcc
135 GLOBAL_VAR(v_Pgm_m, error "pgm_m", String) -- asm code mangler
136 GLOBAL_VAR(v_Pgm_s, error "pgm_s", String) -- asm code splitter
137 GLOBAL_VAR(v_Pgm_a, error "pgm_a", String) -- as
138 GLOBAL_VAR(v_Pgm_l, error "pgm_l", String) -- ld
139 GLOBAL_VAR(v_Pgm_MkDLL, error "pgm_dll", String) -- mkdll
141 GLOBAL_VAR(v_Pgm_T, error "pgm_T", String) -- touch
142 GLOBAL_VAR(v_Pgm_CP, error "pgm_CP", String) -- cp
144 GLOBAL_VAR(v_Path_package_config, error "path_package_config", String)
145 GLOBAL_VAR(v_Path_usage, error "ghc_usage.txt", String)
147 -- Parallel system only
148 GLOBAL_VAR(v_Pgm_sysman, error "pgm_sysman", String) -- system manager
152 %************************************************************************
154 \subsection{Initialisation}
156 %************************************************************************
159 initSysTools :: [String] -- Command-line arguments starting "-B"
161 -> IO String -- Set all the mutable variables above, holding
162 -- (a) the system programs
163 -- (b) the package-config file
164 -- (c) the GHC usage message
168 initSysTools minusB_args
169 = do { (am_installed, top_dir) <- getTopDir minusB_args
171 -- for "installed" this is the root of GHC's support files
172 -- for "in-place" it is the root of the build tree
173 -- NB: top_dir is assumed to be in standard Unix format '/' separated
175 ; let installed_bin pgm = pgmPath (top_dir `slash` "bin") pgm
176 installed file = pgmPath top_dir file
177 inplace dir pgm = pgmPath (top_dir `slash` dir) pgm
180 | am_installed = installed "package.conf"
181 | otherwise = inplace cGHC_DRIVER_DIR "package.conf.inplace"
184 | am_installed = installed "ghc-usage.txt"
185 | otherwise = inplace cGHC_DRIVER_DIR "ghc-usage.txt"
187 -- For all systems, unlit, split, mangle are GHC utilities
188 -- architecture-specific stuff is done when building Config.hs
190 | am_installed = installed_bin cGHC_UNLIT
191 | otherwise = inplace cGHC_UNLIT_DIR cGHC_UNLIT
193 -- split and mangle are Perl scripts
195 | am_installed = installed_bin cGHC_SPLIT
196 | otherwise = inplace cGHC_SPLIT_DIR cGHC_SPLIT
199 | am_installed = installed_bin cGHC_MANGLER
200 | otherwise = inplace cGHC_MANGLER_DIR cGHC_MANGLER
202 -- Check that the package config exists
203 ; config_exists <- doesFileExist pkgconfig_path
204 ; when (not config_exists) $
205 throwDyn (InstallationError
206 ("Can't find package.conf in " ++ pkgconfig_path))
208 #if defined(mingw32_TARGET_OS)
209 -- WINDOWS-SPECIFIC STUFF
210 -- On Windows, gcc and friends are distributed with GHC,
211 -- so when "installed" we look in TopDir/bin
212 -- When "in-place" we look wherever the build-time configure
214 ; let cpp_path | am_installed = installed cRAWCPP
215 | otherwise = cRAWCPP
216 gcc_path | am_installed = installed cGCC
218 perl_path | am_installed = installed cGHC_PERL
219 | otherwise = cGHC_PERL
221 -- 'touch' is a GHC util for Windows, and similarly unlit, mangle
222 ; let touch_path | am_installed = installed cGHC_TOUCHY
223 | otherwise = inplace cGHC_TOUCHY_DIR cGHC_TOUCHY
225 -- On Win32 we don't want to rely on #!/bin/perl, so we prepend
226 -- a call to Perl to get the invocation of split and mangle
227 ; let split_path = perl_path ++ " " ++ split_script
228 mangle_path = perl_path ++ " " ++ mangle_script
230 ; let mkdll_path = cMKDLL
232 -- UNIX-SPECIFIC STUFF
233 -- On Unix, the "standard" tools are assumed to be
234 -- in the same place whether we are running "in-place" or "installed"
235 -- That place is wherever the build-time configure script found them.
236 ; let cpp_path = cRAWCPP
238 touch_path = cGHC_TOUCHY
239 mkdll_path = panic "Can't build DLLs on a non-Win32 system"
241 -- On Unix, scripts are invoked using the '#!' method. Binary
242 -- installations of GHC on Unix place the correct line on the front
243 -- of the script at installation time, so we don't want to wire-in
244 -- our knowledge of $(PERL) on the host system here.
245 ; let split_path = split_script
246 mangle_path = mangle_script
250 -- For all systems, copy and remove are provided by the host
251 -- system; architecture-specific stuff is done when building Config.hs
252 ; let cp_path = cGHC_CP
254 -- Other things being equal, as and ld are simply gcc
255 ; let as_path = gcc_path
259 -- Initialise the global vars
260 ; writeIORef v_Path_package_config pkgconfig_path
261 ; writeIORef v_Path_usage ghc_usage_msg_path
263 ; writeIORef v_Pgm_sysman (top_dir ++ "/ghc/rts/parallel/SysMan")
264 -- Hans: this isn't right in general, but you can
265 -- elaborate it in the same way as the others
267 ; writeIORef v_Pgm_L unlit_path
268 ; writeIORef v_Pgm_P cpp_path
269 ; writeIORef v_Pgm_c gcc_path
270 ; writeIORef v_Pgm_m mangle_path
271 ; writeIORef v_Pgm_s split_path
272 ; writeIORef v_Pgm_a as_path
273 ; writeIORef v_Pgm_l ld_path
274 ; writeIORef v_Pgm_MkDLL mkdll_path
275 ; writeIORef v_Pgm_T touch_path
276 ; writeIORef v_Pgm_CP cp_path
282 setPgm is called when a command-line option like
284 is used to override a particular program with a new onw
287 setPgm :: String -> IO ()
288 -- The string is the flag, minus the '-pgm' prefix
289 -- So the first character says which program to override
291 setPgm ('P' : pgm) = writeIORef v_Pgm_P pgm
292 setPgm ('c' : pgm) = writeIORef v_Pgm_c pgm
293 setPgm ('m' : pgm) = writeIORef v_Pgm_m pgm
294 setPgm ('s' : pgm) = writeIORef v_Pgm_s pgm
295 setPgm ('a' : pgm) = writeIORef v_Pgm_a pgm
296 setPgm ('l' : pgm) = writeIORef v_Pgm_l pgm
297 setPgm pgm = unknownFlagErr ("-pgm" ++ pgm)
303 -- for "installed" this is the root of GHC's support files
304 -- for "in-place" it is the root of the build tree
307 -- 1. Set proto_top_dir
308 -- a) look for (the last) -B flag, and use it
309 -- b) if there are no -B flags, get the directory
310 -- where GHC is running
312 -- 2. If package.conf exists in proto_top_dir, we are running
313 -- installed; and TopDir = proto_top_dir
315 -- 3. Otherwise we are running in-place, so
316 -- proto_top_dir will be /...stuff.../ghc/compiler
317 -- Set TopDir to /...stuff..., which is the root of the build tree
319 -- This is very gruesome indeed
321 getTopDir :: [String]
322 -> IO (Bool, -- True <=> am installed, False <=> in-place
323 String) -- TopDir (in Unix format '/' separated)
326 = do { top_dir1 <- get_proto
327 ; let top_dir2 = unDosifyPath top_dir1 -- Convert to standard internal form
329 -- Discover whether we're running in a build tree or in an installation,
330 -- by looking for the package configuration file.
331 ; am_installed <- doesFileExist (top_dir2 `slash` "package.conf")
333 ; if am_installed then
334 return (True, top_dir2)
336 return (False, remove_suffix top_dir2)
339 get_proto | not (null minusbs)
340 = return (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 dir
349 remove_suffix dir -- "/...stuff.../ghc/compiler" --> "/...stuff..."
350 = ASSERT2( not (null p1) &&
352 dir == top_dir ++ "/ghc/compiler",
356 p1 = dropWhile (not . isSlash) (reverse dir)
357 p2 = dropWhile (not . isSlash) (tail p1) -- head is '/'
358 top_dir = reverse (tail p2) -- head is '/'
362 %************************************************************************
364 \subsection{Running an external program}
366 %************************************************************************
370 runUnlit :: [String] -> IO ()
371 runUnlit args = do p <- readIORef v_Pgm_L
372 runSomething "Literate pre-processor" p args
374 runCpp :: [String] -> IO ()
375 runCpp args = do p <- readIORef v_Pgm_P
376 runSomething "C pre-processor" p args
378 runCc :: [String] -> IO ()
379 runCc args = do p <- readIORef v_Pgm_c
380 runSomething "C Compiler" p args
382 runMangle :: [String] -> IO ()
383 runMangle args = do p <- readIORef v_Pgm_m
384 runSomething "Mangler" p args
386 runSplit :: [String] -> IO ()
387 runSplit args = do p <- readIORef v_Pgm_s
388 runSomething "Splitter" p args
390 runAs :: [String] -> IO ()
391 runAs args = do p <- readIORef v_Pgm_a
392 runSomething "Assembler" p args
394 runLink :: [String] -> IO ()
395 runLink args = do p <- readIORef v_Pgm_l
396 runSomething "Linker" p args
398 runMkDLL :: [String] -> IO ()
399 runMkDLL args = do p <- readIORef v_Pgm_MkDLL
400 runSomething "Make DLL" p args
402 touch :: String -> String -> IO ()
403 touch purpose arg = do p <- readIORef v_Pgm_T
404 runSomething purpose p [arg]
406 copy :: String -> String -> String -> IO ()
407 copy purpose from to = do p <- readIORef v_Pgm_CP
408 runSomething purpose p [from,to]
412 getSysMan :: IO String -- How to invoke the system manager
413 -- (parallel system only)
414 getSysMan = readIORef v_Pgm_sysman
417 %************************************************************************
419 \subsection{GHC Usage message}
421 %************************************************************************
423 Show the usage message and exit
426 showGhcUsage = do { usage_path <- readIORef v_Path_usage
427 ; usage <- readFile usage_path
429 ; exitWith ExitSuccess }
432 dump ('$':'$':s) = hPutStr stderr progName >> dump s
433 dump (c:s) = hPutChar stderr c >> dump s
435 packageConfigPath = readIORef v_Path_package_config
439 %************************************************************************
441 \subsection{Managing temporary files
443 %************************************************************************
446 GLOBAL_VAR(v_FilesToClean, [], [String] )
447 GLOBAL_VAR(v_TmpDir, cDEFAULT_TMPDIR, String )
448 -- v_TmpDir has no closing '/'
452 setTmpDir dir = writeIORef v_TmpDir dir
454 cleanTempFiles :: Int -> IO ()
455 cleanTempFiles verb = do fs <- readIORef v_FilesToClean
456 removeTmpFiles verb fs
458 cleanTempFilesExcept :: Int -> [FilePath] -> IO ()
459 cleanTempFilesExcept verb dont_delete
460 = do fs <- readIORef v_FilesToClean
461 let leftovers = filter (`notElem` dont_delete) fs
462 removeTmpFiles verb leftovers
463 writeIORef v_FilesToClean dont_delete
466 -- find a temporary name that doesn't already exist.
467 newTempName :: Suffix -> IO FilePath
469 = do x <- getProcessID
470 tmp_dir <- readIORef v_TmpDir
471 findTempName tmp_dir x
473 findTempName tmp_dir x
474 = do let filename = tmp_dir ++ "/ghc" ++ show x ++ '.':extn
475 b <- doesFileExist filename
476 if b then findTempName tmp_dir (x+1)
477 else do add v_FilesToClean filename -- clean it up later
480 addFilesToClean :: [FilePath] -> IO ()
481 -- May include wildcards [used by DriverPipeline.run_phase SplitMangle]
482 addFilesToClean files = mapM_ (add v_FilesToClean) files
484 removeTmpFiles :: Int -> [FilePath] -> IO ()
485 removeTmpFiles verb fs
486 = traceCmd "Deleting temp files"
487 ("Deleting: " ++ unwords fs)
490 rm f = removeFile f `catchAllIO`
491 (\exn -> hPutStrLn stderr ("Warning: deleting non-existent " ++ f) >>
497 %************************************************************************
499 \subsection{Running a program}
501 %************************************************************************
504 GLOBAL_VAR(v_Dry_run, False, Bool)
507 setDryRun = writeIORef v_Dry_run True
509 -----------------------------------------------------------------------------
510 -- Running an external program
512 runSomething :: String -- For -v message
513 -> String -- Command name (possibly a full path)
514 -- assumed already dos-ified
515 -> [String] -- Arguments
516 -- runSomething will dos-ify them
519 runSomething phase_name pgm args
520 = traceCmd phase_name cmd_line $
521 do { exit_code <- system cmd_line
522 ; if exit_code /= ExitSuccess
523 then throwDyn (PhaseFailed phase_name exit_code)
527 cmd_line = unwords (pgm : dosifyPaths args)
528 -- The pgm is already in native format
530 traceCmd :: String -> String -> IO () -> IO ()
531 -- a) trace the command (at two levels of verbosity)
532 -- b) don't do it at all if dry-run is set
533 traceCmd phase_name cmd_line action
534 = do { verb <- dynFlag verbosity
535 ; when (verb >= 2) $ hPutStrLn stderr ("*** " ++ phase_name)
536 ; when (verb >= 3) $ hPutStrLn stderr cmd_line
540 ; n <- readIORef v_Dry_run
544 ; action `catchAllIO` handle_exn verb
547 handle_exn verb exn = do { when (verb >= 2) (hPutStr stderr "\n")
548 ; when (verb >= 3) (hPutStrLn stderr ("Failed: " ++ cmd_line))
549 ; throwDyn (PhaseFailed phase_name (ExitFailure 1)) }
553 %************************************************************************
555 \subsection{Path names}
557 %************************************************************************
559 We maintain path names in Unix form ('/'-separated) right until
560 the last moment. On Windows we dos-ify them just before passing them
561 to the Windows command.
563 The alternative, of using '/' consistently on Unix and '\' on Windows,
564 proved quite awkward. There were a lot more calls to dosifyPath,
565 and even on Windows we might invoke a unix-like utility (eg 'sh'), which
566 interpreted a command line 'foo\baz' as 'foobaz'.
569 -----------------------------------------------------------------------------
570 -- Convert filepath into MSDOS form.
572 dosifyPaths :: [String] -> [String]
573 -- dosifyPaths does two things
574 -- a) change '/' to '\'
575 -- b) remove initial '/cygdrive/'
577 unDosifyPath :: String -> String
578 -- Just change '\' to '/'
580 pgmPath :: String -- Directory string in Unix format
581 -> String -- Program name with no directory separators
583 -> String -- Program invocation string in native format
587 #if defined(mingw32_TARGET_OS)
589 --------------------- Windows version ------------------
592 dosifyPaths xs = map dosifyPath xs
594 pgmPath dir pgm = dosifyPath dir ++ '\\' : pgm
597 = subst '/' '\\' real_stuff
599 -- fully convince myself that /cygdrive/ prefixes cannot
600 -- really appear here.
601 cygdrive_prefix = "/cygdrive/"
604 | cygdrive_prefix `isPrefixOf` stuff = drop (length cygdrive_prefix) stuff
609 --------------------- Unix version ---------------------
611 unDosifyPath xs = subst '\\' '/' xs
612 pgmPath dir pgm = dir ++ '/' : pgm
613 --------------------------------------------------------
616 subst a b ls = map (\ x -> if x == a then b else x) ls
620 -----------------------------------------------------------------------------
621 Path name construction
624 slash :: String -> String -> String
625 absPath, relPath :: [String] -> String
628 isSlash other = False
631 relPath xs = foldr1 slash xs
633 absPath xs = "" `slash` relPath xs
635 slash s1 s2 = s1 ++ ('/' : s2)
639 %************************************************************************
641 \subsection{Support code}
643 %************************************************************************
646 -----------------------------------------------------------------------------
647 -- Define myGetProcessId :: IO Int
648 -- getExecDir :: IO (Maybe String)
650 #ifdef mingw32_TARGET_OS
651 foreign import "_getpid" getProcessID :: IO Int -- relies on Int == Int32 on Windows
653 #if __GLASGOW_HASKELL__ >= 500
654 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> CString -> IO Int32
655 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectoryLen :: Int32 -> Addr -> IO Int32
656 getExecDir :: IO (Maybe String)
657 getExecDir = do len <- getCurrentDirectoryLen 0 nullAddr
658 buf <- mallocArray (fromIntegral len)
659 ret <- getCurrentDirectory len buf
660 if ret == 0 then return Nothing
661 else do s <- peekCString buf
662 destructArray (fromIntegral len) buf
665 foreign import stdcall "GetCurrentDirectoryA" getCurrentDirectory :: Int32 -> Addr -> IO Int32
666 getExecDir :: IO (Maybe String)
667 getExecDir = do len <- getCurrentDirectory 0 nullAddr
668 buf <- malloc (fromIntegral len)
669 ret <- getCurrentDirectory len buf
670 if ret == 0 then return Nothing
671 else do s <- unpackCStringIO buf
676 getProcessID :: IO Int
677 getProcessID = Posix.getProcessID
678 getExecDir :: IO (Maybe String) = do return Nothing