1 /** 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 */ 16 #include "private_header.hpp" 17 18 #include "json_utils.hpp" 19 #include "log_id.hpp" 20 #include "pel_types.hpp" 21 #include "pel_values.hpp" 22 23 #include <phosphor-logging/lg2.hpp> 24 25 #include <format> 26 27 namespace openpower 28 { 29 namespace pels 30 { 31 32 namespace pv = openpower::pels::pel_values; 33 34 PrivateHeader::PrivateHeader(uint16_t componentID, uint32_t obmcLogID, 35 uint64_t timestamp) 36 { 37 _header.id = static_cast<uint16_t>(SectionID::privateHeader); 38 _header.size = PrivateHeader::flattenedSize(); 39 _header.version = privateHeaderVersion; 40 _header.subType = 0; 41 _header.componentID = componentID; 42 43 _createTimestamp = getBCDTime(timestamp); 44 45 auto now = std::chrono::system_clock::now(); 46 _commitTimestamp = getBCDTime(now); 47 48 _creatorID = static_cast<uint8_t>(CreatorID::openBMC); 49 50 // Add support for reminder and telemetry log types here if 51 // ever necessary. 52 _logType = 0; 53 54 _reservedByte = 0; 55 56 // the final section count will be updated later 57 _sectionCount = 1; 58 59 _obmcLogID = obmcLogID; 60 61 _id = generatePELID(); 62 63 _plid = _id; 64 65 // Leave _creatorVersion at 0 66 67 _valid = true; 68 } 69 70 PrivateHeader::PrivateHeader(Stream& pel) : 71 _creatorID(0), _logType(0), _reservedByte(0), _sectionCount(0), 72 _obmcLogID(0), _plid(0), _id(0) 73 { 74 try 75 { 76 unflatten(pel); 77 validate(); 78 } 79 catch (const std::exception& e) 80 { 81 lg2::error("Cannot unflatten private header: {EXCEPTION}", "EXCEPTION", 82 e); 83 _valid = false; 84 } 85 } 86 std::optional<std::string> PrivateHeader::getJSON(uint8_t creatorID) const 87 { 88 char tmpPhVal[50]; 89 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X", 90 _createTimestamp.month, _createTimestamp.day, 91 _createTimestamp.yearMSB, _createTimestamp.yearLSB, 92 _createTimestamp.hour, _createTimestamp.minutes, 93 _createTimestamp.seconds); 94 std::string phCreateTStr(tmpPhVal); 95 sprintf(tmpPhVal, "%02X/%02X/%02X%02X %02X:%02X:%02X", 96 _commitTimestamp.month, _commitTimestamp.day, 97 _commitTimestamp.yearMSB, _commitTimestamp.yearLSB, 98 _commitTimestamp.hour, _commitTimestamp.minutes, 99 _commitTimestamp.seconds); 100 std::string phCommitTStr(tmpPhVal); 101 std::string creator = getNumberString("%c", _creatorID); 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)); 106 107 std::string ph; 108 jsonInsert(ph, pv::sectionVer, getNumberString("%d", privateHeaderVersion), 109 1); 110 jsonInsert(ph, pv::subSection, getNumberString("%d", _header.subType), 1); 111 jsonInsert(ph, pv::createdBy, 112 getComponentName(_header.componentID, creatorID), 1); 113 jsonInsert(ph, "Created at", phCreateTStr, 1); 114 jsonInsert(ph, "Committed at", phCommitTStr, 1); 115 jsonInsert(ph, "Creator Subsystem", creator, 1); 116 jsonInsert(ph, "CSSVER", phCreatorVersionStr, 1); 117 jsonInsert(ph, "Platform Log Id", getNumberString("0x%X", _plid), 1); 118 jsonInsert(ph, "Entry Id", getNumberString("0x%X", _id), 1); 119 jsonInsert(ph, "BMC Event Log Id", std::to_string(_obmcLogID), 1); 120 ph.erase(ph.size() - 2); 121 122 return ph; 123 } 124 void PrivateHeader::validate() 125 { 126 bool failed = false; 127 128 if (header().id != static_cast<uint16_t>(SectionID::privateHeader)) 129 { 130 lg2::error("Invalid private header section ID: {HEADER_ID}", 131 "HEADER_ID", lg2::hex, header().id); 132 failed = true; 133 } 134 135 if (header().version != privateHeaderVersion) 136 { 137 lg2::error("Invalid private header version: {HEADER_VERSION}", 138 "HEADER_VERSION", lg2::hex, header().version); 139 failed = true; 140 } 141 142 if (_sectionCount < minSectionCount) 143 { 144 lg2::error("Invalid section count in private header: {SECTION_COUNT}", 145 "SECTION_COUNT", lg2::hex, _sectionCount); 146 failed = true; 147 } 148 149 _valid = (failed) ? false : true; 150 } 151 152 void PrivateHeader::unflatten(Stream& stream) 153 { 154 stream >> _header >> _createTimestamp >> _commitTimestamp >> _creatorID >> 155 _logType >> _reservedByte >> _sectionCount >> _obmcLogID >> 156 _creatorVersion >> _plid >> _id; 157 } 158 159 void PrivateHeader::flatten(Stream& stream) const 160 { 161 stream << _header << _createTimestamp << _commitTimestamp << _creatorID 162 << _logType << _reservedByte << _sectionCount << _obmcLogID 163 << _creatorVersion << _plid << _id; 164 } 165 166 Stream& operator>>(Stream& s, CreatorVersion& cv) 167 { 168 for (size_t i = 0; i < sizeof(CreatorVersion); i++) 169 { 170 s >> cv.version[i]; 171 } 172 return s; 173 } 174 175 Stream& operator<<(Stream& s, const 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 184 } // namespace pels 185 } // namespace openpower 186