blob: 1b4fdbb2b2148c28531cd09d5a1e6fd4216f3896 [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
Jayanth Othayoth1aa90d42023-09-13 04:25:45 -050025#include <format>
26
Matt Spinlerd3335df2019-07-10 11:04:21 -050027namespace openpower
28{
29namespace pels
30{
31
Aatirc92b4eb2019-11-18 13:44:51 -060032namespace pv = openpower::pels::pel_values;
Matt Spinler7f1b9052022-03-22 09:18:58 -050033using namespace phosphor::logging;
Matt Spinlerd3335df2019-07-10 11:04:21 -050034
Matt Spinler289aa472019-09-20 12:33:29 -050035PrivateHeader::PrivateHeader(uint16_t componentID, uint32_t obmcLogID,
36 uint64_t timestamp)
37{
38 _header.id = static_cast<uint16_t>(SectionID::privateHeader);
39 _header.size = PrivateHeader::flattenedSize();
40 _header.version = privateHeaderVersion;
41 _header.subType = 0;
42 _header.componentID = componentID;
43
44 _createTimestamp = getBCDTime(timestamp);
45
46 auto now = std::chrono::system_clock::now();
47 _commitTimestamp = getBCDTime(now);
48
49 _creatorID = static_cast<uint8_t>(CreatorID::openBMC);
50
51 // Add support for reminder and telemetry log types here if
52 // ever necessary.
53 _logType = 0;
54
55 _reservedByte = 0;
56
57 // the final section count will be updated later
58 _sectionCount = 1;
59
60 _obmcLogID = obmcLogID;
61
62 _id = generatePELID();
63
64 _plid = _id;
65
66 // Leave _creatorVersion at 0
67
68 _valid = true;
69}
70
Matt Spinler31eed992019-10-09 14:07:52 -050071PrivateHeader::PrivateHeader(Stream& pel) :
72 _creatorID(0), _logType(0), _reservedByte(0), _sectionCount(0),
73 _obmcLogID(0), _plid(0), _id(0)
Matt Spinlerd3335df2019-07-10 11:04:21 -050074{
75 try
76 {
Matt Spinlercf5a8d02019-09-05 12:58:53 -050077 unflatten(pel);
Matt Spinlerd3335df2019-07-10 11:04:21 -050078 validate();
79 }
80 catch (const std::exception& e)
81 {
Matt Spinler8ac20502023-01-04 11:03:58 -060082 log<level::ERR>(
Jayanth Othayoth1aa90d42023-09-13 04:25:45 -050083 std::format("Cannot unflatten private header: {}", e.what())
Matt Spinler8ac20502023-01-04 11:03:58 -060084 .c_str());
Matt Spinlerd3335df2019-07-10 11:04:21 -050085 _valid = false;
86 }
87}
Matt Spinlerb832aa52023-03-21 15:32:34 -050088std::optional<std::string> PrivateHeader::getJSON(uint8_t creatorID) const
Aatirc92b4eb2019-11-18 13:44:51 -060089{
90 char tmpPhVal[50];
Harisuddin Mohamed Isa160c51c2020-02-13 23:42:20 +080091 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X",
Aatirc92b4eb2019-11-18 13:44:51 -060092 _createTimestamp.month, _createTimestamp.day,
93 _createTimestamp.yearMSB, _createTimestamp.yearLSB,
94 _createTimestamp.hour, _createTimestamp.minutes,
95 _createTimestamp.seconds);
96 std::string phCreateTStr(tmpPhVal);
Harisuddin Mohamed Isa160c51c2020-02-13 23:42:20 +080097 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X",
Aatirc92b4eb2019-11-18 13:44:51 -060098 _commitTimestamp.month, _commitTimestamp.day,
Sumit Kumar74348c62021-10-26 05:48:28 -050099 _commitTimestamp.yearMSB, _commitTimestamp.yearLSB,
Aatirc92b4eb2019-11-18 13:44:51 -0600100 _commitTimestamp.hour, _commitTimestamp.minutes,
101 _commitTimestamp.seconds);
102 std::string phCommitTStr(tmpPhVal);
Harisuddin Mohamed Isabebeb942020-03-12 17:12:24 +0800103 std::string creator = getNumberString("%c", _creatorID);
Aatirc92b4eb2019-11-18 13:44:51 -0600104 creator = pv::creatorIDs.count(creator) ? pv::creatorIDs.at(creator)
105 : "Unknown CreatorID";
106 std::string phCreatorVersionStr =
107 std::string(reinterpret_cast<const char*>(_creatorVersion.version));
Matt Spinlerd3335df2019-07-10 11:04:21 -0500108
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800109 std::string ph;
Harisuddin Mohamed Isabebeb942020-03-12 17:12:24 +0800110 jsonInsert(ph, pv::sectionVer, getNumberString("%d", privateHeaderVersion),
111 1);
112 jsonInsert(ph, pv::subSection, getNumberString("%d", _header.subType), 1);
Matt Spinlerb832aa52023-03-21 15:32:34 -0500113 jsonInsert(ph, pv::createdBy,
114 getComponentName(_header.componentID, creatorID), 1);
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800115 jsonInsert(ph, "Created at", phCreateTStr, 1);
116 jsonInsert(ph, "Committed at", phCommitTStr, 1);
117 jsonInsert(ph, "Creator Subsystem", creator, 1);
118 jsonInsert(ph, "CSSVER", phCreatorVersionStr, 1);
Harisuddin Mohamed Isabebeb942020-03-12 17:12:24 +0800119 jsonInsert(ph, "Platform Log Id", getNumberString("0x%X", _plid), 1);
120 jsonInsert(ph, "Entry Id", getNumberString("0x%X", _id), 1);
121 jsonInsert(ph, "BMC Event Log Id", std::to_string(_obmcLogID), 1);
Harisuddin Mohamed Isa2ecb4652020-01-10 10:51:02 +0800122 ph.erase(ph.size() - 2);
Aatirc92b4eb2019-11-18 13:44:51 -0600123
124 return ph;
125}
Matt Spinlerd3335df2019-07-10 11:04:21 -0500126void PrivateHeader::validate()
127{
128 bool failed = false;
129
Matt Spinler1a94cc32019-09-11 13:32:12 -0500130 if (header().id != static_cast<uint16_t>(SectionID::privateHeader))
Matt Spinlerd3335df2019-07-10 11:04:21 -0500131 {
Jayanth Othayoth1aa90d42023-09-13 04:25:45 -0500132 log<level::ERR>(std::format("Invalid private header section ID: {0:#x}",
Matt Spinler8ac20502023-01-04 11:03:58 -0600133 header().id)
134 .c_str());
Matt Spinlerd3335df2019-07-10 11:04:21 -0500135 failed = true;
136 }
137
138 if (header().version != privateHeaderVersion)
139 {
Jayanth Othayoth1aa90d42023-09-13 04:25:45 -0500140 log<level::ERR>(std::format("Invalid private header version: {0:#x}",
Matt Spinler8ac20502023-01-04 11:03:58 -0600141 header().version)
142 .c_str());
Matt Spinlerd3335df2019-07-10 11:04:21 -0500143 failed = true;
144 }
145
146 if (_sectionCount < minSectionCount)
147 {
Matt Spinler8ac20502023-01-04 11:03:58 -0600148 log<level::ERR>(
Jayanth Othayoth1aa90d42023-09-13 04:25:45 -0500149 std::format("Invalid section count in private header: {0:#x}",
Matt Spinler8ac20502023-01-04 11:03:58 -0600150 _sectionCount)
151 .c_str());
Matt Spinlerd3335df2019-07-10 11:04:21 -0500152 failed = true;
153 }
154
155 _valid = (failed) ? false : true;
156}
157
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500158void PrivateHeader::unflatten(Stream& stream)
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
Matt Spinler06885452019-11-06 10:35:42 -0600165void PrivateHeader::flatten(Stream& stream) const
Matt Spinlerd3335df2019-07-10 11:04:21 -0500166{
Matt Spinlercf5a8d02019-09-05 12:58:53 -0500167 stream << _header << _createTimestamp << _commitTimestamp << _creatorID
168 << _logType << _reservedByte << _sectionCount << _obmcLogID
169 << _creatorVersion << _plid << _id;
Matt Spinlerd3335df2019-07-10 11:04:21 -0500170}
171
172Stream& operator>>(Stream& s, CreatorVersion& cv)
173{
174 for (size_t i = 0; i < sizeof(CreatorVersion); i++)
175 {
176 s >> cv.version[i];
177 }
178 return s;
179}
180
Matt Spinler06885452019-11-06 10:35:42 -0600181Stream& operator<<(Stream& s, const CreatorVersion& cv)
Matt Spinlerd3335df2019-07-10 11:04:21 -0500182{
183 for (size_t i = 0; i < sizeof(CreatorVersion); i++)
184 {
185 s << cv.version[i];
186 }
187 return s;
188}
189
190} // namespace pels
191} // namespace openpower