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 "user_header.hpp"
17 
18 #include "json_utils.hpp"
19 #include "pel_types.hpp"
20 #include "pel_values.hpp"
21 #include "severity.hpp"
22 
23 #include <fmt/format.h>
24 
25 #include <iostream>
26 #include <phosphor-logging/log.hpp>
27 
28 namespace openpower
29 {
30 namespace pels
31 {
32 
33 namespace pv = openpower::pels::pel_values;
34 using namespace phosphor::logging;
35 
36 void UserHeader::unflatten(Stream& stream)
37 {
38     stream >> _header >> _eventSubsystem >> _eventScope >> _eventSeverity >>
39         _eventType >> _reserved4Byte1 >> _problemDomain >> _problemVector >>
40         _actionFlags >> _states;
41 }
42 
43 void UserHeader::flatten(Stream& stream) const
44 {
45     stream << _header << _eventSubsystem << _eventScope << _eventSeverity
46            << _eventType << _reserved4Byte1 << _problemDomain << _problemVector
47            << _actionFlags << _states;
48 }
49 
50 UserHeader::UserHeader(const message::Entry& entry,
51                        phosphor::logging::Entry::Level severity,
52                        const AdditionalData& additionalData,
53                        const DataInterfaceBase& dataIface)
54 {
55     _header.id = static_cast<uint16_t>(SectionID::userHeader);
56     _header.size = UserHeader::flattenedSize();
57     _header.version = userHeaderVersion;
58     _header.subType = 0;
59     _header.componentID = static_cast<uint16_t>(ComponentID::phosphorLogging);
60 
61     std::optional<uint8_t> subsys;
62 
63     // Check for additional data - PEL_SUBSYSTEM
64     auto ss = additionalData.getValue("PEL_SUBSYSTEM");
65     if (ss)
66     {
67         auto eventSubsystem = std::stoul(*ss, NULL, 16);
68         std::string subsystemString =
69             pv::getValue(eventSubsystem, pel_values::subsystemValues);
70         if (subsystemString == "invalid")
71         {
72             log<level::WARNING>(
73                 fmt::format(
74                     "UH: Invalid SubSystem value in PEL_SUBSYSTEM: {:#X}",
75                     eventSubsystem)
76                     .c_str());
77         }
78         else
79         {
80             subsys = eventSubsystem;
81         }
82     }
83     else
84     {
85         subsys = entry.subsystem;
86     }
87 
88     if (subsys)
89     {
90         _eventSubsystem = *subsys;
91     }
92     else
93     {
94         // Gotta use something, how about 'others'.
95         log<level::WARNING>(
96             "No PEL subystem value supplied for error, using 'others'");
97         _eventSubsystem = 0x70;
98     }
99 
100     _eventScope = entry.eventScope.value_or(
101         static_cast<uint8_t>(EventScope::entirePlatform));
102 
103     {
104         bool mfgSevStatus = false;
105         bool mfgActionFlagStatus = false;
106         std::optional<uint8_t> sev = std::nullopt;
107         uint16_t val = 0;
108 
109         // Get the mfg severity & action flags
110         if (entry.mfgSeverity || entry.mfgActionFlags)
111         {
112             if (entry.mfgSeverity)
113             {
114                 // Find the mf severity possibly dependent on the system type.
115                 sev = getSeverity(entry.mfgSeverity.value(), dataIface);
116             }
117 
118             if (entry.mfgActionFlags)
119             {
120                 // Find the mfg action flags
121                 val = entry.mfgActionFlags.value();
122             }
123 
124             if (sev || val)
125             {
126                 bool mfgProp = dataIface.getQuiesceOnError();
127                 if (mfgProp)
128                 {
129                     if (sev)
130                     {
131                         _eventSeverity = *sev;
132                         mfgSevStatus = true;
133                     }
134 
135                     if (val)
136                     {
137                         _actionFlags = val;
138                         mfgActionFlagStatus = true;
139                     }
140                 }
141             }
142         }
143 
144         if (!mfgSevStatus)
145         {
146             // Get the severity from the registry if it's there, otherwise get
147             // it from the OpenBMC event log severity value.
148             if (!entry.severity)
149             {
150                 _eventSeverity = convertOBMCSeverityToPEL(severity);
151             }
152             else
153             {
154                 // Find the severity possibly dependent on the system type.
155                 auto sev = getSeverity(entry.severity.value(), dataIface);
156                 if (sev)
157                 {
158                     _eventSeverity = *sev;
159                 }
160                 else
161                 {
162                     // Either someone  screwed up the message registry
163                     // or getSystemNames failed.
164                     std::string types;
165                     log<level::ERR>(
166                         "Failed finding the severity in the message registry",
167                         phosphor::logging::entry("ERROR=%s",
168                                                  entry.name.c_str()));
169 
170                     // Have to choose something, just use informational.
171                     _eventSeverity = 0;
172                 }
173             }
174         }
175 
176         // Convert Critical error (0x50) to Critical Error-System Termination
177         // (0x51), if the AdditionalData is set to SYSTEM_TERM
178         auto sevLevel = additionalData.getValue("SEVERITY_DETAIL");
179         if ((_eventSeverity & 0xF0) == 0x50)
180         {
181             if (sevLevel.value_or("") == "SYSTEM_TERM")
182             {
183                 // Change to Critical Error, System Termination
184                 _eventSeverity = 0x51;
185             }
186         }
187 
188         if (entry.eventType)
189         {
190             _eventType = *entry.eventType;
191         }
192         else
193         {
194             // There are different default event types for info errors
195             // vs non info ones.
196             auto sevType = static_cast<SeverityType>(_eventSeverity & 0xF0);
197             _eventType =
198                 (sevType == SeverityType::nonError)
199                     ? static_cast<uint8_t>(EventType::miscInformational)
200                     : static_cast<uint8_t>(EventType::notApplicable);
201         }
202 
203         _reserved4Byte1 = 0;
204 
205         // No uses for problem domain or vector
206         _problemDomain = 0;
207         _problemVector = 0;
208 
209         // These will be set in pel_rules::check() if they're still
210         // at the default value.
211         if (!mfgActionFlagStatus)
212         {
213             _actionFlags = entry.actionFlags.value_or(actionFlagsDefault);
214         }
215 
216         _states = 0;
217 
218         _valid = true;
219     }
220 }
221 
222 UserHeader::UserHeader(Stream& pel)
223 {
224     try
225     {
226         unflatten(pel);
227         validate();
228     }
229     catch (const std::exception& e)
230     {
231         log<level::ERR>("Cannot unflatten user header",
232                         entry("ERROR=%s", e.what()));
233         _valid = false;
234     }
235 }
236 
237 void UserHeader::validate()
238 {
239     bool failed = false;
240     if (header().id != static_cast<uint16_t>(SectionID::userHeader))
241     {
242         log<level::ERR>("Invalid user header section ID",
243                         entry("ID=0x%X", header().id));
244         failed = true;
245     }
246 
247     if (header().version != userHeaderVersion)
248     {
249         log<level::ERR>("Invalid user header version",
250                         entry("VERSION=0x%X", header().version));
251         failed = true;
252     }
253 
254     _valid = (failed) ? false : true;
255 }
256 
257 std::optional<std::string> UserHeader::getJSON() const
258 {
259     std::string severity;
260     std::string subsystem;
261     std::string eventScope;
262     std::string eventType;
263     std::vector<std::string> actionFlags;
264     severity = pv::getValue(_eventSeverity, pel_values::severityValues);
265     subsystem = pv::getValue(_eventSubsystem, pel_values::subsystemValues);
266     eventScope = pv::getValue(_eventScope, pel_values::eventScopeValues);
267     eventType = pv::getValue(_eventType, pel_values::eventTypeValues);
268     actionFlags =
269         pv::getValuesBitwise(_actionFlags, pel_values::actionFlagsValues);
270 
271     std::string hostState{"Invalid"};
272     std::string hmcState{"Invalid"};
273     auto iter = pv::transmissionStates.find(
274         static_cast<TransmissionState>(hostTransmissionState()));
275     if (iter != pv::transmissionStates.end())
276     {
277         hostState = iter->second;
278     }
279     auto iter1 = pv::transmissionStates.find(
280         static_cast<TransmissionState>(hmcTransmissionState()));
281     if (iter1 != pv::transmissionStates.end())
282     {
283         hmcState = iter1->second;
284     }
285 
286     std::string uh;
287     jsonInsert(uh, pv::sectionVer, getNumberString("%d", userHeaderVersion), 1);
288     jsonInsert(uh, pv::subSection, getNumberString("%d", _header.subType), 1);
289     jsonInsert(uh, "Log Committed by",
290                getNumberString("0x%X", _header.componentID), 1);
291     jsonInsert(uh, "Subsystem", subsystem, 1);
292     jsonInsert(uh, "Event Scope", eventScope, 1);
293     jsonInsert(uh, "Event Severity", severity, 1);
294     jsonInsert(uh, "Event Type", eventType, 1);
295     jsonInsertArray(uh, "Action Flags", actionFlags, 1);
296     jsonInsert(uh, "Host Transmission", hostState, 1);
297     jsonInsert(uh, "HMC Transmission", hmcState, 1);
298     uh.erase(uh.size() - 2);
299     return uh;
300 }
301 
302 std::optional<uint8_t> UserHeader::getSeverity(
303     const std::vector<message::RegistrySeverity>& severities,
304     const DataInterfaceBase& dataIface) const
305 {
306     const uint8_t* s = nullptr;
307     std::vector<std::string> systemNames;
308 
309     // getSystemNames makes D-Bus calls, so only call it if we
310     // know we'll need it because there is a system name in the sev list
311     if (std::any_of(severities.begin(), severities.end(),
312                     [](const auto& sev) { return !sev.system.empty(); }))
313     {
314         try
315         {
316             systemNames = dataIface.getSystemNames();
317         }
318         catch (const std::exception& e)
319         {
320             log<level::ERR>("Failed trying to look up system names on D-Bus",
321                             entry("ERROR=%s", e.what()));
322             return std::nullopt;
323         }
324     }
325 
326     // Find the severity to use for this system type, or use the default
327     // entry (where no system type is specified).
328     for (const auto& sev : severities)
329     {
330         if (std::find(systemNames.begin(), systemNames.end(), sev.system) !=
331             systemNames.end())
332         {
333             s = &sev.severity;
334             break;
335         }
336         else if (sev.system.empty())
337         {
338             s = &sev.severity;
339         }
340     }
341 
342     if (s)
343     {
344         return *s;
345     }
346 
347     return std::nullopt;
348 }
349 
350 } // namespace pels
351 } // namespace openpower
352