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 "failing_mtms.hpp"
17 
18 #include "json_utils.hpp"
19 #include "pel_types.hpp"
20 #include "pel_values.hpp"
21 
22 #include <phosphor-logging/log.hpp>
23 
24 #include <format>
25 
26 namespace openpower
27 {
28 namespace pels
29 {
30 
31 namespace pv = openpower::pels::pel_values;
32 using namespace phosphor::logging;
33 static constexpr uint8_t failingMTMSVersion = 0x01;
34 
35 FailingMTMS::FailingMTMS(const DataInterfaceBase& dataIface) :
36     _mtms(dataIface.getMachineTypeModel(), dataIface.getMachineSerialNumber())
37 {
38     _header.id = static_cast<uint16_t>(SectionID::failingMTMS);
39     _header.size = FailingMTMS::flattenedSize();
40     _header.version = failingMTMSVersion;
41     _header.subType = 0;
42     _header.componentID = static_cast<uint16_t>(ComponentID::phosphorLogging);
43 
44     _valid = true;
45 }
46 
47 FailingMTMS::FailingMTMS(Stream& pel)
48 {
49     try
50     {
51         unflatten(pel);
52         validate();
53     }
54     catch (const std::exception& e)
55     {
56         log<level::ERR>(
57             std::format("Cannot unflatten failing MTM section: {}", e.what())
58                 .c_str());
59         _valid = false;
60     }
61 }
62 
63 void FailingMTMS::validate()
64 {
65     bool failed = false;
66 
67     if (header().id != static_cast<uint16_t>(SectionID::failingMTMS))
68     {
69         log<level::ERR>(
70             std::format("Invalid failing MTMS section ID: {0:#x}", header().id)
71                 .c_str());
72         failed = true;
73     }
74 
75     if (header().version != failingMTMSVersion)
76     {
77         log<level::ERR>(std::format("Invalid failing MTMS version: {0:#x}",
78                                     header().version)
79                             .c_str());
80         failed = true;
81     }
82 
83     _valid = (failed) ? false : true;
84 }
85 
86 void FailingMTMS::flatten(Stream& stream) const
87 {
88     stream << _header << _mtms;
89 }
90 
91 void FailingMTMS::unflatten(Stream& stream)
92 {
93     stream >> _header >> _mtms;
94 }
95 
96 std::optional<std::string> FailingMTMS::getJSON(uint8_t creatorID) const
97 {
98     std::string json;
99     jsonInsert(json, pv::sectionVer, getNumberString("%d", _header.version), 1);
100     jsonInsert(json, pv::subSection, getNumberString("%d", _header.subType), 1);
101     jsonInsert(json, pv::createdBy,
102                getComponentName(_header.componentID, creatorID), 1);
103     jsonInsert(json, "Machine Type Model", _mtms.machineTypeAndModel(), 1);
104     jsonInsert(json, "Serial Number", trimEnd(_mtms.machineSerialNumber()), 1);
105     json.erase(json.size() - 2);
106     return json;
107 }
108 } // namespace pels
109 } // namespace openpower
110