xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision a8fe54f09be1deefc119d8dcf100da922496d46d)
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>
30cb92c03bSAndrew Geissler #include <error_messages.hpp>
311214b7e7SGunnar Mills 
324418c7f0SJames Feist #include <filesystem>
33cd225da8SJason M. Bills #include <string_view>
34abf2add6SEd Tanous #include <variant>
351da66f75SEd Tanous 
361da66f75SEd Tanous namespace redfish
371da66f75SEd Tanous {
381da66f75SEd Tanous 
395b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump";
405b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump";
415b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump";
425b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
435b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
445b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
45424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
465b61b5e8SJason M. Bills constexpr char const* crashdumpRawPECIInterface =
47424c4176SJason M. Bills     "com.intel.crashdump.SendRawPeci";
486eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface =
496eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
501da66f75SEd Tanous 
514851d45dSJason M. Bills namespace message_registries
524851d45dSJason M. Bills {
534851d45dSJason M. Bills static const Message* getMessageFromRegistry(
544851d45dSJason M. Bills     const std::string& messageKey,
554851d45dSJason M. Bills     const boost::beast::span<const MessageEntry> registry)
564851d45dSJason M. Bills {
574851d45dSJason M. Bills     boost::beast::span<const MessageEntry>::const_iterator messageIt =
584851d45dSJason M. Bills         std::find_if(registry.cbegin(), registry.cend(),
594851d45dSJason M. Bills                      [&messageKey](const MessageEntry& messageEntry) {
604851d45dSJason M. Bills                          return !std::strcmp(messageEntry.first,
614851d45dSJason M. Bills                                              messageKey.c_str());
624851d45dSJason M. Bills                      });
634851d45dSJason M. Bills     if (messageIt != registry.cend())
644851d45dSJason M. Bills     {
654851d45dSJason M. Bills         return &messageIt->second;
664851d45dSJason M. Bills     }
674851d45dSJason M. Bills 
684851d45dSJason M. Bills     return nullptr;
694851d45dSJason M. Bills }
704851d45dSJason M. Bills 
714851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
724851d45dSJason M. Bills {
734851d45dSJason M. Bills     // Redfish MessageIds are in the form
744851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
754851d45dSJason M. Bills     // the right Message
764851d45dSJason M. Bills     std::vector<std::string> fields;
774851d45dSJason M. Bills     fields.reserve(4);
784851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
794851d45dSJason M. Bills     std::string& registryName = fields[0];
804851d45dSJason M. Bills     std::string& messageKey = fields[3];
814851d45dSJason M. Bills 
824851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
834851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
844851d45dSJason M. Bills     {
854851d45dSJason M. Bills         return getMessageFromRegistry(
864851d45dSJason M. Bills             messageKey, boost::beast::span<const MessageEntry>(base::registry));
874851d45dSJason M. Bills     }
884851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
894851d45dSJason M. Bills     {
904851d45dSJason M. Bills         return getMessageFromRegistry(
914851d45dSJason M. Bills             messageKey,
924851d45dSJason M. Bills             boost::beast::span<const MessageEntry>(openbmc::registry));
934851d45dSJason M. Bills     }
944851d45dSJason M. Bills     return nullptr;
954851d45dSJason M. Bills }
964851d45dSJason M. Bills } // namespace message_registries
974851d45dSJason M. Bills 
98f6150403SJames Feist namespace fs = std::filesystem;
991da66f75SEd Tanous 
100cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map<
10119bd78d9SPatrick Williams     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
102cb92c03bSAndrew Geissler                               int32_t, uint32_t, int64_t, uint64_t, double>>;
103cb92c03bSAndrew Geissler 
104cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map<
105cb92c03bSAndrew Geissler     sdbusplus::message::object_path,
106cb92c03bSAndrew Geissler     boost::container::flat_map<std::string, GetManagedPropertyType>>;
107cb92c03bSAndrew Geissler 
108cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
109cb92c03bSAndrew Geissler {
110d4d25793SEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
111d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
112d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
113d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
114cb92c03bSAndrew Geissler     {
115cb92c03bSAndrew Geissler         return "Critical";
116cb92c03bSAndrew Geissler     }
1173174e4dfSEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
118d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
119d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
120cb92c03bSAndrew Geissler     {
121cb92c03bSAndrew Geissler         return "OK";
122cb92c03bSAndrew Geissler     }
1233174e4dfSEd Tanous     if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
124cb92c03bSAndrew Geissler     {
125cb92c03bSAndrew Geissler         return "Warning";
126cb92c03bSAndrew Geissler     }
127cb92c03bSAndrew Geissler     return "";
128cb92c03bSAndrew Geissler }
129cb92c03bSAndrew Geissler 
13016428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
13139e77504SEd Tanous                               const std::string_view& field,
13239e77504SEd Tanous                               std::string_view& contents)
13316428a1aSJason M. Bills {
13416428a1aSJason M. Bills     const char* data = nullptr;
13516428a1aSJason M. Bills     size_t length = 0;
13616428a1aSJason M. Bills     int ret = 0;
13716428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
138271584abSEd Tanous     ret = sd_journal_get_data(journal, field.data(),
139271584abSEd Tanous                               reinterpret_cast<const void**>(&data), &length);
14016428a1aSJason M. Bills     if (ret < 0)
14116428a1aSJason M. Bills     {
14216428a1aSJason M. Bills         return ret;
14316428a1aSJason M. Bills     }
14439e77504SEd Tanous     contents = std::string_view(data, length);
14516428a1aSJason M. Bills     // Only use the content after the "=" character.
14616428a1aSJason M. Bills     contents.remove_prefix(std::min(contents.find("=") + 1, contents.size()));
14716428a1aSJason M. Bills     return ret;
14816428a1aSJason M. Bills }
14916428a1aSJason M. Bills 
15016428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
15139e77504SEd Tanous                               const std::string_view& field, const int& base,
152271584abSEd Tanous                               long int& contents)
15316428a1aSJason M. Bills {
15416428a1aSJason M. Bills     int ret = 0;
15539e77504SEd Tanous     std::string_view metadata;
15616428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
15716428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
15816428a1aSJason M. Bills     if (ret < 0)
15916428a1aSJason M. Bills     {
16016428a1aSJason M. Bills         return ret;
16116428a1aSJason M. Bills     }
162b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
16316428a1aSJason M. Bills     return ret;
16416428a1aSJason M. Bills }
16516428a1aSJason M. Bills 
166a3316fc6SZhikuiRen static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp)
167a3316fc6SZhikuiRen {
168a3316fc6SZhikuiRen     int ret = 0;
169a3316fc6SZhikuiRen     uint64_t timestamp = 0;
170a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
171a3316fc6SZhikuiRen     if (ret < 0)
172a3316fc6SZhikuiRen     {
173a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
174a3316fc6SZhikuiRen                          << strerror(-ret);
175a3316fc6SZhikuiRen         return false;
176a3316fc6SZhikuiRen     }
1779c620e21SAsmitha Karunanithi     entryTimestamp = crow::utility::getDateTime(
1789c620e21SAsmitha Karunanithi         static_cast<std::time_t>(timestamp / 1000 / 1000));
1799c620e21SAsmitha Karunanithi     return true;
180a3316fc6SZhikuiRen }
181a3316fc6SZhikuiRen 
18216428a1aSJason M. Bills static bool getSkipParam(crow::Response& res, const crow::Request& req,
183271584abSEd Tanous                          uint64_t& skip)
18416428a1aSJason M. Bills {
1855a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
1865a7e877eSJames Feist         req.urlParams.find("$skip");
1875a7e877eSJames Feist     if (it != req.urlParams.end())
18816428a1aSJason M. Bills     {
1895a7e877eSJames Feist         std::string skipParam = it->value();
19016428a1aSJason M. Bills         char* ptr = nullptr;
1915a7e877eSJames Feist         skip = std::strtoul(skipParam.c_str(), &ptr, 10);
1925a7e877eSJames Feist         if (skipParam.empty() || *ptr != '\0')
19316428a1aSJason M. Bills         {
19416428a1aSJason M. Bills 
19516428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(skipParam),
19616428a1aSJason M. Bills                                                    "$skip");
19716428a1aSJason M. Bills             return false;
19816428a1aSJason M. Bills         }
19916428a1aSJason M. Bills     }
20016428a1aSJason M. Bills     return true;
20116428a1aSJason M. Bills }
20216428a1aSJason M. Bills 
203271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
20416428a1aSJason M. Bills static bool getTopParam(crow::Response& res, const crow::Request& req,
205271584abSEd Tanous                         uint64_t& top)
20616428a1aSJason M. Bills {
2075a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
2085a7e877eSJames Feist         req.urlParams.find("$top");
2095a7e877eSJames Feist     if (it != req.urlParams.end())
21016428a1aSJason M. Bills     {
2115a7e877eSJames Feist         std::string topParam = it->value();
21216428a1aSJason M. Bills         char* ptr = nullptr;
2135a7e877eSJames Feist         top = std::strtoul(topParam.c_str(), &ptr, 10);
2145a7e877eSJames Feist         if (topParam.empty() || *ptr != '\0')
21516428a1aSJason M. Bills         {
21616428a1aSJason M. Bills             messages::queryParameterValueTypeError(res, std::string(topParam),
21716428a1aSJason M. Bills                                                    "$top");
21816428a1aSJason M. Bills             return false;
21916428a1aSJason M. Bills         }
220271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
22116428a1aSJason M. Bills         {
22216428a1aSJason M. Bills 
22316428a1aSJason M. Bills             messages::queryParameterOutOfRange(
22416428a1aSJason M. Bills                 res, std::to_string(top), "$top",
22516428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
22616428a1aSJason M. Bills             return false;
22716428a1aSJason M. Bills         }
22816428a1aSJason M. Bills     }
22916428a1aSJason M. Bills     return true;
23016428a1aSJason M. Bills }
23116428a1aSJason M. Bills 
232e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
233e85d6b16SJason M. Bills                              const bool firstEntry = true)
23416428a1aSJason M. Bills {
23516428a1aSJason M. Bills     int ret = 0;
23616428a1aSJason M. Bills     static uint64_t prevTs = 0;
23716428a1aSJason M. Bills     static int index = 0;
238e85d6b16SJason M. Bills     if (firstEntry)
239e85d6b16SJason M. Bills     {
240e85d6b16SJason M. Bills         prevTs = 0;
241e85d6b16SJason M. Bills     }
242e85d6b16SJason M. Bills 
24316428a1aSJason M. Bills     // Get the entry timestamp
24416428a1aSJason M. Bills     uint64_t curTs = 0;
24516428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
24616428a1aSJason M. Bills     if (ret < 0)
24716428a1aSJason M. Bills     {
24816428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
24916428a1aSJason M. Bills                          << strerror(-ret);
25016428a1aSJason M. Bills         return false;
25116428a1aSJason M. Bills     }
25216428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
25316428a1aSJason M. Bills     if (curTs == prevTs)
25416428a1aSJason M. Bills     {
25516428a1aSJason M. Bills         index++;
25616428a1aSJason M. Bills     }
25716428a1aSJason M. Bills     else
25816428a1aSJason M. Bills     {
25916428a1aSJason M. Bills         // Otherwise, reset it
26016428a1aSJason M. Bills         index = 0;
26116428a1aSJason M. Bills     }
26216428a1aSJason M. Bills     // Save the timestamp
26316428a1aSJason M. Bills     prevTs = curTs;
26416428a1aSJason M. Bills 
26516428a1aSJason M. Bills     entryID = std::to_string(curTs);
26616428a1aSJason M. Bills     if (index > 0)
26716428a1aSJason M. Bills     {
26816428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
26916428a1aSJason M. Bills     }
27016428a1aSJason M. Bills     return true;
27116428a1aSJason M. Bills }
27216428a1aSJason M. Bills 
273e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
274e85d6b16SJason M. Bills                              const bool firstEntry = true)
27595820184SJason M. Bills {
276271584abSEd Tanous     static time_t prevTs = 0;
27795820184SJason M. Bills     static int index = 0;
278e85d6b16SJason M. Bills     if (firstEntry)
279e85d6b16SJason M. Bills     {
280e85d6b16SJason M. Bills         prevTs = 0;
281e85d6b16SJason M. Bills     }
282e85d6b16SJason M. Bills 
28395820184SJason M. Bills     // Get the entry timestamp
284271584abSEd Tanous     std::time_t curTs = 0;
28595820184SJason M. Bills     std::tm timeStruct = {};
28695820184SJason M. Bills     std::istringstream entryStream(logEntry);
28795820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
28895820184SJason M. Bills     {
28995820184SJason M. Bills         curTs = std::mktime(&timeStruct);
29095820184SJason M. Bills     }
29195820184SJason M. Bills     // If the timestamp isn't unique, increment the index
29295820184SJason M. Bills     if (curTs == prevTs)
29395820184SJason M. Bills     {
29495820184SJason M. Bills         index++;
29595820184SJason M. Bills     }
29695820184SJason M. Bills     else
29795820184SJason M. Bills     {
29895820184SJason M. Bills         // Otherwise, reset it
29995820184SJason M. Bills         index = 0;
30095820184SJason M. Bills     }
30195820184SJason M. Bills     // Save the timestamp
30295820184SJason M. Bills     prevTs = curTs;
30395820184SJason M. Bills 
30495820184SJason M. Bills     entryID = std::to_string(curTs);
30595820184SJason M. Bills     if (index > 0)
30695820184SJason M. Bills     {
30795820184SJason M. Bills         entryID += "_" + std::to_string(index);
30895820184SJason M. Bills     }
30995820184SJason M. Bills     return true;
31095820184SJason M. Bills }
31195820184SJason M. Bills 
31216428a1aSJason M. Bills static bool getTimestampFromID(crow::Response& res, const std::string& entryID,
313271584abSEd Tanous                                uint64_t& timestamp, uint64_t& index)
31416428a1aSJason M. Bills {
31516428a1aSJason M. Bills     if (entryID.empty())
31616428a1aSJason M. Bills     {
31716428a1aSJason M. Bills         return false;
31816428a1aSJason M. Bills     }
31916428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
32039e77504SEd Tanous     std::string_view tsStr(entryID);
32116428a1aSJason M. Bills 
32216428a1aSJason M. Bills     auto underscorePos = tsStr.find("_");
32316428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
32416428a1aSJason M. Bills     {
32516428a1aSJason M. Bills         // Timestamp has an index
32616428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
32739e77504SEd Tanous         std::string_view indexStr(entryID);
32816428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
32916428a1aSJason M. Bills         std::size_t pos;
33016428a1aSJason M. Bills         try
33116428a1aSJason M. Bills         {
33239e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
33316428a1aSJason M. Bills         }
334271584abSEd Tanous         catch (std::invalid_argument&)
33516428a1aSJason M. Bills         {
33616428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
33716428a1aSJason M. Bills             return false;
33816428a1aSJason M. Bills         }
339271584abSEd Tanous         catch (std::out_of_range&)
34016428a1aSJason M. Bills         {
34116428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
34216428a1aSJason M. Bills             return false;
34316428a1aSJason M. Bills         }
34416428a1aSJason M. Bills         if (pos != indexStr.size())
34516428a1aSJason M. Bills         {
34616428a1aSJason M. Bills             messages::resourceMissingAtURI(res, entryID);
34716428a1aSJason M. Bills             return false;
34816428a1aSJason M. Bills         }
34916428a1aSJason M. Bills     }
35016428a1aSJason M. Bills     // Timestamp has no index
35116428a1aSJason M. Bills     std::size_t pos;
35216428a1aSJason M. Bills     try
35316428a1aSJason M. Bills     {
35439e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
35516428a1aSJason M. Bills     }
356271584abSEd Tanous     catch (std::invalid_argument&)
35716428a1aSJason M. Bills     {
35816428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
35916428a1aSJason M. Bills         return false;
36016428a1aSJason M. Bills     }
361271584abSEd Tanous     catch (std::out_of_range&)
36216428a1aSJason M. Bills     {
36316428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
36416428a1aSJason M. Bills         return false;
36516428a1aSJason M. Bills     }
36616428a1aSJason M. Bills     if (pos != tsStr.size())
36716428a1aSJason M. Bills     {
36816428a1aSJason M. Bills         messages::resourceMissingAtURI(res, entryID);
36916428a1aSJason M. Bills         return false;
37016428a1aSJason M. Bills     }
37116428a1aSJason M. Bills     return true;
37216428a1aSJason M. Bills }
37316428a1aSJason M. Bills 
37495820184SJason M. Bills static bool
37595820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
37695820184SJason M. Bills {
37795820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
37895820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
37995820184SJason M. Bills 
38095820184SJason M. Bills     // Loop through the directory looking for redfish log files
38195820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
38295820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
38395820184SJason M. Bills     {
38495820184SJason M. Bills         // If we find a redfish log file, save the path
38595820184SJason M. Bills         std::string filename = dirEnt.path().filename();
38695820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
38795820184SJason M. Bills         {
38895820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
38995820184SJason M. Bills         }
39095820184SJason M. Bills     }
39195820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
39295820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
39395820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
39495820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
39595820184SJason M. Bills 
39695820184SJason M. Bills     return !redfishLogFiles.empty();
39795820184SJason M. Bills }
39895820184SJason M. Bills 
3995cb1dd27SAsmitha Karunanithi inline void getDumpEntryCollection(std::shared_ptr<AsyncResp>& asyncResp,
4005cb1dd27SAsmitha Karunanithi                                    const std::string& dumpType)
4015cb1dd27SAsmitha Karunanithi {
4025cb1dd27SAsmitha Karunanithi     std::string dumpPath;
4035cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
4045cb1dd27SAsmitha Karunanithi     {
4055cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
4065cb1dd27SAsmitha Karunanithi     }
4075cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
4085cb1dd27SAsmitha Karunanithi     {
4095cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
4105cb1dd27SAsmitha Karunanithi     }
4115cb1dd27SAsmitha Karunanithi     else
4125cb1dd27SAsmitha Karunanithi     {
4135cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
4145cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
4155cb1dd27SAsmitha Karunanithi         return;
4165cb1dd27SAsmitha Karunanithi     }
4175cb1dd27SAsmitha Karunanithi 
4185cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
4195cb1dd27SAsmitha Karunanithi         [asyncResp, dumpPath, dumpType](const boost::system::error_code ec,
4205cb1dd27SAsmitha Karunanithi                                         GetManagedObjectsType& resp) {
4215cb1dd27SAsmitha Karunanithi             if (ec)
4225cb1dd27SAsmitha Karunanithi             {
4235cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4245cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
4255cb1dd27SAsmitha Karunanithi                 return;
4265cb1dd27SAsmitha Karunanithi             }
4275cb1dd27SAsmitha Karunanithi 
4285cb1dd27SAsmitha Karunanithi             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4295cb1dd27SAsmitha Karunanithi             entriesArray = nlohmann::json::array();
430b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
431b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
432b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
433b47452b2SAsmitha Karunanithi                 "/entry/";
4345cb1dd27SAsmitha Karunanithi 
4355cb1dd27SAsmitha Karunanithi             for (auto& object : resp)
4365cb1dd27SAsmitha Karunanithi             {
437b47452b2SAsmitha Karunanithi                 if (object.first.str.find(dumpEntryPath) == std::string::npos)
4385cb1dd27SAsmitha Karunanithi                 {
4395cb1dd27SAsmitha Karunanithi                     continue;
4405cb1dd27SAsmitha Karunanithi                 }
4415cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
4425cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
4435cb1dd27SAsmitha Karunanithi                 entriesArray.push_back({});
4445cb1dd27SAsmitha Karunanithi                 nlohmann::json& thisEntry = entriesArray.back();
4455cb1dd27SAsmitha Karunanithi                 const std::string& path =
4465cb1dd27SAsmitha Karunanithi                     static_cast<const std::string&>(object.first);
447f23b7296SEd Tanous                 std::size_t lastPos = path.rfind('/');
4485cb1dd27SAsmitha Karunanithi                 if (lastPos == std::string::npos)
4495cb1dd27SAsmitha Karunanithi                 {
4505cb1dd27SAsmitha Karunanithi                     continue;
4515cb1dd27SAsmitha Karunanithi                 }
4525cb1dd27SAsmitha Karunanithi                 std::string entryID = path.substr(lastPos + 1);
4535cb1dd27SAsmitha Karunanithi 
4545cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4555cb1dd27SAsmitha Karunanithi                 {
4565cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
4575cb1dd27SAsmitha Karunanithi                     {
4585cb1dd27SAsmitha Karunanithi 
4595cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4605cb1dd27SAsmitha Karunanithi                         {
4615cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
4625cb1dd27SAsmitha Karunanithi                             {
4635cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
4645cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4655cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
4665cb1dd27SAsmitha Karunanithi                                 {
4675cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4685cb1dd27SAsmitha Karunanithi                                     break;
4695cb1dd27SAsmitha Karunanithi                                 }
4705cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
4715cb1dd27SAsmitha Karunanithi                                 break;
4725cb1dd27SAsmitha Karunanithi                             }
4735cb1dd27SAsmitha Karunanithi                         }
4745cb1dd27SAsmitha Karunanithi                     }
4755cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
4765cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
4775cb1dd27SAsmitha Karunanithi                     {
4785cb1dd27SAsmitha Karunanithi 
4795cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4805cb1dd27SAsmitha Karunanithi                         {
4815cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
4825cb1dd27SAsmitha Karunanithi                             {
4835cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
4845cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4855cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
4865cb1dd27SAsmitha Karunanithi                                 {
4875cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4885cb1dd27SAsmitha Karunanithi                                     break;
4895cb1dd27SAsmitha Karunanithi                                 }
4905cb1dd27SAsmitha Karunanithi                                 timestamp =
4915cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
4925cb1dd27SAsmitha Karunanithi                                 break;
4935cb1dd27SAsmitha Karunanithi                             }
4945cb1dd27SAsmitha Karunanithi                         }
4955cb1dd27SAsmitha Karunanithi                     }
4965cb1dd27SAsmitha Karunanithi                 }
4975cb1dd27SAsmitha Karunanithi 
498d337bb72SAsmitha Karunanithi                 thisEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry";
4995cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.id"] = dumpPath + entryID;
5005cb1dd27SAsmitha Karunanithi                 thisEntry["Id"] = entryID;
5015cb1dd27SAsmitha Karunanithi                 thisEntry["EntryType"] = "Event";
5025cb1dd27SAsmitha Karunanithi                 thisEntry["Created"] = crow::utility::getDateTime(timestamp);
5035cb1dd27SAsmitha Karunanithi                 thisEntry["Name"] = dumpType + " Dump Entry";
5045cb1dd27SAsmitha Karunanithi 
505d337bb72SAsmitha Karunanithi                 thisEntry["AdditionalDataSizeBytes"] = size;
5065cb1dd27SAsmitha Karunanithi 
5075cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
5085cb1dd27SAsmitha Karunanithi                 {
509d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "Manager";
510d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
511d337bb72SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
512d337bb72SAsmitha Karunanithi                         "attachment/" +
513d337bb72SAsmitha Karunanithi                         entryID;
5145cb1dd27SAsmitha Karunanithi                 }
5155cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
5165cb1dd27SAsmitha Karunanithi                 {
517d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "OEM";
518d337bb72SAsmitha Karunanithi                     thisEntry["OEMDiagnosticDataType"] = "System";
519d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
520d337bb72SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
521d337bb72SAsmitha Karunanithi                         "attachment/" +
522d337bb72SAsmitha Karunanithi                         entryID;
5235cb1dd27SAsmitha Karunanithi                 }
5245cb1dd27SAsmitha Karunanithi             }
5255cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Members@odata.count"] =
5265cb1dd27SAsmitha Karunanithi                 entriesArray.size();
5275cb1dd27SAsmitha Karunanithi         },
5285cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5295cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5305cb1dd27SAsmitha Karunanithi }
5315cb1dd27SAsmitha Karunanithi 
5325cb1dd27SAsmitha Karunanithi inline void getDumpEntryById(std::shared_ptr<AsyncResp>& asyncResp,
5335cb1dd27SAsmitha Karunanithi                              const std::string& entryID,
5345cb1dd27SAsmitha Karunanithi                              const std::string& dumpType)
5355cb1dd27SAsmitha Karunanithi {
5365cb1dd27SAsmitha Karunanithi     std::string dumpPath;
5375cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
5385cb1dd27SAsmitha Karunanithi     {
5395cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
5405cb1dd27SAsmitha Karunanithi     }
5415cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
5425cb1dd27SAsmitha Karunanithi     {
5435cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
5445cb1dd27SAsmitha Karunanithi     }
5455cb1dd27SAsmitha Karunanithi     else
5465cb1dd27SAsmitha Karunanithi     {
5475cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
5485cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5495cb1dd27SAsmitha Karunanithi         return;
5505cb1dd27SAsmitha Karunanithi     }
5515cb1dd27SAsmitha Karunanithi 
5525cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
5535cb1dd27SAsmitha Karunanithi         [asyncResp, entryID, dumpPath, dumpType](
5545cb1dd27SAsmitha Karunanithi             const boost::system::error_code ec, GetManagedObjectsType& resp) {
5555cb1dd27SAsmitha Karunanithi             if (ec)
5565cb1dd27SAsmitha Karunanithi             {
5575cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
5585cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
5595cb1dd27SAsmitha Karunanithi                 return;
5605cb1dd27SAsmitha Karunanithi             }
5615cb1dd27SAsmitha Karunanithi 
562b47452b2SAsmitha Karunanithi             bool foundDumpEntry = false;
563b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
564b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
565b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
566b47452b2SAsmitha Karunanithi                 "/entry/";
567b47452b2SAsmitha Karunanithi 
5685cb1dd27SAsmitha Karunanithi             for (auto& objectPath : resp)
5695cb1dd27SAsmitha Karunanithi             {
570b47452b2SAsmitha Karunanithi                 if (objectPath.first.str != dumpEntryPath + entryID)
5715cb1dd27SAsmitha Karunanithi                 {
5725cb1dd27SAsmitha Karunanithi                     continue;
5735cb1dd27SAsmitha Karunanithi                 }
5745cb1dd27SAsmitha Karunanithi 
5755cb1dd27SAsmitha Karunanithi                 foundDumpEntry = true;
5765cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
5775cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
5785cb1dd27SAsmitha Karunanithi 
5795cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
5805cb1dd27SAsmitha Karunanithi                 {
5815cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
5825cb1dd27SAsmitha Karunanithi                     {
5835cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
5845cb1dd27SAsmitha Karunanithi                         {
5855cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
5865cb1dd27SAsmitha Karunanithi                             {
5875cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
5885cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
5895cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
5905cb1dd27SAsmitha Karunanithi                                 {
5915cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
5925cb1dd27SAsmitha Karunanithi                                     break;
5935cb1dd27SAsmitha Karunanithi                                 }
5945cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
5955cb1dd27SAsmitha Karunanithi                                 break;
5965cb1dd27SAsmitha Karunanithi                             }
5975cb1dd27SAsmitha Karunanithi                         }
5985cb1dd27SAsmitha Karunanithi                     }
5995cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
6005cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
6015cb1dd27SAsmitha Karunanithi                     {
6025cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6035cb1dd27SAsmitha Karunanithi                         {
6045cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
6055cb1dd27SAsmitha Karunanithi                             {
6065cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
6075cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6085cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
6095cb1dd27SAsmitha Karunanithi                                 {
6105cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6115cb1dd27SAsmitha Karunanithi                                     break;
6125cb1dd27SAsmitha Karunanithi                                 }
6135cb1dd27SAsmitha Karunanithi                                 timestamp =
6145cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
6155cb1dd27SAsmitha Karunanithi                                 break;
6165cb1dd27SAsmitha Karunanithi                             }
6175cb1dd27SAsmitha Karunanithi                         }
6185cb1dd27SAsmitha Karunanithi                     }
6195cb1dd27SAsmitha Karunanithi                 }
6205cb1dd27SAsmitha Karunanithi 
6215cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
622d337bb72SAsmitha Karunanithi                     "#LogEntry.v1_7_0.LogEntry";
6235cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
6245cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = entryID;
6255cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["EntryType"] = "Event";
6265cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Created"] =
6275cb1dd27SAsmitha Karunanithi                     crow::utility::getDateTime(timestamp);
6285cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
6295cb1dd27SAsmitha Karunanithi 
630d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
6315cb1dd27SAsmitha Karunanithi 
6325cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
6335cb1dd27SAsmitha Karunanithi                 {
634d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
635d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
6365cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
6375cb1dd27SAsmitha Karunanithi                         "attachment/" +
6385cb1dd27SAsmitha Karunanithi                         entryID;
6395cb1dd27SAsmitha Karunanithi                 }
6405cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
6415cb1dd27SAsmitha Karunanithi                 {
642d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
643d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["OEMDiagnosticDataType"] =
6445cb1dd27SAsmitha Karunanithi                         "System";
645d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
6465cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
6475cb1dd27SAsmitha Karunanithi                         "attachment/" +
6485cb1dd27SAsmitha Karunanithi                         entryID;
6495cb1dd27SAsmitha Karunanithi                 }
6505cb1dd27SAsmitha Karunanithi             }
651b47452b2SAsmitha Karunanithi             if (foundDumpEntry == false)
652b47452b2SAsmitha Karunanithi             {
653b47452b2SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Can't find Dump Entry";
654b47452b2SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
655b47452b2SAsmitha Karunanithi                 return;
656b47452b2SAsmitha Karunanithi             }
6575cb1dd27SAsmitha Karunanithi         },
6585cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
6595cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
6605cb1dd27SAsmitha Karunanithi }
6615cb1dd27SAsmitha Karunanithi 
6629878256fSStanley Chu inline void deleteDumpEntry(const std::shared_ptr<AsyncResp>& asyncResp,
6639878256fSStanley Chu                             const std::string& entryID,
664b47452b2SAsmitha Karunanithi                             const std::string& dumpType)
6655cb1dd27SAsmitha Karunanithi {
6665cb1dd27SAsmitha Karunanithi     auto respHandler = [asyncResp](const boost::system::error_code ec) {
6675cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
6685cb1dd27SAsmitha Karunanithi         if (ec)
6695cb1dd27SAsmitha Karunanithi         {
6705cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
6715cb1dd27SAsmitha Karunanithi                              << ec;
6725cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
6735cb1dd27SAsmitha Karunanithi             return;
6745cb1dd27SAsmitha Karunanithi         }
6755cb1dd27SAsmitha Karunanithi     };
6765cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
6775cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
678b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
679b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
680b47452b2SAsmitha Karunanithi             entryID,
6815cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
6825cb1dd27SAsmitha Karunanithi }
6835cb1dd27SAsmitha Karunanithi 
684a43be80fSAsmitha Karunanithi inline void createDumpTaskCallback(const crow::Request& req,
685b5a76932SEd Tanous                                    const std::shared_ptr<AsyncResp>& asyncResp,
686a43be80fSAsmitha Karunanithi                                    const uint32_t& dumpId,
687a43be80fSAsmitha Karunanithi                                    const std::string& dumpPath,
688a43be80fSAsmitha Karunanithi                                    const std::string& dumpType)
689a43be80fSAsmitha Karunanithi {
690a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
6916145ed6fSAsmitha Karunanithi         [dumpId, dumpPath, dumpType](
692a43be80fSAsmitha Karunanithi             boost::system::error_code err, sdbusplus::message::message& m,
693a43be80fSAsmitha Karunanithi             const std::shared_ptr<task::TaskData>& taskData) {
694cb13a392SEd Tanous             if (err)
695cb13a392SEd Tanous             {
6966145ed6fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Error in creating a dump";
6976145ed6fSAsmitha Karunanithi                 taskData->state = "Cancelled";
6986145ed6fSAsmitha Karunanithi                 return task::completed;
699cb13a392SEd Tanous             }
700a43be80fSAsmitha Karunanithi             std::vector<std::pair<
701a43be80fSAsmitha Karunanithi                 std::string,
702a43be80fSAsmitha Karunanithi                 std::vector<std::pair<std::string, std::variant<std::string>>>>>
703a43be80fSAsmitha Karunanithi                 interfacesList;
704a43be80fSAsmitha Karunanithi 
705a43be80fSAsmitha Karunanithi             sdbusplus::message::object_path objPath;
706a43be80fSAsmitha Karunanithi 
707a43be80fSAsmitha Karunanithi             m.read(objPath, interfacesList);
708a43be80fSAsmitha Karunanithi 
709b47452b2SAsmitha Karunanithi             if (objPath.str ==
710b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
711b47452b2SAsmitha Karunanithi                     std::string(boost::algorithm::to_lower_copy(dumpType)) +
712b47452b2SAsmitha Karunanithi                     "/entry/" + std::to_string(dumpId))
713a43be80fSAsmitha Karunanithi             {
714a43be80fSAsmitha Karunanithi                 nlohmann::json retMessage = messages::success();
715a43be80fSAsmitha Karunanithi                 taskData->messages.emplace_back(retMessage);
716a43be80fSAsmitha Karunanithi 
717a43be80fSAsmitha Karunanithi                 std::string headerLoc =
718a43be80fSAsmitha Karunanithi                     "Location: " + dumpPath + std::to_string(dumpId);
719a43be80fSAsmitha Karunanithi                 taskData->payload->httpHeaders.emplace_back(
720a43be80fSAsmitha Karunanithi                     std::move(headerLoc));
721a43be80fSAsmitha Karunanithi 
722a43be80fSAsmitha Karunanithi                 taskData->state = "Completed";
723b47452b2SAsmitha Karunanithi                 return task::completed;
7246145ed6fSAsmitha Karunanithi             }
725a43be80fSAsmitha Karunanithi             return task::completed;
726a43be80fSAsmitha Karunanithi         },
727a43be80fSAsmitha Karunanithi         "type='signal',interface='org.freedesktop.DBus."
728a43be80fSAsmitha Karunanithi         "ObjectManager',"
729a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
730a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
731a43be80fSAsmitha Karunanithi 
732a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
733a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
734a43be80fSAsmitha Karunanithi     task->payload.emplace(req);
735a43be80fSAsmitha Karunanithi }
736a43be80fSAsmitha Karunanithi 
737a43be80fSAsmitha Karunanithi inline void createDump(crow::Response& res, const crow::Request& req,
738a43be80fSAsmitha Karunanithi                        const std::string& dumpType)
739a43be80fSAsmitha Karunanithi {
740a43be80fSAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
741a43be80fSAsmitha Karunanithi 
742a43be80fSAsmitha Karunanithi     std::string dumpPath;
743a43be80fSAsmitha Karunanithi     if (dumpType == "BMC")
744a43be80fSAsmitha Karunanithi     {
745a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
746a43be80fSAsmitha Karunanithi     }
747a43be80fSAsmitha Karunanithi     else if (dumpType == "System")
748a43be80fSAsmitha Karunanithi     {
749a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
750a43be80fSAsmitha Karunanithi     }
751a43be80fSAsmitha Karunanithi     else
752a43be80fSAsmitha Karunanithi     {
753a43be80fSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
754a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
755a43be80fSAsmitha Karunanithi         return;
756a43be80fSAsmitha Karunanithi     }
757a43be80fSAsmitha Karunanithi 
758a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
759a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
760a43be80fSAsmitha Karunanithi 
761a43be80fSAsmitha Karunanithi     if (!redfish::json_util::readJson(
762a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
763a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
764a43be80fSAsmitha Karunanithi     {
765a43be80fSAsmitha Karunanithi         return;
766a43be80fSAsmitha Karunanithi     }
767a43be80fSAsmitha Karunanithi 
768a43be80fSAsmitha Karunanithi     if (dumpType == "System")
769a43be80fSAsmitha Karunanithi     {
770a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
771a43be80fSAsmitha Karunanithi         {
772a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
773a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType'/"
774a43be80fSAsmitha Karunanithi                                 "'OEMDiagnosticDataType' value not found!";
775a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
776a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
777a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
778a43be80fSAsmitha Karunanithi             return;
779a43be80fSAsmitha Karunanithi         }
7803174e4dfSEd Tanous         if ((*oemDiagnosticDataType != "System") ||
781a43be80fSAsmitha Karunanithi             (*diagnosticDataType != "OEM"))
782a43be80fSAsmitha Karunanithi         {
783a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
784a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
785a43be80fSAsmitha Karunanithi                                     "System Dump creation parameters");
786a43be80fSAsmitha Karunanithi             return;
787a43be80fSAsmitha Karunanithi         }
788a43be80fSAsmitha Karunanithi     }
789a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
790a43be80fSAsmitha Karunanithi     {
791a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
792a43be80fSAsmitha Karunanithi         {
793a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
794a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType' not found!";
795a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
796a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
797a43be80fSAsmitha Karunanithi             return;
798a43be80fSAsmitha Karunanithi         }
7993174e4dfSEd Tanous         if (*diagnosticDataType != "Manager")
800a43be80fSAsmitha Karunanithi         {
801a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
802a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
803a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
804a43be80fSAsmitha Karunanithi                                     "BMC Dump creation parameters");
805a43be80fSAsmitha Karunanithi             return;
806a43be80fSAsmitha Karunanithi         }
807a43be80fSAsmitha Karunanithi     }
808a43be80fSAsmitha Karunanithi 
809a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
810a43be80fSAsmitha Karunanithi         [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec,
811a43be80fSAsmitha Karunanithi                                              const uint32_t& dumpId) {
812a43be80fSAsmitha Karunanithi             if (ec)
813a43be80fSAsmitha Karunanithi             {
814a43be80fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
815a43be80fSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
816a43be80fSAsmitha Karunanithi                 return;
817a43be80fSAsmitha Karunanithi             }
818a43be80fSAsmitha Karunanithi             BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
819a43be80fSAsmitha Karunanithi 
820a43be80fSAsmitha Karunanithi             createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType);
821a43be80fSAsmitha Karunanithi         },
822b47452b2SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager",
823b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
824b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)),
825a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
826a43be80fSAsmitha Karunanithi }
827a43be80fSAsmitha Karunanithi 
828b47452b2SAsmitha Karunanithi inline void clearDump(crow::Response& res, const std::string& dumpType)
82980319af1SAsmitha Karunanithi {
830b47452b2SAsmitha Karunanithi     std::string dumpTypeLowerCopy =
831b47452b2SAsmitha Karunanithi         std::string(boost::algorithm::to_lower_copy(dumpType));
83280319af1SAsmitha Karunanithi     std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
83380319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
834b47452b2SAsmitha Karunanithi         [asyncResp, dumpType](const boost::system::error_code ec,
83580319af1SAsmitha Karunanithi                               const std::vector<std::string>& subTreePaths) {
83680319af1SAsmitha Karunanithi             if (ec)
83780319af1SAsmitha Karunanithi             {
83880319af1SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
83980319af1SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
84080319af1SAsmitha Karunanithi                 return;
84180319af1SAsmitha Karunanithi             }
84280319af1SAsmitha Karunanithi 
84380319af1SAsmitha Karunanithi             for (const std::string& path : subTreePaths)
84480319af1SAsmitha Karunanithi             {
845f23b7296SEd Tanous                 std::size_t pos = path.rfind('/');
84680319af1SAsmitha Karunanithi                 if (pos != std::string::npos)
84780319af1SAsmitha Karunanithi                 {
84880319af1SAsmitha Karunanithi                     std::string logID = path.substr(pos + 1);
8499878256fSStanley Chu                     deleteDumpEntry(asyncResp, logID, dumpType);
85080319af1SAsmitha Karunanithi                 }
85180319af1SAsmitha Karunanithi             }
85280319af1SAsmitha Karunanithi         },
85380319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
85480319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
85580319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
856b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0,
857b47452b2SAsmitha Karunanithi         std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." +
858b47452b2SAsmitha Karunanithi                                    dumpType});
85980319af1SAsmitha Karunanithi }
86080319af1SAsmitha Karunanithi 
8612c70f800SEd Tanous static void parseCrashdumpParameters(
862043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>>& params,
863043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
864043a0536SJohnathan Mantey {
865043a0536SJohnathan Mantey     for (auto property : params)
866043a0536SJohnathan Mantey     {
867043a0536SJohnathan Mantey         if (property.first == "Timestamp")
868043a0536SJohnathan Mantey         {
869043a0536SJohnathan Mantey             const std::string* value =
8708d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
871043a0536SJohnathan Mantey             if (value != nullptr)
872043a0536SJohnathan Mantey             {
873043a0536SJohnathan Mantey                 timestamp = *value;
874043a0536SJohnathan Mantey             }
875043a0536SJohnathan Mantey         }
876043a0536SJohnathan Mantey         else if (property.first == "Filename")
877043a0536SJohnathan Mantey         {
878043a0536SJohnathan Mantey             const std::string* value =
8798d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
880043a0536SJohnathan Mantey             if (value != nullptr)
881043a0536SJohnathan Mantey             {
882043a0536SJohnathan Mantey                 filename = *value;
883043a0536SJohnathan Mantey             }
884043a0536SJohnathan Mantey         }
885043a0536SJohnathan Mantey         else if (property.first == "Log")
886043a0536SJohnathan Mantey         {
887043a0536SJohnathan Mantey             const std::string* value =
8888d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
889043a0536SJohnathan Mantey             if (value != nullptr)
890043a0536SJohnathan Mantey             {
891043a0536SJohnathan Mantey                 logfile = *value;
892043a0536SJohnathan Mantey             }
893043a0536SJohnathan Mantey         }
894043a0536SJohnathan Mantey     }
895043a0536SJohnathan Mantey }
896043a0536SJohnathan Mantey 
897a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
898c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node
8991da66f75SEd Tanous {
9001da66f75SEd Tanous   public:
90152cc112dSEd Tanous     SystemLogServiceCollection(App& app) :
902029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/")
903c4bf6374SJason M. Bills     {
904c4bf6374SJason M. Bills         entityPrivileges = {
905c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
906c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
907c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
908c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
909c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
910c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
911c4bf6374SJason M. Bills     }
912c4bf6374SJason M. Bills 
913c4bf6374SJason M. Bills   private:
914c4bf6374SJason M. Bills     /**
915c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
916c4bf6374SJason M. Bills      */
917cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
918cb13a392SEd Tanous                const std::vector<std::string>&) override
919c4bf6374SJason M. Bills     {
920c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
921c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
922c4bf6374SJason M. Bills         // it has a duplicate entry for members
923c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
924c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
925c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
926029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
927c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
928c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
929c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
930c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
931c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
932029573d4SEd Tanous         logServiceArray.push_back(
933029573d4SEd Tanous             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}});
9345cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
935c9bb6861Sraviteja-b         logServiceArray.push_back(
9365cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}});
937c9bb6861Sraviteja-b #endif
938c9bb6861Sraviteja-b 
939d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
940d53dd41fSJason M. Bills         logServiceArray.push_back(
941cb92c03bSAndrew Geissler             {{"@odata.id",
942424c4176SJason M. Bills               "/redfish/v1/Systems/system/LogServices/Crashdump"}});
943d53dd41fSJason M. Bills #endif
944c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
945c4bf6374SJason M. Bills             logServiceArray.size();
946a3316fc6SZhikuiRen 
947a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
948a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec,
949a3316fc6SZhikuiRen                         const std::vector<std::string>& subtreePath) {
950a3316fc6SZhikuiRen                 if (ec)
951a3316fc6SZhikuiRen                 {
952a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR << ec;
953a3316fc6SZhikuiRen                     return;
954a3316fc6SZhikuiRen                 }
955a3316fc6SZhikuiRen 
956a3316fc6SZhikuiRen                 for (auto& pathStr : subtreePath)
957a3316fc6SZhikuiRen                 {
958a3316fc6SZhikuiRen                     if (pathStr.find("PostCode") != std::string::npos)
959a3316fc6SZhikuiRen                     {
96023a21a1cSEd Tanous                         nlohmann::json& logServiceArrayLocal =
961a3316fc6SZhikuiRen                             asyncResp->res.jsonValue["Members"];
96223a21a1cSEd Tanous                         logServiceArrayLocal.push_back(
963a3316fc6SZhikuiRen                             {{"@odata.id", "/redfish/v1/Systems/system/"
964a3316fc6SZhikuiRen                                            "LogServices/PostCodes"}});
965a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members@odata.count"] =
96623a21a1cSEd Tanous                             logServiceArrayLocal.size();
967a3316fc6SZhikuiRen                         return;
968a3316fc6SZhikuiRen                     }
969a3316fc6SZhikuiRen                 }
970a3316fc6SZhikuiRen             },
971a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper",
972a3316fc6SZhikuiRen             "/xyz/openbmc_project/object_mapper",
973a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
974a3316fc6SZhikuiRen             std::array<const char*, 1>{postCodeIface});
975c4bf6374SJason M. Bills     }
976c4bf6374SJason M. Bills };
977c4bf6374SJason M. Bills 
978c4bf6374SJason M. Bills class EventLogService : public Node
979c4bf6374SJason M. Bills {
980c4bf6374SJason M. Bills   public:
98152cc112dSEd Tanous     EventLogService(App& app) :
982029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
983c4bf6374SJason M. Bills     {
984c4bf6374SJason M. Bills         entityPrivileges = {
985c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
986c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
987c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
988c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
989c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
990c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
991c4bf6374SJason M. Bills     }
992c4bf6374SJason M. Bills 
993c4bf6374SJason M. Bills   private:
994cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
995cb13a392SEd Tanous                const std::vector<std::string>&) override
996c4bf6374SJason M. Bills     {
997c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
998c4bf6374SJason M. Bills 
999c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1000029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
1001c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1002c4bf6374SJason M. Bills             "#LogService.v1_1_0.LogService";
1003c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
1004c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1005c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
1006c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1007c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1008c4bf6374SJason M. Bills             {"@odata.id",
1009029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
1010e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1011e7d6c8b2SGunnar Mills 
1012e7d6c8b2SGunnar Mills             {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
1013e7d6c8b2SGunnar Mills                        "Actions/LogService.ClearLog"}};
1014489640c6SJason M. Bills     }
1015489640c6SJason M. Bills };
1016489640c6SJason M. Bills 
10171f56a3a6STim Lee class JournalEventLogClear : public Node
1018489640c6SJason M. Bills {
1019489640c6SJason M. Bills   public:
102052cc112dSEd Tanous     JournalEventLogClear(App& app) :
1021489640c6SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1022489640c6SJason M. Bills                   "LogService.ClearLog/")
1023489640c6SJason M. Bills     {
1024489640c6SJason M. Bills         entityPrivileges = {
1025489640c6SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1026489640c6SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1027489640c6SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1028489640c6SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1029489640c6SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1030489640c6SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1031489640c6SJason M. Bills     }
1032489640c6SJason M. Bills 
1033489640c6SJason M. Bills   private:
1034cb13a392SEd Tanous     void doPost(crow::Response& res, const crow::Request&,
1035cb13a392SEd Tanous                 const std::vector<std::string>&) override
1036489640c6SJason M. Bills     {
1037489640c6SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1038489640c6SJason M. Bills 
1039489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
1040489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1041489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
1042489640c6SJason M. Bills         {
1043489640c6SJason M. Bills             for (const std::filesystem::path& file : redfishLogFiles)
1044489640c6SJason M. Bills             {
1045489640c6SJason M. Bills                 std::error_code ec;
1046489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
1047489640c6SJason M. Bills             }
1048489640c6SJason M. Bills         }
1049489640c6SJason M. Bills 
1050489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
1051489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
1052489640c6SJason M. Bills             [asyncResp](const boost::system::error_code ec) {
1053489640c6SJason M. Bills                 if (ec)
1054489640c6SJason M. Bills                 {
1055489640c6SJason M. Bills                     BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
1056489640c6SJason M. Bills                     messages::internalError(asyncResp->res);
1057489640c6SJason M. Bills                     return;
1058489640c6SJason M. Bills                 }
1059489640c6SJason M. Bills 
1060489640c6SJason M. Bills                 messages::success(asyncResp->res);
1061489640c6SJason M. Bills             },
1062489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1063489640c6SJason M. Bills             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1064489640c6SJason M. Bills             "replace");
1065c4bf6374SJason M. Bills     }
1066c4bf6374SJason M. Bills };
1067c4bf6374SJason M. Bills 
106895820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
1069b5a76932SEd Tanous                                  const std::string& logEntry,
107095820184SJason M. Bills                                  nlohmann::json& logEntryJson)
1071c4bf6374SJason M. Bills {
107295820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1073cd225da8SJason M. Bills     // First get the Timestamp
1074f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1075cd225da8SJason M. Bills     if (space == std::string::npos)
107695820184SJason M. Bills     {
107795820184SJason M. Bills         return 1;
107895820184SJason M. Bills     }
1079cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1080cd225da8SJason M. Bills     // Then get the log contents
1081f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1082cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1083cd225da8SJason M. Bills     {
1084cd225da8SJason M. Bills         return 1;
1085cd225da8SJason M. Bills     }
1086cd225da8SJason M. Bills     std::string_view entry(logEntry);
1087cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1088cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1089cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1090cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1091cd225da8SJason M. Bills                  boost::token_compress_on);
1092cd225da8SJason M. Bills     // We need at least a MessageId to be valid
1093cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
1094cd225da8SJason M. Bills     {
1095cd225da8SJason M. Bills         return 1;
1096cd225da8SJason M. Bills     }
1097cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
109895820184SJason M. Bills 
10994851d45dSJason M. Bills     // Get the Message from the MessageRegistry
11004851d45dSJason M. Bills     const message_registries::Message* message =
11014851d45dSJason M. Bills         message_registries::getMessage(messageID);
1102c4bf6374SJason M. Bills 
11034851d45dSJason M. Bills     std::string msg;
11044851d45dSJason M. Bills     std::string severity;
11054851d45dSJason M. Bills     if (message != nullptr)
1106c4bf6374SJason M. Bills     {
11074851d45dSJason M. Bills         msg = message->message;
11084851d45dSJason M. Bills         severity = message->severity;
1109c4bf6374SJason M. Bills     }
1110c4bf6374SJason M. Bills 
111115a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
111215a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
111315a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
111415a86ff6SJason M. Bills     {
111515a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
111615a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
111715a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
111815a86ff6SJason M. Bills         if (!messageArgsStart.empty())
111915a86ff6SJason M. Bills         {
112015a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
112115a86ff6SJason M. Bills         }
112215a86ff6SJason M. Bills 
112323a21a1cSEd Tanous         messageArgs = {&messageArgsStart, messageArgsSize};
1124c4bf6374SJason M. Bills 
11254851d45dSJason M. Bills         // Fill the MessageArgs into the Message
112695820184SJason M. Bills         int i = 0;
112795820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11284851d45dSJason M. Bills         {
112995820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11304851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11314851d45dSJason M. Bills             if (argPos != std::string::npos)
11324851d45dSJason M. Bills             {
113395820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11344851d45dSJason M. Bills             }
11354851d45dSJason M. Bills         }
113615a86ff6SJason M. Bills     }
11374851d45dSJason M. Bills 
113895820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
113995820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
114095820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1141f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1142f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
114395820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1144c4bf6374SJason M. Bills     {
114595820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1146c4bf6374SJason M. Bills     }
1147c4bf6374SJason M. Bills 
1148c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
114995820184SJason M. Bills     logEntryJson = {
1150cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1151029573d4SEd Tanous         {"@odata.id",
1152897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
115395820184SJason M. Bills              logEntryID},
1154c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
115595820184SJason M. Bills         {"Id", logEntryID},
115695820184SJason M. Bills         {"Message", std::move(msg)},
115795820184SJason M. Bills         {"MessageId", std::move(messageID)},
1158f23b7296SEd Tanous         {"MessageArgs", messageArgs},
1159c4bf6374SJason M. Bills         {"EntryType", "Event"},
116095820184SJason M. Bills         {"Severity", std::move(severity)},
116195820184SJason M. Bills         {"Created", std::move(timestamp)}};
1162c4bf6374SJason M. Bills     return 0;
1163c4bf6374SJason M. Bills }
1164c4bf6374SJason M. Bills 
116527062605SAnthony Wilson class JournalEventLogEntryCollection : public Node
1166c4bf6374SJason M. Bills {
1167c4bf6374SJason M. Bills   public:
116852cc112dSEd Tanous     JournalEventLogEntryCollection(App& app) :
1169029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1170c4bf6374SJason M. Bills     {
1171c4bf6374SJason M. Bills         entityPrivileges = {
1172c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1173c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1174c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1175c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1176c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1177c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1178c4bf6374SJason M. Bills     }
1179c4bf6374SJason M. Bills 
1180c4bf6374SJason M. Bills   private:
1181c4bf6374SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1182cb13a392SEd Tanous                const std::vector<std::string>&) override
1183c4bf6374SJason M. Bills     {
1184c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1185271584abSEd Tanous         uint64_t skip = 0;
1186271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
1187c4bf6374SJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1188c4bf6374SJason M. Bills         {
1189c4bf6374SJason M. Bills             return;
1190c4bf6374SJason M. Bills         }
1191c4bf6374SJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1192c4bf6374SJason M. Bills         {
1193c4bf6374SJason M. Bills             return;
1194c4bf6374SJason M. Bills         }
1195c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
1196c4bf6374SJason M. Bills         // it has a duplicate entry for members
1197c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1198c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
1199c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1200029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1201c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1202c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1203c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
1204cb92c03bSAndrew Geissler 
1205c4bf6374SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1206c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
120795820184SJason M. Bills         // Go through the log files and create a unique ID for each entry
120895820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
120995820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1210b01bf299SEd Tanous         uint64_t entryCount = 0;
1211cd225da8SJason M. Bills         std::string logEntry;
121295820184SJason M. Bills 
121395820184SJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1214cd225da8SJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1215cd225da8SJason M. Bills              it++)
1216c4bf6374SJason M. Bills         {
1217cd225da8SJason M. Bills             std::ifstream logStream(*it);
121895820184SJason M. Bills             if (!logStream.is_open())
1219c4bf6374SJason M. Bills             {
1220c4bf6374SJason M. Bills                 continue;
1221c4bf6374SJason M. Bills             }
1222c4bf6374SJason M. Bills 
1223e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
1224e85d6b16SJason M. Bills             bool firstEntry = true;
122595820184SJason M. Bills             while (std::getline(logStream, logEntry))
122695820184SJason M. Bills             {
1227c4bf6374SJason M. Bills                 entryCount++;
1228c4bf6374SJason M. Bills                 // Handle paging using skip (number of entries to skip from the
1229c4bf6374SJason M. Bills                 // start) and top (number of entries to display)
1230c4bf6374SJason M. Bills                 if (entryCount <= skip || entryCount > skip + top)
1231c4bf6374SJason M. Bills                 {
1232c4bf6374SJason M. Bills                     continue;
1233c4bf6374SJason M. Bills                 }
1234c4bf6374SJason M. Bills 
1235c4bf6374SJason M. Bills                 std::string idStr;
1236e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1237c4bf6374SJason M. Bills                 {
1238c4bf6374SJason M. Bills                     continue;
1239c4bf6374SJason M. Bills                 }
1240c4bf6374SJason M. Bills 
1241e85d6b16SJason M. Bills                 if (firstEntry)
1242e85d6b16SJason M. Bills                 {
1243e85d6b16SJason M. Bills                     firstEntry = false;
1244e85d6b16SJason M. Bills                 }
1245e85d6b16SJason M. Bills 
1246c4bf6374SJason M. Bills                 logEntryArray.push_back({});
1247c4bf6374SJason M. Bills                 nlohmann::json& bmcLogEntry = logEntryArray.back();
124895820184SJason M. Bills                 if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0)
1249c4bf6374SJason M. Bills                 {
1250c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
1251c4bf6374SJason M. Bills                     return;
1252c4bf6374SJason M. Bills                 }
1253c4bf6374SJason M. Bills             }
125495820184SJason M. Bills         }
1255c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1256c4bf6374SJason M. Bills         if (skip + top < entryCount)
1257c4bf6374SJason M. Bills         {
1258c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
125995820184SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/"
126095820184SJason M. Bills                 "Entries?$skip=" +
1261c4bf6374SJason M. Bills                 std::to_string(skip + top);
1262c4bf6374SJason M. Bills         }
126308a4e4b5SAnthony Wilson     }
126408a4e4b5SAnthony Wilson };
126508a4e4b5SAnthony Wilson 
1266897967deSJason M. Bills class JournalEventLogEntry : public Node
1267897967deSJason M. Bills {
1268897967deSJason M. Bills   public:
126952cc112dSEd Tanous     JournalEventLogEntry(App& app) :
1270897967deSJason M. Bills         Node(app,
1271897967deSJason M. Bills              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1272897967deSJason M. Bills              std::string())
1273897967deSJason M. Bills     {
1274897967deSJason M. Bills         entityPrivileges = {
1275897967deSJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1276897967deSJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1277897967deSJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1278897967deSJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1279897967deSJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1280897967deSJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1281897967deSJason M. Bills     }
1282897967deSJason M. Bills 
1283897967deSJason M. Bills   private:
1284cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
1285897967deSJason M. Bills                const std::vector<std::string>& params) override
1286897967deSJason M. Bills     {
1287897967deSJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1288897967deSJason M. Bills         if (params.size() != 1)
1289897967deSJason M. Bills         {
1290897967deSJason M. Bills             messages::internalError(asyncResp->res);
1291897967deSJason M. Bills             return;
1292897967deSJason M. Bills         }
1293897967deSJason M. Bills         const std::string& targetID = params[0];
1294897967deSJason M. Bills 
1295897967deSJason M. Bills         // Go through the log files and check the unique ID for each entry to
1296897967deSJason M. Bills         // find the target entry
1297897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1298897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1299897967deSJason M. Bills         std::string logEntry;
1300897967deSJason M. Bills 
1301897967deSJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1302897967deSJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1303897967deSJason M. Bills              it++)
1304897967deSJason M. Bills         {
1305897967deSJason M. Bills             std::ifstream logStream(*it);
1306897967deSJason M. Bills             if (!logStream.is_open())
1307897967deSJason M. Bills             {
1308897967deSJason M. Bills                 continue;
1309897967deSJason M. Bills             }
1310897967deSJason M. Bills 
1311897967deSJason M. Bills             // Reset the unique ID on the first entry
1312897967deSJason M. Bills             bool firstEntry = true;
1313897967deSJason M. Bills             while (std::getline(logStream, logEntry))
1314897967deSJason M. Bills             {
1315897967deSJason M. Bills                 std::string idStr;
1316897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1317897967deSJason M. Bills                 {
1318897967deSJason M. Bills                     continue;
1319897967deSJason M. Bills                 }
1320897967deSJason M. Bills 
1321897967deSJason M. Bills                 if (firstEntry)
1322897967deSJason M. Bills                 {
1323897967deSJason M. Bills                     firstEntry = false;
1324897967deSJason M. Bills                 }
1325897967deSJason M. Bills 
1326897967deSJason M. Bills                 if (idStr == targetID)
1327897967deSJason M. Bills                 {
1328897967deSJason M. Bills                     if (fillEventLogEntryJson(idStr, logEntry,
1329897967deSJason M. Bills                                               asyncResp->res.jsonValue) != 0)
1330897967deSJason M. Bills                     {
1331897967deSJason M. Bills                         messages::internalError(asyncResp->res);
1332897967deSJason M. Bills                         return;
1333897967deSJason M. Bills                     }
1334897967deSJason M. Bills                     return;
1335897967deSJason M. Bills                 }
1336897967deSJason M. Bills             }
1337897967deSJason M. Bills         }
1338897967deSJason M. Bills         // Requested ID was not found
1339897967deSJason M. Bills         messages::resourceMissingAtURI(asyncResp->res, targetID);
1340897967deSJason M. Bills     }
1341897967deSJason M. Bills };
1342897967deSJason M. Bills 
134308a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node
134408a4e4b5SAnthony Wilson {
134508a4e4b5SAnthony Wilson   public:
134652cc112dSEd Tanous     DBusEventLogEntryCollection(App& app) :
134708a4e4b5SAnthony Wilson         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
134808a4e4b5SAnthony Wilson     {
134908a4e4b5SAnthony Wilson         entityPrivileges = {
135008a4e4b5SAnthony Wilson             {boost::beast::http::verb::get, {{"Login"}}},
135108a4e4b5SAnthony Wilson             {boost::beast::http::verb::head, {{"Login"}}},
135208a4e4b5SAnthony Wilson             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
135308a4e4b5SAnthony Wilson             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
135408a4e4b5SAnthony Wilson             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
135508a4e4b5SAnthony Wilson             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
135608a4e4b5SAnthony Wilson     }
135708a4e4b5SAnthony Wilson 
135808a4e4b5SAnthony Wilson   private:
1359cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
1360cb13a392SEd Tanous                const std::vector<std::string>&) override
136108a4e4b5SAnthony Wilson     {
136208a4e4b5SAnthony Wilson         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
136308a4e4b5SAnthony Wilson 
136408a4e4b5SAnthony Wilson         // Collections don't include the static data added by SubRoute because
136508a4e4b5SAnthony Wilson         // it has a duplicate entry for members
136608a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
136708a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
136808a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
136908a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
137008a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
137108a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
137208a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
137308a4e4b5SAnthony Wilson 
1374cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1375cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1376cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1377cb92c03bSAndrew Geissler             [asyncResp](const boost::system::error_code ec,
1378cb92c03bSAndrew Geissler                         GetManagedObjectsType& resp) {
1379cb92c03bSAndrew Geissler                 if (ec)
1380cb92c03bSAndrew Geissler                 {
1381cb92c03bSAndrew Geissler                     // TODO Handle for specific error code
1382cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1383cb92c03bSAndrew Geissler                         << "getLogEntriesIfaceData resp_handler got error "
1384cb92c03bSAndrew Geissler                         << ec;
1385cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1386cb92c03bSAndrew Geissler                     return;
1387cb92c03bSAndrew Geissler                 }
1388cb92c03bSAndrew Geissler                 nlohmann::json& entriesArray =
1389cb92c03bSAndrew Geissler                     asyncResp->res.jsonValue["Members"];
1390cb92c03bSAndrew Geissler                 entriesArray = nlohmann::json::array();
1391cb92c03bSAndrew Geissler                 for (auto& objectPath : resp)
1392cb92c03bSAndrew Geissler                 {
1393cb92c03bSAndrew Geissler                     for (auto& interfaceMap : objectPath.second)
1394cb92c03bSAndrew Geissler                     {
1395cb92c03bSAndrew Geissler                         if (interfaceMap.first !=
1396cb92c03bSAndrew Geissler                             "xyz.openbmc_project.Logging.Entry")
1397cb92c03bSAndrew Geissler                         {
1398cb92c03bSAndrew Geissler                             BMCWEB_LOG_DEBUG << "Bailing early on "
1399cb92c03bSAndrew Geissler                                              << interfaceMap.first;
1400cb92c03bSAndrew Geissler                             continue;
1401cb92c03bSAndrew Geissler                         }
1402cb92c03bSAndrew Geissler                         entriesArray.push_back({});
1403cb92c03bSAndrew Geissler                         nlohmann::json& thisEntry = entriesArray.back();
140466664f25SEd Tanous                         uint32_t* id = nullptr;
140566664f25SEd Tanous                         std::time_t timestamp{};
1406d139c236SGeorge Liu                         std::time_t updateTimestamp{};
140766664f25SEd Tanous                         std::string* severity = nullptr;
140866664f25SEd Tanous                         std::string* message = nullptr;
1409d139c236SGeorge Liu 
1410cb92c03bSAndrew Geissler                         for (auto& propertyMap : interfaceMap.second)
1411cb92c03bSAndrew Geissler                         {
1412cb92c03bSAndrew Geissler                             if (propertyMap.first == "Id")
1413cb92c03bSAndrew Geissler                             {
14148d78b7a9SPatrick Williams                                 id = std::get_if<uint32_t>(&propertyMap.second);
1415cb92c03bSAndrew Geissler                                 if (id == nullptr)
1416cb92c03bSAndrew Geissler                                 {
14170f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1418cb92c03bSAndrew Geissler                                 }
1419cb92c03bSAndrew Geissler                             }
1420cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Timestamp")
1421cb92c03bSAndrew Geissler                             {
1422cb92c03bSAndrew Geissler                                 const uint64_t* millisTimeStamp =
1423cb92c03bSAndrew Geissler                                     std::get_if<uint64_t>(&propertyMap.second);
1424cb92c03bSAndrew Geissler                                 if (millisTimeStamp == nullptr)
1425cb92c03bSAndrew Geissler                                 {
14260f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1427cb92c03bSAndrew Geissler                                 }
1428ebd45906SGeorge Liu                                 else
1429ebd45906SGeorge Liu                                 {
1430d139c236SGeorge Liu                                     timestamp = crow::utility::getTimestamp(
1431cb92c03bSAndrew Geissler                                         *millisTimeStamp);
1432d139c236SGeorge Liu                                 }
1433ebd45906SGeorge Liu                             }
1434d139c236SGeorge Liu                             else if (propertyMap.first == "UpdateTimestamp")
1435d139c236SGeorge Liu                             {
1436d139c236SGeorge Liu                                 const uint64_t* millisTimeStamp =
1437d139c236SGeorge Liu                                     std::get_if<uint64_t>(&propertyMap.second);
1438d139c236SGeorge Liu                                 if (millisTimeStamp == nullptr)
1439d139c236SGeorge Liu                                 {
1440d139c236SGeorge Liu                                     messages::internalError(asyncResp->res);
1441d139c236SGeorge Liu                                 }
1442ebd45906SGeorge Liu                                 else
1443ebd45906SGeorge Liu                                 {
1444ebd45906SGeorge Liu                                     updateTimestamp =
1445ebd45906SGeorge Liu                                         crow::utility::getTimestamp(
1446d139c236SGeorge Liu                                             *millisTimeStamp);
1447cb92c03bSAndrew Geissler                                 }
1448ebd45906SGeorge Liu                             }
1449cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Severity")
1450cb92c03bSAndrew Geissler                             {
1451cb92c03bSAndrew Geissler                                 severity = std::get_if<std::string>(
1452cb92c03bSAndrew Geissler                                     &propertyMap.second);
1453cb92c03bSAndrew Geissler                                 if (severity == nullptr)
1454cb92c03bSAndrew Geissler                                 {
14550f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1456cb92c03bSAndrew Geissler                                 }
1457cb92c03bSAndrew Geissler                             }
1458cb92c03bSAndrew Geissler                             else if (propertyMap.first == "Message")
1459cb92c03bSAndrew Geissler                             {
1460cb92c03bSAndrew Geissler                                 message = std::get_if<std::string>(
1461cb92c03bSAndrew Geissler                                     &propertyMap.second);
1462cb92c03bSAndrew Geissler                                 if (message == nullptr)
1463cb92c03bSAndrew Geissler                                 {
14640f1d8ed9SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
1465cb92c03bSAndrew Geissler                                 }
1466cb92c03bSAndrew Geissler                             }
1467cb92c03bSAndrew Geissler                         }
1468cb92c03bSAndrew Geissler                         thisEntry = {
1469d139c236SGeorge Liu                             {"@odata.type", "#LogEntry.v1_6_0.LogEntry"},
1470cb92c03bSAndrew Geissler                             {"@odata.id",
1471cb92c03bSAndrew Geissler                              "/redfish/v1/Systems/system/LogServices/EventLog/"
1472cb92c03bSAndrew Geissler                              "Entries/" +
1473cb92c03bSAndrew Geissler                                  std::to_string(*id)},
147427062605SAnthony Wilson                             {"Name", "System Event Log Entry"},
1475cb92c03bSAndrew Geissler                             {"Id", std::to_string(*id)},
1476cb92c03bSAndrew Geissler                             {"Message", *message},
1477cb92c03bSAndrew Geissler                             {"EntryType", "Event"},
1478cb92c03bSAndrew Geissler                             {"Severity",
1479cb92c03bSAndrew Geissler                              translateSeverityDbusToRedfish(*severity)},
1480d139c236SGeorge Liu                             {"Created", crow::utility::getDateTime(timestamp)},
1481d139c236SGeorge Liu                             {"Modified",
1482d139c236SGeorge Liu                              crow::utility::getDateTime(updateTimestamp)}};
1483cb92c03bSAndrew Geissler                     }
1484cb92c03bSAndrew Geissler                 }
1485cb92c03bSAndrew Geissler                 std::sort(entriesArray.begin(), entriesArray.end(),
1486cb92c03bSAndrew Geissler                           [](const nlohmann::json& left,
1487cb92c03bSAndrew Geissler                              const nlohmann::json& right) {
1488cb92c03bSAndrew Geissler                               return (left["Id"] <= right["Id"]);
1489cb92c03bSAndrew Geissler                           });
1490cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue["Members@odata.count"] =
1491cb92c03bSAndrew Geissler                     entriesArray.size();
1492cb92c03bSAndrew Geissler             },
1493cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
1494cb92c03bSAndrew Geissler             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1495c4bf6374SJason M. Bills     }
1496c4bf6374SJason M. Bills };
1497c4bf6374SJason M. Bills 
149808a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node
1499c4bf6374SJason M. Bills {
1500c4bf6374SJason M. Bills   public:
150152cc112dSEd Tanous     DBusEventLogEntry(App& app) :
1502c4bf6374SJason M. Bills         Node(app,
1503029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1504029573d4SEd Tanous              std::string())
1505c4bf6374SJason M. Bills     {
1506c4bf6374SJason M. Bills         entityPrivileges = {
1507c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1508c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1509c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1510c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1511c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1512c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1513c4bf6374SJason M. Bills     }
1514c4bf6374SJason M. Bills 
1515c4bf6374SJason M. Bills   private:
1516cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
1517c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1518c4bf6374SJason M. Bills     {
1519c4bf6374SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1520029573d4SEd Tanous         if (params.size() != 1)
1521c4bf6374SJason M. Bills         {
1522c4bf6374SJason M. Bills             messages::internalError(asyncResp->res);
1523c4bf6374SJason M. Bills             return;
1524c4bf6374SJason M. Bills         }
1525029573d4SEd Tanous         const std::string& entryID = params[0];
1526cb92c03bSAndrew Geissler 
1527cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1528cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1529cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1530cb92c03bSAndrew Geissler             [asyncResp, entryID](const boost::system::error_code ec,
1531cb92c03bSAndrew Geissler                                  GetManagedPropertyType& resp) {
1532cb92c03bSAndrew Geissler                 if (ec)
1533cb92c03bSAndrew Geissler                 {
1534cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1535cb92c03bSAndrew Geissler                         << "EventLogEntry (DBus) resp_handler got error " << ec;
1536cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1537cb92c03bSAndrew Geissler                     return;
1538cb92c03bSAndrew Geissler                 }
153966664f25SEd Tanous                 uint32_t* id = nullptr;
154066664f25SEd Tanous                 std::time_t timestamp{};
1541d139c236SGeorge Liu                 std::time_t updateTimestamp{};
154266664f25SEd Tanous                 std::string* severity = nullptr;
154366664f25SEd Tanous                 std::string* message = nullptr;
1544d139c236SGeorge Liu 
1545cb92c03bSAndrew Geissler                 for (auto& propertyMap : resp)
1546cb92c03bSAndrew Geissler                 {
1547cb92c03bSAndrew Geissler                     if (propertyMap.first == "Id")
1548cb92c03bSAndrew Geissler                     {
1549cb92c03bSAndrew Geissler                         id = std::get_if<uint32_t>(&propertyMap.second);
1550cb92c03bSAndrew Geissler                         if (id == nullptr)
1551cb92c03bSAndrew Geissler                         {
15520f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1553cb92c03bSAndrew Geissler                         }
1554cb92c03bSAndrew Geissler                     }
1555cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Timestamp")
1556cb92c03bSAndrew Geissler                     {
1557cb92c03bSAndrew Geissler                         const uint64_t* millisTimeStamp =
1558cb92c03bSAndrew Geissler                             std::get_if<uint64_t>(&propertyMap.second);
1559cb92c03bSAndrew Geissler                         if (millisTimeStamp == nullptr)
1560cb92c03bSAndrew Geissler                         {
15610f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1562cb92c03bSAndrew Geissler                         }
1563ebd45906SGeorge Liu                         else
1564ebd45906SGeorge Liu                         {
1565cb92c03bSAndrew Geissler                             timestamp =
1566d139c236SGeorge Liu                                 crow::utility::getTimestamp(*millisTimeStamp);
1567d139c236SGeorge Liu                         }
1568ebd45906SGeorge Liu                     }
1569d139c236SGeorge Liu                     else if (propertyMap.first == "UpdateTimestamp")
1570d139c236SGeorge Liu                     {
1571d139c236SGeorge Liu                         const uint64_t* millisTimeStamp =
1572d139c236SGeorge Liu                             std::get_if<uint64_t>(&propertyMap.second);
1573d139c236SGeorge Liu                         if (millisTimeStamp == nullptr)
1574d139c236SGeorge Liu                         {
1575d139c236SGeorge Liu                             messages::internalError(asyncResp->res);
1576d139c236SGeorge Liu                         }
1577ebd45906SGeorge Liu                         else
1578ebd45906SGeorge Liu                         {
1579d139c236SGeorge Liu                             updateTimestamp =
1580d139c236SGeorge Liu                                 crow::utility::getTimestamp(*millisTimeStamp);
1581cb92c03bSAndrew Geissler                         }
1582ebd45906SGeorge Liu                     }
1583cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Severity")
1584cb92c03bSAndrew Geissler                     {
1585cb92c03bSAndrew Geissler                         severity =
1586cb92c03bSAndrew Geissler                             std::get_if<std::string>(&propertyMap.second);
1587cb92c03bSAndrew Geissler                         if (severity == nullptr)
1588cb92c03bSAndrew Geissler                         {
15890f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1590cb92c03bSAndrew Geissler                         }
1591cb92c03bSAndrew Geissler                     }
1592cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Message")
1593cb92c03bSAndrew Geissler                     {
1594cb92c03bSAndrew Geissler                         message = std::get_if<std::string>(&propertyMap.second);
1595cb92c03bSAndrew Geissler                         if (message == nullptr)
1596cb92c03bSAndrew Geissler                         {
15970f1d8ed9SAsmitha Karunanithi                             messages::internalError(asyncResp->res);
1598cb92c03bSAndrew Geissler                         }
1599cb92c03bSAndrew Geissler                     }
1600cb92c03bSAndrew Geissler                 }
1601271584abSEd Tanous                 if (id == nullptr || message == nullptr || severity == nullptr)
1602271584abSEd Tanous                 {
1603271584abSEd Tanous                     return;
1604271584abSEd Tanous                 }
1605cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue = {
1606d139c236SGeorge Liu                     {"@odata.type", "#LogEntry.v1_6_0.LogEntry"},
1607cb92c03bSAndrew Geissler                     {"@odata.id",
1608cb92c03bSAndrew Geissler                      "/redfish/v1/Systems/system/LogServices/EventLog/"
1609cb92c03bSAndrew Geissler                      "Entries/" +
1610cb92c03bSAndrew Geissler                          std::to_string(*id)},
161127062605SAnthony Wilson                     {"Name", "System Event Log Entry"},
1612cb92c03bSAndrew Geissler                     {"Id", std::to_string(*id)},
1613cb92c03bSAndrew Geissler                     {"Message", *message},
1614cb92c03bSAndrew Geissler                     {"EntryType", "Event"},
1615cb92c03bSAndrew Geissler                     {"Severity", translateSeverityDbusToRedfish(*severity)},
1616d139c236SGeorge Liu                     {"Created", crow::utility::getDateTime(timestamp)},
1617d139c236SGeorge Liu                     {"Modified", crow::utility::getDateTime(updateTimestamp)}};
1618cb92c03bSAndrew Geissler             },
1619cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging",
1620cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging/entry/" + entryID,
1621cb92c03bSAndrew Geissler             "org.freedesktop.DBus.Properties", "GetAll",
1622cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging.Entry");
1623c4bf6374SJason M. Bills     }
1624336e96c6SChicago Duan 
1625cb13a392SEd Tanous     void doDelete(crow::Response& res, const crow::Request&,
1626336e96c6SChicago Duan                   const std::vector<std::string>& params) override
1627336e96c6SChicago Duan     {
1628336e96c6SChicago Duan 
1629336e96c6SChicago Duan         BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1630336e96c6SChicago Duan 
1631336e96c6SChicago Duan         auto asyncResp = std::make_shared<AsyncResp>(res);
1632336e96c6SChicago Duan 
1633336e96c6SChicago Duan         if (params.size() != 1)
1634336e96c6SChicago Duan         {
1635336e96c6SChicago Duan             messages::internalError(asyncResp->res);
1636336e96c6SChicago Duan             return;
1637336e96c6SChicago Duan         }
1638336e96c6SChicago Duan         std::string entryID = params[0];
1639336e96c6SChicago Duan 
1640336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
1641336e96c6SChicago Duan 
1642336e96c6SChicago Duan         // Process response from Logging service.
1643336e96c6SChicago Duan         auto respHandler = [asyncResp](const boost::system::error_code ec) {
1644336e96c6SChicago Duan             BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1645336e96c6SChicago Duan             if (ec)
1646336e96c6SChicago Duan             {
1647336e96c6SChicago Duan                 // TODO Handle for specific error code
1648336e96c6SChicago Duan                 BMCWEB_LOG_ERROR
1649336e96c6SChicago Duan                     << "EventLogEntry (DBus) doDelete respHandler got error "
1650336e96c6SChicago Duan                     << ec;
1651336e96c6SChicago Duan                 asyncResp->res.result(
1652336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
1653336e96c6SChicago Duan                 return;
1654336e96c6SChicago Duan             }
1655336e96c6SChicago Duan 
1656336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
1657336e96c6SChicago Duan         };
1658336e96c6SChicago Duan 
1659336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
1660336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
1661336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
1662336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
1663336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
1664336e96c6SChicago Duan     }
1665c4bf6374SJason M. Bills };
1666c4bf6374SJason M. Bills 
1667c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node
1668c4bf6374SJason M. Bills {
1669c4bf6374SJason M. Bills   public:
167052cc112dSEd Tanous     BMCLogServiceCollection(App& app) :
16714ed77cd5SEd Tanous         Node(app, "/redfish/v1/Managers/bmc/LogServices/")
16721da66f75SEd Tanous     {
16731da66f75SEd Tanous         entityPrivileges = {
1674e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1675e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1676e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1677e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1678e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1679e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
16801da66f75SEd Tanous     }
16811da66f75SEd Tanous 
16821da66f75SEd Tanous   private:
16831da66f75SEd Tanous     /**
16841da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
16851da66f75SEd Tanous      */
1686cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
1687cb13a392SEd Tanous                const std::vector<std::string>&) override
16881da66f75SEd Tanous     {
1689e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
16901da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
16911da66f75SEd Tanous         // it has a duplicate entry for members
1692e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
16931da66f75SEd Tanous             "#LogServiceCollection.LogServiceCollection";
1694e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1695e1f26343SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices";
1696e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1697e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
16981da66f75SEd Tanous             "Collection of LogServices for this Manager";
1699c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1700c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
17015cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
17025cb1dd27SAsmitha Karunanithi         logServiceArray.push_back(
17035cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}});
17045cb1dd27SAsmitha Karunanithi #endif
1705c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1706c4bf6374SJason M. Bills         logServiceArray.push_back(
170708a4e4b5SAnthony Wilson             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1708c4bf6374SJason M. Bills #endif
1709e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
1710c4bf6374SJason M. Bills             logServiceArray.size();
17111da66f75SEd Tanous     }
17121da66f75SEd Tanous };
17131da66f75SEd Tanous 
1714c4bf6374SJason M. Bills class BMCJournalLogService : public Node
17151da66f75SEd Tanous {
17161da66f75SEd Tanous   public:
171752cc112dSEd Tanous     BMCJournalLogService(App& app) :
1718c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1719e1f26343SJason M. Bills     {
1720e1f26343SJason M. Bills         entityPrivileges = {
1721e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1722e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1723e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1724e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1725e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1726e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1727e1f26343SJason M. Bills     }
1728e1f26343SJason M. Bills 
1729e1f26343SJason M. Bills   private:
1730cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
1731cb13a392SEd Tanous                const std::vector<std::string>&) override
1732e1f26343SJason M. Bills     {
1733e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1734e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1735e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
17360f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
17370f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
1738c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
1739c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
1740c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "BMC Journal";
1741e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1742cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1743cd50aa42SJason M. Bills             {"@odata.id",
1744086be238SEd Tanous              "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
1745e1f26343SJason M. Bills     }
1746e1f26343SJason M. Bills };
1747e1f26343SJason M. Bills 
1748c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1749e1f26343SJason M. Bills                                       sd_journal* journal,
1750c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
1751e1f26343SJason M. Bills {
1752e1f26343SJason M. Bills     // Get the Log Entry contents
1753e1f26343SJason M. Bills     int ret = 0;
1754e1f26343SJason M. Bills 
1755*a8fe54f0SJason M. Bills     std::string message;
1756*a8fe54f0SJason M. Bills     std::string_view syslogID;
1757*a8fe54f0SJason M. Bills     ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
1758*a8fe54f0SJason M. Bills     if (ret < 0)
1759*a8fe54f0SJason M. Bills     {
1760*a8fe54f0SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: "
1761*a8fe54f0SJason M. Bills                          << strerror(-ret);
1762*a8fe54f0SJason M. Bills     }
1763*a8fe54f0SJason M. Bills     if (!syslogID.empty())
1764*a8fe54f0SJason M. Bills     {
1765*a8fe54f0SJason M. Bills         message += std::string(syslogID) + ": ";
1766*a8fe54f0SJason M. Bills     }
1767*a8fe54f0SJason M. Bills 
176839e77504SEd Tanous     std::string_view msg;
176916428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1770e1f26343SJason M. Bills     if (ret < 0)
1771e1f26343SJason M. Bills     {
1772e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1773e1f26343SJason M. Bills         return 1;
1774e1f26343SJason M. Bills     }
1775*a8fe54f0SJason M. Bills     message += std::string(msg);
1776e1f26343SJason M. Bills 
1777e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1778271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
177916428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1780e1f26343SJason M. Bills     if (ret < 0)
1781e1f26343SJason M. Bills     {
1782e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
1783e1f26343SJason M. Bills     }
1784e1f26343SJason M. Bills 
1785e1f26343SJason M. Bills     // Get the Created time from the timestamp
178616428a1aSJason M. Bills     std::string entryTimeStr;
178716428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
1788e1f26343SJason M. Bills     {
178916428a1aSJason M. Bills         return 1;
1790e1f26343SJason M. Bills     }
1791e1f26343SJason M. Bills 
1792e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
1793c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
1794cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1795c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1796c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
1797e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
1798c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
1799*a8fe54f0SJason M. Bills         {"Message", std::move(message)},
1800e1f26343SJason M. Bills         {"EntryType", "Oem"},
1801e1f26343SJason M. Bills         {"Severity",
1802b6a61a5eSJason M. Bills          severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"},
1803086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
1804e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
1805e1f26343SJason M. Bills     return 0;
1806e1f26343SJason M. Bills }
1807e1f26343SJason M. Bills 
1808c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node
1809e1f26343SJason M. Bills {
1810e1f26343SJason M. Bills   public:
181152cc112dSEd Tanous     BMCJournalLogEntryCollection(App& app) :
1812c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
1813e1f26343SJason M. Bills     {
1814e1f26343SJason M. Bills         entityPrivileges = {
1815e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1816e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1817e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1818e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1819e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1820e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1821e1f26343SJason M. Bills     }
1822e1f26343SJason M. Bills 
1823e1f26343SJason M. Bills   private:
1824e1f26343SJason M. Bills     void doGet(crow::Response& res, const crow::Request& req,
1825cb13a392SEd Tanous                const std::vector<std::string>&) override
1826e1f26343SJason M. Bills     {
1827e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1828193ad2faSJason M. Bills         static constexpr const long maxEntriesPerPage = 1000;
1829271584abSEd Tanous         uint64_t skip = 0;
1830271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
183116428a1aSJason M. Bills         if (!getSkipParam(asyncResp->res, req, skip))
1832193ad2faSJason M. Bills         {
1833193ad2faSJason M. Bills             return;
1834193ad2faSJason M. Bills         }
183516428a1aSJason M. Bills         if (!getTopParam(asyncResp->res, req, top))
1836193ad2faSJason M. Bills         {
1837193ad2faSJason M. Bills             return;
1838193ad2faSJason M. Bills         }
1839e1f26343SJason M. Bills         // Collections don't include the static data added by SubRoute because
1840e1f26343SJason M. Bills         // it has a duplicate entry for members
1841e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1842e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
18430f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
18440f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1845e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1846c4bf6374SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
1847e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1848e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1849e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
18500f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
18510f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries";
1852e1f26343SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1853e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
1854e1f26343SJason M. Bills 
1855e1f26343SJason M. Bills         // Go through the journal and use the timestamp to create a unique ID
1856e1f26343SJason M. Bills         // for each entry
1857e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1858e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1859e1f26343SJason M. Bills         if (ret < 0)
1860e1f26343SJason M. Bills         {
1861e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1862f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1863e1f26343SJason M. Bills             return;
1864e1f26343SJason M. Bills         }
1865e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1866e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1867e1f26343SJason M. Bills         journalTmp = nullptr;
1868b01bf299SEd Tanous         uint64_t entryCount = 0;
1869e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
1870e85d6b16SJason M. Bills         bool firstEntry = true;
1871e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
1872e1f26343SJason M. Bills         {
1873193ad2faSJason M. Bills             entryCount++;
1874193ad2faSJason M. Bills             // Handle paging using skip (number of entries to skip from the
1875193ad2faSJason M. Bills             // start) and top (number of entries to display)
1876193ad2faSJason M. Bills             if (entryCount <= skip || entryCount > skip + top)
1877193ad2faSJason M. Bills             {
1878193ad2faSJason M. Bills                 continue;
1879193ad2faSJason M. Bills             }
1880193ad2faSJason M. Bills 
188116428a1aSJason M. Bills             std::string idStr;
1882e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1883e1f26343SJason M. Bills             {
1884e1f26343SJason M. Bills                 continue;
1885e1f26343SJason M. Bills             }
1886e1f26343SJason M. Bills 
1887e85d6b16SJason M. Bills             if (firstEntry)
1888e85d6b16SJason M. Bills             {
1889e85d6b16SJason M. Bills                 firstEntry = false;
1890e85d6b16SJason M. Bills             }
1891e85d6b16SJason M. Bills 
1892e1f26343SJason M. Bills             logEntryArray.push_back({});
1893c4bf6374SJason M. Bills             nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
1894c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
1895c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
1896e1f26343SJason M. Bills             {
1897f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
1898e1f26343SJason M. Bills                 return;
1899e1f26343SJason M. Bills             }
1900e1f26343SJason M. Bills         }
1901193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1902193ad2faSJason M. Bills         if (skip + top < entryCount)
1903193ad2faSJason M. Bills         {
1904193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
1905c4bf6374SJason M. Bills                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
1906193ad2faSJason M. Bills                 std::to_string(skip + top);
1907193ad2faSJason M. Bills         }
1908e1f26343SJason M. Bills     }
1909e1f26343SJason M. Bills };
1910e1f26343SJason M. Bills 
1911c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node
1912e1f26343SJason M. Bills {
1913e1f26343SJason M. Bills   public:
191452cc112dSEd Tanous     BMCJournalLogEntry(App& app) :
1915c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/",
1916e1f26343SJason M. Bills              std::string())
1917e1f26343SJason M. Bills     {
1918e1f26343SJason M. Bills         entityPrivileges = {
1919e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1920e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1921e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1922e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1923e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1924e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1925e1f26343SJason M. Bills     }
1926e1f26343SJason M. Bills 
1927e1f26343SJason M. Bills   private:
1928cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
1929e1f26343SJason M. Bills                const std::vector<std::string>& params) override
1930e1f26343SJason M. Bills     {
1931e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1932e1f26343SJason M. Bills         if (params.size() != 1)
1933e1f26343SJason M. Bills         {
1934f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1935e1f26343SJason M. Bills             return;
1936e1f26343SJason M. Bills         }
193716428a1aSJason M. Bills         const std::string& entryID = params[0];
1938e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
1939e1f26343SJason M. Bills         uint64_t ts = 0;
1940271584abSEd Tanous         uint64_t index = 0;
194116428a1aSJason M. Bills         if (!getTimestampFromID(asyncResp->res, entryID, ts, index))
1942e1f26343SJason M. Bills         {
194316428a1aSJason M. Bills             return;
1944e1f26343SJason M. Bills         }
1945e1f26343SJason M. Bills 
1946e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
1947e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1948e1f26343SJason M. Bills         if (ret < 0)
1949e1f26343SJason M. Bills         {
1950e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
1951f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1952e1f26343SJason M. Bills             return;
1953e1f26343SJason M. Bills         }
1954e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1955e1f26343SJason M. Bills             journalTmp, sd_journal_close);
1956e1f26343SJason M. Bills         journalTmp = nullptr;
1957e1f26343SJason M. Bills         // Go to the timestamp in the log and move to the entry at the index
1958af07e3f5SJason M. Bills         // tracking the unique ID
1959af07e3f5SJason M. Bills         std::string idStr;
1960af07e3f5SJason M. Bills         bool firstEntry = true;
1961e1f26343SJason M. Bills         ret = sd_journal_seek_realtime_usec(journal.get(), ts);
19622056b6d1SManojkiran Eda         if (ret < 0)
19632056b6d1SManojkiran Eda         {
19642056b6d1SManojkiran Eda             BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
19652056b6d1SManojkiran Eda                              << strerror(-ret);
19662056b6d1SManojkiran Eda             messages::internalError(asyncResp->res);
19672056b6d1SManojkiran Eda             return;
19682056b6d1SManojkiran Eda         }
1969271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
1970e1f26343SJason M. Bills         {
1971e1f26343SJason M. Bills             sd_journal_next(journal.get());
1972af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1973af07e3f5SJason M. Bills             {
1974af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
1975af07e3f5SJason M. Bills                 return;
1976af07e3f5SJason M. Bills             }
1977af07e3f5SJason M. Bills             if (firstEntry)
1978af07e3f5SJason M. Bills             {
1979af07e3f5SJason M. Bills                 firstEntry = false;
1980af07e3f5SJason M. Bills             }
1981e1f26343SJason M. Bills         }
1982c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
1983af07e3f5SJason M. Bills         if (idStr != entryID)
1984c4bf6374SJason M. Bills         {
1985c4bf6374SJason M. Bills             messages::resourceMissingAtURI(asyncResp->res, entryID);
1986c4bf6374SJason M. Bills             return;
1987c4bf6374SJason M. Bills         }
1988c4bf6374SJason M. Bills 
1989c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
1990e1f26343SJason M. Bills                                        asyncResp->res.jsonValue) != 0)
1991e1f26343SJason M. Bills         {
1992f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
1993e1f26343SJason M. Bills             return;
1994e1f26343SJason M. Bills         }
1995e1f26343SJason M. Bills     }
1996e1f26343SJason M. Bills };
1997e1f26343SJason M. Bills 
19985cb1dd27SAsmitha Karunanithi class BMCDumpService : public Node
1999c9bb6861Sraviteja-b {
2000c9bb6861Sraviteja-b   public:
200152cc112dSEd Tanous     BMCDumpService(App& app) :
20025cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2003c9bb6861Sraviteja-b     {
2004c9bb6861Sraviteja-b         entityPrivileges = {
2005c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2006c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2007c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2008c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2009c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2010c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2011c9bb6861Sraviteja-b     }
2012c9bb6861Sraviteja-b 
2013c9bb6861Sraviteja-b   private:
2014cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2015cb13a392SEd Tanous                const std::vector<std::string>&) override
2016c9bb6861Sraviteja-b     {
2017c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2018c9bb6861Sraviteja-b 
2019c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
20205cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump";
2021c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2022d337bb72SAsmitha Karunanithi             "#LogService.v1_2_0.LogService";
2023c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "Dump LogService";
20245cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
20255cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
2026c9bb6861Sraviteja-b         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2027c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Entries"] = {
20285cb1dd27SAsmitha Karunanithi             {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
20295cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
20305cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
20315cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
20325cb1dd27SAsmitha Karunanithi                          "Actions/LogService.ClearLog"}}},
2033d337bb72SAsmitha Karunanithi             {"#LogService.CollectDiagnosticData",
2034d337bb72SAsmitha Karunanithi              {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
2035d337bb72SAsmitha Karunanithi                          "Actions/LogService.CollectDiagnosticData"}}}};
2036c9bb6861Sraviteja-b     }
2037c9bb6861Sraviteja-b };
2038c9bb6861Sraviteja-b 
20395cb1dd27SAsmitha Karunanithi class BMCDumpEntryCollection : public Node
2040c9bb6861Sraviteja-b {
2041c9bb6861Sraviteja-b   public:
204252cc112dSEd Tanous     BMCDumpEntryCollection(App& app) :
20435cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2044c9bb6861Sraviteja-b     {
2045c9bb6861Sraviteja-b         entityPrivileges = {
2046c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2047c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2048c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2049c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2050c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2051c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2052c9bb6861Sraviteja-b     }
2053c9bb6861Sraviteja-b 
2054c9bb6861Sraviteja-b   private:
2055c9bb6861Sraviteja-b     /**
2056c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
2057c9bb6861Sraviteja-b      */
2058cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2059cb13a392SEd Tanous                const std::vector<std::string>&) override
2060c9bb6861Sraviteja-b     {
2061c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2062c9bb6861Sraviteja-b 
2063c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2064c9bb6861Sraviteja-b             "#LogEntryCollection.LogEntryCollection";
2065c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
20665cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
20675cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
2068c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] =
20695cb1dd27SAsmitha Karunanithi             "Collection of BMC Dump Entries";
2070c9bb6861Sraviteja-b 
20715cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "BMC");
2072c9bb6861Sraviteja-b     }
2073c9bb6861Sraviteja-b };
2074c9bb6861Sraviteja-b 
20755cb1dd27SAsmitha Karunanithi class BMCDumpEntry : public Node
2076c9bb6861Sraviteja-b {
2077c9bb6861Sraviteja-b   public:
207852cc112dSEd Tanous     BMCDumpEntry(App& app) :
20795cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/",
2080c9bb6861Sraviteja-b              std::string())
2081c9bb6861Sraviteja-b     {
2082c9bb6861Sraviteja-b         entityPrivileges = {
2083c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2084c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2085c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2086c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2087c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2088c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2089c9bb6861Sraviteja-b     }
2090c9bb6861Sraviteja-b 
2091c9bb6861Sraviteja-b   private:
2092cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2093c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2094c9bb6861Sraviteja-b     {
2095c9bb6861Sraviteja-b         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2096c9bb6861Sraviteja-b         if (params.size() != 1)
2097c9bb6861Sraviteja-b         {
2098c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2099c9bb6861Sraviteja-b             return;
2100c9bb6861Sraviteja-b         }
21015cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "BMC");
2102c9bb6861Sraviteja-b     }
2103c9bb6861Sraviteja-b 
2104cb13a392SEd Tanous     void doDelete(crow::Response& res, const crow::Request&,
2105c9bb6861Sraviteja-b                   const std::vector<std::string>& params) override
2106c9bb6861Sraviteja-b     {
21075cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2108c9bb6861Sraviteja-b         if (params.size() != 1)
2109c9bb6861Sraviteja-b         {
2110c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2111c9bb6861Sraviteja-b             return;
2112c9bb6861Sraviteja-b         }
21139878256fSStanley Chu         deleteDumpEntry(asyncResp, params[0], "bmc");
21145cb1dd27SAsmitha Karunanithi     }
21155cb1dd27SAsmitha Karunanithi };
2116c9bb6861Sraviteja-b 
2117a43be80fSAsmitha Karunanithi class BMCDumpCreate : public Node
2118a43be80fSAsmitha Karunanithi {
2119a43be80fSAsmitha Karunanithi   public:
212052cc112dSEd Tanous     BMCDumpCreate(App& app) :
2121a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2122d337bb72SAsmitha Karunanithi                   "Actions/"
2123d337bb72SAsmitha Karunanithi                   "LogService.CollectDiagnosticData/")
2124a43be80fSAsmitha Karunanithi     {
2125a43be80fSAsmitha Karunanithi         entityPrivileges = {
2126a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2127a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2128a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2129a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2130a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2131a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2132a43be80fSAsmitha Karunanithi     }
2133a43be80fSAsmitha Karunanithi 
2134a43be80fSAsmitha Karunanithi   private:
2135a43be80fSAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
2136cb13a392SEd Tanous                 const std::vector<std::string>&) override
2137a43be80fSAsmitha Karunanithi     {
2138a43be80fSAsmitha Karunanithi         createDump(res, req, "BMC");
2139a43be80fSAsmitha Karunanithi     }
2140a43be80fSAsmitha Karunanithi };
2141a43be80fSAsmitha Karunanithi 
214280319af1SAsmitha Karunanithi class BMCDumpClear : public Node
214380319af1SAsmitha Karunanithi {
214480319af1SAsmitha Karunanithi   public:
214552cc112dSEd Tanous     BMCDumpClear(App& app) :
214680319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
214780319af1SAsmitha Karunanithi                   "Actions/"
214880319af1SAsmitha Karunanithi                   "LogService.ClearLog/")
214980319af1SAsmitha Karunanithi     {
215080319af1SAsmitha Karunanithi         entityPrivileges = {
215180319af1SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
215280319af1SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
215380319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
215480319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
215580319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
215680319af1SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
215780319af1SAsmitha Karunanithi     }
215880319af1SAsmitha Karunanithi 
215980319af1SAsmitha Karunanithi   private:
2160cb13a392SEd Tanous     void doPost(crow::Response& res, const crow::Request&,
2161cb13a392SEd Tanous                 const std::vector<std::string>&) override
216280319af1SAsmitha Karunanithi     {
2163b47452b2SAsmitha Karunanithi         clearDump(res, "BMC");
216480319af1SAsmitha Karunanithi     }
216580319af1SAsmitha Karunanithi };
216680319af1SAsmitha Karunanithi 
21675cb1dd27SAsmitha Karunanithi class SystemDumpService : public Node
2168c9bb6861Sraviteja-b {
21695cb1dd27SAsmitha Karunanithi   public:
217052cc112dSEd Tanous     SystemDumpService(App& app) :
21715cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/")
21725cb1dd27SAsmitha Karunanithi     {
21735cb1dd27SAsmitha Karunanithi         entityPrivileges = {
21745cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
21755cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
21765cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
21775cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
21785cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
21795cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
21805cb1dd27SAsmitha Karunanithi     }
21815cb1dd27SAsmitha Karunanithi 
21825cb1dd27SAsmitha Karunanithi   private:
2183cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2184cb13a392SEd Tanous                const std::vector<std::string>&) override
21855cb1dd27SAsmitha Karunanithi     {
21865cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
21875cb1dd27SAsmitha Karunanithi 
21885cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
21895cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump";
21905cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
2191d337bb72SAsmitha Karunanithi             "#LogService.v1_2_0.LogService";
21925cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "Dump LogService";
21935cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "System Dump LogService";
21945cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
21955cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
21965cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Entries"] = {
21975cb1dd27SAsmitha Karunanithi             {"@odata.id",
21985cb1dd27SAsmitha Karunanithi              "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
21995cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
22005cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
22015cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
22025cb1dd27SAsmitha Karunanithi                          "LogService.ClearLog"}}},
2203d337bb72SAsmitha Karunanithi             {"#LogService.CollectDiagnosticData",
2204d337bb72SAsmitha Karunanithi              {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
2205d337bb72SAsmitha Karunanithi                          "LogService.CollectDiagnosticData"}}}};
22065cb1dd27SAsmitha Karunanithi     }
22075cb1dd27SAsmitha Karunanithi };
22085cb1dd27SAsmitha Karunanithi 
22095cb1dd27SAsmitha Karunanithi class SystemDumpEntryCollection : public Node
22105cb1dd27SAsmitha Karunanithi {
22115cb1dd27SAsmitha Karunanithi   public:
221252cc112dSEd Tanous     SystemDumpEntryCollection(App& app) :
22135cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
22145cb1dd27SAsmitha Karunanithi     {
22155cb1dd27SAsmitha Karunanithi         entityPrivileges = {
22165cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22175cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22185cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22195cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22205cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22215cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22225cb1dd27SAsmitha Karunanithi     }
22235cb1dd27SAsmitha Karunanithi 
22245cb1dd27SAsmitha Karunanithi   private:
22255cb1dd27SAsmitha Karunanithi     /**
22265cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
22275cb1dd27SAsmitha Karunanithi      */
2228cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2229cb13a392SEd Tanous                const std::vector<std::string>&) override
22305cb1dd27SAsmitha Karunanithi     {
22315cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22325cb1dd27SAsmitha Karunanithi 
22335cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
22345cb1dd27SAsmitha Karunanithi             "#LogEntryCollection.LogEntryCollection";
22355cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
22365cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump/Entries";
22375cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "System Dump Entries";
22385cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] =
22395cb1dd27SAsmitha Karunanithi             "Collection of System Dump Entries";
22405cb1dd27SAsmitha Karunanithi 
22415cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "System");
22425cb1dd27SAsmitha Karunanithi     }
22435cb1dd27SAsmitha Karunanithi };
22445cb1dd27SAsmitha Karunanithi 
22455cb1dd27SAsmitha Karunanithi class SystemDumpEntry : public Node
22465cb1dd27SAsmitha Karunanithi {
22475cb1dd27SAsmitha Karunanithi   public:
224852cc112dSEd Tanous     SystemDumpEntry(App& app) :
22495cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/",
22505cb1dd27SAsmitha Karunanithi              std::string())
22515cb1dd27SAsmitha Karunanithi     {
22525cb1dd27SAsmitha Karunanithi         entityPrivileges = {
22535cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
22545cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
22555cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
22565cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
22575cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
22585cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
22595cb1dd27SAsmitha Karunanithi     }
22605cb1dd27SAsmitha Karunanithi 
22615cb1dd27SAsmitha Karunanithi   private:
2262cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
22635cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
22645cb1dd27SAsmitha Karunanithi     {
22655cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22665cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
22675cb1dd27SAsmitha Karunanithi         {
2268c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2269c9bb6861Sraviteja-b             return;
2270c9bb6861Sraviteja-b         }
22715cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "System");
22725cb1dd27SAsmitha Karunanithi     }
2273c9bb6861Sraviteja-b 
2274cb13a392SEd Tanous     void doDelete(crow::Response& res, const crow::Request&,
22755cb1dd27SAsmitha Karunanithi                   const std::vector<std::string>& params) override
2276c9bb6861Sraviteja-b     {
22775cb1dd27SAsmitha Karunanithi         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
22785cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
2279c9bb6861Sraviteja-b         {
22805cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
2281c9bb6861Sraviteja-b             return;
2282c9bb6861Sraviteja-b         }
22839878256fSStanley Chu         deleteDumpEntry(asyncResp, params[0], "system");
2284c9bb6861Sraviteja-b     }
2285c9bb6861Sraviteja-b };
2286c9bb6861Sraviteja-b 
2287a43be80fSAsmitha Karunanithi class SystemDumpCreate : public Node
2288a43be80fSAsmitha Karunanithi {
2289a43be80fSAsmitha Karunanithi   public:
229052cc112dSEd Tanous     SystemDumpCreate(App& app) :
2291a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2292d337bb72SAsmitha Karunanithi                   "Actions/"
2293d337bb72SAsmitha Karunanithi                   "LogService.CollectDiagnosticData/")
2294a43be80fSAsmitha Karunanithi     {
2295a43be80fSAsmitha Karunanithi         entityPrivileges = {
2296a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2297a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2298a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2299a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2300a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2301a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2302a43be80fSAsmitha Karunanithi     }
2303a43be80fSAsmitha Karunanithi 
2304a43be80fSAsmitha Karunanithi   private:
2305a43be80fSAsmitha Karunanithi     void doPost(crow::Response& res, const crow::Request& req,
2306cb13a392SEd Tanous                 const std::vector<std::string>&) override
2307a43be80fSAsmitha Karunanithi     {
2308a43be80fSAsmitha Karunanithi         createDump(res, req, "System");
2309a43be80fSAsmitha Karunanithi     }
2310a43be80fSAsmitha Karunanithi };
2311a43be80fSAsmitha Karunanithi 
2312013487e5Sraviteja-b class SystemDumpClear : public Node
2313013487e5Sraviteja-b {
2314013487e5Sraviteja-b   public:
231552cc112dSEd Tanous     SystemDumpClear(App& app) :
231680319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2317013487e5Sraviteja-b                   "Actions/"
2318013487e5Sraviteja-b                   "LogService.ClearLog/")
2319013487e5Sraviteja-b     {
2320013487e5Sraviteja-b         entityPrivileges = {
2321013487e5Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2322013487e5Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
232380319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
232480319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
232580319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2326013487e5Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2327013487e5Sraviteja-b     }
2328013487e5Sraviteja-b 
2329013487e5Sraviteja-b   private:
2330cb13a392SEd Tanous     void doPost(crow::Response& res, const crow::Request&,
2331cb13a392SEd Tanous                 const std::vector<std::string>&) override
2332013487e5Sraviteja-b     {
2333b47452b2SAsmitha Karunanithi         clearDump(res, "System");
2334013487e5Sraviteja-b     }
2335013487e5Sraviteja-b };
2336013487e5Sraviteja-b 
2337424c4176SJason M. Bills class CrashdumpService : public Node
2338e1f26343SJason M. Bills {
2339e1f26343SJason M. Bills   public:
234052cc112dSEd Tanous     CrashdumpService(App& app) :
2341424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
23421da66f75SEd Tanous     {
23433946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
23443946028dSAppaRao Puli         // method for security reasons.
23451da66f75SEd Tanous         entityPrivileges = {
23463946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
23473946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2348e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2349e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2350e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2351e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
23521da66f75SEd Tanous     }
23531da66f75SEd Tanous 
23541da66f75SEd Tanous   private:
23551da66f75SEd Tanous     /**
23561da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
23571da66f75SEd Tanous      */
2358cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2359cb13a392SEd Tanous                const std::vector<std::string>&) override
23601da66f75SEd Tanous     {
2361e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
23621da66f75SEd Tanous         // Copy over the static data to include the entries added by SubRoute
23630f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
2364424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
2365e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2366e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
23674f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
23684f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
23694f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2370e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2371e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
2372cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
2373cd50aa42SJason M. Bills             {"@odata.id",
2374424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
2375e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"] = {
23765b61b5e8SJason M. Bills             {"#LogService.ClearLog",
23775b61b5e8SJason M. Bills              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
23785b61b5e8SJason M. Bills                          "Actions/LogService.ClearLog"}}},
23791da66f75SEd Tanous             {"Oem",
2380424c4176SJason M. Bills              {{"#Crashdump.OnDemand",
2381424c4176SJason M. Bills                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
23826eda7685SKenny L. Ku                            "Actions/Oem/Crashdump.OnDemand"}}},
23836eda7685SKenny L. Ku               {"#Crashdump.Telemetry",
23846eda7685SKenny L. Ku                {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
23856eda7685SKenny L. Ku                            "Actions/Oem/Crashdump.Telemetry"}}}}}};
23861da66f75SEd Tanous 
23871da66f75SEd Tanous #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI
2388e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"]["Oem"].push_back(
2389424c4176SJason M. Bills             {"#Crashdump.SendRawPeci",
239008a4e4b5SAnthony Wilson              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
2391424c4176SJason M. Bills                          "Actions/Oem/Crashdump.SendRawPeci"}}});
23921da66f75SEd Tanous #endif
23931da66f75SEd Tanous     }
23941da66f75SEd Tanous };
23951da66f75SEd Tanous 
23965b61b5e8SJason M. Bills class CrashdumpClear : public Node
23975b61b5e8SJason M. Bills {
23985b61b5e8SJason M. Bills   public:
239952cc112dSEd Tanous     CrashdumpClear(App& app) :
24005b61b5e8SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
24015b61b5e8SJason M. Bills                   "LogService.ClearLog/")
24025b61b5e8SJason M. Bills     {
24033946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
24043946028dSAppaRao Puli         // method for security reasons.
24055b61b5e8SJason M. Bills         entityPrivileges = {
24063946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
24073946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
24085b61b5e8SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
24095b61b5e8SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
24105b61b5e8SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
24115b61b5e8SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
24125b61b5e8SJason M. Bills     }
24135b61b5e8SJason M. Bills 
24145b61b5e8SJason M. Bills   private:
2415cb13a392SEd Tanous     void doPost(crow::Response& res, const crow::Request&,
2416cb13a392SEd Tanous                 const std::vector<std::string>&) override
24175b61b5e8SJason M. Bills     {
24185b61b5e8SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
24195b61b5e8SJason M. Bills 
24205b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
24215b61b5e8SJason M. Bills             [asyncResp](const boost::system::error_code ec,
2422cb13a392SEd Tanous                         const std::string&) {
24235b61b5e8SJason M. Bills                 if (ec)
24245b61b5e8SJason M. Bills                 {
24255b61b5e8SJason M. Bills                     messages::internalError(asyncResp->res);
24265b61b5e8SJason M. Bills                     return;
24275b61b5e8SJason M. Bills                 }
24285b61b5e8SJason M. Bills                 messages::success(asyncResp->res);
24295b61b5e8SJason M. Bills             },
24305b61b5e8SJason M. Bills             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
24315b61b5e8SJason M. Bills     }
24325b61b5e8SJason M. Bills };
24335b61b5e8SJason M. Bills 
2434b5a76932SEd Tanous static void logCrashdumpEntry(const std::shared_ptr<AsyncResp>& asyncResp,
2435e855dd28SJason M. Bills                               const std::string& logID,
2436e855dd28SJason M. Bills                               nlohmann::json& logEntryJson)
2437e855dd28SJason M. Bills {
2438043a0536SJohnathan Mantey     auto getStoredLogCallback =
2439043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2440e855dd28SJason M. Bills             const boost::system::error_code ec,
2441043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>>& params) {
2442e855dd28SJason M. Bills             if (ec)
2443e855dd28SJason M. Bills             {
2444e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
24451ddcf01aSJason M. Bills                 if (ec.value() ==
24461ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
24471ddcf01aSJason M. Bills                 {
2448043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2449043a0536SJohnathan Mantey                                                logID);
24501ddcf01aSJason M. Bills                 }
24511ddcf01aSJason M. Bills                 else
24521ddcf01aSJason M. Bills                 {
2453e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
24541ddcf01aSJason M. Bills                 }
2455e855dd28SJason M. Bills                 return;
2456e855dd28SJason M. Bills             }
2457043a0536SJohnathan Mantey 
2458043a0536SJohnathan Mantey             std::string timestamp{};
2459043a0536SJohnathan Mantey             std::string filename{};
2460043a0536SJohnathan Mantey             std::string logfile{};
24612c70f800SEd Tanous             parseCrashdumpParameters(params, filename, timestamp, logfile);
2462043a0536SJohnathan Mantey 
2463043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2464e855dd28SJason M. Bills             {
2465043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2466e855dd28SJason M. Bills                 return;
2467e855dd28SJason M. Bills             }
2468e855dd28SJason M. Bills 
2469043a0536SJohnathan Mantey             std::string crashdumpURI =
2470e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2471043a0536SJohnathan Mantey                 logID + "/" + filename;
2472043a0536SJohnathan Mantey             logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2473043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2474043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2475e855dd28SJason M. Bills                                               logID},
2476e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2477e855dd28SJason M. Bills                             {"Id", logID},
2478e855dd28SJason M. Bills                             {"EntryType", "Oem"},
2479e855dd28SJason M. Bills                             {"OemRecordFormat", "Crashdump URI"},
2480043a0536SJohnathan Mantey                             {"Message", std::move(crashdumpURI)},
2481043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2482e855dd28SJason M. Bills         };
2483e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
24845b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
24855b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2486043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2487e855dd28SJason M. Bills }
2488e855dd28SJason M. Bills 
2489424c4176SJason M. Bills class CrashdumpEntryCollection : public Node
24901da66f75SEd Tanous {
24911da66f75SEd Tanous   public:
249252cc112dSEd Tanous     CrashdumpEntryCollection(App& app) :
2493424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
24941da66f75SEd Tanous     {
24953946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
24963946028dSAppaRao Puli         // method for security reasons.
24971da66f75SEd Tanous         entityPrivileges = {
24983946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
24993946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2500e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2501e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2502e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2503e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
25041da66f75SEd Tanous     }
25051da66f75SEd Tanous 
25061da66f75SEd Tanous   private:
25071da66f75SEd Tanous     /**
25081da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
25091da66f75SEd Tanous      */
2510cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2511cb13a392SEd Tanous                const std::vector<std::string>&) override
25121da66f75SEd Tanous     {
2513e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
25141da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
25151da66f75SEd Tanous         // it has a duplicate entry for members
2516e1f26343SJason M. Bills         auto getLogEntriesCallback = [asyncResp](
2517e1f26343SJason M. Bills                                          const boost::system::error_code ec,
25181da66f75SEd Tanous                                          const std::vector<std::string>& resp) {
25191da66f75SEd Tanous             if (ec)
25201da66f75SEd Tanous             {
25211da66f75SEd Tanous                 if (ec.value() !=
25221da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
25231da66f75SEd Tanous                 {
25241da66f75SEd Tanous                     BMCWEB_LOG_DEBUG << "failed to get entries ec: "
25251da66f75SEd Tanous                                      << ec.message();
2526f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
25271da66f75SEd Tanous                     return;
25281da66f75SEd Tanous                 }
25291da66f75SEd Tanous             }
2530e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
25311da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
25320f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2533424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2534424c4176SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2535e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2536424c4176SJason M. Bills                 "Collection of Crashdump Entries";
2537e1f26343SJason M. Bills             nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2538e1f26343SJason M. Bills             logEntryArray = nlohmann::json::array();
2539e855dd28SJason M. Bills             std::vector<std::string> logIDs;
2540e855dd28SJason M. Bills             // Get the list of log entries and build up an empty array big
2541e855dd28SJason M. Bills             // enough to hold them
25421da66f75SEd Tanous             for (const std::string& objpath : resp)
25431da66f75SEd Tanous             {
2544e855dd28SJason M. Bills                 // Get the log ID
2545f23b7296SEd Tanous                 std::size_t lastPos = objpath.rfind('/');
2546e855dd28SJason M. Bills                 if (lastPos == std::string::npos)
25471da66f75SEd Tanous                 {
2548e855dd28SJason M. Bills                     continue;
25491da66f75SEd Tanous                 }
2550e855dd28SJason M. Bills                 logIDs.emplace_back(objpath.substr(lastPos + 1));
2551e855dd28SJason M. Bills 
2552e855dd28SJason M. Bills                 // Add a space for the log entry to the array
2553e855dd28SJason M. Bills                 logEntryArray.push_back({});
2554e855dd28SJason M. Bills             }
2555e855dd28SJason M. Bills             // Now go through and set up async calls to fill in the entries
2556e855dd28SJason M. Bills             size_t index = 0;
2557e855dd28SJason M. Bills             for (const std::string& logID : logIDs)
2558e855dd28SJason M. Bills             {
2559e855dd28SJason M. Bills                 // Add the log entry to the array
2560e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
25611da66f75SEd Tanous             }
2562e1f26343SJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
2563e1f26343SJason M. Bills                 logEntryArray.size();
25641da66f75SEd Tanous         };
25651da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
25661da66f75SEd Tanous             std::move(getLogEntriesCallback),
25671da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper",
25681da66f75SEd Tanous             "/xyz/openbmc_project/object_mapper",
25691da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
25705b61b5e8SJason M. Bills             std::array<const char*, 1>{crashdumpInterface});
25711da66f75SEd Tanous     }
25721da66f75SEd Tanous };
25731da66f75SEd Tanous 
2574424c4176SJason M. Bills class CrashdumpEntry : public Node
25751da66f75SEd Tanous {
25761da66f75SEd Tanous   public:
257752cc112dSEd Tanous     CrashdumpEntry(App& app) :
2578d53dd41fSJason M. Bills         Node(app,
2579424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/",
25801da66f75SEd Tanous              std::string())
25811da66f75SEd Tanous     {
25823946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
25833946028dSAppaRao Puli         // method for security reasons.
25841da66f75SEd Tanous         entityPrivileges = {
25853946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
25863946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2587e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2588e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2589e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2590e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
25911da66f75SEd Tanous     }
25921da66f75SEd Tanous 
25931da66f75SEd Tanous   private:
2594cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
25951da66f75SEd Tanous                const std::vector<std::string>& params) override
25961da66f75SEd Tanous     {
2597e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
25981da66f75SEd Tanous         if (params.size() != 1)
25991da66f75SEd Tanous         {
2600f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
26011da66f75SEd Tanous             return;
26021da66f75SEd Tanous         }
2603e855dd28SJason M. Bills         const std::string& logID = params[0];
2604e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
2605e855dd28SJason M. Bills     }
2606e855dd28SJason M. Bills };
2607e855dd28SJason M. Bills 
2608e855dd28SJason M. Bills class CrashdumpFile : public Node
2609e855dd28SJason M. Bills {
2610e855dd28SJason M. Bills   public:
261152cc112dSEd Tanous     CrashdumpFile(App& app) :
2612e855dd28SJason M. Bills         Node(app,
2613e855dd28SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/"
2614e855dd28SJason M. Bills              "<str>/",
2615e855dd28SJason M. Bills              std::string(), std::string())
2616e855dd28SJason M. Bills     {
26173946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
26183946028dSAppaRao Puli         // method for security reasons.
2619e855dd28SJason M. Bills         entityPrivileges = {
26203946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
26213946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2622e855dd28SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2623e855dd28SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2624e855dd28SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2625e855dd28SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2626e855dd28SJason M. Bills     }
2627e855dd28SJason M. Bills 
2628e855dd28SJason M. Bills   private:
2629cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
2630e855dd28SJason M. Bills                const std::vector<std::string>& params) override
2631e855dd28SJason M. Bills     {
2632e855dd28SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2633e855dd28SJason M. Bills         if (params.size() != 2)
2634e855dd28SJason M. Bills         {
2635e855dd28SJason M. Bills             messages::internalError(asyncResp->res);
2636e855dd28SJason M. Bills             return;
2637e855dd28SJason M. Bills         }
2638e855dd28SJason M. Bills         const std::string& logID = params[0];
2639e855dd28SJason M. Bills         const std::string& fileName = params[1];
2640e855dd28SJason M. Bills 
2641043a0536SJohnathan Mantey         auto getStoredLogCallback =
2642043a0536SJohnathan Mantey             [asyncResp, logID, fileName](
2643abf2add6SEd Tanous                 const boost::system::error_code ec,
2644043a0536SJohnathan Mantey                 const std::vector<std::pair<std::string, VariantType>>& resp) {
26451da66f75SEd Tanous                 if (ec)
26461da66f75SEd Tanous                 {
2647043a0536SJohnathan Mantey                     BMCWEB_LOG_DEBUG << "failed to get log ec: "
2648043a0536SJohnathan Mantey                                      << ec.message();
2649f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
26501da66f75SEd Tanous                     return;
26511da66f75SEd Tanous                 }
2652e855dd28SJason M. Bills 
2653043a0536SJohnathan Mantey                 std::string dbusFilename{};
2654043a0536SJohnathan Mantey                 std::string dbusTimestamp{};
2655043a0536SJohnathan Mantey                 std::string dbusFilepath{};
2656043a0536SJohnathan Mantey 
26572c70f800SEd Tanous                 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
2658043a0536SJohnathan Mantey                                          dbusFilepath);
2659043a0536SJohnathan Mantey 
2660043a0536SJohnathan Mantey                 if (dbusFilename.empty() || dbusTimestamp.empty() ||
2661043a0536SJohnathan Mantey                     dbusFilepath.empty())
26621da66f75SEd Tanous                 {
2663e855dd28SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, fileName);
26641da66f75SEd Tanous                     return;
26651da66f75SEd Tanous                 }
2666e855dd28SJason M. Bills 
2667043a0536SJohnathan Mantey                 // Verify the file name parameter is correct
2668043a0536SJohnathan Mantey                 if (fileName != dbusFilename)
2669043a0536SJohnathan Mantey                 {
2670043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2671043a0536SJohnathan Mantey                     return;
2672043a0536SJohnathan Mantey                 }
2673043a0536SJohnathan Mantey 
2674043a0536SJohnathan Mantey                 if (!std::filesystem::exists(dbusFilepath))
2675043a0536SJohnathan Mantey                 {
2676043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2677043a0536SJohnathan Mantey                     return;
2678043a0536SJohnathan Mantey                 }
2679043a0536SJohnathan Mantey                 std::ifstream ifs(dbusFilepath, std::ios::in |
2680043a0536SJohnathan Mantey                                                     std::ios::binary |
2681043a0536SJohnathan Mantey                                                     std::ios::ate);
2682043a0536SJohnathan Mantey                 std::ifstream::pos_type fileSize = ifs.tellg();
2683043a0536SJohnathan Mantey                 if (fileSize < 0)
2684043a0536SJohnathan Mantey                 {
2685043a0536SJohnathan Mantey                     messages::generalError(asyncResp->res);
2686043a0536SJohnathan Mantey                     return;
2687043a0536SJohnathan Mantey                 }
2688043a0536SJohnathan Mantey                 ifs.seekg(0, std::ios::beg);
2689043a0536SJohnathan Mantey 
2690043a0536SJohnathan Mantey                 auto crashData = std::make_unique<char[]>(
2691043a0536SJohnathan Mantey                     static_cast<unsigned int>(fileSize));
2692043a0536SJohnathan Mantey 
2693043a0536SJohnathan Mantey                 ifs.read(crashData.get(), static_cast<int>(fileSize));
2694043a0536SJohnathan Mantey 
2695043a0536SJohnathan Mantey                 // The cast to std::string is intentional in order to use the
2696043a0536SJohnathan Mantey                 // assign() that applies move mechanics
2697043a0536SJohnathan Mantey                 asyncResp->res.body().assign(
2698043a0536SJohnathan Mantey                     static_cast<std::string>(crashData.get()));
2699043a0536SJohnathan Mantey 
2700043a0536SJohnathan Mantey                 // Configure this to be a file download when accessed from
2701043a0536SJohnathan Mantey                 // a browser
2702e855dd28SJason M. Bills                 asyncResp->res.addHeader("Content-Disposition", "attachment");
27031da66f75SEd Tanous             };
27041da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
27055b61b5e8SJason M. Bills             std::move(getStoredLogCallback), crashdumpObject,
27065b61b5e8SJason M. Bills             crashdumpPath + std::string("/") + logID,
2707043a0536SJohnathan Mantey             "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
27081da66f75SEd Tanous     }
27091da66f75SEd Tanous };
27101da66f75SEd Tanous 
2711424c4176SJason M. Bills class OnDemandCrashdump : public Node
27121da66f75SEd Tanous {
27131da66f75SEd Tanous   public:
271452cc112dSEd Tanous     OnDemandCrashdump(App& app) :
2715424c4176SJason M. Bills         Node(app,
2716424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2717424c4176SJason M. Bills              "Crashdump.OnDemand/")
27181da66f75SEd Tanous     {
27193946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
27203946028dSAppaRao Puli         // method for security reasons.
27211da66f75SEd Tanous         entityPrivileges = {
27223946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
27233946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
27243946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
27253946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
27263946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
27273946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
27281da66f75SEd Tanous     }
27291da66f75SEd Tanous 
27301da66f75SEd Tanous   private:
27311da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
2732cb13a392SEd Tanous                 const std::vector<std::string>&) override
27331da66f75SEd Tanous     {
2734e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
27351da66f75SEd Tanous 
2736fe306728SJames Feist         auto generateonDemandLogCallback = [asyncResp,
2737fe306728SJames Feist                                             req](const boost::system::error_code
273846229577SJames Feist                                                      ec,
2739cb13a392SEd Tanous                                                  const std::string&) {
27401da66f75SEd Tanous             if (ec)
27411da66f75SEd Tanous             {
274246229577SJames Feist                 if (ec.value() == boost::system::errc::operation_not_supported)
27431da66f75SEd Tanous                 {
2744f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
27451da66f75SEd Tanous                 }
27464363d3b2SJason M. Bills                 else if (ec.value() ==
27474363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
27484363d3b2SJason M. Bills                 {
27494363d3b2SJason M. Bills                     messages::serviceTemporarilyUnavailable(asyncResp->res,
27504363d3b2SJason M. Bills                                                             "60");
27514363d3b2SJason M. Bills                 }
27521da66f75SEd Tanous                 else
27531da66f75SEd Tanous                 {
2754f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
27551da66f75SEd Tanous                 }
27561da66f75SEd Tanous                 return;
27571da66f75SEd Tanous             }
275846229577SJames Feist             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
275966afe4faSJames Feist                 [](boost::system::error_code err, sdbusplus::message::message&,
276066afe4faSJames Feist                    const std::shared_ptr<task::TaskData>& taskData) {
276166afe4faSJames Feist                     if (!err)
276266afe4faSJames Feist                     {
2763e5d5006bSJames Feist                         taskData->messages.emplace_back(
2764e5d5006bSJames Feist                             messages::taskCompletedOK(
2765e5d5006bSJames Feist                                 std::to_string(taskData->index)));
2766831d6b09SJames Feist                         taskData->state = "Completed";
276766afe4faSJames Feist                     }
276832898ceaSJames Feist                     return task::completed;
276966afe4faSJames Feist                 },
277046229577SJames Feist                 "type='signal',interface='org.freedesktop.DBus.Properties',"
277146229577SJames Feist                 "member='PropertiesChanged',arg0namespace='com.intel."
277246229577SJames Feist                 "crashdump'");
277346229577SJames Feist             task->startTimer(std::chrono::minutes(5));
277446229577SJames Feist             task->populateResp(asyncResp->res);
2775fe306728SJames Feist             task->payload.emplace(req);
27761da66f75SEd Tanous         };
27771da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
27785b61b5e8SJason M. Bills             std::move(generateonDemandLogCallback), crashdumpObject,
27795b61b5e8SJason M. Bills             crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog");
27801da66f75SEd Tanous     }
27811da66f75SEd Tanous };
27821da66f75SEd Tanous 
27836eda7685SKenny L. Ku class TelemetryCrashdump : public Node
27846eda7685SKenny L. Ku {
27856eda7685SKenny L. Ku   public:
278652cc112dSEd Tanous     TelemetryCrashdump(App& app) :
27876eda7685SKenny L. Ku         Node(app,
27886eda7685SKenny L. Ku              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
27896eda7685SKenny L. Ku              "Crashdump.Telemetry/")
27906eda7685SKenny L. Ku     {
27916eda7685SKenny L. Ku         // Note: Deviated from redfish privilege registry for GET & HEAD
27926eda7685SKenny L. Ku         // method for security reasons.
27936eda7685SKenny L. Ku         entityPrivileges = {
27946eda7685SKenny L. Ku             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
27956eda7685SKenny L. Ku             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
27966eda7685SKenny L. Ku             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
27976eda7685SKenny L. Ku             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
27986eda7685SKenny L. Ku             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
27996eda7685SKenny L. Ku             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
28006eda7685SKenny L. Ku     }
28016eda7685SKenny L. Ku 
28026eda7685SKenny L. Ku   private:
28036eda7685SKenny L. Ku     void doPost(crow::Response& res, const crow::Request& req,
2804cb13a392SEd Tanous                 const std::vector<std::string>&) override
28056eda7685SKenny L. Ku     {
28066eda7685SKenny L. Ku         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
28076eda7685SKenny L. Ku 
28086eda7685SKenny L. Ku         auto generateTelemetryLogCallback = [asyncResp, req](
28096eda7685SKenny L. Ku                                                 const boost::system::error_code
28106eda7685SKenny L. Ku                                                     ec,
2811cb13a392SEd Tanous                                                 const std::string&) {
28126eda7685SKenny L. Ku             if (ec)
28136eda7685SKenny L. Ku             {
28146eda7685SKenny L. Ku                 if (ec.value() == boost::system::errc::operation_not_supported)
28156eda7685SKenny L. Ku                 {
28166eda7685SKenny L. Ku                     messages::resourceInStandby(asyncResp->res);
28176eda7685SKenny L. Ku                 }
28186eda7685SKenny L. Ku                 else if (ec.value() ==
28196eda7685SKenny L. Ku                          boost::system::errc::device_or_resource_busy)
28206eda7685SKenny L. Ku                 {
28216eda7685SKenny L. Ku                     messages::serviceTemporarilyUnavailable(asyncResp->res,
28226eda7685SKenny L. Ku                                                             "60");
28236eda7685SKenny L. Ku                 }
28246eda7685SKenny L. Ku                 else
28256eda7685SKenny L. Ku                 {
28266eda7685SKenny L. Ku                     messages::internalError(asyncResp->res);
28276eda7685SKenny L. Ku                 }
28286eda7685SKenny L. Ku                 return;
28296eda7685SKenny L. Ku             }
28306eda7685SKenny L. Ku             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
28316eda7685SKenny L. Ku                 [](boost::system::error_code err, sdbusplus::message::message&,
28326eda7685SKenny L. Ku                    const std::shared_ptr<task::TaskData>& taskData) {
28336eda7685SKenny L. Ku                     if (!err)
28346eda7685SKenny L. Ku                     {
28356eda7685SKenny L. Ku                         taskData->messages.emplace_back(
28366eda7685SKenny L. Ku                             messages::taskCompletedOK(
28376eda7685SKenny L. Ku                                 std::to_string(taskData->index)));
28386eda7685SKenny L. Ku                         taskData->state = "Completed";
28396eda7685SKenny L. Ku                     }
28406eda7685SKenny L. Ku                     return task::completed;
28416eda7685SKenny L. Ku                 },
28426eda7685SKenny L. Ku                 "type='signal',interface='org.freedesktop.DBus.Properties',"
28436eda7685SKenny L. Ku                 "member='PropertiesChanged',arg0namespace='com.intel."
28446eda7685SKenny L. Ku                 "crashdump'");
28456eda7685SKenny L. Ku             task->startTimer(std::chrono::minutes(5));
28466eda7685SKenny L. Ku             task->populateResp(asyncResp->res);
28476eda7685SKenny L. Ku             task->payload.emplace(req);
28486eda7685SKenny L. Ku         };
28496eda7685SKenny L. Ku         crow::connections::systemBus->async_method_call(
28506eda7685SKenny L. Ku             std::move(generateTelemetryLogCallback), crashdumpObject,
28516eda7685SKenny L. Ku             crashdumpPath, crashdumpTelemetryInterface, "GenerateTelemetryLog");
28526eda7685SKenny L. Ku     }
28536eda7685SKenny L. Ku };
28546eda7685SKenny L. Ku 
2855e1f26343SJason M. Bills class SendRawPECI : public Node
28561da66f75SEd Tanous {
28571da66f75SEd Tanous   public:
285852cc112dSEd Tanous     SendRawPECI(App& app) :
2859424c4176SJason M. Bills         Node(app,
2860424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2861424c4176SJason M. Bills              "Crashdump.SendRawPeci/")
28621da66f75SEd Tanous     {
28633946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
28643946028dSAppaRao Puli         // method for security reasons.
28651da66f75SEd Tanous         entityPrivileges = {
28661da66f75SEd Tanous             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
28671da66f75SEd Tanous             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
28681da66f75SEd Tanous             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
28691da66f75SEd Tanous             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
28701da66f75SEd Tanous             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
28711da66f75SEd Tanous             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
28721da66f75SEd Tanous     }
28731da66f75SEd Tanous 
28741da66f75SEd Tanous   private:
28751da66f75SEd Tanous     void doPost(crow::Response& res, const crow::Request& req,
2876cb13a392SEd Tanous                 const std::vector<std::string>&) override
28771da66f75SEd Tanous     {
2878e1f26343SJason M. Bills         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
28798724c297SKarthick Sundarrajan         std::vector<std::vector<uint8_t>> peciCommands;
28808724c297SKarthick Sundarrajan 
28818724c297SKarthick Sundarrajan         if (!json_util::readJson(req, res, "PECICommands", peciCommands))
28828724c297SKarthick Sundarrajan         {
28838724c297SKarthick Sundarrajan             return;
28848724c297SKarthick Sundarrajan         }
28858724c297SKarthick Sundarrajan         uint32_t idx = 0;
28868724c297SKarthick Sundarrajan         for (auto const& cmd : peciCommands)
28878724c297SKarthick Sundarrajan         {
28888724c297SKarthick Sundarrajan             if (cmd.size() < 3)
28898724c297SKarthick Sundarrajan             {
28908724c297SKarthick Sundarrajan                 std::string s("[");
28918724c297SKarthick Sundarrajan                 for (auto const& val : cmd)
28928724c297SKarthick Sundarrajan                 {
28938724c297SKarthick Sundarrajan                     if (val != *cmd.begin())
28948724c297SKarthick Sundarrajan                     {
28958724c297SKarthick Sundarrajan                         s += ",";
28968724c297SKarthick Sundarrajan                     }
28978724c297SKarthick Sundarrajan                     s += std::to_string(val);
28988724c297SKarthick Sundarrajan                 }
28998724c297SKarthick Sundarrajan                 s += "]";
29008724c297SKarthick Sundarrajan                 messages::actionParameterValueFormatError(
29018724c297SKarthick Sundarrajan                     res, s, "PECICommands[" + std::to_string(idx) + "]",
29028724c297SKarthick Sundarrajan                     "SendRawPeci");
29038724c297SKarthick Sundarrajan                 return;
29048724c297SKarthick Sundarrajan             }
29058724c297SKarthick Sundarrajan             idx++;
29068724c297SKarthick Sundarrajan         }
29071da66f75SEd Tanous         // Callback to return the Raw PECI response
2908e1f26343SJason M. Bills         auto sendRawPECICallback =
2909e1f26343SJason M. Bills             [asyncResp](const boost::system::error_code ec,
29108724c297SKarthick Sundarrajan                         const std::vector<std::vector<uint8_t>>& resp) {
29111da66f75SEd Tanous                 if (ec)
29121da66f75SEd Tanous                 {
29138724c297SKarthick Sundarrajan                     BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: "
29141da66f75SEd Tanous                                      << ec.message();
2915f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
29161da66f75SEd Tanous                     return;
29171da66f75SEd Tanous                 }
2918e1f26343SJason M. Bills                 asyncResp->res.jsonValue = {{"Name", "PECI Command Response"},
29191da66f75SEd Tanous                                             {"PECIResponse", resp}};
29201da66f75SEd Tanous             };
29211da66f75SEd Tanous         // Call the SendRawPECI command with the provided data
29221da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
29235b61b5e8SJason M. Bills             std::move(sendRawPECICallback), crashdumpObject, crashdumpPath,
29248724c297SKarthick Sundarrajan             crashdumpRawPECIInterface, "SendRawPeci", peciCommands);
29251da66f75SEd Tanous     }
29261da66f75SEd Tanous };
29271da66f75SEd Tanous 
2928cb92c03bSAndrew Geissler /**
2929cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
2930cb92c03bSAndrew Geissler  */
2931cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node
2932cb92c03bSAndrew Geissler {
2933cb92c03bSAndrew Geissler   public:
293452cc112dSEd Tanous     DBusLogServiceActionsClear(App& app) :
2935cb92c03bSAndrew Geissler         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
29367af91514SGunnar Mills                   "LogService.ClearLog/")
2937cb92c03bSAndrew Geissler     {
2938cb92c03bSAndrew Geissler         entityPrivileges = {
2939cb92c03bSAndrew Geissler             {boost::beast::http::verb::get, {{"Login"}}},
2940cb92c03bSAndrew Geissler             {boost::beast::http::verb::head, {{"Login"}}},
2941cb92c03bSAndrew Geissler             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2942cb92c03bSAndrew Geissler             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2943cb92c03bSAndrew Geissler             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2944cb92c03bSAndrew Geissler             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2945cb92c03bSAndrew Geissler     }
2946cb92c03bSAndrew Geissler 
2947cb92c03bSAndrew Geissler   private:
2948cb92c03bSAndrew Geissler     /**
2949cb92c03bSAndrew Geissler      * Function handles POST method request.
2950cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
2951cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
2952cb92c03bSAndrew Geissler      */
2953cb13a392SEd Tanous     void doPost(crow::Response& res, const crow::Request&,
2954cb13a392SEd Tanous                 const std::vector<std::string>&) override
2955cb92c03bSAndrew Geissler     {
2956cb92c03bSAndrew Geissler         BMCWEB_LOG_DEBUG << "Do delete all entries.";
2957cb92c03bSAndrew Geissler 
2958cb92c03bSAndrew Geissler         auto asyncResp = std::make_shared<AsyncResp>(res);
2959cb92c03bSAndrew Geissler         // Process response from Logging service.
29602c70f800SEd Tanous         auto respHandler = [asyncResp](const boost::system::error_code ec) {
2961cb92c03bSAndrew Geissler             BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
2962cb92c03bSAndrew Geissler             if (ec)
2963cb92c03bSAndrew Geissler             {
2964cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
2965cb92c03bSAndrew Geissler                 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
2966cb92c03bSAndrew Geissler                 asyncResp->res.result(
2967cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
2968cb92c03bSAndrew Geissler                 return;
2969cb92c03bSAndrew Geissler             }
2970cb92c03bSAndrew Geissler 
2971cb92c03bSAndrew Geissler             asyncResp->res.result(boost::beast::http::status::no_content);
2972cb92c03bSAndrew Geissler         };
2973cb92c03bSAndrew Geissler 
2974cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
2975cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
29762c70f800SEd Tanous             respHandler, "xyz.openbmc_project.Logging",
2977cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
2978cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
2979cb92c03bSAndrew Geissler     }
2980cb92c03bSAndrew Geissler };
2981a3316fc6SZhikuiRen 
2982a3316fc6SZhikuiRen /****************************************************
2983a3316fc6SZhikuiRen  * Redfish PostCode interfaces
2984a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
2985a3316fc6SZhikuiRen  ******************************************************/
2986a3316fc6SZhikuiRen class PostCodesLogService : public Node
2987a3316fc6SZhikuiRen {
2988a3316fc6SZhikuiRen   public:
298952cc112dSEd Tanous     PostCodesLogService(App& app) :
2990a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
2991a3316fc6SZhikuiRen     {
2992a3316fc6SZhikuiRen         entityPrivileges = {
2993a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
2994a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
2995a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2996a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2997a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2998a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2999a3316fc6SZhikuiRen     }
3000a3316fc6SZhikuiRen 
3001a3316fc6SZhikuiRen   private:
3002cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
3003cb13a392SEd Tanous                const std::vector<std::string>&) override
3004a3316fc6SZhikuiRen     {
3005a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3006a3316fc6SZhikuiRen 
3007a3316fc6SZhikuiRen         asyncResp->res.jsonValue = {
3008a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"},
3009a3316fc6SZhikuiRen             {"@odata.type", "#LogService.v1_1_0.LogService"},
3010a3316fc6SZhikuiRen             {"Name", "POST Code Log Service"},
3011a3316fc6SZhikuiRen             {"Description", "POST Code Log Service"},
3012a3316fc6SZhikuiRen             {"Id", "BIOS POST Code Log"},
3013a3316fc6SZhikuiRen             {"OverWritePolicy", "WrapsWhenFull"},
3014a3316fc6SZhikuiRen             {"Entries",
3015a3316fc6SZhikuiRen              {{"@odata.id",
3016a3316fc6SZhikuiRen                "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
3017a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
3018a3316fc6SZhikuiRen             {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/"
3019a3316fc6SZhikuiRen                        "Actions/LogService.ClearLog"}};
3020a3316fc6SZhikuiRen     }
3021a3316fc6SZhikuiRen };
3022a3316fc6SZhikuiRen 
3023a3316fc6SZhikuiRen class PostCodesClear : public Node
3024a3316fc6SZhikuiRen {
3025a3316fc6SZhikuiRen   public:
302652cc112dSEd Tanous     PostCodesClear(App& app) :
3027a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
3028a3316fc6SZhikuiRen                   "LogService.ClearLog/")
3029a3316fc6SZhikuiRen     {
3030a3316fc6SZhikuiRen         entityPrivileges = {
3031a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3032a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
30333946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
30343946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
30353946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
30363946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
3037a3316fc6SZhikuiRen     }
3038a3316fc6SZhikuiRen 
3039a3316fc6SZhikuiRen   private:
3040cb13a392SEd Tanous     void doPost(crow::Response& res, const crow::Request&,
3041cb13a392SEd Tanous                 const std::vector<std::string>&) override
3042a3316fc6SZhikuiRen     {
3043a3316fc6SZhikuiRen         BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
3044a3316fc6SZhikuiRen 
3045a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3046a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
3047a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
3048a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec) {
3049a3316fc6SZhikuiRen                 if (ec)
3050a3316fc6SZhikuiRen                 {
3051a3316fc6SZhikuiRen                     // TODO Handle for specific error code
3052a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR
3053a3316fc6SZhikuiRen                         << "doClearPostCodes resp_handler got error " << ec;
3054a3316fc6SZhikuiRen                     asyncResp->res.result(
3055a3316fc6SZhikuiRen                         boost::beast::http::status::internal_server_error);
3056a3316fc6SZhikuiRen                     messages::internalError(asyncResp->res);
3057a3316fc6SZhikuiRen                     return;
3058a3316fc6SZhikuiRen                 }
3059a3316fc6SZhikuiRen             },
3060a3316fc6SZhikuiRen             "xyz.openbmc_project.State.Boot.PostCode",
3061a3316fc6SZhikuiRen             "/xyz/openbmc_project/State/Boot/PostCode",
3062a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3063a3316fc6SZhikuiRen     }
3064a3316fc6SZhikuiRen };
3065a3316fc6SZhikuiRen 
3066a3316fc6SZhikuiRen static void fillPostCodeEntry(
3067b5a76932SEd Tanous     const std::shared_ptr<AsyncResp>& aResp,
3068a3316fc6SZhikuiRen     const boost::container::flat_map<uint64_t, uint64_t>& postcode,
3069a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
3070a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
3071a3316fc6SZhikuiRen {
3072a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
3073a3316fc6SZhikuiRen     const message_registries::Message* message =
3074a3316fc6SZhikuiRen         message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode");
3075a3316fc6SZhikuiRen 
3076a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
3077a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
3078a3316fc6SZhikuiRen 
3079a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
3080a3316fc6SZhikuiRen     for (const std::pair<uint64_t, uint64_t>& code : postcode)
3081a3316fc6SZhikuiRen     {
3082a3316fc6SZhikuiRen         currentCodeIndex++;
3083a3316fc6SZhikuiRen         std::string postcodeEntryID =
3084a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
3085a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
3086a3316fc6SZhikuiRen 
3087a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
3088a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
3089a3316fc6SZhikuiRen 
3090a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
3091a3316fc6SZhikuiRen         { // already incremented
3092a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
3093a3316fc6SZhikuiRen         }
3094a3316fc6SZhikuiRen         else
3095a3316fc6SZhikuiRen         {
3096a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
3097a3316fc6SZhikuiRen         }
3098a3316fc6SZhikuiRen 
3099a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
3100a3316fc6SZhikuiRen         // not fall between top and skip
3101a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
3102a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
3103a3316fc6SZhikuiRen         {
3104a3316fc6SZhikuiRen             continue;
3105a3316fc6SZhikuiRen         }
3106a3316fc6SZhikuiRen 
31074e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
3108a3316fc6SZhikuiRen         // currentIndex
3109a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3110a3316fc6SZhikuiRen         {
3111a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
3112a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
3113a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
3114a3316fc6SZhikuiRen             continue;
3115a3316fc6SZhikuiRen         }
3116a3316fc6SZhikuiRen 
3117a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
3118a3316fc6SZhikuiRen         // index
3119a3316fc6SZhikuiRen 
3120a3316fc6SZhikuiRen         // Get the Created time from the timestamp
3121a3316fc6SZhikuiRen         std::string entryTimeStr;
31229c620e21SAsmitha Karunanithi         entryTimeStr = crow::utility::getDateTime(
31239c620e21SAsmitha Karunanithi             static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000));
3124a3316fc6SZhikuiRen 
3125a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3126a3316fc6SZhikuiRen         std::ostringstream hexCode;
3127a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
3128a3316fc6SZhikuiRen                 << code.second;
3129a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
3130a3316fc6SZhikuiRen         // Set Fixed -Point Notation
3131a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
3132a3316fc6SZhikuiRen         // Set precision to 4 digits
3133a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
3134a3316fc6SZhikuiRen         // Add double to stream
3135a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
3136a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
3137a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
3138a3316fc6SZhikuiRen 
3139a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
3140a3316fc6SZhikuiRen         std::string msg;
3141a3316fc6SZhikuiRen         if (message != nullptr)
3142a3316fc6SZhikuiRen         {
3143a3316fc6SZhikuiRen             msg = message->message;
3144a3316fc6SZhikuiRen 
3145a3316fc6SZhikuiRen             // fill in this post code value
3146a3316fc6SZhikuiRen             int i = 0;
3147a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
3148a3316fc6SZhikuiRen             {
3149a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
3150a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
3151a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
3152a3316fc6SZhikuiRen                 {
3153a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
3154a3316fc6SZhikuiRen                 }
3155a3316fc6SZhikuiRen             }
3156a3316fc6SZhikuiRen         }
3157a3316fc6SZhikuiRen 
3158d4342a92STim Lee         // Get Severity template from message registry
3159d4342a92STim Lee         std::string severity;
3160d4342a92STim Lee         if (message != nullptr)
3161d4342a92STim Lee         {
3162d4342a92STim Lee             severity = message->severity;
3163d4342a92STim Lee         }
3164d4342a92STim Lee 
3165a3316fc6SZhikuiRen         // add to AsyncResp
3166a3316fc6SZhikuiRen         logEntryArray.push_back({});
3167a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
3168743e9a1fSGunnar Mills         bmcLogEntry = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
3169a3316fc6SZhikuiRen                        {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
3170a3316fc6SZhikuiRen                                      "PostCodes/Entries/" +
3171a3316fc6SZhikuiRen                                          postcodeEntryID},
3172a3316fc6SZhikuiRen                        {"Name", "POST Code Log Entry"},
3173a3316fc6SZhikuiRen                        {"Id", postcodeEntryID},
3174a3316fc6SZhikuiRen                        {"Message", std::move(msg)},
3175a3316fc6SZhikuiRen                        {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"},
3176a3316fc6SZhikuiRen                        {"MessageArgs", std::move(messageArgs)},
3177a3316fc6SZhikuiRen                        {"EntryType", "Event"},
3178a3316fc6SZhikuiRen                        {"Severity", std::move(severity)},
31799c620e21SAsmitha Karunanithi                        {"Created", entryTimeStr}};
3180a3316fc6SZhikuiRen     }
3181a3316fc6SZhikuiRen }
3182a3316fc6SZhikuiRen 
3183b5a76932SEd Tanous static void getPostCodeForEntry(const std::shared_ptr<AsyncResp>& aResp,
3184a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
3185a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
3186a3316fc6SZhikuiRen {
3187a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3188a3316fc6SZhikuiRen         [aResp, bootIndex, codeIndex](
3189a3316fc6SZhikuiRen             const boost::system::error_code ec,
3190a3316fc6SZhikuiRen             const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
3191a3316fc6SZhikuiRen             if (ec)
3192a3316fc6SZhikuiRen             {
3193a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3194a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3195a3316fc6SZhikuiRen                 return;
3196a3316fc6SZhikuiRen             }
3197a3316fc6SZhikuiRen 
3198a3316fc6SZhikuiRen             // skip the empty postcode boots
3199a3316fc6SZhikuiRen             if (postcode.empty())
3200a3316fc6SZhikuiRen             {
3201a3316fc6SZhikuiRen                 return;
3202a3316fc6SZhikuiRen             }
3203a3316fc6SZhikuiRen 
3204a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
3205a3316fc6SZhikuiRen 
3206a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
3207a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
3208a3316fc6SZhikuiRen         },
3209a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3210a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3211a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3212a3316fc6SZhikuiRen         bootIndex);
3213a3316fc6SZhikuiRen }
3214a3316fc6SZhikuiRen 
3215b5a76932SEd Tanous static void getPostCodeForBoot(const std::shared_ptr<AsyncResp>& aResp,
3216a3316fc6SZhikuiRen                                const uint16_t bootIndex,
3217a3316fc6SZhikuiRen                                const uint16_t bootCount,
3218a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
3219a3316fc6SZhikuiRen                                const uint64_t top)
3220a3316fc6SZhikuiRen {
3221a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3222a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
3223a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3224a3316fc6SZhikuiRen               const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
3225a3316fc6SZhikuiRen             if (ec)
3226a3316fc6SZhikuiRen             {
3227a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3228a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3229a3316fc6SZhikuiRen                 return;
3230a3316fc6SZhikuiRen             }
3231a3316fc6SZhikuiRen 
3232a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
3233a3316fc6SZhikuiRen             if (!postcode.empty())
3234a3316fc6SZhikuiRen             {
3235a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
3236a3316fc6SZhikuiRen 
3237a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
3238a3316fc6SZhikuiRen                 {
3239a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
3240a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
3241a3316fc6SZhikuiRen                     uint64_t thisBootTop =
3242a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
3243a3316fc6SZhikuiRen 
3244a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3245a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
3246a3316fc6SZhikuiRen                 }
3247a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
3248a3316fc6SZhikuiRen             }
3249a3316fc6SZhikuiRen 
3250a3316fc6SZhikuiRen             // continue to previous bootIndex
3251a3316fc6SZhikuiRen             if (bootIndex < bootCount)
3252a3316fc6SZhikuiRen             {
3253a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3254a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
3255a3316fc6SZhikuiRen             }
3256a3316fc6SZhikuiRen             else
3257a3316fc6SZhikuiRen             {
3258a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
3259a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3260a3316fc6SZhikuiRen                     "Entries?$skip=" +
3261a3316fc6SZhikuiRen                     std::to_string(skip + top);
3262a3316fc6SZhikuiRen             }
3263a3316fc6SZhikuiRen         },
3264a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3265a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3266a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3267a3316fc6SZhikuiRen         bootIndex);
3268a3316fc6SZhikuiRen }
3269a3316fc6SZhikuiRen 
3270b5a76932SEd Tanous static void getCurrentBootNumber(const std::shared_ptr<AsyncResp>& aResp,
3271a3316fc6SZhikuiRen                                  const uint64_t skip, const uint64_t top)
3272a3316fc6SZhikuiRen {
3273a3316fc6SZhikuiRen     uint64_t entryCount = 0;
3274a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3275a3316fc6SZhikuiRen         [aResp, entryCount, skip,
3276a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3277a3316fc6SZhikuiRen               const std::variant<uint16_t>& bootCount) {
3278a3316fc6SZhikuiRen             if (ec)
3279a3316fc6SZhikuiRen             {
3280a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3281a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3282a3316fc6SZhikuiRen                 return;
3283a3316fc6SZhikuiRen             }
3284a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
3285a3316fc6SZhikuiRen             if (pVal)
3286a3316fc6SZhikuiRen             {
3287a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
3288a3316fc6SZhikuiRen             }
3289a3316fc6SZhikuiRen             else
3290a3316fc6SZhikuiRen             {
3291a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
3292a3316fc6SZhikuiRen             }
3293a3316fc6SZhikuiRen         },
3294a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode",
3295a3316fc6SZhikuiRen         "/xyz/openbmc_project/State/Boot/PostCode",
3296a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
3297a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
3298a3316fc6SZhikuiRen }
3299a3316fc6SZhikuiRen 
3300a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node
3301a3316fc6SZhikuiRen {
3302a3316fc6SZhikuiRen   public:
330352cc112dSEd Tanous     PostCodesEntryCollection(App& app) :
3304a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3305a3316fc6SZhikuiRen     {
3306a3316fc6SZhikuiRen         entityPrivileges = {
3307a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3308a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3309a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3310a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3311a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3312a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3313a3316fc6SZhikuiRen     }
3314a3316fc6SZhikuiRen 
3315a3316fc6SZhikuiRen   private:
3316a3316fc6SZhikuiRen     void doGet(crow::Response& res, const crow::Request& req,
3317cb13a392SEd Tanous                const std::vector<std::string>&) override
3318a3316fc6SZhikuiRen     {
3319a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3320a3316fc6SZhikuiRen 
3321a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
3322a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
3323a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3324a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3325a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3326a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3327a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3328a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3329a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3330a3316fc6SZhikuiRen 
3331a3316fc6SZhikuiRen         uint64_t skip = 0;
3332a3316fc6SZhikuiRen         uint64_t top = maxEntriesPerPage; // Show max entries by default
3333a3316fc6SZhikuiRen         if (!getSkipParam(asyncResp->res, req, skip))
3334a3316fc6SZhikuiRen         {
3335a3316fc6SZhikuiRen             return;
3336a3316fc6SZhikuiRen         }
3337a3316fc6SZhikuiRen         if (!getTopParam(asyncResp->res, req, top))
3338a3316fc6SZhikuiRen         {
3339a3316fc6SZhikuiRen             return;
3340a3316fc6SZhikuiRen         }
3341a3316fc6SZhikuiRen         getCurrentBootNumber(asyncResp, skip, top);
3342a3316fc6SZhikuiRen     }
3343a3316fc6SZhikuiRen };
3344a3316fc6SZhikuiRen 
3345a3316fc6SZhikuiRen class PostCodesEntry : public Node
3346a3316fc6SZhikuiRen {
3347a3316fc6SZhikuiRen   public:
334852cc112dSEd Tanous     PostCodesEntry(App& app) :
3349a3316fc6SZhikuiRen         Node(app,
3350a3316fc6SZhikuiRen              "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/",
3351a3316fc6SZhikuiRen              std::string())
3352a3316fc6SZhikuiRen     {
3353a3316fc6SZhikuiRen         entityPrivileges = {
3354a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3355a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3356a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3357a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3358a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3359a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3360a3316fc6SZhikuiRen     }
3361a3316fc6SZhikuiRen 
3362a3316fc6SZhikuiRen   private:
3363cb13a392SEd Tanous     void doGet(crow::Response& res, const crow::Request&,
3364a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3365a3316fc6SZhikuiRen     {
3366a3316fc6SZhikuiRen         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3367a3316fc6SZhikuiRen         if (params.size() != 1)
3368a3316fc6SZhikuiRen         {
3369a3316fc6SZhikuiRen             messages::internalError(asyncResp->res);
3370a3316fc6SZhikuiRen             return;
3371a3316fc6SZhikuiRen         }
3372a3316fc6SZhikuiRen 
3373a3316fc6SZhikuiRen         const std::string& targetID = params[0];
3374a3316fc6SZhikuiRen 
3375a3316fc6SZhikuiRen         size_t bootPos = targetID.find('B');
3376a3316fc6SZhikuiRen         if (bootPos == std::string::npos)
3377a3316fc6SZhikuiRen         {
3378a3316fc6SZhikuiRen             // Requested ID was not found
3379a3316fc6SZhikuiRen             messages::resourceMissingAtURI(asyncResp->res, targetID);
3380a3316fc6SZhikuiRen             return;
3381a3316fc6SZhikuiRen         }
3382a3316fc6SZhikuiRen         std::string_view bootIndexStr(targetID);
3383a3316fc6SZhikuiRen         bootIndexStr.remove_prefix(bootPos + 1);
3384a3316fc6SZhikuiRen         uint16_t bootIndex = 0;
3385a3316fc6SZhikuiRen         uint64_t codeIndex = 0;
3386a3316fc6SZhikuiRen         size_t dashPos = bootIndexStr.find('-');
3387a3316fc6SZhikuiRen 
3388a3316fc6SZhikuiRen         if (dashPos == std::string::npos)
3389a3316fc6SZhikuiRen         {
3390a3316fc6SZhikuiRen             return;
3391a3316fc6SZhikuiRen         }
3392a3316fc6SZhikuiRen         std::string_view codeIndexStr(bootIndexStr);
3393a3316fc6SZhikuiRen         bootIndexStr.remove_suffix(dashPos);
3394a3316fc6SZhikuiRen         codeIndexStr.remove_prefix(dashPos + 1);
3395a3316fc6SZhikuiRen 
3396a3316fc6SZhikuiRen         bootIndex = static_cast<uint16_t>(
339723a21a1cSEd Tanous             strtoul(std::string(bootIndexStr).c_str(), nullptr, 0));
339823a21a1cSEd Tanous         codeIndex = strtoul(std::string(codeIndexStr).c_str(), nullptr, 0);
3399a3316fc6SZhikuiRen         if (bootIndex == 0 || codeIndex == 0)
3400a3316fc6SZhikuiRen         {
3401a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
3402a3316fc6SZhikuiRen                              << params[0];
3403a3316fc6SZhikuiRen         }
3404a3316fc6SZhikuiRen 
3405a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
3406a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3407a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/"
3408a3316fc6SZhikuiRen             "Entries";
3409a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3410a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3411a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3412a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3413a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3414a3316fc6SZhikuiRen 
3415a3316fc6SZhikuiRen         getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
3416a3316fc6SZhikuiRen     }
3417a3316fc6SZhikuiRen };
3418a3316fc6SZhikuiRen 
34191da66f75SEd Tanous } // namespace redfish
3420