blob: 6df78114d0bf9374eec8f2d76699c6cbe0c6e0d0 (
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwpf/fapi/fapiErrorInfo.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2012 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* 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. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file fapiErrorInfo.H
*
* @brief Defines the Error Information structures and classes
*/
/*
* Change Log ******************************************************************
* Flag Defect/Feature User Date Description
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 08/09/2011 Created.
* mjjones 08/24/2011 Added ErrorInfoGard.
* mjjones 09/22/2011 Major updates
* mjjones 03/16/2012 Add FfdcType. Remove copy
* ctor and assignment operator
* mjjones 08/14/2012 Merge Callout/Deconfig/Gard
* structures into one
* mjjones 09/19/2012 Replace FFDC type with ID
*/
#ifndef FAPIERRORINFO_H_
#define FAPIERRORINFO_H_
#include <stdint.h>
#include <vector>
#include <fapiTarget.H>
namespace fapi
{
/**
* @class ErrorInfoFfdc
*
* This class contains a copy of some FFDC data
*/
class ErrorInfoFfdc
{
public:
/**
* @brief Constructor
*
* @param[in] i_ffdcId FFDC Identifier (used to decode FFDC)
* @param[in] i_pFfdc Pointer to the FFDC to copy
* @param[in] i_size Size of the FFDC to copy
*/
ErrorInfoFfdc(const uint32_t i_ffdcId,
const void * i_pFfdc,
const uint32_t i_size);
/**
* @brief Destructor
*/
~ErrorInfoFfdc();
/**
* @brief Get a pointer to the FfdcData
*
* @param[out] o_size Reference to uint32_t that is filled in with the FFDC
* size
*
* @return void *. Pointer to the FFDC
*/
const void * getData(uint32_t & o_size) const;
/**
* @brief Get the FFDC Identifier
*
* @return uint32_t The FFDC Identifier
*/
uint32_t getFfdcId() {return iv_ffdcId;}
private:
// FFDC Identifier
uint32_t iv_ffdcId;
// Pointer to the FFDC
uint8_t * iv_pFfdc;
// Size of the FFDC
uint32_t iv_size;
// Disabled
ErrorInfoFfdc(const ErrorInfoFfdc &);
ErrorInfoFfdc & operator=(const ErrorInfoFfdc &);
};
/**
* @enum CalloutPriority
*
* This enumeration defines the possible callout priorities
*/
enum CalloutPriority
{
PRI_LOW = 1,
PRI_MEDIUM = 2,
PRI_HIGH = 3,
};
/**
* @struct ErrorInfoCDG
*
* This struct contains a target to callout/deconfigure/GARD
*/
struct ErrorInfoCDG
{
/**
* @brief Constructor.
*
* @param[in] i_target Reference to the target to callout/deconfigure/GARD
*/
ErrorInfoCDG(const Target & i_target);
// The target to callout/deconfigure/GARD
Target iv_target;
// Callout Information
bool iv_callout;
CalloutPriority iv_calloutPriority;
// Deconfigure Information
bool iv_deconfigure;
// GARD Information
bool iv_gard;
};
/**
* @struct ErrorInfo
*
* This struct defines the error information associated with a fapi::ReturnCode
* Users are allowed to access the data directly
*/
struct ErrorInfo
{
/**
* @brief Destructor.
*/
~ErrorInfo();
/**
* @brief Get a reference to the ErrorInfoCDG structure for the specified
* Target. If there is no existing structure then one is created
*
* @param[in] i_target Reference to Target to get the information for
*
* @return Reference to ErrorInfoCDG
*/
ErrorInfoCDG & getCreateErrorInfoCDG(const Target & i_target);
// Vector of FFDC Data
std::vector<ErrorInfoFfdc *> iv_ffdcs;
typedef std::vector<ErrorInfoFfdc *>::iterator ErrorInfoFfdcItr_t;
typedef std::vector<ErrorInfoFfdc *>::const_iterator ErrorInfoFfdcCItr_t;
// Vector of targets to callout/deconfigure/GARD
std::vector<ErrorInfoCDG *> iv_CDGs;
typedef std::vector<ErrorInfoCDG *>::iterator ErrorInfoCDGItr_t;
typedef std::vector<ErrorInfoCDG *>::const_iterator ErrorInfoCDGCItr_t;
};
}
#endif // FAPIERRORINFO_H_
|
