/* // Copyright (c) 2020 Intel Corporation // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. */ #pragma once #include "dbus_utility.hpp" #include "error_messages.hpp" #include "event_service_store.hpp" #include "http_client.hpp" #include "metric_report.hpp" #include "persistent_data.hpp" #include "random.hpp" #include "registries.hpp" #include "registries/base_message_registry.hpp" #include "registries/openbmc_message_registry.hpp" #include "registries/privilege_registry.hpp" #include "registries/task_event_message_registry.hpp" #include "server_sent_events.hpp" #include "str_utility.hpp" #include "utility.hpp" #include "utils/json_utils.hpp" #include #include #include #include #include #include #include #include #include #include #include #include namespace redfish { using ReadingsObjType = std::vector>; static constexpr const char* eventFormatType = "Event"; static constexpr const char* metricReportFormatType = "MetricReport"; static constexpr const char* subscriptionTypeSSE = "SSE"; static constexpr const char* eventServiceFile = "/var/lib/bmcweb/eventservice_config.json"; static constexpr const uint8_t maxNoOfSubscriptions = 20; static constexpr const uint8_t maxNoOfSSESubscriptions = 10; namespace registries { inline std::span getRegistryFromPrefix(const std::string& registryName) { if (task_event::header.registryPrefix == registryName) { return {task_event::registry}; } if (openbmc::header.registryPrefix == registryName) { return {openbmc::registry}; } if (base::header.registryPrefix == registryName) { return {base::registry}; } return {openbmc::registry}; } } // namespace registries #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) static std::optional inotifyConn; static constexpr const char* redfishEventLogDir = "/var/log"; static constexpr const char* redfishEventLogFile = "/var/log/redfish"; static constexpr const size_t iEventSize = sizeof(inotify_event); // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) static int inotifyFd = -1; // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) static int dirWatchDesc = -1; // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) static int fileWatchDesc = -1; // using EventLogObjectsType = std::tuple>; namespace registries { static const Message* getMsgFromRegistry(const std::string& messageKey, const std::span& registry) { std::span::iterator messageIt = std::find_if(registry.begin(), registry.end(), [&messageKey](const MessageEntry& messageEntry) { return messageKey == messageEntry.first; }); if (messageIt != registry.end()) { return &messageIt->second; } return nullptr; } static const Message* formatMessage(std::string_view messageID) { // Redfish MessageIds are in the form // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find // the right Message std::vector fields; fields.reserve(4); bmcweb::split(fields, messageID, '.'); if (fields.size() != 4) { return nullptr; } const std::string& registryName = fields[0]; const std::string& messageKey = fields[3]; // Find the right registry and check it for the MessageKey return getMsgFromRegistry(messageKey, getRegistryFromPrefix(registryName)); } } // namespace registries namespace event_log { inline bool getUniqueEntryID(const std::string& logEntry, std::string& entryID) { static time_t prevTs = 0; static int index = 0; // Get the entry timestamp std::time_t curTs = 0; std::tm timeStruct = {}; std::istringstream entryStream(logEntry); if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) { curTs = std::mktime(&timeStruct); if (curTs == -1) { return false; } } // If the timestamp isn't unique, increment the index index = (curTs == prevTs) ? index + 1 : 0; // Save the timestamp prevTs = curTs; entryID = std::to_string(curTs); if (index > 0) { entryID += "_" + std::to_string(index); } return true; } inline int getEventLogParams(const std::string& logEntry, std::string& timestamp, std::string& messageID, std::vector& messageArgs) { // The redfish log format is " ," // First get the Timestamp size_t space = logEntry.find_first_of(' '); if (space == std::string::npos) { return -EINVAL; } timestamp = logEntry.substr(0, space); // Then get the log contents size_t entryStart = logEntry.find_first_not_of(' ', space); if (entryStart == std::string::npos) { return -EINVAL; } std::string_view entry(logEntry); entry.remove_prefix(entryStart); // Use split to separate the entry into its fields std::vector logEntryFields; bmcweb::split(logEntryFields, entry, ','); // We need at least a MessageId to be valid if (logEntryFields.empty()) { return -EINVAL; } messageID = logEntryFields[0]; // Get the MessageArgs from the log if there are any if (logEntryFields.size() > 1) { const std::string& messageArgsStart = logEntryFields[1]; // If the first string is empty, assume there are no MessageArgs if (!messageArgsStart.empty()) { messageArgs.assign(logEntryFields.begin() + 1, logEntryFields.end()); } } return 0; } inline void getRegistryAndMessageKey(const std::string& messageID, std::string& registryName, std::string& messageKey) { // Redfish MessageIds are in the form // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find // the right Message std::vector fields; fields.reserve(4); bmcweb::split(fields, messageID, '.'); if (fields.size() == 4) { registryName = fields[0]; messageKey = fields[3]; } } inline int formatEventLogEntry(const std::string& logEntryID, const std::string& messageID, const std::span messageArgs, std::string timestamp, const std::string& customText, nlohmann::json& logEntryJson) { // Get the Message from the MessageRegistry const registries::Message* message = registries::formatMessage(messageID); if (message == nullptr) { return -1; } std::string msg = redfish::registries::fillMessageArgs(messageArgs, message->message); if (msg.empty()) { return -1; } // Get the Created time from the timestamp. The log timestamp is in // RFC3339 format which matches the Redfish format except for the // fractional seconds between the '.' and the '+', so just remove them. std::size_t dot = timestamp.find_first_of('.'); std::size_t plus = timestamp.find_first_of('+', dot); if (dot != std::string::npos && plus != std::string::npos) { timestamp.erase(dot, plus - dot); } // Fill in the log entry with the gathered data logEntryJson["EventId"] = logEntryID; logEntryJson["EventType"] = "Event"; logEntryJson["Severity"] = message->messageSeverity; logEntryJson["Message"] = std::move(msg); logEntryJson["MessageId"] = messageID; logEntryJson["MessageArgs"] = messageArgs; logEntryJson["EventTimestamp"] = std::move(timestamp); logEntryJson["Context"] = customText; return 0; } } // namespace event_log #endif inline bool isFilterQuerySpecialChar(char c) { switch (c) { case '(': case ')': case '\'': return true; default: return false; } } inline bool readSSEQueryParams(std::string sseFilter, std::string& formatType, std::vector& messageIds, std::vector& registryPrefixes, std::vector& metricReportDefinitions) { sseFilter.erase(std::remove_if(sseFilter.begin(), sseFilter.end(), isFilterQuerySpecialChar), sseFilter.end()); std::vector result; // NOLINTNEXTLINE bmcweb::split(result, sseFilter, ' '); BMCWEB_LOG_DEBUG << "No of tokens in SEE query: " << result.size(); constexpr uint8_t divisor = 4; constexpr uint8_t minTokenSize = 3; if (result.size() % divisor != minTokenSize) { BMCWEB_LOG_ERROR << "Invalid SSE filter specified."; return false; } for (std::size_t i = 0; i < result.size(); i += divisor) { const std::string& key = result[i]; const std::string& op = result[i + 1]; const std::string& value = result[i + 2]; if ((i + minTokenSize) < result.size()) { const std::string& separator = result[i + minTokenSize]; // SSE supports only "or" and "and" in query params. if ((separator != "or") && (separator != "and")) { BMCWEB_LOG_ERROR << "Invalid group operator in SSE query parameters"; return false; } } // SSE supports only "eq" as per spec. if (op != "eq") { BMCWEB_LOG_ERROR << "Invalid assignment operator in SSE query parameters"; return false; } BMCWEB_LOG_DEBUG << key << " : " << value; if (key == "EventFormatType") { formatType = value; } else if (key == "MessageId") { messageIds.push_back(value); } else if (key == "RegistryPrefix") { registryPrefixes.push_back(value); } else if (key == "MetricReportDefinition") { metricReportDefinitions.push_back(value); } else { BMCWEB_LOG_ERROR << "Invalid property(" << key << ")in SSE filter query."; return false; } } return true; } class Subscription : public persistent_data::UserSubscription { public: Subscription(const Subscription&) = delete; Subscription& operator=(const Subscription&) = delete; Subscription(Subscription&&) = delete; Subscription& operator=(Subscription&&) = delete; Subscription(const std::string& inHost, uint16_t inPort, const std::string& inPath, const std::string& inUriProto, boost::asio::io_context& ioc) : host(inHost), port(inPort), policy(std::make_shared()), path(inPath), uriProto(inUriProto) { client.emplace(ioc, policy); // Subscription constructor policy->invalidResp = retryRespHandler; } explicit Subscription(crow::sse_socket::Connection& connIn) : sseConn(&connIn) {} ~Subscription() = default; bool sendEvent(std::string&& msg) { persistent_data::EventServiceConfig eventServiceConfig = persistent_data::EventServiceStore::getInstance() .getEventServiceConfig(); if (!eventServiceConfig.enabled) { return false; } bool useSSL = (uriProto == "https"); // A connection pool will be created if one does not already exist if (client) { client->sendData(std::move(msg), host, port, path, useSSL, httpHeaders, boost::beast::http::verb::post); return true; } if (sseConn != nullptr) { eventSeqNum++; sseConn->sendEvent(std::to_string(eventSeqNum), msg); } return true; } bool sendTestEventLog() { nlohmann::json logEntryArray; logEntryArray.push_back({}); nlohmann::json& logEntryJson = logEntryArray.back(); logEntryJson["EventId"] = "TestID"; logEntryJson["EventType"] = "Event"; logEntryJson["Severity"] = "OK"; logEntryJson["Message"] = "Generated test event"; logEntryJson["MessageId"] = "OpenBMC.0.2.TestEventLog"; logEntryJson["MessageArgs"] = nlohmann::json::array(); logEntryJson["EventTimestamp"] = redfish::time_utils::getDateTimeOffsetNow().first; logEntryJson["Context"] = customText; nlohmann::json msg; msg["@odata.type"] = "#Event.v1_4_0.Event"; msg["Id"] = std::to_string(eventSeqNum); msg["Name"] = "Event Log"; msg["Events"] = logEntryArray; std::string strMsg = msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace); return sendEvent(std::move(strMsg)); } #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES void filterAndSendEventLogs( const std::vector& eventRecords) { nlohmann::json logEntryArray; for (const EventLogObjectsType& logEntry : eventRecords) { const std::string& idStr = std::get<0>(logEntry); const std::string& timestamp = std::get<1>(logEntry); const std::string& messageID = std::get<2>(logEntry); const std::string& registryName = std::get<3>(logEntry); const std::string& messageKey = std::get<4>(logEntry); const std::vector& messageArgs = std::get<5>(logEntry); // If registryPrefixes list is empty, don't filter events // send everything. if (!registryPrefixes.empty()) { auto obj = std::find(registryPrefixes.begin(), registryPrefixes.end(), registryName); if (obj == registryPrefixes.end()) { continue; } } // If registryMsgIds list is empty, don't filter events // send everything. if (!registryMsgIds.empty()) { auto obj = std::find(registryMsgIds.begin(), registryMsgIds.end(), messageKey); if (obj == registryMsgIds.end()) { continue; } } std::vector messageArgsView(messageArgs.begin(), messageArgs.end()); logEntryArray.push_back({}); nlohmann::json& bmcLogEntry = logEntryArray.back(); if (event_log::formatEventLogEntry(idStr, messageID, messageArgsView, timestamp, customText, bmcLogEntry) != 0) { BMCWEB_LOG_DEBUG << "Read eventLog entry failed"; continue; } } if (logEntryArray.empty()) { BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; return; } nlohmann::json msg; msg["@odata.type"] = "#Event.v1_4_0.Event"; msg["Id"] = std::to_string(eventSeqNum); msg["Name"] = "Event Log"; msg["Events"] = logEntryArray; std::string strMsg = msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace); sendEvent(std::move(strMsg)); eventSeqNum++; } #endif void filterAndSendReports(const std::string& reportId, const telemetry::TimestampReadings& var) { boost::urls::url mrdUri = boost::urls::format( "/redfish/v1/TelemetryService/MetricReportDefinitions/{}", reportId); // Empty list means no filter. Send everything. if (!metricReportDefinitions.empty()) { if (std::find(metricReportDefinitions.begin(), metricReportDefinitions.end(), mrdUri.buffer()) == metricReportDefinitions.end()) { return; } } nlohmann::json msg; if (!telemetry::fillReport(msg, reportId, var)) { BMCWEB_LOG_ERROR << "Failed to fill the MetricReport for DBus " "Report with id " << reportId; return; } // Context is set by user during Event subscription and it must be // set for MetricReport response. if (!customText.empty()) { msg["Context"] = customText; } std::string strMsg = msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace); sendEvent(std::move(strMsg)); } void updateRetryConfig(uint32_t retryAttempts, uint32_t retryTimeoutInterval) { policy->maxRetryAttempts = retryAttempts; policy->retryIntervalSecs = std::chrono::seconds(retryTimeoutInterval); } uint64_t getEventSeqNum() const { return eventSeqNum; } void setSubscriptionId(const std::string& id2) { BMCWEB_LOG_DEBUG << "Subscription ID: " << id2; subId = id2; } std::string getSubscriptionId() { return subId; } bool matchSseId(const crow::sse_socket::Connection& thisConn) { return &thisConn == sseConn; } private: std::string subId; uint64_t eventSeqNum = 1; std::string host; uint16_t port = 0; std::shared_ptr policy; crow::sse_socket::Connection* sseConn = nullptr; std::optional client; std::string path; std::string uriProto; // Check used to indicate what response codes are valid as part of our retry // policy. 2XX is considered acceptable static boost::system::error_code retryRespHandler(unsigned int respCode) { BMCWEB_LOG_DEBUG << "Checking response code validity for SubscriptionEvent"; if ((respCode < 200) || (respCode >= 300)) { return boost::system::errc::make_error_code( boost::system::errc::result_out_of_range); } // Return 0 if the response code is valid return boost::system::errc::make_error_code( boost::system::errc::success); } }; class EventServiceManager { private: bool serviceEnabled = false; uint32_t retryAttempts = 0; uint32_t retryTimeoutInterval = 0; std::streampos redfishLogFilePosition{0}; size_t noOfEventLogSubscribers{0}; size_t noOfMetricReportSubscribers{0}; std::shared_ptr matchTelemetryMonitor; boost::container::flat_map> subscriptionsMap; uint64_t eventId{1}; boost::asio::io_context& ioc; public: EventServiceManager(const EventServiceManager&) = delete; EventServiceManager& operator=(const EventServiceManager&) = delete; EventServiceManager(EventServiceManager&&) = delete; EventServiceManager& operator=(EventServiceManager&&) = delete; ~EventServiceManager() = default; explicit EventServiceManager(boost::asio::io_context& iocIn) : ioc(iocIn) { // Load config from persist store. initConfig(); } static EventServiceManager& getInstance(boost::asio::io_context* ioc = nullptr) { static EventServiceManager handler(*ioc); return handler; } void initConfig() { loadOldBehavior(); persistent_data::EventServiceConfig eventServiceConfig = persistent_data::EventServiceStore::getInstance() .getEventServiceConfig(); serviceEnabled = eventServiceConfig.enabled; retryAttempts = eventServiceConfig.retryAttempts; retryTimeoutInterval = eventServiceConfig.retryTimeoutInterval; for (const auto& it : persistent_data::EventServiceStore::getInstance() .subscriptionsConfigMap) { std::shared_ptr newSub = it.second; std::string host; std::string urlProto; uint16_t port = 0; std::string path; bool status = crow::utility::validateAndSplitUrl( newSub->destinationUrl, urlProto, host, port, path); if (!status) { BMCWEB_LOG_ERROR << "Failed to validate and split destination url"; continue; } std::shared_ptr subValue = std::make_shared(host, port, path, urlProto, ioc); subValue->id = newSub->id; subValue->destinationUrl = newSub->destinationUrl; subValue->protocol = newSub->protocol; subValue->retryPolicy = newSub->retryPolicy; subValue->customText = newSub->customText; subValue->eventFormatType = newSub->eventFormatType; subValue->subscriptionType = newSub->subscriptionType; subValue->registryMsgIds = newSub->registryMsgIds; subValue->registryPrefixes = newSub->registryPrefixes; subValue->resourceTypes = newSub->resourceTypes; subValue->httpHeaders = newSub->httpHeaders; subValue->metricReportDefinitions = newSub->metricReportDefinitions; if (subValue->id.empty()) { BMCWEB_LOG_ERROR << "Failed to add subscription"; } subscriptionsMap.insert(std::pair(subValue->id, subValue)); updateNoOfSubscribersCount(); #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES cacheRedfishLogFile(); #endif // Update retry configuration. subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); } } static void loadOldBehavior() { std::ifstream eventConfigFile(eventServiceFile); if (!eventConfigFile.good()) { BMCWEB_LOG_DEBUG << "Old eventService config not exist"; return; } auto jsonData = nlohmann::json::parse(eventConfigFile, nullptr, false); if (jsonData.is_discarded()) { BMCWEB_LOG_ERROR << "Old eventService config parse error."; return; } for (const auto& item : jsonData.items()) { if (item.key() == "Configuration") { persistent_data::EventServiceStore::getInstance() .getEventServiceConfig() .fromJson(item.value()); } else if (item.key() == "Subscriptions") { for (const auto& elem : item.value()) { std::shared_ptr newSubscription = persistent_data::UserSubscription::fromJson(elem, true); if (newSubscription == nullptr) { BMCWEB_LOG_ERROR << "Problem reading subscription " "from old persistent store"; continue; } std::uniform_int_distribution dist(0); bmcweb::OpenSSLGenerator gen; std::string id; int retry = 3; while (retry != 0) { id = std::to_string(dist(gen)); if (gen.error()) { retry = 0; break; } newSubscription->id = id; auto inserted = persistent_data::EventServiceStore::getInstance() .subscriptionsConfigMap.insert( std::pair(id, newSubscription)); if (inserted.second) { break; } --retry; } if (retry <= 0) { BMCWEB_LOG_ERROR << "Failed to generate random number from old " "persistent store"; continue; } } } persistent_data::getConfig().writeData(); std::remove(eventServiceFile); BMCWEB_LOG_DEBUG << "Remove old eventservice config"; } } void updateSubscriptionData() const { persistent_data::EventServiceStore::getInstance() .eventServiceConfig.enabled = serviceEnabled; persistent_data::EventServiceStore::getInstance() .eventServiceConfig.retryAttempts = retryAttempts; persistent_data::EventServiceStore::getInstance() .eventServiceConfig.retryTimeoutInterval = retryTimeoutInterval; persistent_data::getConfig().writeData(); } void setEventServiceConfig(const persistent_data::EventServiceConfig& cfg) { bool updateConfig = false; bool updateRetryCfg = false; if (serviceEnabled != cfg.enabled) { serviceEnabled = cfg.enabled; if (serviceEnabled && noOfMetricReportSubscribers != 0U) { registerMetricReportSignal(); } else { unregisterMetricReportSignal(); } updateConfig = true; } if (retryAttempts != cfg.retryAttempts) { retryAttempts = cfg.retryAttempts; updateConfig = true; updateRetryCfg = true; } if (retryTimeoutInterval != cfg.retryTimeoutInterval) { retryTimeoutInterval = cfg.retryTimeoutInterval; updateConfig = true; updateRetryCfg = true; } if (updateConfig) { updateSubscriptionData(); } if (updateRetryCfg) { // Update the changed retry config to all subscriptions for (const auto& it : EventServiceManager::getInstance().subscriptionsMap) { Subscription& entry = *it.second; entry.updateRetryConfig(retryAttempts, retryTimeoutInterval); } } } void updateNoOfSubscribersCount() { size_t eventLogSubCount = 0; size_t metricReportSubCount = 0; for (const auto& it : subscriptionsMap) { std::shared_ptr entry = it.second; if (entry->eventFormatType == eventFormatType) { eventLogSubCount++; } else if (entry->eventFormatType == metricReportFormatType) { metricReportSubCount++; } } noOfEventLogSubscribers = eventLogSubCount; if (noOfMetricReportSubscribers != metricReportSubCount) { noOfMetricReportSubscribers = metricReportSubCount; if (noOfMetricReportSubscribers != 0U) { registerMetricReportSignal(); } else { unregisterMetricReportSignal(); } } } std::shared_ptr getSubscription(const std::string& id) { auto obj = subscriptionsMap.find(id); if (obj == subscriptionsMap.end()) { BMCWEB_LOG_ERROR << "No subscription exist with ID:" << id; return nullptr; } std::shared_ptr subValue = obj->second; return subValue; } std::string addSubscription(const std::shared_ptr& subValue, const bool updateFile = true) { std::uniform_int_distribution dist(0); bmcweb::OpenSSLGenerator gen; std::string id; int retry = 3; while (retry != 0) { id = std::to_string(dist(gen)); if (gen.error()) { retry = 0; break; } auto inserted = subscriptionsMap.insert(std::pair(id, subValue)); if (inserted.second) { break; } --retry; } if (retry <= 0) { BMCWEB_LOG_ERROR << "Failed to generate random number"; return ""; } std::shared_ptr newSub = std::make_shared(); newSub->id = id; newSub->destinationUrl = subValue->destinationUrl; newSub->protocol = subValue->protocol; newSub->retryPolicy = subValue->retryPolicy; newSub->customText = subValue->customText; newSub->eventFormatType = subValue->eventFormatType; newSub->subscriptionType = subValue->subscriptionType; newSub->registryMsgIds = subValue->registryMsgIds; newSub->registryPrefixes = subValue->registryPrefixes; newSub->resourceTypes = subValue->resourceTypes; newSub->httpHeaders = subValue->httpHeaders; newSub->metricReportDefinitions = subValue->metricReportDefinitions; persistent_data::EventServiceStore::getInstance() .subscriptionsConfigMap.emplace(newSub->id, newSub); updateNoOfSubscribersCount(); if (updateFile) { updateSubscriptionData(); } #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES if (redfishLogFilePosition != 0) { cacheRedfishLogFile(); } #endif // Update retry configuration. subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); // Set Subscription ID for back trace subValue->setSubscriptionId(id); return id; } bool isSubscriptionExist(const std::string& id) { auto obj = subscriptionsMap.find(id); return obj != subscriptionsMap.end(); } void deleteSubscription(const std::string& id) { auto obj = subscriptionsMap.find(id); if (obj != subscriptionsMap.end()) { subscriptionsMap.erase(obj); auto obj2 = persistent_data::EventServiceStore::getInstance() .subscriptionsConfigMap.find(id); persistent_data::EventServiceStore::getInstance() .subscriptionsConfigMap.erase(obj2); updateNoOfSubscribersCount(); updateSubscriptionData(); } } void deleteSseSubscription(const crow::sse_socket::Connection& thisConn) { for (const auto& it : subscriptionsMap) { std::shared_ptr entry = it.second; bool entryIsThisConn = entry->matchSseId(thisConn); if (entryIsThisConn) { persistent_data::EventServiceStore::getInstance() .subscriptionsConfigMap.erase( it.second->getSubscriptionId()); return; } } } size_t getNumberOfSubscriptions() const { return subscriptionsMap.size(); } size_t getNumberOfSSESubscriptions() const { auto size = std::count_if( subscriptionsMap.begin(), subscriptionsMap.end(), [](const std::pair>& entry) { return (entry.second->subscriptionType == subscriptionTypeSSE); }); return static_cast(size); } std::vector getAllIDs() { std::vector idList; for (const auto& it : subscriptionsMap) { idList.emplace_back(it.first); } return idList; } bool isDestinationExist(const std::string& destUrl) const { for (const auto& it : subscriptionsMap) { std::shared_ptr entry = it.second; if (entry->destinationUrl == destUrl) { BMCWEB_LOG_ERROR << "Destination exist already" << destUrl; return true; } } return false; } bool sendTestEventLog() { for (const auto& it : subscriptionsMap) { std::shared_ptr entry = it.second; if (!entry->sendTestEventLog()) { return false; } } return true; } void sendEvent(nlohmann::json eventMessage, const std::string& origin, const std::string& resType) { if (!serviceEnabled || (noOfEventLogSubscribers == 0U)) { BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; return; } nlohmann::json eventRecord = nlohmann::json::array(); eventMessage["EventId"] = eventId; // MemberId is 0 : since we are sending one event record. eventMessage["MemberId"] = 0; eventMessage["EventTimestamp"] = redfish::time_utils::getDateTimeOffsetNow().first; eventMessage["OriginOfCondition"] = origin; eventRecord.emplace_back(std::move(eventMessage)); for (const auto& it : subscriptionsMap) { std::shared_ptr entry = it.second; bool isSubscribed = false; // Search the resourceTypes list for the subscription. // If resourceTypes list is empty, don't filter events // send everything. if (!entry->resourceTypes.empty()) { for (const auto& resource : entry->resourceTypes) { if (resType == resource) { BMCWEB_LOG_INFO << "ResourceType " << resource << " found in the subscribed list"; isSubscribed = true; break; } } } else // resourceTypes list is empty. { isSubscribed = true; } if (isSubscribed) { nlohmann::json msgJson; msgJson["@odata.type"] = "#Event.v1_4_0.Event"; msgJson["Name"] = "Event Log"; msgJson["Id"] = eventId; msgJson["Events"] = eventRecord; std::string strMsg = msgJson.dump( 2, ' ', true, nlohmann::json::error_handler_t::replace); entry->sendEvent(std::move(strMsg)); eventId++; // increament the eventId } else { BMCWEB_LOG_INFO << "Not subscribed to this resource"; } } } void sendBroadcastMsg(const std::string& broadcastMsg) { for (const auto& it : subscriptionsMap) { std::shared_ptr entry = it.second; nlohmann::json msgJson; msgJson["Timestamp"] = redfish::time_utils::getDateTimeOffsetNow().first; msgJson["OriginOfCondition"] = "/ibm/v1/HMC/BroadcastService"; msgJson["Name"] = "Broadcast Message"; msgJson["Message"] = broadcastMsg; std::string strMsg = msgJson.dump( 2, ' ', true, nlohmann::json::error_handler_t::replace); entry->sendEvent(std::move(strMsg)); } } #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES void resetRedfishFilePosition() { // Control would be here when Redfish file is created. // Reset File Position as new file is created redfishLogFilePosition = 0; } void cacheRedfishLogFile() { // Open the redfish file and read till the last record. std::ifstream logStream(redfishEventLogFile); if (!logStream.good()) { BMCWEB_LOG_ERROR << " Redfish log file open failed \n"; return; } std::string logEntry; while (std::getline(logStream, logEntry)) { redfishLogFilePosition = logStream.tellg(); } BMCWEB_LOG_DEBUG << "Next Log Position : " << redfishLogFilePosition; } void readEventLogsFromFile() { std::ifstream logStream(redfishEventLogFile); if (!logStream.good()) { BMCWEB_LOG_ERROR << " Redfish log file open failed"; return; } std::vector eventRecords; std::string logEntry; // Get the read pointer to the next log to be read. logStream.seekg(redfishLogFilePosition); while (std::getline(logStream, logEntry)) { // Update Pointer position redfishLogFilePosition = logStream.tellg(); std::string idStr; if (!event_log::getUniqueEntryID(logEntry, idStr)) { continue; } if (!serviceEnabled || noOfEventLogSubscribers == 0) { // If Service is not enabled, no need to compute // the remaining items below. // But, Loop must continue to keep track of Timestamp continue; } std::string timestamp; std::string messageID; std::vector messageArgs; if (event_log::getEventLogParams(logEntry, timestamp, messageID, messageArgs) != 0) { BMCWEB_LOG_DEBUG << "Read eventLog entry params failed"; continue; } std::string registryName; std::string messageKey; event_log::getRegistryAndMessageKey(messageID, registryName, messageKey); if (registryName.empty() || messageKey.empty()) { continue; } eventRecords.emplace_back(idStr, timestamp, messageID, registryName, messageKey, messageArgs); } if (!serviceEnabled || noOfEventLogSubscribers == 0) { BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; return; } if (eventRecords.empty()) { // No Records to send BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; return; } for (const auto& it : subscriptionsMap) { std::shared_ptr entry = it.second; if (entry->eventFormatType == "Event") { entry->filterAndSendEventLogs(eventRecords); } } } static void watchRedfishEventLogFile() { if (!inotifyConn) { return; } static std::array readBuffer; inotifyConn->async_read_some(boost::asio::buffer(readBuffer), [&](const boost::system::error_code& ec, const std::size_t& bytesTransferred) { if (ec) { BMCWEB_LOG_ERROR << "Callback Error: " << ec.message(); return; } std::size_t index = 0; while ((index + iEventSize) <= bytesTransferred) { struct inotify_event event {}; std::memcpy(&event, &readBuffer[index], iEventSize); if (event.wd == dirWatchDesc) { if ((event.len == 0) || (index + iEventSize + event.len > bytesTransferred)) { index += (iEventSize + event.len); continue; } std::string fileName(&readBuffer[index + iEventSize]); if (fileName != "redfish") { index += (iEventSize + event.len); continue; } BMCWEB_LOG_DEBUG << "Redfish log file created/deleted. event.name: " << fileName; if (event.mask == IN_CREATE) { if (fileWatchDesc != -1) { BMCWEB_LOG_DEBUG << "Remove and Add inotify watcher on " "redfish event log file"; // Remove existing inotify watcher and add // with new redfish event log file. inotify_rm_watch(inotifyFd, fileWatchDesc); fileWatchDesc = -1; } fileWatchDesc = inotify_add_watch( inotifyFd, redfishEventLogFile, IN_MODIFY); if (fileWatchDesc == -1) { BMCWEB_LOG_ERROR << "inotify_add_watch failed for " "redfish log file."; return; } EventServiceManager::getInstance() .resetRedfishFilePosition(); EventServiceManager::getInstance() .readEventLogsFromFile(); } else if ((event.mask == IN_DELETE) || (event.mask == IN_MOVED_TO)) { if (fileWatchDesc != -1) { inotify_rm_watch(inotifyFd, fileWatchDesc); fileWatchDesc = -1; } } } else if (event.wd == fileWatchDesc) { if (event.mask == IN_MODIFY) { EventServiceManager::getInstance() .readEventLogsFromFile(); } } index += (iEventSize + event.len); } watchRedfishEventLogFile(); }); } static int startEventLogMonitor(boost::asio::io_context& ioc) { inotifyConn.emplace(ioc); inotifyFd = inotify_init1(IN_NONBLOCK); if (inotifyFd == -1) { BMCWEB_LOG_ERROR << "inotify_init1 failed."; return -1; } // Add watch on directory to handle redfish event log file // create/delete. dirWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogDir, IN_CREATE | IN_MOVED_TO | IN_DELETE); if (dirWatchDesc == -1) { BMCWEB_LOG_ERROR << "inotify_add_watch failed for event log directory."; return -1; } // Watch redfish event log file for modifications. fileWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogFile, IN_MODIFY); if (fileWatchDesc == -1) { BMCWEB_LOG_ERROR << "inotify_add_watch failed for redfish log file."; // Don't return error if file not exist. // Watch on directory will handle create/delete of file. } // monitor redfish event log file inotifyConn->assign(inotifyFd); watchRedfishEventLogFile(); return 0; } #endif static void getReadingsForReport(sdbusplus::message_t& msg) { if (msg.is_method_error()) { BMCWEB_LOG_ERROR << "TelemetryMonitor Signal error"; return; } sdbusplus::message::object_path path(msg.get_path()); std::string id = path.filename(); if (id.empty()) { BMCWEB_LOG_ERROR << "Failed to get Id from path"; return; } std::string interface; dbus::utility::DBusPropertiesMap props; std::vector invalidProps; msg.read(interface, props, invalidProps); auto found = std::find_if(props.begin(), props.end(), [](const auto& x) { return x.first == "Readings"; }); if (found == props.end()) { BMCWEB_LOG_INFO << "Failed to get Readings from Report properties"; return; } const telemetry::TimestampReadings* readings = std::get_if(&found->second); if (readings == nullptr) { BMCWEB_LOG_INFO << "Failed to get Readings from Report properties"; return; } for (const auto& it : EventServiceManager::getInstance().subscriptionsMap) { Subscription& entry = *it.second; if (entry.eventFormatType == metricReportFormatType) { entry.filterAndSendReports(id, *readings); } } } void unregisterMetricReportSignal() { if (matchTelemetryMonitor) { BMCWEB_LOG_DEBUG << "Metrics report signal - Unregister"; matchTelemetryMonitor.reset(); matchTelemetryMonitor = nullptr; } } void registerMetricReportSignal() { if (!serviceEnabled || matchTelemetryMonitor) { BMCWEB_LOG_DEBUG << "Not registering metric report signal."; return; } BMCWEB_LOG_DEBUG << "Metrics report signal - Register"; std::string matchStr = "type='signal',member='PropertiesChanged'," "interface='org.freedesktop.DBus.Properties'," "arg0=xyz.openbmc_project.Telemetry.Report"; matchTelemetryMonitor = std::make_shared( *crow::connections::systemBus, matchStr, getReadingsForReport); } }; } // namespace redfish