summaryrefslogtreecommitdiffstats
path: root/src/include/usr/errl/errludtarget.H
blob: b76c58f13b23c4f9e2b3876c55dc0b1491e1c1c1 (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
//  IBM_PROLOG_BEGIN_TAG
//  This is an automatically generated prolog.
//
//  $Source: src/include/usr/errl/errludtarget.H $
//
//  IBM CONFIDENTIAL
//
//  COPYRIGHT International Business Machines Corp. 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 other-
//  wise divested of its trade secrets, irrespective of what has
//  been deposited with the U.S. Copyright Office.
//
//  Origin: 30
//
//  IBM_PROLOG_END
#ifndef ERRL_UDTARGET_H
#define ERRL_UDTARGET_H

/**
 *  @file errludTarget.H
 *
 *  Defines the following classes:
 *
 *  ErrlUserDetailsTarget: Adds Target FFDC to an error log as user detail data
 *  ErrlUserDetailsParserTarget: Parses Target FFDC user detail in an error log
 */

#include <errl/errluserdetails.H>

#ifndef PARSER

// Forward reference
namespace TARGETING
{
    class Target;
}

namespace ERRORLOG
{

/**
 * @class ErrlUserDetailsTarget
 *
 * Adds Target FFDC to an error log as user detail data
*/
class ErrlUserDetailsTarget : public ErrlUserDetails
{
public:
    /**
     *  @brief Constructor
     *  
     *  Captures the supplied Target's FFDC data internally
     *  
     *  @param i_pTarget Pointer to Target to capture as user detail data
     */
    ErrlUserDetailsTarget(const TARGETING::Target * i_pTarget);

    /**
     *  @brief Destructor
     */
    virtual ~ErrlUserDetailsTarget();

    /**
     *  @brief Adds the Target as user detail data to an error log
     *
     *  @param  i_errl Error log to add detail data to.
     */
    virtual void addToLog(errlHndl_t i_errl);

private:
    // Target pointer
    const TARGETING::Target * iv_pTarget;
    
    // Disabled
    ErrlUserDetailsTarget(const ErrlUserDetailsTarget &);
    ErrlUserDetailsTarget & operator=(const ErrlUserDetailsTarget &);
};

}

#else // (if PARSER defined)

#include <string.h>

namespace ERRORLOG
{

/**
 * @class ErrlUserDetailsParserTarget
 *
 * Parses Target FFDC user detail in an error log
 */
class ErrlUserDetailsParserTarget : public ErrlUserDetailsParser
{
public:
    /**
     *  @brief Constructor
     */
    ErrlUserDetailsParserTarget() {}

    /**
     *  @brief Destructor
     */
    virtual ~ErrlUserDetailsParserTarget() {}

    /**
     *  @brief Parses Target user detail data from an error log
     *
     *  @param  i_version Version of the data
     *  @param  i_parse   ErrlUsrParser object for outputting information
     *  @param  i_pBuffer Pointer to buffer containing detail data
     *  @param  i_buflen  Length of the buffer
     */
    virtual void parse(errlver_t i_version,
                       ErrlUsrParser & i_parser,
                       void * i_pBuffer,
                       const uint32_t i_buflen) const
    {
        i_parser.PrintString("Target data", NULL);
        char * l_ptr = static_cast<char *>(i_pBuffer);
        for (uint32_t i = 0; i < i_buflen; )
        {
            i_parser.PrintString(NULL, l_ptr);
            i += strlen(l_ptr) + 1;
            l_ptr += strlen(l_ptr) + 1;
        }
    }

private:
    // Disabled
    ErrlUserDetailsParserTarget(const ErrlUserDetailsParserTarget &);
    ErrlUserDetailsParserTarget & operator=(
        const ErrlUserDetailsParserTarget &);
};

}

#endif
#endif

OpenPOWER on IntegriCloud