xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision 013487e5d56e4e7964e85a38d6c3044f081a753b)
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 
181da66f75SEd Tanous #include "node.hpp"
194851d45dSJason M. Bills #include "registries.hpp"
204851d45dSJason M. Bills #include "registries/base_message_registry.hpp"
214851d45dSJason M. Bills #include "registries/openbmc_message_registry.hpp"
2246229577SJames Feist #include "task.hpp"
231da66f75SEd Tanous 
24e1f26343SJason M. Bills #include <systemd/sd-journal.h>
25e1f26343SJason M. Bills 
264851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp>
274851d45dSJason M. Bills #include <boost/beast/core/span.hpp>
281da66f75SEd Tanous #include <boost/container/flat_map.hpp>
291ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp>
300657843aSraviteja-b #include <dump_offload.hpp>
31cb92c03bSAndrew Geissler #include <error_messages.hpp>
324418c7f0SJames Feist #include <filesystem>
33cd225da8SJason M. Bills #include <string_view>
34abf2add6SEd Tanous #include <variant>
351da66f75SEd Tanous 
361da66f75SEd Tanous namespace redfish
371da66f75SEd Tanous {
381da66f75SEd Tanous 
395b61b5e8SJason M. Bills constexpr char const *crashdumpObject = "com.intel.crashdump";
405b61b5e8SJason M. Bills constexpr char const *crashdumpPath = "/com/intel/crashdump";
415b61b5e8SJason M. Bills constexpr char const *crashdumpOnDemandPath = "/com/intel/crashdump/OnDemand";
425b61b5e8SJason M. Bills constexpr char const *crashdumpInterface = "com.intel.crashdump";
435b61b5e8SJason M. Bills constexpr char const *deleteAllInterface =
445b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
455b61b5e8SJason M. Bills constexpr char const *crashdumpOnDemandInterface =
46424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
475b61b5e8SJason M. Bills constexpr char const *crashdumpRawPECIInterface =
48424c4176SJason M. Bills     "com.intel.crashdump.SendRawPeci";
491da66f75SEd Tanous 
504851d45dSJason M. Bills namespace message_registries
514851d45dSJason M. Bills {
524851d45dSJason M. Bills static const Message *getMessageFromRegistry(
534851d45dSJason M. Bills     const std::string &messageKey,
544851d45dSJason M. Bills     const boost::beast::span<const MessageEntry> registry)
554851d45dSJason M. Bills {
564851d45dSJason M. Bills     boost::beast::span<const MessageEntry>::const_iterator messageIt =
574851d45dSJason M. Bills         std::find_if(registry.cbegin(), registry.cend(),
584851d45dSJason M. Bills                      [&messageKey](const MessageEntry &messageEntry) {
594851d45dSJason M. Bills                          return !std::strcmp(messageEntry.first,
604851d45dSJason M. Bills                                              messageKey.c_str());
614851d45dSJason M. Bills                      });
624851d45dSJason M. Bills     if (messageIt != registry.cend())
634851d45dSJason M. Bills     {
644851d45dSJason M. Bills         return &messageIt->second;
654851d45dSJason M. Bills     }
664851d45dSJason M. Bills 
674851d45dSJason M. Bills     return nullptr;
684851d45dSJason M. Bills }
694851d45dSJason M. Bills 
704851d45dSJason M. Bills static const Message *getMessage(const std::string_view &messageID)
714851d45dSJason M. Bills {
724851d45dSJason M. Bills     // Redfish MessageIds are in the form
734851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
744851d45dSJason M. Bills     // the right Message
754851d45dSJason M. Bills     std::vector<std::string> fields;
764851d45dSJason M. Bills     fields.reserve(4);
774851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
784851d45dSJason M. Bills     std::string &registryName = fields[0];
794851d45dSJason M. Bills     std::string &messageKey = fields[3];
804851d45dSJason M. Bills 
814851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
824851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
834851d45dSJason M. Bills     {
844851d45dSJason M. Bills         return getMessageFromRegistry(
854851d45dSJason M. Bills             messageKey, boost::beast::span<const MessageEntry>(base::registry));
864851d45dSJason M. Bills     }
874851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
884851d45dSJason M. Bills     {
894851d45dSJason M. Bills         return getMessageFromRegistry(
904851d45dSJason M. Bills             messageKey,
914851d45dSJason M. Bills             boost::beast::span<const MessageEntry>(openbmc::registry));
924851d45dSJason M. Bills     }
934851d45dSJason M. Bills     return nullptr;
944851d45dSJason M. Bills }
954851d45dSJason M. Bills } // namespace message_registries
964851d45dSJason M. Bills 
97f6150403SJames Feist namespace fs = std::filesystem;
981da66f75SEd Tanous 
99cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map<
10019bd78d9SPatrick Williams     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
101cb92c03bSAndrew Geissler                               int32_t, uint32_t, int64_t, uint64_t, double>>;
102cb92c03bSAndrew Geissler 
103cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map<
104cb92c03bSAndrew Geissler     sdbusplus::message::object_path,
105cb92c03bSAndrew Geissler     boost::container::flat_map<std::string, GetManagedPropertyType>>;
106cb92c03bSAndrew Geissler 
107cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string &s)
108cb92c03bSAndrew Geissler {
109cb92c03bSAndrew Geissler     if (s == "xyz.openbmc_project.Logging.Entry.Level.Alert")
110cb92c03bSAndrew Geissler     {
111cb92c03bSAndrew Geissler         return "Critical";
112cb92c03bSAndrew Geissler     }
113cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Critical")
114cb92c03bSAndrew Geissler     {
115cb92c03bSAndrew Geissler         return "Critical";
116cb92c03bSAndrew Geissler     }
117cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Debug")
118cb92c03bSAndrew Geissler     {
119cb92c03bSAndrew Geissler         return "OK";
120cb92c03bSAndrew Geissler     }
121cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency")
122cb92c03bSAndrew Geissler     {
123cb92c03bSAndrew Geissler         return "Critical";
124cb92c03bSAndrew Geissler     }
125cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Error")
126cb92c03bSAndrew Geissler     {
127cb92c03bSAndrew Geissler         return "Critical";
128cb92c03bSAndrew Geissler     }
129cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Informational")
130cb92c03bSAndrew Geissler     {
131cb92c03bSAndrew Geissler         return "OK";
132cb92c03bSAndrew Geissler     }
133cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")
134cb92c03bSAndrew Geissler     {
135cb92c03bSAndrew Geissler         return "OK";
136cb92c03bSAndrew Geissler     }
137cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
138cb92c03bSAndrew Geissler     {
139cb92c03bSAndrew Geissler         return "Warning";
140cb92c03bSAndrew Geissler     }
141cb92c03bSAndrew Geissler     return "";
142cb92c03bSAndrew Geissler }
143cb92c03bSAndrew Geissler 
144c9bb6861Sraviteja-b inline void deleteSystemDumpEntry(crow::Response &res,
145c9bb6861Sraviteja-b                                   const std::string &entryID)
146c9bb6861Sraviteja-b {
147c9bb6861Sraviteja-b     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
148c9bb6861Sraviteja-b 
149c9bb6861Sraviteja-b     auto respHandler = [asyncResp](const boost::system::error_code ec) {
150c9bb6861Sraviteja-b         BMCWEB_LOG_DEBUG << "System Dump Entry doDelete callback: Done";
151c9bb6861Sraviteja-b         if (ec)
152c9bb6861Sraviteja-b         {
153c9bb6861Sraviteja-b             BMCWEB_LOG_ERROR
154c9bb6861Sraviteja-b                 << "System Dump (DBus) doDelete respHandler got error " << ec;
155c9bb6861Sraviteja-b             asyncResp->res.result(
156c9bb6861Sraviteja-b                 boost::beast::http::status::internal_server_error);
157c9bb6861Sraviteja-b             return;
158c9bb6861Sraviteja-b         }
159c9bb6861Sraviteja-b     };
160c9bb6861Sraviteja-b     crow::connections::systemBus->async_method_call(
161c9bb6861Sraviteja-b         respHandler, "xyz.openbmc_project.Dump.Manager",
162c9bb6861Sraviteja-b         "/xyz/openbmc_project/dump/entry/" + entryID,
163c9bb6861Sraviteja-b         "xyz.openbmc_project.Object.Delete", "Delete");
164c9bb6861Sraviteja-b }
165c9bb6861Sraviteja-b 
16616428a1aSJason M. Bills static int getJournalMetadata(sd_journal *journal,
16739e77504SEd Tanous                               const std::string_view &field,
16839e77504SEd Tanous                               std::string_view &contents)
16916428a1aSJason M. Bills {
17016428a1aSJason M. Bills     const char *data = nullptr;
17116428a1aSJason M. Bills     size_t length = 0;
17216428a1aSJason M. Bills     int ret = 0;
17316428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
174271584abSEd Tanous     ret = sd_journal_get_data(journal, field.data(),
175271584abSEd Tanous                               reinterpret_cast<const void **>(&data), &length);
17616428a1aSJason M. Bills     if (ret < 0)
17716428a1aSJason M. Bills     {
17816428a1aSJason M. Bills         return ret;
17916428a1aSJason M. Bills     }
18039e77504SEd Tanous     contents = std::string_view(data, length);
18116428a1aSJason M. Bills     // Only use the content after the "=" character.
18216428a1aSJason M. Bills     contents.remove_prefix(std::min(contents.find("=") + 1, contents.size()));
18316428a1aSJason M. Bills     return ret;
18416428a1aSJason M. Bills }
18516428a1aSJason M. Bills 
18616428a1aSJason M. Bills static int getJournalMetadata(sd_journal *journal,
18739e77504SEd Tanous                               const std::string_view &field, const int &base,
188271584abSEd Tanous                               long int &contents)
18916428a1aSJason M. Bills {
19016428a1aSJason M. Bills     int ret = 0;
19139e77504SEd Tanous     std::string_view metadata;
19216428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
19316428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
19416428a1aSJason M. Bills     if (ret < 0)
19516428a1aSJason M. Bills     {
19616428a1aSJason M. Bills         return ret;
19716428a1aSJason M. Bills     }
198b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
19916428a1aSJason M. Bills     return ret;
20016428a1aSJason M. Bills }
20116428a1aSJason M. Bills 
202a3316fc6SZhikuiRen static bool getTimestampStr(const uint64_t usecSinceEpoch,
203a3316fc6SZhikuiRen                             std::string &entryTimestamp)
20416428a1aSJason M. Bills {
205a3316fc6SZhikuiRen     time_t t = static_cast<time_t>(usecSinceEpoch / 1000 / 1000);
20616428a1aSJason M. Bills     struct tm *loctime = localtime(&t);
20716428a1aSJason M. Bills     char entryTime[64] = {};
20899131cd0SEd Tanous     if (nullptr != loctime)
20916428a1aSJason M. Bills     {
21016428a1aSJason M. Bills         strftime(entryTime, sizeof(entryTime), "%FT%T%z", loctime);
21116428a1aSJason M. Bills     }
21216428a1aSJason M. Bills     // Insert the ':' into the timezone
21339e77504SEd Tanous     std::string_view t1(entryTime);
21439e77504SEd Tanous     std::string_view t2(entryTime);
21516428a1aSJason M. Bills     if (t1.size() > 2 && t2.size() > 2)
21616428a1aSJason M. Bills     {
21716428a1aSJason M. Bills         t1.remove_suffix(2);
21816428a1aSJason M. Bills         t2.remove_prefix(t2.size() - 2);
21916428a1aSJason M. Bills     }
22039e77504SEd Tanous     entryTimestamp = std::string(t1) + ":" + std::string(t2);
22116428a1aSJason M. Bills     return true;
22216428a1aSJason M. Bills }
22316428a1aSJason M. Bills 
224a3316fc6SZhikuiRen static bool getEntryTimestamp(sd_journal *journal, std::string &entryTimestamp)
225a3316fc6SZhikuiRen {
226a3316fc6SZhikuiRen     int ret = 0;
227a3316fc6SZhikuiRen     uint64_t timestamp = 0;
228a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
229a3316fc6SZhikuiRen     if (ret < 0)
230a3316fc6SZhikuiRen     {
231a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
232a3316fc6SZhikuiRen                          << strerror(-ret);
233a3316fc6SZhikuiRen         return false;
234a3316fc6SZhikuiRen     }
235a3316fc6SZhikuiRen     return getTimestampStr(timestamp, entryTimestamp);
236a3316fc6SZhikuiRen }
237a3316fc6SZhikuiRen 
23816428a1aSJason M. Bills static bool getSkipParam(crow::Response &res, const crow::Request &req,
239271584abSEd Tanous                          uint64_t &skip)
24016428a1aSJason M. Bills {
24116428a1aSJason M. Bills     char *skipParam = req.urlParams.get("$skip");
24216428a1aSJason M. Bills     if (skipParam != nullptr)
24316428a1aSJason M. Bills     {
24416428a1aSJason M. Bills         char *ptr = nullptr;
245271584abSEd Tanous         skip = std::strtoul(skipParam, &ptr, 10);
24616428a1aSJason M. Bills         if (*skipParam == '\0' || *ptr != '\0')
24716428a1aSJason M. Bills         {
24816428a1aSJason M. Bills 
24916428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(skipParam),
25016428a1aSJason M. Bills                                                    "$skip");
25116428a1aSJason M. Bills             return false;
25216428a1aSJason M. Bills         }
25316428a1aSJason M. Bills     }
25416428a1aSJason M. Bills     return true;
25516428a1aSJason M. Bills }
25616428a1aSJason M. Bills 
257271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
25816428a1aSJason M. Bills static bool getTopParam(crow::Response &res, const crow::Request &req,
259271584abSEd Tanous                         uint64_t &top)
26016428a1aSJason M. Bills {
26116428a1aSJason M. Bills     char *topParam = req.urlParams.get("$top");
26216428a1aSJason M. Bills     if (topParam != nullptr)
26316428a1aSJason M. Bills     {
26416428a1aSJason M. Bills         char *ptr = nullptr;
265271584abSEd Tanous         top = std::strtoul(topParam, &ptr, 10);
26616428a1aSJason M. Bills         if (*topParam == '\0' || *ptr != '\0')
26716428a1aSJason M. Bills         {
26816428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(topParam),
26916428a1aSJason M. Bills                                                    "$top");
27016428a1aSJason M. Bills             return false;
27116428a1aSJason M. Bills         }
272271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
27316428a1aSJason M. Bills         {
27416428a1aSJason M. Bills 
27516428a1aSJason M. Bills             messages::queryParameterOutOfRange(
27616428a1aSJason M. Bills                 res, std::to_string(top), "$top",
27716428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
27816428a1aSJason M. Bills             return false;
27916428a1aSJason M. Bills         }
28016428a1aSJason M. Bills     }
28116428a1aSJason M. Bills     return true;
28216428a1aSJason M. Bills }
28316428a1aSJason M. Bills 
284e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal *journal, std::string &entryID,
285e85d6b16SJason M. Bills                              const bool firstEntry = true)
28616428a1aSJason M. Bills {
28716428a1aSJason M. Bills     int ret = 0;
28816428a1aSJason M. Bills     static uint64_t prevTs = 0;
28916428a1aSJason M. Bills     static int index = 0;
290e85d6b16SJason M. Bills     if (firstEntry)
291e85d6b16SJason M. Bills     {
292e85d6b16SJason M. Bills         prevTs = 0;
293e85d6b16SJason M. Bills     }
294e85d6b16SJason M. Bills 
29516428a1aSJason M. Bills     // Get the entry timestamp
29616428a1aSJason M. Bills     uint64_t curTs = 0;
29716428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
29816428a1aSJason M. Bills     if (ret < 0)
29916428a1aSJason M. Bills     {
30016428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
30116428a1aSJason M. Bills                          << strerror(-ret);
30216428a1aSJason M. Bills         return false;
30316428a1aSJason M. Bills     }
30416428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
30516428a1aSJason M. Bills     if (curTs == prevTs)
30616428a1aSJason M. Bills     {
30716428a1aSJason M. Bills         index++;
30816428a1aSJason M. Bills     }
30916428a1aSJason M. Bills     else
31016428a1aSJason M. Bills     {
31116428a1aSJason M. Bills         // Otherwise, reset it
31216428a1aSJason M. Bills         index = 0;
31316428a1aSJason M. Bills     }
31416428a1aSJason M. Bills     // Save the timestamp
31516428a1aSJason M. Bills     prevTs = curTs;
31616428a1aSJason M. Bills 
31716428a1aSJason M. Bills     entryID = std::to_string(curTs);
31816428a1aSJason M. Bills     if (index > 0)
31916428a1aSJason M. Bills     {
32016428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
32116428a1aSJason M. Bills     }
32216428a1aSJason M. Bills     return true;
32316428a1aSJason M. Bills }
32416428a1aSJason M. Bills 
325e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string &logEntry, std::string &entryID,
326e85d6b16SJason M. Bills                              const bool firstEntry = true)
32795820184SJason M. Bills {
328271584abSEd Tanous     static time_t prevTs = 0;
32995820184SJason M. Bills     static int index = 0;
330e85d6b16SJason M. Bills     if (firstEntry)
331e85d6b16SJason M. Bills     {
332e85d6b16SJason M. Bills         prevTs = 0;
333e85d6b16SJason M. Bills     }
334e85d6b16SJason M. Bills 
33595820184SJason M. Bills     // Get the entry timestamp
336271584abSEd Tanous     std::time_t curTs = 0;
33795820184SJason M. Bills     std::tm timeStruct = {};
33895820184SJason M. Bills     std::istringstream entryStream(logEntry);
33995820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
34095820184SJason M. Bills     {
34195820184SJason M. Bills         curTs = std::mktime(&timeStruct);
34295820184SJason M. Bills     }
34395820184SJason M. Bills     // If the timestamp isn't unique, increment the index
34495820184SJason M. Bills     if (curTs == prevTs)
34595820184SJason M. Bills     {
34695820184SJason M. Bills         index++;
34795820184SJason M. Bills     }
34895820184SJason M. Bills     else
34995820184SJason M. Bills     {
35095820184SJason M. Bills         // Otherwise, reset it
35195820184SJason M. Bills         index = 0;
35295820184SJason M. Bills     }
35395820184SJason M. Bills     // Save the timestamp
35495820184SJason M. Bills     prevTs = curTs;
35595820184SJason M. Bills 
35695820184SJason M. Bills     entryID = std::to_string(curTs);
35795820184SJason M. Bills     if (index > 0)
35895820184SJason M. Bills     {
35995820184SJason M. Bills         entryID += "_" + std::to_string(index);
36095820184SJason M. Bills     }
36195820184SJason M. Bills     return true;
36295820184SJason M. Bills }
36395820184SJason M. Bills 
36416428a1aSJason M. Bills static bool getTimestampFromID(crow::Response &res, const std::string &entryID,
365271584abSEd Tanous                                uint64_t &timestamp, uint64_t &index)
36616428a1aSJason M. Bills {
36716428a1aSJason M. Bills     if (entryID.empty())
36816428a1aSJason M. Bills     {
36916428a1aSJason M. Bills         return false;
37016428a1aSJason M. Bills     }
37116428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
37239e77504SEd Tanous     std::string_view tsStr(entryID);
37316428a1aSJason M. Bills 
37416428a1aSJason M. Bills     auto underscorePos = tsStr.find("_");
37516428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
37616428a1aSJason M. Bills     {
37716428a1aSJason M. Bills         // Timestamp has an index
37816428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
37939e77504SEd Tanous         std::string_view indexStr(entryID);
38016428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
38116428a1aSJason M. Bills         std::size_t pos;
38216428a1aSJason M. Bills         try
38316428a1aSJason M. Bills         {
38439e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
38516428a1aSJason M. Bills         }
386271584abSEd Tanous         catch (std::invalid_argument &)
38716428a1aSJason M. Bills         {
38816428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
38916428a1aSJason M. Bills             return false;
39016428a1aSJason M. Bills         }
391271584abSEd Tanous         catch (std::out_of_range &)
39216428a1aSJason M. Bills         {
39316428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
39416428a1aSJason M. Bills             return false;
39516428a1aSJason M. Bills         }
39616428a1aSJason M. Bills         if (pos != indexStr.size())
39716428a1aSJason M. Bills         {
39816428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
39916428a1aSJason M. Bills             return false;
40016428a1aSJason M. Bills         }
40116428a1aSJason M. Bills     }
40216428a1aSJason M. Bills     // Timestamp has no index
40316428a1aSJason M. Bills     std::size_t pos;
40416428a1aSJason M. Bills     try
40516428a1aSJason M. Bills     {
40639e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
40716428a1aSJason M. Bills     }
408271584abSEd Tanous     catch (std::invalid_argument &)
40916428a1aSJason M. Bills     {
41016428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
41116428a1aSJason M. Bills         return false;
41216428a1aSJason M. Bills     }
413271584abSEd Tanous     catch (std::out_of_range &)
41416428a1aSJason M. Bills     {
41516428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
41616428a1aSJason M. Bills         return false;
41716428a1aSJason M. Bills     }
41816428a1aSJason M. Bills     if (pos != tsStr.size())
41916428a1aSJason M. Bills     {
42016428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
42116428a1aSJason M. Bills         return false;
42216428a1aSJason M. Bills     }
42316428a1aSJason M. Bills     return true;
42416428a1aSJason M. Bills }
42516428a1aSJason M. Bills 
42695820184SJason M. Bills static bool
42795820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path> &redfishLogFiles)
42895820184SJason M. Bills {
42995820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
43095820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
43195820184SJason M. Bills 
43295820184SJason M. Bills     // Loop through the directory looking for redfish log files
43395820184SJason M. Bills     for (const std::filesystem::directory_entry &dirEnt :
43495820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
43595820184SJason M. Bills     {
43695820184SJason M. Bills         // If we find a redfish log file, save the path
43795820184SJason M. Bills         std::string filename = dirEnt.path().filename();
43895820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
43995820184SJason M. Bills         {
44095820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
44195820184SJason M. Bills         }
44295820184SJason M. Bills     }
44395820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
44495820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
44595820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
44695820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
44795820184SJason M. Bills 
44895820184SJason M. Bills     return !redfishLogFiles.empty();
44995820184SJason M. Bills }
45095820184SJason M. Bills 
451043a0536SJohnathan Mantey static void ParseCrashdumpParameters(
452043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>> &params,
453043a0536SJohnathan Mantey     std::string &filename, std::string &timestamp, std::string &logfile)
454043a0536SJohnathan Mantey {
455043a0536SJohnathan Mantey     for (auto property : params)
456043a0536SJohnathan Mantey     {
457043a0536SJohnathan Mantey         if (property.first == "Timestamp")
458043a0536SJohnathan Mantey         {
459043a0536SJohnathan Mantey             const std::string *value =
4608d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
461043a0536SJohnathan Mantey             if (value != nullptr)
462043a0536SJohnathan Mantey             {
463043a0536SJohnathan Mantey                 timestamp = *value;
464043a0536SJohnathan Mantey             }
465043a0536SJohnathan Mantey         }
466043a0536SJohnathan Mantey         else if (property.first == "Filename")
467043a0536SJohnathan Mantey         {
468043a0536SJohnathan Mantey             const std::string *value =
4698d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
470043a0536SJohnathan Mantey             if (value != nullptr)
471043a0536SJohnathan Mantey             {
472043a0536SJohnathan Mantey                 filename = *value;
473043a0536SJohnathan Mantey             }
474043a0536SJohnathan Mantey         }
475043a0536SJohnathan Mantey         else if (property.first == "Log")
476043a0536SJohnathan Mantey         {
477043a0536SJohnathan Mantey             const std::string *value =
4788d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
479043a0536SJohnathan Mantey             if (value != nullptr)
480043a0536SJohnathan Mantey             {
481043a0536SJohnathan Mantey                 logfile = *value;
482043a0536SJohnathan Mantey             }
483043a0536SJohnathan Mantey         }
484043a0536SJohnathan Mantey     }
485043a0536SJohnathan Mantey }
486043a0536SJohnathan Mantey 
487a3316fc6SZhikuiRen constexpr char const *postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
488c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node
4891da66f75SEd Tanous {
4901da66f75SEd Tanous   public:
4911da66f75SEd Tanous     template <typename CrowApp>
492c4bf6374SJason M. Bills     SystemLogServiceCollection(CrowApp &app) :
493029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/")
494c4bf6374SJason M. Bills     {
495c4bf6374SJason M. Bills         entityPrivileges = {
496c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
497c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
498c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
499c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
500c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
501c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
502c4bf6374SJason M. Bills     }
503c4bf6374SJason M. Bills 
504c4bf6374SJason M. Bills   private:
505c4bf6374SJason M. Bills     /**
506c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
507c4bf6374SJason M. Bills      */
508c4bf6374SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
509c4bf6374SJason M. Bills                const std::vector<std::string> &params) override
510c4bf6374SJason M. Bills     {
511c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
512c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
513c4bf6374SJason M. Bills         // it has a duplicate entry for members
514c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
515c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
516c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
517029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
518c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
519c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
520c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
521c4bf6374SJason M. Bills         nlohmann::json &logServiceArray = asyncResp->res.jsonValue["Members"];
522c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
523029573d4SEd Tanous         logServiceArray.push_back(
524029573d4SEd Tanous             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}});
525c9bb6861Sraviteja-b #ifdef BMCWEB_ENABLE_REDFISH_SYSTEMDUMP_LOG
526c9bb6861Sraviteja-b         logServiceArray.push_back(
527c9bb6861Sraviteja-b             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/System"}});
528c9bb6861Sraviteja-b #endif
529c9bb6861Sraviteja-b 
530d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
531d53dd41fSJason M. Bills         logServiceArray.push_back(
532cb92c03bSAndrew Geissler             {{"@odata.id",
533424c4176SJason M. Bills               "/redfish/v1/Systems/system/LogServices/Crashdump"}});
534d53dd41fSJason M. Bills #endif
535c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
536c4bf6374SJason M. Bills             logServiceArray.size();
537a3316fc6SZhikuiRen 
538a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
539a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec,
540a3316fc6SZhikuiRen                         const std::vector<std::string> &subtreePath) {
541a3316fc6SZhikuiRen                 if (ec)
542a3316fc6SZhikuiRen                 {
543a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR << ec;
544a3316fc6SZhikuiRen                     return;
545a3316fc6SZhikuiRen                 }
546a3316fc6SZhikuiRen 
547a3316fc6SZhikuiRen                 for (auto &pathStr : subtreePath)
548a3316fc6SZhikuiRen                 {
549a3316fc6SZhikuiRen                     if (pathStr.find("PostCode") != std::string::npos)
550a3316fc6SZhikuiRen                     {
551a3316fc6SZhikuiRen                         nlohmann::json &logServiceArray =
552a3316fc6SZhikuiRen                             asyncResp->res.jsonValue["Members"];
553a3316fc6SZhikuiRen                         logServiceArray.push_back(
554a3316fc6SZhikuiRen                             {{"@odata.id", "/redfish/v1/Systems/system/"
555a3316fc6SZhikuiRen                                            "LogServices/PostCodes"}});
556a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members@odata.count"] =
557a3316fc6SZhikuiRen                             logServiceArray.size();
558a3316fc6SZhikuiRen                         return;
559a3316fc6SZhikuiRen                     }
560a3316fc6SZhikuiRen                 }
561a3316fc6SZhikuiRen             },
562a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper",
563a3316fc6SZhikuiRen             "/xyz/openbmc_project/object_mapper",
564a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
565a3316fc6SZhikuiRen             std::array<const char *, 1>{postCodeIface});
566c4bf6374SJason M. Bills     }
567c4bf6374SJason M. Bills };
568c4bf6374SJason M. Bills 
569c4bf6374SJason M. Bills class EventLogService : public Node
570c4bf6374SJason M. Bills {
571c4bf6374SJason M. Bills   public:
572c4bf6374SJason M. Bills     template <typename CrowApp>
573c4bf6374SJason M. Bills     EventLogService(CrowApp &app) :
574029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
575c4bf6374SJason M. Bills     {
576c4bf6374SJason M. Bills         entityPrivileges = {
577c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
578c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
579c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
580c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
581c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
582c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
583c4bf6374SJason M. Bills     }
584c4bf6374SJason M. Bills 
585c4bf6374SJason M. Bills   private:
586c4bf6374SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
587c4bf6374SJason M. Bills                const std::vector<std::string> &params) override
588c4bf6374SJason M. Bills     {
589c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
590c4bf6374SJason M. Bills 
591c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
592029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
593c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
594c4bf6374SJason M. Bills             "#LogService.v1_1_0.LogService";
595c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
596c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
597c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
598c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
599c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
600c4bf6374SJason M. Bills             {"@odata.id",
601029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
602e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
603e7d6c8b2SGunnar Mills 
604e7d6c8b2SGunnar Mills             {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
605e7d6c8b2SGunnar Mills                        "Actions/LogService.ClearLog"}};
606489640c6SJason M. Bills     }
607489640c6SJason M. Bills };
608489640c6SJason M. Bills 
6091f56a3a6STim Lee class JournalEventLogClear : public Node
610489640c6SJason M. Bills {
611489640c6SJason M. Bills   public:
6121f56a3a6STim Lee     JournalEventLogClear(CrowApp &app) :
613489640c6SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
614489640c6SJason M. Bills                   "LogService.ClearLog/")
615489640c6SJason M. Bills     {
616489640c6SJason M. Bills         entityPrivileges = {
617489640c6SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
618489640c6SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
619489640c6SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
620489640c6SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
621489640c6SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
622489640c6SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
623489640c6SJason M. Bills     }
624489640c6SJason M. Bills 
625489640c6SJason M. Bills   private:
626489640c6SJason M. Bills     void doPost(crow::Response &res, const crow::Request &req,
627489640c6SJason M. Bills                 const std::vector<std::string> &params) override
628489640c6SJason M. Bills     {
629489640c6SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
630489640c6SJason M. Bills 
631489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
632489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
633489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
634489640c6SJason M. Bills         {
635489640c6SJason M. Bills             for (const std::filesystem::path &file : redfishLogFiles)
636489640c6SJason M. Bills             {
637489640c6SJason M. Bills                 std::error_code ec;
638489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
639489640c6SJason M. Bills             }
640489640c6SJason M. Bills         }
641489640c6SJason M. Bills 
642489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
643489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
644489640c6SJason M. Bills             [asyncResp](const boost::system::error_code ec) {
645489640c6SJason M. Bills                 if (ec)
646489640c6SJason M. Bills                 {
647489640c6SJason M. Bills                     BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
648489640c6SJason M. Bills                     messages::internalError(asyncResp->res);
649489640c6SJason M. Bills                     return;
650489640c6SJason M. Bills                 }
651489640c6SJason M. Bills 
652489640c6SJason M. Bills                 messages::success(asyncResp->res);
653489640c6SJason M. Bills             },
654489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
655489640c6SJason M. Bills             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
656489640c6SJason M. Bills             "replace");
657c4bf6374SJason M. Bills     }
658c4bf6374SJason M. Bills };
659c4bf6374SJason M. Bills 
66095820184SJason M. Bills static int fillEventLogEntryJson(const std::string &logEntryID,
66195820184SJason M. Bills                                  const std::string logEntry,
66295820184SJason M. Bills                                  nlohmann::json &logEntryJson)
663c4bf6374SJason M. Bills {
66495820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
665cd225da8SJason M. Bills     // First get the Timestamp
666cd225da8SJason M. Bills     size_t space = logEntry.find_first_of(" ");
667cd225da8SJason M. Bills     if (space == std::string::npos)
66895820184SJason M. Bills     {
66995820184SJason M. Bills         return 1;
67095820184SJason M. Bills     }
671cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
672cd225da8SJason M. Bills     // Then get the log contents
673cd225da8SJason M. Bills     size_t entryStart = logEntry.find_first_not_of(" ", space);
674cd225da8SJason M. Bills     if (entryStart == std::string::npos)
675cd225da8SJason M. Bills     {
676cd225da8SJason M. Bills         return 1;
677cd225da8SJason M. Bills     }
678cd225da8SJason M. Bills     std::string_view entry(logEntry);
679cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
680cd225da8SJason M. Bills     // Use split to separate the entry into its fields
681cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
682cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
683cd225da8SJason M. Bills                  boost::token_compress_on);
684cd225da8SJason M. Bills     // We need at least a MessageId to be valid
685cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
686cd225da8SJason M. Bills     {
687cd225da8SJason M. Bills         return 1;
688cd225da8SJason M. Bills     }
689cd225da8SJason M. Bills     std::string &messageID = logEntryFields[0];
69095820184SJason M. Bills 
6914851d45dSJason M. Bills     // Get the Message from the MessageRegistry
6924851d45dSJason M. Bills     const message_registries::Message *message =
6934851d45dSJason M. Bills         message_registries::getMessage(messageID);
694c4bf6374SJason M. Bills 
6954851d45dSJason M. Bills     std::string msg;
6964851d45dSJason M. Bills     std::string severity;
6974851d45dSJason M. Bills     if (message != nullptr)
698c4bf6374SJason M. Bills     {
6994851d45dSJason M. Bills         msg = message->message;
7004851d45dSJason M. Bills         severity = message->severity;
701c4bf6374SJason M. Bills     }
702c4bf6374SJason M. Bills 
70315a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
70415a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
70515a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
70615a86ff6SJason M. Bills     {
70715a86ff6SJason M. Bills         std::string &messageArgsStart = logEntryFields[1];
70815a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
70915a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
71015a86ff6SJason M. Bills         if (!messageArgsStart.empty())
71115a86ff6SJason M. Bills         {
71215a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
71315a86ff6SJason M. Bills         }
71415a86ff6SJason M. Bills 
71515a86ff6SJason M. Bills         messageArgs = boost::beast::span(&messageArgsStart, messageArgsSize);
716c4bf6374SJason M. Bills 
7174851d45dSJason M. Bills         // Fill the MessageArgs into the Message
71895820184SJason M. Bills         int i = 0;
71995820184SJason M. Bills         for (const std::string &messageArg : messageArgs)
7204851d45dSJason M. Bills         {
72195820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
7224851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
7234851d45dSJason M. Bills             if (argPos != std::string::npos)
7244851d45dSJason M. Bills             {
72595820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
7264851d45dSJason M. Bills             }
7274851d45dSJason M. Bills         }
72815a86ff6SJason M. Bills     }
7294851d45dSJason M. Bills 
73095820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
73195820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
73295820184SJason M. Bills     // between the '.' and the '+', so just remove them.
73395820184SJason M. Bills     std::size_t dot = timestamp.find_first_of(".");
73495820184SJason M. Bills     std::size_t plus = timestamp.find_first_of("+");
73595820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
736c4bf6374SJason M. Bills     {
73795820184SJason M. Bills         timestamp.erase(dot, plus - dot);
738c4bf6374SJason M. Bills     }
739c4bf6374SJason M. Bills 
740c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
74195820184SJason M. Bills     logEntryJson = {
742cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
743029573d4SEd Tanous         {"@odata.id",
744897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
74595820184SJason M. Bills              logEntryID},
746c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
74795820184SJason M. Bills         {"Id", logEntryID},
74895820184SJason M. Bills         {"Message", std::move(msg)},
74995820184SJason M. Bills         {"MessageId", std::move(messageID)},
750c4bf6374SJason M. Bills         {"MessageArgs", std::move(messageArgs)},
751c4bf6374SJason M. Bills         {"EntryType", "Event"},
75295820184SJason M. Bills         {"Severity", std::move(severity)},
75395820184SJason M. Bills         {"Created", std::move(timestamp)}};
754c4bf6374SJason M. Bills     return 0;
755c4bf6374SJason M. Bills }
756c4bf6374SJason M. Bills 
75727062605SAnthony Wilson class JournalEventLogEntryCollection : public Node
758c4bf6374SJason M. Bills {
759c4bf6374SJason M. Bills   public:
760c4bf6374SJason M. Bills     template <typename CrowApp>
76127062605SAnthony Wilson     JournalEventLogEntryCollection(CrowApp &app) :
762029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
763c4bf6374SJason M. Bills     {
764c4bf6374SJason M. Bills         entityPrivileges = {
765c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
766c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
767c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
768c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
769c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
770c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
771c4bf6374SJason M. Bills     }
772c4bf6374SJason M. Bills 
773c4bf6374SJason M. Bills   private:
774c4bf6374SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
775c4bf6374SJason M. Bills                const std::vector<std::string> &params) override
776c4bf6374SJason M. Bills     {
777c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
778271584abSEd Tanous         uint64_t skip = 0;
779271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
780c4bf6374SJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
781c4bf6374SJason M. Bills         {
782c4bf6374SJason M. Bills             return;
783c4bf6374SJason M. Bills         }
784c4bf6374SJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
785c4bf6374SJason M. Bills         {
786c4bf6374SJason M. Bills             return;
787c4bf6374SJason M. Bills         }
788c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
789c4bf6374SJason M. Bills         // it has a duplicate entry for members
790c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
791c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
792c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
793029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
794c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
795c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
796c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
797cb92c03bSAndrew Geissler 
798c4bf6374SJason M. Bills         nlohmann::json &logEntryArray = asyncResp->res.jsonValue["Members"];
799c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
80095820184SJason M. Bills         // Go through the log files and create a unique ID for each entry
80195820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
80295820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
803b01bf299SEd Tanous         uint64_t entryCount = 0;
804cd225da8SJason M. Bills         std::string logEntry;
80595820184SJason M. Bills 
80695820184SJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
807cd225da8SJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
808cd225da8SJason M. Bills              it++)
809c4bf6374SJason M. Bills         {
810cd225da8SJason M. Bills             std::ifstream logStream(*it);
81195820184SJason M. Bills             if (!logStream.is_open())
812c4bf6374SJason M. Bills             {
813c4bf6374SJason M. Bills                 continue;
814c4bf6374SJason M. Bills             }
815c4bf6374SJason M. Bills 
816e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
817e85d6b16SJason M. Bills             bool firstEntry = true;
81895820184SJason M. Bills             while (std::getline(logStream, logEntry))
81995820184SJason M. Bills             {
820c4bf6374SJason M. Bills                 entryCount++;
821c4bf6374SJason M. Bills                 // Handle paging using skip (number of entries to skip from the
822c4bf6374SJason M. Bills                 // start) and top (number of entries to display)
823c4bf6374SJason M. Bills                 if (entryCount <= skip || entryCount > skip + top)
824c4bf6374SJason M. Bills                 {
825c4bf6374SJason M. Bills                     continue;
826c4bf6374SJason M. Bills                 }
827c4bf6374SJason M. Bills 
828c4bf6374SJason M. Bills                 std::string idStr;
829e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
830c4bf6374SJason M. Bills                 {
831c4bf6374SJason M. Bills                     continue;
832c4bf6374SJason M. Bills                 }
833c4bf6374SJason M. Bills 
834e85d6b16SJason M. Bills                 if (firstEntry)
835e85d6b16SJason M. Bills                 {
836e85d6b16SJason M. Bills                     firstEntry = false;
837e85d6b16SJason M. Bills                 }
838e85d6b16SJason M. Bills 
839c4bf6374SJason M. Bills                 logEntryArray.push_back({});
840c4bf6374SJason M. Bills                 nlohmann::json &bmcLogEntry = logEntryArray.back();
84195820184SJason M. Bills                 if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0)
842c4bf6374SJason M. Bills                 {
843c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
844c4bf6374SJason M. Bills                     return;
845c4bf6374SJason M. Bills                 }
846c4bf6374SJason M. Bills             }
84795820184SJason M. Bills         }
848c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
849c4bf6374SJason M. Bills         if (skip + top < entryCount)
850c4bf6374SJason M. Bills         {
851c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
85295820184SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/"
85395820184SJason M. Bills                 "Entries?$skip=" +
854c4bf6374SJason M. Bills                 std::to_string(skip + top);
855c4bf6374SJason M. Bills         }
85608a4e4b5SAnthony Wilson     }
85708a4e4b5SAnthony Wilson };
85808a4e4b5SAnthony Wilson 
859897967deSJason M. Bills class JournalEventLogEntry : public Node
860897967deSJason M. Bills {
861897967deSJason M. Bills   public:
862897967deSJason M. Bills     JournalEventLogEntry(CrowApp &app) :
863897967deSJason M. Bills         Node(app,
864897967deSJason M. Bills              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
865897967deSJason M. Bills              std::string())
866897967deSJason M. Bills     {
867897967deSJason M. Bills         entityPrivileges = {
868897967deSJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
869897967deSJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
870897967deSJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
871897967deSJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
872897967deSJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
873897967deSJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
874897967deSJason M. Bills     }
875897967deSJason M. Bills 
876897967deSJason M. Bills   private:
877897967deSJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
878897967deSJason M. Bills                const std::vector<std::string> &params) override
879897967deSJason M. Bills     {
880897967deSJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
881897967deSJason M. Bills         if (params.size() != 1)
882897967deSJason M. Bills         {
883897967deSJason M. Bills             messages::internalError(asyncResp->res);
884897967deSJason M. Bills             return;
885897967deSJason M. Bills         }
886897967deSJason M. Bills         const std::string &targetID = params[0];
887897967deSJason M. Bills 
888897967deSJason M. Bills         // Go through the log files and check the unique ID for each entry to
889897967deSJason M. Bills         // find the target entry
890897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
891897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
892897967deSJason M. Bills         std::string logEntry;
893897967deSJason M. Bills 
894897967deSJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
895897967deSJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
896897967deSJason M. Bills              it++)
897897967deSJason M. Bills         {
898897967deSJason M. Bills             std::ifstream logStream(*it);
899897967deSJason M. Bills             if (!logStream.is_open())
900897967deSJason M. Bills             {
901897967deSJason M. Bills                 continue;
902897967deSJason M. Bills             }
903897967deSJason M. Bills 
904897967deSJason M. Bills             // Reset the unique ID on the first entry
905897967deSJason M. Bills             bool firstEntry = true;
906897967deSJason M. Bills             while (std::getline(logStream, logEntry))
907897967deSJason M. Bills             {
908897967deSJason M. Bills                 std::string idStr;
909897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
910897967deSJason M. Bills                 {
911897967deSJason M. Bills                     continue;
912897967deSJason M. Bills                 }
913897967deSJason M. Bills 
914897967deSJason M. Bills                 if (firstEntry)
915897967deSJason M. Bills                 {
916897967deSJason M. Bills                     firstEntry = false;
917897967deSJason M. Bills                 }
918897967deSJason M. Bills 
919897967deSJason M. Bills                 if (idStr == targetID)
920897967deSJason M. Bills                 {
921897967deSJason M. Bills                     if (fillEventLogEntryJson(idStr, logEntry,
922897967deSJason M. Bills                                               asyncResp->res.jsonValue) != 0)
923897967deSJason M. Bills                     {
924897967deSJason M. Bills                         messages::internalError(asyncResp->res);
925897967deSJason M. Bills                         return;
926897967deSJason M. Bills                     }
927897967deSJason M. Bills                     return;
928897967deSJason M. Bills                 }
929897967deSJason M. Bills             }
930897967deSJason M. Bills         }
931897967deSJason M. Bills         // Requested ID was not found
932897967deSJason M. Bills         messages::resourceMissingAtURI(asyncResp->res, targetID);
933897967deSJason M. Bills     }
934897967deSJason M. Bills };
935897967deSJason M. Bills 
93608a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node
93708a4e4b5SAnthony Wilson {
93808a4e4b5SAnthony Wilson   public:
93908a4e4b5SAnthony Wilson     template <typename CrowApp>
94008a4e4b5SAnthony Wilson     DBusEventLogEntryCollection(CrowApp &app) :
94108a4e4b5SAnthony Wilson         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
94208a4e4b5SAnthony Wilson     {
94308a4e4b5SAnthony Wilson         entityPrivileges = {
94408a4e4b5SAnthony Wilson             {boost::beast::http::verb::get, {{"Login"}}},
94508a4e4b5SAnthony Wilson             {boost::beast::http::verb::head, {{"Login"}}},
94608a4e4b5SAnthony Wilson             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
94708a4e4b5SAnthony Wilson             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
94808a4e4b5SAnthony Wilson             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
94908a4e4b5SAnthony Wilson             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
95008a4e4b5SAnthony Wilson     }
95108a4e4b5SAnthony Wilson 
95208a4e4b5SAnthony Wilson   private:
95308a4e4b5SAnthony Wilson     void doGet(crow::Response &res, const crow::Request &req,
95408a4e4b5SAnthony Wilson                const std::vector<std::string> &params) override
95508a4e4b5SAnthony Wilson     {
95608a4e4b5SAnthony Wilson         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
95708a4e4b5SAnthony Wilson 
95808a4e4b5SAnthony Wilson         // Collections don't include the static data added by SubRoute because
95908a4e4b5SAnthony Wilson         // it has a duplicate entry for members
96008a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
96108a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
96208a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
96308a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
96408a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
96508a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
96608a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
96708a4e4b5SAnthony Wilson 
968cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
969cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
970cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
971cb92c03bSAndrew Geissler             [asyncResp](const boost::system::error_code ec,
972cb92c03bSAndrew Geissler                         GetManagedObjectsType &resp) {
973cb92c03bSAndrew Geissler                 if (ec)
974cb92c03bSAndrew Geissler                 {
975cb92c03bSAndrew Geissler                     // TODO Handle for specific error code
976cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
977cb92c03bSAndrew Geissler                         << "getLogEntriesIfaceData resp_handler got error "
978cb92c03bSAndrew Geissler                         << ec;
979cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
980cb92c03bSAndrew Geissler                     return;
981cb92c03bSAndrew Geissler                 }
982cb92c03bSAndrew Geissler                 nlohmann::json &entriesArray =
983cb92c03bSAndrew Geissler                     asyncResp->res.jsonValue["Members"];
984cb92c03bSAndrew Geissler                 entriesArray = nlohmann::json::array();
985cb92c03bSAndrew Geissler                 for (auto &objectPath : resp)
986cb92c03bSAndrew Geissler                 {
987cb92c03bSAndrew Geissler                     for (auto &interfaceMap : objectPath.second)
988cb92c03bSAndrew Geissler                     {
989cb92c03bSAndrew Geissler                         if (interfaceMap.first !=
990cb92c03bSAndrew Geissler                             "xyz.openbmc_project.Logging.Entry")
991cb92c03bSAndrew Geissler                         {
992cb92c03bSAndrew Geissler                             BMCWEB_LOG_DEBUG << "Bailing early on "
993cb92c03bSAndrew Geissler                                              << interfaceMap.first;
994cb92c03bSAndrew Geissler                             continue;
995cb92c03bSAndrew Geissler                         }
996cb92c03bSAndrew Geissler                         entriesArray.push_back({});
997cb92c03bSAndrew Geissler                         nlohmann::json &thisEntry = entriesArray.back();
99866664f25SEd Tanous                         uint32_t *id = nullptr;
99966664f25SEd Tanous                         std::time_t timestamp{};
100066664f25SEd Tanous                         std::string *severity = nullptr;
100166664f25SEd Tanous                         std::string *message = nullptr;
1002cb92c03bSAndrew Geissler                         for (auto &propertyMap : interfaceMap.second)
1003cb92c03bSAndrew Geissler                         {
1004cb92c03bSAndrew Geissler                             if (propertyMap.first == "Id")
1005cb92c03bSAndrew Geissler                             {
10068d78b7a9SPatrick Williams                                 id = std::get_if<uint32_t>(&propertyMap.second);
1007cb92c03bSAndrew Geissler                                 if (id == nullptr)
1008cb92c03bSAndrew Geissler                                 {
1009cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1010cb92c03bSAndrew Geissler                                                               "Id");
1011cb92c03bSAndrew Geissler                                 }
1012cb92c03bSAndrew Geissler                             }
1013cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Timestamp")
1014cb92c03bSAndrew Geissler                             {
1015cb92c03bSAndrew Geissler                                 const uint64_t *millisTimeStamp =
1016cb92c03bSAndrew Geissler                                     std::get_if<uint64_t>(&propertyMap.second);
1017cb92c03bSAndrew Geissler                                 if (millisTimeStamp == nullptr)
1018cb92c03bSAndrew Geissler                                 {
1019cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1020cb92c03bSAndrew Geissler                                                               "Timestamp");
1021271584abSEd Tanous                                     continue;
1022cb92c03bSAndrew Geissler                                 }
1023cb92c03bSAndrew Geissler                                 // Retrieve Created property with format:
1024cb92c03bSAndrew Geissler                                 // yyyy-mm-ddThh:mm:ss
1025cb92c03bSAndrew Geissler                                 std::chrono::milliseconds chronoTimeStamp(
1026cb92c03bSAndrew Geissler                                     *millisTimeStamp);
1027271584abSEd Tanous                                 timestamp = std::chrono::duration_cast<
1028271584abSEd Tanous                                                 std::chrono::duration<int>>(
1029271584abSEd Tanous                                                 chronoTimeStamp)
1030cb92c03bSAndrew Geissler                                                 .count();
1031cb92c03bSAndrew Geissler                             }
1032cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1033cb92c03bSAndrew Geissler                             {
1034cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1035cb92c03bSAndrew Geissler                                     &propertyMap.second);
1036cb92c03bSAndrew Geissler                                 if (severity == nullptr)
1037cb92c03bSAndrew Geissler                                 {
1038cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1039cb92c03bSAndrew Geissler                                                               "Severity");
1040cb92c03bSAndrew Geissler                                 }
1041cb92c03bSAndrew Geissler                             }
1042cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1043cb92c03bSAndrew Geissler                             {
1044cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1045cb92c03bSAndrew Geissler                                     &propertyMap.second);
1046cb92c03bSAndrew Geissler                                 if (message == nullptr)
1047cb92c03bSAndrew Geissler                                 {
1048cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1049cb92c03bSAndrew Geissler                                                               "Message");
1050cb92c03bSAndrew Geissler                                 }
1051cb92c03bSAndrew Geissler                             }
1052cb92c03bSAndrew Geissler                         }
1053cb92c03bSAndrew Geissler                         thisEntry = {
1054cb92c03bSAndrew Geissler                             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1055cb92c03bSAndrew Geissler                             {"@odata.id",
1056cb92c03bSAndrew Geissler                              "/redfish/v1/Systems/system/LogServices/EventLog/"
1057cb92c03bSAndrew Geissler                              "Entries/" +
1058cb92c03bSAndrew Geissler                                  std::to_string(*id)},
105927062605SAnthony Wilson                             {"Name", "System Event Log Entry"},
1060cb92c03bSAndrew Geissler                             {"Id", std::to_string(*id)},
1061cb92c03bSAndrew Geissler                             {"Message", *message},
1062cb92c03bSAndrew Geissler                             {"EntryType", "Event"},
1063cb92c03bSAndrew Geissler                             {"Severity",
1064cb92c03bSAndrew Geissler                              translateSeverityDbusToRedfish(*severity)},
1065cb92c03bSAndrew Geissler                             {"Created", crow::utility::getDateTime(timestamp)}};
1066cb92c03bSAndrew Geissler                     }
1067cb92c03bSAndrew Geissler                 }
1068cb92c03bSAndrew Geissler                 std::sort(entriesArray.begin(), entriesArray.end(),
1069cb92c03bSAndrew Geissler                           [](const nlohmann::json &left,
1070cb92c03bSAndrew Geissler                              const nlohmann::json &right) {
1071cb92c03bSAndrew Geissler                               return (left["Id"] <= right["Id"]);
1072cb92c03bSAndrew Geissler                           });
1073cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue["Members@odata.count"] =
1074cb92c03bSAndrew Geissler                     entriesArray.size();
1075cb92c03bSAndrew Geissler             },
1076cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
1077cb92c03bSAndrew Geissler             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1078c4bf6374SJason M. Bills     }
1079c4bf6374SJason M. Bills };
1080c4bf6374SJason M. Bills 
108108a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node
1082c4bf6374SJason M. Bills {
1083c4bf6374SJason M. Bills   public:
108408a4e4b5SAnthony Wilson     DBusEventLogEntry(CrowApp &app) :
1085c4bf6374SJason M. Bills         Node(app,
1086029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1087029573d4SEd Tanous              std::string())
1088c4bf6374SJason M. Bills     {
1089c4bf6374SJason M. Bills         entityPrivileges = {
1090c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1091c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1092c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1093c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1094c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1095c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1096c4bf6374SJason M. Bills     }
1097c4bf6374SJason M. Bills 
1098c4bf6374SJason M. Bills   private:
1099c4bf6374SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
1100c4bf6374SJason M. Bills                const std::vector<std::string> &params) override
1101c4bf6374SJason M. Bills     {
1102c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1103029573d4SEd Tanous         if (params.size() != 1)
1104c4bf6374SJason M. Bills         {
1105c4bf6374SJason M. Bills             messages::internalError(asyncResp->res);
1106c4bf6374SJason M. Bills             return;
1107c4bf6374SJason M. Bills         }
1108029573d4SEd Tanous         const std::string &entryID = params[0];
1109cb92c03bSAndrew Geissler 
1110cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1111cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1112cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1113cb92c03bSAndrew Geissler             [asyncResp, entryID](const boost::system::error_code ec,
1114cb92c03bSAndrew Geissler                                  GetManagedPropertyType &resp) {
1115cb92c03bSAndrew Geissler                 if (ec)
1116cb92c03bSAndrew Geissler                 {
1117cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1118cb92c03bSAndrew Geissler                         << "EventLogEntry (DBus) resp_handler got error " << ec;
1119cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1120cb92c03bSAndrew Geissler                     return;
1121cb92c03bSAndrew Geissler                 }
112266664f25SEd Tanous                 uint32_t *id = nullptr;
112366664f25SEd Tanous                 std::time_t timestamp{};
112466664f25SEd Tanous                 std::string *severity = nullptr;
112566664f25SEd Tanous                 std::string *message = nullptr;
1126cb92c03bSAndrew Geissler                 for (auto &propertyMap : resp)
1127cb92c03bSAndrew Geissler                 {
1128cb92c03bSAndrew Geissler                     if (propertyMap.first == "Id")
1129cb92c03bSAndrew Geissler                     {
1130cb92c03bSAndrew Geissler                         id = std::get_if<uint32_t>(&propertyMap.second);
1131cb92c03bSAndrew Geissler                         if (id == nullptr)
1132cb92c03bSAndrew Geissler                         {
1133cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res, "Id");
1134cb92c03bSAndrew Geissler                         }
1135cb92c03bSAndrew Geissler                     }
1136cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Timestamp")
1137cb92c03bSAndrew Geissler                     {
1138cb92c03bSAndrew Geissler                         const uint64_t *millisTimeStamp =
1139cb92c03bSAndrew Geissler                             std::get_if<uint64_t>(&propertyMap.second);
1140cb92c03bSAndrew Geissler                         if (millisTimeStamp == nullptr)
1141cb92c03bSAndrew Geissler                         {
1142cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1143cb92c03bSAndrew Geissler                                                       "Timestamp");
1144271584abSEd Tanous                             continue;
1145cb92c03bSAndrew Geissler                         }
1146cb92c03bSAndrew Geissler                         // Retrieve Created property with format:
1147cb92c03bSAndrew Geissler                         // yyyy-mm-ddThh:mm:ss
1148cb92c03bSAndrew Geissler                         std::chrono::milliseconds chronoTimeStamp(
1149cb92c03bSAndrew Geissler                             *millisTimeStamp);
1150cb92c03bSAndrew Geissler                         timestamp =
1151271584abSEd Tanous                             std::chrono::duration_cast<
1152271584abSEd Tanous                                 std::chrono::duration<int>>(chronoTimeStamp)
1153cb92c03bSAndrew Geissler                                 .count();
1154cb92c03bSAndrew Geissler                     }
1155cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Severity")
1156cb92c03bSAndrew Geissler                     {
1157cb92c03bSAndrew Geissler                         severity =
1158cb92c03bSAndrew Geissler                             std::get_if<std::string>(&propertyMap.second);
1159cb92c03bSAndrew Geissler                         if (severity == nullptr)
1160cb92c03bSAndrew Geissler                         {
1161cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1162cb92c03bSAndrew Geissler                                                       "Severity");
1163cb92c03bSAndrew Geissler                         }
1164cb92c03bSAndrew Geissler                     }
1165cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Message")
1166cb92c03bSAndrew Geissler                     {
1167cb92c03bSAndrew Geissler                         message = std::get_if<std::string>(&propertyMap.second);
1168cb92c03bSAndrew Geissler                         if (message == nullptr)
1169cb92c03bSAndrew Geissler                         {
1170cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1171cb92c03bSAndrew Geissler                                                       "Message");
1172cb92c03bSAndrew Geissler                         }
1173cb92c03bSAndrew Geissler                     }
1174cb92c03bSAndrew Geissler                 }
1175271584abSEd Tanous                 if (id == nullptr || message == nullptr || severity == nullptr)
1176271584abSEd Tanous                 {
1177271584abSEd Tanous                     return;
1178271584abSEd Tanous                 }
1179cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue = {
1180cb92c03bSAndrew Geissler                     {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1181cb92c03bSAndrew Geissler                     {"@odata.id",
1182cb92c03bSAndrew Geissler                      "/redfish/v1/Systems/system/LogServices/EventLog/"
1183cb92c03bSAndrew Geissler                      "Entries/" +
1184cb92c03bSAndrew Geissler                          std::to_string(*id)},
118527062605SAnthony Wilson                     {"Name", "System Event Log Entry"},
1186cb92c03bSAndrew Geissler                     {"Id", std::to_string(*id)},
1187cb92c03bSAndrew Geissler                     {"Message", *message},
1188cb92c03bSAndrew Geissler                     {"EntryType", "Event"},
1189cb92c03bSAndrew Geissler                     {"Severity", translateSeverityDbusToRedfish(*severity)},
119008a4e4b5SAnthony Wilson                     {"Created", crow::utility::getDateTime(timestamp)}};
1191cb92c03bSAndrew Geissler             },
1192cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging",
1193cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging/entry/" + entryID,
1194cb92c03bSAndrew Geissler             "org.freedesktop.DBus.Properties", "GetAll",
1195cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging.Entry");
1196c4bf6374SJason M. Bills     }
1197336e96c6SChicago Duan 
1198336e96c6SChicago Duan     void doDelete(crow::Response &res, const crow::Request &req,
1199336e96c6SChicago Duan                   const std::vector<std::string> &params) override
1200336e96c6SChicago Duan     {
1201336e96c6SChicago Duan 
1202336e96c6SChicago Duan         BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1203336e96c6SChicago Duan 
1204336e96c6SChicago Duan         auto asyncResp = std::make_shared<AsyncResp>(res);
1205336e96c6SChicago Duan 
1206336e96c6SChicago Duan         if (params.size() != 1)
1207336e96c6SChicago Duan         {
1208336e96c6SChicago Duan             messages::internalError(asyncResp->res);
1209336e96c6SChicago Duan             return;
1210336e96c6SChicago Duan         }
1211336e96c6SChicago Duan         std::string entryID = params[0];
1212336e96c6SChicago Duan 
1213336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
1214336e96c6SChicago Duan 
1215336e96c6SChicago Duan         // Process response from Logging service.
1216336e96c6SChicago Duan         auto respHandler = [asyncResp](const boost::system::error_code ec) {
1217336e96c6SChicago Duan             BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1218336e96c6SChicago Duan             if (ec)
1219336e96c6SChicago Duan             {
1220336e96c6SChicago Duan                 // TODO Handle for specific error code
1221336e96c6SChicago Duan                 BMCWEB_LOG_ERROR
1222336e96c6SChicago Duan                     << "EventLogEntry (DBus) doDelete respHandler got error "
1223336e96c6SChicago Duan                     << ec;
1224336e96c6SChicago Duan                 asyncResp->res.result(
1225336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
1226336e96c6SChicago Duan                 return;
1227336e96c6SChicago Duan             }
1228336e96c6SChicago Duan 
1229336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
1230336e96c6SChicago Duan         };
1231336e96c6SChicago Duan 
1232336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
1233336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
1234336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
1235336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
1236336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
1237336e96c6SChicago Duan     }
1238c4bf6374SJason M. Bills };
1239c4bf6374SJason M. Bills 
1240c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node
1241c4bf6374SJason M. Bills {
1242c4bf6374SJason M. Bills   public:
1243c4bf6374SJason M. Bills     template <typename CrowApp>
1244c4bf6374SJason M. Bills     BMCLogServiceCollection(CrowApp &app) :
12454ed77cd5SEd Tanous         Node(app, "/redfish/v1/Managers/bmc/LogServices/")
12461da66f75SEd Tanous     {
12471da66f75SEd Tanous         entityPrivileges = {
1248e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1249e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1250e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1251e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1252e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1253e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
12541da66f75SEd Tanous     }
12551da66f75SEd Tanous 
12561da66f75SEd Tanous   private:
12571da66f75SEd Tanous     /**
12581da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
12591da66f75SEd Tanous      */
12601da66f75SEd Tanous     void doGet(crow::Response &res, const crow::Request &req,
12611da66f75SEd Tanous                const std::vector<std::string> &params) override
12621da66f75SEd Tanous     {
1263e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
12641da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
12651da66f75SEd Tanous         // it has a duplicate entry for members
1266e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
12671da66f75SEd Tanous             "#LogServiceCollection.LogServiceCollection";
1268e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1269e1f26343SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices";
1270e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1271e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
12721da66f75SEd Tanous             "Collection of LogServices for this Manager";
1273c4bf6374SJason M. Bills         nlohmann::json &logServiceArray = asyncResp->res.jsonValue["Members"];
1274c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
1275c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1276c4bf6374SJason M. Bills         logServiceArray.push_back(
127708a4e4b5SAnthony Wilson             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1278c4bf6374SJason M. Bills #endif
1279e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
1280c4bf6374SJason M. Bills             logServiceArray.size();
12811da66f75SEd Tanous     }
12821da66f75SEd Tanous };
12831da66f75SEd Tanous 
1284c4bf6374SJason M. Bills class BMCJournalLogService : public Node
12851da66f75SEd Tanous {
12861da66f75SEd Tanous   public:
12871da66f75SEd Tanous     template <typename CrowApp>
1288c4bf6374SJason M. Bills     BMCJournalLogService(CrowApp &app) :
1289c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1290e1f26343SJason M. Bills     {
1291e1f26343SJason M. Bills         entityPrivileges = {
1292e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1293e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1294e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1295e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1296e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1297e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1298e1f26343SJason M. Bills     }
1299e1f26343SJason M. Bills 
1300e1f26343SJason M. Bills   private:
1301e1f26343SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
1302e1f26343SJason M. Bills                const std::vector<std::string> &params) override
1303e1f26343SJason M. Bills     {
1304e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1305e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1306e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
13070f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
13080f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
1309c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
1310c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
1311c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "BMC Journal";
1312e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1313cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1314cd50aa42SJason M. Bills             {"@odata.id",
1315086be238SEd Tanous              "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
1316e1f26343SJason M. Bills     }
1317e1f26343SJason M. Bills };
1318e1f26343SJason M. Bills 
1319c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string &bmcJournalLogEntryID,
1320e1f26343SJason M. Bills                                       sd_journal *journal,
1321c4bf6374SJason M. Bills                                       nlohmann::json &bmcJournalLogEntryJson)
1322e1f26343SJason M. Bills {
1323e1f26343SJason M. Bills     // Get the Log Entry contents
1324e1f26343SJason M. Bills     int ret = 0;
1325e1f26343SJason M. Bills 
132639e77504SEd Tanous     std::string_view msg;
132716428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1328e1f26343SJason M. Bills     if (ret < 0)
1329e1f26343SJason M. Bills     {
1330e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1331e1f26343SJason M. Bills         return 1;
1332e1f26343SJason M. Bills     }
1333e1f26343SJason M. Bills 
1334e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1335271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
133616428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1337e1f26343SJason M. Bills     if (ret < 0)
1338e1f26343SJason M. Bills     {
1339e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
1340e1f26343SJason M. Bills     }
1341e1f26343SJason M. Bills 
1342e1f26343SJason M. Bills     // Get the Created time from the timestamp
134316428a1aSJason M. Bills     std::string entryTimeStr;
134416428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
1345e1f26343SJason M. Bills     {
134616428a1aSJason M. Bills         return 1;
1347e1f26343SJason M. Bills     }
1348e1f26343SJason M. Bills 
1349e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
1350c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
1351cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1352c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1353c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
1354e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
1355c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
135616428a1aSJason M. Bills         {"Message", msg},
1357e1f26343SJason M. Bills         {"EntryType", "Oem"},
1358e1f26343SJason M. Bills         {"Severity",
1359b6a61a5eSJason M. Bills          severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"},
1360086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
1361e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
1362e1f26343SJason M. Bills     return 0;
1363e1f26343SJason M. Bills }
1364e1f26343SJason M. Bills 
1365c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node
1366e1f26343SJason M. Bills {
1367e1f26343SJason M. Bills   public:
1368e1f26343SJason M. Bills     template <typename CrowApp>
1369c4bf6374SJason M. Bills     BMCJournalLogEntryCollection(CrowApp &app) :
1370c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
1371e1f26343SJason M. Bills     {
1372e1f26343SJason M. Bills         entityPrivileges = {
1373e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1374e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1375e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1376e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1377e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1378e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1379e1f26343SJason M. Bills     }
1380e1f26343SJason M. Bills 
1381e1f26343SJason M. Bills   private:
1382e1f26343SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
1383e1f26343SJason M. Bills                const std::vector<std::string> &params) override
1384e1f26343SJason M. Bills     {
1385e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1386193ad2faSJason M. Bills         static constexpr const long maxEntriesPerPage = 1000;
1387271584abSEd Tanous         uint64_t skip = 0;
1388271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
138916428a1aSJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1390193ad2faSJason M. Bills         {
1391193ad2faSJason M. Bills             return;
1392193ad2faSJason M. Bills         }
139316428a1aSJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1394193ad2faSJason M. Bills         {
1395193ad2faSJason M. Bills             return;
1396193ad2faSJason M. Bills         }
1397e1f26343SJason M. Bills         // Collections don't include the static data added by SubRoute because
1398e1f26343SJason M. Bills         // it has a duplicate entry for members
1399e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1400e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
14010f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
14020f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1403e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1404c4bf6374SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1405e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1406e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1407e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
14080f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
14090f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries";
1410e1f26343SJason M. Bills         nlohmann::json &logEntryArray = asyncResp->res.jsonValue["Members"];
1411e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
1412e1f26343SJason M. Bills 
1413e1f26343SJason M. Bills         // Go through the journal and use the timestamp to create a unique ID
1414e1f26343SJason M. Bills         // for each entry
1415e1f26343SJason M. Bills         sd_journal *journalTmp = nullptr;
1416e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1417e1f26343SJason M. Bills         if (ret < 0)
1418e1f26343SJason M. Bills         {
1419e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1420f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1421e1f26343SJason M. Bills             return;
1422e1f26343SJason M. Bills         }
1423e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1424e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1425e1f26343SJason M. Bills         journalTmp = nullptr;
1426b01bf299SEd Tanous         uint64_t entryCount = 0;
1427e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
1428e85d6b16SJason M. Bills         bool firstEntry = true;
1429e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
1430e1f26343SJason M. Bills         {
1431193ad2faSJason M. Bills             entryCount++;
1432193ad2faSJason M. Bills             // Handle paging using skip (number of entries to skip from the
1433193ad2faSJason M. Bills             // start) and top (number of entries to display)
1434193ad2faSJason M. Bills             if (entryCount <= skip || entryCount > skip + top)
1435193ad2faSJason M. Bills             {
1436193ad2faSJason M. Bills                 continue;
1437193ad2faSJason M. Bills             }
1438193ad2faSJason M. Bills 
143916428a1aSJason M. Bills             std::string idStr;
1440e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1441e1f26343SJason M. Bills             {
1442e1f26343SJason M. Bills                 continue;
1443e1f26343SJason M. Bills             }
1444e1f26343SJason M. Bills 
1445e85d6b16SJason M. Bills             if (firstEntry)
1446e85d6b16SJason M. Bills             {
1447e85d6b16SJason M. Bills                 firstEntry = false;
1448e85d6b16SJason M. Bills             }
1449e85d6b16SJason M. Bills 
1450e1f26343SJason M. Bills             logEntryArray.push_back({});
1451c4bf6374SJason M. Bills             nlohmann::json &bmcJournalLogEntry = logEntryArray.back();
1452c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
1453c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
1454e1f26343SJason M. Bills             {
1455f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
1456e1f26343SJason M. Bills                 return;
1457e1f26343SJason M. Bills             }
1458e1f26343SJason M. Bills         }
1459193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1460193ad2faSJason M. Bills         if (skip + top < entryCount)
1461193ad2faSJason M. Bills         {
1462193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
1463c4bf6374SJason M. Bills                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
1464193ad2faSJason M. Bills                 std::to_string(skip + top);
1465193ad2faSJason M. Bills         }
1466e1f26343SJason M. Bills     }
1467e1f26343SJason M. Bills };
1468e1f26343SJason M. Bills 
1469c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node
1470e1f26343SJason M. Bills {
1471e1f26343SJason M. Bills   public:
1472c4bf6374SJason M. Bills     BMCJournalLogEntry(CrowApp &app) :
1473c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/",
1474e1f26343SJason M. Bills              std::string())
1475e1f26343SJason M. Bills     {
1476e1f26343SJason M. Bills         entityPrivileges = {
1477e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1478e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1479e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1480e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1481e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1482e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1483e1f26343SJason M. Bills     }
1484e1f26343SJason M. Bills 
1485e1f26343SJason M. Bills   private:
1486e1f26343SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
1487e1f26343SJason M. Bills                const std::vector<std::string> &params) override
1488e1f26343SJason M. Bills     {
1489e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1490e1f26343SJason M. Bills         if (params.size() != 1)
1491e1f26343SJason M. Bills         {
1492f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1493e1f26343SJason M. Bills             return;
1494e1f26343SJason M. Bills         }
149516428a1aSJason M. Bills         const std::string &entryID = params[0];
1496e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
1497e1f26343SJason M. Bills         uint64_t ts = 0;
1498271584abSEd Tanous         uint64_t index = 0;
149916428a1aSJason M. Bills         if (!getTimestampFromID(asyncResp->res, entryID, ts, index))
1500e1f26343SJason M. Bills         {
150116428a1aSJason M. Bills             return;
1502e1f26343SJason M. Bills         }
1503e1f26343SJason M. Bills 
1504e1f26343SJason M. Bills         sd_journal *journalTmp = nullptr;
1505e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1506e1f26343SJason M. Bills         if (ret < 0)
1507e1f26343SJason M. Bills         {
1508e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1509f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1510e1f26343SJason M. Bills             return;
1511e1f26343SJason M. Bills         }
1512e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1513e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1514e1f26343SJason M. Bills         journalTmp = nullptr;
1515e1f26343SJason M. Bills         // Go to the timestamp in the log and move to the entry at the index
1516af07e3f5SJason M. Bills         // tracking the unique ID
1517af07e3f5SJason M. Bills         std::string idStr;
1518af07e3f5SJason M. Bills         bool firstEntry = true;
1519e1f26343SJason M. Bills         ret = sd_journal_seek_realtime_usec(journal.get(), ts);
1520271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
1521e1f26343SJason M. Bills         {
1522e1f26343SJason M. Bills             sd_journal_next(journal.get());
1523af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1524af07e3f5SJason M. Bills             {
1525af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
1526af07e3f5SJason M. Bills                 return;
1527af07e3f5SJason M. Bills             }
1528af07e3f5SJason M. Bills             if (firstEntry)
1529af07e3f5SJason M. Bills             {
1530af07e3f5SJason M. Bills                 firstEntry = false;
1531af07e3f5SJason M. Bills             }
1532e1f26343SJason M. Bills         }
1533c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
1534af07e3f5SJason M. Bills         if (idStr != entryID)
1535c4bf6374SJason M. Bills         {
1536c4bf6374SJason M. Bills             messages::resourceMissingAtURI(asyncResp->res, entryID);
1537c4bf6374SJason M. Bills             return;
1538c4bf6374SJason M. Bills         }
1539c4bf6374SJason M. Bills 
1540c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
1541e1f26343SJason M. Bills                                        asyncResp->res.jsonValue) != 0)
1542e1f26343SJason M. Bills         {
1543f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1544e1f26343SJason M. Bills             return;
1545e1f26343SJason M. Bills         }
1546e1f26343SJason M. Bills     }
1547e1f26343SJason M. Bills };
1548e1f26343SJason M. Bills 
1549c9bb6861Sraviteja-b class SystemDumpService : public Node
1550c9bb6861Sraviteja-b {
1551c9bb6861Sraviteja-b   public:
1552c9bb6861Sraviteja-b     template <typename CrowApp>
1553c9bb6861Sraviteja-b     SystemDumpService(CrowApp &app) :
1554c9bb6861Sraviteja-b         Node(app, "/redfish/v1/Systems/system/LogServices/System/")
1555c9bb6861Sraviteja-b     {
1556c9bb6861Sraviteja-b         entityPrivileges = {
1557c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1558c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1559c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1560c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1561c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1562c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1563c9bb6861Sraviteja-b     }
1564c9bb6861Sraviteja-b 
1565c9bb6861Sraviteja-b   private:
1566c9bb6861Sraviteja-b     void doGet(crow::Response &res, const crow::Request &req,
1567c9bb6861Sraviteja-b                const std::vector<std::string> &params) override
1568c9bb6861Sraviteja-b     {
1569c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1570c9bb6861Sraviteja-b 
1571c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
1572c9bb6861Sraviteja-b             "/redfish/v1/Systems/system/LogServices/System";
1573c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
1574c9bb6861Sraviteja-b             "#LogService.v1_1_0.LogService";
1575c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "Dump Log Service";
1576c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] = "System Dump Log Service";
1577c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Id"] = "System";
1578c9bb6861Sraviteja-b         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1579c9bb6861Sraviteja-b         asyncResp->res.jsonValue["LogEntryTypes"] = "Dump";
1580c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Oem"]["DumpType"] = "System";
1581c9bb6861Sraviteja-b 
1582c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Entries"] = {
1583c9bb6861Sraviteja-b             {"@odata.id",
1584c9bb6861Sraviteja-b              "/redfish/v1/Systems/system/LogServices/System/Entries"}};
1585c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1586c9bb6861Sraviteja-b             {"target", "/redfish/v1/Systems/system/LogServices/System/"
1587c9bb6861Sraviteja-b                        "Actions/LogService.ClearLog"}};
1588c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Actions"]["#LogService.CreateLog"] = {
1589c9bb6861Sraviteja-b             {"target", "/redfish/v1/Systems/system/LogServices/System/"
1590c9bb6861Sraviteja-b                        "Actions/LogService.CreateLog"}};
1591c9bb6861Sraviteja-b     }
1592c9bb6861Sraviteja-b };
1593c9bb6861Sraviteja-b 
1594c9bb6861Sraviteja-b class SystemDumpEntryCollection : public Node
1595c9bb6861Sraviteja-b {
1596c9bb6861Sraviteja-b   public:
1597c9bb6861Sraviteja-b     template <typename CrowApp>
1598c9bb6861Sraviteja-b     SystemDumpEntryCollection(CrowApp &app) :
1599c9bb6861Sraviteja-b         Node(app, "/redfish/v1/Systems/system/LogServices/System/Entries/")
1600c9bb6861Sraviteja-b     {
1601c9bb6861Sraviteja-b         entityPrivileges = {
1602c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1603c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1604c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1605c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1606c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1607c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1608c9bb6861Sraviteja-b     }
1609c9bb6861Sraviteja-b 
1610c9bb6861Sraviteja-b   private:
1611c9bb6861Sraviteja-b     /**
1612c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
1613c9bb6861Sraviteja-b      */
1614c9bb6861Sraviteja-b     void doGet(crow::Response &res, const crow::Request &req,
1615c9bb6861Sraviteja-b                const std::vector<std::string> &params) override
1616c9bb6861Sraviteja-b     {
1617c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1618c9bb6861Sraviteja-b 
1619c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
1620c9bb6861Sraviteja-b             "#LogEntryCollection.LogEntryCollection";
1621c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
1622c9bb6861Sraviteja-b             "/redfish/v1/Systems/system/LogServices/System/Entries";
1623c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "System Dump Entries";
1624c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] =
1625c9bb6861Sraviteja-b             "Collection of System Dump Entries";
1626c9bb6861Sraviteja-b 
1627c9bb6861Sraviteja-b         crow::connections::systemBus->async_method_call(
1628c9bb6861Sraviteja-b             [asyncResp](const boost::system::error_code ec,
1629c9bb6861Sraviteja-b                         const crow::openbmc_mapper::GetSubTreeType &resp) {
1630c9bb6861Sraviteja-b                 if (ec)
1631c9bb6861Sraviteja-b                 {
1632c9bb6861Sraviteja-b                     BMCWEB_LOG_ERROR << " resp_handler got error " << ec;
1633c9bb6861Sraviteja-b                     messages::internalError(asyncResp->res);
1634c9bb6861Sraviteja-b                     return;
1635c9bb6861Sraviteja-b                 }
1636c9bb6861Sraviteja-b 
1637c9bb6861Sraviteja-b                 nlohmann::json &logArray = asyncResp->res.jsonValue["Members"];
1638c9bb6861Sraviteja-b                 logArray = nlohmann::json::array();
1639c9bb6861Sraviteja-b                 for (auto &object : resp)
1640c9bb6861Sraviteja-b                 {
1641c9bb6861Sraviteja-b                     const std::string &path =
1642c9bb6861Sraviteja-b                         static_cast<const std::string &>(object.first);
1643c9bb6861Sraviteja-b                     std::size_t lastPos = path.rfind("/");
1644c9bb6861Sraviteja-b                     if (lastPos == std::string::npos)
1645c9bb6861Sraviteja-b                     {
1646c9bb6861Sraviteja-b                         continue;
1647c9bb6861Sraviteja-b                     }
1648c9bb6861Sraviteja-b                     std::string logID = path.substr(lastPos + 1);
1649c9bb6861Sraviteja-b                     logArray.push_back(
1650c9bb6861Sraviteja-b                         {{"@odata.id", "/redfish/v1/Systems/system/LogServices/"
1651c9bb6861Sraviteja-b                                        "System/Entries/" +
1652c9bb6861Sraviteja-b                                            logID}});
1653c9bb6861Sraviteja-b                 }
1654c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Members@odata.count"] =
1655c9bb6861Sraviteja-b                     logArray.size();
1656c9bb6861Sraviteja-b             },
1657c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper",
1658c9bb6861Sraviteja-b             "/xyz/openbmc_project/object_mapper",
1659c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper", "GetSubTree",
1660c9bb6861Sraviteja-b             "/xyz/openbmc_project/dump", 0,
1661c9bb6861Sraviteja-b             std::array<const char *, 1>{
1662c9bb6861Sraviteja-b                 "xyz.openbmc_project.Dump.Entry.System"});
1663c9bb6861Sraviteja-b     }
1664c9bb6861Sraviteja-b };
1665c9bb6861Sraviteja-b 
1666c9bb6861Sraviteja-b class SystemDumpEntry : public Node
1667c9bb6861Sraviteja-b {
1668c9bb6861Sraviteja-b   public:
1669c9bb6861Sraviteja-b     SystemDumpEntry(CrowApp &app) :
1670c9bb6861Sraviteja-b         Node(app,
1671c9bb6861Sraviteja-b              "/redfish/v1/Systems/system/LogServices/System/Entries/<str>/",
1672c9bb6861Sraviteja-b              std::string())
1673c9bb6861Sraviteja-b     {
1674c9bb6861Sraviteja-b         entityPrivileges = {
1675c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1676c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1677c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1678c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1679c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1680c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1681c9bb6861Sraviteja-b     }
1682c9bb6861Sraviteja-b 
1683c9bb6861Sraviteja-b   private:
1684c9bb6861Sraviteja-b     void doGet(crow::Response &res, const crow::Request &req,
1685c9bb6861Sraviteja-b                const std::vector<std::string> &params) override
1686c9bb6861Sraviteja-b     {
1687c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1688c9bb6861Sraviteja-b         if (params.size() != 1)
1689c9bb6861Sraviteja-b         {
1690c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
1691c9bb6861Sraviteja-b             return;
1692c9bb6861Sraviteja-b         }
1693c9bb6861Sraviteja-b         const std::string &entryID = params[0];
1694c9bb6861Sraviteja-b         crow::connections::systemBus->async_method_call(
1695c9bb6861Sraviteja-b             [asyncResp, entryID](const boost::system::error_code ec,
1696c9bb6861Sraviteja-b                                  GetManagedObjectsType &resp) {
1697c9bb6861Sraviteja-b                 if (ec)
1698c9bb6861Sraviteja-b                 {
1699c9bb6861Sraviteja-b                     BMCWEB_LOG_ERROR
1700c9bb6861Sraviteja-b                         << "SystemDumpEntry resp_handler got error " << ec;
1701c9bb6861Sraviteja-b                     messages::internalError(asyncResp->res);
1702c9bb6861Sraviteja-b                     return;
1703c9bb6861Sraviteja-b                 }
1704c9bb6861Sraviteja-b 
1705c9bb6861Sraviteja-b                 for (auto &objectPath : resp)
1706c9bb6861Sraviteja-b                 {
1707c9bb6861Sraviteja-b                     if (objectPath.first.str.find(
1708c9bb6861Sraviteja-b                             "/xyz/openbmc_project/dump/entry/" + entryID) ==
1709c9bb6861Sraviteja-b                         std::string::npos)
1710c9bb6861Sraviteja-b                     {
1711c9bb6861Sraviteja-b                         continue;
1712c9bb6861Sraviteja-b                     }
1713c9bb6861Sraviteja-b 
1714c9bb6861Sraviteja-b                     bool foundSystemDumpEntry = false;
1715c9bb6861Sraviteja-b                     for (auto &interfaceMap : objectPath.second)
1716c9bb6861Sraviteja-b                     {
1717c9bb6861Sraviteja-b                         if (interfaceMap.first ==
1718c9bb6861Sraviteja-b                             "xyz.openbmc_project.Dump.Entry.System")
1719c9bb6861Sraviteja-b                         {
1720c9bb6861Sraviteja-b                             foundSystemDumpEntry = true;
1721c9bb6861Sraviteja-b                             break;
1722c9bb6861Sraviteja-b                         }
1723c9bb6861Sraviteja-b                     }
1724c9bb6861Sraviteja-b                     if (foundSystemDumpEntry == false)
1725c9bb6861Sraviteja-b                     {
1726c9bb6861Sraviteja-b                         BMCWEB_LOG_DEBUG << "Can't find System Dump Entry";
1727c9bb6861Sraviteja-b                         messages::internalError(asyncResp->res);
1728c9bb6861Sraviteja-b                         return;
1729c9bb6861Sraviteja-b                     }
1730c9bb6861Sraviteja-b 
1731c9bb6861Sraviteja-b                     std::string timestamp{};
1732c9bb6861Sraviteja-b                     uint64_t size = 0;
1733c9bb6861Sraviteja-b 
1734c9bb6861Sraviteja-b                     for (auto &interfaceMap : objectPath.second)
1735c9bb6861Sraviteja-b                     {
1736c9bb6861Sraviteja-b                         if (interfaceMap.first ==
1737c9bb6861Sraviteja-b                             "xyz.openbmc_project.Dump.Entry")
1738c9bb6861Sraviteja-b                         {
1739c9bb6861Sraviteja-b                             for (auto &propertyMap : interfaceMap.second)
1740c9bb6861Sraviteja-b                             {
1741c9bb6861Sraviteja-b                                 if (propertyMap.first == "Size")
1742c9bb6861Sraviteja-b                                 {
1743c9bb6861Sraviteja-b                                     auto sizePtr = std::get_if<uint64_t>(
1744c9bb6861Sraviteja-b                                         &propertyMap.second);
1745c9bb6861Sraviteja-b                                     if (sizePtr == nullptr)
1746c9bb6861Sraviteja-b                                     {
1747c9bb6861Sraviteja-b                                         messages::propertyMissing(
1748c9bb6861Sraviteja-b                                             asyncResp->res, "Size");
1749c9bb6861Sraviteja-b                                         break;
1750c9bb6861Sraviteja-b                                     }
1751c9bb6861Sraviteja-b                                     size = *sizePtr;
1752c9bb6861Sraviteja-b                                     break;
1753c9bb6861Sraviteja-b                                 }
1754c9bb6861Sraviteja-b                             }
1755c9bb6861Sraviteja-b                         }
1756c9bb6861Sraviteja-b                         else if (interfaceMap.first ==
1757c9bb6861Sraviteja-b                                  "xyz.openbmc_project.Time.EpochTime")
1758c9bb6861Sraviteja-b                         {
1759c9bb6861Sraviteja-b                             for (auto &propertyMap : interfaceMap.second)
1760c9bb6861Sraviteja-b                             {
1761c9bb6861Sraviteja-b                                 if (propertyMap.first == "Elapsed")
1762c9bb6861Sraviteja-b                                 {
1763c9bb6861Sraviteja-b                                     const uint64_t *usecsTimeStamp =
1764c9bb6861Sraviteja-b                                         std::get_if<uint64_t>(
1765c9bb6861Sraviteja-b                                             &propertyMap.second);
1766c9bb6861Sraviteja-b                                     if (usecsTimeStamp == nullptr)
1767c9bb6861Sraviteja-b                                     {
1768c9bb6861Sraviteja-b                                         messages::propertyMissing(
1769c9bb6861Sraviteja-b                                             asyncResp->res, "Elapsed");
1770c9bb6861Sraviteja-b                                         break;
1771c9bb6861Sraviteja-b                                     }
1772c9bb6861Sraviteja-b                                     getTimestampStr(*usecsTimeStamp, timestamp);
1773c9bb6861Sraviteja-b                                     break;
1774c9bb6861Sraviteja-b                                 }
1775c9bb6861Sraviteja-b                             }
1776c9bb6861Sraviteja-b                         }
1777c9bb6861Sraviteja-b                     }
1778c9bb6861Sraviteja-b                     asyncResp->res.jsonValue = {
1779c9bb6861Sraviteja-b                         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1780c9bb6861Sraviteja-b                         {"@odata.id",
1781c9bb6861Sraviteja-b                          "/redfish/v1/Systems/system/LogServices/System/"
1782c9bb6861Sraviteja-b                          "Entries/" +
1783c9bb6861Sraviteja-b                              entryID},
1784c9bb6861Sraviteja-b                         {"Name", "System Dump Entry"},
1785c9bb6861Sraviteja-b                         {"Id", entryID},
1786c9bb6861Sraviteja-b                         {"SizeInB", size},
1787c9bb6861Sraviteja-b                         {"EntryType", "Dump"},
1788c9bb6861Sraviteja-b                         {"EntryCode", "User generated dump"},
1789c9bb6861Sraviteja-b                         {"Created", timestamp}};
1790c9bb6861Sraviteja-b 
1791c9bb6861Sraviteja-b                     asyncResp->res
1792c9bb6861Sraviteja-b                         .jsonValue["Actions"]["#LogEntry.DownloadLog"] = {
1793c9bb6861Sraviteja-b                         {"target",
1794c9bb6861Sraviteja-b                          "/redfish/v1/Systems/system/LogServices/System/"
1795c9bb6861Sraviteja-b                          "Entries/" +
1796c9bb6861Sraviteja-b                              entryID + "/Actions/LogEntry.DownloadLog"}};
1797c9bb6861Sraviteja-b                 }
1798c9bb6861Sraviteja-b             },
1799c9bb6861Sraviteja-b             "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
1800c9bb6861Sraviteja-b             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1801c9bb6861Sraviteja-b     }
1802c9bb6861Sraviteja-b 
1803c9bb6861Sraviteja-b     void doDelete(crow::Response &res, const crow::Request &req,
1804c9bb6861Sraviteja-b                   const std::vector<std::string> &params) override
1805c9bb6861Sraviteja-b     {
1806c9bb6861Sraviteja-b         BMCWEB_LOG_DEBUG << "Do delete single dump entry";
1807c9bb6861Sraviteja-b 
1808c9bb6861Sraviteja-b         auto asyncResp = std::make_shared<AsyncResp>(res);
1809c9bb6861Sraviteja-b 
1810c9bb6861Sraviteja-b         if (params.size() != 1)
1811c9bb6861Sraviteja-b         {
1812c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
1813c9bb6861Sraviteja-b             return;
1814c9bb6861Sraviteja-b         }
1815c9bb6861Sraviteja-b         std::string entryID = params[0];
1816c9bb6861Sraviteja-b 
1817c9bb6861Sraviteja-b         crow::connections::systemBus->async_method_call(
1818c9bb6861Sraviteja-b             [asyncResp,
1819c9bb6861Sraviteja-b              entryID](const boost::system::error_code ec,
1820c9bb6861Sraviteja-b                       const crow::openbmc_mapper::GetSubTreeType &resp) {
1821c9bb6861Sraviteja-b                 if (ec)
1822c9bb6861Sraviteja-b                 {
1823c9bb6861Sraviteja-b                     BMCWEB_LOG_ERROR << " resp_handler got error " << ec;
1824c9bb6861Sraviteja-b                     messages::internalError(asyncResp->res);
1825c9bb6861Sraviteja-b                     return;
1826c9bb6861Sraviteja-b                 }
1827c9bb6861Sraviteja-b 
1828c9bb6861Sraviteja-b                 for (auto &object : resp)
1829c9bb6861Sraviteja-b                 {
1830c9bb6861Sraviteja-b                     const std::string &path =
1831c9bb6861Sraviteja-b                         static_cast<const std::string &>(object.first);
1832c9bb6861Sraviteja-b 
1833c9bb6861Sraviteja-b                     std::size_t pos = path.rfind(
1834c9bb6861Sraviteja-b                         "/xyz/openbmc_project/dump/entry/" + entryID);
1835c9bb6861Sraviteja-b                     if (pos != std::string::npos)
1836c9bb6861Sraviteja-b                     {
1837c9bb6861Sraviteja-b                         deleteSystemDumpEntry(asyncResp->res, entryID);
1838c9bb6861Sraviteja-b                         return;
1839c9bb6861Sraviteja-b                     }
1840c9bb6861Sraviteja-b                 }
1841c9bb6861Sraviteja-b             },
1842c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper",
1843c9bb6861Sraviteja-b             "/xyz/openbmc_project/object_mapper",
1844c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper", "GetSubTree",
1845c9bb6861Sraviteja-b             "/xyz/openbmc_project/dump", 0,
1846c9bb6861Sraviteja-b             std::array<const char *, 1>{
1847c9bb6861Sraviteja-b                 "xyz.openbmc_project.Dump.Entry.System"});
1848c9bb6861Sraviteja-b     }
1849c9bb6861Sraviteja-b };
1850c9bb6861Sraviteja-b 
18510657843aSraviteja-b class SystemDumpEntryDownload : public Node
18520657843aSraviteja-b {
18530657843aSraviteja-b   public:
18540657843aSraviteja-b     SystemDumpEntryDownload(CrowApp &app) :
18550657843aSraviteja-b         Node(app,
18560657843aSraviteja-b              "/redfish/v1/Systems/system/LogServices/System/Entries/<str>/"
18570657843aSraviteja-b              "Actions/"
18580657843aSraviteja-b              "LogEntry.DownloadLog/",
18590657843aSraviteja-b              std::string())
18600657843aSraviteja-b     {
18610657843aSraviteja-b         entityPrivileges = {
18620657843aSraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
18630657843aSraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
18640657843aSraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
18650657843aSraviteja-b     }
18660657843aSraviteja-b 
18670657843aSraviteja-b   private:
18680657843aSraviteja-b     void doPost(crow::Response &res, const crow::Request &req,
18690657843aSraviteja-b                 const std::vector<std::string> &params) override
18700657843aSraviteja-b     {
18710657843aSraviteja-b         if (params.size() != 1)
18720657843aSraviteja-b         {
18730657843aSraviteja-b             messages::internalError(res);
18740657843aSraviteja-b             return;
18750657843aSraviteja-b         }
18760657843aSraviteja-b         const std::string &entryID = params[0];
18770657843aSraviteja-b         crow::obmc_dump::handleDumpOffloadUrl(req, res, entryID);
18780657843aSraviteja-b     }
18790657843aSraviteja-b };
18800657843aSraviteja-b 
1881*013487e5Sraviteja-b class SystemDumpClear : public Node
1882*013487e5Sraviteja-b {
1883*013487e5Sraviteja-b   public:
1884*013487e5Sraviteja-b     SystemDumpClear(CrowApp &app) :
1885*013487e5Sraviteja-b         Node(app, "/redfish/v1/Systems/system/LogServices/System/"
1886*013487e5Sraviteja-b                   "Actions/"
1887*013487e5Sraviteja-b                   "LogService.ClearLog/")
1888*013487e5Sraviteja-b     {
1889*013487e5Sraviteja-b         entityPrivileges = {
1890*013487e5Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1891*013487e5Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1892*013487e5Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1893*013487e5Sraviteja-b     }
1894*013487e5Sraviteja-b 
1895*013487e5Sraviteja-b   private:
1896*013487e5Sraviteja-b     void doPost(crow::Response &res, const crow::Request &req,
1897*013487e5Sraviteja-b                 const std::vector<std::string> &params) override
1898*013487e5Sraviteja-b     {
1899*013487e5Sraviteja-b 
1900*013487e5Sraviteja-b         auto asyncResp = std::make_shared<AsyncResp>(res);
1901*013487e5Sraviteja-b         crow::connections::systemBus->async_method_call(
1902*013487e5Sraviteja-b             [asyncResp](const boost::system::error_code ec,
1903*013487e5Sraviteja-b                         const std::vector<std::string> &dumpList) {
1904*013487e5Sraviteja-b                 if (ec)
1905*013487e5Sraviteja-b                 {
1906*013487e5Sraviteja-b                     messages::internalError(asyncResp->res);
1907*013487e5Sraviteja-b                     return;
1908*013487e5Sraviteja-b                 }
1909*013487e5Sraviteja-b 
1910*013487e5Sraviteja-b                 for (const std::string &objectPath : dumpList)
1911*013487e5Sraviteja-b                 {
1912*013487e5Sraviteja-b                     std::size_t pos = objectPath.rfind("/");
1913*013487e5Sraviteja-b                     if (pos != std::string::npos)
1914*013487e5Sraviteja-b                     {
1915*013487e5Sraviteja-b                         std::string logID = objectPath.substr(pos + 1);
1916*013487e5Sraviteja-b                         deleteSystemDumpEntry(asyncResp->res, logID);
1917*013487e5Sraviteja-b                     }
1918*013487e5Sraviteja-b                 }
1919*013487e5Sraviteja-b             },
1920*013487e5Sraviteja-b             "xyz.openbmc_project.ObjectMapper",
1921*013487e5Sraviteja-b             "/xyz/openbmc_project/object_mapper",
1922*013487e5Sraviteja-b             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
1923*013487e5Sraviteja-b             "/xyz/openbmc_project/dump", 0,
1924*013487e5Sraviteja-b             std::array<const char *, 1>{
1925*013487e5Sraviteja-b                 "xyz.openbmc_project.Dump.Entry.System"});
1926*013487e5Sraviteja-b     }
1927*013487e5Sraviteja-b };
1928*013487e5Sraviteja-b 
1929424c4176SJason M. Bills class CrashdumpService : public Node
1930e1f26343SJason M. Bills {
1931e1f26343SJason M. Bills   public:
1932e1f26343SJason M. Bills     template <typename CrowApp>
1933424c4176SJason M. Bills     CrashdumpService(CrowApp &app) :
1934424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
19351da66f75SEd Tanous     {
19363946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
19373946028dSAppaRao Puli         // method for security reasons.
19381da66f75SEd Tanous         entityPrivileges = {
19393946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
19403946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
1941e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1942e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1943e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1944e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
19451da66f75SEd Tanous     }
19461da66f75SEd Tanous 
19471da66f75SEd Tanous   private:
19481da66f75SEd Tanous     /**
19491da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
19501da66f75SEd Tanous      */
19511da66f75SEd Tanous     void doGet(crow::Response &res, const crow::Request &req,
19521da66f75SEd Tanous                const std::vector<std::string> &params) override
19531da66f75SEd Tanous     {
1954e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
19551da66f75SEd Tanous         // Copy over the static data to include the entries added by SubRoute
19560f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
1957424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
1958e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1959e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
19604f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
19614f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
19624f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
1963e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1964e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
1965cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1966cd50aa42SJason M. Bills             {"@odata.id",
1967424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
1968e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"] = {
19695b61b5e8SJason M. Bills             {"#LogService.ClearLog",
19705b61b5e8SJason M. Bills              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
19715b61b5e8SJason M. Bills                          "Actions/LogService.ClearLog"}}},
19721da66f75SEd Tanous             {"Oem",
1973424c4176SJason M. Bills              {{"#Crashdump.OnDemand",
1974424c4176SJason M. Bills                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
1975424c4176SJason M. Bills                            "Actions/Oem/Crashdump.OnDemand"}}}}}};
19761da66f75SEd Tanous 
19771da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI
1978e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"]["Oem"].push_back(
1979424c4176SJason M. Bills             {"#Crashdump.SendRawPeci",
198008a4e4b5SAnthony Wilson              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
1981424c4176SJason M. Bills                          "Actions/Oem/Crashdump.SendRawPeci"}}});
19821da66f75SEd Tanous #endif
19831da66f75SEd Tanous     }
19841da66f75SEd Tanous };
19851da66f75SEd Tanous 
19865b61b5e8SJason M. Bills class CrashdumpClear : public Node
19875b61b5e8SJason M. Bills {
19885b61b5e8SJason M. Bills   public:
19895b61b5e8SJason M. Bills     CrashdumpClear(CrowApp &app) :
19905b61b5e8SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
19915b61b5e8SJason M. Bills                   "LogService.ClearLog/")
19925b61b5e8SJason M. Bills     {
19933946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
19943946028dSAppaRao Puli         // method for security reasons.
19955b61b5e8SJason M. Bills         entityPrivileges = {
19963946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
19973946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
19985b61b5e8SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
19995b61b5e8SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
20005b61b5e8SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
20015b61b5e8SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
20025b61b5e8SJason M. Bills     }
20035b61b5e8SJason M. Bills 
20045b61b5e8SJason M. Bills   private:
20055b61b5e8SJason M. Bills     void doPost(crow::Response &res, const crow::Request &req,
20065b61b5e8SJason M. Bills                 const std::vector<std::string> &params) override
20075b61b5e8SJason M. Bills     {
20085b61b5e8SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
20095b61b5e8SJason M. Bills 
20105b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
20115b61b5e8SJason M. Bills             [asyncResp](const boost::system::error_code ec,
20125b61b5e8SJason M. Bills                         const std::string &resp) {
20135b61b5e8SJason M. Bills                 if (ec)
20145b61b5e8SJason M. Bills                 {
20155b61b5e8SJason M. Bills                     messages::internalError(asyncResp->res);
20165b61b5e8SJason M. Bills                     return;
20175b61b5e8SJason M. Bills                 }
20185b61b5e8SJason M. Bills                 messages::success(asyncResp->res);
20195b61b5e8SJason M. Bills             },
20205b61b5e8SJason M. Bills             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
20215b61b5e8SJason M. Bills     }
20225b61b5e8SJason M. Bills };
20235b61b5e8SJason M. Bills 
2024e855dd28SJason M. Bills static void logCrashdumpEntry(std::shared_ptr<AsyncResp> asyncResp,
2025e855dd28SJason M. Bills                               const std::string &logID,
2026e855dd28SJason M. Bills                               nlohmann::json &logEntryJson)
2027e855dd28SJason M. Bills {
2028043a0536SJohnathan Mantey     auto getStoredLogCallback =
2029043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2030e855dd28SJason M. Bills             const boost::system::error_code ec,
2031043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>> &params) {
2032e855dd28SJason M. Bills             if (ec)
2033e855dd28SJason M. Bills             {
2034e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
20351ddcf01aSJason M. Bills                 if (ec.value() ==
20361ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
20371ddcf01aSJason M. Bills                 {
2038043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2039043a0536SJohnathan Mantey                                                logID);
20401ddcf01aSJason M. Bills                 }
20411ddcf01aSJason M. Bills                 else
20421ddcf01aSJason M. Bills                 {
2043e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
20441ddcf01aSJason M. Bills                 }
2045e855dd28SJason M. Bills                 return;
2046e855dd28SJason M. Bills             }
2047043a0536SJohnathan Mantey 
2048043a0536SJohnathan Mantey             std::string timestamp{};
2049043a0536SJohnathan Mantey             std::string filename{};
2050043a0536SJohnathan Mantey             std::string logfile{};
2051043a0536SJohnathan Mantey             ParseCrashdumpParameters(params, filename, timestamp, logfile);
2052043a0536SJohnathan Mantey 
2053043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2054e855dd28SJason M. Bills             {
2055043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2056e855dd28SJason M. Bills                 return;
2057e855dd28SJason M. Bills             }
2058e855dd28SJason M. Bills 
2059043a0536SJohnathan Mantey             std::string crashdumpURI =
2060e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2061043a0536SJohnathan Mantey                 logID + "/" + filename;
2062043a0536SJohnathan Mantey             logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2063043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2064043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2065e855dd28SJason M. Bills                                               logID},
2066e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2067e855dd28SJason M. Bills                             {"Id", logID},
2068e855dd28SJason M. Bills                             {"EntryType", "Oem"},
2069e855dd28SJason M. Bills                             {"OemRecordFormat", "Crashdump URI"},
2070043a0536SJohnathan Mantey                             {"Message", std::move(crashdumpURI)},
2071043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2072e855dd28SJason M. Bills         };
2073e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
20745b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
20755b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2076043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2077e855dd28SJason M. Bills }
2078e855dd28SJason M. Bills 
2079424c4176SJason M. Bills class CrashdumpEntryCollection : public Node
20801da66f75SEd Tanous {
20811da66f75SEd Tanous   public:
20821da66f75SEd Tanous     template <typename CrowApp>
2083424c4176SJason M. Bills     CrashdumpEntryCollection(CrowApp &app) :
2084424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
20851da66f75SEd Tanous     {
20863946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
20873946028dSAppaRao Puli         // method for security reasons.
20881da66f75SEd Tanous         entityPrivileges = {
20893946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
20903946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2091e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2092e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2093e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2094e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
20951da66f75SEd Tanous     }
20961da66f75SEd Tanous 
20971da66f75SEd Tanous   private:
20981da66f75SEd Tanous     /**
20991da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
21001da66f75SEd Tanous      */
21011da66f75SEd Tanous     void doGet(crow::Response &res, const crow::Request &req,
21021da66f75SEd Tanous                const std::vector<std::string> &params) override
21031da66f75SEd Tanous     {
2104e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
21051da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
21061da66f75SEd Tanous         // it has a duplicate entry for members
2107e1f26343SJason M. Bills         auto getLogEntriesCallback = [asyncResp](
2108e1f26343SJason M. Bills                                          const boost::system::error_code ec,
21091da66f75SEd Tanous                                          const std::vector<std::string> &resp) {
21101da66f75SEd Tanous             if (ec)
21111da66f75SEd Tanous             {
21121da66f75SEd Tanous                 if (ec.value() !=
21131da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
21141da66f75SEd Tanous                 {
21151da66f75SEd Tanous                     BMCWEB_LOG_DEBUG << "failed to get entries ec: "
21161da66f75SEd Tanous                                      << ec.message();
2117f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
21181da66f75SEd Tanous                     return;
21191da66f75SEd Tanous                 }
21201da66f75SEd Tanous             }
2121e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
21221da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
21230f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2124424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2125424c4176SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2126e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2127424c4176SJason M. Bills                 "Collection of Crashdump Entries";
2128e1f26343SJason M. Bills             nlohmann::json &logEntryArray = asyncResp->res.jsonValue["Members"];
2129e1f26343SJason M. Bills             logEntryArray = nlohmann::json::array();
2130e855dd28SJason M. Bills             std::vector<std::string> logIDs;
2131e855dd28SJason M. Bills             // Get the list of log entries and build up an empty array big
2132e855dd28SJason M. Bills             // enough to hold them
21331da66f75SEd Tanous             for (const std::string &objpath : resp)
21341da66f75SEd Tanous             {
2135e855dd28SJason M. Bills                 // Get the log ID
21364ed77cd5SEd Tanous                 std::size_t lastPos = objpath.rfind("/");
2137e855dd28SJason M. Bills                 if (lastPos == std::string::npos)
21381da66f75SEd Tanous                 {
2139e855dd28SJason M. Bills                     continue;
21401da66f75SEd Tanous                 }
2141e855dd28SJason M. Bills                 logIDs.emplace_back(objpath.substr(lastPos + 1));
2142e855dd28SJason M. Bills 
2143e855dd28SJason M. Bills                 // Add a space for the log entry to the array
2144e855dd28SJason M. Bills                 logEntryArray.push_back({});
2145e855dd28SJason M. Bills             }
2146e855dd28SJason M. Bills             // Now go through and set up async calls to fill in the entries
2147e855dd28SJason M. Bills             size_t index = 0;
2148e855dd28SJason M. Bills             for (const std::string &logID : logIDs)
2149e855dd28SJason M. Bills             {
2150e855dd28SJason M. Bills                 // Add the log entry to the array
2151e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
21521da66f75SEd Tanous             }
2153e1f26343SJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
2154e1f26343SJason M. Bills                 logEntryArray.size();
21551da66f75SEd Tanous         };
21561da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
21571da66f75SEd Tanous             std::move(getLogEntriesCallback),
21581da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper",
21591da66f75SEd Tanous             "/xyz/openbmc_project/object_mapper",
21601da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
21615b61b5e8SJason M. Bills             std::array<const char *, 1>{crashdumpInterface});
21621da66f75SEd Tanous     }
21631da66f75SEd Tanous };
21641da66f75SEd Tanous 
2165424c4176SJason M. Bills class CrashdumpEntry : public Node
21661da66f75SEd Tanous {
21671da66f75SEd Tanous   public:
2168424c4176SJason M. Bills     CrashdumpEntry(CrowApp &app) :
2169d53dd41fSJason M. Bills         Node(app,
2170424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/",
21711da66f75SEd Tanous              std::string())
21721da66f75SEd Tanous     {
21733946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
21743946028dSAppaRao Puli         // method for security reasons.
21751da66f75SEd Tanous         entityPrivileges = {
21763946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
21773946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2178e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2179e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2180e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2181e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
21821da66f75SEd Tanous     }
21831da66f75SEd Tanous 
21841da66f75SEd Tanous   private:
21851da66f75SEd Tanous     void doGet(crow::Response &res, const crow::Request &req,
21861da66f75SEd Tanous                const std::vector<std::string> &params) override
21871da66f75SEd Tanous     {
2188e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
21891da66f75SEd Tanous         if (params.size() != 1)
21901da66f75SEd Tanous         {
2191f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
21921da66f75SEd Tanous             return;
21931da66f75SEd Tanous         }
2194e855dd28SJason M. Bills         const std::string &logID = params[0];
2195e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
2196e855dd28SJason M. Bills     }
2197e855dd28SJason M. Bills };
2198e855dd28SJason M. Bills 
2199e855dd28SJason M. Bills class CrashdumpFile : public Node
2200e855dd28SJason M. Bills {
2201e855dd28SJason M. Bills   public:
2202e855dd28SJason M. Bills     CrashdumpFile(CrowApp &app) :
2203e855dd28SJason M. Bills         Node(app,
2204e855dd28SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/"
2205e855dd28SJason M. Bills              "<str>/",
2206e855dd28SJason M. Bills              std::string(), std::string())
2207e855dd28SJason M. Bills     {
22083946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
22093946028dSAppaRao Puli         // method for security reasons.
2210e855dd28SJason M. Bills         entityPrivileges = {
22113946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
22123946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2213e855dd28SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2214e855dd28SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2215e855dd28SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2216e855dd28SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2217e855dd28SJason M. Bills     }
2218e855dd28SJason M. Bills 
2219e855dd28SJason M. Bills   private:
2220e855dd28SJason M. Bills     void doGet(crow::Response &res, const crow::Request &req,
2221e855dd28SJason M. Bills                const std::vector<std::string> &params) override
2222e855dd28SJason M. Bills     {
2223e855dd28SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2224e855dd28SJason M. Bills         if (params.size() != 2)
2225e855dd28SJason M. Bills         {
2226e855dd28SJason M. Bills             messages::internalError(asyncResp->res);
2227e855dd28SJason M. Bills             return;
2228e855dd28SJason M. Bills         }
2229e855dd28SJason M. Bills         const std::string &logID = params[0];
2230e855dd28SJason M. Bills         const std::string &fileName = params[1];
2231e855dd28SJason M. Bills 
2232043a0536SJohnathan Mantey         auto getStoredLogCallback =
2233043a0536SJohnathan Mantey             [asyncResp, logID, fileName](
2234abf2add6SEd Tanous                 const boost::system::error_code ec,
2235043a0536SJohnathan Mantey                 const std::vector<std::pair<std::string, VariantType>> &resp) {
22361da66f75SEd Tanous                 if (ec)
22371da66f75SEd Tanous                 {
2238043a0536SJohnathan Mantey                     BMCWEB_LOG_DEBUG << "failed to get log ec: "
2239043a0536SJohnathan Mantey                                      << ec.message();
2240f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
22411da66f75SEd Tanous                     return;
22421da66f75SEd Tanous                 }
2243e855dd28SJason M. Bills 
2244043a0536SJohnathan Mantey                 std::string dbusFilename{};
2245043a0536SJohnathan Mantey                 std::string dbusTimestamp{};
2246043a0536SJohnathan Mantey                 std::string dbusFilepath{};
2247043a0536SJohnathan Mantey 
2248043a0536SJohnathan Mantey                 ParseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
2249043a0536SJohnathan Mantey                                          dbusFilepath);
2250043a0536SJohnathan Mantey 
2251043a0536SJohnathan Mantey                 if (dbusFilename.empty() || dbusTimestamp.empty() ||
2252043a0536SJohnathan Mantey                     dbusFilepath.empty())
22531da66f75SEd Tanous                 {
2254e855dd28SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, fileName);
22551da66f75SEd Tanous                     return;
22561da66f75SEd Tanous                 }
2257e855dd28SJason M. Bills 
2258043a0536SJohnathan Mantey                 // Verify the file name parameter is correct
2259043a0536SJohnathan Mantey                 if (fileName != dbusFilename)
2260043a0536SJohnathan Mantey                 {
2261043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2262043a0536SJohnathan Mantey                     return;
2263043a0536SJohnathan Mantey                 }
2264043a0536SJohnathan Mantey 
2265043a0536SJohnathan Mantey                 if (!std::filesystem::exists(dbusFilepath))
2266043a0536SJohnathan Mantey                 {
2267043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2268043a0536SJohnathan Mantey                     return;
2269043a0536SJohnathan Mantey                 }
2270043a0536SJohnathan Mantey                 std::ifstream ifs(dbusFilepath, std::ios::in |
2271043a0536SJohnathan Mantey                                                     std::ios::binary |
2272043a0536SJohnathan Mantey                                                     std::ios::ate);
2273043a0536SJohnathan Mantey                 std::ifstream::pos_type fileSize = ifs.tellg();
2274043a0536SJohnathan Mantey                 if (fileSize < 0)
2275043a0536SJohnathan Mantey                 {
2276043a0536SJohnathan Mantey                     messages::generalError(asyncResp->res);
2277043a0536SJohnathan Mantey                     return;
2278043a0536SJohnathan Mantey                 }
2279043a0536SJohnathan Mantey                 ifs.seekg(0, std::ios::beg);
2280043a0536SJohnathan Mantey 
2281043a0536SJohnathan Mantey                 auto crashData = std::make_unique<char[]>(
2282043a0536SJohnathan Mantey                     static_cast<unsigned int>(fileSize));
2283043a0536SJohnathan Mantey 
2284043a0536SJohnathan Mantey                 ifs.read(crashData.get(), static_cast<int>(fileSize));
2285043a0536SJohnathan Mantey 
2286043a0536SJohnathan Mantey                 // The cast to std::string is intentional in order to use the
2287043a0536SJohnathan Mantey                 // assign() that applies move mechanics
2288043a0536SJohnathan Mantey                 asyncResp->res.body().assign(
2289043a0536SJohnathan Mantey                     static_cast<std::string>(crashData.get()));
2290043a0536SJohnathan Mantey 
2291043a0536SJohnathan Mantey                 // Configure this to be a file download when accessed from
2292043a0536SJohnathan Mantey                 // a browser
2293e855dd28SJason M. Bills                 asyncResp->res.addHeader("Content-Disposition", "attachment");
22941da66f75SEd Tanous             };
22951da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
22965b61b5e8SJason M. Bills             std::move(getStoredLogCallback), crashdumpObject,
22975b61b5e8SJason M. Bills             crashdumpPath + std::string("/") + logID,
2298043a0536SJohnathan Mantey             "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
22991da66f75SEd Tanous     }
23001da66f75SEd Tanous };
23011da66f75SEd Tanous 
2302424c4176SJason M. Bills class OnDemandCrashdump : public Node
23031da66f75SEd Tanous {
23041da66f75SEd Tanous   public:
2305424c4176SJason M. Bills     OnDemandCrashdump(CrowApp &app) :
2306424c4176SJason M. Bills         Node(app,
2307424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2308424c4176SJason M. Bills              "Crashdump.OnDemand/")
23091da66f75SEd Tanous     {
23103946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
23113946028dSAppaRao Puli         // method for security reasons.
23121da66f75SEd Tanous         entityPrivileges = {
23133946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
23143946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
23153946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
23163946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
23173946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
23183946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
23191da66f75SEd Tanous     }
23201da66f75SEd Tanous 
23211da66f75SEd Tanous   private:
23221da66f75SEd Tanous     void doPost(crow::Response &res, const crow::Request &req,
23231da66f75SEd Tanous                 const std::vector<std::string> &params) override
23241da66f75SEd Tanous     {
2325e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
23261da66f75SEd Tanous 
2327fe306728SJames Feist         auto generateonDemandLogCallback = [asyncResp,
2328fe306728SJames Feist                                             req](const boost::system::error_code
232946229577SJames Feist                                                      ec,
23301da66f75SEd Tanous                                                  const std::string &resp) {
23311da66f75SEd Tanous             if (ec)
23321da66f75SEd Tanous             {
233346229577SJames Feist                 if (ec.value() == boost::system::errc::operation_not_supported)
23341da66f75SEd Tanous                 {
2335f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
23361da66f75SEd Tanous                 }
23374363d3b2SJason M. Bills                 else if (ec.value() ==
23384363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
23394363d3b2SJason M. Bills                 {
23404363d3b2SJason M. Bills                     messages::serviceTemporarilyUnavailable(asyncResp->res,
23414363d3b2SJason M. Bills                                                             "60");
23424363d3b2SJason M. Bills                 }
23431da66f75SEd Tanous                 else
23441da66f75SEd Tanous                 {
2345f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
23461da66f75SEd Tanous                 }
23471da66f75SEd Tanous                 return;
23481da66f75SEd Tanous             }
234946229577SJames Feist             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
235066afe4faSJames Feist                 [](boost::system::error_code err, sdbusplus::message::message &,
235166afe4faSJames Feist                    const std::shared_ptr<task::TaskData> &taskData) {
235266afe4faSJames Feist                     if (!err)
235366afe4faSJames Feist                     {
2354e5d5006bSJames Feist                         taskData->messages.emplace_back(
2355e5d5006bSJames Feist                             messages::taskCompletedOK(
2356e5d5006bSJames Feist                                 std::to_string(taskData->index)));
2357831d6b09SJames Feist                         taskData->state = "Completed";
235866afe4faSJames Feist                     }
235932898ceaSJames Feist                     return task::completed;
236066afe4faSJames Feist                 },
236146229577SJames Feist                 "type='signal',interface='org.freedesktop.DBus.Properties',"
236246229577SJames Feist                 "member='PropertiesChanged',arg0namespace='com.intel."
236346229577SJames Feist                 "crashdump'");
236446229577SJames Feist             task->startTimer(std::chrono::minutes(5));
236546229577SJames Feist             task->populateResp(asyncResp->res);
2366fe306728SJames Feist             task->payload.emplace(req);
23671da66f75SEd Tanous         };
23681da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
23695b61b5e8SJason M. Bills             std::move(generateonDemandLogCallback), crashdumpObject,
23705b61b5e8SJason M. Bills             crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog");
23711da66f75SEd Tanous     }
23721da66f75SEd Tanous };
23731da66f75SEd Tanous 
2374e1f26343SJason M. Bills class SendRawPECI : public Node
23751da66f75SEd Tanous {
23761da66f75SEd Tanous   public:
2377e1f26343SJason M. Bills     SendRawPECI(CrowApp &app) :
2378424c4176SJason M. Bills         Node(app,
2379424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2380424c4176SJason M. Bills              "Crashdump.SendRawPeci/")
23811da66f75SEd Tanous     {
23823946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
23833946028dSAppaRao Puli         // method for security reasons.
23841da66f75SEd Tanous         entityPrivileges = {
23851da66f75SEd Tanous             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
23861da66f75SEd Tanous             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
23871da66f75SEd Tanous             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
23881da66f75SEd Tanous             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
23891da66f75SEd Tanous             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
23901da66f75SEd Tanous             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
23911da66f75SEd Tanous     }
23921da66f75SEd Tanous 
23931da66f75SEd Tanous   private:
23941da66f75SEd Tanous     void doPost(crow::Response &res, const crow::Request &req,
23951da66f75SEd Tanous                 const std::vector<std::string> &params) override
23961da66f75SEd Tanous     {
2397e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
23988724c297SKarthick Sundarrajan         std::vector<std::vector<uint8_t>> peciCommands;
23998724c297SKarthick Sundarrajan 
24008724c297SKarthick Sundarrajan         nlohmann::json reqJson =
24018724c297SKarthick Sundarrajan             nlohmann::json::parse(req.body, nullptr, false);
24028724c297SKarthick Sundarrajan         if (reqJson.find("PECICommands") != reqJson.end())
24038724c297SKarthick Sundarrajan         {
24048724c297SKarthick Sundarrajan             if (!json_util::readJson(req, res, "PECICommands", peciCommands))
24058724c297SKarthick Sundarrajan             {
24068724c297SKarthick Sundarrajan                 return;
24078724c297SKarthick Sundarrajan             }
24088724c297SKarthick Sundarrajan             uint32_t idx = 0;
24098724c297SKarthick Sundarrajan             for (auto const &cmd : peciCommands)
24108724c297SKarthick Sundarrajan             {
24118724c297SKarthick Sundarrajan                 if (cmd.size() < 3)
24128724c297SKarthick Sundarrajan                 {
24138724c297SKarthick Sundarrajan                     std::string s("[");
24148724c297SKarthick Sundarrajan                     for (auto const &val : cmd)
24158724c297SKarthick Sundarrajan                     {
24168724c297SKarthick Sundarrajan                         if (val != *cmd.begin())
24178724c297SKarthick Sundarrajan                         {
24188724c297SKarthick Sundarrajan                             s += ",";
24198724c297SKarthick Sundarrajan                         }
24208724c297SKarthick Sundarrajan                         s += std::to_string(val);
24218724c297SKarthick Sundarrajan                     }
24228724c297SKarthick Sundarrajan                     s += "]";
24238724c297SKarthick Sundarrajan                     messages::actionParameterValueFormatError(
24248724c297SKarthick Sundarrajan                         res, s, "PECICommands[" + std::to_string(idx) + "]",
24258724c297SKarthick Sundarrajan                         "SendRawPeci");
24268724c297SKarthick Sundarrajan                     return;
24278724c297SKarthick Sundarrajan                 }
24288724c297SKarthick Sundarrajan                 idx++;
24298724c297SKarthick Sundarrajan             }
24308724c297SKarthick Sundarrajan         }
24318724c297SKarthick Sundarrajan         else
24328724c297SKarthick Sundarrajan         {
24338724c297SKarthick Sundarrajan             /* This interface is deprecated */
2434b1556427SEd Tanous             uint8_t clientAddress = 0;
2435b1556427SEd Tanous             uint8_t readLength = 0;
24361da66f75SEd Tanous             std::vector<uint8_t> peciCommand;
2437b1556427SEd Tanous             if (!json_util::readJson(req, res, "ClientAddress", clientAddress,
2438b1556427SEd Tanous                                      "ReadLength", readLength, "PECICommand",
2439b1556427SEd Tanous                                      peciCommand))
24401da66f75SEd Tanous             {
24411da66f75SEd Tanous                 return;
24421da66f75SEd Tanous             }
24438724c297SKarthick Sundarrajan             peciCommands.push_back({clientAddress, 0, readLength});
24448724c297SKarthick Sundarrajan             peciCommands[0].insert(peciCommands[0].end(), peciCommand.begin(),
24458724c297SKarthick Sundarrajan                                    peciCommand.end());
24468724c297SKarthick Sundarrajan         }
24471da66f75SEd Tanous         // Callback to return the Raw PECI response
2448e1f26343SJason M. Bills         auto sendRawPECICallback =
2449e1f26343SJason M. Bills             [asyncResp](const boost::system::error_code ec,
24508724c297SKarthick Sundarrajan                         const std::vector<std::vector<uint8_t>> &resp) {
24511da66f75SEd Tanous                 if (ec)
24521da66f75SEd Tanous                 {
24538724c297SKarthick Sundarrajan                     BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: "
24541da66f75SEd Tanous                                      << ec.message();
2455f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
24561da66f75SEd Tanous                     return;
24571da66f75SEd Tanous                 }
2458e1f26343SJason M. Bills                 asyncResp->res.jsonValue = {{"Name", "PECI Command Response"},
24591da66f75SEd Tanous                                             {"PECIResponse", resp}};
24601da66f75SEd Tanous             };
24611da66f75SEd Tanous         // Call the SendRawPECI command with the provided data
24621da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
24635b61b5e8SJason M. Bills             std::move(sendRawPECICallback), crashdumpObject, crashdumpPath,
24648724c297SKarthick Sundarrajan             crashdumpRawPECIInterface, "SendRawPeci", peciCommands);
24651da66f75SEd Tanous     }
24661da66f75SEd Tanous };
24671da66f75SEd Tanous 
2468cb92c03bSAndrew Geissler /**
2469cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
2470cb92c03bSAndrew Geissler  */
2471cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node
2472cb92c03bSAndrew Geissler {
2473cb92c03bSAndrew Geissler   public:
2474cb92c03bSAndrew Geissler     DBusLogServiceActionsClear(CrowApp &app) :
2475cb92c03bSAndrew Geissler         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
24767af91514SGunnar Mills                   "LogService.ClearLog/")
2477cb92c03bSAndrew Geissler     {
2478cb92c03bSAndrew Geissler         entityPrivileges = {
2479cb92c03bSAndrew Geissler             {boost::beast::http::verb::get, {{"Login"}}},
2480cb92c03bSAndrew Geissler             {boost::beast::http::verb::head, {{"Login"}}},
2481cb92c03bSAndrew Geissler             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2482cb92c03bSAndrew Geissler             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2483cb92c03bSAndrew Geissler             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2484cb92c03bSAndrew Geissler             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2485cb92c03bSAndrew Geissler     }
2486cb92c03bSAndrew Geissler 
2487cb92c03bSAndrew Geissler   private:
2488cb92c03bSAndrew Geissler     /**
2489cb92c03bSAndrew Geissler      * Function handles POST method request.
2490cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
2491cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
2492cb92c03bSAndrew Geissler      */
2493cb92c03bSAndrew Geissler     void doPost(crow::Response &res, const crow::Request &req,
2494cb92c03bSAndrew Geissler                 const std::vector<std::string> &params) override
2495cb92c03bSAndrew Geissler     {
2496cb92c03bSAndrew Geissler         BMCWEB_LOG_DEBUG << "Do delete all entries.";
2497cb92c03bSAndrew Geissler 
2498cb92c03bSAndrew Geissler         auto asyncResp = std::make_shared<AsyncResp>(res);
2499cb92c03bSAndrew Geissler         // Process response from Logging service.
2500cb92c03bSAndrew Geissler         auto resp_handler = [asyncResp](const boost::system::error_code ec) {
2501cb92c03bSAndrew Geissler             BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
2502cb92c03bSAndrew Geissler             if (ec)
2503cb92c03bSAndrew Geissler             {
2504cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
2505cb92c03bSAndrew Geissler                 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
2506cb92c03bSAndrew Geissler                 asyncResp->res.result(
2507cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
2508cb92c03bSAndrew Geissler                 return;
2509cb92c03bSAndrew Geissler             }
2510cb92c03bSAndrew Geissler 
2511cb92c03bSAndrew Geissler             asyncResp->res.result(boost::beast::http::status::no_content);
2512cb92c03bSAndrew Geissler         };
2513cb92c03bSAndrew Geissler 
2514cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
2515cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
2516cb92c03bSAndrew Geissler             resp_handler, "xyz.openbmc_project.Logging",
2517cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
2518cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
2519cb92c03bSAndrew Geissler     }
2520cb92c03bSAndrew Geissler };
2521a3316fc6SZhikuiRen 
2522a3316fc6SZhikuiRen /****************************************************
2523a3316fc6SZhikuiRen  * Redfish PostCode interfaces
2524a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
2525a3316fc6SZhikuiRen  ******************************************************/
2526a3316fc6SZhikuiRen class PostCodesLogService : public Node
2527a3316fc6SZhikuiRen {
2528a3316fc6SZhikuiRen   public:
2529a3316fc6SZhikuiRen     PostCodesLogService(CrowApp &app) :
2530a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
2531a3316fc6SZhikuiRen     {
2532a3316fc6SZhikuiRen         entityPrivileges = {
2533a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2534a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
2535a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2536a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2537a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2538a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2539a3316fc6SZhikuiRen     }
2540a3316fc6SZhikuiRen 
2541a3316fc6SZhikuiRen   private:
2542a3316fc6SZhikuiRen     void doGet(crow::Response &res, const crow::Request &req,
2543a3316fc6SZhikuiRen                const std::vector<std::string> &params) override
2544a3316fc6SZhikuiRen     {
2545a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2546a3316fc6SZhikuiRen 
2547a3316fc6SZhikuiRen         asyncResp->res.jsonValue = {
2548a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"},
2549a3316fc6SZhikuiRen             {"@odata.type", "#LogService.v1_1_0.LogService"},
2550a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogService.LogService"},
2551a3316fc6SZhikuiRen             {"Name", "POST Code Log Service"},
2552a3316fc6SZhikuiRen             {"Description", "POST Code Log Service"},
2553a3316fc6SZhikuiRen             {"Id", "BIOS POST Code Log"},
2554a3316fc6SZhikuiRen             {"OverWritePolicy", "WrapsWhenFull"},
2555a3316fc6SZhikuiRen             {"Entries",
2556a3316fc6SZhikuiRen              {{"@odata.id",
2557a3316fc6SZhikuiRen                "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
2558a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
2559a3316fc6SZhikuiRen             {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/"
2560a3316fc6SZhikuiRen                        "Actions/LogService.ClearLog"}};
2561a3316fc6SZhikuiRen     }
2562a3316fc6SZhikuiRen };
2563a3316fc6SZhikuiRen 
2564a3316fc6SZhikuiRen class PostCodesClear : public Node
2565a3316fc6SZhikuiRen {
2566a3316fc6SZhikuiRen   public:
2567a3316fc6SZhikuiRen     PostCodesClear(CrowApp &app) :
2568a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
2569a3316fc6SZhikuiRen                   "LogService.ClearLog/")
2570a3316fc6SZhikuiRen     {
2571a3316fc6SZhikuiRen         entityPrivileges = {
2572a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2573a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
25743946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
25753946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
25763946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
25773946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2578a3316fc6SZhikuiRen     }
2579a3316fc6SZhikuiRen 
2580a3316fc6SZhikuiRen   private:
2581a3316fc6SZhikuiRen     void doPost(crow::Response &res, const crow::Request &req,
2582a3316fc6SZhikuiRen                 const std::vector<std::string> &params) override
2583a3316fc6SZhikuiRen     {
2584a3316fc6SZhikuiRen         BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
2585a3316fc6SZhikuiRen 
2586a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2587a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
2588a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
2589a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec) {
2590a3316fc6SZhikuiRen                 if (ec)
2591a3316fc6SZhikuiRen                 {
2592a3316fc6SZhikuiRen                     // TODO Handle for specific error code
2593a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR
2594a3316fc6SZhikuiRen                         << "doClearPostCodes resp_handler got error " << ec;
2595a3316fc6SZhikuiRen                     asyncResp->res.result(
2596a3316fc6SZhikuiRen                         boost::beast::http::status::internal_server_error);
2597a3316fc6SZhikuiRen                     messages::internalError(asyncResp->res);
2598a3316fc6SZhikuiRen                     return;
2599a3316fc6SZhikuiRen                 }
2600a3316fc6SZhikuiRen             },
2601a3316fc6SZhikuiRen             "xyz.openbmc_project.State.Boot.PostCode",
2602a3316fc6SZhikuiRen             "/xyz/openbmc_project/State/Boot/PostCode",
2603a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
2604a3316fc6SZhikuiRen     }
2605a3316fc6SZhikuiRen };
2606a3316fc6SZhikuiRen 
2607a3316fc6SZhikuiRen static void fillPostCodeEntry(
2608a3316fc6SZhikuiRen     std::shared_ptr<AsyncResp> aResp,
2609a3316fc6SZhikuiRen     const boost::container::flat_map<uint64_t, uint64_t> &postcode,
2610a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
2611a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
2612a3316fc6SZhikuiRen {
2613a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
2614a3316fc6SZhikuiRen     const message_registries::Message *message =
2615a3316fc6SZhikuiRen         message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode");
2616a3316fc6SZhikuiRen     std::string severity;
2617a3316fc6SZhikuiRen     if (message != nullptr)
2618a3316fc6SZhikuiRen     {
2619a3316fc6SZhikuiRen         severity = message->severity;
2620a3316fc6SZhikuiRen     }
2621a3316fc6SZhikuiRen 
2622a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
2623a3316fc6SZhikuiRen     nlohmann::json &logEntryArray = aResp->res.jsonValue["Members"];
2624a3316fc6SZhikuiRen 
2625a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
2626a3316fc6SZhikuiRen     for (const std::pair<uint64_t, uint64_t> &code : postcode)
2627a3316fc6SZhikuiRen     {
2628a3316fc6SZhikuiRen         currentCodeIndex++;
2629a3316fc6SZhikuiRen         std::string postcodeEntryID =
2630a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
2631a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
2632a3316fc6SZhikuiRen 
2633a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
2634a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
2635a3316fc6SZhikuiRen 
2636a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
2637a3316fc6SZhikuiRen         { // already incremented
2638a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
2639a3316fc6SZhikuiRen         }
2640a3316fc6SZhikuiRen         else
2641a3316fc6SZhikuiRen         {
2642a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
2643a3316fc6SZhikuiRen         }
2644a3316fc6SZhikuiRen 
2645a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
2646a3316fc6SZhikuiRen         // not fall between top and skip
2647a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
2648a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
2649a3316fc6SZhikuiRen         {
2650a3316fc6SZhikuiRen             continue;
2651a3316fc6SZhikuiRen         }
2652a3316fc6SZhikuiRen 
2653a3316fc6SZhikuiRen         // skip if a sepcific codeIndex is specified and does not match the
2654a3316fc6SZhikuiRen         // currentIndex
2655a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
2656a3316fc6SZhikuiRen         {
2657a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
2658a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
2659a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
2660a3316fc6SZhikuiRen             continue;
2661a3316fc6SZhikuiRen         }
2662a3316fc6SZhikuiRen 
2663a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
2664a3316fc6SZhikuiRen         // index
2665a3316fc6SZhikuiRen 
2666a3316fc6SZhikuiRen         // Get the Created time from the timestamp
2667a3316fc6SZhikuiRen         std::string entryTimeStr;
2668a3316fc6SZhikuiRen         if (!getTimestampStr(usecSinceEpoch, entryTimeStr))
2669a3316fc6SZhikuiRen         {
2670a3316fc6SZhikuiRen             continue;
2671a3316fc6SZhikuiRen         }
2672a3316fc6SZhikuiRen 
2673a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
2674a3316fc6SZhikuiRen         std::ostringstream hexCode;
2675a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
2676a3316fc6SZhikuiRen                 << code.second;
2677a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
2678a3316fc6SZhikuiRen         // Set Fixed -Point Notation
2679a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
2680a3316fc6SZhikuiRen         // Set precision to 4 digits
2681a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
2682a3316fc6SZhikuiRen         // Add double to stream
2683a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
2684a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
2685a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
2686a3316fc6SZhikuiRen 
2687a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
2688a3316fc6SZhikuiRen         std::string msg;
2689a3316fc6SZhikuiRen         if (message != nullptr)
2690a3316fc6SZhikuiRen         {
2691a3316fc6SZhikuiRen             msg = message->message;
2692a3316fc6SZhikuiRen 
2693a3316fc6SZhikuiRen             // fill in this post code value
2694a3316fc6SZhikuiRen             int i = 0;
2695a3316fc6SZhikuiRen             for (const std::string &messageArg : messageArgs)
2696a3316fc6SZhikuiRen             {
2697a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
2698a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
2699a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
2700a3316fc6SZhikuiRen                 {
2701a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
2702a3316fc6SZhikuiRen                 }
2703a3316fc6SZhikuiRen             }
2704a3316fc6SZhikuiRen         }
2705a3316fc6SZhikuiRen 
2706a3316fc6SZhikuiRen         // add to AsyncResp
2707a3316fc6SZhikuiRen         logEntryArray.push_back({});
2708a3316fc6SZhikuiRen         nlohmann::json &bmcLogEntry = logEntryArray.back();
2709a3316fc6SZhikuiRen         bmcLogEntry = {
2710a3316fc6SZhikuiRen             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2711a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"},
2712a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
2713a3316fc6SZhikuiRen                           "PostCodes/Entries/" +
2714a3316fc6SZhikuiRen                               postcodeEntryID},
2715a3316fc6SZhikuiRen             {"Name", "POST Code Log Entry"},
2716a3316fc6SZhikuiRen             {"Id", postcodeEntryID},
2717a3316fc6SZhikuiRen             {"Message", std::move(msg)},
2718a3316fc6SZhikuiRen             {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"},
2719a3316fc6SZhikuiRen             {"MessageArgs", std::move(messageArgs)},
2720a3316fc6SZhikuiRen             {"EntryType", "Event"},
2721a3316fc6SZhikuiRen             {"Severity", std::move(severity)},
2722a3316fc6SZhikuiRen             {"Created", std::move(entryTimeStr)}};
2723a3316fc6SZhikuiRen     }
2724a3316fc6SZhikuiRen }
2725a3316fc6SZhikuiRen 
2726a3316fc6SZhikuiRen static void getPostCodeForEntry(std::shared_ptr<AsyncResp> aResp,
2727a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
2728a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
2729a3316fc6SZhikuiRen {
2730a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
2731a3316fc6SZhikuiRen         [aResp, bootIndex, codeIndex](
2732a3316fc6SZhikuiRen             const boost::system::error_code ec,
2733a3316fc6SZhikuiRen             const boost::container::flat_map<uint64_t, uint64_t> &postcode) {
2734a3316fc6SZhikuiRen             if (ec)
2735a3316fc6SZhikuiRen             {
2736a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
2737a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2738a3316fc6SZhikuiRen                 return;
2739a3316fc6SZhikuiRen             }
2740a3316fc6SZhikuiRen 
2741a3316fc6SZhikuiRen             // skip the empty postcode boots
2742a3316fc6SZhikuiRen             if (postcode.empty())
2743a3316fc6SZhikuiRen             {
2744a3316fc6SZhikuiRen                 return;
2745a3316fc6SZhikuiRen             }
2746a3316fc6SZhikuiRen 
2747a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
2748a3316fc6SZhikuiRen 
2749a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
2750a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
2751a3316fc6SZhikuiRen         },
2752a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
2753a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
2754a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
2755a3316fc6SZhikuiRen         bootIndex);
2756a3316fc6SZhikuiRen }
2757a3316fc6SZhikuiRen 
2758a3316fc6SZhikuiRen static void getPostCodeForBoot(std::shared_ptr<AsyncResp> aResp,
2759a3316fc6SZhikuiRen                                const uint16_t bootIndex,
2760a3316fc6SZhikuiRen                                const uint16_t bootCount,
2761a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
2762a3316fc6SZhikuiRen                                const uint64_t top)
2763a3316fc6SZhikuiRen {
2764a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
2765a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
2766a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
2767a3316fc6SZhikuiRen               const boost::container::flat_map<uint64_t, uint64_t> &postcode) {
2768a3316fc6SZhikuiRen             if (ec)
2769a3316fc6SZhikuiRen             {
2770a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
2771a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2772a3316fc6SZhikuiRen                 return;
2773a3316fc6SZhikuiRen             }
2774a3316fc6SZhikuiRen 
2775a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
2776a3316fc6SZhikuiRen             if (!postcode.empty())
2777a3316fc6SZhikuiRen             {
2778a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
2779a3316fc6SZhikuiRen 
2780a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
2781a3316fc6SZhikuiRen                 {
2782a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
2783a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
2784a3316fc6SZhikuiRen                     uint64_t thisBootTop =
2785a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
2786a3316fc6SZhikuiRen 
2787a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
2788a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
2789a3316fc6SZhikuiRen                 }
2790a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
2791a3316fc6SZhikuiRen             }
2792a3316fc6SZhikuiRen 
2793a3316fc6SZhikuiRen             // continue to previous bootIndex
2794a3316fc6SZhikuiRen             if (bootIndex < bootCount)
2795a3316fc6SZhikuiRen             {
2796a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
2797a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
2798a3316fc6SZhikuiRen             }
2799a3316fc6SZhikuiRen             else
2800a3316fc6SZhikuiRen             {
2801a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
2802a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
2803a3316fc6SZhikuiRen                     "Entries?$skip=" +
2804a3316fc6SZhikuiRen                     std::to_string(skip + top);
2805a3316fc6SZhikuiRen             }
2806a3316fc6SZhikuiRen         },
2807a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
2808a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
2809a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
2810a3316fc6SZhikuiRen         bootIndex);
2811a3316fc6SZhikuiRen }
2812a3316fc6SZhikuiRen 
2813a3316fc6SZhikuiRen static void getCurrentBootNumber(std::shared_ptr<AsyncResp> aResp,
2814a3316fc6SZhikuiRen                                  const uint64_t skip, const uint64_t top)
2815a3316fc6SZhikuiRen {
2816a3316fc6SZhikuiRen     uint64_t entryCount = 0;
2817a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
2818a3316fc6SZhikuiRen         [aResp, entryCount, skip,
2819a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
2820a3316fc6SZhikuiRen               const std::variant<uint16_t> &bootCount) {
2821a3316fc6SZhikuiRen             if (ec)
2822a3316fc6SZhikuiRen             {
2823a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
2824a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2825a3316fc6SZhikuiRen                 return;
2826a3316fc6SZhikuiRen             }
2827a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
2828a3316fc6SZhikuiRen             if (pVal)
2829a3316fc6SZhikuiRen             {
2830a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
2831a3316fc6SZhikuiRen             }
2832a3316fc6SZhikuiRen             else
2833a3316fc6SZhikuiRen             {
2834a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
2835a3316fc6SZhikuiRen             }
2836a3316fc6SZhikuiRen         },
2837a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
2838a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
2839a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
2840a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
2841a3316fc6SZhikuiRen }
2842a3316fc6SZhikuiRen 
2843a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node
2844a3316fc6SZhikuiRen {
2845a3316fc6SZhikuiRen   public:
2846a3316fc6SZhikuiRen     template <typename CrowApp>
2847a3316fc6SZhikuiRen     PostCodesEntryCollection(CrowApp &app) :
2848a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
2849a3316fc6SZhikuiRen     {
2850a3316fc6SZhikuiRen         entityPrivileges = {
2851a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2852a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
2853a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2854a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2855a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2856a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2857a3316fc6SZhikuiRen     }
2858a3316fc6SZhikuiRen 
2859a3316fc6SZhikuiRen   private:
2860a3316fc6SZhikuiRen     void doGet(crow::Response &res, const crow::Request &req,
2861a3316fc6SZhikuiRen                const std::vector<std::string> &params) override
2862a3316fc6SZhikuiRen     {
2863a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2864a3316fc6SZhikuiRen 
2865a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
2866a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
2867a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
2868a3316fc6SZhikuiRen             "/redfish/v1/"
2869a3316fc6SZhikuiRen             "$metadata#LogEntryCollection.LogEntryCollection";
2870a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
2871a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
2872a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
2873a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
2874a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
2875a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
2876a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
2877a3316fc6SZhikuiRen 
2878a3316fc6SZhikuiRen         uint64_t skip = 0;
2879a3316fc6SZhikuiRen         uint64_t top = maxEntriesPerPage; // Show max entries by default
2880a3316fc6SZhikuiRen         if (!getSkipParam(asyncResp->res, req, skip))
2881a3316fc6SZhikuiRen         {
2882a3316fc6SZhikuiRen             return;
2883a3316fc6SZhikuiRen         }
2884a3316fc6SZhikuiRen         if (!getTopParam(asyncResp->res, req, top))
2885a3316fc6SZhikuiRen         {
2886a3316fc6SZhikuiRen             return;
2887a3316fc6SZhikuiRen         }
2888a3316fc6SZhikuiRen         getCurrentBootNumber(asyncResp, skip, top);
2889a3316fc6SZhikuiRen     }
2890a3316fc6SZhikuiRen };
2891a3316fc6SZhikuiRen 
2892a3316fc6SZhikuiRen class PostCodesEntry : public Node
2893a3316fc6SZhikuiRen {
2894a3316fc6SZhikuiRen   public:
2895a3316fc6SZhikuiRen     PostCodesEntry(CrowApp &app) :
2896a3316fc6SZhikuiRen         Node(app,
2897a3316fc6SZhikuiRen              "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/",
2898a3316fc6SZhikuiRen              std::string())
2899a3316fc6SZhikuiRen     {
2900a3316fc6SZhikuiRen         entityPrivileges = {
2901a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2902a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
2903a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2904a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2905a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2906a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2907a3316fc6SZhikuiRen     }
2908a3316fc6SZhikuiRen 
2909a3316fc6SZhikuiRen   private:
2910a3316fc6SZhikuiRen     void doGet(crow::Response &res, const crow::Request &req,
2911a3316fc6SZhikuiRen                const std::vector<std::string> &params) override
2912a3316fc6SZhikuiRen     {
2913a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2914a3316fc6SZhikuiRen         if (params.size() != 1)
2915a3316fc6SZhikuiRen         {
2916a3316fc6SZhikuiRen             messages::internalError(asyncResp->res);
2917a3316fc6SZhikuiRen             return;
2918a3316fc6SZhikuiRen         }
2919a3316fc6SZhikuiRen 
2920a3316fc6SZhikuiRen         const std::string &targetID = params[0];
2921a3316fc6SZhikuiRen 
2922a3316fc6SZhikuiRen         size_t bootPos = targetID.find('B');
2923a3316fc6SZhikuiRen         if (bootPos == std::string::npos)
2924a3316fc6SZhikuiRen         {
2925a3316fc6SZhikuiRen             // Requested ID was not found
2926a3316fc6SZhikuiRen             messages::resourceMissingAtURI(asyncResp->res, targetID);
2927a3316fc6SZhikuiRen             return;
2928a3316fc6SZhikuiRen         }
2929a3316fc6SZhikuiRen         std::string_view bootIndexStr(targetID);
2930a3316fc6SZhikuiRen         bootIndexStr.remove_prefix(bootPos + 1);
2931a3316fc6SZhikuiRen         uint16_t bootIndex = 0;
2932a3316fc6SZhikuiRen         uint64_t codeIndex = 0;
2933a3316fc6SZhikuiRen         size_t dashPos = bootIndexStr.find('-');
2934a3316fc6SZhikuiRen 
2935a3316fc6SZhikuiRen         if (dashPos == std::string::npos)
2936a3316fc6SZhikuiRen         {
2937a3316fc6SZhikuiRen             return;
2938a3316fc6SZhikuiRen         }
2939a3316fc6SZhikuiRen         std::string_view codeIndexStr(bootIndexStr);
2940a3316fc6SZhikuiRen         bootIndexStr.remove_suffix(dashPos);
2941a3316fc6SZhikuiRen         codeIndexStr.remove_prefix(dashPos + 1);
2942a3316fc6SZhikuiRen 
2943a3316fc6SZhikuiRen         bootIndex = static_cast<uint16_t>(
2944a3316fc6SZhikuiRen             strtoul(std::string(bootIndexStr).c_str(), NULL, 0));
2945a3316fc6SZhikuiRen         codeIndex = strtoul(std::string(codeIndexStr).c_str(), NULL, 0);
2946a3316fc6SZhikuiRen         if (bootIndex == 0 || codeIndex == 0)
2947a3316fc6SZhikuiRen         {
2948a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
2949a3316fc6SZhikuiRen                              << params[0];
2950a3316fc6SZhikuiRen         }
2951a3316fc6SZhikuiRen 
2952a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
2953a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
2954a3316fc6SZhikuiRen             "/redfish/v1/$metadata#LogEntry.LogEntry";
2955a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
2956a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/"
2957a3316fc6SZhikuiRen             "Entries";
2958a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
2959a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
2960a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
2961a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
2962a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
2963a3316fc6SZhikuiRen 
2964a3316fc6SZhikuiRen         getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
2965a3316fc6SZhikuiRen     }
2966a3316fc6SZhikuiRen };
2967a3316fc6SZhikuiRen 
29681da66f75SEd Tanous } // namespace redfish
2969