xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision 80319af19c4b74a95a940ade10b13dee2562fe8a)
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>
321214b7e7SGunnar 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* crashdumpInterface = "com.intel.crashdump";
435b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
445b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
455b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
46424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
475b61b5e8SJason M. Bills constexpr char const* crashdumpRawPECIInterface =
48424c4176SJason M. Bills     "com.intel.crashdump.SendRawPeci";
496eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface =
506eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
511da66f75SEd Tanous 
524851d45dSJason M. Bills namespace message_registries
534851d45dSJason M. Bills {
544851d45dSJason M. Bills static const Message* getMessageFromRegistry(
554851d45dSJason M. Bills     const std::string& messageKey,
564851d45dSJason M. Bills     const boost::beast::span<const MessageEntry> registry)
574851d45dSJason M. Bills {
584851d45dSJason M. Bills     boost::beast::span<const MessageEntry>::const_iterator messageIt =
594851d45dSJason M. Bills         std::find_if(registry.cbegin(), registry.cend(),
604851d45dSJason M. Bills                      [&messageKey](const MessageEntry& messageEntry) {
614851d45dSJason M. Bills                          return !std::strcmp(messageEntry.first,
624851d45dSJason M. Bills                                              messageKey.c_str());
634851d45dSJason M. Bills                      });
644851d45dSJason M. Bills     if (messageIt != registry.cend())
654851d45dSJason M. Bills     {
664851d45dSJason M. Bills         return &messageIt->second;
674851d45dSJason M. Bills     }
684851d45dSJason M. Bills 
694851d45dSJason M. Bills     return nullptr;
704851d45dSJason M. Bills }
714851d45dSJason M. Bills 
724851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
734851d45dSJason M. Bills {
744851d45dSJason M. Bills     // Redfish MessageIds are in the form
754851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
764851d45dSJason M. Bills     // the right Message
774851d45dSJason M. Bills     std::vector<std::string> fields;
784851d45dSJason M. Bills     fields.reserve(4);
794851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
804851d45dSJason M. Bills     std::string& registryName = fields[0];
814851d45dSJason M. Bills     std::string& messageKey = fields[3];
824851d45dSJason M. Bills 
834851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
844851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
854851d45dSJason M. Bills     {
864851d45dSJason M. Bills         return getMessageFromRegistry(
874851d45dSJason M. Bills             messageKey, boost::beast::span<const MessageEntry>(base::registry));
884851d45dSJason M. Bills     }
894851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
904851d45dSJason M. Bills     {
914851d45dSJason M. Bills         return getMessageFromRegistry(
924851d45dSJason M. Bills             messageKey,
934851d45dSJason M. Bills             boost::beast::span<const MessageEntry>(openbmc::registry));
944851d45dSJason M. Bills     }
954851d45dSJason M. Bills     return nullptr;
964851d45dSJason M. Bills }
974851d45dSJason M. Bills } // namespace message_registries
984851d45dSJason M. Bills 
99f6150403SJames Feist namespace fs = std::filesystem;
1001da66f75SEd Tanous 
101cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map<
10219bd78d9SPatrick Williams     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
103cb92c03bSAndrew Geissler                               int32_t, uint32_t, int64_t, uint64_t, double>>;
104cb92c03bSAndrew Geissler 
105cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map<
106cb92c03bSAndrew Geissler     sdbusplus::message::object_path,
107cb92c03bSAndrew Geissler     boost::container::flat_map<std::string, GetManagedPropertyType>>;
108cb92c03bSAndrew Geissler 
109cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
110cb92c03bSAndrew Geissler {
111cb92c03bSAndrew Geissler     if (s == "xyz.openbmc_project.Logging.Entry.Level.Alert")
112cb92c03bSAndrew Geissler     {
113cb92c03bSAndrew Geissler         return "Critical";
114cb92c03bSAndrew Geissler     }
115cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Critical")
116cb92c03bSAndrew Geissler     {
117cb92c03bSAndrew Geissler         return "Critical";
118cb92c03bSAndrew Geissler     }
119cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Debug")
120cb92c03bSAndrew Geissler     {
121cb92c03bSAndrew Geissler         return "OK";
122cb92c03bSAndrew Geissler     }
123cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency")
124cb92c03bSAndrew Geissler     {
125cb92c03bSAndrew Geissler         return "Critical";
126cb92c03bSAndrew Geissler     }
127cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Error")
128cb92c03bSAndrew Geissler     {
129cb92c03bSAndrew Geissler         return "Critical";
130cb92c03bSAndrew Geissler     }
131cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Informational")
132cb92c03bSAndrew Geissler     {
133cb92c03bSAndrew Geissler         return "OK";
134cb92c03bSAndrew Geissler     }
135cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Notice")
136cb92c03bSAndrew Geissler     {
137cb92c03bSAndrew Geissler         return "OK";
138cb92c03bSAndrew Geissler     }
139cb92c03bSAndrew Geissler     else if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
140cb92c03bSAndrew Geissler     {
141cb92c03bSAndrew Geissler         return "Warning";
142cb92c03bSAndrew Geissler     }
143cb92c03bSAndrew Geissler     return "";
144cb92c03bSAndrew Geissler }
145cb92c03bSAndrew Geissler 
14616428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
14739e77504SEd Tanous                               const std::string_view& field,
14839e77504SEd Tanous                               std::string_view& contents)
14916428a1aSJason M. Bills {
15016428a1aSJason M. Bills     const char* data = nullptr;
15116428a1aSJason M. Bills     size_t length = 0;
15216428a1aSJason M. Bills     int ret = 0;
15316428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
154271584abSEd Tanous     ret = sd_journal_get_data(journal, field.data(),
155271584abSEd Tanous                               reinterpret_cast<const void**>(&data), &length);
15616428a1aSJason M. Bills     if (ret < 0)
15716428a1aSJason M. Bills     {
15816428a1aSJason M. Bills         return ret;
15916428a1aSJason M. Bills     }
16039e77504SEd Tanous     contents = std::string_view(data, length);
16116428a1aSJason M. Bills     // Only use the content after the "=" character.
16216428a1aSJason M. Bills     contents.remove_prefix(std::min(contents.find("=") + 1, contents.size()));
16316428a1aSJason M. Bills     return ret;
16416428a1aSJason M. Bills }
16516428a1aSJason M. Bills 
16616428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
16739e77504SEd Tanous                               const std::string_view& field, const int& base,
168271584abSEd Tanous                               long int& contents)
16916428a1aSJason M. Bills {
17016428a1aSJason M. Bills     int ret = 0;
17139e77504SEd Tanous     std::string_view metadata;
17216428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
17316428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
17416428a1aSJason M. Bills     if (ret < 0)
17516428a1aSJason M. Bills     {
17616428a1aSJason M. Bills         return ret;
17716428a1aSJason M. Bills     }
178b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
17916428a1aSJason M. Bills     return ret;
18016428a1aSJason M. Bills }
18116428a1aSJason M. Bills 
182a3316fc6SZhikuiRen static bool getTimestampStr(const uint64_t usecSinceEpoch,
183a3316fc6SZhikuiRen                             std::string& entryTimestamp)
18416428a1aSJason M. Bills {
185a3316fc6SZhikuiRen     time_t t = static_cast<time_t>(usecSinceEpoch / 1000 / 1000);
18616428a1aSJason M. Bills     struct tm* loctime = localtime(&t);
18716428a1aSJason M. Bills     char entryTime[64] = {};
18899131cd0SEd Tanous     if (nullptr != loctime)
18916428a1aSJason M. Bills     {
19016428a1aSJason M. Bills         strftime(entryTime, sizeof(entryTime), "%FT%T%z", loctime);
19116428a1aSJason M. Bills     }
19216428a1aSJason M. Bills     // Insert the ':' into the timezone
19339e77504SEd Tanous     std::string_view t1(entryTime);
19439e77504SEd Tanous     std::string_view t2(entryTime);
19516428a1aSJason M. Bills     if (t1.size() > 2 && t2.size() > 2)
19616428a1aSJason M. Bills     {
19716428a1aSJason M. Bills         t1.remove_suffix(2);
19816428a1aSJason M. Bills         t2.remove_prefix(t2.size() - 2);
19916428a1aSJason M. Bills     }
20039e77504SEd Tanous     entryTimestamp = std::string(t1) + ":" + std::string(t2);
20116428a1aSJason M. Bills     return true;
20216428a1aSJason M. Bills }
20316428a1aSJason M. Bills 
204a3316fc6SZhikuiRen static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp)
205a3316fc6SZhikuiRen {
206a3316fc6SZhikuiRen     int ret = 0;
207a3316fc6SZhikuiRen     uint64_t timestamp = 0;
208a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
209a3316fc6SZhikuiRen     if (ret < 0)
210a3316fc6SZhikuiRen     {
211a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
212a3316fc6SZhikuiRen                          << strerror(-ret);
213a3316fc6SZhikuiRen         return false;
214a3316fc6SZhikuiRen     }
215a3316fc6SZhikuiRen     return getTimestampStr(timestamp, entryTimestamp);
216a3316fc6SZhikuiRen }
217a3316fc6SZhikuiRen 
21816428a1aSJason M. Bills static bool getSkipParam(crow::Response& res, const crow::Request& req,
219271584abSEd Tanous                          uint64_t& skip)
22016428a1aSJason M. Bills {
22116428a1aSJason M. Bills     char* skipParam = req.urlParams.get("$skip");
22216428a1aSJason M. Bills     if (skipParam != nullptr)
22316428a1aSJason M. Bills     {
22416428a1aSJason M. Bills         char* ptr = nullptr;
225271584abSEd Tanous         skip = std::strtoul(skipParam, &ptr, 10);
22616428a1aSJason M. Bills         if (*skipParam == '\0' || *ptr != '\0')
22716428a1aSJason M. Bills         {
22816428a1aSJason M. Bills 
22916428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(skipParam),
23016428a1aSJason M. Bills                                                    "$skip");
23116428a1aSJason M. Bills             return false;
23216428a1aSJason M. Bills         }
23316428a1aSJason M. Bills     }
23416428a1aSJason M. Bills     return true;
23516428a1aSJason M. Bills }
23616428a1aSJason M. Bills 
237271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
23816428a1aSJason M. Bills static bool getTopParam(crow::Response& res, const crow::Request& req,
239271584abSEd Tanous                         uint64_t& top)
24016428a1aSJason M. Bills {
24116428a1aSJason M. Bills     char* topParam = req.urlParams.get("$top");
24216428a1aSJason M. Bills     if (topParam != nullptr)
24316428a1aSJason M. Bills     {
24416428a1aSJason M. Bills         char* ptr = nullptr;
245271584abSEd Tanous         top = std::strtoul(topParam, &ptr, 10);
24616428a1aSJason M. Bills         if (*topParam == '\0' || *ptr != '\0')
24716428a1aSJason M. Bills         {
24816428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(topParam),
24916428a1aSJason M. Bills                                                    "$top");
25016428a1aSJason M. Bills             return false;
25116428a1aSJason M. Bills         }
252271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
25316428a1aSJason M. Bills         {
25416428a1aSJason M. Bills 
25516428a1aSJason M. Bills             messages::queryParameterOutOfRange(
25616428a1aSJason M. Bills                 res, std::to_string(top), "$top",
25716428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
25816428a1aSJason M. Bills             return false;
25916428a1aSJason M. Bills         }
26016428a1aSJason M. Bills     }
26116428a1aSJason M. Bills     return true;
26216428a1aSJason M. Bills }
26316428a1aSJason M. Bills 
264e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
265e85d6b16SJason M. Bills                              const bool firstEntry = true)
26616428a1aSJason M. Bills {
26716428a1aSJason M. Bills     int ret = 0;
26816428a1aSJason M. Bills     static uint64_t prevTs = 0;
26916428a1aSJason M. Bills     static int index = 0;
270e85d6b16SJason M. Bills     if (firstEntry)
271e85d6b16SJason M. Bills     {
272e85d6b16SJason M. Bills         prevTs = 0;
273e85d6b16SJason M. Bills     }
274e85d6b16SJason M. Bills 
27516428a1aSJason M. Bills     // Get the entry timestamp
27616428a1aSJason M. Bills     uint64_t curTs = 0;
27716428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
27816428a1aSJason M. Bills     if (ret < 0)
27916428a1aSJason M. Bills     {
28016428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
28116428a1aSJason M. Bills                          << strerror(-ret);
28216428a1aSJason M. Bills         return false;
28316428a1aSJason M. Bills     }
28416428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
28516428a1aSJason M. Bills     if (curTs == prevTs)
28616428a1aSJason M. Bills     {
28716428a1aSJason M. Bills         index++;
28816428a1aSJason M. Bills     }
28916428a1aSJason M. Bills     else
29016428a1aSJason M. Bills     {
29116428a1aSJason M. Bills         // Otherwise, reset it
29216428a1aSJason M. Bills         index = 0;
29316428a1aSJason M. Bills     }
29416428a1aSJason M. Bills     // Save the timestamp
29516428a1aSJason M. Bills     prevTs = curTs;
29616428a1aSJason M. Bills 
29716428a1aSJason M. Bills     entryID = std::to_string(curTs);
29816428a1aSJason M. Bills     if (index > 0)
29916428a1aSJason M. Bills     {
30016428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
30116428a1aSJason M. Bills     }
30216428a1aSJason M. Bills     return true;
30316428a1aSJason M. Bills }
30416428a1aSJason M. Bills 
305e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
306e85d6b16SJason M. Bills                              const bool firstEntry = true)
30795820184SJason M. Bills {
308271584abSEd Tanous     static time_t prevTs = 0;
30995820184SJason M. Bills     static int index = 0;
310e85d6b16SJason M. Bills     if (firstEntry)
311e85d6b16SJason M. Bills     {
312e85d6b16SJason M. Bills         prevTs = 0;
313e85d6b16SJason M. Bills     }
314e85d6b16SJason M. Bills 
31595820184SJason M. Bills     // Get the entry timestamp
316271584abSEd Tanous     std::time_t curTs = 0;
31795820184SJason M. Bills     std::tm timeStruct = {};
31895820184SJason M. Bills     std::istringstream entryStream(logEntry);
31995820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
32095820184SJason M. Bills     {
32195820184SJason M. Bills         curTs = std::mktime(&timeStruct);
32295820184SJason M. Bills     }
32395820184SJason M. Bills     // If the timestamp isn't unique, increment the index
32495820184SJason M. Bills     if (curTs == prevTs)
32595820184SJason M. Bills     {
32695820184SJason M. Bills         index++;
32795820184SJason M. Bills     }
32895820184SJason M. Bills     else
32995820184SJason M. Bills     {
33095820184SJason M. Bills         // Otherwise, reset it
33195820184SJason M. Bills         index = 0;
33295820184SJason M. Bills     }
33395820184SJason M. Bills     // Save the timestamp
33495820184SJason M. Bills     prevTs = curTs;
33595820184SJason M. Bills 
33695820184SJason M. Bills     entryID = std::to_string(curTs);
33795820184SJason M. Bills     if (index > 0)
33895820184SJason M. Bills     {
33995820184SJason M. Bills         entryID += "_" + std::to_string(index);
34095820184SJason M. Bills     }
34195820184SJason M. Bills     return true;
34295820184SJason M. Bills }
34395820184SJason M. Bills 
34416428a1aSJason M. Bills static bool getTimestampFromID(crow::Response& res, const std::string& entryID,
345271584abSEd Tanous                                uint64_t& timestamp, uint64_t& index)
34616428a1aSJason M. Bills {
34716428a1aSJason M. Bills     if (entryID.empty())
34816428a1aSJason M. Bills     {
34916428a1aSJason M. Bills         return false;
35016428a1aSJason M. Bills     }
35116428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
35239e77504SEd Tanous     std::string_view tsStr(entryID);
35316428a1aSJason M. Bills 
35416428a1aSJason M. Bills     auto underscorePos = tsStr.find("_");
35516428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
35616428a1aSJason M. Bills     {
35716428a1aSJason M. Bills         // Timestamp has an index
35816428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
35939e77504SEd Tanous         std::string_view indexStr(entryID);
36016428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
36116428a1aSJason M. Bills         std::size_t pos;
36216428a1aSJason M. Bills         try
36316428a1aSJason M. Bills         {
36439e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
36516428a1aSJason M. Bills         }
366271584abSEd Tanous         catch (std::invalid_argument&)
36716428a1aSJason M. Bills         {
36816428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
36916428a1aSJason M. Bills             return false;
37016428a1aSJason M. Bills         }
371271584abSEd Tanous         catch (std::out_of_range&)
37216428a1aSJason M. Bills         {
37316428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
37416428a1aSJason M. Bills             return false;
37516428a1aSJason M. Bills         }
37616428a1aSJason M. Bills         if (pos != indexStr.size())
37716428a1aSJason M. Bills         {
37816428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
37916428a1aSJason M. Bills             return false;
38016428a1aSJason M. Bills         }
38116428a1aSJason M. Bills     }
38216428a1aSJason M. Bills     // Timestamp has no index
38316428a1aSJason M. Bills     std::size_t pos;
38416428a1aSJason M. Bills     try
38516428a1aSJason M. Bills     {
38639e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
38716428a1aSJason M. Bills     }
388271584abSEd Tanous     catch (std::invalid_argument&)
38916428a1aSJason M. Bills     {
39016428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
39116428a1aSJason M. Bills         return false;
39216428a1aSJason M. Bills     }
393271584abSEd Tanous     catch (std::out_of_range&)
39416428a1aSJason M. Bills     {
39516428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
39616428a1aSJason M. Bills         return false;
39716428a1aSJason M. Bills     }
39816428a1aSJason M. Bills     if (pos != tsStr.size())
39916428a1aSJason M. Bills     {
40016428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
40116428a1aSJason M. Bills         return false;
40216428a1aSJason M. Bills     }
40316428a1aSJason M. Bills     return true;
40416428a1aSJason M. Bills }
40516428a1aSJason M. Bills 
40695820184SJason M. Bills static bool
40795820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
40895820184SJason M. Bills {
40995820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
41095820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
41195820184SJason M. Bills 
41295820184SJason M. Bills     // Loop through the directory looking for redfish log files
41395820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
41495820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
41595820184SJason M. Bills     {
41695820184SJason M. Bills         // If we find a redfish log file, save the path
41795820184SJason M. Bills         std::string filename = dirEnt.path().filename();
41895820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
41995820184SJason M. Bills         {
42095820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
42195820184SJason M. Bills         }
42295820184SJason M. Bills     }
42395820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
42495820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
42595820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
42695820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
42795820184SJason M. Bills 
42895820184SJason M. Bills     return !redfishLogFiles.empty();
42995820184SJason M. Bills }
43095820184SJason M. Bills 
4315cb1dd27SAsmitha Karunanithi inline void getDumpEntryCollection(std::shared_ptr<AsyncResp>& asyncResp,
4325cb1dd27SAsmitha Karunanithi                                    const std::string& dumpType)
4335cb1dd27SAsmitha Karunanithi {
4345cb1dd27SAsmitha Karunanithi     std::string dumpPath;
4355cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
4365cb1dd27SAsmitha Karunanithi     {
4375cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
4385cb1dd27SAsmitha Karunanithi     }
4395cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
4405cb1dd27SAsmitha Karunanithi     {
4415cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
4425cb1dd27SAsmitha Karunanithi     }
4435cb1dd27SAsmitha Karunanithi     else
4445cb1dd27SAsmitha Karunanithi     {
4455cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
4465cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
4475cb1dd27SAsmitha Karunanithi         return;
4485cb1dd27SAsmitha Karunanithi     }
4495cb1dd27SAsmitha Karunanithi 
4505cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
4515cb1dd27SAsmitha Karunanithi         [asyncResp, dumpPath, dumpType](const boost::system::error_code ec,
4525cb1dd27SAsmitha Karunanithi                                         GetManagedObjectsType& resp) {
4535cb1dd27SAsmitha Karunanithi             if (ec)
4545cb1dd27SAsmitha Karunanithi             {
4555cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4565cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
4575cb1dd27SAsmitha Karunanithi                 return;
4585cb1dd27SAsmitha Karunanithi             }
4595cb1dd27SAsmitha Karunanithi 
4605cb1dd27SAsmitha Karunanithi             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4615cb1dd27SAsmitha Karunanithi             entriesArray = nlohmann::json::array();
4625cb1dd27SAsmitha Karunanithi 
4635cb1dd27SAsmitha Karunanithi             for (auto& object : resp)
4645cb1dd27SAsmitha Karunanithi             {
4655cb1dd27SAsmitha Karunanithi                 bool foundDumpEntry = false;
4665cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4675cb1dd27SAsmitha Karunanithi                 {
4685cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first ==
4695cb1dd27SAsmitha Karunanithi                         ("xyz.openbmc_project.Dump.Entry." + dumpType))
4705cb1dd27SAsmitha Karunanithi                     {
4715cb1dd27SAsmitha Karunanithi                         foundDumpEntry = true;
4725cb1dd27SAsmitha Karunanithi                         break;
4735cb1dd27SAsmitha Karunanithi                     }
4745cb1dd27SAsmitha Karunanithi                 }
4755cb1dd27SAsmitha Karunanithi 
4765cb1dd27SAsmitha Karunanithi                 if (foundDumpEntry == false)
4775cb1dd27SAsmitha Karunanithi                 {
4785cb1dd27SAsmitha Karunanithi                     continue;
4795cb1dd27SAsmitha Karunanithi                 }
4805cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
4815cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
4825cb1dd27SAsmitha Karunanithi                 entriesArray.push_back({});
4835cb1dd27SAsmitha Karunanithi                 nlohmann::json& thisEntry = entriesArray.back();
4845cb1dd27SAsmitha Karunanithi                 const std::string& path =
4855cb1dd27SAsmitha Karunanithi                     static_cast<const std::string&>(object.first);
4865cb1dd27SAsmitha Karunanithi                 std::size_t lastPos = path.rfind("/");
4875cb1dd27SAsmitha Karunanithi                 if (lastPos == std::string::npos)
4885cb1dd27SAsmitha Karunanithi                 {
4895cb1dd27SAsmitha Karunanithi                     continue;
4905cb1dd27SAsmitha Karunanithi                 }
4915cb1dd27SAsmitha Karunanithi                 std::string entryID = path.substr(lastPos + 1);
4925cb1dd27SAsmitha Karunanithi 
4935cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4945cb1dd27SAsmitha Karunanithi                 {
4955cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
4965cb1dd27SAsmitha Karunanithi                     {
4975cb1dd27SAsmitha Karunanithi 
4985cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4995cb1dd27SAsmitha Karunanithi                         {
5005cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
5015cb1dd27SAsmitha Karunanithi                             {
5025cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
5035cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
5045cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
5055cb1dd27SAsmitha Karunanithi                                 {
5065cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
5075cb1dd27SAsmitha Karunanithi                                     break;
5085cb1dd27SAsmitha Karunanithi                                 }
5095cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
5105cb1dd27SAsmitha Karunanithi                                 break;
5115cb1dd27SAsmitha Karunanithi                             }
5125cb1dd27SAsmitha Karunanithi                         }
5135cb1dd27SAsmitha Karunanithi                     }
5145cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
5155cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
5165cb1dd27SAsmitha Karunanithi                     {
5175cb1dd27SAsmitha Karunanithi 
5185cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
5195cb1dd27SAsmitha Karunanithi                         {
5205cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
5215cb1dd27SAsmitha Karunanithi                             {
5225cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
5235cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
5245cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
5255cb1dd27SAsmitha Karunanithi                                 {
5265cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
5275cb1dd27SAsmitha Karunanithi                                     break;
5285cb1dd27SAsmitha Karunanithi                                 }
5295cb1dd27SAsmitha Karunanithi                                 timestamp =
5305cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
5315cb1dd27SAsmitha Karunanithi                                 break;
5325cb1dd27SAsmitha Karunanithi                             }
5335cb1dd27SAsmitha Karunanithi                         }
5345cb1dd27SAsmitha Karunanithi                     }
5355cb1dd27SAsmitha Karunanithi                 }
5365cb1dd27SAsmitha Karunanithi 
5375cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.type"] = "#LogEntry.v1_5_1.LogEntry";
5385cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.id"] = dumpPath + entryID;
5395cb1dd27SAsmitha Karunanithi                 thisEntry["Id"] = entryID;
5405cb1dd27SAsmitha Karunanithi                 thisEntry["EntryType"] = "Event";
5415cb1dd27SAsmitha Karunanithi                 thisEntry["Created"] = crow::utility::getDateTime(timestamp);
5425cb1dd27SAsmitha Karunanithi                 thisEntry["Name"] = dumpType + " Dump Entry";
5435cb1dd27SAsmitha Karunanithi 
5445cb1dd27SAsmitha Karunanithi                 thisEntry["Oem"]["OpenBmc"]["@odata.type"] =
5455cb1dd27SAsmitha Karunanithi                     "#OemLogEntry.v1_0_0.OpenBmc";
5465cb1dd27SAsmitha Karunanithi                 thisEntry["Oem"]["OpenBmc"]["AdditionalDataSizeBytes"] = size;
5475cb1dd27SAsmitha Karunanithi 
5485cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
5495cb1dd27SAsmitha Karunanithi                 {
5505cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["DiagnosticDataType"] =
5515cb1dd27SAsmitha Karunanithi                         "Manager";
5525cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["AdditionalDataURI"] =
5535cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
5545cb1dd27SAsmitha Karunanithi                         "attachment/" +
5555cb1dd27SAsmitha Karunanithi                         entryID;
5565cb1dd27SAsmitha Karunanithi                 }
5575cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
5585cb1dd27SAsmitha Karunanithi                 {
5595cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["DiagnosticDataType"] = "OEM";
5605cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["OEMDiagnosticDataType"] =
5615cb1dd27SAsmitha Karunanithi                         "System";
5625cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["AdditionalDataURI"] =
5635cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
5645cb1dd27SAsmitha Karunanithi                         "attachment/" +
5655cb1dd27SAsmitha Karunanithi                         entryID;
5665cb1dd27SAsmitha Karunanithi                 }
5675cb1dd27SAsmitha Karunanithi             }
5685cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Members@odata.count"] =
5695cb1dd27SAsmitha Karunanithi                 entriesArray.size();
5705cb1dd27SAsmitha Karunanithi         },
5715cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5725cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5735cb1dd27SAsmitha Karunanithi }
5745cb1dd27SAsmitha Karunanithi 
5755cb1dd27SAsmitha Karunanithi inline void getDumpEntryById(std::shared_ptr<AsyncResp>& asyncResp,
5765cb1dd27SAsmitha Karunanithi                              const std::string& entryID,
5775cb1dd27SAsmitha Karunanithi                              const std::string& dumpType)
5785cb1dd27SAsmitha Karunanithi {
5795cb1dd27SAsmitha Karunanithi     std::string dumpPath;
5805cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
5815cb1dd27SAsmitha Karunanithi     {
5825cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
5835cb1dd27SAsmitha Karunanithi     }
5845cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
5855cb1dd27SAsmitha Karunanithi     {
5865cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
5875cb1dd27SAsmitha Karunanithi     }
5885cb1dd27SAsmitha Karunanithi     else
5895cb1dd27SAsmitha Karunanithi     {
5905cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
5915cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5925cb1dd27SAsmitha Karunanithi         return;
5935cb1dd27SAsmitha Karunanithi     }
5945cb1dd27SAsmitha Karunanithi 
5955cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
5965cb1dd27SAsmitha Karunanithi         [asyncResp, entryID, dumpPath, dumpType](
5975cb1dd27SAsmitha Karunanithi             const boost::system::error_code ec, GetManagedObjectsType& resp) {
5985cb1dd27SAsmitha Karunanithi             if (ec)
5995cb1dd27SAsmitha Karunanithi             {
6005cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
6015cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
6025cb1dd27SAsmitha Karunanithi                 return;
6035cb1dd27SAsmitha Karunanithi             }
6045cb1dd27SAsmitha Karunanithi 
6055cb1dd27SAsmitha Karunanithi             for (auto& objectPath : resp)
6065cb1dd27SAsmitha Karunanithi             {
6075cb1dd27SAsmitha Karunanithi                 if (objectPath.first.str.find(
6085cb1dd27SAsmitha Karunanithi                         "/xyz/openbmc_project/dump/entry/" + entryID) ==
6095cb1dd27SAsmitha Karunanithi                     std::string::npos)
6105cb1dd27SAsmitha Karunanithi                 {
6115cb1dd27SAsmitha Karunanithi                     continue;
6125cb1dd27SAsmitha Karunanithi                 }
6135cb1dd27SAsmitha Karunanithi 
6145cb1dd27SAsmitha Karunanithi                 bool foundDumpEntry = false;
6155cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
6165cb1dd27SAsmitha Karunanithi                 {
6175cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first ==
6185cb1dd27SAsmitha Karunanithi                         ("xyz.openbmc_project.Dump.Entry." + dumpType))
6195cb1dd27SAsmitha Karunanithi                     {
6205cb1dd27SAsmitha Karunanithi                         foundDumpEntry = true;
6215cb1dd27SAsmitha Karunanithi                         break;
6225cb1dd27SAsmitha Karunanithi                     }
6235cb1dd27SAsmitha Karunanithi                 }
6245cb1dd27SAsmitha Karunanithi                 if (foundDumpEntry == false)
6255cb1dd27SAsmitha Karunanithi                 {
6265cb1dd27SAsmitha Karunanithi                     BMCWEB_LOG_ERROR << "Can't find Dump Entry";
6275cb1dd27SAsmitha Karunanithi                     messages::internalError(asyncResp->res);
6285cb1dd27SAsmitha Karunanithi                     return;
6295cb1dd27SAsmitha Karunanithi                 }
6305cb1dd27SAsmitha Karunanithi 
6315cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
6325cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
6335cb1dd27SAsmitha Karunanithi 
6345cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
6355cb1dd27SAsmitha Karunanithi                 {
6365cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
6375cb1dd27SAsmitha Karunanithi                     {
6385cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6395cb1dd27SAsmitha Karunanithi                         {
6405cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
6415cb1dd27SAsmitha Karunanithi                             {
6425cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
6435cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6445cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
6455cb1dd27SAsmitha Karunanithi                                 {
6465cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6475cb1dd27SAsmitha Karunanithi                                     break;
6485cb1dd27SAsmitha Karunanithi                                 }
6495cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
6505cb1dd27SAsmitha Karunanithi                                 break;
6515cb1dd27SAsmitha Karunanithi                             }
6525cb1dd27SAsmitha Karunanithi                         }
6535cb1dd27SAsmitha Karunanithi                     }
6545cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
6555cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
6565cb1dd27SAsmitha Karunanithi                     {
6575cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6585cb1dd27SAsmitha Karunanithi                         {
6595cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
6605cb1dd27SAsmitha Karunanithi                             {
6615cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
6625cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6635cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
6645cb1dd27SAsmitha Karunanithi                                 {
6655cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6665cb1dd27SAsmitha Karunanithi                                     break;
6675cb1dd27SAsmitha Karunanithi                                 }
6685cb1dd27SAsmitha Karunanithi                                 timestamp =
6695cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
6705cb1dd27SAsmitha Karunanithi                                 break;
6715cb1dd27SAsmitha Karunanithi                             }
6725cb1dd27SAsmitha Karunanithi                         }
6735cb1dd27SAsmitha Karunanithi                     }
6745cb1dd27SAsmitha Karunanithi                 }
6755cb1dd27SAsmitha Karunanithi 
6765cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
6775cb1dd27SAsmitha Karunanithi                     "#LogEntry.v1_5_1.LogEntry";
6785cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
6795cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = entryID;
6805cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["EntryType"] = "Event";
6815cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Created"] =
6825cb1dd27SAsmitha Karunanithi                     crow::utility::getDateTime(timestamp);
6835cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
6845cb1dd27SAsmitha Karunanithi 
6855cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Oem"]["OpenBmc"]["@odata.type"] =
6865cb1dd27SAsmitha Karunanithi                     "#OemLogEntry.v1_0_0.OpenBmc";
6875cb1dd27SAsmitha Karunanithi                 asyncResp->res
6885cb1dd27SAsmitha Karunanithi                     .jsonValue["Oem"]["OpenBmc"]["AdditionalDataSizeBytes"] =
6895cb1dd27SAsmitha Karunanithi                     size;
6905cb1dd27SAsmitha Karunanithi 
6915cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
6925cb1dd27SAsmitha Karunanithi                 {
6935cb1dd27SAsmitha Karunanithi                     asyncResp->res
6945cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["DiagnosticDataType"] =
6955cb1dd27SAsmitha Karunanithi                         "Manager";
6965cb1dd27SAsmitha Karunanithi                     asyncResp->res
6975cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["AdditionalDataURI"] =
6985cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
6995cb1dd27SAsmitha Karunanithi                         "attachment/" +
7005cb1dd27SAsmitha Karunanithi                         entryID;
7015cb1dd27SAsmitha Karunanithi                 }
7025cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
7035cb1dd27SAsmitha Karunanithi                 {
7045cb1dd27SAsmitha Karunanithi                     asyncResp->res
7055cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["DiagnosticDataType"] =
7065cb1dd27SAsmitha Karunanithi                         "OEM";
7075cb1dd27SAsmitha Karunanithi                     asyncResp->res
7085cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["OEMDiagnosticDataType"] =
7095cb1dd27SAsmitha Karunanithi                         "System";
7105cb1dd27SAsmitha Karunanithi                     asyncResp->res
7115cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["AdditionalDataURI"] =
7125cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
7135cb1dd27SAsmitha Karunanithi                         "attachment/" +
7145cb1dd27SAsmitha Karunanithi                         entryID;
7155cb1dd27SAsmitha Karunanithi                 }
7165cb1dd27SAsmitha Karunanithi             }
7175cb1dd27SAsmitha Karunanithi         },
7185cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
7195cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
7205cb1dd27SAsmitha Karunanithi }
7215cb1dd27SAsmitha Karunanithi 
7225cb1dd27SAsmitha Karunanithi inline void deleteDumpEntry(crow::Response& res, const std::string& entryID)
7235cb1dd27SAsmitha Karunanithi {
7245cb1dd27SAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
7255cb1dd27SAsmitha Karunanithi 
7265cb1dd27SAsmitha Karunanithi     auto respHandler = [asyncResp](const boost::system::error_code ec) {
7275cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
7285cb1dd27SAsmitha Karunanithi         if (ec)
7295cb1dd27SAsmitha Karunanithi         {
7305cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
7315cb1dd27SAsmitha Karunanithi                              << ec;
7325cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
7335cb1dd27SAsmitha Karunanithi             return;
7345cb1dd27SAsmitha Karunanithi         }
7355cb1dd27SAsmitha Karunanithi     };
7365cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
7375cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
7385cb1dd27SAsmitha Karunanithi         "/xyz/openbmc_project/dump/entry/" + entryID,
7395cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
7405cb1dd27SAsmitha Karunanithi }
7415cb1dd27SAsmitha Karunanithi 
742a43be80fSAsmitha Karunanithi inline void createDumpTaskCallback(const crow::Request& req,
743a43be80fSAsmitha Karunanithi                                    std::shared_ptr<AsyncResp> asyncResp,
744a43be80fSAsmitha Karunanithi                                    const uint32_t& dumpId,
745a43be80fSAsmitha Karunanithi                                    const std::string& dumpPath,
746a43be80fSAsmitha Karunanithi                                    const std::string& dumpType)
747a43be80fSAsmitha Karunanithi {
748a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
749a43be80fSAsmitha Karunanithi         [dumpId, dumpPath, dumpType](
750a43be80fSAsmitha Karunanithi             boost::system::error_code err, sdbusplus::message::message& m,
751a43be80fSAsmitha Karunanithi             const std::shared_ptr<task::TaskData>& taskData) {
752a43be80fSAsmitha Karunanithi             std::vector<std::pair<
753a43be80fSAsmitha Karunanithi                 std::string,
754a43be80fSAsmitha Karunanithi                 std::vector<std::pair<std::string, std::variant<std::string>>>>>
755a43be80fSAsmitha Karunanithi                 interfacesList;
756a43be80fSAsmitha Karunanithi 
757a43be80fSAsmitha Karunanithi             sdbusplus::message::object_path objPath;
758a43be80fSAsmitha Karunanithi 
759a43be80fSAsmitha Karunanithi             m.read(objPath, interfacesList);
760a43be80fSAsmitha Karunanithi 
761a43be80fSAsmitha Karunanithi             for (auto& interface : interfacesList)
762a43be80fSAsmitha Karunanithi             {
763a43be80fSAsmitha Karunanithi                 if (interface.first ==
764a43be80fSAsmitha Karunanithi                     ("xyz.openbmc_project.Dump.Entry." + dumpType))
765a43be80fSAsmitha Karunanithi                 {
766a43be80fSAsmitha Karunanithi                     nlohmann::json retMessage = messages::success();
767a43be80fSAsmitha Karunanithi                     taskData->messages.emplace_back(retMessage);
768a43be80fSAsmitha Karunanithi 
769a43be80fSAsmitha Karunanithi                     std::string headerLoc =
770a43be80fSAsmitha Karunanithi                         "Location: " + dumpPath + std::to_string(dumpId);
771a43be80fSAsmitha Karunanithi                     taskData->payload->httpHeaders.emplace_back(
772a43be80fSAsmitha Karunanithi                         std::move(headerLoc));
773a43be80fSAsmitha Karunanithi 
774a43be80fSAsmitha Karunanithi                     taskData->state = "Completed";
775a43be80fSAsmitha Karunanithi                     return task::completed;
776a43be80fSAsmitha Karunanithi                 }
777a43be80fSAsmitha Karunanithi             }
778a43be80fSAsmitha Karunanithi             return !task::completed;
779a43be80fSAsmitha Karunanithi         },
780a43be80fSAsmitha Karunanithi         "type='signal',interface='org.freedesktop.DBus."
781a43be80fSAsmitha Karunanithi         "ObjectManager',"
782a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
783a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
784a43be80fSAsmitha Karunanithi 
785a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
786a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
787a43be80fSAsmitha Karunanithi     task->payload.emplace(req);
788a43be80fSAsmitha Karunanithi }
789a43be80fSAsmitha Karunanithi 
790a43be80fSAsmitha Karunanithi inline void createDump(crow::Response& res, const crow::Request& req,
791a43be80fSAsmitha Karunanithi                        const std::string& dumpType)
792a43be80fSAsmitha Karunanithi {
793a43be80fSAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
794a43be80fSAsmitha Karunanithi 
795a43be80fSAsmitha Karunanithi     std::string dumpPath;
796a43be80fSAsmitha Karunanithi     if (dumpType == "BMC")
797a43be80fSAsmitha Karunanithi     {
798a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
799a43be80fSAsmitha Karunanithi     }
800a43be80fSAsmitha Karunanithi     else if (dumpType == "System")
801a43be80fSAsmitha Karunanithi     {
802a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
803a43be80fSAsmitha Karunanithi     }
804a43be80fSAsmitha Karunanithi     else
805a43be80fSAsmitha Karunanithi     {
806a43be80fSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
807a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
808a43be80fSAsmitha Karunanithi         return;
809a43be80fSAsmitha Karunanithi     }
810a43be80fSAsmitha Karunanithi 
811a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
812a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
813a43be80fSAsmitha Karunanithi 
814a43be80fSAsmitha Karunanithi     if (!redfish::json_util::readJson(
815a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
816a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
817a43be80fSAsmitha Karunanithi     {
818a43be80fSAsmitha Karunanithi         return;
819a43be80fSAsmitha Karunanithi     }
820a43be80fSAsmitha Karunanithi 
821a43be80fSAsmitha Karunanithi     if (dumpType == "System")
822a43be80fSAsmitha Karunanithi     {
823a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
824a43be80fSAsmitha Karunanithi         {
825a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
826a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType'/"
827a43be80fSAsmitha Karunanithi                                 "'OEMDiagnosticDataType' value not found!";
828a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
829a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
830a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
831a43be80fSAsmitha Karunanithi             return;
832a43be80fSAsmitha Karunanithi         }
833a43be80fSAsmitha Karunanithi         else if ((*oemDiagnosticDataType != "System") ||
834a43be80fSAsmitha Karunanithi                  (*diagnosticDataType != "OEM"))
835a43be80fSAsmitha Karunanithi         {
836a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
837a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
838a43be80fSAsmitha Karunanithi                                     "System Dump creation parameters");
839a43be80fSAsmitha Karunanithi             return;
840a43be80fSAsmitha Karunanithi         }
841a43be80fSAsmitha Karunanithi     }
842a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
843a43be80fSAsmitha Karunanithi     {
844a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
845a43be80fSAsmitha Karunanithi         {
846a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
847a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType' not found!";
848a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
849a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
850a43be80fSAsmitha Karunanithi             return;
851a43be80fSAsmitha Karunanithi         }
852a43be80fSAsmitha Karunanithi         else if (*diagnosticDataType != "Manager")
853a43be80fSAsmitha Karunanithi         {
854a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
855a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
856a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
857a43be80fSAsmitha Karunanithi                                     "BMC Dump creation parameters");
858a43be80fSAsmitha Karunanithi             return;
859a43be80fSAsmitha Karunanithi         }
860a43be80fSAsmitha Karunanithi     }
861a43be80fSAsmitha Karunanithi 
862a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
863a43be80fSAsmitha Karunanithi         [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec,
864a43be80fSAsmitha Karunanithi                                              const uint32_t& dumpId) {
865a43be80fSAsmitha Karunanithi             if (ec)
866a43be80fSAsmitha Karunanithi             {
867a43be80fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
868a43be80fSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
869a43be80fSAsmitha Karunanithi                 return;
870a43be80fSAsmitha Karunanithi             }
871a43be80fSAsmitha Karunanithi             BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
872a43be80fSAsmitha Karunanithi 
873a43be80fSAsmitha Karunanithi             createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType);
874a43be80fSAsmitha Karunanithi         },
875a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
876a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
877a43be80fSAsmitha Karunanithi }
878a43be80fSAsmitha Karunanithi 
879*80319af1SAsmitha Karunanithi inline void clearDump(crow::Response& res, const std::string& dumpInterface)
880*80319af1SAsmitha Karunanithi {
881*80319af1SAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
882*80319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
883*80319af1SAsmitha Karunanithi         [asyncResp](const boost::system::error_code ec,
884*80319af1SAsmitha Karunanithi                     const std::vector<std::string>& subTreePaths) {
885*80319af1SAsmitha Karunanithi             if (ec)
886*80319af1SAsmitha Karunanithi             {
887*80319af1SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
888*80319af1SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
889*80319af1SAsmitha Karunanithi                 return;
890*80319af1SAsmitha Karunanithi             }
891*80319af1SAsmitha Karunanithi 
892*80319af1SAsmitha Karunanithi             for (const std::string& path : subTreePaths)
893*80319af1SAsmitha Karunanithi             {
894*80319af1SAsmitha Karunanithi                 std::size_t pos = path.rfind("/");
895*80319af1SAsmitha Karunanithi                 if (pos != std::string::npos)
896*80319af1SAsmitha Karunanithi                 {
897*80319af1SAsmitha Karunanithi                     std::string logID = path.substr(pos + 1);
898*80319af1SAsmitha Karunanithi                     deleteDumpEntry(asyncResp->res, logID);
899*80319af1SAsmitha Karunanithi                 }
900*80319af1SAsmitha Karunanithi             }
901*80319af1SAsmitha Karunanithi         },
902*80319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
903*80319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
904*80319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
905*80319af1SAsmitha Karunanithi         "/xyz/openbmc_project/dump", 0,
906*80319af1SAsmitha Karunanithi         std::array<std::string, 1>{dumpInterface});
907*80319af1SAsmitha Karunanithi }
908*80319af1SAsmitha Karunanithi 
909043a0536SJohnathan Mantey static void ParseCrashdumpParameters(
910043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>>& params,
911043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
912043a0536SJohnathan Mantey {
913043a0536SJohnathan Mantey     for (auto property : params)
914043a0536SJohnathan Mantey     {
915043a0536SJohnathan Mantey         if (property.first == "Timestamp")
916043a0536SJohnathan Mantey         {
917043a0536SJohnathan Mantey             const std::string* value =
9188d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
919043a0536SJohnathan Mantey             if (value != nullptr)
920043a0536SJohnathan Mantey             {
921043a0536SJohnathan Mantey                 timestamp = *value;
922043a0536SJohnathan Mantey             }
923043a0536SJohnathan Mantey         }
924043a0536SJohnathan Mantey         else if (property.first == "Filename")
925043a0536SJohnathan Mantey         {
926043a0536SJohnathan Mantey             const std::string* value =
9278d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
928043a0536SJohnathan Mantey             if (value != nullptr)
929043a0536SJohnathan Mantey             {
930043a0536SJohnathan Mantey                 filename = *value;
931043a0536SJohnathan Mantey             }
932043a0536SJohnathan Mantey         }
933043a0536SJohnathan Mantey         else if (property.first == "Log")
934043a0536SJohnathan Mantey         {
935043a0536SJohnathan Mantey             const std::string* value =
9368d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
937043a0536SJohnathan Mantey             if (value != nullptr)
938043a0536SJohnathan Mantey             {
939043a0536SJohnathan Mantey                 logfile = *value;
940043a0536SJohnathan Mantey             }
941043a0536SJohnathan Mantey         }
942043a0536SJohnathan Mantey     }
943043a0536SJohnathan Mantey }
944043a0536SJohnathan Mantey 
945a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
946c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node
9471da66f75SEd Tanous {
9481da66f75SEd Tanous   public:
9491da66f75SEd Tanous     template <typename CrowApp>
950c4bf6374SJason M. Bills     SystemLogServiceCollection(CrowApp& app) :
951029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/")
952c4bf6374SJason M. Bills     {
953c4bf6374SJason M. Bills         entityPrivileges = {
954c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
955c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
956c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
957c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
958c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
959c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
960c4bf6374SJason M. Bills     }
961c4bf6374SJason M. Bills 
962c4bf6374SJason M. Bills   private:
963c4bf6374SJason M. Bills     /**
964c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
965c4bf6374SJason M. Bills      */
966c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
967c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
968c4bf6374SJason M. Bills     {
969c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
970c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
971c4bf6374SJason M. Bills         // it has a duplicate entry for members
972c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
973c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
974c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
975029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
976c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
977c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
978c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
979c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
980c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
981029573d4SEd Tanous         logServiceArray.push_back(
982029573d4SEd Tanous             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}});
9835cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
984c9bb6861Sraviteja-b         logServiceArray.push_back(
9855cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}});
986c9bb6861Sraviteja-b #endif
987c9bb6861Sraviteja-b 
988d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
989d53dd41fSJason M. Bills         logServiceArray.push_back(
990cb92c03bSAndrew Geissler             {{"@odata.id",
991424c4176SJason M. Bills               "/redfish/v1/Systems/system/LogServices/Crashdump"}});
992d53dd41fSJason M. Bills #endif
993c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
994c4bf6374SJason M. Bills             logServiceArray.size();
995a3316fc6SZhikuiRen 
996a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
997a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec,
998a3316fc6SZhikuiRen                         const std::vector<std::string>& subtreePath) {
999a3316fc6SZhikuiRen                 if (ec)
1000a3316fc6SZhikuiRen                 {
1001a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR << ec;
1002a3316fc6SZhikuiRen                     return;
1003a3316fc6SZhikuiRen                 }
1004a3316fc6SZhikuiRen 
1005a3316fc6SZhikuiRen                 for (auto& pathStr : subtreePath)
1006a3316fc6SZhikuiRen                 {
1007a3316fc6SZhikuiRen                     if (pathStr.find("PostCode") != std::string::npos)
1008a3316fc6SZhikuiRen                     {
1009a3316fc6SZhikuiRen                         nlohmann::json& logServiceArray =
1010a3316fc6SZhikuiRen                             asyncResp->res.jsonValue["Members"];
1011a3316fc6SZhikuiRen                         logServiceArray.push_back(
1012a3316fc6SZhikuiRen                             {{"@odata.id", "/redfish/v1/Systems/system/"
1013a3316fc6SZhikuiRen                                            "LogServices/PostCodes"}});
1014a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members@odata.count"] =
1015a3316fc6SZhikuiRen                             logServiceArray.size();
1016a3316fc6SZhikuiRen                         return;
1017a3316fc6SZhikuiRen                     }
1018a3316fc6SZhikuiRen                 }
1019a3316fc6SZhikuiRen             },
1020a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper",
1021a3316fc6SZhikuiRen             "/xyz/openbmc_project/object_mapper",
1022a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
1023a3316fc6SZhikuiRen             std::array<const char*, 1>{postCodeIface});
1024c4bf6374SJason M. Bills     }
1025c4bf6374SJason M. Bills };
1026c4bf6374SJason M. Bills 
1027c4bf6374SJason M. Bills class EventLogService : public Node
1028c4bf6374SJason M. Bills {
1029c4bf6374SJason M. Bills   public:
1030c4bf6374SJason M. Bills     template <typename CrowApp>
1031c4bf6374SJason M. Bills     EventLogService(CrowApp& app) :
1032029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
1033c4bf6374SJason M. Bills     {
1034c4bf6374SJason M. Bills         entityPrivileges = {
1035c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1036c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1037c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1038c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1039c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1040c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1041c4bf6374SJason M. Bills     }
1042c4bf6374SJason M. Bills 
1043c4bf6374SJason M. Bills   private:
1044c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1045c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1046c4bf6374SJason M. Bills     {
1047c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1048c4bf6374SJason M. Bills 
1049c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1050029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
1051c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1052c4bf6374SJason M. Bills             "#LogService.v1_1_0.LogService";
1053c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
1054c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1055c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
1056c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1057c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1058c4bf6374SJason M. Bills             {"@odata.id",
1059029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
1060e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1061e7d6c8b2SGunnar Mills 
1062e7d6c8b2SGunnar Mills             {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
1063e7d6c8b2SGunnar Mills                        "Actions/LogService.ClearLog"}};
1064489640c6SJason M. Bills     }
1065489640c6SJason M. Bills };
1066489640c6SJason M. Bills 
10671f56a3a6STim Lee class JournalEventLogClear : public Node
1068489640c6SJason M. Bills {
1069489640c6SJason M. Bills   public:
10701f56a3a6STim Lee     JournalEventLogClear(CrowApp& app) :
1071489640c6SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1072489640c6SJason M. Bills                   "LogService.ClearLog/")
1073489640c6SJason M. Bills     {
1074489640c6SJason M. Bills         entityPrivileges = {
1075489640c6SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1076489640c6SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1077489640c6SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1078489640c6SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1079489640c6SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1080489640c6SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1081489640c6SJason M. Bills     }
1082489640c6SJason M. Bills 
1083489640c6SJason M. Bills   private:
1084489640c6SJason M. Bills     void doPost(crow::Response& res, const crow::Request& req,
1085489640c6SJason M. Bills                 const std::vector<std::string>& params) override
1086489640c6SJason M. Bills     {
1087489640c6SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1088489640c6SJason M. Bills 
1089489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
1090489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1091489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
1092489640c6SJason M. Bills         {
1093489640c6SJason M. Bills             for (const std::filesystem::path& file : redfishLogFiles)
1094489640c6SJason M. Bills             {
1095489640c6SJason M. Bills                 std::error_code ec;
1096489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
1097489640c6SJason M. Bills             }
1098489640c6SJason M. Bills         }
1099489640c6SJason M. Bills 
1100489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
1101489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
1102489640c6SJason M. Bills             [asyncResp](const boost::system::error_code ec) {
1103489640c6SJason M. Bills                 if (ec)
1104489640c6SJason M. Bills                 {
1105489640c6SJason M. Bills                     BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
1106489640c6SJason M. Bills                     messages::internalError(asyncResp->res);
1107489640c6SJason M. Bills                     return;
1108489640c6SJason M. Bills                 }
1109489640c6SJason M. Bills 
1110489640c6SJason M. Bills                 messages::success(asyncResp->res);
1111489640c6SJason M. Bills             },
1112489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1113489640c6SJason M. Bills             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1114489640c6SJason M. Bills             "replace");
1115c4bf6374SJason M. Bills     }
1116c4bf6374SJason M. Bills };
1117c4bf6374SJason M. Bills 
111895820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
111995820184SJason M. Bills                                  const std::string logEntry,
112095820184SJason M. Bills                                  nlohmann::json& logEntryJson)
1121c4bf6374SJason M. Bills {
112295820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1123cd225da8SJason M. Bills     // First get the Timestamp
1124cd225da8SJason M. Bills     size_t space = logEntry.find_first_of(" ");
1125cd225da8SJason M. Bills     if (space == std::string::npos)
112695820184SJason M. Bills     {
112795820184SJason M. Bills         return 1;
112895820184SJason M. Bills     }
1129cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1130cd225da8SJason M. Bills     // Then get the log contents
1131cd225da8SJason M. Bills     size_t entryStart = logEntry.find_first_not_of(" ", space);
1132cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1133cd225da8SJason M. Bills     {
1134cd225da8SJason M. Bills         return 1;
1135cd225da8SJason M. Bills     }
1136cd225da8SJason M. Bills     std::string_view entry(logEntry);
1137cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1138cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1139cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1140cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1141cd225da8SJason M. Bills                  boost::token_compress_on);
1142cd225da8SJason M. Bills     // We need at least a MessageId to be valid
1143cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
1144cd225da8SJason M. Bills     {
1145cd225da8SJason M. Bills         return 1;
1146cd225da8SJason M. Bills     }
1147cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
114895820184SJason M. Bills 
11494851d45dSJason M. Bills     // Get the Message from the MessageRegistry
11504851d45dSJason M. Bills     const message_registries::Message* message =
11514851d45dSJason M. Bills         message_registries::getMessage(messageID);
1152c4bf6374SJason M. Bills 
11534851d45dSJason M. Bills     std::string msg;
11544851d45dSJason M. Bills     std::string severity;
11554851d45dSJason M. Bills     if (message != nullptr)
1156c4bf6374SJason M. Bills     {
11574851d45dSJason M. Bills         msg = message->message;
11584851d45dSJason M. Bills         severity = message->severity;
1159c4bf6374SJason M. Bills     }
1160c4bf6374SJason M. Bills 
116115a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
116215a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
116315a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
116415a86ff6SJason M. Bills     {
116515a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
116615a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
116715a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
116815a86ff6SJason M. Bills         if (!messageArgsStart.empty())
116915a86ff6SJason M. Bills         {
117015a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
117115a86ff6SJason M. Bills         }
117215a86ff6SJason M. Bills 
117315a86ff6SJason M. Bills         messageArgs = boost::beast::span(&messageArgsStart, messageArgsSize);
1174c4bf6374SJason M. Bills 
11754851d45dSJason M. Bills         // Fill the MessageArgs into the Message
117695820184SJason M. Bills         int i = 0;
117795820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11784851d45dSJason M. Bills         {
117995820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11804851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11814851d45dSJason M. Bills             if (argPos != std::string::npos)
11824851d45dSJason M. Bills             {
118395820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11844851d45dSJason M. Bills             }
11854851d45dSJason M. Bills         }
118615a86ff6SJason M. Bills     }
11874851d45dSJason M. Bills 
118895820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
118995820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
119095820184SJason M. Bills     // between the '.' and the '+', so just remove them.
119195820184SJason M. Bills     std::size_t dot = timestamp.find_first_of(".");
119295820184SJason M. Bills     std::size_t plus = timestamp.find_first_of("+");
119395820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1194c4bf6374SJason M. Bills     {
119595820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1196c4bf6374SJason M. Bills     }
1197c4bf6374SJason M. Bills 
1198c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
119995820184SJason M. Bills     logEntryJson = {
1200cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1201029573d4SEd Tanous         {"@odata.id",
1202897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
120395820184SJason M. Bills              logEntryID},
1204c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
120595820184SJason M. Bills         {"Id", logEntryID},
120695820184SJason M. Bills         {"Message", std::move(msg)},
120795820184SJason M. Bills         {"MessageId", std::move(messageID)},
1208c4bf6374SJason M. Bills         {"MessageArgs", std::move(messageArgs)},
1209c4bf6374SJason M. Bills         {"EntryType", "Event"},
121095820184SJason M. Bills         {"Severity", std::move(severity)},
121195820184SJason M. Bills         {"Created", std::move(timestamp)}};
1212c4bf6374SJason M. Bills     return 0;
1213c4bf6374SJason M. Bills }
1214c4bf6374SJason M. Bills 
121527062605SAnthony Wilson class JournalEventLogEntryCollection : public Node
1216c4bf6374SJason M. Bills {
1217c4bf6374SJason M. Bills   public:
1218c4bf6374SJason M. Bills     template <typename CrowApp>
121927062605SAnthony Wilson     JournalEventLogEntryCollection(CrowApp& app) :
1220029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1221c4bf6374SJason M. Bills     {
1222c4bf6374SJason M. Bills         entityPrivileges = {
1223c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1224c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1225c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1226c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1227c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1228c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1229c4bf6374SJason M. Bills     }
1230c4bf6374SJason M. Bills 
1231c4bf6374SJason M. Bills   private:
1232c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1233c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1234c4bf6374SJason M. Bills     {
1235c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1236271584abSEd Tanous         uint64_t skip = 0;
1237271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
1238c4bf6374SJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1239c4bf6374SJason M. Bills         {
1240c4bf6374SJason M. Bills             return;
1241c4bf6374SJason M. Bills         }
1242c4bf6374SJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1243c4bf6374SJason M. Bills         {
1244c4bf6374SJason M. Bills             return;
1245c4bf6374SJason M. Bills         }
1246c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
1247c4bf6374SJason M. Bills         // it has a duplicate entry for members
1248c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1249c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
1250c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1251029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1252c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1253c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1254c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
1255cb92c03bSAndrew Geissler 
1256c4bf6374SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1257c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
125895820184SJason M. Bills         // Go through the log files and create a unique ID for each entry
125995820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
126095820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1261b01bf299SEd Tanous         uint64_t entryCount = 0;
1262cd225da8SJason M. Bills         std::string logEntry;
126395820184SJason M. Bills 
126495820184SJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1265cd225da8SJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1266cd225da8SJason M. Bills              it++)
1267c4bf6374SJason M. Bills         {
1268cd225da8SJason M. Bills             std::ifstream logStream(*it);
126995820184SJason M. Bills             if (!logStream.is_open())
1270c4bf6374SJason M. Bills             {
1271c4bf6374SJason M. Bills                 continue;
1272c4bf6374SJason M. Bills             }
1273c4bf6374SJason M. Bills 
1274e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
1275e85d6b16SJason M. Bills             bool firstEntry = true;
127695820184SJason M. Bills             while (std::getline(logStream, logEntry))
127795820184SJason M. Bills             {
1278c4bf6374SJason M. Bills                 entryCount++;
1279c4bf6374SJason M. Bills                 // Handle paging using skip (number of entries to skip from the
1280c4bf6374SJason M. Bills                 // start) and top (number of entries to display)
1281c4bf6374SJason M. Bills                 if (entryCount <= skip || entryCount > skip + top)
1282c4bf6374SJason M. Bills                 {
1283c4bf6374SJason M. Bills                     continue;
1284c4bf6374SJason M. Bills                 }
1285c4bf6374SJason M. Bills 
1286c4bf6374SJason M. Bills                 std::string idStr;
1287e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1288c4bf6374SJason M. Bills                 {
1289c4bf6374SJason M. Bills                     continue;
1290c4bf6374SJason M. Bills                 }
1291c4bf6374SJason M. Bills 
1292e85d6b16SJason M. Bills                 if (firstEntry)
1293e85d6b16SJason M. Bills                 {
1294e85d6b16SJason M. Bills                     firstEntry = false;
1295e85d6b16SJason M. Bills                 }
1296e85d6b16SJason M. Bills 
1297c4bf6374SJason M. Bills                 logEntryArray.push_back({});
1298c4bf6374SJason M. Bills                 nlohmann::json& bmcLogEntry = logEntryArray.back();
129995820184SJason M. Bills                 if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0)
1300c4bf6374SJason M. Bills                 {
1301c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
1302c4bf6374SJason M. Bills                     return;
1303c4bf6374SJason M. Bills                 }
1304c4bf6374SJason M. Bills             }
130595820184SJason M. Bills         }
1306c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1307c4bf6374SJason M. Bills         if (skip + top < entryCount)
1308c4bf6374SJason M. Bills         {
1309c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
131095820184SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/"
131195820184SJason M. Bills                 "Entries?$skip=" +
1312c4bf6374SJason M. Bills                 std::to_string(skip + top);
1313c4bf6374SJason M. Bills         }
131408a4e4b5SAnthony Wilson     }
131508a4e4b5SAnthony Wilson };
131608a4e4b5SAnthony Wilson 
1317897967deSJason M. Bills class JournalEventLogEntry : public Node
1318897967deSJason M. Bills {
1319897967deSJason M. Bills   public:
1320897967deSJason M. Bills     JournalEventLogEntry(CrowApp& app) :
1321897967deSJason M. Bills         Node(app,
1322897967deSJason M. Bills              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1323897967deSJason M. Bills              std::string())
1324897967deSJason M. Bills     {
1325897967deSJason M. Bills         entityPrivileges = {
1326897967deSJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1327897967deSJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1328897967deSJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1329897967deSJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1330897967deSJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1331897967deSJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1332897967deSJason M. Bills     }
1333897967deSJason M. Bills 
1334897967deSJason M. Bills   private:
1335897967deSJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1336897967deSJason M. Bills                const std::vector<std::string>& params) override
1337897967deSJason M. Bills     {
1338897967deSJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1339897967deSJason M. Bills         if (params.size() != 1)
1340897967deSJason M. Bills         {
1341897967deSJason M. Bills             messages::internalError(asyncResp->res);
1342897967deSJason M. Bills             return;
1343897967deSJason M. Bills         }
1344897967deSJason M. Bills         const std::string& targetID = params[0];
1345897967deSJason M. Bills 
1346897967deSJason M. Bills         // Go through the log files and check the unique ID for each entry to
1347897967deSJason M. Bills         // find the target entry
1348897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1349897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1350897967deSJason M. Bills         std::string logEntry;
1351897967deSJason M. Bills 
1352897967deSJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1353897967deSJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1354897967deSJason M. Bills              it++)
1355897967deSJason M. Bills         {
1356897967deSJason M. Bills             std::ifstream logStream(*it);
1357897967deSJason M. Bills             if (!logStream.is_open())
1358897967deSJason M. Bills             {
1359897967deSJason M. Bills                 continue;
1360897967deSJason M. Bills             }
1361897967deSJason M. Bills 
1362897967deSJason M. Bills             // Reset the unique ID on the first entry
1363897967deSJason M. Bills             bool firstEntry = true;
1364897967deSJason M. Bills             while (std::getline(logStream, logEntry))
1365897967deSJason M. Bills             {
1366897967deSJason M. Bills                 std::string idStr;
1367897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1368897967deSJason M. Bills                 {
1369897967deSJason M. Bills                     continue;
1370897967deSJason M. Bills                 }
1371897967deSJason M. Bills 
1372897967deSJason M. Bills                 if (firstEntry)
1373897967deSJason M. Bills                 {
1374897967deSJason M. Bills                     firstEntry = false;
1375897967deSJason M. Bills                 }
1376897967deSJason M. Bills 
1377897967deSJason M. Bills                 if (idStr == targetID)
1378897967deSJason M. Bills                 {
1379897967deSJason M. Bills                     if (fillEventLogEntryJson(idStr, logEntry,
1380897967deSJason M. Bills                                               asyncResp->res.jsonValue) != 0)
1381897967deSJason M. Bills                     {
1382897967deSJason M. Bills                         messages::internalError(asyncResp->res);
1383897967deSJason M. Bills                         return;
1384897967deSJason M. Bills                     }
1385897967deSJason M. Bills                     return;
1386897967deSJason M. Bills                 }
1387897967deSJason M. Bills             }
1388897967deSJason M. Bills         }
1389897967deSJason M. Bills         // Requested ID was not found
1390897967deSJason M. Bills         messages::resourceMissingAtURI(asyncResp->res, targetID);
1391897967deSJason M. Bills     }
1392897967deSJason M. Bills };
1393897967deSJason M. Bills 
139408a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node
139508a4e4b5SAnthony Wilson {
139608a4e4b5SAnthony Wilson   public:
139708a4e4b5SAnthony Wilson     template <typename CrowApp>
139808a4e4b5SAnthony Wilson     DBusEventLogEntryCollection(CrowApp& app) :
139908a4e4b5SAnthony Wilson         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
140008a4e4b5SAnthony Wilson     {
140108a4e4b5SAnthony Wilson         entityPrivileges = {
140208a4e4b5SAnthony Wilson             {boost::beast::http::verb::get, {{"Login"}}},
140308a4e4b5SAnthony Wilson             {boost::beast::http::verb::head, {{"Login"}}},
140408a4e4b5SAnthony Wilson             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
140508a4e4b5SAnthony Wilson             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
140608a4e4b5SAnthony Wilson             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
140708a4e4b5SAnthony Wilson             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
140808a4e4b5SAnthony Wilson     }
140908a4e4b5SAnthony Wilson 
141008a4e4b5SAnthony Wilson   private:
141108a4e4b5SAnthony Wilson     void doGet(crow::Response& res, const crow::Request& req,
141208a4e4b5SAnthony Wilson                const std::vector<std::string>& params) override
141308a4e4b5SAnthony Wilson     {
141408a4e4b5SAnthony Wilson         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
141508a4e4b5SAnthony Wilson 
141608a4e4b5SAnthony Wilson         // Collections don't include the static data added by SubRoute because
141708a4e4b5SAnthony Wilson         // it has a duplicate entry for members
141808a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
141908a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
142008a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
142108a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
142208a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
142308a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
142408a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
142508a4e4b5SAnthony Wilson 
1426cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1427cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1428cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1429cb92c03bSAndrew Geissler             [asyncResp](const boost::system::error_code ec,
1430cb92c03bSAndrew Geissler                         GetManagedObjectsType& resp) {
1431cb92c03bSAndrew Geissler                 if (ec)
1432cb92c03bSAndrew Geissler                 {
1433cb92c03bSAndrew Geissler                     // TODO Handle for specific error code
1434cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1435cb92c03bSAndrew Geissler                         << "getLogEntriesIfaceData resp_handler got error "
1436cb92c03bSAndrew Geissler                         << ec;
1437cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1438cb92c03bSAndrew Geissler                     return;
1439cb92c03bSAndrew Geissler                 }
1440cb92c03bSAndrew Geissler                 nlohmann::json& entriesArray =
1441cb92c03bSAndrew Geissler                     asyncResp->res.jsonValue["Members"];
1442cb92c03bSAndrew Geissler                 entriesArray = nlohmann::json::array();
1443cb92c03bSAndrew Geissler                 for (auto& objectPath : resp)
1444cb92c03bSAndrew Geissler                 {
1445cb92c03bSAndrew Geissler                     for (auto& interfaceMap : objectPath.second)
1446cb92c03bSAndrew Geissler                     {
1447cb92c03bSAndrew Geissler                         if (interfaceMap.first !=
1448cb92c03bSAndrew Geissler                             "xyz.openbmc_project.Logging.Entry")
1449cb92c03bSAndrew Geissler                         {
1450cb92c03bSAndrew Geissler                             BMCWEB_LOG_DEBUG << "Bailing early on "
1451cb92c03bSAndrew Geissler                                              << interfaceMap.first;
1452cb92c03bSAndrew Geissler                             continue;
1453cb92c03bSAndrew Geissler                         }
1454cb92c03bSAndrew Geissler                         entriesArray.push_back({});
1455cb92c03bSAndrew Geissler                         nlohmann::json& thisEntry = entriesArray.back();
145666664f25SEd Tanous                         uint32_t* id = nullptr;
145766664f25SEd Tanous                         std::time_t timestamp{};
145866664f25SEd Tanous                         std::string* severity = nullptr;
145966664f25SEd Tanous                         std::string* message = nullptr;
1460cb92c03bSAndrew Geissler                         for (auto& propertyMap : interfaceMap.second)
1461cb92c03bSAndrew Geissler                         {
1462cb92c03bSAndrew Geissler                             if (propertyMap.first == "Id")
1463cb92c03bSAndrew Geissler                             {
14648d78b7a9SPatrick Williams                                 id = std::get_if<uint32_t>(&propertyMap.second);
1465cb92c03bSAndrew Geissler                                 if (id == nullptr)
1466cb92c03bSAndrew Geissler                                 {
1467cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1468cb92c03bSAndrew Geissler                                                               "Id");
1469cb92c03bSAndrew Geissler                                 }
1470cb92c03bSAndrew Geissler                             }
1471cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Timestamp")
1472cb92c03bSAndrew Geissler                             {
1473cb92c03bSAndrew Geissler                                 const uint64_t* millisTimeStamp =
1474cb92c03bSAndrew Geissler                                     std::get_if<uint64_t>(&propertyMap.second);
1475cb92c03bSAndrew Geissler                                 if (millisTimeStamp == nullptr)
1476cb92c03bSAndrew Geissler                                 {
1477cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1478cb92c03bSAndrew Geissler                                                               "Timestamp");
1479271584abSEd Tanous                                     continue;
1480cb92c03bSAndrew Geissler                                 }
1481cb92c03bSAndrew Geissler                                 // Retrieve Created property with format:
1482cb92c03bSAndrew Geissler                                 // yyyy-mm-ddThh:mm:ss
1483cb92c03bSAndrew Geissler                                 std::chrono::milliseconds chronoTimeStamp(
1484cb92c03bSAndrew Geissler                                     *millisTimeStamp);
1485271584abSEd Tanous                                 timestamp = std::chrono::duration_cast<
1486271584abSEd Tanous                                                 std::chrono::duration<int>>(
1487271584abSEd Tanous                                                 chronoTimeStamp)
1488cb92c03bSAndrew Geissler                                                 .count();
1489cb92c03bSAndrew Geissler                             }
1490cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1491cb92c03bSAndrew Geissler                             {
1492cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1493cb92c03bSAndrew Geissler                                     &propertyMap.second);
1494cb92c03bSAndrew Geissler                                 if (severity == nullptr)
1495cb92c03bSAndrew Geissler                                 {
1496cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1497cb92c03bSAndrew Geissler                                                               "Severity");
1498cb92c03bSAndrew Geissler                                 }
1499cb92c03bSAndrew Geissler                             }
1500cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1501cb92c03bSAndrew Geissler                             {
1502cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1503cb92c03bSAndrew Geissler                                     &propertyMap.second);
1504cb92c03bSAndrew Geissler                                 if (message == nullptr)
1505cb92c03bSAndrew Geissler                                 {
1506cb92c03bSAndrew Geissler                                     messages::propertyMissing(asyncResp->res,
1507cb92c03bSAndrew Geissler                                                               "Message");
1508cb92c03bSAndrew Geissler                                 }
1509cb92c03bSAndrew Geissler                             }
1510cb92c03bSAndrew Geissler                         }
1511cb92c03bSAndrew Geissler                         thisEntry = {
1512cb92c03bSAndrew Geissler                             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1513cb92c03bSAndrew Geissler                             {"@odata.id",
1514cb92c03bSAndrew Geissler                              "/redfish/v1/Systems/system/LogServices/EventLog/"
1515cb92c03bSAndrew Geissler                              "Entries/" +
1516cb92c03bSAndrew Geissler                                  std::to_string(*id)},
151727062605SAnthony Wilson                             {"Name", "System Event Log Entry"},
1518cb92c03bSAndrew Geissler                             {"Id", std::to_string(*id)},
1519cb92c03bSAndrew Geissler                             {"Message", *message},
1520cb92c03bSAndrew Geissler                             {"EntryType", "Event"},
1521cb92c03bSAndrew Geissler                             {"Severity",
1522cb92c03bSAndrew Geissler                              translateSeverityDbusToRedfish(*severity)},
1523cb92c03bSAndrew Geissler                             {"Created", crow::utility::getDateTime(timestamp)}};
1524cb92c03bSAndrew Geissler                     }
1525cb92c03bSAndrew Geissler                 }
1526cb92c03bSAndrew Geissler                 std::sort(entriesArray.begin(), entriesArray.end(),
1527cb92c03bSAndrew Geissler                           [](const nlohmann::json& left,
1528cb92c03bSAndrew Geissler                              const nlohmann::json& right) {
1529cb92c03bSAndrew Geissler                               return (left["Id"] <= right["Id"]);
1530cb92c03bSAndrew Geissler                           });
1531cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue["Members@odata.count"] =
1532cb92c03bSAndrew Geissler                     entriesArray.size();
1533cb92c03bSAndrew Geissler             },
1534cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
1535cb92c03bSAndrew Geissler             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1536c4bf6374SJason M. Bills     }
1537c4bf6374SJason M. Bills };
1538c4bf6374SJason M. Bills 
153908a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node
1540c4bf6374SJason M. Bills {
1541c4bf6374SJason M. Bills   public:
154208a4e4b5SAnthony Wilson     DBusEventLogEntry(CrowApp& app) :
1543c4bf6374SJason M. Bills         Node(app,
1544029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1545029573d4SEd Tanous              std::string())
1546c4bf6374SJason M. Bills     {
1547c4bf6374SJason M. Bills         entityPrivileges = {
1548c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1549c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1550c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1551c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1552c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1553c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1554c4bf6374SJason M. Bills     }
1555c4bf6374SJason M. Bills 
1556c4bf6374SJason M. Bills   private:
1557c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1558c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1559c4bf6374SJason M. Bills     {
1560c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1561029573d4SEd Tanous         if (params.size() != 1)
1562c4bf6374SJason M. Bills         {
1563c4bf6374SJason M. Bills             messages::internalError(asyncResp->res);
1564c4bf6374SJason M. Bills             return;
1565c4bf6374SJason M. Bills         }
1566029573d4SEd Tanous         const std::string& entryID = params[0];
1567cb92c03bSAndrew Geissler 
1568cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1569cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1570cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1571cb92c03bSAndrew Geissler             [asyncResp, entryID](const boost::system::error_code ec,
1572cb92c03bSAndrew Geissler                                  GetManagedPropertyType& resp) {
1573cb92c03bSAndrew Geissler                 if (ec)
1574cb92c03bSAndrew Geissler                 {
1575cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1576cb92c03bSAndrew Geissler                         << "EventLogEntry (DBus) resp_handler got error " << ec;
1577cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1578cb92c03bSAndrew Geissler                     return;
1579cb92c03bSAndrew Geissler                 }
158066664f25SEd Tanous                 uint32_t* id = nullptr;
158166664f25SEd Tanous                 std::time_t timestamp{};
158266664f25SEd Tanous                 std::string* severity = nullptr;
158366664f25SEd Tanous                 std::string* message = nullptr;
1584cb92c03bSAndrew Geissler                 for (auto& propertyMap : resp)
1585cb92c03bSAndrew Geissler                 {
1586cb92c03bSAndrew Geissler                     if (propertyMap.first == "Id")
1587cb92c03bSAndrew Geissler                     {
1588cb92c03bSAndrew Geissler                         id = std::get_if<uint32_t>(&propertyMap.second);
1589cb92c03bSAndrew Geissler                         if (id == nullptr)
1590cb92c03bSAndrew Geissler                         {
1591cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res, "Id");
1592cb92c03bSAndrew Geissler                         }
1593cb92c03bSAndrew Geissler                     }
1594cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Timestamp")
1595cb92c03bSAndrew Geissler                     {
1596cb92c03bSAndrew Geissler                         const uint64_t* millisTimeStamp =
1597cb92c03bSAndrew Geissler                             std::get_if<uint64_t>(&propertyMap.second);
1598cb92c03bSAndrew Geissler                         if (millisTimeStamp == nullptr)
1599cb92c03bSAndrew Geissler                         {
1600cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1601cb92c03bSAndrew Geissler                                                       "Timestamp");
1602271584abSEd Tanous                             continue;
1603cb92c03bSAndrew Geissler                         }
1604cb92c03bSAndrew Geissler                         // Retrieve Created property with format:
1605cb92c03bSAndrew Geissler                         // yyyy-mm-ddThh:mm:ss
1606cb92c03bSAndrew Geissler                         std::chrono::milliseconds chronoTimeStamp(
1607cb92c03bSAndrew Geissler                             *millisTimeStamp);
1608cb92c03bSAndrew Geissler                         timestamp =
1609271584abSEd Tanous                             std::chrono::duration_cast<
1610271584abSEd Tanous                                 std::chrono::duration<int>>(chronoTimeStamp)
1611cb92c03bSAndrew Geissler                                 .count();
1612cb92c03bSAndrew Geissler                     }
1613cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Severity")
1614cb92c03bSAndrew Geissler                     {
1615cb92c03bSAndrew Geissler                         severity =
1616cb92c03bSAndrew Geissler                             std::get_if<std::string>(&propertyMap.second);
1617cb92c03bSAndrew Geissler                         if (severity == nullptr)
1618cb92c03bSAndrew Geissler                         {
1619cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1620cb92c03bSAndrew Geissler                                                       "Severity");
1621cb92c03bSAndrew Geissler                         }
1622cb92c03bSAndrew Geissler                     }
1623cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Message")
1624cb92c03bSAndrew Geissler                     {
1625cb92c03bSAndrew Geissler                         message = std::get_if<std::string>(&propertyMap.second);
1626cb92c03bSAndrew Geissler                         if (message == nullptr)
1627cb92c03bSAndrew Geissler                         {
1628cb92c03bSAndrew Geissler                             messages::propertyMissing(asyncResp->res,
1629cb92c03bSAndrew Geissler                                                       "Message");
1630cb92c03bSAndrew Geissler                         }
1631cb92c03bSAndrew Geissler                     }
1632cb92c03bSAndrew Geissler                 }
1633271584abSEd Tanous                 if (id == nullptr || message == nullptr || severity == nullptr)
1634271584abSEd Tanous                 {
1635271584abSEd Tanous                     return;
1636271584abSEd Tanous                 }
1637cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue = {
1638cb92c03bSAndrew Geissler                     {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1639cb92c03bSAndrew Geissler                     {"@odata.id",
1640cb92c03bSAndrew Geissler                      "/redfish/v1/Systems/system/LogServices/EventLog/"
1641cb92c03bSAndrew Geissler                      "Entries/" +
1642cb92c03bSAndrew Geissler                          std::to_string(*id)},
164327062605SAnthony Wilson                     {"Name", "System Event Log Entry"},
1644cb92c03bSAndrew Geissler                     {"Id", std::to_string(*id)},
1645cb92c03bSAndrew Geissler                     {"Message", *message},
1646cb92c03bSAndrew Geissler                     {"EntryType", "Event"},
1647cb92c03bSAndrew Geissler                     {"Severity", translateSeverityDbusToRedfish(*severity)},
164808a4e4b5SAnthony Wilson                     {"Created", crow::utility::getDateTime(timestamp)}};
1649cb92c03bSAndrew Geissler             },
1650cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging",
1651cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging/entry/" + entryID,
1652cb92c03bSAndrew Geissler             "org.freedesktop.DBus.Properties", "GetAll",
1653cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging.Entry");
1654c4bf6374SJason M. Bills     }
1655336e96c6SChicago Duan 
1656336e96c6SChicago Duan     void doDelete(crow::Response& res, const crow::Request& req,
1657336e96c6SChicago Duan                   const std::vector<std::string>& params) override
1658336e96c6SChicago Duan     {
1659336e96c6SChicago Duan 
1660336e96c6SChicago Duan         BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1661336e96c6SChicago Duan 
1662336e96c6SChicago Duan         auto asyncResp = std::make_shared<AsyncResp>(res);
1663336e96c6SChicago Duan 
1664336e96c6SChicago Duan         if (params.size() != 1)
1665336e96c6SChicago Duan         {
1666336e96c6SChicago Duan             messages::internalError(asyncResp->res);
1667336e96c6SChicago Duan             return;
1668336e96c6SChicago Duan         }
1669336e96c6SChicago Duan         std::string entryID = params[0];
1670336e96c6SChicago Duan 
1671336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
1672336e96c6SChicago Duan 
1673336e96c6SChicago Duan         // Process response from Logging service.
1674336e96c6SChicago Duan         auto respHandler = [asyncResp](const boost::system::error_code ec) {
1675336e96c6SChicago Duan             BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1676336e96c6SChicago Duan             if (ec)
1677336e96c6SChicago Duan             {
1678336e96c6SChicago Duan                 // TODO Handle for specific error code
1679336e96c6SChicago Duan                 BMCWEB_LOG_ERROR
1680336e96c6SChicago Duan                     << "EventLogEntry (DBus) doDelete respHandler got error "
1681336e96c6SChicago Duan                     << ec;
1682336e96c6SChicago Duan                 asyncResp->res.result(
1683336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
1684336e96c6SChicago Duan                 return;
1685336e96c6SChicago Duan             }
1686336e96c6SChicago Duan 
1687336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
1688336e96c6SChicago Duan         };
1689336e96c6SChicago Duan 
1690336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
1691336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
1692336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
1693336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
1694336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
1695336e96c6SChicago Duan     }
1696c4bf6374SJason M. Bills };
1697c4bf6374SJason M. Bills 
1698c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node
1699c4bf6374SJason M. Bills {
1700c4bf6374SJason M. Bills   public:
1701c4bf6374SJason M. Bills     template <typename CrowApp>
1702c4bf6374SJason M. Bills     BMCLogServiceCollection(CrowApp& app) :
17034ed77cd5SEd Tanous         Node(app, "/redfish/v1/Managers/bmc/LogServices/")
17041da66f75SEd Tanous     {
17051da66f75SEd Tanous         entityPrivileges = {
1706e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1707e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1708e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1709e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1710e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1711e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
17121da66f75SEd Tanous     }
17131da66f75SEd Tanous 
17141da66f75SEd Tanous   private:
17151da66f75SEd Tanous     /**
17161da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
17171da66f75SEd Tanous      */
17181da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
17191da66f75SEd Tanous                const std::vector<std::string>& params) override
17201da66f75SEd Tanous     {
1721e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
17221da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
17231da66f75SEd Tanous         // it has a duplicate entry for members
1724e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
17251da66f75SEd Tanous             "#LogServiceCollection.LogServiceCollection";
1726e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1727e1f26343SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices";
1728e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1729e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
17301da66f75SEd Tanous             "Collection of LogServices for this Manager";
1731c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1732c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
17335cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
17345cb1dd27SAsmitha Karunanithi         logServiceArray.push_back(
17355cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}});
17365cb1dd27SAsmitha Karunanithi #endif
1737c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1738c4bf6374SJason M. Bills         logServiceArray.push_back(
173908a4e4b5SAnthony Wilson             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1740c4bf6374SJason M. Bills #endif
1741e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
1742c4bf6374SJason M. Bills             logServiceArray.size();
17431da66f75SEd Tanous     }
17441da66f75SEd Tanous };
17451da66f75SEd Tanous 
1746c4bf6374SJason M. Bills class BMCJournalLogService : public Node
17471da66f75SEd Tanous {
17481da66f75SEd Tanous   public:
17491da66f75SEd Tanous     template <typename CrowApp>
1750c4bf6374SJason M. Bills     BMCJournalLogService(CrowApp& app) :
1751c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1752e1f26343SJason M. Bills     {
1753e1f26343SJason M. Bills         entityPrivileges = {
1754e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1755e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1756e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1757e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1758e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1759e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1760e1f26343SJason M. Bills     }
1761e1f26343SJason M. Bills 
1762e1f26343SJason M. Bills   private:
1763e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1764e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1765e1f26343SJason M. Bills     {
1766e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1767e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1768e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
17690f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
17700f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
1771c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
1772c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
1773c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "BMC Journal";
1774e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1775cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1776cd50aa42SJason M. Bills             {"@odata.id",
1777086be238SEd Tanous              "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
1778e1f26343SJason M. Bills     }
1779e1f26343SJason M. Bills };
1780e1f26343SJason M. Bills 
1781c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1782e1f26343SJason M. Bills                                       sd_journal* journal,
1783c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
1784e1f26343SJason M. Bills {
1785e1f26343SJason M. Bills     // Get the Log Entry contents
1786e1f26343SJason M. Bills     int ret = 0;
1787e1f26343SJason M. Bills 
178839e77504SEd Tanous     std::string_view msg;
178916428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1790e1f26343SJason M. Bills     if (ret < 0)
1791e1f26343SJason M. Bills     {
1792e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1793e1f26343SJason M. Bills         return 1;
1794e1f26343SJason M. Bills     }
1795e1f26343SJason M. Bills 
1796e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1797271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
179816428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1799e1f26343SJason M. Bills     if (ret < 0)
1800e1f26343SJason M. Bills     {
1801e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
1802e1f26343SJason M. Bills     }
1803e1f26343SJason M. Bills 
1804e1f26343SJason M. Bills     // Get the Created time from the timestamp
180516428a1aSJason M. Bills     std::string entryTimeStr;
180616428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
1807e1f26343SJason M. Bills     {
180816428a1aSJason M. Bills         return 1;
1809e1f26343SJason M. Bills     }
1810e1f26343SJason M. Bills 
1811e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
1812c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
1813cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1814c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1815c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
1816e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
1817c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
181816428a1aSJason M. Bills         {"Message", msg},
1819e1f26343SJason M. Bills         {"EntryType", "Oem"},
1820e1f26343SJason M. Bills         {"Severity",
1821b6a61a5eSJason M. Bills          severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"},
1822086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
1823e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
1824e1f26343SJason M. Bills     return 0;
1825e1f26343SJason M. Bills }
1826e1f26343SJason M. Bills 
1827c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node
1828e1f26343SJason M. Bills {
1829e1f26343SJason M. Bills   public:
1830e1f26343SJason M. Bills     template <typename CrowApp>
1831c4bf6374SJason M. Bills     BMCJournalLogEntryCollection(CrowApp& app) :
1832c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
1833e1f26343SJason M. Bills     {
1834e1f26343SJason M. Bills         entityPrivileges = {
1835e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1836e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1837e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1838e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1839e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1840e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1841e1f26343SJason M. Bills     }
1842e1f26343SJason M. Bills 
1843e1f26343SJason M. Bills   private:
1844e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1845e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1846e1f26343SJason M. Bills     {
1847e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1848193ad2faSJason M. Bills         static constexpr const long maxEntriesPerPage = 1000;
1849271584abSEd Tanous         uint64_t skip = 0;
1850271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
185116428a1aSJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1852193ad2faSJason M. Bills         {
1853193ad2faSJason M. Bills             return;
1854193ad2faSJason M. Bills         }
185516428a1aSJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1856193ad2faSJason M. Bills         {
1857193ad2faSJason M. Bills             return;
1858193ad2faSJason M. Bills         }
1859e1f26343SJason M. Bills         // Collections don't include the static data added by SubRoute because
1860e1f26343SJason M. Bills         // it has a duplicate entry for members
1861e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1862e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
18630f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
18640f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1865e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1866c4bf6374SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1867e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1868e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1869e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
18700f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
18710f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries";
1872e1f26343SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1873e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
1874e1f26343SJason M. Bills 
1875e1f26343SJason M. Bills         // Go through the journal and use the timestamp to create a unique ID
1876e1f26343SJason M. Bills         // for each entry
1877e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1878e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1879e1f26343SJason M. Bills         if (ret < 0)
1880e1f26343SJason M. Bills         {
1881e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1882f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1883e1f26343SJason M. Bills             return;
1884e1f26343SJason M. Bills         }
1885e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1886e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1887e1f26343SJason M. Bills         journalTmp = nullptr;
1888b01bf299SEd Tanous         uint64_t entryCount = 0;
1889e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
1890e85d6b16SJason M. Bills         bool firstEntry = true;
1891e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
1892e1f26343SJason M. Bills         {
1893193ad2faSJason M. Bills             entryCount++;
1894193ad2faSJason M. Bills             // Handle paging using skip (number of entries to skip from the
1895193ad2faSJason M. Bills             // start) and top (number of entries to display)
1896193ad2faSJason M. Bills             if (entryCount <= skip || entryCount > skip + top)
1897193ad2faSJason M. Bills             {
1898193ad2faSJason M. Bills                 continue;
1899193ad2faSJason M. Bills             }
1900193ad2faSJason M. Bills 
190116428a1aSJason M. Bills             std::string idStr;
1902e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1903e1f26343SJason M. Bills             {
1904e1f26343SJason M. Bills                 continue;
1905e1f26343SJason M. Bills             }
1906e1f26343SJason M. Bills 
1907e85d6b16SJason M. Bills             if (firstEntry)
1908e85d6b16SJason M. Bills             {
1909e85d6b16SJason M. Bills                 firstEntry = false;
1910e85d6b16SJason M. Bills             }
1911e85d6b16SJason M. Bills 
1912e1f26343SJason M. Bills             logEntryArray.push_back({});
1913c4bf6374SJason M. Bills             nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
1914c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
1915c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
1916e1f26343SJason M. Bills             {
1917f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
1918e1f26343SJason M. Bills                 return;
1919e1f26343SJason M. Bills             }
1920e1f26343SJason M. Bills         }
1921193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1922193ad2faSJason M. Bills         if (skip + top < entryCount)
1923193ad2faSJason M. Bills         {
1924193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
1925c4bf6374SJason M. Bills                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
1926193ad2faSJason M. Bills                 std::to_string(skip + top);
1927193ad2faSJason M. Bills         }
1928e1f26343SJason M. Bills     }
1929e1f26343SJason M. Bills };
1930e1f26343SJason M. Bills 
1931c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node
1932e1f26343SJason M. Bills {
1933e1f26343SJason M. Bills   public:
1934c4bf6374SJason M. Bills     BMCJournalLogEntry(CrowApp& app) :
1935c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/",
1936e1f26343SJason M. Bills              std::string())
1937e1f26343SJason M. Bills     {
1938e1f26343SJason M. Bills         entityPrivileges = {
1939e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1940e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1941e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1942e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1943e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1944e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1945e1f26343SJason M. Bills     }
1946e1f26343SJason M. Bills 
1947e1f26343SJason M. Bills   private:
1948e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1949e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1950e1f26343SJason M. Bills     {
1951e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1952e1f26343SJason M. Bills         if (params.size() != 1)
1953e1f26343SJason M. Bills         {
1954f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1955e1f26343SJason M. Bills             return;
1956e1f26343SJason M. Bills         }
195716428a1aSJason M. Bills         const std::string& entryID = params[0];
1958e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
1959e1f26343SJason M. Bills         uint64_t ts = 0;
1960271584abSEd Tanous         uint64_t index = 0;
196116428a1aSJason M. Bills         if (!getTimestampFromID(asyncResp->res, entryID, ts, index))
1962e1f26343SJason M. Bills         {
196316428a1aSJason M. Bills             return;
1964e1f26343SJason M. Bills         }
1965e1f26343SJason M. Bills 
1966e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1967e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1968e1f26343SJason M. Bills         if (ret < 0)
1969e1f26343SJason M. Bills         {
1970e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1971f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1972e1f26343SJason M. Bills             return;
1973e1f26343SJason M. Bills         }
1974e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1975e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1976e1f26343SJason M. Bills         journalTmp = nullptr;
1977e1f26343SJason M. Bills         // Go to the timestamp in the log and move to the entry at the index
1978af07e3f5SJason M. Bills         // tracking the unique ID
1979af07e3f5SJason M. Bills         std::string idStr;
1980af07e3f5SJason M. Bills         bool firstEntry = true;
1981e1f26343SJason M. Bills         ret = sd_journal_seek_realtime_usec(journal.get(), ts);
19822056b6d1SManojkiran Eda         if (ret < 0)
19832056b6d1SManojkiran Eda         {
19842056b6d1SManojkiran Eda             BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
19852056b6d1SManojkiran Eda                              << strerror(-ret);
19862056b6d1SManojkiran Eda             messages::internalError(asyncResp->res);
19872056b6d1SManojkiran Eda             return;
19882056b6d1SManojkiran Eda         }
1989271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
1990e1f26343SJason M. Bills         {
1991e1f26343SJason M. Bills             sd_journal_next(journal.get());
1992af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1993af07e3f5SJason M. Bills             {
1994af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
1995af07e3f5SJason M. Bills                 return;
1996af07e3f5SJason M. Bills             }
1997af07e3f5SJason M. Bills             if (firstEntry)
1998af07e3f5SJason M. Bills             {
1999af07e3f5SJason M. Bills                 firstEntry = false;
2000af07e3f5SJason M. Bills             }
2001e1f26343SJason M. Bills         }
2002c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
2003af07e3f5SJason M. Bills         if (idStr != entryID)
2004c4bf6374SJason M. Bills         {
2005c4bf6374SJason M. Bills             messages::resourceMissingAtURI(asyncResp->res, entryID);
2006c4bf6374SJason M. Bills             return;
2007c4bf6374SJason M. Bills         }
2008c4bf6374SJason M. Bills 
2009c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
2010e1f26343SJason M. Bills                                        asyncResp->res.jsonValue) != 0)
2011e1f26343SJason M. Bills         {
2012f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2013e1f26343SJason M. Bills             return;
2014e1f26343SJason M. Bills         }
2015e1f26343SJason M. Bills     }
2016e1f26343SJason M. Bills };
2017e1f26343SJason M. Bills 
20185cb1dd27SAsmitha Karunanithi class BMCDumpService : public Node
2019c9bb6861Sraviteja-b {
2020c9bb6861Sraviteja-b   public:
2021c9bb6861Sraviteja-b     template <typename CrowApp>
20225cb1dd27SAsmitha Karunanithi     BMCDumpService(CrowApp& app) :
20235cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2024c9bb6861Sraviteja-b     {
2025c9bb6861Sraviteja-b         entityPrivileges = {
2026c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2027c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2028c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2029c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2030c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2031c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2032c9bb6861Sraviteja-b     }
2033c9bb6861Sraviteja-b 
2034c9bb6861Sraviteja-b   private:
2035c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
2036c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2037c9bb6861Sraviteja-b     {
2038c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2039c9bb6861Sraviteja-b 
2040c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
20415cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump";
2042c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2043c9bb6861Sraviteja-b             "#LogService.v1_1_0.LogService";
2044c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "Dump LogService";
20455cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
20465cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
2047c9bb6861Sraviteja-b         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2048c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Entries"] = {
20495cb1dd27SAsmitha Karunanithi             {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
20505cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
20515cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
20525cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
20535cb1dd27SAsmitha Karunanithi                          "Actions/LogService.ClearLog"}}},
20545cb1dd27SAsmitha Karunanithi             {"Oem",
20555cb1dd27SAsmitha Karunanithi              {{"#OemLogService.CollectDiagnosticData",
20565cb1dd27SAsmitha Karunanithi                {{"target",
20575cb1dd27SAsmitha Karunanithi                  "/redfish/v1/Managers/bmc/LogServices/Dump/"
20585cb1dd27SAsmitha Karunanithi                  "Actions/Oem/OemLogService.CollectDiagnosticData"}}}}}};
2059c9bb6861Sraviteja-b     }
2060c9bb6861Sraviteja-b };
2061c9bb6861Sraviteja-b 
20625cb1dd27SAsmitha Karunanithi class BMCDumpEntryCollection : public Node
2063c9bb6861Sraviteja-b {
2064c9bb6861Sraviteja-b   public:
2065c9bb6861Sraviteja-b     template <typename CrowApp>
20665cb1dd27SAsmitha Karunanithi     BMCDumpEntryCollection(CrowApp& app) :
20675cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2068c9bb6861Sraviteja-b     {
2069c9bb6861Sraviteja-b         entityPrivileges = {
2070c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2071c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2072c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2073c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2074c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2075c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2076c9bb6861Sraviteja-b     }
2077c9bb6861Sraviteja-b 
2078c9bb6861Sraviteja-b   private:
2079c9bb6861Sraviteja-b     /**
2080c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
2081c9bb6861Sraviteja-b      */
2082c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
2083c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2084c9bb6861Sraviteja-b     {
2085c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2086c9bb6861Sraviteja-b 
2087c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2088c9bb6861Sraviteja-b             "#LogEntryCollection.LogEntryCollection";
2089c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
20905cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
20915cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
2092c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] =
20935cb1dd27SAsmitha Karunanithi             "Collection of BMC Dump Entries";
2094c9bb6861Sraviteja-b 
20955cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "BMC");
2096c9bb6861Sraviteja-b     }
2097c9bb6861Sraviteja-b };
2098c9bb6861Sraviteja-b 
20995cb1dd27SAsmitha Karunanithi class BMCDumpEntry : public Node
2100c9bb6861Sraviteja-b {
2101c9bb6861Sraviteja-b   public:
21025cb1dd27SAsmitha Karunanithi     BMCDumpEntry(CrowApp& app) :
21035cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/",
2104c9bb6861Sraviteja-b              std::string())
2105c9bb6861Sraviteja-b     {
2106c9bb6861Sraviteja-b         entityPrivileges = {
2107c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2108c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2109c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2110c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2111c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2112c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2113c9bb6861Sraviteja-b     }
2114c9bb6861Sraviteja-b 
2115c9bb6861Sraviteja-b   private:
2116c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
2117c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2118c9bb6861Sraviteja-b     {
2119c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2120c9bb6861Sraviteja-b         if (params.size() != 1)
2121c9bb6861Sraviteja-b         {
2122c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2123c9bb6861Sraviteja-b             return;
2124c9bb6861Sraviteja-b         }
21255cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "BMC");
2126c9bb6861Sraviteja-b     }
2127c9bb6861Sraviteja-b 
2128c9bb6861Sraviteja-b     void doDelete(crow::Response& res, const crow::Request& req,
2129c9bb6861Sraviteja-b                   const std::vector<std::string>& params) override
2130c9bb6861Sraviteja-b     {
21315cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2132c9bb6861Sraviteja-b         if (params.size() != 1)
2133c9bb6861Sraviteja-b         {
2134c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2135c9bb6861Sraviteja-b             return;
2136c9bb6861Sraviteja-b         }
21375cb1dd27SAsmitha Karunanithi         deleteDumpEntry(asyncResp->res, params[0]);
21385cb1dd27SAsmitha Karunanithi     }
21395cb1dd27SAsmitha Karunanithi };
2140c9bb6861Sraviteja-b 
2141a43be80fSAsmitha Karunanithi class BMCDumpCreate : public Node
2142a43be80fSAsmitha Karunanithi {
2143a43be80fSAsmitha Karunanithi   public:
2144a43be80fSAsmitha Karunanithi     BMCDumpCreate(CrowApp& app) :
2145a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2146a43be80fSAsmitha Karunanithi                   "Actions/Oem/"
2147a43be80fSAsmitha Karunanithi                   "OemLogService.CollectDiagnosticData/")
2148a43be80fSAsmitha Karunanithi     {
2149a43be80fSAsmitha Karunanithi         entityPrivileges = {
2150a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2151a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2152a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2153a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2154a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2155a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2156a43be80fSAsmitha Karunanithi     }
2157a43be80fSAsmitha Karunanithi 
2158a43be80fSAsmitha Karunanithi   private:
2159a43be80fSAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
2160a43be80fSAsmitha Karunanithi                 const std::vector<std::string>& params) override
2161a43be80fSAsmitha Karunanithi     {
2162a43be80fSAsmitha Karunanithi         createDump(res, req, "BMC");
2163a43be80fSAsmitha Karunanithi     }
2164a43be80fSAsmitha Karunanithi };
2165a43be80fSAsmitha Karunanithi 
2166*80319af1SAsmitha Karunanithi class BMCDumpClear : public Node
2167*80319af1SAsmitha Karunanithi {
2168*80319af1SAsmitha Karunanithi   public:
2169*80319af1SAsmitha Karunanithi     BMCDumpClear(CrowApp& app) :
2170*80319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2171*80319af1SAsmitha Karunanithi                   "Actions/"
2172*80319af1SAsmitha Karunanithi                   "LogService.ClearLog/")
2173*80319af1SAsmitha Karunanithi     {
2174*80319af1SAsmitha Karunanithi         entityPrivileges = {
2175*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2176*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2177*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2178*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2179*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2180*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2181*80319af1SAsmitha Karunanithi     }
2182*80319af1SAsmitha Karunanithi 
2183*80319af1SAsmitha Karunanithi   private:
2184*80319af1SAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
2185*80319af1SAsmitha Karunanithi                 const std::vector<std::string>& params) override
2186*80319af1SAsmitha Karunanithi     {
2187*80319af1SAsmitha Karunanithi         clearDump(res, "xyz.openbmc_project.Dump.Entry.BMC");
2188*80319af1SAsmitha Karunanithi     }
2189*80319af1SAsmitha Karunanithi };
2190*80319af1SAsmitha Karunanithi 
21915cb1dd27SAsmitha Karunanithi class SystemDumpService : public Node
2192c9bb6861Sraviteja-b {
21935cb1dd27SAsmitha Karunanithi   public:
21945cb1dd27SAsmitha Karunanithi     template <typename CrowApp>
21955cb1dd27SAsmitha Karunanithi     SystemDumpService(CrowApp& app) :
21965cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/")
21975cb1dd27SAsmitha Karunanithi     {
21985cb1dd27SAsmitha Karunanithi         entityPrivileges = {
21995cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22005cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22015cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22025cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22035cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22045cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22055cb1dd27SAsmitha Karunanithi     }
22065cb1dd27SAsmitha Karunanithi 
22075cb1dd27SAsmitha Karunanithi   private:
22085cb1dd27SAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
22095cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
22105cb1dd27SAsmitha Karunanithi     {
22115cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22125cb1dd27SAsmitha Karunanithi 
22135cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
22145cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump";
22155cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
22165cb1dd27SAsmitha Karunanithi             "#LogService.v1_1_0.LogService";
22175cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "Dump LogService";
22185cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "System Dump LogService";
22195cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
22205cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
22215cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Entries"] = {
22225cb1dd27SAsmitha Karunanithi             {"@odata.id",
22235cb1dd27SAsmitha Karunanithi              "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
22245cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
22255cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
22265cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
22275cb1dd27SAsmitha Karunanithi                          "LogService.ClearLog"}}},
22285cb1dd27SAsmitha Karunanithi             {"Oem",
22295cb1dd27SAsmitha Karunanithi              {{"#OemLogService.CollectDiagnosticData",
22305cb1dd27SAsmitha Karunanithi                {{"target",
22315cb1dd27SAsmitha Karunanithi                  "/redfish/v1/Systems/system/LogServices/Dump/Actions/Oem/"
22325cb1dd27SAsmitha Karunanithi                  "OemLogService.CollectDiagnosticData"}}}}}};
22335cb1dd27SAsmitha Karunanithi     }
22345cb1dd27SAsmitha Karunanithi };
22355cb1dd27SAsmitha Karunanithi 
22365cb1dd27SAsmitha Karunanithi class SystemDumpEntryCollection : public Node
22375cb1dd27SAsmitha Karunanithi {
22385cb1dd27SAsmitha Karunanithi   public:
22395cb1dd27SAsmitha Karunanithi     template <typename CrowApp>
22405cb1dd27SAsmitha Karunanithi     SystemDumpEntryCollection(CrowApp& app) :
22415cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
22425cb1dd27SAsmitha Karunanithi     {
22435cb1dd27SAsmitha Karunanithi         entityPrivileges = {
22445cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22455cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22465cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22475cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22485cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22495cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22505cb1dd27SAsmitha Karunanithi     }
22515cb1dd27SAsmitha Karunanithi 
22525cb1dd27SAsmitha Karunanithi   private:
22535cb1dd27SAsmitha Karunanithi     /**
22545cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
22555cb1dd27SAsmitha Karunanithi      */
22565cb1dd27SAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
22575cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
22585cb1dd27SAsmitha Karunanithi     {
22595cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22605cb1dd27SAsmitha Karunanithi 
22615cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
22625cb1dd27SAsmitha Karunanithi             "#LogEntryCollection.LogEntryCollection";
22635cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
22645cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump/Entries";
22655cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "System Dump Entries";
22665cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] =
22675cb1dd27SAsmitha Karunanithi             "Collection of System Dump Entries";
22685cb1dd27SAsmitha Karunanithi 
22695cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "System");
22705cb1dd27SAsmitha Karunanithi     }
22715cb1dd27SAsmitha Karunanithi };
22725cb1dd27SAsmitha Karunanithi 
22735cb1dd27SAsmitha Karunanithi class SystemDumpEntry : public Node
22745cb1dd27SAsmitha Karunanithi {
22755cb1dd27SAsmitha Karunanithi   public:
22765cb1dd27SAsmitha Karunanithi     SystemDumpEntry(CrowApp& app) :
22775cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/",
22785cb1dd27SAsmitha Karunanithi              std::string())
22795cb1dd27SAsmitha Karunanithi     {
22805cb1dd27SAsmitha Karunanithi         entityPrivileges = {
22815cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22825cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22835cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22845cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22855cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22865cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22875cb1dd27SAsmitha Karunanithi     }
22885cb1dd27SAsmitha Karunanithi 
22895cb1dd27SAsmitha Karunanithi   private:
22905cb1dd27SAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
22915cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
22925cb1dd27SAsmitha Karunanithi     {
22935cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22945cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
22955cb1dd27SAsmitha Karunanithi         {
2296c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2297c9bb6861Sraviteja-b             return;
2298c9bb6861Sraviteja-b         }
22995cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "System");
23005cb1dd27SAsmitha Karunanithi     }
2301c9bb6861Sraviteja-b 
23025cb1dd27SAsmitha Karunanithi     void doDelete(crow::Response& res, const crow::Request& req,
23035cb1dd27SAsmitha Karunanithi                   const std::vector<std::string>& params) override
2304c9bb6861Sraviteja-b     {
23055cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
23065cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
2307c9bb6861Sraviteja-b         {
23085cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
2309c9bb6861Sraviteja-b             return;
2310c9bb6861Sraviteja-b         }
23115cb1dd27SAsmitha Karunanithi         deleteDumpEntry(asyncResp->res, params[0]);
2312c9bb6861Sraviteja-b     }
2313c9bb6861Sraviteja-b };
2314c9bb6861Sraviteja-b 
2315a43be80fSAsmitha Karunanithi class SystemDumpCreate : public Node
2316a43be80fSAsmitha Karunanithi {
2317a43be80fSAsmitha Karunanithi   public:
2318a43be80fSAsmitha Karunanithi     SystemDumpCreate(CrowApp& app) :
2319a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2320a43be80fSAsmitha Karunanithi                   "Actions/Oem/"
2321a43be80fSAsmitha Karunanithi                   "OemLogService.CollectDiagnosticData/")
2322a43be80fSAsmitha Karunanithi     {
2323a43be80fSAsmitha Karunanithi         entityPrivileges = {
2324a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2325a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2326a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2327a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2328a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2329a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2330a43be80fSAsmitha Karunanithi     }
2331a43be80fSAsmitha Karunanithi 
2332a43be80fSAsmitha Karunanithi   private:
2333a43be80fSAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
2334a43be80fSAsmitha Karunanithi                 const std::vector<std::string>& params) override
2335a43be80fSAsmitha Karunanithi     {
2336a43be80fSAsmitha Karunanithi         createDump(res, req, "System");
2337a43be80fSAsmitha Karunanithi     }
2338a43be80fSAsmitha Karunanithi };
2339a43be80fSAsmitha Karunanithi 
23400657843aSraviteja-b class SystemDumpEntryDownload : public Node
23410657843aSraviteja-b {
23420657843aSraviteja-b   public:
23430657843aSraviteja-b     SystemDumpEntryDownload(CrowApp& app) :
23440657843aSraviteja-b         Node(app,
23450657843aSraviteja-b              "/redfish/v1/Systems/system/LogServices/System/Entries/<str>/"
23460657843aSraviteja-b              "Actions/"
23470657843aSraviteja-b              "LogEntry.DownloadLog/",
23480657843aSraviteja-b              std::string())
23490657843aSraviteja-b     {
23500657843aSraviteja-b         entityPrivileges = {
23510657843aSraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
23520657843aSraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
23530657843aSraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
23540657843aSraviteja-b     }
23550657843aSraviteja-b 
23560657843aSraviteja-b   private:
23570657843aSraviteja-b     void doPost(crow::Response& res, const crow::Request& req,
23580657843aSraviteja-b                 const std::vector<std::string>& params) override
23590657843aSraviteja-b     {
23600657843aSraviteja-b         if (params.size() != 1)
23610657843aSraviteja-b         {
23620657843aSraviteja-b             messages::internalError(res);
23630657843aSraviteja-b             return;
23640657843aSraviteja-b         }
23650657843aSraviteja-b         const std::string& entryID = params[0];
23660657843aSraviteja-b         crow::obmc_dump::handleDumpOffloadUrl(req, res, entryID);
23670657843aSraviteja-b     }
23680657843aSraviteja-b };
23690657843aSraviteja-b 
2370013487e5Sraviteja-b class SystemDumpClear : public Node
2371013487e5Sraviteja-b {
2372013487e5Sraviteja-b   public:
2373013487e5Sraviteja-b     SystemDumpClear(CrowApp& app) :
2374*80319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2375013487e5Sraviteja-b                   "Actions/"
2376013487e5Sraviteja-b                   "LogService.ClearLog/")
2377013487e5Sraviteja-b     {
2378013487e5Sraviteja-b         entityPrivileges = {
2379013487e5Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2380013487e5Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2381*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2382*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2383*80319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2384013487e5Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2385013487e5Sraviteja-b     }
2386013487e5Sraviteja-b 
2387013487e5Sraviteja-b   private:
2388013487e5Sraviteja-b     void doPost(crow::Response& res, const crow::Request& req,
2389013487e5Sraviteja-b                 const std::vector<std::string>& params) override
2390013487e5Sraviteja-b     {
2391*80319af1SAsmitha Karunanithi         clearDump(res, "xyz.openbmc_project.Dump.Entry.System");
2392013487e5Sraviteja-b     }
2393013487e5Sraviteja-b };
2394013487e5Sraviteja-b 
2395424c4176SJason M. Bills class CrashdumpService : public Node
2396e1f26343SJason M. Bills {
2397e1f26343SJason M. Bills   public:
2398e1f26343SJason M. Bills     template <typename CrowApp>
2399424c4176SJason M. Bills     CrashdumpService(CrowApp& app) :
2400424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
24011da66f75SEd Tanous     {
24023946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
24033946028dSAppaRao Puli         // method for security reasons.
24041da66f75SEd Tanous         entityPrivileges = {
24053946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
24063946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2407e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2408e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2409e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2410e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
24111da66f75SEd Tanous     }
24121da66f75SEd Tanous 
24131da66f75SEd Tanous   private:
24141da66f75SEd Tanous     /**
24151da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
24161da66f75SEd Tanous      */
24171da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
24181da66f75SEd Tanous                const std::vector<std::string>& params) override
24191da66f75SEd Tanous     {
2420e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
24211da66f75SEd Tanous         // Copy over the static data to include the entries added by SubRoute
24220f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
2423424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
2424e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2425e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
24264f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
24274f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
24284f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2429e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2430e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
2431cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
2432cd50aa42SJason M. Bills             {"@odata.id",
2433424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
2434e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"] = {
24355b61b5e8SJason M. Bills             {"#LogService.ClearLog",
24365b61b5e8SJason M. Bills              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
24375b61b5e8SJason M. Bills                          "Actions/LogService.ClearLog"}}},
24381da66f75SEd Tanous             {"Oem",
2439424c4176SJason M. Bills              {{"#Crashdump.OnDemand",
2440424c4176SJason M. Bills                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
24416eda7685SKenny L. Ku                            "Actions/Oem/Crashdump.OnDemand"}}},
24426eda7685SKenny L. Ku               {"#Crashdump.Telemetry",
24436eda7685SKenny L. Ku                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
24446eda7685SKenny L. Ku                            "Actions/Oem/Crashdump.Telemetry"}}}}}};
24451da66f75SEd Tanous 
24461da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI
2447e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"]["Oem"].push_back(
2448424c4176SJason M. Bills             {"#Crashdump.SendRawPeci",
244908a4e4b5SAnthony Wilson              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
2450424c4176SJason M. Bills                          "Actions/Oem/Crashdump.SendRawPeci"}}});
24511da66f75SEd Tanous #endif
24521da66f75SEd Tanous     }
24531da66f75SEd Tanous };
24541da66f75SEd Tanous 
24555b61b5e8SJason M. Bills class CrashdumpClear : public Node
24565b61b5e8SJason M. Bills {
24575b61b5e8SJason M. Bills   public:
24585b61b5e8SJason M. Bills     CrashdumpClear(CrowApp& app) :
24595b61b5e8SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
24605b61b5e8SJason M. Bills                   "LogService.ClearLog/")
24615b61b5e8SJason M. Bills     {
24623946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
24633946028dSAppaRao Puli         // method for security reasons.
24645b61b5e8SJason M. Bills         entityPrivileges = {
24653946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
24663946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
24675b61b5e8SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
24685b61b5e8SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
24695b61b5e8SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
24705b61b5e8SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
24715b61b5e8SJason M. Bills     }
24725b61b5e8SJason M. Bills 
24735b61b5e8SJason M. Bills   private:
24745b61b5e8SJason M. Bills     void doPost(crow::Response& res, const crow::Request& req,
24755b61b5e8SJason M. Bills                 const std::vector<std::string>& params) override
24765b61b5e8SJason M. Bills     {
24775b61b5e8SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
24785b61b5e8SJason M. Bills 
24795b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
24805b61b5e8SJason M. Bills             [asyncResp](const boost::system::error_code ec,
24815b61b5e8SJason M. Bills                         const std::string& resp) {
24825b61b5e8SJason M. Bills                 if (ec)
24835b61b5e8SJason M. Bills                 {
24845b61b5e8SJason M. Bills                     messages::internalError(asyncResp->res);
24855b61b5e8SJason M. Bills                     return;
24865b61b5e8SJason M. Bills                 }
24875b61b5e8SJason M. Bills                 messages::success(asyncResp->res);
24885b61b5e8SJason M. Bills             },
24895b61b5e8SJason M. Bills             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
24905b61b5e8SJason M. Bills     }
24915b61b5e8SJason M. Bills };
24925b61b5e8SJason M. Bills 
2493e855dd28SJason M. Bills static void logCrashdumpEntry(std::shared_ptr<AsyncResp> asyncResp,
2494e855dd28SJason M. Bills                               const std::string& logID,
2495e855dd28SJason M. Bills                               nlohmann::json& logEntryJson)
2496e855dd28SJason M. Bills {
2497043a0536SJohnathan Mantey     auto getStoredLogCallback =
2498043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2499e855dd28SJason M. Bills             const boost::system::error_code ec,
2500043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>>& params) {
2501e855dd28SJason M. Bills             if (ec)
2502e855dd28SJason M. Bills             {
2503e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
25041ddcf01aSJason M. Bills                 if (ec.value() ==
25051ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
25061ddcf01aSJason M. Bills                 {
2507043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2508043a0536SJohnathan Mantey                                                logID);
25091ddcf01aSJason M. Bills                 }
25101ddcf01aSJason M. Bills                 else
25111ddcf01aSJason M. Bills                 {
2512e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
25131ddcf01aSJason M. Bills                 }
2514e855dd28SJason M. Bills                 return;
2515e855dd28SJason M. Bills             }
2516043a0536SJohnathan Mantey 
2517043a0536SJohnathan Mantey             std::string timestamp{};
2518043a0536SJohnathan Mantey             std::string filename{};
2519043a0536SJohnathan Mantey             std::string logfile{};
2520043a0536SJohnathan Mantey             ParseCrashdumpParameters(params, filename, timestamp, logfile);
2521043a0536SJohnathan Mantey 
2522043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2523e855dd28SJason M. Bills             {
2524043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2525e855dd28SJason M. Bills                 return;
2526e855dd28SJason M. Bills             }
2527e855dd28SJason M. Bills 
2528043a0536SJohnathan Mantey             std::string crashdumpURI =
2529e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2530043a0536SJohnathan Mantey                 logID + "/" + filename;
2531043a0536SJohnathan Mantey             logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2532043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2533043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2534e855dd28SJason M. Bills                                               logID},
2535e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2536e855dd28SJason M. Bills                             {"Id", logID},
2537e855dd28SJason M. Bills                             {"EntryType", "Oem"},
2538e855dd28SJason M. Bills                             {"OemRecordFormat", "Crashdump URI"},
2539043a0536SJohnathan Mantey                             {"Message", std::move(crashdumpURI)},
2540043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2541e855dd28SJason M. Bills         };
2542e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
25435b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
25445b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2545043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2546e855dd28SJason M. Bills }
2547e855dd28SJason M. Bills 
2548424c4176SJason M. Bills class CrashdumpEntryCollection : public Node
25491da66f75SEd Tanous {
25501da66f75SEd Tanous   public:
25511da66f75SEd Tanous     template <typename CrowApp>
2552424c4176SJason M. Bills     CrashdumpEntryCollection(CrowApp& app) :
2553424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
25541da66f75SEd Tanous     {
25553946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
25563946028dSAppaRao Puli         // method for security reasons.
25571da66f75SEd Tanous         entityPrivileges = {
25583946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
25593946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2560e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2561e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2562e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2563e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
25641da66f75SEd Tanous     }
25651da66f75SEd Tanous 
25661da66f75SEd Tanous   private:
25671da66f75SEd Tanous     /**
25681da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
25691da66f75SEd Tanous      */
25701da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
25711da66f75SEd Tanous                const std::vector<std::string>& params) override
25721da66f75SEd Tanous     {
2573e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
25741da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
25751da66f75SEd Tanous         // it has a duplicate entry for members
2576e1f26343SJason M. Bills         auto getLogEntriesCallback = [asyncResp](
2577e1f26343SJason M. Bills                                          const boost::system::error_code ec,
25781da66f75SEd Tanous                                          const std::vector<std::string>& resp) {
25791da66f75SEd Tanous             if (ec)
25801da66f75SEd Tanous             {
25811da66f75SEd Tanous                 if (ec.value() !=
25821da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
25831da66f75SEd Tanous                 {
25841da66f75SEd Tanous                     BMCWEB_LOG_DEBUG << "failed to get entries ec: "
25851da66f75SEd Tanous                                      << ec.message();
2586f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
25871da66f75SEd Tanous                     return;
25881da66f75SEd Tanous                 }
25891da66f75SEd Tanous             }
2590e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
25911da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
25920f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2593424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2594424c4176SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2595e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2596424c4176SJason M. Bills                 "Collection of Crashdump Entries";
2597e1f26343SJason M. Bills             nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2598e1f26343SJason M. Bills             logEntryArray = nlohmann::json::array();
2599e855dd28SJason M. Bills             std::vector<std::string> logIDs;
2600e855dd28SJason M. Bills             // Get the list of log entries and build up an empty array big
2601e855dd28SJason M. Bills             // enough to hold them
26021da66f75SEd Tanous             for (const std::string& objpath : resp)
26031da66f75SEd Tanous             {
2604e855dd28SJason M. Bills                 // Get the log ID
26054ed77cd5SEd Tanous                 std::size_t lastPos = objpath.rfind("/");
2606e855dd28SJason M. Bills                 if (lastPos == std::string::npos)
26071da66f75SEd Tanous                 {
2608e855dd28SJason M. Bills                     continue;
26091da66f75SEd Tanous                 }
2610e855dd28SJason M. Bills                 logIDs.emplace_back(objpath.substr(lastPos + 1));
2611e855dd28SJason M. Bills 
2612e855dd28SJason M. Bills                 // Add a space for the log entry to the array
2613e855dd28SJason M. Bills                 logEntryArray.push_back({});
2614e855dd28SJason M. Bills             }
2615e855dd28SJason M. Bills             // Now go through and set up async calls to fill in the entries
2616e855dd28SJason M. Bills             size_t index = 0;
2617e855dd28SJason M. Bills             for (const std::string& logID : logIDs)
2618e855dd28SJason M. Bills             {
2619e855dd28SJason M. Bills                 // Add the log entry to the array
2620e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
26211da66f75SEd Tanous             }
2622e1f26343SJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
2623e1f26343SJason M. Bills                 logEntryArray.size();
26241da66f75SEd Tanous         };
26251da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
26261da66f75SEd Tanous             std::move(getLogEntriesCallback),
26271da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper",
26281da66f75SEd Tanous             "/xyz/openbmc_project/object_mapper",
26291da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
26305b61b5e8SJason M. Bills             std::array<const char*, 1>{crashdumpInterface});
26311da66f75SEd Tanous     }
26321da66f75SEd Tanous };
26331da66f75SEd Tanous 
2634424c4176SJason M. Bills class CrashdumpEntry : public Node
26351da66f75SEd Tanous {
26361da66f75SEd Tanous   public:
2637424c4176SJason M. Bills     CrashdumpEntry(CrowApp& app) :
2638d53dd41fSJason M. Bills         Node(app,
2639424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/",
26401da66f75SEd Tanous              std::string())
26411da66f75SEd Tanous     {
26423946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
26433946028dSAppaRao Puli         // method for security reasons.
26441da66f75SEd Tanous         entityPrivileges = {
26453946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
26463946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2647e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2648e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2649e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2650e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
26511da66f75SEd Tanous     }
26521da66f75SEd Tanous 
26531da66f75SEd Tanous   private:
26541da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
26551da66f75SEd Tanous                const std::vector<std::string>& params) override
26561da66f75SEd Tanous     {
2657e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
26581da66f75SEd Tanous         if (params.size() != 1)
26591da66f75SEd Tanous         {
2660f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
26611da66f75SEd Tanous             return;
26621da66f75SEd Tanous         }
2663e855dd28SJason M. Bills         const std::string& logID = params[0];
2664e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
2665e855dd28SJason M. Bills     }
2666e855dd28SJason M. Bills };
2667e855dd28SJason M. Bills 
2668e855dd28SJason M. Bills class CrashdumpFile : public Node
2669e855dd28SJason M. Bills {
2670e855dd28SJason M. Bills   public:
2671e855dd28SJason M. Bills     CrashdumpFile(CrowApp& app) :
2672e855dd28SJason M. Bills         Node(app,
2673e855dd28SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/"
2674e855dd28SJason M. Bills              "<str>/",
2675e855dd28SJason M. Bills              std::string(), std::string())
2676e855dd28SJason M. Bills     {
26773946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
26783946028dSAppaRao Puli         // method for security reasons.
2679e855dd28SJason M. Bills         entityPrivileges = {
26803946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
26813946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2682e855dd28SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2683e855dd28SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2684e855dd28SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2685e855dd28SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2686e855dd28SJason M. Bills     }
2687e855dd28SJason M. Bills 
2688e855dd28SJason M. Bills   private:
2689e855dd28SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
2690e855dd28SJason M. Bills                const std::vector<std::string>& params) override
2691e855dd28SJason M. Bills     {
2692e855dd28SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2693e855dd28SJason M. Bills         if (params.size() != 2)
2694e855dd28SJason M. Bills         {
2695e855dd28SJason M. Bills             messages::internalError(asyncResp->res);
2696e855dd28SJason M. Bills             return;
2697e855dd28SJason M. Bills         }
2698e855dd28SJason M. Bills         const std::string& logID = params[0];
2699e855dd28SJason M. Bills         const std::string& fileName = params[1];
2700e855dd28SJason M. Bills 
2701043a0536SJohnathan Mantey         auto getStoredLogCallback =
2702043a0536SJohnathan Mantey             [asyncResp, logID, fileName](
2703abf2add6SEd Tanous                 const boost::system::error_code ec,
2704043a0536SJohnathan Mantey                 const std::vector<std::pair<std::string, VariantType>>& resp) {
27051da66f75SEd Tanous                 if (ec)
27061da66f75SEd Tanous                 {
2707043a0536SJohnathan Mantey                     BMCWEB_LOG_DEBUG << "failed to get log ec: "
2708043a0536SJohnathan Mantey                                      << ec.message();
2709f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
27101da66f75SEd Tanous                     return;
27111da66f75SEd Tanous                 }
2712e855dd28SJason M. Bills 
2713043a0536SJohnathan Mantey                 std::string dbusFilename{};
2714043a0536SJohnathan Mantey                 std::string dbusTimestamp{};
2715043a0536SJohnathan Mantey                 std::string dbusFilepath{};
2716043a0536SJohnathan Mantey 
2717043a0536SJohnathan Mantey                 ParseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
2718043a0536SJohnathan Mantey                                          dbusFilepath);
2719043a0536SJohnathan Mantey 
2720043a0536SJohnathan Mantey                 if (dbusFilename.empty() || dbusTimestamp.empty() ||
2721043a0536SJohnathan Mantey                     dbusFilepath.empty())
27221da66f75SEd Tanous                 {
2723e855dd28SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, fileName);
27241da66f75SEd Tanous                     return;
27251da66f75SEd Tanous                 }
2726e855dd28SJason M. Bills 
2727043a0536SJohnathan Mantey                 // Verify the file name parameter is correct
2728043a0536SJohnathan Mantey                 if (fileName != dbusFilename)
2729043a0536SJohnathan Mantey                 {
2730043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2731043a0536SJohnathan Mantey                     return;
2732043a0536SJohnathan Mantey                 }
2733043a0536SJohnathan Mantey 
2734043a0536SJohnathan Mantey                 if (!std::filesystem::exists(dbusFilepath))
2735043a0536SJohnathan Mantey                 {
2736043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2737043a0536SJohnathan Mantey                     return;
2738043a0536SJohnathan Mantey                 }
2739043a0536SJohnathan Mantey                 std::ifstream ifs(dbusFilepath, std::ios::in |
2740043a0536SJohnathan Mantey                                                     std::ios::binary |
2741043a0536SJohnathan Mantey                                                     std::ios::ate);
2742043a0536SJohnathan Mantey                 std::ifstream::pos_type fileSize = ifs.tellg();
2743043a0536SJohnathan Mantey                 if (fileSize < 0)
2744043a0536SJohnathan Mantey                 {
2745043a0536SJohnathan Mantey                     messages::generalError(asyncResp->res);
2746043a0536SJohnathan Mantey                     return;
2747043a0536SJohnathan Mantey                 }
2748043a0536SJohnathan Mantey                 ifs.seekg(0, std::ios::beg);
2749043a0536SJohnathan Mantey 
2750043a0536SJohnathan Mantey                 auto crashData = std::make_unique<char[]>(
2751043a0536SJohnathan Mantey                     static_cast<unsigned int>(fileSize));
2752043a0536SJohnathan Mantey 
2753043a0536SJohnathan Mantey                 ifs.read(crashData.get(), static_cast<int>(fileSize));
2754043a0536SJohnathan Mantey 
2755043a0536SJohnathan Mantey                 // The cast to std::string is intentional in order to use the
2756043a0536SJohnathan Mantey                 // assign() that applies move mechanics
2757043a0536SJohnathan Mantey                 asyncResp->res.body().assign(
2758043a0536SJohnathan Mantey                     static_cast<std::string>(crashData.get()));
2759043a0536SJohnathan Mantey 
2760043a0536SJohnathan Mantey                 // Configure this to be a file download when accessed from
2761043a0536SJohnathan Mantey                 // a browser
2762e855dd28SJason M. Bills                 asyncResp->res.addHeader("Content-Disposition", "attachment");
27631da66f75SEd Tanous             };
27641da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
27655b61b5e8SJason M. Bills             std::move(getStoredLogCallback), crashdumpObject,
27665b61b5e8SJason M. Bills             crashdumpPath + std::string("/") + logID,
2767043a0536SJohnathan Mantey             "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
27681da66f75SEd Tanous     }
27691da66f75SEd Tanous };
27701da66f75SEd Tanous 
2771424c4176SJason M. Bills class OnDemandCrashdump : public Node
27721da66f75SEd Tanous {
27731da66f75SEd Tanous   public:
2774424c4176SJason M. Bills     OnDemandCrashdump(CrowApp& app) :
2775424c4176SJason M. Bills         Node(app,
2776424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2777424c4176SJason M. Bills              "Crashdump.OnDemand/")
27781da66f75SEd Tanous     {
27793946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
27803946028dSAppaRao Puli         // method for security reasons.
27811da66f75SEd Tanous         entityPrivileges = {
27823946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
27833946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
27843946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
27853946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
27863946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
27873946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
27881da66f75SEd Tanous     }
27891da66f75SEd Tanous 
27901da66f75SEd Tanous   private:
27911da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
27921da66f75SEd Tanous                 const std::vector<std::string>& params) override
27931da66f75SEd Tanous     {
2794e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
27951da66f75SEd Tanous 
2796fe306728SJames Feist         auto generateonDemandLogCallback = [asyncResp,
2797fe306728SJames Feist                                             req](const boost::system::error_code
279846229577SJames Feist                                                      ec,
27991da66f75SEd Tanous                                                  const std::string& resp) {
28001da66f75SEd Tanous             if (ec)
28011da66f75SEd Tanous             {
280246229577SJames Feist                 if (ec.value() == boost::system::errc::operation_not_supported)
28031da66f75SEd Tanous                 {
2804f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
28051da66f75SEd Tanous                 }
28064363d3b2SJason M. Bills                 else if (ec.value() ==
28074363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
28084363d3b2SJason M. Bills                 {
28094363d3b2SJason M. Bills                     messages::serviceTemporarilyUnavailable(asyncResp->res,
28104363d3b2SJason M. Bills                                                             "60");
28114363d3b2SJason M. Bills                 }
28121da66f75SEd Tanous                 else
28131da66f75SEd Tanous                 {
2814f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
28151da66f75SEd Tanous                 }
28161da66f75SEd Tanous                 return;
28171da66f75SEd Tanous             }
281846229577SJames Feist             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
281966afe4faSJames Feist                 [](boost::system::error_code err, sdbusplus::message::message&,
282066afe4faSJames Feist                    const std::shared_ptr<task::TaskData>& taskData) {
282166afe4faSJames Feist                     if (!err)
282266afe4faSJames Feist                     {
2823e5d5006bSJames Feist                         taskData->messages.emplace_back(
2824e5d5006bSJames Feist                             messages::taskCompletedOK(
2825e5d5006bSJames Feist                                 std::to_string(taskData->index)));
2826831d6b09SJames Feist                         taskData->state = "Completed";
282766afe4faSJames Feist                     }
282832898ceaSJames Feist                     return task::completed;
282966afe4faSJames Feist                 },
283046229577SJames Feist                 "type='signal',interface='org.freedesktop.DBus.Properties',"
283146229577SJames Feist                 "member='PropertiesChanged',arg0namespace='com.intel."
283246229577SJames Feist                 "crashdump'");
283346229577SJames Feist             task->startTimer(std::chrono::minutes(5));
283446229577SJames Feist             task->populateResp(asyncResp->res);
2835fe306728SJames Feist             task->payload.emplace(req);
28361da66f75SEd Tanous         };
28371da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
28385b61b5e8SJason M. Bills             std::move(generateonDemandLogCallback), crashdumpObject,
28395b61b5e8SJason M. Bills             crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog");
28401da66f75SEd Tanous     }
28411da66f75SEd Tanous };
28421da66f75SEd Tanous 
28436eda7685SKenny L. Ku class TelemetryCrashdump : public Node
28446eda7685SKenny L. Ku {
28456eda7685SKenny L. Ku   public:
28466eda7685SKenny L. Ku     TelemetryCrashdump(CrowApp& app) :
28476eda7685SKenny L. Ku         Node(app,
28486eda7685SKenny L. Ku              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
28496eda7685SKenny L. Ku              "Crashdump.Telemetry/")
28506eda7685SKenny L. Ku     {
28516eda7685SKenny L. Ku         // Note: Deviated from redfish privilege registry for GET & HEAD
28526eda7685SKenny L. Ku         // method for security reasons.
28536eda7685SKenny L. Ku         entityPrivileges = {
28546eda7685SKenny L. Ku             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
28556eda7685SKenny L. Ku             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
28566eda7685SKenny L. Ku             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
28576eda7685SKenny L. Ku             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
28586eda7685SKenny L. Ku             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
28596eda7685SKenny L. Ku             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
28606eda7685SKenny L. Ku     }
28616eda7685SKenny L. Ku 
28626eda7685SKenny L. Ku   private:
28636eda7685SKenny L. Ku     void doPost(crow::Response& res, const crow::Request& req,
28646eda7685SKenny L. Ku                 const std::vector<std::string>& params) override
28656eda7685SKenny L. Ku     {
28666eda7685SKenny L. Ku         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
28676eda7685SKenny L. Ku 
28686eda7685SKenny L. Ku         auto generateTelemetryLogCallback = [asyncResp, req](
28696eda7685SKenny L. Ku                                                 const boost::system::error_code
28706eda7685SKenny L. Ku                                                     ec,
28716eda7685SKenny L. Ku                                                 const std::string& resp) {
28726eda7685SKenny L. Ku             if (ec)
28736eda7685SKenny L. Ku             {
28746eda7685SKenny L. Ku                 if (ec.value() == boost::system::errc::operation_not_supported)
28756eda7685SKenny L. Ku                 {
28766eda7685SKenny L. Ku                     messages::resourceInStandby(asyncResp->res);
28776eda7685SKenny L. Ku                 }
28786eda7685SKenny L. Ku                 else if (ec.value() ==
28796eda7685SKenny L. Ku                          boost::system::errc::device_or_resource_busy)
28806eda7685SKenny L. Ku                 {
28816eda7685SKenny L. Ku                     messages::serviceTemporarilyUnavailable(asyncResp->res,
28826eda7685SKenny L. Ku                                                             "60");
28836eda7685SKenny L. Ku                 }
28846eda7685SKenny L. Ku                 else
28856eda7685SKenny L. Ku                 {
28866eda7685SKenny L. Ku                     messages::internalError(asyncResp->res);
28876eda7685SKenny L. Ku                 }
28886eda7685SKenny L. Ku                 return;
28896eda7685SKenny L. Ku             }
28906eda7685SKenny L. Ku             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
28916eda7685SKenny L. Ku                 [](boost::system::error_code err, sdbusplus::message::message&,
28926eda7685SKenny L. Ku                    const std::shared_ptr<task::TaskData>& taskData) {
28936eda7685SKenny L. Ku                     if (!err)
28946eda7685SKenny L. Ku                     {
28956eda7685SKenny L. Ku                         taskData->messages.emplace_back(
28966eda7685SKenny L. Ku                             messages::taskCompletedOK(
28976eda7685SKenny L. Ku                                 std::to_string(taskData->index)));
28986eda7685SKenny L. Ku                         taskData->state = "Completed";
28996eda7685SKenny L. Ku                     }
29006eda7685SKenny L. Ku                     return task::completed;
29016eda7685SKenny L. Ku                 },
29026eda7685SKenny L. Ku                 "type='signal',interface='org.freedesktop.DBus.Properties',"
29036eda7685SKenny L. Ku                 "member='PropertiesChanged',arg0namespace='com.intel."
29046eda7685SKenny L. Ku                 "crashdump'");
29056eda7685SKenny L. Ku             task->startTimer(std::chrono::minutes(5));
29066eda7685SKenny L. Ku             task->populateResp(asyncResp->res);
29076eda7685SKenny L. Ku             task->payload.emplace(req);
29086eda7685SKenny L. Ku         };
29096eda7685SKenny L. Ku         crow::connections::systemBus->async_method_call(
29106eda7685SKenny L. Ku             std::move(generateTelemetryLogCallback), crashdumpObject,
29116eda7685SKenny L. Ku             crashdumpPath, crashdumpTelemetryInterface, "GenerateTelemetryLog");
29126eda7685SKenny L. Ku     }
29136eda7685SKenny L. Ku };
29146eda7685SKenny L. Ku 
2915e1f26343SJason M. Bills class SendRawPECI : public Node
29161da66f75SEd Tanous {
29171da66f75SEd Tanous   public:
2918e1f26343SJason M. Bills     SendRawPECI(CrowApp& app) :
2919424c4176SJason M. Bills         Node(app,
2920424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2921424c4176SJason M. Bills              "Crashdump.SendRawPeci/")
29221da66f75SEd Tanous     {
29233946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
29243946028dSAppaRao Puli         // method for security reasons.
29251da66f75SEd Tanous         entityPrivileges = {
29261da66f75SEd Tanous             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
29271da66f75SEd Tanous             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
29281da66f75SEd Tanous             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
29291da66f75SEd Tanous             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
29301da66f75SEd Tanous             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
29311da66f75SEd Tanous             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
29321da66f75SEd Tanous     }
29331da66f75SEd Tanous 
29341da66f75SEd Tanous   private:
29351da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
29361da66f75SEd Tanous                 const std::vector<std::string>& params) override
29371da66f75SEd Tanous     {
2938e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
29398724c297SKarthick Sundarrajan         std::vector<std::vector<uint8_t>> peciCommands;
29408724c297SKarthick Sundarrajan 
29418724c297SKarthick Sundarrajan         nlohmann::json reqJson =
29428724c297SKarthick Sundarrajan             nlohmann::json::parse(req.body, nullptr, false);
29438724c297SKarthick Sundarrajan         if (reqJson.find("PECICommands") != reqJson.end())
29448724c297SKarthick Sundarrajan         {
29458724c297SKarthick Sundarrajan             if (!json_util::readJson(req, res, "PECICommands", peciCommands))
29468724c297SKarthick Sundarrajan             {
29478724c297SKarthick Sundarrajan                 return;
29488724c297SKarthick Sundarrajan             }
29498724c297SKarthick Sundarrajan             uint32_t idx = 0;
29508724c297SKarthick Sundarrajan             for (auto const& cmd : peciCommands)
29518724c297SKarthick Sundarrajan             {
29528724c297SKarthick Sundarrajan                 if (cmd.size() < 3)
29538724c297SKarthick Sundarrajan                 {
29548724c297SKarthick Sundarrajan                     std::string s("[");
29558724c297SKarthick Sundarrajan                     for (auto const& val : cmd)
29568724c297SKarthick Sundarrajan                     {
29578724c297SKarthick Sundarrajan                         if (val != *cmd.begin())
29588724c297SKarthick Sundarrajan                         {
29598724c297SKarthick Sundarrajan                             s += ",";
29608724c297SKarthick Sundarrajan                         }
29618724c297SKarthick Sundarrajan                         s += std::to_string(val);
29628724c297SKarthick Sundarrajan                     }
29638724c297SKarthick Sundarrajan                     s += "]";
29648724c297SKarthick Sundarrajan                     messages::actionParameterValueFormatError(
29658724c297SKarthick Sundarrajan                         res, s, "PECICommands[" + std::to_string(idx) + "]",
29668724c297SKarthick Sundarrajan                         "SendRawPeci");
29678724c297SKarthick Sundarrajan                     return;
29688724c297SKarthick Sundarrajan                 }
29698724c297SKarthick Sundarrajan                 idx++;
29708724c297SKarthick Sundarrajan             }
29718724c297SKarthick Sundarrajan         }
29728724c297SKarthick Sundarrajan         else
29738724c297SKarthick Sundarrajan         {
29748724c297SKarthick Sundarrajan             /* This interface is deprecated */
2975b1556427SEd Tanous             uint8_t clientAddress = 0;
2976b1556427SEd Tanous             uint8_t readLength = 0;
29771da66f75SEd Tanous             std::vector<uint8_t> peciCommand;
2978b1556427SEd Tanous             if (!json_util::readJson(req, res, "ClientAddress", clientAddress,
2979b1556427SEd Tanous                                      "ReadLength", readLength, "PECICommand",
2980b1556427SEd Tanous                                      peciCommand))
29811da66f75SEd Tanous             {
29821da66f75SEd Tanous                 return;
29831da66f75SEd Tanous             }
29848724c297SKarthick Sundarrajan             peciCommands.push_back({clientAddress, 0, readLength});
29858724c297SKarthick Sundarrajan             peciCommands[0].insert(peciCommands[0].end(), peciCommand.begin(),
29868724c297SKarthick Sundarrajan                                    peciCommand.end());
29878724c297SKarthick Sundarrajan         }
29881da66f75SEd Tanous         // Callback to return the Raw PECI response
2989e1f26343SJason M. Bills         auto sendRawPECICallback =
2990e1f26343SJason M. Bills             [asyncResp](const boost::system::error_code ec,
29918724c297SKarthick Sundarrajan                         const std::vector<std::vector<uint8_t>>& resp) {
29921da66f75SEd Tanous                 if (ec)
29931da66f75SEd Tanous                 {
29948724c297SKarthick Sundarrajan                     BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: "
29951da66f75SEd Tanous                                      << ec.message();
2996f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
29971da66f75SEd Tanous                     return;
29981da66f75SEd Tanous                 }
2999e1f26343SJason M. Bills                 asyncResp->res.jsonValue = {{"Name", "PECI Command Response"},
30001da66f75SEd Tanous                                             {"PECIResponse", resp}};
30011da66f75SEd Tanous             };
30021da66f75SEd Tanous         // Call the SendRawPECI command with the provided data
30031da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
30045b61b5e8SJason M. Bills             std::move(sendRawPECICallback), crashdumpObject, crashdumpPath,
30058724c297SKarthick Sundarrajan             crashdumpRawPECIInterface, "SendRawPeci", peciCommands);
30061da66f75SEd Tanous     }
30071da66f75SEd Tanous };
30081da66f75SEd Tanous 
3009cb92c03bSAndrew Geissler /**
3010cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3011cb92c03bSAndrew Geissler  */
3012cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node
3013cb92c03bSAndrew Geissler {
3014cb92c03bSAndrew Geissler   public:
3015cb92c03bSAndrew Geissler     DBusLogServiceActionsClear(CrowApp& app) :
3016cb92c03bSAndrew Geissler         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
30177af91514SGunnar Mills                   "LogService.ClearLog/")
3018cb92c03bSAndrew Geissler     {
3019cb92c03bSAndrew Geissler         entityPrivileges = {
3020cb92c03bSAndrew Geissler             {boost::beast::http::verb::get, {{"Login"}}},
3021cb92c03bSAndrew Geissler             {boost::beast::http::verb::head, {{"Login"}}},
3022cb92c03bSAndrew Geissler             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3023cb92c03bSAndrew Geissler             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3024cb92c03bSAndrew Geissler             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3025cb92c03bSAndrew Geissler             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3026cb92c03bSAndrew Geissler     }
3027cb92c03bSAndrew Geissler 
3028cb92c03bSAndrew Geissler   private:
3029cb92c03bSAndrew Geissler     /**
3030cb92c03bSAndrew Geissler      * Function handles POST method request.
3031cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
3032cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
3033cb92c03bSAndrew Geissler      */
3034cb92c03bSAndrew Geissler     void doPost(crow::Response& res, const crow::Request& req,
3035cb92c03bSAndrew Geissler                 const std::vector<std::string>& params) override
3036cb92c03bSAndrew Geissler     {
3037cb92c03bSAndrew Geissler         BMCWEB_LOG_DEBUG << "Do delete all entries.";
3038cb92c03bSAndrew Geissler 
3039cb92c03bSAndrew Geissler         auto asyncResp = std::make_shared<AsyncResp>(res);
3040cb92c03bSAndrew Geissler         // Process response from Logging service.
3041cb92c03bSAndrew Geissler         auto resp_handler = [asyncResp](const boost::system::error_code ec) {
3042cb92c03bSAndrew Geissler             BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
3043cb92c03bSAndrew Geissler             if (ec)
3044cb92c03bSAndrew Geissler             {
3045cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
3046cb92c03bSAndrew Geissler                 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
3047cb92c03bSAndrew Geissler                 asyncResp->res.result(
3048cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
3049cb92c03bSAndrew Geissler                 return;
3050cb92c03bSAndrew Geissler             }
3051cb92c03bSAndrew Geissler 
3052cb92c03bSAndrew Geissler             asyncResp->res.result(boost::beast::http::status::no_content);
3053cb92c03bSAndrew Geissler         };
3054cb92c03bSAndrew Geissler 
3055cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
3056cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
3057cb92c03bSAndrew Geissler             resp_handler, "xyz.openbmc_project.Logging",
3058cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
3059cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3060cb92c03bSAndrew Geissler     }
3061cb92c03bSAndrew Geissler };
3062a3316fc6SZhikuiRen 
3063a3316fc6SZhikuiRen /****************************************************
3064a3316fc6SZhikuiRen  * Redfish PostCode interfaces
3065a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
3066a3316fc6SZhikuiRen  ******************************************************/
3067a3316fc6SZhikuiRen class PostCodesLogService : public Node
3068a3316fc6SZhikuiRen {
3069a3316fc6SZhikuiRen   public:
3070a3316fc6SZhikuiRen     PostCodesLogService(CrowApp& app) :
3071a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
3072a3316fc6SZhikuiRen     {
3073a3316fc6SZhikuiRen         entityPrivileges = {
3074a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3075a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3076a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3077a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3078a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3079a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3080a3316fc6SZhikuiRen     }
3081a3316fc6SZhikuiRen 
3082a3316fc6SZhikuiRen   private:
3083a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
3084a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3085a3316fc6SZhikuiRen     {
3086a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3087a3316fc6SZhikuiRen 
3088a3316fc6SZhikuiRen         asyncResp->res.jsonValue = {
3089a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"},
3090a3316fc6SZhikuiRen             {"@odata.type", "#LogService.v1_1_0.LogService"},
3091a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogService.LogService"},
3092a3316fc6SZhikuiRen             {"Name", "POST Code Log Service"},
3093a3316fc6SZhikuiRen             {"Description", "POST Code Log Service"},
3094a3316fc6SZhikuiRen             {"Id", "BIOS POST Code Log"},
3095a3316fc6SZhikuiRen             {"OverWritePolicy", "WrapsWhenFull"},
3096a3316fc6SZhikuiRen             {"Entries",
3097a3316fc6SZhikuiRen              {{"@odata.id",
3098a3316fc6SZhikuiRen                "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
3099a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
3100a3316fc6SZhikuiRen             {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/"
3101a3316fc6SZhikuiRen                        "Actions/LogService.ClearLog"}};
3102a3316fc6SZhikuiRen     }
3103a3316fc6SZhikuiRen };
3104a3316fc6SZhikuiRen 
3105a3316fc6SZhikuiRen class PostCodesClear : public Node
3106a3316fc6SZhikuiRen {
3107a3316fc6SZhikuiRen   public:
3108a3316fc6SZhikuiRen     PostCodesClear(CrowApp& app) :
3109a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
3110a3316fc6SZhikuiRen                   "LogService.ClearLog/")
3111a3316fc6SZhikuiRen     {
3112a3316fc6SZhikuiRen         entityPrivileges = {
3113a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3114a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
31153946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
31163946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
31173946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
31183946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
3119a3316fc6SZhikuiRen     }
3120a3316fc6SZhikuiRen 
3121a3316fc6SZhikuiRen   private:
3122a3316fc6SZhikuiRen     void doPost(crow::Response& res, const crow::Request& req,
3123a3316fc6SZhikuiRen                 const std::vector<std::string>& params) override
3124a3316fc6SZhikuiRen     {
3125a3316fc6SZhikuiRen         BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
3126a3316fc6SZhikuiRen 
3127a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3128a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
3129a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
3130a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec) {
3131a3316fc6SZhikuiRen                 if (ec)
3132a3316fc6SZhikuiRen                 {
3133a3316fc6SZhikuiRen                     // TODO Handle for specific error code
3134a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR
3135a3316fc6SZhikuiRen                         << "doClearPostCodes resp_handler got error " << ec;
3136a3316fc6SZhikuiRen                     asyncResp->res.result(
3137a3316fc6SZhikuiRen                         boost::beast::http::status::internal_server_error);
3138a3316fc6SZhikuiRen                     messages::internalError(asyncResp->res);
3139a3316fc6SZhikuiRen                     return;
3140a3316fc6SZhikuiRen                 }
3141a3316fc6SZhikuiRen             },
3142a3316fc6SZhikuiRen             "xyz.openbmc_project.State.Boot.PostCode",
3143a3316fc6SZhikuiRen             "/xyz/openbmc_project/State/Boot/PostCode",
3144a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3145a3316fc6SZhikuiRen     }
3146a3316fc6SZhikuiRen };
3147a3316fc6SZhikuiRen 
3148a3316fc6SZhikuiRen static void fillPostCodeEntry(
3149a3316fc6SZhikuiRen     std::shared_ptr<AsyncResp> aResp,
3150a3316fc6SZhikuiRen     const boost::container::flat_map<uint64_t, uint64_t>& postcode,
3151a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
3152a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
3153a3316fc6SZhikuiRen {
3154a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
3155a3316fc6SZhikuiRen     const message_registries::Message* message =
3156a3316fc6SZhikuiRen         message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode");
3157a3316fc6SZhikuiRen 
3158a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
3159a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
3160a3316fc6SZhikuiRen 
3161a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
3162a3316fc6SZhikuiRen     for (const std::pair<uint64_t, uint64_t>& code : postcode)
3163a3316fc6SZhikuiRen     {
3164a3316fc6SZhikuiRen         currentCodeIndex++;
3165a3316fc6SZhikuiRen         std::string postcodeEntryID =
3166a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
3167a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
3168a3316fc6SZhikuiRen 
3169a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
3170a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
3171a3316fc6SZhikuiRen 
3172a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
3173a3316fc6SZhikuiRen         { // already incremented
3174a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
3175a3316fc6SZhikuiRen         }
3176a3316fc6SZhikuiRen         else
3177a3316fc6SZhikuiRen         {
3178a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
3179a3316fc6SZhikuiRen         }
3180a3316fc6SZhikuiRen 
3181a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
3182a3316fc6SZhikuiRen         // not fall between top and skip
3183a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
3184a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
3185a3316fc6SZhikuiRen         {
3186a3316fc6SZhikuiRen             continue;
3187a3316fc6SZhikuiRen         }
3188a3316fc6SZhikuiRen 
31894e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
3190a3316fc6SZhikuiRen         // currentIndex
3191a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3192a3316fc6SZhikuiRen         {
3193a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
3194a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
3195a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
3196a3316fc6SZhikuiRen             continue;
3197a3316fc6SZhikuiRen         }
3198a3316fc6SZhikuiRen 
3199a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
3200a3316fc6SZhikuiRen         // index
3201a3316fc6SZhikuiRen 
3202a3316fc6SZhikuiRen         // Get the Created time from the timestamp
3203a3316fc6SZhikuiRen         std::string entryTimeStr;
3204a3316fc6SZhikuiRen         if (!getTimestampStr(usecSinceEpoch, entryTimeStr))
3205a3316fc6SZhikuiRen         {
3206a3316fc6SZhikuiRen             continue;
3207a3316fc6SZhikuiRen         }
3208a3316fc6SZhikuiRen 
3209a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3210a3316fc6SZhikuiRen         std::ostringstream hexCode;
3211a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
3212a3316fc6SZhikuiRen                 << code.second;
3213a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
3214a3316fc6SZhikuiRen         // Set Fixed -Point Notation
3215a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
3216a3316fc6SZhikuiRen         // Set precision to 4 digits
3217a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
3218a3316fc6SZhikuiRen         // Add double to stream
3219a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
3220a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
3221a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
3222a3316fc6SZhikuiRen 
3223a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
3224a3316fc6SZhikuiRen         std::string msg;
3225a3316fc6SZhikuiRen         if (message != nullptr)
3226a3316fc6SZhikuiRen         {
3227a3316fc6SZhikuiRen             msg = message->message;
3228a3316fc6SZhikuiRen 
3229a3316fc6SZhikuiRen             // fill in this post code value
3230a3316fc6SZhikuiRen             int i = 0;
3231a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
3232a3316fc6SZhikuiRen             {
3233a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
3234a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
3235a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
3236a3316fc6SZhikuiRen                 {
3237a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
3238a3316fc6SZhikuiRen                 }
3239a3316fc6SZhikuiRen             }
3240a3316fc6SZhikuiRen         }
3241a3316fc6SZhikuiRen 
3242d4342a92STim Lee         // Get Severity template from message registry
3243d4342a92STim Lee         std::string severity;
3244d4342a92STim Lee         if (message != nullptr)
3245d4342a92STim Lee         {
3246d4342a92STim Lee             severity = message->severity;
3247d4342a92STim Lee         }
3248d4342a92STim Lee 
3249a3316fc6SZhikuiRen         // add to AsyncResp
3250a3316fc6SZhikuiRen         logEntryArray.push_back({});
3251a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
3252a3316fc6SZhikuiRen         bmcLogEntry = {
3253a3316fc6SZhikuiRen             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
3254a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"},
3255a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
3256a3316fc6SZhikuiRen                           "PostCodes/Entries/" +
3257a3316fc6SZhikuiRen                               postcodeEntryID},
3258a3316fc6SZhikuiRen             {"Name", "POST Code Log Entry"},
3259a3316fc6SZhikuiRen             {"Id", postcodeEntryID},
3260a3316fc6SZhikuiRen             {"Message", std::move(msg)},
3261a3316fc6SZhikuiRen             {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"},
3262a3316fc6SZhikuiRen             {"MessageArgs", std::move(messageArgs)},
3263a3316fc6SZhikuiRen             {"EntryType", "Event"},
3264a3316fc6SZhikuiRen             {"Severity", std::move(severity)},
3265a3316fc6SZhikuiRen             {"Created", std::move(entryTimeStr)}};
3266a3316fc6SZhikuiRen     }
3267a3316fc6SZhikuiRen }
3268a3316fc6SZhikuiRen 
3269a3316fc6SZhikuiRen static void getPostCodeForEntry(std::shared_ptr<AsyncResp> aResp,
3270a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
3271a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
3272a3316fc6SZhikuiRen {
3273a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3274a3316fc6SZhikuiRen         [aResp, bootIndex, codeIndex](
3275a3316fc6SZhikuiRen             const boost::system::error_code ec,
3276a3316fc6SZhikuiRen             const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
3277a3316fc6SZhikuiRen             if (ec)
3278a3316fc6SZhikuiRen             {
3279a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3280a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3281a3316fc6SZhikuiRen                 return;
3282a3316fc6SZhikuiRen             }
3283a3316fc6SZhikuiRen 
3284a3316fc6SZhikuiRen             // skip the empty postcode boots
3285a3316fc6SZhikuiRen             if (postcode.empty())
3286a3316fc6SZhikuiRen             {
3287a3316fc6SZhikuiRen                 return;
3288a3316fc6SZhikuiRen             }
3289a3316fc6SZhikuiRen 
3290a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
3291a3316fc6SZhikuiRen 
3292a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
3293a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
3294a3316fc6SZhikuiRen         },
3295a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3296a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3297a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3298a3316fc6SZhikuiRen         bootIndex);
3299a3316fc6SZhikuiRen }
3300a3316fc6SZhikuiRen 
3301a3316fc6SZhikuiRen static void getPostCodeForBoot(std::shared_ptr<AsyncResp> aResp,
3302a3316fc6SZhikuiRen                                const uint16_t bootIndex,
3303a3316fc6SZhikuiRen                                const uint16_t bootCount,
3304a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
3305a3316fc6SZhikuiRen                                const uint64_t top)
3306a3316fc6SZhikuiRen {
3307a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3308a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
3309a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3310a3316fc6SZhikuiRen               const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
3311a3316fc6SZhikuiRen             if (ec)
3312a3316fc6SZhikuiRen             {
3313a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3314a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3315a3316fc6SZhikuiRen                 return;
3316a3316fc6SZhikuiRen             }
3317a3316fc6SZhikuiRen 
3318a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
3319a3316fc6SZhikuiRen             if (!postcode.empty())
3320a3316fc6SZhikuiRen             {
3321a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
3322a3316fc6SZhikuiRen 
3323a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
3324a3316fc6SZhikuiRen                 {
3325a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
3326a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
3327a3316fc6SZhikuiRen                     uint64_t thisBootTop =
3328a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
3329a3316fc6SZhikuiRen 
3330a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3331a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
3332a3316fc6SZhikuiRen                 }
3333a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
3334a3316fc6SZhikuiRen             }
3335a3316fc6SZhikuiRen 
3336a3316fc6SZhikuiRen             // continue to previous bootIndex
3337a3316fc6SZhikuiRen             if (bootIndex < bootCount)
3338a3316fc6SZhikuiRen             {
3339a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3340a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
3341a3316fc6SZhikuiRen             }
3342a3316fc6SZhikuiRen             else
3343a3316fc6SZhikuiRen             {
3344a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
3345a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3346a3316fc6SZhikuiRen                     "Entries?$skip=" +
3347a3316fc6SZhikuiRen                     std::to_string(skip + top);
3348a3316fc6SZhikuiRen             }
3349a3316fc6SZhikuiRen         },
3350a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3351a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3352a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3353a3316fc6SZhikuiRen         bootIndex);
3354a3316fc6SZhikuiRen }
3355a3316fc6SZhikuiRen 
3356a3316fc6SZhikuiRen static void getCurrentBootNumber(std::shared_ptr<AsyncResp> aResp,
3357a3316fc6SZhikuiRen                                  const uint64_t skip, const uint64_t top)
3358a3316fc6SZhikuiRen {
3359a3316fc6SZhikuiRen     uint64_t entryCount = 0;
3360a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3361a3316fc6SZhikuiRen         [aResp, entryCount, skip,
3362a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3363a3316fc6SZhikuiRen               const std::variant<uint16_t>& bootCount) {
3364a3316fc6SZhikuiRen             if (ec)
3365a3316fc6SZhikuiRen             {
3366a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3367a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3368a3316fc6SZhikuiRen                 return;
3369a3316fc6SZhikuiRen             }
3370a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
3371a3316fc6SZhikuiRen             if (pVal)
3372a3316fc6SZhikuiRen             {
3373a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
3374a3316fc6SZhikuiRen             }
3375a3316fc6SZhikuiRen             else
3376a3316fc6SZhikuiRen             {
3377a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
3378a3316fc6SZhikuiRen             }
3379a3316fc6SZhikuiRen         },
3380a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3381a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3382a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
3383a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
3384a3316fc6SZhikuiRen }
3385a3316fc6SZhikuiRen 
3386a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node
3387a3316fc6SZhikuiRen {
3388a3316fc6SZhikuiRen   public:
3389a3316fc6SZhikuiRen     template <typename CrowApp>
3390a3316fc6SZhikuiRen     PostCodesEntryCollection(CrowApp& app) :
3391a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3392a3316fc6SZhikuiRen     {
3393a3316fc6SZhikuiRen         entityPrivileges = {
3394a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3395a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3396a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3397a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3398a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3399a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3400a3316fc6SZhikuiRen     }
3401a3316fc6SZhikuiRen 
3402a3316fc6SZhikuiRen   private:
3403a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
3404a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3405a3316fc6SZhikuiRen     {
3406a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3407a3316fc6SZhikuiRen 
3408a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
3409a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
3410a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
3411a3316fc6SZhikuiRen             "/redfish/v1/"
3412a3316fc6SZhikuiRen             "$metadata#LogEntryCollection.LogEntryCollection";
3413a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3414a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3415a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3416a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3417a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3418a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3419a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3420a3316fc6SZhikuiRen 
3421a3316fc6SZhikuiRen         uint64_t skip = 0;
3422a3316fc6SZhikuiRen         uint64_t top = maxEntriesPerPage; // Show max entries by default
3423a3316fc6SZhikuiRen         if (!getSkipParam(asyncResp->res, req, skip))
3424a3316fc6SZhikuiRen         {
3425a3316fc6SZhikuiRen             return;
3426a3316fc6SZhikuiRen         }
3427a3316fc6SZhikuiRen         if (!getTopParam(asyncResp->res, req, top))
3428a3316fc6SZhikuiRen         {
3429a3316fc6SZhikuiRen             return;
3430a3316fc6SZhikuiRen         }
3431a3316fc6SZhikuiRen         getCurrentBootNumber(asyncResp, skip, top);
3432a3316fc6SZhikuiRen     }
3433a3316fc6SZhikuiRen };
3434a3316fc6SZhikuiRen 
3435a3316fc6SZhikuiRen class PostCodesEntry : public Node
3436a3316fc6SZhikuiRen {
3437a3316fc6SZhikuiRen   public:
3438a3316fc6SZhikuiRen     PostCodesEntry(CrowApp& app) :
3439a3316fc6SZhikuiRen         Node(app,
3440a3316fc6SZhikuiRen              "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/",
3441a3316fc6SZhikuiRen              std::string())
3442a3316fc6SZhikuiRen     {
3443a3316fc6SZhikuiRen         entityPrivileges = {
3444a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3445a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3446a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3447a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3448a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3449a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3450a3316fc6SZhikuiRen     }
3451a3316fc6SZhikuiRen 
3452a3316fc6SZhikuiRen   private:
3453a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
3454a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3455a3316fc6SZhikuiRen     {
3456a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3457a3316fc6SZhikuiRen         if (params.size() != 1)
3458a3316fc6SZhikuiRen         {
3459a3316fc6SZhikuiRen             messages::internalError(asyncResp->res);
3460a3316fc6SZhikuiRen             return;
3461a3316fc6SZhikuiRen         }
3462a3316fc6SZhikuiRen 
3463a3316fc6SZhikuiRen         const std::string& targetID = params[0];
3464a3316fc6SZhikuiRen 
3465a3316fc6SZhikuiRen         size_t bootPos = targetID.find('B');
3466a3316fc6SZhikuiRen         if (bootPos == std::string::npos)
3467a3316fc6SZhikuiRen         {
3468a3316fc6SZhikuiRen             // Requested ID was not found
3469a3316fc6SZhikuiRen             messages::resourceMissingAtURI(asyncResp->res, targetID);
3470a3316fc6SZhikuiRen             return;
3471a3316fc6SZhikuiRen         }
3472a3316fc6SZhikuiRen         std::string_view bootIndexStr(targetID);
3473a3316fc6SZhikuiRen         bootIndexStr.remove_prefix(bootPos + 1);
3474a3316fc6SZhikuiRen         uint16_t bootIndex = 0;
3475a3316fc6SZhikuiRen         uint64_t codeIndex = 0;
3476a3316fc6SZhikuiRen         size_t dashPos = bootIndexStr.find('-');
3477a3316fc6SZhikuiRen 
3478a3316fc6SZhikuiRen         if (dashPos == std::string::npos)
3479a3316fc6SZhikuiRen         {
3480a3316fc6SZhikuiRen             return;
3481a3316fc6SZhikuiRen         }
3482a3316fc6SZhikuiRen         std::string_view codeIndexStr(bootIndexStr);
3483a3316fc6SZhikuiRen         bootIndexStr.remove_suffix(dashPos);
3484a3316fc6SZhikuiRen         codeIndexStr.remove_prefix(dashPos + 1);
3485a3316fc6SZhikuiRen 
3486a3316fc6SZhikuiRen         bootIndex = static_cast<uint16_t>(
3487a3316fc6SZhikuiRen             strtoul(std::string(bootIndexStr).c_str(), NULL, 0));
3488a3316fc6SZhikuiRen         codeIndex = strtoul(std::string(codeIndexStr).c_str(), NULL, 0);
3489a3316fc6SZhikuiRen         if (bootIndex == 0 || codeIndex == 0)
3490a3316fc6SZhikuiRen         {
3491a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
3492a3316fc6SZhikuiRen                              << params[0];
3493a3316fc6SZhikuiRen         }
3494a3316fc6SZhikuiRen 
3495a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
3496a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
3497a3316fc6SZhikuiRen             "/redfish/v1/$metadata#LogEntry.LogEntry";
3498a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3499a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/"
3500a3316fc6SZhikuiRen             "Entries";
3501a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3502a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3503a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3504a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3505a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3506a3316fc6SZhikuiRen 
3507a3316fc6SZhikuiRen         getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
3508a3316fc6SZhikuiRen     }
3509a3316fc6SZhikuiRen };
3510a3316fc6SZhikuiRen 
35111da66f75SEd Tanous } // namespace redfish
3512