blob: 1bf54caa14a3b4da60c48e9eb3b0f15cfd7c6306 [file] [log] [blame]
Matt Spinler711d51d2019-11-06 09:36:51 -06001/**
2 * Copyright © 2019 IBM Corporation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Matt Spinlerd3335df2019-07-10 11:04:21 -050016#include "private_header.hpp"
17
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +080018#include "json_utils.hpp"
Matt Spinler289aa472019-09-20 12:33:29 -050019#include "log_id.hpp"
Matt Spinler1a94cc32019-09-11 13:32:12 -050020#include "pel_types.hpp"
Aatirc92b4eb2019-11-18 13:44:51 -060021#include "pel_values.hpp"
Matt Spinler1a94cc32019-09-11 13:32:12 -050022
Matt Spinlerd3335df2019-07-10 11:04:21 -050023#include <phosphor-logging/log.hpp>
24
25namespace openpower
26{
27namespace pels
28{
29
Aatirc92b4eb2019-11-18 13:44:51 -060030namespace pv = openpower::pels::pel_values;
Matt Spinlerd3335df2019-07-10 11:04:21 -050031using namespace phosphor::logging;
32
Matt Spinler289aa472019-09-20 12:33:29 -050033PrivateHeader::PrivateHeader(uint16_t componentID, uint32_t obmcLogID,
34 uint64_t timestamp)
35{
36 _header.id = static_cast<uint16_t>(SectionID::privateHeader);
37 _header.size = PrivateHeader::flattenedSize();
38 _header.version = privateHeaderVersion;
39 _header.subType = 0;
40 _header.componentID = componentID;
41
42 _createTimestamp = getBCDTime(timestamp);
43
44 auto now = std::chrono::system_clock::now();
45 _commitTimestamp = getBCDTime(now);
46
47 _creatorID = static_cast<uint8_t>(CreatorID::openBMC);
48
49 // Add support for reminder and telemetry log types here if
50 // ever necessary.
51 _logType = 0;
52
53 _reservedByte = 0;
54
55 // the final section count will be updated later
56 _sectionCount = 1;
57
58 _obmcLogID = obmcLogID;
59
60 _id = generatePELID();
61
62 _plid = _id;
63
64 // Leave _creatorVersion at 0
65
66 _valid = true;
67}
68
Matt Spinler31eed992019-10-09 14:07:52 -050069PrivateHeader::PrivateHeader(Stream& pel) :
70 _creatorID(0), _logType(0), _reservedByte(0), _sectionCount(0),
71 _obmcLogID(0), _plid(0), _id(0)
Matt Spinlerd3335df2019-07-10 11:04:21 -050072{
73 try
74 {
Matt Spinlercf5a8d02019-09-05 12:58:53 -050075 unflatten(pel);
Matt Spinlerd3335df2019-07-10 11:04:21 -050076 validate();
77 }
78 catch (const std::exception& e)
79 {
80 log<level::ERR>("Cannot unflatten private header",
81 entry("ERROR=%s", e.what()));
82 _valid = false;
83 }
84}
Aatirc92b4eb2019-11-18 13:44:51 -060085std::optional<std::string> PrivateHeader::getJSON() const
86{
87 char tmpPhVal[50];
88 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X",
89 _createTimestamp.month, _createTimestamp.day,
90 _createTimestamp.yearMSB, _createTimestamp.yearLSB,
91 _createTimestamp.hour, _createTimestamp.minutes,
92 _createTimestamp.seconds);
93 std::string phCreateTStr(tmpPhVal);
94 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X",
95 _commitTimestamp.month, _commitTimestamp.day,
96 _createTimestamp.yearMSB, _commitTimestamp.yearLSB,
97 _commitTimestamp.hour, _commitTimestamp.minutes,
98 _commitTimestamp.seconds);
99 std::string phCommitTStr(tmpPhVal);
100 sprintf(tmpPhVal, "%c", _creatorID);
101 std::string creator(tmpPhVal);
102 creator = pv::creatorIDs.count(creator) ? pv::creatorIDs.at(creator)
103 : "Unknown CreatorID";
104 std::string phCreatorVersionStr =
105 std::string(reinterpret_cast<const char*>(_creatorVersion.version));
Matt Spinlerd3335df2019-07-10 11:04:21 -0500106
Aatirc92b4eb2019-11-18 13:44:51 -0600107 sprintf(tmpPhVal, "0x%X", _header.componentID);
108 std::string phCbStr(tmpPhVal);
109 sprintf(tmpPhVal, "%d", _header.subType);
110 std::string phStStr(tmpPhVal);
111 sprintf(tmpPhVal, "%d", privateHeaderVersion);
112 std::string phVerStr(tmpPhVal);
113 sprintf(tmpPhVal, "0x%X", _plid);
114 std::string phPlatformIDStr(tmpPhVal);
115 sprintf(tmpPhVal, "0x%X", _id);
116 std::string phLogEntryIDStr(tmpPhVal);
Matt Spinlerebffe1c2020-01-15 14:48:21 -0600117 std::string phObmcIDStr = std::to_string(_obmcLogID);
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800118 std::string ph;
119 jsonInsert(ph, "Section Version", phVerStr, 1);
120 jsonInsert(ph, "Sub-section type", phStStr, 1);
121 jsonInsert(ph, "Created by", phCbStr, 1);
122 jsonInsert(ph, "Created at", phCreateTStr, 1);
123 jsonInsert(ph, "Committed at", phCommitTStr, 1);
124 jsonInsert(ph, "Creator Subsystem", creator, 1);
125 jsonInsert(ph, "CSSVER", phCreatorVersionStr, 1);
126 jsonInsert(ph, "Platform Log Id", phPlatformIDStr, 1);
127 jsonInsert(ph, "Entry Id", phLogEntryIDStr, 1);
Matt Spinlerebffe1c2020-01-15 14:48:21 -0600128 jsonInsert(ph, "BMC Event Log Id", phObmcIDStr, 1);
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800129 ph.erase(ph.size() - 2);
Aatirc92b4eb2019-11-18 13:44:51 -0600130
131 return ph;
132}
Matt Spinlerd3335df2019-07-10 11:04:21 -0500133void PrivateHeader::validate()
134{
135 bool failed = false;
136
Matt Spinler1a94cc32019-09-11 13:32:12 -0500137 if (header().id != static_cast<uint16_t>(SectionID::privateHeader))
Matt Spinlerd3335df2019-07-10 11:04:21 -0500138 {
139 log<level::ERR>("Invalid private header section ID",
140 entry("ID=0x%X", header().id));
141 failed = true;
142 }
143
144 if (header().version != privateHeaderVersion)
145 {
146 log<level::ERR>("Invalid private header version",
147 entry("VERSION=0x%X", header().version));
148 failed = true;
149 }
150
151 if (_sectionCount < minSectionCount)
152 {
153 log<level::ERR>("Invalid section count in private header",
154 entry("SECTION_COUNT=0x%X", _sectionCount));
155 failed = true;
156 }
157
158 _valid = (failed) ? false : true;
159}
160
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500161void PrivateHeader::unflatten(Stream& stream)
Matt Spinlerd3335df2019-07-10 11:04:21 -0500162{
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500163 stream >> _header >> _createTimestamp >> _commitTimestamp >> _creatorID >>
164 _logType >> _reservedByte >> _sectionCount >> _obmcLogID >>
165 _creatorVersion >> _plid >> _id;
Matt Spinlerd3335df2019-07-10 11:04:21 -0500166}
167
Matt Spinler06885452019-11-06 10:35:42 -0600168void PrivateHeader::flatten(Stream& stream) const
Matt Spinlerd3335df2019-07-10 11:04:21 -0500169{
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500170 stream << _header << _createTimestamp << _commitTimestamp << _creatorID
171 << _logType << _reservedByte << _sectionCount << _obmcLogID
172 << _creatorVersion << _plid << _id;
Matt Spinlerd3335df2019-07-10 11:04:21 -0500173}
174
175Stream& operator>>(Stream& s, CreatorVersion& cv)
176{
177 for (size_t i = 0; i < sizeof(CreatorVersion); i++)
178 {
179 s >> cv.version[i];
180 }
181 return s;
182}
183
Matt Spinler06885452019-11-06 10:35:42 -0600184Stream& operator<<(Stream& s, const CreatorVersion& cv)
Matt Spinlerd3335df2019-07-10 11:04:21 -0500185{
186 for (size_t i = 0; i < sizeof(CreatorVersion); i++)
187 {
188 s << cv.version[i];
189 }
190 return s;
191}
192
193} // namespace pels
194} // namespace openpower