xref: /freebsd/contrib/kyua/utils/process/system.hpp (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1 // Copyright 2010 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/process/system.hpp
30 /// Indirection to perform system calls.
31 ///
32 /// The indirections exposed in this file are provided to allow unit-testing of
33 /// particular system behaviors (e.g. failures).  The caller of a routine in
34 /// this library is allowed, for testing purposes only, to explicitly replace
35 /// the pointers in this file with custom functions to inject a particular
36 /// behavior into the library code.
37 ///
38 /// Do not include this header from other header files.
39 ///
40 /// It may be nice to go one step further and completely abstract the library
41 /// functions in here to provide exception-based error reporting.
42 
43 #if !defined(UTILS_PROCESS_SYSTEM_HPP)
44 #define UTILS_PROCESS_SYSTEM_HPP
45 
46 extern "C" {
47 #include <unistd.h>
48 }
49 
50 namespace utils {
51 namespace process {
52 namespace detail {
53 
54 
55 extern int (*syscall_dup2)(const int, const int);
56 extern pid_t (*syscall_fork)(void);
57 extern int (*syscall_open)(const char*, const int, ...);
58 extern int (*syscall_pipe)(int[2]);
59 extern pid_t (*syscall_waitpid)(const pid_t, int*, const int);
60 
61 
62 }  // namespace detail
63 }  // namespace process
64 }  // namespace utils
65 
66 #endif  // !defined(UTILS_PROCESS_SYSTEM_HPP)
67