4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// Automated Testing Framework (atf)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// Copyright (c) 2008 The NetBSD Foundation, Inc.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// All rights reserved.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// Redistribution and use in source and binary forms, with or without
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// modification, are permitted provided that the following conditions
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// 1. Redistributions of source code must retain the above copyright
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// notice, this list of conditions and the following disclaimer.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// 2. Redistributions in binary form must reproduce the above copyright
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// notice, this list of conditions and the following disclaimer in the
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// documentation and/or other materials provided with the distribution.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// The "argv_array" type.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews typedef std::vector< std::string > args_vector;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // TODO: This is immutable, so we should be able to use
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // std::tr1::shared_array instead when it becomes widely available.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // The reason would be to remove all copy constructors and assignment
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // operators from this class.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews typedef args_vector::const_iterator const_iterator;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews argv_array(const char*, ...);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews explicit argv_array(const char* const*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class C > explicit argv_array(const C&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const char* const* exec_argv(void) const;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const char* operator[](int) const;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewstemplate< class C >
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews for (typename C::const_iterator iter = c.begin(); iter != c.end();
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// The "stream" types.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // Allow access to the getters.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews child fork(void (*)(void*), OutStream, ErrStream, void*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews status exec(const tools::fs::path&, const argv_array&,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream&, const ErrStream&, void (*)(void));
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews void connect_child(const int);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // Allow access to the getters.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews child fork(void (*)(void*), OutStream, ErrStream, void*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews status exec(const tools::fs::path&, const argv_array&,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream&, const ErrStream&, void (*)(void));
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews void connect_child(const int);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews stream_connect(const int, const int);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // Allow access to the getters.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews child fork(void (*)(void*), OutStream, ErrStream, void*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews status exec(const tools::fs::path&, const argv_array&,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream&, const ErrStream&, void (*)(void));
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews void connect_child(const int);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // Allow access to the getters.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews child fork(void (*)(void*), OutStream, ErrStream, void*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews status exec(const tools::fs::path&, const argv_array&,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream&, const ErrStream&, void (*)(void));
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews void connect_child(const int);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews // Allow access to the getters.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews child fork(void (*)(void*), OutStream, ErrStream, void*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews status exec(const tools::fs::path&, const argv_array&,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream&, const ErrStream&, void (*)(void));
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews void connect_child(const int);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// The "status" type.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews friend class child;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews status exec(const tools::fs::path&, const argv_array&,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream&, const ErrStream&, void (*)(void));
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews bool exited(void) const;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews int exitstatus(void) const;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews bool signaled(void) const;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews int termsig(void) const;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews bool coredump(void) const;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// The "child" type.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews template< class OutStream, class ErrStream > friend
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews child fork(void (*)(void*), OutStream, ErrStream, void*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// Free functions.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// ------------------------------------------------------------------------
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews} // namespace detail
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// TODO: The void* cookie can probably be templatized, thus also allowing
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// const data structures.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsfork(void (*start)(void*), OutStream outsb, ErrStream errsb, void* v)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews throw system_error("tools::process::child::fork",
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews } else if (pid == 0) {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews } catch (...) {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews std::cerr << "Unhandled error while running subprocess\n";
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsexec(const tools::fs::path& prog, const argv_array& argv,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream& outsb, const ErrStream& errsb,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews void (*prehook)(void))
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews struct detail::exec_args ea = { prog, argv, prehook };
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews child c = fork(detail::do_exec, outsb, errsb, &ea);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews } catch (const system_error& e) {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsexec(const tools::fs::path& prog, const argv_array& argv,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews const OutStream& outsb, const ErrStream& errsb)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews} // namespace process
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews} // namespace tools
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#endif // !defined(TOOLS_PROCESS_HPP)