xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision b2a3289d6f86756da4bd500b6a53b1628fffcf37)
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 
184851d45dSJason M. Bills #include "registries.hpp"
194851d45dSJason M. Bills #include "registries/base_message_registry.hpp"
204851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp"
2146229577SJames Feist #include "task.hpp"
221da66f75SEd Tanous 
23e1f26343SJason M. Bills #include <systemd/sd-journal.h>
24400fd1fbSAdriana Kobylak #include <unistd.h>
25e1f26343SJason M. Bills 
267e860f15SJohn Edward Broadbent #include <app.hpp>
27400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp>
284851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp>
294851d45dSJason M. Bills #include <boost/beast/core/span.hpp>
30400fd1fbSAdriana Kobylak #include <boost/beast/http.hpp>
311da66f75SEd Tanous #include <boost/container/flat_map.hpp>
321ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp>
33cb92c03bSAndrew Geissler #include <error_messages.hpp>
34ed398213SEd Tanous #include <registries/privilege_registry.hpp>
351214b7e7SGunnar Mills 
364418c7f0SJames Feist #include <filesystem>
3775710de2SXiaochao Ma #include <optional>
38cd225da8SJason M. Bills #include <string_view>
39abf2add6SEd Tanous #include <variant>
401da66f75SEd Tanous 
411da66f75SEd Tanous namespace redfish
421da66f75SEd Tanous {
431da66f75SEd Tanous 
445b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump";
455b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump";
465b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump";
475b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
485b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
495b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
50424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
516eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface =
526eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
531da66f75SEd Tanous 
544851d45dSJason M. Bills namespace message_registries
554851d45dSJason M. Bills {
564851d45dSJason M. Bills static const Message* getMessageFromRegistry(
574851d45dSJason M. Bills     const std::string& messageKey,
584851d45dSJason M. Bills     const boost::beast::span<const MessageEntry> registry)
594851d45dSJason M. Bills {
604851d45dSJason M. Bills     boost::beast::span<const MessageEntry>::const_iterator messageIt =
614851d45dSJason M. Bills         std::find_if(registry.cbegin(), registry.cend(),
624851d45dSJason M. Bills                      [&messageKey](const MessageEntry& messageEntry) {
634851d45dSJason M. Bills                          return !std::strcmp(messageEntry.first,
644851d45dSJason M. Bills                                              messageKey.c_str());
654851d45dSJason M. Bills                      });
664851d45dSJason M. Bills     if (messageIt != registry.cend())
674851d45dSJason M. Bills     {
684851d45dSJason M. Bills         return &messageIt->second;
694851d45dSJason M. Bills     }
704851d45dSJason M. Bills 
714851d45dSJason M. Bills     return nullptr;
724851d45dSJason M. Bills }
734851d45dSJason M. Bills 
744851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
754851d45dSJason M. Bills {
764851d45dSJason M. Bills     // Redfish MessageIds are in the form
774851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
784851d45dSJason M. Bills     // the right Message
794851d45dSJason M. Bills     std::vector<std::string> fields;
804851d45dSJason M. Bills     fields.reserve(4);
814851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
824851d45dSJason M. Bills     std::string& registryName = fields[0];
834851d45dSJason M. Bills     std::string& messageKey = fields[3];
844851d45dSJason M. Bills 
854851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
864851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
874851d45dSJason M. Bills     {
884851d45dSJason M. Bills         return getMessageFromRegistry(
894851d45dSJason M. Bills             messageKey, boost::beast::span<const MessageEntry>(base::registry));
904851d45dSJason M. Bills     }
914851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
924851d45dSJason M. Bills     {
934851d45dSJason M. Bills         return getMessageFromRegistry(
944851d45dSJason M. Bills             messageKey,
954851d45dSJason M. Bills             boost::beast::span<const MessageEntry>(openbmc::registry));
964851d45dSJason M. Bills     }
974851d45dSJason M. Bills     return nullptr;
984851d45dSJason M. Bills }
994851d45dSJason M. Bills } // namespace message_registries
1004851d45dSJason M. Bills 
101f6150403SJames Feist namespace fs = std::filesystem;
1021da66f75SEd Tanous 
103cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map<
10419bd78d9SPatrick Williams     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
105cb92c03bSAndrew Geissler                               int32_t, uint32_t, int64_t, uint64_t, double>>;
106cb92c03bSAndrew Geissler 
107cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map<
108cb92c03bSAndrew Geissler     sdbusplus::message::object_path,
109cb92c03bSAndrew Geissler     boost::container::flat_map<std::string, GetManagedPropertyType>>;
110cb92c03bSAndrew Geissler 
111cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
112cb92c03bSAndrew Geissler {
113d4d25793SEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
114d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
115d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
116d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
117cb92c03bSAndrew Geissler     {
118cb92c03bSAndrew Geissler         return "Critical";
119cb92c03bSAndrew Geissler     }
1203174e4dfSEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
121d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
122d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
123cb92c03bSAndrew Geissler     {
124cb92c03bSAndrew Geissler         return "OK";
125cb92c03bSAndrew Geissler     }
1263174e4dfSEd Tanous     if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
127cb92c03bSAndrew Geissler     {
128cb92c03bSAndrew Geissler         return "Warning";
129cb92c03bSAndrew Geissler     }
130cb92c03bSAndrew Geissler     return "";
131cb92c03bSAndrew Geissler }
132cb92c03bSAndrew Geissler 
1337e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
13439e77504SEd Tanous                                      const std::string_view& field,
13539e77504SEd Tanous                                      std::string_view& contents)
13616428a1aSJason M. Bills {
13716428a1aSJason M. Bills     const char* data = nullptr;
13816428a1aSJason M. Bills     size_t length = 0;
13916428a1aSJason M. Bills     int ret = 0;
14016428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
141271584abSEd Tanous     ret = sd_journal_get_data(journal, field.data(),
142271584abSEd Tanous                               reinterpret_cast<const void**>(&data), &length);
14316428a1aSJason M. Bills     if (ret < 0)
14416428a1aSJason M. Bills     {
14516428a1aSJason M. Bills         return ret;
14616428a1aSJason M. Bills     }
14739e77504SEd Tanous     contents = std::string_view(data, length);
14816428a1aSJason M. Bills     // Only use the content after the "=" character.
14981ce609eSEd Tanous     contents.remove_prefix(std::min(contents.find('=') + 1, contents.size()));
15016428a1aSJason M. Bills     return ret;
15116428a1aSJason M. Bills }
15216428a1aSJason M. Bills 
1537e860f15SJohn Edward Broadbent inline static int getJournalMetadata(sd_journal* journal,
1547e860f15SJohn Edward Broadbent                                      const std::string_view& field,
1557e860f15SJohn Edward Broadbent                                      const int& base, long int& contents)
15616428a1aSJason M. Bills {
15716428a1aSJason M. Bills     int ret = 0;
15839e77504SEd Tanous     std::string_view metadata;
15916428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
16016428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
16116428a1aSJason M. Bills     if (ret < 0)
16216428a1aSJason M. Bills     {
16316428a1aSJason M. Bills         return ret;
16416428a1aSJason M. Bills     }
165b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
16616428a1aSJason M. Bills     return ret;
16716428a1aSJason M. Bills }
16816428a1aSJason M. Bills 
1697e860f15SJohn Edward Broadbent inline static bool getEntryTimestamp(sd_journal* journal,
1707e860f15SJohn Edward Broadbent                                      std::string& entryTimestamp)
171a3316fc6SZhikuiRen {
172a3316fc6SZhikuiRen     int ret = 0;
173a3316fc6SZhikuiRen     uint64_t timestamp = 0;
174a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
175a3316fc6SZhikuiRen     if (ret < 0)
176a3316fc6SZhikuiRen     {
177a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
178a3316fc6SZhikuiRen                          << strerror(-ret);
179a3316fc6SZhikuiRen         return false;
180a3316fc6SZhikuiRen     }
1819c620e21SAsmitha Karunanithi     entryTimestamp = crow::utility::getDateTime(
1829c620e21SAsmitha Karunanithi         static_cast<std::time_t>(timestamp / 1000 / 1000));
1839c620e21SAsmitha Karunanithi     return true;
184a3316fc6SZhikuiRen }
185a3316fc6SZhikuiRen 
1868d1b46d7Szhanghch05 static bool getSkipParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1878d1b46d7Szhanghch05                          const crow::Request& req, uint64_t& skip)
18816428a1aSJason M. Bills {
1895a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
1905a7e877eSJames Feist         req.urlParams.find("$skip");
1915a7e877eSJames Feist     if (it != req.urlParams.end())
19216428a1aSJason M. Bills     {
1935a7e877eSJames Feist         std::string skipParam = it->value();
19416428a1aSJason M. Bills         char* ptr = nullptr;
1955a7e877eSJames Feist         skip = std::strtoul(skipParam.c_str(), &ptr, 10);
1965a7e877eSJames Feist         if (skipParam.empty() || *ptr != '\0')
19716428a1aSJason M. Bills         {
19816428a1aSJason M. Bills 
1998d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
2008d1b46d7Szhanghch05                 asyncResp->res, std::string(skipParam), "$skip");
20116428a1aSJason M. Bills             return false;
20216428a1aSJason M. Bills         }
20316428a1aSJason M. Bills     }
20416428a1aSJason M. Bills     return true;
20516428a1aSJason M. Bills }
20616428a1aSJason M. Bills 
207271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
2088d1b46d7Szhanghch05 static bool getTopParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2098d1b46d7Szhanghch05                         const crow::Request& req, uint64_t& top)
21016428a1aSJason M. Bills {
2115a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
2125a7e877eSJames Feist         req.urlParams.find("$top");
2135a7e877eSJames Feist     if (it != req.urlParams.end())
21416428a1aSJason M. Bills     {
2155a7e877eSJames Feist         std::string topParam = it->value();
21616428a1aSJason M. Bills         char* ptr = nullptr;
2175a7e877eSJames Feist         top = std::strtoul(topParam.c_str(), &ptr, 10);
2185a7e877eSJames Feist         if (topParam.empty() || *ptr != '\0')
21916428a1aSJason M. Bills         {
2208d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
2218d1b46d7Szhanghch05                 asyncResp->res, std::string(topParam), "$top");
22216428a1aSJason M. Bills             return false;
22316428a1aSJason M. Bills         }
224271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
22516428a1aSJason M. Bills         {
22616428a1aSJason M. Bills 
22716428a1aSJason M. Bills             messages::queryParameterOutOfRange(
2288d1b46d7Szhanghch05                 asyncResp->res, std::to_string(top), "$top",
22916428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
23016428a1aSJason M. Bills             return false;
23116428a1aSJason M. Bills         }
23216428a1aSJason M. Bills     }
23316428a1aSJason M. Bills     return true;
23416428a1aSJason M. Bills }
23516428a1aSJason M. Bills 
2367e860f15SJohn Edward Broadbent inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
237e85d6b16SJason M. Bills                                     const bool firstEntry = true)
23816428a1aSJason M. Bills {
23916428a1aSJason M. Bills     int ret = 0;
24016428a1aSJason M. Bills     static uint64_t prevTs = 0;
24116428a1aSJason M. Bills     static int index = 0;
242e85d6b16SJason M. Bills     if (firstEntry)
243e85d6b16SJason M. Bills     {
244e85d6b16SJason M. Bills         prevTs = 0;
245e85d6b16SJason M. Bills     }
246e85d6b16SJason M. Bills 
24716428a1aSJason M. Bills     // Get the entry timestamp
24816428a1aSJason M. Bills     uint64_t curTs = 0;
24916428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
25016428a1aSJason M. Bills     if (ret < 0)
25116428a1aSJason M. Bills     {
25216428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
25316428a1aSJason M. Bills                          << strerror(-ret);
25416428a1aSJason M. Bills         return false;
25516428a1aSJason M. Bills     }
25616428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
25716428a1aSJason M. Bills     if (curTs == prevTs)
25816428a1aSJason M. Bills     {
25916428a1aSJason M. Bills         index++;
26016428a1aSJason M. Bills     }
26116428a1aSJason M. Bills     else
26216428a1aSJason M. Bills     {
26316428a1aSJason M. Bills         // Otherwise, reset it
26416428a1aSJason M. Bills         index = 0;
26516428a1aSJason M. Bills     }
26616428a1aSJason M. Bills     // Save the timestamp
26716428a1aSJason M. Bills     prevTs = curTs;
26816428a1aSJason M. Bills 
26916428a1aSJason M. Bills     entryID = std::to_string(curTs);
27016428a1aSJason M. Bills     if (index > 0)
27116428a1aSJason M. Bills     {
27216428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
27316428a1aSJason M. Bills     }
27416428a1aSJason M. Bills     return true;
27516428a1aSJason M. Bills }
27616428a1aSJason M. Bills 
277e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
278e85d6b16SJason M. Bills                              const bool firstEntry = true)
27995820184SJason M. Bills {
280271584abSEd Tanous     static time_t prevTs = 0;
28195820184SJason M. Bills     static int index = 0;
282e85d6b16SJason M. Bills     if (firstEntry)
283e85d6b16SJason M. Bills     {
284e85d6b16SJason M. Bills         prevTs = 0;
285e85d6b16SJason M. Bills     }
286e85d6b16SJason M. Bills 
28795820184SJason M. Bills     // Get the entry timestamp
288271584abSEd Tanous     std::time_t curTs = 0;
28995820184SJason M. Bills     std::tm timeStruct = {};
29095820184SJason M. Bills     std::istringstream entryStream(logEntry);
29195820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
29295820184SJason M. Bills     {
29395820184SJason M. Bills         curTs = std::mktime(&timeStruct);
29495820184SJason M. Bills     }
29595820184SJason M. Bills     // If the timestamp isn't unique, increment the index
29695820184SJason M. Bills     if (curTs == prevTs)
29795820184SJason M. Bills     {
29895820184SJason M. Bills         index++;
29995820184SJason M. Bills     }
30095820184SJason M. Bills     else
30195820184SJason M. Bills     {
30295820184SJason M. Bills         // Otherwise, reset it
30395820184SJason M. Bills         index = 0;
30495820184SJason M. Bills     }
30595820184SJason M. Bills     // Save the timestamp
30695820184SJason M. Bills     prevTs = curTs;
30795820184SJason M. Bills 
30895820184SJason M. Bills     entryID = std::to_string(curTs);
30995820184SJason M. Bills     if (index > 0)
31095820184SJason M. Bills     {
31195820184SJason M. Bills         entryID += "_" + std::to_string(index);
31295820184SJason M. Bills     }
31395820184SJason M. Bills     return true;
31495820184SJason M. Bills }
31595820184SJason M. Bills 
3167e860f15SJohn Edward Broadbent inline static bool
3178d1b46d7Szhanghch05     getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3188d1b46d7Szhanghch05                        const std::string& entryID, uint64_t& timestamp,
3198d1b46d7Szhanghch05                        uint64_t& index)
32016428a1aSJason M. Bills {
32116428a1aSJason M. Bills     if (entryID.empty())
32216428a1aSJason M. Bills     {
32316428a1aSJason M. Bills         return false;
32416428a1aSJason M. Bills     }
32516428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
32639e77504SEd Tanous     std::string_view tsStr(entryID);
32716428a1aSJason M. Bills 
32881ce609eSEd Tanous     auto underscorePos = tsStr.find('_');
32916428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
33016428a1aSJason M. Bills     {
33116428a1aSJason M. Bills         // Timestamp has an index
33216428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
33339e77504SEd Tanous         std::string_view indexStr(entryID);
33416428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
33516428a1aSJason M. Bills         std::size_t pos;
33616428a1aSJason M. Bills         try
33716428a1aSJason M. Bills         {
33839e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
33916428a1aSJason M. Bills         }
340271584abSEd Tanous         catch (std::invalid_argument&)
34116428a1aSJason M. Bills         {
3428d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
34316428a1aSJason M. Bills             return false;
34416428a1aSJason M. Bills         }
345271584abSEd Tanous         catch (std::out_of_range&)
34616428a1aSJason M. Bills         {
3478d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
34816428a1aSJason M. Bills             return false;
34916428a1aSJason M. Bills         }
35016428a1aSJason M. Bills         if (pos != indexStr.size())
35116428a1aSJason M. Bills         {
3528d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
35316428a1aSJason M. Bills             return false;
35416428a1aSJason M. Bills         }
35516428a1aSJason M. Bills     }
35616428a1aSJason M. Bills     // Timestamp has no index
35716428a1aSJason M. Bills     std::size_t pos;
35816428a1aSJason M. Bills     try
35916428a1aSJason M. Bills     {
36039e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
36116428a1aSJason M. Bills     }
362271584abSEd Tanous     catch (std::invalid_argument&)
36316428a1aSJason M. Bills     {
3648d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
36516428a1aSJason M. Bills         return false;
36616428a1aSJason M. Bills     }
367271584abSEd Tanous     catch (std::out_of_range&)
36816428a1aSJason M. Bills     {
3698d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
37016428a1aSJason M. Bills         return false;
37116428a1aSJason M. Bills     }
37216428a1aSJason M. Bills     if (pos != tsStr.size())
37316428a1aSJason M. Bills     {
3748d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
37516428a1aSJason M. Bills         return false;
37616428a1aSJason M. Bills     }
37716428a1aSJason M. Bills     return true;
37816428a1aSJason M. Bills }
37916428a1aSJason M. Bills 
38095820184SJason M. Bills static bool
38195820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
38295820184SJason M. Bills {
38395820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
38495820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
38595820184SJason M. Bills 
38695820184SJason M. Bills     // Loop through the directory looking for redfish log files
38795820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
38895820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
38995820184SJason M. Bills     {
39095820184SJason M. Bills         // If we find a redfish log file, save the path
39195820184SJason M. Bills         std::string filename = dirEnt.path().filename();
39295820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
39395820184SJason M. Bills         {
39495820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
39595820184SJason M. Bills         }
39695820184SJason M. Bills     }
39795820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
39895820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
39995820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
40095820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
40195820184SJason M. Bills 
40295820184SJason M. Bills     return !redfishLogFiles.empty();
40395820184SJason M. Bills }
40495820184SJason M. Bills 
4058d1b46d7Szhanghch05 inline void
4068d1b46d7Szhanghch05     getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
4075cb1dd27SAsmitha Karunanithi                            const std::string& dumpType)
4085cb1dd27SAsmitha Karunanithi {
4095cb1dd27SAsmitha Karunanithi     std::string dumpPath;
4105cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
4115cb1dd27SAsmitha Karunanithi     {
4125cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
4135cb1dd27SAsmitha Karunanithi     }
4145cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
4155cb1dd27SAsmitha Karunanithi     {
4165cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
4175cb1dd27SAsmitha Karunanithi     }
4185cb1dd27SAsmitha Karunanithi     else
4195cb1dd27SAsmitha Karunanithi     {
4205cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
4215cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
4225cb1dd27SAsmitha Karunanithi         return;
4235cb1dd27SAsmitha Karunanithi     }
4245cb1dd27SAsmitha Karunanithi 
4255cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
4265cb1dd27SAsmitha Karunanithi         [asyncResp, dumpPath, dumpType](const boost::system::error_code ec,
4275cb1dd27SAsmitha Karunanithi                                         GetManagedObjectsType& resp) {
4285cb1dd27SAsmitha Karunanithi             if (ec)
4295cb1dd27SAsmitha Karunanithi             {
4305cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4315cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
4325cb1dd27SAsmitha Karunanithi                 return;
4335cb1dd27SAsmitha Karunanithi             }
4345cb1dd27SAsmitha Karunanithi 
4355cb1dd27SAsmitha Karunanithi             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4365cb1dd27SAsmitha Karunanithi             entriesArray = nlohmann::json::array();
437b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
438b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
439b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
440b47452b2SAsmitha Karunanithi                 "/entry/";
4415cb1dd27SAsmitha Karunanithi 
4425cb1dd27SAsmitha Karunanithi             for (auto& object : resp)
4435cb1dd27SAsmitha Karunanithi             {
444b47452b2SAsmitha Karunanithi                 if (object.first.str.find(dumpEntryPath) == std::string::npos)
4455cb1dd27SAsmitha Karunanithi                 {
4465cb1dd27SAsmitha Karunanithi                     continue;
4475cb1dd27SAsmitha Karunanithi                 }
4485cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
4495cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
4505cb1dd27SAsmitha Karunanithi                 entriesArray.push_back({});
4515cb1dd27SAsmitha Karunanithi                 nlohmann::json& thisEntry = entriesArray.back();
4522dfd18efSEd Tanous 
4532dfd18efSEd Tanous                 std::string entryID = object.first.filename();
4542dfd18efSEd Tanous                 if (entryID.empty())
4555cb1dd27SAsmitha Karunanithi                 {
4565cb1dd27SAsmitha Karunanithi                     continue;
4575cb1dd27SAsmitha Karunanithi                 }
4585cb1dd27SAsmitha Karunanithi 
4595cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4605cb1dd27SAsmitha Karunanithi                 {
4615cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
4625cb1dd27SAsmitha Karunanithi                     {
4635cb1dd27SAsmitha Karunanithi 
4645cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4655cb1dd27SAsmitha Karunanithi                         {
4665cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
4675cb1dd27SAsmitha Karunanithi                             {
4685cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
4695cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4705cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
4715cb1dd27SAsmitha Karunanithi                                 {
4725cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4735cb1dd27SAsmitha Karunanithi                                     break;
4745cb1dd27SAsmitha Karunanithi                                 }
4755cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
4765cb1dd27SAsmitha Karunanithi                                 break;
4775cb1dd27SAsmitha Karunanithi                             }
4785cb1dd27SAsmitha Karunanithi                         }
4795cb1dd27SAsmitha Karunanithi                     }
4805cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
4815cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
4825cb1dd27SAsmitha Karunanithi                     {
4835cb1dd27SAsmitha Karunanithi 
4845cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4855cb1dd27SAsmitha Karunanithi                         {
4865cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
4875cb1dd27SAsmitha Karunanithi                             {
4885cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
4895cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4905cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
4915cb1dd27SAsmitha Karunanithi                                 {
4925cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4935cb1dd27SAsmitha Karunanithi                                     break;
4945cb1dd27SAsmitha Karunanithi                                 }
4955cb1dd27SAsmitha Karunanithi                                 timestamp =
4965cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
4975cb1dd27SAsmitha Karunanithi                                 break;
4985cb1dd27SAsmitha Karunanithi                             }
4995cb1dd27SAsmitha Karunanithi                         }
5005cb1dd27SAsmitha Karunanithi                     }
5015cb1dd27SAsmitha Karunanithi                 }
5025cb1dd27SAsmitha Karunanithi 
503d0dbeefdSEd Tanous                 thisEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry";
5045cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.id"] = dumpPath + entryID;
5055cb1dd27SAsmitha Karunanithi                 thisEntry["Id"] = entryID;
5065cb1dd27SAsmitha Karunanithi                 thisEntry["EntryType"] = "Event";
5075cb1dd27SAsmitha Karunanithi                 thisEntry["Created"] = crow::utility::getDateTime(timestamp);
5085cb1dd27SAsmitha Karunanithi                 thisEntry["Name"] = dumpType + " Dump Entry";
5095cb1dd27SAsmitha Karunanithi 
510d337bb72SAsmitha Karunanithi                 thisEntry["AdditionalDataSizeBytes"] = size;
5115cb1dd27SAsmitha Karunanithi 
5125cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
5135cb1dd27SAsmitha Karunanithi                 {
514d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "Manager";
515d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
516de8d94a3SAbhishek Patel                         "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" +
517de8d94a3SAbhishek Patel                         entryID + "/attachment";
5185cb1dd27SAsmitha Karunanithi                 }
5195cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
5205cb1dd27SAsmitha Karunanithi                 {
521d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "OEM";
522d337bb72SAsmitha Karunanithi                     thisEntry["OEMDiagnosticDataType"] = "System";
523d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
524de8d94a3SAbhishek Patel                         "/redfish/v1/Systems/system/LogServices/Dump/Entries/" +
525de8d94a3SAbhishek Patel                         entryID + "/attachment";
5265cb1dd27SAsmitha Karunanithi                 }
5275cb1dd27SAsmitha Karunanithi             }
5285cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Members@odata.count"] =
5295cb1dd27SAsmitha Karunanithi                 entriesArray.size();
5305cb1dd27SAsmitha Karunanithi         },
5315cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5325cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5335cb1dd27SAsmitha Karunanithi }
5345cb1dd27SAsmitha Karunanithi 
5358d1b46d7Szhanghch05 inline void
5368d1b46d7Szhanghch05     getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5378d1b46d7Szhanghch05                      const std::string& entryID, const std::string& dumpType)
5385cb1dd27SAsmitha Karunanithi {
5395cb1dd27SAsmitha Karunanithi     std::string dumpPath;
5405cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
5415cb1dd27SAsmitha Karunanithi     {
5425cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
5435cb1dd27SAsmitha Karunanithi     }
5445cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
5455cb1dd27SAsmitha Karunanithi     {
5465cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
5475cb1dd27SAsmitha Karunanithi     }
5485cb1dd27SAsmitha Karunanithi     else
5495cb1dd27SAsmitha Karunanithi     {
5505cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
5515cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5525cb1dd27SAsmitha Karunanithi         return;
5535cb1dd27SAsmitha Karunanithi     }
5545cb1dd27SAsmitha Karunanithi 
5555cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
5565cb1dd27SAsmitha Karunanithi         [asyncResp, entryID, dumpPath, dumpType](
5575cb1dd27SAsmitha Karunanithi             const boost::system::error_code ec, GetManagedObjectsType& resp) {
5585cb1dd27SAsmitha Karunanithi             if (ec)
5595cb1dd27SAsmitha Karunanithi             {
5605cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
5615cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
5625cb1dd27SAsmitha Karunanithi                 return;
5635cb1dd27SAsmitha Karunanithi             }
5645cb1dd27SAsmitha Karunanithi 
565b47452b2SAsmitha Karunanithi             bool foundDumpEntry = false;
566b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
567b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
568b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
569b47452b2SAsmitha Karunanithi                 "/entry/";
570b47452b2SAsmitha Karunanithi 
5715cb1dd27SAsmitha Karunanithi             for (auto& objectPath : resp)
5725cb1dd27SAsmitha Karunanithi             {
573b47452b2SAsmitha Karunanithi                 if (objectPath.first.str != dumpEntryPath + entryID)
5745cb1dd27SAsmitha Karunanithi                 {
5755cb1dd27SAsmitha Karunanithi                     continue;
5765cb1dd27SAsmitha Karunanithi                 }
5775cb1dd27SAsmitha Karunanithi 
5785cb1dd27SAsmitha Karunanithi                 foundDumpEntry = true;
5795cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
5805cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
5815cb1dd27SAsmitha Karunanithi 
5825cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
5835cb1dd27SAsmitha Karunanithi                 {
5845cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
5855cb1dd27SAsmitha Karunanithi                     {
5865cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
5875cb1dd27SAsmitha Karunanithi                         {
5885cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
5895cb1dd27SAsmitha Karunanithi                             {
5905cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
5915cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
5925cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
5935cb1dd27SAsmitha Karunanithi                                 {
5945cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
5955cb1dd27SAsmitha Karunanithi                                     break;
5965cb1dd27SAsmitha Karunanithi                                 }
5975cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
5985cb1dd27SAsmitha Karunanithi                                 break;
5995cb1dd27SAsmitha Karunanithi                             }
6005cb1dd27SAsmitha Karunanithi                         }
6015cb1dd27SAsmitha Karunanithi                     }
6025cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
6035cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
6045cb1dd27SAsmitha Karunanithi                     {
6055cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6065cb1dd27SAsmitha Karunanithi                         {
6075cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
6085cb1dd27SAsmitha Karunanithi                             {
6095cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
6105cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6115cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
6125cb1dd27SAsmitha Karunanithi                                 {
6135cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6145cb1dd27SAsmitha Karunanithi                                     break;
6155cb1dd27SAsmitha Karunanithi                                 }
6165cb1dd27SAsmitha Karunanithi                                 timestamp =
6175cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
6185cb1dd27SAsmitha Karunanithi                                 break;
6195cb1dd27SAsmitha Karunanithi                             }
6205cb1dd27SAsmitha Karunanithi                         }
6215cb1dd27SAsmitha Karunanithi                     }
6225cb1dd27SAsmitha Karunanithi                 }
6235cb1dd27SAsmitha Karunanithi 
6245cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
625d0dbeefdSEd Tanous                     "#LogEntry.v1_7_0.LogEntry";
6265cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
6275cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = entryID;
6285cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["EntryType"] = "Event";
6295cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Created"] =
6305cb1dd27SAsmitha Karunanithi                     crow::utility::getDateTime(timestamp);
6315cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
6325cb1dd27SAsmitha Karunanithi 
633d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
6345cb1dd27SAsmitha Karunanithi 
6355cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
6365cb1dd27SAsmitha Karunanithi                 {
637d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
638d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
639de8d94a3SAbhishek Patel                         "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/" +
640de8d94a3SAbhishek Patel                         entryID + "/attachment";
6415cb1dd27SAsmitha Karunanithi                 }
6425cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
6435cb1dd27SAsmitha Karunanithi                 {
644d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
645d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["OEMDiagnosticDataType"] =
6465cb1dd27SAsmitha Karunanithi                         "System";
647d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
648de8d94a3SAbhishek Patel                         "/redfish/v1/Systems/system/LogServices/Dump/Entries/" +
649de8d94a3SAbhishek Patel                         entryID + "/attachment";
6505cb1dd27SAsmitha Karunanithi                 }
6515cb1dd27SAsmitha Karunanithi             }
652b47452b2SAsmitha Karunanithi             if (foundDumpEntry == false)
653b47452b2SAsmitha Karunanithi             {
654b47452b2SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Can't find Dump Entry";
655b47452b2SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
656b47452b2SAsmitha Karunanithi                 return;
657b47452b2SAsmitha Karunanithi             }
6585cb1dd27SAsmitha Karunanithi         },
6595cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
6605cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
6615cb1dd27SAsmitha Karunanithi }
6625cb1dd27SAsmitha Karunanithi 
6638d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6649878256fSStanley Chu                             const std::string& entryID,
665b47452b2SAsmitha Karunanithi                             const std::string& dumpType)
6665cb1dd27SAsmitha Karunanithi {
6673de8d8baSGeorge Liu     auto respHandler = [asyncResp,
6683de8d8baSGeorge Liu                         entryID](const boost::system::error_code ec) {
6695cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
6705cb1dd27SAsmitha Karunanithi         if (ec)
6715cb1dd27SAsmitha Karunanithi         {
6723de8d8baSGeorge Liu             if (ec.value() == EBADR)
6733de8d8baSGeorge Liu             {
6743de8d8baSGeorge Liu                 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
6753de8d8baSGeorge Liu                 return;
6763de8d8baSGeorge Liu             }
6775cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
6785cb1dd27SAsmitha Karunanithi                              << ec;
6795cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
6805cb1dd27SAsmitha Karunanithi             return;
6815cb1dd27SAsmitha Karunanithi         }
6825cb1dd27SAsmitha Karunanithi     };
6835cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
6845cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
685b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
686b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
687b47452b2SAsmitha Karunanithi             entryID,
6885cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
6895cb1dd27SAsmitha Karunanithi }
6905cb1dd27SAsmitha Karunanithi 
6918d1b46d7Szhanghch05 inline void
6928d1b46d7Szhanghch05     createDumpTaskCallback(const crow::Request& req,
6938d1b46d7Szhanghch05                            const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6948d1b46d7Szhanghch05                            const uint32_t& dumpId, const std::string& dumpPath,
695a43be80fSAsmitha Karunanithi                            const std::string& dumpType)
696a43be80fSAsmitha Karunanithi {
697a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
6986145ed6fSAsmitha Karunanithi         [dumpId, dumpPath, dumpType](
699a43be80fSAsmitha Karunanithi             boost::system::error_code err, sdbusplus::message::message& m,
700a43be80fSAsmitha Karunanithi             const std::shared_ptr<task::TaskData>& taskData) {
701cb13a392SEd Tanous             if (err)
702cb13a392SEd Tanous             {
7036145ed6fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Error in creating a dump";
7046145ed6fSAsmitha Karunanithi                 taskData->state = "Cancelled";
7056145ed6fSAsmitha Karunanithi                 return task::completed;
706cb13a392SEd Tanous             }
707a43be80fSAsmitha Karunanithi             std::vector<std::pair<
708a43be80fSAsmitha Karunanithi                 std::string,
709a43be80fSAsmitha Karunanithi                 std::vector<std::pair<std::string, std::variant<std::string>>>>>
710a43be80fSAsmitha Karunanithi                 interfacesList;
711a43be80fSAsmitha Karunanithi 
712a43be80fSAsmitha Karunanithi             sdbusplus::message::object_path objPath;
713a43be80fSAsmitha Karunanithi 
714a43be80fSAsmitha Karunanithi             m.read(objPath, interfacesList);
715a43be80fSAsmitha Karunanithi 
716b47452b2SAsmitha Karunanithi             if (objPath.str ==
717b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
718b47452b2SAsmitha Karunanithi                     std::string(boost::algorithm::to_lower_copy(dumpType)) +
719b47452b2SAsmitha Karunanithi                     "/entry/" + std::to_string(dumpId))
720a43be80fSAsmitha Karunanithi             {
721a43be80fSAsmitha Karunanithi                 nlohmann::json retMessage = messages::success();
722a43be80fSAsmitha Karunanithi                 taskData->messages.emplace_back(retMessage);
723a43be80fSAsmitha Karunanithi 
724a43be80fSAsmitha Karunanithi                 std::string headerLoc =
725a43be80fSAsmitha Karunanithi                     "Location: " + dumpPath + std::to_string(dumpId);
726a43be80fSAsmitha Karunanithi                 taskData->payload->httpHeaders.emplace_back(
727a43be80fSAsmitha Karunanithi                     std::move(headerLoc));
728a43be80fSAsmitha Karunanithi 
729a43be80fSAsmitha Karunanithi                 taskData->state = "Completed";
730b47452b2SAsmitha Karunanithi                 return task::completed;
7316145ed6fSAsmitha Karunanithi             }
732a43be80fSAsmitha Karunanithi             return task::completed;
733a43be80fSAsmitha Karunanithi         },
734a43be80fSAsmitha Karunanithi         "type='signal',interface='org.freedesktop.DBus."
735a43be80fSAsmitha Karunanithi         "ObjectManager',"
736a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
737a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
738a43be80fSAsmitha Karunanithi 
739a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
740a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
741a43be80fSAsmitha Karunanithi     task->payload.emplace(req);
742a43be80fSAsmitha Karunanithi }
743a43be80fSAsmitha Karunanithi 
7448d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7458d1b46d7Szhanghch05                        const crow::Request& req, const std::string& dumpType)
746a43be80fSAsmitha Karunanithi {
747a43be80fSAsmitha Karunanithi 
748a43be80fSAsmitha Karunanithi     std::string dumpPath;
749a43be80fSAsmitha Karunanithi     if (dumpType == "BMC")
750a43be80fSAsmitha Karunanithi     {
751a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
752a43be80fSAsmitha Karunanithi     }
753a43be80fSAsmitha Karunanithi     else if (dumpType == "System")
754a43be80fSAsmitha Karunanithi     {
755a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
756a43be80fSAsmitha Karunanithi     }
757a43be80fSAsmitha Karunanithi     else
758a43be80fSAsmitha Karunanithi     {
759a43be80fSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
760a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
761a43be80fSAsmitha Karunanithi         return;
762a43be80fSAsmitha Karunanithi     }
763a43be80fSAsmitha Karunanithi 
764a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
765a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
766a43be80fSAsmitha Karunanithi 
767a43be80fSAsmitha Karunanithi     if (!redfish::json_util::readJson(
768a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
769a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
770a43be80fSAsmitha Karunanithi     {
771a43be80fSAsmitha Karunanithi         return;
772a43be80fSAsmitha Karunanithi     }
773a43be80fSAsmitha Karunanithi 
774a43be80fSAsmitha Karunanithi     if (dumpType == "System")
775a43be80fSAsmitha Karunanithi     {
776a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
777a43be80fSAsmitha Karunanithi         {
778a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
779a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType'/"
780a43be80fSAsmitha Karunanithi                                 "'OEMDiagnosticDataType' value not found!";
781a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
782a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
783a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
784a43be80fSAsmitha Karunanithi             return;
785a43be80fSAsmitha Karunanithi         }
7863174e4dfSEd Tanous         if ((*oemDiagnosticDataType != "System") ||
787a43be80fSAsmitha Karunanithi             (*diagnosticDataType != "OEM"))
788a43be80fSAsmitha Karunanithi         {
789a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
790a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
791a43be80fSAsmitha Karunanithi                                     "System Dump creation parameters");
792a43be80fSAsmitha Karunanithi             return;
793a43be80fSAsmitha Karunanithi         }
794a43be80fSAsmitha Karunanithi     }
795a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
796a43be80fSAsmitha Karunanithi     {
797a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
798a43be80fSAsmitha Karunanithi         {
799a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
800a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType' not found!";
801a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
802a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
803a43be80fSAsmitha Karunanithi             return;
804a43be80fSAsmitha Karunanithi         }
8053174e4dfSEd Tanous         if (*diagnosticDataType != "Manager")
806a43be80fSAsmitha Karunanithi         {
807a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
808a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
809a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
810a43be80fSAsmitha Karunanithi                                     "BMC Dump creation parameters");
811a43be80fSAsmitha Karunanithi             return;
812a43be80fSAsmitha Karunanithi         }
813a43be80fSAsmitha Karunanithi     }
814a43be80fSAsmitha Karunanithi 
815a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
816a43be80fSAsmitha Karunanithi         [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec,
817a43be80fSAsmitha Karunanithi                                              const uint32_t& dumpId) {
818a43be80fSAsmitha Karunanithi             if (ec)
819a43be80fSAsmitha Karunanithi             {
820a43be80fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
821a43be80fSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
822a43be80fSAsmitha Karunanithi                 return;
823a43be80fSAsmitha Karunanithi             }
824a43be80fSAsmitha Karunanithi             BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
825a43be80fSAsmitha Karunanithi 
826a43be80fSAsmitha Karunanithi             createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType);
827a43be80fSAsmitha Karunanithi         },
828b47452b2SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager",
829b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
830b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)),
831a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
832a43be80fSAsmitha Karunanithi }
833a43be80fSAsmitha Karunanithi 
8348d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
8358d1b46d7Szhanghch05                       const std::string& dumpType)
83680319af1SAsmitha Karunanithi {
837b47452b2SAsmitha Karunanithi     std::string dumpTypeLowerCopy =
838b47452b2SAsmitha Karunanithi         std::string(boost::algorithm::to_lower_copy(dumpType));
8398d1b46d7Szhanghch05 
84080319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
841b47452b2SAsmitha Karunanithi         [asyncResp, dumpType](const boost::system::error_code ec,
84280319af1SAsmitha Karunanithi                               const std::vector<std::string>& subTreePaths) {
84380319af1SAsmitha Karunanithi             if (ec)
84480319af1SAsmitha Karunanithi             {
84580319af1SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
84680319af1SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
84780319af1SAsmitha Karunanithi                 return;
84880319af1SAsmitha Karunanithi             }
84980319af1SAsmitha Karunanithi 
85080319af1SAsmitha Karunanithi             for (const std::string& path : subTreePaths)
85180319af1SAsmitha Karunanithi             {
8522dfd18efSEd Tanous                 sdbusplus::message::object_path objPath(path);
8532dfd18efSEd Tanous                 std::string logID = objPath.filename();
8542dfd18efSEd Tanous                 if (logID.empty())
85580319af1SAsmitha Karunanithi                 {
8562dfd18efSEd Tanous                     continue;
85780319af1SAsmitha Karunanithi                 }
8582dfd18efSEd Tanous                 deleteDumpEntry(asyncResp, logID, dumpType);
85980319af1SAsmitha Karunanithi             }
86080319af1SAsmitha Karunanithi         },
86180319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
86280319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
86380319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
864b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0,
865b47452b2SAsmitha Karunanithi         std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." +
866b47452b2SAsmitha Karunanithi                                    dumpType});
86780319af1SAsmitha Karunanithi }
86880319af1SAsmitha Karunanithi 
8697e860f15SJohn Edward Broadbent inline static void parseCrashdumpParameters(
870043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>>& params,
871043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
872043a0536SJohnathan Mantey {
873043a0536SJohnathan Mantey     for (auto property : params)
874043a0536SJohnathan Mantey     {
875043a0536SJohnathan Mantey         if (property.first == "Timestamp")
876043a0536SJohnathan Mantey         {
877043a0536SJohnathan Mantey             const std::string* value =
8788d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
879043a0536SJohnathan Mantey             if (value != nullptr)
880043a0536SJohnathan Mantey             {
881043a0536SJohnathan Mantey                 timestamp = *value;
882043a0536SJohnathan Mantey             }
883043a0536SJohnathan Mantey         }
884043a0536SJohnathan Mantey         else if (property.first == "Filename")
885043a0536SJohnathan Mantey         {
886043a0536SJohnathan Mantey             const std::string* value =
8878d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
888043a0536SJohnathan Mantey             if (value != nullptr)
889043a0536SJohnathan Mantey             {
890043a0536SJohnathan Mantey                 filename = *value;
891043a0536SJohnathan Mantey             }
892043a0536SJohnathan Mantey         }
893043a0536SJohnathan Mantey         else if (property.first == "Log")
894043a0536SJohnathan Mantey         {
895043a0536SJohnathan Mantey             const std::string* value =
8968d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
897043a0536SJohnathan Mantey             if (value != nullptr)
898043a0536SJohnathan Mantey             {
899043a0536SJohnathan Mantey                 logfile = *value;
900043a0536SJohnathan Mantey             }
901043a0536SJohnathan Mantey         }
902043a0536SJohnathan Mantey     }
903043a0536SJohnathan Mantey }
904043a0536SJohnathan Mantey 
905a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
9067e860f15SJohn Edward Broadbent inline void requestRoutesSystemLogServiceCollection(App& app)
9071da66f75SEd Tanous {
908c4bf6374SJason M. Bills     /**
909c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
910c4bf6374SJason M. Bills      */
9117e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/")
912ed398213SEd Tanous         .privileges(redfish::privileges::getLogServiceCollection)
9137e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
9147e860f15SJohn Edward Broadbent             [](const crow::Request&,
9157e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
9167e860f15SJohn Edward Broadbent 
917c4bf6374SJason M. Bills             {
9187e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
9197e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
920c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
921c4bf6374SJason M. Bills                     "#LogServiceCollection.LogServiceCollection";
922c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
923029573d4SEd Tanous                     "/redfish/v1/Systems/system/LogServices";
9247e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
9257e860f15SJohn Edward Broadbent                     "System Log Services Collection";
926c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
927c4bf6374SJason M. Bills                     "Collection of LogServices for this Computer System";
9287e860f15SJohn Edward Broadbent                 nlohmann::json& logServiceArray =
9297e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
930c4bf6374SJason M. Bills                 logServiceArray = nlohmann::json::array();
931029573d4SEd Tanous                 logServiceArray.push_back(
9327e860f15SJohn Edward Broadbent                     {{"@odata.id",
9337e860f15SJohn Edward Broadbent                       "/redfish/v1/Systems/system/LogServices/EventLog"}});
9345cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
935c9bb6861Sraviteja-b                 logServiceArray.push_back(
9367e860f15SJohn Edward Broadbent                     {{"@odata.id",
9377e860f15SJohn Edward Broadbent                       "/redfish/v1/Systems/system/LogServices/Dump"}});
938c9bb6861Sraviteja-b #endif
939c9bb6861Sraviteja-b 
940d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
941d53dd41fSJason M. Bills                 logServiceArray.push_back(
942cb92c03bSAndrew Geissler                     {{"@odata.id",
943424c4176SJason M. Bills                       "/redfish/v1/Systems/system/LogServices/Crashdump"}});
944d53dd41fSJason M. Bills #endif
945c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
946c4bf6374SJason M. Bills                     logServiceArray.size();
947a3316fc6SZhikuiRen 
948a3316fc6SZhikuiRen                 crow::connections::systemBus->async_method_call(
949a3316fc6SZhikuiRen                     [asyncResp](const boost::system::error_code ec,
950a3316fc6SZhikuiRen                                 const std::vector<std::string>& subtreePath) {
951a3316fc6SZhikuiRen                         if (ec)
952a3316fc6SZhikuiRen                         {
953a3316fc6SZhikuiRen                             BMCWEB_LOG_ERROR << ec;
954a3316fc6SZhikuiRen                             return;
955a3316fc6SZhikuiRen                         }
956a3316fc6SZhikuiRen 
957a3316fc6SZhikuiRen                         for (auto& pathStr : subtreePath)
958a3316fc6SZhikuiRen                         {
959a3316fc6SZhikuiRen                             if (pathStr.find("PostCode") != std::string::npos)
960a3316fc6SZhikuiRen                             {
96123a21a1cSEd Tanous                                 nlohmann::json& logServiceArrayLocal =
962a3316fc6SZhikuiRen                                     asyncResp->res.jsonValue["Members"];
96323a21a1cSEd Tanous                                 logServiceArrayLocal.push_back(
964a3316fc6SZhikuiRen                                     {{"@odata.id", "/redfish/v1/Systems/system/"
965a3316fc6SZhikuiRen                                                    "LogServices/PostCodes"}});
9667e860f15SJohn Edward Broadbent                                 asyncResp->res
9677e860f15SJohn Edward Broadbent                                     .jsonValue["Members@odata.count"] =
96823a21a1cSEd Tanous                                     logServiceArrayLocal.size();
969a3316fc6SZhikuiRen                                 return;
970a3316fc6SZhikuiRen                             }
971a3316fc6SZhikuiRen                         }
972a3316fc6SZhikuiRen                     },
973a3316fc6SZhikuiRen                     "xyz.openbmc_project.ObjectMapper",
974a3316fc6SZhikuiRen                     "/xyz/openbmc_project/object_mapper",
9757e860f15SJohn Edward Broadbent                     "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/",
9767e860f15SJohn Edward Broadbent                     0, std::array<const char*, 1>{postCodeIface});
9777e860f15SJohn Edward Broadbent             });
978c4bf6374SJason M. Bills }
979c4bf6374SJason M. Bills 
9807e860f15SJohn Edward Broadbent inline void requestRoutesEventLogService(App& app)
981c4bf6374SJason M. Bills {
9827e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
983ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
9847e860f15SJohn Edward Broadbent         .methods(
9857e860f15SJohn Edward Broadbent             boost::beast::http::verb::
9867e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
9877e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
988c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.id"] =
989029573d4SEd Tanous                 "/redfish/v1/Systems/system/LogServices/EventLog";
990c4bf6374SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
991c4bf6374SJason M. Bills                 "#LogService.v1_1_0.LogService";
992c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Event Log Service";
9937e860f15SJohn Edward Broadbent             asyncResp->res.jsonValue["Description"] =
9947e860f15SJohn Edward Broadbent                 "System Event Log Service";
995c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Id"] = "EventLog";
996c4bf6374SJason M. Bills             asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
9977c8c4058STejas Patil 
9987c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
9997c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
10007c8c4058STejas Patil 
10017c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
10027c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
10037c8c4058STejas Patil                 redfishDateTimeOffset.second;
10047c8c4058STejas Patil 
1005c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Entries"] = {
1006c4bf6374SJason M. Bills                 {"@odata.id",
1007029573d4SEd Tanous                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
1008e7d6c8b2SGunnar Mills             asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1009e7d6c8b2SGunnar Mills 
1010e7d6c8b2SGunnar Mills                 {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
1011e7d6c8b2SGunnar Mills                            "Actions/LogService.ClearLog"}};
10127e860f15SJohn Edward Broadbent         });
1013489640c6SJason M. Bills }
1014489640c6SJason M. Bills 
10157e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogClear(App& app)
1016489640c6SJason M. Bills {
10177e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1018489640c6SJason M. Bills                       "LogService.ClearLog/")
1019432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
10207e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
10217e860f15SJohn Edward Broadbent             [](const crow::Request&,
10227e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1023489640c6SJason M. Bills                 // Clear the EventLog by deleting the log files
1024489640c6SJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
1025489640c6SJason M. Bills                 if (getRedfishLogFiles(redfishLogFiles))
1026489640c6SJason M. Bills                 {
1027489640c6SJason M. Bills                     for (const std::filesystem::path& file : redfishLogFiles)
1028489640c6SJason M. Bills                     {
1029489640c6SJason M. Bills                         std::error_code ec;
1030489640c6SJason M. Bills                         std::filesystem::remove(file, ec);
1031489640c6SJason M. Bills                     }
1032489640c6SJason M. Bills                 }
1033489640c6SJason M. Bills 
1034489640c6SJason M. Bills                 // Reload rsyslog so it knows to start new log files
1035489640c6SJason M. Bills                 crow::connections::systemBus->async_method_call(
1036489640c6SJason M. Bills                     [asyncResp](const boost::system::error_code ec) {
1037489640c6SJason M. Bills                         if (ec)
1038489640c6SJason M. Bills                         {
10397e860f15SJohn Edward Broadbent                             BMCWEB_LOG_ERROR << "Failed to reload rsyslog: "
10407e860f15SJohn Edward Broadbent                                              << ec;
1041489640c6SJason M. Bills                             messages::internalError(asyncResp->res);
1042489640c6SJason M. Bills                             return;
1043489640c6SJason M. Bills                         }
1044489640c6SJason M. Bills 
1045489640c6SJason M. Bills                         messages::success(asyncResp->res);
1046489640c6SJason M. Bills                     },
1047489640c6SJason M. Bills                     "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
10487e860f15SJohn Edward Broadbent                     "org.freedesktop.systemd1.Manager", "ReloadUnit",
10497e860f15SJohn Edward Broadbent                     "rsyslog.service", "replace");
10507e860f15SJohn Edward Broadbent             });
1051c4bf6374SJason M. Bills }
1052c4bf6374SJason M. Bills 
105395820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
1054b5a76932SEd Tanous                                  const std::string& logEntry,
105595820184SJason M. Bills                                  nlohmann::json& logEntryJson)
1056c4bf6374SJason M. Bills {
105795820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1058cd225da8SJason M. Bills     // First get the Timestamp
1059f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1060cd225da8SJason M. Bills     if (space == std::string::npos)
106195820184SJason M. Bills     {
106295820184SJason M. Bills         return 1;
106395820184SJason M. Bills     }
1064cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1065cd225da8SJason M. Bills     // Then get the log contents
1066f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1067cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1068cd225da8SJason M. Bills     {
1069cd225da8SJason M. Bills         return 1;
1070cd225da8SJason M. Bills     }
1071cd225da8SJason M. Bills     std::string_view entry(logEntry);
1072cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1073cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1074cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1075cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1076cd225da8SJason M. Bills                  boost::token_compress_on);
1077cd225da8SJason M. Bills     // We need at least a MessageId to be valid
1078cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
1079cd225da8SJason M. Bills     {
1080cd225da8SJason M. Bills         return 1;
1081cd225da8SJason M. Bills     }
1082cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
108395820184SJason M. Bills 
10844851d45dSJason M. Bills     // Get the Message from the MessageRegistry
10854851d45dSJason M. Bills     const message_registries::Message* message =
10864851d45dSJason M. Bills         message_registries::getMessage(messageID);
1087c4bf6374SJason M. Bills 
10884851d45dSJason M. Bills     std::string msg;
10894851d45dSJason M. Bills     std::string severity;
10904851d45dSJason M. Bills     if (message != nullptr)
1091c4bf6374SJason M. Bills     {
10924851d45dSJason M. Bills         msg = message->message;
10934851d45dSJason M. Bills         severity = message->severity;
1094c4bf6374SJason M. Bills     }
1095c4bf6374SJason M. Bills 
109615a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
109715a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
109815a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
109915a86ff6SJason M. Bills     {
110015a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
110115a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
110215a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
110315a86ff6SJason M. Bills         if (!messageArgsStart.empty())
110415a86ff6SJason M. Bills         {
110515a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
110615a86ff6SJason M. Bills         }
110715a86ff6SJason M. Bills 
110823a21a1cSEd Tanous         messageArgs = {&messageArgsStart, messageArgsSize};
1109c4bf6374SJason M. Bills 
11104851d45dSJason M. Bills         // Fill the MessageArgs into the Message
111195820184SJason M. Bills         int i = 0;
111295820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11134851d45dSJason M. Bills         {
111495820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11154851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11164851d45dSJason M. Bills             if (argPos != std::string::npos)
11174851d45dSJason M. Bills             {
111895820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11194851d45dSJason M. Bills             }
11204851d45dSJason M. Bills         }
112115a86ff6SJason M. Bills     }
11224851d45dSJason M. Bills 
112395820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
112495820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
112595820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1126f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1127f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
112895820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1129c4bf6374SJason M. Bills     {
113095820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1131c4bf6374SJason M. Bills     }
1132c4bf6374SJason M. Bills 
1133c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
113495820184SJason M. Bills     logEntryJson = {
1135d0dbeefdSEd Tanous         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1136029573d4SEd Tanous         {"@odata.id",
1137897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
113895820184SJason M. Bills              logEntryID},
1139c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
114095820184SJason M. Bills         {"Id", logEntryID},
114195820184SJason M. Bills         {"Message", std::move(msg)},
114295820184SJason M. Bills         {"MessageId", std::move(messageID)},
1143f23b7296SEd Tanous         {"MessageArgs", messageArgs},
1144c4bf6374SJason M. Bills         {"EntryType", "Event"},
114595820184SJason M. Bills         {"Severity", std::move(severity)},
114695820184SJason M. Bills         {"Created", std::move(timestamp)}};
1147c4bf6374SJason M. Bills     return 0;
1148c4bf6374SJason M. Bills }
1149c4bf6374SJason M. Bills 
11507e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntryCollection(App& app)
1151c4bf6374SJason M. Bills {
11527e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
11537e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1154ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
11557e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
11567e860f15SJohn Edward Broadbent             [](const crow::Request& req,
11577e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1158271584abSEd Tanous                 uint64_t skip = 0;
1159271584abSEd Tanous                 uint64_t top = maxEntriesPerPage; // Show max entries by default
11608d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
1161c4bf6374SJason M. Bills                 {
1162c4bf6374SJason M. Bills                     return;
1163c4bf6374SJason M. Bills                 }
11648d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
1165c4bf6374SJason M. Bills                 {
1166c4bf6374SJason M. Bills                     return;
1167c4bf6374SJason M. Bills                 }
11687e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
11697e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
1170c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
1171c4bf6374SJason M. Bills                     "#LogEntryCollection.LogEntryCollection";
1172c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
1173029573d4SEd Tanous                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1174c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1175c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
1176c4bf6374SJason M. Bills                     "Collection of System Event Log Entries";
1177cb92c03bSAndrew Geissler 
11787e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
11797e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
1180c4bf6374SJason M. Bills                 logEntryArray = nlohmann::json::array();
11817e860f15SJohn Edward Broadbent                 // Go through the log files and create a unique ID for each
11827e860f15SJohn Edward Broadbent                 // entry
118395820184SJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
118495820184SJason M. Bills                 getRedfishLogFiles(redfishLogFiles);
1185b01bf299SEd Tanous                 uint64_t entryCount = 0;
1186cd225da8SJason M. Bills                 std::string logEntry;
118795820184SJason M. Bills 
11887e860f15SJohn Edward Broadbent                 // Oldest logs are in the last file, so start there and loop
11897e860f15SJohn Edward Broadbent                 // backwards
11907e860f15SJohn Edward Broadbent                 for (auto it = redfishLogFiles.rbegin();
11917e860f15SJohn Edward Broadbent                      it < redfishLogFiles.rend(); it++)
1192c4bf6374SJason M. Bills                 {
1193cd225da8SJason M. Bills                     std::ifstream logStream(*it);
119495820184SJason M. Bills                     if (!logStream.is_open())
1195c4bf6374SJason M. Bills                     {
1196c4bf6374SJason M. Bills                         continue;
1197c4bf6374SJason M. Bills                     }
1198c4bf6374SJason M. Bills 
1199e85d6b16SJason M. Bills                     // Reset the unique ID on the first entry
1200e85d6b16SJason M. Bills                     bool firstEntry = true;
120195820184SJason M. Bills                     while (std::getline(logStream, logEntry))
120295820184SJason M. Bills                     {
1203c4bf6374SJason M. Bills                         entryCount++;
12047e860f15SJohn Edward Broadbent                         // Handle paging using skip (number of entries to skip
12057e860f15SJohn Edward Broadbent                         // from the start) and top (number of entries to
12067e860f15SJohn Edward Broadbent                         // display)
1207c4bf6374SJason M. Bills                         if (entryCount <= skip || entryCount > skip + top)
1208c4bf6374SJason M. Bills                         {
1209c4bf6374SJason M. Bills                             continue;
1210c4bf6374SJason M. Bills                         }
1211c4bf6374SJason M. Bills 
1212c4bf6374SJason M. Bills                         std::string idStr;
1213e85d6b16SJason M. Bills                         if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1214c4bf6374SJason M. Bills                         {
1215c4bf6374SJason M. Bills                             continue;
1216c4bf6374SJason M. Bills                         }
1217c4bf6374SJason M. Bills 
1218e85d6b16SJason M. Bills                         if (firstEntry)
1219e85d6b16SJason M. Bills                         {
1220e85d6b16SJason M. Bills                             firstEntry = false;
1221e85d6b16SJason M. Bills                         }
1222e85d6b16SJason M. Bills 
1223c4bf6374SJason M. Bills                         logEntryArray.push_back({});
1224c4bf6374SJason M. Bills                         nlohmann::json& bmcLogEntry = logEntryArray.back();
12257e860f15SJohn Edward Broadbent                         if (fillEventLogEntryJson(idStr, logEntry,
12267e860f15SJohn Edward Broadbent                                                   bmcLogEntry) != 0)
1227c4bf6374SJason M. Bills                         {
1228c4bf6374SJason M. Bills                             messages::internalError(asyncResp->res);
1229c4bf6374SJason M. Bills                             return;
1230c4bf6374SJason M. Bills                         }
1231c4bf6374SJason M. Bills                     }
123295820184SJason M. Bills                 }
1233c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1234c4bf6374SJason M. Bills                 if (skip + top < entryCount)
1235c4bf6374SJason M. Bills                 {
1236c4bf6374SJason M. Bills                     asyncResp->res.jsonValue["Members@odata.nextLink"] =
123795820184SJason M. Bills                         "/redfish/v1/Systems/system/LogServices/EventLog/"
123895820184SJason M. Bills                         "Entries?$skip=" +
1239c4bf6374SJason M. Bills                         std::to_string(skip + top);
1240c4bf6374SJason M. Bills                 }
12417e860f15SJohn Edward Broadbent             });
1242897967deSJason M. Bills }
1243897967deSJason M. Bills 
12447e860f15SJohn Edward Broadbent inline void requestRoutesJournalEventLogEntry(App& app)
1245897967deSJason M. Bills {
12467e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
12477e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1248ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
12497e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
12507e860f15SJohn Edward Broadbent             [](const crow::Request&,
12517e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
12527e860f15SJohn Edward Broadbent                const std::string& param) {
12537e860f15SJohn Edward Broadbent                 const std::string& targetID = param;
12548d1b46d7Szhanghch05 
12557e860f15SJohn Edward Broadbent                 // Go through the log files and check the unique ID for each
12567e860f15SJohn Edward Broadbent                 // entry to find the target entry
1257897967deSJason M. Bills                 std::vector<std::filesystem::path> redfishLogFiles;
1258897967deSJason M. Bills                 getRedfishLogFiles(redfishLogFiles);
1259897967deSJason M. Bills                 std::string logEntry;
1260897967deSJason M. Bills 
12617e860f15SJohn Edward Broadbent                 // Oldest logs are in the last file, so start there and loop
12627e860f15SJohn Edward Broadbent                 // backwards
12637e860f15SJohn Edward Broadbent                 for (auto it = redfishLogFiles.rbegin();
12647e860f15SJohn Edward Broadbent                      it < redfishLogFiles.rend(); it++)
1265897967deSJason M. Bills                 {
1266897967deSJason M. Bills                     std::ifstream logStream(*it);
1267897967deSJason M. Bills                     if (!logStream.is_open())
1268897967deSJason M. Bills                     {
1269897967deSJason M. Bills                         continue;
1270897967deSJason M. Bills                     }
1271897967deSJason M. Bills 
1272897967deSJason M. Bills                     // Reset the unique ID on the first entry
1273897967deSJason M. Bills                     bool firstEntry = true;
1274897967deSJason M. Bills                     while (std::getline(logStream, logEntry))
1275897967deSJason M. Bills                     {
1276897967deSJason M. Bills                         std::string idStr;
1277897967deSJason M. Bills                         if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1278897967deSJason M. Bills                         {
1279897967deSJason M. Bills                             continue;
1280897967deSJason M. Bills                         }
1281897967deSJason M. Bills 
1282897967deSJason M. Bills                         if (firstEntry)
1283897967deSJason M. Bills                         {
1284897967deSJason M. Bills                             firstEntry = false;
1285897967deSJason M. Bills                         }
1286897967deSJason M. Bills 
1287897967deSJason M. Bills                         if (idStr == targetID)
1288897967deSJason M. Bills                         {
12897e860f15SJohn Edward Broadbent                             if (fillEventLogEntryJson(
12907e860f15SJohn Edward Broadbent                                     idStr, logEntry,
1291897967deSJason M. Bills                                     asyncResp->res.jsonValue) != 0)
1292897967deSJason M. Bills                             {
1293897967deSJason M. Bills                                 messages::internalError(asyncResp->res);
1294897967deSJason M. Bills                                 return;
1295897967deSJason M. Bills                             }
1296897967deSJason M. Bills                             return;
1297897967deSJason M. Bills                         }
1298897967deSJason M. Bills                     }
1299897967deSJason M. Bills                 }
1300897967deSJason M. Bills                 // Requested ID was not found
1301897967deSJason M. Bills                 messages::resourceMissingAtURI(asyncResp->res, targetID);
13027e860f15SJohn Edward Broadbent             });
130308a4e4b5SAnthony Wilson }
130408a4e4b5SAnthony Wilson 
13057e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryCollection(App& app)
130608a4e4b5SAnthony Wilson {
13077e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
13087e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1309ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
13107e860f15SJohn Edward Broadbent         .methods(
13117e860f15SJohn Edward Broadbent             boost::beast::http::verb::
13127e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
13137e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
13147e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
13157e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
131608a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["@odata.type"] =
131708a4e4b5SAnthony Wilson                 "#LogEntryCollection.LogEntryCollection";
131808a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["@odata.id"] =
131908a4e4b5SAnthony Wilson                 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
132008a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
132108a4e4b5SAnthony Wilson             asyncResp->res.jsonValue["Description"] =
132208a4e4b5SAnthony Wilson                 "Collection of System Event Log Entries";
132308a4e4b5SAnthony Wilson 
1324cb92c03bSAndrew Geissler             // DBus implementation of EventLog/Entries
1325cb92c03bSAndrew Geissler             // Make call to Logging Service to find all log entry objects
1326cb92c03bSAndrew Geissler             crow::connections::systemBus->async_method_call(
1327cb92c03bSAndrew Geissler                 [asyncResp](const boost::system::error_code ec,
1328cb92c03bSAndrew Geissler                             GetManagedObjectsType& resp) {
1329cb92c03bSAndrew Geissler                     if (ec)
1330cb92c03bSAndrew Geissler                     {
1331cb92c03bSAndrew Geissler                         // TODO Handle for specific error code
1332cb92c03bSAndrew Geissler                         BMCWEB_LOG_ERROR
1333cb92c03bSAndrew Geissler                             << "getLogEntriesIfaceData resp_handler got error "
1334cb92c03bSAndrew Geissler                             << ec;
1335cb92c03bSAndrew Geissler                         messages::internalError(asyncResp->res);
1336cb92c03bSAndrew Geissler                         return;
1337cb92c03bSAndrew Geissler                     }
1338cb92c03bSAndrew Geissler                     nlohmann::json& entriesArray =
1339cb92c03bSAndrew Geissler                         asyncResp->res.jsonValue["Members"];
1340cb92c03bSAndrew Geissler                     entriesArray = nlohmann::json::array();
1341cb92c03bSAndrew Geissler                     for (auto& objectPath : resp)
1342cb92c03bSAndrew Geissler                     {
134366664f25SEd Tanous                         uint32_t* id = nullptr;
134466664f25SEd Tanous                         std::time_t timestamp{};
1345d139c236SGeorge Liu                         std::time_t updateTimestamp{};
134666664f25SEd Tanous                         std::string* severity = nullptr;
134766664f25SEd Tanous                         std::string* message = nullptr;
1348f86bb901SAdriana Kobylak                         std::string* filePath = nullptr;
134975710de2SXiaochao Ma                         bool resolved = false;
1350f86bb901SAdriana Kobylak                         for (auto& interfaceMap : objectPath.second)
1351f86bb901SAdriana Kobylak                         {
1352f86bb901SAdriana Kobylak                             if (interfaceMap.first ==
1353f86bb901SAdriana Kobylak                                 "xyz.openbmc_project.Logging.Entry")
1354f86bb901SAdriana Kobylak                             {
1355cb92c03bSAndrew Geissler                                 for (auto& propertyMap : interfaceMap.second)
1356cb92c03bSAndrew Geissler                                 {
1357cb92c03bSAndrew Geissler                                     if (propertyMap.first == "Id")
1358cb92c03bSAndrew Geissler                                     {
1359f86bb901SAdriana Kobylak                                         id = std::get_if<uint32_t>(
1360f86bb901SAdriana Kobylak                                             &propertyMap.second);
1361cb92c03bSAndrew Geissler                                     }
1362cb92c03bSAndrew Geissler                                     else if (propertyMap.first == "Timestamp")
1363cb92c03bSAndrew Geissler                                     {
1364cb92c03bSAndrew Geissler                                         const uint64_t* millisTimeStamp =
1365f86bb901SAdriana Kobylak                                             std::get_if<uint64_t>(
1366f86bb901SAdriana Kobylak                                                 &propertyMap.second);
1367ae34c8e8SAdriana Kobylak                                         if (millisTimeStamp != nullptr)
1368ebd45906SGeorge Liu                                         {
13697e860f15SJohn Edward Broadbent                                             timestamp =
13707e860f15SJohn Edward Broadbent                                                 crow::utility::getTimestamp(
13717e860f15SJohn Edward Broadbent                                                     *millisTimeStamp);
13727e860f15SJohn Edward Broadbent                                         }
13737e860f15SJohn Edward Broadbent                                     }
13747e860f15SJohn Edward Broadbent                                     else if (propertyMap.first ==
13757e860f15SJohn Edward Broadbent                                              "UpdateTimestamp")
13767e860f15SJohn Edward Broadbent                                     {
13777e860f15SJohn Edward Broadbent                                         const uint64_t* millisTimeStamp =
13787e860f15SJohn Edward Broadbent                                             std::get_if<uint64_t>(
13797e860f15SJohn Edward Broadbent                                                 &propertyMap.second);
13807e860f15SJohn Edward Broadbent                                         if (millisTimeStamp != nullptr)
13817e860f15SJohn Edward Broadbent                                         {
13827e860f15SJohn Edward Broadbent                                             updateTimestamp =
13837e860f15SJohn Edward Broadbent                                                 crow::utility::getTimestamp(
13847e860f15SJohn Edward Broadbent                                                     *millisTimeStamp);
13857e860f15SJohn Edward Broadbent                                         }
13867e860f15SJohn Edward Broadbent                                     }
13877e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Severity")
13887e860f15SJohn Edward Broadbent                                     {
13897e860f15SJohn Edward Broadbent                                         severity = std::get_if<std::string>(
13907e860f15SJohn Edward Broadbent                                             &propertyMap.second);
13917e860f15SJohn Edward Broadbent                                     }
13927e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Message")
13937e860f15SJohn Edward Broadbent                                     {
13947e860f15SJohn Edward Broadbent                                         message = std::get_if<std::string>(
13957e860f15SJohn Edward Broadbent                                             &propertyMap.second);
13967e860f15SJohn Edward Broadbent                                     }
13977e860f15SJohn Edward Broadbent                                     else if (propertyMap.first == "Resolved")
13987e860f15SJohn Edward Broadbent                                     {
13997e860f15SJohn Edward Broadbent                                         bool* resolveptr = std::get_if<bool>(
14007e860f15SJohn Edward Broadbent                                             &propertyMap.second);
14017e860f15SJohn Edward Broadbent                                         if (resolveptr == nullptr)
14027e860f15SJohn Edward Broadbent                                         {
14037e860f15SJohn Edward Broadbent                                             messages::internalError(
14047e860f15SJohn Edward Broadbent                                                 asyncResp->res);
14057e860f15SJohn Edward Broadbent                                             return;
14067e860f15SJohn Edward Broadbent                                         }
14077e860f15SJohn Edward Broadbent                                         resolved = *resolveptr;
14087e860f15SJohn Edward Broadbent                                     }
14097e860f15SJohn Edward Broadbent                                 }
14107e860f15SJohn Edward Broadbent                                 if (id == nullptr || message == nullptr ||
14117e860f15SJohn Edward Broadbent                                     severity == nullptr)
14127e860f15SJohn Edward Broadbent                                 {
14137e860f15SJohn Edward Broadbent                                     messages::internalError(asyncResp->res);
14147e860f15SJohn Edward Broadbent                                     return;
14157e860f15SJohn Edward Broadbent                                 }
14167e860f15SJohn Edward Broadbent                             }
14177e860f15SJohn Edward Broadbent                             else if (interfaceMap.first ==
14187e860f15SJohn Edward Broadbent                                      "xyz.openbmc_project.Common.FilePath")
14197e860f15SJohn Edward Broadbent                             {
14207e860f15SJohn Edward Broadbent                                 for (auto& propertyMap : interfaceMap.second)
14217e860f15SJohn Edward Broadbent                                 {
14227e860f15SJohn Edward Broadbent                                     if (propertyMap.first == "Path")
14237e860f15SJohn Edward Broadbent                                     {
14247e860f15SJohn Edward Broadbent                                         filePath = std::get_if<std::string>(
14257e860f15SJohn Edward Broadbent                                             &propertyMap.second);
14267e860f15SJohn Edward Broadbent                                     }
14277e860f15SJohn Edward Broadbent                                 }
14287e860f15SJohn Edward Broadbent                             }
14297e860f15SJohn Edward Broadbent                         }
14307e860f15SJohn Edward Broadbent                         // Object path without the
14317e860f15SJohn Edward Broadbent                         // xyz.openbmc_project.Logging.Entry interface, ignore
14327e860f15SJohn Edward Broadbent                         // and continue.
14337e860f15SJohn Edward Broadbent                         if (id == nullptr || message == nullptr ||
14347e860f15SJohn Edward Broadbent                             severity == nullptr)
14357e860f15SJohn Edward Broadbent                         {
14367e860f15SJohn Edward Broadbent                             continue;
14377e860f15SJohn Edward Broadbent                         }
14387e860f15SJohn Edward Broadbent                         entriesArray.push_back({});
14397e860f15SJohn Edward Broadbent                         nlohmann::json& thisEntry = entriesArray.back();
14407e860f15SJohn Edward Broadbent                         thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
14417e860f15SJohn Edward Broadbent                         thisEntry["@odata.id"] =
14427e860f15SJohn Edward Broadbent                             "/redfish/v1/Systems/system/"
14437e860f15SJohn Edward Broadbent                             "LogServices/EventLog/Entries/" +
14447e860f15SJohn Edward Broadbent                             std::to_string(*id);
14457e860f15SJohn Edward Broadbent                         thisEntry["Name"] = "System Event Log Entry";
14467e860f15SJohn Edward Broadbent                         thisEntry["Id"] = std::to_string(*id);
14477e860f15SJohn Edward Broadbent                         thisEntry["Message"] = *message;
14487e860f15SJohn Edward Broadbent                         thisEntry["Resolved"] = resolved;
14497e860f15SJohn Edward Broadbent                         thisEntry["EntryType"] = "Event";
14507e860f15SJohn Edward Broadbent                         thisEntry["Severity"] =
14517e860f15SJohn Edward Broadbent                             translateSeverityDbusToRedfish(*severity);
14527e860f15SJohn Edward Broadbent                         thisEntry["Created"] =
14537e860f15SJohn Edward Broadbent                             crow::utility::getDateTime(timestamp);
14547e860f15SJohn Edward Broadbent                         thisEntry["Modified"] =
14557e860f15SJohn Edward Broadbent                             crow::utility::getDateTime(updateTimestamp);
14567e860f15SJohn Edward Broadbent                         if (filePath != nullptr)
14577e860f15SJohn Edward Broadbent                         {
14587e860f15SJohn Edward Broadbent                             thisEntry["AdditionalDataURI"] =
14597e860f15SJohn Edward Broadbent                                 "/redfish/v1/Systems/system/LogServices/"
14607e860f15SJohn Edward Broadbent                                 "EventLog/"
14617e860f15SJohn Edward Broadbent                                 "Entries/" +
14627e860f15SJohn Edward Broadbent                                 std::to_string(*id) + "/attachment";
14637e860f15SJohn Edward Broadbent                         }
14647e860f15SJohn Edward Broadbent                     }
14657e860f15SJohn Edward Broadbent                     std::sort(entriesArray.begin(), entriesArray.end(),
14667e860f15SJohn Edward Broadbent                               [](const nlohmann::json& left,
14677e860f15SJohn Edward Broadbent                                  const nlohmann::json& right) {
14687e860f15SJohn Edward Broadbent                                   return (left["Id"] <= right["Id"]);
14697e860f15SJohn Edward Broadbent                               });
14707e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members@odata.count"] =
14717e860f15SJohn Edward Broadbent                         entriesArray.size();
14727e860f15SJohn Edward Broadbent                 },
14737e860f15SJohn Edward Broadbent                 "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
14747e860f15SJohn Edward Broadbent                 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
14757e860f15SJohn Edward Broadbent         });
14767e860f15SJohn Edward Broadbent }
14777e860f15SJohn Edward Broadbent 
14787e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntry(App& app)
14797e860f15SJohn Edward Broadbent {
14807e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
14817e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1482ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
14837e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
14847e860f15SJohn Edward Broadbent             [](const crow::Request&,
14857e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
14867e860f15SJohn Edward Broadbent                const std::string& param)
14877e860f15SJohn Edward Broadbent 
14887e860f15SJohn Edward Broadbent             {
14897e860f15SJohn Edward Broadbent                 std::string entryID = param;
14907e860f15SJohn Edward Broadbent                 dbus::utility::escapePathForDbus(entryID);
14917e860f15SJohn Edward Broadbent 
14927e860f15SJohn Edward Broadbent                 // DBus implementation of EventLog/Entries
14937e860f15SJohn Edward Broadbent                 // Make call to Logging Service to find all log entry objects
14947e860f15SJohn Edward Broadbent                 crow::connections::systemBus->async_method_call(
14957e860f15SJohn Edward Broadbent                     [asyncResp, entryID](const boost::system::error_code ec,
14967e860f15SJohn Edward Broadbent                                          GetManagedPropertyType& resp) {
14977e860f15SJohn Edward Broadbent                         if (ec.value() == EBADR)
14987e860f15SJohn Edward Broadbent                         {
14997e860f15SJohn Edward Broadbent                             messages::resourceNotFound(
15007e860f15SJohn Edward Broadbent                                 asyncResp->res, "EventLogEntry", entryID);
15017e860f15SJohn Edward Broadbent                             return;
15027e860f15SJohn Edward Broadbent                         }
15037e860f15SJohn Edward Broadbent                         if (ec)
15047e860f15SJohn Edward Broadbent                         {
15057e860f15SJohn Edward Broadbent                             BMCWEB_LOG_ERROR << "EventLogEntry (DBus) "
15067e860f15SJohn Edward Broadbent                                                 "resp_handler got error "
15077e860f15SJohn Edward Broadbent                                              << ec;
15087e860f15SJohn Edward Broadbent                             messages::internalError(asyncResp->res);
15097e860f15SJohn Edward Broadbent                             return;
15107e860f15SJohn Edward Broadbent                         }
15117e860f15SJohn Edward Broadbent                         uint32_t* id = nullptr;
15127e860f15SJohn Edward Broadbent                         std::time_t timestamp{};
15137e860f15SJohn Edward Broadbent                         std::time_t updateTimestamp{};
15147e860f15SJohn Edward Broadbent                         std::string* severity = nullptr;
15157e860f15SJohn Edward Broadbent                         std::string* message = nullptr;
15167e860f15SJohn Edward Broadbent                         std::string* filePath = nullptr;
15177e860f15SJohn Edward Broadbent                         bool resolved = false;
15187e860f15SJohn Edward Broadbent 
15197e860f15SJohn Edward Broadbent                         for (auto& propertyMap : resp)
15207e860f15SJohn Edward Broadbent                         {
15217e860f15SJohn Edward Broadbent                             if (propertyMap.first == "Id")
15227e860f15SJohn Edward Broadbent                             {
15237e860f15SJohn Edward Broadbent                                 id = std::get_if<uint32_t>(&propertyMap.second);
15247e860f15SJohn Edward Broadbent                             }
15257e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Timestamp")
15267e860f15SJohn Edward Broadbent                             {
15277e860f15SJohn Edward Broadbent                                 const uint64_t* millisTimeStamp =
15287e860f15SJohn Edward Broadbent                                     std::get_if<uint64_t>(&propertyMap.second);
15297e860f15SJohn Edward Broadbent                                 if (millisTimeStamp != nullptr)
15307e860f15SJohn Edward Broadbent                                 {
1531d139c236SGeorge Liu                                     timestamp = crow::utility::getTimestamp(
1532cb92c03bSAndrew Geissler                                         *millisTimeStamp);
1533d139c236SGeorge Liu                                 }
1534ebd45906SGeorge Liu                             }
1535d139c236SGeorge Liu                             else if (propertyMap.first == "UpdateTimestamp")
1536d139c236SGeorge Liu                             {
1537d139c236SGeorge Liu                                 const uint64_t* millisTimeStamp =
15387e860f15SJohn Edward Broadbent                                     std::get_if<uint64_t>(&propertyMap.second);
1539ae34c8e8SAdriana Kobylak                                 if (millisTimeStamp != nullptr)
1540ebd45906SGeorge Liu                                 {
1541ebd45906SGeorge Liu                                     updateTimestamp =
1542ebd45906SGeorge Liu                                         crow::utility::getTimestamp(
1543d139c236SGeorge Liu                                             *millisTimeStamp);
1544cb92c03bSAndrew Geissler                                 }
1545ebd45906SGeorge Liu                             }
1546cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1547cb92c03bSAndrew Geissler                             {
1548cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1549cb92c03bSAndrew Geissler                                     &propertyMap.second);
1550cb92c03bSAndrew Geissler                             }
1551cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1552cb92c03bSAndrew Geissler                             {
1553cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1554cb92c03bSAndrew Geissler                                     &propertyMap.second);
1555ae34c8e8SAdriana Kobylak                             }
155675710de2SXiaochao Ma                             else if (propertyMap.first == "Resolved")
155775710de2SXiaochao Ma                             {
155875710de2SXiaochao Ma                                 bool* resolveptr =
155975710de2SXiaochao Ma                                     std::get_if<bool>(&propertyMap.second);
156075710de2SXiaochao Ma                                 if (resolveptr == nullptr)
156175710de2SXiaochao Ma                                 {
156275710de2SXiaochao Ma                                     messages::internalError(asyncResp->res);
156375710de2SXiaochao Ma                                     return;
156475710de2SXiaochao Ma                                 }
156575710de2SXiaochao Ma                                 resolved = *resolveptr;
156675710de2SXiaochao Ma                             }
15677e860f15SJohn Edward Broadbent                             else if (propertyMap.first == "Path")
1568f86bb901SAdriana Kobylak                             {
1569f86bb901SAdriana Kobylak                                 filePath = std::get_if<std::string>(
1570f86bb901SAdriana Kobylak                                     &propertyMap.second);
1571f86bb901SAdriana Kobylak                             }
1572f86bb901SAdriana Kobylak                         }
1573f86bb901SAdriana Kobylak                         if (id == nullptr || message == nullptr ||
1574f86bb901SAdriana Kobylak                             severity == nullptr)
1575f86bb901SAdriana Kobylak                         {
1576ae34c8e8SAdriana Kobylak                             messages::internalError(asyncResp->res);
1577271584abSEd Tanous                             return;
1578271584abSEd Tanous                         }
1579f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["@odata.type"] =
1580f86bb901SAdriana Kobylak                             "#LogEntry.v1_8_0.LogEntry";
1581f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["@odata.id"] =
15827e860f15SJohn Edward Broadbent                             "/redfish/v1/Systems/system/LogServices/EventLog/"
15837e860f15SJohn Edward Broadbent                             "Entries/" +
1584f86bb901SAdriana Kobylak                             std::to_string(*id);
15857e860f15SJohn Edward Broadbent                         asyncResp->res.jsonValue["Name"] =
15867e860f15SJohn Edward Broadbent                             "System Event Log Entry";
1587f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1588f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Message"] = *message;
1589f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Resolved"] = resolved;
1590f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["EntryType"] = "Event";
1591f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Severity"] =
1592f86bb901SAdriana Kobylak                             translateSeverityDbusToRedfish(*severity);
1593f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Created"] =
1594f86bb901SAdriana Kobylak                             crow::utility::getDateTime(timestamp);
1595f86bb901SAdriana Kobylak                         asyncResp->res.jsonValue["Modified"] =
1596f86bb901SAdriana Kobylak                             crow::utility::getDateTime(updateTimestamp);
1597f86bb901SAdriana Kobylak                         if (filePath != nullptr)
1598f86bb901SAdriana Kobylak                         {
1599f86bb901SAdriana Kobylak                             asyncResp->res.jsonValue["AdditionalDataURI"] =
16007e860f15SJohn Edward Broadbent                                 "/redfish/v1/Systems/system/LogServices/"
16017e860f15SJohn Edward Broadbent                                 "EventLog/"
16027e860f15SJohn Edward Broadbent                                 "attachment/" +
16037e860f15SJohn Edward Broadbent                                 std::to_string(*id);
1604f86bb901SAdriana Kobylak                         }
1605cb92c03bSAndrew Geissler                     },
1606cb92c03bSAndrew Geissler                     "xyz.openbmc_project.Logging",
1607cb92c03bSAndrew Geissler                     "/xyz/openbmc_project/logging/entry/" + entryID,
1608f86bb901SAdriana Kobylak                     "org.freedesktop.DBus.Properties", "GetAll", "");
16097e860f15SJohn Edward Broadbent             });
1610336e96c6SChicago Duan 
16117e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
16127e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1613ed398213SEd Tanous         .privileges(redfish::privileges::patchLogEntry)
16147e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::patch)(
16157e860f15SJohn Edward Broadbent             [](const crow::Request& req,
16167e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16177e860f15SJohn Edward Broadbent                const std::string& entryId) {
161875710de2SXiaochao Ma                 std::optional<bool> resolved;
161975710de2SXiaochao Ma 
16207e860f15SJohn Edward Broadbent                 if (!json_util::readJson(req, asyncResp->res, "Resolved",
16217e860f15SJohn Edward Broadbent                                          resolved))
162275710de2SXiaochao Ma                 {
162375710de2SXiaochao Ma                     return;
162475710de2SXiaochao Ma                 }
162575710de2SXiaochao Ma                 BMCWEB_LOG_DEBUG << "Set Resolved";
162675710de2SXiaochao Ma 
162775710de2SXiaochao Ma                 crow::connections::systemBus->async_method_call(
16284f48d5f6SEd Tanous                     [asyncResp, entryId](const boost::system::error_code ec) {
162975710de2SXiaochao Ma                         if (ec)
163075710de2SXiaochao Ma                         {
163175710de2SXiaochao Ma                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
163275710de2SXiaochao Ma                             messages::internalError(asyncResp->res);
163375710de2SXiaochao Ma                             return;
163475710de2SXiaochao Ma                         }
163575710de2SXiaochao Ma                     },
163675710de2SXiaochao Ma                     "xyz.openbmc_project.Logging",
163775710de2SXiaochao Ma                     "/xyz/openbmc_project/logging/entry/" + entryId,
163875710de2SXiaochao Ma                     "org.freedesktop.DBus.Properties", "Set",
163975710de2SXiaochao Ma                     "xyz.openbmc_project.Logging.Entry", "Resolved",
164075710de2SXiaochao Ma                     std::variant<bool>(*resolved));
16417e860f15SJohn Edward Broadbent             });
164275710de2SXiaochao Ma 
16437e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
16447e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/")
1645ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
1646ed398213SEd Tanous 
16477e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
16487e860f15SJohn Edward Broadbent             [](const crow::Request&,
16497e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16507e860f15SJohn Edward Broadbent                const std::string& param)
16517e860f15SJohn Edward Broadbent 
1652336e96c6SChicago Duan             {
1653336e96c6SChicago Duan                 BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1654336e96c6SChicago Duan 
16557e860f15SJohn Edward Broadbent                 std::string entryID = param;
1656336e96c6SChicago Duan 
1657336e96c6SChicago Duan                 dbus::utility::escapePathForDbus(entryID);
1658336e96c6SChicago Duan 
1659336e96c6SChicago Duan                 // Process response from Logging service.
16607e860f15SJohn Edward Broadbent                 auto respHandler = [asyncResp, entryID](
16617e860f15SJohn Edward Broadbent                                        const boost::system::error_code ec) {
16627e860f15SJohn Edward Broadbent                     BMCWEB_LOG_DEBUG
16637e860f15SJohn Edward Broadbent                         << "EventLogEntry (DBus) doDelete callback: Done";
1664336e96c6SChicago Duan                     if (ec)
1665336e96c6SChicago Duan                     {
16663de8d8baSGeorge Liu                         if (ec.value() == EBADR)
16673de8d8baSGeorge Liu                         {
16687e860f15SJohn Edward Broadbent                             messages::resourceNotFound(asyncResp->res,
16697e860f15SJohn Edward Broadbent                                                        "LogEntry", entryID);
16703de8d8baSGeorge Liu                             return;
16713de8d8baSGeorge Liu                         }
1672336e96c6SChicago Duan                         // TODO Handle for specific error code
16737e860f15SJohn Edward Broadbent                         BMCWEB_LOG_ERROR << "EventLogEntry (DBus) doDelete "
16747e860f15SJohn Edward Broadbent                                             "respHandler got error "
1675336e96c6SChicago Duan                                          << ec;
1676336e96c6SChicago Duan                         asyncResp->res.result(
1677336e96c6SChicago Duan                             boost::beast::http::status::internal_server_error);
1678336e96c6SChicago Duan                         return;
1679336e96c6SChicago Duan                     }
1680336e96c6SChicago Duan 
1681336e96c6SChicago Duan                     asyncResp->res.result(boost::beast::http::status::ok);
1682336e96c6SChicago Duan                 };
1683336e96c6SChicago Duan 
1684336e96c6SChicago Duan                 // Make call to Logging service to request Delete Log
1685336e96c6SChicago Duan                 crow::connections::systemBus->async_method_call(
1686336e96c6SChicago Duan                     respHandler, "xyz.openbmc_project.Logging",
1687336e96c6SChicago Duan                     "/xyz/openbmc_project/logging/entry/" + entryID,
1688336e96c6SChicago Duan                     "xyz.openbmc_project.Object.Delete", "Delete");
16897e860f15SJohn Edward Broadbent             });
1690400fd1fbSAdriana Kobylak }
1691400fd1fbSAdriana Kobylak 
16927e860f15SJohn Edward Broadbent inline void requestRoutesDBusEventLogEntryDownload(App& app)
1693400fd1fbSAdriana Kobylak {
16947e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/"
16957e860f15SJohn Edward Broadbent                       "<str>/attachment")
1696ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
16977e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
16987e860f15SJohn Edward Broadbent             [](const crow::Request& req,
16997e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
17007e860f15SJohn Edward Broadbent                const std::string& param)
1701400fd1fbSAdriana Kobylak 
17027e860f15SJohn Edward Broadbent             {
1703753d034dSEd Tanous                 std::string_view acceptHeader = req.getHeaderValue("Accept");
1704753d034dSEd Tanous                 // The iterators in boost/http/rfc7230.hpp end the string if '/'
1705753d034dSEd Tanous                 // is found, so replace it with arbitrary character '|' which is
1706753d034dSEd Tanous                 // not part of the Accept header syntax.
1707753d034dSEd Tanous                 std::string acceptStr = boost::replace_all_copy(
1708753d034dSEd Tanous                     std::string(acceptHeader), "/", "|");
1709753d034dSEd Tanous                 boost::beast::http::ext_list acceptTypes{acceptStr};
1710753d034dSEd Tanous                 bool supported = false;
1711753d034dSEd Tanous                 for (const auto& type : acceptTypes)
1712753d034dSEd Tanous                 {
1713753d034dSEd Tanous                     if ((type.first == "*|*") ||
1714753d034dSEd Tanous                         (type.first == "application|octet-stream"))
1715753d034dSEd Tanous                     {
1716753d034dSEd Tanous                         supported = true;
1717753d034dSEd Tanous                         break;
1718753d034dSEd Tanous                     }
1719753d034dSEd Tanous                 }
1720753d034dSEd Tanous                 if (!supported)
1721400fd1fbSAdriana Kobylak                 {
17227e860f15SJohn Edward Broadbent                     asyncResp->res.result(
17237e860f15SJohn Edward Broadbent                         boost::beast::http::status::bad_request);
1724400fd1fbSAdriana Kobylak                     return;
1725400fd1fbSAdriana Kobylak                 }
1726400fd1fbSAdriana Kobylak 
17277e860f15SJohn Edward Broadbent                 std::string entryID = param;
1728400fd1fbSAdriana Kobylak                 dbus::utility::escapePathForDbus(entryID);
1729400fd1fbSAdriana Kobylak 
1730400fd1fbSAdriana Kobylak                 crow::connections::systemBus->async_method_call(
17317e860f15SJohn Edward Broadbent                     [asyncResp,
17327e860f15SJohn Edward Broadbent                      entryID](const boost::system::error_code ec,
1733400fd1fbSAdriana Kobylak                               const sdbusplus::message::unix_fd& unixfd) {
1734400fd1fbSAdriana Kobylak                         if (ec.value() == EBADR)
1735400fd1fbSAdriana Kobylak                         {
17367e860f15SJohn Edward Broadbent                             messages::resourceNotFound(
17377e860f15SJohn Edward Broadbent                                 asyncResp->res, "EventLogAttachment", entryID);
1738400fd1fbSAdriana Kobylak                             return;
1739400fd1fbSAdriana Kobylak                         }
1740400fd1fbSAdriana Kobylak                         if (ec)
1741400fd1fbSAdriana Kobylak                         {
1742400fd1fbSAdriana Kobylak                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1743400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1744400fd1fbSAdriana Kobylak                             return;
1745400fd1fbSAdriana Kobylak                         }
1746400fd1fbSAdriana Kobylak 
1747400fd1fbSAdriana Kobylak                         int fd = -1;
1748400fd1fbSAdriana Kobylak                         fd = dup(unixfd);
1749400fd1fbSAdriana Kobylak                         if (fd == -1)
1750400fd1fbSAdriana Kobylak                         {
1751400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1752400fd1fbSAdriana Kobylak                             return;
1753400fd1fbSAdriana Kobylak                         }
1754400fd1fbSAdriana Kobylak 
1755400fd1fbSAdriana Kobylak                         long long int size = lseek(fd, 0, SEEK_END);
1756400fd1fbSAdriana Kobylak                         if (size == -1)
1757400fd1fbSAdriana Kobylak                         {
1758400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1759400fd1fbSAdriana Kobylak                             return;
1760400fd1fbSAdriana Kobylak                         }
1761400fd1fbSAdriana Kobylak 
1762400fd1fbSAdriana Kobylak                         // Arbitrary max size of 64kb
1763400fd1fbSAdriana Kobylak                         constexpr int maxFileSize = 65536;
1764400fd1fbSAdriana Kobylak                         if (size > maxFileSize)
1765400fd1fbSAdriana Kobylak                         {
1766400fd1fbSAdriana Kobylak                             BMCWEB_LOG_ERROR
1767400fd1fbSAdriana Kobylak                                 << "File size exceeds maximum allowed size of "
1768400fd1fbSAdriana Kobylak                                 << maxFileSize;
1769400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1770400fd1fbSAdriana Kobylak                             return;
1771400fd1fbSAdriana Kobylak                         }
1772400fd1fbSAdriana Kobylak                         std::vector<char> data(static_cast<size_t>(size));
1773400fd1fbSAdriana Kobylak                         long long int rc = lseek(fd, 0, SEEK_SET);
1774400fd1fbSAdriana Kobylak                         if (rc == -1)
1775400fd1fbSAdriana Kobylak                         {
1776400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1777400fd1fbSAdriana Kobylak                             return;
1778400fd1fbSAdriana Kobylak                         }
1779400fd1fbSAdriana Kobylak                         rc = read(fd, data.data(), data.size());
1780400fd1fbSAdriana Kobylak                         if ((rc == -1) || (rc != size))
1781400fd1fbSAdriana Kobylak                         {
1782400fd1fbSAdriana Kobylak                             messages::internalError(asyncResp->res);
1783400fd1fbSAdriana Kobylak                             return;
1784400fd1fbSAdriana Kobylak                         }
1785400fd1fbSAdriana Kobylak                         close(fd);
1786400fd1fbSAdriana Kobylak 
1787400fd1fbSAdriana Kobylak                         std::string_view strData(data.data(), data.size());
17887e860f15SJohn Edward Broadbent                         std::string output =
17897e860f15SJohn Edward Broadbent                             crow::utility::base64encode(strData);
1790400fd1fbSAdriana Kobylak 
1791400fd1fbSAdriana Kobylak                         asyncResp->res.addHeader("Content-Type",
1792400fd1fbSAdriana Kobylak                                                  "application/octet-stream");
17937e860f15SJohn Edward Broadbent                         asyncResp->res.addHeader("Content-Transfer-Encoding",
17947e860f15SJohn Edward Broadbent                                                  "Base64");
1795400fd1fbSAdriana Kobylak                         asyncResp->res.body() = std::move(output);
1796400fd1fbSAdriana Kobylak                     },
1797400fd1fbSAdriana Kobylak                     "xyz.openbmc_project.Logging",
1798400fd1fbSAdriana Kobylak                     "/xyz/openbmc_project/logging/entry/" + entryID,
1799400fd1fbSAdriana Kobylak                     "xyz.openbmc_project.Logging.Entry", "GetEntry");
18007e860f15SJohn Edward Broadbent             });
18011da66f75SEd Tanous }
18021da66f75SEd Tanous 
18037e860f15SJohn Edward Broadbent inline void requestRoutesBMCLogServiceCollection(App& app)
18041da66f75SEd Tanous {
18057e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/")
1806ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
18077e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
18087e860f15SJohn Edward Broadbent             [](const crow::Request&,
18097e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
18107e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
18117e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
1812e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
18131da66f75SEd Tanous                     "#LogServiceCollection.LogServiceCollection";
1814e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.id"] =
1815e1f26343SJason M. Bills                     "/redfish/v1/Managers/bmc/LogServices";
18167e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
18177e860f15SJohn Edward Broadbent                     "Open BMC Log Services Collection";
1818e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
18191da66f75SEd Tanous                     "Collection of LogServices for this Manager";
18207e860f15SJohn Edward Broadbent                 nlohmann::json& logServiceArray =
18217e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
1822c4bf6374SJason M. Bills                 logServiceArray = nlohmann::json::array();
18235cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
18245cb1dd27SAsmitha Karunanithi                 logServiceArray.push_back(
18257e860f15SJohn Edward Broadbent                     {{"@odata.id",
18267e860f15SJohn Edward Broadbent                       "/redfish/v1/Managers/bmc/LogServices/Dump"}});
18275cb1dd27SAsmitha Karunanithi #endif
1828c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1829c4bf6374SJason M. Bills                 logServiceArray.push_back(
18307e860f15SJohn Edward Broadbent                     {{"@odata.id",
18317e860f15SJohn Edward Broadbent                       "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1832c4bf6374SJason M. Bills #endif
1833e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
1834c4bf6374SJason M. Bills                     logServiceArray.size();
18357e860f15SJohn Edward Broadbent             });
1836e1f26343SJason M. Bills }
1837e1f26343SJason M. Bills 
18387e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogService(App& app)
1839e1f26343SJason M. Bills {
18407e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1841ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
18427e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
18437e860f15SJohn Edward Broadbent             [](const crow::Request&,
18447e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
18458d1b46d7Szhanghch05 
18467e860f15SJohn Edward Broadbent             {
1847e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
1848e1f26343SJason M. Bills                     "#LogService.v1_1_0.LogService";
18490f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
18500f74e643SEd Tanous                     "/redfish/v1/Managers/bmc/LogServices/Journal";
18517e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Name"] =
18527e860f15SJohn Edward Broadbent                     "Open BMC Journal Log Service";
18537e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Description"] =
18547e860f15SJohn Edward Broadbent                     "BMC Journal Log Service";
1855c4bf6374SJason M. Bills                 asyncResp->res.jsonValue["Id"] = "BMC Journal";
1856e1f26343SJason M. Bills                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
18577c8c4058STejas Patil 
18587c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
18597c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
18607c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
18617c8c4058STejas Patil                     redfishDateTimeOffset.first;
18627c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
18637c8c4058STejas Patil                     redfishDateTimeOffset.second;
18647c8c4058STejas Patil 
1865cd50aa42SJason M. Bills                 asyncResp->res.jsonValue["Entries"] = {
1866cd50aa42SJason M. Bills                     {"@odata.id",
1867086be238SEd Tanous                      "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
18687e860f15SJohn Edward Broadbent             });
1869e1f26343SJason M. Bills }
1870e1f26343SJason M. Bills 
1871c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1872e1f26343SJason M. Bills                                       sd_journal* journal,
1873c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
1874e1f26343SJason M. Bills {
1875e1f26343SJason M. Bills     // Get the Log Entry contents
1876e1f26343SJason M. Bills     int ret = 0;
1877e1f26343SJason M. Bills 
1878a8fe54f0SJason M. Bills     std::string message;
1879a8fe54f0SJason M. Bills     std::string_view syslogID;
1880a8fe54f0SJason M. Bills     ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
1881a8fe54f0SJason M. Bills     if (ret < 0)
1882a8fe54f0SJason M. Bills     {
1883a8fe54f0SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: "
1884a8fe54f0SJason M. Bills                          << strerror(-ret);
1885a8fe54f0SJason M. Bills     }
1886a8fe54f0SJason M. Bills     if (!syslogID.empty())
1887a8fe54f0SJason M. Bills     {
1888a8fe54f0SJason M. Bills         message += std::string(syslogID) + ": ";
1889a8fe54f0SJason M. Bills     }
1890a8fe54f0SJason M. Bills 
189139e77504SEd Tanous     std::string_view msg;
189216428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1893e1f26343SJason M. Bills     if (ret < 0)
1894e1f26343SJason M. Bills     {
1895e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1896e1f26343SJason M. Bills         return 1;
1897e1f26343SJason M. Bills     }
1898a8fe54f0SJason M. Bills     message += std::string(msg);
1899e1f26343SJason M. Bills 
1900e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1901271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
190216428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1903e1f26343SJason M. Bills     if (ret < 0)
1904e1f26343SJason M. Bills     {
1905e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
1906e1f26343SJason M. Bills     }
1907e1f26343SJason M. Bills 
1908e1f26343SJason M. Bills     // Get the Created time from the timestamp
190916428a1aSJason M. Bills     std::string entryTimeStr;
191016428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
1911e1f26343SJason M. Bills     {
191216428a1aSJason M. Bills         return 1;
1913e1f26343SJason M. Bills     }
1914e1f26343SJason M. Bills 
1915e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
1916c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
1917d0dbeefdSEd Tanous         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1918c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1919c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
1920e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
1921c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
1922a8fe54f0SJason M. Bills         {"Message", std::move(message)},
1923e1f26343SJason M. Bills         {"EntryType", "Oem"},
1924738c1e61SPatrick Williams         {"Severity", severity <= 2   ? "Critical"
1925738c1e61SPatrick Williams                      : severity <= 4 ? "Warning"
1926738c1e61SPatrick Williams                                      : "OK"},
1927086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
1928e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
1929e1f26343SJason M. Bills     return 0;
1930e1f26343SJason M. Bills }
1931e1f26343SJason M. Bills 
19327e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntryCollection(App& app)
1933e1f26343SJason M. Bills {
19347e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
1935ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
19367e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
19377e860f15SJohn Edward Broadbent             [](const crow::Request& req,
19387e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
1939193ad2faSJason M. Bills                 static constexpr const long maxEntriesPerPage = 1000;
1940271584abSEd Tanous                 uint64_t skip = 0;
1941271584abSEd Tanous                 uint64_t top = maxEntriesPerPage; // Show max entries by default
19428d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
1943193ad2faSJason M. Bills                 {
1944193ad2faSJason M. Bills                     return;
1945193ad2faSJason M. Bills                 }
19468d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
1947193ad2faSJason M. Bills                 {
1948193ad2faSJason M. Bills                     return;
1949193ad2faSJason M. Bills                 }
19507e860f15SJohn Edward Broadbent                 // Collections don't include the static data added by SubRoute
19517e860f15SJohn Edward Broadbent                 // because it has a duplicate entry for members
1952e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
1953e1f26343SJason M. Bills                     "#LogEntryCollection.LogEntryCollection";
19540f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
19550f74e643SEd Tanous                     "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1956e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1957e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
1958e1f26343SJason M. Bills                     "Collection of BMC Journal Entries";
19597e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
19607e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
1961e1f26343SJason M. Bills                 logEntryArray = nlohmann::json::array();
1962e1f26343SJason M. Bills 
19637e860f15SJohn Edward Broadbent                 // Go through the journal and use the timestamp to create a
19647e860f15SJohn Edward Broadbent                 // unique ID for each entry
1965e1f26343SJason M. Bills                 sd_journal* journalTmp = nullptr;
1966e1f26343SJason M. Bills                 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1967e1f26343SJason M. Bills                 if (ret < 0)
1968e1f26343SJason M. Bills                 {
19697e860f15SJohn Edward Broadbent                     BMCWEB_LOG_ERROR << "failed to open journal: "
19707e860f15SJohn Edward Broadbent                                      << strerror(-ret);
1971f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
1972e1f26343SJason M. Bills                     return;
1973e1f26343SJason M. Bills                 }
19747e860f15SJohn Edward Broadbent                 std::unique_ptr<sd_journal, decltype(&sd_journal_close)>
19757e860f15SJohn Edward Broadbent                     journal(journalTmp, sd_journal_close);
1976e1f26343SJason M. Bills                 journalTmp = nullptr;
1977b01bf299SEd Tanous                 uint64_t entryCount = 0;
1978e85d6b16SJason M. Bills                 // Reset the unique ID on the first entry
1979e85d6b16SJason M. Bills                 bool firstEntry = true;
1980e1f26343SJason M. Bills                 SD_JOURNAL_FOREACH(journal.get())
1981e1f26343SJason M. Bills                 {
1982193ad2faSJason M. Bills                     entryCount++;
19837e860f15SJohn Edward Broadbent                     // Handle paging using skip (number of entries to skip from
19847e860f15SJohn Edward Broadbent                     // the start) and top (number of entries to display)
1985193ad2faSJason M. Bills                     if (entryCount <= skip || entryCount > skip + top)
1986193ad2faSJason M. Bills                     {
1987193ad2faSJason M. Bills                         continue;
1988193ad2faSJason M. Bills                     }
1989193ad2faSJason M. Bills 
199016428a1aSJason M. Bills                     std::string idStr;
1991e85d6b16SJason M. Bills                     if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1992e1f26343SJason M. Bills                     {
1993e1f26343SJason M. Bills                         continue;
1994e1f26343SJason M. Bills                     }
1995e1f26343SJason M. Bills 
1996e85d6b16SJason M. Bills                     if (firstEntry)
1997e85d6b16SJason M. Bills                     {
1998e85d6b16SJason M. Bills                         firstEntry = false;
1999e85d6b16SJason M. Bills                     }
2000e85d6b16SJason M. Bills 
2001e1f26343SJason M. Bills                     logEntryArray.push_back({});
2002c4bf6374SJason M. Bills                     nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
2003c4bf6374SJason M. Bills                     if (fillBMCJournalLogEntryJson(idStr, journal.get(),
2004c4bf6374SJason M. Bills                                                    bmcJournalLogEntry) != 0)
2005e1f26343SJason M. Bills                     {
2006f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
2007e1f26343SJason M. Bills                         return;
2008e1f26343SJason M. Bills                     }
2009e1f26343SJason M. Bills                 }
2010193ad2faSJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
2011193ad2faSJason M. Bills                 if (skip + top < entryCount)
2012193ad2faSJason M. Bills                 {
2013193ad2faSJason M. Bills                     asyncResp->res.jsonValue["Members@odata.nextLink"] =
20147e860f15SJohn Edward Broadbent                         "/redfish/v1/Managers/bmc/LogServices/Journal/"
20157e860f15SJohn Edward Broadbent                         "Entries?$skip=" +
2016193ad2faSJason M. Bills                         std::to_string(skip + top);
2017193ad2faSJason M. Bills                 }
20187e860f15SJohn Edward Broadbent             });
2019e1f26343SJason M. Bills }
2020e1f26343SJason M. Bills 
20217e860f15SJohn Edward Broadbent inline void requestRoutesBMCJournalLogEntry(App& app)
2022e1f26343SJason M. Bills {
20237e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
20247e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/")
2025ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
20267e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
20277e860f15SJohn Edward Broadbent             [](const crow::Request&,
20287e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
20297e860f15SJohn Edward Broadbent                const std::string& entryID) {
2030e1f26343SJason M. Bills                 // Convert the unique ID back to a timestamp to find the entry
2031e1f26343SJason M. Bills                 uint64_t ts = 0;
2032271584abSEd Tanous                 uint64_t index = 0;
20338d1b46d7Szhanghch05                 if (!getTimestampFromID(asyncResp, entryID, ts, index))
2034e1f26343SJason M. Bills                 {
203516428a1aSJason M. Bills                     return;
2036e1f26343SJason M. Bills                 }
2037e1f26343SJason M. Bills 
2038e1f26343SJason M. Bills                 sd_journal* journalTmp = nullptr;
2039e1f26343SJason M. Bills                 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2040e1f26343SJason M. Bills                 if (ret < 0)
2041e1f26343SJason M. Bills                 {
20427e860f15SJohn Edward Broadbent                     BMCWEB_LOG_ERROR << "failed to open journal: "
20437e860f15SJohn Edward Broadbent                                      << strerror(-ret);
2044f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
2045e1f26343SJason M. Bills                     return;
2046e1f26343SJason M. Bills                 }
20477e860f15SJohn Edward Broadbent                 std::unique_ptr<sd_journal, decltype(&sd_journal_close)>
20487e860f15SJohn Edward Broadbent                     journal(journalTmp, sd_journal_close);
2049e1f26343SJason M. Bills                 journalTmp = nullptr;
20507e860f15SJohn Edward Broadbent                 // Go to the timestamp in the log and move to the entry at the
20517e860f15SJohn Edward Broadbent                 // index tracking the unique ID
2052af07e3f5SJason M. Bills                 std::string idStr;
2053af07e3f5SJason M. Bills                 bool firstEntry = true;
2054e1f26343SJason M. Bills                 ret = sd_journal_seek_realtime_usec(journal.get(), ts);
20552056b6d1SManojkiran Eda                 if (ret < 0)
20562056b6d1SManojkiran Eda                 {
20572056b6d1SManojkiran Eda                     BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
20582056b6d1SManojkiran Eda                                      << strerror(-ret);
20592056b6d1SManojkiran Eda                     messages::internalError(asyncResp->res);
20602056b6d1SManojkiran Eda                     return;
20612056b6d1SManojkiran Eda                 }
2062271584abSEd Tanous                 for (uint64_t i = 0; i <= index; i++)
2063e1f26343SJason M. Bills                 {
2064e1f26343SJason M. Bills                     sd_journal_next(journal.get());
2065af07e3f5SJason M. Bills                     if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2066af07e3f5SJason M. Bills                     {
2067af07e3f5SJason M. Bills                         messages::internalError(asyncResp->res);
2068af07e3f5SJason M. Bills                         return;
2069af07e3f5SJason M. Bills                     }
2070af07e3f5SJason M. Bills                     if (firstEntry)
2071af07e3f5SJason M. Bills                     {
2072af07e3f5SJason M. Bills                         firstEntry = false;
2073af07e3f5SJason M. Bills                     }
2074e1f26343SJason M. Bills                 }
2075c4bf6374SJason M. Bills                 // Confirm that the entry ID matches what was requested
2076af07e3f5SJason M. Bills                 if (idStr != entryID)
2077c4bf6374SJason M. Bills                 {
2078c4bf6374SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, entryID);
2079c4bf6374SJason M. Bills                     return;
2080c4bf6374SJason M. Bills                 }
2081c4bf6374SJason M. Bills 
2082c4bf6374SJason M. Bills                 if (fillBMCJournalLogEntryJson(entryID, journal.get(),
2083e1f26343SJason M. Bills                                                asyncResp->res.jsonValue) != 0)
2084e1f26343SJason M. Bills                 {
2085f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
2086e1f26343SJason M. Bills                     return;
2087e1f26343SJason M. Bills                 }
20887e860f15SJohn Edward Broadbent             });
2089c9bb6861Sraviteja-b }
2090c9bb6861Sraviteja-b 
20917e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpService(App& app)
2092c9bb6861Sraviteja-b {
20937e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2094ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
20957e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
20967e860f15SJohn Edward Broadbent             [](const crow::Request&,
20977e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2098c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.id"] =
20995cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Managers/bmc/LogServices/Dump";
2100c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.type"] =
2101d337bb72SAsmitha Karunanithi                     "#LogService.v1_2_0.LogService";
2102c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Name"] = "Dump LogService";
21035cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
21045cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = "Dump";
2105c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
21067c8c4058STejas Patil 
21077c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
21087c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
21097c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
21107c8c4058STejas Patil                     redfishDateTimeOffset.first;
21117c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
21127c8c4058STejas Patil                     redfishDateTimeOffset.second;
21137c8c4058STejas Patil 
2114c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Entries"] = {
21157e860f15SJohn Edward Broadbent                     {"@odata.id",
21167e860f15SJohn Edward Broadbent                      "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
21175cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Actions"] = {
21185cb1dd27SAsmitha Karunanithi                     {"#LogService.ClearLog",
21195cb1dd27SAsmitha Karunanithi                      {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
21205cb1dd27SAsmitha Karunanithi                                  "Actions/LogService.ClearLog"}}},
2121d337bb72SAsmitha Karunanithi                     {"#LogService.CollectDiagnosticData",
2122d337bb72SAsmitha Karunanithi                      {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
2123d337bb72SAsmitha Karunanithi                                  "Actions/LogService.CollectDiagnosticData"}}}};
21247e860f15SJohn Edward Broadbent             });
2125c9bb6861Sraviteja-b }
2126c9bb6861Sraviteja-b 
21277e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntryCollection(App& app)
21287e860f15SJohn Edward Broadbent {
21297e860f15SJohn Edward Broadbent 
2130c9bb6861Sraviteja-b     /**
2131c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
2132c9bb6861Sraviteja-b      */
21337e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2134ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
21357e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
21367e860f15SJohn Edward Broadbent             [](const crow::Request&,
21377e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2138c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.type"] =
2139c9bb6861Sraviteja-b                     "#LogEntryCollection.LogEntryCollection";
2140c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["@odata.id"] =
21415cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
21425cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
2143c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Description"] =
21445cb1dd27SAsmitha Karunanithi                     "Collection of BMC Dump Entries";
2145c9bb6861Sraviteja-b 
21465cb1dd27SAsmitha Karunanithi                 getDumpEntryCollection(asyncResp, "BMC");
21477e860f15SJohn Edward Broadbent             });
2148c9bb6861Sraviteja-b }
2149c9bb6861Sraviteja-b 
21507e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpEntry(App& app)
2151c9bb6861Sraviteja-b {
21527e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
21537e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2154ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
21557e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
21567e860f15SJohn Edward Broadbent             [](const crow::Request&,
21577e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
21587e860f15SJohn Edward Broadbent                const std::string& param) {
21597e860f15SJohn Edward Broadbent                 getDumpEntryById(asyncResp, param, "BMC");
21607e860f15SJohn Edward Broadbent             });
21617e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
21627e860f15SJohn Edward Broadbent                  "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
2163ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
21647e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
21657e860f15SJohn Edward Broadbent             [](const crow::Request&,
21667e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
21677e860f15SJohn Edward Broadbent                const std::string& param) {
21687e860f15SJohn Edward Broadbent                 deleteDumpEntry(asyncResp, param, "bmc");
21697e860f15SJohn Edward Broadbent             });
2170c9bb6861Sraviteja-b }
2171c9bb6861Sraviteja-b 
21727e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpCreate(App& app)
2173c9bb6861Sraviteja-b {
21748d1b46d7Szhanghch05 
21757e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2176d337bb72SAsmitha Karunanithi                       "Actions/"
2177d337bb72SAsmitha Karunanithi                       "LogService.CollectDiagnosticData/")
2178ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
21797e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
21807e860f15SJohn Edward Broadbent             [](const crow::Request& req,
21817e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
21828d1b46d7Szhanghch05                 createDump(asyncResp, req, "BMC");
21837e860f15SJohn Edward Broadbent             });
2184a43be80fSAsmitha Karunanithi }
2185a43be80fSAsmitha Karunanithi 
21867e860f15SJohn Edward Broadbent inline void requestRoutesBMCDumpClear(App& app)
218780319af1SAsmitha Karunanithi {
21887e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
218980319af1SAsmitha Karunanithi                       "Actions/"
219080319af1SAsmitha Karunanithi                       "LogService.ClearLog/")
2191ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
21927e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
21937e860f15SJohn Edward Broadbent             [](const crow::Request&,
21947e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
21958d1b46d7Szhanghch05                 clearDump(asyncResp, "BMC");
21967e860f15SJohn Edward Broadbent             });
21975cb1dd27SAsmitha Karunanithi }
21985cb1dd27SAsmitha Karunanithi 
21997e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpService(App& app)
22005cb1dd27SAsmitha Karunanithi {
22017e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/")
2202ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
22037e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
22047e860f15SJohn Edward Broadbent             [](const crow::Request&,
22057e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
22065cb1dd27SAsmitha Karunanithi 
22077e860f15SJohn Edward Broadbent             {
22085cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] =
22095cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Systems/system/LogServices/Dump";
22105cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
2211d337bb72SAsmitha Karunanithi                     "#LogService.v1_2_0.LogService";
22125cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "Dump LogService";
22137e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["Description"] =
22147e860f15SJohn Edward Broadbent                     "System Dump LogService";
22155cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = "Dump";
22165cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
22177c8c4058STejas Patil 
22187c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
22197c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
22207c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
22217c8c4058STejas Patil                     redfishDateTimeOffset.first;
22227c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
22237c8c4058STejas Patil                     redfishDateTimeOffset.second;
22247c8c4058STejas Patil 
22255cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Entries"] = {
22265cb1dd27SAsmitha Karunanithi                     {"@odata.id",
22275cb1dd27SAsmitha Karunanithi                      "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
22285cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Actions"] = {
22295cb1dd27SAsmitha Karunanithi                     {"#LogService.ClearLog",
22307e860f15SJohn Edward Broadbent                      {{"target",
22317e860f15SJohn Edward Broadbent                        "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
22325cb1dd27SAsmitha Karunanithi                        "LogService.ClearLog"}}},
2233d337bb72SAsmitha Karunanithi                     {"#LogService.CollectDiagnosticData",
22347e860f15SJohn Edward Broadbent                      {{"target",
22357e860f15SJohn Edward Broadbent                        "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
2236d337bb72SAsmitha Karunanithi                        "LogService.CollectDiagnosticData"}}}};
22377e860f15SJohn Edward Broadbent             });
22385cb1dd27SAsmitha Karunanithi }
22395cb1dd27SAsmitha Karunanithi 
22407e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntryCollection(App& app)
22417e860f15SJohn Edward Broadbent {
22427e860f15SJohn Edward Broadbent 
22435cb1dd27SAsmitha Karunanithi     /**
22445cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
22455cb1dd27SAsmitha Karunanithi      */
2246*b2a3289dSAsmitha Karunanithi     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
2247ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
22487e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
22497e860f15SJohn Edward Broadbent             [](const crow::Request&,
2250864d6a17SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
22515cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
22525cb1dd27SAsmitha Karunanithi                     "#LogEntryCollection.LogEntryCollection";
22535cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] =
22545cb1dd27SAsmitha Karunanithi                     "/redfish/v1/Systems/system/LogServices/Dump/Entries";
22555cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = "System Dump Entries";
22565cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Description"] =
22575cb1dd27SAsmitha Karunanithi                     "Collection of System Dump Entries";
22585cb1dd27SAsmitha Karunanithi 
22595cb1dd27SAsmitha Karunanithi                 getDumpEntryCollection(asyncResp, "System");
22607e860f15SJohn Edward Broadbent             });
22615cb1dd27SAsmitha Karunanithi }
22625cb1dd27SAsmitha Karunanithi 
22637e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpEntry(App& app)
22645cb1dd27SAsmitha Karunanithi {
22657e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2266864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2267ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
2268ed398213SEd Tanous 
22697e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
22707e860f15SJohn Edward Broadbent             [](const crow::Request&,
22717e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22727e860f15SJohn Edward Broadbent                const std::string& param) {
22737e860f15SJohn Edward Broadbent                 getDumpEntryById(asyncResp, param, "System");
22747e860f15SJohn Edward Broadbent             });
22758d1b46d7Szhanghch05 
22767e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
2277864d6a17SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/")
2278ed398213SEd Tanous         .privileges(redfish::privileges::deleteLogEntry)
22797e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::delete_)(
22807e860f15SJohn Edward Broadbent             [](const crow::Request&,
22817e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22827e860f15SJohn Edward Broadbent                const std::string& param) {
22837e860f15SJohn Edward Broadbent                 deleteDumpEntry(asyncResp, param, "system");
22847e860f15SJohn Edward Broadbent             });
22855cb1dd27SAsmitha Karunanithi }
2286c9bb6861Sraviteja-b 
22877e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpCreate(App& app)
2288c9bb6861Sraviteja-b {
22897e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2290d337bb72SAsmitha Karunanithi                       "Actions/"
2291d337bb72SAsmitha Karunanithi                       "LogService.CollectDiagnosticData/")
2292ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
22937e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
22947e860f15SJohn Edward Broadbent             [](const crow::Request& req,
22957e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
22967e860f15SJohn Edward Broadbent 
22977e860f15SJohn Edward Broadbent             { createDump(asyncResp, req, "System"); });
2298a43be80fSAsmitha Karunanithi }
2299a43be80fSAsmitha Karunanithi 
23007e860f15SJohn Edward Broadbent inline void requestRoutesSystemDumpClear(App& app)
2301a43be80fSAsmitha Karunanithi {
23027e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2303013487e5Sraviteja-b                       "Actions/"
2304013487e5Sraviteja-b                       "LogService.ClearLog/")
2305ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
23067e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
23077e860f15SJohn Edward Broadbent             [](const crow::Request&,
23087e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
23097e860f15SJohn Edward Broadbent 
23107e860f15SJohn Edward Broadbent             { clearDump(asyncResp, "System"); });
2311013487e5Sraviteja-b }
2312013487e5Sraviteja-b 
23137e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpService(App& app)
23141da66f75SEd Tanous {
23153946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
23163946028dSAppaRao Puli     // method for security reasons.
23171da66f75SEd Tanous     /**
23181da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
23191da66f75SEd Tanous      */
23207e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
2321ed398213SEd Tanous         // This is incorrect, should be:
2322ed398213SEd Tanous         //.privileges(redfish::privileges::getLogService)
2323432a890cSEd Tanous         .privileges({{"ConfigureManager"}})
23247e860f15SJohn Edward Broadbent         .methods(
23257e860f15SJohn Edward Broadbent             boost::beast::http::verb::
23267e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
23277e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
23287e860f15SJohn Edward Broadbent             // Copy over the static data to include the entries added by
23297e860f15SJohn Edward Broadbent             // SubRoute
23300f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2331424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump";
2332e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
23338e6c099aSJason M. Bills                 "#LogService.v1_2_0.LogService";
23344f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
23354f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
23364f50ae4bSGunnar Mills             asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2337e1f26343SJason M. Bills             asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2338e1f26343SJason M. Bills             asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
23397c8c4058STejas Patil 
23407c8c4058STejas Patil             std::pair<std::string, std::string> redfishDateTimeOffset =
23417c8c4058STejas Patil                 crow::utility::getDateTimeOffsetNow();
23427c8c4058STejas Patil             asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
23437c8c4058STejas Patil             asyncResp->res.jsonValue["DateTimeLocalOffset"] =
23447c8c4058STejas Patil                 redfishDateTimeOffset.second;
23457c8c4058STejas Patil 
2346cd50aa42SJason M. Bills             asyncResp->res.jsonValue["Entries"] = {
2347cd50aa42SJason M. Bills                 {"@odata.id",
2348424c4176SJason M. Bills                  "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
2349e1f26343SJason M. Bills             asyncResp->res.jsonValue["Actions"] = {
23505b61b5e8SJason M. Bills                 {"#LogService.ClearLog",
23515b61b5e8SJason M. Bills                  {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
23525b61b5e8SJason M. Bills                              "Actions/LogService.ClearLog"}}},
23538e6c099aSJason M. Bills                 {"#LogService.CollectDiagnosticData",
2354424c4176SJason M. Bills                  {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
23558e6c099aSJason M. Bills                              "Actions/LogService.CollectDiagnosticData"}}}};
23567e860f15SJohn Edward Broadbent         });
23571da66f75SEd Tanous }
23581da66f75SEd Tanous 
23597e860f15SJohn Edward Broadbent void inline requestRoutesCrashdumpClear(App& app)
23605b61b5e8SJason M. Bills {
23617e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
23627e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
23635b61b5e8SJason M. Bills                  "LogService.ClearLog/")
2364ed398213SEd Tanous         // This is incorrect, should be:
2365ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2366432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
23677e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
23687e860f15SJohn Edward Broadbent             [](const crow::Request&,
23697e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
23705b61b5e8SJason M. Bills                 crow::connections::systemBus->async_method_call(
23715b61b5e8SJason M. Bills                     [asyncResp](const boost::system::error_code ec,
2372cb13a392SEd Tanous                                 const std::string&) {
23735b61b5e8SJason M. Bills                         if (ec)
23745b61b5e8SJason M. Bills                         {
23755b61b5e8SJason M. Bills                             messages::internalError(asyncResp->res);
23765b61b5e8SJason M. Bills                             return;
23775b61b5e8SJason M. Bills                         }
23785b61b5e8SJason M. Bills                         messages::success(asyncResp->res);
23795b61b5e8SJason M. Bills                     },
23807e860f15SJohn Edward Broadbent                     crashdumpObject, crashdumpPath, deleteAllInterface,
23817e860f15SJohn Edward Broadbent                     "DeleteAll");
23827e860f15SJohn Edward Broadbent             });
23835b61b5e8SJason M. Bills }
23845b61b5e8SJason M. Bills 
23858d1b46d7Szhanghch05 static void
23868d1b46d7Szhanghch05     logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23878d1b46d7Szhanghch05                       const std::string& logID, nlohmann::json& logEntryJson)
2388e855dd28SJason M. Bills {
2389043a0536SJohnathan Mantey     auto getStoredLogCallback =
2390043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2391e855dd28SJason M. Bills             const boost::system::error_code ec,
2392043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>>& params) {
2393e855dd28SJason M. Bills             if (ec)
2394e855dd28SJason M. Bills             {
2395e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
23961ddcf01aSJason M. Bills                 if (ec.value() ==
23971ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
23981ddcf01aSJason M. Bills                 {
2399043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2400043a0536SJohnathan Mantey                                                logID);
24011ddcf01aSJason M. Bills                 }
24021ddcf01aSJason M. Bills                 else
24031ddcf01aSJason M. Bills                 {
2404e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
24051ddcf01aSJason M. Bills                 }
2406e855dd28SJason M. Bills                 return;
2407e855dd28SJason M. Bills             }
2408043a0536SJohnathan Mantey 
2409043a0536SJohnathan Mantey             std::string timestamp{};
2410043a0536SJohnathan Mantey             std::string filename{};
2411043a0536SJohnathan Mantey             std::string logfile{};
24122c70f800SEd Tanous             parseCrashdumpParameters(params, filename, timestamp, logfile);
2413043a0536SJohnathan Mantey 
2414043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2415e855dd28SJason M. Bills             {
2416043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2417e855dd28SJason M. Bills                 return;
2418e855dd28SJason M. Bills             }
2419e855dd28SJason M. Bills 
2420043a0536SJohnathan Mantey             std::string crashdumpURI =
2421e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2422043a0536SJohnathan Mantey                 logID + "/" + filename;
2423d0dbeefdSEd Tanous             logEntryJson = {{"@odata.type", "#LogEntry.v1_7_0.LogEntry"},
2424043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2425043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2426e855dd28SJason M. Bills                                               logID},
2427e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2428e855dd28SJason M. Bills                             {"Id", logID},
2429e855dd28SJason M. Bills                             {"EntryType", "Oem"},
24308e6c099aSJason M. Bills                             {"AdditionalDataURI", std::move(crashdumpURI)},
24318e6c099aSJason M. Bills                             {"DiagnosticDataType", "OEM"},
24328e6c099aSJason M. Bills                             {"OEMDiagnosticDataType", "PECICrashdump"},
2433043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2434e855dd28SJason M. Bills         };
2435e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
24365b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
24375b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2438043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2439e855dd28SJason M. Bills }
2440e855dd28SJason M. Bills 
24417e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntryCollection(App& app)
24421da66f75SEd Tanous {
24433946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
24443946028dSAppaRao Puli     // method for security reasons.
24451da66f75SEd Tanous     /**
24461da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
24471da66f75SEd Tanous      */
24487e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
24497e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
2450ed398213SEd Tanous         // This is incorrect, should be.
2451ed398213SEd Tanous         //.privileges(redfish::privileges::postLogEntryCollection)
2452432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
24537e860f15SJohn Edward Broadbent         .methods(
24547e860f15SJohn Edward Broadbent             boost::beast::http::verb::
24557e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
24567e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
24577e860f15SJohn Edward Broadbent             // Collections don't include the static data added by SubRoute
24587e860f15SJohn Edward Broadbent             // because it has a duplicate entry for members
2459e1f26343SJason M. Bills             auto getLogEntriesCallback = [asyncResp](
2460e1f26343SJason M. Bills                                              const boost::system::error_code ec,
24617e860f15SJohn Edward Broadbent                                              const std::vector<std::string>&
24627e860f15SJohn Edward Broadbent                                                  resp) {
24631da66f75SEd Tanous                 if (ec)
24641da66f75SEd Tanous                 {
24651da66f75SEd Tanous                     if (ec.value() !=
24661da66f75SEd Tanous                         boost::system::errc::no_such_file_or_directory)
24671da66f75SEd Tanous                     {
24681da66f75SEd Tanous                         BMCWEB_LOG_DEBUG << "failed to get entries ec: "
24691da66f75SEd Tanous                                          << ec.message();
2470f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
24711da66f75SEd Tanous                         return;
24721da66f75SEd Tanous                     }
24731da66f75SEd Tanous                 }
2474e1f26343SJason M. Bills                 asyncResp->res.jsonValue["@odata.type"] =
24751da66f75SEd Tanous                     "#LogEntryCollection.LogEntryCollection";
24760f74e643SEd Tanous                 asyncResp->res.jsonValue["@odata.id"] =
2477424c4176SJason M. Bills                     "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2478424c4176SJason M. Bills                 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2479e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Description"] =
2480424c4176SJason M. Bills                     "Collection of Crashdump Entries";
24817e860f15SJohn Edward Broadbent                 nlohmann::json& logEntryArray =
24827e860f15SJohn Edward Broadbent                     asyncResp->res.jsonValue["Members"];
2483e1f26343SJason M. Bills                 logEntryArray = nlohmann::json::array();
2484e855dd28SJason M. Bills                 std::vector<std::string> logIDs;
2485e855dd28SJason M. Bills                 // Get the list of log entries and build up an empty array big
2486e855dd28SJason M. Bills                 // enough to hold them
24871da66f75SEd Tanous                 for (const std::string& objpath : resp)
24881da66f75SEd Tanous                 {
2489e855dd28SJason M. Bills                     // Get the log ID
2490f23b7296SEd Tanous                     std::size_t lastPos = objpath.rfind('/');
2491e855dd28SJason M. Bills                     if (lastPos == std::string::npos)
24921da66f75SEd Tanous                     {
2493e855dd28SJason M. Bills                         continue;
24941da66f75SEd Tanous                     }
2495e855dd28SJason M. Bills                     logIDs.emplace_back(objpath.substr(lastPos + 1));
2496e855dd28SJason M. Bills 
2497e855dd28SJason M. Bills                     // Add a space for the log entry to the array
2498e855dd28SJason M. Bills                     logEntryArray.push_back({});
2499e855dd28SJason M. Bills                 }
2500e855dd28SJason M. Bills                 // Now go through and set up async calls to fill in the entries
2501e855dd28SJason M. Bills                 size_t index = 0;
2502e855dd28SJason M. Bills                 for (const std::string& logID : logIDs)
2503e855dd28SJason M. Bills                 {
2504e855dd28SJason M. Bills                     // Add the log entry to the array
2505e855dd28SJason M. Bills                     logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
25061da66f75SEd Tanous                 }
2507e1f26343SJason M. Bills                 asyncResp->res.jsonValue["Members@odata.count"] =
2508e1f26343SJason M. Bills                     logEntryArray.size();
25091da66f75SEd Tanous             };
25101da66f75SEd Tanous             crow::connections::systemBus->async_method_call(
25111da66f75SEd Tanous                 std::move(getLogEntriesCallback),
25121da66f75SEd Tanous                 "xyz.openbmc_project.ObjectMapper",
25131da66f75SEd Tanous                 "/xyz/openbmc_project/object_mapper",
25141da66f75SEd Tanous                 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
25155b61b5e8SJason M. Bills                 std::array<const char*, 1>{crashdumpInterface});
25167e860f15SJohn Edward Broadbent         });
25171da66f75SEd Tanous }
25181da66f75SEd Tanous 
25197e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpEntry(App& app)
25201da66f75SEd Tanous {
25213946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
25223946028dSAppaRao Puli     // method for security reasons.
25231da66f75SEd Tanous 
25247e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
25257e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/")
2526ed398213SEd Tanous         // this is incorrect, should be
2527ed398213SEd Tanous         // .privileges(redfish::privileges::getLogEntry)
2528432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
25297e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
25307e860f15SJohn Edward Broadbent             [](const crow::Request&,
25317e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25327e860f15SJohn Edward Broadbent                const std::string& param) {
25337e860f15SJohn Edward Broadbent                 const std::string& logID = param;
2534e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
25357e860f15SJohn Edward Broadbent             });
2536e855dd28SJason M. Bills }
2537e855dd28SJason M. Bills 
25387e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpFile(App& app)
2539e855dd28SJason M. Bills {
25403946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
25413946028dSAppaRao Puli     // method for security reasons.
25427e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
25437e860f15SJohn Edward Broadbent         app,
25447e860f15SJohn Edward Broadbent         "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/<str>/")
2545ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
25467e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
25477e860f15SJohn Edward Broadbent             [](const crow::Request&,
25487e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25497e860f15SJohn Edward Broadbent                const std::string& logID, const std::string& fileName) {
2550043a0536SJohnathan Mantey                 auto getStoredLogCallback =
2551043a0536SJohnathan Mantey                     [asyncResp, logID, fileName](
2552abf2add6SEd Tanous                         const boost::system::error_code ec,
25537e860f15SJohn Edward Broadbent                         const std::vector<std::pair<std::string, VariantType>>&
25547e860f15SJohn Edward Broadbent                             resp) {
25551da66f75SEd Tanous                         if (ec)
25561da66f75SEd Tanous                         {
2557043a0536SJohnathan Mantey                             BMCWEB_LOG_DEBUG << "failed to get log ec: "
2558043a0536SJohnathan Mantey                                              << ec.message();
2559f12894f8SJason M. Bills                             messages::internalError(asyncResp->res);
25601da66f75SEd Tanous                             return;
25611da66f75SEd Tanous                         }
2562e855dd28SJason M. Bills 
2563043a0536SJohnathan Mantey                         std::string dbusFilename{};
2564043a0536SJohnathan Mantey                         std::string dbusTimestamp{};
2565043a0536SJohnathan Mantey                         std::string dbusFilepath{};
2566043a0536SJohnathan Mantey 
25677e860f15SJohn Edward Broadbent                         parseCrashdumpParameters(resp, dbusFilename,
25687e860f15SJohn Edward Broadbent                                                  dbusTimestamp, dbusFilepath);
2569043a0536SJohnathan Mantey 
2570043a0536SJohnathan Mantey                         if (dbusFilename.empty() || dbusTimestamp.empty() ||
2571043a0536SJohnathan Mantey                             dbusFilepath.empty())
25721da66f75SEd Tanous                         {
25737e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
25747e860f15SJohn Edward Broadbent                                                            fileName);
25751da66f75SEd Tanous                             return;
25761da66f75SEd Tanous                         }
2577e855dd28SJason M. Bills 
2578043a0536SJohnathan Mantey                         // Verify the file name parameter is correct
2579043a0536SJohnathan Mantey                         if (fileName != dbusFilename)
2580043a0536SJohnathan Mantey                         {
25817e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
25827e860f15SJohn Edward Broadbent                                                            fileName);
2583043a0536SJohnathan Mantey                             return;
2584043a0536SJohnathan Mantey                         }
2585043a0536SJohnathan Mantey 
2586043a0536SJohnathan Mantey                         if (!std::filesystem::exists(dbusFilepath))
2587043a0536SJohnathan Mantey                         {
25887e860f15SJohn Edward Broadbent                             messages::resourceMissingAtURI(asyncResp->res,
25897e860f15SJohn Edward Broadbent                                                            fileName);
2590043a0536SJohnathan Mantey                             return;
2591043a0536SJohnathan Mantey                         }
2592043a0536SJohnathan Mantey                         std::ifstream ifs(dbusFilepath, std::ios::in |
2593043a0536SJohnathan Mantey                                                             std::ios::binary |
2594043a0536SJohnathan Mantey                                                             std::ios::ate);
2595043a0536SJohnathan Mantey                         std::ifstream::pos_type fileSize = ifs.tellg();
2596043a0536SJohnathan Mantey                         if (fileSize < 0)
2597043a0536SJohnathan Mantey                         {
2598043a0536SJohnathan Mantey                             messages::generalError(asyncResp->res);
2599043a0536SJohnathan Mantey                             return;
2600043a0536SJohnathan Mantey                         }
2601043a0536SJohnathan Mantey                         ifs.seekg(0, std::ios::beg);
2602043a0536SJohnathan Mantey 
2603043a0536SJohnathan Mantey                         auto crashData = std::make_unique<char[]>(
2604043a0536SJohnathan Mantey                             static_cast<unsigned int>(fileSize));
2605043a0536SJohnathan Mantey 
2606043a0536SJohnathan Mantey                         ifs.read(crashData.get(), static_cast<int>(fileSize));
2607043a0536SJohnathan Mantey 
26087e860f15SJohn Edward Broadbent                         // The cast to std::string is intentional in order to
26097e860f15SJohn Edward Broadbent                         // use the assign() that applies move mechanics
2610043a0536SJohnathan Mantey                         asyncResp->res.body().assign(
2611043a0536SJohnathan Mantey                             static_cast<std::string>(crashData.get()));
2612043a0536SJohnathan Mantey 
26137e860f15SJohn Edward Broadbent                         // Configure this to be a file download when accessed
26147e860f15SJohn Edward Broadbent                         // from a browser
26157e860f15SJohn Edward Broadbent                         asyncResp->res.addHeader("Content-Disposition",
26167e860f15SJohn Edward Broadbent                                                  "attachment");
26171da66f75SEd Tanous                     };
26181da66f75SEd Tanous                 crow::connections::systemBus->async_method_call(
26195b61b5e8SJason M. Bills                     std::move(getStoredLogCallback), crashdumpObject,
26205b61b5e8SJason M. Bills                     crashdumpPath + std::string("/") + logID,
26217e860f15SJohn Edward Broadbent                     "org.freedesktop.DBus.Properties", "GetAll",
26227e860f15SJohn Edward Broadbent                     crashdumpInterface);
26237e860f15SJohn Edward Broadbent             });
26241da66f75SEd Tanous }
26251da66f75SEd Tanous 
26267e860f15SJohn Edward Broadbent inline void requestRoutesCrashdumpCollect(App& app)
26271da66f75SEd Tanous {
26283946028dSAppaRao Puli     // Note: Deviated from redfish privilege registry for GET & HEAD
26293946028dSAppaRao Puli     // method for security reasons.
26307e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/Crashdump/"
26317e860f15SJohn Edward Broadbent                       "Actions/LogService.CollectDiagnosticData/")
2632ed398213SEd Tanous         // The below is incorrect;  Should be ConfigureManager
2633ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2634432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
26357e860f15SJohn Edward Broadbent         .methods(
26367e860f15SJohn Edward Broadbent             boost::beast::http::verb::
26377e860f15SJohn Edward Broadbent                 post)([](const crow::Request& req,
26387e860f15SJohn Edward Broadbent                          const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
26398e6c099aSJason M. Bills             std::string diagnosticDataType;
26408e6c099aSJason M. Bills             std::string oemDiagnosticDataType;
26418e6c099aSJason M. Bills             if (!redfish::json_util::readJson(
26427e860f15SJohn Edward Broadbent                     req, asyncResp->res, "DiagnosticDataType",
26437e860f15SJohn Edward Broadbent                     diagnosticDataType, "OEMDiagnosticDataType",
26447e860f15SJohn Edward Broadbent                     oemDiagnosticDataType))
26458e6c099aSJason M. Bills             {
26468e6c099aSJason M. Bills                 return;
26478e6c099aSJason M. Bills             }
26488e6c099aSJason M. Bills 
26498e6c099aSJason M. Bills             if (diagnosticDataType != "OEM")
26508e6c099aSJason M. Bills             {
26518e6c099aSJason M. Bills                 BMCWEB_LOG_ERROR
26528e6c099aSJason M. Bills                     << "Only OEM DiagnosticDataType supported for Crashdump";
26538e6c099aSJason M. Bills                 messages::actionParameterValueFormatError(
26548e6c099aSJason M. Bills                     asyncResp->res, diagnosticDataType, "DiagnosticDataType",
26558e6c099aSJason M. Bills                     "CollectDiagnosticData");
26568e6c099aSJason M. Bills                 return;
26578e6c099aSJason M. Bills             }
26588e6c099aSJason M. Bills 
26598e6c099aSJason M. Bills             auto collectCrashdumpCallback = [asyncResp, req](
26607e860f15SJohn Edward Broadbent                                                 const boost::system::error_code
26617e860f15SJohn Edward Broadbent                                                     ec,
2662cb13a392SEd Tanous                                                 const std::string&) {
26631da66f75SEd Tanous                 if (ec)
26641da66f75SEd Tanous                 {
26657e860f15SJohn Edward Broadbent                     if (ec.value() ==
26667e860f15SJohn Edward Broadbent                         boost::system::errc::operation_not_supported)
26671da66f75SEd Tanous                     {
2668f12894f8SJason M. Bills                         messages::resourceInStandby(asyncResp->res);
26691da66f75SEd Tanous                     }
26704363d3b2SJason M. Bills                     else if (ec.value() ==
26714363d3b2SJason M. Bills                              boost::system::errc::device_or_resource_busy)
26724363d3b2SJason M. Bills                     {
26734363d3b2SJason M. Bills                         messages::serviceTemporarilyUnavailable(asyncResp->res,
26744363d3b2SJason M. Bills                                                                 "60");
26754363d3b2SJason M. Bills                     }
26761da66f75SEd Tanous                     else
26771da66f75SEd Tanous                     {
2678f12894f8SJason M. Bills                         messages::internalError(asyncResp->res);
26791da66f75SEd Tanous                     }
26801da66f75SEd Tanous                     return;
26811da66f75SEd Tanous                 }
26827e860f15SJohn Edward Broadbent                 std::shared_ptr<task::TaskData> task =
26837e860f15SJohn Edward Broadbent                     task::TaskData::createTask(
26847e860f15SJohn Edward Broadbent                         [](boost::system::error_code err,
26857e860f15SJohn Edward Broadbent                            sdbusplus::message::message&,
268666afe4faSJames Feist                            const std::shared_ptr<task::TaskData>& taskData) {
268766afe4faSJames Feist                             if (!err)
268866afe4faSJames Feist                             {
2689e5d5006bSJames Feist                                 taskData->messages.emplace_back(
2690e5d5006bSJames Feist                                     messages::taskCompletedOK(
2691e5d5006bSJames Feist                                         std::to_string(taskData->index)));
2692831d6b09SJames Feist                                 taskData->state = "Completed";
269366afe4faSJames Feist                             }
269432898ceaSJames Feist                             return task::completed;
269566afe4faSJames Feist                         },
26967e860f15SJohn Edward Broadbent                         "type='signal',interface='org.freedesktop.DBus."
26977e860f15SJohn Edward Broadbent                         "Properties',"
269846229577SJames Feist                         "member='PropertiesChanged',arg0namespace='com.intel."
269946229577SJames Feist                         "crashdump'");
270046229577SJames Feist                 task->startTimer(std::chrono::minutes(5));
270146229577SJames Feist                 task->populateResp(asyncResp->res);
2702fe306728SJames Feist                 task->payload.emplace(req);
27031da66f75SEd Tanous             };
27048e6c099aSJason M. Bills 
27058e6c099aSJason M. Bills             if (oemDiagnosticDataType == "OnDemand")
27068e6c099aSJason M. Bills             {
27071da66f75SEd Tanous                 crow::connections::systemBus->async_method_call(
27088e6c099aSJason M. Bills                     std::move(collectCrashdumpCallback), crashdumpObject,
27098e6c099aSJason M. Bills                     crashdumpPath, crashdumpOnDemandInterface,
27108e6c099aSJason M. Bills                     "GenerateOnDemandLog");
27111da66f75SEd Tanous             }
27128e6c099aSJason M. Bills             else if (oemDiagnosticDataType == "Telemetry")
27136eda7685SKenny L. Ku             {
27148e6c099aSJason M. Bills                 crow::connections::systemBus->async_method_call(
27158e6c099aSJason M. Bills                     std::move(collectCrashdumpCallback), crashdumpObject,
27168e6c099aSJason M. Bills                     crashdumpPath, crashdumpTelemetryInterface,
27178e6c099aSJason M. Bills                     "GenerateTelemetryLog");
27186eda7685SKenny L. Ku             }
27196eda7685SKenny L. Ku             else
27206eda7685SKenny L. Ku             {
27218e6c099aSJason M. Bills                 BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: "
27228e6c099aSJason M. Bills                                  << oemDiagnosticDataType;
27238e6c099aSJason M. Bills                 messages::actionParameterValueFormatError(
27247e860f15SJohn Edward Broadbent                     asyncResp->res, oemDiagnosticDataType,
27257e860f15SJohn Edward Broadbent                     "OEMDiagnosticDataType", "CollectDiagnosticData");
27266eda7685SKenny L. Ku                 return;
27276eda7685SKenny L. Ku             }
27287e860f15SJohn Edward Broadbent         });
27296eda7685SKenny L. Ku }
27306eda7685SKenny L. Ku 
2731cb92c03bSAndrew Geissler /**
2732cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
2733cb92c03bSAndrew Geissler  */
27347e860f15SJohn Edward Broadbent inline void requestRoutesDBusLogServiceActionsClear(App& app)
2735cb92c03bSAndrew Geissler {
2736cb92c03bSAndrew Geissler     /**
2737cb92c03bSAndrew Geissler      * Function handles POST method request.
2738cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
2739cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
2740cb92c03bSAndrew Geissler      */
27417e860f15SJohn Edward Broadbent 
27427e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
27437e860f15SJohn Edward Broadbent                       "LogService.ClearLog/")
2744ed398213SEd Tanous         .privileges(redfish::privileges::postLogService)
27457e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
27467e860f15SJohn Edward Broadbent             [](const crow::Request&,
27477e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2748cb92c03bSAndrew Geissler                 BMCWEB_LOG_DEBUG << "Do delete all entries.";
2749cb92c03bSAndrew Geissler 
2750cb92c03bSAndrew Geissler                 // Process response from Logging service.
27517e860f15SJohn Edward Broadbent                 auto respHandler = [asyncResp](
27527e860f15SJohn Edward Broadbent                                        const boost::system::error_code ec) {
27537e860f15SJohn Edward Broadbent                     BMCWEB_LOG_DEBUG
27547e860f15SJohn Edward Broadbent                         << "doClearLog resp_handler callback: Done";
2755cb92c03bSAndrew Geissler                     if (ec)
2756cb92c03bSAndrew Geissler                     {
2757cb92c03bSAndrew Geissler                         // TODO Handle for specific error code
27587e860f15SJohn Edward Broadbent                         BMCWEB_LOG_ERROR << "doClearLog resp_handler got error "
27597e860f15SJohn Edward Broadbent                                          << ec;
2760cb92c03bSAndrew Geissler                         asyncResp->res.result(
2761cb92c03bSAndrew Geissler                             boost::beast::http::status::internal_server_error);
2762cb92c03bSAndrew Geissler                         return;
2763cb92c03bSAndrew Geissler                     }
2764cb92c03bSAndrew Geissler 
27657e860f15SJohn Edward Broadbent                     asyncResp->res.result(
27667e860f15SJohn Edward Broadbent                         boost::beast::http::status::no_content);
2767cb92c03bSAndrew Geissler                 };
2768cb92c03bSAndrew Geissler 
2769cb92c03bSAndrew Geissler                 // Make call to Logging service to request Clear Log
2770cb92c03bSAndrew Geissler                 crow::connections::systemBus->async_method_call(
27712c70f800SEd Tanous                     respHandler, "xyz.openbmc_project.Logging",
2772cb92c03bSAndrew Geissler                     "/xyz/openbmc_project/logging",
2773cb92c03bSAndrew Geissler                     "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
27747e860f15SJohn Edward Broadbent             });
2775cb92c03bSAndrew Geissler }
2776a3316fc6SZhikuiRen 
2777a3316fc6SZhikuiRen /****************************************************
2778a3316fc6SZhikuiRen  * Redfish PostCode interfaces
2779a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
2780a3316fc6SZhikuiRen  ******************************************************/
27817e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesLogService(App& app)
2782a3316fc6SZhikuiRen {
27837e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
2784ed398213SEd Tanous         .privileges(redfish::privileges::getLogService)
27857e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
27867e860f15SJohn Edward Broadbent             [](const crow::Request&,
27877e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2788a3316fc6SZhikuiRen                 asyncResp->res.jsonValue = {
27897e860f15SJohn Edward Broadbent                     {"@odata.id",
27907e860f15SJohn Edward Broadbent                      "/redfish/v1/Systems/system/LogServices/PostCodes"},
2791a3316fc6SZhikuiRen                     {"@odata.type", "#LogService.v1_1_0.LogService"},
2792a3316fc6SZhikuiRen                     {"Name", "POST Code Log Service"},
2793a3316fc6SZhikuiRen                     {"Description", "POST Code Log Service"},
2794a3316fc6SZhikuiRen                     {"Id", "BIOS POST Code Log"},
2795a3316fc6SZhikuiRen                     {"OverWritePolicy", "WrapsWhenFull"},
2796a3316fc6SZhikuiRen                     {"Entries",
27977e860f15SJohn Edward Broadbent                      {{"@odata.id", "/redfish/v1/Systems/system/LogServices/"
27987e860f15SJohn Edward Broadbent                                     "PostCodes/Entries"}}}};
27997c8c4058STejas Patil 
28007c8c4058STejas Patil                 std::pair<std::string, std::string> redfishDateTimeOffset =
28017c8c4058STejas Patil                     crow::utility::getDateTimeOffsetNow();
28027c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTime"] =
28037c8c4058STejas Patil                     redfishDateTimeOffset.first;
28047c8c4058STejas Patil                 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
28057c8c4058STejas Patil                     redfishDateTimeOffset.second;
28067c8c4058STejas Patil 
2807a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
28087e860f15SJohn Edward Broadbent                     {"target",
28097e860f15SJohn Edward Broadbent                      "/redfish/v1/Systems/system/LogServices/PostCodes/"
2810a3316fc6SZhikuiRen                      "Actions/LogService.ClearLog"}};
28117e860f15SJohn Edward Broadbent             });
2812a3316fc6SZhikuiRen }
2813a3316fc6SZhikuiRen 
28147e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesClear(App& app)
2815a3316fc6SZhikuiRen {
28167e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
28177e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
2818a3316fc6SZhikuiRen                  "LogService.ClearLog/")
2819ed398213SEd Tanous         // The following privilege is incorrect;  It should be ConfigureManager
2820ed398213SEd Tanous         //.privileges(redfish::privileges::postLogService)
2821432a890cSEd Tanous         .privileges({{"ConfigureComponents"}})
28227e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::post)(
28237e860f15SJohn Edward Broadbent             [](const crow::Request&,
28247e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2825a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
2826a3316fc6SZhikuiRen 
2827a3316fc6SZhikuiRen                 // Make call to post-code service to request clear all
2828a3316fc6SZhikuiRen                 crow::connections::systemBus->async_method_call(
2829a3316fc6SZhikuiRen                     [asyncResp](const boost::system::error_code ec) {
2830a3316fc6SZhikuiRen                         if (ec)
2831a3316fc6SZhikuiRen                         {
2832a3316fc6SZhikuiRen                             // TODO Handle for specific error code
2833a3316fc6SZhikuiRen                             BMCWEB_LOG_ERROR
28347e860f15SJohn Edward Broadbent                                 << "doClearPostCodes resp_handler got error "
28357e860f15SJohn Edward Broadbent                                 << ec;
28367e860f15SJohn Edward Broadbent                             asyncResp->res.result(boost::beast::http::status::
28377e860f15SJohn Edward Broadbent                                                       internal_server_error);
2838a3316fc6SZhikuiRen                             messages::internalError(asyncResp->res);
2839a3316fc6SZhikuiRen                             return;
2840a3316fc6SZhikuiRen                         }
2841a3316fc6SZhikuiRen                     },
284215124765SJonathan Doman                     "xyz.openbmc_project.State.Boot.PostCode0",
284315124765SJonathan Doman                     "/xyz/openbmc_project/State/Boot/PostCode0",
2844a3316fc6SZhikuiRen                     "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
28457e860f15SJohn Edward Broadbent             });
2846a3316fc6SZhikuiRen }
2847a3316fc6SZhikuiRen 
2848a3316fc6SZhikuiRen static void fillPostCodeEntry(
28498d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& aResp,
28506c9a279eSManojkiran Eda     const boost::container::flat_map<
28516c9a279eSManojkiran Eda         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
2852a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
2853a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
2854a3316fc6SZhikuiRen {
2855a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
2856a3316fc6SZhikuiRen     const message_registries::Message* message =
28574a0bf539SManojkiran Eda         message_registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
2858a3316fc6SZhikuiRen 
2859a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
2860a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
2861a3316fc6SZhikuiRen 
2862a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
28636c9a279eSManojkiran Eda     for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
28646c9a279eSManojkiran Eda              code : postcode)
2865a3316fc6SZhikuiRen     {
2866a3316fc6SZhikuiRen         currentCodeIndex++;
2867a3316fc6SZhikuiRen         std::string postcodeEntryID =
2868a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
2869a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
2870a3316fc6SZhikuiRen 
2871a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
2872a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
2873a3316fc6SZhikuiRen 
2874a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
2875a3316fc6SZhikuiRen         { // already incremented
2876a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
2877a3316fc6SZhikuiRen         }
2878a3316fc6SZhikuiRen         else
2879a3316fc6SZhikuiRen         {
2880a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
2881a3316fc6SZhikuiRen         }
2882a3316fc6SZhikuiRen 
2883a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
2884a3316fc6SZhikuiRen         // not fall between top and skip
2885a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
2886a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
2887a3316fc6SZhikuiRen         {
2888a3316fc6SZhikuiRen             continue;
2889a3316fc6SZhikuiRen         }
2890a3316fc6SZhikuiRen 
28914e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
2892a3316fc6SZhikuiRen         // currentIndex
2893a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
2894a3316fc6SZhikuiRen         {
2895a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
2896a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
2897a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
2898a3316fc6SZhikuiRen             continue;
2899a3316fc6SZhikuiRen         }
2900a3316fc6SZhikuiRen 
2901a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
2902a3316fc6SZhikuiRen         // index
2903a3316fc6SZhikuiRen 
2904a3316fc6SZhikuiRen         // Get the Created time from the timestamp
2905a3316fc6SZhikuiRen         std::string entryTimeStr;
29069c620e21SAsmitha Karunanithi         entryTimeStr = crow::utility::getDateTime(
29079c620e21SAsmitha Karunanithi             static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000));
2908a3316fc6SZhikuiRen 
2909a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
2910a3316fc6SZhikuiRen         std::ostringstream hexCode;
2911a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
29126c9a279eSManojkiran Eda                 << std::get<0>(code.second);
2913a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
2914a3316fc6SZhikuiRen         // Set Fixed -Point Notation
2915a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
2916a3316fc6SZhikuiRen         // Set precision to 4 digits
2917a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
2918a3316fc6SZhikuiRen         // Add double to stream
2919a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
2920a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
2921a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
2922a3316fc6SZhikuiRen 
2923a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
2924a3316fc6SZhikuiRen         std::string msg;
2925a3316fc6SZhikuiRen         if (message != nullptr)
2926a3316fc6SZhikuiRen         {
2927a3316fc6SZhikuiRen             msg = message->message;
2928a3316fc6SZhikuiRen 
2929a3316fc6SZhikuiRen             // fill in this post code value
2930a3316fc6SZhikuiRen             int i = 0;
2931a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
2932a3316fc6SZhikuiRen             {
2933a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
2934a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
2935a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
2936a3316fc6SZhikuiRen                 {
2937a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
2938a3316fc6SZhikuiRen                 }
2939a3316fc6SZhikuiRen             }
2940a3316fc6SZhikuiRen         }
2941a3316fc6SZhikuiRen 
2942d4342a92STim Lee         // Get Severity template from message registry
2943d4342a92STim Lee         std::string severity;
2944d4342a92STim Lee         if (message != nullptr)
2945d4342a92STim Lee         {
2946d4342a92STim Lee             severity = message->severity;
2947d4342a92STim Lee         }
2948d4342a92STim Lee 
2949a3316fc6SZhikuiRen         // add to AsyncResp
2950a3316fc6SZhikuiRen         logEntryArray.push_back({});
2951a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
2952d0dbeefdSEd Tanous         bmcLogEntry = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2953a3316fc6SZhikuiRen                        {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
2954a3316fc6SZhikuiRen                                      "PostCodes/Entries/" +
2955a3316fc6SZhikuiRen                                          postcodeEntryID},
2956a3316fc6SZhikuiRen                        {"Name", "POST Code Log Entry"},
2957a3316fc6SZhikuiRen                        {"Id", postcodeEntryID},
2958a3316fc6SZhikuiRen                        {"Message", std::move(msg)},
29594a0bf539SManojkiran Eda                        {"MessageId", "OpenBMC.0.2.BIOSPOSTCode"},
2960a3316fc6SZhikuiRen                        {"MessageArgs", std::move(messageArgs)},
2961a3316fc6SZhikuiRen                        {"EntryType", "Event"},
2962a3316fc6SZhikuiRen                        {"Severity", std::move(severity)},
29639c620e21SAsmitha Karunanithi                        {"Created", entryTimeStr}};
2964a3316fc6SZhikuiRen     }
2965a3316fc6SZhikuiRen }
2966a3316fc6SZhikuiRen 
29678d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
2968a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
2969a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
2970a3316fc6SZhikuiRen {
2971a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
29726c9a279eSManojkiran Eda         [aResp, bootIndex,
29736c9a279eSManojkiran Eda          codeIndex](const boost::system::error_code ec,
29746c9a279eSManojkiran Eda                     const boost::container::flat_map<
29756c9a279eSManojkiran Eda                         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
29766c9a279eSManojkiran Eda                         postcode) {
2977a3316fc6SZhikuiRen             if (ec)
2978a3316fc6SZhikuiRen             {
2979a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
2980a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2981a3316fc6SZhikuiRen                 return;
2982a3316fc6SZhikuiRen             }
2983a3316fc6SZhikuiRen 
2984a3316fc6SZhikuiRen             // skip the empty postcode boots
2985a3316fc6SZhikuiRen             if (postcode.empty())
2986a3316fc6SZhikuiRen             {
2987a3316fc6SZhikuiRen                 return;
2988a3316fc6SZhikuiRen             }
2989a3316fc6SZhikuiRen 
2990a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
2991a3316fc6SZhikuiRen 
2992a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
2993a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
2994a3316fc6SZhikuiRen         },
299515124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
299615124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
2997a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
2998a3316fc6SZhikuiRen         bootIndex);
2999a3316fc6SZhikuiRen }
3000a3316fc6SZhikuiRen 
30018d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3002a3316fc6SZhikuiRen                                const uint16_t bootIndex,
3003a3316fc6SZhikuiRen                                const uint16_t bootCount,
3004a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
3005a3316fc6SZhikuiRen                                const uint64_t top)
3006a3316fc6SZhikuiRen {
3007a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3008a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
3009a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
30106c9a279eSManojkiran Eda               const boost::container::flat_map<
30116c9a279eSManojkiran Eda                   uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
30126c9a279eSManojkiran Eda                   postcode) {
3013a3316fc6SZhikuiRen             if (ec)
3014a3316fc6SZhikuiRen             {
3015a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3016a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3017a3316fc6SZhikuiRen                 return;
3018a3316fc6SZhikuiRen             }
3019a3316fc6SZhikuiRen 
3020a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
3021a3316fc6SZhikuiRen             if (!postcode.empty())
3022a3316fc6SZhikuiRen             {
3023a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
3024a3316fc6SZhikuiRen 
3025a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
3026a3316fc6SZhikuiRen                 {
3027a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
3028a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
3029a3316fc6SZhikuiRen                     uint64_t thisBootTop =
3030a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
3031a3316fc6SZhikuiRen 
3032a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3033a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
3034a3316fc6SZhikuiRen                 }
3035a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
3036a3316fc6SZhikuiRen             }
3037a3316fc6SZhikuiRen 
3038a3316fc6SZhikuiRen             // continue to previous bootIndex
3039a3316fc6SZhikuiRen             if (bootIndex < bootCount)
3040a3316fc6SZhikuiRen             {
3041a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3042a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
3043a3316fc6SZhikuiRen             }
3044a3316fc6SZhikuiRen             else
3045a3316fc6SZhikuiRen             {
3046a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
3047a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3048a3316fc6SZhikuiRen                     "Entries?$skip=" +
3049a3316fc6SZhikuiRen                     std::to_string(skip + top);
3050a3316fc6SZhikuiRen             }
3051a3316fc6SZhikuiRen         },
305215124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
305315124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3054a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3055a3316fc6SZhikuiRen         bootIndex);
3056a3316fc6SZhikuiRen }
3057a3316fc6SZhikuiRen 
30588d1b46d7Szhanghch05 static void
30598d1b46d7Szhanghch05     getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3060a3316fc6SZhikuiRen                          const uint64_t skip, const uint64_t top)
3061a3316fc6SZhikuiRen {
3062a3316fc6SZhikuiRen     uint64_t entryCount = 0;
3063a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3064a3316fc6SZhikuiRen         [aResp, entryCount, skip,
3065a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3066a3316fc6SZhikuiRen               const std::variant<uint16_t>& bootCount) {
3067a3316fc6SZhikuiRen             if (ec)
3068a3316fc6SZhikuiRen             {
3069a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3070a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3071a3316fc6SZhikuiRen                 return;
3072a3316fc6SZhikuiRen             }
3073a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
3074a3316fc6SZhikuiRen             if (pVal)
3075a3316fc6SZhikuiRen             {
3076a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
3077a3316fc6SZhikuiRen             }
3078a3316fc6SZhikuiRen             else
3079a3316fc6SZhikuiRen             {
3080a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
3081a3316fc6SZhikuiRen             }
3082a3316fc6SZhikuiRen         },
308315124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
308415124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3085a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
3086a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
3087a3316fc6SZhikuiRen }
3088a3316fc6SZhikuiRen 
30897e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntryCollection(App& app)
3090a3316fc6SZhikuiRen {
30917e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
30927e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3093ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntryCollection)
30947e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
30957e860f15SJohn Edward Broadbent             [](const crow::Request& req,
30967e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
3097a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.type"] =
3098a3316fc6SZhikuiRen                     "#LogEntryCollection.LogEntryCollection";
3099a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.id"] =
3100a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3101a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3102a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Description"] =
3103a3316fc6SZhikuiRen                     "Collection of POST Code Log Entries";
3104a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3105a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3106a3316fc6SZhikuiRen 
3107a3316fc6SZhikuiRen                 uint64_t skip = 0;
3108a3316fc6SZhikuiRen                 uint64_t top = maxEntriesPerPage; // Show max entries by default
31098d1b46d7Szhanghch05                 if (!getSkipParam(asyncResp, req, skip))
3110a3316fc6SZhikuiRen                 {
3111a3316fc6SZhikuiRen                     return;
3112a3316fc6SZhikuiRen                 }
31138d1b46d7Szhanghch05                 if (!getTopParam(asyncResp, req, top))
3114a3316fc6SZhikuiRen                 {
3115a3316fc6SZhikuiRen                     return;
3116a3316fc6SZhikuiRen                 }
3117a3316fc6SZhikuiRen                 getCurrentBootNumber(asyncResp, skip, top);
31187e860f15SJohn Edward Broadbent             });
3119a3316fc6SZhikuiRen }
3120a3316fc6SZhikuiRen 
31217e860f15SJohn Edward Broadbent inline void requestRoutesPostCodesEntry(App& app)
3122a3316fc6SZhikuiRen {
31237e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(
31247e860f15SJohn Edward Broadbent         app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/")
3125ed398213SEd Tanous         .privileges(redfish::privileges::getLogEntry)
31267e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
31277e860f15SJohn Edward Broadbent             [](const crow::Request&,
31287e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
31297e860f15SJohn Edward Broadbent                const std::string& targetID) {
3130a3316fc6SZhikuiRen                 size_t bootPos = targetID.find('B');
3131a3316fc6SZhikuiRen                 if (bootPos == std::string::npos)
3132a3316fc6SZhikuiRen                 {
3133a3316fc6SZhikuiRen                     // Requested ID was not found
3134a3316fc6SZhikuiRen                     messages::resourceMissingAtURI(asyncResp->res, targetID);
3135a3316fc6SZhikuiRen                     return;
3136a3316fc6SZhikuiRen                 }
3137a3316fc6SZhikuiRen                 std::string_view bootIndexStr(targetID);
3138a3316fc6SZhikuiRen                 bootIndexStr.remove_prefix(bootPos + 1);
3139a3316fc6SZhikuiRen                 uint16_t bootIndex = 0;
3140a3316fc6SZhikuiRen                 uint64_t codeIndex = 0;
3141a3316fc6SZhikuiRen                 size_t dashPos = bootIndexStr.find('-');
3142a3316fc6SZhikuiRen 
3143a3316fc6SZhikuiRen                 if (dashPos == std::string::npos)
3144a3316fc6SZhikuiRen                 {
3145a3316fc6SZhikuiRen                     return;
3146a3316fc6SZhikuiRen                 }
3147a3316fc6SZhikuiRen                 std::string_view codeIndexStr(bootIndexStr);
3148a3316fc6SZhikuiRen                 bootIndexStr.remove_suffix(dashPos);
3149a3316fc6SZhikuiRen                 codeIndexStr.remove_prefix(dashPos + 1);
3150a3316fc6SZhikuiRen 
3151a3316fc6SZhikuiRen                 bootIndex = static_cast<uint16_t>(
315223a21a1cSEd Tanous                     strtoul(std::string(bootIndexStr).c_str(), nullptr, 0));
31537e860f15SJohn Edward Broadbent                 codeIndex =
31547e860f15SJohn Edward Broadbent                     strtoul(std::string(codeIndexStr).c_str(), nullptr, 0);
3155a3316fc6SZhikuiRen                 if (bootIndex == 0 || codeIndex == 0)
3156a3316fc6SZhikuiRen                 {
3157a3316fc6SZhikuiRen                     BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
31587e860f15SJohn Edward Broadbent                                      << targetID;
3159a3316fc6SZhikuiRen                 }
3160a3316fc6SZhikuiRen 
31617e860f15SJohn Edward Broadbent                 asyncResp->res.jsonValue["@odata.type"] =
31627e860f15SJohn Edward Broadbent                     "#LogEntry.v1_4_0.LogEntry";
3163a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["@odata.id"] =
3164a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3165a3316fc6SZhikuiRen                     "Entries";
3166a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3167a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Description"] =
3168a3316fc6SZhikuiRen                     "Collection of POST Code Log Entries";
3169a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3170a3316fc6SZhikuiRen                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3171a3316fc6SZhikuiRen 
3172a3316fc6SZhikuiRen                 getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
31737e860f15SJohn Edward Broadbent             });
3174a3316fc6SZhikuiRen }
3175a3316fc6SZhikuiRen 
31761da66f75SEd Tanous } // namespace redfish
3177