xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision 5b90429a75c58797ec29ac9a8ed18c2dcd7d4950)
11da66f75SEd Tanous /*
21da66f75SEd Tanous // Copyright (c) 2018 Intel Corporation
31da66f75SEd Tanous //
41da66f75SEd Tanous // Licensed under the Apache License, Version 2.0 (the "License");
51da66f75SEd Tanous // you may not use this file except in compliance with the License.
61da66f75SEd Tanous // You may obtain a copy of the License at
71da66f75SEd Tanous //
81da66f75SEd Tanous //      http://www.apache.org/licenses/LICENSE-2.0
91da66f75SEd Tanous //
101da66f75SEd Tanous // Unless required by applicable law or agreed to in writing, software
111da66f75SEd Tanous // distributed under the License is distributed on an "AS IS" BASIS,
121da66f75SEd Tanous // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
131da66f75SEd Tanous // See the License for the specific language governing permissions and
141da66f75SEd Tanous // limitations under the License.
151da66f75SEd Tanous */
161da66f75SEd Tanous #pragma once
171da66f75SEd Tanous 
183ccb3adbSEd Tanous #include "app.hpp"
197a1dbc48SGeorge Liu #include "dbus_utility.hpp"
203ccb3adbSEd Tanous #include "error_messages.hpp"
2168dd075aSAsmitha Karunanithi #include "generated/enums/log_entry.hpp"
22b7028ebfSSpencer Ku #include "gzfile.hpp"
23647b3cdcSGeorge Liu #include "http_utility.hpp"
24b7028ebfSSpencer Ku #include "human_sort.hpp"
253ccb3adbSEd Tanous #include "query.hpp"
264851d45dSJason M. Bills #include "registries.hpp"
274851d45dSJason M. Bills #include "registries/base_message_registry.hpp"
284851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp"
293ccb3adbSEd Tanous #include "registries/privilege_registry.hpp"
3046229577SJames Feist #include "task.hpp"
31*5b90429aSEd Tanous #include "task_messages.hpp"
323ccb3adbSEd Tanous #include "utils/dbus_utils.hpp"
33*5b90429aSEd Tanous #include "utils/json_utils.hpp"
343ccb3adbSEd Tanous #include "utils/time_utils.hpp"
351da66f75SEd Tanous 
3675e8e218SMyung Bae #include <systemd/sd-id128.h>
37e1f26343SJason M. Bills #include <systemd/sd-journal.h>
388e31778eSAsmitha Karunanithi #include <tinyxml2.h>
39400fd1fbSAdriana Kobylak #include <unistd.h>
40e1f26343SJason M. Bills 
4107c8c20dSEd Tanous #include <boost/beast/http/verb.hpp>
421da66f75SEd Tanous #include <boost/container/flat_map.hpp>
431ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp>
44ef4c65b7SEd Tanous #include <boost/url/format.hpp>
45d1bde9e5SKrzysztof Grobelny #include <sdbusplus/asio/property.hpp>
46d1bde9e5SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp>
471214b7e7SGunnar Mills 
487a1dbc48SGeorge Liu #include <array>
49647b3cdcSGeorge Liu #include <charconv>
50b5f288d2SAbhilash Raju #include <cstddef>
514418c7f0SJames Feist #include <filesystem>
5218f8f608SEd Tanous #include <iterator>
5375710de2SXiaochao Ma #include <optional>
543544d2a7SEd Tanous #include <ranges>
5526702d01SEd Tanous #include <span>
5618f8f608SEd Tanous #include <string>
57cd225da8SJason M. Bills #include <string_view>
58abf2add6SEd Tanous #include <variant>
591da66f75SEd Tanous 
601da66f75SEd Tanous namespace redfish
611da66f75SEd Tanous {
621da66f75SEd Tanous 
6389492a15SPatrick Williams constexpr const char* crashdumpObject = "com.intel.crashdump";
6489492a15SPatrick Williams constexpr const char* crashdumpPath = "/com/intel/crashdump";
6589492a15SPatrick Williams constexpr const char* crashdumpInterface = "com.intel.crashdump";
6689492a15SPatrick Williams constexpr const char* deleteAllInterface =
675b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
6889492a15SPatrick Williams constexpr const char* crashdumpOnDemandInterface =
69424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
7089492a15SPatrick Williams constexpr const char* crashdumpTelemetryInterface =
716eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
721da66f75SEd Tanous 
738e31778eSAsmitha Karunanithi enum class DumpCreationProgress
748e31778eSAsmitha Karunanithi {
758e31778eSAsmitha Karunanithi     DUMP_CREATE_SUCCESS,
768e31778eSAsmitha Karunanithi     DUMP_CREATE_FAILED,
778e31778eSAsmitha Karunanithi     DUMP_CREATE_INPROGRESS
788e31778eSAsmitha Karunanithi };
798e31778eSAsmitha Karunanithi 
80f6150403SJames Feist namespace fs = std::filesystem;
811da66f75SEd Tanous 
82cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
83cb92c03bSAndrew Geissler {
84d4d25793SEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
85d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
86d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
87d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
88cb92c03bSAndrew Geissler     {
89cb92c03bSAndrew Geissler         return "Critical";
90cb92c03bSAndrew Geissler     }
913174e4dfSEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
92d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
93d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
94cb92c03bSAndrew Geissler     {
95cb92c03bSAndrew Geissler         return "OK";
96cb92c03bSAndrew Geissler     }
973174e4dfSEd Tanous     if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
98cb92c03bSAndrew Geissler     {
99cb92c03bSAndrew Geissler         return "Warning";
100cb92c03bSAndrew Geissler     }
101cb92c03bSAndrew Geissler     return "";
102cb92c03bSAndrew Geissler }
103cb92c03bSAndrew Geissler 
1049017faf2SAbhishek Patel inline std::optional<bool> getProviderNotifyAction(const std::string& notify)
1059017faf2SAbhishek Patel {
1069017faf2SAbhishek Patel     std::optional<bool> notifyAction;
1079017faf2SAbhishek Patel     if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Notify")
1089017faf2SAbhishek Patel     {
1099017faf2SAbhishek Patel         notifyAction = true;
1109017faf2SAbhishek Patel     }
1119017faf2SAbhishek Patel     else if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Inhibit")
1129017faf2SAbhishek Patel     {
1139017faf2SAbhishek Patel         notifyAction = false;
1149017faf2SAbhishek Patel     }
1159017faf2SAbhishek Patel 
1169017faf2SAbhishek Patel     return notifyAction;
1179017faf2SAbhishek Patel }
1189017faf2SAbhishek Patel 
11918f8f608SEd Tanous inline std::string getDumpPath(std::string_view dumpType)
12018f8f608SEd Tanous {
12118f8f608SEd Tanous     std::string dbusDumpPath = "/xyz/openbmc_project/dump/";
12218f8f608SEd Tanous     std::ranges::transform(dumpType, std::back_inserter(dbusDumpPath),
12318f8f608SEd Tanous                            bmcweb::asciiToLower);
12418f8f608SEd Tanous 
12518f8f608SEd Tanous     return dbusDumpPath;
12618f8f608SEd Tanous }
12718f8f608SEd Tanous 
128df254f2cSEd Tanous inline int getJournalMetadata(sd_journal* journal, std::string_view field,
12939e77504SEd Tanous                               std::string_view& contents)
13016428a1aSJason M. Bills {
13116428a1aSJason M. Bills     const char* data = nullptr;
13216428a1aSJason M. Bills     size_t length = 0;
13316428a1aSJason M. Bills     int ret = 0;
13416428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
13546ff87baSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
13646ff87baSEd Tanous     const void** dataVoid = reinterpret_cast<const void**>(&data);
13746ff87baSEd Tanous 
13846ff87baSEd Tanous     ret = sd_journal_get_data(journal, field.data(), dataVoid, &length);
13916428a1aSJason M. Bills     if (ret < 0)
14016428a1aSJason M. Bills     {
14116428a1aSJason M. Bills         return ret;
14216428a1aSJason M. Bills     }
14339e77504SEd Tanous     contents = std::string_view(data, length);
14416428a1aSJason M. Bills     // Only use the content after the "=" character.
14581ce609eSEd Tanous     contents.remove_prefix(std::min(contents.find('=') + 1, contents.size()));
14616428a1aSJason M. Bills     return ret;
14716428a1aSJason M. Bills }
14816428a1aSJason M. Bills 
149df254f2cSEd Tanous inline int getJournalMetadata(sd_journal* journal, std::string_view field,
150df254f2cSEd Tanous                               const int& base, long int& contents)
15116428a1aSJason M. Bills {
15216428a1aSJason M. Bills     int ret = 0;
15339e77504SEd Tanous     std::string_view metadata;
15416428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
15516428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
15616428a1aSJason M. Bills     if (ret < 0)
15716428a1aSJason M. Bills     {
15816428a1aSJason M. Bills         return ret;
15916428a1aSJason M. Bills     }
160b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
16116428a1aSJason M. Bills     return ret;
16216428a1aSJason M. Bills }
16316428a1aSJason M. Bills 
164df254f2cSEd Tanous inline bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp)
165a3316fc6SZhikuiRen {
166a3316fc6SZhikuiRen     int ret = 0;
167a3316fc6SZhikuiRen     uint64_t timestamp = 0;
168a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
169a3316fc6SZhikuiRen     if (ret < 0)
170a3316fc6SZhikuiRen     {
17162598e31SEd Tanous         BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret));
172a3316fc6SZhikuiRen         return false;
173a3316fc6SZhikuiRen     }
174e645c5e6SKonstantin Aladyshev     entryTimestamp = redfish::time_utils::getDateTimeUintUs(timestamp);
1759c620e21SAsmitha Karunanithi     return true;
176a3316fc6SZhikuiRen }
17750b8a43aSEd Tanous 
178df254f2cSEd Tanous inline bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
179e85d6b16SJason M. Bills                              const bool firstEntry = true)
18016428a1aSJason M. Bills {
18116428a1aSJason M. Bills     int ret = 0;
18275e8e218SMyung Bae     static sd_id128_t prevBootID{};
18316428a1aSJason M. Bills     static uint64_t prevTs = 0;
18416428a1aSJason M. Bills     static int index = 0;
185e85d6b16SJason M. Bills     if (firstEntry)
186e85d6b16SJason M. Bills     {
18775e8e218SMyung Bae         prevBootID = {};
188e85d6b16SJason M. Bills         prevTs = 0;
189e85d6b16SJason M. Bills     }
190e85d6b16SJason M. Bills 
19116428a1aSJason M. Bills     // Get the entry timestamp
19216428a1aSJason M. Bills     uint64_t curTs = 0;
19375e8e218SMyung Bae     sd_id128_t curBootID{};
19475e8e218SMyung Bae     ret = sd_journal_get_monotonic_usec(journal, &curTs, &curBootID);
19516428a1aSJason M. Bills     if (ret < 0)
19616428a1aSJason M. Bills     {
19762598e31SEd Tanous         BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret));
19816428a1aSJason M. Bills         return false;
19916428a1aSJason M. Bills     }
20075e8e218SMyung Bae     // If the timestamp isn't unique on the same boot, increment the index
20175e8e218SMyung Bae     bool sameBootIDs = sd_id128_equal(curBootID, prevBootID) != 0;
20275e8e218SMyung Bae     if (sameBootIDs && (curTs == prevTs))
20316428a1aSJason M. Bills     {
20416428a1aSJason M. Bills         index++;
20516428a1aSJason M. Bills     }
20616428a1aSJason M. Bills     else
20716428a1aSJason M. Bills     {
20816428a1aSJason M. Bills         // Otherwise, reset it
20916428a1aSJason M. Bills         index = 0;
21016428a1aSJason M. Bills     }
21175e8e218SMyung Bae 
21275e8e218SMyung Bae     if (!sameBootIDs)
21375e8e218SMyung Bae     {
21475e8e218SMyung Bae         // Save the bootID
21575e8e218SMyung Bae         prevBootID = curBootID;
21675e8e218SMyung Bae     }
21716428a1aSJason M. Bills     // Save the timestamp
21816428a1aSJason M. Bills     prevTs = curTs;
21916428a1aSJason M. Bills 
22075e8e218SMyung Bae     // make entryID as <bootID>_<timestamp>[_<index>]
22175e8e218SMyung Bae     std::array<char, SD_ID128_STRING_MAX> bootIDStr{};
22275e8e218SMyung Bae     sd_id128_to_string(curBootID, bootIDStr.data());
22375e8e218SMyung Bae     entryID = std::format("{}_{}", bootIDStr.data(), curTs);
22416428a1aSJason M. Bills     if (index > 0)
22516428a1aSJason M. Bills     {
22616428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
22716428a1aSJason M. Bills     }
22816428a1aSJason M. Bills     return true;
22916428a1aSJason M. Bills }
23016428a1aSJason M. Bills 
231e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
232e85d6b16SJason M. Bills                              const bool firstEntry = true)
23395820184SJason M. Bills {
234271584abSEd Tanous     static time_t prevTs = 0;
23595820184SJason M. Bills     static int index = 0;
236e85d6b16SJason M. Bills     if (firstEntry)
237e85d6b16SJason M. Bills     {
238e85d6b16SJason M. Bills         prevTs = 0;
239e85d6b16SJason M. Bills     }
240e85d6b16SJason M. Bills 
24195820184SJason M. Bills     // Get the entry timestamp
242271584abSEd Tanous     std::time_t curTs = 0;
24395820184SJason M. Bills     std::tm timeStruct = {};
24495820184SJason M. Bills     std::istringstream entryStream(logEntry);
24595820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
24695820184SJason M. Bills     {
24795820184SJason M. Bills         curTs = std::mktime(&timeStruct);
24895820184SJason M. Bills     }
24995820184SJason M. Bills     // If the timestamp isn't unique, increment the index
25095820184SJason M. Bills     if (curTs == prevTs)
25195820184SJason M. Bills     {
25295820184SJason M. Bills         index++;
25395820184SJason M. Bills     }
25495820184SJason M. Bills     else
25595820184SJason M. Bills     {
25695820184SJason M. Bills         // Otherwise, reset it
25795820184SJason M. Bills         index = 0;
25895820184SJason M. Bills     }
25995820184SJason M. Bills     // Save the timestamp
26095820184SJason M. Bills     prevTs = curTs;
26195820184SJason M. Bills 
26295820184SJason M. Bills     entryID = std::to_string(curTs);
26395820184SJason M. Bills     if (index > 0)
26495820184SJason M. Bills     {
26595820184SJason M. Bills         entryID += "_" + std::to_string(index);
26695820184SJason M. Bills     }
26795820184SJason M. Bills     return true;
26895820184SJason M. Bills }
26995820184SJason M. Bills 
27075e8e218SMyung Bae // Entry is formed like "BootID_timestamp" or "BootID_timestamp_index"
271df254f2cSEd Tanous inline bool
2728d1b46d7Szhanghch05     getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
273099984c1SEd Tanous                        std::string_view entryIDStrView, sd_id128_t& bootID,
27475e8e218SMyung Bae                        uint64_t& timestamp, uint64_t& index)
27516428a1aSJason M. Bills {
27675e8e218SMyung Bae     // Convert the unique ID back to a bootID + timestamp to find the entry
27775e8e218SMyung Bae     auto underscore1Pos = entryIDStrView.find('_');
27875e8e218SMyung Bae     if (underscore1Pos == std::string_view::npos)
27975e8e218SMyung Bae     {
28075e8e218SMyung Bae         // EntryID has no bootID or timestamp
281099984c1SEd Tanous         messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView);
28275e8e218SMyung Bae         return false;
28375e8e218SMyung Bae     }
28475e8e218SMyung Bae 
28575e8e218SMyung Bae     // EntryID has bootID + timestamp
28675e8e218SMyung Bae 
28775e8e218SMyung Bae     // Convert entryIDViewString to BootID
28875e8e218SMyung Bae     // NOTE: bootID string which needs to be null-terminated for
28975e8e218SMyung Bae     // sd_id128_from_string()
290099984c1SEd Tanous     std::string bootIDStr(entryIDStrView.substr(0, underscore1Pos));
29175e8e218SMyung Bae     if (sd_id128_from_string(bootIDStr.c_str(), &bootID) < 0)
29275e8e218SMyung Bae     {
293099984c1SEd Tanous         messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView);
29475e8e218SMyung Bae         return false;
29575e8e218SMyung Bae     }
29675e8e218SMyung Bae 
29775e8e218SMyung Bae     // Get the timestamp from entryID
298099984c1SEd Tanous     entryIDStrView.remove_prefix(underscore1Pos + 1);
29975e8e218SMyung Bae 
300099984c1SEd Tanous     auto [timestampEnd, tstampEc] = std::from_chars(
301099984c1SEd Tanous         entryIDStrView.begin(), entryIDStrView.end(), timestamp);
302099984c1SEd Tanous     if (tstampEc != std::errc())
30316428a1aSJason M. Bills     {
304099984c1SEd Tanous         messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView);
30516428a1aSJason M. Bills         return false;
30616428a1aSJason M. Bills     }
307099984c1SEd Tanous     entryIDStrView = std::string_view(
308099984c1SEd Tanous         timestampEnd,
309099984c1SEd Tanous         static_cast<size_t>(std::distance(timestampEnd, entryIDStrView.end())));
310099984c1SEd Tanous     if (entryIDStrView.empty())
31116428a1aSJason M. Bills     {
312099984c1SEd Tanous         index = 0U;
313099984c1SEd Tanous         return true;
314099984c1SEd Tanous     }
315099984c1SEd Tanous     // Timestamp might include optional index, if two events happened at the
316099984c1SEd Tanous     // same "time".
317099984c1SEd Tanous     if (entryIDStrView[0] != '_')
318099984c1SEd Tanous     {
319099984c1SEd Tanous         messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView);
320099984c1SEd Tanous         return false;
321099984c1SEd Tanous     }
322099984c1SEd Tanous     entryIDStrView.remove_prefix(1);
323099984c1SEd Tanous     auto [ptr, indexEc] = std::from_chars(entryIDStrView.begin(),
324099984c1SEd Tanous                                           entryIDStrView.end(), index);
325099984c1SEd Tanous     if (indexEc != std::errc() || ptr != entryIDStrView.end())
326099984c1SEd Tanous     {
327099984c1SEd Tanous         messages::resourceNotFound(asyncResp->res, "LogEntry", entryIDStrView);
32816428a1aSJason M. Bills         return false;
32916428a1aSJason M. Bills     }
33016428a1aSJason M. Bills     return true;
33116428a1aSJason M. Bills }
33216428a1aSJason M. Bills 
33395820184SJason M. Bills static bool
33495820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
33595820184SJason M. Bills {
33695820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
33795820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
33895820184SJason M. Bills 
33995820184SJason M. Bills     // Loop through the directory looking for redfish log files
34095820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
34195820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
34295820184SJason M. Bills     {
34395820184SJason M. Bills         // If we find a redfish log file, save the path
34495820184SJason M. Bills         std::string filename = dirEnt.path().filename();
34511ba3979SEd Tanous         if (filename.starts_with(redfishLogFilename))
34695820184SJason M. Bills         {
34795820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
34895820184SJason M. Bills         }
34995820184SJason M. Bills     }
35095820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
35195820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
35295820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
3533544d2a7SEd Tanous     std::ranges::sort(redfishLogFiles);
35495820184SJason M. Bills 
35595820184SJason M. Bills     return !redfishLogFiles.empty();
35695820184SJason M. Bills }
35795820184SJason M. Bills 
35868dd075aSAsmitha Karunanithi inline log_entry::OriginatorTypes
35968dd075aSAsmitha Karunanithi     mapDbusOriginatorTypeToRedfish(const std::string& originatorType)
36068dd075aSAsmitha Karunanithi {
36168dd075aSAsmitha Karunanithi     if (originatorType ==
36268dd075aSAsmitha Karunanithi         "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client")
36368dd075aSAsmitha Karunanithi     {
36468dd075aSAsmitha Karunanithi         return log_entry::OriginatorTypes::Client;
36568dd075aSAsmitha Karunanithi     }
36668dd075aSAsmitha Karunanithi     if (originatorType ==
36768dd075aSAsmitha Karunanithi         "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal")
36868dd075aSAsmitha Karunanithi     {
36968dd075aSAsmitha Karunanithi         return log_entry::OriginatorTypes::Internal;
37068dd075aSAsmitha Karunanithi     }
37168dd075aSAsmitha Karunanithi     if (originatorType ==
37268dd075aSAsmitha Karunanithi         "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService")
37368dd075aSAsmitha Karunanithi     {
37468dd075aSAsmitha Karunanithi         return log_entry::OriginatorTypes::SupportingService;
37568dd075aSAsmitha Karunanithi     }
37668dd075aSAsmitha Karunanithi     return log_entry::OriginatorTypes::Invalid;
37768dd075aSAsmitha Karunanithi }
37868dd075aSAsmitha Karunanithi 
379aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject(
3802d613eb6SJiaqing Zhao     const dbus::utility::ManagedObjectType::value_type& object,
381c6fecdabSClaire Weinan     std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs,
38268dd075aSAsmitha Karunanithi     std::string& originatorId, log_entry::OriginatorTypes& originatorType,
383aefe3786SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
384aefe3786SClaire Weinan {
385aefe3786SClaire Weinan     for (const auto& interfaceMap : object.second)
386aefe3786SClaire Weinan     {
387aefe3786SClaire Weinan         if (interfaceMap.first == "xyz.openbmc_project.Common.Progress")
388aefe3786SClaire Weinan         {
389aefe3786SClaire Weinan             for (const auto& propertyMap : interfaceMap.second)
390aefe3786SClaire Weinan             {
391aefe3786SClaire Weinan                 if (propertyMap.first == "Status")
392aefe3786SClaire Weinan                 {
393aefe3786SClaire Weinan                     const auto* status =
394aefe3786SClaire Weinan                         std::get_if<std::string>(&propertyMap.second);
395aefe3786SClaire Weinan                     if (status == nullptr)
396aefe3786SClaire Weinan                     {
397aefe3786SClaire Weinan                         messages::internalError(asyncResp->res);
398aefe3786SClaire Weinan                         break;
399aefe3786SClaire Weinan                     }
400aefe3786SClaire Weinan                     dumpStatus = *status;
401aefe3786SClaire Weinan                 }
402aefe3786SClaire Weinan             }
403aefe3786SClaire Weinan         }
404aefe3786SClaire Weinan         else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
405aefe3786SClaire Weinan         {
406aefe3786SClaire Weinan             for (const auto& propertyMap : interfaceMap.second)
407aefe3786SClaire Weinan             {
408aefe3786SClaire Weinan                 if (propertyMap.first == "Size")
409aefe3786SClaire Weinan                 {
410aefe3786SClaire Weinan                     const auto* sizePtr =
411aefe3786SClaire Weinan                         std::get_if<uint64_t>(&propertyMap.second);
412aefe3786SClaire Weinan                     if (sizePtr == nullptr)
413aefe3786SClaire Weinan                     {
414aefe3786SClaire Weinan                         messages::internalError(asyncResp->res);
415aefe3786SClaire Weinan                         break;
416aefe3786SClaire Weinan                     }
417aefe3786SClaire Weinan                     size = *sizePtr;
418aefe3786SClaire Weinan                     break;
419aefe3786SClaire Weinan                 }
420aefe3786SClaire Weinan             }
421aefe3786SClaire Weinan         }
422aefe3786SClaire Weinan         else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime")
423aefe3786SClaire Weinan         {
424aefe3786SClaire Weinan             for (const auto& propertyMap : interfaceMap.second)
425aefe3786SClaire Weinan             {
426aefe3786SClaire Weinan                 if (propertyMap.first == "Elapsed")
427aefe3786SClaire Weinan                 {
428aefe3786SClaire Weinan                     const uint64_t* usecsTimeStamp =
429aefe3786SClaire Weinan                         std::get_if<uint64_t>(&propertyMap.second);
430aefe3786SClaire Weinan                     if (usecsTimeStamp == nullptr)
431aefe3786SClaire Weinan                     {
432aefe3786SClaire Weinan                         messages::internalError(asyncResp->res);
433aefe3786SClaire Weinan                         break;
434aefe3786SClaire Weinan                     }
435c6fecdabSClaire Weinan                     timestampUs = *usecsTimeStamp;
436aefe3786SClaire Weinan                     break;
437aefe3786SClaire Weinan                 }
438aefe3786SClaire Weinan             }
439aefe3786SClaire Weinan         }
44068dd075aSAsmitha Karunanithi         else if (interfaceMap.first ==
44168dd075aSAsmitha Karunanithi                  "xyz.openbmc_project.Common.OriginatedBy")
44268dd075aSAsmitha Karunanithi         {
44368dd075aSAsmitha Karunanithi             for (const auto& propertyMap : interfaceMap.second)
44468dd075aSAsmitha Karunanithi             {
44568dd075aSAsmitha Karunanithi                 if (propertyMap.first == "OriginatorId")
44668dd075aSAsmitha Karunanithi                 {
44768dd075aSAsmitha Karunanithi                     const std::string* id =
44868dd075aSAsmitha Karunanithi                         std::get_if<std::string>(&propertyMap.second);
44968dd075aSAsmitha Karunanithi                     if (id == nullptr)
45068dd075aSAsmitha Karunanithi                     {
45168dd075aSAsmitha Karunanithi                         messages::internalError(asyncResp->res);
45268dd075aSAsmitha Karunanithi                         break;
45368dd075aSAsmitha Karunanithi                     }
45468dd075aSAsmitha Karunanithi                     originatorId = *id;
45568dd075aSAsmitha Karunanithi                 }
45668dd075aSAsmitha Karunanithi 
45768dd075aSAsmitha Karunanithi                 if (propertyMap.first == "OriginatorType")
45868dd075aSAsmitha Karunanithi                 {
45968dd075aSAsmitha Karunanithi                     const std::string* type =
46068dd075aSAsmitha Karunanithi                         std::get_if<std::string>(&propertyMap.second);
46168dd075aSAsmitha Karunanithi                     if (type == nullptr)
46268dd075aSAsmitha Karunanithi                     {
46368dd075aSAsmitha Karunanithi                         messages::internalError(asyncResp->res);
46468dd075aSAsmitha Karunanithi                         break;
46568dd075aSAsmitha Karunanithi                     }
46668dd075aSAsmitha Karunanithi 
46768dd075aSAsmitha Karunanithi                     originatorType = mapDbusOriginatorTypeToRedfish(*type);
46868dd075aSAsmitha Karunanithi                     if (originatorType == log_entry::OriginatorTypes::Invalid)
46968dd075aSAsmitha Karunanithi                     {
47068dd075aSAsmitha Karunanithi                         messages::internalError(asyncResp->res);
47168dd075aSAsmitha Karunanithi                         break;
47268dd075aSAsmitha Karunanithi                     }
47368dd075aSAsmitha Karunanithi                 }
47468dd075aSAsmitha Karunanithi             }
47568dd075aSAsmitha Karunanithi         }
476aefe3786SClaire Weinan     }
477aefe3786SClaire Weinan }
478aefe3786SClaire Weinan 
47921ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType)
480fdd26906SClaire Weinan {
481fdd26906SClaire Weinan     std::string entriesPath;
482fdd26906SClaire Weinan 
483fdd26906SClaire Weinan     if (dumpType == "BMC")
484fdd26906SClaire Weinan     {
485fdd26906SClaire Weinan         entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
486fdd26906SClaire Weinan     }
487fdd26906SClaire Weinan     else if (dumpType == "FaultLog")
488fdd26906SClaire Weinan     {
489fdd26906SClaire Weinan         entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/";
490fdd26906SClaire Weinan     }
491fdd26906SClaire Weinan     else if (dumpType == "System")
492fdd26906SClaire Weinan     {
493fdd26906SClaire Weinan         entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
494fdd26906SClaire Weinan     }
495fdd26906SClaire Weinan     else
496fdd26906SClaire Weinan     {
49762598e31SEd Tanous         BMCWEB_LOG_ERROR("getDumpEntriesPath() invalid dump type: {}",
49862598e31SEd Tanous                          dumpType);
499fdd26906SClaire Weinan     }
500fdd26906SClaire Weinan 
501fdd26906SClaire Weinan     // Returns empty string on error
502fdd26906SClaire Weinan     return entriesPath;
503fdd26906SClaire Weinan }
504fdd26906SClaire Weinan 
5058d1b46d7Szhanghch05 inline void
5068d1b46d7Szhanghch05     getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5075cb1dd27SAsmitha Karunanithi                            const std::string& dumpType)
5085cb1dd27SAsmitha Karunanithi {
509fdd26906SClaire Weinan     std::string entriesPath = getDumpEntriesPath(dumpType);
510fdd26906SClaire Weinan     if (entriesPath.empty())
5115cb1dd27SAsmitha Karunanithi     {
5125cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5135cb1dd27SAsmitha Karunanithi         return;
5145cb1dd27SAsmitha Karunanithi     }
5155cb1dd27SAsmitha Karunanithi 
5165eb468daSGeorge Liu     sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
5175eb468daSGeorge Liu     dbus::utility::getManagedObjects(
5185eb468daSGeorge Liu         "xyz.openbmc_project.Dump.Manager", path,
519fdd26906SClaire Weinan         [asyncResp, entriesPath,
5205e7e2dc5SEd Tanous          dumpType](const boost::system::error_code& ec,
5215eb468daSGeorge Liu                    const dbus::utility::ManagedObjectType& objects) {
5225cb1dd27SAsmitha Karunanithi         if (ec)
5235cb1dd27SAsmitha Karunanithi         {
52462598e31SEd Tanous             BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec);
5255cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
5265cb1dd27SAsmitha Karunanithi             return;
5275cb1dd27SAsmitha Karunanithi         }
5285cb1dd27SAsmitha Karunanithi 
529fdd26906SClaire Weinan         // Remove ending slash
530fdd26906SClaire Weinan         std::string odataIdStr = entriesPath;
531fdd26906SClaire Weinan         if (!odataIdStr.empty())
532fdd26906SClaire Weinan         {
533fdd26906SClaire Weinan             odataIdStr.pop_back();
534fdd26906SClaire Weinan         }
535fdd26906SClaire Weinan 
536fdd26906SClaire Weinan         asyncResp->res.jsonValue["@odata.type"] =
537fdd26906SClaire Weinan             "#LogEntryCollection.LogEntryCollection";
538fdd26906SClaire Weinan         asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr);
539fdd26906SClaire Weinan         asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries";
54089492a15SPatrick Williams         asyncResp->res.jsonValue["Description"] = "Collection of " + dumpType +
54189492a15SPatrick Williams                                                   " Dump Entries";
542fdd26906SClaire Weinan 
5433544d2a7SEd Tanous         nlohmann::json::array_t entriesArray;
54418f8f608SEd Tanous         std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/";
5455cb1dd27SAsmitha Karunanithi 
5465eb468daSGeorge Liu         dbus::utility::ManagedObjectType resp(objects);
5473544d2a7SEd Tanous         std::ranges::sort(resp, [](const auto& l, const auto& r) {
548002d39b4SEd Tanous             return AlphanumLess<std::string>()(l.first.filename(),
549002d39b4SEd Tanous                                                r.first.filename());
550565dfb6fSClaire Weinan         });
551565dfb6fSClaire Weinan 
5525cb1dd27SAsmitha Karunanithi         for (auto& object : resp)
5535cb1dd27SAsmitha Karunanithi         {
554b47452b2SAsmitha Karunanithi             if (object.first.str.find(dumpEntryPath) == std::string::npos)
5555cb1dd27SAsmitha Karunanithi             {
5565cb1dd27SAsmitha Karunanithi                 continue;
5575cb1dd27SAsmitha Karunanithi             }
558c6fecdabSClaire Weinan             uint64_t timestampUs = 0;
5595cb1dd27SAsmitha Karunanithi             uint64_t size = 0;
56035440d18SAsmitha Karunanithi             std::string dumpStatus;
56168dd075aSAsmitha Karunanithi             std::string originatorId;
56268dd075aSAsmitha Karunanithi             log_entry::OriginatorTypes originatorType =
56368dd075aSAsmitha Karunanithi                 log_entry::OriginatorTypes::Internal;
564433b68b4SJason M. Bills             nlohmann::json::object_t thisEntry;
5652dfd18efSEd Tanous 
5662dfd18efSEd Tanous             std::string entryID = object.first.filename();
5672dfd18efSEd Tanous             if (entryID.empty())
5685cb1dd27SAsmitha Karunanithi             {
5695cb1dd27SAsmitha Karunanithi                 continue;
5705cb1dd27SAsmitha Karunanithi             }
5715cb1dd27SAsmitha Karunanithi 
572c6fecdabSClaire Weinan             parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs,
57368dd075aSAsmitha Karunanithi                                          originatorId, originatorType,
574aefe3786SClaire Weinan                                          asyncResp);
5755cb1dd27SAsmitha Karunanithi 
5760fda0f12SGeorge Liu             if (dumpStatus !=
5770fda0f12SGeorge Liu                     "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
57835440d18SAsmitha Karunanithi                 !dumpStatus.empty())
57935440d18SAsmitha Karunanithi             {
58035440d18SAsmitha Karunanithi                 // Dump status is not Complete, no need to enumerate
58135440d18SAsmitha Karunanithi                 continue;
58235440d18SAsmitha Karunanithi             }
58335440d18SAsmitha Karunanithi 
58468dd075aSAsmitha Karunanithi             thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry";
585fdd26906SClaire Weinan             thisEntry["@odata.id"] = entriesPath + entryID;
5865cb1dd27SAsmitha Karunanithi             thisEntry["Id"] = entryID;
5875cb1dd27SAsmitha Karunanithi             thisEntry["EntryType"] = "Event";
5885cb1dd27SAsmitha Karunanithi             thisEntry["Name"] = dumpType + " Dump Entry";
589bbd80db8SClaire Weinan             thisEntry["Created"] =
590bbd80db8SClaire Weinan                 redfish::time_utils::getDateTimeUintUs(timestampUs);
5915cb1dd27SAsmitha Karunanithi 
59268dd075aSAsmitha Karunanithi             if (!originatorId.empty())
59368dd075aSAsmitha Karunanithi             {
59468dd075aSAsmitha Karunanithi                 thisEntry["Originator"] = originatorId;
59568dd075aSAsmitha Karunanithi                 thisEntry["OriginatorType"] = originatorType;
59668dd075aSAsmitha Karunanithi             }
59768dd075aSAsmitha Karunanithi 
5985cb1dd27SAsmitha Karunanithi             if (dumpType == "BMC")
5995cb1dd27SAsmitha Karunanithi             {
600d337bb72SAsmitha Karunanithi                 thisEntry["DiagnosticDataType"] = "Manager";
60189492a15SPatrick Williams                 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
60289492a15SPatrick Williams                                                  "/attachment";
603fdd26906SClaire Weinan                 thisEntry["AdditionalDataSizeBytes"] = size;
6045cb1dd27SAsmitha Karunanithi             }
6055cb1dd27SAsmitha Karunanithi             else if (dumpType == "System")
6065cb1dd27SAsmitha Karunanithi             {
607d337bb72SAsmitha Karunanithi                 thisEntry["DiagnosticDataType"] = "OEM";
608d337bb72SAsmitha Karunanithi                 thisEntry["OEMDiagnosticDataType"] = "System";
60989492a15SPatrick Williams                 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
61089492a15SPatrick Williams                                                  "/attachment";
611fdd26906SClaire Weinan                 thisEntry["AdditionalDataSizeBytes"] = size;
6125cb1dd27SAsmitha Karunanithi             }
613b2ba3072SPatrick Williams             entriesArray.emplace_back(std::move(thisEntry));
6145cb1dd27SAsmitha Karunanithi         }
615002d39b4SEd Tanous         asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
6163544d2a7SEd Tanous         asyncResp->res.jsonValue["Members"] = std::move(entriesArray);
6175eb468daSGeorge Liu     });
6185cb1dd27SAsmitha Karunanithi }
6195cb1dd27SAsmitha Karunanithi 
6208d1b46d7Szhanghch05 inline void
621c7a6d660SClaire Weinan     getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6228d1b46d7Szhanghch05                      const std::string& entryID, const std::string& dumpType)
6235cb1dd27SAsmitha Karunanithi {
624fdd26906SClaire Weinan     std::string entriesPath = getDumpEntriesPath(dumpType);
625fdd26906SClaire Weinan     if (entriesPath.empty())
6265cb1dd27SAsmitha Karunanithi     {
6275cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
6285cb1dd27SAsmitha Karunanithi         return;
6295cb1dd27SAsmitha Karunanithi     }
6305cb1dd27SAsmitha Karunanithi 
6315eb468daSGeorge Liu     sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
6325eb468daSGeorge Liu     dbus::utility::getManagedObjects(
6335eb468daSGeorge Liu         "xyz.openbmc_project.Dump.Manager", path,
634fdd26906SClaire Weinan         [asyncResp, entryID, dumpType,
6355e7e2dc5SEd Tanous          entriesPath](const boost::system::error_code& ec,
63602cad96eSEd Tanous                       const dbus::utility::ManagedObjectType& resp) {
6375cb1dd27SAsmitha Karunanithi         if (ec)
6385cb1dd27SAsmitha Karunanithi         {
63962598e31SEd Tanous             BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec);
6405cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
6415cb1dd27SAsmitha Karunanithi             return;
6425cb1dd27SAsmitha Karunanithi         }
6435cb1dd27SAsmitha Karunanithi 
644b47452b2SAsmitha Karunanithi         bool foundDumpEntry = false;
64518f8f608SEd Tanous         std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/";
646b47452b2SAsmitha Karunanithi 
6479eb808c1SEd Tanous         for (const auto& objectPath : resp)
6485cb1dd27SAsmitha Karunanithi         {
649b47452b2SAsmitha Karunanithi             if (objectPath.first.str != dumpEntryPath + entryID)
6505cb1dd27SAsmitha Karunanithi             {
6515cb1dd27SAsmitha Karunanithi                 continue;
6525cb1dd27SAsmitha Karunanithi             }
6535cb1dd27SAsmitha Karunanithi 
6545cb1dd27SAsmitha Karunanithi             foundDumpEntry = true;
655c6fecdabSClaire Weinan             uint64_t timestampUs = 0;
6565cb1dd27SAsmitha Karunanithi             uint64_t size = 0;
65735440d18SAsmitha Karunanithi             std::string dumpStatus;
65868dd075aSAsmitha Karunanithi             std::string originatorId;
65968dd075aSAsmitha Karunanithi             log_entry::OriginatorTypes originatorType =
66068dd075aSAsmitha Karunanithi                 log_entry::OriginatorTypes::Internal;
6615cb1dd27SAsmitha Karunanithi 
662aefe3786SClaire Weinan             parseDumpEntryFromDbusObject(objectPath, dumpStatus, size,
66368dd075aSAsmitha Karunanithi                                          timestampUs, originatorId,
66468dd075aSAsmitha Karunanithi                                          originatorType, asyncResp);
6655cb1dd27SAsmitha Karunanithi 
6660fda0f12SGeorge Liu             if (dumpStatus !=
6670fda0f12SGeorge Liu                     "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
66835440d18SAsmitha Karunanithi                 !dumpStatus.empty())
66935440d18SAsmitha Karunanithi             {
67035440d18SAsmitha Karunanithi                 // Dump status is not Complete
67135440d18SAsmitha Karunanithi                 // return not found until status is changed to Completed
672d1bde9e5SKrzysztof Grobelny                 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
673d1bde9e5SKrzysztof Grobelny                                            entryID);
67435440d18SAsmitha Karunanithi                 return;
67535440d18SAsmitha Karunanithi             }
67635440d18SAsmitha Karunanithi 
6775cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["@odata.type"] =
67868dd075aSAsmitha Karunanithi                 "#LogEntry.v1_11_0.LogEntry";
679fdd26906SClaire Weinan             asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID;
6805cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Id"] = entryID;
6815cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["EntryType"] = "Event";
6825cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
683bbd80db8SClaire Weinan             asyncResp->res.jsonValue["Created"] =
684bbd80db8SClaire Weinan                 redfish::time_utils::getDateTimeUintUs(timestampUs);
6855cb1dd27SAsmitha Karunanithi 
68668dd075aSAsmitha Karunanithi             if (!originatorId.empty())
68768dd075aSAsmitha Karunanithi             {
68868dd075aSAsmitha Karunanithi                 asyncResp->res.jsonValue["Originator"] = originatorId;
68968dd075aSAsmitha Karunanithi                 asyncResp->res.jsonValue["OriginatorType"] = originatorType;
69068dd075aSAsmitha Karunanithi             }
69168dd075aSAsmitha Karunanithi 
6925cb1dd27SAsmitha Karunanithi             if (dumpType == "BMC")
6935cb1dd27SAsmitha Karunanithi             {
694d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
695d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataURI"] =
696fdd26906SClaire Weinan                     entriesPath + entryID + "/attachment";
697fdd26906SClaire Weinan                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
6985cb1dd27SAsmitha Karunanithi             }
6995cb1dd27SAsmitha Karunanithi             else if (dumpType == "System")
7005cb1dd27SAsmitha Karunanithi             {
701d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
702002d39b4SEd Tanous                 asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System";
703d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataURI"] =
704fdd26906SClaire Weinan                     entriesPath + entryID + "/attachment";
705fdd26906SClaire Weinan                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
7065cb1dd27SAsmitha Karunanithi             }
7075cb1dd27SAsmitha Karunanithi         }
708e05aec50SEd Tanous         if (!foundDumpEntry)
709b47452b2SAsmitha Karunanithi         {
71062598e31SEd Tanous             BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID);
711b90d14f2SMyung Bae             messages::resourceNotFound(asyncResp->res, dumpType + " dump",
712b90d14f2SMyung Bae                                        entryID);
713b47452b2SAsmitha Karunanithi             return;
714b47452b2SAsmitha Karunanithi         }
7155eb468daSGeorge Liu     });
7165cb1dd27SAsmitha Karunanithi }
7175cb1dd27SAsmitha Karunanithi 
7188d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7199878256fSStanley Chu                             const std::string& entryID,
720b47452b2SAsmitha Karunanithi                             const std::string& dumpType)
7215cb1dd27SAsmitha Karunanithi {
7225a39f77aSPatrick Williams     auto respHandler = [asyncResp,
7235a39f77aSPatrick Williams                         entryID](const boost::system::error_code& ec) {
72462598e31SEd Tanous         BMCWEB_LOG_DEBUG("Dump Entry doDelete callback: Done");
7255cb1dd27SAsmitha Karunanithi         if (ec)
7265cb1dd27SAsmitha Karunanithi         {
7273de8d8baSGeorge Liu             if (ec.value() == EBADR)
7283de8d8baSGeorge Liu             {
7293de8d8baSGeorge Liu                 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
7303de8d8baSGeorge Liu                 return;
7313de8d8baSGeorge Liu             }
73262598e31SEd Tanous             BMCWEB_LOG_ERROR(
73362598e31SEd Tanous                 "Dump (DBus) doDelete respHandler got error {} entryID={}", ec,
73462598e31SEd Tanous                 entryID);
7355cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
7365cb1dd27SAsmitha Karunanithi             return;
7375cb1dd27SAsmitha Karunanithi         }
7385cb1dd27SAsmitha Karunanithi     };
73918f8f608SEd Tanous 
7405cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
7415cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
74218f8f608SEd Tanous         std::format("{}/entry/{}", getDumpPath(dumpType), entryID),
7435cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
7445cb1dd27SAsmitha Karunanithi }
745b5f288d2SAbhilash Raju inline bool checkSizeLimit(int fd, crow::Response& res)
746b5f288d2SAbhilash Raju {
747b5f288d2SAbhilash Raju     long long int size = lseek(fd, 0, SEEK_END);
748b5f288d2SAbhilash Raju     if (size <= 0)
749b5f288d2SAbhilash Raju     {
750b5f288d2SAbhilash Raju         BMCWEB_LOG_ERROR("Failed to get size of file, lseek() returned {}",
751b5f288d2SAbhilash Raju                          size);
752b5f288d2SAbhilash Raju         messages::internalError(res);
753b5f288d2SAbhilash Raju         return false;
754b5f288d2SAbhilash Raju     }
7555cb1dd27SAsmitha Karunanithi 
756b5f288d2SAbhilash Raju     // Arbitrary max size of 20MB to accommodate BMC dumps
757b5f288d2SAbhilash Raju     constexpr long long int maxFileSize = 20LL * 1024LL * 1024LL;
758b5f288d2SAbhilash Raju     if (size > maxFileSize)
759b5f288d2SAbhilash Raju     {
760b5f288d2SAbhilash Raju         BMCWEB_LOG_ERROR("File size {} exceeds maximum allowed size of {}",
761b5f288d2SAbhilash Raju                          size, maxFileSize);
762b5f288d2SAbhilash Raju         messages::internalError(res);
763b5f288d2SAbhilash Raju         return false;
764b5f288d2SAbhilash Raju     }
765b5f288d2SAbhilash Raju     off_t rc = lseek(fd, 0, SEEK_SET);
766b5f288d2SAbhilash Raju     if (rc < 0)
767b5f288d2SAbhilash Raju     {
768b5f288d2SAbhilash Raju         BMCWEB_LOG_ERROR("Failed to reset file offset to 0");
769b5f288d2SAbhilash Raju         messages::internalError(res);
770b5f288d2SAbhilash Raju         return false;
771b5f288d2SAbhilash Raju     }
772b5f288d2SAbhilash Raju     return true;
773b5f288d2SAbhilash Raju }
774168d1b1aSCarson Labrado inline void
775168d1b1aSCarson Labrado     downloadEntryCallback(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
776168d1b1aSCarson Labrado                           const std::string& entryID,
777168d1b1aSCarson Labrado                           const std::string& downloadEntryType,
778168d1b1aSCarson Labrado                           const boost::system::error_code& ec,
779168d1b1aSCarson Labrado                           const sdbusplus::message::unix_fd& unixfd)
780168d1b1aSCarson Labrado {
781168d1b1aSCarson Labrado     if (ec.value() == EBADR)
782168d1b1aSCarson Labrado     {
783168d1b1aSCarson Labrado         messages::resourceNotFound(asyncResp->res, "EntryAttachment", entryID);
784168d1b1aSCarson Labrado         return;
785168d1b1aSCarson Labrado     }
786168d1b1aSCarson Labrado     if (ec)
787168d1b1aSCarson Labrado     {
788168d1b1aSCarson Labrado         BMCWEB_LOG_ERROR("DBUS response error: {}", ec);
789168d1b1aSCarson Labrado         messages::internalError(asyncResp->res);
790168d1b1aSCarson Labrado         return;
791168d1b1aSCarson Labrado     }
792168d1b1aSCarson Labrado 
793168d1b1aSCarson Labrado     // Make sure we know how to process the retrieved entry attachment
794168d1b1aSCarson Labrado     if ((downloadEntryType != "BMC") && (downloadEntryType != "System"))
795168d1b1aSCarson Labrado     {
796168d1b1aSCarson Labrado         BMCWEB_LOG_ERROR("downloadEntryCallback() invalid entry type: {}",
797168d1b1aSCarson Labrado                          downloadEntryType);
798168d1b1aSCarson Labrado         messages::internalError(asyncResp->res);
799168d1b1aSCarson Labrado     }
800168d1b1aSCarson Labrado 
801168d1b1aSCarson Labrado     int fd = -1;
802168d1b1aSCarson Labrado     fd = dup(unixfd);
803168d1b1aSCarson Labrado     if (fd < 0)
804168d1b1aSCarson Labrado     {
805168d1b1aSCarson Labrado         BMCWEB_LOG_ERROR("Failed to open file");
806168d1b1aSCarson Labrado         messages::internalError(asyncResp->res);
807168d1b1aSCarson Labrado         return;
808168d1b1aSCarson Labrado     }
809b5f288d2SAbhilash Raju     if (!checkSizeLimit(fd, asyncResp->res))
810168d1b1aSCarson Labrado     {
811168d1b1aSCarson Labrado         close(fd);
812168d1b1aSCarson Labrado         return;
813168d1b1aSCarson Labrado     }
814168d1b1aSCarson Labrado     if (downloadEntryType == "System")
815168d1b1aSCarson Labrado     {
816b5f288d2SAbhilash Raju         if (!asyncResp->res.openFd(fd, bmcweb::EncodingType::Base64))
817b5f288d2SAbhilash Raju         {
818b5f288d2SAbhilash Raju             messages::internalError(asyncResp->res);
819b5f288d2SAbhilash Raju             close(fd);
820b5f288d2SAbhilash Raju             return;
821b5f288d2SAbhilash Raju         }
822168d1b1aSCarson Labrado         asyncResp->res.addHeader(
823168d1b1aSCarson Labrado             boost::beast::http::field::content_transfer_encoding, "Base64");
824b5f288d2SAbhilash Raju         return;
825168d1b1aSCarson Labrado     }
826b5f288d2SAbhilash Raju     if (!asyncResp->res.openFd(fd))
82727b0cf90SEd Tanous     {
828b5f288d2SAbhilash Raju         messages::internalError(asyncResp->res);
829b5f288d2SAbhilash Raju         close(fd);
830b5f288d2SAbhilash Raju         return;
83127b0cf90SEd Tanous     }
832168d1b1aSCarson Labrado     asyncResp->res.addHeader(boost::beast::http::field::content_type,
833168d1b1aSCarson Labrado                              "application/octet-stream");
834168d1b1aSCarson Labrado }
835168d1b1aSCarson Labrado 
836168d1b1aSCarson Labrado inline void
837168d1b1aSCarson Labrado     downloadDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
838168d1b1aSCarson Labrado                       const std::string& entryID, const std::string& dumpType)
839168d1b1aSCarson Labrado {
840168d1b1aSCarson Labrado     if (dumpType != "BMC")
841168d1b1aSCarson Labrado     {
842168d1b1aSCarson Labrado         BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID);
843168d1b1aSCarson Labrado         messages::resourceNotFound(asyncResp->res, dumpType + " dump", entryID);
844168d1b1aSCarson Labrado         return;
845168d1b1aSCarson Labrado     }
846168d1b1aSCarson Labrado 
84718f8f608SEd Tanous     std::string dumpEntryPath = std::format("{}/entry/{}",
84818f8f608SEd Tanous                                             getDumpPath(dumpType), entryID);
849168d1b1aSCarson Labrado 
850168d1b1aSCarson Labrado     auto downloadDumpEntryHandler =
851168d1b1aSCarson Labrado         [asyncResp, entryID,
852168d1b1aSCarson Labrado          dumpType](const boost::system::error_code& ec,
853168d1b1aSCarson Labrado                    const sdbusplus::message::unix_fd& unixfd) {
854168d1b1aSCarson Labrado         downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd);
855168d1b1aSCarson Labrado     };
856168d1b1aSCarson Labrado 
857168d1b1aSCarson Labrado     crow::connections::systemBus->async_method_call(
858168d1b1aSCarson Labrado         std::move(downloadDumpEntryHandler), "xyz.openbmc_project.Dump.Manager",
859168d1b1aSCarson Labrado         dumpEntryPath, "xyz.openbmc_project.Dump.Entry", "GetFileHandle");
860168d1b1aSCarson Labrado }
861168d1b1aSCarson Labrado 
862168d1b1aSCarson Labrado inline void
863168d1b1aSCarson Labrado     downloadEventLogEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
864168d1b1aSCarson Labrado                           const std::string& systemName,
865168d1b1aSCarson Labrado                           const std::string& entryID,
866168d1b1aSCarson Labrado                           const std::string& dumpType)
867168d1b1aSCarson Labrado {
868168d1b1aSCarson Labrado     if constexpr (bmcwebEnableMultiHost)
869168d1b1aSCarson Labrado     {
870168d1b1aSCarson Labrado         // Option currently returns no systems.  TBD
871168d1b1aSCarson Labrado         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
872168d1b1aSCarson Labrado                                    systemName);
873168d1b1aSCarson Labrado         return;
874168d1b1aSCarson Labrado     }
875168d1b1aSCarson Labrado     if (systemName != "system")
876168d1b1aSCarson Labrado     {
877168d1b1aSCarson Labrado         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
878168d1b1aSCarson Labrado                                    systemName);
879168d1b1aSCarson Labrado         return;
880168d1b1aSCarson Labrado     }
881168d1b1aSCarson Labrado 
882168d1b1aSCarson Labrado     std::string entryPath =
883168d1b1aSCarson Labrado         sdbusplus::message::object_path("/xyz/openbmc_project/logging/entry") /
884168d1b1aSCarson Labrado         entryID;
885168d1b1aSCarson Labrado 
886168d1b1aSCarson Labrado     auto downloadEventLogEntryHandler =
887168d1b1aSCarson Labrado         [asyncResp, entryID,
888168d1b1aSCarson Labrado          dumpType](const boost::system::error_code& ec,
889168d1b1aSCarson Labrado                    const sdbusplus::message::unix_fd& unixfd) {
890168d1b1aSCarson Labrado         downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd);
891168d1b1aSCarson Labrado     };
892168d1b1aSCarson Labrado 
893168d1b1aSCarson Labrado     crow::connections::systemBus->async_method_call(
894168d1b1aSCarson Labrado         std::move(downloadEventLogEntryHandler), "xyz.openbmc_project.Logging",
895168d1b1aSCarson Labrado         entryPath, "xyz.openbmc_project.Logging.Entry", "GetEntry");
896168d1b1aSCarson Labrado }
897168d1b1aSCarson Labrado 
8988e31778eSAsmitha Karunanithi inline DumpCreationProgress
8998e31778eSAsmitha Karunanithi     mapDbusStatusToDumpProgress(const std::string& status)
900a43be80fSAsmitha Karunanithi {
9018e31778eSAsmitha Karunanithi     if (status ==
9028e31778eSAsmitha Karunanithi             "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" ||
9038e31778eSAsmitha Karunanithi         status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted")
9048e31778eSAsmitha Karunanithi     {
9058e31778eSAsmitha Karunanithi         return DumpCreationProgress::DUMP_CREATE_FAILED;
9068e31778eSAsmitha Karunanithi     }
9078e31778eSAsmitha Karunanithi     if (status ==
9088e31778eSAsmitha Karunanithi         "xyz.openbmc_project.Common.Progress.OperationStatus.Completed")
9098e31778eSAsmitha Karunanithi     {
9108e31778eSAsmitha Karunanithi         return DumpCreationProgress::DUMP_CREATE_SUCCESS;
9118e31778eSAsmitha Karunanithi     }
9128e31778eSAsmitha Karunanithi     return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
9138e31778eSAsmitha Karunanithi }
9148e31778eSAsmitha Karunanithi 
9158e31778eSAsmitha Karunanithi inline DumpCreationProgress
9168e31778eSAsmitha Karunanithi     getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values)
9178e31778eSAsmitha Karunanithi {
9188e31778eSAsmitha Karunanithi     for (const auto& [key, val] : values)
9198e31778eSAsmitha Karunanithi     {
9208e31778eSAsmitha Karunanithi         if (key == "Status")
9218e31778eSAsmitha Karunanithi         {
9228e31778eSAsmitha Karunanithi             const std::string* value = std::get_if<std::string>(&val);
9238e31778eSAsmitha Karunanithi             if (value == nullptr)
9248e31778eSAsmitha Karunanithi             {
92562598e31SEd Tanous                 BMCWEB_LOG_ERROR("Status property value is null");
9268e31778eSAsmitha Karunanithi                 return DumpCreationProgress::DUMP_CREATE_FAILED;
9278e31778eSAsmitha Karunanithi             }
9288e31778eSAsmitha Karunanithi             return mapDbusStatusToDumpProgress(*value);
9298e31778eSAsmitha Karunanithi         }
9308e31778eSAsmitha Karunanithi     }
9318e31778eSAsmitha Karunanithi     return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
9328e31778eSAsmitha Karunanithi }
9338e31778eSAsmitha Karunanithi 
9348e31778eSAsmitha Karunanithi inline std::string getDumpEntryPath(const std::string& dumpPath)
9358e31778eSAsmitha Karunanithi {
9368e31778eSAsmitha Karunanithi     if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry")
9378e31778eSAsmitha Karunanithi     {
9388e31778eSAsmitha Karunanithi         return "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
9398e31778eSAsmitha Karunanithi     }
9408e31778eSAsmitha Karunanithi     if (dumpPath == "/xyz/openbmc_project/dump/system/entry")
9418e31778eSAsmitha Karunanithi     {
9428e31778eSAsmitha Karunanithi         return "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
9438e31778eSAsmitha Karunanithi     }
9448e31778eSAsmitha Karunanithi     return "";
9458e31778eSAsmitha Karunanithi }
9468e31778eSAsmitha Karunanithi 
9478e31778eSAsmitha Karunanithi inline void createDumpTaskCallback(
9488e31778eSAsmitha Karunanithi     task::Payload&& payload,
9498e31778eSAsmitha Karunanithi     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
9508e31778eSAsmitha Karunanithi     const sdbusplus::message::object_path& createdObjPath)
9518e31778eSAsmitha Karunanithi {
9528e31778eSAsmitha Karunanithi     const std::string dumpPath = createdObjPath.parent_path().str;
9538e31778eSAsmitha Karunanithi     const std::string dumpId = createdObjPath.filename();
9548e31778eSAsmitha Karunanithi 
9558e31778eSAsmitha Karunanithi     std::string dumpEntryPath = getDumpEntryPath(dumpPath);
9568e31778eSAsmitha Karunanithi 
9578e31778eSAsmitha Karunanithi     if (dumpEntryPath.empty())
9588e31778eSAsmitha Karunanithi     {
95962598e31SEd Tanous         BMCWEB_LOG_ERROR("Invalid dump type received");
9608e31778eSAsmitha Karunanithi         messages::internalError(asyncResp->res);
9618e31778eSAsmitha Karunanithi         return;
9628e31778eSAsmitha Karunanithi     }
9638e31778eSAsmitha Karunanithi 
9648e31778eSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
9658cb2c024SEd Tanous         [asyncResp, payload = std::move(payload), createdObjPath,
9668e31778eSAsmitha Karunanithi          dumpEntryPath{std::move(dumpEntryPath)},
9675e7e2dc5SEd Tanous          dumpId](const boost::system::error_code& ec,
9688e31778eSAsmitha Karunanithi                  const std::string& introspectXml) {
9698e31778eSAsmitha Karunanithi         if (ec)
9708e31778eSAsmitha Karunanithi         {
97162598e31SEd Tanous             BMCWEB_LOG_ERROR("Introspect call failed with error: {}",
97262598e31SEd Tanous                              ec.message());
9738e31778eSAsmitha Karunanithi             messages::internalError(asyncResp->res);
9748e31778eSAsmitha Karunanithi             return;
9758e31778eSAsmitha Karunanithi         }
9768e31778eSAsmitha Karunanithi 
9778e31778eSAsmitha Karunanithi         // Check if the created dump object has implemented Progress
9788e31778eSAsmitha Karunanithi         // interface to track dump completion. If yes, fetch the "Status"
9798e31778eSAsmitha Karunanithi         // property of the interface, modify the task state accordingly.
9808e31778eSAsmitha Karunanithi         // Else, return task completed.
9818e31778eSAsmitha Karunanithi         tinyxml2::XMLDocument doc;
9828e31778eSAsmitha Karunanithi 
9838e31778eSAsmitha Karunanithi         doc.Parse(introspectXml.data(), introspectXml.size());
9848e31778eSAsmitha Karunanithi         tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
9858e31778eSAsmitha Karunanithi         if (pRoot == nullptr)
9868e31778eSAsmitha Karunanithi         {
98762598e31SEd Tanous             BMCWEB_LOG_ERROR("XML document failed to parse");
9888e31778eSAsmitha Karunanithi             messages::internalError(asyncResp->res);
9898e31778eSAsmitha Karunanithi             return;
9908e31778eSAsmitha Karunanithi         }
9918e31778eSAsmitha Karunanithi         tinyxml2::XMLElement* interfaceNode =
9928e31778eSAsmitha Karunanithi             pRoot->FirstChildElement("interface");
9938e31778eSAsmitha Karunanithi 
9948e31778eSAsmitha Karunanithi         bool isProgressIntfPresent = false;
9958e31778eSAsmitha Karunanithi         while (interfaceNode != nullptr)
9968e31778eSAsmitha Karunanithi         {
9978e31778eSAsmitha Karunanithi             const char* thisInterfaceName = interfaceNode->Attribute("name");
9988e31778eSAsmitha Karunanithi             if (thisInterfaceName != nullptr)
9998e31778eSAsmitha Karunanithi             {
10008e31778eSAsmitha Karunanithi                 if (thisInterfaceName ==
10018e31778eSAsmitha Karunanithi                     std::string_view("xyz.openbmc_project.Common.Progress"))
10028e31778eSAsmitha Karunanithi                 {
10038e31778eSAsmitha Karunanithi                     interfaceNode =
10048e31778eSAsmitha Karunanithi                         interfaceNode->NextSiblingElement("interface");
10058e31778eSAsmitha Karunanithi                     continue;
10068e31778eSAsmitha Karunanithi                 }
10078e31778eSAsmitha Karunanithi                 isProgressIntfPresent = true;
10088e31778eSAsmitha Karunanithi                 break;
10098e31778eSAsmitha Karunanithi             }
10108e31778eSAsmitha Karunanithi             interfaceNode = interfaceNode->NextSiblingElement("interface");
10118e31778eSAsmitha Karunanithi         }
10128e31778eSAsmitha Karunanithi 
1013a43be80fSAsmitha Karunanithi         std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
10148e31778eSAsmitha Karunanithi             [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent](
10158b24275dSEd Tanous                 const boost::system::error_code& ec2, sdbusplus::message_t& msg,
1016a43be80fSAsmitha Karunanithi                 const std::shared_ptr<task::TaskData>& taskData) {
10178b24275dSEd Tanous             if (ec2)
1018cb13a392SEd Tanous             {
101962598e31SEd Tanous                 BMCWEB_LOG_ERROR("{}: Error in creating dump",
102062598e31SEd Tanous                                  createdObjPath.str);
10218e31778eSAsmitha Karunanithi                 taskData->messages.emplace_back(messages::internalError());
10226145ed6fSAsmitha Karunanithi                 taskData->state = "Cancelled";
10236145ed6fSAsmitha Karunanithi                 return task::completed;
1024cb13a392SEd Tanous             }
1025b9d36b47SEd Tanous 
10268e31778eSAsmitha Karunanithi             if (isProgressIntfPresent)
1027a43be80fSAsmitha Karunanithi             {
10288e31778eSAsmitha Karunanithi                 dbus::utility::DBusPropertiesMap values;
10298e31778eSAsmitha Karunanithi                 std::string prop;
10308e31778eSAsmitha Karunanithi                 msg.read(prop, values);
10318e31778eSAsmitha Karunanithi 
10328e31778eSAsmitha Karunanithi                 DumpCreationProgress dumpStatus =
10338e31778eSAsmitha Karunanithi                     getDumpCompletionStatus(values);
10348e31778eSAsmitha Karunanithi                 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED)
10358e31778eSAsmitha Karunanithi                 {
103662598e31SEd Tanous                     BMCWEB_LOG_ERROR("{}: Error in creating dump",
103762598e31SEd Tanous                                      createdObjPath.str);
10388e31778eSAsmitha Karunanithi                     taskData->state = "Cancelled";
10398e31778eSAsmitha Karunanithi                     return task::completed;
10408e31778eSAsmitha Karunanithi                 }
10418e31778eSAsmitha Karunanithi 
10428e31778eSAsmitha Karunanithi                 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS)
10438e31778eSAsmitha Karunanithi                 {
104462598e31SEd Tanous                     BMCWEB_LOG_DEBUG("{}: Dump creation task is in progress",
104562598e31SEd Tanous                                      createdObjPath.str);
10468e31778eSAsmitha Karunanithi                     return !task::completed;
10478e31778eSAsmitha Karunanithi                 }
10488e31778eSAsmitha Karunanithi             }
10498e31778eSAsmitha Karunanithi 
1050a43be80fSAsmitha Karunanithi             nlohmann::json retMessage = messages::success();
1051a43be80fSAsmitha Karunanithi             taskData->messages.emplace_back(retMessage);
1052a43be80fSAsmitha Karunanithi 
1053c51a58eeSEd Tanous             boost::urls::url url = boost::urls::format(
1054c51a58eeSEd Tanous                 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/{}", dumpId);
1055c51a58eeSEd Tanous 
1056c51a58eeSEd Tanous             std::string headerLoc = "Location: ";
1057c51a58eeSEd Tanous             headerLoc += url.buffer();
1058c51a58eeSEd Tanous 
1059002d39b4SEd Tanous             taskData->payload->httpHeaders.emplace_back(std::move(headerLoc));
1060a43be80fSAsmitha Karunanithi 
106162598e31SEd Tanous             BMCWEB_LOG_DEBUG("{}: Dump creation task completed",
106262598e31SEd Tanous                              createdObjPath.str);
1063a43be80fSAsmitha Karunanithi             taskData->state = "Completed";
1064b47452b2SAsmitha Karunanithi             return task::completed;
1065a43be80fSAsmitha Karunanithi         },
10668e31778eSAsmitha Karunanithi             "type='signal',interface='org.freedesktop.DBus.Properties',"
10678e31778eSAsmitha Karunanithi             "member='PropertiesChanged',path='" +
10688e31778eSAsmitha Karunanithi                 createdObjPath.str + "'");
1069a43be80fSAsmitha Karunanithi 
10708e31778eSAsmitha Karunanithi         // The task timer is set to max time limit within which the
10718e31778eSAsmitha Karunanithi         // requested dump will be collected.
10728e31778eSAsmitha Karunanithi         task->startTimer(std::chrono::minutes(6));
1073a43be80fSAsmitha Karunanithi         task->populateResp(asyncResp->res);
10748e31778eSAsmitha Karunanithi         task->payload.emplace(payload);
10758e31778eSAsmitha Karunanithi     },
10768e31778eSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", createdObjPath,
10778e31778eSAsmitha Karunanithi         "org.freedesktop.DBus.Introspectable", "Introspect");
1078a43be80fSAsmitha Karunanithi }
1079a43be80fSAsmitha Karunanithi 
10808d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
10818d1b46d7Szhanghch05                        const crow::Request& req, const std::string& dumpType)
1082a43be80fSAsmitha Karunanithi {
1083fdd26906SClaire Weinan     std::string dumpPath = getDumpEntriesPath(dumpType);
1084fdd26906SClaire Weinan     if (dumpPath.empty())
1085a43be80fSAsmitha Karunanithi     {
1086a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
1087a43be80fSAsmitha Karunanithi         return;
1088a43be80fSAsmitha Karunanithi     }
1089a43be80fSAsmitha Karunanithi 
1090a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
1091a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
1092a43be80fSAsmitha Karunanithi 
109315ed6780SWilly Tu     if (!redfish::json_util::readJsonAction(
1094a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
1095a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
1096a43be80fSAsmitha Karunanithi     {
1097a43be80fSAsmitha Karunanithi         return;
1098a43be80fSAsmitha Karunanithi     }
1099a43be80fSAsmitha Karunanithi 
1100a43be80fSAsmitha Karunanithi     if (dumpType == "System")
1101a43be80fSAsmitha Karunanithi     {
1102a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
1103a43be80fSAsmitha Karunanithi         {
110462598e31SEd Tanous             BMCWEB_LOG_ERROR(
110562598e31SEd Tanous                 "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!");
1106a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
1107a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
1108a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
1109a43be80fSAsmitha Karunanithi             return;
1110a43be80fSAsmitha Karunanithi         }
11113174e4dfSEd Tanous         if ((*oemDiagnosticDataType != "System") ||
1112a43be80fSAsmitha Karunanithi             (*diagnosticDataType != "OEM"))
1113a43be80fSAsmitha Karunanithi         {
111462598e31SEd Tanous             BMCWEB_LOG_ERROR("Wrong parameter values passed");
1115ace85d60SEd Tanous             messages::internalError(asyncResp->res);
1116a43be80fSAsmitha Karunanithi             return;
1117a43be80fSAsmitha Karunanithi         }
11185907571dSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/";
1119a43be80fSAsmitha Karunanithi     }
1120a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
1121a43be80fSAsmitha Karunanithi     {
1122a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
1123a43be80fSAsmitha Karunanithi         {
112462598e31SEd Tanous             BMCWEB_LOG_ERROR(
112562598e31SEd Tanous                 "CreateDump action parameter 'DiagnosticDataType' not found!");
1126a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
1127a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
1128a43be80fSAsmitha Karunanithi             return;
1129a43be80fSAsmitha Karunanithi         }
11303174e4dfSEd Tanous         if (*diagnosticDataType != "Manager")
1131a43be80fSAsmitha Karunanithi         {
113262598e31SEd Tanous             BMCWEB_LOG_ERROR(
113362598e31SEd Tanous                 "Wrong parameter value passed for 'DiagnosticDataType'");
1134ace85d60SEd Tanous             messages::internalError(asyncResp->res);
1135a43be80fSAsmitha Karunanithi             return;
1136a43be80fSAsmitha Karunanithi         }
11375907571dSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/";
11385907571dSAsmitha Karunanithi     }
11395907571dSAsmitha Karunanithi     else
11405907571dSAsmitha Karunanithi     {
114162598e31SEd Tanous         BMCWEB_LOG_ERROR("CreateDump failed. Unknown dump type");
11425907571dSAsmitha Karunanithi         messages::internalError(asyncResp->res);
11435907571dSAsmitha Karunanithi         return;
1144a43be80fSAsmitha Karunanithi     }
1145a43be80fSAsmitha Karunanithi 
11468e31778eSAsmitha Karunanithi     std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>>
11478e31778eSAsmitha Karunanithi         createDumpParamVec;
11488e31778eSAsmitha Karunanithi 
1149f574a8e1SCarson Labrado     if (req.session != nullptr)
1150f574a8e1SCarson Labrado     {
115168dd075aSAsmitha Karunanithi         createDumpParamVec.emplace_back(
115268dd075aSAsmitha Karunanithi             "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId",
115368dd075aSAsmitha Karunanithi             req.session->clientIp);
115468dd075aSAsmitha Karunanithi         createDumpParamVec.emplace_back(
115568dd075aSAsmitha Karunanithi             "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType",
115668dd075aSAsmitha Karunanithi             "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client");
1157f574a8e1SCarson Labrado     }
115868dd075aSAsmitha Karunanithi 
1159a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
11605e7e2dc5SEd Tanous         [asyncResp, payload(task::Payload(req)),
11615e7e2dc5SEd Tanous          dumpPath](const boost::system::error_code& ec,
11625e7e2dc5SEd Tanous                    const sdbusplus::message_t& msg,
11638e31778eSAsmitha Karunanithi                    const sdbusplus::message::object_path& objPath) mutable {
1164a43be80fSAsmitha Karunanithi         if (ec)
1165a43be80fSAsmitha Karunanithi         {
116662598e31SEd Tanous             BMCWEB_LOG_ERROR("CreateDump resp_handler got error {}", ec);
11675907571dSAsmitha Karunanithi             const sd_bus_error* dbusError = msg.get_error();
11685907571dSAsmitha Karunanithi             if (dbusError == nullptr)
11695907571dSAsmitha Karunanithi             {
11705907571dSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
11715907571dSAsmitha Karunanithi                 return;
11725907571dSAsmitha Karunanithi             }
11735907571dSAsmitha Karunanithi 
117462598e31SEd Tanous             BMCWEB_LOG_ERROR("CreateDump DBus error: {} and error msg: {}",
117562598e31SEd Tanous                              dbusError->name, dbusError->message);
11765907571dSAsmitha Karunanithi             if (std::string_view(
11775907571dSAsmitha Karunanithi                     "xyz.openbmc_project.Common.Error.NotAllowed") ==
11785907571dSAsmitha Karunanithi                 dbusError->name)
11795907571dSAsmitha Karunanithi             {
11805907571dSAsmitha Karunanithi                 messages::resourceInStandby(asyncResp->res);
11815907571dSAsmitha Karunanithi                 return;
11825907571dSAsmitha Karunanithi             }
11835907571dSAsmitha Karunanithi             if (std::string_view(
11845907571dSAsmitha Karunanithi                     "xyz.openbmc_project.Dump.Create.Error.Disabled") ==
11855907571dSAsmitha Karunanithi                 dbusError->name)
11865907571dSAsmitha Karunanithi             {
11875907571dSAsmitha Karunanithi                 messages::serviceDisabled(asyncResp->res, dumpPath);
11885907571dSAsmitha Karunanithi                 return;
11895907571dSAsmitha Karunanithi             }
11905907571dSAsmitha Karunanithi             if (std::string_view(
11915907571dSAsmitha Karunanithi                     "xyz.openbmc_project.Common.Error.Unavailable") ==
11925907571dSAsmitha Karunanithi                 dbusError->name)
11935907571dSAsmitha Karunanithi             {
11945907571dSAsmitha Karunanithi                 messages::resourceInUse(asyncResp->res);
11955907571dSAsmitha Karunanithi                 return;
11965907571dSAsmitha Karunanithi             }
11975907571dSAsmitha Karunanithi             // Other Dbus errors such as:
11985907571dSAsmitha Karunanithi             // xyz.openbmc_project.Common.Error.InvalidArgument &
11995907571dSAsmitha Karunanithi             // org.freedesktop.DBus.Error.InvalidArgs are all related to
12005907571dSAsmitha Karunanithi             // the dbus call that is made here in the bmcweb
12015907571dSAsmitha Karunanithi             // implementation and has nothing to do with the client's
12025907571dSAsmitha Karunanithi             // input in the request. Hence, returning internal error
12035907571dSAsmitha Karunanithi             // back to the client.
1204a43be80fSAsmitha Karunanithi             messages::internalError(asyncResp->res);
1205a43be80fSAsmitha Karunanithi             return;
1206a43be80fSAsmitha Karunanithi         }
120762598e31SEd Tanous         BMCWEB_LOG_DEBUG("Dump Created. Path: {}", objPath.str);
12088e31778eSAsmitha Karunanithi         createDumpTaskCallback(std::move(payload), asyncResp, objPath);
1209a43be80fSAsmitha Karunanithi     },
121018f8f608SEd Tanous         "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType),
12118e31778eSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec);
1212a43be80fSAsmitha Karunanithi }
1213a43be80fSAsmitha Karunanithi 
12148d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
12158d1b46d7Szhanghch05                       const std::string& dumpType)
121680319af1SAsmitha Karunanithi {
12170d946211SClaire Weinan     crow::connections::systemBus->async_method_call(
12180d946211SClaire Weinan         [asyncResp](const boost::system::error_code& ec) {
121980319af1SAsmitha Karunanithi         if (ec)
122080319af1SAsmitha Karunanithi         {
122162598e31SEd Tanous             BMCWEB_LOG_ERROR("clearDump resp_handler got error {}", ec);
122280319af1SAsmitha Karunanithi             messages::internalError(asyncResp->res);
122380319af1SAsmitha Karunanithi             return;
122480319af1SAsmitha Karunanithi         }
12250d946211SClaire Weinan     },
122618f8f608SEd Tanous         "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType),
12270d946211SClaire Weinan         "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
122880319af1SAsmitha Karunanithi }
122980319af1SAsmitha Karunanithi 
1230df254f2cSEd Tanous inline void
1231b9d36b47SEd Tanous     parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params,
1232b9d36b47SEd Tanous                              std::string& filename, std::string& timestamp,
1233b9d36b47SEd Tanous                              std::string& logfile)
1234043a0536SJohnathan Mantey {
1235d1bde9e5SKrzysztof Grobelny     const std::string* filenamePtr = nullptr;
1236d1bde9e5SKrzysztof Grobelny     const std::string* timestampPtr = nullptr;
1237d1bde9e5SKrzysztof Grobelny     const std::string* logfilePtr = nullptr;
1238d1bde9e5SKrzysztof Grobelny 
1239d1bde9e5SKrzysztof Grobelny     const bool success = sdbusplus::unpackPropertiesNoThrow(
1240d1bde9e5SKrzysztof Grobelny         dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr,
1241d1bde9e5SKrzysztof Grobelny         "Filename", filenamePtr, "Log", logfilePtr);
1242d1bde9e5SKrzysztof Grobelny 
1243d1bde9e5SKrzysztof Grobelny     if (!success)
1244043a0536SJohnathan Mantey     {
1245d1bde9e5SKrzysztof Grobelny         return;
1246043a0536SJohnathan Mantey     }
1247d1bde9e5SKrzysztof Grobelny 
1248d1bde9e5SKrzysztof Grobelny     if (filenamePtr != nullptr)
1249043a0536SJohnathan Mantey     {
1250d1bde9e5SKrzysztof Grobelny         filename = *filenamePtr;
1251d1bde9e5SKrzysztof Grobelny     }
1252d1bde9e5SKrzysztof Grobelny 
1253d1bde9e5SKrzysztof Grobelny     if (timestampPtr != nullptr)
1254043a0536SJohnathan Mantey     {
1255d1bde9e5SKrzysztof Grobelny         timestamp = *timestampPtr;
1256043a0536SJohnathan Mantey     }
1257d1bde9e5SKrzysztof Grobelny 
1258d1bde9e5SKrzysztof Grobelny     if (logfilePtr != nullptr)
1259043a0536SJohnathan Mantey     {
1260d1bde9e5SKrzysztof Grobelny         logfile = *logfilePtr;
1261043a0536SJohnathan Mantey     }
1262043a0536SJohnathan Mantey }
1263043a0536SJohnathan Mantey 
12647e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app)
12651da66f75SEd Tanous {
1266c4bf6374SJason M. Bills     /**
1267c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
1268c4bf6374SJason M. Bills      */
126922d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/")
1270ed398213SEd Tanous         .privileges(redfish::privileges::getLogServiceCollection)
1271002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1272002d39b4SEd Tanous             [&app](const crow::Request& req,
127322d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
127422d268cbSEd Tanous                    const std::string& systemName) {
12753ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
1276c4bf6374SJason M. Bills         {
127745ca1b86SEd Tanous             return;
127845ca1b86SEd Tanous         }
12797f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
12807f3e84a1SEd Tanous         {
12817f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
12827f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
12837f3e84a1SEd Tanous                                        systemName);
12847f3e84a1SEd Tanous             return;
12857f3e84a1SEd Tanous         }
128622d268cbSEd Tanous         if (systemName != "system")
128722d268cbSEd Tanous         {
128822d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
128922d268cbSEd Tanous                                        systemName);
129022d268cbSEd Tanous             return;
129122d268cbSEd Tanous         }
129222d268cbSEd Tanous 
12937e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
12947e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
1295c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1296c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
1297c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1298029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
129945ca1b86SEd Tanous         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
1300c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1301c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
1302002d39b4SEd Tanous         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1303c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
13041476687dSEd Tanous         nlohmann::json::object_t eventLog;
13051476687dSEd Tanous         eventLog["@odata.id"] =
13061476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
1307b2ba3072SPatrick Williams         logServiceArray.emplace_back(std::move(eventLog));
13085cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
13091476687dSEd Tanous         nlohmann::json::object_t dumpLog;
1310002d39b4SEd Tanous         dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump";
1311b2ba3072SPatrick Williams         logServiceArray.emplace_back(std::move(dumpLog));
1312c9bb6861Sraviteja-b #endif
1313c9bb6861Sraviteja-b 
1314d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
13151476687dSEd Tanous         nlohmann::json::object_t crashdump;
13161476687dSEd Tanous         crashdump["@odata.id"] =
13171476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump";
1318b2ba3072SPatrick Williams         logServiceArray.emplace_back(std::move(crashdump));
1319d53dd41fSJason M. Bills #endif
1320b7028ebfSSpencer Ku 
1321b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
13221476687dSEd Tanous         nlohmann::json::object_t hostlogger;
13231476687dSEd Tanous         hostlogger["@odata.id"] =
13241476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/HostLogger";
1325b2ba3072SPatrick Williams         logServiceArray.emplace_back(std::move(hostlogger));
1326b7028ebfSSpencer Ku #endif
1327c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
1328c4bf6374SJason M. Bills             logServiceArray.size();
1329a3316fc6SZhikuiRen 
13307a1dbc48SGeorge Liu         constexpr std::array<std::string_view, 1> interfaces = {
13317a1dbc48SGeorge Liu             "xyz.openbmc_project.State.Boot.PostCode"};
13327a1dbc48SGeorge Liu         dbus::utility::getSubTreePaths(
13337a1dbc48SGeorge Liu             "/", 0, interfaces,
13347a1dbc48SGeorge Liu             [asyncResp](const boost::system::error_code& ec,
1335b9d36b47SEd Tanous                         const dbus::utility::MapperGetSubTreePathsResponse&
1336b9d36b47SEd Tanous                             subtreePath) {
1337a3316fc6SZhikuiRen             if (ec)
1338a3316fc6SZhikuiRen             {
133962598e31SEd Tanous                 BMCWEB_LOG_ERROR("{}", ec);
1340a3316fc6SZhikuiRen                 return;
1341a3316fc6SZhikuiRen             }
1342a3316fc6SZhikuiRen 
134355f79e6fSEd Tanous             for (const auto& pathStr : subtreePath)
1344a3316fc6SZhikuiRen             {
1345a3316fc6SZhikuiRen                 if (pathStr.find("PostCode") != std::string::npos)
1346a3316fc6SZhikuiRen                 {
134723a21a1cSEd Tanous                     nlohmann::json& logServiceArrayLocal =
1348a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members"];
1349613dabeaSEd Tanous                     nlohmann::json::object_t member;
1350613dabeaSEd Tanous                     member["@odata.id"] =
1351613dabeaSEd Tanous                         "/redfish/v1/Systems/system/LogServices/PostCodes";
1352613dabeaSEd Tanous 
1353b2ba3072SPatrick Williams                     logServiceArrayLocal.emplace_back(std::move(member));
1354613dabeaSEd Tanous 
135545ca1b86SEd Tanous                     asyncResp->res.jsonValue["Members@odata.count"] =
135623a21a1cSEd Tanous                         logServiceArrayLocal.size();
1357a3316fc6SZhikuiRen                     return;
1358a3316fc6SZhikuiRen                 }
1359a3316fc6SZhikuiRen             }
13607a1dbc48SGeorge Liu         });
13617e860f15SJohn Edward Broadbent     });
1362c4bf6374SJason M. Bills }
1363c4bf6374SJason M. Bills 
13647e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app)
1365c4bf6374SJason M. Bills {
136622d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/")
1367ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
1368002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1369002d39b4SEd Tanous             [&app](const crow::Request& req,
137022d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
137122d268cbSEd Tanous                    const std::string& systemName) {
13723ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
137345ca1b86SEd Tanous         {
137445ca1b86SEd Tanous             return;
137545ca1b86SEd Tanous         }
137622d268cbSEd Tanous         if (systemName != "system")
137722d268cbSEd Tanous         {
137822d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
137922d268cbSEd Tanous                                        systemName);
138022d268cbSEd Tanous             return;
138122d268cbSEd Tanous         }
1382c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1383029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
1384c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1385b25644a1SJanet Adkins             "#LogService.v1_2_0.LogService";
1386c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
1387002d39b4SEd Tanous         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1388c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
1389c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
13907c8c4058STejas Patil 
13917c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
13922b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
13937c8c4058STejas Patil 
13947c8c4058STejas Patil         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
13957c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
13967c8c4058STejas Patil             redfishDateTimeOffset.second;
13977c8c4058STejas Patil 
13981476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
13991476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1400e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1401e7d6c8b2SGunnar Mills 
14020fda0f12SGeorge Liu             {"target",
14030fda0f12SGeorge Liu              "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}};
14047e860f15SJohn Edward Broadbent     });
1405489640c6SJason M. Bills }
1406489640c6SJason M. Bills 
14077e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app)
1408489640c6SJason M. Bills {
14094978b63fSJason M. Bills     BMCWEB_ROUTE(
14104978b63fSJason M. Bills         app,
141122d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
1412432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
14137e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
141445ca1b86SEd Tanous             [&app](const crow::Request& req,
141522d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
141622d268cbSEd Tanous                    const std::string& systemName) {
14173ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
141845ca1b86SEd Tanous         {
141945ca1b86SEd Tanous             return;
142045ca1b86SEd Tanous         }
142122d268cbSEd Tanous         if (systemName != "system")
142222d268cbSEd Tanous         {
142322d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
142422d268cbSEd Tanous                                        systemName);
142522d268cbSEd Tanous             return;
142622d268cbSEd Tanous         }
1427489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
1428489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1429489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
1430489640c6SJason M. Bills         {
1431489640c6SJason M. Bills             for (const std::filesystem::path& file : redfishLogFiles)
1432489640c6SJason M. Bills             {
1433489640c6SJason M. Bills                 std::error_code ec;
1434489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
1435489640c6SJason M. Bills             }
1436489640c6SJason M. Bills         }
1437489640c6SJason M. Bills 
1438489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
1439489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
14405e7e2dc5SEd Tanous             [asyncResp](const boost::system::error_code& ec) {
1441489640c6SJason M. Bills             if (ec)
1442489640c6SJason M. Bills             {
144362598e31SEd Tanous                 BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec);
1444489640c6SJason M. Bills                 messages::internalError(asyncResp->res);
1445489640c6SJason M. Bills                 return;
1446489640c6SJason M. Bills             }
1447489640c6SJason M. Bills 
1448489640c6SJason M. Bills             messages::success(asyncResp->res);
1449489640c6SJason M. Bills         },
1450489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1451002d39b4SEd Tanous             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1452002d39b4SEd Tanous             "replace");
14537e860f15SJohn Edward Broadbent     });
1454c4bf6374SJason M. Bills }
1455c4bf6374SJason M. Bills 
1456ac992cdeSJason M. Bills enum class LogParseError
1457ac992cdeSJason M. Bills {
1458ac992cdeSJason M. Bills     success,
1459ac992cdeSJason M. Bills     parseFailed,
1460ac992cdeSJason M. Bills     messageIdNotInRegistry,
1461ac992cdeSJason M. Bills };
1462ac992cdeSJason M. Bills 
1463ac992cdeSJason M. Bills static LogParseError
1464ac992cdeSJason M. Bills     fillEventLogEntryJson(const std::string& logEntryID,
1465b5a76932SEd Tanous                           const std::string& logEntry,
1466de703c5dSJason M. Bills                           nlohmann::json::object_t& logEntryJson)
1467c4bf6374SJason M. Bills {
146895820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1469cd225da8SJason M. Bills     // First get the Timestamp
1470f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1471cd225da8SJason M. Bills     if (space == std::string::npos)
147295820184SJason M. Bills     {
1473ac992cdeSJason M. Bills         return LogParseError::parseFailed;
147495820184SJason M. Bills     }
1475cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1476cd225da8SJason M. Bills     // Then get the log contents
1477f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1478cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1479cd225da8SJason M. Bills     {
1480ac992cdeSJason M. Bills         return LogParseError::parseFailed;
1481cd225da8SJason M. Bills     }
1482cd225da8SJason M. Bills     std::string_view entry(logEntry);
1483cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1484cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1485cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
148650ebd4afSEd Tanous     bmcweb::split(logEntryFields, entry, ',');
1487cd225da8SJason M. Bills     // We need at least a MessageId to be valid
14881e6deaf6SEd Tanous     auto logEntryIter = logEntryFields.begin();
14891e6deaf6SEd Tanous     if (logEntryIter == logEntryFields.end())
1490cd225da8SJason M. Bills     {
1491ac992cdeSJason M. Bills         return LogParseError::parseFailed;
1492cd225da8SJason M. Bills     }
14931e6deaf6SEd Tanous     std::string& messageID = *logEntryIter;
14944851d45dSJason M. Bills     // Get the Message from the MessageRegistry
1495fffb8c1fSEd Tanous     const registries::Message* message = registries::getMessage(messageID);
1496c4bf6374SJason M. Bills 
14971e6deaf6SEd Tanous     logEntryIter++;
149854417b02SSui Chen     if (message == nullptr)
1499c4bf6374SJason M. Bills     {
150062598e31SEd Tanous         BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry);
1501ac992cdeSJason M. Bills         return LogParseError::messageIdNotInRegistry;
1502c4bf6374SJason M. Bills     }
1503c4bf6374SJason M. Bills 
15041e6deaf6SEd Tanous     std::vector<std::string_view> messageArgs(logEntryIter,
15051e6deaf6SEd Tanous                                               logEntryFields.end());
1506c05bba45SEd Tanous     messageArgs.resize(message->numberOfArgs);
1507c05bba45SEd Tanous 
15081e6deaf6SEd Tanous     std::string msg = redfish::registries::fillMessageArgs(messageArgs,
15091e6deaf6SEd Tanous                                                            message->message);
15101e6deaf6SEd Tanous     if (msg.empty())
151115a86ff6SJason M. Bills     {
15121e6deaf6SEd Tanous         return LogParseError::parseFailed;
151315a86ff6SJason M. Bills     }
15144851d45dSJason M. Bills 
151595820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
151695820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
151795820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1518f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1519f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
152095820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1521c4bf6374SJason M. Bills     {
152295820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1523c4bf6374SJason M. Bills     }
1524c4bf6374SJason M. Bills 
1525c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
15269c11a172SVijay Lobo     logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
1527ef4c65b7SEd Tanous     logEntryJson["@odata.id"] = boost::urls::format(
1528ef4c65b7SEd Tanous         "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1529ef4c65b7SEd Tanous         logEntryID);
153084afc48bSJason M. Bills     logEntryJson["Name"] = "System Event Log Entry";
153184afc48bSJason M. Bills     logEntryJson["Id"] = logEntryID;
153284afc48bSJason M. Bills     logEntryJson["Message"] = std::move(msg);
153384afc48bSJason M. Bills     logEntryJson["MessageId"] = std::move(messageID);
153484afc48bSJason M. Bills     logEntryJson["MessageArgs"] = messageArgs;
153584afc48bSJason M. Bills     logEntryJson["EntryType"] = "Event";
153684afc48bSJason M. Bills     logEntryJson["Severity"] = message->messageSeverity;
153784afc48bSJason M. Bills     logEntryJson["Created"] = std::move(timestamp);
1538ac992cdeSJason M. Bills     return LogParseError::success;
1539c4bf6374SJason M. Bills }
1540c4bf6374SJason M. Bills 
15417e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app)
1542c4bf6374SJason M. Bills {
154322d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
15448b6a35f0SGunnar Mills         .privileges(redfish::privileges::getLogEntryCollection)
1545002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1546002d39b4SEd Tanous             [&app](const crow::Request& req,
154722d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
154822d268cbSEd Tanous                    const std::string& systemName) {
1549c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
1550c937d2bfSEd Tanous             .canDelegateTop = true,
1551c937d2bfSEd Tanous             .canDelegateSkip = true,
1552c937d2bfSEd Tanous         };
1553c937d2bfSEd Tanous         query_param::Query delegatedQuery;
1554c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
15553ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
1556c4bf6374SJason M. Bills         {
1557c4bf6374SJason M. Bills             return;
1558c4bf6374SJason M. Bills         }
15597f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
15607f3e84a1SEd Tanous         {
15617f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
15627f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
15637f3e84a1SEd Tanous                                        systemName);
15647f3e84a1SEd Tanous             return;
15657f3e84a1SEd Tanous         }
156622d268cbSEd Tanous         if (systemName != "system")
156722d268cbSEd Tanous         {
156822d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
156922d268cbSEd Tanous                                        systemName);
157022d268cbSEd Tanous             return;
157122d268cbSEd Tanous         }
157222d268cbSEd Tanous 
15735143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
15743648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
15753648c8beSEd Tanous 
15767e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
15777e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
1578c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1579c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
1580c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1581029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1582c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1583c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1584c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
1585cb92c03bSAndrew Geissler 
15864978b63fSJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1587c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
15887e860f15SJohn Edward Broadbent         // Go through the log files and create a unique ID for each
15897e860f15SJohn Edward Broadbent         // entry
159095820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
159195820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1592b01bf299SEd Tanous         uint64_t entryCount = 0;
1593cd225da8SJason M. Bills         std::string logEntry;
159495820184SJason M. Bills 
15957e860f15SJohn Edward Broadbent         // Oldest logs are in the last file, so start there and loop
15967e860f15SJohn Edward Broadbent         // backwards
1597002d39b4SEd Tanous         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1598002d39b4SEd Tanous              it++)
1599c4bf6374SJason M. Bills         {
1600cd225da8SJason M. Bills             std::ifstream logStream(*it);
160195820184SJason M. Bills             if (!logStream.is_open())
1602c4bf6374SJason M. Bills             {
1603c4bf6374SJason M. Bills                 continue;
1604c4bf6374SJason M. Bills             }
1605c4bf6374SJason M. Bills 
1606e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
1607e85d6b16SJason M. Bills             bool firstEntry = true;
160895820184SJason M. Bills             while (std::getline(logStream, logEntry))
160995820184SJason M. Bills             {
1610c4bf6374SJason M. Bills                 std::string idStr;
1611e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1612c4bf6374SJason M. Bills                 {
1613c4bf6374SJason M. Bills                     continue;
1614c4bf6374SJason M. Bills                 }
1615e85d6b16SJason M. Bills                 firstEntry = false;
1616e85d6b16SJason M. Bills 
1617de703c5dSJason M. Bills                 nlohmann::json::object_t bmcLogEntry;
161889492a15SPatrick Williams                 LogParseError status = fillEventLogEntryJson(idStr, logEntry,
161989492a15SPatrick Williams                                                              bmcLogEntry);
1620ac992cdeSJason M. Bills                 if (status == LogParseError::messageIdNotInRegistry)
1621ac992cdeSJason M. Bills                 {
1622ac992cdeSJason M. Bills                     continue;
1623ac992cdeSJason M. Bills                 }
1624ac992cdeSJason M. Bills                 if (status != LogParseError::success)
1625c4bf6374SJason M. Bills                 {
1626c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
1627c4bf6374SJason M. Bills                     return;
1628c4bf6374SJason M. Bills                 }
1629de703c5dSJason M. Bills 
1630de703c5dSJason M. Bills                 entryCount++;
1631de703c5dSJason M. Bills                 // Handle paging using skip (number of entries to skip from the
1632de703c5dSJason M. Bills                 // start) and top (number of entries to display)
16333648c8beSEd Tanous                 if (entryCount <= skip || entryCount > skip + top)
1634de703c5dSJason M. Bills                 {
1635de703c5dSJason M. Bills                     continue;
1636de703c5dSJason M. Bills                 }
1637de703c5dSJason M. Bills 
1638b2ba3072SPatrick Williams                 logEntryArray.emplace_back(std::move(bmcLogEntry));
1639c4bf6374SJason M. Bills             }
164095820184SJason M. Bills         }
1641c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
16423648c8beSEd Tanous         if (skip + top < entryCount)
1643c4bf6374SJason M. Bills         {
1644c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
16454978b63fSJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" +
16463648c8beSEd Tanous                 std::to_string(skip + top);
1647c4bf6374SJason M. Bills         }
16487e860f15SJohn Edward Broadbent     });
1649897967deSJason M. Bills }
1650897967deSJason M. Bills 
16517e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app)
1652897967deSJason M. Bills {
16537e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
165422d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
1655ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
16567e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
165745ca1b86SEd Tanous             [&app](const crow::Request& req,
16587e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
165922d268cbSEd Tanous                    const std::string& systemName, const std::string& param) {
16603ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
166145ca1b86SEd Tanous         {
166245ca1b86SEd Tanous             return;
166345ca1b86SEd Tanous         }
16647f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
16657f3e84a1SEd Tanous         {
16667f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
16677f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
16687f3e84a1SEd Tanous                                        systemName);
16697f3e84a1SEd Tanous             return;
16707f3e84a1SEd Tanous         }
167122d268cbSEd Tanous 
167222d268cbSEd Tanous         if (systemName != "system")
167322d268cbSEd Tanous         {
167422d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
167522d268cbSEd Tanous                                        systemName);
167622d268cbSEd Tanous             return;
167722d268cbSEd Tanous         }
167822d268cbSEd Tanous 
16797e860f15SJohn Edward Broadbent         const std::string& targetID = param;
16808d1b46d7Szhanghch05 
16817e860f15SJohn Edward Broadbent         // Go through the log files and check the unique ID for each
16827e860f15SJohn Edward Broadbent         // entry to find the target entry
1683897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1684897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1685897967deSJason M. Bills         std::string logEntry;
1686897967deSJason M. Bills 
16877e860f15SJohn Edward Broadbent         // Oldest logs are in the last file, so start there and loop
16887e860f15SJohn Edward Broadbent         // backwards
1689002d39b4SEd Tanous         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1690002d39b4SEd Tanous              it++)
1691897967deSJason M. Bills         {
1692897967deSJason M. Bills             std::ifstream logStream(*it);
1693897967deSJason M. Bills             if (!logStream.is_open())
1694897967deSJason M. Bills             {
1695897967deSJason M. Bills                 continue;
1696897967deSJason M. Bills             }
1697897967deSJason M. Bills 
1698897967deSJason M. Bills             // Reset the unique ID on the first entry
1699897967deSJason M. Bills             bool firstEntry = true;
1700897967deSJason M. Bills             while (std::getline(logStream, logEntry))
1701897967deSJason M. Bills             {
1702897967deSJason M. Bills                 std::string idStr;
1703897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1704897967deSJason M. Bills                 {
1705897967deSJason M. Bills                     continue;
1706897967deSJason M. Bills                 }
1707897967deSJason M. Bills                 firstEntry = false;
1708897967deSJason M. Bills 
1709897967deSJason M. Bills                 if (idStr == targetID)
1710897967deSJason M. Bills                 {
1711de703c5dSJason M. Bills                     nlohmann::json::object_t bmcLogEntry;
1712ac992cdeSJason M. Bills                     LogParseError status =
1713ac992cdeSJason M. Bills                         fillEventLogEntryJson(idStr, logEntry, bmcLogEntry);
1714ac992cdeSJason M. Bills                     if (status != LogParseError::success)
1715897967deSJason M. Bills                     {
1716897967deSJason M. Bills                         messages::internalError(asyncResp->res);
1717897967deSJason M. Bills                         return;
1718897967deSJason M. Bills                     }
1719d405bb51SJason M. Bills                     asyncResp->res.jsonValue.update(bmcLogEntry);
1720897967deSJason M. Bills                     return;
1721897967deSJason M. Bills                 }
1722897967deSJason M. Bills             }
1723897967deSJason M. Bills         }
1724897967deSJason M. Bills         // Requested ID was not found
17259db4ba25SJiaqing Zhao         messages::resourceNotFound(asyncResp->res, "LogEntry", targetID);
17267e860f15SJohn Edward Broadbent     });
172708a4e4b5SAnthony Wilson }
172808a4e4b5SAnthony Wilson 
17297e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app)
173008a4e4b5SAnthony Wilson {
173122d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
1732ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
1733002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1734002d39b4SEd Tanous             [&app](const crow::Request& req,
173522d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
173622d268cbSEd Tanous                    const std::string& systemName) {
17373ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
173845ca1b86SEd Tanous         {
173945ca1b86SEd Tanous             return;
174045ca1b86SEd Tanous         }
17417f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
17427f3e84a1SEd Tanous         {
17437f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
17447f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
17457f3e84a1SEd Tanous                                        systemName);
17467f3e84a1SEd Tanous             return;
17477f3e84a1SEd Tanous         }
174822d268cbSEd Tanous         if (systemName != "system")
174922d268cbSEd Tanous         {
175022d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
175122d268cbSEd Tanous                                        systemName);
175222d268cbSEd Tanous             return;
175322d268cbSEd Tanous         }
175422d268cbSEd Tanous 
17557e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
17567e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
175708a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
175808a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
175908a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
176008a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
176108a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
176208a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
176308a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
176408a4e4b5SAnthony Wilson 
1765cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1766cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
17675eb468daSGeorge Liu         sdbusplus::message::object_path path("/xyz/openbmc_project/logging");
17685eb468daSGeorge Liu         dbus::utility::getManagedObjects(
17695eb468daSGeorge Liu             "xyz.openbmc_project.Logging", path,
17705e7e2dc5SEd Tanous             [asyncResp](const boost::system::error_code& ec,
1771914e2d5dSEd Tanous                         const dbus::utility::ManagedObjectType& resp) {
1772cb92c03bSAndrew Geissler             if (ec)
1773cb92c03bSAndrew Geissler             {
1774cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
177562598e31SEd Tanous                 BMCWEB_LOG_ERROR(
177662598e31SEd Tanous                     "getLogEntriesIfaceData resp_handler got error {}", ec);
1777cb92c03bSAndrew Geissler                 messages::internalError(asyncResp->res);
1778cb92c03bSAndrew Geissler                 return;
1779cb92c03bSAndrew Geissler             }
17803544d2a7SEd Tanous             nlohmann::json::array_t entriesArray;
17819eb808c1SEd Tanous             for (const auto& objectPath : resp)
1782cb92c03bSAndrew Geissler             {
1783914e2d5dSEd Tanous                 const uint32_t* id = nullptr;
1784c419c759SEd Tanous                 const uint64_t* timestamp = nullptr;
1785c419c759SEd Tanous                 const uint64_t* updateTimestamp = nullptr;
1786914e2d5dSEd Tanous                 const std::string* severity = nullptr;
1787914e2d5dSEd Tanous                 const std::string* message = nullptr;
1788914e2d5dSEd Tanous                 const std::string* filePath = nullptr;
17899c11a172SVijay Lobo                 const std::string* resolution = nullptr;
179075710de2SXiaochao Ma                 bool resolved = false;
17919017faf2SAbhishek Patel                 const std::string* notify = nullptr;
17929017faf2SAbhishek Patel 
17939eb808c1SEd Tanous                 for (const auto& interfaceMap : objectPath.second)
1794f86bb901SAdriana Kobylak                 {
1795f86bb901SAdriana Kobylak                     if (interfaceMap.first ==
1796f86bb901SAdriana Kobylak                         "xyz.openbmc_project.Logging.Entry")
1797f86bb901SAdriana Kobylak                     {
1798002d39b4SEd Tanous                         for (const auto& propertyMap : interfaceMap.second)
1799cb92c03bSAndrew Geissler                         {
1800cb92c03bSAndrew Geissler                             if (propertyMap.first == "Id")
1801cb92c03bSAndrew Geissler                             {
1802002d39b4SEd Tanous                                 id = std::get_if<uint32_t>(&propertyMap.second);
1803cb92c03bSAndrew Geissler                             }
1804cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Timestamp")
1805cb92c03bSAndrew Geissler                             {
1806002d39b4SEd Tanous                                 timestamp =
1807002d39b4SEd Tanous                                     std::get_if<uint64_t>(&propertyMap.second);
18087e860f15SJohn Edward Broadbent                             }
1809002d39b4SEd Tanous                             else if (propertyMap.first == "UpdateTimestamp")
18107e860f15SJohn Edward Broadbent                             {
1811002d39b4SEd Tanous                                 updateTimestamp =
1812002d39b4SEd Tanous                                     std::get_if<uint64_t>(&propertyMap.second);
18137e860f15SJohn Edward Broadbent                             }
18147e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Severity")
18157e860f15SJohn Edward Broadbent                             {
18167e860f15SJohn Edward Broadbent                                 severity = std::get_if<std::string>(
18177e860f15SJohn Edward Broadbent                                     &propertyMap.second);
18187e860f15SJohn Edward Broadbent                             }
18199c11a172SVijay Lobo                             else if (propertyMap.first == "Resolution")
18209c11a172SVijay Lobo                             {
18219c11a172SVijay Lobo                                 resolution = std::get_if<std::string>(
18229c11a172SVijay Lobo                                     &propertyMap.second);
18239c11a172SVijay Lobo                             }
18247e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Message")
18257e860f15SJohn Edward Broadbent                             {
18267e860f15SJohn Edward Broadbent                                 message = std::get_if<std::string>(
18277e860f15SJohn Edward Broadbent                                     &propertyMap.second);
18287e860f15SJohn Edward Broadbent                             }
18297e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Resolved")
18307e860f15SJohn Edward Broadbent                             {
1831914e2d5dSEd Tanous                                 const bool* resolveptr =
1832002d39b4SEd Tanous                                     std::get_if<bool>(&propertyMap.second);
18337e860f15SJohn Edward Broadbent                                 if (resolveptr == nullptr)
18347e860f15SJohn Edward Broadbent                                 {
1835002d39b4SEd Tanous                                     messages::internalError(asyncResp->res);
18367e860f15SJohn Edward Broadbent                                     return;
18377e860f15SJohn Edward Broadbent                                 }
18387e860f15SJohn Edward Broadbent                                 resolved = *resolveptr;
18397e860f15SJohn Edward Broadbent                             }
18409017faf2SAbhishek Patel                             else if (propertyMap.first ==
18419017faf2SAbhishek Patel                                      "ServiceProviderNotify")
18429017faf2SAbhishek Patel                             {
18439017faf2SAbhishek Patel                                 notify = std::get_if<std::string>(
18449017faf2SAbhishek Patel                                     &propertyMap.second);
18459017faf2SAbhishek Patel                                 if (notify == nullptr)
18469017faf2SAbhishek Patel                                 {
18479017faf2SAbhishek Patel                                     messages::internalError(asyncResp->res);
18489017faf2SAbhishek Patel                                     return;
18499017faf2SAbhishek Patel                                 }
18509017faf2SAbhishek Patel                             }
18517e860f15SJohn Edward Broadbent                         }
18527e860f15SJohn Edward Broadbent                         if (id == nullptr || message == nullptr ||
18537e860f15SJohn Edward Broadbent                             severity == nullptr)
18547e860f15SJohn Edward Broadbent                         {
18557e860f15SJohn Edward Broadbent                             messages::internalError(asyncResp->res);
18567e860f15SJohn Edward Broadbent                             return;
18577e860f15SJohn Edward Broadbent                         }
18587e860f15SJohn Edward Broadbent                     }
18597e860f15SJohn Edward Broadbent                     else if (interfaceMap.first ==
18607e860f15SJohn Edward Broadbent                              "xyz.openbmc_project.Common.FilePath")
18617e860f15SJohn Edward Broadbent                     {
1862002d39b4SEd Tanous                         for (const auto& propertyMap : interfaceMap.second)
18637e860f15SJohn Edward Broadbent                         {
18647e860f15SJohn Edward Broadbent                             if (propertyMap.first == "Path")
18657e860f15SJohn Edward Broadbent                             {
18667e860f15SJohn Edward Broadbent                                 filePath = std::get_if<std::string>(
18677e860f15SJohn Edward Broadbent                                     &propertyMap.second);
18687e860f15SJohn Edward Broadbent                             }
18697e860f15SJohn Edward Broadbent                         }
18707e860f15SJohn Edward Broadbent                     }
18717e860f15SJohn Edward Broadbent                 }
18727e860f15SJohn Edward Broadbent                 // Object path without the
18737e860f15SJohn Edward Broadbent                 // xyz.openbmc_project.Logging.Entry interface, ignore
18747e860f15SJohn Edward Broadbent                 // and continue.
18757e860f15SJohn Edward Broadbent                 if (id == nullptr || message == nullptr ||
1876c419c759SEd Tanous                     severity == nullptr || timestamp == nullptr ||
1877c419c759SEd Tanous                     updateTimestamp == nullptr)
18787e860f15SJohn Edward Broadbent                 {
18797e860f15SJohn Edward Broadbent                     continue;
18807e860f15SJohn Edward Broadbent                 }
18813544d2a7SEd Tanous                 nlohmann::json& thisEntry = entriesArray.emplace_back();
18829c11a172SVijay Lobo                 thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
1883ef4c65b7SEd Tanous                 thisEntry["@odata.id"] = boost::urls::format(
1884ef4c65b7SEd Tanous                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1885ef4c65b7SEd Tanous                     std::to_string(*id));
18867e860f15SJohn Edward Broadbent                 thisEntry["Name"] = "System Event Log Entry";
18877e860f15SJohn Edward Broadbent                 thisEntry["Id"] = std::to_string(*id);
18887e860f15SJohn Edward Broadbent                 thisEntry["Message"] = *message;
18897e860f15SJohn Edward Broadbent                 thisEntry["Resolved"] = resolved;
18909c11a172SVijay Lobo                 if ((resolution != nullptr) && (!(*resolution).empty()))
18919c11a172SVijay Lobo                 {
18929c11a172SVijay Lobo                     thisEntry["Resolution"] = *resolution;
18939c11a172SVijay Lobo                 }
18949017faf2SAbhishek Patel                 std::optional<bool> notifyAction =
18959017faf2SAbhishek Patel                     getProviderNotifyAction(*notify);
18969017faf2SAbhishek Patel                 if (notifyAction)
18979017faf2SAbhishek Patel                 {
18989017faf2SAbhishek Patel                     thisEntry["ServiceProviderNotified"] = *notifyAction;
18999017faf2SAbhishek Patel                 }
19007e860f15SJohn Edward Broadbent                 thisEntry["EntryType"] = "Event";
19017e860f15SJohn Edward Broadbent                 thisEntry["Severity"] =
19027e860f15SJohn Edward Broadbent                     translateSeverityDbusToRedfish(*severity);
19037e860f15SJohn Edward Broadbent                 thisEntry["Created"] =
19042b82937eSEd Tanous                     redfish::time_utils::getDateTimeUintMs(*timestamp);
19057e860f15SJohn Edward Broadbent                 thisEntry["Modified"] =
19062b82937eSEd Tanous                     redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
19077e860f15SJohn Edward Broadbent                 if (filePath != nullptr)
19087e860f15SJohn Edward Broadbent                 {
19097e860f15SJohn Edward Broadbent                     thisEntry["AdditionalDataURI"] =
19100fda0f12SGeorge Liu                         "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
19117e860f15SJohn Edward Broadbent                         std::to_string(*id) + "/attachment";
19127e860f15SJohn Edward Broadbent                 }
19137e860f15SJohn Edward Broadbent             }
19143544d2a7SEd Tanous             std::ranges::sort(entriesArray, [](const nlohmann::json& left,
19153544d2a7SEd Tanous                                                const nlohmann::json& right) {
19167e860f15SJohn Edward Broadbent                 return (left["Id"] <= right["Id"]);
19177e860f15SJohn Edward Broadbent             });
19187e860f15SJohn Edward Broadbent             asyncResp->res.jsonValue["Members@odata.count"] =
19197e860f15SJohn Edward Broadbent                 entriesArray.size();
19203544d2a7SEd Tanous             asyncResp->res.jsonValue["Members"] = std::move(entriesArray);
19215eb468daSGeorge Liu         });
19227e860f15SJohn Edward Broadbent     });
19237e860f15SJohn Edward Broadbent }
19247e860f15SJohn Edward Broadbent 
19257e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app)
19267e860f15SJohn Edward Broadbent {
19277e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
192822d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
1929ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
1930002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1931002d39b4SEd Tanous             [&app](const crow::Request& req,
19327e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
193322d268cbSEd Tanous                    const std::string& systemName, const std::string& param) {
19343ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
19357e860f15SJohn Edward Broadbent         {
193645ca1b86SEd Tanous             return;
193745ca1b86SEd Tanous         }
19387f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
19397f3e84a1SEd Tanous         {
19407f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
19417f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
19427f3e84a1SEd Tanous                                        systemName);
19437f3e84a1SEd Tanous             return;
19447f3e84a1SEd Tanous         }
194522d268cbSEd Tanous         if (systemName != "system")
194622d268cbSEd Tanous         {
194722d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
194822d268cbSEd Tanous                                        systemName);
194922d268cbSEd Tanous             return;
195022d268cbSEd Tanous         }
195122d268cbSEd Tanous 
19527e860f15SJohn Edward Broadbent         std::string entryID = param;
19537e860f15SJohn Edward Broadbent         dbus::utility::escapePathForDbus(entryID);
19547e860f15SJohn Edward Broadbent 
19557e860f15SJohn Edward Broadbent         // DBus implementation of EventLog/Entries
19567e860f15SJohn Edward Broadbent         // Make call to Logging Service to find all log entry objects
1957d1bde9e5SKrzysztof Grobelny         sdbusplus::asio::getAllProperties(
1958d1bde9e5SKrzysztof Grobelny             *crow::connections::systemBus, "xyz.openbmc_project.Logging",
1959d1bde9e5SKrzysztof Grobelny             "/xyz/openbmc_project/logging/entry/" + entryID, "",
19605e7e2dc5SEd Tanous             [asyncResp, entryID](const boost::system::error_code& ec,
1961b9d36b47SEd Tanous                                  const dbus::utility::DBusPropertiesMap& resp) {
19627e860f15SJohn Edward Broadbent             if (ec.value() == EBADR)
19637e860f15SJohn Edward Broadbent             {
1964d1bde9e5SKrzysztof Grobelny                 messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1965d1bde9e5SKrzysztof Grobelny                                            entryID);
19667e860f15SJohn Edward Broadbent                 return;
19677e860f15SJohn Edward Broadbent             }
19687e860f15SJohn Edward Broadbent             if (ec)
19697e860f15SJohn Edward Broadbent             {
197062598e31SEd Tanous                 BMCWEB_LOG_ERROR(
197162598e31SEd Tanous                     "EventLogEntry (DBus) resp_handler got error {}", ec);
19727e860f15SJohn Edward Broadbent                 messages::internalError(asyncResp->res);
19737e860f15SJohn Edward Broadbent                 return;
19747e860f15SJohn Edward Broadbent             }
1975914e2d5dSEd Tanous             const uint32_t* id = nullptr;
1976c419c759SEd Tanous             const uint64_t* timestamp = nullptr;
1977c419c759SEd Tanous             const uint64_t* updateTimestamp = nullptr;
1978914e2d5dSEd Tanous             const std::string* severity = nullptr;
1979914e2d5dSEd Tanous             const std::string* message = nullptr;
1980914e2d5dSEd Tanous             const std::string* filePath = nullptr;
19819c11a172SVijay Lobo             const std::string* resolution = nullptr;
19827e860f15SJohn Edward Broadbent             bool resolved = false;
19839017faf2SAbhishek Patel             const std::string* notify = nullptr;
19847e860f15SJohn Edward Broadbent 
1985d1bde9e5SKrzysztof Grobelny             const bool success = sdbusplus::unpackPropertiesNoThrow(
1986d1bde9e5SKrzysztof Grobelny                 dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp",
1987d1bde9e5SKrzysztof Grobelny                 timestamp, "UpdateTimestamp", updateTimestamp, "Severity",
19889c11a172SVijay Lobo                 severity, "Message", message, "Resolved", resolved,
19899017faf2SAbhishek Patel                 "Resolution", resolution, "Path", filePath,
19909017faf2SAbhishek Patel                 "ServiceProviderNotify", notify);
1991d1bde9e5SKrzysztof Grobelny 
1992d1bde9e5SKrzysztof Grobelny             if (!success)
199375710de2SXiaochao Ma             {
199475710de2SXiaochao Ma                 messages::internalError(asyncResp->res);
199575710de2SXiaochao Ma                 return;
199675710de2SXiaochao Ma             }
1997d1bde9e5SKrzysztof Grobelny 
1998002d39b4SEd Tanous             if (id == nullptr || message == nullptr || severity == nullptr ||
19999017faf2SAbhishek Patel                 timestamp == nullptr || updateTimestamp == nullptr ||
20009017faf2SAbhishek Patel                 notify == nullptr)
2001f86bb901SAdriana Kobylak             {
2002ae34c8e8SAdriana Kobylak                 messages::internalError(asyncResp->res);
2003271584abSEd Tanous                 return;
2004271584abSEd Tanous             }
20059017faf2SAbhishek Patel 
2006f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["@odata.type"] =
20079c11a172SVijay Lobo                 "#LogEntry.v1_9_0.LogEntry";
2008ef4c65b7SEd Tanous             asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
2009ef4c65b7SEd Tanous                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
2010ef4c65b7SEd Tanous                 std::to_string(*id));
201145ca1b86SEd Tanous             asyncResp->res.jsonValue["Name"] = "System Event Log Entry";
2012f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Id"] = std::to_string(*id);
2013f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Message"] = *message;
2014f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Resolved"] = resolved;
20159017faf2SAbhishek Patel             std::optional<bool> notifyAction = getProviderNotifyAction(*notify);
20169017faf2SAbhishek Patel             if (notifyAction)
20179017faf2SAbhishek Patel             {
20189017faf2SAbhishek Patel                 asyncResp->res.jsonValue["ServiceProviderNotified"] =
20199017faf2SAbhishek Patel                     *notifyAction;
20209017faf2SAbhishek Patel             }
20219c11a172SVijay Lobo             if ((resolution != nullptr) && (!(*resolution).empty()))
20229c11a172SVijay Lobo             {
20239c11a172SVijay Lobo                 asyncResp->res.jsonValue["Resolution"] = *resolution;
20249c11a172SVijay Lobo             }
2025f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["EntryType"] = "Event";
2026f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Severity"] =
2027f86bb901SAdriana Kobylak                 translateSeverityDbusToRedfish(*severity);
2028f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Created"] =
20292b82937eSEd Tanous                 redfish::time_utils::getDateTimeUintMs(*timestamp);
2030f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Modified"] =
20312b82937eSEd Tanous                 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
2032f86bb901SAdriana Kobylak             if (filePath != nullptr)
2033f86bb901SAdriana Kobylak             {
2034f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["AdditionalDataURI"] =
2035e7dbd530SPotin Lai                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
2036e7dbd530SPotin Lai                     std::to_string(*id) + "/attachment";
2037f86bb901SAdriana Kobylak             }
2038d1bde9e5SKrzysztof Grobelny         });
20397e860f15SJohn Edward Broadbent     });
2040336e96c6SChicago Duan 
20417e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
204222d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
2043ed398213SEd Tanous         .privileges(redfish::privileges::patchLogEntry)
20447e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::patch)(
204545ca1b86SEd Tanous             [&app](const crow::Request& req,
20467e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
204722d268cbSEd Tanous                    const std::string& systemName, const std::string& entryId) {
20483ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
204945ca1b86SEd Tanous         {
205045ca1b86SEd Tanous             return;
205145ca1b86SEd Tanous         }
20527f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
20537f3e84a1SEd Tanous         {
20547f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
20557f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
20567f3e84a1SEd Tanous                                        systemName);
20577f3e84a1SEd Tanous             return;
20587f3e84a1SEd Tanous         }
205922d268cbSEd Tanous         if (systemName != "system")
206022d268cbSEd Tanous         {
206122d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
206222d268cbSEd Tanous                                        systemName);
206322d268cbSEd Tanous             return;
206422d268cbSEd Tanous         }
206575710de2SXiaochao Ma         std::optional<bool> resolved;
206675710de2SXiaochao Ma 
206715ed6780SWilly Tu         if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved",
20687e860f15SJohn Edward Broadbent                                       resolved))
206975710de2SXiaochao Ma         {
207075710de2SXiaochao Ma             return;
207175710de2SXiaochao Ma         }
207262598e31SEd Tanous         BMCWEB_LOG_DEBUG("Set Resolved");
207375710de2SXiaochao Ma 
20743eb66652SAsmitha Karunanithi         setDbusProperty(asyncResp, "xyz.openbmc_project.Logging",
20759ae226faSGeorge Liu                         "/xyz/openbmc_project/logging/entry/" + entryId,
20763eb66652SAsmitha Karunanithi                         "xyz.openbmc_project.Logging.Entry", "Resolved",
20773eb66652SAsmitha Karunanithi                         "Resolved", *resolved);
20787e860f15SJohn Edward Broadbent     });
207975710de2SXiaochao Ma 
20807e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
208122d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
2082ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
2083ed398213SEd Tanous 
2084002d39b4SEd Tanous         .methods(boost::beast::http::verb::delete_)(
2085002d39b4SEd Tanous             [&app](const crow::Request& req,
2086002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
208722d268cbSEd Tanous                    const std::string& systemName, const std::string& param) {
20883ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2089336e96c6SChicago Duan         {
209045ca1b86SEd Tanous             return;
209145ca1b86SEd Tanous         }
20927f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
20937f3e84a1SEd Tanous         {
20947f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
20957f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
20967f3e84a1SEd Tanous                                        systemName);
20977f3e84a1SEd Tanous             return;
20987f3e84a1SEd Tanous         }
209922d268cbSEd Tanous         if (systemName != "system")
210022d268cbSEd Tanous         {
210122d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
210222d268cbSEd Tanous                                        systemName);
210322d268cbSEd Tanous             return;
210422d268cbSEd Tanous         }
210562598e31SEd Tanous         BMCWEB_LOG_DEBUG("Do delete single event entries.");
2106336e96c6SChicago Duan 
21077e860f15SJohn Edward Broadbent         std::string entryID = param;
2108336e96c6SChicago Duan 
2109336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
2110336e96c6SChicago Duan 
2111336e96c6SChicago Duan         // Process response from Logging service.
21125a39f77aSPatrick Williams         auto respHandler = [asyncResp,
21135a39f77aSPatrick Williams                             entryID](const boost::system::error_code& ec) {
211462598e31SEd Tanous             BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done");
2115336e96c6SChicago Duan             if (ec)
2116336e96c6SChicago Duan             {
21173de8d8baSGeorge Liu                 if (ec.value() == EBADR)
21183de8d8baSGeorge Liu                 {
211945ca1b86SEd Tanous                     messages::resourceNotFound(asyncResp->res, "LogEntry",
212045ca1b86SEd Tanous                                                entryID);
21213de8d8baSGeorge Liu                     return;
21223de8d8baSGeorge Liu                 }
2123336e96c6SChicago Duan                 // TODO Handle for specific error code
212462598e31SEd Tanous                 BMCWEB_LOG_ERROR(
212562598e31SEd Tanous                     "EventLogEntry (DBus) doDelete respHandler got error {}",
212662598e31SEd Tanous                     ec);
2127336e96c6SChicago Duan                 asyncResp->res.result(
2128336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
2129336e96c6SChicago Duan                 return;
2130336e96c6SChicago Duan             }
2131336e96c6SChicago Duan 
2132336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
2133336e96c6SChicago Duan         };
2134336e96c6SChicago Duan 
2135336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
2136336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
2137336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
2138336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
2139336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
21407e860f15SJohn Edward Broadbent     });
2141400fd1fbSAdriana Kobylak }
2142400fd1fbSAdriana Kobylak 
2143b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console";
2144b7028ebfSSpencer Ku 
2145b7028ebfSSpencer Ku inline bool
2146b7028ebfSSpencer Ku     getHostLoggerFiles(const std::string& hostLoggerFilePath,
2147b7028ebfSSpencer Ku                        std::vector<std::filesystem::path>& hostLoggerFiles)
2148b7028ebfSSpencer Ku {
2149b7028ebfSSpencer Ku     std::error_code ec;
2150b7028ebfSSpencer Ku     std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec);
2151b7028ebfSSpencer Ku     if (ec)
2152b7028ebfSSpencer Ku     {
2153bf2ddedeSCarson Labrado         BMCWEB_LOG_WARNING("{}", ec.message());
2154b7028ebfSSpencer Ku         return false;
2155b7028ebfSSpencer Ku     }
2156b7028ebfSSpencer Ku     for (const std::filesystem::directory_entry& it : logPath)
2157b7028ebfSSpencer Ku     {
2158b7028ebfSSpencer Ku         std::string filename = it.path().filename();
2159b7028ebfSSpencer Ku         // Prefix of each log files is "log". Find the file and save the
2160b7028ebfSSpencer Ku         // path
216111ba3979SEd Tanous         if (filename.starts_with("log"))
2162b7028ebfSSpencer Ku         {
2163b7028ebfSSpencer Ku             hostLoggerFiles.emplace_back(it.path());
2164b7028ebfSSpencer Ku         }
2165b7028ebfSSpencer Ku     }
2166b7028ebfSSpencer Ku     // As the log files rotate, they are appended with a ".#" that is higher for
2167b7028ebfSSpencer Ku     // the older logs. Since we start from oldest logs, sort the name in
2168b7028ebfSSpencer Ku     // descending order.
2169b7028ebfSSpencer Ku     std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(),
2170b7028ebfSSpencer Ku               AlphanumLess<std::string>());
2171b7028ebfSSpencer Ku 
2172b7028ebfSSpencer Ku     return true;
2173b7028ebfSSpencer Ku }
2174b7028ebfSSpencer Ku 
217502cad96eSEd Tanous inline bool getHostLoggerEntries(
217602cad96eSEd Tanous     const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip,
217702cad96eSEd Tanous     uint64_t top, std::vector<std::string>& logEntries, size_t& logCount)
2178b7028ebfSSpencer Ku {
2179b7028ebfSSpencer Ku     GzFileReader logFile;
2180b7028ebfSSpencer Ku 
2181b7028ebfSSpencer Ku     // Go though all log files and expose host logs.
2182b7028ebfSSpencer Ku     for (const std::filesystem::path& it : hostLoggerFiles)
2183b7028ebfSSpencer Ku     {
2184b7028ebfSSpencer Ku         if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount))
2185b7028ebfSSpencer Ku         {
218662598e31SEd Tanous             BMCWEB_LOG_ERROR("fail to expose host logs");
2187b7028ebfSSpencer Ku             return false;
2188b7028ebfSSpencer Ku         }
2189b7028ebfSSpencer Ku     }
2190b7028ebfSSpencer Ku     // Get lastMessage from constructor by getter
2191b7028ebfSSpencer Ku     std::string lastMessage = logFile.getLastMessage();
2192b7028ebfSSpencer Ku     if (!lastMessage.empty())
2193b7028ebfSSpencer Ku     {
2194b7028ebfSSpencer Ku         logCount++;
2195b7028ebfSSpencer Ku         if (logCount > skip && logCount <= (skip + top))
2196b7028ebfSSpencer Ku         {
2197b7028ebfSSpencer Ku             logEntries.push_back(lastMessage);
2198b7028ebfSSpencer Ku         }
2199b7028ebfSSpencer Ku     }
2200b7028ebfSSpencer Ku     return true;
2201b7028ebfSSpencer Ku }
2202b7028ebfSSpencer Ku 
22036f056f24SEd Tanous inline void fillHostLoggerEntryJson(std::string_view logEntryID,
22046f056f24SEd Tanous                                     std::string_view msg,
22056d6574c9SJason M. Bills                                     nlohmann::json::object_t& logEntryJson)
2206b7028ebfSSpencer Ku {
2207b7028ebfSSpencer Ku     // Fill in the log entry with the gathered data.
22089c11a172SVijay Lobo     logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
2209ef4c65b7SEd Tanous     logEntryJson["@odata.id"] = boost::urls::format(
2210ef4c65b7SEd Tanous         "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/{}",
2211ef4c65b7SEd Tanous         logEntryID);
22126d6574c9SJason M. Bills     logEntryJson["Name"] = "Host Logger Entry";
22136d6574c9SJason M. Bills     logEntryJson["Id"] = logEntryID;
22146d6574c9SJason M. Bills     logEntryJson["Message"] = msg;
22156d6574c9SJason M. Bills     logEntryJson["EntryType"] = "Oem";
22166d6574c9SJason M. Bills     logEntryJson["Severity"] = "OK";
22176d6574c9SJason M. Bills     logEntryJson["OemRecordFormat"] = "Host Logger Entry";
2218b7028ebfSSpencer Ku }
2219b7028ebfSSpencer Ku 
2220b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app)
2221b7028ebfSSpencer Ku {
222222d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/")
2223b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogService)
22241476687dSEd Tanous         .methods(boost::beast::http::verb::get)(
22251476687dSEd Tanous             [&app](const crow::Request& req,
222622d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
222722d268cbSEd Tanous                    const std::string& systemName) {
22283ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
222945ca1b86SEd Tanous         {
223045ca1b86SEd Tanous             return;
223145ca1b86SEd Tanous         }
22327f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
22337f3e84a1SEd Tanous         {
22347f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
22357f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
22367f3e84a1SEd Tanous                                        systemName);
22377f3e84a1SEd Tanous             return;
22387f3e84a1SEd Tanous         }
223922d268cbSEd Tanous         if (systemName != "system")
224022d268cbSEd Tanous         {
224122d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
224222d268cbSEd Tanous                                        systemName);
224322d268cbSEd Tanous             return;
224422d268cbSEd Tanous         }
2245b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.id"] =
2246b7028ebfSSpencer Ku             "/redfish/v1/Systems/system/LogServices/HostLogger";
2247b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.type"] =
2248b25644a1SJanet Adkins             "#LogService.v1_2_0.LogService";
2249b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Name"] = "Host Logger Service";
2250b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Description"] = "Host Logger Service";
2251b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Id"] = "HostLogger";
22521476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
22531476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
2254b7028ebfSSpencer Ku     });
2255b7028ebfSSpencer Ku }
2256b7028ebfSSpencer Ku 
2257b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app)
2258b7028ebfSSpencer Ku {
2259b7028ebfSSpencer Ku     BMCWEB_ROUTE(app,
226022d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/")
2261b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogEntry)
2262002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2263002d39b4SEd Tanous             [&app](const crow::Request& req,
226422d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
226522d268cbSEd Tanous                    const std::string& systemName) {
2266c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
2267c937d2bfSEd Tanous             .canDelegateTop = true,
2268c937d2bfSEd Tanous             .canDelegateSkip = true,
2269c937d2bfSEd Tanous         };
2270c937d2bfSEd Tanous         query_param::Query delegatedQuery;
2271c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
22723ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
2273b7028ebfSSpencer Ku         {
2274b7028ebfSSpencer Ku             return;
2275b7028ebfSSpencer Ku         }
22767f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
22777f3e84a1SEd Tanous         {
22787f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
22797f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
22807f3e84a1SEd Tanous                                        systemName);
22817f3e84a1SEd Tanous             return;
22827f3e84a1SEd Tanous         }
228322d268cbSEd Tanous         if (systemName != "system")
228422d268cbSEd Tanous         {
228522d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
228622d268cbSEd Tanous                                        systemName);
228722d268cbSEd Tanous             return;
228822d268cbSEd Tanous         }
2289b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.id"] =
2290b7028ebfSSpencer Ku             "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
2291b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.type"] =
2292b7028ebfSSpencer Ku             "#LogEntryCollection.LogEntryCollection";
2293b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Name"] = "HostLogger Entries";
2294b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Description"] =
2295b7028ebfSSpencer Ku             "Collection of HostLogger Entries";
22960fda0f12SGeorge Liu         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2297b7028ebfSSpencer Ku         logEntryArray = nlohmann::json::array();
2298b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Members@odata.count"] = 0;
2299b7028ebfSSpencer Ku 
2300b7028ebfSSpencer Ku         std::vector<std::filesystem::path> hostLoggerFiles;
2301b7028ebfSSpencer Ku         if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2302b7028ebfSSpencer Ku         {
2303bf2ddedeSCarson Labrado             BMCWEB_LOG_DEBUG("Failed to get host log file path");
2304b7028ebfSSpencer Ku             return;
2305b7028ebfSSpencer Ku         }
23063648c8beSEd Tanous         // If we weren't provided top and skip limits, use the defaults.
23073648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
23085143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
2309b7028ebfSSpencer Ku         size_t logCount = 0;
2310b7028ebfSSpencer Ku         // This vector only store the entries we want to expose that
2311b7028ebfSSpencer Ku         // control by skip and top.
2312b7028ebfSSpencer Ku         std::vector<std::string> logEntries;
23133648c8beSEd Tanous         if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries,
23143648c8beSEd Tanous                                   logCount))
2315b7028ebfSSpencer Ku         {
2316b7028ebfSSpencer Ku             messages::internalError(asyncResp->res);
2317b7028ebfSSpencer Ku             return;
2318b7028ebfSSpencer Ku         }
2319b7028ebfSSpencer Ku         // If vector is empty, that means skip value larger than total
2320b7028ebfSSpencer Ku         // log count
232126f6976fSEd Tanous         if (logEntries.empty())
2322b7028ebfSSpencer Ku         {
2323b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Members@odata.count"] = logCount;
2324b7028ebfSSpencer Ku             return;
2325b7028ebfSSpencer Ku         }
232626f6976fSEd Tanous         if (!logEntries.empty())
2327b7028ebfSSpencer Ku         {
2328b7028ebfSSpencer Ku             for (size_t i = 0; i < logEntries.size(); i++)
2329b7028ebfSSpencer Ku             {
23306d6574c9SJason M. Bills                 nlohmann::json::object_t hostLogEntry;
23313648c8beSEd Tanous                 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i],
23323648c8beSEd Tanous                                         hostLogEntry);
2333b2ba3072SPatrick Williams                 logEntryArray.emplace_back(std::move(hostLogEntry));
2334b7028ebfSSpencer Ku             }
2335b7028ebfSSpencer Ku 
2336b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Members@odata.count"] = logCount;
23373648c8beSEd Tanous             if (skip + top < logCount)
2338b7028ebfSSpencer Ku             {
2339b7028ebfSSpencer Ku                 asyncResp->res.jsonValue["Members@odata.nextLink"] =
23400fda0f12SGeorge Liu                     "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" +
23413648c8beSEd Tanous                     std::to_string(skip + top);
2342b7028ebfSSpencer Ku             }
2343b7028ebfSSpencer Ku         }
2344b7028ebfSSpencer Ku     });
2345b7028ebfSSpencer Ku }
2346b7028ebfSSpencer Ku 
2347b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app)
2348b7028ebfSSpencer Ku {
2349b7028ebfSSpencer Ku     BMCWEB_ROUTE(
235022d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/")
2351b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogEntry)
2352b7028ebfSSpencer Ku         .methods(boost::beast::http::verb::get)(
235345ca1b86SEd Tanous             [&app](const crow::Request& req,
2354b7028ebfSSpencer Ku                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
235522d268cbSEd Tanous                    const std::string& systemName, const std::string& param) {
23563ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
235745ca1b86SEd Tanous         {
235845ca1b86SEd Tanous             return;
235945ca1b86SEd Tanous         }
23607f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
23617f3e84a1SEd Tanous         {
23627f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
23637f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
23647f3e84a1SEd Tanous                                        systemName);
23657f3e84a1SEd Tanous             return;
23667f3e84a1SEd Tanous         }
236722d268cbSEd Tanous         if (systemName != "system")
236822d268cbSEd Tanous         {
236922d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
237022d268cbSEd Tanous                                        systemName);
237122d268cbSEd Tanous             return;
237222d268cbSEd Tanous         }
23736f056f24SEd Tanous         std::string_view targetID = param;
2374b7028ebfSSpencer Ku 
2375b7028ebfSSpencer Ku         uint64_t idInt = 0;
2376ca45aa3cSEd Tanous 
23776f056f24SEd Tanous         auto [ptr, ec] = std::from_chars(targetID.begin(), targetID.end(),
237884396af9SPatrick Williams                                          idInt);
23796f056f24SEd Tanous         if (ec != std::errc{} || ptr != targetID.end())
2380b7028ebfSSpencer Ku         {
23819db4ba25SJiaqing Zhao             messages::resourceNotFound(asyncResp->res, "LogEntry", param);
2382b7028ebfSSpencer Ku             return;
2383b7028ebfSSpencer Ku         }
2384b7028ebfSSpencer Ku 
2385b7028ebfSSpencer Ku         std::vector<std::filesystem::path> hostLoggerFiles;
2386b7028ebfSSpencer Ku         if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2387b7028ebfSSpencer Ku         {
2388bf2ddedeSCarson Labrado             BMCWEB_LOG_DEBUG("Failed to get host log file path");
2389b7028ebfSSpencer Ku             return;
2390b7028ebfSSpencer Ku         }
2391b7028ebfSSpencer Ku 
2392b7028ebfSSpencer Ku         size_t logCount = 0;
23933648c8beSEd Tanous         size_t top = 1;
2394b7028ebfSSpencer Ku         std::vector<std::string> logEntries;
2395b7028ebfSSpencer Ku         // We can get specific entry by skip and top. For example, if we
2396b7028ebfSSpencer Ku         // want to get nth entry, we can set skip = n-1 and top = 1 to
2397b7028ebfSSpencer Ku         // get that entry
2398002d39b4SEd Tanous         if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries,
2399002d39b4SEd Tanous                                   logCount))
2400b7028ebfSSpencer Ku         {
2401b7028ebfSSpencer Ku             messages::internalError(asyncResp->res);
2402b7028ebfSSpencer Ku             return;
2403b7028ebfSSpencer Ku         }
2404b7028ebfSSpencer Ku 
2405b7028ebfSSpencer Ku         if (!logEntries.empty())
2406b7028ebfSSpencer Ku         {
24076d6574c9SJason M. Bills             nlohmann::json::object_t hostLogEntry;
24086d6574c9SJason M. Bills             fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry);
24096d6574c9SJason M. Bills             asyncResp->res.jsonValue.update(hostLogEntry);
2410b7028ebfSSpencer Ku             return;
2411b7028ebfSSpencer Ku         }
2412b7028ebfSSpencer Ku 
2413b7028ebfSSpencer Ku         // Requested ID was not found
24149db4ba25SJiaqing Zhao         messages::resourceNotFound(asyncResp->res, "LogEntry", param);
2415b7028ebfSSpencer Ku     });
2416b7028ebfSSpencer Ku }
2417b7028ebfSSpencer Ku 
2418dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet(
2419fdd26906SClaire Weinan     crow::App& app, const crow::Request& req,
2420fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
24211da66f75SEd Tanous {
24223ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
242345ca1b86SEd Tanous     {
242445ca1b86SEd Tanous         return;
242545ca1b86SEd Tanous     }
24267e860f15SJohn Edward Broadbent     // Collections don't include the static data added by SubRoute
24277e860f15SJohn Edward Broadbent     // because it has a duplicate entry for members
2428e1f26343SJason M. Bills     asyncResp->res.jsonValue["@odata.type"] =
24291da66f75SEd Tanous         "#LogServiceCollection.LogServiceCollection";
2430e1f26343SJason M. Bills     asyncResp->res.jsonValue["@odata.id"] =
2431e1f26343SJason M. Bills         "/redfish/v1/Managers/bmc/LogServices";
2432002d39b4SEd Tanous     asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
2433e1f26343SJason M. Bills     asyncResp->res.jsonValue["Description"] =
24341da66f75SEd Tanous         "Collection of LogServices for this Manager";
2435002d39b4SEd Tanous     nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
2436c4bf6374SJason M. Bills     logServiceArray = nlohmann::json::array();
2437fdd26906SClaire Weinan 
2438c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
2439613dabeaSEd Tanous     nlohmann::json::object_t journal;
2440613dabeaSEd Tanous     journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal";
2441b2ba3072SPatrick Williams     logServiceArray.emplace_back(std::move(journal));
2442c4bf6374SJason M. Bills #endif
2443fdd26906SClaire Weinan 
2444fdd26906SClaire Weinan     asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size();
2445fdd26906SClaire Weinan 
2446fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
244715912159SGeorge Liu     constexpr std::array<std::string_view, 1> interfaces = {
24487a1dbc48SGeorge Liu         "xyz.openbmc_project.Collection.DeleteAll"};
24497a1dbc48SGeorge Liu     dbus::utility::getSubTreePaths(
24507a1dbc48SGeorge Liu         "/xyz/openbmc_project/dump", 0, interfaces,
2451fdd26906SClaire Weinan         [asyncResp](
24527a1dbc48SGeorge Liu             const boost::system::error_code& ec,
2453fdd26906SClaire Weinan             const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2454fdd26906SClaire Weinan         if (ec)
2455fdd26906SClaire Weinan         {
245662598e31SEd Tanous             BMCWEB_LOG_ERROR(
245762598e31SEd Tanous                 "handleBMCLogServicesCollectionGet respHandler got error {}",
245862598e31SEd Tanous                 ec);
2459fdd26906SClaire Weinan             // Assume that getting an error simply means there are no dump
2460fdd26906SClaire Weinan             // LogServices. Return without adding any error response.
2461fdd26906SClaire Weinan             return;
2462fdd26906SClaire Weinan         }
2463fdd26906SClaire Weinan 
2464fdd26906SClaire Weinan         nlohmann::json& logServiceArrayLocal =
2465fdd26906SClaire Weinan             asyncResp->res.jsonValue["Members"];
2466fdd26906SClaire Weinan 
2467fdd26906SClaire Weinan         for (const std::string& path : subTreePaths)
2468fdd26906SClaire Weinan         {
2469fdd26906SClaire Weinan             if (path == "/xyz/openbmc_project/dump/bmc")
2470fdd26906SClaire Weinan             {
2471613dabeaSEd Tanous                 nlohmann::json::object_t member;
2472613dabeaSEd Tanous                 member["@odata.id"] =
2473613dabeaSEd Tanous                     "/redfish/v1/Managers/bmc/LogServices/Dump";
2474b2ba3072SPatrick Williams                 logServiceArrayLocal.emplace_back(std::move(member));
2475fdd26906SClaire Weinan             }
2476fdd26906SClaire Weinan             else if (path == "/xyz/openbmc_project/dump/faultlog")
2477fdd26906SClaire Weinan             {
2478613dabeaSEd Tanous                 nlohmann::json::object_t member;
2479613dabeaSEd Tanous                 member["@odata.id"] =
2480613dabeaSEd Tanous                     "/redfish/v1/Managers/bmc/LogServices/FaultLog";
2481b2ba3072SPatrick Williams                 logServiceArrayLocal.emplace_back(std::move(member));
2482fdd26906SClaire Weinan             }
2483fdd26906SClaire Weinan         }
2484fdd26906SClaire Weinan 
2485e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
2486fdd26906SClaire Weinan             logServiceArrayLocal.size();
24877a1dbc48SGeorge Liu     });
2488fdd26906SClaire Weinan #endif
2489fdd26906SClaire Weinan }
2490fdd26906SClaire Weinan 
2491fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app)
2492fdd26906SClaire Weinan {
2493fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/")
2494fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogServiceCollection)
2495fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(
2496dd72e87bSClaire Weinan             std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app)));
2497e1f26343SJason M. Bills }
2498e1f26343SJason M. Bills 
24997e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app)
2500e1f26343SJason M. Bills {
25017e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
2502ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
25037e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
250445ca1b86SEd Tanous             [&app](const crow::Request& req,
250545ca1b86SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
25063ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
25077e860f15SJohn Edward Broadbent         {
250845ca1b86SEd Tanous             return;
250945ca1b86SEd Tanous         }
2510e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2511b25644a1SJanet Adkins             "#LogService.v1_2_0.LogService";
25120f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
25130f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
2514002d39b4SEd Tanous         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
2515002d39b4SEd Tanous         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
2516ed34a4adSEd Tanous         asyncResp->res.jsonValue["Id"] = "Journal";
2517e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
25187c8c4058STejas Patil 
25197c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
25202b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
2521002d39b4SEd Tanous         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
25227c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
25237c8c4058STejas Patil             redfishDateTimeOffset.second;
25247c8c4058STejas Patil 
25251476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
25261476687dSEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
25277e860f15SJohn Edward Broadbent     });
2528e1f26343SJason M. Bills }
2529e1f26343SJason M. Bills 
25303a48b3a2SJason M. Bills static int
25313a48b3a2SJason M. Bills     fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
2532e1f26343SJason M. Bills                                sd_journal* journal,
25333a48b3a2SJason M. Bills                                nlohmann::json::object_t& bmcJournalLogEntryJson)
2534e1f26343SJason M. Bills {
2535e1f26343SJason M. Bills     // Get the Log Entry contents
2536e1f26343SJason M. Bills     int ret = 0;
2537e1f26343SJason M. Bills 
2538a8fe54f0SJason M. Bills     std::string message;
2539a8fe54f0SJason M. Bills     std::string_view syslogID;
2540a8fe54f0SJason M. Bills     ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
2541a8fe54f0SJason M. Bills     if (ret < 0)
2542a8fe54f0SJason M. Bills     {
2543bf2ddedeSCarson Labrado         BMCWEB_LOG_DEBUG("Failed to read SYSLOG_IDENTIFIER field: {}",
254462598e31SEd Tanous                          strerror(-ret));
2545a8fe54f0SJason M. Bills     }
2546a8fe54f0SJason M. Bills     if (!syslogID.empty())
2547a8fe54f0SJason M. Bills     {
2548a8fe54f0SJason M. Bills         message += std::string(syslogID) + ": ";
2549a8fe54f0SJason M. Bills     }
2550a8fe54f0SJason M. Bills 
255139e77504SEd Tanous     std::string_view msg;
255216428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
2553e1f26343SJason M. Bills     if (ret < 0)
2554e1f26343SJason M. Bills     {
255562598e31SEd Tanous         BMCWEB_LOG_ERROR("Failed to read MESSAGE field: {}", strerror(-ret));
2556e1f26343SJason M. Bills         return 1;
2557e1f26343SJason M. Bills     }
2558a8fe54f0SJason M. Bills     message += std::string(msg);
2559e1f26343SJason M. Bills 
2560e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
2561271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
256216428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
2563e1f26343SJason M. Bills     if (ret < 0)
2564e1f26343SJason M. Bills     {
2565bf2ddedeSCarson Labrado         BMCWEB_LOG_DEBUG("Failed to read PRIORITY field: {}", strerror(-ret));
2566e1f26343SJason M. Bills     }
2567e1f26343SJason M. Bills 
2568e1f26343SJason M. Bills     // Get the Created time from the timestamp
256916428a1aSJason M. Bills     std::string entryTimeStr;
257016428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
2571e1f26343SJason M. Bills     {
257216428a1aSJason M. Bills         return 1;
2573e1f26343SJason M. Bills     }
2574e1f26343SJason M. Bills 
2575e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
25769c11a172SVijay Lobo     bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
2577ef4c65b7SEd Tanous     bmcJournalLogEntryJson["@odata.id"] = boost::urls::format(
2578ef4c65b7SEd Tanous         "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/{}",
2579eddfc437SWilly Tu         bmcJournalLogEntryID);
258084afc48bSJason M. Bills     bmcJournalLogEntryJson["Name"] = "BMC Journal Entry";
258184afc48bSJason M. Bills     bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID;
258284afc48bSJason M. Bills     bmcJournalLogEntryJson["Message"] = std::move(message);
258384afc48bSJason M. Bills     bmcJournalLogEntryJson["EntryType"] = "Oem";
2584ddf3564eSEd Tanous     log_entry::EventSeverity severityEnum = log_entry::EventSeverity::OK;
2585ddf3564eSEd Tanous     if (severity <= 2)
2586ddf3564eSEd Tanous     {
2587ddf3564eSEd Tanous         severityEnum = log_entry::EventSeverity::Critical;
2588ddf3564eSEd Tanous     }
2589ddf3564eSEd Tanous     else if (severity <= 4)
2590ddf3564eSEd Tanous     {
2591ddf3564eSEd Tanous         severityEnum = log_entry::EventSeverity::Warning;
2592ddf3564eSEd Tanous     }
2593ddf3564eSEd Tanous 
2594ddf3564eSEd Tanous     bmcJournalLogEntryJson["Severity"] = severityEnum;
259584afc48bSJason M. Bills     bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry";
259684afc48bSJason M. Bills     bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr);
2597e1f26343SJason M. Bills     return 0;
2598e1f26343SJason M. Bills }
2599e1f26343SJason M. Bills 
26007e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app)
2601e1f26343SJason M. Bills {
26027e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
2603ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
2604002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2605002d39b4SEd Tanous             [&app](const crow::Request& req,
2606002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2607c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
2608c937d2bfSEd Tanous             .canDelegateTop = true,
2609c937d2bfSEd Tanous             .canDelegateSkip = true,
2610c937d2bfSEd Tanous         };
2611c937d2bfSEd Tanous         query_param::Query delegatedQuery;
2612c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
26133ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
2614193ad2faSJason M. Bills         {
2615193ad2faSJason M. Bills             return;
2616193ad2faSJason M. Bills         }
26173648c8beSEd Tanous 
26183648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
26195143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
26203648c8beSEd Tanous 
26217e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
26227e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
2623e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2624e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
26250f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
26260f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2627e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
2628e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
2629e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
26300fda0f12SGeorge Liu         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2631e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
2632e1f26343SJason M. Bills 
26337e860f15SJohn Edward Broadbent         // Go through the journal and use the timestamp to create a
26347e860f15SJohn Edward Broadbent         // unique ID for each entry
2635e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
2636e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2637e1f26343SJason M. Bills         if (ret < 0)
2638e1f26343SJason M. Bills         {
263962598e31SEd Tanous             BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret));
2640f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2641e1f26343SJason M. Bills             return;
2642e1f26343SJason M. Bills         }
26430fda0f12SGeorge Liu         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
26440fda0f12SGeorge Liu             journalTmp, sd_journal_close);
2645e1f26343SJason M. Bills         journalTmp = nullptr;
2646b01bf299SEd Tanous         uint64_t entryCount = 0;
2647e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
2648e85d6b16SJason M. Bills         bool firstEntry = true;
2649e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
2650e1f26343SJason M. Bills         {
2651193ad2faSJason M. Bills             entryCount++;
26527e860f15SJohn Edward Broadbent             // Handle paging using skip (number of entries to skip from
26537e860f15SJohn Edward Broadbent             // the start) and top (number of entries to display)
26543648c8beSEd Tanous             if (entryCount <= skip || entryCount > skip + top)
2655193ad2faSJason M. Bills             {
2656193ad2faSJason M. Bills                 continue;
2657193ad2faSJason M. Bills             }
2658193ad2faSJason M. Bills 
265916428a1aSJason M. Bills             std::string idStr;
2660e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2661e1f26343SJason M. Bills             {
2662e1f26343SJason M. Bills                 continue;
2663e1f26343SJason M. Bills             }
2664e85d6b16SJason M. Bills             firstEntry = false;
2665e85d6b16SJason M. Bills 
26663a48b3a2SJason M. Bills             nlohmann::json::object_t bmcJournalLogEntry;
2667c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
2668c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
2669e1f26343SJason M. Bills             {
2670f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
2671e1f26343SJason M. Bills                 return;
2672e1f26343SJason M. Bills             }
2673b2ba3072SPatrick Williams             logEntryArray.emplace_back(std::move(bmcJournalLogEntry));
2674e1f26343SJason M. Bills         }
2675193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
26763648c8beSEd Tanous         if (skip + top < entryCount)
2677193ad2faSJason M. Bills         {
2678193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
26790fda0f12SGeorge Liu                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
26803648c8beSEd Tanous                 std::to_string(skip + top);
2681193ad2faSJason M. Bills         }
26827e860f15SJohn Edward Broadbent     });
2683e1f26343SJason M. Bills }
2684e1f26343SJason M. Bills 
26857e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app)
2686e1f26343SJason M. Bills {
26877e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
26887e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/")
2689ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
26907e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
269145ca1b86SEd Tanous             [&app](const crow::Request& req,
26927e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
26937e860f15SJohn Edward Broadbent                    const std::string& entryID) {
26943ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
269545ca1b86SEd Tanous         {
269645ca1b86SEd Tanous             return;
269745ca1b86SEd Tanous         }
2698e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
269975e8e218SMyung Bae         sd_id128_t bootID{};
2700e1f26343SJason M. Bills         uint64_t ts = 0;
2701271584abSEd Tanous         uint64_t index = 0;
270275e8e218SMyung Bae         if (!getTimestampFromID(asyncResp, entryID, bootID, ts, index))
2703e1f26343SJason M. Bills         {
270416428a1aSJason M. Bills             return;
2705e1f26343SJason M. Bills         }
2706e1f26343SJason M. Bills 
2707e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
2708e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2709e1f26343SJason M. Bills         if (ret < 0)
2710e1f26343SJason M. Bills         {
271162598e31SEd Tanous             BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret));
2712f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2713e1f26343SJason M. Bills             return;
2714e1f26343SJason M. Bills         }
2715002d39b4SEd Tanous         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2716002d39b4SEd Tanous             journalTmp, sd_journal_close);
2717e1f26343SJason M. Bills         journalTmp = nullptr;
27187e860f15SJohn Edward Broadbent         // Go to the timestamp in the log and move to the entry at the
27197e860f15SJohn Edward Broadbent         // index tracking the unique ID
2720af07e3f5SJason M. Bills         std::string idStr;
2721af07e3f5SJason M. Bills         bool firstEntry = true;
272275e8e218SMyung Bae         ret = sd_journal_seek_monotonic_usec(journal.get(), bootID, ts);
27232056b6d1SManojkiran Eda         if (ret < 0)
27242056b6d1SManojkiran Eda         {
272562598e31SEd Tanous             BMCWEB_LOG_ERROR("failed to seek to an entry in journal{}",
272662598e31SEd Tanous                              strerror(-ret));
27272056b6d1SManojkiran Eda             messages::internalError(asyncResp->res);
27282056b6d1SManojkiran Eda             return;
27292056b6d1SManojkiran Eda         }
2730271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
2731e1f26343SJason M. Bills         {
2732e1f26343SJason M. Bills             sd_journal_next(journal.get());
2733af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2734af07e3f5SJason M. Bills             {
2735af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
2736af07e3f5SJason M. Bills                 return;
2737af07e3f5SJason M. Bills             }
2738af07e3f5SJason M. Bills             firstEntry = false;
2739af07e3f5SJason M. Bills         }
2740c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
2741af07e3f5SJason M. Bills         if (idStr != entryID)
2742c4bf6374SJason M. Bills         {
27439db4ba25SJiaqing Zhao             messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
2744c4bf6374SJason M. Bills             return;
2745c4bf6374SJason M. Bills         }
2746c4bf6374SJason M. Bills 
27473a48b3a2SJason M. Bills         nlohmann::json::object_t bmcJournalLogEntry;
2748c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
27493a48b3a2SJason M. Bills                                        bmcJournalLogEntry) != 0)
2750e1f26343SJason M. Bills         {
2751f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2752e1f26343SJason M. Bills             return;
2753e1f26343SJason M. Bills         }
2754d405bb51SJason M. Bills         asyncResp->res.jsonValue.update(bmcJournalLogEntry);
27557e860f15SJohn Edward Broadbent     });
2756c9bb6861Sraviteja-b }
2757c9bb6861Sraviteja-b 
2758fdd26906SClaire Weinan inline void
2759fdd26906SClaire Weinan     getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2760fdd26906SClaire Weinan                        const std::string& dumpType)
2761c9bb6861Sraviteja-b {
2762fdd26906SClaire Weinan     std::string dumpPath;
2763fdd26906SClaire Weinan     std::string overWritePolicy;
2764fdd26906SClaire Weinan     bool collectDiagnosticDataSupported = false;
2765fdd26906SClaire Weinan 
2766fdd26906SClaire Weinan     if (dumpType == "BMC")
276745ca1b86SEd Tanous     {
2768fdd26906SClaire Weinan         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump";
2769fdd26906SClaire Weinan         overWritePolicy = "WrapsWhenFull";
2770fdd26906SClaire Weinan         collectDiagnosticDataSupported = true;
2771fdd26906SClaire Weinan     }
2772fdd26906SClaire Weinan     else if (dumpType == "FaultLog")
2773fdd26906SClaire Weinan     {
2774fdd26906SClaire Weinan         dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog";
2775fdd26906SClaire Weinan         overWritePolicy = "Unknown";
2776fdd26906SClaire Weinan         collectDiagnosticDataSupported = false;
2777fdd26906SClaire Weinan     }
2778fdd26906SClaire Weinan     else if (dumpType == "System")
2779fdd26906SClaire Weinan     {
2780fdd26906SClaire Weinan         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump";
2781fdd26906SClaire Weinan         overWritePolicy = "WrapsWhenFull";
2782fdd26906SClaire Weinan         collectDiagnosticDataSupported = true;
2783fdd26906SClaire Weinan     }
2784fdd26906SClaire Weinan     else
2785fdd26906SClaire Weinan     {
278662598e31SEd Tanous         BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}",
278762598e31SEd Tanous                          dumpType);
2788fdd26906SClaire Weinan         messages::internalError(asyncResp->res);
278945ca1b86SEd Tanous         return;
279045ca1b86SEd Tanous     }
2791fdd26906SClaire Weinan 
2792fdd26906SClaire Weinan     asyncResp->res.jsonValue["@odata.id"] = dumpPath;
2793fdd26906SClaire Weinan     asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService";
2794c9bb6861Sraviteja-b     asyncResp->res.jsonValue["Name"] = "Dump LogService";
2795fdd26906SClaire Weinan     asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService";
2796fdd26906SClaire Weinan     asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename();
2797fdd26906SClaire Weinan     asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy);
27987c8c4058STejas Patil 
27997c8c4058STejas Patil     std::pair<std::string, std::string> redfishDateTimeOffset =
28002b82937eSEd Tanous         redfish::time_utils::getDateTimeOffsetNow();
28010fda0f12SGeorge Liu     asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
28027c8c4058STejas Patil     asyncResp->res.jsonValue["DateTimeLocalOffset"] =
28037c8c4058STejas Patil         redfishDateTimeOffset.second;
28047c8c4058STejas Patil 
2805fdd26906SClaire Weinan     asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries";
2806fdd26906SClaire Weinan 
2807fdd26906SClaire Weinan     if (collectDiagnosticDataSupported)
2808fdd26906SClaire Weinan     {
2809002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
28101476687dSEd Tanous                                 ["target"] =
2811fdd26906SClaire Weinan             dumpPath + "/Actions/LogService.CollectDiagnosticData";
2812fdd26906SClaire Weinan     }
28130d946211SClaire Weinan 
28140d946211SClaire Weinan     constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface};
28150d946211SClaire Weinan     dbus::utility::getSubTreePaths(
28160d946211SClaire Weinan         "/xyz/openbmc_project/dump", 0, interfaces,
28170d946211SClaire Weinan         [asyncResp, dumpType, dumpPath](
28180d946211SClaire Weinan             const boost::system::error_code& ec,
28190d946211SClaire Weinan             const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
28200d946211SClaire Weinan         if (ec)
28210d946211SClaire Weinan         {
282262598e31SEd Tanous             BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", ec);
28230d946211SClaire Weinan             // Assume that getting an error simply means there are no dump
28240d946211SClaire Weinan             // LogServices. Return without adding any error response.
28250d946211SClaire Weinan             return;
28260d946211SClaire Weinan         }
282718f8f608SEd Tanous         std::string dbusDumpPath = getDumpPath(dumpType);
28280d946211SClaire Weinan         for (const std::string& path : subTreePaths)
28290d946211SClaire Weinan         {
28300d946211SClaire Weinan             if (path == dbusDumpPath)
28310d946211SClaire Weinan             {
28320d946211SClaire Weinan                 asyncResp->res
28330d946211SClaire Weinan                     .jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
28340d946211SClaire Weinan                     dumpPath + "/Actions/LogService.ClearLog";
28350d946211SClaire Weinan                 break;
28360d946211SClaire Weinan             }
28370d946211SClaire Weinan         }
28380d946211SClaire Weinan     });
2839c9bb6861Sraviteja-b }
2840c9bb6861Sraviteja-b 
2841fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet(
2842fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2843fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
28447e860f15SJohn Edward Broadbent {
28453ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
284645ca1b86SEd Tanous     {
284745ca1b86SEd Tanous         return;
284845ca1b86SEd Tanous     }
2849fdd26906SClaire Weinan     getDumpServiceInfo(asyncResp, dumpType);
2850fdd26906SClaire Weinan }
2851c9bb6861Sraviteja-b 
285222d268cbSEd Tanous inline void handleLogServicesDumpServiceComputerSystemGet(
285322d268cbSEd Tanous     crow::App& app, const crow::Request& req,
285422d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
285522d268cbSEd Tanous     const std::string& chassisId)
285622d268cbSEd Tanous {
285722d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
285822d268cbSEd Tanous     {
285922d268cbSEd Tanous         return;
286022d268cbSEd Tanous     }
286122d268cbSEd Tanous     if (chassisId != "system")
286222d268cbSEd Tanous     {
286322d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
286422d268cbSEd Tanous         return;
286522d268cbSEd Tanous     }
286622d268cbSEd Tanous     getDumpServiceInfo(asyncResp, "System");
286722d268cbSEd Tanous }
286822d268cbSEd Tanous 
2869fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet(
2870fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2871fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2872fdd26906SClaire Weinan {
2873fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2874fdd26906SClaire Weinan     {
2875fdd26906SClaire Weinan         return;
2876fdd26906SClaire Weinan     }
2877fdd26906SClaire Weinan     getDumpEntryCollection(asyncResp, dumpType);
2878fdd26906SClaire Weinan }
2879fdd26906SClaire Weinan 
288022d268cbSEd Tanous inline void handleLogServicesDumpEntriesCollectionComputerSystemGet(
288122d268cbSEd Tanous     crow::App& app, const crow::Request& req,
288222d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
288322d268cbSEd Tanous     const std::string& chassisId)
288422d268cbSEd Tanous {
288522d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
288622d268cbSEd Tanous     {
288722d268cbSEd Tanous         return;
288822d268cbSEd Tanous     }
288922d268cbSEd Tanous     if (chassisId != "system")
289022d268cbSEd Tanous     {
289122d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
289222d268cbSEd Tanous         return;
289322d268cbSEd Tanous     }
289422d268cbSEd Tanous     getDumpEntryCollection(asyncResp, "System");
289522d268cbSEd Tanous }
289622d268cbSEd Tanous 
2897fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet(
2898fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2899fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2900fdd26906SClaire Weinan     const std::string& dumpId)
2901fdd26906SClaire Weinan {
2902fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2903fdd26906SClaire Weinan     {
2904fdd26906SClaire Weinan         return;
2905fdd26906SClaire Weinan     }
2906fdd26906SClaire Weinan     getDumpEntryById(asyncResp, dumpId, dumpType);
2907fdd26906SClaire Weinan }
2908168d1b1aSCarson Labrado 
290922d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemGet(
291022d268cbSEd Tanous     crow::App& app, const crow::Request& req,
291122d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
291222d268cbSEd Tanous     const std::string& chassisId, const std::string& dumpId)
291322d268cbSEd Tanous {
291422d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
291522d268cbSEd Tanous     {
291622d268cbSEd Tanous         return;
291722d268cbSEd Tanous     }
291822d268cbSEd Tanous     if (chassisId != "system")
291922d268cbSEd Tanous     {
292022d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
292122d268cbSEd Tanous         return;
292222d268cbSEd Tanous     }
292322d268cbSEd Tanous     getDumpEntryById(asyncResp, dumpId, "System");
292422d268cbSEd Tanous }
2925fdd26906SClaire Weinan 
2926fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete(
2927fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2928fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2929fdd26906SClaire Weinan     const std::string& dumpId)
2930fdd26906SClaire Weinan {
2931fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2932fdd26906SClaire Weinan     {
2933fdd26906SClaire Weinan         return;
2934fdd26906SClaire Weinan     }
2935fdd26906SClaire Weinan     deleteDumpEntry(asyncResp, dumpId, dumpType);
2936fdd26906SClaire Weinan }
2937fdd26906SClaire Weinan 
293822d268cbSEd Tanous inline void handleLogServicesDumpEntryComputerSystemDelete(
293922d268cbSEd Tanous     crow::App& app, const crow::Request& req,
294022d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
294122d268cbSEd Tanous     const std::string& chassisId, const std::string& dumpId)
294222d268cbSEd Tanous {
294322d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
294422d268cbSEd Tanous     {
294522d268cbSEd Tanous         return;
294622d268cbSEd Tanous     }
294722d268cbSEd Tanous     if (chassisId != "system")
294822d268cbSEd Tanous     {
294922d268cbSEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
295022d268cbSEd Tanous         return;
295122d268cbSEd Tanous     }
295222d268cbSEd Tanous     deleteDumpEntry(asyncResp, dumpId, "System");
295322d268cbSEd Tanous }
295422d268cbSEd Tanous 
2955168d1b1aSCarson Labrado inline void handleLogServicesDumpEntryDownloadGet(
2956168d1b1aSCarson Labrado     crow::App& app, const std::string& dumpType, const crow::Request& req,
2957168d1b1aSCarson Labrado     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2958168d1b1aSCarson Labrado     const std::string& dumpId)
2959168d1b1aSCarson Labrado {
2960168d1b1aSCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2961168d1b1aSCarson Labrado     {
2962168d1b1aSCarson Labrado         return;
2963168d1b1aSCarson Labrado     }
2964168d1b1aSCarson Labrado     downloadDumpEntry(asyncResp, dumpId, dumpType);
2965168d1b1aSCarson Labrado }
2966168d1b1aSCarson Labrado 
2967168d1b1aSCarson Labrado inline void handleDBusEventLogEntryDownloadGet(
2968168d1b1aSCarson Labrado     crow::App& app, const std::string& dumpType, const crow::Request& req,
2969168d1b1aSCarson Labrado     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2970168d1b1aSCarson Labrado     const std::string& systemName, const std::string& entryID)
2971168d1b1aSCarson Labrado {
2972168d1b1aSCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2973168d1b1aSCarson Labrado     {
2974168d1b1aSCarson Labrado         return;
2975168d1b1aSCarson Labrado     }
2976168d1b1aSCarson Labrado     if (!http_helpers::isContentTypeAllowed(
2977168d1b1aSCarson Labrado             req.getHeaderValue("Accept"),
2978168d1b1aSCarson Labrado             http_helpers::ContentType::OctetStream, true))
2979168d1b1aSCarson Labrado     {
2980168d1b1aSCarson Labrado         asyncResp->res.result(boost::beast::http::status::bad_request);
2981168d1b1aSCarson Labrado         return;
2982168d1b1aSCarson Labrado     }
2983168d1b1aSCarson Labrado     downloadEventLogEntry(asyncResp, systemName, entryID, dumpType);
2984168d1b1aSCarson Labrado }
2985168d1b1aSCarson Labrado 
2986fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost(
2987fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2988fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2989fdd26906SClaire Weinan {
2990fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2991fdd26906SClaire Weinan     {
2992fdd26906SClaire Weinan         return;
2993fdd26906SClaire Weinan     }
2994fdd26906SClaire Weinan     createDump(asyncResp, req, dumpType);
2995fdd26906SClaire Weinan }
2996fdd26906SClaire Weinan 
299722d268cbSEd Tanous inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost(
299822d268cbSEd Tanous     crow::App& app, const crow::Request& req,
299922d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
30007f3e84a1SEd Tanous     const std::string& systemName)
300122d268cbSEd Tanous {
300222d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
300322d268cbSEd Tanous     {
300422d268cbSEd Tanous         return;
300522d268cbSEd Tanous     }
30067f3e84a1SEd Tanous 
30077f3e84a1SEd Tanous     if constexpr (bmcwebEnableMultiHost)
300822d268cbSEd Tanous     {
30097f3e84a1SEd Tanous         // Option currently returns no systems.  TBD
30107f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
30117f3e84a1SEd Tanous                                    systemName);
30127f3e84a1SEd Tanous         return;
30137f3e84a1SEd Tanous     }
30147f3e84a1SEd Tanous     if (systemName != "system")
30157f3e84a1SEd Tanous     {
30167f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
30177f3e84a1SEd Tanous                                    systemName);
301822d268cbSEd Tanous         return;
301922d268cbSEd Tanous     }
302022d268cbSEd Tanous     createDump(asyncResp, req, "System");
302122d268cbSEd Tanous }
302222d268cbSEd Tanous 
3023fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost(
3024fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
3025fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
3026fdd26906SClaire Weinan {
3027fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
3028fdd26906SClaire Weinan     {
3029fdd26906SClaire Weinan         return;
3030fdd26906SClaire Weinan     }
3031fdd26906SClaire Weinan     clearDump(asyncResp, dumpType);
3032fdd26906SClaire Weinan }
3033fdd26906SClaire Weinan 
303422d268cbSEd Tanous inline void handleLogServicesDumpClearLogComputerSystemPost(
303522d268cbSEd Tanous     crow::App& app, const crow::Request& req,
303622d268cbSEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
30377f3e84a1SEd Tanous     const std::string& systemName)
303822d268cbSEd Tanous {
303922d268cbSEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
304022d268cbSEd Tanous     {
304122d268cbSEd Tanous         return;
304222d268cbSEd Tanous     }
30437f3e84a1SEd Tanous     if constexpr (bmcwebEnableMultiHost)
304422d268cbSEd Tanous     {
30457f3e84a1SEd Tanous         // Option currently returns no systems.  TBD
30467f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
30477f3e84a1SEd Tanous                                    systemName);
30487f3e84a1SEd Tanous         return;
30497f3e84a1SEd Tanous     }
30507f3e84a1SEd Tanous     if (systemName != "system")
30517f3e84a1SEd Tanous     {
30527f3e84a1SEd Tanous         messages::resourceNotFound(asyncResp->res, "ComputerSystem",
30537f3e84a1SEd Tanous                                    systemName);
305422d268cbSEd Tanous         return;
305522d268cbSEd Tanous     }
305622d268cbSEd Tanous     clearDump(asyncResp, "System");
305722d268cbSEd Tanous }
305822d268cbSEd Tanous 
3059fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app)
3060fdd26906SClaire Weinan {
3061fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
3062fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogService)
3063fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
3064fdd26906SClaire Weinan             handleLogServicesDumpServiceGet, std::ref(app), "BMC"));
3065fdd26906SClaire Weinan }
3066fdd26906SClaire Weinan 
3067fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app)
3068fdd26906SClaire Weinan {
3069fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
3070fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntryCollection)
3071fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
3072fdd26906SClaire Weinan             handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC"));
3073c9bb6861Sraviteja-b }
3074c9bb6861Sraviteja-b 
30757e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app)
3076c9bb6861Sraviteja-b {
30777e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
30787e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
3079ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
3080fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
3081fdd26906SClaire Weinan             handleLogServicesDumpEntryGet, std::ref(app), "BMC"));
3082fdd26906SClaire Weinan 
30837e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
30847e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
3085ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
3086fdd26906SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
3087fdd26906SClaire Weinan             handleLogServicesDumpEntryDelete, std::ref(app), "BMC"));
3088c9bb6861Sraviteja-b }
3089c9bb6861Sraviteja-b 
3090168d1b1aSCarson Labrado inline void requestRoutesBMCDumpEntryDownload(App& app)
3091168d1b1aSCarson Labrado {
3092168d1b1aSCarson Labrado     BMCWEB_ROUTE(
3093168d1b1aSCarson Labrado         app,
30949e9d99daSRavi Teja         "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/attachment/")
3095168d1b1aSCarson Labrado         .privileges(redfish::privileges::getLogEntry)
3096168d1b1aSCarson Labrado         .methods(boost::beast::http::verb::get)(std::bind_front(
3097168d1b1aSCarson Labrado             handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC"));
3098168d1b1aSCarson Labrado }
3099168d1b1aSCarson Labrado 
31007e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app)
3101c9bb6861Sraviteja-b {
31020fda0f12SGeorge Liu     BMCWEB_ROUTE(
31030fda0f12SGeorge Liu         app,
31040fda0f12SGeorge Liu         "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
3105ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
31067e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
3107fdd26906SClaire Weinan             std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost,
3108fdd26906SClaire Weinan                             std::ref(app), "BMC"));
3109a43be80fSAsmitha Karunanithi }
3110a43be80fSAsmitha Karunanithi 
31117e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app)
311280319af1SAsmitha Karunanithi {
31130fda0f12SGeorge Liu     BMCWEB_ROUTE(
31140fda0f12SGeorge Liu         app,
31150fda0f12SGeorge Liu         "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/")
3116ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
3117fdd26906SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
3118fdd26906SClaire Weinan             handleLogServicesDumpClearLogPost, std::ref(app), "BMC"));
311945ca1b86SEd Tanous }
3120fdd26906SClaire Weinan 
3121168d1b1aSCarson Labrado inline void requestRoutesDBusEventLogEntryDownload(App& app)
3122168d1b1aSCarson Labrado {
3123168d1b1aSCarson Labrado     BMCWEB_ROUTE(
3124168d1b1aSCarson Labrado         app,
31259e9d99daSRavi Teja         "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/")
3126168d1b1aSCarson Labrado         .privileges(redfish::privileges::getLogEntry)
3127168d1b1aSCarson Labrado         .methods(boost::beast::http::verb::get)(std::bind_front(
3128168d1b1aSCarson Labrado             handleDBusEventLogEntryDownloadGet, std::ref(app), "System"));
3129168d1b1aSCarson Labrado }
3130168d1b1aSCarson Labrado 
3131fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app)
3132fdd26906SClaire Weinan {
3133fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/")
3134fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogService)
3135fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
3136fdd26906SClaire Weinan             handleLogServicesDumpServiceGet, std::ref(app), "FaultLog"));
3137fdd26906SClaire Weinan }
3138fdd26906SClaire Weinan 
3139fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app)
3140fdd26906SClaire Weinan {
3141fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/")
3142fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntryCollection)
3143fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(
3144fdd26906SClaire Weinan             std::bind_front(handleLogServicesDumpEntriesCollectionGet,
3145fdd26906SClaire Weinan                             std::ref(app), "FaultLog"));
3146fdd26906SClaire Weinan }
3147fdd26906SClaire Weinan 
3148fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app)
3149fdd26906SClaire Weinan {
3150fdd26906SClaire Weinan     BMCWEB_ROUTE(app,
3151fdd26906SClaire Weinan                  "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
3152fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntry)
3153fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
3154fdd26906SClaire Weinan             handleLogServicesDumpEntryGet, std::ref(app), "FaultLog"));
3155fdd26906SClaire Weinan 
3156fdd26906SClaire Weinan     BMCWEB_ROUTE(app,
3157fdd26906SClaire Weinan                  "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
3158fdd26906SClaire Weinan         .privileges(redfish::privileges::deleteLogEntry)
3159fdd26906SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
3160fdd26906SClaire Weinan             handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog"));
3161fdd26906SClaire Weinan }
3162fdd26906SClaire Weinan 
3163fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app)
3164fdd26906SClaire Weinan {
3165fdd26906SClaire Weinan     BMCWEB_ROUTE(
3166fdd26906SClaire Weinan         app,
3167fdd26906SClaire Weinan         "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/")
3168fdd26906SClaire Weinan         .privileges(redfish::privileges::postLogService)
3169fdd26906SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
3170fdd26906SClaire Weinan             handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog"));
31715cb1dd27SAsmitha Karunanithi }
31725cb1dd27SAsmitha Karunanithi 
31737e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app)
31745cb1dd27SAsmitha Karunanithi {
317522d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/")
3176ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
31776ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
317822d268cbSEd Tanous             handleLogServicesDumpServiceComputerSystemGet, std::ref(app)));
31795cb1dd27SAsmitha Karunanithi }
31805cb1dd27SAsmitha Karunanithi 
31817e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app)
31827e860f15SJohn Edward Broadbent {
318322d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/")
3184ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
318522d268cbSEd Tanous         .methods(boost::beast::http::verb::get)(std::bind_front(
318622d268cbSEd Tanous             handleLogServicesDumpEntriesCollectionComputerSystemGet,
318722d268cbSEd Tanous             std::ref(app)));
31885cb1dd27SAsmitha Karunanithi }
31895cb1dd27SAsmitha Karunanithi 
31907e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app)
31915cb1dd27SAsmitha Karunanithi {
31927e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
319322d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
3194ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
31956ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
319622d268cbSEd Tanous             handleLogServicesDumpEntryComputerSystemGet, std::ref(app)));
31978d1b46d7Szhanghch05 
31987e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
319922d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
3200ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
32016ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
320222d268cbSEd Tanous             handleLogServicesDumpEntryComputerSystemDelete, std::ref(app)));
32035cb1dd27SAsmitha Karunanithi }
3204c9bb6861Sraviteja-b 
32057e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app)
3206c9bb6861Sraviteja-b {
32070fda0f12SGeorge Liu     BMCWEB_ROUTE(
32080fda0f12SGeorge Liu         app,
320922d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
3210ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
321122d268cbSEd Tanous         .methods(boost::beast::http::verb::post)(std::bind_front(
321222d268cbSEd Tanous             handleLogServicesDumpCollectDiagnosticDataComputerSystemPost,
321322d268cbSEd Tanous             std::ref(app)));
3214a43be80fSAsmitha Karunanithi }
3215a43be80fSAsmitha Karunanithi 
32167e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app)
3217a43be80fSAsmitha Karunanithi {
32180fda0f12SGeorge Liu     BMCWEB_ROUTE(
32190fda0f12SGeorge Liu         app,
322022d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
3221ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
32226ab9ad54SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
322322d268cbSEd Tanous             handleLogServicesDumpClearLogComputerSystemPost, std::ref(app)));
3224013487e5Sraviteja-b }
3225013487e5Sraviteja-b 
32267e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app)
32271da66f75SEd Tanous {
32283946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
32293946028dSAppaRao Puli     // method for security reasons.
32301da66f75SEd Tanous     /**
32311da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
32321da66f75SEd Tanous      */
323322d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/")
3234ed398213SEd Tanous         // This is incorrect, should be:
3235ed398213SEd Tanous         //.privileges(redfish::privileges::getLogService)
3236432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
3237002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
3238002d39b4SEd Tanous             [&app](const crow::Request& req,
323922d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
324022d268cbSEd Tanous                    const std::string& systemName) {
32413ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
324245ca1b86SEd Tanous         {
324345ca1b86SEd Tanous             return;
324445ca1b86SEd Tanous         }
32457f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
32467f3e84a1SEd Tanous         {
32477f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
32487f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
32497f3e84a1SEd Tanous                                        systemName);
32507f3e84a1SEd Tanous             return;
32517f3e84a1SEd Tanous         }
325222d268cbSEd Tanous         if (systemName != "system")
325322d268cbSEd Tanous         {
325422d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
325522d268cbSEd Tanous                                        systemName);
325622d268cbSEd Tanous             return;
325722d268cbSEd Tanous         }
325822d268cbSEd Tanous 
32597e860f15SJohn Edward Broadbent         // Copy over the static data to include the entries added by
32607e860f15SJohn Edward Broadbent         // SubRoute
32610f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
3262424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
3263e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
32648e6c099aSJason M. Bills             "#LogService.v1_2_0.LogService";
32654f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
32664f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
326715b89725SV-Sanjana         asyncResp->res.jsonValue["Id"] = "Crashdump";
3268e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
3269e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
32707c8c4058STejas Patil 
32717c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
32722b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
32737c8c4058STejas Patil         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
32747c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
32757c8c4058STejas Patil             redfishDateTimeOffset.second;
32767c8c4058STejas Patil 
32771476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
3278ef4c65b7SEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
3279002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
32801476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog";
3281002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
32821476687dSEd Tanous                                 ["target"] =
32831476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData";
32847e860f15SJohn Edward Broadbent     });
32851da66f75SEd Tanous }
32861da66f75SEd Tanous 
32877e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app)
32885b61b5e8SJason M. Bills {
32890fda0f12SGeorge Liu     BMCWEB_ROUTE(
32900fda0f12SGeorge Liu         app,
329122d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/")
3292ed398213SEd Tanous         // This is incorrect, should be:
3293ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
3294432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
32957e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
329645ca1b86SEd Tanous             [&app](const crow::Request& req,
329722d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
329822d268cbSEd Tanous                    const std::string& systemName) {
32993ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
330045ca1b86SEd Tanous         {
330145ca1b86SEd Tanous             return;
330245ca1b86SEd Tanous         }
33037f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
33047f3e84a1SEd Tanous         {
33057f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
33067f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
33077f3e84a1SEd Tanous                                        systemName);
33087f3e84a1SEd Tanous             return;
33097f3e84a1SEd Tanous         }
331022d268cbSEd Tanous         if (systemName != "system")
331122d268cbSEd Tanous         {
331222d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
331322d268cbSEd Tanous                                        systemName);
331422d268cbSEd Tanous             return;
331522d268cbSEd Tanous         }
33165b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
33175e7e2dc5SEd Tanous             [asyncResp](const boost::system::error_code& ec,
3318cb13a392SEd Tanous                         const std::string&) {
33195b61b5e8SJason M. Bills             if (ec)
33205b61b5e8SJason M. Bills             {
33215b61b5e8SJason M. Bills                 messages::internalError(asyncResp->res);
33225b61b5e8SJason M. Bills                 return;
33235b61b5e8SJason M. Bills             }
33245b61b5e8SJason M. Bills             messages::success(asyncResp->res);
33255b61b5e8SJason M. Bills         },
3326002d39b4SEd Tanous             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
33277e860f15SJohn Edward Broadbent     });
33285b61b5e8SJason M. Bills }
33295b61b5e8SJason M. Bills 
33308d1b46d7Szhanghch05 static void
33318d1b46d7Szhanghch05     logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
33328d1b46d7Szhanghch05                       const std::string& logID, nlohmann::json& logEntryJson)
3333e855dd28SJason M. Bills {
3334043a0536SJohnathan Mantey     auto getStoredLogCallback =
3335b9d36b47SEd Tanous         [asyncResp, logID,
33365e7e2dc5SEd Tanous          &logEntryJson](const boost::system::error_code& ec,
3337b9d36b47SEd Tanous                         const dbus::utility::DBusPropertiesMap& params) {
3338e855dd28SJason M. Bills         if (ec)
3339e855dd28SJason M. Bills         {
334062598e31SEd Tanous             BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
33411ddcf01aSJason M. Bills             if (ec.value() ==
33421ddcf01aSJason M. Bills                 boost::system::linux_error::bad_request_descriptor)
33431ddcf01aSJason M. Bills             {
3344002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
33451ddcf01aSJason M. Bills             }
33461ddcf01aSJason M. Bills             else
33471ddcf01aSJason M. Bills             {
3348e855dd28SJason M. Bills                 messages::internalError(asyncResp->res);
33491ddcf01aSJason M. Bills             }
3350e855dd28SJason M. Bills             return;
3351e855dd28SJason M. Bills         }
3352043a0536SJohnathan Mantey 
3353043a0536SJohnathan Mantey         std::string timestamp{};
3354043a0536SJohnathan Mantey         std::string filename{};
3355043a0536SJohnathan Mantey         std::string logfile{};
33562c70f800SEd Tanous         parseCrashdumpParameters(params, filename, timestamp, logfile);
3357043a0536SJohnathan Mantey 
3358043a0536SJohnathan Mantey         if (filename.empty() || timestamp.empty())
3359e855dd28SJason M. Bills         {
33609db4ba25SJiaqing Zhao             messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
3361e855dd28SJason M. Bills             return;
3362e855dd28SJason M. Bills         }
3363e855dd28SJason M. Bills 
3364043a0536SJohnathan Mantey         std::string crashdumpURI =
3365e855dd28SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
3366043a0536SJohnathan Mantey             logID + "/" + filename;
336784afc48bSJason M. Bills         nlohmann::json::object_t logEntry;
33689c11a172SVijay Lobo         logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
3369ef4c65b7SEd Tanous         logEntry["@odata.id"] = boost::urls::format(
3370ef4c65b7SEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/{}",
3371ef4c65b7SEd Tanous             logID);
337284afc48bSJason M. Bills         logEntry["Name"] = "CPU Crashdump";
337384afc48bSJason M. Bills         logEntry["Id"] = logID;
337484afc48bSJason M. Bills         logEntry["EntryType"] = "Oem";
337584afc48bSJason M. Bills         logEntry["AdditionalDataURI"] = std::move(crashdumpURI);
337684afc48bSJason M. Bills         logEntry["DiagnosticDataType"] = "OEM";
337784afc48bSJason M. Bills         logEntry["OEMDiagnosticDataType"] = "PECICrashdump";
337884afc48bSJason M. Bills         logEntry["Created"] = std::move(timestamp);
33792b20ef6eSJason M. Bills 
33802b20ef6eSJason M. Bills         // If logEntryJson references an array of LogEntry resources
33812b20ef6eSJason M. Bills         // ('Members' list), then push this as a new entry, otherwise set it
33822b20ef6eSJason M. Bills         // directly
33832b20ef6eSJason M. Bills         if (logEntryJson.is_array())
33842b20ef6eSJason M. Bills         {
33852b20ef6eSJason M. Bills             logEntryJson.push_back(logEntry);
33862b20ef6eSJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
33872b20ef6eSJason M. Bills                 logEntryJson.size();
33882b20ef6eSJason M. Bills         }
33892b20ef6eSJason M. Bills         else
33902b20ef6eSJason M. Bills         {
3391d405bb51SJason M. Bills             logEntryJson.update(logEntry);
33922b20ef6eSJason M. Bills         }
3393e855dd28SJason M. Bills     };
3394d1bde9e5SKrzysztof Grobelny     sdbusplus::asio::getAllProperties(
3395d1bde9e5SKrzysztof Grobelny         *crow::connections::systemBus, crashdumpObject,
3396d1bde9e5SKrzysztof Grobelny         crashdumpPath + std::string("/") + logID, crashdumpInterface,
3397d1bde9e5SKrzysztof Grobelny         std::move(getStoredLogCallback));
3398e855dd28SJason M. Bills }
3399e855dd28SJason M. Bills 
34007e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app)
34011da66f75SEd Tanous {
34023946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
34033946028dSAppaRao Puli     // method for security reasons.
34041da66f75SEd Tanous     /**
34051da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
34061da66f75SEd Tanous      */
34077e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
340822d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/")
3409ed398213SEd Tanous         // This is incorrect, should be.
3410ed398213SEd Tanous         //.privileges(redfish::privileges::postLogEntryCollection)
3411432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
3412002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
3413002d39b4SEd Tanous             [&app](const crow::Request& req,
341422d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
341522d268cbSEd Tanous                    const std::string& systemName) {
34163ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
341745ca1b86SEd Tanous         {
341845ca1b86SEd Tanous             return;
341945ca1b86SEd Tanous         }
34207f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
34217f3e84a1SEd Tanous         {
34227f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
34237f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
34247f3e84a1SEd Tanous                                        systemName);
34257f3e84a1SEd Tanous             return;
34267f3e84a1SEd Tanous         }
342722d268cbSEd Tanous         if (systemName != "system")
342822d268cbSEd Tanous         {
342922d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
343022d268cbSEd Tanous                                        systemName);
343122d268cbSEd Tanous             return;
343222d268cbSEd Tanous         }
343322d268cbSEd Tanous 
34347a1dbc48SGeorge Liu         constexpr std::array<std::string_view, 1> interfaces = {
34357a1dbc48SGeorge Liu             crashdumpInterface};
34367a1dbc48SGeorge Liu         dbus::utility::getSubTreePaths(
34377a1dbc48SGeorge Liu             "/", 0, interfaces,
34387a1dbc48SGeorge Liu             [asyncResp](const boost::system::error_code& ec,
34392b20ef6eSJason M. Bills                         const std::vector<std::string>& resp) {
34401da66f75SEd Tanous             if (ec)
34411da66f75SEd Tanous             {
34421da66f75SEd Tanous                 if (ec.value() !=
34431da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
34441da66f75SEd Tanous                 {
344562598e31SEd Tanous                     BMCWEB_LOG_DEBUG("failed to get entries ec: {}",
344662598e31SEd Tanous                                      ec.message());
3447f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
34481da66f75SEd Tanous                     return;
34491da66f75SEd Tanous                 }
34501da66f75SEd Tanous             }
3451e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
34521da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
34530f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
3454424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
3455002d39b4SEd Tanous             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
3456e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
3457424c4176SJason M. Bills                 "Collection of Crashdump Entries";
3458002d39b4SEd Tanous             asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3459a2dd60a6SBrandon Kim             asyncResp->res.jsonValue["Members@odata.count"] = 0;
34602b20ef6eSJason M. Bills 
34612b20ef6eSJason M. Bills             for (const std::string& path : resp)
34621da66f75SEd Tanous             {
34632b20ef6eSJason M. Bills                 const sdbusplus::message::object_path objPath(path);
3464e855dd28SJason M. Bills                 // Get the log ID
34652b20ef6eSJason M. Bills                 std::string logID = objPath.filename();
34662b20ef6eSJason M. Bills                 if (logID.empty())
34671da66f75SEd Tanous                 {
3468e855dd28SJason M. Bills                     continue;
34691da66f75SEd Tanous                 }
3470e855dd28SJason M. Bills                 // Add the log entry to the array
34712b20ef6eSJason M. Bills                 logCrashdumpEntry(asyncResp, logID,
34722b20ef6eSJason M. Bills                                   asyncResp->res.jsonValue["Members"]);
34731da66f75SEd Tanous             }
34747a1dbc48SGeorge Liu         });
34757e860f15SJohn Edward Broadbent     });
34761da66f75SEd Tanous }
34771da66f75SEd Tanous 
34787e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app)
34791da66f75SEd Tanous {
34803946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
34813946028dSAppaRao Puli     // method for security reasons.
34821da66f75SEd Tanous 
34837e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
348422d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/")
3485ed398213SEd Tanous         // this is incorrect, should be
3486ed398213SEd Tanous         // .privileges(redfish::privileges::getLogEntry)
3487432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
34887e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
348945ca1b86SEd Tanous             [&app](const crow::Request& req,
34907e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
349122d268cbSEd Tanous                    const std::string& systemName, const std::string& param) {
34923ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
349345ca1b86SEd Tanous         {
349445ca1b86SEd Tanous             return;
349545ca1b86SEd Tanous         }
34967f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
34977f3e84a1SEd Tanous         {
34987f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
34997f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
35007f3e84a1SEd Tanous                                        systemName);
35017f3e84a1SEd Tanous             return;
35027f3e84a1SEd Tanous         }
350322d268cbSEd Tanous         if (systemName != "system")
350422d268cbSEd Tanous         {
350522d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
350622d268cbSEd Tanous                                        systemName);
350722d268cbSEd Tanous             return;
350822d268cbSEd Tanous         }
35097e860f15SJohn Edward Broadbent         const std::string& logID = param;
3510e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
35117e860f15SJohn Edward Broadbent     });
3512e855dd28SJason M. Bills }
3513e855dd28SJason M. Bills 
35147e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app)
3515e855dd28SJason M. Bills {
35163946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
35173946028dSAppaRao Puli     // method for security reasons.
35187e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
35197e860f15SJohn Edward Broadbent         app,
352022d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/")
3521ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
35227e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
3523a4ce114aSNan Zhou             [](const crow::Request& req,
35247e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
352522d268cbSEd Tanous                const std::string& systemName, const std::string& logID,
352622d268cbSEd Tanous                const std::string& fileName) {
35272a9beeedSShounak Mitra         // Do not call getRedfishRoute here since the crashdump file is not a
35282a9beeedSShounak Mitra         // Redfish resource.
352922d268cbSEd Tanous 
35307f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
35317f3e84a1SEd Tanous         {
35327f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
35337f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
35347f3e84a1SEd Tanous                                        systemName);
35357f3e84a1SEd Tanous             return;
35367f3e84a1SEd Tanous         }
353722d268cbSEd Tanous         if (systemName != "system")
353822d268cbSEd Tanous         {
353922d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
354022d268cbSEd Tanous                                        systemName);
354122d268cbSEd Tanous             return;
354222d268cbSEd Tanous         }
354322d268cbSEd Tanous 
3544043a0536SJohnathan Mantey         auto getStoredLogCallback =
354539662a3bSEd Tanous             [asyncResp, logID, fileName, url(boost::urls::url(req.url()))](
35465e7e2dc5SEd Tanous                 const boost::system::error_code& ec,
3547002d39b4SEd Tanous                 const std::vector<
3548002d39b4SEd Tanous                     std::pair<std::string, dbus::utility::DbusVariantType>>&
35497e860f15SJohn Edward Broadbent                     resp) {
35501da66f75SEd Tanous             if (ec)
35511da66f75SEd Tanous             {
355262598e31SEd Tanous                 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
3553f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
35541da66f75SEd Tanous                 return;
35551da66f75SEd Tanous             }
3556e855dd28SJason M. Bills 
3557043a0536SJohnathan Mantey             std::string dbusFilename{};
3558043a0536SJohnathan Mantey             std::string dbusTimestamp{};
3559043a0536SJohnathan Mantey             std::string dbusFilepath{};
3560043a0536SJohnathan Mantey 
3561002d39b4SEd Tanous             parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
3562002d39b4SEd Tanous                                      dbusFilepath);
3563043a0536SJohnathan Mantey 
3564043a0536SJohnathan Mantey             if (dbusFilename.empty() || dbusTimestamp.empty() ||
3565043a0536SJohnathan Mantey                 dbusFilepath.empty())
35661da66f75SEd Tanous             {
35679db4ba25SJiaqing Zhao                 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
35681da66f75SEd Tanous                 return;
35691da66f75SEd Tanous             }
3570e855dd28SJason M. Bills 
3571043a0536SJohnathan Mantey             // Verify the file name parameter is correct
3572043a0536SJohnathan Mantey             if (fileName != dbusFilename)
3573043a0536SJohnathan Mantey             {
35749db4ba25SJiaqing Zhao                 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
3575043a0536SJohnathan Mantey                 return;
3576043a0536SJohnathan Mantey             }
3577043a0536SJohnathan Mantey 
357827b0cf90SEd Tanous             if (!asyncResp->res.openFile(dbusFilepath))
3579043a0536SJohnathan Mantey             {
35809db4ba25SJiaqing Zhao                 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
3581043a0536SJohnathan Mantey                 return;
3582043a0536SJohnathan Mantey             }
3583043a0536SJohnathan Mantey 
35847e860f15SJohn Edward Broadbent             // Configure this to be a file download when accessed
35857e860f15SJohn Edward Broadbent             // from a browser
3586d9f6c621SEd Tanous             asyncResp->res.addHeader(
3587d9f6c621SEd Tanous                 boost::beast::http::field::content_disposition, "attachment");
35881da66f75SEd Tanous         };
3589d1bde9e5SKrzysztof Grobelny         sdbusplus::asio::getAllProperties(
3590d1bde9e5SKrzysztof Grobelny             *crow::connections::systemBus, crashdumpObject,
3591d1bde9e5SKrzysztof Grobelny             crashdumpPath + std::string("/") + logID, crashdumpInterface,
3592d1bde9e5SKrzysztof Grobelny             std::move(getStoredLogCallback));
35937e860f15SJohn Edward Broadbent     });
35941da66f75SEd Tanous }
35951da66f75SEd Tanous 
3596c5a4c82aSJason M. Bills enum class OEMDiagnosticType
3597c5a4c82aSJason M. Bills {
3598c5a4c82aSJason M. Bills     onDemand,
3599c5a4c82aSJason M. Bills     telemetry,
3600c5a4c82aSJason M. Bills     invalid,
3601c5a4c82aSJason M. Bills };
3602c5a4c82aSJason M. Bills 
360326ccae32SEd Tanous inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr)
3604c5a4c82aSJason M. Bills {
3605c5a4c82aSJason M. Bills     if (oemDiagStr == "OnDemand")
3606c5a4c82aSJason M. Bills     {
3607c5a4c82aSJason M. Bills         return OEMDiagnosticType::onDemand;
3608c5a4c82aSJason M. Bills     }
3609c5a4c82aSJason M. Bills     if (oemDiagStr == "Telemetry")
3610c5a4c82aSJason M. Bills     {
3611c5a4c82aSJason M. Bills         return OEMDiagnosticType::telemetry;
3612c5a4c82aSJason M. Bills     }
3613c5a4c82aSJason M. Bills 
3614c5a4c82aSJason M. Bills     return OEMDiagnosticType::invalid;
3615c5a4c82aSJason M. Bills }
3616c5a4c82aSJason M. Bills 
36177e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app)
36181da66f75SEd Tanous {
36193946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
36203946028dSAppaRao Puli     // method for security reasons.
36210fda0f12SGeorge Liu     BMCWEB_ROUTE(
36220fda0f12SGeorge Liu         app,
362322d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
3624ed398213SEd Tanous         // The below is incorrect;  Should be ConfigureManager
3625ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
3626432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
3627002d39b4SEd Tanous         .methods(boost::beast::http::verb::post)(
3628002d39b4SEd Tanous             [&app](const crow::Request& req,
362922d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
363022d268cbSEd Tanous                    const std::string& systemName) {
36313ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
363245ca1b86SEd Tanous         {
363345ca1b86SEd Tanous             return;
363445ca1b86SEd Tanous         }
363522d268cbSEd Tanous 
36367f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
36377f3e84a1SEd Tanous         {
36387f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
36397f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
36407f3e84a1SEd Tanous                                        systemName);
36417f3e84a1SEd Tanous             return;
36427f3e84a1SEd Tanous         }
364322d268cbSEd Tanous         if (systemName != "system")
364422d268cbSEd Tanous         {
364522d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
364622d268cbSEd Tanous                                        systemName);
364722d268cbSEd Tanous             return;
364822d268cbSEd Tanous         }
364922d268cbSEd Tanous 
36508e6c099aSJason M. Bills         std::string diagnosticDataType;
36518e6c099aSJason M. Bills         std::string oemDiagnosticDataType;
365215ed6780SWilly Tu         if (!redfish::json_util::readJsonAction(
3653002d39b4SEd Tanous                 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
3654002d39b4SEd Tanous                 "OEMDiagnosticDataType", oemDiagnosticDataType))
36558e6c099aSJason M. Bills         {
36568e6c099aSJason M. Bills             return;
36578e6c099aSJason M. Bills         }
36588e6c099aSJason M. Bills 
36598e6c099aSJason M. Bills         if (diagnosticDataType != "OEM")
36608e6c099aSJason M. Bills         {
366162598e31SEd Tanous             BMCWEB_LOG_ERROR(
366262598e31SEd Tanous                 "Only OEM DiagnosticDataType supported for Crashdump");
36638e6c099aSJason M. Bills             messages::actionParameterValueFormatError(
36648e6c099aSJason M. Bills                 asyncResp->res, diagnosticDataType, "DiagnosticDataType",
36658e6c099aSJason M. Bills                 "CollectDiagnosticData");
36668e6c099aSJason M. Bills             return;
36678e6c099aSJason M. Bills         }
36688e6c099aSJason M. Bills 
3669c5a4c82aSJason M. Bills         OEMDiagnosticType oemDiagType =
3670c5a4c82aSJason M. Bills             getOEMDiagnosticType(oemDiagnosticDataType);
3671c5a4c82aSJason M. Bills 
3672c5a4c82aSJason M. Bills         std::string iface;
3673c5a4c82aSJason M. Bills         std::string method;
3674c5a4c82aSJason M. Bills         std::string taskMatchStr;
3675c5a4c82aSJason M. Bills         if (oemDiagType == OEMDiagnosticType::onDemand)
3676c5a4c82aSJason M. Bills         {
3677c5a4c82aSJason M. Bills             iface = crashdumpOnDemandInterface;
3678c5a4c82aSJason M. Bills             method = "GenerateOnDemandLog";
3679c5a4c82aSJason M. Bills             taskMatchStr = "type='signal',"
3680c5a4c82aSJason M. Bills                            "interface='org.freedesktop.DBus.Properties',"
3681c5a4c82aSJason M. Bills                            "member='PropertiesChanged',"
3682c5a4c82aSJason M. Bills                            "arg0namespace='com.intel.crashdump'";
3683c5a4c82aSJason M. Bills         }
3684c5a4c82aSJason M. Bills         else if (oemDiagType == OEMDiagnosticType::telemetry)
3685c5a4c82aSJason M. Bills         {
3686c5a4c82aSJason M. Bills             iface = crashdumpTelemetryInterface;
3687c5a4c82aSJason M. Bills             method = "GenerateTelemetryLog";
3688c5a4c82aSJason M. Bills             taskMatchStr = "type='signal',"
3689c5a4c82aSJason M. Bills                            "interface='org.freedesktop.DBus.Properties',"
3690c5a4c82aSJason M. Bills                            "member='PropertiesChanged',"
3691c5a4c82aSJason M. Bills                            "arg0namespace='com.intel.crashdump'";
3692c5a4c82aSJason M. Bills         }
3693c5a4c82aSJason M. Bills         else
3694c5a4c82aSJason M. Bills         {
369562598e31SEd Tanous             BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}",
369662598e31SEd Tanous                              oemDiagnosticDataType);
3697c5a4c82aSJason M. Bills             messages::actionParameterValueFormatError(
3698002d39b4SEd Tanous                 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType",
3699002d39b4SEd Tanous                 "CollectDiagnosticData");
3700c5a4c82aSJason M. Bills             return;
3701c5a4c82aSJason M. Bills         }
3702c5a4c82aSJason M. Bills 
3703c5a4c82aSJason M. Bills         auto collectCrashdumpCallback =
3704c5a4c82aSJason M. Bills             [asyncResp, payload(task::Payload(req)),
37055e7e2dc5SEd Tanous              taskMatchStr](const boost::system::error_code& ec,
370698be3e39SEd Tanous                            const std::string&) mutable {
37071da66f75SEd Tanous             if (ec)
37081da66f75SEd Tanous             {
3709002d39b4SEd Tanous                 if (ec.value() == boost::system::errc::operation_not_supported)
37101da66f75SEd Tanous                 {
3711f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
37121da66f75SEd Tanous                 }
37134363d3b2SJason M. Bills                 else if (ec.value() ==
37144363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
37154363d3b2SJason M. Bills                 {
3716002d39b4SEd Tanous                     messages::serviceTemporarilyUnavailable(asyncResp->res,
3717002d39b4SEd Tanous                                                             "60");
37184363d3b2SJason M. Bills                 }
37191da66f75SEd Tanous                 else
37201da66f75SEd Tanous                 {
3721f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
37221da66f75SEd Tanous                 }
37231da66f75SEd Tanous                 return;
37241da66f75SEd Tanous             }
3725002d39b4SEd Tanous             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
37268b24275dSEd Tanous                 [](const boost::system::error_code& ec2, sdbusplus::message_t&,
3727002d39b4SEd Tanous                    const std::shared_ptr<task::TaskData>& taskData) {
37288b24275dSEd Tanous                 if (!ec2)
372966afe4faSJames Feist                 {
3730002d39b4SEd Tanous                     taskData->messages.emplace_back(messages::taskCompletedOK(
3731e5d5006bSJames Feist                         std::to_string(taskData->index)));
3732831d6b09SJames Feist                     taskData->state = "Completed";
373366afe4faSJames Feist                 }
373432898ceaSJames Feist                 return task::completed;
373566afe4faSJames Feist             },
3736c5a4c82aSJason M. Bills                 taskMatchStr);
3737c5a4c82aSJason M. Bills 
373846229577SJames Feist             task->startTimer(std::chrono::minutes(5));
373946229577SJames Feist             task->populateResp(asyncResp->res);
374098be3e39SEd Tanous             task->payload.emplace(std::move(payload));
37411da66f75SEd Tanous         };
37428e6c099aSJason M. Bills 
37431da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
3744002d39b4SEd Tanous             std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath,
3745002d39b4SEd Tanous             iface, method);
37467e860f15SJohn Edward Broadbent     });
37476eda7685SKenny L. Ku }
37486eda7685SKenny L. Ku 
3749cb92c03bSAndrew Geissler /**
3750cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3751cb92c03bSAndrew Geissler  */
37527e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app)
3753cb92c03bSAndrew Geissler {
3754cb92c03bSAndrew Geissler     /**
3755cb92c03bSAndrew Geissler      * Function handles POST method request.
3756cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
3757cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
3758cb92c03bSAndrew Geissler      */
37597e860f15SJohn Edward Broadbent 
37600fda0f12SGeorge Liu     BMCWEB_ROUTE(
37610fda0f12SGeorge Liu         app,
376222d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
3763ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
37647e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
376545ca1b86SEd Tanous             [&app](const crow::Request& req,
376622d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
376722d268cbSEd Tanous                    const std::string& systemName) {
37683ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
376945ca1b86SEd Tanous         {
377045ca1b86SEd Tanous             return;
377145ca1b86SEd Tanous         }
37727f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
37737f3e84a1SEd Tanous         {
37747f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
37757f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
37767f3e84a1SEd Tanous                                        systemName);
37777f3e84a1SEd Tanous             return;
37787f3e84a1SEd Tanous         }
377922d268cbSEd Tanous         if (systemName != "system")
378022d268cbSEd Tanous         {
378122d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
378222d268cbSEd Tanous                                        systemName);
378322d268cbSEd Tanous             return;
378422d268cbSEd Tanous         }
378562598e31SEd Tanous         BMCWEB_LOG_DEBUG("Do delete all entries.");
3786cb92c03bSAndrew Geissler 
3787cb92c03bSAndrew Geissler         // Process response from Logging service.
37885e7e2dc5SEd Tanous         auto respHandler = [asyncResp](const boost::system::error_code& ec) {
378962598e31SEd Tanous             BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done");
3790cb92c03bSAndrew Geissler             if (ec)
3791cb92c03bSAndrew Geissler             {
3792cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
379362598e31SEd Tanous                 BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec);
3794cb92c03bSAndrew Geissler                 asyncResp->res.result(
3795cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
3796cb92c03bSAndrew Geissler                 return;
3797cb92c03bSAndrew Geissler             }
3798cb92c03bSAndrew Geissler 
3799002d39b4SEd Tanous             asyncResp->res.result(boost::beast::http::status::no_content);
3800cb92c03bSAndrew Geissler         };
3801cb92c03bSAndrew Geissler 
3802cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
3803cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
38042c70f800SEd Tanous             respHandler, "xyz.openbmc_project.Logging",
3805cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
3806cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
38077e860f15SJohn Edward Broadbent     });
3808cb92c03bSAndrew Geissler }
3809a3316fc6SZhikuiRen 
3810a3316fc6SZhikuiRen /****************************************************
3811a3316fc6SZhikuiRen  * Redfish PostCode interfaces
3812a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
3813a3316fc6SZhikuiRen  ******************************************************/
38147e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app)
3815a3316fc6SZhikuiRen {
381622d268cbSEd Tanous     BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/")
3817ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
3818002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
3819002d39b4SEd Tanous             [&app](const crow::Request& req,
382022d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
382122d268cbSEd Tanous                    const std::string& systemName) {
38223ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
382345ca1b86SEd Tanous         {
382445ca1b86SEd Tanous             return;
382545ca1b86SEd Tanous         }
38267f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
38277f3e84a1SEd Tanous         {
38287f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
38297f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
38307f3e84a1SEd Tanous                                        systemName);
38317f3e84a1SEd Tanous             return;
38327f3e84a1SEd Tanous         }
383322d268cbSEd Tanous         if (systemName != "system")
383422d268cbSEd Tanous         {
383522d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
383622d268cbSEd Tanous                                        systemName);
383722d268cbSEd Tanous             return;
383822d268cbSEd Tanous         }
38391476687dSEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
38401476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/PostCodes";
38411476687dSEd Tanous         asyncResp->res.jsonValue["@odata.type"] =
3842b25644a1SJanet Adkins             "#LogService.v1_2_0.LogService";
38431476687dSEd Tanous         asyncResp->res.jsonValue["Name"] = "POST Code Log Service";
38441476687dSEd Tanous         asyncResp->res.jsonValue["Description"] = "POST Code Log Service";
3845ed34a4adSEd Tanous         asyncResp->res.jsonValue["Id"] = "PostCodes";
38461476687dSEd Tanous         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
38471476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
38481476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
38497c8c4058STejas Patil 
38507c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
38512b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
38520fda0f12SGeorge Liu         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
38537c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
38547c8c4058STejas Patil             redfishDateTimeOffset.second;
38557c8c4058STejas Patil 
3856a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
38577e860f15SJohn Edward Broadbent             {"target",
38580fda0f12SGeorge Liu              "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}};
38597e860f15SJohn Edward Broadbent     });
3860a3316fc6SZhikuiRen }
3861a3316fc6SZhikuiRen 
38627e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app)
3863a3316fc6SZhikuiRen {
38640fda0f12SGeorge Liu     BMCWEB_ROUTE(
38650fda0f12SGeorge Liu         app,
386622d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/")
3867ed398213SEd Tanous         // The following privilege is incorrect;  It should be ConfigureManager
3868ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
3869432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
38707e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
387145ca1b86SEd Tanous             [&app](const crow::Request& req,
387222d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
387322d268cbSEd Tanous                    const std::string& systemName) {
38743ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
387545ca1b86SEd Tanous         {
387645ca1b86SEd Tanous             return;
387745ca1b86SEd Tanous         }
38787f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
38797f3e84a1SEd Tanous         {
38807f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
38817f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
38827f3e84a1SEd Tanous                                        systemName);
38837f3e84a1SEd Tanous             return;
38847f3e84a1SEd Tanous         }
388522d268cbSEd Tanous         if (systemName != "system")
388622d268cbSEd Tanous         {
388722d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
388822d268cbSEd Tanous                                        systemName);
388922d268cbSEd Tanous             return;
389022d268cbSEd Tanous         }
389162598e31SEd Tanous         BMCWEB_LOG_DEBUG("Do delete all postcodes entries.");
3892a3316fc6SZhikuiRen 
3893a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
3894a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
38955e7e2dc5SEd Tanous             [asyncResp](const boost::system::error_code& ec) {
3896a3316fc6SZhikuiRen             if (ec)
3897a3316fc6SZhikuiRen             {
3898a3316fc6SZhikuiRen                 // TODO Handle for specific error code
389962598e31SEd Tanous                 BMCWEB_LOG_ERROR("doClearPostCodes resp_handler got error {}",
390062598e31SEd Tanous                                  ec);
3901002d39b4SEd Tanous                 asyncResp->res.result(
3902002d39b4SEd Tanous                     boost::beast::http::status::internal_server_error);
3903a3316fc6SZhikuiRen                 messages::internalError(asyncResp->res);
3904a3316fc6SZhikuiRen                 return;
3905a3316fc6SZhikuiRen             }
390618fc70c0STony Lee             messages::success(asyncResp->res);
3907a3316fc6SZhikuiRen         },
390815124765SJonathan Doman             "xyz.openbmc_project.State.Boot.PostCode0",
390915124765SJonathan Doman             "/xyz/openbmc_project/State/Boot/PostCode0",
3910a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
39117e860f15SJohn Edward Broadbent     });
3912a3316fc6SZhikuiRen }
3913a3316fc6SZhikuiRen 
39146f284d24SJiaqing Zhao /**
39156f284d24SJiaqing Zhao  * @brief Parse post code ID and get the current value and index value
39166f284d24SJiaqing Zhao  *        eg: postCodeID=B1-2, currentValue=1, index=2
39176f284d24SJiaqing Zhao  *
39186f284d24SJiaqing Zhao  * @param[in]  postCodeID     Post Code ID
39196f284d24SJiaqing Zhao  * @param[out] currentValue   Current value
39206f284d24SJiaqing Zhao  * @param[out] index          Index value
39216f284d24SJiaqing Zhao  *
39226f284d24SJiaqing Zhao  * @return bool true if the parsing is successful, false the parsing fails
39236f284d24SJiaqing Zhao  */
39246f056f24SEd Tanous inline bool parsePostCode(std::string_view postCodeID, uint64_t& currentValue,
3925df254f2cSEd Tanous                           uint16_t& index)
39266f284d24SJiaqing Zhao {
39276f284d24SJiaqing Zhao     std::vector<std::string> split;
392850ebd4afSEd Tanous     bmcweb::split(split, postCodeID, '-');
39296f056f24SEd Tanous     if (split.size() != 2)
39306f056f24SEd Tanous     {
39316f056f24SEd Tanous         return false;
39326f056f24SEd Tanous     }
39336f056f24SEd Tanous     std::string_view postCodeNumber = split[0];
39346f056f24SEd Tanous     if (postCodeNumber.size() < 2)
39356f056f24SEd Tanous     {
39366f056f24SEd Tanous         return false;
39376f056f24SEd Tanous     }
39386f056f24SEd Tanous     if (postCodeNumber[0] != 'B')
39396f056f24SEd Tanous     {
39406f056f24SEd Tanous         return false;
39416f056f24SEd Tanous     }
39426f056f24SEd Tanous     postCodeNumber.remove_prefix(1);
39436f056f24SEd Tanous     auto [ptrIndex, ecIndex] = std::from_chars(postCodeNumber.begin(),
39446f056f24SEd Tanous                                                postCodeNumber.end(), index);
39456f056f24SEd Tanous     if (ptrIndex != postCodeNumber.end() || ecIndex != std::errc())
39466f284d24SJiaqing Zhao     {
39476f284d24SJiaqing Zhao         return false;
39486f284d24SJiaqing Zhao     }
39496f284d24SJiaqing Zhao 
39506f056f24SEd Tanous     std::string_view postCodeIndex = split[1];
39516f284d24SJiaqing Zhao 
39526f056f24SEd Tanous     auto [ptrValue, ecValue] = std::from_chars(
39536f056f24SEd Tanous         postCodeIndex.begin(), postCodeIndex.end(), currentValue);
39546f284d24SJiaqing Zhao 
39556f056f24SEd Tanous     return ptrValue == postCodeIndex.end() && ecValue == std::errc();
39566f284d24SJiaqing Zhao }
39576f284d24SJiaqing Zhao 
39586f284d24SJiaqing Zhao static bool fillPostCodeEntry(
3959ac106bf6SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
39606c9a279eSManojkiran Eda     const boost::container::flat_map<
39616c9a279eSManojkiran Eda         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
3962a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
3963a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
3964a3316fc6SZhikuiRen {
3965a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
3966fffb8c1fSEd Tanous     const registries::Message* message =
3967fffb8c1fSEd Tanous         registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
3968dc8cfa66SEd Tanous     if (message == nullptr)
3969dc8cfa66SEd Tanous     {
3970dc8cfa66SEd Tanous         BMCWEB_LOG_ERROR("Couldn't find known message?");
3971dc8cfa66SEd Tanous         return false;
3972dc8cfa66SEd Tanous     }
3973a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
3974a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
39756c9a279eSManojkiran Eda     for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
39766c9a279eSManojkiran Eda              code : postcode)
3977a3316fc6SZhikuiRen     {
3978a3316fc6SZhikuiRen         currentCodeIndex++;
3979a3316fc6SZhikuiRen         std::string postcodeEntryID =
3980a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
3981a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
3982a3316fc6SZhikuiRen 
3983a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
3984a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
3985a3316fc6SZhikuiRen 
3986a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
3987a3316fc6SZhikuiRen         { // already incremented
3988a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
3989a3316fc6SZhikuiRen         }
3990a3316fc6SZhikuiRen         else
3991a3316fc6SZhikuiRen         {
3992a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
3993a3316fc6SZhikuiRen         }
3994a3316fc6SZhikuiRen 
3995a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
3996a3316fc6SZhikuiRen         // not fall between top and skip
3997a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
3998a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
3999a3316fc6SZhikuiRen         {
4000a3316fc6SZhikuiRen             continue;
4001a3316fc6SZhikuiRen         }
4002a3316fc6SZhikuiRen 
40034e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
4004a3316fc6SZhikuiRen         // currentIndex
4005a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
4006a3316fc6SZhikuiRen         {
4007a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
4008a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
4009a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
4010a3316fc6SZhikuiRen             continue;
4011a3316fc6SZhikuiRen         }
4012a3316fc6SZhikuiRen 
4013a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
4014a3316fc6SZhikuiRen         // index
4015a3316fc6SZhikuiRen 
4016a3316fc6SZhikuiRen         // Get the Created time from the timestamp
4017a3316fc6SZhikuiRen         std::string entryTimeStr;
40182a025611SKonstantin Aladyshev         entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch);
4019a3316fc6SZhikuiRen 
4020a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
4021a3316fc6SZhikuiRen         std::ostringstream hexCode;
4022a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
40236c9a279eSManojkiran Eda                 << std::get<0>(code.second);
4024a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
4025a3316fc6SZhikuiRen         // Set Fixed -Point Notation
4026a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
4027a3316fc6SZhikuiRen         // Set precision to 4 digits
4028a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
4029a3316fc6SZhikuiRen         // Add double to stream
4030a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
4031a3316fc6SZhikuiRen 
40321e6deaf6SEd Tanous         std::string bootIndexStr = std::to_string(bootIndex);
40331e6deaf6SEd Tanous         std::string timeOffsetString = timeOffsetStr.str();
40341e6deaf6SEd Tanous         std::string hexCodeStr = hexCode.str();
4035a3316fc6SZhikuiRen 
40361e6deaf6SEd Tanous         std::array<std::string_view, 3> messageArgs = {
40371e6deaf6SEd Tanous             bootIndexStr, timeOffsetString, hexCodeStr};
40381e6deaf6SEd Tanous 
40391e6deaf6SEd Tanous         std::string msg =
40401e6deaf6SEd Tanous             redfish::registries::fillMessageArgs(messageArgs, message->message);
40411e6deaf6SEd Tanous         if (msg.empty())
4042a3316fc6SZhikuiRen         {
40431e6deaf6SEd Tanous             messages::internalError(asyncResp->res);
40441e6deaf6SEd Tanous             return false;
4045a3316fc6SZhikuiRen         }
4046a3316fc6SZhikuiRen 
4047d4342a92STim Lee         // Get Severity template from message registry
4048d4342a92STim Lee         std::string severity;
4049d4342a92STim Lee         if (message != nullptr)
4050d4342a92STim Lee         {
40515f2b84eeSEd Tanous             severity = message->messageSeverity;
4052d4342a92STim Lee         }
4053d4342a92STim Lee 
40546f284d24SJiaqing Zhao         // Format entry
40556f284d24SJiaqing Zhao         nlohmann::json::object_t bmcLogEntry;
40569c11a172SVijay Lobo         bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
4057ef4c65b7SEd Tanous         bmcLogEntry["@odata.id"] = boost::urls::format(
4058ef4c65b7SEd Tanous             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/{}",
4059ef4c65b7SEd Tanous             postcodeEntryID);
406084afc48bSJason M. Bills         bmcLogEntry["Name"] = "POST Code Log Entry";
406184afc48bSJason M. Bills         bmcLogEntry["Id"] = postcodeEntryID;
406284afc48bSJason M. Bills         bmcLogEntry["Message"] = std::move(msg);
406384afc48bSJason M. Bills         bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode";
40641e6deaf6SEd Tanous         bmcLogEntry["MessageArgs"] = messageArgs;
406584afc48bSJason M. Bills         bmcLogEntry["EntryType"] = "Event";
406684afc48bSJason M. Bills         bmcLogEntry["Severity"] = std::move(severity);
406784afc48bSJason M. Bills         bmcLogEntry["Created"] = entryTimeStr;
4068647b3cdcSGeorge Liu         if (!std::get<std::vector<uint8_t>>(code.second).empty())
4069647b3cdcSGeorge Liu         {
4070647b3cdcSGeorge Liu             bmcLogEntry["AdditionalDataURI"] =
4071647b3cdcSGeorge Liu                 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
4072647b3cdcSGeorge Liu                 postcodeEntryID + "/attachment";
4073647b3cdcSGeorge Liu         }
40746f284d24SJiaqing Zhao 
40756f284d24SJiaqing Zhao         // codeIndex is only specified when querying single entry, return only
40766f284d24SJiaqing Zhao         // that entry in this case
40776f284d24SJiaqing Zhao         if (codeIndex != 0)
40786f284d24SJiaqing Zhao         {
4079ac106bf6SEd Tanous             asyncResp->res.jsonValue.update(bmcLogEntry);
40806f284d24SJiaqing Zhao             return true;
4081a3316fc6SZhikuiRen         }
40826f284d24SJiaqing Zhao 
4083ac106bf6SEd Tanous         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
4084b2ba3072SPatrick Williams         logEntryArray.emplace_back(std::move(bmcLogEntry));
40856f284d24SJiaqing Zhao     }
40866f284d24SJiaqing Zhao 
40876f284d24SJiaqing Zhao     // Return value is always false when querying multiple entries
40886f284d24SJiaqing Zhao     return false;
4089a3316fc6SZhikuiRen }
4090a3316fc6SZhikuiRen 
4091ac106bf6SEd Tanous static void
4092ac106bf6SEd Tanous     getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
40936f284d24SJiaqing Zhao                         const std::string& entryId)
4094a3316fc6SZhikuiRen {
40956f284d24SJiaqing Zhao     uint16_t bootIndex = 0;
40966f284d24SJiaqing Zhao     uint64_t codeIndex = 0;
40976f284d24SJiaqing Zhao     if (!parsePostCode(entryId, codeIndex, bootIndex))
40986f284d24SJiaqing Zhao     {
40996f284d24SJiaqing Zhao         // Requested ID was not found
4100ac106bf6SEd Tanous         messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
41016f284d24SJiaqing Zhao         return;
41026f284d24SJiaqing Zhao     }
41036f284d24SJiaqing Zhao 
41046f284d24SJiaqing Zhao     if (bootIndex == 0 || codeIndex == 0)
41056f284d24SJiaqing Zhao     {
41066f284d24SJiaqing Zhao         // 0 is an invalid index
4107ac106bf6SEd Tanous         messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
41086f284d24SJiaqing Zhao         return;
41096f284d24SJiaqing Zhao     }
41106f284d24SJiaqing Zhao 
4111a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
4112ac106bf6SEd Tanous         [asyncResp, entryId, bootIndex,
41135e7e2dc5SEd Tanous          codeIndex](const boost::system::error_code& ec,
41146c9a279eSManojkiran Eda                     const boost::container::flat_map<
41156c9a279eSManojkiran Eda                         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
41166c9a279eSManojkiran Eda                         postcode) {
4117a3316fc6SZhikuiRen         if (ec)
4118a3316fc6SZhikuiRen         {
411962598e31SEd Tanous             BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
4120ac106bf6SEd Tanous             messages::internalError(asyncResp->res);
4121a3316fc6SZhikuiRen             return;
4122a3316fc6SZhikuiRen         }
4123a3316fc6SZhikuiRen 
4124a3316fc6SZhikuiRen         if (postcode.empty())
4125a3316fc6SZhikuiRen         {
4126ac106bf6SEd Tanous             messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
4127a3316fc6SZhikuiRen             return;
4128a3316fc6SZhikuiRen         }
4129a3316fc6SZhikuiRen 
4130ac106bf6SEd Tanous         if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex))
41316f284d24SJiaqing Zhao         {
4132ac106bf6SEd Tanous             messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
41336f284d24SJiaqing Zhao             return;
41346f284d24SJiaqing Zhao         }
4135a3316fc6SZhikuiRen     },
413615124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
413715124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
4138a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
4139a3316fc6SZhikuiRen         bootIndex);
4140a3316fc6SZhikuiRen }
4141a3316fc6SZhikuiRen 
4142ac106bf6SEd Tanous static void
4143ac106bf6SEd Tanous     getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
4144ac106bf6SEd Tanous                        const uint16_t bootIndex, const uint16_t bootCount,
4145ac106bf6SEd Tanous                        const uint64_t entryCount, size_t skip, size_t top)
4146a3316fc6SZhikuiRen {
4147a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
4148ac106bf6SEd Tanous         [asyncResp, bootIndex, bootCount, entryCount, skip,
41495e7e2dc5SEd Tanous          top](const boost::system::error_code& ec,
41506c9a279eSManojkiran Eda               const boost::container::flat_map<
41516c9a279eSManojkiran Eda                   uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
41526c9a279eSManojkiran Eda                   postcode) {
4153a3316fc6SZhikuiRen         if (ec)
4154a3316fc6SZhikuiRen         {
415562598e31SEd Tanous             BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
4156ac106bf6SEd Tanous             messages::internalError(asyncResp->res);
4157a3316fc6SZhikuiRen             return;
4158a3316fc6SZhikuiRen         }
4159a3316fc6SZhikuiRen 
4160a3316fc6SZhikuiRen         uint64_t endCount = entryCount;
4161a3316fc6SZhikuiRen         if (!postcode.empty())
4162a3316fc6SZhikuiRen         {
4163a3316fc6SZhikuiRen             endCount = entryCount + postcode.size();
41643648c8beSEd Tanous             if (skip < endCount && (top + skip) > entryCount)
4165a3316fc6SZhikuiRen             {
416689492a15SPatrick Williams                 uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip),
416789492a15SPatrick Williams                                                  entryCount) -
41683648c8beSEd Tanous                                         entryCount;
4169a3316fc6SZhikuiRen                 uint64_t thisBootTop =
41703648c8beSEd Tanous                     std::min(static_cast<uint64_t>(top + skip), endCount) -
41713648c8beSEd Tanous                     entryCount;
4172a3316fc6SZhikuiRen 
4173ac106bf6SEd Tanous                 fillPostCodeEntry(asyncResp, postcode, bootIndex, 0,
4174ac106bf6SEd Tanous                                   thisBootSkip, thisBootTop);
4175a3316fc6SZhikuiRen             }
4176ac106bf6SEd Tanous             asyncResp->res.jsonValue["Members@odata.count"] = endCount;
4177a3316fc6SZhikuiRen         }
4178a3316fc6SZhikuiRen 
4179a3316fc6SZhikuiRen         // continue to previous bootIndex
4180a3316fc6SZhikuiRen         if (bootIndex < bootCount)
4181a3316fc6SZhikuiRen         {
4182ac106bf6SEd Tanous             getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1),
4183a3316fc6SZhikuiRen                                bootCount, endCount, skip, top);
4184a3316fc6SZhikuiRen         }
418581584abeSJiaqing Zhao         else if (skip + top < endCount)
4186a3316fc6SZhikuiRen         {
4187ac106bf6SEd Tanous             asyncResp->res.jsonValue["Members@odata.nextLink"] =
41880fda0f12SGeorge Liu                 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" +
4189a3316fc6SZhikuiRen                 std::to_string(skip + top);
4190a3316fc6SZhikuiRen         }
4191a3316fc6SZhikuiRen     },
419215124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
419315124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
4194a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
4195a3316fc6SZhikuiRen         bootIndex);
4196a3316fc6SZhikuiRen }
4197a3316fc6SZhikuiRen 
41988d1b46d7Szhanghch05 static void
4199ac106bf6SEd Tanous     getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
42003648c8beSEd Tanous                          size_t skip, size_t top)
4201a3316fc6SZhikuiRen {
4202a3316fc6SZhikuiRen     uint64_t entryCount = 0;
42031e1e598dSJonathan Doman     sdbusplus::asio::getProperty<uint16_t>(
42041e1e598dSJonathan Doman         *crow::connections::systemBus,
42051e1e598dSJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
42061e1e598dSJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
42071e1e598dSJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount",
4208ac106bf6SEd Tanous         [asyncResp, entryCount, skip, top](const boost::system::error_code& ec,
42091e1e598dSJonathan Doman                                            const uint16_t bootCount) {
4210a3316fc6SZhikuiRen         if (ec)
4211a3316fc6SZhikuiRen         {
421262598e31SEd Tanous             BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
4213ac106bf6SEd Tanous             messages::internalError(asyncResp->res);
4214a3316fc6SZhikuiRen             return;
4215a3316fc6SZhikuiRen         }
4216ac106bf6SEd Tanous         getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top);
42171e1e598dSJonathan Doman     });
4218a3316fc6SZhikuiRen }
4219a3316fc6SZhikuiRen 
42207e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app)
4221a3316fc6SZhikuiRen {
42227e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
422322d268cbSEd Tanous                  "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/")
4224ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
42257e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
422645ca1b86SEd Tanous             [&app](const crow::Request& req,
422722d268cbSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
422822d268cbSEd Tanous                    const std::string& systemName) {
4229c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
4230c937d2bfSEd Tanous             .canDelegateTop = true,
4231c937d2bfSEd Tanous             .canDelegateSkip = true,
4232c937d2bfSEd Tanous         };
4233c937d2bfSEd Tanous         query_param::Query delegatedQuery;
4234c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
42353ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
423645ca1b86SEd Tanous         {
423745ca1b86SEd Tanous             return;
423845ca1b86SEd Tanous         }
42397f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
42407f3e84a1SEd Tanous         {
42417f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
42427f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
42437f3e84a1SEd Tanous                                        systemName);
42447f3e84a1SEd Tanous             return;
42457f3e84a1SEd Tanous         }
424622d268cbSEd Tanous 
424722d268cbSEd Tanous         if (systemName != "system")
424822d268cbSEd Tanous         {
424922d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
425022d268cbSEd Tanous                                        systemName);
425122d268cbSEd Tanous             return;
425222d268cbSEd Tanous         }
4253a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
4254a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
4255a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
4256a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
4257a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
4258a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
4259a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
4260a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
4261a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
42623648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
42635143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
42643648c8beSEd Tanous         getCurrentBootNumber(asyncResp, skip, top);
42657e860f15SJohn Edward Broadbent     });
4266a3316fc6SZhikuiRen }
4267a3316fc6SZhikuiRen 
4268647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app)
4269647b3cdcSGeorge Liu {
42700fda0f12SGeorge Liu     BMCWEB_ROUTE(
42710fda0f12SGeorge Liu         app,
427222d268cbSEd Tanous         "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/")
4273647b3cdcSGeorge Liu         .privileges(redfish::privileges::getLogEntry)
4274647b3cdcSGeorge Liu         .methods(boost::beast::http::verb::get)(
427545ca1b86SEd Tanous             [&app](const crow::Request& req,
4276647b3cdcSGeorge Liu                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
427722d268cbSEd Tanous                    const std::string& systemName,
4278647b3cdcSGeorge Liu                    const std::string& postCodeID) {
42793ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
428045ca1b86SEd Tanous         {
428145ca1b86SEd Tanous             return;
428245ca1b86SEd Tanous         }
428372e21377SMatt Spinler         if (!http_helpers::isContentTypeAllowed(
428499351cd8SEd Tanous                 req.getHeaderValue("Accept"),
42854a0e1a0cSEd Tanous                 http_helpers::ContentType::OctetStream, true))
4286647b3cdcSGeorge Liu         {
4287002d39b4SEd Tanous             asyncResp->res.result(boost::beast::http::status::bad_request);
4288647b3cdcSGeorge Liu             return;
4289647b3cdcSGeorge Liu         }
42907f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
42917f3e84a1SEd Tanous         {
42927f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
42937f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
42947f3e84a1SEd Tanous                                        systemName);
42957f3e84a1SEd Tanous             return;
42967f3e84a1SEd Tanous         }
429722d268cbSEd Tanous         if (systemName != "system")
429822d268cbSEd Tanous         {
429922d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
430022d268cbSEd Tanous                                        systemName);
430122d268cbSEd Tanous             return;
430222d268cbSEd Tanous         }
4303647b3cdcSGeorge Liu 
4304647b3cdcSGeorge Liu         uint64_t currentValue = 0;
4305647b3cdcSGeorge Liu         uint16_t index = 0;
4306647b3cdcSGeorge Liu         if (!parsePostCode(postCodeID, currentValue, index))
4307647b3cdcSGeorge Liu         {
4308002d39b4SEd Tanous             messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID);
4309647b3cdcSGeorge Liu             return;
4310647b3cdcSGeorge Liu         }
4311647b3cdcSGeorge Liu 
4312647b3cdcSGeorge Liu         crow::connections::systemBus->async_method_call(
4313647b3cdcSGeorge Liu             [asyncResp, postCodeID, currentValue](
43145e7e2dc5SEd Tanous                 const boost::system::error_code& ec,
4315002d39b4SEd Tanous                 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>&
4316002d39b4SEd Tanous                     postcodes) {
4317647b3cdcSGeorge Liu             if (ec.value() == EBADR)
4318647b3cdcSGeorge Liu             {
4319002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry",
4320002d39b4SEd Tanous                                            postCodeID);
4321647b3cdcSGeorge Liu                 return;
4322647b3cdcSGeorge Liu             }
4323647b3cdcSGeorge Liu             if (ec)
4324647b3cdcSGeorge Liu             {
432562598e31SEd Tanous                 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
4326647b3cdcSGeorge Liu                 messages::internalError(asyncResp->res);
4327647b3cdcSGeorge Liu                 return;
4328647b3cdcSGeorge Liu             }
4329647b3cdcSGeorge Liu 
4330647b3cdcSGeorge Liu             size_t value = static_cast<size_t>(currentValue) - 1;
4331002d39b4SEd Tanous             if (value == std::string::npos || postcodes.size() < currentValue)
4332647b3cdcSGeorge Liu             {
433362598e31SEd Tanous                 BMCWEB_LOG_WARNING("Wrong currentValue value");
4334002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry",
4335002d39b4SEd Tanous                                            postCodeID);
4336647b3cdcSGeorge Liu                 return;
4337647b3cdcSGeorge Liu             }
4338647b3cdcSGeorge Liu 
43399eb808c1SEd Tanous             const auto& [tID, c] = postcodes[value];
434046ff87baSEd Tanous             if (c.empty())
4341647b3cdcSGeorge Liu             {
434262598e31SEd Tanous                 BMCWEB_LOG_WARNING("No found post code data");
4343002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry",
4344002d39b4SEd Tanous                                            postCodeID);
4345647b3cdcSGeorge Liu                 return;
4346647b3cdcSGeorge Liu             }
434746ff87baSEd Tanous             // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
434846ff87baSEd Tanous             const char* d = reinterpret_cast<const char*>(c.data());
434946ff87baSEd Tanous             std::string_view strData(d, c.size());
4350647b3cdcSGeorge Liu 
4351d9f6c621SEd Tanous             asyncResp->res.addHeader(boost::beast::http::field::content_type,
4352647b3cdcSGeorge Liu                                      "application/octet-stream");
4353d9f6c621SEd Tanous             asyncResp->res.addHeader(
4354d9f6c621SEd Tanous                 boost::beast::http::field::content_transfer_encoding, "Base64");
435527b0cf90SEd Tanous             asyncResp->res.write(crow::utility::base64encode(strData));
4356647b3cdcSGeorge Liu         },
4357647b3cdcSGeorge Liu             "xyz.openbmc_project.State.Boot.PostCode0",
4358647b3cdcSGeorge Liu             "/xyz/openbmc_project/State/Boot/PostCode0",
4359002d39b4SEd Tanous             "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index);
4360647b3cdcSGeorge Liu     });
4361647b3cdcSGeorge Liu }
4362647b3cdcSGeorge Liu 
43637e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app)
4364a3316fc6SZhikuiRen {
43657e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
436622d268cbSEd Tanous         app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/")
4367ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
43687e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
436945ca1b86SEd Tanous             [&app](const crow::Request& req,
43707e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
437122d268cbSEd Tanous                    const std::string& systemName, const std::string& targetID) {
43723ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
437345ca1b86SEd Tanous         {
437445ca1b86SEd Tanous             return;
437545ca1b86SEd Tanous         }
43767f3e84a1SEd Tanous         if constexpr (bmcwebEnableMultiHost)
43777f3e84a1SEd Tanous         {
43787f3e84a1SEd Tanous             // Option currently returns no systems.  TBD
43797f3e84a1SEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
43807f3e84a1SEd Tanous                                        systemName);
43817f3e84a1SEd Tanous             return;
43827f3e84a1SEd Tanous         }
438322d268cbSEd Tanous         if (systemName != "system")
438422d268cbSEd Tanous         {
438522d268cbSEd Tanous             messages::resourceNotFound(asyncResp->res, "ComputerSystem",
438622d268cbSEd Tanous                                        systemName);
438722d268cbSEd Tanous             return;
438822d268cbSEd Tanous         }
438922d268cbSEd Tanous 
43906f284d24SJiaqing Zhao         getPostCodeForEntry(asyncResp, targetID);
43917e860f15SJohn Edward Broadbent     });
4392a3316fc6SZhikuiRen }
4393a3316fc6SZhikuiRen 
43941da66f75SEd Tanous } // namespace redfish
4395