01c8189723bf13054fece9e5a2f80506726029dc
[oota-llvm.git] / include / Support / SystemUtils.h
1 //===- SystemUtils.h - Utilities to do low-level system stuff ---*- C++ -*-===//
2 //
3 // This file contains functions used to do a variety of low-level, often
4 // system-specific, tasks.
5 //
6 //===----------------------------------------------------------------------===//
7
8 #ifndef SYSTEMUTILS_H
9 #define SYSTEMUTILS_H
10
11 #include <string>
12
13 /// isExecutableFile - This function returns true if the filename specified
14 /// exists and is executable.
15 ///
16 bool isExecutableFile(const std::string &ExeFileName);
17
18 /// FindExecutable - Find a named executable, giving the argv[0] of program
19 /// being executed. This allows us to find another LLVM tool if it is built into
20 /// the same directory, but that directory is neither the current directory, nor
21 /// in the PATH.  If the executable cannot be found, return an empty string.
22 /// 
23 std::string FindExecutable(const std::string &ExeName,
24                            const std::string &ProgramPath);
25
26 /// RunProgramWithTimeout - This function executes the specified program, with
27 /// the specified null-terminated argument array, with the stdin/out/err fd's
28 /// redirected, with a timeout specified on the commandline.  This terminates
29 /// the calling program if there is an error executing the specified program.
30 /// It returns the return value of the program, or -1 if a timeout is detected.
31 ///
32 int RunProgramWithTimeout(const std::string &ProgramPath, const char **Args,
33                           const std::string &StdInFile = "",
34                           const std::string &StdOutFile = "",
35                           const std::string &StdErrFile = "");
36
37 /// ExecWait - Execute a program with the given arguments and environment and 
38 /// wait for it to terminate.
39 ///
40 int ExecWait (const char * const argv[], const char * const envp[]);
41 #endif