xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision f71882ffecef5e64d1f5ad7ef59e811383de7156)
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 getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp)
183a3316fc6SZhikuiRen {
184a3316fc6SZhikuiRen     int ret = 0;
185a3316fc6SZhikuiRen     uint64_t timestamp = 0;
186a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
187a3316fc6SZhikuiRen     if (ret < 0)
188a3316fc6SZhikuiRen     {
189a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
190a3316fc6SZhikuiRen                          << strerror(-ret);
191a3316fc6SZhikuiRen         return false;
192a3316fc6SZhikuiRen     }
1939c620e21SAsmitha Karunanithi     entryTimestamp = crow::utility::getDateTime(
1949c620e21SAsmitha Karunanithi         static_cast<std::time_t>(timestamp / 1000 / 1000));
1959c620e21SAsmitha Karunanithi     return true;
196a3316fc6SZhikuiRen }
197a3316fc6SZhikuiRen 
19816428a1aSJason M. Bills static bool getSkipParam(crow::Response& res, const crow::Request& req,
199271584abSEd Tanous                          uint64_t& skip)
20016428a1aSJason M. Bills {
2015a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
2025a7e877eSJames Feist         req.urlParams.find("$skip");
2035a7e877eSJames Feist     if (it != req.urlParams.end())
20416428a1aSJason M. Bills     {
2055a7e877eSJames Feist         std::string skipParam = it->value();
20616428a1aSJason M. Bills         char* ptr = nullptr;
2075a7e877eSJames Feist         skip = std::strtoul(skipParam.c_str(), &ptr, 10);
2085a7e877eSJames Feist         if (skipParam.empty() || *ptr != '\0')
20916428a1aSJason M. Bills         {
21016428a1aSJason M. Bills 
21116428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(skipParam),
21216428a1aSJason M. Bills                                                    "$skip");
21316428a1aSJason M. Bills             return false;
21416428a1aSJason M. Bills         }
21516428a1aSJason M. Bills     }
21616428a1aSJason M. Bills     return true;
21716428a1aSJason M. Bills }
21816428a1aSJason M. Bills 
219271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
22016428a1aSJason M. Bills static bool getTopParam(crow::Response& res, const crow::Request& req,
221271584abSEd Tanous                         uint64_t& top)
22216428a1aSJason M. Bills {
2235a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
2245a7e877eSJames Feist         req.urlParams.find("$top");
2255a7e877eSJames Feist     if (it != req.urlParams.end())
22616428a1aSJason M. Bills     {
2275a7e877eSJames Feist         std::string topParam = it->value();
22816428a1aSJason M. Bills         char* ptr = nullptr;
2295a7e877eSJames Feist         top = std::strtoul(topParam.c_str(), &ptr, 10);
2305a7e877eSJames Feist         if (topParam.empty() || *ptr != '\0')
23116428a1aSJason M. Bills         {
23216428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(topParam),
23316428a1aSJason M. Bills                                                    "$top");
23416428a1aSJason M. Bills             return false;
23516428a1aSJason M. Bills         }
236271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
23716428a1aSJason M. Bills         {
23816428a1aSJason M. Bills 
23916428a1aSJason M. Bills             messages::queryParameterOutOfRange(
24016428a1aSJason M. Bills                 res, std::to_string(top), "$top",
24116428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
24216428a1aSJason M. Bills             return false;
24316428a1aSJason M. Bills         }
24416428a1aSJason M. Bills     }
24516428a1aSJason M. Bills     return true;
24616428a1aSJason M. Bills }
24716428a1aSJason M. Bills 
248e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
249e85d6b16SJason M. Bills                              const bool firstEntry = true)
25016428a1aSJason M. Bills {
25116428a1aSJason M. Bills     int ret = 0;
25216428a1aSJason M. Bills     static uint64_t prevTs = 0;
25316428a1aSJason M. Bills     static int index = 0;
254e85d6b16SJason M. Bills     if (firstEntry)
255e85d6b16SJason M. Bills     {
256e85d6b16SJason M. Bills         prevTs = 0;
257e85d6b16SJason M. Bills     }
258e85d6b16SJason M. Bills 
25916428a1aSJason M. Bills     // Get the entry timestamp
26016428a1aSJason M. Bills     uint64_t curTs = 0;
26116428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
26216428a1aSJason M. Bills     if (ret < 0)
26316428a1aSJason M. Bills     {
26416428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
26516428a1aSJason M. Bills                          << strerror(-ret);
26616428a1aSJason M. Bills         return false;
26716428a1aSJason M. Bills     }
26816428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
26916428a1aSJason M. Bills     if (curTs == prevTs)
27016428a1aSJason M. Bills     {
27116428a1aSJason M. Bills         index++;
27216428a1aSJason M. Bills     }
27316428a1aSJason M. Bills     else
27416428a1aSJason M. Bills     {
27516428a1aSJason M. Bills         // Otherwise, reset it
27616428a1aSJason M. Bills         index = 0;
27716428a1aSJason M. Bills     }
27816428a1aSJason M. Bills     // Save the timestamp
27916428a1aSJason M. Bills     prevTs = curTs;
28016428a1aSJason M. Bills 
28116428a1aSJason M. Bills     entryID = std::to_string(curTs);
28216428a1aSJason M. Bills     if (index > 0)
28316428a1aSJason M. Bills     {
28416428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
28516428a1aSJason M. Bills     }
28616428a1aSJason M. Bills     return true;
28716428a1aSJason M. Bills }
28816428a1aSJason M. Bills 
289e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
290e85d6b16SJason M. Bills                              const bool firstEntry = true)
29195820184SJason M. Bills {
292271584abSEd Tanous     static time_t prevTs = 0;
29395820184SJason M. Bills     static int index = 0;
294e85d6b16SJason M. Bills     if (firstEntry)
295e85d6b16SJason M. Bills     {
296e85d6b16SJason M. Bills         prevTs = 0;
297e85d6b16SJason M. Bills     }
298e85d6b16SJason M. Bills 
29995820184SJason M. Bills     // Get the entry timestamp
300271584abSEd Tanous     std::time_t curTs = 0;
30195820184SJason M. Bills     std::tm timeStruct = {};
30295820184SJason M. Bills     std::istringstream entryStream(logEntry);
30395820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
30495820184SJason M. Bills     {
30595820184SJason M. Bills         curTs = std::mktime(&timeStruct);
30695820184SJason M. Bills     }
30795820184SJason M. Bills     // If the timestamp isn't unique, increment the index
30895820184SJason M. Bills     if (curTs == prevTs)
30995820184SJason M. Bills     {
31095820184SJason M. Bills         index++;
31195820184SJason M. Bills     }
31295820184SJason M. Bills     else
31395820184SJason M. Bills     {
31495820184SJason M. Bills         // Otherwise, reset it
31595820184SJason M. Bills         index = 0;
31695820184SJason M. Bills     }
31795820184SJason M. Bills     // Save the timestamp
31895820184SJason M. Bills     prevTs = curTs;
31995820184SJason M. Bills 
32095820184SJason M. Bills     entryID = std::to_string(curTs);
32195820184SJason M. Bills     if (index > 0)
32295820184SJason M. Bills     {
32395820184SJason M. Bills         entryID += "_" + std::to_string(index);
32495820184SJason M. Bills     }
32595820184SJason M. Bills     return true;
32695820184SJason M. Bills }
32795820184SJason M. Bills 
32816428a1aSJason M. Bills static bool getTimestampFromID(crow::Response& res, const std::string& entryID,
329271584abSEd Tanous                                uint64_t& timestamp, uint64_t& index)
33016428a1aSJason M. Bills {
33116428a1aSJason M. Bills     if (entryID.empty())
33216428a1aSJason M. Bills     {
33316428a1aSJason M. Bills         return false;
33416428a1aSJason M. Bills     }
33516428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
33639e77504SEd Tanous     std::string_view tsStr(entryID);
33716428a1aSJason M. Bills 
33816428a1aSJason M. Bills     auto underscorePos = tsStr.find("_");
33916428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
34016428a1aSJason M. Bills     {
34116428a1aSJason M. Bills         // Timestamp has an index
34216428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
34339e77504SEd Tanous         std::string_view indexStr(entryID);
34416428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
34516428a1aSJason M. Bills         std::size_t pos;
34616428a1aSJason M. Bills         try
34716428a1aSJason M. Bills         {
34839e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
34916428a1aSJason M. Bills         }
350271584abSEd Tanous         catch (std::invalid_argument&)
35116428a1aSJason M. Bills         {
35216428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
35316428a1aSJason M. Bills             return false;
35416428a1aSJason M. Bills         }
355271584abSEd Tanous         catch (std::out_of_range&)
35616428a1aSJason M. Bills         {
35716428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
35816428a1aSJason M. Bills             return false;
35916428a1aSJason M. Bills         }
36016428a1aSJason M. Bills         if (pos != indexStr.size())
36116428a1aSJason M. Bills         {
36216428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
36316428a1aSJason M. Bills             return false;
36416428a1aSJason M. Bills         }
36516428a1aSJason M. Bills     }
36616428a1aSJason M. Bills     // Timestamp has no index
36716428a1aSJason M. Bills     std::size_t pos;
36816428a1aSJason M. Bills     try
36916428a1aSJason M. Bills     {
37039e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
37116428a1aSJason M. Bills     }
372271584abSEd Tanous     catch (std::invalid_argument&)
37316428a1aSJason M. Bills     {
37416428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
37516428a1aSJason M. Bills         return false;
37616428a1aSJason M. Bills     }
377271584abSEd Tanous     catch (std::out_of_range&)
37816428a1aSJason M. Bills     {
37916428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
38016428a1aSJason M. Bills         return false;
38116428a1aSJason M. Bills     }
38216428a1aSJason M. Bills     if (pos != tsStr.size())
38316428a1aSJason M. Bills     {
38416428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
38516428a1aSJason M. Bills         return false;
38616428a1aSJason M. Bills     }
38716428a1aSJason M. Bills     return true;
38816428a1aSJason M. Bills }
38916428a1aSJason M. Bills 
39095820184SJason M. Bills static bool
39195820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
39295820184SJason M. Bills {
39395820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
39495820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
39595820184SJason M. Bills 
39695820184SJason M. Bills     // Loop through the directory looking for redfish log files
39795820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
39895820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
39995820184SJason M. Bills     {
40095820184SJason M. Bills         // If we find a redfish log file, save the path
40195820184SJason M. Bills         std::string filename = dirEnt.path().filename();
40295820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
40395820184SJason M. Bills         {
40495820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
40595820184SJason M. Bills         }
40695820184SJason M. Bills     }
40795820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
40895820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
40995820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
41095820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
41195820184SJason M. Bills 
41295820184SJason M. Bills     return !redfishLogFiles.empty();
41395820184SJason M. Bills }
41495820184SJason M. Bills 
4155cb1dd27SAsmitha Karunanithi inline void getDumpEntryCollection(std::shared_ptr<AsyncResp>& asyncResp,
4165cb1dd27SAsmitha Karunanithi                                    const std::string& dumpType)
4175cb1dd27SAsmitha Karunanithi {
4185cb1dd27SAsmitha Karunanithi     std::string dumpPath;
4195cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
4205cb1dd27SAsmitha Karunanithi     {
4215cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
4225cb1dd27SAsmitha Karunanithi     }
4235cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
4245cb1dd27SAsmitha Karunanithi     {
4255cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
4265cb1dd27SAsmitha Karunanithi     }
4275cb1dd27SAsmitha Karunanithi     else
4285cb1dd27SAsmitha Karunanithi     {
4295cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
4305cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
4315cb1dd27SAsmitha Karunanithi         return;
4325cb1dd27SAsmitha Karunanithi     }
4335cb1dd27SAsmitha Karunanithi 
4345cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
4355cb1dd27SAsmitha Karunanithi         [asyncResp, dumpPath, dumpType](const boost::system::error_code ec,
4365cb1dd27SAsmitha Karunanithi                                         GetManagedObjectsType& resp) {
4375cb1dd27SAsmitha Karunanithi             if (ec)
4385cb1dd27SAsmitha Karunanithi             {
4395cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4405cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
4415cb1dd27SAsmitha Karunanithi                 return;
4425cb1dd27SAsmitha Karunanithi             }
4435cb1dd27SAsmitha Karunanithi 
4445cb1dd27SAsmitha Karunanithi             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4455cb1dd27SAsmitha Karunanithi             entriesArray = nlohmann::json::array();
4465cb1dd27SAsmitha Karunanithi 
4475cb1dd27SAsmitha Karunanithi             for (auto& object : resp)
4485cb1dd27SAsmitha Karunanithi             {
4495cb1dd27SAsmitha Karunanithi                 bool foundDumpEntry = false;
4505cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4515cb1dd27SAsmitha Karunanithi                 {
4525cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first ==
4535cb1dd27SAsmitha Karunanithi                         ("xyz.openbmc_project.Dump.Entry." + dumpType))
4545cb1dd27SAsmitha Karunanithi                     {
4555cb1dd27SAsmitha Karunanithi                         foundDumpEntry = true;
4565cb1dd27SAsmitha Karunanithi                         break;
4575cb1dd27SAsmitha Karunanithi                     }
4585cb1dd27SAsmitha Karunanithi                 }
4595cb1dd27SAsmitha Karunanithi 
4605cb1dd27SAsmitha Karunanithi                 if (foundDumpEntry == false)
4615cb1dd27SAsmitha Karunanithi                 {
4625cb1dd27SAsmitha Karunanithi                     continue;
4635cb1dd27SAsmitha Karunanithi                 }
4645cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
4655cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
4665cb1dd27SAsmitha Karunanithi                 entriesArray.push_back({});
4675cb1dd27SAsmitha Karunanithi                 nlohmann::json& thisEntry = entriesArray.back();
4685cb1dd27SAsmitha Karunanithi                 const std::string& path =
4695cb1dd27SAsmitha Karunanithi                     static_cast<const std::string&>(object.first);
4705cb1dd27SAsmitha Karunanithi                 std::size_t lastPos = path.rfind("/");
4715cb1dd27SAsmitha Karunanithi                 if (lastPos == std::string::npos)
4725cb1dd27SAsmitha Karunanithi                 {
4735cb1dd27SAsmitha Karunanithi                     continue;
4745cb1dd27SAsmitha Karunanithi                 }
4755cb1dd27SAsmitha Karunanithi                 std::string entryID = path.substr(lastPos + 1);
4765cb1dd27SAsmitha Karunanithi 
4775cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4785cb1dd27SAsmitha Karunanithi                 {
4795cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
4805cb1dd27SAsmitha Karunanithi                     {
4815cb1dd27SAsmitha Karunanithi 
4825cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4835cb1dd27SAsmitha Karunanithi                         {
4845cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
4855cb1dd27SAsmitha Karunanithi                             {
4865cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
4875cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4885cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
4895cb1dd27SAsmitha Karunanithi                                 {
4905cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4915cb1dd27SAsmitha Karunanithi                                     break;
4925cb1dd27SAsmitha Karunanithi                                 }
4935cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
4945cb1dd27SAsmitha Karunanithi                                 break;
4955cb1dd27SAsmitha Karunanithi                             }
4965cb1dd27SAsmitha Karunanithi                         }
4975cb1dd27SAsmitha Karunanithi                     }
4985cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
4995cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
5005cb1dd27SAsmitha Karunanithi                     {
5015cb1dd27SAsmitha Karunanithi 
5025cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
5035cb1dd27SAsmitha Karunanithi                         {
5045cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
5055cb1dd27SAsmitha Karunanithi                             {
5065cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
5075cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
5085cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
5095cb1dd27SAsmitha Karunanithi                                 {
5105cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
5115cb1dd27SAsmitha Karunanithi                                     break;
5125cb1dd27SAsmitha Karunanithi                                 }
5135cb1dd27SAsmitha Karunanithi                                 timestamp =
5145cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
5155cb1dd27SAsmitha Karunanithi                                 break;
5165cb1dd27SAsmitha Karunanithi                             }
5175cb1dd27SAsmitha Karunanithi                         }
5185cb1dd27SAsmitha Karunanithi                     }
5195cb1dd27SAsmitha Karunanithi                 }
5205cb1dd27SAsmitha Karunanithi 
5215cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.type"] = "#LogEntry.v1_5_1.LogEntry";
5225cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.id"] = dumpPath + entryID;
5235cb1dd27SAsmitha Karunanithi                 thisEntry["Id"] = entryID;
5245cb1dd27SAsmitha Karunanithi                 thisEntry["EntryType"] = "Event";
5255cb1dd27SAsmitha Karunanithi                 thisEntry["Created"] = crow::utility::getDateTime(timestamp);
5265cb1dd27SAsmitha Karunanithi                 thisEntry["Name"] = dumpType + " Dump Entry";
5275cb1dd27SAsmitha Karunanithi 
5285cb1dd27SAsmitha Karunanithi                 thisEntry["Oem"]["OpenBmc"]["@odata.type"] =
5295cb1dd27SAsmitha Karunanithi                     "#OemLogEntry.v1_0_0.OpenBmc";
5305cb1dd27SAsmitha Karunanithi                 thisEntry["Oem"]["OpenBmc"]["AdditionalDataSizeBytes"] = size;
5315cb1dd27SAsmitha Karunanithi 
5325cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
5335cb1dd27SAsmitha Karunanithi                 {
5345cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["DiagnosticDataType"] =
5355cb1dd27SAsmitha Karunanithi                         "Manager";
5365cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["AdditionalDataURI"] =
5375cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
5385cb1dd27SAsmitha Karunanithi                         "attachment/" +
5395cb1dd27SAsmitha Karunanithi                         entryID;
5405cb1dd27SAsmitha Karunanithi                 }
5415cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
5425cb1dd27SAsmitha Karunanithi                 {
5435cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["DiagnosticDataType"] = "OEM";
5445cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["OEMDiagnosticDataType"] =
5455cb1dd27SAsmitha Karunanithi                         "System";
5465cb1dd27SAsmitha Karunanithi                     thisEntry["Oem"]["OpenBmc"]["AdditionalDataURI"] =
5475cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
5485cb1dd27SAsmitha Karunanithi                         "attachment/" +
5495cb1dd27SAsmitha Karunanithi                         entryID;
5505cb1dd27SAsmitha Karunanithi                 }
5515cb1dd27SAsmitha Karunanithi             }
5525cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Members@odata.count"] =
5535cb1dd27SAsmitha Karunanithi                 entriesArray.size();
5545cb1dd27SAsmitha Karunanithi         },
5555cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5565cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5575cb1dd27SAsmitha Karunanithi }
5585cb1dd27SAsmitha Karunanithi 
5595cb1dd27SAsmitha Karunanithi inline void getDumpEntryById(std::shared_ptr<AsyncResp>& asyncResp,
5605cb1dd27SAsmitha Karunanithi                              const std::string& entryID,
5615cb1dd27SAsmitha Karunanithi                              const std::string& dumpType)
5625cb1dd27SAsmitha Karunanithi {
5635cb1dd27SAsmitha Karunanithi     std::string dumpPath;
5645cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
5655cb1dd27SAsmitha Karunanithi     {
5665cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
5675cb1dd27SAsmitha Karunanithi     }
5685cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
5695cb1dd27SAsmitha Karunanithi     {
5705cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
5715cb1dd27SAsmitha Karunanithi     }
5725cb1dd27SAsmitha Karunanithi     else
5735cb1dd27SAsmitha Karunanithi     {
5745cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
5755cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5765cb1dd27SAsmitha Karunanithi         return;
5775cb1dd27SAsmitha Karunanithi     }
5785cb1dd27SAsmitha Karunanithi 
5795cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
5805cb1dd27SAsmitha Karunanithi         [asyncResp, entryID, dumpPath, dumpType](
5815cb1dd27SAsmitha Karunanithi             const boost::system::error_code ec, GetManagedObjectsType& resp) {
5825cb1dd27SAsmitha Karunanithi             if (ec)
5835cb1dd27SAsmitha Karunanithi             {
5845cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
5855cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
5865cb1dd27SAsmitha Karunanithi                 return;
5875cb1dd27SAsmitha Karunanithi             }
5885cb1dd27SAsmitha Karunanithi 
5895cb1dd27SAsmitha Karunanithi             for (auto& objectPath : resp)
5905cb1dd27SAsmitha Karunanithi             {
5915cb1dd27SAsmitha Karunanithi                 if (objectPath.first.str.find(
5925cb1dd27SAsmitha Karunanithi                         "/xyz/openbmc_project/dump/entry/" + entryID) ==
5935cb1dd27SAsmitha Karunanithi                     std::string::npos)
5945cb1dd27SAsmitha Karunanithi                 {
5955cb1dd27SAsmitha Karunanithi                     continue;
5965cb1dd27SAsmitha Karunanithi                 }
5975cb1dd27SAsmitha Karunanithi 
5985cb1dd27SAsmitha Karunanithi                 bool foundDumpEntry = false;
5995cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
6005cb1dd27SAsmitha Karunanithi                 {
6015cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first ==
6025cb1dd27SAsmitha Karunanithi                         ("xyz.openbmc_project.Dump.Entry." + dumpType))
6035cb1dd27SAsmitha Karunanithi                     {
6045cb1dd27SAsmitha Karunanithi                         foundDumpEntry = true;
6055cb1dd27SAsmitha Karunanithi                         break;
6065cb1dd27SAsmitha Karunanithi                     }
6075cb1dd27SAsmitha Karunanithi                 }
6085cb1dd27SAsmitha Karunanithi                 if (foundDumpEntry == false)
6095cb1dd27SAsmitha Karunanithi                 {
6105cb1dd27SAsmitha Karunanithi                     BMCWEB_LOG_ERROR << "Can't find Dump Entry";
6115cb1dd27SAsmitha Karunanithi                     messages::internalError(asyncResp->res);
6125cb1dd27SAsmitha Karunanithi                     return;
6135cb1dd27SAsmitha Karunanithi                 }
6145cb1dd27SAsmitha Karunanithi 
6155cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
6165cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
6175cb1dd27SAsmitha Karunanithi 
6185cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
6195cb1dd27SAsmitha Karunanithi                 {
6205cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
6215cb1dd27SAsmitha Karunanithi                     {
6225cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6235cb1dd27SAsmitha Karunanithi                         {
6245cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
6255cb1dd27SAsmitha Karunanithi                             {
6265cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
6275cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6285cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
6295cb1dd27SAsmitha Karunanithi                                 {
6305cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6315cb1dd27SAsmitha Karunanithi                                     break;
6325cb1dd27SAsmitha Karunanithi                                 }
6335cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
6345cb1dd27SAsmitha Karunanithi                                 break;
6355cb1dd27SAsmitha Karunanithi                             }
6365cb1dd27SAsmitha Karunanithi                         }
6375cb1dd27SAsmitha Karunanithi                     }
6385cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
6395cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
6405cb1dd27SAsmitha Karunanithi                     {
6415cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6425cb1dd27SAsmitha Karunanithi                         {
6435cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
6445cb1dd27SAsmitha Karunanithi                             {
6455cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
6465cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6475cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
6485cb1dd27SAsmitha Karunanithi                                 {
6495cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6505cb1dd27SAsmitha Karunanithi                                     break;
6515cb1dd27SAsmitha Karunanithi                                 }
6525cb1dd27SAsmitha Karunanithi                                 timestamp =
6535cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
6545cb1dd27SAsmitha Karunanithi                                 break;
6555cb1dd27SAsmitha Karunanithi                             }
6565cb1dd27SAsmitha Karunanithi                         }
6575cb1dd27SAsmitha Karunanithi                     }
6585cb1dd27SAsmitha Karunanithi                 }
6595cb1dd27SAsmitha Karunanithi 
6605cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
6615cb1dd27SAsmitha Karunanithi                     "#LogEntry.v1_5_1.LogEntry";
6625cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
6635cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = entryID;
6645cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["EntryType"] = "Event";
6655cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Created"] =
6665cb1dd27SAsmitha Karunanithi                     crow::utility::getDateTime(timestamp);
6675cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
6685cb1dd27SAsmitha Karunanithi 
6695cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Oem"]["OpenBmc"]["@odata.type"] =
6705cb1dd27SAsmitha Karunanithi                     "#OemLogEntry.v1_0_0.OpenBmc";
6715cb1dd27SAsmitha Karunanithi                 asyncResp->res
6725cb1dd27SAsmitha Karunanithi                     .jsonValue["Oem"]["OpenBmc"]["AdditionalDataSizeBytes"] =
6735cb1dd27SAsmitha Karunanithi                     size;
6745cb1dd27SAsmitha Karunanithi 
6755cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
6765cb1dd27SAsmitha Karunanithi                 {
6775cb1dd27SAsmitha Karunanithi                     asyncResp->res
6785cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["DiagnosticDataType"] =
6795cb1dd27SAsmitha Karunanithi                         "Manager";
6805cb1dd27SAsmitha Karunanithi                     asyncResp->res
6815cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["AdditionalDataURI"] =
6825cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
6835cb1dd27SAsmitha Karunanithi                         "attachment/" +
6845cb1dd27SAsmitha Karunanithi                         entryID;
6855cb1dd27SAsmitha Karunanithi                 }
6865cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
6875cb1dd27SAsmitha Karunanithi                 {
6885cb1dd27SAsmitha Karunanithi                     asyncResp->res
6895cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["DiagnosticDataType"] =
6905cb1dd27SAsmitha Karunanithi                         "OEM";
6915cb1dd27SAsmitha Karunanithi                     asyncResp->res
6925cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["OEMDiagnosticDataType"] =
6935cb1dd27SAsmitha Karunanithi                         "System";
6945cb1dd27SAsmitha Karunanithi                     asyncResp->res
6955cb1dd27SAsmitha Karunanithi                         .jsonValue["Oem"]["OpenBmc"]["AdditionalDataURI"] =
6965cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
6975cb1dd27SAsmitha Karunanithi                         "attachment/" +
6985cb1dd27SAsmitha Karunanithi                         entryID;
6995cb1dd27SAsmitha Karunanithi                 }
7005cb1dd27SAsmitha Karunanithi             }
7015cb1dd27SAsmitha Karunanithi         },
7025cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
7035cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
7045cb1dd27SAsmitha Karunanithi }
7055cb1dd27SAsmitha Karunanithi 
7065cb1dd27SAsmitha Karunanithi inline void deleteDumpEntry(crow::Response& res, const std::string& entryID)
7075cb1dd27SAsmitha Karunanithi {
7085cb1dd27SAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
7095cb1dd27SAsmitha Karunanithi 
7105cb1dd27SAsmitha Karunanithi     auto respHandler = [asyncResp](const boost::system::error_code ec) {
7115cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
7125cb1dd27SAsmitha Karunanithi         if (ec)
7135cb1dd27SAsmitha Karunanithi         {
7145cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
7155cb1dd27SAsmitha Karunanithi                              << ec;
7165cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
7175cb1dd27SAsmitha Karunanithi             return;
7185cb1dd27SAsmitha Karunanithi         }
7195cb1dd27SAsmitha Karunanithi     };
7205cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
7215cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
7225cb1dd27SAsmitha Karunanithi         "/xyz/openbmc_project/dump/entry/" + entryID,
7235cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
7245cb1dd27SAsmitha Karunanithi }
7255cb1dd27SAsmitha Karunanithi 
726a43be80fSAsmitha Karunanithi inline void createDumpTaskCallback(const crow::Request& req,
727a43be80fSAsmitha Karunanithi                                    std::shared_ptr<AsyncResp> asyncResp,
728a43be80fSAsmitha Karunanithi                                    const uint32_t& dumpId,
729a43be80fSAsmitha Karunanithi                                    const std::string& dumpPath,
730a43be80fSAsmitha Karunanithi                                    const std::string& dumpType)
731a43be80fSAsmitha Karunanithi {
732a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
733a43be80fSAsmitha Karunanithi         [dumpId, dumpPath, dumpType](
734a43be80fSAsmitha Karunanithi             boost::system::error_code err, sdbusplus::message::message& m,
735a43be80fSAsmitha Karunanithi             const std::shared_ptr<task::TaskData>& taskData) {
736a43be80fSAsmitha Karunanithi             std::vector<std::pair<
737a43be80fSAsmitha Karunanithi                 std::string,
738a43be80fSAsmitha Karunanithi                 std::vector<std::pair<std::string, std::variant<std::string>>>>>
739a43be80fSAsmitha Karunanithi                 interfacesList;
740a43be80fSAsmitha Karunanithi 
741a43be80fSAsmitha Karunanithi             sdbusplus::message::object_path objPath;
742a43be80fSAsmitha Karunanithi 
743a43be80fSAsmitha Karunanithi             m.read(objPath, interfacesList);
744a43be80fSAsmitha Karunanithi 
745a43be80fSAsmitha Karunanithi             for (auto& interface : interfacesList)
746a43be80fSAsmitha Karunanithi             {
747a43be80fSAsmitha Karunanithi                 if (interface.first ==
748a43be80fSAsmitha Karunanithi                     ("xyz.openbmc_project.Dump.Entry." + dumpType))
749a43be80fSAsmitha Karunanithi                 {
750a43be80fSAsmitha Karunanithi                     nlohmann::json retMessage = messages::success();
751a43be80fSAsmitha Karunanithi                     taskData->messages.emplace_back(retMessage);
752a43be80fSAsmitha Karunanithi 
753a43be80fSAsmitha Karunanithi                     std::string headerLoc =
754a43be80fSAsmitha Karunanithi                         "Location: " + dumpPath + std::to_string(dumpId);
755a43be80fSAsmitha Karunanithi                     taskData->payload->httpHeaders.emplace_back(
756a43be80fSAsmitha Karunanithi                         std::move(headerLoc));
757a43be80fSAsmitha Karunanithi 
758a43be80fSAsmitha Karunanithi                     taskData->state = "Completed";
759a43be80fSAsmitha Karunanithi                     return task::completed;
760a43be80fSAsmitha Karunanithi                 }
761a43be80fSAsmitha Karunanithi             }
762a43be80fSAsmitha Karunanithi             return !task::completed;
763a43be80fSAsmitha Karunanithi         },
764a43be80fSAsmitha Karunanithi         "type='signal',interface='org.freedesktop.DBus."
765a43be80fSAsmitha Karunanithi         "ObjectManager',"
766a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
767a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
768a43be80fSAsmitha Karunanithi 
769a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
770a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
771a43be80fSAsmitha Karunanithi     task->payload.emplace(req);
772a43be80fSAsmitha Karunanithi }
773a43be80fSAsmitha Karunanithi 
774a43be80fSAsmitha Karunanithi inline void createDump(crow::Response& res, const crow::Request& req,
775a43be80fSAsmitha Karunanithi                        const std::string& dumpType)
776a43be80fSAsmitha Karunanithi {
777a43be80fSAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
778a43be80fSAsmitha Karunanithi 
779a43be80fSAsmitha Karunanithi     std::string dumpPath;
780a43be80fSAsmitha Karunanithi     if (dumpType == "BMC")
781a43be80fSAsmitha Karunanithi     {
782a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
783a43be80fSAsmitha Karunanithi     }
784a43be80fSAsmitha Karunanithi     else if (dumpType == "System")
785a43be80fSAsmitha Karunanithi     {
786a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
787a43be80fSAsmitha Karunanithi     }
788a43be80fSAsmitha Karunanithi     else
789a43be80fSAsmitha Karunanithi     {
790a43be80fSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
791a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
792a43be80fSAsmitha Karunanithi         return;
793a43be80fSAsmitha Karunanithi     }
794a43be80fSAsmitha Karunanithi 
795a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
796a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
797a43be80fSAsmitha Karunanithi 
798a43be80fSAsmitha Karunanithi     if (!redfish::json_util::readJson(
799a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
800a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
801a43be80fSAsmitha Karunanithi     {
802a43be80fSAsmitha Karunanithi         return;
803a43be80fSAsmitha Karunanithi     }
804a43be80fSAsmitha Karunanithi 
805a43be80fSAsmitha Karunanithi     if (dumpType == "System")
806a43be80fSAsmitha Karunanithi     {
807a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
808a43be80fSAsmitha Karunanithi         {
809a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
810a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType'/"
811a43be80fSAsmitha Karunanithi                                 "'OEMDiagnosticDataType' value not found!";
812a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
813a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
814a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
815a43be80fSAsmitha Karunanithi             return;
816a43be80fSAsmitha Karunanithi         }
817a43be80fSAsmitha Karunanithi         else if ((*oemDiagnosticDataType != "System") ||
818a43be80fSAsmitha Karunanithi                  (*diagnosticDataType != "OEM"))
819a43be80fSAsmitha Karunanithi         {
820a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
821a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
822a43be80fSAsmitha Karunanithi                                     "System Dump creation parameters");
823a43be80fSAsmitha Karunanithi             return;
824a43be80fSAsmitha Karunanithi         }
825a43be80fSAsmitha Karunanithi     }
826a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
827a43be80fSAsmitha Karunanithi     {
828a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
829a43be80fSAsmitha Karunanithi         {
830a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
831a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType' not found!";
832a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
833a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
834a43be80fSAsmitha Karunanithi             return;
835a43be80fSAsmitha Karunanithi         }
836a43be80fSAsmitha Karunanithi         else if (*diagnosticDataType != "Manager")
837a43be80fSAsmitha Karunanithi         {
838a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
839a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
840a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
841a43be80fSAsmitha Karunanithi                                     "BMC Dump creation parameters");
842a43be80fSAsmitha Karunanithi             return;
843a43be80fSAsmitha Karunanithi         }
844a43be80fSAsmitha Karunanithi     }
845a43be80fSAsmitha Karunanithi 
846a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
847a43be80fSAsmitha Karunanithi         [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec,
848a43be80fSAsmitha Karunanithi                                              const uint32_t& dumpId) {
849a43be80fSAsmitha Karunanithi             if (ec)
850a43be80fSAsmitha Karunanithi             {
851a43be80fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
852a43be80fSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
853a43be80fSAsmitha Karunanithi                 return;
854a43be80fSAsmitha Karunanithi             }
855a43be80fSAsmitha Karunanithi             BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
856a43be80fSAsmitha Karunanithi 
857a43be80fSAsmitha Karunanithi             createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType);
858a43be80fSAsmitha Karunanithi         },
859a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
860a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
861a43be80fSAsmitha Karunanithi }
862a43be80fSAsmitha Karunanithi 
86380319af1SAsmitha Karunanithi inline void clearDump(crow::Response& res, const std::string& dumpInterface)
86480319af1SAsmitha Karunanithi {
86580319af1SAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
86680319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
86780319af1SAsmitha Karunanithi         [asyncResp](const boost::system::error_code ec,
86880319af1SAsmitha Karunanithi                     const std::vector<std::string>& subTreePaths) {
86980319af1SAsmitha Karunanithi             if (ec)
87080319af1SAsmitha Karunanithi             {
87180319af1SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
87280319af1SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
87380319af1SAsmitha Karunanithi                 return;
87480319af1SAsmitha Karunanithi             }
87580319af1SAsmitha Karunanithi 
87680319af1SAsmitha Karunanithi             for (const std::string& path : subTreePaths)
87780319af1SAsmitha Karunanithi             {
87880319af1SAsmitha Karunanithi                 std::size_t pos = path.rfind("/");
87980319af1SAsmitha Karunanithi                 if (pos != std::string::npos)
88080319af1SAsmitha Karunanithi                 {
88180319af1SAsmitha Karunanithi                     std::string logID = path.substr(pos + 1);
88280319af1SAsmitha Karunanithi                     deleteDumpEntry(asyncResp->res, logID);
88380319af1SAsmitha Karunanithi                 }
88480319af1SAsmitha Karunanithi             }
88580319af1SAsmitha Karunanithi         },
88680319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
88780319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
88880319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
88980319af1SAsmitha Karunanithi         "/xyz/openbmc_project/dump", 0,
89080319af1SAsmitha Karunanithi         std::array<std::string, 1>{dumpInterface});
89180319af1SAsmitha Karunanithi }
89280319af1SAsmitha Karunanithi 
893043a0536SJohnathan Mantey static void ParseCrashdumpParameters(
894043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>>& params,
895043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
896043a0536SJohnathan Mantey {
897043a0536SJohnathan Mantey     for (auto property : params)
898043a0536SJohnathan Mantey     {
899043a0536SJohnathan Mantey         if (property.first == "Timestamp")
900043a0536SJohnathan Mantey         {
901043a0536SJohnathan Mantey             const std::string* value =
9028d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
903043a0536SJohnathan Mantey             if (value != nullptr)
904043a0536SJohnathan Mantey             {
905043a0536SJohnathan Mantey                 timestamp = *value;
906043a0536SJohnathan Mantey             }
907043a0536SJohnathan Mantey         }
908043a0536SJohnathan Mantey         else if (property.first == "Filename")
909043a0536SJohnathan Mantey         {
910043a0536SJohnathan Mantey             const std::string* value =
9118d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
912043a0536SJohnathan Mantey             if (value != nullptr)
913043a0536SJohnathan Mantey             {
914043a0536SJohnathan Mantey                 filename = *value;
915043a0536SJohnathan Mantey             }
916043a0536SJohnathan Mantey         }
917043a0536SJohnathan Mantey         else if (property.first == "Log")
918043a0536SJohnathan Mantey         {
919043a0536SJohnathan Mantey             const std::string* value =
9208d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
921043a0536SJohnathan Mantey             if (value != nullptr)
922043a0536SJohnathan Mantey             {
923043a0536SJohnathan Mantey                 logfile = *value;
924043a0536SJohnathan Mantey             }
925043a0536SJohnathan Mantey         }
926043a0536SJohnathan Mantey     }
927043a0536SJohnathan Mantey }
928043a0536SJohnathan Mantey 
929a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
930c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node
9311da66f75SEd Tanous {
9321da66f75SEd Tanous   public:
9331da66f75SEd Tanous     template <typename CrowApp>
934c4bf6374SJason M. Bills     SystemLogServiceCollection(CrowApp& app) :
935029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/")
936c4bf6374SJason M. Bills     {
937c4bf6374SJason M. Bills         entityPrivileges = {
938c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
939c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
940c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
941c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
942c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
943c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
944c4bf6374SJason M. Bills     }
945c4bf6374SJason M. Bills 
946c4bf6374SJason M. Bills   private:
947c4bf6374SJason M. Bills     /**
948c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
949c4bf6374SJason M. Bills      */
950c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
951c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
952c4bf6374SJason M. Bills     {
953c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
954c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
955c4bf6374SJason M. Bills         // it has a duplicate entry for members
956c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
957c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
958c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
959029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
960c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
961c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
962c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
963c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
964c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
965029573d4SEd Tanous         logServiceArray.push_back(
966029573d4SEd Tanous             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}});
9675cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
968c9bb6861Sraviteja-b         logServiceArray.push_back(
9695cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}});
970c9bb6861Sraviteja-b #endif
971c9bb6861Sraviteja-b 
972d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
973d53dd41fSJason M. Bills         logServiceArray.push_back(
974cb92c03bSAndrew Geissler             {{"@odata.id",
975424c4176SJason M. Bills               "/redfish/v1/Systems/system/LogServices/Crashdump"}});
976d53dd41fSJason M. Bills #endif
977c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
978c4bf6374SJason M. Bills             logServiceArray.size();
979a3316fc6SZhikuiRen 
980a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
981a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec,
982a3316fc6SZhikuiRen                         const std::vector<std::string>& subtreePath) {
983a3316fc6SZhikuiRen                 if (ec)
984a3316fc6SZhikuiRen                 {
985a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR << ec;
986a3316fc6SZhikuiRen                     return;
987a3316fc6SZhikuiRen                 }
988a3316fc6SZhikuiRen 
989a3316fc6SZhikuiRen                 for (auto& pathStr : subtreePath)
990a3316fc6SZhikuiRen                 {
991a3316fc6SZhikuiRen                     if (pathStr.find("PostCode") != std::string::npos)
992a3316fc6SZhikuiRen                     {
993a3316fc6SZhikuiRen                         nlohmann::json& logServiceArray =
994a3316fc6SZhikuiRen                             asyncResp->res.jsonValue["Members"];
995a3316fc6SZhikuiRen                         logServiceArray.push_back(
996a3316fc6SZhikuiRen                             {{"@odata.id", "/redfish/v1/Systems/system/"
997a3316fc6SZhikuiRen                                            "LogServices/PostCodes"}});
998a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members@odata.count"] =
999a3316fc6SZhikuiRen                             logServiceArray.size();
1000a3316fc6SZhikuiRen                         return;
1001a3316fc6SZhikuiRen                     }
1002a3316fc6SZhikuiRen                 }
1003a3316fc6SZhikuiRen             },
1004a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper",
1005a3316fc6SZhikuiRen             "/xyz/openbmc_project/object_mapper",
1006a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
1007a3316fc6SZhikuiRen             std::array<const char*, 1>{postCodeIface});
1008c4bf6374SJason M. Bills     }
1009c4bf6374SJason M. Bills };
1010c4bf6374SJason M. Bills 
1011c4bf6374SJason M. Bills class EventLogService : public Node
1012c4bf6374SJason M. Bills {
1013c4bf6374SJason M. Bills   public:
1014c4bf6374SJason M. Bills     template <typename CrowApp>
1015c4bf6374SJason M. Bills     EventLogService(CrowApp& app) :
1016029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
1017c4bf6374SJason M. Bills     {
1018c4bf6374SJason M. Bills         entityPrivileges = {
1019c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1020c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1021c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1022c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1023c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1024c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1025c4bf6374SJason M. Bills     }
1026c4bf6374SJason M. Bills 
1027c4bf6374SJason M. Bills   private:
1028c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1029c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1030c4bf6374SJason M. Bills     {
1031c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1032c4bf6374SJason M. Bills 
1033c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1034029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
1035c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1036c4bf6374SJason M. Bills             "#LogService.v1_1_0.LogService";
1037c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
1038c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1039c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
1040c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1041c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1042c4bf6374SJason M. Bills             {"@odata.id",
1043029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
1044e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1045e7d6c8b2SGunnar Mills 
1046e7d6c8b2SGunnar Mills             {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
1047e7d6c8b2SGunnar Mills                        "Actions/LogService.ClearLog"}};
1048489640c6SJason M. Bills     }
1049489640c6SJason M. Bills };
1050489640c6SJason M. Bills 
10511f56a3a6STim Lee class JournalEventLogClear : public Node
1052489640c6SJason M. Bills {
1053489640c6SJason M. Bills   public:
10541f56a3a6STim Lee     JournalEventLogClear(CrowApp& app) :
1055489640c6SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1056489640c6SJason M. Bills                   "LogService.ClearLog/")
1057489640c6SJason M. Bills     {
1058489640c6SJason M. Bills         entityPrivileges = {
1059489640c6SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1060489640c6SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1061489640c6SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1062489640c6SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1063489640c6SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1064489640c6SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1065489640c6SJason M. Bills     }
1066489640c6SJason M. Bills 
1067489640c6SJason M. Bills   private:
1068489640c6SJason M. Bills     void doPost(crow::Response& res, const crow::Request& req,
1069489640c6SJason M. Bills                 const std::vector<std::string>& params) override
1070489640c6SJason M. Bills     {
1071489640c6SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1072489640c6SJason M. Bills 
1073489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
1074489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1075489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
1076489640c6SJason M. Bills         {
1077489640c6SJason M. Bills             for (const std::filesystem::path& file : redfishLogFiles)
1078489640c6SJason M. Bills             {
1079489640c6SJason M. Bills                 std::error_code ec;
1080489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
1081489640c6SJason M. Bills             }
1082489640c6SJason M. Bills         }
1083489640c6SJason M. Bills 
1084489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
1085489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
1086489640c6SJason M. Bills             [asyncResp](const boost::system::error_code ec) {
1087489640c6SJason M. Bills                 if (ec)
1088489640c6SJason M. Bills                 {
1089489640c6SJason M. Bills                     BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
1090489640c6SJason M. Bills                     messages::internalError(asyncResp->res);
1091489640c6SJason M. Bills                     return;
1092489640c6SJason M. Bills                 }
1093489640c6SJason M. Bills 
1094489640c6SJason M. Bills                 messages::success(asyncResp->res);
1095489640c6SJason M. Bills             },
1096489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1097489640c6SJason M. Bills             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1098489640c6SJason M. Bills             "replace");
1099c4bf6374SJason M. Bills     }
1100c4bf6374SJason M. Bills };
1101c4bf6374SJason M. Bills 
110295820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
110395820184SJason M. Bills                                  const std::string logEntry,
110495820184SJason M. Bills                                  nlohmann::json& logEntryJson)
1105c4bf6374SJason M. Bills {
110695820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1107cd225da8SJason M. Bills     // First get the Timestamp
1108cd225da8SJason M. Bills     size_t space = logEntry.find_first_of(" ");
1109cd225da8SJason M. Bills     if (space == std::string::npos)
111095820184SJason M. Bills     {
111195820184SJason M. Bills         return 1;
111295820184SJason M. Bills     }
1113cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1114cd225da8SJason M. Bills     // Then get the log contents
1115cd225da8SJason M. Bills     size_t entryStart = logEntry.find_first_not_of(" ", space);
1116cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1117cd225da8SJason M. Bills     {
1118cd225da8SJason M. Bills         return 1;
1119cd225da8SJason M. Bills     }
1120cd225da8SJason M. Bills     std::string_view entry(logEntry);
1121cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1122cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1123cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1124cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1125cd225da8SJason M. Bills                  boost::token_compress_on);
1126cd225da8SJason M. Bills     // We need at least a MessageId to be valid
1127cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
1128cd225da8SJason M. Bills     {
1129cd225da8SJason M. Bills         return 1;
1130cd225da8SJason M. Bills     }
1131cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
113295820184SJason M. Bills 
11334851d45dSJason M. Bills     // Get the Message from the MessageRegistry
11344851d45dSJason M. Bills     const message_registries::Message* message =
11354851d45dSJason M. Bills         message_registries::getMessage(messageID);
1136c4bf6374SJason M. Bills 
11374851d45dSJason M. Bills     std::string msg;
11384851d45dSJason M. Bills     std::string severity;
11394851d45dSJason M. Bills     if (message != nullptr)
1140c4bf6374SJason M. Bills     {
11414851d45dSJason M. Bills         msg = message->message;
11424851d45dSJason M. Bills         severity = message->severity;
1143c4bf6374SJason M. Bills     }
1144c4bf6374SJason M. Bills 
114515a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
114615a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
114715a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
114815a86ff6SJason M. Bills     {
114915a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
115015a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
115115a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
115215a86ff6SJason M. Bills         if (!messageArgsStart.empty())
115315a86ff6SJason M. Bills         {
115415a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
115515a86ff6SJason M. Bills         }
115615a86ff6SJason M. Bills 
115715a86ff6SJason M. Bills         messageArgs = boost::beast::span(&messageArgsStart, messageArgsSize);
1158c4bf6374SJason M. Bills 
11594851d45dSJason M. Bills         // Fill the MessageArgs into the Message
116095820184SJason M. Bills         int i = 0;
116195820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11624851d45dSJason M. Bills         {
116395820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11644851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11654851d45dSJason M. Bills             if (argPos != std::string::npos)
11664851d45dSJason M. Bills             {
116795820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11684851d45dSJason M. Bills             }
11694851d45dSJason M. Bills         }
117015a86ff6SJason M. Bills     }
11714851d45dSJason M. Bills 
117295820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
117395820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
117495820184SJason M. Bills     // between the '.' and the '+', so just remove them.
117595820184SJason M. Bills     std::size_t dot = timestamp.find_first_of(".");
117695820184SJason M. Bills     std::size_t plus = timestamp.find_first_of("+");
117795820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1178c4bf6374SJason M. Bills     {
117995820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1180c4bf6374SJason M. Bills     }
1181c4bf6374SJason M. Bills 
1182c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
118395820184SJason M. Bills     logEntryJson = {
1184cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1185029573d4SEd Tanous         {"@odata.id",
1186897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
118795820184SJason M. Bills              logEntryID},
1188c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
118995820184SJason M. Bills         {"Id", logEntryID},
119095820184SJason M. Bills         {"Message", std::move(msg)},
119195820184SJason M. Bills         {"MessageId", std::move(messageID)},
1192c4bf6374SJason M. Bills         {"MessageArgs", std::move(messageArgs)},
1193c4bf6374SJason M. Bills         {"EntryType", "Event"},
119495820184SJason M. Bills         {"Severity", std::move(severity)},
119595820184SJason M. Bills         {"Created", std::move(timestamp)}};
1196c4bf6374SJason M. Bills     return 0;
1197c4bf6374SJason M. Bills }
1198c4bf6374SJason M. Bills 
119927062605SAnthony Wilson class JournalEventLogEntryCollection : public Node
1200c4bf6374SJason M. Bills {
1201c4bf6374SJason M. Bills   public:
1202c4bf6374SJason M. Bills     template <typename CrowApp>
120327062605SAnthony Wilson     JournalEventLogEntryCollection(CrowApp& app) :
1204029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1205c4bf6374SJason M. Bills     {
1206c4bf6374SJason M. Bills         entityPrivileges = {
1207c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1208c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1209c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1210c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1211c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1212c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1213c4bf6374SJason M. Bills     }
1214c4bf6374SJason M. Bills 
1215c4bf6374SJason M. Bills   private:
1216c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1217c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1218c4bf6374SJason M. Bills     {
1219c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1220271584abSEd Tanous         uint64_t skip = 0;
1221271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
1222c4bf6374SJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1223c4bf6374SJason M. Bills         {
1224c4bf6374SJason M. Bills             return;
1225c4bf6374SJason M. Bills         }
1226c4bf6374SJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1227c4bf6374SJason M. Bills         {
1228c4bf6374SJason M. Bills             return;
1229c4bf6374SJason M. Bills         }
1230c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
1231c4bf6374SJason M. Bills         // it has a duplicate entry for members
1232c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1233c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
1234c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1235029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1236c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1237c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1238c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
1239cb92c03bSAndrew Geissler 
1240c4bf6374SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1241c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
124295820184SJason M. Bills         // Go through the log files and create a unique ID for each entry
124395820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
124495820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1245b01bf299SEd Tanous         uint64_t entryCount = 0;
1246cd225da8SJason M. Bills         std::string logEntry;
124795820184SJason M. Bills 
124895820184SJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1249cd225da8SJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1250cd225da8SJason M. Bills              it++)
1251c4bf6374SJason M. Bills         {
1252cd225da8SJason M. Bills             std::ifstream logStream(*it);
125395820184SJason M. Bills             if (!logStream.is_open())
1254c4bf6374SJason M. Bills             {
1255c4bf6374SJason M. Bills                 continue;
1256c4bf6374SJason M. Bills             }
1257c4bf6374SJason M. Bills 
1258e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
1259e85d6b16SJason M. Bills             bool firstEntry = true;
126095820184SJason M. Bills             while (std::getline(logStream, logEntry))
126195820184SJason M. Bills             {
1262c4bf6374SJason M. Bills                 entryCount++;
1263c4bf6374SJason M. Bills                 // Handle paging using skip (number of entries to skip from the
1264c4bf6374SJason M. Bills                 // start) and top (number of entries to display)
1265c4bf6374SJason M. Bills                 if (entryCount <= skip || entryCount > skip + top)
1266c4bf6374SJason M. Bills                 {
1267c4bf6374SJason M. Bills                     continue;
1268c4bf6374SJason M. Bills                 }
1269c4bf6374SJason M. Bills 
1270c4bf6374SJason M. Bills                 std::string idStr;
1271e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1272c4bf6374SJason M. Bills                 {
1273c4bf6374SJason M. Bills                     continue;
1274c4bf6374SJason M. Bills                 }
1275c4bf6374SJason M. Bills 
1276e85d6b16SJason M. Bills                 if (firstEntry)
1277e85d6b16SJason M. Bills                 {
1278e85d6b16SJason M. Bills                     firstEntry = false;
1279e85d6b16SJason M. Bills                 }
1280e85d6b16SJason M. Bills 
1281c4bf6374SJason M. Bills                 logEntryArray.push_back({});
1282c4bf6374SJason M. Bills                 nlohmann::json& bmcLogEntry = logEntryArray.back();
128395820184SJason M. Bills                 if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0)
1284c4bf6374SJason M. Bills                 {
1285c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
1286c4bf6374SJason M. Bills                     return;
1287c4bf6374SJason M. Bills                 }
1288c4bf6374SJason M. Bills             }
128995820184SJason M. Bills         }
1290c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1291c4bf6374SJason M. Bills         if (skip + top < entryCount)
1292c4bf6374SJason M. Bills         {
1293c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
129495820184SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/"
129595820184SJason M. Bills                 "Entries?$skip=" +
1296c4bf6374SJason M. Bills                 std::to_string(skip + top);
1297c4bf6374SJason M. Bills         }
129808a4e4b5SAnthony Wilson     }
129908a4e4b5SAnthony Wilson };
130008a4e4b5SAnthony Wilson 
1301897967deSJason M. Bills class JournalEventLogEntry : public Node
1302897967deSJason M. Bills {
1303897967deSJason M. Bills   public:
1304897967deSJason M. Bills     JournalEventLogEntry(CrowApp& app) :
1305897967deSJason M. Bills         Node(app,
1306897967deSJason M. Bills              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1307897967deSJason M. Bills              std::string())
1308897967deSJason M. Bills     {
1309897967deSJason M. Bills         entityPrivileges = {
1310897967deSJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1311897967deSJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1312897967deSJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1313897967deSJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1314897967deSJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1315897967deSJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1316897967deSJason M. Bills     }
1317897967deSJason M. Bills 
1318897967deSJason M. Bills   private:
1319897967deSJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1320897967deSJason M. Bills                const std::vector<std::string>& params) override
1321897967deSJason M. Bills     {
1322897967deSJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1323897967deSJason M. Bills         if (params.size() != 1)
1324897967deSJason M. Bills         {
1325897967deSJason M. Bills             messages::internalError(asyncResp->res);
1326897967deSJason M. Bills             return;
1327897967deSJason M. Bills         }
1328897967deSJason M. Bills         const std::string& targetID = params[0];
1329897967deSJason M. Bills 
1330897967deSJason M. Bills         // Go through the log files and check the unique ID for each entry to
1331897967deSJason M. Bills         // find the target entry
1332897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1333897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1334897967deSJason M. Bills         std::string logEntry;
1335897967deSJason M. Bills 
1336897967deSJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1337897967deSJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1338897967deSJason M. Bills              it++)
1339897967deSJason M. Bills         {
1340897967deSJason M. Bills             std::ifstream logStream(*it);
1341897967deSJason M. Bills             if (!logStream.is_open())
1342897967deSJason M. Bills             {
1343897967deSJason M. Bills                 continue;
1344897967deSJason M. Bills             }
1345897967deSJason M. Bills 
1346897967deSJason M. Bills             // Reset the unique ID on the first entry
1347897967deSJason M. Bills             bool firstEntry = true;
1348897967deSJason M. Bills             while (std::getline(logStream, logEntry))
1349897967deSJason M. Bills             {
1350897967deSJason M. Bills                 std::string idStr;
1351897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1352897967deSJason M. Bills                 {
1353897967deSJason M. Bills                     continue;
1354897967deSJason M. Bills                 }
1355897967deSJason M. Bills 
1356897967deSJason M. Bills                 if (firstEntry)
1357897967deSJason M. Bills                 {
1358897967deSJason M. Bills                     firstEntry = false;
1359897967deSJason M. Bills                 }
1360897967deSJason M. Bills 
1361897967deSJason M. Bills                 if (idStr == targetID)
1362897967deSJason M. Bills                 {
1363897967deSJason M. Bills                     if (fillEventLogEntryJson(idStr, logEntry,
1364897967deSJason M. Bills                                               asyncResp->res.jsonValue) != 0)
1365897967deSJason M. Bills                     {
1366897967deSJason M. Bills                         messages::internalError(asyncResp->res);
1367897967deSJason M. Bills                         return;
1368897967deSJason M. Bills                     }
1369897967deSJason M. Bills                     return;
1370897967deSJason M. Bills                 }
1371897967deSJason M. Bills             }
1372897967deSJason M. Bills         }
1373897967deSJason M. Bills         // Requested ID was not found
1374897967deSJason M. Bills         messages::resourceMissingAtURI(asyncResp->res, targetID);
1375897967deSJason M. Bills     }
1376897967deSJason M. Bills };
1377897967deSJason M. Bills 
137808a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node
137908a4e4b5SAnthony Wilson {
138008a4e4b5SAnthony Wilson   public:
138108a4e4b5SAnthony Wilson     template <typename CrowApp>
138208a4e4b5SAnthony Wilson     DBusEventLogEntryCollection(CrowApp& app) :
138308a4e4b5SAnthony Wilson         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
138408a4e4b5SAnthony Wilson     {
138508a4e4b5SAnthony Wilson         entityPrivileges = {
138608a4e4b5SAnthony Wilson             {boost::beast::http::verb::get, {{"Login"}}},
138708a4e4b5SAnthony Wilson             {boost::beast::http::verb::head, {{"Login"}}},
138808a4e4b5SAnthony Wilson             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
138908a4e4b5SAnthony Wilson             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
139008a4e4b5SAnthony Wilson             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
139108a4e4b5SAnthony Wilson             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
139208a4e4b5SAnthony Wilson     }
139308a4e4b5SAnthony Wilson 
139408a4e4b5SAnthony Wilson   private:
139508a4e4b5SAnthony Wilson     void doGet(crow::Response& res, const crow::Request& req,
139608a4e4b5SAnthony Wilson                const std::vector<std::string>& params) override
139708a4e4b5SAnthony Wilson     {
139808a4e4b5SAnthony Wilson         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
139908a4e4b5SAnthony Wilson 
140008a4e4b5SAnthony Wilson         // Collections don't include the static data added by SubRoute because
140108a4e4b5SAnthony Wilson         // it has a duplicate entry for members
140208a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
140308a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
140408a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
140508a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
140608a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
140708a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
140808a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
140908a4e4b5SAnthony Wilson 
1410cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1411cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1412cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1413cb92c03bSAndrew Geissler             [asyncResp](const boost::system::error_code ec,
1414cb92c03bSAndrew Geissler                         GetManagedObjectsType& resp) {
1415cb92c03bSAndrew Geissler                 if (ec)
1416cb92c03bSAndrew Geissler                 {
1417cb92c03bSAndrew Geissler                     // TODO Handle for specific error code
1418cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1419cb92c03bSAndrew Geissler                         << "getLogEntriesIfaceData resp_handler got error "
1420cb92c03bSAndrew Geissler                         << ec;
1421cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1422cb92c03bSAndrew Geissler                     return;
1423cb92c03bSAndrew Geissler                 }
1424cb92c03bSAndrew Geissler                 nlohmann::json& entriesArray =
1425cb92c03bSAndrew Geissler                     asyncResp->res.jsonValue["Members"];
1426cb92c03bSAndrew Geissler                 entriesArray = nlohmann::json::array();
1427cb92c03bSAndrew Geissler                 for (auto& objectPath : resp)
1428cb92c03bSAndrew Geissler                 {
1429cb92c03bSAndrew Geissler                     for (auto& interfaceMap : objectPath.second)
1430cb92c03bSAndrew Geissler                     {
1431cb92c03bSAndrew Geissler                         if (interfaceMap.first !=
1432cb92c03bSAndrew Geissler                             "xyz.openbmc_project.Logging.Entry")
1433cb92c03bSAndrew Geissler                         {
1434cb92c03bSAndrew Geissler                             BMCWEB_LOG_DEBUG << "Bailing early on "
1435cb92c03bSAndrew Geissler                                              << interfaceMap.first;
1436cb92c03bSAndrew Geissler                             continue;
1437cb92c03bSAndrew Geissler                         }
1438cb92c03bSAndrew Geissler                         entriesArray.push_back({});
1439cb92c03bSAndrew Geissler                         nlohmann::json& thisEntry = entriesArray.back();
144066664f25SEd Tanous                         uint32_t* id = nullptr;
144166664f25SEd Tanous                         std::time_t timestamp{};
144266664f25SEd Tanous                         std::string* severity = nullptr;
144366664f25SEd Tanous                         std::string* message = nullptr;
1444cb92c03bSAndrew Geissler                         for (auto& propertyMap : interfaceMap.second)
1445cb92c03bSAndrew Geissler                         {
1446cb92c03bSAndrew Geissler                             if (propertyMap.first == "Id")
1447cb92c03bSAndrew Geissler                             {
14488d78b7a9SPatrick Williams                                 id = std::get_if<uint32_t>(&propertyMap.second);
1449cb92c03bSAndrew Geissler                                 if (id == nullptr)
1450cb92c03bSAndrew Geissler                                 {
14510f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1452cb92c03bSAndrew Geissler                                 }
1453cb92c03bSAndrew Geissler                             }
1454cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Timestamp")
1455cb92c03bSAndrew Geissler                             {
1456cb92c03bSAndrew Geissler                                 const uint64_t* millisTimeStamp =
1457cb92c03bSAndrew Geissler                                     std::get_if<uint64_t>(&propertyMap.second);
1458cb92c03bSAndrew Geissler                                 if (millisTimeStamp == nullptr)
1459cb92c03bSAndrew Geissler                                 {
14600f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1461271584abSEd Tanous                                     continue;
1462cb92c03bSAndrew Geissler                                 }
1463cb92c03bSAndrew Geissler                                 // Retrieve Created property with format:
1464cb92c03bSAndrew Geissler                                 // yyyy-mm-ddThh:mm:ss
1465cb92c03bSAndrew Geissler                                 std::chrono::milliseconds chronoTimeStamp(
1466cb92c03bSAndrew Geissler                                     *millisTimeStamp);
1467271584abSEd Tanous                                 timestamp = std::chrono::duration_cast<
1468271584abSEd Tanous                                                 std::chrono::duration<int>>(
1469271584abSEd Tanous                                                 chronoTimeStamp)
1470cb92c03bSAndrew Geissler                                                 .count();
1471cb92c03bSAndrew Geissler                             }
1472cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1473cb92c03bSAndrew Geissler                             {
1474cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1475cb92c03bSAndrew Geissler                                     &propertyMap.second);
1476cb92c03bSAndrew Geissler                                 if (severity == nullptr)
1477cb92c03bSAndrew Geissler                                 {
14780f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1479cb92c03bSAndrew Geissler                                 }
1480cb92c03bSAndrew Geissler                             }
1481cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1482cb92c03bSAndrew Geissler                             {
1483cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1484cb92c03bSAndrew Geissler                                     &propertyMap.second);
1485cb92c03bSAndrew Geissler                                 if (message == nullptr)
1486cb92c03bSAndrew Geissler                                 {
14870f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1488cb92c03bSAndrew Geissler                                 }
1489cb92c03bSAndrew Geissler                             }
1490cb92c03bSAndrew Geissler                         }
1491cb92c03bSAndrew Geissler                         thisEntry = {
1492cb92c03bSAndrew Geissler                             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1493cb92c03bSAndrew Geissler                             {"@odata.id",
1494cb92c03bSAndrew Geissler                              "/redfish/v1/Systems/system/LogServices/EventLog/"
1495cb92c03bSAndrew Geissler                              "Entries/" +
1496cb92c03bSAndrew Geissler                                  std::to_string(*id)},
149727062605SAnthony Wilson                             {"Name", "System Event Log Entry"},
1498cb92c03bSAndrew Geissler                             {"Id", std::to_string(*id)},
1499cb92c03bSAndrew Geissler                             {"Message", *message},
1500cb92c03bSAndrew Geissler                             {"EntryType", "Event"},
1501cb92c03bSAndrew Geissler                             {"Severity",
1502cb92c03bSAndrew Geissler                              translateSeverityDbusToRedfish(*severity)},
1503cb92c03bSAndrew Geissler                             {"Created", crow::utility::getDateTime(timestamp)}};
1504cb92c03bSAndrew Geissler                     }
1505cb92c03bSAndrew Geissler                 }
1506cb92c03bSAndrew Geissler                 std::sort(entriesArray.begin(), entriesArray.end(),
1507cb92c03bSAndrew Geissler                           [](const nlohmann::json& left,
1508cb92c03bSAndrew Geissler                              const nlohmann::json& right) {
1509cb92c03bSAndrew Geissler                               return (left["Id"] <= right["Id"]);
1510cb92c03bSAndrew Geissler                           });
1511cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue["Members@odata.count"] =
1512cb92c03bSAndrew Geissler                     entriesArray.size();
1513cb92c03bSAndrew Geissler             },
1514cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
1515cb92c03bSAndrew Geissler             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1516c4bf6374SJason M. Bills     }
1517c4bf6374SJason M. Bills };
1518c4bf6374SJason M. Bills 
151908a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node
1520c4bf6374SJason M. Bills {
1521c4bf6374SJason M. Bills   public:
152208a4e4b5SAnthony Wilson     DBusEventLogEntry(CrowApp& app) :
1523c4bf6374SJason M. Bills         Node(app,
1524029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1525029573d4SEd Tanous              std::string())
1526c4bf6374SJason M. Bills     {
1527c4bf6374SJason M. Bills         entityPrivileges = {
1528c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1529c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1530c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1531c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1532c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1533c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1534c4bf6374SJason M. Bills     }
1535c4bf6374SJason M. Bills 
1536c4bf6374SJason M. Bills   private:
1537c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1538c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1539c4bf6374SJason M. Bills     {
1540c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1541029573d4SEd Tanous         if (params.size() != 1)
1542c4bf6374SJason M. Bills         {
1543c4bf6374SJason M. Bills             messages::internalError(asyncResp->res);
1544c4bf6374SJason M. Bills             return;
1545c4bf6374SJason M. Bills         }
1546029573d4SEd Tanous         const std::string& entryID = params[0];
1547cb92c03bSAndrew Geissler 
1548cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1549cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1550cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1551cb92c03bSAndrew Geissler             [asyncResp, entryID](const boost::system::error_code ec,
1552cb92c03bSAndrew Geissler                                  GetManagedPropertyType& resp) {
1553cb92c03bSAndrew Geissler                 if (ec)
1554cb92c03bSAndrew Geissler                 {
1555cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1556cb92c03bSAndrew Geissler                         << "EventLogEntry (DBus) resp_handler got error " << ec;
1557cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1558cb92c03bSAndrew Geissler                     return;
1559cb92c03bSAndrew Geissler                 }
156066664f25SEd Tanous                 uint32_t* id = nullptr;
156166664f25SEd Tanous                 std::time_t timestamp{};
156266664f25SEd Tanous                 std::string* severity = nullptr;
156366664f25SEd Tanous                 std::string* message = nullptr;
1564cb92c03bSAndrew Geissler                 for (auto& propertyMap : resp)
1565cb92c03bSAndrew Geissler                 {
1566cb92c03bSAndrew Geissler                     if (propertyMap.first == "Id")
1567cb92c03bSAndrew Geissler                     {
1568cb92c03bSAndrew Geissler                         id = std::get_if<uint32_t>(&propertyMap.second);
1569cb92c03bSAndrew Geissler                         if (id == nullptr)
1570cb92c03bSAndrew Geissler                         {
15710f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1572cb92c03bSAndrew Geissler                         }
1573cb92c03bSAndrew Geissler                     }
1574cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Timestamp")
1575cb92c03bSAndrew Geissler                     {
1576cb92c03bSAndrew Geissler                         const uint64_t* millisTimeStamp =
1577cb92c03bSAndrew Geissler                             std::get_if<uint64_t>(&propertyMap.second);
1578cb92c03bSAndrew Geissler                         if (millisTimeStamp == nullptr)
1579cb92c03bSAndrew Geissler                         {
15800f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1581271584abSEd Tanous                             continue;
1582cb92c03bSAndrew Geissler                         }
1583cb92c03bSAndrew Geissler                         // Retrieve Created property with format:
1584cb92c03bSAndrew Geissler                         // yyyy-mm-ddThh:mm:ss
1585cb92c03bSAndrew Geissler                         std::chrono::milliseconds chronoTimeStamp(
1586cb92c03bSAndrew Geissler                             *millisTimeStamp);
1587cb92c03bSAndrew Geissler                         timestamp =
1588271584abSEd Tanous                             std::chrono::duration_cast<
1589271584abSEd Tanous                                 std::chrono::duration<int>>(chronoTimeStamp)
1590cb92c03bSAndrew Geissler                                 .count();
1591cb92c03bSAndrew Geissler                     }
1592cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Severity")
1593cb92c03bSAndrew Geissler                     {
1594cb92c03bSAndrew Geissler                         severity =
1595cb92c03bSAndrew Geissler                             std::get_if<std::string>(&propertyMap.second);
1596cb92c03bSAndrew Geissler                         if (severity == nullptr)
1597cb92c03bSAndrew Geissler                         {
15980f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1599cb92c03bSAndrew Geissler                         }
1600cb92c03bSAndrew Geissler                     }
1601cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Message")
1602cb92c03bSAndrew Geissler                     {
1603cb92c03bSAndrew Geissler                         message = std::get_if<std::string>(&propertyMap.second);
1604cb92c03bSAndrew Geissler                         if (message == nullptr)
1605cb92c03bSAndrew Geissler                         {
16060f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1607cb92c03bSAndrew Geissler                         }
1608cb92c03bSAndrew Geissler                     }
1609cb92c03bSAndrew Geissler                 }
1610271584abSEd Tanous                 if (id == nullptr || message == nullptr || severity == nullptr)
1611271584abSEd Tanous                 {
1612271584abSEd Tanous                     return;
1613271584abSEd Tanous                 }
1614cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue = {
1615cb92c03bSAndrew Geissler                     {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1616cb92c03bSAndrew Geissler                     {"@odata.id",
1617cb92c03bSAndrew Geissler                      "/redfish/v1/Systems/system/LogServices/EventLog/"
1618cb92c03bSAndrew Geissler                      "Entries/" +
1619cb92c03bSAndrew Geissler                          std::to_string(*id)},
162027062605SAnthony Wilson                     {"Name", "System Event Log Entry"},
1621cb92c03bSAndrew Geissler                     {"Id", std::to_string(*id)},
1622cb92c03bSAndrew Geissler                     {"Message", *message},
1623cb92c03bSAndrew Geissler                     {"EntryType", "Event"},
1624cb92c03bSAndrew Geissler                     {"Severity", translateSeverityDbusToRedfish(*severity)},
162508a4e4b5SAnthony Wilson                     {"Created", crow::utility::getDateTime(timestamp)}};
1626cb92c03bSAndrew Geissler             },
1627cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging",
1628cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging/entry/" + entryID,
1629cb92c03bSAndrew Geissler             "org.freedesktop.DBus.Properties", "GetAll",
1630cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging.Entry");
1631c4bf6374SJason M. Bills     }
1632336e96c6SChicago Duan 
1633336e96c6SChicago Duan     void doDelete(crow::Response& res, const crow::Request& req,
1634336e96c6SChicago Duan                   const std::vector<std::string>& params) override
1635336e96c6SChicago Duan     {
1636336e96c6SChicago Duan 
1637336e96c6SChicago Duan         BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1638336e96c6SChicago Duan 
1639336e96c6SChicago Duan         auto asyncResp = std::make_shared<AsyncResp>(res);
1640336e96c6SChicago Duan 
1641336e96c6SChicago Duan         if (params.size() != 1)
1642336e96c6SChicago Duan         {
1643336e96c6SChicago Duan             messages::internalError(asyncResp->res);
1644336e96c6SChicago Duan             return;
1645336e96c6SChicago Duan         }
1646336e96c6SChicago Duan         std::string entryID = params[0];
1647336e96c6SChicago Duan 
1648336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
1649336e96c6SChicago Duan 
1650336e96c6SChicago Duan         // Process response from Logging service.
1651336e96c6SChicago Duan         auto respHandler = [asyncResp](const boost::system::error_code ec) {
1652336e96c6SChicago Duan             BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1653336e96c6SChicago Duan             if (ec)
1654336e96c6SChicago Duan             {
1655336e96c6SChicago Duan                 // TODO Handle for specific error code
1656336e96c6SChicago Duan                 BMCWEB_LOG_ERROR
1657336e96c6SChicago Duan                     << "EventLogEntry (DBus) doDelete respHandler got error "
1658336e96c6SChicago Duan                     << ec;
1659336e96c6SChicago Duan                 asyncResp->res.result(
1660336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
1661336e96c6SChicago Duan                 return;
1662336e96c6SChicago Duan             }
1663336e96c6SChicago Duan 
1664336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
1665336e96c6SChicago Duan         };
1666336e96c6SChicago Duan 
1667336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
1668336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
1669336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
1670336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
1671336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
1672336e96c6SChicago Duan     }
1673c4bf6374SJason M. Bills };
1674c4bf6374SJason M. Bills 
1675c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node
1676c4bf6374SJason M. Bills {
1677c4bf6374SJason M. Bills   public:
1678c4bf6374SJason M. Bills     template <typename CrowApp>
1679c4bf6374SJason M. Bills     BMCLogServiceCollection(CrowApp& app) :
16804ed77cd5SEd Tanous         Node(app, "/redfish/v1/Managers/bmc/LogServices/")
16811da66f75SEd Tanous     {
16821da66f75SEd Tanous         entityPrivileges = {
1683e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1684e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1685e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1686e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1687e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1688e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
16891da66f75SEd Tanous     }
16901da66f75SEd Tanous 
16911da66f75SEd Tanous   private:
16921da66f75SEd Tanous     /**
16931da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
16941da66f75SEd Tanous      */
16951da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
16961da66f75SEd Tanous                const std::vector<std::string>& params) override
16971da66f75SEd Tanous     {
1698e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
16991da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
17001da66f75SEd Tanous         // it has a duplicate entry for members
1701e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
17021da66f75SEd Tanous             "#LogServiceCollection.LogServiceCollection";
1703e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1704e1f26343SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices";
1705e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1706e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
17071da66f75SEd Tanous             "Collection of LogServices for this Manager";
1708c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1709c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
17105cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
17115cb1dd27SAsmitha Karunanithi         logServiceArray.push_back(
17125cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}});
17135cb1dd27SAsmitha Karunanithi #endif
1714c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1715c4bf6374SJason M. Bills         logServiceArray.push_back(
171608a4e4b5SAnthony Wilson             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1717c4bf6374SJason M. Bills #endif
1718e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
1719c4bf6374SJason M. Bills             logServiceArray.size();
17201da66f75SEd Tanous     }
17211da66f75SEd Tanous };
17221da66f75SEd Tanous 
1723c4bf6374SJason M. Bills class BMCJournalLogService : public Node
17241da66f75SEd Tanous {
17251da66f75SEd Tanous   public:
17261da66f75SEd Tanous     template <typename CrowApp>
1727c4bf6374SJason M. Bills     BMCJournalLogService(CrowApp& app) :
1728c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1729e1f26343SJason M. Bills     {
1730e1f26343SJason M. Bills         entityPrivileges = {
1731e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1732e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1733e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1734e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1735e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1736e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1737e1f26343SJason M. Bills     }
1738e1f26343SJason M. Bills 
1739e1f26343SJason M. Bills   private:
1740e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1741e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1742e1f26343SJason M. Bills     {
1743e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1744e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1745e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
17460f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
17470f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
1748c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
1749c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
1750c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "BMC Journal";
1751e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1752cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1753cd50aa42SJason M. Bills             {"@odata.id",
1754086be238SEd Tanous              "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
1755e1f26343SJason M. Bills     }
1756e1f26343SJason M. Bills };
1757e1f26343SJason M. Bills 
1758c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1759e1f26343SJason M. Bills                                       sd_journal* journal,
1760c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
1761e1f26343SJason M. Bills {
1762e1f26343SJason M. Bills     // Get the Log Entry contents
1763e1f26343SJason M. Bills     int ret = 0;
1764e1f26343SJason M. Bills 
176539e77504SEd Tanous     std::string_view msg;
176616428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1767e1f26343SJason M. Bills     if (ret < 0)
1768e1f26343SJason M. Bills     {
1769e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1770e1f26343SJason M. Bills         return 1;
1771e1f26343SJason M. Bills     }
1772e1f26343SJason M. Bills 
1773e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1774271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
177516428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1776e1f26343SJason M. Bills     if (ret < 0)
1777e1f26343SJason M. Bills     {
1778e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
1779e1f26343SJason M. Bills     }
1780e1f26343SJason M. Bills 
1781e1f26343SJason M. Bills     // Get the Created time from the timestamp
178216428a1aSJason M. Bills     std::string entryTimeStr;
178316428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
1784e1f26343SJason M. Bills     {
178516428a1aSJason M. Bills         return 1;
1786e1f26343SJason M. Bills     }
1787e1f26343SJason M. Bills 
1788e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
1789c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
1790cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1791c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1792c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
1793e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
1794c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
179516428a1aSJason M. Bills         {"Message", msg},
1796e1f26343SJason M. Bills         {"EntryType", "Oem"},
1797e1f26343SJason M. Bills         {"Severity",
1798b6a61a5eSJason M. Bills          severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"},
1799086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
1800e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
1801e1f26343SJason M. Bills     return 0;
1802e1f26343SJason M. Bills }
1803e1f26343SJason M. Bills 
1804c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node
1805e1f26343SJason M. Bills {
1806e1f26343SJason M. Bills   public:
1807e1f26343SJason M. Bills     template <typename CrowApp>
1808c4bf6374SJason M. Bills     BMCJournalLogEntryCollection(CrowApp& app) :
1809c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
1810e1f26343SJason M. Bills     {
1811e1f26343SJason M. Bills         entityPrivileges = {
1812e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1813e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1814e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1815e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1816e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1817e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1818e1f26343SJason M. Bills     }
1819e1f26343SJason M. Bills 
1820e1f26343SJason M. Bills   private:
1821e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1822e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1823e1f26343SJason M. Bills     {
1824e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1825193ad2faSJason M. Bills         static constexpr const long maxEntriesPerPage = 1000;
1826271584abSEd Tanous         uint64_t skip = 0;
1827271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
182816428a1aSJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1829193ad2faSJason M. Bills         {
1830193ad2faSJason M. Bills             return;
1831193ad2faSJason M. Bills         }
183216428a1aSJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1833193ad2faSJason M. Bills         {
1834193ad2faSJason M. Bills             return;
1835193ad2faSJason M. Bills         }
1836e1f26343SJason M. Bills         // Collections don't include the static data added by SubRoute because
1837e1f26343SJason M. Bills         // it has a duplicate entry for members
1838e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1839e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
18400f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
18410f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1842e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1843c4bf6374SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1844e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1845e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1846e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
18470f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
18480f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries";
1849e1f26343SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1850e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
1851e1f26343SJason M. Bills 
1852e1f26343SJason M. Bills         // Go through the journal and use the timestamp to create a unique ID
1853e1f26343SJason M. Bills         // for each entry
1854e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1855e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1856e1f26343SJason M. Bills         if (ret < 0)
1857e1f26343SJason M. Bills         {
1858e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1859f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1860e1f26343SJason M. Bills             return;
1861e1f26343SJason M. Bills         }
1862e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1863e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1864e1f26343SJason M. Bills         journalTmp = nullptr;
1865b01bf299SEd Tanous         uint64_t entryCount = 0;
1866e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
1867e85d6b16SJason M. Bills         bool firstEntry = true;
1868e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
1869e1f26343SJason M. Bills         {
1870193ad2faSJason M. Bills             entryCount++;
1871193ad2faSJason M. Bills             // Handle paging using skip (number of entries to skip from the
1872193ad2faSJason M. Bills             // start) and top (number of entries to display)
1873193ad2faSJason M. Bills             if (entryCount <= skip || entryCount > skip + top)
1874193ad2faSJason M. Bills             {
1875193ad2faSJason M. Bills                 continue;
1876193ad2faSJason M. Bills             }
1877193ad2faSJason M. Bills 
187816428a1aSJason M. Bills             std::string idStr;
1879e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1880e1f26343SJason M. Bills             {
1881e1f26343SJason M. Bills                 continue;
1882e1f26343SJason M. Bills             }
1883e1f26343SJason M. Bills 
1884e85d6b16SJason M. Bills             if (firstEntry)
1885e85d6b16SJason M. Bills             {
1886e85d6b16SJason M. Bills                 firstEntry = false;
1887e85d6b16SJason M. Bills             }
1888e85d6b16SJason M. Bills 
1889e1f26343SJason M. Bills             logEntryArray.push_back({});
1890c4bf6374SJason M. Bills             nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
1891c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
1892c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
1893e1f26343SJason M. Bills             {
1894f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
1895e1f26343SJason M. Bills                 return;
1896e1f26343SJason M. Bills             }
1897e1f26343SJason M. Bills         }
1898193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1899193ad2faSJason M. Bills         if (skip + top < entryCount)
1900193ad2faSJason M. Bills         {
1901193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
1902c4bf6374SJason M. Bills                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
1903193ad2faSJason M. Bills                 std::to_string(skip + top);
1904193ad2faSJason M. Bills         }
1905e1f26343SJason M. Bills     }
1906e1f26343SJason M. Bills };
1907e1f26343SJason M. Bills 
1908c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node
1909e1f26343SJason M. Bills {
1910e1f26343SJason M. Bills   public:
1911c4bf6374SJason M. Bills     BMCJournalLogEntry(CrowApp& app) :
1912c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/",
1913e1f26343SJason M. Bills              std::string())
1914e1f26343SJason M. Bills     {
1915e1f26343SJason M. Bills         entityPrivileges = {
1916e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1917e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1918e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1919e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1920e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1921e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1922e1f26343SJason M. Bills     }
1923e1f26343SJason M. Bills 
1924e1f26343SJason M. Bills   private:
1925e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1926e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1927e1f26343SJason M. Bills     {
1928e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1929e1f26343SJason M. Bills         if (params.size() != 1)
1930e1f26343SJason M. Bills         {
1931f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1932e1f26343SJason M. Bills             return;
1933e1f26343SJason M. Bills         }
193416428a1aSJason M. Bills         const std::string& entryID = params[0];
1935e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
1936e1f26343SJason M. Bills         uint64_t ts = 0;
1937271584abSEd Tanous         uint64_t index = 0;
193816428a1aSJason M. Bills         if (!getTimestampFromID(asyncResp->res, entryID, ts, index))
1939e1f26343SJason M. Bills         {
194016428a1aSJason M. Bills             return;
1941e1f26343SJason M. Bills         }
1942e1f26343SJason M. Bills 
1943e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1944e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1945e1f26343SJason M. Bills         if (ret < 0)
1946e1f26343SJason M. Bills         {
1947e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1948f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1949e1f26343SJason M. Bills             return;
1950e1f26343SJason M. Bills         }
1951e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1952e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1953e1f26343SJason M. Bills         journalTmp = nullptr;
1954e1f26343SJason M. Bills         // Go to the timestamp in the log and move to the entry at the index
1955af07e3f5SJason M. Bills         // tracking the unique ID
1956af07e3f5SJason M. Bills         std::string idStr;
1957af07e3f5SJason M. Bills         bool firstEntry = true;
1958e1f26343SJason M. Bills         ret = sd_journal_seek_realtime_usec(journal.get(), ts);
19592056b6d1SManojkiran Eda         if (ret < 0)
19602056b6d1SManojkiran Eda         {
19612056b6d1SManojkiran Eda             BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
19622056b6d1SManojkiran Eda                              << strerror(-ret);
19632056b6d1SManojkiran Eda             messages::internalError(asyncResp->res);
19642056b6d1SManojkiran Eda             return;
19652056b6d1SManojkiran Eda         }
1966271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
1967e1f26343SJason M. Bills         {
1968e1f26343SJason M. Bills             sd_journal_next(journal.get());
1969af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1970af07e3f5SJason M. Bills             {
1971af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
1972af07e3f5SJason M. Bills                 return;
1973af07e3f5SJason M. Bills             }
1974af07e3f5SJason M. Bills             if (firstEntry)
1975af07e3f5SJason M. Bills             {
1976af07e3f5SJason M. Bills                 firstEntry = false;
1977af07e3f5SJason M. Bills             }
1978e1f26343SJason M. Bills         }
1979c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
1980af07e3f5SJason M. Bills         if (idStr != entryID)
1981c4bf6374SJason M. Bills         {
1982c4bf6374SJason M. Bills             messages::resourceMissingAtURI(asyncResp->res, entryID);
1983c4bf6374SJason M. Bills             return;
1984c4bf6374SJason M. Bills         }
1985c4bf6374SJason M. Bills 
1986c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
1987e1f26343SJason M. Bills                                        asyncResp->res.jsonValue) != 0)
1988e1f26343SJason M. Bills         {
1989f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1990e1f26343SJason M. Bills             return;
1991e1f26343SJason M. Bills         }
1992e1f26343SJason M. Bills     }
1993e1f26343SJason M. Bills };
1994e1f26343SJason M. Bills 
19955cb1dd27SAsmitha Karunanithi class BMCDumpService : public Node
1996c9bb6861Sraviteja-b {
1997c9bb6861Sraviteja-b   public:
1998c9bb6861Sraviteja-b     template <typename CrowApp>
19995cb1dd27SAsmitha Karunanithi     BMCDumpService(CrowApp& app) :
20005cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2001c9bb6861Sraviteja-b     {
2002c9bb6861Sraviteja-b         entityPrivileges = {
2003c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2004c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2005c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2006c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2007c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2008c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2009c9bb6861Sraviteja-b     }
2010c9bb6861Sraviteja-b 
2011c9bb6861Sraviteja-b   private:
2012c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
2013c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2014c9bb6861Sraviteja-b     {
2015c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2016c9bb6861Sraviteja-b 
2017c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
20185cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump";
2019c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2020c9bb6861Sraviteja-b             "#LogService.v1_1_0.LogService";
2021c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "Dump LogService";
20225cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
20235cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
2024c9bb6861Sraviteja-b         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2025c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Entries"] = {
20265cb1dd27SAsmitha Karunanithi             {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
20275cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
20285cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
20295cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
20305cb1dd27SAsmitha Karunanithi                          "Actions/LogService.ClearLog"}}},
20315cb1dd27SAsmitha Karunanithi             {"Oem",
20325cb1dd27SAsmitha Karunanithi              {{"#OemLogService.CollectDiagnosticData",
20335cb1dd27SAsmitha Karunanithi                {{"target",
20345cb1dd27SAsmitha Karunanithi                  "/redfish/v1/Managers/bmc/LogServices/Dump/"
20355cb1dd27SAsmitha Karunanithi                  "Actions/Oem/OemLogService.CollectDiagnosticData"}}}}}};
2036c9bb6861Sraviteja-b     }
2037c9bb6861Sraviteja-b };
2038c9bb6861Sraviteja-b 
20395cb1dd27SAsmitha Karunanithi class BMCDumpEntryCollection : public Node
2040c9bb6861Sraviteja-b {
2041c9bb6861Sraviteja-b   public:
2042c9bb6861Sraviteja-b     template <typename CrowApp>
20435cb1dd27SAsmitha Karunanithi     BMCDumpEntryCollection(CrowApp& app) :
20445cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2045c9bb6861Sraviteja-b     {
2046c9bb6861Sraviteja-b         entityPrivileges = {
2047c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2048c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2049c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2050c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2051c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2052c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2053c9bb6861Sraviteja-b     }
2054c9bb6861Sraviteja-b 
2055c9bb6861Sraviteja-b   private:
2056c9bb6861Sraviteja-b     /**
2057c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
2058c9bb6861Sraviteja-b      */
2059c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
2060c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2061c9bb6861Sraviteja-b     {
2062c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2063c9bb6861Sraviteja-b 
2064c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2065c9bb6861Sraviteja-b             "#LogEntryCollection.LogEntryCollection";
2066c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
20675cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
20685cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
2069c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] =
20705cb1dd27SAsmitha Karunanithi             "Collection of BMC Dump Entries";
2071c9bb6861Sraviteja-b 
20725cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "BMC");
2073c9bb6861Sraviteja-b     }
2074c9bb6861Sraviteja-b };
2075c9bb6861Sraviteja-b 
20765cb1dd27SAsmitha Karunanithi class BMCDumpEntry : public Node
2077c9bb6861Sraviteja-b {
2078c9bb6861Sraviteja-b   public:
20795cb1dd27SAsmitha Karunanithi     BMCDumpEntry(CrowApp& app) :
20805cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/",
2081c9bb6861Sraviteja-b              std::string())
2082c9bb6861Sraviteja-b     {
2083c9bb6861Sraviteja-b         entityPrivileges = {
2084c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2085c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2086c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2087c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2088c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2089c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2090c9bb6861Sraviteja-b     }
2091c9bb6861Sraviteja-b 
2092c9bb6861Sraviteja-b   private:
2093c9bb6861Sraviteja-b     void doGet(crow::Response& res, const crow::Request& req,
2094c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2095c9bb6861Sraviteja-b     {
2096c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2097c9bb6861Sraviteja-b         if (params.size() != 1)
2098c9bb6861Sraviteja-b         {
2099c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2100c9bb6861Sraviteja-b             return;
2101c9bb6861Sraviteja-b         }
21025cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "BMC");
2103c9bb6861Sraviteja-b     }
2104c9bb6861Sraviteja-b 
2105c9bb6861Sraviteja-b     void doDelete(crow::Response& res, const crow::Request& req,
2106c9bb6861Sraviteja-b                   const std::vector<std::string>& params) override
2107c9bb6861Sraviteja-b     {
21085cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2109c9bb6861Sraviteja-b         if (params.size() != 1)
2110c9bb6861Sraviteja-b         {
2111c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2112c9bb6861Sraviteja-b             return;
2113c9bb6861Sraviteja-b         }
21145cb1dd27SAsmitha Karunanithi         deleteDumpEntry(asyncResp->res, params[0]);
21155cb1dd27SAsmitha Karunanithi     }
21165cb1dd27SAsmitha Karunanithi };
2117c9bb6861Sraviteja-b 
2118a43be80fSAsmitha Karunanithi class BMCDumpCreate : public Node
2119a43be80fSAsmitha Karunanithi {
2120a43be80fSAsmitha Karunanithi   public:
2121a43be80fSAsmitha Karunanithi     BMCDumpCreate(CrowApp& app) :
2122a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2123a43be80fSAsmitha Karunanithi                   "Actions/Oem/"
2124a43be80fSAsmitha Karunanithi                   "OemLogService.CollectDiagnosticData/")
2125a43be80fSAsmitha Karunanithi     {
2126a43be80fSAsmitha Karunanithi         entityPrivileges = {
2127a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2128a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2129a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2130a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2131a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2132a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2133a43be80fSAsmitha Karunanithi     }
2134a43be80fSAsmitha Karunanithi 
2135a43be80fSAsmitha Karunanithi   private:
2136a43be80fSAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
2137a43be80fSAsmitha Karunanithi                 const std::vector<std::string>& params) override
2138a43be80fSAsmitha Karunanithi     {
2139a43be80fSAsmitha Karunanithi         createDump(res, req, "BMC");
2140a43be80fSAsmitha Karunanithi     }
2141a43be80fSAsmitha Karunanithi };
2142a43be80fSAsmitha Karunanithi 
2143*f71882ffSAsmitha Karunanithi class BMCDumpEntryDownload : public Node
2144*f71882ffSAsmitha Karunanithi {
2145*f71882ffSAsmitha Karunanithi   public:
2146*f71882ffSAsmitha Karunanithi     BMCDumpEntryDownload(CrowApp& app) :
2147*f71882ffSAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/attachment/<str>/",
2148*f71882ffSAsmitha Karunanithi              std::string())
2149*f71882ffSAsmitha Karunanithi     {
2150*f71882ffSAsmitha Karunanithi         entityPrivileges = {
2151*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2152*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2153*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2154*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2155*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2156*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2157*f71882ffSAsmitha Karunanithi     }
2158*f71882ffSAsmitha Karunanithi 
2159*f71882ffSAsmitha Karunanithi   private:
2160*f71882ffSAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
2161*f71882ffSAsmitha Karunanithi                const std::vector<std::string>& params) override
2162*f71882ffSAsmitha Karunanithi     {
2163*f71882ffSAsmitha Karunanithi         if (params.size() != 1)
2164*f71882ffSAsmitha Karunanithi         {
2165*f71882ffSAsmitha Karunanithi             messages::internalError(res);
2166*f71882ffSAsmitha Karunanithi             return;
2167*f71882ffSAsmitha Karunanithi         }
2168*f71882ffSAsmitha Karunanithi         const std::string& entryID = params[0];
2169*f71882ffSAsmitha Karunanithi         crow::obmc_dump::handleDumpOffloadUrl(req, res, entryID);
2170*f71882ffSAsmitha Karunanithi     }
2171*f71882ffSAsmitha Karunanithi };
2172*f71882ffSAsmitha Karunanithi 
217380319af1SAsmitha Karunanithi class BMCDumpClear : public Node
217480319af1SAsmitha Karunanithi {
217580319af1SAsmitha Karunanithi   public:
217680319af1SAsmitha Karunanithi     BMCDumpClear(CrowApp& app) :
217780319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
217880319af1SAsmitha Karunanithi                   "Actions/"
217980319af1SAsmitha Karunanithi                   "LogService.ClearLog/")
218080319af1SAsmitha Karunanithi     {
218180319af1SAsmitha Karunanithi         entityPrivileges = {
218280319af1SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
218380319af1SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
218480319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
218580319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
218680319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
218780319af1SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
218880319af1SAsmitha Karunanithi     }
218980319af1SAsmitha Karunanithi 
219080319af1SAsmitha Karunanithi   private:
219180319af1SAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
219280319af1SAsmitha Karunanithi                 const std::vector<std::string>& params) override
219380319af1SAsmitha Karunanithi     {
219480319af1SAsmitha Karunanithi         clearDump(res, "xyz.openbmc_project.Dump.Entry.BMC");
219580319af1SAsmitha Karunanithi     }
219680319af1SAsmitha Karunanithi };
219780319af1SAsmitha Karunanithi 
21985cb1dd27SAsmitha Karunanithi class SystemDumpService : public Node
2199c9bb6861Sraviteja-b {
22005cb1dd27SAsmitha Karunanithi   public:
22015cb1dd27SAsmitha Karunanithi     template <typename CrowApp>
22025cb1dd27SAsmitha Karunanithi     SystemDumpService(CrowApp& app) :
22035cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/")
22045cb1dd27SAsmitha Karunanithi     {
22055cb1dd27SAsmitha Karunanithi         entityPrivileges = {
22065cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22075cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22085cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22095cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22105cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22115cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22125cb1dd27SAsmitha Karunanithi     }
22135cb1dd27SAsmitha Karunanithi 
22145cb1dd27SAsmitha Karunanithi   private:
22155cb1dd27SAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
22165cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
22175cb1dd27SAsmitha Karunanithi     {
22185cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22195cb1dd27SAsmitha Karunanithi 
22205cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
22215cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump";
22225cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
22235cb1dd27SAsmitha Karunanithi             "#LogService.v1_1_0.LogService";
22245cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "Dump LogService";
22255cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "System Dump LogService";
22265cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
22275cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
22285cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Entries"] = {
22295cb1dd27SAsmitha Karunanithi             {"@odata.id",
22305cb1dd27SAsmitha Karunanithi              "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
22315cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
22325cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
22335cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
22345cb1dd27SAsmitha Karunanithi                          "LogService.ClearLog"}}},
22355cb1dd27SAsmitha Karunanithi             {"Oem",
22365cb1dd27SAsmitha Karunanithi              {{"#OemLogService.CollectDiagnosticData",
22375cb1dd27SAsmitha Karunanithi                {{"target",
22385cb1dd27SAsmitha Karunanithi                  "/redfish/v1/Systems/system/LogServices/Dump/Actions/Oem/"
22395cb1dd27SAsmitha Karunanithi                  "OemLogService.CollectDiagnosticData"}}}}}};
22405cb1dd27SAsmitha Karunanithi     }
22415cb1dd27SAsmitha Karunanithi };
22425cb1dd27SAsmitha Karunanithi 
22435cb1dd27SAsmitha Karunanithi class SystemDumpEntryCollection : public Node
22445cb1dd27SAsmitha Karunanithi {
22455cb1dd27SAsmitha Karunanithi   public:
22465cb1dd27SAsmitha Karunanithi     template <typename CrowApp>
22475cb1dd27SAsmitha Karunanithi     SystemDumpEntryCollection(CrowApp& app) :
22485cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
22495cb1dd27SAsmitha Karunanithi     {
22505cb1dd27SAsmitha Karunanithi         entityPrivileges = {
22515cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22525cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22535cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22545cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22555cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22565cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22575cb1dd27SAsmitha Karunanithi     }
22585cb1dd27SAsmitha Karunanithi 
22595cb1dd27SAsmitha Karunanithi   private:
22605cb1dd27SAsmitha Karunanithi     /**
22615cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
22625cb1dd27SAsmitha Karunanithi      */
22635cb1dd27SAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
22645cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
22655cb1dd27SAsmitha Karunanithi     {
22665cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22675cb1dd27SAsmitha Karunanithi 
22685cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
22695cb1dd27SAsmitha Karunanithi             "#LogEntryCollection.LogEntryCollection";
22705cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
22715cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump/Entries";
22725cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "System Dump Entries";
22735cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] =
22745cb1dd27SAsmitha Karunanithi             "Collection of System Dump Entries";
22755cb1dd27SAsmitha Karunanithi 
22765cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "System");
22775cb1dd27SAsmitha Karunanithi     }
22785cb1dd27SAsmitha Karunanithi };
22795cb1dd27SAsmitha Karunanithi 
22805cb1dd27SAsmitha Karunanithi class SystemDumpEntry : public Node
22815cb1dd27SAsmitha Karunanithi {
22825cb1dd27SAsmitha Karunanithi   public:
22835cb1dd27SAsmitha Karunanithi     SystemDumpEntry(CrowApp& app) :
22845cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/",
22855cb1dd27SAsmitha Karunanithi              std::string())
22865cb1dd27SAsmitha Karunanithi     {
22875cb1dd27SAsmitha Karunanithi         entityPrivileges = {
22885cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22895cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22905cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22915cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22925cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22935cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22945cb1dd27SAsmitha Karunanithi     }
22955cb1dd27SAsmitha Karunanithi 
22965cb1dd27SAsmitha Karunanithi   private:
22975cb1dd27SAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
22985cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
22995cb1dd27SAsmitha Karunanithi     {
23005cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
23015cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
23025cb1dd27SAsmitha Karunanithi         {
2303c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2304c9bb6861Sraviteja-b             return;
2305c9bb6861Sraviteja-b         }
23065cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "System");
23075cb1dd27SAsmitha Karunanithi     }
2308c9bb6861Sraviteja-b 
23095cb1dd27SAsmitha Karunanithi     void doDelete(crow::Response& res, const crow::Request& req,
23105cb1dd27SAsmitha Karunanithi                   const std::vector<std::string>& params) override
2311c9bb6861Sraviteja-b     {
23125cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
23135cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
2314c9bb6861Sraviteja-b         {
23155cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
2316c9bb6861Sraviteja-b             return;
2317c9bb6861Sraviteja-b         }
23185cb1dd27SAsmitha Karunanithi         deleteDumpEntry(asyncResp->res, params[0]);
2319c9bb6861Sraviteja-b     }
2320c9bb6861Sraviteja-b };
2321c9bb6861Sraviteja-b 
2322a43be80fSAsmitha Karunanithi class SystemDumpCreate : public Node
2323a43be80fSAsmitha Karunanithi {
2324a43be80fSAsmitha Karunanithi   public:
2325a43be80fSAsmitha Karunanithi     SystemDumpCreate(CrowApp& app) :
2326a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2327a43be80fSAsmitha Karunanithi                   "Actions/Oem/"
2328a43be80fSAsmitha Karunanithi                   "OemLogService.CollectDiagnosticData/")
2329a43be80fSAsmitha Karunanithi     {
2330a43be80fSAsmitha Karunanithi         entityPrivileges = {
2331a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2332a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2333a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2334a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2335a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2336a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2337a43be80fSAsmitha Karunanithi     }
2338a43be80fSAsmitha Karunanithi 
2339a43be80fSAsmitha Karunanithi   private:
2340a43be80fSAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
2341a43be80fSAsmitha Karunanithi                 const std::vector<std::string>& params) override
2342a43be80fSAsmitha Karunanithi     {
2343a43be80fSAsmitha Karunanithi         createDump(res, req, "System");
2344a43be80fSAsmitha Karunanithi     }
2345a43be80fSAsmitha Karunanithi };
2346a43be80fSAsmitha Karunanithi 
23470657843aSraviteja-b class SystemDumpEntryDownload : public Node
23480657843aSraviteja-b {
23490657843aSraviteja-b   public:
23500657843aSraviteja-b     SystemDumpEntryDownload(CrowApp& app) :
23510657843aSraviteja-b         Node(app,
2352*f71882ffSAsmitha Karunanithi              "/redfish/v1/Systems/system/LogServices/Dump/attachment/<str>/",
23530657843aSraviteja-b              std::string())
23540657843aSraviteja-b     {
23550657843aSraviteja-b         entityPrivileges = {
23560657843aSraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
23570657843aSraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2358*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2359*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2360*f71882ffSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
23610657843aSraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
23620657843aSraviteja-b     }
23630657843aSraviteja-b 
23640657843aSraviteja-b   private:
2365*f71882ffSAsmitha Karunanithi     void doGet(crow::Response& res, const crow::Request& req,
23660657843aSraviteja-b                const std::vector<std::string>& params) override
23670657843aSraviteja-b     {
23680657843aSraviteja-b         if (params.size() != 1)
23690657843aSraviteja-b         {
23700657843aSraviteja-b             messages::internalError(res);
23710657843aSraviteja-b             return;
23720657843aSraviteja-b         }
23730657843aSraviteja-b         const std::string& entryID = params[0];
23740657843aSraviteja-b         crow::obmc_dump::handleDumpOffloadUrl(req, res, entryID);
23750657843aSraviteja-b     }
23760657843aSraviteja-b };
23770657843aSraviteja-b 
2378013487e5Sraviteja-b class SystemDumpClear : public Node
2379013487e5Sraviteja-b {
2380013487e5Sraviteja-b   public:
2381013487e5Sraviteja-b     SystemDumpClear(CrowApp& app) :
238280319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2383013487e5Sraviteja-b                   "Actions/"
2384013487e5Sraviteja-b                   "LogService.ClearLog/")
2385013487e5Sraviteja-b     {
2386013487e5Sraviteja-b         entityPrivileges = {
2387013487e5Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2388013487e5Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
238980319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
239080319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
239180319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2392013487e5Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2393013487e5Sraviteja-b     }
2394013487e5Sraviteja-b 
2395013487e5Sraviteja-b   private:
2396013487e5Sraviteja-b     void doPost(crow::Response& res, const crow::Request& req,
2397013487e5Sraviteja-b                 const std::vector<std::string>& params) override
2398013487e5Sraviteja-b     {
239980319af1SAsmitha Karunanithi         clearDump(res, "xyz.openbmc_project.Dump.Entry.System");
2400013487e5Sraviteja-b     }
2401013487e5Sraviteja-b };
2402013487e5Sraviteja-b 
2403424c4176SJason M. Bills class CrashdumpService : public Node
2404e1f26343SJason M. Bills {
2405e1f26343SJason M. Bills   public:
2406e1f26343SJason M. Bills     template <typename CrowApp>
2407424c4176SJason M. Bills     CrashdumpService(CrowApp& app) :
2408424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
24091da66f75SEd Tanous     {
24103946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
24113946028dSAppaRao Puli         // method for security reasons.
24121da66f75SEd Tanous         entityPrivileges = {
24133946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
24143946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2415e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2416e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2417e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2418e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
24191da66f75SEd Tanous     }
24201da66f75SEd Tanous 
24211da66f75SEd Tanous   private:
24221da66f75SEd Tanous     /**
24231da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
24241da66f75SEd Tanous      */
24251da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
24261da66f75SEd Tanous                const std::vector<std::string>& params) override
24271da66f75SEd Tanous     {
2428e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
24291da66f75SEd Tanous         // Copy over the static data to include the entries added by SubRoute
24300f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
2431424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
2432e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2433e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
24344f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
24354f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
24364f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2437e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2438e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
2439cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
2440cd50aa42SJason M. Bills             {"@odata.id",
2441424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
2442e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"] = {
24435b61b5e8SJason M. Bills             {"#LogService.ClearLog",
24445b61b5e8SJason M. Bills              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
24455b61b5e8SJason M. Bills                          "Actions/LogService.ClearLog"}}},
24461da66f75SEd Tanous             {"Oem",
2447424c4176SJason M. Bills              {{"#Crashdump.OnDemand",
2448424c4176SJason M. Bills                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
24496eda7685SKenny L. Ku                            "Actions/Oem/Crashdump.OnDemand"}}},
24506eda7685SKenny L. Ku               {"#Crashdump.Telemetry",
24516eda7685SKenny L. Ku                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
24526eda7685SKenny L. Ku                            "Actions/Oem/Crashdump.Telemetry"}}}}}};
24531da66f75SEd Tanous 
24541da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI
2455e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"]["Oem"].push_back(
2456424c4176SJason M. Bills             {"#Crashdump.SendRawPeci",
245708a4e4b5SAnthony Wilson              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
2458424c4176SJason M. Bills                          "Actions/Oem/Crashdump.SendRawPeci"}}});
24591da66f75SEd Tanous #endif
24601da66f75SEd Tanous     }
24611da66f75SEd Tanous };
24621da66f75SEd Tanous 
24635b61b5e8SJason M. Bills class CrashdumpClear : public Node
24645b61b5e8SJason M. Bills {
24655b61b5e8SJason M. Bills   public:
24665b61b5e8SJason M. Bills     CrashdumpClear(CrowApp& app) :
24675b61b5e8SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
24685b61b5e8SJason M. Bills                   "LogService.ClearLog/")
24695b61b5e8SJason M. Bills     {
24703946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
24713946028dSAppaRao Puli         // method for security reasons.
24725b61b5e8SJason M. Bills         entityPrivileges = {
24733946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
24743946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
24755b61b5e8SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
24765b61b5e8SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
24775b61b5e8SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
24785b61b5e8SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
24795b61b5e8SJason M. Bills     }
24805b61b5e8SJason M. Bills 
24815b61b5e8SJason M. Bills   private:
24825b61b5e8SJason M. Bills     void doPost(crow::Response& res, const crow::Request& req,
24835b61b5e8SJason M. Bills                 const std::vector<std::string>& params) override
24845b61b5e8SJason M. Bills     {
24855b61b5e8SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
24865b61b5e8SJason M. Bills 
24875b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
24885b61b5e8SJason M. Bills             [asyncResp](const boost::system::error_code ec,
24895b61b5e8SJason M. Bills                         const std::string& resp) {
24905b61b5e8SJason M. Bills                 if (ec)
24915b61b5e8SJason M. Bills                 {
24925b61b5e8SJason M. Bills                     messages::internalError(asyncResp->res);
24935b61b5e8SJason M. Bills                     return;
24945b61b5e8SJason M. Bills                 }
24955b61b5e8SJason M. Bills                 messages::success(asyncResp->res);
24965b61b5e8SJason M. Bills             },
24975b61b5e8SJason M. Bills             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
24985b61b5e8SJason M. Bills     }
24995b61b5e8SJason M. Bills };
25005b61b5e8SJason M. Bills 
2501e855dd28SJason M. Bills static void logCrashdumpEntry(std::shared_ptr<AsyncResp> asyncResp,
2502e855dd28SJason M. Bills                               const std::string& logID,
2503e855dd28SJason M. Bills                               nlohmann::json& logEntryJson)
2504e855dd28SJason M. Bills {
2505043a0536SJohnathan Mantey     auto getStoredLogCallback =
2506043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2507e855dd28SJason M. Bills             const boost::system::error_code ec,
2508043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>>& params) {
2509e855dd28SJason M. Bills             if (ec)
2510e855dd28SJason M. Bills             {
2511e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
25121ddcf01aSJason M. Bills                 if (ec.value() ==
25131ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
25141ddcf01aSJason M. Bills                 {
2515043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2516043a0536SJohnathan Mantey                                                logID);
25171ddcf01aSJason M. Bills                 }
25181ddcf01aSJason M. Bills                 else
25191ddcf01aSJason M. Bills                 {
2520e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
25211ddcf01aSJason M. Bills                 }
2522e855dd28SJason M. Bills                 return;
2523e855dd28SJason M. Bills             }
2524043a0536SJohnathan Mantey 
2525043a0536SJohnathan Mantey             std::string timestamp{};
2526043a0536SJohnathan Mantey             std::string filename{};
2527043a0536SJohnathan Mantey             std::string logfile{};
2528043a0536SJohnathan Mantey             ParseCrashdumpParameters(params, filename, timestamp, logfile);
2529043a0536SJohnathan Mantey 
2530043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2531e855dd28SJason M. Bills             {
2532043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2533e855dd28SJason M. Bills                 return;
2534e855dd28SJason M. Bills             }
2535e855dd28SJason M. Bills 
2536043a0536SJohnathan Mantey             std::string crashdumpURI =
2537e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2538043a0536SJohnathan Mantey                 logID + "/" + filename;
2539043a0536SJohnathan Mantey             logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2540043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2541043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2542e855dd28SJason M. Bills                                               logID},
2543e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2544e855dd28SJason M. Bills                             {"Id", logID},
2545e855dd28SJason M. Bills                             {"EntryType", "Oem"},
2546e855dd28SJason M. Bills                             {"OemRecordFormat", "Crashdump URI"},
2547043a0536SJohnathan Mantey                             {"Message", std::move(crashdumpURI)},
2548043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2549e855dd28SJason M. Bills         };
2550e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
25515b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
25525b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2553043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2554e855dd28SJason M. Bills }
2555e855dd28SJason M. Bills 
2556424c4176SJason M. Bills class CrashdumpEntryCollection : public Node
25571da66f75SEd Tanous {
25581da66f75SEd Tanous   public:
25591da66f75SEd Tanous     template <typename CrowApp>
2560424c4176SJason M. Bills     CrashdumpEntryCollection(CrowApp& app) :
2561424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
25621da66f75SEd Tanous     {
25633946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
25643946028dSAppaRao Puli         // method for security reasons.
25651da66f75SEd Tanous         entityPrivileges = {
25663946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
25673946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2568e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2569e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2570e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2571e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
25721da66f75SEd Tanous     }
25731da66f75SEd Tanous 
25741da66f75SEd Tanous   private:
25751da66f75SEd Tanous     /**
25761da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
25771da66f75SEd Tanous      */
25781da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
25791da66f75SEd Tanous                const std::vector<std::string>& params) override
25801da66f75SEd Tanous     {
2581e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
25821da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
25831da66f75SEd Tanous         // it has a duplicate entry for members
2584e1f26343SJason M. Bills         auto getLogEntriesCallback = [asyncResp](
2585e1f26343SJason M. Bills                                          const boost::system::error_code ec,
25861da66f75SEd Tanous                                          const std::vector<std::string>& resp) {
25871da66f75SEd Tanous             if (ec)
25881da66f75SEd Tanous             {
25891da66f75SEd Tanous                 if (ec.value() !=
25901da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
25911da66f75SEd Tanous                 {
25921da66f75SEd Tanous                     BMCWEB_LOG_DEBUG << "failed to get entries ec: "
25931da66f75SEd Tanous                                      << ec.message();
2594f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
25951da66f75SEd Tanous                     return;
25961da66f75SEd Tanous                 }
25971da66f75SEd Tanous             }
2598e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
25991da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
26000f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2601424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2602424c4176SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2603e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2604424c4176SJason M. Bills                 "Collection of Crashdump Entries";
2605e1f26343SJason M. Bills             nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2606e1f26343SJason M. Bills             logEntryArray = nlohmann::json::array();
2607e855dd28SJason M. Bills             std::vector<std::string> logIDs;
2608e855dd28SJason M. Bills             // Get the list of log entries and build up an empty array big
2609e855dd28SJason M. Bills             // enough to hold them
26101da66f75SEd Tanous             for (const std::string& objpath : resp)
26111da66f75SEd Tanous             {
2612e855dd28SJason M. Bills                 // Get the log ID
26134ed77cd5SEd Tanous                 std::size_t lastPos = objpath.rfind("/");
2614e855dd28SJason M. Bills                 if (lastPos == std::string::npos)
26151da66f75SEd Tanous                 {
2616e855dd28SJason M. Bills                     continue;
26171da66f75SEd Tanous                 }
2618e855dd28SJason M. Bills                 logIDs.emplace_back(objpath.substr(lastPos + 1));
2619e855dd28SJason M. Bills 
2620e855dd28SJason M. Bills                 // Add a space for the log entry to the array
2621e855dd28SJason M. Bills                 logEntryArray.push_back({});
2622e855dd28SJason M. Bills             }
2623e855dd28SJason M. Bills             // Now go through and set up async calls to fill in the entries
2624e855dd28SJason M. Bills             size_t index = 0;
2625e855dd28SJason M. Bills             for (const std::string& logID : logIDs)
2626e855dd28SJason M. Bills             {
2627e855dd28SJason M. Bills                 // Add the log entry to the array
2628e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
26291da66f75SEd Tanous             }
2630e1f26343SJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
2631e1f26343SJason M. Bills                 logEntryArray.size();
26321da66f75SEd Tanous         };
26331da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
26341da66f75SEd Tanous             std::move(getLogEntriesCallback),
26351da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper",
26361da66f75SEd Tanous             "/xyz/openbmc_project/object_mapper",
26371da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
26385b61b5e8SJason M. Bills             std::array<const char*, 1>{crashdumpInterface});
26391da66f75SEd Tanous     }
26401da66f75SEd Tanous };
26411da66f75SEd Tanous 
2642424c4176SJason M. Bills class CrashdumpEntry : public Node
26431da66f75SEd Tanous {
26441da66f75SEd Tanous   public:
2645424c4176SJason M. Bills     CrashdumpEntry(CrowApp& app) :
2646d53dd41fSJason M. Bills         Node(app,
2647424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/",
26481da66f75SEd Tanous              std::string())
26491da66f75SEd Tanous     {
26503946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
26513946028dSAppaRao Puli         // method for security reasons.
26521da66f75SEd Tanous         entityPrivileges = {
26533946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
26543946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2655e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2656e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2657e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2658e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
26591da66f75SEd Tanous     }
26601da66f75SEd Tanous 
26611da66f75SEd Tanous   private:
26621da66f75SEd Tanous     void doGet(crow::Response& res, const crow::Request& req,
26631da66f75SEd Tanous                const std::vector<std::string>& params) override
26641da66f75SEd Tanous     {
2665e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
26661da66f75SEd Tanous         if (params.size() != 1)
26671da66f75SEd Tanous         {
2668f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
26691da66f75SEd Tanous             return;
26701da66f75SEd Tanous         }
2671e855dd28SJason M. Bills         const std::string& logID = params[0];
2672e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
2673e855dd28SJason M. Bills     }
2674e855dd28SJason M. Bills };
2675e855dd28SJason M. Bills 
2676e855dd28SJason M. Bills class CrashdumpFile : public Node
2677e855dd28SJason M. Bills {
2678e855dd28SJason M. Bills   public:
2679e855dd28SJason M. Bills     CrashdumpFile(CrowApp& app) :
2680e855dd28SJason M. Bills         Node(app,
2681e855dd28SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/"
2682e855dd28SJason M. Bills              "<str>/",
2683e855dd28SJason M. Bills              std::string(), std::string())
2684e855dd28SJason M. Bills     {
26853946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
26863946028dSAppaRao Puli         // method for security reasons.
2687e855dd28SJason M. Bills         entityPrivileges = {
26883946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
26893946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2690e855dd28SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2691e855dd28SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2692e855dd28SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2693e855dd28SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2694e855dd28SJason M. Bills     }
2695e855dd28SJason M. Bills 
2696e855dd28SJason M. Bills   private:
2697e855dd28SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
2698e855dd28SJason M. Bills                const std::vector<std::string>& params) override
2699e855dd28SJason M. Bills     {
2700e855dd28SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2701e855dd28SJason M. Bills         if (params.size() != 2)
2702e855dd28SJason M. Bills         {
2703e855dd28SJason M. Bills             messages::internalError(asyncResp->res);
2704e855dd28SJason M. Bills             return;
2705e855dd28SJason M. Bills         }
2706e855dd28SJason M. Bills         const std::string& logID = params[0];
2707e855dd28SJason M. Bills         const std::string& fileName = params[1];
2708e855dd28SJason M. Bills 
2709043a0536SJohnathan Mantey         auto getStoredLogCallback =
2710043a0536SJohnathan Mantey             [asyncResp, logID, fileName](
2711abf2add6SEd Tanous                 const boost::system::error_code ec,
2712043a0536SJohnathan Mantey                 const std::vector<std::pair<std::string, VariantType>>& resp) {
27131da66f75SEd Tanous                 if (ec)
27141da66f75SEd Tanous                 {
2715043a0536SJohnathan Mantey                     BMCWEB_LOG_DEBUG << "failed to get log ec: "
2716043a0536SJohnathan Mantey                                      << ec.message();
2717f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
27181da66f75SEd Tanous                     return;
27191da66f75SEd Tanous                 }
2720e855dd28SJason M. Bills 
2721043a0536SJohnathan Mantey                 std::string dbusFilename{};
2722043a0536SJohnathan Mantey                 std::string dbusTimestamp{};
2723043a0536SJohnathan Mantey                 std::string dbusFilepath{};
2724043a0536SJohnathan Mantey 
2725043a0536SJohnathan Mantey                 ParseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
2726043a0536SJohnathan Mantey                                          dbusFilepath);
2727043a0536SJohnathan Mantey 
2728043a0536SJohnathan Mantey                 if (dbusFilename.empty() || dbusTimestamp.empty() ||
2729043a0536SJohnathan Mantey                     dbusFilepath.empty())
27301da66f75SEd Tanous                 {
2731e855dd28SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, fileName);
27321da66f75SEd Tanous                     return;
27331da66f75SEd Tanous                 }
2734e855dd28SJason M. Bills 
2735043a0536SJohnathan Mantey                 // Verify the file name parameter is correct
2736043a0536SJohnathan Mantey                 if (fileName != dbusFilename)
2737043a0536SJohnathan Mantey                 {
2738043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2739043a0536SJohnathan Mantey                     return;
2740043a0536SJohnathan Mantey                 }
2741043a0536SJohnathan Mantey 
2742043a0536SJohnathan Mantey                 if (!std::filesystem::exists(dbusFilepath))
2743043a0536SJohnathan Mantey                 {
2744043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2745043a0536SJohnathan Mantey                     return;
2746043a0536SJohnathan Mantey                 }
2747043a0536SJohnathan Mantey                 std::ifstream ifs(dbusFilepath, std::ios::in |
2748043a0536SJohnathan Mantey                                                     std::ios::binary |
2749043a0536SJohnathan Mantey                                                     std::ios::ate);
2750043a0536SJohnathan Mantey                 std::ifstream::pos_type fileSize = ifs.tellg();
2751043a0536SJohnathan Mantey                 if (fileSize < 0)
2752043a0536SJohnathan Mantey                 {
2753043a0536SJohnathan Mantey                     messages::generalError(asyncResp->res);
2754043a0536SJohnathan Mantey                     return;
2755043a0536SJohnathan Mantey                 }
2756043a0536SJohnathan Mantey                 ifs.seekg(0, std::ios::beg);
2757043a0536SJohnathan Mantey 
2758043a0536SJohnathan Mantey                 auto crashData = std::make_unique<char[]>(
2759043a0536SJohnathan Mantey                     static_cast<unsigned int>(fileSize));
2760043a0536SJohnathan Mantey 
2761043a0536SJohnathan Mantey                 ifs.read(crashData.get(), static_cast<int>(fileSize));
2762043a0536SJohnathan Mantey 
2763043a0536SJohnathan Mantey                 // The cast to std::string is intentional in order to use the
2764043a0536SJohnathan Mantey                 // assign() that applies move mechanics
2765043a0536SJohnathan Mantey                 asyncResp->res.body().assign(
2766043a0536SJohnathan Mantey                     static_cast<std::string>(crashData.get()));
2767043a0536SJohnathan Mantey 
2768043a0536SJohnathan Mantey                 // Configure this to be a file download when accessed from
2769043a0536SJohnathan Mantey                 // a browser
2770e855dd28SJason M. Bills                 asyncResp->res.addHeader("Content-Disposition", "attachment");
27711da66f75SEd Tanous             };
27721da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
27735b61b5e8SJason M. Bills             std::move(getStoredLogCallback), crashdumpObject,
27745b61b5e8SJason M. Bills             crashdumpPath + std::string("/") + logID,
2775043a0536SJohnathan Mantey             "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
27761da66f75SEd Tanous     }
27771da66f75SEd Tanous };
27781da66f75SEd Tanous 
2779424c4176SJason M. Bills class OnDemandCrashdump : public Node
27801da66f75SEd Tanous {
27811da66f75SEd Tanous   public:
2782424c4176SJason M. Bills     OnDemandCrashdump(CrowApp& app) :
2783424c4176SJason M. Bills         Node(app,
2784424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2785424c4176SJason M. Bills              "Crashdump.OnDemand/")
27861da66f75SEd Tanous     {
27873946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
27883946028dSAppaRao Puli         // method for security reasons.
27891da66f75SEd Tanous         entityPrivileges = {
27903946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
27913946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
27923946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
27933946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
27943946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
27953946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
27961da66f75SEd Tanous     }
27971da66f75SEd Tanous 
27981da66f75SEd Tanous   private:
27991da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
28001da66f75SEd Tanous                 const std::vector<std::string>& params) override
28011da66f75SEd Tanous     {
2802e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
28031da66f75SEd Tanous 
2804fe306728SJames Feist         auto generateonDemandLogCallback = [asyncResp,
2805fe306728SJames Feist                                             req](const boost::system::error_code
280646229577SJames Feist                                                      ec,
28071da66f75SEd Tanous                                                  const std::string& resp) {
28081da66f75SEd Tanous             if (ec)
28091da66f75SEd Tanous             {
281046229577SJames Feist                 if (ec.value() == boost::system::errc::operation_not_supported)
28111da66f75SEd Tanous                 {
2812f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
28131da66f75SEd Tanous                 }
28144363d3b2SJason M. Bills                 else if (ec.value() ==
28154363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
28164363d3b2SJason M. Bills                 {
28174363d3b2SJason M. Bills                     messages::serviceTemporarilyUnavailable(asyncResp->res,
28184363d3b2SJason M. Bills                                                             "60");
28194363d3b2SJason M. Bills                 }
28201da66f75SEd Tanous                 else
28211da66f75SEd Tanous                 {
2822f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
28231da66f75SEd Tanous                 }
28241da66f75SEd Tanous                 return;
28251da66f75SEd Tanous             }
282646229577SJames Feist             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
282766afe4faSJames Feist                 [](boost::system::error_code err, sdbusplus::message::message&,
282866afe4faSJames Feist                    const std::shared_ptr<task::TaskData>& taskData) {
282966afe4faSJames Feist                     if (!err)
283066afe4faSJames Feist                     {
2831e5d5006bSJames Feist                         taskData->messages.emplace_back(
2832e5d5006bSJames Feist                             messages::taskCompletedOK(
2833e5d5006bSJames Feist                                 std::to_string(taskData->index)));
2834831d6b09SJames Feist                         taskData->state = "Completed";
283566afe4faSJames Feist                     }
283632898ceaSJames Feist                     return task::completed;
283766afe4faSJames Feist                 },
283846229577SJames Feist                 "type='signal',interface='org.freedesktop.DBus.Properties',"
283946229577SJames Feist                 "member='PropertiesChanged',arg0namespace='com.intel."
284046229577SJames Feist                 "crashdump'");
284146229577SJames Feist             task->startTimer(std::chrono::minutes(5));
284246229577SJames Feist             task->populateResp(asyncResp->res);
2843fe306728SJames Feist             task->payload.emplace(req);
28441da66f75SEd Tanous         };
28451da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
28465b61b5e8SJason M. Bills             std::move(generateonDemandLogCallback), crashdumpObject,
28475b61b5e8SJason M. Bills             crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog");
28481da66f75SEd Tanous     }
28491da66f75SEd Tanous };
28501da66f75SEd Tanous 
28516eda7685SKenny L. Ku class TelemetryCrashdump : public Node
28526eda7685SKenny L. Ku {
28536eda7685SKenny L. Ku   public:
28546eda7685SKenny L. Ku     TelemetryCrashdump(CrowApp& app) :
28556eda7685SKenny L. Ku         Node(app,
28566eda7685SKenny L. Ku              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
28576eda7685SKenny L. Ku              "Crashdump.Telemetry/")
28586eda7685SKenny L. Ku     {
28596eda7685SKenny L. Ku         // Note: Deviated from redfish privilege registry for GET & HEAD
28606eda7685SKenny L. Ku         // method for security reasons.
28616eda7685SKenny L. Ku         entityPrivileges = {
28626eda7685SKenny L. Ku             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
28636eda7685SKenny L. Ku             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
28646eda7685SKenny L. Ku             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
28656eda7685SKenny L. Ku             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
28666eda7685SKenny L. Ku             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
28676eda7685SKenny L. Ku             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
28686eda7685SKenny L. Ku     }
28696eda7685SKenny L. Ku 
28706eda7685SKenny L. Ku   private:
28716eda7685SKenny L. Ku     void doPost(crow::Response& res, const crow::Request& req,
28726eda7685SKenny L. Ku                 const std::vector<std::string>& params) override
28736eda7685SKenny L. Ku     {
28746eda7685SKenny L. Ku         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
28756eda7685SKenny L. Ku 
28766eda7685SKenny L. Ku         auto generateTelemetryLogCallback = [asyncResp, req](
28776eda7685SKenny L. Ku                                                 const boost::system::error_code
28786eda7685SKenny L. Ku                                                     ec,
28796eda7685SKenny L. Ku                                                 const std::string& resp) {
28806eda7685SKenny L. Ku             if (ec)
28816eda7685SKenny L. Ku             {
28826eda7685SKenny L. Ku                 if (ec.value() == boost::system::errc::operation_not_supported)
28836eda7685SKenny L. Ku                 {
28846eda7685SKenny L. Ku                     messages::resourceInStandby(asyncResp->res);
28856eda7685SKenny L. Ku                 }
28866eda7685SKenny L. Ku                 else if (ec.value() ==
28876eda7685SKenny L. Ku                          boost::system::errc::device_or_resource_busy)
28886eda7685SKenny L. Ku                 {
28896eda7685SKenny L. Ku                     messages::serviceTemporarilyUnavailable(asyncResp->res,
28906eda7685SKenny L. Ku                                                             "60");
28916eda7685SKenny L. Ku                 }
28926eda7685SKenny L. Ku                 else
28936eda7685SKenny L. Ku                 {
28946eda7685SKenny L. Ku                     messages::internalError(asyncResp->res);
28956eda7685SKenny L. Ku                 }
28966eda7685SKenny L. Ku                 return;
28976eda7685SKenny L. Ku             }
28986eda7685SKenny L. Ku             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
28996eda7685SKenny L. Ku                 [](boost::system::error_code err, sdbusplus::message::message&,
29006eda7685SKenny L. Ku                    const std::shared_ptr<task::TaskData>& taskData) {
29016eda7685SKenny L. Ku                     if (!err)
29026eda7685SKenny L. Ku                     {
29036eda7685SKenny L. Ku                         taskData->messages.emplace_back(
29046eda7685SKenny L. Ku                             messages::taskCompletedOK(
29056eda7685SKenny L. Ku                                 std::to_string(taskData->index)));
29066eda7685SKenny L. Ku                         taskData->state = "Completed";
29076eda7685SKenny L. Ku                     }
29086eda7685SKenny L. Ku                     return task::completed;
29096eda7685SKenny L. Ku                 },
29106eda7685SKenny L. Ku                 "type='signal',interface='org.freedesktop.DBus.Properties',"
29116eda7685SKenny L. Ku                 "member='PropertiesChanged',arg0namespace='com.intel."
29126eda7685SKenny L. Ku                 "crashdump'");
29136eda7685SKenny L. Ku             task->startTimer(std::chrono::minutes(5));
29146eda7685SKenny L. Ku             task->populateResp(asyncResp->res);
29156eda7685SKenny L. Ku             task->payload.emplace(req);
29166eda7685SKenny L. Ku         };
29176eda7685SKenny L. Ku         crow::connections::systemBus->async_method_call(
29186eda7685SKenny L. Ku             std::move(generateTelemetryLogCallback), crashdumpObject,
29196eda7685SKenny L. Ku             crashdumpPath, crashdumpTelemetryInterface, "GenerateTelemetryLog");
29206eda7685SKenny L. Ku     }
29216eda7685SKenny L. Ku };
29226eda7685SKenny L. Ku 
2923e1f26343SJason M. Bills class SendRawPECI : public Node
29241da66f75SEd Tanous {
29251da66f75SEd Tanous   public:
2926e1f26343SJason M. Bills     SendRawPECI(CrowApp& app) :
2927424c4176SJason M. Bills         Node(app,
2928424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2929424c4176SJason M. Bills              "Crashdump.SendRawPeci/")
29301da66f75SEd Tanous     {
29313946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
29323946028dSAppaRao Puli         // method for security reasons.
29331da66f75SEd Tanous         entityPrivileges = {
29341da66f75SEd Tanous             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
29351da66f75SEd Tanous             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
29361da66f75SEd Tanous             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
29371da66f75SEd Tanous             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
29381da66f75SEd Tanous             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
29391da66f75SEd Tanous             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
29401da66f75SEd Tanous     }
29411da66f75SEd Tanous 
29421da66f75SEd Tanous   private:
29431da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
29441da66f75SEd Tanous                 const std::vector<std::string>& params) override
29451da66f75SEd Tanous     {
2946e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
29478724c297SKarthick Sundarrajan         std::vector<std::vector<uint8_t>> peciCommands;
29488724c297SKarthick Sundarrajan 
29498724c297SKarthick Sundarrajan         nlohmann::json reqJson =
29508724c297SKarthick Sundarrajan             nlohmann::json::parse(req.body, nullptr, false);
29518724c297SKarthick Sundarrajan         if (reqJson.find("PECICommands") != reqJson.end())
29528724c297SKarthick Sundarrajan         {
29538724c297SKarthick Sundarrajan             if (!json_util::readJson(req, res, "PECICommands", peciCommands))
29548724c297SKarthick Sundarrajan             {
29558724c297SKarthick Sundarrajan                 return;
29568724c297SKarthick Sundarrajan             }
29578724c297SKarthick Sundarrajan             uint32_t idx = 0;
29588724c297SKarthick Sundarrajan             for (auto const& cmd : peciCommands)
29598724c297SKarthick Sundarrajan             {
29608724c297SKarthick Sundarrajan                 if (cmd.size() < 3)
29618724c297SKarthick Sundarrajan                 {
29628724c297SKarthick Sundarrajan                     std::string s("[");
29638724c297SKarthick Sundarrajan                     for (auto const& val : cmd)
29648724c297SKarthick Sundarrajan                     {
29658724c297SKarthick Sundarrajan                         if (val != *cmd.begin())
29668724c297SKarthick Sundarrajan                         {
29678724c297SKarthick Sundarrajan                             s += ",";
29688724c297SKarthick Sundarrajan                         }
29698724c297SKarthick Sundarrajan                         s += std::to_string(val);
29708724c297SKarthick Sundarrajan                     }
29718724c297SKarthick Sundarrajan                     s += "]";
29728724c297SKarthick Sundarrajan                     messages::actionParameterValueFormatError(
29738724c297SKarthick Sundarrajan                         res, s, "PECICommands[" + std::to_string(idx) + "]",
29748724c297SKarthick Sundarrajan                         "SendRawPeci");
29758724c297SKarthick Sundarrajan                     return;
29768724c297SKarthick Sundarrajan                 }
29778724c297SKarthick Sundarrajan                 idx++;
29788724c297SKarthick Sundarrajan             }
29798724c297SKarthick Sundarrajan         }
29808724c297SKarthick Sundarrajan         else
29818724c297SKarthick Sundarrajan         {
29828724c297SKarthick Sundarrajan             /* This interface is deprecated */
2983b1556427SEd Tanous             uint8_t clientAddress = 0;
2984b1556427SEd Tanous             uint8_t readLength = 0;
29851da66f75SEd Tanous             std::vector<uint8_t> peciCommand;
2986b1556427SEd Tanous             if (!json_util::readJson(req, res, "ClientAddress", clientAddress,
2987b1556427SEd Tanous                                      "ReadLength", readLength, "PECICommand",
2988b1556427SEd Tanous                                      peciCommand))
29891da66f75SEd Tanous             {
29901da66f75SEd Tanous                 return;
29911da66f75SEd Tanous             }
29928724c297SKarthick Sundarrajan             peciCommands.push_back({clientAddress, 0, readLength});
29938724c297SKarthick Sundarrajan             peciCommands[0].insert(peciCommands[0].end(), peciCommand.begin(),
29948724c297SKarthick Sundarrajan                                    peciCommand.end());
29958724c297SKarthick Sundarrajan         }
29961da66f75SEd Tanous         // Callback to return the Raw PECI response
2997e1f26343SJason M. Bills         auto sendRawPECICallback =
2998e1f26343SJason M. Bills             [asyncResp](const boost::system::error_code ec,
29998724c297SKarthick Sundarrajan                         const std::vector<std::vector<uint8_t>>& resp) {
30001da66f75SEd Tanous                 if (ec)
30011da66f75SEd Tanous                 {
30028724c297SKarthick Sundarrajan                     BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: "
30031da66f75SEd Tanous                                      << ec.message();
3004f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
30051da66f75SEd Tanous                     return;
30061da66f75SEd Tanous                 }
3007e1f26343SJason M. Bills                 asyncResp->res.jsonValue = {{"Name", "PECI Command Response"},
30081da66f75SEd Tanous                                             {"PECIResponse", resp}};
30091da66f75SEd Tanous             };
30101da66f75SEd Tanous         // Call the SendRawPECI command with the provided data
30111da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
30125b61b5e8SJason M. Bills             std::move(sendRawPECICallback), crashdumpObject, crashdumpPath,
30138724c297SKarthick Sundarrajan             crashdumpRawPECIInterface, "SendRawPeci", peciCommands);
30141da66f75SEd Tanous     }
30151da66f75SEd Tanous };
30161da66f75SEd Tanous 
3017cb92c03bSAndrew Geissler /**
3018cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3019cb92c03bSAndrew Geissler  */
3020cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node
3021cb92c03bSAndrew Geissler {
3022cb92c03bSAndrew Geissler   public:
3023cb92c03bSAndrew Geissler     DBusLogServiceActionsClear(CrowApp& app) :
3024cb92c03bSAndrew Geissler         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
30257af91514SGunnar Mills                   "LogService.ClearLog/")
3026cb92c03bSAndrew Geissler     {
3027cb92c03bSAndrew Geissler         entityPrivileges = {
3028cb92c03bSAndrew Geissler             {boost::beast::http::verb::get, {{"Login"}}},
3029cb92c03bSAndrew Geissler             {boost::beast::http::verb::head, {{"Login"}}},
3030cb92c03bSAndrew Geissler             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3031cb92c03bSAndrew Geissler             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3032cb92c03bSAndrew Geissler             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3033cb92c03bSAndrew Geissler             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3034cb92c03bSAndrew Geissler     }
3035cb92c03bSAndrew Geissler 
3036cb92c03bSAndrew Geissler   private:
3037cb92c03bSAndrew Geissler     /**
3038cb92c03bSAndrew Geissler      * Function handles POST method request.
3039cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
3040cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
3041cb92c03bSAndrew Geissler      */
3042cb92c03bSAndrew Geissler     void doPost(crow::Response& res, const crow::Request& req,
3043cb92c03bSAndrew Geissler                 const std::vector<std::string>& params) override
3044cb92c03bSAndrew Geissler     {
3045cb92c03bSAndrew Geissler         BMCWEB_LOG_DEBUG << "Do delete all entries.";
3046cb92c03bSAndrew Geissler 
3047cb92c03bSAndrew Geissler         auto asyncResp = std::make_shared<AsyncResp>(res);
3048cb92c03bSAndrew Geissler         // Process response from Logging service.
3049cb92c03bSAndrew Geissler         auto resp_handler = [asyncResp](const boost::system::error_code ec) {
3050cb92c03bSAndrew Geissler             BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
3051cb92c03bSAndrew Geissler             if (ec)
3052cb92c03bSAndrew Geissler             {
3053cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
3054cb92c03bSAndrew Geissler                 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
3055cb92c03bSAndrew Geissler                 asyncResp->res.result(
3056cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
3057cb92c03bSAndrew Geissler                 return;
3058cb92c03bSAndrew Geissler             }
3059cb92c03bSAndrew Geissler 
3060cb92c03bSAndrew Geissler             asyncResp->res.result(boost::beast::http::status::no_content);
3061cb92c03bSAndrew Geissler         };
3062cb92c03bSAndrew Geissler 
3063cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
3064cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
3065cb92c03bSAndrew Geissler             resp_handler, "xyz.openbmc_project.Logging",
3066cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
3067cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3068cb92c03bSAndrew Geissler     }
3069cb92c03bSAndrew Geissler };
3070a3316fc6SZhikuiRen 
3071a3316fc6SZhikuiRen /****************************************************
3072a3316fc6SZhikuiRen  * Redfish PostCode interfaces
3073a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
3074a3316fc6SZhikuiRen  ******************************************************/
3075a3316fc6SZhikuiRen class PostCodesLogService : public Node
3076a3316fc6SZhikuiRen {
3077a3316fc6SZhikuiRen   public:
3078a3316fc6SZhikuiRen     PostCodesLogService(CrowApp& app) :
3079a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
3080a3316fc6SZhikuiRen     {
3081a3316fc6SZhikuiRen         entityPrivileges = {
3082a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3083a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3084a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3085a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3086a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3087a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3088a3316fc6SZhikuiRen     }
3089a3316fc6SZhikuiRen 
3090a3316fc6SZhikuiRen   private:
3091a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
3092a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3093a3316fc6SZhikuiRen     {
3094a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3095a3316fc6SZhikuiRen 
3096a3316fc6SZhikuiRen         asyncResp->res.jsonValue = {
3097a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"},
3098a3316fc6SZhikuiRen             {"@odata.type", "#LogService.v1_1_0.LogService"},
3099a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogService.LogService"},
3100a3316fc6SZhikuiRen             {"Name", "POST Code Log Service"},
3101a3316fc6SZhikuiRen             {"Description", "POST Code Log Service"},
3102a3316fc6SZhikuiRen             {"Id", "BIOS POST Code Log"},
3103a3316fc6SZhikuiRen             {"OverWritePolicy", "WrapsWhenFull"},
3104a3316fc6SZhikuiRen             {"Entries",
3105a3316fc6SZhikuiRen              {{"@odata.id",
3106a3316fc6SZhikuiRen                "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
3107a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
3108a3316fc6SZhikuiRen             {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/"
3109a3316fc6SZhikuiRen                        "Actions/LogService.ClearLog"}};
3110a3316fc6SZhikuiRen     }
3111a3316fc6SZhikuiRen };
3112a3316fc6SZhikuiRen 
3113a3316fc6SZhikuiRen class PostCodesClear : public Node
3114a3316fc6SZhikuiRen {
3115a3316fc6SZhikuiRen   public:
3116a3316fc6SZhikuiRen     PostCodesClear(CrowApp& app) :
3117a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
3118a3316fc6SZhikuiRen                   "LogService.ClearLog/")
3119a3316fc6SZhikuiRen     {
3120a3316fc6SZhikuiRen         entityPrivileges = {
3121a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3122a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
31233946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
31243946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
31253946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
31263946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
3127a3316fc6SZhikuiRen     }
3128a3316fc6SZhikuiRen 
3129a3316fc6SZhikuiRen   private:
3130a3316fc6SZhikuiRen     void doPost(crow::Response& res, const crow::Request& req,
3131a3316fc6SZhikuiRen                 const std::vector<std::string>& params) override
3132a3316fc6SZhikuiRen     {
3133a3316fc6SZhikuiRen         BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
3134a3316fc6SZhikuiRen 
3135a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3136a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
3137a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
3138a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec) {
3139a3316fc6SZhikuiRen                 if (ec)
3140a3316fc6SZhikuiRen                 {
3141a3316fc6SZhikuiRen                     // TODO Handle for specific error code
3142a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR
3143a3316fc6SZhikuiRen                         << "doClearPostCodes resp_handler got error " << ec;
3144a3316fc6SZhikuiRen                     asyncResp->res.result(
3145a3316fc6SZhikuiRen                         boost::beast::http::status::internal_server_error);
3146a3316fc6SZhikuiRen                     messages::internalError(asyncResp->res);
3147a3316fc6SZhikuiRen                     return;
3148a3316fc6SZhikuiRen                 }
3149a3316fc6SZhikuiRen             },
3150a3316fc6SZhikuiRen             "xyz.openbmc_project.State.Boot.PostCode",
3151a3316fc6SZhikuiRen             "/xyz/openbmc_project/State/Boot/PostCode",
3152a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3153a3316fc6SZhikuiRen     }
3154a3316fc6SZhikuiRen };
3155a3316fc6SZhikuiRen 
3156a3316fc6SZhikuiRen static void fillPostCodeEntry(
3157a3316fc6SZhikuiRen     std::shared_ptr<AsyncResp> aResp,
3158a3316fc6SZhikuiRen     const boost::container::flat_map<uint64_t, uint64_t>& postcode,
3159a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
3160a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
3161a3316fc6SZhikuiRen {
3162a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
3163a3316fc6SZhikuiRen     const message_registries::Message* message =
3164a3316fc6SZhikuiRen         message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode");
3165a3316fc6SZhikuiRen 
3166a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
3167a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
3168a3316fc6SZhikuiRen 
3169a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
3170a3316fc6SZhikuiRen     for (const std::pair<uint64_t, uint64_t>& code : postcode)
3171a3316fc6SZhikuiRen     {
3172a3316fc6SZhikuiRen         currentCodeIndex++;
3173a3316fc6SZhikuiRen         std::string postcodeEntryID =
3174a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
3175a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
3176a3316fc6SZhikuiRen 
3177a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
3178a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
3179a3316fc6SZhikuiRen 
3180a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
3181a3316fc6SZhikuiRen         { // already incremented
3182a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
3183a3316fc6SZhikuiRen         }
3184a3316fc6SZhikuiRen         else
3185a3316fc6SZhikuiRen         {
3186a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
3187a3316fc6SZhikuiRen         }
3188a3316fc6SZhikuiRen 
3189a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
3190a3316fc6SZhikuiRen         // not fall between top and skip
3191a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
3192a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
3193a3316fc6SZhikuiRen         {
3194a3316fc6SZhikuiRen             continue;
3195a3316fc6SZhikuiRen         }
3196a3316fc6SZhikuiRen 
31974e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
3198a3316fc6SZhikuiRen         // currentIndex
3199a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3200a3316fc6SZhikuiRen         {
3201a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
3202a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
3203a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
3204a3316fc6SZhikuiRen             continue;
3205a3316fc6SZhikuiRen         }
3206a3316fc6SZhikuiRen 
3207a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
3208a3316fc6SZhikuiRen         // index
3209a3316fc6SZhikuiRen 
3210a3316fc6SZhikuiRen         // Get the Created time from the timestamp
3211a3316fc6SZhikuiRen         std::string entryTimeStr;
32129c620e21SAsmitha Karunanithi         entryTimeStr = crow::utility::getDateTime(
32139c620e21SAsmitha Karunanithi             static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000));
3214a3316fc6SZhikuiRen 
3215a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3216a3316fc6SZhikuiRen         std::ostringstream hexCode;
3217a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
3218a3316fc6SZhikuiRen                 << code.second;
3219a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
3220a3316fc6SZhikuiRen         // Set Fixed -Point Notation
3221a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
3222a3316fc6SZhikuiRen         // Set precision to 4 digits
3223a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
3224a3316fc6SZhikuiRen         // Add double to stream
3225a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
3226a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
3227a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
3228a3316fc6SZhikuiRen 
3229a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
3230a3316fc6SZhikuiRen         std::string msg;
3231a3316fc6SZhikuiRen         if (message != nullptr)
3232a3316fc6SZhikuiRen         {
3233a3316fc6SZhikuiRen             msg = message->message;
3234a3316fc6SZhikuiRen 
3235a3316fc6SZhikuiRen             // fill in this post code value
3236a3316fc6SZhikuiRen             int i = 0;
3237a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
3238a3316fc6SZhikuiRen             {
3239a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
3240a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
3241a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
3242a3316fc6SZhikuiRen                 {
3243a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
3244a3316fc6SZhikuiRen                 }
3245a3316fc6SZhikuiRen             }
3246a3316fc6SZhikuiRen         }
3247a3316fc6SZhikuiRen 
3248d4342a92STim Lee         // Get Severity template from message registry
3249d4342a92STim Lee         std::string severity;
3250d4342a92STim Lee         if (message != nullptr)
3251d4342a92STim Lee         {
3252d4342a92STim Lee             severity = message->severity;
3253d4342a92STim Lee         }
3254d4342a92STim Lee 
3255a3316fc6SZhikuiRen         // add to AsyncResp
3256a3316fc6SZhikuiRen         logEntryArray.push_back({});
3257a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
3258a3316fc6SZhikuiRen         bmcLogEntry = {
3259a3316fc6SZhikuiRen             {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
3260a3316fc6SZhikuiRen             {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"},
3261a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
3262a3316fc6SZhikuiRen                           "PostCodes/Entries/" +
3263a3316fc6SZhikuiRen                               postcodeEntryID},
3264a3316fc6SZhikuiRen             {"Name", "POST Code Log Entry"},
3265a3316fc6SZhikuiRen             {"Id", postcodeEntryID},
3266a3316fc6SZhikuiRen             {"Message", std::move(msg)},
3267a3316fc6SZhikuiRen             {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"},
3268a3316fc6SZhikuiRen             {"MessageArgs", std::move(messageArgs)},
3269a3316fc6SZhikuiRen             {"EntryType", "Event"},
3270a3316fc6SZhikuiRen             {"Severity", std::move(severity)},
32719c620e21SAsmitha Karunanithi             {"Created", entryTimeStr}};
3272a3316fc6SZhikuiRen     }
3273a3316fc6SZhikuiRen }
3274a3316fc6SZhikuiRen 
3275a3316fc6SZhikuiRen static void getPostCodeForEntry(std::shared_ptr<AsyncResp> aResp,
3276a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
3277a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
3278a3316fc6SZhikuiRen {
3279a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3280a3316fc6SZhikuiRen         [aResp, bootIndex, codeIndex](
3281a3316fc6SZhikuiRen             const boost::system::error_code ec,
3282a3316fc6SZhikuiRen             const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
3283a3316fc6SZhikuiRen             if (ec)
3284a3316fc6SZhikuiRen             {
3285a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3286a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3287a3316fc6SZhikuiRen                 return;
3288a3316fc6SZhikuiRen             }
3289a3316fc6SZhikuiRen 
3290a3316fc6SZhikuiRen             // skip the empty postcode boots
3291a3316fc6SZhikuiRen             if (postcode.empty())
3292a3316fc6SZhikuiRen             {
3293a3316fc6SZhikuiRen                 return;
3294a3316fc6SZhikuiRen             }
3295a3316fc6SZhikuiRen 
3296a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
3297a3316fc6SZhikuiRen 
3298a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
3299a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
3300a3316fc6SZhikuiRen         },
3301a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3302a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3303a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3304a3316fc6SZhikuiRen         bootIndex);
3305a3316fc6SZhikuiRen }
3306a3316fc6SZhikuiRen 
3307a3316fc6SZhikuiRen static void getPostCodeForBoot(std::shared_ptr<AsyncResp> aResp,
3308a3316fc6SZhikuiRen                                const uint16_t bootIndex,
3309a3316fc6SZhikuiRen                                const uint16_t bootCount,
3310a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
3311a3316fc6SZhikuiRen                                const uint64_t top)
3312a3316fc6SZhikuiRen {
3313a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3314a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
3315a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3316a3316fc6SZhikuiRen               const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
3317a3316fc6SZhikuiRen             if (ec)
3318a3316fc6SZhikuiRen             {
3319a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3320a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3321a3316fc6SZhikuiRen                 return;
3322a3316fc6SZhikuiRen             }
3323a3316fc6SZhikuiRen 
3324a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
3325a3316fc6SZhikuiRen             if (!postcode.empty())
3326a3316fc6SZhikuiRen             {
3327a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
3328a3316fc6SZhikuiRen 
3329a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
3330a3316fc6SZhikuiRen                 {
3331a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
3332a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
3333a3316fc6SZhikuiRen                     uint64_t thisBootTop =
3334a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
3335a3316fc6SZhikuiRen 
3336a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3337a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
3338a3316fc6SZhikuiRen                 }
3339a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
3340a3316fc6SZhikuiRen             }
3341a3316fc6SZhikuiRen 
3342a3316fc6SZhikuiRen             // continue to previous bootIndex
3343a3316fc6SZhikuiRen             if (bootIndex < bootCount)
3344a3316fc6SZhikuiRen             {
3345a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3346a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
3347a3316fc6SZhikuiRen             }
3348a3316fc6SZhikuiRen             else
3349a3316fc6SZhikuiRen             {
3350a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
3351a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3352a3316fc6SZhikuiRen                     "Entries?$skip=" +
3353a3316fc6SZhikuiRen                     std::to_string(skip + top);
3354a3316fc6SZhikuiRen             }
3355a3316fc6SZhikuiRen         },
3356a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3357a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3358a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3359a3316fc6SZhikuiRen         bootIndex);
3360a3316fc6SZhikuiRen }
3361a3316fc6SZhikuiRen 
3362a3316fc6SZhikuiRen static void getCurrentBootNumber(std::shared_ptr<AsyncResp> aResp,
3363a3316fc6SZhikuiRen                                  const uint64_t skip, const uint64_t top)
3364a3316fc6SZhikuiRen {
3365a3316fc6SZhikuiRen     uint64_t entryCount = 0;
3366a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3367a3316fc6SZhikuiRen         [aResp, entryCount, skip,
3368a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3369a3316fc6SZhikuiRen               const std::variant<uint16_t>& bootCount) {
3370a3316fc6SZhikuiRen             if (ec)
3371a3316fc6SZhikuiRen             {
3372a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3373a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3374a3316fc6SZhikuiRen                 return;
3375a3316fc6SZhikuiRen             }
3376a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
3377a3316fc6SZhikuiRen             if (pVal)
3378a3316fc6SZhikuiRen             {
3379a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
3380a3316fc6SZhikuiRen             }
3381a3316fc6SZhikuiRen             else
3382a3316fc6SZhikuiRen             {
3383a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
3384a3316fc6SZhikuiRen             }
3385a3316fc6SZhikuiRen         },
3386a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3387a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3388a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
3389a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
3390a3316fc6SZhikuiRen }
3391a3316fc6SZhikuiRen 
3392a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node
3393a3316fc6SZhikuiRen {
3394a3316fc6SZhikuiRen   public:
3395a3316fc6SZhikuiRen     template <typename CrowApp>
3396a3316fc6SZhikuiRen     PostCodesEntryCollection(CrowApp& app) :
3397a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3398a3316fc6SZhikuiRen     {
3399a3316fc6SZhikuiRen         entityPrivileges = {
3400a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3401a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3402a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3403a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3404a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3405a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3406a3316fc6SZhikuiRen     }
3407a3316fc6SZhikuiRen 
3408a3316fc6SZhikuiRen   private:
3409a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
3410a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3411a3316fc6SZhikuiRen     {
3412a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3413a3316fc6SZhikuiRen 
3414a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
3415a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
3416a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
3417a3316fc6SZhikuiRen             "/redfish/v1/"
3418a3316fc6SZhikuiRen             "$metadata#LogEntryCollection.LogEntryCollection";
3419a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3420a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3421a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3422a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3423a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3424a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3425a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3426a3316fc6SZhikuiRen 
3427a3316fc6SZhikuiRen         uint64_t skip = 0;
3428a3316fc6SZhikuiRen         uint64_t top = maxEntriesPerPage; // Show max entries by default
3429a3316fc6SZhikuiRen         if (!getSkipParam(asyncResp->res, req, skip))
3430a3316fc6SZhikuiRen         {
3431a3316fc6SZhikuiRen             return;
3432a3316fc6SZhikuiRen         }
3433a3316fc6SZhikuiRen         if (!getTopParam(asyncResp->res, req, top))
3434a3316fc6SZhikuiRen         {
3435a3316fc6SZhikuiRen             return;
3436a3316fc6SZhikuiRen         }
3437a3316fc6SZhikuiRen         getCurrentBootNumber(asyncResp, skip, top);
3438a3316fc6SZhikuiRen     }
3439a3316fc6SZhikuiRen };
3440a3316fc6SZhikuiRen 
3441a3316fc6SZhikuiRen class PostCodesEntry : public Node
3442a3316fc6SZhikuiRen {
3443a3316fc6SZhikuiRen   public:
3444a3316fc6SZhikuiRen     PostCodesEntry(CrowApp& app) :
3445a3316fc6SZhikuiRen         Node(app,
3446a3316fc6SZhikuiRen              "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/",
3447a3316fc6SZhikuiRen              std::string())
3448a3316fc6SZhikuiRen     {
3449a3316fc6SZhikuiRen         entityPrivileges = {
3450a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3451a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3452a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3453a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3454a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3455a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3456a3316fc6SZhikuiRen     }
3457a3316fc6SZhikuiRen 
3458a3316fc6SZhikuiRen   private:
3459a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
3460a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3461a3316fc6SZhikuiRen     {
3462a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3463a3316fc6SZhikuiRen         if (params.size() != 1)
3464a3316fc6SZhikuiRen         {
3465a3316fc6SZhikuiRen             messages::internalError(asyncResp->res);
3466a3316fc6SZhikuiRen             return;
3467a3316fc6SZhikuiRen         }
3468a3316fc6SZhikuiRen 
3469a3316fc6SZhikuiRen         const std::string& targetID = params[0];
3470a3316fc6SZhikuiRen 
3471a3316fc6SZhikuiRen         size_t bootPos = targetID.find('B');
3472a3316fc6SZhikuiRen         if (bootPos == std::string::npos)
3473a3316fc6SZhikuiRen         {
3474a3316fc6SZhikuiRen             // Requested ID was not found
3475a3316fc6SZhikuiRen             messages::resourceMissingAtURI(asyncResp->res, targetID);
3476a3316fc6SZhikuiRen             return;
3477a3316fc6SZhikuiRen         }
3478a3316fc6SZhikuiRen         std::string_view bootIndexStr(targetID);
3479a3316fc6SZhikuiRen         bootIndexStr.remove_prefix(bootPos + 1);
3480a3316fc6SZhikuiRen         uint16_t bootIndex = 0;
3481a3316fc6SZhikuiRen         uint64_t codeIndex = 0;
3482a3316fc6SZhikuiRen         size_t dashPos = bootIndexStr.find('-');
3483a3316fc6SZhikuiRen 
3484a3316fc6SZhikuiRen         if (dashPos == std::string::npos)
3485a3316fc6SZhikuiRen         {
3486a3316fc6SZhikuiRen             return;
3487a3316fc6SZhikuiRen         }
3488a3316fc6SZhikuiRen         std::string_view codeIndexStr(bootIndexStr);
3489a3316fc6SZhikuiRen         bootIndexStr.remove_suffix(dashPos);
3490a3316fc6SZhikuiRen         codeIndexStr.remove_prefix(dashPos + 1);
3491a3316fc6SZhikuiRen 
3492a3316fc6SZhikuiRen         bootIndex = static_cast<uint16_t>(
3493a3316fc6SZhikuiRen             strtoul(std::string(bootIndexStr).c_str(), NULL, 0));
3494a3316fc6SZhikuiRen         codeIndex = strtoul(std::string(codeIndexStr).c_str(), NULL, 0);
3495a3316fc6SZhikuiRen         if (bootIndex == 0 || codeIndex == 0)
3496a3316fc6SZhikuiRen         {
3497a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
3498a3316fc6SZhikuiRen                              << params[0];
3499a3316fc6SZhikuiRen         }
3500a3316fc6SZhikuiRen 
3501a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
3502a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.context"] =
3503a3316fc6SZhikuiRen             "/redfish/v1/$metadata#LogEntry.LogEntry";
3504a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3505a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/"
3506a3316fc6SZhikuiRen             "Entries";
3507a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3508a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3509a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3510a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3511a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3512a3316fc6SZhikuiRen 
3513a3316fc6SZhikuiRen         getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
3514a3316fc6SZhikuiRen     }
3515a3316fc6SZhikuiRen };
3516a3316fc6SZhikuiRen 
35171da66f75SEd Tanous } // namespace redfish
3518