xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision dd72e87b0588dcc2e2732cd47e5c9468a6386200)
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 
18b7028ebfSSpencer Ku #include "gzfile.hpp"
19647b3cdcSGeorge Liu #include "http_utility.hpp"
20b7028ebfSSpencer Ku #include "human_sort.hpp"
214851d45dSJason M. Bills #include "registries.hpp"
224851d45dSJason M. Bills #include "registries/base_message_registry.hpp"
234851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp"
2446229577SJames Feist #include "task.hpp"
251da66f75SEd Tanous 
26e1f26343SJason M. Bills #include <systemd/sd-journal.h>
27400fd1fbSAdriana Kobylak #include <unistd.h>
28e1f26343SJason M. Bills 
297e860f15SJohn Edward Broadbent #include <app.hpp>
309896eaedSEd Tanous #include <boost/algorithm/string/case_conv.hpp>
3111ba3979SEd Tanous #include <boost/algorithm/string/classification.hpp>
32400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp>
334851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp>
3407c8c20dSEd Tanous #include <boost/beast/http/verb.hpp>
351da66f75SEd Tanous #include <boost/container/flat_map.hpp>
361ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp>
37168e20c1SEd Tanous #include <dbus_utility.hpp>
38cb92c03bSAndrew Geissler #include <error_messages.hpp>
3945ca1b86SEd Tanous #include <query.hpp>
40ed398213SEd Tanous #include <registries/privilege_registry.hpp>
412b82937eSEd Tanous #include <utils/time_utils.hpp>
421214b7e7SGunnar Mills 
43647b3cdcSGeorge Liu #include <charconv>
444418c7f0SJames Feist #include <filesystem>
4575710de2SXiaochao Ma #include <optional>
4626702d01SEd Tanous #include <span>
47cd225da8SJason M. Bills #include <string_view>
48abf2add6SEd Tanous #include <variant>
491da66f75SEd Tanous 
501da66f75SEd Tanous namespace redfish
511da66f75SEd Tanous {
521da66f75SEd Tanous 
535b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump";
545b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump";
555b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump";
565b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
575b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
585b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
59424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
606eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface =
616eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
621da66f75SEd Tanous 
63fffb8c1fSEd Tanous namespace registries
644851d45dSJason M. Bills {
6526702d01SEd Tanous static const Message*
6626702d01SEd Tanous     getMessageFromRegistry(const std::string& messageKey,
6726702d01SEd Tanous                            const std::span<const MessageEntry> registry)
684851d45dSJason M. Bills {
69002d39b4SEd Tanous     std::span<const MessageEntry>::iterator messageIt =
70002d39b4SEd Tanous         std::find_if(registry.begin(), registry.end(),
714851d45dSJason M. Bills                      [&messageKey](const MessageEntry& messageEntry) {
72e662eae8SEd Tanous         return std::strcmp(messageEntry.first, messageKey.c_str()) == 0;
734851d45dSJason M. Bills         });
7426702d01SEd Tanous     if (messageIt != registry.end())
754851d45dSJason M. Bills     {
764851d45dSJason M. Bills         return &messageIt->second;
774851d45dSJason M. Bills     }
784851d45dSJason M. Bills 
794851d45dSJason M. Bills     return nullptr;
804851d45dSJason M. Bills }
814851d45dSJason M. Bills 
824851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
834851d45dSJason M. Bills {
844851d45dSJason M. Bills     // Redfish MessageIds are in the form
854851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
864851d45dSJason M. Bills     // the right Message
874851d45dSJason M. Bills     std::vector<std::string> fields;
884851d45dSJason M. Bills     fields.reserve(4);
894851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
9002cad96eSEd Tanous     const std::string& registryName = fields[0];
9102cad96eSEd Tanous     const std::string& messageKey = fields[3];
924851d45dSJason M. Bills 
934851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
944851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
954851d45dSJason M. Bills     {
964851d45dSJason M. Bills         return getMessageFromRegistry(
9726702d01SEd Tanous             messageKey, std::span<const MessageEntry>(base::registry));
984851d45dSJason M. Bills     }
994851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
1004851d45dSJason M. Bills     {
1014851d45dSJason M. Bills         return getMessageFromRegistry(
10226702d01SEd Tanous             messageKey, std::span<const MessageEntry>(openbmc::registry));
1034851d45dSJason M. Bills     }
1044851d45dSJason M. Bills     return nullptr;
1054851d45dSJason M. Bills }
106fffb8c1fSEd Tanous } // namespace registries
1074851d45dSJason M. Bills 
108f6150403SJames Feist namespace fs = std::filesystem;
1091da66f75SEd Tanous 
110cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
111cb92c03bSAndrew Geissler {
112d4d25793SEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
113d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
114d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
115d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
116cb92c03bSAndrew Geissler     {
117cb92c03bSAndrew Geissler         return "Critical";
118cb92c03bSAndrew Geissler     }
1193174e4dfSEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
120d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
121d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
122cb92c03bSAndrew Geissler     {
123cb92c03bSAndrew Geissler         return "OK";
124cb92c03bSAndrew Geissler     }
1253174e4dfSEd Tanous     if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
126cb92c03bSAndrew Geissler     {
127cb92c03bSAndrew Geissler         return "Warning";
128cb92c03bSAndrew Geissler     }
129cb92c03bSAndrew Geissler     return "";
130cb92c03bSAndrew Geissler }
131cb92c03bSAndrew Geissler 
1327e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
13339e77504SEd Tanous                                      const std::string_view& field,
13439e77504SEd Tanous                                      std::string_view& contents)
13516428a1aSJason M. Bills {
13616428a1aSJason M. Bills     const char* data = nullptr;
13716428a1aSJason M. Bills     size_t length = 0;
13816428a1aSJason M. Bills     int ret = 0;
13916428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
14046ff87baSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
14146ff87baSEd Tanous     const void** dataVoid = reinterpret_cast<const void**>(&data);
14246ff87baSEd Tanous 
14346ff87baSEd Tanous     ret = sd_journal_get_data(journal, field.data(), dataVoid, &length);
14416428a1aSJason M. Bills     if (ret < 0)
14516428a1aSJason M. Bills     {
14616428a1aSJason M. Bills         return ret;
14716428a1aSJason M. Bills     }
14839e77504SEd Tanous     contents = std::string_view(data, length);
14916428a1aSJason M. Bills     // Only use the content after the "=" character.
15081ce609eSEd Tanous     contents.remove_prefix(std::min(contents.find('=') + 1, contents.size()));
15116428a1aSJason M. Bills     return ret;
15216428a1aSJason M. Bills }
15316428a1aSJason M. Bills 
1547e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
1557e860f15SJohn Edward Broadbent                                      const std::string_view& field,
1567e860f15SJohn Edward Broadbent                                      const int& base, long int& contents)
15716428a1aSJason M. Bills {
15816428a1aSJason M. Bills     int ret = 0;
15939e77504SEd Tanous     std::string_view metadata;
16016428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
16116428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
16216428a1aSJason M. Bills     if (ret < 0)
16316428a1aSJason M. Bills     {
16416428a1aSJason M. Bills         return ret;
16516428a1aSJason M. Bills     }
166b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
16716428a1aSJason M. Bills     return ret;
16816428a1aSJason M. Bills }
16916428a1aSJason M. Bills 
1707e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal,
1717e860f15SJohn Edward Broadbent                                      std::string& entryTimestamp)
172a3316fc6SZhikuiRen {
173a3316fc6SZhikuiRen     int ret = 0;
174a3316fc6SZhikuiRen     uint64_t timestamp = 0;
175a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
176a3316fc6SZhikuiRen     if (ret < 0)
177a3316fc6SZhikuiRen     {
178a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
179a3316fc6SZhikuiRen                          << strerror(-ret);
180a3316fc6SZhikuiRen         return false;
181a3316fc6SZhikuiRen     }
1822b82937eSEd Tanous     entryTimestamp =
1832b82937eSEd Tanous         redfish::time_utils::getDateTimeUint(timestamp / 1000 / 1000);
1849c620e21SAsmitha Karunanithi     return true;
185a3316fc6SZhikuiRen }
18650b8a43aSEd Tanous 
1877e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
188e85d6b16SJason M. Bills                                     const bool firstEntry = true)
18916428a1aSJason M. Bills {
19016428a1aSJason M. Bills     int ret = 0;
19116428a1aSJason M. Bills     static uint64_t prevTs = 0;
19216428a1aSJason M. Bills     static int index = 0;
193e85d6b16SJason M. Bills     if (firstEntry)
194e85d6b16SJason M. Bills     {
195e85d6b16SJason M. Bills         prevTs = 0;
196e85d6b16SJason M. Bills     }
197e85d6b16SJason M. Bills 
19816428a1aSJason M. Bills     // Get the entry timestamp
19916428a1aSJason M. Bills     uint64_t curTs = 0;
20016428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
20116428a1aSJason M. Bills     if (ret < 0)
20216428a1aSJason M. Bills     {
20316428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
20416428a1aSJason M. Bills                          << strerror(-ret);
20516428a1aSJason M. Bills         return false;
20616428a1aSJason M. Bills     }
20716428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
20816428a1aSJason M. Bills     if (curTs == prevTs)
20916428a1aSJason M. Bills     {
21016428a1aSJason M. Bills         index++;
21116428a1aSJason M. Bills     }
21216428a1aSJason M. Bills     else
21316428a1aSJason M. Bills     {
21416428a1aSJason M. Bills         // Otherwise, reset it
21516428a1aSJason M. Bills         index = 0;
21616428a1aSJason M. Bills     }
21716428a1aSJason M. Bills     // Save the timestamp
21816428a1aSJason M. Bills     prevTs = curTs;
21916428a1aSJason M. Bills 
22016428a1aSJason M. Bills     entryID = std::to_string(curTs);
22116428a1aSJason M. Bills     if (index > 0)
22216428a1aSJason M. Bills     {
22316428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
22416428a1aSJason M. Bills     }
22516428a1aSJason M. Bills     return true;
22616428a1aSJason M. Bills }
22716428a1aSJason M. Bills 
228e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
229e85d6b16SJason M. Bills                              const bool firstEntry = true)
23095820184SJason M. Bills {
231271584abSEd Tanous     static time_t prevTs = 0;
23295820184SJason M. Bills     static int index = 0;
233e85d6b16SJason M. Bills     if (firstEntry)
234e85d6b16SJason M. Bills     {
235e85d6b16SJason M. Bills         prevTs = 0;
236e85d6b16SJason M. Bills     }
237e85d6b16SJason M. Bills 
23895820184SJason M. Bills     // Get the entry timestamp
239271584abSEd Tanous     std::time_t curTs = 0;
24095820184SJason M. Bills     std::tm timeStruct = {};
24195820184SJason M. Bills     std::istringstream entryStream(logEntry);
24295820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
24395820184SJason M. Bills     {
24495820184SJason M. Bills         curTs = std::mktime(&timeStruct);
24595820184SJason M. Bills     }
24695820184SJason M. Bills     // If the timestamp isn't unique, increment the index
24795820184SJason M. Bills     if (curTs == prevTs)
24895820184SJason M. Bills     {
24995820184SJason M. Bills         index++;
25095820184SJason M. Bills     }
25195820184SJason M. Bills     else
25295820184SJason M. Bills     {
25395820184SJason M. Bills         // Otherwise, reset it
25495820184SJason M. Bills         index = 0;
25595820184SJason M. Bills     }
25695820184SJason M. Bills     // Save the timestamp
25795820184SJason M. Bills     prevTs = curTs;
25895820184SJason M. Bills 
25995820184SJason M. Bills     entryID = std::to_string(curTs);
26095820184SJason M. Bills     if (index > 0)
26195820184SJason M. Bills     {
26295820184SJason M. Bills         entryID += "_" + std::to_string(index);
26395820184SJason M. Bills     }
26495820184SJason M. Bills     return true;
26595820184SJason M. Bills }
26695820184SJason M. Bills 
2677e860f15SJohn Edward Broadbent inline static bool
2688d1b46d7Szhanghch05     getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2698d1b46d7Szhanghch05                        const std::string& entryID, uint64_t& timestamp,
2708d1b46d7Szhanghch05                        uint64_t& index)
27116428a1aSJason M. Bills {
27216428a1aSJason M. Bills     if (entryID.empty())
27316428a1aSJason M. Bills     {
27416428a1aSJason M. Bills         return false;
27516428a1aSJason M. Bills     }
27616428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
27739e77504SEd Tanous     std::string_view tsStr(entryID);
27816428a1aSJason M. Bills 
27981ce609eSEd Tanous     auto underscorePos = tsStr.find('_');
28071d5d8dbSEd Tanous     if (underscorePos != std::string_view::npos)
28116428a1aSJason M. Bills     {
28216428a1aSJason M. Bills         // Timestamp has an index
28316428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
28439e77504SEd Tanous         std::string_view indexStr(entryID);
28516428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
286c0bd5e4bSEd Tanous         auto [ptr, ec] = std::from_chars(
287c0bd5e4bSEd Tanous             indexStr.data(), indexStr.data() + indexStr.size(), index);
288c0bd5e4bSEd Tanous         if (ec != std::errc())
28916428a1aSJason M. Bills         {
290ace85d60SEd Tanous             messages::resourceMissingAtURI(
291ace85d60SEd Tanous                 asyncResp->res, crow::utility::urlFromPieces(entryID));
29216428a1aSJason M. Bills             return false;
29316428a1aSJason M. Bills         }
29416428a1aSJason M. Bills     }
29516428a1aSJason M. Bills     // Timestamp has no index
296c0bd5e4bSEd Tanous     auto [ptr, ec] =
297c0bd5e4bSEd Tanous         std::from_chars(tsStr.data(), tsStr.data() + tsStr.size(), timestamp);
298c0bd5e4bSEd Tanous     if (ec != std::errc())
29916428a1aSJason M. Bills     {
300ace85d60SEd Tanous         messages::resourceMissingAtURI(asyncResp->res,
301ace85d60SEd Tanous                                        crow::utility::urlFromPieces(entryID));
30216428a1aSJason M. Bills         return false;
30316428a1aSJason M. Bills     }
30416428a1aSJason M. Bills     return true;
30516428a1aSJason M. Bills }
30616428a1aSJason M. Bills 
30795820184SJason M. Bills static bool
30895820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
30995820184SJason M. Bills {
31095820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
31195820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
31295820184SJason M. Bills 
31395820184SJason M. Bills     // Loop through the directory looking for redfish log files
31495820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
31595820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
31695820184SJason M. Bills     {
31795820184SJason M. Bills         // If we find a redfish log file, save the path
31895820184SJason M. Bills         std::string filename = dirEnt.path().filename();
31911ba3979SEd Tanous         if (filename.starts_with(redfishLogFilename))
32095820184SJason M. Bills         {
32195820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
32295820184SJason M. Bills         }
32395820184SJason M. Bills     }
32495820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
32595820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
32695820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
32795820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
32895820184SJason M. Bills 
32995820184SJason M. Bills     return !redfishLogFiles.empty();
33095820184SJason M. Bills }
33195820184SJason M. Bills 
332aefe3786SClaire Weinan inline void parseDumpEntryFromDbusObject(
3332d613eb6SJiaqing Zhao     const dbus::utility::ManagedObjectType::value_type& object,
3342d613eb6SJiaqing Zhao     std::string& dumpStatus, uint64_t& size, uint64_t& timestamp,
335aefe3786SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
336aefe3786SClaire Weinan {
337aefe3786SClaire Weinan     for (const auto& interfaceMap : object.second)
338aefe3786SClaire Weinan     {
339aefe3786SClaire Weinan         if (interfaceMap.first == "xyz.openbmc_project.Common.Progress")
340aefe3786SClaire Weinan         {
341aefe3786SClaire Weinan             for (const auto& propertyMap : interfaceMap.second)
342aefe3786SClaire Weinan             {
343aefe3786SClaire Weinan                 if (propertyMap.first == "Status")
344aefe3786SClaire Weinan                 {
345aefe3786SClaire Weinan                     const auto* status =
346aefe3786SClaire Weinan                         std::get_if<std::string>(&propertyMap.second);
347aefe3786SClaire Weinan                     if (status == nullptr)
348aefe3786SClaire Weinan                     {
349aefe3786SClaire Weinan                         messages::internalError(asyncResp->res);
350aefe3786SClaire Weinan                         break;
351aefe3786SClaire Weinan                     }
352aefe3786SClaire Weinan                     dumpStatus = *status;
353aefe3786SClaire Weinan                 }
354aefe3786SClaire Weinan             }
355aefe3786SClaire Weinan         }
356aefe3786SClaire Weinan         else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
357aefe3786SClaire Weinan         {
358aefe3786SClaire Weinan             for (const auto& propertyMap : interfaceMap.second)
359aefe3786SClaire Weinan             {
360aefe3786SClaire Weinan                 if (propertyMap.first == "Size")
361aefe3786SClaire Weinan                 {
362aefe3786SClaire Weinan                     const auto* sizePtr =
363aefe3786SClaire Weinan                         std::get_if<uint64_t>(&propertyMap.second);
364aefe3786SClaire Weinan                     if (sizePtr == nullptr)
365aefe3786SClaire Weinan                     {
366aefe3786SClaire Weinan                         messages::internalError(asyncResp->res);
367aefe3786SClaire Weinan                         break;
368aefe3786SClaire Weinan                     }
369aefe3786SClaire Weinan                     size = *sizePtr;
370aefe3786SClaire Weinan                     break;
371aefe3786SClaire Weinan                 }
372aefe3786SClaire Weinan             }
373aefe3786SClaire Weinan         }
374aefe3786SClaire Weinan         else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime")
375aefe3786SClaire Weinan         {
376aefe3786SClaire Weinan             for (const auto& propertyMap : interfaceMap.second)
377aefe3786SClaire Weinan             {
378aefe3786SClaire Weinan                 if (propertyMap.first == "Elapsed")
379aefe3786SClaire Weinan                 {
380aefe3786SClaire Weinan                     const uint64_t* usecsTimeStamp =
381aefe3786SClaire Weinan                         std::get_if<uint64_t>(&propertyMap.second);
382aefe3786SClaire Weinan                     if (usecsTimeStamp == nullptr)
383aefe3786SClaire Weinan                     {
384aefe3786SClaire Weinan                         messages::internalError(asyncResp->res);
385aefe3786SClaire Weinan                         break;
386aefe3786SClaire Weinan                     }
387c21c64b6SClaire Weinan                     timestamp = (*usecsTimeStamp / 1000 / 1000);
388aefe3786SClaire Weinan                     break;
389aefe3786SClaire Weinan                 }
390aefe3786SClaire Weinan             }
391aefe3786SClaire Weinan         }
392aefe3786SClaire Weinan     }
393aefe3786SClaire Weinan }
394aefe3786SClaire Weinan 
39521ab404cSNan Zhou static std::string getDumpEntriesPath(const std::string& dumpType)
396fdd26906SClaire Weinan {
397fdd26906SClaire Weinan     std::string entriesPath;
398fdd26906SClaire Weinan 
399fdd26906SClaire Weinan     if (dumpType == "BMC")
400fdd26906SClaire Weinan     {
401fdd26906SClaire Weinan         entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
402fdd26906SClaire Weinan     }
403fdd26906SClaire Weinan     else if (dumpType == "FaultLog")
404fdd26906SClaire Weinan     {
405fdd26906SClaire Weinan         entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/";
406fdd26906SClaire Weinan     }
407fdd26906SClaire Weinan     else if (dumpType == "System")
408fdd26906SClaire Weinan     {
409fdd26906SClaire Weinan         entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
410fdd26906SClaire Weinan     }
411fdd26906SClaire Weinan     else
412fdd26906SClaire Weinan     {
413fdd26906SClaire Weinan         BMCWEB_LOG_ERROR << "getDumpEntriesPath() invalid dump type: "
414fdd26906SClaire Weinan                          << dumpType;
415fdd26906SClaire Weinan     }
416fdd26906SClaire Weinan 
417fdd26906SClaire Weinan     // Returns empty string on error
418fdd26906SClaire Weinan     return entriesPath;
419fdd26906SClaire Weinan }
420fdd26906SClaire Weinan 
4218d1b46d7Szhanghch05 inline void
4228d1b46d7Szhanghch05     getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
4235cb1dd27SAsmitha Karunanithi                            const std::string& dumpType)
4245cb1dd27SAsmitha Karunanithi {
425fdd26906SClaire Weinan     std::string entriesPath = getDumpEntriesPath(dumpType);
426fdd26906SClaire Weinan     if (entriesPath.empty())
4275cb1dd27SAsmitha Karunanithi     {
4285cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
4295cb1dd27SAsmitha Karunanithi         return;
4305cb1dd27SAsmitha Karunanithi     }
4315cb1dd27SAsmitha Karunanithi 
4325cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
433fdd26906SClaire Weinan         [asyncResp, entriesPath,
434711ac7a9SEd Tanous          dumpType](const boost::system::error_code ec,
435711ac7a9SEd Tanous                    dbus::utility::ManagedObjectType& resp) {
4365cb1dd27SAsmitha Karunanithi         if (ec)
4375cb1dd27SAsmitha Karunanithi         {
4385cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4395cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
4405cb1dd27SAsmitha Karunanithi             return;
4415cb1dd27SAsmitha Karunanithi         }
4425cb1dd27SAsmitha Karunanithi 
443fdd26906SClaire Weinan         // Remove ending slash
444fdd26906SClaire Weinan         std::string odataIdStr = entriesPath;
445fdd26906SClaire Weinan         if (!odataIdStr.empty())
446fdd26906SClaire Weinan         {
447fdd26906SClaire Weinan             odataIdStr.pop_back();
448fdd26906SClaire Weinan         }
449fdd26906SClaire Weinan 
450fdd26906SClaire Weinan         asyncResp->res.jsonValue["@odata.type"] =
451fdd26906SClaire Weinan             "#LogEntryCollection.LogEntryCollection";
452fdd26906SClaire Weinan         asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr);
453fdd26906SClaire Weinan         asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries";
454fdd26906SClaire Weinan         asyncResp->res.jsonValue["Description"] =
455fdd26906SClaire Weinan             "Collection of " + dumpType + " Dump Entries";
456fdd26906SClaire Weinan 
4575cb1dd27SAsmitha Karunanithi         nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4585cb1dd27SAsmitha Karunanithi         entriesArray = nlohmann::json::array();
459b47452b2SAsmitha Karunanithi         std::string dumpEntryPath =
460b47452b2SAsmitha Karunanithi             "/xyz/openbmc_project/dump/" +
461002d39b4SEd Tanous             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/";
4625cb1dd27SAsmitha Karunanithi 
463002d39b4SEd Tanous         std::sort(resp.begin(), resp.end(), [](const auto& l, const auto& r) {
464002d39b4SEd Tanous             return AlphanumLess<std::string>()(l.first.filename(),
465002d39b4SEd Tanous                                                r.first.filename());
466565dfb6fSClaire Weinan         });
467565dfb6fSClaire Weinan 
4685cb1dd27SAsmitha Karunanithi         for (auto& object : resp)
4695cb1dd27SAsmitha Karunanithi         {
470b47452b2SAsmitha Karunanithi             if (object.first.str.find(dumpEntryPath) == std::string::npos)
4715cb1dd27SAsmitha Karunanithi             {
4725cb1dd27SAsmitha Karunanithi                 continue;
4735cb1dd27SAsmitha Karunanithi             }
4741d8782e7SNan Zhou             uint64_t timestamp = 0;
4755cb1dd27SAsmitha Karunanithi             uint64_t size = 0;
47635440d18SAsmitha Karunanithi             std::string dumpStatus;
477433b68b4SJason M. Bills             nlohmann::json::object_t thisEntry;
4782dfd18efSEd Tanous 
4792dfd18efSEd Tanous             std::string entryID = object.first.filename();
4802dfd18efSEd Tanous             if (entryID.empty())
4815cb1dd27SAsmitha Karunanithi             {
4825cb1dd27SAsmitha Karunanithi                 continue;
4835cb1dd27SAsmitha Karunanithi             }
4845cb1dd27SAsmitha Karunanithi 
485aefe3786SClaire Weinan             parseDumpEntryFromDbusObject(object, dumpStatus, size, timestamp,
486aefe3786SClaire Weinan                                          asyncResp);
4875cb1dd27SAsmitha Karunanithi 
4880fda0f12SGeorge Liu             if (dumpStatus !=
4890fda0f12SGeorge Liu                     "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
49035440d18SAsmitha Karunanithi                 !dumpStatus.empty())
49135440d18SAsmitha Karunanithi             {
49235440d18SAsmitha Karunanithi                 // Dump status is not Complete, no need to enumerate
49335440d18SAsmitha Karunanithi                 continue;
49435440d18SAsmitha Karunanithi             }
49535440d18SAsmitha Karunanithi 
496647b3cdcSGeorge Liu             thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
497fdd26906SClaire Weinan             thisEntry["@odata.id"] = entriesPath + entryID;
4985cb1dd27SAsmitha Karunanithi             thisEntry["Id"] = entryID;
4995cb1dd27SAsmitha Karunanithi             thisEntry["EntryType"] = "Event";
5002b82937eSEd Tanous             thisEntry["Created"] =
5012b82937eSEd Tanous                 redfish::time_utils::getDateTimeUint(timestamp);
5025cb1dd27SAsmitha Karunanithi             thisEntry["Name"] = dumpType + " Dump Entry";
5035cb1dd27SAsmitha Karunanithi 
5045cb1dd27SAsmitha Karunanithi             if (dumpType == "BMC")
5055cb1dd27SAsmitha Karunanithi             {
506d337bb72SAsmitha Karunanithi                 thisEntry["DiagnosticDataType"] = "Manager";
507d337bb72SAsmitha Karunanithi                 thisEntry["AdditionalDataURI"] =
508fdd26906SClaire Weinan                     entriesPath + entryID + "/attachment";
509fdd26906SClaire Weinan                 thisEntry["AdditionalDataSizeBytes"] = size;
5105cb1dd27SAsmitha Karunanithi             }
5115cb1dd27SAsmitha Karunanithi             else if (dumpType == "System")
5125cb1dd27SAsmitha Karunanithi             {
513d337bb72SAsmitha Karunanithi                 thisEntry["DiagnosticDataType"] = "OEM";
514d337bb72SAsmitha Karunanithi                 thisEntry["OEMDiagnosticDataType"] = "System";
515d337bb72SAsmitha Karunanithi                 thisEntry["AdditionalDataURI"] =
516fdd26906SClaire Weinan                     entriesPath + entryID + "/attachment";
517fdd26906SClaire Weinan                 thisEntry["AdditionalDataSizeBytes"] = size;
5185cb1dd27SAsmitha Karunanithi             }
51935440d18SAsmitha Karunanithi             entriesArray.push_back(std::move(thisEntry));
5205cb1dd27SAsmitha Karunanithi         }
521002d39b4SEd Tanous         asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
5225cb1dd27SAsmitha Karunanithi         },
5235cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5245cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5255cb1dd27SAsmitha Karunanithi }
5265cb1dd27SAsmitha Karunanithi 
5278d1b46d7Szhanghch05 inline void
528c7a6d660SClaire Weinan     getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5298d1b46d7Szhanghch05                      const std::string& entryID, const std::string& dumpType)
5305cb1dd27SAsmitha Karunanithi {
531fdd26906SClaire Weinan     std::string entriesPath = getDumpEntriesPath(dumpType);
532fdd26906SClaire Weinan     if (entriesPath.empty())
5335cb1dd27SAsmitha Karunanithi     {
5345cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5355cb1dd27SAsmitha Karunanithi         return;
5365cb1dd27SAsmitha Karunanithi     }
5375cb1dd27SAsmitha Karunanithi 
5385cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
539fdd26906SClaire Weinan         [asyncResp, entryID, dumpType,
540fdd26906SClaire Weinan          entriesPath](const boost::system::error_code ec,
54102cad96eSEd Tanous                       const dbus::utility::ManagedObjectType& resp) {
5425cb1dd27SAsmitha Karunanithi         if (ec)
5435cb1dd27SAsmitha Karunanithi         {
5445cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
5455cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
5465cb1dd27SAsmitha Karunanithi             return;
5475cb1dd27SAsmitha Karunanithi         }
5485cb1dd27SAsmitha Karunanithi 
549b47452b2SAsmitha Karunanithi         bool foundDumpEntry = false;
550b47452b2SAsmitha Karunanithi         std::string dumpEntryPath =
551b47452b2SAsmitha Karunanithi             "/xyz/openbmc_project/dump/" +
552002d39b4SEd Tanous             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/";
553b47452b2SAsmitha Karunanithi 
5549eb808c1SEd Tanous         for (const auto& objectPath : resp)
5555cb1dd27SAsmitha Karunanithi         {
556b47452b2SAsmitha Karunanithi             if (objectPath.first.str != dumpEntryPath + entryID)
5575cb1dd27SAsmitha Karunanithi             {
5585cb1dd27SAsmitha Karunanithi                 continue;
5595cb1dd27SAsmitha Karunanithi             }
5605cb1dd27SAsmitha Karunanithi 
5615cb1dd27SAsmitha Karunanithi             foundDumpEntry = true;
5621d8782e7SNan Zhou             uint64_t timestamp = 0;
5635cb1dd27SAsmitha Karunanithi             uint64_t size = 0;
56435440d18SAsmitha Karunanithi             std::string dumpStatus;
5655cb1dd27SAsmitha Karunanithi 
566aefe3786SClaire Weinan             parseDumpEntryFromDbusObject(objectPath, dumpStatus, size,
567aefe3786SClaire Weinan                                          timestamp, asyncResp);
5685cb1dd27SAsmitha Karunanithi 
5690fda0f12SGeorge Liu             if (dumpStatus !=
5700fda0f12SGeorge Liu                     "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
57135440d18SAsmitha Karunanithi                 !dumpStatus.empty())
57235440d18SAsmitha Karunanithi             {
57335440d18SAsmitha Karunanithi                 // Dump status is not Complete
57435440d18SAsmitha Karunanithi                 // return not found until status is changed to Completed
575002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
576002d39b4SEd Tanous                                            entryID);
57735440d18SAsmitha Karunanithi                 return;
57835440d18SAsmitha Karunanithi             }
57935440d18SAsmitha Karunanithi 
5805cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["@odata.type"] =
581647b3cdcSGeorge Liu                 "#LogEntry.v1_8_0.LogEntry";
582fdd26906SClaire Weinan             asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID;
5835cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Id"] = entryID;
5845cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["EntryType"] = "Event";
5855cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Created"] =
5862b82937eSEd Tanous                 redfish::time_utils::getDateTimeUint(timestamp);
5875cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
5885cb1dd27SAsmitha Karunanithi 
5895cb1dd27SAsmitha Karunanithi             if (dumpType == "BMC")
5905cb1dd27SAsmitha Karunanithi             {
591d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
592d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataURI"] =
593fdd26906SClaire Weinan                     entriesPath + entryID + "/attachment";
594fdd26906SClaire Weinan                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
5955cb1dd27SAsmitha Karunanithi             }
5965cb1dd27SAsmitha Karunanithi             else if (dumpType == "System")
5975cb1dd27SAsmitha Karunanithi             {
598d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
599002d39b4SEd Tanous                 asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System";
600d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataURI"] =
601fdd26906SClaire Weinan                     entriesPath + entryID + "/attachment";
602fdd26906SClaire Weinan                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
6035cb1dd27SAsmitha Karunanithi             }
6045cb1dd27SAsmitha Karunanithi         }
605e05aec50SEd Tanous         if (!foundDumpEntry)
606b47452b2SAsmitha Karunanithi         {
607b47452b2SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Can't find Dump Entry";
608b47452b2SAsmitha Karunanithi             messages::internalError(asyncResp->res);
609b47452b2SAsmitha Karunanithi             return;
610b47452b2SAsmitha Karunanithi         }
6115cb1dd27SAsmitha Karunanithi         },
6125cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
6135cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
6145cb1dd27SAsmitha Karunanithi }
6155cb1dd27SAsmitha Karunanithi 
6168d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6179878256fSStanley Chu                             const std::string& entryID,
618b47452b2SAsmitha Karunanithi                             const std::string& dumpType)
6195cb1dd27SAsmitha Karunanithi {
620002d39b4SEd Tanous     auto respHandler =
621002d39b4SEd Tanous         [asyncResp, entryID](const boost::system::error_code ec) {
6225cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
6235cb1dd27SAsmitha Karunanithi         if (ec)
6245cb1dd27SAsmitha Karunanithi         {
6253de8d8baSGeorge Liu             if (ec.value() == EBADR)
6263de8d8baSGeorge Liu             {
6273de8d8baSGeorge Liu                 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
6283de8d8baSGeorge Liu                 return;
6293de8d8baSGeorge Liu             }
6305cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
631fdd26906SClaire Weinan                              << ec << " entryID=" << entryID;
6325cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
6335cb1dd27SAsmitha Karunanithi             return;
6345cb1dd27SAsmitha Karunanithi         }
6355cb1dd27SAsmitha Karunanithi     };
6365cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
6375cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
638b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
639b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
640b47452b2SAsmitha Karunanithi             entryID,
6415cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
6425cb1dd27SAsmitha Karunanithi }
6435cb1dd27SAsmitha Karunanithi 
6448d1b46d7Szhanghch05 inline void
64598be3e39SEd Tanous     createDumpTaskCallback(task::Payload&& payload,
6468d1b46d7Szhanghch05                            const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6478d1b46d7Szhanghch05                            const uint32_t& dumpId, const std::string& dumpPath,
648a43be80fSAsmitha Karunanithi                            const std::string& dumpType)
649a43be80fSAsmitha Karunanithi {
650a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
65159d494eeSPatrick Williams         [dumpId, dumpPath,
65259d494eeSPatrick Williams          dumpType](boost::system::error_code err, sdbusplus::message_t& m,
653a43be80fSAsmitha Karunanithi                    const std::shared_ptr<task::TaskData>& taskData) {
654cb13a392SEd Tanous         if (err)
655cb13a392SEd Tanous         {
6566145ed6fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Error in creating a dump";
6576145ed6fSAsmitha Karunanithi             taskData->state = "Cancelled";
6586145ed6fSAsmitha Karunanithi             return task::completed;
659cb13a392SEd Tanous         }
660b9d36b47SEd Tanous 
661b9d36b47SEd Tanous         dbus::utility::DBusInteracesMap interfacesList;
662a43be80fSAsmitha Karunanithi 
663a43be80fSAsmitha Karunanithi         sdbusplus::message::object_path objPath;
664a43be80fSAsmitha Karunanithi 
665a43be80fSAsmitha Karunanithi         m.read(objPath, interfacesList);
666a43be80fSAsmitha Karunanithi 
667b47452b2SAsmitha Karunanithi         if (objPath.str ==
668b47452b2SAsmitha Karunanithi             "/xyz/openbmc_project/dump/" +
669b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
670b47452b2SAsmitha Karunanithi                 "/entry/" + std::to_string(dumpId))
671a43be80fSAsmitha Karunanithi         {
672a43be80fSAsmitha Karunanithi             nlohmann::json retMessage = messages::success();
673a43be80fSAsmitha Karunanithi             taskData->messages.emplace_back(retMessage);
674a43be80fSAsmitha Karunanithi 
675a43be80fSAsmitha Karunanithi             std::string headerLoc =
676a43be80fSAsmitha Karunanithi                 "Location: " + dumpPath + std::to_string(dumpId);
677002d39b4SEd Tanous             taskData->payload->httpHeaders.emplace_back(std::move(headerLoc));
678a43be80fSAsmitha Karunanithi 
679a43be80fSAsmitha Karunanithi             taskData->state = "Completed";
680b47452b2SAsmitha Karunanithi             return task::completed;
6816145ed6fSAsmitha Karunanithi         }
682a43be80fSAsmitha Karunanithi         return task::completed;
683a43be80fSAsmitha Karunanithi         },
6844978b63fSJason M. Bills         "type='signal',interface='org.freedesktop.DBus.ObjectManager',"
685a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
686a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
687a43be80fSAsmitha Karunanithi 
688a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
689a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
69098be3e39SEd Tanous     task->payload.emplace(std::move(payload));
691a43be80fSAsmitha Karunanithi }
692a43be80fSAsmitha Karunanithi 
6938d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6948d1b46d7Szhanghch05                        const crow::Request& req, const std::string& dumpType)
695a43be80fSAsmitha Karunanithi {
696fdd26906SClaire Weinan     std::string dumpPath = getDumpEntriesPath(dumpType);
697fdd26906SClaire Weinan     if (dumpPath.empty())
698a43be80fSAsmitha Karunanithi     {
699a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
700a43be80fSAsmitha Karunanithi         return;
701a43be80fSAsmitha Karunanithi     }
702a43be80fSAsmitha Karunanithi 
703a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
704a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
705a43be80fSAsmitha Karunanithi 
70615ed6780SWilly Tu     if (!redfish::json_util::readJsonAction(
707a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
708a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
709a43be80fSAsmitha Karunanithi     {
710a43be80fSAsmitha Karunanithi         return;
711a43be80fSAsmitha Karunanithi     }
712a43be80fSAsmitha Karunanithi 
713a43be80fSAsmitha Karunanithi     if (dumpType == "System")
714a43be80fSAsmitha Karunanithi     {
715a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
716a43be80fSAsmitha Karunanithi         {
7174978b63fSJason M. Bills             BMCWEB_LOG_ERROR
7184978b63fSJason M. Bills                 << "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!";
719a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
720a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
721a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
722a43be80fSAsmitha Karunanithi             return;
723a43be80fSAsmitha Karunanithi         }
7243174e4dfSEd Tanous         if ((*oemDiagnosticDataType != "System") ||
725a43be80fSAsmitha Karunanithi             (*diagnosticDataType != "OEM"))
726a43be80fSAsmitha Karunanithi         {
727a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
728ace85d60SEd Tanous             messages::internalError(asyncResp->res);
729a43be80fSAsmitha Karunanithi             return;
730a43be80fSAsmitha Karunanithi         }
7315907571dSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/";
732a43be80fSAsmitha Karunanithi     }
733a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
734a43be80fSAsmitha Karunanithi     {
735a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
736a43be80fSAsmitha Karunanithi         {
7370fda0f12SGeorge Liu             BMCWEB_LOG_ERROR
7380fda0f12SGeorge Liu                 << "CreateDump action parameter 'DiagnosticDataType' not found!";
739a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
740a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
741a43be80fSAsmitha Karunanithi             return;
742a43be80fSAsmitha Karunanithi         }
7433174e4dfSEd Tanous         if (*diagnosticDataType != "Manager")
744a43be80fSAsmitha Karunanithi         {
745a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
746a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
747ace85d60SEd Tanous             messages::internalError(asyncResp->res);
748a43be80fSAsmitha Karunanithi             return;
749a43be80fSAsmitha Karunanithi         }
7505907571dSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/";
7515907571dSAsmitha Karunanithi     }
7525907571dSAsmitha Karunanithi     else
7535907571dSAsmitha Karunanithi     {
7545907571dSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "CreateDump failed. Unknown dump type";
7555907571dSAsmitha Karunanithi         messages::internalError(asyncResp->res);
7565907571dSAsmitha Karunanithi         return;
757a43be80fSAsmitha Karunanithi     }
758a43be80fSAsmitha Karunanithi 
759a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
76098be3e39SEd Tanous         [asyncResp, payload(task::Payload(req)), dumpPath,
76198be3e39SEd Tanous          dumpType](const boost::system::error_code ec,
7625907571dSAsmitha Karunanithi                    const sdbusplus::message::message& msg,
76398be3e39SEd Tanous                    const uint32_t& dumpId) mutable {
764a43be80fSAsmitha Karunanithi         if (ec)
765a43be80fSAsmitha Karunanithi         {
766a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
7675907571dSAsmitha Karunanithi             const sd_bus_error* dbusError = msg.get_error();
7685907571dSAsmitha Karunanithi             if (dbusError == nullptr)
7695907571dSAsmitha Karunanithi             {
7705907571dSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
7715907571dSAsmitha Karunanithi                 return;
7725907571dSAsmitha Karunanithi             }
7735907571dSAsmitha Karunanithi 
7745907571dSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump DBus error: " << dbusError->name
7755907571dSAsmitha Karunanithi                              << " and error msg: " << dbusError->message;
7765907571dSAsmitha Karunanithi             if (std::string_view(
7775907571dSAsmitha Karunanithi                     "xyz.openbmc_project.Common.Error.NotAllowed") ==
7785907571dSAsmitha Karunanithi                 dbusError->name)
7795907571dSAsmitha Karunanithi             {
7805907571dSAsmitha Karunanithi                 messages::resourceInStandby(asyncResp->res);
7815907571dSAsmitha Karunanithi                 return;
7825907571dSAsmitha Karunanithi             }
7835907571dSAsmitha Karunanithi             if (std::string_view(
7845907571dSAsmitha Karunanithi                     "xyz.openbmc_project.Dump.Create.Error.Disabled") ==
7855907571dSAsmitha Karunanithi                 dbusError->name)
7865907571dSAsmitha Karunanithi             {
7875907571dSAsmitha Karunanithi                 messages::serviceDisabled(asyncResp->res, dumpPath);
7885907571dSAsmitha Karunanithi                 return;
7895907571dSAsmitha Karunanithi             }
7905907571dSAsmitha Karunanithi             if (std::string_view(
7915907571dSAsmitha Karunanithi                     "xyz.openbmc_project.Common.Error.Unavailable") ==
7925907571dSAsmitha Karunanithi                 dbusError->name)
7935907571dSAsmitha Karunanithi             {
7945907571dSAsmitha Karunanithi                 messages::resourceInUse(asyncResp->res);
7955907571dSAsmitha Karunanithi                 return;
7965907571dSAsmitha Karunanithi             }
7975907571dSAsmitha Karunanithi             // Other Dbus errors such as:
7985907571dSAsmitha Karunanithi             // xyz.openbmc_project.Common.Error.InvalidArgument &
7995907571dSAsmitha Karunanithi             // org.freedesktop.DBus.Error.InvalidArgs are all related to
8005907571dSAsmitha Karunanithi             // the dbus call that is made here in the bmcweb
8015907571dSAsmitha Karunanithi             // implementation and has nothing to do with the client's
8025907571dSAsmitha Karunanithi             // input in the request. Hence, returning internal error
8035907571dSAsmitha Karunanithi             // back to the client.
804a43be80fSAsmitha Karunanithi             messages::internalError(asyncResp->res);
805a43be80fSAsmitha Karunanithi             return;
806a43be80fSAsmitha Karunanithi         }
807a43be80fSAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
808a43be80fSAsmitha Karunanithi 
809002d39b4SEd Tanous         createDumpTaskCallback(std::move(payload), asyncResp, dumpId, dumpPath,
810002d39b4SEd Tanous                                dumpType);
811a43be80fSAsmitha Karunanithi         },
812b47452b2SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager",
813b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
814b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)),
815a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
816a43be80fSAsmitha Karunanithi }
817a43be80fSAsmitha Karunanithi 
8188d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
8198d1b46d7Szhanghch05                       const std::string& dumpType)
82080319af1SAsmitha Karunanithi {
821b47452b2SAsmitha Karunanithi     std::string dumpTypeLowerCopy =
822b47452b2SAsmitha Karunanithi         std::string(boost::algorithm::to_lower_copy(dumpType));
8238d1b46d7Szhanghch05 
82480319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
825b9d36b47SEd Tanous         [asyncResp, dumpType](
826b9d36b47SEd Tanous             const boost::system::error_code ec,
827b9d36b47SEd Tanous             const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
82880319af1SAsmitha Karunanithi         if (ec)
82980319af1SAsmitha Karunanithi         {
83080319af1SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
83180319af1SAsmitha Karunanithi             messages::internalError(asyncResp->res);
83280319af1SAsmitha Karunanithi             return;
83380319af1SAsmitha Karunanithi         }
83480319af1SAsmitha Karunanithi 
83580319af1SAsmitha Karunanithi         for (const std::string& path : subTreePaths)
83680319af1SAsmitha Karunanithi         {
8372dfd18efSEd Tanous             sdbusplus::message::object_path objPath(path);
8382dfd18efSEd Tanous             std::string logID = objPath.filename();
8392dfd18efSEd Tanous             if (logID.empty())
84080319af1SAsmitha Karunanithi             {
8412dfd18efSEd Tanous                 continue;
84280319af1SAsmitha Karunanithi             }
8432dfd18efSEd Tanous             deleteDumpEntry(asyncResp, logID, dumpType);
84480319af1SAsmitha Karunanithi         }
84580319af1SAsmitha Karunanithi         },
84680319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
84780319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
84880319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
849b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0,
850b47452b2SAsmitha Karunanithi         std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." +
851b47452b2SAsmitha Karunanithi                                    dumpType});
85280319af1SAsmitha Karunanithi }
85380319af1SAsmitha Karunanithi 
854b9d36b47SEd Tanous inline static void
855b9d36b47SEd Tanous     parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params,
856b9d36b47SEd Tanous                              std::string& filename, std::string& timestamp,
857b9d36b47SEd Tanous                              std::string& logfile)
858043a0536SJohnathan Mantey {
859043a0536SJohnathan Mantey     for (auto property : params)
860043a0536SJohnathan Mantey     {
861043a0536SJohnathan Mantey         if (property.first == "Timestamp")
862043a0536SJohnathan Mantey         {
863043a0536SJohnathan Mantey             const std::string* value =
8648d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
865043a0536SJohnathan Mantey             if (value != nullptr)
866043a0536SJohnathan Mantey             {
867043a0536SJohnathan Mantey                 timestamp = *value;
868043a0536SJohnathan Mantey             }
869043a0536SJohnathan Mantey         }
870043a0536SJohnathan Mantey         else if (property.first == "Filename")
871043a0536SJohnathan Mantey         {
872043a0536SJohnathan Mantey             const std::string* value =
8738d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
874043a0536SJohnathan Mantey             if (value != nullptr)
875043a0536SJohnathan Mantey             {
876043a0536SJohnathan Mantey                 filename = *value;
877043a0536SJohnathan Mantey             }
878043a0536SJohnathan Mantey         }
879043a0536SJohnathan Mantey         else if (property.first == "Log")
880043a0536SJohnathan Mantey         {
881043a0536SJohnathan Mantey             const std::string* value =
8828d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
883043a0536SJohnathan Mantey             if (value != nullptr)
884043a0536SJohnathan Mantey             {
885043a0536SJohnathan Mantey                 logfile = *value;
886043a0536SJohnathan Mantey             }
887043a0536SJohnathan Mantey         }
888043a0536SJohnathan Mantey     }
889043a0536SJohnathan Mantey }
890043a0536SJohnathan Mantey 
891a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
8927e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app)
8931da66f75SEd Tanous {
894c4bf6374SJason M. Bills     /**
895c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
896c4bf6374SJason M. Bills      */
8977e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/")
898ed398213SEd Tanous         .privileges(redfish::privileges::getLogServiceCollection)
899002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
900002d39b4SEd Tanous             [&app](const crow::Request& req,
901002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
9023ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
903c4bf6374SJason M. Bills         {
90445ca1b86SEd Tanous             return;
90545ca1b86SEd Tanous         }
9067e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
9077e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
908c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
909c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
910c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
911029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
91245ca1b86SEd Tanous         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
913c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
914c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
915002d39b4SEd Tanous         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
916c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
9171476687dSEd Tanous         nlohmann::json::object_t eventLog;
9181476687dSEd Tanous         eventLog["@odata.id"] =
9191476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
9201476687dSEd Tanous         logServiceArray.push_back(std::move(eventLog));
9215cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
9221476687dSEd Tanous         nlohmann::json::object_t dumpLog;
923002d39b4SEd Tanous         dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump";
9241476687dSEd Tanous         logServiceArray.push_back(std::move(dumpLog));
925c9bb6861Sraviteja-b #endif
926c9bb6861Sraviteja-b 
927d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
9281476687dSEd Tanous         nlohmann::json::object_t crashdump;
9291476687dSEd Tanous         crashdump["@odata.id"] =
9301476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump";
9311476687dSEd Tanous         logServiceArray.push_back(std::move(crashdump));
932d53dd41fSJason M. Bills #endif
933b7028ebfSSpencer Ku 
934b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
9351476687dSEd Tanous         nlohmann::json::object_t hostlogger;
9361476687dSEd Tanous         hostlogger["@odata.id"] =
9371476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/HostLogger";
9381476687dSEd Tanous         logServiceArray.push_back(std::move(hostlogger));
939b7028ebfSSpencer Ku #endif
940c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
941c4bf6374SJason M. Bills             logServiceArray.size();
942a3316fc6SZhikuiRen 
943a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
94445ca1b86SEd Tanous             [asyncResp](const boost::system::error_code ec,
945b9d36b47SEd Tanous                         const dbus::utility::MapperGetSubTreePathsResponse&
946b9d36b47SEd Tanous                             subtreePath) {
947a3316fc6SZhikuiRen             if (ec)
948a3316fc6SZhikuiRen             {
949a3316fc6SZhikuiRen                 BMCWEB_LOG_ERROR << ec;
950a3316fc6SZhikuiRen                 return;
951a3316fc6SZhikuiRen             }
952a3316fc6SZhikuiRen 
95355f79e6fSEd Tanous             for (const auto& pathStr : subtreePath)
954a3316fc6SZhikuiRen             {
955a3316fc6SZhikuiRen                 if (pathStr.find("PostCode") != std::string::npos)
956a3316fc6SZhikuiRen                 {
95723a21a1cSEd Tanous                     nlohmann::json& logServiceArrayLocal =
958a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members"];
95923a21a1cSEd Tanous                     logServiceArrayLocal.push_back(
9600fda0f12SGeorge Liu                         {{"@odata.id",
9610fda0f12SGeorge Liu                           "/redfish/v1/Systems/system/LogServices/PostCodes"}});
96245ca1b86SEd Tanous                     asyncResp->res.jsonValue["Members@odata.count"] =
96323a21a1cSEd Tanous                         logServiceArrayLocal.size();
964a3316fc6SZhikuiRen                     return;
965a3316fc6SZhikuiRen                 }
966a3316fc6SZhikuiRen             }
967a3316fc6SZhikuiRen             },
968a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper",
969a3316fc6SZhikuiRen             "/xyz/openbmc_project/object_mapper",
97045ca1b86SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
97145ca1b86SEd Tanous             std::array<const char*, 1>{postCodeIface});
9727e860f15SJohn Edward Broadbent         });
973c4bf6374SJason M. Bills }
974c4bf6374SJason M. Bills 
9757e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app)
976c4bf6374SJason M. Bills {
9777e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
978ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
979002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
980002d39b4SEd Tanous             [&app](const crow::Request& req,
981002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
9823ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
98345ca1b86SEd Tanous         {
98445ca1b86SEd Tanous             return;
98545ca1b86SEd Tanous         }
986c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
987029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
988c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
989c4bf6374SJason M. Bills             "#LogService.v1_1_0.LogService";
990c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
991002d39b4SEd Tanous         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
992c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
993c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
9947c8c4058STejas Patil 
9957c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
9962b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
9977c8c4058STejas Patil 
9987c8c4058STejas Patil         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
9997c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
10007c8c4058STejas Patil             redfishDateTimeOffset.second;
10017c8c4058STejas Patil 
10021476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
10031476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1004e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1005e7d6c8b2SGunnar Mills 
10060fda0f12SGeorge Liu             {"target",
10070fda0f12SGeorge Liu              "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}};
10087e860f15SJohn Edward Broadbent         });
1009489640c6SJason M. Bills }
1010489640c6SJason M. Bills 
10117e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app)
1012489640c6SJason M. Bills {
10134978b63fSJason M. Bills     BMCWEB_ROUTE(
10144978b63fSJason M. Bills         app,
10154978b63fSJason M. Bills         "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/")
1016432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
10177e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
101845ca1b86SEd Tanous             [&app](const crow::Request& req,
10197e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
10203ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
102145ca1b86SEd Tanous         {
102245ca1b86SEd Tanous             return;
102345ca1b86SEd Tanous         }
1024489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
1025489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1026489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
1027489640c6SJason M. Bills         {
1028489640c6SJason M. Bills             for (const std::filesystem::path& file : redfishLogFiles)
1029489640c6SJason M. Bills             {
1030489640c6SJason M. Bills                 std::error_code ec;
1031489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
1032489640c6SJason M. Bills             }
1033489640c6SJason M. Bills         }
1034489640c6SJason M. Bills 
1035489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
1036489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
1037489640c6SJason M. Bills             [asyncResp](const boost::system::error_code ec) {
1038489640c6SJason M. Bills             if (ec)
1039489640c6SJason M. Bills             {
1040002d39b4SEd Tanous                 BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
1041489640c6SJason M. Bills                 messages::internalError(asyncResp->res);
1042489640c6SJason M. Bills                 return;
1043489640c6SJason M. Bills             }
1044489640c6SJason M. Bills 
1045489640c6SJason M. Bills             messages::success(asyncResp->res);
1046489640c6SJason M. Bills             },
1047489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1048002d39b4SEd Tanous             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1049002d39b4SEd Tanous             "replace");
10507e860f15SJohn Edward Broadbent         });
1051c4bf6374SJason M. Bills }
1052c4bf6374SJason M. Bills 
1053ac992cdeSJason M. Bills enum class LogParseError
1054ac992cdeSJason M. Bills {
1055ac992cdeSJason M. Bills     success,
1056ac992cdeSJason M. Bills     parseFailed,
1057ac992cdeSJason M. Bills     messageIdNotInRegistry,
1058ac992cdeSJason M. Bills };
1059ac992cdeSJason M. Bills 
1060ac992cdeSJason M. Bills static LogParseError
1061ac992cdeSJason M. Bills     fillEventLogEntryJson(const std::string& logEntryID,
1062b5a76932SEd Tanous                           const std::string& logEntry,
1063de703c5dSJason M. Bills                           nlohmann::json::object_t& logEntryJson)
1064c4bf6374SJason M. Bills {
106595820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1066cd225da8SJason M. Bills     // First get the Timestamp
1067f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1068cd225da8SJason M. Bills     if (space == std::string::npos)
106995820184SJason M. Bills     {
1070ac992cdeSJason M. Bills         return LogParseError::parseFailed;
107195820184SJason M. Bills     }
1072cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1073cd225da8SJason M. Bills     // Then get the log contents
1074f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1075cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1076cd225da8SJason M. Bills     {
1077ac992cdeSJason M. Bills         return LogParseError::parseFailed;
1078cd225da8SJason M. Bills     }
1079cd225da8SJason M. Bills     std::string_view entry(logEntry);
1080cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1081cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1082cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1083cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1084cd225da8SJason M. Bills                  boost::token_compress_on);
1085cd225da8SJason M. Bills     // We need at least a MessageId to be valid
108626f6976fSEd Tanous     if (logEntryFields.empty())
1087cd225da8SJason M. Bills     {
1088ac992cdeSJason M. Bills         return LogParseError::parseFailed;
1089cd225da8SJason M. Bills     }
1090cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
109195820184SJason M. Bills 
10924851d45dSJason M. Bills     // Get the Message from the MessageRegistry
1093fffb8c1fSEd Tanous     const registries::Message* message = registries::getMessage(messageID);
1094c4bf6374SJason M. Bills 
109554417b02SSui Chen     if (message == nullptr)
1096c4bf6374SJason M. Bills     {
109754417b02SSui Chen         BMCWEB_LOG_WARNING << "Log entry not found in registry: " << logEntry;
1098ac992cdeSJason M. Bills         return LogParseError::messageIdNotInRegistry;
1099c4bf6374SJason M. Bills     }
1100c4bf6374SJason M. Bills 
110154417b02SSui Chen     std::string msg = message->message;
110254417b02SSui Chen 
110315a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
110426702d01SEd Tanous     std::span<std::string> messageArgs;
110515a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
110615a86ff6SJason M. Bills     {
110715a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
110815a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
110915a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
111015a86ff6SJason M. Bills         if (!messageArgsStart.empty())
111115a86ff6SJason M. Bills         {
111215a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
111315a86ff6SJason M. Bills         }
111415a86ff6SJason M. Bills 
111523a21a1cSEd Tanous         messageArgs = {&messageArgsStart, messageArgsSize};
1116c4bf6374SJason M. Bills 
11174851d45dSJason M. Bills         // Fill the MessageArgs into the Message
111895820184SJason M. Bills         int i = 0;
111995820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11204851d45dSJason M. Bills         {
112195820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11224851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11234851d45dSJason M. Bills             if (argPos != std::string::npos)
11244851d45dSJason M. Bills             {
112595820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11264851d45dSJason M. Bills             }
11274851d45dSJason M. Bills         }
112815a86ff6SJason M. Bills     }
11294851d45dSJason M. Bills 
113095820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
113195820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
113295820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1133f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1134f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
113595820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1136c4bf6374SJason M. Bills     {
113795820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1138c4bf6374SJason M. Bills     }
1139c4bf6374SJason M. Bills 
1140c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
114184afc48bSJason M. Bills     logEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
114284afc48bSJason M. Bills     logEntryJson["@odata.id"] =
114384afc48bSJason M. Bills         "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + logEntryID;
114484afc48bSJason M. Bills     logEntryJson["Name"] = "System Event Log Entry";
114584afc48bSJason M. Bills     logEntryJson["Id"] = logEntryID;
114684afc48bSJason M. Bills     logEntryJson["Message"] = std::move(msg);
114784afc48bSJason M. Bills     logEntryJson["MessageId"] = std::move(messageID);
114884afc48bSJason M. Bills     logEntryJson["MessageArgs"] = messageArgs;
114984afc48bSJason M. Bills     logEntryJson["EntryType"] = "Event";
115084afc48bSJason M. Bills     logEntryJson["Severity"] = message->messageSeverity;
115184afc48bSJason M. Bills     logEntryJson["Created"] = std::move(timestamp);
1152ac992cdeSJason M. Bills     return LogParseError::success;
1153c4bf6374SJason M. Bills }
1154c4bf6374SJason M. Bills 
11557e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app)
1156c4bf6374SJason M. Bills {
11577e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
11587e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
11598b6a35f0SGunnar Mills         .privileges(redfish::privileges::getLogEntryCollection)
1160002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1161002d39b4SEd Tanous             [&app](const crow::Request& req,
1162002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1163c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
1164c937d2bfSEd Tanous             .canDelegateTop = true,
1165c937d2bfSEd Tanous             .canDelegateSkip = true,
1166c937d2bfSEd Tanous         };
1167c937d2bfSEd Tanous         query_param::Query delegatedQuery;
1168c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
11693ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
1170c4bf6374SJason M. Bills         {
1171c4bf6374SJason M. Bills             return;
1172c4bf6374SJason M. Bills         }
11735143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
11743648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
11753648c8beSEd Tanous 
11767e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
11777e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
1178c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1179c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
1180c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1181029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1182c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1183c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1184c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
1185cb92c03bSAndrew Geissler 
11864978b63fSJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1187c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
11887e860f15SJohn Edward Broadbent         // Go through the log files and create a unique ID for each
11897e860f15SJohn Edward Broadbent         // entry
119095820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
119195820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1192b01bf299SEd Tanous         uint64_t entryCount = 0;
1193cd225da8SJason M. Bills         std::string logEntry;
119495820184SJason M. Bills 
11957e860f15SJohn Edward Broadbent         // Oldest logs are in the last file, so start there and loop
11967e860f15SJohn Edward Broadbent         // backwards
1197002d39b4SEd Tanous         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1198002d39b4SEd Tanous              it++)
1199c4bf6374SJason M. Bills         {
1200cd225da8SJason M. Bills             std::ifstream logStream(*it);
120195820184SJason M. Bills             if (!logStream.is_open())
1202c4bf6374SJason M. Bills             {
1203c4bf6374SJason M. Bills                 continue;
1204c4bf6374SJason M. Bills             }
1205c4bf6374SJason M. Bills 
1206e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
1207e85d6b16SJason M. Bills             bool firstEntry = true;
120895820184SJason M. Bills             while (std::getline(logStream, logEntry))
120995820184SJason M. Bills             {
1210c4bf6374SJason M. Bills                 std::string idStr;
1211e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1212c4bf6374SJason M. Bills                 {
1213c4bf6374SJason M. Bills                     continue;
1214c4bf6374SJason M. Bills                 }
1215e85d6b16SJason M. Bills                 firstEntry = false;
1216e85d6b16SJason M. Bills 
1217de703c5dSJason M. Bills                 nlohmann::json::object_t bmcLogEntry;
1218ac992cdeSJason M. Bills                 LogParseError status =
1219ac992cdeSJason M. Bills                     fillEventLogEntryJson(idStr, logEntry, bmcLogEntry);
1220ac992cdeSJason M. Bills                 if (status == LogParseError::messageIdNotInRegistry)
1221ac992cdeSJason M. Bills                 {
1222ac992cdeSJason M. Bills                     continue;
1223ac992cdeSJason M. Bills                 }
1224ac992cdeSJason M. Bills                 if (status != LogParseError::success)
1225c4bf6374SJason M. Bills                 {
1226c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
1227c4bf6374SJason M. Bills                     return;
1228c4bf6374SJason M. Bills                 }
1229de703c5dSJason M. Bills 
1230de703c5dSJason M. Bills                 entryCount++;
1231de703c5dSJason M. Bills                 // Handle paging using skip (number of entries to skip from the
1232de703c5dSJason M. Bills                 // start) and top (number of entries to display)
12333648c8beSEd Tanous                 if (entryCount <= skip || entryCount > skip + top)
1234de703c5dSJason M. Bills                 {
1235de703c5dSJason M. Bills                     continue;
1236de703c5dSJason M. Bills                 }
1237de703c5dSJason M. Bills 
1238de703c5dSJason M. Bills                 logEntryArray.push_back(std::move(bmcLogEntry));
1239c4bf6374SJason M. Bills             }
124095820184SJason M. Bills         }
1241c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
12423648c8beSEd Tanous         if (skip + top < entryCount)
1243c4bf6374SJason M. Bills         {
1244c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
12454978b63fSJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" +
12463648c8beSEd Tanous                 std::to_string(skip + top);
1247c4bf6374SJason M. Bills         }
12487e860f15SJohn Edward Broadbent         });
1249897967deSJason M. Bills }
1250897967deSJason M. Bills 
12517e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app)
1252897967deSJason M. Bills {
12537e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
12547e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1255ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
12567e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
125745ca1b86SEd Tanous             [&app](const crow::Request& req,
12587e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
12597e860f15SJohn Edward Broadbent                    const std::string& param) {
12603ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
126145ca1b86SEd Tanous         {
126245ca1b86SEd Tanous             return;
126345ca1b86SEd Tanous         }
12647e860f15SJohn Edward Broadbent         const std::string& targetID = param;
12658d1b46d7Szhanghch05 
12667e860f15SJohn Edward Broadbent         // Go through the log files and check the unique ID for each
12677e860f15SJohn Edward Broadbent         // entry to find the target entry
1268897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1269897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1270897967deSJason M. Bills         std::string logEntry;
1271897967deSJason M. Bills 
12727e860f15SJohn Edward Broadbent         // Oldest logs are in the last file, so start there and loop
12737e860f15SJohn Edward Broadbent         // backwards
1274002d39b4SEd Tanous         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1275002d39b4SEd Tanous              it++)
1276897967deSJason M. Bills         {
1277897967deSJason M. Bills             std::ifstream logStream(*it);
1278897967deSJason M. Bills             if (!logStream.is_open())
1279897967deSJason M. Bills             {
1280897967deSJason M. Bills                 continue;
1281897967deSJason M. Bills             }
1282897967deSJason M. Bills 
1283897967deSJason M. Bills             // Reset the unique ID on the first entry
1284897967deSJason M. Bills             bool firstEntry = true;
1285897967deSJason M. Bills             while (std::getline(logStream, logEntry))
1286897967deSJason M. Bills             {
1287897967deSJason M. Bills                 std::string idStr;
1288897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1289897967deSJason M. Bills                 {
1290897967deSJason M. Bills                     continue;
1291897967deSJason M. Bills                 }
1292897967deSJason M. Bills                 firstEntry = false;
1293897967deSJason M. Bills 
1294897967deSJason M. Bills                 if (idStr == targetID)
1295897967deSJason M. Bills                 {
1296de703c5dSJason M. Bills                     nlohmann::json::object_t bmcLogEntry;
1297ac992cdeSJason M. Bills                     LogParseError status =
1298ac992cdeSJason M. Bills                         fillEventLogEntryJson(idStr, logEntry, bmcLogEntry);
1299ac992cdeSJason M. Bills                     if (status != LogParseError::success)
1300897967deSJason M. Bills                     {
1301897967deSJason M. Bills                         messages::internalError(asyncResp->res);
1302897967deSJason M. Bills                         return;
1303897967deSJason M. Bills                     }
1304d405bb51SJason M. Bills                     asyncResp->res.jsonValue.update(bmcLogEntry);
1305897967deSJason M. Bills                     return;
1306897967deSJason M. Bills                 }
1307897967deSJason M. Bills             }
1308897967deSJason M. Bills         }
1309897967deSJason M. Bills         // Requested ID was not found
1310002d39b4SEd Tanous         messages::resourceMissingAtURI(asyncResp->res,
1311002d39b4SEd Tanous                                        crow::utility::urlFromPieces(targetID));
13127e860f15SJohn Edward Broadbent         });
131308a4e4b5SAnthony Wilson }
131408a4e4b5SAnthony Wilson 
13157e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app)
131608a4e4b5SAnthony Wilson {
13177e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
13187e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1319ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
1320002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1321002d39b4SEd Tanous             [&app](const crow::Request& req,
1322002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
13233ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
132445ca1b86SEd Tanous         {
132545ca1b86SEd Tanous             return;
132645ca1b86SEd Tanous         }
13277e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
13287e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
132908a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
133008a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
133108a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
133208a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
133308a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
133408a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
133508a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
133608a4e4b5SAnthony Wilson 
1337cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1338cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1339cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1340cb92c03bSAndrew Geissler             [asyncResp](const boost::system::error_code ec,
1341914e2d5dSEd Tanous                         const dbus::utility::ManagedObjectType& resp) {
1342cb92c03bSAndrew Geissler             if (ec)
1343cb92c03bSAndrew Geissler             {
1344cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
1345cb92c03bSAndrew Geissler                 BMCWEB_LOG_ERROR
1346002d39b4SEd Tanous                     << "getLogEntriesIfaceData resp_handler got error " << ec;
1347cb92c03bSAndrew Geissler                 messages::internalError(asyncResp->res);
1348cb92c03bSAndrew Geissler                 return;
1349cb92c03bSAndrew Geissler             }
1350002d39b4SEd Tanous             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
1351cb92c03bSAndrew Geissler             entriesArray = nlohmann::json::array();
13529eb808c1SEd Tanous             for (const auto& objectPath : resp)
1353cb92c03bSAndrew Geissler             {
1354914e2d5dSEd Tanous                 const uint32_t* id = nullptr;
1355c419c759SEd Tanous                 const uint64_t* timestamp = nullptr;
1356c419c759SEd Tanous                 const uint64_t* updateTimestamp = nullptr;
1357914e2d5dSEd Tanous                 const std::string* severity = nullptr;
1358914e2d5dSEd Tanous                 const std::string* message = nullptr;
1359914e2d5dSEd Tanous                 const std::string* filePath = nullptr;
136075710de2SXiaochao Ma                 bool resolved = false;
13619eb808c1SEd Tanous                 for (const auto& interfaceMap : objectPath.second)
1362f86bb901SAdriana Kobylak                 {
1363f86bb901SAdriana Kobylak                     if (interfaceMap.first ==
1364f86bb901SAdriana Kobylak                         "xyz.openbmc_project.Logging.Entry")
1365f86bb901SAdriana Kobylak                     {
1366002d39b4SEd Tanous                         for (const auto& propertyMap : interfaceMap.second)
1367cb92c03bSAndrew Geissler                         {
1368cb92c03bSAndrew Geissler                             if (propertyMap.first == "Id")
1369cb92c03bSAndrew Geissler                             {
1370002d39b4SEd Tanous                                 id = std::get_if<uint32_t>(&propertyMap.second);
1371cb92c03bSAndrew Geissler                             }
1372cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Timestamp")
1373cb92c03bSAndrew Geissler                             {
1374002d39b4SEd Tanous                                 timestamp =
1375002d39b4SEd Tanous                                     std::get_if<uint64_t>(&propertyMap.second);
13767e860f15SJohn Edward Broadbent                             }
1377002d39b4SEd Tanous                             else if (propertyMap.first == "UpdateTimestamp")
13787e860f15SJohn Edward Broadbent                             {
1379002d39b4SEd Tanous                                 updateTimestamp =
1380002d39b4SEd Tanous                                     std::get_if<uint64_t>(&propertyMap.second);
13817e860f15SJohn Edward Broadbent                             }
13827e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Severity")
13837e860f15SJohn Edward Broadbent                             {
13847e860f15SJohn Edward Broadbent                                 severity = std::get_if<std::string>(
13857e860f15SJohn Edward Broadbent                                     &propertyMap.second);
13867e860f15SJohn Edward Broadbent                             }
13877e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Message")
13887e860f15SJohn Edward Broadbent                             {
13897e860f15SJohn Edward Broadbent                                 message = std::get_if<std::string>(
13907e860f15SJohn Edward Broadbent                                     &propertyMap.second);
13917e860f15SJohn Edward Broadbent                             }
13927e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Resolved")
13937e860f15SJohn Edward Broadbent                             {
1394914e2d5dSEd Tanous                                 const bool* resolveptr =
1395002d39b4SEd Tanous                                     std::get_if<bool>(&propertyMap.second);
13967e860f15SJohn Edward Broadbent                                 if (resolveptr == nullptr)
13977e860f15SJohn Edward Broadbent                                 {
1398002d39b4SEd Tanous                                     messages::internalError(asyncResp->res);
13997e860f15SJohn Edward Broadbent                                     return;
14007e860f15SJohn Edward Broadbent                                 }
14017e860f15SJohn Edward Broadbent                                 resolved = *resolveptr;
14027e860f15SJohn Edward Broadbent                             }
14037e860f15SJohn Edward Broadbent                         }
14047e860f15SJohn Edward Broadbent                         if (id == nullptr || message == nullptr ||
14057e860f15SJohn Edward Broadbent                             severity == nullptr)
14067e860f15SJohn Edward Broadbent                         {
14077e860f15SJohn Edward Broadbent                             messages::internalError(asyncResp->res);
14087e860f15SJohn Edward Broadbent                             return;
14097e860f15SJohn Edward Broadbent                         }
14107e860f15SJohn Edward Broadbent                     }
14117e860f15SJohn Edward Broadbent                     else if (interfaceMap.first ==
14127e860f15SJohn Edward Broadbent                              "xyz.openbmc_project.Common.FilePath")
14137e860f15SJohn Edward Broadbent                     {
1414002d39b4SEd Tanous                         for (const auto& propertyMap : interfaceMap.second)
14157e860f15SJohn Edward Broadbent                         {
14167e860f15SJohn Edward Broadbent                             if (propertyMap.first == "Path")
14177e860f15SJohn Edward Broadbent                             {
14187e860f15SJohn Edward Broadbent                                 filePath = std::get_if<std::string>(
14197e860f15SJohn Edward Broadbent                                     &propertyMap.second);
14207e860f15SJohn Edward Broadbent                             }
14217e860f15SJohn Edward Broadbent                         }
14227e860f15SJohn Edward Broadbent                     }
14237e860f15SJohn Edward Broadbent                 }
14247e860f15SJohn Edward Broadbent                 // Object path without the
14257e860f15SJohn Edward Broadbent                 // xyz.openbmc_project.Logging.Entry interface, ignore
14267e860f15SJohn Edward Broadbent                 // and continue.
14277e860f15SJohn Edward Broadbent                 if (id == nullptr || message == nullptr ||
1428c419c759SEd Tanous                     severity == nullptr || timestamp == nullptr ||
1429c419c759SEd Tanous                     updateTimestamp == nullptr)
14307e860f15SJohn Edward Broadbent                 {
14317e860f15SJohn Edward Broadbent                     continue;
14327e860f15SJohn Edward Broadbent                 }
14337e860f15SJohn Edward Broadbent                 entriesArray.push_back({});
14347e860f15SJohn Edward Broadbent                 nlohmann::json& thisEntry = entriesArray.back();
14357e860f15SJohn Edward Broadbent                 thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
14367e860f15SJohn Edward Broadbent                 thisEntry["@odata.id"] =
14370fda0f12SGeorge Liu                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
14387e860f15SJohn Edward Broadbent                     std::to_string(*id);
14397e860f15SJohn Edward Broadbent                 thisEntry["Name"] = "System Event Log Entry";
14407e860f15SJohn Edward Broadbent                 thisEntry["Id"] = std::to_string(*id);
14417e860f15SJohn Edward Broadbent                 thisEntry["Message"] = *message;
14427e860f15SJohn Edward Broadbent                 thisEntry["Resolved"] = resolved;
14437e860f15SJohn Edward Broadbent                 thisEntry["EntryType"] = "Event";
14447e860f15SJohn Edward Broadbent                 thisEntry["Severity"] =
14457e860f15SJohn Edward Broadbent                     translateSeverityDbusToRedfish(*severity);
14467e860f15SJohn Edward Broadbent                 thisEntry["Created"] =
14472b82937eSEd Tanous                     redfish::time_utils::getDateTimeUintMs(*timestamp);
14487e860f15SJohn Edward Broadbent                 thisEntry["Modified"] =
14492b82937eSEd Tanous                     redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
14507e860f15SJohn Edward Broadbent                 if (filePath != nullptr)
14517e860f15SJohn Edward Broadbent                 {
14527e860f15SJohn Edward Broadbent                     thisEntry["AdditionalDataURI"] =
14530fda0f12SGeorge Liu                         "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
14547e860f15SJohn Edward Broadbent                         std::to_string(*id) + "/attachment";
14557e860f15SJohn Edward Broadbent                 }
14567e860f15SJohn Edward Broadbent             }
1457002d39b4SEd Tanous             std::sort(
1458002d39b4SEd Tanous                 entriesArray.begin(), entriesArray.end(),
1459002d39b4SEd Tanous                 [](const nlohmann::json& left, const nlohmann::json& right) {
14607e860f15SJohn Edward Broadbent                 return (left["Id"] <= right["Id"]);
14617e860f15SJohn Edward Broadbent                 });
14627e860f15SJohn Edward Broadbent             asyncResp->res.jsonValue["Members@odata.count"] =
14637e860f15SJohn Edward Broadbent                 entriesArray.size();
14647e860f15SJohn Edward Broadbent             },
14657e860f15SJohn Edward Broadbent             "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
14667e860f15SJohn Edward Broadbent             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
14677e860f15SJohn Edward Broadbent         });
14687e860f15SJohn Edward Broadbent }
14697e860f15SJohn Edward Broadbent 
14707e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app)
14717e860f15SJohn Edward Broadbent {
14727e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
14737e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1474ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
1475002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1476002d39b4SEd Tanous             [&app](const crow::Request& req,
14777e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
147845ca1b86SEd Tanous                    const std::string& param) {
14793ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
14807e860f15SJohn Edward Broadbent         {
148145ca1b86SEd Tanous             return;
148245ca1b86SEd Tanous         }
14837e860f15SJohn Edward Broadbent         std::string entryID = param;
14847e860f15SJohn Edward Broadbent         dbus::utility::escapePathForDbus(entryID);
14857e860f15SJohn Edward Broadbent 
14867e860f15SJohn Edward Broadbent         // DBus implementation of EventLog/Entries
14877e860f15SJohn Edward Broadbent         // Make call to Logging Service to find all log entry objects
14887e860f15SJohn Edward Broadbent         crow::connections::systemBus->async_method_call(
1489002d39b4SEd Tanous             [asyncResp, entryID](const boost::system::error_code ec,
1490b9d36b47SEd Tanous                                  const dbus::utility::DBusPropertiesMap& resp) {
14917e860f15SJohn Edward Broadbent             if (ec.value() == EBADR)
14927e860f15SJohn Edward Broadbent             {
1493002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1494002d39b4SEd Tanous                                            entryID);
14957e860f15SJohn Edward Broadbent                 return;
14967e860f15SJohn Edward Broadbent             }
14977e860f15SJohn Edward Broadbent             if (ec)
14987e860f15SJohn Edward Broadbent             {
14990fda0f12SGeorge Liu                 BMCWEB_LOG_ERROR
1500002d39b4SEd Tanous                     << "EventLogEntry (DBus) resp_handler got error " << ec;
15017e860f15SJohn Edward Broadbent                 messages::internalError(asyncResp->res);
15027e860f15SJohn Edward Broadbent                 return;
15037e860f15SJohn Edward Broadbent             }
1504914e2d5dSEd Tanous             const uint32_t* id = nullptr;
1505c419c759SEd Tanous             const uint64_t* timestamp = nullptr;
1506c419c759SEd Tanous             const uint64_t* updateTimestamp = nullptr;
1507914e2d5dSEd Tanous             const std::string* severity = nullptr;
1508914e2d5dSEd Tanous             const std::string* message = nullptr;
1509914e2d5dSEd Tanous             const std::string* filePath = nullptr;
15107e860f15SJohn Edward Broadbent             bool resolved = false;
15117e860f15SJohn Edward Broadbent 
15129eb808c1SEd Tanous             for (const auto& propertyMap : resp)
15137e860f15SJohn Edward Broadbent             {
15147e860f15SJohn Edward Broadbent                 if (propertyMap.first == "Id")
15157e860f15SJohn Edward Broadbent                 {
15167e860f15SJohn Edward Broadbent                     id = std::get_if<uint32_t>(&propertyMap.second);
15177e860f15SJohn Edward Broadbent                 }
15187e860f15SJohn Edward Broadbent                 else if (propertyMap.first == "Timestamp")
15197e860f15SJohn Edward Broadbent                 {
1520002d39b4SEd Tanous                     timestamp = std::get_if<uint64_t>(&propertyMap.second);
1521ebd45906SGeorge Liu                 }
1522d139c236SGeorge Liu                 else if (propertyMap.first == "UpdateTimestamp")
1523d139c236SGeorge Liu                 {
1524ebd45906SGeorge Liu                     updateTimestamp =
1525c419c759SEd Tanous                         std::get_if<uint64_t>(&propertyMap.second);
1526ebd45906SGeorge Liu                 }
1527cb92c03bSAndrew Geissler                 else if (propertyMap.first == "Severity")
1528cb92c03bSAndrew Geissler                 {
1529002d39b4SEd Tanous                     severity = std::get_if<std::string>(&propertyMap.second);
1530cb92c03bSAndrew Geissler                 }
1531cb92c03bSAndrew Geissler                 else if (propertyMap.first == "Message")
1532cb92c03bSAndrew Geissler                 {
1533002d39b4SEd Tanous                     message = std::get_if<std::string>(&propertyMap.second);
1534ae34c8e8SAdriana Kobylak                 }
153575710de2SXiaochao Ma                 else if (propertyMap.first == "Resolved")
153675710de2SXiaochao Ma                 {
1537914e2d5dSEd Tanous                     const bool* resolveptr =
153875710de2SXiaochao Ma                         std::get_if<bool>(&propertyMap.second);
153975710de2SXiaochao Ma                     if (resolveptr == nullptr)
154075710de2SXiaochao Ma                     {
154175710de2SXiaochao Ma                         messages::internalError(asyncResp->res);
154275710de2SXiaochao Ma                         return;
154375710de2SXiaochao Ma                     }
154475710de2SXiaochao Ma                     resolved = *resolveptr;
154575710de2SXiaochao Ma                 }
15467e860f15SJohn Edward Broadbent                 else if (propertyMap.first == "Path")
1547f86bb901SAdriana Kobylak                 {
1548002d39b4SEd Tanous                     filePath = std::get_if<std::string>(&propertyMap.second);
1549f86bb901SAdriana Kobylak                 }
1550f86bb901SAdriana Kobylak             }
1551002d39b4SEd Tanous             if (id == nullptr || message == nullptr || severity == nullptr ||
1552002d39b4SEd Tanous                 timestamp == nullptr || updateTimestamp == nullptr)
1553f86bb901SAdriana Kobylak             {
1554ae34c8e8SAdriana Kobylak                 messages::internalError(asyncResp->res);
1555271584abSEd Tanous                 return;
1556271584abSEd Tanous             }
1557f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["@odata.type"] =
1558f86bb901SAdriana Kobylak                 "#LogEntry.v1_8_0.LogEntry";
1559f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["@odata.id"] =
15600fda0f12SGeorge Liu                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1561f86bb901SAdriana Kobylak                 std::to_string(*id);
156245ca1b86SEd Tanous             asyncResp->res.jsonValue["Name"] = "System Event Log Entry";
1563f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1564f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Message"] = *message;
1565f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Resolved"] = resolved;
1566f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["EntryType"] = "Event";
1567f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Severity"] =
1568f86bb901SAdriana Kobylak                 translateSeverityDbusToRedfish(*severity);
1569f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Created"] =
15702b82937eSEd Tanous                 redfish::time_utils::getDateTimeUintMs(*timestamp);
1571f86bb901SAdriana Kobylak             asyncResp->res.jsonValue["Modified"] =
15722b82937eSEd Tanous                 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
1573f86bb901SAdriana Kobylak             if (filePath != nullptr)
1574f86bb901SAdriana Kobylak             {
1575f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["AdditionalDataURI"] =
1576e7dbd530SPotin Lai                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1577e7dbd530SPotin Lai                     std::to_string(*id) + "/attachment";
1578f86bb901SAdriana Kobylak             }
1579cb92c03bSAndrew Geissler             },
1580cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging",
1581cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging/entry/" + entryID,
1582f86bb901SAdriana Kobylak             "org.freedesktop.DBus.Properties", "GetAll", "");
15837e860f15SJohn Edward Broadbent         });
1584336e96c6SChicago Duan 
15857e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
15867e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1587ed398213SEd Tanous         .privileges(redfish::privileges::patchLogEntry)
15887e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::patch)(
158945ca1b86SEd Tanous             [&app](const crow::Request& req,
15907e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
15917e860f15SJohn Edward Broadbent                    const std::string& entryId) {
15923ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
159345ca1b86SEd Tanous         {
159445ca1b86SEd Tanous             return;
159545ca1b86SEd Tanous         }
159675710de2SXiaochao Ma         std::optional<bool> resolved;
159775710de2SXiaochao Ma 
159815ed6780SWilly Tu         if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved",
15997e860f15SJohn Edward Broadbent                                       resolved))
160075710de2SXiaochao Ma         {
160175710de2SXiaochao Ma             return;
160275710de2SXiaochao Ma         }
160375710de2SXiaochao Ma         BMCWEB_LOG_DEBUG << "Set Resolved";
160475710de2SXiaochao Ma 
160575710de2SXiaochao Ma         crow::connections::systemBus->async_method_call(
16064f48d5f6SEd Tanous             [asyncResp, entryId](const boost::system::error_code ec) {
160775710de2SXiaochao Ma             if (ec)
160875710de2SXiaochao Ma             {
160975710de2SXiaochao Ma                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
161075710de2SXiaochao Ma                 messages::internalError(asyncResp->res);
161175710de2SXiaochao Ma                 return;
161275710de2SXiaochao Ma             }
161375710de2SXiaochao Ma             },
161475710de2SXiaochao Ma             "xyz.openbmc_project.Logging",
161575710de2SXiaochao Ma             "/xyz/openbmc_project/logging/entry/" + entryId,
161675710de2SXiaochao Ma             "org.freedesktop.DBus.Properties", "Set",
161775710de2SXiaochao Ma             "xyz.openbmc_project.Logging.Entry", "Resolved",
1618168e20c1SEd Tanous             dbus::utility::DbusVariantType(*resolved));
16197e860f15SJohn Edward Broadbent         });
162075710de2SXiaochao Ma 
16217e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
16227e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1623ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
1624ed398213SEd Tanous 
1625002d39b4SEd Tanous         .methods(boost::beast::http::verb::delete_)(
1626002d39b4SEd Tanous             [&app](const crow::Request& req,
1627002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
162845ca1b86SEd Tanous                    const std::string& param) {
16293ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
1630336e96c6SChicago Duan         {
163145ca1b86SEd Tanous             return;
163245ca1b86SEd Tanous         }
1633336e96c6SChicago Duan         BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1634336e96c6SChicago Duan 
16357e860f15SJohn Edward Broadbent         std::string entryID = param;
1636336e96c6SChicago Duan 
1637336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
1638336e96c6SChicago Duan 
1639336e96c6SChicago Duan         // Process response from Logging service.
1640002d39b4SEd Tanous         auto respHandler =
1641002d39b4SEd Tanous             [asyncResp, entryID](const boost::system::error_code ec) {
1642002d39b4SEd Tanous             BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1643336e96c6SChicago Duan             if (ec)
1644336e96c6SChicago Duan             {
16453de8d8baSGeorge Liu                 if (ec.value() == EBADR)
16463de8d8baSGeorge Liu                 {
164745ca1b86SEd Tanous                     messages::resourceNotFound(asyncResp->res, "LogEntry",
164845ca1b86SEd Tanous                                                entryID);
16493de8d8baSGeorge Liu                     return;
16503de8d8baSGeorge Liu                 }
1651336e96c6SChicago Duan                 // TODO Handle for specific error code
16520fda0f12SGeorge Liu                 BMCWEB_LOG_ERROR
16530fda0f12SGeorge Liu                     << "EventLogEntry (DBus) doDelete respHandler got error "
1654336e96c6SChicago Duan                     << ec;
1655336e96c6SChicago Duan                 asyncResp->res.result(
1656336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
1657336e96c6SChicago Duan                 return;
1658336e96c6SChicago Duan             }
1659336e96c6SChicago Duan 
1660336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
1661336e96c6SChicago Duan         };
1662336e96c6SChicago Duan 
1663336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
1664336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
1665336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
1666336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
1667336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
16687e860f15SJohn Edward Broadbent         });
1669400fd1fbSAdriana Kobylak }
1670400fd1fbSAdriana Kobylak 
16717e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app)
1672400fd1fbSAdriana Kobylak {
16730fda0f12SGeorge Liu     BMCWEB_ROUTE(
16740fda0f12SGeorge Liu         app,
16750fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment")
1676ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
16777e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
167845ca1b86SEd Tanous             [&app](const crow::Request& req,
16797e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
168045ca1b86SEd Tanous                    const std::string& param) {
16813ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
16827e860f15SJohn Edward Broadbent         {
168345ca1b86SEd Tanous             return;
168445ca1b86SEd Tanous         }
1685002d39b4SEd Tanous         if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept")))
1686400fd1fbSAdriana Kobylak         {
1687002d39b4SEd Tanous             asyncResp->res.result(boost::beast::http::status::bad_request);
1688400fd1fbSAdriana Kobylak             return;
1689400fd1fbSAdriana Kobylak         }
1690400fd1fbSAdriana Kobylak 
16917e860f15SJohn Edward Broadbent         std::string entryID = param;
1692400fd1fbSAdriana Kobylak         dbus::utility::escapePathForDbus(entryID);
1693400fd1fbSAdriana Kobylak 
1694400fd1fbSAdriana Kobylak         crow::connections::systemBus->async_method_call(
1695002d39b4SEd Tanous             [asyncResp, entryID](const boost::system::error_code ec,
1696400fd1fbSAdriana Kobylak                                  const sdbusplus::message::unix_fd& unixfd) {
1697400fd1fbSAdriana Kobylak             if (ec.value() == EBADR)
1698400fd1fbSAdriana Kobylak             {
1699002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "EventLogAttachment",
1700002d39b4SEd Tanous                                            entryID);
1701400fd1fbSAdriana Kobylak                 return;
1702400fd1fbSAdriana Kobylak             }
1703400fd1fbSAdriana Kobylak             if (ec)
1704400fd1fbSAdriana Kobylak             {
1705400fd1fbSAdriana Kobylak                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1706400fd1fbSAdriana Kobylak                 messages::internalError(asyncResp->res);
1707400fd1fbSAdriana Kobylak                 return;
1708400fd1fbSAdriana Kobylak             }
1709400fd1fbSAdriana Kobylak 
1710400fd1fbSAdriana Kobylak             int fd = -1;
1711400fd1fbSAdriana Kobylak             fd = dup(unixfd);
1712400fd1fbSAdriana Kobylak             if (fd == -1)
1713400fd1fbSAdriana Kobylak             {
1714400fd1fbSAdriana Kobylak                 messages::internalError(asyncResp->res);
1715400fd1fbSAdriana Kobylak                 return;
1716400fd1fbSAdriana Kobylak             }
1717400fd1fbSAdriana Kobylak 
1718400fd1fbSAdriana Kobylak             long long int size = lseek(fd, 0, SEEK_END);
1719400fd1fbSAdriana Kobylak             if (size == -1)
1720400fd1fbSAdriana Kobylak             {
1721400fd1fbSAdriana Kobylak                 messages::internalError(asyncResp->res);
1722400fd1fbSAdriana Kobylak                 return;
1723400fd1fbSAdriana Kobylak             }
1724400fd1fbSAdriana Kobylak 
1725400fd1fbSAdriana Kobylak             // Arbitrary max size of 64kb
1726400fd1fbSAdriana Kobylak             constexpr int maxFileSize = 65536;
1727400fd1fbSAdriana Kobylak             if (size > maxFileSize)
1728400fd1fbSAdriana Kobylak             {
1729002d39b4SEd Tanous                 BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of "
1730400fd1fbSAdriana Kobylak                                  << maxFileSize;
1731400fd1fbSAdriana Kobylak                 messages::internalError(asyncResp->res);
1732400fd1fbSAdriana Kobylak                 return;
1733400fd1fbSAdriana Kobylak             }
1734400fd1fbSAdriana Kobylak             std::vector<char> data(static_cast<size_t>(size));
1735400fd1fbSAdriana Kobylak             long long int rc = lseek(fd, 0, SEEK_SET);
1736400fd1fbSAdriana Kobylak             if (rc == -1)
1737400fd1fbSAdriana Kobylak             {
1738400fd1fbSAdriana Kobylak                 messages::internalError(asyncResp->res);
1739400fd1fbSAdriana Kobylak                 return;
1740400fd1fbSAdriana Kobylak             }
1741400fd1fbSAdriana Kobylak             rc = read(fd, data.data(), data.size());
1742400fd1fbSAdriana Kobylak             if ((rc == -1) || (rc != size))
1743400fd1fbSAdriana Kobylak             {
1744400fd1fbSAdriana Kobylak                 messages::internalError(asyncResp->res);
1745400fd1fbSAdriana Kobylak                 return;
1746400fd1fbSAdriana Kobylak             }
1747400fd1fbSAdriana Kobylak             close(fd);
1748400fd1fbSAdriana Kobylak 
1749400fd1fbSAdriana Kobylak             std::string_view strData(data.data(), data.size());
1750002d39b4SEd Tanous             std::string output = crow::utility::base64encode(strData);
1751400fd1fbSAdriana Kobylak 
1752d9f6c621SEd Tanous             asyncResp->res.addHeader(boost::beast::http::field::content_type,
1753400fd1fbSAdriana Kobylak                                      "application/octet-stream");
1754d9f6c621SEd Tanous             asyncResp->res.addHeader(
1755d9f6c621SEd Tanous                 boost::beast::http::field::content_transfer_encoding, "Base64");
1756400fd1fbSAdriana Kobylak             asyncResp->res.body() = std::move(output);
1757400fd1fbSAdriana Kobylak             },
1758400fd1fbSAdriana Kobylak             "xyz.openbmc_project.Logging",
1759400fd1fbSAdriana Kobylak             "/xyz/openbmc_project/logging/entry/" + entryID,
1760400fd1fbSAdriana Kobylak             "xyz.openbmc_project.Logging.Entry", "GetEntry");
17617e860f15SJohn Edward Broadbent         });
17621da66f75SEd Tanous }
17631da66f75SEd Tanous 
1764b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console";
1765b7028ebfSSpencer Ku 
1766b7028ebfSSpencer Ku inline bool
1767b7028ebfSSpencer Ku     getHostLoggerFiles(const std::string& hostLoggerFilePath,
1768b7028ebfSSpencer Ku                        std::vector<std::filesystem::path>& hostLoggerFiles)
1769b7028ebfSSpencer Ku {
1770b7028ebfSSpencer Ku     std::error_code ec;
1771b7028ebfSSpencer Ku     std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec);
1772b7028ebfSSpencer Ku     if (ec)
1773b7028ebfSSpencer Ku     {
1774b7028ebfSSpencer Ku         BMCWEB_LOG_ERROR << ec.message();
1775b7028ebfSSpencer Ku         return false;
1776b7028ebfSSpencer Ku     }
1777b7028ebfSSpencer Ku     for (const std::filesystem::directory_entry& it : logPath)
1778b7028ebfSSpencer Ku     {
1779b7028ebfSSpencer Ku         std::string filename = it.path().filename();
1780b7028ebfSSpencer Ku         // Prefix of each log files is "log". Find the file and save the
1781b7028ebfSSpencer Ku         // path
178211ba3979SEd Tanous         if (filename.starts_with("log"))
1783b7028ebfSSpencer Ku         {
1784b7028ebfSSpencer Ku             hostLoggerFiles.emplace_back(it.path());
1785b7028ebfSSpencer Ku         }
1786b7028ebfSSpencer Ku     }
1787b7028ebfSSpencer Ku     // As the log files rotate, they are appended with a ".#" that is higher for
1788b7028ebfSSpencer Ku     // the older logs. Since we start from oldest logs, sort the name in
1789b7028ebfSSpencer Ku     // descending order.
1790b7028ebfSSpencer Ku     std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(),
1791b7028ebfSSpencer Ku               AlphanumLess<std::string>());
1792b7028ebfSSpencer Ku 
1793b7028ebfSSpencer Ku     return true;
1794b7028ebfSSpencer Ku }
1795b7028ebfSSpencer Ku 
179602cad96eSEd Tanous inline bool getHostLoggerEntries(
179702cad96eSEd Tanous     const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip,
179802cad96eSEd Tanous     uint64_t top, std::vector<std::string>& logEntries, size_t& logCount)
1799b7028ebfSSpencer Ku {
1800b7028ebfSSpencer Ku     GzFileReader logFile;
1801b7028ebfSSpencer Ku 
1802b7028ebfSSpencer Ku     // Go though all log files and expose host logs.
1803b7028ebfSSpencer Ku     for (const std::filesystem::path& it : hostLoggerFiles)
1804b7028ebfSSpencer Ku     {
1805b7028ebfSSpencer Ku         if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount))
1806b7028ebfSSpencer Ku         {
1807b7028ebfSSpencer Ku             BMCWEB_LOG_ERROR << "fail to expose host logs";
1808b7028ebfSSpencer Ku             return false;
1809b7028ebfSSpencer Ku         }
1810b7028ebfSSpencer Ku     }
1811b7028ebfSSpencer Ku     // Get lastMessage from constructor by getter
1812b7028ebfSSpencer Ku     std::string lastMessage = logFile.getLastMessage();
1813b7028ebfSSpencer Ku     if (!lastMessage.empty())
1814b7028ebfSSpencer Ku     {
1815b7028ebfSSpencer Ku         logCount++;
1816b7028ebfSSpencer Ku         if (logCount > skip && logCount <= (skip + top))
1817b7028ebfSSpencer Ku         {
1818b7028ebfSSpencer Ku             logEntries.push_back(lastMessage);
1819b7028ebfSSpencer Ku         }
1820b7028ebfSSpencer Ku     }
1821b7028ebfSSpencer Ku     return true;
1822b7028ebfSSpencer Ku }
1823b7028ebfSSpencer Ku 
1824b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID,
1825b7028ebfSSpencer Ku                                     const std::string& msg,
18266d6574c9SJason M. Bills                                     nlohmann::json::object_t& logEntryJson)
1827b7028ebfSSpencer Ku {
1828b7028ebfSSpencer Ku     // Fill in the log entry with the gathered data.
18296d6574c9SJason M. Bills     logEntryJson["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
18306d6574c9SJason M. Bills     logEntryJson["@odata.id"] =
1831b7028ebfSSpencer Ku         "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" +
18326d6574c9SJason M. Bills         logEntryID;
18336d6574c9SJason M. Bills     logEntryJson["Name"] = "Host Logger Entry";
18346d6574c9SJason M. Bills     logEntryJson["Id"] = logEntryID;
18356d6574c9SJason M. Bills     logEntryJson["Message"] = msg;
18366d6574c9SJason M. Bills     logEntryJson["EntryType"] = "Oem";
18376d6574c9SJason M. Bills     logEntryJson["Severity"] = "OK";
18386d6574c9SJason M. Bills     logEntryJson["OemRecordFormat"] = "Host Logger Entry";
1839b7028ebfSSpencer Ku }
1840b7028ebfSSpencer Ku 
1841b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app)
1842b7028ebfSSpencer Ku {
1843b7028ebfSSpencer Ku     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/")
1844b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogService)
18451476687dSEd Tanous         .methods(boost::beast::http::verb::get)(
18461476687dSEd Tanous             [&app](const crow::Request& req,
18471476687dSEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
18483ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
184945ca1b86SEd Tanous         {
185045ca1b86SEd Tanous             return;
185145ca1b86SEd Tanous         }
1852b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.id"] =
1853b7028ebfSSpencer Ku             "/redfish/v1/Systems/system/LogServices/HostLogger";
1854b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.type"] =
1855b7028ebfSSpencer Ku             "#LogService.v1_1_0.LogService";
1856b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Name"] = "Host Logger Service";
1857b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Description"] = "Host Logger Service";
1858b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Id"] = "HostLogger";
18591476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
18601476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
1861b7028ebfSSpencer Ku         });
1862b7028ebfSSpencer Ku }
1863b7028ebfSSpencer Ku 
1864b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app)
1865b7028ebfSSpencer Ku {
1866b7028ebfSSpencer Ku     BMCWEB_ROUTE(app,
1867b7028ebfSSpencer Ku                  "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/")
1868b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogEntry)
1869002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
1870002d39b4SEd Tanous             [&app](const crow::Request& req,
1871002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1872c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
1873c937d2bfSEd Tanous             .canDelegateTop = true,
1874c937d2bfSEd Tanous             .canDelegateSkip = true,
1875c937d2bfSEd Tanous         };
1876c937d2bfSEd Tanous         query_param::Query delegatedQuery;
1877c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
18783ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
1879b7028ebfSSpencer Ku         {
1880b7028ebfSSpencer Ku             return;
1881b7028ebfSSpencer Ku         }
1882b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.id"] =
1883b7028ebfSSpencer Ku             "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
1884b7028ebfSSpencer Ku         asyncResp->res.jsonValue["@odata.type"] =
1885b7028ebfSSpencer Ku             "#LogEntryCollection.LogEntryCollection";
1886b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Name"] = "HostLogger Entries";
1887b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Description"] =
1888b7028ebfSSpencer Ku             "Collection of HostLogger Entries";
18890fda0f12SGeorge Liu         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1890b7028ebfSSpencer Ku         logEntryArray = nlohmann::json::array();
1891b7028ebfSSpencer Ku         asyncResp->res.jsonValue["Members@odata.count"] = 0;
1892b7028ebfSSpencer Ku 
1893b7028ebfSSpencer Ku         std::vector<std::filesystem::path> hostLoggerFiles;
1894b7028ebfSSpencer Ku         if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
1895b7028ebfSSpencer Ku         {
1896b7028ebfSSpencer Ku             BMCWEB_LOG_ERROR << "fail to get host log file path";
1897b7028ebfSSpencer Ku             return;
1898b7028ebfSSpencer Ku         }
18993648c8beSEd Tanous         // If we weren't provided top and skip limits, use the defaults.
19003648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
19015143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
1902b7028ebfSSpencer Ku         size_t logCount = 0;
1903b7028ebfSSpencer Ku         // This vector only store the entries we want to expose that
1904b7028ebfSSpencer Ku         // control by skip and top.
1905b7028ebfSSpencer Ku         std::vector<std::string> logEntries;
19063648c8beSEd Tanous         if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries,
19073648c8beSEd Tanous                                   logCount))
1908b7028ebfSSpencer Ku         {
1909b7028ebfSSpencer Ku             messages::internalError(asyncResp->res);
1910b7028ebfSSpencer Ku             return;
1911b7028ebfSSpencer Ku         }
1912b7028ebfSSpencer Ku         // If vector is empty, that means skip value larger than total
1913b7028ebfSSpencer Ku         // log count
191426f6976fSEd Tanous         if (logEntries.empty())
1915b7028ebfSSpencer Ku         {
1916b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Members@odata.count"] = logCount;
1917b7028ebfSSpencer Ku             return;
1918b7028ebfSSpencer Ku         }
191926f6976fSEd Tanous         if (!logEntries.empty())
1920b7028ebfSSpencer Ku         {
1921b7028ebfSSpencer Ku             for (size_t i = 0; i < logEntries.size(); i++)
1922b7028ebfSSpencer Ku             {
19236d6574c9SJason M. Bills                 nlohmann::json::object_t hostLogEntry;
19243648c8beSEd Tanous                 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i],
19253648c8beSEd Tanous                                         hostLogEntry);
19266d6574c9SJason M. Bills                 logEntryArray.push_back(std::move(hostLogEntry));
1927b7028ebfSSpencer Ku             }
1928b7028ebfSSpencer Ku 
1929b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Members@odata.count"] = logCount;
19303648c8beSEd Tanous             if (skip + top < logCount)
1931b7028ebfSSpencer Ku             {
1932b7028ebfSSpencer Ku                 asyncResp->res.jsonValue["Members@odata.nextLink"] =
19330fda0f12SGeorge Liu                     "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" +
19343648c8beSEd Tanous                     std::to_string(skip + top);
1935b7028ebfSSpencer Ku             }
1936b7028ebfSSpencer Ku         }
1937b7028ebfSSpencer Ku         });
1938b7028ebfSSpencer Ku }
1939b7028ebfSSpencer Ku 
1940b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app)
1941b7028ebfSSpencer Ku {
1942b7028ebfSSpencer Ku     BMCWEB_ROUTE(
1943b7028ebfSSpencer Ku         app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/")
1944b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogEntry)
1945b7028ebfSSpencer Ku         .methods(boost::beast::http::verb::get)(
194645ca1b86SEd Tanous             [&app](const crow::Request& req,
1947b7028ebfSSpencer Ku                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1948b7028ebfSSpencer Ku                    const std::string& param) {
19493ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
195045ca1b86SEd Tanous         {
195145ca1b86SEd Tanous             return;
195245ca1b86SEd Tanous         }
1953b7028ebfSSpencer Ku         const std::string& targetID = param;
1954b7028ebfSSpencer Ku 
1955b7028ebfSSpencer Ku         uint64_t idInt = 0;
1956ca45aa3cSEd Tanous 
1957ca45aa3cSEd Tanous         // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
1958ca45aa3cSEd Tanous         const char* end = targetID.data() + targetID.size();
1959ca45aa3cSEd Tanous 
1960ca45aa3cSEd Tanous         auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt);
1961b7028ebfSSpencer Ku         if (ec == std::errc::invalid_argument)
1962b7028ebfSSpencer Ku         {
1963ace85d60SEd Tanous             messages::resourceMissingAtURI(asyncResp->res, req.urlView);
1964b7028ebfSSpencer Ku             return;
1965b7028ebfSSpencer Ku         }
1966b7028ebfSSpencer Ku         if (ec == std::errc::result_out_of_range)
1967b7028ebfSSpencer Ku         {
1968ace85d60SEd Tanous             messages::resourceMissingAtURI(asyncResp->res, req.urlView);
1969b7028ebfSSpencer Ku             return;
1970b7028ebfSSpencer Ku         }
1971b7028ebfSSpencer Ku 
1972b7028ebfSSpencer Ku         std::vector<std::filesystem::path> hostLoggerFiles;
1973b7028ebfSSpencer Ku         if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
1974b7028ebfSSpencer Ku         {
1975b7028ebfSSpencer Ku             BMCWEB_LOG_ERROR << "fail to get host log file path";
1976b7028ebfSSpencer Ku             return;
1977b7028ebfSSpencer Ku         }
1978b7028ebfSSpencer Ku 
1979b7028ebfSSpencer Ku         size_t logCount = 0;
19803648c8beSEd Tanous         size_t top = 1;
1981b7028ebfSSpencer Ku         std::vector<std::string> logEntries;
1982b7028ebfSSpencer Ku         // We can get specific entry by skip and top. For example, if we
1983b7028ebfSSpencer Ku         // want to get nth entry, we can set skip = n-1 and top = 1 to
1984b7028ebfSSpencer Ku         // get that entry
1985002d39b4SEd Tanous         if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries,
1986002d39b4SEd Tanous                                   logCount))
1987b7028ebfSSpencer Ku         {
1988b7028ebfSSpencer Ku             messages::internalError(asyncResp->res);
1989b7028ebfSSpencer Ku             return;
1990b7028ebfSSpencer Ku         }
1991b7028ebfSSpencer Ku 
1992b7028ebfSSpencer Ku         if (!logEntries.empty())
1993b7028ebfSSpencer Ku         {
19946d6574c9SJason M. Bills             nlohmann::json::object_t hostLogEntry;
19956d6574c9SJason M. Bills             fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry);
19966d6574c9SJason M. Bills             asyncResp->res.jsonValue.update(hostLogEntry);
1997b7028ebfSSpencer Ku             return;
1998b7028ebfSSpencer Ku         }
1999b7028ebfSSpencer Ku 
2000b7028ebfSSpencer Ku         // Requested ID was not found
2001ace85d60SEd Tanous         messages::resourceMissingAtURI(asyncResp->res, req.urlView);
2002b7028ebfSSpencer Ku         });
2003b7028ebfSSpencer Ku }
2004b7028ebfSSpencer Ku 
2005fdd26906SClaire Weinan constexpr char const* dumpManagerIface =
2006fdd26906SClaire Weinan     "xyz.openbmc_project.Collection.DeleteAll";
2007*dd72e87bSClaire Weinan inline void handleBMCLogServicesCollectionGet(
2008fdd26906SClaire Weinan     crow::App& app, const crow::Request& req,
2009fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
20101da66f75SEd Tanous {
20113ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
201245ca1b86SEd Tanous     {
201345ca1b86SEd Tanous         return;
201445ca1b86SEd Tanous     }
20157e860f15SJohn Edward Broadbent     // Collections don't include the static data added by SubRoute
20167e860f15SJohn Edward Broadbent     // because it has a duplicate entry for members
2017e1f26343SJason M. Bills     asyncResp->res.jsonValue["@odata.type"] =
20181da66f75SEd Tanous         "#LogServiceCollection.LogServiceCollection";
2019e1f26343SJason M. Bills     asyncResp->res.jsonValue["@odata.id"] =
2020e1f26343SJason M. Bills         "/redfish/v1/Managers/bmc/LogServices";
2021002d39b4SEd Tanous     asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
2022e1f26343SJason M. Bills     asyncResp->res.jsonValue["Description"] =
20231da66f75SEd Tanous         "Collection of LogServices for this Manager";
2024002d39b4SEd Tanous     nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
2025c4bf6374SJason M. Bills     logServiceArray = nlohmann::json::array();
2026fdd26906SClaire Weinan 
2027c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
2028c4bf6374SJason M. Bills     logServiceArray.push_back(
2029002d39b4SEd Tanous         {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
2030c4bf6374SJason M. Bills #endif
2031fdd26906SClaire Weinan 
2032fdd26906SClaire Weinan     asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size();
2033fdd26906SClaire Weinan 
2034fdd26906SClaire Weinan #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
2035fdd26906SClaire Weinan     auto respHandler =
2036fdd26906SClaire Weinan         [asyncResp](
2037fdd26906SClaire Weinan             const boost::system::error_code ec,
2038fdd26906SClaire Weinan             const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2039fdd26906SClaire Weinan         if (ec)
2040fdd26906SClaire Weinan         {
2041fdd26906SClaire Weinan             BMCWEB_LOG_ERROR
2042*dd72e87bSClaire Weinan                 << "handleBMCLogServicesCollectionGet respHandler got error "
2043fdd26906SClaire Weinan                 << ec;
2044fdd26906SClaire Weinan             // Assume that getting an error simply means there are no dump
2045fdd26906SClaire Weinan             // LogServices. Return without adding any error response.
2046fdd26906SClaire Weinan             return;
2047fdd26906SClaire Weinan         }
2048fdd26906SClaire Weinan 
2049fdd26906SClaire Weinan         nlohmann::json& logServiceArrayLocal =
2050fdd26906SClaire Weinan             asyncResp->res.jsonValue["Members"];
2051fdd26906SClaire Weinan 
2052fdd26906SClaire Weinan         for (const std::string& path : subTreePaths)
2053fdd26906SClaire Weinan         {
2054fdd26906SClaire Weinan             if (path == "/xyz/openbmc_project/dump/bmc")
2055fdd26906SClaire Weinan             {
2056fdd26906SClaire Weinan                 logServiceArrayLocal.push_back(
2057fdd26906SClaire Weinan                     {{"@odata.id",
2058fdd26906SClaire Weinan                       "/redfish/v1/Managers/bmc/LogServices/Dump"}});
2059fdd26906SClaire Weinan             }
2060fdd26906SClaire Weinan             else if (path == "/xyz/openbmc_project/dump/faultlog")
2061fdd26906SClaire Weinan             {
2062fdd26906SClaire Weinan                 logServiceArrayLocal.push_back(
2063fdd26906SClaire Weinan                     {{"@odata.id",
2064fdd26906SClaire Weinan                       "/redfish/v1/Managers/bmc/LogServices/FaultLog"}});
2065fdd26906SClaire Weinan             }
2066fdd26906SClaire Weinan         }
2067fdd26906SClaire Weinan 
2068e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
2069fdd26906SClaire Weinan             logServiceArrayLocal.size();
2070fdd26906SClaire Weinan     };
2071fdd26906SClaire Weinan 
2072fdd26906SClaire Weinan     crow::connections::systemBus->async_method_call(
2073fdd26906SClaire Weinan         respHandler, "xyz.openbmc_project.ObjectMapper",
2074fdd26906SClaire Weinan         "/xyz/openbmc_project/object_mapper",
2075fdd26906SClaire Weinan         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
2076fdd26906SClaire Weinan         "/xyz/openbmc_project/dump", 0,
2077fdd26906SClaire Weinan         std::array<const char*, 1>{dumpManagerIface});
2078fdd26906SClaire Weinan #endif
2079fdd26906SClaire Weinan }
2080fdd26906SClaire Weinan 
2081fdd26906SClaire Weinan inline void requestRoutesBMCLogServiceCollection(App& app)
2082fdd26906SClaire Weinan {
2083fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/")
2084fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogServiceCollection)
2085fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(
2086*dd72e87bSClaire Weinan             std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app)));
2087e1f26343SJason M. Bills }
2088e1f26343SJason M. Bills 
20897e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app)
2090e1f26343SJason M. Bills {
20917e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
2092ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
20937e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
209445ca1b86SEd Tanous             [&app](const crow::Request& req,
209545ca1b86SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
20963ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
20977e860f15SJohn Edward Broadbent         {
209845ca1b86SEd Tanous             return;
209945ca1b86SEd Tanous         }
2100e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2101e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
21020f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
21030f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
2104002d39b4SEd Tanous         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
2105002d39b4SEd Tanous         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
2106c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "BMC Journal";
2107e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
21087c8c4058STejas Patil 
21097c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
21102b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
2111002d39b4SEd Tanous         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
21127c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
21137c8c4058STejas Patil             redfishDateTimeOffset.second;
21147c8c4058STejas Patil 
21151476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
21161476687dSEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
21177e860f15SJohn Edward Broadbent         });
2118e1f26343SJason M. Bills }
2119e1f26343SJason M. Bills 
21203a48b3a2SJason M. Bills static int
21213a48b3a2SJason M. Bills     fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
2122e1f26343SJason M. Bills                                sd_journal* journal,
21233a48b3a2SJason M. Bills                                nlohmann::json::object_t& bmcJournalLogEntryJson)
2124e1f26343SJason M. Bills {
2125e1f26343SJason M. Bills     // Get the Log Entry contents
2126e1f26343SJason M. Bills     int ret = 0;
2127e1f26343SJason M. Bills 
2128a8fe54f0SJason M. Bills     std::string message;
2129a8fe54f0SJason M. Bills     std::string_view syslogID;
2130a8fe54f0SJason M. Bills     ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
2131a8fe54f0SJason M. Bills     if (ret < 0)
2132a8fe54f0SJason M. Bills     {
2133a8fe54f0SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: "
2134a8fe54f0SJason M. Bills                          << strerror(-ret);
2135a8fe54f0SJason M. Bills     }
2136a8fe54f0SJason M. Bills     if (!syslogID.empty())
2137a8fe54f0SJason M. Bills     {
2138a8fe54f0SJason M. Bills         message += std::string(syslogID) + ": ";
2139a8fe54f0SJason M. Bills     }
2140a8fe54f0SJason M. Bills 
214139e77504SEd Tanous     std::string_view msg;
214216428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
2143e1f26343SJason M. Bills     if (ret < 0)
2144e1f26343SJason M. Bills     {
2145e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
2146e1f26343SJason M. Bills         return 1;
2147e1f26343SJason M. Bills     }
2148a8fe54f0SJason M. Bills     message += std::string(msg);
2149e1f26343SJason M. Bills 
2150e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
2151271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
215216428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
2153e1f26343SJason M. Bills     if (ret < 0)
2154e1f26343SJason M. Bills     {
2155e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
2156e1f26343SJason M. Bills     }
2157e1f26343SJason M. Bills 
2158e1f26343SJason M. Bills     // Get the Created time from the timestamp
215916428a1aSJason M. Bills     std::string entryTimeStr;
216016428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
2161e1f26343SJason M. Bills     {
216216428a1aSJason M. Bills         return 1;
2163e1f26343SJason M. Bills     }
2164e1f26343SJason M. Bills 
2165e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
216684afc48bSJason M. Bills     bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
216784afc48bSJason M. Bills     bmcJournalLogEntryJson["@odata.id"] =
216884afc48bSJason M. Bills         "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
216984afc48bSJason M. Bills         bmcJournalLogEntryID;
217084afc48bSJason M. Bills     bmcJournalLogEntryJson["Name"] = "BMC Journal Entry";
217184afc48bSJason M. Bills     bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID;
217284afc48bSJason M. Bills     bmcJournalLogEntryJson["Message"] = std::move(message);
217384afc48bSJason M. Bills     bmcJournalLogEntryJson["EntryType"] = "Oem";
217484afc48bSJason M. Bills     bmcJournalLogEntryJson["Severity"] = severity <= 2   ? "Critical"
2175738c1e61SPatrick Williams                                          : severity <= 4 ? "Warning"
217684afc48bSJason M. Bills                                                          : "OK";
217784afc48bSJason M. Bills     bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry";
217884afc48bSJason M. Bills     bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr);
2179e1f26343SJason M. Bills     return 0;
2180e1f26343SJason M. Bills }
2181e1f26343SJason M. Bills 
21827e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app)
2183e1f26343SJason M. Bills {
21847e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
2185ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
2186002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2187002d39b4SEd Tanous             [&app](const crow::Request& req,
2188002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2189c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
2190c937d2bfSEd Tanous             .canDelegateTop = true,
2191c937d2bfSEd Tanous             .canDelegateSkip = true,
2192c937d2bfSEd Tanous         };
2193c937d2bfSEd Tanous         query_param::Query delegatedQuery;
2194c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
21953ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
2196193ad2faSJason M. Bills         {
2197193ad2faSJason M. Bills             return;
2198193ad2faSJason M. Bills         }
21993648c8beSEd Tanous 
22003648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
22015143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
22023648c8beSEd Tanous 
22037e860f15SJohn Edward Broadbent         // Collections don't include the static data added by SubRoute
22047e860f15SJohn Edward Broadbent         // because it has a duplicate entry for members
2205e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2206e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
22070f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
22080f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2209e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
2210e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
2211e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
22120fda0f12SGeorge Liu         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2213e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
2214e1f26343SJason M. Bills 
22157e860f15SJohn Edward Broadbent         // Go through the journal and use the timestamp to create a
22167e860f15SJohn Edward Broadbent         // unique ID for each entry
2217e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
2218e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2219e1f26343SJason M. Bills         if (ret < 0)
2220e1f26343SJason M. Bills         {
2221002d39b4SEd Tanous             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
2222f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2223e1f26343SJason M. Bills             return;
2224e1f26343SJason M. Bills         }
22250fda0f12SGeorge Liu         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
22260fda0f12SGeorge Liu             journalTmp, sd_journal_close);
2227e1f26343SJason M. Bills         journalTmp = nullptr;
2228b01bf299SEd Tanous         uint64_t entryCount = 0;
2229e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
2230e85d6b16SJason M. Bills         bool firstEntry = true;
2231e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
2232e1f26343SJason M. Bills         {
2233193ad2faSJason M. Bills             entryCount++;
22347e860f15SJohn Edward Broadbent             // Handle paging using skip (number of entries to skip from
22357e860f15SJohn Edward Broadbent             // the start) and top (number of entries to display)
22363648c8beSEd Tanous             if (entryCount <= skip || entryCount > skip + top)
2237193ad2faSJason M. Bills             {
2238193ad2faSJason M. Bills                 continue;
2239193ad2faSJason M. Bills             }
2240193ad2faSJason M. Bills 
224116428a1aSJason M. Bills             std::string idStr;
2242e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2243e1f26343SJason M. Bills             {
2244e1f26343SJason M. Bills                 continue;
2245e1f26343SJason M. Bills             }
2246e85d6b16SJason M. Bills             firstEntry = false;
2247e85d6b16SJason M. Bills 
22483a48b3a2SJason M. Bills             nlohmann::json::object_t bmcJournalLogEntry;
2249c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
2250c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
2251e1f26343SJason M. Bills             {
2252f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
2253e1f26343SJason M. Bills                 return;
2254e1f26343SJason M. Bills             }
22553a48b3a2SJason M. Bills             logEntryArray.push_back(std::move(bmcJournalLogEntry));
2256e1f26343SJason M. Bills         }
2257193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
22583648c8beSEd Tanous         if (skip + top < entryCount)
2259193ad2faSJason M. Bills         {
2260193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
22610fda0f12SGeorge Liu                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
22623648c8beSEd Tanous                 std::to_string(skip + top);
2263193ad2faSJason M. Bills         }
22647e860f15SJohn Edward Broadbent         });
2265e1f26343SJason M. Bills }
2266e1f26343SJason M. Bills 
22677e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app)
2268e1f26343SJason M. Bills {
22697e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
22707e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/")
2271ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
22727e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
227345ca1b86SEd Tanous             [&app](const crow::Request& req,
22747e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22757e860f15SJohn Edward Broadbent                    const std::string& entryID) {
22763ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
227745ca1b86SEd Tanous         {
227845ca1b86SEd Tanous             return;
227945ca1b86SEd Tanous         }
2280e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
2281e1f26343SJason M. Bills         uint64_t ts = 0;
2282271584abSEd Tanous         uint64_t index = 0;
22838d1b46d7Szhanghch05         if (!getTimestampFromID(asyncResp, entryID, ts, index))
2284e1f26343SJason M. Bills         {
228516428a1aSJason M. Bills             return;
2286e1f26343SJason M. Bills         }
2287e1f26343SJason M. Bills 
2288e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
2289e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2290e1f26343SJason M. Bills         if (ret < 0)
2291e1f26343SJason M. Bills         {
2292002d39b4SEd Tanous             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
2293f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2294e1f26343SJason M. Bills             return;
2295e1f26343SJason M. Bills         }
2296002d39b4SEd Tanous         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2297002d39b4SEd Tanous             journalTmp, sd_journal_close);
2298e1f26343SJason M. Bills         journalTmp = nullptr;
22997e860f15SJohn Edward Broadbent         // Go to the timestamp in the log and move to the entry at the
23007e860f15SJohn Edward Broadbent         // index tracking the unique ID
2301af07e3f5SJason M. Bills         std::string idStr;
2302af07e3f5SJason M. Bills         bool firstEntry = true;
2303e1f26343SJason M. Bills         ret = sd_journal_seek_realtime_usec(journal.get(), ts);
23042056b6d1SManojkiran Eda         if (ret < 0)
23052056b6d1SManojkiran Eda         {
23062056b6d1SManojkiran Eda             BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
23072056b6d1SManojkiran Eda                              << strerror(-ret);
23082056b6d1SManojkiran Eda             messages::internalError(asyncResp->res);
23092056b6d1SManojkiran Eda             return;
23102056b6d1SManojkiran Eda         }
2311271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
2312e1f26343SJason M. Bills         {
2313e1f26343SJason M. Bills             sd_journal_next(journal.get());
2314af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2315af07e3f5SJason M. Bills             {
2316af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
2317af07e3f5SJason M. Bills                 return;
2318af07e3f5SJason M. Bills             }
2319af07e3f5SJason M. Bills             firstEntry = false;
2320af07e3f5SJason M. Bills         }
2321c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
2322af07e3f5SJason M. Bills         if (idStr != entryID)
2323c4bf6374SJason M. Bills         {
2324ace85d60SEd Tanous             messages::resourceMissingAtURI(asyncResp->res, req.urlView);
2325c4bf6374SJason M. Bills             return;
2326c4bf6374SJason M. Bills         }
2327c4bf6374SJason M. Bills 
23283a48b3a2SJason M. Bills         nlohmann::json::object_t bmcJournalLogEntry;
2329c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
23303a48b3a2SJason M. Bills                                        bmcJournalLogEntry) != 0)
2331e1f26343SJason M. Bills         {
2332f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2333e1f26343SJason M. Bills             return;
2334e1f26343SJason M. Bills         }
2335d405bb51SJason M. Bills         asyncResp->res.jsonValue.update(bmcJournalLogEntry);
23367e860f15SJohn Edward Broadbent         });
2337c9bb6861Sraviteja-b }
2338c9bb6861Sraviteja-b 
2339fdd26906SClaire Weinan inline void
2340fdd26906SClaire Weinan     getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2341fdd26906SClaire Weinan                        const std::string& dumpType)
2342c9bb6861Sraviteja-b {
2343fdd26906SClaire Weinan     std::string dumpPath;
2344fdd26906SClaire Weinan     std::string overWritePolicy;
2345fdd26906SClaire Weinan     bool collectDiagnosticDataSupported = false;
2346fdd26906SClaire Weinan 
2347fdd26906SClaire Weinan     if (dumpType == "BMC")
234845ca1b86SEd Tanous     {
2349fdd26906SClaire Weinan         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump";
2350fdd26906SClaire Weinan         overWritePolicy = "WrapsWhenFull";
2351fdd26906SClaire Weinan         collectDiagnosticDataSupported = true;
2352fdd26906SClaire Weinan     }
2353fdd26906SClaire Weinan     else if (dumpType == "FaultLog")
2354fdd26906SClaire Weinan     {
2355fdd26906SClaire Weinan         dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog";
2356fdd26906SClaire Weinan         overWritePolicy = "Unknown";
2357fdd26906SClaire Weinan         collectDiagnosticDataSupported = false;
2358fdd26906SClaire Weinan     }
2359fdd26906SClaire Weinan     else if (dumpType == "System")
2360fdd26906SClaire Weinan     {
2361fdd26906SClaire Weinan         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump";
2362fdd26906SClaire Weinan         overWritePolicy = "WrapsWhenFull";
2363fdd26906SClaire Weinan         collectDiagnosticDataSupported = true;
2364fdd26906SClaire Weinan     }
2365fdd26906SClaire Weinan     else
2366fdd26906SClaire Weinan     {
2367fdd26906SClaire Weinan         BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: "
2368fdd26906SClaire Weinan                          << dumpType;
2369fdd26906SClaire Weinan         messages::internalError(asyncResp->res);
237045ca1b86SEd Tanous         return;
237145ca1b86SEd Tanous     }
2372fdd26906SClaire Weinan 
2373fdd26906SClaire Weinan     asyncResp->res.jsonValue["@odata.id"] = dumpPath;
2374fdd26906SClaire Weinan     asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService";
2375c9bb6861Sraviteja-b     asyncResp->res.jsonValue["Name"] = "Dump LogService";
2376fdd26906SClaire Weinan     asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService";
2377fdd26906SClaire Weinan     asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename();
2378fdd26906SClaire Weinan     asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy);
23797c8c4058STejas Patil 
23807c8c4058STejas Patil     std::pair<std::string, std::string> redfishDateTimeOffset =
23812b82937eSEd Tanous         redfish::time_utils::getDateTimeOffsetNow();
23820fda0f12SGeorge Liu     asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
23837c8c4058STejas Patil     asyncResp->res.jsonValue["DateTimeLocalOffset"] =
23847c8c4058STejas Patil         redfishDateTimeOffset.second;
23857c8c4058STejas Patil 
2386fdd26906SClaire Weinan     asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries";
2387002d39b4SEd Tanous     asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
2388fdd26906SClaire Weinan         dumpPath + "/Actions/LogService.ClearLog";
2389fdd26906SClaire Weinan 
2390fdd26906SClaire Weinan     if (collectDiagnosticDataSupported)
2391fdd26906SClaire Weinan     {
2392002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
23931476687dSEd Tanous                                 ["target"] =
2394fdd26906SClaire Weinan             dumpPath + "/Actions/LogService.CollectDiagnosticData";
2395fdd26906SClaire Weinan     }
2396c9bb6861Sraviteja-b }
2397c9bb6861Sraviteja-b 
2398fdd26906SClaire Weinan inline void handleLogServicesDumpServiceGet(
2399fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2400fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
24017e860f15SJohn Edward Broadbent {
24023ba00073SCarson Labrado     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
240345ca1b86SEd Tanous     {
240445ca1b86SEd Tanous         return;
240545ca1b86SEd Tanous     }
2406fdd26906SClaire Weinan     getDumpServiceInfo(asyncResp, dumpType);
2407fdd26906SClaire Weinan }
2408c9bb6861Sraviteja-b 
2409fdd26906SClaire Weinan inline void handleLogServicesDumpEntriesCollectionGet(
2410fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2411fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2412fdd26906SClaire Weinan {
2413fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2414fdd26906SClaire Weinan     {
2415fdd26906SClaire Weinan         return;
2416fdd26906SClaire Weinan     }
2417fdd26906SClaire Weinan     getDumpEntryCollection(asyncResp, dumpType);
2418fdd26906SClaire Weinan }
2419fdd26906SClaire Weinan 
2420fdd26906SClaire Weinan inline void handleLogServicesDumpEntryGet(
2421fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2422fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2423fdd26906SClaire Weinan     const std::string& dumpId)
2424fdd26906SClaire Weinan {
2425fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2426fdd26906SClaire Weinan     {
2427fdd26906SClaire Weinan         return;
2428fdd26906SClaire Weinan     }
2429fdd26906SClaire Weinan     getDumpEntryById(asyncResp, dumpId, dumpType);
2430fdd26906SClaire Weinan }
2431fdd26906SClaire Weinan 
2432fdd26906SClaire Weinan inline void handleLogServicesDumpEntryDelete(
2433fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2434fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2435fdd26906SClaire Weinan     const std::string& dumpId)
2436fdd26906SClaire Weinan {
2437fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2438fdd26906SClaire Weinan     {
2439fdd26906SClaire Weinan         return;
2440fdd26906SClaire Weinan     }
2441fdd26906SClaire Weinan     deleteDumpEntry(asyncResp, dumpId, dumpType);
2442fdd26906SClaire Weinan }
2443fdd26906SClaire Weinan 
2444fdd26906SClaire Weinan inline void handleLogServicesDumpCollectDiagnosticDataPost(
2445fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2446fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2447fdd26906SClaire Weinan {
2448fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2449fdd26906SClaire Weinan     {
2450fdd26906SClaire Weinan         return;
2451fdd26906SClaire Weinan     }
2452fdd26906SClaire Weinan     createDump(asyncResp, req, dumpType);
2453fdd26906SClaire Weinan }
2454fdd26906SClaire Weinan 
2455fdd26906SClaire Weinan inline void handleLogServicesDumpClearLogPost(
2456fdd26906SClaire Weinan     crow::App& app, const std::string& dumpType, const crow::Request& req,
2457fdd26906SClaire Weinan     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2458fdd26906SClaire Weinan {
2459fdd26906SClaire Weinan     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2460fdd26906SClaire Weinan     {
2461fdd26906SClaire Weinan         return;
2462fdd26906SClaire Weinan     }
2463fdd26906SClaire Weinan     clearDump(asyncResp, dumpType);
2464fdd26906SClaire Weinan }
2465fdd26906SClaire Weinan 
2466fdd26906SClaire Weinan inline void requestRoutesBMCDumpService(App& app)
2467fdd26906SClaire Weinan {
2468fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2469fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogService)
2470fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2471fdd26906SClaire Weinan             handleLogServicesDumpServiceGet, std::ref(app), "BMC"));
2472fdd26906SClaire Weinan }
2473fdd26906SClaire Weinan 
2474fdd26906SClaire Weinan inline void requestRoutesBMCDumpEntryCollection(App& app)
2475fdd26906SClaire Weinan {
2476fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2477fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntryCollection)
2478fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2479fdd26906SClaire Weinan             handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC"));
2480c9bb6861Sraviteja-b }
2481c9bb6861Sraviteja-b 
24827e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app)
2483c9bb6861Sraviteja-b {
24847e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
24857e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2486ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
2487fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2488fdd26906SClaire Weinan             handleLogServicesDumpEntryGet, std::ref(app), "BMC"));
2489fdd26906SClaire Weinan 
24907e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
24917e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2492ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
2493fdd26906SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
2494fdd26906SClaire Weinan             handleLogServicesDumpEntryDelete, std::ref(app), "BMC"));
2495c9bb6861Sraviteja-b }
2496c9bb6861Sraviteja-b 
24977e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app)
2498c9bb6861Sraviteja-b {
24990fda0f12SGeorge Liu     BMCWEB_ROUTE(
25000fda0f12SGeorge Liu         app,
25010fda0f12SGeorge Liu         "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
2502ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
25037e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
2504fdd26906SClaire Weinan             std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost,
2505fdd26906SClaire Weinan                             std::ref(app), "BMC"));
2506a43be80fSAsmitha Karunanithi }
2507a43be80fSAsmitha Karunanithi 
25087e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app)
250980319af1SAsmitha Karunanithi {
25100fda0f12SGeorge Liu     BMCWEB_ROUTE(
25110fda0f12SGeorge Liu         app,
25120fda0f12SGeorge Liu         "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/")
2513ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
2514fdd26906SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
2515fdd26906SClaire Weinan             handleLogServicesDumpClearLogPost, std::ref(app), "BMC"));
251645ca1b86SEd Tanous }
2517fdd26906SClaire Weinan 
2518fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpService(App& app)
2519fdd26906SClaire Weinan {
2520fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/")
2521fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogService)
2522fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2523fdd26906SClaire Weinan             handleLogServicesDumpServiceGet, std::ref(app), "FaultLog"));
2524fdd26906SClaire Weinan }
2525fdd26906SClaire Weinan 
2526fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntryCollection(App& app)
2527fdd26906SClaire Weinan {
2528fdd26906SClaire Weinan     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/")
2529fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntryCollection)
2530fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(
2531fdd26906SClaire Weinan             std::bind_front(handleLogServicesDumpEntriesCollectionGet,
2532fdd26906SClaire Weinan                             std::ref(app), "FaultLog"));
2533fdd26906SClaire Weinan }
2534fdd26906SClaire Weinan 
2535fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpEntry(App& app)
2536fdd26906SClaire Weinan {
2537fdd26906SClaire Weinan     BMCWEB_ROUTE(app,
2538fdd26906SClaire Weinan                  "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
2539fdd26906SClaire Weinan         .privileges(redfish::privileges::getLogEntry)
2540fdd26906SClaire Weinan         .methods(boost::beast::http::verb::get)(std::bind_front(
2541fdd26906SClaire Weinan             handleLogServicesDumpEntryGet, std::ref(app), "FaultLog"));
2542fdd26906SClaire Weinan 
2543fdd26906SClaire Weinan     BMCWEB_ROUTE(app,
2544fdd26906SClaire Weinan                  "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
2545fdd26906SClaire Weinan         .privileges(redfish::privileges::deleteLogEntry)
2546fdd26906SClaire Weinan         .methods(boost::beast::http::verb::delete_)(std::bind_front(
2547fdd26906SClaire Weinan             handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog"));
2548fdd26906SClaire Weinan }
2549fdd26906SClaire Weinan 
2550fdd26906SClaire Weinan inline void requestRoutesFaultLogDumpClear(App& app)
2551fdd26906SClaire Weinan {
2552fdd26906SClaire Weinan     BMCWEB_ROUTE(
2553fdd26906SClaire Weinan         app,
2554fdd26906SClaire Weinan         "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/")
2555fdd26906SClaire Weinan         .privileges(redfish::privileges::postLogService)
2556fdd26906SClaire Weinan         .methods(boost::beast::http::verb::post)(std::bind_front(
2557fdd26906SClaire Weinan             handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog"));
25585cb1dd27SAsmitha Karunanithi }
25595cb1dd27SAsmitha Karunanithi 
25607e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app)
25615cb1dd27SAsmitha Karunanithi {
25627e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/")
2563ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
2564002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2565002d39b4SEd Tanous             [&app](const crow::Request& req,
2566002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
25673ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
25687e860f15SJohn Edward Broadbent         {
256945ca1b86SEd Tanous             return;
257045ca1b86SEd Tanous         }
25715cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
25725cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump";
25735cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
2574d337bb72SAsmitha Karunanithi             "#LogService.v1_2_0.LogService";
25755cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "Dump LogService";
257645ca1b86SEd Tanous         asyncResp->res.jsonValue["Description"] = "System Dump LogService";
25775cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
25785cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
25797c8c4058STejas Patil 
25807c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
25812b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
258245ca1b86SEd Tanous         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
25837c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
25847c8c4058STejas Patil             redfishDateTimeOffset.second;
25857c8c4058STejas Patil 
25861476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
25871476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Dump/Entries";
2588002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
25891476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog";
25901476687dSEd Tanous 
2591002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
25921476687dSEd Tanous                                 ["target"] =
25931476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData";
25947e860f15SJohn Edward Broadbent         });
25955cb1dd27SAsmitha Karunanithi }
25965cb1dd27SAsmitha Karunanithi 
25977e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app)
25987e860f15SJohn Edward Broadbent {
25997e860f15SJohn Edward Broadbent 
26005cb1dd27SAsmitha Karunanithi     /**
26015cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
26025cb1dd27SAsmitha Karunanithi      */
2603b2a3289dSAsmitha Karunanithi     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
2604ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
26057e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
260645ca1b86SEd Tanous             [&app](const crow::Request& req,
2607864d6a17SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
26083ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
260945ca1b86SEd Tanous         {
261045ca1b86SEd Tanous             return;
261145ca1b86SEd Tanous         }
26125cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "System");
26137e860f15SJohn Edward Broadbent         });
26145cb1dd27SAsmitha Karunanithi }
26155cb1dd27SAsmitha Karunanithi 
26167e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app)
26175cb1dd27SAsmitha Karunanithi {
26187e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2619864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2620ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
2621ed398213SEd Tanous 
26227e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
262345ca1b86SEd Tanous             [&app](const crow::Request& req,
26247e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
26257e860f15SJohn Edward Broadbent                    const std::string& param) {
26263ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2627c7a6d660SClaire Weinan         {
2628c7a6d660SClaire Weinan             return;
2629c7a6d660SClaire Weinan         }
2630c7a6d660SClaire Weinan         getDumpEntryById(asyncResp, param, "System");
26317e860f15SJohn Edward Broadbent         });
26328d1b46d7Szhanghch05 
26337e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2634864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2635ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
26367e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
263745ca1b86SEd Tanous             [&app](const crow::Request& req,
26387e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
26397e860f15SJohn Edward Broadbent                    const std::string& param) {
26403ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
264145ca1b86SEd Tanous         {
264245ca1b86SEd Tanous             return;
264345ca1b86SEd Tanous         }
26447e860f15SJohn Edward Broadbent         deleteDumpEntry(asyncResp, param, "system");
26457e860f15SJohn Edward Broadbent         });
26465cb1dd27SAsmitha Karunanithi }
2647c9bb6861Sraviteja-b 
26487e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app)
2649c9bb6861Sraviteja-b {
26500fda0f12SGeorge Liu     BMCWEB_ROUTE(
26510fda0f12SGeorge Liu         app,
26520fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
2653ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
26547e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
265545ca1b86SEd Tanous             [&app](const crow::Request& req,
265645ca1b86SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
26573ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
265845ca1b86SEd Tanous         {
265945ca1b86SEd Tanous             return;
266045ca1b86SEd Tanous         }
266145ca1b86SEd Tanous         createDump(asyncResp, req, "System");
266245ca1b86SEd Tanous         });
2663a43be80fSAsmitha Karunanithi }
2664a43be80fSAsmitha Karunanithi 
26657e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app)
2666a43be80fSAsmitha Karunanithi {
26670fda0f12SGeorge Liu     BMCWEB_ROUTE(
26680fda0f12SGeorge Liu         app,
26690fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/")
2670ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
26717e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
267245ca1b86SEd Tanous             [&app](const crow::Request& req,
26737e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
26747e860f15SJohn Edward Broadbent 
267545ca1b86SEd Tanous             {
26763ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
267745ca1b86SEd Tanous         {
267845ca1b86SEd Tanous             return;
267945ca1b86SEd Tanous         }
268045ca1b86SEd Tanous         clearDump(asyncResp, "System");
268145ca1b86SEd Tanous         });
2682013487e5Sraviteja-b }
2683013487e5Sraviteja-b 
26847e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app)
26851da66f75SEd Tanous {
26863946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
26873946028dSAppaRao Puli     // method for security reasons.
26881da66f75SEd Tanous     /**
26891da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
26901da66f75SEd Tanous      */
26917e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
2692ed398213SEd Tanous         // This is incorrect, should be:
2693ed398213SEd Tanous         //.privileges(redfish::privileges::getLogService)
2694432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
2695002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2696002d39b4SEd Tanous             [&app](const crow::Request& req,
2697002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
26983ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
269945ca1b86SEd Tanous         {
270045ca1b86SEd Tanous             return;
270145ca1b86SEd Tanous         }
27027e860f15SJohn Edward Broadbent         // Copy over the static data to include the entries added by
27037e860f15SJohn Edward Broadbent         // SubRoute
27040f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
2705424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
2706e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
27078e6c099aSJason M. Bills             "#LogService.v1_2_0.LogService";
27084f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
27094f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
27104f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2711e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2712e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
27137c8c4058STejas Patil 
27147c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
27152b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
27167c8c4058STejas Patil         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
27177c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
27187c8c4058STejas Patil             redfishDateTimeOffset.second;
27197c8c4058STejas Patil 
27201476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
27211476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2722002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
27231476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog";
2724002d39b4SEd Tanous         asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
27251476687dSEd Tanous                                 ["target"] =
27261476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData";
27277e860f15SJohn Edward Broadbent         });
27281da66f75SEd Tanous }
27291da66f75SEd Tanous 
27307e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app)
27315b61b5e8SJason M. Bills {
27320fda0f12SGeorge Liu     BMCWEB_ROUTE(
27330fda0f12SGeorge Liu         app,
27340fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/")
2735ed398213SEd Tanous         // This is incorrect, should be:
2736ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2737432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
27387e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
273945ca1b86SEd Tanous             [&app](const crow::Request& req,
27407e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
27413ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
274245ca1b86SEd Tanous         {
274345ca1b86SEd Tanous             return;
274445ca1b86SEd Tanous         }
27455b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
27465b61b5e8SJason M. Bills             [asyncResp](const boost::system::error_code ec,
2747cb13a392SEd Tanous                         const std::string&) {
27485b61b5e8SJason M. Bills             if (ec)
27495b61b5e8SJason M. Bills             {
27505b61b5e8SJason M. Bills                 messages::internalError(asyncResp->res);
27515b61b5e8SJason M. Bills                 return;
27525b61b5e8SJason M. Bills             }
27535b61b5e8SJason M. Bills             messages::success(asyncResp->res);
27545b61b5e8SJason M. Bills             },
2755002d39b4SEd Tanous             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
27567e860f15SJohn Edward Broadbent         });
27575b61b5e8SJason M. Bills }
27585b61b5e8SJason M. Bills 
27598d1b46d7Szhanghch05 static void
27608d1b46d7Szhanghch05     logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
27618d1b46d7Szhanghch05                       const std::string& logID, nlohmann::json& logEntryJson)
2762e855dd28SJason M. Bills {
2763043a0536SJohnathan Mantey     auto getStoredLogCallback =
2764b9d36b47SEd Tanous         [asyncResp, logID,
2765b9d36b47SEd Tanous          &logEntryJson](const boost::system::error_code ec,
2766b9d36b47SEd Tanous                         const dbus::utility::DBusPropertiesMap& params) {
2767e855dd28SJason M. Bills         if (ec)
2768e855dd28SJason M. Bills         {
2769e855dd28SJason M. Bills             BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
27701ddcf01aSJason M. Bills             if (ec.value() ==
27711ddcf01aSJason M. Bills                 boost::system::linux_error::bad_request_descriptor)
27721ddcf01aSJason M. Bills             {
2773002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
27741ddcf01aSJason M. Bills             }
27751ddcf01aSJason M. Bills             else
27761ddcf01aSJason M. Bills             {
2777e855dd28SJason M. Bills                 messages::internalError(asyncResp->res);
27781ddcf01aSJason M. Bills             }
2779e855dd28SJason M. Bills             return;
2780e855dd28SJason M. Bills         }
2781043a0536SJohnathan Mantey 
2782043a0536SJohnathan Mantey         std::string timestamp{};
2783043a0536SJohnathan Mantey         std::string filename{};
2784043a0536SJohnathan Mantey         std::string logfile{};
27852c70f800SEd Tanous         parseCrashdumpParameters(params, filename, timestamp, logfile);
2786043a0536SJohnathan Mantey 
2787043a0536SJohnathan Mantey         if (filename.empty() || timestamp.empty())
2788e855dd28SJason M. Bills         {
2789002d39b4SEd Tanous             messages::resourceMissingAtURI(asyncResp->res,
2790002d39b4SEd Tanous                                            crow::utility::urlFromPieces(logID));
2791e855dd28SJason M. Bills             return;
2792e855dd28SJason M. Bills         }
2793e855dd28SJason M. Bills 
2794043a0536SJohnathan Mantey         std::string crashdumpURI =
2795e855dd28SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2796043a0536SJohnathan Mantey             logID + "/" + filename;
279784afc48bSJason M. Bills         nlohmann::json::object_t logEntry;
279884afc48bSJason M. Bills         logEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry";
279984afc48bSJason M. Bills         logEntry["@odata.id"] =
280084afc48bSJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + logID;
280184afc48bSJason M. Bills         logEntry["Name"] = "CPU Crashdump";
280284afc48bSJason M. Bills         logEntry["Id"] = logID;
280384afc48bSJason M. Bills         logEntry["EntryType"] = "Oem";
280484afc48bSJason M. Bills         logEntry["AdditionalDataURI"] = std::move(crashdumpURI);
280584afc48bSJason M. Bills         logEntry["DiagnosticDataType"] = "OEM";
280684afc48bSJason M. Bills         logEntry["OEMDiagnosticDataType"] = "PECICrashdump";
280784afc48bSJason M. Bills         logEntry["Created"] = std::move(timestamp);
28082b20ef6eSJason M. Bills 
28092b20ef6eSJason M. Bills         // If logEntryJson references an array of LogEntry resources
28102b20ef6eSJason M. Bills         // ('Members' list), then push this as a new entry, otherwise set it
28112b20ef6eSJason M. Bills         // directly
28122b20ef6eSJason M. Bills         if (logEntryJson.is_array())
28132b20ef6eSJason M. Bills         {
28142b20ef6eSJason M. Bills             logEntryJson.push_back(logEntry);
28152b20ef6eSJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
28162b20ef6eSJason M. Bills                 logEntryJson.size();
28172b20ef6eSJason M. Bills         }
28182b20ef6eSJason M. Bills         else
28192b20ef6eSJason M. Bills         {
2820d405bb51SJason M. Bills             logEntryJson.update(logEntry);
28212b20ef6eSJason M. Bills         }
2822e855dd28SJason M. Bills     };
2823e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
28245b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
28255b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2826043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2827e855dd28SJason M. Bills }
2828e855dd28SJason M. Bills 
28297e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app)
28301da66f75SEd Tanous {
28313946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
28323946028dSAppaRao Puli     // method for security reasons.
28331da66f75SEd Tanous     /**
28341da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
28351da66f75SEd Tanous      */
28367e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
28377e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
2838ed398213SEd Tanous         // This is incorrect, should be.
2839ed398213SEd Tanous         //.privileges(redfish::privileges::postLogEntryCollection)
2840432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
2841002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2842002d39b4SEd Tanous             [&app](const crow::Request& req,
2843002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
28443ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
284545ca1b86SEd Tanous         {
284645ca1b86SEd Tanous             return;
284745ca1b86SEd Tanous         }
28482b20ef6eSJason M. Bills         crow::connections::systemBus->async_method_call(
28492b20ef6eSJason M. Bills             [asyncResp](const boost::system::error_code ec,
28502b20ef6eSJason M. Bills                         const std::vector<std::string>& resp) {
28511da66f75SEd Tanous             if (ec)
28521da66f75SEd Tanous             {
28531da66f75SEd Tanous                 if (ec.value() !=
28541da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
28551da66f75SEd Tanous                 {
28561da66f75SEd Tanous                     BMCWEB_LOG_DEBUG << "failed to get entries ec: "
28571da66f75SEd Tanous                                      << ec.message();
2858f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
28591da66f75SEd Tanous                     return;
28601da66f75SEd Tanous                 }
28611da66f75SEd Tanous             }
2862e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
28631da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
28640f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2865424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2866002d39b4SEd Tanous             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2867e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2868424c4176SJason M. Bills                 "Collection of Crashdump Entries";
2869002d39b4SEd Tanous             asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
2870a2dd60a6SBrandon Kim             asyncResp->res.jsonValue["Members@odata.count"] = 0;
28712b20ef6eSJason M. Bills 
28722b20ef6eSJason M. Bills             for (const std::string& path : resp)
28731da66f75SEd Tanous             {
28742b20ef6eSJason M. Bills                 const sdbusplus::message::object_path objPath(path);
2875e855dd28SJason M. Bills                 // Get the log ID
28762b20ef6eSJason M. Bills                 std::string logID = objPath.filename();
28772b20ef6eSJason M. Bills                 if (logID.empty())
28781da66f75SEd Tanous                 {
2879e855dd28SJason M. Bills                     continue;
28801da66f75SEd Tanous                 }
2881e855dd28SJason M. Bills                 // Add the log entry to the array
28822b20ef6eSJason M. Bills                 logCrashdumpEntry(asyncResp, logID,
28832b20ef6eSJason M. Bills                                   asyncResp->res.jsonValue["Members"]);
28841da66f75SEd Tanous             }
28852b20ef6eSJason M. Bills             },
28861da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper",
28871da66f75SEd Tanous             "/xyz/openbmc_project/object_mapper",
28881da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
28895b61b5e8SJason M. Bills             std::array<const char*, 1>{crashdumpInterface});
28907e860f15SJohn Edward Broadbent         });
28911da66f75SEd Tanous }
28921da66f75SEd Tanous 
28937e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app)
28941da66f75SEd Tanous {
28953946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
28963946028dSAppaRao Puli     // method for security reasons.
28971da66f75SEd Tanous 
28987e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
28997e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/")
2900ed398213SEd Tanous         // this is incorrect, should be
2901ed398213SEd Tanous         // .privileges(redfish::privileges::getLogEntry)
2902432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
29037e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
290445ca1b86SEd Tanous             [&app](const crow::Request& req,
29057e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
29067e860f15SJohn Edward Broadbent                    const std::string& param) {
29073ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
290845ca1b86SEd Tanous         {
290945ca1b86SEd Tanous             return;
291045ca1b86SEd Tanous         }
29117e860f15SJohn Edward Broadbent         const std::string& logID = param;
2912e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
29137e860f15SJohn Edward Broadbent         });
2914e855dd28SJason M. Bills }
2915e855dd28SJason M. Bills 
29167e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app)
2917e855dd28SJason M. Bills {
29183946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
29193946028dSAppaRao Puli     // method for security reasons.
29207e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
29217e860f15SJohn Edward Broadbent         app,
29227e860f15SJohn Edward Broadbent         "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/")
2923ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
29247e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
2925a4ce114aSNan Zhou             [](const crow::Request& req,
29267e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
29277e860f15SJohn Edward Broadbent                const std::string& logID, const std::string& fileName) {
29282a9beeedSShounak Mitra         // Do not call getRedfishRoute here since the crashdump file is not a
29292a9beeedSShounak Mitra         // Redfish resource.
2930043a0536SJohnathan Mantey         auto getStoredLogCallback =
2931002d39b4SEd Tanous             [asyncResp, logID, fileName, url(boost::urls::url(req.urlView))](
2932abf2add6SEd Tanous                 const boost::system::error_code ec,
2933002d39b4SEd Tanous                 const std::vector<
2934002d39b4SEd Tanous                     std::pair<std::string, dbus::utility::DbusVariantType>>&
29357e860f15SJohn Edward Broadbent                     resp) {
29361da66f75SEd Tanous             if (ec)
29371da66f75SEd Tanous             {
2938002d39b4SEd Tanous                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
2939f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
29401da66f75SEd Tanous                 return;
29411da66f75SEd Tanous             }
2942e855dd28SJason M. Bills 
2943043a0536SJohnathan Mantey             std::string dbusFilename{};
2944043a0536SJohnathan Mantey             std::string dbusTimestamp{};
2945043a0536SJohnathan Mantey             std::string dbusFilepath{};
2946043a0536SJohnathan Mantey 
2947002d39b4SEd Tanous             parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
2948002d39b4SEd Tanous                                      dbusFilepath);
2949043a0536SJohnathan Mantey 
2950043a0536SJohnathan Mantey             if (dbusFilename.empty() || dbusTimestamp.empty() ||
2951043a0536SJohnathan Mantey                 dbusFilepath.empty())
29521da66f75SEd Tanous             {
2953ace85d60SEd Tanous                 messages::resourceMissingAtURI(asyncResp->res, url);
29541da66f75SEd Tanous                 return;
29551da66f75SEd Tanous             }
2956e855dd28SJason M. Bills 
2957043a0536SJohnathan Mantey             // Verify the file name parameter is correct
2958043a0536SJohnathan Mantey             if (fileName != dbusFilename)
2959043a0536SJohnathan Mantey             {
2960ace85d60SEd Tanous                 messages::resourceMissingAtURI(asyncResp->res, url);
2961043a0536SJohnathan Mantey                 return;
2962043a0536SJohnathan Mantey             }
2963043a0536SJohnathan Mantey 
2964043a0536SJohnathan Mantey             if (!std::filesystem::exists(dbusFilepath))
2965043a0536SJohnathan Mantey             {
2966ace85d60SEd Tanous                 messages::resourceMissingAtURI(asyncResp->res, url);
2967043a0536SJohnathan Mantey                 return;
2968043a0536SJohnathan Mantey             }
2969002d39b4SEd Tanous             std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary);
2970002d39b4SEd Tanous             asyncResp->res.body() =
2971002d39b4SEd Tanous                 std::string(std::istreambuf_iterator<char>{ifs}, {});
2972043a0536SJohnathan Mantey 
29737e860f15SJohn Edward Broadbent             // Configure this to be a file download when accessed
29747e860f15SJohn Edward Broadbent             // from a browser
2975d9f6c621SEd Tanous             asyncResp->res.addHeader(
2976d9f6c621SEd Tanous                 boost::beast::http::field::content_disposition, "attachment");
29771da66f75SEd Tanous         };
29781da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
29795b61b5e8SJason M. Bills             std::move(getStoredLogCallback), crashdumpObject,
29805b61b5e8SJason M. Bills             crashdumpPath + std::string("/") + logID,
2981002d39b4SEd Tanous             "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
29827e860f15SJohn Edward Broadbent         });
29831da66f75SEd Tanous }
29841da66f75SEd Tanous 
2985c5a4c82aSJason M. Bills enum class OEMDiagnosticType
2986c5a4c82aSJason M. Bills {
2987c5a4c82aSJason M. Bills     onDemand,
2988c5a4c82aSJason M. Bills     telemetry,
2989c5a4c82aSJason M. Bills     invalid,
2990c5a4c82aSJason M. Bills };
2991c5a4c82aSJason M. Bills 
2992f7725d79SEd Tanous inline OEMDiagnosticType
2993f7725d79SEd Tanous     getOEMDiagnosticType(const std::string_view& oemDiagStr)
2994c5a4c82aSJason M. Bills {
2995c5a4c82aSJason M. Bills     if (oemDiagStr == "OnDemand")
2996c5a4c82aSJason M. Bills     {
2997c5a4c82aSJason M. Bills         return OEMDiagnosticType::onDemand;
2998c5a4c82aSJason M. Bills     }
2999c5a4c82aSJason M. Bills     if (oemDiagStr == "Telemetry")
3000c5a4c82aSJason M. Bills     {
3001c5a4c82aSJason M. Bills         return OEMDiagnosticType::telemetry;
3002c5a4c82aSJason M. Bills     }
3003c5a4c82aSJason M. Bills 
3004c5a4c82aSJason M. Bills     return OEMDiagnosticType::invalid;
3005c5a4c82aSJason M. Bills }
3006c5a4c82aSJason M. Bills 
30077e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app)
30081da66f75SEd Tanous {
30093946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
30103946028dSAppaRao Puli     // method for security reasons.
30110fda0f12SGeorge Liu     BMCWEB_ROUTE(
30120fda0f12SGeorge Liu         app,
30130fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
3014ed398213SEd Tanous         // The below is incorrect;  Should be ConfigureManager
3015ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
3016432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
3017002d39b4SEd Tanous         .methods(boost::beast::http::verb::post)(
3018002d39b4SEd Tanous             [&app](const crow::Request& req,
30197e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
30203ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
302145ca1b86SEd Tanous         {
302245ca1b86SEd Tanous             return;
302345ca1b86SEd Tanous         }
30248e6c099aSJason M. Bills         std::string diagnosticDataType;
30258e6c099aSJason M. Bills         std::string oemDiagnosticDataType;
302615ed6780SWilly Tu         if (!redfish::json_util::readJsonAction(
3027002d39b4SEd Tanous                 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
3028002d39b4SEd Tanous                 "OEMDiagnosticDataType", oemDiagnosticDataType))
30298e6c099aSJason M. Bills         {
30308e6c099aSJason M. Bills             return;
30318e6c099aSJason M. Bills         }
30328e6c099aSJason M. Bills 
30338e6c099aSJason M. Bills         if (diagnosticDataType != "OEM")
30348e6c099aSJason M. Bills         {
30358e6c099aSJason M. Bills             BMCWEB_LOG_ERROR
30368e6c099aSJason M. Bills                 << "Only OEM DiagnosticDataType supported for Crashdump";
30378e6c099aSJason M. Bills             messages::actionParameterValueFormatError(
30388e6c099aSJason M. Bills                 asyncResp->res, diagnosticDataType, "DiagnosticDataType",
30398e6c099aSJason M. Bills                 "CollectDiagnosticData");
30408e6c099aSJason M. Bills             return;
30418e6c099aSJason M. Bills         }
30428e6c099aSJason M. Bills 
3043c5a4c82aSJason M. Bills         OEMDiagnosticType oemDiagType =
3044c5a4c82aSJason M. Bills             getOEMDiagnosticType(oemDiagnosticDataType);
3045c5a4c82aSJason M. Bills 
3046c5a4c82aSJason M. Bills         std::string iface;
3047c5a4c82aSJason M. Bills         std::string method;
3048c5a4c82aSJason M. Bills         std::string taskMatchStr;
3049c5a4c82aSJason M. Bills         if (oemDiagType == OEMDiagnosticType::onDemand)
3050c5a4c82aSJason M. Bills         {
3051c5a4c82aSJason M. Bills             iface = crashdumpOnDemandInterface;
3052c5a4c82aSJason M. Bills             method = "GenerateOnDemandLog";
3053c5a4c82aSJason M. Bills             taskMatchStr = "type='signal',"
3054c5a4c82aSJason M. Bills                            "interface='org.freedesktop.DBus.Properties',"
3055c5a4c82aSJason M. Bills                            "member='PropertiesChanged',"
3056c5a4c82aSJason M. Bills                            "arg0namespace='com.intel.crashdump'";
3057c5a4c82aSJason M. Bills         }
3058c5a4c82aSJason M. Bills         else if (oemDiagType == OEMDiagnosticType::telemetry)
3059c5a4c82aSJason M. Bills         {
3060c5a4c82aSJason M. Bills             iface = crashdumpTelemetryInterface;
3061c5a4c82aSJason M. Bills             method = "GenerateTelemetryLog";
3062c5a4c82aSJason M. Bills             taskMatchStr = "type='signal',"
3063c5a4c82aSJason M. Bills                            "interface='org.freedesktop.DBus.Properties',"
3064c5a4c82aSJason M. Bills                            "member='PropertiesChanged',"
3065c5a4c82aSJason M. Bills                            "arg0namespace='com.intel.crashdump'";
3066c5a4c82aSJason M. Bills         }
3067c5a4c82aSJason M. Bills         else
3068c5a4c82aSJason M. Bills         {
3069c5a4c82aSJason M. Bills             BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: "
3070c5a4c82aSJason M. Bills                              << oemDiagnosticDataType;
3071c5a4c82aSJason M. Bills             messages::actionParameterValueFormatError(
3072002d39b4SEd Tanous                 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType",
3073002d39b4SEd Tanous                 "CollectDiagnosticData");
3074c5a4c82aSJason M. Bills             return;
3075c5a4c82aSJason M. Bills         }
3076c5a4c82aSJason M. Bills 
3077c5a4c82aSJason M. Bills         auto collectCrashdumpCallback =
3078c5a4c82aSJason M. Bills             [asyncResp, payload(task::Payload(req)),
3079c5a4c82aSJason M. Bills              taskMatchStr](const boost::system::error_code ec,
308098be3e39SEd Tanous                            const std::string&) mutable {
30811da66f75SEd Tanous             if (ec)
30821da66f75SEd Tanous             {
3083002d39b4SEd Tanous                 if (ec.value() == boost::system::errc::operation_not_supported)
30841da66f75SEd Tanous                 {
3085f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
30861da66f75SEd Tanous                 }
30874363d3b2SJason M. Bills                 else if (ec.value() ==
30884363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
30894363d3b2SJason M. Bills                 {
3090002d39b4SEd Tanous                     messages::serviceTemporarilyUnavailable(asyncResp->res,
3091002d39b4SEd Tanous                                                             "60");
30924363d3b2SJason M. Bills                 }
30931da66f75SEd Tanous                 else
30941da66f75SEd Tanous                 {
3095f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
30961da66f75SEd Tanous                 }
30971da66f75SEd Tanous                 return;
30981da66f75SEd Tanous             }
3099002d39b4SEd Tanous             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
310059d494eeSPatrick Williams                 [](boost::system::error_code err, sdbusplus::message_t&,
3101002d39b4SEd Tanous                    const std::shared_ptr<task::TaskData>& taskData) {
310266afe4faSJames Feist                 if (!err)
310366afe4faSJames Feist                 {
3104002d39b4SEd Tanous                     taskData->messages.emplace_back(messages::taskCompletedOK(
3105e5d5006bSJames Feist                         std::to_string(taskData->index)));
3106831d6b09SJames Feist                     taskData->state = "Completed";
310766afe4faSJames Feist                 }
310832898ceaSJames Feist                 return task::completed;
310966afe4faSJames Feist                 },
3110c5a4c82aSJason M. Bills                 taskMatchStr);
3111c5a4c82aSJason M. Bills 
311246229577SJames Feist             task->startTimer(std::chrono::minutes(5));
311346229577SJames Feist             task->populateResp(asyncResp->res);
311498be3e39SEd Tanous             task->payload.emplace(std::move(payload));
31151da66f75SEd Tanous         };
31168e6c099aSJason M. Bills 
31171da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
3118002d39b4SEd Tanous             std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath,
3119002d39b4SEd Tanous             iface, method);
31207e860f15SJohn Edward Broadbent         });
31216eda7685SKenny L. Ku }
31226eda7685SKenny L. Ku 
3123cb92c03bSAndrew Geissler /**
3124cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3125cb92c03bSAndrew Geissler  */
31267e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app)
3127cb92c03bSAndrew Geissler {
3128cb92c03bSAndrew Geissler     /**
3129cb92c03bSAndrew Geissler      * Function handles POST method request.
3130cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
3131cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
3132cb92c03bSAndrew Geissler      */
31337e860f15SJohn Edward Broadbent 
31340fda0f12SGeorge Liu     BMCWEB_ROUTE(
31350fda0f12SGeorge Liu         app,
31360fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/")
3137ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
31387e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
313945ca1b86SEd Tanous             [&app](const crow::Request& req,
31407e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
31413ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
314245ca1b86SEd Tanous         {
314345ca1b86SEd Tanous             return;
314445ca1b86SEd Tanous         }
3145cb92c03bSAndrew Geissler         BMCWEB_LOG_DEBUG << "Do delete all entries.";
3146cb92c03bSAndrew Geissler 
3147cb92c03bSAndrew Geissler         // Process response from Logging service.
3148002d39b4SEd Tanous         auto respHandler = [asyncResp](const boost::system::error_code ec) {
3149002d39b4SEd Tanous             BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
3150cb92c03bSAndrew Geissler             if (ec)
3151cb92c03bSAndrew Geissler             {
3152cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
3153002d39b4SEd Tanous                 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
3154cb92c03bSAndrew Geissler                 asyncResp->res.result(
3155cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
3156cb92c03bSAndrew Geissler                 return;
3157cb92c03bSAndrew Geissler             }
3158cb92c03bSAndrew Geissler 
3159002d39b4SEd Tanous             asyncResp->res.result(boost::beast::http::status::no_content);
3160cb92c03bSAndrew Geissler         };
3161cb92c03bSAndrew Geissler 
3162cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
3163cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
31642c70f800SEd Tanous             respHandler, "xyz.openbmc_project.Logging",
3165cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
3166cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
31677e860f15SJohn Edward Broadbent         });
3168cb92c03bSAndrew Geissler }
3169a3316fc6SZhikuiRen 
3170a3316fc6SZhikuiRen /****************************************************
3171a3316fc6SZhikuiRen  * Redfish PostCode interfaces
3172a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
3173a3316fc6SZhikuiRen  ******************************************************/
31747e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app)
3175a3316fc6SZhikuiRen {
31767e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
3177ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
3178002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
3179002d39b4SEd Tanous             [&app](const crow::Request& req,
3180002d39b4SEd Tanous                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
31813ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
318245ca1b86SEd Tanous         {
318345ca1b86SEd Tanous             return;
318445ca1b86SEd Tanous         }
31851476687dSEd Tanous 
31861476687dSEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
31871476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/PostCodes";
31881476687dSEd Tanous         asyncResp->res.jsonValue["@odata.type"] =
31891476687dSEd Tanous             "#LogService.v1_1_0.LogService";
31901476687dSEd Tanous         asyncResp->res.jsonValue["Name"] = "POST Code Log Service";
31911476687dSEd Tanous         asyncResp->res.jsonValue["Description"] = "POST Code Log Service";
31921476687dSEd Tanous         asyncResp->res.jsonValue["Id"] = "BIOS POST Code Log";
31931476687dSEd Tanous         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
31941476687dSEd Tanous         asyncResp->res.jsonValue["Entries"]["@odata.id"] =
31951476687dSEd Tanous             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
31967c8c4058STejas Patil 
31977c8c4058STejas Patil         std::pair<std::string, std::string> redfishDateTimeOffset =
31982b82937eSEd Tanous             redfish::time_utils::getDateTimeOffsetNow();
31990fda0f12SGeorge Liu         asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
32007c8c4058STejas Patil         asyncResp->res.jsonValue["DateTimeLocalOffset"] =
32017c8c4058STejas Patil             redfishDateTimeOffset.second;
32027c8c4058STejas Patil 
3203a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
32047e860f15SJohn Edward Broadbent             {"target",
32050fda0f12SGeorge Liu              "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}};
32067e860f15SJohn Edward Broadbent         });
3207a3316fc6SZhikuiRen }
3208a3316fc6SZhikuiRen 
32097e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app)
3210a3316fc6SZhikuiRen {
32110fda0f12SGeorge Liu     BMCWEB_ROUTE(
32120fda0f12SGeorge Liu         app,
32130fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/")
3214ed398213SEd Tanous         // The following privilege is incorrect;  It should be ConfigureManager
3215ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
3216432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
32177e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
321845ca1b86SEd Tanous             [&app](const crow::Request& req,
32197e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
32203ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
322145ca1b86SEd Tanous         {
322245ca1b86SEd Tanous             return;
322345ca1b86SEd Tanous         }
3224a3316fc6SZhikuiRen         BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
3225a3316fc6SZhikuiRen 
3226a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
3227a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
3228a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec) {
3229a3316fc6SZhikuiRen             if (ec)
3230a3316fc6SZhikuiRen             {
3231a3316fc6SZhikuiRen                 // TODO Handle for specific error code
3232002d39b4SEd Tanous                 BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error "
32337e860f15SJohn Edward Broadbent                                  << ec;
3234002d39b4SEd Tanous                 asyncResp->res.result(
3235002d39b4SEd Tanous                     boost::beast::http::status::internal_server_error);
3236a3316fc6SZhikuiRen                 messages::internalError(asyncResp->res);
3237a3316fc6SZhikuiRen                 return;
3238a3316fc6SZhikuiRen             }
3239a3316fc6SZhikuiRen             },
324015124765SJonathan Doman             "xyz.openbmc_project.State.Boot.PostCode0",
324115124765SJonathan Doman             "/xyz/openbmc_project/State/Boot/PostCode0",
3242a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
32437e860f15SJohn Edward Broadbent         });
3244a3316fc6SZhikuiRen }
3245a3316fc6SZhikuiRen 
3246a3316fc6SZhikuiRen static void fillPostCodeEntry(
32478d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& aResp,
32486c9a279eSManojkiran Eda     const boost::container::flat_map<
32496c9a279eSManojkiran Eda         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
3250a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
3251a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
3252a3316fc6SZhikuiRen {
3253a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
3254fffb8c1fSEd Tanous     const registries::Message* message =
3255fffb8c1fSEd Tanous         registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
3256a3316fc6SZhikuiRen 
3257a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
3258a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
3259a3316fc6SZhikuiRen 
3260a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
32616c9a279eSManojkiran Eda     for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
32626c9a279eSManojkiran Eda              code : postcode)
3263a3316fc6SZhikuiRen     {
3264a3316fc6SZhikuiRen         currentCodeIndex++;
3265a3316fc6SZhikuiRen         std::string postcodeEntryID =
3266a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
3267a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
3268a3316fc6SZhikuiRen 
3269a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
3270a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
3271a3316fc6SZhikuiRen 
3272a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
3273a3316fc6SZhikuiRen         { // already incremented
3274a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
3275a3316fc6SZhikuiRen         }
3276a3316fc6SZhikuiRen         else
3277a3316fc6SZhikuiRen         {
3278a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
3279a3316fc6SZhikuiRen         }
3280a3316fc6SZhikuiRen 
3281a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
3282a3316fc6SZhikuiRen         // not fall between top and skip
3283a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
3284a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
3285a3316fc6SZhikuiRen         {
3286a3316fc6SZhikuiRen             continue;
3287a3316fc6SZhikuiRen         }
3288a3316fc6SZhikuiRen 
32894e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
3290a3316fc6SZhikuiRen         // currentIndex
3291a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3292a3316fc6SZhikuiRen         {
3293a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
3294a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
3295a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
3296a3316fc6SZhikuiRen             continue;
3297a3316fc6SZhikuiRen         }
3298a3316fc6SZhikuiRen 
3299a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
3300a3316fc6SZhikuiRen         // index
3301a3316fc6SZhikuiRen 
3302a3316fc6SZhikuiRen         // Get the Created time from the timestamp
3303a3316fc6SZhikuiRen         std::string entryTimeStr;
33041d8782e7SNan Zhou         entryTimeStr =
33052b82937eSEd Tanous             redfish::time_utils::getDateTimeUint(usecSinceEpoch / 1000 / 1000);
3306a3316fc6SZhikuiRen 
3307a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3308a3316fc6SZhikuiRen         std::ostringstream hexCode;
3309a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
33106c9a279eSManojkiran Eda                 << std::get<0>(code.second);
3311a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
3312a3316fc6SZhikuiRen         // Set Fixed -Point Notation
3313a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
3314a3316fc6SZhikuiRen         // Set precision to 4 digits
3315a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
3316a3316fc6SZhikuiRen         // Add double to stream
3317a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
3318a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
3319a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
3320a3316fc6SZhikuiRen 
3321a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
3322a3316fc6SZhikuiRen         std::string msg;
3323a3316fc6SZhikuiRen         if (message != nullptr)
3324a3316fc6SZhikuiRen         {
3325a3316fc6SZhikuiRen             msg = message->message;
3326a3316fc6SZhikuiRen 
3327a3316fc6SZhikuiRen             // fill in this post code value
3328a3316fc6SZhikuiRen             int i = 0;
3329a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
3330a3316fc6SZhikuiRen             {
3331a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
3332a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
3333a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
3334a3316fc6SZhikuiRen                 {
3335a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
3336a3316fc6SZhikuiRen                 }
3337a3316fc6SZhikuiRen             }
3338a3316fc6SZhikuiRen         }
3339a3316fc6SZhikuiRen 
3340d4342a92STim Lee         // Get Severity template from message registry
3341d4342a92STim Lee         std::string severity;
3342d4342a92STim Lee         if (message != nullptr)
3343d4342a92STim Lee         {
33445f2b84eeSEd Tanous             severity = message->messageSeverity;
3345d4342a92STim Lee         }
3346d4342a92STim Lee 
3347a3316fc6SZhikuiRen         // add to AsyncResp
3348a3316fc6SZhikuiRen         logEntryArray.push_back({});
3349a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
335084afc48bSJason M. Bills         bmcLogEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
335184afc48bSJason M. Bills         bmcLogEntry["@odata.id"] =
33520fda0f12SGeorge Liu             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
335384afc48bSJason M. Bills             postcodeEntryID;
335484afc48bSJason M. Bills         bmcLogEntry["Name"] = "POST Code Log Entry";
335584afc48bSJason M. Bills         bmcLogEntry["Id"] = postcodeEntryID;
335684afc48bSJason M. Bills         bmcLogEntry["Message"] = std::move(msg);
335784afc48bSJason M. Bills         bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode";
335884afc48bSJason M. Bills         bmcLogEntry["MessageArgs"] = std::move(messageArgs);
335984afc48bSJason M. Bills         bmcLogEntry["EntryType"] = "Event";
336084afc48bSJason M. Bills         bmcLogEntry["Severity"] = std::move(severity);
336184afc48bSJason M. Bills         bmcLogEntry["Created"] = entryTimeStr;
3362647b3cdcSGeorge Liu         if (!std::get<std::vector<uint8_t>>(code.second).empty())
3363647b3cdcSGeorge Liu         {
3364647b3cdcSGeorge Liu             bmcLogEntry["AdditionalDataURI"] =
3365647b3cdcSGeorge Liu                 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
3366647b3cdcSGeorge Liu                 postcodeEntryID + "/attachment";
3367647b3cdcSGeorge Liu         }
3368a3316fc6SZhikuiRen     }
3369a3316fc6SZhikuiRen }
3370a3316fc6SZhikuiRen 
33718d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3372a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
3373a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
3374a3316fc6SZhikuiRen {
3375a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
33766c9a279eSManojkiran Eda         [aResp, bootIndex,
33776c9a279eSManojkiran Eda          codeIndex](const boost::system::error_code ec,
33786c9a279eSManojkiran Eda                     const boost::container::flat_map<
33796c9a279eSManojkiran Eda                         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
33806c9a279eSManojkiran Eda                         postcode) {
3381a3316fc6SZhikuiRen         if (ec)
3382a3316fc6SZhikuiRen         {
3383a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3384a3316fc6SZhikuiRen             messages::internalError(aResp->res);
3385a3316fc6SZhikuiRen             return;
3386a3316fc6SZhikuiRen         }
3387a3316fc6SZhikuiRen 
3388a3316fc6SZhikuiRen         // skip the empty postcode boots
3389a3316fc6SZhikuiRen         if (postcode.empty())
3390a3316fc6SZhikuiRen         {
3391a3316fc6SZhikuiRen             return;
3392a3316fc6SZhikuiRen         }
3393a3316fc6SZhikuiRen 
3394a3316fc6SZhikuiRen         fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
3395a3316fc6SZhikuiRen 
3396a3316fc6SZhikuiRen         aResp->res.jsonValue["Members@odata.count"] =
3397a3316fc6SZhikuiRen             aResp->res.jsonValue["Members"].size();
3398a3316fc6SZhikuiRen         },
339915124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
340015124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3401a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3402a3316fc6SZhikuiRen         bootIndex);
3403a3316fc6SZhikuiRen }
3404a3316fc6SZhikuiRen 
34058d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3406a3316fc6SZhikuiRen                                const uint16_t bootIndex,
3407a3316fc6SZhikuiRen                                const uint16_t bootCount,
34083648c8beSEd Tanous                                const uint64_t entryCount, size_t skip,
34093648c8beSEd Tanous                                size_t top)
3410a3316fc6SZhikuiRen {
3411a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3412a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
3413a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
34146c9a279eSManojkiran Eda               const boost::container::flat_map<
34156c9a279eSManojkiran Eda                   uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
34166c9a279eSManojkiran Eda                   postcode) {
3417a3316fc6SZhikuiRen         if (ec)
3418a3316fc6SZhikuiRen         {
3419a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3420a3316fc6SZhikuiRen             messages::internalError(aResp->res);
3421a3316fc6SZhikuiRen             return;
3422a3316fc6SZhikuiRen         }
3423a3316fc6SZhikuiRen 
3424a3316fc6SZhikuiRen         uint64_t endCount = entryCount;
3425a3316fc6SZhikuiRen         if (!postcode.empty())
3426a3316fc6SZhikuiRen         {
3427a3316fc6SZhikuiRen             endCount = entryCount + postcode.size();
34283648c8beSEd Tanous             if (skip < endCount && (top + skip) > entryCount)
3429a3316fc6SZhikuiRen             {
34303648c8beSEd Tanous                 uint64_t thisBootSkip =
34313648c8beSEd Tanous                     std::max(static_cast<uint64_t>(skip), entryCount) -
34323648c8beSEd Tanous                     entryCount;
3433a3316fc6SZhikuiRen                 uint64_t thisBootTop =
34343648c8beSEd Tanous                     std::min(static_cast<uint64_t>(top + skip), endCount) -
34353648c8beSEd Tanous                     entryCount;
3436a3316fc6SZhikuiRen 
3437002d39b4SEd Tanous                 fillPostCodeEntry(aResp, postcode, bootIndex, 0, thisBootSkip,
3438002d39b4SEd Tanous                                   thisBootTop);
3439a3316fc6SZhikuiRen             }
3440a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] = endCount;
3441a3316fc6SZhikuiRen         }
3442a3316fc6SZhikuiRen 
3443a3316fc6SZhikuiRen         // continue to previous bootIndex
3444a3316fc6SZhikuiRen         if (bootIndex < bootCount)
3445a3316fc6SZhikuiRen         {
3446a3316fc6SZhikuiRen             getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3447a3316fc6SZhikuiRen                                bootCount, endCount, skip, top);
3448a3316fc6SZhikuiRen         }
344981584abeSJiaqing Zhao         else if (skip + top < endCount)
3450a3316fc6SZhikuiRen         {
3451a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.nextLink"] =
34520fda0f12SGeorge Liu                 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" +
3453a3316fc6SZhikuiRen                 std::to_string(skip + top);
3454a3316fc6SZhikuiRen         }
3455a3316fc6SZhikuiRen         },
345615124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
345715124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3458a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3459a3316fc6SZhikuiRen         bootIndex);
3460a3316fc6SZhikuiRen }
3461a3316fc6SZhikuiRen 
34628d1b46d7Szhanghch05 static void
34638d1b46d7Szhanghch05     getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
34643648c8beSEd Tanous                          size_t skip, size_t top)
3465a3316fc6SZhikuiRen {
3466a3316fc6SZhikuiRen     uint64_t entryCount = 0;
34671e1e598dSJonathan Doman     sdbusplus::asio::getProperty<uint16_t>(
34681e1e598dSJonathan Doman         *crow::connections::systemBus,
34691e1e598dSJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
34701e1e598dSJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
34711e1e598dSJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount",
34721e1e598dSJonathan Doman         [aResp, entryCount, skip, top](const boost::system::error_code ec,
34731e1e598dSJonathan Doman                                        const uint16_t bootCount) {
3474a3316fc6SZhikuiRen         if (ec)
3475a3316fc6SZhikuiRen         {
3476a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3477a3316fc6SZhikuiRen             messages::internalError(aResp->res);
3478a3316fc6SZhikuiRen             return;
3479a3316fc6SZhikuiRen         }
34801e1e598dSJonathan Doman         getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top);
34811e1e598dSJonathan Doman         });
3482a3316fc6SZhikuiRen }
3483a3316fc6SZhikuiRen 
34847e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app)
3485a3316fc6SZhikuiRen {
34867e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
34877e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3488ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
34897e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
349045ca1b86SEd Tanous             [&app](const crow::Request& req,
34917e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
3492c937d2bfSEd Tanous         query_param::QueryCapabilities capabilities = {
3493c937d2bfSEd Tanous             .canDelegateTop = true,
3494c937d2bfSEd Tanous             .canDelegateSkip = true,
3495c937d2bfSEd Tanous         };
3496c937d2bfSEd Tanous         query_param::Query delegatedQuery;
3497c937d2bfSEd Tanous         if (!redfish::setUpRedfishRouteWithDelegation(
34983ba00073SCarson Labrado                 app, req, asyncResp, delegatedQuery, capabilities))
349945ca1b86SEd Tanous         {
350045ca1b86SEd Tanous             return;
350145ca1b86SEd Tanous         }
3502a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
3503a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
3504a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3505a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3506a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3507a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3508a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3509a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3510a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
35113648c8beSEd Tanous         size_t skip = delegatedQuery.skip.value_or(0);
35125143f7a5SJiaqing Zhao         size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
35133648c8beSEd Tanous         getCurrentBootNumber(asyncResp, skip, top);
35147e860f15SJohn Edward Broadbent         });
3515a3316fc6SZhikuiRen }
3516a3316fc6SZhikuiRen 
3517647b3cdcSGeorge Liu /**
3518647b3cdcSGeorge Liu  * @brief Parse post code ID and get the current value and index value
3519647b3cdcSGeorge Liu  *        eg: postCodeID=B1-2, currentValue=1, index=2
3520647b3cdcSGeorge Liu  *
3521647b3cdcSGeorge Liu  * @param[in]  postCodeID     Post Code ID
3522647b3cdcSGeorge Liu  * @param[out] currentValue   Current value
3523647b3cdcSGeorge Liu  * @param[out] index          Index value
3524647b3cdcSGeorge Liu  *
3525647b3cdcSGeorge Liu  * @return bool true if the parsing is successful, false the parsing fails
3526647b3cdcSGeorge Liu  */
3527647b3cdcSGeorge Liu inline static bool parsePostCode(const std::string& postCodeID,
3528647b3cdcSGeorge Liu                                  uint64_t& currentValue, uint16_t& index)
3529647b3cdcSGeorge Liu {
3530647b3cdcSGeorge Liu     std::vector<std::string> split;
3531647b3cdcSGeorge Liu     boost::algorithm::split(split, postCodeID, boost::is_any_of("-"));
3532647b3cdcSGeorge Liu     if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B')
3533647b3cdcSGeorge Liu     {
3534647b3cdcSGeorge Liu         return false;
3535647b3cdcSGeorge Liu     }
3536647b3cdcSGeorge Liu 
3537ca45aa3cSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
3538647b3cdcSGeorge Liu     const char* start = split[0].data() + 1;
3539ca45aa3cSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
3540647b3cdcSGeorge Liu     const char* end = split[0].data() + split[0].size();
3541647b3cdcSGeorge Liu     auto [ptrIndex, ecIndex] = std::from_chars(start, end, index);
3542647b3cdcSGeorge Liu 
3543647b3cdcSGeorge Liu     if (ptrIndex != end || ecIndex != std::errc())
3544647b3cdcSGeorge Liu     {
3545647b3cdcSGeorge Liu         return false;
3546647b3cdcSGeorge Liu     }
3547647b3cdcSGeorge Liu 
3548647b3cdcSGeorge Liu     start = split[1].data();
3549ca45aa3cSEd Tanous 
3550ca45aa3cSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
3551647b3cdcSGeorge Liu     end = split[1].data() + split[1].size();
3552647b3cdcSGeorge Liu     auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue);
3553647b3cdcSGeorge Liu 
3554517d9a58STony Lee     return ptrValue == end && ecValue == std::errc();
3555647b3cdcSGeorge Liu }
3556647b3cdcSGeorge Liu 
3557647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app)
3558647b3cdcSGeorge Liu {
35590fda0f12SGeorge Liu     BMCWEB_ROUTE(
35600fda0f12SGeorge Liu         app,
35610fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/")
3562647b3cdcSGeorge Liu         .privileges(redfish::privileges::getLogEntry)
3563647b3cdcSGeorge Liu         .methods(boost::beast::http::verb::get)(
356445ca1b86SEd Tanous             [&app](const crow::Request& req,
3565647b3cdcSGeorge Liu                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3566647b3cdcSGeorge Liu                    const std::string& postCodeID) {
35673ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
356845ca1b86SEd Tanous         {
356945ca1b86SEd Tanous             return;
357045ca1b86SEd Tanous         }
3571002d39b4SEd Tanous         if (!http_helpers::isOctetAccepted(req.getHeaderValue("Accept")))
3572647b3cdcSGeorge Liu         {
3573002d39b4SEd Tanous             asyncResp->res.result(boost::beast::http::status::bad_request);
3574647b3cdcSGeorge Liu             return;
3575647b3cdcSGeorge Liu         }
3576647b3cdcSGeorge Liu 
3577647b3cdcSGeorge Liu         uint64_t currentValue = 0;
3578647b3cdcSGeorge Liu         uint16_t index = 0;
3579647b3cdcSGeorge Liu         if (!parsePostCode(postCodeID, currentValue, index))
3580647b3cdcSGeorge Liu         {
3581002d39b4SEd Tanous             messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID);
3582647b3cdcSGeorge Liu             return;
3583647b3cdcSGeorge Liu         }
3584647b3cdcSGeorge Liu 
3585647b3cdcSGeorge Liu         crow::connections::systemBus->async_method_call(
3586647b3cdcSGeorge Liu             [asyncResp, postCodeID, currentValue](
3587647b3cdcSGeorge Liu                 const boost::system::error_code ec,
3588002d39b4SEd Tanous                 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>&
3589002d39b4SEd Tanous                     postcodes) {
3590647b3cdcSGeorge Liu             if (ec.value() == EBADR)
3591647b3cdcSGeorge Liu             {
3592002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry",
3593002d39b4SEd Tanous                                            postCodeID);
3594647b3cdcSGeorge Liu                 return;
3595647b3cdcSGeorge Liu             }
3596647b3cdcSGeorge Liu             if (ec)
3597647b3cdcSGeorge Liu             {
3598647b3cdcSGeorge Liu                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3599647b3cdcSGeorge Liu                 messages::internalError(asyncResp->res);
3600647b3cdcSGeorge Liu                 return;
3601647b3cdcSGeorge Liu             }
3602647b3cdcSGeorge Liu 
3603647b3cdcSGeorge Liu             size_t value = static_cast<size_t>(currentValue) - 1;
3604002d39b4SEd Tanous             if (value == std::string::npos || postcodes.size() < currentValue)
3605647b3cdcSGeorge Liu             {
3606647b3cdcSGeorge Liu                 BMCWEB_LOG_ERROR << "Wrong currentValue value";
3607002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry",
3608002d39b4SEd Tanous                                            postCodeID);
3609647b3cdcSGeorge Liu                 return;
3610647b3cdcSGeorge Liu             }
3611647b3cdcSGeorge Liu 
36129eb808c1SEd Tanous             const auto& [tID, c] = postcodes[value];
361346ff87baSEd Tanous             if (c.empty())
3614647b3cdcSGeorge Liu             {
3615647b3cdcSGeorge Liu                 BMCWEB_LOG_INFO << "No found post code data";
3616002d39b4SEd Tanous                 messages::resourceNotFound(asyncResp->res, "LogEntry",
3617002d39b4SEd Tanous                                            postCodeID);
3618647b3cdcSGeorge Liu                 return;
3619647b3cdcSGeorge Liu             }
362046ff87baSEd Tanous             // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
362146ff87baSEd Tanous             const char* d = reinterpret_cast<const char*>(c.data());
362246ff87baSEd Tanous             std::string_view strData(d, c.size());
3623647b3cdcSGeorge Liu 
3624d9f6c621SEd Tanous             asyncResp->res.addHeader(boost::beast::http::field::content_type,
3625647b3cdcSGeorge Liu                                      "application/octet-stream");
3626d9f6c621SEd Tanous             asyncResp->res.addHeader(
3627d9f6c621SEd Tanous                 boost::beast::http::field::content_transfer_encoding, "Base64");
3628002d39b4SEd Tanous             asyncResp->res.body() = crow::utility::base64encode(strData);
3629647b3cdcSGeorge Liu             },
3630647b3cdcSGeorge Liu             "xyz.openbmc_project.State.Boot.PostCode0",
3631647b3cdcSGeorge Liu             "/xyz/openbmc_project/State/Boot/PostCode0",
3632002d39b4SEd Tanous             "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index);
3633647b3cdcSGeorge Liu         });
3634647b3cdcSGeorge Liu }
3635647b3cdcSGeorge Liu 
36367e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app)
3637a3316fc6SZhikuiRen {
36387e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
36397e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/")
3640ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
36417e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
364245ca1b86SEd Tanous             [&app](const crow::Request& req,
36437e860f15SJohn Edward Broadbent                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
36447e860f15SJohn Edward Broadbent                    const std::string& targetID) {
36453ba00073SCarson Labrado         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
364645ca1b86SEd Tanous         {
364745ca1b86SEd Tanous             return;
364845ca1b86SEd Tanous         }
3649647b3cdcSGeorge Liu         uint16_t bootIndex = 0;
3650647b3cdcSGeorge Liu         uint64_t codeIndex = 0;
3651647b3cdcSGeorge Liu         if (!parsePostCode(targetID, codeIndex, bootIndex))
3652a3316fc6SZhikuiRen         {
3653a3316fc6SZhikuiRen             // Requested ID was not found
3654ace85d60SEd Tanous             messages::resourceMissingAtURI(asyncResp->res, req.urlView);
3655a3316fc6SZhikuiRen             return;
3656a3316fc6SZhikuiRen         }
3657a3316fc6SZhikuiRen         if (bootIndex == 0 || codeIndex == 0)
3658a3316fc6SZhikuiRen         {
3659a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
36607e860f15SJohn Edward Broadbent                              << targetID;
3661a3316fc6SZhikuiRen         }
3662a3316fc6SZhikuiRen 
3663002d39b4SEd Tanous         asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
3664a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
36650fda0f12SGeorge Liu             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3666a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3667a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3668a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3669a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3670a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3671a3316fc6SZhikuiRen 
3672a3316fc6SZhikuiRen         getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
36737e860f15SJohn Edward Broadbent         });
3674a3316fc6SZhikuiRen }
3675a3316fc6SZhikuiRen 
36761da66f75SEd Tanous } // namespace redfish
3677