xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision ca45aa3c416e55027b8d17078bac6493e81d564f)
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>
30400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp>
314851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp>
32400fd1fbSAdriana Kobylak #include <boost/beast/http.hpp>
331da66f75SEd Tanous #include <boost/container/flat_map.hpp>
341ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp>
35168e20c1SEd Tanous #include <dbus_utility.hpp>
36cb92c03bSAndrew Geissler #include <error_messages.hpp>
37ed398213SEd Tanous #include <registries/privilege_registry.hpp>
381214b7e7SGunnar Mills 
39647b3cdcSGeorge Liu #include <charconv>
404418c7f0SJames Feist #include <filesystem>
4175710de2SXiaochao Ma #include <optional>
4226702d01SEd Tanous #include <span>
43cd225da8SJason M. Bills #include <string_view>
44abf2add6SEd Tanous #include <variant>
451da66f75SEd Tanous 
461da66f75SEd Tanous namespace redfish
471da66f75SEd Tanous {
481da66f75SEd Tanous 
495b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump";
505b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump";
515b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump";
525b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
535b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
545b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
55424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
566eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface =
576eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
581da66f75SEd Tanous 
594851d45dSJason M. Bills namespace message_registries
604851d45dSJason M. Bills {
6126702d01SEd Tanous static const Message*
6226702d01SEd Tanous     getMessageFromRegistry(const std::string& messageKey,
6326702d01SEd Tanous                            const std::span<const MessageEntry> registry)
644851d45dSJason M. Bills {
6526702d01SEd Tanous     std::span<const MessageEntry>::iterator messageIt = std::find_if(
6626702d01SEd Tanous         registry.begin(), registry.end(),
674851d45dSJason M. Bills         [&messageKey](const MessageEntry& messageEntry) {
6826702d01SEd Tanous             return !std::strcmp(messageEntry.first, messageKey.c_str());
694851d45dSJason M. Bills         });
7026702d01SEd Tanous     if (messageIt != registry.end())
714851d45dSJason M. Bills     {
724851d45dSJason M. Bills         return &messageIt->second;
734851d45dSJason M. Bills     }
744851d45dSJason M. Bills 
754851d45dSJason M. Bills     return nullptr;
764851d45dSJason M. Bills }
774851d45dSJason M. Bills 
784851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
794851d45dSJason M. Bills {
804851d45dSJason M. Bills     // Redfish MessageIds are in the form
814851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
824851d45dSJason M. Bills     // the right Message
834851d45dSJason M. Bills     std::vector<std::string> fields;
844851d45dSJason M. Bills     fields.reserve(4);
854851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
864851d45dSJason M. Bills     std::string& registryName = fields[0];
874851d45dSJason M. Bills     std::string& messageKey = fields[3];
884851d45dSJason M. Bills 
894851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
904851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
914851d45dSJason M. Bills     {
924851d45dSJason M. Bills         return getMessageFromRegistry(
9326702d01SEd Tanous             messageKey, std::span<const MessageEntry>(base::registry));
944851d45dSJason M. Bills     }
954851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
964851d45dSJason M. Bills     {
974851d45dSJason M. Bills         return getMessageFromRegistry(
9826702d01SEd Tanous             messageKey, std::span<const MessageEntry>(openbmc::registry));
994851d45dSJason M. Bills     }
1004851d45dSJason M. Bills     return nullptr;
1014851d45dSJason M. Bills }
1024851d45dSJason M. Bills } // namespace message_registries
1034851d45dSJason M. Bills 
104f6150403SJames Feist namespace fs = std::filesystem;
1051da66f75SEd Tanous 
106168e20c1SEd Tanous using GetManagedPropertyType =
107168e20c1SEd Tanous     boost::container::flat_map<std::string, dbus::utility::DbusVariantType>;
108cb92c03bSAndrew Geissler 
109cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
110cb92c03bSAndrew Geissler {
111d4d25793SEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
112d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
113d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
114d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
115cb92c03bSAndrew Geissler     {
116cb92c03bSAndrew Geissler         return "Critical";
117cb92c03bSAndrew Geissler     }
1183174e4dfSEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
119d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
120d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
121cb92c03bSAndrew Geissler     {
122cb92c03bSAndrew Geissler         return "OK";
123cb92c03bSAndrew Geissler     }
1243174e4dfSEd Tanous     if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
125cb92c03bSAndrew Geissler     {
126cb92c03bSAndrew Geissler         return "Warning";
127cb92c03bSAndrew Geissler     }
128cb92c03bSAndrew Geissler     return "";
129cb92c03bSAndrew Geissler }
130cb92c03bSAndrew Geissler 
1317e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
13239e77504SEd Tanous                                      const std::string_view& field,
13339e77504SEd Tanous                                      std::string_view& contents)
13416428a1aSJason M. Bills {
13516428a1aSJason M. Bills     const char* data = nullptr;
13616428a1aSJason M. Bills     size_t length = 0;
13716428a1aSJason M. Bills     int ret = 0;
13816428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
13946ff87baSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
14046ff87baSEd Tanous     const void** dataVoid = reinterpret_cast<const void**>(&data);
14146ff87baSEd Tanous 
14246ff87baSEd Tanous     ret = sd_journal_get_data(journal, field.data(), dataVoid, &length);
14316428a1aSJason M. Bills     if (ret < 0)
14416428a1aSJason M. Bills     {
14516428a1aSJason M. Bills         return ret;
14616428a1aSJason M. Bills     }
14739e77504SEd Tanous     contents = std::string_view(data, length);
14816428a1aSJason M. Bills     // Only use the content after the "=" character.
14981ce609eSEd Tanous     contents.remove_prefix(std::min(contents.find('=') + 1, contents.size()));
15016428a1aSJason M. Bills     return ret;
15116428a1aSJason M. Bills }
15216428a1aSJason M. Bills 
1537e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
1547e860f15SJohn Edward Broadbent                                      const std::string_view& field,
1557e860f15SJohn Edward Broadbent                                      const int& base, long int& contents)
15616428a1aSJason M. Bills {
15716428a1aSJason M. Bills     int ret = 0;
15839e77504SEd Tanous     std::string_view metadata;
15916428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
16016428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
16116428a1aSJason M. Bills     if (ret < 0)
16216428a1aSJason M. Bills     {
16316428a1aSJason M. Bills         return ret;
16416428a1aSJason M. Bills     }
165b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
16616428a1aSJason M. Bills     return ret;
16716428a1aSJason M. Bills }
16816428a1aSJason M. Bills 
1697e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal,
1707e860f15SJohn Edward Broadbent                                      std::string& entryTimestamp)
171a3316fc6SZhikuiRen {
172a3316fc6SZhikuiRen     int ret = 0;
173a3316fc6SZhikuiRen     uint64_t timestamp = 0;
174a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
175a3316fc6SZhikuiRen     if (ret < 0)
176a3316fc6SZhikuiRen     {
177a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
178a3316fc6SZhikuiRen                          << strerror(-ret);
179a3316fc6SZhikuiRen         return false;
180a3316fc6SZhikuiRen     }
1811d8782e7SNan Zhou     entryTimestamp = crow::utility::getDateTimeUint(timestamp / 1000 / 1000);
1829c620e21SAsmitha Karunanithi     return true;
183a3316fc6SZhikuiRen }
184a3316fc6SZhikuiRen 
1858d1b46d7Szhanghch05 static bool getSkipParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1868d1b46d7Szhanghch05                          const crow::Request& req, uint64_t& skip)
18716428a1aSJason M. Bills {
188d32c4fa9SEd Tanous     boost::urls::query_params_view::iterator it = req.urlParams.find("$skip");
1895a7e877eSJames Feist     if (it != req.urlParams.end())
19016428a1aSJason M. Bills     {
1915a7e877eSJames Feist         std::string skipParam = it->value();
19216428a1aSJason M. Bills         char* ptr = nullptr;
1935a7e877eSJames Feist         skip = std::strtoul(skipParam.c_str(), &ptr, 10);
1945a7e877eSJames Feist         if (skipParam.empty() || *ptr != '\0')
19516428a1aSJason M. Bills         {
19616428a1aSJason M. Bills 
1978d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
1988d1b46d7Szhanghch05                 asyncResp->res, std::string(skipParam), "$skip");
19916428a1aSJason M. Bills             return false;
20016428a1aSJason M. Bills         }
20116428a1aSJason M. Bills     }
20216428a1aSJason M. Bills     return true;
20316428a1aSJason M. Bills }
20416428a1aSJason M. Bills 
205271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
2068d1b46d7Szhanghch05 static bool getTopParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2078d1b46d7Szhanghch05                         const crow::Request& req, uint64_t& top)
20816428a1aSJason M. Bills {
209d32c4fa9SEd Tanous     boost::urls::query_params_view::iterator it = req.urlParams.find("$top");
2105a7e877eSJames Feist     if (it != req.urlParams.end())
21116428a1aSJason M. Bills     {
2125a7e877eSJames Feist         std::string topParam = it->value();
21316428a1aSJason M. Bills         char* ptr = nullptr;
2145a7e877eSJames Feist         top = std::strtoul(topParam.c_str(), &ptr, 10);
2155a7e877eSJames Feist         if (topParam.empty() || *ptr != '\0')
21616428a1aSJason M. Bills         {
2178d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
2188d1b46d7Szhanghch05                 asyncResp->res, std::string(topParam), "$top");
21916428a1aSJason M. Bills             return false;
22016428a1aSJason M. Bills         }
221271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
22216428a1aSJason M. Bills         {
22316428a1aSJason M. Bills 
22416428a1aSJason M. Bills             messages::queryParameterOutOfRange(
2258d1b46d7Szhanghch05                 asyncResp->res, std::to_string(top), "$top",
22616428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
22716428a1aSJason M. Bills             return false;
22816428a1aSJason M. Bills         }
22916428a1aSJason M. Bills     }
23016428a1aSJason M. Bills     return true;
23116428a1aSJason M. Bills }
23216428a1aSJason M. Bills 
2337e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
234e85d6b16SJason M. Bills                                     const bool firstEntry = true)
23516428a1aSJason M. Bills {
23616428a1aSJason M. Bills     int ret = 0;
23716428a1aSJason M. Bills     static uint64_t prevTs = 0;
23816428a1aSJason M. Bills     static int index = 0;
239e85d6b16SJason M. Bills     if (firstEntry)
240e85d6b16SJason M. Bills     {
241e85d6b16SJason M. Bills         prevTs = 0;
242e85d6b16SJason M. Bills     }
243e85d6b16SJason M. Bills 
24416428a1aSJason M. Bills     // Get the entry timestamp
24516428a1aSJason M. Bills     uint64_t curTs = 0;
24616428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
24716428a1aSJason M. Bills     if (ret < 0)
24816428a1aSJason M. Bills     {
24916428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
25016428a1aSJason M. Bills                          << strerror(-ret);
25116428a1aSJason M. Bills         return false;
25216428a1aSJason M. Bills     }
25316428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
25416428a1aSJason M. Bills     if (curTs == prevTs)
25516428a1aSJason M. Bills     {
25616428a1aSJason M. Bills         index++;
25716428a1aSJason M. Bills     }
25816428a1aSJason M. Bills     else
25916428a1aSJason M. Bills     {
26016428a1aSJason M. Bills         // Otherwise, reset it
26116428a1aSJason M. Bills         index = 0;
26216428a1aSJason M. Bills     }
26316428a1aSJason M. Bills     // Save the timestamp
26416428a1aSJason M. Bills     prevTs = curTs;
26516428a1aSJason M. Bills 
26616428a1aSJason M. Bills     entryID = std::to_string(curTs);
26716428a1aSJason M. Bills     if (index > 0)
26816428a1aSJason M. Bills     {
26916428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
27016428a1aSJason M. Bills     }
27116428a1aSJason M. Bills     return true;
27216428a1aSJason M. Bills }
27316428a1aSJason M. Bills 
274e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
275e85d6b16SJason M. Bills                              const bool firstEntry = true)
27695820184SJason M. Bills {
277271584abSEd Tanous     static time_t prevTs = 0;
27895820184SJason M. Bills     static int index = 0;
279e85d6b16SJason M. Bills     if (firstEntry)
280e85d6b16SJason M. Bills     {
281e85d6b16SJason M. Bills         prevTs = 0;
282e85d6b16SJason M. Bills     }
283e85d6b16SJason M. Bills 
28495820184SJason M. Bills     // Get the entry timestamp
285271584abSEd Tanous     std::time_t curTs = 0;
28695820184SJason M. Bills     std::tm timeStruct = {};
28795820184SJason M. Bills     std::istringstream entryStream(logEntry);
28895820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
28995820184SJason M. Bills     {
29095820184SJason M. Bills         curTs = std::mktime(&timeStruct);
29195820184SJason M. Bills     }
29295820184SJason M. Bills     // If the timestamp isn't unique, increment the index
29395820184SJason M. Bills     if (curTs == prevTs)
29495820184SJason M. Bills     {
29595820184SJason M. Bills         index++;
29695820184SJason M. Bills     }
29795820184SJason M. Bills     else
29895820184SJason M. Bills     {
29995820184SJason M. Bills         // Otherwise, reset it
30095820184SJason M. Bills         index = 0;
30195820184SJason M. Bills     }
30295820184SJason M. Bills     // Save the timestamp
30395820184SJason M. Bills     prevTs = curTs;
30495820184SJason M. Bills 
30595820184SJason M. Bills     entryID = std::to_string(curTs);
30695820184SJason M. Bills     if (index > 0)
30795820184SJason M. Bills     {
30895820184SJason M. Bills         entryID += "_" + std::to_string(index);
30995820184SJason M. Bills     }
31095820184SJason M. Bills     return true;
31195820184SJason M. Bills }
31295820184SJason M. Bills 
3137e860f15SJohn Edward Broadbent inline static bool
3148d1b46d7Szhanghch05     getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3158d1b46d7Szhanghch05                        const std::string& entryID, uint64_t& timestamp,
3168d1b46d7Szhanghch05                        uint64_t& index)
31716428a1aSJason M. Bills {
31816428a1aSJason M. Bills     if (entryID.empty())
31916428a1aSJason M. Bills     {
32016428a1aSJason M. Bills         return false;
32116428a1aSJason M. Bills     }
32216428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
32339e77504SEd Tanous     std::string_view tsStr(entryID);
32416428a1aSJason M. Bills 
32581ce609eSEd Tanous     auto underscorePos = tsStr.find('_');
32616428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
32716428a1aSJason M. Bills     {
32816428a1aSJason M. Bills         // Timestamp has an index
32916428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
33039e77504SEd Tanous         std::string_view indexStr(entryID);
33116428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
332c0bd5e4bSEd Tanous         auto [ptr, ec] = std::from_chars(
333c0bd5e4bSEd Tanous             indexStr.data(), indexStr.data() + indexStr.size(), index);
334c0bd5e4bSEd Tanous         if (ec != std::errc())
33516428a1aSJason M. Bills         {
3368d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
33716428a1aSJason M. Bills             return false;
33816428a1aSJason M. Bills         }
33916428a1aSJason M. Bills     }
34016428a1aSJason M. Bills     // Timestamp has no index
341c0bd5e4bSEd Tanous     auto [ptr, ec] =
342c0bd5e4bSEd Tanous         std::from_chars(tsStr.data(), tsStr.data() + tsStr.size(), timestamp);
343c0bd5e4bSEd Tanous     if (ec != std::errc())
34416428a1aSJason M. Bills     {
3458d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
34616428a1aSJason M. Bills         return false;
34716428a1aSJason M. Bills     }
34816428a1aSJason M. Bills     return true;
34916428a1aSJason M. Bills }
35016428a1aSJason M. Bills 
35195820184SJason M. Bills static bool
35295820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
35395820184SJason M. Bills {
35495820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
35595820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
35695820184SJason M. Bills 
35795820184SJason M. Bills     // Loop through the directory looking for redfish log files
35895820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
35995820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
36095820184SJason M. Bills     {
36195820184SJason M. Bills         // If we find a redfish log file, save the path
36295820184SJason M. Bills         std::string filename = dirEnt.path().filename();
36395820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
36495820184SJason M. Bills         {
36595820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
36695820184SJason M. Bills         }
36795820184SJason M. Bills     }
36895820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
36995820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
37095820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
37195820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
37295820184SJason M. Bills 
37395820184SJason M. Bills     return !redfishLogFiles.empty();
37495820184SJason M. Bills }
37595820184SJason M. Bills 
3768d1b46d7Szhanghch05 inline void
3778d1b46d7Szhanghch05     getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3785cb1dd27SAsmitha Karunanithi                            const std::string& dumpType)
3795cb1dd27SAsmitha Karunanithi {
3805cb1dd27SAsmitha Karunanithi     std::string dumpPath;
3815cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
3825cb1dd27SAsmitha Karunanithi     {
3835cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
3845cb1dd27SAsmitha Karunanithi     }
3855cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
3865cb1dd27SAsmitha Karunanithi     {
3875cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
3885cb1dd27SAsmitha Karunanithi     }
3895cb1dd27SAsmitha Karunanithi     else
3905cb1dd27SAsmitha Karunanithi     {
3915cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
3925cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
3935cb1dd27SAsmitha Karunanithi         return;
3945cb1dd27SAsmitha Karunanithi     }
3955cb1dd27SAsmitha Karunanithi 
3965cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
397711ac7a9SEd Tanous         [asyncResp, dumpPath,
398711ac7a9SEd Tanous          dumpType](const boost::system::error_code ec,
399711ac7a9SEd Tanous                    dbus::utility::ManagedObjectType& resp) {
4005cb1dd27SAsmitha Karunanithi             if (ec)
4015cb1dd27SAsmitha Karunanithi             {
4025cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4035cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
4045cb1dd27SAsmitha Karunanithi                 return;
4055cb1dd27SAsmitha Karunanithi             }
4065cb1dd27SAsmitha Karunanithi 
4075cb1dd27SAsmitha Karunanithi             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4085cb1dd27SAsmitha Karunanithi             entriesArray = nlohmann::json::array();
409b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
410b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
411b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
412b47452b2SAsmitha Karunanithi                 "/entry/";
4135cb1dd27SAsmitha Karunanithi 
4145cb1dd27SAsmitha Karunanithi             for (auto& object : resp)
4155cb1dd27SAsmitha Karunanithi             {
416b47452b2SAsmitha Karunanithi                 if (object.first.str.find(dumpEntryPath) == std::string::npos)
4175cb1dd27SAsmitha Karunanithi                 {
4185cb1dd27SAsmitha Karunanithi                     continue;
4195cb1dd27SAsmitha Karunanithi                 }
4201d8782e7SNan Zhou                 uint64_t timestamp = 0;
4215cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
42235440d18SAsmitha Karunanithi                 std::string dumpStatus;
42335440d18SAsmitha Karunanithi                 nlohmann::json thisEntry;
4242dfd18efSEd Tanous 
4252dfd18efSEd Tanous                 std::string entryID = object.first.filename();
4262dfd18efSEd Tanous                 if (entryID.empty())
4275cb1dd27SAsmitha Karunanithi                 {
4285cb1dd27SAsmitha Karunanithi                     continue;
4295cb1dd27SAsmitha Karunanithi                 }
4305cb1dd27SAsmitha Karunanithi 
4315cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4325cb1dd27SAsmitha Karunanithi                 {
43335440d18SAsmitha Karunanithi                     if (interfaceMap.first ==
43435440d18SAsmitha Karunanithi                         "xyz.openbmc_project.Common.Progress")
43535440d18SAsmitha Karunanithi                     {
43635440d18SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
43735440d18SAsmitha Karunanithi                         {
43835440d18SAsmitha Karunanithi                             if (propertyMap.first == "Status")
43935440d18SAsmitha Karunanithi                             {
44035440d18SAsmitha Karunanithi                                 auto status = std::get_if<std::string>(
44135440d18SAsmitha Karunanithi                                     &propertyMap.second);
44235440d18SAsmitha Karunanithi                                 if (status == nullptr)
44335440d18SAsmitha Karunanithi                                 {
44435440d18SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
44535440d18SAsmitha Karunanithi                                     break;
44635440d18SAsmitha Karunanithi                                 }
44735440d18SAsmitha Karunanithi                                 dumpStatus = *status;
44835440d18SAsmitha Karunanithi                             }
44935440d18SAsmitha Karunanithi                         }
45035440d18SAsmitha Karunanithi                     }
45135440d18SAsmitha Karunanithi                     else if (interfaceMap.first ==
45235440d18SAsmitha Karunanithi                              "xyz.openbmc_project.Dump.Entry")
4535cb1dd27SAsmitha Karunanithi                     {
4545cb1dd27SAsmitha Karunanithi 
4555cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4565cb1dd27SAsmitha Karunanithi                         {
4575cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
4585cb1dd27SAsmitha Karunanithi                             {
4595cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
4605cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4615cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
4625cb1dd27SAsmitha Karunanithi                                 {
4635cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4645cb1dd27SAsmitha Karunanithi                                     break;
4655cb1dd27SAsmitha Karunanithi                                 }
4665cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
4675cb1dd27SAsmitha Karunanithi                                 break;
4685cb1dd27SAsmitha Karunanithi                             }
4695cb1dd27SAsmitha Karunanithi                         }
4705cb1dd27SAsmitha Karunanithi                     }
4715cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
4725cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
4735cb1dd27SAsmitha Karunanithi                     {
4745cb1dd27SAsmitha Karunanithi 
4755cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4765cb1dd27SAsmitha Karunanithi                         {
4775cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
4785cb1dd27SAsmitha Karunanithi                             {
4795cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
4805cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4815cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
4825cb1dd27SAsmitha Karunanithi                                 {
4835cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4845cb1dd27SAsmitha Karunanithi                                     break;
4855cb1dd27SAsmitha Karunanithi                                 }
4861d8782e7SNan Zhou                                 timestamp = (*usecsTimeStamp / 1000 / 1000);
4875cb1dd27SAsmitha Karunanithi                                 break;
4885cb1dd27SAsmitha Karunanithi                             }
4895cb1dd27SAsmitha Karunanithi                         }
4905cb1dd27SAsmitha Karunanithi                     }
4915cb1dd27SAsmitha Karunanithi                 }
4925cb1dd27SAsmitha Karunanithi 
4930fda0f12SGeorge Liu                 if (dumpStatus !=
4940fda0f12SGeorge Liu                         "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
49535440d18SAsmitha Karunanithi                     !dumpStatus.empty())
49635440d18SAsmitha Karunanithi                 {
49735440d18SAsmitha Karunanithi                     // Dump status is not Complete, no need to enumerate
49835440d18SAsmitha Karunanithi                     continue;
49935440d18SAsmitha Karunanithi                 }
50035440d18SAsmitha Karunanithi 
501647b3cdcSGeorge Liu                 thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
5025cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.id"] = dumpPath + entryID;
5035cb1dd27SAsmitha Karunanithi                 thisEntry["Id"] = entryID;
5045cb1dd27SAsmitha Karunanithi                 thisEntry["EntryType"] = "Event";
5051d8782e7SNan Zhou                 thisEntry["Created"] =
5061d8782e7SNan Zhou                     crow::utility::getDateTimeUint(timestamp);
5075cb1dd27SAsmitha Karunanithi                 thisEntry["Name"] = dumpType + " Dump Entry";
5085cb1dd27SAsmitha Karunanithi 
509d337bb72SAsmitha Karunanithi                 thisEntry["AdditionalDataSizeBytes"] = size;
5105cb1dd27SAsmitha Karunanithi 
5115cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
5125cb1dd27SAsmitha Karunanithi                 {
513d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "Manager";
514d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
515de8d94a3SAbhishek Patel                         "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" +
516de8d94a3SAbhishek Patel                         entryID + "/attachment";
5175cb1dd27SAsmitha Karunanithi                 }
5185cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
5195cb1dd27SAsmitha Karunanithi                 {
520d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "OEM";
521d337bb72SAsmitha Karunanithi                     thisEntry["OEMDiagnosticDataType"] = "System";
522d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
523de8d94a3SAbhishek Patel                         "/redfish/v1/Systems/system/LogServices/Dump/Entries/" +
524de8d94a3SAbhishek Patel                         entryID + "/attachment";
5255cb1dd27SAsmitha Karunanithi                 }
52635440d18SAsmitha Karunanithi                 entriesArray.push_back(std::move(thisEntry));
5275cb1dd27SAsmitha Karunanithi             }
5285cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Members@odata.count"] =
5295cb1dd27SAsmitha Karunanithi                 entriesArray.size();
5305cb1dd27SAsmitha Karunanithi         },
5315cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5325cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5335cb1dd27SAsmitha Karunanithi }
5345cb1dd27SAsmitha Karunanithi 
5358d1b46d7Szhanghch05 inline void
5368d1b46d7Szhanghch05     getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5378d1b46d7Szhanghch05                      const std::string& entryID, const std::string& dumpType)
5385cb1dd27SAsmitha Karunanithi {
5395cb1dd27SAsmitha Karunanithi     std::string dumpPath;
5405cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
5415cb1dd27SAsmitha Karunanithi     {
5425cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
5435cb1dd27SAsmitha Karunanithi     }
5445cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
5455cb1dd27SAsmitha Karunanithi     {
5465cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
5475cb1dd27SAsmitha Karunanithi     }
5485cb1dd27SAsmitha Karunanithi     else
5495cb1dd27SAsmitha Karunanithi     {
5505cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
5515cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5525cb1dd27SAsmitha Karunanithi         return;
5535cb1dd27SAsmitha Karunanithi     }
5545cb1dd27SAsmitha Karunanithi 
5555cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
556711ac7a9SEd Tanous         [asyncResp, entryID, dumpPath,
557711ac7a9SEd Tanous          dumpType](const boost::system::error_code ec,
558711ac7a9SEd Tanous                    dbus::utility::ManagedObjectType& resp) {
5595cb1dd27SAsmitha Karunanithi             if (ec)
5605cb1dd27SAsmitha Karunanithi             {
5615cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
5625cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
5635cb1dd27SAsmitha Karunanithi                 return;
5645cb1dd27SAsmitha Karunanithi             }
5655cb1dd27SAsmitha Karunanithi 
566b47452b2SAsmitha Karunanithi             bool foundDumpEntry = false;
567b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
568b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
569b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
570b47452b2SAsmitha Karunanithi                 "/entry/";
571b47452b2SAsmitha Karunanithi 
5725cb1dd27SAsmitha Karunanithi             for (auto& objectPath : resp)
5735cb1dd27SAsmitha Karunanithi             {
574b47452b2SAsmitha Karunanithi                 if (objectPath.first.str != dumpEntryPath + entryID)
5755cb1dd27SAsmitha Karunanithi                 {
5765cb1dd27SAsmitha Karunanithi                     continue;
5775cb1dd27SAsmitha Karunanithi                 }
5785cb1dd27SAsmitha Karunanithi 
5795cb1dd27SAsmitha Karunanithi                 foundDumpEntry = true;
5801d8782e7SNan Zhou                 uint64_t timestamp = 0;
5815cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
58235440d18SAsmitha Karunanithi                 std::string dumpStatus;
5835cb1dd27SAsmitha Karunanithi 
5845cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
5855cb1dd27SAsmitha Karunanithi                 {
58635440d18SAsmitha Karunanithi                     if (interfaceMap.first ==
58735440d18SAsmitha Karunanithi                         "xyz.openbmc_project.Common.Progress")
58835440d18SAsmitha Karunanithi                     {
58935440d18SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
59035440d18SAsmitha Karunanithi                         {
59135440d18SAsmitha Karunanithi                             if (propertyMap.first == "Status")
59235440d18SAsmitha Karunanithi                             {
59335440d18SAsmitha Karunanithi                                 auto status = std::get_if<std::string>(
59435440d18SAsmitha Karunanithi                                     &propertyMap.second);
59535440d18SAsmitha Karunanithi                                 if (status == nullptr)
59635440d18SAsmitha Karunanithi                                 {
59735440d18SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
59835440d18SAsmitha Karunanithi                                     break;
59935440d18SAsmitha Karunanithi                                 }
60035440d18SAsmitha Karunanithi                                 dumpStatus = *status;
60135440d18SAsmitha Karunanithi                             }
60235440d18SAsmitha Karunanithi                         }
60335440d18SAsmitha Karunanithi                     }
60435440d18SAsmitha Karunanithi                     else if (interfaceMap.first ==
60535440d18SAsmitha Karunanithi                              "xyz.openbmc_project.Dump.Entry")
6065cb1dd27SAsmitha Karunanithi                     {
6075cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6085cb1dd27SAsmitha Karunanithi                         {
6095cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
6105cb1dd27SAsmitha Karunanithi                             {
6115cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
6125cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6135cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
6145cb1dd27SAsmitha Karunanithi                                 {
6155cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6165cb1dd27SAsmitha Karunanithi                                     break;
6175cb1dd27SAsmitha Karunanithi                                 }
6185cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
6195cb1dd27SAsmitha Karunanithi                                 break;
6205cb1dd27SAsmitha Karunanithi                             }
6215cb1dd27SAsmitha Karunanithi                         }
6225cb1dd27SAsmitha Karunanithi                     }
6235cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
6245cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
6255cb1dd27SAsmitha Karunanithi                     {
6265cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6275cb1dd27SAsmitha Karunanithi                         {
6285cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
6295cb1dd27SAsmitha Karunanithi                             {
6305cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
6315cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6325cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
6335cb1dd27SAsmitha Karunanithi                                 {
6345cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6355cb1dd27SAsmitha Karunanithi                                     break;
6365cb1dd27SAsmitha Karunanithi                                 }
6371d8782e7SNan Zhou                                 timestamp = *usecsTimeStamp / 1000 / 1000;
6385cb1dd27SAsmitha Karunanithi                                 break;
6395cb1dd27SAsmitha Karunanithi                             }
6405cb1dd27SAsmitha Karunanithi                         }
6415cb1dd27SAsmitha Karunanithi                     }
6425cb1dd27SAsmitha Karunanithi                 }
6435cb1dd27SAsmitha Karunanithi 
6440fda0f12SGeorge Liu                 if (dumpStatus !=
6450fda0f12SGeorge Liu                         "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
64635440d18SAsmitha Karunanithi                     !dumpStatus.empty())
64735440d18SAsmitha Karunanithi                 {
64835440d18SAsmitha Karunanithi                     // Dump status is not Complete
64935440d18SAsmitha Karunanithi                     // return not found until status is changed to Completed
65035440d18SAsmitha Karunanithi                     messages::resourceNotFound(asyncResp->res,
65135440d18SAsmitha Karunanithi                                                dumpType + " dump", entryID);
65235440d18SAsmitha Karunanithi                     return;
65335440d18SAsmitha Karunanithi                 }
65435440d18SAsmitha Karunanithi 
6555cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
656647b3cdcSGeorge Liu                     "#LogEntry.v1_8_0.LogEntry";
6575cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
6585cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = entryID;
6595cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["EntryType"] = "Event";
6605cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Created"] =
6611d8782e7SNan Zhou                     crow::utility::getDateTimeUint(timestamp);
6625cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
6635cb1dd27SAsmitha Karunanithi 
664d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
6655cb1dd27SAsmitha Karunanithi 
6665cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
6675cb1dd27SAsmitha Karunanithi                 {
668d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
669d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
670de8d94a3SAbhishek Patel                         "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" +
671de8d94a3SAbhishek Patel                         entryID + "/attachment";
6725cb1dd27SAsmitha Karunanithi                 }
6735cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
6745cb1dd27SAsmitha Karunanithi                 {
675d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
676d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["OEMDiagnosticDataType"] =
6775cb1dd27SAsmitha Karunanithi                         "System";
678d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
679de8d94a3SAbhishek Patel                         "/redfish/v1/Systems/system/LogServices/Dump/Entries/" +
680de8d94a3SAbhishek Patel                         entryID + "/attachment";
6815cb1dd27SAsmitha Karunanithi                 }
6825cb1dd27SAsmitha Karunanithi             }
683b47452b2SAsmitha Karunanithi             if (foundDumpEntry == false)
684b47452b2SAsmitha Karunanithi             {
685b47452b2SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Can't find Dump Entry";
686b47452b2SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
687b47452b2SAsmitha Karunanithi                 return;
688b47452b2SAsmitha Karunanithi             }
6895cb1dd27SAsmitha Karunanithi         },
6905cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
6915cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
6925cb1dd27SAsmitha Karunanithi }
6935cb1dd27SAsmitha Karunanithi 
6948d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6959878256fSStanley Chu                             const std::string& entryID,
696b47452b2SAsmitha Karunanithi                             const std::string& dumpType)
6975cb1dd27SAsmitha Karunanithi {
6983de8d8baSGeorge Liu     auto respHandler = [asyncResp,
6993de8d8baSGeorge Liu                         entryID](const boost::system::error_code ec) {
7005cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
7015cb1dd27SAsmitha Karunanithi         if (ec)
7025cb1dd27SAsmitha Karunanithi         {
7033de8d8baSGeorge Liu             if (ec.value() == EBADR)
7043de8d8baSGeorge Liu             {
7053de8d8baSGeorge Liu                 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
7063de8d8baSGeorge Liu                 return;
7073de8d8baSGeorge Liu             }
7085cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
7095cb1dd27SAsmitha Karunanithi                              << ec;
7105cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
7115cb1dd27SAsmitha Karunanithi             return;
7125cb1dd27SAsmitha Karunanithi         }
7135cb1dd27SAsmitha Karunanithi     };
7145cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
7155cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
716b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
717b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
718b47452b2SAsmitha Karunanithi             entryID,
7195cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
7205cb1dd27SAsmitha Karunanithi }
7215cb1dd27SAsmitha Karunanithi 
7228d1b46d7Szhanghch05 inline void
72398be3e39SEd Tanous     createDumpTaskCallback(task::Payload&& payload,
7248d1b46d7Szhanghch05                            const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7258d1b46d7Szhanghch05                            const uint32_t& dumpId, const std::string& dumpPath,
726a43be80fSAsmitha Karunanithi                            const std::string& dumpType)
727a43be80fSAsmitha Karunanithi {
728a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
7296145ed6fSAsmitha Karunanithi         [dumpId, dumpPath, dumpType](
730a43be80fSAsmitha Karunanithi             boost::system::error_code err, sdbusplus::message::message& m,
731a43be80fSAsmitha Karunanithi             const std::shared_ptr<task::TaskData>& taskData) {
732cb13a392SEd Tanous             if (err)
733cb13a392SEd Tanous             {
7346145ed6fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Error in creating a dump";
7356145ed6fSAsmitha Karunanithi                 taskData->state = "Cancelled";
7366145ed6fSAsmitha Karunanithi                 return task::completed;
737cb13a392SEd Tanous             }
738a43be80fSAsmitha Karunanithi             std::vector<std::pair<
739168e20c1SEd Tanous                 std::string, std::vector<std::pair<
740168e20c1SEd Tanous                                  std::string, dbus::utility::DbusVariantType>>>>
741a43be80fSAsmitha Karunanithi                 interfacesList;
742a43be80fSAsmitha Karunanithi 
743a43be80fSAsmitha Karunanithi             sdbusplus::message::object_path objPath;
744a43be80fSAsmitha Karunanithi 
745a43be80fSAsmitha Karunanithi             m.read(objPath, interfacesList);
746a43be80fSAsmitha Karunanithi 
747b47452b2SAsmitha Karunanithi             if (objPath.str ==
748b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
749b47452b2SAsmitha Karunanithi                     std::string(boost::algorithm::to_lower_copy(dumpType)) +
750b47452b2SAsmitha Karunanithi                     "/entry/" + std::to_string(dumpId))
751a43be80fSAsmitha Karunanithi             {
752a43be80fSAsmitha Karunanithi                 nlohmann::json retMessage = messages::success();
753a43be80fSAsmitha Karunanithi                 taskData->messages.emplace_back(retMessage);
754a43be80fSAsmitha Karunanithi 
755a43be80fSAsmitha Karunanithi                 std::string headerLoc =
756a43be80fSAsmitha Karunanithi                     "Location: " + dumpPath + std::to_string(dumpId);
757a43be80fSAsmitha Karunanithi                 taskData->payload->httpHeaders.emplace_back(
758a43be80fSAsmitha Karunanithi                     std::move(headerLoc));
759a43be80fSAsmitha Karunanithi 
760a43be80fSAsmitha Karunanithi                 taskData->state = "Completed";
761b47452b2SAsmitha Karunanithi                 return task::completed;
7626145ed6fSAsmitha Karunanithi             }
763a43be80fSAsmitha Karunanithi             return task::completed;
764a43be80fSAsmitha Karunanithi         },
765a43be80fSAsmitha Karunanithi         "type='signal',interface='org.freedesktop.DBus."
766a43be80fSAsmitha Karunanithi         "ObjectManager',"
767a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
768a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
769a43be80fSAsmitha Karunanithi 
770a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
771a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
77298be3e39SEd Tanous     task->payload.emplace(std::move(payload));
773a43be80fSAsmitha Karunanithi }
774a43be80fSAsmitha Karunanithi 
7758d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7768d1b46d7Szhanghch05                        const crow::Request& req, const std::string& dumpType)
777a43be80fSAsmitha Karunanithi {
778a43be80fSAsmitha Karunanithi 
779a43be80fSAsmitha Karunanithi     std::string dumpPath;
780a43be80fSAsmitha Karunanithi     if (dumpType == "BMC")
781a43be80fSAsmitha Karunanithi     {
782a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
783a43be80fSAsmitha Karunanithi     }
784a43be80fSAsmitha Karunanithi     else if (dumpType == "System")
785a43be80fSAsmitha Karunanithi     {
786a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
787a43be80fSAsmitha Karunanithi     }
788a43be80fSAsmitha Karunanithi     else
789a43be80fSAsmitha Karunanithi     {
790a43be80fSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
791a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
792a43be80fSAsmitha Karunanithi         return;
793a43be80fSAsmitha Karunanithi     }
794a43be80fSAsmitha Karunanithi 
795a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
796a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
797a43be80fSAsmitha Karunanithi 
798a43be80fSAsmitha Karunanithi     if (!redfish::json_util::readJson(
799a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
800a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
801a43be80fSAsmitha Karunanithi     {
802a43be80fSAsmitha Karunanithi         return;
803a43be80fSAsmitha Karunanithi     }
804a43be80fSAsmitha Karunanithi 
805a43be80fSAsmitha Karunanithi     if (dumpType == "System")
806a43be80fSAsmitha Karunanithi     {
807a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
808a43be80fSAsmitha Karunanithi         {
809a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
810a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType'/"
811a43be80fSAsmitha Karunanithi                                 "'OEMDiagnosticDataType' value not found!";
812a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
813a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
814a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
815a43be80fSAsmitha Karunanithi             return;
816a43be80fSAsmitha Karunanithi         }
8173174e4dfSEd Tanous         if ((*oemDiagnosticDataType != "System") ||
818a43be80fSAsmitha Karunanithi             (*diagnosticDataType != "OEM"))
819a43be80fSAsmitha Karunanithi         {
820a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
821a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
822a43be80fSAsmitha Karunanithi                                     "System Dump creation parameters");
823a43be80fSAsmitha Karunanithi             return;
824a43be80fSAsmitha Karunanithi         }
825a43be80fSAsmitha Karunanithi     }
826a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
827a43be80fSAsmitha Karunanithi     {
828a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
829a43be80fSAsmitha Karunanithi         {
8300fda0f12SGeorge Liu             BMCWEB_LOG_ERROR
8310fda0f12SGeorge Liu                 << "CreateDump action parameter 'DiagnosticDataType' not found!";
832a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
833a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
834a43be80fSAsmitha Karunanithi             return;
835a43be80fSAsmitha Karunanithi         }
8363174e4dfSEd Tanous         if (*diagnosticDataType != "Manager")
837a43be80fSAsmitha Karunanithi         {
838a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
839a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
840a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
841a43be80fSAsmitha Karunanithi                                     "BMC Dump creation parameters");
842a43be80fSAsmitha Karunanithi             return;
843a43be80fSAsmitha Karunanithi         }
844a43be80fSAsmitha Karunanithi     }
845a43be80fSAsmitha Karunanithi 
846a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
84798be3e39SEd Tanous         [asyncResp, payload(task::Payload(req)), dumpPath,
84898be3e39SEd Tanous          dumpType](const boost::system::error_code ec,
84998be3e39SEd Tanous                    const uint32_t& dumpId) mutable {
850a43be80fSAsmitha Karunanithi             if (ec)
851a43be80fSAsmitha Karunanithi             {
852a43be80fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
853a43be80fSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
854a43be80fSAsmitha Karunanithi                 return;
855a43be80fSAsmitha Karunanithi             }
856a43be80fSAsmitha Karunanithi             BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
857a43be80fSAsmitha Karunanithi 
85898be3e39SEd Tanous             createDumpTaskCallback(std::move(payload), asyncResp, dumpId,
85998be3e39SEd Tanous                                    dumpPath, dumpType);
860a43be80fSAsmitha Karunanithi         },
861b47452b2SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager",
862b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
863b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)),
864a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
865a43be80fSAsmitha Karunanithi }
866a43be80fSAsmitha Karunanithi 
8678d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
8688d1b46d7Szhanghch05                       const std::string& dumpType)
86980319af1SAsmitha Karunanithi {
870b47452b2SAsmitha Karunanithi     std::string dumpTypeLowerCopy =
871b47452b2SAsmitha Karunanithi         std::string(boost::algorithm::to_lower_copy(dumpType));
8728d1b46d7Szhanghch05 
87380319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
874b47452b2SAsmitha Karunanithi         [asyncResp, dumpType](const boost::system::error_code ec,
87580319af1SAsmitha Karunanithi                               const std::vector<std::string>& subTreePaths) {
87680319af1SAsmitha Karunanithi             if (ec)
87780319af1SAsmitha Karunanithi             {
87880319af1SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
87980319af1SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
88080319af1SAsmitha Karunanithi                 return;
88180319af1SAsmitha Karunanithi             }
88280319af1SAsmitha Karunanithi 
88380319af1SAsmitha Karunanithi             for (const std::string& path : subTreePaths)
88480319af1SAsmitha Karunanithi             {
8852dfd18efSEd Tanous                 sdbusplus::message::object_path objPath(path);
8862dfd18efSEd Tanous                 std::string logID = objPath.filename();
8872dfd18efSEd Tanous                 if (logID.empty())
88880319af1SAsmitha Karunanithi                 {
8892dfd18efSEd Tanous                     continue;
89080319af1SAsmitha Karunanithi                 }
8912dfd18efSEd Tanous                 deleteDumpEntry(asyncResp, logID, dumpType);
89280319af1SAsmitha Karunanithi             }
89380319af1SAsmitha Karunanithi         },
89480319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
89580319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
89680319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
897b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0,
898b47452b2SAsmitha Karunanithi         std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." +
899b47452b2SAsmitha Karunanithi                                    dumpType});
90080319af1SAsmitha Karunanithi }
90180319af1SAsmitha Karunanithi 
9027e860f15SJohn Edward Broadbent inline static void parseCrashdumpParameters(
903168e20c1SEd Tanous     const std::vector<std::pair<std::string, dbus::utility::DbusVariantType>>&
904168e20c1SEd Tanous         params,
905043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
906043a0536SJohnathan Mantey {
907043a0536SJohnathan Mantey     for (auto property : params)
908043a0536SJohnathan Mantey     {
909043a0536SJohnathan Mantey         if (property.first == "Timestamp")
910043a0536SJohnathan Mantey         {
911043a0536SJohnathan Mantey             const std::string* value =
9128d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
913043a0536SJohnathan Mantey             if (value != nullptr)
914043a0536SJohnathan Mantey             {
915043a0536SJohnathan Mantey                 timestamp = *value;
916043a0536SJohnathan Mantey             }
917043a0536SJohnathan Mantey         }
918043a0536SJohnathan Mantey         else if (property.first == "Filename")
919043a0536SJohnathan Mantey         {
920043a0536SJohnathan Mantey             const std::string* value =
9218d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
922043a0536SJohnathan Mantey             if (value != nullptr)
923043a0536SJohnathan Mantey             {
924043a0536SJohnathan Mantey                 filename = *value;
925043a0536SJohnathan Mantey             }
926043a0536SJohnathan Mantey         }
927043a0536SJohnathan Mantey         else if (property.first == "Log")
928043a0536SJohnathan Mantey         {
929043a0536SJohnathan Mantey             const std::string* value =
9308d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
931043a0536SJohnathan Mantey             if (value != nullptr)
932043a0536SJohnathan Mantey             {
933043a0536SJohnathan Mantey                 logfile = *value;
934043a0536SJohnathan Mantey             }
935043a0536SJohnathan Mantey         }
936043a0536SJohnathan Mantey     }
937043a0536SJohnathan Mantey }
938043a0536SJohnathan Mantey 
939a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
9407e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app)
9411da66f75SEd Tanous {
942c4bf6374SJason M. Bills     /**
943c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
944c4bf6374SJason M. Bills      */
9457e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/")
946ed398213SEd Tanous         .privileges(redfish::privileges::getLogServiceCollection)
9477e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
9487e860f15SJohn Edward Broadbent             [](const crow::Request&,
9497e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
9507e860f15SJohn Edward Broadbent 
951c4bf6374SJason M. Bills             {
9527e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
9537e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
954c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
955c4bf6374SJason M. Bills                     "#LogServiceCollection.LogServiceCollection";
956c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
957029573d4SEd Tanous                     "/redfish/v1/Systems/system/LogServices";
9587e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
9597e860f15SJohn Edward Broadbent                     "System Log Services Collection";
960c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
961c4bf6374SJason M. Bills                     "Collection of LogServices for this Computer System";
9627e860f15SJohn Edward Broadbent                 nlohmann::json& logServiceArray =
9637e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
964c4bf6374SJason M. Bills                 logServiceArray = nlohmann::json::array();
965029573d4SEd Tanous                 logServiceArray.push_back(
9667e860f15SJohn Edward Broadbent                     {{"@odata.id",
9677e860f15SJohn Edward Broadbent                       "/redfish/v1/Systems/system/LogServices/EventLog"}});
9685cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
969c9bb6861Sraviteja-b                 logServiceArray.push_back(
9707e860f15SJohn Edward Broadbent                     {{"@odata.id",
9717e860f15SJohn Edward Broadbent                       "/redfish/v1/Systems/system/LogServices/Dump"}});
972c9bb6861Sraviteja-b #endif
973c9bb6861Sraviteja-b 
974d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
975d53dd41fSJason M. Bills                 logServiceArray.push_back(
976cb92c03bSAndrew Geissler                     {{"@odata.id",
977424c4176SJason M. Bills                       "/redfish/v1/Systems/system/LogServices/Crashdump"}});
978d53dd41fSJason M. Bills #endif
979b7028ebfSSpencer Ku 
980b7028ebfSSpencer Ku #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
981b7028ebfSSpencer Ku                 logServiceArray.push_back(
982b7028ebfSSpencer Ku                     {{"@odata.id",
983b7028ebfSSpencer Ku                       "/redfish/v1/Systems/system/LogServices/HostLogger"}});
984b7028ebfSSpencer Ku #endif
985c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
986c4bf6374SJason M. Bills                     logServiceArray.size();
987a3316fc6SZhikuiRen 
988a3316fc6SZhikuiRen                 crow::connections::systemBus->async_method_call(
989a3316fc6SZhikuiRen                     [asyncResp](const boost::system::error_code ec,
990a3316fc6SZhikuiRen                                 const std::vector<std::string>& subtreePath) {
991a3316fc6SZhikuiRen                         if (ec)
992a3316fc6SZhikuiRen                         {
993a3316fc6SZhikuiRen                             BMCWEB_LOG_ERROR << ec;
994a3316fc6SZhikuiRen                             return;
995a3316fc6SZhikuiRen                         }
996a3316fc6SZhikuiRen 
997a3316fc6SZhikuiRen                         for (auto& pathStr : subtreePath)
998a3316fc6SZhikuiRen                         {
999a3316fc6SZhikuiRen                             if (pathStr.find("PostCode") != std::string::npos)
1000a3316fc6SZhikuiRen                             {
100123a21a1cSEd Tanous                                 nlohmann::json& logServiceArrayLocal =
1002a3316fc6SZhikuiRen                                     asyncResp->res.jsonValue["Members"];
100323a21a1cSEd Tanous                                 logServiceArrayLocal.push_back(
10040fda0f12SGeorge Liu                                     {{"@odata.id",
10050fda0f12SGeorge Liu                                       "/redfish/v1/Systems/system/LogServices/PostCodes"}});
10067e860f15SJohn Edward Broadbent                                 asyncResp->res
10077e860f15SJohn Edward Broadbent                                     .jsonValue["Members@odata.count"] =
100823a21a1cSEd Tanous                                     logServiceArrayLocal.size();
1009a3316fc6SZhikuiRen                                 return;
1010a3316fc6SZhikuiRen                             }
1011a3316fc6SZhikuiRen                         }
1012a3316fc6SZhikuiRen                     },
1013a3316fc6SZhikuiRen                     "xyz.openbmc_project.ObjectMapper",
1014a3316fc6SZhikuiRen                     "/xyz/openbmc_project/object_mapper",
10157e860f15SJohn Edward Broadbent                     "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/",
10167e860f15SJohn Edward Broadbent                     0, std::array<const char*, 1>{postCodeIface});
10177e860f15SJohn Edward Broadbent             });
1018c4bf6374SJason M. Bills }
1019c4bf6374SJason M. Bills 
10207e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app)
1021c4bf6374SJason M. Bills {
10227e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
1023ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
10247e860f15SJohn Edward Broadbent         .methods(
10257e860f15SJohn Edward Broadbent             boost::beast::http::verb::
10267e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
10277e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1028c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.id"] =
1029029573d4SEd Tanous                 "/redfish/v1/Systems/system/LogServices/EventLog";
1030c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
1031c4bf6374SJason M. Bills                 "#LogService.v1_1_0.LogService";
1032c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Event Log Service";
10337e860f15SJohn Edward Broadbent             asyncResp->res.jsonValue["Description"] =
10347e860f15SJohn Edward Broadbent                 "System Event Log Service";
1035c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Id"] = "EventLog";
1036c4bf6374SJason M. Bills             asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
10377c8c4058STejas Patil 
10387c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
10397c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
10407c8c4058STejas Patil 
10417c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
10427c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
10437c8c4058STejas Patil                 redfishDateTimeOffset.second;
10447c8c4058STejas Patil 
1045c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Entries"] = {
1046c4bf6374SJason M. Bills                 {"@odata.id",
1047029573d4SEd Tanous                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
1048e7d6c8b2SGunnar Mills             asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1049e7d6c8b2SGunnar Mills 
10500fda0f12SGeorge Liu                 {"target",
10510fda0f12SGeorge Liu                  "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}};
10527e860f15SJohn Edward Broadbent         });
1053489640c6SJason M. Bills }
1054489640c6SJason M. Bills 
10557e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app)
1056489640c6SJason M. Bills {
10577e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1058489640c6SJason M. Bills                       "LogService.ClearLog/")
1059432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
10607e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
10617e860f15SJohn Edward Broadbent             [](const crow::Request&,
10627e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1063489640c6SJason M. Bills                 // Clear the EventLog by deleting the log files
1064489640c6SJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
1065489640c6SJason M. Bills                 if (getRedfishLogFiles(redfishLogFiles))
1066489640c6SJason M. Bills                 {
1067489640c6SJason M. Bills                     for (const std::filesystem::path& file : redfishLogFiles)
1068489640c6SJason M. Bills                     {
1069489640c6SJason M. Bills                         std::error_code ec;
1070489640c6SJason M. Bills                         std::filesystem::remove(file, ec);
1071489640c6SJason M. Bills                     }
1072489640c6SJason M. Bills                 }
1073489640c6SJason M. Bills 
1074489640c6SJason M. Bills                 // Reload rsyslog so it knows to start new log files
1075489640c6SJason M. Bills                 crow::connections::systemBus->async_method_call(
1076489640c6SJason M. Bills                     [asyncResp](const boost::system::error_code ec) {
1077489640c6SJason M. Bills                         if (ec)
1078489640c6SJason M. Bills                         {
10797e860f15SJohn Edward Broadbent                             BMCWEB_LOG_ERROR << "Failed to reload rsyslog: "
10807e860f15SJohn Edward Broadbent                                              << ec;
1081489640c6SJason M. Bills                             messages::internalError(asyncResp->res);
1082489640c6SJason M. Bills                             return;
1083489640c6SJason M. Bills                         }
1084489640c6SJason M. Bills 
1085489640c6SJason M. Bills                         messages::success(asyncResp->res);
1086489640c6SJason M. Bills                     },
1087489640c6SJason M. Bills                     "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
10887e860f15SJohn Edward Broadbent                     "org.freedesktop.systemd1.Manager", "ReloadUnit",
10897e860f15SJohn Edward Broadbent                     "rsyslog.service", "replace");
10907e860f15SJohn Edward Broadbent             });
1091c4bf6374SJason M. Bills }
1092c4bf6374SJason M. Bills 
109395820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
1094b5a76932SEd Tanous                                  const std::string& logEntry,
109595820184SJason M. Bills                                  nlohmann::json& logEntryJson)
1096c4bf6374SJason M. Bills {
109795820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1098cd225da8SJason M. Bills     // First get the Timestamp
1099f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1100cd225da8SJason M. Bills     if (space == std::string::npos)
110195820184SJason M. Bills     {
110295820184SJason M. Bills         return 1;
110395820184SJason M. Bills     }
1104cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1105cd225da8SJason M. Bills     // Then get the log contents
1106f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1107cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1108cd225da8SJason M. Bills     {
1109cd225da8SJason M. Bills         return 1;
1110cd225da8SJason M. Bills     }
1111cd225da8SJason M. Bills     std::string_view entry(logEntry);
1112cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1113cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1114cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1115cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1116cd225da8SJason M. Bills                  boost::token_compress_on);
1117cd225da8SJason M. Bills     // We need at least a MessageId to be valid
1118cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
1119cd225da8SJason M. Bills     {
1120cd225da8SJason M. Bills         return 1;
1121cd225da8SJason M. Bills     }
1122cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
112395820184SJason M. Bills 
11244851d45dSJason M. Bills     // Get the Message from the MessageRegistry
11254851d45dSJason M. Bills     const message_registries::Message* message =
11264851d45dSJason M. Bills         message_registries::getMessage(messageID);
1127c4bf6374SJason M. Bills 
11284851d45dSJason M. Bills     std::string msg;
11294851d45dSJason M. Bills     std::string severity;
11304851d45dSJason M. Bills     if (message != nullptr)
1131c4bf6374SJason M. Bills     {
11324851d45dSJason M. Bills         msg = message->message;
11334851d45dSJason M. Bills         severity = message->severity;
1134c4bf6374SJason M. Bills     }
1135c4bf6374SJason M. Bills 
113615a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
113726702d01SEd Tanous     std::span<std::string> messageArgs;
113815a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
113915a86ff6SJason M. Bills     {
114015a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
114115a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
114215a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
114315a86ff6SJason M. Bills         if (!messageArgsStart.empty())
114415a86ff6SJason M. Bills         {
114515a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
114615a86ff6SJason M. Bills         }
114715a86ff6SJason M. Bills 
114823a21a1cSEd Tanous         messageArgs = {&messageArgsStart, messageArgsSize};
1149c4bf6374SJason M. Bills 
11504851d45dSJason M. Bills         // Fill the MessageArgs into the Message
115195820184SJason M. Bills         int i = 0;
115295820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11534851d45dSJason M. Bills         {
115495820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11554851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11564851d45dSJason M. Bills             if (argPos != std::string::npos)
11574851d45dSJason M. Bills             {
115895820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11594851d45dSJason M. Bills             }
11604851d45dSJason M. Bills         }
116115a86ff6SJason M. Bills     }
11624851d45dSJason M. Bills 
116395820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
116495820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
116595820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1166f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1167f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
116895820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1169c4bf6374SJason M. Bills     {
117095820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1171c4bf6374SJason M. Bills     }
1172c4bf6374SJason M. Bills 
1173c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
117495820184SJason M. Bills     logEntryJson = {
1175647b3cdcSGeorge Liu         {"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
1176029573d4SEd Tanous         {"@odata.id",
1177897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
117895820184SJason M. Bills              logEntryID},
1179c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
118095820184SJason M. Bills         {"Id", logEntryID},
118195820184SJason M. Bills         {"Message", std::move(msg)},
118295820184SJason M. Bills         {"MessageId", std::move(messageID)},
1183f23b7296SEd Tanous         {"MessageArgs", messageArgs},
1184c4bf6374SJason M. Bills         {"EntryType", "Event"},
118595820184SJason M. Bills         {"Severity", std::move(severity)},
118695820184SJason M. Bills         {"Created", std::move(timestamp)}};
1187c4bf6374SJason M. Bills     return 0;
1188c4bf6374SJason M. Bills }
1189c4bf6374SJason M. Bills 
11907e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app)
1191c4bf6374SJason M. Bills {
11927e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
11937e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
11948b6a35f0SGunnar Mills         .privileges(redfish::privileges::getLogEntryCollection)
11957e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
11967e860f15SJohn Edward Broadbent             [](const crow::Request& req,
11977e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1198271584abSEd Tanous                 uint64_t skip = 0;
1199271584abSEd Tanous                 uint64_t top = maxEntriesPerPage; // Show max entries by default
12008d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
1201c4bf6374SJason M. Bills                 {
1202c4bf6374SJason M. Bills                     return;
1203c4bf6374SJason M. Bills                 }
12048d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
1205c4bf6374SJason M. Bills                 {
1206c4bf6374SJason M. Bills                     return;
1207c4bf6374SJason M. Bills                 }
12087e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
12097e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
1210c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
1211c4bf6374SJason M. Bills                     "#LogEntryCollection.LogEntryCollection";
1212c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
1213029573d4SEd Tanous                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1214c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1215c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
1216c4bf6374SJason M. Bills                     "Collection of System Event Log Entries";
1217cb92c03bSAndrew Geissler 
12187e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
12197e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
1220c4bf6374SJason M. Bills                 logEntryArray = nlohmann::json::array();
12217e860f15SJohn Edward Broadbent                 // Go through the log files and create a unique ID for each
12227e860f15SJohn Edward Broadbent                 // entry
122395820184SJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
122495820184SJason M. Bills                 getRedfishLogFiles(redfishLogFiles);
1225b01bf299SEd Tanous                 uint64_t entryCount = 0;
1226cd225da8SJason M. Bills                 std::string logEntry;
122795820184SJason M. Bills 
12287e860f15SJohn Edward Broadbent                 // Oldest logs are in the last file, so start there and loop
12297e860f15SJohn Edward Broadbent                 // backwards
12307e860f15SJohn Edward Broadbent                 for (auto it = redfishLogFiles.rbegin();
12317e860f15SJohn Edward Broadbent                      it < redfishLogFiles.rend(); it++)
1232c4bf6374SJason M. Bills                 {
1233cd225da8SJason M. Bills                     std::ifstream logStream(*it);
123495820184SJason M. Bills                     if (!logStream.is_open())
1235c4bf6374SJason M. Bills                     {
1236c4bf6374SJason M. Bills                         continue;
1237c4bf6374SJason M. Bills                     }
1238c4bf6374SJason M. Bills 
1239e85d6b16SJason M. Bills                     // Reset the unique ID on the first entry
1240e85d6b16SJason M. Bills                     bool firstEntry = true;
124195820184SJason M. Bills                     while (std::getline(logStream, logEntry))
124295820184SJason M. Bills                     {
1243c4bf6374SJason M. Bills                         entryCount++;
12447e860f15SJohn Edward Broadbent                         // Handle paging using skip (number of entries to skip
12457e860f15SJohn Edward Broadbent                         // from the start) and top (number of entries to
12467e860f15SJohn Edward Broadbent                         // display)
1247c4bf6374SJason M. Bills                         if (entryCount <= skip || entryCount > skip + top)
1248c4bf6374SJason M. Bills                         {
1249c4bf6374SJason M. Bills                             continue;
1250c4bf6374SJason M. Bills                         }
1251c4bf6374SJason M. Bills 
1252c4bf6374SJason M. Bills                         std::string idStr;
1253e85d6b16SJason M. Bills                         if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1254c4bf6374SJason M. Bills                         {
1255c4bf6374SJason M. Bills                             continue;
1256c4bf6374SJason M. Bills                         }
1257c4bf6374SJason M. Bills 
1258e85d6b16SJason M. Bills                         if (firstEntry)
1259e85d6b16SJason M. Bills                         {
1260e85d6b16SJason M. Bills                             firstEntry = false;
1261e85d6b16SJason M. Bills                         }
1262e85d6b16SJason M. Bills 
1263c4bf6374SJason M. Bills                         logEntryArray.push_back({});
1264c4bf6374SJason M. Bills                         nlohmann::json& bmcLogEntry = logEntryArray.back();
12657e860f15SJohn Edward Broadbent                         if (fillEventLogEntryJson(idStr, logEntry,
12667e860f15SJohn Edward Broadbent                                                   bmcLogEntry) != 0)
1267c4bf6374SJason M. Bills                         {
1268c4bf6374SJason M. Bills                             messages::internalError(asyncResp->res);
1269c4bf6374SJason M. Bills                             return;
1270c4bf6374SJason M. Bills                         }
1271c4bf6374SJason M. Bills                     }
127295820184SJason M. Bills                 }
1273c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1274c4bf6374SJason M. Bills                 if (skip + top < entryCount)
1275c4bf6374SJason M. Bills                 {
1276c4bf6374SJason M. Bills                     asyncResp->res.jsonValue["Members@odata.nextLink"] =
127795820184SJason M. Bills                         "/redfish/v1/Systems/system/LogServices/EventLog/"
127895820184SJason M. Bills                         "Entries?$skip=" +
1279c4bf6374SJason M. Bills                         std::to_string(skip + top);
1280c4bf6374SJason M. Bills                 }
12817e860f15SJohn Edward Broadbent             });
1282897967deSJason M. Bills }
1283897967deSJason M. Bills 
12847e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app)
1285897967deSJason M. Bills {
12867e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
12877e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1288ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
12897e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
12907e860f15SJohn Edward Broadbent             [](const crow::Request&,
12917e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
12927e860f15SJohn Edward Broadbent                const std::string& param) {
12937e860f15SJohn Edward Broadbent                 const std::string& targetID = param;
12948d1b46d7Szhanghch05 
12957e860f15SJohn Edward Broadbent                 // Go through the log files and check the unique ID for each
12967e860f15SJohn Edward Broadbent                 // entry to find the target entry
1297897967deSJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
1298897967deSJason M. Bills                 getRedfishLogFiles(redfishLogFiles);
1299897967deSJason M. Bills                 std::string logEntry;
1300897967deSJason M. Bills 
13017e860f15SJohn Edward Broadbent                 // Oldest logs are in the last file, so start there and loop
13027e860f15SJohn Edward Broadbent                 // backwards
13037e860f15SJohn Edward Broadbent                 for (auto it = redfishLogFiles.rbegin();
13047e860f15SJohn Edward Broadbent                      it < redfishLogFiles.rend(); it++)
1305897967deSJason M. Bills                 {
1306897967deSJason M. Bills                     std::ifstream logStream(*it);
1307897967deSJason M. Bills                     if (!logStream.is_open())
1308897967deSJason M. Bills                     {
1309897967deSJason M. Bills                         continue;
1310897967deSJason M. Bills                     }
1311897967deSJason M. Bills 
1312897967deSJason M. Bills                     // Reset the unique ID on the first entry
1313897967deSJason M. Bills                     bool firstEntry = true;
1314897967deSJason M. Bills                     while (std::getline(logStream, logEntry))
1315897967deSJason M. Bills                     {
1316897967deSJason M. Bills                         std::string idStr;
1317897967deSJason M. Bills                         if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1318897967deSJason M. Bills                         {
1319897967deSJason M. Bills                             continue;
1320897967deSJason M. Bills                         }
1321897967deSJason M. Bills 
1322897967deSJason M. Bills                         if (firstEntry)
1323897967deSJason M. Bills                         {
1324897967deSJason M. Bills                             firstEntry = false;
1325897967deSJason M. Bills                         }
1326897967deSJason M. Bills 
1327897967deSJason M. Bills                         if (idStr == targetID)
1328897967deSJason M. Bills                         {
13297e860f15SJohn Edward Broadbent                             if (fillEventLogEntryJson(
13307e860f15SJohn Edward Broadbent                                     idStr, logEntry,
1331897967deSJason M. Bills                                     asyncResp->res.jsonValue) != 0)
1332897967deSJason M. Bills                             {
1333897967deSJason M. Bills                                 messages::internalError(asyncResp->res);
1334897967deSJason M. Bills                                 return;
1335897967deSJason M. Bills                             }
1336897967deSJason M. Bills                             return;
1337897967deSJason M. Bills                         }
1338897967deSJason M. Bills                     }
1339897967deSJason M. Bills                 }
1340897967deSJason M. Bills                 // Requested ID was not found
1341897967deSJason M. Bills                 messages::resourceMissingAtURI(asyncResp->res, targetID);
13427e860f15SJohn Edward Broadbent             });
134308a4e4b5SAnthony Wilson }
134408a4e4b5SAnthony Wilson 
13457e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app)
134608a4e4b5SAnthony Wilson {
13477e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
13487e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1349ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
13507e860f15SJohn Edward Broadbent         .methods(
13517e860f15SJohn Edward Broadbent             boost::beast::http::verb::
13527e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
13537e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
13547e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
13557e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
135608a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["@odata.type"] =
135708a4e4b5SAnthony Wilson                 "#LogEntryCollection.LogEntryCollection";
135808a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["@odata.id"] =
135908a4e4b5SAnthony Wilson                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
136008a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
136108a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["Description"] =
136208a4e4b5SAnthony Wilson                 "Collection of System Event Log Entries";
136308a4e4b5SAnthony Wilson 
1364cb92c03bSAndrew Geissler             // DBus implementation of EventLog/Entries
1365cb92c03bSAndrew Geissler             // Make call to Logging Service to find all log entry objects
1366cb92c03bSAndrew Geissler             crow::connections::systemBus->async_method_call(
1367cb92c03bSAndrew Geissler                 [asyncResp](const boost::system::error_code ec,
1368914e2d5dSEd Tanous                             const dbus::utility::ManagedObjectType& resp) {
1369cb92c03bSAndrew Geissler                     if (ec)
1370cb92c03bSAndrew Geissler                     {
1371cb92c03bSAndrew Geissler                         // TODO Handle for specific error code
1372cb92c03bSAndrew Geissler                         BMCWEB_LOG_ERROR
1373cb92c03bSAndrew Geissler                             << "getLogEntriesIfaceData resp_handler got error "
1374cb92c03bSAndrew Geissler                             << ec;
1375cb92c03bSAndrew Geissler                         messages::internalError(asyncResp->res);
1376cb92c03bSAndrew Geissler                         return;
1377cb92c03bSAndrew Geissler                     }
1378cb92c03bSAndrew Geissler                     nlohmann::json& entriesArray =
1379cb92c03bSAndrew Geissler                         asyncResp->res.jsonValue["Members"];
1380cb92c03bSAndrew Geissler                     entriesArray = nlohmann::json::array();
1381cb92c03bSAndrew Geissler                     for (auto& objectPath : resp)
1382cb92c03bSAndrew Geissler                     {
1383914e2d5dSEd Tanous                         const uint32_t* id = nullptr;
138466664f25SEd Tanous                         std::time_t timestamp{};
1385d139c236SGeorge Liu                         std::time_t updateTimestamp{};
1386914e2d5dSEd Tanous                         const std::string* severity = nullptr;
1387914e2d5dSEd Tanous                         const std::string* message = nullptr;
1388914e2d5dSEd Tanous                         const std::string* filePath = nullptr;
138975710de2SXiaochao Ma                         bool resolved = false;
1390f86bb901SAdriana Kobylak                         for (auto& interfaceMap : objectPath.second)
1391f86bb901SAdriana Kobylak                         {
1392f86bb901SAdriana Kobylak                             if (interfaceMap.first ==
1393f86bb901SAdriana Kobylak                                 "xyz.openbmc_project.Logging.Entry")
1394f86bb901SAdriana Kobylak                             {
1395cb92c03bSAndrew Geissler                                 for (auto& propertyMap : interfaceMap.second)
1396cb92c03bSAndrew Geissler                                 {
1397cb92c03bSAndrew Geissler                                     if (propertyMap.first == "Id")
1398cb92c03bSAndrew Geissler                                     {
1399f86bb901SAdriana Kobylak                                         id = std::get_if<uint32_t>(
1400f86bb901SAdriana Kobylak                                             &propertyMap.second);
1401cb92c03bSAndrew Geissler                                     }
1402cb92c03bSAndrew Geissler                                     else if (propertyMap.first == "Timestamp")
1403cb92c03bSAndrew Geissler                                     {
1404cb92c03bSAndrew Geissler                                         const uint64_t* millisTimeStamp =
1405f86bb901SAdriana Kobylak                                             std::get_if<uint64_t>(
1406f86bb901SAdriana Kobylak                                                 &propertyMap.second);
1407ae34c8e8SAdriana Kobylak                                         if (millisTimeStamp != nullptr)
1408ebd45906SGeorge Liu                                         {
14097e860f15SJohn Edward Broadbent                                             timestamp =
14107e860f15SJohn Edward Broadbent                                                 crow::utility::getTimestamp(
14117e860f15SJohn Edward Broadbent                                                     *millisTimeStamp);
14127e860f15SJohn Edward Broadbent                                         }
14137e860f15SJohn Edward Broadbent                                     }
14147e860f15SJohn Edward Broadbent                                     else if (propertyMap.first ==
14157e860f15SJohn Edward Broadbent                                              "UpdateTimestamp")
14167e860f15SJohn Edward Broadbent                                     {
14177e860f15SJohn Edward Broadbent                                         const uint64_t* millisTimeStamp =
14187e860f15SJohn Edward Broadbent                                             std::get_if<uint64_t>(
14197e860f15SJohn Edward Broadbent                                                 &propertyMap.second);
14207e860f15SJohn Edward Broadbent                                         if (millisTimeStamp != nullptr)
14217e860f15SJohn Edward Broadbent                                         {
14227e860f15SJohn Edward Broadbent                                             updateTimestamp =
14237e860f15SJohn Edward Broadbent                                                 crow::utility::getTimestamp(
14247e860f15SJohn Edward Broadbent                                                     *millisTimeStamp);
14257e860f15SJohn Edward Broadbent                                         }
14267e860f15SJohn Edward Broadbent                                     }
14277e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Severity")
14287e860f15SJohn Edward Broadbent                                     {
14297e860f15SJohn Edward Broadbent                                         severity = std::get_if<std::string>(
14307e860f15SJohn Edward Broadbent                                             &propertyMap.second);
14317e860f15SJohn Edward Broadbent                                     }
14327e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Message")
14337e860f15SJohn Edward Broadbent                                     {
14347e860f15SJohn Edward Broadbent                                         message = std::get_if<std::string>(
14357e860f15SJohn Edward Broadbent                                             &propertyMap.second);
14367e860f15SJohn Edward Broadbent                                     }
14377e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Resolved")
14387e860f15SJohn Edward Broadbent                                     {
1439914e2d5dSEd Tanous                                         const bool* resolveptr =
1440914e2d5dSEd Tanous                                             std::get_if<bool>(
14417e860f15SJohn Edward Broadbent                                                 &propertyMap.second);
14427e860f15SJohn Edward Broadbent                                         if (resolveptr == nullptr)
14437e860f15SJohn Edward Broadbent                                         {
14447e860f15SJohn Edward Broadbent                                             messages::internalError(
14457e860f15SJohn Edward Broadbent                                                 asyncResp->res);
14467e860f15SJohn Edward Broadbent                                             return;
14477e860f15SJohn Edward Broadbent                                         }
14487e860f15SJohn Edward Broadbent                                         resolved = *resolveptr;
14497e860f15SJohn Edward Broadbent                                     }
14507e860f15SJohn Edward Broadbent                                 }
14517e860f15SJohn Edward Broadbent                                 if (id == nullptr || message == nullptr ||
14527e860f15SJohn Edward Broadbent                                     severity == nullptr)
14537e860f15SJohn Edward Broadbent                                 {
14547e860f15SJohn Edward Broadbent                                     messages::internalError(asyncResp->res);
14557e860f15SJohn Edward Broadbent                                     return;
14567e860f15SJohn Edward Broadbent                                 }
14577e860f15SJohn Edward Broadbent                             }
14587e860f15SJohn Edward Broadbent                             else if (interfaceMap.first ==
14597e860f15SJohn Edward Broadbent                                      "xyz.openbmc_project.Common.FilePath")
14607e860f15SJohn Edward Broadbent                             {
14617e860f15SJohn Edward Broadbent                                 for (auto& propertyMap : interfaceMap.second)
14627e860f15SJohn Edward Broadbent                                 {
14637e860f15SJohn Edward Broadbent                                     if (propertyMap.first == "Path")
14647e860f15SJohn Edward Broadbent                                     {
14657e860f15SJohn Edward Broadbent                                         filePath = std::get_if<std::string>(
14667e860f15SJohn Edward Broadbent                                             &propertyMap.second);
14677e860f15SJohn Edward Broadbent                                     }
14687e860f15SJohn Edward Broadbent                                 }
14697e860f15SJohn Edward Broadbent                             }
14707e860f15SJohn Edward Broadbent                         }
14717e860f15SJohn Edward Broadbent                         // Object path without the
14727e860f15SJohn Edward Broadbent                         // xyz.openbmc_project.Logging.Entry interface, ignore
14737e860f15SJohn Edward Broadbent                         // and continue.
14747e860f15SJohn Edward Broadbent                         if (id == nullptr || message == nullptr ||
14757e860f15SJohn Edward Broadbent                             severity == nullptr)
14767e860f15SJohn Edward Broadbent                         {
14777e860f15SJohn Edward Broadbent                             continue;
14787e860f15SJohn Edward Broadbent                         }
14797e860f15SJohn Edward Broadbent                         entriesArray.push_back({});
14807e860f15SJohn Edward Broadbent                         nlohmann::json& thisEntry = entriesArray.back();
14817e860f15SJohn Edward Broadbent                         thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
14827e860f15SJohn Edward Broadbent                         thisEntry["@odata.id"] =
14830fda0f12SGeorge Liu                             "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
14847e860f15SJohn Edward Broadbent                             std::to_string(*id);
14857e860f15SJohn Edward Broadbent                         thisEntry["Name"] = "System Event Log Entry";
14867e860f15SJohn Edward Broadbent                         thisEntry["Id"] = std::to_string(*id);
14877e860f15SJohn Edward Broadbent                         thisEntry["Message"] = *message;
14887e860f15SJohn Edward Broadbent                         thisEntry["Resolved"] = resolved;
14897e860f15SJohn Edward Broadbent                         thisEntry["EntryType"] = "Event";
14907e860f15SJohn Edward Broadbent                         thisEntry["Severity"] =
14917e860f15SJohn Edward Broadbent                             translateSeverityDbusToRedfish(*severity);
14927e860f15SJohn Edward Broadbent                         thisEntry["Created"] =
14931d8782e7SNan Zhou                             crow::utility::getDateTimeStdtime(timestamp);
14947e860f15SJohn Edward Broadbent                         thisEntry["Modified"] =
14951d8782e7SNan Zhou                             crow::utility::getDateTimeStdtime(updateTimestamp);
14967e860f15SJohn Edward Broadbent                         if (filePath != nullptr)
14977e860f15SJohn Edward Broadbent                         {
14987e860f15SJohn Edward Broadbent                             thisEntry["AdditionalDataURI"] =
14990fda0f12SGeorge Liu                                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
15007e860f15SJohn Edward Broadbent                                 std::to_string(*id) + "/attachment";
15017e860f15SJohn Edward Broadbent                         }
15027e860f15SJohn Edward Broadbent                     }
15037e860f15SJohn Edward Broadbent                     std::sort(entriesArray.begin(), entriesArray.end(),
15047e860f15SJohn Edward Broadbent                               [](const nlohmann::json& left,
15057e860f15SJohn Edward Broadbent                                  const nlohmann::json& right) {
15067e860f15SJohn Edward Broadbent                                   return (left["Id"] <= right["Id"]);
15077e860f15SJohn Edward Broadbent                               });
15087e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members@odata.count"] =
15097e860f15SJohn Edward Broadbent                         entriesArray.size();
15107e860f15SJohn Edward Broadbent                 },
15117e860f15SJohn Edward Broadbent                 "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
15127e860f15SJohn Edward Broadbent                 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
15137e860f15SJohn Edward Broadbent         });
15147e860f15SJohn Edward Broadbent }
15157e860f15SJohn Edward Broadbent 
15167e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app)
15177e860f15SJohn Edward Broadbent {
15187e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
15197e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1520ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
15217e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
15227e860f15SJohn Edward Broadbent             [](const crow::Request&,
15237e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
15247e860f15SJohn Edward Broadbent                const std::string& param)
15257e860f15SJohn Edward Broadbent 
15267e860f15SJohn Edward Broadbent             {
15277e860f15SJohn Edward Broadbent                 std::string entryID = param;
15287e860f15SJohn Edward Broadbent                 dbus::utility::escapePathForDbus(entryID);
15297e860f15SJohn Edward Broadbent 
15307e860f15SJohn Edward Broadbent                 // DBus implementation of EventLog/Entries
15317e860f15SJohn Edward Broadbent                 // Make call to Logging Service to find all log entry objects
15327e860f15SJohn Edward Broadbent                 crow::connections::systemBus->async_method_call(
15337e860f15SJohn Edward Broadbent                     [asyncResp, entryID](const boost::system::error_code ec,
1534914e2d5dSEd Tanous                                          const GetManagedPropertyType& resp) {
15357e860f15SJohn Edward Broadbent                         if (ec.value() == EBADR)
15367e860f15SJohn Edward Broadbent                         {
15377e860f15SJohn Edward Broadbent                             messages::resourceNotFound(
15387e860f15SJohn Edward Broadbent                                 asyncResp->res, "EventLogEntry", entryID);
15397e860f15SJohn Edward Broadbent                             return;
15407e860f15SJohn Edward Broadbent                         }
15417e860f15SJohn Edward Broadbent                         if (ec)
15427e860f15SJohn Edward Broadbent                         {
15430fda0f12SGeorge Liu                             BMCWEB_LOG_ERROR
15440fda0f12SGeorge Liu                                 << "EventLogEntry (DBus) resp_handler got error "
15457e860f15SJohn Edward Broadbent                                 << ec;
15467e860f15SJohn Edward Broadbent                             messages::internalError(asyncResp->res);
15477e860f15SJohn Edward Broadbent                             return;
15487e860f15SJohn Edward Broadbent                         }
1549914e2d5dSEd Tanous                         const uint32_t* id = nullptr;
15507e860f15SJohn Edward Broadbent                         std::time_t timestamp{};
15517e860f15SJohn Edward Broadbent                         std::time_t updateTimestamp{};
1552914e2d5dSEd Tanous                         const std::string* severity = nullptr;
1553914e2d5dSEd Tanous                         const std::string* message = nullptr;
1554914e2d5dSEd Tanous                         const std::string* filePath = nullptr;
15557e860f15SJohn Edward Broadbent                         bool resolved = false;
15567e860f15SJohn Edward Broadbent 
15577e860f15SJohn Edward Broadbent                         for (auto& propertyMap : resp)
15587e860f15SJohn Edward Broadbent                         {
15597e860f15SJohn Edward Broadbent                             if (propertyMap.first == "Id")
15607e860f15SJohn Edward Broadbent                             {
15617e860f15SJohn Edward Broadbent                                 id = std::get_if<uint32_t>(&propertyMap.second);
15627e860f15SJohn Edward Broadbent                             }
15637e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Timestamp")
15647e860f15SJohn Edward Broadbent                             {
15657e860f15SJohn Edward Broadbent                                 const uint64_t* millisTimeStamp =
15667e860f15SJohn Edward Broadbent                                     std::get_if<uint64_t>(&propertyMap.second);
15677e860f15SJohn Edward Broadbent                                 if (millisTimeStamp != nullptr)
15687e860f15SJohn Edward Broadbent                                 {
1569d139c236SGeorge Liu                                     timestamp = crow::utility::getTimestamp(
1570cb92c03bSAndrew Geissler                                         *millisTimeStamp);
1571d139c236SGeorge Liu                                 }
1572ebd45906SGeorge Liu                             }
1573d139c236SGeorge Liu                             else if (propertyMap.first == "UpdateTimestamp")
1574d139c236SGeorge Liu                             {
1575d139c236SGeorge Liu                                 const uint64_t* millisTimeStamp =
15767e860f15SJohn Edward Broadbent                                     std::get_if<uint64_t>(&propertyMap.second);
1577ae34c8e8SAdriana Kobylak                                 if (millisTimeStamp != nullptr)
1578ebd45906SGeorge Liu                                 {
1579ebd45906SGeorge Liu                                     updateTimestamp =
1580ebd45906SGeorge Liu                                         crow::utility::getTimestamp(
1581d139c236SGeorge Liu                                             *millisTimeStamp);
1582cb92c03bSAndrew Geissler                                 }
1583ebd45906SGeorge Liu                             }
1584cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1585cb92c03bSAndrew Geissler                             {
1586cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1587cb92c03bSAndrew Geissler                                     &propertyMap.second);
1588cb92c03bSAndrew Geissler                             }
1589cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1590cb92c03bSAndrew Geissler                             {
1591cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1592cb92c03bSAndrew Geissler                                     &propertyMap.second);
1593ae34c8e8SAdriana Kobylak                             }
159475710de2SXiaochao Ma                             else if (propertyMap.first == "Resolved")
159575710de2SXiaochao Ma                             {
1596914e2d5dSEd Tanous                                 const bool* resolveptr =
159775710de2SXiaochao Ma                                     std::get_if<bool>(&propertyMap.second);
159875710de2SXiaochao Ma                                 if (resolveptr == nullptr)
159975710de2SXiaochao Ma                                 {
160075710de2SXiaochao Ma                                     messages::internalError(asyncResp->res);
160175710de2SXiaochao Ma                                     return;
160275710de2SXiaochao Ma                                 }
160375710de2SXiaochao Ma                                 resolved = *resolveptr;
160475710de2SXiaochao Ma                             }
16057e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Path")
1606f86bb901SAdriana Kobylak                             {
1607f86bb901SAdriana Kobylak                                 filePath = std::get_if<std::string>(
1608f86bb901SAdriana Kobylak                                     &propertyMap.second);
1609f86bb901SAdriana Kobylak                             }
1610f86bb901SAdriana Kobylak                         }
1611f86bb901SAdriana Kobylak                         if (id == nullptr || message == nullptr ||
1612f86bb901SAdriana Kobylak                             severity == nullptr)
1613f86bb901SAdriana Kobylak                         {
1614ae34c8e8SAdriana Kobylak                             messages::internalError(asyncResp->res);
1615271584abSEd Tanous                             return;
1616271584abSEd Tanous                         }
1617f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["@odata.type"] =
1618f86bb901SAdriana Kobylak                             "#LogEntry.v1_8_0.LogEntry";
1619f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["@odata.id"] =
16200fda0f12SGeorge Liu                             "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1621f86bb901SAdriana Kobylak                             std::to_string(*id);
16227e860f15SJohn Edward Broadbent                         asyncResp->res.jsonValue["Name"] =
16237e860f15SJohn Edward Broadbent                             "System Event Log Entry";
1624f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1625f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Message"] = *message;
1626f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Resolved"] = resolved;
1627f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["EntryType"] = "Event";
1628f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Severity"] =
1629f86bb901SAdriana Kobylak                             translateSeverityDbusToRedfish(*severity);
1630f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Created"] =
16311d8782e7SNan Zhou                             crow::utility::getDateTimeStdtime(timestamp);
1632f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Modified"] =
16331d8782e7SNan Zhou                             crow::utility::getDateTimeStdtime(updateTimestamp);
1634f86bb901SAdriana Kobylak                         if (filePath != nullptr)
1635f86bb901SAdriana Kobylak                         {
1636f86bb901SAdriana Kobylak                             asyncResp->res.jsonValue["AdditionalDataURI"] =
16370fda0f12SGeorge Liu                                 "/redfish/v1/Systems/system/LogServices/EventLog/attachment/" +
16387e860f15SJohn Edward Broadbent                                 std::to_string(*id);
1639f86bb901SAdriana Kobylak                         }
1640cb92c03bSAndrew Geissler                     },
1641cb92c03bSAndrew Geissler                     "xyz.openbmc_project.Logging",
1642cb92c03bSAndrew Geissler                     "/xyz/openbmc_project/logging/entry/" + entryID,
1643f86bb901SAdriana Kobylak                     "org.freedesktop.DBus.Properties", "GetAll", "");
16447e860f15SJohn Edward Broadbent             });
1645336e96c6SChicago Duan 
16467e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
16477e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1648ed398213SEd Tanous         .privileges(redfish::privileges::patchLogEntry)
16497e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::patch)(
16507e860f15SJohn Edward Broadbent             [](const crow::Request& req,
16517e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16527e860f15SJohn Edward Broadbent                const std::string& entryId) {
165375710de2SXiaochao Ma                 std::optional<bool> resolved;
165475710de2SXiaochao Ma 
16557e860f15SJohn Edward Broadbent                 if (!json_util::readJson(req, asyncResp->res, "Resolved",
16567e860f15SJohn Edward Broadbent                                          resolved))
165775710de2SXiaochao Ma                 {
165875710de2SXiaochao Ma                     return;
165975710de2SXiaochao Ma                 }
166075710de2SXiaochao Ma                 BMCWEB_LOG_DEBUG << "Set Resolved";
166175710de2SXiaochao Ma 
166275710de2SXiaochao Ma                 crow::connections::systemBus->async_method_call(
16634f48d5f6SEd Tanous                     [asyncResp, entryId](const boost::system::error_code ec) {
166475710de2SXiaochao Ma                         if (ec)
166575710de2SXiaochao Ma                         {
166675710de2SXiaochao Ma                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
166775710de2SXiaochao Ma                             messages::internalError(asyncResp->res);
166875710de2SXiaochao Ma                             return;
166975710de2SXiaochao Ma                         }
167075710de2SXiaochao Ma                     },
167175710de2SXiaochao Ma                     "xyz.openbmc_project.Logging",
167275710de2SXiaochao Ma                     "/xyz/openbmc_project/logging/entry/" + entryId,
167375710de2SXiaochao Ma                     "org.freedesktop.DBus.Properties", "Set",
167475710de2SXiaochao Ma                     "xyz.openbmc_project.Logging.Entry", "Resolved",
1675168e20c1SEd Tanous                     dbus::utility::DbusVariantType(*resolved));
16767e860f15SJohn Edward Broadbent             });
167775710de2SXiaochao Ma 
16787e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
16797e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1680ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
1681ed398213SEd Tanous 
16827e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
16837e860f15SJohn Edward Broadbent             [](const crow::Request&,
16847e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16857e860f15SJohn Edward Broadbent                const std::string& param)
16867e860f15SJohn Edward Broadbent 
1687336e96c6SChicago Duan             {
1688336e96c6SChicago Duan                 BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1689336e96c6SChicago Duan 
16907e860f15SJohn Edward Broadbent                 std::string entryID = param;
1691336e96c6SChicago Duan 
1692336e96c6SChicago Duan                 dbus::utility::escapePathForDbus(entryID);
1693336e96c6SChicago Duan 
1694336e96c6SChicago Duan                 // Process response from Logging service.
16957e860f15SJohn Edward Broadbent                 auto respHandler = [asyncResp, entryID](
16967e860f15SJohn Edward Broadbent                                        const boost::system::error_code ec) {
16977e860f15SJohn Edward Broadbent                     BMCWEB_LOG_DEBUG
16987e860f15SJohn Edward Broadbent                         << "EventLogEntry (DBus) doDelete callback: Done";
1699336e96c6SChicago Duan                     if (ec)
1700336e96c6SChicago Duan                     {
17013de8d8baSGeorge Liu                         if (ec.value() == EBADR)
17023de8d8baSGeorge Liu                         {
17037e860f15SJohn Edward Broadbent                             messages::resourceNotFound(asyncResp->res,
17047e860f15SJohn Edward Broadbent                                                        "LogEntry", entryID);
17053de8d8baSGeorge Liu                             return;
17063de8d8baSGeorge Liu                         }
1707336e96c6SChicago Duan                         // TODO Handle for specific error code
17080fda0f12SGeorge Liu                         BMCWEB_LOG_ERROR
17090fda0f12SGeorge Liu                             << "EventLogEntry (DBus) doDelete respHandler got error "
1710336e96c6SChicago Duan                             << ec;
1711336e96c6SChicago Duan                         asyncResp->res.result(
1712336e96c6SChicago Duan                             boost::beast::http::status::internal_server_error);
1713336e96c6SChicago Duan                         return;
1714336e96c6SChicago Duan                     }
1715336e96c6SChicago Duan 
1716336e96c6SChicago Duan                     asyncResp->res.result(boost::beast::http::status::ok);
1717336e96c6SChicago Duan                 };
1718336e96c6SChicago Duan 
1719336e96c6SChicago Duan                 // Make call to Logging service to request Delete Log
1720336e96c6SChicago Duan                 crow::connections::systemBus->async_method_call(
1721336e96c6SChicago Duan                     respHandler, "xyz.openbmc_project.Logging",
1722336e96c6SChicago Duan                     "/xyz/openbmc_project/logging/entry/" + entryID,
1723336e96c6SChicago Duan                     "xyz.openbmc_project.Object.Delete", "Delete");
17247e860f15SJohn Edward Broadbent             });
1725400fd1fbSAdriana Kobylak }
1726400fd1fbSAdriana Kobylak 
17277e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app)
1728400fd1fbSAdriana Kobylak {
17290fda0f12SGeorge Liu     BMCWEB_ROUTE(
17300fda0f12SGeorge Liu         app,
17310fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/attachment")
1732ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
17337e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
17347e860f15SJohn Edward Broadbent             [](const crow::Request& req,
17357e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
17367e860f15SJohn Edward Broadbent                const std::string& param)
1737400fd1fbSAdriana Kobylak 
17387e860f15SJohn Edward Broadbent             {
1739647b3cdcSGeorge Liu                 if (!http_helpers::isOctetAccepted(
1740647b3cdcSGeorge Liu                         req.getHeaderValue("Accept")))
1741400fd1fbSAdriana Kobylak                 {
17427e860f15SJohn Edward Broadbent                     asyncResp->res.result(
17437e860f15SJohn Edward Broadbent                         boost::beast::http::status::bad_request);
1744400fd1fbSAdriana Kobylak                     return;
1745400fd1fbSAdriana Kobylak                 }
1746400fd1fbSAdriana Kobylak 
17477e860f15SJohn Edward Broadbent                 std::string entryID = param;
1748400fd1fbSAdriana Kobylak                 dbus::utility::escapePathForDbus(entryID);
1749400fd1fbSAdriana Kobylak 
1750400fd1fbSAdriana Kobylak                 crow::connections::systemBus->async_method_call(
17517e860f15SJohn Edward Broadbent                     [asyncResp,
17527e860f15SJohn Edward Broadbent                      entryID](const boost::system::error_code ec,
1753400fd1fbSAdriana Kobylak                               const sdbusplus::message::unix_fd& unixfd) {
1754400fd1fbSAdriana Kobylak                         if (ec.value() == EBADR)
1755400fd1fbSAdriana Kobylak                         {
17567e860f15SJohn Edward Broadbent                             messages::resourceNotFound(
17577e860f15SJohn Edward Broadbent                                 asyncResp->res, "EventLogAttachment", entryID);
1758400fd1fbSAdriana Kobylak                             return;
1759400fd1fbSAdriana Kobylak                         }
1760400fd1fbSAdriana Kobylak                         if (ec)
1761400fd1fbSAdriana Kobylak                         {
1762400fd1fbSAdriana Kobylak                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1763400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1764400fd1fbSAdriana Kobylak                             return;
1765400fd1fbSAdriana Kobylak                         }
1766400fd1fbSAdriana Kobylak 
1767400fd1fbSAdriana Kobylak                         int fd = -1;
1768400fd1fbSAdriana Kobylak                         fd = dup(unixfd);
1769400fd1fbSAdriana Kobylak                         if (fd == -1)
1770400fd1fbSAdriana Kobylak                         {
1771400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1772400fd1fbSAdriana Kobylak                             return;
1773400fd1fbSAdriana Kobylak                         }
1774400fd1fbSAdriana Kobylak 
1775400fd1fbSAdriana Kobylak                         long long int size = lseek(fd, 0, SEEK_END);
1776400fd1fbSAdriana Kobylak                         if (size == -1)
1777400fd1fbSAdriana Kobylak                         {
1778400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1779400fd1fbSAdriana Kobylak                             return;
1780400fd1fbSAdriana Kobylak                         }
1781400fd1fbSAdriana Kobylak 
1782400fd1fbSAdriana Kobylak                         // Arbitrary max size of 64kb
1783400fd1fbSAdriana Kobylak                         constexpr int maxFileSize = 65536;
1784400fd1fbSAdriana Kobylak                         if (size > maxFileSize)
1785400fd1fbSAdriana Kobylak                         {
1786400fd1fbSAdriana Kobylak                             BMCWEB_LOG_ERROR
1787400fd1fbSAdriana Kobylak                                 << "File size exceeds maximum allowed size of "
1788400fd1fbSAdriana Kobylak                                 << maxFileSize;
1789400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1790400fd1fbSAdriana Kobylak                             return;
1791400fd1fbSAdriana Kobylak                         }
1792400fd1fbSAdriana Kobylak                         std::vector<char> data(static_cast<size_t>(size));
1793400fd1fbSAdriana Kobylak                         long long int rc = lseek(fd, 0, SEEK_SET);
1794400fd1fbSAdriana Kobylak                         if (rc == -1)
1795400fd1fbSAdriana Kobylak                         {
1796400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1797400fd1fbSAdriana Kobylak                             return;
1798400fd1fbSAdriana Kobylak                         }
1799400fd1fbSAdriana Kobylak                         rc = read(fd, data.data(), data.size());
1800400fd1fbSAdriana Kobylak                         if ((rc == -1) || (rc != size))
1801400fd1fbSAdriana Kobylak                         {
1802400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1803400fd1fbSAdriana Kobylak                             return;
1804400fd1fbSAdriana Kobylak                         }
1805400fd1fbSAdriana Kobylak                         close(fd);
1806400fd1fbSAdriana Kobylak 
1807400fd1fbSAdriana Kobylak                         std::string_view strData(data.data(), data.size());
18087e860f15SJohn Edward Broadbent                         std::string output =
18097e860f15SJohn Edward Broadbent                             crow::utility::base64encode(strData);
1810400fd1fbSAdriana Kobylak 
1811400fd1fbSAdriana Kobylak                         asyncResp->res.addHeader("Content-Type",
1812400fd1fbSAdriana Kobylak                                                  "application/octet-stream");
18137e860f15SJohn Edward Broadbent                         asyncResp->res.addHeader("Content-Transfer-Encoding",
18147e860f15SJohn Edward Broadbent                                                  "Base64");
1815400fd1fbSAdriana Kobylak                         asyncResp->res.body() = std::move(output);
1816400fd1fbSAdriana Kobylak                     },
1817400fd1fbSAdriana Kobylak                     "xyz.openbmc_project.Logging",
1818400fd1fbSAdriana Kobylak                     "/xyz/openbmc_project/logging/entry/" + entryID,
1819400fd1fbSAdriana Kobylak                     "xyz.openbmc_project.Logging.Entry", "GetEntry");
18207e860f15SJohn Edward Broadbent             });
18211da66f75SEd Tanous }
18221da66f75SEd Tanous 
1823b7028ebfSSpencer Ku constexpr const char* hostLoggerFolderPath = "/var/log/console";
1824b7028ebfSSpencer Ku 
1825b7028ebfSSpencer Ku inline bool
1826b7028ebfSSpencer Ku     getHostLoggerFiles(const std::string& hostLoggerFilePath,
1827b7028ebfSSpencer Ku                        std::vector<std::filesystem::path>& hostLoggerFiles)
1828b7028ebfSSpencer Ku {
1829b7028ebfSSpencer Ku     std::error_code ec;
1830b7028ebfSSpencer Ku     std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec);
1831b7028ebfSSpencer Ku     if (ec)
1832b7028ebfSSpencer Ku     {
1833b7028ebfSSpencer Ku         BMCWEB_LOG_ERROR << ec.message();
1834b7028ebfSSpencer Ku         return false;
1835b7028ebfSSpencer Ku     }
1836b7028ebfSSpencer Ku     for (const std::filesystem::directory_entry& it : logPath)
1837b7028ebfSSpencer Ku     {
1838b7028ebfSSpencer Ku         std::string filename = it.path().filename();
1839b7028ebfSSpencer Ku         // Prefix of each log files is "log". Find the file and save the
1840b7028ebfSSpencer Ku         // path
1841b7028ebfSSpencer Ku         if (boost::starts_with(filename, "log"))
1842b7028ebfSSpencer Ku         {
1843b7028ebfSSpencer Ku             hostLoggerFiles.emplace_back(it.path());
1844b7028ebfSSpencer Ku         }
1845b7028ebfSSpencer Ku     }
1846b7028ebfSSpencer Ku     // As the log files rotate, they are appended with a ".#" that is higher for
1847b7028ebfSSpencer Ku     // the older logs. Since we start from oldest logs, sort the name in
1848b7028ebfSSpencer Ku     // descending order.
1849b7028ebfSSpencer Ku     std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(),
1850b7028ebfSSpencer Ku               AlphanumLess<std::string>());
1851b7028ebfSSpencer Ku 
1852b7028ebfSSpencer Ku     return true;
1853b7028ebfSSpencer Ku }
1854b7028ebfSSpencer Ku 
1855b7028ebfSSpencer Ku inline bool
1856b7028ebfSSpencer Ku     getHostLoggerEntries(std::vector<std::filesystem::path>& hostLoggerFiles,
1857b7028ebfSSpencer Ku                          uint64_t& skip, uint64_t& top,
1858b7028ebfSSpencer Ku                          std::vector<std::string>& logEntries, size_t& logCount)
1859b7028ebfSSpencer Ku {
1860b7028ebfSSpencer Ku     GzFileReader logFile;
1861b7028ebfSSpencer Ku 
1862b7028ebfSSpencer Ku     // Go though all log files and expose host logs.
1863b7028ebfSSpencer Ku     for (const std::filesystem::path& it : hostLoggerFiles)
1864b7028ebfSSpencer Ku     {
1865b7028ebfSSpencer Ku         if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount))
1866b7028ebfSSpencer Ku         {
1867b7028ebfSSpencer Ku             BMCWEB_LOG_ERROR << "fail to expose host logs";
1868b7028ebfSSpencer Ku             return false;
1869b7028ebfSSpencer Ku         }
1870b7028ebfSSpencer Ku     }
1871b7028ebfSSpencer Ku     // Get lastMessage from constructor by getter
1872b7028ebfSSpencer Ku     std::string lastMessage = logFile.getLastMessage();
1873b7028ebfSSpencer Ku     if (!lastMessage.empty())
1874b7028ebfSSpencer Ku     {
1875b7028ebfSSpencer Ku         logCount++;
1876b7028ebfSSpencer Ku         if (logCount > skip && logCount <= (skip + top))
1877b7028ebfSSpencer Ku         {
1878b7028ebfSSpencer Ku             logEntries.push_back(lastMessage);
1879b7028ebfSSpencer Ku         }
1880b7028ebfSSpencer Ku     }
1881b7028ebfSSpencer Ku     return true;
1882b7028ebfSSpencer Ku }
1883b7028ebfSSpencer Ku 
1884b7028ebfSSpencer Ku inline void fillHostLoggerEntryJson(const std::string& logEntryID,
1885b7028ebfSSpencer Ku                                     const std::string& msg,
1886b7028ebfSSpencer Ku                                     nlohmann::json& logEntryJson)
1887b7028ebfSSpencer Ku {
1888b7028ebfSSpencer Ku     // Fill in the log entry with the gathered data.
1889b7028ebfSSpencer Ku     logEntryJson = {
1890b7028ebfSSpencer Ku         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1891b7028ebfSSpencer Ku         {"@odata.id",
1892b7028ebfSSpencer Ku          "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/" +
1893b7028ebfSSpencer Ku              logEntryID},
1894b7028ebfSSpencer Ku         {"Name", "Host Logger Entry"},
1895b7028ebfSSpencer Ku         {"Id", logEntryID},
1896b7028ebfSSpencer Ku         {"Message", msg},
1897b7028ebfSSpencer Ku         {"EntryType", "Oem"},
1898b7028ebfSSpencer Ku         {"Severity", "OK"},
1899b7028ebfSSpencer Ku         {"OemRecordFormat", "Host Logger Entry"}};
1900b7028ebfSSpencer Ku }
1901b7028ebfSSpencer Ku 
1902b7028ebfSSpencer Ku inline void requestRoutesSystemHostLogger(App& app)
1903b7028ebfSSpencer Ku {
1904b7028ebfSSpencer Ku     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/HostLogger/")
1905b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogService)
19060fda0f12SGeorge Liu         .methods(
19070fda0f12SGeorge Liu             boost::beast::http::verb::
19080fda0f12SGeorge Liu                 get)([](const crow::Request&,
1909b7028ebfSSpencer Ku                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1910b7028ebfSSpencer Ku             asyncResp->res.jsonValue["@odata.id"] =
1911b7028ebfSSpencer Ku                 "/redfish/v1/Systems/system/LogServices/HostLogger";
1912b7028ebfSSpencer Ku             asyncResp->res.jsonValue["@odata.type"] =
1913b7028ebfSSpencer Ku                 "#LogService.v1_1_0.LogService";
1914b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Name"] = "Host Logger Service";
1915b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Description"] = "Host Logger Service";
1916b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Id"] = "HostLogger";
1917b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Entries"] = {
19180fda0f12SGeorge Liu                 {"@odata.id",
19190fda0f12SGeorge Liu                  "/redfish/v1/Systems/system/LogServices/HostLogger/Entries"}};
1920b7028ebfSSpencer Ku         });
1921b7028ebfSSpencer Ku }
1922b7028ebfSSpencer Ku 
1923b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerCollection(App& app)
1924b7028ebfSSpencer Ku {
1925b7028ebfSSpencer Ku     BMCWEB_ROUTE(app,
1926b7028ebfSSpencer Ku                  "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/")
1927b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogEntry)
19280fda0f12SGeorge Liu         .methods(
19290fda0f12SGeorge Liu             boost::beast::http::verb::
19300fda0f12SGeorge Liu                 get)([](const crow::Request& req,
1931b7028ebfSSpencer Ku                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1932b7028ebfSSpencer Ku             uint64_t skip = 0;
1933b7028ebfSSpencer Ku             uint64_t top = maxEntriesPerPage; // Show max 1000 entries by
1934b7028ebfSSpencer Ku                                               // default, allow range 1 to
1935b7028ebfSSpencer Ku                                               // 1000 entries per page.
1936b7028ebfSSpencer Ku             if (!getSkipParam(asyncResp, req, skip))
1937b7028ebfSSpencer Ku             {
1938b7028ebfSSpencer Ku                 return;
1939b7028ebfSSpencer Ku             }
1940b7028ebfSSpencer Ku             if (!getTopParam(asyncResp, req, top))
1941b7028ebfSSpencer Ku             {
1942b7028ebfSSpencer Ku                 return;
1943b7028ebfSSpencer Ku             }
1944b7028ebfSSpencer Ku             asyncResp->res.jsonValue["@odata.id"] =
1945b7028ebfSSpencer Ku                 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
1946b7028ebfSSpencer Ku             asyncResp->res.jsonValue["@odata.type"] =
1947b7028ebfSSpencer Ku                 "#LogEntryCollection.LogEntryCollection";
1948b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Name"] = "HostLogger Entries";
1949b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Description"] =
1950b7028ebfSSpencer Ku                 "Collection of HostLogger Entries";
19510fda0f12SGeorge Liu             nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1952b7028ebfSSpencer Ku             logEntryArray = nlohmann::json::array();
1953b7028ebfSSpencer Ku             asyncResp->res.jsonValue["Members@odata.count"] = 0;
1954b7028ebfSSpencer Ku 
1955b7028ebfSSpencer Ku             std::vector<std::filesystem::path> hostLoggerFiles;
1956b7028ebfSSpencer Ku             if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
1957b7028ebfSSpencer Ku             {
1958b7028ebfSSpencer Ku                 BMCWEB_LOG_ERROR << "fail to get host log file path";
1959b7028ebfSSpencer Ku                 return;
1960b7028ebfSSpencer Ku             }
1961b7028ebfSSpencer Ku 
1962b7028ebfSSpencer Ku             size_t logCount = 0;
1963b7028ebfSSpencer Ku             // This vector only store the entries we want to expose that
1964b7028ebfSSpencer Ku             // control by skip and top.
1965b7028ebfSSpencer Ku             std::vector<std::string> logEntries;
19660fda0f12SGeorge Liu             if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries,
19670fda0f12SGeorge Liu                                       logCount))
1968b7028ebfSSpencer Ku             {
1969b7028ebfSSpencer Ku                 messages::internalError(asyncResp->res);
1970b7028ebfSSpencer Ku                 return;
1971b7028ebfSSpencer Ku             }
1972b7028ebfSSpencer Ku             // If vector is empty, that means skip value larger than total
1973b7028ebfSSpencer Ku             // log count
1974b7028ebfSSpencer Ku             if (logEntries.size() == 0)
1975b7028ebfSSpencer Ku             {
1976b7028ebfSSpencer Ku                 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
1977b7028ebfSSpencer Ku                 return;
1978b7028ebfSSpencer Ku             }
1979b7028ebfSSpencer Ku             if (logEntries.size() > 0)
1980b7028ebfSSpencer Ku             {
1981b7028ebfSSpencer Ku                 for (size_t i = 0; i < logEntries.size(); i++)
1982b7028ebfSSpencer Ku                 {
1983b7028ebfSSpencer Ku                     logEntryArray.push_back({});
1984b7028ebfSSpencer Ku                     nlohmann::json& hostLogEntry = logEntryArray.back();
1985b7028ebfSSpencer Ku                     fillHostLoggerEntryJson(std::to_string(skip + i),
1986b7028ebfSSpencer Ku                                             logEntries[i], hostLogEntry);
1987b7028ebfSSpencer Ku                 }
1988b7028ebfSSpencer Ku 
1989b7028ebfSSpencer Ku                 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
1990b7028ebfSSpencer Ku                 if (skip + top < logCount)
1991b7028ebfSSpencer Ku                 {
1992b7028ebfSSpencer Ku                     asyncResp->res.jsonValue["Members@odata.nextLink"] =
19930fda0f12SGeorge Liu                         "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" +
1994b7028ebfSSpencer Ku                         std::to_string(skip + top);
1995b7028ebfSSpencer Ku                 }
1996b7028ebfSSpencer Ku             }
1997b7028ebfSSpencer Ku         });
1998b7028ebfSSpencer Ku }
1999b7028ebfSSpencer Ku 
2000b7028ebfSSpencer Ku inline void requestRoutesSystemHostLoggerLogEntry(App& app)
2001b7028ebfSSpencer Ku {
2002b7028ebfSSpencer Ku     BMCWEB_ROUTE(
2003b7028ebfSSpencer Ku         app, "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/<str>/")
2004b7028ebfSSpencer Ku         .privileges(redfish::privileges::getLogEntry)
2005b7028ebfSSpencer Ku         .methods(boost::beast::http::verb::get)(
2006b7028ebfSSpencer Ku             [](const crow::Request&,
2007b7028ebfSSpencer Ku                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2008b7028ebfSSpencer Ku                const std::string& param) {
2009b7028ebfSSpencer Ku                 const std::string& targetID = param;
2010b7028ebfSSpencer Ku 
2011b7028ebfSSpencer Ku                 uint64_t idInt = 0;
2012*ca45aa3cSEd Tanous 
2013*ca45aa3cSEd Tanous                 // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
2014*ca45aa3cSEd Tanous                 const char* end = targetID.data() + targetID.size();
2015*ca45aa3cSEd Tanous 
2016*ca45aa3cSEd Tanous                 auto [ptr, ec] = std::from_chars(targetID.data(), end, idInt);
2017b7028ebfSSpencer Ku                 if (ec == std::errc::invalid_argument)
2018b7028ebfSSpencer Ku                 {
2019b7028ebfSSpencer Ku                     messages::resourceMissingAtURI(asyncResp->res, targetID);
2020b7028ebfSSpencer Ku                     return;
2021b7028ebfSSpencer Ku                 }
2022b7028ebfSSpencer Ku                 if (ec == std::errc::result_out_of_range)
2023b7028ebfSSpencer Ku                 {
2024b7028ebfSSpencer Ku                     messages::resourceMissingAtURI(asyncResp->res, targetID);
2025b7028ebfSSpencer Ku                     return;
2026b7028ebfSSpencer Ku                 }
2027b7028ebfSSpencer Ku 
2028b7028ebfSSpencer Ku                 std::vector<std::filesystem::path> hostLoggerFiles;
2029b7028ebfSSpencer Ku                 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2030b7028ebfSSpencer Ku                 {
2031b7028ebfSSpencer Ku                     BMCWEB_LOG_ERROR << "fail to get host log file path";
2032b7028ebfSSpencer Ku                     return;
2033b7028ebfSSpencer Ku                 }
2034b7028ebfSSpencer Ku 
2035b7028ebfSSpencer Ku                 size_t logCount = 0;
2036b7028ebfSSpencer Ku                 uint64_t top = 1;
2037b7028ebfSSpencer Ku                 std::vector<std::string> logEntries;
2038b7028ebfSSpencer Ku                 // We can get specific entry by skip and top. For example, if we
2039b7028ebfSSpencer Ku                 // want to get nth entry, we can set skip = n-1 and top = 1 to
2040b7028ebfSSpencer Ku                 // get that entry
2041b7028ebfSSpencer Ku                 if (!getHostLoggerEntries(hostLoggerFiles, idInt, top,
2042b7028ebfSSpencer Ku                                           logEntries, logCount))
2043b7028ebfSSpencer Ku                 {
2044b7028ebfSSpencer Ku                     messages::internalError(asyncResp->res);
2045b7028ebfSSpencer Ku                     return;
2046b7028ebfSSpencer Ku                 }
2047b7028ebfSSpencer Ku 
2048b7028ebfSSpencer Ku                 if (!logEntries.empty())
2049b7028ebfSSpencer Ku                 {
2050b7028ebfSSpencer Ku                     fillHostLoggerEntryJson(targetID, logEntries[0],
2051b7028ebfSSpencer Ku                                             asyncResp->res.jsonValue);
2052b7028ebfSSpencer Ku                     return;
2053b7028ebfSSpencer Ku                 }
2054b7028ebfSSpencer Ku 
2055b7028ebfSSpencer Ku                 // Requested ID was not found
2056b7028ebfSSpencer Ku                 messages::resourceMissingAtURI(asyncResp->res, targetID);
2057b7028ebfSSpencer Ku             });
2058b7028ebfSSpencer Ku }
2059b7028ebfSSpencer Ku 
20607e860f15SJohn Edward Broadbent inline void requestRoutesBMCLogServiceCollection(App& app)
20611da66f75SEd Tanous {
20627e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/")
2063ad89dcf0SGunnar Mills         .privileges(redfish::privileges::getLogServiceCollection)
20647e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
20657e860f15SJohn Edward Broadbent             [](const crow::Request&,
20667e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
20677e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
20687e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
2069e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
20701da66f75SEd Tanous                     "#LogServiceCollection.LogServiceCollection";
2071e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
2072e1f26343SJason M. Bills                     "/redfish/v1/Managers/bmc/LogServices";
20737e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
20747e860f15SJohn Edward Broadbent                     "Open BMC Log Services Collection";
2075e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
20761da66f75SEd Tanous                     "Collection of LogServices for this Manager";
20777e860f15SJohn Edward Broadbent                 nlohmann::json& logServiceArray =
20787e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
2079c4bf6374SJason M. Bills                 logServiceArray = nlohmann::json::array();
20805cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
20815cb1dd27SAsmitha Karunanithi                 logServiceArray.push_back(
20827e860f15SJohn Edward Broadbent                     {{"@odata.id",
20837e860f15SJohn Edward Broadbent                       "/redfish/v1/Managers/bmc/LogServices/Dump"}});
20845cb1dd27SAsmitha Karunanithi #endif
2085c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
2086c4bf6374SJason M. Bills                 logServiceArray.push_back(
20877e860f15SJohn Edward Broadbent                     {{"@odata.id",
20887e860f15SJohn Edward Broadbent                       "/redfish/v1/Managers/bmc/LogServices/Journal"}});
2089c4bf6374SJason M. Bills #endif
2090e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
2091c4bf6374SJason M. Bills                     logServiceArray.size();
20927e860f15SJohn Edward Broadbent             });
2093e1f26343SJason M. Bills }
2094e1f26343SJason M. Bills 
20957e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app)
2096e1f26343SJason M. Bills {
20977e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
2098ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
20997e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
21007e860f15SJohn Edward Broadbent             [](const crow::Request&,
21017e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
21028d1b46d7Szhanghch05 
21037e860f15SJohn Edward Broadbent             {
2104e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
2105e1f26343SJason M. Bills                     "#LogService.v1_1_0.LogService";
21060f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
21070f74e643SEd Tanous                     "/redfish/v1/Managers/bmc/LogServices/Journal";
21087e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
21097e860f15SJohn Edward Broadbent                     "Open BMC Journal Log Service";
21107e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Description"] =
21117e860f15SJohn Edward Broadbent                     "BMC Journal Log Service";
2112c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Id"] = "BMC Journal";
2113e1f26343SJason M. Bills                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
21147c8c4058STejas Patil 
21157c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
21167c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
21177c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
21187c8c4058STejas Patil                     redfishDateTimeOffset.first;
21197c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
21207c8c4058STejas Patil                     redfishDateTimeOffset.second;
21217c8c4058STejas Patil 
2122cd50aa42SJason M. Bills                 asyncResp->res.jsonValue["Entries"] = {
2123cd50aa42SJason M. Bills                     {"@odata.id",
2124086be238SEd Tanous                      "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
21257e860f15SJohn Edward Broadbent             });
2126e1f26343SJason M. Bills }
2127e1f26343SJason M. Bills 
2128c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
2129e1f26343SJason M. Bills                                       sd_journal* journal,
2130c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
2131e1f26343SJason M. Bills {
2132e1f26343SJason M. Bills     // Get the Log Entry contents
2133e1f26343SJason M. Bills     int ret = 0;
2134e1f26343SJason M. Bills 
2135a8fe54f0SJason M. Bills     std::string message;
2136a8fe54f0SJason M. Bills     std::string_view syslogID;
2137a8fe54f0SJason M. Bills     ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
2138a8fe54f0SJason M. Bills     if (ret < 0)
2139a8fe54f0SJason M. Bills     {
2140a8fe54f0SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: "
2141a8fe54f0SJason M. Bills                          << strerror(-ret);
2142a8fe54f0SJason M. Bills     }
2143a8fe54f0SJason M. Bills     if (!syslogID.empty())
2144a8fe54f0SJason M. Bills     {
2145a8fe54f0SJason M. Bills         message += std::string(syslogID) + ": ";
2146a8fe54f0SJason M. Bills     }
2147a8fe54f0SJason M. Bills 
214839e77504SEd Tanous     std::string_view msg;
214916428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
2150e1f26343SJason M. Bills     if (ret < 0)
2151e1f26343SJason M. Bills     {
2152e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
2153e1f26343SJason M. Bills         return 1;
2154e1f26343SJason M. Bills     }
2155a8fe54f0SJason M. Bills     message += std::string(msg);
2156e1f26343SJason M. Bills 
2157e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
2158271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
215916428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
2160e1f26343SJason M. Bills     if (ret < 0)
2161e1f26343SJason M. Bills     {
2162e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
2163e1f26343SJason M. Bills     }
2164e1f26343SJason M. Bills 
2165e1f26343SJason M. Bills     // Get the Created time from the timestamp
216616428a1aSJason M. Bills     std::string entryTimeStr;
216716428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
2168e1f26343SJason M. Bills     {
216916428a1aSJason M. Bills         return 1;
2170e1f26343SJason M. Bills     }
2171e1f26343SJason M. Bills 
2172e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
2173c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
2174647b3cdcSGeorge Liu         {"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
2175c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
2176c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
2177e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
2178c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
2179a8fe54f0SJason M. Bills         {"Message", std::move(message)},
2180e1f26343SJason M. Bills         {"EntryType", "Oem"},
2181738c1e61SPatrick Williams         {"Severity", severity <= 2   ? "Critical"
2182738c1e61SPatrick Williams                      : severity <= 4 ? "Warning"
2183738c1e61SPatrick Williams                                      : "OK"},
2184086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
2185e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
2186e1f26343SJason M. Bills     return 0;
2187e1f26343SJason M. Bills }
2188e1f26343SJason M. Bills 
21897e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app)
2190e1f26343SJason M. Bills {
21917e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
2192ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
21930fda0f12SGeorge Liu         .methods(
21940fda0f12SGeorge Liu             boost::beast::http::verb::
21950fda0f12SGeorge Liu                 get)([](const crow::Request& req,
21967e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2197193ad2faSJason M. Bills             static constexpr const long maxEntriesPerPage = 1000;
2198271584abSEd Tanous             uint64_t skip = 0;
2199271584abSEd Tanous             uint64_t top = maxEntriesPerPage; // Show max entries by default
22008d1b46d7Szhanghch05             if (!getSkipParam(asyncResp, req, skip))
2201193ad2faSJason M. Bills             {
2202193ad2faSJason M. Bills                 return;
2203193ad2faSJason M. Bills             }
22048d1b46d7Szhanghch05             if (!getTopParam(asyncResp, req, top))
2205193ad2faSJason M. Bills             {
2206193ad2faSJason M. Bills                 return;
2207193ad2faSJason M. Bills             }
22087e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
22097e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
2210e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
2211e1f26343SJason M. Bills                 "#LogEntryCollection.LogEntryCollection";
22120f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
22130f74e643SEd Tanous                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2214e1f26343SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
2215e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2216e1f26343SJason M. Bills                 "Collection of BMC Journal Entries";
22170fda0f12SGeorge Liu             nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2218e1f26343SJason M. Bills             logEntryArray = nlohmann::json::array();
2219e1f26343SJason M. Bills 
22207e860f15SJohn Edward Broadbent             // Go through the journal and use the timestamp to create a
22217e860f15SJohn Edward Broadbent             // unique ID for each entry
2222e1f26343SJason M. Bills             sd_journal* journalTmp = nullptr;
2223e1f26343SJason M. Bills             int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2224e1f26343SJason M. Bills             if (ret < 0)
2225e1f26343SJason M. Bills             {
22267e860f15SJohn Edward Broadbent                 BMCWEB_LOG_ERROR << "failed to open journal: "
22277e860f15SJohn Edward Broadbent                                  << strerror(-ret);
2228f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
2229e1f26343SJason M. Bills                 return;
2230e1f26343SJason M. Bills             }
22310fda0f12SGeorge Liu             std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
22320fda0f12SGeorge Liu                 journalTmp, sd_journal_close);
2233e1f26343SJason M. Bills             journalTmp = nullptr;
2234b01bf299SEd Tanous             uint64_t entryCount = 0;
2235e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
2236e85d6b16SJason M. Bills             bool firstEntry = true;
2237e1f26343SJason M. Bills             SD_JOURNAL_FOREACH(journal.get())
2238e1f26343SJason M. Bills             {
2239193ad2faSJason M. Bills                 entryCount++;
22407e860f15SJohn Edward Broadbent                 // Handle paging using skip (number of entries to skip from
22417e860f15SJohn Edward Broadbent                 // the start) and top (number of entries to display)
2242193ad2faSJason M. Bills                 if (entryCount <= skip || entryCount > skip + top)
2243193ad2faSJason M. Bills                 {
2244193ad2faSJason M. Bills                     continue;
2245193ad2faSJason M. Bills                 }
2246193ad2faSJason M. Bills 
224716428a1aSJason M. Bills                 std::string idStr;
2248e85d6b16SJason M. Bills                 if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2249e1f26343SJason M. Bills                 {
2250e1f26343SJason M. Bills                     continue;
2251e1f26343SJason M. Bills                 }
2252e1f26343SJason M. Bills 
2253e85d6b16SJason M. Bills                 if (firstEntry)
2254e85d6b16SJason M. Bills                 {
2255e85d6b16SJason M. Bills                     firstEntry = false;
2256e85d6b16SJason M. Bills                 }
2257e85d6b16SJason M. Bills 
2258e1f26343SJason M. Bills                 logEntryArray.push_back({});
2259c4bf6374SJason M. Bills                 nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
2260c4bf6374SJason M. Bills                 if (fillBMCJournalLogEntryJson(idStr, journal.get(),
2261c4bf6374SJason M. Bills                                                bmcJournalLogEntry) != 0)
2262e1f26343SJason M. Bills                 {
2263f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
2264e1f26343SJason M. Bills                     return;
2265e1f26343SJason M. Bills                 }
2266e1f26343SJason M. Bills             }
2267193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
2268193ad2faSJason M. Bills             if (skip + top < entryCount)
2269193ad2faSJason M. Bills             {
2270193ad2faSJason M. Bills                 asyncResp->res.jsonValue["Members@odata.nextLink"] =
22710fda0f12SGeorge Liu                     "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
2272193ad2faSJason M. Bills                     std::to_string(skip + top);
2273193ad2faSJason M. Bills             }
22747e860f15SJohn Edward Broadbent         });
2275e1f26343SJason M. Bills }
2276e1f26343SJason M. Bills 
22777e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app)
2278e1f26343SJason M. Bills {
22797e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
22807e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/")
2281ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
22827e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
22837e860f15SJohn Edward Broadbent             [](const crow::Request&,
22847e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22857e860f15SJohn Edward Broadbent                const std::string& entryID) {
2286e1f26343SJason M. Bills                 // Convert the unique ID back to a timestamp to find the entry
2287e1f26343SJason M. Bills                 uint64_t ts = 0;
2288271584abSEd Tanous                 uint64_t index = 0;
22898d1b46d7Szhanghch05                 if (!getTimestampFromID(asyncResp, entryID, ts, index))
2290e1f26343SJason M. Bills                 {
229116428a1aSJason M. Bills                     return;
2292e1f26343SJason M. Bills                 }
2293e1f26343SJason M. Bills 
2294e1f26343SJason M. Bills                 sd_journal* journalTmp = nullptr;
2295e1f26343SJason M. Bills                 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2296e1f26343SJason M. Bills                 if (ret < 0)
2297e1f26343SJason M. Bills                 {
22987e860f15SJohn Edward Broadbent                     BMCWEB_LOG_ERROR << "failed to open journal: "
22997e860f15SJohn Edward Broadbent                                      << strerror(-ret);
2300f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
2301e1f26343SJason M. Bills                     return;
2302e1f26343SJason M. Bills                 }
23037e860f15SJohn Edward Broadbent                 std::unique_ptr<sd_journal, decltype(&sd_journal_close)>
23047e860f15SJohn Edward Broadbent                     journal(journalTmp, sd_journal_close);
2305e1f26343SJason M. Bills                 journalTmp = nullptr;
23067e860f15SJohn Edward Broadbent                 // Go to the timestamp in the log and move to the entry at the
23077e860f15SJohn Edward Broadbent                 // index tracking the unique ID
2308af07e3f5SJason M. Bills                 std::string idStr;
2309af07e3f5SJason M. Bills                 bool firstEntry = true;
2310e1f26343SJason M. Bills                 ret = sd_journal_seek_realtime_usec(journal.get(), ts);
23112056b6d1SManojkiran Eda                 if (ret < 0)
23122056b6d1SManojkiran Eda                 {
23132056b6d1SManojkiran Eda                     BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
23142056b6d1SManojkiran Eda                                      << strerror(-ret);
23152056b6d1SManojkiran Eda                     messages::internalError(asyncResp->res);
23162056b6d1SManojkiran Eda                     return;
23172056b6d1SManojkiran Eda                 }
2318271584abSEd Tanous                 for (uint64_t i = 0; i <= index; i++)
2319e1f26343SJason M. Bills                 {
2320e1f26343SJason M. Bills                     sd_journal_next(journal.get());
2321af07e3f5SJason M. Bills                     if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2322af07e3f5SJason M. Bills                     {
2323af07e3f5SJason M. Bills                         messages::internalError(asyncResp->res);
2324af07e3f5SJason M. Bills                         return;
2325af07e3f5SJason M. Bills                     }
2326af07e3f5SJason M. Bills                     if (firstEntry)
2327af07e3f5SJason M. Bills                     {
2328af07e3f5SJason M. Bills                         firstEntry = false;
2329af07e3f5SJason M. Bills                     }
2330e1f26343SJason M. Bills                 }
2331c4bf6374SJason M. Bills                 // Confirm that the entry ID matches what was requested
2332af07e3f5SJason M. Bills                 if (idStr != entryID)
2333c4bf6374SJason M. Bills                 {
2334c4bf6374SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, entryID);
2335c4bf6374SJason M. Bills                     return;
2336c4bf6374SJason M. Bills                 }
2337c4bf6374SJason M. Bills 
2338c4bf6374SJason M. Bills                 if (fillBMCJournalLogEntryJson(entryID, journal.get(),
2339e1f26343SJason M. Bills                                                asyncResp->res.jsonValue) != 0)
2340e1f26343SJason M. Bills                 {
2341f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
2342e1f26343SJason M. Bills                     return;
2343e1f26343SJason M. Bills                 }
23447e860f15SJohn Edward Broadbent             });
2345c9bb6861Sraviteja-b }
2346c9bb6861Sraviteja-b 
23477e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpService(App& app)
2348c9bb6861Sraviteja-b {
23497e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2350ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
23510fda0f12SGeorge Liu         .methods(
23520fda0f12SGeorge Liu             boost::beast::http::verb::
23530fda0f12SGeorge Liu                 get)([](const crow::Request&,
23547e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2355c9bb6861Sraviteja-b             asyncResp->res.jsonValue["@odata.id"] =
23565cb1dd27SAsmitha Karunanithi                 "/redfish/v1/Managers/bmc/LogServices/Dump";
2357c9bb6861Sraviteja-b             asyncResp->res.jsonValue["@odata.type"] =
2358d337bb72SAsmitha Karunanithi                 "#LogService.v1_2_0.LogService";
2359c9bb6861Sraviteja-b             asyncResp->res.jsonValue["Name"] = "Dump LogService";
23605cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
23615cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Id"] = "Dump";
2362c9bb6861Sraviteja-b             asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
23637c8c4058STejas Patil 
23647c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
23657c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
23660fda0f12SGeorge Liu             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
23677c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
23687c8c4058STejas Patil                 redfishDateTimeOffset.second;
23697c8c4058STejas Patil 
2370c9bb6861Sraviteja-b             asyncResp->res.jsonValue["Entries"] = {
23717e860f15SJohn Edward Broadbent                 {"@odata.id",
23727e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
23735cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Actions"] = {
23745cb1dd27SAsmitha Karunanithi                 {"#LogService.ClearLog",
23750fda0f12SGeorge Liu                  {{"target",
23760fda0f12SGeorge Liu                    "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog"}}},
2377d337bb72SAsmitha Karunanithi                 {"#LogService.CollectDiagnosticData",
23780fda0f12SGeorge Liu                  {{"target",
23790fda0f12SGeorge Liu                    "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData"}}}};
23807e860f15SJohn Edward Broadbent         });
2381c9bb6861Sraviteja-b }
2382c9bb6861Sraviteja-b 
23837e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntryCollection(App& app)
23847e860f15SJohn Edward Broadbent {
23857e860f15SJohn Edward Broadbent 
2386c9bb6861Sraviteja-b     /**
2387c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
2388c9bb6861Sraviteja-b      */
23897e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2390ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
23917e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
23927e860f15SJohn Edward Broadbent             [](const crow::Request&,
23937e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2394c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.type"] =
2395c9bb6861Sraviteja-b                     "#LogEntryCollection.LogEntryCollection";
2396c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.id"] =
23975cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
23985cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
2399c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Description"] =
24005cb1dd27SAsmitha Karunanithi                     "Collection of BMC Dump Entries";
2401c9bb6861Sraviteja-b 
24025cb1dd27SAsmitha Karunanithi                 getDumpEntryCollection(asyncResp, "BMC");
24037e860f15SJohn Edward Broadbent             });
2404c9bb6861Sraviteja-b }
2405c9bb6861Sraviteja-b 
24067e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app)
2407c9bb6861Sraviteja-b {
24087e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
24097e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2410ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
24117e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
24127e860f15SJohn Edward Broadbent             [](const crow::Request&,
24137e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
24147e860f15SJohn Edward Broadbent                const std::string& param) {
24157e860f15SJohn Edward Broadbent                 getDumpEntryById(asyncResp, param, "BMC");
24167e860f15SJohn Edward Broadbent             });
24177e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
24187e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2419ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
24207e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
24217e860f15SJohn Edward Broadbent             [](const crow::Request&,
24227e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
24237e860f15SJohn Edward Broadbent                const std::string& param) {
24247e860f15SJohn Edward Broadbent                 deleteDumpEntry(asyncResp, param, "bmc");
24257e860f15SJohn Edward Broadbent             });
2426c9bb6861Sraviteja-b }
2427c9bb6861Sraviteja-b 
24287e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app)
2429c9bb6861Sraviteja-b {
24308d1b46d7Szhanghch05 
24310fda0f12SGeorge Liu     BMCWEB_ROUTE(
24320fda0f12SGeorge Liu         app,
24330fda0f12SGeorge Liu         "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
2434ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
24357e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
24367e860f15SJohn Edward Broadbent             [](const crow::Request& req,
24377e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
24388d1b46d7Szhanghch05                 createDump(asyncResp, req, "BMC");
24397e860f15SJohn Edward Broadbent             });
2440a43be80fSAsmitha Karunanithi }
2441a43be80fSAsmitha Karunanithi 
24427e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app)
244380319af1SAsmitha Karunanithi {
24440fda0f12SGeorge Liu     BMCWEB_ROUTE(
24450fda0f12SGeorge Liu         app,
24460fda0f12SGeorge Liu         "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/")
2447ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
24487e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
24497e860f15SJohn Edward Broadbent             [](const crow::Request&,
24507e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
24518d1b46d7Szhanghch05                 clearDump(asyncResp, "BMC");
24527e860f15SJohn Edward Broadbent             });
24535cb1dd27SAsmitha Karunanithi }
24545cb1dd27SAsmitha Karunanithi 
24557e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app)
24565cb1dd27SAsmitha Karunanithi {
24577e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/")
2458ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
24597e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
24607e860f15SJohn Edward Broadbent             [](const crow::Request&,
24617e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
24625cb1dd27SAsmitha Karunanithi 
24637e860f15SJohn Edward Broadbent             {
24645cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] =
24655cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Systems/system/LogServices/Dump";
24665cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
2467d337bb72SAsmitha Karunanithi                     "#LogService.v1_2_0.LogService";
24685cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "Dump LogService";
24697e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Description"] =
24707e860f15SJohn Edward Broadbent                     "System Dump LogService";
24715cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = "Dump";
24725cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
24737c8c4058STejas Patil 
24747c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
24757c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
24767c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
24777c8c4058STejas Patil                     redfishDateTimeOffset.first;
24787c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
24797c8c4058STejas Patil                     redfishDateTimeOffset.second;
24807c8c4058STejas Patil 
24815cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Entries"] = {
24825cb1dd27SAsmitha Karunanithi                     {"@odata.id",
24835cb1dd27SAsmitha Karunanithi                      "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
24845cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Actions"] = {
24855cb1dd27SAsmitha Karunanithi                     {"#LogService.ClearLog",
24867e860f15SJohn Edward Broadbent                      {{"target",
24870fda0f12SGeorge Liu                        "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog"}}},
2488d337bb72SAsmitha Karunanithi                     {"#LogService.CollectDiagnosticData",
24897e860f15SJohn Edward Broadbent                      {{"target",
24900fda0f12SGeorge Liu                        "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData"}}}};
24917e860f15SJohn Edward Broadbent             });
24925cb1dd27SAsmitha Karunanithi }
24935cb1dd27SAsmitha Karunanithi 
24947e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app)
24957e860f15SJohn Edward Broadbent {
24967e860f15SJohn Edward Broadbent 
24975cb1dd27SAsmitha Karunanithi     /**
24985cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
24995cb1dd27SAsmitha Karunanithi      */
2500b2a3289dSAsmitha Karunanithi     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
2501ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
25027e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
25037e860f15SJohn Edward Broadbent             [](const crow::Request&,
2504864d6a17SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
25055cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
25065cb1dd27SAsmitha Karunanithi                     "#LogEntryCollection.LogEntryCollection";
25075cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] =
25085cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Systems/system/LogServices/Dump/Entries";
25095cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "System Dump Entries";
25105cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Description"] =
25115cb1dd27SAsmitha Karunanithi                     "Collection of System Dump Entries";
25125cb1dd27SAsmitha Karunanithi 
25135cb1dd27SAsmitha Karunanithi                 getDumpEntryCollection(asyncResp, "System");
25147e860f15SJohn Edward Broadbent             });
25155cb1dd27SAsmitha Karunanithi }
25165cb1dd27SAsmitha Karunanithi 
25177e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app)
25185cb1dd27SAsmitha Karunanithi {
25197e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2520864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2521ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
2522ed398213SEd Tanous 
25237e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
25247e860f15SJohn Edward Broadbent             [](const crow::Request&,
25257e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25267e860f15SJohn Edward Broadbent                const std::string& param) {
25277e860f15SJohn Edward Broadbent                 getDumpEntryById(asyncResp, param, "System");
25287e860f15SJohn Edward Broadbent             });
25298d1b46d7Szhanghch05 
25307e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2531864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2532ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
25337e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
25347e860f15SJohn Edward Broadbent             [](const crow::Request&,
25357e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25367e860f15SJohn Edward Broadbent                const std::string& param) {
25377e860f15SJohn Edward Broadbent                 deleteDumpEntry(asyncResp, param, "system");
25387e860f15SJohn Edward Broadbent             });
25395cb1dd27SAsmitha Karunanithi }
2540c9bb6861Sraviteja-b 
25417e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app)
2542c9bb6861Sraviteja-b {
25430fda0f12SGeorge Liu     BMCWEB_ROUTE(
25440fda0f12SGeorge Liu         app,
25450fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
2546ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
25477e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
25487e860f15SJohn Edward Broadbent             [](const crow::Request& req,
25497e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
25507e860f15SJohn Edward Broadbent 
25517e860f15SJohn Edward Broadbent             { createDump(asyncResp, req, "System"); });
2552a43be80fSAsmitha Karunanithi }
2553a43be80fSAsmitha Karunanithi 
25547e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app)
2555a43be80fSAsmitha Karunanithi {
25560fda0f12SGeorge Liu     BMCWEB_ROUTE(
25570fda0f12SGeorge Liu         app,
25580fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog/")
2559ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
25607e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
25617e860f15SJohn Edward Broadbent             [](const crow::Request&,
25627e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
25637e860f15SJohn Edward Broadbent 
25647e860f15SJohn Edward Broadbent             { clearDump(asyncResp, "System"); });
2565013487e5Sraviteja-b }
2566013487e5Sraviteja-b 
25677e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app)
25681da66f75SEd Tanous {
25693946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
25703946028dSAppaRao Puli     // method for security reasons.
25711da66f75SEd Tanous     /**
25721da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
25731da66f75SEd Tanous      */
25747e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
2575ed398213SEd Tanous         // This is incorrect, should be:
2576ed398213SEd Tanous         //.privileges(redfish::privileges::getLogService)
2577432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
25787e860f15SJohn Edward Broadbent         .methods(
25797e860f15SJohn Edward Broadbent             boost::beast::http::verb::
25807e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
25817e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
25827e860f15SJohn Edward Broadbent             // Copy over the static data to include the entries added by
25837e860f15SJohn Edward Broadbent             // SubRoute
25840f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2585424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump";
2586e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
25878e6c099aSJason M. Bills                 "#LogService.v1_2_0.LogService";
25884f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
25894f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
25904f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2591e1f26343SJason M. Bills             asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2592e1f26343SJason M. Bills             asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
25937c8c4058STejas Patil 
25947c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
25957c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
25967c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
25977c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
25987c8c4058STejas Patil                 redfishDateTimeOffset.second;
25997c8c4058STejas Patil 
2600cd50aa42SJason M. Bills             asyncResp->res.jsonValue["Entries"] = {
2601cd50aa42SJason M. Bills                 {"@odata.id",
2602424c4176SJason M. Bills                  "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
2603e1f26343SJason M. Bills             asyncResp->res.jsonValue["Actions"] = {
26045b61b5e8SJason M. Bills                 {"#LogService.ClearLog",
26050fda0f12SGeorge Liu                  {{"target",
26060fda0f12SGeorge Liu                    "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog"}}},
26078e6c099aSJason M. Bills                 {"#LogService.CollectDiagnosticData",
26080fda0f12SGeorge Liu                  {{"target",
26090fda0f12SGeorge Liu                    "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData"}}}};
26107e860f15SJohn Edward Broadbent         });
26111da66f75SEd Tanous }
26121da66f75SEd Tanous 
26137e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app)
26145b61b5e8SJason M. Bills {
26150fda0f12SGeorge Liu     BMCWEB_ROUTE(
26160fda0f12SGeorge Liu         app,
26170fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog/")
2618ed398213SEd Tanous         // This is incorrect, should be:
2619ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2620432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
26217e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
26227e860f15SJohn Edward Broadbent             [](const crow::Request&,
26237e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
26245b61b5e8SJason M. Bills                 crow::connections::systemBus->async_method_call(
26255b61b5e8SJason M. Bills                     [asyncResp](const boost::system::error_code ec,
2626cb13a392SEd Tanous                                 const std::string&) {
26275b61b5e8SJason M. Bills                         if (ec)
26285b61b5e8SJason M. Bills                         {
26295b61b5e8SJason M. Bills                             messages::internalError(asyncResp->res);
26305b61b5e8SJason M. Bills                             return;
26315b61b5e8SJason M. Bills                         }
26325b61b5e8SJason M. Bills                         messages::success(asyncResp->res);
26335b61b5e8SJason M. Bills                     },
26347e860f15SJohn Edward Broadbent                     crashdumpObject, crashdumpPath, deleteAllInterface,
26357e860f15SJohn Edward Broadbent                     "DeleteAll");
26367e860f15SJohn Edward Broadbent             });
26375b61b5e8SJason M. Bills }
26385b61b5e8SJason M. Bills 
26398d1b46d7Szhanghch05 static void
26408d1b46d7Szhanghch05     logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
26418d1b46d7Szhanghch05                       const std::string& logID, nlohmann::json& logEntryJson)
2642e855dd28SJason M. Bills {
2643043a0536SJohnathan Mantey     auto getStoredLogCallback =
2644043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2645e855dd28SJason M. Bills             const boost::system::error_code ec,
2646168e20c1SEd Tanous             const std::vector<
2647168e20c1SEd Tanous                 std::pair<std::string, dbus::utility::DbusVariantType>>&
2648168e20c1SEd Tanous                 params) {
2649e855dd28SJason M. Bills             if (ec)
2650e855dd28SJason M. Bills             {
2651e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
26521ddcf01aSJason M. Bills                 if (ec.value() ==
26531ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
26541ddcf01aSJason M. Bills                 {
2655043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2656043a0536SJohnathan Mantey                                                logID);
26571ddcf01aSJason M. Bills                 }
26581ddcf01aSJason M. Bills                 else
26591ddcf01aSJason M. Bills                 {
2660e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
26611ddcf01aSJason M. Bills                 }
2662e855dd28SJason M. Bills                 return;
2663e855dd28SJason M. Bills             }
2664043a0536SJohnathan Mantey 
2665043a0536SJohnathan Mantey             std::string timestamp{};
2666043a0536SJohnathan Mantey             std::string filename{};
2667043a0536SJohnathan Mantey             std::string logfile{};
26682c70f800SEd Tanous             parseCrashdumpParameters(params, filename, timestamp, logfile);
2669043a0536SJohnathan Mantey 
2670043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2671e855dd28SJason M. Bills             {
2672043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2673e855dd28SJason M. Bills                 return;
2674e855dd28SJason M. Bills             }
2675e855dd28SJason M. Bills 
2676043a0536SJohnathan Mantey             std::string crashdumpURI =
2677e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2678043a0536SJohnathan Mantey                 logID + "/" + filename;
2679d0dbeefdSEd Tanous             logEntryJson = {{"@odata.type", "#LogEntry.v1_7_0.LogEntry"},
2680043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2681043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2682e855dd28SJason M. Bills                                               logID},
2683e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2684e855dd28SJason M. Bills                             {"Id", logID},
2685e855dd28SJason M. Bills                             {"EntryType", "Oem"},
26868e6c099aSJason M. Bills                             {"AdditionalDataURI", std::move(crashdumpURI)},
26878e6c099aSJason M. Bills                             {"DiagnosticDataType", "OEM"},
26888e6c099aSJason M. Bills                             {"OEMDiagnosticDataType", "PECICrashdump"},
2689043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2690e855dd28SJason M. Bills         };
2691e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
26925b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
26935b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2694043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2695e855dd28SJason M. Bills }
2696e855dd28SJason M. Bills 
26977e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app)
26981da66f75SEd Tanous {
26993946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
27003946028dSAppaRao Puli     // method for security reasons.
27011da66f75SEd Tanous     /**
27021da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
27031da66f75SEd Tanous      */
27047e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
27057e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
2706ed398213SEd Tanous         // This is incorrect, should be.
2707ed398213SEd Tanous         //.privileges(redfish::privileges::postLogEntryCollection)
2708432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
27097e860f15SJohn Edward Broadbent         .methods(
27107e860f15SJohn Edward Broadbent             boost::beast::http::verb::
27117e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
27127e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
27137e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
27147e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
2715e1f26343SJason M. Bills             auto getLogEntriesCallback = [asyncResp](
2716e1f26343SJason M. Bills                                              const boost::system::error_code ec,
27177e860f15SJohn Edward Broadbent                                              const std::vector<std::string>&
27187e860f15SJohn Edward Broadbent                                                  resp) {
27191da66f75SEd Tanous                 if (ec)
27201da66f75SEd Tanous                 {
27211da66f75SEd Tanous                     if (ec.value() !=
27221da66f75SEd Tanous                         boost::system::errc::no_such_file_or_directory)
27231da66f75SEd Tanous                     {
27241da66f75SEd Tanous                         BMCWEB_LOG_DEBUG << "failed to get entries ec: "
27251da66f75SEd Tanous                                          << ec.message();
2726f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
27271da66f75SEd Tanous                         return;
27281da66f75SEd Tanous                     }
27291da66f75SEd Tanous                 }
2730e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
27311da66f75SEd Tanous                     "#LogEntryCollection.LogEntryCollection";
27320f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
2733424c4176SJason M. Bills                     "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2734424c4176SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2735e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
2736424c4176SJason M. Bills                     "Collection of Crashdump Entries";
27377e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
27387e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
2739e1f26343SJason M. Bills                 logEntryArray = nlohmann::json::array();
2740e855dd28SJason M. Bills                 std::vector<std::string> logIDs;
2741e855dd28SJason M. Bills                 // Get the list of log entries and build up an empty array big
2742e855dd28SJason M. Bills                 // enough to hold them
27431da66f75SEd Tanous                 for (const std::string& objpath : resp)
27441da66f75SEd Tanous                 {
2745e855dd28SJason M. Bills                     // Get the log ID
2746f23b7296SEd Tanous                     std::size_t lastPos = objpath.rfind('/');
2747e855dd28SJason M. Bills                     if (lastPos == std::string::npos)
27481da66f75SEd Tanous                     {
2749e855dd28SJason M. Bills                         continue;
27501da66f75SEd Tanous                     }
2751e855dd28SJason M. Bills                     logIDs.emplace_back(objpath.substr(lastPos + 1));
2752e855dd28SJason M. Bills 
2753e855dd28SJason M. Bills                     // Add a space for the log entry to the array
2754e855dd28SJason M. Bills                     logEntryArray.push_back({});
2755e855dd28SJason M. Bills                 }
2756e855dd28SJason M. Bills                 // Now go through and set up async calls to fill in the entries
2757e855dd28SJason M. Bills                 size_t index = 0;
2758e855dd28SJason M. Bills                 for (const std::string& logID : logIDs)
2759e855dd28SJason M. Bills                 {
2760e855dd28SJason M. Bills                     // Add the log entry to the array
2761e855dd28SJason M. Bills                     logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
27621da66f75SEd Tanous                 }
2763e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
2764e1f26343SJason M. Bills                     logEntryArray.size();
27651da66f75SEd Tanous             };
27661da66f75SEd Tanous             crow::connections::systemBus->async_method_call(
27671da66f75SEd Tanous                 std::move(getLogEntriesCallback),
27681da66f75SEd Tanous                 "xyz.openbmc_project.ObjectMapper",
27691da66f75SEd Tanous                 "/xyz/openbmc_project/object_mapper",
27701da66f75SEd Tanous                 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
27715b61b5e8SJason M. Bills                 std::array<const char*, 1>{crashdumpInterface});
27727e860f15SJohn Edward Broadbent         });
27731da66f75SEd Tanous }
27741da66f75SEd Tanous 
27757e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app)
27761da66f75SEd Tanous {
27773946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
27783946028dSAppaRao Puli     // method for security reasons.
27791da66f75SEd Tanous 
27807e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
27817e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/")
2782ed398213SEd Tanous         // this is incorrect, should be
2783ed398213SEd Tanous         // .privileges(redfish::privileges::getLogEntry)
2784432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
27857e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
27867e860f15SJohn Edward Broadbent             [](const crow::Request&,
27877e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
27887e860f15SJohn Edward Broadbent                const std::string& param) {
27897e860f15SJohn Edward Broadbent                 const std::string& logID = param;
2790e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
27917e860f15SJohn Edward Broadbent             });
2792e855dd28SJason M. Bills }
2793e855dd28SJason M. Bills 
27947e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app)
2795e855dd28SJason M. Bills {
27963946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
27973946028dSAppaRao Puli     // method for security reasons.
27987e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
27997e860f15SJohn Edward Broadbent         app,
28007e860f15SJohn Edward Broadbent         "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/")
2801ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
28027e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
28037e860f15SJohn Edward Broadbent             [](const crow::Request&,
28047e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
28057e860f15SJohn Edward Broadbent                const std::string& logID, const std::string& fileName) {
2806043a0536SJohnathan Mantey                 auto getStoredLogCallback =
2807043a0536SJohnathan Mantey                     [asyncResp, logID, fileName](
2808abf2add6SEd Tanous                         const boost::system::error_code ec,
2809168e20c1SEd Tanous                         const std::vector<std::pair<
2810168e20c1SEd Tanous                             std::string, dbus::utility::DbusVariantType>>&
28117e860f15SJohn Edward Broadbent                             resp) {
28121da66f75SEd Tanous                         if (ec)
28131da66f75SEd Tanous                         {
2814043a0536SJohnathan Mantey                             BMCWEB_LOG_DEBUG << "failed to get log ec: "
2815043a0536SJohnathan Mantey                                              << ec.message();
2816f12894f8SJason M. Bills                             messages::internalError(asyncResp->res);
28171da66f75SEd Tanous                             return;
28181da66f75SEd Tanous                         }
2819e855dd28SJason M. Bills 
2820043a0536SJohnathan Mantey                         std::string dbusFilename{};
2821043a0536SJohnathan Mantey                         std::string dbusTimestamp{};
2822043a0536SJohnathan Mantey                         std::string dbusFilepath{};
2823043a0536SJohnathan Mantey 
28247e860f15SJohn Edward Broadbent                         parseCrashdumpParameters(resp, dbusFilename,
28257e860f15SJohn Edward Broadbent                                                  dbusTimestamp, dbusFilepath);
2826043a0536SJohnathan Mantey 
2827043a0536SJohnathan Mantey                         if (dbusFilename.empty() || dbusTimestamp.empty() ||
2828043a0536SJohnathan Mantey                             dbusFilepath.empty())
28291da66f75SEd Tanous                         {
28307e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
28317e860f15SJohn Edward Broadbent                                                            fileName);
28321da66f75SEd Tanous                             return;
28331da66f75SEd Tanous                         }
2834e855dd28SJason M. Bills 
2835043a0536SJohnathan Mantey                         // Verify the file name parameter is correct
2836043a0536SJohnathan Mantey                         if (fileName != dbusFilename)
2837043a0536SJohnathan Mantey                         {
28387e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
28397e860f15SJohn Edward Broadbent                                                            fileName);
2840043a0536SJohnathan Mantey                             return;
2841043a0536SJohnathan Mantey                         }
2842043a0536SJohnathan Mantey 
2843043a0536SJohnathan Mantey                         if (!std::filesystem::exists(dbusFilepath))
2844043a0536SJohnathan Mantey                         {
28457e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
28467e860f15SJohn Edward Broadbent                                                            fileName);
2847043a0536SJohnathan Mantey                             return;
2848043a0536SJohnathan Mantey                         }
2849043a0536SJohnathan Mantey                         std::ifstream ifs(dbusFilepath, std::ios::in |
2850043a0536SJohnathan Mantey                                                             std::ios::binary |
2851043a0536SJohnathan Mantey                                                             std::ios::ate);
2852043a0536SJohnathan Mantey                         std::ifstream::pos_type fileSize = ifs.tellg();
2853043a0536SJohnathan Mantey                         if (fileSize < 0)
2854043a0536SJohnathan Mantey                         {
2855043a0536SJohnathan Mantey                             messages::generalError(asyncResp->res);
2856043a0536SJohnathan Mantey                             return;
2857043a0536SJohnathan Mantey                         }
2858043a0536SJohnathan Mantey                         ifs.seekg(0, std::ios::beg);
2859043a0536SJohnathan Mantey 
2860043a0536SJohnathan Mantey                         auto crashData = std::make_unique<char[]>(
2861043a0536SJohnathan Mantey                             static_cast<unsigned int>(fileSize));
2862043a0536SJohnathan Mantey 
2863043a0536SJohnathan Mantey                         ifs.read(crashData.get(), static_cast<int>(fileSize));
2864043a0536SJohnathan Mantey 
28657e860f15SJohn Edward Broadbent                         // The cast to std::string is intentional in order to
28667e860f15SJohn Edward Broadbent                         // use the assign() that applies move mechanics
2867043a0536SJohnathan Mantey                         asyncResp->res.body().assign(
2868043a0536SJohnathan Mantey                             static_cast<std::string>(crashData.get()));
2869043a0536SJohnathan Mantey 
28707e860f15SJohn Edward Broadbent                         // Configure this to be a file download when accessed
28717e860f15SJohn Edward Broadbent                         // from a browser
28727e860f15SJohn Edward Broadbent                         asyncResp->res.addHeader("Content-Disposition",
28737e860f15SJohn Edward Broadbent                                                  "attachment");
28741da66f75SEd Tanous                     };
28751da66f75SEd Tanous                 crow::connections::systemBus->async_method_call(
28765b61b5e8SJason M. Bills                     std::move(getStoredLogCallback), crashdumpObject,
28775b61b5e8SJason M. Bills                     crashdumpPath + std::string("/") + logID,
28787e860f15SJohn Edward Broadbent                     "org.freedesktop.DBus.Properties", "GetAll",
28797e860f15SJohn Edward Broadbent                     crashdumpInterface);
28807e860f15SJohn Edward Broadbent             });
28811da66f75SEd Tanous }
28821da66f75SEd Tanous 
28837e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app)
28841da66f75SEd Tanous {
28853946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
28863946028dSAppaRao Puli     // method for security reasons.
28870fda0f12SGeorge Liu     BMCWEB_ROUTE(
28880fda0f12SGeorge Liu         app,
28890fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
2890ed398213SEd Tanous         // The below is incorrect;  Should be ConfigureManager
2891ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2892432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
28937e860f15SJohn Edward Broadbent         .methods(
28947e860f15SJohn Edward Broadbent             boost::beast::http::verb::
28957e860f15SJohn Edward Broadbent                 post)([](const crow::Request& req,
28967e860f15SJohn Edward Broadbent                          const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
28978e6c099aSJason M. Bills             std::string diagnosticDataType;
28988e6c099aSJason M. Bills             std::string oemDiagnosticDataType;
28998e6c099aSJason M. Bills             if (!redfish::json_util::readJson(
29007e860f15SJohn Edward Broadbent                     req, asyncResp->res, "DiagnosticDataType",
29017e860f15SJohn Edward Broadbent                     diagnosticDataType, "OEMDiagnosticDataType",
29027e860f15SJohn Edward Broadbent                     oemDiagnosticDataType))
29038e6c099aSJason M. Bills             {
29048e6c099aSJason M. Bills                 return;
29058e6c099aSJason M. Bills             }
29068e6c099aSJason M. Bills 
29078e6c099aSJason M. Bills             if (diagnosticDataType != "OEM")
29088e6c099aSJason M. Bills             {
29098e6c099aSJason M. Bills                 BMCWEB_LOG_ERROR
29108e6c099aSJason M. Bills                     << "Only OEM DiagnosticDataType supported for Crashdump";
29118e6c099aSJason M. Bills                 messages::actionParameterValueFormatError(
29128e6c099aSJason M. Bills                     asyncResp->res, diagnosticDataType, "DiagnosticDataType",
29138e6c099aSJason M. Bills                     "CollectDiagnosticData");
29148e6c099aSJason M. Bills                 return;
29158e6c099aSJason M. Bills             }
29168e6c099aSJason M. Bills 
291798be3e39SEd Tanous             auto collectCrashdumpCallback = [asyncResp,
291898be3e39SEd Tanous                                              payload(task::Payload(req))](
29197e860f15SJohn Edward Broadbent                                                 const boost::system::error_code
29207e860f15SJohn Edward Broadbent                                                     ec,
292198be3e39SEd Tanous                                                 const std::string&) mutable {
29221da66f75SEd Tanous                 if (ec)
29231da66f75SEd Tanous                 {
29247e860f15SJohn Edward Broadbent                     if (ec.value() ==
29257e860f15SJohn Edward Broadbent                         boost::system::errc::operation_not_supported)
29261da66f75SEd Tanous                     {
2927f12894f8SJason M. Bills                         messages::resourceInStandby(asyncResp->res);
29281da66f75SEd Tanous                     }
29294363d3b2SJason M. Bills                     else if (ec.value() ==
29304363d3b2SJason M. Bills                              boost::system::errc::device_or_resource_busy)
29314363d3b2SJason M. Bills                     {
29324363d3b2SJason M. Bills                         messages::serviceTemporarilyUnavailable(asyncResp->res,
29334363d3b2SJason M. Bills                                                                 "60");
29344363d3b2SJason M. Bills                     }
29351da66f75SEd Tanous                     else
29361da66f75SEd Tanous                     {
2937f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
29381da66f75SEd Tanous                     }
29391da66f75SEd Tanous                     return;
29401da66f75SEd Tanous                 }
29410fda0f12SGeorge Liu                 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
29427e860f15SJohn Edward Broadbent                     [](boost::system::error_code err,
29437e860f15SJohn Edward Broadbent                        sdbusplus::message::message&,
294466afe4faSJames Feist                        const std::shared_ptr<task::TaskData>& taskData) {
294566afe4faSJames Feist                         if (!err)
294666afe4faSJames Feist                         {
2947e5d5006bSJames Feist                             taskData->messages.emplace_back(
2948e5d5006bSJames Feist                                 messages::taskCompletedOK(
2949e5d5006bSJames Feist                                     std::to_string(taskData->index)));
2950831d6b09SJames Feist                             taskData->state = "Completed";
295166afe4faSJames Feist                         }
295232898ceaSJames Feist                         return task::completed;
295366afe4faSJames Feist                     },
29547e860f15SJohn Edward Broadbent                     "type='signal',interface='org.freedesktop.DBus."
29557e860f15SJohn Edward Broadbent                     "Properties',"
29560fda0f12SGeorge Liu                     "member='PropertiesChanged',arg0namespace='com.intel.crashdump'");
295746229577SJames Feist                 task->startTimer(std::chrono::minutes(5));
295846229577SJames Feist                 task->populateResp(asyncResp->res);
295998be3e39SEd Tanous                 task->payload.emplace(std::move(payload));
29601da66f75SEd Tanous             };
29618e6c099aSJason M. Bills 
29628e6c099aSJason M. Bills             if (oemDiagnosticDataType == "OnDemand")
29638e6c099aSJason M. Bills             {
29641da66f75SEd Tanous                 crow::connections::systemBus->async_method_call(
29658e6c099aSJason M. Bills                     std::move(collectCrashdumpCallback), crashdumpObject,
29668e6c099aSJason M. Bills                     crashdumpPath, crashdumpOnDemandInterface,
29678e6c099aSJason M. Bills                     "GenerateOnDemandLog");
29681da66f75SEd Tanous             }
29698e6c099aSJason M. Bills             else if (oemDiagnosticDataType == "Telemetry")
29706eda7685SKenny L. Ku             {
29718e6c099aSJason M. Bills                 crow::connections::systemBus->async_method_call(
29728e6c099aSJason M. Bills                     std::move(collectCrashdumpCallback), crashdumpObject,
29738e6c099aSJason M. Bills                     crashdumpPath, crashdumpTelemetryInterface,
29748e6c099aSJason M. Bills                     "GenerateTelemetryLog");
29756eda7685SKenny L. Ku             }
29766eda7685SKenny L. Ku             else
29776eda7685SKenny L. Ku             {
29788e6c099aSJason M. Bills                 BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: "
29798e6c099aSJason M. Bills                                  << oemDiagnosticDataType;
29808e6c099aSJason M. Bills                 messages::actionParameterValueFormatError(
29817e860f15SJohn Edward Broadbent                     asyncResp->res, oemDiagnosticDataType,
29827e860f15SJohn Edward Broadbent                     "OEMDiagnosticDataType", "CollectDiagnosticData");
29836eda7685SKenny L. Ku                 return;
29846eda7685SKenny L. Ku             }
29857e860f15SJohn Edward Broadbent         });
29866eda7685SKenny L. Ku }
29876eda7685SKenny L. Ku 
2988cb92c03bSAndrew Geissler /**
2989cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
2990cb92c03bSAndrew Geissler  */
29917e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app)
2992cb92c03bSAndrew Geissler {
2993cb92c03bSAndrew Geissler     /**
2994cb92c03bSAndrew Geissler      * Function handles POST method request.
2995cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
2996cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
2997cb92c03bSAndrew Geissler      */
29987e860f15SJohn Edward Broadbent 
29990fda0f12SGeorge Liu     BMCWEB_ROUTE(
30000fda0f12SGeorge Liu         app,
30010fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog/")
3002ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
30037e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
30047e860f15SJohn Edward Broadbent             [](const crow::Request&,
30057e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
3006cb92c03bSAndrew Geissler                 BMCWEB_LOG_DEBUG << "Do delete all entries.";
3007cb92c03bSAndrew Geissler 
3008cb92c03bSAndrew Geissler                 // Process response from Logging service.
30097e860f15SJohn Edward Broadbent                 auto respHandler = [asyncResp](
30107e860f15SJohn Edward Broadbent                                        const boost::system::error_code ec) {
30117e860f15SJohn Edward Broadbent                     BMCWEB_LOG_DEBUG
30127e860f15SJohn Edward Broadbent                         << "doClearLog resp_handler callback: Done";
3013cb92c03bSAndrew Geissler                     if (ec)
3014cb92c03bSAndrew Geissler                     {
3015cb92c03bSAndrew Geissler                         // TODO Handle for specific error code
30167e860f15SJohn Edward Broadbent                         BMCWEB_LOG_ERROR << "doClearLog resp_handler got error "
30177e860f15SJohn Edward Broadbent                                          << ec;
3018cb92c03bSAndrew Geissler                         asyncResp->res.result(
3019cb92c03bSAndrew Geissler                             boost::beast::http::status::internal_server_error);
3020cb92c03bSAndrew Geissler                         return;
3021cb92c03bSAndrew Geissler                     }
3022cb92c03bSAndrew Geissler 
30237e860f15SJohn Edward Broadbent                     asyncResp->res.result(
30247e860f15SJohn Edward Broadbent                         boost::beast::http::status::no_content);
3025cb92c03bSAndrew Geissler                 };
3026cb92c03bSAndrew Geissler 
3027cb92c03bSAndrew Geissler                 // Make call to Logging service to request Clear Log
3028cb92c03bSAndrew Geissler                 crow::connections::systemBus->async_method_call(
30292c70f800SEd Tanous                     respHandler, "xyz.openbmc_project.Logging",
3030cb92c03bSAndrew Geissler                     "/xyz/openbmc_project/logging",
3031cb92c03bSAndrew Geissler                     "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
30327e860f15SJohn Edward Broadbent             });
3033cb92c03bSAndrew Geissler }
3034a3316fc6SZhikuiRen 
3035a3316fc6SZhikuiRen /****************************************************
3036a3316fc6SZhikuiRen  * Redfish PostCode interfaces
3037a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
3038a3316fc6SZhikuiRen  ******************************************************/
30397e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app)
3040a3316fc6SZhikuiRen {
30417e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
3042ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
30430fda0f12SGeorge Liu         .methods(
30440fda0f12SGeorge Liu             boost::beast::http::verb::
30450fda0f12SGeorge Liu                 get)([](const crow::Request&,
30467e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
3047a3316fc6SZhikuiRen             asyncResp->res.jsonValue = {
30487e860f15SJohn Edward Broadbent                 {"@odata.id",
30497e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/PostCodes"},
3050a3316fc6SZhikuiRen                 {"@odata.type", "#LogService.v1_1_0.LogService"},
3051a3316fc6SZhikuiRen                 {"Name", "POST Code Log Service"},
3052a3316fc6SZhikuiRen                 {"Description", "POST Code Log Service"},
3053a3316fc6SZhikuiRen                 {"Id", "BIOS POST Code Log"},
3054a3316fc6SZhikuiRen                 {"OverWritePolicy", "WrapsWhenFull"},
3055a3316fc6SZhikuiRen                 {"Entries",
30560fda0f12SGeorge Liu                  {{"@odata.id",
30570fda0f12SGeorge Liu                    "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
30587c8c4058STejas Patil 
30597c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
30607c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
30610fda0f12SGeorge Liu             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
30627c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
30637c8c4058STejas Patil                 redfishDateTimeOffset.second;
30647c8c4058STejas Patil 
3065a3316fc6SZhikuiRen             asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
30667e860f15SJohn Edward Broadbent                 {"target",
30670fda0f12SGeorge Liu                  "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}};
30687e860f15SJohn Edward Broadbent         });
3069a3316fc6SZhikuiRen }
3070a3316fc6SZhikuiRen 
30717e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app)
3072a3316fc6SZhikuiRen {
30730fda0f12SGeorge Liu     BMCWEB_ROUTE(
30740fda0f12SGeorge Liu         app,
30750fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog/")
3076ed398213SEd Tanous         // The following privilege is incorrect;  It should be ConfigureManager
3077ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
3078432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
30797e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
30807e860f15SJohn Edward Broadbent             [](const crow::Request&,
30817e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
3082a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
3083a3316fc6SZhikuiRen 
3084a3316fc6SZhikuiRen                 // Make call to post-code service to request clear all
3085a3316fc6SZhikuiRen                 crow::connections::systemBus->async_method_call(
3086a3316fc6SZhikuiRen                     [asyncResp](const boost::system::error_code ec) {
3087a3316fc6SZhikuiRen                         if (ec)
3088a3316fc6SZhikuiRen                         {
3089a3316fc6SZhikuiRen                             // TODO Handle for specific error code
3090a3316fc6SZhikuiRen                             BMCWEB_LOG_ERROR
30917e860f15SJohn Edward Broadbent                                 << "doClearPostCodes resp_handler got error "
30927e860f15SJohn Edward Broadbent                                 << ec;
30937e860f15SJohn Edward Broadbent                             asyncResp->res.result(boost::beast::http::status::
30947e860f15SJohn Edward Broadbent                                                       internal_server_error);
3095a3316fc6SZhikuiRen                             messages::internalError(asyncResp->res);
3096a3316fc6SZhikuiRen                             return;
3097a3316fc6SZhikuiRen                         }
3098a3316fc6SZhikuiRen                     },
309915124765SJonathan Doman                     "xyz.openbmc_project.State.Boot.PostCode0",
310015124765SJonathan Doman                     "/xyz/openbmc_project/State/Boot/PostCode0",
3101a3316fc6SZhikuiRen                     "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
31027e860f15SJohn Edward Broadbent             });
3103a3316fc6SZhikuiRen }
3104a3316fc6SZhikuiRen 
3105a3316fc6SZhikuiRen static void fillPostCodeEntry(
31068d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& aResp,
31076c9a279eSManojkiran Eda     const boost::container::flat_map<
31086c9a279eSManojkiran Eda         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
3109a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
3110a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
3111a3316fc6SZhikuiRen {
3112a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
3113a3316fc6SZhikuiRen     const message_registries::Message* message =
31144a0bf539SManojkiran Eda         message_registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
3115a3316fc6SZhikuiRen 
3116a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
3117a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
3118a3316fc6SZhikuiRen 
3119a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
31206c9a279eSManojkiran Eda     for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
31216c9a279eSManojkiran Eda              code : postcode)
3122a3316fc6SZhikuiRen     {
3123a3316fc6SZhikuiRen         currentCodeIndex++;
3124a3316fc6SZhikuiRen         std::string postcodeEntryID =
3125a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
3126a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
3127a3316fc6SZhikuiRen 
3128a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
3129a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
3130a3316fc6SZhikuiRen 
3131a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
3132a3316fc6SZhikuiRen         { // already incremented
3133a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
3134a3316fc6SZhikuiRen         }
3135a3316fc6SZhikuiRen         else
3136a3316fc6SZhikuiRen         {
3137a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
3138a3316fc6SZhikuiRen         }
3139a3316fc6SZhikuiRen 
3140a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
3141a3316fc6SZhikuiRen         // not fall between top and skip
3142a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
3143a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
3144a3316fc6SZhikuiRen         {
3145a3316fc6SZhikuiRen             continue;
3146a3316fc6SZhikuiRen         }
3147a3316fc6SZhikuiRen 
31484e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
3149a3316fc6SZhikuiRen         // currentIndex
3150a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3151a3316fc6SZhikuiRen         {
3152a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
3153a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
3154a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
3155a3316fc6SZhikuiRen             continue;
3156a3316fc6SZhikuiRen         }
3157a3316fc6SZhikuiRen 
3158a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
3159a3316fc6SZhikuiRen         // index
3160a3316fc6SZhikuiRen 
3161a3316fc6SZhikuiRen         // Get the Created time from the timestamp
3162a3316fc6SZhikuiRen         std::string entryTimeStr;
31631d8782e7SNan Zhou         entryTimeStr =
31641d8782e7SNan Zhou             crow::utility::getDateTimeUint(usecSinceEpoch / 1000 / 1000);
3165a3316fc6SZhikuiRen 
3166a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3167a3316fc6SZhikuiRen         std::ostringstream hexCode;
3168a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
31696c9a279eSManojkiran Eda                 << std::get<0>(code.second);
3170a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
3171a3316fc6SZhikuiRen         // Set Fixed -Point Notation
3172a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
3173a3316fc6SZhikuiRen         // Set precision to 4 digits
3174a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
3175a3316fc6SZhikuiRen         // Add double to stream
3176a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
3177a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
3178a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
3179a3316fc6SZhikuiRen 
3180a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
3181a3316fc6SZhikuiRen         std::string msg;
3182a3316fc6SZhikuiRen         if (message != nullptr)
3183a3316fc6SZhikuiRen         {
3184a3316fc6SZhikuiRen             msg = message->message;
3185a3316fc6SZhikuiRen 
3186a3316fc6SZhikuiRen             // fill in this post code value
3187a3316fc6SZhikuiRen             int i = 0;
3188a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
3189a3316fc6SZhikuiRen             {
3190a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
3191a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
3192a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
3193a3316fc6SZhikuiRen                 {
3194a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
3195a3316fc6SZhikuiRen                 }
3196a3316fc6SZhikuiRen             }
3197a3316fc6SZhikuiRen         }
3198a3316fc6SZhikuiRen 
3199d4342a92STim Lee         // Get Severity template from message registry
3200d4342a92STim Lee         std::string severity;
3201d4342a92STim Lee         if (message != nullptr)
3202d4342a92STim Lee         {
3203d4342a92STim Lee             severity = message->severity;
3204d4342a92STim Lee         }
3205d4342a92STim Lee 
3206a3316fc6SZhikuiRen         // add to AsyncResp
3207a3316fc6SZhikuiRen         logEntryArray.push_back({});
3208a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
32090fda0f12SGeorge Liu         bmcLogEntry = {
32100fda0f12SGeorge Liu             {"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
32110fda0f12SGeorge Liu             {"@odata.id",
32120fda0f12SGeorge Liu              "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
3213a3316fc6SZhikuiRen                  postcodeEntryID},
3214a3316fc6SZhikuiRen             {"Name", "POST Code Log Entry"},
3215a3316fc6SZhikuiRen             {"Id", postcodeEntryID},
3216a3316fc6SZhikuiRen             {"Message", std::move(msg)},
32174a0bf539SManojkiran Eda             {"MessageId", "OpenBMC.0.2.BIOSPOSTCode"},
3218a3316fc6SZhikuiRen             {"MessageArgs", std::move(messageArgs)},
3219a3316fc6SZhikuiRen             {"EntryType", "Event"},
3220a3316fc6SZhikuiRen             {"Severity", std::move(severity)},
32219c620e21SAsmitha Karunanithi             {"Created", entryTimeStr}};
3222647b3cdcSGeorge Liu         if (!std::get<std::vector<uint8_t>>(code.second).empty())
3223647b3cdcSGeorge Liu         {
3224647b3cdcSGeorge Liu             bmcLogEntry["AdditionalDataURI"] =
3225647b3cdcSGeorge Liu                 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
3226647b3cdcSGeorge Liu                 postcodeEntryID + "/attachment";
3227647b3cdcSGeorge Liu         }
3228a3316fc6SZhikuiRen     }
3229a3316fc6SZhikuiRen }
3230a3316fc6SZhikuiRen 
32318d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3232a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
3233a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
3234a3316fc6SZhikuiRen {
3235a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
32366c9a279eSManojkiran Eda         [aResp, bootIndex,
32376c9a279eSManojkiran Eda          codeIndex](const boost::system::error_code ec,
32386c9a279eSManojkiran Eda                     const boost::container::flat_map<
32396c9a279eSManojkiran Eda                         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
32406c9a279eSManojkiran Eda                         postcode) {
3241a3316fc6SZhikuiRen             if (ec)
3242a3316fc6SZhikuiRen             {
3243a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3244a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3245a3316fc6SZhikuiRen                 return;
3246a3316fc6SZhikuiRen             }
3247a3316fc6SZhikuiRen 
3248a3316fc6SZhikuiRen             // skip the empty postcode boots
3249a3316fc6SZhikuiRen             if (postcode.empty())
3250a3316fc6SZhikuiRen             {
3251a3316fc6SZhikuiRen                 return;
3252a3316fc6SZhikuiRen             }
3253a3316fc6SZhikuiRen 
3254a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
3255a3316fc6SZhikuiRen 
3256a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
3257a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
3258a3316fc6SZhikuiRen         },
325915124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
326015124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3261a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3262a3316fc6SZhikuiRen         bootIndex);
3263a3316fc6SZhikuiRen }
3264a3316fc6SZhikuiRen 
32658d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3266a3316fc6SZhikuiRen                                const uint16_t bootIndex,
3267a3316fc6SZhikuiRen                                const uint16_t bootCount,
3268a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
3269a3316fc6SZhikuiRen                                const uint64_t top)
3270a3316fc6SZhikuiRen {
3271a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3272a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
3273a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
32746c9a279eSManojkiran Eda               const boost::container::flat_map<
32756c9a279eSManojkiran Eda                   uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
32766c9a279eSManojkiran Eda                   postcode) {
3277a3316fc6SZhikuiRen             if (ec)
3278a3316fc6SZhikuiRen             {
3279a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3280a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3281a3316fc6SZhikuiRen                 return;
3282a3316fc6SZhikuiRen             }
3283a3316fc6SZhikuiRen 
3284a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
3285a3316fc6SZhikuiRen             if (!postcode.empty())
3286a3316fc6SZhikuiRen             {
3287a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
3288a3316fc6SZhikuiRen 
3289a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
3290a3316fc6SZhikuiRen                 {
3291a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
3292a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
3293a3316fc6SZhikuiRen                     uint64_t thisBootTop =
3294a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
3295a3316fc6SZhikuiRen 
3296a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3297a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
3298a3316fc6SZhikuiRen                 }
3299a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
3300a3316fc6SZhikuiRen             }
3301a3316fc6SZhikuiRen 
3302a3316fc6SZhikuiRen             // continue to previous bootIndex
3303a3316fc6SZhikuiRen             if (bootIndex < bootCount)
3304a3316fc6SZhikuiRen             {
3305a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3306a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
3307a3316fc6SZhikuiRen             }
3308a3316fc6SZhikuiRen             else
3309a3316fc6SZhikuiRen             {
3310a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
33110fda0f12SGeorge Liu                     "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" +
3312a3316fc6SZhikuiRen                     std::to_string(skip + top);
3313a3316fc6SZhikuiRen             }
3314a3316fc6SZhikuiRen         },
331515124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
331615124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3317a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3318a3316fc6SZhikuiRen         bootIndex);
3319a3316fc6SZhikuiRen }
3320a3316fc6SZhikuiRen 
33218d1b46d7Szhanghch05 static void
33228d1b46d7Szhanghch05     getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3323a3316fc6SZhikuiRen                          const uint64_t skip, const uint64_t top)
3324a3316fc6SZhikuiRen {
3325a3316fc6SZhikuiRen     uint64_t entryCount = 0;
33261e1e598dSJonathan Doman     sdbusplus::asio::getProperty<uint16_t>(
33271e1e598dSJonathan Doman         *crow::connections::systemBus,
33281e1e598dSJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
33291e1e598dSJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
33301e1e598dSJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount",
33311e1e598dSJonathan Doman         [aResp, entryCount, skip, top](const boost::system::error_code ec,
33321e1e598dSJonathan Doman                                        const uint16_t bootCount) {
3333a3316fc6SZhikuiRen             if (ec)
3334a3316fc6SZhikuiRen             {
3335a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3336a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3337a3316fc6SZhikuiRen                 return;
3338a3316fc6SZhikuiRen             }
33391e1e598dSJonathan Doman             getPostCodeForBoot(aResp, 1, bootCount, entryCount, skip, top);
33401e1e598dSJonathan Doman         });
3341a3316fc6SZhikuiRen }
3342a3316fc6SZhikuiRen 
33437e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app)
3344a3316fc6SZhikuiRen {
33457e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
33467e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3347ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
33487e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
33497e860f15SJohn Edward Broadbent             [](const crow::Request& req,
33507e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
3351a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.type"] =
3352a3316fc6SZhikuiRen                     "#LogEntryCollection.LogEntryCollection";
3353a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.id"] =
3354a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3355a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3356a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Description"] =
3357a3316fc6SZhikuiRen                     "Collection of POST Code Log Entries";
3358a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3359a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3360a3316fc6SZhikuiRen 
3361a3316fc6SZhikuiRen                 uint64_t skip = 0;
3362a3316fc6SZhikuiRen                 uint64_t top = maxEntriesPerPage; // Show max entries by default
33638d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
3364a3316fc6SZhikuiRen                 {
3365a3316fc6SZhikuiRen                     return;
3366a3316fc6SZhikuiRen                 }
33678d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
3368a3316fc6SZhikuiRen                 {
3369a3316fc6SZhikuiRen                     return;
3370a3316fc6SZhikuiRen                 }
3371a3316fc6SZhikuiRen                 getCurrentBootNumber(asyncResp, skip, top);
33727e860f15SJohn Edward Broadbent             });
3373a3316fc6SZhikuiRen }
3374a3316fc6SZhikuiRen 
3375647b3cdcSGeorge Liu /**
3376647b3cdcSGeorge Liu  * @brief Parse post code ID and get the current value and index value
3377647b3cdcSGeorge Liu  *        eg: postCodeID=B1-2, currentValue=1, index=2
3378647b3cdcSGeorge Liu  *
3379647b3cdcSGeorge Liu  * @param[in]  postCodeID     Post Code ID
3380647b3cdcSGeorge Liu  * @param[out] currentValue   Current value
3381647b3cdcSGeorge Liu  * @param[out] index          Index value
3382647b3cdcSGeorge Liu  *
3383647b3cdcSGeorge Liu  * @return bool true if the parsing is successful, false the parsing fails
3384647b3cdcSGeorge Liu  */
3385647b3cdcSGeorge Liu inline static bool parsePostCode(const std::string& postCodeID,
3386647b3cdcSGeorge Liu                                  uint64_t& currentValue, uint16_t& index)
3387647b3cdcSGeorge Liu {
3388647b3cdcSGeorge Liu     std::vector<std::string> split;
3389647b3cdcSGeorge Liu     boost::algorithm::split(split, postCodeID, boost::is_any_of("-"));
3390647b3cdcSGeorge Liu     if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B')
3391647b3cdcSGeorge Liu     {
3392647b3cdcSGeorge Liu         return false;
3393647b3cdcSGeorge Liu     }
3394647b3cdcSGeorge Liu 
3395*ca45aa3cSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
3396647b3cdcSGeorge Liu     const char* start = split[0].data() + 1;
3397*ca45aa3cSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
3398647b3cdcSGeorge Liu     const char* end = split[0].data() + split[0].size();
3399647b3cdcSGeorge Liu     auto [ptrIndex, ecIndex] = std::from_chars(start, end, index);
3400647b3cdcSGeorge Liu 
3401647b3cdcSGeorge Liu     if (ptrIndex != end || ecIndex != std::errc())
3402647b3cdcSGeorge Liu     {
3403647b3cdcSGeorge Liu         return false;
3404647b3cdcSGeorge Liu     }
3405647b3cdcSGeorge Liu 
3406647b3cdcSGeorge Liu     start = split[1].data();
3407*ca45aa3cSEd Tanous 
3408*ca45aa3cSEd Tanous     // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
3409647b3cdcSGeorge Liu     end = split[1].data() + split[1].size();
3410647b3cdcSGeorge Liu     auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue);
3411647b3cdcSGeorge Liu     if (ptrValue != end || ecValue != std::errc())
3412647b3cdcSGeorge Liu     {
3413647b3cdcSGeorge Liu         return false;
3414647b3cdcSGeorge Liu     }
3415647b3cdcSGeorge Liu 
3416647b3cdcSGeorge Liu     return true;
3417647b3cdcSGeorge Liu }
3418647b3cdcSGeorge Liu 
3419647b3cdcSGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app)
3420647b3cdcSGeorge Liu {
34210fda0f12SGeorge Liu     BMCWEB_ROUTE(
34220fda0f12SGeorge Liu         app,
34230fda0f12SGeorge Liu         "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/attachment/")
3424647b3cdcSGeorge Liu         .privileges(redfish::privileges::getLogEntry)
3425647b3cdcSGeorge Liu         .methods(boost::beast::http::verb::get)(
3426647b3cdcSGeorge Liu             [](const crow::Request& req,
3427647b3cdcSGeorge Liu                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3428647b3cdcSGeorge Liu                const std::string& postCodeID) {
3429647b3cdcSGeorge Liu                 if (!http_helpers::isOctetAccepted(
3430647b3cdcSGeorge Liu                         req.getHeaderValue("Accept")))
3431647b3cdcSGeorge Liu                 {
3432647b3cdcSGeorge Liu                     asyncResp->res.result(
3433647b3cdcSGeorge Liu                         boost::beast::http::status::bad_request);
3434647b3cdcSGeorge Liu                     return;
3435647b3cdcSGeorge Liu                 }
3436647b3cdcSGeorge Liu 
3437647b3cdcSGeorge Liu                 uint64_t currentValue = 0;
3438647b3cdcSGeorge Liu                 uint16_t index = 0;
3439647b3cdcSGeorge Liu                 if (!parsePostCode(postCodeID, currentValue, index))
3440647b3cdcSGeorge Liu                 {
3441647b3cdcSGeorge Liu                     messages::resourceNotFound(asyncResp->res, "LogEntry",
3442647b3cdcSGeorge Liu                                                postCodeID);
3443647b3cdcSGeorge Liu                     return;
3444647b3cdcSGeorge Liu                 }
3445647b3cdcSGeorge Liu 
3446647b3cdcSGeorge Liu                 crow::connections::systemBus->async_method_call(
3447647b3cdcSGeorge Liu                     [asyncResp, postCodeID, currentValue](
3448647b3cdcSGeorge Liu                         const boost::system::error_code ec,
3449647b3cdcSGeorge Liu                         const std::vector<std::tuple<
3450647b3cdcSGeorge Liu                             uint64_t, std::vector<uint8_t>>>& postcodes) {
3451647b3cdcSGeorge Liu                         if (ec.value() == EBADR)
3452647b3cdcSGeorge Liu                         {
3453647b3cdcSGeorge Liu                             messages::resourceNotFound(asyncResp->res,
3454647b3cdcSGeorge Liu                                                        "LogEntry", postCodeID);
3455647b3cdcSGeorge Liu                             return;
3456647b3cdcSGeorge Liu                         }
3457647b3cdcSGeorge Liu                         if (ec)
3458647b3cdcSGeorge Liu                         {
3459647b3cdcSGeorge Liu                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3460647b3cdcSGeorge Liu                             messages::internalError(asyncResp->res);
3461647b3cdcSGeorge Liu                             return;
3462647b3cdcSGeorge Liu                         }
3463647b3cdcSGeorge Liu 
3464647b3cdcSGeorge Liu                         size_t value = static_cast<size_t>(currentValue) - 1;
3465647b3cdcSGeorge Liu                         if (value == std::string::npos ||
3466647b3cdcSGeorge Liu                             postcodes.size() < currentValue)
3467647b3cdcSGeorge Liu                         {
3468647b3cdcSGeorge Liu                             BMCWEB_LOG_ERROR << "Wrong currentValue value";
3469647b3cdcSGeorge Liu                             messages::resourceNotFound(asyncResp->res,
3470647b3cdcSGeorge Liu                                                        "LogEntry", postCodeID);
3471647b3cdcSGeorge Liu                             return;
3472647b3cdcSGeorge Liu                         }
3473647b3cdcSGeorge Liu 
347446ff87baSEd Tanous                         auto& [tID, c] = postcodes[value];
347546ff87baSEd Tanous                         if (c.empty())
3476647b3cdcSGeorge Liu                         {
3477647b3cdcSGeorge Liu                             BMCWEB_LOG_INFO << "No found post code data";
3478647b3cdcSGeorge Liu                             messages::resourceNotFound(asyncResp->res,
3479647b3cdcSGeorge Liu                                                        "LogEntry", postCodeID);
3480647b3cdcSGeorge Liu                             return;
3481647b3cdcSGeorge Liu                         }
348246ff87baSEd Tanous                         // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
348346ff87baSEd Tanous                         const char* d = reinterpret_cast<const char*>(c.data());
348446ff87baSEd Tanous                         std::string_view strData(d, c.size());
3485647b3cdcSGeorge Liu 
3486647b3cdcSGeorge Liu                         asyncResp->res.addHeader("Content-Type",
3487647b3cdcSGeorge Liu                                                  "application/octet-stream");
3488647b3cdcSGeorge Liu                         asyncResp->res.addHeader("Content-Transfer-Encoding",
3489647b3cdcSGeorge Liu                                                  "Base64");
3490647b3cdcSGeorge Liu                         asyncResp->res.body() =
3491647b3cdcSGeorge Liu                             crow::utility::base64encode(strData);
3492647b3cdcSGeorge Liu                     },
3493647b3cdcSGeorge Liu                     "xyz.openbmc_project.State.Boot.PostCode0",
3494647b3cdcSGeorge Liu                     "/xyz/openbmc_project/State/Boot/PostCode0",
3495647b3cdcSGeorge Liu                     "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes",
3496647b3cdcSGeorge Liu                     index);
3497647b3cdcSGeorge Liu             });
3498647b3cdcSGeorge Liu }
3499647b3cdcSGeorge Liu 
35007e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app)
3501a3316fc6SZhikuiRen {
35027e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
35037e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/")
3504ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
35057e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
35067e860f15SJohn Edward Broadbent             [](const crow::Request&,
35077e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
35087e860f15SJohn Edward Broadbent                const std::string& targetID) {
3509647b3cdcSGeorge Liu                 uint16_t bootIndex = 0;
3510647b3cdcSGeorge Liu                 uint64_t codeIndex = 0;
3511647b3cdcSGeorge Liu                 if (!parsePostCode(targetID, codeIndex, bootIndex))
3512a3316fc6SZhikuiRen                 {
3513a3316fc6SZhikuiRen                     // Requested ID was not found
3514a3316fc6SZhikuiRen                     messages::resourceMissingAtURI(asyncResp->res, targetID);
3515a3316fc6SZhikuiRen                     return;
3516a3316fc6SZhikuiRen                 }
3517a3316fc6SZhikuiRen                 if (bootIndex == 0 || codeIndex == 0)
3518a3316fc6SZhikuiRen                 {
3519a3316fc6SZhikuiRen                     BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
35207e860f15SJohn Edward Broadbent                                      << targetID;
3521a3316fc6SZhikuiRen                 }
3522a3316fc6SZhikuiRen 
35237e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["@odata.type"] =
35247e860f15SJohn Edward Broadbent                     "#LogEntry.v1_4_0.LogEntry";
3525a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.id"] =
35260fda0f12SGeorge Liu                     "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3527a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3528a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Description"] =
3529a3316fc6SZhikuiRen                     "Collection of POST Code Log Entries";
3530a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3531a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3532a3316fc6SZhikuiRen 
3533a3316fc6SZhikuiRen                 getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
35347e860f15SJohn Edward Broadbent             });
3535a3316fc6SZhikuiRen }
3536a3316fc6SZhikuiRen 
35371da66f75SEd Tanous } // namespace redfish
3538