xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision 7c8c4058e265f784679b9144ff33b89f50f1bf59)
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 
18af61db10SGeorge Liu #include "http_utility.hpp"
194851d45dSJason M. Bills #include "registries.hpp"
204851d45dSJason M. Bills #include "registries/base_message_registry.hpp"
214851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp"
2246229577SJames Feist #include "task.hpp"
231da66f75SEd Tanous 
24e1f26343SJason M. Bills #include <systemd/sd-journal.h>
25400fd1fbSAdriana Kobylak #include <unistd.h>
26e1f26343SJason M. Bills 
277e860f15SJohn Edward Broadbent #include <app.hpp>
28400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp>
294851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp>
304851d45dSJason M. Bills #include <boost/beast/core/span.hpp>
31400fd1fbSAdriana Kobylak #include <boost/beast/http.hpp>
321da66f75SEd Tanous #include <boost/container/flat_map.hpp>
331ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp>
34cb92c03bSAndrew Geissler #include <error_messages.hpp>
351214b7e7SGunnar Mills 
36af61db10SGeorge Liu #include <charconv>
374418c7f0SJames Feist #include <filesystem>
3875710de2SXiaochao Ma #include <optional>
39cd225da8SJason M. Bills #include <string_view>
40abf2add6SEd Tanous #include <variant>
411da66f75SEd Tanous 
421da66f75SEd Tanous namespace redfish
431da66f75SEd Tanous {
441da66f75SEd Tanous 
455b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump";
465b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump";
475b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump";
485b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
495b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
505b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
51424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
526eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface =
536eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
541da66f75SEd Tanous 
554851d45dSJason M. Bills namespace message_registries
564851d45dSJason M. Bills {
574851d45dSJason M. Bills static const Message* getMessageFromRegistry(
584851d45dSJason M. Bills     const std::string& messageKey,
594851d45dSJason M. Bills     const boost::beast::span<const MessageEntry> registry)
604851d45dSJason M. Bills {
614851d45dSJason M. Bills     boost::beast::span<const MessageEntry>::const_iterator messageIt =
624851d45dSJason M. Bills         std::find_if(registry.cbegin(), registry.cend(),
634851d45dSJason M. Bills                      [&messageKey](const MessageEntry& messageEntry) {
644851d45dSJason M. Bills                          return !std::strcmp(messageEntry.first,
654851d45dSJason M. Bills                                              messageKey.c_str());
664851d45dSJason M. Bills                      });
674851d45dSJason M. Bills     if (messageIt != registry.cend())
684851d45dSJason M. Bills     {
694851d45dSJason M. Bills         return &messageIt->second;
704851d45dSJason M. Bills     }
714851d45dSJason M. Bills 
724851d45dSJason M. Bills     return nullptr;
734851d45dSJason M. Bills }
744851d45dSJason M. Bills 
754851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
764851d45dSJason M. Bills {
774851d45dSJason M. Bills     // Redfish MessageIds are in the form
784851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
794851d45dSJason M. Bills     // the right Message
804851d45dSJason M. Bills     std::vector<std::string> fields;
814851d45dSJason M. Bills     fields.reserve(4);
824851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
834851d45dSJason M. Bills     std::string& registryName = fields[0];
844851d45dSJason M. Bills     std::string& messageKey = fields[3];
854851d45dSJason M. Bills 
864851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
874851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
884851d45dSJason M. Bills     {
894851d45dSJason M. Bills         return getMessageFromRegistry(
904851d45dSJason M. Bills             messageKey, boost::beast::span<const MessageEntry>(base::registry));
914851d45dSJason M. Bills     }
924851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
934851d45dSJason M. Bills     {
944851d45dSJason M. Bills         return getMessageFromRegistry(
954851d45dSJason M. Bills             messageKey,
964851d45dSJason M. Bills             boost::beast::span<const MessageEntry>(openbmc::registry));
974851d45dSJason M. Bills     }
984851d45dSJason M. Bills     return nullptr;
994851d45dSJason M. Bills }
1004851d45dSJason M. Bills } // namespace message_registries
1014851d45dSJason M. Bills 
102f6150403SJames Feist namespace fs = std::filesystem;
1031da66f75SEd Tanous 
104cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map<
10519bd78d9SPatrick Williams     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
106cb92c03bSAndrew Geissler                               int32_t, uint32_t, int64_t, uint64_t, double>>;
107cb92c03bSAndrew Geissler 
108cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map<
109cb92c03bSAndrew Geissler     sdbusplus::message::object_path,
110cb92c03bSAndrew Geissler     boost::container::flat_map<std::string, GetManagedPropertyType>>;
111cb92c03bSAndrew Geissler 
112cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
113cb92c03bSAndrew Geissler {
114d4d25793SEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
115d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
116d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
117d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
118cb92c03bSAndrew Geissler     {
119cb92c03bSAndrew Geissler         return "Critical";
120cb92c03bSAndrew Geissler     }
1213174e4dfSEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
122d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
123d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
124cb92c03bSAndrew Geissler     {
125cb92c03bSAndrew Geissler         return "OK";
126cb92c03bSAndrew Geissler     }
1273174e4dfSEd Tanous     if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
128cb92c03bSAndrew Geissler     {
129cb92c03bSAndrew Geissler         return "Warning";
130cb92c03bSAndrew Geissler     }
131cb92c03bSAndrew Geissler     return "";
132cb92c03bSAndrew Geissler }
133cb92c03bSAndrew Geissler 
1347e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
13539e77504SEd Tanous                                      const std::string_view& field,
13639e77504SEd Tanous                                      std::string_view& contents)
13716428a1aSJason M. Bills {
13816428a1aSJason M. Bills     const char* data = nullptr;
13916428a1aSJason M. Bills     size_t length = 0;
14016428a1aSJason M. Bills     int ret = 0;
14116428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
142271584abSEd Tanous     ret = sd_journal_get_data(journal, field.data(),
143271584abSEd Tanous                               reinterpret_cast<const void**>(&data), &length);
14416428a1aSJason M. Bills     if (ret < 0)
14516428a1aSJason M. Bills     {
14616428a1aSJason M. Bills         return ret;
14716428a1aSJason M. Bills     }
14839e77504SEd Tanous     contents = std::string_view(data, length);
14916428a1aSJason M. Bills     // Only use the content after the "=" character.
15081ce609eSEd Tanous     contents.remove_prefix(std::min(contents.find('=') + 1, contents.size()));
15116428a1aSJason M. Bills     return ret;
15216428a1aSJason M. Bills }
15316428a1aSJason M. Bills 
1547e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
1557e860f15SJohn Edward Broadbent                                      const std::string_view& field,
1567e860f15SJohn Edward Broadbent                                      const int& base, long int& contents)
15716428a1aSJason M. Bills {
15816428a1aSJason M. Bills     int ret = 0;
15939e77504SEd Tanous     std::string_view metadata;
16016428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
16116428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
16216428a1aSJason M. Bills     if (ret < 0)
16316428a1aSJason M. Bills     {
16416428a1aSJason M. Bills         return ret;
16516428a1aSJason M. Bills     }
166b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
16716428a1aSJason M. Bills     return ret;
16816428a1aSJason M. Bills }
16916428a1aSJason M. Bills 
1707e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal,
1717e860f15SJohn Edward Broadbent                                      std::string& entryTimestamp)
172a3316fc6SZhikuiRen {
173a3316fc6SZhikuiRen     int ret = 0;
174a3316fc6SZhikuiRen     uint64_t timestamp = 0;
175a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
176a3316fc6SZhikuiRen     if (ret < 0)
177a3316fc6SZhikuiRen     {
178a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
179a3316fc6SZhikuiRen                          << strerror(-ret);
180a3316fc6SZhikuiRen         return false;
181a3316fc6SZhikuiRen     }
1829c620e21SAsmitha Karunanithi     entryTimestamp = crow::utility::getDateTime(
1839c620e21SAsmitha Karunanithi         static_cast<std::time_t>(timestamp / 1000 / 1000));
1849c620e21SAsmitha Karunanithi     return true;
185a3316fc6SZhikuiRen }
186a3316fc6SZhikuiRen 
1878d1b46d7Szhanghch05 static bool getSkipParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1888d1b46d7Szhanghch05                          const crow::Request& req, uint64_t& skip)
18916428a1aSJason M. Bills {
1905a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
1915a7e877eSJames Feist         req.urlParams.find("$skip");
1925a7e877eSJames Feist     if (it != req.urlParams.end())
19316428a1aSJason M. Bills     {
1945a7e877eSJames Feist         std::string skipParam = it->value();
19516428a1aSJason M. Bills         char* ptr = nullptr;
1965a7e877eSJames Feist         skip = std::strtoul(skipParam.c_str(), &ptr, 10);
1975a7e877eSJames Feist         if (skipParam.empty() || *ptr != '\0')
19816428a1aSJason M. Bills         {
19916428a1aSJason M. Bills 
2008d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
2018d1b46d7Szhanghch05                 asyncResp->res, std::string(skipParam), "$skip");
20216428a1aSJason M. Bills             return false;
20316428a1aSJason M. Bills         }
20416428a1aSJason M. Bills     }
20516428a1aSJason M. Bills     return true;
20616428a1aSJason M. Bills }
20716428a1aSJason M. Bills 
208271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
2098d1b46d7Szhanghch05 static bool getTopParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2108d1b46d7Szhanghch05                         const crow::Request& req, uint64_t& top)
21116428a1aSJason M. Bills {
2125a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
2135a7e877eSJames Feist         req.urlParams.find("$top");
2145a7e877eSJames Feist     if (it != req.urlParams.end())
21516428a1aSJason M. Bills     {
2165a7e877eSJames Feist         std::string topParam = it->value();
21716428a1aSJason M. Bills         char* ptr = nullptr;
2185a7e877eSJames Feist         top = std::strtoul(topParam.c_str(), &ptr, 10);
2195a7e877eSJames Feist         if (topParam.empty() || *ptr != '\0')
22016428a1aSJason M. Bills         {
2218d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
2228d1b46d7Szhanghch05                 asyncResp->res, std::string(topParam), "$top");
22316428a1aSJason M. Bills             return false;
22416428a1aSJason M. Bills         }
225271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
22616428a1aSJason M. Bills         {
22716428a1aSJason M. Bills 
22816428a1aSJason M. Bills             messages::queryParameterOutOfRange(
2298d1b46d7Szhanghch05                 asyncResp->res, std::to_string(top), "$top",
23016428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
23116428a1aSJason M. Bills             return false;
23216428a1aSJason M. Bills         }
23316428a1aSJason M. Bills     }
23416428a1aSJason M. Bills     return true;
23516428a1aSJason M. Bills }
23616428a1aSJason M. Bills 
2377e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
238e85d6b16SJason M. Bills                                     const bool firstEntry = true)
23916428a1aSJason M. Bills {
24016428a1aSJason M. Bills     int ret = 0;
24116428a1aSJason M. Bills     static uint64_t prevTs = 0;
24216428a1aSJason M. Bills     static int index = 0;
243e85d6b16SJason M. Bills     if (firstEntry)
244e85d6b16SJason M. Bills     {
245e85d6b16SJason M. Bills         prevTs = 0;
246e85d6b16SJason M. Bills     }
247e85d6b16SJason M. Bills 
24816428a1aSJason M. Bills     // Get the entry timestamp
24916428a1aSJason M. Bills     uint64_t curTs = 0;
25016428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
25116428a1aSJason M. Bills     if (ret < 0)
25216428a1aSJason M. Bills     {
25316428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
25416428a1aSJason M. Bills                          << strerror(-ret);
25516428a1aSJason M. Bills         return false;
25616428a1aSJason M. Bills     }
25716428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
25816428a1aSJason M. Bills     if (curTs == prevTs)
25916428a1aSJason M. Bills     {
26016428a1aSJason M. Bills         index++;
26116428a1aSJason M. Bills     }
26216428a1aSJason M. Bills     else
26316428a1aSJason M. Bills     {
26416428a1aSJason M. Bills         // Otherwise, reset it
26516428a1aSJason M. Bills         index = 0;
26616428a1aSJason M. Bills     }
26716428a1aSJason M. Bills     // Save the timestamp
26816428a1aSJason M. Bills     prevTs = curTs;
26916428a1aSJason M. Bills 
27016428a1aSJason M. Bills     entryID = std::to_string(curTs);
27116428a1aSJason M. Bills     if (index > 0)
27216428a1aSJason M. Bills     {
27316428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
27416428a1aSJason M. Bills     }
27516428a1aSJason M. Bills     return true;
27616428a1aSJason M. Bills }
27716428a1aSJason M. Bills 
278e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
279e85d6b16SJason M. Bills                              const bool firstEntry = true)
28095820184SJason M. Bills {
281271584abSEd Tanous     static time_t prevTs = 0;
28295820184SJason M. Bills     static int index = 0;
283e85d6b16SJason M. Bills     if (firstEntry)
284e85d6b16SJason M. Bills     {
285e85d6b16SJason M. Bills         prevTs = 0;
286e85d6b16SJason M. Bills     }
287e85d6b16SJason M. Bills 
28895820184SJason M. Bills     // Get the entry timestamp
289271584abSEd Tanous     std::time_t curTs = 0;
29095820184SJason M. Bills     std::tm timeStruct = {};
29195820184SJason M. Bills     std::istringstream entryStream(logEntry);
29295820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
29395820184SJason M. Bills     {
29495820184SJason M. Bills         curTs = std::mktime(&timeStruct);
29595820184SJason M. Bills     }
29695820184SJason M. Bills     // If the timestamp isn't unique, increment the index
29795820184SJason M. Bills     if (curTs == prevTs)
29895820184SJason M. Bills     {
29995820184SJason M. Bills         index++;
30095820184SJason M. Bills     }
30195820184SJason M. Bills     else
30295820184SJason M. Bills     {
30395820184SJason M. Bills         // Otherwise, reset it
30495820184SJason M. Bills         index = 0;
30595820184SJason M. Bills     }
30695820184SJason M. Bills     // Save the timestamp
30795820184SJason M. Bills     prevTs = curTs;
30895820184SJason M. Bills 
30995820184SJason M. Bills     entryID = std::to_string(curTs);
31095820184SJason M. Bills     if (index > 0)
31195820184SJason M. Bills     {
31295820184SJason M. Bills         entryID += "_" + std::to_string(index);
31395820184SJason M. Bills     }
31495820184SJason M. Bills     return true;
31595820184SJason M. Bills }
31695820184SJason M. Bills 
3177e860f15SJohn Edward Broadbent inline static bool
3188d1b46d7Szhanghch05     getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3198d1b46d7Szhanghch05                        const std::string& entryID, uint64_t& timestamp,
3208d1b46d7Szhanghch05                        uint64_t& index)
32116428a1aSJason M. Bills {
32216428a1aSJason M. Bills     if (entryID.empty())
32316428a1aSJason M. Bills     {
32416428a1aSJason M. Bills         return false;
32516428a1aSJason M. Bills     }
32616428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
32739e77504SEd Tanous     std::string_view tsStr(entryID);
32816428a1aSJason M. Bills 
32981ce609eSEd Tanous     auto underscorePos = tsStr.find('_');
33016428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
33116428a1aSJason M. Bills     {
33216428a1aSJason M. Bills         // Timestamp has an index
33316428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
33439e77504SEd Tanous         std::string_view indexStr(entryID);
33516428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
33616428a1aSJason M. Bills         std::size_t pos;
33716428a1aSJason M. Bills         try
33816428a1aSJason M. Bills         {
33939e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
34016428a1aSJason M. Bills         }
341271584abSEd Tanous         catch (std::invalid_argument&)
34216428a1aSJason M. Bills         {
3438d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
34416428a1aSJason M. Bills             return false;
34516428a1aSJason M. Bills         }
346271584abSEd Tanous         catch (std::out_of_range&)
34716428a1aSJason M. Bills         {
3488d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
34916428a1aSJason M. Bills             return false;
35016428a1aSJason M. Bills         }
35116428a1aSJason M. Bills         if (pos != indexStr.size())
35216428a1aSJason M. Bills         {
3538d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
35416428a1aSJason M. Bills             return false;
35516428a1aSJason M. Bills         }
35616428a1aSJason M. Bills     }
35716428a1aSJason M. Bills     // Timestamp has no index
35816428a1aSJason M. Bills     std::size_t pos;
35916428a1aSJason M. Bills     try
36016428a1aSJason M. Bills     {
36139e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
36216428a1aSJason M. Bills     }
363271584abSEd Tanous     catch (std::invalid_argument&)
36416428a1aSJason M. Bills     {
3658d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
36616428a1aSJason M. Bills         return false;
36716428a1aSJason M. Bills     }
368271584abSEd Tanous     catch (std::out_of_range&)
36916428a1aSJason M. Bills     {
3708d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
37116428a1aSJason M. Bills         return false;
37216428a1aSJason M. Bills     }
37316428a1aSJason M. Bills     if (pos != tsStr.size())
37416428a1aSJason M. Bills     {
3758d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
37616428a1aSJason M. Bills         return false;
37716428a1aSJason M. Bills     }
37816428a1aSJason M. Bills     return true;
37916428a1aSJason M. Bills }
38016428a1aSJason M. Bills 
38195820184SJason M. Bills static bool
38295820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
38395820184SJason M. Bills {
38495820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
38595820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
38695820184SJason M. Bills 
38795820184SJason M. Bills     // Loop through the directory looking for redfish log files
38895820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
38995820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
39095820184SJason M. Bills     {
39195820184SJason M. Bills         // If we find a redfish log file, save the path
39295820184SJason M. Bills         std::string filename = dirEnt.path().filename();
39395820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
39495820184SJason M. Bills         {
39595820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
39695820184SJason M. Bills         }
39795820184SJason M. Bills     }
39895820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
39995820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
40095820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
40195820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
40295820184SJason M. Bills 
40395820184SJason M. Bills     return !redfishLogFiles.empty();
40495820184SJason M. Bills }
40595820184SJason M. Bills 
4068d1b46d7Szhanghch05 inline void
4078d1b46d7Szhanghch05     getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
4085cb1dd27SAsmitha Karunanithi                            const std::string& dumpType)
4095cb1dd27SAsmitha Karunanithi {
4105cb1dd27SAsmitha Karunanithi     std::string dumpPath;
4115cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
4125cb1dd27SAsmitha Karunanithi     {
4135cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
4145cb1dd27SAsmitha Karunanithi     }
4155cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
4165cb1dd27SAsmitha Karunanithi     {
4175cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
4185cb1dd27SAsmitha Karunanithi     }
4195cb1dd27SAsmitha Karunanithi     else
4205cb1dd27SAsmitha Karunanithi     {
4215cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
4225cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
4235cb1dd27SAsmitha Karunanithi         return;
4245cb1dd27SAsmitha Karunanithi     }
4255cb1dd27SAsmitha Karunanithi 
4265cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
4275cb1dd27SAsmitha Karunanithi         [asyncResp, dumpPath, dumpType](const boost::system::error_code ec,
4285cb1dd27SAsmitha Karunanithi                                         GetManagedObjectsType& resp) {
4295cb1dd27SAsmitha Karunanithi             if (ec)
4305cb1dd27SAsmitha Karunanithi             {
4315cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4325cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
4335cb1dd27SAsmitha Karunanithi                 return;
4345cb1dd27SAsmitha Karunanithi             }
4355cb1dd27SAsmitha Karunanithi 
4365cb1dd27SAsmitha Karunanithi             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4375cb1dd27SAsmitha Karunanithi             entriesArray = nlohmann::json::array();
438b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
439b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
440b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
441b47452b2SAsmitha Karunanithi                 "/entry/";
4425cb1dd27SAsmitha Karunanithi 
4435cb1dd27SAsmitha Karunanithi             for (auto& object : resp)
4445cb1dd27SAsmitha Karunanithi             {
445b47452b2SAsmitha Karunanithi                 if (object.first.str.find(dumpEntryPath) == std::string::npos)
4465cb1dd27SAsmitha Karunanithi                 {
4475cb1dd27SAsmitha Karunanithi                     continue;
4485cb1dd27SAsmitha Karunanithi                 }
4495cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
4505cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
4515cb1dd27SAsmitha Karunanithi                 entriesArray.push_back({});
4525cb1dd27SAsmitha Karunanithi                 nlohmann::json& thisEntry = entriesArray.back();
4532dfd18efSEd Tanous 
4542dfd18efSEd Tanous                 std::string entryID = object.first.filename();
4552dfd18efSEd Tanous                 if (entryID.empty())
4565cb1dd27SAsmitha Karunanithi                 {
4575cb1dd27SAsmitha Karunanithi                     continue;
4585cb1dd27SAsmitha Karunanithi                 }
4595cb1dd27SAsmitha Karunanithi 
4605cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4615cb1dd27SAsmitha Karunanithi                 {
4625cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
4635cb1dd27SAsmitha Karunanithi                     {
4645cb1dd27SAsmitha Karunanithi 
4655cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4665cb1dd27SAsmitha Karunanithi                         {
4675cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
4685cb1dd27SAsmitha Karunanithi                             {
4695cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
4705cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4715cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
4725cb1dd27SAsmitha Karunanithi                                 {
4735cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4745cb1dd27SAsmitha Karunanithi                                     break;
4755cb1dd27SAsmitha Karunanithi                                 }
4765cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
4775cb1dd27SAsmitha Karunanithi                                 break;
4785cb1dd27SAsmitha Karunanithi                             }
4795cb1dd27SAsmitha Karunanithi                         }
4805cb1dd27SAsmitha Karunanithi                     }
4815cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
4825cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
4835cb1dd27SAsmitha Karunanithi                     {
4845cb1dd27SAsmitha Karunanithi 
4855cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4865cb1dd27SAsmitha Karunanithi                         {
4875cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
4885cb1dd27SAsmitha Karunanithi                             {
4895cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
4905cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4915cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
4925cb1dd27SAsmitha Karunanithi                                 {
4935cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4945cb1dd27SAsmitha Karunanithi                                     break;
4955cb1dd27SAsmitha Karunanithi                                 }
4965cb1dd27SAsmitha Karunanithi                                 timestamp =
4975cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
4985cb1dd27SAsmitha Karunanithi                                 break;
4995cb1dd27SAsmitha Karunanithi                             }
5005cb1dd27SAsmitha Karunanithi                         }
5015cb1dd27SAsmitha Karunanithi                     }
5025cb1dd27SAsmitha Karunanithi                 }
5035cb1dd27SAsmitha Karunanithi 
5040ef217f4SGeorge Liu                 thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
5055cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.id"] = dumpPath + entryID;
5065cb1dd27SAsmitha Karunanithi                 thisEntry["Id"] = entryID;
5075cb1dd27SAsmitha Karunanithi                 thisEntry["EntryType"] = "Event";
5085cb1dd27SAsmitha Karunanithi                 thisEntry["Created"] = crow::utility::getDateTime(timestamp);
5095cb1dd27SAsmitha Karunanithi                 thisEntry["Name"] = dumpType + " Dump Entry";
5105cb1dd27SAsmitha Karunanithi 
511d337bb72SAsmitha Karunanithi                 thisEntry["AdditionalDataSizeBytes"] = size;
5125cb1dd27SAsmitha Karunanithi 
5135cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
5145cb1dd27SAsmitha Karunanithi                 {
515d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "Manager";
516d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
517de8d94a3SAbhishek Patel                         "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" +
518de8d94a3SAbhishek Patel                         entryID + "/attachment";
5195cb1dd27SAsmitha Karunanithi                 }
5205cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
5215cb1dd27SAsmitha Karunanithi                 {
522d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "OEM";
523d337bb72SAsmitha Karunanithi                     thisEntry["OEMDiagnosticDataType"] = "System";
524d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
525de8d94a3SAbhishek Patel                         "/redfish/v1/Systems/system/LogServices/Dump/Entries/" +
526de8d94a3SAbhishek Patel                         entryID + "/attachment";
5275cb1dd27SAsmitha Karunanithi                 }
5285cb1dd27SAsmitha Karunanithi             }
5295cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Members@odata.count"] =
5305cb1dd27SAsmitha Karunanithi                 entriesArray.size();
5315cb1dd27SAsmitha Karunanithi         },
5325cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5335cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5345cb1dd27SAsmitha Karunanithi }
5355cb1dd27SAsmitha Karunanithi 
5368d1b46d7Szhanghch05 inline void
5378d1b46d7Szhanghch05     getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5388d1b46d7Szhanghch05                      const std::string& entryID, const std::string& dumpType)
5395cb1dd27SAsmitha Karunanithi {
5405cb1dd27SAsmitha Karunanithi     std::string dumpPath;
5415cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
5425cb1dd27SAsmitha Karunanithi     {
5435cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
5445cb1dd27SAsmitha Karunanithi     }
5455cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
5465cb1dd27SAsmitha Karunanithi     {
5475cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
5485cb1dd27SAsmitha Karunanithi     }
5495cb1dd27SAsmitha Karunanithi     else
5505cb1dd27SAsmitha Karunanithi     {
5515cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
5525cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5535cb1dd27SAsmitha Karunanithi         return;
5545cb1dd27SAsmitha Karunanithi     }
5555cb1dd27SAsmitha Karunanithi 
5565cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
5575cb1dd27SAsmitha Karunanithi         [asyncResp, entryID, dumpPath, dumpType](
5585cb1dd27SAsmitha Karunanithi             const boost::system::error_code ec, GetManagedObjectsType& 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;
5805cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
5815cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
5825cb1dd27SAsmitha Karunanithi 
5835cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
5845cb1dd27SAsmitha Karunanithi                 {
5855cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
5865cb1dd27SAsmitha Karunanithi                     {
5875cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
5885cb1dd27SAsmitha Karunanithi                         {
5895cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
5905cb1dd27SAsmitha Karunanithi                             {
5915cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
5925cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
5935cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
5945cb1dd27SAsmitha Karunanithi                                 {
5955cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
5965cb1dd27SAsmitha Karunanithi                                     break;
5975cb1dd27SAsmitha Karunanithi                                 }
5985cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
5995cb1dd27SAsmitha Karunanithi                                 break;
6005cb1dd27SAsmitha Karunanithi                             }
6015cb1dd27SAsmitha Karunanithi                         }
6025cb1dd27SAsmitha Karunanithi                     }
6035cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
6045cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
6055cb1dd27SAsmitha Karunanithi                     {
6065cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6075cb1dd27SAsmitha Karunanithi                         {
6085cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
6095cb1dd27SAsmitha Karunanithi                             {
6105cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
6115cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6125cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
6135cb1dd27SAsmitha Karunanithi                                 {
6145cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6155cb1dd27SAsmitha Karunanithi                                     break;
6165cb1dd27SAsmitha Karunanithi                                 }
6175cb1dd27SAsmitha Karunanithi                                 timestamp =
6185cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
6195cb1dd27SAsmitha Karunanithi                                 break;
6205cb1dd27SAsmitha Karunanithi                             }
6215cb1dd27SAsmitha Karunanithi                         }
6225cb1dd27SAsmitha Karunanithi                     }
6235cb1dd27SAsmitha Karunanithi                 }
6245cb1dd27SAsmitha Karunanithi 
6255cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
6260ef217f4SGeorge Liu                     "#LogEntry.v1_8_0.LogEntry";
6275cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
6285cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = entryID;
6295cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["EntryType"] = "Event";
6305cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Created"] =
6315cb1dd27SAsmitha Karunanithi                     crow::utility::getDateTime(timestamp);
6325cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
6335cb1dd27SAsmitha Karunanithi 
634d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
6355cb1dd27SAsmitha Karunanithi 
6365cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
6375cb1dd27SAsmitha Karunanithi                 {
638d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
639d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
640de8d94a3SAbhishek Patel                         "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" +
641de8d94a3SAbhishek Patel                         entryID + "/attachment";
6425cb1dd27SAsmitha Karunanithi                 }
6435cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
6445cb1dd27SAsmitha Karunanithi                 {
645d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
646d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["OEMDiagnosticDataType"] =
6475cb1dd27SAsmitha Karunanithi                         "System";
648d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
649de8d94a3SAbhishek Patel                         "/redfish/v1/Systems/system/LogServices/Dump/Entries/" +
650de8d94a3SAbhishek Patel                         entryID + "/attachment";
6515cb1dd27SAsmitha Karunanithi                 }
6525cb1dd27SAsmitha Karunanithi             }
653b47452b2SAsmitha Karunanithi             if (foundDumpEntry == false)
654b47452b2SAsmitha Karunanithi             {
655b47452b2SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Can't find Dump Entry";
656b47452b2SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
657b47452b2SAsmitha Karunanithi                 return;
658b47452b2SAsmitha Karunanithi             }
6595cb1dd27SAsmitha Karunanithi         },
6605cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
6615cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
6625cb1dd27SAsmitha Karunanithi }
6635cb1dd27SAsmitha Karunanithi 
6648d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6659878256fSStanley Chu                             const std::string& entryID,
666b47452b2SAsmitha Karunanithi                             const std::string& dumpType)
6675cb1dd27SAsmitha Karunanithi {
6683de8d8baSGeorge Liu     auto respHandler = [asyncResp,
6693de8d8baSGeorge Liu                         entryID](const boost::system::error_code ec) {
6705cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
6715cb1dd27SAsmitha Karunanithi         if (ec)
6725cb1dd27SAsmitha Karunanithi         {
6733de8d8baSGeorge Liu             if (ec.value() == EBADR)
6743de8d8baSGeorge Liu             {
6753de8d8baSGeorge Liu                 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
6763de8d8baSGeorge Liu                 return;
6773de8d8baSGeorge Liu             }
6785cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
6795cb1dd27SAsmitha Karunanithi                              << ec;
6805cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
6815cb1dd27SAsmitha Karunanithi             return;
6825cb1dd27SAsmitha Karunanithi         }
6835cb1dd27SAsmitha Karunanithi     };
6845cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
6855cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
686b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
687b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
688b47452b2SAsmitha Karunanithi             entryID,
6895cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
6905cb1dd27SAsmitha Karunanithi }
6915cb1dd27SAsmitha Karunanithi 
6928d1b46d7Szhanghch05 inline void
6938d1b46d7Szhanghch05     createDumpTaskCallback(const crow::Request& req,
6948d1b46d7Szhanghch05                            const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6958d1b46d7Szhanghch05                            const uint32_t& dumpId, const std::string& dumpPath,
696a43be80fSAsmitha Karunanithi                            const std::string& dumpType)
697a43be80fSAsmitha Karunanithi {
698a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
6996145ed6fSAsmitha Karunanithi         [dumpId, dumpPath, dumpType](
700a43be80fSAsmitha Karunanithi             boost::system::error_code err, sdbusplus::message::message& m,
701a43be80fSAsmitha Karunanithi             const std::shared_ptr<task::TaskData>& taskData) {
702cb13a392SEd Tanous             if (err)
703cb13a392SEd Tanous             {
7046145ed6fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Error in creating a dump";
7056145ed6fSAsmitha Karunanithi                 taskData->state = "Cancelled";
7066145ed6fSAsmitha Karunanithi                 return task::completed;
707cb13a392SEd Tanous             }
708a43be80fSAsmitha Karunanithi             std::vector<std::pair<
709a43be80fSAsmitha Karunanithi                 std::string,
710a43be80fSAsmitha Karunanithi                 std::vector<std::pair<std::string, std::variant<std::string>>>>>
711a43be80fSAsmitha Karunanithi                 interfacesList;
712a43be80fSAsmitha Karunanithi 
713a43be80fSAsmitha Karunanithi             sdbusplus::message::object_path objPath;
714a43be80fSAsmitha Karunanithi 
715a43be80fSAsmitha Karunanithi             m.read(objPath, interfacesList);
716a43be80fSAsmitha Karunanithi 
717b47452b2SAsmitha Karunanithi             if (objPath.str ==
718b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
719b47452b2SAsmitha Karunanithi                     std::string(boost::algorithm::to_lower_copy(dumpType)) +
720b47452b2SAsmitha Karunanithi                     "/entry/" + std::to_string(dumpId))
721a43be80fSAsmitha Karunanithi             {
722a43be80fSAsmitha Karunanithi                 nlohmann::json retMessage = messages::success();
723a43be80fSAsmitha Karunanithi                 taskData->messages.emplace_back(retMessage);
724a43be80fSAsmitha Karunanithi 
725a43be80fSAsmitha Karunanithi                 std::string headerLoc =
726a43be80fSAsmitha Karunanithi                     "Location: " + dumpPath + std::to_string(dumpId);
727a43be80fSAsmitha Karunanithi                 taskData->payload->httpHeaders.emplace_back(
728a43be80fSAsmitha Karunanithi                     std::move(headerLoc));
729a43be80fSAsmitha Karunanithi 
730a43be80fSAsmitha Karunanithi                 taskData->state = "Completed";
731b47452b2SAsmitha Karunanithi                 return task::completed;
7326145ed6fSAsmitha Karunanithi             }
733a43be80fSAsmitha Karunanithi             return task::completed;
734a43be80fSAsmitha Karunanithi         },
735a43be80fSAsmitha Karunanithi         "type='signal',interface='org.freedesktop.DBus."
736a43be80fSAsmitha Karunanithi         "ObjectManager',"
737a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
738a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
739a43be80fSAsmitha Karunanithi 
740a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
741a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
742a43be80fSAsmitha Karunanithi     task->payload.emplace(req);
743a43be80fSAsmitha Karunanithi }
744a43be80fSAsmitha Karunanithi 
7458d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7468d1b46d7Szhanghch05                        const crow::Request& req, const std::string& dumpType)
747a43be80fSAsmitha Karunanithi {
748a43be80fSAsmitha Karunanithi 
749a43be80fSAsmitha Karunanithi     std::string dumpPath;
750a43be80fSAsmitha Karunanithi     if (dumpType == "BMC")
751a43be80fSAsmitha Karunanithi     {
752a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
753a43be80fSAsmitha Karunanithi     }
754a43be80fSAsmitha Karunanithi     else if (dumpType == "System")
755a43be80fSAsmitha Karunanithi     {
756a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
757a43be80fSAsmitha Karunanithi     }
758a43be80fSAsmitha Karunanithi     else
759a43be80fSAsmitha Karunanithi     {
760a43be80fSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
761a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
762a43be80fSAsmitha Karunanithi         return;
763a43be80fSAsmitha Karunanithi     }
764a43be80fSAsmitha Karunanithi 
765a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
766a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
767a43be80fSAsmitha Karunanithi 
768a43be80fSAsmitha Karunanithi     if (!redfish::json_util::readJson(
769a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
770a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
771a43be80fSAsmitha Karunanithi     {
772a43be80fSAsmitha Karunanithi         return;
773a43be80fSAsmitha Karunanithi     }
774a43be80fSAsmitha Karunanithi 
775a43be80fSAsmitha Karunanithi     if (dumpType == "System")
776a43be80fSAsmitha Karunanithi     {
777a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
778a43be80fSAsmitha Karunanithi         {
779a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
780a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType'/"
781a43be80fSAsmitha Karunanithi                                 "'OEMDiagnosticDataType' value not found!";
782a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
783a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
784a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
785a43be80fSAsmitha Karunanithi             return;
786a43be80fSAsmitha Karunanithi         }
7873174e4dfSEd Tanous         if ((*oemDiagnosticDataType != "System") ||
788a43be80fSAsmitha Karunanithi             (*diagnosticDataType != "OEM"))
789a43be80fSAsmitha Karunanithi         {
790a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
791a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
792a43be80fSAsmitha Karunanithi                                     "System Dump creation parameters");
793a43be80fSAsmitha Karunanithi             return;
794a43be80fSAsmitha Karunanithi         }
795a43be80fSAsmitha Karunanithi     }
796a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
797a43be80fSAsmitha Karunanithi     {
798a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
799a43be80fSAsmitha Karunanithi         {
800a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
801a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType' not found!";
802a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
803a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
804a43be80fSAsmitha Karunanithi             return;
805a43be80fSAsmitha Karunanithi         }
8063174e4dfSEd Tanous         if (*diagnosticDataType != "Manager")
807a43be80fSAsmitha Karunanithi         {
808a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
809a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
810a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
811a43be80fSAsmitha Karunanithi                                     "BMC Dump creation parameters");
812a43be80fSAsmitha Karunanithi             return;
813a43be80fSAsmitha Karunanithi         }
814a43be80fSAsmitha Karunanithi     }
815a43be80fSAsmitha Karunanithi 
816a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
817a43be80fSAsmitha Karunanithi         [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec,
818a43be80fSAsmitha Karunanithi                                              const uint32_t& dumpId) {
819a43be80fSAsmitha Karunanithi             if (ec)
820a43be80fSAsmitha Karunanithi             {
821a43be80fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
822a43be80fSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
823a43be80fSAsmitha Karunanithi                 return;
824a43be80fSAsmitha Karunanithi             }
825a43be80fSAsmitha Karunanithi             BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
826a43be80fSAsmitha Karunanithi 
827a43be80fSAsmitha Karunanithi             createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType);
828a43be80fSAsmitha Karunanithi         },
829b47452b2SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager",
830b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
831b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)),
832a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
833a43be80fSAsmitha Karunanithi }
834a43be80fSAsmitha Karunanithi 
8358d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
8368d1b46d7Szhanghch05                       const std::string& dumpType)
83780319af1SAsmitha Karunanithi {
838b47452b2SAsmitha Karunanithi     std::string dumpTypeLowerCopy =
839b47452b2SAsmitha Karunanithi         std::string(boost::algorithm::to_lower_copy(dumpType));
8408d1b46d7Szhanghch05 
84180319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
842b47452b2SAsmitha Karunanithi         [asyncResp, dumpType](const boost::system::error_code ec,
84380319af1SAsmitha Karunanithi                               const std::vector<std::string>& subTreePaths) {
84480319af1SAsmitha Karunanithi             if (ec)
84580319af1SAsmitha Karunanithi             {
84680319af1SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
84780319af1SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
84880319af1SAsmitha Karunanithi                 return;
84980319af1SAsmitha Karunanithi             }
85080319af1SAsmitha Karunanithi 
85180319af1SAsmitha Karunanithi             for (const std::string& path : subTreePaths)
85280319af1SAsmitha Karunanithi             {
8532dfd18efSEd Tanous                 sdbusplus::message::object_path objPath(path);
8542dfd18efSEd Tanous                 std::string logID = objPath.filename();
8552dfd18efSEd Tanous                 if (logID.empty())
85680319af1SAsmitha Karunanithi                 {
8572dfd18efSEd Tanous                     continue;
85880319af1SAsmitha Karunanithi                 }
8592dfd18efSEd Tanous                 deleteDumpEntry(asyncResp, logID, dumpType);
86080319af1SAsmitha Karunanithi             }
86180319af1SAsmitha Karunanithi         },
86280319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
86380319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
86480319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
865b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0,
866b47452b2SAsmitha Karunanithi         std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." +
867b47452b2SAsmitha Karunanithi                                    dumpType});
86880319af1SAsmitha Karunanithi }
86980319af1SAsmitha Karunanithi 
8707e860f15SJohn Edward Broadbent inline static void parseCrashdumpParameters(
871043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>>& params,
872043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
873043a0536SJohnathan Mantey {
874043a0536SJohnathan Mantey     for (auto property : params)
875043a0536SJohnathan Mantey     {
876043a0536SJohnathan Mantey         if (property.first == "Timestamp")
877043a0536SJohnathan Mantey         {
878043a0536SJohnathan Mantey             const std::string* value =
8798d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
880043a0536SJohnathan Mantey             if (value != nullptr)
881043a0536SJohnathan Mantey             {
882043a0536SJohnathan Mantey                 timestamp = *value;
883043a0536SJohnathan Mantey             }
884043a0536SJohnathan Mantey         }
885043a0536SJohnathan Mantey         else if (property.first == "Filename")
886043a0536SJohnathan Mantey         {
887043a0536SJohnathan Mantey             const std::string* value =
8888d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
889043a0536SJohnathan Mantey             if (value != nullptr)
890043a0536SJohnathan Mantey             {
891043a0536SJohnathan Mantey                 filename = *value;
892043a0536SJohnathan Mantey             }
893043a0536SJohnathan Mantey         }
894043a0536SJohnathan Mantey         else if (property.first == "Log")
895043a0536SJohnathan Mantey         {
896043a0536SJohnathan Mantey             const std::string* value =
8978d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
898043a0536SJohnathan Mantey             if (value != nullptr)
899043a0536SJohnathan Mantey             {
900043a0536SJohnathan Mantey                 logfile = *value;
901043a0536SJohnathan Mantey             }
902043a0536SJohnathan Mantey         }
903043a0536SJohnathan Mantey     }
904043a0536SJohnathan Mantey }
905043a0536SJohnathan Mantey 
906a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
9077e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app)
9081da66f75SEd Tanous {
909c4bf6374SJason M. Bills     /**
910c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
911c4bf6374SJason M. Bills      */
9127e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/")
913432a890cSEd Tanous         .privileges({{"Login"}})
9147e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
9157e860f15SJohn Edward Broadbent             [](const crow::Request&,
9167e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
9177e860f15SJohn Edward Broadbent 
918c4bf6374SJason M. Bills             {
9197e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
9207e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
921c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
922c4bf6374SJason M. Bills                     "#LogServiceCollection.LogServiceCollection";
923c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
924029573d4SEd Tanous                     "/redfish/v1/Systems/system/LogServices";
9257e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
9267e860f15SJohn Edward Broadbent                     "System Log Services Collection";
927c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
928c4bf6374SJason M. Bills                     "Collection of LogServices for this Computer System";
9297e860f15SJohn Edward Broadbent                 nlohmann::json& logServiceArray =
9307e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
931c4bf6374SJason M. Bills                 logServiceArray = nlohmann::json::array();
932029573d4SEd Tanous                 logServiceArray.push_back(
9337e860f15SJohn Edward Broadbent                     {{"@odata.id",
9347e860f15SJohn Edward Broadbent                       "/redfish/v1/Systems/system/LogServices/EventLog"}});
9355cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
936c9bb6861Sraviteja-b                 logServiceArray.push_back(
9377e860f15SJohn Edward Broadbent                     {{"@odata.id",
9387e860f15SJohn Edward Broadbent                       "/redfish/v1/Systems/system/LogServices/Dump"}});
939c9bb6861Sraviteja-b #endif
940c9bb6861Sraviteja-b 
941d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
942d53dd41fSJason M. Bills                 logServiceArray.push_back(
943cb92c03bSAndrew Geissler                     {{"@odata.id",
944424c4176SJason M. Bills                       "/redfish/v1/Systems/system/LogServices/Crashdump"}});
945d53dd41fSJason M. Bills #endif
946c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
947c4bf6374SJason M. Bills                     logServiceArray.size();
948a3316fc6SZhikuiRen 
949a3316fc6SZhikuiRen                 crow::connections::systemBus->async_method_call(
950a3316fc6SZhikuiRen                     [asyncResp](const boost::system::error_code ec,
951a3316fc6SZhikuiRen                                 const std::vector<std::string>& subtreePath) {
952a3316fc6SZhikuiRen                         if (ec)
953a3316fc6SZhikuiRen                         {
954a3316fc6SZhikuiRen                             BMCWEB_LOG_ERROR << ec;
955a3316fc6SZhikuiRen                             return;
956a3316fc6SZhikuiRen                         }
957a3316fc6SZhikuiRen 
958a3316fc6SZhikuiRen                         for (auto& pathStr : subtreePath)
959a3316fc6SZhikuiRen                         {
960a3316fc6SZhikuiRen                             if (pathStr.find("PostCode") != std::string::npos)
961a3316fc6SZhikuiRen                             {
96223a21a1cSEd Tanous                                 nlohmann::json& logServiceArrayLocal =
963a3316fc6SZhikuiRen                                     asyncResp->res.jsonValue["Members"];
96423a21a1cSEd Tanous                                 logServiceArrayLocal.push_back(
965a3316fc6SZhikuiRen                                     {{"@odata.id", "/redfish/v1/Systems/system/"
966a3316fc6SZhikuiRen                                                    "LogServices/PostCodes"}});
9677e860f15SJohn Edward Broadbent                                 asyncResp->res
9687e860f15SJohn Edward Broadbent                                     .jsonValue["Members@odata.count"] =
96923a21a1cSEd Tanous                                     logServiceArrayLocal.size();
970a3316fc6SZhikuiRen                                 return;
971a3316fc6SZhikuiRen                             }
972a3316fc6SZhikuiRen                         }
973a3316fc6SZhikuiRen                     },
974a3316fc6SZhikuiRen                     "xyz.openbmc_project.ObjectMapper",
975a3316fc6SZhikuiRen                     "/xyz/openbmc_project/object_mapper",
9767e860f15SJohn Edward Broadbent                     "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/",
9777e860f15SJohn Edward Broadbent                     0, std::array<const char*, 1>{postCodeIface});
9787e860f15SJohn Edward Broadbent             });
979c4bf6374SJason M. Bills }
980c4bf6374SJason M. Bills 
9817e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app)
982c4bf6374SJason M. Bills {
9837e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
984432a890cSEd Tanous         .privileges({{"Login"}})
9857e860f15SJohn Edward Broadbent         .methods(
9867e860f15SJohn Edward Broadbent             boost::beast::http::verb::
9877e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
9887e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
989c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.id"] =
990029573d4SEd Tanous                 "/redfish/v1/Systems/system/LogServices/EventLog";
991c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
992c4bf6374SJason M. Bills                 "#LogService.v1_1_0.LogService";
993c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Event Log Service";
9947e860f15SJohn Edward Broadbent             asyncResp->res.jsonValue["Description"] =
9957e860f15SJohn Edward Broadbent                 "System Event Log Service";
996c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Id"] = "EventLog";
997c4bf6374SJason M. Bills             asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
998*7c8c4058STejas Patil 
999*7c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
1000*7c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
1001*7c8c4058STejas Patil 
1002*7c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
1003*7c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
1004*7c8c4058STejas Patil                 redfishDateTimeOffset.second;
1005*7c8c4058STejas Patil 
1006c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Entries"] = {
1007c4bf6374SJason M. Bills                 {"@odata.id",
1008029573d4SEd Tanous                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
1009e7d6c8b2SGunnar Mills             asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1010e7d6c8b2SGunnar Mills 
1011e7d6c8b2SGunnar Mills                 {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
1012e7d6c8b2SGunnar Mills                            "Actions/LogService.ClearLog"}};
10137e860f15SJohn Edward Broadbent         });
1014489640c6SJason M. Bills }
1015489640c6SJason M. Bills 
10167e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app)
1017489640c6SJason M. Bills {
10187e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1019489640c6SJason M. Bills                       "LogService.ClearLog/")
1020432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
10217e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
10227e860f15SJohn Edward Broadbent             [](const crow::Request&,
10237e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1024489640c6SJason M. Bills                 // Clear the EventLog by deleting the log files
1025489640c6SJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
1026489640c6SJason M. Bills                 if (getRedfishLogFiles(redfishLogFiles))
1027489640c6SJason M. Bills                 {
1028489640c6SJason M. Bills                     for (const std::filesystem::path& file : redfishLogFiles)
1029489640c6SJason M. Bills                     {
1030489640c6SJason M. Bills                         std::error_code ec;
1031489640c6SJason M. Bills                         std::filesystem::remove(file, ec);
1032489640c6SJason M. Bills                     }
1033489640c6SJason M. Bills                 }
1034489640c6SJason M. Bills 
1035489640c6SJason M. Bills                 // Reload rsyslog so it knows to start new log files
1036489640c6SJason M. Bills                 crow::connections::systemBus->async_method_call(
1037489640c6SJason M. Bills                     [asyncResp](const boost::system::error_code ec) {
1038489640c6SJason M. Bills                         if (ec)
1039489640c6SJason M. Bills                         {
10407e860f15SJohn Edward Broadbent                             BMCWEB_LOG_ERROR << "Failed to reload rsyslog: "
10417e860f15SJohn Edward Broadbent                                              << ec;
1042489640c6SJason M. Bills                             messages::internalError(asyncResp->res);
1043489640c6SJason M. Bills                             return;
1044489640c6SJason M. Bills                         }
1045489640c6SJason M. Bills 
1046489640c6SJason M. Bills                         messages::success(asyncResp->res);
1047489640c6SJason M. Bills                     },
1048489640c6SJason M. Bills                     "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
10497e860f15SJohn Edward Broadbent                     "org.freedesktop.systemd1.Manager", "ReloadUnit",
10507e860f15SJohn Edward Broadbent                     "rsyslog.service", "replace");
10517e860f15SJohn Edward Broadbent             });
1052c4bf6374SJason M. Bills }
1053c4bf6374SJason M. Bills 
105495820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
1055b5a76932SEd Tanous                                  const std::string& logEntry,
105695820184SJason M. Bills                                  nlohmann::json& logEntryJson)
1057c4bf6374SJason M. Bills {
105895820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1059cd225da8SJason M. Bills     // First get the Timestamp
1060f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1061cd225da8SJason M. Bills     if (space == std::string::npos)
106295820184SJason M. Bills     {
106395820184SJason M. Bills         return 1;
106495820184SJason M. Bills     }
1065cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1066cd225da8SJason M. Bills     // Then get the log contents
1067f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1068cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1069cd225da8SJason M. Bills     {
1070cd225da8SJason M. Bills         return 1;
1071cd225da8SJason M. Bills     }
1072cd225da8SJason M. Bills     std::string_view entry(logEntry);
1073cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1074cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1075cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1076cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1077cd225da8SJason M. Bills                  boost::token_compress_on);
1078cd225da8SJason M. Bills     // We need at least a MessageId to be valid
1079cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
1080cd225da8SJason M. Bills     {
1081cd225da8SJason M. Bills         return 1;
1082cd225da8SJason M. Bills     }
1083cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
108495820184SJason M. Bills 
10854851d45dSJason M. Bills     // Get the Message from the MessageRegistry
10864851d45dSJason M. Bills     const message_registries::Message* message =
10874851d45dSJason M. Bills         message_registries::getMessage(messageID);
1088c4bf6374SJason M. Bills 
10894851d45dSJason M. Bills     std::string msg;
10904851d45dSJason M. Bills     std::string severity;
10914851d45dSJason M. Bills     if (message != nullptr)
1092c4bf6374SJason M. Bills     {
10934851d45dSJason M. Bills         msg = message->message;
10944851d45dSJason M. Bills         severity = message->severity;
1095c4bf6374SJason M. Bills     }
1096c4bf6374SJason M. Bills 
109715a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
109815a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
109915a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
110015a86ff6SJason M. Bills     {
110115a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
110215a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
110315a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
110415a86ff6SJason M. Bills         if (!messageArgsStart.empty())
110515a86ff6SJason M. Bills         {
110615a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
110715a86ff6SJason M. Bills         }
110815a86ff6SJason M. Bills 
110923a21a1cSEd Tanous         messageArgs = {&messageArgsStart, messageArgsSize};
1110c4bf6374SJason M. Bills 
11114851d45dSJason M. Bills         // Fill the MessageArgs into the Message
111295820184SJason M. Bills         int i = 0;
111395820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11144851d45dSJason M. Bills         {
111595820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11164851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11174851d45dSJason M. Bills             if (argPos != std::string::npos)
11184851d45dSJason M. Bills             {
111995820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11204851d45dSJason M. Bills             }
11214851d45dSJason M. Bills         }
112215a86ff6SJason M. Bills     }
11234851d45dSJason M. Bills 
112495820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
112595820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
112695820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1127f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1128f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
112995820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1130c4bf6374SJason M. Bills     {
113195820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1132c4bf6374SJason M. Bills     }
1133c4bf6374SJason M. Bills 
1134c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
113595820184SJason M. Bills     logEntryJson = {
11360ef217f4SGeorge Liu         {"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
1137029573d4SEd Tanous         {"@odata.id",
1138897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
113995820184SJason M. Bills              logEntryID},
1140c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
114195820184SJason M. Bills         {"Id", logEntryID},
114295820184SJason M. Bills         {"Message", std::move(msg)},
114395820184SJason M. Bills         {"MessageId", std::move(messageID)},
1144f23b7296SEd Tanous         {"MessageArgs", messageArgs},
1145c4bf6374SJason M. Bills         {"EntryType", "Event"},
114695820184SJason M. Bills         {"Severity", std::move(severity)},
114795820184SJason M. Bills         {"Created", std::move(timestamp)}};
1148c4bf6374SJason M. Bills     return 0;
1149c4bf6374SJason M. Bills }
1150c4bf6374SJason M. Bills 
11517e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app)
1152c4bf6374SJason M. Bills {
11537e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
11547e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1155432a890cSEd Tanous         .privileges({{"Login"}})
11567e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
11577e860f15SJohn Edward Broadbent             [](const crow::Request& req,
11587e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1159271584abSEd Tanous                 uint64_t skip = 0;
1160271584abSEd Tanous                 uint64_t top = maxEntriesPerPage; // Show max entries by default
11618d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
1162c4bf6374SJason M. Bills                 {
1163c4bf6374SJason M. Bills                     return;
1164c4bf6374SJason M. Bills                 }
11658d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
1166c4bf6374SJason M. Bills                 {
1167c4bf6374SJason M. Bills                     return;
1168c4bf6374SJason M. Bills                 }
11697e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
11707e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
1171c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
1172c4bf6374SJason M. Bills                     "#LogEntryCollection.LogEntryCollection";
1173c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
1174029573d4SEd Tanous                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1175c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1176c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
1177c4bf6374SJason M. Bills                     "Collection of System Event Log Entries";
1178cb92c03bSAndrew Geissler 
11797e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
11807e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
1181c4bf6374SJason M. Bills                 logEntryArray = nlohmann::json::array();
11827e860f15SJohn Edward Broadbent                 // Go through the log files and create a unique ID for each
11837e860f15SJohn Edward Broadbent                 // entry
118495820184SJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
118595820184SJason M. Bills                 getRedfishLogFiles(redfishLogFiles);
1186b01bf299SEd Tanous                 uint64_t entryCount = 0;
1187cd225da8SJason M. Bills                 std::string logEntry;
118895820184SJason M. Bills 
11897e860f15SJohn Edward Broadbent                 // Oldest logs are in the last file, so start there and loop
11907e860f15SJohn Edward Broadbent                 // backwards
11917e860f15SJohn Edward Broadbent                 for (auto it = redfishLogFiles.rbegin();
11927e860f15SJohn Edward Broadbent                      it < redfishLogFiles.rend(); it++)
1193c4bf6374SJason M. Bills                 {
1194cd225da8SJason M. Bills                     std::ifstream logStream(*it);
119595820184SJason M. Bills                     if (!logStream.is_open())
1196c4bf6374SJason M. Bills                     {
1197c4bf6374SJason M. Bills                         continue;
1198c4bf6374SJason M. Bills                     }
1199c4bf6374SJason M. Bills 
1200e85d6b16SJason M. Bills                     // Reset the unique ID on the first entry
1201e85d6b16SJason M. Bills                     bool firstEntry = true;
120295820184SJason M. Bills                     while (std::getline(logStream, logEntry))
120395820184SJason M. Bills                     {
1204c4bf6374SJason M. Bills                         entryCount++;
12057e860f15SJohn Edward Broadbent                         // Handle paging using skip (number of entries to skip
12067e860f15SJohn Edward Broadbent                         // from the start) and top (number of entries to
12077e860f15SJohn Edward Broadbent                         // display)
1208c4bf6374SJason M. Bills                         if (entryCount <= skip || entryCount > skip + top)
1209c4bf6374SJason M. Bills                         {
1210c4bf6374SJason M. Bills                             continue;
1211c4bf6374SJason M. Bills                         }
1212c4bf6374SJason M. Bills 
1213c4bf6374SJason M. Bills                         std::string idStr;
1214e85d6b16SJason M. Bills                         if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1215c4bf6374SJason M. Bills                         {
1216c4bf6374SJason M. Bills                             continue;
1217c4bf6374SJason M. Bills                         }
1218c4bf6374SJason M. Bills 
1219e85d6b16SJason M. Bills                         if (firstEntry)
1220e85d6b16SJason M. Bills                         {
1221e85d6b16SJason M. Bills                             firstEntry = false;
1222e85d6b16SJason M. Bills                         }
1223e85d6b16SJason M. Bills 
1224c4bf6374SJason M. Bills                         logEntryArray.push_back({});
1225c4bf6374SJason M. Bills                         nlohmann::json& bmcLogEntry = logEntryArray.back();
12267e860f15SJohn Edward Broadbent                         if (fillEventLogEntryJson(idStr, logEntry,
12277e860f15SJohn Edward Broadbent                                                   bmcLogEntry) != 0)
1228c4bf6374SJason M. Bills                         {
1229c4bf6374SJason M. Bills                             messages::internalError(asyncResp->res);
1230c4bf6374SJason M. Bills                             return;
1231c4bf6374SJason M. Bills                         }
1232c4bf6374SJason M. Bills                     }
123395820184SJason M. Bills                 }
1234c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1235c4bf6374SJason M. Bills                 if (skip + top < entryCount)
1236c4bf6374SJason M. Bills                 {
1237c4bf6374SJason M. Bills                     asyncResp->res.jsonValue["Members@odata.nextLink"] =
123895820184SJason M. Bills                         "/redfish/v1/Systems/system/LogServices/EventLog/"
123995820184SJason M. Bills                         "Entries?$skip=" +
1240c4bf6374SJason M. Bills                         std::to_string(skip + top);
1241c4bf6374SJason M. Bills                 }
12427e860f15SJohn Edward Broadbent             });
1243897967deSJason M. Bills }
1244897967deSJason M. Bills 
12457e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app)
1246897967deSJason M. Bills {
12477e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
12487e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1249432a890cSEd Tanous         .privileges({{"Login"}})
12507e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
12517e860f15SJohn Edward Broadbent             [](const crow::Request&,
12527e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
12537e860f15SJohn Edward Broadbent                const std::string& param) {
12547e860f15SJohn Edward Broadbent                 const std::string& targetID = param;
12558d1b46d7Szhanghch05 
12567e860f15SJohn Edward Broadbent                 // Go through the log files and check the unique ID for each
12577e860f15SJohn Edward Broadbent                 // entry to find the target entry
1258897967deSJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
1259897967deSJason M. Bills                 getRedfishLogFiles(redfishLogFiles);
1260897967deSJason M. Bills                 std::string logEntry;
1261897967deSJason M. Bills 
12627e860f15SJohn Edward Broadbent                 // Oldest logs are in the last file, so start there and loop
12637e860f15SJohn Edward Broadbent                 // backwards
12647e860f15SJohn Edward Broadbent                 for (auto it = redfishLogFiles.rbegin();
12657e860f15SJohn Edward Broadbent                      it < redfishLogFiles.rend(); it++)
1266897967deSJason M. Bills                 {
1267897967deSJason M. Bills                     std::ifstream logStream(*it);
1268897967deSJason M. Bills                     if (!logStream.is_open())
1269897967deSJason M. Bills                     {
1270897967deSJason M. Bills                         continue;
1271897967deSJason M. Bills                     }
1272897967deSJason M. Bills 
1273897967deSJason M. Bills                     // Reset the unique ID on the first entry
1274897967deSJason M. Bills                     bool firstEntry = true;
1275897967deSJason M. Bills                     while (std::getline(logStream, logEntry))
1276897967deSJason M. Bills                     {
1277897967deSJason M. Bills                         std::string idStr;
1278897967deSJason M. Bills                         if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1279897967deSJason M. Bills                         {
1280897967deSJason M. Bills                             continue;
1281897967deSJason M. Bills                         }
1282897967deSJason M. Bills 
1283897967deSJason M. Bills                         if (firstEntry)
1284897967deSJason M. Bills                         {
1285897967deSJason M. Bills                             firstEntry = false;
1286897967deSJason M. Bills                         }
1287897967deSJason M. Bills 
1288897967deSJason M. Bills                         if (idStr == targetID)
1289897967deSJason M. Bills                         {
12907e860f15SJohn Edward Broadbent                             if (fillEventLogEntryJson(
12917e860f15SJohn Edward Broadbent                                     idStr, logEntry,
1292897967deSJason M. Bills                                     asyncResp->res.jsonValue) != 0)
1293897967deSJason M. Bills                             {
1294897967deSJason M. Bills                                 messages::internalError(asyncResp->res);
1295897967deSJason M. Bills                                 return;
1296897967deSJason M. Bills                             }
1297897967deSJason M. Bills                             return;
1298897967deSJason M. Bills                         }
1299897967deSJason M. Bills                     }
1300897967deSJason M. Bills                 }
1301897967deSJason M. Bills                 // Requested ID was not found
1302897967deSJason M. Bills                 messages::resourceMissingAtURI(asyncResp->res, targetID);
13037e860f15SJohn Edward Broadbent             });
130408a4e4b5SAnthony Wilson }
130508a4e4b5SAnthony Wilson 
13067e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app)
130708a4e4b5SAnthony Wilson {
13087e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
13097e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1310432a890cSEd Tanous         .privileges({{"Login"}})
13117e860f15SJohn Edward Broadbent         .methods(
13127e860f15SJohn Edward Broadbent             boost::beast::http::verb::
13137e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
13147e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
13157e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
13167e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
131708a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["@odata.type"] =
131808a4e4b5SAnthony Wilson                 "#LogEntryCollection.LogEntryCollection";
131908a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["@odata.id"] =
132008a4e4b5SAnthony Wilson                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
132108a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
132208a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["Description"] =
132308a4e4b5SAnthony Wilson                 "Collection of System Event Log Entries";
132408a4e4b5SAnthony Wilson 
1325cb92c03bSAndrew Geissler             // DBus implementation of EventLog/Entries
1326cb92c03bSAndrew Geissler             // Make call to Logging Service to find all log entry objects
1327cb92c03bSAndrew Geissler             crow::connections::systemBus->async_method_call(
1328cb92c03bSAndrew Geissler                 [asyncResp](const boost::system::error_code ec,
1329cb92c03bSAndrew Geissler                             GetManagedObjectsType& resp) {
1330cb92c03bSAndrew Geissler                     if (ec)
1331cb92c03bSAndrew Geissler                     {
1332cb92c03bSAndrew Geissler                         // TODO Handle for specific error code
1333cb92c03bSAndrew Geissler                         BMCWEB_LOG_ERROR
1334cb92c03bSAndrew Geissler                             << "getLogEntriesIfaceData resp_handler got error "
1335cb92c03bSAndrew Geissler                             << ec;
1336cb92c03bSAndrew Geissler                         messages::internalError(asyncResp->res);
1337cb92c03bSAndrew Geissler                         return;
1338cb92c03bSAndrew Geissler                     }
1339cb92c03bSAndrew Geissler                     nlohmann::json& entriesArray =
1340cb92c03bSAndrew Geissler                         asyncResp->res.jsonValue["Members"];
1341cb92c03bSAndrew Geissler                     entriesArray = nlohmann::json::array();
1342cb92c03bSAndrew Geissler                     for (auto& objectPath : resp)
1343cb92c03bSAndrew Geissler                     {
134466664f25SEd Tanous                         uint32_t* id = nullptr;
134566664f25SEd Tanous                         std::time_t timestamp{};
1346d139c236SGeorge Liu                         std::time_t updateTimestamp{};
134766664f25SEd Tanous                         std::string* severity = nullptr;
134866664f25SEd Tanous                         std::string* message = nullptr;
1349f86bb901SAdriana Kobylak                         std::string* filePath = nullptr;
135075710de2SXiaochao Ma                         bool resolved = false;
1351f86bb901SAdriana Kobylak                         for (auto& interfaceMap : objectPath.second)
1352f86bb901SAdriana Kobylak                         {
1353f86bb901SAdriana Kobylak                             if (interfaceMap.first ==
1354f86bb901SAdriana Kobylak                                 "xyz.openbmc_project.Logging.Entry")
1355f86bb901SAdriana Kobylak                             {
1356cb92c03bSAndrew Geissler                                 for (auto& propertyMap : interfaceMap.second)
1357cb92c03bSAndrew Geissler                                 {
1358cb92c03bSAndrew Geissler                                     if (propertyMap.first == "Id")
1359cb92c03bSAndrew Geissler                                     {
1360f86bb901SAdriana Kobylak                                         id = std::get_if<uint32_t>(
1361f86bb901SAdriana Kobylak                                             &propertyMap.second);
1362cb92c03bSAndrew Geissler                                     }
1363cb92c03bSAndrew Geissler                                     else if (propertyMap.first == "Timestamp")
1364cb92c03bSAndrew Geissler                                     {
1365cb92c03bSAndrew Geissler                                         const uint64_t* millisTimeStamp =
1366f86bb901SAdriana Kobylak                                             std::get_if<uint64_t>(
1367f86bb901SAdriana Kobylak                                                 &propertyMap.second);
1368ae34c8e8SAdriana Kobylak                                         if (millisTimeStamp != nullptr)
1369ebd45906SGeorge Liu                                         {
13707e860f15SJohn Edward Broadbent                                             timestamp =
13717e860f15SJohn Edward Broadbent                                                 crow::utility::getTimestamp(
13727e860f15SJohn Edward Broadbent                                                     *millisTimeStamp);
13737e860f15SJohn Edward Broadbent                                         }
13747e860f15SJohn Edward Broadbent                                     }
13757e860f15SJohn Edward Broadbent                                     else if (propertyMap.first ==
13767e860f15SJohn Edward Broadbent                                              "UpdateTimestamp")
13777e860f15SJohn Edward Broadbent                                     {
13787e860f15SJohn Edward Broadbent                                         const uint64_t* millisTimeStamp =
13797e860f15SJohn Edward Broadbent                                             std::get_if<uint64_t>(
13807e860f15SJohn Edward Broadbent                                                 &propertyMap.second);
13817e860f15SJohn Edward Broadbent                                         if (millisTimeStamp != nullptr)
13827e860f15SJohn Edward Broadbent                                         {
13837e860f15SJohn Edward Broadbent                                             updateTimestamp =
13847e860f15SJohn Edward Broadbent                                                 crow::utility::getTimestamp(
13857e860f15SJohn Edward Broadbent                                                     *millisTimeStamp);
13867e860f15SJohn Edward Broadbent                                         }
13877e860f15SJohn Edward Broadbent                                     }
13887e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Severity")
13897e860f15SJohn Edward Broadbent                                     {
13907e860f15SJohn Edward Broadbent                                         severity = std::get_if<std::string>(
13917e860f15SJohn Edward Broadbent                                             &propertyMap.second);
13927e860f15SJohn Edward Broadbent                                     }
13937e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Message")
13947e860f15SJohn Edward Broadbent                                     {
13957e860f15SJohn Edward Broadbent                                         message = std::get_if<std::string>(
13967e860f15SJohn Edward Broadbent                                             &propertyMap.second);
13977e860f15SJohn Edward Broadbent                                     }
13987e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Resolved")
13997e860f15SJohn Edward Broadbent                                     {
14007e860f15SJohn Edward Broadbent                                         bool* resolveptr = std::get_if<bool>(
14017e860f15SJohn Edward Broadbent                                             &propertyMap.second);
14027e860f15SJohn Edward Broadbent                                         if (resolveptr == nullptr)
14037e860f15SJohn Edward Broadbent                                         {
14047e860f15SJohn Edward Broadbent                                             messages::internalError(
14057e860f15SJohn Edward Broadbent                                                 asyncResp->res);
14067e860f15SJohn Edward Broadbent                                             return;
14077e860f15SJohn Edward Broadbent                                         }
14087e860f15SJohn Edward Broadbent                                         resolved = *resolveptr;
14097e860f15SJohn Edward Broadbent                                     }
14107e860f15SJohn Edward Broadbent                                 }
14117e860f15SJohn Edward Broadbent                                 if (id == nullptr || message == nullptr ||
14127e860f15SJohn Edward Broadbent                                     severity == nullptr)
14137e860f15SJohn Edward Broadbent                                 {
14147e860f15SJohn Edward Broadbent                                     messages::internalError(asyncResp->res);
14157e860f15SJohn Edward Broadbent                                     return;
14167e860f15SJohn Edward Broadbent                                 }
14177e860f15SJohn Edward Broadbent                             }
14187e860f15SJohn Edward Broadbent                             else if (interfaceMap.first ==
14197e860f15SJohn Edward Broadbent                                      "xyz.openbmc_project.Common.FilePath")
14207e860f15SJohn Edward Broadbent                             {
14217e860f15SJohn Edward Broadbent                                 for (auto& propertyMap : interfaceMap.second)
14227e860f15SJohn Edward Broadbent                                 {
14237e860f15SJohn Edward Broadbent                                     if (propertyMap.first == "Path")
14247e860f15SJohn Edward Broadbent                                     {
14257e860f15SJohn Edward Broadbent                                         filePath = std::get_if<std::string>(
14267e860f15SJohn Edward Broadbent                                             &propertyMap.second);
14277e860f15SJohn Edward Broadbent                                     }
14287e860f15SJohn Edward Broadbent                                 }
14297e860f15SJohn Edward Broadbent                             }
14307e860f15SJohn Edward Broadbent                         }
14317e860f15SJohn Edward Broadbent                         // Object path without the
14327e860f15SJohn Edward Broadbent                         // xyz.openbmc_project.Logging.Entry interface, ignore
14337e860f15SJohn Edward Broadbent                         // and continue.
14347e860f15SJohn Edward Broadbent                         if (id == nullptr || message == nullptr ||
14357e860f15SJohn Edward Broadbent                             severity == nullptr)
14367e860f15SJohn Edward Broadbent                         {
14377e860f15SJohn Edward Broadbent                             continue;
14387e860f15SJohn Edward Broadbent                         }
14397e860f15SJohn Edward Broadbent                         entriesArray.push_back({});
14407e860f15SJohn Edward Broadbent                         nlohmann::json& thisEntry = entriesArray.back();
14417e860f15SJohn Edward Broadbent                         thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
14427e860f15SJohn Edward Broadbent                         thisEntry["@odata.id"] =
14437e860f15SJohn Edward Broadbent                             "/redfish/v1/Systems/system/"
14447e860f15SJohn Edward Broadbent                             "LogServices/EventLog/Entries/" +
14457e860f15SJohn Edward Broadbent                             std::to_string(*id);
14467e860f15SJohn Edward Broadbent                         thisEntry["Name"] = "System Event Log Entry";
14477e860f15SJohn Edward Broadbent                         thisEntry["Id"] = std::to_string(*id);
14487e860f15SJohn Edward Broadbent                         thisEntry["Message"] = *message;
14497e860f15SJohn Edward Broadbent                         thisEntry["Resolved"] = resolved;
14507e860f15SJohn Edward Broadbent                         thisEntry["EntryType"] = "Event";
14517e860f15SJohn Edward Broadbent                         thisEntry["Severity"] =
14527e860f15SJohn Edward Broadbent                             translateSeverityDbusToRedfish(*severity);
14537e860f15SJohn Edward Broadbent                         thisEntry["Created"] =
14547e860f15SJohn Edward Broadbent                             crow::utility::getDateTime(timestamp);
14557e860f15SJohn Edward Broadbent                         thisEntry["Modified"] =
14567e860f15SJohn Edward Broadbent                             crow::utility::getDateTime(updateTimestamp);
14577e860f15SJohn Edward Broadbent                         if (filePath != nullptr)
14587e860f15SJohn Edward Broadbent                         {
14597e860f15SJohn Edward Broadbent                             thisEntry["AdditionalDataURI"] =
14607e860f15SJohn Edward Broadbent                                 "/redfish/v1/Systems/system/LogServices/"
14617e860f15SJohn Edward Broadbent                                 "EventLog/"
14627e860f15SJohn Edward Broadbent                                 "Entries/" +
14637e860f15SJohn Edward Broadbent                                 std::to_string(*id) + "/attachment";
14647e860f15SJohn Edward Broadbent                         }
14657e860f15SJohn Edward Broadbent                     }
14667e860f15SJohn Edward Broadbent                     std::sort(entriesArray.begin(), entriesArray.end(),
14677e860f15SJohn Edward Broadbent                               [](const nlohmann::json& left,
14687e860f15SJohn Edward Broadbent                                  const nlohmann::json& right) {
14697e860f15SJohn Edward Broadbent                                   return (left["Id"] <= right["Id"]);
14707e860f15SJohn Edward Broadbent                               });
14717e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members@odata.count"] =
14727e860f15SJohn Edward Broadbent                         entriesArray.size();
14737e860f15SJohn Edward Broadbent                 },
14747e860f15SJohn Edward Broadbent                 "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
14757e860f15SJohn Edward Broadbent                 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
14767e860f15SJohn Edward Broadbent         });
14777e860f15SJohn Edward Broadbent }
14787e860f15SJohn Edward Broadbent 
14797e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app)
14807e860f15SJohn Edward Broadbent {
14817e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
14827e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1483432a890cSEd Tanous         .privileges({{"Login"}})
14847e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
14857e860f15SJohn Edward Broadbent             [](const crow::Request&,
14867e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
14877e860f15SJohn Edward Broadbent                const std::string& param)
14887e860f15SJohn Edward Broadbent 
14897e860f15SJohn Edward Broadbent             {
14907e860f15SJohn Edward Broadbent                 std::string entryID = param;
14917e860f15SJohn Edward Broadbent                 dbus::utility::escapePathForDbus(entryID);
14927e860f15SJohn Edward Broadbent 
14937e860f15SJohn Edward Broadbent                 // DBus implementation of EventLog/Entries
14947e860f15SJohn Edward Broadbent                 // Make call to Logging Service to find all log entry objects
14957e860f15SJohn Edward Broadbent                 crow::connections::systemBus->async_method_call(
14967e860f15SJohn Edward Broadbent                     [asyncResp, entryID](const boost::system::error_code ec,
14977e860f15SJohn Edward Broadbent                                          GetManagedPropertyType& resp) {
14987e860f15SJohn Edward Broadbent                         if (ec.value() == EBADR)
14997e860f15SJohn Edward Broadbent                         {
15007e860f15SJohn Edward Broadbent                             messages::resourceNotFound(
15017e860f15SJohn Edward Broadbent                                 asyncResp->res, "EventLogEntry", entryID);
15027e860f15SJohn Edward Broadbent                             return;
15037e860f15SJohn Edward Broadbent                         }
15047e860f15SJohn Edward Broadbent                         if (ec)
15057e860f15SJohn Edward Broadbent                         {
15067e860f15SJohn Edward Broadbent                             BMCWEB_LOG_ERROR << "EventLogEntry (DBus) "
15077e860f15SJohn Edward Broadbent                                                 "resp_handler got error "
15087e860f15SJohn Edward Broadbent                                              << ec;
15097e860f15SJohn Edward Broadbent                             messages::internalError(asyncResp->res);
15107e860f15SJohn Edward Broadbent                             return;
15117e860f15SJohn Edward Broadbent                         }
15127e860f15SJohn Edward Broadbent                         uint32_t* id = nullptr;
15137e860f15SJohn Edward Broadbent                         std::time_t timestamp{};
15147e860f15SJohn Edward Broadbent                         std::time_t updateTimestamp{};
15157e860f15SJohn Edward Broadbent                         std::string* severity = nullptr;
15167e860f15SJohn Edward Broadbent                         std::string* message = nullptr;
15177e860f15SJohn Edward Broadbent                         std::string* filePath = nullptr;
15187e860f15SJohn Edward Broadbent                         bool resolved = false;
15197e860f15SJohn Edward Broadbent 
15207e860f15SJohn Edward Broadbent                         for (auto& propertyMap : resp)
15217e860f15SJohn Edward Broadbent                         {
15227e860f15SJohn Edward Broadbent                             if (propertyMap.first == "Id")
15237e860f15SJohn Edward Broadbent                             {
15247e860f15SJohn Edward Broadbent                                 id = std::get_if<uint32_t>(&propertyMap.second);
15257e860f15SJohn Edward Broadbent                             }
15267e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Timestamp")
15277e860f15SJohn Edward Broadbent                             {
15287e860f15SJohn Edward Broadbent                                 const uint64_t* millisTimeStamp =
15297e860f15SJohn Edward Broadbent                                     std::get_if<uint64_t>(&propertyMap.second);
15307e860f15SJohn Edward Broadbent                                 if (millisTimeStamp != nullptr)
15317e860f15SJohn Edward Broadbent                                 {
1532d139c236SGeorge Liu                                     timestamp = crow::utility::getTimestamp(
1533cb92c03bSAndrew Geissler                                         *millisTimeStamp);
1534d139c236SGeorge Liu                                 }
1535ebd45906SGeorge Liu                             }
1536d139c236SGeorge Liu                             else if (propertyMap.first == "UpdateTimestamp")
1537d139c236SGeorge Liu                             {
1538d139c236SGeorge Liu                                 const uint64_t* millisTimeStamp =
15397e860f15SJohn Edward Broadbent                                     std::get_if<uint64_t>(&propertyMap.second);
1540ae34c8e8SAdriana Kobylak                                 if (millisTimeStamp != nullptr)
1541ebd45906SGeorge Liu                                 {
1542ebd45906SGeorge Liu                                     updateTimestamp =
1543ebd45906SGeorge Liu                                         crow::utility::getTimestamp(
1544d139c236SGeorge Liu                                             *millisTimeStamp);
1545cb92c03bSAndrew Geissler                                 }
1546ebd45906SGeorge Liu                             }
1547cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1548cb92c03bSAndrew Geissler                             {
1549cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1550cb92c03bSAndrew Geissler                                     &propertyMap.second);
1551cb92c03bSAndrew Geissler                             }
1552cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1553cb92c03bSAndrew Geissler                             {
1554cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1555cb92c03bSAndrew Geissler                                     &propertyMap.second);
1556ae34c8e8SAdriana Kobylak                             }
155775710de2SXiaochao Ma                             else if (propertyMap.first == "Resolved")
155875710de2SXiaochao Ma                             {
155975710de2SXiaochao Ma                                 bool* resolveptr =
156075710de2SXiaochao Ma                                     std::get_if<bool>(&propertyMap.second);
156175710de2SXiaochao Ma                                 if (resolveptr == nullptr)
156275710de2SXiaochao Ma                                 {
156375710de2SXiaochao Ma                                     messages::internalError(asyncResp->res);
156475710de2SXiaochao Ma                                     return;
156575710de2SXiaochao Ma                                 }
156675710de2SXiaochao Ma                                 resolved = *resolveptr;
156775710de2SXiaochao Ma                             }
15687e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Path")
1569f86bb901SAdriana Kobylak                             {
1570f86bb901SAdriana Kobylak                                 filePath = std::get_if<std::string>(
1571f86bb901SAdriana Kobylak                                     &propertyMap.second);
1572f86bb901SAdriana Kobylak                             }
1573f86bb901SAdriana Kobylak                         }
1574f86bb901SAdriana Kobylak                         if (id == nullptr || message == nullptr ||
1575f86bb901SAdriana Kobylak                             severity == nullptr)
1576f86bb901SAdriana Kobylak                         {
1577ae34c8e8SAdriana Kobylak                             messages::internalError(asyncResp->res);
1578271584abSEd Tanous                             return;
1579271584abSEd Tanous                         }
1580f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["@odata.type"] =
1581f86bb901SAdriana Kobylak                             "#LogEntry.v1_8_0.LogEntry";
1582f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["@odata.id"] =
15837e860f15SJohn Edward Broadbent                             "/redfish/v1/Systems/system/LogServices/EventLog/"
15847e860f15SJohn Edward Broadbent                             "Entries/" +
1585f86bb901SAdriana Kobylak                             std::to_string(*id);
15867e860f15SJohn Edward Broadbent                         asyncResp->res.jsonValue["Name"] =
15877e860f15SJohn Edward Broadbent                             "System Event Log Entry";
1588f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1589f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Message"] = *message;
1590f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Resolved"] = resolved;
1591f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["EntryType"] = "Event";
1592f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Severity"] =
1593f86bb901SAdriana Kobylak                             translateSeverityDbusToRedfish(*severity);
1594f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Created"] =
1595f86bb901SAdriana Kobylak                             crow::utility::getDateTime(timestamp);
1596f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Modified"] =
1597f86bb901SAdriana Kobylak                             crow::utility::getDateTime(updateTimestamp);
1598f86bb901SAdriana Kobylak                         if (filePath != nullptr)
1599f86bb901SAdriana Kobylak                         {
1600f86bb901SAdriana Kobylak                             asyncResp->res.jsonValue["AdditionalDataURI"] =
16017e860f15SJohn Edward Broadbent                                 "/redfish/v1/Systems/system/LogServices/"
16027e860f15SJohn Edward Broadbent                                 "EventLog/"
16037e860f15SJohn Edward Broadbent                                 "attachment/" +
16047e860f15SJohn Edward Broadbent                                 std::to_string(*id);
1605f86bb901SAdriana Kobylak                         }
1606cb92c03bSAndrew Geissler                     },
1607cb92c03bSAndrew Geissler                     "xyz.openbmc_project.Logging",
1608cb92c03bSAndrew Geissler                     "/xyz/openbmc_project/logging/entry/" + entryID,
1609f86bb901SAdriana Kobylak                     "org.freedesktop.DBus.Properties", "GetAll", "");
16107e860f15SJohn Edward Broadbent             });
1611336e96c6SChicago Duan 
16127e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
16137e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1614432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
16157e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::patch)(
16167e860f15SJohn Edward Broadbent             [](const crow::Request& req,
16177e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16187e860f15SJohn Edward Broadbent                const std::string& entryId) {
161975710de2SXiaochao Ma                 std::optional<bool> resolved;
162075710de2SXiaochao Ma 
16217e860f15SJohn Edward Broadbent                 if (!json_util::readJson(req, asyncResp->res, "Resolved",
16227e860f15SJohn Edward Broadbent                                          resolved))
162375710de2SXiaochao Ma                 {
162475710de2SXiaochao Ma                     return;
162575710de2SXiaochao Ma                 }
162675710de2SXiaochao Ma                 BMCWEB_LOG_DEBUG << "Set Resolved";
162775710de2SXiaochao Ma 
162875710de2SXiaochao Ma                 crow::connections::systemBus->async_method_call(
162975710de2SXiaochao Ma                     [asyncResp, resolved,
163075710de2SXiaochao Ma                      entryId](const boost::system::error_code ec) {
163175710de2SXiaochao Ma                         if (ec)
163275710de2SXiaochao Ma                         {
163375710de2SXiaochao Ma                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
163475710de2SXiaochao Ma                             messages::internalError(asyncResp->res);
163575710de2SXiaochao Ma                             return;
163675710de2SXiaochao Ma                         }
163775710de2SXiaochao Ma                     },
163875710de2SXiaochao Ma                     "xyz.openbmc_project.Logging",
163975710de2SXiaochao Ma                     "/xyz/openbmc_project/logging/entry/" + entryId,
164075710de2SXiaochao Ma                     "org.freedesktop.DBus.Properties", "Set",
164175710de2SXiaochao Ma                     "xyz.openbmc_project.Logging.Entry", "Resolved",
164275710de2SXiaochao Ma                     std::variant<bool>(*resolved));
16437e860f15SJohn Edward Broadbent             });
164475710de2SXiaochao Ma 
16457e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
16467e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1647432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
16487e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
16497e860f15SJohn Edward Broadbent             [](const crow::Request&,
16507e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16517e860f15SJohn Edward Broadbent                const std::string& param)
16527e860f15SJohn Edward Broadbent 
1653336e96c6SChicago Duan             {
1654336e96c6SChicago Duan                 BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1655336e96c6SChicago Duan 
16567e860f15SJohn Edward Broadbent                 std::string entryID = param;
1657336e96c6SChicago Duan 
1658336e96c6SChicago Duan                 dbus::utility::escapePathForDbus(entryID);
1659336e96c6SChicago Duan 
1660336e96c6SChicago Duan                 // Process response from Logging service.
16617e860f15SJohn Edward Broadbent                 auto respHandler = [asyncResp, entryID](
16627e860f15SJohn Edward Broadbent                                        const boost::system::error_code ec) {
16637e860f15SJohn Edward Broadbent                     BMCWEB_LOG_DEBUG
16647e860f15SJohn Edward Broadbent                         << "EventLogEntry (DBus) doDelete callback: Done";
1665336e96c6SChicago Duan                     if (ec)
1666336e96c6SChicago Duan                     {
16673de8d8baSGeorge Liu                         if (ec.value() == EBADR)
16683de8d8baSGeorge Liu                         {
16697e860f15SJohn Edward Broadbent                             messages::resourceNotFound(asyncResp->res,
16707e860f15SJohn Edward Broadbent                                                        "LogEntry", entryID);
16713de8d8baSGeorge Liu                             return;
16723de8d8baSGeorge Liu                         }
1673336e96c6SChicago Duan                         // TODO Handle for specific error code
16747e860f15SJohn Edward Broadbent                         BMCWEB_LOG_ERROR << "EventLogEntry (DBus) doDelete "
16757e860f15SJohn Edward Broadbent                                             "respHandler got error "
1676336e96c6SChicago Duan                                          << ec;
1677336e96c6SChicago Duan                         asyncResp->res.result(
1678336e96c6SChicago Duan                             boost::beast::http::status::internal_server_error);
1679336e96c6SChicago Duan                         return;
1680336e96c6SChicago Duan                     }
1681336e96c6SChicago Duan 
1682336e96c6SChicago Duan                     asyncResp->res.result(boost::beast::http::status::ok);
1683336e96c6SChicago Duan                 };
1684336e96c6SChicago Duan 
1685336e96c6SChicago Duan                 // Make call to Logging service to request Delete Log
1686336e96c6SChicago Duan                 crow::connections::systemBus->async_method_call(
1687336e96c6SChicago Duan                     respHandler, "xyz.openbmc_project.Logging",
1688336e96c6SChicago Duan                     "/xyz/openbmc_project/logging/entry/" + entryID,
1689336e96c6SChicago Duan                     "xyz.openbmc_project.Object.Delete", "Delete");
16907e860f15SJohn Edward Broadbent             });
1691400fd1fbSAdriana Kobylak }
1692400fd1fbSAdriana Kobylak 
16937e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app)
1694400fd1fbSAdriana Kobylak {
16957e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/"
16967e860f15SJohn Edward Broadbent                       "<str>/attachment")
1697432a890cSEd Tanous         .privileges({{"Login"}})
16987e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
16997e860f15SJohn Edward Broadbent             [](const crow::Request& req,
17007e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
17017e860f15SJohn Edward Broadbent                const std::string& param)
1702400fd1fbSAdriana Kobylak 
17037e860f15SJohn Edward Broadbent             {
1704af61db10SGeorge Liu                 if (!http_helpers::isOctetAccepted(req))
1705400fd1fbSAdriana Kobylak                 {
17067e860f15SJohn Edward Broadbent                     asyncResp->res.result(
17077e860f15SJohn Edward Broadbent                         boost::beast::http::status::bad_request);
1708400fd1fbSAdriana Kobylak                     return;
1709400fd1fbSAdriana Kobylak                 }
1710400fd1fbSAdriana Kobylak 
17117e860f15SJohn Edward Broadbent                 std::string entryID = param;
1712400fd1fbSAdriana Kobylak                 dbus::utility::escapePathForDbus(entryID);
1713400fd1fbSAdriana Kobylak 
1714400fd1fbSAdriana Kobylak                 crow::connections::systemBus->async_method_call(
17157e860f15SJohn Edward Broadbent                     [asyncResp,
17167e860f15SJohn Edward Broadbent                      entryID](const boost::system::error_code ec,
1717400fd1fbSAdriana Kobylak                               const sdbusplus::message::unix_fd& unixfd) {
1718400fd1fbSAdriana Kobylak                         if (ec.value() == EBADR)
1719400fd1fbSAdriana Kobylak                         {
17207e860f15SJohn Edward Broadbent                             messages::resourceNotFound(
17217e860f15SJohn Edward Broadbent                                 asyncResp->res, "EventLogAttachment", entryID);
1722400fd1fbSAdriana Kobylak                             return;
1723400fd1fbSAdriana Kobylak                         }
1724400fd1fbSAdriana Kobylak                         if (ec)
1725400fd1fbSAdriana Kobylak                         {
1726400fd1fbSAdriana Kobylak                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1727400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1728400fd1fbSAdriana Kobylak                             return;
1729400fd1fbSAdriana Kobylak                         }
1730400fd1fbSAdriana Kobylak 
1731400fd1fbSAdriana Kobylak                         int fd = -1;
1732400fd1fbSAdriana Kobylak                         fd = dup(unixfd);
1733400fd1fbSAdriana Kobylak                         if (fd == -1)
1734400fd1fbSAdriana Kobylak                         {
1735400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1736400fd1fbSAdriana Kobylak                             return;
1737400fd1fbSAdriana Kobylak                         }
1738400fd1fbSAdriana Kobylak 
1739400fd1fbSAdriana Kobylak                         long long int size = lseek(fd, 0, SEEK_END);
1740400fd1fbSAdriana Kobylak                         if (size == -1)
1741400fd1fbSAdriana Kobylak                         {
1742400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1743400fd1fbSAdriana Kobylak                             return;
1744400fd1fbSAdriana Kobylak                         }
1745400fd1fbSAdriana Kobylak 
1746400fd1fbSAdriana Kobylak                         // Arbitrary max size of 64kb
1747400fd1fbSAdriana Kobylak                         constexpr int maxFileSize = 65536;
1748400fd1fbSAdriana Kobylak                         if (size > maxFileSize)
1749400fd1fbSAdriana Kobylak                         {
1750400fd1fbSAdriana Kobylak                             BMCWEB_LOG_ERROR
1751400fd1fbSAdriana Kobylak                                 << "File size exceeds maximum allowed size of "
1752400fd1fbSAdriana Kobylak                                 << maxFileSize;
1753400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1754400fd1fbSAdriana Kobylak                             return;
1755400fd1fbSAdriana Kobylak                         }
1756400fd1fbSAdriana Kobylak                         std::vector<char> data(static_cast<size_t>(size));
1757400fd1fbSAdriana Kobylak                         long long int rc = lseek(fd, 0, SEEK_SET);
1758400fd1fbSAdriana Kobylak                         if (rc == -1)
1759400fd1fbSAdriana Kobylak                         {
1760400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1761400fd1fbSAdriana Kobylak                             return;
1762400fd1fbSAdriana Kobylak                         }
1763400fd1fbSAdriana Kobylak                         rc = read(fd, data.data(), data.size());
1764400fd1fbSAdriana Kobylak                         if ((rc == -1) || (rc != size))
1765400fd1fbSAdriana Kobylak                         {
1766400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1767400fd1fbSAdriana Kobylak                             return;
1768400fd1fbSAdriana Kobylak                         }
1769400fd1fbSAdriana Kobylak                         close(fd);
1770400fd1fbSAdriana Kobylak 
1771400fd1fbSAdriana Kobylak                         std::string_view strData(data.data(), data.size());
17727e860f15SJohn Edward Broadbent                         std::string output =
17737e860f15SJohn Edward Broadbent                             crow::utility::base64encode(strData);
1774400fd1fbSAdriana Kobylak 
1775400fd1fbSAdriana Kobylak                         asyncResp->res.addHeader("Content-Type",
1776400fd1fbSAdriana Kobylak                                                  "application/octet-stream");
17777e860f15SJohn Edward Broadbent                         asyncResp->res.addHeader("Content-Transfer-Encoding",
17787e860f15SJohn Edward Broadbent                                                  "Base64");
1779400fd1fbSAdriana Kobylak                         asyncResp->res.body() = std::move(output);
1780400fd1fbSAdriana Kobylak                     },
1781400fd1fbSAdriana Kobylak                     "xyz.openbmc_project.Logging",
1782400fd1fbSAdriana Kobylak                     "/xyz/openbmc_project/logging/entry/" + entryID,
1783400fd1fbSAdriana Kobylak                     "xyz.openbmc_project.Logging.Entry", "GetEntry");
17847e860f15SJohn Edward Broadbent             });
17851da66f75SEd Tanous }
17861da66f75SEd Tanous 
17877e860f15SJohn Edward Broadbent inline void requestRoutesBMCLogServiceCollection(App& app)
17881da66f75SEd Tanous {
17897e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/")
1790432a890cSEd Tanous         .privileges({{"Login"}})
17917e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
17927e860f15SJohn Edward Broadbent             [](const crow::Request&,
17937e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
17947e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
17957e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
1796e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
17971da66f75SEd Tanous                     "#LogServiceCollection.LogServiceCollection";
1798e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
1799e1f26343SJason M. Bills                     "/redfish/v1/Managers/bmc/LogServices";
18007e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
18017e860f15SJohn Edward Broadbent                     "Open BMC Log Services Collection";
1802e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
18031da66f75SEd Tanous                     "Collection of LogServices for this Manager";
18047e860f15SJohn Edward Broadbent                 nlohmann::json& logServiceArray =
18057e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
1806c4bf6374SJason M. Bills                 logServiceArray = nlohmann::json::array();
18075cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
18085cb1dd27SAsmitha Karunanithi                 logServiceArray.push_back(
18097e860f15SJohn Edward Broadbent                     {{"@odata.id",
18107e860f15SJohn Edward Broadbent                       "/redfish/v1/Managers/bmc/LogServices/Dump"}});
18115cb1dd27SAsmitha Karunanithi #endif
1812c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1813c4bf6374SJason M. Bills                 logServiceArray.push_back(
18147e860f15SJohn Edward Broadbent                     {{"@odata.id",
18157e860f15SJohn Edward Broadbent                       "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1816c4bf6374SJason M. Bills #endif
1817e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
1818c4bf6374SJason M. Bills                     logServiceArray.size();
18197e860f15SJohn Edward Broadbent             });
1820e1f26343SJason M. Bills }
1821e1f26343SJason M. Bills 
18227e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app)
1823e1f26343SJason M. Bills {
18247e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1825432a890cSEd Tanous         .privileges({{"Login"}})
18267e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
18277e860f15SJohn Edward Broadbent             [](const crow::Request&,
18287e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
18298d1b46d7Szhanghch05 
18307e860f15SJohn Edward Broadbent             {
1831e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
1832e1f26343SJason M. Bills                     "#LogService.v1_1_0.LogService";
18330f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
18340f74e643SEd Tanous                     "/redfish/v1/Managers/bmc/LogServices/Journal";
18357e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
18367e860f15SJohn Edward Broadbent                     "Open BMC Journal Log Service";
18377e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Description"] =
18387e860f15SJohn Edward Broadbent                     "BMC Journal Log Service";
1839c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Id"] = "BMC Journal";
1840e1f26343SJason M. Bills                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1841*7c8c4058STejas Patil 
1842*7c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
1843*7c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
1844*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
1845*7c8c4058STejas Patil                     redfishDateTimeOffset.first;
1846*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
1847*7c8c4058STejas Patil                     redfishDateTimeOffset.second;
1848*7c8c4058STejas Patil 
1849cd50aa42SJason M. Bills                 asyncResp->res.jsonValue["Entries"] = {
1850cd50aa42SJason M. Bills                     {"@odata.id",
1851086be238SEd Tanous                      "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
18527e860f15SJohn Edward Broadbent             });
1853e1f26343SJason M. Bills }
1854e1f26343SJason M. Bills 
1855c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1856e1f26343SJason M. Bills                                       sd_journal* journal,
1857c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
1858e1f26343SJason M. Bills {
1859e1f26343SJason M. Bills     // Get the Log Entry contents
1860e1f26343SJason M. Bills     int ret = 0;
1861e1f26343SJason M. Bills 
1862a8fe54f0SJason M. Bills     std::string message;
1863a8fe54f0SJason M. Bills     std::string_view syslogID;
1864a8fe54f0SJason M. Bills     ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
1865a8fe54f0SJason M. Bills     if (ret < 0)
1866a8fe54f0SJason M. Bills     {
1867a8fe54f0SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: "
1868a8fe54f0SJason M. Bills                          << strerror(-ret);
1869a8fe54f0SJason M. Bills     }
1870a8fe54f0SJason M. Bills     if (!syslogID.empty())
1871a8fe54f0SJason M. Bills     {
1872a8fe54f0SJason M. Bills         message += std::string(syslogID) + ": ";
1873a8fe54f0SJason M. Bills     }
1874a8fe54f0SJason M. Bills 
187539e77504SEd Tanous     std::string_view msg;
187616428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1877e1f26343SJason M. Bills     if (ret < 0)
1878e1f26343SJason M. Bills     {
1879e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1880e1f26343SJason M. Bills         return 1;
1881e1f26343SJason M. Bills     }
1882a8fe54f0SJason M. Bills     message += std::string(msg);
1883e1f26343SJason M. Bills 
1884e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1885271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
188616428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1887e1f26343SJason M. Bills     if (ret < 0)
1888e1f26343SJason M. Bills     {
1889e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
1890e1f26343SJason M. Bills     }
1891e1f26343SJason M. Bills 
1892e1f26343SJason M. Bills     // Get the Created time from the timestamp
189316428a1aSJason M. Bills     std::string entryTimeStr;
189416428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
1895e1f26343SJason M. Bills     {
189616428a1aSJason M. Bills         return 1;
1897e1f26343SJason M. Bills     }
1898e1f26343SJason M. Bills 
1899e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
1900c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
19010ef217f4SGeorge Liu         {"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
1902c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1903c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
1904e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
1905c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
1906a8fe54f0SJason M. Bills         {"Message", std::move(message)},
1907e1f26343SJason M. Bills         {"EntryType", "Oem"},
1908738c1e61SPatrick Williams         {"Severity", severity <= 2   ? "Critical"
1909738c1e61SPatrick Williams                      : severity <= 4 ? "Warning"
1910738c1e61SPatrick Williams                                      : "OK"},
1911086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
1912e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
1913e1f26343SJason M. Bills     return 0;
1914e1f26343SJason M. Bills }
1915e1f26343SJason M. Bills 
19167e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app)
1917e1f26343SJason M. Bills {
19187e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
1919432a890cSEd Tanous         .privileges({{"Login"}})
19207e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
19217e860f15SJohn Edward Broadbent             [](const crow::Request& req,
19227e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1923193ad2faSJason M. Bills                 static constexpr const long maxEntriesPerPage = 1000;
1924271584abSEd Tanous                 uint64_t skip = 0;
1925271584abSEd Tanous                 uint64_t top = maxEntriesPerPage; // Show max entries by default
19268d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
1927193ad2faSJason M. Bills                 {
1928193ad2faSJason M. Bills                     return;
1929193ad2faSJason M. Bills                 }
19308d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
1931193ad2faSJason M. Bills                 {
1932193ad2faSJason M. Bills                     return;
1933193ad2faSJason M. Bills                 }
19347e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
19357e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
1936e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
1937e1f26343SJason M. Bills                     "#LogEntryCollection.LogEntryCollection";
19380f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
19390f74e643SEd Tanous                     "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1940e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1941e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
1942e1f26343SJason M. Bills                     "Collection of BMC Journal Entries";
19437e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
19447e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
1945e1f26343SJason M. Bills                 logEntryArray = nlohmann::json::array();
1946e1f26343SJason M. Bills 
19477e860f15SJohn Edward Broadbent                 // Go through the journal and use the timestamp to create a
19487e860f15SJohn Edward Broadbent                 // unique ID for each entry
1949e1f26343SJason M. Bills                 sd_journal* journalTmp = nullptr;
1950e1f26343SJason M. Bills                 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1951e1f26343SJason M. Bills                 if (ret < 0)
1952e1f26343SJason M. Bills                 {
19537e860f15SJohn Edward Broadbent                     BMCWEB_LOG_ERROR << "failed to open journal: "
19547e860f15SJohn Edward Broadbent                                      << strerror(-ret);
1955f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
1956e1f26343SJason M. Bills                     return;
1957e1f26343SJason M. Bills                 }
19587e860f15SJohn Edward Broadbent                 std::unique_ptr<sd_journal, decltype(&sd_journal_close)>
19597e860f15SJohn Edward Broadbent                     journal(journalTmp, sd_journal_close);
1960e1f26343SJason M. Bills                 journalTmp = nullptr;
1961b01bf299SEd Tanous                 uint64_t entryCount = 0;
1962e85d6b16SJason M. Bills                 // Reset the unique ID on the first entry
1963e85d6b16SJason M. Bills                 bool firstEntry = true;
1964e1f26343SJason M. Bills                 SD_JOURNAL_FOREACH(journal.get())
1965e1f26343SJason M. Bills                 {
1966193ad2faSJason M. Bills                     entryCount++;
19677e860f15SJohn Edward Broadbent                     // Handle paging using skip (number of entries to skip from
19687e860f15SJohn Edward Broadbent                     // the start) and top (number of entries to display)
1969193ad2faSJason M. Bills                     if (entryCount <= skip || entryCount > skip + top)
1970193ad2faSJason M. Bills                     {
1971193ad2faSJason M. Bills                         continue;
1972193ad2faSJason M. Bills                     }
1973193ad2faSJason M. Bills 
197416428a1aSJason M. Bills                     std::string idStr;
1975e85d6b16SJason M. Bills                     if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1976e1f26343SJason M. Bills                     {
1977e1f26343SJason M. Bills                         continue;
1978e1f26343SJason M. Bills                     }
1979e1f26343SJason M. Bills 
1980e85d6b16SJason M. Bills                     if (firstEntry)
1981e85d6b16SJason M. Bills                     {
1982e85d6b16SJason M. Bills                         firstEntry = false;
1983e85d6b16SJason M. Bills                     }
1984e85d6b16SJason M. Bills 
1985e1f26343SJason M. Bills                     logEntryArray.push_back({});
1986c4bf6374SJason M. Bills                     nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
1987c4bf6374SJason M. Bills                     if (fillBMCJournalLogEntryJson(idStr, journal.get(),
1988c4bf6374SJason M. Bills                                                    bmcJournalLogEntry) != 0)
1989e1f26343SJason M. Bills                     {
1990f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
1991e1f26343SJason M. Bills                         return;
1992e1f26343SJason M. Bills                     }
1993e1f26343SJason M. Bills                 }
1994193ad2faSJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1995193ad2faSJason M. Bills                 if (skip + top < entryCount)
1996193ad2faSJason M. Bills                 {
1997193ad2faSJason M. Bills                     asyncResp->res.jsonValue["Members@odata.nextLink"] =
19987e860f15SJohn Edward Broadbent                         "/redfish/v1/Managers/bmc/LogServices/Journal/"
19997e860f15SJohn Edward Broadbent                         "Entries?$skip=" +
2000193ad2faSJason M. Bills                         std::to_string(skip + top);
2001193ad2faSJason M. Bills                 }
20027e860f15SJohn Edward Broadbent             });
2003e1f26343SJason M. Bills }
2004e1f26343SJason M. Bills 
20057e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app)
2006e1f26343SJason M. Bills {
20077e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
20087e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/")
2009432a890cSEd Tanous         .privileges({{"Login"}})
20107e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
20117e860f15SJohn Edward Broadbent             [](const crow::Request&,
20127e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
20137e860f15SJohn Edward Broadbent                const std::string& entryID) {
2014e1f26343SJason M. Bills                 // Convert the unique ID back to a timestamp to find the entry
2015e1f26343SJason M. Bills                 uint64_t ts = 0;
2016271584abSEd Tanous                 uint64_t index = 0;
20178d1b46d7Szhanghch05                 if (!getTimestampFromID(asyncResp, entryID, ts, index))
2018e1f26343SJason M. Bills                 {
201916428a1aSJason M. Bills                     return;
2020e1f26343SJason M. Bills                 }
2021e1f26343SJason M. Bills 
2022e1f26343SJason M. Bills                 sd_journal* journalTmp = nullptr;
2023e1f26343SJason M. Bills                 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2024e1f26343SJason M. Bills                 if (ret < 0)
2025e1f26343SJason M. Bills                 {
20267e860f15SJohn Edward Broadbent                     BMCWEB_LOG_ERROR << "failed to open journal: "
20277e860f15SJohn Edward Broadbent                                      << strerror(-ret);
2028f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
2029e1f26343SJason M. Bills                     return;
2030e1f26343SJason M. Bills                 }
20317e860f15SJohn Edward Broadbent                 std::unique_ptr<sd_journal, decltype(&sd_journal_close)>
20327e860f15SJohn Edward Broadbent                     journal(journalTmp, sd_journal_close);
2033e1f26343SJason M. Bills                 journalTmp = nullptr;
20347e860f15SJohn Edward Broadbent                 // Go to the timestamp in the log and move to the entry at the
20357e860f15SJohn Edward Broadbent                 // index tracking the unique ID
2036af07e3f5SJason M. Bills                 std::string idStr;
2037af07e3f5SJason M. Bills                 bool firstEntry = true;
2038e1f26343SJason M. Bills                 ret = sd_journal_seek_realtime_usec(journal.get(), ts);
20392056b6d1SManojkiran Eda                 if (ret < 0)
20402056b6d1SManojkiran Eda                 {
20412056b6d1SManojkiran Eda                     BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
20422056b6d1SManojkiran Eda                                      << strerror(-ret);
20432056b6d1SManojkiran Eda                     messages::internalError(asyncResp->res);
20442056b6d1SManojkiran Eda                     return;
20452056b6d1SManojkiran Eda                 }
2046271584abSEd Tanous                 for (uint64_t i = 0; i <= index; i++)
2047e1f26343SJason M. Bills                 {
2048e1f26343SJason M. Bills                     sd_journal_next(journal.get());
2049af07e3f5SJason M. Bills                     if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2050af07e3f5SJason M. Bills                     {
2051af07e3f5SJason M. Bills                         messages::internalError(asyncResp->res);
2052af07e3f5SJason M. Bills                         return;
2053af07e3f5SJason M. Bills                     }
2054af07e3f5SJason M. Bills                     if (firstEntry)
2055af07e3f5SJason M. Bills                     {
2056af07e3f5SJason M. Bills                         firstEntry = false;
2057af07e3f5SJason M. Bills                     }
2058e1f26343SJason M. Bills                 }
2059c4bf6374SJason M. Bills                 // Confirm that the entry ID matches what was requested
2060af07e3f5SJason M. Bills                 if (idStr != entryID)
2061c4bf6374SJason M. Bills                 {
2062c4bf6374SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, entryID);
2063c4bf6374SJason M. Bills                     return;
2064c4bf6374SJason M. Bills                 }
2065c4bf6374SJason M. Bills 
2066c4bf6374SJason M. Bills                 if (fillBMCJournalLogEntryJson(entryID, journal.get(),
2067e1f26343SJason M. Bills                                                asyncResp->res.jsonValue) != 0)
2068e1f26343SJason M. Bills                 {
2069f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
2070e1f26343SJason M. Bills                     return;
2071e1f26343SJason M. Bills                 }
20727e860f15SJohn Edward Broadbent             });
2073c9bb6861Sraviteja-b }
2074c9bb6861Sraviteja-b 
20757e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpService(App& app)
2076c9bb6861Sraviteja-b {
20777e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2078432a890cSEd Tanous         .privileges({{"Login"}})
20797e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
20807e860f15SJohn Edward Broadbent             [](const crow::Request&,
20817e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2082c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.id"] =
20835cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Managers/bmc/LogServices/Dump";
2084c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.type"] =
2085d337bb72SAsmitha Karunanithi                     "#LogService.v1_2_0.LogService";
2086c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Name"] = "Dump LogService";
20875cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
20885cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = "Dump";
2089c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2090*7c8c4058STejas Patil 
2091*7c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
2092*7c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
2093*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
2094*7c8c4058STejas Patil                     redfishDateTimeOffset.first;
2095*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2096*7c8c4058STejas Patil                     redfishDateTimeOffset.second;
2097*7c8c4058STejas Patil 
2098c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Entries"] = {
20997e860f15SJohn Edward Broadbent                     {"@odata.id",
21007e860f15SJohn Edward Broadbent                      "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
21015cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Actions"] = {
21025cb1dd27SAsmitha Karunanithi                     {"#LogService.ClearLog",
21035cb1dd27SAsmitha Karunanithi                      {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
21045cb1dd27SAsmitha Karunanithi                                  "Actions/LogService.ClearLog"}}},
2105d337bb72SAsmitha Karunanithi                     {"#LogService.CollectDiagnosticData",
2106d337bb72SAsmitha Karunanithi                      {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
2107d337bb72SAsmitha Karunanithi                                  "Actions/LogService.CollectDiagnosticData"}}}};
21087e860f15SJohn Edward Broadbent             });
2109c9bb6861Sraviteja-b }
2110c9bb6861Sraviteja-b 
21117e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntryCollection(App& app)
21127e860f15SJohn Edward Broadbent {
21137e860f15SJohn Edward Broadbent 
2114c9bb6861Sraviteja-b     /**
2115c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
2116c9bb6861Sraviteja-b      */
21177e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2118432a890cSEd Tanous         .privileges({{"Login"}})
21197e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
21207e860f15SJohn Edward Broadbent             [](const crow::Request&,
21217e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2122c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.type"] =
2123c9bb6861Sraviteja-b                     "#LogEntryCollection.LogEntryCollection";
2124c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.id"] =
21255cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
21265cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
2127c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Description"] =
21285cb1dd27SAsmitha Karunanithi                     "Collection of BMC Dump Entries";
2129c9bb6861Sraviteja-b 
21305cb1dd27SAsmitha Karunanithi                 getDumpEntryCollection(asyncResp, "BMC");
21317e860f15SJohn Edward Broadbent             });
2132c9bb6861Sraviteja-b }
2133c9bb6861Sraviteja-b 
21347e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app)
2135c9bb6861Sraviteja-b {
21367e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
21377e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2138432a890cSEd Tanous         .privileges({{"Login"}})
21397e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
21407e860f15SJohn Edward Broadbent             [](const crow::Request&,
21417e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
21427e860f15SJohn Edward Broadbent                const std::string& param) {
21437e860f15SJohn Edward Broadbent                 getDumpEntryById(asyncResp, param, "BMC");
21447e860f15SJohn Edward Broadbent             });
21457e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
21467e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2147432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
21487e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
21497e860f15SJohn Edward Broadbent             [](const crow::Request&,
21507e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
21517e860f15SJohn Edward Broadbent                const std::string& param) {
21527e860f15SJohn Edward Broadbent                 deleteDumpEntry(asyncResp, param, "bmc");
21537e860f15SJohn Edward Broadbent             });
2154c9bb6861Sraviteja-b }
2155c9bb6861Sraviteja-b 
21567e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app)
2157c9bb6861Sraviteja-b {
21588d1b46d7Szhanghch05 
21597e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2160d337bb72SAsmitha Karunanithi                       "Actions/"
2161d337bb72SAsmitha Karunanithi                       "LogService.CollectDiagnosticData/")
2162432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
21637e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
21647e860f15SJohn Edward Broadbent             [](const crow::Request& req,
21657e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
21668d1b46d7Szhanghch05                 createDump(asyncResp, req, "BMC");
21677e860f15SJohn Edward Broadbent             });
2168a43be80fSAsmitha Karunanithi }
2169a43be80fSAsmitha Karunanithi 
21707e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app)
217180319af1SAsmitha Karunanithi {
21727e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
217380319af1SAsmitha Karunanithi                       "Actions/"
217480319af1SAsmitha Karunanithi                       "LogService.ClearLog/")
2175432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
21767e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
21777e860f15SJohn Edward Broadbent             [](const crow::Request&,
21787e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
21798d1b46d7Szhanghch05                 clearDump(asyncResp, "BMC");
21807e860f15SJohn Edward Broadbent             });
21815cb1dd27SAsmitha Karunanithi }
21825cb1dd27SAsmitha Karunanithi 
21837e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app)
21845cb1dd27SAsmitha Karunanithi {
21857e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/")
2186432a890cSEd Tanous         .privileges({{"Login"}})
21877e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
21887e860f15SJohn Edward Broadbent             [](const crow::Request&,
21897e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
21905cb1dd27SAsmitha Karunanithi 
21917e860f15SJohn Edward Broadbent             {
21925cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] =
21935cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Systems/system/LogServices/Dump";
21945cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
2195d337bb72SAsmitha Karunanithi                     "#LogService.v1_2_0.LogService";
21965cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "Dump LogService";
21977e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Description"] =
21987e860f15SJohn Edward Broadbent                     "System Dump LogService";
21995cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = "Dump";
22005cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2201*7c8c4058STejas Patil 
2202*7c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
2203*7c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
2204*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
2205*7c8c4058STejas Patil                     redfishDateTimeOffset.first;
2206*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2207*7c8c4058STejas Patil                     redfishDateTimeOffset.second;
2208*7c8c4058STejas Patil 
22095cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Entries"] = {
22105cb1dd27SAsmitha Karunanithi                     {"@odata.id",
22115cb1dd27SAsmitha Karunanithi                      "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
22125cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Actions"] = {
22135cb1dd27SAsmitha Karunanithi                     {"#LogService.ClearLog",
22147e860f15SJohn Edward Broadbent                      {{"target",
22157e860f15SJohn Edward Broadbent                        "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
22165cb1dd27SAsmitha Karunanithi                        "LogService.ClearLog"}}},
2217d337bb72SAsmitha Karunanithi                     {"#LogService.CollectDiagnosticData",
22187e860f15SJohn Edward Broadbent                      {{"target",
22197e860f15SJohn Edward Broadbent                        "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
2220d337bb72SAsmitha Karunanithi                        "LogService.CollectDiagnosticData"}}}};
22217e860f15SJohn Edward Broadbent             });
22225cb1dd27SAsmitha Karunanithi }
22235cb1dd27SAsmitha Karunanithi 
22247e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app)
22257e860f15SJohn Edward Broadbent {
22267e860f15SJohn Edward Broadbent 
22275cb1dd27SAsmitha Karunanithi     /**
22285cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
22295cb1dd27SAsmitha Karunanithi      */
2230f9a6708cSCharles Boyer     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
2231432a890cSEd Tanous         .privileges({{"Login"}})
22327e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
22337e860f15SJohn Edward Broadbent             [](const crow::Request&,
2234864d6a17SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
22355cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
22365cb1dd27SAsmitha Karunanithi                     "#LogEntryCollection.LogEntryCollection";
22375cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] =
22385cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Systems/system/LogServices/Dump/Entries";
22395cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "System Dump Entries";
22405cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Description"] =
22415cb1dd27SAsmitha Karunanithi                     "Collection of System Dump Entries";
22425cb1dd27SAsmitha Karunanithi 
22435cb1dd27SAsmitha Karunanithi                 getDumpEntryCollection(asyncResp, "System");
22447e860f15SJohn Edward Broadbent             });
22455cb1dd27SAsmitha Karunanithi }
22465cb1dd27SAsmitha Karunanithi 
22477e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app)
22485cb1dd27SAsmitha Karunanithi {
22497e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2250864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2251432a890cSEd Tanous         .privileges({{"Login"}})
22527e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
22537e860f15SJohn Edward Broadbent             [](const crow::Request&,
22547e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22557e860f15SJohn Edward Broadbent                const std::string& param) {
22567e860f15SJohn Edward Broadbent                 getDumpEntryById(asyncResp, param, "System");
22577e860f15SJohn Edward Broadbent             });
22588d1b46d7Szhanghch05 
22597e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2260864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2261432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
22627e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
22637e860f15SJohn Edward Broadbent             [](const crow::Request&,
22647e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22657e860f15SJohn Edward Broadbent                const std::string& param) {
22667e860f15SJohn Edward Broadbent                 deleteDumpEntry(asyncResp, param, "system");
22677e860f15SJohn Edward Broadbent             });
22685cb1dd27SAsmitha Karunanithi }
2269c9bb6861Sraviteja-b 
22707e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app)
2271c9bb6861Sraviteja-b {
22727e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2273d337bb72SAsmitha Karunanithi                       "Actions/"
2274d337bb72SAsmitha Karunanithi                       "LogService.CollectDiagnosticData/")
2275432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
22767e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
22777e860f15SJohn Edward Broadbent             [](const crow::Request& req,
22787e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
22797e860f15SJohn Edward Broadbent 
22807e860f15SJohn Edward Broadbent             { createDump(asyncResp, req, "System"); });
2281a43be80fSAsmitha Karunanithi }
2282a43be80fSAsmitha Karunanithi 
22837e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app)
2284a43be80fSAsmitha Karunanithi {
22857e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2286013487e5Sraviteja-b                       "Actions/"
2287013487e5Sraviteja-b                       "LogService.ClearLog/")
2288432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
22897e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
22907e860f15SJohn Edward Broadbent             [](const crow::Request&,
22917e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
22927e860f15SJohn Edward Broadbent 
22937e860f15SJohn Edward Broadbent             { clearDump(asyncResp, "System"); });
2294013487e5Sraviteja-b }
2295013487e5Sraviteja-b 
22967e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app)
22971da66f75SEd Tanous {
22983946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
22993946028dSAppaRao Puli     // method for security reasons.
23001da66f75SEd Tanous     /**
23011da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
23021da66f75SEd Tanous      */
23037e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
2304432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
23057e860f15SJohn Edward Broadbent         .methods(
23067e860f15SJohn Edward Broadbent             boost::beast::http::verb::
23077e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
23087e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
23097e860f15SJohn Edward Broadbent             // Copy over the static data to include the entries added by
23107e860f15SJohn Edward Broadbent             // SubRoute
23110f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2312424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump";
2313e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
23148e6c099aSJason M. Bills                 "#LogService.v1_2_0.LogService";
23154f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
23164f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
23174f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2318e1f26343SJason M. Bills             asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2319e1f26343SJason M. Bills             asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
2320*7c8c4058STejas Patil 
2321*7c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
2322*7c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
2323*7c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2324*7c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2325*7c8c4058STejas Patil                 redfishDateTimeOffset.second;
2326*7c8c4058STejas Patil 
2327cd50aa42SJason M. Bills             asyncResp->res.jsonValue["Entries"] = {
2328cd50aa42SJason M. Bills                 {"@odata.id",
2329424c4176SJason M. Bills                  "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
2330e1f26343SJason M. Bills             asyncResp->res.jsonValue["Actions"] = {
23315b61b5e8SJason M. Bills                 {"#LogService.ClearLog",
23325b61b5e8SJason M. Bills                  {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
23335b61b5e8SJason M. Bills                              "Actions/LogService.ClearLog"}}},
23348e6c099aSJason M. Bills                 {"#LogService.CollectDiagnosticData",
2335424c4176SJason M. Bills                  {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
23368e6c099aSJason M. Bills                              "Actions/LogService.CollectDiagnosticData"}}}};
23377e860f15SJohn Edward Broadbent         });
23381da66f75SEd Tanous }
23391da66f75SEd Tanous 
23407e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app)
23415b61b5e8SJason M. Bills {
23427e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
23437e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
23445b61b5e8SJason M. Bills                  "LogService.ClearLog/")
2345432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
23467e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
23477e860f15SJohn Edward Broadbent             [](const crow::Request&,
23487e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
23495b61b5e8SJason M. Bills                 crow::connections::systemBus->async_method_call(
23505b61b5e8SJason M. Bills                     [asyncResp](const boost::system::error_code ec,
2351cb13a392SEd Tanous                                 const std::string&) {
23525b61b5e8SJason M. Bills                         if (ec)
23535b61b5e8SJason M. Bills                         {
23545b61b5e8SJason M. Bills                             messages::internalError(asyncResp->res);
23555b61b5e8SJason M. Bills                             return;
23565b61b5e8SJason M. Bills                         }
23575b61b5e8SJason M. Bills                         messages::success(asyncResp->res);
23585b61b5e8SJason M. Bills                     },
23597e860f15SJohn Edward Broadbent                     crashdumpObject, crashdumpPath, deleteAllInterface,
23607e860f15SJohn Edward Broadbent                     "DeleteAll");
23617e860f15SJohn Edward Broadbent             });
23625b61b5e8SJason M. Bills }
23635b61b5e8SJason M. Bills 
23648d1b46d7Szhanghch05 static void
23658d1b46d7Szhanghch05     logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23668d1b46d7Szhanghch05                       const std::string& logID, nlohmann::json& logEntryJson)
2367e855dd28SJason M. Bills {
2368043a0536SJohnathan Mantey     auto getStoredLogCallback =
2369043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2370e855dd28SJason M. Bills             const boost::system::error_code ec,
2371043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>>& params) {
2372e855dd28SJason M. Bills             if (ec)
2373e855dd28SJason M. Bills             {
2374e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
23751ddcf01aSJason M. Bills                 if (ec.value() ==
23761ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
23771ddcf01aSJason M. Bills                 {
2378043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2379043a0536SJohnathan Mantey                                                logID);
23801ddcf01aSJason M. Bills                 }
23811ddcf01aSJason M. Bills                 else
23821ddcf01aSJason M. Bills                 {
2383e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
23841ddcf01aSJason M. Bills                 }
2385e855dd28SJason M. Bills                 return;
2386e855dd28SJason M. Bills             }
2387043a0536SJohnathan Mantey 
2388043a0536SJohnathan Mantey             std::string timestamp{};
2389043a0536SJohnathan Mantey             std::string filename{};
2390043a0536SJohnathan Mantey             std::string logfile{};
23912c70f800SEd Tanous             parseCrashdumpParameters(params, filename, timestamp, logfile);
2392043a0536SJohnathan Mantey 
2393043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2394e855dd28SJason M. Bills             {
2395043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2396e855dd28SJason M. Bills                 return;
2397e855dd28SJason M. Bills             }
2398e855dd28SJason M. Bills 
2399043a0536SJohnathan Mantey             std::string crashdumpURI =
2400e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2401043a0536SJohnathan Mantey                 logID + "/" + filename;
24020ef217f4SGeorge Liu             logEntryJson = {{"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
2403043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2404043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2405e855dd28SJason M. Bills                                               logID},
2406e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2407e855dd28SJason M. Bills                             {"Id", logID},
2408e855dd28SJason M. Bills                             {"EntryType", "Oem"},
24098e6c099aSJason M. Bills                             {"AdditionalDataURI", std::move(crashdumpURI)},
24108e6c099aSJason M. Bills                             {"DiagnosticDataType", "OEM"},
24118e6c099aSJason M. Bills                             {"OEMDiagnosticDataType", "PECICrashdump"},
2412043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2413e855dd28SJason M. Bills         };
2414e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
24155b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
24165b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2417043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2418e855dd28SJason M. Bills }
2419e855dd28SJason M. Bills 
24207e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app)
24211da66f75SEd Tanous {
24223946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
24233946028dSAppaRao Puli     // method for security reasons.
24241da66f75SEd Tanous     /**
24251da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
24261da66f75SEd Tanous      */
24277e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
24287e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
2429432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
24307e860f15SJohn Edward Broadbent         .methods(
24317e860f15SJohn Edward Broadbent             boost::beast::http::verb::
24327e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
24337e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
24347e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
24357e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
2436e1f26343SJason M. Bills             auto getLogEntriesCallback = [asyncResp](
2437e1f26343SJason M. Bills                                              const boost::system::error_code ec,
24387e860f15SJohn Edward Broadbent                                              const std::vector<std::string>&
24397e860f15SJohn Edward Broadbent                                                  resp) {
24401da66f75SEd Tanous                 if (ec)
24411da66f75SEd Tanous                 {
24421da66f75SEd Tanous                     if (ec.value() !=
24431da66f75SEd Tanous                         boost::system::errc::no_such_file_or_directory)
24441da66f75SEd Tanous                     {
24451da66f75SEd Tanous                         BMCWEB_LOG_DEBUG << "failed to get entries ec: "
24461da66f75SEd Tanous                                          << ec.message();
2447f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
24481da66f75SEd Tanous                         return;
24491da66f75SEd Tanous                     }
24501da66f75SEd Tanous                 }
2451e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
24521da66f75SEd Tanous                     "#LogEntryCollection.LogEntryCollection";
24530f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
2454424c4176SJason M. Bills                     "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2455424c4176SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2456e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
2457424c4176SJason M. Bills                     "Collection of Crashdump Entries";
24587e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
24597e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
2460e1f26343SJason M. Bills                 logEntryArray = nlohmann::json::array();
2461e855dd28SJason M. Bills                 std::vector<std::string> logIDs;
2462e855dd28SJason M. Bills                 // Get the list of log entries and build up an empty array big
2463e855dd28SJason M. Bills                 // enough to hold them
24641da66f75SEd Tanous                 for (const std::string& objpath : resp)
24651da66f75SEd Tanous                 {
2466e855dd28SJason M. Bills                     // Get the log ID
2467f23b7296SEd Tanous                     std::size_t lastPos = objpath.rfind('/');
2468e855dd28SJason M. Bills                     if (lastPos == std::string::npos)
24691da66f75SEd Tanous                     {
2470e855dd28SJason M. Bills                         continue;
24711da66f75SEd Tanous                     }
2472e855dd28SJason M. Bills                     logIDs.emplace_back(objpath.substr(lastPos + 1));
2473e855dd28SJason M. Bills 
2474e855dd28SJason M. Bills                     // Add a space for the log entry to the array
2475e855dd28SJason M. Bills                     logEntryArray.push_back({});
2476e855dd28SJason M. Bills                 }
2477e855dd28SJason M. Bills                 // Now go through and set up async calls to fill in the entries
2478e855dd28SJason M. Bills                 size_t index = 0;
2479e855dd28SJason M. Bills                 for (const std::string& logID : logIDs)
2480e855dd28SJason M. Bills                 {
2481e855dd28SJason M. Bills                     // Add the log entry to the array
2482e855dd28SJason M. Bills                     logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
24831da66f75SEd Tanous                 }
2484e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
2485e1f26343SJason M. Bills                     logEntryArray.size();
24861da66f75SEd Tanous             };
24871da66f75SEd Tanous             crow::connections::systemBus->async_method_call(
24881da66f75SEd Tanous                 std::move(getLogEntriesCallback),
24891da66f75SEd Tanous                 "xyz.openbmc_project.ObjectMapper",
24901da66f75SEd Tanous                 "/xyz/openbmc_project/object_mapper",
24911da66f75SEd Tanous                 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
24925b61b5e8SJason M. Bills                 std::array<const char*, 1>{crashdumpInterface});
24937e860f15SJohn Edward Broadbent         });
24941da66f75SEd Tanous }
24951da66f75SEd Tanous 
24967e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app)
24971da66f75SEd Tanous {
24983946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
24993946028dSAppaRao Puli     // method for security reasons.
25001da66f75SEd Tanous 
25017e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
25027e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/")
2503432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
25047e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
25057e860f15SJohn Edward Broadbent             [](const crow::Request&,
25067e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25077e860f15SJohn Edward Broadbent                const std::string& param) {
25087e860f15SJohn Edward Broadbent                 const std::string& logID = param;
2509e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
25107e860f15SJohn Edward Broadbent             });
2511e855dd28SJason M. Bills }
2512e855dd28SJason M. Bills 
25137e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app)
2514e855dd28SJason M. Bills {
25153946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
25163946028dSAppaRao Puli     // method for security reasons.
25177e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
25187e860f15SJohn Edward Broadbent         app,
25197e860f15SJohn Edward Broadbent         "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/")
2520432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
25217e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
25227e860f15SJohn Edward Broadbent             [](const crow::Request&,
25237e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25247e860f15SJohn Edward Broadbent                const std::string& logID, const std::string& fileName) {
2525043a0536SJohnathan Mantey                 auto getStoredLogCallback =
2526043a0536SJohnathan Mantey                     [asyncResp, logID, fileName](
2527abf2add6SEd Tanous                         const boost::system::error_code ec,
25287e860f15SJohn Edward Broadbent                         const std::vector<std::pair<std::string, VariantType>>&
25297e860f15SJohn Edward Broadbent                             resp) {
25301da66f75SEd Tanous                         if (ec)
25311da66f75SEd Tanous                         {
2532043a0536SJohnathan Mantey                             BMCWEB_LOG_DEBUG << "failed to get log ec: "
2533043a0536SJohnathan Mantey                                              << ec.message();
2534f12894f8SJason M. Bills                             messages::internalError(asyncResp->res);
25351da66f75SEd Tanous                             return;
25361da66f75SEd Tanous                         }
2537e855dd28SJason M. Bills 
2538043a0536SJohnathan Mantey                         std::string dbusFilename{};
2539043a0536SJohnathan Mantey                         std::string dbusTimestamp{};
2540043a0536SJohnathan Mantey                         std::string dbusFilepath{};
2541043a0536SJohnathan Mantey 
25427e860f15SJohn Edward Broadbent                         parseCrashdumpParameters(resp, dbusFilename,
25437e860f15SJohn Edward Broadbent                                                  dbusTimestamp, dbusFilepath);
2544043a0536SJohnathan Mantey 
2545043a0536SJohnathan Mantey                         if (dbusFilename.empty() || dbusTimestamp.empty() ||
2546043a0536SJohnathan Mantey                             dbusFilepath.empty())
25471da66f75SEd Tanous                         {
25487e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
25497e860f15SJohn Edward Broadbent                                                            fileName);
25501da66f75SEd Tanous                             return;
25511da66f75SEd Tanous                         }
2552e855dd28SJason M. Bills 
2553043a0536SJohnathan Mantey                         // Verify the file name parameter is correct
2554043a0536SJohnathan Mantey                         if (fileName != dbusFilename)
2555043a0536SJohnathan Mantey                         {
25567e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
25577e860f15SJohn Edward Broadbent                                                            fileName);
2558043a0536SJohnathan Mantey                             return;
2559043a0536SJohnathan Mantey                         }
2560043a0536SJohnathan Mantey 
2561043a0536SJohnathan Mantey                         if (!std::filesystem::exists(dbusFilepath))
2562043a0536SJohnathan Mantey                         {
25637e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
25647e860f15SJohn Edward Broadbent                                                            fileName);
2565043a0536SJohnathan Mantey                             return;
2566043a0536SJohnathan Mantey                         }
2567043a0536SJohnathan Mantey                         std::ifstream ifs(dbusFilepath, std::ios::in |
2568043a0536SJohnathan Mantey                                                             std::ios::binary |
2569043a0536SJohnathan Mantey                                                             std::ios::ate);
2570043a0536SJohnathan Mantey                         std::ifstream::pos_type fileSize = ifs.tellg();
2571043a0536SJohnathan Mantey                         if (fileSize < 0)
2572043a0536SJohnathan Mantey                         {
2573043a0536SJohnathan Mantey                             messages::generalError(asyncResp->res);
2574043a0536SJohnathan Mantey                             return;
2575043a0536SJohnathan Mantey                         }
2576043a0536SJohnathan Mantey                         ifs.seekg(0, std::ios::beg);
2577043a0536SJohnathan Mantey 
2578043a0536SJohnathan Mantey                         auto crashData = std::make_unique<char[]>(
2579043a0536SJohnathan Mantey                             static_cast<unsigned int>(fileSize));
2580043a0536SJohnathan Mantey 
2581043a0536SJohnathan Mantey                         ifs.read(crashData.get(), static_cast<int>(fileSize));
2582043a0536SJohnathan Mantey 
25837e860f15SJohn Edward Broadbent                         // The cast to std::string is intentional in order to
25847e860f15SJohn Edward Broadbent                         // use the assign() that applies move mechanics
2585043a0536SJohnathan Mantey                         asyncResp->res.body().assign(
2586043a0536SJohnathan Mantey                             static_cast<std::string>(crashData.get()));
2587043a0536SJohnathan Mantey 
25887e860f15SJohn Edward Broadbent                         // Configure this to be a file download when accessed
25897e860f15SJohn Edward Broadbent                         // from a browser
25907e860f15SJohn Edward Broadbent                         asyncResp->res.addHeader("Content-Disposition",
25917e860f15SJohn Edward Broadbent                                                  "attachment");
25921da66f75SEd Tanous                     };
25931da66f75SEd Tanous                 crow::connections::systemBus->async_method_call(
25945b61b5e8SJason M. Bills                     std::move(getStoredLogCallback), crashdumpObject,
25955b61b5e8SJason M. Bills                     crashdumpPath + std::string("/") + logID,
25967e860f15SJohn Edward Broadbent                     "org.freedesktop.DBus.Properties", "GetAll",
25977e860f15SJohn Edward Broadbent                     crashdumpInterface);
25987e860f15SJohn Edward Broadbent             });
25991da66f75SEd Tanous }
26001da66f75SEd Tanous 
26017e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app)
26021da66f75SEd Tanous {
26033946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
26043946028dSAppaRao Puli     // method for security reasons.
26057e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/"
26067e860f15SJohn Edward Broadbent                       "Actions/LogService.CollectDiagnosticData/")
2607432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
26087e860f15SJohn Edward Broadbent         .methods(
26097e860f15SJohn Edward Broadbent             boost::beast::http::verb::
26107e860f15SJohn Edward Broadbent                 post)([](const crow::Request& req,
26117e860f15SJohn Edward Broadbent                          const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
26128e6c099aSJason M. Bills             std::string diagnosticDataType;
26138e6c099aSJason M. Bills             std::string oemDiagnosticDataType;
26148e6c099aSJason M. Bills             if (!redfish::json_util::readJson(
26157e860f15SJohn Edward Broadbent                     req, asyncResp->res, "DiagnosticDataType",
26167e860f15SJohn Edward Broadbent                     diagnosticDataType, "OEMDiagnosticDataType",
26177e860f15SJohn Edward Broadbent                     oemDiagnosticDataType))
26188e6c099aSJason M. Bills             {
26198e6c099aSJason M. Bills                 return;
26208e6c099aSJason M. Bills             }
26218e6c099aSJason M. Bills 
26228e6c099aSJason M. Bills             if (diagnosticDataType != "OEM")
26238e6c099aSJason M. Bills             {
26248e6c099aSJason M. Bills                 BMCWEB_LOG_ERROR
26258e6c099aSJason M. Bills                     << "Only OEM DiagnosticDataType supported for Crashdump";
26268e6c099aSJason M. Bills                 messages::actionParameterValueFormatError(
26278e6c099aSJason M. Bills                     asyncResp->res, diagnosticDataType, "DiagnosticDataType",
26288e6c099aSJason M. Bills                     "CollectDiagnosticData");
26298e6c099aSJason M. Bills                 return;
26308e6c099aSJason M. Bills             }
26318e6c099aSJason M. Bills 
26328e6c099aSJason M. Bills             auto collectCrashdumpCallback = [asyncResp, req](
26337e860f15SJohn Edward Broadbent                                                 const boost::system::error_code
26347e860f15SJohn Edward Broadbent                                                     ec,
2635cb13a392SEd Tanous                                                 const std::string&) {
26361da66f75SEd Tanous                 if (ec)
26371da66f75SEd Tanous                 {
26387e860f15SJohn Edward Broadbent                     if (ec.value() ==
26397e860f15SJohn Edward Broadbent                         boost::system::errc::operation_not_supported)
26401da66f75SEd Tanous                     {
2641f12894f8SJason M. Bills                         messages::resourceInStandby(asyncResp->res);
26421da66f75SEd Tanous                     }
26434363d3b2SJason M. Bills                     else if (ec.value() ==
26444363d3b2SJason M. Bills                              boost::system::errc::device_or_resource_busy)
26454363d3b2SJason M. Bills                     {
26464363d3b2SJason M. Bills                         messages::serviceTemporarilyUnavailable(asyncResp->res,
26474363d3b2SJason M. Bills                                                                 "60");
26484363d3b2SJason M. Bills                     }
26491da66f75SEd Tanous                     else
26501da66f75SEd Tanous                     {
2651f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
26521da66f75SEd Tanous                     }
26531da66f75SEd Tanous                     return;
26541da66f75SEd Tanous                 }
26557e860f15SJohn Edward Broadbent                 std::shared_ptr<task::TaskData> task =
26567e860f15SJohn Edward Broadbent                     task::TaskData::createTask(
26577e860f15SJohn Edward Broadbent                         [](boost::system::error_code err,
26587e860f15SJohn Edward Broadbent                            sdbusplus::message::message&,
265966afe4faSJames Feist                            const std::shared_ptr<task::TaskData>& taskData) {
266066afe4faSJames Feist                             if (!err)
266166afe4faSJames Feist                             {
2662e5d5006bSJames Feist                                 taskData->messages.emplace_back(
2663e5d5006bSJames Feist                                     messages::taskCompletedOK(
2664e5d5006bSJames Feist                                         std::to_string(taskData->index)));
2665831d6b09SJames Feist                                 taskData->state = "Completed";
266666afe4faSJames Feist                             }
266732898ceaSJames Feist                             return task::completed;
266866afe4faSJames Feist                         },
26697e860f15SJohn Edward Broadbent                         "type='signal',interface='org.freedesktop.DBus."
26707e860f15SJohn Edward Broadbent                         "Properties',"
267146229577SJames Feist                         "member='PropertiesChanged',arg0namespace='com.intel."
267246229577SJames Feist                         "crashdump'");
267346229577SJames Feist                 task->startTimer(std::chrono::minutes(5));
267446229577SJames Feist                 task->populateResp(asyncResp->res);
2675fe306728SJames Feist                 task->payload.emplace(req);
26761da66f75SEd Tanous             };
26778e6c099aSJason M. Bills 
26788e6c099aSJason M. Bills             if (oemDiagnosticDataType == "OnDemand")
26798e6c099aSJason M. Bills             {
26801da66f75SEd Tanous                 crow::connections::systemBus->async_method_call(
26818e6c099aSJason M. Bills                     std::move(collectCrashdumpCallback), crashdumpObject,
26828e6c099aSJason M. Bills                     crashdumpPath, crashdumpOnDemandInterface,
26838e6c099aSJason M. Bills                     "GenerateOnDemandLog");
26841da66f75SEd Tanous             }
26858e6c099aSJason M. Bills             else if (oemDiagnosticDataType == "Telemetry")
26866eda7685SKenny L. Ku             {
26878e6c099aSJason M. Bills                 crow::connections::systemBus->async_method_call(
26888e6c099aSJason M. Bills                     std::move(collectCrashdumpCallback), crashdumpObject,
26898e6c099aSJason M. Bills                     crashdumpPath, crashdumpTelemetryInterface,
26908e6c099aSJason M. Bills                     "GenerateTelemetryLog");
26916eda7685SKenny L. Ku             }
26926eda7685SKenny L. Ku             else
26936eda7685SKenny L. Ku             {
26948e6c099aSJason M. Bills                 BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: "
26958e6c099aSJason M. Bills                                  << oemDiagnosticDataType;
26968e6c099aSJason M. Bills                 messages::actionParameterValueFormatError(
26977e860f15SJohn Edward Broadbent                     asyncResp->res, oemDiagnosticDataType,
26987e860f15SJohn Edward Broadbent                     "OEMDiagnosticDataType", "CollectDiagnosticData");
26996eda7685SKenny L. Ku                 return;
27006eda7685SKenny L. Ku             }
27017e860f15SJohn Edward Broadbent         });
27026eda7685SKenny L. Ku }
27036eda7685SKenny L. Ku 
2704cb92c03bSAndrew Geissler /**
2705cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
2706cb92c03bSAndrew Geissler  */
27077e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app)
2708cb92c03bSAndrew Geissler {
2709cb92c03bSAndrew Geissler     /**
2710cb92c03bSAndrew Geissler      * Function handles POST method request.
2711cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
2712cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
2713cb92c03bSAndrew Geissler      */
27147e860f15SJohn Edward Broadbent 
27157e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
27167e860f15SJohn Edward Broadbent                       "LogService.ClearLog/")
2717432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
27187e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
27197e860f15SJohn Edward Broadbent             [](const crow::Request&,
27207e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2721cb92c03bSAndrew Geissler                 BMCWEB_LOG_DEBUG << "Do delete all entries.";
2722cb92c03bSAndrew Geissler 
2723cb92c03bSAndrew Geissler                 // Process response from Logging service.
27247e860f15SJohn Edward Broadbent                 auto respHandler = [asyncResp](
27257e860f15SJohn Edward Broadbent                                        const boost::system::error_code ec) {
27267e860f15SJohn Edward Broadbent                     BMCWEB_LOG_DEBUG
27277e860f15SJohn Edward Broadbent                         << "doClearLog resp_handler callback: Done";
2728cb92c03bSAndrew Geissler                     if (ec)
2729cb92c03bSAndrew Geissler                     {
2730cb92c03bSAndrew Geissler                         // TODO Handle for specific error code
27317e860f15SJohn Edward Broadbent                         BMCWEB_LOG_ERROR << "doClearLog resp_handler got error "
27327e860f15SJohn Edward Broadbent                                          << ec;
2733cb92c03bSAndrew Geissler                         asyncResp->res.result(
2734cb92c03bSAndrew Geissler                             boost::beast::http::status::internal_server_error);
2735cb92c03bSAndrew Geissler                         return;
2736cb92c03bSAndrew Geissler                     }
2737cb92c03bSAndrew Geissler 
27387e860f15SJohn Edward Broadbent                     asyncResp->res.result(
27397e860f15SJohn Edward Broadbent                         boost::beast::http::status::no_content);
2740cb92c03bSAndrew Geissler                 };
2741cb92c03bSAndrew Geissler 
2742cb92c03bSAndrew Geissler                 // Make call to Logging service to request Clear Log
2743cb92c03bSAndrew Geissler                 crow::connections::systemBus->async_method_call(
27442c70f800SEd Tanous                     respHandler, "xyz.openbmc_project.Logging",
2745cb92c03bSAndrew Geissler                     "/xyz/openbmc_project/logging",
2746cb92c03bSAndrew Geissler                     "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
27477e860f15SJohn Edward Broadbent             });
2748cb92c03bSAndrew Geissler }
2749a3316fc6SZhikuiRen 
2750a3316fc6SZhikuiRen /****************************************************
2751a3316fc6SZhikuiRen  * Redfish PostCode interfaces
2752a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
2753a3316fc6SZhikuiRen  ******************************************************/
27547e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app)
2755a3316fc6SZhikuiRen {
27567e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
2757432a890cSEd Tanous         .privileges({{"Login"}})
27587e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
27597e860f15SJohn Edward Broadbent             [](const crow::Request&,
27607e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2761a3316fc6SZhikuiRen                 asyncResp->res.jsonValue = {
27627e860f15SJohn Edward Broadbent                     {"@odata.id",
27637e860f15SJohn Edward Broadbent                      "/redfish/v1/Systems/system/LogServices/PostCodes"},
2764a3316fc6SZhikuiRen                     {"@odata.type", "#LogService.v1_1_0.LogService"},
2765a3316fc6SZhikuiRen                     {"Name", "POST Code Log Service"},
2766a3316fc6SZhikuiRen                     {"Description", "POST Code Log Service"},
2767a3316fc6SZhikuiRen                     {"Id", "BIOS POST Code Log"},
2768a3316fc6SZhikuiRen                     {"OverWritePolicy", "WrapsWhenFull"},
2769a3316fc6SZhikuiRen                     {"Entries",
27707e860f15SJohn Edward Broadbent                      {{"@odata.id", "/redfish/v1/Systems/system/LogServices/"
27717e860f15SJohn Edward Broadbent                                     "PostCodes/Entries"}}}};
2772*7c8c4058STejas Patil 
2773*7c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
2774*7c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
2775*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
2776*7c8c4058STejas Patil                     redfishDateTimeOffset.first;
2777*7c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2778*7c8c4058STejas Patil                     redfishDateTimeOffset.second;
2779*7c8c4058STejas Patil 
2780a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
27817e860f15SJohn Edward Broadbent                     {"target",
27827e860f15SJohn Edward Broadbent                      "/redfish/v1/Systems/system/LogServices/PostCodes/"
2783a3316fc6SZhikuiRen                      "Actions/LogService.ClearLog"}};
27847e860f15SJohn Edward Broadbent             });
2785a3316fc6SZhikuiRen }
2786a3316fc6SZhikuiRen 
27877e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app)
2788a3316fc6SZhikuiRen {
27897e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
27907e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
2791a3316fc6SZhikuiRen                  "LogService.ClearLog/")
2792432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
27937e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
27947e860f15SJohn Edward Broadbent             [](const crow::Request&,
27957e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2796a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
2797a3316fc6SZhikuiRen 
2798a3316fc6SZhikuiRen                 // Make call to post-code service to request clear all
2799a3316fc6SZhikuiRen                 crow::connections::systemBus->async_method_call(
2800a3316fc6SZhikuiRen                     [asyncResp](const boost::system::error_code ec) {
2801a3316fc6SZhikuiRen                         if (ec)
2802a3316fc6SZhikuiRen                         {
2803a3316fc6SZhikuiRen                             // TODO Handle for specific error code
2804a3316fc6SZhikuiRen                             BMCWEB_LOG_ERROR
28057e860f15SJohn Edward Broadbent                                 << "doClearPostCodes resp_handler got error "
28067e860f15SJohn Edward Broadbent                                 << ec;
28077e860f15SJohn Edward Broadbent                             asyncResp->res.result(boost::beast::http::status::
28087e860f15SJohn Edward Broadbent                                                       internal_server_error);
2809a3316fc6SZhikuiRen                             messages::internalError(asyncResp->res);
2810a3316fc6SZhikuiRen                             return;
2811a3316fc6SZhikuiRen                         }
2812a3316fc6SZhikuiRen                     },
281315124765SJonathan Doman                     "xyz.openbmc_project.State.Boot.PostCode0",
281415124765SJonathan Doman                     "/xyz/openbmc_project/State/Boot/PostCode0",
2815a3316fc6SZhikuiRen                     "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
28167e860f15SJohn Edward Broadbent             });
2817a3316fc6SZhikuiRen }
2818a3316fc6SZhikuiRen 
2819a3316fc6SZhikuiRen static void fillPostCodeEntry(
28208d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& aResp,
28216c9a279eSManojkiran Eda     const boost::container::flat_map<
28226c9a279eSManojkiran Eda         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
2823a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
2824a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
2825a3316fc6SZhikuiRen {
2826a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
2827a3316fc6SZhikuiRen     const message_registries::Message* message =
28284a0bf539SManojkiran Eda         message_registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
2829a3316fc6SZhikuiRen 
2830a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
2831a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
2832a3316fc6SZhikuiRen 
2833a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
28346c9a279eSManojkiran Eda     for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
28356c9a279eSManojkiran Eda              code : postcode)
2836a3316fc6SZhikuiRen     {
2837a3316fc6SZhikuiRen         currentCodeIndex++;
2838a3316fc6SZhikuiRen         std::string postcodeEntryID =
2839a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
2840a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
2841a3316fc6SZhikuiRen 
2842a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
2843a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
2844a3316fc6SZhikuiRen 
2845a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
2846a3316fc6SZhikuiRen         { // already incremented
2847a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
2848a3316fc6SZhikuiRen         }
2849a3316fc6SZhikuiRen         else
2850a3316fc6SZhikuiRen         {
2851a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
2852a3316fc6SZhikuiRen         }
2853a3316fc6SZhikuiRen 
2854a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
2855a3316fc6SZhikuiRen         // not fall between top and skip
2856a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
2857a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
2858a3316fc6SZhikuiRen         {
2859a3316fc6SZhikuiRen             continue;
2860a3316fc6SZhikuiRen         }
2861a3316fc6SZhikuiRen 
28624e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
2863a3316fc6SZhikuiRen         // currentIndex
2864a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
2865a3316fc6SZhikuiRen         {
2866a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
2867a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
2868a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
2869a3316fc6SZhikuiRen             continue;
2870a3316fc6SZhikuiRen         }
2871a3316fc6SZhikuiRen 
2872a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
2873a3316fc6SZhikuiRen         // index
2874a3316fc6SZhikuiRen 
2875a3316fc6SZhikuiRen         // Get the Created time from the timestamp
2876a3316fc6SZhikuiRen         std::string entryTimeStr;
28779c620e21SAsmitha Karunanithi         entryTimeStr = crow::utility::getDateTime(
28789c620e21SAsmitha Karunanithi             static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000));
2879a3316fc6SZhikuiRen 
2880a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
2881a3316fc6SZhikuiRen         std::ostringstream hexCode;
2882a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
28836c9a279eSManojkiran Eda                 << std::get<0>(code.second);
2884a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
2885a3316fc6SZhikuiRen         // Set Fixed -Point Notation
2886a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
2887a3316fc6SZhikuiRen         // Set precision to 4 digits
2888a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
2889a3316fc6SZhikuiRen         // Add double to stream
2890a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
2891a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
2892a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
2893a3316fc6SZhikuiRen 
2894a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
2895a3316fc6SZhikuiRen         std::string msg;
2896a3316fc6SZhikuiRen         if (message != nullptr)
2897a3316fc6SZhikuiRen         {
2898a3316fc6SZhikuiRen             msg = message->message;
2899a3316fc6SZhikuiRen 
2900a3316fc6SZhikuiRen             // fill in this post code value
2901a3316fc6SZhikuiRen             int i = 0;
2902a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
2903a3316fc6SZhikuiRen             {
2904a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
2905a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
2906a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
2907a3316fc6SZhikuiRen                 {
2908a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
2909a3316fc6SZhikuiRen                 }
2910a3316fc6SZhikuiRen             }
2911a3316fc6SZhikuiRen         }
2912a3316fc6SZhikuiRen 
2913d4342a92STim Lee         // Get Severity template from message registry
2914d4342a92STim Lee         std::string severity;
2915d4342a92STim Lee         if (message != nullptr)
2916d4342a92STim Lee         {
2917d4342a92STim Lee             severity = message->severity;
2918d4342a92STim Lee         }
2919d4342a92STim Lee 
2920a3316fc6SZhikuiRen         // add to AsyncResp
2921a3316fc6SZhikuiRen         logEntryArray.push_back({});
2922a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
29230ef217f4SGeorge Liu         bmcLogEntry = {{"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
2924a3316fc6SZhikuiRen                        {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
2925a3316fc6SZhikuiRen                                      "PostCodes/Entries/" +
2926a3316fc6SZhikuiRen                                          postcodeEntryID},
2927a3316fc6SZhikuiRen                        {"Name", "POST Code Log Entry"},
2928a3316fc6SZhikuiRen                        {"Id", postcodeEntryID},
2929a3316fc6SZhikuiRen                        {"Message", std::move(msg)},
29304a0bf539SManojkiran Eda                        {"MessageId", "OpenBMC.0.2.BIOSPOSTCode"},
2931a3316fc6SZhikuiRen                        {"MessageArgs", std::move(messageArgs)},
2932a3316fc6SZhikuiRen                        {"EntryType", "Event"},
2933a3316fc6SZhikuiRen                        {"Severity", std::move(severity)},
29349c620e21SAsmitha Karunanithi                        {"Created", entryTimeStr}};
29350ef217f4SGeorge Liu 
29360ef217f4SGeorge Liu         if (std::get<std::vector<uint8_t>>(code.second).size())
29370ef217f4SGeorge Liu         {
29380ef217f4SGeorge Liu             bmcLogEntry["AdditionalDataURI"] =
29390ef217f4SGeorge Liu                 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
29400ef217f4SGeorge Liu                 postcodeEntryID + "/attachment";
29410ef217f4SGeorge Liu         }
2942a3316fc6SZhikuiRen     }
2943a3316fc6SZhikuiRen }
2944a3316fc6SZhikuiRen 
29458d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
2946a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
2947a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
2948a3316fc6SZhikuiRen {
2949a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
29506c9a279eSManojkiran Eda         [aResp, bootIndex,
29516c9a279eSManojkiran Eda          codeIndex](const boost::system::error_code ec,
29526c9a279eSManojkiran Eda                     const boost::container::flat_map<
29536c9a279eSManojkiran Eda                         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
29546c9a279eSManojkiran Eda                         postcode) {
2955a3316fc6SZhikuiRen             if (ec)
2956a3316fc6SZhikuiRen             {
2957a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
2958a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2959a3316fc6SZhikuiRen                 return;
2960a3316fc6SZhikuiRen             }
2961a3316fc6SZhikuiRen 
2962a3316fc6SZhikuiRen             // skip the empty postcode boots
2963a3316fc6SZhikuiRen             if (postcode.empty())
2964a3316fc6SZhikuiRen             {
2965a3316fc6SZhikuiRen                 return;
2966a3316fc6SZhikuiRen             }
2967a3316fc6SZhikuiRen 
2968a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
2969a3316fc6SZhikuiRen 
2970a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
2971a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
2972a3316fc6SZhikuiRen         },
297315124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
297415124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
2975a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
2976a3316fc6SZhikuiRen         bootIndex);
2977a3316fc6SZhikuiRen }
2978a3316fc6SZhikuiRen 
29798d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
2980a3316fc6SZhikuiRen                                const uint16_t bootIndex,
2981a3316fc6SZhikuiRen                                const uint16_t bootCount,
2982a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
2983a3316fc6SZhikuiRen                                const uint64_t top)
2984a3316fc6SZhikuiRen {
2985a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
2986a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
2987a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
29886c9a279eSManojkiran Eda               const boost::container::flat_map<
29896c9a279eSManojkiran Eda                   uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
29906c9a279eSManojkiran Eda                   postcode) {
2991a3316fc6SZhikuiRen             if (ec)
2992a3316fc6SZhikuiRen             {
2993a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
2994a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2995a3316fc6SZhikuiRen                 return;
2996a3316fc6SZhikuiRen             }
2997a3316fc6SZhikuiRen 
2998a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
2999a3316fc6SZhikuiRen             if (!postcode.empty())
3000a3316fc6SZhikuiRen             {
3001a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
3002a3316fc6SZhikuiRen 
3003a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
3004a3316fc6SZhikuiRen                 {
3005a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
3006a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
3007a3316fc6SZhikuiRen                     uint64_t thisBootTop =
3008a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
3009a3316fc6SZhikuiRen 
3010a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3011a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
3012a3316fc6SZhikuiRen                 }
3013a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
3014a3316fc6SZhikuiRen             }
3015a3316fc6SZhikuiRen 
3016a3316fc6SZhikuiRen             // continue to previous bootIndex
3017a3316fc6SZhikuiRen             if (bootIndex < bootCount)
3018a3316fc6SZhikuiRen             {
3019a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3020a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
3021a3316fc6SZhikuiRen             }
3022a3316fc6SZhikuiRen             else
3023a3316fc6SZhikuiRen             {
3024a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
3025a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3026a3316fc6SZhikuiRen                     "Entries?$skip=" +
3027a3316fc6SZhikuiRen                     std::to_string(skip + top);
3028a3316fc6SZhikuiRen             }
3029a3316fc6SZhikuiRen         },
303015124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
303115124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3032a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3033a3316fc6SZhikuiRen         bootIndex);
3034a3316fc6SZhikuiRen }
3035a3316fc6SZhikuiRen 
30368d1b46d7Szhanghch05 static void
30378d1b46d7Szhanghch05     getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3038a3316fc6SZhikuiRen                          const uint64_t skip, const uint64_t top)
3039a3316fc6SZhikuiRen {
3040a3316fc6SZhikuiRen     uint64_t entryCount = 0;
3041a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3042a3316fc6SZhikuiRen         [aResp, entryCount, skip,
3043a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3044a3316fc6SZhikuiRen               const std::variant<uint16_t>& bootCount) {
3045a3316fc6SZhikuiRen             if (ec)
3046a3316fc6SZhikuiRen             {
3047a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3048a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3049a3316fc6SZhikuiRen                 return;
3050a3316fc6SZhikuiRen             }
3051a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
3052a3316fc6SZhikuiRen             if (pVal)
3053a3316fc6SZhikuiRen             {
3054a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
3055a3316fc6SZhikuiRen             }
3056a3316fc6SZhikuiRen             else
3057a3316fc6SZhikuiRen             {
3058a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
3059a3316fc6SZhikuiRen             }
3060a3316fc6SZhikuiRen         },
306115124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
306215124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3063a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
3064a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
3065a3316fc6SZhikuiRen }
3066a3316fc6SZhikuiRen 
3067af61db10SGeorge Liu inline static bool parsePostCode(std::string postCodeID, uint64_t& currentValue,
3068af61db10SGeorge Liu                                  uint16_t& index)
3069af61db10SGeorge Liu {
3070af61db10SGeorge Liu     // postCodeID = B1-1
3071af61db10SGeorge Liu     std::vector<std::string> split;
3072af61db10SGeorge Liu     boost::algorithm::split(split, postCodeID, boost::is_any_of("-"));
3073af61db10SGeorge Liu     if (split.size() != 2 || split[0].length() < 2)
3074af61db10SGeorge Liu     {
3075af61db10SGeorge Liu         return false;
3076af61db10SGeorge Liu     }
3077af61db10SGeorge Liu 
3078af61db10SGeorge Liu     const char* start = split[0].data() + 1;
3079af61db10SGeorge Liu     const char* end = split[0].data() + split[0].size();
3080af61db10SGeorge Liu     auto [ptrIndex, ecIndex] = std::from_chars(start, end, index);
3081af61db10SGeorge Liu 
3082af61db10SGeorge Liu     if (ptrIndex != end || ecIndex != std::errc() || !index)
3083af61db10SGeorge Liu     {
3084af61db10SGeorge Liu         return false;
3085af61db10SGeorge Liu     }
3086af61db10SGeorge Liu 
3087af61db10SGeorge Liu     start = split[1].data();
3088af61db10SGeorge Liu     end = split[1].data() + split[1].size();
3089af61db10SGeorge Liu     auto [ptrValue, ecValue] = std::from_chars(start, end, currentValue);
3090af61db10SGeorge Liu     if (ptrValue != end || ecValue != std::errc() || !currentValue)
3091af61db10SGeorge Liu     {
3092af61db10SGeorge Liu         return false;
3093af61db10SGeorge Liu     }
3094af61db10SGeorge Liu 
3095af61db10SGeorge Liu     return true;
3096af61db10SGeorge Liu }
3097af61db10SGeorge Liu 
3098af61db10SGeorge Liu inline void requestRoutesPostCodesEntryAdditionalData(App& app)
3099af61db10SGeorge Liu {
3100af61db10SGeorge Liu     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/"
3101af61db10SGeorge Liu                       "Entries/<str>/attachment/")
3102af61db10SGeorge Liu         .privileges({"Login"})
3103af61db10SGeorge Liu         .methods(boost::beast::http::verb::get)(
3104af61db10SGeorge Liu             [](const crow::Request& req,
3105af61db10SGeorge Liu                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3106af61db10SGeorge Liu                const std::string& postCodeID) {
3107af61db10SGeorge Liu                 if (!http_helpers::isOctetAccepted(req))
3108af61db10SGeorge Liu                 {
3109af61db10SGeorge Liu                     asyncResp->res.result(
3110af61db10SGeorge Liu                         boost::beast::http::status::bad_request);
3111af61db10SGeorge Liu                     return;
3112af61db10SGeorge Liu                 }
3113af61db10SGeorge Liu 
3114af61db10SGeorge Liu                 uint64_t currentValue = 0;
3115af61db10SGeorge Liu                 uint16_t index = 0;
3116af61db10SGeorge Liu                 if (!parsePostCode(postCodeID, currentValue, index))
3117af61db10SGeorge Liu                 {
3118af61db10SGeorge Liu                     messages::resourceNotFound(asyncResp->res, "LogEntry",
3119af61db10SGeorge Liu                                                postCodeID);
3120af61db10SGeorge Liu                     return;
3121af61db10SGeorge Liu                 }
3122af61db10SGeorge Liu 
3123af61db10SGeorge Liu                 crow::connections::systemBus->async_method_call(
3124af61db10SGeorge Liu                     [asyncResp, postCodeID, currentValue](
3125af61db10SGeorge Liu                         const boost::system::error_code ec,
3126af61db10SGeorge Liu                         const std::vector<std::tuple<
3127af61db10SGeorge Liu                             uint64_t, std::vector<uint8_t>>>& postcodes) {
3128af61db10SGeorge Liu                         if (ec.value() == EBADR)
3129af61db10SGeorge Liu                         {
3130af61db10SGeorge Liu                             messages::resourceNotFound(asyncResp->res,
3131af61db10SGeorge Liu                                                        "LogEntry", postCodeID);
3132af61db10SGeorge Liu                             return;
3133af61db10SGeorge Liu                         }
3134af61db10SGeorge Liu                         if (ec)
3135af61db10SGeorge Liu                         {
3136af61db10SGeorge Liu                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3137af61db10SGeorge Liu                             messages::internalError(asyncResp->res);
3138af61db10SGeorge Liu                             return;
3139af61db10SGeorge Liu                         }
3140af61db10SGeorge Liu 
3141af61db10SGeorge Liu                         if (currentValue < 1 ||
3142af61db10SGeorge Liu                             postcodes.size() <= currentValue)
3143af61db10SGeorge Liu                         {
3144af61db10SGeorge Liu                             BMCWEB_LOG_ERROR << "Wrong currentValue value";
3145af61db10SGeorge Liu                             messages::resourceNotFound(asyncResp->res,
3146af61db10SGeorge Liu                                                        "LogEntry", postCodeID);
3147af61db10SGeorge Liu                             return;
3148af61db10SGeorge Liu                         }
3149af61db10SGeorge Liu 
3150af61db10SGeorge Liu                         size_t value = static_cast<size_t>(currentValue) - 1;
3151af61db10SGeorge Liu                         auto& [tID, code] = postcodes[value];
3152af61db10SGeorge Liu 
3153af61db10SGeorge Liu                         if (code.size() == 0)
3154af61db10SGeorge Liu                         {
3155af61db10SGeorge Liu                             BMCWEB_LOG_INFO << "No found post code data";
3156af61db10SGeorge Liu                             messages::internalError(asyncResp->res);
3157af61db10SGeorge Liu                             return;
3158af61db10SGeorge Liu                         }
3159af61db10SGeorge Liu 
3160af61db10SGeorge Liu                         std::string_view strData(
3161af61db10SGeorge Liu                             reinterpret_cast<const char*>(code.data()),
3162af61db10SGeorge Liu                             code.size());
3163af61db10SGeorge Liu 
3164af61db10SGeorge Liu                         asyncResp->res.addHeader("Content-Type",
3165af61db10SGeorge Liu                                                  "application/octet-stream");
3166af61db10SGeorge Liu                         asyncResp->res.addHeader("Content-Transfer-Encoding",
3167af61db10SGeorge Liu                                                  "Base64");
3168af61db10SGeorge Liu                         asyncResp->res.body() =
3169af61db10SGeorge Liu                             std::move(crow::utility::base64encode(strData));
3170af61db10SGeorge Liu                     },
3171af61db10SGeorge Liu                     "xyz.openbmc_project.State.Boot.PostCode0",
3172af61db10SGeorge Liu                     "/xyz/openbmc_project/State/Boot/PostCode0",
3173af61db10SGeorge Liu                     "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes",
3174af61db10SGeorge Liu                     index);
3175af61db10SGeorge Liu             });
3176af61db10SGeorge Liu }
3177af61db10SGeorge Liu 
31787e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app)
3179a3316fc6SZhikuiRen {
31807e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
31817e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3182432a890cSEd Tanous         .privileges({{"Login"}})
31837e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
31847e860f15SJohn Edward Broadbent             [](const crow::Request& req,
31857e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
3186a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.type"] =
3187a3316fc6SZhikuiRen                     "#LogEntryCollection.LogEntryCollection";
3188a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.id"] =
3189a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3190a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3191a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Description"] =
3192a3316fc6SZhikuiRen                     "Collection of POST Code Log Entries";
3193a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3194a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3195a3316fc6SZhikuiRen 
3196a3316fc6SZhikuiRen                 uint64_t skip = 0;
3197a3316fc6SZhikuiRen                 uint64_t top = maxEntriesPerPage; // Show max entries by default
31988d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
3199a3316fc6SZhikuiRen                 {
3200a3316fc6SZhikuiRen                     return;
3201a3316fc6SZhikuiRen                 }
32028d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
3203a3316fc6SZhikuiRen                 {
3204a3316fc6SZhikuiRen                     return;
3205a3316fc6SZhikuiRen                 }
3206a3316fc6SZhikuiRen                 getCurrentBootNumber(asyncResp, skip, top);
32077e860f15SJohn Edward Broadbent             });
3208a3316fc6SZhikuiRen }
3209a3316fc6SZhikuiRen 
32107e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app)
3211a3316fc6SZhikuiRen {
32127e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
32137e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/")
3214432a890cSEd Tanous         .privileges({{"Login"}})
32157e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
32167e860f15SJohn Edward Broadbent             [](const crow::Request&,
32177e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
32187e860f15SJohn Edward Broadbent                const std::string& targetID) {
3219a3316fc6SZhikuiRen                 size_t bootPos = targetID.find('B');
3220a3316fc6SZhikuiRen                 if (bootPos == std::string::npos)
3221a3316fc6SZhikuiRen                 {
3222a3316fc6SZhikuiRen                     // Requested ID was not found
3223a3316fc6SZhikuiRen                     messages::resourceMissingAtURI(asyncResp->res, targetID);
3224a3316fc6SZhikuiRen                     return;
3225a3316fc6SZhikuiRen                 }
3226a3316fc6SZhikuiRen                 std::string_view bootIndexStr(targetID);
3227a3316fc6SZhikuiRen                 bootIndexStr.remove_prefix(bootPos + 1);
3228a3316fc6SZhikuiRen                 uint16_t bootIndex = 0;
3229a3316fc6SZhikuiRen                 uint64_t codeIndex = 0;
3230a3316fc6SZhikuiRen                 size_t dashPos = bootIndexStr.find('-');
3231a3316fc6SZhikuiRen 
3232a3316fc6SZhikuiRen                 if (dashPos == std::string::npos)
3233a3316fc6SZhikuiRen                 {
3234a3316fc6SZhikuiRen                     return;
3235a3316fc6SZhikuiRen                 }
3236a3316fc6SZhikuiRen                 std::string_view codeIndexStr(bootIndexStr);
3237a3316fc6SZhikuiRen                 bootIndexStr.remove_suffix(dashPos);
3238a3316fc6SZhikuiRen                 codeIndexStr.remove_prefix(dashPos + 1);
3239a3316fc6SZhikuiRen 
3240a3316fc6SZhikuiRen                 bootIndex = static_cast<uint16_t>(
324123a21a1cSEd Tanous                     strtoul(std::string(bootIndexStr).c_str(), nullptr, 0));
32427e860f15SJohn Edward Broadbent                 codeIndex =
32437e860f15SJohn Edward Broadbent                     strtoul(std::string(codeIndexStr).c_str(), nullptr, 0);
3244a3316fc6SZhikuiRen                 if (bootIndex == 0 || codeIndex == 0)
3245a3316fc6SZhikuiRen                 {
3246a3316fc6SZhikuiRen                     BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
32477e860f15SJohn Edward Broadbent                                      << targetID;
3248a3316fc6SZhikuiRen                 }
3249a3316fc6SZhikuiRen 
32507e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["@odata.type"] =
32517e860f15SJohn Edward Broadbent                     "#LogEntry.v1_4_0.LogEntry";
3252a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.id"] =
3253a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3254a3316fc6SZhikuiRen                     "Entries";
3255a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3256a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Description"] =
3257a3316fc6SZhikuiRen                     "Collection of POST Code Log Entries";
3258a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3259a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3260a3316fc6SZhikuiRen 
3261a3316fc6SZhikuiRen                 getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
32627e860f15SJohn Edward Broadbent             });
3263a3316fc6SZhikuiRen }
3264a3316fc6SZhikuiRen 
32651da66f75SEd Tanous } // namespace redfish
3266