blob: 31e0f61a9eef68d978492a1256788151726abc34 [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 Spinler7f1b9052022-03-22 09:18:58 -050023#include <phosphor-logging/log.hpp>
Matt Spinlerd3335df2019-07-10 11:04:21 -050024
25namespace openpower
26{
27namespace pels
28{
29
Aatirc92b4eb2019-11-18 13:44:51 -060030namespace pv = openpower::pels::pel_values;
Matt Spinler7f1b9052022-03-22 09:18:58 -050031using namespace phosphor::logging;
Matt Spinlerd3335df2019-07-10 11:04:21 -050032
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 {
Matt Spinler7f1b9052022-03-22 09:18:58 -050080 log<level::ERR>("Cannot unflatten private header",
81 entry("ERROR=%s", e.what()));
Matt Spinlerd3335df2019-07-10 11:04:21 -050082 _valid = false;
83 }
84}
Aatirc92b4eb2019-11-18 13:44:51 -060085std::optional<std::string> PrivateHeader::getJSON() const
86{
87 char tmpPhVal[50];
Harisuddin Mohamed Isa160c51c2020-02-13 23:42:20 +080088 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X",
Aatirc92b4eb2019-11-18 13:44:51 -060089 _createTimestamp.month, _createTimestamp.day,
90 _createTimestamp.yearMSB, _createTimestamp.yearLSB,
91 _createTimestamp.hour, _createTimestamp.minutes,
92 _createTimestamp.seconds);
93 std::string phCreateTStr(tmpPhVal);
Harisuddin Mohamed Isa160c51c2020-02-13 23:42:20 +080094 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X",
Aatirc92b4eb2019-11-18 13:44:51 -060095 _commitTimestamp.month, _commitTimestamp.day,
Sumit Kumar74348c62021-10-26 05:48:28 -050096 _commitTimestamp.yearMSB, _commitTimestamp.yearLSB,
Aatirc92b4eb2019-11-18 13:44:51 -060097 _commitTimestamp.hour, _commitTimestamp.minutes,
98 _commitTimestamp.seconds);
99 std::string phCommitTStr(tmpPhVal);
Harisuddin Mohamed Isabebeb942020-03-12 17:12:24 +0800100 std::string creator = getNumberString("%c", _creatorID);
Aatirc92b4eb2019-11-18 13:44:51 -0600101 creator = pv::creatorIDs.count(creator) ? pv::creatorIDs.at(creator)
102 : "Unknown CreatorID";
103 std::string phCreatorVersionStr =
104 std::string(reinterpret_cast<const char*>(_creatorVersion.version));
Matt Spinlerd3335df2019-07-10 11:04:21 -0500105
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800106 std::string ph;
Harisuddin Mohamed Isabebeb942020-03-12 17:12:24 +0800107 jsonInsert(ph, pv::sectionVer, getNumberString("%d", privateHeaderVersion),
108 1);
109 jsonInsert(ph, pv::subSection, getNumberString("%d", _header.subType), 1);
110 jsonInsert(ph, pv::createdBy, getNumberString("0x%X", _header.componentID),
111 1);
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800112 jsonInsert(ph, "Created at", phCreateTStr, 1);
113 jsonInsert(ph, "Committed at", phCommitTStr, 1);
114 jsonInsert(ph, "Creator Subsystem", creator, 1);
115 jsonInsert(ph, "CSSVER", phCreatorVersionStr, 1);
Harisuddin Mohamed Isabebeb942020-03-12 17:12:24 +0800116 jsonInsert(ph, "Platform Log Id", getNumberString("0x%X", _plid), 1);
117 jsonInsert(ph, "Entry Id", getNumberString("0x%X", _id), 1);
118 jsonInsert(ph, "BMC Event Log Id", std::to_string(_obmcLogID), 1);
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800119 ph.erase(ph.size() - 2);
Aatirc92b4eb2019-11-18 13:44:51 -0600120
121 return ph;
122}
Matt Spinlerd3335df2019-07-10 11:04:21 -0500123void PrivateHeader::validate()
124{
125 bool failed = false;
126
Matt Spinler1a94cc32019-09-11 13:32:12 -0500127 if (header().id != static_cast<uint16_t>(SectionID::privateHeader))
Matt Spinlerd3335df2019-07-10 11:04:21 -0500128 {
Matt Spinler7f1b9052022-03-22 09:18:58 -0500129 log<level::ERR>("Invalid private header section ID",
130 entry("ID=0x%X", header().id));
Matt Spinlerd3335df2019-07-10 11:04:21 -0500131 failed = true;
132 }
133
134 if (header().version != privateHeaderVersion)
135 {
Matt Spinler7f1b9052022-03-22 09:18:58 -0500136 log<level::ERR>("Invalid private header version",
137 entry("VERSION=0x%X", header().version));
Matt Spinlerd3335df2019-07-10 11:04:21 -0500138 failed = true;
139 }
140
141 if (_sectionCount < minSectionCount)
142 {
Matt Spinler7f1b9052022-03-22 09:18:58 -0500143 log<level::ERR>("Invalid section count in private header",
144 entry("SECTION_COUNT=0x%X", _sectionCount));
Matt Spinlerd3335df2019-07-10 11:04:21 -0500145 failed = true;
146 }
147
148 _valid = (failed) ? false : true;
149}
150
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500151void PrivateHeader::unflatten(Stream& stream)
Matt Spinlerd3335df2019-07-10 11:04:21 -0500152{
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500153 stream >> _header >> _createTimestamp >> _commitTimestamp >> _creatorID >>
154 _logType >> _reservedByte >> _sectionCount >> _obmcLogID >>
155 _creatorVersion >> _plid >> _id;
Matt Spinlerd3335df2019-07-10 11:04:21 -0500156}
157
Matt Spinler06885452019-11-06 10:35:42 -0600158void PrivateHeader::flatten(Stream& stream) const
Matt Spinlerd3335df2019-07-10 11:04:21 -0500159{
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500160 stream << _header << _createTimestamp << _commitTimestamp << _creatorID
161 << _logType << _reservedByte << _sectionCount << _obmcLogID
162 << _creatorVersion << _plid << _id;
Matt Spinlerd3335df2019-07-10 11:04:21 -0500163}
164
165Stream& operator>>(Stream& s, CreatorVersion& cv)
166{
167 for (size_t i = 0; i < sizeof(CreatorVersion); i++)
168 {
169 s >> cv.version[i];
170 }
171 return s;
172}
173
Matt Spinler06885452019-11-06 10:35:42 -0600174Stream& operator<<(Stream& s, const CreatorVersion& cv)
Matt Spinlerd3335df2019-07-10 11:04:21 -0500175{
176 for (size_t i = 0; i < sizeof(CreatorVersion); i++)
177 {
178 s << cv.version[i];
179 }
180 return s;
181}
182
183} // namespace pels
184} // namespace openpower