blob: 6c1caf4a3e37a508bb31282418865e9afbcdab01 (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/errl/errluh.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2013 */
/* */
/* 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 */
#ifndef ERRLUH_H
#define ERRLUH_H
/**
* @file errluh.H
*
* @brief A class for the user header 'UH' section of an error log.
* This classes manages those ErrlEntry data items that are destined
* to be saved in the user header PEL section.
*/
#include <errl/errlentry.H>
#include <errl/errlsctnhdr.H>
namespace ERRORLOG
{
class ErrlUH
{
// ErrlEntry may access private elements of this class. Data items that
// you would expect to be part of ErrlEntry are actually instance data
// in this class.
friend class ErrlEntry;
private:
enum constants
{
// for generating UH section of PEL
SLEN = 16, // 16 does not include the 8 bytes of ErrlSctnHdr
VER = 1, // section version
SST = 0 // section type
};
/** @brief User header constructor. */
ErrlUH( errlSeverity_t i_sev );
/** @brief User header destructor. */
~ErrlUH();
/**
* @brief Disable copy constructor and assignment operator.
*/
ErrlUH(const ErrlUH& i_right);
ErrlUH& operator=(const ErrlUH& i_right);
/**
* @brief Data export size. Amount of flat storage (in bytes) required to
* store the object.
*
* @return size in bytes
*/
uint64_t flatSize() const;
/**
* @brief Data Export facility. Flatten the object into PEL for the
* 'UH' user header section.
*
* @param[in,out] io_pBuffer Pointer to buffer where flat data will go.
* @param[in] i_cbBuffer Count of bytes in target buffer
*
*/
uint64_t flatten( void * io_pBuffer, const uint64_t i_cbBuffer );
/**
* @brief Import data
* @param[in] i_buf, the pointer to the flattened data
* @return number of bytes consumed
*/
uint64_t unflatten( const void * i_buf );
/**
* @brief return the failing subsystem id value
*
* @return Failing subsystem ID
*
*/
epubSubSystem_t getSubSys()const { return iv_ssid; };
/**
* @brief set the failing subsystem id value in the SRC object
*
*
*/
void setSubSys( epubSubSystem_t i_ssid ){ iv_ssid = i_ssid; };
/** @brief Set the component ID into the user header.
* Only should be called from ErrlEntry instance.
* The component ID in the user header identifies
* the component that committed the error log.
*
* @param[in] i_compId component ID
*/
void setComponentId( compId_t i_compId );
// Instance variables
// SctnHdr for 'UH' section
ErrlSctnHdr iv_header;
errlSeverity_t iv_severity;
errlEventType_t iv_etype;
// failing sub system ID
epubSubSystem_t iv_ssid;
// these are defaulted at object creation
// no setters/getters are provided currently
errlDomain_t iv_domain;
errlVector_t iv_vector;
uint16_t iv_actions;
errlScope_t iv_scope;
};
/*****************************************************************************/
// Destructor
inline ErrlUH::~ErrlUH()
{
}
/*****************************************************************************/
// Export data size
inline uint64_t ErrlUH::flatSize() const
{
return ( iv_header.flatSize() + SLEN );
}
/*****************************************************************************/
// For user headers, the comp ID represents the committing component.
inline void ErrlUH::setComponentId( compId_t i_compId )
{
iv_header.iv_compId = i_compId;
}
} // namespace
#endif //ERRLUH_H
|
