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