blob: 727100dec41bd27d10f25756419e64beeece172e (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/errl/errluserdetails.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef ERRL_ERRLUSERDETAILS_H
#define ERRL_ERRLUSERDETAILS_H
/**
* @file errluserdetails.H
*
* Defines the ErrlUserDetails base classes
*
* Derive a class from ErrlUserDetails to create user detail data. For each
* class, in the component's plugins directory, derive a class from
* ErrlUserDetailsParser to parse user detail data
*/
#include <stdint.h>
#include <errl/errlentry.H>
namespace ERRORLOG
{
/**
* @class ErrlUserDetails
*
* This class creates user detail data. If a component creates user detail data
* then for each different type of data it should derive a class from this.
*/
class ErrlUserDetails
{
public:
/**
* @brief Constructor
*
* Sets up instance variables. A derived class should set up the instance
* variables to reflect a specific format of user detail data
*/
ErrlUserDetails();
/**
* @brief Destructor
*
* Performs any necessary cleanup
*/
virtual ~ErrlUserDetails();
/**
* @brief Adds user detail data to an error log
*
* Adds the user detail data stored in the internal buffer to the error
* log. Subclasses should override if the detail data is not stored in the
* internal buffer.
*
* @param i_errl Error log handle to add detail data to.
*/
virtual void addToLog(errlHndl_t i_errl);
protected:
/**
* @brief Allocates the internal data buffer for storing detail data
*
* If the internal buffer is already allocated then it is reallocated and
* the contents preserved (up to the lesser of the new and old sizes).
*
* @param i_size Size of buffer
*
* @return uint8_t* Pointer to the data buffer
*/
uint8_t * reallocUsrBuf(const uint32_t i_size);
/**
* @brief Returns the size of the internal data buffer
*
* @return uint32_t Size of the internal data buffer
*/
uint32_t getUsrBufSize() const;
/**
* Protected Data: ID of component adding user details
*/
compId_t iv_CompId;
/**
* Protected Data: Version number of the user details
*/
errlver_t iv_Version;
/**
* Protected Data: Subsection number of the user details
*/
errlsubsec_t iv_SubSection;
/**
* Protected Data: true/false merge like buffers
*/
bool iv_merge;
private:
// Disabled
ErrlUserDetails(const ErrlUserDetails &);
ErrlUserDetails & operator=(const ErrlUserDetails &);
/**
* Private Data members (the internal buffer should be accessed through
* public member functions)
*/
uint8_t * iv_pBuffer; // Pointer to internal buffer
uint32_t iv_BufLen; // Length of internal buffer
};
}
#endif
|
