11da66f75SEd Tanous /* 21da66f75SEd Tanous // Copyright (c) 2018 Intel Corporation 31da66f75SEd Tanous // 41da66f75SEd Tanous // Licensed under the Apache License, Version 2.0 (the "License"); 51da66f75SEd Tanous // you may not use this file except in compliance with the License. 61da66f75SEd Tanous // You may obtain a copy of the License at 71da66f75SEd Tanous // 81da66f75SEd Tanous // http://www.apache.org/licenses/LICENSE-2.0 91da66f75SEd Tanous // 101da66f75SEd Tanous // Unless required by applicable law or agreed to in writing, software 111da66f75SEd Tanous // distributed under the License is distributed on an "AS IS" BASIS, 121da66f75SEd Tanous // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131da66f75SEd Tanous // See the License for the specific language governing permissions and 141da66f75SEd Tanous // limitations under the License. 151da66f75SEd Tanous */ 161da66f75SEd Tanous #pragma once 171da66f75SEd Tanous 181da66f75SEd Tanous #include "node.hpp" 194851d45dSJason M. Bills #include "registries.hpp" 204851d45dSJason M. Bills #include "registries/base_message_registry.hpp" 214851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp" 221da66f75SEd Tanous 23e1f26343SJason M. Bills #include <systemd/sd-journal.h> 24e1f26343SJason M. Bills 254851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp> 264851d45dSJason M. Bills #include <boost/beast/core/span.hpp> 271da66f75SEd Tanous #include <boost/container/flat_map.hpp> 28cb92c03bSAndrew Geissler #include <error_messages.hpp> 294418c7f0SJames Feist #include <filesystem> 30cd225da8SJason M. Bills #include <string_view> 31abf2add6SEd Tanous #include <variant> 321da66f75SEd Tanous 331da66f75SEd Tanous namespace redfish 341da66f75SEd Tanous { 351da66f75SEd Tanous 36424c4176SJason M. Bills constexpr char const *CrashdumpObject = "com.intel.crashdump"; 37424c4176SJason M. Bills constexpr char const *CrashdumpPath = "/com/intel/crashdump"; 38424c4176SJason M. Bills constexpr char const *CrashdumpOnDemandPath = "/com/intel/crashdump/OnDemand"; 39424c4176SJason M. Bills constexpr char const *CrashdumpInterface = "com.intel.crashdump"; 40424c4176SJason M. Bills constexpr char const *CrashdumpOnDemandInterface = 41424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 42424c4176SJason M. Bills constexpr char const *CrashdumpRawPECIInterface = 43424c4176SJason M. Bills "com.intel.crashdump.SendRawPeci"; 441da66f75SEd Tanous 454851d45dSJason M. Bills namespace message_registries 464851d45dSJason M. Bills { 474851d45dSJason M. Bills static const Message *getMessageFromRegistry( 484851d45dSJason M. Bills const std::string &messageKey, 494851d45dSJason M. Bills const boost::beast::span<const MessageEntry> registry) 504851d45dSJason M. Bills { 514851d45dSJason M. Bills boost::beast::span<const MessageEntry>::const_iterator messageIt = 524851d45dSJason M. Bills std::find_if(registry.cbegin(), registry.cend(), 534851d45dSJason M. Bills [&messageKey](const MessageEntry &messageEntry) { 544851d45dSJason M. Bills return !std::strcmp(messageEntry.first, 554851d45dSJason M. Bills messageKey.c_str()); 564851d45dSJason M. Bills }); 574851d45dSJason M. Bills if (messageIt != registry.cend()) 584851d45dSJason M. Bills { 594851d45dSJason M. Bills return &messageIt->second; 604851d45dSJason M. Bills } 614851d45dSJason M. Bills 624851d45dSJason M. Bills return nullptr; 634851d45dSJason M. Bills } 644851d45dSJason M. Bills 654851d45dSJason M. Bills static const Message *getMessage(const std::string_view &messageID) 664851d45dSJason M. Bills { 674851d45dSJason M. Bills // Redfish MessageIds are in the form 684851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 694851d45dSJason M. Bills // the right Message 704851d45dSJason M. Bills std::vector<std::string> fields; 714851d45dSJason M. Bills fields.reserve(4); 724851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 734851d45dSJason M. Bills std::string ®istryName = fields[0]; 744851d45dSJason M. Bills std::string &messageKey = fields[3]; 754851d45dSJason M. Bills 764851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 774851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 784851d45dSJason M. Bills { 794851d45dSJason M. Bills return getMessageFromRegistry( 804851d45dSJason M. Bills messageKey, boost::beast::span<const MessageEntry>(base::registry)); 814851d45dSJason M. Bills } 824851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 834851d45dSJason M. Bills { 844851d45dSJason M. Bills return getMessageFromRegistry( 854851d45dSJason M. Bills messageKey, 864851d45dSJason M. Bills boost::beast::span<const MessageEntry>(openbmc::registry)); 874851d45dSJason M. Bills } 884851d45dSJason M. Bills return nullptr; 894851d45dSJason M. Bills } 904851d45dSJason M. Bills } // namespace message_registries 914851d45dSJason M. Bills 92f6150403SJames Feist namespace fs = std::filesystem; 931da66f75SEd Tanous 94cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map< 95cb92c03bSAndrew Geissler std::string, 96cb92c03bSAndrew Geissler sdbusplus::message::variant<std::string, bool, uint8_t, int16_t, uint16_t, 97cb92c03bSAndrew Geissler int32_t, uint32_t, int64_t, uint64_t, double>>; 98cb92c03bSAndrew Geissler 99cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map< 100cb92c03bSAndrew Geissler sdbusplus::message::object_path, 101cb92c03bSAndrew Geissler boost::container::flat_map<std::string, GetManagedPropertyType>>; 102cb92c03bSAndrew Geissler 103cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string &s) 104cb92c03bSAndrew Geissler { 105cb92c03bSAndrew Geissler if (s == "xyz.openbmc_project.Logging.Entry.Level.Alert") 106cb92c03bSAndrew Geissler { 107cb92c03bSAndrew Geissler return "Critical"; 108cb92c03bSAndrew Geissler } 109cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") 110cb92c03bSAndrew Geissler { 111cb92c03bSAndrew Geissler return "Critical"; 112cb92c03bSAndrew Geissler } 113cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Debug") 114cb92c03bSAndrew Geissler { 115cb92c03bSAndrew Geissler return "OK"; 116cb92c03bSAndrew Geissler } 117cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") 118cb92c03bSAndrew Geissler { 119cb92c03bSAndrew Geissler return "Critical"; 120cb92c03bSAndrew Geissler } 121cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Error") 122cb92c03bSAndrew Geissler { 123cb92c03bSAndrew Geissler return "Critical"; 124cb92c03bSAndrew Geissler } 125cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") 126cb92c03bSAndrew Geissler { 127cb92c03bSAndrew Geissler return "OK"; 128cb92c03bSAndrew Geissler } 129cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Notice") 130cb92c03bSAndrew Geissler { 131cb92c03bSAndrew Geissler return "OK"; 132cb92c03bSAndrew Geissler } 133cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 134cb92c03bSAndrew Geissler { 135cb92c03bSAndrew Geissler return "Warning"; 136cb92c03bSAndrew Geissler } 137cb92c03bSAndrew Geissler return ""; 138cb92c03bSAndrew Geissler } 139cb92c03bSAndrew Geissler 14016428a1aSJason M. Bills static int getJournalMetadata(sd_journal *journal, 14139e77504SEd Tanous const std::string_view &field, 14239e77504SEd Tanous std::string_view &contents) 14316428a1aSJason M. Bills { 14416428a1aSJason M. Bills const char *data = nullptr; 14516428a1aSJason M. Bills size_t length = 0; 14616428a1aSJason M. Bills int ret = 0; 14716428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 148b01bf299SEd Tanous ret = sd_journal_get_data(journal, field.data(), (const void **)&data, 149b01bf299SEd Tanous &length); 15016428a1aSJason M. Bills if (ret < 0) 15116428a1aSJason M. Bills { 15216428a1aSJason M. Bills return ret; 15316428a1aSJason M. Bills } 15439e77504SEd Tanous contents = std::string_view(data, length); 15516428a1aSJason M. Bills // Only use the content after the "=" character. 15616428a1aSJason M. Bills contents.remove_prefix(std::min(contents.find("=") + 1, contents.size())); 15716428a1aSJason M. Bills return ret; 15816428a1aSJason M. Bills } 15916428a1aSJason M. Bills 16016428a1aSJason M. Bills static int getJournalMetadata(sd_journal *journal, 16139e77504SEd Tanous const std::string_view &field, const int &base, 16216428a1aSJason M. Bills int &contents) 16316428a1aSJason M. Bills { 16416428a1aSJason M. Bills int ret = 0; 16539e77504SEd Tanous std::string_view metadata; 16616428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 16716428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 16816428a1aSJason M. Bills if (ret < 0) 16916428a1aSJason M. Bills { 17016428a1aSJason M. Bills return ret; 17116428a1aSJason M. Bills } 172b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 17316428a1aSJason M. Bills return ret; 17416428a1aSJason M. Bills } 17516428a1aSJason M. Bills 17616428a1aSJason M. Bills static bool getEntryTimestamp(sd_journal *journal, std::string &entryTimestamp) 17716428a1aSJason M. Bills { 17816428a1aSJason M. Bills int ret = 0; 17916428a1aSJason M. Bills uint64_t timestamp = 0; 18016428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, ×tamp); 18116428a1aSJason M. Bills if (ret < 0) 18216428a1aSJason M. Bills { 18316428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 18416428a1aSJason M. Bills << strerror(-ret); 18516428a1aSJason M. Bills return false; 18616428a1aSJason M. Bills } 18716428a1aSJason M. Bills time_t t = 18816428a1aSJason M. Bills static_cast<time_t>(timestamp / 1000 / 1000); // Convert from us to s 18916428a1aSJason M. Bills struct tm *loctime = localtime(&t); 19016428a1aSJason M. Bills char entryTime[64] = {}; 19116428a1aSJason M. Bills if (NULL != loctime) 19216428a1aSJason M. Bills { 19316428a1aSJason M. Bills strftime(entryTime, sizeof(entryTime), "%FT%T%z", loctime); 19416428a1aSJason M. Bills } 19516428a1aSJason M. Bills // Insert the ':' into the timezone 19639e77504SEd Tanous std::string_view t1(entryTime); 19739e77504SEd Tanous std::string_view t2(entryTime); 19816428a1aSJason M. Bills if (t1.size() > 2 && t2.size() > 2) 19916428a1aSJason M. Bills { 20016428a1aSJason M. Bills t1.remove_suffix(2); 20116428a1aSJason M. Bills t2.remove_prefix(t2.size() - 2); 20216428a1aSJason M. Bills } 20339e77504SEd Tanous entryTimestamp = std::string(t1) + ":" + std::string(t2); 20416428a1aSJason M. Bills return true; 20516428a1aSJason M. Bills } 20616428a1aSJason M. Bills 20716428a1aSJason M. Bills static bool getSkipParam(crow::Response &res, const crow::Request &req, 20816428a1aSJason M. Bills long &skip) 20916428a1aSJason M. Bills { 21016428a1aSJason M. Bills char *skipParam = req.urlParams.get("$skip"); 21116428a1aSJason M. Bills if (skipParam != nullptr) 21216428a1aSJason M. Bills { 21316428a1aSJason M. Bills char *ptr = nullptr; 21416428a1aSJason M. Bills skip = std::strtol(skipParam, &ptr, 10); 21516428a1aSJason M. Bills if (*skipParam == '\0' || *ptr != '\0') 21616428a1aSJason M. Bills { 21716428a1aSJason M. Bills 21816428a1aSJason M. Bills messages::queryParameterValueTypeError(res, std::string(skipParam), 21916428a1aSJason M. Bills "$skip"); 22016428a1aSJason M. Bills return false; 22116428a1aSJason M. Bills } 22216428a1aSJason M. Bills if (skip < 0) 22316428a1aSJason M. Bills { 22416428a1aSJason M. Bills 22516428a1aSJason M. Bills messages::queryParameterOutOfRange(res, std::to_string(skip), 22616428a1aSJason M. Bills "$skip", "greater than 0"); 22716428a1aSJason M. Bills return false; 22816428a1aSJason M. Bills } 22916428a1aSJason M. Bills } 23016428a1aSJason M. Bills return true; 23116428a1aSJason M. Bills } 23216428a1aSJason M. Bills 23316428a1aSJason M. Bills static constexpr const long maxEntriesPerPage = 1000; 23416428a1aSJason M. Bills static bool getTopParam(crow::Response &res, const crow::Request &req, 23516428a1aSJason M. Bills long &top) 23616428a1aSJason M. Bills { 23716428a1aSJason M. Bills char *topParam = req.urlParams.get("$top"); 23816428a1aSJason M. Bills if (topParam != nullptr) 23916428a1aSJason M. Bills { 24016428a1aSJason M. Bills char *ptr = nullptr; 24116428a1aSJason M. Bills top = std::strtol(topParam, &ptr, 10); 24216428a1aSJason M. Bills if (*topParam == '\0' || *ptr != '\0') 24316428a1aSJason M. Bills { 24416428a1aSJason M. Bills messages::queryParameterValueTypeError(res, std::string(topParam), 24516428a1aSJason M. Bills "$top"); 24616428a1aSJason M. Bills return false; 24716428a1aSJason M. Bills } 24816428a1aSJason M. Bills if (top < 1 || top > maxEntriesPerPage) 24916428a1aSJason M. Bills { 25016428a1aSJason M. Bills 25116428a1aSJason M. Bills messages::queryParameterOutOfRange( 25216428a1aSJason M. Bills res, std::to_string(top), "$top", 25316428a1aSJason M. Bills "1-" + std::to_string(maxEntriesPerPage)); 25416428a1aSJason M. Bills return false; 25516428a1aSJason M. Bills } 25616428a1aSJason M. Bills } 25716428a1aSJason M. Bills return true; 25816428a1aSJason M. Bills } 25916428a1aSJason M. Bills 26016428a1aSJason M. Bills static bool getUniqueEntryID(sd_journal *journal, std::string &entryID) 26116428a1aSJason M. Bills { 26216428a1aSJason M. Bills int ret = 0; 26316428a1aSJason M. Bills static uint64_t prevTs = 0; 26416428a1aSJason M. Bills static int index = 0; 26516428a1aSJason M. Bills // Get the entry timestamp 26616428a1aSJason M. Bills uint64_t curTs = 0; 26716428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 26816428a1aSJason M. Bills if (ret < 0) 26916428a1aSJason M. Bills { 27016428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 27116428a1aSJason M. Bills << strerror(-ret); 27216428a1aSJason M. Bills return false; 27316428a1aSJason M. Bills } 27416428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 27516428a1aSJason M. Bills if (curTs == prevTs) 27616428a1aSJason M. Bills { 27716428a1aSJason M. Bills index++; 27816428a1aSJason M. Bills } 27916428a1aSJason M. Bills else 28016428a1aSJason M. Bills { 28116428a1aSJason M. Bills // Otherwise, reset it 28216428a1aSJason M. Bills index = 0; 28316428a1aSJason M. Bills } 28416428a1aSJason M. Bills // Save the timestamp 28516428a1aSJason M. Bills prevTs = curTs; 28616428a1aSJason M. Bills 28716428a1aSJason M. Bills entryID = std::to_string(curTs); 28816428a1aSJason M. Bills if (index > 0) 28916428a1aSJason M. Bills { 29016428a1aSJason M. Bills entryID += "_" + std::to_string(index); 29116428a1aSJason M. Bills } 29216428a1aSJason M. Bills return true; 29316428a1aSJason M. Bills } 29416428a1aSJason M. Bills 29595820184SJason M. Bills static bool getUniqueEntryID(const std::string &logEntry, std::string &entryID) 29695820184SJason M. Bills { 29795820184SJason M. Bills static uint64_t prevTs = 0; 29895820184SJason M. Bills static int index = 0; 29995820184SJason M. Bills // Get the entry timestamp 30095820184SJason M. Bills uint64_t curTs = 0; 30195820184SJason M. Bills std::tm timeStruct = {}; 30295820184SJason M. Bills std::istringstream entryStream(logEntry); 30395820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 30495820184SJason M. Bills { 30595820184SJason M. Bills curTs = std::mktime(&timeStruct); 30695820184SJason M. Bills } 30795820184SJason M. Bills // If the timestamp isn't unique, increment the index 30895820184SJason M. Bills if (curTs == prevTs) 30995820184SJason M. Bills { 31095820184SJason M. Bills index++; 31195820184SJason M. Bills } 31295820184SJason M. Bills else 31395820184SJason M. Bills { 31495820184SJason M. Bills // Otherwise, reset it 31595820184SJason M. Bills index = 0; 31695820184SJason M. Bills } 31795820184SJason M. Bills // Save the timestamp 31895820184SJason M. Bills prevTs = curTs; 31995820184SJason M. Bills 32095820184SJason M. Bills entryID = std::to_string(curTs); 32195820184SJason M. Bills if (index > 0) 32295820184SJason M. Bills { 32395820184SJason M. Bills entryID += "_" + std::to_string(index); 32495820184SJason M. Bills } 32595820184SJason M. Bills return true; 32695820184SJason M. Bills } 32795820184SJason M. Bills 32816428a1aSJason M. Bills static bool getTimestampFromID(crow::Response &res, const std::string &entryID, 32916428a1aSJason M. Bills uint64_t ×tamp, uint16_t &index) 33016428a1aSJason M. Bills { 33116428a1aSJason M. Bills if (entryID.empty()) 33216428a1aSJason M. Bills { 33316428a1aSJason M. Bills return false; 33416428a1aSJason M. Bills } 33516428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 33639e77504SEd Tanous std::string_view tsStr(entryID); 33716428a1aSJason M. Bills 33816428a1aSJason M. Bills auto underscorePos = tsStr.find("_"); 33916428a1aSJason M. Bills if (underscorePos != tsStr.npos) 34016428a1aSJason M. Bills { 34116428a1aSJason M. Bills // Timestamp has an index 34216428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 34339e77504SEd Tanous std::string_view indexStr(entryID); 34416428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 34516428a1aSJason M. Bills std::size_t pos; 34616428a1aSJason M. Bills try 34716428a1aSJason M. Bills { 34839e77504SEd Tanous index = std::stoul(std::string(indexStr), &pos); 34916428a1aSJason M. Bills } 350b01bf299SEd Tanous catch (std::invalid_argument) 35116428a1aSJason M. Bills { 35216428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 35316428a1aSJason M. Bills return false; 35416428a1aSJason M. Bills } 355b01bf299SEd Tanous catch (std::out_of_range) 35616428a1aSJason M. Bills { 35716428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 35816428a1aSJason M. Bills return false; 35916428a1aSJason M. Bills } 36016428a1aSJason M. Bills if (pos != indexStr.size()) 36116428a1aSJason M. Bills { 36216428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 36316428a1aSJason M. Bills return false; 36416428a1aSJason M. Bills } 36516428a1aSJason M. Bills } 36616428a1aSJason M. Bills // Timestamp has no index 36716428a1aSJason M. Bills std::size_t pos; 36816428a1aSJason M. Bills try 36916428a1aSJason M. Bills { 37039e77504SEd Tanous timestamp = std::stoull(std::string(tsStr), &pos); 37116428a1aSJason M. Bills } 372b01bf299SEd Tanous catch (std::invalid_argument) 37316428a1aSJason M. Bills { 37416428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 37516428a1aSJason M. Bills return false; 37616428a1aSJason M. Bills } 377b01bf299SEd Tanous catch (std::out_of_range) 37816428a1aSJason M. Bills { 37916428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 38016428a1aSJason M. Bills return false; 38116428a1aSJason M. Bills } 38216428a1aSJason M. Bills if (pos != tsStr.size()) 38316428a1aSJason M. Bills { 38416428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 38516428a1aSJason M. Bills return false; 38616428a1aSJason M. Bills } 38716428a1aSJason M. Bills return true; 38816428a1aSJason M. Bills } 38916428a1aSJason M. Bills 39095820184SJason M. Bills static bool 39195820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path> &redfishLogFiles) 39295820184SJason M. Bills { 39395820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 39495820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 39595820184SJason M. Bills 39695820184SJason M. Bills // Loop through the directory looking for redfish log files 39795820184SJason M. Bills for (const std::filesystem::directory_entry &dirEnt : 39895820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 39995820184SJason M. Bills { 40095820184SJason M. Bills // If we find a redfish log file, save the path 40195820184SJason M. Bills std::string filename = dirEnt.path().filename(); 40295820184SJason M. Bills if (boost::starts_with(filename, redfishLogFilename)) 40395820184SJason M. Bills { 40495820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 40595820184SJason M. Bills } 40695820184SJason M. Bills } 40795820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 40895820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 40995820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 41095820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 41195820184SJason M. Bills 41295820184SJason M. Bills return !redfishLogFiles.empty(); 41395820184SJason M. Bills } 41495820184SJason M. Bills 415c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node 4161da66f75SEd Tanous { 4171da66f75SEd Tanous public: 4181da66f75SEd Tanous template <typename CrowApp> 419c4bf6374SJason M. Bills SystemLogServiceCollection(CrowApp &app) : 420029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/") 421c4bf6374SJason M. Bills { 422c4bf6374SJason M. Bills entityPrivileges = { 423c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 424c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 425c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 426c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 427c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 428c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 429c4bf6374SJason M. Bills } 430c4bf6374SJason M. Bills 431c4bf6374SJason M. Bills private: 432c4bf6374SJason M. Bills /** 433c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 434c4bf6374SJason M. Bills */ 435c4bf6374SJason M. Bills void doGet(crow::Response &res, const crow::Request &req, 436c4bf6374SJason M. Bills const std::vector<std::string> ¶ms) override 437c4bf6374SJason M. Bills { 438c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 439c4bf6374SJason M. Bills // Collections don't include the static data added by SubRoute because 440c4bf6374SJason M. Bills // it has a duplicate entry for members 441c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 442c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 443c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 444c4bf6374SJason M. Bills "/redfish/v1/$metadata#LogServiceCollection.LogServiceCollection"; 445c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 446029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 447c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 448c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 449c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 450c4bf6374SJason M. Bills nlohmann::json &logServiceArray = asyncResp->res.jsonValue["Members"]; 451c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 452029573d4SEd Tanous logServiceArray.push_back( 453029573d4SEd Tanous {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}}); 454d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 455d53dd41fSJason M. Bills logServiceArray.push_back( 456cb92c03bSAndrew Geissler {{ "@odata.id", 457424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump" }}); 458d53dd41fSJason M. Bills #endif 459c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 460c4bf6374SJason M. Bills logServiceArray.size(); 461c4bf6374SJason M. Bills } 462c4bf6374SJason M. Bills }; 463c4bf6374SJason M. Bills 464c4bf6374SJason M. Bills class EventLogService : public Node 465c4bf6374SJason M. Bills { 466c4bf6374SJason M. Bills public: 467c4bf6374SJason M. Bills template <typename CrowApp> 468c4bf6374SJason M. Bills EventLogService(CrowApp &app) : 469029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 470c4bf6374SJason M. Bills { 471c4bf6374SJason M. Bills entityPrivileges = { 472c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 473c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 474c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 475c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 476c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 477c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 478c4bf6374SJason M. Bills } 479c4bf6374SJason M. Bills 480c4bf6374SJason M. Bills private: 481c4bf6374SJason M. Bills void doGet(crow::Response &res, const crow::Request &req, 482c4bf6374SJason M. Bills const std::vector<std::string> ¶ms) override 483c4bf6374SJason M. Bills { 484c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 485c4bf6374SJason M. Bills 486c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 487029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 488c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 489c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 490c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 491c4bf6374SJason M. Bills "/redfish/v1/$metadata#LogService.LogService"; 492c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 493c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 494c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "Event Log"; 495c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 496c4bf6374SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 497c4bf6374SJason M. Bills {"@odata.id", 498029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}}; 499*489640c6SJason M. Bills asyncResp->res.jsonValue["Actions"] = { 500*489640c6SJason M. Bills {{"#LogService.ClearLog", 501*489640c6SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/EventLog/" 502*489640c6SJason M. Bills "Actions/LogService.ClearLog"}}}}}; 503*489640c6SJason M. Bills } 504*489640c6SJason M. Bills }; 505*489640c6SJason M. Bills 506*489640c6SJason M. Bills class EventLogClear : public Node 507*489640c6SJason M. Bills { 508*489640c6SJason M. Bills public: 509*489640c6SJason M. Bills EventLogClear(CrowApp &app) : 510*489640c6SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 511*489640c6SJason M. Bills "LogService.ClearLog/") 512*489640c6SJason M. Bills { 513*489640c6SJason M. Bills entityPrivileges = { 514*489640c6SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 515*489640c6SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 516*489640c6SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 517*489640c6SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 518*489640c6SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 519*489640c6SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 520*489640c6SJason M. Bills } 521*489640c6SJason M. Bills 522*489640c6SJason M. Bills private: 523*489640c6SJason M. Bills void doPost(crow::Response &res, const crow::Request &req, 524*489640c6SJason M. Bills const std::vector<std::string> ¶ms) override 525*489640c6SJason M. Bills { 526*489640c6SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 527*489640c6SJason M. Bills 528*489640c6SJason M. Bills // Clear the EventLog by deleting the log files 529*489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 530*489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 531*489640c6SJason M. Bills { 532*489640c6SJason M. Bills for (const std::filesystem::path &file : redfishLogFiles) 533*489640c6SJason M. Bills { 534*489640c6SJason M. Bills std::error_code ec; 535*489640c6SJason M. Bills std::filesystem::remove(file, ec); 536*489640c6SJason M. Bills } 537*489640c6SJason M. Bills } 538*489640c6SJason M. Bills 539*489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 540*489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 541*489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 542*489640c6SJason M. Bills if (ec) 543*489640c6SJason M. Bills { 544*489640c6SJason M. Bills BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; 545*489640c6SJason M. Bills messages::internalError(asyncResp->res); 546*489640c6SJason M. Bills return; 547*489640c6SJason M. Bills } 548*489640c6SJason M. Bills 549*489640c6SJason M. Bills messages::success(asyncResp->res); 550*489640c6SJason M. Bills }, 551*489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 552*489640c6SJason M. Bills "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 553*489640c6SJason M. Bills "replace"); 554c4bf6374SJason M. Bills } 555c4bf6374SJason M. Bills }; 556c4bf6374SJason M. Bills 55795820184SJason M. Bills static int fillEventLogEntryJson(const std::string &logEntryID, 55895820184SJason M. Bills const std::string logEntry, 55995820184SJason M. Bills nlohmann::json &logEntryJson) 560c4bf6374SJason M. Bills { 56195820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 562cd225da8SJason M. Bills // First get the Timestamp 563cd225da8SJason M. Bills size_t space = logEntry.find_first_of(" "); 564cd225da8SJason M. Bills if (space == std::string::npos) 56595820184SJason M. Bills { 56695820184SJason M. Bills return 1; 56795820184SJason M. Bills } 568cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 569cd225da8SJason M. Bills // Then get the log contents 570cd225da8SJason M. Bills size_t entryStart = logEntry.find_first_not_of(" ", space); 571cd225da8SJason M. Bills if (entryStart == std::string::npos) 572cd225da8SJason M. Bills { 573cd225da8SJason M. Bills return 1; 574cd225da8SJason M. Bills } 575cd225da8SJason M. Bills std::string_view entry(logEntry); 576cd225da8SJason M. Bills entry.remove_prefix(entryStart); 577cd225da8SJason M. Bills // Use split to separate the entry into its fields 578cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 579cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 580cd225da8SJason M. Bills boost::token_compress_on); 581cd225da8SJason M. Bills // We need at least a MessageId to be valid 582cd225da8SJason M. Bills if (logEntryFields.size() < 1) 583cd225da8SJason M. Bills { 584cd225da8SJason M. Bills return 1; 585cd225da8SJason M. Bills } 586cd225da8SJason M. Bills std::string &messageID = logEntryFields[0]; 587cd225da8SJason M. Bills std::string &messageArgsStart = logEntryFields[1]; 588cd225da8SJason M. Bills std::size_t messageArgsSize = logEntryFields.size() - 1; 58995820184SJason M. Bills 5904851d45dSJason M. Bills // Get the Message from the MessageRegistry 5914851d45dSJason M. Bills const message_registries::Message *message = 5924851d45dSJason M. Bills message_registries::getMessage(messageID); 593c4bf6374SJason M. Bills 5944851d45dSJason M. Bills std::string msg; 5954851d45dSJason M. Bills std::string severity; 5964851d45dSJason M. Bills if (message != nullptr) 597c4bf6374SJason M. Bills { 5984851d45dSJason M. Bills msg = message->message; 5994851d45dSJason M. Bills severity = message->severity; 600c4bf6374SJason M. Bills } 601c4bf6374SJason M. Bills 60295820184SJason M. Bills // Get the MessageArgs from the log 60395820184SJason M. Bills boost::beast::span messageArgs(&messageArgsStart, messageArgsSize); 604c4bf6374SJason M. Bills 6054851d45dSJason M. Bills // Fill the MessageArgs into the Message 60695820184SJason M. Bills int i = 0; 60795820184SJason M. Bills for (const std::string &messageArg : messageArgs) 6084851d45dSJason M. Bills { 60995820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 6104851d45dSJason M. Bills size_t argPos = msg.find(argStr); 6114851d45dSJason M. Bills if (argPos != std::string::npos) 6124851d45dSJason M. Bills { 61395820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 6144851d45dSJason M. Bills } 6154851d45dSJason M. Bills } 6164851d45dSJason M. Bills 61795820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 61895820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 61995820184SJason M. Bills // between the '.' and the '+', so just remove them. 62095820184SJason M. Bills std::size_t dot = timestamp.find_first_of("."); 62195820184SJason M. Bills std::size_t plus = timestamp.find_first_of("+"); 62295820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 623c4bf6374SJason M. Bills { 62495820184SJason M. Bills timestamp.erase(dot, plus - dot); 625c4bf6374SJason M. Bills } 626c4bf6374SJason M. Bills 627c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 62895820184SJason M. Bills logEntryJson = { 629cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 630c4bf6374SJason M. Bills {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"}, 631029573d4SEd Tanous {"@odata.id", 63295820184SJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/#" + 63395820184SJason M. Bills logEntryID}, 634c4bf6374SJason M. Bills {"Name", "System Event Log Entry"}, 63595820184SJason M. Bills {"Id", logEntryID}, 63695820184SJason M. Bills {"Message", std::move(msg)}, 63795820184SJason M. Bills {"MessageId", std::move(messageID)}, 638c4bf6374SJason M. Bills {"MessageArgs", std::move(messageArgs)}, 639c4bf6374SJason M. Bills {"EntryType", "Event"}, 64095820184SJason M. Bills {"Severity", std::move(severity)}, 64195820184SJason M. Bills {"Created", std::move(timestamp)}}; 642c4bf6374SJason M. Bills return 0; 643c4bf6374SJason M. Bills } 644c4bf6374SJason M. Bills 645c4bf6374SJason M. Bills class EventLogEntryCollection : public Node 646c4bf6374SJason M. Bills { 647c4bf6374SJason M. Bills public: 648c4bf6374SJason M. Bills template <typename CrowApp> 649c4bf6374SJason M. Bills EventLogEntryCollection(CrowApp &app) : 650029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 651c4bf6374SJason M. Bills { 652c4bf6374SJason M. Bills entityPrivileges = { 653c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 654c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 655c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 656c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 657c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 658c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 659c4bf6374SJason M. Bills } 660c4bf6374SJason M. Bills 661c4bf6374SJason M. Bills private: 662c4bf6374SJason M. Bills void doGet(crow::Response &res, const crow::Request &req, 663c4bf6374SJason M. Bills const std::vector<std::string> ¶ms) override 664c4bf6374SJason M. Bills { 665c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 666c4bf6374SJason M. Bills long skip = 0; 667c4bf6374SJason M. Bills long top = maxEntriesPerPage; // Show max entries by default 668c4bf6374SJason M. Bills if (!getSkipParam(asyncResp->res, req, skip)) 669c4bf6374SJason M. Bills { 670c4bf6374SJason M. Bills return; 671c4bf6374SJason M. Bills } 672c4bf6374SJason M. Bills if (!getTopParam(asyncResp->res, req, top)) 673c4bf6374SJason M. Bills { 674c4bf6374SJason M. Bills return; 675c4bf6374SJason M. Bills } 676c4bf6374SJason M. Bills // Collections don't include the static data added by SubRoute because 677c4bf6374SJason M. Bills // it has a duplicate entry for members 678c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 679c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 680c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 681c4bf6374SJason M. Bills "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection"; 682c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 683029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 684c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 685c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 686c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 687cb92c03bSAndrew Geissler 688cb92c03bSAndrew Geissler #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 689c4bf6374SJason M. Bills nlohmann::json &logEntryArray = asyncResp->res.jsonValue["Members"]; 690c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 69195820184SJason M. Bills // Go through the log files and create a unique ID for each entry 69295820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 69395820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 694b01bf299SEd Tanous uint64_t entryCount = 0; 695cd225da8SJason M. Bills std::string logEntry; 69695820184SJason M. Bills 69795820184SJason M. Bills // Oldest logs are in the last file, so start there and loop backwards 698cd225da8SJason M. Bills for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 699cd225da8SJason M. Bills it++) 700c4bf6374SJason M. Bills { 701cd225da8SJason M. Bills std::ifstream logStream(*it); 70295820184SJason M. Bills if (!logStream.is_open()) 703c4bf6374SJason M. Bills { 704c4bf6374SJason M. Bills continue; 705c4bf6374SJason M. Bills } 706c4bf6374SJason M. Bills 70795820184SJason M. Bills while (std::getline(logStream, logEntry)) 70895820184SJason M. Bills { 709c4bf6374SJason M. Bills entryCount++; 710c4bf6374SJason M. Bills // Handle paging using skip (number of entries to skip from the 711c4bf6374SJason M. Bills // start) and top (number of entries to display) 712c4bf6374SJason M. Bills if (entryCount <= skip || entryCount > skip + top) 713c4bf6374SJason M. Bills { 714c4bf6374SJason M. Bills continue; 715c4bf6374SJason M. Bills } 716c4bf6374SJason M. Bills 717c4bf6374SJason M. Bills std::string idStr; 71895820184SJason M. Bills if (!getUniqueEntryID(logEntry, idStr)) 719c4bf6374SJason M. Bills { 720c4bf6374SJason M. Bills continue; 721c4bf6374SJason M. Bills } 722c4bf6374SJason M. Bills 723c4bf6374SJason M. Bills logEntryArray.push_back({}); 724c4bf6374SJason M. Bills nlohmann::json &bmcLogEntry = logEntryArray.back(); 72595820184SJason M. Bills if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0) 726c4bf6374SJason M. Bills { 727c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 728c4bf6374SJason M. Bills return; 729c4bf6374SJason M. Bills } 730c4bf6374SJason M. Bills } 73195820184SJason M. Bills } 732c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 733c4bf6374SJason M. Bills if (skip + top < entryCount) 734c4bf6374SJason M. Bills { 735c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 73695820184SJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/" 73795820184SJason M. Bills "Entries?$skip=" + 738c4bf6374SJason M. Bills std::to_string(skip + top); 739c4bf6374SJason M. Bills } 740cb92c03bSAndrew Geissler #else 741cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 742cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 743cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 744cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 745cb92c03bSAndrew Geissler GetManagedObjectsType &resp) { 746cb92c03bSAndrew Geissler if (ec) 747cb92c03bSAndrew Geissler { 748cb92c03bSAndrew Geissler // TODO Handle for specific error code 749cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 750cb92c03bSAndrew Geissler << "getLogEntriesIfaceData resp_handler got error " 751cb92c03bSAndrew Geissler << ec; 752cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 753cb92c03bSAndrew Geissler return; 754cb92c03bSAndrew Geissler } 755cb92c03bSAndrew Geissler nlohmann::json &entriesArray = 756cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members"]; 757cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 758cb92c03bSAndrew Geissler for (auto &objectPath : resp) 759cb92c03bSAndrew Geissler { 760cb92c03bSAndrew Geissler for (auto &interfaceMap : objectPath.second) 761cb92c03bSAndrew Geissler { 762cb92c03bSAndrew Geissler if (interfaceMap.first != 763cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging.Entry") 764cb92c03bSAndrew Geissler { 765cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Bailing early on " 766cb92c03bSAndrew Geissler << interfaceMap.first; 767cb92c03bSAndrew Geissler continue; 768cb92c03bSAndrew Geissler } 769cb92c03bSAndrew Geissler entriesArray.push_back({}); 770cb92c03bSAndrew Geissler nlohmann::json &thisEntry = entriesArray.back(); 771cb92c03bSAndrew Geissler uint32_t *id; 772cb92c03bSAndrew Geissler std::time_t timestamp; 773cb92c03bSAndrew Geissler std::string *severity, *message; 774cb92c03bSAndrew Geissler bool *resolved; 775cb92c03bSAndrew Geissler for (auto &propertyMap : interfaceMap.second) 776cb92c03bSAndrew Geissler { 777cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 778cb92c03bSAndrew Geissler { 779cb92c03bSAndrew Geissler id = sdbusplus::message::variant_ns::get_if< 780cb92c03bSAndrew Geissler uint32_t>(&propertyMap.second); 781cb92c03bSAndrew Geissler if (id == nullptr) 782cb92c03bSAndrew Geissler { 783cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, 784cb92c03bSAndrew Geissler "Id"); 785cb92c03bSAndrew Geissler } 786cb92c03bSAndrew Geissler } 787cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 788cb92c03bSAndrew Geissler { 789cb92c03bSAndrew Geissler const uint64_t *millisTimeStamp = 790cb92c03bSAndrew Geissler std::get_if<uint64_t>(&propertyMap.second); 791cb92c03bSAndrew Geissler if (millisTimeStamp == nullptr) 792cb92c03bSAndrew Geissler { 793cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, 794cb92c03bSAndrew Geissler "Timestamp"); 795cb92c03bSAndrew Geissler } 796cb92c03bSAndrew Geissler // Retrieve Created property with format: 797cb92c03bSAndrew Geissler // yyyy-mm-ddThh:mm:ss 798cb92c03bSAndrew Geissler std::chrono::milliseconds chronoTimeStamp( 799cb92c03bSAndrew Geissler *millisTimeStamp); 800cb92c03bSAndrew Geissler timestamp = 801cb92c03bSAndrew Geissler std::chrono::duration_cast< 802cb92c03bSAndrew Geissler std::chrono::seconds>(chronoTimeStamp) 803cb92c03bSAndrew Geissler .count(); 804cb92c03bSAndrew Geissler } 805cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 806cb92c03bSAndrew Geissler { 807cb92c03bSAndrew Geissler severity = std::get_if<std::string>( 808cb92c03bSAndrew Geissler &propertyMap.second); 809cb92c03bSAndrew Geissler if (severity == nullptr) 810cb92c03bSAndrew Geissler { 811cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, 812cb92c03bSAndrew Geissler "Severity"); 813cb92c03bSAndrew Geissler } 814cb92c03bSAndrew Geissler } 815cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 816cb92c03bSAndrew Geissler { 817cb92c03bSAndrew Geissler message = std::get_if<std::string>( 818cb92c03bSAndrew Geissler &propertyMap.second); 819cb92c03bSAndrew Geissler if (message == nullptr) 820cb92c03bSAndrew Geissler { 821cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, 822cb92c03bSAndrew Geissler "Message"); 823cb92c03bSAndrew Geissler } 824cb92c03bSAndrew Geissler } 825cb92c03bSAndrew Geissler } 826cb92c03bSAndrew Geissler thisEntry = { 827cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 828cb92c03bSAndrew Geissler {"@odata.context", "/redfish/v1/" 829cb92c03bSAndrew Geissler "$metadata#LogEntry.LogEntry"}, 830cb92c03bSAndrew Geissler {"@odata.id", 831cb92c03bSAndrew Geissler "/redfish/v1/Systems/system/LogServices/EventLog/" 832cb92c03bSAndrew Geissler "Entries/" + 833cb92c03bSAndrew Geissler std::to_string(*id)}, 834cb92c03bSAndrew Geissler {"Name", "System DBus Event Log Entry"}, 835cb92c03bSAndrew Geissler {"Id", std::to_string(*id)}, 836cb92c03bSAndrew Geissler {"Message", *message}, 837cb92c03bSAndrew Geissler {"EntryType", "Event"}, 838cb92c03bSAndrew Geissler {"Severity", 839cb92c03bSAndrew Geissler translateSeverityDbusToRedfish(*severity)}, 840cb92c03bSAndrew Geissler {"Created", crow::utility::getDateTime(timestamp)}}; 841cb92c03bSAndrew Geissler } 842cb92c03bSAndrew Geissler } 843cb92c03bSAndrew Geissler std::sort(entriesArray.begin(), entriesArray.end(), 844cb92c03bSAndrew Geissler [](const nlohmann::json &left, 845cb92c03bSAndrew Geissler const nlohmann::json &right) { 846cb92c03bSAndrew Geissler return (left["Id"] <= right["Id"]); 847cb92c03bSAndrew Geissler }); 848cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members@odata.count"] = 849cb92c03bSAndrew Geissler entriesArray.size(); 850cb92c03bSAndrew Geissler }, 851cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 852cb92c03bSAndrew Geissler "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 853cb92c03bSAndrew Geissler #endif 854c4bf6374SJason M. Bills } 855c4bf6374SJason M. Bills }; 856c4bf6374SJason M. Bills 857c4bf6374SJason M. Bills class EventLogEntry : public Node 858c4bf6374SJason M. Bills { 859c4bf6374SJason M. Bills public: 860c4bf6374SJason M. Bills EventLogEntry(CrowApp &app) : 861c4bf6374SJason M. Bills Node(app, 862029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/", 863029573d4SEd Tanous std::string()) 864c4bf6374SJason M. Bills { 865c4bf6374SJason M. Bills entityPrivileges = { 866c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 867c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 868c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 869c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 870c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 871c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 872c4bf6374SJason M. Bills } 873c4bf6374SJason M. Bills 874c4bf6374SJason M. Bills private: 875c4bf6374SJason M. Bills void doGet(crow::Response &res, const crow::Request &req, 876c4bf6374SJason M. Bills const std::vector<std::string> ¶ms) override 877c4bf6374SJason M. Bills { 878c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 879029573d4SEd Tanous if (params.size() != 1) 880c4bf6374SJason M. Bills { 881c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 882c4bf6374SJason M. Bills return; 883c4bf6374SJason M. Bills } 884029573d4SEd Tanous const std::string &entryID = params[0]; 885cb92c03bSAndrew Geissler 88695820184SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 887cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 888cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 889cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 890cb92c03bSAndrew Geissler [asyncResp, entryID](const boost::system::error_code ec, 891cb92c03bSAndrew Geissler GetManagedPropertyType &resp) { 892cb92c03bSAndrew Geissler if (ec) 893cb92c03bSAndrew Geissler { 894cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 895cb92c03bSAndrew Geissler << "EventLogEntry (DBus) resp_handler got error " << ec; 896cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 897cb92c03bSAndrew Geissler return; 898cb92c03bSAndrew Geissler } 899cb92c03bSAndrew Geissler uint32_t *id; 900cb92c03bSAndrew Geissler std::time_t timestamp; 901cb92c03bSAndrew Geissler std::string *severity, *message; 902cb92c03bSAndrew Geissler bool *resolved; 903cb92c03bSAndrew Geissler for (auto &propertyMap : resp) 904cb92c03bSAndrew Geissler { 905cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 906cb92c03bSAndrew Geissler { 907cb92c03bSAndrew Geissler id = std::get_if<uint32_t>(&propertyMap.second); 908cb92c03bSAndrew Geissler if (id == nullptr) 909cb92c03bSAndrew Geissler { 910cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, "Id"); 911cb92c03bSAndrew Geissler } 912cb92c03bSAndrew Geissler } 913cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 914cb92c03bSAndrew Geissler { 915cb92c03bSAndrew Geissler const uint64_t *millisTimeStamp = 916cb92c03bSAndrew Geissler std::get_if<uint64_t>(&propertyMap.second); 917cb92c03bSAndrew Geissler if (millisTimeStamp == nullptr) 918cb92c03bSAndrew Geissler { 919cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, 920cb92c03bSAndrew Geissler "Timestamp"); 921cb92c03bSAndrew Geissler } 922cb92c03bSAndrew Geissler // Retrieve Created property with format: 923cb92c03bSAndrew Geissler // yyyy-mm-ddThh:mm:ss 924cb92c03bSAndrew Geissler std::chrono::milliseconds chronoTimeStamp( 925cb92c03bSAndrew Geissler *millisTimeStamp); 926cb92c03bSAndrew Geissler timestamp = 927cb92c03bSAndrew Geissler std::chrono::duration_cast<std::chrono::seconds>( 928cb92c03bSAndrew Geissler chronoTimeStamp) 929cb92c03bSAndrew Geissler .count(); 930cb92c03bSAndrew Geissler } 931cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 932cb92c03bSAndrew Geissler { 933cb92c03bSAndrew Geissler severity = 934cb92c03bSAndrew Geissler std::get_if<std::string>(&propertyMap.second); 935cb92c03bSAndrew Geissler if (severity == nullptr) 936cb92c03bSAndrew Geissler { 937cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, 938cb92c03bSAndrew Geissler "Severity"); 939cb92c03bSAndrew Geissler } 940cb92c03bSAndrew Geissler } 941cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 942cb92c03bSAndrew Geissler { 943cb92c03bSAndrew Geissler message = std::get_if<std::string>(&propertyMap.second); 944cb92c03bSAndrew Geissler if (message == nullptr) 945cb92c03bSAndrew Geissler { 946cb92c03bSAndrew Geissler messages::propertyMissing(asyncResp->res, 947cb92c03bSAndrew Geissler "Message"); 948cb92c03bSAndrew Geissler } 949cb92c03bSAndrew Geissler } 950cb92c03bSAndrew Geissler } 951cb92c03bSAndrew Geissler asyncResp->res.jsonValue = { 952cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 953cb92c03bSAndrew Geissler {"@odata.context", "/redfish/v1/" 954cb92c03bSAndrew Geissler "$metadata#LogEntry.LogEntry"}, 955cb92c03bSAndrew Geissler {"@odata.id", 956cb92c03bSAndrew Geissler "/redfish/v1/Systems/system/LogServices/EventLog/" 957cb92c03bSAndrew Geissler "Entries/" + 958cb92c03bSAndrew Geissler std::to_string(*id)}, 959cb92c03bSAndrew Geissler {"Name", "System DBus Event Log Entry"}, 960cb92c03bSAndrew Geissler {"Id", std::to_string(*id)}, 961cb92c03bSAndrew Geissler {"Message", *message}, 962cb92c03bSAndrew Geissler {"EntryType", "Event"}, 963cb92c03bSAndrew Geissler {"Severity", translateSeverityDbusToRedfish(*severity)}, 96495820184SJason M. Bills { "Created", 96595820184SJason M. Bills crow::utility::getDateTime(timestamp) }}; 966cb92c03bSAndrew Geissler }, 967cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", 968cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging/entry/" + entryID, 969cb92c03bSAndrew Geissler "org.freedesktop.DBus.Properties", "GetAll", 970cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging.Entry"); 971cb92c03bSAndrew Geissler #endif 972c4bf6374SJason M. Bills } 973c4bf6374SJason M. Bills }; 974c4bf6374SJason M. Bills 975c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node 976c4bf6374SJason M. Bills { 977c4bf6374SJason M. Bills public: 978c4bf6374SJason M. Bills template <typename CrowApp> 979c4bf6374SJason M. Bills BMCLogServiceCollection(CrowApp &app) : 9804ed77cd5SEd Tanous Node(app, "/redfish/v1/Managers/bmc/LogServices/") 9811da66f75SEd Tanous { 9821da66f75SEd Tanous entityPrivileges = { 983e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 984e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 985e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 986e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 987e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 988e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 9891da66f75SEd Tanous } 9901da66f75SEd Tanous 9911da66f75SEd Tanous private: 9921da66f75SEd Tanous /** 9931da66f75SEd Tanous * Functions triggers appropriate requests on DBus 9941da66f75SEd Tanous */ 9951da66f75SEd Tanous void doGet(crow::Response &res, const crow::Request &req, 9961da66f75SEd Tanous const std::vector<std::string> ¶ms) override 9971da66f75SEd Tanous { 998e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 9991da66f75SEd Tanous // Collections don't include the static data added by SubRoute because 10001da66f75SEd Tanous // it has a duplicate entry for members 1001e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 10021da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 1003e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 1004c4bf6374SJason M. Bills "/redfish/v1/$metadata#LogServiceCollection.LogServiceCollection"; 1005e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1006e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 1007e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 1008e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 10091da66f75SEd Tanous "Collection of LogServices for this Manager"; 1010c4bf6374SJason M. Bills nlohmann::json &logServiceArray = asyncResp->res.jsonValue["Members"]; 1011c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 1012c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 1013c4bf6374SJason M. Bills logServiceArray.push_back( 1014cb92c03bSAndrew Geissler {{ "@odata.id", 1015cb92c03bSAndrew Geissler "/redfish/v1/Managers/bmc/LogServices/Journal" }}); 1016c4bf6374SJason M. Bills #endif 1017e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1018c4bf6374SJason M. Bills logServiceArray.size(); 10191da66f75SEd Tanous } 10201da66f75SEd Tanous }; 10211da66f75SEd Tanous 1022c4bf6374SJason M. Bills class BMCJournalLogService : public Node 10231da66f75SEd Tanous { 10241da66f75SEd Tanous public: 10251da66f75SEd Tanous template <typename CrowApp> 1026c4bf6374SJason M. Bills BMCJournalLogService(CrowApp &app) : 1027c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 1028e1f26343SJason M. Bills { 1029e1f26343SJason M. Bills entityPrivileges = { 1030e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1031e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1032e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1033e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1034e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1035e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1036e1f26343SJason M. Bills } 1037e1f26343SJason M. Bills 1038e1f26343SJason M. Bills private: 1039e1f26343SJason M. Bills void doGet(crow::Response &res, const crow::Request &req, 1040e1f26343SJason M. Bills const std::vector<std::string> ¶ms) override 1041e1f26343SJason M. Bills { 1042e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1043e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1044e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 10450f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 10460f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 1047e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 1048e1f26343SJason M. Bills "/redfish/v1/$metadata#LogService.LogService"; 1049c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 1050c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 1051c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 1052e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 1053cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1054cd50aa42SJason M. Bills {"@odata.id", 1055086be238SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}}; 1056e1f26343SJason M. Bills } 1057e1f26343SJason M. Bills }; 1058e1f26343SJason M. Bills 1059c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string &bmcJournalLogEntryID, 1060e1f26343SJason M. Bills sd_journal *journal, 1061c4bf6374SJason M. Bills nlohmann::json &bmcJournalLogEntryJson) 1062e1f26343SJason M. Bills { 1063e1f26343SJason M. Bills // Get the Log Entry contents 1064e1f26343SJason M. Bills int ret = 0; 1065e1f26343SJason M. Bills 106639e77504SEd Tanous std::string_view msg; 106716428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 1068e1f26343SJason M. Bills if (ret < 0) 1069e1f26343SJason M. Bills { 1070e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 1071e1f26343SJason M. Bills return 1; 1072e1f26343SJason M. Bills } 1073e1f26343SJason M. Bills 1074e1f26343SJason M. Bills // Get the severity from the PRIORITY field 1075e1f26343SJason M. Bills int severity = 8; // Default to an invalid priority 107616428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 1077e1f26343SJason M. Bills if (ret < 0) 1078e1f26343SJason M. Bills { 1079e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 1080e1f26343SJason M. Bills return 1; 1081e1f26343SJason M. Bills } 1082e1f26343SJason M. Bills 1083e1f26343SJason M. Bills // Get the Created time from the timestamp 108416428a1aSJason M. Bills std::string entryTimeStr; 108516428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 1086e1f26343SJason M. Bills { 108716428a1aSJason M. Bills return 1; 1088e1f26343SJason M. Bills } 1089e1f26343SJason M. Bills 1090e1f26343SJason M. Bills // Fill in the log entry with the gathered data 1091c4bf6374SJason M. Bills bmcJournalLogEntryJson = { 1092cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1093e1f26343SJason M. Bills {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"}, 1094c4bf6374SJason M. Bills {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 1095c4bf6374SJason M. Bills bmcJournalLogEntryID}, 1096e1f26343SJason M. Bills {"Name", "BMC Journal Entry"}, 1097c4bf6374SJason M. Bills {"Id", bmcJournalLogEntryID}, 109816428a1aSJason M. Bills {"Message", msg}, 1099e1f26343SJason M. Bills {"EntryType", "Oem"}, 1100e1f26343SJason M. Bills {"Severity", 1101e1f26343SJason M. Bills severity <= 2 ? "Critical" 1102e1f26343SJason M. Bills : severity <= 4 ? "Warning" : severity <= 7 ? "OK" : ""}, 1103086be238SEd Tanous {"OemRecordFormat", "BMC Journal Entry"}, 1104e1f26343SJason M. Bills {"Created", std::move(entryTimeStr)}}; 1105e1f26343SJason M. Bills return 0; 1106e1f26343SJason M. Bills } 1107e1f26343SJason M. Bills 1108c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node 1109e1f26343SJason M. Bills { 1110e1f26343SJason M. Bills public: 1111e1f26343SJason M. Bills template <typename CrowApp> 1112c4bf6374SJason M. Bills BMCJournalLogEntryCollection(CrowApp &app) : 1113c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 1114e1f26343SJason M. Bills { 1115e1f26343SJason M. Bills entityPrivileges = { 1116e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1117e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1118e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1119e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1120e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1121e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1122e1f26343SJason M. Bills } 1123e1f26343SJason M. Bills 1124e1f26343SJason M. Bills private: 1125e1f26343SJason M. Bills void doGet(crow::Response &res, const crow::Request &req, 1126e1f26343SJason M. Bills const std::vector<std::string> ¶ms) override 1127e1f26343SJason M. Bills { 1128e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1129193ad2faSJason M. Bills static constexpr const long maxEntriesPerPage = 1000; 1130193ad2faSJason M. Bills long skip = 0; 1131193ad2faSJason M. Bills long top = maxEntriesPerPage; // Show max entries by default 113216428a1aSJason M. Bills if (!getSkipParam(asyncResp->res, req, skip)) 1133193ad2faSJason M. Bills { 1134193ad2faSJason M. Bills return; 1135193ad2faSJason M. Bills } 113616428a1aSJason M. Bills if (!getTopParam(asyncResp->res, req, top)) 1137193ad2faSJason M. Bills { 1138193ad2faSJason M. Bills return; 1139193ad2faSJason M. Bills } 1140e1f26343SJason M. Bills // Collections don't include the static data added by SubRoute because 1141e1f26343SJason M. Bills // it has a duplicate entry for members 1142e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1143e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 11440f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 11450f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 1146e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 1147c4bf6374SJason M. Bills "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection"; 1148e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1149c4bf6374SJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 1150e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 1151e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 1152e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 11530f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 11540f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries"; 1155e1f26343SJason M. Bills nlohmann::json &logEntryArray = asyncResp->res.jsonValue["Members"]; 1156e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 1157e1f26343SJason M. Bills 1158e1f26343SJason M. Bills // Go through the journal and use the timestamp to create a unique ID 1159e1f26343SJason M. Bills // for each entry 1160e1f26343SJason M. Bills sd_journal *journalTmp = nullptr; 1161e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 1162e1f26343SJason M. Bills if (ret < 0) 1163e1f26343SJason M. Bills { 1164e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 1165f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1166e1f26343SJason M. Bills return; 1167e1f26343SJason M. Bills } 1168e1f26343SJason M. Bills std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 1169e1f26343SJason M. Bills journalTmp, sd_journal_close); 1170e1f26343SJason M. Bills journalTmp = nullptr; 1171b01bf299SEd Tanous uint64_t entryCount = 0; 1172e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 1173e1f26343SJason M. Bills { 1174193ad2faSJason M. Bills entryCount++; 1175193ad2faSJason M. Bills // Handle paging using skip (number of entries to skip from the 1176193ad2faSJason M. Bills // start) and top (number of entries to display) 1177193ad2faSJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1178193ad2faSJason M. Bills { 1179193ad2faSJason M. Bills continue; 1180193ad2faSJason M. Bills } 1181193ad2faSJason M. Bills 118216428a1aSJason M. Bills std::string idStr; 118316428a1aSJason M. Bills if (!getUniqueEntryID(journal.get(), idStr)) 1184e1f26343SJason M. Bills { 1185e1f26343SJason M. Bills continue; 1186e1f26343SJason M. Bills } 1187e1f26343SJason M. Bills 1188e1f26343SJason M. Bills logEntryArray.push_back({}); 1189c4bf6374SJason M. Bills nlohmann::json &bmcJournalLogEntry = logEntryArray.back(); 1190c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 1191c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 1192e1f26343SJason M. Bills { 1193f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1194e1f26343SJason M. Bills return; 1195e1f26343SJason M. Bills } 1196e1f26343SJason M. Bills } 1197193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1198193ad2faSJason M. Bills if (skip + top < entryCount) 1199193ad2faSJason M. Bills { 1200193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 1201c4bf6374SJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 1202193ad2faSJason M. Bills std::to_string(skip + top); 1203193ad2faSJason M. Bills } 1204e1f26343SJason M. Bills } 1205e1f26343SJason M. Bills }; 1206e1f26343SJason M. Bills 1207c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node 1208e1f26343SJason M. Bills { 1209e1f26343SJason M. Bills public: 1210c4bf6374SJason M. Bills BMCJournalLogEntry(CrowApp &app) : 1211c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/", 1212e1f26343SJason M. Bills std::string()) 1213e1f26343SJason M. Bills { 1214e1f26343SJason M. Bills entityPrivileges = { 1215e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1216e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1217e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1218e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1219e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1220e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1221e1f26343SJason M. Bills } 1222e1f26343SJason M. Bills 1223e1f26343SJason M. Bills private: 1224e1f26343SJason M. Bills void doGet(crow::Response &res, const crow::Request &req, 1225e1f26343SJason M. Bills const std::vector<std::string> ¶ms) override 1226e1f26343SJason M. Bills { 1227e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1228e1f26343SJason M. Bills if (params.size() != 1) 1229e1f26343SJason M. Bills { 1230f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1231e1f26343SJason M. Bills return; 1232e1f26343SJason M. Bills } 123316428a1aSJason M. Bills const std::string &entryID = params[0]; 1234e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 1235e1f26343SJason M. Bills uint64_t ts = 0; 1236e1f26343SJason M. Bills uint16_t index = 0; 123716428a1aSJason M. Bills if (!getTimestampFromID(asyncResp->res, entryID, ts, index)) 1238e1f26343SJason M. Bills { 123916428a1aSJason M. Bills return; 1240e1f26343SJason M. Bills } 1241e1f26343SJason M. Bills 1242e1f26343SJason M. Bills sd_journal *journalTmp = nullptr; 1243e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 1244e1f26343SJason M. Bills if (ret < 0) 1245e1f26343SJason M. Bills { 1246e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 1247f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1248e1f26343SJason M. Bills return; 1249e1f26343SJason M. Bills } 1250e1f26343SJason M. Bills std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 1251e1f26343SJason M. Bills journalTmp, sd_journal_close); 1252e1f26343SJason M. Bills journalTmp = nullptr; 1253e1f26343SJason M. Bills // Go to the timestamp in the log and move to the entry at the index 1254e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 1255e1f26343SJason M. Bills for (int i = 0; i <= index; i++) 1256e1f26343SJason M. Bills { 1257e1f26343SJason M. Bills sd_journal_next(journal.get()); 1258e1f26343SJason M. Bills } 1259c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 1260c4bf6374SJason M. Bills std::string idStr; 1261c4bf6374SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr) || idStr != entryID) 1262c4bf6374SJason M. Bills { 1263c4bf6374SJason M. Bills messages::resourceMissingAtURI(asyncResp->res, entryID); 1264c4bf6374SJason M. Bills return; 1265c4bf6374SJason M. Bills } 1266c4bf6374SJason M. Bills 1267c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 1268e1f26343SJason M. Bills asyncResp->res.jsonValue) != 0) 1269e1f26343SJason M. Bills { 1270f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1271e1f26343SJason M. Bills return; 1272e1f26343SJason M. Bills } 1273e1f26343SJason M. Bills } 1274e1f26343SJason M. Bills }; 1275e1f26343SJason M. Bills 1276424c4176SJason M. Bills class CrashdumpService : public Node 1277e1f26343SJason M. Bills { 1278e1f26343SJason M. Bills public: 1279e1f26343SJason M. Bills template <typename CrowApp> 1280424c4176SJason M. Bills CrashdumpService(CrowApp &app) : 1281424c4176SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 12821da66f75SEd Tanous { 12831da66f75SEd Tanous entityPrivileges = { 1284e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1285e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1286e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1287e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1288e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1289e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 12901da66f75SEd Tanous } 12911da66f75SEd Tanous 12921da66f75SEd Tanous private: 12931da66f75SEd Tanous /** 12941da66f75SEd Tanous * Functions triggers appropriate requests on DBus 12951da66f75SEd Tanous */ 12961da66f75SEd Tanous void doGet(crow::Response &res, const crow::Request &req, 12971da66f75SEd Tanous const std::vector<std::string> ¶ms) override 12981da66f75SEd Tanous { 1299e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 13001da66f75SEd Tanous // Copy over the static data to include the entries added by SubRoute 13010f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 1302424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 1303e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1304e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 1305e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 1306c4bf6374SJason M. Bills "/redfish/v1/$metadata#LogService.LogService"; 1307424c4176SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Service"; 1308424c4176SJason M. Bills asyncResp->res.jsonValue["Description"] = "Crashdump Service"; 1309424c4176SJason M. Bills asyncResp->res.jsonValue["Id"] = "Crashdump"; 1310e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 1311e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 1312cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1313cd50aa42SJason M. Bills {"@odata.id", 1314424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}}; 1315e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"] = { 13161da66f75SEd Tanous {"Oem", 1317424c4176SJason M. Bills {{"#Crashdump.OnDemand", 1318424c4176SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 1319424c4176SJason M. Bills "Actions/Oem/Crashdump.OnDemand"}}}}}}; 13201da66f75SEd Tanous 13211da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI 1322e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"]["Oem"].push_back( 1323424c4176SJason M. Bills {"#Crashdump.SendRawPeci", 1324cb92c03bSAndrew Geissler { { "target", 1325424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/" 1326424c4176SJason M. Bills "Actions/Oem/Crashdump.SendRawPeci" } }}); 13271da66f75SEd Tanous #endif 13281da66f75SEd Tanous } 13291da66f75SEd Tanous }; 13301da66f75SEd Tanous 1331424c4176SJason M. Bills class CrashdumpEntryCollection : public Node 13321da66f75SEd Tanous { 13331da66f75SEd Tanous public: 13341da66f75SEd Tanous template <typename CrowApp> 1335424c4176SJason M. Bills CrashdumpEntryCollection(CrowApp &app) : 1336424c4176SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 13371da66f75SEd Tanous { 13381da66f75SEd Tanous entityPrivileges = { 1339e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1340e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1341e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1342e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1343e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1344e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 13451da66f75SEd Tanous } 13461da66f75SEd Tanous 13471da66f75SEd Tanous private: 13481da66f75SEd Tanous /** 13491da66f75SEd Tanous * Functions triggers appropriate requests on DBus 13501da66f75SEd Tanous */ 13511da66f75SEd Tanous void doGet(crow::Response &res, const crow::Request &req, 13521da66f75SEd Tanous const std::vector<std::string> ¶ms) override 13531da66f75SEd Tanous { 1354e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 13551da66f75SEd Tanous // Collections don't include the static data added by SubRoute because 13561da66f75SEd Tanous // it has a duplicate entry for members 1357e1f26343SJason M. Bills auto getLogEntriesCallback = [asyncResp]( 1358e1f26343SJason M. Bills const boost::system::error_code ec, 13591da66f75SEd Tanous const std::vector<std::string> &resp) { 13601da66f75SEd Tanous if (ec) 13611da66f75SEd Tanous { 13621da66f75SEd Tanous if (ec.value() != 13631da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 13641da66f75SEd Tanous { 13651da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 13661da66f75SEd Tanous << ec.message(); 1367f12894f8SJason M. Bills messages::internalError(asyncResp->res); 13681da66f75SEd Tanous return; 13691da66f75SEd Tanous } 13701da66f75SEd Tanous } 1371e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 13721da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 13730f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 1374424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 1375e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.context"] = 1376d53dd41fSJason M. Bills "/redfish/v1/" 1377d53dd41fSJason M. Bills "$metadata#LogEntryCollection.LogEntryCollection"; 1378424c4176SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 1379e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 1380424c4176SJason M. Bills "Collection of Crashdump Entries"; 1381e1f26343SJason M. Bills nlohmann::json &logEntryArray = asyncResp->res.jsonValue["Members"]; 1382e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 13831da66f75SEd Tanous for (const std::string &objpath : resp) 13841da66f75SEd Tanous { 138548e4639eSJason M. Bills // Don't list the on-demand log 1386424c4176SJason M. Bills if (objpath.compare(CrashdumpOnDemandPath) == 0) 13871da66f75SEd Tanous { 13881da66f75SEd Tanous continue; 13891da66f75SEd Tanous } 13904ed77cd5SEd Tanous std::size_t lastPos = objpath.rfind("/"); 13914ed77cd5SEd Tanous if (lastPos != std::string::npos) 13921da66f75SEd Tanous { 1393e1f26343SJason M. Bills logEntryArray.push_back( 1394d53dd41fSJason M. Bills {{"@odata.id", "/redfish/v1/Systems/system/LogServices/" 1395424c4176SJason M. Bills "Crashdump/Entries/" + 13964ed77cd5SEd Tanous objpath.substr(lastPos + 1)}}); 13971da66f75SEd Tanous } 13981da66f75SEd Tanous } 1399e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1400e1f26343SJason M. Bills logEntryArray.size(); 14011da66f75SEd Tanous }; 14021da66f75SEd Tanous crow::connections::systemBus->async_method_call( 14031da66f75SEd Tanous std::move(getLogEntriesCallback), 14041da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 14051da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 14061da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 1407424c4176SJason M. Bills std::array<const char *, 1>{CrashdumpInterface}); 14081da66f75SEd Tanous } 14091da66f75SEd Tanous }; 14101da66f75SEd Tanous 1411424c4176SJason M. Bills std::string getLogCreatedTime(const nlohmann::json &Crashdump) 14121da66f75SEd Tanous { 1413424c4176SJason M. Bills nlohmann::json::const_iterator cdIt = Crashdump.find("crashlog_data"); 1414424c4176SJason M. Bills if (cdIt != Crashdump.end()) 14151da66f75SEd Tanous { 1416c4d00437SJason M. Bills nlohmann::json::const_iterator siIt = cdIt->find("SYSTEM_INFO"); 1417c4d00437SJason M. Bills if (siIt != cdIt->end()) 14181da66f75SEd Tanous { 1419c4d00437SJason M. Bills nlohmann::json::const_iterator tsIt = siIt->find("timestamp"); 1420c4d00437SJason M. Bills if (tsIt != siIt->end()) 1421c4d00437SJason M. Bills { 1422c4d00437SJason M. Bills const std::string *logTime = 1423c4d00437SJason M. Bills tsIt->get_ptr<const std::string *>(); 14241da66f75SEd Tanous if (logTime != nullptr) 14251da66f75SEd Tanous { 14261da66f75SEd Tanous return *logTime; 14271da66f75SEd Tanous } 14281da66f75SEd Tanous } 14291da66f75SEd Tanous } 1430c4d00437SJason M. Bills } 14311da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to find log timestamp"; 14321da66f75SEd Tanous 14331da66f75SEd Tanous return std::string(); 14341da66f75SEd Tanous } 14351da66f75SEd Tanous 1436424c4176SJason M. Bills class CrashdumpEntry : public Node 14371da66f75SEd Tanous { 14381da66f75SEd Tanous public: 1439424c4176SJason M. Bills CrashdumpEntry(CrowApp &app) : 1440d53dd41fSJason M. Bills Node(app, 1441424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/", 14421da66f75SEd Tanous std::string()) 14431da66f75SEd Tanous { 14441da66f75SEd Tanous entityPrivileges = { 1445e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1446e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1447e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1448e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1449e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1450e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 14511da66f75SEd Tanous } 14521da66f75SEd Tanous 14531da66f75SEd Tanous private: 14541da66f75SEd Tanous void doGet(crow::Response &res, const crow::Request &req, 14551da66f75SEd Tanous const std::vector<std::string> ¶ms) override 14561da66f75SEd Tanous { 1457e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 14581da66f75SEd Tanous if (params.size() != 1) 14591da66f75SEd Tanous { 1460f12894f8SJason M. Bills messages::internalError(asyncResp->res); 14611da66f75SEd Tanous return; 14621da66f75SEd Tanous } 1463b01bf299SEd Tanous const uint8_t logId = std::atoi(params[0].c_str()); 1464abf2add6SEd Tanous auto getStoredLogCallback = [asyncResp, logId]( 1465abf2add6SEd Tanous const boost::system::error_code ec, 1466abf2add6SEd Tanous const std::variant<std::string> &resp) { 14671da66f75SEd Tanous if (ec) 14681da66f75SEd Tanous { 1469abf2add6SEd Tanous BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 1470f12894f8SJason M. Bills messages::internalError(asyncResp->res); 14711da66f75SEd Tanous return; 14721da66f75SEd Tanous } 1473abf2add6SEd Tanous const std::string *log = std::get_if<std::string>(&resp); 14741da66f75SEd Tanous if (log == nullptr) 14751da66f75SEd Tanous { 1476f12894f8SJason M. Bills messages::internalError(asyncResp->res); 14771da66f75SEd Tanous return; 14781da66f75SEd Tanous } 14791da66f75SEd Tanous nlohmann::json j = nlohmann::json::parse(*log, nullptr, false); 14801da66f75SEd Tanous if (j.is_discarded()) 14811da66f75SEd Tanous { 1482f12894f8SJason M. Bills messages::internalError(asyncResp->res); 14831da66f75SEd Tanous return; 14841da66f75SEd Tanous } 14851da66f75SEd Tanous std::string t = getLogCreatedTime(j); 1486e1f26343SJason M. Bills asyncResp->res.jsonValue = { 1487cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1488abf2add6SEd Tanous {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"}, 14891da66f75SEd Tanous {"@odata.id", 1490424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 14914ed77cd5SEd Tanous std::to_string(logId)}, 1492424c4176SJason M. Bills {"Name", "CPU Crashdump"}, 14934ed77cd5SEd Tanous {"Id", logId}, 14941da66f75SEd Tanous {"EntryType", "Oem"}, 1495424c4176SJason M. Bills {"OemRecordFormat", "Intel Crashdump"}, 14961da66f75SEd Tanous {"Oem", {{"Intel", std::move(j)}}}, 14971da66f75SEd Tanous {"Created", std::move(t)}}; 14981da66f75SEd Tanous }; 14991da66f75SEd Tanous crow::connections::systemBus->async_method_call( 1500424c4176SJason M. Bills std::move(getStoredLogCallback), CrashdumpObject, 1501424c4176SJason M. Bills CrashdumpPath + std::string("/") + std::to_string(logId), 1502424c4176SJason M. Bills "org.freedesktop.DBus.Properties", "Get", CrashdumpInterface, 1503424c4176SJason M. Bills "Log"); 15041da66f75SEd Tanous } 15051da66f75SEd Tanous }; 15061da66f75SEd Tanous 1507424c4176SJason M. Bills class OnDemandCrashdump : public Node 15081da66f75SEd Tanous { 15091da66f75SEd Tanous public: 1510424c4176SJason M. Bills OnDemandCrashdump(CrowApp &app) : 1511424c4176SJason M. Bills Node(app, 1512424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 1513424c4176SJason M. Bills "Crashdump.OnDemand/") 15141da66f75SEd Tanous { 15151da66f75SEd Tanous entityPrivileges = { 1516e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1517e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1518e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1519e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1520e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1521e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 15221da66f75SEd Tanous } 15231da66f75SEd Tanous 15241da66f75SEd Tanous private: 15251da66f75SEd Tanous void doPost(crow::Response &res, const crow::Request &req, 15261da66f75SEd Tanous const std::vector<std::string> ¶ms) override 15271da66f75SEd Tanous { 1528e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 152948e4639eSJason M. Bills static std::unique_ptr<sdbusplus::bus::match::match> onDemandLogMatcher; 15301da66f75SEd Tanous 153148e4639eSJason M. Bills // Only allow one OnDemand Log request at a time 153248e4639eSJason M. Bills if (onDemandLogMatcher != nullptr) 15331da66f75SEd Tanous { 1534e1f26343SJason M. Bills asyncResp->res.addHeader("Retry-After", "30"); 1535f12894f8SJason M. Bills messages::serviceTemporarilyUnavailable(asyncResp->res, "30"); 15361da66f75SEd Tanous return; 15371da66f75SEd Tanous } 15381da66f75SEd Tanous // Make this static so it survives outside this method 15391da66f75SEd Tanous static boost::asio::deadline_timer timeout(*req.ioService); 15401da66f75SEd Tanous 15411da66f75SEd Tanous timeout.expires_from_now(boost::posix_time::seconds(30)); 1542e1f26343SJason M. Bills timeout.async_wait([asyncResp](const boost::system::error_code &ec) { 154348e4639eSJason M. Bills onDemandLogMatcher = nullptr; 15441da66f75SEd Tanous if (ec) 15451da66f75SEd Tanous { 15461da66f75SEd Tanous // operation_aborted is expected if timer is canceled before 15471da66f75SEd Tanous // completion. 15481da66f75SEd Tanous if (ec != boost::asio::error::operation_aborted) 15491da66f75SEd Tanous { 15501da66f75SEd Tanous BMCWEB_LOG_ERROR << "Async_wait failed " << ec; 15511da66f75SEd Tanous } 15521da66f75SEd Tanous return; 15531da66f75SEd Tanous } 155448e4639eSJason M. Bills BMCWEB_LOG_ERROR << "Timed out waiting for on-demand log"; 15551da66f75SEd Tanous 1556f12894f8SJason M. Bills messages::internalError(asyncResp->res); 15571da66f75SEd Tanous }); 15581da66f75SEd Tanous 155948e4639eSJason M. Bills auto onDemandLogMatcherCallback = [asyncResp]( 15601da66f75SEd Tanous sdbusplus::message::message &m) { 156148e4639eSJason M. Bills BMCWEB_LOG_DEBUG << "OnDemand log available match fired"; 15621da66f75SEd Tanous boost::system::error_code ec; 15631da66f75SEd Tanous timeout.cancel(ec); 15641da66f75SEd Tanous if (ec) 15651da66f75SEd Tanous { 15661da66f75SEd Tanous BMCWEB_LOG_ERROR << "error canceling timer " << ec; 15671da66f75SEd Tanous } 15684ed77cd5SEd Tanous sdbusplus::message::object_path objPath; 15691da66f75SEd Tanous boost::container::flat_map< 1570abf2add6SEd Tanous std::string, boost::container::flat_map< 1571abf2add6SEd Tanous std::string, std::variant<std::string>>> 15724ed77cd5SEd Tanous interfacesAdded; 15734ed77cd5SEd Tanous m.read(objPath, interfacesAdded); 1574abf2add6SEd Tanous const std::string *log = std::get_if<std::string>( 1575424c4176SJason M. Bills &interfacesAdded[CrashdumpInterface]["Log"]); 15761da66f75SEd Tanous if (log == nullptr) 15771da66f75SEd Tanous { 1578f12894f8SJason M. Bills messages::internalError(asyncResp->res); 157948e4639eSJason M. Bills // Careful with onDemandLogMatcher. It is a unique_ptr to the 15801da66f75SEd Tanous // match object inside which this lambda is executing. Once it 15811da66f75SEd Tanous // is set to nullptr, the match object will be destroyed and the 15821da66f75SEd Tanous // lambda will lose its context, including res, so it needs to 15831da66f75SEd Tanous // be the last thing done. 158448e4639eSJason M. Bills onDemandLogMatcher = nullptr; 15851da66f75SEd Tanous return; 15861da66f75SEd Tanous } 15871da66f75SEd Tanous nlohmann::json j = nlohmann::json::parse(*log, nullptr, false); 15881da66f75SEd Tanous if (j.is_discarded()) 15891da66f75SEd Tanous { 1590f12894f8SJason M. Bills messages::internalError(asyncResp->res); 159148e4639eSJason M. Bills // Careful with onDemandLogMatcher. It is a unique_ptr to the 15921da66f75SEd Tanous // match object inside which this lambda is executing. Once it 15931da66f75SEd Tanous // is set to nullptr, the match object will be destroyed and the 15941da66f75SEd Tanous // lambda will lose its context, including res, so it needs to 15951da66f75SEd Tanous // be the last thing done. 159648e4639eSJason M. Bills onDemandLogMatcher = nullptr; 15971da66f75SEd Tanous return; 15981da66f75SEd Tanous } 15991da66f75SEd Tanous std::string t = getLogCreatedTime(j); 1600e1f26343SJason M. Bills asyncResp->res.jsonValue = { 1601cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 16021da66f75SEd Tanous {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"}, 1603424c4176SJason M. Bills {"Name", "CPU Crashdump"}, 16041da66f75SEd Tanous {"EntryType", "Oem"}, 1605424c4176SJason M. Bills {"OemRecordFormat", "Intel Crashdump"}, 16061da66f75SEd Tanous {"Oem", {{"Intel", std::move(j)}}}, 16071da66f75SEd Tanous {"Created", std::move(t)}}; 160848e4639eSJason M. Bills // Careful with onDemandLogMatcher. It is a unique_ptr to the 16091da66f75SEd Tanous // match object inside which this lambda is executing. Once it is 16101da66f75SEd Tanous // set to nullptr, the match object will be destroyed and the lambda 16111da66f75SEd Tanous // will lose its context, including res, so it needs to be the last 16121da66f75SEd Tanous // thing done. 161348e4639eSJason M. Bills onDemandLogMatcher = nullptr; 16141da66f75SEd Tanous }; 161548e4639eSJason M. Bills onDemandLogMatcher = std::make_unique<sdbusplus::bus::match::match>( 16161da66f75SEd Tanous *crow::connections::systemBus, 16171da66f75SEd Tanous sdbusplus::bus::match::rules::interfacesAdded() + 1618424c4176SJason M. Bills sdbusplus::bus::match::rules::argNpath(0, 1619424c4176SJason M. Bills CrashdumpOnDemandPath), 162048e4639eSJason M. Bills std::move(onDemandLogMatcherCallback)); 16211da66f75SEd Tanous 162248e4639eSJason M. Bills auto generateonDemandLogCallback = 1623e1f26343SJason M. Bills [asyncResp](const boost::system::error_code ec, 16241da66f75SEd Tanous const std::string &resp) { 16251da66f75SEd Tanous if (ec) 16261da66f75SEd Tanous { 16271da66f75SEd Tanous if (ec.value() == 16281da66f75SEd Tanous boost::system::errc::operation_not_supported) 16291da66f75SEd Tanous { 1630f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 16311da66f75SEd Tanous } 16321da66f75SEd Tanous else 16331da66f75SEd Tanous { 1634f12894f8SJason M. Bills messages::internalError(asyncResp->res); 16351da66f75SEd Tanous } 16361da66f75SEd Tanous boost::system::error_code timeoutec; 16371da66f75SEd Tanous timeout.cancel(timeoutec); 16381da66f75SEd Tanous if (timeoutec) 16391da66f75SEd Tanous { 16401da66f75SEd Tanous BMCWEB_LOG_ERROR << "error canceling timer " 16411da66f75SEd Tanous << timeoutec; 16421da66f75SEd Tanous } 164348e4639eSJason M. Bills onDemandLogMatcher = nullptr; 16441da66f75SEd Tanous return; 16451da66f75SEd Tanous } 16461da66f75SEd Tanous }; 16471da66f75SEd Tanous crow::connections::systemBus->async_method_call( 1648424c4176SJason M. Bills std::move(generateonDemandLogCallback), CrashdumpObject, 1649424c4176SJason M. Bills CrashdumpPath, CrashdumpOnDemandInterface, "GenerateOnDemandLog"); 16501da66f75SEd Tanous } 16511da66f75SEd Tanous }; 16521da66f75SEd Tanous 1653e1f26343SJason M. Bills class SendRawPECI : public Node 16541da66f75SEd Tanous { 16551da66f75SEd Tanous public: 1656e1f26343SJason M. Bills SendRawPECI(CrowApp &app) : 1657424c4176SJason M. Bills Node(app, 1658424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 1659424c4176SJason M. Bills "Crashdump.SendRawPeci/") 16601da66f75SEd Tanous { 16611da66f75SEd Tanous entityPrivileges = { 16621da66f75SEd Tanous {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 16631da66f75SEd Tanous {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 16641da66f75SEd Tanous {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 16651da66f75SEd Tanous {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 16661da66f75SEd Tanous {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 16671da66f75SEd Tanous {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 16681da66f75SEd Tanous } 16691da66f75SEd Tanous 16701da66f75SEd Tanous private: 16711da66f75SEd Tanous void doPost(crow::Response &res, const crow::Request &req, 16721da66f75SEd Tanous const std::vector<std::string> ¶ms) override 16731da66f75SEd Tanous { 1674e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1675b1556427SEd Tanous uint8_t clientAddress = 0; 1676b1556427SEd Tanous uint8_t readLength = 0; 16771da66f75SEd Tanous std::vector<uint8_t> peciCommand; 1678b1556427SEd Tanous if (!json_util::readJson(req, res, "ClientAddress", clientAddress, 1679b1556427SEd Tanous "ReadLength", readLength, "PECICommand", 1680b1556427SEd Tanous peciCommand)) 16811da66f75SEd Tanous { 16821da66f75SEd Tanous return; 16831da66f75SEd Tanous } 1684b1556427SEd Tanous 16851da66f75SEd Tanous // Callback to return the Raw PECI response 1686e1f26343SJason M. Bills auto sendRawPECICallback = 1687e1f26343SJason M. Bills [asyncResp](const boost::system::error_code ec, 16881da66f75SEd Tanous const std::vector<uint8_t> &resp) { 16891da66f75SEd Tanous if (ec) 16901da66f75SEd Tanous { 16911da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to send PECI command ec: " 16921da66f75SEd Tanous << ec.message(); 1693f12894f8SJason M. Bills messages::internalError(asyncResp->res); 16941da66f75SEd Tanous return; 16951da66f75SEd Tanous } 1696e1f26343SJason M. Bills asyncResp->res.jsonValue = {{"Name", "PECI Command Response"}, 16971da66f75SEd Tanous {"PECIResponse", resp}}; 16981da66f75SEd Tanous }; 16991da66f75SEd Tanous // Call the SendRawPECI command with the provided data 17001da66f75SEd Tanous crow::connections::systemBus->async_method_call( 1701424c4176SJason M. Bills std::move(sendRawPECICallback), CrashdumpObject, CrashdumpPath, 1702424c4176SJason M. Bills CrashdumpRawPECIInterface, "SendRawPeci", clientAddress, readLength, 17034ed77cd5SEd Tanous peciCommand); 17041da66f75SEd Tanous } 17051da66f75SEd Tanous }; 17061da66f75SEd Tanous 1707cb92c03bSAndrew Geissler /** 1708cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 1709cb92c03bSAndrew Geissler */ 1710cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node 1711cb92c03bSAndrew Geissler { 1712cb92c03bSAndrew Geissler public: 1713cb92c03bSAndrew Geissler DBusLogServiceActionsClear(CrowApp &app) : 1714cb92c03bSAndrew Geissler Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 1715cb92c03bSAndrew Geissler "LogService.Reset") 1716cb92c03bSAndrew Geissler { 1717cb92c03bSAndrew Geissler entityPrivileges = { 1718cb92c03bSAndrew Geissler {boost::beast::http::verb::get, {{"Login"}}}, 1719cb92c03bSAndrew Geissler {boost::beast::http::verb::head, {{"Login"}}}, 1720cb92c03bSAndrew Geissler {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1721cb92c03bSAndrew Geissler {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1722cb92c03bSAndrew Geissler {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1723cb92c03bSAndrew Geissler {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1724cb92c03bSAndrew Geissler } 1725cb92c03bSAndrew Geissler 1726cb92c03bSAndrew Geissler private: 1727cb92c03bSAndrew Geissler /** 1728cb92c03bSAndrew Geissler * Function handles POST method request. 1729cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 1730cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 1731cb92c03bSAndrew Geissler */ 1732cb92c03bSAndrew Geissler void doPost(crow::Response &res, const crow::Request &req, 1733cb92c03bSAndrew Geissler const std::vector<std::string> ¶ms) override 1734cb92c03bSAndrew Geissler { 1735cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 1736cb92c03bSAndrew Geissler 1737cb92c03bSAndrew Geissler auto asyncResp = std::make_shared<AsyncResp>(res); 1738cb92c03bSAndrew Geissler // Process response from Logging service. 1739cb92c03bSAndrew Geissler auto resp_handler = [asyncResp](const boost::system::error_code ec) { 1740cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 1741cb92c03bSAndrew Geissler if (ec) 1742cb92c03bSAndrew Geissler { 1743cb92c03bSAndrew Geissler // TODO Handle for specific error code 1744cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 1745cb92c03bSAndrew Geissler asyncResp->res.result( 1746cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 1747cb92c03bSAndrew Geissler return; 1748cb92c03bSAndrew Geissler } 1749cb92c03bSAndrew Geissler 1750cb92c03bSAndrew Geissler asyncResp->res.result(boost::beast::http::status::no_content); 1751cb92c03bSAndrew Geissler }; 1752cb92c03bSAndrew Geissler 1753cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 1754cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1755cb92c03bSAndrew Geissler resp_handler, "xyz.openbmc_project.Logging", 1756cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 1757cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 1758cb92c03bSAndrew Geissler } 1759cb92c03bSAndrew Geissler }; 17601da66f75SEd Tanous } // namespace redfish 1761