xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision 1214b7e7d921e331fb1480c7e5d579ffa5811cda)
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>
32*1214b7e7SGunnar Mills 
334418c7f0SJames Feist #include <filesystem>
34cd225da8SJason M. Bills #include <string_view>
35abf2add6SEd Tanous #include <variant>
361da66f75SEd Tanous 
371da66f75SEd Tanous namespace redfish
381da66f75SEd Tanous {
391da66f75SEd Tanous 
405b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump";
415b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump";
425b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandPath = "/com/intel/crashdump/OnDemand";
435b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump";
445b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
455b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
465b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
47424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
485b61b5e8SJason M. Bills constexpr char const* crashdumpRawPECIInterface =
49424c4176SJason M. Bills     "com.intel.crashdump.SendRawPeci";
501da66f75SEd Tanous 
514851d45dSJason M. Bills namespace message_registries
524851d45dSJason M. Bills {
534851d45dSJason M. Bills static const Message* getMessageFromRegistry(
544851d45dSJason M. Bills     const std::string& messageKey,
554851d45dSJason M. Bills     const boost::beast::span<const MessageEntry> registry)
564851d45dSJason M. Bills {
574851d45dSJason M. Bills     boost::beast::span<const MessageEntry>::const_iterator messageIt =
584851d45dSJason M. Bills         std::find_if(registry.cbegin(), registry.cend(),
594851d45dSJason M. Bills                      [&messageKey](const MessageEntry& messageEntry) {
604851d45dSJason M. Bills                          return !std::strcmp(messageEntry.first,
614851d45dSJason M. Bills                                              messageKey.c_str());
624851d45dSJason M. Bills                      });
634851d45dSJason M. Bills     if (messageIt != registry.cend())
644851d45dSJason M. Bills     {
654851d45dSJason M. Bills         return &messageIt->second;
664851d45dSJason M. Bills     }
674851d45dSJason M. Bills 
684851d45dSJason M. Bills     return nullptr;
694851d45dSJason M. Bills }
704851d45dSJason M. Bills 
714851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
724851d45dSJason M. Bills {
734851d45dSJason M. Bills     // Redfish MessageIds are in the form
744851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
754851d45dSJason M. Bills     // the right Message
764851d45dSJason M. Bills     std::vector<std::string> fields;
774851d45dSJason M. Bills     fields.reserve(4);
784851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
794851d45dSJason M. Bills     std::string& registryName = fields[0];
804851d45dSJason M. Bills     std::string& messageKey = fields[3];
814851d45dSJason M. Bills 
824851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
834851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
844851d45dSJason M. Bills     {
854851d45dSJason M. Bills         return getMessageFromRegistry(
864851d45dSJason M. Bills             messageKey, boost::beast::span<const MessageEntry>(base::registry));
874851d45dSJason M. Bills     }
884851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
894851d45dSJason M. Bills     {
904851d45dSJason M. Bills         return getMessageFromRegistry(
914851d45dSJason M. Bills             messageKey,
924851d45dSJason M. Bills             boost::beast::span<const MessageEntry>(openbmc::registry));
934851d45dSJason M. Bills     }
944851d45dSJason M. Bills     return nullptr;
954851d45dSJason M. Bills }
964851d45dSJason M. Bills } // namespace message_registries
974851d45dSJason M. Bills 
98f6150403SJames Feist namespace fs = std::filesystem;
991da66f75SEd Tanous 
100cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map<
10119bd78d9SPatrick Williams     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
102cb92c03bSAndrew Geissler                               int32_t, uint32_t, int64_t, uint64_t, double>>;
103cb92c03bSAndrew Geissler 
104cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map<
105cb92c03bSAndrew Geissler     sdbusplus::message::object_path,
106cb92c03bSAndrew Geissler     boost::container::flat_map<std::string, GetManagedPropertyType>>;
107cb92c03bSAndrew Geissler 
108cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
109cb92c03bSAndrew Geissler {
110cb92c03bSAndrew Geissler     if (s == "xyz.openbmc_project.Logging.Entry.Level.Alert")
111cb92c03bSAndrew Geissler     {
112cb92c03bSAndrew Geissler         return "Critical";
113cb92c03bSAndrew Geissler     }
114cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Critical")
115cb92c03bSAndrew Geissler     {
116cb92c03bSAndrew Geissler         return "Critical";
117cb92c03bSAndrew Geissler     }
118cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Debug")
119cb92c03bSAndrew Geissler     {
120cb92c03bSAndrew Geissler         return "OK";
121cb92c03bSAndrew Geissler     }
122cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency")
123cb92c03bSAndrew Geissler     {
124cb92c03bSAndrew Geissler         return "Critical";
125cb92c03bSAndrew Geissler     }
126cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Error")
127cb92c03bSAndrew Geissler     {
128cb92c03bSAndrew Geissler         return "Critical";
129cb92c03bSAndrew Geissler     }
130cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Informational")
131cb92c03bSAndrew Geissler     {
132cb92c03bSAndrew Geissler         return "OK";
133cb92c03bSAndrew Geissler     }
134cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")
135cb92c03bSAndrew Geissler     {
136cb92c03bSAndrew Geissler         return "OK";
137cb92c03bSAndrew Geissler     }
138cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
139cb92c03bSAndrew Geissler     {
140cb92c03bSAndrew Geissler         return "Warning";
141cb92c03bSAndrew Geissler     }
142cb92c03bSAndrew Geissler     return "";
143cb92c03bSAndrew Geissler }
144cb92c03bSAndrew Geissler 
145c9bb6861Sraviteja-b inline void deleteSystemDumpEntry(crow::Response& res,
146c9bb6861Sraviteja-b                                   const std::string& entryID)
147c9bb6861Sraviteja-b {
148c9bb6861Sraviteja-b     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
149c9bb6861Sraviteja-b 
150c9bb6861Sraviteja-b     auto respHandler = [asyncResp](const boost::system::error_code ec) {
151c9bb6861Sraviteja-b         BMCWEB_LOG_DEBUG << "System Dump Entry doDelete callback: Done";
152c9bb6861Sraviteja-b         if (ec)
153c9bb6861Sraviteja-b         {
154c9bb6861Sraviteja-b             BMCWEB_LOG_ERROR
155c9bb6861Sraviteja-b                 << "System Dump (DBus) doDelete respHandler got error " << ec;
156c9bb6861Sraviteja-b             asyncResp->res.result(
157c9bb6861Sraviteja-b                 boost::beast::http::status::internal_server_error);
158c9bb6861Sraviteja-b             return;
159c9bb6861Sraviteja-b         }
160c9bb6861Sraviteja-b     };
161c9bb6861Sraviteja-b     crow::connections::systemBus->async_method_call(
162c9bb6861Sraviteja-b         respHandler, "xyz.openbmc_project.Dump.Manager",
163c9bb6861Sraviteja-b         "/xyz/openbmc_project/dump/entry/" + entryID,
164c9bb6861Sraviteja-b         "xyz.openbmc_project.Object.Delete", "Delete");
165c9bb6861Sraviteja-b }
166c9bb6861Sraviteja-b 
16716428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
16839e77504SEd Tanous                               const std::string_view& field,
16939e77504SEd Tanous                               std::string_view& contents)
17016428a1aSJason M. Bills {
17116428a1aSJason M. Bills     const char* data = nullptr;
17216428a1aSJason M. Bills     size_t length = 0;
17316428a1aSJason M. Bills     int ret = 0;
17416428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
175271584abSEd Tanous     ret = sd_journal_get_data(journal, field.data(),
176271584abSEd Tanous                               reinterpret_cast<const void**>(&data), &length);
17716428a1aSJason M. Bills     if (ret < 0)
17816428a1aSJason M. Bills     {
17916428a1aSJason M. Bills         return ret;
18016428a1aSJason M. Bills     }
18139e77504SEd Tanous     contents = std::string_view(data, length);
18216428a1aSJason M. Bills     // Only use the content after the "=" character.
18316428a1aSJason M. Bills     contents.remove_prefix(std::min(contents.find("=") + 1, contents.size()));
18416428a1aSJason M. Bills     return ret;
18516428a1aSJason M. Bills }
18616428a1aSJason M. Bills 
18716428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
18839e77504SEd Tanous                               const std::string_view& field, const int& base,
189271584abSEd Tanous                               long int& contents)
19016428a1aSJason M. Bills {
19116428a1aSJason M. Bills     int ret = 0;
19239e77504SEd Tanous     std::string_view metadata;
19316428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
19416428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
19516428a1aSJason M. Bills     if (ret < 0)
19616428a1aSJason M. Bills     {
19716428a1aSJason M. Bills         return ret;
19816428a1aSJason M. Bills     }
199b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
20016428a1aSJason M. Bills     return ret;
20116428a1aSJason M. Bills }
20216428a1aSJason M. Bills 
203a3316fc6SZhikuiRen static bool getTimestampStr(const uint64_t usecSinceEpoch,
204a3316fc6SZhikuiRen                             std::string& entryTimestamp)
20516428a1aSJason M. Bills {
206a3316fc6SZhikuiRen     time_t t = static_cast<time_t>(usecSinceEpoch / 1000 / 1000);
20716428a1aSJason M. Bills     struct tm* loctime = localtime(&t);
20816428a1aSJason M. Bills     char entryTime[64] = {};
20999131cd0SEd Tanous     if (nullptr != loctime)
21016428a1aSJason M. Bills     {
21116428a1aSJason M. Bills         strftime(entryTime, sizeof(entryTime), "%FT%T%z", loctime);
21216428a1aSJason M. Bills     }
21316428a1aSJason M. Bills     // Insert the ':' into the timezone
21439e77504SEd Tanous     std::string_view t1(entryTime);
21539e77504SEd Tanous     std::string_view t2(entryTime);
21616428a1aSJason M. Bills     if (t1.size() > 2 && t2.size() > 2)
21716428a1aSJason M. Bills     {
21816428a1aSJason M. Bills         t1.remove_suffix(2);
21916428a1aSJason M. Bills         t2.remove_prefix(t2.size() - 2);
22016428a1aSJason M. Bills     }
22139e77504SEd Tanous     entryTimestamp = std::string(t1) + ":" + std::string(t2);
22216428a1aSJason M. Bills     return true;
22316428a1aSJason M. Bills }
22416428a1aSJason M. Bills 
225a3316fc6SZhikuiRen static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp)
226a3316fc6SZhikuiRen {
227a3316fc6SZhikuiRen     int ret = 0;
228a3316fc6SZhikuiRen     uint64_t timestamp = 0;
229a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
230a3316fc6SZhikuiRen     if (ret < 0)
231a3316fc6SZhikuiRen     {
232a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
233a3316fc6SZhikuiRen                          << strerror(-ret);
234a3316fc6SZhikuiRen         return false;
235a3316fc6SZhikuiRen     }
236a3316fc6SZhikuiRen     return getTimestampStr(timestamp, entryTimestamp);
237a3316fc6SZhikuiRen }
238a3316fc6SZhikuiRen 
23916428a1aSJason M. Bills static bool getSkipParam(crow::Response& res, const crow::Request& req,
240271584abSEd Tanous                          uint64_t& skip)
24116428a1aSJason M. Bills {
24216428a1aSJason M. Bills     char* skipParam = req.urlParams.get("$skip");
24316428a1aSJason M. Bills     if (skipParam != nullptr)
24416428a1aSJason M. Bills     {
24516428a1aSJason M. Bills         char* ptr = nullptr;
246271584abSEd Tanous         skip = std::strtoul(skipParam, &ptr, 10);
24716428a1aSJason M. Bills         if (*skipParam == '\0' || *ptr != '\0')
24816428a1aSJason M. Bills         {
24916428a1aSJason M. Bills 
25016428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(skipParam),
25116428a1aSJason M. Bills                                                    "$skip");
25216428a1aSJason M. Bills             return false;
25316428a1aSJason M. Bills         }
25416428a1aSJason M. Bills     }
25516428a1aSJason M. Bills     return true;
25616428a1aSJason M. Bills }
25716428a1aSJason M. Bills 
258271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
25916428a1aSJason M. Bills static bool getTopParam(crow::Response& res, const crow::Request& req,
260271584abSEd Tanous                         uint64_t& top)
26116428a1aSJason M. Bills {
26216428a1aSJason M. Bills     char* topParam = req.urlParams.get("$top");
26316428a1aSJason M. Bills     if (topParam != nullptr)
26416428a1aSJason M. Bills     {
26516428a1aSJason M. Bills         char* ptr = nullptr;
266271584abSEd Tanous         top = std::strtoul(topParam, &ptr, 10);
26716428a1aSJason M. Bills         if (*topParam == '\0' || *ptr != '\0')
26816428a1aSJason M. Bills         {
26916428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(topParam),
27016428a1aSJason M. Bills                                                    "$top");
27116428a1aSJason M. Bills             return false;
27216428a1aSJason M. Bills         }
273271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
27416428a1aSJason M. Bills         {
27516428a1aSJason M. Bills 
27616428a1aSJason M. Bills             messages::queryParameterOutOfRange(
27716428a1aSJason M. Bills                 res, std::to_string(top), "$top",
27816428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
27916428a1aSJason M. Bills             return false;
28016428a1aSJason M. Bills         }
28116428a1aSJason M. Bills     }
28216428a1aSJason M. Bills     return true;
28316428a1aSJason M. Bills }
28416428a1aSJason M. Bills 
285e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
286e85d6b16SJason M. Bills                              const bool firstEntry = true)
28716428a1aSJason M. Bills {
28816428a1aSJason M. Bills     int ret = 0;
28916428a1aSJason M. Bills     static uint64_t prevTs = 0;
29016428a1aSJason M. Bills     static int index = 0;
291e85d6b16SJason M. Bills     if (firstEntry)
292e85d6b16SJason M. Bills     {
293e85d6b16SJason M. Bills         prevTs = 0;
294e85d6b16SJason M. Bills     }
295e85d6b16SJason M. Bills 
29616428a1aSJason M. Bills     // Get the entry timestamp
29716428a1aSJason M. Bills     uint64_t curTs = 0;
29816428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
29916428a1aSJason M. Bills     if (ret < 0)
30016428a1aSJason M. Bills     {
30116428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
30216428a1aSJason M. Bills                          << strerror(-ret);
30316428a1aSJason M. Bills         return false;
30416428a1aSJason M. Bills     }
30516428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
30616428a1aSJason M. Bills     if (curTs == prevTs)
30716428a1aSJason M. Bills     {
30816428a1aSJason M. Bills         index++;
30916428a1aSJason M. Bills     }
31016428a1aSJason M. Bills     else
31116428a1aSJason M. Bills     {
31216428a1aSJason M. Bills         // Otherwise, reset it
31316428a1aSJason M. Bills         index = 0;
31416428a1aSJason M. Bills     }
31516428a1aSJason M. Bills     // Save the timestamp
31616428a1aSJason M. Bills     prevTs = curTs;
31716428a1aSJason M. Bills 
31816428a1aSJason M. Bills     entryID = std::to_string(curTs);
31916428a1aSJason M. Bills     if (index > 0)
32016428a1aSJason M. Bills     {
32116428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
32216428a1aSJason M. Bills     }
32316428a1aSJason M. Bills     return true;
32416428a1aSJason M. Bills }
32516428a1aSJason M. Bills 
326e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
327e85d6b16SJason M. Bills                              const bool firstEntry = true)
32895820184SJason M. Bills {
329271584abSEd Tanous     static time_t prevTs = 0;
33095820184SJason M. Bills     static int index = 0;
331e85d6b16SJason M. Bills     if (firstEntry)
332e85d6b16SJason M. Bills     {
333e85d6b16SJason M. Bills         prevTs = 0;
334e85d6b16SJason M. Bills     }
335e85d6b16SJason M. Bills 
33695820184SJason M. Bills     // Get the entry timestamp
337271584abSEd Tanous     std::time_t curTs = 0;
33895820184SJason M. Bills     std::tm timeStruct = {};
33995820184SJason M. Bills     std::istringstream entryStream(logEntry);
34095820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
34195820184SJason M. Bills     {
34295820184SJason M. Bills         curTs = std::mktime(&timeStruct);
34395820184SJason M. Bills     }
34495820184SJason M. Bills     // If the timestamp isn't unique, increment the index
34595820184SJason M. Bills     if (curTs == prevTs)
34695820184SJason M. Bills     {
34795820184SJason M. Bills         index++;
34895820184SJason M. Bills     }
34995820184SJason M. Bills     else
35095820184SJason M. Bills     {
35195820184SJason M. Bills         // Otherwise, reset it
35295820184SJason M. Bills         index = 0;
35395820184SJason M. Bills     }
35495820184SJason M. Bills     // Save the timestamp
35595820184SJason M. Bills     prevTs = curTs;
35695820184SJason M. Bills 
35795820184SJason M. Bills     entryID = std::to_string(curTs);
35895820184SJason M. Bills     if (index > 0)
35995820184SJason M. Bills     {
36095820184SJason M. Bills         entryID += "_" + std::to_string(index);
36195820184SJason M. Bills     }
36295820184SJason M. Bills     return true;
36395820184SJason M. Bills }
36495820184SJason M. Bills 
36516428a1aSJason M. Bills static bool getTimestampFromID(crow::Response& res, const std::string& entryID,
366271584abSEd Tanous                                uint64_t& timestamp, uint64_t& index)
36716428a1aSJason M. Bills {
36816428a1aSJason M. Bills     if (entryID.empty())
36916428a1aSJason M. Bills     {
37016428a1aSJason M. Bills         return false;
37116428a1aSJason M. Bills     }
37216428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
37339e77504SEd Tanous     std::string_view tsStr(entryID);
37416428a1aSJason M. Bills 
37516428a1aSJason M. Bills     auto underscorePos = tsStr.find("_");
37616428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
37716428a1aSJason M. Bills     {
37816428a1aSJason M. Bills         // Timestamp has an index
37916428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
38039e77504SEd Tanous         std::string_view indexStr(entryID);
38116428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
38216428a1aSJason M. Bills         std::size_t pos;
38316428a1aSJason M. Bills         try
38416428a1aSJason M. Bills         {
38539e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
38616428a1aSJason M. Bills         }
387271584abSEd Tanous         catch (std::invalid_argument&)
38816428a1aSJason M. Bills         {
38916428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
39016428a1aSJason M. Bills             return false;
39116428a1aSJason M. Bills         }
392271584abSEd Tanous         catch (std::out_of_range&)
39316428a1aSJason M. Bills         {
39416428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
39516428a1aSJason M. Bills             return false;
39616428a1aSJason M. Bills         }
39716428a1aSJason M. Bills         if (pos != indexStr.size())
39816428a1aSJason M. Bills         {
39916428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
40016428a1aSJason M. Bills             return false;
40116428a1aSJason M. Bills         }
40216428a1aSJason M. Bills     }
40316428a1aSJason M. Bills     // Timestamp has no index
40416428a1aSJason M. Bills     std::size_t pos;
40516428a1aSJason M. Bills     try
40616428a1aSJason M. Bills     {
40739e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
40816428a1aSJason M. Bills     }
409271584abSEd Tanous     catch (std::invalid_argument&)
41016428a1aSJason M. Bills     {
41116428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
41216428a1aSJason M. Bills         return false;
41316428a1aSJason M. Bills     }
414271584abSEd Tanous     catch (std::out_of_range&)
41516428a1aSJason M. Bills     {
41616428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
41716428a1aSJason M. Bills         return false;
41816428a1aSJason M. Bills     }
41916428a1aSJason M. Bills     if (pos != tsStr.size())
42016428a1aSJason M. Bills     {
42116428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
42216428a1aSJason M. Bills         return false;
42316428a1aSJason M. Bills     }
42416428a1aSJason M. Bills     return true;
42516428a1aSJason M. Bills }
42616428a1aSJason M. Bills 
42795820184SJason M. Bills static bool
42895820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
42995820184SJason M. Bills {
43095820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
43195820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
43295820184SJason M. Bills 
43395820184SJason M. Bills     // Loop through the directory looking for redfish log files
43495820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
43595820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
43695820184SJason M. Bills     {
43795820184SJason M. Bills         // If we find a redfish log file, save the path
43895820184SJason M. Bills         std::string filename = dirEnt.path().filename();
43995820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
44095820184SJason M. Bills         {
44195820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
44295820184SJason M. Bills         }
44395820184SJason M. Bills     }
44495820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
44595820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
44695820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
44795820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
44895820184SJason M. Bills 
44995820184SJason M. Bills     return !redfishLogFiles.empty();
45095820184SJason M. Bills }
45195820184SJason M. Bills 
452043a0536SJohnathan Mantey static void ParseCrashdumpParameters(
453043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>>& params,
454043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
455043a0536SJohnathan Mantey {
456043a0536SJohnathan Mantey     for (auto property : params)
457043a0536SJohnathan Mantey     {
458043a0536SJohnathan Mantey         if (property.first == "Timestamp")
459043a0536SJohnathan Mantey         {
460043a0536SJohnathan Mantey             const std::string* value =
4618d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
462043a0536SJohnathan Mantey             if (value != nullptr)
463043a0536SJohnathan Mantey             {
464043a0536SJohnathan Mantey                 timestamp = *value;
465043a0536SJohnathan Mantey             }
466043a0536SJohnathan Mantey         }
467043a0536SJohnathan Mantey         else if (property.first == "Filename")
468043a0536SJohnathan Mantey         {
469043a0536SJohnathan Mantey             const std::string* value =
4708d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
471043a0536SJohnathan Mantey             if (value != nullptr)
472043a0536SJohnathan Mantey             {
473043a0536SJohnathan Mantey                 filename = *value;
474043a0536SJohnathan Mantey             }
475043a0536SJohnathan Mantey         }
476043a0536SJohnathan Mantey         else if (property.first == "Log")
477043a0536SJohnathan Mantey         {
478043a0536SJohnathan Mantey             const std::string* value =
4798d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
480043a0536SJohnathan Mantey             if (value != nullptr)
481043a0536SJohnathan Mantey             {
482043a0536SJohnathan Mantey                 logfile = *value;
483043a0536SJohnathan Mantey             }
484043a0536SJohnathan Mantey         }
485043a0536SJohnathan Mantey     }
486043a0536SJohnathan Mantey }
487043a0536SJohnathan Mantey 
488a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
489c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node
4901da66f75SEd Tanous {
4911da66f75SEd Tanous   public:
4921da66f75SEd Tanous     template <typename CrowApp>
493c4bf6374SJason M. Bills     SystemLogServiceCollection(CrowApp& app) :
494029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/")
495c4bf6374SJason M. Bills     {
496c4bf6374SJason M. Bills         entityPrivileges = {
497c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
498c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
499c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
500c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
501c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
502c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
503c4bf6374SJason M. Bills     }
504c4bf6374SJason M. Bills 
505c4bf6374SJason M. Bills   private:
506c4bf6374SJason M. Bills     /**
507c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
508c4bf6374SJason M. Bills      */
509c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
510c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
511c4bf6374SJason M. Bills     {
512c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
513c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
514c4bf6374SJason M. Bills         // it has a duplicate entry for members
515c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
516c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
517c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
518029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
519c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
520c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
521c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
522c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
523c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
524029573d4SEd Tanous         logServiceArray.push_back(
525029573d4SEd Tanous             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}});
526c9bb6861Sraviteja-b #ifdef BMCWEB_ENABLE_REDFISH_SYSTEMDUMP_LOG
527c9bb6861Sraviteja-b         logServiceArray.push_back(
528c9bb6861Sraviteja-b             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/System"}});
529c9bb6861Sraviteja-b #endif
530c9bb6861Sraviteja-b 
531d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
532d53dd41fSJason M. Bills         logServiceArray.push_back(
533cb92c03bSAndrew Geissler             {{"@odata.id",
534424c4176SJason M. Bills               "/redfish/v1/Systems/system/LogServices/Crashdump"}});
535d53dd41fSJason M. Bills #endif
536c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
537c4bf6374SJason M. Bills             logServiceArray.size();
538a3316fc6SZhikuiRen 
539a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
540a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec,
541a3316fc6SZhikuiRen                         const std::vector<std::string>& subtreePath) {
542a3316fc6SZhikuiRen                 if (ec)
543a3316fc6SZhikuiRen                 {
544a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR << ec;
545a3316fc6SZhikuiRen                     return;
546a3316fc6SZhikuiRen                 }
547a3316fc6SZhikuiRen 
548a3316fc6SZhikuiRen                 for (auto& pathStr : subtreePath)
549a3316fc6SZhikuiRen                 {
550a3316fc6SZhikuiRen                     if (pathStr.find("PostCode") != std::string::npos)
551a3316fc6SZhikuiRen                     {
552a3316fc6SZhikuiRen                         nlohmann::json& logServiceArray =
553a3316fc6SZhikuiRen                             asyncResp->res.jsonValue["Members"];
554a3316fc6SZhikuiRen                         logServiceArray.push_back(
555a3316fc6SZhikuiRen                             {{"@odata.id", "/redfish/v1/Systems/system/"
556a3316fc6SZhikuiRen                                            "LogServices/PostCodes"}});
557a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members@odata.count"] =
558a3316fc6SZhikuiRen                             logServiceArray.size();
559a3316fc6SZhikuiRen                         return;
560a3316fc6SZhikuiRen                     }
561a3316fc6SZhikuiRen                 }
562a3316fc6SZhikuiRen             },
563a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper",
564a3316fc6SZhikuiRen             "/xyz/openbmc_project/object_mapper",
565a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
566a3316fc6SZhikuiRen             std::array<const char*, 1>{postCodeIface});
567c4bf6374SJason M. Bills     }
568c4bf6374SJason M. Bills };
569c4bf6374SJason M. Bills 
570c4bf6374SJason M. Bills class EventLogService : public Node
571c4bf6374SJason M. Bills {
572c4bf6374SJason M. Bills   public:
573c4bf6374SJason M. Bills     template <typename CrowApp>
574c4bf6374SJason M. Bills     EventLogService(CrowApp& app) :
575029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
576c4bf6374SJason M. Bills     {
577c4bf6374SJason M. Bills         entityPrivileges = {
578c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
579c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
580c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
581c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
582c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
583c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
584c4bf6374SJason M. Bills     }
585c4bf6374SJason M. Bills 
586c4bf6374SJason M. Bills   private:
587c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
588c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
589c4bf6374SJason M. Bills     {
590c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
591c4bf6374SJason M. Bills 
592c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
593029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
594c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
595c4bf6374SJason M. Bills             "#LogService.v1_1_0.LogService";
596c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
597c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
598c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
599c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
600c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
601c4bf6374SJason M. Bills             {"@odata.id",
602029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
603e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
604e7d6c8b2SGunnar Mills 
605e7d6c8b2SGunnar Mills             {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
606e7d6c8b2SGunnar Mills                        "Actions/LogService.ClearLog"}};
607489640c6SJason M. Bills     }
608489640c6SJason M. Bills };
609489640c6SJason M. Bills 
6101f56a3a6STim Lee class JournalEventLogClear : public Node
611489640c6SJason M. Bills {
612489640c6SJason M. Bills   public:
6131f56a3a6STim Lee     JournalEventLogClear(CrowApp& app) :
614489640c6SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
615489640c6SJason M. Bills                   "LogService.ClearLog/")
616489640c6SJason M. Bills     {
617489640c6SJason M. Bills         entityPrivileges = {
618489640c6SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
619489640c6SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
620489640c6SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
621489640c6SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
622489640c6SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
623489640c6SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
624489640c6SJason M. Bills     }
625489640c6SJason M. Bills 
626489640c6SJason M. Bills   private:
627489640c6SJason M. Bills     void doPost(crow::Response& res, const crow::Request& req,
628489640c6SJason M. Bills                 const std::vector<std::string>& params) override
629489640c6SJason M. Bills     {
630489640c6SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
631489640c6SJason M. Bills 
632489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
633489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
634489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
635489640c6SJason M. Bills         {
636489640c6SJason M. Bills             for (const std::filesystem::path& file : redfishLogFiles)
637489640c6SJason M. Bills             {
638489640c6SJason M. Bills                 std::error_code ec;
639489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
640489640c6SJason M. Bills             }
641489640c6SJason M. Bills         }
642489640c6SJason M. Bills 
643489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
644489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
645489640c6SJason M. Bills             [asyncResp](const boost::system::error_code ec) {
646489640c6SJason M. Bills                 if (ec)
647489640c6SJason M. Bills                 {
648489640c6SJason M. Bills                     BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
649489640c6SJason M. Bills                     messages::internalError(asyncResp->res);
650489640c6SJason M. Bills                     return;
651489640c6SJason M. Bills                 }
652489640c6SJason M. Bills 
653489640c6SJason M. Bills                 messages::success(asyncResp->res);
654489640c6SJason M. Bills             },
655489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
656489640c6SJason M. Bills             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
657489640c6SJason M. Bills             "replace");
658c4bf6374SJason M. Bills     }
659c4bf6374SJason M. Bills };
660c4bf6374SJason M. Bills 
66195820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
66295820184SJason M. Bills                                  const std::string logEntry,
66395820184SJason M. Bills                                  nlohmann::json& logEntryJson)
664c4bf6374SJason M. Bills {
66595820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
666cd225da8SJason M. Bills     // First get the Timestamp
667cd225da8SJason M. Bills     size_t space = logEntry.find_first_of(" ");
668cd225da8SJason M. Bills     if (space == std::string::npos)
66995820184SJason M. Bills     {
67095820184SJason M. Bills         return 1;
67195820184SJason M. Bills     }
672cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
673cd225da8SJason M. Bills     // Then get the log contents
674cd225da8SJason M. Bills     size_t entryStart = logEntry.find_first_not_of(" ", space);
675cd225da8SJason M. Bills     if (entryStart == std::string::npos)
676cd225da8SJason M. Bills     {
677cd225da8SJason M. Bills         return 1;
678cd225da8SJason M. Bills     }
679cd225da8SJason M. Bills     std::string_view entry(logEntry);
680cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
681cd225da8SJason M. Bills     // Use split to separate the entry into its fields
682cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
683cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
684cd225da8SJason M. Bills                  boost::token_compress_on);
685cd225da8SJason M. Bills     // We need at least a MessageId to be valid
686cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
687cd225da8SJason M. Bills     {
688cd225da8SJason M. Bills         return 1;
689cd225da8SJason M. Bills     }
690cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
69195820184SJason M. Bills 
6924851d45dSJason M. Bills     // Get the Message from the MessageRegistry
6934851d45dSJason M. Bills     const message_registries::Message* message =
6944851d45dSJason M. Bills         message_registries::getMessage(messageID);
695c4bf6374SJason M. Bills 
6964851d45dSJason M. Bills     std::string msg;
6974851d45dSJason M. Bills     std::string severity;
6984851d45dSJason M. Bills     if (message != nullptr)
699c4bf6374SJason M. Bills     {
7004851d45dSJason M. Bills         msg = message->message;
7014851d45dSJason M. Bills         severity = message->severity;
702c4bf6374SJason M. Bills     }
703c4bf6374SJason M. Bills 
70415a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
70515a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
70615a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
70715a86ff6SJason M. Bills     {
70815a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
70915a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
71015a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
71115a86ff6SJason M. Bills         if (!messageArgsStart.empty())
71215a86ff6SJason M. Bills         {
71315a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
71415a86ff6SJason M. Bills         }
71515a86ff6SJason M. Bills 
71615a86ff6SJason M. Bills         messageArgs = boost::beast::span(&messageArgsStart, messageArgsSize);
717c4bf6374SJason M. Bills 
7184851d45dSJason M. Bills         // Fill the MessageArgs into the Message
71995820184SJason M. Bills         int i = 0;
72095820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
7214851d45dSJason M. Bills         {
72295820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
7234851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
7244851d45dSJason M. Bills             if (argPos != std::string::npos)
7254851d45dSJason M. Bills             {
72695820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
7274851d45dSJason M. Bills             }
7284851d45dSJason M. Bills         }
72915a86ff6SJason M. Bills     }
7304851d45dSJason M. Bills 
73195820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
73295820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
73395820184SJason M. Bills     // between the '.' and the '+', so just remove them.
73495820184SJason M. Bills     std::size_t dot = timestamp.find_first_of(".");
73595820184SJason M. Bills     std::size_t plus = timestamp.find_first_of("+");
73695820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
737c4bf6374SJason M. Bills     {
73895820184SJason M. Bills         timestamp.erase(dot, plus - dot);
739c4bf6374SJason M. Bills     }
740c4bf6374SJason M. Bills 
741c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
74295820184SJason M. Bills     logEntryJson = {
743cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
744029573d4SEd Tanous         {"@odata.id",
745897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
74695820184SJason M. Bills              logEntryID},
747c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
74895820184SJason M. Bills         {"Id", logEntryID},
74995820184SJason M. Bills         {"Message", std::move(msg)},
75095820184SJason M. Bills         {"MessageId", std::move(messageID)},
751c4bf6374SJason M. Bills         {"MessageArgs", std::move(messageArgs)},
752c4bf6374SJason M. Bills         {"EntryType", "Event"},
75395820184SJason M. Bills         {"Severity", std::move(severity)},
75495820184SJason M. Bills         {"Created", std::move(timestamp)}};
755c4bf6374SJason M. Bills     return 0;
756c4bf6374SJason M. Bills }
757c4bf6374SJason M. Bills 
75827062605SAnthony Wilson class JournalEventLogEntryCollection : public Node
759c4bf6374SJason M. Bills {
760c4bf6374SJason M. Bills   public:
761c4bf6374SJason M. Bills     template <typename CrowApp>
76227062605SAnthony Wilson     JournalEventLogEntryCollection(CrowApp& app) :
763029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
764c4bf6374SJason M. Bills     {
765c4bf6374SJason M. Bills         entityPrivileges = {
766c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
767c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
768c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
769c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
770c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
771c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
772c4bf6374SJason M. Bills     }
773c4bf6374SJason M. Bills 
774c4bf6374SJason M. Bills   private:
775c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
776c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
777c4bf6374SJason M. Bills     {
778c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
779271584abSEd Tanous         uint64_t skip = 0;
780271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
781c4bf6374SJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
782c4bf6374SJason M. Bills         {
783c4bf6374SJason M. Bills             return;
784c4bf6374SJason M. Bills         }
785c4bf6374SJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
786c4bf6374SJason M. Bills         {
787c4bf6374SJason M. Bills             return;
788c4bf6374SJason M. Bills         }
789c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
790c4bf6374SJason M. Bills         // it has a duplicate entry for members
791c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
792c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
793c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
794029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
795c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
796c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
797c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
798cb92c03bSAndrew Geissler 
799c4bf6374SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
800c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
80195820184SJason M. Bills         // Go through the log files and create a unique ID for each entry
80295820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
80395820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
804b01bf299SEd Tanous         uint64_t entryCount = 0;
805cd225da8SJason M. Bills         std::string logEntry;
80695820184SJason M. Bills 
80795820184SJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
808cd225da8SJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
809cd225da8SJason M. Bills              it++)
810c4bf6374SJason M. Bills         {
811cd225da8SJason M. Bills             std::ifstream logStream(*it);
81295820184SJason M. Bills             if (!logStream.is_open())
813c4bf6374SJason M. Bills             {
814c4bf6374SJason M. Bills                 continue;
815c4bf6374SJason M. Bills             }
816c4bf6374SJason M. Bills 
817e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
818e85d6b16SJason M. Bills             bool firstEntry = true;
81995820184SJason M. Bills             while (std::getline(logStream, logEntry))
82095820184SJason M. Bills             {
821c4bf6374SJason M. Bills                 entryCount++;
822c4bf6374SJason M. Bills                 // Handle paging using skip (number of entries to skip from the
823c4bf6374SJason M. Bills                 // start) and top (number of entries to display)
824c4bf6374SJason M. Bills                 if (entryCount <= skip || entryCount > skip + top)
825c4bf6374SJason M. Bills                 {
826c4bf6374SJason M. Bills                     continue;
827c4bf6374SJason M. Bills                 }
828c4bf6374SJason M. Bills 
829c4bf6374SJason M. Bills                 std::string idStr;
830e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
831c4bf6374SJason M. Bills                 {
832c4bf6374SJason M. Bills                     continue;
833c4bf6374SJason M. Bills                 }
834c4bf6374SJason M. Bills 
835e85d6b16SJason M. Bills                 if (firstEntry)
836e85d6b16SJason M. Bills                 {
837e85d6b16SJason M. Bills                     firstEntry = false;
838e85d6b16SJason M. Bills                 }
839e85d6b16SJason M. Bills 
840c4bf6374SJason M. Bills                 logEntryArray.push_back({});
841c4bf6374SJason M. Bills                 nlohmann::json& bmcLogEntry = logEntryArray.back();
84295820184SJason M. Bills                 if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0)
843c4bf6374SJason M. Bills                 {
844c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
845c4bf6374SJason M. Bills                     return;
846c4bf6374SJason M. Bills                 }
847c4bf6374SJason M. Bills             }
84895820184SJason M. Bills         }
849c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
850c4bf6374SJason M. Bills         if (skip + top < entryCount)
851c4bf6374SJason M. Bills         {
852c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
85395820184SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/"
85495820184SJason M. Bills                 "Entries?$skip=" +
855c4bf6374SJason M. Bills                 std::to_string(skip + top);
856c4bf6374SJason M. Bills         }
85708a4e4b5SAnthony Wilson     }
85808a4e4b5SAnthony Wilson };
85908a4e4b5SAnthony Wilson 
860897967deSJason M. Bills class JournalEventLogEntry : public Node
861897967deSJason M. Bills {
862897967deSJason M. Bills   public:
863897967deSJason M. Bills     JournalEventLogEntry(CrowApp& app) :
864897967deSJason M. Bills         Node(app,
865897967deSJason M. Bills              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
866897967deSJason M. Bills              std::string())
867897967deSJason M. Bills     {
868897967deSJason M. Bills         entityPrivileges = {
869897967deSJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
870897967deSJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
871897967deSJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
872897967deSJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
873897967deSJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
874897967deSJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
875897967deSJason M. Bills     }
876897967deSJason M. Bills 
877897967deSJason M. Bills   private:
878897967deSJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
879897967deSJason M. Bills                const std::vector<std::string>& params) override
880897967deSJason M. Bills     {
881897967deSJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
882897967deSJason M. Bills         if (params.size() != 1)
883897967deSJason M. Bills         {
884897967deSJason M. Bills             messages::internalError(asyncResp->res);
885897967deSJason M. Bills             return;
886897967deSJason M. Bills         }
887897967deSJason M. Bills         const std::string& targetID = params[0];
888897967deSJason M. Bills 
889897967deSJason M. Bills         // Go through the log files and check the unique ID for each entry to
890897967deSJason M. Bills         // find the target entry
891897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
892897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
893897967deSJason M. Bills         std::string logEntry;
894897967deSJason M. Bills 
895897967deSJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
896897967deSJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
897897967deSJason M. Bills              it++)
898897967deSJason M. Bills         {
899897967deSJason M. Bills             std::ifstream logStream(*it);
900897967deSJason M. Bills             if (!logStream.is_open())
901897967deSJason M. Bills             {
902897967deSJason M. Bills                 continue;
903897967deSJason M. Bills             }
904897967deSJason M. Bills 
905897967deSJason M. Bills             // Reset the unique ID on the first entry
906897967deSJason M. Bills             bool firstEntry = true;
907897967deSJason M. Bills             while (std::getline(logStream, logEntry))
908897967deSJason M. Bills             {
909897967deSJason M. Bills                 std::string idStr;
910897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
911897967deSJason M. Bills                 {
912897967deSJason M. Bills                     continue;
913897967deSJason M. Bills                 }
914897967deSJason M. Bills 
915897967deSJason M. Bills                 if (firstEntry)
916897967deSJason M. Bills                 {
917897967deSJason M. Bills                     firstEntry = false;
918897967deSJason M. Bills                 }
919897967deSJason M. Bills 
920897967deSJason M. Bills                 if (idStr == targetID)
921897967deSJason M. Bills                 {
922897967deSJason M. Bills                     if (fillEventLogEntryJson(idStr, logEntry,
923897967deSJason M. Bills                                               asyncResp->res.jsonValue) != 0)
924897967deSJason M. Bills                     {
925897967deSJason M. Bills                         messages::internalError(asyncResp->res);
926897967deSJason M. Bills                         return;
927897967deSJason M. Bills                     }
928897967deSJason M. Bills                     return;
929897967deSJason M. Bills                 }
930897967deSJason M. Bills             }
931897967deSJason M. Bills         }
932897967deSJason M. Bills         // Requested ID was not found
933897967deSJason M. Bills         messages::resourceMissingAtURI(asyncResp->res, targetID);
934897967deSJason M. Bills     }
935897967deSJason M. Bills };
936897967deSJason M. Bills 
93708a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node
93808a4e4b5SAnthony Wilson {
93908a4e4b5SAnthony Wilson   public:
94008a4e4b5SAnthony Wilson     template <typename CrowApp>
94108a4e4b5SAnthony Wilson     DBusEventLogEntryCollection(CrowApp& app) :
94208a4e4b5SAnthony Wilson         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
94308a4e4b5SAnthony Wilson     {
94408a4e4b5SAnthony Wilson         entityPrivileges = {
94508a4e4b5SAnthony Wilson             {boost::beast::http::verb::get, {{"Login"}}},
94608a4e4b5SAnthony Wilson             {boost::beast::http::verb::head, {{"Login"}}},
94708a4e4b5SAnthony Wilson             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
94808a4e4b5SAnthony Wilson             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
94908a4e4b5SAnthony Wilson             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
95008a4e4b5SAnthony Wilson             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
95108a4e4b5SAnthony Wilson     }
95208a4e4b5SAnthony Wilson 
95308a4e4b5SAnthony Wilson   private:
95408a4e4b5SAnthony Wilson     void doGet(crow::Response& res, const crow::Request& req,
95508a4e4b5SAnthony Wilson                const std::vector<std::string>& params) override
95608a4e4b5SAnthony Wilson     {
95708a4e4b5SAnthony Wilson         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
95808a4e4b5SAnthony Wilson 
95908a4e4b5SAnthony Wilson         // Collections don't include the static data added by SubRoute because
96008a4e4b5SAnthony Wilson         // it has a duplicate entry for members
96108a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
96208a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
96308a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
96408a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
96508a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
96608a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
96708a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
96808a4e4b5SAnthony Wilson 
969cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
970cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
971cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
972cb92c03bSAndrew Geissler             [asyncResp](const boost::system::error_code ec,
973cb92c03bSAndrew Geissler                         GetManagedObjectsType& resp) {
974cb92c03bSAndrew Geissler                 if (ec)
975cb92c03bSAndrew Geissler                 {
976cb92c03bSAndrew Geissler                     // TODO Handle for specific error code
977cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
978cb92c03bSAndrew Geissler                         << "getLogEntriesIfaceData resp_handler got error "
979cb92c03bSAndrew Geissler                         << ec;
980cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
981cb92c03bSAndrew Geissler                     return;
982cb92c03bSAndrew Geissler                 }
983cb92c03bSAndrew Geissler                 nlohmann::json& entriesArray =
984cb92c03bSAndrew Geissler                     asyncResp->res.jsonValue["Members"];
985cb92c03bSAndrew Geissler                 entriesArray = nlohmann::json::array();
986cb92c03bSAndrew Geissler                 for (auto& objectPath : resp)
987cb92c03bSAndrew Geissler                 {
988cb92c03bSAndrew Geissler                     for (auto& interfaceMap : objectPath.second)
989cb92c03bSAndrew Geissler                     {
990cb92c03bSAndrew Geissler                         if (interfaceMap.first !=
991cb92c03bSAndrew Geissler                             "xyz.openbmc_project.Logging.Entry")
992cb92c03bSAndrew Geissler                         {
993cb92c03bSAndrew Geissler                             BMCWEB_LOG_DEBUG << "Bailing early on "
994cb92c03bSAndrew Geissler                                              << interfaceMap.first;
995cb92c03bSAndrew Geissler                             continue;
996cb92c03bSAndrew Geissler                         }
997cb92c03bSAndrew Geissler                         entriesArray.push_back({});
998cb92c03bSAndrew Geissler                         nlohmann::json& thisEntry = entriesArray.back();
99966664f25SEd Tanous                         uint32_t* id = nullptr;
100066664f25SEd Tanous                         std::time_t timestamp{};
100166664f25SEd Tanous                         std::string* severity = nullptr;
100266664f25SEd Tanous                         std::string* message = nullptr;
1003cb92c03bSAndrew Geissler                         for (auto& propertyMap : interfaceMap.second)
1004cb92c03bSAndrew Geissler                         {
1005cb92c03bSAndrew Geissler                             if (propertyMap.first == "Id")
1006cb92c03bSAndrew Geissler                             {
10078d78b7a9SPatrick Williams                                 id = std::get_if<uint32_t>(&propertyMap.second);
1008cb92c03bSAndrew Geissler                                 if (id == nullptr)
1009cb92c03bSAndrew Geissler                                 {
1010cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1011cb92c03bSAndrew Geissler                                                               "Id");
1012cb92c03bSAndrew Geissler                                 }
1013cb92c03bSAndrew Geissler                             }
1014cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Timestamp")
1015cb92c03bSAndrew Geissler                             {
1016cb92c03bSAndrew Geissler                                 const uint64_t* millisTimeStamp =
1017cb92c03bSAndrew Geissler                                     std::get_if<uint64_t>(&propertyMap.second);
1018cb92c03bSAndrew Geissler                                 if (millisTimeStamp == nullptr)
1019cb92c03bSAndrew Geissler                                 {
1020cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1021cb92c03bSAndrew Geissler                                                               "Timestamp");
1022271584abSEd Tanous                                     continue;
1023cb92c03bSAndrew Geissler                                 }
1024cb92c03bSAndrew Geissler                                 // Retrieve Created property with format:
1025cb92c03bSAndrew Geissler                                 // yyyy-mm-ddThh:mm:ss
1026cb92c03bSAndrew Geissler                                 std::chrono::milliseconds chronoTimeStamp(
1027cb92c03bSAndrew Geissler                                     *millisTimeStamp);
1028271584abSEd Tanous                                 timestamp = std::chrono::duration_cast<
1029271584abSEd Tanous                                                 std::chrono::duration<int>>(
1030271584abSEd Tanous                                                 chronoTimeStamp)
1031cb92c03bSAndrew Geissler                                                 .count();
1032cb92c03bSAndrew Geissler                             }
1033cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1034cb92c03bSAndrew Geissler                             {
1035cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1036cb92c03bSAndrew Geissler                                     &propertyMap.second);
1037cb92c03bSAndrew Geissler                                 if (severity == nullptr)
1038cb92c03bSAndrew Geissler                                 {
1039cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1040cb92c03bSAndrew Geissler                                                               "Severity");
1041cb92c03bSAndrew Geissler                                 }
1042cb92c03bSAndrew Geissler                             }
1043cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1044cb92c03bSAndrew Geissler                             {
1045cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1046cb92c03bSAndrew Geissler                                     &propertyMap.second);
1047cb92c03bSAndrew Geissler                                 if (message == nullptr)
1048cb92c03bSAndrew Geissler                                 {
1049cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1050cb92c03bSAndrew Geissler                                                               "Message");
1051cb92c03bSAndrew Geissler                                 }
1052cb92c03bSAndrew Geissler                             }
1053cb92c03bSAndrew Geissler                         }
1054cb92c03bSAndrew Geissler                         thisEntry = {
1055cb92c03bSAndrew Geissler                             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1056cb92c03bSAndrew Geissler                             {"@odata.id",
1057cb92c03bSAndrew Geissler                              "/redfish/v1/Systems/system/LogServices/EventLog/"
1058cb92c03bSAndrew Geissler                              "Entries/" +
1059cb92c03bSAndrew Geissler                                  std::to_string(*id)},
106027062605SAnthony Wilson                             {"Name", "System Event Log Entry"},
1061cb92c03bSAndrew Geissler                             {"Id", std::to_string(*id)},
1062cb92c03bSAndrew Geissler                             {"Message", *message},
1063cb92c03bSAndrew Geissler                             {"EntryType", "Event"},
1064cb92c03bSAndrew Geissler                             {"Severity",
1065cb92c03bSAndrew Geissler                              translateSeverityDbusToRedfish(*severity)},
1066cb92c03bSAndrew Geissler                             {"Created", crow::utility::getDateTime(timestamp)}};
1067cb92c03bSAndrew Geissler                     }
1068cb92c03bSAndrew Geissler                 }
1069cb92c03bSAndrew Geissler                 std::sort(entriesArray.begin(), entriesArray.end(),
1070cb92c03bSAndrew Geissler                           [](const nlohmann::json& left,
1071cb92c03bSAndrew Geissler                              const nlohmann::json& right) {
1072cb92c03bSAndrew Geissler                               return (left["Id"] <= right["Id"]);
1073cb92c03bSAndrew Geissler                           });
1074cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue["Members@odata.count"] =
1075cb92c03bSAndrew Geissler                     entriesArray.size();
1076cb92c03bSAndrew Geissler             },
1077cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
1078cb92c03bSAndrew Geissler             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1079c4bf6374SJason M. Bills     }
1080c4bf6374SJason M. Bills };
1081c4bf6374SJason M. Bills 
108208a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node
1083c4bf6374SJason M. Bills {
1084c4bf6374SJason M. Bills   public:
108508a4e4b5SAnthony Wilson     DBusEventLogEntry(CrowApp& app) :
1086c4bf6374SJason M. Bills         Node(app,
1087029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1088029573d4SEd Tanous              std::string())
1089c4bf6374SJason M. Bills     {
1090c4bf6374SJason M. Bills         entityPrivileges = {
1091c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1092c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1093c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1094c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1095c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1096c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1097c4bf6374SJason M. Bills     }
1098c4bf6374SJason M. Bills 
1099c4bf6374SJason M. Bills   private:
1100c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1101c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1102c4bf6374SJason M. Bills     {
1103c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1104029573d4SEd Tanous         if (params.size() != 1)
1105c4bf6374SJason M. Bills         {
1106c4bf6374SJason M. Bills             messages::internalError(asyncResp->res);
1107c4bf6374SJason M. Bills             return;
1108c4bf6374SJason M. Bills         }
1109029573d4SEd Tanous         const std::string& entryID = params[0];
1110cb92c03bSAndrew Geissler 
1111cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1112cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1113cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1114cb92c03bSAndrew Geissler             [asyncResp, entryID](const boost::system::error_code ec,
1115cb92c03bSAndrew Geissler                                  GetManagedPropertyType& resp) {
1116cb92c03bSAndrew Geissler                 if (ec)
1117cb92c03bSAndrew Geissler                 {
1118cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1119cb92c03bSAndrew Geissler                         << "EventLogEntry (DBus) resp_handler got error " << ec;
1120cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1121cb92c03bSAndrew Geissler                     return;
1122cb92c03bSAndrew Geissler                 }
112366664f25SEd Tanous                 uint32_t* id = nullptr;
112466664f25SEd Tanous                 std::time_t timestamp{};
112566664f25SEd Tanous                 std::string* severity = nullptr;
112666664f25SEd Tanous                 std::string* message = nullptr;
1127cb92c03bSAndrew Geissler                 for (auto& propertyMap : resp)
1128cb92c03bSAndrew Geissler                 {
1129cb92c03bSAndrew Geissler                     if (propertyMap.first == "Id")
1130cb92c03bSAndrew Geissler                     {
1131cb92c03bSAndrew Geissler                         id = std::get_if<uint32_t>(&propertyMap.second);
1132cb92c03bSAndrew Geissler                         if (id == nullptr)
1133cb92c03bSAndrew Geissler                         {
1134cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res, "Id");
1135cb92c03bSAndrew Geissler                         }
1136cb92c03bSAndrew Geissler                     }
1137cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Timestamp")
1138cb92c03bSAndrew Geissler                     {
1139cb92c03bSAndrew Geissler                         const uint64_t* millisTimeStamp =
1140cb92c03bSAndrew Geissler                             std::get_if<uint64_t>(&propertyMap.second);
1141cb92c03bSAndrew Geissler                         if (millisTimeStamp == nullptr)
1142cb92c03bSAndrew Geissler                         {
1143cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1144cb92c03bSAndrew Geissler                                                       "Timestamp");
1145271584abSEd Tanous                             continue;
1146cb92c03bSAndrew Geissler                         }
1147cb92c03bSAndrew Geissler                         // Retrieve Created property with format:
1148cb92c03bSAndrew Geissler                         // yyyy-mm-ddThh:mm:ss
1149cb92c03bSAndrew Geissler                         std::chrono::milliseconds chronoTimeStamp(
1150cb92c03bSAndrew Geissler                             *millisTimeStamp);
1151cb92c03bSAndrew Geissler                         timestamp =
1152271584abSEd Tanous                             std::chrono::duration_cast<
1153271584abSEd Tanous                                 std::chrono::duration<int>>(chronoTimeStamp)
1154cb92c03bSAndrew Geissler                                 .count();
1155cb92c03bSAndrew Geissler                     }
1156cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Severity")
1157cb92c03bSAndrew Geissler                     {
1158cb92c03bSAndrew Geissler                         severity =
1159cb92c03bSAndrew Geissler                             std::get_if<std::string>(&propertyMap.second);
1160cb92c03bSAndrew Geissler                         if (severity == nullptr)
1161cb92c03bSAndrew Geissler                         {
1162cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1163cb92c03bSAndrew Geissler                                                       "Severity");
1164cb92c03bSAndrew Geissler                         }
1165cb92c03bSAndrew Geissler                     }
1166cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Message")
1167cb92c03bSAndrew Geissler                     {
1168cb92c03bSAndrew Geissler                         message = std::get_if<std::string>(&propertyMap.second);
1169cb92c03bSAndrew Geissler                         if (message == nullptr)
1170cb92c03bSAndrew Geissler                         {
1171cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1172cb92c03bSAndrew Geissler                                                       "Message");
1173cb92c03bSAndrew Geissler                         }
1174cb92c03bSAndrew Geissler                     }
1175cb92c03bSAndrew Geissler                 }
1176271584abSEd Tanous                 if (id == nullptr || message == nullptr || severity == nullptr)
1177271584abSEd Tanous                 {
1178271584abSEd Tanous                     return;
1179271584abSEd Tanous                 }
1180cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue = {
1181cb92c03bSAndrew Geissler                     {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1182cb92c03bSAndrew Geissler                     {"@odata.id",
1183cb92c03bSAndrew Geissler                      "/redfish/v1/Systems/system/LogServices/EventLog/"
1184cb92c03bSAndrew Geissler                      "Entries/" +
1185cb92c03bSAndrew Geissler                          std::to_string(*id)},
118627062605SAnthony Wilson                     {"Name", "System Event Log Entry"},
1187cb92c03bSAndrew Geissler                     {"Id", std::to_string(*id)},
1188cb92c03bSAndrew Geissler                     {"Message", *message},
1189cb92c03bSAndrew Geissler                     {"EntryType", "Event"},
1190cb92c03bSAndrew Geissler                     {"Severity", translateSeverityDbusToRedfish(*severity)},
119108a4e4b5SAnthony Wilson                     {"Created", crow::utility::getDateTime(timestamp)}};
1192cb92c03bSAndrew Geissler             },
1193cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging",
1194cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging/entry/" + entryID,
1195cb92c03bSAndrew Geissler             "org.freedesktop.DBus.Properties", "GetAll",
1196cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging.Entry");
1197c4bf6374SJason M. Bills     }
1198336e96c6SChicago Duan 
1199336e96c6SChicago Duan     void doDelete(crow::Response& res, const crow::Request& req,
1200336e96c6SChicago Duan                   const std::vector<std::string>& params) override
1201336e96c6SChicago Duan     {
1202336e96c6SChicago Duan 
1203336e96c6SChicago Duan         BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1204336e96c6SChicago Duan 
1205336e96c6SChicago Duan         auto asyncResp = std::make_shared<AsyncResp>(res);
1206336e96c6SChicago Duan 
1207336e96c6SChicago Duan         if (params.size() != 1)
1208336e96c6SChicago Duan         {
1209336e96c6SChicago Duan             messages::internalError(asyncResp->res);
1210336e96c6SChicago Duan             return;
1211336e96c6SChicago Duan         }
1212336e96c6SChicago Duan         std::string entryID = params[0];
1213336e96c6SChicago Duan 
1214336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
1215336e96c6SChicago Duan 
1216336e96c6SChicago Duan         // Process response from Logging service.
1217336e96c6SChicago Duan         auto respHandler = [asyncResp](const boost::system::error_code ec) {
1218336e96c6SChicago Duan             BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1219336e96c6SChicago Duan             if (ec)
1220336e96c6SChicago Duan             {
1221336e96c6SChicago Duan                 // TODO Handle for specific error code
1222336e96c6SChicago Duan                 BMCWEB_LOG_ERROR
1223336e96c6SChicago Duan                     << "EventLogEntry (DBus) doDelete respHandler got error "
1224336e96c6SChicago Duan                     << ec;
1225336e96c6SChicago Duan                 asyncResp->res.result(
1226336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
1227336e96c6SChicago Duan                 return;
1228336e96c6SChicago Duan             }
1229336e96c6SChicago Duan 
1230336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
1231336e96c6SChicago Duan         };
1232336e96c6SChicago Duan 
1233336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
1234336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
1235336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
1236336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
1237336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
1238336e96c6SChicago Duan     }
1239c4bf6374SJason M. Bills };
1240c4bf6374SJason M. Bills 
1241c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node
1242c4bf6374SJason M. Bills {
1243c4bf6374SJason M. Bills   public:
1244c4bf6374SJason M. Bills     template <typename CrowApp>
1245c4bf6374SJason M. Bills     BMCLogServiceCollection(CrowApp& app) :
12464ed77cd5SEd Tanous         Node(app, "/redfish/v1/Managers/bmc/LogServices/")
12471da66f75SEd Tanous     {
12481da66f75SEd Tanous         entityPrivileges = {
1249e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1250e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1251e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1252e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1253e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1254e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
12551da66f75SEd Tanous     }
12561da66f75SEd Tanous 
12571da66f75SEd Tanous   private:
12581da66f75SEd Tanous     /**
12591da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
12601da66f75SEd Tanous      */
12611da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
12621da66f75SEd Tanous                const std::vector<std::string>& params) override
12631da66f75SEd Tanous     {
1264e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
12651da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
12661da66f75SEd Tanous         // it has a duplicate entry for members
1267e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
12681da66f75SEd Tanous             "#LogServiceCollection.LogServiceCollection";
1269e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1270e1f26343SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices";
1271e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1272e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
12731da66f75SEd Tanous             "Collection of LogServices for this Manager";
1274c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1275c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
1276c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1277c4bf6374SJason M. Bills         logServiceArray.push_back(
127808a4e4b5SAnthony Wilson             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1279c4bf6374SJason M. Bills #endif
1280e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
1281c4bf6374SJason M. Bills             logServiceArray.size();
12821da66f75SEd Tanous     }
12831da66f75SEd Tanous };
12841da66f75SEd Tanous 
1285c4bf6374SJason M. Bills class BMCJournalLogService : public Node
12861da66f75SEd Tanous {
12871da66f75SEd Tanous   public:
12881da66f75SEd Tanous     template <typename CrowApp>
1289c4bf6374SJason M. Bills     BMCJournalLogService(CrowApp& app) :
1290c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1291e1f26343SJason M. Bills     {
1292e1f26343SJason M. Bills         entityPrivileges = {
1293e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1294e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1295e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1296e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1297e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1298e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1299e1f26343SJason M. Bills     }
1300e1f26343SJason M. Bills 
1301e1f26343SJason M. Bills   private:
1302e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1303e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1304e1f26343SJason M. Bills     {
1305e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1306e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1307e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
13080f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
13090f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
1310c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
1311c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
1312c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "BMC Journal";
1313e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1314cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1315cd50aa42SJason M. Bills             {"@odata.id",
1316086be238SEd Tanous              "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
1317e1f26343SJason M. Bills     }
1318e1f26343SJason M. Bills };
1319e1f26343SJason M. Bills 
1320c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1321e1f26343SJason M. Bills                                       sd_journal* journal,
1322c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
1323e1f26343SJason M. Bills {
1324e1f26343SJason M. Bills     // Get the Log Entry contents
1325e1f26343SJason M. Bills     int ret = 0;
1326e1f26343SJason M. Bills 
132739e77504SEd Tanous     std::string_view msg;
132816428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1329e1f26343SJason M. Bills     if (ret < 0)
1330e1f26343SJason M. Bills     {
1331e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1332e1f26343SJason M. Bills         return 1;
1333e1f26343SJason M. Bills     }
1334e1f26343SJason M. Bills 
1335e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1336271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
133716428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1338e1f26343SJason M. Bills     if (ret < 0)
1339e1f26343SJason M. Bills     {
1340e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
1341e1f26343SJason M. Bills     }
1342e1f26343SJason M. Bills 
1343e1f26343SJason M. Bills     // Get the Created time from the timestamp
134416428a1aSJason M. Bills     std::string entryTimeStr;
134516428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
1346e1f26343SJason M. Bills     {
134716428a1aSJason M. Bills         return 1;
1348e1f26343SJason M. Bills     }
1349e1f26343SJason M. Bills 
1350e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
1351c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
1352cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1353c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1354c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
1355e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
1356c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
135716428a1aSJason M. Bills         {"Message", msg},
1358e1f26343SJason M. Bills         {"EntryType", "Oem"},
1359e1f26343SJason M. Bills         {"Severity",
1360b6a61a5eSJason M. Bills          severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"},
1361086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
1362e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
1363e1f26343SJason M. Bills     return 0;
1364e1f26343SJason M. Bills }
1365e1f26343SJason M. Bills 
1366c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node
1367e1f26343SJason M. Bills {
1368e1f26343SJason M. Bills   public:
1369e1f26343SJason M. Bills     template <typename CrowApp>
1370c4bf6374SJason M. Bills     BMCJournalLogEntryCollection(CrowApp& app) :
1371c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
1372e1f26343SJason M. Bills     {
1373e1f26343SJason M. Bills         entityPrivileges = {
1374e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1375e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1376e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1377e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1378e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1379e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1380e1f26343SJason M. Bills     }
1381e1f26343SJason M. Bills 
1382e1f26343SJason M. Bills   private:
1383e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1384e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1385e1f26343SJason M. Bills     {
1386e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1387193ad2faSJason M. Bills         static constexpr const long maxEntriesPerPage = 1000;
1388271584abSEd Tanous         uint64_t skip = 0;
1389271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
139016428a1aSJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1391193ad2faSJason M. Bills         {
1392193ad2faSJason M. Bills             return;
1393193ad2faSJason M. Bills         }
139416428a1aSJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1395193ad2faSJason M. Bills         {
1396193ad2faSJason M. Bills             return;
1397193ad2faSJason M. Bills         }
1398e1f26343SJason M. Bills         // Collections don't include the static data added by SubRoute because
1399e1f26343SJason M. Bills         // it has a duplicate entry for members
1400e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1401e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
14020f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
14030f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1404e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1405c4bf6374SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1406e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1407e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1408e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
14090f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
14100f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries";
1411e1f26343SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1412e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
1413e1f26343SJason M. Bills 
1414e1f26343SJason M. Bills         // Go through the journal and use the timestamp to create a unique ID
1415e1f26343SJason M. Bills         // for each entry
1416e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1417e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1418e1f26343SJason M. Bills         if (ret < 0)
1419e1f26343SJason M. Bills         {
1420e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1421f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1422e1f26343SJason M. Bills             return;
1423e1f26343SJason M. Bills         }
1424e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1425e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1426e1f26343SJason M. Bills         journalTmp = nullptr;
1427b01bf299SEd Tanous         uint64_t entryCount = 0;
1428e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
1429e85d6b16SJason M. Bills         bool firstEntry = true;
1430e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
1431e1f26343SJason M. Bills         {
1432193ad2faSJason M. Bills             entryCount++;
1433193ad2faSJason M. Bills             // Handle paging using skip (number of entries to skip from the
1434193ad2faSJason M. Bills             // start) and top (number of entries to display)
1435193ad2faSJason M. Bills             if (entryCount <= skip || entryCount > skip + top)
1436193ad2faSJason M. Bills             {
1437193ad2faSJason M. Bills                 continue;
1438193ad2faSJason M. Bills             }
1439193ad2faSJason M. Bills 
144016428a1aSJason M. Bills             std::string idStr;
1441e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1442e1f26343SJason M. Bills             {
1443e1f26343SJason M. Bills                 continue;
1444e1f26343SJason M. Bills             }
1445e1f26343SJason M. Bills 
1446e85d6b16SJason M. Bills             if (firstEntry)
1447e85d6b16SJason M. Bills             {
1448e85d6b16SJason M. Bills                 firstEntry = false;
1449e85d6b16SJason M. Bills             }
1450e85d6b16SJason M. Bills 
1451e1f26343SJason M. Bills             logEntryArray.push_back({});
1452c4bf6374SJason M. Bills             nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
1453c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
1454c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
1455e1f26343SJason M. Bills             {
1456f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
1457e1f26343SJason M. Bills                 return;
1458e1f26343SJason M. Bills             }
1459e1f26343SJason M. Bills         }
1460193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1461193ad2faSJason M. Bills         if (skip + top < entryCount)
1462193ad2faSJason M. Bills         {
1463193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
1464c4bf6374SJason M. Bills                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
1465193ad2faSJason M. Bills                 std::to_string(skip + top);
1466193ad2faSJason M. Bills         }
1467e1f26343SJason M. Bills     }
1468e1f26343SJason M. Bills };
1469e1f26343SJason M. Bills 
1470c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node
1471e1f26343SJason M. Bills {
1472e1f26343SJason M. Bills   public:
1473c4bf6374SJason M. Bills     BMCJournalLogEntry(CrowApp& app) :
1474c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/",
1475e1f26343SJason M. Bills              std::string())
1476e1f26343SJason M. Bills     {
1477e1f26343SJason M. Bills         entityPrivileges = {
1478e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1479e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1480e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1481e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1482e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1483e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1484e1f26343SJason M. Bills     }
1485e1f26343SJason M. Bills 
1486e1f26343SJason M. Bills   private:
1487e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1488e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1489e1f26343SJason M. Bills     {
1490e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1491e1f26343SJason M. Bills         if (params.size() != 1)
1492e1f26343SJason M. Bills         {
1493f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1494e1f26343SJason M. Bills             return;
1495e1f26343SJason M. Bills         }
149616428a1aSJason M. Bills         const std::string& entryID = params[0];
1497e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
1498e1f26343SJason M. Bills         uint64_t ts = 0;
1499271584abSEd Tanous         uint64_t index = 0;
150016428a1aSJason M. Bills         if (!getTimestampFromID(asyncResp->res, entryID, ts, index))
1501e1f26343SJason M. Bills         {
150216428a1aSJason M. Bills             return;
1503e1f26343SJason M. Bills         }
1504e1f26343SJason M. Bills 
1505e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1506e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1507e1f26343SJason M. Bills         if (ret < 0)
1508e1f26343SJason M. Bills         {
1509e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1510f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1511e1f26343SJason M. Bills             return;
1512e1f26343SJason M. Bills         }
1513e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1514e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1515e1f26343SJason M. Bills         journalTmp = nullptr;
1516e1f26343SJason M. Bills         // Go to the timestamp in the log and move to the entry at the index
1517af07e3f5SJason M. Bills         // tracking the unique ID
1518af07e3f5SJason M. Bills         std::string idStr;
1519af07e3f5SJason M. Bills         bool firstEntry = true;
1520e1f26343SJason M. Bills         ret = sd_journal_seek_realtime_usec(journal.get(), ts);
15212056b6d1SManojkiran Eda         if (ret < 0)
15222056b6d1SManojkiran Eda         {
15232056b6d1SManojkiran Eda             BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
15242056b6d1SManojkiran Eda                              << strerror(-ret);
15252056b6d1SManojkiran Eda             messages::internalError(asyncResp->res);
15262056b6d1SManojkiran Eda             return;
15272056b6d1SManojkiran Eda         }
1528271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
1529e1f26343SJason M. Bills         {
1530e1f26343SJason M. Bills             sd_journal_next(journal.get());
1531af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1532af07e3f5SJason M. Bills             {
1533af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
1534af07e3f5SJason M. Bills                 return;
1535af07e3f5SJason M. Bills             }
1536af07e3f5SJason M. Bills             if (firstEntry)
1537af07e3f5SJason M. Bills             {
1538af07e3f5SJason M. Bills                 firstEntry = false;
1539af07e3f5SJason M. Bills             }
1540e1f26343SJason M. Bills         }
1541c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
1542af07e3f5SJason M. Bills         if (idStr != entryID)
1543c4bf6374SJason M. Bills         {
1544c4bf6374SJason M. Bills             messages::resourceMissingAtURI(asyncResp->res, entryID);
1545c4bf6374SJason M. Bills             return;
1546c4bf6374SJason M. Bills         }
1547c4bf6374SJason M. Bills 
1548c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
1549e1f26343SJason M. Bills                                        asyncResp->res.jsonValue) != 0)
1550e1f26343SJason M. Bills         {
1551f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1552e1f26343SJason M. Bills             return;
1553e1f26343SJason M. Bills         }
1554e1f26343SJason M. Bills     }
1555e1f26343SJason M. Bills };
1556e1f26343SJason M. Bills 
1557c9bb6861Sraviteja-b class SystemDumpService : public Node
1558c9bb6861Sraviteja-b {
1559c9bb6861Sraviteja-b   public:
1560c9bb6861Sraviteja-b     template <typename CrowApp>
1561c9bb6861Sraviteja-b     SystemDumpService(CrowApp& app) :
1562c9bb6861Sraviteja-b         Node(app, "/redfish/v1/Systems/system/LogServices/System/")
1563c9bb6861Sraviteja-b     {
1564c9bb6861Sraviteja-b         entityPrivileges = {
1565c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1566c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1567c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1568c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1569c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1570c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1571c9bb6861Sraviteja-b     }
1572c9bb6861Sraviteja-b 
1573c9bb6861Sraviteja-b   private:
1574c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
1575c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
1576c9bb6861Sraviteja-b     {
1577c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1578c9bb6861Sraviteja-b 
1579c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
1580c9bb6861Sraviteja-b             "/redfish/v1/Systems/system/LogServices/System";
1581c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
1582c9bb6861Sraviteja-b             "#LogService.v1_1_0.LogService";
1583c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "Dump Log Service";
1584c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] = "System Dump Log Service";
1585c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Id"] = "System";
1586c9bb6861Sraviteja-b         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1587c9bb6861Sraviteja-b         asyncResp->res.jsonValue["LogEntryTypes"] = "Dump";
1588c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Oem"]["DumpType"] = "System";
1589c9bb6861Sraviteja-b 
1590c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Entries"] = {
1591c9bb6861Sraviteja-b             {"@odata.id",
1592c9bb6861Sraviteja-b              "/redfish/v1/Systems/system/LogServices/System/Entries"}};
1593c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1594c9bb6861Sraviteja-b             {"target", "/redfish/v1/Systems/system/LogServices/System/"
1595c9bb6861Sraviteja-b                        "Actions/LogService.ClearLog"}};
1596c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Actions"]["#LogService.CreateLog"] = {
1597c9bb6861Sraviteja-b             {"target", "/redfish/v1/Systems/system/LogServices/System/"
1598c9bb6861Sraviteja-b                        "Actions/LogService.CreateLog"}};
1599c9bb6861Sraviteja-b     }
1600c9bb6861Sraviteja-b };
1601c9bb6861Sraviteja-b 
1602c9bb6861Sraviteja-b class SystemDumpEntryCollection : public Node
1603c9bb6861Sraviteja-b {
1604c9bb6861Sraviteja-b   public:
1605c9bb6861Sraviteja-b     template <typename CrowApp>
1606c9bb6861Sraviteja-b     SystemDumpEntryCollection(CrowApp& app) :
1607c9bb6861Sraviteja-b         Node(app, "/redfish/v1/Systems/system/LogServices/System/Entries/")
1608c9bb6861Sraviteja-b     {
1609c9bb6861Sraviteja-b         entityPrivileges = {
1610c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1611c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1612c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1613c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1614c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1615c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1616c9bb6861Sraviteja-b     }
1617c9bb6861Sraviteja-b 
1618c9bb6861Sraviteja-b   private:
1619c9bb6861Sraviteja-b     /**
1620c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
1621c9bb6861Sraviteja-b      */
1622c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
1623c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
1624c9bb6861Sraviteja-b     {
1625c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1626c9bb6861Sraviteja-b 
1627c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
1628c9bb6861Sraviteja-b             "#LogEntryCollection.LogEntryCollection";
1629c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
1630c9bb6861Sraviteja-b             "/redfish/v1/Systems/system/LogServices/System/Entries";
1631c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "System Dump Entries";
1632c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] =
1633c9bb6861Sraviteja-b             "Collection of System Dump Entries";
1634c9bb6861Sraviteja-b 
1635c9bb6861Sraviteja-b         crow::connections::systemBus->async_method_call(
1636c9bb6861Sraviteja-b             [asyncResp](const boost::system::error_code ec,
1637c9bb6861Sraviteja-b                         const crow::openbmc_mapper::GetSubTreeType& resp) {
1638c9bb6861Sraviteja-b                 if (ec)
1639c9bb6861Sraviteja-b                 {
1640c9bb6861Sraviteja-b                     BMCWEB_LOG_ERROR << " resp_handler got error " << ec;
1641c9bb6861Sraviteja-b                     messages::internalError(asyncResp->res);
1642c9bb6861Sraviteja-b                     return;
1643c9bb6861Sraviteja-b                 }
1644c9bb6861Sraviteja-b 
1645c9bb6861Sraviteja-b                 nlohmann::json& logArray = asyncResp->res.jsonValue["Members"];
1646c9bb6861Sraviteja-b                 logArray = nlohmann::json::array();
1647c9bb6861Sraviteja-b                 for (auto& object : resp)
1648c9bb6861Sraviteja-b                 {
1649c9bb6861Sraviteja-b                     const std::string& path =
1650c9bb6861Sraviteja-b                         static_cast<const std::string&>(object.first);
1651c9bb6861Sraviteja-b                     std::size_t lastPos = path.rfind("/");
1652c9bb6861Sraviteja-b                     if (lastPos == std::string::npos)
1653c9bb6861Sraviteja-b                     {
1654c9bb6861Sraviteja-b                         continue;
1655c9bb6861Sraviteja-b                     }
1656c9bb6861Sraviteja-b                     std::string logID = path.substr(lastPos + 1);
1657c9bb6861Sraviteja-b                     logArray.push_back(
1658c9bb6861Sraviteja-b                         {{"@odata.id", "/redfish/v1/Systems/system/LogServices/"
1659c9bb6861Sraviteja-b                                        "System/Entries/" +
1660c9bb6861Sraviteja-b                                            logID}});
1661c9bb6861Sraviteja-b                 }
1662c9bb6861Sraviteja-b                 asyncResp->res.jsonValue["Members@odata.count"] =
1663c9bb6861Sraviteja-b                     logArray.size();
1664c9bb6861Sraviteja-b             },
1665c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper",
1666c9bb6861Sraviteja-b             "/xyz/openbmc_project/object_mapper",
1667c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper", "GetSubTree",
1668c9bb6861Sraviteja-b             "/xyz/openbmc_project/dump", 0,
1669c9bb6861Sraviteja-b             std::array<const char*, 1>{
1670c9bb6861Sraviteja-b                 "xyz.openbmc_project.Dump.Entry.System"});
1671c9bb6861Sraviteja-b     }
1672c9bb6861Sraviteja-b };
1673c9bb6861Sraviteja-b 
1674c9bb6861Sraviteja-b class SystemDumpEntry : public Node
1675c9bb6861Sraviteja-b {
1676c9bb6861Sraviteja-b   public:
1677c9bb6861Sraviteja-b     SystemDumpEntry(CrowApp& app) :
1678c9bb6861Sraviteja-b         Node(app,
1679c9bb6861Sraviteja-b              "/redfish/v1/Systems/system/LogServices/System/Entries/<str>/",
1680c9bb6861Sraviteja-b              std::string())
1681c9bb6861Sraviteja-b     {
1682c9bb6861Sraviteja-b         entityPrivileges = {
1683c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1684c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1685c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1686c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1687c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1688c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1689c9bb6861Sraviteja-b     }
1690c9bb6861Sraviteja-b 
1691c9bb6861Sraviteja-b   private:
1692c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
1693c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
1694c9bb6861Sraviteja-b     {
1695c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1696c9bb6861Sraviteja-b         if (params.size() != 1)
1697c9bb6861Sraviteja-b         {
1698c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
1699c9bb6861Sraviteja-b             return;
1700c9bb6861Sraviteja-b         }
1701c9bb6861Sraviteja-b         const std::string& entryID = params[0];
1702c9bb6861Sraviteja-b         crow::connections::systemBus->async_method_call(
1703c9bb6861Sraviteja-b             [asyncResp, entryID](const boost::system::error_code ec,
1704c9bb6861Sraviteja-b                                  GetManagedObjectsType& resp) {
1705c9bb6861Sraviteja-b                 if (ec)
1706c9bb6861Sraviteja-b                 {
1707c9bb6861Sraviteja-b                     BMCWEB_LOG_ERROR
1708c9bb6861Sraviteja-b                         << "SystemDumpEntry resp_handler got error " << ec;
1709c9bb6861Sraviteja-b                     messages::internalError(asyncResp->res);
1710c9bb6861Sraviteja-b                     return;
1711c9bb6861Sraviteja-b                 }
1712c9bb6861Sraviteja-b 
1713c9bb6861Sraviteja-b                 for (auto& objectPath : resp)
1714c9bb6861Sraviteja-b                 {
1715c9bb6861Sraviteja-b                     if (objectPath.first.str.find(
1716c9bb6861Sraviteja-b                             "/xyz/openbmc_project/dump/entry/" + entryID) ==
1717c9bb6861Sraviteja-b                         std::string::npos)
1718c9bb6861Sraviteja-b                     {
1719c9bb6861Sraviteja-b                         continue;
1720c9bb6861Sraviteja-b                     }
1721c9bb6861Sraviteja-b 
1722c9bb6861Sraviteja-b                     bool foundSystemDumpEntry = false;
1723c9bb6861Sraviteja-b                     for (auto& interfaceMap : objectPath.second)
1724c9bb6861Sraviteja-b                     {
1725c9bb6861Sraviteja-b                         if (interfaceMap.first ==
1726c9bb6861Sraviteja-b                             "xyz.openbmc_project.Dump.Entry.System")
1727c9bb6861Sraviteja-b                         {
1728c9bb6861Sraviteja-b                             foundSystemDumpEntry = true;
1729c9bb6861Sraviteja-b                             break;
1730c9bb6861Sraviteja-b                         }
1731c9bb6861Sraviteja-b                     }
1732c9bb6861Sraviteja-b                     if (foundSystemDumpEntry == false)
1733c9bb6861Sraviteja-b                     {
1734c9bb6861Sraviteja-b                         BMCWEB_LOG_DEBUG << "Can't find System Dump Entry";
1735c9bb6861Sraviteja-b                         messages::internalError(asyncResp->res);
1736c9bb6861Sraviteja-b                         return;
1737c9bb6861Sraviteja-b                     }
1738c9bb6861Sraviteja-b 
1739c9bb6861Sraviteja-b                     std::string timestamp{};
1740c9bb6861Sraviteja-b                     uint64_t size = 0;
1741c9bb6861Sraviteja-b 
1742c9bb6861Sraviteja-b                     for (auto& interfaceMap : objectPath.second)
1743c9bb6861Sraviteja-b                     {
1744c9bb6861Sraviteja-b                         if (interfaceMap.first ==
1745c9bb6861Sraviteja-b                             "xyz.openbmc_project.Dump.Entry")
1746c9bb6861Sraviteja-b                         {
1747c9bb6861Sraviteja-b                             for (auto& propertyMap : interfaceMap.second)
1748c9bb6861Sraviteja-b                             {
1749c9bb6861Sraviteja-b                                 if (propertyMap.first == "Size")
1750c9bb6861Sraviteja-b                                 {
1751c9bb6861Sraviteja-b                                     auto sizePtr = std::get_if<uint64_t>(
1752c9bb6861Sraviteja-b                                         &propertyMap.second);
1753c9bb6861Sraviteja-b                                     if (sizePtr == nullptr)
1754c9bb6861Sraviteja-b                                     {
1755c9bb6861Sraviteja-b                                         messages::propertyMissing(
1756c9bb6861Sraviteja-b                                             asyncResp->res, "Size");
1757c9bb6861Sraviteja-b                                         break;
1758c9bb6861Sraviteja-b                                     }
1759c9bb6861Sraviteja-b                                     size = *sizePtr;
1760c9bb6861Sraviteja-b                                     break;
1761c9bb6861Sraviteja-b                                 }
1762c9bb6861Sraviteja-b                             }
1763c9bb6861Sraviteja-b                         }
1764c9bb6861Sraviteja-b                         else if (interfaceMap.first ==
1765c9bb6861Sraviteja-b                                  "xyz.openbmc_project.Time.EpochTime")
1766c9bb6861Sraviteja-b                         {
1767c9bb6861Sraviteja-b                             for (auto& propertyMap : interfaceMap.second)
1768c9bb6861Sraviteja-b                             {
1769c9bb6861Sraviteja-b                                 if (propertyMap.first == "Elapsed")
1770c9bb6861Sraviteja-b                                 {
1771c9bb6861Sraviteja-b                                     const uint64_t* usecsTimeStamp =
1772c9bb6861Sraviteja-b                                         std::get_if<uint64_t>(
1773c9bb6861Sraviteja-b                                             &propertyMap.second);
1774c9bb6861Sraviteja-b                                     if (usecsTimeStamp == nullptr)
1775c9bb6861Sraviteja-b                                     {
1776c9bb6861Sraviteja-b                                         messages::propertyMissing(
1777c9bb6861Sraviteja-b                                             asyncResp->res, "Elapsed");
1778c9bb6861Sraviteja-b                                         break;
1779c9bb6861Sraviteja-b                                     }
1780c9bb6861Sraviteja-b                                     getTimestampStr(*usecsTimeStamp, timestamp);
1781c9bb6861Sraviteja-b                                     break;
1782c9bb6861Sraviteja-b                                 }
1783c9bb6861Sraviteja-b                             }
1784c9bb6861Sraviteja-b                         }
1785c9bb6861Sraviteja-b                     }
1786c9bb6861Sraviteja-b                     asyncResp->res.jsonValue = {
1787c9bb6861Sraviteja-b                         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1788c9bb6861Sraviteja-b                         {"@odata.id",
1789c9bb6861Sraviteja-b                          "/redfish/v1/Systems/system/LogServices/System/"
1790c9bb6861Sraviteja-b                          "Entries/" +
1791c9bb6861Sraviteja-b                              entryID},
1792c9bb6861Sraviteja-b                         {"Name", "System Dump Entry"},
1793c9bb6861Sraviteja-b                         {"Id", entryID},
1794c9bb6861Sraviteja-b                         {"SizeInB", size},
1795c9bb6861Sraviteja-b                         {"EntryType", "Dump"},
1796c9bb6861Sraviteja-b                         {"EntryCode", "User generated dump"},
1797c9bb6861Sraviteja-b                         {"Created", timestamp}};
1798c9bb6861Sraviteja-b 
1799c9bb6861Sraviteja-b                     asyncResp->res
1800c9bb6861Sraviteja-b                         .jsonValue["Actions"]["#LogEntry.DownloadLog"] = {
1801c9bb6861Sraviteja-b                         {"target",
1802c9bb6861Sraviteja-b                          "/redfish/v1/Systems/system/LogServices/System/"
1803c9bb6861Sraviteja-b                          "Entries/" +
1804c9bb6861Sraviteja-b                              entryID + "/Actions/LogEntry.DownloadLog"}};
1805c9bb6861Sraviteja-b                 }
1806c9bb6861Sraviteja-b             },
1807c9bb6861Sraviteja-b             "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
1808c9bb6861Sraviteja-b             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1809c9bb6861Sraviteja-b     }
1810c9bb6861Sraviteja-b 
1811c9bb6861Sraviteja-b     void doDelete(crow::Response& res, const crow::Request& req,
1812c9bb6861Sraviteja-b                   const std::vector<std::string>& params) override
1813c9bb6861Sraviteja-b     {
1814c9bb6861Sraviteja-b         BMCWEB_LOG_DEBUG << "Do delete single dump entry";
1815c9bb6861Sraviteja-b 
1816c9bb6861Sraviteja-b         auto asyncResp = std::make_shared<AsyncResp>(res);
1817c9bb6861Sraviteja-b 
1818c9bb6861Sraviteja-b         if (params.size() != 1)
1819c9bb6861Sraviteja-b         {
1820c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
1821c9bb6861Sraviteja-b             return;
1822c9bb6861Sraviteja-b         }
1823c9bb6861Sraviteja-b         std::string entryID = params[0];
1824c9bb6861Sraviteja-b 
1825c9bb6861Sraviteja-b         crow::connections::systemBus->async_method_call(
1826c9bb6861Sraviteja-b             [asyncResp,
1827c9bb6861Sraviteja-b              entryID](const boost::system::error_code ec,
1828c9bb6861Sraviteja-b                       const crow::openbmc_mapper::GetSubTreeType& resp) {
1829c9bb6861Sraviteja-b                 if (ec)
1830c9bb6861Sraviteja-b                 {
1831c9bb6861Sraviteja-b                     BMCWEB_LOG_ERROR << " resp_handler got error " << ec;
1832c9bb6861Sraviteja-b                     messages::internalError(asyncResp->res);
1833c9bb6861Sraviteja-b                     return;
1834c9bb6861Sraviteja-b                 }
1835c9bb6861Sraviteja-b 
1836c9bb6861Sraviteja-b                 for (auto& object : resp)
1837c9bb6861Sraviteja-b                 {
1838c9bb6861Sraviteja-b                     const std::string& path =
1839c9bb6861Sraviteja-b                         static_cast<const std::string&>(object.first);
1840c9bb6861Sraviteja-b 
1841c9bb6861Sraviteja-b                     std::size_t pos = path.rfind(
1842c9bb6861Sraviteja-b                         "/xyz/openbmc_project/dump/entry/" + entryID);
1843c9bb6861Sraviteja-b                     if (pos != std::string::npos)
1844c9bb6861Sraviteja-b                     {
1845c9bb6861Sraviteja-b                         deleteSystemDumpEntry(asyncResp->res, entryID);
1846c9bb6861Sraviteja-b                         return;
1847c9bb6861Sraviteja-b                     }
1848c9bb6861Sraviteja-b                 }
1849c9bb6861Sraviteja-b             },
1850c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper",
1851c9bb6861Sraviteja-b             "/xyz/openbmc_project/object_mapper",
1852c9bb6861Sraviteja-b             "xyz.openbmc_project.ObjectMapper", "GetSubTree",
1853c9bb6861Sraviteja-b             "/xyz/openbmc_project/dump", 0,
1854c9bb6861Sraviteja-b             std::array<const char*, 1>{
1855c9bb6861Sraviteja-b                 "xyz.openbmc_project.Dump.Entry.System"});
1856c9bb6861Sraviteja-b     }
1857c9bb6861Sraviteja-b };
1858c9bb6861Sraviteja-b 
18590657843aSraviteja-b class SystemDumpEntryDownload : public Node
18600657843aSraviteja-b {
18610657843aSraviteja-b   public:
18620657843aSraviteja-b     SystemDumpEntryDownload(CrowApp& app) :
18630657843aSraviteja-b         Node(app,
18640657843aSraviteja-b              "/redfish/v1/Systems/system/LogServices/System/Entries/<str>/"
18650657843aSraviteja-b              "Actions/"
18660657843aSraviteja-b              "LogEntry.DownloadLog/",
18670657843aSraviteja-b              std::string())
18680657843aSraviteja-b     {
18690657843aSraviteja-b         entityPrivileges = {
18700657843aSraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
18710657843aSraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
18720657843aSraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
18730657843aSraviteja-b     }
18740657843aSraviteja-b 
18750657843aSraviteja-b   private:
18760657843aSraviteja-b     void doPost(crow::Response& res, const crow::Request& req,
18770657843aSraviteja-b                 const std::vector<std::string>& params) override
18780657843aSraviteja-b     {
18790657843aSraviteja-b         if (params.size() != 1)
18800657843aSraviteja-b         {
18810657843aSraviteja-b             messages::internalError(res);
18820657843aSraviteja-b             return;
18830657843aSraviteja-b         }
18840657843aSraviteja-b         const std::string& entryID = params[0];
18850657843aSraviteja-b         crow::obmc_dump::handleDumpOffloadUrl(req, res, entryID);
18860657843aSraviteja-b     }
18870657843aSraviteja-b };
18880657843aSraviteja-b 
1889013487e5Sraviteja-b class SystemDumpClear : public Node
1890013487e5Sraviteja-b {
1891013487e5Sraviteja-b   public:
1892013487e5Sraviteja-b     SystemDumpClear(CrowApp& app) :
1893013487e5Sraviteja-b         Node(app, "/redfish/v1/Systems/system/LogServices/System/"
1894013487e5Sraviteja-b                   "Actions/"
1895013487e5Sraviteja-b                   "LogService.ClearLog/")
1896013487e5Sraviteja-b     {
1897013487e5Sraviteja-b         entityPrivileges = {
1898013487e5Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
1899013487e5Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
1900013487e5Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1901013487e5Sraviteja-b     }
1902013487e5Sraviteja-b 
1903013487e5Sraviteja-b   private:
1904013487e5Sraviteja-b     void doPost(crow::Response& res, const crow::Request& req,
1905013487e5Sraviteja-b                 const std::vector<std::string>& params) override
1906013487e5Sraviteja-b     {
1907013487e5Sraviteja-b 
1908013487e5Sraviteja-b         auto asyncResp = std::make_shared<AsyncResp>(res);
1909013487e5Sraviteja-b         crow::connections::systemBus->async_method_call(
1910013487e5Sraviteja-b             [asyncResp](const boost::system::error_code ec,
1911013487e5Sraviteja-b                         const std::vector<std::string>& dumpList) {
1912013487e5Sraviteja-b                 if (ec)
1913013487e5Sraviteja-b                 {
1914013487e5Sraviteja-b                     messages::internalError(asyncResp->res);
1915013487e5Sraviteja-b                     return;
1916013487e5Sraviteja-b                 }
1917013487e5Sraviteja-b 
1918013487e5Sraviteja-b                 for (const std::string& objectPath : dumpList)
1919013487e5Sraviteja-b                 {
1920013487e5Sraviteja-b                     std::size_t pos = objectPath.rfind("/");
1921013487e5Sraviteja-b                     if (pos != std::string::npos)
1922013487e5Sraviteja-b                     {
1923013487e5Sraviteja-b                         std::string logID = objectPath.substr(pos + 1);
1924013487e5Sraviteja-b                         deleteSystemDumpEntry(asyncResp->res, logID);
1925013487e5Sraviteja-b                     }
1926013487e5Sraviteja-b                 }
1927013487e5Sraviteja-b             },
1928013487e5Sraviteja-b             "xyz.openbmc_project.ObjectMapper",
1929013487e5Sraviteja-b             "/xyz/openbmc_project/object_mapper",
1930013487e5Sraviteja-b             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
1931013487e5Sraviteja-b             "/xyz/openbmc_project/dump", 0,
1932013487e5Sraviteja-b             std::array<const char*, 1>{
1933013487e5Sraviteja-b                 "xyz.openbmc_project.Dump.Entry.System"});
1934013487e5Sraviteja-b     }
1935013487e5Sraviteja-b };
1936013487e5Sraviteja-b 
1937424c4176SJason M. Bills class CrashdumpService : public Node
1938e1f26343SJason M. Bills {
1939e1f26343SJason M. Bills   public:
1940e1f26343SJason M. Bills     template <typename CrowApp>
1941424c4176SJason M. Bills     CrashdumpService(CrowApp& app) :
1942424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
19431da66f75SEd Tanous     {
19443946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
19453946028dSAppaRao Puli         // method for security reasons.
19461da66f75SEd Tanous         entityPrivileges = {
19473946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
19483946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
1949e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1950e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1951e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1952e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
19531da66f75SEd Tanous     }
19541da66f75SEd Tanous 
19551da66f75SEd Tanous   private:
19561da66f75SEd Tanous     /**
19571da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
19581da66f75SEd Tanous      */
19591da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
19601da66f75SEd Tanous                const std::vector<std::string>& params) override
19611da66f75SEd Tanous     {
1962e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
19631da66f75SEd Tanous         // Copy over the static data to include the entries added by SubRoute
19640f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
1965424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
1966e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1967e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
19684f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
19694f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
19704f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
1971e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1972e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
1973cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1974cd50aa42SJason M. Bills             {"@odata.id",
1975424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
1976e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"] = {
19775b61b5e8SJason M. Bills             {"#LogService.ClearLog",
19785b61b5e8SJason M. Bills              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
19795b61b5e8SJason M. Bills                          "Actions/LogService.ClearLog"}}},
19801da66f75SEd Tanous             {"Oem",
1981424c4176SJason M. Bills              {{"#Crashdump.OnDemand",
1982424c4176SJason M. Bills                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
1983424c4176SJason M. Bills                            "Actions/Oem/Crashdump.OnDemand"}}}}}};
19841da66f75SEd Tanous 
19851da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI
1986e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"]["Oem"].push_back(
1987424c4176SJason M. Bills             {"#Crashdump.SendRawPeci",
198808a4e4b5SAnthony Wilson              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
1989424c4176SJason M. Bills                          "Actions/Oem/Crashdump.SendRawPeci"}}});
19901da66f75SEd Tanous #endif
19911da66f75SEd Tanous     }
19921da66f75SEd Tanous };
19931da66f75SEd Tanous 
19945b61b5e8SJason M. Bills class CrashdumpClear : public Node
19955b61b5e8SJason M. Bills {
19965b61b5e8SJason M. Bills   public:
19975b61b5e8SJason M. Bills     CrashdumpClear(CrowApp& app) :
19985b61b5e8SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
19995b61b5e8SJason M. Bills                   "LogService.ClearLog/")
20005b61b5e8SJason M. Bills     {
20013946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
20023946028dSAppaRao Puli         // method for security reasons.
20035b61b5e8SJason M. Bills         entityPrivileges = {
20043946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
20053946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
20065b61b5e8SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
20075b61b5e8SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
20085b61b5e8SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
20095b61b5e8SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
20105b61b5e8SJason M. Bills     }
20115b61b5e8SJason M. Bills 
20125b61b5e8SJason M. Bills   private:
20135b61b5e8SJason M. Bills     void doPost(crow::Response& res, const crow::Request& req,
20145b61b5e8SJason M. Bills                 const std::vector<std::string>& params) override
20155b61b5e8SJason M. Bills     {
20165b61b5e8SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
20175b61b5e8SJason M. Bills 
20185b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
20195b61b5e8SJason M. Bills             [asyncResp](const boost::system::error_code ec,
20205b61b5e8SJason M. Bills                         const std::string& resp) {
20215b61b5e8SJason M. Bills                 if (ec)
20225b61b5e8SJason M. Bills                 {
20235b61b5e8SJason M. Bills                     messages::internalError(asyncResp->res);
20245b61b5e8SJason M. Bills                     return;
20255b61b5e8SJason M. Bills                 }
20265b61b5e8SJason M. Bills                 messages::success(asyncResp->res);
20275b61b5e8SJason M. Bills             },
20285b61b5e8SJason M. Bills             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
20295b61b5e8SJason M. Bills     }
20305b61b5e8SJason M. Bills };
20315b61b5e8SJason M. Bills 
2032e855dd28SJason M. Bills static void logCrashdumpEntry(std::shared_ptr<AsyncResp> asyncResp,
2033e855dd28SJason M. Bills                               const std::string& logID,
2034e855dd28SJason M. Bills                               nlohmann::json& logEntryJson)
2035e855dd28SJason M. Bills {
2036043a0536SJohnathan Mantey     auto getStoredLogCallback =
2037043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2038e855dd28SJason M. Bills             const boost::system::error_code ec,
2039043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>>& params) {
2040e855dd28SJason M. Bills             if (ec)
2041e855dd28SJason M. Bills             {
2042e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
20431ddcf01aSJason M. Bills                 if (ec.value() ==
20441ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
20451ddcf01aSJason M. Bills                 {
2046043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2047043a0536SJohnathan Mantey                                                logID);
20481ddcf01aSJason M. Bills                 }
20491ddcf01aSJason M. Bills                 else
20501ddcf01aSJason M. Bills                 {
2051e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
20521ddcf01aSJason M. Bills                 }
2053e855dd28SJason M. Bills                 return;
2054e855dd28SJason M. Bills             }
2055043a0536SJohnathan Mantey 
2056043a0536SJohnathan Mantey             std::string timestamp{};
2057043a0536SJohnathan Mantey             std::string filename{};
2058043a0536SJohnathan Mantey             std::string logfile{};
2059043a0536SJohnathan Mantey             ParseCrashdumpParameters(params, filename, timestamp, logfile);
2060043a0536SJohnathan Mantey 
2061043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2062e855dd28SJason M. Bills             {
2063043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2064e855dd28SJason M. Bills                 return;
2065e855dd28SJason M. Bills             }
2066e855dd28SJason M. Bills 
2067043a0536SJohnathan Mantey             std::string crashdumpURI =
2068e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2069043a0536SJohnathan Mantey                 logID + "/" + filename;
2070043a0536SJohnathan Mantey             logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2071043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2072043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2073e855dd28SJason M. Bills                                               logID},
2074e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2075e855dd28SJason M. Bills                             {"Id", logID},
2076e855dd28SJason M. Bills                             {"EntryType", "Oem"},
2077e855dd28SJason M. Bills                             {"OemRecordFormat", "Crashdump URI"},
2078043a0536SJohnathan Mantey                             {"Message", std::move(crashdumpURI)},
2079043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2080e855dd28SJason M. Bills         };
2081e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
20825b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
20835b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2084043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2085e855dd28SJason M. Bills }
2086e855dd28SJason M. Bills 
2087424c4176SJason M. Bills class CrashdumpEntryCollection : public Node
20881da66f75SEd Tanous {
20891da66f75SEd Tanous   public:
20901da66f75SEd Tanous     template <typename CrowApp>
2091424c4176SJason M. Bills     CrashdumpEntryCollection(CrowApp& app) :
2092424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
20931da66f75SEd Tanous     {
20943946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
20953946028dSAppaRao Puli         // method for security reasons.
20961da66f75SEd Tanous         entityPrivileges = {
20973946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
20983946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2099e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2100e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2101e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2102e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
21031da66f75SEd Tanous     }
21041da66f75SEd Tanous 
21051da66f75SEd Tanous   private:
21061da66f75SEd Tanous     /**
21071da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
21081da66f75SEd Tanous      */
21091da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
21101da66f75SEd Tanous                const std::vector<std::string>& params) override
21111da66f75SEd Tanous     {
2112e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
21131da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
21141da66f75SEd Tanous         // it has a duplicate entry for members
2115e1f26343SJason M. Bills         auto getLogEntriesCallback = [asyncResp](
2116e1f26343SJason M. Bills                                          const boost::system::error_code ec,
21171da66f75SEd Tanous                                          const std::vector<std::string>& resp) {
21181da66f75SEd Tanous             if (ec)
21191da66f75SEd Tanous             {
21201da66f75SEd Tanous                 if (ec.value() !=
21211da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
21221da66f75SEd Tanous                 {
21231da66f75SEd Tanous                     BMCWEB_LOG_DEBUG << "failed to get entries ec: "
21241da66f75SEd Tanous                                      << ec.message();
2125f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
21261da66f75SEd Tanous                     return;
21271da66f75SEd Tanous                 }
21281da66f75SEd Tanous             }
2129e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
21301da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
21310f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2132424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2133424c4176SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2134e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2135424c4176SJason M. Bills                 "Collection of Crashdump Entries";
2136e1f26343SJason M. Bills             nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2137e1f26343SJason M. Bills             logEntryArray = nlohmann::json::array();
2138e855dd28SJason M. Bills             std::vector<std::string> logIDs;
2139e855dd28SJason M. Bills             // Get the list of log entries and build up an empty array big
2140e855dd28SJason M. Bills             // enough to hold them
21411da66f75SEd Tanous             for (const std::string& objpath : resp)
21421da66f75SEd Tanous             {
2143e855dd28SJason M. Bills                 // Get the log ID
21444ed77cd5SEd Tanous                 std::size_t lastPos = objpath.rfind("/");
2145e855dd28SJason M. Bills                 if (lastPos == std::string::npos)
21461da66f75SEd Tanous                 {
2147e855dd28SJason M. Bills                     continue;
21481da66f75SEd Tanous                 }
2149e855dd28SJason M. Bills                 logIDs.emplace_back(objpath.substr(lastPos + 1));
2150e855dd28SJason M. Bills 
2151e855dd28SJason M. Bills                 // Add a space for the log entry to the array
2152e855dd28SJason M. Bills                 logEntryArray.push_back({});
2153e855dd28SJason M. Bills             }
2154e855dd28SJason M. Bills             // Now go through and set up async calls to fill in the entries
2155e855dd28SJason M. Bills             size_t index = 0;
2156e855dd28SJason M. Bills             for (const std::string& logID : logIDs)
2157e855dd28SJason M. Bills             {
2158e855dd28SJason M. Bills                 // Add the log entry to the array
2159e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
21601da66f75SEd Tanous             }
2161e1f26343SJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
2162e1f26343SJason M. Bills                 logEntryArray.size();
21631da66f75SEd Tanous         };
21641da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
21651da66f75SEd Tanous             std::move(getLogEntriesCallback),
21661da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper",
21671da66f75SEd Tanous             "/xyz/openbmc_project/object_mapper",
21681da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
21695b61b5e8SJason M. Bills             std::array<const char*, 1>{crashdumpInterface});
21701da66f75SEd Tanous     }
21711da66f75SEd Tanous };
21721da66f75SEd Tanous 
2173424c4176SJason M. Bills class CrashdumpEntry : public Node
21741da66f75SEd Tanous {
21751da66f75SEd Tanous   public:
2176424c4176SJason M. Bills     CrashdumpEntry(CrowApp& app) :
2177d53dd41fSJason M. Bills         Node(app,
2178424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/",
21791da66f75SEd Tanous              std::string())
21801da66f75SEd Tanous     {
21813946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
21823946028dSAppaRao Puli         // method for security reasons.
21831da66f75SEd Tanous         entityPrivileges = {
21843946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
21853946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2186e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2187e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2188e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2189e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
21901da66f75SEd Tanous     }
21911da66f75SEd Tanous 
21921da66f75SEd Tanous   private:
21931da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
21941da66f75SEd Tanous                const std::vector<std::string>& params) override
21951da66f75SEd Tanous     {
2196e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
21971da66f75SEd Tanous         if (params.size() != 1)
21981da66f75SEd Tanous         {
2199f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
22001da66f75SEd Tanous             return;
22011da66f75SEd Tanous         }
2202e855dd28SJason M. Bills         const std::string& logID = params[0];
2203e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
2204e855dd28SJason M. Bills     }
2205e855dd28SJason M. Bills };
2206e855dd28SJason M. Bills 
2207e855dd28SJason M. Bills class CrashdumpFile : public Node
2208e855dd28SJason M. Bills {
2209e855dd28SJason M. Bills   public:
2210e855dd28SJason M. Bills     CrashdumpFile(CrowApp& app) :
2211e855dd28SJason M. Bills         Node(app,
2212e855dd28SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/"
2213e855dd28SJason M. Bills              "<str>/",
2214e855dd28SJason M. Bills              std::string(), std::string())
2215e855dd28SJason M. Bills     {
22163946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
22173946028dSAppaRao Puli         // method for security reasons.
2218e855dd28SJason M. Bills         entityPrivileges = {
22193946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
22203946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2221e855dd28SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2222e855dd28SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2223e855dd28SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2224e855dd28SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2225e855dd28SJason M. Bills     }
2226e855dd28SJason M. Bills 
2227e855dd28SJason M. Bills   private:
2228e855dd28SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
2229e855dd28SJason M. Bills                const std::vector<std::string>& params) override
2230e855dd28SJason M. Bills     {
2231e855dd28SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2232e855dd28SJason M. Bills         if (params.size() != 2)
2233e855dd28SJason M. Bills         {
2234e855dd28SJason M. Bills             messages::internalError(asyncResp->res);
2235e855dd28SJason M. Bills             return;
2236e855dd28SJason M. Bills         }
2237e855dd28SJason M. Bills         const std::string& logID = params[0];
2238e855dd28SJason M. Bills         const std::string& fileName = params[1];
2239e855dd28SJason M. Bills 
2240043a0536SJohnathan Mantey         auto getStoredLogCallback =
2241043a0536SJohnathan Mantey             [asyncResp, logID, fileName](
2242abf2add6SEd Tanous                 const boost::system::error_code ec,
2243043a0536SJohnathan Mantey                 const std::vector<std::pair<std::string, VariantType>>& resp) {
22441da66f75SEd Tanous                 if (ec)
22451da66f75SEd Tanous                 {
2246043a0536SJohnathan Mantey                     BMCWEB_LOG_DEBUG << "failed to get log ec: "
2247043a0536SJohnathan Mantey                                      << ec.message();
2248f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
22491da66f75SEd Tanous                     return;
22501da66f75SEd Tanous                 }
2251e855dd28SJason M. Bills 
2252043a0536SJohnathan Mantey                 std::string dbusFilename{};
2253043a0536SJohnathan Mantey                 std::string dbusTimestamp{};
2254043a0536SJohnathan Mantey                 std::string dbusFilepath{};
2255043a0536SJohnathan Mantey 
2256043a0536SJohnathan Mantey                 ParseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
2257043a0536SJohnathan Mantey                                          dbusFilepath);
2258043a0536SJohnathan Mantey 
2259043a0536SJohnathan Mantey                 if (dbusFilename.empty() || dbusTimestamp.empty() ||
2260043a0536SJohnathan Mantey                     dbusFilepath.empty())
22611da66f75SEd Tanous                 {
2262e855dd28SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, fileName);
22631da66f75SEd Tanous                     return;
22641da66f75SEd Tanous                 }
2265e855dd28SJason M. Bills 
2266043a0536SJohnathan Mantey                 // Verify the file name parameter is correct
2267043a0536SJohnathan Mantey                 if (fileName != dbusFilename)
2268043a0536SJohnathan Mantey                 {
2269043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2270043a0536SJohnathan Mantey                     return;
2271043a0536SJohnathan Mantey                 }
2272043a0536SJohnathan Mantey 
2273043a0536SJohnathan Mantey                 if (!std::filesystem::exists(dbusFilepath))
2274043a0536SJohnathan Mantey                 {
2275043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2276043a0536SJohnathan Mantey                     return;
2277043a0536SJohnathan Mantey                 }
2278043a0536SJohnathan Mantey                 std::ifstream ifs(dbusFilepath, std::ios::in |
2279043a0536SJohnathan Mantey                                                     std::ios::binary |
2280043a0536SJohnathan Mantey                                                     std::ios::ate);
2281043a0536SJohnathan Mantey                 std::ifstream::pos_type fileSize = ifs.tellg();
2282043a0536SJohnathan Mantey                 if (fileSize < 0)
2283043a0536SJohnathan Mantey                 {
2284043a0536SJohnathan Mantey                     messages::generalError(asyncResp->res);
2285043a0536SJohnathan Mantey                     return;
2286043a0536SJohnathan Mantey                 }
2287043a0536SJohnathan Mantey                 ifs.seekg(0, std::ios::beg);
2288043a0536SJohnathan Mantey 
2289043a0536SJohnathan Mantey                 auto crashData = std::make_unique<char[]>(
2290043a0536SJohnathan Mantey                     static_cast<unsigned int>(fileSize));
2291043a0536SJohnathan Mantey 
2292043a0536SJohnathan Mantey                 ifs.read(crashData.get(), static_cast<int>(fileSize));
2293043a0536SJohnathan Mantey 
2294043a0536SJohnathan Mantey                 // The cast to std::string is intentional in order to use the
2295043a0536SJohnathan Mantey                 // assign() that applies move mechanics
2296043a0536SJohnathan Mantey                 asyncResp->res.body().assign(
2297043a0536SJohnathan Mantey                     static_cast<std::string>(crashData.get()));
2298043a0536SJohnathan Mantey 
2299043a0536SJohnathan Mantey                 // Configure this to be a file download when accessed from
2300043a0536SJohnathan Mantey                 // a browser
2301e855dd28SJason M. Bills                 asyncResp->res.addHeader("Content-Disposition", "attachment");
23021da66f75SEd Tanous             };
23031da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
23045b61b5e8SJason M. Bills             std::move(getStoredLogCallback), crashdumpObject,
23055b61b5e8SJason M. Bills             crashdumpPath + std::string("/") + logID,
2306043a0536SJohnathan Mantey             "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
23071da66f75SEd Tanous     }
23081da66f75SEd Tanous };
23091da66f75SEd Tanous 
2310424c4176SJason M. Bills class OnDemandCrashdump : public Node
23111da66f75SEd Tanous {
23121da66f75SEd Tanous   public:
2313424c4176SJason M. Bills     OnDemandCrashdump(CrowApp& app) :
2314424c4176SJason M. Bills         Node(app,
2315424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2316424c4176SJason M. Bills              "Crashdump.OnDemand/")
23171da66f75SEd Tanous     {
23183946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
23193946028dSAppaRao Puli         // method for security reasons.
23201da66f75SEd Tanous         entityPrivileges = {
23213946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
23223946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
23233946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
23243946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
23253946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
23263946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
23271da66f75SEd Tanous     }
23281da66f75SEd Tanous 
23291da66f75SEd Tanous   private:
23301da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
23311da66f75SEd Tanous                 const std::vector<std::string>& params) override
23321da66f75SEd Tanous     {
2333e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
23341da66f75SEd Tanous 
2335fe306728SJames Feist         auto generateonDemandLogCallback = [asyncResp,
2336fe306728SJames Feist                                             req](const boost::system::error_code
233746229577SJames Feist                                                      ec,
23381da66f75SEd Tanous                                                  const std::string& resp) {
23391da66f75SEd Tanous             if (ec)
23401da66f75SEd Tanous             {
234146229577SJames Feist                 if (ec.value() == boost::system::errc::operation_not_supported)
23421da66f75SEd Tanous                 {
2343f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
23441da66f75SEd Tanous                 }
23454363d3b2SJason M. Bills                 else if (ec.value() ==
23464363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
23474363d3b2SJason M. Bills                 {
23484363d3b2SJason M. Bills                     messages::serviceTemporarilyUnavailable(asyncResp->res,
23494363d3b2SJason M. Bills                                                             "60");
23504363d3b2SJason M. Bills                 }
23511da66f75SEd Tanous                 else
23521da66f75SEd Tanous                 {
2353f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
23541da66f75SEd Tanous                 }
23551da66f75SEd Tanous                 return;
23561da66f75SEd Tanous             }
235746229577SJames Feist             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
235866afe4faSJames Feist                 [](boost::system::error_code err, sdbusplus::message::message&,
235966afe4faSJames Feist                    const std::shared_ptr<task::TaskData>& taskData) {
236066afe4faSJames Feist                     if (!err)
236166afe4faSJames Feist                     {
2362e5d5006bSJames Feist                         taskData->messages.emplace_back(
2363e5d5006bSJames Feist                             messages::taskCompletedOK(
2364e5d5006bSJames Feist                                 std::to_string(taskData->index)));
2365831d6b09SJames Feist                         taskData->state = "Completed";
236666afe4faSJames Feist                     }
236732898ceaSJames Feist                     return task::completed;
236866afe4faSJames Feist                 },
236946229577SJames Feist                 "type='signal',interface='org.freedesktop.DBus.Properties',"
237046229577SJames Feist                 "member='PropertiesChanged',arg0namespace='com.intel."
237146229577SJames Feist                 "crashdump'");
237246229577SJames Feist             task->startTimer(std::chrono::minutes(5));
237346229577SJames Feist             task->populateResp(asyncResp->res);
2374fe306728SJames Feist             task->payload.emplace(req);
23751da66f75SEd Tanous         };
23761da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
23775b61b5e8SJason M. Bills             std::move(generateonDemandLogCallback), crashdumpObject,
23785b61b5e8SJason M. Bills             crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog");
23791da66f75SEd Tanous     }
23801da66f75SEd Tanous };
23811da66f75SEd Tanous 
2382e1f26343SJason M. Bills class SendRawPECI : public Node
23831da66f75SEd Tanous {
23841da66f75SEd Tanous   public:
2385e1f26343SJason M. Bills     SendRawPECI(CrowApp& app) :
2386424c4176SJason M. Bills         Node(app,
2387424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2388424c4176SJason M. Bills              "Crashdump.SendRawPeci/")
23891da66f75SEd Tanous     {
23903946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
23913946028dSAppaRao Puli         // method for security reasons.
23921da66f75SEd Tanous         entityPrivileges = {
23931da66f75SEd Tanous             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
23941da66f75SEd Tanous             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
23951da66f75SEd Tanous             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
23961da66f75SEd Tanous             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
23971da66f75SEd Tanous             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
23981da66f75SEd Tanous             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
23991da66f75SEd Tanous     }
24001da66f75SEd Tanous 
24011da66f75SEd Tanous   private:
24021da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
24031da66f75SEd Tanous                 const std::vector<std::string>& params) override
24041da66f75SEd Tanous     {
2405e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
24068724c297SKarthick Sundarrajan         std::vector<std::vector<uint8_t>> peciCommands;
24078724c297SKarthick Sundarrajan 
24088724c297SKarthick Sundarrajan         nlohmann::json reqJson =
24098724c297SKarthick Sundarrajan             nlohmann::json::parse(req.body, nullptr, false);
24108724c297SKarthick Sundarrajan         if (reqJson.find("PECICommands") != reqJson.end())
24118724c297SKarthick Sundarrajan         {
24128724c297SKarthick Sundarrajan             if (!json_util::readJson(req, res, "PECICommands", peciCommands))
24138724c297SKarthick Sundarrajan             {
24148724c297SKarthick Sundarrajan                 return;
24158724c297SKarthick Sundarrajan             }
24168724c297SKarthick Sundarrajan             uint32_t idx = 0;
24178724c297SKarthick Sundarrajan             for (auto const& cmd : peciCommands)
24188724c297SKarthick Sundarrajan             {
24198724c297SKarthick Sundarrajan                 if (cmd.size() < 3)
24208724c297SKarthick Sundarrajan                 {
24218724c297SKarthick Sundarrajan                     std::string s("[");
24228724c297SKarthick Sundarrajan                     for (auto const& val : cmd)
24238724c297SKarthick Sundarrajan                     {
24248724c297SKarthick Sundarrajan                         if (val != *cmd.begin())
24258724c297SKarthick Sundarrajan                         {
24268724c297SKarthick Sundarrajan                             s += ",";
24278724c297SKarthick Sundarrajan                         }
24288724c297SKarthick Sundarrajan                         s += std::to_string(val);
24298724c297SKarthick Sundarrajan                     }
24308724c297SKarthick Sundarrajan                     s += "]";
24318724c297SKarthick Sundarrajan                     messages::actionParameterValueFormatError(
24328724c297SKarthick Sundarrajan                         res, s, "PECICommands[" + std::to_string(idx) + "]",
24338724c297SKarthick Sundarrajan                         "SendRawPeci");
24348724c297SKarthick Sundarrajan                     return;
24358724c297SKarthick Sundarrajan                 }
24368724c297SKarthick Sundarrajan                 idx++;
24378724c297SKarthick Sundarrajan             }
24388724c297SKarthick Sundarrajan         }
24398724c297SKarthick Sundarrajan         else
24408724c297SKarthick Sundarrajan         {
24418724c297SKarthick Sundarrajan             /* This interface is deprecated */
2442b1556427SEd Tanous             uint8_t clientAddress = 0;
2443b1556427SEd Tanous             uint8_t readLength = 0;
24441da66f75SEd Tanous             std::vector<uint8_t> peciCommand;
2445b1556427SEd Tanous             if (!json_util::readJson(req, res, "ClientAddress", clientAddress,
2446b1556427SEd Tanous                                      "ReadLength", readLength, "PECICommand",
2447b1556427SEd Tanous                                      peciCommand))
24481da66f75SEd Tanous             {
24491da66f75SEd Tanous                 return;
24501da66f75SEd Tanous             }
24518724c297SKarthick Sundarrajan             peciCommands.push_back({clientAddress, 0, readLength});
24528724c297SKarthick Sundarrajan             peciCommands[0].insert(peciCommands[0].end(), peciCommand.begin(),
24538724c297SKarthick Sundarrajan                                    peciCommand.end());
24548724c297SKarthick Sundarrajan         }
24551da66f75SEd Tanous         // Callback to return the Raw PECI response
2456e1f26343SJason M. Bills         auto sendRawPECICallback =
2457e1f26343SJason M. Bills             [asyncResp](const boost::system::error_code ec,
24588724c297SKarthick Sundarrajan                         const std::vector<std::vector<uint8_t>>& resp) {
24591da66f75SEd Tanous                 if (ec)
24601da66f75SEd Tanous                 {
24618724c297SKarthick Sundarrajan                     BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: "
24621da66f75SEd Tanous                                      << ec.message();
2463f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
24641da66f75SEd Tanous                     return;
24651da66f75SEd Tanous                 }
2466e1f26343SJason M. Bills                 asyncResp->res.jsonValue = {{"Name", "PECI Command Response"},
24671da66f75SEd Tanous                                             {"PECIResponse", resp}};
24681da66f75SEd Tanous             };
24691da66f75SEd Tanous         // Call the SendRawPECI command with the provided data
24701da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
24715b61b5e8SJason M. Bills             std::move(sendRawPECICallback), crashdumpObject, crashdumpPath,
24728724c297SKarthick Sundarrajan             crashdumpRawPECIInterface, "SendRawPeci", peciCommands);
24731da66f75SEd Tanous     }
24741da66f75SEd Tanous };
24751da66f75SEd Tanous 
2476cb92c03bSAndrew Geissler /**
2477cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
2478cb92c03bSAndrew Geissler  */
2479cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node
2480cb92c03bSAndrew Geissler {
2481cb92c03bSAndrew Geissler   public:
2482cb92c03bSAndrew Geissler     DBusLogServiceActionsClear(CrowApp& app) :
2483cb92c03bSAndrew Geissler         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
24847af91514SGunnar Mills                   "LogService.ClearLog/")
2485cb92c03bSAndrew Geissler     {
2486cb92c03bSAndrew Geissler         entityPrivileges = {
2487cb92c03bSAndrew Geissler             {boost::beast::http::verb::get, {{"Login"}}},
2488cb92c03bSAndrew Geissler             {boost::beast::http::verb::head, {{"Login"}}},
2489cb92c03bSAndrew Geissler             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2490cb92c03bSAndrew Geissler             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2491cb92c03bSAndrew Geissler             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2492cb92c03bSAndrew Geissler             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2493cb92c03bSAndrew Geissler     }
2494cb92c03bSAndrew Geissler 
2495cb92c03bSAndrew Geissler   private:
2496cb92c03bSAndrew Geissler     /**
2497cb92c03bSAndrew Geissler      * Function handles POST method request.
2498cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
2499cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
2500cb92c03bSAndrew Geissler      */
2501cb92c03bSAndrew Geissler     void doPost(crow::Response& res, const crow::Request& req,
2502cb92c03bSAndrew Geissler                 const std::vector<std::string>& params) override
2503cb92c03bSAndrew Geissler     {
2504cb92c03bSAndrew Geissler         BMCWEB_LOG_DEBUG << "Do delete all entries.";
2505cb92c03bSAndrew Geissler 
2506cb92c03bSAndrew Geissler         auto asyncResp = std::make_shared<AsyncResp>(res);
2507cb92c03bSAndrew Geissler         // Process response from Logging service.
2508cb92c03bSAndrew Geissler         auto resp_handler = [asyncResp](const boost::system::error_code ec) {
2509cb92c03bSAndrew Geissler             BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
2510cb92c03bSAndrew Geissler             if (ec)
2511cb92c03bSAndrew Geissler             {
2512cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
2513cb92c03bSAndrew Geissler                 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
2514cb92c03bSAndrew Geissler                 asyncResp->res.result(
2515cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
2516cb92c03bSAndrew Geissler                 return;
2517cb92c03bSAndrew Geissler             }
2518cb92c03bSAndrew Geissler 
2519cb92c03bSAndrew Geissler             asyncResp->res.result(boost::beast::http::status::no_content);
2520cb92c03bSAndrew Geissler         };
2521cb92c03bSAndrew Geissler 
2522cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
2523cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
2524cb92c03bSAndrew Geissler             resp_handler, "xyz.openbmc_project.Logging",
2525cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
2526cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
2527cb92c03bSAndrew Geissler     }
2528cb92c03bSAndrew Geissler };
2529a3316fc6SZhikuiRen 
2530a3316fc6SZhikuiRen /****************************************************
2531a3316fc6SZhikuiRen  * Redfish PostCode interfaces
2532a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
2533a3316fc6SZhikuiRen  ******************************************************/
2534a3316fc6SZhikuiRen class PostCodesLogService : public Node
2535a3316fc6SZhikuiRen {
2536a3316fc6SZhikuiRen   public:
2537a3316fc6SZhikuiRen     PostCodesLogService(CrowApp& app) :
2538a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
2539a3316fc6SZhikuiRen     {
2540a3316fc6SZhikuiRen         entityPrivileges = {
2541a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2542a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
2543a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2544a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2545a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2546a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2547a3316fc6SZhikuiRen     }
2548a3316fc6SZhikuiRen 
2549a3316fc6SZhikuiRen   private:
2550a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
2551a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
2552a3316fc6SZhikuiRen     {
2553a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2554a3316fc6SZhikuiRen 
2555a3316fc6SZhikuiRen         asyncResp->res.jsonValue = {
2556a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"},
2557a3316fc6SZhikuiRen             {"@odata.type", "#LogService.v1_1_0.LogService"},
2558a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogService.LogService"},
2559a3316fc6SZhikuiRen             {"Name", "POST Code Log Service"},
2560a3316fc6SZhikuiRen             {"Description", "POST Code Log Service"},
2561a3316fc6SZhikuiRen             {"Id", "BIOS POST Code Log"},
2562a3316fc6SZhikuiRen             {"OverWritePolicy", "WrapsWhenFull"},
2563a3316fc6SZhikuiRen             {"Entries",
2564a3316fc6SZhikuiRen              {{"@odata.id",
2565a3316fc6SZhikuiRen                "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
2566a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
2567a3316fc6SZhikuiRen             {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/"
2568a3316fc6SZhikuiRen                        "Actions/LogService.ClearLog"}};
2569a3316fc6SZhikuiRen     }
2570a3316fc6SZhikuiRen };
2571a3316fc6SZhikuiRen 
2572a3316fc6SZhikuiRen class PostCodesClear : public Node
2573a3316fc6SZhikuiRen {
2574a3316fc6SZhikuiRen   public:
2575a3316fc6SZhikuiRen     PostCodesClear(CrowApp& app) :
2576a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
2577a3316fc6SZhikuiRen                   "LogService.ClearLog/")
2578a3316fc6SZhikuiRen     {
2579a3316fc6SZhikuiRen         entityPrivileges = {
2580a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2581a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
25823946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
25833946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
25843946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
25853946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2586a3316fc6SZhikuiRen     }
2587a3316fc6SZhikuiRen 
2588a3316fc6SZhikuiRen   private:
2589a3316fc6SZhikuiRen     void doPost(crow::Response& res, const crow::Request& req,
2590a3316fc6SZhikuiRen                 const std::vector<std::string>& params) override
2591a3316fc6SZhikuiRen     {
2592a3316fc6SZhikuiRen         BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
2593a3316fc6SZhikuiRen 
2594a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2595a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
2596a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
2597a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec) {
2598a3316fc6SZhikuiRen                 if (ec)
2599a3316fc6SZhikuiRen                 {
2600a3316fc6SZhikuiRen                     // TODO Handle for specific error code
2601a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR
2602a3316fc6SZhikuiRen                         << "doClearPostCodes resp_handler got error " << ec;
2603a3316fc6SZhikuiRen                     asyncResp->res.result(
2604a3316fc6SZhikuiRen                         boost::beast::http::status::internal_server_error);
2605a3316fc6SZhikuiRen                     messages::internalError(asyncResp->res);
2606a3316fc6SZhikuiRen                     return;
2607a3316fc6SZhikuiRen                 }
2608a3316fc6SZhikuiRen             },
2609a3316fc6SZhikuiRen             "xyz.openbmc_project.State.Boot.PostCode",
2610a3316fc6SZhikuiRen             "/xyz/openbmc_project/State/Boot/PostCode",
2611a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
2612a3316fc6SZhikuiRen     }
2613a3316fc6SZhikuiRen };
2614a3316fc6SZhikuiRen 
2615a3316fc6SZhikuiRen static void fillPostCodeEntry(
2616a3316fc6SZhikuiRen     std::shared_ptr<AsyncResp> aResp,
2617a3316fc6SZhikuiRen     const boost::container::flat_map<uint64_t, uint64_t>& postcode,
2618a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
2619a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
2620a3316fc6SZhikuiRen {
2621a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
2622a3316fc6SZhikuiRen     const message_registries::Message* message =
2623a3316fc6SZhikuiRen         message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode");
2624a3316fc6SZhikuiRen 
2625a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
2626a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
2627a3316fc6SZhikuiRen 
2628a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
2629a3316fc6SZhikuiRen     for (const std::pair<uint64_t, uint64_t>& code : postcode)
2630a3316fc6SZhikuiRen     {
2631a3316fc6SZhikuiRen         currentCodeIndex++;
2632a3316fc6SZhikuiRen         std::string postcodeEntryID =
2633a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
2634a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
2635a3316fc6SZhikuiRen 
2636a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
2637a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
2638a3316fc6SZhikuiRen 
2639a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
2640a3316fc6SZhikuiRen         { // already incremented
2641a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
2642a3316fc6SZhikuiRen         }
2643a3316fc6SZhikuiRen         else
2644a3316fc6SZhikuiRen         {
2645a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
2646a3316fc6SZhikuiRen         }
2647a3316fc6SZhikuiRen 
2648a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
2649a3316fc6SZhikuiRen         // not fall between top and skip
2650a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
2651a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
2652a3316fc6SZhikuiRen         {
2653a3316fc6SZhikuiRen             continue;
2654a3316fc6SZhikuiRen         }
2655a3316fc6SZhikuiRen 
2656a3316fc6SZhikuiRen         // skip if a sepcific codeIndex is specified and does not match the
2657a3316fc6SZhikuiRen         // currentIndex
2658a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
2659a3316fc6SZhikuiRen         {
2660a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
2661a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
2662a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
2663a3316fc6SZhikuiRen             continue;
2664a3316fc6SZhikuiRen         }
2665a3316fc6SZhikuiRen 
2666a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
2667a3316fc6SZhikuiRen         // index
2668a3316fc6SZhikuiRen 
2669a3316fc6SZhikuiRen         // Get the Created time from the timestamp
2670a3316fc6SZhikuiRen         std::string entryTimeStr;
2671a3316fc6SZhikuiRen         if (!getTimestampStr(usecSinceEpoch, entryTimeStr))
2672a3316fc6SZhikuiRen         {
2673a3316fc6SZhikuiRen             continue;
2674a3316fc6SZhikuiRen         }
2675a3316fc6SZhikuiRen 
2676a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
2677a3316fc6SZhikuiRen         std::ostringstream hexCode;
2678a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
2679a3316fc6SZhikuiRen                 << code.second;
2680a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
2681a3316fc6SZhikuiRen         // Set Fixed -Point Notation
2682a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
2683a3316fc6SZhikuiRen         // Set precision to 4 digits
2684a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
2685a3316fc6SZhikuiRen         // Add double to stream
2686a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
2687a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
2688a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
2689a3316fc6SZhikuiRen 
2690a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
2691a3316fc6SZhikuiRen         std::string msg;
2692a3316fc6SZhikuiRen         if (message != nullptr)
2693a3316fc6SZhikuiRen         {
2694a3316fc6SZhikuiRen             msg = message->message;
2695a3316fc6SZhikuiRen 
2696a3316fc6SZhikuiRen             // fill in this post code value
2697a3316fc6SZhikuiRen             int i = 0;
2698a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
2699a3316fc6SZhikuiRen             {
2700a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
2701a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
2702a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
2703a3316fc6SZhikuiRen                 {
2704a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
2705a3316fc6SZhikuiRen                 }
2706a3316fc6SZhikuiRen             }
2707a3316fc6SZhikuiRen         }
2708a3316fc6SZhikuiRen 
2709d4342a92STim Lee         // Get Severity template from message registry
2710d4342a92STim Lee         std::string severity;
2711d4342a92STim Lee         if (message != nullptr)
2712d4342a92STim Lee         {
2713d4342a92STim Lee             severity = message->severity;
2714d4342a92STim Lee         }
2715d4342a92STim Lee 
2716a3316fc6SZhikuiRen         // add to AsyncResp
2717a3316fc6SZhikuiRen         logEntryArray.push_back({});
2718a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
2719a3316fc6SZhikuiRen         bmcLogEntry = {
2720a3316fc6SZhikuiRen             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2721a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"},
2722a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
2723a3316fc6SZhikuiRen                           "PostCodes/Entries/" +
2724a3316fc6SZhikuiRen                               postcodeEntryID},
2725a3316fc6SZhikuiRen             {"Name", "POST Code Log Entry"},
2726a3316fc6SZhikuiRen             {"Id", postcodeEntryID},
2727a3316fc6SZhikuiRen             {"Message", std::move(msg)},
2728a3316fc6SZhikuiRen             {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"},
2729a3316fc6SZhikuiRen             {"MessageArgs", std::move(messageArgs)},
2730a3316fc6SZhikuiRen             {"EntryType", "Event"},
2731a3316fc6SZhikuiRen             {"Severity", std::move(severity)},
2732a3316fc6SZhikuiRen             {"Created", std::move(entryTimeStr)}};
2733a3316fc6SZhikuiRen     }
2734a3316fc6SZhikuiRen }
2735a3316fc6SZhikuiRen 
2736a3316fc6SZhikuiRen static void getPostCodeForEntry(std::shared_ptr<AsyncResp> aResp,
2737a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
2738a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
2739a3316fc6SZhikuiRen {
2740a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
2741a3316fc6SZhikuiRen         [aResp, bootIndex, codeIndex](
2742a3316fc6SZhikuiRen             const boost::system::error_code ec,
2743a3316fc6SZhikuiRen             const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
2744a3316fc6SZhikuiRen             if (ec)
2745a3316fc6SZhikuiRen             {
2746a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
2747a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2748a3316fc6SZhikuiRen                 return;
2749a3316fc6SZhikuiRen             }
2750a3316fc6SZhikuiRen 
2751a3316fc6SZhikuiRen             // skip the empty postcode boots
2752a3316fc6SZhikuiRen             if (postcode.empty())
2753a3316fc6SZhikuiRen             {
2754a3316fc6SZhikuiRen                 return;
2755a3316fc6SZhikuiRen             }
2756a3316fc6SZhikuiRen 
2757a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
2758a3316fc6SZhikuiRen 
2759a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
2760a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
2761a3316fc6SZhikuiRen         },
2762a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
2763a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
2764a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
2765a3316fc6SZhikuiRen         bootIndex);
2766a3316fc6SZhikuiRen }
2767a3316fc6SZhikuiRen 
2768a3316fc6SZhikuiRen static void getPostCodeForBoot(std::shared_ptr<AsyncResp> aResp,
2769a3316fc6SZhikuiRen                                const uint16_t bootIndex,
2770a3316fc6SZhikuiRen                                const uint16_t bootCount,
2771a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
2772a3316fc6SZhikuiRen                                const uint64_t top)
2773a3316fc6SZhikuiRen {
2774a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
2775a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
2776a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
2777a3316fc6SZhikuiRen               const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
2778a3316fc6SZhikuiRen             if (ec)
2779a3316fc6SZhikuiRen             {
2780a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
2781a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2782a3316fc6SZhikuiRen                 return;
2783a3316fc6SZhikuiRen             }
2784a3316fc6SZhikuiRen 
2785a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
2786a3316fc6SZhikuiRen             if (!postcode.empty())
2787a3316fc6SZhikuiRen             {
2788a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
2789a3316fc6SZhikuiRen 
2790a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
2791a3316fc6SZhikuiRen                 {
2792a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
2793a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
2794a3316fc6SZhikuiRen                     uint64_t thisBootTop =
2795a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
2796a3316fc6SZhikuiRen 
2797a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
2798a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
2799a3316fc6SZhikuiRen                 }
2800a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
2801a3316fc6SZhikuiRen             }
2802a3316fc6SZhikuiRen 
2803a3316fc6SZhikuiRen             // continue to previous bootIndex
2804a3316fc6SZhikuiRen             if (bootIndex < bootCount)
2805a3316fc6SZhikuiRen             {
2806a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
2807a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
2808a3316fc6SZhikuiRen             }
2809a3316fc6SZhikuiRen             else
2810a3316fc6SZhikuiRen             {
2811a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
2812a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
2813a3316fc6SZhikuiRen                     "Entries?$skip=" +
2814a3316fc6SZhikuiRen                     std::to_string(skip + top);
2815a3316fc6SZhikuiRen             }
2816a3316fc6SZhikuiRen         },
2817a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
2818a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
2819a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
2820a3316fc6SZhikuiRen         bootIndex);
2821a3316fc6SZhikuiRen }
2822a3316fc6SZhikuiRen 
2823a3316fc6SZhikuiRen static void getCurrentBootNumber(std::shared_ptr<AsyncResp> aResp,
2824a3316fc6SZhikuiRen                                  const uint64_t skip, const uint64_t top)
2825a3316fc6SZhikuiRen {
2826a3316fc6SZhikuiRen     uint64_t entryCount = 0;
2827a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
2828a3316fc6SZhikuiRen         [aResp, entryCount, skip,
2829a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
2830a3316fc6SZhikuiRen               const std::variant<uint16_t>& bootCount) {
2831a3316fc6SZhikuiRen             if (ec)
2832a3316fc6SZhikuiRen             {
2833a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
2834a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
2835a3316fc6SZhikuiRen                 return;
2836a3316fc6SZhikuiRen             }
2837a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
2838a3316fc6SZhikuiRen             if (pVal)
2839a3316fc6SZhikuiRen             {
2840a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
2841a3316fc6SZhikuiRen             }
2842a3316fc6SZhikuiRen             else
2843a3316fc6SZhikuiRen             {
2844a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
2845a3316fc6SZhikuiRen             }
2846a3316fc6SZhikuiRen         },
2847a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
2848a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
2849a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
2850a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
2851a3316fc6SZhikuiRen }
2852a3316fc6SZhikuiRen 
2853a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node
2854a3316fc6SZhikuiRen {
2855a3316fc6SZhikuiRen   public:
2856a3316fc6SZhikuiRen     template <typename CrowApp>
2857a3316fc6SZhikuiRen     PostCodesEntryCollection(CrowApp& app) :
2858a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
2859a3316fc6SZhikuiRen     {
2860a3316fc6SZhikuiRen         entityPrivileges = {
2861a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2862a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
2863a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2864a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2865a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2866a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2867a3316fc6SZhikuiRen     }
2868a3316fc6SZhikuiRen 
2869a3316fc6SZhikuiRen   private:
2870a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
2871a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
2872a3316fc6SZhikuiRen     {
2873a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2874a3316fc6SZhikuiRen 
2875a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
2876a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
2877a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
2878a3316fc6SZhikuiRen             "/redfish/v1/"
2879a3316fc6SZhikuiRen             "$metadata#LogEntryCollection.LogEntryCollection";
2880a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
2881a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
2882a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
2883a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
2884a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
2885a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
2886a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
2887a3316fc6SZhikuiRen 
2888a3316fc6SZhikuiRen         uint64_t skip = 0;
2889a3316fc6SZhikuiRen         uint64_t top = maxEntriesPerPage; // Show max entries by default
2890a3316fc6SZhikuiRen         if (!getSkipParam(asyncResp->res, req, skip))
2891a3316fc6SZhikuiRen         {
2892a3316fc6SZhikuiRen             return;
2893a3316fc6SZhikuiRen         }
2894a3316fc6SZhikuiRen         if (!getTopParam(asyncResp->res, req, top))
2895a3316fc6SZhikuiRen         {
2896a3316fc6SZhikuiRen             return;
2897a3316fc6SZhikuiRen         }
2898a3316fc6SZhikuiRen         getCurrentBootNumber(asyncResp, skip, top);
2899a3316fc6SZhikuiRen     }
2900a3316fc6SZhikuiRen };
2901a3316fc6SZhikuiRen 
2902a3316fc6SZhikuiRen class PostCodesEntry : public Node
2903a3316fc6SZhikuiRen {
2904a3316fc6SZhikuiRen   public:
2905a3316fc6SZhikuiRen     PostCodesEntry(CrowApp& app) :
2906a3316fc6SZhikuiRen         Node(app,
2907a3316fc6SZhikuiRen              "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/",
2908a3316fc6SZhikuiRen              std::string())
2909a3316fc6SZhikuiRen     {
2910a3316fc6SZhikuiRen         entityPrivileges = {
2911a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2912a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
2913a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2914a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2915a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2916a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2917a3316fc6SZhikuiRen     }
2918a3316fc6SZhikuiRen 
2919a3316fc6SZhikuiRen   private:
2920a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
2921a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
2922a3316fc6SZhikuiRen     {
2923a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2924a3316fc6SZhikuiRen         if (params.size() != 1)
2925a3316fc6SZhikuiRen         {
2926a3316fc6SZhikuiRen             messages::internalError(asyncResp->res);
2927a3316fc6SZhikuiRen             return;
2928a3316fc6SZhikuiRen         }
2929a3316fc6SZhikuiRen 
2930a3316fc6SZhikuiRen         const std::string& targetID = params[0];
2931a3316fc6SZhikuiRen 
2932a3316fc6SZhikuiRen         size_t bootPos = targetID.find('B');
2933a3316fc6SZhikuiRen         if (bootPos == std::string::npos)
2934a3316fc6SZhikuiRen         {
2935a3316fc6SZhikuiRen             // Requested ID was not found
2936a3316fc6SZhikuiRen             messages::resourceMissingAtURI(asyncResp->res, targetID);
2937a3316fc6SZhikuiRen             return;
2938a3316fc6SZhikuiRen         }
2939a3316fc6SZhikuiRen         std::string_view bootIndexStr(targetID);
2940a3316fc6SZhikuiRen         bootIndexStr.remove_prefix(bootPos + 1);
2941a3316fc6SZhikuiRen         uint16_t bootIndex = 0;
2942a3316fc6SZhikuiRen         uint64_t codeIndex = 0;
2943a3316fc6SZhikuiRen         size_t dashPos = bootIndexStr.find('-');
2944a3316fc6SZhikuiRen 
2945a3316fc6SZhikuiRen         if (dashPos == std::string::npos)
2946a3316fc6SZhikuiRen         {
2947a3316fc6SZhikuiRen             return;
2948a3316fc6SZhikuiRen         }
2949a3316fc6SZhikuiRen         std::string_view codeIndexStr(bootIndexStr);
2950a3316fc6SZhikuiRen         bootIndexStr.remove_suffix(dashPos);
2951a3316fc6SZhikuiRen         codeIndexStr.remove_prefix(dashPos + 1);
2952a3316fc6SZhikuiRen 
2953a3316fc6SZhikuiRen         bootIndex = static_cast<uint16_t>(
2954a3316fc6SZhikuiRen             strtoul(std::string(bootIndexStr).c_str(), NULL, 0));
2955a3316fc6SZhikuiRen         codeIndex = strtoul(std::string(codeIndexStr).c_str(), NULL, 0);
2956a3316fc6SZhikuiRen         if (bootIndex == 0 || codeIndex == 0)
2957a3316fc6SZhikuiRen         {
2958a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
2959a3316fc6SZhikuiRen                              << params[0];
2960a3316fc6SZhikuiRen         }
2961a3316fc6SZhikuiRen 
2962a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
2963a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
2964a3316fc6SZhikuiRen             "/redfish/v1/$metadata#LogEntry.LogEntry";
2965a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
2966a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/"
2967a3316fc6SZhikuiRen             "Entries";
2968a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
2969a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
2970a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
2971a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
2972a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
2973a3316fc6SZhikuiRen 
2974a3316fc6SZhikuiRen         getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
2975a3316fc6SZhikuiRen     }
2976a3316fc6SZhikuiRen };
2977a3316fc6SZhikuiRen 
29781da66f75SEd Tanous } // namespace redfish
2979