140e9b92eSEd Tanous // SPDX-License-Identifier: Apache-2.0 240e9b92eSEd Tanous // SPDX-FileCopyrightText: Copyright OpenBMC Authors 340e9b92eSEd Tanous // SPDX-FileCopyrightText: Copyright 2018 Intel Corporation 41da66f75SEd Tanous #pragma once 51da66f75SEd Tanous 6d7857201SEd Tanous #include "bmcweb_config.h" 7d7857201SEd Tanous 83ccb3adbSEd Tanous #include "app.hpp" 9d7857201SEd Tanous #include "async_resp.hpp" 10d7857201SEd Tanous #include "dbus_singleton.hpp" 117a1dbc48SGeorge Liu #include "dbus_utility.hpp" 123ccb3adbSEd Tanous #include "error_messages.hpp" 1368dd075aSAsmitha Karunanithi #include "generated/enums/log_entry.hpp" 14539d8c6bSEd Tanous #include "generated/enums/log_service.hpp" 15d7857201SEd Tanous #include "http_body.hpp" 16d7857201SEd Tanous #include "http_request.hpp" 17d7857201SEd Tanous #include "http_response.hpp" 18647b3cdcSGeorge Liu #include "http_utility.hpp" 19b7028ebfSSpencer Ku #include "human_sort.hpp" 20d7857201SEd Tanous #include "logging.hpp" 213ccb3adbSEd Tanous #include "query.hpp" 224851d45dSJason M. Bills #include "registries.hpp" 233ccb3adbSEd Tanous #include "registries/privilege_registry.hpp" 24d7857201SEd Tanous #include "str_utility.hpp" 2546229577SJames Feist #include "task.hpp" 265b90429aSEd Tanous #include "task_messages.hpp" 27262dcc1cSAlexander Hansen #include "utils/dbus_event_log_entry.hpp" 283ccb3adbSEd Tanous #include "utils/dbus_utils.hpp" 295b90429aSEd Tanous #include "utils/json_utils.hpp" 30d7857201SEd Tanous #include "utils/query_param.hpp" 313ccb3adbSEd Tanous #include "utils/time_utils.hpp" 321da66f75SEd Tanous 33d7857201SEd Tanous #include <asm-generic/errno.h> 34d7857201SEd Tanous #include <systemd/sd-bus.h> 358e31778eSAsmitha Karunanithi #include <tinyxml2.h> 36400fd1fbSAdriana Kobylak #include <unistd.h> 37e1f26343SJason M. Bills 38d7857201SEd Tanous #include <boost/beast/http/field.hpp> 39d7857201SEd Tanous #include <boost/beast/http/status.hpp> 4007c8c20dSEd Tanous #include <boost/beast/http/verb.hpp> 411ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp> 42ef4c65b7SEd Tanous #include <boost/url/format.hpp> 43d7857201SEd Tanous #include <boost/url/url.hpp> 44d7857201SEd Tanous #include <sdbusplus/message.hpp> 45d7857201SEd Tanous #include <sdbusplus/message/native_types.hpp> 46d1bde9e5SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp> 471214b7e7SGunnar Mills 48d7857201SEd Tanous #include <algorithm> 497a1dbc48SGeorge Liu #include <array> 50d7857201SEd Tanous #include <chrono> 51b5f288d2SAbhilash Raju #include <cstddef> 52d7857201SEd Tanous #include <cstdint> 53d7857201SEd Tanous #include <cstdio> 54d7857201SEd Tanous #include <ctime> 554418c7f0SJames Feist #include <filesystem> 56d7857201SEd Tanous #include <format> 57d7857201SEd Tanous #include <fstream> 58d7857201SEd Tanous #include <functional> 59d7857201SEd Tanous #include <iomanip> 6018f8f608SEd Tanous #include <iterator> 61d7857201SEd Tanous #include <memory> 6275710de2SXiaochao Ma #include <optional> 633544d2a7SEd Tanous #include <ranges> 6426702d01SEd Tanous #include <span> 65d7857201SEd Tanous #include <sstream> 6618f8f608SEd Tanous #include <string> 67cd225da8SJason M. Bills #include <string_view> 68d7857201SEd Tanous #include <system_error> 69d7857201SEd Tanous #include <utility> 70abf2add6SEd Tanous #include <variant> 71d7857201SEd Tanous #include <vector> 721da66f75SEd Tanous 731da66f75SEd Tanous namespace redfish 741da66f75SEd Tanous { 751da66f75SEd Tanous 7689492a15SPatrick Williams constexpr const char* crashdumpObject = "com.intel.crashdump"; 7789492a15SPatrick Williams constexpr const char* crashdumpPath = "/com/intel/crashdump"; 7889492a15SPatrick Williams constexpr const char* crashdumpInterface = "com.intel.crashdump"; 7989492a15SPatrick Williams constexpr const char* deleteAllInterface = 805b61b5e8SJason M. Bills "xyz.openbmc_project.Collection.DeleteAll"; 8189492a15SPatrick Williams constexpr const char* crashdumpOnDemandInterface = 82424c4176SJason M. Bills "com.intel.crashdump.OnDemand"; 8389492a15SPatrick Williams constexpr const char* crashdumpTelemetryInterface = 846eda7685SKenny L. Ku "com.intel.crashdump.Telemetry"; 851da66f75SEd Tanous 868e31778eSAsmitha Karunanithi enum class DumpCreationProgress 878e31778eSAsmitha Karunanithi { 888e31778eSAsmitha Karunanithi DUMP_CREATE_SUCCESS, 898e31778eSAsmitha Karunanithi DUMP_CREATE_FAILED, 908e31778eSAsmitha Karunanithi DUMP_CREATE_INPROGRESS 918e31778eSAsmitha Karunanithi }; 928e31778eSAsmitha Karunanithi 93cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s) 94cb92c03bSAndrew Geissler { 95d4d25793SEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") || 96d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") || 97d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") || 98d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Error")) 99cb92c03bSAndrew Geissler { 100cb92c03bSAndrew Geissler return "Critical"; 101cb92c03bSAndrew Geissler } 1023174e4dfSEd Tanous if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") || 103d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") || 104d4d25793SEd Tanous (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")) 105cb92c03bSAndrew Geissler { 106cb92c03bSAndrew Geissler return "OK"; 107cb92c03bSAndrew Geissler } 1083174e4dfSEd Tanous if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") 109cb92c03bSAndrew Geissler { 110cb92c03bSAndrew Geissler return "Warning"; 111cb92c03bSAndrew Geissler } 112cb92c03bSAndrew Geissler return ""; 113cb92c03bSAndrew Geissler } 114cb92c03bSAndrew Geissler 1159017faf2SAbhishek Patel inline std::optional<bool> getProviderNotifyAction(const std::string& notify) 1169017faf2SAbhishek Patel { 1179017faf2SAbhishek Patel std::optional<bool> notifyAction; 1189017faf2SAbhishek Patel if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Notify") 1199017faf2SAbhishek Patel { 1209017faf2SAbhishek Patel notifyAction = true; 1219017faf2SAbhishek Patel } 1229017faf2SAbhishek Patel else if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Inhibit") 1239017faf2SAbhishek Patel { 1249017faf2SAbhishek Patel notifyAction = false; 1259017faf2SAbhishek Patel } 1269017faf2SAbhishek Patel 1279017faf2SAbhishek Patel return notifyAction; 1289017faf2SAbhishek Patel } 1299017faf2SAbhishek Patel 13018f8f608SEd Tanous inline std::string getDumpPath(std::string_view dumpType) 13118f8f608SEd Tanous { 13218f8f608SEd Tanous std::string dbusDumpPath = "/xyz/openbmc_project/dump/"; 13318f8f608SEd Tanous std::ranges::transform(dumpType, std::back_inserter(dbusDumpPath), 13418f8f608SEd Tanous bmcweb::asciiToLower); 13518f8f608SEd Tanous 13618f8f608SEd Tanous return dbusDumpPath; 13718f8f608SEd Tanous } 13818f8f608SEd Tanous 139055713e4SEd Tanous inline bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 140e85d6b16SJason M. Bills const bool firstEntry = true) 14195820184SJason M. Bills { 142271584abSEd Tanous static time_t prevTs = 0; 14395820184SJason M. Bills static int index = 0; 144e85d6b16SJason M. Bills if (firstEntry) 145e85d6b16SJason M. Bills { 146e85d6b16SJason M. Bills prevTs = 0; 147e85d6b16SJason M. Bills } 148e85d6b16SJason M. Bills 14995820184SJason M. Bills // Get the entry timestamp 150271584abSEd Tanous std::time_t curTs = 0; 15195820184SJason M. Bills std::tm timeStruct = {}; 15295820184SJason M. Bills std::istringstream entryStream(logEntry); 15395820184SJason M. Bills if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 15495820184SJason M. Bills { 15595820184SJason M. Bills curTs = std::mktime(&timeStruct); 15695820184SJason M. Bills } 15795820184SJason M. Bills // If the timestamp isn't unique, increment the index 15895820184SJason M. Bills if (curTs == prevTs) 15995820184SJason M. Bills { 16095820184SJason M. Bills index++; 16195820184SJason M. Bills } 16295820184SJason M. Bills else 16395820184SJason M. Bills { 16495820184SJason M. Bills // Otherwise, reset it 16595820184SJason M. Bills index = 0; 16695820184SJason M. Bills } 16795820184SJason M. Bills // Save the timestamp 16895820184SJason M. Bills prevTs = curTs; 16995820184SJason M. Bills 17095820184SJason M. Bills entryID = std::to_string(curTs); 17195820184SJason M. Bills if (index > 0) 17295820184SJason M. Bills { 17395820184SJason M. Bills entryID += "_" + std::to_string(index); 17495820184SJason M. Bills } 17595820184SJason M. Bills return true; 17695820184SJason M. Bills } 17795820184SJason M. Bills 178504af5a0SPatrick Williams inline bool getRedfishLogFiles( 179504af5a0SPatrick Williams std::vector<std::filesystem::path>& redfishLogFiles) 18095820184SJason M. Bills { 18195820184SJason M. Bills static const std::filesystem::path redfishLogDir = "/var/log"; 18295820184SJason M. Bills static const std::string redfishLogFilename = "redfish"; 18395820184SJason M. Bills 18495820184SJason M. Bills // Loop through the directory looking for redfish log files 18595820184SJason M. Bills for (const std::filesystem::directory_entry& dirEnt : 18695820184SJason M. Bills std::filesystem::directory_iterator(redfishLogDir)) 18795820184SJason M. Bills { 18895820184SJason M. Bills // If we find a redfish log file, save the path 18995820184SJason M. Bills std::string filename = dirEnt.path().filename(); 19011ba3979SEd Tanous if (filename.starts_with(redfishLogFilename)) 19195820184SJason M. Bills { 19295820184SJason M. Bills redfishLogFiles.emplace_back(redfishLogDir / filename); 19395820184SJason M. Bills } 19495820184SJason M. Bills } 19595820184SJason M. Bills // As the log files rotate, they are appended with a ".#" that is higher for 19695820184SJason M. Bills // the older logs. Since we don't expect more than 10 log files, we 19795820184SJason M. Bills // can just sort the list to get them in order from newest to oldest 1983544d2a7SEd Tanous std::ranges::sort(redfishLogFiles); 19995820184SJason M. Bills 20095820184SJason M. Bills return !redfishLogFiles.empty(); 20195820184SJason M. Bills } 20295820184SJason M. Bills 203504af5a0SPatrick Williams inline log_entry::OriginatorTypes mapDbusOriginatorTypeToRedfish( 204504af5a0SPatrick Williams const std::string& originatorType) 20568dd075aSAsmitha Karunanithi { 20668dd075aSAsmitha Karunanithi if (originatorType == 20768dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client") 20868dd075aSAsmitha Karunanithi { 20968dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Client; 21068dd075aSAsmitha Karunanithi } 21168dd075aSAsmitha Karunanithi if (originatorType == 21268dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal") 21368dd075aSAsmitha Karunanithi { 21468dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Internal; 21568dd075aSAsmitha Karunanithi } 21668dd075aSAsmitha Karunanithi if (originatorType == 21768dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService") 21868dd075aSAsmitha Karunanithi { 21968dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::SupportingService; 22068dd075aSAsmitha Karunanithi } 22168dd075aSAsmitha Karunanithi return log_entry::OriginatorTypes::Invalid; 22268dd075aSAsmitha Karunanithi } 22368dd075aSAsmitha Karunanithi 224aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject( 2252d613eb6SJiaqing Zhao const dbus::utility::ManagedObjectType::value_type& object, 226c6fecdabSClaire Weinan std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs, 22768dd075aSAsmitha Karunanithi std::string& originatorId, log_entry::OriginatorTypes& originatorType, 228aefe3786SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 229aefe3786SClaire Weinan { 230aefe3786SClaire Weinan for (const auto& interfaceMap : object.second) 231aefe3786SClaire Weinan { 232aefe3786SClaire Weinan if (interfaceMap.first == "xyz.openbmc_project.Common.Progress") 233aefe3786SClaire Weinan { 234aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 235aefe3786SClaire Weinan { 236aefe3786SClaire Weinan if (propertyMap.first == "Status") 237aefe3786SClaire Weinan { 238aefe3786SClaire Weinan const auto* status = 239aefe3786SClaire Weinan std::get_if<std::string>(&propertyMap.second); 240aefe3786SClaire Weinan if (status == nullptr) 241aefe3786SClaire Weinan { 242aefe3786SClaire Weinan messages::internalError(asyncResp->res); 243aefe3786SClaire Weinan break; 244aefe3786SClaire Weinan } 245aefe3786SClaire Weinan dumpStatus = *status; 246aefe3786SClaire Weinan } 247aefe3786SClaire Weinan } 248aefe3786SClaire Weinan } 249aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") 250aefe3786SClaire Weinan { 251aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 252aefe3786SClaire Weinan { 253aefe3786SClaire Weinan if (propertyMap.first == "Size") 254aefe3786SClaire Weinan { 255aefe3786SClaire Weinan const auto* sizePtr = 256aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 257aefe3786SClaire Weinan if (sizePtr == nullptr) 258aefe3786SClaire Weinan { 259aefe3786SClaire Weinan messages::internalError(asyncResp->res); 260aefe3786SClaire Weinan break; 261aefe3786SClaire Weinan } 262aefe3786SClaire Weinan size = *sizePtr; 263aefe3786SClaire Weinan break; 264aefe3786SClaire Weinan } 265aefe3786SClaire Weinan } 266aefe3786SClaire Weinan } 267aefe3786SClaire Weinan else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime") 268aefe3786SClaire Weinan { 269aefe3786SClaire Weinan for (const auto& propertyMap : interfaceMap.second) 270aefe3786SClaire Weinan { 271aefe3786SClaire Weinan if (propertyMap.first == "Elapsed") 272aefe3786SClaire Weinan { 273aefe3786SClaire Weinan const uint64_t* usecsTimeStamp = 274aefe3786SClaire Weinan std::get_if<uint64_t>(&propertyMap.second); 275aefe3786SClaire Weinan if (usecsTimeStamp == nullptr) 276aefe3786SClaire Weinan { 277aefe3786SClaire Weinan messages::internalError(asyncResp->res); 278aefe3786SClaire Weinan break; 279aefe3786SClaire Weinan } 280c6fecdabSClaire Weinan timestampUs = *usecsTimeStamp; 281aefe3786SClaire Weinan break; 282aefe3786SClaire Weinan } 283aefe3786SClaire Weinan } 284aefe3786SClaire Weinan } 28568dd075aSAsmitha Karunanithi else if (interfaceMap.first == 28668dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy") 28768dd075aSAsmitha Karunanithi { 28868dd075aSAsmitha Karunanithi for (const auto& propertyMap : interfaceMap.second) 28968dd075aSAsmitha Karunanithi { 29068dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorId") 29168dd075aSAsmitha Karunanithi { 29268dd075aSAsmitha Karunanithi const std::string* id = 29368dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 29468dd075aSAsmitha Karunanithi if (id == nullptr) 29568dd075aSAsmitha Karunanithi { 29668dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 29768dd075aSAsmitha Karunanithi break; 29868dd075aSAsmitha Karunanithi } 29968dd075aSAsmitha Karunanithi originatorId = *id; 30068dd075aSAsmitha Karunanithi } 30168dd075aSAsmitha Karunanithi 30268dd075aSAsmitha Karunanithi if (propertyMap.first == "OriginatorType") 30368dd075aSAsmitha Karunanithi { 30468dd075aSAsmitha Karunanithi const std::string* type = 30568dd075aSAsmitha Karunanithi std::get_if<std::string>(&propertyMap.second); 30668dd075aSAsmitha Karunanithi if (type == nullptr) 30768dd075aSAsmitha Karunanithi { 30868dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 30968dd075aSAsmitha Karunanithi break; 31068dd075aSAsmitha Karunanithi } 31168dd075aSAsmitha Karunanithi 31268dd075aSAsmitha Karunanithi originatorType = mapDbusOriginatorTypeToRedfish(*type); 31368dd075aSAsmitha Karunanithi if (originatorType == log_entry::OriginatorTypes::Invalid) 31468dd075aSAsmitha Karunanithi { 31568dd075aSAsmitha Karunanithi messages::internalError(asyncResp->res); 31668dd075aSAsmitha Karunanithi break; 31768dd075aSAsmitha Karunanithi } 31868dd075aSAsmitha Karunanithi } 31968dd075aSAsmitha Karunanithi } 32068dd075aSAsmitha Karunanithi } 321aefe3786SClaire Weinan } 322aefe3786SClaire Weinan } 323aefe3786SClaire Weinan 32421ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType) 325fdd26906SClaire Weinan { 326fdd26906SClaire Weinan std::string entriesPath; 327fdd26906SClaire Weinan 328fdd26906SClaire Weinan if (dumpType == "BMC") 329fdd26906SClaire Weinan { 330253f11b8SEd Tanous entriesPath = 331253f11b8SEd Tanous std::format("/redfish/v1/Managers/{}/LogServices/Dump/Entries/", 332253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 333fdd26906SClaire Weinan } 334fdd26906SClaire Weinan else if (dumpType == "FaultLog") 335fdd26906SClaire Weinan { 336253f11b8SEd Tanous entriesPath = 337253f11b8SEd Tanous std::format("/redfish/v1/Managers/{}/LogServices/FaultLog/Entries/", 338253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 339fdd26906SClaire Weinan } 340fdd26906SClaire Weinan else if (dumpType == "System") 341fdd26906SClaire Weinan { 342253f11b8SEd Tanous entriesPath = 343253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/Dump/Entries/", 344253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 345fdd26906SClaire Weinan } 346fdd26906SClaire Weinan else 347fdd26906SClaire Weinan { 34862598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpEntriesPath() invalid dump type: {}", 34962598e31SEd Tanous dumpType); 350fdd26906SClaire Weinan } 351fdd26906SClaire Weinan 352fdd26906SClaire Weinan // Returns empty string on error 353fdd26906SClaire Weinan return entriesPath; 354fdd26906SClaire Weinan } 355fdd26906SClaire Weinan 356504af5a0SPatrick Williams inline void getDumpEntryCollection( 357504af5a0SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 3585cb1dd27SAsmitha Karunanithi const std::string& dumpType) 3595cb1dd27SAsmitha Karunanithi { 360fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 361fdd26906SClaire Weinan if (entriesPath.empty()) 3625cb1dd27SAsmitha Karunanithi { 3635cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 3645cb1dd27SAsmitha Karunanithi return; 3655cb1dd27SAsmitha Karunanithi } 3665cb1dd27SAsmitha Karunanithi 3675eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 3685eb468daSGeorge Liu dbus::utility::getManagedObjects( 3695eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 370fdd26906SClaire Weinan [asyncResp, entriesPath, 3715e7e2dc5SEd Tanous dumpType](const boost::system::error_code& ec, 3725eb468daSGeorge Liu const dbus::utility::ManagedObjectType& objects) { 3735cb1dd27SAsmitha Karunanithi if (ec) 3745cb1dd27SAsmitha Karunanithi { 37562598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 3765cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 3775cb1dd27SAsmitha Karunanithi return; 3785cb1dd27SAsmitha Karunanithi } 3795cb1dd27SAsmitha Karunanithi 380fdd26906SClaire Weinan // Remove ending slash 381fdd26906SClaire Weinan std::string odataIdStr = entriesPath; 382fdd26906SClaire Weinan if (!odataIdStr.empty()) 383fdd26906SClaire Weinan { 384fdd26906SClaire Weinan odataIdStr.pop_back(); 385fdd26906SClaire Weinan } 386fdd26906SClaire Weinan 387fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = 388fdd26906SClaire Weinan "#LogEntryCollection.LogEntryCollection"; 389fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr); 390fdd26906SClaire Weinan asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries"; 391bd79bce8SPatrick Williams asyncResp->res.jsonValue["Description"] = 392bd79bce8SPatrick Williams "Collection of " + dumpType + " Dump Entries"; 393fdd26906SClaire Weinan 3943544d2a7SEd Tanous nlohmann::json::array_t entriesArray; 39518f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 3965cb1dd27SAsmitha Karunanithi 3975eb468daSGeorge Liu dbus::utility::ManagedObjectType resp(objects); 3983544d2a7SEd Tanous std::ranges::sort(resp, [](const auto& l, const auto& r) { 399002d39b4SEd Tanous return AlphanumLess<std::string>()(l.first.filename(), 400002d39b4SEd Tanous r.first.filename()); 401565dfb6fSClaire Weinan }); 402565dfb6fSClaire Weinan 4035cb1dd27SAsmitha Karunanithi for (auto& object : resp) 4045cb1dd27SAsmitha Karunanithi { 405b47452b2SAsmitha Karunanithi if (object.first.str.find(dumpEntryPath) == std::string::npos) 4065cb1dd27SAsmitha Karunanithi { 4075cb1dd27SAsmitha Karunanithi continue; 4085cb1dd27SAsmitha Karunanithi } 409c6fecdabSClaire Weinan uint64_t timestampUs = 0; 4105cb1dd27SAsmitha Karunanithi uint64_t size = 0; 41135440d18SAsmitha Karunanithi std::string dumpStatus; 41268dd075aSAsmitha Karunanithi std::string originatorId; 41368dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 41468dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 415433b68b4SJason M. Bills nlohmann::json::object_t thisEntry; 4162dfd18efSEd Tanous 4172dfd18efSEd Tanous std::string entryID = object.first.filename(); 4182dfd18efSEd Tanous if (entryID.empty()) 4195cb1dd27SAsmitha Karunanithi { 4205cb1dd27SAsmitha Karunanithi continue; 4215cb1dd27SAsmitha Karunanithi } 4225cb1dd27SAsmitha Karunanithi 423bd79bce8SPatrick Williams parseDumpEntryFromDbusObject(object, dumpStatus, size, 424bd79bce8SPatrick Williams timestampUs, originatorId, 425bd79bce8SPatrick Williams originatorType, asyncResp); 4265cb1dd27SAsmitha Karunanithi 4270fda0f12SGeorge Liu if (dumpStatus != 4280fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 42935440d18SAsmitha Karunanithi !dumpStatus.empty()) 43035440d18SAsmitha Karunanithi { 43135440d18SAsmitha Karunanithi // Dump status is not Complete, no need to enumerate 43235440d18SAsmitha Karunanithi continue; 43335440d18SAsmitha Karunanithi } 43435440d18SAsmitha Karunanithi 43568dd075aSAsmitha Karunanithi thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry"; 436fdd26906SClaire Weinan thisEntry["@odata.id"] = entriesPath + entryID; 4375cb1dd27SAsmitha Karunanithi thisEntry["Id"] = entryID; 4385cb1dd27SAsmitha Karunanithi thisEntry["EntryType"] = "Event"; 4395cb1dd27SAsmitha Karunanithi thisEntry["Name"] = dumpType + " Dump Entry"; 440bbd80db8SClaire Weinan thisEntry["Created"] = 441bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 4425cb1dd27SAsmitha Karunanithi 44368dd075aSAsmitha Karunanithi if (!originatorId.empty()) 44468dd075aSAsmitha Karunanithi { 44568dd075aSAsmitha Karunanithi thisEntry["Originator"] = originatorId; 44668dd075aSAsmitha Karunanithi thisEntry["OriginatorType"] = originatorType; 44768dd075aSAsmitha Karunanithi } 44868dd075aSAsmitha Karunanithi 4495cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 4505cb1dd27SAsmitha Karunanithi { 451d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "Manager"; 452bd79bce8SPatrick Williams thisEntry["AdditionalDataURI"] = 453bd79bce8SPatrick Williams entriesPath + entryID + "/attachment"; 454fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 4555cb1dd27SAsmitha Karunanithi } 4565cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 4575cb1dd27SAsmitha Karunanithi { 458d337bb72SAsmitha Karunanithi thisEntry["DiagnosticDataType"] = "OEM"; 459d337bb72SAsmitha Karunanithi thisEntry["OEMDiagnosticDataType"] = "System"; 460bd79bce8SPatrick Williams thisEntry["AdditionalDataURI"] = 461bd79bce8SPatrick Williams entriesPath + entryID + "/attachment"; 462fdd26906SClaire Weinan thisEntry["AdditionalDataSizeBytes"] = size; 4635cb1dd27SAsmitha Karunanithi } 464b2ba3072SPatrick Williams entriesArray.emplace_back(std::move(thisEntry)); 4655cb1dd27SAsmitha Karunanithi } 466bd79bce8SPatrick Williams asyncResp->res.jsonValue["Members@odata.count"] = 467bd79bce8SPatrick Williams entriesArray.size(); 4683544d2a7SEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 4695eb468daSGeorge Liu }); 4705cb1dd27SAsmitha Karunanithi } 4715cb1dd27SAsmitha Karunanithi 472504af5a0SPatrick Williams inline void getDumpEntryById( 473504af5a0SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 4748d1b46d7Szhanghch05 const std::string& entryID, const std::string& dumpType) 4755cb1dd27SAsmitha Karunanithi { 476fdd26906SClaire Weinan std::string entriesPath = getDumpEntriesPath(dumpType); 477fdd26906SClaire Weinan if (entriesPath.empty()) 4785cb1dd27SAsmitha Karunanithi { 4795cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4805cb1dd27SAsmitha Karunanithi return; 4815cb1dd27SAsmitha Karunanithi } 4825cb1dd27SAsmitha Karunanithi 4835eb468daSGeorge Liu sdbusplus::message::object_path path("/xyz/openbmc_project/dump"); 4845eb468daSGeorge Liu dbus::utility::getManagedObjects( 4855eb468daSGeorge Liu "xyz.openbmc_project.Dump.Manager", path, 486fdd26906SClaire Weinan [asyncResp, entryID, dumpType, 4875e7e2dc5SEd Tanous entriesPath](const boost::system::error_code& ec, 48802cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 4895cb1dd27SAsmitha Karunanithi if (ec) 4905cb1dd27SAsmitha Karunanithi { 49162598e31SEd Tanous BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec); 4925cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 4935cb1dd27SAsmitha Karunanithi return; 4945cb1dd27SAsmitha Karunanithi } 4955cb1dd27SAsmitha Karunanithi 496b47452b2SAsmitha Karunanithi bool foundDumpEntry = false; 49718f8f608SEd Tanous std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/"; 498b47452b2SAsmitha Karunanithi 4999eb808c1SEd Tanous for (const auto& objectPath : resp) 5005cb1dd27SAsmitha Karunanithi { 501b47452b2SAsmitha Karunanithi if (objectPath.first.str != dumpEntryPath + entryID) 5025cb1dd27SAsmitha Karunanithi { 5035cb1dd27SAsmitha Karunanithi continue; 5045cb1dd27SAsmitha Karunanithi } 5055cb1dd27SAsmitha Karunanithi 5065cb1dd27SAsmitha Karunanithi foundDumpEntry = true; 507c6fecdabSClaire Weinan uint64_t timestampUs = 0; 5085cb1dd27SAsmitha Karunanithi uint64_t size = 0; 50935440d18SAsmitha Karunanithi std::string dumpStatus; 51068dd075aSAsmitha Karunanithi std::string originatorId; 51168dd075aSAsmitha Karunanithi log_entry::OriginatorTypes originatorType = 51268dd075aSAsmitha Karunanithi log_entry::OriginatorTypes::Internal; 5135cb1dd27SAsmitha Karunanithi 514aefe3786SClaire Weinan parseDumpEntryFromDbusObject(objectPath, dumpStatus, size, 51568dd075aSAsmitha Karunanithi timestampUs, originatorId, 51668dd075aSAsmitha Karunanithi originatorType, asyncResp); 5175cb1dd27SAsmitha Karunanithi 5180fda0f12SGeorge Liu if (dumpStatus != 5190fda0f12SGeorge Liu "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" && 52035440d18SAsmitha Karunanithi !dumpStatus.empty()) 52135440d18SAsmitha Karunanithi { 52235440d18SAsmitha Karunanithi // Dump status is not Complete 52335440d18SAsmitha Karunanithi // return not found until status is changed to Completed 524bd79bce8SPatrick Williams messages::resourceNotFound(asyncResp->res, 525bd79bce8SPatrick Williams dumpType + " dump", entryID); 52635440d18SAsmitha Karunanithi return; 52735440d18SAsmitha Karunanithi } 52835440d18SAsmitha Karunanithi 5295cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["@odata.type"] = 53068dd075aSAsmitha Karunanithi "#LogEntry.v1_11_0.LogEntry"; 531fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID; 5325cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Id"] = entryID; 5335cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["EntryType"] = "Event"; 5345cb1dd27SAsmitha Karunanithi asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; 535bbd80db8SClaire Weinan asyncResp->res.jsonValue["Created"] = 536bbd80db8SClaire Weinan redfish::time_utils::getDateTimeUintUs(timestampUs); 5375cb1dd27SAsmitha Karunanithi 53868dd075aSAsmitha Karunanithi if (!originatorId.empty()) 53968dd075aSAsmitha Karunanithi { 54068dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["Originator"] = originatorId; 54168dd075aSAsmitha Karunanithi asyncResp->res.jsonValue["OriginatorType"] = originatorType; 54268dd075aSAsmitha Karunanithi } 54368dd075aSAsmitha Karunanithi 5445cb1dd27SAsmitha Karunanithi if (dumpType == "BMC") 5455cb1dd27SAsmitha Karunanithi { 546d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager"; 547d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 548fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 549fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 5505cb1dd27SAsmitha Karunanithi } 5515cb1dd27SAsmitha Karunanithi else if (dumpType == "System") 5525cb1dd27SAsmitha Karunanithi { 553d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM"; 554bd79bce8SPatrick Williams asyncResp->res.jsonValue["OEMDiagnosticDataType"] = 555bd79bce8SPatrick Williams "System"; 556d337bb72SAsmitha Karunanithi asyncResp->res.jsonValue["AdditionalDataURI"] = 557fdd26906SClaire Weinan entriesPath + entryID + "/attachment"; 558fdd26906SClaire Weinan asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size; 5595cb1dd27SAsmitha Karunanithi } 5605cb1dd27SAsmitha Karunanithi } 561e05aec50SEd Tanous if (!foundDumpEntry) 562b47452b2SAsmitha Karunanithi { 56362598e31SEd Tanous BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 564b90d14f2SMyung Bae messages::resourceNotFound(asyncResp->res, dumpType + " dump", 565b90d14f2SMyung Bae entryID); 566b47452b2SAsmitha Karunanithi return; 567b47452b2SAsmitha Karunanithi } 5685eb468daSGeorge Liu }); 5695cb1dd27SAsmitha Karunanithi } 5705cb1dd27SAsmitha Karunanithi 5718d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 5729878256fSStanley Chu const std::string& entryID, 573b47452b2SAsmitha Karunanithi const std::string& dumpType) 5745cb1dd27SAsmitha Karunanithi { 5755a39f77aSPatrick Williams auto respHandler = [asyncResp, 5765a39f77aSPatrick Williams entryID](const boost::system::error_code& ec) { 57762598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Entry doDelete callback: Done"); 5785cb1dd27SAsmitha Karunanithi if (ec) 5795cb1dd27SAsmitha Karunanithi { 5803de8d8baSGeorge Liu if (ec.value() == EBADR) 5813de8d8baSGeorge Liu { 5823de8d8baSGeorge Liu messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 5833de8d8baSGeorge Liu return; 5843de8d8baSGeorge Liu } 58562598e31SEd Tanous BMCWEB_LOG_ERROR( 58662598e31SEd Tanous "Dump (DBus) doDelete respHandler got error {} entryID={}", ec, 58762598e31SEd Tanous entryID); 5885cb1dd27SAsmitha Karunanithi messages::internalError(asyncResp->res); 5895cb1dd27SAsmitha Karunanithi return; 5905cb1dd27SAsmitha Karunanithi } 5915cb1dd27SAsmitha Karunanithi }; 59218f8f608SEd Tanous 593177612aaSEd Tanous dbus::utility::async_method_call( 594177612aaSEd Tanous asyncResp, respHandler, "xyz.openbmc_project.Dump.Manager", 59518f8f608SEd Tanous std::format("{}/entry/{}", getDumpPath(dumpType), entryID), 5965cb1dd27SAsmitha Karunanithi "xyz.openbmc_project.Object.Delete", "Delete"); 5975cb1dd27SAsmitha Karunanithi } 598b5f288d2SAbhilash Raju inline bool checkSizeLimit(int fd, crow::Response& res) 599b5f288d2SAbhilash Raju { 600b5f288d2SAbhilash Raju long long int size = lseek(fd, 0, SEEK_END); 601b5f288d2SAbhilash Raju if (size <= 0) 602b5f288d2SAbhilash Raju { 603b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to get size of file, lseek() returned {}", 604b5f288d2SAbhilash Raju size); 605b5f288d2SAbhilash Raju messages::internalError(res); 606b5f288d2SAbhilash Raju return false; 607b5f288d2SAbhilash Raju } 6085cb1dd27SAsmitha Karunanithi 609b5f288d2SAbhilash Raju // Arbitrary max size of 20MB to accommodate BMC dumps 610b5f288d2SAbhilash Raju constexpr long long int maxFileSize = 20LL * 1024LL * 1024LL; 611b5f288d2SAbhilash Raju if (size > maxFileSize) 612b5f288d2SAbhilash Raju { 613b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("File size {} exceeds maximum allowed size of {}", 614b5f288d2SAbhilash Raju size, maxFileSize); 615b5f288d2SAbhilash Raju messages::internalError(res); 616b5f288d2SAbhilash Raju return false; 617b5f288d2SAbhilash Raju } 618b5f288d2SAbhilash Raju off_t rc = lseek(fd, 0, SEEK_SET); 619b5f288d2SAbhilash Raju if (rc < 0) 620b5f288d2SAbhilash Raju { 621b5f288d2SAbhilash Raju BMCWEB_LOG_ERROR("Failed to reset file offset to 0"); 622b5f288d2SAbhilash Raju messages::internalError(res); 623b5f288d2SAbhilash Raju return false; 624b5f288d2SAbhilash Raju } 625b5f288d2SAbhilash Raju return true; 626b5f288d2SAbhilash Raju } 627bd79bce8SPatrick Williams inline void downloadEntryCallback( 628bd79bce8SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 629bd79bce8SPatrick Williams const std::string& entryID, const std::string& downloadEntryType, 630168d1b1aSCarson Labrado const boost::system::error_code& ec, 631168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) 632168d1b1aSCarson Labrado { 633168d1b1aSCarson Labrado if (ec.value() == EBADR) 634168d1b1aSCarson Labrado { 635168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "EntryAttachment", entryID); 636168d1b1aSCarson Labrado return; 637168d1b1aSCarson Labrado } 638168d1b1aSCarson Labrado if (ec) 639168d1b1aSCarson Labrado { 640168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("DBUS response error: {}", ec); 641168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 642168d1b1aSCarson Labrado return; 643168d1b1aSCarson Labrado } 644168d1b1aSCarson Labrado 645168d1b1aSCarson Labrado // Make sure we know how to process the retrieved entry attachment 646168d1b1aSCarson Labrado if ((downloadEntryType != "BMC") && (downloadEntryType != "System")) 647168d1b1aSCarson Labrado { 648168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("downloadEntryCallback() invalid entry type: {}", 649168d1b1aSCarson Labrado downloadEntryType); 650168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 651168d1b1aSCarson Labrado } 652168d1b1aSCarson Labrado 653168d1b1aSCarson Labrado int fd = -1; 654168d1b1aSCarson Labrado fd = dup(unixfd); 655168d1b1aSCarson Labrado if (fd < 0) 656168d1b1aSCarson Labrado { 657168d1b1aSCarson Labrado BMCWEB_LOG_ERROR("Failed to open file"); 658168d1b1aSCarson Labrado messages::internalError(asyncResp->res); 659168d1b1aSCarson Labrado return; 660168d1b1aSCarson Labrado } 661b5f288d2SAbhilash Raju if (!checkSizeLimit(fd, asyncResp->res)) 662168d1b1aSCarson Labrado { 663168d1b1aSCarson Labrado close(fd); 664168d1b1aSCarson Labrado return; 665168d1b1aSCarson Labrado } 666168d1b1aSCarson Labrado if (downloadEntryType == "System") 667168d1b1aSCarson Labrado { 668b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd, bmcweb::EncodingType::Base64)) 669b5f288d2SAbhilash Raju { 670b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 671b5f288d2SAbhilash Raju close(fd); 672b5f288d2SAbhilash Raju return; 673b5f288d2SAbhilash Raju } 674168d1b1aSCarson Labrado asyncResp->res.addHeader( 675168d1b1aSCarson Labrado boost::beast::http::field::content_transfer_encoding, "Base64"); 676b5f288d2SAbhilash Raju return; 677168d1b1aSCarson Labrado } 678b5f288d2SAbhilash Raju if (!asyncResp->res.openFd(fd)) 67927b0cf90SEd Tanous { 680b5f288d2SAbhilash Raju messages::internalError(asyncResp->res); 681b5f288d2SAbhilash Raju close(fd); 682b5f288d2SAbhilash Raju return; 68327b0cf90SEd Tanous } 684168d1b1aSCarson Labrado asyncResp->res.addHeader(boost::beast::http::field::content_type, 685168d1b1aSCarson Labrado "application/octet-stream"); 686168d1b1aSCarson Labrado } 687168d1b1aSCarson Labrado 688504af5a0SPatrick Williams inline void downloadDumpEntry( 689504af5a0SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 690168d1b1aSCarson Labrado const std::string& entryID, const std::string& dumpType) 691168d1b1aSCarson Labrado { 692168d1b1aSCarson Labrado if (dumpType != "BMC") 693168d1b1aSCarson Labrado { 694168d1b1aSCarson Labrado BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID); 695168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, dumpType + " dump", entryID); 696168d1b1aSCarson Labrado return; 697168d1b1aSCarson Labrado } 698168d1b1aSCarson Labrado 699bd79bce8SPatrick Williams std::string dumpEntryPath = 700bd79bce8SPatrick Williams std::format("{}/entry/{}", getDumpPath(dumpType), entryID); 701168d1b1aSCarson Labrado 702168d1b1aSCarson Labrado auto downloadDumpEntryHandler = 703168d1b1aSCarson Labrado [asyncResp, entryID, 704168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 705168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 706168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 707168d1b1aSCarson Labrado }; 708168d1b1aSCarson Labrado 709177612aaSEd Tanous dbus::utility::async_method_call( 710177612aaSEd Tanous asyncResp, std::move(downloadDumpEntryHandler), 711177612aaSEd Tanous "xyz.openbmc_project.Dump.Manager", dumpEntryPath, 712177612aaSEd Tanous "xyz.openbmc_project.Dump.Entry", "GetFileHandle"); 713168d1b1aSCarson Labrado } 714168d1b1aSCarson Labrado 715bd79bce8SPatrick Williams inline void downloadEventLogEntry( 716bd79bce8SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 717bd79bce8SPatrick Williams const std::string& systemName, const std::string& entryID, 718168d1b1aSCarson Labrado const std::string& dumpType) 719168d1b1aSCarson Labrado { 72025b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 721168d1b1aSCarson Labrado { 722168d1b1aSCarson Labrado // Option currently returns no systems. TBD 723168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 724168d1b1aSCarson Labrado systemName); 725168d1b1aSCarson Labrado return; 726168d1b1aSCarson Labrado } 727253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 728168d1b1aSCarson Labrado { 729168d1b1aSCarson Labrado messages::resourceNotFound(asyncResp->res, "ComputerSystem", 730168d1b1aSCarson Labrado systemName); 731168d1b1aSCarson Labrado return; 732168d1b1aSCarson Labrado } 733168d1b1aSCarson Labrado 734168d1b1aSCarson Labrado std::string entryPath = 735168d1b1aSCarson Labrado sdbusplus::message::object_path("/xyz/openbmc_project/logging/entry") / 736168d1b1aSCarson Labrado entryID; 737168d1b1aSCarson Labrado 738168d1b1aSCarson Labrado auto downloadEventLogEntryHandler = 739168d1b1aSCarson Labrado [asyncResp, entryID, 740168d1b1aSCarson Labrado dumpType](const boost::system::error_code& ec, 741168d1b1aSCarson Labrado const sdbusplus::message::unix_fd& unixfd) { 742168d1b1aSCarson Labrado downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd); 743168d1b1aSCarson Labrado }; 744168d1b1aSCarson Labrado 745177612aaSEd Tanous dbus::utility::async_method_call( 746177612aaSEd Tanous asyncResp, std::move(downloadEventLogEntryHandler), 747177612aaSEd Tanous "xyz.openbmc_project.Logging", entryPath, 748177612aaSEd Tanous "xyz.openbmc_project.Logging.Entry", "GetEntry"); 749168d1b1aSCarson Labrado } 750168d1b1aSCarson Labrado 751504af5a0SPatrick Williams inline DumpCreationProgress mapDbusStatusToDumpProgress( 752504af5a0SPatrick Williams const std::string& status) 753a43be80fSAsmitha Karunanithi { 7548e31778eSAsmitha Karunanithi if (status == 7558e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" || 7568e31778eSAsmitha Karunanithi status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted") 7578e31778eSAsmitha Karunanithi { 7588e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 7598e31778eSAsmitha Karunanithi } 7608e31778eSAsmitha Karunanithi if (status == 7618e31778eSAsmitha Karunanithi "xyz.openbmc_project.Common.Progress.OperationStatus.Completed") 7628e31778eSAsmitha Karunanithi { 7638e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_SUCCESS; 7648e31778eSAsmitha Karunanithi } 7658e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 7668e31778eSAsmitha Karunanithi } 7678e31778eSAsmitha Karunanithi 768504af5a0SPatrick Williams inline DumpCreationProgress getDumpCompletionStatus( 769504af5a0SPatrick Williams const dbus::utility::DBusPropertiesMap& values) 7708e31778eSAsmitha Karunanithi { 7718e31778eSAsmitha Karunanithi for (const auto& [key, val] : values) 7728e31778eSAsmitha Karunanithi { 7738e31778eSAsmitha Karunanithi if (key == "Status") 7748e31778eSAsmitha Karunanithi { 7758e31778eSAsmitha Karunanithi const std::string* value = std::get_if<std::string>(&val); 7768e31778eSAsmitha Karunanithi if (value == nullptr) 7778e31778eSAsmitha Karunanithi { 77862598e31SEd Tanous BMCWEB_LOG_ERROR("Status property value is null"); 7798e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_FAILED; 7808e31778eSAsmitha Karunanithi } 7818e31778eSAsmitha Karunanithi return mapDbusStatusToDumpProgress(*value); 7828e31778eSAsmitha Karunanithi } 7838e31778eSAsmitha Karunanithi } 7848e31778eSAsmitha Karunanithi return DumpCreationProgress::DUMP_CREATE_INPROGRESS; 7858e31778eSAsmitha Karunanithi } 7868e31778eSAsmitha Karunanithi 7878e31778eSAsmitha Karunanithi inline std::string getDumpEntryPath(const std::string& dumpPath) 7888e31778eSAsmitha Karunanithi { 7898e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry") 7908e31778eSAsmitha Karunanithi { 791253f11b8SEd Tanous return std::format("/redfish/v1/Managers/{}/LogServices/Dump/Entries/", 7929f565090SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 7938e31778eSAsmitha Karunanithi } 7948e31778eSAsmitha Karunanithi if (dumpPath == "/xyz/openbmc_project/dump/system/entry") 7958e31778eSAsmitha Karunanithi { 796253f11b8SEd Tanous return std::format("/redfish/v1/Systems/{}/LogServices/Dump/Entries/", 797253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 7988e31778eSAsmitha Karunanithi } 7998e31778eSAsmitha Karunanithi return ""; 8008e31778eSAsmitha Karunanithi } 8018e31778eSAsmitha Karunanithi 8028e31778eSAsmitha Karunanithi inline void createDumpTaskCallback( 8038e31778eSAsmitha Karunanithi task::Payload&& payload, 8048e31778eSAsmitha Karunanithi const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 8058e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& createdObjPath) 8068e31778eSAsmitha Karunanithi { 8078e31778eSAsmitha Karunanithi const std::string dumpPath = createdObjPath.parent_path().str; 8088e31778eSAsmitha Karunanithi const std::string dumpId = createdObjPath.filename(); 8098e31778eSAsmitha Karunanithi 8108e31778eSAsmitha Karunanithi std::string dumpEntryPath = getDumpEntryPath(dumpPath); 8118e31778eSAsmitha Karunanithi 8128e31778eSAsmitha Karunanithi if (dumpEntryPath.empty()) 8138e31778eSAsmitha Karunanithi { 81462598e31SEd Tanous BMCWEB_LOG_ERROR("Invalid dump type received"); 8158e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 8168e31778eSAsmitha Karunanithi return; 8178e31778eSAsmitha Karunanithi } 8188e31778eSAsmitha Karunanithi 819177612aaSEd Tanous dbus::utility::async_method_call( 820177612aaSEd Tanous asyncResp, 8218cb2c024SEd Tanous [asyncResp, payload = std::move(payload), createdObjPath, 8228e31778eSAsmitha Karunanithi dumpEntryPath{std::move(dumpEntryPath)}, 8235e7e2dc5SEd Tanous dumpId](const boost::system::error_code& ec, 8248e31778eSAsmitha Karunanithi const std::string& introspectXml) { 8258e31778eSAsmitha Karunanithi if (ec) 8268e31778eSAsmitha Karunanithi { 82762598e31SEd Tanous BMCWEB_LOG_ERROR("Introspect call failed with error: {}", 82862598e31SEd Tanous ec.message()); 8298e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 8308e31778eSAsmitha Karunanithi return; 8318e31778eSAsmitha Karunanithi } 8328e31778eSAsmitha Karunanithi 8338e31778eSAsmitha Karunanithi // Check if the created dump object has implemented Progress 8348e31778eSAsmitha Karunanithi // interface to track dump completion. If yes, fetch the "Status" 8358e31778eSAsmitha Karunanithi // property of the interface, modify the task state accordingly. 8368e31778eSAsmitha Karunanithi // Else, return task completed. 8378e31778eSAsmitha Karunanithi tinyxml2::XMLDocument doc; 8388e31778eSAsmitha Karunanithi 8398e31778eSAsmitha Karunanithi doc.Parse(introspectXml.data(), introspectXml.size()); 8408e31778eSAsmitha Karunanithi tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node"); 8418e31778eSAsmitha Karunanithi if (pRoot == nullptr) 8428e31778eSAsmitha Karunanithi { 84362598e31SEd Tanous BMCWEB_LOG_ERROR("XML document failed to parse"); 8448e31778eSAsmitha Karunanithi messages::internalError(asyncResp->res); 8458e31778eSAsmitha Karunanithi return; 8468e31778eSAsmitha Karunanithi } 8478e31778eSAsmitha Karunanithi tinyxml2::XMLElement* interfaceNode = 8488e31778eSAsmitha Karunanithi pRoot->FirstChildElement("interface"); 8498e31778eSAsmitha Karunanithi 8508e31778eSAsmitha Karunanithi bool isProgressIntfPresent = false; 8518e31778eSAsmitha Karunanithi while (interfaceNode != nullptr) 8528e31778eSAsmitha Karunanithi { 853bd79bce8SPatrick Williams const char* thisInterfaceName = 854bd79bce8SPatrick Williams interfaceNode->Attribute("name"); 8558e31778eSAsmitha Karunanithi if (thisInterfaceName != nullptr) 8568e31778eSAsmitha Karunanithi { 8578e31778eSAsmitha Karunanithi if (thisInterfaceName == 8588e31778eSAsmitha Karunanithi std::string_view("xyz.openbmc_project.Common.Progress")) 8598e31778eSAsmitha Karunanithi { 8608e31778eSAsmitha Karunanithi interfaceNode = 8618e31778eSAsmitha Karunanithi interfaceNode->NextSiblingElement("interface"); 8628e31778eSAsmitha Karunanithi continue; 8638e31778eSAsmitha Karunanithi } 8648e31778eSAsmitha Karunanithi isProgressIntfPresent = true; 8658e31778eSAsmitha Karunanithi break; 8668e31778eSAsmitha Karunanithi } 8678e31778eSAsmitha Karunanithi interfaceNode = interfaceNode->NextSiblingElement("interface"); 8688e31778eSAsmitha Karunanithi } 8698e31778eSAsmitha Karunanithi 870a43be80fSAsmitha Karunanithi std::shared_ptr<task::TaskData> task = task::TaskData::createTask( 8718e31778eSAsmitha Karunanithi [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent]( 872bd79bce8SPatrick Williams const boost::system::error_code& ec2, 873bd79bce8SPatrick Williams sdbusplus::message_t& msg, 874a43be80fSAsmitha Karunanithi const std::shared_ptr<task::TaskData>& taskData) { 8758b24275dSEd Tanous if (ec2) 876cb13a392SEd Tanous { 87762598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 87862598e31SEd Tanous createdObjPath.str); 879bd79bce8SPatrick Williams taskData->messages.emplace_back( 880bd79bce8SPatrick Williams messages::internalError()); 8816145ed6fSAsmitha Karunanithi taskData->state = "Cancelled"; 8826145ed6fSAsmitha Karunanithi return task::completed; 883cb13a392SEd Tanous } 884b9d36b47SEd Tanous 8858e31778eSAsmitha Karunanithi if (isProgressIntfPresent) 886a43be80fSAsmitha Karunanithi { 8878e31778eSAsmitha Karunanithi dbus::utility::DBusPropertiesMap values; 8888e31778eSAsmitha Karunanithi std::string prop; 8898e31778eSAsmitha Karunanithi msg.read(prop, values); 8908e31778eSAsmitha Karunanithi 8918e31778eSAsmitha Karunanithi DumpCreationProgress dumpStatus = 8928e31778eSAsmitha Karunanithi getDumpCompletionStatus(values); 893bd79bce8SPatrick Williams if (dumpStatus == 894bd79bce8SPatrick Williams DumpCreationProgress::DUMP_CREATE_FAILED) 8958e31778eSAsmitha Karunanithi { 89662598e31SEd Tanous BMCWEB_LOG_ERROR("{}: Error in creating dump", 89762598e31SEd Tanous createdObjPath.str); 8988e31778eSAsmitha Karunanithi taskData->state = "Cancelled"; 8998e31778eSAsmitha Karunanithi return task::completed; 9008e31778eSAsmitha Karunanithi } 9018e31778eSAsmitha Karunanithi 902bd79bce8SPatrick Williams if (dumpStatus == 903bd79bce8SPatrick Williams DumpCreationProgress::DUMP_CREATE_INPROGRESS) 9048e31778eSAsmitha Karunanithi { 905bd79bce8SPatrick Williams BMCWEB_LOG_DEBUG( 906bd79bce8SPatrick Williams "{}: Dump creation task is in progress", 90762598e31SEd Tanous createdObjPath.str); 9088e31778eSAsmitha Karunanithi return !task::completed; 9098e31778eSAsmitha Karunanithi } 9108e31778eSAsmitha Karunanithi } 9118e31778eSAsmitha Karunanithi 912a43be80fSAsmitha Karunanithi nlohmann::json retMessage = messages::success(); 913a43be80fSAsmitha Karunanithi taskData->messages.emplace_back(retMessage); 914a43be80fSAsmitha Karunanithi 915c51a58eeSEd Tanous boost::urls::url url = boost::urls::format( 916253f11b8SEd Tanous "/redfish/v1/Managers/{}/LogServices/Dump/Entries/{}", 917253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME, dumpId); 918c51a58eeSEd Tanous 919c51a58eeSEd Tanous std::string headerLoc = "Location: "; 920c51a58eeSEd Tanous headerLoc += url.buffer(); 921c51a58eeSEd Tanous 922bd79bce8SPatrick Williams taskData->payload->httpHeaders.emplace_back( 923bd79bce8SPatrick Williams std::move(headerLoc)); 924a43be80fSAsmitha Karunanithi 92562598e31SEd Tanous BMCWEB_LOG_DEBUG("{}: Dump creation task completed", 92662598e31SEd Tanous createdObjPath.str); 927a43be80fSAsmitha Karunanithi taskData->state = "Completed"; 928b47452b2SAsmitha Karunanithi return task::completed; 929a43be80fSAsmitha Karunanithi }, 9308e31778eSAsmitha Karunanithi "type='signal',interface='org.freedesktop.DBus.Properties'," 9318e31778eSAsmitha Karunanithi "member='PropertiesChanged',path='" + 9328e31778eSAsmitha Karunanithi createdObjPath.str + "'"); 933a43be80fSAsmitha Karunanithi 9348e31778eSAsmitha Karunanithi // The task timer is set to max time limit within which the 9358e31778eSAsmitha Karunanithi // requested dump will be collected. 9368e31778eSAsmitha Karunanithi task->startTimer(std::chrono::minutes(6)); 9378e31778eSAsmitha Karunanithi task->payload.emplace(payload); 93829e2bdd7SChinmay Shripad Hegde task->populateResp(asyncResp->res); 9398e31778eSAsmitha Karunanithi }, 9408e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Manager", createdObjPath, 9418e31778eSAsmitha Karunanithi "org.freedesktop.DBus.Introspectable", "Introspect"); 942a43be80fSAsmitha Karunanithi } 943a43be80fSAsmitha Karunanithi 9448d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 9458d1b46d7Szhanghch05 const crow::Request& req, const std::string& dumpType) 946a43be80fSAsmitha Karunanithi { 947fdd26906SClaire Weinan std::string dumpPath = getDumpEntriesPath(dumpType); 948fdd26906SClaire Weinan if (dumpPath.empty()) 949a43be80fSAsmitha Karunanithi { 950a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 951a43be80fSAsmitha Karunanithi return; 952a43be80fSAsmitha Karunanithi } 953a43be80fSAsmitha Karunanithi 954a43be80fSAsmitha Karunanithi std::optional<std::string> diagnosticDataType; 955a43be80fSAsmitha Karunanithi std::optional<std::string> oemDiagnosticDataType; 956a43be80fSAsmitha Karunanithi 957afc474aeSMyung Bae if (!redfish::json_util::readJsonAction( // 958afc474aeSMyung Bae req, asyncResp->res, // 959afc474aeSMyung Bae "DiagnosticDataType", diagnosticDataType, // 960afc474aeSMyung Bae "OEMDiagnosticDataType", oemDiagnosticDataType // 961afc474aeSMyung Bae )) 962a43be80fSAsmitha Karunanithi { 963a43be80fSAsmitha Karunanithi return; 964a43be80fSAsmitha Karunanithi } 965a43be80fSAsmitha Karunanithi 966a43be80fSAsmitha Karunanithi if (dumpType == "System") 967a43be80fSAsmitha Karunanithi { 968a43be80fSAsmitha Karunanithi if (!oemDiagnosticDataType || !diagnosticDataType) 969a43be80fSAsmitha Karunanithi { 97062598e31SEd Tanous BMCWEB_LOG_ERROR( 97162598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!"); 972a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 973a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", 974a43be80fSAsmitha Karunanithi "DiagnosticDataType & OEMDiagnosticDataType"); 975a43be80fSAsmitha Karunanithi return; 976a43be80fSAsmitha Karunanithi } 9773174e4dfSEd Tanous if ((*oemDiagnosticDataType != "System") || 978a43be80fSAsmitha Karunanithi (*diagnosticDataType != "OEM")) 979a43be80fSAsmitha Karunanithi { 98062598e31SEd Tanous BMCWEB_LOG_ERROR("Wrong parameter values passed"); 981ace85d60SEd Tanous messages::internalError(asyncResp->res); 982a43be80fSAsmitha Karunanithi return; 983a43be80fSAsmitha Karunanithi } 984253f11b8SEd Tanous dumpPath = std::format("/redfish/v1/Systems/{}/LogServices/Dump/", 985253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 986a43be80fSAsmitha Karunanithi } 987a43be80fSAsmitha Karunanithi else if (dumpType == "BMC") 988a43be80fSAsmitha Karunanithi { 989a43be80fSAsmitha Karunanithi if (!diagnosticDataType) 990a43be80fSAsmitha Karunanithi { 99162598e31SEd Tanous BMCWEB_LOG_ERROR( 99262598e31SEd Tanous "CreateDump action parameter 'DiagnosticDataType' not found!"); 993a43be80fSAsmitha Karunanithi messages::actionParameterMissing( 994a43be80fSAsmitha Karunanithi asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); 995a43be80fSAsmitha Karunanithi return; 996a43be80fSAsmitha Karunanithi } 9973174e4dfSEd Tanous if (*diagnosticDataType != "Manager") 998a43be80fSAsmitha Karunanithi { 99962598e31SEd Tanous BMCWEB_LOG_ERROR( 100062598e31SEd Tanous "Wrong parameter value passed for 'DiagnosticDataType'"); 1001ace85d60SEd Tanous messages::internalError(asyncResp->res); 1002a43be80fSAsmitha Karunanithi return; 1003a43be80fSAsmitha Karunanithi } 1004253f11b8SEd Tanous dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/Dump/", 1005253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 10065907571dSAsmitha Karunanithi } 10075907571dSAsmitha Karunanithi else 10085907571dSAsmitha Karunanithi { 100962598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump failed. Unknown dump type"); 10105907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 10115907571dSAsmitha Karunanithi return; 1012a43be80fSAsmitha Karunanithi } 1013a43be80fSAsmitha Karunanithi 10148e31778eSAsmitha Karunanithi std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>> 10158e31778eSAsmitha Karunanithi createDumpParamVec; 10168e31778eSAsmitha Karunanithi 1017f574a8e1SCarson Labrado if (req.session != nullptr) 1018f574a8e1SCarson Labrado { 101968dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 102068dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId", 102168dd075aSAsmitha Karunanithi req.session->clientIp); 102268dd075aSAsmitha Karunanithi createDumpParamVec.emplace_back( 102368dd075aSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType", 102468dd075aSAsmitha Karunanithi "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client"); 1025f574a8e1SCarson Labrado } 102668dd075aSAsmitha Karunanithi 1027177612aaSEd Tanous dbus::utility::async_method_call( 1028177612aaSEd Tanous asyncResp, 10295e7e2dc5SEd Tanous [asyncResp, payload(task::Payload(req)), 10305e7e2dc5SEd Tanous dumpPath](const boost::system::error_code& ec, 10315e7e2dc5SEd Tanous const sdbusplus::message_t& msg, 10328e31778eSAsmitha Karunanithi const sdbusplus::message::object_path& objPath) mutable { 1033a43be80fSAsmitha Karunanithi if (ec) 1034a43be80fSAsmitha Karunanithi { 103562598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump resp_handler got error {}", ec); 10365907571dSAsmitha Karunanithi const sd_bus_error* dbusError = msg.get_error(); 10375907571dSAsmitha Karunanithi if (dbusError == nullptr) 10385907571dSAsmitha Karunanithi { 10395907571dSAsmitha Karunanithi messages::internalError(asyncResp->res); 10405907571dSAsmitha Karunanithi return; 10415907571dSAsmitha Karunanithi } 10425907571dSAsmitha Karunanithi 104362598e31SEd Tanous BMCWEB_LOG_ERROR("CreateDump DBus error: {} and error msg: {}", 104462598e31SEd Tanous dbusError->name, dbusError->message); 10455907571dSAsmitha Karunanithi if (std::string_view( 10465907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.NotAllowed") == 10475907571dSAsmitha Karunanithi dbusError->name) 10485907571dSAsmitha Karunanithi { 10495907571dSAsmitha Karunanithi messages::resourceInStandby(asyncResp->res); 10505907571dSAsmitha Karunanithi return; 10515907571dSAsmitha Karunanithi } 10525907571dSAsmitha Karunanithi if (std::string_view( 10535907571dSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create.Error.Disabled") == 10545907571dSAsmitha Karunanithi dbusError->name) 10555907571dSAsmitha Karunanithi { 10565907571dSAsmitha Karunanithi messages::serviceDisabled(asyncResp->res, dumpPath); 10575907571dSAsmitha Karunanithi return; 10585907571dSAsmitha Karunanithi } 10595907571dSAsmitha Karunanithi if (std::string_view( 10605907571dSAsmitha Karunanithi "xyz.openbmc_project.Common.Error.Unavailable") == 10615907571dSAsmitha Karunanithi dbusError->name) 10625907571dSAsmitha Karunanithi { 10635907571dSAsmitha Karunanithi messages::resourceInUse(asyncResp->res); 10645907571dSAsmitha Karunanithi return; 10655907571dSAsmitha Karunanithi } 10665907571dSAsmitha Karunanithi // Other Dbus errors such as: 10675907571dSAsmitha Karunanithi // xyz.openbmc_project.Common.Error.InvalidArgument & 10685907571dSAsmitha Karunanithi // org.freedesktop.DBus.Error.InvalidArgs are all related to 10695907571dSAsmitha Karunanithi // the dbus call that is made here in the bmcweb 10705907571dSAsmitha Karunanithi // implementation and has nothing to do with the client's 10715907571dSAsmitha Karunanithi // input in the request. Hence, returning internal error 10725907571dSAsmitha Karunanithi // back to the client. 1073a43be80fSAsmitha Karunanithi messages::internalError(asyncResp->res); 1074a43be80fSAsmitha Karunanithi return; 1075a43be80fSAsmitha Karunanithi } 107662598e31SEd Tanous BMCWEB_LOG_DEBUG("Dump Created. Path: {}", objPath.str); 10778e31778eSAsmitha Karunanithi createDumpTaskCallback(std::move(payload), asyncResp, objPath); 1078a43be80fSAsmitha Karunanithi }, 107918f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 10808e31778eSAsmitha Karunanithi "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec); 1081a43be80fSAsmitha Karunanithi } 1082a43be80fSAsmitha Karunanithi 10838d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 10848d1b46d7Szhanghch05 const std::string& dumpType) 108580319af1SAsmitha Karunanithi { 1086177612aaSEd Tanous dbus::utility::async_method_call( 1087177612aaSEd Tanous asyncResp, 10880d946211SClaire Weinan [asyncResp](const boost::system::error_code& ec) { 108980319af1SAsmitha Karunanithi if (ec) 109080319af1SAsmitha Karunanithi { 109162598e31SEd Tanous BMCWEB_LOG_ERROR("clearDump resp_handler got error {}", ec); 109280319af1SAsmitha Karunanithi messages::internalError(asyncResp->res); 109380319af1SAsmitha Karunanithi return; 109480319af1SAsmitha Karunanithi } 1095e2460466SAmy Chang messages::success(asyncResp->res); 10960d946211SClaire Weinan }, 109718f8f608SEd Tanous "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType), 10980d946211SClaire Weinan "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 109980319af1SAsmitha Karunanithi } 110080319af1SAsmitha Karunanithi 1101bd79bce8SPatrick Williams inline void parseCrashdumpParameters( 1102bd79bce8SPatrick Williams const dbus::utility::DBusPropertiesMap& params, std::string& filename, 1103bd79bce8SPatrick Williams std::string& timestamp, std::string& logfile) 1104043a0536SJohnathan Mantey { 1105d1bde9e5SKrzysztof Grobelny const std::string* filenamePtr = nullptr; 1106d1bde9e5SKrzysztof Grobelny const std::string* timestampPtr = nullptr; 1107d1bde9e5SKrzysztof Grobelny const std::string* logfilePtr = nullptr; 1108d1bde9e5SKrzysztof Grobelny 1109d1bde9e5SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 1110d1bde9e5SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr, 1111d1bde9e5SKrzysztof Grobelny "Filename", filenamePtr, "Log", logfilePtr); 1112d1bde9e5SKrzysztof Grobelny 1113d1bde9e5SKrzysztof Grobelny if (!success) 1114043a0536SJohnathan Mantey { 1115d1bde9e5SKrzysztof Grobelny return; 1116043a0536SJohnathan Mantey } 1117d1bde9e5SKrzysztof Grobelny 1118d1bde9e5SKrzysztof Grobelny if (filenamePtr != nullptr) 1119043a0536SJohnathan Mantey { 1120d1bde9e5SKrzysztof Grobelny filename = *filenamePtr; 1121d1bde9e5SKrzysztof Grobelny } 1122d1bde9e5SKrzysztof Grobelny 1123d1bde9e5SKrzysztof Grobelny if (timestampPtr != nullptr) 1124043a0536SJohnathan Mantey { 1125d1bde9e5SKrzysztof Grobelny timestamp = *timestampPtr; 1126043a0536SJohnathan Mantey } 1127d1bde9e5SKrzysztof Grobelny 1128d1bde9e5SKrzysztof Grobelny if (logfilePtr != nullptr) 1129043a0536SJohnathan Mantey { 1130d1bde9e5SKrzysztof Grobelny logfile = *logfilePtr; 1131043a0536SJohnathan Mantey } 1132043a0536SJohnathan Mantey } 1133043a0536SJohnathan Mantey 11347e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app) 11351da66f75SEd Tanous { 1136c4bf6374SJason M. Bills /** 1137c4bf6374SJason M. Bills * Functions triggers appropriate requests on DBus 1138c4bf6374SJason M. Bills */ 113922d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/") 1140ed398213SEd Tanous .privileges(redfish::privileges::getLogServiceCollection) 1141bd79bce8SPatrick Williams .methods( 1142bd79bce8SPatrick Williams boost::beast::http::verb:: 1143bd79bce8SPatrick Williams get)([&app](const crow::Request& req, 114422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 114522d268cbSEd Tanous const std::string& systemName) { 11463ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1147c4bf6374SJason M. Bills { 114845ca1b86SEd Tanous return; 114945ca1b86SEd Tanous } 115025b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 11517f3e84a1SEd Tanous { 11527f3e84a1SEd Tanous // Option currently returns no systems. TBD 11537f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 11547f3e84a1SEd Tanous systemName); 11557f3e84a1SEd Tanous return; 11567f3e84a1SEd Tanous } 1157253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 115822d268cbSEd Tanous { 115922d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 116022d268cbSEd Tanous systemName); 116122d268cbSEd Tanous return; 116222d268cbSEd Tanous } 116322d268cbSEd Tanous 11647e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 11657e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1166c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1167c4bf6374SJason M. Bills "#LogServiceCollection.LogServiceCollection"; 1168c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1169253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices", 1170253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 117145ca1b86SEd Tanous asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; 1172c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1173c4bf6374SJason M. Bills "Collection of LogServices for this Computer System"; 1174bd79bce8SPatrick Williams nlohmann::json& logServiceArray = 1175bd79bce8SPatrick Williams asyncResp->res.jsonValue["Members"]; 1176c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 11771476687dSEd Tanous nlohmann::json::object_t eventLog; 11781476687dSEd Tanous eventLog["@odata.id"] = 1179253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/EventLog", 1180253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1181b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(eventLog)); 118225b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_DUMP_LOG) 118325b54dbaSEd Tanous { 11841476687dSEd Tanous nlohmann::json::object_t dumpLog; 118525b54dbaSEd Tanous dumpLog["@odata.id"] = 1186253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/Dump", 1187253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1188b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(dumpLog)); 118925b54dbaSEd Tanous } 1190c9bb6861Sraviteja-b 11915ffd11f2SGunnar Mills if constexpr (BMCWEB_REDFISH_CPU_LOG) 119225b54dbaSEd Tanous { 11931476687dSEd Tanous nlohmann::json::object_t crashdump; 11941476687dSEd Tanous crashdump["@odata.id"] = 1195253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/Crashdump", 1196253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1197b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(crashdump)); 119825b54dbaSEd Tanous } 1199b7028ebfSSpencer Ku 120025b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_HOST_LOGGER) 120125b54dbaSEd Tanous { 12021476687dSEd Tanous nlohmann::json::object_t hostlogger; 12031476687dSEd Tanous hostlogger["@odata.id"] = 1204253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/HostLogger", 1205253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1206b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(hostlogger)); 120725b54dbaSEd Tanous } 1208c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 1209c4bf6374SJason M. Bills logServiceArray.size(); 1210a3316fc6SZhikuiRen 12117a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 12127a1dbc48SGeorge Liu "xyz.openbmc_project.State.Boot.PostCode"}; 12137a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 12147a1dbc48SGeorge Liu "/", 0, interfaces, 12157a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 1216b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 1217b9d36b47SEd Tanous subtreePath) { 1218a3316fc6SZhikuiRen if (ec) 1219a3316fc6SZhikuiRen { 122062598e31SEd Tanous BMCWEB_LOG_ERROR("{}", ec); 1221a3316fc6SZhikuiRen return; 1222a3316fc6SZhikuiRen } 1223a3316fc6SZhikuiRen 122455f79e6fSEd Tanous for (const auto& pathStr : subtreePath) 1225a3316fc6SZhikuiRen { 1226a3316fc6SZhikuiRen if (pathStr.find("PostCode") != std::string::npos) 1227a3316fc6SZhikuiRen { 122823a21a1cSEd Tanous nlohmann::json& logServiceArrayLocal = 1229a3316fc6SZhikuiRen asyncResp->res.jsonValue["Members"]; 1230613dabeaSEd Tanous nlohmann::json::object_t member; 1231253f11b8SEd Tanous member["@odata.id"] = std::format( 1232253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/PostCodes", 1233253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1234613dabeaSEd Tanous 1235bd79bce8SPatrick Williams logServiceArrayLocal.emplace_back( 1236bd79bce8SPatrick Williams std::move(member)); 1237613dabeaSEd Tanous 123845ca1b86SEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = 123923a21a1cSEd Tanous logServiceArrayLocal.size(); 1240a3316fc6SZhikuiRen return; 1241a3316fc6SZhikuiRen } 1242a3316fc6SZhikuiRen } 12437a1dbc48SGeorge Liu }); 12447e860f15SJohn Edward Broadbent }); 1245c4bf6374SJason M. Bills } 1246c4bf6374SJason M. Bills 12477e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app) 1248c4bf6374SJason M. Bills { 124922d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/") 1250ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 1251bd79bce8SPatrick Williams .methods( 1252bd79bce8SPatrick Williams boost::beast::http::verb:: 1253bd79bce8SPatrick Williams get)([&app](const crow::Request& req, 125422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 125522d268cbSEd Tanous const std::string& systemName) { 12563ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 125745ca1b86SEd Tanous { 125845ca1b86SEd Tanous return; 125945ca1b86SEd Tanous } 1260253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 126122d268cbSEd Tanous { 126222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 126322d268cbSEd Tanous systemName); 126422d268cbSEd Tanous return; 126522d268cbSEd Tanous } 1266c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1267253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/EventLog", 1268253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1269c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1270b25644a1SJanet Adkins "#LogService.v1_2_0.LogService"; 1271c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "Event Log Service"; 1272bd79bce8SPatrick Williams asyncResp->res.jsonValue["Description"] = 1273bd79bce8SPatrick Williams "System Event Log Service"; 1274c4bf6374SJason M. Bills asyncResp->res.jsonValue["Id"] = "EventLog"; 1275539d8c6bSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = 1276539d8c6bSEd Tanous log_service::OverWritePolicy::WrapsWhenFull; 12777c8c4058STejas Patil 12787c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 12792b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 12807c8c4058STejas Patil 12817c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 12827c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 12837c8c4058STejas Patil redfishDateTimeOffset.second; 12847c8c4058STejas Patil 1285bd79bce8SPatrick Williams asyncResp->res.jsonValue["Entries"]["@odata.id"] = std::format( 1286bd79bce8SPatrick Williams "/redfish/v1/Systems/{}/LogServices/EventLog/Entries", 1287253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1288bd79bce8SPatrick Williams asyncResp->res 1289bd79bce8SPatrick Williams .jsonValue["Actions"]["#LogService.ClearLog"]["target"] 1290e7d6c8b2SGunnar Mills 129120fa6a2cSEd Tanous = std::format( 1292253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/EventLog/Actions/LogService.ClearLog", 129320fa6a2cSEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 12947e860f15SJohn Edward Broadbent }); 1295489640c6SJason M. Bills } 1296489640c6SJason M. Bills 1297599b9af3SAlexander Hansen inline void handleSystemsLogServicesEventLogActionsClearPost( 1298599b9af3SAlexander Hansen App& app, const crow::Request& req, 129922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1300599b9af3SAlexander Hansen const std::string& systemName) 1301599b9af3SAlexander Hansen { 13023ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 130345ca1b86SEd Tanous { 130445ca1b86SEd Tanous return; 130545ca1b86SEd Tanous } 1306253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 130722d268cbSEd Tanous { 130822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 130922d268cbSEd Tanous systemName); 131022d268cbSEd Tanous return; 131122d268cbSEd Tanous } 1312599b9af3SAlexander Hansen 1313489640c6SJason M. Bills // Clear the EventLog by deleting the log files 1314489640c6SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1315489640c6SJason M. Bills if (getRedfishLogFiles(redfishLogFiles)) 1316489640c6SJason M. Bills { 1317489640c6SJason M. Bills for (const std::filesystem::path& file : redfishLogFiles) 1318489640c6SJason M. Bills { 1319489640c6SJason M. Bills std::error_code ec; 1320489640c6SJason M. Bills std::filesystem::remove(file, ec); 1321489640c6SJason M. Bills } 1322489640c6SJason M. Bills } 1323489640c6SJason M. Bills 1324489640c6SJason M. Bills // Reload rsyslog so it knows to start new log files 1325177612aaSEd Tanous dbus::utility::async_method_call( 1326177612aaSEd Tanous asyncResp, 13275e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec) { 1328489640c6SJason M. Bills if (ec) 1329489640c6SJason M. Bills { 133062598e31SEd Tanous BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec); 1331489640c6SJason M. Bills messages::internalError(asyncResp->res); 1332489640c6SJason M. Bills return; 1333489640c6SJason M. Bills } 1334489640c6SJason M. Bills 1335489640c6SJason M. Bills messages::success(asyncResp->res); 1336489640c6SJason M. Bills }, 1337489640c6SJason M. Bills "org.freedesktop.systemd1", "/org/freedesktop/systemd1", 1338002d39b4SEd Tanous "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", 1339002d39b4SEd Tanous "replace"); 1340599b9af3SAlexander Hansen } 1341599b9af3SAlexander Hansen 1342599b9af3SAlexander Hansen inline void requestRoutesJournalEventLogClear(App& app) 1343599b9af3SAlexander Hansen { 1344599b9af3SAlexander Hansen BMCWEB_ROUTE( 1345599b9af3SAlexander Hansen app, 1346599b9af3SAlexander Hansen "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 1347fff6a4d3SAbhishek Patel .privileges(redfish::privileges:: 1348fff6a4d3SAbhishek Patel postLogServiceSubOverComputerSystemLogServiceCollection) 1349599b9af3SAlexander Hansen .methods(boost::beast::http::verb::post)(std::bind_front( 1350599b9af3SAlexander Hansen handleSystemsLogServicesEventLogActionsClearPost, std::ref(app))); 1351c4bf6374SJason M. Bills } 1352c4bf6374SJason M. Bills 1353ac992cdeSJason M. Bills enum class LogParseError 1354ac992cdeSJason M. Bills { 1355ac992cdeSJason M. Bills success, 1356ac992cdeSJason M. Bills parseFailed, 1357ac992cdeSJason M. Bills messageIdNotInRegistry, 1358ac992cdeSJason M. Bills }; 1359ac992cdeSJason M. Bills 1360bd79bce8SPatrick Williams static LogParseError fillEventLogEntryJson( 1361bd79bce8SPatrick Williams const std::string& logEntryID, const std::string& logEntry, 1362de703c5dSJason M. Bills nlohmann::json::object_t& logEntryJson) 1363c4bf6374SJason M. Bills { 136495820184SJason M. Bills // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1365cd225da8SJason M. Bills // First get the Timestamp 1366f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1367cd225da8SJason M. Bills if (space == std::string::npos) 136895820184SJason M. Bills { 1369ac992cdeSJason M. Bills return LogParseError::parseFailed; 137095820184SJason M. Bills } 1371cd225da8SJason M. Bills std::string timestamp = logEntry.substr(0, space); 1372cd225da8SJason M. Bills // Then get the log contents 1373f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1374cd225da8SJason M. Bills if (entryStart == std::string::npos) 1375cd225da8SJason M. Bills { 1376ac992cdeSJason M. Bills return LogParseError::parseFailed; 1377cd225da8SJason M. Bills } 1378cd225da8SJason M. Bills std::string_view entry(logEntry); 1379cd225da8SJason M. Bills entry.remove_prefix(entryStart); 1380cd225da8SJason M. Bills // Use split to separate the entry into its fields 1381cd225da8SJason M. Bills std::vector<std::string> logEntryFields; 138250ebd4afSEd Tanous bmcweb::split(logEntryFields, entry, ','); 1383cd225da8SJason M. Bills // We need at least a MessageId to be valid 13841e6deaf6SEd Tanous auto logEntryIter = logEntryFields.begin(); 13851e6deaf6SEd Tanous if (logEntryIter == logEntryFields.end()) 1386cd225da8SJason M. Bills { 1387ac992cdeSJason M. Bills return LogParseError::parseFailed; 1388cd225da8SJason M. Bills } 13891e6deaf6SEd Tanous std::string& messageID = *logEntryIter; 13904851d45dSJason M. Bills // Get the Message from the MessageRegistry 1391fffb8c1fSEd Tanous const registries::Message* message = registries::getMessage(messageID); 1392c4bf6374SJason M. Bills 13931e6deaf6SEd Tanous logEntryIter++; 139454417b02SSui Chen if (message == nullptr) 1395c4bf6374SJason M. Bills { 139662598e31SEd Tanous BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry); 1397ac992cdeSJason M. Bills return LogParseError::messageIdNotInRegistry; 1398c4bf6374SJason M. Bills } 1399c4bf6374SJason M. Bills 14001e6deaf6SEd Tanous std::vector<std::string_view> messageArgs(logEntryIter, 14011e6deaf6SEd Tanous logEntryFields.end()); 1402c05bba45SEd Tanous messageArgs.resize(message->numberOfArgs); 1403c05bba45SEd Tanous 1404bd79bce8SPatrick Williams std::string msg = 1405bd79bce8SPatrick Williams redfish::registries::fillMessageArgs(messageArgs, message->message); 14061e6deaf6SEd Tanous if (msg.empty()) 140715a86ff6SJason M. Bills { 14081e6deaf6SEd Tanous return LogParseError::parseFailed; 140915a86ff6SJason M. Bills } 14104851d45dSJason M. Bills 141195820184SJason M. Bills // Get the Created time from the timestamp. The log timestamp is in RFC3339 141295820184SJason M. Bills // format which matches the Redfish format except for the fractional seconds 141395820184SJason M. Bills // between the '.' and the '+', so just remove them. 1414f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 1415f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 141695820184SJason M. Bills if (dot != std::string::npos && plus != std::string::npos) 1417c4bf6374SJason M. Bills { 141895820184SJason M. Bills timestamp.erase(dot, plus - dot); 1419c4bf6374SJason M. Bills } 1420c4bf6374SJason M. Bills 1421c4bf6374SJason M. Bills // Fill in the log entry with the gathered data 14229c11a172SVijay Lobo logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1423ef4c65b7SEd Tanous logEntryJson["@odata.id"] = boost::urls::format( 1424253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}", 1425253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME, logEntryID); 142684afc48bSJason M. Bills logEntryJson["Name"] = "System Event Log Entry"; 142784afc48bSJason M. Bills logEntryJson["Id"] = logEntryID; 142884afc48bSJason M. Bills logEntryJson["Message"] = std::move(msg); 142984afc48bSJason M. Bills logEntryJson["MessageId"] = std::move(messageID); 143084afc48bSJason M. Bills logEntryJson["MessageArgs"] = messageArgs; 143184afc48bSJason M. Bills logEntryJson["EntryType"] = "Event"; 143284afc48bSJason M. Bills logEntryJson["Severity"] = message->messageSeverity; 143384afc48bSJason M. Bills logEntryJson["Created"] = std::move(timestamp); 1434ac992cdeSJason M. Bills return LogParseError::success; 1435c4bf6374SJason M. Bills } 1436c4bf6374SJason M. Bills 14377f3726a2SMyung Bae inline void fillEventLogLogEntryFromDbusLogEntry( 14387f3726a2SMyung Bae const DbusEventLogEntry& entry, nlohmann::json& objectToFillOut) 1439898f2aa2SEd Tanous { 1440898f2aa2SEd Tanous objectToFillOut["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 1441898f2aa2SEd Tanous objectToFillOut["@odata.id"] = boost::urls::format( 1442898f2aa2SEd Tanous "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}", 1443262dcc1cSAlexander Hansen BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(entry.Id)); 1444898f2aa2SEd Tanous objectToFillOut["Name"] = "System Event Log Entry"; 1445262dcc1cSAlexander Hansen objectToFillOut["Id"] = std::to_string(entry.Id); 1446262dcc1cSAlexander Hansen objectToFillOut["Message"] = entry.Message; 1447262dcc1cSAlexander Hansen objectToFillOut["Resolved"] = entry.Resolved; 1448262dcc1cSAlexander Hansen std::optional<bool> notifyAction = 1449262dcc1cSAlexander Hansen getProviderNotifyAction(entry.ServiceProviderNotify); 1450898f2aa2SEd Tanous if (notifyAction) 1451898f2aa2SEd Tanous { 1452898f2aa2SEd Tanous objectToFillOut["ServiceProviderNotified"] = *notifyAction; 1453898f2aa2SEd Tanous } 1454262dcc1cSAlexander Hansen if ((entry.Resolution != nullptr) && !entry.Resolution->empty()) 1455898f2aa2SEd Tanous { 1456262dcc1cSAlexander Hansen objectToFillOut["Resolution"] = *entry.Resolution; 1457898f2aa2SEd Tanous } 1458898f2aa2SEd Tanous objectToFillOut["EntryType"] = "Event"; 1459262dcc1cSAlexander Hansen objectToFillOut["Severity"] = 1460262dcc1cSAlexander Hansen translateSeverityDbusToRedfish(entry.Severity); 1461898f2aa2SEd Tanous objectToFillOut["Created"] = 1462262dcc1cSAlexander Hansen redfish::time_utils::getDateTimeUintMs(entry.Timestamp); 1463898f2aa2SEd Tanous objectToFillOut["Modified"] = 1464262dcc1cSAlexander Hansen redfish::time_utils::getDateTimeUintMs(entry.UpdateTimestamp); 1465262dcc1cSAlexander Hansen if (entry.Path != nullptr) 1466898f2aa2SEd Tanous { 1467898f2aa2SEd Tanous objectToFillOut["AdditionalDataURI"] = boost::urls::format( 1468898f2aa2SEd Tanous "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}/attachment", 1469262dcc1cSAlexander Hansen BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(entry.Id)); 1470898f2aa2SEd Tanous } 1471898f2aa2SEd Tanous } 1472898f2aa2SEd Tanous 1473b729096dSEd Tanous inline void afterLogEntriesGetManagedObjects( 1474b729096dSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1475b729096dSEd Tanous const boost::system::error_code& ec, 1476b729096dSEd Tanous const dbus::utility::ManagedObjectType& resp) 1477b729096dSEd Tanous { 1478b729096dSEd Tanous if (ec) 1479b729096dSEd Tanous { 1480b729096dSEd Tanous // TODO Handle for specific error code 1481b729096dSEd Tanous BMCWEB_LOG_ERROR("getLogEntriesIfaceData resp_handler got error {}", 1482b729096dSEd Tanous ec); 1483b729096dSEd Tanous messages::internalError(asyncResp->res); 1484b729096dSEd Tanous return; 1485b729096dSEd Tanous } 1486b729096dSEd Tanous nlohmann::json::array_t entriesArray; 1487b729096dSEd Tanous for (const auto& objectPath : resp) 1488b729096dSEd Tanous { 1489898f2aa2SEd Tanous dbus::utility::DBusPropertiesMap propsFlattened; 1490bd79bce8SPatrick Williams auto isEntry = 1491bd79bce8SPatrick Williams std::ranges::find_if(objectPath.second, [](const auto& object) { 1492898f2aa2SEd Tanous return object.first == "xyz.openbmc_project.Logging.Entry"; 1493898f2aa2SEd Tanous }); 1494898f2aa2SEd Tanous if (isEntry == objectPath.second.end()) 1495b729096dSEd Tanous { 1496b729096dSEd Tanous continue; 1497b729096dSEd Tanous } 14987f3726a2SMyung Bae 1499898f2aa2SEd Tanous for (const auto& interfaceMap : objectPath.second) 1500b729096dSEd Tanous { 1501898f2aa2SEd Tanous for (const auto& propertyMap : interfaceMap.second) 1502b729096dSEd Tanous { 1503898f2aa2SEd Tanous propsFlattened.emplace_back(propertyMap.first, 1504898f2aa2SEd Tanous propertyMap.second); 1505b729096dSEd Tanous } 1506b729096dSEd Tanous } 15077f3726a2SMyung Bae std::optional<DbusEventLogEntry> optEntry = 15087f3726a2SMyung Bae fillDbusEventLogEntryFromPropertyMap(propsFlattened); 15097f3726a2SMyung Bae 15107f3726a2SMyung Bae if (!optEntry.has_value()) 151190896601SIgor Kanyuka { 15127f3726a2SMyung Bae messages::internalError(asyncResp->res); 151390896601SIgor Kanyuka return; 151490896601SIgor Kanyuka } 15157f3726a2SMyung Bae fillEventLogLogEntryFromDbusLogEntry(*optEntry, 15167f3726a2SMyung Bae entriesArray.emplace_back()); 1517b729096dSEd Tanous } 1518898f2aa2SEd Tanous 151990896601SIgor Kanyuka redfish::json_util::sortJsonArrayByKey(entriesArray, "Id"); 1520b729096dSEd Tanous asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size(); 1521b729096dSEd Tanous asyncResp->res.jsonValue["Members"] = std::move(entriesArray); 1522b729096dSEd Tanous } 1523b729096dSEd Tanous 1524599b9af3SAlexander Hansen inline void handleSystemsLogServiceEventLogLogEntryCollection( 1525599b9af3SAlexander Hansen App& app, const crow::Request& req, 152622d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1527599b9af3SAlexander Hansen const std::string& systemName) 1528599b9af3SAlexander Hansen { 1529c937d2bfSEd Tanous query_param::QueryCapabilities capabilities = { 1530c937d2bfSEd Tanous .canDelegateTop = true, 1531c937d2bfSEd Tanous .canDelegateSkip = true, 1532c937d2bfSEd Tanous }; 1533c937d2bfSEd Tanous query_param::Query delegatedQuery; 1534599b9af3SAlexander Hansen if (!redfish::setUpRedfishRouteWithDelegation(app, req, asyncResp, 1535599b9af3SAlexander Hansen delegatedQuery, capabilities)) 1536c4bf6374SJason M. Bills { 1537c4bf6374SJason M. Bills return; 1538c4bf6374SJason M. Bills } 153925b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 15407f3e84a1SEd Tanous { 15417f3e84a1SEd Tanous // Option currently returns no systems. TBD 15427f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 15437f3e84a1SEd Tanous systemName); 15447f3e84a1SEd Tanous return; 15457f3e84a1SEd Tanous } 1546253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 154722d268cbSEd Tanous { 154822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 154922d268cbSEd Tanous systemName); 155022d268cbSEd Tanous return; 155122d268cbSEd Tanous } 155222d268cbSEd Tanous 15535143f7a5SJiaqing Zhao size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop); 15543648c8beSEd Tanous size_t skip = delegatedQuery.skip.value_or(0); 15553648c8beSEd Tanous 15567e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 15577e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1558c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 1559c4bf6374SJason M. Bills "#LogEntryCollection.LogEntryCollection"; 1560c4bf6374SJason M. Bills asyncResp->res.jsonValue["@odata.id"] = 1561253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries", 1562253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 1563c4bf6374SJason M. Bills asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1564c4bf6374SJason M. Bills asyncResp->res.jsonValue["Description"] = 1565c4bf6374SJason M. Bills "Collection of System Event Log Entries"; 1566cb92c03bSAndrew Geissler 15674978b63fSJason M. Bills nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; 1568c4bf6374SJason M. Bills logEntryArray = nlohmann::json::array(); 15697e860f15SJohn Edward Broadbent // Go through the log files and create a unique ID for each 15707e860f15SJohn Edward Broadbent // entry 157195820184SJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 157295820184SJason M. Bills getRedfishLogFiles(redfishLogFiles); 1573b01bf299SEd Tanous uint64_t entryCount = 0; 1574cd225da8SJason M. Bills std::string logEntry; 157595820184SJason M. Bills 15767e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 15777e860f15SJohn Edward Broadbent // backwards 1578599b9af3SAlexander Hansen for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++) 1579c4bf6374SJason M. Bills { 1580cd225da8SJason M. Bills std::ifstream logStream(*it); 158195820184SJason M. Bills if (!logStream.is_open()) 1582c4bf6374SJason M. Bills { 1583c4bf6374SJason M. Bills continue; 1584c4bf6374SJason M. Bills } 1585c4bf6374SJason M. Bills 1586e85d6b16SJason M. Bills // Reset the unique ID on the first entry 1587e85d6b16SJason M. Bills bool firstEntry = true; 158895820184SJason M. Bills while (std::getline(logStream, logEntry)) 158995820184SJason M. Bills { 1590c4bf6374SJason M. Bills std::string idStr; 1591e85d6b16SJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1592c4bf6374SJason M. Bills { 1593c4bf6374SJason M. Bills continue; 1594c4bf6374SJason M. Bills } 1595e85d6b16SJason M. Bills firstEntry = false; 1596e85d6b16SJason M. Bills 1597de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1598bd79bce8SPatrick Williams LogParseError status = 1599bd79bce8SPatrick Williams fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1600ac992cdeSJason M. Bills if (status == LogParseError::messageIdNotInRegistry) 1601ac992cdeSJason M. Bills { 1602ac992cdeSJason M. Bills continue; 1603ac992cdeSJason M. Bills } 1604ac992cdeSJason M. Bills if (status != LogParseError::success) 1605c4bf6374SJason M. Bills { 1606c4bf6374SJason M. Bills messages::internalError(asyncResp->res); 1607c4bf6374SJason M. Bills return; 1608c4bf6374SJason M. Bills } 1609de703c5dSJason M. Bills 1610de703c5dSJason M. Bills entryCount++; 1611de703c5dSJason M. Bills // Handle paging using skip (number of entries to skip from the 1612de703c5dSJason M. Bills // start) and top (number of entries to display) 16133648c8beSEd Tanous if (entryCount <= skip || entryCount > skip + top) 1614de703c5dSJason M. Bills { 1615de703c5dSJason M. Bills continue; 1616de703c5dSJason M. Bills } 1617de703c5dSJason M. Bills 1618b2ba3072SPatrick Williams logEntryArray.emplace_back(std::move(bmcLogEntry)); 1619c4bf6374SJason M. Bills } 162095820184SJason M. Bills } 1621c4bf6374SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = entryCount; 16223648c8beSEd Tanous if (skip + top < entryCount) 1623c4bf6374SJason M. Bills { 1624599b9af3SAlexander Hansen asyncResp->res.jsonValue["Members@odata.nextLink"] = 1625599b9af3SAlexander Hansen boost::urls::format( 1626253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/EventLog/Entries?$skip={}", 1627253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(skip + top)); 1628c4bf6374SJason M. Bills } 1629897967deSJason M. Bills } 1630897967deSJason M. Bills 1631599b9af3SAlexander Hansen inline void requestRoutesJournalEventLogEntryCollection(App& app) 1632897967deSJason M. Bills { 1633599b9af3SAlexander Hansen BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 1634599b9af3SAlexander Hansen .privileges(redfish::privileges::getLogEntryCollection) 1635599b9af3SAlexander Hansen .methods(boost::beast::http::verb::get)(std::bind_front( 1636599b9af3SAlexander Hansen handleSystemsLogServiceEventLogLogEntryCollection, std::ref(app))); 1637599b9af3SAlexander Hansen } 1638599b9af3SAlexander Hansen 1639599b9af3SAlexander Hansen inline void handleSystemsLogServiceEventLogEntriesGet( 1640599b9af3SAlexander Hansen App& app, const crow::Request& req, 16417e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1642599b9af3SAlexander Hansen const std::string& systemName, const std::string& param) 1643599b9af3SAlexander Hansen { 16443ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 164545ca1b86SEd Tanous { 164645ca1b86SEd Tanous return; 164745ca1b86SEd Tanous } 164825b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 16497f3e84a1SEd Tanous { 16507f3e84a1SEd Tanous // Option currently returns no systems. TBD 16517f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 16527f3e84a1SEd Tanous systemName); 16537f3e84a1SEd Tanous return; 16547f3e84a1SEd Tanous } 165522d268cbSEd Tanous 1656253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 165722d268cbSEd Tanous { 165822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 165922d268cbSEd Tanous systemName); 166022d268cbSEd Tanous return; 166122d268cbSEd Tanous } 166222d268cbSEd Tanous 16637e860f15SJohn Edward Broadbent const std::string& targetID = param; 16648d1b46d7Szhanghch05 16657e860f15SJohn Edward Broadbent // Go through the log files and check the unique ID for each 16667e860f15SJohn Edward Broadbent // entry to find the target entry 1667897967deSJason M. Bills std::vector<std::filesystem::path> redfishLogFiles; 1668897967deSJason M. Bills getRedfishLogFiles(redfishLogFiles); 1669897967deSJason M. Bills std::string logEntry; 1670897967deSJason M. Bills 16717e860f15SJohn Edward Broadbent // Oldest logs are in the last file, so start there and loop 16727e860f15SJohn Edward Broadbent // backwards 1673599b9af3SAlexander Hansen for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++) 1674897967deSJason M. Bills { 1675897967deSJason M. Bills std::ifstream logStream(*it); 1676897967deSJason M. Bills if (!logStream.is_open()) 1677897967deSJason M. Bills { 1678897967deSJason M. Bills continue; 1679897967deSJason M. Bills } 1680897967deSJason M. Bills 1681897967deSJason M. Bills // Reset the unique ID on the first entry 1682897967deSJason M. Bills bool firstEntry = true; 1683897967deSJason M. Bills while (std::getline(logStream, logEntry)) 1684897967deSJason M. Bills { 1685897967deSJason M. Bills std::string idStr; 1686897967deSJason M. Bills if (!getUniqueEntryID(logEntry, idStr, firstEntry)) 1687897967deSJason M. Bills { 1688897967deSJason M. Bills continue; 1689897967deSJason M. Bills } 1690897967deSJason M. Bills firstEntry = false; 1691897967deSJason M. Bills 1692897967deSJason M. Bills if (idStr == targetID) 1693897967deSJason M. Bills { 1694de703c5dSJason M. Bills nlohmann::json::object_t bmcLogEntry; 1695bd79bce8SPatrick Williams LogParseError status = 1696bd79bce8SPatrick Williams fillEventLogEntryJson(idStr, logEntry, bmcLogEntry); 1697ac992cdeSJason M. Bills if (status != LogParseError::success) 1698897967deSJason M. Bills { 1699897967deSJason M. Bills messages::internalError(asyncResp->res); 1700897967deSJason M. Bills return; 1701897967deSJason M. Bills } 1702d405bb51SJason M. Bills asyncResp->res.jsonValue.update(bmcLogEntry); 1703897967deSJason M. Bills return; 1704897967deSJason M. Bills } 1705897967deSJason M. Bills } 1706897967deSJason M. Bills } 1707897967deSJason M. Bills // Requested ID was not found 17089db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", targetID); 1709599b9af3SAlexander Hansen } 1710599b9af3SAlexander Hansen 1711599b9af3SAlexander Hansen inline void requestRoutesJournalEventLogEntry(App& app) 1712599b9af3SAlexander Hansen { 1713599b9af3SAlexander Hansen BMCWEB_ROUTE( 1714599b9af3SAlexander Hansen app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1715599b9af3SAlexander Hansen .privileges(redfish::privileges::getLogEntry) 1716599b9af3SAlexander Hansen .methods(boost::beast::http::verb::get)(std::bind_front( 1717599b9af3SAlexander Hansen handleSystemsLogServiceEventLogEntriesGet, std::ref(app))); 1718599b9af3SAlexander Hansen } 1719599b9af3SAlexander Hansen 1720599b9af3SAlexander Hansen inline void dBusEventLogEntryCollection( 1721599b9af3SAlexander Hansen const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 1722599b9af3SAlexander Hansen { 1723599b9af3SAlexander Hansen // Collections don't include the static data added by SubRoute 1724599b9af3SAlexander Hansen // because it has a duplicate entry for members 1725599b9af3SAlexander Hansen asyncResp->res.jsonValue["@odata.type"] = 1726599b9af3SAlexander Hansen "#LogEntryCollection.LogEntryCollection"; 1727599b9af3SAlexander Hansen asyncResp->res.jsonValue["@odata.id"] = 1728599b9af3SAlexander Hansen std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries", 1729599b9af3SAlexander Hansen BMCWEB_REDFISH_SYSTEM_URI_NAME); 1730599b9af3SAlexander Hansen asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; 1731599b9af3SAlexander Hansen asyncResp->res.jsonValue["Description"] = 1732599b9af3SAlexander Hansen "Collection of System Event Log Entries"; 1733599b9af3SAlexander Hansen 1734599b9af3SAlexander Hansen // DBus implementation of EventLog/Entries 1735599b9af3SAlexander Hansen // Make call to Logging Service to find all log entry objects 1736599b9af3SAlexander Hansen sdbusplus::message::object_path path("/xyz/openbmc_project/logging"); 1737599b9af3SAlexander Hansen dbus::utility::getManagedObjects( 1738599b9af3SAlexander Hansen "xyz.openbmc_project.Logging", path, 1739599b9af3SAlexander Hansen [asyncResp](const boost::system::error_code& ec, 1740599b9af3SAlexander Hansen const dbus::utility::ManagedObjectType& resp) { 1741b729096dSEd Tanous afterLogEntriesGetManagedObjects(asyncResp, ec, resp); 17427e860f15SJohn Edward Broadbent }); 174308a4e4b5SAnthony Wilson } 174408a4e4b5SAnthony Wilson 17457e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app) 174608a4e4b5SAnthony Wilson { 174722d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/") 1748ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 1749002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1750002d39b4SEd Tanous [&app](const crow::Request& req, 175122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 175222d268cbSEd Tanous const std::string& systemName) { 17533ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 175445ca1b86SEd Tanous { 175545ca1b86SEd Tanous return; 175645ca1b86SEd Tanous } 175725b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 17587f3e84a1SEd Tanous { 17597f3e84a1SEd Tanous // Option currently returns no systems. TBD 17607f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 17617f3e84a1SEd Tanous systemName); 17627f3e84a1SEd Tanous return; 17637f3e84a1SEd Tanous } 1764253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 176522d268cbSEd Tanous { 176622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 176722d268cbSEd Tanous systemName); 176822d268cbSEd Tanous return; 176922d268cbSEd Tanous } 1770599b9af3SAlexander Hansen dBusEventLogEntryCollection(asyncResp); 1771599b9af3SAlexander Hansen }); 1772599b9af3SAlexander Hansen } 177322d268cbSEd Tanous 1774c6b7cae2SMyung Bae inline void afterDBusEventLogEntryGet( 1775c6b7cae2SMyung Bae const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1776c6b7cae2SMyung Bae const std::string& entryID, const boost::system::error_code& ec, 1777c6b7cae2SMyung Bae const dbus::utility::DBusPropertiesMap& resp) 1778c6b7cae2SMyung Bae { 1779c6b7cae2SMyung Bae if (ec.value() == EBADR) 1780c6b7cae2SMyung Bae { 1781c6b7cae2SMyung Bae messages::resourceNotFound(asyncResp->res, "EventLogEntry", entryID); 1782c6b7cae2SMyung Bae return; 1783c6b7cae2SMyung Bae } 1784c6b7cae2SMyung Bae if (ec) 1785c6b7cae2SMyung Bae { 1786c6b7cae2SMyung Bae BMCWEB_LOG_ERROR("EventLogEntry (DBus) resp_handler got error {}", ec); 1787c6b7cae2SMyung Bae messages::internalError(asyncResp->res); 1788c6b7cae2SMyung Bae return; 1789c6b7cae2SMyung Bae } 1790c6b7cae2SMyung Bae 17917f3726a2SMyung Bae std::optional<DbusEventLogEntry> optEntry = 17927f3726a2SMyung Bae fillDbusEventLogEntryFromPropertyMap(resp); 17937f3726a2SMyung Bae 17947f3726a2SMyung Bae if (!optEntry.has_value()) 17957f3726a2SMyung Bae { 17967f3726a2SMyung Bae messages::internalError(asyncResp->res); 17977f3726a2SMyung Bae return; 17987f3726a2SMyung Bae } 17997f3726a2SMyung Bae 18007f3726a2SMyung Bae fillEventLogLogEntryFromDbusLogEntry(*optEntry, asyncResp->res.jsonValue); 1801c6b7cae2SMyung Bae } 1802c6b7cae2SMyung Bae 1803bd79bce8SPatrick Williams inline void dBusEventLogEntryGet( 1804bd79bce8SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, std::string entryID) 1805599b9af3SAlexander Hansen { 1806599b9af3SAlexander Hansen dbus::utility::escapePathForDbus(entryID); 180708a4e4b5SAnthony Wilson 1808cb92c03bSAndrew Geissler // DBus implementation of EventLog/Entries 1809cb92c03bSAndrew Geissler // Make call to Logging Service to find all log entry objects 1810deae6a78SEd Tanous dbus::utility::getAllProperties( 1811deae6a78SEd Tanous "xyz.openbmc_project.Logging", 1812599b9af3SAlexander Hansen "/xyz/openbmc_project/logging/entry/" + entryID, "", 1813c6b7cae2SMyung Bae std::bind_front(afterDBusEventLogEntryGet, asyncResp, entryID)); 18147e860f15SJohn Edward Broadbent } 1815599b9af3SAlexander Hansen 1816504af5a0SPatrick Williams inline void dBusEventLogEntryPatch( 1817504af5a0SPatrick Williams const crow::Request& req, 1818599b9af3SAlexander Hansen const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1819599b9af3SAlexander Hansen const std::string& entryId) 1820599b9af3SAlexander Hansen { 1821599b9af3SAlexander Hansen std::optional<bool> resolved; 1822599b9af3SAlexander Hansen 1823599b9af3SAlexander Hansen if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", resolved)) 1824599b9af3SAlexander Hansen { 1825599b9af3SAlexander Hansen return; 1826599b9af3SAlexander Hansen } 1827599b9af3SAlexander Hansen BMCWEB_LOG_DEBUG("Set Resolved"); 1828599b9af3SAlexander Hansen 1829599b9af3SAlexander Hansen setDbusProperty(asyncResp, "Resolved", "xyz.openbmc_project.Logging", 1830599b9af3SAlexander Hansen "/xyz/openbmc_project/logging/entry/" + entryId, 1831599b9af3SAlexander Hansen "xyz.openbmc_project.Logging.Entry", "Resolved", 1832599b9af3SAlexander Hansen resolved.value_or(false)); 1833599b9af3SAlexander Hansen } 1834599b9af3SAlexander Hansen 1835bd79bce8SPatrick Williams inline void dBusEventLogEntryDelete( 1836bd79bce8SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, std::string entryID) 1837599b9af3SAlexander Hansen { 1838599b9af3SAlexander Hansen BMCWEB_LOG_DEBUG("Do delete single event entries."); 1839599b9af3SAlexander Hansen 1840599b9af3SAlexander Hansen dbus::utility::escapePathForDbus(entryID); 1841599b9af3SAlexander Hansen 1842599b9af3SAlexander Hansen // Process response from Logging service. 1843599b9af3SAlexander Hansen auto respHandler = [asyncResp, 1844599b9af3SAlexander Hansen entryID](const boost::system::error_code& ec) { 1845599b9af3SAlexander Hansen BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done"); 1846599b9af3SAlexander Hansen if (ec) 1847599b9af3SAlexander Hansen { 1848599b9af3SAlexander Hansen if (ec.value() == EBADR) 1849599b9af3SAlexander Hansen { 1850599b9af3SAlexander Hansen messages::resourceNotFound(asyncResp->res, "LogEntry", entryID); 1851599b9af3SAlexander Hansen return; 1852599b9af3SAlexander Hansen } 1853599b9af3SAlexander Hansen // TODO Handle for specific error code 1854599b9af3SAlexander Hansen BMCWEB_LOG_ERROR( 1855599b9af3SAlexander Hansen "EventLogEntry (DBus) doDelete respHandler got error {}", ec); 1856599b9af3SAlexander Hansen asyncResp->res.result( 1857599b9af3SAlexander Hansen boost::beast::http::status::internal_server_error); 1858599b9af3SAlexander Hansen return; 1859599b9af3SAlexander Hansen } 1860599b9af3SAlexander Hansen 1861599b9af3SAlexander Hansen asyncResp->res.result(boost::beast::http::status::ok); 1862599b9af3SAlexander Hansen }; 1863599b9af3SAlexander Hansen 1864599b9af3SAlexander Hansen // Make call to Logging service to request Delete Log 1865177612aaSEd Tanous dbus::utility::async_method_call( 1866177612aaSEd Tanous asyncResp, respHandler, "xyz.openbmc_project.Logging", 1867599b9af3SAlexander Hansen "/xyz/openbmc_project/logging/entry/" + entryID, 1868599b9af3SAlexander Hansen "xyz.openbmc_project.Object.Delete", "Delete"); 18697e860f15SJohn Edward Broadbent } 18707e860f15SJohn Edward Broadbent 18717e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app) 18727e860f15SJohn Edward Broadbent { 18737e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 187422d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1875ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 1876002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 1877002d39b4SEd Tanous [&app](const crow::Request& req, 18787e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1879898f2aa2SEd Tanous const std::string& systemName, const std::string& entryId) { 18803ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 18817e860f15SJohn Edward Broadbent { 188245ca1b86SEd Tanous return; 188345ca1b86SEd Tanous } 188425b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 18857f3e84a1SEd Tanous { 18867f3e84a1SEd Tanous // Option currently returns no systems. TBD 18877f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 18887f3e84a1SEd Tanous systemName); 18897f3e84a1SEd Tanous return; 18907f3e84a1SEd Tanous } 1891253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 189222d268cbSEd Tanous { 189322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 189422d268cbSEd Tanous systemName); 189522d268cbSEd Tanous return; 189622d268cbSEd Tanous } 189722d268cbSEd Tanous 1898898f2aa2SEd Tanous dBusEventLogEntryGet(asyncResp, entryId); 18997e860f15SJohn Edward Broadbent }); 1900336e96c6SChicago Duan 19017e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 190222d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1903ed398213SEd Tanous .privileges(redfish::privileges::patchLogEntry) 19047e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::patch)( 190545ca1b86SEd Tanous [&app](const crow::Request& req, 19067e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 190722d268cbSEd Tanous const std::string& systemName, const std::string& entryId) { 19083ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 190945ca1b86SEd Tanous { 191045ca1b86SEd Tanous return; 191145ca1b86SEd Tanous } 191225b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 19137f3e84a1SEd Tanous { 19147f3e84a1SEd Tanous // Option currently returns no systems. TBD 19157f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 19167f3e84a1SEd Tanous systemName); 19177f3e84a1SEd Tanous return; 19187f3e84a1SEd Tanous } 1919253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 192022d268cbSEd Tanous { 192122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 192222d268cbSEd Tanous systemName); 192322d268cbSEd Tanous return; 192422d268cbSEd Tanous } 192575710de2SXiaochao Ma 1926599b9af3SAlexander Hansen dBusEventLogEntryPatch(req, asyncResp, entryId); 19277e860f15SJohn Edward Broadbent }); 192875710de2SXiaochao Ma 19297e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 193022d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/") 1931fff6a4d3SAbhishek Patel .privileges( 1932fff6a4d3SAbhishek Patel redfish::privileges:: 1933fff6a4d3SAbhishek Patel deleteLogEntrySubOverComputerSystemLogServiceCollectionLogServiceLogEntryCollection) 1934002d39b4SEd Tanous .methods(boost::beast::http::verb::delete_)( 1935002d39b4SEd Tanous [&app](const crow::Request& req, 1936002d39b4SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 193722d268cbSEd Tanous const std::string& systemName, const std::string& param) { 19383ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 1939336e96c6SChicago Duan { 194045ca1b86SEd Tanous return; 194145ca1b86SEd Tanous } 194225b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 19437f3e84a1SEd Tanous { 19447f3e84a1SEd Tanous // Option currently returns no systems. TBD 19457f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 19467f3e84a1SEd Tanous systemName); 19477f3e84a1SEd Tanous return; 19487f3e84a1SEd Tanous } 1949253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 195022d268cbSEd Tanous { 195122d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 195222d268cbSEd Tanous systemName); 195322d268cbSEd Tanous return; 195422d268cbSEd Tanous } 1955599b9af3SAlexander Hansen dBusEventLogEntryDelete(asyncResp, param); 19567e860f15SJohn Edward Broadbent }); 1957400fd1fbSAdriana Kobylak } 1958400fd1fbSAdriana Kobylak 1959dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet( 1960fdd26906SClaire Weinan crow::App& app, const crow::Request& req, 1961253f11b8SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1962253f11b8SEd Tanous const std::string& managerId) 19631da66f75SEd Tanous { 19643ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 196545ca1b86SEd Tanous { 196645ca1b86SEd Tanous return; 196745ca1b86SEd Tanous } 1968253f11b8SEd Tanous 1969253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 1970253f11b8SEd Tanous { 1971253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 1972253f11b8SEd Tanous return; 1973253f11b8SEd Tanous } 1974253f11b8SEd Tanous 19757e860f15SJohn Edward Broadbent // Collections don't include the static data added by SubRoute 19767e860f15SJohn Edward Broadbent // because it has a duplicate entry for members 1977e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 19781da66f75SEd Tanous "#LogServiceCollection.LogServiceCollection"; 1979253f11b8SEd Tanous asyncResp->res.jsonValue["@odata.id"] = boost::urls::format( 1980253f11b8SEd Tanous "/redfish/v1/Managers/{}/LogServices", BMCWEB_REDFISH_MANAGER_URI_NAME); 1981002d39b4SEd Tanous asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; 1982e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 19831da66f75SEd Tanous "Collection of LogServices for this Manager"; 1984002d39b4SEd Tanous nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; 1985c4bf6374SJason M. Bills logServiceArray = nlohmann::json::array(); 1986fdd26906SClaire Weinan 198725b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_BMC_JOURNAL) 198825b54dbaSEd Tanous { 1989613dabeaSEd Tanous nlohmann::json::object_t journal; 1990253f11b8SEd Tanous journal["@odata.id"] = 1991253f11b8SEd Tanous boost::urls::format("/redfish/v1/Managers/{}/LogServices/Journal", 1992253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 1993b2ba3072SPatrick Williams logServiceArray.emplace_back(std::move(journal)); 199425b54dbaSEd Tanous } 1995fdd26906SClaire Weinan 1996fdd26906SClaire Weinan asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size(); 1997fdd26906SClaire Weinan 199825b54dbaSEd Tanous if constexpr (BMCWEB_REDFISH_DUMP_LOG) 199925b54dbaSEd Tanous { 200015912159SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 20017a1dbc48SGeorge Liu "xyz.openbmc_project.Collection.DeleteAll"}; 20027a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 20037a1dbc48SGeorge Liu "/xyz/openbmc_project/dump", 0, interfaces, 200425b54dbaSEd Tanous [asyncResp](const boost::system::error_code& ec, 200525b54dbaSEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& 200625b54dbaSEd Tanous subTreePaths) { 2007fdd26906SClaire Weinan if (ec) 2008fdd26906SClaire Weinan { 200962598e31SEd Tanous BMCWEB_LOG_ERROR( 201062598e31SEd Tanous "handleBMCLogServicesCollectionGet respHandler got error {}", 201162598e31SEd Tanous ec); 2012bd79bce8SPatrick Williams // Assume that getting an error simply means there are no 2013bd79bce8SPatrick Williams // dump LogServices. Return without adding any error 2014bd79bce8SPatrick Williams // response. 2015fdd26906SClaire Weinan return; 2016fdd26906SClaire Weinan } 2017fdd26906SClaire Weinan 2018fdd26906SClaire Weinan nlohmann::json& logServiceArrayLocal = 2019fdd26906SClaire Weinan asyncResp->res.jsonValue["Members"]; 2020fdd26906SClaire Weinan 2021fdd26906SClaire Weinan for (const std::string& path : subTreePaths) 2022fdd26906SClaire Weinan { 2023fdd26906SClaire Weinan if (path == "/xyz/openbmc_project/dump/bmc") 2024fdd26906SClaire Weinan { 2025613dabeaSEd Tanous nlohmann::json::object_t member; 2026253f11b8SEd Tanous member["@odata.id"] = boost::urls::format( 2027253f11b8SEd Tanous "/redfish/v1/Managers/{}/LogServices/Dump", 2028253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 2029b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2030fdd26906SClaire Weinan } 2031fdd26906SClaire Weinan else if (path == "/xyz/openbmc_project/dump/faultlog") 2032fdd26906SClaire Weinan { 2033613dabeaSEd Tanous nlohmann::json::object_t member; 2034253f11b8SEd Tanous member["@odata.id"] = boost::urls::format( 2035253f11b8SEd Tanous "/redfish/v1/Managers/{}/LogServices/FaultLog", 2036253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 2037b2ba3072SPatrick Williams logServiceArrayLocal.emplace_back(std::move(member)); 2038fdd26906SClaire Weinan } 2039fdd26906SClaire Weinan } 2040fdd26906SClaire Weinan 2041e1f26343SJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 2042fdd26906SClaire Weinan logServiceArrayLocal.size(); 20437a1dbc48SGeorge Liu }); 204425b54dbaSEd Tanous } 2045fdd26906SClaire Weinan } 2046fdd26906SClaire Weinan 2047fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app) 2048fdd26906SClaire Weinan { 2049253f11b8SEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/") 2050fdd26906SClaire Weinan .privileges(redfish::privileges::getLogServiceCollection) 2051fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2052dd72e87bSClaire Weinan std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app))); 2053e1f26343SJason M. Bills } 2054e1f26343SJason M. Bills 2055504af5a0SPatrick Williams inline void getDumpServiceInfo( 2056504af5a0SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2057fdd26906SClaire Weinan const std::string& dumpType) 2058c9bb6861Sraviteja-b { 2059fdd26906SClaire Weinan std::string dumpPath; 2060539d8c6bSEd Tanous log_service::OverWritePolicy overWritePolicy = 2061539d8c6bSEd Tanous log_service::OverWritePolicy::Invalid; 2062fdd26906SClaire Weinan bool collectDiagnosticDataSupported = false; 2063fdd26906SClaire Weinan 2064fdd26906SClaire Weinan if (dumpType == "BMC") 206545ca1b86SEd Tanous { 2066253f11b8SEd Tanous dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/Dump", 2067253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 2068539d8c6bSEd Tanous overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull; 2069fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2070fdd26906SClaire Weinan } 2071fdd26906SClaire Weinan else if (dumpType == "FaultLog") 2072fdd26906SClaire Weinan { 2073253f11b8SEd Tanous dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/FaultLog", 2074253f11b8SEd Tanous BMCWEB_REDFISH_MANAGER_URI_NAME); 2075539d8c6bSEd Tanous overWritePolicy = log_service::OverWritePolicy::Unknown; 2076fdd26906SClaire Weinan collectDiagnosticDataSupported = false; 2077fdd26906SClaire Weinan } 2078fdd26906SClaire Weinan else if (dumpType == "System") 2079fdd26906SClaire Weinan { 2080253f11b8SEd Tanous dumpPath = std::format("/redfish/v1/Systems/{}/LogServices/Dump", 2081253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 2082539d8c6bSEd Tanous overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull; 2083fdd26906SClaire Weinan collectDiagnosticDataSupported = true; 2084fdd26906SClaire Weinan } 2085fdd26906SClaire Weinan else 2086fdd26906SClaire Weinan { 208762598e31SEd Tanous BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}", 208862598e31SEd Tanous dumpType); 2089fdd26906SClaire Weinan messages::internalError(asyncResp->res); 209045ca1b86SEd Tanous return; 209145ca1b86SEd Tanous } 2092fdd26906SClaire Weinan 2093fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.id"] = dumpPath; 2094fdd26906SClaire Weinan asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService"; 2095c9bb6861Sraviteja-b asyncResp->res.jsonValue["Name"] = "Dump LogService"; 2096fdd26906SClaire Weinan asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService"; 2097fdd26906SClaire Weinan asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename(); 2098539d8c6bSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = overWritePolicy; 20997c8c4058STejas Patil 21007c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 21012b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 21020fda0f12SGeorge Liu asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 21037c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 21047c8c4058STejas Patil redfishDateTimeOffset.second; 21057c8c4058STejas Patil 2106fdd26906SClaire Weinan asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries"; 2107fdd26906SClaire Weinan 2108fdd26906SClaire Weinan if (collectDiagnosticDataSupported) 2109fdd26906SClaire Weinan { 2110002d39b4SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 21111476687dSEd Tanous ["target"] = 2112fdd26906SClaire Weinan dumpPath + "/Actions/LogService.CollectDiagnosticData"; 2113fdd26906SClaire Weinan } 21140d946211SClaire Weinan 21150d946211SClaire Weinan constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface}; 21160d946211SClaire Weinan dbus::utility::getSubTreePaths( 21170d946211SClaire Weinan "/xyz/openbmc_project/dump", 0, interfaces, 21180d946211SClaire Weinan [asyncResp, dumpType, dumpPath]( 21190d946211SClaire Weinan const boost::system::error_code& ec, 21200d946211SClaire Weinan const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) { 21210d946211SClaire Weinan if (ec) 21220d946211SClaire Weinan { 2123bd79bce8SPatrick Williams BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", 2124bd79bce8SPatrick Williams ec); 21250d946211SClaire Weinan // Assume that getting an error simply means there are no dump 21260d946211SClaire Weinan // LogServices. Return without adding any error response. 21270d946211SClaire Weinan return; 21280d946211SClaire Weinan } 212918f8f608SEd Tanous std::string dbusDumpPath = getDumpPath(dumpType); 21300d946211SClaire Weinan for (const std::string& path : subTreePaths) 21310d946211SClaire Weinan { 21320d946211SClaire Weinan if (path == dbusDumpPath) 21330d946211SClaire Weinan { 2134bd79bce8SPatrick Williams asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] 2135bd79bce8SPatrick Williams ["target"] = 21360d946211SClaire Weinan dumpPath + "/Actions/LogService.ClearLog"; 21370d946211SClaire Weinan break; 21380d946211SClaire Weinan } 21390d946211SClaire Weinan } 21400d946211SClaire Weinan }); 2141c9bb6861Sraviteja-b } 2142c9bb6861Sraviteja-b 2143fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet( 2144fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2145253f11b8SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2146253f11b8SEd Tanous const std::string& managerId) 21477e860f15SJohn Edward Broadbent { 21483ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 214945ca1b86SEd Tanous { 215045ca1b86SEd Tanous return; 215145ca1b86SEd Tanous } 2152253f11b8SEd Tanous 2153253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 2154253f11b8SEd Tanous { 2155253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 2156253f11b8SEd Tanous return; 2157253f11b8SEd Tanous } 2158253f11b8SEd Tanous 2159fdd26906SClaire Weinan getDumpServiceInfo(asyncResp, dumpType); 2160fdd26906SClaire Weinan } 2161c9bb6861Sraviteja-b 216222d268cbSEd Tanous inline void handleLogServicesDumpServiceComputerSystemGet( 216322d268cbSEd Tanous crow::App& app, const crow::Request& req, 216422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 216522d268cbSEd Tanous const std::string& chassisId) 216622d268cbSEd Tanous { 216722d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 216822d268cbSEd Tanous { 216922d268cbSEd Tanous return; 217022d268cbSEd Tanous } 2171253f11b8SEd Tanous if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME) 217222d268cbSEd Tanous { 217322d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 217422d268cbSEd Tanous return; 217522d268cbSEd Tanous } 217622d268cbSEd Tanous getDumpServiceInfo(asyncResp, "System"); 217722d268cbSEd Tanous } 217822d268cbSEd Tanous 2179fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet( 2180fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2181253f11b8SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2182253f11b8SEd Tanous const std::string& managerId) 2183fdd26906SClaire Weinan { 2184fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2185fdd26906SClaire Weinan { 2186fdd26906SClaire Weinan return; 2187fdd26906SClaire Weinan } 2188253f11b8SEd Tanous 2189253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 2190253f11b8SEd Tanous { 2191253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 2192253f11b8SEd Tanous return; 2193253f11b8SEd Tanous } 2194fdd26906SClaire Weinan getDumpEntryCollection(asyncResp, dumpType); 2195fdd26906SClaire Weinan } 2196fdd26906SClaire Weinan 219722d268cbSEd Tanous inline void handleLogServicesDumpEntriesCollectionComputerSystemGet( 219822d268cbSEd Tanous crow::App& app, const crow::Request& req, 219922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 220022d268cbSEd Tanous const std::string& chassisId) 220122d268cbSEd Tanous { 220222d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 220322d268cbSEd Tanous { 220422d268cbSEd Tanous return; 220522d268cbSEd Tanous } 2206253f11b8SEd Tanous if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME) 220722d268cbSEd Tanous { 220822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 220922d268cbSEd Tanous return; 221022d268cbSEd Tanous } 221122d268cbSEd Tanous getDumpEntryCollection(asyncResp, "System"); 221222d268cbSEd Tanous } 221322d268cbSEd Tanous 2214fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet( 2215fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2216fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2217253f11b8SEd Tanous const std::string& managerId, const std::string& dumpId) 2218fdd26906SClaire Weinan { 2219fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2220fdd26906SClaire Weinan { 2221fdd26906SClaire Weinan return; 2222fdd26906SClaire Weinan } 2223253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 2224253f11b8SEd Tanous { 2225253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 2226253f11b8SEd Tanous return; 2227253f11b8SEd Tanous } 2228fdd26906SClaire Weinan getDumpEntryById(asyncResp, dumpId, dumpType); 2229fdd26906SClaire Weinan } 2230168d1b1aSCarson Labrado 223122d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemGet( 223222d268cbSEd Tanous crow::App& app, const crow::Request& req, 223322d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 223422d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 223522d268cbSEd Tanous { 223622d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 223722d268cbSEd Tanous { 223822d268cbSEd Tanous return; 223922d268cbSEd Tanous } 2240253f11b8SEd Tanous if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME) 224122d268cbSEd Tanous { 224222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 224322d268cbSEd Tanous return; 224422d268cbSEd Tanous } 224522d268cbSEd Tanous getDumpEntryById(asyncResp, dumpId, "System"); 224622d268cbSEd Tanous } 2247fdd26906SClaire Weinan 2248fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete( 2249fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2250fdd26906SClaire Weinan const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2251253f11b8SEd Tanous const std::string& managerId, const std::string& dumpId) 2252fdd26906SClaire Weinan { 2253fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2254fdd26906SClaire Weinan { 2255fdd26906SClaire Weinan return; 2256fdd26906SClaire Weinan } 2257253f11b8SEd Tanous 2258253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 2259253f11b8SEd Tanous { 2260253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 2261253f11b8SEd Tanous return; 2262253f11b8SEd Tanous } 2263fdd26906SClaire Weinan deleteDumpEntry(asyncResp, dumpId, dumpType); 2264fdd26906SClaire Weinan } 2265fdd26906SClaire Weinan 226622d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemDelete( 226722d268cbSEd Tanous crow::App& app, const crow::Request& req, 226822d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 226922d268cbSEd Tanous const std::string& chassisId, const std::string& dumpId) 227022d268cbSEd Tanous { 227122d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 227222d268cbSEd Tanous { 227322d268cbSEd Tanous return; 227422d268cbSEd Tanous } 2275253f11b8SEd Tanous if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME) 227622d268cbSEd Tanous { 227722d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId); 227822d268cbSEd Tanous return; 227922d268cbSEd Tanous } 228022d268cbSEd Tanous deleteDumpEntry(asyncResp, dumpId, "System"); 228122d268cbSEd Tanous } 228222d268cbSEd Tanous 2283168d1b1aSCarson Labrado inline void handleLogServicesDumpEntryDownloadGet( 2284168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2285168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2286253f11b8SEd Tanous const std::string& managerId, const std::string& dumpId) 2287168d1b1aSCarson Labrado { 2288168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2289168d1b1aSCarson Labrado { 2290168d1b1aSCarson Labrado return; 2291168d1b1aSCarson Labrado } 2292253f11b8SEd Tanous 2293253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 2294253f11b8SEd Tanous { 2295253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 2296253f11b8SEd Tanous return; 2297253f11b8SEd Tanous } 2298168d1b1aSCarson Labrado downloadDumpEntry(asyncResp, dumpId, dumpType); 2299168d1b1aSCarson Labrado } 2300168d1b1aSCarson Labrado 2301168d1b1aSCarson Labrado inline void handleDBusEventLogEntryDownloadGet( 2302168d1b1aSCarson Labrado crow::App& app, const std::string& dumpType, const crow::Request& req, 2303168d1b1aSCarson Labrado const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2304168d1b1aSCarson Labrado const std::string& systemName, const std::string& entryID) 2305168d1b1aSCarson Labrado { 2306168d1b1aSCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2307168d1b1aSCarson Labrado { 2308168d1b1aSCarson Labrado return; 2309168d1b1aSCarson Labrado } 2310168d1b1aSCarson Labrado if (!http_helpers::isContentTypeAllowed( 2311168d1b1aSCarson Labrado req.getHeaderValue("Accept"), 2312168d1b1aSCarson Labrado http_helpers::ContentType::OctetStream, true)) 2313168d1b1aSCarson Labrado { 2314168d1b1aSCarson Labrado asyncResp->res.result(boost::beast::http::status::bad_request); 2315168d1b1aSCarson Labrado return; 2316168d1b1aSCarson Labrado } 2317168d1b1aSCarson Labrado downloadEventLogEntry(asyncResp, systemName, entryID, dumpType); 2318168d1b1aSCarson Labrado } 2319168d1b1aSCarson Labrado 2320fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost( 2321fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2322253f11b8SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2323253f11b8SEd Tanous const std::string& managerId) 2324fdd26906SClaire Weinan { 2325fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2326fdd26906SClaire Weinan { 2327fdd26906SClaire Weinan return; 2328fdd26906SClaire Weinan } 2329253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 2330253f11b8SEd Tanous { 2331253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 2332253f11b8SEd Tanous return; 2333253f11b8SEd Tanous } 2334253f11b8SEd Tanous 2335fdd26906SClaire Weinan createDump(asyncResp, req, dumpType); 2336fdd26906SClaire Weinan } 2337fdd26906SClaire Weinan 233822d268cbSEd Tanous inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost( 233922d268cbSEd Tanous crow::App& app, const crow::Request& req, 234022d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 23417f3e84a1SEd Tanous const std::string& systemName) 234222d268cbSEd Tanous { 234322d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 234422d268cbSEd Tanous { 234522d268cbSEd Tanous return; 234622d268cbSEd Tanous } 23477f3e84a1SEd Tanous 234825b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 234922d268cbSEd Tanous { 23507f3e84a1SEd Tanous // Option currently returns no systems. TBD 23517f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 23527f3e84a1SEd Tanous systemName); 23537f3e84a1SEd Tanous return; 23547f3e84a1SEd Tanous } 2355253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 23567f3e84a1SEd Tanous { 23577f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 23587f3e84a1SEd Tanous systemName); 235922d268cbSEd Tanous return; 236022d268cbSEd Tanous } 236122d268cbSEd Tanous createDump(asyncResp, req, "System"); 236222d268cbSEd Tanous } 236322d268cbSEd Tanous 2364fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost( 2365fdd26906SClaire Weinan crow::App& app, const std::string& dumpType, const crow::Request& req, 2366253f11b8SEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 2367253f11b8SEd Tanous const std::string& managerId) 2368fdd26906SClaire Weinan { 2369fdd26906SClaire Weinan if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 2370fdd26906SClaire Weinan { 2371fdd26906SClaire Weinan return; 2372fdd26906SClaire Weinan } 2373253f11b8SEd Tanous 2374253f11b8SEd Tanous if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME) 2375253f11b8SEd Tanous { 2376253f11b8SEd Tanous messages::resourceNotFound(asyncResp->res, "Manager", managerId); 2377253f11b8SEd Tanous return; 2378253f11b8SEd Tanous } 2379fdd26906SClaire Weinan clearDump(asyncResp, dumpType); 2380fdd26906SClaire Weinan } 2381fdd26906SClaire Weinan 238222d268cbSEd Tanous inline void handleLogServicesDumpClearLogComputerSystemPost( 238322d268cbSEd Tanous crow::App& app, const crow::Request& req, 238422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 23857f3e84a1SEd Tanous const std::string& systemName) 238622d268cbSEd Tanous { 238722d268cbSEd Tanous if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 238822d268cbSEd Tanous { 238922d268cbSEd Tanous return; 239022d268cbSEd Tanous } 239125b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 239222d268cbSEd Tanous { 23937f3e84a1SEd Tanous // Option currently returns no systems. TBD 23947f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 23957f3e84a1SEd Tanous systemName); 23967f3e84a1SEd Tanous return; 23977f3e84a1SEd Tanous } 2398253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 23997f3e84a1SEd Tanous { 24007f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 24017f3e84a1SEd Tanous systemName); 240222d268cbSEd Tanous return; 240322d268cbSEd Tanous } 240422d268cbSEd Tanous clearDump(asyncResp, "System"); 240522d268cbSEd Tanous } 240622d268cbSEd Tanous 2407fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app) 2408fdd26906SClaire Weinan { 2409253f11b8SEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/") 2410fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2411fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2412fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "BMC")); 2413fdd26906SClaire Weinan } 2414fdd26906SClaire Weinan 2415fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app) 2416fdd26906SClaire Weinan { 2417253f11b8SEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/") 2418fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2419fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2420fdd26906SClaire Weinan handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC")); 2421c9bb6861Sraviteja-b } 2422c9bb6861Sraviteja-b 24237e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app) 2424c9bb6861Sraviteja-b { 24257e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2426253f11b8SEd Tanous "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/") 2427ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 2428fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2429fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "BMC")); 2430fdd26906SClaire Weinan 24317e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 2432253f11b8SEd Tanous "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/") 2433ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 2434fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2435fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "BMC")); 2436c9bb6861Sraviteja-b } 2437c9bb6861Sraviteja-b 2438168d1b1aSCarson Labrado inline void requestRoutesBMCDumpEntryDownload(App& app) 2439168d1b1aSCarson Labrado { 2440168d1b1aSCarson Labrado BMCWEB_ROUTE( 2441168d1b1aSCarson Labrado app, 2442253f11b8SEd Tanous "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/attachment/") 2443168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 2444168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 2445168d1b1aSCarson Labrado handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC")); 2446168d1b1aSCarson Labrado } 2447168d1b1aSCarson Labrado 24487e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app) 2449c9bb6861Sraviteja-b { 24500fda0f12SGeorge Liu BMCWEB_ROUTE( 24510fda0f12SGeorge Liu app, 2452253f11b8SEd Tanous "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2453ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 24547e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 2455fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost, 2456fdd26906SClaire Weinan std::ref(app), "BMC")); 2457a43be80fSAsmitha Karunanithi } 2458a43be80fSAsmitha Karunanithi 24597e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app) 246080319af1SAsmitha Karunanithi { 24610fda0f12SGeorge Liu BMCWEB_ROUTE( 24620fda0f12SGeorge Liu app, 2463253f11b8SEd Tanous "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.ClearLog/") 2464ed398213SEd Tanous .privileges(redfish::privileges::postLogService) 2465fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2466fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "BMC")); 246745ca1b86SEd Tanous } 2468fdd26906SClaire Weinan 2469168d1b1aSCarson Labrado inline void requestRoutesDBusEventLogEntryDownload(App& app) 2470168d1b1aSCarson Labrado { 2471168d1b1aSCarson Labrado BMCWEB_ROUTE( 2472168d1b1aSCarson Labrado app, 24739e9d99daSRavi Teja "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/") 2474168d1b1aSCarson Labrado .privileges(redfish::privileges::getLogEntry) 2475168d1b1aSCarson Labrado .methods(boost::beast::http::verb::get)(std::bind_front( 2476168d1b1aSCarson Labrado handleDBusEventLogEntryDownloadGet, std::ref(app), "System")); 2477168d1b1aSCarson Labrado } 2478168d1b1aSCarson Labrado 2479fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app) 2480fdd26906SClaire Weinan { 2481253f11b8SEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/") 2482fdd26906SClaire Weinan .privileges(redfish::privileges::getLogService) 2483fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2484fdd26906SClaire Weinan handleLogServicesDumpServiceGet, std::ref(app), "FaultLog")); 2485fdd26906SClaire Weinan } 2486fdd26906SClaire Weinan 2487fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app) 2488fdd26906SClaire Weinan { 2489253f11b8SEd Tanous BMCWEB_ROUTE(app, 2490253f11b8SEd Tanous "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/") 2491fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntryCollection) 2492fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)( 2493fdd26906SClaire Weinan std::bind_front(handleLogServicesDumpEntriesCollectionGet, 2494fdd26906SClaire Weinan std::ref(app), "FaultLog")); 2495fdd26906SClaire Weinan } 2496fdd26906SClaire Weinan 2497fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app) 2498fdd26906SClaire Weinan { 2499253f11b8SEd Tanous BMCWEB_ROUTE( 2500253f11b8SEd Tanous app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/") 2501fdd26906SClaire Weinan .privileges(redfish::privileges::getLogEntry) 2502fdd26906SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 2503fdd26906SClaire Weinan handleLogServicesDumpEntryGet, std::ref(app), "FaultLog")); 2504fdd26906SClaire Weinan 2505253f11b8SEd Tanous BMCWEB_ROUTE( 2506253f11b8SEd Tanous app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/") 2507fdd26906SClaire Weinan .privileges(redfish::privileges::deleteLogEntry) 2508fdd26906SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 2509fdd26906SClaire Weinan handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog")); 2510fdd26906SClaire Weinan } 2511fdd26906SClaire Weinan 2512fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app) 2513fdd26906SClaire Weinan { 2514fdd26906SClaire Weinan BMCWEB_ROUTE( 2515fdd26906SClaire Weinan app, 2516253f11b8SEd Tanous "/redfish/v1/Managers/<str>/LogServices/FaultLog/Actions/LogService.ClearLog/") 2517fdd26906SClaire Weinan .privileges(redfish::privileges::postLogService) 2518fdd26906SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 2519fdd26906SClaire Weinan handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog")); 25205cb1dd27SAsmitha Karunanithi } 25215cb1dd27SAsmitha Karunanithi 25227e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app) 25235cb1dd27SAsmitha Karunanithi { 252422d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/") 2525ed398213SEd Tanous .privileges(redfish::privileges::getLogService) 25266ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 252722d268cbSEd Tanous handleLogServicesDumpServiceComputerSystemGet, std::ref(app))); 25285cb1dd27SAsmitha Karunanithi } 25295cb1dd27SAsmitha Karunanithi 25307e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app) 25317e860f15SJohn Edward Broadbent { 253222d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/") 2533ed398213SEd Tanous .privileges(redfish::privileges::getLogEntryCollection) 253422d268cbSEd Tanous .methods(boost::beast::http::verb::get)(std::bind_front( 253522d268cbSEd Tanous handleLogServicesDumpEntriesCollectionComputerSystemGet, 253622d268cbSEd Tanous std::ref(app))); 25375cb1dd27SAsmitha Karunanithi } 25385cb1dd27SAsmitha Karunanithi 25397e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app) 25405cb1dd27SAsmitha Karunanithi { 25417e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 254222d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 2543ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 25446ab9ad54SClaire Weinan .methods(boost::beast::http::verb::get)(std::bind_front( 254522d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemGet, std::ref(app))); 25468d1b46d7Szhanghch05 25477e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 254822d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/") 2549ed398213SEd Tanous .privileges(redfish::privileges::deleteLogEntry) 25506ab9ad54SClaire Weinan .methods(boost::beast::http::verb::delete_)(std::bind_front( 255122d268cbSEd Tanous handleLogServicesDumpEntryComputerSystemDelete, std::ref(app))); 25525cb1dd27SAsmitha Karunanithi } 2553c9bb6861Sraviteja-b 25547e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app) 2555c9bb6861Sraviteja-b { 25560fda0f12SGeorge Liu BMCWEB_ROUTE( 25570fda0f12SGeorge Liu app, 255822d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/") 2559fff6a4d3SAbhishek Patel .privileges(redfish::privileges:: 2560fff6a4d3SAbhishek Patel postLogServiceSubOverComputerSystemLogServiceCollection) 256122d268cbSEd Tanous .methods(boost::beast::http::verb::post)(std::bind_front( 256222d268cbSEd Tanous handleLogServicesDumpCollectDiagnosticDataComputerSystemPost, 256322d268cbSEd Tanous std::ref(app))); 2564a43be80fSAsmitha Karunanithi } 2565a43be80fSAsmitha Karunanithi 25667e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app) 2567a43be80fSAsmitha Karunanithi { 25680fda0f12SGeorge Liu BMCWEB_ROUTE( 25690fda0f12SGeorge Liu app, 257022d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/") 2571fff6a4d3SAbhishek Patel .privileges(redfish::privileges:: 2572fff6a4d3SAbhishek Patel postLogServiceSubOverComputerSystemLogServiceCollection) 25736ab9ad54SClaire Weinan .methods(boost::beast::http::verb::post)(std::bind_front( 257422d268cbSEd Tanous handleLogServicesDumpClearLogComputerSystemPost, std::ref(app))); 2575013487e5Sraviteja-b } 2576013487e5Sraviteja-b 25777e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app) 25781da66f75SEd Tanous { 25791da66f75SEd Tanous /** 25801da66f75SEd Tanous * Functions triggers appropriate requests on DBus 25811da66f75SEd Tanous */ 258222d268cbSEd Tanous BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/") 2583*50d9f38aSMyung Bae .privileges(redfish::privileges::getLogService) 2584bd79bce8SPatrick Williams .methods( 2585bd79bce8SPatrick Williams boost::beast::http::verb:: 2586bd79bce8SPatrick Williams get)([&app](const crow::Request& req, 258722d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 258822d268cbSEd Tanous const std::string& systemName) { 25893ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 259045ca1b86SEd Tanous { 259145ca1b86SEd Tanous return; 259245ca1b86SEd Tanous } 259325b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 25947f3e84a1SEd Tanous { 25957f3e84a1SEd Tanous // Option currently returns no systems. TBD 25967f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 25977f3e84a1SEd Tanous systemName); 25987f3e84a1SEd Tanous return; 25997f3e84a1SEd Tanous } 2600253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 260122d268cbSEd Tanous { 260222d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 260322d268cbSEd Tanous systemName); 260422d268cbSEd Tanous return; 260522d268cbSEd Tanous } 260622d268cbSEd Tanous 26077e860f15SJohn Edward Broadbent // Copy over the static data to include the entries added by 26087e860f15SJohn Edward Broadbent // SubRoute 26090f74e643SEd Tanous asyncResp->res.jsonValue["@odata.id"] = 2610253f11b8SEd Tanous std::format("/redfish/v1/Systems/{}/LogServices/Crashdump", 2611253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 2612e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 26138e6c099aSJason M. Bills "#LogService.v1_2_0.LogService"; 26144f50ae4bSGunnar Mills asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; 26154f50ae4bSGunnar Mills asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; 261615b89725SV-Sanjana asyncResp->res.jsonValue["Id"] = "Crashdump"; 2617539d8c6bSEd Tanous asyncResp->res.jsonValue["OverWritePolicy"] = 2618539d8c6bSEd Tanous log_service::OverWritePolicy::WrapsWhenFull; 2619e1f26343SJason M. Bills asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; 26207c8c4058STejas Patil 26217c8c4058STejas Patil std::pair<std::string, std::string> redfishDateTimeOffset = 26222b82937eSEd Tanous redfish::time_utils::getDateTimeOffsetNow(); 26237c8c4058STejas Patil asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first; 26247c8c4058STejas Patil asyncResp->res.jsonValue["DateTimeLocalOffset"] = 26257c8c4058STejas Patil redfishDateTimeOffset.second; 26267c8c4058STejas Patil 2627bd79bce8SPatrick Williams asyncResp->res.jsonValue["Entries"]["@odata.id"] = std::format( 2628bd79bce8SPatrick Williams "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries", 2629253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 2630253f11b8SEd Tanous asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] 2631253f11b8SEd Tanous ["target"] = std::format( 2632253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.ClearLog", 2633253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 2634bd79bce8SPatrick Williams asyncResp->res 2635bd79bce8SPatrick Williams .jsonValue["Actions"]["#LogService.CollectDiagnosticData"] 2636253f11b8SEd Tanous ["target"] = std::format( 2637253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData", 2638253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 26397e860f15SJohn Edward Broadbent }); 26401da66f75SEd Tanous } 26411da66f75SEd Tanous 26427e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app) 26435b61b5e8SJason M. Bills { 26440fda0f12SGeorge Liu BMCWEB_ROUTE( 26450fda0f12SGeorge Liu app, 264622d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/") 2647*50d9f38aSMyung Bae .privileges(redfish::privileges:: 2648*50d9f38aSMyung Bae postLogServiceSubOverComputerSystemLogServiceCollection) 26497e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 265045ca1b86SEd Tanous [&app](const crow::Request& req, 265122d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 265222d268cbSEd Tanous const std::string& systemName) { 26533ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 265445ca1b86SEd Tanous { 265545ca1b86SEd Tanous return; 265645ca1b86SEd Tanous } 265725b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 26587f3e84a1SEd Tanous { 26597f3e84a1SEd Tanous // Option currently returns no systems. TBD 26607f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 26617f3e84a1SEd Tanous systemName); 26627f3e84a1SEd Tanous return; 26637f3e84a1SEd Tanous } 2664253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 266522d268cbSEd Tanous { 266622d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 266722d268cbSEd Tanous systemName); 266822d268cbSEd Tanous return; 266922d268cbSEd Tanous } 2670177612aaSEd Tanous dbus::utility::async_method_call( 2671177612aaSEd Tanous asyncResp, 26725e7e2dc5SEd Tanous [asyncResp](const boost::system::error_code& ec, 2673cb13a392SEd Tanous const std::string&) { 26745b61b5e8SJason M. Bills if (ec) 26755b61b5e8SJason M. Bills { 26765b61b5e8SJason M. Bills messages::internalError(asyncResp->res); 26775b61b5e8SJason M. Bills return; 26785b61b5e8SJason M. Bills } 26795b61b5e8SJason M. Bills messages::success(asyncResp->res); 26805b61b5e8SJason M. Bills }, 2681bd79bce8SPatrick Williams crashdumpObject, crashdumpPath, deleteAllInterface, 2682bd79bce8SPatrick Williams "DeleteAll"); 26837e860f15SJohn Edward Broadbent }); 26845b61b5e8SJason M. Bills } 26855b61b5e8SJason M. Bills 2686504af5a0SPatrick Williams inline void logCrashdumpEntry( 2687504af5a0SPatrick Williams const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 26888d1b46d7Szhanghch05 const std::string& logID, nlohmann::json& logEntryJson) 2689e855dd28SJason M. Bills { 2690043a0536SJohnathan Mantey auto getStoredLogCallback = 2691b9d36b47SEd Tanous [asyncResp, logID, 26925e7e2dc5SEd Tanous &logEntryJson](const boost::system::error_code& ec, 2693b9d36b47SEd Tanous const dbus::utility::DBusPropertiesMap& params) { 2694e855dd28SJason M. Bills if (ec) 2695e855dd28SJason M. Bills { 269662598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message()); 26971ddcf01aSJason M. Bills if (ec.value() == 26981ddcf01aSJason M. Bills boost::system::linux_error::bad_request_descriptor) 26991ddcf01aSJason M. Bills { 2700bd79bce8SPatrick Williams messages::resourceNotFound(asyncResp->res, "LogEntry", 2701bd79bce8SPatrick Williams logID); 27021ddcf01aSJason M. Bills } 27031ddcf01aSJason M. Bills else 27041ddcf01aSJason M. Bills { 2705e855dd28SJason M. Bills messages::internalError(asyncResp->res); 27061ddcf01aSJason M. Bills } 2707e855dd28SJason M. Bills return; 2708e855dd28SJason M. Bills } 2709043a0536SJohnathan Mantey 2710043a0536SJohnathan Mantey std::string timestamp{}; 2711043a0536SJohnathan Mantey std::string filename{}; 2712043a0536SJohnathan Mantey std::string logfile{}; 27132c70f800SEd Tanous parseCrashdumpParameters(params, filename, timestamp, logfile); 2714043a0536SJohnathan Mantey 2715043a0536SJohnathan Mantey if (filename.empty() || timestamp.empty()) 2716e855dd28SJason M. Bills { 27179db4ba25SJiaqing Zhao messages::resourceNotFound(asyncResp->res, "LogEntry", logID); 2718e855dd28SJason M. Bills return; 2719e855dd28SJason M. Bills } 2720e855dd28SJason M. Bills 2721043a0536SJohnathan Mantey std::string crashdumpURI = 2722bd79bce8SPatrick Williams std::format( 2723bd79bce8SPatrick Williams "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/", 2724253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME) + 2725043a0536SJohnathan Mantey logID + "/" + filename; 272684afc48bSJason M. Bills nlohmann::json::object_t logEntry; 27279c11a172SVijay Lobo logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry"; 2728ef4c65b7SEd Tanous logEntry["@odata.id"] = boost::urls::format( 2729253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/{}", 2730253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME, logID); 273184afc48bSJason M. Bills logEntry["Name"] = "CPU Crashdump"; 273284afc48bSJason M. Bills logEntry["Id"] = logID; 2733539d8c6bSEd Tanous logEntry["EntryType"] = log_entry::LogEntryType::Oem; 273484afc48bSJason M. Bills logEntry["AdditionalDataURI"] = std::move(crashdumpURI); 273584afc48bSJason M. Bills logEntry["DiagnosticDataType"] = "OEM"; 273684afc48bSJason M. Bills logEntry["OEMDiagnosticDataType"] = "PECICrashdump"; 273784afc48bSJason M. Bills logEntry["Created"] = std::move(timestamp); 27382b20ef6eSJason M. Bills 27392b20ef6eSJason M. Bills // If logEntryJson references an array of LogEntry resources 27402b20ef6eSJason M. Bills // ('Members' list), then push this as a new entry, otherwise set it 27412b20ef6eSJason M. Bills // directly 27422b20ef6eSJason M. Bills if (logEntryJson.is_array()) 27432b20ef6eSJason M. Bills { 27442b20ef6eSJason M. Bills logEntryJson.push_back(logEntry); 27452b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members@odata.count"] = 27462b20ef6eSJason M. Bills logEntryJson.size(); 27472b20ef6eSJason M. Bills } 27482b20ef6eSJason M. Bills else 27492b20ef6eSJason M. Bills { 2750d405bb51SJason M. Bills logEntryJson.update(logEntry); 27512b20ef6eSJason M. Bills } 2752e855dd28SJason M. Bills }; 2753deae6a78SEd Tanous dbus::utility::getAllProperties( 2754deae6a78SEd Tanous crashdumpObject, crashdumpPath + std::string("/") + logID, 2755deae6a78SEd Tanous crashdumpInterface, std::move(getStoredLogCallback)); 2756e855dd28SJason M. Bills } 2757e855dd28SJason M. Bills 27587e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app) 27591da66f75SEd Tanous { 27601da66f75SEd Tanous /** 27611da66f75SEd Tanous * Functions triggers appropriate requests on DBus 27621da66f75SEd Tanous */ 27637e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, 276422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/") 2765*50d9f38aSMyung Bae .privileges(redfish::privileges::getLogEntryCollection) 2766bd79bce8SPatrick Williams .methods( 2767bd79bce8SPatrick Williams boost::beast::http::verb:: 2768bd79bce8SPatrick Williams get)([&app](const crow::Request& req, 276922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 277022d268cbSEd Tanous const std::string& systemName) { 27713ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 277245ca1b86SEd Tanous { 277345ca1b86SEd Tanous return; 277445ca1b86SEd Tanous } 277525b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 27767f3e84a1SEd Tanous { 27777f3e84a1SEd Tanous // Option currently returns no systems. TBD 27787f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 27797f3e84a1SEd Tanous systemName); 27807f3e84a1SEd Tanous return; 27817f3e84a1SEd Tanous } 2782253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 278322d268cbSEd Tanous { 278422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 278522d268cbSEd Tanous systemName); 278622d268cbSEd Tanous return; 278722d268cbSEd Tanous } 278822d268cbSEd Tanous 27897a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces = { 27907a1dbc48SGeorge Liu crashdumpInterface}; 27917a1dbc48SGeorge Liu dbus::utility::getSubTreePaths( 27927a1dbc48SGeorge Liu "/", 0, interfaces, 27937a1dbc48SGeorge Liu [asyncResp](const boost::system::error_code& ec, 27942b20ef6eSJason M. Bills const std::vector<std::string>& resp) { 27951da66f75SEd Tanous if (ec) 27961da66f75SEd Tanous { 27971da66f75SEd Tanous if (ec.value() != 27981da66f75SEd Tanous boost::system::errc::no_such_file_or_directory) 27991da66f75SEd Tanous { 280062598e31SEd Tanous BMCWEB_LOG_DEBUG("failed to get entries ec: {}", 280162598e31SEd Tanous ec.message()); 2802f12894f8SJason M. Bills messages::internalError(asyncResp->res); 28031da66f75SEd Tanous return; 28041da66f75SEd Tanous } 28051da66f75SEd Tanous } 2806e1f26343SJason M. Bills asyncResp->res.jsonValue["@odata.type"] = 28071da66f75SEd Tanous "#LogEntryCollection.LogEntryCollection"; 2808253f11b8SEd Tanous asyncResp->res.jsonValue["@odata.id"] = std::format( 2809253f11b8SEd Tanous "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries", 2810253f11b8SEd Tanous BMCWEB_REDFISH_SYSTEM_URI_NAME); 2811bd79bce8SPatrick Williams asyncResp->res.jsonValue["Name"] = 2812bd79bce8SPatrick Williams "Open BMC Crashdump Entries"; 2813e1f26343SJason M. Bills asyncResp->res.jsonValue["Description"] = 2814424c4176SJason M. Bills "Collection of Crashdump Entries"; 2815bd79bce8SPatrick Williams asyncResp->res.jsonValue["Members"] = 2816bd79bce8SPatrick Williams nlohmann::json::array(); 2817a2dd60a6SBrandon Kim asyncResp->res.jsonValue["Members@odata.count"] = 0; 28182b20ef6eSJason M. Bills 28192b20ef6eSJason M. Bills for (const std::string& path : resp) 28201da66f75SEd Tanous { 28212b20ef6eSJason M. Bills const sdbusplus::message::object_path objPath(path); 2822e855dd28SJason M. Bills // Get the log ID 28232b20ef6eSJason M. Bills std::string logID = objPath.filename(); 28242b20ef6eSJason M. Bills if (logID.empty()) 28251da66f75SEd Tanous { 2826e855dd28SJason M. Bills continue; 28271da66f75SEd Tanous } 2828e855dd28SJason M. Bills // Add the log entry to the array 28292b20ef6eSJason M. Bills logCrashdumpEntry(asyncResp, logID, 28302b20ef6eSJason M. Bills asyncResp->res.jsonValue["Members"]); 28311da66f75SEd Tanous } 28327a1dbc48SGeorge Liu }); 28337e860f15SJohn Edward Broadbent }); 28341da66f75SEd Tanous } 28351da66f75SEd Tanous 28367e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app) 28371da66f75SEd Tanous { 28387e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 283922d268cbSEd Tanous app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/") 2840*50d9f38aSMyung Bae .privileges(redfish::privileges::getLogEntry) 28417e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 284245ca1b86SEd Tanous [&app](const crow::Request& req, 28437e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 284422d268cbSEd Tanous const std::string& systemName, const std::string& param) { 28453ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 284645ca1b86SEd Tanous { 284745ca1b86SEd Tanous return; 284845ca1b86SEd Tanous } 284925b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 28507f3e84a1SEd Tanous { 28517f3e84a1SEd Tanous // Option currently returns no systems. TBD 28527f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 28537f3e84a1SEd Tanous systemName); 28547f3e84a1SEd Tanous return; 28557f3e84a1SEd Tanous } 2856253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 285722d268cbSEd Tanous { 285822d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 285922d268cbSEd Tanous systemName); 286022d268cbSEd Tanous return; 286122d268cbSEd Tanous } 28627e860f15SJohn Edward Broadbent const std::string& logID = param; 2863e855dd28SJason M. Bills logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); 28647e860f15SJohn Edward Broadbent }); 2865e855dd28SJason M. Bills } 2866e855dd28SJason M. Bills 28677e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app) 2868e855dd28SJason M. Bills { 28697e860f15SJohn Edward Broadbent BMCWEB_ROUTE( 28707e860f15SJohn Edward Broadbent app, 287122d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/") 2872ed398213SEd Tanous .privileges(redfish::privileges::getLogEntry) 28737e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::get)( 2874a4ce114aSNan Zhou [](const crow::Request& req, 28757e860f15SJohn Edward Broadbent const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 287622d268cbSEd Tanous const std::string& systemName, const std::string& logID, 287722d268cbSEd Tanous const std::string& fileName) { 2878bd79bce8SPatrick Williams // Do not call getRedfishRoute here since the crashdump file is 2879bd79bce8SPatrick Williams // not a Redfish resource. 288022d268cbSEd Tanous 288125b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 28827f3e84a1SEd Tanous { 28837f3e84a1SEd Tanous // Option currently returns no systems. TBD 28847f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 28857f3e84a1SEd Tanous systemName); 28867f3e84a1SEd Tanous return; 28877f3e84a1SEd Tanous } 2888253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 288922d268cbSEd Tanous { 289022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 289122d268cbSEd Tanous systemName); 289222d268cbSEd Tanous return; 289322d268cbSEd Tanous } 289422d268cbSEd Tanous 2895043a0536SJohnathan Mantey auto getStoredLogCallback = 2896bd79bce8SPatrick Williams [asyncResp, logID, fileName, 2897bd79bce8SPatrick Williams url(boost::urls::url(req.url()))]( 28985e7e2dc5SEd Tanous const boost::system::error_code& ec, 2899bd79bce8SPatrick Williams const std::vector<std::pair< 2900bd79bce8SPatrick Williams std::string, dbus::utility::DbusVariantType>>& 29017e860f15SJohn Edward Broadbent resp) { 29021da66f75SEd Tanous if (ec) 29031da66f75SEd Tanous { 2904bd79bce8SPatrick Williams BMCWEB_LOG_DEBUG("failed to get log ec: {}", 2905bd79bce8SPatrick Williams ec.message()); 2906f12894f8SJason M. Bills messages::internalError(asyncResp->res); 29071da66f75SEd Tanous return; 29081da66f75SEd Tanous } 2909e855dd28SJason M. Bills 2910043a0536SJohnathan Mantey std::string dbusFilename{}; 2911043a0536SJohnathan Mantey std::string dbusTimestamp{}; 2912043a0536SJohnathan Mantey std::string dbusFilepath{}; 2913043a0536SJohnathan Mantey 2914bd79bce8SPatrick Williams parseCrashdumpParameters(resp, dbusFilename, 2915bd79bce8SPatrick Williams dbusTimestamp, dbusFilepath); 2916043a0536SJohnathan Mantey 2917043a0536SJohnathan Mantey if (dbusFilename.empty() || dbusTimestamp.empty() || 2918043a0536SJohnathan Mantey dbusFilepath.empty()) 29191da66f75SEd Tanous { 2920bd79bce8SPatrick Williams messages::resourceNotFound(asyncResp->res, 2921bd79bce8SPatrick Williams "LogEntry", logID); 29221da66f75SEd Tanous return; 29231da66f75SEd Tanous } 2924e855dd28SJason M. Bills 2925043a0536SJohnathan Mantey // Verify the file name parameter is correct 2926043a0536SJohnathan Mantey if (fileName != dbusFilename) 2927043a0536SJohnathan Mantey { 2928bd79bce8SPatrick Williams messages::resourceNotFound(asyncResp->res, 2929bd79bce8SPatrick Williams "LogEntry", logID); 2930043a0536SJohnathan Mantey return; 2931043a0536SJohnathan Mantey } 2932043a0536SJohnathan Mantey 2933d51c61b4SMyung Bae if (asyncResp->res.openFile(dbusFilepath) != 2934d51c61b4SMyung Bae crow::OpenCode::Success) 2935043a0536SJohnathan Mantey { 2936bd79bce8SPatrick Williams messages::resourceNotFound(asyncResp->res, 2937bd79bce8SPatrick Williams "LogEntry", logID); 2938043a0536SJohnathan Mantey return; 2939043a0536SJohnathan Mantey } 2940043a0536SJohnathan Mantey 29417e860f15SJohn Edward Broadbent // Configure this to be a file download when accessed 29427e860f15SJohn Edward Broadbent // from a browser 2943d9f6c621SEd Tanous asyncResp->res.addHeader( 2944bd79bce8SPatrick Williams boost::beast::http::field::content_disposition, 2945bd79bce8SPatrick Williams "attachment"); 29461da66f75SEd Tanous }; 2947deae6a78SEd Tanous dbus::utility::getAllProperties( 2948d1bde9e5SKrzysztof Grobelny *crow::connections::systemBus, crashdumpObject, 2949bd79bce8SPatrick Williams crashdumpPath + std::string("/") + logID, 2950bd79bce8SPatrick Williams crashdumpInterface, std::move(getStoredLogCallback)); 29517e860f15SJohn Edward Broadbent }); 29521da66f75SEd Tanous } 29531da66f75SEd Tanous 2954c5a4c82aSJason M. Bills enum class OEMDiagnosticType 2955c5a4c82aSJason M. Bills { 2956c5a4c82aSJason M. Bills onDemand, 2957c5a4c82aSJason M. Bills telemetry, 2958c5a4c82aSJason M. Bills invalid, 2959c5a4c82aSJason M. Bills }; 2960c5a4c82aSJason M. Bills 296126ccae32SEd Tanous inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr) 2962c5a4c82aSJason M. Bills { 2963c5a4c82aSJason M. Bills if (oemDiagStr == "OnDemand") 2964c5a4c82aSJason M. Bills { 2965c5a4c82aSJason M. Bills return OEMDiagnosticType::onDemand; 2966c5a4c82aSJason M. Bills } 2967c5a4c82aSJason M. Bills if (oemDiagStr == "Telemetry") 2968c5a4c82aSJason M. Bills { 2969c5a4c82aSJason M. Bills return OEMDiagnosticType::telemetry; 2970c5a4c82aSJason M. Bills } 2971c5a4c82aSJason M. Bills 2972c5a4c82aSJason M. Bills return OEMDiagnosticType::invalid; 2973c5a4c82aSJason M. Bills } 2974c5a4c82aSJason M. Bills 29757e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app) 29761da66f75SEd Tanous { 29770fda0f12SGeorge Liu BMCWEB_ROUTE( 29780fda0f12SGeorge Liu app, 297922d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/") 2980*50d9f38aSMyung Bae .privileges(redfish::privileges:: 2981*50d9f38aSMyung Bae postLogServiceSubOverComputerSystemLogServiceCollection) 2982002d39b4SEd Tanous .methods(boost::beast::http::verb::post)( 2983002d39b4SEd Tanous [&app](const crow::Request& req, 298422d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 298522d268cbSEd Tanous const std::string& systemName) { 29863ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 298745ca1b86SEd Tanous { 298845ca1b86SEd Tanous return; 298945ca1b86SEd Tanous } 299022d268cbSEd Tanous 299125b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 29927f3e84a1SEd Tanous { 29937f3e84a1SEd Tanous // Option currently returns no systems. TBD 29947f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 29957f3e84a1SEd Tanous systemName); 29967f3e84a1SEd Tanous return; 29977f3e84a1SEd Tanous } 2998253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 299922d268cbSEd Tanous { 300022d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 300122d268cbSEd Tanous systemName); 300222d268cbSEd Tanous return; 300322d268cbSEd Tanous } 300422d268cbSEd Tanous 30058e6c099aSJason M. Bills std::string diagnosticDataType; 30068e6c099aSJason M. Bills std::string oemDiagnosticDataType; 3007afc474aeSMyung Bae if (!redfish::json_util::readJsonAction( // 3008afc474aeSMyung Bae req, asyncResp->res, // 3009afc474aeSMyung Bae "DiagnosticDataType", diagnosticDataType, // 3010afc474aeSMyung Bae "OEMDiagnosticDataType", oemDiagnosticDataType // 3011afc474aeSMyung Bae )) 30128e6c099aSJason M. Bills { 30138e6c099aSJason M. Bills return; 30148e6c099aSJason M. Bills } 30158e6c099aSJason M. Bills 30168e6c099aSJason M. Bills if (diagnosticDataType != "OEM") 30178e6c099aSJason M. Bills { 301862598e31SEd Tanous BMCWEB_LOG_ERROR( 301962598e31SEd Tanous "Only OEM DiagnosticDataType supported for Crashdump"); 30208e6c099aSJason M. Bills messages::actionParameterValueFormatError( 3021bd79bce8SPatrick Williams asyncResp->res, diagnosticDataType, 3022bd79bce8SPatrick Williams "DiagnosticDataType", "CollectDiagnosticData"); 30238e6c099aSJason M. Bills return; 30248e6c099aSJason M. Bills } 30258e6c099aSJason M. Bills 3026c5a4c82aSJason M. Bills OEMDiagnosticType oemDiagType = 3027c5a4c82aSJason M. Bills getOEMDiagnosticType(oemDiagnosticDataType); 3028c5a4c82aSJason M. Bills 3029c5a4c82aSJason M. Bills std::string iface; 3030c5a4c82aSJason M. Bills std::string method; 3031c5a4c82aSJason M. Bills std::string taskMatchStr; 3032c5a4c82aSJason M. Bills if (oemDiagType == OEMDiagnosticType::onDemand) 3033c5a4c82aSJason M. Bills { 3034c5a4c82aSJason M. Bills iface = crashdumpOnDemandInterface; 3035c5a4c82aSJason M. Bills method = "GenerateOnDemandLog"; 3036bd79bce8SPatrick Williams taskMatchStr = 3037bd79bce8SPatrick Williams "type='signal'," 3038c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3039c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3040c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3041c5a4c82aSJason M. Bills } 3042c5a4c82aSJason M. Bills else if (oemDiagType == OEMDiagnosticType::telemetry) 3043c5a4c82aSJason M. Bills { 3044c5a4c82aSJason M. Bills iface = crashdumpTelemetryInterface; 3045c5a4c82aSJason M. Bills method = "GenerateTelemetryLog"; 3046bd79bce8SPatrick Williams taskMatchStr = 3047bd79bce8SPatrick Williams "type='signal'," 3048c5a4c82aSJason M. Bills "interface='org.freedesktop.DBus.Properties'," 3049c5a4c82aSJason M. Bills "member='PropertiesChanged'," 3050c5a4c82aSJason M. Bills "arg0namespace='com.intel.crashdump'"; 3051c5a4c82aSJason M. Bills } 3052c5a4c82aSJason M. Bills else 3053c5a4c82aSJason M. Bills { 305462598e31SEd Tanous BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}", 305562598e31SEd Tanous oemDiagnosticDataType); 3056c5a4c82aSJason M. Bills messages::actionParameterValueFormatError( 3057bd79bce8SPatrick Williams asyncResp->res, oemDiagnosticDataType, 3058bd79bce8SPatrick Williams "OEMDiagnosticDataType", "CollectDiagnosticData"); 3059c5a4c82aSJason M. Bills return; 3060c5a4c82aSJason M. Bills } 3061c5a4c82aSJason M. Bills 3062c5a4c82aSJason M. Bills auto collectCrashdumpCallback = 3063c5a4c82aSJason M. Bills [asyncResp, payload(task::Payload(req)), 30645e7e2dc5SEd Tanous taskMatchStr](const boost::system::error_code& ec, 306598be3e39SEd Tanous const std::string&) mutable { 30661da66f75SEd Tanous if (ec) 30671da66f75SEd Tanous { 3068bd79bce8SPatrick Williams if (ec.value() == 3069bd79bce8SPatrick Williams boost::system::errc::operation_not_supported) 30701da66f75SEd Tanous { 3071f12894f8SJason M. Bills messages::resourceInStandby(asyncResp->res); 30721da66f75SEd Tanous } 3073bd79bce8SPatrick Williams else if (ec.value() == boost::system::errc:: 3074bd79bce8SPatrick Williams device_or_resource_busy) 30754363d3b2SJason M. Bills { 3076bd79bce8SPatrick Williams messages::serviceTemporarilyUnavailable( 3077bd79bce8SPatrick Williams asyncResp->res, "60"); 30784363d3b2SJason M. Bills } 30791da66f75SEd Tanous else 30801da66f75SEd Tanous { 3081f12894f8SJason M. Bills messages::internalError(asyncResp->res); 30821da66f75SEd Tanous } 30831da66f75SEd Tanous return; 30841da66f75SEd Tanous } 3085bd79bce8SPatrick Williams std::shared_ptr<task::TaskData> task = 3086bd79bce8SPatrick Williams task::TaskData::createTask( 3087bd79bce8SPatrick Williams [](const boost::system::error_code& ec2, 3088bd79bce8SPatrick Williams sdbusplus::message_t&, 3089bd79bce8SPatrick Williams const std::shared_ptr<task::TaskData>& 3090bd79bce8SPatrick Williams taskData) { 30918b24275dSEd Tanous if (!ec2) 309266afe4faSJames Feist { 3093bd79bce8SPatrick Williams taskData->messages.emplace_back( 3094bd79bce8SPatrick Williams messages::taskCompletedOK( 3095bd79bce8SPatrick Williams std::to_string( 3096bd79bce8SPatrick Williams taskData->index))); 3097831d6b09SJames Feist taskData->state = "Completed"; 309866afe4faSJames Feist } 309932898ceaSJames Feist return task::completed; 310066afe4faSJames Feist }, 3101c5a4c82aSJason M. Bills taskMatchStr); 3102c5a4c82aSJason M. Bills 310346229577SJames Feist task->startTimer(std::chrono::minutes(5)); 310498be3e39SEd Tanous task->payload.emplace(std::move(payload)); 310529e2bdd7SChinmay Shripad Hegde task->populateResp(asyncResp->res); 31061da66f75SEd Tanous }; 31078e6c099aSJason M. Bills 3108177612aaSEd Tanous dbus::utility::async_method_call( 3109177612aaSEd Tanous asyncResp, std::move(collectCrashdumpCallback), 3110177612aaSEd Tanous crashdumpObject, crashdumpPath, iface, method); 31117e860f15SJohn Edward Broadbent }); 31126eda7685SKenny L. Ku } 31136eda7685SKenny L. Ku 3114599b9af3SAlexander Hansen inline void dBusLogServiceActionsClear( 3115599b9af3SAlexander Hansen const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 3116599b9af3SAlexander Hansen { 3117599b9af3SAlexander Hansen BMCWEB_LOG_DEBUG("Do delete all entries."); 3118599b9af3SAlexander Hansen 3119599b9af3SAlexander Hansen // Process response from Logging service. 3120599b9af3SAlexander Hansen auto respHandler = [asyncResp](const boost::system::error_code& ec) { 3121599b9af3SAlexander Hansen BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done"); 3122599b9af3SAlexander Hansen if (ec) 3123599b9af3SAlexander Hansen { 3124599b9af3SAlexander Hansen // TODO Handle for specific error code 3125599b9af3SAlexander Hansen BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec); 3126599b9af3SAlexander Hansen asyncResp->res.result( 3127599b9af3SAlexander Hansen boost::beast::http::status::internal_server_error); 3128599b9af3SAlexander Hansen return; 3129599b9af3SAlexander Hansen } 3130599b9af3SAlexander Hansen 3131e2460466SAmy Chang messages::success(asyncResp->res); 3132599b9af3SAlexander Hansen }; 3133599b9af3SAlexander Hansen 3134599b9af3SAlexander Hansen // Make call to Logging service to request Clear Log 3135177612aaSEd Tanous dbus::utility::async_method_call( 3136177612aaSEd Tanous asyncResp, respHandler, "xyz.openbmc_project.Logging", 3137599b9af3SAlexander Hansen "/xyz/openbmc_project/logging", 3138599b9af3SAlexander Hansen "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); 3139599b9af3SAlexander Hansen } 3140599b9af3SAlexander Hansen 3141cb92c03bSAndrew Geissler /** 3142cb92c03bSAndrew Geissler * DBusLogServiceActionsClear class supports POST method for ClearLog action. 3143cb92c03bSAndrew Geissler */ 31447e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app) 3145cb92c03bSAndrew Geissler { 3146cb92c03bSAndrew Geissler /** 3147cb92c03bSAndrew Geissler * Function handles POST method request. 3148cb92c03bSAndrew Geissler * The Clear Log actions does not require any parameter.The action deletes 3149cb92c03bSAndrew Geissler * all entries found in the Entries collection for this Log Service. 3150cb92c03bSAndrew Geissler */ 31517e860f15SJohn Edward Broadbent 31520fda0f12SGeorge Liu BMCWEB_ROUTE( 31530fda0f12SGeorge Liu app, 315422d268cbSEd Tanous "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/") 3155fff6a4d3SAbhishek Patel .privileges(redfish::privileges:: 3156fff6a4d3SAbhishek Patel postLogServiceSubOverComputerSystemLogServiceCollection) 31577e860f15SJohn Edward Broadbent .methods(boost::beast::http::verb::post)( 315845ca1b86SEd Tanous [&app](const crow::Request& req, 315922d268cbSEd Tanous const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 316022d268cbSEd Tanous const std::string& systemName) { 31613ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 316245ca1b86SEd Tanous { 316345ca1b86SEd Tanous return; 316445ca1b86SEd Tanous } 316525b54dbaSEd Tanous if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM) 31667f3e84a1SEd Tanous { 31677f3e84a1SEd Tanous // Option currently returns no systems. TBD 31687f3e84a1SEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 31697f3e84a1SEd Tanous systemName); 31707f3e84a1SEd Tanous return; 31717f3e84a1SEd Tanous } 3172253f11b8SEd Tanous if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME) 317322d268cbSEd Tanous { 317422d268cbSEd Tanous messages::resourceNotFound(asyncResp->res, "ComputerSystem", 317522d268cbSEd Tanous systemName); 317622d268cbSEd Tanous return; 317722d268cbSEd Tanous } 3178599b9af3SAlexander Hansen dBusLogServiceActionsClear(asyncResp); 31797e860f15SJohn Edward Broadbent }); 3180cb92c03bSAndrew Geissler } 3181a3316fc6SZhikuiRen 31821da66f75SEd Tanous } // namespace redfish 3183