1 -----------------------------------------------------------------------------
3 -- (c) The University of Glasgow 2001-2003
5 -- Access to system tools: gcc, cp, rm etc
7 -----------------------------------------------------------------------------
14 -- Interface to system tools
15 runUnlit, runCpp, runCc, -- [Option] -> IO ()
16 runPp, -- [Option] -> IO ()
17 runMangle, runSplit, -- [Option] -> IO ()
18 runAs, runLink, -- [Option] -> IO ()
21 touch, -- String -> String -> IO ()
24 normalisePath, -- FilePath -> FilePath
26 -- Temporary-file management
29 cleanTempDirs, cleanTempFiles, cleanTempFilesExcept,
36 #include "HsVersions.h"
47 import Control.Exception
51 import System.Environment
53 import SYSTEM_IO_ERROR as IO
54 import System.Directory
59 #ifndef mingw32_HOST_OS
60 #if __GLASGOW_HASKELL__ > 504
61 import qualified System.Posix.Internals
63 import qualified Posix
65 #else /* Must be Win32 */
67 import CString ( CString, peekCString )
70 #if __GLASGOW_HASKELL__ < 603
71 -- rawSystem comes from libghccompat.a in stage1
72 import Compat.RawSystem ( rawSystem )
73 import System.Cmd ( system )
74 import GHC.IOBase ( IOErrorType(..) )
76 import System.Process ( runInteractiveProcess, getProcessExitCode )
77 import Control.Concurrent( forkIO, newChan, readChan, writeChan )
78 import Data.Char ( isSpace )
79 import FastString ( mkFastString )
80 import SrcLoc ( SrcLoc, mkSrcLoc, noSrcSpan, mkSrcSpan )
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_REL The *path* to the directory containing unlit, split etc
118 cSPLIT_DIR_REL *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${topdir}/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 ---------------------------------------------
146 %************************************************************************
148 \subsection{Initialisation}
150 %************************************************************************
153 initSysTools :: Maybe String -- Maybe TopDir path (without the '-B' prefix)
156 -> IO DynFlags -- Set all the mutable variables above, holding
157 -- (a) the system programs
158 -- (b) the package-config file
159 -- (c) the GHC usage message
162 initSysTools mbMinusB dflags
163 = do { (am_installed, top_dir) <- findTopDir mbMinusB
165 -- for "installed" this is the root of GHC's support files
166 -- for "in-place" it is the root of the build tree
167 -- NB: top_dir is assumed to be in standard Unix
168 -- format, '/' separated
170 ; let installed, installed_bin :: FilePath -> FilePath
171 installed_bin pgm = pgmPath top_dir pgm
172 installed file = pgmPath top_dir file
173 inplace dir pgm = pgmPath (top_dir `joinFileName`
174 cPROJECT_DIR `joinFileName` dir) pgm
177 | am_installed = installed "package.conf"
178 | otherwise = inplace cGHC_DRIVER_DIR_REL "package.conf.inplace"
181 | am_installed = installed "ghc-usage.txt"
182 | otherwise = inplace cGHC_DRIVER_DIR_REL "ghc-usage.txt"
185 | am_installed = installed "ghci-usage.txt"
186 | otherwise = inplace cGHC_DRIVER_DIR_REL "ghci-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_PGM
192 | otherwise = inplace cGHC_UNLIT_DIR_REL cGHC_UNLIT_PGM
194 -- split and mangle are Perl scripts
196 | am_installed = installed_bin cGHC_SPLIT_PGM
197 | otherwise = inplace cGHC_SPLIT_DIR_REL cGHC_SPLIT_PGM
200 | am_installed = installed_bin cGHC_MANGLER_PGM
201 | otherwise = inplace cGHC_MANGLER_DIR_REL cGHC_MANGLER_PGM
203 ; let dflags0 = defaultDynFlags
204 #ifndef mingw32_HOST_OS
205 -- check whether TMPDIR is set in the environment
206 ; e_tmpdir <- IO.try (getEnv "TMPDIR") -- fails if not set
208 -- On Win32, consult GetTempPath() for a temp dir.
209 -- => it first tries TMP, TEMP, then finally the
210 -- Windows directory(!). The directory is in short-path
214 let len = (2048::Int)
215 buf <- mallocArray len
216 ret <- getTempPath len buf
218 -- failed, consult TMPDIR.
226 ; let dflags1 = case e_tmpdir of
228 Right d -> setTmpDir d dflags0
230 -- Check that the package config exists
231 ; config_exists <- doesFileExist pkgconfig_path
232 ; when (not config_exists) $
233 throwDyn (InstallationError
234 ("Can't find package.conf as " ++ pkgconfig_path))
236 #if defined(mingw32_HOST_OS)
237 -- WINDOWS-SPECIFIC STUFF
238 -- On Windows, gcc and friends are distributed with GHC,
239 -- so when "installed" we look in TopDir/bin
240 -- When "in-place" we look wherever the build-time configure
242 -- When "install" we tell gcc where its specs file + exes are (-B)
243 -- and also some places to pick up include files. We need
244 -- to be careful to put all necessary exes in the -B place
245 -- (as, ld, cc1, etc) since if they don't get found there, gcc
246 -- then tries to run unadorned "as", "ld", etc, and will
247 -- pick up whatever happens to be lying around in the path,
248 -- possibly including those from a cygwin install on the target,
249 -- which is exactly what we're trying to avoid.
250 ; let gcc_b_arg = Option ("-B" ++ installed "gcc-lib/")
252 | am_installed = (installed_bin "gcc", [gcc_b_arg])
253 | otherwise = (cGCC, [])
254 -- The trailing "/" is absolutely essential; gcc seems
255 -- to construct file names simply by concatenating to
256 -- this -B path with no extra slash We use "/" rather
257 -- than "\\" because otherwise "\\\" is mangled
258 -- later on; although gcc_args are in NATIVE format,
260 -- (see comments with declarations of global variables)
262 -- The quotes round the -B argument are in case TopDir
265 perl_path | am_installed = installed_bin cGHC_PERL
266 | otherwise = cGHC_PERL
268 -- 'touch' is a GHC util for Windows, and similarly unlit, mangle
269 ; let touch_path | am_installed = installed_bin cGHC_TOUCHY_PGM
270 | otherwise = inplace cGHC_TOUCHY_DIR_REL cGHC_TOUCHY_PGM
272 -- On Win32 we don't want to rely on #!/bin/perl, so we prepend
273 -- a call to Perl to get the invocation of split and mangle
274 ; let (split_prog, split_args) = (perl_path, [Option split_script])
275 (mangle_prog, mangle_args) = (perl_path, [Option mangle_script])
277 ; let (mkdll_prog, mkdll_args)
279 (pgmPath (installed "gcc-lib/") cMKDLL,
280 [ Option "--dlltool-name",
281 Option (pgmPath (installed "gcc-lib/") "dlltool"),
282 Option "--driver-name",
283 Option gcc_prog, gcc_b_arg ])
284 | otherwise = (cMKDLL, [])
286 -- UNIX-SPECIFIC STUFF
287 -- On Unix, the "standard" tools are assumed to be
288 -- in the same place whether we are running "in-place" or "installed"
289 -- That place is wherever the build-time configure script found them.
290 ; let gcc_prog = cGCC
293 mkdll_prog = panic "Can't build DLLs on a non-Win32 system"
296 -- On Unix, scripts are invoked using the '#!' method. Binary
297 -- installations of GHC on Unix place the correct line on the front
298 -- of the script at installation time, so we don't want to wire-in
299 -- our knowledge of $(PERL) on the host system here.
300 ; let (split_prog, split_args) = (split_script, [])
301 (mangle_prog, mangle_args) = (mangle_script, [])
304 -- cpp is derived from gcc on all platforms
305 -- HACK, see setPgmP below. We keep 'words' here to remember to fix
306 -- Config.hs one day.
307 ; let cpp_path = (gcc_prog, gcc_args ++
308 (Option "-E"):(map Option (words cRAWCPP_FLAGS)))
310 -- For all systems, copy and remove are provided by the host
311 -- system; architecture-specific stuff is done when building Config.hs
312 ; let cp_path = cGHC_CP
314 -- Other things being equal, as and ld are simply gcc
315 ; let (as_prog,as_args) = (gcc_prog,gcc_args)
316 (ld_prog,ld_args) = (gcc_prog,gcc_args)
319 ghcUsagePath = ghc_usage_msg_path,
320 ghciUsagePath = ghci_usage_msg_path,
322 systemPackageConfig = pkgconfig_path,
326 pgm_c = (gcc_prog,gcc_args),
327 pgm_m = (mangle_prog,mangle_args),
328 pgm_s = (split_prog,split_args),
329 pgm_a = (as_prog,as_args),
330 pgm_l = (ld_prog,ld_args),
331 pgm_dll = (mkdll_prog,mkdll_args),
333 pgm_sysman = top_dir ++ "/ghc/rts/parallel/SysMan"
334 -- Hans: this isn't right in general, but you can
335 -- elaborate it in the same way as the others
339 #if defined(mingw32_HOST_OS)
340 foreign import stdcall unsafe "GetTempPathA" getTempPath :: Int -> CString -> IO Int32
346 -- for "installed" this is the root of GHC's support files
347 -- for "in-place" it is the root of the build tree
350 -- 1. Set proto_top_dir
351 -- if there is no given TopDir path, get the directory
352 -- where GHC is running (only on Windows)
354 -- 2. If package.conf exists in proto_top_dir, we are running
355 -- installed; and TopDir = proto_top_dir
357 -- 3. Otherwise we are running in-place, so
358 -- proto_top_dir will be /...stuff.../ghc/compiler
359 -- Set TopDir to /...stuff..., which is the root of the build tree
361 -- This is very gruesome indeed
363 findTopDir :: Maybe String -- Maybe TopDir path (without the '-B' prefix).
364 -> IO (Bool, -- True <=> am installed, False <=> in-place
365 String) -- TopDir (in Unix format '/' separated)
368 = do { top_dir <- get_proto
369 -- Discover whether we're running in a build tree or in an installation,
370 -- by looking for the package configuration file.
371 ; am_installed <- doesFileExist (top_dir `joinFileName` "package.conf")
373 ; return (am_installed, top_dir)
376 -- get_proto returns a Unix-format path (relying on getBaseDir to do so too)
377 get_proto = case mbMinusB of
378 Just minusb -> return (normalisePath minusb)
380 -> do maybe_exec_dir <- getBaseDir -- Get directory of executable
381 case maybe_exec_dir of -- (only works on Windows;
382 -- returns Nothing on Unix)
383 Nothing -> throwDyn (InstallationError "missing -B<dir> option")
384 Just dir -> return dir
388 %************************************************************************
390 \subsection{Running an external program}
392 %************************************************************************
396 runUnlit :: DynFlags -> [Option] -> IO ()
397 runUnlit dflags args = do
399 runSomething dflags "Literate pre-processor" p args
401 runCpp :: DynFlags -> [Option] -> IO ()
402 runCpp dflags args = do
403 let (p,args0) = pgm_P dflags
404 runSomething dflags "C pre-processor" p (args0 ++ args)
406 runPp :: DynFlags -> [Option] -> IO ()
407 runPp dflags args = do
409 runSomething dflags "Haskell pre-processor" p args
411 runCc :: DynFlags -> [Option] -> IO ()
412 runCc dflags args = do
413 let (p,args0) = pgm_c dflags
414 args1 = args0 ++ args
415 mb_env <- getGccEnv args1
416 runSomethingFiltered dflags cc_filter "C Compiler" p args1 mb_env
418 -- discard some harmless warnings from gcc that we can't turn off
419 cc_filter = unlines . doFilter . lines
422 gcc gives warnings in chunks like so:
423 In file included from /foo/bar/baz.h:11,
424 from /foo/bar/baz2.h:22,
426 /foo/flibble:14: global register variable ...
427 /foo/flibble:15: warning: call-clobbered r...
428 We break it up into its chunks, remove any call-clobbered register
429 warnings from each chunk, and then delete any chunks that we have
432 doFilter = unChunkWarnings . filterWarnings . chunkWarnings []
433 -- We can't assume that the output will start with an "In file inc..."
434 -- line, so we start off expecting a list of warnings rather than a
436 chunkWarnings :: [String] -- The location stack to use for the next
438 -> [String] -- The remaining lines to look at
439 -> [([String], [String])]
440 chunkWarnings loc_stack [] = [(loc_stack, [])]
441 chunkWarnings loc_stack xs
442 = case break loc_stack_start xs of
443 (warnings, lss:xs') ->
444 case span loc_start_continuation xs' of
446 (loc_stack, warnings) : chunkWarnings (lss : lsc) xs''
447 _ -> [(loc_stack, xs)]
449 filterWarnings :: [([String], [String])] -> [([String], [String])]
450 filterWarnings [] = []
451 -- If the warnings are already empty then we are probably doing
452 -- something wrong, so don't delete anything
453 filterWarnings ((xs, []) : zs) = (xs, []) : filterWarnings zs
454 filterWarnings ((xs, ys) : zs) = case filter wantedWarning ys of
455 [] -> filterWarnings zs
456 ys' -> (xs, ys') : filterWarnings zs
458 unChunkWarnings :: [([String], [String])] -> [String]
459 unChunkWarnings [] = []
460 unChunkWarnings ((xs, ys) : zs) = xs ++ ys ++ unChunkWarnings zs
462 loc_stack_start s = "In file included from " `isPrefixOf` s
463 loc_start_continuation s = " from " `isPrefixOf` s
465 | "warning: call-clobbered register used" `isContainedIn` w = False
468 isContainedIn :: String -> String -> Bool
469 xs `isContainedIn` ys = any (xs `isPrefixOf`) (tails ys)
471 -- If the -B<dir> option is set, add <dir> to PATH. This works around
472 -- a bug in gcc on Windows Vista where it can't find its auxiliary
473 -- binaries (see bug #1110).
474 getGccEnv :: [Option] -> IO (Maybe [(String,String)])
476 #if __GLASGOW_HASKELL__ < 603
481 else do env <- getEnvironment
482 return (Just (map mangle_path env))
484 (b_dirs, _) = partitionWith get_b_opt opts
486 get_b_opt (Option ('-':'B':dir)) = Left dir
487 get_b_opt other = Right other
489 mangle_path ("PATH",paths) = ("PATH", '\"' : head b_dirs ++ "\";" ++ paths)
490 mangle_path other = other
493 runMangle :: DynFlags -> [Option] -> IO ()
494 runMangle dflags args = do
495 let (p,args0) = pgm_m dflags
496 runSomething dflags "Mangler" p (args0++args)
498 runSplit :: DynFlags -> [Option] -> IO ()
499 runSplit dflags args = do
500 let (p,args0) = pgm_s dflags
501 runSomething dflags "Splitter" p (args0++args)
503 runAs :: DynFlags -> [Option] -> IO ()
504 runAs dflags args = do
505 let (p,args0) = pgm_a dflags
506 args1 = args0 ++ args
507 mb_env <- getGccEnv args1
508 runSomethingFiltered dflags id "Assembler" p args1 mb_env
510 runLink :: DynFlags -> [Option] -> IO ()
511 runLink dflags args = do
512 let (p,args0) = pgm_l dflags
513 runSomething dflags "Linker" p (args0++args)
515 runMkDLL :: DynFlags -> [Option] -> IO ()
516 runMkDLL dflags args = do
517 let (p,args0) = pgm_dll dflags
518 args1 = args0 ++ args
519 mb_env <- getGccEnv (args0++args)
520 runSomethingFiltered dflags id "Make DLL" p args1 mb_env
522 touch :: DynFlags -> String -> String -> IO ()
523 touch dflags purpose arg =
524 runSomething dflags purpose (pgm_T dflags) [FileOption "" arg]
526 copy :: DynFlags -> String -> FilePath -> FilePath -> IO ()
527 copy dflags purpose from to = copyWithHeader dflags purpose Nothing from to
529 copyWithHeader :: DynFlags -> String -> Maybe String -> FilePath -> FilePath
531 copyWithHeader dflags purpose maybe_header from to = do
532 showPass dflags purpose
534 h <- openFile to WriteMode
535 ls <- readFile from -- inefficient, but it'll do for now.
536 -- ToDo: speed up via slurping.
537 maybe (return ()) (hPutStr h) maybe_header
543 %************************************************************************
545 \subsection{Managing temporary files
547 %************************************************************************
550 GLOBAL_VAR(v_FilesToClean, [], [String] )
551 GLOBAL_VAR(v_DirsToClean, emptyFM, FiniteMap FilePath FilePath )
555 cleanTempDirs :: DynFlags -> IO ()
557 = unless (dopt Opt_KeepTmpFiles dflags)
558 $ do ds <- readIORef v_DirsToClean
559 removeTmpDirs dflags (eltsFM ds)
560 writeIORef v_DirsToClean emptyFM
562 cleanTempFiles :: DynFlags -> IO ()
563 cleanTempFiles dflags
564 = unless (dopt Opt_KeepTmpFiles dflags)
565 $ do fs <- readIORef v_FilesToClean
566 removeTmpFiles dflags fs
567 writeIORef v_FilesToClean []
569 cleanTempFilesExcept :: DynFlags -> [FilePath] -> IO ()
570 cleanTempFilesExcept dflags dont_delete
571 = unless (dopt Opt_KeepTmpFiles dflags)
572 $ do files <- readIORef v_FilesToClean
573 let (to_keep, to_delete) = partition (`elem` dont_delete) files
574 removeTmpFiles dflags to_delete
575 writeIORef v_FilesToClean to_keep
578 -- find a temporary name that doesn't already exist.
579 newTempName :: DynFlags -> Suffix -> IO FilePath
580 newTempName dflags extn
581 = do d <- getTempDir dflags
583 findTempName (d ++ "/ghc" ++ show x ++ "_") 0
585 findTempName prefix x
586 = do let filename = (prefix ++ show x) `joinFileExt` extn
587 b <- doesFileExist filename
588 if b then findTempName prefix (x+1)
589 else do consIORef v_FilesToClean filename -- clean it up later
592 -- return our temporary directory within tmp_dir, creating one if we
593 -- don't have one yet
594 getTempDir :: DynFlags -> IO FilePath
595 getTempDir dflags@(DynFlags{tmpDir=tmp_dir})
596 = do mapping <- readIORef v_DirsToClean
597 case lookupFM mapping tmp_dir of
600 let prefix = tmp_dir ++ "/ghc" ++ show x ++ "_"
602 = let dirname = prefix ++ show x
603 in do createDirectory dirname
604 let mapping' = addToFM mapping tmp_dir dirname
605 writeIORef v_DirsToClean mapping'
606 debugTraceMsg dflags 2 (ptext SLIT("Created temporary directory:") <+> text dirname)
609 if isAlreadyExistsError e
615 addFilesToClean :: [FilePath] -> IO ()
616 -- May include wildcards [used by DriverPipeline.run_phase SplitMangle]
617 addFilesToClean files = mapM_ (consIORef v_FilesToClean) files
619 removeTmpDirs :: DynFlags -> [FilePath] -> IO ()
620 removeTmpDirs dflags ds
621 = traceCmd dflags "Deleting temp dirs"
622 ("Deleting: " ++ unwords ds)
623 (mapM_ (removeWith dflags removeDirectory) ds)
625 removeTmpFiles :: DynFlags -> [FilePath] -> IO ()
626 removeTmpFiles dflags fs
628 traceCmd dflags "Deleting temp files"
629 ("Deleting: " ++ unwords deletees)
630 (mapM_ (removeWith dflags removeFile) deletees)
632 -- Flat out refuse to delete files that are likely to be source input
633 -- files (is there a worse bug than having a compiler delete your source
636 -- Deleting source files is a sign of a bug elsewhere, so prominently flag
639 | null non_deletees = act
641 putMsg dflags (text "WARNING - NOT deleting source files:" <+> hsep (map text non_deletees))
644 (non_deletees, deletees) = partition isHaskellUserSrcFilename fs
646 removeWith :: DynFlags -> (FilePath -> IO ()) -> FilePath -> IO ()
647 removeWith dflags remover f = remover f `IO.catch`
649 let msg = if isDoesNotExistError e
650 then ptext SLIT("Warning: deleting non-existent") <+> text f
651 else ptext SLIT("Warning: exception raised when deleting")
654 in debugTraceMsg dflags 2 msg
657 -----------------------------------------------------------------------------
658 -- Running an external program
660 runSomething :: DynFlags
661 -> String -- For -v message
662 -> String -- Command name (possibly a full path)
663 -- assumed already dos-ified
664 -> [Option] -- Arguments
665 -- runSomething will dos-ify them
668 runSomething dflags phase_name pgm args =
669 runSomethingFiltered dflags id phase_name pgm args Nothing
672 :: DynFlags -> (String->String) -> String -> String -> [Option]
673 -> Maybe [(String,String)] -> IO ()
675 runSomethingFiltered dflags filter_fn phase_name pgm args mb_env = do
676 let real_args = filter notNull (map showOpt args)
677 traceCmd dflags phase_name (unwords (pgm:real_args)) $ do
678 (exit_code, doesn'tExist) <-
680 rc <- builderMainLoop dflags filter_fn pgm real_args mb_env
682 ExitSuccess{} -> return (rc, False)
684 -- rawSystem returns (ExitFailure 127) if the exec failed for any
685 -- reason (eg. the program doesn't exist). This is the only clue
686 -- we have, but we need to report something to the user because in
687 -- the case of a missing program there will otherwise be no output
689 | n == 127 -> return (rc, True)
690 | otherwise -> return (rc, False))
691 -- Should 'rawSystem' generate an IO exception indicating that
692 -- 'pgm' couldn't be run rather than a funky return code, catch
693 -- this here (the win32 version does this, but it doesn't hurt
694 -- to test for this in general.)
696 if IO.isDoesNotExistError err
697 #if defined(mingw32_HOST_OS) && __GLASGOW_HASKELL__ < 604
698 -- the 'compat' version of rawSystem under mingw32 always
699 -- maps 'errno' to EINVAL to failure.
700 || case (ioeGetErrorType err ) of { InvalidArgument{} -> True ; _ -> False}
702 then return (ExitFailure 1, True)
704 case (doesn'tExist, exit_code) of
705 (True, _) -> throwDyn (InstallationError ("could not execute: " ++ pgm))
706 (_, ExitSuccess) -> return ()
707 _ -> throwDyn (PhaseFailed phase_name exit_code)
711 #if __GLASGOW_HASKELL__ < 603
712 builderMainLoop dflags filter_fn pgm real_args mb_env = do
713 rawSystem pgm real_args
715 builderMainLoop dflags filter_fn pgm real_args mb_env = do
717 (hStdIn, hStdOut, hStdErr, hProcess) <- runInteractiveProcess pgm real_args Nothing mb_env
719 -- and run a loop piping the output from the compiler to the log_action in DynFlags
720 hSetBuffering hStdOut LineBuffering
721 hSetBuffering hStdErr LineBuffering
722 forkIO (readerProc chan hStdOut filter_fn)
723 forkIO (readerProc chan hStdErr filter_fn)
724 rc <- loop chan hProcess 2 1 ExitSuccess
730 -- status starts at zero, and increments each time either
731 -- a reader process gets EOF, or the build proc exits. We wait
732 -- for all of these to happen (status==3).
733 -- ToDo: we should really have a contingency plan in case any of
734 -- the threads dies, such as a timeout.
735 loop chan hProcess 0 0 exitcode = return exitcode
736 loop chan hProcess t p exitcode = do
738 then getProcessExitCode hProcess
741 Just code -> loop chan hProcess t (p-1) code
747 log_action dflags SevInfo noSrcSpan defaultUserStyle msg
748 loop chan hProcess t p exitcode
749 BuildError loc msg -> do
750 log_action dflags SevError (mkSrcSpan loc loc) defaultUserStyle msg
751 loop chan hProcess t p exitcode
753 loop chan hProcess (t-1) p exitcode
754 | otherwise -> loop chan hProcess t p exitcode
756 readerProc chan hdl filter_fn =
757 (do str <- hGetContents hdl
758 loop (linesPlatform (filter_fn str)) Nothing)
761 -- ToDo: check errors more carefully
762 -- ToDo: in the future, the filter should be implemented as
763 -- a stream transformer.
765 loop [] Nothing = return ()
766 loop [] (Just err) = writeChan chan err
769 Just err@(BuildError srcLoc msg)
770 | leading_whitespace l -> do
771 loop ls (Just (BuildError srcLoc (msg $$ text l)))
779 = case parseError l of
781 writeChan chan (BuildMsg (text l))
783 Just (file, lineNum, colNum, msg) -> do
784 let srcLoc = mkSrcLoc (mkFastString file) lineNum colNum
785 loop ls (Just (BuildError srcLoc (text msg)))
787 leading_whitespace [] = False
788 leading_whitespace (x:_) = isSpace x
790 parseError :: String -> Maybe (String, Int, Int, String)
791 parseError s0 = case breakColon s0 of
792 Just (filename, s1) ->
793 case breakIntColon s1 of
794 Just (lineNum, s2) ->
795 case breakIntColon s2 of
796 Just (columnNum, s3) ->
797 Just (filename, lineNum, columnNum, s3)
799 Just (filename, lineNum, 0, s2)
803 breakColon :: String -> Maybe (String, String)
804 breakColon xs = case break (':' ==) xs of
805 (ys, _:zs) -> Just (ys, zs)
808 breakIntColon :: String -> Maybe (Int, String)
809 breakIntColon xs = case break (':' ==) xs of
811 | not (null ys) && all isAscii ys && all isDigit ys ->
817 | BuildError !SrcLoc !SDoc
821 showOpt (FileOption pre f) = pre ++ platformPath f
822 showOpt (Option "") = ""
823 showOpt (Option s) = s
825 traceCmd :: DynFlags -> String -> String -> IO () -> IO ()
826 -- a) trace the command (at two levels of verbosity)
827 -- b) don't do it at all if dry-run is set
828 traceCmd dflags phase_name cmd_line action
829 = do { let verb = verbosity dflags
830 ; showPass dflags phase_name
831 ; debugTraceMsg dflags 3 (text cmd_line)
835 ; unless (dopt Opt_DryRun dflags) $ do {
838 ; action `IO.catch` handle_exn verb
841 handle_exn verb exn = do { debugTraceMsg dflags 2 (char '\n')
842 ; debugTraceMsg dflags 2 (ptext SLIT("Failed:") <+> text cmd_line <+> text (show exn))
843 ; throwDyn (PhaseFailed phase_name (ExitFailure 1)) }
846 %************************************************************************
848 \subsection{Support code}
850 %************************************************************************
853 -----------------------------------------------------------------------------
854 -- Define getBaseDir :: IO (Maybe String)
856 getBaseDir :: IO (Maybe String)
857 #if defined(mingw32_HOST_OS)
858 -- Assuming we are running ghc, accessed by path $()/bin/ghc.exe,
859 -- return the path $(stuff). Note that we drop the "bin/" directory too.
860 getBaseDir = do let len = (2048::Int) -- plenty, PATH_MAX is 512 under Win32.
861 buf <- mallocArray len
862 ret <- getModuleFileName nullPtr buf len
863 if ret == 0 then free buf >> return Nothing
864 else do s <- peekCString buf
866 return (Just (rootDir s))
868 rootDir s = reverse (dropList "/bin/ghc.exe" (reverse (normalisePath s)))
870 foreign import stdcall unsafe "GetModuleFileNameA"
871 getModuleFileName :: Ptr () -> CString -> Int -> IO Int32
873 getBaseDir = return Nothing
876 #ifdef mingw32_HOST_OS
877 foreign import ccall unsafe "_getpid" getProcessID :: IO Int -- relies on Int == Int32 on Windows
878 #elif __GLASGOW_HASKELL__ > 504
879 getProcessID :: IO Int
880 getProcessID = System.Posix.Internals.c_getpid >>= return . fromIntegral
882 getProcessID :: IO Int
883 getProcessID = Posix.getProcessID
886 -- Divvy up text stream into lines, taking platform dependent
887 -- line termination into account.
888 linesPlatform :: String -> [String]
889 #if !defined(mingw32_HOST_OS)
890 linesPlatform ls = lines ls
892 linesPlatform "" = []
895 (as,xs1) -> as : linesPlatform xs1
897 lineBreak "" = ("","")
898 lineBreak ('\r':'\n':xs) = ([],xs)
899 lineBreak ('\n':xs) = ([],xs)
900 lineBreak (x:xs) = let (as,bs) = lineBreak xs in (x:as,bs)