#include "storagehandler.hpp" #include "fruread.hpp" #include "read_fru_data.hpp" #include "selutility.hpp" #include "sensorhandler.hpp" #include "storageaddsel.hpp" #include "utils.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if __has_include() #include #elif __has_include() #include namespace std { // splice experimental::filesystem into std namespace filesystem = std::experimental::filesystem; } // namespace std #else #error filesystem not available #endif void register_netfn_storage_functions() __attribute__((constructor)); unsigned int g_sel_time = 0xFFFFFFFF; extern const ipmi::sensor::IdInfoMap sensors; extern const FruMap frus; namespace { constexpr auto TIME_INTERFACE = "xyz.openbmc_project.Time.EpochTime"; constexpr auto HOST_TIME_PATH = "/xyz/openbmc_project/time/host"; constexpr auto DBUS_PROPERTIES = "org.freedesktop.DBus.Properties"; constexpr auto PROPERTY_ELAPSED = "Elapsed"; const char* getTimeString(const uint64_t& usecSinceEpoch) { using namespace std::chrono; system_clock::time_point tp{microseconds(usecSinceEpoch)}; auto t = system_clock::to_time_t(tp); return std::ctime(&t); } } // namespace namespace cache { /* * This cache contains the object paths of the logging entries sorted in the * order of the filename(numeric order). The cache is initialized by * invoking readLoggingObjectPaths with the cache as the parameter. The * cache is invoked in the execution of the Get SEL info and Delete SEL * entry command. The Get SEL Info command is typically invoked before the * Get SEL entry command, so the cache is utilized for responding to Get SEL * entry command. The cache is invalidated by clearing after Delete SEL * entry and Clear SEL command. */ ipmi::sel::ObjectPaths paths; } // namespace cache namespace variant_ns = sdbusplus::message::variant_ns; using InternalFailure = sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure; using namespace phosphor::logging; using namespace ipmi::fru; /** * @enum Device access mode */ enum class AccessMode { bytes, ///< Device is accessed by bytes words ///< Device is accessed by words }; ipmi_ret_t ipmi_storage_wildcard(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { // Status code. ipmi_ret_t rc = IPMI_CC_INVALID; *data_len = 0; return rc; } ipmi_ret_t getSELInfo(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { std::vector outPayload(sizeof(ipmi::sel::GetSELInfoResponse)); auto responseData = reinterpret_cast(outPayload.data()); responseData->selVersion = ipmi::sel::selVersion; // Last erase timestamp is not available from log manager. responseData->eraseTimeStamp = ipmi::sel::invalidTimeStamp; responseData->operationSupport = ipmi::sel::operationSupport; try { ipmi::sel::readLoggingObjectPaths(cache::paths); } catch (const sdbusplus::exception::SdBusError& e) { // No action if reading log objects have failed for this command. // readLoggingObjectPaths will throw exception if there are no log // entries. The command will be responded with number of SEL entries // as 0. } responseData->entries = 0; responseData->addTimeStamp = ipmi::sel::invalidTimeStamp; if (!cache::paths.empty()) { responseData->entries = static_cast(cache::paths.size()); try { responseData->addTimeStamp = static_cast( (ipmi::sel::getEntryTimeStamp(cache::paths.back()).count())); } catch (InternalFailure& e) { } catch (const std::runtime_error& e) { log(e.what()); } } std::memcpy(response, outPayload.data(), outPayload.size()); *data_len = outPayload.size(); return IPMI_CC_OK; } ipmi_ret_t getSELEntry(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { auto requestData = reinterpret_cast(request); if (requestData->reservationID != 0) { if (!checkSELReservation(requestData->reservationID)) { *data_len = 0; return IPMI_CC_INVALID_RESERVATION_ID; } } if (cache::paths.empty()) { *data_len = 0; return IPMI_CC_SENSOR_INVALID; } ipmi::sel::ObjectPaths::const_iterator iter; // Check for the requested SEL Entry. if (requestData->selRecordID == ipmi::sel::firstEntry) { iter = cache::paths.begin(); } else if (requestData->selRecordID == ipmi::sel::lastEntry) { iter = cache::paths.end(); } else { std::string objPath = std::string(ipmi::sel::logBasePath) + "/" + std::to_string(requestData->selRecordID); iter = std::find(cache::paths.begin(), cache::paths.end(), objPath); if (iter == cache::paths.end()) { *data_len = 0; return IPMI_CC_SENSOR_INVALID; } } ipmi::sel::GetSELEntryResponse record{}; // Convert the log entry into SEL record. try { record = ipmi::sel::convertLogEntrytoSEL(*iter); } catch (InternalFailure& e) { *data_len = 0; return IPMI_CC_UNSPECIFIED_ERROR; } catch (const std::runtime_error& e) { log(e.what()); *data_len = 0; return IPMI_CC_UNSPECIFIED_ERROR; } // Identify the next SEL record ID if (iter != cache::paths.end()) { ++iter; if (iter == cache::paths.end()) { record.nextRecordID = ipmi::sel::lastEntry; } else { namespace fs = std::filesystem; fs::path path(*iter); record.nextRecordID = static_cast( std::stoul(std::string(path.filename().c_str()))); } } else { record.nextRecordID = ipmi::sel::lastEntry; } if (requestData->readLength == ipmi::sel::entireRecord) { std::memcpy(response, &record, sizeof(record)); *data_len = sizeof(record); } else { if (requestData->offset >= ipmi::sel::selRecordSize || requestData->readLength > ipmi::sel::selRecordSize) { *data_len = 0; return IPMI_CC_INVALID_FIELD_REQUEST; } auto diff = ipmi::sel::selRecordSize - requestData->offset; auto readLength = std::min(diff, static_cast(requestData->readLength)); std::memcpy(response, &record.nextRecordID, sizeof(record.nextRecordID)); std::memcpy(static_cast(response) + sizeof(record.nextRecordID), &record.recordID + requestData->offset, readLength); *data_len = sizeof(record.nextRecordID) + readLength; } return IPMI_CC_OK; } ipmi_ret_t deleteSELEntry(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { namespace fs = std::filesystem; auto requestData = reinterpret_cast(request); if (!checkSELReservation(requestData->reservationID)) { *data_len = 0; return IPMI_CC_INVALID_RESERVATION_ID; } // Per the IPMI spec, need to cancel the reservation when a SEL entry is // deleted cancelSELReservation(); try { ipmi::sel::readLoggingObjectPaths(cache::paths); } catch (const sdbusplus::exception::SdBusError& e) { // readLoggingObjectPaths will throw exception if there are no error // log entries. *data_len = 0; return IPMI_CC_SENSOR_INVALID; } if (cache::paths.empty()) { *data_len = 0; return IPMI_CC_SENSOR_INVALID; } ipmi::sel::ObjectPaths::const_iterator iter; uint16_t delRecordID = 0; if (requestData->selRecordID == ipmi::sel::firstEntry) { iter = cache::paths.begin(); fs::path path(*iter); delRecordID = static_cast( std::stoul(std::string(path.filename().c_str()))); } else if (requestData->selRecordID == ipmi::sel::lastEntry) { iter = cache::paths.end(); fs::path path(*iter); delRecordID = static_cast( std::stoul(std::string(path.filename().c_str()))); } else { std::string objPath = std::string(ipmi::sel::logBasePath) + "/" + std::to_string(requestData->selRecordID); iter = std::find(cache::paths.begin(), cache::paths.end(), objPath); if (iter == cache::paths.end()) { *data_len = 0; return IPMI_CC_SENSOR_INVALID; } delRecordID = requestData->selRecordID; } sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()}; std::string service; try { service = ipmi::getService(bus, ipmi::sel::logDeleteIntf, *iter); } catch (const std::runtime_error& e) { log(e.what()); *data_len = 0; return IPMI_CC_UNSPECIFIED_ERROR; } auto methodCall = bus.new_method_call(service.c_str(), (*iter).c_str(), ipmi::sel::logDeleteIntf, "Delete"); auto reply = bus.call(methodCall); if (reply.is_method_error()) { *data_len = 0; return IPMI_CC_UNSPECIFIED_ERROR; } // Invalidate the cache of dbus entry objects. cache::paths.clear(); std::memcpy(response, &delRecordID, sizeof(delRecordID)); *data_len = sizeof(delRecordID); return IPMI_CC_OK; } ipmi_ret_t clearSEL(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { auto requestData = reinterpret_cast(request); if (!checkSELReservation(requestData->reservationID)) { *data_len = 0; return IPMI_CC_INVALID_RESERVATION_ID; } if (requestData->charC != 'C' || requestData->charL != 'L' || requestData->charR != 'R') { *data_len = 0; return IPMI_CC_INVALID_FIELD_REQUEST; } uint8_t eraseProgress = ipmi::sel::eraseComplete; /* * Erasure status cannot be fetched from DBUS, so always return erasure * status as `erase completed`. */ if (requestData->eraseOperation == ipmi::sel::getEraseStatus) { std::memcpy(response, &eraseProgress, sizeof(eraseProgress)); *data_len = sizeof(eraseProgress); return IPMI_CC_OK; } // Per the IPMI spec, need to cancel any reservation when the SEL is cleared cancelSELReservation(); sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()}; ipmi::sel::ObjectPaths objectPaths; auto depth = 0; auto mapperCall = bus.new_method_call(ipmi::sel::mapperBusName, ipmi::sel::mapperObjPath, ipmi::sel::mapperIntf, "GetSubTreePaths"); mapperCall.append(ipmi::sel::logBasePath); mapperCall.append(depth); mapperCall.append(ipmi::sel::ObjectPaths({ipmi::sel::logEntryIntf})); try { auto reply = bus.call(mapperCall); if (reply.is_method_error()) { std::memcpy(response, &eraseProgress, sizeof(eraseProgress)); *data_len = sizeof(eraseProgress); return IPMI_CC_OK; } reply.read(objectPaths); if (objectPaths.empty()) { std::memcpy(response, &eraseProgress, sizeof(eraseProgress)); *data_len = sizeof(eraseProgress); return IPMI_CC_OK; } } catch (const sdbusplus::exception::SdBusError& e) { std::memcpy(response, &eraseProgress, sizeof(eraseProgress)); *data_len = sizeof(eraseProgress); return IPMI_CC_OK; } std::string service; try { service = ipmi::getService(bus, ipmi::sel::logDeleteIntf, objectPaths.front()); } catch (const std::runtime_error& e) { log(e.what()); *data_len = 0; return IPMI_CC_UNSPECIFIED_ERROR; } for (const auto& iter : objectPaths) { auto methodCall = bus.new_method_call( service.c_str(), iter.c_str(), ipmi::sel::logDeleteIntf, "Delete"); auto reply = bus.call(methodCall); if (reply.is_method_error()) { *data_len = 0; return IPMI_CC_UNSPECIFIED_ERROR; } } // Invalidate the cache of dbus entry objects. cache::paths.clear(); std::memcpy(response, &eraseProgress, sizeof(eraseProgress)); *data_len = sizeof(eraseProgress); return IPMI_CC_OK; } ipmi_ret_t ipmi_storage_get_sel_time(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { using namespace std::chrono; uint64_t host_time_usec = 0; uint32_t resp = 0; std::stringstream hostTime; try { sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()}; auto service = ipmi::getService(bus, TIME_INTERFACE, HOST_TIME_PATH); sdbusplus::message::variant value; // Get host time auto method = bus.new_method_call(service.c_str(), HOST_TIME_PATH, DBUS_PROPERTIES, "Get"); method.append(TIME_INTERFACE, PROPERTY_ELAPSED); auto reply = bus.call(method); if (reply.is_method_error()) { log("Error getting time", entry("SERVICE=%s", service.c_str()), entry("PATH=%s", HOST_TIME_PATH)); return IPMI_CC_UNSPECIFIED_ERROR; } reply.read(value); host_time_usec = variant_ns::get(value); } catch (InternalFailure& e) { log(e.what()); return IPMI_CC_UNSPECIFIED_ERROR; } catch (const std::runtime_error& e) { log(e.what()); return IPMI_CC_UNSPECIFIED_ERROR; } hostTime << "Host time:" << getTimeString(host_time_usec); log(hostTime.str().c_str()); // Time is really long int but IPMI wants just uint32. This works okay until // the number of seconds since 1970 overflows uint32 size.. Still a whole // lot of time here to even think about that. resp = duration_cast(microseconds(host_time_usec)).count(); resp = htole32(resp); // From the IPMI Spec 2.0, response should be a 32-bit value *data_len = sizeof(resp); // Pack the actual response std::memcpy(response, &resp, *data_len); return IPMI_CC_OK; } ipmi_ret_t ipmi_storage_set_sel_time(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { using namespace std::chrono; ipmi_ret_t rc = IPMI_CC_OK; uint32_t secs = *static_cast(request); *data_len = 0; secs = le32toh(secs); microseconds usec{seconds(secs)}; try { sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()}; auto service = ipmi::getService(bus, TIME_INTERFACE, HOST_TIME_PATH); sdbusplus::message::variant value{usec.count()}; // Set host time auto method = bus.new_method_call(service.c_str(), HOST_TIME_PATH, DBUS_PROPERTIES, "Set"); method.append(TIME_INTERFACE, PROPERTY_ELAPSED, value); auto reply = bus.call(method); if (reply.is_method_error()) { log("Error setting time", entry("SERVICE=%s", service.c_str()), entry("PATH=%s", HOST_TIME_PATH)); rc = IPMI_CC_UNSPECIFIED_ERROR; } } catch (InternalFailure& e) { log(e.what()); rc = IPMI_CC_UNSPECIFIED_ERROR; } catch (const std::runtime_error& e) { log(e.what()); rc = IPMI_CC_UNSPECIFIED_ERROR; } return rc; } ipmi_ret_t ipmi_storage_reserve_sel(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { ipmi_ret_t rc = IPMI_CC_OK; unsigned short selResID = reserveSel(); *data_len = sizeof(selResID); // Pack the actual response std::memcpy(response, &selResID, *data_len); return rc; } ipmi_ret_t ipmi_storage_add_sel(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { ipmi_ret_t rc = IPMI_CC_OK; ipmi_add_sel_request_t* p = (ipmi_add_sel_request_t*)request; uint16_t recordid; // Per the IPMI spec, need to cancel the reservation when a SEL entry is // added cancelSELReservation(); recordid = ((uint16_t)p->eventdata[1] << 8) | p->eventdata[2]; *data_len = sizeof(recordid); // Pack the actual response std::memcpy(response, &p->eventdata[1], 2); // Hostboot sends SEL with OEM record type 0xDE to indicate that there is // a maintenance procedure associated with eSEL record. static constexpr auto procedureType = 0xDE; if (p->recordtype == procedureType) { // In the OEM record type 0xDE, byte 11 in the SEL record indicate the // procedure number. createProcedureLogEntry(p->sensortype); } else { send_esel(recordid); } return rc; } // Read FRU info area ipmi_ret_t ipmi_storage_get_fru_inv_area_info( ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { ipmi_ret_t rc = IPMI_CC_OK; const FruInvenAreaInfoRequest* reqptr = reinterpret_cast(request); auto iter = frus.find(reqptr->fruID); if (iter == frus.end()) { *data_len = 0; return IPMI_CC_SENSOR_INVALID; } try { const auto& fruArea = getFruAreaData(reqptr->fruID); auto size = static_cast(fruArea.size()); FruInvenAreaInfoResponse resp; resp.sizems = size >> 8; resp.sizels = size; resp.access = static_cast(AccessMode::bytes); *data_len = sizeof(resp); // Pack the actual response std::memcpy(response, &resp, *data_len); } catch (const InternalFailure& e) { rc = IPMI_CC_UNSPECIFIED_ERROR; *data_len = 0; log(e.what()); } return rc; } // Read FRU data ipmi_ret_t ipmi_storage_read_fru_data(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { ipmi_ret_t rc = IPMI_CC_OK; const ReadFruDataRequest* reqptr = reinterpret_cast(request); auto resptr = reinterpret_cast(response); auto iter = frus.find(reqptr->fruID); if (iter == frus.end()) { *data_len = 0; return IPMI_CC_SENSOR_INVALID; } auto offset = static_cast(reqptr->offsetMS << 8 | reqptr->offsetLS); try { const auto& fruArea = getFruAreaData(reqptr->fruID); auto size = fruArea.size(); if (offset >= size) { return IPMI_CC_PARM_OUT_OF_RANGE; } // Write the count of response data. if ((offset + reqptr->count) <= size) { resptr->count = reqptr->count; } else { resptr->count = size - offset; } std::copy((fruArea.begin() + offset), (fruArea.begin() + offset + resptr->count), resptr->data); *data_len = resptr->count + 1; // additional one byte for count } catch (const InternalFailure& e) { rc = IPMI_CC_UNSPECIFIED_ERROR; *data_len = 0; log(e.what()); } return rc; } ipmi_ret_t ipmi_get_repository_info(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request, ipmi_response_t response, ipmi_data_len_t data_len, ipmi_context_t context) { constexpr auto sdrVersion = 0x51; auto responseData = reinterpret_cast(response); std::memset(responseData, 0, sizeof(GetRepositoryInfoResponse)); responseData->sdrVersion = sdrVersion; uint16_t records = frus.size() + sensors.size(); responseData->recordCountMs = records >> 8; responseData->recordCountLs = records; responseData->freeSpace[0] = 0xFF; responseData->freeSpace[1] = 0xFF; *data_len = sizeof(GetRepositoryInfoResponse); return IPMI_CC_OK; } void register_netfn_storage_functions() { // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_WILDCARD, NULL, ipmi_storage_wildcard, PRIVILEGE_USER); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_SEL_INFO, NULL, getSELInfo, PRIVILEGE_USER); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_SEL_TIME, NULL, ipmi_storage_get_sel_time, PRIVILEGE_USER); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_SET_SEL_TIME, NULL, ipmi_storage_set_sel_time, PRIVILEGE_OPERATOR); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_RESERVE_SEL, NULL, ipmi_storage_reserve_sel, PRIVILEGE_USER); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_SEL_ENTRY, NULL, getSELEntry, PRIVILEGE_USER); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_DELETE_SEL, NULL, deleteSELEntry, PRIVILEGE_OPERATOR); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_ADD_SEL, NULL, ipmi_storage_add_sel, PRIVILEGE_OPERATOR); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_CLEAR_SEL, NULL, clearSEL, PRIVILEGE_OPERATOR); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_FRU_INV_AREA_INFO, NULL, ipmi_storage_get_fru_inv_area_info, PRIVILEGE_OPERATOR); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_REPOSITORY_INFO, nullptr, ipmi_get_repository_info, PRIVILEGE_USER); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_RESERVE_SDR, nullptr, ipmi_sen_reserve_sdr, PRIVILEGE_USER); // ipmi_register_callback(NETFUN_STORAGE, IPMI_CMD_GET_SDR, nullptr, ipmi_sen_get_sdr, PRIVILEGE_USER); ipmi::fru::registerCallbackHandler(); return; }