// Copyright (c) 2006, 2007 Julio M. Merino Vidal // Copyright (c) 2008 Ilya Sokolov, Boris Schaeling // Copyright (c) 2009 Boris Schaeling // Copyright (c) 2010 Felipe Tanus, Boris Schaeling // Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling // // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) #ifndef BOOST_PROCESS_DETAIL_POSIX_EXECUTOR_HPP #define BOOST_PROCESS_DETAIL_POSIX_EXECUTOR_HPP #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace boost { namespace process { namespace detail { namespace posix { template struct on_setup_t { Executor & exec; on_setup_t(Executor & exec) : exec(exec) {}; template void operator()(T & t) const { if (!exec.error()) t.on_setup(exec); } }; template struct on_error_t { Executor & exec; const std::error_code & error; on_error_t(Executor & exec, const std::error_code & error) : exec(exec), error(error) {}; template void operator()(T & t) const { t.on_error(exec, error); } }; template struct on_success_t { Executor & exec; on_success_t(Executor & exec) : exec(exec) {}; template void operator()(T & t) const {t.on_success(exec);} }; template struct on_fork_error_t { Executor & exec; const std::error_code & error; on_fork_error_t(Executor & exec, const std::error_code & error) : exec(exec), error(error) {}; template void operator()(T & t) const { t.on_fork_error(exec, error); } }; template struct on_exec_setup_t { Executor & exec; on_exec_setup_t(Executor & exec) : exec(exec) {}; template void operator()(T & t) const { t.on_exec_setup(exec); } }; template struct on_exec_error_t { Executor & exec; const std::error_code &ec; on_exec_error_t(Executor & exec, const std::error_code & error) : exec(exec), ec(error) {}; template void operator()(T & t) const { t.on_exec_error(exec, ec); } }; template struct on_fork_success_t { Executor & exec; on_fork_success_t(Executor & exec) : exec(exec) {}; template void operator()(T & t) const { t.on_fork_success(exec); } }; template on_setup_t call_on_setup (Executor & exec) {return exec;} template on_error_t call_on_error (Executor & exec, const std::error_code & ec) { return on_error_t (exec, ec); } template on_success_t call_on_success(Executor & exec) {return exec;} template on_fork_error_t call_on_fork_error (Executor & exec, const std::error_code & ec) { return on_fork_error_t (exec, ec); } template on_exec_setup_t call_on_exec_setup (Executor & exec) {return exec;} template on_exec_error_t call_on_exec_error (Executor & exec, const std::error_code & ec) { return on_exec_error_t (exec, ec); } template class executor { template void internal_error_handle(const std::error_code&, const char*, HasHandler, boost::mpl::true_, UseVFork) {} int _pipe_sink = -1; void write_error(const std::error_code & ec, const char * msg) { //I am the child int len = ec.value(); ::write(_pipe_sink, &len, sizeof(int)); len = std::strlen(msg) + 1; ::write(_pipe_sink, &len, sizeof(int)); ::write(_pipe_sink, msg, len); } void internal_error_handle(const std::error_code &ec, const char* msg, boost::mpl::true_ , boost::mpl::false_, boost::mpl::false_) { if (this->pid == 0) //on the fork. write_error(ec, msg); else { this->_ec = ec; this->_msg = msg; } } void internal_error_handle(const std::error_code &ec, const char* msg, boost::mpl::false_, boost::mpl::false_, boost::mpl::false_) { if (this->pid == 0) write_error(ec, msg); else throw process_error(ec, msg); } void internal_error_handle(const std::error_code &ec, const char* msg, boost::mpl::true_ , boost::mpl::false_, boost::mpl::true_) { this->_ec = ec; this->_msg = msg; } void internal_error_handle(const std::error_code &ec, const char* msg, boost::mpl::false_, boost::mpl::false_, boost::mpl::true_) { if (this->pid == 0) { this->_ec = ec; this->_msg = msg; } else throw process_error(ec, msg); } void check_error(boost::mpl::true_) {}; void check_error(boost::mpl::false_) { if (_ec) throw process_error(_ec, _msg); } typedef typename ::boost::process::detail::has_error_handler::type has_error_handler; typedef typename ::boost::process::detail::has_ignore_error ::type has_ignore_error; typedef typename ::boost::process::detail::posix::shall_use_vfork::type shall_use_vfork; inline child invoke(boost::mpl::true_ , boost::mpl::true_ ); inline child invoke(boost::mpl::false_, boost::mpl::true_ ); inline child invoke(boost::mpl::true_ , boost::mpl::false_ ); inline child invoke(boost::mpl::false_, boost::mpl::false_ ); void _write_error(int sink) { int data[2] = {_ec.value(),static_cast(_msg.size())}; while (::write(sink, &data[0], sizeof(int) *2) == -1) { auto err = errno; if (err == EBADF) return; else if ((err != EINTR) && (err != EAGAIN)) break; } while (::write(sink, &_msg.front(), _msg.size()) == -1) { auto err = errno; if (err == EBADF) return; else if ((err != EINTR) && (err != EAGAIN)) break; } } void _read_error(int source) { int data[2]; _ec.clear(); int count = 0; while ((count = ::read(source, &data[0], sizeof(int) *2 ) ) == -1) { //actually, this should block until it's read. auto err = errno; if ((err != EAGAIN ) && (err != EINTR)) set_error(std::error_code(err, std::system_category()), "Error read pipe"); } if (count == 0) return ; std::error_code ec(data[0], std::system_category()); std::string msg(data[1], ' '); while (::read(source, &msg.front(), msg.size() ) == -1) { //actually, this should block until it's read. auto err = errno; if ((err == EBADF) || (err == EPERM))//that should occur on success, therefore return. return; //EAGAIN not yet forked, EINTR interrupted, i.e. try again else if ((err != EAGAIN ) && (err != EINTR)) set_error(std::error_code(err, std::system_category()), "Error read pipe"); } set_error(ec, std::move(msg)); } std::string prepare_cmd_style_fn; //buffer inline void prepare_cmd_style() //this does what execvpe does - but we execute it in the father process, to avoid allocations. { //use my own implementation prepare_cmd_style_fn = exe; if ((prepare_cmd_style_fn.find('/') == std::string::npos) && ::access(prepare_cmd_style_fn.c_str(), X_OK)) { auto e = ::environ; while ((*e != nullptr) && !boost::starts_with(*e, "PATH=")) e++; if (e != nullptr) { std::vector path; boost::split(path, *e, boost::is_any_of(":")); for (const std::string & pp : path) { auto p = pp + "/" + exe; if (!::access(p.c_str(), X_OK)) { prepare_cmd_style_fn = p; break; } } } } exe = prepare_cmd_style_fn.c_str(); } std::error_code _ec; std::string _msg; public: executor(Sequence & seq) : seq(seq) { } child operator()() { return invoke(has_ignore_error(), shall_use_vfork()); } Sequence & seq; const char * exe = nullptr; char *const* cmd_line = nullptr; bool cmd_style = false; char **env = ::environ; pid_t pid = -1; std::shared_ptr> exit_status = std::make_shared>(still_active); const std::error_code & error() const {return _ec;} void set_error(const std::error_code &ec, const char* msg) { internal_error_handle(ec, msg, has_error_handler(), has_ignore_error(), shall_use_vfork()); } void set_error(const std::error_code &ec, const std::string &msg) {set_error(ec, msg.c_str());}; }; template child executor::invoke(boost::mpl::true_, boost::mpl::false_) //ignore errors { boost::fusion::for_each(seq, call_on_setup(*this)); if (_ec) return child(); if (cmd_style) prepare_cmd_style(); this->pid = ::fork(); if (pid == -1) { auto ec = boost::process::detail::get_last_error(); boost::fusion::for_each(seq, call_on_fork_error(*this, ec)); return child(); } else if (pid == 0) { boost::fusion::for_each(seq, call_on_exec_setup(*this)); ::execve(exe, cmd_line, env); auto ec = boost::process::detail::get_last_error(); boost::fusion::for_each(seq, call_on_exec_error(*this, ec)); _exit(EXIT_FAILURE); } child c(child_handle(pid), exit_status); boost::fusion::for_each(seq, call_on_success(*this)); return c; } template child executor::invoke(boost::mpl::false_, boost::mpl::false_) { { struct pipe_guard { int p[2]; pipe_guard() : p{-1,-1} {} ~pipe_guard() { if (p[0] != -1) ::close(p[0]); if (p[1] != -1) ::close(p[1]); } } p{}; if (::pipe(p.p) == -1) { set_error(::boost::process::detail::get_last_error(), "pipe(2) failed"); return child(); } if (::fcntl(p.p[1], F_SETFD, FD_CLOEXEC) == -1) { auto err = ::boost::process::detail::get_last_error(); set_error(err, "fcntl(2) failed");//this might throw, so we need to be sure our pipe is safe. return child(); } _ec.clear(); boost::fusion::for_each(seq, call_on_setup(*this)); if (_ec) { boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } if (cmd_style) prepare_cmd_style(); this->pid = ::fork(); if (pid == -1) { _ec = boost::process::detail::get_last_error(); _msg = "fork() failed"; boost::fusion::for_each(seq, call_on_fork_error(*this, _ec)); boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } else if (pid == 0) { _pipe_sink = p.p[1]; ::close(p.p[0]); boost::fusion::for_each(seq, call_on_exec_setup(*this)); ::execve(exe, cmd_line, env); _ec = boost::process::detail::get_last_error(); _msg = "execve failed"; boost::fusion::for_each(seq, call_on_exec_error(*this, _ec)); _write_error(_pipe_sink); ::close(p.p[1]); _exit(EXIT_FAILURE); return child(); } ::close(p.p[1]); p.p[1] = -1; _read_error(p.p[0]); } if (_ec) { boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } child c(child_handle(pid), exit_status); boost::fusion::for_each(seq, call_on_success(*this)); if (_ec) { boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } return c; } #if BOOST_POSIX_HAS_VFORK template child executor::invoke(boost::mpl::true_, boost::mpl::true_) //ignore errors { boost::fusion::for_each(seq, call_on_setup(*this)); if (_ec) return child(); this->pid = ::vfork(); if (pid == -1) { auto ec = boost::process::detail::get_last_error(); boost::fusion::for_each(seq, call_on_fork_error(*this, ec)); return child(); } else if (pid == 0) { boost::fusion::for_each(seq, call_on_exec_setup(*this)); ::execve(exe, cmd_line, env); auto ec = boost::process::detail::get_last_error(); boost::fusion::for_each(seq, call_on_exec_error(*this, ec)); _exit(EXIT_FAILURE); } child c(child_handle(pid), exit_status); boost::fusion::for_each(seq, call_on_success(*this)); return c; } template child executor::invoke(boost::mpl::false_, boost::mpl::true_) { boost::fusion::for_each(seq, call_on_setup(*this)); if (_ec) { boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } _ec.clear(); if (cmd_style) this->prepare_cmd_style(); this->pid = ::vfork(); if (pid == -1) { _ec = boost::process::detail::get_last_error(); _msg = "fork() failed"; boost::fusion::for_each(seq, call_on_fork_error(*this, _ec)); boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } else if (pid == 0) { boost::fusion::for_each(seq, call_on_exec_setup(*this)); ::execve(exe, cmd_line, env); _ec = boost::process::detail::get_last_error(); _msg = "execve failed"; boost::fusion::for_each(seq, call_on_exec_error(*this, _ec)); _exit(EXIT_FAILURE); return child(); } child c(child_handle(pid), exit_status); check_error(has_error_handler()); if (_ec) { boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } else boost::fusion::for_each(seq, call_on_success(*this)); if (_ec) { boost::fusion::for_each(seq, call_on_error(*this, _ec)); return child(); } return c; } #endif template inline executor make_executor(Tup & tup) { return executor(tup); } }}}} #endif