xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision 177612aaa0633cf9d5aef0b763a43135cf552d9b)
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 
593*177612aaSEd Tanous     dbus::utility::async_method_call(
594*177612aaSEd 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 
709*177612aaSEd Tanous     dbus::utility::async_method_call(
710*177612aaSEd Tanous         asyncResp, std::move(downloadDumpEntryHandler),
711*177612aaSEd Tanous         "xyz.openbmc_project.Dump.Manager", dumpEntryPath,
712*177612aaSEd 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 
745*177612aaSEd Tanous     dbus::utility::async_method_call(
746*177612aaSEd Tanous         asyncResp, std::move(downloadEventLogEntryHandler),
747*177612aaSEd Tanous         "xyz.openbmc_project.Logging", entryPath,
748*177612aaSEd 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 
819*177612aaSEd Tanous     dbus::utility::async_method_call(
820*177612aaSEd 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));
937a43be80fSAsmitha Karunanithi             task->populateResp(asyncResp->res);
9388e31778eSAsmitha Karunanithi             task->payload.emplace(payload);
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 
1027*177612aaSEd Tanous     dbus::utility::async_method_call(
1028*177612aaSEd 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 {
1086*177612aaSEd Tanous     dbus::utility::async_method_call(
1087*177612aaSEd 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             }
10950d946211SClaire Weinan         },
109618f8f608SEd Tanous         "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType),
10970d946211SClaire Weinan         "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
109880319af1SAsmitha Karunanithi }
109980319af1SAsmitha Karunanithi 
1100bd79bce8SPatrick Williams inline void parseCrashdumpParameters(
1101bd79bce8SPatrick Williams     const dbus::utility::DBusPropertiesMap& params, std::string& filename,
1102bd79bce8SPatrick Williams     std::string& timestamp, std::string& logfile)
1103043a0536SJohnathan Mantey {
1104d1bde9e5SKrzysztof Grobelny     const std::string* filenamePtr = nullptr;
1105d1bde9e5SKrzysztof Grobelny     const std::string* timestampPtr = nullptr;
1106d1bde9e5SKrzysztof Grobelny     const std::string* logfilePtr = nullptr;
1107d1bde9e5SKrzysztof Grobelny 
1108d1bde9e5SKrzysztof Grobelny     const bool success = sdbusplus::unpackPropertiesNoThrow(
1109d1bde9e5SKrzysztof Grobelny         dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr,
1110d1bde9e5SKrzysztof Grobelny         "Filename", filenamePtr, "Log", logfilePtr);
1111d1bde9e5SKrzysztof Grobelny 
1112d1bde9e5SKrzysztof Grobelny     if (!success)
1113043a0536SJohnathan Mantey     {
1114d1bde9e5SKrzysztof Grobelny         return;
1115043a0536SJohnathan Mantey     }
1116d1bde9e5SKrzysztof Grobelny 
1117d1bde9e5SKrzysztof Grobelny     if (filenamePtr != nullptr)
1118043a0536SJohnathan Mantey     {
1119d1bde9e5SKrzysztof Grobelny         filename = *filenamePtr;
1120d1bde9e5SKrzysztof Grobelny     }
1121d1bde9e5SKrzysztof Grobelny 
1122d1bde9e5SKrzysztof Grobelny     if (timestampPtr != nullptr)
1123043a0536SJohnathan Mantey     {
1124d1bde9e5SKrzysztof Grobelny         timestamp = *timestampPtr;
1125043a0536SJohnathan Mantey     }
1126d1bde9e5SKrzysztof Grobelny 
1127d1bde9e5SKrzysztof Grobelny     if (logfilePtr != nullptr)
1128043a0536SJohnathan Mantey     {
1129d1bde9e5SKrzysztof Grobelny         logfile = *logfilePtr;
1130043a0536SJohnathan Mantey     }
1131043a0536SJohnathan Mantey }
1132043a0536SJohnathan Mantey 
11337e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app)
11341da66f75SEd Tanous {
1135c4bf6374SJason M. Bills     /**
1136c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
1137c4bf6374SJason M. Bills      */
113822d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/")
1139ed398213SEd Tanous         .privileges(redfish::privileges::getLogServiceCollection)
1140bd79bce8SPatrick Williams         .methods(
1141bd79bce8SPatrick Williams             boost::beast::http::verb::
1142bd79bce8SPatrick Williams                 get)([&app](const crow::Request& req,
114322d268cbSEd Tanous                             const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
114422d268cbSEd Tanous                             const std::string& systemName) {
11453ba00073SCarson Labrado             if (!redfish::setUpRedfishRoute(app, req, asyncResp))
1146c4bf6374SJason M. Bills             {
114745ca1b86SEd Tanous                 return;
114845ca1b86SEd Tanous             }
114925b54dbaSEd Tanous             if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
11507f3e84a1SEd Tanous             {
11517f3e84a1SEd Tanous                 // Option currently returns no systems.  TBD
11527f3e84a1SEd Tanous                 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
11537f3e84a1SEd Tanous                                            systemName);
11547f3e84a1SEd Tanous                 return;
11557f3e84a1SEd Tanous             }
1156253f11b8SEd Tanous             if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
115722d268cbSEd Tanous             {
115822d268cbSEd Tanous                 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
115922d268cbSEd Tanous                                            systemName);
116022d268cbSEd Tanous                 return;
116122d268cbSEd Tanous             }
116222d268cbSEd Tanous 
11637e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
11647e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
1165c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
1166c4bf6374SJason M. Bills                 "#LogServiceCollection.LogServiceCollection";
1167c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.id"] =
1168253f11b8SEd Tanous                 std::format("/redfish/v1/Systems/{}/LogServices",
1169253f11b8SEd Tanous                             BMCWEB_REDFISH_SYSTEM_URI_NAME);
117045ca1b86SEd Tanous             asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
1171c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Description"] =
1172c4bf6374SJason M. Bills                 "Collection of LogServices for this Computer System";
1173bd79bce8SPatrick Williams             nlohmann::json& logServiceArray =
1174bd79bce8SPatrick Williams                 asyncResp->res.jsonValue["Members"];
1175c4bf6374SJason M. Bills             logServiceArray = nlohmann::json::array();
11761476687dSEd Tanous             nlohmann::json::object_t eventLog;
11771476687dSEd Tanous             eventLog["@odata.id"] =
1178253f11b8SEd Tanous                 std::format("/redfish/v1/Systems/{}/LogServices/EventLog",
1179253f11b8SEd Tanous                             BMCWEB_REDFISH_SYSTEM_URI_NAME);
1180b2ba3072SPatrick Williams             logServiceArray.emplace_back(std::move(eventLog));
118125b54dbaSEd Tanous             if constexpr (BMCWEB_REDFISH_DUMP_LOG)
118225b54dbaSEd Tanous             {
11831476687dSEd Tanous                 nlohmann::json::object_t dumpLog;
118425b54dbaSEd Tanous                 dumpLog["@odata.id"] =
1185253f11b8SEd Tanous                     std::format("/redfish/v1/Systems/{}/LogServices/Dump",
1186253f11b8SEd Tanous                                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1187b2ba3072SPatrick Williams                 logServiceArray.emplace_back(std::move(dumpLog));
118825b54dbaSEd Tanous             }
1189c9bb6861Sraviteja-b 
11905ffd11f2SGunnar Mills             if constexpr (BMCWEB_REDFISH_CPU_LOG)
119125b54dbaSEd Tanous             {
11921476687dSEd Tanous                 nlohmann::json::object_t crashdump;
11931476687dSEd Tanous                 crashdump["@odata.id"] =
1194253f11b8SEd Tanous                     std::format("/redfish/v1/Systems/{}/LogServices/Crashdump",
1195253f11b8SEd Tanous                                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1196b2ba3072SPatrick Williams                 logServiceArray.emplace_back(std::move(crashdump));
119725b54dbaSEd Tanous             }
1198b7028ebfSSpencer Ku 
119925b54dbaSEd Tanous             if constexpr (BMCWEB_REDFISH_HOST_LOGGER)
120025b54dbaSEd Tanous             {
12011476687dSEd Tanous                 nlohmann::json::object_t hostlogger;
12021476687dSEd Tanous                 hostlogger["@odata.id"] =
1203253f11b8SEd Tanous                     std::format("/redfish/v1/Systems/{}/LogServices/HostLogger",
1204253f11b8SEd Tanous                                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1205b2ba3072SPatrick Williams                 logServiceArray.emplace_back(std::move(hostlogger));
120625b54dbaSEd Tanous             }
1207c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
1208c4bf6374SJason M. Bills                 logServiceArray.size();
1209a3316fc6SZhikuiRen 
12107a1dbc48SGeorge Liu             constexpr std::array<std::string_view, 1> interfaces = {
12117a1dbc48SGeorge Liu                 "xyz.openbmc_project.State.Boot.PostCode"};
12127a1dbc48SGeorge Liu             dbus::utility::getSubTreePaths(
12137a1dbc48SGeorge Liu                 "/", 0, interfaces,
12147a1dbc48SGeorge Liu                 [asyncResp](const boost::system::error_code& ec,
1215b9d36b47SEd Tanous                             const dbus::utility::MapperGetSubTreePathsResponse&
1216b9d36b47SEd Tanous                                 subtreePath) {
1217a3316fc6SZhikuiRen                     if (ec)
1218a3316fc6SZhikuiRen                     {
121962598e31SEd Tanous                         BMCWEB_LOG_ERROR("{}", ec);
1220a3316fc6SZhikuiRen                         return;
1221a3316fc6SZhikuiRen                     }
1222a3316fc6SZhikuiRen 
122355f79e6fSEd Tanous                     for (const auto& pathStr : subtreePath)
1224a3316fc6SZhikuiRen                     {
1225a3316fc6SZhikuiRen                         if (pathStr.find("PostCode") != std::string::npos)
1226a3316fc6SZhikuiRen                         {
122723a21a1cSEd Tanous                             nlohmann::json& logServiceArrayLocal =
1228a3316fc6SZhikuiRen                                 asyncResp->res.jsonValue["Members"];
1229613dabeaSEd Tanous                             nlohmann::json::object_t member;
1230253f11b8SEd Tanous                             member["@odata.id"] = std::format(
1231253f11b8SEd Tanous                                 "/redfish/v1/Systems/{}/LogServices/PostCodes",
1232253f11b8SEd Tanous                                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1233613dabeaSEd Tanous 
1234bd79bce8SPatrick Williams                             logServiceArrayLocal.emplace_back(
1235bd79bce8SPatrick Williams                                 std::move(member));
1236613dabeaSEd Tanous 
123745ca1b86SEd Tanous                             asyncResp->res.jsonValue["Members@odata.count"] =
123823a21a1cSEd Tanous                                 logServiceArrayLocal.size();
1239a3316fc6SZhikuiRen                             return;
1240a3316fc6SZhikuiRen                         }
1241a3316fc6SZhikuiRen                     }
12427a1dbc48SGeorge Liu                 });
12437e860f15SJohn Edward Broadbent         });
1244c4bf6374SJason M. Bills }
1245c4bf6374SJason M. Bills 
12467e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app)
1247c4bf6374SJason M. Bills {
124822d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/")
1249ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
1250bd79bce8SPatrick Williams         .methods(
1251bd79bce8SPatrick Williams             boost::beast::http::verb::
1252bd79bce8SPatrick Williams                 get)([&app](const crow::Request& req,
125322d268cbSEd Tanous                             const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
125422d268cbSEd Tanous                             const std::string& systemName) {
12553ba00073SCarson Labrado             if (!redfish::setUpRedfishRoute(app, req, asyncResp))
125645ca1b86SEd Tanous             {
125745ca1b86SEd Tanous                 return;
125845ca1b86SEd Tanous             }
1259253f11b8SEd Tanous             if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
126022d268cbSEd Tanous             {
126122d268cbSEd Tanous                 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
126222d268cbSEd Tanous                                            systemName);
126322d268cbSEd Tanous                 return;
126422d268cbSEd Tanous             }
1265c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.id"] =
1266253f11b8SEd Tanous                 std::format("/redfish/v1/Systems/{}/LogServices/EventLog",
1267253f11b8SEd Tanous                             BMCWEB_REDFISH_SYSTEM_URI_NAME);
1268c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
1269b25644a1SJanet Adkins                 "#LogService.v1_2_0.LogService";
1270c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Event Log Service";
1271bd79bce8SPatrick Williams             asyncResp->res.jsonValue["Description"] =
1272bd79bce8SPatrick Williams                 "System Event Log Service";
1273c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Id"] = "EventLog";
1274539d8c6bSEd Tanous             asyncResp->res.jsonValue["OverWritePolicy"] =
1275539d8c6bSEd Tanous                 log_service::OverWritePolicy::WrapsWhenFull;
12767c8c4058STejas Patil 
12777c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
12782b82937eSEd Tanous                 redfish::time_utils::getDateTimeOffsetNow();
12797c8c4058STejas Patil 
12807c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
12817c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
12827c8c4058STejas Patil                 redfishDateTimeOffset.second;
12837c8c4058STejas Patil 
1284bd79bce8SPatrick Williams             asyncResp->res.jsonValue["Entries"]["@odata.id"] = std::format(
1285bd79bce8SPatrick Williams                 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1286253f11b8SEd Tanous                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1287bd79bce8SPatrick Williams             asyncResp->res
1288bd79bce8SPatrick Williams                 .jsonValue["Actions"]["#LogService.ClearLog"]["target"]
1289e7d6c8b2SGunnar Mills 
129020fa6a2cSEd Tanous                 = std::format(
1291253f11b8SEd Tanous                     "/redfish/v1/Systems/{}/LogServices/EventLog/Actions/LogService.ClearLog",
129220fa6a2cSEd Tanous                     BMCWEB_REDFISH_SYSTEM_URI_NAME);
12937e860f15SJohn Edward Broadbent         });
1294489640c6SJason M. Bills }
1295489640c6SJason M. Bills 
1296599b9af3SAlexander Hansen inline void handleSystemsLogServicesEventLogActionsClearPost(
1297599b9af3SAlexander Hansen     App& app, const crow::Request& req,
129822d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1299599b9af3SAlexander Hansen     const std::string& systemName)
1300599b9af3SAlexander Hansen {
13013ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
130245ca1b86SEd Tanous     {
130345ca1b86SEd Tanous         return;
130445ca1b86SEd Tanous     }
1305253f11b8SEd Tanous     if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
130622d268cbSEd Tanous     {
130722d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
130822d268cbSEd Tanous                                    systemName);
130922d268cbSEd Tanous         return;
131022d268cbSEd Tanous     }
1311599b9af3SAlexander Hansen 
1312489640c6SJason M. Bills     // Clear the EventLog by deleting the log files
1313489640c6SJason M. Bills     std::vector<std::filesystem::path> redfishLogFiles;
1314489640c6SJason M. Bills     if (getRedfishLogFiles(redfishLogFiles))
1315489640c6SJason M. Bills     {
1316489640c6SJason M. Bills         for (const std::filesystem::path& file : redfishLogFiles)
1317489640c6SJason M. Bills         {
1318489640c6SJason M. Bills             std::error_code ec;
1319489640c6SJason M. Bills             std::filesystem::remove(file, ec);
1320489640c6SJason M. Bills         }
1321489640c6SJason M. Bills     }
1322489640c6SJason M. Bills 
1323489640c6SJason M. Bills     // Reload rsyslog so it knows to start new log files
1324*177612aaSEd Tanous     dbus::utility::async_method_call(
1325*177612aaSEd Tanous         asyncResp,
13265e7e2dc5SEd Tanous         [asyncResp](const boost::system::error_code& ec) {
1327489640c6SJason M. Bills             if (ec)
1328489640c6SJason M. Bills             {
132962598e31SEd Tanous                 BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec);
1330489640c6SJason M. Bills                 messages::internalError(asyncResp->res);
1331489640c6SJason M. Bills                 return;
1332489640c6SJason M. Bills             }
1333489640c6SJason M. Bills 
1334489640c6SJason M. Bills             messages::success(asyncResp->res);
1335489640c6SJason M. Bills         },
1336489640c6SJason M. Bills         "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1337002d39b4SEd Tanous         "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1338002d39b4SEd Tanous         "replace");
1339599b9af3SAlexander Hansen }
1340599b9af3SAlexander Hansen 
1341599b9af3SAlexander Hansen inline void requestRoutesJournalEventLogClear(App& app)
1342599b9af3SAlexander Hansen {
1343599b9af3SAlexander Hansen     BMCWEB_ROUTE(
1344599b9af3SAlexander Hansen         app,
1345599b9af3SAlexander Hansen         "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
1346599b9af3SAlexander Hansen         .privileges({{"ConfigureComponents"}})
1347599b9af3SAlexander Hansen         .methods(boost::beast::http::verb::post)(std::bind_front(
1348599b9af3SAlexander Hansen             handleSystemsLogServicesEventLogActionsClearPost, std::ref(app)));
1349c4bf6374SJason M. Bills }
1350c4bf6374SJason M. Bills 
1351ac992cdeSJason M. Bills enum class LogParseError
1352ac992cdeSJason M. Bills {
1353ac992cdeSJason M. Bills     success,
1354ac992cdeSJason M. Bills     parseFailed,
1355ac992cdeSJason M. Bills     messageIdNotInRegistry,
1356ac992cdeSJason M. Bills };
1357ac992cdeSJason M. Bills 
1358bd79bce8SPatrick Williams static LogParseError fillEventLogEntryJson(
1359bd79bce8SPatrick Williams     const std::string& logEntryID, const std::string& logEntry,
1360de703c5dSJason M. Bills     nlohmann::json::object_t& logEntryJson)
1361c4bf6374SJason M. Bills {
136295820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1363cd225da8SJason M. Bills     // First get the Timestamp
1364f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1365cd225da8SJason M. Bills     if (space == std::string::npos)
136695820184SJason M. Bills     {
1367ac992cdeSJason M. Bills         return LogParseError::parseFailed;
136895820184SJason M. Bills     }
1369cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1370cd225da8SJason M. Bills     // Then get the log contents
1371f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1372cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1373cd225da8SJason M. Bills     {
1374ac992cdeSJason M. Bills         return LogParseError::parseFailed;
1375cd225da8SJason M. Bills     }
1376cd225da8SJason M. Bills     std::string_view entry(logEntry);
1377cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1378cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1379cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
138050ebd4afSEd Tanous     bmcweb::split(logEntryFields, entry, ',');
1381cd225da8SJason M. Bills     // We need at least a MessageId to be valid
13821e6deaf6SEd Tanous     auto logEntryIter = logEntryFields.begin();
13831e6deaf6SEd Tanous     if (logEntryIter == logEntryFields.end())
1384cd225da8SJason M. Bills     {
1385ac992cdeSJason M. Bills         return LogParseError::parseFailed;
1386cd225da8SJason M. Bills     }
13871e6deaf6SEd Tanous     std::string& messageID = *logEntryIter;
13884851d45dSJason M. Bills     // Get the Message from the MessageRegistry
1389fffb8c1fSEd Tanous     const registries::Message* message = registries::getMessage(messageID);
1390c4bf6374SJason M. Bills 
13911e6deaf6SEd Tanous     logEntryIter++;
139254417b02SSui Chen     if (message == nullptr)
1393c4bf6374SJason M. Bills     {
139462598e31SEd Tanous         BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry);
1395ac992cdeSJason M. Bills         return LogParseError::messageIdNotInRegistry;
1396c4bf6374SJason M. Bills     }
1397c4bf6374SJason M. Bills 
13981e6deaf6SEd Tanous     std::vector<std::string_view> messageArgs(logEntryIter,
13991e6deaf6SEd Tanous                                               logEntryFields.end());
1400c05bba45SEd Tanous     messageArgs.resize(message->numberOfArgs);
1401c05bba45SEd Tanous 
1402bd79bce8SPatrick Williams     std::string msg =
1403bd79bce8SPatrick Williams         redfish::registries::fillMessageArgs(messageArgs, message->message);
14041e6deaf6SEd Tanous     if (msg.empty())
140515a86ff6SJason M. Bills     {
14061e6deaf6SEd Tanous         return LogParseError::parseFailed;
140715a86ff6SJason M. Bills     }
14084851d45dSJason M. Bills 
140995820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
141095820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
141195820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1412f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1413f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
141495820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1415c4bf6374SJason M. Bills     {
141695820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1417c4bf6374SJason M. Bills     }
1418c4bf6374SJason M. Bills 
1419c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
14209c11a172SVijay Lobo     logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
1421ef4c65b7SEd Tanous     logEntryJson["@odata.id"] = boost::urls::format(
1422253f11b8SEd Tanous         "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}",
1423253f11b8SEd Tanous         BMCWEB_REDFISH_SYSTEM_URI_NAME, logEntryID);
142484afc48bSJason M. Bills     logEntryJson["Name"] = "System Event Log Entry";
142584afc48bSJason M. Bills     logEntryJson["Id"] = logEntryID;
142684afc48bSJason M. Bills     logEntryJson["Message"] = std::move(msg);
142784afc48bSJason M. Bills     logEntryJson["MessageId"] = std::move(messageID);
142884afc48bSJason M. Bills     logEntryJson["MessageArgs"] = messageArgs;
142984afc48bSJason M. Bills     logEntryJson["EntryType"] = "Event";
143084afc48bSJason M. Bills     logEntryJson["Severity"] = message->messageSeverity;
143184afc48bSJason M. Bills     logEntryJson["Created"] = std::move(timestamp);
1432ac992cdeSJason M. Bills     return LogParseError::success;
1433c4bf6374SJason M. Bills }
1434c4bf6374SJason M. Bills 
143590896601SIgor Kanyuka inline bool fillEventLogLogEntryFromPropertyMap(
1436898f2aa2SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1437898f2aa2SEd Tanous     const dbus::utility::DBusPropertiesMap& resp,
1438898f2aa2SEd Tanous     nlohmann::json& objectToFillOut)
1439898f2aa2SEd Tanous {
1440262dcc1cSAlexander Hansen     std::optional<DbusEventLogEntry> optEntry =
1441262dcc1cSAlexander Hansen         fillDbusEventLogEntryFromPropertyMap(resp);
1442898f2aa2SEd Tanous 
1443262dcc1cSAlexander Hansen     if (!optEntry.has_value())
1444898f2aa2SEd Tanous     {
1445898f2aa2SEd Tanous         messages::internalError(asyncResp->res);
144690896601SIgor Kanyuka         return false;
1447898f2aa2SEd Tanous     }
1448262dcc1cSAlexander Hansen     DbusEventLogEntry entry = optEntry.value();
1449898f2aa2SEd Tanous 
1450898f2aa2SEd Tanous     objectToFillOut["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
1451898f2aa2SEd Tanous     objectToFillOut["@odata.id"] = boost::urls::format(
1452898f2aa2SEd Tanous         "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}",
1453262dcc1cSAlexander Hansen         BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(entry.Id));
1454898f2aa2SEd Tanous     objectToFillOut["Name"] = "System Event Log Entry";
1455262dcc1cSAlexander Hansen     objectToFillOut["Id"] = std::to_string(entry.Id);
1456262dcc1cSAlexander Hansen     objectToFillOut["Message"] = entry.Message;
1457262dcc1cSAlexander Hansen     objectToFillOut["Resolved"] = entry.Resolved;
1458262dcc1cSAlexander Hansen     std::optional<bool> notifyAction =
1459262dcc1cSAlexander Hansen         getProviderNotifyAction(entry.ServiceProviderNotify);
1460898f2aa2SEd Tanous     if (notifyAction)
1461898f2aa2SEd Tanous     {
1462898f2aa2SEd Tanous         objectToFillOut["ServiceProviderNotified"] = *notifyAction;
1463898f2aa2SEd Tanous     }
1464262dcc1cSAlexander Hansen     if ((entry.Resolution != nullptr) && !entry.Resolution->empty())
1465898f2aa2SEd Tanous     {
1466262dcc1cSAlexander Hansen         objectToFillOut["Resolution"] = *entry.Resolution;
1467898f2aa2SEd Tanous     }
1468898f2aa2SEd Tanous     objectToFillOut["EntryType"] = "Event";
1469262dcc1cSAlexander Hansen     objectToFillOut["Severity"] =
1470262dcc1cSAlexander Hansen         translateSeverityDbusToRedfish(entry.Severity);
1471898f2aa2SEd Tanous     objectToFillOut["Created"] =
1472262dcc1cSAlexander Hansen         redfish::time_utils::getDateTimeUintMs(entry.Timestamp);
1473898f2aa2SEd Tanous     objectToFillOut["Modified"] =
1474262dcc1cSAlexander Hansen         redfish::time_utils::getDateTimeUintMs(entry.UpdateTimestamp);
1475262dcc1cSAlexander Hansen     if (entry.Path != nullptr)
1476898f2aa2SEd Tanous     {
1477898f2aa2SEd Tanous         objectToFillOut["AdditionalDataURI"] = boost::urls::format(
1478898f2aa2SEd Tanous             "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}/attachment",
1479262dcc1cSAlexander Hansen             BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(entry.Id));
1480898f2aa2SEd Tanous     }
148190896601SIgor Kanyuka     return true;
1482898f2aa2SEd Tanous }
1483898f2aa2SEd Tanous 
1484b729096dSEd Tanous inline void afterLogEntriesGetManagedObjects(
1485b729096dSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1486b729096dSEd Tanous     const boost::system::error_code& ec,
1487b729096dSEd Tanous     const dbus::utility::ManagedObjectType& resp)
1488b729096dSEd Tanous {
1489b729096dSEd Tanous     if (ec)
1490b729096dSEd Tanous     {
1491b729096dSEd Tanous         // TODO Handle for specific error code
1492b729096dSEd Tanous         BMCWEB_LOG_ERROR("getLogEntriesIfaceData resp_handler got error {}",
1493b729096dSEd Tanous                          ec);
1494b729096dSEd Tanous         messages::internalError(asyncResp->res);
1495b729096dSEd Tanous         return;
1496b729096dSEd Tanous     }
1497b729096dSEd Tanous     nlohmann::json::array_t entriesArray;
1498b729096dSEd Tanous     for (const auto& objectPath : resp)
1499b729096dSEd Tanous     {
1500898f2aa2SEd Tanous         dbus::utility::DBusPropertiesMap propsFlattened;
1501bd79bce8SPatrick Williams         auto isEntry =
1502bd79bce8SPatrick Williams             std::ranges::find_if(objectPath.second, [](const auto& object) {
1503898f2aa2SEd Tanous                 return object.first == "xyz.openbmc_project.Logging.Entry";
1504898f2aa2SEd Tanous             });
1505898f2aa2SEd Tanous         if (isEntry == objectPath.second.end())
1506b729096dSEd Tanous         {
1507b729096dSEd Tanous             continue;
1508b729096dSEd Tanous         }
1509898f2aa2SEd Tanous         for (const auto& interfaceMap : objectPath.second)
1510b729096dSEd Tanous         {
1511898f2aa2SEd Tanous             for (const auto& propertyMap : interfaceMap.second)
1512b729096dSEd Tanous             {
1513898f2aa2SEd Tanous                 propsFlattened.emplace_back(propertyMap.first,
1514898f2aa2SEd Tanous                                             propertyMap.second);
1515b729096dSEd Tanous             }
1516b729096dSEd Tanous         }
151790896601SIgor Kanyuka         bool success = fillEventLogLogEntryFromPropertyMap(
151890896601SIgor Kanyuka             asyncResp, propsFlattened, entriesArray.emplace_back());
151990896601SIgor Kanyuka         if (!success)
152090896601SIgor Kanyuka         {
152190896601SIgor Kanyuka             return;
152290896601SIgor Kanyuka         }
1523b729096dSEd Tanous     }
1524898f2aa2SEd Tanous 
152590896601SIgor Kanyuka     redfish::json_util::sortJsonArrayByKey(entriesArray, "Id");
1526b729096dSEd Tanous     asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
1527b729096dSEd Tanous     asyncResp->res.jsonValue["Members"] = std::move(entriesArray);
1528b729096dSEd Tanous }
1529b729096dSEd Tanous 
1530599b9af3SAlexander Hansen inline void handleSystemsLogServiceEventLogLogEntryCollection(
1531599b9af3SAlexander Hansen     App& app, const crow::Request& req,
153222d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1533599b9af3SAlexander Hansen     const std::string& systemName)
1534599b9af3SAlexander Hansen {
1535c937d2bfSEd Tanous     query_param::QueryCapabilities capabilities = {
1536c937d2bfSEd Tanous         .canDelegateTop = true,
1537c937d2bfSEd Tanous         .canDelegateSkip = true,
1538c937d2bfSEd Tanous     };
1539c937d2bfSEd Tanous     query_param::Query delegatedQuery;
1540599b9af3SAlexander Hansen     if (!redfish::setUpRedfishRouteWithDelegation(app, req, asyncResp,
1541599b9af3SAlexander Hansen                                                   delegatedQuery, capabilities))
1542c4bf6374SJason M. Bills     {
1543c4bf6374SJason M. Bills         return;
1544c4bf6374SJason M. Bills     }
154525b54dbaSEd Tanous     if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
15467f3e84a1SEd Tanous     {
15477f3e84a1SEd Tanous         // Option currently returns no systems.  TBD
15487f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
15497f3e84a1SEd Tanous                                    systemName);
15507f3e84a1SEd Tanous         return;
15517f3e84a1SEd Tanous     }
1552253f11b8SEd Tanous     if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
155322d268cbSEd Tanous     {
155422d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
155522d268cbSEd Tanous                                    systemName);
155622d268cbSEd Tanous         return;
155722d268cbSEd Tanous     }
155822d268cbSEd Tanous 
15595143f7a5SJiaqing Zhao     size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
15603648c8beSEd Tanous     size_t skip = delegatedQuery.skip.value_or(0);
15613648c8beSEd Tanous 
15627e860f15SJohn Edward Broadbent     // Collections don't include the static data added by SubRoute
15637e860f15SJohn Edward Broadbent     // because it has a duplicate entry for members
1564c4bf6374SJason M. Bills     asyncResp->res.jsonValue["@odata.type"] =
1565c4bf6374SJason M. Bills         "#LogEntryCollection.LogEntryCollection";
1566c4bf6374SJason M. Bills     asyncResp->res.jsonValue["@odata.id"] =
1567253f11b8SEd Tanous         std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1568253f11b8SEd Tanous                     BMCWEB_REDFISH_SYSTEM_URI_NAME);
1569c4bf6374SJason M. Bills     asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1570c4bf6374SJason M. Bills     asyncResp->res.jsonValue["Description"] =
1571c4bf6374SJason M. Bills         "Collection of System Event Log Entries";
1572cb92c03bSAndrew Geissler 
15734978b63fSJason M. Bills     nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1574c4bf6374SJason M. Bills     logEntryArray = nlohmann::json::array();
15757e860f15SJohn Edward Broadbent     // Go through the log files and create a unique ID for each
15767e860f15SJohn Edward Broadbent     // entry
157795820184SJason M. Bills     std::vector<std::filesystem::path> redfishLogFiles;
157895820184SJason M. Bills     getRedfishLogFiles(redfishLogFiles);
1579b01bf299SEd Tanous     uint64_t entryCount = 0;
1580cd225da8SJason M. Bills     std::string logEntry;
158195820184SJason M. Bills 
15827e860f15SJohn Edward Broadbent     // Oldest logs are in the last file, so start there and loop
15837e860f15SJohn Edward Broadbent     // backwards
1584599b9af3SAlexander Hansen     for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++)
1585c4bf6374SJason M. Bills     {
1586cd225da8SJason M. Bills         std::ifstream logStream(*it);
158795820184SJason M. Bills         if (!logStream.is_open())
1588c4bf6374SJason M. Bills         {
1589c4bf6374SJason M. Bills             continue;
1590c4bf6374SJason M. Bills         }
1591c4bf6374SJason M. Bills 
1592e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
1593e85d6b16SJason M. Bills         bool firstEntry = true;
159495820184SJason M. Bills         while (std::getline(logStream, logEntry))
159595820184SJason M. Bills         {
1596c4bf6374SJason M. Bills             std::string idStr;
1597e85d6b16SJason M. Bills             if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1598c4bf6374SJason M. Bills             {
1599c4bf6374SJason M. Bills                 continue;
1600c4bf6374SJason M. Bills             }
1601e85d6b16SJason M. Bills             firstEntry = false;
1602e85d6b16SJason M. Bills 
1603de703c5dSJason M. Bills             nlohmann::json::object_t bmcLogEntry;
1604bd79bce8SPatrick Williams             LogParseError status =
1605bd79bce8SPatrick Williams                 fillEventLogEntryJson(idStr, logEntry, bmcLogEntry);
1606ac992cdeSJason M. Bills             if (status == LogParseError::messageIdNotInRegistry)
1607ac992cdeSJason M. Bills             {
1608ac992cdeSJason M. Bills                 continue;
1609ac992cdeSJason M. Bills             }
1610ac992cdeSJason M. Bills             if (status != LogParseError::success)
1611c4bf6374SJason M. Bills             {
1612c4bf6374SJason M. Bills                 messages::internalError(asyncResp->res);
1613c4bf6374SJason M. Bills                 return;
1614c4bf6374SJason M. Bills             }
1615de703c5dSJason M. Bills 
1616de703c5dSJason M. Bills             entryCount++;
1617de703c5dSJason M. Bills             // Handle paging using skip (number of entries to skip from the
1618de703c5dSJason M. Bills             // start) and top (number of entries to display)
16193648c8beSEd Tanous             if (entryCount <= skip || entryCount > skip + top)
1620de703c5dSJason M. Bills             {
1621de703c5dSJason M. Bills                 continue;
1622de703c5dSJason M. Bills             }
1623de703c5dSJason M. Bills 
1624b2ba3072SPatrick Williams             logEntryArray.emplace_back(std::move(bmcLogEntry));
1625c4bf6374SJason M. Bills         }
162695820184SJason M. Bills     }
1627c4bf6374SJason M. Bills     asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
16283648c8beSEd Tanous     if (skip + top < entryCount)
1629c4bf6374SJason M. Bills     {
1630599b9af3SAlexander Hansen         asyncResp->res.jsonValue["Members@odata.nextLink"] =
1631599b9af3SAlexander Hansen             boost::urls::format(
1632253f11b8SEd Tanous                 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries?$skip={}",
1633253f11b8SEd Tanous                 BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(skip + top));
1634c4bf6374SJason M. Bills     }
1635897967deSJason M. Bills }
1636897967deSJason M. Bills 
1637599b9af3SAlexander Hansen inline void requestRoutesJournalEventLogEntryCollection(App& app)
1638897967deSJason M. Bills {
1639599b9af3SAlexander Hansen     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
1640599b9af3SAlexander Hansen         .privileges(redfish::privileges::getLogEntryCollection)
1641599b9af3SAlexander Hansen         .methods(boost::beast::http::verb::get)(std::bind_front(
1642599b9af3SAlexander Hansen             handleSystemsLogServiceEventLogLogEntryCollection, std::ref(app)));
1643599b9af3SAlexander Hansen }
1644599b9af3SAlexander Hansen 
1645599b9af3SAlexander Hansen inline void handleSystemsLogServiceEventLogEntriesGet(
1646599b9af3SAlexander Hansen     App& app, const crow::Request& req,
16477e860f15SJohn Edward Broadbent     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1648599b9af3SAlexander Hansen     const std::string& systemName, const std::string& param)
1649599b9af3SAlexander Hansen {
16503ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
165145ca1b86SEd Tanous     {
165245ca1b86SEd Tanous         return;
165345ca1b86SEd Tanous     }
165425b54dbaSEd Tanous     if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
16557f3e84a1SEd Tanous     {
16567f3e84a1SEd Tanous         // Option currently returns no systems.  TBD
16577f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
16587f3e84a1SEd Tanous                                    systemName);
16597f3e84a1SEd Tanous         return;
16607f3e84a1SEd Tanous     }
166122d268cbSEd Tanous 
1662253f11b8SEd Tanous     if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
166322d268cbSEd Tanous     {
166422d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
166522d268cbSEd Tanous                                    systemName);
166622d268cbSEd Tanous         return;
166722d268cbSEd Tanous     }
166822d268cbSEd Tanous 
16697e860f15SJohn Edward Broadbent     const std::string& targetID = param;
16708d1b46d7Szhanghch05 
16717e860f15SJohn Edward Broadbent     // Go through the log files and check the unique ID for each
16727e860f15SJohn Edward Broadbent     // entry to find the target entry
1673897967deSJason M. Bills     std::vector<std::filesystem::path> redfishLogFiles;
1674897967deSJason M. Bills     getRedfishLogFiles(redfishLogFiles);
1675897967deSJason M. Bills     std::string logEntry;
1676897967deSJason M. Bills 
16777e860f15SJohn Edward Broadbent     // Oldest logs are in the last file, so start there and loop
16787e860f15SJohn Edward Broadbent     // backwards
1679599b9af3SAlexander Hansen     for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++)
1680897967deSJason M. Bills     {
1681897967deSJason M. Bills         std::ifstream logStream(*it);
1682897967deSJason M. Bills         if (!logStream.is_open())
1683897967deSJason M. Bills         {
1684897967deSJason M. Bills             continue;
1685897967deSJason M. Bills         }
1686897967deSJason M. Bills 
1687897967deSJason M. Bills         // Reset the unique ID on the first entry
1688897967deSJason M. Bills         bool firstEntry = true;
1689897967deSJason M. Bills         while (std::getline(logStream, logEntry))
1690897967deSJason M. Bills         {
1691897967deSJason M. Bills             std::string idStr;
1692897967deSJason M. Bills             if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1693897967deSJason M. Bills             {
1694897967deSJason M. Bills                 continue;
1695897967deSJason M. Bills             }
1696897967deSJason M. Bills             firstEntry = false;
1697897967deSJason M. Bills 
1698897967deSJason M. Bills             if (idStr == targetID)
1699897967deSJason M. Bills             {
1700de703c5dSJason M. Bills                 nlohmann::json::object_t bmcLogEntry;
1701bd79bce8SPatrick Williams                 LogParseError status =
1702bd79bce8SPatrick Williams                     fillEventLogEntryJson(idStr, logEntry, bmcLogEntry);
1703ac992cdeSJason M. Bills                 if (status != LogParseError::success)
1704897967deSJason M. Bills                 {
1705897967deSJason M. Bills                     messages::internalError(asyncResp->res);
1706897967deSJason M. Bills                     return;
1707897967deSJason M. Bills                 }
1708d405bb51SJason M. Bills                 asyncResp->res.jsonValue.update(bmcLogEntry);
1709897967deSJason M. Bills                 return;
1710897967deSJason M. Bills             }
1711897967deSJason M. Bills         }
1712897967deSJason M. Bills     }
1713897967deSJason M. Bills     // Requested ID was not found
17149db4ba25SJiaqing Zhao     messages::resourceNotFound(asyncResp->res, "LogEntry", targetID);
1715599b9af3SAlexander Hansen }
1716599b9af3SAlexander Hansen 
1717599b9af3SAlexander Hansen inline void requestRoutesJournalEventLogEntry(App& app)
1718599b9af3SAlexander Hansen {
1719599b9af3SAlexander Hansen     BMCWEB_ROUTE(
1720599b9af3SAlexander Hansen         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
1721599b9af3SAlexander Hansen         .privileges(redfish::privileges::getLogEntry)
1722599b9af3SAlexander Hansen         .methods(boost::beast::http::verb::get)(std::bind_front(
1723599b9af3SAlexander Hansen             handleSystemsLogServiceEventLogEntriesGet, std::ref(app)));
1724599b9af3SAlexander Hansen }
1725599b9af3SAlexander Hansen 
1726599b9af3SAlexander Hansen inline void dBusEventLogEntryCollection(
1727599b9af3SAlexander Hansen     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
1728599b9af3SAlexander Hansen {
1729599b9af3SAlexander Hansen     // Collections don't include the static data added by SubRoute
1730599b9af3SAlexander Hansen     // because it has a duplicate entry for members
1731599b9af3SAlexander Hansen     asyncResp->res.jsonValue["@odata.type"] =
1732599b9af3SAlexander Hansen         "#LogEntryCollection.LogEntryCollection";
1733599b9af3SAlexander Hansen     asyncResp->res.jsonValue["@odata.id"] =
1734599b9af3SAlexander Hansen         std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1735599b9af3SAlexander Hansen                     BMCWEB_REDFISH_SYSTEM_URI_NAME);
1736599b9af3SAlexander Hansen     asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1737599b9af3SAlexander Hansen     asyncResp->res.jsonValue["Description"] =
1738599b9af3SAlexander Hansen         "Collection of System Event Log Entries";
1739599b9af3SAlexander Hansen 
1740599b9af3SAlexander Hansen     // DBus implementation of EventLog/Entries
1741599b9af3SAlexander Hansen     // Make call to Logging Service to find all log entry objects
1742599b9af3SAlexander Hansen     sdbusplus::message::object_path path("/xyz/openbmc_project/logging");
1743599b9af3SAlexander Hansen     dbus::utility::getManagedObjects(
1744599b9af3SAlexander Hansen         "xyz.openbmc_project.Logging", path,
1745599b9af3SAlexander Hansen         [asyncResp](const boost::system::error_code& ec,
1746599b9af3SAlexander Hansen                     const dbus::utility::ManagedObjectType& resp) {
1747b729096dSEd Tanous             afterLogEntriesGetManagedObjects(asyncResp, ec, resp);
17487e860f15SJohn Edward Broadbent         });
174908a4e4b5SAnthony Wilson }
175008a4e4b5SAnthony Wilson 
17517e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app)
175208a4e4b5SAnthony Wilson {
175322d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
1754ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
1755002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1756002d39b4SEd Tanous             [&app](const crow::Request& req,
175722d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
175822d268cbSEd Tanous                    const std::string& systemName) {
17593ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
176045ca1b86SEd Tanous                 {
176145ca1b86SEd Tanous                     return;
176245ca1b86SEd Tanous                 }
176325b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
17647f3e84a1SEd Tanous                 {
17657f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
17667f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
17677f3e84a1SEd Tanous                                                systemName);
17687f3e84a1SEd Tanous                     return;
17697f3e84a1SEd Tanous                 }
1770253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
177122d268cbSEd Tanous                 {
177222d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
177322d268cbSEd Tanous                                                systemName);
177422d268cbSEd Tanous                     return;
177522d268cbSEd Tanous                 }
1776599b9af3SAlexander Hansen                 dBusEventLogEntryCollection(asyncResp);
1777599b9af3SAlexander Hansen             });
1778599b9af3SAlexander Hansen }
177922d268cbSEd Tanous 
1780bd79bce8SPatrick Williams inline void dBusEventLogEntryGet(
1781bd79bce8SPatrick Williams     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, std::string entryID)
1782599b9af3SAlexander Hansen {
1783599b9af3SAlexander Hansen     dbus::utility::escapePathForDbus(entryID);
178408a4e4b5SAnthony Wilson 
1785cb92c03bSAndrew Geissler     // DBus implementation of EventLog/Entries
1786cb92c03bSAndrew Geissler     // Make call to Logging Service to find all log entry objects
1787deae6a78SEd Tanous     dbus::utility::getAllProperties(
1788deae6a78SEd Tanous         "xyz.openbmc_project.Logging",
1789599b9af3SAlexander Hansen         "/xyz/openbmc_project/logging/entry/" + entryID, "",
1790599b9af3SAlexander Hansen         [asyncResp, entryID](const boost::system::error_code& ec,
1791599b9af3SAlexander Hansen                              const dbus::utility::DBusPropertiesMap& resp) {
1792599b9af3SAlexander Hansen             if (ec.value() == EBADR)
1793599b9af3SAlexander Hansen             {
1794599b9af3SAlexander Hansen                 messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1795599b9af3SAlexander Hansen                                            entryID);
1796599b9af3SAlexander Hansen                 return;
1797599b9af3SAlexander Hansen             }
1798cb92c03bSAndrew Geissler             if (ec)
1799cb92c03bSAndrew Geissler             {
1800bd79bce8SPatrick Williams                 BMCWEB_LOG_ERROR(
1801bd79bce8SPatrick Williams                     "EventLogEntry (DBus) resp_handler got error {}", ec);
1802cb92c03bSAndrew Geissler                 messages::internalError(asyncResp->res);
1803cb92c03bSAndrew Geissler                 return;
1804cb92c03bSAndrew Geissler             }
18059017faf2SAbhishek Patel 
1806898f2aa2SEd Tanous             fillEventLogLogEntryFromPropertyMap(asyncResp, resp,
1807898f2aa2SEd Tanous                                                 asyncResp->res.jsonValue);
1808599b9af3SAlexander Hansen         });
18097e860f15SJohn Edward Broadbent }
1810599b9af3SAlexander Hansen 
1811504af5a0SPatrick Williams inline void dBusEventLogEntryPatch(
1812504af5a0SPatrick Williams     const crow::Request& req,
1813599b9af3SAlexander Hansen     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1814599b9af3SAlexander Hansen     const std::string& entryId)
1815599b9af3SAlexander Hansen {
1816599b9af3SAlexander Hansen     std::optional<bool> resolved;
1817599b9af3SAlexander Hansen 
1818599b9af3SAlexander Hansen     if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", resolved))
1819599b9af3SAlexander Hansen     {
1820599b9af3SAlexander Hansen         return;
1821599b9af3SAlexander Hansen     }
1822599b9af3SAlexander Hansen     BMCWEB_LOG_DEBUG("Set Resolved");
1823599b9af3SAlexander Hansen 
1824599b9af3SAlexander Hansen     setDbusProperty(asyncResp, "Resolved", "xyz.openbmc_project.Logging",
1825599b9af3SAlexander Hansen                     "/xyz/openbmc_project/logging/entry/" + entryId,
1826599b9af3SAlexander Hansen                     "xyz.openbmc_project.Logging.Entry", "Resolved",
1827599b9af3SAlexander Hansen                     resolved.value_or(false));
1828599b9af3SAlexander Hansen }
1829599b9af3SAlexander Hansen 
1830bd79bce8SPatrick Williams inline void dBusEventLogEntryDelete(
1831bd79bce8SPatrick Williams     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, std::string entryID)
1832599b9af3SAlexander Hansen {
1833599b9af3SAlexander Hansen     BMCWEB_LOG_DEBUG("Do delete single event entries.");
1834599b9af3SAlexander Hansen 
1835599b9af3SAlexander Hansen     dbus::utility::escapePathForDbus(entryID);
1836599b9af3SAlexander Hansen 
1837599b9af3SAlexander Hansen     // Process response from Logging service.
1838599b9af3SAlexander Hansen     auto respHandler = [asyncResp,
1839599b9af3SAlexander Hansen                         entryID](const boost::system::error_code& ec) {
1840599b9af3SAlexander Hansen         BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done");
1841599b9af3SAlexander Hansen         if (ec)
1842599b9af3SAlexander Hansen         {
1843599b9af3SAlexander Hansen             if (ec.value() == EBADR)
1844599b9af3SAlexander Hansen             {
1845599b9af3SAlexander Hansen                 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
1846599b9af3SAlexander Hansen                 return;
1847599b9af3SAlexander Hansen             }
1848599b9af3SAlexander Hansen             // TODO Handle for specific error code
1849599b9af3SAlexander Hansen             BMCWEB_LOG_ERROR(
1850599b9af3SAlexander Hansen                 "EventLogEntry (DBus) doDelete respHandler got error {}", ec);
1851599b9af3SAlexander Hansen             asyncResp->res.result(
1852599b9af3SAlexander Hansen                 boost::beast::http::status::internal_server_error);
1853599b9af3SAlexander Hansen             return;
1854599b9af3SAlexander Hansen         }
1855599b9af3SAlexander Hansen 
1856599b9af3SAlexander Hansen         asyncResp->res.result(boost::beast::http::status::ok);
1857599b9af3SAlexander Hansen     };
1858599b9af3SAlexander Hansen 
1859599b9af3SAlexander Hansen     // Make call to Logging service to request Delete Log
1860*177612aaSEd Tanous     dbus::utility::async_method_call(
1861*177612aaSEd Tanous         asyncResp, respHandler, "xyz.openbmc_project.Logging",
1862599b9af3SAlexander Hansen         "/xyz/openbmc_project/logging/entry/" + entryID,
1863599b9af3SAlexander Hansen         "xyz.openbmc_project.Object.Delete", "Delete");
18647e860f15SJohn Edward Broadbent }
18657e860f15SJohn Edward Broadbent 
18667e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app)
18677e860f15SJohn Edward Broadbent {
18687e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
186922d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
1870ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
1871002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1872002d39b4SEd Tanous             [&app](const crow::Request& req,
18737e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1874898f2aa2SEd Tanous                    const std::string& systemName, const std::string& entryId) {
18753ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
18767e860f15SJohn Edward Broadbent                 {
187745ca1b86SEd Tanous                     return;
187845ca1b86SEd Tanous                 }
187925b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
18807f3e84a1SEd Tanous                 {
18817f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
18827f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
18837f3e84a1SEd Tanous                                                systemName);
18847f3e84a1SEd Tanous                     return;
18857f3e84a1SEd Tanous                 }
1886253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
188722d268cbSEd Tanous                 {
188822d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
188922d268cbSEd Tanous                                                systemName);
189022d268cbSEd Tanous                     return;
189122d268cbSEd Tanous                 }
189222d268cbSEd Tanous 
1893898f2aa2SEd Tanous                 dBusEventLogEntryGet(asyncResp, entryId);
18947e860f15SJohn Edward Broadbent             });
1895336e96c6SChicago Duan 
18967e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
189722d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
1898ed398213SEd Tanous         .privileges(redfish::privileges::patchLogEntry)
18997e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::patch)(
190045ca1b86SEd Tanous             [&app](const crow::Request& req,
19017e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
190222d268cbSEd Tanous                    const std::string& systemName, const std::string& entryId) {
19033ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
190445ca1b86SEd Tanous                 {
190545ca1b86SEd Tanous                     return;
190645ca1b86SEd Tanous                 }
190725b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
19087f3e84a1SEd Tanous                 {
19097f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
19107f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
19117f3e84a1SEd Tanous                                                systemName);
19127f3e84a1SEd Tanous                     return;
19137f3e84a1SEd Tanous                 }
1914253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
191522d268cbSEd Tanous                 {
191622d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
191722d268cbSEd Tanous                                                systemName);
191822d268cbSEd Tanous                     return;
191922d268cbSEd Tanous                 }
192075710de2SXiaochao Ma 
1921599b9af3SAlexander Hansen                 dBusEventLogEntryPatch(req, asyncResp, entryId);
19227e860f15SJohn Edward Broadbent             });
192375710de2SXiaochao Ma 
19247e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
192522d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
1926ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
1927ed398213SEd Tanous 
1928002d39b4SEd Tanous         .methods(boost::beast::http::verb::delete_)(
1929002d39b4SEd Tanous             [&app](const crow::Request& req,
1930002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
193122d268cbSEd Tanous                    const std::string& systemName, const std::string& param) {
19323ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
1933336e96c6SChicago Duan                 {
193445ca1b86SEd Tanous                     return;
193545ca1b86SEd Tanous                 }
193625b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
19377f3e84a1SEd Tanous                 {
19387f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
19397f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
19407f3e84a1SEd Tanous                                                systemName);
19417f3e84a1SEd Tanous                     return;
19427f3e84a1SEd Tanous                 }
1943253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
194422d268cbSEd Tanous                 {
194522d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
194622d268cbSEd Tanous                                                systemName);
194722d268cbSEd Tanous                     return;
194822d268cbSEd Tanous                 }
1949599b9af3SAlexander Hansen                 dBusEventLogEntryDelete(asyncResp, param);
19507e860f15SJohn Edward Broadbent             });
1951400fd1fbSAdriana Kobylak }
1952400fd1fbSAdriana Kobylak 
1953dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet(
1954fdd26906SClaire Weinan     crow::App& app, const crow::Request& req,
1955253f11b8SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1956253f11b8SEd Tanous     const std::string& managerId)
19571da66f75SEd Tanous {
19583ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
195945ca1b86SEd Tanous     {
196045ca1b86SEd Tanous         return;
196145ca1b86SEd Tanous     }
1962253f11b8SEd Tanous 
1963253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
1964253f11b8SEd Tanous     {
1965253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
1966253f11b8SEd Tanous         return;
1967253f11b8SEd Tanous     }
1968253f11b8SEd Tanous 
19697e860f15SJohn Edward Broadbent     // Collections don't include the static data added by SubRoute
19707e860f15SJohn Edward Broadbent     // because it has a duplicate entry for members
1971e1f26343SJason M. Bills     asyncResp->res.jsonValue["@odata.type"] =
19721da66f75SEd Tanous         "#LogServiceCollection.LogServiceCollection";
1973253f11b8SEd Tanous     asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
1974253f11b8SEd Tanous         "/redfish/v1/Managers/{}/LogServices", BMCWEB_REDFISH_MANAGER_URI_NAME);
1975002d39b4SEd Tanous     asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1976e1f26343SJason M. Bills     asyncResp->res.jsonValue["Description"] =
19771da66f75SEd Tanous         "Collection of LogServices for this Manager";
1978002d39b4SEd Tanous     nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1979c4bf6374SJason M. Bills     logServiceArray = nlohmann::json::array();
1980fdd26906SClaire Weinan 
198125b54dbaSEd Tanous     if constexpr (BMCWEB_REDFISH_BMC_JOURNAL)
198225b54dbaSEd Tanous     {
1983613dabeaSEd Tanous         nlohmann::json::object_t journal;
1984253f11b8SEd Tanous         journal["@odata.id"] =
1985253f11b8SEd Tanous             boost::urls::format("/redfish/v1/Managers/{}/LogServices/Journal",
1986253f11b8SEd Tanous                                 BMCWEB_REDFISH_MANAGER_URI_NAME);
1987b2ba3072SPatrick Williams         logServiceArray.emplace_back(std::move(journal));
198825b54dbaSEd Tanous     }
1989fdd26906SClaire Weinan 
1990fdd26906SClaire Weinan     asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size();
1991fdd26906SClaire Weinan 
199225b54dbaSEd Tanous     if constexpr (BMCWEB_REDFISH_DUMP_LOG)
199325b54dbaSEd Tanous     {
199415912159SGeorge Liu         constexpr std::array<std::string_view, 1> interfaces = {
19957a1dbc48SGeorge Liu             "xyz.openbmc_project.Collection.DeleteAll"};
19967a1dbc48SGeorge Liu         dbus::utility::getSubTreePaths(
19977a1dbc48SGeorge Liu             "/xyz/openbmc_project/dump", 0, interfaces,
199825b54dbaSEd Tanous             [asyncResp](const boost::system::error_code& ec,
199925b54dbaSEd Tanous                         const dbus::utility::MapperGetSubTreePathsResponse&
200025b54dbaSEd Tanous                             subTreePaths) {
2001fdd26906SClaire Weinan                 if (ec)
2002fdd26906SClaire Weinan                 {
200362598e31SEd Tanous                     BMCWEB_LOG_ERROR(
200462598e31SEd Tanous                         "handleBMCLogServicesCollectionGet respHandler got error {}",
200562598e31SEd Tanous                         ec);
2006bd79bce8SPatrick Williams                     // Assume that getting an error simply means there are no
2007bd79bce8SPatrick Williams                     // dump LogServices. Return without adding any error
2008bd79bce8SPatrick Williams                     // response.
2009fdd26906SClaire Weinan                     return;
2010fdd26906SClaire Weinan                 }
2011fdd26906SClaire Weinan 
2012fdd26906SClaire Weinan                 nlohmann::json& logServiceArrayLocal =
2013fdd26906SClaire Weinan                     asyncResp->res.jsonValue["Members"];
2014fdd26906SClaire Weinan 
2015fdd26906SClaire Weinan                 for (const std::string& path : subTreePaths)
2016fdd26906SClaire Weinan                 {
2017fdd26906SClaire Weinan                     if (path == "/xyz/openbmc_project/dump/bmc")
2018fdd26906SClaire Weinan                     {
2019613dabeaSEd Tanous                         nlohmann::json::object_t member;
2020253f11b8SEd Tanous                         member["@odata.id"] = boost::urls::format(
2021253f11b8SEd Tanous                             "/redfish/v1/Managers/{}/LogServices/Dump",
2022253f11b8SEd Tanous                             BMCWEB_REDFISH_MANAGER_URI_NAME);
2023b2ba3072SPatrick Williams                         logServiceArrayLocal.emplace_back(std::move(member));
2024fdd26906SClaire Weinan                     }
2025fdd26906SClaire Weinan                     else if (path == "/xyz/openbmc_project/dump/faultlog")
2026fdd26906SClaire Weinan                     {
2027613dabeaSEd Tanous                         nlohmann::json::object_t member;
2028253f11b8SEd Tanous                         member["@odata.id"] = boost::urls::format(
2029253f11b8SEd Tanous                             "/redfish/v1/Managers/{}/LogServices/FaultLog",
2030253f11b8SEd Tanous                             BMCWEB_REDFISH_MANAGER_URI_NAME);
2031b2ba3072SPatrick Williams                         logServiceArrayLocal.emplace_back(std::move(member));
2032fdd26906SClaire Weinan                     }
2033fdd26906SClaire Weinan                 }
2034fdd26906SClaire Weinan 
2035e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
2036fdd26906SClaire Weinan                     logServiceArrayLocal.size();
20377a1dbc48SGeorge Liu             });
203825b54dbaSEd Tanous     }
2039fdd26906SClaire Weinan }
2040fdd26906SClaire Weinan 
2041fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app)
2042fdd26906SClaire Weinan {
2043253f11b8SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/")
2044fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogServiceCollection)
2045fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(
2046dd72e87bSClaire Weinan             std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app)));
2047e1f26343SJason M. Bills }
2048e1f26343SJason M. Bills 
2049504af5a0SPatrick Williams inline void getDumpServiceInfo(
2050504af5a0SPatrick Williams     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2051fdd26906SClaire Weinan     const std::string& dumpType)
2052c9bb6861Sraviteja-b {
2053fdd26906SClaire Weinan     std::string dumpPath;
2054539d8c6bSEd Tanous     log_service::OverWritePolicy overWritePolicy =
2055539d8c6bSEd Tanous         log_service::OverWritePolicy::Invalid;
2056fdd26906SClaire Weinan     bool collectDiagnosticDataSupported = false;
2057fdd26906SClaire Weinan 
2058fdd26906SClaire Weinan     if (dumpType == "BMC")
205945ca1b86SEd Tanous     {
2060253f11b8SEd Tanous         dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/Dump",
2061253f11b8SEd Tanous                                BMCWEB_REDFISH_MANAGER_URI_NAME);
2062539d8c6bSEd Tanous         overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull;
2063fdd26906SClaire Weinan         collectDiagnosticDataSupported = true;
2064fdd26906SClaire Weinan     }
2065fdd26906SClaire Weinan     else if (dumpType == "FaultLog")
2066fdd26906SClaire Weinan     {
2067253f11b8SEd Tanous         dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/FaultLog",
2068253f11b8SEd Tanous                                BMCWEB_REDFISH_MANAGER_URI_NAME);
2069539d8c6bSEd Tanous         overWritePolicy = log_service::OverWritePolicy::Unknown;
2070fdd26906SClaire Weinan         collectDiagnosticDataSupported = false;
2071fdd26906SClaire Weinan     }
2072fdd26906SClaire Weinan     else if (dumpType == "System")
2073fdd26906SClaire Weinan     {
2074253f11b8SEd Tanous         dumpPath = std::format("/redfish/v1/Systems/{}/LogServices/Dump",
2075253f11b8SEd Tanous                                BMCWEB_REDFISH_SYSTEM_URI_NAME);
2076539d8c6bSEd Tanous         overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull;
2077fdd26906SClaire Weinan         collectDiagnosticDataSupported = true;
2078fdd26906SClaire Weinan     }
2079fdd26906SClaire Weinan     else
2080fdd26906SClaire Weinan     {
208162598e31SEd Tanous         BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}",
208262598e31SEd Tanous                          dumpType);
2083fdd26906SClaire Weinan         messages::internalError(asyncResp->res);
208445ca1b86SEd Tanous         return;
208545ca1b86SEd Tanous     }
2086fdd26906SClaire Weinan 
2087fdd26906SClaire Weinan     asyncResp->res.jsonValue["@odata.id"] = dumpPath;
2088fdd26906SClaire Weinan     asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService";
2089c9bb6861Sraviteja-b     asyncResp->res.jsonValue["Name"] = "Dump LogService";
2090fdd26906SClaire Weinan     asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService";
2091fdd26906SClaire Weinan     asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename();
2092539d8c6bSEd Tanous     asyncResp->res.jsonValue["OverWritePolicy"] = overWritePolicy;
20937c8c4058STejas Patil 
20947c8c4058STejas Patil     std::pair<std::string, std::string> redfishDateTimeOffset =
20952b82937eSEd Tanous         redfish::time_utils::getDateTimeOffsetNow();
20960fda0f12SGeorge Liu     asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
20977c8c4058STejas Patil     asyncResp->res.jsonValue["DateTimeLocalOffset"] =
20987c8c4058STejas Patil         redfishDateTimeOffset.second;
20997c8c4058STejas Patil 
2100fdd26906SClaire Weinan     asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries";
2101fdd26906SClaire Weinan 
2102fdd26906SClaire Weinan     if (collectDiagnosticDataSupported)
2103fdd26906SClaire Weinan     {
2104002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
21051476687dSEd Tanous                                 ["target"] =
2106fdd26906SClaire Weinan             dumpPath + "/Actions/LogService.CollectDiagnosticData";
2107fdd26906SClaire Weinan     }
21080d946211SClaire Weinan 
21090d946211SClaire Weinan     constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface};
21100d946211SClaire Weinan     dbus::utility::getSubTreePaths(
21110d946211SClaire Weinan         "/xyz/openbmc_project/dump", 0, interfaces,
21120d946211SClaire Weinan         [asyncResp, dumpType, dumpPath](
21130d946211SClaire Weinan             const boost::system::error_code& ec,
21140d946211SClaire Weinan             const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
21150d946211SClaire Weinan             if (ec)
21160d946211SClaire Weinan             {
2117bd79bce8SPatrick Williams                 BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}",
2118bd79bce8SPatrick Williams                                  ec);
21190d946211SClaire Weinan                 // Assume that getting an error simply means there are no dump
21200d946211SClaire Weinan                 // LogServices. Return without adding any error response.
21210d946211SClaire Weinan                 return;
21220d946211SClaire Weinan             }
212318f8f608SEd Tanous             std::string dbusDumpPath = getDumpPath(dumpType);
21240d946211SClaire Weinan             for (const std::string& path : subTreePaths)
21250d946211SClaire Weinan             {
21260d946211SClaire Weinan                 if (path == dbusDumpPath)
21270d946211SClaire Weinan                 {
2128bd79bce8SPatrick Williams                     asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]
2129bd79bce8SPatrick Williams                                             ["target"] =
21300d946211SClaire Weinan                         dumpPath + "/Actions/LogService.ClearLog";
21310d946211SClaire Weinan                     break;
21320d946211SClaire Weinan                 }
21330d946211SClaire Weinan             }
21340d946211SClaire Weinan         });
2135c9bb6861Sraviteja-b }
2136c9bb6861Sraviteja-b 
2137fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet(
2138fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2139253f11b8SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2140253f11b8SEd Tanous     const std::string& managerId)
21417e860f15SJohn Edward Broadbent {
21423ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
214345ca1b86SEd Tanous     {
214445ca1b86SEd Tanous         return;
214545ca1b86SEd Tanous     }
2146253f11b8SEd Tanous 
2147253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2148253f11b8SEd Tanous     {
2149253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2150253f11b8SEd Tanous         return;
2151253f11b8SEd Tanous     }
2152253f11b8SEd Tanous 
2153fdd26906SClaire Weinan     getDumpServiceInfo(asyncResp, dumpType);
2154fdd26906SClaire Weinan }
2155c9bb6861Sraviteja-b 
215622d268cbSEd Tanous inline void handleLogServicesDumpServiceComputerSystemGet(
215722d268cbSEd Tanous     crow::App& app, const crow::Request& req,
215822d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
215922d268cbSEd Tanous     const std::string& chassisId)
216022d268cbSEd Tanous {
216122d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
216222d268cbSEd Tanous     {
216322d268cbSEd Tanous         return;
216422d268cbSEd Tanous     }
2165253f11b8SEd Tanous     if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
216622d268cbSEd Tanous     {
216722d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
216822d268cbSEd Tanous         return;
216922d268cbSEd Tanous     }
217022d268cbSEd Tanous     getDumpServiceInfo(asyncResp, "System");
217122d268cbSEd Tanous }
217222d268cbSEd Tanous 
2173fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet(
2174fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2175253f11b8SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2176253f11b8SEd Tanous     const std::string& managerId)
2177fdd26906SClaire Weinan {
2178fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2179fdd26906SClaire Weinan     {
2180fdd26906SClaire Weinan         return;
2181fdd26906SClaire Weinan     }
2182253f11b8SEd Tanous 
2183253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2184253f11b8SEd Tanous     {
2185253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2186253f11b8SEd Tanous         return;
2187253f11b8SEd Tanous     }
2188fdd26906SClaire Weinan     getDumpEntryCollection(asyncResp, dumpType);
2189fdd26906SClaire Weinan }
2190fdd26906SClaire Weinan 
219122d268cbSEd Tanous inline void handleLogServicesDumpEntriesCollectionComputerSystemGet(
219222d268cbSEd Tanous     crow::App& app, const crow::Request& req,
219322d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
219422d268cbSEd Tanous     const std::string& chassisId)
219522d268cbSEd Tanous {
219622d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
219722d268cbSEd Tanous     {
219822d268cbSEd Tanous         return;
219922d268cbSEd Tanous     }
2200253f11b8SEd Tanous     if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
220122d268cbSEd Tanous     {
220222d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
220322d268cbSEd Tanous         return;
220422d268cbSEd Tanous     }
220522d268cbSEd Tanous     getDumpEntryCollection(asyncResp, "System");
220622d268cbSEd Tanous }
220722d268cbSEd Tanous 
2208fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet(
2209fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2210fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2211253f11b8SEd Tanous     const std::string& managerId, const std::string& dumpId)
2212fdd26906SClaire Weinan {
2213fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2214fdd26906SClaire Weinan     {
2215fdd26906SClaire Weinan         return;
2216fdd26906SClaire Weinan     }
2217253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2218253f11b8SEd Tanous     {
2219253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2220253f11b8SEd Tanous         return;
2221253f11b8SEd Tanous     }
2222fdd26906SClaire Weinan     getDumpEntryById(asyncResp, dumpId, dumpType);
2223fdd26906SClaire Weinan }
2224168d1b1aSCarson Labrado 
222522d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemGet(
222622d268cbSEd Tanous     crow::App& app, const crow::Request& req,
222722d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
222822d268cbSEd Tanous     const std::string& chassisId, const std::string& dumpId)
222922d268cbSEd Tanous {
223022d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
223122d268cbSEd Tanous     {
223222d268cbSEd Tanous         return;
223322d268cbSEd Tanous     }
2234253f11b8SEd Tanous     if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
223522d268cbSEd Tanous     {
223622d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
223722d268cbSEd Tanous         return;
223822d268cbSEd Tanous     }
223922d268cbSEd Tanous     getDumpEntryById(asyncResp, dumpId, "System");
224022d268cbSEd Tanous }
2241fdd26906SClaire Weinan 
2242fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete(
2243fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2244fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2245253f11b8SEd Tanous     const std::string& managerId, const std::string& dumpId)
2246fdd26906SClaire Weinan {
2247fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2248fdd26906SClaire Weinan     {
2249fdd26906SClaire Weinan         return;
2250fdd26906SClaire Weinan     }
2251253f11b8SEd Tanous 
2252253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2253253f11b8SEd Tanous     {
2254253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2255253f11b8SEd Tanous         return;
2256253f11b8SEd Tanous     }
2257fdd26906SClaire Weinan     deleteDumpEntry(asyncResp, dumpId, dumpType);
2258fdd26906SClaire Weinan }
2259fdd26906SClaire Weinan 
226022d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemDelete(
226122d268cbSEd Tanous     crow::App& app, const crow::Request& req,
226222d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
226322d268cbSEd Tanous     const std::string& chassisId, const std::string& dumpId)
226422d268cbSEd Tanous {
226522d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
226622d268cbSEd Tanous     {
226722d268cbSEd Tanous         return;
226822d268cbSEd Tanous     }
2269253f11b8SEd Tanous     if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
227022d268cbSEd Tanous     {
227122d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
227222d268cbSEd Tanous         return;
227322d268cbSEd Tanous     }
227422d268cbSEd Tanous     deleteDumpEntry(asyncResp, dumpId, "System");
227522d268cbSEd Tanous }
227622d268cbSEd Tanous 
2277168d1b1aSCarson Labrado inline void handleLogServicesDumpEntryDownloadGet(
2278168d1b1aSCarson Labrado     crow::App& app, const std::string& dumpType, const crow::Request& req,
2279168d1b1aSCarson Labrado     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2280253f11b8SEd Tanous     const std::string& managerId, const std::string& dumpId)
2281168d1b1aSCarson Labrado {
2282168d1b1aSCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2283168d1b1aSCarson Labrado     {
2284168d1b1aSCarson Labrado         return;
2285168d1b1aSCarson Labrado     }
2286253f11b8SEd Tanous 
2287253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2288253f11b8SEd Tanous     {
2289253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2290253f11b8SEd Tanous         return;
2291253f11b8SEd Tanous     }
2292168d1b1aSCarson Labrado     downloadDumpEntry(asyncResp, dumpId, dumpType);
2293168d1b1aSCarson Labrado }
2294168d1b1aSCarson Labrado 
2295168d1b1aSCarson Labrado inline void handleDBusEventLogEntryDownloadGet(
2296168d1b1aSCarson Labrado     crow::App& app, const std::string& dumpType, const crow::Request& req,
2297168d1b1aSCarson Labrado     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2298168d1b1aSCarson Labrado     const std::string& systemName, const std::string& entryID)
2299168d1b1aSCarson Labrado {
2300168d1b1aSCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2301168d1b1aSCarson Labrado     {
2302168d1b1aSCarson Labrado         return;
2303168d1b1aSCarson Labrado     }
2304168d1b1aSCarson Labrado     if (!http_helpers::isContentTypeAllowed(
2305168d1b1aSCarson Labrado             req.getHeaderValue("Accept"),
2306168d1b1aSCarson Labrado             http_helpers::ContentType::OctetStream, true))
2307168d1b1aSCarson Labrado     {
2308168d1b1aSCarson Labrado         asyncResp->res.result(boost::beast::http::status::bad_request);
2309168d1b1aSCarson Labrado         return;
2310168d1b1aSCarson Labrado     }
2311168d1b1aSCarson Labrado     downloadEventLogEntry(asyncResp, systemName, entryID, dumpType);
2312168d1b1aSCarson Labrado }
2313168d1b1aSCarson Labrado 
2314fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost(
2315fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2316253f11b8SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2317253f11b8SEd Tanous     const std::string& managerId)
2318fdd26906SClaire Weinan {
2319fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2320fdd26906SClaire Weinan     {
2321fdd26906SClaire Weinan         return;
2322fdd26906SClaire Weinan     }
2323253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2324253f11b8SEd Tanous     {
2325253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2326253f11b8SEd Tanous         return;
2327253f11b8SEd Tanous     }
2328253f11b8SEd Tanous 
2329fdd26906SClaire Weinan     createDump(asyncResp, req, dumpType);
2330fdd26906SClaire Weinan }
2331fdd26906SClaire Weinan 
233222d268cbSEd Tanous inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost(
233322d268cbSEd Tanous     crow::App& app, const crow::Request& req,
233422d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23357f3e84a1SEd Tanous     const std::string& systemName)
233622d268cbSEd Tanous {
233722d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
233822d268cbSEd Tanous     {
233922d268cbSEd Tanous         return;
234022d268cbSEd Tanous     }
23417f3e84a1SEd Tanous 
234225b54dbaSEd Tanous     if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
234322d268cbSEd Tanous     {
23447f3e84a1SEd Tanous         // Option currently returns no systems.  TBD
23457f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
23467f3e84a1SEd Tanous                                    systemName);
23477f3e84a1SEd Tanous         return;
23487f3e84a1SEd Tanous     }
2349253f11b8SEd Tanous     if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
23507f3e84a1SEd Tanous     {
23517f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
23527f3e84a1SEd Tanous                                    systemName);
235322d268cbSEd Tanous         return;
235422d268cbSEd Tanous     }
235522d268cbSEd Tanous     createDump(asyncResp, req, "System");
235622d268cbSEd Tanous }
235722d268cbSEd Tanous 
2358fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost(
2359fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2360253f11b8SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2361253f11b8SEd Tanous     const std::string& managerId)
2362fdd26906SClaire Weinan {
2363fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2364fdd26906SClaire Weinan     {
2365fdd26906SClaire Weinan         return;
2366fdd26906SClaire Weinan     }
2367253f11b8SEd Tanous 
2368253f11b8SEd Tanous     if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2369253f11b8SEd Tanous     {
2370253f11b8SEd Tanous         messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2371253f11b8SEd Tanous         return;
2372253f11b8SEd Tanous     }
2373fdd26906SClaire Weinan     clearDump(asyncResp, dumpType);
2374fdd26906SClaire Weinan }
2375fdd26906SClaire Weinan 
237622d268cbSEd Tanous inline void handleLogServicesDumpClearLogComputerSystemPost(
237722d268cbSEd Tanous     crow::App& app, const crow::Request& req,
237822d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23797f3e84a1SEd Tanous     const std::string& systemName)
238022d268cbSEd Tanous {
238122d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
238222d268cbSEd Tanous     {
238322d268cbSEd Tanous         return;
238422d268cbSEd Tanous     }
238525b54dbaSEd Tanous     if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
238622d268cbSEd Tanous     {
23877f3e84a1SEd Tanous         // Option currently returns no systems.  TBD
23887f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
23897f3e84a1SEd Tanous                                    systemName);
23907f3e84a1SEd Tanous         return;
23917f3e84a1SEd Tanous     }
2392253f11b8SEd Tanous     if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
23937f3e84a1SEd Tanous     {
23947f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
23957f3e84a1SEd Tanous                                    systemName);
239622d268cbSEd Tanous         return;
239722d268cbSEd Tanous     }
239822d268cbSEd Tanous     clearDump(asyncResp, "System");
239922d268cbSEd Tanous }
240022d268cbSEd Tanous 
2401fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app)
2402fdd26906SClaire Weinan {
2403253f11b8SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/")
2404fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogService)
2405fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2406fdd26906SClaire Weinan             handleLogServicesDumpServiceGet, std::ref(app), "BMC"));
2407fdd26906SClaire Weinan }
2408fdd26906SClaire Weinan 
2409fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app)
2410fdd26906SClaire Weinan {
2411253f11b8SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/")
2412fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntryCollection)
2413fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2414fdd26906SClaire Weinan             handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC"));
2415c9bb6861Sraviteja-b }
2416c9bb6861Sraviteja-b 
24177e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app)
2418c9bb6861Sraviteja-b {
24197e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2420253f11b8SEd Tanous                  "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/")
2421ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
2422fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2423fdd26906SClaire Weinan             handleLogServicesDumpEntryGet, std::ref(app), "BMC"));
2424fdd26906SClaire Weinan 
24257e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2426253f11b8SEd Tanous                  "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/")
2427ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
2428fdd26906SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
2429fdd26906SClaire Weinan             handleLogServicesDumpEntryDelete, std::ref(app), "BMC"));
2430c9bb6861Sraviteja-b }
2431c9bb6861Sraviteja-b 
2432168d1b1aSCarson Labrado inline void requestRoutesBMCDumpEntryDownload(App& app)
2433168d1b1aSCarson Labrado {
2434168d1b1aSCarson Labrado     BMCWEB_ROUTE(
2435168d1b1aSCarson Labrado         app,
2436253f11b8SEd Tanous         "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/attachment/")
2437168d1b1aSCarson Labrado         .privileges(redfish::privileges::getLogEntry)
2438168d1b1aSCarson Labrado         .methods(boost::beast::http::verb::get)(std::bind_front(
2439168d1b1aSCarson Labrado             handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC"));
2440168d1b1aSCarson Labrado }
2441168d1b1aSCarson Labrado 
24427e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app)
2443c9bb6861Sraviteja-b {
24440fda0f12SGeorge Liu     BMCWEB_ROUTE(
24450fda0f12SGeorge Liu         app,
2446253f11b8SEd Tanous         "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
2447ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
24487e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
2449fdd26906SClaire Weinan             std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost,
2450fdd26906SClaire Weinan                             std::ref(app), "BMC"));
2451a43be80fSAsmitha Karunanithi }
2452a43be80fSAsmitha Karunanithi 
24537e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app)
245480319af1SAsmitha Karunanithi {
24550fda0f12SGeorge Liu     BMCWEB_ROUTE(
24560fda0f12SGeorge Liu         app,
2457253f11b8SEd Tanous         "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
2458ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
2459fdd26906SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
2460fdd26906SClaire Weinan             handleLogServicesDumpClearLogPost, std::ref(app), "BMC"));
246145ca1b86SEd Tanous }
2462fdd26906SClaire Weinan 
2463168d1b1aSCarson Labrado inline void requestRoutesDBusEventLogEntryDownload(App& app)
2464168d1b1aSCarson Labrado {
2465168d1b1aSCarson Labrado     BMCWEB_ROUTE(
2466168d1b1aSCarson Labrado         app,
24679e9d99daSRavi Teja         "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/")
2468168d1b1aSCarson Labrado         .privileges(redfish::privileges::getLogEntry)
2469168d1b1aSCarson Labrado         .methods(boost::beast::http::verb::get)(std::bind_front(
2470168d1b1aSCarson Labrado             handleDBusEventLogEntryDownloadGet, std::ref(app), "System"));
2471168d1b1aSCarson Labrado }
2472168d1b1aSCarson Labrado 
2473fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app)
2474fdd26906SClaire Weinan {
2475253f11b8SEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/")
2476fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogService)
2477fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2478fdd26906SClaire Weinan             handleLogServicesDumpServiceGet, std::ref(app), "FaultLog"));
2479fdd26906SClaire Weinan }
2480fdd26906SClaire Weinan 
2481fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app)
2482fdd26906SClaire Weinan {
2483253f11b8SEd Tanous     BMCWEB_ROUTE(app,
2484253f11b8SEd Tanous                  "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/")
2485fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntryCollection)
2486fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(
2487fdd26906SClaire Weinan             std::bind_front(handleLogServicesDumpEntriesCollectionGet,
2488fdd26906SClaire Weinan                             std::ref(app), "FaultLog"));
2489fdd26906SClaire Weinan }
2490fdd26906SClaire Weinan 
2491fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app)
2492fdd26906SClaire Weinan {
2493253f11b8SEd Tanous     BMCWEB_ROUTE(
2494253f11b8SEd Tanous         app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/")
2495fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntry)
2496fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2497fdd26906SClaire Weinan             handleLogServicesDumpEntryGet, std::ref(app), "FaultLog"));
2498fdd26906SClaire Weinan 
2499253f11b8SEd Tanous     BMCWEB_ROUTE(
2500253f11b8SEd Tanous         app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/")
2501fdd26906SClaire Weinan         .privileges(redfish::privileges::deleteLogEntry)
2502fdd26906SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
2503fdd26906SClaire Weinan             handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog"));
2504fdd26906SClaire Weinan }
2505fdd26906SClaire Weinan 
2506fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app)
2507fdd26906SClaire Weinan {
2508fdd26906SClaire Weinan     BMCWEB_ROUTE(
2509fdd26906SClaire Weinan         app,
2510253f11b8SEd Tanous         "/redfish/v1/Managers/<str>/LogServices/FaultLog/Actions/LogService.ClearLog/")
2511fdd26906SClaire Weinan         .privileges(redfish::privileges::postLogService)
2512fdd26906SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
2513fdd26906SClaire Weinan             handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog"));
25145cb1dd27SAsmitha Karunanithi }
25155cb1dd27SAsmitha Karunanithi 
25167e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app)
25175cb1dd27SAsmitha Karunanithi {
251822d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/")
2519ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
25206ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
252122d268cbSEd Tanous             handleLogServicesDumpServiceComputerSystemGet, std::ref(app)));
25225cb1dd27SAsmitha Karunanithi }
25235cb1dd27SAsmitha Karunanithi 
25247e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app)
25257e860f15SJohn Edward Broadbent {
252622d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/")
2527ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
252822d268cbSEd Tanous         .methods(boost::beast::http::verb::get)(std::bind_front(
252922d268cbSEd Tanous             handleLogServicesDumpEntriesCollectionComputerSystemGet,
253022d268cbSEd Tanous             std::ref(app)));
25315cb1dd27SAsmitha Karunanithi }
25325cb1dd27SAsmitha Karunanithi 
25337e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app)
25345cb1dd27SAsmitha Karunanithi {
25357e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
253622d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
2537ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
25386ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
253922d268cbSEd Tanous             handleLogServicesDumpEntryComputerSystemGet, std::ref(app)));
25408d1b46d7Szhanghch05 
25417e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
254222d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
2543ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
25446ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
254522d268cbSEd Tanous             handleLogServicesDumpEntryComputerSystemDelete, std::ref(app)));
25465cb1dd27SAsmitha Karunanithi }
2547c9bb6861Sraviteja-b 
25487e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app)
2549c9bb6861Sraviteja-b {
25500fda0f12SGeorge Liu     BMCWEB_ROUTE(
25510fda0f12SGeorge Liu         app,
255222d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
2553ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
255422d268cbSEd Tanous         .methods(boost::beast::http::verb::post)(std::bind_front(
255522d268cbSEd Tanous             handleLogServicesDumpCollectDiagnosticDataComputerSystemPost,
255622d268cbSEd Tanous             std::ref(app)));
2557a43be80fSAsmitha Karunanithi }
2558a43be80fSAsmitha Karunanithi 
25597e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app)
2560a43be80fSAsmitha Karunanithi {
25610fda0f12SGeorge Liu     BMCWEB_ROUTE(
25620fda0f12SGeorge Liu         app,
256322d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
2564ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
25656ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
256622d268cbSEd Tanous             handleLogServicesDumpClearLogComputerSystemPost, std::ref(app)));
2567013487e5Sraviteja-b }
2568013487e5Sraviteja-b 
25697e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app)
25701da66f75SEd Tanous {
25713946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
25723946028dSAppaRao Puli     // method for security reasons.
25731da66f75SEd Tanous     /**
25741da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
25751da66f75SEd Tanous      */
257622d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/")
2577ed398213SEd Tanous         // This is incorrect, should be:
2578ed398213SEd Tanous         //.privileges(redfish::privileges::getLogService)
2579432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
2580bd79bce8SPatrick Williams         .methods(
2581bd79bce8SPatrick Williams             boost::beast::http::verb::
2582bd79bce8SPatrick Williams                 get)([&app](const crow::Request& req,
258322d268cbSEd Tanous                             const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
258422d268cbSEd Tanous                             const std::string& systemName) {
25853ba00073SCarson Labrado             if (!redfish::setUpRedfishRoute(app, req, asyncResp))
258645ca1b86SEd Tanous             {
258745ca1b86SEd Tanous                 return;
258845ca1b86SEd Tanous             }
258925b54dbaSEd Tanous             if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
25907f3e84a1SEd Tanous             {
25917f3e84a1SEd Tanous                 // Option currently returns no systems.  TBD
25927f3e84a1SEd Tanous                 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
25937f3e84a1SEd Tanous                                            systemName);
25947f3e84a1SEd Tanous                 return;
25957f3e84a1SEd Tanous             }
2596253f11b8SEd Tanous             if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
259722d268cbSEd Tanous             {
259822d268cbSEd Tanous                 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
259922d268cbSEd Tanous                                            systemName);
260022d268cbSEd Tanous                 return;
260122d268cbSEd Tanous             }
260222d268cbSEd Tanous 
26037e860f15SJohn Edward Broadbent             // Copy over the static data to include the entries added by
26047e860f15SJohn Edward Broadbent             // SubRoute
26050f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2606253f11b8SEd Tanous                 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump",
2607253f11b8SEd Tanous                             BMCWEB_REDFISH_SYSTEM_URI_NAME);
2608e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
26098e6c099aSJason M. Bills                 "#LogService.v1_2_0.LogService";
26104f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
26114f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
261215b89725SV-Sanjana             asyncResp->res.jsonValue["Id"] = "Crashdump";
2613539d8c6bSEd Tanous             asyncResp->res.jsonValue["OverWritePolicy"] =
2614539d8c6bSEd Tanous                 log_service::OverWritePolicy::WrapsWhenFull;
2615e1f26343SJason M. Bills             asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
26167c8c4058STejas Patil 
26177c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
26182b82937eSEd Tanous                 redfish::time_utils::getDateTimeOffsetNow();
26197c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
26207c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
26217c8c4058STejas Patil                 redfishDateTimeOffset.second;
26227c8c4058STejas Patil 
2623bd79bce8SPatrick Williams             asyncResp->res.jsonValue["Entries"]["@odata.id"] = std::format(
2624bd79bce8SPatrick Williams                 "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries",
2625253f11b8SEd Tanous                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
2626253f11b8SEd Tanous             asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]
2627253f11b8SEd Tanous                                     ["target"] = std::format(
2628253f11b8SEd Tanous                 "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.ClearLog",
2629253f11b8SEd Tanous                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
2630bd79bce8SPatrick Williams             asyncResp->res
2631bd79bce8SPatrick Williams                 .jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
2632253f11b8SEd Tanous                           ["target"] = std::format(
2633253f11b8SEd Tanous                 "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData",
2634253f11b8SEd Tanous                 BMCWEB_REDFISH_SYSTEM_URI_NAME);
26357e860f15SJohn Edward Broadbent         });
26361da66f75SEd Tanous }
26371da66f75SEd Tanous 
26387e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app)
26395b61b5e8SJason M. Bills {
26400fda0f12SGeorge Liu     BMCWEB_ROUTE(
26410fda0f12SGeorge Liu         app,
264222d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/")
2643ed398213SEd Tanous         // This is incorrect, should be:
2644ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2645432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
26467e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
264745ca1b86SEd Tanous             [&app](const crow::Request& req,
264822d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
264922d268cbSEd Tanous                    const std::string& systemName) {
26503ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
265145ca1b86SEd Tanous                 {
265245ca1b86SEd Tanous                     return;
265345ca1b86SEd Tanous                 }
265425b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
26557f3e84a1SEd Tanous                 {
26567f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
26577f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
26587f3e84a1SEd Tanous                                                systemName);
26597f3e84a1SEd Tanous                     return;
26607f3e84a1SEd Tanous                 }
2661253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
266222d268cbSEd Tanous                 {
266322d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
266422d268cbSEd Tanous                                                systemName);
266522d268cbSEd Tanous                     return;
266622d268cbSEd Tanous                 }
2667*177612aaSEd Tanous                 dbus::utility::async_method_call(
2668*177612aaSEd Tanous                     asyncResp,
26695e7e2dc5SEd Tanous                     [asyncResp](const boost::system::error_code& ec,
2670cb13a392SEd Tanous                                 const std::string&) {
26715b61b5e8SJason M. Bills                         if (ec)
26725b61b5e8SJason M. Bills                         {
26735b61b5e8SJason M. Bills                             messages::internalError(asyncResp->res);
26745b61b5e8SJason M. Bills                             return;
26755b61b5e8SJason M. Bills                         }
26765b61b5e8SJason M. Bills                         messages::success(asyncResp->res);
26775b61b5e8SJason M. Bills                     },
2678bd79bce8SPatrick Williams                     crashdumpObject, crashdumpPath, deleteAllInterface,
2679bd79bce8SPatrick Williams                     "DeleteAll");
26807e860f15SJohn Edward Broadbent             });
26815b61b5e8SJason M. Bills }
26825b61b5e8SJason M. Bills 
2683504af5a0SPatrick Williams inline void logCrashdumpEntry(
2684504af5a0SPatrick Williams     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
26858d1b46d7Szhanghch05     const std::string& logID, nlohmann::json& logEntryJson)
2686e855dd28SJason M. Bills {
2687043a0536SJohnathan Mantey     auto getStoredLogCallback =
2688b9d36b47SEd Tanous         [asyncResp, logID,
26895e7e2dc5SEd Tanous          &logEntryJson](const boost::system::error_code& ec,
2690b9d36b47SEd Tanous                         const dbus::utility::DBusPropertiesMap& params) {
2691e855dd28SJason M. Bills             if (ec)
2692e855dd28SJason M. Bills             {
269362598e31SEd Tanous                 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
26941ddcf01aSJason M. Bills                 if (ec.value() ==
26951ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
26961ddcf01aSJason M. Bills                 {
2697bd79bce8SPatrick Williams                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2698bd79bce8SPatrick Williams                                                logID);
26991ddcf01aSJason M. Bills                 }
27001ddcf01aSJason M. Bills                 else
27011ddcf01aSJason M. Bills                 {
2702e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
27031ddcf01aSJason M. Bills                 }
2704e855dd28SJason M. Bills                 return;
2705e855dd28SJason M. Bills             }
2706043a0536SJohnathan Mantey 
2707043a0536SJohnathan Mantey             std::string timestamp{};
2708043a0536SJohnathan Mantey             std::string filename{};
2709043a0536SJohnathan Mantey             std::string logfile{};
27102c70f800SEd Tanous             parseCrashdumpParameters(params, filename, timestamp, logfile);
2711043a0536SJohnathan Mantey 
2712043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2713e855dd28SJason M. Bills             {
27149db4ba25SJiaqing Zhao                 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
2715e855dd28SJason M. Bills                 return;
2716e855dd28SJason M. Bills             }
2717e855dd28SJason M. Bills 
2718043a0536SJohnathan Mantey             std::string crashdumpURI =
2719bd79bce8SPatrick Williams                 std::format(
2720bd79bce8SPatrick Williams                     "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/",
2721253f11b8SEd Tanous                     BMCWEB_REDFISH_SYSTEM_URI_NAME) +
2722043a0536SJohnathan Mantey                 logID + "/" + filename;
272384afc48bSJason M. Bills             nlohmann::json::object_t logEntry;
27249c11a172SVijay Lobo             logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
2725ef4c65b7SEd Tanous             logEntry["@odata.id"] = boost::urls::format(
2726253f11b8SEd Tanous                 "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/{}",
2727253f11b8SEd Tanous                 BMCWEB_REDFISH_SYSTEM_URI_NAME, logID);
272884afc48bSJason M. Bills             logEntry["Name"] = "CPU Crashdump";
272984afc48bSJason M. Bills             logEntry["Id"] = logID;
2730539d8c6bSEd Tanous             logEntry["EntryType"] = log_entry::LogEntryType::Oem;
273184afc48bSJason M. Bills             logEntry["AdditionalDataURI"] = std::move(crashdumpURI);
273284afc48bSJason M. Bills             logEntry["DiagnosticDataType"] = "OEM";
273384afc48bSJason M. Bills             logEntry["OEMDiagnosticDataType"] = "PECICrashdump";
273484afc48bSJason M. Bills             logEntry["Created"] = std::move(timestamp);
27352b20ef6eSJason M. Bills 
27362b20ef6eSJason M. Bills             // If logEntryJson references an array of LogEntry resources
27372b20ef6eSJason M. Bills             // ('Members' list), then push this as a new entry, otherwise set it
27382b20ef6eSJason M. Bills             // directly
27392b20ef6eSJason M. Bills             if (logEntryJson.is_array())
27402b20ef6eSJason M. Bills             {
27412b20ef6eSJason M. Bills                 logEntryJson.push_back(logEntry);
27422b20ef6eSJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
27432b20ef6eSJason M. Bills                     logEntryJson.size();
27442b20ef6eSJason M. Bills             }
27452b20ef6eSJason M. Bills             else
27462b20ef6eSJason M. Bills             {
2747d405bb51SJason M. Bills                 logEntryJson.update(logEntry);
27482b20ef6eSJason M. Bills             }
2749e855dd28SJason M. Bills         };
2750deae6a78SEd Tanous     dbus::utility::getAllProperties(
2751deae6a78SEd Tanous         crashdumpObject, crashdumpPath + std::string("/") + logID,
2752deae6a78SEd Tanous         crashdumpInterface, std::move(getStoredLogCallback));
2753e855dd28SJason M. Bills }
2754e855dd28SJason M. Bills 
27557e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app)
27561da66f75SEd Tanous {
27573946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
27583946028dSAppaRao Puli     // method for security reasons.
27591da66f75SEd Tanous     /**
27601da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
27611da66f75SEd Tanous      */
27627e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
276322d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/")
2764ed398213SEd Tanous         // This is incorrect, should be.
2765ed398213SEd Tanous         //.privileges(redfish::privileges::postLogEntryCollection)
2766432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
2767bd79bce8SPatrick Williams         .methods(
2768bd79bce8SPatrick Williams             boost::beast::http::verb::
2769bd79bce8SPatrick Williams                 get)([&app](const crow::Request& req,
277022d268cbSEd Tanous                             const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
277122d268cbSEd Tanous                             const std::string& systemName) {
27723ba00073SCarson Labrado             if (!redfish::setUpRedfishRoute(app, req, asyncResp))
277345ca1b86SEd Tanous             {
277445ca1b86SEd Tanous                 return;
277545ca1b86SEd Tanous             }
277625b54dbaSEd Tanous             if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
27777f3e84a1SEd Tanous             {
27787f3e84a1SEd Tanous                 // Option currently returns no systems.  TBD
27797f3e84a1SEd Tanous                 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
27807f3e84a1SEd Tanous                                            systemName);
27817f3e84a1SEd Tanous                 return;
27827f3e84a1SEd Tanous             }
2783253f11b8SEd Tanous             if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
278422d268cbSEd Tanous             {
278522d268cbSEd Tanous                 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
278622d268cbSEd Tanous                                            systemName);
278722d268cbSEd Tanous                 return;
278822d268cbSEd Tanous             }
278922d268cbSEd Tanous 
27907a1dbc48SGeorge Liu             constexpr std::array<std::string_view, 1> interfaces = {
27917a1dbc48SGeorge Liu                 crashdumpInterface};
27927a1dbc48SGeorge Liu             dbus::utility::getSubTreePaths(
27937a1dbc48SGeorge Liu                 "/", 0, interfaces,
27947a1dbc48SGeorge Liu                 [asyncResp](const boost::system::error_code& ec,
27952b20ef6eSJason M. Bills                             const std::vector<std::string>& resp) {
27961da66f75SEd Tanous                     if (ec)
27971da66f75SEd Tanous                     {
27981da66f75SEd Tanous                         if (ec.value() !=
27991da66f75SEd Tanous                             boost::system::errc::no_such_file_or_directory)
28001da66f75SEd Tanous                         {
280162598e31SEd Tanous                             BMCWEB_LOG_DEBUG("failed to get entries ec: {}",
280262598e31SEd Tanous                                              ec.message());
2803f12894f8SJason M. Bills                             messages::internalError(asyncResp->res);
28041da66f75SEd Tanous                             return;
28051da66f75SEd Tanous                         }
28061da66f75SEd Tanous                     }
2807e1f26343SJason M. Bills                     asyncResp->res.jsonValue["@odata.type"] =
28081da66f75SEd Tanous                         "#LogEntryCollection.LogEntryCollection";
2809253f11b8SEd Tanous                     asyncResp->res.jsonValue["@odata.id"] = std::format(
2810253f11b8SEd Tanous                         "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries",
2811253f11b8SEd Tanous                         BMCWEB_REDFISH_SYSTEM_URI_NAME);
2812bd79bce8SPatrick Williams                     asyncResp->res.jsonValue["Name"] =
2813bd79bce8SPatrick Williams                         "Open BMC Crashdump Entries";
2814e1f26343SJason M. Bills                     asyncResp->res.jsonValue["Description"] =
2815424c4176SJason M. Bills                         "Collection of Crashdump Entries";
2816bd79bce8SPatrick Williams                     asyncResp->res.jsonValue["Members"] =
2817bd79bce8SPatrick Williams                         nlohmann::json::array();
2818a2dd60a6SBrandon Kim                     asyncResp->res.jsonValue["Members@odata.count"] = 0;
28192b20ef6eSJason M. Bills 
28202b20ef6eSJason M. Bills                     for (const std::string& path : resp)
28211da66f75SEd Tanous                     {
28222b20ef6eSJason M. Bills                         const sdbusplus::message::object_path objPath(path);
2823e855dd28SJason M. Bills                         // Get the log ID
28242b20ef6eSJason M. Bills                         std::string logID = objPath.filename();
28252b20ef6eSJason M. Bills                         if (logID.empty())
28261da66f75SEd Tanous                         {
2827e855dd28SJason M. Bills                             continue;
28281da66f75SEd Tanous                         }
2829e855dd28SJason M. Bills                         // Add the log entry to the array
28302b20ef6eSJason M. Bills                         logCrashdumpEntry(asyncResp, logID,
28312b20ef6eSJason M. Bills                                           asyncResp->res.jsonValue["Members"]);
28321da66f75SEd Tanous                     }
28337a1dbc48SGeorge Liu                 });
28347e860f15SJohn Edward Broadbent         });
28351da66f75SEd Tanous }
28361da66f75SEd Tanous 
28377e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app)
28381da66f75SEd Tanous {
28393946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
28403946028dSAppaRao Puli     // method for security reasons.
28411da66f75SEd Tanous 
28427e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
284322d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/")
2844ed398213SEd Tanous         // this is incorrect, should be
2845ed398213SEd Tanous         // .privileges(redfish::privileges::getLogEntry)
2846432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
28477e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
284845ca1b86SEd Tanous             [&app](const crow::Request& req,
28497e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
285022d268cbSEd Tanous                    const std::string& systemName, const std::string& param) {
28513ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
285245ca1b86SEd Tanous                 {
285345ca1b86SEd Tanous                     return;
285445ca1b86SEd Tanous                 }
285525b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
28567f3e84a1SEd Tanous                 {
28577f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
28587f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
28597f3e84a1SEd Tanous                                                systemName);
28607f3e84a1SEd Tanous                     return;
28617f3e84a1SEd Tanous                 }
2862253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
286322d268cbSEd Tanous                 {
286422d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
286522d268cbSEd Tanous                                                systemName);
286622d268cbSEd Tanous                     return;
286722d268cbSEd Tanous                 }
28687e860f15SJohn Edward Broadbent                 const std::string& logID = param;
2869e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
28707e860f15SJohn Edward Broadbent             });
2871e855dd28SJason M. Bills }
2872e855dd28SJason M. Bills 
28737e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app)
2874e855dd28SJason M. Bills {
28753946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
28763946028dSAppaRao Puli     // method for security reasons.
28777e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
28787e860f15SJohn Edward Broadbent         app,
287922d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/")
2880ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
28817e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
2882a4ce114aSNan Zhou             [](const crow::Request& req,
28837e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
288422d268cbSEd Tanous                const std::string& systemName, const std::string& logID,
288522d268cbSEd Tanous                const std::string& fileName) {
2886bd79bce8SPatrick Williams                 // Do not call getRedfishRoute here since the crashdump file is
2887bd79bce8SPatrick Williams                 // not a Redfish resource.
288822d268cbSEd Tanous 
288925b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
28907f3e84a1SEd Tanous                 {
28917f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
28927f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
28937f3e84a1SEd Tanous                                                systemName);
28947f3e84a1SEd Tanous                     return;
28957f3e84a1SEd Tanous                 }
2896253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
289722d268cbSEd Tanous                 {
289822d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
289922d268cbSEd Tanous                                                systemName);
290022d268cbSEd Tanous                     return;
290122d268cbSEd Tanous                 }
290222d268cbSEd Tanous 
2903043a0536SJohnathan Mantey                 auto getStoredLogCallback =
2904bd79bce8SPatrick Williams                     [asyncResp, logID, fileName,
2905bd79bce8SPatrick Williams                      url(boost::urls::url(req.url()))](
29065e7e2dc5SEd Tanous                         const boost::system::error_code& ec,
2907bd79bce8SPatrick Williams                         const std::vector<std::pair<
2908bd79bce8SPatrick Williams                             std::string, dbus::utility::DbusVariantType>>&
29097e860f15SJohn Edward Broadbent                             resp) {
29101da66f75SEd Tanous                         if (ec)
29111da66f75SEd Tanous                         {
2912bd79bce8SPatrick Williams                             BMCWEB_LOG_DEBUG("failed to get log ec: {}",
2913bd79bce8SPatrick Williams                                              ec.message());
2914f12894f8SJason M. Bills                             messages::internalError(asyncResp->res);
29151da66f75SEd Tanous                             return;
29161da66f75SEd Tanous                         }
2917e855dd28SJason M. Bills 
2918043a0536SJohnathan Mantey                         std::string dbusFilename{};
2919043a0536SJohnathan Mantey                         std::string dbusTimestamp{};
2920043a0536SJohnathan Mantey                         std::string dbusFilepath{};
2921043a0536SJohnathan Mantey 
2922bd79bce8SPatrick Williams                         parseCrashdumpParameters(resp, dbusFilename,
2923bd79bce8SPatrick Williams                                                  dbusTimestamp, dbusFilepath);
2924043a0536SJohnathan Mantey 
2925043a0536SJohnathan Mantey                         if (dbusFilename.empty() || dbusTimestamp.empty() ||
2926043a0536SJohnathan Mantey                             dbusFilepath.empty())
29271da66f75SEd Tanous                         {
2928bd79bce8SPatrick Williams                             messages::resourceNotFound(asyncResp->res,
2929bd79bce8SPatrick Williams                                                        "LogEntry", logID);
29301da66f75SEd Tanous                             return;
29311da66f75SEd Tanous                         }
2932e855dd28SJason M. Bills 
2933043a0536SJohnathan Mantey                         // Verify the file name parameter is correct
2934043a0536SJohnathan Mantey                         if (fileName != dbusFilename)
2935043a0536SJohnathan Mantey                         {
2936bd79bce8SPatrick Williams                             messages::resourceNotFound(asyncResp->res,
2937bd79bce8SPatrick Williams                                                        "LogEntry", logID);
2938043a0536SJohnathan Mantey                             return;
2939043a0536SJohnathan Mantey                         }
2940043a0536SJohnathan Mantey 
2941d51c61b4SMyung Bae                         if (asyncResp->res.openFile(dbusFilepath) !=
2942d51c61b4SMyung Bae                             crow::OpenCode::Success)
2943043a0536SJohnathan Mantey                         {
2944bd79bce8SPatrick Williams                             messages::resourceNotFound(asyncResp->res,
2945bd79bce8SPatrick Williams                                                        "LogEntry", logID);
2946043a0536SJohnathan Mantey                             return;
2947043a0536SJohnathan Mantey                         }
2948043a0536SJohnathan Mantey 
29497e860f15SJohn Edward Broadbent                         // Configure this to be a file download when accessed
29507e860f15SJohn Edward Broadbent                         // from a browser
2951d9f6c621SEd Tanous                         asyncResp->res.addHeader(
2952bd79bce8SPatrick Williams                             boost::beast::http::field::content_disposition,
2953bd79bce8SPatrick Williams                             "attachment");
29541da66f75SEd Tanous                     };
2955deae6a78SEd Tanous                 dbus::utility::getAllProperties(
2956d1bde9e5SKrzysztof Grobelny                     *crow::connections::systemBus, crashdumpObject,
2957bd79bce8SPatrick Williams                     crashdumpPath + std::string("/") + logID,
2958bd79bce8SPatrick Williams                     crashdumpInterface, std::move(getStoredLogCallback));
29597e860f15SJohn Edward Broadbent             });
29601da66f75SEd Tanous }
29611da66f75SEd Tanous 
2962c5a4c82aSJason M. Bills enum class OEMDiagnosticType
2963c5a4c82aSJason M. Bills {
2964c5a4c82aSJason M. Bills     onDemand,
2965c5a4c82aSJason M. Bills     telemetry,
2966c5a4c82aSJason M. Bills     invalid,
2967c5a4c82aSJason M. Bills };
2968c5a4c82aSJason M. Bills 
296926ccae32SEd Tanous inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr)
2970c5a4c82aSJason M. Bills {
2971c5a4c82aSJason M. Bills     if (oemDiagStr == "OnDemand")
2972c5a4c82aSJason M. Bills     {
2973c5a4c82aSJason M. Bills         return OEMDiagnosticType::onDemand;
2974c5a4c82aSJason M. Bills     }
2975c5a4c82aSJason M. Bills     if (oemDiagStr == "Telemetry")
2976c5a4c82aSJason M. Bills     {
2977c5a4c82aSJason M. Bills         return OEMDiagnosticType::telemetry;
2978c5a4c82aSJason M. Bills     }
2979c5a4c82aSJason M. Bills 
2980c5a4c82aSJason M. Bills     return OEMDiagnosticType::invalid;
2981c5a4c82aSJason M. Bills }
2982c5a4c82aSJason M. Bills 
29837e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app)
29841da66f75SEd Tanous {
29853946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
29863946028dSAppaRao Puli     // method for security reasons.
29870fda0f12SGeorge Liu     BMCWEB_ROUTE(
29880fda0f12SGeorge Liu         app,
298922d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
2990ed398213SEd Tanous         // The below is incorrect;  Should be ConfigureManager
2991ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2992432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
2993002d39b4SEd Tanous         .methods(boost::beast::http::verb::post)(
2994002d39b4SEd Tanous             [&app](const crow::Request& req,
299522d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
299622d268cbSEd Tanous                    const std::string& systemName) {
29973ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
299845ca1b86SEd Tanous                 {
299945ca1b86SEd Tanous                     return;
300045ca1b86SEd Tanous                 }
300122d268cbSEd Tanous 
300225b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
30037f3e84a1SEd Tanous                 {
30047f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
30057f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
30067f3e84a1SEd Tanous                                                systemName);
30077f3e84a1SEd Tanous                     return;
30087f3e84a1SEd Tanous                 }
3009253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
301022d268cbSEd Tanous                 {
301122d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
301222d268cbSEd Tanous                                                systemName);
301322d268cbSEd Tanous                     return;
301422d268cbSEd Tanous                 }
301522d268cbSEd Tanous 
30168e6c099aSJason M. Bills                 std::string diagnosticDataType;
30178e6c099aSJason M. Bills                 std::string oemDiagnosticDataType;
3018afc474aeSMyung Bae                 if (!redfish::json_util::readJsonAction(               //
3019afc474aeSMyung Bae                         req, asyncResp->res,                           //
3020afc474aeSMyung Bae                         "DiagnosticDataType", diagnosticDataType,      //
3021afc474aeSMyung Bae                         "OEMDiagnosticDataType", oemDiagnosticDataType //
3022afc474aeSMyung Bae                         ))
30238e6c099aSJason M. Bills                 {
30248e6c099aSJason M. Bills                     return;
30258e6c099aSJason M. Bills                 }
30268e6c099aSJason M. Bills 
30278e6c099aSJason M. Bills                 if (diagnosticDataType != "OEM")
30288e6c099aSJason M. Bills                 {
302962598e31SEd Tanous                     BMCWEB_LOG_ERROR(
303062598e31SEd Tanous                         "Only OEM DiagnosticDataType supported for Crashdump");
30318e6c099aSJason M. Bills                     messages::actionParameterValueFormatError(
3032bd79bce8SPatrick Williams                         asyncResp->res, diagnosticDataType,
3033bd79bce8SPatrick Williams                         "DiagnosticDataType", "CollectDiagnosticData");
30348e6c099aSJason M. Bills                     return;
30358e6c099aSJason M. Bills                 }
30368e6c099aSJason M. Bills 
3037c5a4c82aSJason M. Bills                 OEMDiagnosticType oemDiagType =
3038c5a4c82aSJason M. Bills                     getOEMDiagnosticType(oemDiagnosticDataType);
3039c5a4c82aSJason M. Bills 
3040c5a4c82aSJason M. Bills                 std::string iface;
3041c5a4c82aSJason M. Bills                 std::string method;
3042c5a4c82aSJason M. Bills                 std::string taskMatchStr;
3043c5a4c82aSJason M. Bills                 if (oemDiagType == OEMDiagnosticType::onDemand)
3044c5a4c82aSJason M. Bills                 {
3045c5a4c82aSJason M. Bills                     iface = crashdumpOnDemandInterface;
3046c5a4c82aSJason M. Bills                     method = "GenerateOnDemandLog";
3047bd79bce8SPatrick Williams                     taskMatchStr =
3048bd79bce8SPatrick Williams                         "type='signal',"
3049c5a4c82aSJason M. Bills                         "interface='org.freedesktop.DBus.Properties',"
3050c5a4c82aSJason M. Bills                         "member='PropertiesChanged',"
3051c5a4c82aSJason M. Bills                         "arg0namespace='com.intel.crashdump'";
3052c5a4c82aSJason M. Bills                 }
3053c5a4c82aSJason M. Bills                 else if (oemDiagType == OEMDiagnosticType::telemetry)
3054c5a4c82aSJason M. Bills                 {
3055c5a4c82aSJason M. Bills                     iface = crashdumpTelemetryInterface;
3056c5a4c82aSJason M. Bills                     method = "GenerateTelemetryLog";
3057bd79bce8SPatrick Williams                     taskMatchStr =
3058bd79bce8SPatrick Williams                         "type='signal',"
3059c5a4c82aSJason M. Bills                         "interface='org.freedesktop.DBus.Properties',"
3060c5a4c82aSJason M. Bills                         "member='PropertiesChanged',"
3061c5a4c82aSJason M. Bills                         "arg0namespace='com.intel.crashdump'";
3062c5a4c82aSJason M. Bills                 }
3063c5a4c82aSJason M. Bills                 else
3064c5a4c82aSJason M. Bills                 {
306562598e31SEd Tanous                     BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}",
306662598e31SEd Tanous                                      oemDiagnosticDataType);
3067c5a4c82aSJason M. Bills                     messages::actionParameterValueFormatError(
3068bd79bce8SPatrick Williams                         asyncResp->res, oemDiagnosticDataType,
3069bd79bce8SPatrick Williams                         "OEMDiagnosticDataType", "CollectDiagnosticData");
3070c5a4c82aSJason M. Bills                     return;
3071c5a4c82aSJason M. Bills                 }
3072c5a4c82aSJason M. Bills 
3073c5a4c82aSJason M. Bills                 auto collectCrashdumpCallback =
3074c5a4c82aSJason M. Bills                     [asyncResp, payload(task::Payload(req)),
30755e7e2dc5SEd Tanous                      taskMatchStr](const boost::system::error_code& ec,
307698be3e39SEd Tanous                                    const std::string&) mutable {
30771da66f75SEd Tanous                         if (ec)
30781da66f75SEd Tanous                         {
3079bd79bce8SPatrick Williams                             if (ec.value() ==
3080bd79bce8SPatrick Williams                                 boost::system::errc::operation_not_supported)
30811da66f75SEd Tanous                             {
3082f12894f8SJason M. Bills                                 messages::resourceInStandby(asyncResp->res);
30831da66f75SEd Tanous                             }
3084bd79bce8SPatrick Williams                             else if (ec.value() == boost::system::errc::
3085bd79bce8SPatrick Williams                                                        device_or_resource_busy)
30864363d3b2SJason M. Bills                             {
3087bd79bce8SPatrick Williams                                 messages::serviceTemporarilyUnavailable(
3088bd79bce8SPatrick Williams                                     asyncResp->res, "60");
30894363d3b2SJason M. Bills                             }
30901da66f75SEd Tanous                             else
30911da66f75SEd Tanous                             {
3092f12894f8SJason M. Bills                                 messages::internalError(asyncResp->res);
30931da66f75SEd Tanous                             }
30941da66f75SEd Tanous                             return;
30951da66f75SEd Tanous                         }
3096bd79bce8SPatrick Williams                         std::shared_ptr<task::TaskData> task =
3097bd79bce8SPatrick Williams                             task::TaskData::createTask(
3098bd79bce8SPatrick Williams                                 [](const boost::system::error_code& ec2,
3099bd79bce8SPatrick Williams                                    sdbusplus::message_t&,
3100bd79bce8SPatrick Williams                                    const std::shared_ptr<task::TaskData>&
3101bd79bce8SPatrick Williams                                        taskData) {
31028b24275dSEd Tanous                                     if (!ec2)
310366afe4faSJames Feist                                     {
3104bd79bce8SPatrick Williams                                         taskData->messages.emplace_back(
3105bd79bce8SPatrick Williams                                             messages::taskCompletedOK(
3106bd79bce8SPatrick Williams                                                 std::to_string(
3107bd79bce8SPatrick Williams                                                     taskData->index)));
3108831d6b09SJames Feist                                         taskData->state = "Completed";
310966afe4faSJames Feist                                     }
311032898ceaSJames Feist                                     return task::completed;
311166afe4faSJames Feist                                 },
3112c5a4c82aSJason M. Bills                                 taskMatchStr);
3113c5a4c82aSJason M. Bills 
311446229577SJames Feist                         task->startTimer(std::chrono::minutes(5));
311546229577SJames Feist                         task->populateResp(asyncResp->res);
311698be3e39SEd Tanous                         task->payload.emplace(std::move(payload));
31171da66f75SEd Tanous                     };
31188e6c099aSJason M. Bills 
3119*177612aaSEd Tanous                 dbus::utility::async_method_call(
3120*177612aaSEd Tanous                     asyncResp, std::move(collectCrashdumpCallback),
3121*177612aaSEd Tanous                     crashdumpObject, crashdumpPath, iface, method);
31227e860f15SJohn Edward Broadbent             });
31236eda7685SKenny L. Ku }
31246eda7685SKenny L. Ku 
3125599b9af3SAlexander Hansen inline void dBusLogServiceActionsClear(
3126599b9af3SAlexander Hansen     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
3127599b9af3SAlexander Hansen {
3128599b9af3SAlexander Hansen     BMCWEB_LOG_DEBUG("Do delete all entries.");
3129599b9af3SAlexander Hansen 
3130599b9af3SAlexander Hansen     // Process response from Logging service.
3131599b9af3SAlexander Hansen     auto respHandler = [asyncResp](const boost::system::error_code& ec) {
3132599b9af3SAlexander Hansen         BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done");
3133599b9af3SAlexander Hansen         if (ec)
3134599b9af3SAlexander Hansen         {
3135599b9af3SAlexander Hansen             // TODO Handle for specific error code
3136599b9af3SAlexander Hansen             BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec);
3137599b9af3SAlexander Hansen             asyncResp->res.result(
3138599b9af3SAlexander Hansen                 boost::beast::http::status::internal_server_error);
3139599b9af3SAlexander Hansen             return;
3140599b9af3SAlexander Hansen         }
3141599b9af3SAlexander Hansen 
3142599b9af3SAlexander Hansen         asyncResp->res.result(boost::beast::http::status::no_content);
3143599b9af3SAlexander Hansen     };
3144599b9af3SAlexander Hansen 
3145599b9af3SAlexander Hansen     // Make call to Logging service to request Clear Log
3146*177612aaSEd Tanous     dbus::utility::async_method_call(
3147*177612aaSEd Tanous         asyncResp, respHandler, "xyz.openbmc_project.Logging",
3148599b9af3SAlexander Hansen         "/xyz/openbmc_project/logging",
3149599b9af3SAlexander Hansen         "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3150599b9af3SAlexander Hansen }
3151599b9af3SAlexander Hansen 
3152cb92c03bSAndrew Geissler /**
3153cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3154cb92c03bSAndrew Geissler  */
31557e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app)
3156cb92c03bSAndrew Geissler {
3157cb92c03bSAndrew Geissler     /**
3158cb92c03bSAndrew Geissler      * Function handles POST method request.
3159cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
3160cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
3161cb92c03bSAndrew Geissler      */
31627e860f15SJohn Edward Broadbent 
31630fda0f12SGeorge Liu     BMCWEB_ROUTE(
31640fda0f12SGeorge Liu         app,
316522d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
3166ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
31677e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
316845ca1b86SEd Tanous             [&app](const crow::Request& req,
316922d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
317022d268cbSEd Tanous                    const std::string& systemName) {
31713ba00073SCarson Labrado                 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
317245ca1b86SEd Tanous                 {
317345ca1b86SEd Tanous                     return;
317445ca1b86SEd Tanous                 }
317525b54dbaSEd Tanous                 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
31767f3e84a1SEd Tanous                 {
31777f3e84a1SEd Tanous                     // Option currently returns no systems.  TBD
31787f3e84a1SEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
31797f3e84a1SEd Tanous                                                systemName);
31807f3e84a1SEd Tanous                     return;
31817f3e84a1SEd Tanous                 }
3182253f11b8SEd Tanous                 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
318322d268cbSEd Tanous                 {
318422d268cbSEd Tanous                     messages::resourceNotFound(asyncResp->res, "ComputerSystem",
318522d268cbSEd Tanous                                                systemName);
318622d268cbSEd Tanous                     return;
318722d268cbSEd Tanous                 }
3188599b9af3SAlexander Hansen                 dBusLogServiceActionsClear(asyncResp);
31897e860f15SJohn Edward Broadbent             });
3190cb92c03bSAndrew Geissler }
3191a3316fc6SZhikuiRen 
31921da66f75SEd Tanous } // namespace redfish
3193