nicole/cellar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity
3dc004d27a
cellar/include/subprocess.hpp
Nicholas O'Connor 1c91618f5c launching commands!
2017-03-23 21:20:26 -07:00

1623 lines
42 KiB
C++
Raw Blame History

/*!
Documentation for C++ subprocessing libraray.
@copyright The code is licensed under the [MIT
License](http://opensource.org/licenses/MIT):
<br>
Copyright &copy; 2016-2018 Arun Muralidharan.
<br>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
<br>
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
<br>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@author [Arun Muralidharan]
@see https://github.com/arun11299/cpp-subprocess to download the source code
@version 1.0.0
*/
#ifndef SUBPROCESS_HPP
#define SUBPROCESS_HPP
#include <map>
#include <algorithm>
#include <iostream>
#include <string>
#include <cstdlib>
#include <cassert>
#include <cstring>
#include <cstdio>
#include <future>
#include <vector>
#include <sstream>
#include <memory>
#include <initializer_list>
#include <exception>
extern "C" {
#include <unistd.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <signal.h>
}
/*!
* Getting started with reading this source code.
* The source is mainly divided into four parts:
* 1. Exception Classes:
* These are very basic exception classes derived from
* runtime_error exception.
* There are two types of exception thrown from subprocess
* library: OSError and CalledProcessError
*
* 2. Popen Class
* This is the main class the users will deal with. It
* provides with all the API's to deal with processes.
*
* 3. Util namespace
* It includes some helper functions to split/join a string,
* reading from file descriptors, waiting on a process, fcntl
* options on file descriptors etc.
*
* 4. Detail namespace
* This includes some metaprogramming and helper classes.
*/
namespace subprocess {
// Max buffer size allocated on stack for read error
// from pipe
static const size_t SP_MAX_ERR_BUF_SIZ = 1024;
// Default buffer capcity for OutBuffer and ErrBuffer.
// If the data exceeds this capacity, the buffer size is grown
// by 1.5 times its previous capacity
static const size_t DEFAULT_BUF_CAP_BYTES = 8192;
/*-----------------------------------------------
* EXCEPTION CLASSES
*-----------------------------------------------
*/
/*!
* class: CalledProcessError
* Thrown when there was error executing the command.
* Check Popen class API's to know when this exception
* can be thrown.
*
*/
class CalledProcessError: public std::runtime_error
{
public:
CalledProcessError(const std::string& error_msg):
std::runtime_error(error_msg)
{}
};
/*!
* class: OSError
* Thrown when some system call fails to execute or give result.
* The exception message contains the name of the failed system call
* with the stringisized errno code.
* Check Popen class API's to know when this exception would be
* thrown.
* Its usual that the API exception specification would have
* this exception together with CalledProcessError.
*/
class OSError: public std::runtime_error
{
public:
OSError(const std::string& err_msg, int err_code):
std::runtime_error( err_msg + " : " + std::strerror(err_code) )
{}
};
//--------------------------------------------------------------------
namespace util
{
/*!
* Function: split
* Parameters:
* [in] str : Input string which needs to be split based upon the
* delimiters provided.
* [in] deleims : Delimiter characters based upon which the string needs
* to be split. Default constructed to ' '(space) and '\t'(tab)
* [out] vector<string> : Vector of strings split at deleimiter.
*/
static std::vector<std::string>
split(const std::string& str, const std::string& delims=" \t")
{
std::vector<std::string> res;
size_t init = 0;
while (true) {
auto pos = str.find_first_of(delims, init);
if (pos == std::string::npos) {
res.emplace_back(str.substr(init, str.length()));
break;
}
res.emplace_back(str.substr(init, pos - init));
pos++;
init = pos;
}
return res;
}
/*!
* Function: join
* Parameters:
* [in] vec : Vector of strings which needs to be joined to form
* a single string with words seperated by
* a seperator char.
* [in] sep : String used to seperate 2 words in the joined string.
* Default constructed to ' ' (space).
* [out] string: Joined string.
*/
static
std::string join(const std::vector<std::string>& vec,
const std::string& sep = " ")
{
std::string res;
for (auto& elem : vec) res.append(elem + sep);
res.erase(--res.end());
return res;
}
/*!
* Function: set_clo_on_exec
* Sets/Resets the FD_CLOEXEC flag on the provided file descriptor
* based upon the `set` parameter.
* Parameters:
* [in] fd : The descriptor on which FD_CLOEXEC needs to be set/reset.
* [in] set : If 'true', set FD_CLOEXEC.
* If 'false' unset FD_CLOEXEC.
*/
static
void set_clo_on_exec(int fd, bool set = true)
{
int flags = fcntl(fd, F_GETFD, 0);
if (set) flags |= FD_CLOEXEC;
else flags &= ~FD_CLOEXEC;
//TODO: should check for errors
fcntl(fd, F_SETFD, flags);
}
/*!
* Function: pipe_cloexec
* Creates a pipe and sets FD_CLOEXEC flag on both
* read and write descriptors of the pipe.
* Parameters:
* [out] : A pair of file descriptors.
* First element of pair is the read descriptor of pipe.
* Second element is the write descriptor of pipe.
*/
static
std::pair<int, int> pipe_cloexec() throw (OSError)
{
int pipe_fds[2];
int res = pipe(pipe_fds);
if (res) {
throw OSError("pipe failure", errno);
}
set_clo_on_exec(pipe_fds[0]);
set_clo_on_exec(pipe_fds[1]);
return std::make_pair(pipe_fds[0], pipe_fds[1]);
}
/*!
* Function: write_n
* Writes `length` bytes to the file descriptor `fd`
* from the buffer `buf`.
* Parameters:
* [in] fd : The file descriptotr to write to.
* [in] buf: Buffer from which data needs to be written to fd.
* [in] length: The number of bytes that needs to be written from
* `buf` to `fd`.
* [out] int : Number of bytes written or -1 in case of failure.
*/
static
int write_n(int fd, const char* buf, size_t length)
{
int nwritten = 0;
while (nwritten < length) {
int written = write(fd, buf + nwritten, length - nwritten);
if (written == -1) return -1;
nwritten += written;
}
return nwritten;
}
/*!
* Function: read_atmost_n
* Reads at the most `read_upto` bytes from the
* file descriptor `fd` before returning.
* Parameters:
* [in] fd : The file descriptor from which it needs to read.
* [in] buf : The buffer into which it needs to write the data.
* [in] read_upto: Max number of bytes which must be read from `fd`.
* [out] int : Number of bytes written to `buf` or read from `fd`
* OR -1 in case of error.
* NOTE: In case of EINTR while reading from socket, this API
* will retry to read from `fd`, but only till the EINTR counter
* reaches 50 after which it will return with whatever data it read.
*/
static
int read_atmost_n(int fd, char* buf, size_t read_upto)
{
int rbytes = 0;
int eintr_cnter = 0;
while (1) {
int read_bytes = read(fd, buf, read_upto);
if (read_bytes == -1) {
if (errno == EINTR) {
if (eintr_cnter >= 50) return -1;
eintr_cnter++;
continue;
}
return -1;
}
if (read_bytes == 0) return rbytes;
rbytes += read_bytes;
}
return rbytes;
}
/*!
* Function: read_all
* Reads all the available data from `fd` into
* `buf`. Internally calls read_atmost_n.
* Parameters:
* [in] fd : The file descriptor from which to read from.
* [in] buf : The buffer of type `class Buffer` into which
* the read data is written to.
* [out] int: Number of bytes read OR -1 in case of failure.
*
* NOTE: `class Buffer` is a exposed public class. See below.
*/
template <typename Buffer>
// Requires Buffer to be of type class Buffer
static int read_all(int fd, Buffer& buf)
{
size_t orig_size = buf.size();
size_t increment = orig_size;
auto buffer = buf.data();
int total_bytes_read = 0;
while (1) {
int rd_bytes = read_atmost_n(fd, buffer, buf.size());
if (rd_bytes == increment) {
// Resize the buffer to accomodate more
orig_size = orig_size * 1.5;
increment = orig_size - buf.size();
buf.resize(orig_size);
buffer += rd_bytes;
total_bytes_read += rd_bytes;
} else if (rd_bytes != -1){
total_bytes_read += rd_bytes;
break;
} else {
if (total_bytes_read == 0) return -1;
break;
}
}
return total_bytes_read;
}
/*!
* Function: wait_for_child_exit
* Waits for the process with pid `pid` to exit
* and returns its status.
* Parameters:
* [in] pid : The pid of the process.
* [out] pair<int, int>:
* pair.first : Return code of the waitpid call.
* pair.second : Exit status of the process.
*
* NOTE: This is a blocking call as in, it will loop
* till the child is exited.
*/
static
std::pair<int, int> wait_for_child_exit(int pid)
{
int status = 0;
int ret = -1;
while (1) {
ret = waitpid(pid, &status, WNOHANG);
if (ret == -1) break;
if (ret == 0) continue;
return std::make_pair(ret, status);
}
return std::make_pair(ret, status);
}
}; // end namespace util
/* -------------------------------
* Popen Arguments
* -------------------------------
*/
/*!
* The buffer size of the stdin/stdout/stderr
* streams of the child process.
* Default value is 0.
*/
struct bufsize {
bufsize(int siz): bufsiz(siz) {}
int bufsiz = 0;
};
/*!
* Option to defer spawning of the child process
* till `Popen::start_process` API is called.
* Default value is false.
*/
struct defer_spawn {
defer_spawn(bool d): defer(d) {}
bool defer = false;
};
/*!
* Option to close all file descriptors
* when the child process is spawned.
* The close fd list does not include
* input/output/error if they are explicitly
* set as part of the Popen arguments.
*
* Default value is false.
*/
struct close_fds {
close_fds(bool c): close_all(c) {}
bool close_all = false;
};
/*!
* Option to make the child process as the
* session leader and thus the process
* group leader.
* Default value is false.
*/
struct session_leader {
session_leader(bool sl): leader_(sl) {}
bool leader_ = false;
};
struct shell {
shell(bool s): shell_(s) {}
bool shell_ = false;
};
/*!
* Base class for all arguments involving string value.
*/
struct string_arg
{
string_arg(const char* arg): arg_value(arg) {}
string_arg(std::string&& arg): arg_value(std::move(arg)) {}
string_arg(std::string arg): arg_value(std::move(arg)) {}
std::string arg_value;
};
/*!
* Option to specify the executable name seperately
* from the args sequence.
* In this case the cmd args must only contain the
* options required for this executable.
*
* Eg: executable{"ls"}
*/
struct executable: string_arg
{
template <typename T>
executable(T&& arg): string_arg(std::forward<T>(arg)) {}
};
/*!
* Option to set the current working directory
* of the spawned process.
*
* Eg: cwd{"/som/path/x"}
*/
struct cwd: string_arg
{
template <typename T>
cwd(T&& arg): string_arg(std::forward<T>(arg)) {}
};
/*!
* Option to specify environment variables required by
* the spawned process.
*
* Eg: environment{{ {"K1", "V1"}, {"K2", "V2"},... }}
*/
struct environment
{
environment(std::map<std::string, std::string>&& env):
env_(std::move(env)) {}
environment(const std::map<std::string, std::string>& env):
env_(env) {}
std::map<std::string, std::string> env_;
};
/*!
* Used for redirecting input/output/error
*/
enum IOTYPE {
STDOUT = 1,
STDERR,
PIPE,
};
//TODO: A common base/interface for below stream structures ??
/*!
* Option to specify the input channel for the child
* process. It can be:
* 1. An already open file descriptor.
* 2. A file name.
* 3. IOTYPE. Usuall a PIPE
*
* Eg: input{PIPE}
* OR in case of redirection, output of another Popen
* input{popen.output()}
*/
struct input
{
// For an already existing file descriptor.
input(int fd): rd_ch_(fd) {}
// FILE pointer.
input (FILE* fp):input(fileno(fp)) { assert(fp); }
input(const char* filename) {
int fd = open(filename, O_RDONLY);
if (fd == -1) throw OSError("File not found: ", errno);
rd_ch_ = fd;
}
input(IOTYPE typ) {
assert (typ == PIPE && "STDOUT/STDERR not allowed");
std::tie(rd_ch_, wr_ch_) = util::pipe_cloexec();
}
int rd_ch_ = -1;
int wr_ch_ = -1;
};
/*!
* Option to specify the output channel for the child
* process. It can be:
* 1. An already open file descriptor.
* 2. A file name.
* 3. IOTYPE. Usually a PIPE.
*
* Eg: output{PIPE}
* OR output{"output.txt"}
*/
struct output
{
output(int fd): wr_ch_(fd) {}
output (FILE* fp):output(fileno(fp)) { assert(fp); }
output(const char* filename) {
int fd = open(filename, O_APPEND | O_CREAT | O_RDWR, 0640);
if (fd == -1) throw OSError("File not found: ", errno);
wr_ch_ = fd;
}
output(IOTYPE typ) {
assert (typ == PIPE && "STDOUT/STDERR not allowed");
std::tie(rd_ch_, wr_ch_) = util::pipe_cloexec();
}
int rd_ch_ = -1;
int wr_ch_ = -1;
};
/*!
* Option to specify the error channel for the child
* process. It can be:
* 1. An already open file descriptor.
* 2. A file name.
* 3. IOTYPE. Usually a PIPE or STDOUT
*
*/
struct error
{
error(int fd): wr_ch_(fd) {}
error(FILE* fp):error(fileno(fp)) { assert(fp); }
error(const char* filename) {
int fd = open(filename, O_APPEND | O_CREAT | O_RDWR, 0640);
if (fd == -1) throw OSError("File not found: ", errno);
wr_ch_ = fd;
}
error(IOTYPE typ) {
assert ((typ == PIPE || typ == STDOUT) && "STDERR not aloowed");
if (typ == PIPE) {
std::tie(rd_ch_, wr_ch_) = util::pipe_cloexec();
} else {
// Need to defer it till we have checked all arguments
deferred_ = true;
}
}
bool deferred_ = false;
int rd_ch_ = -1;
int wr_ch_ = -1;
};
// Impoverished, meager, needy, truly needy
// version of type erasure to store function pointers
// needed to provide the functionality of preexec_func
// ATTN: Can be used only to execute functions with no
// arguments and returning void.
// Could have used more efficient methods, ofcourse, but
// that wont yield me the consistent syntax which I am
// aiming for. If you know, then please do let me know.
class preexec_func
{
public:
preexec_func() {}
template <typename Func>
preexec_func(Func f): holder_(new FuncHolder<Func>(f))
{}
void operator()() {
(*holder_)();
}
private:
struct HolderBase {
virtual void operator()() const;
};
template <typename T>
struct FuncHolder: HolderBase {
FuncHolder(T func): func_(func) {}
void operator()() const override {}
// The function pointer/reference
T func_;
};
std::unique_ptr<HolderBase> holder_ = nullptr;
};
// ~~~~ End Popen Args ~~~~
/*!
* class: Buffer
* This class is a very thin wrapper around std::vector<char>
* This is basically used to determine the length of the actual
* data stored inside the dynamically resized vector.
*
* This is what is returned as the output to communicate and check_output
* functions, so, users must know about this class.
*
* OutBuffer and ErrBuffer are just different typedefs to this class.
*/
class Buffer
{
public:
Buffer() {}
Buffer(size_t cap) { buf.resize(cap); }
void add_cap(size_t cap) { buf.resize(cap); }
#if 0
Buffer(const Buffer& other):
buf(other.buf),
length(other.length)
{
std::cout << "COPY" << std::endl;
}
Buffer(Buffer&& other):
buf(std::move(other.buf)),
length(other.length)
{
std::cout << "MOVE" << std::endl;
}
#endif
public:
std::vector<char> buf;
size_t length = 0;
};
// Buffer for storing output written to output fd
using OutBuffer = Buffer;
// Buffer for storing output written to error fd
using ErrBuffer = Buffer;
// Fwd Decl.
class Popen;
/*---------------------------------------------------
* DETAIL NAMESPACE
*---------------------------------------------------
*/
namespace detail {
// Metaprogram for searching a type within
// a variadic parameter pack
// This is particularly required to do a compile time
// checking of the arguments provided to 'check_ouput' function
// wherein the user is not expected to provide an 'ouput' option.
template <typename... T> struct param_pack{};
template <typename F, typename T> struct has_type;
template <typename F>
struct has_type<F, param_pack<>> {
static constexpr bool value = false;
};
template <typename F, typename... T>
struct has_type<F, param_pack<F, T...>> {
static constexpr bool value = true;
};
template <typename F, typename H, typename... T>
struct has_type<F, param_pack<H,T...>> {
static constexpr bool value =
std::is_same<F, typename std::decay<H>::type>::value ? true : has_type<F, param_pack<T...>>::value;
};
//----
/*!
* A helper class to Popen class for setting
* options as provided in the Popen constructor
* or in check_ouput arguments.
* This design allows us to _not_ have any fixed position
* to any arguments and specify them in a way similar to what
* can be done in python.
*/
struct ArgumentDeducer
{
ArgumentDeducer(Popen* p): popen_(p) {}
void set_option(executable&& exe);
void set_option(cwd&& cwdir);
void set_option(bufsize&& bsiz);
void set_option(environment&& env);
void set_option(defer_spawn&& defer);
void set_option(shell&& sh);
void set_option(input&& inp);
void set_option(output&& out);
void set_option(error&& err);
void set_option(close_fds&& cfds);
void set_option(preexec_func&& prefunc);
void set_option(session_leader&& sleader);
private:
Popen* popen_ = nullptr;
};
/*!
* A helper class to Popen.
* This takes care of all the fork-exec logic
* in the execute_child API.
*/
class Child
{
public:
Child(Popen* p, int err_wr_pipe):
parent_(p),
err_wr_pipe_(err_wr_pipe)
{}
void execute_child();
private:
// Lets call it parent even though
// technically a bit incorrect
Popen* parent_ = nullptr;
int err_wr_pipe_ = -1;
};
// Fwd Decl.
class Streams;
/*!
* A helper class to Streams.
* This takes care of management of communicating
* with the child process with the means of the correct
* file descriptor.
*/
class Communication
{
public:
Communication(Streams* stream): stream_(stream)
{}
void operator=(const Communication&) = delete;
public:
int send(const char* msg, size_t length);
int send(const std::vector<char>& msg);
std::pair<OutBuffer, ErrBuffer> communicate(const char* msg, size_t length);
std::pair<OutBuffer, ErrBuffer> communicate(const std::vector<char>& msg)
{ return communicate(msg.data(), msg.size()); }
void set_out_buf_cap(size_t cap) { out_buf_cap_ = cap; }
void set_err_buf_cap(size_t cap) { err_buf_cap_ = cap; }
private:
std::pair<OutBuffer, ErrBuffer> communicate_threaded(
const char* msg, size_t length);
private:
Streams* stream_;
size_t out_buf_cap_ = DEFAULT_BUF_CAP_BYTES;
size_t err_buf_cap_ = DEFAULT_BUF_CAP_BYTES;
};
/*!
* This is a helper class to Popen.
* It takes care of management of all the file descriptors
* and file pointers.
* It dispatches of the communication aspects to the
* Communication class.
* Read through the data members to understand about the
* various file descriptors used.
*/
class Streams
{
public:
Streams():comm_(this) {}
void operator=(const Streams&) = delete;
public:
void setup_comm_channels();
void cleanup_fds()
{
if (write_to_child_ != -1 && read_from_parent_ != -1) {
close(write_to_child_);
}
if (write_to_parent_ != -1 && read_from_child_ != -1) {
close(read_from_child_);
}
if (err_write_ != -1 && err_read_ != -1) {
close(err_read_);
}
}
void close_parent_fds()
{
if (write_to_child_ != -1) close(write_to_child_);
if (read_from_child_ != -1) close(read_from_child_);
if (err_read_ != -1) close(err_read_);
}
void close_child_fds()
{
if (write_to_parent_ != -1) close(write_to_parent_);
if (read_from_parent_ != -1) close(read_from_parent_);
if (err_write_ != -1) close(err_write_);
}
FILE* input() { return input_.get(); }
FILE* output() { return output_.get(); }
FILE* error() { return error_.get(); }
void input(FILE* fp) { input_.reset(fp, fclose); }
void output(FILE* fp) { output_.reset(fp, fclose); }
void error(FILE* fp) { error_.reset(fp, fclose); }
void set_out_buf_cap(size_t cap) { comm_.set_out_buf_cap(cap); }
void set_err_buf_cap(size_t cap) { comm_.set_err_buf_cap(cap); }
public: /* Communication forwarding API's */
int send(const char* msg, size_t length)
{ return comm_.send(msg, length); }
int send(const std::vector<char>& msg)
{ return comm_.send(msg); }
std::pair<OutBuffer, ErrBuffer> communicate(const char* msg, size_t length)
{ return comm_.communicate(msg, length); }
std::pair<OutBuffer, ErrBuffer> communicate(const std::vector<char>& msg)
{ return comm_.communicate(msg); }
public:// Yes they are public
std::shared_ptr<FILE> input_ = nullptr;
std::shared_ptr<FILE> output_ = nullptr;
std::shared_ptr<FILE> error_ = nullptr;
// Buffer size for the IO streams
int bufsiz_ = 0;
// Pipes for communicating with child
// Emulates stdin
int write_to_child_ = -1; // Parent owned descriptor
int read_from_parent_ = -1; // Child owned descriptor
// Emulates stdout
int write_to_parent_ = -1; // Child owned descriptor
int read_from_child_ = -1; // Parent owned descriptor
// Emulates stderr
int err_write_ = -1; // Write error to parent (Child owned)
int err_read_ = -1; // Read error from child (Parent owned)
private:
Communication comm_;
};
}; // end namespace detail
/*!
* class: Popen
* This is the single most important class in the whole library
* and glues together all the helper classes to provide a common
* interface to the client.
*
* API's provided by the class:
* 1. Popen({"cmd"}, output{..}, error{..}, cwd{..}, ....)
* Command provided as a sequence.
* 2. Popen("cmd arg1"m output{..}, error{..}, cwd{..}, ....)
* Command provided in a single string.
* 3. wait() - Wait for the child to exit.
* 4. retcode() - The return code of the exited child.
* 5. pid() - PID of the spawned child.
* 6. poll() - Check the status of the running child.
* 7. kill(sig_num) - Kill the child. SIGTERM used by default.
* 8. send(...) - Send input to the input channel of the child.
* 9. communicate(...) - Get the output/error from the child and close the channels
* from the parent side.
*10. input() - Get the input channel/File pointer. Can be used for
* cutomizing the way of sending input to child.
*11. output() - Get the output channel/File pointer. Usually used
in case of redirection. See piping examples.
*12. error() - Get the error channel/File poiner. Usually used
in case of redirection.
*13. start_process() - Start the child process. Only to be used when
* `defer_spawn` option was provided in Popen constructor.
*/
class Popen
{
public:
friend class detail::ArgumentDeducer;
friend class detail::Child;
template <typename... Args>
Popen(const std::string& cmd_args, Args&& ...args):
args_(cmd_args)
{
vargs_ = util::split(cmd_args);
init_args(std::forward<Args>(args)...);
// Setup the communication channels of the Popen class
stream_.setup_comm_channels();
if (!defer_process_start_) execute_process();
}
template <typename... Args>
Popen(std::initializer_list<const char*> cmd_args, Args&& ...args)
{
vargs_.insert(vargs_.end(), cmd_args.begin(), cmd_args.end());
init_args(std::forward<Args>(args)...);
// Setup the communication channels of the Popen class
stream_.setup_comm_channels();
if (!defer_process_start_) execute_process();
}
void start_process() throw (CalledProcessError, OSError);
int pid() const noexcept { return child_pid_; }
int retcode() const noexcept { return retcode_; }
int wait() throw(OSError);
int poll() throw(OSError);
// Does not fail, Caller is expected to recheck the
// status with a call to poll()
void kill(int sig_num = 9);
void set_out_buf_cap(size_t cap) { stream_.set_out_buf_cap(cap); }
void set_err_buf_cap(size_t cap) { stream_.set_err_buf_cap(cap); }
int send(const char* msg, size_t length)
{ return stream_.send(msg, length); }
int send(const std::vector<char>& msg)
{ return stream_.send(msg); }
std::pair<OutBuffer, ErrBuffer> communicate(const char* msg, size_t length)
{
auto res = stream_.communicate(msg, length);
wait();
return res;
}
std::pair<OutBuffer, ErrBuffer> communicate(const std::vector<char>& msg)
{
auto res = stream_.communicate(msg);
wait();
return res;
}
std::pair<OutBuffer, ErrBuffer> communicate()
{
return communicate(nullptr, 0);
}
FILE* input() { return stream_.input(); }
FILE* output() { return stream_.output();}
FILE* error() { return stream_.error(); }
private:
template <typename F, typename... Args>
void init_args(F&& farg, Args&&... args);
void init_args();
void populate_c_argv();
void execute_process() throw (CalledProcessError, OSError);
private:
detail::Streams stream_;
bool defer_process_start_ = false;
bool close_fds_ = false;
bool has_preexec_fn_ = false;
bool shell_ = false;
bool session_leader_ = false;
std::string exe_name_;
std::string cwd_;
std::map<std::string, std::string> env_;
preexec_func preexec_fn_;
// Command in string format
std::string args_;
// Comamnd provided as sequence
std::vector<std::string> vargs_;
std::vector<char*> cargv_;
bool child_created_ = false;
// Pid of the child process
int child_pid_ = -1;
int retcode_ = -1;
};
void Popen::init_args() {
populate_c_argv();
}
template <typename F, typename... Args>
void Popen::init_args(F&& farg, Args&&... args)
{
detail::ArgumentDeducer argd(this);
argd.set_option(std::forward<F>(farg));
init_args(std::forward<Args>(args)...);
}
void Popen::populate_c_argv()
{
cargv_.clear();
cargv_.reserve(vargs_.size() + 1);
for (auto& arg : vargs_) cargv_.push_back(&arg[0]);
cargv_.push_back(nullptr);
}
void Popen::start_process() throw (CalledProcessError, OSError)
{
// The process was started/tried to be started
// in the constructor itself.
// For explicitly calling this API to start the
// process, 'defer_spawn' argument must be set to
// true in the constructor.
if (!defer_process_start_) {
assert (0);
return;
}
execute_process();
}
int Popen::wait() throw (OSError)
{
int ret, status;
std::tie(ret, status) = util::wait_for_child_exit(pid());
if (ret == -1) {
if (errno != ECHILD) throw OSError("waitpid failed", errno);
return 0;
}
if (WIFEXITED(status)) return WEXITSTATUS(status);
if (WIFSIGNALED(status)) return WTERMSIG(status);
else return 255;
return 0;
}
int Popen::poll() throw (OSError)
{
int status;
if (!child_created_) return -1; // TODO: ??
// Returns zero if child is still running
int ret = waitpid(child_pid_, &status, WNOHANG);
if (ret == 0) return -1;
if (ret == child_pid_) {
if (WIFSIGNALED(status)) {
retcode_ = WTERMSIG(status);
} else if (WIFEXITED(status)) {
retcode_ = WEXITSTATUS(status);
} else {
retcode_ = 255;
}
return retcode_;
}
if (ret == -1) {
// From subprocess.py
// This happens if SIGCHLD is set to be ignored
// or waiting for child process has otherwise been disabled
// for our process. This child is dead, we cannot get the
// status.
if (errno == ECHILD) retcode_ = 0;
else throw OSError("waitpid failed", errno);
} else {
retcode_ = ret;
}
return retcode_;
}
void Popen::kill(int sig_num)
{
if (session_leader_) killpg(child_pid_, sig_num);
else ::kill(child_pid_, sig_num);
}
void Popen::execute_process() throw (CalledProcessError, OSError)
{
int err_rd_pipe, err_wr_pipe;
std::tie(err_rd_pipe, err_wr_pipe) = util::pipe_cloexec();
if (shell_) {
auto new_cmd = util::join(vargs_);
vargs_.clear();
vargs_.insert(vargs_.begin(), {"/bin/sh", "-c"});
vargs_.push_back(new_cmd);
populate_c_argv();
}
if (exe_name_.length()) {
vargs_.insert(vargs_.begin(), exe_name_);
populate_c_argv();
}
exe_name_ = vargs_[0];
child_pid_ = fork();
if (child_pid_ < 0) {
close(err_rd_pipe);
close(err_wr_pipe);
throw OSError("fork failed", errno);
}
child_created_ = true;
if (child_pid_ == 0)
{
// Close descriptors belonging to parent
stream_.close_parent_fds();
//Close the read end of the error pipe
close(err_rd_pipe);
detail::Child chld(this, err_wr_pipe);
chld.execute_child();
}
else
{
int sys_ret = -1;
close (err_wr_pipe);// close child side of pipe, else get stuck in read below
stream_.close_child_fds();
try {
char err_buf[SP_MAX_ERR_BUF_SIZ] = {0,};
int read_bytes = util::read_atmost_n(
err_rd_pipe,
err_buf,
SP_MAX_ERR_BUF_SIZ);
close(err_rd_pipe);
if (read_bytes || strlen(err_buf)) {
// Call waitpid to reap the child process
// waitpid suspends the calling process until the
// child terminates.
wait();
// Throw whatever information we have about child failure
throw CalledProcessError(err_buf);
}
} catch (std::exception& exp) {
stream_.cleanup_fds();
throw exp;
}
}
}
namespace detail {
void ArgumentDeducer::set_option(executable&& exe) {
popen_->exe_name_ = std::move(exe.arg_value);
}
void ArgumentDeducer::set_option(cwd&& cwdir) {
popen_->cwd_ = std::move(cwdir.arg_value);
}
void ArgumentDeducer::set_option(bufsize&& bsiz) {
popen_->stream_.bufsiz_ = bsiz.bufsiz;
}
void ArgumentDeducer::set_option(environment&& env) {
popen_->env_ = std::move(env.env_);
}
void ArgumentDeducer::set_option(defer_spawn&& defer) {
popen_->defer_process_start_ = defer.defer;
}
void ArgumentDeducer::set_option(shell&& sh) {
popen_->shell_ = sh.shell_;
}
void ArgumentDeducer::set_option(session_leader&& sleader) {
popen_->session_leader_ = sleader.leader_;
}
void ArgumentDeducer::set_option(input&& inp) {
if (inp.rd_ch_ != -1) popen_->stream_.read_from_parent_ = inp.rd_ch_;
if (inp.wr_ch_ != -1) popen_->stream_.write_to_child_ = inp.wr_ch_;
}
void ArgumentDeducer::set_option(output&& out) {
if (out.wr_ch_ != -1) popen_->stream_.write_to_parent_ = out.wr_ch_;
if (out.rd_ch_ != -1) popen_->stream_.read_from_child_ = out.rd_ch_;
}
void ArgumentDeducer::set_option(error&& err) {
if (err.deferred_) {
if (popen_->stream_.write_to_parent_) {
popen_->stream_.err_write_ = popen_->stream_.write_to_parent_;
} else {
throw std::runtime_error("Set output before redirecting error to output");
}
}
if (err.wr_ch_ != -1) popen_->stream_.err_write_ = err.wr_ch_;
if (err.rd_ch_ != -1) popen_->stream_.err_read_ = err.rd_ch_;
}
void ArgumentDeducer::set_option(close_fds&& cfds) {
popen_->close_fds_ = cfds.close_all;
}
void ArgumentDeducer::set_option(preexec_func&& prefunc) {
popen_->preexec_fn_ = std::move(prefunc);
popen_->has_preexec_fn_ = true;
}
void Child::execute_child() {
int sys_ret = -1;
auto& stream = parent_->stream_;
try {
if (stream.write_to_parent_ == 0)
stream.write_to_parent_ = dup(stream.write_to_parent_);
if (stream.err_write_ == 0 || stream.err_write_ == 1)
stream.err_write_ = dup(stream.err_write_);
// Make the child owned descriptors as the
// stdin, stdout and stderr for the child process
auto _dup2_ = [](int fd, int to_fd) {
if (fd == to_fd) {
// dup2 syscall does not reset the
// CLOEXEC flag if the descriptors
// provided to it are same.
// But, we need to reset the CLOEXEC
// flag as the provided descriptors
// are now going to be the standard
// input, output and error
util::set_clo_on_exec(fd, false);
} else if(fd != -1) {
int res = dup2(fd, to_fd);
if (res == -1) throw OSError("dup2 failed", errno);
}
};
// Create the standard streams
_dup2_(stream.read_from_parent_, 0); // Input stream
_dup2_(stream.write_to_parent_, 1); // Output stream
_dup2_(stream.err_write_, 2); // Error stream
// Close the duped descriptors
if (stream.read_from_parent_ != -1 && stream.read_from_parent_ > 2)
close(stream.read_from_parent_);
if (stream.write_to_parent_ != -1 && stream.write_to_parent_ > 2)
close(stream.write_to_parent_);
if (stream.err_write_ != -1 && stream.err_write_ > 2)
close(stream.err_write_);
// Close all the inherited fd's except the error write pipe
if (parent_->close_fds_) {
int max_fd = sysconf(_SC_OPEN_MAX);
if (max_fd == -1) throw OSError("sysconf failed", errno);
for (int i = 3; i < max_fd; i++) {
if (i == err_wr_pipe_) continue;
close(i);
}
}
// Change the working directory if provided
if (parent_->cwd_.length()) {
sys_ret = chdir(parent_->cwd_.c_str());
if (sys_ret == -1) throw OSError("chdir failed", errno);
}
if (parent_->has_preexec_fn_) {
parent_->preexec_fn_();
}
if (parent_->session_leader_) {
sys_ret = setsid();
if (sys_ret == -1) throw OSError("setsid failed", errno);
}
// Replace the current image with the executable
if (parent_->env_.size()) {
for (auto& kv : parent_->env_) {
setenv(kv.first.c_str(), kv.second.c_str(), 1);
}
sys_ret = execvp(parent_->exe_name_.c_str(), parent_->cargv_.data());
} else {
sys_ret = execvp(parent_->exe_name_.c_str(), parent_->cargv_.data());
}
if (sys_ret == -1) throw OSError("execve failed", errno);
} catch (const OSError& exp) {
// Just write the exception message
// TODO: Give back stack trace ?
std::string err_msg(exp.what());
//ATTN: Can we do something on error here ?
util::write_n(err_wr_pipe_, err_msg.c_str(), err_msg.length());
throw exp;
}
// Calling application would not get this
// exit failure
exit (EXIT_FAILURE);
}
void Streams::setup_comm_channels()
{
if (write_to_child_ != -1) input(fdopen(write_to_child_, "wb"));
if (read_from_child_ != -1) output(fdopen(read_from_child_, "rb"));
if (err_read_ != -1) error(fdopen(err_read_, "rb"));
auto handles = {input(), output(), error()};
for (auto& h : handles) {
if (h == nullptr) continue;
switch (bufsiz_) {
case 0:
setvbuf(h, nullptr, _IONBF, BUFSIZ);
break;
case 1:
setvbuf(h, nullptr, _IONBF, BUFSIZ);
break;
default:
setvbuf(h, nullptr, _IOFBF, bufsiz_);
};
}
}
int Communication::send(const char* msg, size_t length)
{
if (stream_->input() == nullptr) return -1;
return std::fwrite(msg, sizeof(char), length, stream_->input());
}
int Communication::send(const std::vector<char>& msg)
{
return send(msg.data(), msg.size());
}
std::pair<OutBuffer, ErrBuffer>
Communication::communicate(const char* msg, size_t length)
{
// Optimization from subprocess.py
// If we are using one pipe, or no pipe
// at all, using select() or threads is unnecessary.
auto hndls = {stream_->input(), stream_->output(), stream_->error()};
int count = std::count(std::begin(hndls), std::end(hndls), nullptr);
if (count >= 2) {
OutBuffer obuf;
ErrBuffer ebuf;
if (stream_->input()) {
if (msg) {
int wbytes = std::fwrite(msg, sizeof(char), length, stream_->input());
if (wbytes < length) {
if (errno != EPIPE && errno != EINVAL) {
throw OSError("fwrite error", errno);
}
}
}
// Close the input stream
stream_->input_.reset();
} else if (stream_->output()) {
// Read till EOF
// ATTN: This could be blocking, if the process
// at the other end screws up, we get screwed up as well
obuf.add_cap(out_buf_cap_);
int rbytes = util::read_all(
fileno(stream_->output()),
obuf.buf);
if (rbytes == -1) {
throw OSError("read to obuf failed", errno);
}
obuf.length = rbytes;
// Close the output stream
stream_->output_.reset();
} else if (stream_->error()) {
// Same screwness applies here as well
ebuf.add_cap(err_buf_cap_);
int rbytes = util::read_atmost_n(
fileno(stream_->error()),
ebuf.buf.data(),
ebuf.buf.size());
if (rbytes == -1) {
throw OSError("read to ebuf failed", errno);
}
ebuf.length = rbytes;
// Close the error stream
stream_->error_.reset();
}
return std::make_pair(std::move(obuf), std::move(ebuf));
}
return communicate_threaded(msg, length);
}
std::pair<OutBuffer, ErrBuffer>
Communication::communicate_threaded(const char* msg, size_t length)
{
OutBuffer obuf;
ErrBuffer ebuf;
std::future<int> out_fut, err_fut;
if (stream_->output()) {
obuf.add_cap(out_buf_cap_);
out_fut = std::async(std::launch::async,
[&obuf, this] {
return util::read_all(fileno(this->stream_->output()), obuf.buf);
});
}
if (stream_->error()) {
ebuf.add_cap(err_buf_cap_);
err_fut = std::async(std::launch::async,
[&ebuf, this] {
return util::read_all(fileno(this->stream_->error()), ebuf.buf);
});
}
if (stream_->input()) {
if (msg) {
int wbytes = std::fwrite(msg, sizeof(char), length, stream_->input());
if (wbytes < length) {
if (errno != EPIPE && errno != EINVAL) {
throw OSError("fwrite error", errno);
}
}
}
stream_->input_.reset();
}
if (out_fut.valid()) {
int res = out_fut.get();
if (res != -1) obuf.length = res;
else obuf.length = 0;
}
if (err_fut.valid()) {
int res = err_fut.get();
if (res != -1) ebuf.length = res;
else ebuf.length = 0;
}
return std::make_pair(std::move(obuf), std::move(ebuf));
}
}; // end namespace detail
// Convenience Functions
//
//
namespace detail
{
template<typename F, typename... Args>
OutBuffer check_output_impl(F& farg, Args&&... args)
{
static_assert(!detail::has_type<output, detail::param_pack<Args...>>::value, "output not allowed in args");
auto p = Popen(std::forward<F>(farg), std::forward<Args>(args)..., output{PIPE});
auto res = p.communicate();
auto retcode = p.poll();
if (retcode > 0) {
throw CalledProcessError("Command failed : Non zero retcode");
}
return std::move(res.first);
}
template<typename F, typename... Args>
int call_impl(F& farg, Args&&... args)
{
return Popen(std::forward<F>(farg), std::forward<Args>(args)...).wait();
}
void pipeline_impl(std::vector<Popen>& cmds) { /* EMPTY IMPL */ }
template<typename... Args>
void pipeline_impl(std::vector<Popen>& cmds,
const std::string& cmd,
Args&&... args)
{
if (cmds.size() == 0) {
cmds.emplace_back(cmd, output{PIPE}, defer_spawn{true});
} else {
cmds.emplace_back(cmd, input{cmds.back().output()}, output{PIPE}, defer_spawn{true});
}
pipeline_impl(cmds, std::forward<Args>(args)...);
}
}
/*-----------------------------------------------------------
* CONVIENIENCE FUNCTIONS
*-----------------------------------------------------------
*/
/*!
* Run the command with arguments and wait for it to complete.
* The parameters passed to the argument are exactly the same
* one would use for Popen constructors.
*/
template<typename... Args>
int call(std::initializer_list<const char*> plist, Args&&... args)
{
return (detail::call_impl(plist, std::forward<Args>(args)...));
}
template<typename... Args>
int call(const std::string& arg, Args&&... args)
{
return (detail::call_impl(arg, std::forward<Args>(args)...));
}
/*!
* Run the command with arguments and wait for it to complete.
* If the exit code was non-zero it raises a CalledProcessError.
* The arguments are the same as for the Popen constructor.
*/
template <typename... Args>
OutBuffer check_output(std::initializer_list<const char*> plist, Args&&... args)
{
return (detail::check_output_impl(plist, std::forward<Args>(args)...));
}
template <typename... Args>
OutBuffer check_output(const std::string& arg, Args&&... args)
{
return (detail::check_output_impl(arg, std::forward<Args>(args)...));
}
/*!
* An easy way to pipeline easy commands.
* Provide the commands that needs to be pipelined in the order they
* would appear in a regular command.
* It would wait for the last command provided in the pipeline
* to finish and then return the OutBuffer.
*/
template<typename... Args>
// Args expected to be flat commands using string instead of initializer_list
OutBuffer pipeline(Args&&... args)
{
std::vector<Popen> pcmds;
detail::pipeline_impl(pcmds, std::forward<Args>(args)...);
for (auto& p : pcmds) p.start_process();
return (pcmds.back().communicate().first);
}
};
#endif // SUBPROCESS_HPP
Reference in New Issue View Git Blame Copy Permalink