summaryrefslogtreecommitdiffstats
path: root/src/include/usr/initservice/initsvcudistep.H
blob: 9dc8f21062c3f7e8c93f17c7cb5a165545785376 (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
//  IBM_PROLOG_BEGIN_TAG
//  This is an automatically generated prolog.
//
//  $Source: src/include/usr/initservice/initsvcudistep.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 INITSVC_UDSTEP_H
#define INITSVC_UDSTEP_H

/**
 *  @file initsvcudistep.H
 *
 *  Defines the following classes:
 *
 *  InitSvcUserDetailsIstep: Adds IStep FFDC to an error log as user detail data
 *  InitSvcUserDetailsParserIstep: Parses IStep FFDC user detail in an error log
*/

#include <errl/errluserdetails.H>

namespace   INITSERVICE
{

/**
 * @struct InitSvcUserDetailsIstepData
 *
 * Defines the user detail data
 */
struct InitSvcUserDetailsIstepData
{
    uint16_t iv_step;
    uint16_t iv_substep;
    char iv_pIstepname[0];
};

#ifndef PARSER

/**
 * @class InitSvcUserDetailsIstep
 *
 * Adds IStep FFDC to an error log as user detail data
 */
class InitSvcUserDetailsIstep : public ERRORLOG::ErrlUserDetails
{
public:
    /**
     *  @brief Constructor
     *
     *  Captures the supplied IStep FFDC data internally
     *
     *  @param i_pIstepname Istep name
     *  @param i_step       Step number
     *  @param i_substep    Sub-step number
     */
    InitSvcUserDetailsIstep(const char * i_pIstepname,
                            const uint16_t i_step,
                            const uint16_t i_substep);

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

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

#else // (if PARSER defined)

/**
 * @class InitSvcUserDetailsParserIstep
 *
 * Parses Istep user detail in an error log
*/
class InitSvcUserDetailsParserIstep : public ERRORLOG::ErrlUserDetailsParser
{
public:
    /**
     *  @brief Constructor
     */
    InitSvcUserDetailsParserIstep() {}

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

    /**
     *  @brief Parses Istep 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
    {
        InitSvcUserDetailsIstepData * l_pData =
            static_cast<InitSvcUserDetailsIstepData *>(i_pBuffer);

        i_parser.PrintString("IStep name", l_pData->iv_pIstepname);
        i_parser.PrintNumber("Step", "%d", ntohs(l_pData->iv_step));
        i_parser.PrintNumber("Sub-step", "%d", ntohs(l_pData->iv_substep));
    }

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

#endif

}

#endif

OpenPOWER on IntegriCloud