blob: 19d140d6eb1daf21082e0a0fdecd132a34916edb [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 Spinlerf9bae182019-10-09 13:37:38 -050016#include "src.hpp"
17
Matt Spinler717de422020-06-04 13:10:14 -050018#include "device_callouts.hpp"
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +080019#include "json_utils.hpp"
20#include "paths.hpp"
21#include "pel_values.hpp"
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +080022#ifdef PELTOOL
23#include <Python.h>
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +080024
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +080025#include <nlohmann/json.hpp>
26#include <sstream>
27#endif
Matt Spinler5a90a952020-08-27 09:39:03 -050028#include <fmt/format.h>
29
Matt Spinlerf9bae182019-10-09 13:37:38 -050030#include <phosphor-logging/log.hpp>
31
32namespace openpower
33{
34namespace pels
35{
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +080036namespace pv = openpower::pels::pel_values;
37namespace rg = openpower::pels::message;
Matt Spinlerf9bae182019-10-09 13:37:38 -050038using namespace phosphor::logging;
Matt Spinler85f61a62020-06-03 16:28:55 -050039using namespace std::string_literals;
Matt Spinlerf9bae182019-10-09 13:37:38 -050040
Matt Spinler075e5ba2020-02-21 15:46:00 -060041constexpr size_t ccinSize = 4;
42
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +080043#ifdef PELTOOL
Sumit Kumar516935a2021-04-14 13:00:54 -050044using orderedJSON = nlohmann::ordered_json;
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +080045
46void pyDecRef(PyObject* pyObj)
47{
48 Py_XDECREF(pyObj);
49}
50
51/**
52 * @brief Returns a JSON string to append to SRC section.
53 *
54 * The returning string will contain a JSON object, but without
55 * the outer {}. If the input JSON isn't a JSON object (dict), then
56 * one will be created with the input added to a 'SRC Details' key.
57 *
58 * @param[in] json - The JSON to convert to a string
59 *
60 * @return std::string - The JSON string
61 */
Sumit Kumar516935a2021-04-14 13:00:54 -050062std::string prettyJSON(const orderedJSON& json)
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +080063{
Sumit Kumar516935a2021-04-14 13:00:54 -050064 orderedJSON output;
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +080065 if (!json.is_object())
66 {
67 output["SRC Details"] = json;
68 }
69 else
70 {
71 for (const auto& [key, value] : json.items())
72 {
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +080073 output["SRC Details"][key] = value;
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +080074 }
75 }
76
77 // Let nlohmann do the pretty printing.
78 std::stringstream stream;
79 stream << std::setw(4) << output;
80
81 auto jsonString = stream.str();
82
83 // Now it looks like:
84 // {
85 // "Key": "Value",
86 // ...
87 // }
88
89 // Replace the { and the following newline, and the } and its
90 // preceeding newline.
91 jsonString.erase(0, 2);
92
93 auto pos = jsonString.find_last_of('}');
94 jsonString.erase(pos - 1);
95
96 return jsonString;
97}
98
99/**
100 * @brief Call Python modules to parse the data into a JSON string
101 *
102 * The module to call is based on the Creator Subsystem ID under the namespace
103 * "srcparsers". For example: "srcparsers.xsrc.xsrc" where "x" is the Creator
104 * Subsystem ID in ASCII lowercase.
105 *
106 * All modules must provide the following:
107 * Function: parseSRCToJson
108 * Argument list:
109 * 1. (str) ASCII string (Hex Word 1)
110 * 2. (str) Hex Word 2
111 * 3. (str) Hex Word 3
112 * 4. (str) Hex Word 4
113 * 5. (str) Hex Word 5
114 * 6. (str) Hex Word 6
115 * 7. (str) Hex Word 7
116 * 8. (str) Hex Word 8
117 * 9. (str) Hex Word 9
118 *-Return data:
119 * 1. (str) JSON string
120 *
121 * @param[in] hexwords - Vector of strings of Hexwords 1-9
122 * @param[in] creatorID - The creatorID from the Private Header section
123 * @return std::optional<std::string> - The JSON string if it could be created,
124 * else std::nullopt
125 */
126std::optional<std::string> getPythonJSON(std::vector<std::string>& hexwords,
127 uint8_t creatorID)
128{
129 PyObject *pName, *pModule, *pDict, *pFunc, *pArgs, *pResult, *pBytes,
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800130 *eType, *eValue, *eTraceback, *pKey;
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800131 std::string pErrStr;
132 std::string module = getNumberString("%c", tolower(creatorID)) + "src";
133 pName = PyUnicode_FromString(
134 std::string("srcparsers." + module + "." + module).c_str());
135 std::unique_ptr<PyObject, decltype(&pyDecRef)> modNamePtr(pName, &pyDecRef);
136 pModule = PyImport_Import(pName);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800137 if (pModule == NULL)
138 {
139 pErrStr = "No error string found";
140 PyErr_Fetch(&eType, &eValue, &eTraceback);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800141 if (eType)
142 {
143 Py_XDECREF(eType);
144 }
145 if (eTraceback)
146 {
147 Py_XDECREF(eTraceback);
148 }
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800149 if (eValue)
150 {
151 PyObject* pStr = PyObject_Str(eValue);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800152 Py_XDECREF(eValue);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800153 if (pStr)
154 {
155 pErrStr = PyUnicode_AsUTF8(pStr);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800156 Py_XDECREF(pStr);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800157 }
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800158 }
159 }
160 else
161 {
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800162 std::unique_ptr<PyObject, decltype(&pyDecRef)> modPtr(pModule,
163 &pyDecRef);
164 std::string funcToCall = "parseSRCToJson";
165 pKey = PyUnicode_FromString(funcToCall.c_str());
166 std::unique_ptr<PyObject, decltype(&pyDecRef)> keyPtr(pKey, &pyDecRef);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800167 pDict = PyModule_GetDict(pModule);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800168 Py_INCREF(pDict);
169 if (!PyDict_Contains(pDict, pKey))
170 {
171 Py_DECREF(pDict);
172 log<level::ERR>(
173 "Python module error",
174 entry("ERROR=%s",
175 std::string(funcToCall + " function missing").c_str()),
176 entry("SRC=%s", hexwords.front().c_str()),
177 entry("PARSER_MODULE=%s", module.c_str()));
178 return std::nullopt;
179 }
180 pFunc = PyDict_GetItemString(pDict, funcToCall.c_str());
181 Py_DECREF(pDict);
182 Py_INCREF(pFunc);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800183 if (PyCallable_Check(pFunc))
184 {
185 pArgs = PyTuple_New(9);
186 std::unique_ptr<PyObject, decltype(&pyDecRef)> argPtr(pArgs,
187 &pyDecRef);
188 for (size_t i = 0; i < 9; i++)
189 {
190 if (i < hexwords.size())
191 {
192 auto arg = hexwords[i];
193 PyTuple_SetItem(pArgs, i,
194 Py_BuildValue("s#", arg.c_str(), 8));
195 }
196 else
197 {
198 PyTuple_SetItem(pArgs, i, Py_BuildValue("s", "00000000"));
199 }
200 }
201 pResult = PyObject_CallObject(pFunc, pArgs);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800202 Py_DECREF(pFunc);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800203 if (pResult)
204 {
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800205 std::unique_ptr<PyObject, decltype(&pyDecRef)> resPtr(
206 pResult, &pyDecRef);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800207 pBytes = PyUnicode_AsEncodedString(pResult, "utf-8", "~E~");
208 std::unique_ptr<PyObject, decltype(&pyDecRef)> pyBytePtr(
209 pBytes, &pyDecRef);
210 const char* output = PyBytes_AS_STRING(pBytes);
211 try
212 {
Matt Spinlerbb1c1d52021-06-03 13:18:48 -0600213 orderedJSON json = orderedJSON::parse(output);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800214 if ((json.is_object() && !json.empty()) ||
215 (json.is_array() && json.size() > 0) ||
216 (json.is_string() && json != ""))
217 {
218 return prettyJSON(json);
219 }
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800220 }
Patrick Williams66491c62021-10-06 12:23:37 -0500221 catch (const std::exception& e)
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800222 {
223 log<level::ERR>("Bad JSON from parser",
224 entry("ERROR=%s", e.what()),
225 entry("SRC=%s", hexwords.front().c_str()),
226 entry("PARSER_MODULE=%s", module.c_str()));
227 return std::nullopt;
228 }
229 }
230 else
231 {
232 pErrStr = "No error string found";
233 PyErr_Fetch(&eType, &eValue, &eTraceback);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800234 if (eType)
235 {
236 Py_XDECREF(eType);
237 }
238 if (eTraceback)
239 {
240 Py_XDECREF(eTraceback);
241 }
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800242 if (eValue)
243 {
244 PyObject* pStr = PyObject_Str(eValue);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800245 Py_XDECREF(eValue);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800246 if (pStr)
247 {
248 pErrStr = PyUnicode_AsUTF8(pStr);
Harisuddin Mohamed Isa69c18272021-05-29 13:18:45 +0800249 Py_XDECREF(pStr);
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800250 }
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800251 }
252 }
253 }
254 }
255 if (!pErrStr.empty())
256 {
Matt Spinler3279cc52022-02-15 11:02:00 -0600257 log<level::DEBUG>("Python exception thrown by parser",
258 entry("ERROR=%s", pErrStr.c_str()),
259 entry("SRC=%s", hexwords.front().c_str()),
260 entry("PARSER_MODULE=%s", module.c_str()));
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800261 }
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800262 return std::nullopt;
263}
264#endif
265
Matt Spinlerf9bae182019-10-09 13:37:38 -0500266void SRC::unflatten(Stream& stream)
267{
268 stream >> _header >> _version >> _flags >> _reserved1B >> _wordCount >>
269 _reserved2B >> _size;
270
271 for (auto& word : _hexData)
272 {
273 stream >> word;
274 }
275
276 _asciiString = std::make_unique<src::AsciiString>(stream);
277
278 if (hasAdditionalSections())
279 {
280 // The callouts section is currently the only extra subsection type
281 _callouts = std::make_unique<src::Callouts>(stream);
282 }
283}
284
Matt Spinler06885452019-11-06 10:35:42 -0600285void SRC::flatten(Stream& stream) const
Matt Spinlerf9bae182019-10-09 13:37:38 -0500286{
287 stream << _header << _version << _flags << _reserved1B << _wordCount
288 << _reserved2B << _size;
289
290 for (auto& word : _hexData)
291 {
292 stream << word;
293 }
294
295 _asciiString->flatten(stream);
296
297 if (_callouts)
298 {
299 _callouts->flatten(stream);
300 }
301}
302
303SRC::SRC(Stream& pel)
304{
305 try
306 {
307 unflatten(pel);
308 validate();
309 }
310 catch (const std::exception& e)
311 {
312 log<level::ERR>("Cannot unflatten SRC", entry("ERROR=%s", e.what()));
313 _valid = false;
314 }
315}
316
Matt Spinler075e5ba2020-02-21 15:46:00 -0600317SRC::SRC(const message::Entry& regEntry, const AdditionalData& additionalData,
Matt Spinler5a90a952020-08-27 09:39:03 -0500318 const nlohmann::json& jsonCallouts, const DataInterfaceBase& dataIface)
Matt Spinlerbd716f02019-10-15 10:54:11 -0500319{
320 _header.id = static_cast<uint16_t>(SectionID::primarySRC);
321 _header.version = srcSectionVersion;
322 _header.subType = srcSectionSubtype;
323 _header.componentID = regEntry.componentID;
324
325 _version = srcVersion;
326
327 _flags = 0;
Vijay Lobof3702bb2021-04-09 15:10:19 -0500328
Matt Spinlerbd716f02019-10-15 10:54:11 -0500329 _reserved1B = 0;
330
331 _wordCount = numSRCHexDataWords + 1;
332
333 _reserved2B = 0;
334
335 // There are multiple fields encoded in the hex data words.
336 std::for_each(_hexData.begin(), _hexData.end(),
337 [](auto& word) { word = 0; });
Matt Spinler7c619182020-07-27 15:15:11 -0500338
339 // Hex Word 2 Nibbles:
340 // MIGVEPFF
341 // M: Partition dump status = 0
342 // I: System boot state = TODO
343 // G: Partition Boot type = 0
Sumit Kumar9d43a722021-08-24 09:46:19 -0500344 // V: BMC dump status
Matt Spinler7c619182020-07-27 15:15:11 -0500345 // E: Platform boot mode = 0 (side = temporary, speed = fast)
Sumit Kumar9d43a722021-08-24 09:46:19 -0500346 // P: Platform dump status
Matt Spinler7c619182020-07-27 15:15:11 -0500347 // FF: SRC format, set below
348
Sumit Kumar9d43a722021-08-24 09:46:19 -0500349 setDumpStatus(dataIface);
Matt Spinlerbd716f02019-10-15 10:54:11 -0500350 setBMCFormat();
351 setBMCPosition();
Matt Spinler075e5ba2020-02-21 15:46:00 -0600352 setMotherboardCCIN(dataIface);
353
Matt Spinlerbd716f02019-10-15 10:54:11 -0500354 // Fill in the last 4 words from the AdditionalData property contents.
355 setUserDefinedHexWords(regEntry, additionalData);
356
357 _asciiString = std::make_unique<src::AsciiString>(regEntry);
358
Sumit Kumar50bfa692022-01-06 06:48:26 -0600359 // Check for additional data - PEL_SUBSYSTEM
360 auto ss = additionalData.getValue("PEL_SUBSYSTEM");
361 if (ss)
362 {
363 auto eventSubsystem = std::stoul(*ss, NULL, 16);
364 std::string subsystem =
365 pv::getValue(eventSubsystem, pel_values::subsystemValues);
366 if (subsystem == "invalid")
367 {
368 log<level::WARNING>(
369 fmt::format("SRC: Invalid SubSystem value:{:#X}",
370 eventSubsystem)
371 .c_str());
372 }
373 else
374 {
375 _asciiString->setByte(2, eventSubsystem);
376 }
377 }
378
Matt Spinler5a90a952020-08-27 09:39:03 -0500379 addCallouts(regEntry, additionalData, jsonCallouts, dataIface);
Matt Spinlerbd716f02019-10-15 10:54:11 -0500380
381 _size = baseSRCSize;
382 _size += _callouts ? _callouts->flattenedSize() : 0;
383 _header.size = Section::flattenedSize() + _size;
384
385 _valid = true;
386}
387
388void SRC::setUserDefinedHexWords(const message::Entry& regEntry,
389 const AdditionalData& ad)
390{
391 if (!regEntry.src.hexwordADFields)
392 {
393 return;
394 }
395
Harisuddin Mohamed Isa1a1b0df2020-11-23 16:34:36 +0800396 // Save the AdditionalData value corresponding to the first element of
397 // adName tuple into _hexData[wordNum].
Matt Spinlerbd716f02019-10-15 10:54:11 -0500398 for (const auto& [wordNum, adName] : *regEntry.src.hexwordADFields)
399 {
400 // Can only set words 6 - 9
401 if (!isUserDefinedWord(wordNum))
402 {
Matt Spinler85f61a62020-06-03 16:28:55 -0500403 std::string msg =
404 "SRC user data word out of range: " + std::to_string(wordNum);
405 addDebugData(msg);
Matt Spinlerbd716f02019-10-15 10:54:11 -0500406 continue;
407 }
408
Harisuddin Mohamed Isa1a1b0df2020-11-23 16:34:36 +0800409 auto value = ad.getValue(std::get<0>(adName));
Matt Spinlerbd716f02019-10-15 10:54:11 -0500410 if (value)
411 {
412 _hexData[getWordIndexFromWordNum(wordNum)] =
413 std::strtoul(value.value().c_str(), nullptr, 0);
414 }
415 else
416 {
Harisuddin Mohamed Isa1a1b0df2020-11-23 16:34:36 +0800417 std::string msg = "Source for user data SRC word not found: " +
418 std::get<0>(adName);
Matt Spinler85f61a62020-06-03 16:28:55 -0500419 addDebugData(msg);
Matt Spinlerbd716f02019-10-15 10:54:11 -0500420 }
421 }
422}
423
Matt Spinler075e5ba2020-02-21 15:46:00 -0600424void SRC::setMotherboardCCIN(const DataInterfaceBase& dataIface)
425{
426 uint32_t ccin = 0;
427 auto ccinString = dataIface.getMotherboardCCIN();
428
429 try
430 {
431 if (ccinString.size() == ccinSize)
432 {
433 ccin = std::stoi(ccinString, 0, 16);
434 }
435 }
Patrick Williams66491c62021-10-06 12:23:37 -0500436 catch (const std::exception& e)
Matt Spinler075e5ba2020-02-21 15:46:00 -0600437 {
438 log<level::WARNING>("Could not convert motherboard CCIN to a number",
439 entry("CCIN=%s", ccinString.c_str()));
440 return;
441 }
442
443 // Set the first 2 bytes
444 _hexData[1] |= ccin << 16;
445}
446
Matt Spinlerf9bae182019-10-09 13:37:38 -0500447void SRC::validate()
448{
449 bool failed = false;
450
451 if ((header().id != static_cast<uint16_t>(SectionID::primarySRC)) &&
452 (header().id != static_cast<uint16_t>(SectionID::secondarySRC)))
453 {
454 log<level::ERR>("Invalid SRC section ID",
455 entry("ID=0x%X", header().id));
456 failed = true;
457 }
458
459 // Check the version in the SRC, not in the header
Matt Spinlerbd716f02019-10-15 10:54:11 -0500460 if (_version != srcVersion)
Matt Spinlerf9bae182019-10-09 13:37:38 -0500461 {
Matt Spinlerbd716f02019-10-15 10:54:11 -0500462 log<level::ERR>("Invalid SRC version", entry("VERSION=0x%X", _version));
Matt Spinlerf9bae182019-10-09 13:37:38 -0500463 failed = true;
464 }
465
466 _valid = failed ? false : true;
467}
468
Matt Spinler075e5ba2020-02-21 15:46:00 -0600469bool SRC::isBMCSRC() const
470{
471 auto as = asciiString();
472 if (as.length() >= 2)
473 {
474 uint8_t errorType = strtoul(as.substr(0, 2).c_str(), nullptr, 16);
475 return (errorType == static_cast<uint8_t>(SRCType::bmcError) ||
476 errorType == static_cast<uint8_t>(SRCType::powerError));
477 }
478 return false;
479}
480
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800481std::optional<std::string> SRC::getErrorDetails(message::Registry& registry,
482 DetailLevel type,
483 bool toCache) const
484{
485 const std::string jsonIndent(indentLevel, 0x20);
486 std::string errorOut;
Matt Spinler075e5ba2020-02-21 15:46:00 -0600487 if (isBMCSRC())
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800488 {
489 auto entry = registry.lookup("0x" + asciiString().substr(4, 4),
490 rg::LookupType::reasonCode, toCache);
491 if (entry)
492 {
493 errorOut.append(jsonIndent + "\"Error Details\": {\n");
494 auto errorMsg = getErrorMessage(*entry);
495 if (errorMsg)
496 {
497 if (type == DetailLevel::message)
498 {
499 return errorMsg.value();
500 }
501 else
502 {
503 jsonInsert(errorOut, "Message", errorMsg.value(), 2);
504 }
505 }
506 if (entry->src.hexwordADFields)
507 {
Harisuddin Mohamed Isa1a1b0df2020-11-23 16:34:36 +0800508 std::map<size_t, std::tuple<std::string, std::string>>
509 adFields = entry->src.hexwordADFields.value();
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800510 for (const auto& hexwordMap : adFields)
511 {
Zane Shelleye8db29b2021-11-13 10:34:07 -0600512 auto srcValue = getNumberString(
Harisuddin Mohamed Isa1a1b0df2020-11-23 16:34:36 +0800513 "0x%X",
Zane Shelleye8db29b2021-11-13 10:34:07 -0600514 _hexData[getWordIndexFromWordNum(hexwordMap.first)]);
515
516 auto srcKey = std::get<0>(hexwordMap.second);
517 auto srcDesc = std::get<1>(hexwordMap.second);
518
519 // Only include this hex word in the error details if the
520 // description exists.
521 if (!srcDesc.empty())
522 {
523 std::vector<std::string> valueDescr;
524 valueDescr.push_back(srcValue);
525 valueDescr.push_back(srcDesc);
526 jsonInsertArray(errorOut, srcKey, valueDescr, 2);
527 }
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800528 }
529 }
530 errorOut.erase(errorOut.size() - 2);
531 errorOut.append("\n");
532 errorOut.append(jsonIndent + "},\n");
533 return errorOut;
534 }
535 }
536 return std::nullopt;
537}
538
539std::optional<std::string>
540 SRC::getErrorMessage(const message::Entry& regEntry) const
541{
542 try
543 {
544 if (regEntry.doc.messageArgSources)
545 {
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800546 std::vector<uint32_t> argSourceVals;
547 std::string message;
548 const auto& argValues = regEntry.doc.messageArgSources.value();
549 for (size_t i = 0; i < argValues.size(); ++i)
550 {
551 argSourceVals.push_back(_hexData[getWordIndexFromWordNum(
552 argValues[i].back() - '0')]);
553 }
Patrick Williams0230abb2021-04-19 14:32:50 -0500554
555 auto it = std::begin(regEntry.doc.message);
556 auto it_end = std::end(regEntry.doc.message);
557
558 while (it != it_end)
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800559 {
Patrick Williams0230abb2021-04-19 14:32:50 -0500560 if (*it == '%')
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800561 {
Patrick Williams0230abb2021-04-19 14:32:50 -0500562 ++it;
563
564 size_t wordIndex = *it - '0';
565 if (isdigit(*it) && wordIndex >= 1 &&
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800566 static_cast<uint16_t>(wordIndex) <=
567 argSourceVals.size())
568 {
569 message.append(getNumberString(
Zane Shelley39936e32021-11-13 16:19:34 -0600570 "0x%08X", argSourceVals[wordIndex - 1]));
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800571 }
572 else
573 {
Patrick Williams0230abb2021-04-19 14:32:50 -0500574 message.append("%" + std::string(1, *it));
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800575 }
576 }
577 else
578 {
Patrick Williams0230abb2021-04-19 14:32:50 -0500579 message.push_back(*it);
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800580 }
Patrick Williams0230abb2021-04-19 14:32:50 -0500581 ++it;
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800582 }
Patrick Williams0230abb2021-04-19 14:32:50 -0500583
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800584 return message;
585 }
586 else
587 {
588 return regEntry.doc.message;
589 }
590 }
591 catch (const std::exception& e)
592 {
593 log<level::ERR>("Cannot get error message from registry entry",
594 entry("ERROR=%s", e.what()));
595 }
596 return std::nullopt;
597}
598
599std::optional<std::string> SRC::getCallouts() const
600{
601 if (!_callouts)
602 {
603 return std::nullopt;
604 }
605 std::string printOut;
606 const std::string jsonIndent(indentLevel, 0x20);
607 const auto& callout = _callouts->callouts();
608 const auto& compDescrp = pv::failingComponentType;
609 printOut.append(jsonIndent + "\"Callout Section\": {\n");
610 jsonInsert(printOut, "Callout Count", std::to_string(callout.size()), 2);
611 printOut.append(jsonIndent + jsonIndent + "\"Callouts\": [");
612 for (auto& entry : callout)
613 {
614 printOut.append("{\n");
615 if (entry->fruIdentity())
616 {
617 jsonInsert(
618 printOut, "FRU Type",
619 compDescrp.at(entry->fruIdentity()->failingComponentType()), 3);
620 jsonInsert(printOut, "Priority",
621 pv::getValue(entry->priority(),
622 pel_values::calloutPriorityValues),
623 3);
624 if (!entry->locationCode().empty())
625 {
626 jsonInsert(printOut, "Location Code", entry->locationCode(), 3);
627 }
628 if (entry->fruIdentity()->getPN().has_value())
629 {
630 jsonInsert(printOut, "Part Number",
631 entry->fruIdentity()->getPN().value(), 3);
632 }
633 if (entry->fruIdentity()->getMaintProc().has_value())
634 {
Matt Spinler9e8b49e2020-09-10 13:15:26 -0500635 jsonInsert(printOut, "Procedure",
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800636 entry->fruIdentity()->getMaintProc().value(), 3);
637 if (pv::procedureDesc.find(
638 entry->fruIdentity()->getMaintProc().value()) !=
639 pv::procedureDesc.end())
640 {
641 jsonInsert(
642 printOut, "Description",
643 pv::procedureDesc.at(
644 entry->fruIdentity()->getMaintProc().value()),
645 3);
646 }
647 }
648 if (entry->fruIdentity()->getCCIN().has_value())
649 {
650 jsonInsert(printOut, "CCIN",
651 entry->fruIdentity()->getCCIN().value(), 3);
652 }
653 if (entry->fruIdentity()->getSN().has_value())
654 {
655 jsonInsert(printOut, "Serial Number",
656 entry->fruIdentity()->getSN().value(), 3);
657 }
658 }
659 if (entry->pceIdentity())
660 {
661 const auto& pceIdentMtms = entry->pceIdentity()->mtms();
662 if (!pceIdentMtms.machineTypeAndModel().empty())
663 {
664 jsonInsert(printOut, "PCE MTMS",
665 pceIdentMtms.machineTypeAndModel() + "_" +
666 pceIdentMtms.machineSerialNumber(),
667 3);
668 }
669 if (!entry->pceIdentity()->enclosureName().empty())
670 {
671 jsonInsert(printOut, "PCE Name",
672 entry->pceIdentity()->enclosureName(), 3);
673 }
674 }
675 if (entry->mru())
676 {
677 const auto& mruCallouts = entry->mru()->mrus();
678 std::string mruId;
679 for (auto& element : mruCallouts)
680 {
681 if (!mruId.empty())
682 {
683 mruId.append(", " + getNumberString("%08X", element.id));
684 }
685 else
686 {
687 mruId.append(getNumberString("%08X", element.id));
688 }
689 }
690 jsonInsert(printOut, "MRU Id", mruId, 3);
691 }
692 printOut.erase(printOut.size() - 2);
693 printOut.append("\n" + jsonIndent + jsonIndent + "}, ");
694 };
695 printOut.erase(printOut.size() - 2);
696 printOut.append("]\n" + jsonIndent + "}");
697 return printOut;
698}
699
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800700std::optional<std::string> SRC::getJSON(message::Registry& registry,
Patrick Williamsd26fa3e2021-04-21 15:22:23 -0500701 const std::vector<std::string>& plugins
702 [[maybe_unused]],
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800703 uint8_t creatorID) const
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800704{
705 std::string ps;
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800706 std::vector<std::string> hexwords;
Harisuddin Mohamed Isabebeb942020-03-12 17:12:24 +0800707 jsonInsert(ps, pv::sectionVer, getNumberString("%d", _header.version), 1);
708 jsonInsert(ps, pv::subSection, getNumberString("%d", _header.subType), 1);
709 jsonInsert(ps, pv::createdBy, getNumberString("0x%X", _header.componentID),
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800710 1);
711 jsonInsert(ps, "SRC Version", getNumberString("0x%02X", _version), 1);
Harisuddin Mohamed Isac32e5512020-02-06 18:05:21 +0800712 jsonInsert(ps, "SRC Format", getNumberString("0x%02X", _hexData[0] & 0xFF),
713 1);
714 jsonInsert(ps, "Virtual Progress SRC",
715 pv::boolString.at(_flags & virtualProgressSRC), 1);
716 jsonInsert(ps, "I5/OS Service Event Bit",
717 pv::boolString.at(_flags & i5OSServiceEventBit), 1);
718 jsonInsert(ps, "Hypervisor Dump Initiated",
719 pv::boolString.at(_flags & hypDumpInit), 1);
Matt Spinler075e5ba2020-02-21 15:46:00 -0600720
721 if (isBMCSRC())
722 {
723 std::string ccinString;
724 uint32_t ccin = _hexData[1] >> 16;
725
726 if (ccin)
727 {
728 ccinString = getNumberString("%04X", ccin);
729 }
730 // The PEL spec calls it a backplane, so call it that here.
731 jsonInsert(ps, "Backplane CCIN", ccinString, 1);
Matt Spinlerafa2c792020-08-27 11:01:39 -0500732
Sumit Kumar3e274432021-09-14 06:37:56 -0500733 jsonInsert(ps, "Terminate FW Error",
734 pv::boolString.at(
735 _hexData[3] &
736 static_cast<uint32_t>(ErrorStatusFlags::terminateFwErr)),
737 1);
Matt Spinlerafa2c792020-08-27 11:01:39 -0500738 jsonInsert(ps, "Deconfigured",
739 pv::boolString.at(
740 _hexData[3] &
741 static_cast<uint32_t>(ErrorStatusFlags::deconfigured)),
742 1);
743
744 jsonInsert(
745 ps, "Guarded",
746 pv::boolString.at(_hexData[3] &
747 static_cast<uint32_t>(ErrorStatusFlags::guarded)),
748 1);
Matt Spinler075e5ba2020-02-21 15:46:00 -0600749 }
750
Harisuddin Mohamed Isaa214ed32020-02-28 15:58:23 +0800751 auto errorDetails = getErrorDetails(registry, DetailLevel::json, true);
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800752 if (errorDetails)
753 {
754 ps.append(errorDetails.value());
755 }
756 jsonInsert(ps, "Valid Word Count", getNumberString("0x%02X", _wordCount),
757 1);
758 std::string refcode = asciiString();
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800759 hexwords.push_back(refcode);
Harisuddin Mohamed Isafecaa572020-03-11 16:04:50 +0800760 std::string extRefcode;
761 size_t pos = refcode.find(0x20);
762 if (pos != std::string::npos)
763 {
764 size_t nextPos = refcode.find_first_not_of(0x20, pos);
765 if (nextPos != std::string::npos)
766 {
767 extRefcode = trimEnd(refcode.substr(nextPos));
768 }
769 refcode.erase(pos);
770 }
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800771 jsonInsert(ps, "Reference Code", refcode, 1);
Harisuddin Mohamed Isafecaa572020-03-11 16:04:50 +0800772 if (!extRefcode.empty())
773 {
774 jsonInsert(ps, "Extended Reference Code", extRefcode, 1);
775 }
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800776 for (size_t i = 2; i <= _wordCount; i++)
777 {
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800778 std::string tmpWord =
779 getNumberString("%08X", _hexData[getWordIndexFromWordNum(i)]);
780 jsonInsert(ps, "Hex Word " + std::to_string(i), tmpWord, 1);
781 hexwords.push_back(tmpWord);
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800782 }
783 auto calloutJson = getCallouts();
784 if (calloutJson)
785 {
786 ps.append(calloutJson.value());
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800787 ps.append(",\n");
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800788 }
Harisuddin Mohamed Isac8d6cc62020-08-19 22:47:19 +0800789 std::string subsystem = getNumberString("%c", tolower(creatorID));
790 bool srcDetailExists = false;
791#ifdef PELTOOL
792 if (std::find(plugins.begin(), plugins.end(), subsystem + "src") !=
793 plugins.end())
794 {
795 auto pyJson = getPythonJSON(hexwords, creatorID);
796 if (pyJson)
797 {
798 ps.append(pyJson.value());
799 srcDetailExists = true;
800 }
801 }
802#endif
803 if (!srcDetailExists)
Harisuddin Mohamed Isa0f717e12020-01-15 20:05:33 +0800804 {
805 ps.erase(ps.size() - 2);
806 }
807 return ps;
808}
809
Matt Spinler03984582020-04-09 13:17:58 -0500810void SRC::addCallouts(const message::Entry& regEntry,
811 const AdditionalData& additionalData,
Matt Spinler5a90a952020-08-27 09:39:03 -0500812 const nlohmann::json& jsonCallouts,
Matt Spinlered046852020-03-13 13:58:15 -0500813 const DataInterfaceBase& dataIface)
814{
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500815 auto registryCallouts =
816 getRegistryCallouts(regEntry, additionalData, dataIface);
817
Matt Spinlered046852020-03-13 13:58:15 -0500818 auto item = additionalData.getValue("CALLOUT_INVENTORY_PATH");
Miguel Gomez53ef1552020-10-14 21:16:32 +0000819 auto priority = additionalData.getValue("CALLOUT_PRIORITY");
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500820
Miguel Gomez53ef1552020-10-14 21:16:32 +0000821 std::optional<CalloutPriority> calloutPriority;
822
823 // Only H, M or L priority values.
824 if (priority && !(*priority).empty())
825 {
826 uint8_t p = (*priority)[0];
827 if (p == 'H' || p == 'M' || p == 'L')
828 {
829 calloutPriority = static_cast<CalloutPriority>(p);
830 }
831 }
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500832 // If the first registry callout says to use the passed in inventory
833 // path to get the location code for a symbolic FRU callout with a
834 // trusted location code, then do not add the inventory path as a
835 // normal FRU callout.
836 bool useInvForSymbolicFRULocCode =
837 !registryCallouts.empty() && registryCallouts[0].useInventoryLocCode &&
838 !registryCallouts[0].symbolicFRUTrusted.empty();
839
840 if (item && !useInvForSymbolicFRULocCode)
Matt Spinlered046852020-03-13 13:58:15 -0500841 {
Miguel Gomez53ef1552020-10-14 21:16:32 +0000842 addInventoryCallout(*item, calloutPriority, std::nullopt, dataIface);
Matt Spinlered046852020-03-13 13:58:15 -0500843 }
844
Matt Spinler717de422020-06-04 13:10:14 -0500845 addDevicePathCallouts(additionalData, dataIface);
Matt Spinler03984582020-04-09 13:17:58 -0500846
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500847 addRegistryCallouts(registryCallouts, dataIface,
848 (useInvForSymbolicFRULocCode) ? item : std::nullopt);
Matt Spinler5a90a952020-08-27 09:39:03 -0500849
850 if (!jsonCallouts.empty())
851 {
852 addJSONCallouts(jsonCallouts, dataIface);
853 }
Matt Spinlered046852020-03-13 13:58:15 -0500854}
855
856void SRC::addInventoryCallout(const std::string& inventoryPath,
Matt Spinleraf191c72020-06-04 11:35:13 -0500857 const std::optional<CalloutPriority>& priority,
858 const std::optional<std::string>& locationCode,
Matt Spinlerb8cb60f2020-08-27 10:55:55 -0500859 const DataInterfaceBase& dataIface,
860 const std::vector<src::MRU::MRUCallout>& mrus)
Matt Spinlered046852020-03-13 13:58:15 -0500861{
862 std::string locCode;
863 std::string fn;
864 std::string ccin;
865 std::string sn;
866 std::unique_ptr<src::Callout> callout;
867
Matt Spinlered046852020-03-13 13:58:15 -0500868 try
869 {
Matt Spinleraf191c72020-06-04 11:35:13 -0500870 // Use the passed in location code if there otherwise look it up
871 if (locationCode)
872 {
873 locCode = *locationCode;
874 }
875 else
876 {
877 locCode = dataIface.getLocationCode(inventoryPath);
878 }
Matt Spinlered046852020-03-13 13:58:15 -0500879
Matt Spinler9b90e2a2020-04-14 10:59:04 -0500880 try
881 {
882 dataIface.getHWCalloutFields(inventoryPath, fn, ccin, sn);
883
Matt Spinleraf191c72020-06-04 11:35:13 -0500884 CalloutPriority p =
885 priority ? priority.value() : CalloutPriority::high;
886
Matt Spinlerb8cb60f2020-08-27 10:55:55 -0500887 callout =
888 std::make_unique<src::Callout>(p, locCode, fn, ccin, sn, mrus);
Matt Spinler9b90e2a2020-04-14 10:59:04 -0500889 }
Patrick Williamse99a4fd2021-09-02 09:44:53 -0500890 catch (const sdbusplus::exception::exception& e)
Matt Spinler9b90e2a2020-04-14 10:59:04 -0500891 {
Matt Spinler85f61a62020-06-03 16:28:55 -0500892 std::string msg =
893 "No VPD found for " + inventoryPath + ": " + e.what();
894 addDebugData(msg);
Matt Spinler9b90e2a2020-04-14 10:59:04 -0500895
896 // Just create the callout with empty FRU fields
Matt Spinlerb8cb60f2020-08-27 10:55:55 -0500897 callout = std::make_unique<src::Callout>(
898 CalloutPriority::high, locCode, fn, ccin, sn, mrus);
Matt Spinler9b90e2a2020-04-14 10:59:04 -0500899 }
Matt Spinlered046852020-03-13 13:58:15 -0500900 }
Patrick Williamse99a4fd2021-09-02 09:44:53 -0500901 catch (const sdbusplus::exception::exception& e)
Matt Spinlered046852020-03-13 13:58:15 -0500902 {
Matt Spinler85f61a62020-06-03 16:28:55 -0500903 std::string msg = "Could not get location code for " + inventoryPath +
904 ": " + e.what();
905 addDebugData(msg);
Matt Spinlered046852020-03-13 13:58:15 -0500906
Matt Spinler479b6922021-08-17 16:34:59 -0500907 // Don't add a callout in this case, because:
908 // 1) With how the inventory is primed, there is no case where
909 // a location code is expected to be missing. This implies
910 // the caller is passing in something invalid.
911 // 2) The addDebugData call above will put the passed in path into
912 // a user data section that can be seen by development for debug.
913 // 3) Even if we wanted to do a 'no_vpd_for_fru' sort of maint.
914 // procedure, we don't have a good way to indicate to the user
915 // anything about the intended callout (they won't see user data).
916 // 4) Creating a new standalone event log for this problem isn't
917 // possible from inside a PEL section.
Matt Spinlered046852020-03-13 13:58:15 -0500918 }
919
Matt Spinler479b6922021-08-17 16:34:59 -0500920 if (callout)
921 {
922 createCalloutsObject();
923 _callouts->addCallout(std::move(callout));
924 }
Matt Spinler03984582020-04-09 13:17:58 -0500925}
Matt Spinlered046852020-03-13 13:58:15 -0500926
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500927std::vector<message::RegistryCallout>
928 SRC::getRegistryCallouts(const message::Entry& regEntry,
929 const AdditionalData& additionalData,
930 const DataInterfaceBase& dataIface)
931{
932 std::vector<message::RegistryCallout> registryCallouts;
933
934 if (regEntry.callouts)
935 {
Matt Spinler9a50c8d2021-04-12 14:22:26 -0500936 std::vector<std::string> systemNames;
937
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500938 try
939 {
Matt Spinler9a50c8d2021-04-12 14:22:26 -0500940 systemNames = dataIface.getSystemNames();
941 }
942 catch (const std::exception& e)
943 {
944 // Compatible interface not available yet
945 }
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500946
Matt Spinler9a50c8d2021-04-12 14:22:26 -0500947 try
948 {
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500949 registryCallouts = message::Registry::getCallouts(
950 regEntry.callouts.value(), systemNames, additionalData);
951 }
952 catch (const std::exception& e)
953 {
954 addDebugData(fmt::format(
955 "Error parsing PEL message registry callout JSON: {}",
956 e.what()));
957 }
958 }
959
960 return registryCallouts;
961}
962
963void SRC::addRegistryCallouts(
964 const std::vector<message::RegistryCallout>& callouts,
965 const DataInterfaceBase& dataIface,
966 std::optional<std::string> trustedSymbolicFRUInvPath)
Matt Spinler03984582020-04-09 13:17:58 -0500967{
968 try
969 {
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500970 for (const auto& callout : callouts)
Matt Spinler03984582020-04-09 13:17:58 -0500971 {
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500972 addRegistryCallout(callout, dataIface, trustedSymbolicFRUInvPath);
973
974 // Only the first callout gets the inventory path
975 if (trustedSymbolicFRUInvPath)
976 {
977 trustedSymbolicFRUInvPath = std::nullopt;
978 }
Matt Spinler03984582020-04-09 13:17:58 -0500979 }
980 }
Patrick Williams66491c62021-10-06 12:23:37 -0500981 catch (const std::exception& e)
Matt Spinler03984582020-04-09 13:17:58 -0500982 {
Matt Spinler85f61a62020-06-03 16:28:55 -0500983 std::string msg =
984 "Error parsing PEL message registry callout JSON: "s + e.what();
985 addDebugData(msg);
Matt Spinler03984582020-04-09 13:17:58 -0500986 }
987}
988
Matt Spinlerf00f9d02020-10-23 09:14:22 -0500989void SRC::addRegistryCallout(
990 const message::RegistryCallout& regCallout,
991 const DataInterfaceBase& dataIface,
992 const std::optional<std::string>& trustedSymbolicFRUInvPath)
Matt Spinler03984582020-04-09 13:17:58 -0500993{
994 std::unique_ptr<src::Callout> callout;
Matt Spinler03984582020-04-09 13:17:58 -0500995 auto locCode = regCallout.locCode;
996
Matt Spinleraf191c72020-06-04 11:35:13 -0500997 if (!locCode.empty())
998 {
999 try
1000 {
1001 locCode = dataIface.expandLocationCode(locCode, 0);
1002 }
1003 catch (const std::exception& e)
1004 {
1005 auto msg =
1006 "Unable to expand location code " + locCode + ": " + e.what();
1007 addDebugData(msg);
1008 return;
1009 }
1010 }
1011
Matt Spinler03984582020-04-09 13:17:58 -05001012 // Via the PEL values table, get the priority enum.
1013 // The schema will have validated the priority was a valid value.
1014 auto priorityIt =
1015 pv::findByName(regCallout.priority, pv::calloutPriorityValues);
1016 assert(priorityIt != pv::calloutPriorityValues.end());
1017 auto priority =
1018 static_cast<CalloutPriority>(std::get<pv::fieldValuePos>(*priorityIt));
1019
1020 if (!regCallout.procedure.empty())
1021 {
1022 // Procedure callout
1023 callout =
1024 std::make_unique<src::Callout>(priority, regCallout.procedure);
1025 }
1026 else if (!regCallout.symbolicFRU.empty())
1027 {
1028 // Symbolic FRU callout
1029 callout = std::make_unique<src::Callout>(
1030 priority, regCallout.symbolicFRU, locCode, false);
1031 }
1032 else if (!regCallout.symbolicFRUTrusted.empty())
1033 {
1034 // Symbolic FRU with trusted location code callout
1035
Matt Spinlerf00f9d02020-10-23 09:14:22 -05001036 // Use the location code from the inventory path if there is one.
1037 if (trustedSymbolicFRUInvPath)
1038 {
1039 try
1040 {
1041 locCode = dataIface.getLocationCode(*trustedSymbolicFRUInvPath);
1042 }
1043 catch (const std::exception& e)
1044 {
1045 addDebugData(
1046 fmt::format("Could not get location code for {}: {}",
1047 *trustedSymbolicFRUInvPath, e.what()));
1048 locCode.clear();
1049 }
1050 }
1051
Matt Spinler03984582020-04-09 13:17:58 -05001052 // The registry wants it to be trusted, but that requires a valid
1053 // location code for it to actually be.
1054 callout = std::make_unique<src::Callout>(
1055 priority, regCallout.symbolicFRUTrusted, locCode, !locCode.empty());
1056 }
1057 else
1058 {
Matt Spinleraf191c72020-06-04 11:35:13 -05001059 // A hardware callout
1060 std::string inventoryPath;
1061
1062 try
1063 {
1064 // Get the inventory item from the unexpanded location code
1065 inventoryPath =
Matt Spinler2f9225a2020-08-05 12:58:49 -05001066 dataIface.getInventoryFromLocCode(regCallout.locCode, 0, false);
Matt Spinleraf191c72020-06-04 11:35:13 -05001067 }
1068 catch (const std::exception& e)
1069 {
1070 std::string msg =
1071 "Unable to get inventory path from location code: " + locCode +
1072 ": " + e.what();
1073 addDebugData(msg);
1074 return;
1075 }
1076
1077 addInventoryCallout(inventoryPath, priority, locCode, dataIface);
Matt Spinler03984582020-04-09 13:17:58 -05001078 }
1079
1080 if (callout)
1081 {
1082 createCalloutsObject();
1083 _callouts->addCallout(std::move(callout));
1084 }
1085}
Matt Spinlered046852020-03-13 13:58:15 -05001086
Matt Spinler717de422020-06-04 13:10:14 -05001087void SRC::addDevicePathCallouts(const AdditionalData& additionalData,
1088 const DataInterfaceBase& dataIface)
1089{
1090 std::vector<device_callouts::Callout> callouts;
1091 auto i2cBus = additionalData.getValue("CALLOUT_IIC_BUS");
1092 auto i2cAddr = additionalData.getValue("CALLOUT_IIC_ADDR");
1093 auto devPath = additionalData.getValue("CALLOUT_DEVICE_PATH");
1094
1095 // A device callout contains either:
1096 // * CALLOUT_ERRNO, CALLOUT_DEVICE_PATH
1097 // * CALLOUT_ERRNO, CALLOUT_IIC_BUS, CALLOUT_IIC_ADDR
1098 // We don't care about the errno.
1099
1100 if (devPath)
1101 {
1102 try
1103 {
1104 callouts = device_callouts::getCallouts(*devPath,
1105 dataIface.getSystemNames());
1106 }
1107 catch (const std::exception& e)
1108 {
1109 addDebugData(e.what());
1110 callouts.clear();
1111 }
1112 }
1113 else if (i2cBus && i2cAddr)
1114 {
1115 size_t bus;
1116 uint8_t address;
1117
1118 try
1119 {
1120 // If /dev/i2c- is prepended, remove it
1121 if (i2cBus->find("/dev/i2c-") != std::string::npos)
1122 {
1123 *i2cBus = i2cBus->substr(9);
1124 }
1125
1126 bus = stoul(*i2cBus, nullptr, 0);
1127 address = stoul(*i2cAddr, nullptr, 0);
1128 }
1129 catch (const std::exception& e)
1130 {
1131 std::string msg = "Invalid CALLOUT_IIC_BUS " + *i2cBus +
1132 " or CALLOUT_IIC_ADDR " + *i2cAddr +
1133 " in AdditionalData property";
1134 addDebugData(msg);
1135 return;
1136 }
1137
1138 try
1139 {
1140 callouts = device_callouts::getI2CCallouts(
1141 bus, address, dataIface.getSystemNames());
1142 }
1143 catch (const std::exception& e)
1144 {
1145 addDebugData(e.what());
1146 callouts.clear();
1147 }
1148 }
1149
1150 for (const auto& callout : callouts)
1151 {
1152 // The priority shouldn't be invalid, but check just in case.
1153 CalloutPriority priority = CalloutPriority::high;
1154
1155 if (!callout.priority.empty())
1156 {
1157 auto p = pel_values::findByValue(
1158 static_cast<uint32_t>(callout.priority[0]),
1159 pel_values::calloutPriorityValues);
1160
1161 if (p != pel_values::calloutPriorityValues.end())
1162 {
1163 priority = static_cast<CalloutPriority>(callout.priority[0]);
1164 }
1165 else
1166 {
1167 std::string msg =
1168 "Invalid priority found in dev callout JSON: " +
1169 callout.priority[0];
1170 addDebugData(msg);
1171 }
1172 }
1173
Matt Spinler0d92b522021-06-16 13:28:17 -06001174 std::optional<std::string> locCode;
1175
1176 try
1177 {
1178 locCode = dataIface.expandLocationCode(callout.locationCode, 0);
1179 }
1180 catch (const std::exception& e)
1181 {
1182 auto msg = fmt::format("Unable to expand location code {}: {}",
1183 callout.locationCode, e.what());
1184 addDebugData(msg);
1185 }
1186
Matt Spinler717de422020-06-04 13:10:14 -05001187 try
1188 {
Matt Spinler2f9225a2020-08-05 12:58:49 -05001189 auto inventoryPath = dataIface.getInventoryFromLocCode(
1190 callout.locationCode, 0, false);
Matt Spinler717de422020-06-04 13:10:14 -05001191
Matt Spinler0d92b522021-06-16 13:28:17 -06001192 addInventoryCallout(inventoryPath, priority, locCode, dataIface);
Matt Spinler717de422020-06-04 13:10:14 -05001193 }
1194 catch (const std::exception& e)
1195 {
1196 std::string msg =
1197 "Unable to get inventory path from location code: " +
1198 callout.locationCode + ": " + e.what();
1199 addDebugData(msg);
1200 }
1201
1202 // Until the code is there to convert these MRU value strings to
1203 // the official MRU values in the callout objects, just store
1204 // the MRU name in the debug UserData section.
1205 if (!callout.mru.empty())
1206 {
1207 std::string msg = "MRU: " + callout.mru;
1208 addDebugData(msg);
1209 }
1210
1211 // getCallouts() may have generated some debug data it stored
1212 // in a callout object. Save it as well.
1213 if (!callout.debug.empty())
1214 {
1215 addDebugData(callout.debug);
1216 }
1217 }
1218}
1219
Matt Spinler5a90a952020-08-27 09:39:03 -05001220void SRC::addJSONCallouts(const nlohmann::json& jsonCallouts,
1221 const DataInterfaceBase& dataIface)
1222{
1223 if (jsonCallouts.empty())
1224 {
1225 return;
1226 }
1227
1228 if (!jsonCallouts.is_array())
1229 {
1230 addDebugData("Callout JSON isn't an array");
1231 return;
1232 }
1233
1234 for (const auto& callout : jsonCallouts)
1235 {
1236 try
1237 {
1238 addJSONCallout(callout, dataIface);
1239 }
1240 catch (const std::exception& e)
1241 {
1242 addDebugData(fmt::format(
1243 "Failed extracting callout data from JSON: {}", e.what()));
1244 }
1245 }
1246}
1247
1248void SRC::addJSONCallout(const nlohmann::json& jsonCallout,
1249 const DataInterfaceBase& dataIface)
1250{
Matt Spinler3bdd0112020-08-27 10:24:34 -05001251 auto priority = getPriorityFromJSON(jsonCallout);
1252 std::string locCode;
1253 std::string unexpandedLocCode;
1254 std::unique_ptr<src::Callout> callout;
1255
1256 // Expand the location code if it's there
1257 if (jsonCallout.contains("LocationCode"))
1258 {
1259 unexpandedLocCode = jsonCallout.at("LocationCode").get<std::string>();
1260
1261 try
1262 {
1263 locCode = dataIface.expandLocationCode(unexpandedLocCode, 0);
1264 }
1265 catch (const std::exception& e)
1266 {
1267 addDebugData(fmt::format("Unable to expand location code {}: {}",
1268 unexpandedLocCode, e.what()));
1269 // Use the value from the JSON so at least there's something
1270 locCode = unexpandedLocCode;
1271 }
1272 }
1273
1274 // Create either a procedure, symbolic FRU, or normal FRU callout.
1275 if (jsonCallout.contains("Procedure"))
1276 {
1277 auto procedure = jsonCallout.at("Procedure").get<std::string>();
1278
1279 callout = std::make_unique<src::Callout>(
1280 static_cast<CalloutPriority>(priority), procedure,
1281 src::CalloutValueType::raw);
1282 }
1283 else if (jsonCallout.contains("SymbolicFRU"))
1284 {
1285 auto fru = jsonCallout.at("SymbolicFRU").get<std::string>();
1286
1287 bool trusted = false;
1288 if (jsonCallout.contains("TrustedLocationCode") && !locCode.empty())
1289 {
1290 trusted = jsonCallout.at("TrustedLocationCode").get<bool>();
1291 }
1292
1293 callout = std::make_unique<src::Callout>(
1294 static_cast<CalloutPriority>(priority), fru,
1295 src::CalloutValueType::raw, locCode, trusted);
1296 }
1297 else
1298 {
1299 // A hardware FRU
1300 std::string inventoryPath;
Matt Spinlerb8cb60f2020-08-27 10:55:55 -05001301 std::vector<src::MRU::MRUCallout> mrus;
Matt Spinler3bdd0112020-08-27 10:24:34 -05001302
1303 if (jsonCallout.contains("InventoryPath"))
1304 {
1305 inventoryPath = jsonCallout.at("InventoryPath").get<std::string>();
1306 }
1307 else
1308 {
1309 if (unexpandedLocCode.empty())
1310 {
1311 throw std::runtime_error{"JSON callout needs either an "
1312 "inventory path or location code"};
1313 }
1314
1315 try
1316 {
1317 inventoryPath = dataIface.getInventoryFromLocCode(
1318 unexpandedLocCode, 0, false);
1319 }
1320 catch (const std::exception& e)
1321 {
1322 throw std::runtime_error{
1323 fmt::format("Unable to get inventory path from "
1324 "location code: {}: {}",
1325 unexpandedLocCode, e.what())};
1326 }
1327 }
1328
Matt Spinlerb8cb60f2020-08-27 10:55:55 -05001329 if (jsonCallout.contains("MRUs"))
1330 {
1331 mrus = getMRUsFromJSON(jsonCallout.at("MRUs"));
1332 }
1333
Matt Spinler3bdd0112020-08-27 10:24:34 -05001334 // If the location code was also passed in, use that here too
1335 // so addInventoryCallout doesn't have to look it up.
1336 std::optional<std::string> lc;
1337 if (!locCode.empty())
1338 {
1339 lc = locCode;
1340 }
1341
Matt Spinlerb8cb60f2020-08-27 10:55:55 -05001342 addInventoryCallout(inventoryPath, priority, lc, dataIface, mrus);
Matt Spinlerafa2c792020-08-27 11:01:39 -05001343
1344 if (jsonCallout.contains("Deconfigured"))
1345 {
1346 if (jsonCallout.at("Deconfigured").get<bool>())
1347 {
1348 setErrorStatusFlag(ErrorStatusFlags::deconfigured);
1349 }
1350 }
1351
1352 if (jsonCallout.contains("Guarded"))
1353 {
1354 if (jsonCallout.at("Guarded").get<bool>())
1355 {
1356 setErrorStatusFlag(ErrorStatusFlags::guarded);
1357 }
1358 }
Matt Spinler3bdd0112020-08-27 10:24:34 -05001359 }
1360
1361 if (callout)
1362 {
1363 createCalloutsObject();
1364 _callouts->addCallout(std::move(callout));
1365 }
1366}
1367
1368CalloutPriority SRC::getPriorityFromJSON(const nlohmann::json& json)
1369{
1370 // Looks like:
1371 // {
1372 // "Priority": "H"
1373 // }
1374 auto p = json.at("Priority").get<std::string>();
1375 if (p.empty())
1376 {
1377 throw std::runtime_error{"Priority field in callout is empty"};
1378 }
1379
1380 auto priority = static_cast<CalloutPriority>(p.front());
1381
1382 // Validate it
1383 auto priorityIt = pv::findByValue(static_cast<uint32_t>(priority),
1384 pv::calloutPriorityValues);
1385 if (priorityIt == pv::calloutPriorityValues.end())
1386 {
1387 throw std::runtime_error{
1388 fmt::format("Invalid priority '{}' found in JSON callout", p)};
1389 }
1390
1391 return priority;
Matt Spinler5a90a952020-08-27 09:39:03 -05001392}
1393
Matt Spinlerb8cb60f2020-08-27 10:55:55 -05001394std::vector<src::MRU::MRUCallout>
1395 SRC::getMRUsFromJSON(const nlohmann::json& mruJSON)
1396{
1397 std::vector<src::MRU::MRUCallout> mrus;
1398
1399 // Looks like:
1400 // [
1401 // {
1402 // "ID": 100,
1403 // "Priority": "H"
1404 // }
1405 // ]
1406 if (!mruJSON.is_array())
1407 {
1408 addDebugData("MRU callout JSON is not an array");
1409 return mrus;
1410 }
1411
1412 for (const auto& mruCallout : mruJSON)
1413 {
1414 try
1415 {
1416 auto priority = getPriorityFromJSON(mruCallout);
1417 auto id = mruCallout.at("ID").get<uint32_t>();
1418
1419 src::MRU::MRUCallout mru{static_cast<uint32_t>(priority), id};
1420 mrus.push_back(std::move(mru));
1421 }
1422 catch (const std::exception& e)
1423 {
1424 addDebugData(fmt::format("Invalid MRU entry in JSON: {}: {}",
1425 mruCallout.dump(), e.what()));
1426 }
1427 }
1428
1429 return mrus;
1430}
1431
Sumit Kumar9d43a722021-08-24 09:46:19 -05001432void SRC::setDumpStatus(const DataInterfaceBase& dataIface)
1433{
1434 std::vector<bool> dumpStatus{false, false, false};
1435
1436 try
1437 {
1438 std::vector<std::string> dumpType = {"bmc/entry", "resource/entry",
1439 "system/entry"};
1440 dumpStatus = dataIface.checkDumpStatus(dumpType);
1441
1442 // For bmc - set bit 0 of nibble [4-7] bits of byte-1 SP dump
1443 // For resource - set bit 2 of nibble [4-7] bits of byte-2 Hypervisor
1444 // For system - set bit 1 of nibble [4-7] bits of byte-2 HW dump
1445 _hexData[0] |= ((dumpStatus[0] << 19) | (dumpStatus[1] << 9) |
1446 (dumpStatus[2] << 10));
1447 }
1448 catch (const std::exception& e)
1449 {
Matt Spinler35a405b2022-03-02 11:42:42 -06001450 log<level::ERR>(
1451 fmt::format("Checking dump status failed: {}", e.what()).c_str());
Sumit Kumar9d43a722021-08-24 09:46:19 -05001452 }
1453}
1454
Sumit Kumar3e274432021-09-14 06:37:56 -05001455std::vector<uint8_t> SRC::getSrcStruct()
1456{
1457 std::vector<uint8_t> data;
1458 Stream stream{data};
1459
1460 //------ Ref section 4.3 in PEL doc---
1461 //------ SRC Structure 40 bytes-------
1462 // Byte-0 | Byte-1 | Byte-2 | Byte-3 |
1463 // -----------------------------------
1464 // 02 | 08 | 00 | 09 | ==> Header
1465 // 00 | 00 | 00 | 48 | ==> Header
1466 // 00 | 00 | 00 | 00 | ==> Hex data word-2
1467 // 00 | 00 | 00 | 00 | ==> Hex data word-3
1468 // 00 | 00 | 00 | 00 | ==> Hex data word-4
1469 // 20 | 00 | 00 | 00 | ==> Hex data word-5
1470 // 00 | 00 | 00 | 00 | ==> Hex data word-6
1471 // 00 | 00 | 00 | 00 | ==> Hex data word-7
1472 // 00 | 00 | 00 | 00 | ==> Hex data word-8
1473 // 00 | 00 | 00 | 00 | ==> Hex data word-9
1474 // -----------------------------------
1475 // ASCII string - 8 bytes |
1476 // -----------------------------------
1477 // ASCII space NULL - 24 bytes |
1478 // -----------------------------------
1479 //_size = Base SRC struct: 8 byte header + hex data section + ASCII string
1480
1481 uint8_t flags = (_flags | postOPPanel);
1482
1483 stream << _version << flags << _reserved1B << _wordCount << _reserved2B
1484 << _size;
1485
1486 for (auto& word : _hexData)
1487 {
1488 stream << word;
1489 }
1490
1491 _asciiString->flatten(stream);
1492
1493 return data;
1494}
1495
Matt Spinlerf9bae182019-10-09 13:37:38 -05001496} // namespace pels
1497} // namespace openpower