xref: /freebsd/contrib/kyua/utils/process/status.hpp (revision e32fecd0c2c3ee37c47ee100f169e7eb0282a873)
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/status.hpp
30 /// Provides the utils::process::status class.
31 
32 #if !defined(UTILS_PROCESS_STATUS_HPP)
33 #define UTILS_PROCESS_STATUS_HPP
34 
35 #include "utils/process/status_fwd.hpp"
36 
37 #include <ostream>
38 #include <utility>
39 
40 #include "utils/optional.ipp"
41 
42 namespace utils {
43 namespace process {
44 
45 
46 /// Representation of the termination status of a process.
47 class status {
48     /// The PID of the process that generated this status.
49     ///
50     /// Note that the process has exited already and been awaited for, so the
51     /// PID cannot be used to address the process.
52     int _dead_pid;
53 
54     /// The exit status of the process, if it exited cleanly.
55     optional< int > _exited;
56 
57     /// The signal that terminated the program, if any, and if it dumped core.
58     optional< std::pair< int, bool > > _signaled;
59 
60     status(const optional< int >&, const optional< std::pair< int, bool > >&);
61 
62 public:
63     status(const int, int);
64     static status fake_exited(const int);
65     static status fake_signaled(const int, const bool);
66 
67     int dead_pid(void) const;
68 
69     bool exited(void) const;
70     int exitstatus(void) const;
71 
72     bool signaled(void) const;
73     int termsig(void) const;
74     bool coredump(void) const;
75 };
76 
77 
78 std::ostream& operator<<(std::ostream&, const status&);
79 
80 
81 }  // namespace process
82 }  // namespace utils
83 
84 #endif  // !defined(UTILS_PROCESS_STATUS_HPP)
85