2010-11-29 19:44:50 +00:00
|
|
|
//===- llvm/Support/Program.h ------------------------------------*- C++ -*-===//
|
2005-04-21 20:48:15 +00:00
|
|
|
//
|
2004-08-29 05:29:35 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 19:59:42 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 20:48:15 +00:00
|
|
|
//
|
2004-08-29 05:29:35 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file declares the llvm::sys::Program class.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2013-01-10 00:45:19 +00:00
|
|
|
#ifndef LLVM_SUPPORT_PROGRAM_H
|
|
|
|
#define LLVM_SUPPORT_PROGRAM_H
|
2004-08-29 05:29:35 +00:00
|
|
|
|
2013-04-11 14:06:34 +00:00
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
2010-11-29 18:16:10 +00:00
|
|
|
#include "llvm/Support/Path.h"
|
2013-06-11 20:00:56 +00:00
|
|
|
#include "llvm/Support/PathV1.h"
|
2013-06-12 20:42:59 +00:00
|
|
|
#include "llvm/Support/system_error.h"
|
2004-08-29 05:29:35 +00:00
|
|
|
|
|
|
|
namespace llvm {
|
2011-12-13 23:16:49 +00:00
|
|
|
class error_code;
|
2004-08-29 05:29:35 +00:00
|
|
|
namespace sys {
|
2013-06-12 20:58:35 +00:00
|
|
|
/// This static constructor (factory) will attempt to locate a program in
|
|
|
|
/// the operating system's file system using some pre-determined set of
|
|
|
|
/// locations to search (e.g. the PATH on Unix). Paths with slashes are
|
|
|
|
/// returned unmodified.
|
|
|
|
/// @returns A Path object initialized to the path of the program or a
|
|
|
|
/// Path object that is empty (invalid) if the program could not be found.
|
|
|
|
/// @brief Construct a Program by finding it by name.
|
2013-06-13 19:25:37 +00:00
|
|
|
std::string FindProgramByName(const std::string& name);
|
2013-06-12 20:58:35 +00:00
|
|
|
|
|
|
|
// These functions change the specified standard stream (stdin, stdout, or
|
|
|
|
// stderr) to binary mode. They return errc::success if the specified stream
|
|
|
|
// was changed. Otherwise a platform dependent error is returned.
|
|
|
|
error_code ChangeStdinToBinary();
|
|
|
|
error_code ChangeStdoutToBinary();
|
|
|
|
error_code ChangeStderrToBinary();
|
|
|
|
|
|
|
|
/// This function executes the program using the arguments provided. The
|
|
|
|
/// invoked program will inherit the stdin, stdout, and stderr file
|
|
|
|
/// descriptors, the environment and other configuration settings of the
|
|
|
|
/// invoking program.
|
|
|
|
/// This function waits the program to finish.
|
|
|
|
/// @returns an integer result code indicating the status of the program.
|
|
|
|
/// A zero or positive value indicates the result code of the program.
|
|
|
|
/// -1 indicates failure to execute
|
|
|
|
/// -2 indicates a crash during execution or timeout
|
|
|
|
int ExecuteAndWait(
|
|
|
|
const Path &path, ///< sys::Path object providing the path of the
|
2009-07-18 21:43:12 +00:00
|
|
|
///< program to be executed. It is presumed this is the result of
|
|
|
|
///< the FindProgramByName method.
|
2013-06-12 20:58:35 +00:00
|
|
|
const char **args, ///< A vector of strings that are passed to the
|
2009-07-18 21:43:12 +00:00
|
|
|
///< program. The first element should be the name of the program.
|
|
|
|
///< The list *must* be terminated by a null char* entry.
|
2013-06-12 20:58:35 +00:00
|
|
|
const char **env = 0, ///< An optional vector of strings to use for
|
2009-07-18 21:43:12 +00:00
|
|
|
///< the program's environment. If not provided, the current program's
|
|
|
|
///< environment will be used.
|
2013-06-12 20:58:35 +00:00
|
|
|
const sys::Path **redirects = 0, ///< An optional array of pointers to
|
2009-07-18 21:43:12 +00:00
|
|
|
///< Paths. If the array is null, no redirection is done. The array
|
|
|
|
///< should have a size of at least three. If the pointer in the array
|
|
|
|
///< are not null, then the inferior process's stdin(0), stdout(1),
|
|
|
|
///< and stderr(2) will be redirected to the corresponding Paths.
|
|
|
|
///< When an empty Path is passed in, the corresponding file
|
|
|
|
///< descriptor will be disconnected (ie, /dev/null'd) in a portable
|
|
|
|
///< way.
|
2013-06-12 20:58:35 +00:00
|
|
|
unsigned secondsToWait = 0, ///< If non-zero, this specifies the amount
|
|
|
|
///< of time to wait for the child process to exit. If the time
|
|
|
|
///< expires, the child is killed and this call returns. If zero,
|
|
|
|
///< this function will wait until the child finishes or forever if
|
|
|
|
///< it doesn't.
|
2009-07-18 21:43:12 +00:00
|
|
|
unsigned memoryLimit = 0, ///< If non-zero, this specifies max. amount
|
|
|
|
///< of memory can be allocated by process. If memory usage will be
|
|
|
|
///< higher limit, the child is killed and this call returns. If zero
|
|
|
|
///< - no memory limit.
|
2013-06-12 20:58:35 +00:00
|
|
|
std::string *ErrMsg = 0, ///< If non-zero, provides a pointer to a string
|
2009-07-18 21:43:12 +00:00
|
|
|
///< instance in which error messages will be returned. If the string
|
|
|
|
///< is non-empty upon return an error occurred while invoking the
|
|
|
|
///< program.
|
2013-06-12 20:58:35 +00:00
|
|
|
bool *ExecutionFailed = 0);
|
2013-06-12 20:42:59 +00:00
|
|
|
|
2013-06-13 20:06:28 +00:00
|
|
|
int ExecuteAndWait(StringRef path, const char **args, const char **env = 0,
|
|
|
|
const StringRef **redirects = 0,
|
|
|
|
unsigned secondsToWait = 0, unsigned memoryLimit = 0,
|
|
|
|
std::string *ErrMsg = 0, bool *ExecutionFailed = 0);
|
|
|
|
|
2013-06-12 20:58:35 +00:00
|
|
|
/// Similar to ExecuteAndWait, but return immediately.
|
|
|
|
void ExecuteNoWait(const Path &path, const char **args, const char **env = 0,
|
|
|
|
const sys::Path **redirects = 0, unsigned memoryLimit = 0,
|
|
|
|
std::string *ErrMsg = 0);
|
2013-06-12 20:42:59 +00:00
|
|
|
|
2013-04-11 14:06:34 +00:00
|
|
|
// Return true if the given arguments fit within system-specific
|
|
|
|
// argument length limits.
|
|
|
|
bool argumentsFitWithinSystemLimits(ArrayRef<const char*> Args);
|
2004-08-29 05:29:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|