1 -----------------------------------------------------------------------------
3 -- (c) The University of Glasgow 2001-2003
5 -- Access to system tools: gcc, cp, rm etc
7 -----------------------------------------------------------------------------
10 {-# OPTIONS -fno-cse #-}
11 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
17 -- Interface to system tools
18 runUnlit, runCpp, runCc, -- [Option] -> IO ()
19 runPp, -- [Option] -> IO ()
20 runMangle, runSplit, -- [Option] -> IO ()
21 runAs, runLink, -- [Option] -> IO ()
25 touch, -- String -> String -> IO ()
30 -- Temporary-file management
33 cleanTempDirs, cleanTempFiles, cleanTempFilesExcept,
40 #include "HsVersions.h"
51 import Control.Exception
55 import System.Environment
56 import System.FilePath
58 import System.IO.Error as IO
59 import System.Directory
64 #ifndef mingw32_HOST_OS
65 import qualified System.Posix.Internals
66 #else /* Must be Win32 */
68 import CString ( CString, peekCString )
71 import System.Process ( runInteractiveProcess, getProcessExitCode )
72 import Control.Concurrent
74 import SrcLoc ( SrcLoc, mkSrcLoc, noSrcSpan, mkSrcSpan )
78 The configuration story
79 ~~~~~~~~~~~~~~~~~~~~~~~
81 GHC needs various support files (library packages, RTS etc), plus
82 various auxiliary programs (cp, gcc, etc). It finds these in one
85 * When running as an *installed program*, GHC finds most of this support
86 stuff in the installed library tree. The path to this tree is passed
87 to GHC via the -B flag, and given to initSysTools .
89 * When running *in-place* in a build tree, GHC finds most of this support
90 stuff in the build tree. The path to the build tree is, again passed
93 GHC tells which of the two is the case by seeing whether package.conf
94 is in TopDir [installed] or in TopDir/ghc/driver [inplace] (what a hack).
97 SysTools.initSysProgs figures out exactly where all the auxiliary programs
98 are, and initialises mutable variables to make it easy to call them.
99 To to this, it makes use of definitions in Config.hs, which is a Haskell
100 file containing variables whose value is figured out by the build system.
102 Config.hs contains two sorts of things
104 cGCC, The *names* of the programs
107 etc They do *not* include paths
110 cUNLIT_DIR_REL The *path* to the directory containing unlit, split etc
111 cSPLIT_DIR_REL *relative* to the root of the build tree,
112 for use when running *in-place* in a build tree (only)
116 ---------------------------------------------
117 NOTES for an ALTERNATIVE scheme (i.e *not* what is currently implemented):
119 Another hair-brained scheme for simplifying the current tool location
120 nightmare in GHC: Simon originally suggested using another
121 configuration file along the lines of GCC's specs file - which is fine
122 except that it means adding code to read yet another configuration
123 file. What I didn't notice is that the current package.conf is
124 general enough to do this:
127 {name = "tools", import_dirs = [], source_dirs = [],
128 library_dirs = [], hs_libraries = [], extra_libraries = [],
129 include_dirs = [], c_includes = [], package_deps = [],
130 extra_ghc_opts = ["-pgmc/usr/bin/gcc","-pgml${topdir}/bin/unlit", ... etc.],
131 extra_cc_opts = [], extra_ld_opts = []}
133 Which would have the advantage that we get to collect together in one
134 place the path-specific package stuff with the path-specific tool
137 ---------------------------------------------
139 %************************************************************************
141 \subsection{Initialisation}
143 %************************************************************************
146 initSysTools :: Maybe String -- Maybe TopDir path (without the '-B' prefix)
149 -> IO DynFlags -- Set all the mutable variables above, holding
150 -- (a) the system programs
151 -- (b) the package-config file
152 -- (c) the GHC usage message
155 initSysTools mbMinusB dflags0
156 = do { (am_installed, top_dir) <- findTopDir mbMinusB
158 -- for "installed" this is the root of GHC's support files
159 -- for "in-place" it is the root of the build tree
160 -- NB: top_dir is assumed to be in standard Unix
161 -- format, '/' separated
163 ; let installed, installed_bin :: FilePath -> FilePath
164 installed_bin pgm = top_dir </> pgm
165 installed file = top_dir </> file
167 | isWindowsHost = top_dir </> ".." </> ".."
168 | otherwise = top_dir </> ".."
169 inplace dir pgm = real_top_dir </> dir </> pgm
172 | am_installed = installed "package.conf"
173 | otherwise = inplace "inplace-datadir" "package.conf"
176 | am_installed = installed "ghc-usage.txt"
177 | otherwise = inplace cGHC_DRIVER_DIR_REL "ghc-usage.txt"
180 | am_installed = installed "ghci-usage.txt"
181 | otherwise = inplace cGHC_DRIVER_DIR_REL "ghci-usage.txt"
183 -- For all systems, unlit, split, mangle are GHC utilities
184 -- architecture-specific stuff is done when building Config.hs
186 | am_installed = installed_bin cGHC_UNLIT_PGM
187 | otherwise = inplace cGHC_UNLIT_DIR_REL cGHC_UNLIT_PGM
189 -- split and mangle are Perl scripts
191 | am_installed = installed_bin cGHC_SPLIT_PGM
192 | otherwise = inplace cGHC_SPLIT_DIR_REL cGHC_SPLIT_PGM
195 | am_installed = installed_bin cGHC_MANGLER_PGM
196 | otherwise = inplace cGHC_MANGLER_DIR_REL cGHC_MANGLER_PGM
199 | am_installed = installed_bin "bin/windres"
200 | otherwise = "windres"
202 ; tmpdir <- getTemporaryDirectory
203 ; let dflags1 = setTmpDir tmpdir dflags0
205 -- Check that the package config exists
206 ; config_exists <- doesFileExist pkgconfig_path
207 ; when (not config_exists) $
208 throwDyn (InstallationError
209 ("Can't find package.conf as " ++ pkgconfig_path))
211 -- On Windows, gcc and friends are distributed with GHC,
212 -- so when "installed" we look in TopDir/bin
213 -- When "in-place", or when not on Windows, we look wherever
214 -- the build-time configure script found them
216 -- The trailing "/" is absolutely essential; gcc seems
217 -- to construct file names simply by concatenating to
218 -- this -B path with no extra slash We use "/" rather
219 -- than "\\" because otherwise "\\\" is mangled
220 -- later on; although gcc_args are in NATIVE format,
222 -- (see comments with declarations of global variables)
223 gcc_b_arg = Option ("-B" ++ installed "gcc-lib/")
225 | isWindowsHost && am_installed
226 -- We tell gcc where its specs file + exes are (-B)
227 -- and also some places to pick up include files. We need
228 -- to be careful to put all necessary exes in the -B place
229 -- (as, ld, cc1, etc) since if they don't get found there,
230 -- gcc then tries to run unadorned "as", "ld", etc, and
231 -- will pick up whatever happens to be lying around in
232 -- the path, possibly including those from a cygwin
233 -- install on the target, which is exactly what we're
235 = (installed_bin "gcc", [gcc_b_arg])
236 | otherwise = (cGCC, [])
238 | isWindowsHost && am_installed = installed_bin cGHC_PERL
239 | otherwise = cGHC_PERL
240 -- 'touch' is a GHC util for Windows
244 then installed_bin cGHC_TOUCHY_PGM
245 else inplace cGHC_TOUCHY_DIR_REL cGHC_TOUCHY_PGM
246 | otherwise = "touch"
247 -- On Win32 we don't want to rely on #!/bin/perl, so we prepend
248 -- a call to Perl to get the invocation of split and mangle.
249 -- On Unix, scripts are invoked using the '#!' method. Binary
250 -- installations of GHC on Unix place the correct line on the
251 -- front of the script at installation time, so we don't want
252 -- to wire-in our knowledge of $(PERL) on the host system here.
253 (split_prog, split_args)
254 | isWindowsHost = (perl_path, [Option split_script])
255 | otherwise = (split_script, [])
256 (mangle_prog, mangle_args)
257 | isWindowsHost = (perl_path, [Option mangle_script])
258 | otherwise = (mangle_script, [])
259 (mkdll_prog, mkdll_args)
261 = panic "Can't build DLLs on a non-Win32 system"
263 (installed "gcc-lib/" </> cMKDLL,
264 [ Option "--dlltool-name",
265 Option (installed "gcc-lib/" </> "dlltool"),
266 Option "--driver-name",
267 Option gcc_prog, gcc_b_arg ])
268 | otherwise = (cMKDLL, [])
270 -- cpp is derived from gcc on all platforms
271 -- HACK, see setPgmP below. We keep 'words' here to remember to fix
272 -- Config.hs one day.
273 ; let cpp_path = (gcc_prog, gcc_args ++
274 (Option "-E"):(map Option (words cRAWCPP_FLAGS)))
276 -- Other things being equal, as and ld are simply gcc
277 ; let (as_prog,as_args) = (gcc_prog,gcc_args)
278 (ld_prog,ld_args) = (gcc_prog,gcc_args)
281 ghcUsagePath = ghc_usage_msg_path,
282 ghciUsagePath = ghci_usage_msg_path,
284 systemPackageConfig = pkgconfig_path,
288 pgm_c = (gcc_prog,gcc_args),
289 pgm_m = (mangle_prog,mangle_args),
290 pgm_s = (split_prog,split_args),
291 pgm_a = (as_prog,as_args),
292 pgm_l = (ld_prog,ld_args),
293 pgm_dll = (mkdll_prog,mkdll_args),
295 pgm_sysman = top_dir ++ "/ghc/rts/parallel/SysMan",
296 pgm_windres = windres_path
297 -- Hans: this isn't right in general, but you can
298 -- elaborate it in the same way as the others
305 -- for "installed" this is the root of GHC's support files
306 -- for "in-place" it is the root of the build tree
309 -- 1. Set proto_top_dir
310 -- if there is no given TopDir path, 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 findTopDir :: Maybe String -- Maybe TopDir path (without the '-B' prefix).
323 -> IO (Bool, -- True <=> am installed, False <=> in-place
324 String) -- TopDir (in Unix format '/' separated)
327 = do { top_dir <- get_proto
328 ; exists1 <- doesFileExist (top_dir </> "package.conf")
329 ; exists2 <- doesFileExist (top_dir </> "inplace")
330 ; let amInplace = not exists1 -- On Windows, package.conf doesn't exist
331 -- when we are inplace
332 || exists2 -- On Linux, the presence of inplace signals
333 -- that we are inplace
335 ; return (not amInplace, top_dir)
338 -- get_proto returns a Unix-format path (relying on getBaseDir to do so too)
339 get_proto = case mbMinusB of
340 Just minusb -> return (normalise minusb)
342 -> do maybe_exec_dir <- getBaseDir -- 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
350 %************************************************************************
352 \subsection{Running an external program}
354 %************************************************************************
358 runUnlit :: DynFlags -> [Option] -> IO ()
359 runUnlit dflags args = do
361 runSomething dflags "Literate pre-processor" p args
363 runCpp :: DynFlags -> [Option] -> IO ()
364 runCpp dflags args = do
365 let (p,args0) = pgm_P dflags
366 args1 = args0 ++ args
367 mb_env <- getGccEnv args1
368 runSomethingFiltered dflags id "C pre-processor" p args1 mb_env
370 runPp :: DynFlags -> [Option] -> IO ()
371 runPp dflags args = do
373 runSomething dflags "Haskell pre-processor" p args
375 runCc :: DynFlags -> [Option] -> IO ()
376 runCc dflags args = do
377 let (p,args0) = pgm_c dflags
378 args1 = args0 ++ args
379 mb_env <- getGccEnv args1
380 runSomethingFiltered dflags cc_filter "C Compiler" p args1 mb_env
382 -- discard some harmless warnings from gcc that we can't turn off
383 cc_filter = unlines . doFilter . lines
386 gcc gives warnings in chunks like so:
387 In file included from /foo/bar/baz.h:11,
388 from /foo/bar/baz2.h:22,
390 /foo/flibble:14: global register variable ...
391 /foo/flibble:15: warning: call-clobbered r...
392 We break it up into its chunks, remove any call-clobbered register
393 warnings from each chunk, and then delete any chunks that we have
396 doFilter = unChunkWarnings . filterWarnings . chunkWarnings []
397 -- We can't assume that the output will start with an "In file inc..."
398 -- line, so we start off expecting a list of warnings rather than a
400 chunkWarnings :: [String] -- The location stack to use for the next
402 -> [String] -- The remaining lines to look at
403 -> [([String], [String])]
404 chunkWarnings loc_stack [] = [(loc_stack, [])]
405 chunkWarnings loc_stack xs
406 = case break loc_stack_start xs of
407 (warnings, lss:xs') ->
408 case span loc_start_continuation xs' of
410 (loc_stack, warnings) : chunkWarnings (lss : lsc) xs''
411 _ -> [(loc_stack, xs)]
413 filterWarnings :: [([String], [String])] -> [([String], [String])]
414 filterWarnings [] = []
415 -- If the warnings are already empty then we are probably doing
416 -- something wrong, so don't delete anything
417 filterWarnings ((xs, []) : zs) = (xs, []) : filterWarnings zs
418 filterWarnings ((xs, ys) : zs) = case filter wantedWarning ys of
419 [] -> filterWarnings zs
420 ys' -> (xs, ys') : filterWarnings zs
422 unChunkWarnings :: [([String], [String])] -> [String]
423 unChunkWarnings [] = []
424 unChunkWarnings ((xs, ys) : zs) = xs ++ ys ++ unChunkWarnings zs
426 loc_stack_start s = "In file included from " `isPrefixOf` s
427 loc_start_continuation s = " from " `isPrefixOf` s
429 | "warning: call-clobbered register used" `isContainedIn` w = False
432 isContainedIn :: String -> String -> Bool
433 xs `isContainedIn` ys = any (xs `isPrefixOf`) (tails ys)
435 -- If the -B<dir> option is set, add <dir> to PATH. This works around
436 -- a bug in gcc on Windows Vista where it can't find its auxiliary
437 -- binaries (see bug #1110).
438 getGccEnv :: [Option] -> IO (Maybe [(String,String)])
442 else do env <- getEnvironment
443 return (Just (map mangle_path env))
445 (b_dirs, _) = partitionWith get_b_opt opts
447 get_b_opt (Option ('-':'B':dir)) = Left dir
448 get_b_opt other = Right other
450 mangle_path (path,paths) | map toUpper path == "PATH"
451 = (path, '\"' : head b_dirs ++ "\";" ++ paths)
452 mangle_path other = other
454 runMangle :: DynFlags -> [Option] -> IO ()
455 runMangle dflags args = do
456 let (p,args0) = pgm_m dflags
457 runSomething dflags "Mangler" p (args0++args)
459 runSplit :: DynFlags -> [Option] -> IO ()
460 runSplit dflags args = do
461 let (p,args0) = pgm_s dflags
462 runSomething dflags "Splitter" p (args0++args)
464 runAs :: DynFlags -> [Option] -> IO ()
465 runAs dflags args = do
466 let (p,args0) = pgm_a dflags
467 args1 = args0 ++ args
468 mb_env <- getGccEnv args1
469 runSomethingFiltered dflags id "Assembler" p args1 mb_env
471 runLink :: DynFlags -> [Option] -> IO ()
472 runLink dflags args = do
473 let (p,args0) = pgm_l dflags
474 args1 = args0 ++ args
475 mb_env <- getGccEnv args1
476 runSomethingFiltered dflags id "Linker" p args1 mb_env
478 runMkDLL :: DynFlags -> [Option] -> IO ()
479 runMkDLL dflags args = do
480 let (p,args0) = pgm_dll dflags
481 args1 = args0 ++ args
482 mb_env <- getGccEnv (args0++args)
483 runSomethingFiltered dflags id "Make DLL" p args1 mb_env
485 runWindres :: DynFlags -> [Option] -> IO ()
486 runWindres dflags args = do
487 let (gcc,gcc_args) = pgm_c dflags
488 windres = pgm_windres dflags
489 mb_env <- getGccEnv gcc_args
490 runSomethingFiltered dflags id "Windres" windres
491 -- we must tell windres where to find gcc: it might not be on PATH
492 (Option ("--preprocessor=" ++
493 unwords (map quote (gcc : map showOpt gcc_args ++
494 ["-E", "-xc", "-DRC_INVOKED"])))
495 -- -- use-temp-file is required for windres to interpret the
496 -- quoting in the preprocessor arg above correctly. Without
497 -- this, windres calls the preprocessor with popen, which gets
498 -- the quoting wrong (discovered by experimentation and
499 -- reading the windres sources). See #1828.
500 : Option "--use-temp-file"
502 -- we must use the PATH workaround here too, since windres invokes gcc
505 quote x = '\"' : x ++ "\""
507 touch :: DynFlags -> String -> String -> IO ()
508 touch dflags purpose arg =
509 runSomething dflags purpose (pgm_T dflags) [FileOption "" arg]
511 copy :: DynFlags -> String -> FilePath -> FilePath -> IO ()
512 copy dflags purpose from to = copyWithHeader dflags purpose Nothing from to
514 copyWithHeader :: DynFlags -> String -> Maybe String -> FilePath -> FilePath
516 copyWithHeader dflags purpose maybe_header from to = do
517 showPass dflags purpose
519 h <- openFile to WriteMode
520 ls <- readFile from -- inefficient, but it'll do for now.
521 -- ToDo: speed up via slurping.
522 maybe (return ()) (hPutStr h) maybe_header
526 getExtraViaCOpts :: DynFlags -> IO [String]
527 getExtraViaCOpts dflags = do
528 (am_installed, top_dir) <- findTopDir (Just (topDir dflags))
531 | isWindowsHost && not am_installed
532 = top_dir </> ".." </> ".." </> "inplace-datadir"
533 | otherwise = top_dir
534 f <- readFile (top_dir' </> "extra-gcc-opts")
538 %************************************************************************
540 \subsection{Managing temporary files
542 %************************************************************************
545 GLOBAL_VAR(v_FilesToClean, [], [String] )
546 GLOBAL_VAR(v_DirsToClean, emptyFM, FiniteMap FilePath FilePath )
550 cleanTempDirs :: DynFlags -> IO ()
552 = unless (dopt Opt_KeepTmpFiles dflags)
553 $ do ds <- readIORef v_DirsToClean
554 removeTmpDirs dflags (eltsFM ds)
555 writeIORef v_DirsToClean emptyFM
557 cleanTempFiles :: DynFlags -> IO ()
558 cleanTempFiles dflags
559 = unless (dopt Opt_KeepTmpFiles dflags)
560 $ do fs <- readIORef v_FilesToClean
561 removeTmpFiles dflags fs
562 writeIORef v_FilesToClean []
564 cleanTempFilesExcept :: DynFlags -> [FilePath] -> IO ()
565 cleanTempFilesExcept dflags dont_delete
566 = unless (dopt Opt_KeepTmpFiles dflags)
567 $ do files <- readIORef v_FilesToClean
568 let (to_keep, to_delete) = partition (`elem` dont_delete) files
569 removeTmpFiles dflags to_delete
570 writeIORef v_FilesToClean to_keep
573 -- find a temporary name that doesn't already exist.
574 newTempName :: DynFlags -> Suffix -> IO FilePath
575 newTempName dflags extn
576 = do d <- getTempDir dflags
578 findTempName (d ++ "/ghc" ++ show x ++ "_") 0
580 findTempName :: FilePath -> Integer -> IO FilePath
581 findTempName prefix x
582 = do let filename = (prefix ++ show x) <.> extn
583 b <- doesFileExist filename
584 if b then findTempName prefix (x+1)
585 else do consIORef v_FilesToClean filename -- clean it up later
588 -- return our temporary directory within tmp_dir, creating one if we
589 -- don't have one yet
590 getTempDir :: DynFlags -> IO FilePath
591 getTempDir dflags@(DynFlags{tmpDir=tmp_dir})
592 = do mapping <- readIORef v_DirsToClean
593 case lookupFM mapping tmp_dir of
596 let prefix = tmp_dir ++ "/ghc" ++ show x ++ "_"
598 mkTempDir :: Integer -> IO FilePath
600 = let dirname = prefix ++ show x
601 in do createDirectory dirname
602 let mapping' = addToFM mapping tmp_dir dirname
603 writeIORef v_DirsToClean mapping'
604 debugTraceMsg dflags 2 (ptext (sLit "Created temporary directory:") <+> text dirname)
607 if isAlreadyExistsError e
613 addFilesToClean :: [FilePath] -> IO ()
614 -- May include wildcards [used by DriverPipeline.run_phase SplitMangle]
615 addFilesToClean files = mapM_ (consIORef v_FilesToClean) files
617 removeTmpDirs :: DynFlags -> [FilePath] -> IO ()
618 removeTmpDirs dflags ds
619 = traceCmd dflags "Deleting temp dirs"
620 ("Deleting: " ++ unwords ds)
621 (mapM_ (removeWith dflags removeDirectory) ds)
623 removeTmpFiles :: DynFlags -> [FilePath] -> IO ()
624 removeTmpFiles dflags fs
626 traceCmd dflags "Deleting temp files"
627 ("Deleting: " ++ unwords deletees)
628 (mapM_ (removeWith dflags removeFile) deletees)
630 -- Flat out refuse to delete files that are likely to be source input
631 -- files (is there a worse bug than having a compiler delete your source
634 -- Deleting source files is a sign of a bug elsewhere, so prominently flag
637 | null non_deletees = act
639 putMsg dflags (text "WARNING - NOT deleting source files:" <+> hsep (map text non_deletees))
642 (non_deletees, deletees) = partition isHaskellUserSrcFilename fs
644 removeWith :: DynFlags -> (FilePath -> IO ()) -> FilePath -> IO ()
645 removeWith dflags remover f = remover f `IO.catch`
647 let msg = if isDoesNotExistError e
648 then ptext (sLit "Warning: deleting non-existent") <+> text f
649 else ptext (sLit "Warning: exception raised when deleting")
652 in debugTraceMsg dflags 2 msg
655 -----------------------------------------------------------------------------
656 -- Running an external program
658 runSomething :: DynFlags
659 -> String -- For -v message
660 -> String -- Command name (possibly a full path)
661 -- assumed already dos-ified
662 -> [Option] -- Arguments
663 -- runSomething will dos-ify them
666 runSomething dflags phase_name pgm args =
667 runSomethingFiltered dflags id phase_name pgm args Nothing
670 :: DynFlags -> (String->String) -> String -> String -> [Option]
671 -> Maybe [(String,String)] -> IO ()
673 runSomethingFiltered dflags filter_fn phase_name pgm args mb_env = do
674 let real_args = filter notNull (map showOpt args)
675 traceCmd dflags phase_name (unwords (pgm:real_args)) $ do
676 (exit_code, doesn'tExist) <-
678 rc <- builderMainLoop dflags filter_fn pgm real_args mb_env
680 ExitSuccess{} -> return (rc, False)
682 -- rawSystem returns (ExitFailure 127) if the exec failed for any
683 -- reason (eg. the program doesn't exist). This is the only clue
684 -- we have, but we need to report something to the user because in
685 -- the case of a missing program there will otherwise be no output
687 | n == 127 -> return (rc, True)
688 | otherwise -> return (rc, False))
689 -- Should 'rawSystem' generate an IO exception indicating that
690 -- 'pgm' couldn't be run rather than a funky return code, catch
691 -- this here (the win32 version does this, but it doesn't hurt
692 -- to test for this in general.)
694 if IO.isDoesNotExistError err
695 then return (ExitFailure 1, True)
697 case (doesn'tExist, exit_code) of
698 (True, _) -> throwDyn (InstallationError ("could not execute: " ++ pgm))
699 (_, ExitSuccess) -> return ()
700 _ -> throwDyn (PhaseFailed phase_name exit_code)
702 builderMainLoop :: DynFlags -> (String -> String) -> FilePath
703 -> [String] -> Maybe [(String, String)]
705 builderMainLoop dflags filter_fn pgm real_args mb_env = do
707 (hStdIn, hStdOut, hStdErr, hProcess) <- runInteractiveProcess pgm real_args Nothing mb_env
709 -- and run a loop piping the output from the compiler to the log_action in DynFlags
710 hSetBuffering hStdOut LineBuffering
711 hSetBuffering hStdErr LineBuffering
712 forkIO (readerProc chan hStdOut filter_fn)
713 forkIO (readerProc chan hStdErr filter_fn)
714 -- we don't want to finish until 2 streams have been completed
715 -- (stdout and stderr)
716 -- nor until 1 exit code has been retrieved.
717 rc <- loop chan hProcess (2::Integer) (1::Integer) ExitSuccess
718 -- after that, we're done here.
724 -- status starts at zero, and increments each time either
725 -- a reader process gets EOF, or the build proc exits. We wait
726 -- for all of these to happen (status==3).
727 -- ToDo: we should really have a contingency plan in case any of
728 -- the threads dies, such as a timeout.
729 loop _ _ 0 0 exitcode = return exitcode
730 loop chan hProcess t p exitcode = do
732 then getProcessExitCode hProcess
735 Just code -> loop chan hProcess t (p-1) code
741 log_action dflags SevInfo noSrcSpan defaultUserStyle msg
742 loop chan hProcess t p exitcode
743 BuildError loc msg -> do
744 log_action dflags SevError (mkSrcSpan loc loc) defaultUserStyle msg
745 loop chan hProcess t p exitcode
747 loop chan hProcess (t-1) p exitcode
748 | otherwise -> loop chan hProcess t p exitcode
750 readerProc :: Chan BuildMessage -> Handle -> (String -> String) -> IO ()
751 readerProc chan hdl filter_fn =
752 (do str <- hGetContents hdl
753 loop (linesPlatform (filter_fn str)) Nothing)
756 -- ToDo: check errors more carefully
757 -- ToDo: in the future, the filter should be implemented as
758 -- a stream transformer.
760 loop [] Nothing = return ()
761 loop [] (Just err) = writeChan chan err
764 Just err@(BuildError srcLoc msg)
765 | leading_whitespace l -> do
766 loop ls (Just (BuildError srcLoc (msg $$ text l)))
772 _ -> panic "readerProc/loop"
775 = case parseError l of
777 writeChan chan (BuildMsg (text l))
779 Just (file, lineNum, colNum, msg) -> do
780 let srcLoc = mkSrcLoc (mkFastString file) lineNum colNum
781 loop ls (Just (BuildError srcLoc (text msg)))
783 leading_whitespace [] = False
784 leading_whitespace (x:_) = isSpace x
786 parseError :: String -> Maybe (String, Int, Int, String)
787 parseError s0 = case breakColon s0 of
788 Just (filename, s1) ->
789 case breakIntColon s1 of
790 Just (lineNum, s2) ->
791 case breakIntColon s2 of
792 Just (columnNum, s3) ->
793 Just (filename, lineNum, columnNum, s3)
795 Just (filename, lineNum, 0, s2)
799 breakColon :: String -> Maybe (String, String)
800 breakColon xs = case break (':' ==) xs of
801 (ys, _:zs) -> Just (ys, zs)
804 breakIntColon :: String -> Maybe (Int, String)
805 breakIntColon xs = case break (':' ==) xs of
807 | not (null ys) && all isAscii ys && all isDigit ys ->
813 | BuildError !SrcLoc !SDoc
816 showOpt :: Option -> String
817 showOpt (FileOption pre f) = pre ++ f
818 showOpt (Option s) = s
820 traceCmd :: DynFlags -> String -> String -> IO () -> IO ()
821 -- a) trace the command (at two levels of verbosity)
822 -- b) don't do it at all if dry-run is set
823 traceCmd dflags phase_name cmd_line action
824 = do { let verb = verbosity dflags
825 ; showPass dflags phase_name
826 ; debugTraceMsg dflags 3 (text cmd_line)
830 ; unless (dopt Opt_DryRun dflags) $ do {
833 ; action `IO.catch` handle_exn verb
836 handle_exn _verb exn = do { debugTraceMsg dflags 2 (char '\n')
837 ; debugTraceMsg dflags 2 (ptext (sLit "Failed:") <+> text cmd_line <+> text (show exn))
838 ; throwDyn (PhaseFailed phase_name (ExitFailure 1)) }
841 %************************************************************************
843 \subsection{Support code}
845 %************************************************************************
848 -----------------------------------------------------------------------------
849 -- Define getBaseDir :: IO (Maybe String)
851 getBaseDir :: IO (Maybe String)
852 #if defined(mingw32_HOST_OS)
853 -- Assuming we are running ghc, accessed by path $()/bin/ghc.exe,
854 -- return the path $(stuff). Note that we drop the "bin/" directory too.
855 getBaseDir = do let len = (2048::Int) -- plenty, PATH_MAX is 512 under Win32.
856 buf <- mallocArray len
857 ret <- getModuleFileName nullPtr buf len
858 if ret == 0 then free buf >> return Nothing
859 else do s <- peekCString buf
861 return (Just (rootDir s))
863 rootDir s = case splitFileName $ normalise s of
865 case splitFileName $ takeDirectory d of
866 (d', "bin") -> takeDirectory d'
867 _ -> panic ("Expected \"bin\" in " ++ show s)
868 _ -> panic ("Expected \"ghc.exe\" in " ++ show 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
879 getProcessID :: IO Int
880 getProcessID = System.Posix.Internals.c_getpid >>= return . fromIntegral
883 -- Divvy up text stream into lines, taking platform dependent
884 -- line termination into account.
885 linesPlatform :: String -> [String]
886 #if !defined(mingw32_HOST_OS)
887 linesPlatform ls = lines ls
889 linesPlatform "" = []
892 (as,xs1) -> as : linesPlatform xs1
894 lineBreak "" = ("","")
895 lineBreak ('\r':'\n':xs) = ([],xs)
896 lineBreak ('\n':xs) = ([],xs)
897 lineBreak (x:xs) = let (as,bs) = lineBreak xs in (x:as,bs)