blob: 954ec7bba779f06704d4e2936fdb95c1d95d5f6b [file] [log] [blame]
Patrick Williams768730d2023-09-06 16:27:20 -05001#include "config.h"
2
Patrick Venture3a5071a2018-09-12 13:27:42 -07003#include "storagehandler.hpp"
4
5#include "fruread.hpp"
6#include "read_fru_data.hpp"
7#include "selutility.hpp"
8#include "sensorhandler.hpp"
9#include "storageaddsel.hpp"
Patrick Venture3a5071a2018-09-12 13:27:42 -070010
Lei YU52d91242017-10-17 22:52:28 +080011#include <arpa/inet.h>
Patrick Venture3a5071a2018-09-12 13:27:42 -070012#include <systemd/sd-bus.h>
Patrick Venture0b02be92018-08-31 11:55:55 -070013
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050014#include <ipmid/api.hpp>
Vernon Mauery9cf08382023-04-28 14:00:11 -070015#include <ipmid/entity_map_json.hpp>
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050016#include <ipmid/utils.hpp>
17#include <phosphor-logging/elog-errors.hpp>
18#include <phosphor-logging/elog.hpp>
George Liu51856e62024-07-17 19:46:03 +080019#include <phosphor-logging/lg2.hpp>
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050020#include <sdbusplus/server.hpp>
21#include <xyz/openbmc_project/Common/error.hpp>
22#include <xyz/openbmc_project/Logging/SEL/error.hpp>
23
Patrick Venture0b02be92018-08-31 11:55:55 -070024#include <algorithm>
Lei YU52d91242017-10-17 22:52:28 +080025#include <chrono>
26#include <cstdio>
Patrick Ventureb51bf9c2018-09-10 15:53:14 -070027#include <cstring>
Vernon Mauerybdda8002019-02-26 10:18:51 -080028#include <filesystem>
Lei YUa0bb2a32021-09-24 11:03:56 +080029#include <optional>
Patrick Venture3a5071a2018-09-12 13:27:42 -070030#include <string>
Vernon Mauery16b86932019-05-01 08:36:11 -070031#include <variant>
Patrick Venture3a5071a2018-09-12 13:27:42 -070032
Chris Austenb4f5b922015-10-13 12:44:43 -050033void register_netfn_storage_functions() __attribute__((constructor));
34
Patrick Venture0b02be92018-08-31 11:55:55 -070035unsigned int g_sel_time = 0xFFFFFFFF;
Patrick Venturedb0cbe62019-09-09 14:47:22 -070036namespace ipmi
37{
38namespace sensor
39{
40extern const IdInfoMap sensors;
41} // namespace sensor
42} // namespace ipmi
Lotus Xu57d35572021-01-24 11:13:13 +080043extern const ipmi::sensor::InvObjectIDMap invSensors;
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -060044extern const FruMap frus;
anil kumar appana2c7db1d2019-05-28 11:20:19 +000045constexpr uint8_t eventDataSize = 3;
Patrick Venture0b02be92018-08-31 11:55:55 -070046namespace
47{
shamim ali071d00c2022-03-02 15:42:46 +053048constexpr auto SystemdTimeService = "org.freedesktop.timedate1";
49constexpr auto SystemdTimePath = "/org/freedesktop/timedate1";
50constexpr auto SystemdTimeInterface = "org.freedesktop.timedate1";
51
Lei YUe8939392017-06-15 10:45:05 +080052constexpr auto TIME_INTERFACE = "xyz.openbmc_project.Time.EpochTime";
George Liu4d623e92020-05-25 16:51:57 +080053constexpr auto BMC_TIME_PATH = "/xyz/openbmc_project/time/bmc";
Lei YUe8939392017-06-15 10:45:05 +080054constexpr auto DBUS_PROPERTIES = "org.freedesktop.DBus.Properties";
Patrick Venture0b02be92018-08-31 11:55:55 -070055constexpr auto PROPERTY_ELAPSED = "Elapsed";
Lei YUe8939392017-06-15 10:45:05 +080056
Lei YUd9555252021-09-14 20:30:41 +080057constexpr auto logWatchPath = "/xyz/openbmc_project/logging";
Lei YUd9e57662021-09-14 18:06:28 +080058constexpr auto logBasePath = "/xyz/openbmc_project/logging/entry";
59constexpr auto logEntryIntf = "xyz.openbmc_project.Logging.Entry";
60constexpr auto logDeleteIntf = "xyz.openbmc_project.Object.Delete";
Patrick Venture0b02be92018-08-31 11:55:55 -070061} // namespace
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +053062
Tom Joseph6f7deaa2017-06-30 19:03:54 +053063using InternalFailure =
Willy Tu523e2d12023-09-05 11:36:48 -070064 sdbusplus::error::xyz::openbmc_project::common::InternalFailure;
Tom Joseph6f7deaa2017-06-30 19:03:54 +053065using namespace phosphor::logging;
Marri Devender Raocac383b2017-07-03 13:24:27 -050066using namespace ipmi::fru;
Willy Tu523e2d12023-09-05 11:36:48 -070067using namespace xyz::openbmc_project::logging::sel;
Lotus Xu57d35572021-01-24 11:13:13 +080068using SELCreated =
Willy Tu523e2d12023-09-05 11:36:48 -070069 sdbusplus::error::xyz::openbmc_project::logging::sel::Created;
Marri Devender Raocac383b2017-07-03 13:24:27 -050070
Lei YUd9e57662021-09-14 18:06:28 +080071using SELRecordID = uint16_t;
72using SELEntry = ipmi::sel::SELEventRecordFormat;
73using SELCacheMap = std::map<SELRecordID, SELEntry>;
74
75SELCacheMap selCacheMap __attribute__((init_priority(101)));
Lei YU3df36612021-09-15 11:41:11 +080076bool selCacheMapInitialized;
Patrick Williams5d82f472022-07-22 19:26:53 -050077std::unique_ptr<sdbusplus::bus::match_t> selAddedMatch
Lei YUd9555252021-09-14 20:30:41 +080078 __attribute__((init_priority(101)));
Patrick Williams5d82f472022-07-22 19:26:53 -050079std::unique_ptr<sdbusplus::bus::match_t> selRemovedMatch
Lei YUb6b72b02021-09-14 21:06:05 +080080 __attribute__((init_priority(101)));
Patrick Williams5d82f472022-07-22 19:26:53 -050081std::unique_ptr<sdbusplus::bus::match_t> selUpdatedMatch
Lei YU4106e422021-09-15 10:55:51 +080082 __attribute__((init_priority(101)));
Lei YUd9e57662021-09-14 18:06:28 +080083
Lei YUb6b72b02021-09-14 21:06:05 +080084static inline uint16_t getLoggingId(const std::string& p)
Lei YUd9e57662021-09-14 18:06:28 +080085{
86 namespace fs = std::filesystem;
87 fs::path entryPath(p);
Lei YUb6b72b02021-09-14 21:06:05 +080088 return std::stoul(entryPath.filename().string());
89}
90
Lei YUeba8e9a2021-09-15 13:16:17 +080091static inline std::string getLoggingObjPath(uint16_t id)
92{
93 return std::string(ipmi::sel::logBasePath) + "/" + std::to_string(id);
94}
95
Lei YUa0bb2a32021-09-24 11:03:56 +080096std::optional<std::pair<uint16_t, SELEntry>>
97 parseLoggingEntry(const std::string& p)
Lei YUb6b72b02021-09-14 21:06:05 +080098{
Lei YU3df36612021-09-15 11:41:11 +080099 try
100 {
Lei YUa0bb2a32021-09-24 11:03:56 +0800101 auto id = getLoggingId(p);
102 ipmi::sel::GetSELEntryResponse record{};
Lei YU3df36612021-09-15 11:41:11 +0800103 record = ipmi::sel::convertLogEntrytoSEL(p);
Lei YUa0bb2a32021-09-24 11:03:56 +0800104 return std::pair<uint16_t, SELEntry>({id, std::move(record.event)});
Lei YU3df36612021-09-15 11:41:11 +0800105 }
106 catch (const std::exception& e)
107 {
108 fprintf(stderr, "Failed to convert %s to SEL: %s\n", p.c_str(),
109 e.what());
110 }
Lei YUa0bb2a32021-09-24 11:03:56 +0800111 return std::nullopt;
Lei YUd9e57662021-09-14 18:06:28 +0800112}
113
Patrick Williams5d82f472022-07-22 19:26:53 -0500114static void selAddedCallback(sdbusplus::message_t& m)
Lei YUd9555252021-09-14 20:30:41 +0800115{
116 sdbusplus::message::object_path objPath;
117 try
118 {
119 m.read(objPath);
120 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500121 catch (const sdbusplus::exception_t& e)
Lei YUd9555252021-09-14 20:30:41 +0800122 {
George Liu51856e62024-07-17 19:46:03 +0800123 lg2::error("Failed to read object path");
Lei YUd9555252021-09-14 20:30:41 +0800124 return;
125 }
126 std::string p = objPath;
Lei YUa0bb2a32021-09-24 11:03:56 +0800127 auto entry = parseLoggingEntry(p);
128 if (entry)
129 {
130 selCacheMap.insert(std::move(*entry));
131 }
Lei YUd9555252021-09-14 20:30:41 +0800132}
133
Patrick Williams5d82f472022-07-22 19:26:53 -0500134static void selRemovedCallback(sdbusplus::message_t& m)
Lei YUb6b72b02021-09-14 21:06:05 +0800135{
136 sdbusplus::message::object_path objPath;
137 try
138 {
139 m.read(objPath);
140 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500141 catch (const sdbusplus::exception_t& e)
Lei YUb6b72b02021-09-14 21:06:05 +0800142 {
George Liu51856e62024-07-17 19:46:03 +0800143 lg2::error("Failed to read object path");
Lei YUb6b72b02021-09-14 21:06:05 +0800144 }
Lei YUa0bb2a32021-09-24 11:03:56 +0800145 try
146 {
147 std::string p = objPath;
148 selCacheMap.erase(getLoggingId(p));
149 }
150 catch (const std::invalid_argument& e)
151 {
George Liu51856e62024-07-17 19:46:03 +0800152 lg2::error("Invalid logging entry ID");
Lei YUa0bb2a32021-09-24 11:03:56 +0800153 }
Lei YUb6b72b02021-09-14 21:06:05 +0800154}
155
Patrick Williams5d82f472022-07-22 19:26:53 -0500156static void selUpdatedCallback(sdbusplus::message_t& m)
Lei YU4106e422021-09-15 10:55:51 +0800157{
158 std::string p = m.get_path();
159 auto entry = parseLoggingEntry(p);
Lei YUa0bb2a32021-09-24 11:03:56 +0800160 if (entry)
161 {
162 selCacheMap.insert_or_assign(entry->first, std::move(entry->second));
163 }
Lei YU4106e422021-09-15 10:55:51 +0800164}
165
Lei YUd9555252021-09-14 20:30:41 +0800166void registerSelCallbackHandler()
167{
168 using namespace sdbusplus::bus::match::rules;
Patrick Williams5d82f472022-07-22 19:26:53 -0500169 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lei YUd9555252021-09-14 20:30:41 +0800170 if (!selAddedMatch)
171 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500172 selAddedMatch = std::make_unique<sdbusplus::bus::match_t>(
Lei YUd9555252021-09-14 20:30:41 +0800173 bus, interfacesAdded(logWatchPath),
174 std::bind(selAddedCallback, std::placeholders::_1));
175 }
Lei YUb6b72b02021-09-14 21:06:05 +0800176 if (!selRemovedMatch)
177 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500178 selRemovedMatch = std::make_unique<sdbusplus::bus::match_t>(
Lei YUb6b72b02021-09-14 21:06:05 +0800179 bus, interfacesRemoved(logWatchPath),
180 std::bind(selRemovedCallback, std::placeholders::_1));
181 }
Lei YU4106e422021-09-15 10:55:51 +0800182 if (!selUpdatedMatch)
183 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500184 selUpdatedMatch = std::make_unique<sdbusplus::bus::match_t>(
Lei YU4106e422021-09-15 10:55:51 +0800185 bus,
186 type::signal() + member("PropertiesChanged"s) +
187 interface("org.freedesktop.DBus.Properties"s) +
188 argN(0, logEntryIntf),
189 std::bind(selUpdatedCallback, std::placeholders::_1));
190 }
Lei YUd9555252021-09-14 20:30:41 +0800191}
192
Lei YUd9e57662021-09-14 18:06:28 +0800193void initSELCache()
194{
Lei YUc10cda12022-01-06 16:01:57 +0800195 registerSelCallbackHandler();
Lei YUeba8e9a2021-09-15 13:16:17 +0800196 ipmi::sel::ObjectPaths paths;
Lei YUd9e57662021-09-14 18:06:28 +0800197 try
198 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800199 ipmi::sel::readLoggingObjectPaths(paths);
Lei YUd9e57662021-09-14 18:06:28 +0800200 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500201 catch (const sdbusplus::exception_t& e)
Lei YUd9e57662021-09-14 18:06:28 +0800202 {
George Liu51856e62024-07-17 19:46:03 +0800203 lg2::error("Failed to get logging object paths");
Lei YUd9e57662021-09-14 18:06:28 +0800204 return;
205 }
Lei YUeba8e9a2021-09-15 13:16:17 +0800206 for (const auto& p : paths)
Lei YUd9e57662021-09-14 18:06:28 +0800207 {
Lei YUa0bb2a32021-09-24 11:03:56 +0800208 auto entry = parseLoggingEntry(p);
209 if (entry)
210 {
211 selCacheMap.insert(std::move(*entry));
212 }
Lei YUd9e57662021-09-14 18:06:28 +0800213 }
Lei YU3df36612021-09-15 11:41:11 +0800214 selCacheMapInitialized = true;
Lei YUd9e57662021-09-14 18:06:28 +0800215}
216
Marri Devender Raocac383b2017-07-03 13:24:27 -0500217/**
218 * @enum Device access mode
219 */
220enum class AccessMode
221{
222 bytes, ///< Device is accessed by bytes
223 words ///< Device is accessed by words
224};
225
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000226/** @brief implements the get SEL Info command
227 * @returns IPMI completion code plus response data
228 * - selVersion - SEL revision
229 * - entries - Number of log entries in SEL.
230 * - freeSpace - Free Space in bytes.
231 * - addTimeStamp - Most recent addition timestamp
232 * - eraseTimeStamp - Most recent erase timestamp
233 * - operationSupport - Reserve & Delete SEL operations supported
234 */
235
236ipmi::RspType<uint8_t, // SEL revision.
237 uint16_t, // number of log entries in SEL.
238 uint16_t, // free Space in bytes.
239 uint32_t, // most recent addition timestamp
240 uint32_t, // most recent erase timestamp.
241
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500242 bool, // SEL allocation info supported
243 bool, // reserve SEL supported
244 bool, // partial Add SEL Entry supported
245 bool, // delete SEL supported
246 uint3_t, // reserved
247 bool // overflow flag
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000248 >
249 ipmiStorageGetSelInfo()
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530250{
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000251 uint16_t entries = 0;
252 // Most recent addition timestamp.
253 uint32_t addTimeStamp = ipmi::sel::invalidTimeStamp;
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530254
Lei YUeba8e9a2021-09-15 13:16:17 +0800255 if (!selCacheMapInitialized)
Tom Josephe59abfb2018-08-06 18:46:27 +0530256 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800257 // In case the initSELCache() fails, try it again
258 initSELCache();
Tom Josephe59abfb2018-08-06 18:46:27 +0530259 }
Lei YUeba8e9a2021-09-15 13:16:17 +0800260 if (!selCacheMap.empty())
Tom Josephe59abfb2018-08-06 18:46:27 +0530261 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800262 entries = static_cast<uint16_t>(selCacheMap.size());
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530263
264 try
265 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800266 auto objPath = getLoggingObjPath(selCacheMap.rbegin()->first);
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000267 addTimeStamp = static_cast<uint32_t>(
Lei YUeba8e9a2021-09-15 13:16:17 +0800268 (ipmi::sel::getEntryTimeStamp(objPath).count()));
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530269 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500270 catch (const InternalFailure& e)
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500271 {}
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530272 catch (const std::runtime_error& e)
273 {
George Liu51856e62024-07-17 19:46:03 +0800274 lg2::error("runtime error: {ERROR}", "ERROR", e);
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530275 }
276 }
277
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000278 constexpr uint8_t selVersion = ipmi::sel::selVersion;
279 constexpr uint16_t freeSpace = 0xFFFF;
280 constexpr uint32_t eraseTimeStamp = ipmi::sel::invalidTimeStamp;
281 constexpr uint3_t reserved{0};
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530282
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000283 return ipmi::responseSuccess(
284 selVersion, entries, freeSpace, addTimeStamp, eraseTimeStamp,
285 ipmi::sel::operationSupport::getSelAllocationInfo,
286 ipmi::sel::operationSupport::reserveSel,
287 ipmi::sel::operationSupport::partialAddSelEntry,
288 ipmi::sel::operationSupport::deleteSel, reserved,
289 ipmi::sel::operationSupport::overflow);
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530290}
291
Willy Tu11d68892022-01-20 10:37:34 -0800292ipmi_ret_t getSELEntry(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t request,
293 ipmi_response_t response, ipmi_data_len_t data_len,
294 ipmi_context_t)
Tom Josepha4953392017-06-30 19:09:47 +0530295{
Jason M. Bills851acb12019-02-04 14:06:57 -0800296 if (*data_len != sizeof(ipmi::sel::GetSELEntryRequest))
297 {
298 *data_len = 0;
299 return IPMI_CC_REQ_DATA_LEN_INVALID;
300 }
301
Patrick Venture0b02be92018-08-31 11:55:55 -0700302 auto requestData =
303 reinterpret_cast<const ipmi::sel::GetSELEntryRequest*>(request);
Tom Josepha4953392017-06-30 19:09:47 +0530304
305 if (requestData->reservationID != 0)
306 {
Jason M. Bills13e67c82018-09-10 14:12:16 -0700307 if (!checkSELReservation(requestData->reservationID))
Tom Josepha4953392017-06-30 19:09:47 +0530308 {
309 *data_len = 0;
310 return IPMI_CC_INVALID_RESERVATION_ID;
311 }
312 }
313
Lei YU3df36612021-09-15 11:41:11 +0800314 if (!selCacheMapInitialized)
315 {
316 // In case the initSELCache() fails, try it again
317 initSELCache();
318 }
319
320 if (selCacheMap.empty())
Tom Josepha4953392017-06-30 19:09:47 +0530321 {
322 *data_len = 0;
323 return IPMI_CC_SENSOR_INVALID;
324 }
325
Lei YU3df36612021-09-15 11:41:11 +0800326 SELCacheMap::const_iterator iter;
Tom Josepha4953392017-06-30 19:09:47 +0530327
328 // Check for the requested SEL Entry.
329 if (requestData->selRecordID == ipmi::sel::firstEntry)
330 {
Lei YU3df36612021-09-15 11:41:11 +0800331 iter = selCacheMap.begin();
Tom Josepha4953392017-06-30 19:09:47 +0530332 }
333 else if (requestData->selRecordID == ipmi::sel::lastEntry)
334 {
Lei YU3df36612021-09-15 11:41:11 +0800335 if (selCacheMap.size() > 1)
336 {
337 iter = selCacheMap.end();
338 --iter;
339 }
340 else
341 {
342 // Only one entry exists, return the first
343 iter = selCacheMap.begin();
344 }
Tom Josepha4953392017-06-30 19:09:47 +0530345 }
346 else
347 {
Lei YU3df36612021-09-15 11:41:11 +0800348 iter = selCacheMap.find(requestData->selRecordID);
349 if (iter == selCacheMap.end())
Tom Josepha4953392017-06-30 19:09:47 +0530350 {
351 *data_len = 0;
352 return IPMI_CC_SENSOR_INVALID;
353 }
354 }
355
Lei YU3df36612021-09-15 11:41:11 +0800356 ipmi::sel::GetSELEntryResponse record{0, iter->second};
Tom Josepha4953392017-06-30 19:09:47 +0530357 // Identify the next SEL record ID
Lei YU3df36612021-09-15 11:41:11 +0800358 ++iter;
359 if (iter == selCacheMap.end())
Tom Josepha4953392017-06-30 19:09:47 +0530360 {
Lei YU3df36612021-09-15 11:41:11 +0800361 record.nextRecordID = ipmi::sel::lastEntry;
Tom Josepha4953392017-06-30 19:09:47 +0530362 }
363 else
364 {
Lei YU3df36612021-09-15 11:41:11 +0800365 record.nextRecordID = iter->first;
Tom Josepha4953392017-06-30 19:09:47 +0530366 }
367
368 if (requestData->readLength == ipmi::sel::entireRecord)
369 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700370 std::memcpy(response, &record, sizeof(record));
Tom Josepha4953392017-06-30 19:09:47 +0530371 *data_len = sizeof(record);
372 }
373 else
374 {
375 if (requestData->offset >= ipmi::sel::selRecordSize ||
376 requestData->readLength > ipmi::sel::selRecordSize)
377 {
378 *data_len = 0;
379 return IPMI_CC_INVALID_FIELD_REQUEST;
380 }
381
382 auto diff = ipmi::sel::selRecordSize - requestData->offset;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400383 auto readLength =
384 std::min(diff, static_cast<int>(requestData->readLength));
Tom Josepha4953392017-06-30 19:09:47 +0530385
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700386 std::memcpy(response, &record.nextRecordID,
387 sizeof(record.nextRecordID));
388 std::memcpy(static_cast<uint8_t*>(response) +
389 sizeof(record.nextRecordID),
Lei YUaf378fa2020-12-02 16:28:57 +0800390 &record.event.eventRecord.recordID + requestData->offset,
391 readLength);
Tom Josepha4953392017-06-30 19:09:47 +0530392 *data_len = sizeof(record.nextRecordID) + readLength;
393 }
394
395 return IPMI_CC_OK;
396}
397
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000398/** @brief implements the delete SEL entry command
399 * @request
400 * - reservationID; // reservation ID.
401 * - selRecordID; // SEL record ID.
402 *
403 * @returns ipmi completion code plus response data
404 * - Record ID of the deleted record
405 */
406ipmi::RspType<uint16_t // deleted record ID
407 >
408 deleteSELEntry(uint16_t reservationID, uint16_t selRecordID)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530409{
Brad Bishop1a4117b2018-11-21 15:48:18 -0500410 namespace fs = std::filesystem;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530411
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000412 if (!checkSELReservation(reservationID))
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530413 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000414 return ipmi::responseInvalidReservationId();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530415 }
416
Jason M. Bills13e67c82018-09-10 14:12:16 -0700417 // Per the IPMI spec, need to cancel the reservation when a SEL entry is
418 // deleted
419 cancelSELReservation();
420
Lei YUeba8e9a2021-09-15 13:16:17 +0800421 if (!selCacheMapInitialized)
Tom Josephe59abfb2018-08-06 18:46:27 +0530422 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800423 // In case the initSELCache() fails, try it again
424 initSELCache();
Tom Josephe59abfb2018-08-06 18:46:27 +0530425 }
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530426
Lei YUeba8e9a2021-09-15 13:16:17 +0800427 if (selCacheMap.empty())
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530428 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000429 return ipmi::responseSensorInvalid();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530430 }
431
Lei YUeba8e9a2021-09-15 13:16:17 +0800432 SELCacheMap::const_iterator iter;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530433 uint16_t delRecordID = 0;
434
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000435 if (selRecordID == ipmi::sel::firstEntry)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530436 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800437 delRecordID = selCacheMap.begin()->first;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530438 }
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000439 else if (selRecordID == ipmi::sel::lastEntry)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530440 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800441 delRecordID = selCacheMap.rbegin()->first;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530442 }
443 else
444 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000445 delRecordID = selRecordID;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530446 }
447
Jian7d5f4812022-02-23 19:30:27 +0800448 iter = selCacheMap.find(delRecordID);
449 if (iter == selCacheMap.end())
450 {
451 return ipmi::responseSensorInvalid();
452 }
453
Patrick Williams5d82f472022-07-22 19:26:53 -0500454 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530455 std::string service;
456
Lei YUeba8e9a2021-09-15 13:16:17 +0800457 auto objPath = getLoggingObjPath(iter->first);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530458 try
459 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800460 service = ipmi::getService(bus, ipmi::sel::logDeleteIntf, objPath);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530461 }
462 catch (const std::runtime_error& e)
463 {
George Liu51856e62024-07-17 19:46:03 +0800464 lg2::error("runtime error: {ERROR}", "ERROR", e);
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000465 return ipmi::responseUnspecifiedError();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530466 }
467
Lei YUeba8e9a2021-09-15 13:16:17 +0800468 auto methodCall = bus.new_method_call(service.c_str(), objPath.c_str(),
Patrick Venture0b02be92018-08-31 11:55:55 -0700469 ipmi::sel::logDeleteIntf, "Delete");
George Liu3e3cc352023-07-26 15:59:31 +0800470 try
471 {
472 auto reply = bus.call(methodCall);
473 }
474 catch (const std::exception& e)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530475 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000476 return ipmi::responseUnspecifiedError();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530477 }
478
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000479 return ipmi::responseSuccess(delRecordID);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530480}
481
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000482/** @brief implements the Clear SEL command
483 * @request
484 * - reservationID // Reservation ID.
485 * - clr // char array { 'C'(0x43h), 'L'(0x4Ch), 'R'(0x52h) }
486 * - eraseOperation; // requested operation.
487 *
488 * @returns ipmi completion code plus response data
489 * - erase status
490 */
491
492ipmi::RspType<uint8_t // erase status
493 >
494 clearSEL(uint16_t reservationID, const std::array<char, 3>& clr,
495 uint8_t eraseOperation)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530496{
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000497 static constexpr std::array<char, 3> clrOk = {'C', 'L', 'R'};
498 if (clr != clrOk)
Jason M. Bills851acb12019-02-04 14:06:57 -0800499 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000500 return ipmi::responseInvalidFieldRequest();
Jason M. Bills851acb12019-02-04 14:06:57 -0800501 }
502
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000503 if (!checkSELReservation(reservationID))
Tom Joseph2f05bb52017-06-30 19:14:49 +0530504 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000505 return ipmi::responseInvalidReservationId();
Tom Joseph2f05bb52017-06-30 19:14:49 +0530506 }
507
Tom Joseph2f05bb52017-06-30 19:14:49 +0530508 /*
509 * Erasure status cannot be fetched from DBUS, so always return erasure
510 * status as `erase completed`.
511 */
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000512 if (eraseOperation == ipmi::sel::getEraseStatus)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530513 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000514 return ipmi::responseSuccess(
515 static_cast<uint8_t>(ipmi::sel::eraseComplete));
Tom Joseph2f05bb52017-06-30 19:14:49 +0530516 }
517
Xiaoyu Ma73d07772024-02-04 10:31:37 +0800518 // Check that initiate erase is correct
519 if (eraseOperation != ipmi::sel::initiateErase)
520 {
521 return ipmi::responseInvalidFieldRequest();
522 }
523
Jason M. Bills13e67c82018-09-10 14:12:16 -0700524 // Per the IPMI spec, need to cancel any reservation when the SEL is cleared
525 cancelSELReservation();
526
Patrick Williams5d82f472022-07-22 19:26:53 -0500527 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lotus Xu78fe1b12021-05-23 17:26:56 +0800528 auto service = ipmi::getService(bus, ipmi::sel::logIntf, ipmi::sel::logObj);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400529 auto method =
530 bus.new_method_call(service.c_str(), ipmi::sel::logObj,
531 ipmi::sel::logIntf, ipmi::sel::logDeleteAllMethod);
Tom Josephe59abfb2018-08-06 18:46:27 +0530532 try
Tom Joseph2f05bb52017-06-30 19:14:49 +0530533 {
Lotus Xu78fe1b12021-05-23 17:26:56 +0800534 bus.call_noreply(method);
Tom Josephe59abfb2018-08-06 18:46:27 +0530535 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500536 catch (const sdbusplus::exception_t& e)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530537 {
George Liu51856e62024-07-17 19:46:03 +0800538 lg2::error("Error eraseAll: {ERROR}", "ERROR", e);
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000539 return ipmi::responseUnspecifiedError();
Tom Joseph2f05bb52017-06-30 19:14:49 +0530540 }
541
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000542 return ipmi::responseSuccess(
543 static_cast<uint8_t>(ipmi::sel::eraseComplete));
Tom Joseph2f05bb52017-06-30 19:14:49 +0530544}
545
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000546/** @brief implements the get SEL time command
547 * @returns IPMI completion code plus response data
548 * -current time
549 */
550ipmi::RspType<uint32_t> // current time
551 ipmiStorageGetSelTime()
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500552{
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530553 using namespace std::chrono;
George Liu4d623e92020-05-25 16:51:57 +0800554 uint64_t bmc_time_usec = 0;
555 std::stringstream bmcTime;
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500556
Lei YUe8939392017-06-15 10:45:05 +0800557 try
558 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500559 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
George Liu4d623e92020-05-25 16:51:57 +0800560 auto service = ipmi::getService(bus, TIME_INTERFACE, BMC_TIME_PATH);
George Liu42f64ef2024-02-05 15:03:18 +0800561 auto propValue = ipmi::getDbusProperty(
562 bus, service, BMC_TIME_PATH, TIME_INTERFACE, PROPERTY_ELAPSED);
563 bmc_time_usec = std::get<uint64_t>(propValue);
Lei YUe8939392017-06-15 10:45:05 +0800564 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500565 catch (const InternalFailure& e)
Lei YUe8939392017-06-15 10:45:05 +0800566 {
George Liu51856e62024-07-17 19:46:03 +0800567 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000568 return ipmi::responseUnspecifiedError();
Lei YUe8939392017-06-15 10:45:05 +0800569 }
Tom Joseph30fd0a12019-09-24 06:53:22 +0530570 catch (const std::exception& e)
Lei YUe8939392017-06-15 10:45:05 +0800571 {
George Liu51856e62024-07-17 19:46:03 +0800572 lg2::error("exception message: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000573 return ipmi::responseUnspecifiedError();
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530574 }
575
George Liu51856e62024-07-17 19:46:03 +0800576 lg2::debug("BMC time: {BMC_TIME}", "BMC_TIME",
577 duration_cast<seconds>(microseconds(bmc_time_usec)).count());
Nagaraju Goruganti8960b7c2018-04-29 22:38:40 -0500578
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530579 // Time is really long int but IPMI wants just uint32. This works okay until
580 // the number of seconds since 1970 overflows uint32 size.. Still a whole
581 // lot of time here to even think about that.
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000582 return ipmi::responseSuccess(
George Liu4d623e92020-05-25 16:51:57 +0800583 duration_cast<seconds>(microseconds(bmc_time_usec)).count());
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500584}
585
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000586/** @brief implements the set SEL time command
587 * @param selDeviceTime - epoch time
588 * -local time as the number of seconds from 00:00:00, January 1, 1970
589 * @returns IPMI completion code
590 */
591ipmi::RspType<> ipmiStorageSetSelTime(uint32_t selDeviceTime)
Chris Austenb4f5b922015-10-13 12:44:43 -0500592{
Lei YUe8939392017-06-15 10:45:05 +0800593 using namespace std::chrono;
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000594 microseconds usec{seconds(selDeviceTime)};
Norman James82330442015-11-19 16:53:26 -0600595
Lei YUe8939392017-06-15 10:45:05 +0800596 try
597 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500598 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
shamim ali071d00c2022-03-02 15:42:46 +0530599 bool ntp = std::get<bool>(
600 ipmi::getDbusProperty(bus, SystemdTimeService, SystemdTimePath,
601 SystemdTimeInterface, "NTP"));
602 if (ntp)
603 {
604 return ipmi::responseCommandNotAvailable();
605 }
606
George Liu4d623e92020-05-25 16:51:57 +0800607 auto service = ipmi::getService(bus, TIME_INTERFACE, BMC_TIME_PATH);
Andrew Geissler6467ed22020-05-16 16:03:53 -0500608 std::variant<uint64_t> value{(uint64_t)usec.count()};
Lei YUe8939392017-06-15 10:45:05 +0800609
George Liu4d623e92020-05-25 16:51:57 +0800610 // Set bmc time
611 auto method = bus.new_method_call(service.c_str(), BMC_TIME_PATH,
Patrick Venture0b02be92018-08-31 11:55:55 -0700612 DBUS_PROPERTIES, "Set");
Lei YUe8939392017-06-15 10:45:05 +0800613
614 method.append(TIME_INTERFACE, PROPERTY_ELAPSED, value);
615 auto reply = bus.call(method);
Norman James82330442015-11-19 16:53:26 -0600616 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500617 catch (const InternalFailure& e)
Lei YUe8939392017-06-15 10:45:05 +0800618 {
George Liu51856e62024-07-17 19:46:03 +0800619 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000620 return ipmi::responseUnspecifiedError();
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530621 }
Tom Joseph30fd0a12019-09-24 06:53:22 +0530622 catch (const std::exception& e)
Lei YUe8939392017-06-15 10:45:05 +0800623 {
George Liu51856e62024-07-17 19:46:03 +0800624 lg2::error("exception message: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000625 return ipmi::responseUnspecifiedError();
Norman James82330442015-11-19 16:53:26 -0600626 }
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530627
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000628 return ipmi::responseSuccess();
Chris Austenb4f5b922015-10-13 12:44:43 -0500629}
630
Xiaochao Maf020c442022-10-31 11:09:38 +0800631/** @brief implements the get SEL timezone command
632 * @returns IPMI completion code plus response data
633 * -current timezone
634 */
635ipmi::RspType<int16_t> ipmiStorageGetSelTimeUtcOffset()
636{
637 time_t timep;
638 struct tm* gmTime;
639 struct tm* localTime;
640
641 time(&timep);
642 localTime = localtime(&timep);
643 auto validLocalTime = mktime(localTime);
644 gmTime = gmtime(&timep);
645 auto validGmTime = mktime(gmTime);
646 auto timeEquation = (validLocalTime - validGmTime) / 60;
647
648 return ipmi::responseSuccess(timeEquation);
649}
650
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000651/** @brief implements the reserve SEL command
652 * @returns IPMI completion code plus response data
653 * - SEL reservation ID.
654 */
655ipmi::RspType<uint16_t> ipmiStorageReserveSel()
Chris Austenb4f5b922015-10-13 12:44:43 -0500656{
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000657 return ipmi::responseSuccess(reserveSel());
Chris Austenb4f5b922015-10-13 12:44:43 -0500658}
659
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000660/** @brief implements the Add SEL entry command
661 * @request
662 *
663 * - recordID ID used for SEL Record access
664 * - recordType Record Type
665 * - timeStamp Time when event was logged. LS byte first
666 * - generatorID software ID if event was generated from
667 * system software
668 * - evmRev event message format version
669 * - sensorType sensor type code for service that generated
670 * the event
671 * - sensorNumber number of sensors that generated the event
672 * - eventDir event dir
673 * - eventData event data field contents
674 *
675 * @returns ipmi completion code plus response data
676 * - RecordID of the Added SEL entry
677 */
678ipmi::RspType<uint16_t // recordID of the Added SEL entry
679 >
Willy Tu11d68892022-01-20 10:37:34 -0800680 ipmiStorageAddSEL(uint16_t recordID, uint8_t recordType,
681 [[maybe_unused]] uint32_t timeStamp, uint16_t generatorID,
682 [[maybe_unused]] uint8_t evmRev, uint8_t sensorType,
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000683 uint8_t sensorNumber, uint8_t eventDir,
684 std::array<uint8_t, eventDataSize> eventData)
Chris Austenb4f5b922015-10-13 12:44:43 -0500685{
Lotus Xu57d35572021-01-24 11:13:13 +0800686 std::string objpath;
687 static constexpr auto systemRecordType = 0x02;
Tom Josephb647d5b2017-10-31 17:25:33 +0530688 // Hostboot sends SEL with OEM record type 0xDE to indicate that there is
689 // a maintenance procedure associated with eSEL record.
690 static constexpr auto procedureType = 0xDE;
Lotus Xu57d35572021-01-24 11:13:13 +0800691 cancelSELReservation();
692 if (recordType == systemRecordType)
693 {
Lotus Xu57d35572021-01-24 11:13:13 +0800694 for (const auto& it : invSensors)
695 {
696 if (it.second.sensorID == sensorNumber)
697 {
698 objpath = it.first;
699 break;
700 }
701 }
702 auto selDataStr = ipmi::sel::toHexStr(eventData);
703
704 bool assert = (eventDir & 0x80) ? false : true;
705
Patrick Williams1318a5e2024-08-16 15:19:54 -0400706 recordID = report<SELCreated>(
707 Created::RECORD_TYPE(recordType),
708 Created::GENERATOR_ID(generatorID),
709 Created::SENSOR_DATA(selDataStr.c_str()),
710 Created::EVENT_DIR(assert), Created::SENSOR_PATH(objpath.c_str()));
Lotus Xu57d35572021-01-24 11:13:13 +0800711 }
Patrick Williams768730d2023-09-06 16:27:20 -0500712#ifdef OPEN_POWER_SUPPORT
Lotus Xu57d35572021-01-24 11:13:13 +0800713 else if (recordType == procedureType)
Tom Josephb647d5b2017-10-31 17:25:33 +0530714 {
715 // In the OEM record type 0xDE, byte 11 in the SEL record indicate the
716 // procedure number.
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000717 createProcedureLogEntry(sensorType);
Tom Josephb647d5b2017-10-31 17:25:33 +0530718 }
Patrick Williams768730d2023-09-06 16:27:20 -0500719#endif
Chris Austenb4f5b922015-10-13 12:44:43 -0500720
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000721 return ipmi::responseSuccess(recordID);
Chris Austenb4f5b922015-10-13 12:44:43 -0500722}
723
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300724bool isFruPresent(ipmi::Context::ptr& ctx, const std::string& fruPath)
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300725{
726 using namespace ipmi::fru;
727
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300728 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400729 boost::system::error_code ec =
730 getService(ctx, invItemInterface, invObjPath + fruPath, service);
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300731 if (!ec)
732 {
733 bool result;
734 ec = ipmi::getDbusProperty(ctx, service, invObjPath + fruPath,
735 invItemInterface, itemPresentProp, result);
736 if (!ec)
737 {
738 return result;
739 }
740 }
Konstantin Aladyshevc7e4b042021-12-24 15:30:47 +0300741
742 ipmi::ObjectValueTree managedObjects;
Nan Zhou947da1b2022-09-20 20:40:59 +0000743 ec = getManagedObjects(ctx, "xyz.openbmc_project.EntityManager",
744 "/xyz/openbmc_project/inventory", managedObjects);
Konstantin Aladyshevc7e4b042021-12-24 15:30:47 +0300745 if (!ec)
746 {
747 auto connection = managedObjects.find(fruPath);
748 if (connection != managedObjects.end())
749 {
750 return true;
751 }
752 }
753
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300754 return false;
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300755}
756
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000757/** @brief implements the get FRU Inventory Area Info command
758 *
759 * @returns IPMI completion code plus response data
760 * - FRU Inventory area size in bytes,
761 * - access bit
762 **/
763ipmi::RspType<uint16_t, // FRU Inventory area size in bytes,
764 uint8_t // access size (bytes / words)
765 >
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300766 ipmiStorageGetFruInvAreaInfo(ipmi::Context::ptr ctx, uint8_t fruID)
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500767{
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000768 auto iter = frus.find(fruID);
Tom Joseph187f5642018-03-29 13:49:06 +0530769 if (iter == frus.end())
770 {
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000771 return ipmi::responseSensorInvalid();
Tom Joseph187f5642018-03-29 13:49:06 +0530772 }
773
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300774 auto path = iter->second[0].path;
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300775 if (!isFruPresent(ctx, path))
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300776 {
777 return ipmi::responseSensorInvalid();
778 }
779
Marri Devender Raocac383b2017-07-03 13:24:27 -0500780 try
781 {
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000782 return ipmi::responseSuccess(
783 static_cast<uint16_t>(getFruAreaData(fruID).size()),
784 static_cast<uint8_t>(AccessMode::bytes));
Marri Devender Raocac383b2017-07-03 13:24:27 -0500785 }
Patrick Venture0b02be92018-08-31 11:55:55 -0700786 catch (const InternalFailure& e)
Marri Devender Raocac383b2017-07-03 13:24:27 -0500787 {
George Liu51856e62024-07-17 19:46:03 +0800788 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000789 return ipmi::responseUnspecifiedError();
Marri Devender Raocac383b2017-07-03 13:24:27 -0500790 }
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500791}
792
anil kumar appana5b7c3262019-05-27 18:10:23 +0000793/**@brief implements the Read FRU Data command
794 * @param fruDeviceId - FRU device ID. FFh = reserved
795 * @param offset - FRU inventory offset to read
796 * @param readCount - count to read
797 *
798 * @return IPMI completion code plus response data
799 * - returnCount - response data count.
800 * - data - response data
801 */
802ipmi::RspType<uint8_t, // count returned
803 std::vector<uint8_t>> // FRU data
804 ipmiStorageReadFruData(uint8_t fruDeviceId, uint16_t offset,
805 uint8_t readCount)
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500806{
anil kumar appana5b7c3262019-05-27 18:10:23 +0000807 if (fruDeviceId == 0xFF)
Tom Joseph187f5642018-03-29 13:49:06 +0530808 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000809 return ipmi::responseInvalidFieldRequest();
Tom Joseph187f5642018-03-29 13:49:06 +0530810 }
811
anil kumar appana5b7c3262019-05-27 18:10:23 +0000812 auto iter = frus.find(fruDeviceId);
813 if (iter == frus.end())
814 {
815 return ipmi::responseSensorInvalid();
816 }
817
Marri Devender Raocac383b2017-07-03 13:24:27 -0500818 try
819 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000820 const auto& fruArea = getFruAreaData(fruDeviceId);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500821 auto size = fruArea.size();
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500822
Tom Josephefcd68b2018-04-26 18:46:27 +0530823 if (offset >= size)
824 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000825 return ipmi::responseParmOutOfRange();
Tom Josephefcd68b2018-04-26 18:46:27 +0530826 }
827
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500828 // Write the count of response data.
anil kumar appana5b7c3262019-05-27 18:10:23 +0000829 uint8_t returnCount;
830 if ((offset + readCount) <= size)
Marri Devender Raocac383b2017-07-03 13:24:27 -0500831 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000832 returnCount = readCount;
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500833 }
834 else
835 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000836 returnCount = size - offset;
Marri Devender Raocac383b2017-07-03 13:24:27 -0500837 }
Ratan Gupta2848d602018-01-31 20:39:20 +0530838
anil kumar appana5b7c3262019-05-27 18:10:23 +0000839 std::vector<uint8_t> fruData((fruArea.begin() + offset),
840 (fruArea.begin() + offset + returnCount));
Ratan Gupta2848d602018-01-31 20:39:20 +0530841
anil kumar appana5b7c3262019-05-27 18:10:23 +0000842 return ipmi::responseSuccess(returnCount, fruData);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500843 }
844 catch (const InternalFailure& e)
845 {
George Liu51856e62024-07-17 19:46:03 +0800846 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
anil kumar appana5b7c3262019-05-27 18:10:23 +0000847 return ipmi::responseUnspecifiedError();
Marri Devender Raocac383b2017-07-03 13:24:27 -0500848 }
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500849}
850
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000851ipmi::RspType<uint8_t, // SDR version
852 uint16_t, // record count LS first
853 uint16_t, // free space in bytes, LS first
854 uint32_t, // addition timestamp LS first
855 uint32_t, // deletion timestamp LS first
856 uint8_t> // operation Support
857 ipmiGetRepositoryInfo()
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600858{
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000859 constexpr uint8_t sdrVersion = 0x51;
860 constexpr uint16_t freeSpace = 0xFFFF;
861 constexpr uint32_t additionTimestamp = 0x0;
862 constexpr uint32_t deletionTimestamp = 0x0;
863 constexpr uint8_t operationSupport = 0;
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600864
Willy Tu0ca3bfe2022-01-28 09:40:18 -0800865 // Get SDR count. This returns the total number of SDRs in the device.
866 const auto& entityRecords =
867 ipmi::sensor::EntityInfoMapContainer::getContainer()
868 ->getIpmiEntityRecords();
Patrick Williams1318a5e2024-08-16 15:19:54 -0400869 uint16_t records =
870 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size();
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600871
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000872 return ipmi::responseSuccess(sdrVersion, records, freeSpace,
873 additionTimestamp, deletionTimestamp,
874 operationSupport);
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600875}
Chris Austenb4f5b922015-10-13 12:44:43 -0500876
Chris Austenb4f5b922015-10-13 12:44:43 -0500877void register_netfn_storage_functions()
878{
Lei YU3df36612021-09-15 11:41:11 +0800879 selCacheMapInitialized = false;
Lei YUd9e57662021-09-14 18:06:28 +0800880 initSELCache();
Willy Tud351a722021-08-12 14:33:40 -0700881 // Handlers with dbus-sdr handler implementation.
882 // Do not register the hander if it dynamic sensors stack is used.
883
884#ifndef FEATURE_DYNAMIC_SENSORS
Thang Tran292c9172023-06-26 10:03:04 +0700885
886#ifndef FEATURE_DYNAMIC_STORAGES_ONLY
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530887 // <Get SEL Info>
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000888 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
889 ipmi::storage::cmdGetSelInfo, ipmi::Privilege::User,
890 ipmiStorageGetSelInfo);
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530891
Xiaochao Maf020c442022-10-31 11:09:38 +0800892 // <Get SEL Timezone>
893 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
894 ipmi::storage::cmdGetSelTimeUtcOffset,
895 ipmi::Privilege::User,
896 ipmiStorageGetSelTimeUtcOffset);
897
Tom Josepha4953392017-06-30 19:09:47 +0530898 // <Get SEL Entry>
Patrick Venture0b02be92018-08-31 11:55:55 -0700899 ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_SEL_ENTRY, NULL,
900 getSELEntry, PRIVILEGE_USER);
Tom Josepha4953392017-06-30 19:09:47 +0530901
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530902 // <Delete SEL Entry>
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000903 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
904 ipmi::storage::cmdDeleteSelEntry,
905 ipmi::Privilege::Operator, deleteSELEntry);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530906
Tom05732372016-09-06 17:21:23 +0530907 // <Add SEL Entry>
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000908 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
909 ipmi::storage::cmdAddSelEntry,
910 ipmi::Privilege::Operator, ipmiStorageAddSEL);
911
Tom Joseph2f05bb52017-06-30 19:14:49 +0530912 // <Clear SEL>
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000913 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
914 ipmi::storage::cmdClearSel, ipmi::Privilege::Operator,
915 clearSEL);
916
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500917 // <Get FRU Inventory Area Info>
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000918 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
919 ipmi::storage::cmdGetFruInventoryAreaInfo,
920 ipmi::Privilege::User, ipmiStorageGetFruInvAreaInfo);
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500921
Jason M. Billsb5248c92019-06-24 15:53:08 -0700922 // <READ FRU Data>
anil kumar appana5b7c3262019-05-27 18:10:23 +0000923 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
924 ipmi::storage::cmdReadFruData,
925 ipmi::Privilege::Operator, ipmiStorageReadFruData);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500926
Thang Tran292c9172023-06-26 10:03:04 +0700927#endif // FEATURE_DYNAMIC_STORAGES_ONLY
928
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600929 // <Get Repository Info>
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000930 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
931 ipmi::storage::cmdGetSdrRepositoryInfo,
932 ipmi::Privilege::User, ipmiGetRepositoryInfo);
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600933
Tom Joseph5ca50952018-02-22 00:33:38 +0530934 // <Reserve SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000935 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
936 ipmi::storage::cmdReserveSdrRepository,
937 ipmi::Privilege::User, ipmiSensorReserveSdr);
Tom Joseph5ca50952018-02-22 00:33:38 +0530938
939 // <Get SDR>
Patrick Venture0b02be92018-08-31 11:55:55 -0700940 ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_SDR, nullptr,
941 ipmi_sen_get_sdr, PRIVILEGE_USER);
Tom Joseph5ca50952018-02-22 00:33:38 +0530942
Willy Tud351a722021-08-12 14:33:40 -0700943#endif
944
945 // Common Handers used by both implementation.
946
947 // <Reserve SEL>
948 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
949 ipmi::storage::cmdReserveSel, ipmi::Privilege::User,
950 ipmiStorageReserveSel);
951
Thang Trandbf66e12023-09-21 13:07:24 +0700952 // <Get SEL Time>
953 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
954 ipmi::storage::cmdGetSelTime, ipmi::Privilege::User,
955 ipmiStorageGetSelTime);
956
957 // <Set SEL Time>
958 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
959 ipmi::storage::cmdSetSelTime,
960 ipmi::Privilege::Operator, ipmiStorageSetSelTime);
961
Marri Devender Rao908f7502017-07-10 01:49:54 -0500962 ipmi::fru::registerCallbackHandler();
Chris Austenb4f5b922015-10-13 12:44:43 -0500963 return;
964}