1 #include "bios_config.hpp"
2
3 #include "bios_enum_attribute.hpp"
4 #include "bios_integer_attribute.hpp"
5 #include "bios_string_attribute.hpp"
6 #include "bios_table.hpp"
7 #include "common/bios_utils.hpp"
8
9 #include <phosphor-logging/lg2.hpp>
10 #include <xyz/openbmc_project/BIOSConfig/Manager/server.hpp>
11
12 #include <filesystem>
13 #include <fstream>
14
15 #ifdef OEM_IBM
16 #include "oem/ibm/libpldmresponder/platform_oem_ibm.hpp"
17 #endif
18
19 PHOSPHOR_LOG2_USING;
20
21 using namespace pldm::utils;
22
23 namespace pldm
24 {
25 namespace responder
26 {
27 namespace bios
28 {
29 namespace
30 {
31 using BIOSConfigManager =
32 sdbusplus::xyz::openbmc_project::BIOSConfig::server::Manager;
33
34 constexpr auto attributesJsonFile = "bios_attrs.json";
35
36 constexpr auto stringTableFile = "stringTable";
37 constexpr auto attrTableFile = "attributeTable";
38 constexpr auto attrValueTableFile = "attributeValueTable";
39
40 } // namespace
41
BIOSConfig(const char * jsonDir,const char * tableDir,DBusHandler * const dbusHandler,int,uint8_t eid,pldm::InstanceIdDb * instanceIdDb,pldm::requester::Handler<pldm::requester::Request> * handler,pldm::responder::platform_config::Handler * platformConfigHandler,pldm::responder::bios::Callback requestPLDMServiceName)42 BIOSConfig::BIOSConfig(
43 const char* jsonDir, const char* tableDir, DBusHandler* const dbusHandler,
44 int /* fd */, uint8_t eid, pldm::InstanceIdDb* instanceIdDb,
45 pldm::requester::Handler<pldm::requester::Request>* handler,
46 pldm::responder::platform_config::Handler* platformConfigHandler,
47 pldm::responder::bios::Callback requestPLDMServiceName) :
48 jsonDir(jsonDir), tableDir(tableDir), dbusHandler(dbusHandler), eid(eid),
49 instanceIdDb(instanceIdDb), handler(handler),
50 platformConfigHandler(platformConfigHandler),
51 requestPLDMServiceName(requestPLDMServiceName)
52 {
53 fs::create_directories(tableDir);
54 removeTables();
55
56 #ifdef SYSTEM_SPECIFIC_BIOS_JSON
57 checkSystemTypeAvailability();
58 #else
59 initBIOSAttributes(sysType, false);
60 #endif
61
62 listenPendingAttributes();
63 }
64
checkSystemTypeAvailability()65 void BIOSConfig::checkSystemTypeAvailability()
66 {
67 if (platformConfigHandler)
68 {
69 auto systemType = platformConfigHandler->getPlatformName();
70 if (systemType.has_value())
71 {
72 // Received System Type from Entity Manager
73 sysType = systemType.value();
74 initBIOSAttributes(sysType, true);
75 }
76 else
77 {
78 platformConfigHandler->registerSystemTypeCallback(
79 std::bind(&BIOSConfig::initBIOSAttributes, this,
80 std::placeholders::_1, std::placeholders::_2));
81 }
82 }
83 }
84
initBIOSAttributes(const std::string & systemType,bool registerService)85 void BIOSConfig::initBIOSAttributes(const std::string& systemType,
86 bool registerService)
87 {
88 sysType = systemType;
89 fs::path dir{jsonDir / sysType};
90 if (!fs::exists(dir) && !fs::is_symlink(dir))
91 {
92 error("System specific bios attribute directory {DIR} does not exist",
93 "DIR", dir);
94 if (registerService)
95 {
96 requestPLDMServiceName();
97 }
98 return;
99 }
100 constructAttributes();
101 buildTables();
102 if (registerService)
103 {
104 requestPLDMServiceName();
105 }
106 }
107
buildTables()108 void BIOSConfig::buildTables()
109 {
110 auto stringTable = buildAndStoreStringTable();
111 if (stringTable)
112 {
113 buildAndStoreAttrTables(*stringTable);
114 }
115 }
116
getBIOSTable(pldm_bios_table_types tableType)117 std::optional<Table> BIOSConfig::getBIOSTable(pldm_bios_table_types tableType)
118 {
119 fs::path tablePath;
120 switch (tableType)
121 {
122 case PLDM_BIOS_STRING_TABLE:
123 tablePath = tableDir / stringTableFile;
124 break;
125 case PLDM_BIOS_ATTR_TABLE:
126 tablePath = tableDir / attrTableFile;
127 break;
128 case PLDM_BIOS_ATTR_VAL_TABLE:
129 tablePath = tableDir / attrValueTableFile;
130 break;
131 }
132 return loadTable(tablePath);
133 }
134
setBIOSTable(uint8_t tableType,const Table & table,bool updateBaseBIOSTable)135 int BIOSConfig::setBIOSTable(uint8_t tableType, const Table& table,
136 bool updateBaseBIOSTable)
137 {
138 fs::path stringTablePath(tableDir / stringTableFile);
139 fs::path attrTablePath(tableDir / attrTableFile);
140 fs::path attrValueTablePath(tableDir / attrValueTableFile);
141
142 if (!pldm_bios_table_checksum(table.data(), table.size()))
143 {
144 return PLDM_INVALID_BIOS_TABLE_DATA_INTEGRITY_CHECK;
145 }
146
147 if (tableType == PLDM_BIOS_STRING_TABLE)
148 {
149 storeTable(stringTablePath, table);
150 }
151 else if (tableType == PLDM_BIOS_ATTR_TABLE)
152 {
153 BIOSTable biosStringTable(stringTablePath.c_str());
154 if (biosStringTable.isEmpty())
155 {
156 return PLDM_INVALID_BIOS_TABLE_TYPE;
157 }
158
159 auto rc = checkAttributeTable(table);
160 if (rc != PLDM_SUCCESS)
161 {
162 return rc;
163 }
164
165 storeTable(attrTablePath, table);
166 }
167 else if (tableType == PLDM_BIOS_ATTR_VAL_TABLE)
168 {
169 BIOSTable biosStringTable(stringTablePath.c_str());
170 BIOSTable biosStringValueTable(attrTablePath.c_str());
171 if (biosStringTable.isEmpty() || biosStringValueTable.isEmpty())
172 {
173 return PLDM_INVALID_BIOS_TABLE_TYPE;
174 }
175
176 auto rc = checkAttributeValueTable(table);
177 if (rc != PLDM_SUCCESS)
178 {
179 return rc;
180 }
181
182 storeTable(attrValueTablePath, table);
183 }
184 else
185 {
186 return PLDM_INVALID_BIOS_TABLE_TYPE;
187 }
188
189 if ((tableType == PLDM_BIOS_ATTR_VAL_TABLE) && updateBaseBIOSTable)
190 {
191 updateBaseBIOSTableProperty();
192 }
193
194 return PLDM_SUCCESS;
195 }
196
checkAttributeTable(const Table & table)197 int BIOSConfig::checkAttributeTable(const Table& table)
198 {
199 using namespace pldm::bios::utils;
200 auto stringTable = getBIOSTable(PLDM_BIOS_STRING_TABLE);
201 for (auto entry :
202 BIOSTableIter<PLDM_BIOS_ATTR_TABLE>(table.data(), table.size()))
203 {
204 auto attrNameHandle =
205 pldm_bios_table_attr_entry_decode_string_handle(entry);
206
207 auto stringEnty = pldm_bios_table_string_find_by_handle(
208 stringTable->data(), stringTable->size(), attrNameHandle);
209 if (stringEnty == nullptr)
210 {
211 return PLDM_INVALID_BIOS_ATTR_HANDLE;
212 }
213
214 auto attrType = static_cast<pldm_bios_attribute_type>(
215 pldm_bios_table_attr_entry_decode_attribute_type(entry));
216
217 switch (attrType)
218 {
219 case PLDM_BIOS_ENUMERATION:
220 case PLDM_BIOS_ENUMERATION_READ_ONLY:
221 {
222 uint8_t pvNum;
223 // Preconditions are upheld therefore no error check necessary
224 pldm_bios_table_attr_entry_enum_decode_pv_num(entry, &pvNum);
225 std::vector<uint16_t> pvHandls(pvNum);
226 // Preconditions are upheld therefore no error check necessary
227 pldm_bios_table_attr_entry_enum_decode_pv_hdls(
228 entry, pvHandls.data(), pvHandls.size());
229 uint8_t defNum;
230 pldm_bios_table_attr_entry_enum_decode_def_num(entry, &defNum);
231 std::vector<uint8_t> defIndices(defNum);
232 pldm_bios_table_attr_entry_enum_decode_def_indices(
233 entry, defIndices.data(), defIndices.size());
234
235 for (size_t i = 0; i < pvHandls.size(); i++)
236 {
237 auto stringEntry = pldm_bios_table_string_find_by_handle(
238 stringTable->data(), stringTable->size(), pvHandls[i]);
239 if (stringEntry == nullptr)
240 {
241 return PLDM_INVALID_BIOS_ATTR_HANDLE;
242 }
243 }
244
245 for (size_t i = 0; i < defIndices.size(); i++)
246 {
247 auto stringEntry = pldm_bios_table_string_find_by_handle(
248 stringTable->data(), stringTable->size(),
249 pvHandls[defIndices[i]]);
250 if (stringEntry == nullptr)
251 {
252 return PLDM_INVALID_BIOS_ATTR_HANDLE;
253 }
254 }
255 break;
256 }
257 case PLDM_BIOS_INTEGER:
258 case PLDM_BIOS_INTEGER_READ_ONLY:
259 case PLDM_BIOS_STRING:
260 case PLDM_BIOS_STRING_READ_ONLY:
261 case PLDM_BIOS_PASSWORD:
262 case PLDM_BIOS_PASSWORD_READ_ONLY:
263 break;
264 default:
265 return PLDM_INVALID_BIOS_ATTR_HANDLE;
266 }
267 }
268
269 return PLDM_SUCCESS;
270 }
271
checkAttributeValueTable(const Table & table)272 int BIOSConfig::checkAttributeValueTable(const Table& table)
273 {
274 using namespace pldm::bios::utils;
275 auto stringTable = getBIOSTable(PLDM_BIOS_STRING_TABLE);
276 auto attrTable = getBIOSTable(PLDM_BIOS_ATTR_TABLE);
277
278 baseBIOSTableMaps.clear();
279
280 for (auto tableEntry :
281 BIOSTableIter<PLDM_BIOS_ATTR_VAL_TABLE>(table.data(), table.size()))
282 {
283 AttributeName attributeName{};
284 AttributeType attributeType{};
285 ReadonlyStatus readonlyStatus{};
286 DisplayName displayName{};
287 Description description{};
288 MenuPath menuPath{};
289 CurrentValue currentValue{};
290 DefaultValue defaultValue{};
291 std::vector<ValueDisplayName> valueDisplayNames;
292 std::map<uint16_t, std::vector<std::string>> valueDisplayNamesMap;
293 Option options{};
294
295 auto attrValueHandle =
296 pldm_bios_table_attr_value_entry_decode_attribute_handle(
297 tableEntry);
298 auto attrType = static_cast<pldm_bios_attribute_type>(
299 pldm_bios_table_attr_value_entry_decode_attribute_type(tableEntry));
300
301 auto attrEntry = pldm_bios_table_attr_find_by_handle(
302 attrTable->data(), attrTable->size(), attrValueHandle);
303 if (attrEntry == nullptr)
304 {
305 return PLDM_INVALID_BIOS_ATTR_HANDLE;
306 }
307 auto attrHandle =
308 pldm_bios_table_attr_entry_decode_attribute_handle(attrEntry);
309 auto attrNameHandle =
310 pldm_bios_table_attr_entry_decode_string_handle(attrEntry);
311
312 auto stringEntry = pldm_bios_table_string_find_by_handle(
313 stringTable->data(), stringTable->size(), attrNameHandle);
314 if (stringEntry == nullptr)
315 {
316 return PLDM_INVALID_BIOS_ATTR_HANDLE;
317 }
318 auto strLength =
319 pldm_bios_table_string_entry_decode_string_length(stringEntry);
320 std::vector<char> buffer(strLength + 1 /* sizeof '\0' */);
321 // Preconditions are upheld therefore no error check necessary
322 pldm_bios_table_string_entry_decode_string(stringEntry, buffer.data(),
323 buffer.size());
324
325 attributeName = std::string(buffer.data(), buffer.data() + strLength);
326
327 if (!biosAttributes.empty())
328 {
329 readonlyStatus =
330 biosAttributes[attrHandle % biosAttributes.size()]->readOnly;
331 description =
332 biosAttributes[attrHandle % biosAttributes.size()]->helpText;
333 displayName =
334 biosAttributes[attrHandle % biosAttributes.size()]->displayName;
335 valueDisplayNamesMap =
336 biosAttributes[attrHandle % biosAttributes.size()]
337 ->valueDisplayNamesMap;
338 }
339
340 switch (attrType)
341 {
342 case PLDM_BIOS_ENUMERATION:
343 case PLDM_BIOS_ENUMERATION_READ_ONLY:
344 {
345 if (valueDisplayNamesMap.contains(attrHandle))
346 {
347 const std::vector<ValueDisplayName>& vdn =
348 valueDisplayNamesMap[attrHandle];
349 valueDisplayNames.insert(valueDisplayNames.end(),
350 vdn.begin(), vdn.end());
351 }
352 auto getValue =
353 [](uint16_t handle, const Table& table) -> std::string {
354 auto stringEntry = pldm_bios_table_string_find_by_handle(
355 table.data(), table.size(), handle);
356
357 auto strLength =
358 pldm_bios_table_string_entry_decode_string_length(
359 stringEntry);
360 std::vector<char> buffer(strLength + 1 /* sizeof '\0' */);
361 // Preconditions are upheld therefore no error check
362 // necessary
363 pldm_bios_table_string_entry_decode_string(
364 stringEntry, buffer.data(), buffer.size());
365
366 return std::string(buffer.data(),
367 buffer.data() + strLength);
368 };
369
370 attributeType = "xyz.openbmc_project.BIOSConfig.Manager."
371 "AttributeType.Enumeration";
372
373 uint8_t pvNum;
374 // Preconditions are upheld therefore no error check necessary
375 pldm_bios_table_attr_entry_enum_decode_pv_num(attrEntry,
376 &pvNum);
377 std::vector<uint16_t> pvHandls(pvNum);
378 // Preconditions are upheld therefore no error check necessary
379 pldm_bios_table_attr_entry_enum_decode_pv_hdls(
380 attrEntry, pvHandls.data(), pvHandls.size());
381
382 // get possible_value
383 for (size_t i = 0; i < pvHandls.size(); i++)
384 {
385 options.push_back(
386 std::make_tuple("xyz.openbmc_project.BIOSConfig."
387 "Manager.BoundType.OneOf",
388 getValue(pvHandls[i], *stringTable),
389 valueDisplayNames[i]));
390 }
391
392 auto count =
393 pldm_bios_table_attr_value_entry_enum_decode_number(
394 tableEntry);
395 std::vector<uint8_t> handles(count);
396 pldm_bios_table_attr_value_entry_enum_decode_handles(
397 tableEntry, handles.data(), handles.size());
398
399 // get current_value
400 for (size_t i = 0; i < handles.size(); i++)
401 {
402 currentValue = getValue(pvHandls[handles[i]], *stringTable);
403 }
404
405 uint8_t defNum;
406 // Preconditions are upheld therefore no error check necessary
407 pldm_bios_table_attr_entry_enum_decode_def_num(attrEntry,
408 &defNum);
409 std::vector<uint8_t> defIndices(defNum);
410 pldm_bios_table_attr_entry_enum_decode_def_indices(
411 attrEntry, defIndices.data(), defIndices.size());
412
413 // get default_value
414 for (size_t i = 0; i < defIndices.size(); i++)
415 {
416 defaultValue =
417 getValue(pvHandls[defIndices[i]], *stringTable);
418 }
419
420 break;
421 }
422 case PLDM_BIOS_INTEGER:
423 case PLDM_BIOS_INTEGER_READ_ONLY:
424 {
425 attributeType = "xyz.openbmc_project.BIOSConfig.Manager."
426 "AttributeType.Integer";
427 currentValue = static_cast<int64_t>(
428 pldm_bios_table_attr_value_entry_integer_decode_cv(
429 tableEntry));
430
431 uint64_t lower, upper, def;
432 uint32_t scalar;
433 pldm_bios_table_attr_entry_integer_decode(
434 attrEntry, &lower, &upper, &scalar, &def);
435 options.push_back(std::make_tuple(
436 "xyz.openbmc_project.BIOSConfig.Manager."
437 "BoundType.LowerBound",
438 static_cast<int64_t>(lower), attributeName));
439 options.push_back(std::make_tuple(
440 "xyz.openbmc_project.BIOSConfig.Manager."
441 "BoundType.UpperBound",
442 static_cast<int64_t>(upper), attributeName));
443 options.push_back(std::make_tuple(
444 "xyz.openbmc_project.BIOSConfig.Manager."
445 "BoundType.ScalarIncrement",
446 static_cast<int64_t>(scalar), attributeName));
447 defaultValue = static_cast<int64_t>(def);
448 break;
449 }
450 case PLDM_BIOS_STRING:
451 case PLDM_BIOS_STRING_READ_ONLY:
452 {
453 attributeType = "xyz.openbmc_project.BIOSConfig.Manager."
454 "AttributeType.String";
455 variable_field currentString;
456 pldm_bios_table_attr_value_entry_string_decode_string(
457 tableEntry, ¤tString);
458 currentValue = std::string(
459 reinterpret_cast<const char*>(currentString.ptr),
460 currentString.length);
461 auto min = pldm_bios_table_attr_entry_string_decode_min_length(
462 attrEntry);
463 auto max = pldm_bios_table_attr_entry_string_decode_max_length(
464 attrEntry);
465 uint16_t def;
466 // Preconditions are upheld therefore no error check necessary
467 pldm_bios_table_attr_entry_string_decode_def_string_length(
468 attrEntry, &def);
469 std::vector<char> defString(def + 1);
470 pldm_bios_table_attr_entry_string_decode_def_string(
471 attrEntry, defString.data(), defString.size());
472 options.push_back(
473 std::make_tuple("xyz.openbmc_project.BIOSConfig.Manager."
474 "BoundType.MinStringLength",
475 static_cast<int64_t>(min), attributeName));
476 options.push_back(
477 std::make_tuple("xyz.openbmc_project.BIOSConfig.Manager."
478 "BoundType.MaxStringLength",
479 static_cast<int64_t>(max), attributeName));
480 defaultValue = defString.data();
481 break;
482 }
483 case PLDM_BIOS_PASSWORD:
484 case PLDM_BIOS_PASSWORD_READ_ONLY:
485 {
486 attributeType = "xyz.openbmc_project.BIOSConfig.Manager."
487 "AttributeType.Password";
488 break;
489 }
490 default:
491 return PLDM_INVALID_BIOS_ATTR_HANDLE;
492 }
493 baseBIOSTableMaps.emplace(
494 std::move(attributeName),
495 std::make_tuple(attributeType, readonlyStatus, displayName,
496 description, menuPath, currentValue, defaultValue,
497 std::move(options)));
498 }
499
500 return PLDM_SUCCESS;
501 }
502
updateBaseBIOSTableProperty()503 void BIOSConfig::updateBaseBIOSTableProperty()
504 {
505 constexpr static auto dbusProperties = "org.freedesktop.DBus.Properties";
506
507 if (baseBIOSTableMaps.empty())
508 {
509 return;
510 }
511
512 try
513 {
514 auto& bus = dbusHandler->getBus();
515 auto service = dbusHandler->getService(biosConfigPath,
516 BIOSConfigManager::interface);
517 auto method = bus.new_method_call(service.c_str(), biosConfigPath,
518 dbusProperties, "Set");
519 std::variant<BaseBIOSTable> value = baseBIOSTableMaps;
520 if (oemBiosHandler)
521 {
522 oemBiosHandler->processOEMBaseBiosTable(baseBIOSTableMaps);
523 }
524 method.append(BIOSConfigManager::interface,
525 BIOSConfigManager::property_names::base_bios_table,
526 value);
527 bus.call_noreply(method, dbusTimeout);
528 }
529 catch (const std::exception& e)
530 {
531 error("Failed to update BaseBIOSTable property, error - {ERROR}",
532 "ERROR", e);
533 }
534 }
535
constructAttributes()536 void BIOSConfig::constructAttributes()
537 {
538 info("Bios Attribute file path: {PATH}", "PATH",
539 (jsonDir / sysType / attributesJsonFile));
540 load(jsonDir / sysType / attributesJsonFile, [this](const Json& entry) {
541 std::string attrType = entry.at("attribute_type");
542 if (attrType == "string")
543 {
544 constructAttribute<BIOSStringAttribute>(entry);
545 }
546 else if (attrType == "integer")
547 {
548 constructAttribute<BIOSIntegerAttribute>(entry);
549 }
550 else if (attrType == "enum")
551 {
552 constructAttribute<BIOSEnumAttribute>(entry);
553 }
554 });
555 }
556
buildAndStoreAttrTables(const Table & stringTable)557 void BIOSConfig::buildAndStoreAttrTables(const Table& stringTable)
558 {
559 BIOSStringTable biosStringTable(stringTable);
560
561 if (biosAttributes.empty())
562 {
563 return;
564 }
565
566 BaseBIOSTable biosTable{};
567
568 try
569 {
570 auto& bus = dbusHandler->getBus();
571 auto service = dbusHandler->getService(biosConfigPath,
572 BIOSConfigManager::interface);
573 auto method =
574 bus.new_method_call(service.c_str(), biosConfigPath,
575 "org.freedesktop.DBus.Properties", "Get");
576 method.append(BIOSConfigManager::interface,
577 BIOSConfigManager::property_names::base_bios_table);
578 auto reply = bus.call(method, dbusTimeout);
579 std::variant<BaseBIOSTable> varBiosTable{};
580 reply.read(varBiosTable);
581 biosTable = std::get<BaseBIOSTable>(varBiosTable);
582 }
583 // Failed to read the BaseBIOSTable, so update the BaseBIOSTable with the
584 // default values populated from the BIOS JSONs to keep PLDM and
585 // bios-settings-manager in sync
586 catch (const std::exception& e)
587 {
588 error("Failed to read BaseBIOSTable property, error - {ERROR}", "ERROR",
589 e);
590 }
591
592 Table attrTable, attrValueTable;
593
594 for (auto& attr : biosAttributes)
595 {
596 try
597 {
598 auto iter = biosTable.find(attr->name);
599 if (iter == biosTable.end())
600 {
601 attr->constructEntry(biosStringTable, attrTable, attrValueTable,
602 std::nullopt);
603 }
604 else
605 {
606 attr->constructEntry(
607 biosStringTable, attrTable, attrValueTable,
608 std::get<static_cast<uint8_t>(Index::currentValue)>(
609 iter->second));
610 }
611 }
612 catch (const std::exception& e)
613 {
614 error(
615 "Failed to construct table entry for attribute '{ATTRIBUTE}', error - {ERROR}",
616 "ATTRIBUTE", attr->name, "ERROR", e);
617 }
618 }
619
620 table::appendPadAndChecksum(attrTable);
621 table::appendPadAndChecksum(attrValueTable);
622 setBIOSTable(PLDM_BIOS_ATTR_TABLE, attrTable);
623 setBIOSTable(PLDM_BIOS_ATTR_VAL_TABLE, attrValueTable);
624 }
625
buildAndStoreStringTable()626 std::optional<Table> BIOSConfig::buildAndStoreStringTable()
627 {
628 std::set<std::string> strings;
629 load(jsonDir / sysType / attributesJsonFile, [&strings](const Json& entry) {
630 if (entry.at("attribute_type") == "enum")
631 {
632 strings.emplace(entry.at("attribute_name"));
633 auto possibleValues = entry.at("possible_values");
634 for (auto& pv : possibleValues)
635 {
636 strings.emplace(pv);
637 }
638 }
639 else
640 {
641 strings.emplace(entry.at("attribute_name"));
642 }
643 });
644
645 if (strings.empty())
646 {
647 return std::nullopt;
648 }
649
650 Table table;
651 for (const auto& elem : strings)
652 {
653 table::string::constructEntry(table, elem);
654 }
655
656 table::appendPadAndChecksum(table);
657 setBIOSTable(PLDM_BIOS_STRING_TABLE, table);
658 return table;
659 }
660
storeTable(const fs::path & path,const Table & table)661 void BIOSConfig::storeTable(const fs::path& path, const Table& table)
662 {
663 BIOSTable biosTable(path.c_str());
664 biosTable.store(table);
665 }
666
loadTable(const fs::path & path)667 std::optional<Table> BIOSConfig::loadTable(const fs::path& path)
668 {
669 BIOSTable biosTable(path.c_str());
670 if (biosTable.isEmpty())
671 {
672 return std::nullopt;
673 }
674
675 Table table;
676 biosTable.load(table);
677 return table;
678 }
679
load(const fs::path & filePath,ParseHandler handler)680 void BIOSConfig::load(const fs::path& filePath, ParseHandler handler)
681 {
682 std::ifstream file;
683 Json jsonConf;
684 if (fs::exists(filePath))
685 {
686 try
687 {
688 file.open(filePath);
689 jsonConf = Json::parse(file);
690 auto entries = jsonConf.at("entries");
691 for (auto& entry : entries)
692 {
693 try
694 {
695 handler(entry);
696 }
697 catch (const std::exception& e)
698 {
699 error(
700 "Failed to parse JSON config file at path '{PATH}', error - {ERROR}",
701 "PATH", filePath, "ERROR", e);
702 }
703 }
704 }
705 catch (const std::exception& e)
706 {
707 error("Failed to parse JSON config file '{PATH}', error - {ERROR}",
708 "PATH", filePath, "ERROR", e);
709 }
710 }
711 }
712
decodeStringFromStringEntry(const pldm_bios_string_table_entry * stringEntry)713 std::string BIOSConfig::decodeStringFromStringEntry(
714 const pldm_bios_string_table_entry* stringEntry)
715 {
716 auto strLength =
717 pldm_bios_table_string_entry_decode_string_length(stringEntry);
718 std::vector<char> buffer(strLength + 1 /* sizeof '\0' */);
719 // Preconditions are upheld therefore no error check necessary
720 pldm_bios_table_string_entry_decode_string(stringEntry, buffer.data(),
721 buffer.size());
722 return std::string(buffer.data(), buffer.data() + strLength);
723 }
724
displayStringHandle(uint16_t handle,uint8_t index,const std::optional<Table> & attrTable,const std::optional<Table> & stringTable)725 std::string BIOSConfig::displayStringHandle(
726 uint16_t handle, uint8_t index, const std::optional<Table>& attrTable,
727 const std::optional<Table>& stringTable)
728 {
729 auto attrEntry = pldm_bios_table_attr_find_by_handle(
730 attrTable->data(), attrTable->size(), handle);
731 uint8_t pvNum;
732 int rc = pldm_bios_table_attr_entry_enum_decode_pv_num(attrEntry, &pvNum);
733 if (rc != PLDM_SUCCESS)
734 {
735 error(
736 "Failed to decode BIOS table possible values for attribute entry, response code '{RC}'",
737 "RC", rc);
738 throw std::runtime_error(
739 "Failed to decode BIOS table possible values for attribute entry");
740 }
741
742 std::vector<uint16_t> pvHandls(pvNum);
743 // Preconditions are upheld therefore no error check necessary
744 pldm_bios_table_attr_entry_enum_decode_pv_hdls(attrEntry, pvHandls.data(),
745 pvHandls.size());
746
747 std::string displayString = std::to_string(pvHandls[index]);
748
749 auto stringEntry = pldm_bios_table_string_find_by_handle(
750 stringTable->data(), stringTable->size(), pvHandls[index]);
751
752 auto decodedStr = decodeStringFromStringEntry(stringEntry);
753
754 return decodedStr + "(" + displayString + ")";
755 }
756
traceBIOSUpdate(const pldm_bios_attr_val_table_entry * attrValueEntry,const pldm_bios_attr_table_entry * attrEntry,bool isBMC)757 void BIOSConfig::traceBIOSUpdate(
758 const pldm_bios_attr_val_table_entry* attrValueEntry,
759 const pldm_bios_attr_table_entry* attrEntry, bool isBMC)
760 {
761 auto stringTable = getBIOSTable(PLDM_BIOS_STRING_TABLE);
762 auto attrTable = getBIOSTable(PLDM_BIOS_ATTR_TABLE);
763
764 auto [attrHandle,
765 attrType] = table::attribute_value::decodeHeader(attrValueEntry);
766
767 auto attrHeader = table::attribute::decodeHeader(attrEntry);
768 BIOSStringTable biosStringTable(*stringTable);
769 auto attrName = biosStringTable.findString(attrHeader.stringHandle);
770
771 switch (attrType)
772 {
773 case PLDM_BIOS_ENUMERATION:
774 case PLDM_BIOS_ENUMERATION_READ_ONLY:
775 {
776 auto count = pldm_bios_table_attr_value_entry_enum_decode_number(
777 attrValueEntry);
778 std::vector<uint8_t> handles(count);
779 pldm_bios_table_attr_value_entry_enum_decode_handles(
780 attrValueEntry, handles.data(), handles.size());
781
782 for (uint8_t handle : handles)
783 {
784 auto nwVal = displayStringHandle(attrHandle, handle, attrTable,
785 stringTable);
786 auto chkBMC = isBMC ? "true" : "false";
787 info(
788 "BIOS attribute '{ATTRIBUTE}' updated to value '{VALUE}' by BMC '{CHECK_BMC}'",
789 "ATTRIBUTE", attrName, "VALUE", nwVal, "CHECK_BMC", chkBMC);
790 }
791 break;
792 }
793 case PLDM_BIOS_INTEGER:
794 case PLDM_BIOS_INTEGER_READ_ONLY:
795 {
796 auto value =
797 table::attribute_value::decodeIntegerEntry(attrValueEntry);
798 auto chkBMC = isBMC ? "true" : "false";
799 info(
800 "BIOS attribute '{ATTRIBUTE}' updated to value '{VALUE}' by BMC '{CHECK_BMC}'",
801 "ATTRIBUTE", attrName, "VALUE", value, "CHECK_BMC", chkBMC);
802 break;
803 }
804 case PLDM_BIOS_STRING:
805 case PLDM_BIOS_STRING_READ_ONLY:
806 {
807 auto value =
808 table::attribute_value::decodeStringEntry(attrValueEntry);
809 auto chkBMC = isBMC ? "true" : "false";
810 info(
811 "BIOS attribute '{ATTRIBUTE}' updated to value '{VALUE}' by BMC '{CHECK_BMC}'",
812 "ATTRIBUTE", attrName, "VALUE", value, "CHECK_BMC", chkBMC);
813 break;
814 }
815 default:
816 break;
817 };
818 }
819
checkAttrValueToUpdate(const pldm_bios_attr_val_table_entry * attrValueEntry,const pldm_bios_attr_table_entry * attrEntry,Table &)820 int BIOSConfig::checkAttrValueToUpdate(
821 const pldm_bios_attr_val_table_entry* attrValueEntry,
822 const pldm_bios_attr_table_entry* attrEntry, Table&)
823
824 {
825 auto [attrHandle,
826 attrType] = table::attribute_value::decodeHeader(attrValueEntry);
827
828 switch (attrType)
829 {
830 case PLDM_BIOS_ENUMERATION:
831 case PLDM_BIOS_ENUMERATION_READ_ONLY:
832 {
833 auto value =
834 table::attribute_value::decodeEnumEntry(attrValueEntry);
835 auto [pvHdls,
836 defIndex] = table::attribute::decodeEnumEntry(attrEntry);
837 if (!(value.size() == 1))
838 {
839 return PLDM_ERROR_INVALID_LENGTH;
840 }
841 if (value[0] >= pvHdls.size())
842 {
843 error(
844 "Invalid index '{INDEX}' encountered for Enum type BIOS attribute",
845 "INDEX", value[0]);
846 return PLDM_ERROR_INVALID_DATA;
847 }
848 return PLDM_SUCCESS;
849 }
850 case PLDM_BIOS_INTEGER:
851 case PLDM_BIOS_INTEGER_READ_ONLY:
852 {
853 auto value =
854 table::attribute_value::decodeIntegerEntry(attrValueEntry);
855 auto [lower, upper, scalar,
856 def] = table::attribute::decodeIntegerEntry(attrEntry);
857
858 if (value < lower || value > upper)
859 {
860 error(
861 "Out of range index '{ATTRIBUTE_VALUE}' encountered for Integer type BIOS attribute for the lower bound '{LOWER}', the upper bound '{UPPER}' and the scalar value '{SCALAR}'.",
862 "ATTRIBUTE_VALUE", value, "LOWER", lower, "UPPER", upper,
863 "SCALAR", scalar);
864 return PLDM_ERROR_INVALID_DATA;
865 }
866 return PLDM_SUCCESS;
867 }
868 case PLDM_BIOS_STRING:
869 case PLDM_BIOS_STRING_READ_ONLY:
870 {
871 auto stringConf = table::attribute::decodeStringEntry(attrEntry);
872 auto value =
873 table::attribute_value::decodeStringEntry(attrValueEntry);
874 if (value.size() < stringConf.minLength ||
875 value.size() > stringConf.maxLength)
876 {
877 error(
878 "Invalid length '{LENGTH}' encountered for string type BIOS attribute value '{ATTRIBUTE_VALUE}' when minimum string entry length '{MIN_LEN}' and maximum string entry length '{MAX_LEN}'",
879 "ATTRIBUTE_VALUE", value, "LENGTH", value.size(), "MIN_LEN",
880 stringConf.minLength, "MAX_LEN", stringConf.maxLength);
881 return PLDM_ERROR_INVALID_LENGTH;
882 }
883 return PLDM_SUCCESS;
884 }
885 default:
886 error("ReadOnly or Unsupported type '{TYPE}'", "TYPE", attrType);
887 return PLDM_ERROR;
888 };
889 }
890
setAttrValue(const void * entry,size_t size,bool isBMC,bool updateDBus,bool updateBaseBIOSTable)891 int BIOSConfig::setAttrValue(const void* entry, size_t size, bool isBMC,
892 bool updateDBus, bool updateBaseBIOSTable)
893 {
894 auto attrValueTable = getBIOSTable(PLDM_BIOS_ATTR_VAL_TABLE);
895 auto attrTable = getBIOSTable(PLDM_BIOS_ATTR_TABLE);
896 auto stringTable = getBIOSTable(PLDM_BIOS_STRING_TABLE);
897 if (!attrValueTable || !attrTable || !stringTable)
898 {
899 return PLDM_BIOS_TABLE_UNAVAILABLE;
900 }
901
902 auto attrValueEntry =
903 reinterpret_cast<const pldm_bios_attr_val_table_entry*>(entry);
904
905 auto attrValHeader = table::attribute_value::decodeHeader(attrValueEntry);
906
907 auto attrEntry =
908 table::attribute::findByHandle(*attrTable, attrValHeader.attrHandle);
909 if (!attrEntry)
910 {
911 return PLDM_ERROR;
912 }
913
914 auto rc = checkAttrValueToUpdate(attrValueEntry, attrEntry, *stringTable);
915 if (rc != PLDM_SUCCESS)
916 {
917 return rc;
918 }
919
920 auto destTable =
921 table::attribute_value::updateTable(*attrValueTable, entry, size);
922
923 if (!destTable)
924 {
925 return PLDM_ERROR;
926 }
927
928 try
929 {
930 auto attrHeader = table::attribute::decodeHeader(attrEntry);
931
932 BIOSStringTable biosStringTable(*stringTable);
933 auto attrName = biosStringTable.findString(attrHeader.stringHandle);
934 auto iter = std::find_if(
935 biosAttributes.begin(), biosAttributes.end(),
936 [&attrName](const auto& attr) { return attr->name == attrName; });
937
938 if (iter == biosAttributes.end())
939 {
940 return PLDM_ERROR;
941 }
942 if (updateDBus)
943 {
944 (*iter)->setAttrValueOnDbus(attrValueEntry, attrEntry,
945 biosStringTable);
946 }
947 }
948 catch (const std::exception& e)
949 {
950 error("Set attribute value error - {ERROR}", "ERROR", e);
951 return PLDM_ERROR;
952 }
953
954 setBIOSTable(PLDM_BIOS_ATTR_VAL_TABLE, *destTable, updateBaseBIOSTable);
955
956 traceBIOSUpdate(attrValueEntry, attrEntry, isBMC);
957
958 return PLDM_SUCCESS;
959 }
960
removeTables()961 void BIOSConfig::removeTables()
962 {
963 try
964 {
965 fs::remove(tableDir / stringTableFile);
966 fs::remove(tableDir / attrTableFile);
967 fs::remove(tableDir / attrValueTableFile);
968 }
969 catch (const std::exception& e)
970 {
971 error("Remove the tables error - {ERROR}", "ERROR", e);
972 }
973 }
974
processBiosAttrChangeNotification(const DbusChObjProperties & chProperties,uint32_t biosAttrIndex)975 void BIOSConfig::processBiosAttrChangeNotification(
976 const DbusChObjProperties& chProperties, uint32_t biosAttrIndex)
977 {
978 const auto& dBusMap = biosAttributes[biosAttrIndex]->getDBusMap();
979 const auto& propertyName = dBusMap->propertyName;
980 const auto& attrName = biosAttributes[biosAttrIndex]->name;
981
982 const auto it = chProperties.find(propertyName);
983 if (it == chProperties.end())
984 {
985 return;
986 }
987
988 PropertyValue newPropVal = it->second;
989 auto stringTable = getBIOSTable(PLDM_BIOS_STRING_TABLE);
990 if (!stringTable.has_value())
991 {
992 error("BIOS string table unavailable");
993 return;
994 }
995 BIOSStringTable biosStringTable(*stringTable);
996 uint16_t attrNameHdl{};
997 try
998 {
999 attrNameHdl = biosStringTable.findHandle(attrName);
1000 }
1001 catch (const std::invalid_argument& e)
1002 {
1003 error(
1004 "Missing handle for attribute '{ATTRIBUTE}' in BIOS String Table, error - '{ERROR}'",
1005 "ATTRIBUTE", attrName, "ERROR", e);
1006 return;
1007 }
1008
1009 auto attrTable = getBIOSTable(PLDM_BIOS_ATTR_TABLE);
1010 if (!attrTable.has_value())
1011 {
1012 error("BIOS Attribute table not present");
1013 return;
1014 }
1015 const struct pldm_bios_attr_table_entry* tableEntry =
1016 table::attribute::findByStringHandle(*attrTable, attrNameHdl);
1017 if (tableEntry == nullptr)
1018 {
1019 error(
1020 "Failed to find attribute {ATTRIBUTE} in BIOS Attribute table with attribute handle '{ATTR_HANDLE}'",
1021 "ATTRIBUTE", attrName, "ATTR_HANDLE", attrNameHdl);
1022 return;
1023 }
1024
1025 auto [attrHdl, attrType,
1026 stringHdl] = table::attribute::decodeHeader(tableEntry);
1027
1028 auto attrValueSrcTable = getBIOSTable(PLDM_BIOS_ATTR_VAL_TABLE);
1029
1030 if (!attrValueSrcTable.has_value())
1031 {
1032 error("Attribute value table not present");
1033 return;
1034 }
1035
1036 Table newValue;
1037 auto rc = biosAttributes[biosAttrIndex]->updateAttrVal(
1038 newValue, attrHdl, attrType, newPropVal);
1039 if (rc != PLDM_SUCCESS)
1040 {
1041 error(
1042 "Failed to update the attribute value table for attribute handle '{ATTR_HANDLE}' and attribute type '{TYPE}'",
1043 "ATTR_HANDLE", attrHdl, "TYPE", attrType);
1044 return;
1045 }
1046 auto destTable = table::attribute_value::updateTable(
1047 *attrValueSrcTable, newValue.data(), newValue.size());
1048 if (destTable.has_value())
1049 {
1050 storeTable(tableDir / attrValueTableFile, *destTable);
1051 }
1052
1053 rc = setAttrValue(newValue.data(), newValue.size(), true, false);
1054 if (rc != PLDM_SUCCESS)
1055 {
1056 error(
1057 "Failed to setAttrValue on base bios table and dbus, response code '{RC}'",
1058 "RC", rc);
1059 }
1060 }
1061
findAttrHandle(const std::string & attrName)1062 uint16_t BIOSConfig::findAttrHandle(const std::string& attrName)
1063 {
1064 auto stringTable = getBIOSTable(PLDM_BIOS_STRING_TABLE);
1065 auto attrTable = getBIOSTable(PLDM_BIOS_ATTR_TABLE);
1066
1067 BIOSStringTable biosStringTable(*stringTable);
1068 pldm::bios::utils::BIOSTableIter<PLDM_BIOS_ATTR_TABLE> attrTableIter(
1069 attrTable->data(), attrTable->size());
1070 auto stringHandle = biosStringTable.findHandle(attrName);
1071
1072 for (auto entry : pldm::bios::utils::BIOSTableIter<PLDM_BIOS_ATTR_TABLE>(
1073 attrTable->data(), attrTable->size()))
1074 {
1075 auto header = table::attribute::decodeHeader(entry);
1076 if (header.stringHandle == stringHandle)
1077 {
1078 return header.attrHandle;
1079 }
1080 }
1081
1082 throw std::invalid_argument("Unknown attribute Name");
1083 }
1084
constructPendingAttribute(const PendingAttributes & pendingAttributes)1085 void BIOSConfig::constructPendingAttribute(
1086 const PendingAttributes& pendingAttributes)
1087 {
1088 std::vector<uint16_t> listOfHandles{};
1089
1090 for (auto& attribute : pendingAttributes)
1091 {
1092 std::string attributeName = attribute.first;
1093 auto& [attributeType, attributevalue] = attribute.second;
1094
1095 auto iter = std::find_if(biosAttributes.begin(), biosAttributes.end(),
1096 [&attributeName](const auto& attr) {
1097 return attr->name == attributeName;
1098 });
1099
1100 if (iter == biosAttributes.end())
1101 {
1102 error("Wrong attribute name {NAME}", "NAME", attributeName);
1103 continue;
1104 }
1105
1106 Table attrValueEntry(sizeof(pldm_bios_attr_val_table_entry), 0);
1107 auto entry = new (attrValueEntry.data()) pldm_bios_attr_val_table_entry;
1108
1109 auto handler = findAttrHandle(attributeName);
1110 auto type =
1111 BIOSConfigManager::convertAttributeTypeFromString(attributeType);
1112
1113 if (type != BIOSConfigManager::AttributeType::Enumeration &&
1114 type != BIOSConfigManager::AttributeType::String &&
1115 type != BIOSConfigManager::AttributeType::Integer)
1116 {
1117 error("Attribute type '{TYPE}' not supported", "TYPE",
1118 attributeType);
1119 continue;
1120 }
1121
1122 const auto [attrType, readonlyStatus, displayName, description,
1123 menuPath, currentValue, defaultValue,
1124 option] = baseBIOSTableMaps.at(attributeName);
1125
1126 entry->attr_handle = htole16(handler);
1127
1128 // Need to verify that the current value has really changed
1129 if (attributeType == attrType && attributevalue != currentValue)
1130 {
1131 listOfHandles.emplace_back(htole16(handler));
1132 }
1133
1134 (*iter)->generateAttributeEntry(attributevalue, attrValueEntry);
1135
1136 setAttrValue(attrValueEntry.data(), attrValueEntry.size(), true);
1137 }
1138
1139 if (listOfHandles.size())
1140 {
1141 #ifdef OEM_IBM
1142 auto rc = pldm::responder::platform::sendBiosAttributeUpdateEvent(
1143 eid, instanceIdDb, listOfHandles, handler);
1144 if (rc != PLDM_SUCCESS)
1145 {
1146 return;
1147 }
1148 #endif
1149 }
1150 }
1151
listenPendingAttributes()1152 void BIOSConfig::listenPendingAttributes()
1153 {
1154 using namespace sdbusplus::bus::match::rules;
1155 auto updateBIOSMatch = std::make_unique<sdbusplus::bus::match_t>(
1156 pldm::utils::DBusHandler::getBus(),
1157 propertiesChanged(biosConfigPath, BIOSConfigManager::interface),
1158 [this](sdbusplus::message_t& msg) {
1159 using Value =
1160 std::variant<std::string, PendingAttributes, BaseBIOSTable>;
1161 using Properties = std::map<DbusProp, Value>;
1162
1163 Properties props{};
1164 std::string intf;
1165 msg.read(intf, props);
1166
1167 auto valPropMap = props.find(
1168 BIOSConfigManager::property_names::pending_attributes);
1169 if (valPropMap == props.end())
1170 {
1171 return;
1172 }
1173
1174 PendingAttributes pendingAttributes =
1175 std::get<PendingAttributes>(valPropMap->second);
1176 this->constructPendingAttribute(pendingAttributes);
1177 });
1178
1179 biosAttrMatch.emplace_back(std::move(updateBIOSMatch));
1180 }
1181
1182 } // namespace bios
1183 } // namespace responder
1184 } // namespace pldm
1185