blob: 2f8f3460c993cda79bb9bde3fd44a1144debfe9e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: hwpf/fapi2/include/return_code.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* EKB Project */
/* */
/* COPYRIGHT 2012,2015 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file return_code.H
* @brief definitions for fapi2 return codes
*/
#ifndef __FAPI2_RETURN_CODE__
#define __FAPI2_RETURN_CODE__
#include <stdint.h>
#ifndef FAPI2_NO_FFDC
#include <ffdc.H>
#endif
namespace fapi2
{
///
/// @brief Class representing a FAPI2 ReturnCode
///
// Remove the inheritance relationship with FirstFailureData if
// the platform doesn't support FFDC.
#ifdef FAPI2_NO_FFDC
class ReturnCode
#else
class ReturnCode : public FirstFailureData<ReturnCode>
#endif
{
public:
///
/// @brief Constructor.
/// @param[in] i_rc the rc to set
///
ReturnCode(const uint64_t i_rc = FAPI2_RC_SUCCESS):
iv_rc(i_rc)
{};
///
/// @brief integral type conversion function. Returns the error code
/// @return The error code
///
inline operator uint64_t() const
{
return iv_rc;
}
///
/// @brief Returns true iff iv_rc == SUCCESS
/// @return true or false
///
inline operator bool() const
{
return iv_rc != FAPI2_RC_SUCCESS;
}
///
/// @brief Assignement operator
///
#ifdef DOXYGEN
inline ReturnCode& operator=(const uint64_t& rhs)
inline ReturnCode& operator=(const ReturnCodes& rhs)
#endif
inline bool operator==(const uint64_t& rhs) const
{
return rhs == iv_rc;
}
inline bool operator==(const ReturnCodes& rhs) const
{
return rhs == iv_rc;
}
inline bool operator!=(const uint64_t& rhs) const
{
return rhs != iv_rc;
}
inline bool operator!=(const ReturnCodes& rhs) const
{
return rhs != iv_rc;
}
private:
uint64_t iv_rc;
};
/// This implementation assumes no exception handling and leverages thread-local
/// storage. For platforms without thread support, a global variable will
/// suffice for the error state.
extern thread_local ReturnCode current_err; /// the current error state
extern thread_local uint64_t pib_error_mask; /// the pib mask
extern thread_local uint64_t operational_state; /// the operational mode
}
#endif
|
