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" 2246229577SJames Feist #include "task.hpp" 231da66f75SEd Tanous 24e1f26343SJason M. Bills #include <systemd/sd-journal.h> 25e1f26343SJason M. Bills 264851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp> 274851d45dSJason M. Bills #include <boost/beast/core/span.hpp> 281da66f75SEd Tanous #include <boost/container/flat_map.hpp> 291ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 30cb92c03bSAndrew Geissler #include <error_messages.hpp> 311214b7e7SGunnar Mills 324418c7f0SJames Feist #include <filesystem> 33cd225da8SJason M. Bills #include <string_view> 34abf2add6SEd Tanous #include <variant> 351da66f75SEd Tanous 361da66f75SEd Tanous namespace redfish 371da66f75SEd Tanous { 381da66f75SEd Tanous 395b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump"; 405b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump"; 415b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump"; 425b61b5e8SJason M. Bills constexpr char const* deleteAllInterface = 435b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 445b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface = 45424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 465b61b5e8SJason M. Bills constexpr char const* crashdumpRawPECIInterface = 47424c4176SJason M. Bills "com.intel.crashdump.SendRawPeci"; 486eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface = 496eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 501da66f75SEd Tanous 514851d45dSJason M. Bills namespace message_registries 524851d45dSJason M. Bills { 534851d45dSJason M. Bills static const Message* getMessageFromRegistry( 544851d45dSJason M. Bills const std::string& messageKey, 554851d45dSJason M. Bills const boost::beast::span<const MessageEntry> registry) 564851d45dSJason M. Bills { 574851d45dSJason M. Bills boost::beast::span<const MessageEntry>::const_iterator messageIt = 584851d45dSJason M. Bills std::find_if(registry.cbegin(), registry.cend(), 594851d45dSJason M. Bills [&messageKey](const MessageEntry& messageEntry) { 604851d45dSJason M. Bills return !std::strcmp(messageEntry.first, 614851d45dSJason M. Bills messageKey.c_str()); 624851d45dSJason M. Bills }); 634851d45dSJason M. Bills if (messageIt != registry.cend()) 644851d45dSJason M. Bills { 654851d45dSJason M. Bills return &messageIt->second; 664851d45dSJason M. Bills } 674851d45dSJason M. Bills 684851d45dSJason M. Bills return nullptr; 694851d45dSJason M. Bills } 704851d45dSJason M. Bills 714851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID) 724851d45dSJason M. Bills { 734851d45dSJason M. Bills // Redfish MessageIds are in the form 744851d45dSJason M. Bills // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 754851d45dSJason M. Bills // the right Message 764851d45dSJason M. Bills std::vector<std::string> fields; 774851d45dSJason M. Bills fields.reserve(4); 784851d45dSJason M. Bills boost::split(fields, messageID, boost::is_any_of(".")); 794851d45dSJason M. Bills std::string& registryName = fields[0]; 804851d45dSJason M. Bills std::string& messageKey = fields[3]; 814851d45dSJason M. Bills 824851d45dSJason M. Bills // Find the right registry and check it for the MessageKey 834851d45dSJason M. Bills if (std::string(base::header.registryPrefix) == registryName) 844851d45dSJason M. Bills { 854851d45dSJason M. Bills return getMessageFromRegistry( 864851d45dSJason M. Bills messageKey, boost::beast::span<const MessageEntry>(base::registry)); 874851d45dSJason M. Bills } 884851d45dSJason M. Bills if (std::string(openbmc::header.registryPrefix) == registryName) 894851d45dSJason M. Bills { 904851d45dSJason M. Bills return getMessageFromRegistry( 914851d45dSJason M. Bills messageKey, 924851d45dSJason M. Bills boost::beast::span<const MessageEntry>(openbmc::registry)); 934851d45dSJason M. Bills } 944851d45dSJason M. Bills return nullptr; 954851d45dSJason M. Bills } 964851d45dSJason M. Bills } // namespace message_registries 974851d45dSJason M. Bills 98f6150403SJames Feist namespace fs = std::filesystem; 991da66f75SEd Tanous 100cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map< 10119bd78d9SPatrick Williams std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t, 102cb92c03bSAndrew Geissler int32_t, uint32_t, int64_t, uint64_t, double>>; 103cb92c03bSAndrew Geissler 104cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map< 105cb92c03bSAndrew Geissler sdbusplus::message::object_path, 106cb92c03bSAndrew Geissler boost::container::flat_map<std::string, GetManagedPropertyType>>; 107cb92c03bSAndrew Geissler 108cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 109cb92c03bSAndrew Geissler { 110*d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 111*d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 112*d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 113*d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 114cb92c03bSAndrew Geissler { 115cb92c03bSAndrew Geissler return "Critical"; 116cb92c03bSAndrew Geissler } 117*d4d25793SEd Tanous else if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 118*d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 119*d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 120cb92c03bSAndrew Geissler { 121cb92c03bSAndrew Geissler return "OK"; 122cb92c03bSAndrew Geissler } 123cb92c03bSAndrew Geissler else if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 124cb92c03bSAndrew Geissler { 125cb92c03bSAndrew Geissler return "Warning"; 126cb92c03bSAndrew Geissler } 127cb92c03bSAndrew Geissler return ""; 128cb92c03bSAndrew Geissler } 129cb92c03bSAndrew Geissler 13016428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal, 13139e77504SEd Tanous const std::string_view& field, 13239e77504SEd Tanous std::string_view& contents) 13316428a1aSJason M. Bills { 13416428a1aSJason M. Bills const char* data = nullptr; 13516428a1aSJason M. Bills size_t length = 0; 13616428a1aSJason M. Bills int ret = 0; 13716428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 138271584abSEd Tanous ret = sd_journal_get_data(journal, field.data(), 139271584abSEd Tanous reinterpret_cast<const void**>(&data), &length); 14016428a1aSJason M. Bills if (ret < 0) 14116428a1aSJason M. Bills { 14216428a1aSJason M. Bills return ret; 14316428a1aSJason M. Bills } 14439e77504SEd Tanous contents = std::string_view(data, length); 14516428a1aSJason M. Bills // Only use the content after the "=" character. 14616428a1aSJason M. Bills contents.remove_prefix(std::min(contents.find("=") + 1, contents.size())); 14716428a1aSJason M. Bills return ret; 14816428a1aSJason M. Bills } 14916428a1aSJason M. Bills 15016428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal, 15139e77504SEd Tanous const std::string_view& field, const int& base, 152271584abSEd Tanous long int& contents) 15316428a1aSJason M. Bills { 15416428a1aSJason M. Bills int ret = 0; 15539e77504SEd Tanous std::string_view metadata; 15616428a1aSJason M. Bills // Get the metadata from the requested field of the journal entry 15716428a1aSJason M. Bills ret = getJournalMetadata(journal, field, metadata); 15816428a1aSJason M. Bills if (ret < 0) 15916428a1aSJason M. Bills { 16016428a1aSJason M. Bills return ret; 16116428a1aSJason M. Bills } 162b01bf299SEd Tanous contents = strtol(metadata.data(), nullptr, base); 16316428a1aSJason M. Bills return ret; 16416428a1aSJason M. Bills } 16516428a1aSJason M. Bills 166a3316fc6SZhikuiRen static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp) 167a3316fc6SZhikuiRen { 168a3316fc6SZhikuiRen int ret = 0; 169a3316fc6SZhikuiRen uint64_t timestamp = 0; 170a3316fc6SZhikuiRen ret = sd_journal_get_realtime_usec(journal, ×tamp); 171a3316fc6SZhikuiRen if (ret < 0) 172a3316fc6SZhikuiRen { 173a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 174a3316fc6SZhikuiRen << strerror(-ret); 175a3316fc6SZhikuiRen return false; 176a3316fc6SZhikuiRen } 1779c620e21SAsmitha Karunanithi entryTimestamp = crow::utility::getDateTime( 1789c620e21SAsmitha Karunanithi static_cast<std::time_t>(timestamp / 1000 / 1000)); 1799c620e21SAsmitha Karunanithi return true; 180a3316fc6SZhikuiRen } 181a3316fc6SZhikuiRen 18216428a1aSJason M. Bills static bool getSkipParam(crow::Response& res, const crow::Request& req, 183271584abSEd Tanous uint64_t& skip) 18416428a1aSJason M. Bills { 1855a7e877eSJames Feist boost::urls::url_view::params_type::iterator it = 1865a7e877eSJames Feist req.urlParams.find("$skip"); 1875a7e877eSJames Feist if (it != req.urlParams.end()) 18816428a1aSJason M. Bills { 1895a7e877eSJames Feist std::string skipParam = it->value(); 19016428a1aSJason M. Bills char* ptr = nullptr; 1915a7e877eSJames Feist skip = std::strtoul(skipParam.c_str(), &ptr, 10); 1925a7e877eSJames Feist if (skipParam.empty() || *ptr != '\0') 19316428a1aSJason M. Bills { 19416428a1aSJason M. Bills 19516428a1aSJason M. Bills messages::queryParameterValueTypeError(res, std::string(skipParam), 19616428a1aSJason M. Bills "$skip"); 19716428a1aSJason M. Bills return false; 19816428a1aSJason M. Bills } 19916428a1aSJason M. Bills } 20016428a1aSJason M. Bills return true; 20116428a1aSJason M. Bills } 20216428a1aSJason M. Bills 203271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000; 20416428a1aSJason M. Bills static bool getTopParam(crow::Response& res, const crow::Request& req, 205271584abSEd Tanous uint64_t& top) 20616428a1aSJason M. Bills { 2075a7e877eSJames Feist boost::urls::url_view::params_type::iterator it = 2085a7e877eSJames Feist req.urlParams.find("$top"); 2095a7e877eSJames Feist if (it != req.urlParams.end()) 21016428a1aSJason M. Bills { 2115a7e877eSJames Feist std::string topParam = it->value(); 21216428a1aSJason M. Bills char* ptr = nullptr; 2135a7e877eSJames Feist top = std::strtoul(topParam.c_str(), &ptr, 10); 2145a7e877eSJames Feist if (topParam.empty() || *ptr != '\0') 21516428a1aSJason M. Bills { 21616428a1aSJason M. Bills messages::queryParameterValueTypeError(res, std::string(topParam), 21716428a1aSJason M. Bills "$top"); 21816428a1aSJason M. Bills return false; 21916428a1aSJason M. Bills } 220271584abSEd Tanous if (top < 1U || top > maxEntriesPerPage) 22116428a1aSJason M. Bills { 22216428a1aSJason M. Bills 22316428a1aSJason M. Bills messages::queryParameterOutOfRange( 22416428a1aSJason M. Bills res, std::to_string(top), "$top", 22516428a1aSJason M. Bills "1-" + std::to_string(maxEntriesPerPage)); 22616428a1aSJason M. Bills return false; 22716428a1aSJason M. Bills } 22816428a1aSJason M. Bills } 22916428a1aSJason M. Bills return true; 23016428a1aSJason M. Bills } 23116428a1aSJason M. Bills 232e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, 233e85d6b16SJason M. Bills const bool firstEntry = true) 23416428a1aSJason M. Bills { 23516428a1aSJason M. Bills int ret = 0; 23616428a1aSJason M. Bills static uint64_t prevTs = 0; 23716428a1aSJason M. Bills static int index = 0; 238e85d6b16SJason M. Bills if (firstEntry) 239e85d6b16SJason M. Bills { 240e85d6b16SJason M. Bills prevTs = 0; 241e85d6b16SJason M. Bills } 242e85d6b16SJason M. Bills 24316428a1aSJason M. Bills // Get the entry timestamp 24416428a1aSJason M. Bills uint64_t curTs = 0; 24516428a1aSJason M. Bills ret = sd_journal_get_realtime_usec(journal, &curTs); 24616428a1aSJason M. Bills if (ret < 0) 24716428a1aSJason M. Bills { 24816428a1aSJason M. Bills BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " 24916428a1aSJason M. Bills << strerror(-ret); 25016428a1aSJason M. Bills return false; 25116428a1aSJason M. Bills } 25216428a1aSJason M. Bills // If the timestamp isn't unique, increment the index 25316428a1aSJason M. Bills if (curTs == prevTs) 25416428a1aSJason M. Bills { 25516428a1aSJason M. Bills index++; 25616428a1aSJason M. Bills } 25716428a1aSJason M. Bills else 25816428a1aSJason M. Bills { 25916428a1aSJason M. Bills // Otherwise, reset it 26016428a1aSJason M. Bills index = 0; 26116428a1aSJason M. Bills } 26216428a1aSJason M. Bills // Save the timestamp 26316428a1aSJason M. Bills prevTs = curTs; 26416428a1aSJason M. Bills 26516428a1aSJason M. Bills entryID = std::to_string(curTs); 26616428a1aSJason M. Bills if (index > 0) 26716428a1aSJason M. Bills { 26816428a1aSJason M. Bills entryID += "_" + std::to_string(index); 26916428a1aSJason M. Bills } 27016428a1aSJason M. Bills return true; 27116428a1aSJason M. Bills } 27216428a1aSJason M. Bills 273e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 274e85d6b16SJason M. Bills const bool firstEntry = true) 27595820184SJason M. Bills { 276271584abSEd Tanous static time_t prevTs = 0; 27795820184SJason M. Bills static int index = 0; 278e85d6b16SJason M. Bills if (firstEntry) 279e85d6b16SJason M. Bills { 280e85d6b16SJason M. Bills prevTs = 0; 281e85d6b16SJason M. Bills } 282e85d6b16SJason M. Bills 28395820184SJason M. Bills // Get the entry timestamp 284271584abSEd Tanous std::time_t curTs = 0; 28595820184SJason M. Bills std::tm timeStruct = {}; 28695820184SJason M. Bills std::istringstream entryStream(logEntry); 28795820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 28895820184SJason M. Bills { 28995820184SJason M. Bills curTs = std::mktime(&timeStruct); 29095820184SJason M. Bills } 29195820184SJason M. Bills // If the timestamp isn't unique, increment the index 29295820184SJason M. Bills if (curTs == prevTs) 29395820184SJason M. Bills { 29495820184SJason M. Bills index++; 29595820184SJason M. Bills } 29695820184SJason M. Bills else 29795820184SJason M. Bills { 29895820184SJason M. Bills // Otherwise, reset it 29995820184SJason M. Bills index = 0; 30095820184SJason M. Bills } 30195820184SJason M. Bills // Save the timestamp 30295820184SJason M. Bills prevTs = curTs; 30395820184SJason M. Bills 30495820184SJason M. Bills entryID = std::to_string(curTs); 30595820184SJason M. Bills if (index > 0) 30695820184SJason M. Bills { 30795820184SJason M. Bills entryID += "_" + std::to_string(index); 30895820184SJason M. Bills } 30995820184SJason M. Bills return true; 31095820184SJason M. Bills } 31195820184SJason M. Bills 31216428a1aSJason M. Bills static bool getTimestampFromID(crow::Response& res, const std::string& entryID, 313271584abSEd Tanous uint64_t& timestamp, uint64_t& index) 31416428a1aSJason M. Bills { 31516428a1aSJason M. Bills if (entryID.empty()) 31616428a1aSJason M. Bills { 31716428a1aSJason M. Bills return false; 31816428a1aSJason M. Bills } 31916428a1aSJason M. Bills // Convert the unique ID back to a timestamp to find the entry 32039e77504SEd Tanous std::string_view tsStr(entryID); 32116428a1aSJason M. Bills 32216428a1aSJason M. Bills auto underscorePos = tsStr.find("_"); 32316428a1aSJason M. Bills if (underscorePos != tsStr.npos) 32416428a1aSJason M. Bills { 32516428a1aSJason M. Bills // Timestamp has an index 32616428a1aSJason M. Bills tsStr.remove_suffix(tsStr.size() - underscorePos); 32739e77504SEd Tanous std::string_view indexStr(entryID); 32816428a1aSJason M. Bills indexStr.remove_prefix(underscorePos + 1); 32916428a1aSJason M. Bills std::size_t pos; 33016428a1aSJason M. Bills try 33116428a1aSJason M. Bills { 33239e77504SEd Tanous index = std::stoul(std::string(indexStr), &pos); 33316428a1aSJason M. Bills } 334271584abSEd Tanous catch (std::invalid_argument&) 33516428a1aSJason M. Bills { 33616428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 33716428a1aSJason M. Bills return false; 33816428a1aSJason M. Bills } 339271584abSEd Tanous catch (std::out_of_range&) 34016428a1aSJason M. Bills { 34116428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 34216428a1aSJason M. Bills return false; 34316428a1aSJason M. Bills } 34416428a1aSJason M. Bills if (pos != indexStr.size()) 34516428a1aSJason M. Bills { 34616428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 34716428a1aSJason M. Bills return false; 34816428a1aSJason M. Bills } 34916428a1aSJason M. Bills } 35016428a1aSJason M. Bills // Timestamp has no index 35116428a1aSJason M. Bills std::size_t pos; 35216428a1aSJason M. Bills try 35316428a1aSJason M. Bills { 35439e77504SEd Tanous timestamp = std::stoull(std::string(tsStr), &pos); 35516428a1aSJason M. Bills } 356271584abSEd Tanous catch (std::invalid_argument&) 35716428a1aSJason M. Bills { 35816428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 35916428a1aSJason M. Bills return false; 36016428a1aSJason M. Bills } 361271584abSEd Tanous catch (std::out_of_range&) 36216428a1aSJason M. Bills { 36316428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 36416428a1aSJason M. Bills return false; 36516428a1aSJason M. Bills } 36616428a1aSJason M. Bills if (pos != tsStr.size()) 36716428a1aSJason M. Bills { 36816428a1aSJason M. Bills messages::resourceMissingAtURI(res, entryID); 36916428a1aSJason M. Bills return false; 37016428a1aSJason M. Bills } 37116428a1aSJason M. Bills return true; 37216428a1aSJason M. Bills } 37316428a1aSJason M. Bills 37495820184SJason M. Bills static bool 37595820184SJason M. Bills getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) 37695820184SJason M. Bills { 37795820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 37895820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 37995820184SJason M. Bills 38095820184SJason M. Bills // Loop through the directory looking for redfish log files 38195820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 38295820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 38395820184SJason M. Bills { 38495820184SJason M. Bills // If we find a redfish log file, save the path 38595820184SJason M. Bills std::string filename = dirEnt.path().filename(); 38695820184SJason M. Bills if (boost::starts_with(filename, redfishLogFilename)) 38795820184SJason M. Bills { 38895820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 38995820184SJason M. Bills } 39095820184SJason M. Bills } 39195820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 39295820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 39395820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 39495820184SJason M. Bills std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); 39595820184SJason M. Bills 39695820184SJason M. Bills return !redfishLogFiles.empty(); 39795820184SJason M. Bills } 39895820184SJason M. Bills 3995cb1dd27SAsmitha Karunanithi inline void getDumpEntryCollection(std::shared_ptr<AsyncResp>& asyncResp, 4005cb1dd27SAsmitha Karunanithi const std::string& dumpType) 4015cb1dd27SAsmitha Karunanithi { 4025cb1dd27SAsmitha Karunanithi std::string dumpPath; 4035cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 4045cb1dd27SAsmitha Karunanithi { 4055cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 4065cb1dd27SAsmitha Karunanithi } 4075cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 4085cb1dd27SAsmitha Karunanithi { 4095cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 4105cb1dd27SAsmitha Karunanithi } 4115cb1dd27SAsmitha Karunanithi else 4125cb1dd27SAsmitha Karunanithi { 4135cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 4145cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4155cb1dd27SAsmitha Karunanithi return; 4165cb1dd27SAsmitha Karunanithi } 4175cb1dd27SAsmitha Karunanithi 4185cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 4195cb1dd27SAsmitha Karunanithi [asyncResp, dumpPath, dumpType](const boost::system::error_code ec, 4205cb1dd27SAsmitha Karunanithi GetManagedObjectsType& resp) { 4215cb1dd27SAsmitha Karunanithi if (ec) 4225cb1dd27SAsmitha Karunanithi { 4235cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 4245cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4255cb1dd27SAsmitha Karunanithi return; 4265cb1dd27SAsmitha Karunanithi } 4275cb1dd27SAsmitha Karunanithi 4285cb1dd27SAsmitha Karunanithi nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; 4295cb1dd27SAsmitha Karunanithi entriesArray = nlohmann::json::array(); 4305cb1dd27SAsmitha Karunanithi 4315cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4325cb1dd27SAsmitha Karunanithi { 4335cb1dd27SAsmitha Karunanithi bool foundDumpEntry = false; 4345cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : object.second) 4355cb1dd27SAsmitha Karunanithi { 4365cb1dd27SAsmitha Karunanithi if (interfaceMap.first == 4375cb1dd27SAsmitha Karunanithi ("xyz.openbmc_project.Dump.Entry." + dumpType)) 4385cb1dd27SAsmitha Karunanithi { 4395cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 4405cb1dd27SAsmitha Karunanithi break; 4415cb1dd27SAsmitha Karunanithi } 4425cb1dd27SAsmitha Karunanithi } 4435cb1dd27SAsmitha Karunanithi 4445cb1dd27SAsmitha Karunanithi if (foundDumpEntry == false) 4455cb1dd27SAsmitha Karunanithi { 4465cb1dd27SAsmitha Karunanithi continue; 4475cb1dd27SAsmitha Karunanithi } 4485cb1dd27SAsmitha Karunanithi std::time_t timestamp; 4495cb1dd27SAsmitha Karunanithi uint64_t size = 0; 4505cb1dd27SAsmitha Karunanithi entriesArray.push_back({}); 4515cb1dd27SAsmitha Karunanithi nlohmann::json& thisEntry = entriesArray.back(); 4525cb1dd27SAsmitha Karunanithi const std::string& path = 4535cb1dd27SAsmitha Karunanithi static_cast<const std::string&>(object.first); 4545cb1dd27SAsmitha Karunanithi std::size_t lastPos = path.rfind("/"); 4555cb1dd27SAsmitha Karunanithi if (lastPos == std::string::npos) 4565cb1dd27SAsmitha Karunanithi { 4575cb1dd27SAsmitha Karunanithi continue; 4585cb1dd27SAsmitha Karunanithi } 4595cb1dd27SAsmitha Karunanithi std::string entryID = path.substr(lastPos + 1); 4605cb1dd27SAsmitha Karunanithi 4615cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : object.second) 4625cb1dd27SAsmitha Karunanithi { 4635cb1dd27SAsmitha Karunanithi if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 4645cb1dd27SAsmitha Karunanithi { 4655cb1dd27SAsmitha Karunanithi 4665cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4675cb1dd27SAsmitha Karunanithi { 4685cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 4695cb1dd27SAsmitha Karunanithi { 4705cb1dd27SAsmitha Karunanithi auto sizePtr = 4715cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4725cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 4735cb1dd27SAsmitha Karunanithi { 4745cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4755cb1dd27SAsmitha Karunanithi break; 4765cb1dd27SAsmitha Karunanithi } 4775cb1dd27SAsmitha Karunanithi size = *sizePtr; 4785cb1dd27SAsmitha Karunanithi break; 4795cb1dd27SAsmitha Karunanithi } 4805cb1dd27SAsmitha Karunanithi } 4815cb1dd27SAsmitha Karunanithi } 4825cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 4835cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 4845cb1dd27SAsmitha Karunanithi { 4855cb1dd27SAsmitha Karunanithi 4865cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 4875cb1dd27SAsmitha Karunanithi { 4885cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 4895cb1dd27SAsmitha Karunanithi { 4905cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 4915cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 4925cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 4935cb1dd27SAsmitha Karunanithi { 4945cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4955cb1dd27SAsmitha Karunanithi break; 4965cb1dd27SAsmitha Karunanithi } 4975cb1dd27SAsmitha Karunanithi timestamp = 4985cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 4995cb1dd27SAsmitha Karunanithi break; 5005cb1dd27SAsmitha Karunanithi } 5015cb1dd27SAsmitha Karunanithi } 5025cb1dd27SAsmitha Karunanithi } 5035cb1dd27SAsmitha Karunanithi } 5045cb1dd27SAsmitha Karunanithi 505d337bb72SAsmitha Karunanithi thisEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry"; 5065cb1dd27SAsmitha Karunanithi thisEntry["@odata.id"] = dumpPath + entryID; 5075cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 5085cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 5095cb1dd27SAsmitha Karunanithi thisEntry["Created"] = crow::utility::getDateTime(timestamp); 5105cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 5115cb1dd27SAsmitha Karunanithi 512d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataSizeBytes"] = size; 5135cb1dd27SAsmitha Karunanithi 5145cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5155cb1dd27SAsmitha Karunanithi { 516d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 517d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 518d337bb72SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/" 519d337bb72SAsmitha Karunanithi "attachment/" + 520d337bb72SAsmitha Karunanithi entryID; 5215cb1dd27SAsmitha Karunanithi } 5225cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5235cb1dd27SAsmitha Karunanithi { 524d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 525d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 526d337bb72SAsmitha Karunanithi thisEntry["AdditionalDataURI"] = 527d337bb72SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/" 528d337bb72SAsmitha Karunanithi "attachment/" + 529d337bb72SAsmitha Karunanithi entryID; 5305cb1dd27SAsmitha Karunanithi } 5315cb1dd27SAsmitha Karunanithi } 5325cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Members@odata.count"] = 5335cb1dd27SAsmitha Karunanithi entriesArray.size(); 5345cb1dd27SAsmitha Karunanithi }, 5355cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 5365cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 5375cb1dd27SAsmitha Karunanithi } 5385cb1dd27SAsmitha Karunanithi 5395cb1dd27SAsmitha Karunanithi inline void getDumpEntryById(std::shared_ptr<AsyncResp>& asyncResp, 5405cb1dd27SAsmitha Karunanithi const std::string& entryID, 5415cb1dd27SAsmitha Karunanithi const std::string& dumpType) 5425cb1dd27SAsmitha Karunanithi { 5435cb1dd27SAsmitha Karunanithi std::string dumpPath; 5445cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5455cb1dd27SAsmitha Karunanithi { 5465cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 5475cb1dd27SAsmitha Karunanithi } 5485cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5495cb1dd27SAsmitha Karunanithi { 5505cb1dd27SAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 5515cb1dd27SAsmitha Karunanithi } 5525cb1dd27SAsmitha Karunanithi else 5535cb1dd27SAsmitha Karunanithi { 5545cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; 5555cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5565cb1dd27SAsmitha Karunanithi return; 5575cb1dd27SAsmitha Karunanithi } 5585cb1dd27SAsmitha Karunanithi 5595cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 5605cb1dd27SAsmitha Karunanithi [asyncResp, entryID, dumpPath, dumpType]( 5615cb1dd27SAsmitha Karunanithi const boost::system::error_code ec, GetManagedObjectsType& resp) { 5625cb1dd27SAsmitha Karunanithi if (ec) 5635cb1dd27SAsmitha Karunanithi { 5645cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; 5655cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5665cb1dd27SAsmitha Karunanithi return; 5675cb1dd27SAsmitha Karunanithi } 5685cb1dd27SAsmitha Karunanithi 5695cb1dd27SAsmitha Karunanithi for (auto& objectPath : resp) 5705cb1dd27SAsmitha Karunanithi { 5715cb1dd27SAsmitha Karunanithi if (objectPath.first.str.find( 5725cb1dd27SAsmitha Karunanithi "/xyz/openbmc_project/dump/entry/" + entryID) == 5735cb1dd27SAsmitha Karunanithi std::string::npos) 5745cb1dd27SAsmitha Karunanithi { 5755cb1dd27SAsmitha Karunanithi continue; 5765cb1dd27SAsmitha Karunanithi } 5775cb1dd27SAsmitha Karunanithi 5785cb1dd27SAsmitha Karunanithi bool foundDumpEntry = false; 5795cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : objectPath.second) 5805cb1dd27SAsmitha Karunanithi { 5815cb1dd27SAsmitha Karunanithi if (interfaceMap.first == 5825cb1dd27SAsmitha Karunanithi ("xyz.openbmc_project.Dump.Entry." + dumpType)) 5835cb1dd27SAsmitha Karunanithi { 5845cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 5855cb1dd27SAsmitha Karunanithi break; 5865cb1dd27SAsmitha Karunanithi } 5875cb1dd27SAsmitha Karunanithi } 5885cb1dd27SAsmitha Karunanithi if (foundDumpEntry == false) 5895cb1dd27SAsmitha Karunanithi { 5905cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Can't find Dump Entry"; 5915cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5925cb1dd27SAsmitha Karunanithi return; 5935cb1dd27SAsmitha Karunanithi } 5945cb1dd27SAsmitha Karunanithi 5955cb1dd27SAsmitha Karunanithi std::time_t timestamp; 5965cb1dd27SAsmitha Karunanithi uint64_t size = 0; 5975cb1dd27SAsmitha Karunanithi 5985cb1dd27SAsmitha Karunanithi for (auto& interfaceMap : objectPath.second) 5995cb1dd27SAsmitha Karunanithi { 6005cb1dd27SAsmitha Karunanithi if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 6015cb1dd27SAsmitha Karunanithi { 6025cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 6035cb1dd27SAsmitha Karunanithi { 6045cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Size") 6055cb1dd27SAsmitha Karunanithi { 6065cb1dd27SAsmitha Karunanithi auto sizePtr = 6075cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6085cb1dd27SAsmitha Karunanithi if (sizePtr == nullptr) 6095cb1dd27SAsmitha Karunanithi { 6105cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6115cb1dd27SAsmitha Karunanithi break; 6125cb1dd27SAsmitha Karunanithi } 6135cb1dd27SAsmitha Karunanithi size = *sizePtr; 6145cb1dd27SAsmitha Karunanithi break; 6155cb1dd27SAsmitha Karunanithi } 6165cb1dd27SAsmitha Karunanithi } 6175cb1dd27SAsmitha Karunanithi } 6185cb1dd27SAsmitha Karunanithi else if (interfaceMap.first == 6195cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Time.EpochTime") 6205cb1dd27SAsmitha Karunanithi { 6215cb1dd27SAsmitha Karunanithi for (auto& propertyMap : interfaceMap.second) 6225cb1dd27SAsmitha Karunanithi { 6235cb1dd27SAsmitha Karunanithi if (propertyMap.first == "Elapsed") 6245cb1dd27SAsmitha Karunanithi { 6255cb1dd27SAsmitha Karunanithi const uint64_t* usecsTimeStamp = 6265cb1dd27SAsmitha Karunanithi std::get_if<uint64_t>(&propertyMap.second); 6275cb1dd27SAsmitha Karunanithi if (usecsTimeStamp == nullptr) 6285cb1dd27SAsmitha Karunanithi { 6295cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6305cb1dd27SAsmitha Karunanithi break; 6315cb1dd27SAsmitha Karunanithi } 6325cb1dd27SAsmitha Karunanithi timestamp = 6335cb1dd27SAsmitha Karunanithi static_cast<std::time_t>(*usecsTimeStamp); 6345cb1dd27SAsmitha Karunanithi break; 6355cb1dd27SAsmitha Karunanithi } 6365cb1dd27SAsmitha Karunanithi } 6375cb1dd27SAsmitha Karunanithi } 6385cb1dd27SAsmitha Karunanithi } 6395cb1dd27SAsmitha Karunanithi 6405cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 641d337bb72SAsmitha Karunanithi "#LogEntry.v1_7_0.LogEntry"; 6425cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID; 6435cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 6445cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 6455cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Created"] = 6465cb1dd27SAsmitha Karunanithi crow::utility::getDateTime(timestamp); 6475cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 6485cb1dd27SAsmitha Karunanithi 649d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 6505cb1dd27SAsmitha Karunanithi 6515cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 6525cb1dd27SAsmitha Karunanithi { 653d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 654d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 6555cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/" 6565cb1dd27SAsmitha Karunanithi "attachment/" + 6575cb1dd27SAsmitha Karunanithi entryID; 6585cb1dd27SAsmitha Karunanithi } 6595cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 6605cb1dd27SAsmitha Karunanithi { 661d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 662d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["OEMDiagnosticDataType"] = 6635cb1dd27SAsmitha Karunanithi "System"; 664d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 6655cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/" 6665cb1dd27SAsmitha Karunanithi "attachment/" + 6675cb1dd27SAsmitha Karunanithi entryID; 6685cb1dd27SAsmitha Karunanithi } 6695cb1dd27SAsmitha Karunanithi } 6705cb1dd27SAsmitha Karunanithi }, 6715cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 6725cb1dd27SAsmitha Karunanithi "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 6735cb1dd27SAsmitha Karunanithi } 6745cb1dd27SAsmitha Karunanithi 6755cb1dd27SAsmitha Karunanithi inline void deleteDumpEntry(crow::Response& res, const std::string& entryID) 6765cb1dd27SAsmitha Karunanithi { 6775cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 6785cb1dd27SAsmitha Karunanithi 6795cb1dd27SAsmitha Karunanithi auto respHandler = [asyncResp](const boost::system::error_code ec) { 6805cb1dd27SAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; 6815cb1dd27SAsmitha Karunanithi if (ec) 6825cb1dd27SAsmitha Karunanithi { 6835cb1dd27SAsmitha Karunanithi BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " 6845cb1dd27SAsmitha Karunanithi << ec; 6855cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 6865cb1dd27SAsmitha Karunanithi return; 6875cb1dd27SAsmitha Karunanithi } 6885cb1dd27SAsmitha Karunanithi }; 6895cb1dd27SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 6905cb1dd27SAsmitha Karunanithi respHandler, "xyz.openbmc_project.Dump.Manager", 6915cb1dd27SAsmitha Karunanithi "/xyz/openbmc_project/dump/entry/" + entryID, 6925cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 6935cb1dd27SAsmitha Karunanithi } 6945cb1dd27SAsmitha Karunanithi 695a43be80fSAsmitha Karunanithi inline void createDumpTaskCallback(const crow::Request& req, 696a43be80fSAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp, 697a43be80fSAsmitha Karunanithi const uint32_t& dumpId, 698a43be80fSAsmitha Karunanithi const std::string& dumpPath, 699a43be80fSAsmitha Karunanithi const std::string& dumpType) 700a43be80fSAsmitha Karunanithi { 701a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 7026145ed6fSAsmitha Karunanithi [dumpId, dumpPath, dumpType]( 703a43be80fSAsmitha Karunanithi boost::system::error_code err, sdbusplus::message::message& m, 704a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 705cb13a392SEd Tanous if (err) 706cb13a392SEd Tanous { 7076145ed6fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Error in creating a dump"; 7086145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 7096145ed6fSAsmitha Karunanithi return task::completed; 710cb13a392SEd Tanous } 711a43be80fSAsmitha Karunanithi std::vector<std::pair< 712a43be80fSAsmitha Karunanithi std::string, 713a43be80fSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string>>>>> 714a43be80fSAsmitha Karunanithi interfacesList; 715a43be80fSAsmitha Karunanithi 716a43be80fSAsmitha Karunanithi sdbusplus::message::object_path objPath; 717a43be80fSAsmitha Karunanithi 718a43be80fSAsmitha Karunanithi m.read(objPath, interfacesList); 719a43be80fSAsmitha Karunanithi 720a43be80fSAsmitha Karunanithi for (auto& interface : interfacesList) 721a43be80fSAsmitha Karunanithi { 722a43be80fSAsmitha Karunanithi if (interface.first == 723a43be80fSAsmitha Karunanithi ("xyz.openbmc_project.Dump.Entry." + dumpType)) 724a43be80fSAsmitha Karunanithi { 725a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 726a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 727a43be80fSAsmitha Karunanithi 728a43be80fSAsmitha Karunanithi std::string headerLoc = 729a43be80fSAsmitha Karunanithi "Location: " + dumpPath + std::to_string(dumpId); 730a43be80fSAsmitha Karunanithi taskData->payload->httpHeaders.emplace_back( 731a43be80fSAsmitha Karunanithi std::move(headerLoc)); 732a43be80fSAsmitha Karunanithi 733a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 7346145ed6fSAsmitha Karunanithi break; 7356145ed6fSAsmitha Karunanithi } 7366145ed6fSAsmitha Karunanithi } 737a43be80fSAsmitha Karunanithi return task::completed; 738a43be80fSAsmitha Karunanithi }, 739a43be80fSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus." 740a43be80fSAsmitha Karunanithi "ObjectManager'," 741a43be80fSAsmitha Karunanithi "member='InterfacesAdded', " 742a43be80fSAsmitha Karunanithi "path='/xyz/openbmc_project/dump'"); 743a43be80fSAsmitha Karunanithi 744a43be80fSAsmitha Karunanithi task->startTimer(std::chrono::minutes(3)); 745a43be80fSAsmitha Karunanithi task->populateResp(asyncResp->res); 746a43be80fSAsmitha Karunanithi task->payload.emplace(req); 747a43be80fSAsmitha Karunanithi } 748a43be80fSAsmitha Karunanithi 749a43be80fSAsmitha Karunanithi inline void createDump(crow::Response& res, const crow::Request& req, 750a43be80fSAsmitha Karunanithi const std::string& dumpType) 751a43be80fSAsmitha Karunanithi { 752a43be80fSAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 753a43be80fSAsmitha Karunanithi 754a43be80fSAsmitha Karunanithi std::string dumpPath; 755a43be80fSAsmitha Karunanithi if (dumpType == "BMC") 756a43be80fSAsmitha Karunanithi { 757a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; 758a43be80fSAsmitha Karunanithi } 759a43be80fSAsmitha Karunanithi else if (dumpType == "System") 760a43be80fSAsmitha Karunanithi { 761a43be80fSAsmitha Karunanithi dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; 762a43be80fSAsmitha Karunanithi } 763a43be80fSAsmitha Karunanithi else 764a43be80fSAsmitha Karunanithi { 765a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType; 766a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 767a43be80fSAsmitha Karunanithi return; 768a43be80fSAsmitha Karunanithi } 769a43be80fSAsmitha Karunanithi 770a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 771a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 772a43be80fSAsmitha Karunanithi 773a43be80fSAsmitha Karunanithi if (!redfish::json_util::readJson( 774a43be80fSAsmitha Karunanithi req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, 775a43be80fSAsmitha Karunanithi "OEMDiagnosticDataType", oemDiagnosticDataType)) 776a43be80fSAsmitha Karunanithi { 777a43be80fSAsmitha Karunanithi return; 778a43be80fSAsmitha Karunanithi } 779a43be80fSAsmitha Karunanithi 780a43be80fSAsmitha Karunanithi if (dumpType == "System") 781a43be80fSAsmitha Karunanithi { 782a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 783a43be80fSAsmitha Karunanithi { 784a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump action parameter " 785a43be80fSAsmitha Karunanithi "'DiagnosticDataType'/" 786a43be80fSAsmitha Karunanithi "'OEMDiagnosticDataType' value not found!"; 787a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 788a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 789a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 790a43be80fSAsmitha Karunanithi return; 791a43be80fSAsmitha Karunanithi } 792a43be80fSAsmitha Karunanithi else if ((*oemDiagnosticDataType != "System") || 793a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 794a43be80fSAsmitha Karunanithi { 795a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "Wrong parameter values passed"; 796a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 797a43be80fSAsmitha Karunanithi "System Dump creation parameters"); 798a43be80fSAsmitha Karunanithi return; 799a43be80fSAsmitha Karunanithi } 800a43be80fSAsmitha Karunanithi } 801a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 802a43be80fSAsmitha Karunanithi { 803a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 804a43be80fSAsmitha Karunanithi { 805a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump action parameter " 806a43be80fSAsmitha Karunanithi "'DiagnosticDataType' not found!"; 807a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 808a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 809a43be80fSAsmitha Karunanithi return; 810a43be80fSAsmitha Karunanithi } 811a43be80fSAsmitha Karunanithi else if (*diagnosticDataType != "Manager") 812a43be80fSAsmitha Karunanithi { 813a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR 814a43be80fSAsmitha Karunanithi << "Wrong parameter value passed for 'DiagnosticDataType'"; 815a43be80fSAsmitha Karunanithi messages::invalidObject(asyncResp->res, 816a43be80fSAsmitha Karunanithi "BMC Dump creation parameters"); 817a43be80fSAsmitha Karunanithi return; 818a43be80fSAsmitha Karunanithi } 819a43be80fSAsmitha Karunanithi } 820a43be80fSAsmitha Karunanithi 821a43be80fSAsmitha Karunanithi crow::connections::systemBus->async_method_call( 822a43be80fSAsmitha Karunanithi [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec, 823a43be80fSAsmitha Karunanithi const uint32_t& dumpId) { 824a43be80fSAsmitha Karunanithi if (ec) 825a43be80fSAsmitha Karunanithi { 826a43be80fSAsmitha Karunanithi BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; 827a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 828a43be80fSAsmitha Karunanithi return; 829a43be80fSAsmitha Karunanithi } 830a43be80fSAsmitha Karunanithi BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; 831a43be80fSAsmitha Karunanithi 832a43be80fSAsmitha Karunanithi createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType); 833a43be80fSAsmitha Karunanithi }, 834a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", 835a43be80fSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump"); 836a43be80fSAsmitha Karunanithi } 837a43be80fSAsmitha Karunanithi 83880319af1SAsmitha Karunanithi inline void clearDump(crow::Response& res, const std::string& dumpInterface) 83980319af1SAsmitha Karunanithi { 84080319af1SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 84180319af1SAsmitha Karunanithi crow::connections::systemBus->async_method_call( 84280319af1SAsmitha Karunanithi [asyncResp](const boost::system::error_code ec, 84380319af1SAsmitha Karunanithi const std::vector<std::string>& subTreePaths) { 84480319af1SAsmitha Karunanithi if (ec) 84580319af1SAsmitha Karunanithi { 84680319af1SAsmitha Karunanithi BMCWEB_LOG_ERROR << "resp_handler got error " << ec; 84780319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 84880319af1SAsmitha Karunanithi return; 84980319af1SAsmitha Karunanithi } 85080319af1SAsmitha Karunanithi 85180319af1SAsmitha Karunanithi for (const std::string& path : subTreePaths) 85280319af1SAsmitha Karunanithi { 85380319af1SAsmitha Karunanithi std::size_t pos = path.rfind("/"); 85480319af1SAsmitha Karunanithi if (pos != std::string::npos) 85580319af1SAsmitha Karunanithi { 85680319af1SAsmitha Karunanithi std::string logID = path.substr(pos + 1); 85780319af1SAsmitha Karunanithi deleteDumpEntry(asyncResp->res, logID); 85880319af1SAsmitha Karunanithi } 85980319af1SAsmitha Karunanithi } 86080319af1SAsmitha Karunanithi }, 86180319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", 86280319af1SAsmitha Karunanithi "/xyz/openbmc_project/object_mapper", 86380319af1SAsmitha Karunanithi "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 86480319af1SAsmitha Karunanithi "/xyz/openbmc_project/dump", 0, 86580319af1SAsmitha Karunanithi std::array<std::string, 1>{dumpInterface}); 86680319af1SAsmitha Karunanithi } 86780319af1SAsmitha Karunanithi 8682c70f800SEd Tanous static void parseCrashdumpParameters( 869043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params, 870043a0536SJohnathan Mantey std::string& filename, std::string& timestamp, std::string& logfile) 871043a0536SJohnathan Mantey { 872043a0536SJohnathan Mantey for (auto property : params) 873043a0536SJohnathan Mantey { 874043a0536SJohnathan Mantey if (property.first == "Timestamp") 875043a0536SJohnathan Mantey { 876043a0536SJohnathan Mantey const std::string* value = 8778d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 878043a0536SJohnathan Mantey if (value != nullptr) 879043a0536SJohnathan Mantey { 880043a0536SJohnathan Mantey timestamp = *value; 881043a0536SJohnathan Mantey } 882043a0536SJohnathan Mantey } 883043a0536SJohnathan Mantey else if (property.first == "Filename") 884043a0536SJohnathan Mantey { 885043a0536SJohnathan Mantey const std::string* value = 8868d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 887043a0536SJohnathan Mantey if (value != nullptr) 888043a0536SJohnathan Mantey { 889043a0536SJohnathan Mantey filename = *value; 890043a0536SJohnathan Mantey } 891043a0536SJohnathan Mantey } 892043a0536SJohnathan Mantey else if (property.first == "Log") 893043a0536SJohnathan Mantey { 894043a0536SJohnathan Mantey const std::string* value = 8958d78b7a9SPatrick Williams std::get_if<std::string>(&property.second); 896043a0536SJohnathan Mantey if (value != nullptr) 897043a0536SJohnathan Mantey { 898043a0536SJohnathan Mantey logfile = *value; 899043a0536SJohnathan Mantey } 900043a0536SJohnathan Mantey } 901043a0536SJohnathan Mantey } 902043a0536SJohnathan Mantey } 903043a0536SJohnathan Mantey 904a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; 905c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node 9061da66f75SEd Tanous { 9071da66f75SEd Tanous public: 90852cc112dSEd Tanous SystemLogServiceCollection(App& app) : 909029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/") 910c4bf6374SJason M. Bills { 911c4bf6374SJason M. Bills entityPrivileges = { 912c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 913c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 914c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 915c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 916c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 917c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 918c4bf6374SJason M. Bills } 919c4bf6374SJason M. Bills 920c4bf6374SJason M. Bills private: 921c4bf6374SJason M. Bills /** 922c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 923c4bf6374SJason M. Bills */ 924cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 925cb13a392SEd Tanous const std::vector<std::string>&) override 926c4bf6374SJason M. Bills { 927c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 928c4bf6374SJason M. Bills // Collections don't include the static data added by SubRoute because 929c4bf6374SJason M. Bills // it has a duplicate entry for members 930c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 931c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 932c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 933029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices"; 934c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 935c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 936c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 937c4bf6374SJason M. Bills nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 938c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 939029573d4SEd Tanous logServiceArray.push_back( 940029573d4SEd Tanous {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}}); 9415cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 942c9bb6861Sraviteja-b logServiceArray.push_back( 9435cb1dd27SAsmitha Karunanithi {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}}); 944c9bb6861Sraviteja-b #endif 945c9bb6861Sraviteja-b 946d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 947d53dd41fSJason M. Bills logServiceArray.push_back( 948cb92c03bSAndrew Geissler {{"@odata.id", 949424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"}}); 950d53dd41fSJason M. Bills #endif 951c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 952c4bf6374SJason M. Bills logServiceArray.size(); 953a3316fc6SZhikuiRen 954a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 955a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec, 956a3316fc6SZhikuiRen const std::vector<std::string>& subtreePath) { 957a3316fc6SZhikuiRen if (ec) 958a3316fc6SZhikuiRen { 959a3316fc6SZhikuiRen BMCWEB_LOG_ERROR << ec; 960a3316fc6SZhikuiRen return; 961a3316fc6SZhikuiRen } 962a3316fc6SZhikuiRen 963a3316fc6SZhikuiRen for (auto& pathStr : subtreePath) 964a3316fc6SZhikuiRen { 965a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 966a3316fc6SZhikuiRen { 96723a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 968a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 96923a21a1cSEd Tanous logServiceArrayLocal.push_back( 970a3316fc6SZhikuiRen {{"@odata.id", "/redfish/v1/Systems/system/" 971a3316fc6SZhikuiRen "LogServices/PostCodes"}}); 972a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 97323a21a1cSEd Tanous logServiceArrayLocal.size(); 974a3316fc6SZhikuiRen return; 975a3316fc6SZhikuiRen } 976a3316fc6SZhikuiRen } 977a3316fc6SZhikuiRen }, 978a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", 979a3316fc6SZhikuiRen "/xyz/openbmc_project/object_mapper", 980a3316fc6SZhikuiRen "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0, 981a3316fc6SZhikuiRen std::array<const char*, 1>{postCodeIface}); 982c4bf6374SJason M. Bills } 983c4bf6374SJason M. Bills }; 984c4bf6374SJason M. Bills 985c4bf6374SJason M. Bills class EventLogService : public Node 986c4bf6374SJason M. Bills { 987c4bf6374SJason M. Bills public: 98852cc112dSEd Tanous EventLogService(App& app) : 989029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/") 990c4bf6374SJason M. Bills { 991c4bf6374SJason M. Bills entityPrivileges = { 992c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 993c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 994c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 995c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 996c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 997c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 998c4bf6374SJason M. Bills } 999c4bf6374SJason M. Bills 1000c4bf6374SJason M. Bills private: 1001cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1002cb13a392SEd Tanous const std::vector<std::string>&) override 1003c4bf6374SJason M. Bills { 1004c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1005c4bf6374SJason M. Bills 1006c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1007029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog"; 1008c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1009c4bf6374SJason M. Bills "#LogService.v1_1_0.LogService"; 1010c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1011c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = "System Event Log Service"; 1012c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1013c4bf6374SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 1014c4bf6374SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1015c4bf6374SJason M. Bills {"@odata.id", 1016029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}}; 1017e7d6c8b2SGunnar Mills asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 1018e7d6c8b2SGunnar Mills 1019e7d6c8b2SGunnar Mills {"target", "/redfish/v1/Systems/system/LogServices/EventLog/" 1020e7d6c8b2SGunnar Mills "Actions/LogService.ClearLog"}}; 1021489640c6SJason M. Bills } 1022489640c6SJason M. Bills }; 1023489640c6SJason M. Bills 10241f56a3a6STim Lee class JournalEventLogClear : public Node 1025489640c6SJason M. Bills { 1026489640c6SJason M. Bills public: 102752cc112dSEd Tanous JournalEventLogClear(App& app) : 1028489640c6SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 1029489640c6SJason M. Bills "LogService.ClearLog/") 1030489640c6SJason M. Bills { 1031489640c6SJason M. Bills entityPrivileges = { 1032489640c6SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1033489640c6SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1034489640c6SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1035489640c6SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1036489640c6SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1037489640c6SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1038489640c6SJason M. Bills } 1039489640c6SJason M. Bills 1040489640c6SJason M. Bills private: 1041cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 1042cb13a392SEd Tanous const std::vector<std::string>&) override 1043489640c6SJason M. Bills { 1044489640c6SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1045489640c6SJason M. Bills 1046489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1047489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1048489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1049489640c6SJason M. Bills { 1050489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1051489640c6SJason M. Bills { 1052489640c6SJason M. Bills std::error_code ec; 1053489640c6SJason M. Bills std::filesystem::remove(file, ec); 1054489640c6SJason M. Bills } 1055489640c6SJason M. Bills } 1056489640c6SJason M. Bills 1057489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1058489640c6SJason M. Bills crow::connections::systemBus->async_method_call( 1059489640c6SJason M. Bills [asyncResp](const boost::system::error_code ec) { 1060489640c6SJason M. Bills if (ec) 1061489640c6SJason M. Bills { 1062489640c6SJason M. Bills BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; 1063489640c6SJason M. Bills messages::internalError(asyncResp->res); 1064489640c6SJason M. Bills return; 1065489640c6SJason M. Bills } 1066489640c6SJason M. Bills 1067489640c6SJason M. Bills messages::success(asyncResp->res); 1068489640c6SJason M. Bills }, 1069489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1070489640c6SJason M. Bills "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1071489640c6SJason M. Bills "replace"); 1072c4bf6374SJason M. Bills } 1073c4bf6374SJason M. Bills }; 1074c4bf6374SJason M. Bills 107595820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID, 107695820184SJason M. Bills const std::string logEntry, 107795820184SJason M. Bills nlohmann::json& logEntryJson) 1078c4bf6374SJason M. Bills { 107995820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1080cd225da8SJason M. Bills // First get the Timestamp 1081cd225da8SJason M. Bills size_t space = logEntry.find_first_of(" "); 1082cd225da8SJason M. Bills if (space == std::string::npos) 108395820184SJason M. Bills { 108495820184SJason M. Bills return 1; 108595820184SJason M. Bills } 1086cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1087cd225da8SJason M. Bills // Then get the log contents 1088cd225da8SJason M. Bills size_t entryStart = logEntry.find_first_not_of(" ", space); 1089cd225da8SJason M. Bills if (entryStart == std::string::npos) 1090cd225da8SJason M. Bills { 1091cd225da8SJason M. Bills return 1; 1092cd225da8SJason M. Bills } 1093cd225da8SJason M. Bills std::string_view entry(logEntry); 1094cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1095cd225da8SJason M. Bills // Use split to separate the entry into its fields 1096cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 1097cd225da8SJason M. Bills boost::split(logEntryFields, entry, boost::is_any_of(","), 1098cd225da8SJason M. Bills boost::token_compress_on); 1099cd225da8SJason M. Bills // We need at least a MessageId to be valid 1100cd225da8SJason M. Bills if (logEntryFields.size() < 1) 1101cd225da8SJason M. Bills { 1102cd225da8SJason M. Bills return 1; 1103cd225da8SJason M. Bills } 1104cd225da8SJason M. Bills std::string& messageID = logEntryFields[0]; 110595820184SJason M. Bills 11064851d45dSJason M. Bills // Get the Message from the MessageRegistry 11074851d45dSJason M. Bills const message_registries::Message* message = 11084851d45dSJason M. Bills message_registries::getMessage(messageID); 1109c4bf6374SJason M. Bills 11104851d45dSJason M. Bills std::string msg; 11114851d45dSJason M. Bills std::string severity; 11124851d45dSJason M. Bills if (message != nullptr) 1113c4bf6374SJason M. Bills { 11144851d45dSJason M. Bills msg = message->message; 11154851d45dSJason M. Bills severity = message->severity; 1116c4bf6374SJason M. Bills } 1117c4bf6374SJason M. Bills 111815a86ff6SJason M. Bills // Get the MessageArgs from the log if there are any 111915a86ff6SJason M. Bills boost::beast::span<std::string> messageArgs; 112015a86ff6SJason M. Bills if (logEntryFields.size() > 1) 112115a86ff6SJason M. Bills { 112215a86ff6SJason M. Bills std::string& messageArgsStart = logEntryFields[1]; 112315a86ff6SJason M. Bills // If the first string is empty, assume there are no MessageArgs 112415a86ff6SJason M. Bills std::size_t messageArgsSize = 0; 112515a86ff6SJason M. Bills if (!messageArgsStart.empty()) 112615a86ff6SJason M. Bills { 112715a86ff6SJason M. Bills messageArgsSize = logEntryFields.size() - 1; 112815a86ff6SJason M. Bills } 112915a86ff6SJason M. Bills 113023a21a1cSEd Tanous messageArgs = {&messageArgsStart, messageArgsSize}; 1131c4bf6374SJason M. Bills 11324851d45dSJason M. Bills // Fill the MessageArgs into the Message 113395820184SJason M. Bills int i = 0; 113495820184SJason M. Bills for (const std::string& messageArg : messageArgs) 11354851d45dSJason M. Bills { 113695820184SJason M. Bills std::string argStr = "%" + std::to_string(++i); 11374851d45dSJason M. Bills size_t argPos = msg.find(argStr); 11384851d45dSJason M. Bills if (argPos != std::string::npos) 11394851d45dSJason M. Bills { 114095820184SJason M. Bills msg.replace(argPos, argStr.length(), messageArg); 11414851d45dSJason M. Bills } 11424851d45dSJason M. Bills } 114315a86ff6SJason M. Bills } 11444851d45dSJason M. Bills 114595820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 114695820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 114795820184SJason M. Bills // between the '.' and the '+', so just remove them. 114895820184SJason M. Bills std::size_t dot = timestamp.find_first_of("."); 114995820184SJason M. Bills std::size_t plus = timestamp.find_first_of("+"); 115095820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1151c4bf6374SJason M. Bills { 115295820184SJason M. Bills timestamp.erase(dot, plus - dot); 1153c4bf6374SJason M. Bills } 1154c4bf6374SJason M. Bills 1155c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 115695820184SJason M. Bills logEntryJson = { 1157cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1158029573d4SEd Tanous {"@odata.id", 1159897967deSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + 116095820184SJason M. Bills logEntryID}, 1161c4bf6374SJason M. Bills {"Name", "System Event Log Entry"}, 116295820184SJason M. Bills {"Id", logEntryID}, 116395820184SJason M. Bills {"Message", std::move(msg)}, 116495820184SJason M. Bills {"MessageId", std::move(messageID)}, 1165c4bf6374SJason M. Bills {"MessageArgs", std::move(messageArgs)}, 1166c4bf6374SJason M. Bills {"EntryType", "Event"}, 116795820184SJason M. Bills {"Severity", std::move(severity)}, 116895820184SJason M. Bills {"Created", std::move(timestamp)}}; 1169c4bf6374SJason M. Bills return 0; 1170c4bf6374SJason M. Bills } 1171c4bf6374SJason M. Bills 117227062605SAnthony Wilson class JournalEventLogEntryCollection : public Node 1173c4bf6374SJason M. Bills { 1174c4bf6374SJason M. Bills public: 117552cc112dSEd Tanous JournalEventLogEntryCollection(App& app) : 1176029573d4SEd Tanous Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 1177c4bf6374SJason M. Bills { 1178c4bf6374SJason M. Bills entityPrivileges = { 1179c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1180c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1181c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1182c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1183c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1184c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1185c4bf6374SJason M. Bills } 1186c4bf6374SJason M. Bills 1187c4bf6374SJason M. Bills private: 1188c4bf6374SJason M. Bills void doGet(crow::Response& res, const crow::Request& req, 1189cb13a392SEd Tanous const std::vector<std::string>&) override 1190c4bf6374SJason M. Bills { 1191c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1192271584abSEd Tanous uint64_t skip = 0; 1193271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 1194c4bf6374SJason M. Bills if (!getSkipParam(asyncResp->res, req, skip)) 1195c4bf6374SJason M. Bills { 1196c4bf6374SJason M. Bills return; 1197c4bf6374SJason M. Bills } 1198c4bf6374SJason M. Bills if (!getTopParam(asyncResp->res, req, top)) 1199c4bf6374SJason M. Bills { 1200c4bf6374SJason M. Bills return; 1201c4bf6374SJason M. Bills } 1202c4bf6374SJason M. Bills // Collections don't include the static data added by SubRoute because 1203c4bf6374SJason M. Bills // it has a duplicate entry for members 1204c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1205c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1206c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1207029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 1208c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1209c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1210c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1211cb92c03bSAndrew Geissler 1212c4bf6374SJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1213c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 121495820184SJason M. Bills // Go through the log files and create a unique ID for each entry 121595820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 121695820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1217b01bf299SEd Tanous uint64_t entryCount = 0; 1218cd225da8SJason M. Bills std::string logEntry; 121995820184SJason M. Bills 122095820184SJason M. Bills // Oldest logs are in the last file, so start there and loop backwards 1221cd225da8SJason M. Bills for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1222cd225da8SJason M. Bills it++) 1223c4bf6374SJason M. Bills { 1224cd225da8SJason M. Bills std::ifstream logStream(*it); 122595820184SJason M. Bills if (!logStream.is_open()) 1226c4bf6374SJason M. Bills { 1227c4bf6374SJason M. Bills continue; 1228c4bf6374SJason M. Bills } 1229c4bf6374SJason M. Bills 1230e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1231e85d6b16SJason M. Bills bool firstEntry = true; 123295820184SJason M. Bills while (std::getline(logStream, logEntry)) 123395820184SJason M. Bills { 1234c4bf6374SJason M. Bills entryCount++; 1235c4bf6374SJason M. Bills // Handle paging using skip (number of entries to skip from the 1236c4bf6374SJason M. Bills // start) and top (number of entries to display) 1237c4bf6374SJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1238c4bf6374SJason M. Bills { 1239c4bf6374SJason M. Bills continue; 1240c4bf6374SJason M. Bills } 1241c4bf6374SJason M. Bills 1242c4bf6374SJason M. Bills std::string idStr; 1243e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1244c4bf6374SJason M. Bills { 1245c4bf6374SJason M. Bills continue; 1246c4bf6374SJason M. Bills } 1247c4bf6374SJason M. Bills 1248e85d6b16SJason M. Bills if (firstEntry) 1249e85d6b16SJason M. Bills { 1250e85d6b16SJason M. Bills firstEntry = false; 1251e85d6b16SJason M. Bills } 1252e85d6b16SJason M. Bills 1253c4bf6374SJason M. Bills logEntryArray.push_back({}); 1254c4bf6374SJason M. Bills nlohmann::json& bmcLogEntry = logEntryArray.back(); 125595820184SJason M. Bills if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0) 1256c4bf6374SJason M. Bills { 1257c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1258c4bf6374SJason M. Bills return; 1259c4bf6374SJason M. Bills } 1260c4bf6374SJason M. Bills } 126195820184SJason M. Bills } 1262c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1263c4bf6374SJason M. Bills if (skip + top < entryCount) 1264c4bf6374SJason M. Bills { 1265c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 126695820184SJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/" 126795820184SJason M. Bills "Entries?$skip=" + 1268c4bf6374SJason M. Bills std::to_string(skip + top); 1269c4bf6374SJason M. Bills } 127008a4e4b5SAnthony Wilson } 127108a4e4b5SAnthony Wilson }; 127208a4e4b5SAnthony Wilson 1273897967deSJason M. Bills class JournalEventLogEntry : public Node 1274897967deSJason M. Bills { 1275897967deSJason M. Bills public: 127652cc112dSEd Tanous JournalEventLogEntry(App& app) : 1277897967deSJason M. Bills Node(app, 1278897967deSJason M. Bills "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/", 1279897967deSJason M. Bills std::string()) 1280897967deSJason M. Bills { 1281897967deSJason M. Bills entityPrivileges = { 1282897967deSJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1283897967deSJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1284897967deSJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1285897967deSJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1286897967deSJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1287897967deSJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1288897967deSJason M. Bills } 1289897967deSJason M. Bills 1290897967deSJason M. Bills private: 1291cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1292897967deSJason M. Bills const std::vector<std::string>& params) override 1293897967deSJason M. Bills { 1294897967deSJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1295897967deSJason M. Bills if (params.size() != 1) 1296897967deSJason M. Bills { 1297897967deSJason M. Bills messages::internalError(asyncResp->res); 1298897967deSJason M. Bills return; 1299897967deSJason M. Bills } 1300897967deSJason M. Bills const std::string& targetID = params[0]; 1301897967deSJason M. Bills 1302897967deSJason M. Bills // Go through the log files and check the unique ID for each entry to 1303897967deSJason M. Bills // find the target entry 1304897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1305897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1306897967deSJason M. Bills std::string logEntry; 1307897967deSJason M. Bills 1308897967deSJason M. Bills // Oldest logs are in the last file, so start there and loop backwards 1309897967deSJason M. Bills for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); 1310897967deSJason M. Bills it++) 1311897967deSJason M. Bills { 1312897967deSJason M. Bills std::ifstream logStream(*it); 1313897967deSJason M. Bills if (!logStream.is_open()) 1314897967deSJason M. Bills { 1315897967deSJason M. Bills continue; 1316897967deSJason M. Bills } 1317897967deSJason M. Bills 1318897967deSJason M. Bills // Reset the unique ID on the first entry 1319897967deSJason M. Bills bool firstEntry = true; 1320897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1321897967deSJason M. Bills { 1322897967deSJason M. Bills std::string idStr; 1323897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1324897967deSJason M. Bills { 1325897967deSJason M. Bills continue; 1326897967deSJason M. Bills } 1327897967deSJason M. Bills 1328897967deSJason M. Bills if (firstEntry) 1329897967deSJason M. Bills { 1330897967deSJason M. Bills firstEntry = false; 1331897967deSJason M. Bills } 1332897967deSJason M. Bills 1333897967deSJason M. Bills if (idStr == targetID) 1334897967deSJason M. Bills { 1335897967deSJason M. Bills if (fillEventLogEntryJson(idStr, logEntry, 1336897967deSJason M. Bills asyncResp->res.jsonValue) != 0) 1337897967deSJason M. Bills { 1338897967deSJason M. Bills messages::internalError(asyncResp->res); 1339897967deSJason M. Bills return; 1340897967deSJason M. Bills } 1341897967deSJason M. Bills return; 1342897967deSJason M. Bills } 1343897967deSJason M. Bills } 1344897967deSJason M. Bills } 1345897967deSJason M. Bills // Requested ID was not found 1346897967deSJason M. Bills messages::resourceMissingAtURI(asyncResp->res, targetID); 1347897967deSJason M. Bills } 1348897967deSJason M. Bills }; 1349897967deSJason M. Bills 135008a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node 135108a4e4b5SAnthony Wilson { 135208a4e4b5SAnthony Wilson public: 135352cc112dSEd Tanous DBusEventLogEntryCollection(App& app) : 135408a4e4b5SAnthony Wilson Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") 135508a4e4b5SAnthony Wilson { 135608a4e4b5SAnthony Wilson entityPrivileges = { 135708a4e4b5SAnthony Wilson {boost::beast::http::verb::get, {{"Login"}}}, 135808a4e4b5SAnthony Wilson {boost::beast::http::verb::head, {{"Login"}}}, 135908a4e4b5SAnthony Wilson {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 136008a4e4b5SAnthony Wilson {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 136108a4e4b5SAnthony Wilson {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 136208a4e4b5SAnthony Wilson {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 136308a4e4b5SAnthony Wilson } 136408a4e4b5SAnthony Wilson 136508a4e4b5SAnthony Wilson private: 1366cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1367cb13a392SEd Tanous const std::vector<std::string>&) override 136808a4e4b5SAnthony Wilson { 136908a4e4b5SAnthony Wilson std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 137008a4e4b5SAnthony Wilson 137108a4e4b5SAnthony Wilson // Collections don't include the static data added by SubRoute because 137208a4e4b5SAnthony Wilson // it has a duplicate entry for members 137308a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.type"] = 137408a4e4b5SAnthony Wilson "#LogEntryCollection.LogEntryCollection"; 137508a4e4b5SAnthony Wilson asyncResp->res.jsonValue["@odata.id"] = 137608a4e4b5SAnthony Wilson "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; 137708a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 137808a4e4b5SAnthony Wilson asyncResp->res.jsonValue["Description"] = 137908a4e4b5SAnthony Wilson "Collection of System Event Log Entries"; 138008a4e4b5SAnthony Wilson 1381cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1382cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1383cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1384cb92c03bSAndrew Geissler [asyncResp](const boost::system::error_code ec, 1385cb92c03bSAndrew Geissler GetManagedObjectsType& resp) { 1386cb92c03bSAndrew Geissler if (ec) 1387cb92c03bSAndrew Geissler { 1388cb92c03bSAndrew Geissler // TODO Handle for specific error code 1389cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1390cb92c03bSAndrew Geissler << "getLogEntriesIfaceData resp_handler got error " 1391cb92c03bSAndrew Geissler << ec; 1392cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1393cb92c03bSAndrew Geissler return; 1394cb92c03bSAndrew Geissler } 1395cb92c03bSAndrew Geissler nlohmann::json& entriesArray = 1396cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members"]; 1397cb92c03bSAndrew Geissler entriesArray = nlohmann::json::array(); 1398cb92c03bSAndrew Geissler for (auto& objectPath : resp) 1399cb92c03bSAndrew Geissler { 1400cb92c03bSAndrew Geissler for (auto& interfaceMap : objectPath.second) 1401cb92c03bSAndrew Geissler { 1402cb92c03bSAndrew Geissler if (interfaceMap.first != 1403cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging.Entry") 1404cb92c03bSAndrew Geissler { 1405cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Bailing early on " 1406cb92c03bSAndrew Geissler << interfaceMap.first; 1407cb92c03bSAndrew Geissler continue; 1408cb92c03bSAndrew Geissler } 1409cb92c03bSAndrew Geissler entriesArray.push_back({}); 1410cb92c03bSAndrew Geissler nlohmann::json& thisEntry = entriesArray.back(); 141166664f25SEd Tanous uint32_t* id = nullptr; 141266664f25SEd Tanous std::time_t timestamp{}; 1413d139c236SGeorge Liu std::time_t updateTimestamp{}; 141466664f25SEd Tanous std::string* severity = nullptr; 141566664f25SEd Tanous std::string* message = nullptr; 1416d139c236SGeorge Liu 1417cb92c03bSAndrew Geissler for (auto& propertyMap : interfaceMap.second) 1418cb92c03bSAndrew Geissler { 1419cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1420cb92c03bSAndrew Geissler { 14218d78b7a9SPatrick Williams id = std::get_if<uint32_t>(&propertyMap.second); 1422cb92c03bSAndrew Geissler if (id == nullptr) 1423cb92c03bSAndrew Geissler { 14240f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1425cb92c03bSAndrew Geissler } 1426cb92c03bSAndrew Geissler } 1427cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1428cb92c03bSAndrew Geissler { 1429cb92c03bSAndrew Geissler const uint64_t* millisTimeStamp = 1430cb92c03bSAndrew Geissler std::get_if<uint64_t>(&propertyMap.second); 1431cb92c03bSAndrew Geissler if (millisTimeStamp == nullptr) 1432cb92c03bSAndrew Geissler { 14330f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1434cb92c03bSAndrew Geissler } 1435ebd45906SGeorge Liu else 1436ebd45906SGeorge Liu { 1437d139c236SGeorge Liu timestamp = crow::utility::getTimestamp( 1438cb92c03bSAndrew Geissler *millisTimeStamp); 1439d139c236SGeorge Liu } 1440ebd45906SGeorge Liu } 1441d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1442d139c236SGeorge Liu { 1443d139c236SGeorge Liu const uint64_t* millisTimeStamp = 1444d139c236SGeorge Liu std::get_if<uint64_t>(&propertyMap.second); 1445d139c236SGeorge Liu if (millisTimeStamp == nullptr) 1446d139c236SGeorge Liu { 1447d139c236SGeorge Liu messages::internalError(asyncResp->res); 1448d139c236SGeorge Liu } 1449ebd45906SGeorge Liu else 1450ebd45906SGeorge Liu { 1451ebd45906SGeorge Liu updateTimestamp = 1452ebd45906SGeorge Liu crow::utility::getTimestamp( 1453d139c236SGeorge Liu *millisTimeStamp); 1454cb92c03bSAndrew Geissler } 1455ebd45906SGeorge Liu } 1456cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1457cb92c03bSAndrew Geissler { 1458cb92c03bSAndrew Geissler severity = std::get_if<std::string>( 1459cb92c03bSAndrew Geissler &propertyMap.second); 1460cb92c03bSAndrew Geissler if (severity == nullptr) 1461cb92c03bSAndrew Geissler { 14620f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1463cb92c03bSAndrew Geissler } 1464cb92c03bSAndrew Geissler } 1465cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1466cb92c03bSAndrew Geissler { 1467cb92c03bSAndrew Geissler message = std::get_if<std::string>( 1468cb92c03bSAndrew Geissler &propertyMap.second); 1469cb92c03bSAndrew Geissler if (message == nullptr) 1470cb92c03bSAndrew Geissler { 14710f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1472cb92c03bSAndrew Geissler } 1473cb92c03bSAndrew Geissler } 1474cb92c03bSAndrew Geissler } 1475cb92c03bSAndrew Geissler thisEntry = { 1476d139c236SGeorge Liu {"@odata.type", "#LogEntry.v1_6_0.LogEntry"}, 1477cb92c03bSAndrew Geissler {"@odata.id", 1478cb92c03bSAndrew Geissler "/redfish/v1/Systems/system/LogServices/EventLog/" 1479cb92c03bSAndrew Geissler "Entries/" + 1480cb92c03bSAndrew Geissler std::to_string(*id)}, 148127062605SAnthony Wilson {"Name", "System Event Log Entry"}, 1482cb92c03bSAndrew Geissler {"Id", std::to_string(*id)}, 1483cb92c03bSAndrew Geissler {"Message", *message}, 1484cb92c03bSAndrew Geissler {"EntryType", "Event"}, 1485cb92c03bSAndrew Geissler {"Severity", 1486cb92c03bSAndrew Geissler translateSeverityDbusToRedfish(*severity)}, 1487d139c236SGeorge Liu {"Created", crow::utility::getDateTime(timestamp)}, 1488d139c236SGeorge Liu {"Modified", 1489d139c236SGeorge Liu crow::utility::getDateTime(updateTimestamp)}}; 1490cb92c03bSAndrew Geissler } 1491cb92c03bSAndrew Geissler } 1492cb92c03bSAndrew Geissler std::sort(entriesArray.begin(), entriesArray.end(), 1493cb92c03bSAndrew Geissler [](const nlohmann::json& left, 1494cb92c03bSAndrew Geissler const nlohmann::json& right) { 1495cb92c03bSAndrew Geissler return (left["Id"] <= right["Id"]); 1496cb92c03bSAndrew Geissler }); 1497cb92c03bSAndrew Geissler asyncResp->res.jsonValue["Members@odata.count"] = 1498cb92c03bSAndrew Geissler entriesArray.size(); 1499cb92c03bSAndrew Geissler }, 1500cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", 1501cb92c03bSAndrew Geissler "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 1502c4bf6374SJason M. Bills } 1503c4bf6374SJason M. Bills }; 1504c4bf6374SJason M. Bills 150508a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node 1506c4bf6374SJason M. Bills { 1507c4bf6374SJason M. Bills public: 150852cc112dSEd Tanous DBusEventLogEntry(App& app) : 1509c4bf6374SJason M. Bills Node(app, 1510029573d4SEd Tanous "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/", 1511029573d4SEd Tanous std::string()) 1512c4bf6374SJason M. Bills { 1513c4bf6374SJason M. Bills entityPrivileges = { 1514c4bf6374SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1515c4bf6374SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1516c4bf6374SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1517c4bf6374SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1518c4bf6374SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1519c4bf6374SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1520c4bf6374SJason M. Bills } 1521c4bf6374SJason M. Bills 1522c4bf6374SJason M. Bills private: 1523cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1524c4bf6374SJason M. Bills const std::vector<std::string>& params) override 1525c4bf6374SJason M. Bills { 1526c4bf6374SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1527029573d4SEd Tanous if (params.size() != 1) 1528c4bf6374SJason M. Bills { 1529c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1530c4bf6374SJason M. Bills return; 1531c4bf6374SJason M. Bills } 1532029573d4SEd Tanous const std::string& entryID = params[0]; 1533cb92c03bSAndrew Geissler 1534cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1535cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1536cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 1537cb92c03bSAndrew Geissler [asyncResp, entryID](const boost::system::error_code ec, 1538cb92c03bSAndrew Geissler GetManagedPropertyType& resp) { 1539cb92c03bSAndrew Geissler if (ec) 1540cb92c03bSAndrew Geissler { 1541cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR 1542cb92c03bSAndrew Geissler << "EventLogEntry (DBus) resp_handler got error " << ec; 1543cb92c03bSAndrew Geissler messages::internalError(asyncResp->res); 1544cb92c03bSAndrew Geissler return; 1545cb92c03bSAndrew Geissler } 154666664f25SEd Tanous uint32_t* id = nullptr; 154766664f25SEd Tanous std::time_t timestamp{}; 1548d139c236SGeorge Liu std::time_t updateTimestamp{}; 154966664f25SEd Tanous std::string* severity = nullptr; 155066664f25SEd Tanous std::string* message = nullptr; 1551d139c236SGeorge Liu 1552cb92c03bSAndrew Geissler for (auto& propertyMap : resp) 1553cb92c03bSAndrew Geissler { 1554cb92c03bSAndrew Geissler if (propertyMap.first == "Id") 1555cb92c03bSAndrew Geissler { 1556cb92c03bSAndrew Geissler id = std::get_if<uint32_t>(&propertyMap.second); 1557cb92c03bSAndrew Geissler if (id == nullptr) 1558cb92c03bSAndrew Geissler { 15590f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1560cb92c03bSAndrew Geissler } 1561cb92c03bSAndrew Geissler } 1562cb92c03bSAndrew Geissler else if (propertyMap.first == "Timestamp") 1563cb92c03bSAndrew Geissler { 1564cb92c03bSAndrew Geissler const uint64_t* millisTimeStamp = 1565cb92c03bSAndrew Geissler std::get_if<uint64_t>(&propertyMap.second); 1566cb92c03bSAndrew Geissler if (millisTimeStamp == nullptr) 1567cb92c03bSAndrew Geissler { 15680f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1569cb92c03bSAndrew Geissler } 1570ebd45906SGeorge Liu else 1571ebd45906SGeorge Liu { 1572cb92c03bSAndrew Geissler timestamp = 1573d139c236SGeorge Liu crow::utility::getTimestamp(*millisTimeStamp); 1574d139c236SGeorge Liu } 1575ebd45906SGeorge Liu } 1576d139c236SGeorge Liu else if (propertyMap.first == "UpdateTimestamp") 1577d139c236SGeorge Liu { 1578d139c236SGeorge Liu const uint64_t* millisTimeStamp = 1579d139c236SGeorge Liu std::get_if<uint64_t>(&propertyMap.second); 1580d139c236SGeorge Liu if (millisTimeStamp == nullptr) 1581d139c236SGeorge Liu { 1582d139c236SGeorge Liu messages::internalError(asyncResp->res); 1583d139c236SGeorge Liu } 1584ebd45906SGeorge Liu else 1585ebd45906SGeorge Liu { 1586d139c236SGeorge Liu updateTimestamp = 1587d139c236SGeorge Liu crow::utility::getTimestamp(*millisTimeStamp); 1588cb92c03bSAndrew Geissler } 1589ebd45906SGeorge Liu } 1590cb92c03bSAndrew Geissler else if (propertyMap.first == "Severity") 1591cb92c03bSAndrew Geissler { 1592cb92c03bSAndrew Geissler severity = 1593cb92c03bSAndrew Geissler std::get_if<std::string>(&propertyMap.second); 1594cb92c03bSAndrew Geissler if (severity == nullptr) 1595cb92c03bSAndrew Geissler { 15960f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1597cb92c03bSAndrew Geissler } 1598cb92c03bSAndrew Geissler } 1599cb92c03bSAndrew Geissler else if (propertyMap.first == "Message") 1600cb92c03bSAndrew Geissler { 1601cb92c03bSAndrew Geissler message = std::get_if<std::string>(&propertyMap.second); 1602cb92c03bSAndrew Geissler if (message == nullptr) 1603cb92c03bSAndrew Geissler { 16040f1d8ed9SAsmitha Karunanithi messages::internalError(asyncResp->res); 1605cb92c03bSAndrew Geissler } 1606cb92c03bSAndrew Geissler } 1607cb92c03bSAndrew Geissler } 1608271584abSEd Tanous if (id == nullptr || message == nullptr || severity == nullptr) 1609271584abSEd Tanous { 1610271584abSEd Tanous return; 1611271584abSEd Tanous } 1612cb92c03bSAndrew Geissler asyncResp->res.jsonValue = { 1613d139c236SGeorge Liu {"@odata.type", "#LogEntry.v1_6_0.LogEntry"}, 1614cb92c03bSAndrew Geissler {"@odata.id", 1615cb92c03bSAndrew Geissler "/redfish/v1/Systems/system/LogServices/EventLog/" 1616cb92c03bSAndrew Geissler "Entries/" + 1617cb92c03bSAndrew Geissler std::to_string(*id)}, 161827062605SAnthony Wilson {"Name", "System Event Log Entry"}, 1619cb92c03bSAndrew Geissler {"Id", std::to_string(*id)}, 1620cb92c03bSAndrew Geissler {"Message", *message}, 1621cb92c03bSAndrew Geissler {"EntryType", "Event"}, 1622cb92c03bSAndrew Geissler {"Severity", translateSeverityDbusToRedfish(*severity)}, 1623d139c236SGeorge Liu {"Created", crow::utility::getDateTime(timestamp)}, 1624d139c236SGeorge Liu {"Modified", crow::utility::getDateTime(updateTimestamp)}}; 1625cb92c03bSAndrew Geissler }, 1626cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging", 1627cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging/entry/" + entryID, 1628cb92c03bSAndrew Geissler "org.freedesktop.DBus.Properties", "GetAll", 1629cb92c03bSAndrew Geissler "xyz.openbmc_project.Logging.Entry"); 1630c4bf6374SJason M. Bills } 1631336e96c6SChicago Duan 1632cb13a392SEd Tanous void doDelete(crow::Response& res, const crow::Request&, 1633336e96c6SChicago Duan const std::vector<std::string>& params) override 1634336e96c6SChicago Duan { 1635336e96c6SChicago Duan 1636336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "Do delete single event entries."; 1637336e96c6SChicago Duan 1638336e96c6SChicago Duan auto asyncResp = std::make_shared<AsyncResp>(res); 1639336e96c6SChicago Duan 1640336e96c6SChicago Duan if (params.size() != 1) 1641336e96c6SChicago Duan { 1642336e96c6SChicago Duan messages::internalError(asyncResp->res); 1643336e96c6SChicago Duan return; 1644336e96c6SChicago Duan } 1645336e96c6SChicago Duan std::string entryID = params[0]; 1646336e96c6SChicago Duan 1647336e96c6SChicago Duan dbus::utility::escapePathForDbus(entryID); 1648336e96c6SChicago Duan 1649336e96c6SChicago Duan // Process response from Logging service. 1650336e96c6SChicago Duan auto respHandler = [asyncResp](const boost::system::error_code ec) { 1651336e96c6SChicago Duan BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; 1652336e96c6SChicago Duan if (ec) 1653336e96c6SChicago Duan { 1654336e96c6SChicago Duan // TODO Handle for specific error code 1655336e96c6SChicago Duan BMCWEB_LOG_ERROR 1656336e96c6SChicago Duan << "EventLogEntry (DBus) doDelete respHandler got error " 1657336e96c6SChicago Duan << ec; 1658336e96c6SChicago Duan asyncResp->res.result( 1659336e96c6SChicago Duan boost::beast::http::status::internal_server_error); 1660336e96c6SChicago Duan return; 1661336e96c6SChicago Duan } 1662336e96c6SChicago Duan 1663336e96c6SChicago Duan asyncResp->res.result(boost::beast::http::status::ok); 1664336e96c6SChicago Duan }; 1665336e96c6SChicago Duan 1666336e96c6SChicago Duan // Make call to Logging service to request Delete Log 1667336e96c6SChicago Duan crow::connections::systemBus->async_method_call( 1668336e96c6SChicago Duan respHandler, "xyz.openbmc_project.Logging", 1669336e96c6SChicago Duan "/xyz/openbmc_project/logging/entry/" + entryID, 1670336e96c6SChicago Duan "xyz.openbmc_project.Object.Delete", "Delete"); 1671336e96c6SChicago Duan } 1672c4bf6374SJason M. Bills }; 1673c4bf6374SJason M. Bills 1674c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node 1675c4bf6374SJason M. Bills { 1676c4bf6374SJason M. Bills public: 167752cc112dSEd Tanous BMCLogServiceCollection(App& app) : 16784ed77cd5SEd Tanous Node(app, "/redfish/v1/Managers/bmc/LogServices/") 16791da66f75SEd Tanous { 16801da66f75SEd Tanous entityPrivileges = { 1681e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1682e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1683e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1684e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1685e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1686e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 16871da66f75SEd Tanous } 16881da66f75SEd Tanous 16891da66f75SEd Tanous private: 16901da66f75SEd Tanous /** 16911da66f75SEd Tanous * Functions triggers appropriate requests on DBus 16921da66f75SEd Tanous */ 1693cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1694cb13a392SEd Tanous const std::vector<std::string>&) override 16951da66f75SEd Tanous { 1696e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 16971da66f75SEd Tanous // Collections don't include the static data added by SubRoute because 16981da66f75SEd Tanous // it has a duplicate entry for members 1699e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 17001da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 1701e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1702e1f26343SJason M. Bills "/redfish/v1/Managers/bmc/LogServices"; 1703e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 1704e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 17051da66f75SEd Tanous "Collection of LogServices for this Manager"; 1706c4bf6374SJason M. Bills nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 1707c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 17085cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 17095cb1dd27SAsmitha Karunanithi logServiceArray.push_back( 17105cb1dd27SAsmitha Karunanithi {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}}); 17115cb1dd27SAsmitha Karunanithi #endif 1712c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 1713c4bf6374SJason M. Bills logServiceArray.push_back( 171408a4e4b5SAnthony Wilson {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}}); 1715c4bf6374SJason M. Bills #endif 1716e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1717c4bf6374SJason M. Bills logServiceArray.size(); 17181da66f75SEd Tanous } 17191da66f75SEd Tanous }; 17201da66f75SEd Tanous 1721c4bf6374SJason M. Bills class BMCJournalLogService : public Node 17221da66f75SEd Tanous { 17231da66f75SEd Tanous public: 172452cc112dSEd Tanous BMCJournalLogService(App& app) : 1725c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") 1726e1f26343SJason M. Bills { 1727e1f26343SJason M. Bills entityPrivileges = { 1728e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1729e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1730e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1731e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1732e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1733e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1734e1f26343SJason M. Bills } 1735e1f26343SJason M. Bills 1736e1f26343SJason M. Bills private: 1737cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1738cb13a392SEd Tanous const std::vector<std::string>&) override 1739e1f26343SJason M. Bills { 1740e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1741e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1742e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 17430f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 17440f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal"; 1745c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; 1746c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; 1747c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "BMC Journal"; 1748e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 1749cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 1750cd50aa42SJason M. Bills {"@odata.id", 1751086be238SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}}; 1752e1f26343SJason M. Bills } 1753e1f26343SJason M. Bills }; 1754e1f26343SJason M. Bills 1755c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, 1756e1f26343SJason M. Bills sd_journal* journal, 1757c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntryJson) 1758e1f26343SJason M. Bills { 1759e1f26343SJason M. Bills // Get the Log Entry contents 1760e1f26343SJason M. Bills int ret = 0; 1761e1f26343SJason M. Bills 176239e77504SEd Tanous std::string_view msg; 176316428a1aSJason M. Bills ret = getJournalMetadata(journal, "MESSAGE", msg); 1764e1f26343SJason M. Bills if (ret < 0) 1765e1f26343SJason M. Bills { 1766e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); 1767e1f26343SJason M. Bills return 1; 1768e1f26343SJason M. Bills } 1769e1f26343SJason M. Bills 1770e1f26343SJason M. Bills // Get the severity from the PRIORITY field 1771271584abSEd Tanous long int severity = 8; // Default to an invalid priority 177216428a1aSJason M. Bills ret = getJournalMetadata(journal, "PRIORITY", 10, severity); 1773e1f26343SJason M. Bills if (ret < 0) 1774e1f26343SJason M. Bills { 1775e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); 1776e1f26343SJason M. Bills } 1777e1f26343SJason M. Bills 1778e1f26343SJason M. Bills // Get the Created time from the timestamp 177916428a1aSJason M. Bills std::string entryTimeStr; 178016428a1aSJason M. Bills if (!getEntryTimestamp(journal, entryTimeStr)) 1781e1f26343SJason M. Bills { 178216428a1aSJason M. Bills return 1; 1783e1f26343SJason M. Bills } 1784e1f26343SJason M. Bills 1785e1f26343SJason M. Bills // Fill in the log entry with the gathered data 1786c4bf6374SJason M. Bills bmcJournalLogEntryJson = { 1787cb92c03bSAndrew Geissler {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 1788c4bf6374SJason M. Bills {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + 1789c4bf6374SJason M. Bills bmcJournalLogEntryID}, 1790e1f26343SJason M. Bills {"Name", "BMC Journal Entry"}, 1791c4bf6374SJason M. Bills {"Id", bmcJournalLogEntryID}, 179216428a1aSJason M. Bills {"Message", msg}, 1793e1f26343SJason M. Bills {"EntryType", "Oem"}, 1794e1f26343SJason M. Bills {"Severity", 1795b6a61a5eSJason M. Bills severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"}, 1796086be238SEd Tanous {"OemRecordFormat", "BMC Journal Entry"}, 1797e1f26343SJason M. Bills {"Created", std::move(entryTimeStr)}}; 1798e1f26343SJason M. Bills return 0; 1799e1f26343SJason M. Bills } 1800e1f26343SJason M. Bills 1801c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node 1802e1f26343SJason M. Bills { 1803e1f26343SJason M. Bills public: 180452cc112dSEd Tanous BMCJournalLogEntryCollection(App& app) : 1805c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") 1806e1f26343SJason M. Bills { 1807e1f26343SJason M. Bills entityPrivileges = { 1808e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1809e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1810e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1811e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1812e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1813e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1814e1f26343SJason M. Bills } 1815e1f26343SJason M. Bills 1816e1f26343SJason M. Bills private: 1817e1f26343SJason M. Bills void doGet(crow::Response& res, const crow::Request& req, 1818cb13a392SEd Tanous const std::vector<std::string>&) override 1819e1f26343SJason M. Bills { 1820e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1821193ad2faSJason M. Bills static constexpr const long maxEntriesPerPage = 1000; 1822271584abSEd Tanous uint64_t skip = 0; 1823271584abSEd Tanous uint64_t top = maxEntriesPerPage; // Show max entries by default 182416428a1aSJason M. Bills if (!getSkipParam(asyncResp->res, req, skip)) 1825193ad2faSJason M. Bills { 1826193ad2faSJason M. Bills return; 1827193ad2faSJason M. Bills } 182816428a1aSJason M. Bills if (!getTopParam(asyncResp->res, req, top)) 1829193ad2faSJason M. Bills { 1830193ad2faSJason M. Bills return; 1831193ad2faSJason M. Bills } 1832e1f26343SJason M. Bills // Collections don't include the static data added by SubRoute because 1833e1f26343SJason M. Bills // it has a duplicate entry for members 1834e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1835e1f26343SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 18360f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 18370f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 1838e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1839c4bf6374SJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; 1840e1f26343SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; 1841e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 1842e1f26343SJason M. Bills "Collection of BMC Journal Entries"; 18430f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 18440f74e643SEd Tanous "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries"; 1845e1f26343SJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1846e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 1847e1f26343SJason M. Bills 1848e1f26343SJason M. Bills // Go through the journal and use the timestamp to create a unique ID 1849e1f26343SJason M. Bills // for each entry 1850e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 1851e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 1852e1f26343SJason M. Bills if (ret < 0) 1853e1f26343SJason M. Bills { 1854e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 1855f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1856e1f26343SJason M. Bills return; 1857e1f26343SJason M. Bills } 1858e1f26343SJason M. Bills std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 1859e1f26343SJason M. Bills journalTmp, sd_journal_close); 1860e1f26343SJason M. Bills journalTmp = nullptr; 1861b01bf299SEd Tanous uint64_t entryCount = 0; 1862e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1863e85d6b16SJason M. Bills bool firstEntry = true; 1864e1f26343SJason M. Bills SD_JOURNAL_FOREACH(journal.get()) 1865e1f26343SJason M. Bills { 1866193ad2faSJason M. Bills entryCount++; 1867193ad2faSJason M. Bills // Handle paging using skip (number of entries to skip from the 1868193ad2faSJason M. Bills // start) and top (number of entries to display) 1869193ad2faSJason M. Bills if (entryCount <= skip || entryCount > skip + top) 1870193ad2faSJason M. Bills { 1871193ad2faSJason M. Bills continue; 1872193ad2faSJason M. Bills } 1873193ad2faSJason M. Bills 187416428a1aSJason M. Bills std::string idStr; 1875e85d6b16SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 1876e1f26343SJason M. Bills { 1877e1f26343SJason M. Bills continue; 1878e1f26343SJason M. Bills } 1879e1f26343SJason M. Bills 1880e85d6b16SJason M. Bills if (firstEntry) 1881e85d6b16SJason M. Bills { 1882e85d6b16SJason M. Bills firstEntry = false; 1883e85d6b16SJason M. Bills } 1884e85d6b16SJason M. Bills 1885e1f26343SJason M. Bills logEntryArray.push_back({}); 1886c4bf6374SJason M. Bills nlohmann::json& bmcJournalLogEntry = logEntryArray.back(); 1887c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(idStr, journal.get(), 1888c4bf6374SJason M. Bills bmcJournalLogEntry) != 0) 1889e1f26343SJason M. Bills { 1890f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1891e1f26343SJason M. Bills return; 1892e1f26343SJason M. Bills } 1893e1f26343SJason M. Bills } 1894193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 1895193ad2faSJason M. Bills if (skip + top < entryCount) 1896193ad2faSJason M. Bills { 1897193ad2faSJason M. Bills asyncResp->res.jsonValue["Members@odata.nextLink"] = 1898c4bf6374SJason M. Bills "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + 1899193ad2faSJason M. Bills std::to_string(skip + top); 1900193ad2faSJason M. Bills } 1901e1f26343SJason M. Bills } 1902e1f26343SJason M. Bills }; 1903e1f26343SJason M. Bills 1904c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node 1905e1f26343SJason M. Bills { 1906e1f26343SJason M. Bills public: 190752cc112dSEd Tanous BMCJournalLogEntry(App& app) : 1908c4bf6374SJason M. Bills Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/", 1909e1f26343SJason M. Bills std::string()) 1910e1f26343SJason M. Bills { 1911e1f26343SJason M. Bills entityPrivileges = { 1912e1f26343SJason M. Bills {boost::beast::http::verb::get, {{"Login"}}}, 1913e1f26343SJason M. Bills {boost::beast::http::verb::head, {{"Login"}}}, 1914e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 1915e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 1916e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 1917e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 1918e1f26343SJason M. Bills } 1919e1f26343SJason M. Bills 1920e1f26343SJason M. Bills private: 1921cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 1922e1f26343SJason M. Bills const std::vector<std::string>& params) override 1923e1f26343SJason M. Bills { 1924e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1925e1f26343SJason M. Bills if (params.size() != 1) 1926e1f26343SJason M. Bills { 1927f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1928e1f26343SJason M. Bills return; 1929e1f26343SJason M. Bills } 193016428a1aSJason M. Bills const std::string& entryID = params[0]; 1931e1f26343SJason M. Bills // Convert the unique ID back to a timestamp to find the entry 1932e1f26343SJason M. Bills uint64_t ts = 0; 1933271584abSEd Tanous uint64_t index = 0; 193416428a1aSJason M. Bills if (!getTimestampFromID(asyncResp->res, entryID, ts, index)) 1935e1f26343SJason M. Bills { 193616428a1aSJason M. Bills return; 1937e1f26343SJason M. Bills } 1938e1f26343SJason M. Bills 1939e1f26343SJason M. Bills sd_journal* journalTmp = nullptr; 1940e1f26343SJason M. Bills int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); 1941e1f26343SJason M. Bills if (ret < 0) 1942e1f26343SJason M. Bills { 1943e1f26343SJason M. Bills BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); 1944f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1945e1f26343SJason M. Bills return; 1946e1f26343SJason M. Bills } 1947e1f26343SJason M. Bills std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( 1948e1f26343SJason M. Bills journalTmp, sd_journal_close); 1949e1f26343SJason M. Bills journalTmp = nullptr; 1950e1f26343SJason M. Bills // Go to the timestamp in the log and move to the entry at the index 1951af07e3f5SJason M. Bills // tracking the unique ID 1952af07e3f5SJason M. Bills std::string idStr; 1953af07e3f5SJason M. Bills bool firstEntry = true; 1954e1f26343SJason M. Bills ret = sd_journal_seek_realtime_usec(journal.get(), ts); 19552056b6d1SManojkiran Eda if (ret < 0) 19562056b6d1SManojkiran Eda { 19572056b6d1SManojkiran Eda BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" 19582056b6d1SManojkiran Eda << strerror(-ret); 19592056b6d1SManojkiran Eda messages::internalError(asyncResp->res); 19602056b6d1SManojkiran Eda return; 19612056b6d1SManojkiran Eda } 1962271584abSEd Tanous for (uint64_t i = 0; i <= index; i++) 1963e1f26343SJason M. Bills { 1964e1f26343SJason M. Bills sd_journal_next(journal.get()); 1965af07e3f5SJason M. Bills if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) 1966af07e3f5SJason M. Bills { 1967af07e3f5SJason M. Bills messages::internalError(asyncResp->res); 1968af07e3f5SJason M. Bills return; 1969af07e3f5SJason M. Bills } 1970af07e3f5SJason M. Bills if (firstEntry) 1971af07e3f5SJason M. Bills { 1972af07e3f5SJason M. Bills firstEntry = false; 1973af07e3f5SJason M. Bills } 1974e1f26343SJason M. Bills } 1975c4bf6374SJason M. Bills // Confirm that the entry ID matches what was requested 1976af07e3f5SJason M. Bills if (idStr != entryID) 1977c4bf6374SJason M. Bills { 1978c4bf6374SJason M. Bills messages::resourceMissingAtURI(asyncResp->res, entryID); 1979c4bf6374SJason M. Bills return; 1980c4bf6374SJason M. Bills } 1981c4bf6374SJason M. Bills 1982c4bf6374SJason M. Bills if (fillBMCJournalLogEntryJson(entryID, journal.get(), 1983e1f26343SJason M. Bills asyncResp->res.jsonValue) != 0) 1984e1f26343SJason M. Bills { 1985f12894f8SJason M. Bills messages::internalError(asyncResp->res); 1986e1f26343SJason M. Bills return; 1987e1f26343SJason M. Bills } 1988e1f26343SJason M. Bills } 1989e1f26343SJason M. Bills }; 1990e1f26343SJason M. Bills 19915cb1dd27SAsmitha Karunanithi class BMCDumpService : public Node 1992c9bb6861Sraviteja-b { 1993c9bb6861Sraviteja-b public: 199452cc112dSEd Tanous BMCDumpService(App& app) : 19955cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") 1996c9bb6861Sraviteja-b { 1997c9bb6861Sraviteja-b entityPrivileges = { 1998c9bb6861Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 1999c9bb6861Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 2000c9bb6861Sraviteja-b {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2001c9bb6861Sraviteja-b {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2002c9bb6861Sraviteja-b {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2003c9bb6861Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2004c9bb6861Sraviteja-b } 2005c9bb6861Sraviteja-b 2006c9bb6861Sraviteja-b private: 2007cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2008cb13a392SEd Tanous const std::vector<std::string>&) override 2009c9bb6861Sraviteja-b { 2010c9bb6861Sraviteja-b std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2011c9bb6861Sraviteja-b 2012c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 20135cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump"; 2014c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2015d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 2016c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 20175cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = "BMC Dump LogService"; 20185cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 2019c9bb6861Sraviteja-b asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2020c9bb6861Sraviteja-b asyncResp->res.jsonValue["Entries"] = { 20215cb1dd27SAsmitha Karunanithi {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}}; 20225cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 20235cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 20245cb1dd27SAsmitha Karunanithi {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/" 20255cb1dd27SAsmitha Karunanithi "Actions/LogService.ClearLog"}}}, 2026d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 2027d337bb72SAsmitha Karunanithi {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/" 2028d337bb72SAsmitha Karunanithi "Actions/LogService.CollectDiagnosticData"}}}}; 2029c9bb6861Sraviteja-b } 2030c9bb6861Sraviteja-b }; 2031c9bb6861Sraviteja-b 20325cb1dd27SAsmitha Karunanithi class BMCDumpEntryCollection : public Node 2033c9bb6861Sraviteja-b { 2034c9bb6861Sraviteja-b public: 203552cc112dSEd Tanous BMCDumpEntryCollection(App& app) : 20365cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") 2037c9bb6861Sraviteja-b { 2038c9bb6861Sraviteja-b entityPrivileges = { 2039c9bb6861Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 2040c9bb6861Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 2041c9bb6861Sraviteja-b {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2042c9bb6861Sraviteja-b {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2043c9bb6861Sraviteja-b {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2044c9bb6861Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2045c9bb6861Sraviteja-b } 2046c9bb6861Sraviteja-b 2047c9bb6861Sraviteja-b private: 2048c9bb6861Sraviteja-b /** 2049c9bb6861Sraviteja-b * Functions triggers appropriate requests on DBus 2050c9bb6861Sraviteja-b */ 2051cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2052cb13a392SEd Tanous const std::vector<std::string>&) override 2053c9bb6861Sraviteja-b { 2054c9bb6861Sraviteja-b std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2055c9bb6861Sraviteja-b 2056c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.type"] = 2057c9bb6861Sraviteja-b "#LogEntryCollection.LogEntryCollection"; 2058c9bb6861Sraviteja-b asyncResp->res.jsonValue["@odata.id"] = 20595cb1dd27SAsmitha Karunanithi "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"; 20605cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "BMC Dump Entries"; 2061c9bb6861Sraviteja-b asyncResp->res.jsonValue["Description"] = 20625cb1dd27SAsmitha Karunanithi "Collection of BMC Dump Entries"; 2063c9bb6861Sraviteja-b 20645cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "BMC"); 2065c9bb6861Sraviteja-b } 2066c9bb6861Sraviteja-b }; 2067c9bb6861Sraviteja-b 20685cb1dd27SAsmitha Karunanithi class BMCDumpEntry : public Node 2069c9bb6861Sraviteja-b { 2070c9bb6861Sraviteja-b public: 207152cc112dSEd Tanous BMCDumpEntry(App& app) : 20725cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/", 2073c9bb6861Sraviteja-b std::string()) 2074c9bb6861Sraviteja-b { 2075c9bb6861Sraviteja-b entityPrivileges = { 2076c9bb6861Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 2077c9bb6861Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 2078c9bb6861Sraviteja-b {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2079c9bb6861Sraviteja-b {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2080c9bb6861Sraviteja-b {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2081c9bb6861Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2082c9bb6861Sraviteja-b } 2083c9bb6861Sraviteja-b 2084c9bb6861Sraviteja-b private: 2085cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2086c9bb6861Sraviteja-b const std::vector<std::string>& params) override 2087c9bb6861Sraviteja-b { 2088c9bb6861Sraviteja-b std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2089c9bb6861Sraviteja-b if (params.size() != 1) 2090c9bb6861Sraviteja-b { 2091c9bb6861Sraviteja-b messages::internalError(asyncResp->res); 2092c9bb6861Sraviteja-b return; 2093c9bb6861Sraviteja-b } 20945cb1dd27SAsmitha Karunanithi getDumpEntryById(asyncResp, params[0], "BMC"); 2095c9bb6861Sraviteja-b } 2096c9bb6861Sraviteja-b 2097cb13a392SEd Tanous void doDelete(crow::Response& res, const crow::Request&, 2098c9bb6861Sraviteja-b const std::vector<std::string>& params) override 2099c9bb6861Sraviteja-b { 21005cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2101c9bb6861Sraviteja-b if (params.size() != 1) 2102c9bb6861Sraviteja-b { 2103c9bb6861Sraviteja-b messages::internalError(asyncResp->res); 2104c9bb6861Sraviteja-b return; 2105c9bb6861Sraviteja-b } 21065cb1dd27SAsmitha Karunanithi deleteDumpEntry(asyncResp->res, params[0]); 21075cb1dd27SAsmitha Karunanithi } 21085cb1dd27SAsmitha Karunanithi }; 2109c9bb6861Sraviteja-b 2110a43be80fSAsmitha Karunanithi class BMCDumpCreate : public Node 2111a43be80fSAsmitha Karunanithi { 2112a43be80fSAsmitha Karunanithi public: 211352cc112dSEd Tanous BMCDumpCreate(App& app) : 2114a43be80fSAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" 2115d337bb72SAsmitha Karunanithi "Actions/" 2116d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData/") 2117a43be80fSAsmitha Karunanithi { 2118a43be80fSAsmitha Karunanithi entityPrivileges = { 2119a43be80fSAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 2120a43be80fSAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 2121a43be80fSAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2122a43be80fSAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2123a43be80fSAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2124a43be80fSAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2125a43be80fSAsmitha Karunanithi } 2126a43be80fSAsmitha Karunanithi 2127a43be80fSAsmitha Karunanithi private: 2128a43be80fSAsmitha Karunanithi void doPost(crow::Response& res, const crow::Request& req, 2129cb13a392SEd Tanous const std::vector<std::string>&) override 2130a43be80fSAsmitha Karunanithi { 2131a43be80fSAsmitha Karunanithi createDump(res, req, "BMC"); 2132a43be80fSAsmitha Karunanithi } 2133a43be80fSAsmitha Karunanithi }; 2134a43be80fSAsmitha Karunanithi 213580319af1SAsmitha Karunanithi class BMCDumpClear : public Node 213680319af1SAsmitha Karunanithi { 213780319af1SAsmitha Karunanithi public: 213852cc112dSEd Tanous BMCDumpClear(App& app) : 213980319af1SAsmitha Karunanithi Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" 214080319af1SAsmitha Karunanithi "Actions/" 214180319af1SAsmitha Karunanithi "LogService.ClearLog/") 214280319af1SAsmitha Karunanithi { 214380319af1SAsmitha Karunanithi entityPrivileges = { 214480319af1SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 214580319af1SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 214680319af1SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 214780319af1SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 214880319af1SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 214980319af1SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 215080319af1SAsmitha Karunanithi } 215180319af1SAsmitha Karunanithi 215280319af1SAsmitha Karunanithi private: 2153cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2154cb13a392SEd Tanous const std::vector<std::string>&) override 215580319af1SAsmitha Karunanithi { 215680319af1SAsmitha Karunanithi clearDump(res, "xyz.openbmc_project.Dump.Entry.BMC"); 215780319af1SAsmitha Karunanithi } 215880319af1SAsmitha Karunanithi }; 215980319af1SAsmitha Karunanithi 21605cb1dd27SAsmitha Karunanithi class SystemDumpService : public Node 2161c9bb6861Sraviteja-b { 21625cb1dd27SAsmitha Karunanithi public: 216352cc112dSEd Tanous SystemDumpService(App& app) : 21645cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/") 21655cb1dd27SAsmitha Karunanithi { 21665cb1dd27SAsmitha Karunanithi entityPrivileges = { 21675cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 21685cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 21695cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 21705cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 21715cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 21725cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 21735cb1dd27SAsmitha Karunanithi } 21745cb1dd27SAsmitha Karunanithi 21755cb1dd27SAsmitha Karunanithi private: 2176cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2177cb13a392SEd Tanous const std::vector<std::string>&) override 21785cb1dd27SAsmitha Karunanithi { 21795cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 21805cb1dd27SAsmitha Karunanithi 21815cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 21825cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump"; 21835cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 2184d337bb72SAsmitha Karunanithi "#LogService.v1_2_0.LogService"; 21855cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "Dump LogService"; 21865cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = "System Dump LogService"; 21875cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = "Dump"; 21885cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 21895cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Entries"] = { 21905cb1dd27SAsmitha Karunanithi {"@odata.id", 21915cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"}}; 21925cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Actions"] = { 21935cb1dd27SAsmitha Karunanithi {"#LogService.ClearLog", 21945cb1dd27SAsmitha Karunanithi {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/" 21955cb1dd27SAsmitha Karunanithi "LogService.ClearLog"}}}, 2196d337bb72SAsmitha Karunanithi {"#LogService.CollectDiagnosticData", 2197d337bb72SAsmitha Karunanithi {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/" 2198d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData"}}}}; 21995cb1dd27SAsmitha Karunanithi } 22005cb1dd27SAsmitha Karunanithi }; 22015cb1dd27SAsmitha Karunanithi 22025cb1dd27SAsmitha Karunanithi class SystemDumpEntryCollection : public Node 22035cb1dd27SAsmitha Karunanithi { 22045cb1dd27SAsmitha Karunanithi public: 220552cc112dSEd Tanous SystemDumpEntryCollection(App& app) : 22065cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") 22075cb1dd27SAsmitha Karunanithi { 22085cb1dd27SAsmitha Karunanithi entityPrivileges = { 22095cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 22105cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 22115cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 22125cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 22135cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 22145cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 22155cb1dd27SAsmitha Karunanithi } 22165cb1dd27SAsmitha Karunanithi 22175cb1dd27SAsmitha Karunanithi private: 22185cb1dd27SAsmitha Karunanithi /** 22195cb1dd27SAsmitha Karunanithi * Functions triggers appropriate requests on DBus 22205cb1dd27SAsmitha Karunanithi */ 2221cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2222cb13a392SEd Tanous const std::vector<std::string>&) override 22235cb1dd27SAsmitha Karunanithi { 22245cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 22255cb1dd27SAsmitha Karunanithi 22265cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 22275cb1dd27SAsmitha Karunanithi "#LogEntryCollection.LogEntryCollection"; 22285cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.id"] = 22295cb1dd27SAsmitha Karunanithi "/redfish/v1/Systems/system/LogServices/Dump/Entries"; 22305cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = "System Dump Entries"; 22315cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Description"] = 22325cb1dd27SAsmitha Karunanithi "Collection of System Dump Entries"; 22335cb1dd27SAsmitha Karunanithi 22345cb1dd27SAsmitha Karunanithi getDumpEntryCollection(asyncResp, "System"); 22355cb1dd27SAsmitha Karunanithi } 22365cb1dd27SAsmitha Karunanithi }; 22375cb1dd27SAsmitha Karunanithi 22385cb1dd27SAsmitha Karunanithi class SystemDumpEntry : public Node 22395cb1dd27SAsmitha Karunanithi { 22405cb1dd27SAsmitha Karunanithi public: 224152cc112dSEd Tanous SystemDumpEntry(App& app) : 22425cb1dd27SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/", 22435cb1dd27SAsmitha Karunanithi std::string()) 22445cb1dd27SAsmitha Karunanithi { 22455cb1dd27SAsmitha Karunanithi entityPrivileges = { 22465cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 22475cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 22485cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 22495cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 22505cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 22515cb1dd27SAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 22525cb1dd27SAsmitha Karunanithi } 22535cb1dd27SAsmitha Karunanithi 22545cb1dd27SAsmitha Karunanithi private: 2255cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 22565cb1dd27SAsmitha Karunanithi const std::vector<std::string>& params) override 22575cb1dd27SAsmitha Karunanithi { 22585cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 22595cb1dd27SAsmitha Karunanithi if (params.size() != 1) 22605cb1dd27SAsmitha Karunanithi { 2261c9bb6861Sraviteja-b messages::internalError(asyncResp->res); 2262c9bb6861Sraviteja-b return; 2263c9bb6861Sraviteja-b } 22645cb1dd27SAsmitha Karunanithi getDumpEntryById(asyncResp, params[0], "System"); 22655cb1dd27SAsmitha Karunanithi } 2266c9bb6861Sraviteja-b 2267cb13a392SEd Tanous void doDelete(crow::Response& res, const crow::Request&, 22685cb1dd27SAsmitha Karunanithi const std::vector<std::string>& params) override 2269c9bb6861Sraviteja-b { 22705cb1dd27SAsmitha Karunanithi std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 22715cb1dd27SAsmitha Karunanithi if (params.size() != 1) 2272c9bb6861Sraviteja-b { 22735cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 2274c9bb6861Sraviteja-b return; 2275c9bb6861Sraviteja-b } 22765cb1dd27SAsmitha Karunanithi deleteDumpEntry(asyncResp->res, params[0]); 2277c9bb6861Sraviteja-b } 2278c9bb6861Sraviteja-b }; 2279c9bb6861Sraviteja-b 2280a43be80fSAsmitha Karunanithi class SystemDumpCreate : public Node 2281a43be80fSAsmitha Karunanithi { 2282a43be80fSAsmitha Karunanithi public: 228352cc112dSEd Tanous SystemDumpCreate(App& app) : 2284a43be80fSAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/" 2285d337bb72SAsmitha Karunanithi "Actions/" 2286d337bb72SAsmitha Karunanithi "LogService.CollectDiagnosticData/") 2287a43be80fSAsmitha Karunanithi { 2288a43be80fSAsmitha Karunanithi entityPrivileges = { 2289a43be80fSAsmitha Karunanithi {boost::beast::http::verb::get, {{"Login"}}}, 2290a43be80fSAsmitha Karunanithi {boost::beast::http::verb::head, {{"Login"}}}, 2291a43be80fSAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2292a43be80fSAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2293a43be80fSAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2294a43be80fSAsmitha Karunanithi {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2295a43be80fSAsmitha Karunanithi } 2296a43be80fSAsmitha Karunanithi 2297a43be80fSAsmitha Karunanithi private: 2298a43be80fSAsmitha Karunanithi void doPost(crow::Response& res, const crow::Request& req, 2299cb13a392SEd Tanous const std::vector<std::string>&) override 2300a43be80fSAsmitha Karunanithi { 2301a43be80fSAsmitha Karunanithi createDump(res, req, "System"); 2302a43be80fSAsmitha Karunanithi } 2303a43be80fSAsmitha Karunanithi }; 2304a43be80fSAsmitha Karunanithi 2305013487e5Sraviteja-b class SystemDumpClear : public Node 2306013487e5Sraviteja-b { 2307013487e5Sraviteja-b public: 230852cc112dSEd Tanous SystemDumpClear(App& app) : 230980319af1SAsmitha Karunanithi Node(app, "/redfish/v1/Systems/system/LogServices/Dump/" 2310013487e5Sraviteja-b "Actions/" 2311013487e5Sraviteja-b "LogService.ClearLog/") 2312013487e5Sraviteja-b { 2313013487e5Sraviteja-b entityPrivileges = { 2314013487e5Sraviteja-b {boost::beast::http::verb::get, {{"Login"}}}, 2315013487e5Sraviteja-b {boost::beast::http::verb::head, {{"Login"}}}, 231680319af1SAsmitha Karunanithi {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 231780319af1SAsmitha Karunanithi {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 231880319af1SAsmitha Karunanithi {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2319013487e5Sraviteja-b {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2320013487e5Sraviteja-b } 2321013487e5Sraviteja-b 2322013487e5Sraviteja-b private: 2323cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2324cb13a392SEd Tanous const std::vector<std::string>&) override 2325013487e5Sraviteja-b { 232680319af1SAsmitha Karunanithi clearDump(res, "xyz.openbmc_project.Dump.Entry.System"); 2327013487e5Sraviteja-b } 2328013487e5Sraviteja-b }; 2329013487e5Sraviteja-b 2330424c4176SJason M. Bills class CrashdumpService : public Node 2331e1f26343SJason M. Bills { 2332e1f26343SJason M. Bills public: 233352cc112dSEd Tanous CrashdumpService(App& app) : 2334424c4176SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") 23351da66f75SEd Tanous { 23363946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 23373946028dSAppaRao Puli // method for security reasons. 23381da66f75SEd Tanous entityPrivileges = { 23393946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 23403946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2341e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2342e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2343e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2344e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 23451da66f75SEd Tanous } 23461da66f75SEd Tanous 23471da66f75SEd Tanous private: 23481da66f75SEd Tanous /** 23491da66f75SEd Tanous * Functions triggers appropriate requests on DBus 23501da66f75SEd Tanous */ 2351cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2352cb13a392SEd Tanous const std::vector<std::string>&) override 23531da66f75SEd Tanous { 2354e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 23551da66f75SEd Tanous // Copy over the static data to include the entries added by SubRoute 23560f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2357424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump"; 2358e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 2359e1f26343SJason M. Bills "#LogService.v1_1_0.LogService"; 23604f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 23614f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 23624f50ae4bSGunnar Mills asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; 2363e1f26343SJason M. Bills asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; 2364e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 2365cd50aa42SJason M. Bills asyncResp->res.jsonValue["Entries"] = { 2366cd50aa42SJason M. Bills {"@odata.id", 2367424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}}; 2368e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"] = { 23695b61b5e8SJason M. Bills {"#LogService.ClearLog", 23705b61b5e8SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23715b61b5e8SJason M. Bills "Actions/LogService.ClearLog"}}}, 23721da66f75SEd Tanous {"Oem", 2373424c4176SJason M. Bills {{"#Crashdump.OnDemand", 2374424c4176SJason M. Bills {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23756eda7685SKenny L. Ku "Actions/Oem/Crashdump.OnDemand"}}}, 23766eda7685SKenny L. Ku {"#Crashdump.Telemetry", 23776eda7685SKenny L. Ku {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 23786eda7685SKenny L. Ku "Actions/Oem/Crashdump.Telemetry"}}}}}}; 23791da66f75SEd Tanous 23801da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI 2381e1f26343SJason M. Bills asyncResp->res.jsonValue["Actions"]["Oem"].push_back( 2382424c4176SJason M. Bills {"#Crashdump.SendRawPeci", 238308a4e4b5SAnthony Wilson {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" 2384424c4176SJason M. Bills "Actions/Oem/Crashdump.SendRawPeci"}}}); 23851da66f75SEd Tanous #endif 23861da66f75SEd Tanous } 23871da66f75SEd Tanous }; 23881da66f75SEd Tanous 23895b61b5e8SJason M. Bills class CrashdumpClear : public Node 23905b61b5e8SJason M. Bills { 23915b61b5e8SJason M. Bills public: 239252cc112dSEd Tanous CrashdumpClear(App& app) : 23935b61b5e8SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/" 23945b61b5e8SJason M. Bills "LogService.ClearLog/") 23955b61b5e8SJason M. Bills { 23963946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 23973946028dSAppaRao Puli // method for security reasons. 23985b61b5e8SJason M. Bills entityPrivileges = { 23993946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 24003946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 24015b61b5e8SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 24025b61b5e8SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 24035b61b5e8SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 24045b61b5e8SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 24055b61b5e8SJason M. Bills } 24065b61b5e8SJason M. Bills 24075b61b5e8SJason M. Bills private: 2408cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2409cb13a392SEd Tanous const std::vector<std::string>&) override 24105b61b5e8SJason M. Bills { 24115b61b5e8SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 24125b61b5e8SJason M. Bills 24135b61b5e8SJason M. Bills crow::connections::systemBus->async_method_call( 24145b61b5e8SJason M. Bills [asyncResp](const boost::system::error_code ec, 2415cb13a392SEd Tanous const std::string&) { 24165b61b5e8SJason M. Bills if (ec) 24175b61b5e8SJason M. Bills { 24185b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 24195b61b5e8SJason M. Bills return; 24205b61b5e8SJason M. Bills } 24215b61b5e8SJason M. Bills messages::success(asyncResp->res); 24225b61b5e8SJason M. Bills }, 24235b61b5e8SJason M. Bills crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); 24245b61b5e8SJason M. Bills } 24255b61b5e8SJason M. Bills }; 24265b61b5e8SJason M. Bills 2427e855dd28SJason M. Bills static void logCrashdumpEntry(std::shared_ptr<AsyncResp> asyncResp, 2428e855dd28SJason M. Bills const std::string& logID, 2429e855dd28SJason M. Bills nlohmann::json& logEntryJson) 2430e855dd28SJason M. Bills { 2431043a0536SJohnathan Mantey auto getStoredLogCallback = 2432043a0536SJohnathan Mantey [asyncResp, logID, &logEntryJson]( 2433e855dd28SJason M. Bills const boost::system::error_code ec, 2434043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& params) { 2435e855dd28SJason M. Bills if (ec) 2436e855dd28SJason M. Bills { 2437e855dd28SJason M. Bills BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); 24381ddcf01aSJason M. Bills if (ec.value() == 24391ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 24401ddcf01aSJason M. Bills { 2441043a0536SJohnathan Mantey messages::resourceNotFound(asyncResp->res, "LogEntry", 2442043a0536SJohnathan Mantey logID); 24431ddcf01aSJason M. Bills } 24441ddcf01aSJason M. Bills else 24451ddcf01aSJason M. Bills { 2446e855dd28SJason M. Bills messages::internalError(asyncResp->res); 24471ddcf01aSJason M. Bills } 2448e855dd28SJason M. Bills return; 2449e855dd28SJason M. Bills } 2450043a0536SJohnathan Mantey 2451043a0536SJohnathan Mantey std::string timestamp{}; 2452043a0536SJohnathan Mantey std::string filename{}; 2453043a0536SJohnathan Mantey std::string logfile{}; 24542c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2455043a0536SJohnathan Mantey 2456043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2457e855dd28SJason M. Bills { 2458043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, logID); 2459e855dd28SJason M. Bills return; 2460e855dd28SJason M. Bills } 2461e855dd28SJason M. Bills 2462043a0536SJohnathan Mantey std::string crashdumpURI = 2463e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + 2464043a0536SJohnathan Mantey logID + "/" + filename; 2465043a0536SJohnathan Mantey logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 2466043a0536SJohnathan Mantey {"@odata.id", "/redfish/v1/Systems/system/" 2467043a0536SJohnathan Mantey "LogServices/Crashdump/Entries/" + 2468e855dd28SJason M. Bills logID}, 2469e855dd28SJason M. Bills {"Name", "CPU Crashdump"}, 2470e855dd28SJason M. Bills {"Id", logID}, 2471e855dd28SJason M. Bills {"EntryType", "Oem"}, 2472e855dd28SJason M. Bills {"OemRecordFormat", "Crashdump URI"}, 2473043a0536SJohnathan Mantey {"Message", std::move(crashdumpURI)}, 2474043a0536SJohnathan Mantey {"Created", std::move(timestamp)}}; 2475e855dd28SJason M. Bills }; 2476e855dd28SJason M. Bills crow::connections::systemBus->async_method_call( 24775b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 24785b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2479043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 2480e855dd28SJason M. Bills } 2481e855dd28SJason M. Bills 2482424c4176SJason M. Bills class CrashdumpEntryCollection : public Node 24831da66f75SEd Tanous { 24841da66f75SEd Tanous public: 248552cc112dSEd Tanous CrashdumpEntryCollection(App& app) : 2486424c4176SJason M. Bills Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") 24871da66f75SEd Tanous { 24883946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 24893946028dSAppaRao Puli // method for security reasons. 24901da66f75SEd Tanous entityPrivileges = { 24913946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 24923946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2493e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2494e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2495e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2496e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 24971da66f75SEd Tanous } 24981da66f75SEd Tanous 24991da66f75SEd Tanous private: 25001da66f75SEd Tanous /** 25011da66f75SEd Tanous * Functions triggers appropriate requests on DBus 25021da66f75SEd Tanous */ 2503cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2504cb13a392SEd Tanous const std::vector<std::string>&) override 25051da66f75SEd Tanous { 2506e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 25071da66f75SEd Tanous // Collections don't include the static data added by SubRoute because 25081da66f75SEd Tanous // it has a duplicate entry for members 2509e1f26343SJason M. Bills auto getLogEntriesCallback = [asyncResp]( 2510e1f26343SJason M. Bills const boost::system::error_code ec, 25111da66f75SEd Tanous const std::vector<std::string>& resp) { 25121da66f75SEd Tanous if (ec) 25131da66f75SEd Tanous { 25141da66f75SEd Tanous if (ec.value() != 25151da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 25161da66f75SEd Tanous { 25171da66f75SEd Tanous BMCWEB_LOG_DEBUG << "failed to get entries ec: " 25181da66f75SEd Tanous << ec.message(); 2519f12894f8SJason M. Bills messages::internalError(asyncResp->res); 25201da66f75SEd Tanous return; 25211da66f75SEd Tanous } 25221da66f75SEd Tanous } 2523e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 25241da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 25250f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2526424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; 2527424c4176SJason M. Bills asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; 2528e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2529424c4176SJason M. Bills "Collection of Crashdump Entries"; 2530e1f26343SJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 2531e1f26343SJason M. Bills logEntryArray = nlohmann::json::array(); 2532e855dd28SJason M. Bills std::vector<std::string> logIDs; 2533e855dd28SJason M. Bills // Get the list of log entries and build up an empty array big 2534e855dd28SJason M. Bills // enough to hold them 25351da66f75SEd Tanous for (const std::string& objpath : resp) 25361da66f75SEd Tanous { 2537e855dd28SJason M. Bills // Get the log ID 25384ed77cd5SEd Tanous std::size_t lastPos = objpath.rfind("/"); 2539e855dd28SJason M. Bills if (lastPos == std::string::npos) 25401da66f75SEd Tanous { 2541e855dd28SJason M. Bills continue; 25421da66f75SEd Tanous } 2543e855dd28SJason M. Bills logIDs.emplace_back(objpath.substr(lastPos + 1)); 2544e855dd28SJason M. Bills 2545e855dd28SJason M. Bills // Add a space for the log entry to the array 2546e855dd28SJason M. Bills logEntryArray.push_back({}); 2547e855dd28SJason M. Bills } 2548e855dd28SJason M. Bills // Now go through and set up async calls to fill in the entries 2549e855dd28SJason M. Bills size_t index = 0; 2550e855dd28SJason M. Bills for (const std::string& logID : logIDs) 2551e855dd28SJason M. Bills { 2552e855dd28SJason M. Bills // Add the log entry to the array 2553e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]); 25541da66f75SEd Tanous } 2555e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2556e1f26343SJason M. Bills logEntryArray.size(); 25571da66f75SEd Tanous }; 25581da66f75SEd Tanous crow::connections::systemBus->async_method_call( 25591da66f75SEd Tanous std::move(getLogEntriesCallback), 25601da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", 25611da66f75SEd Tanous "/xyz/openbmc_project/object_mapper", 25621da66f75SEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, 25635b61b5e8SJason M. Bills std::array<const char*, 1>{crashdumpInterface}); 25641da66f75SEd Tanous } 25651da66f75SEd Tanous }; 25661da66f75SEd Tanous 2567424c4176SJason M. Bills class CrashdumpEntry : public Node 25681da66f75SEd Tanous { 25691da66f75SEd Tanous public: 257052cc112dSEd Tanous CrashdumpEntry(App& app) : 2571d53dd41fSJason M. Bills Node(app, 2572424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/", 25731da66f75SEd Tanous std::string()) 25741da66f75SEd Tanous { 25753946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 25763946028dSAppaRao Puli // method for security reasons. 25771da66f75SEd Tanous entityPrivileges = { 25783946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 25793946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2580e1f26343SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2581e1f26343SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2582e1f26343SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2583e1f26343SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 25841da66f75SEd Tanous } 25851da66f75SEd Tanous 25861da66f75SEd Tanous private: 2587cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 25881da66f75SEd Tanous const std::vector<std::string>& params) override 25891da66f75SEd Tanous { 2590e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 25911da66f75SEd Tanous if (params.size() != 1) 25921da66f75SEd Tanous { 2593f12894f8SJason M. Bills messages::internalError(asyncResp->res); 25941da66f75SEd Tanous return; 25951da66f75SEd Tanous } 2596e855dd28SJason M. Bills const std::string& logID = params[0]; 2597e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 2598e855dd28SJason M. Bills } 2599e855dd28SJason M. Bills }; 2600e855dd28SJason M. Bills 2601e855dd28SJason M. Bills class CrashdumpFile : public Node 2602e855dd28SJason M. Bills { 2603e855dd28SJason M. Bills public: 260452cc112dSEd Tanous CrashdumpFile(App& app) : 2605e855dd28SJason M. Bills Node(app, 2606e855dd28SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/" 2607e855dd28SJason M. Bills "<str>/", 2608e855dd28SJason M. Bills std::string(), std::string()) 2609e855dd28SJason M. Bills { 26103946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 26113946028dSAppaRao Puli // method for security reasons. 2612e855dd28SJason M. Bills entityPrivileges = { 26133946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 26143946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 2615e855dd28SJason M. Bills {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2616e855dd28SJason M. Bills {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2617e855dd28SJason M. Bills {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2618e855dd28SJason M. Bills {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2619e855dd28SJason M. Bills } 2620e855dd28SJason M. Bills 2621e855dd28SJason M. Bills private: 2622cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2623e855dd28SJason M. Bills const std::vector<std::string>& params) override 2624e855dd28SJason M. Bills { 2625e855dd28SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2626e855dd28SJason M. Bills if (params.size() != 2) 2627e855dd28SJason M. Bills { 2628e855dd28SJason M. Bills messages::internalError(asyncResp->res); 2629e855dd28SJason M. Bills return; 2630e855dd28SJason M. Bills } 2631e855dd28SJason M. Bills const std::string& logID = params[0]; 2632e855dd28SJason M. Bills const std::string& fileName = params[1]; 2633e855dd28SJason M. Bills 2634043a0536SJohnathan Mantey auto getStoredLogCallback = 2635043a0536SJohnathan Mantey [asyncResp, logID, fileName]( 2636abf2add6SEd Tanous const boost::system::error_code ec, 2637043a0536SJohnathan Mantey const std::vector<std::pair<std::string, VariantType>>& resp) { 26381da66f75SEd Tanous if (ec) 26391da66f75SEd Tanous { 2640043a0536SJohnathan Mantey BMCWEB_LOG_DEBUG << "failed to get log ec: " 2641043a0536SJohnathan Mantey << ec.message(); 2642f12894f8SJason M. Bills messages::internalError(asyncResp->res); 26431da66f75SEd Tanous return; 26441da66f75SEd Tanous } 2645e855dd28SJason M. Bills 2646043a0536SJohnathan Mantey std::string dbusFilename{}; 2647043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2648043a0536SJohnathan Mantey std::string dbusFilepath{}; 2649043a0536SJohnathan Mantey 26502c70f800SEd Tanous parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, 2651043a0536SJohnathan Mantey dbusFilepath); 2652043a0536SJohnathan Mantey 2653043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2654043a0536SJohnathan Mantey dbusFilepath.empty()) 26551da66f75SEd Tanous { 2656e855dd28SJason M. Bills messages::resourceMissingAtURI(asyncResp->res, fileName); 26571da66f75SEd Tanous return; 26581da66f75SEd Tanous } 2659e855dd28SJason M. Bills 2660043a0536SJohnathan Mantey // Verify the file name parameter is correct 2661043a0536SJohnathan Mantey if (fileName != dbusFilename) 2662043a0536SJohnathan Mantey { 2663043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, fileName); 2664043a0536SJohnathan Mantey return; 2665043a0536SJohnathan Mantey } 2666043a0536SJohnathan Mantey 2667043a0536SJohnathan Mantey if (!std::filesystem::exists(dbusFilepath)) 2668043a0536SJohnathan Mantey { 2669043a0536SJohnathan Mantey messages::resourceMissingAtURI(asyncResp->res, fileName); 2670043a0536SJohnathan Mantey return; 2671043a0536SJohnathan Mantey } 2672043a0536SJohnathan Mantey std::ifstream ifs(dbusFilepath, std::ios::in | 2673043a0536SJohnathan Mantey std::ios::binary | 2674043a0536SJohnathan Mantey std::ios::ate); 2675043a0536SJohnathan Mantey std::ifstream::pos_type fileSize = ifs.tellg(); 2676043a0536SJohnathan Mantey if (fileSize < 0) 2677043a0536SJohnathan Mantey { 2678043a0536SJohnathan Mantey messages::generalError(asyncResp->res); 2679043a0536SJohnathan Mantey return; 2680043a0536SJohnathan Mantey } 2681043a0536SJohnathan Mantey ifs.seekg(0, std::ios::beg); 2682043a0536SJohnathan Mantey 2683043a0536SJohnathan Mantey auto crashData = std::make_unique<char[]>( 2684043a0536SJohnathan Mantey static_cast<unsigned int>(fileSize)); 2685043a0536SJohnathan Mantey 2686043a0536SJohnathan Mantey ifs.read(crashData.get(), static_cast<int>(fileSize)); 2687043a0536SJohnathan Mantey 2688043a0536SJohnathan Mantey // The cast to std::string is intentional in order to use the 2689043a0536SJohnathan Mantey // assign() that applies move mechanics 2690043a0536SJohnathan Mantey asyncResp->res.body().assign( 2691043a0536SJohnathan Mantey static_cast<std::string>(crashData.get())); 2692043a0536SJohnathan Mantey 2693043a0536SJohnathan Mantey // Configure this to be a file download when accessed from 2694043a0536SJohnathan Mantey // a browser 2695e855dd28SJason M. Bills asyncResp->res.addHeader("Content-Disposition", "attachment"); 26961da66f75SEd Tanous }; 26971da66f75SEd Tanous crow::connections::systemBus->async_method_call( 26985b61b5e8SJason M. Bills std::move(getStoredLogCallback), crashdumpObject, 26995b61b5e8SJason M. Bills crashdumpPath + std::string("/") + logID, 2700043a0536SJohnathan Mantey "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); 27011da66f75SEd Tanous } 27021da66f75SEd Tanous }; 27031da66f75SEd Tanous 2704424c4176SJason M. Bills class OnDemandCrashdump : public Node 27051da66f75SEd Tanous { 27061da66f75SEd Tanous public: 270752cc112dSEd Tanous OnDemandCrashdump(App& app) : 2708424c4176SJason M. Bills Node(app, 2709424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 2710424c4176SJason M. Bills "Crashdump.OnDemand/") 27111da66f75SEd Tanous { 27123946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 27133946028dSAppaRao Puli // method for security reasons. 27141da66f75SEd Tanous entityPrivileges = { 27153946028dSAppaRao Puli {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 27163946028dSAppaRao Puli {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 27173946028dSAppaRao Puli {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 27183946028dSAppaRao Puli {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 27193946028dSAppaRao Puli {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 27203946028dSAppaRao Puli {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 27211da66f75SEd Tanous } 27221da66f75SEd Tanous 27231da66f75SEd Tanous private: 27241da66f75SEd Tanous void doPost(crow::Response& res, const crow::Request& req, 2725cb13a392SEd Tanous const std::vector<std::string>&) override 27261da66f75SEd Tanous { 2727e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 27281da66f75SEd Tanous 2729fe306728SJames Feist auto generateonDemandLogCallback = [asyncResp, 2730fe306728SJames Feist req](const boost::system::error_code 273146229577SJames Feist ec, 2732cb13a392SEd Tanous const std::string&) { 27331da66f75SEd Tanous if (ec) 27341da66f75SEd Tanous { 273546229577SJames Feist if (ec.value() == boost::system::errc::operation_not_supported) 27361da66f75SEd Tanous { 2737f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 27381da66f75SEd Tanous } 27394363d3b2SJason M. Bills else if (ec.value() == 27404363d3b2SJason M. Bills boost::system::errc::device_or_resource_busy) 27414363d3b2SJason M. Bills { 27424363d3b2SJason M. Bills messages::serviceTemporarilyUnavailable(asyncResp->res, 27434363d3b2SJason M. Bills "60"); 27444363d3b2SJason M. Bills } 27451da66f75SEd Tanous else 27461da66f75SEd Tanous { 2747f12894f8SJason M. Bills messages::internalError(asyncResp->res); 27481da66f75SEd Tanous } 27491da66f75SEd Tanous return; 27501da66f75SEd Tanous } 275146229577SJames Feist std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 275266afe4faSJames Feist [](boost::system::error_code err, sdbusplus::message::message&, 275366afe4faSJames Feist const std::shared_ptr<task::TaskData>& taskData) { 275466afe4faSJames Feist if (!err) 275566afe4faSJames Feist { 2756e5d5006bSJames Feist taskData->messages.emplace_back( 2757e5d5006bSJames Feist messages::taskCompletedOK( 2758e5d5006bSJames Feist std::to_string(taskData->index))); 2759831d6b09SJames Feist taskData->state = "Completed"; 276066afe4faSJames Feist } 276132898ceaSJames Feist return task::completed; 276266afe4faSJames Feist }, 276346229577SJames Feist "type='signal',interface='org.freedesktop.DBus.Properties'," 276446229577SJames Feist "member='PropertiesChanged',arg0namespace='com.intel." 276546229577SJames Feist "crashdump'"); 276646229577SJames Feist task->startTimer(std::chrono::minutes(5)); 276746229577SJames Feist task->populateResp(asyncResp->res); 2768fe306728SJames Feist task->payload.emplace(req); 27691da66f75SEd Tanous }; 27701da66f75SEd Tanous crow::connections::systemBus->async_method_call( 27715b61b5e8SJason M. Bills std::move(generateonDemandLogCallback), crashdumpObject, 27725b61b5e8SJason M. Bills crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog"); 27731da66f75SEd Tanous } 27741da66f75SEd Tanous }; 27751da66f75SEd Tanous 27766eda7685SKenny L. Ku class TelemetryCrashdump : public Node 27776eda7685SKenny L. Ku { 27786eda7685SKenny L. Ku public: 277952cc112dSEd Tanous TelemetryCrashdump(App& app) : 27806eda7685SKenny L. Ku Node(app, 27816eda7685SKenny L. Ku "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 27826eda7685SKenny L. Ku "Crashdump.Telemetry/") 27836eda7685SKenny L. Ku { 27846eda7685SKenny L. Ku // Note: Deviated from redfish privilege registry for GET & HEAD 27856eda7685SKenny L. Ku // method for security reasons. 27866eda7685SKenny L. Ku entityPrivileges = { 27876eda7685SKenny L. Ku {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 27886eda7685SKenny L. Ku {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 27896eda7685SKenny L. Ku {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 27906eda7685SKenny L. Ku {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 27916eda7685SKenny L. Ku {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 27926eda7685SKenny L. Ku {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 27936eda7685SKenny L. Ku } 27946eda7685SKenny L. Ku 27956eda7685SKenny L. Ku private: 27966eda7685SKenny L. Ku void doPost(crow::Response& res, const crow::Request& req, 2797cb13a392SEd Tanous const std::vector<std::string>&) override 27986eda7685SKenny L. Ku { 27996eda7685SKenny L. Ku std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 28006eda7685SKenny L. Ku 28016eda7685SKenny L. Ku auto generateTelemetryLogCallback = [asyncResp, req]( 28026eda7685SKenny L. Ku const boost::system::error_code 28036eda7685SKenny L. Ku ec, 2804cb13a392SEd Tanous const std::string&) { 28056eda7685SKenny L. Ku if (ec) 28066eda7685SKenny L. Ku { 28076eda7685SKenny L. Ku if (ec.value() == boost::system::errc::operation_not_supported) 28086eda7685SKenny L. Ku { 28096eda7685SKenny L. Ku messages::resourceInStandby(asyncResp->res); 28106eda7685SKenny L. Ku } 28116eda7685SKenny L. Ku else if (ec.value() == 28126eda7685SKenny L. Ku boost::system::errc::device_or_resource_busy) 28136eda7685SKenny L. Ku { 28146eda7685SKenny L. Ku messages::serviceTemporarilyUnavailable(asyncResp->res, 28156eda7685SKenny L. Ku "60"); 28166eda7685SKenny L. Ku } 28176eda7685SKenny L. Ku else 28186eda7685SKenny L. Ku { 28196eda7685SKenny L. Ku messages::internalError(asyncResp->res); 28206eda7685SKenny L. Ku } 28216eda7685SKenny L. Ku return; 28226eda7685SKenny L. Ku } 28236eda7685SKenny L. Ku std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 28246eda7685SKenny L. Ku [](boost::system::error_code err, sdbusplus::message::message&, 28256eda7685SKenny L. Ku const std::shared_ptr<task::TaskData>& taskData) { 28266eda7685SKenny L. Ku if (!err) 28276eda7685SKenny L. Ku { 28286eda7685SKenny L. Ku taskData->messages.emplace_back( 28296eda7685SKenny L. Ku messages::taskCompletedOK( 28306eda7685SKenny L. Ku std::to_string(taskData->index))); 28316eda7685SKenny L. Ku taskData->state = "Completed"; 28326eda7685SKenny L. Ku } 28336eda7685SKenny L. Ku return task::completed; 28346eda7685SKenny L. Ku }, 28356eda7685SKenny L. Ku "type='signal',interface='org.freedesktop.DBus.Properties'," 28366eda7685SKenny L. Ku "member='PropertiesChanged',arg0namespace='com.intel." 28376eda7685SKenny L. Ku "crashdump'"); 28386eda7685SKenny L. Ku task->startTimer(std::chrono::minutes(5)); 28396eda7685SKenny L. Ku task->populateResp(asyncResp->res); 28406eda7685SKenny L. Ku task->payload.emplace(req); 28416eda7685SKenny L. Ku }; 28426eda7685SKenny L. Ku crow::connections::systemBus->async_method_call( 28436eda7685SKenny L. Ku std::move(generateTelemetryLogCallback), crashdumpObject, 28446eda7685SKenny L. Ku crashdumpPath, crashdumpTelemetryInterface, "GenerateTelemetryLog"); 28456eda7685SKenny L. Ku } 28466eda7685SKenny L. Ku }; 28476eda7685SKenny L. Ku 2848e1f26343SJason M. Bills class SendRawPECI : public Node 28491da66f75SEd Tanous { 28501da66f75SEd Tanous public: 285152cc112dSEd Tanous SendRawPECI(App& app) : 2852424c4176SJason M. Bills Node(app, 2853424c4176SJason M. Bills "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" 2854424c4176SJason M. Bills "Crashdump.SendRawPeci/") 28551da66f75SEd Tanous { 28563946028dSAppaRao Puli // Note: Deviated from redfish privilege registry for GET & HEAD 28573946028dSAppaRao Puli // method for security reasons. 28581da66f75SEd Tanous entityPrivileges = { 28591da66f75SEd Tanous {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, 28601da66f75SEd Tanous {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, 28611da66f75SEd Tanous {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 28621da66f75SEd Tanous {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 28631da66f75SEd Tanous {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 28641da66f75SEd Tanous {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 28651da66f75SEd Tanous } 28661da66f75SEd Tanous 28671da66f75SEd Tanous private: 28681da66f75SEd Tanous void doPost(crow::Response& res, const crow::Request& req, 2869cb13a392SEd Tanous const std::vector<std::string>&) override 28701da66f75SEd Tanous { 2871e1f26343SJason M. Bills std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 28728724c297SKarthick Sundarrajan std::vector<std::vector<uint8_t>> peciCommands; 28738724c297SKarthick Sundarrajan 28748724c297SKarthick Sundarrajan if (!json_util::readJson(req, res, "PECICommands", peciCommands)) 28758724c297SKarthick Sundarrajan { 28768724c297SKarthick Sundarrajan return; 28778724c297SKarthick Sundarrajan } 28788724c297SKarthick Sundarrajan uint32_t idx = 0; 28798724c297SKarthick Sundarrajan for (auto const& cmd : peciCommands) 28808724c297SKarthick Sundarrajan { 28818724c297SKarthick Sundarrajan if (cmd.size() < 3) 28828724c297SKarthick Sundarrajan { 28838724c297SKarthick Sundarrajan std::string s("["); 28848724c297SKarthick Sundarrajan for (auto const& val : cmd) 28858724c297SKarthick Sundarrajan { 28868724c297SKarthick Sundarrajan if (val != *cmd.begin()) 28878724c297SKarthick Sundarrajan { 28888724c297SKarthick Sundarrajan s += ","; 28898724c297SKarthick Sundarrajan } 28908724c297SKarthick Sundarrajan s += std::to_string(val); 28918724c297SKarthick Sundarrajan } 28928724c297SKarthick Sundarrajan s += "]"; 28938724c297SKarthick Sundarrajan messages::actionParameterValueFormatError( 28948724c297SKarthick Sundarrajan res, s, "PECICommands[" + std::to_string(idx) + "]", 28958724c297SKarthick Sundarrajan "SendRawPeci"); 28968724c297SKarthick Sundarrajan return; 28978724c297SKarthick Sundarrajan } 28988724c297SKarthick Sundarrajan idx++; 28998724c297SKarthick Sundarrajan } 29001da66f75SEd Tanous // Callback to return the Raw PECI response 2901e1f26343SJason M. Bills auto sendRawPECICallback = 2902e1f26343SJason M. Bills [asyncResp](const boost::system::error_code ec, 29038724c297SKarthick Sundarrajan const std::vector<std::vector<uint8_t>>& resp) { 29041da66f75SEd Tanous if (ec) 29051da66f75SEd Tanous { 29068724c297SKarthick Sundarrajan BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: " 29071da66f75SEd Tanous << ec.message(); 2908f12894f8SJason M. Bills messages::internalError(asyncResp->res); 29091da66f75SEd Tanous return; 29101da66f75SEd Tanous } 2911e1f26343SJason M. Bills asyncResp->res.jsonValue = {{"Name", "PECI Command Response"}, 29121da66f75SEd Tanous {"PECIResponse", resp}}; 29131da66f75SEd Tanous }; 29141da66f75SEd Tanous // Call the SendRawPECI command with the provided data 29151da66f75SEd Tanous crow::connections::systemBus->async_method_call( 29165b61b5e8SJason M. Bills std::move(sendRawPECICallback), crashdumpObject, crashdumpPath, 29178724c297SKarthick Sundarrajan crashdumpRawPECIInterface, "SendRawPeci", peciCommands); 29181da66f75SEd Tanous } 29191da66f75SEd Tanous }; 29201da66f75SEd Tanous 2921cb92c03bSAndrew Geissler /** 2922cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 2923cb92c03bSAndrew Geissler */ 2924cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node 2925cb92c03bSAndrew Geissler { 2926cb92c03bSAndrew Geissler public: 292752cc112dSEd Tanous DBusLogServiceActionsClear(App& app) : 2928cb92c03bSAndrew Geissler Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" 29297af91514SGunnar Mills "LogService.ClearLog/") 2930cb92c03bSAndrew Geissler { 2931cb92c03bSAndrew Geissler entityPrivileges = { 2932cb92c03bSAndrew Geissler {boost::beast::http::verb::get, {{"Login"}}}, 2933cb92c03bSAndrew Geissler {boost::beast::http::verb::head, {{"Login"}}}, 2934cb92c03bSAndrew Geissler {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2935cb92c03bSAndrew Geissler {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2936cb92c03bSAndrew Geissler {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2937cb92c03bSAndrew Geissler {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2938cb92c03bSAndrew Geissler } 2939cb92c03bSAndrew Geissler 2940cb92c03bSAndrew Geissler private: 2941cb92c03bSAndrew Geissler /** 2942cb92c03bSAndrew Geissler * Function handles POST method request. 2943cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 2944cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 2945cb92c03bSAndrew Geissler */ 2946cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 2947cb13a392SEd Tanous const std::vector<std::string>&) override 2948cb92c03bSAndrew Geissler { 2949cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "Do delete all entries."; 2950cb92c03bSAndrew Geissler 2951cb92c03bSAndrew Geissler auto asyncResp = std::make_shared<AsyncResp>(res); 2952cb92c03bSAndrew Geissler // Process response from Logging service. 29532c70f800SEd Tanous auto respHandler = [asyncResp](const boost::system::error_code ec) { 2954cb92c03bSAndrew Geissler BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; 2955cb92c03bSAndrew Geissler if (ec) 2956cb92c03bSAndrew Geissler { 2957cb92c03bSAndrew Geissler // TODO Handle for specific error code 2958cb92c03bSAndrew Geissler BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; 2959cb92c03bSAndrew Geissler asyncResp->res.result( 2960cb92c03bSAndrew Geissler boost::beast::http::status::internal_server_error); 2961cb92c03bSAndrew Geissler return; 2962cb92c03bSAndrew Geissler } 2963cb92c03bSAndrew Geissler 2964cb92c03bSAndrew Geissler asyncResp->res.result(boost::beast::http::status::no_content); 2965cb92c03bSAndrew Geissler }; 2966cb92c03bSAndrew Geissler 2967cb92c03bSAndrew Geissler // Make call to Logging service to request Clear Log 2968cb92c03bSAndrew Geissler crow::connections::systemBus->async_method_call( 29692c70f800SEd Tanous respHandler, "xyz.openbmc_project.Logging", 2970cb92c03bSAndrew Geissler "/xyz/openbmc_project/logging", 2971cb92c03bSAndrew Geissler "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 2972cb92c03bSAndrew Geissler } 2973cb92c03bSAndrew Geissler }; 2974a3316fc6SZhikuiRen 2975a3316fc6SZhikuiRen /**************************************************** 2976a3316fc6SZhikuiRen * Redfish PostCode interfaces 2977a3316fc6SZhikuiRen * using DBUS interface: getPostCodesTS 2978a3316fc6SZhikuiRen ******************************************************/ 2979a3316fc6SZhikuiRen class PostCodesLogService : public Node 2980a3316fc6SZhikuiRen { 2981a3316fc6SZhikuiRen public: 298252cc112dSEd Tanous PostCodesLogService(App& app) : 2983a3316fc6SZhikuiRen Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") 2984a3316fc6SZhikuiRen { 2985a3316fc6SZhikuiRen entityPrivileges = { 2986a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 2987a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 2988a3316fc6SZhikuiRen {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 2989a3316fc6SZhikuiRen {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 2990a3316fc6SZhikuiRen {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 2991a3316fc6SZhikuiRen {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 2992a3316fc6SZhikuiRen } 2993a3316fc6SZhikuiRen 2994a3316fc6SZhikuiRen private: 2995cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 2996cb13a392SEd Tanous const std::vector<std::string>&) override 2997a3316fc6SZhikuiRen { 2998a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2999a3316fc6SZhikuiRen 3000a3316fc6SZhikuiRen asyncResp->res.jsonValue = { 3001a3316fc6SZhikuiRen {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"}, 3002a3316fc6SZhikuiRen {"@odata.type", "#LogService.v1_1_0.LogService"}, 3003a3316fc6SZhikuiRen {"@odata.context", "/redfish/v1/$metadata#LogService.LogService"}, 3004a3316fc6SZhikuiRen {"Name", "POST Code Log Service"}, 3005a3316fc6SZhikuiRen {"Description", "POST Code Log Service"}, 3006a3316fc6SZhikuiRen {"Id", "BIOS POST Code Log"}, 3007a3316fc6SZhikuiRen {"OverWritePolicy", "WrapsWhenFull"}, 3008a3316fc6SZhikuiRen {"Entries", 3009a3316fc6SZhikuiRen {{"@odata.id", 3010a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}}; 3011a3316fc6SZhikuiRen asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { 3012a3316fc6SZhikuiRen {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/" 3013a3316fc6SZhikuiRen "Actions/LogService.ClearLog"}}; 3014a3316fc6SZhikuiRen } 3015a3316fc6SZhikuiRen }; 3016a3316fc6SZhikuiRen 3017a3316fc6SZhikuiRen class PostCodesClear : public Node 3018a3316fc6SZhikuiRen { 3019a3316fc6SZhikuiRen public: 302052cc112dSEd Tanous PostCodesClear(App& app) : 3021a3316fc6SZhikuiRen Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/" 3022a3316fc6SZhikuiRen "LogService.ClearLog/") 3023a3316fc6SZhikuiRen { 3024a3316fc6SZhikuiRen entityPrivileges = { 3025a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 3026a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 30273946028dSAppaRao Puli {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 30283946028dSAppaRao Puli {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 30293946028dSAppaRao Puli {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 30303946028dSAppaRao Puli {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 3031a3316fc6SZhikuiRen } 3032a3316fc6SZhikuiRen 3033a3316fc6SZhikuiRen private: 3034cb13a392SEd Tanous void doPost(crow::Response& res, const crow::Request&, 3035cb13a392SEd Tanous const std::vector<std::string>&) override 3036a3316fc6SZhikuiRen { 3037a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; 3038a3316fc6SZhikuiRen 3039a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 3040a3316fc6SZhikuiRen // Make call to post-code service to request clear all 3041a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3042a3316fc6SZhikuiRen [asyncResp](const boost::system::error_code ec) { 3043a3316fc6SZhikuiRen if (ec) 3044a3316fc6SZhikuiRen { 3045a3316fc6SZhikuiRen // TODO Handle for specific error code 3046a3316fc6SZhikuiRen BMCWEB_LOG_ERROR 3047a3316fc6SZhikuiRen << "doClearPostCodes resp_handler got error " << ec; 3048a3316fc6SZhikuiRen asyncResp->res.result( 3049a3316fc6SZhikuiRen boost::beast::http::status::internal_server_error); 3050a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3051a3316fc6SZhikuiRen return; 3052a3316fc6SZhikuiRen } 3053a3316fc6SZhikuiRen }, 3054a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3055a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3056a3316fc6SZhikuiRen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 3057a3316fc6SZhikuiRen } 3058a3316fc6SZhikuiRen }; 3059a3316fc6SZhikuiRen 3060a3316fc6SZhikuiRen static void fillPostCodeEntry( 3061a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> aResp, 3062a3316fc6SZhikuiRen const boost::container::flat_map<uint64_t, uint64_t>& postcode, 3063a3316fc6SZhikuiRen const uint16_t bootIndex, const uint64_t codeIndex = 0, 3064a3316fc6SZhikuiRen const uint64_t skip = 0, const uint64_t top = 0) 3065a3316fc6SZhikuiRen { 3066a3316fc6SZhikuiRen // Get the Message from the MessageRegistry 3067a3316fc6SZhikuiRen const message_registries::Message* message = 3068a3316fc6SZhikuiRen message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode"); 3069a3316fc6SZhikuiRen 3070a3316fc6SZhikuiRen uint64_t currentCodeIndex = 0; 3071a3316fc6SZhikuiRen nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; 3072a3316fc6SZhikuiRen 3073a3316fc6SZhikuiRen uint64_t firstCodeTimeUs = 0; 3074a3316fc6SZhikuiRen for (const std::pair<uint64_t, uint64_t>& code : postcode) 3075a3316fc6SZhikuiRen { 3076a3316fc6SZhikuiRen currentCodeIndex++; 3077a3316fc6SZhikuiRen std::string postcodeEntryID = 3078a3316fc6SZhikuiRen "B" + std::to_string(bootIndex) + "-" + 3079a3316fc6SZhikuiRen std::to_string(currentCodeIndex); // 1 based index in EntryID string 3080a3316fc6SZhikuiRen 3081a3316fc6SZhikuiRen uint64_t usecSinceEpoch = code.first; 3082a3316fc6SZhikuiRen uint64_t usTimeOffset = 0; 3083a3316fc6SZhikuiRen 3084a3316fc6SZhikuiRen if (1 == currentCodeIndex) 3085a3316fc6SZhikuiRen { // already incremented 3086a3316fc6SZhikuiRen firstCodeTimeUs = code.first; 3087a3316fc6SZhikuiRen } 3088a3316fc6SZhikuiRen else 3089a3316fc6SZhikuiRen { 3090a3316fc6SZhikuiRen usTimeOffset = code.first - firstCodeTimeUs; 3091a3316fc6SZhikuiRen } 3092a3316fc6SZhikuiRen 3093a3316fc6SZhikuiRen // skip if no specific codeIndex is specified and currentCodeIndex does 3094a3316fc6SZhikuiRen // not fall between top and skip 3095a3316fc6SZhikuiRen if ((codeIndex == 0) && 3096a3316fc6SZhikuiRen (currentCodeIndex <= skip || currentCodeIndex > top)) 3097a3316fc6SZhikuiRen { 3098a3316fc6SZhikuiRen continue; 3099a3316fc6SZhikuiRen } 3100a3316fc6SZhikuiRen 31014e0453b1SGunnar Mills // skip if a specific codeIndex is specified and does not match the 3102a3316fc6SZhikuiRen // currentIndex 3103a3316fc6SZhikuiRen if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) 3104a3316fc6SZhikuiRen { 3105a3316fc6SZhikuiRen // This is done for simplicity. 1st entry is needed to calculate 3106a3316fc6SZhikuiRen // time offset. To improve efficiency, one can get to the entry 3107a3316fc6SZhikuiRen // directly (possibly with flatmap's nth method) 3108a3316fc6SZhikuiRen continue; 3109a3316fc6SZhikuiRen } 3110a3316fc6SZhikuiRen 3111a3316fc6SZhikuiRen // currentCodeIndex is within top and skip or equal to specified code 3112a3316fc6SZhikuiRen // index 3113a3316fc6SZhikuiRen 3114a3316fc6SZhikuiRen // Get the Created time from the timestamp 3115a3316fc6SZhikuiRen std::string entryTimeStr; 31169c620e21SAsmitha Karunanithi entryTimeStr = crow::utility::getDateTime( 31179c620e21SAsmitha Karunanithi static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000)); 3118a3316fc6SZhikuiRen 3119a3316fc6SZhikuiRen // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) 3120a3316fc6SZhikuiRen std::ostringstream hexCode; 3121a3316fc6SZhikuiRen hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex 3122a3316fc6SZhikuiRen << code.second; 3123a3316fc6SZhikuiRen std::ostringstream timeOffsetStr; 3124a3316fc6SZhikuiRen // Set Fixed -Point Notation 3125a3316fc6SZhikuiRen timeOffsetStr << std::fixed; 3126a3316fc6SZhikuiRen // Set precision to 4 digits 3127a3316fc6SZhikuiRen timeOffsetStr << std::setprecision(4); 3128a3316fc6SZhikuiRen // Add double to stream 3129a3316fc6SZhikuiRen timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; 3130a3316fc6SZhikuiRen std::vector<std::string> messageArgs = { 3131a3316fc6SZhikuiRen std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; 3132a3316fc6SZhikuiRen 3133a3316fc6SZhikuiRen // Get MessageArgs template from message registry 3134a3316fc6SZhikuiRen std::string msg; 3135a3316fc6SZhikuiRen if (message != nullptr) 3136a3316fc6SZhikuiRen { 3137a3316fc6SZhikuiRen msg = message->message; 3138a3316fc6SZhikuiRen 3139a3316fc6SZhikuiRen // fill in this post code value 3140a3316fc6SZhikuiRen int i = 0; 3141a3316fc6SZhikuiRen for (const std::string& messageArg : messageArgs) 3142a3316fc6SZhikuiRen { 3143a3316fc6SZhikuiRen std::string argStr = "%" + std::to_string(++i); 3144a3316fc6SZhikuiRen size_t argPos = msg.find(argStr); 3145a3316fc6SZhikuiRen if (argPos != std::string::npos) 3146a3316fc6SZhikuiRen { 3147a3316fc6SZhikuiRen msg.replace(argPos, argStr.length(), messageArg); 3148a3316fc6SZhikuiRen } 3149a3316fc6SZhikuiRen } 3150a3316fc6SZhikuiRen } 3151a3316fc6SZhikuiRen 3152d4342a92STim Lee // Get Severity template from message registry 3153d4342a92STim Lee std::string severity; 3154d4342a92STim Lee if (message != nullptr) 3155d4342a92STim Lee { 3156d4342a92STim Lee severity = message->severity; 3157d4342a92STim Lee } 3158d4342a92STim Lee 3159a3316fc6SZhikuiRen // add to AsyncResp 3160a3316fc6SZhikuiRen logEntryArray.push_back({}); 3161a3316fc6SZhikuiRen nlohmann::json& bmcLogEntry = logEntryArray.back(); 3162a3316fc6SZhikuiRen bmcLogEntry = { 3163a3316fc6SZhikuiRen {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, 3164a3316fc6SZhikuiRen {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"}, 3165a3316fc6SZhikuiRen {"@odata.id", "/redfish/v1/Systems/system/LogServices/" 3166a3316fc6SZhikuiRen "PostCodes/Entries/" + 3167a3316fc6SZhikuiRen postcodeEntryID}, 3168a3316fc6SZhikuiRen {"Name", "POST Code Log Entry"}, 3169a3316fc6SZhikuiRen {"Id", postcodeEntryID}, 3170a3316fc6SZhikuiRen {"Message", std::move(msg)}, 3171a3316fc6SZhikuiRen {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"}, 3172a3316fc6SZhikuiRen {"MessageArgs", std::move(messageArgs)}, 3173a3316fc6SZhikuiRen {"EntryType", "Event"}, 3174a3316fc6SZhikuiRen {"Severity", std::move(severity)}, 31759c620e21SAsmitha Karunanithi {"Created", entryTimeStr}}; 3176a3316fc6SZhikuiRen } 3177a3316fc6SZhikuiRen } 3178a3316fc6SZhikuiRen 3179a3316fc6SZhikuiRen static void getPostCodeForEntry(std::shared_ptr<AsyncResp> aResp, 3180a3316fc6SZhikuiRen const uint16_t bootIndex, 3181a3316fc6SZhikuiRen const uint64_t codeIndex) 3182a3316fc6SZhikuiRen { 3183a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3184a3316fc6SZhikuiRen [aResp, bootIndex, codeIndex]( 3185a3316fc6SZhikuiRen const boost::system::error_code ec, 3186a3316fc6SZhikuiRen const boost::container::flat_map<uint64_t, uint64_t>& postcode) { 3187a3316fc6SZhikuiRen if (ec) 3188a3316fc6SZhikuiRen { 3189a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3190a3316fc6SZhikuiRen messages::internalError(aResp->res); 3191a3316fc6SZhikuiRen return; 3192a3316fc6SZhikuiRen } 3193a3316fc6SZhikuiRen 3194a3316fc6SZhikuiRen // skip the empty postcode boots 3195a3316fc6SZhikuiRen if (postcode.empty()) 3196a3316fc6SZhikuiRen { 3197a3316fc6SZhikuiRen return; 3198a3316fc6SZhikuiRen } 3199a3316fc6SZhikuiRen 3200a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); 3201a3316fc6SZhikuiRen 3202a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = 3203a3316fc6SZhikuiRen aResp->res.jsonValue["Members"].size(); 3204a3316fc6SZhikuiRen }, 3205a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3206a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3207a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3208a3316fc6SZhikuiRen bootIndex); 3209a3316fc6SZhikuiRen } 3210a3316fc6SZhikuiRen 3211a3316fc6SZhikuiRen static void getPostCodeForBoot(std::shared_ptr<AsyncResp> aResp, 3212a3316fc6SZhikuiRen const uint16_t bootIndex, 3213a3316fc6SZhikuiRen const uint16_t bootCount, 3214a3316fc6SZhikuiRen const uint64_t entryCount, const uint64_t skip, 3215a3316fc6SZhikuiRen const uint64_t top) 3216a3316fc6SZhikuiRen { 3217a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3218a3316fc6SZhikuiRen [aResp, bootIndex, bootCount, entryCount, skip, 3219a3316fc6SZhikuiRen top](const boost::system::error_code ec, 3220a3316fc6SZhikuiRen const boost::container::flat_map<uint64_t, uint64_t>& postcode) { 3221a3316fc6SZhikuiRen if (ec) 3222a3316fc6SZhikuiRen { 3223a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; 3224a3316fc6SZhikuiRen messages::internalError(aResp->res); 3225a3316fc6SZhikuiRen return; 3226a3316fc6SZhikuiRen } 3227a3316fc6SZhikuiRen 3228a3316fc6SZhikuiRen uint64_t endCount = entryCount; 3229a3316fc6SZhikuiRen if (!postcode.empty()) 3230a3316fc6SZhikuiRen { 3231a3316fc6SZhikuiRen endCount = entryCount + postcode.size(); 3232a3316fc6SZhikuiRen 3233a3316fc6SZhikuiRen if ((skip < endCount) && ((top + skip) > entryCount)) 3234a3316fc6SZhikuiRen { 3235a3316fc6SZhikuiRen uint64_t thisBootSkip = 3236a3316fc6SZhikuiRen std::max(skip, entryCount) - entryCount; 3237a3316fc6SZhikuiRen uint64_t thisBootTop = 3238a3316fc6SZhikuiRen std::min(top + skip, endCount) - entryCount; 3239a3316fc6SZhikuiRen 3240a3316fc6SZhikuiRen fillPostCodeEntry(aResp, postcode, bootIndex, 0, 3241a3316fc6SZhikuiRen thisBootSkip, thisBootTop); 3242a3316fc6SZhikuiRen } 3243a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.count"] = endCount; 3244a3316fc6SZhikuiRen } 3245a3316fc6SZhikuiRen 3246a3316fc6SZhikuiRen // continue to previous bootIndex 3247a3316fc6SZhikuiRen if (bootIndex < bootCount) 3248a3316fc6SZhikuiRen { 3249a3316fc6SZhikuiRen getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), 3250a3316fc6SZhikuiRen bootCount, endCount, skip, top); 3251a3316fc6SZhikuiRen } 3252a3316fc6SZhikuiRen else 3253a3316fc6SZhikuiRen { 3254a3316fc6SZhikuiRen aResp->res.jsonValue["Members@odata.nextLink"] = 3255a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/" 3256a3316fc6SZhikuiRen "Entries?$skip=" + 3257a3316fc6SZhikuiRen std::to_string(skip + top); 3258a3316fc6SZhikuiRen } 3259a3316fc6SZhikuiRen }, 3260a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3261a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3262a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", 3263a3316fc6SZhikuiRen bootIndex); 3264a3316fc6SZhikuiRen } 3265a3316fc6SZhikuiRen 3266a3316fc6SZhikuiRen static void getCurrentBootNumber(std::shared_ptr<AsyncResp> aResp, 3267a3316fc6SZhikuiRen const uint64_t skip, const uint64_t top) 3268a3316fc6SZhikuiRen { 3269a3316fc6SZhikuiRen uint64_t entryCount = 0; 3270a3316fc6SZhikuiRen crow::connections::systemBus->async_method_call( 3271a3316fc6SZhikuiRen [aResp, entryCount, skip, 3272a3316fc6SZhikuiRen top](const boost::system::error_code ec, 3273a3316fc6SZhikuiRen const std::variant<uint16_t>& bootCount) { 3274a3316fc6SZhikuiRen if (ec) 3275a3316fc6SZhikuiRen { 3276a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "DBUS response error " << ec; 3277a3316fc6SZhikuiRen messages::internalError(aResp->res); 3278a3316fc6SZhikuiRen return; 3279a3316fc6SZhikuiRen } 3280a3316fc6SZhikuiRen auto pVal = std::get_if<uint16_t>(&bootCount); 3281a3316fc6SZhikuiRen if (pVal) 3282a3316fc6SZhikuiRen { 3283a3316fc6SZhikuiRen getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top); 3284a3316fc6SZhikuiRen } 3285a3316fc6SZhikuiRen else 3286a3316fc6SZhikuiRen { 3287a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Post code boot index failed."; 3288a3316fc6SZhikuiRen } 3289a3316fc6SZhikuiRen }, 3290a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", 3291a3316fc6SZhikuiRen "/xyz/openbmc_project/State/Boot/PostCode", 3292a3316fc6SZhikuiRen "org.freedesktop.DBus.Properties", "Get", 3293a3316fc6SZhikuiRen "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount"); 3294a3316fc6SZhikuiRen } 3295a3316fc6SZhikuiRen 3296a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node 3297a3316fc6SZhikuiRen { 3298a3316fc6SZhikuiRen public: 329952cc112dSEd Tanous PostCodesEntryCollection(App& app) : 3300a3316fc6SZhikuiRen Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") 3301a3316fc6SZhikuiRen { 3302a3316fc6SZhikuiRen entityPrivileges = { 3303a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 3304a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 3305a3316fc6SZhikuiRen {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 3306a3316fc6SZhikuiRen {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 3307a3316fc6SZhikuiRen {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 3308a3316fc6SZhikuiRen {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 3309a3316fc6SZhikuiRen } 3310a3316fc6SZhikuiRen 3311a3316fc6SZhikuiRen private: 3312a3316fc6SZhikuiRen void doGet(crow::Response& res, const crow::Request& req, 3313cb13a392SEd Tanous const std::vector<std::string>&) override 3314a3316fc6SZhikuiRen { 3315a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 3316a3316fc6SZhikuiRen 3317a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = 3318a3316fc6SZhikuiRen "#LogEntryCollection.LogEntryCollection"; 3319a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.context"] = 3320a3316fc6SZhikuiRen "/redfish/v1/" 3321a3316fc6SZhikuiRen "$metadata#LogEntryCollection.LogEntryCollection"; 3322a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3323a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; 3324a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3325a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3326a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3327a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3328a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3329a3316fc6SZhikuiRen 3330a3316fc6SZhikuiRen uint64_t skip = 0; 3331a3316fc6SZhikuiRen uint64_t top = maxEntriesPerPage; // Show max entries by default 3332a3316fc6SZhikuiRen if (!getSkipParam(asyncResp->res, req, skip)) 3333a3316fc6SZhikuiRen { 3334a3316fc6SZhikuiRen return; 3335a3316fc6SZhikuiRen } 3336a3316fc6SZhikuiRen if (!getTopParam(asyncResp->res, req, top)) 3337a3316fc6SZhikuiRen { 3338a3316fc6SZhikuiRen return; 3339a3316fc6SZhikuiRen } 3340a3316fc6SZhikuiRen getCurrentBootNumber(asyncResp, skip, top); 3341a3316fc6SZhikuiRen } 3342a3316fc6SZhikuiRen }; 3343a3316fc6SZhikuiRen 3344a3316fc6SZhikuiRen class PostCodesEntry : public Node 3345a3316fc6SZhikuiRen { 3346a3316fc6SZhikuiRen public: 334752cc112dSEd Tanous PostCodesEntry(App& app) : 3348a3316fc6SZhikuiRen Node(app, 3349a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/", 3350a3316fc6SZhikuiRen std::string()) 3351a3316fc6SZhikuiRen { 3352a3316fc6SZhikuiRen entityPrivileges = { 3353a3316fc6SZhikuiRen {boost::beast::http::verb::get, {{"Login"}}}, 3354a3316fc6SZhikuiRen {boost::beast::http::verb::head, {{"Login"}}}, 3355a3316fc6SZhikuiRen {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, 3356a3316fc6SZhikuiRen {boost::beast::http::verb::put, {{"ConfigureManager"}}}, 3357a3316fc6SZhikuiRen {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, 3358a3316fc6SZhikuiRen {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; 3359a3316fc6SZhikuiRen } 3360a3316fc6SZhikuiRen 3361a3316fc6SZhikuiRen private: 3362cb13a392SEd Tanous void doGet(crow::Response& res, const crow::Request&, 3363a3316fc6SZhikuiRen const std::vector<std::string>& params) override 3364a3316fc6SZhikuiRen { 3365a3316fc6SZhikuiRen std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 3366a3316fc6SZhikuiRen if (params.size() != 1) 3367a3316fc6SZhikuiRen { 3368a3316fc6SZhikuiRen messages::internalError(asyncResp->res); 3369a3316fc6SZhikuiRen return; 3370a3316fc6SZhikuiRen } 3371a3316fc6SZhikuiRen 3372a3316fc6SZhikuiRen const std::string& targetID = params[0]; 3373a3316fc6SZhikuiRen 3374a3316fc6SZhikuiRen size_t bootPos = targetID.find('B'); 3375a3316fc6SZhikuiRen if (bootPos == std::string::npos) 3376a3316fc6SZhikuiRen { 3377a3316fc6SZhikuiRen // Requested ID was not found 3378a3316fc6SZhikuiRen messages::resourceMissingAtURI(asyncResp->res, targetID); 3379a3316fc6SZhikuiRen return; 3380a3316fc6SZhikuiRen } 3381a3316fc6SZhikuiRen std::string_view bootIndexStr(targetID); 3382a3316fc6SZhikuiRen bootIndexStr.remove_prefix(bootPos + 1); 3383a3316fc6SZhikuiRen uint16_t bootIndex = 0; 3384a3316fc6SZhikuiRen uint64_t codeIndex = 0; 3385a3316fc6SZhikuiRen size_t dashPos = bootIndexStr.find('-'); 3386a3316fc6SZhikuiRen 3387a3316fc6SZhikuiRen if (dashPos == std::string::npos) 3388a3316fc6SZhikuiRen { 3389a3316fc6SZhikuiRen return; 3390a3316fc6SZhikuiRen } 3391a3316fc6SZhikuiRen std::string_view codeIndexStr(bootIndexStr); 3392a3316fc6SZhikuiRen bootIndexStr.remove_suffix(dashPos); 3393a3316fc6SZhikuiRen codeIndexStr.remove_prefix(dashPos + 1); 3394a3316fc6SZhikuiRen 3395a3316fc6SZhikuiRen bootIndex = static_cast<uint16_t>( 339623a21a1cSEd Tanous strtoul(std::string(bootIndexStr).c_str(), nullptr, 0)); 339723a21a1cSEd Tanous codeIndex = strtoul(std::string(codeIndexStr).c_str(), nullptr, 0); 3398a3316fc6SZhikuiRen if (bootIndex == 0 || codeIndex == 0) 3399a3316fc6SZhikuiRen { 3400a3316fc6SZhikuiRen BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " 3401a3316fc6SZhikuiRen << params[0]; 3402a3316fc6SZhikuiRen } 3403a3316fc6SZhikuiRen 3404a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; 3405a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.context"] = 3406a3316fc6SZhikuiRen "/redfish/v1/$metadata#LogEntry.LogEntry"; 3407a3316fc6SZhikuiRen asyncResp->res.jsonValue["@odata.id"] = 3408a3316fc6SZhikuiRen "/redfish/v1/Systems/system/LogServices/PostCodes/" 3409a3316fc6SZhikuiRen "Entries"; 3410a3316fc6SZhikuiRen asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; 3411a3316fc6SZhikuiRen asyncResp->res.jsonValue["Description"] = 3412a3316fc6SZhikuiRen "Collection of POST Code Log Entries"; 3413a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); 3414a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members@odata.count"] = 0; 3415a3316fc6SZhikuiRen 3416a3316fc6SZhikuiRen getPostCodeForEntry(asyncResp, bootIndex, codeIndex); 3417a3316fc6SZhikuiRen } 3418a3316fc6SZhikuiRen }; 3419a3316fc6SZhikuiRen 34201da66f75SEd Tanous } // namespace redfish 3421