xref: /openbmc/bmcweb/features/redfish/lib/log_services.hpp (revision 4a0bf539728cada806fc7a16a208edc6332bdb86)
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>
25400fd1fbSAdriana Kobylak #include <unistd.h>
26e1f26343SJason M. Bills 
27400fd1fbSAdriana Kobylak #include <boost/algorithm/string/replace.hpp>
284851d45dSJason M. Bills #include <boost/algorithm/string/split.hpp>
294851d45dSJason M. Bills #include <boost/beast/core/span.hpp>
30400fd1fbSAdriana Kobylak #include <boost/beast/http.hpp>
311da66f75SEd Tanous #include <boost/container/flat_map.hpp>
321ddcf01aSJason M. Bills #include <boost/system/linux_error.hpp>
33cb92c03bSAndrew Geissler #include <error_messages.hpp>
341214b7e7SGunnar Mills 
354418c7f0SJames Feist #include <filesystem>
3675710de2SXiaochao Ma #include <optional>
37cd225da8SJason M. Bills #include <string_view>
38abf2add6SEd Tanous #include <variant>
391da66f75SEd Tanous 
401da66f75SEd Tanous namespace redfish
411da66f75SEd Tanous {
421da66f75SEd Tanous 
435b61b5e8SJason M. Bills constexpr char const* crashdumpObject = "com.intel.crashdump";
445b61b5e8SJason M. Bills constexpr char const* crashdumpPath = "/com/intel/crashdump";
455b61b5e8SJason M. Bills constexpr char const* crashdumpInterface = "com.intel.crashdump";
465b61b5e8SJason M. Bills constexpr char const* deleteAllInterface =
475b61b5e8SJason M. Bills     "xyz.openbmc_project.Collection.DeleteAll";
485b61b5e8SJason M. Bills constexpr char const* crashdumpOnDemandInterface =
49424c4176SJason M. Bills     "com.intel.crashdump.OnDemand";
506eda7685SKenny L. Ku constexpr char const* crashdumpTelemetryInterface =
516eda7685SKenny L. Ku     "com.intel.crashdump.Telemetry";
521da66f75SEd Tanous 
534851d45dSJason M. Bills namespace message_registries
544851d45dSJason M. Bills {
554851d45dSJason M. Bills static const Message* getMessageFromRegistry(
564851d45dSJason M. Bills     const std::string& messageKey,
574851d45dSJason M. Bills     const boost::beast::span<const MessageEntry> registry)
584851d45dSJason M. Bills {
594851d45dSJason M. Bills     boost::beast::span<const MessageEntry>::const_iterator messageIt =
604851d45dSJason M. Bills         std::find_if(registry.cbegin(), registry.cend(),
614851d45dSJason M. Bills                      [&messageKey](const MessageEntry& messageEntry) {
624851d45dSJason M. Bills                          return !std::strcmp(messageEntry.first,
634851d45dSJason M. Bills                                              messageKey.c_str());
644851d45dSJason M. Bills                      });
654851d45dSJason M. Bills     if (messageIt != registry.cend())
664851d45dSJason M. Bills     {
674851d45dSJason M. Bills         return &messageIt->second;
684851d45dSJason M. Bills     }
694851d45dSJason M. Bills 
704851d45dSJason M. Bills     return nullptr;
714851d45dSJason M. Bills }
724851d45dSJason M. Bills 
734851d45dSJason M. Bills static const Message* getMessage(const std::string_view& messageID)
744851d45dSJason M. Bills {
754851d45dSJason M. Bills     // Redfish MessageIds are in the form
764851d45dSJason M. Bills     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
774851d45dSJason M. Bills     // the right Message
784851d45dSJason M. Bills     std::vector<std::string> fields;
794851d45dSJason M. Bills     fields.reserve(4);
804851d45dSJason M. Bills     boost::split(fields, messageID, boost::is_any_of("."));
814851d45dSJason M. Bills     std::string& registryName = fields[0];
824851d45dSJason M. Bills     std::string& messageKey = fields[3];
834851d45dSJason M. Bills 
844851d45dSJason M. Bills     // Find the right registry and check it for the MessageKey
854851d45dSJason M. Bills     if (std::string(base::header.registryPrefix) == registryName)
864851d45dSJason M. Bills     {
874851d45dSJason M. Bills         return getMessageFromRegistry(
884851d45dSJason M. Bills             messageKey, boost::beast::span<const MessageEntry>(base::registry));
894851d45dSJason M. Bills     }
904851d45dSJason M. Bills     if (std::string(openbmc::header.registryPrefix) == registryName)
914851d45dSJason M. Bills     {
924851d45dSJason M. Bills         return getMessageFromRegistry(
934851d45dSJason M. Bills             messageKey,
944851d45dSJason M. Bills             boost::beast::span<const MessageEntry>(openbmc::registry));
954851d45dSJason M. Bills     }
964851d45dSJason M. Bills     return nullptr;
974851d45dSJason M. Bills }
984851d45dSJason M. Bills } // namespace message_registries
994851d45dSJason M. Bills 
100f6150403SJames Feist namespace fs = std::filesystem;
1011da66f75SEd Tanous 
102cb92c03bSAndrew Geissler using GetManagedPropertyType = boost::container::flat_map<
10319bd78d9SPatrick Williams     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
104cb92c03bSAndrew Geissler                               int32_t, uint32_t, int64_t, uint64_t, double>>;
105cb92c03bSAndrew Geissler 
106cb92c03bSAndrew Geissler using GetManagedObjectsType = boost::container::flat_map<
107cb92c03bSAndrew Geissler     sdbusplus::message::object_path,
108cb92c03bSAndrew Geissler     boost::container::flat_map<std::string, GetManagedPropertyType>>;
109cb92c03bSAndrew Geissler 
110cb92c03bSAndrew Geissler inline std::string translateSeverityDbusToRedfish(const std::string& s)
111cb92c03bSAndrew Geissler {
112d4d25793SEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
113d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
114d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
115d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
116cb92c03bSAndrew Geissler     {
117cb92c03bSAndrew Geissler         return "Critical";
118cb92c03bSAndrew Geissler     }
1193174e4dfSEd Tanous     if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
120d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
121d4d25793SEd Tanous         (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
122cb92c03bSAndrew Geissler     {
123cb92c03bSAndrew Geissler         return "OK";
124cb92c03bSAndrew Geissler     }
1253174e4dfSEd Tanous     if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
126cb92c03bSAndrew Geissler     {
127cb92c03bSAndrew Geissler         return "Warning";
128cb92c03bSAndrew Geissler     }
129cb92c03bSAndrew Geissler     return "";
130cb92c03bSAndrew Geissler }
131cb92c03bSAndrew Geissler 
13216428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
13339e77504SEd Tanous                               const std::string_view& field,
13439e77504SEd Tanous                               std::string_view& contents)
13516428a1aSJason M. Bills {
13616428a1aSJason M. Bills     const char* data = nullptr;
13716428a1aSJason M. Bills     size_t length = 0;
13816428a1aSJason M. Bills     int ret = 0;
13916428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
140271584abSEd Tanous     ret = sd_journal_get_data(journal, field.data(),
141271584abSEd Tanous                               reinterpret_cast<const void**>(&data), &length);
14216428a1aSJason M. Bills     if (ret < 0)
14316428a1aSJason M. Bills     {
14416428a1aSJason M. Bills         return ret;
14516428a1aSJason M. Bills     }
14639e77504SEd Tanous     contents = std::string_view(data, length);
14716428a1aSJason M. Bills     // Only use the content after the "=" character.
14881ce609eSEd Tanous     contents.remove_prefix(std::min(contents.find('=') + 1, contents.size()));
14916428a1aSJason M. Bills     return ret;
15016428a1aSJason M. Bills }
15116428a1aSJason M. Bills 
15216428a1aSJason M. Bills static int getJournalMetadata(sd_journal* journal,
15339e77504SEd Tanous                               const std::string_view& field, const int& base,
154271584abSEd Tanous                               long int& contents)
15516428a1aSJason M. Bills {
15616428a1aSJason M. Bills     int ret = 0;
15739e77504SEd Tanous     std::string_view metadata;
15816428a1aSJason M. Bills     // Get the metadata from the requested field of the journal entry
15916428a1aSJason M. Bills     ret = getJournalMetadata(journal, field, metadata);
16016428a1aSJason M. Bills     if (ret < 0)
16116428a1aSJason M. Bills     {
16216428a1aSJason M. Bills         return ret;
16316428a1aSJason M. Bills     }
164b01bf299SEd Tanous     contents = strtol(metadata.data(), nullptr, base);
16516428a1aSJason M. Bills     return ret;
16616428a1aSJason M. Bills }
16716428a1aSJason M. Bills 
168a3316fc6SZhikuiRen static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp)
169a3316fc6SZhikuiRen {
170a3316fc6SZhikuiRen     int ret = 0;
171a3316fc6SZhikuiRen     uint64_t timestamp = 0;
172a3316fc6SZhikuiRen     ret = sd_journal_get_realtime_usec(journal, &timestamp);
173a3316fc6SZhikuiRen     if (ret < 0)
174a3316fc6SZhikuiRen     {
175a3316fc6SZhikuiRen         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
176a3316fc6SZhikuiRen                          << strerror(-ret);
177a3316fc6SZhikuiRen         return false;
178a3316fc6SZhikuiRen     }
1799c620e21SAsmitha Karunanithi     entryTimestamp = crow::utility::getDateTime(
1809c620e21SAsmitha Karunanithi         static_cast<std::time_t>(timestamp / 1000 / 1000));
1819c620e21SAsmitha Karunanithi     return true;
182a3316fc6SZhikuiRen }
183a3316fc6SZhikuiRen 
1848d1b46d7Szhanghch05 static bool getSkipParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1858d1b46d7Szhanghch05                          const crow::Request& req, uint64_t& skip)
18616428a1aSJason M. Bills {
1875a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
1885a7e877eSJames Feist         req.urlParams.find("$skip");
1895a7e877eSJames Feist     if (it != req.urlParams.end())
19016428a1aSJason M. Bills     {
1915a7e877eSJames Feist         std::string skipParam = it->value();
19216428a1aSJason M. Bills         char* ptr = nullptr;
1935a7e877eSJames Feist         skip = std::strtoul(skipParam.c_str(), &ptr, 10);
1945a7e877eSJames Feist         if (skipParam.empty() || *ptr != '\0')
19516428a1aSJason M. Bills         {
19616428a1aSJason M. Bills 
1978d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
1988d1b46d7Szhanghch05                 asyncResp->res, std::string(skipParam), "$skip");
19916428a1aSJason M. Bills             return false;
20016428a1aSJason M. Bills         }
20116428a1aSJason M. Bills     }
20216428a1aSJason M. Bills     return true;
20316428a1aSJason M. Bills }
20416428a1aSJason M. Bills 
205271584abSEd Tanous static constexpr const uint64_t maxEntriesPerPage = 1000;
2068d1b46d7Szhanghch05 static bool getTopParam(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2078d1b46d7Szhanghch05                         const crow::Request& req, uint64_t& top)
20816428a1aSJason M. Bills {
2095a7e877eSJames Feist     boost::urls::url_view::params_type::iterator it =
2105a7e877eSJames Feist         req.urlParams.find("$top");
2115a7e877eSJames Feist     if (it != req.urlParams.end())
21216428a1aSJason M. Bills     {
2135a7e877eSJames Feist         std::string topParam = it->value();
21416428a1aSJason M. Bills         char* ptr = nullptr;
2155a7e877eSJames Feist         top = std::strtoul(topParam.c_str(), &ptr, 10);
2165a7e877eSJames Feist         if (topParam.empty() || *ptr != '\0')
21716428a1aSJason M. Bills         {
2188d1b46d7Szhanghch05             messages::queryParameterValueTypeError(
2198d1b46d7Szhanghch05                 asyncResp->res, std::string(topParam), "$top");
22016428a1aSJason M. Bills             return false;
22116428a1aSJason M. Bills         }
222271584abSEd Tanous         if (top < 1U || top > maxEntriesPerPage)
22316428a1aSJason M. Bills         {
22416428a1aSJason M. Bills 
22516428a1aSJason M. Bills             messages::queryParameterOutOfRange(
2268d1b46d7Szhanghch05                 asyncResp->res, std::to_string(top), "$top",
22716428a1aSJason M. Bills                 "1-" + std::to_string(maxEntriesPerPage));
22816428a1aSJason M. Bills             return false;
22916428a1aSJason M. Bills         }
23016428a1aSJason M. Bills     }
23116428a1aSJason M. Bills     return true;
23216428a1aSJason M. Bills }
23316428a1aSJason M. Bills 
234e85d6b16SJason M. Bills static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
235e85d6b16SJason M. Bills                              const bool firstEntry = true)
23616428a1aSJason M. Bills {
23716428a1aSJason M. Bills     int ret = 0;
23816428a1aSJason M. Bills     static uint64_t prevTs = 0;
23916428a1aSJason M. Bills     static int index = 0;
240e85d6b16SJason M. Bills     if (firstEntry)
241e85d6b16SJason M. Bills     {
242e85d6b16SJason M. Bills         prevTs = 0;
243e85d6b16SJason M. Bills     }
244e85d6b16SJason M. Bills 
24516428a1aSJason M. Bills     // Get the entry timestamp
24616428a1aSJason M. Bills     uint64_t curTs = 0;
24716428a1aSJason M. Bills     ret = sd_journal_get_realtime_usec(journal, &curTs);
24816428a1aSJason M. Bills     if (ret < 0)
24916428a1aSJason M. Bills     {
25016428a1aSJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
25116428a1aSJason M. Bills                          << strerror(-ret);
25216428a1aSJason M. Bills         return false;
25316428a1aSJason M. Bills     }
25416428a1aSJason M. Bills     // If the timestamp isn't unique, increment the index
25516428a1aSJason M. Bills     if (curTs == prevTs)
25616428a1aSJason M. Bills     {
25716428a1aSJason M. Bills         index++;
25816428a1aSJason M. Bills     }
25916428a1aSJason M. Bills     else
26016428a1aSJason M. Bills     {
26116428a1aSJason M. Bills         // Otherwise, reset it
26216428a1aSJason M. Bills         index = 0;
26316428a1aSJason M. Bills     }
26416428a1aSJason M. Bills     // Save the timestamp
26516428a1aSJason M. Bills     prevTs = curTs;
26616428a1aSJason M. Bills 
26716428a1aSJason M. Bills     entryID = std::to_string(curTs);
26816428a1aSJason M. Bills     if (index > 0)
26916428a1aSJason M. Bills     {
27016428a1aSJason M. Bills         entryID += "_" + std::to_string(index);
27116428a1aSJason M. Bills     }
27216428a1aSJason M. Bills     return true;
27316428a1aSJason M. Bills }
27416428a1aSJason M. Bills 
275e85d6b16SJason M. Bills static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
276e85d6b16SJason M. Bills                              const bool firstEntry = true)
27795820184SJason M. Bills {
278271584abSEd Tanous     static time_t prevTs = 0;
27995820184SJason M. Bills     static int index = 0;
280e85d6b16SJason M. Bills     if (firstEntry)
281e85d6b16SJason M. Bills     {
282e85d6b16SJason M. Bills         prevTs = 0;
283e85d6b16SJason M. Bills     }
284e85d6b16SJason M. Bills 
28595820184SJason M. Bills     // Get the entry timestamp
286271584abSEd Tanous     std::time_t curTs = 0;
28795820184SJason M. Bills     std::tm timeStruct = {};
28895820184SJason M. Bills     std::istringstream entryStream(logEntry);
28995820184SJason M. Bills     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
29095820184SJason M. Bills     {
29195820184SJason M. Bills         curTs = std::mktime(&timeStruct);
29295820184SJason M. Bills     }
29395820184SJason M. Bills     // If the timestamp isn't unique, increment the index
29495820184SJason M. Bills     if (curTs == prevTs)
29595820184SJason M. Bills     {
29695820184SJason M. Bills         index++;
29795820184SJason M. Bills     }
29895820184SJason M. Bills     else
29995820184SJason M. Bills     {
30095820184SJason M. Bills         // Otherwise, reset it
30195820184SJason M. Bills         index = 0;
30295820184SJason M. Bills     }
30395820184SJason M. Bills     // Save the timestamp
30495820184SJason M. Bills     prevTs = curTs;
30595820184SJason M. Bills 
30695820184SJason M. Bills     entryID = std::to_string(curTs);
30795820184SJason M. Bills     if (index > 0)
30895820184SJason M. Bills     {
30995820184SJason M. Bills         entryID += "_" + std::to_string(index);
31095820184SJason M. Bills     }
31195820184SJason M. Bills     return true;
31295820184SJason M. Bills }
31395820184SJason M. Bills 
3148d1b46d7Szhanghch05 static bool
3158d1b46d7Szhanghch05     getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3168d1b46d7Szhanghch05                        const std::string& entryID, uint64_t& timestamp,
3178d1b46d7Szhanghch05                        uint64_t& index)
31816428a1aSJason M. Bills {
31916428a1aSJason M. Bills     if (entryID.empty())
32016428a1aSJason M. Bills     {
32116428a1aSJason M. Bills         return false;
32216428a1aSJason M. Bills     }
32316428a1aSJason M. Bills     // Convert the unique ID back to a timestamp to find the entry
32439e77504SEd Tanous     std::string_view tsStr(entryID);
32516428a1aSJason M. Bills 
32681ce609eSEd Tanous     auto underscorePos = tsStr.find('_');
32716428a1aSJason M. Bills     if (underscorePos != tsStr.npos)
32816428a1aSJason M. Bills     {
32916428a1aSJason M. Bills         // Timestamp has an index
33016428a1aSJason M. Bills         tsStr.remove_suffix(tsStr.size() - underscorePos);
33139e77504SEd Tanous         std::string_view indexStr(entryID);
33216428a1aSJason M. Bills         indexStr.remove_prefix(underscorePos + 1);
33316428a1aSJason M. Bills         std::size_t pos;
33416428a1aSJason M. Bills         try
33516428a1aSJason M. Bills         {
33639e77504SEd Tanous             index = std::stoul(std::string(indexStr), &pos);
33716428a1aSJason M. Bills         }
338271584abSEd Tanous         catch (std::invalid_argument&)
33916428a1aSJason M. Bills         {
3408d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
34116428a1aSJason M. Bills             return false;
34216428a1aSJason M. Bills         }
343271584abSEd Tanous         catch (std::out_of_range&)
34416428a1aSJason M. Bills         {
3458d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
34616428a1aSJason M. Bills             return false;
34716428a1aSJason M. Bills         }
34816428a1aSJason M. Bills         if (pos != indexStr.size())
34916428a1aSJason M. Bills         {
3508d1b46d7Szhanghch05             messages::resourceMissingAtURI(asyncResp->res, entryID);
35116428a1aSJason M. Bills             return false;
35216428a1aSJason M. Bills         }
35316428a1aSJason M. Bills     }
35416428a1aSJason M. Bills     // Timestamp has no index
35516428a1aSJason M. Bills     std::size_t pos;
35616428a1aSJason M. Bills     try
35716428a1aSJason M. Bills     {
35839e77504SEd Tanous         timestamp = std::stoull(std::string(tsStr), &pos);
35916428a1aSJason M. Bills     }
360271584abSEd Tanous     catch (std::invalid_argument&)
36116428a1aSJason M. Bills     {
3628d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
36316428a1aSJason M. Bills         return false;
36416428a1aSJason M. Bills     }
365271584abSEd Tanous     catch (std::out_of_range&)
36616428a1aSJason M. Bills     {
3678d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
36816428a1aSJason M. Bills         return false;
36916428a1aSJason M. Bills     }
37016428a1aSJason M. Bills     if (pos != tsStr.size())
37116428a1aSJason M. Bills     {
3728d1b46d7Szhanghch05         messages::resourceMissingAtURI(asyncResp->res, entryID);
37316428a1aSJason M. Bills         return false;
37416428a1aSJason M. Bills     }
37516428a1aSJason M. Bills     return true;
37616428a1aSJason M. Bills }
37716428a1aSJason M. Bills 
37895820184SJason M. Bills static bool
37995820184SJason M. Bills     getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
38095820184SJason M. Bills {
38195820184SJason M. Bills     static const std::filesystem::path redfishLogDir = "/var/log";
38295820184SJason M. Bills     static const std::string redfishLogFilename = "redfish";
38395820184SJason M. Bills 
38495820184SJason M. Bills     // Loop through the directory looking for redfish log files
38595820184SJason M. Bills     for (const std::filesystem::directory_entry& dirEnt :
38695820184SJason M. Bills          std::filesystem::directory_iterator(redfishLogDir))
38795820184SJason M. Bills     {
38895820184SJason M. Bills         // If we find a redfish log file, save the path
38995820184SJason M. Bills         std::string filename = dirEnt.path().filename();
39095820184SJason M. Bills         if (boost::starts_with(filename, redfishLogFilename))
39195820184SJason M. Bills         {
39295820184SJason M. Bills             redfishLogFiles.emplace_back(redfishLogDir / filename);
39395820184SJason M. Bills         }
39495820184SJason M. Bills     }
39595820184SJason M. Bills     // As the log files rotate, they are appended with a ".#" that is higher for
39695820184SJason M. Bills     // the older logs. Since we don't expect more than 10 log files, we
39795820184SJason M. Bills     // can just sort the list to get them in order from newest to oldest
39895820184SJason M. Bills     std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
39995820184SJason M. Bills 
40095820184SJason M. Bills     return !redfishLogFiles.empty();
40195820184SJason M. Bills }
40295820184SJason M. Bills 
4038d1b46d7Szhanghch05 inline void
4048d1b46d7Szhanghch05     getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
4055cb1dd27SAsmitha Karunanithi                            const std::string& dumpType)
4065cb1dd27SAsmitha Karunanithi {
4075cb1dd27SAsmitha Karunanithi     std::string dumpPath;
4085cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
4095cb1dd27SAsmitha Karunanithi     {
4105cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
4115cb1dd27SAsmitha Karunanithi     }
4125cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
4135cb1dd27SAsmitha Karunanithi     {
4145cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
4155cb1dd27SAsmitha Karunanithi     }
4165cb1dd27SAsmitha Karunanithi     else
4175cb1dd27SAsmitha Karunanithi     {
4185cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
4195cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
4205cb1dd27SAsmitha Karunanithi         return;
4215cb1dd27SAsmitha Karunanithi     }
4225cb1dd27SAsmitha Karunanithi 
4235cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
4245cb1dd27SAsmitha Karunanithi         [asyncResp, dumpPath, dumpType](const boost::system::error_code ec,
4255cb1dd27SAsmitha Karunanithi                                         GetManagedObjectsType& resp) {
4265cb1dd27SAsmitha Karunanithi             if (ec)
4275cb1dd27SAsmitha Karunanithi             {
4285cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
4295cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
4305cb1dd27SAsmitha Karunanithi                 return;
4315cb1dd27SAsmitha Karunanithi             }
4325cb1dd27SAsmitha Karunanithi 
4335cb1dd27SAsmitha Karunanithi             nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
4345cb1dd27SAsmitha Karunanithi             entriesArray = nlohmann::json::array();
435b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
436b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
437b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
438b47452b2SAsmitha Karunanithi                 "/entry/";
4395cb1dd27SAsmitha Karunanithi 
4405cb1dd27SAsmitha Karunanithi             for (auto& object : resp)
4415cb1dd27SAsmitha Karunanithi             {
442b47452b2SAsmitha Karunanithi                 if (object.first.str.find(dumpEntryPath) == std::string::npos)
4435cb1dd27SAsmitha Karunanithi                 {
4445cb1dd27SAsmitha Karunanithi                     continue;
4455cb1dd27SAsmitha Karunanithi                 }
4465cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
4475cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
4485cb1dd27SAsmitha Karunanithi                 entriesArray.push_back({});
4495cb1dd27SAsmitha Karunanithi                 nlohmann::json& thisEntry = entriesArray.back();
4502dfd18efSEd Tanous 
4512dfd18efSEd Tanous                 std::string entryID = object.first.filename();
4522dfd18efSEd Tanous                 if (entryID.empty())
4535cb1dd27SAsmitha Karunanithi                 {
4545cb1dd27SAsmitha Karunanithi                     continue;
4555cb1dd27SAsmitha Karunanithi                 }
4565cb1dd27SAsmitha Karunanithi 
4575cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : object.second)
4585cb1dd27SAsmitha Karunanithi                 {
4595cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
4605cb1dd27SAsmitha Karunanithi                     {
4615cb1dd27SAsmitha Karunanithi 
4625cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4635cb1dd27SAsmitha Karunanithi                         {
4645cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
4655cb1dd27SAsmitha Karunanithi                             {
4665cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
4675cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4685cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
4695cb1dd27SAsmitha Karunanithi                                 {
4705cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4715cb1dd27SAsmitha Karunanithi                                     break;
4725cb1dd27SAsmitha Karunanithi                                 }
4735cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
4745cb1dd27SAsmitha Karunanithi                                 break;
4755cb1dd27SAsmitha Karunanithi                             }
4765cb1dd27SAsmitha Karunanithi                         }
4775cb1dd27SAsmitha Karunanithi                     }
4785cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
4795cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
4805cb1dd27SAsmitha Karunanithi                     {
4815cb1dd27SAsmitha Karunanithi 
4825cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
4835cb1dd27SAsmitha Karunanithi                         {
4845cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
4855cb1dd27SAsmitha Karunanithi                             {
4865cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
4875cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
4885cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
4895cb1dd27SAsmitha Karunanithi                                 {
4905cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
4915cb1dd27SAsmitha Karunanithi                                     break;
4925cb1dd27SAsmitha Karunanithi                                 }
4935cb1dd27SAsmitha Karunanithi                                 timestamp =
4945cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
4955cb1dd27SAsmitha Karunanithi                                 break;
4965cb1dd27SAsmitha Karunanithi                             }
4975cb1dd27SAsmitha Karunanithi                         }
4985cb1dd27SAsmitha Karunanithi                     }
4995cb1dd27SAsmitha Karunanithi                 }
5005cb1dd27SAsmitha Karunanithi 
501d337bb72SAsmitha Karunanithi                 thisEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry";
5025cb1dd27SAsmitha Karunanithi                 thisEntry["@odata.id"] = dumpPath + entryID;
5035cb1dd27SAsmitha Karunanithi                 thisEntry["Id"] = entryID;
5045cb1dd27SAsmitha Karunanithi                 thisEntry["EntryType"] = "Event";
5055cb1dd27SAsmitha Karunanithi                 thisEntry["Created"] = crow::utility::getDateTime(timestamp);
5065cb1dd27SAsmitha Karunanithi                 thisEntry["Name"] = dumpType + " Dump Entry";
5075cb1dd27SAsmitha Karunanithi 
508d337bb72SAsmitha Karunanithi                 thisEntry["AdditionalDataSizeBytes"] = size;
5095cb1dd27SAsmitha Karunanithi 
5105cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
5115cb1dd27SAsmitha Karunanithi                 {
512d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "Manager";
513d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
514d337bb72SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
515d337bb72SAsmitha Karunanithi                         "attachment/" +
516d337bb72SAsmitha Karunanithi                         entryID;
5175cb1dd27SAsmitha Karunanithi                 }
5185cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
5195cb1dd27SAsmitha Karunanithi                 {
520d337bb72SAsmitha Karunanithi                     thisEntry["DiagnosticDataType"] = "OEM";
521d337bb72SAsmitha Karunanithi                     thisEntry["OEMDiagnosticDataType"] = "System";
522d337bb72SAsmitha Karunanithi                     thisEntry["AdditionalDataURI"] =
523d337bb72SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
524d337bb72SAsmitha Karunanithi                         "attachment/" +
525d337bb72SAsmitha Karunanithi                         entryID;
5265cb1dd27SAsmitha Karunanithi                 }
5275cb1dd27SAsmitha Karunanithi             }
5285cb1dd27SAsmitha Karunanithi             asyncResp->res.jsonValue["Members@odata.count"] =
5295cb1dd27SAsmitha Karunanithi                 entriesArray.size();
5305cb1dd27SAsmitha Karunanithi         },
5315cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
5325cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
5335cb1dd27SAsmitha Karunanithi }
5345cb1dd27SAsmitha Karunanithi 
5358d1b46d7Szhanghch05 inline void
5368d1b46d7Szhanghch05     getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5378d1b46d7Szhanghch05                      const std::string& entryID, const std::string& dumpType)
5385cb1dd27SAsmitha Karunanithi {
5395cb1dd27SAsmitha Karunanithi     std::string dumpPath;
5405cb1dd27SAsmitha Karunanithi     if (dumpType == "BMC")
5415cb1dd27SAsmitha Karunanithi     {
5425cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
5435cb1dd27SAsmitha Karunanithi     }
5445cb1dd27SAsmitha Karunanithi     else if (dumpType == "System")
5455cb1dd27SAsmitha Karunanithi     {
5465cb1dd27SAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
5475cb1dd27SAsmitha Karunanithi     }
5485cb1dd27SAsmitha Karunanithi     else
5495cb1dd27SAsmitha Karunanithi     {
5505cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
5515cb1dd27SAsmitha Karunanithi         messages::internalError(asyncResp->res);
5525cb1dd27SAsmitha Karunanithi         return;
5535cb1dd27SAsmitha Karunanithi     }
5545cb1dd27SAsmitha Karunanithi 
5555cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
5565cb1dd27SAsmitha Karunanithi         [asyncResp, entryID, dumpPath, dumpType](
5575cb1dd27SAsmitha Karunanithi             const boost::system::error_code ec, GetManagedObjectsType& resp) {
5585cb1dd27SAsmitha Karunanithi             if (ec)
5595cb1dd27SAsmitha Karunanithi             {
5605cb1dd27SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
5615cb1dd27SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
5625cb1dd27SAsmitha Karunanithi                 return;
5635cb1dd27SAsmitha Karunanithi             }
5645cb1dd27SAsmitha Karunanithi 
565b47452b2SAsmitha Karunanithi             bool foundDumpEntry = false;
566b47452b2SAsmitha Karunanithi             std::string dumpEntryPath =
567b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
568b47452b2SAsmitha Karunanithi                 std::string(boost::algorithm::to_lower_copy(dumpType)) +
569b47452b2SAsmitha Karunanithi                 "/entry/";
570b47452b2SAsmitha Karunanithi 
5715cb1dd27SAsmitha Karunanithi             for (auto& objectPath : resp)
5725cb1dd27SAsmitha Karunanithi             {
573b47452b2SAsmitha Karunanithi                 if (objectPath.first.str != dumpEntryPath + entryID)
5745cb1dd27SAsmitha Karunanithi                 {
5755cb1dd27SAsmitha Karunanithi                     continue;
5765cb1dd27SAsmitha Karunanithi                 }
5775cb1dd27SAsmitha Karunanithi 
5785cb1dd27SAsmitha Karunanithi                 foundDumpEntry = true;
5795cb1dd27SAsmitha Karunanithi                 std::time_t timestamp;
5805cb1dd27SAsmitha Karunanithi                 uint64_t size = 0;
5815cb1dd27SAsmitha Karunanithi 
5825cb1dd27SAsmitha Karunanithi                 for (auto& interfaceMap : objectPath.second)
5835cb1dd27SAsmitha Karunanithi                 {
5845cb1dd27SAsmitha Karunanithi                     if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
5855cb1dd27SAsmitha Karunanithi                     {
5865cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
5875cb1dd27SAsmitha Karunanithi                         {
5885cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Size")
5895cb1dd27SAsmitha Karunanithi                             {
5905cb1dd27SAsmitha Karunanithi                                 auto sizePtr =
5915cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
5925cb1dd27SAsmitha Karunanithi                                 if (sizePtr == nullptr)
5935cb1dd27SAsmitha Karunanithi                                 {
5945cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
5955cb1dd27SAsmitha Karunanithi                                     break;
5965cb1dd27SAsmitha Karunanithi                                 }
5975cb1dd27SAsmitha Karunanithi                                 size = *sizePtr;
5985cb1dd27SAsmitha Karunanithi                                 break;
5995cb1dd27SAsmitha Karunanithi                             }
6005cb1dd27SAsmitha Karunanithi                         }
6015cb1dd27SAsmitha Karunanithi                     }
6025cb1dd27SAsmitha Karunanithi                     else if (interfaceMap.first ==
6035cb1dd27SAsmitha Karunanithi                              "xyz.openbmc_project.Time.EpochTime")
6045cb1dd27SAsmitha Karunanithi                     {
6055cb1dd27SAsmitha Karunanithi                         for (auto& propertyMap : interfaceMap.second)
6065cb1dd27SAsmitha Karunanithi                         {
6075cb1dd27SAsmitha Karunanithi                             if (propertyMap.first == "Elapsed")
6085cb1dd27SAsmitha Karunanithi                             {
6095cb1dd27SAsmitha Karunanithi                                 const uint64_t* usecsTimeStamp =
6105cb1dd27SAsmitha Karunanithi                                     std::get_if<uint64_t>(&propertyMap.second);
6115cb1dd27SAsmitha Karunanithi                                 if (usecsTimeStamp == nullptr)
6125cb1dd27SAsmitha Karunanithi                                 {
6135cb1dd27SAsmitha Karunanithi                                     messages::internalError(asyncResp->res);
6145cb1dd27SAsmitha Karunanithi                                     break;
6155cb1dd27SAsmitha Karunanithi                                 }
6165cb1dd27SAsmitha Karunanithi                                 timestamp =
6175cb1dd27SAsmitha Karunanithi                                     static_cast<std::time_t>(*usecsTimeStamp);
6185cb1dd27SAsmitha Karunanithi                                 break;
6195cb1dd27SAsmitha Karunanithi                             }
6205cb1dd27SAsmitha Karunanithi                         }
6215cb1dd27SAsmitha Karunanithi                     }
6225cb1dd27SAsmitha Karunanithi                 }
6235cb1dd27SAsmitha Karunanithi 
6245cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.type"] =
625d337bb72SAsmitha Karunanithi                     "#LogEntry.v1_7_0.LogEntry";
6265cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
6275cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Id"] = entryID;
6285cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["EntryType"] = "Event";
6295cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Created"] =
6305cb1dd27SAsmitha Karunanithi                     crow::utility::getDateTime(timestamp);
6315cb1dd27SAsmitha Karunanithi                 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
6325cb1dd27SAsmitha Karunanithi 
633d337bb72SAsmitha Karunanithi                 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
6345cb1dd27SAsmitha Karunanithi 
6355cb1dd27SAsmitha Karunanithi                 if (dumpType == "BMC")
6365cb1dd27SAsmitha Karunanithi                 {
637d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
638d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
6395cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Managers/bmc/LogServices/Dump/"
6405cb1dd27SAsmitha Karunanithi                         "attachment/" +
6415cb1dd27SAsmitha Karunanithi                         entryID;
6425cb1dd27SAsmitha Karunanithi                 }
6435cb1dd27SAsmitha Karunanithi                 else if (dumpType == "System")
6445cb1dd27SAsmitha Karunanithi                 {
645d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
646d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["OEMDiagnosticDataType"] =
6475cb1dd27SAsmitha Karunanithi                         "System";
648d337bb72SAsmitha Karunanithi                     asyncResp->res.jsonValue["AdditionalDataURI"] =
6495cb1dd27SAsmitha Karunanithi                         "/redfish/v1/Systems/system/LogServices/Dump/"
6505cb1dd27SAsmitha Karunanithi                         "attachment/" +
6515cb1dd27SAsmitha Karunanithi                         entryID;
6525cb1dd27SAsmitha Karunanithi                 }
6535cb1dd27SAsmitha Karunanithi             }
654b47452b2SAsmitha Karunanithi             if (foundDumpEntry == false)
655b47452b2SAsmitha Karunanithi             {
656b47452b2SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Can't find Dump Entry";
657b47452b2SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
658b47452b2SAsmitha Karunanithi                 return;
659b47452b2SAsmitha Karunanithi             }
6605cb1dd27SAsmitha Karunanithi         },
6615cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
6625cb1dd27SAsmitha Karunanithi         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
6635cb1dd27SAsmitha Karunanithi }
6645cb1dd27SAsmitha Karunanithi 
6658d1b46d7Szhanghch05 inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6669878256fSStanley Chu                             const std::string& entryID,
667b47452b2SAsmitha Karunanithi                             const std::string& dumpType)
6685cb1dd27SAsmitha Karunanithi {
6693de8d8baSGeorge Liu     auto respHandler = [asyncResp,
6703de8d8baSGeorge Liu                         entryID](const boost::system::error_code ec) {
6715cb1dd27SAsmitha Karunanithi         BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
6725cb1dd27SAsmitha Karunanithi         if (ec)
6735cb1dd27SAsmitha Karunanithi         {
6743de8d8baSGeorge Liu             if (ec.value() == EBADR)
6753de8d8baSGeorge Liu             {
6763de8d8baSGeorge Liu                 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
6773de8d8baSGeorge Liu                 return;
6783de8d8baSGeorge Liu             }
6795cb1dd27SAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
6805cb1dd27SAsmitha Karunanithi                              << ec;
6815cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
6825cb1dd27SAsmitha Karunanithi             return;
6835cb1dd27SAsmitha Karunanithi         }
6845cb1dd27SAsmitha Karunanithi     };
6855cb1dd27SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
6865cb1dd27SAsmitha Karunanithi         respHandler, "xyz.openbmc_project.Dump.Manager",
687b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
688b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
689b47452b2SAsmitha Karunanithi             entryID,
6905cb1dd27SAsmitha Karunanithi         "xyz.openbmc_project.Object.Delete", "Delete");
6915cb1dd27SAsmitha Karunanithi }
6925cb1dd27SAsmitha Karunanithi 
6938d1b46d7Szhanghch05 inline void
6948d1b46d7Szhanghch05     createDumpTaskCallback(const crow::Request& req,
6958d1b46d7Szhanghch05                            const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
6968d1b46d7Szhanghch05                            const uint32_t& dumpId, const std::string& dumpPath,
697a43be80fSAsmitha Karunanithi                            const std::string& dumpType)
698a43be80fSAsmitha Karunanithi {
699a43be80fSAsmitha Karunanithi     std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
7006145ed6fSAsmitha Karunanithi         [dumpId, dumpPath, dumpType](
701a43be80fSAsmitha Karunanithi             boost::system::error_code err, sdbusplus::message::message& m,
702a43be80fSAsmitha Karunanithi             const std::shared_ptr<task::TaskData>& taskData) {
703cb13a392SEd Tanous             if (err)
704cb13a392SEd Tanous             {
7056145ed6fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "Error in creating a dump";
7066145ed6fSAsmitha Karunanithi                 taskData->state = "Cancelled";
7076145ed6fSAsmitha Karunanithi                 return task::completed;
708cb13a392SEd Tanous             }
709a43be80fSAsmitha Karunanithi             std::vector<std::pair<
710a43be80fSAsmitha Karunanithi                 std::string,
711a43be80fSAsmitha Karunanithi                 std::vector<std::pair<std::string, std::variant<std::string>>>>>
712a43be80fSAsmitha Karunanithi                 interfacesList;
713a43be80fSAsmitha Karunanithi 
714a43be80fSAsmitha Karunanithi             sdbusplus::message::object_path objPath;
715a43be80fSAsmitha Karunanithi 
716a43be80fSAsmitha Karunanithi             m.read(objPath, interfacesList);
717a43be80fSAsmitha Karunanithi 
718b47452b2SAsmitha Karunanithi             if (objPath.str ==
719b47452b2SAsmitha Karunanithi                 "/xyz/openbmc_project/dump/" +
720b47452b2SAsmitha Karunanithi                     std::string(boost::algorithm::to_lower_copy(dumpType)) +
721b47452b2SAsmitha Karunanithi                     "/entry/" + std::to_string(dumpId))
722a43be80fSAsmitha Karunanithi             {
723a43be80fSAsmitha Karunanithi                 nlohmann::json retMessage = messages::success();
724a43be80fSAsmitha Karunanithi                 taskData->messages.emplace_back(retMessage);
725a43be80fSAsmitha Karunanithi 
726a43be80fSAsmitha Karunanithi                 std::string headerLoc =
727a43be80fSAsmitha Karunanithi                     "Location: " + dumpPath + std::to_string(dumpId);
728a43be80fSAsmitha Karunanithi                 taskData->payload->httpHeaders.emplace_back(
729a43be80fSAsmitha Karunanithi                     std::move(headerLoc));
730a43be80fSAsmitha Karunanithi 
731a43be80fSAsmitha Karunanithi                 taskData->state = "Completed";
732b47452b2SAsmitha Karunanithi                 return task::completed;
7336145ed6fSAsmitha Karunanithi             }
734a43be80fSAsmitha Karunanithi             return task::completed;
735a43be80fSAsmitha Karunanithi         },
736a43be80fSAsmitha Karunanithi         "type='signal',interface='org.freedesktop.DBus."
737a43be80fSAsmitha Karunanithi         "ObjectManager',"
738a43be80fSAsmitha Karunanithi         "member='InterfacesAdded', "
739a43be80fSAsmitha Karunanithi         "path='/xyz/openbmc_project/dump'");
740a43be80fSAsmitha Karunanithi 
741a43be80fSAsmitha Karunanithi     task->startTimer(std::chrono::minutes(3));
742a43be80fSAsmitha Karunanithi     task->populateResp(asyncResp->res);
743a43be80fSAsmitha Karunanithi     task->payload.emplace(req);
744a43be80fSAsmitha Karunanithi }
745a43be80fSAsmitha Karunanithi 
7468d1b46d7Szhanghch05 inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
7478d1b46d7Szhanghch05                        const crow::Request& req, const std::string& dumpType)
748a43be80fSAsmitha Karunanithi {
749a43be80fSAsmitha Karunanithi 
750a43be80fSAsmitha Karunanithi     std::string dumpPath;
751a43be80fSAsmitha Karunanithi     if (dumpType == "BMC")
752a43be80fSAsmitha Karunanithi     {
753a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
754a43be80fSAsmitha Karunanithi     }
755a43be80fSAsmitha Karunanithi     else if (dumpType == "System")
756a43be80fSAsmitha Karunanithi     {
757a43be80fSAsmitha Karunanithi         dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
758a43be80fSAsmitha Karunanithi     }
759a43be80fSAsmitha Karunanithi     else
760a43be80fSAsmitha Karunanithi     {
761a43be80fSAsmitha Karunanithi         BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
762a43be80fSAsmitha Karunanithi         messages::internalError(asyncResp->res);
763a43be80fSAsmitha Karunanithi         return;
764a43be80fSAsmitha Karunanithi     }
765a43be80fSAsmitha Karunanithi 
766a43be80fSAsmitha Karunanithi     std::optional<std::string> diagnosticDataType;
767a43be80fSAsmitha Karunanithi     std::optional<std::string> oemDiagnosticDataType;
768a43be80fSAsmitha Karunanithi 
769a43be80fSAsmitha Karunanithi     if (!redfish::json_util::readJson(
770a43be80fSAsmitha Karunanithi             req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
771a43be80fSAsmitha Karunanithi             "OEMDiagnosticDataType", oemDiagnosticDataType))
772a43be80fSAsmitha Karunanithi     {
773a43be80fSAsmitha Karunanithi         return;
774a43be80fSAsmitha Karunanithi     }
775a43be80fSAsmitha Karunanithi 
776a43be80fSAsmitha Karunanithi     if (dumpType == "System")
777a43be80fSAsmitha Karunanithi     {
778a43be80fSAsmitha Karunanithi         if (!oemDiagnosticDataType || !diagnosticDataType)
779a43be80fSAsmitha Karunanithi         {
780a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
781a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType'/"
782a43be80fSAsmitha Karunanithi                                 "'OEMDiagnosticDataType' value not found!";
783a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
784a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData",
785a43be80fSAsmitha Karunanithi                 "DiagnosticDataType & OEMDiagnosticDataType");
786a43be80fSAsmitha Karunanithi             return;
787a43be80fSAsmitha Karunanithi         }
7883174e4dfSEd Tanous         if ((*oemDiagnosticDataType != "System") ||
789a43be80fSAsmitha Karunanithi             (*diagnosticDataType != "OEM"))
790a43be80fSAsmitha Karunanithi         {
791a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "Wrong parameter values passed";
792a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
793a43be80fSAsmitha Karunanithi                                     "System Dump creation parameters");
794a43be80fSAsmitha Karunanithi             return;
795a43be80fSAsmitha Karunanithi         }
796a43be80fSAsmitha Karunanithi     }
797a43be80fSAsmitha Karunanithi     else if (dumpType == "BMC")
798a43be80fSAsmitha Karunanithi     {
799a43be80fSAsmitha Karunanithi         if (!diagnosticDataType)
800a43be80fSAsmitha Karunanithi         {
801a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR << "CreateDump action parameter "
802a43be80fSAsmitha Karunanithi                                 "'DiagnosticDataType' not found!";
803a43be80fSAsmitha Karunanithi             messages::actionParameterMissing(
804a43be80fSAsmitha Karunanithi                 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
805a43be80fSAsmitha Karunanithi             return;
806a43be80fSAsmitha Karunanithi         }
8073174e4dfSEd Tanous         if (*diagnosticDataType != "Manager")
808a43be80fSAsmitha Karunanithi         {
809a43be80fSAsmitha Karunanithi             BMCWEB_LOG_ERROR
810a43be80fSAsmitha Karunanithi                 << "Wrong parameter value passed for 'DiagnosticDataType'";
811a43be80fSAsmitha Karunanithi             messages::invalidObject(asyncResp->res,
812a43be80fSAsmitha Karunanithi                                     "BMC Dump creation parameters");
813a43be80fSAsmitha Karunanithi             return;
814a43be80fSAsmitha Karunanithi         }
815a43be80fSAsmitha Karunanithi     }
816a43be80fSAsmitha Karunanithi 
817a43be80fSAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
818a43be80fSAsmitha Karunanithi         [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec,
819a43be80fSAsmitha Karunanithi                                              const uint32_t& dumpId) {
820a43be80fSAsmitha Karunanithi             if (ec)
821a43be80fSAsmitha Karunanithi             {
822a43be80fSAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
823a43be80fSAsmitha Karunanithi                 messages::internalError(asyncResp->res);
824a43be80fSAsmitha Karunanithi                 return;
825a43be80fSAsmitha Karunanithi             }
826a43be80fSAsmitha Karunanithi             BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
827a43be80fSAsmitha Karunanithi 
828a43be80fSAsmitha Karunanithi             createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType);
829a43be80fSAsmitha Karunanithi         },
830b47452b2SAsmitha Karunanithi         "xyz.openbmc_project.Dump.Manager",
831b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" +
832b47452b2SAsmitha Karunanithi             std::string(boost::algorithm::to_lower_copy(dumpType)),
833a43be80fSAsmitha Karunanithi         "xyz.openbmc_project.Dump.Create", "CreateDump");
834a43be80fSAsmitha Karunanithi }
835a43be80fSAsmitha Karunanithi 
8368d1b46d7Szhanghch05 inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
8378d1b46d7Szhanghch05                       const std::string& dumpType)
83880319af1SAsmitha Karunanithi {
839b47452b2SAsmitha Karunanithi     std::string dumpTypeLowerCopy =
840b47452b2SAsmitha Karunanithi         std::string(boost::algorithm::to_lower_copy(dumpType));
8418d1b46d7Szhanghch05 
84280319af1SAsmitha Karunanithi     crow::connections::systemBus->async_method_call(
843b47452b2SAsmitha Karunanithi         [asyncResp, dumpType](const boost::system::error_code ec,
84480319af1SAsmitha Karunanithi                               const std::vector<std::string>& subTreePaths) {
84580319af1SAsmitha Karunanithi             if (ec)
84680319af1SAsmitha Karunanithi             {
84780319af1SAsmitha Karunanithi                 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
84880319af1SAsmitha Karunanithi                 messages::internalError(asyncResp->res);
84980319af1SAsmitha Karunanithi                 return;
85080319af1SAsmitha Karunanithi             }
85180319af1SAsmitha Karunanithi 
85280319af1SAsmitha Karunanithi             for (const std::string& path : subTreePaths)
85380319af1SAsmitha Karunanithi             {
8542dfd18efSEd Tanous                 sdbusplus::message::object_path objPath(path);
8552dfd18efSEd Tanous                 std::string logID = objPath.filename();
8562dfd18efSEd Tanous                 if (logID.empty())
85780319af1SAsmitha Karunanithi                 {
8582dfd18efSEd Tanous                     continue;
85980319af1SAsmitha Karunanithi                 }
8602dfd18efSEd Tanous                 deleteDumpEntry(asyncResp, logID, dumpType);
86180319af1SAsmitha Karunanithi             }
86280319af1SAsmitha Karunanithi         },
86380319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper",
86480319af1SAsmitha Karunanithi         "/xyz/openbmc_project/object_mapper",
86580319af1SAsmitha Karunanithi         "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
866b47452b2SAsmitha Karunanithi         "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0,
867b47452b2SAsmitha Karunanithi         std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." +
868b47452b2SAsmitha Karunanithi                                    dumpType});
86980319af1SAsmitha Karunanithi }
87080319af1SAsmitha Karunanithi 
8712c70f800SEd Tanous static void parseCrashdumpParameters(
872043a0536SJohnathan Mantey     const std::vector<std::pair<std::string, VariantType>>& params,
873043a0536SJohnathan Mantey     std::string& filename, std::string& timestamp, std::string& logfile)
874043a0536SJohnathan Mantey {
875043a0536SJohnathan Mantey     for (auto property : params)
876043a0536SJohnathan Mantey     {
877043a0536SJohnathan Mantey         if (property.first == "Timestamp")
878043a0536SJohnathan Mantey         {
879043a0536SJohnathan Mantey             const std::string* value =
8808d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
881043a0536SJohnathan Mantey             if (value != nullptr)
882043a0536SJohnathan Mantey             {
883043a0536SJohnathan Mantey                 timestamp = *value;
884043a0536SJohnathan Mantey             }
885043a0536SJohnathan Mantey         }
886043a0536SJohnathan Mantey         else if (property.first == "Filename")
887043a0536SJohnathan Mantey         {
888043a0536SJohnathan Mantey             const std::string* value =
8898d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
890043a0536SJohnathan Mantey             if (value != nullptr)
891043a0536SJohnathan Mantey             {
892043a0536SJohnathan Mantey                 filename = *value;
893043a0536SJohnathan Mantey             }
894043a0536SJohnathan Mantey         }
895043a0536SJohnathan Mantey         else if (property.first == "Log")
896043a0536SJohnathan Mantey         {
897043a0536SJohnathan Mantey             const std::string* value =
8988d78b7a9SPatrick Williams                 std::get_if<std::string>(&property.second);
899043a0536SJohnathan Mantey             if (value != nullptr)
900043a0536SJohnathan Mantey             {
901043a0536SJohnathan Mantey                 logfile = *value;
902043a0536SJohnathan Mantey             }
903043a0536SJohnathan Mantey         }
904043a0536SJohnathan Mantey     }
905043a0536SJohnathan Mantey }
906043a0536SJohnathan Mantey 
907a3316fc6SZhikuiRen constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
908c4bf6374SJason M. Bills class SystemLogServiceCollection : public Node
9091da66f75SEd Tanous {
9101da66f75SEd Tanous   public:
91152cc112dSEd Tanous     SystemLogServiceCollection(App& app) :
912029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/")
913c4bf6374SJason M. Bills     {
914c4bf6374SJason M. Bills         entityPrivileges = {
915c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
916c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
917c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
918c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
919c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
920c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
921c4bf6374SJason M. Bills     }
922c4bf6374SJason M. Bills 
923c4bf6374SJason M. Bills   private:
924c4bf6374SJason M. Bills     /**
925c4bf6374SJason M. Bills      * Functions triggers appropriate requests on DBus
926c4bf6374SJason M. Bills      */
9278d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
9288d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
929c4bf6374SJason M. Bills     {
930c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
931c4bf6374SJason M. Bills         // it has a duplicate entry for members
932c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
933c4bf6374SJason M. Bills             "#LogServiceCollection.LogServiceCollection";
934c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
935029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices";
936c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
937c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
938c4bf6374SJason M. Bills             "Collection of LogServices for this Computer System";
939c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
940c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
941029573d4SEd Tanous         logServiceArray.push_back(
942029573d4SEd Tanous             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}});
9435cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
944c9bb6861Sraviteja-b         logServiceArray.push_back(
9455cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}});
946c9bb6861Sraviteja-b #endif
947c9bb6861Sraviteja-b 
948d53dd41fSJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
949d53dd41fSJason M. Bills         logServiceArray.push_back(
950cb92c03bSAndrew Geissler             {{"@odata.id",
951424c4176SJason M. Bills               "/redfish/v1/Systems/system/LogServices/Crashdump"}});
952d53dd41fSJason M. Bills #endif
953c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
954c4bf6374SJason M. Bills             logServiceArray.size();
955a3316fc6SZhikuiRen 
956a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
957a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec,
958a3316fc6SZhikuiRen                         const std::vector<std::string>& subtreePath) {
959a3316fc6SZhikuiRen                 if (ec)
960a3316fc6SZhikuiRen                 {
961a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR << ec;
962a3316fc6SZhikuiRen                     return;
963a3316fc6SZhikuiRen                 }
964a3316fc6SZhikuiRen 
965a3316fc6SZhikuiRen                 for (auto& pathStr : subtreePath)
966a3316fc6SZhikuiRen                 {
967a3316fc6SZhikuiRen                     if (pathStr.find("PostCode") != std::string::npos)
968a3316fc6SZhikuiRen                     {
96923a21a1cSEd Tanous                         nlohmann::json& logServiceArrayLocal =
970a3316fc6SZhikuiRen                             asyncResp->res.jsonValue["Members"];
97123a21a1cSEd Tanous                         logServiceArrayLocal.push_back(
972a3316fc6SZhikuiRen                             {{"@odata.id", "/redfish/v1/Systems/system/"
973a3316fc6SZhikuiRen                                            "LogServices/PostCodes"}});
974a3316fc6SZhikuiRen                         asyncResp->res.jsonValue["Members@odata.count"] =
97523a21a1cSEd Tanous                             logServiceArrayLocal.size();
976a3316fc6SZhikuiRen                         return;
977a3316fc6SZhikuiRen                     }
978a3316fc6SZhikuiRen                 }
979a3316fc6SZhikuiRen             },
980a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper",
981a3316fc6SZhikuiRen             "/xyz/openbmc_project/object_mapper",
982a3316fc6SZhikuiRen             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
983a3316fc6SZhikuiRen             std::array<const char*, 1>{postCodeIface});
984c4bf6374SJason M. Bills     }
985c4bf6374SJason M. Bills };
986c4bf6374SJason M. Bills 
987c4bf6374SJason M. Bills class EventLogService : public Node
988c4bf6374SJason M. Bills {
989c4bf6374SJason M. Bills   public:
99052cc112dSEd Tanous     EventLogService(App& app) :
991029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
992c4bf6374SJason M. Bills     {
993c4bf6374SJason M. Bills         entityPrivileges = {
994c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
995c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
996c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
997c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
998c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
999c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1000c4bf6374SJason M. Bills     }
1001c4bf6374SJason M. Bills 
1002c4bf6374SJason M. Bills   private:
10038d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
10048d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
1005c4bf6374SJason M. Bills     {
1006c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1007029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog";
1008c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1009c4bf6374SJason M. Bills             "#LogService.v1_1_0.LogService";
1010c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Event Log Service";
1011c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1012c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "EventLog";
1013c4bf6374SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1014c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1015c4bf6374SJason M. Bills             {"@odata.id",
1016029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
1017e7d6c8b2SGunnar Mills         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1018e7d6c8b2SGunnar Mills 
1019e7d6c8b2SGunnar Mills             {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
1020e7d6c8b2SGunnar Mills                        "Actions/LogService.ClearLog"}};
1021489640c6SJason M. Bills     }
1022489640c6SJason M. Bills };
1023489640c6SJason M. Bills 
10241f56a3a6STim Lee class JournalEventLogClear : public Node
1025489640c6SJason M. Bills {
1026489640c6SJason M. Bills   public:
102752cc112dSEd Tanous     JournalEventLogClear(App& app) :
1028489640c6SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1029489640c6SJason M. Bills                   "LogService.ClearLog/")
1030489640c6SJason M. Bills     {
1031489640c6SJason M. Bills         entityPrivileges = {
1032489640c6SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1033489640c6SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1034489640c6SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1035489640c6SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1036489640c6SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1037489640c6SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1038489640c6SJason M. Bills     }
1039489640c6SJason M. Bills 
1040489640c6SJason M. Bills   private:
10418d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
10428d1b46d7Szhanghch05                 const crow::Request&, const std::vector<std::string>&) override
1043489640c6SJason M. Bills     {
1044489640c6SJason M. Bills 
1045489640c6SJason M. Bills         // Clear the EventLog by deleting the log files
1046489640c6SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1047489640c6SJason M. Bills         if (getRedfishLogFiles(redfishLogFiles))
1048489640c6SJason M. Bills         {
1049489640c6SJason M. Bills             for (const std::filesystem::path& file : redfishLogFiles)
1050489640c6SJason M. Bills             {
1051489640c6SJason M. Bills                 std::error_code ec;
1052489640c6SJason M. Bills                 std::filesystem::remove(file, ec);
1053489640c6SJason M. Bills             }
1054489640c6SJason M. Bills         }
1055489640c6SJason M. Bills 
1056489640c6SJason M. Bills         // Reload rsyslog so it knows to start new log files
1057489640c6SJason M. Bills         crow::connections::systemBus->async_method_call(
1058489640c6SJason M. Bills             [asyncResp](const boost::system::error_code ec) {
1059489640c6SJason M. Bills                 if (ec)
1060489640c6SJason M. Bills                 {
1061489640c6SJason M. Bills                     BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
1062489640c6SJason M. Bills                     messages::internalError(asyncResp->res);
1063489640c6SJason M. Bills                     return;
1064489640c6SJason M. Bills                 }
1065489640c6SJason M. Bills 
1066489640c6SJason M. Bills                 messages::success(asyncResp->res);
1067489640c6SJason M. Bills             },
1068489640c6SJason M. Bills             "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1069489640c6SJason M. Bills             "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1070489640c6SJason M. Bills             "replace");
1071c4bf6374SJason M. Bills     }
1072c4bf6374SJason M. Bills };
1073c4bf6374SJason M. Bills 
107495820184SJason M. Bills static int fillEventLogEntryJson(const std::string& logEntryID,
1075b5a76932SEd Tanous                                  const std::string& logEntry,
107695820184SJason M. Bills                                  nlohmann::json& logEntryJson)
1077c4bf6374SJason M. Bills {
107895820184SJason M. Bills     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1079cd225da8SJason M. Bills     // First get the Timestamp
1080f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1081cd225da8SJason M. Bills     if (space == std::string::npos)
108295820184SJason M. Bills     {
108395820184SJason M. Bills         return 1;
108495820184SJason M. Bills     }
1085cd225da8SJason M. Bills     std::string timestamp = logEntry.substr(0, space);
1086cd225da8SJason M. Bills     // Then get the log contents
1087f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1088cd225da8SJason M. Bills     if (entryStart == std::string::npos)
1089cd225da8SJason M. Bills     {
1090cd225da8SJason M. Bills         return 1;
1091cd225da8SJason M. Bills     }
1092cd225da8SJason M. Bills     std::string_view entry(logEntry);
1093cd225da8SJason M. Bills     entry.remove_prefix(entryStart);
1094cd225da8SJason M. Bills     // Use split to separate the entry into its fields
1095cd225da8SJason M. Bills     std::vector<std::string> logEntryFields;
1096cd225da8SJason M. Bills     boost::split(logEntryFields, entry, boost::is_any_of(","),
1097cd225da8SJason M. Bills                  boost::token_compress_on);
1098cd225da8SJason M. Bills     // We need at least a MessageId to be valid
1099cd225da8SJason M. Bills     if (logEntryFields.size() < 1)
1100cd225da8SJason M. Bills     {
1101cd225da8SJason M. Bills         return 1;
1102cd225da8SJason M. Bills     }
1103cd225da8SJason M. Bills     std::string& messageID = logEntryFields[0];
110495820184SJason M. Bills 
11054851d45dSJason M. Bills     // Get the Message from the MessageRegistry
11064851d45dSJason M. Bills     const message_registries::Message* message =
11074851d45dSJason M. Bills         message_registries::getMessage(messageID);
1108c4bf6374SJason M. Bills 
11094851d45dSJason M. Bills     std::string msg;
11104851d45dSJason M. Bills     std::string severity;
11114851d45dSJason M. Bills     if (message != nullptr)
1112c4bf6374SJason M. Bills     {
11134851d45dSJason M. Bills         msg = message->message;
11144851d45dSJason M. Bills         severity = message->severity;
1115c4bf6374SJason M. Bills     }
1116c4bf6374SJason M. Bills 
111715a86ff6SJason M. Bills     // Get the MessageArgs from the log if there are any
111815a86ff6SJason M. Bills     boost::beast::span<std::string> messageArgs;
111915a86ff6SJason M. Bills     if (logEntryFields.size() > 1)
112015a86ff6SJason M. Bills     {
112115a86ff6SJason M. Bills         std::string& messageArgsStart = logEntryFields[1];
112215a86ff6SJason M. Bills         // If the first string is empty, assume there are no MessageArgs
112315a86ff6SJason M. Bills         std::size_t messageArgsSize = 0;
112415a86ff6SJason M. Bills         if (!messageArgsStart.empty())
112515a86ff6SJason M. Bills         {
112615a86ff6SJason M. Bills             messageArgsSize = logEntryFields.size() - 1;
112715a86ff6SJason M. Bills         }
112815a86ff6SJason M. Bills 
112923a21a1cSEd Tanous         messageArgs = {&messageArgsStart, messageArgsSize};
1130c4bf6374SJason M. Bills 
11314851d45dSJason M. Bills         // Fill the MessageArgs into the Message
113295820184SJason M. Bills         int i = 0;
113395820184SJason M. Bills         for (const std::string& messageArg : messageArgs)
11344851d45dSJason M. Bills         {
113595820184SJason M. Bills             std::string argStr = "%" + std::to_string(++i);
11364851d45dSJason M. Bills             size_t argPos = msg.find(argStr);
11374851d45dSJason M. Bills             if (argPos != std::string::npos)
11384851d45dSJason M. Bills             {
113995820184SJason M. Bills                 msg.replace(argPos, argStr.length(), messageArg);
11404851d45dSJason M. Bills             }
11414851d45dSJason M. Bills         }
114215a86ff6SJason M. Bills     }
11434851d45dSJason M. Bills 
114495820184SJason M. Bills     // Get the Created time from the timestamp. The log timestamp is in RFC3339
114595820184SJason M. Bills     // format which matches the Redfish format except for the fractional seconds
114695820184SJason M. Bills     // between the '.' and the '+', so just remove them.
1147f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
1148f23b7296SEd Tanous     std::size_t plus = timestamp.find_first_of('+');
114995820184SJason M. Bills     if (dot != std::string::npos && plus != std::string::npos)
1150c4bf6374SJason M. Bills     {
115195820184SJason M. Bills         timestamp.erase(dot, plus - dot);
1152c4bf6374SJason M. Bills     }
1153c4bf6374SJason M. Bills 
1154c4bf6374SJason M. Bills     // Fill in the log entry with the gathered data
115595820184SJason M. Bills     logEntryJson = {
1156cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
1157029573d4SEd Tanous         {"@odata.id",
1158897967deSJason M. Bills          "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
115995820184SJason M. Bills              logEntryID},
1160c4bf6374SJason M. Bills         {"Name", "System Event Log Entry"},
116195820184SJason M. Bills         {"Id", logEntryID},
116295820184SJason M. Bills         {"Message", std::move(msg)},
116395820184SJason M. Bills         {"MessageId", std::move(messageID)},
1164f23b7296SEd Tanous         {"MessageArgs", messageArgs},
1165c4bf6374SJason M. Bills         {"EntryType", "Event"},
116695820184SJason M. Bills         {"Severity", std::move(severity)},
116795820184SJason M. Bills         {"Created", std::move(timestamp)}};
1168c4bf6374SJason M. Bills     return 0;
1169c4bf6374SJason M. Bills }
1170c4bf6374SJason M. Bills 
117127062605SAnthony Wilson class JournalEventLogEntryCollection : public Node
1172c4bf6374SJason M. Bills {
1173c4bf6374SJason M. Bills   public:
117452cc112dSEd Tanous     JournalEventLogEntryCollection(App& app) :
1175029573d4SEd Tanous         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1176c4bf6374SJason M. Bills     {
1177c4bf6374SJason M. Bills         entityPrivileges = {
1178c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1179c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1180c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1181c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1182c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1183c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1184c4bf6374SJason M. Bills     }
1185c4bf6374SJason M. Bills 
1186c4bf6374SJason M. Bills   private:
11878d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
11888d1b46d7Szhanghch05                const crow::Request& req,
1189cb13a392SEd Tanous                const std::vector<std::string>&) override
1190c4bf6374SJason M. Bills     {
1191271584abSEd Tanous         uint64_t skip = 0;
1192271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
11938d1b46d7Szhanghch05         if (!getSkipParam(asyncResp, req, skip))
1194c4bf6374SJason M. Bills         {
1195c4bf6374SJason M. Bills             return;
1196c4bf6374SJason M. Bills         }
11978d1b46d7Szhanghch05         if (!getTopParam(asyncResp, req, top))
1198c4bf6374SJason M. Bills         {
1199c4bf6374SJason M. Bills             return;
1200c4bf6374SJason M. Bills         }
1201c4bf6374SJason M. Bills         // Collections don't include the static data added by SubRoute because
1202c4bf6374SJason M. Bills         // it has a duplicate entry for members
1203c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1204c4bf6374SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
1205c4bf6374SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1206029573d4SEd Tanous             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1207c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1208c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] =
1209c4bf6374SJason M. Bills             "Collection of System Event Log Entries";
1210cb92c03bSAndrew Geissler 
1211c4bf6374SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1212c4bf6374SJason M. Bills         logEntryArray = nlohmann::json::array();
121395820184SJason M. Bills         // Go through the log files and create a unique ID for each entry
121495820184SJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
121595820184SJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1216b01bf299SEd Tanous         uint64_t entryCount = 0;
1217cd225da8SJason M. Bills         std::string logEntry;
121895820184SJason M. Bills 
121995820184SJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1220cd225da8SJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1221cd225da8SJason M. Bills              it++)
1222c4bf6374SJason M. Bills         {
1223cd225da8SJason M. Bills             std::ifstream logStream(*it);
122495820184SJason M. Bills             if (!logStream.is_open())
1225c4bf6374SJason M. Bills             {
1226c4bf6374SJason M. Bills                 continue;
1227c4bf6374SJason M. Bills             }
1228c4bf6374SJason M. Bills 
1229e85d6b16SJason M. Bills             // Reset the unique ID on the first entry
1230e85d6b16SJason M. Bills             bool firstEntry = true;
123195820184SJason M. Bills             while (std::getline(logStream, logEntry))
123295820184SJason M. Bills             {
1233c4bf6374SJason M. Bills                 entryCount++;
1234c4bf6374SJason M. Bills                 // Handle paging using skip (number of entries to skip from the
1235c4bf6374SJason M. Bills                 // start) and top (number of entries to display)
1236c4bf6374SJason M. Bills                 if (entryCount <= skip || entryCount > skip + top)
1237c4bf6374SJason M. Bills                 {
1238c4bf6374SJason M. Bills                     continue;
1239c4bf6374SJason M. Bills                 }
1240c4bf6374SJason M. Bills 
1241c4bf6374SJason M. Bills                 std::string idStr;
1242e85d6b16SJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1243c4bf6374SJason M. Bills                 {
1244c4bf6374SJason M. Bills                     continue;
1245c4bf6374SJason M. Bills                 }
1246c4bf6374SJason M. Bills 
1247e85d6b16SJason M. Bills                 if (firstEntry)
1248e85d6b16SJason M. Bills                 {
1249e85d6b16SJason M. Bills                     firstEntry = false;
1250e85d6b16SJason M. Bills                 }
1251e85d6b16SJason M. Bills 
1252c4bf6374SJason M. Bills                 logEntryArray.push_back({});
1253c4bf6374SJason M. Bills                 nlohmann::json& bmcLogEntry = logEntryArray.back();
125495820184SJason M. Bills                 if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0)
1255c4bf6374SJason M. Bills                 {
1256c4bf6374SJason M. Bills                     messages::internalError(asyncResp->res);
1257c4bf6374SJason M. Bills                     return;
1258c4bf6374SJason M. Bills                 }
1259c4bf6374SJason M. Bills             }
126095820184SJason M. Bills         }
1261c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1262c4bf6374SJason M. Bills         if (skip + top < entryCount)
1263c4bf6374SJason M. Bills         {
1264c4bf6374SJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
126595820184SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/EventLog/"
126695820184SJason M. Bills                 "Entries?$skip=" +
1267c4bf6374SJason M. Bills                 std::to_string(skip + top);
1268c4bf6374SJason M. Bills         }
126908a4e4b5SAnthony Wilson     }
127008a4e4b5SAnthony Wilson };
127108a4e4b5SAnthony Wilson 
1272897967deSJason M. Bills class JournalEventLogEntry : public Node
1273897967deSJason M. Bills {
1274897967deSJason M. Bills   public:
127552cc112dSEd Tanous     JournalEventLogEntry(App& app) :
1276897967deSJason M. Bills         Node(app,
1277897967deSJason M. Bills              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1278897967deSJason M. Bills              std::string())
1279897967deSJason M. Bills     {
1280897967deSJason M. Bills         entityPrivileges = {
1281897967deSJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1282897967deSJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1283897967deSJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1284897967deSJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1285897967deSJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1286897967deSJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1287897967deSJason M. Bills     }
1288897967deSJason M. Bills 
1289897967deSJason M. Bills   private:
12908d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
12918d1b46d7Szhanghch05                const crow::Request&,
1292897967deSJason M. Bills                const std::vector<std::string>& params) override
1293897967deSJason M. Bills     {
12948d1b46d7Szhanghch05 
1295897967deSJason M. Bills         if (params.size() != 1)
1296897967deSJason M. Bills         {
1297897967deSJason M. Bills             messages::internalError(asyncResp->res);
1298897967deSJason M. Bills             return;
1299897967deSJason M. Bills         }
1300897967deSJason M. Bills         const std::string& targetID = params[0];
1301897967deSJason M. Bills 
1302897967deSJason M. Bills         // Go through the log files and check the unique ID for each entry to
1303897967deSJason M. Bills         // find the target entry
1304897967deSJason M. Bills         std::vector<std::filesystem::path> redfishLogFiles;
1305897967deSJason M. Bills         getRedfishLogFiles(redfishLogFiles);
1306897967deSJason M. Bills         std::string logEntry;
1307897967deSJason M. Bills 
1308897967deSJason M. Bills         // Oldest logs are in the last file, so start there and loop backwards
1309897967deSJason M. Bills         for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1310897967deSJason M. Bills              it++)
1311897967deSJason M. Bills         {
1312897967deSJason M. Bills             std::ifstream logStream(*it);
1313897967deSJason M. Bills             if (!logStream.is_open())
1314897967deSJason M. Bills             {
1315897967deSJason M. Bills                 continue;
1316897967deSJason M. Bills             }
1317897967deSJason M. Bills 
1318897967deSJason M. Bills             // Reset the unique ID on the first entry
1319897967deSJason M. Bills             bool firstEntry = true;
1320897967deSJason M. Bills             while (std::getline(logStream, logEntry))
1321897967deSJason M. Bills             {
1322897967deSJason M. Bills                 std::string idStr;
1323897967deSJason M. Bills                 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1324897967deSJason M. Bills                 {
1325897967deSJason M. Bills                     continue;
1326897967deSJason M. Bills                 }
1327897967deSJason M. Bills 
1328897967deSJason M. Bills                 if (firstEntry)
1329897967deSJason M. Bills                 {
1330897967deSJason M. Bills                     firstEntry = false;
1331897967deSJason M. Bills                 }
1332897967deSJason M. Bills 
1333897967deSJason M. Bills                 if (idStr == targetID)
1334897967deSJason M. Bills                 {
1335897967deSJason M. Bills                     if (fillEventLogEntryJson(idStr, logEntry,
1336897967deSJason M. Bills                                               asyncResp->res.jsonValue) != 0)
1337897967deSJason M. Bills                     {
1338897967deSJason M. Bills                         messages::internalError(asyncResp->res);
1339897967deSJason M. Bills                         return;
1340897967deSJason M. Bills                     }
1341897967deSJason M. Bills                     return;
1342897967deSJason M. Bills                 }
1343897967deSJason M. Bills             }
1344897967deSJason M. Bills         }
1345897967deSJason M. Bills         // Requested ID was not found
1346897967deSJason M. Bills         messages::resourceMissingAtURI(asyncResp->res, targetID);
1347897967deSJason M. Bills     }
1348897967deSJason M. Bills };
1349897967deSJason M. Bills 
135008a4e4b5SAnthony Wilson class DBusEventLogEntryCollection : public Node
135108a4e4b5SAnthony Wilson {
135208a4e4b5SAnthony Wilson   public:
135352cc112dSEd Tanous     DBusEventLogEntryCollection(App& app) :
135408a4e4b5SAnthony Wilson         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
135508a4e4b5SAnthony Wilson     {
135608a4e4b5SAnthony Wilson         entityPrivileges = {
135708a4e4b5SAnthony Wilson             {boost::beast::http::verb::get, {{"Login"}}},
135808a4e4b5SAnthony Wilson             {boost::beast::http::verb::head, {{"Login"}}},
135908a4e4b5SAnthony Wilson             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
136008a4e4b5SAnthony Wilson             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
136108a4e4b5SAnthony Wilson             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
136208a4e4b5SAnthony Wilson             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
136308a4e4b5SAnthony Wilson     }
136408a4e4b5SAnthony Wilson 
136508a4e4b5SAnthony Wilson   private:
13668d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
13678d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
136808a4e4b5SAnthony Wilson     {
136908a4e4b5SAnthony Wilson 
137008a4e4b5SAnthony Wilson         // Collections don't include the static data added by SubRoute because
137108a4e4b5SAnthony Wilson         // it has a duplicate entry for members
137208a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.type"] =
137308a4e4b5SAnthony Wilson             "#LogEntryCollection.LogEntryCollection";
137408a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["@odata.id"] =
137508a4e4b5SAnthony Wilson             "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
137608a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
137708a4e4b5SAnthony Wilson         asyncResp->res.jsonValue["Description"] =
137808a4e4b5SAnthony Wilson             "Collection of System Event Log Entries";
137908a4e4b5SAnthony Wilson 
1380cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1381cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1382cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1383cb92c03bSAndrew Geissler             [asyncResp](const boost::system::error_code ec,
1384cb92c03bSAndrew Geissler                         GetManagedObjectsType& resp) {
1385cb92c03bSAndrew Geissler                 if (ec)
1386cb92c03bSAndrew Geissler                 {
1387cb92c03bSAndrew Geissler                     // TODO Handle for specific error code
1388cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1389cb92c03bSAndrew Geissler                         << "getLogEntriesIfaceData resp_handler got error "
1390cb92c03bSAndrew Geissler                         << ec;
1391cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1392cb92c03bSAndrew Geissler                     return;
1393cb92c03bSAndrew Geissler                 }
1394cb92c03bSAndrew Geissler                 nlohmann::json& entriesArray =
1395cb92c03bSAndrew Geissler                     asyncResp->res.jsonValue["Members"];
1396cb92c03bSAndrew Geissler                 entriesArray = nlohmann::json::array();
1397cb92c03bSAndrew Geissler                 for (auto& objectPath : resp)
1398cb92c03bSAndrew Geissler                 {
139966664f25SEd Tanous                     uint32_t* id = nullptr;
140066664f25SEd Tanous                     std::time_t timestamp{};
1401d139c236SGeorge Liu                     std::time_t updateTimestamp{};
140266664f25SEd Tanous                     std::string* severity = nullptr;
140366664f25SEd Tanous                     std::string* message = nullptr;
1404f86bb901SAdriana Kobylak                     std::string* filePath = nullptr;
140575710de2SXiaochao Ma                     bool resolved = false;
1406f86bb901SAdriana Kobylak                     for (auto& interfaceMap : objectPath.second)
1407f86bb901SAdriana Kobylak                     {
1408f86bb901SAdriana Kobylak                         if (interfaceMap.first ==
1409f86bb901SAdriana Kobylak                             "xyz.openbmc_project.Logging.Entry")
1410f86bb901SAdriana Kobylak                         {
1411cb92c03bSAndrew Geissler                             for (auto& propertyMap : interfaceMap.second)
1412cb92c03bSAndrew Geissler                             {
1413cb92c03bSAndrew Geissler                                 if (propertyMap.first == "Id")
1414cb92c03bSAndrew Geissler                                 {
1415f86bb901SAdriana Kobylak                                     id = std::get_if<uint32_t>(
1416f86bb901SAdriana Kobylak                                         &propertyMap.second);
1417cb92c03bSAndrew Geissler                                 }
1418cb92c03bSAndrew Geissler                                 else if (propertyMap.first == "Timestamp")
1419cb92c03bSAndrew Geissler                                 {
1420cb92c03bSAndrew Geissler                                     const uint64_t* millisTimeStamp =
1421f86bb901SAdriana Kobylak                                         std::get_if<uint64_t>(
1422f86bb901SAdriana Kobylak                                             &propertyMap.second);
1423ae34c8e8SAdriana Kobylak                                     if (millisTimeStamp != nullptr)
1424ebd45906SGeorge Liu                                     {
1425d139c236SGeorge Liu                                         timestamp = crow::utility::getTimestamp(
1426cb92c03bSAndrew Geissler                                             *millisTimeStamp);
1427d139c236SGeorge Liu                                     }
1428ebd45906SGeorge Liu                                 }
1429d139c236SGeorge Liu                                 else if (propertyMap.first == "UpdateTimestamp")
1430d139c236SGeorge Liu                                 {
1431d139c236SGeorge Liu                                     const uint64_t* millisTimeStamp =
1432f86bb901SAdriana Kobylak                                         std::get_if<uint64_t>(
1433f86bb901SAdriana Kobylak                                             &propertyMap.second);
1434ae34c8e8SAdriana Kobylak                                     if (millisTimeStamp != nullptr)
1435ebd45906SGeorge Liu                                     {
1436ebd45906SGeorge Liu                                         updateTimestamp =
1437ebd45906SGeorge Liu                                             crow::utility::getTimestamp(
1438d139c236SGeorge Liu                                                 *millisTimeStamp);
1439cb92c03bSAndrew Geissler                                     }
1440ebd45906SGeorge Liu                                 }
1441cb92c03bSAndrew Geissler                                 else if (propertyMap.first == "Severity")
1442cb92c03bSAndrew Geissler                                 {
1443cb92c03bSAndrew Geissler                                     severity = std::get_if<std::string>(
1444cb92c03bSAndrew Geissler                                         &propertyMap.second);
1445cb92c03bSAndrew Geissler                                 }
1446cb92c03bSAndrew Geissler                                 else if (propertyMap.first == "Message")
1447cb92c03bSAndrew Geissler                                 {
1448cb92c03bSAndrew Geissler                                     message = std::get_if<std::string>(
1449cb92c03bSAndrew Geissler                                         &propertyMap.second);
1450ae34c8e8SAdriana Kobylak                                 }
145175710de2SXiaochao Ma                                 else if (propertyMap.first == "Resolved")
145275710de2SXiaochao Ma                                 {
145375710de2SXiaochao Ma                                     bool* resolveptr =
145475710de2SXiaochao Ma                                         std::get_if<bool>(&propertyMap.second);
145575710de2SXiaochao Ma                                     if (resolveptr == nullptr)
145675710de2SXiaochao Ma                                     {
145775710de2SXiaochao Ma                                         messages::internalError(asyncResp->res);
145875710de2SXiaochao Ma                                         return;
145975710de2SXiaochao Ma                                     }
146075710de2SXiaochao Ma                                     resolved = *resolveptr;
146175710de2SXiaochao Ma                                 }
1462ae34c8e8SAdriana Kobylak                             }
1463ae34c8e8SAdriana Kobylak                             if (id == nullptr || message == nullptr ||
1464ae34c8e8SAdriana Kobylak                                 severity == nullptr)
1465cb92c03bSAndrew Geissler                             {
14660f1d8ed9SAsmitha Karunanithi                                 messages::internalError(asyncResp->res);
1467ae34c8e8SAdriana Kobylak                                 return;
1468cb92c03bSAndrew Geissler                             }
1469f86bb901SAdriana Kobylak                         }
1470f86bb901SAdriana Kobylak                         else if (interfaceMap.first ==
1471f86bb901SAdriana Kobylak                                  "xyz.openbmc_project.Common.FilePath")
1472f86bb901SAdriana Kobylak                         {
1473f86bb901SAdriana Kobylak                             for (auto& propertyMap : interfaceMap.second)
1474f86bb901SAdriana Kobylak                             {
1475f86bb901SAdriana Kobylak                                 if (propertyMap.first == "Path")
1476f86bb901SAdriana Kobylak                                 {
1477f86bb901SAdriana Kobylak                                     filePath = std::get_if<std::string>(
1478f86bb901SAdriana Kobylak                                         &propertyMap.second);
1479f86bb901SAdriana Kobylak                                 }
1480f86bb901SAdriana Kobylak                             }
1481f86bb901SAdriana Kobylak                         }
1482f86bb901SAdriana Kobylak                     }
1483f86bb901SAdriana Kobylak                     // Object path without the xyz.openbmc_project.Logging.Entry
1484f86bb901SAdriana Kobylak                     // interface, ignore and continue.
1485f86bb901SAdriana Kobylak                     if (id == nullptr || message == nullptr ||
1486f86bb901SAdriana Kobylak                         severity == nullptr)
1487f86bb901SAdriana Kobylak                     {
1488f86bb901SAdriana Kobylak                         continue;
1489f86bb901SAdriana Kobylak                     }
1490f86bb901SAdriana Kobylak                     entriesArray.push_back({});
1491f86bb901SAdriana Kobylak                     nlohmann::json& thisEntry = entriesArray.back();
1492f86bb901SAdriana Kobylak                     thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
1493f86bb901SAdriana Kobylak                     thisEntry["@odata.id"] = "/redfish/v1/Systems/system/"
1494f86bb901SAdriana Kobylak                                              "LogServices/EventLog/Entries/" +
1495f86bb901SAdriana Kobylak                                              std::to_string(*id);
1496f86bb901SAdriana Kobylak                     thisEntry["Name"] = "System Event Log Entry";
1497f86bb901SAdriana Kobylak                     thisEntry["Id"] = std::to_string(*id);
1498f86bb901SAdriana Kobylak                     thisEntry["Message"] = *message;
1499f86bb901SAdriana Kobylak                     thisEntry["Resolved"] = resolved;
1500f86bb901SAdriana Kobylak                     thisEntry["EntryType"] = "Event";
1501f86bb901SAdriana Kobylak                     thisEntry["Severity"] =
1502f86bb901SAdriana Kobylak                         translateSeverityDbusToRedfish(*severity);
1503f86bb901SAdriana Kobylak                     thisEntry["Created"] =
1504f86bb901SAdriana Kobylak                         crow::utility::getDateTime(timestamp);
1505f86bb901SAdriana Kobylak                     thisEntry["Modified"] =
1506f86bb901SAdriana Kobylak                         crow::utility::getDateTime(updateTimestamp);
1507f86bb901SAdriana Kobylak                     if (filePath != nullptr)
1508f86bb901SAdriana Kobylak                     {
1509f86bb901SAdriana Kobylak                         thisEntry["AdditionalDataURI"] =
1510cb92c03bSAndrew Geissler                             "/redfish/v1/Systems/system/LogServices/EventLog/"
1511f86bb901SAdriana Kobylak                             "attachment/" +
1512f86bb901SAdriana Kobylak                             std::to_string(*id);
1513cb92c03bSAndrew Geissler                     }
1514cb92c03bSAndrew Geissler                 }
1515cb92c03bSAndrew Geissler                 std::sort(entriesArray.begin(), entriesArray.end(),
1516cb92c03bSAndrew Geissler                           [](const nlohmann::json& left,
1517cb92c03bSAndrew Geissler                              const nlohmann::json& right) {
1518cb92c03bSAndrew Geissler                               return (left["Id"] <= right["Id"]);
1519cb92c03bSAndrew Geissler                           });
1520cb92c03bSAndrew Geissler                 asyncResp->res.jsonValue["Members@odata.count"] =
1521cb92c03bSAndrew Geissler                     entriesArray.size();
1522cb92c03bSAndrew Geissler             },
1523cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
1524cb92c03bSAndrew Geissler             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1525c4bf6374SJason M. Bills     }
1526c4bf6374SJason M. Bills };
1527c4bf6374SJason M. Bills 
152808a4e4b5SAnthony Wilson class DBusEventLogEntry : public Node
1529c4bf6374SJason M. Bills {
1530c4bf6374SJason M. Bills   public:
153152cc112dSEd Tanous     DBusEventLogEntry(App& app) :
1532c4bf6374SJason M. Bills         Node(app,
1533029573d4SEd Tanous              "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1534029573d4SEd Tanous              std::string())
1535c4bf6374SJason M. Bills     {
1536c4bf6374SJason M. Bills         entityPrivileges = {
1537c4bf6374SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1538c4bf6374SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1539c4bf6374SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1540c4bf6374SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1541c4bf6374SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1542c4bf6374SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1543c4bf6374SJason M. Bills     }
1544c4bf6374SJason M. Bills 
1545c4bf6374SJason M. Bills   private:
15468d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
15478d1b46d7Szhanghch05                const crow::Request&,
1548c4bf6374SJason M. Bills                const std::vector<std::string>& params) override
1549c4bf6374SJason M. Bills     {
15508d1b46d7Szhanghch05 
1551029573d4SEd Tanous         if (params.size() != 1)
1552c4bf6374SJason M. Bills         {
1553c4bf6374SJason M. Bills             messages::internalError(asyncResp->res);
1554c4bf6374SJason M. Bills             return;
1555c4bf6374SJason M. Bills         }
1556ae34c8e8SAdriana Kobylak         std::string entryID = params[0];
1557ae34c8e8SAdriana Kobylak         dbus::utility::escapePathForDbus(entryID);
1558cb92c03bSAndrew Geissler 
1559cb92c03bSAndrew Geissler         // DBus implementation of EventLog/Entries
1560cb92c03bSAndrew Geissler         // Make call to Logging Service to find all log entry objects
1561cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
1562cb92c03bSAndrew Geissler             [asyncResp, entryID](const boost::system::error_code ec,
1563cb92c03bSAndrew Geissler                                  GetManagedPropertyType& resp) {
1564ae34c8e8SAdriana Kobylak                 if (ec.value() == EBADR)
1565ae34c8e8SAdriana Kobylak                 {
1566ae34c8e8SAdriana Kobylak                     messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1567ae34c8e8SAdriana Kobylak                                                entryID);
1568ae34c8e8SAdriana Kobylak                     return;
1569ae34c8e8SAdriana Kobylak                 }
1570cb92c03bSAndrew Geissler                 if (ec)
1571cb92c03bSAndrew Geissler                 {
1572cb92c03bSAndrew Geissler                     BMCWEB_LOG_ERROR
1573cb92c03bSAndrew Geissler                         << "EventLogEntry (DBus) resp_handler got error " << ec;
1574cb92c03bSAndrew Geissler                     messages::internalError(asyncResp->res);
1575cb92c03bSAndrew Geissler                     return;
1576cb92c03bSAndrew Geissler                 }
157766664f25SEd Tanous                 uint32_t* id = nullptr;
157866664f25SEd Tanous                 std::time_t timestamp{};
1579d139c236SGeorge Liu                 std::time_t updateTimestamp{};
158066664f25SEd Tanous                 std::string* severity = nullptr;
158166664f25SEd Tanous                 std::string* message = nullptr;
1582f86bb901SAdriana Kobylak                 std::string* filePath = nullptr;
158375710de2SXiaochao Ma                 bool resolved = false;
1584d139c236SGeorge Liu 
1585cb92c03bSAndrew Geissler                 for (auto& propertyMap : resp)
1586cb92c03bSAndrew Geissler                 {
1587cb92c03bSAndrew Geissler                     if (propertyMap.first == "Id")
1588cb92c03bSAndrew Geissler                     {
1589cb92c03bSAndrew Geissler                         id = std::get_if<uint32_t>(&propertyMap.second);
1590cb92c03bSAndrew Geissler                     }
1591cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Timestamp")
1592cb92c03bSAndrew Geissler                     {
1593cb92c03bSAndrew Geissler                         const uint64_t* millisTimeStamp =
1594cb92c03bSAndrew Geissler                             std::get_if<uint64_t>(&propertyMap.second);
1595ae34c8e8SAdriana Kobylak                         if (millisTimeStamp != nullptr)
1596ebd45906SGeorge Liu                         {
1597cb92c03bSAndrew Geissler                             timestamp =
1598d139c236SGeorge Liu                                 crow::utility::getTimestamp(*millisTimeStamp);
1599d139c236SGeorge Liu                         }
1600ebd45906SGeorge Liu                     }
1601d139c236SGeorge Liu                     else if (propertyMap.first == "UpdateTimestamp")
1602d139c236SGeorge Liu                     {
1603d139c236SGeorge Liu                         const uint64_t* millisTimeStamp =
1604d139c236SGeorge Liu                             std::get_if<uint64_t>(&propertyMap.second);
1605ae34c8e8SAdriana Kobylak                         if (millisTimeStamp != nullptr)
1606ebd45906SGeorge Liu                         {
1607d139c236SGeorge Liu                             updateTimestamp =
1608d139c236SGeorge Liu                                 crow::utility::getTimestamp(*millisTimeStamp);
1609cb92c03bSAndrew Geissler                         }
1610ebd45906SGeorge Liu                     }
1611cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Severity")
1612cb92c03bSAndrew Geissler                     {
1613cb92c03bSAndrew Geissler                         severity =
1614cb92c03bSAndrew Geissler                             std::get_if<std::string>(&propertyMap.second);
1615cb92c03bSAndrew Geissler                     }
1616cb92c03bSAndrew Geissler                     else if (propertyMap.first == "Message")
1617cb92c03bSAndrew Geissler                     {
1618cb92c03bSAndrew Geissler                         message = std::get_if<std::string>(&propertyMap.second);
1619cb92c03bSAndrew Geissler                     }
162075710de2SXiaochao Ma                     else if (propertyMap.first == "Resolved")
162175710de2SXiaochao Ma                     {
162275710de2SXiaochao Ma                         bool* resolveptr =
162375710de2SXiaochao Ma                             std::get_if<bool>(&propertyMap.second);
162475710de2SXiaochao Ma                         if (resolveptr == nullptr)
162575710de2SXiaochao Ma                         {
162675710de2SXiaochao Ma                             messages::internalError(asyncResp->res);
162775710de2SXiaochao Ma                             return;
162875710de2SXiaochao Ma                         }
162975710de2SXiaochao Ma                         resolved = *resolveptr;
163075710de2SXiaochao Ma                     }
1631f86bb901SAdriana Kobylak                     else if (propertyMap.first == "Path")
1632f86bb901SAdriana Kobylak                     {
1633f86bb901SAdriana Kobylak                         filePath =
1634f86bb901SAdriana Kobylak                             std::get_if<std::string>(&propertyMap.second);
1635f86bb901SAdriana Kobylak                     }
1636cb92c03bSAndrew Geissler                 }
1637271584abSEd Tanous                 if (id == nullptr || message == nullptr || severity == nullptr)
1638271584abSEd Tanous                 {
1639ae34c8e8SAdriana Kobylak                     messages::internalError(asyncResp->res);
1640271584abSEd Tanous                     return;
1641271584abSEd Tanous                 }
1642f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["@odata.type"] =
1643f86bb901SAdriana Kobylak                     "#LogEntry.v1_8_0.LogEntry";
1644f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["@odata.id"] =
1645f86bb901SAdriana Kobylak                     "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1646f86bb901SAdriana Kobylak                     std::to_string(*id);
1647f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["Name"] = "System Event Log Entry";
1648f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1649f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["Message"] = *message;
1650f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["Resolved"] = resolved;
1651f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["EntryType"] = "Event";
1652f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["Severity"] =
1653f86bb901SAdriana Kobylak                     translateSeverityDbusToRedfish(*severity);
1654f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["Created"] =
1655f86bb901SAdriana Kobylak                     crow::utility::getDateTime(timestamp);
1656f86bb901SAdriana Kobylak                 asyncResp->res.jsonValue["Modified"] =
1657f86bb901SAdriana Kobylak                     crow::utility::getDateTime(updateTimestamp);
1658f86bb901SAdriana Kobylak                 if (filePath != nullptr)
1659f86bb901SAdriana Kobylak                 {
1660f86bb901SAdriana Kobylak                     asyncResp->res.jsonValue["AdditionalDataURI"] =
1661cb92c03bSAndrew Geissler                         "/redfish/v1/Systems/system/LogServices/EventLog/"
1662f86bb901SAdriana Kobylak                         "attachment/" +
1663f86bb901SAdriana Kobylak                         std::to_string(*id);
1664f86bb901SAdriana Kobylak                 }
1665cb92c03bSAndrew Geissler             },
1666cb92c03bSAndrew Geissler             "xyz.openbmc_project.Logging",
1667cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging/entry/" + entryID,
1668f86bb901SAdriana Kobylak             "org.freedesktop.DBus.Properties", "GetAll", "");
1669c4bf6374SJason M. Bills     }
1670336e96c6SChicago Duan 
16718d1b46d7Szhanghch05     void doPatch(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
16728d1b46d7Szhanghch05                  const crow::Request& req,
167375710de2SXiaochao Ma                  const std::vector<std::string>& params) override
167475710de2SXiaochao Ma     {
167575710de2SXiaochao Ma 
167675710de2SXiaochao Ma         if (params.size() != 1)
167775710de2SXiaochao Ma         {
167875710de2SXiaochao Ma             messages::internalError(asyncResp->res);
167975710de2SXiaochao Ma             return;
168075710de2SXiaochao Ma         }
168175710de2SXiaochao Ma         std::string entryId = params[0];
168275710de2SXiaochao Ma 
168375710de2SXiaochao Ma         std::optional<bool> resolved;
168475710de2SXiaochao Ma 
16858d1b46d7Szhanghch05         if (!json_util::readJson(req, asyncResp->res, "Resolved", resolved))
168675710de2SXiaochao Ma         {
168775710de2SXiaochao Ma             return;
168875710de2SXiaochao Ma         }
168975710de2SXiaochao Ma 
169075710de2SXiaochao Ma         if (resolved)
169175710de2SXiaochao Ma         {
169275710de2SXiaochao Ma             BMCWEB_LOG_DEBUG << "Set Resolved";
169375710de2SXiaochao Ma 
169475710de2SXiaochao Ma             crow::connections::systemBus->async_method_call(
169575710de2SXiaochao Ma                 [asyncResp, resolved,
169675710de2SXiaochao Ma                  entryId](const boost::system::error_code ec) {
169775710de2SXiaochao Ma                     if (ec)
169875710de2SXiaochao Ma                     {
169975710de2SXiaochao Ma                         BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
170075710de2SXiaochao Ma                         messages::internalError(asyncResp->res);
170175710de2SXiaochao Ma                         return;
170275710de2SXiaochao Ma                     }
170375710de2SXiaochao Ma                 },
170475710de2SXiaochao Ma                 "xyz.openbmc_project.Logging",
170575710de2SXiaochao Ma                 "/xyz/openbmc_project/logging/entry/" + entryId,
170675710de2SXiaochao Ma                 "org.freedesktop.DBus.Properties", "Set",
170775710de2SXiaochao Ma                 "xyz.openbmc_project.Logging.Entry", "Resolved",
170875710de2SXiaochao Ma                 std::variant<bool>(*resolved));
170975710de2SXiaochao Ma         }
171075710de2SXiaochao Ma     }
171175710de2SXiaochao Ma 
17128d1b46d7Szhanghch05     void doDelete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
17138d1b46d7Szhanghch05                   const crow::Request&,
1714336e96c6SChicago Duan                   const std::vector<std::string>& params) override
1715336e96c6SChicago Duan     {
1716336e96c6SChicago Duan 
1717336e96c6SChicago Duan         BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1718336e96c6SChicago Duan 
1719336e96c6SChicago Duan         if (params.size() != 1)
1720336e96c6SChicago Duan         {
1721336e96c6SChicago Duan             messages::internalError(asyncResp->res);
1722336e96c6SChicago Duan             return;
1723336e96c6SChicago Duan         }
1724336e96c6SChicago Duan         std::string entryID = params[0];
1725336e96c6SChicago Duan 
1726336e96c6SChicago Duan         dbus::utility::escapePathForDbus(entryID);
1727336e96c6SChicago Duan 
1728336e96c6SChicago Duan         // Process response from Logging service.
17293de8d8baSGeorge Liu         auto respHandler = [asyncResp,
17303de8d8baSGeorge Liu                             entryID](const boost::system::error_code ec) {
1731336e96c6SChicago Duan             BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1732336e96c6SChicago Duan             if (ec)
1733336e96c6SChicago Duan             {
17343de8d8baSGeorge Liu                 if (ec.value() == EBADR)
17353de8d8baSGeorge Liu                 {
17363de8d8baSGeorge Liu                     messages::resourceNotFound(asyncResp->res, "LogEntry",
17373de8d8baSGeorge Liu                                                entryID);
17383de8d8baSGeorge Liu                     return;
17393de8d8baSGeorge Liu                 }
1740336e96c6SChicago Duan                 // TODO Handle for specific error code
1741336e96c6SChicago Duan                 BMCWEB_LOG_ERROR
1742336e96c6SChicago Duan                     << "EventLogEntry (DBus) doDelete respHandler got error "
1743336e96c6SChicago Duan                     << ec;
1744336e96c6SChicago Duan                 asyncResp->res.result(
1745336e96c6SChicago Duan                     boost::beast::http::status::internal_server_error);
1746336e96c6SChicago Duan                 return;
1747336e96c6SChicago Duan             }
1748336e96c6SChicago Duan 
1749336e96c6SChicago Duan             asyncResp->res.result(boost::beast::http::status::ok);
1750336e96c6SChicago Duan         };
1751336e96c6SChicago Duan 
1752336e96c6SChicago Duan         // Make call to Logging service to request Delete Log
1753336e96c6SChicago Duan         crow::connections::systemBus->async_method_call(
1754336e96c6SChicago Duan             respHandler, "xyz.openbmc_project.Logging",
1755336e96c6SChicago Duan             "/xyz/openbmc_project/logging/entry/" + entryID,
1756336e96c6SChicago Duan             "xyz.openbmc_project.Object.Delete", "Delete");
1757336e96c6SChicago Duan     }
1758c4bf6374SJason M. Bills };
1759c4bf6374SJason M. Bills 
1760400fd1fbSAdriana Kobylak class DBusEventLogEntryDownload : public Node
1761400fd1fbSAdriana Kobylak {
1762400fd1fbSAdriana Kobylak   public:
1763400fd1fbSAdriana Kobylak     DBusEventLogEntryDownload(App& app) :
1764400fd1fbSAdriana Kobylak         Node(
1765400fd1fbSAdriana Kobylak             app,
1766400fd1fbSAdriana Kobylak             "/redfish/v1/Systems/system/LogServices/EventLog/attachment/<str>/",
1767400fd1fbSAdriana Kobylak             std::string())
1768400fd1fbSAdriana Kobylak     {
1769400fd1fbSAdriana Kobylak         entityPrivileges = {
1770400fd1fbSAdriana Kobylak             {boost::beast::http::verb::get, {{"Login"}}},
1771400fd1fbSAdriana Kobylak             {boost::beast::http::verb::head, {{"Login"}}},
1772400fd1fbSAdriana Kobylak             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1773400fd1fbSAdriana Kobylak             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1774400fd1fbSAdriana Kobylak             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1775400fd1fbSAdriana Kobylak             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1776400fd1fbSAdriana Kobylak     }
1777400fd1fbSAdriana Kobylak 
1778400fd1fbSAdriana Kobylak   private:
17798d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
17808d1b46d7Szhanghch05                const crow::Request& req,
1781400fd1fbSAdriana Kobylak                const std::vector<std::string>& params) override
1782400fd1fbSAdriana Kobylak     {
1783400fd1fbSAdriana Kobylak         if (params.size() != 1)
1784400fd1fbSAdriana Kobylak         {
1785400fd1fbSAdriana Kobylak             messages::internalError(asyncResp->res);
1786400fd1fbSAdriana Kobylak             return;
1787400fd1fbSAdriana Kobylak         }
1788400fd1fbSAdriana Kobylak 
1789400fd1fbSAdriana Kobylak         std::string_view acceptHeader = req.getHeaderValue("Accept");
1790400fd1fbSAdriana Kobylak         // The iterators in boost/http/rfc7230.hpp end the string if '/' is
1791400fd1fbSAdriana Kobylak         // found, so replace it with arbitrary character '|' which is not part
1792400fd1fbSAdriana Kobylak         // of the Accept header syntax.
1793400fd1fbSAdriana Kobylak         std::string acceptStr =
1794400fd1fbSAdriana Kobylak             boost::replace_all_copy(std::string(acceptHeader), "/", "|");
1795400fd1fbSAdriana Kobylak         boost::beast::http::ext_list acceptTypes{acceptStr};
1796400fd1fbSAdriana Kobylak         bool supported = false;
1797400fd1fbSAdriana Kobylak         for (const auto& type : acceptTypes)
1798400fd1fbSAdriana Kobylak         {
1799400fd1fbSAdriana Kobylak             if ((type.first == "*|*") ||
1800400fd1fbSAdriana Kobylak                 (type.first == "application|octet-stream"))
1801400fd1fbSAdriana Kobylak             {
1802400fd1fbSAdriana Kobylak                 supported = true;
1803400fd1fbSAdriana Kobylak                 break;
1804400fd1fbSAdriana Kobylak             }
1805400fd1fbSAdriana Kobylak         }
1806400fd1fbSAdriana Kobylak         if (!supported)
1807400fd1fbSAdriana Kobylak         {
1808400fd1fbSAdriana Kobylak             asyncResp->res.result(boost::beast::http::status::bad_request);
1809400fd1fbSAdriana Kobylak             return;
1810400fd1fbSAdriana Kobylak         }
1811400fd1fbSAdriana Kobylak 
1812400fd1fbSAdriana Kobylak         std::string entryID = params[0];
1813400fd1fbSAdriana Kobylak         dbus::utility::escapePathForDbus(entryID);
1814400fd1fbSAdriana Kobylak 
1815400fd1fbSAdriana Kobylak         crow::connections::systemBus->async_method_call(
1816400fd1fbSAdriana Kobylak             [asyncResp, entryID](const boost::system::error_code ec,
1817400fd1fbSAdriana Kobylak                                  const sdbusplus::message::unix_fd& unixfd) {
1818400fd1fbSAdriana Kobylak                 if (ec.value() == EBADR)
1819400fd1fbSAdriana Kobylak                 {
1820400fd1fbSAdriana Kobylak                     messages::resourceNotFound(asyncResp->res,
1821400fd1fbSAdriana Kobylak                                                "EventLogAttachment", entryID);
1822400fd1fbSAdriana Kobylak                     return;
1823400fd1fbSAdriana Kobylak                 }
1824400fd1fbSAdriana Kobylak                 if (ec)
1825400fd1fbSAdriana Kobylak                 {
1826400fd1fbSAdriana Kobylak                     BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1827400fd1fbSAdriana Kobylak                     messages::internalError(asyncResp->res);
1828400fd1fbSAdriana Kobylak                     return;
1829400fd1fbSAdriana Kobylak                 }
1830400fd1fbSAdriana Kobylak 
1831400fd1fbSAdriana Kobylak                 int fd = -1;
1832400fd1fbSAdriana Kobylak                 fd = dup(unixfd);
1833400fd1fbSAdriana Kobylak                 if (fd == -1)
1834400fd1fbSAdriana Kobylak                 {
1835400fd1fbSAdriana Kobylak                     messages::internalError(asyncResp->res);
1836400fd1fbSAdriana Kobylak                     return;
1837400fd1fbSAdriana Kobylak                 }
1838400fd1fbSAdriana Kobylak 
1839400fd1fbSAdriana Kobylak                 long long int size = lseek(fd, 0, SEEK_END);
1840400fd1fbSAdriana Kobylak                 if (size == -1)
1841400fd1fbSAdriana Kobylak                 {
1842400fd1fbSAdriana Kobylak                     messages::internalError(asyncResp->res);
1843400fd1fbSAdriana Kobylak                     return;
1844400fd1fbSAdriana Kobylak                 }
1845400fd1fbSAdriana Kobylak 
1846400fd1fbSAdriana Kobylak                 // Arbitrary max size of 64kb
1847400fd1fbSAdriana Kobylak                 constexpr int maxFileSize = 65536;
1848400fd1fbSAdriana Kobylak                 if (size > maxFileSize)
1849400fd1fbSAdriana Kobylak                 {
1850400fd1fbSAdriana Kobylak                     BMCWEB_LOG_ERROR
1851400fd1fbSAdriana Kobylak                         << "File size exceeds maximum allowed size of "
1852400fd1fbSAdriana Kobylak                         << maxFileSize;
1853400fd1fbSAdriana Kobylak                     messages::internalError(asyncResp->res);
1854400fd1fbSAdriana Kobylak                     return;
1855400fd1fbSAdriana Kobylak                 }
1856400fd1fbSAdriana Kobylak                 std::vector<char> data(static_cast<size_t>(size));
1857400fd1fbSAdriana Kobylak                 long long int rc = lseek(fd, 0, SEEK_SET);
1858400fd1fbSAdriana Kobylak                 if (rc == -1)
1859400fd1fbSAdriana Kobylak                 {
1860400fd1fbSAdriana Kobylak                     messages::internalError(asyncResp->res);
1861400fd1fbSAdriana Kobylak                     return;
1862400fd1fbSAdriana Kobylak                 }
1863400fd1fbSAdriana Kobylak                 rc = read(fd, data.data(), data.size());
1864400fd1fbSAdriana Kobylak                 if ((rc == -1) || (rc != size))
1865400fd1fbSAdriana Kobylak                 {
1866400fd1fbSAdriana Kobylak                     messages::internalError(asyncResp->res);
1867400fd1fbSAdriana Kobylak                     return;
1868400fd1fbSAdriana Kobylak                 }
1869400fd1fbSAdriana Kobylak                 close(fd);
1870400fd1fbSAdriana Kobylak 
1871400fd1fbSAdriana Kobylak                 std::string_view strData(data.data(), data.size());
1872400fd1fbSAdriana Kobylak                 std::string output = crow::utility::base64encode(strData);
1873400fd1fbSAdriana Kobylak 
1874400fd1fbSAdriana Kobylak                 asyncResp->res.addHeader("Content-Type",
1875400fd1fbSAdriana Kobylak                                          "application/octet-stream");
1876400fd1fbSAdriana Kobylak                 asyncResp->res.addHeader("Content-Transfer-Encoding", "Base64");
1877400fd1fbSAdriana Kobylak                 asyncResp->res.body() = std::move(output);
1878400fd1fbSAdriana Kobylak             },
1879400fd1fbSAdriana Kobylak             "xyz.openbmc_project.Logging",
1880400fd1fbSAdriana Kobylak             "/xyz/openbmc_project/logging/entry/" + entryID,
1881400fd1fbSAdriana Kobylak             "xyz.openbmc_project.Logging.Entry", "GetEntry");
1882400fd1fbSAdriana Kobylak     }
1883400fd1fbSAdriana Kobylak };
1884400fd1fbSAdriana Kobylak 
1885c4bf6374SJason M. Bills class BMCLogServiceCollection : public Node
1886c4bf6374SJason M. Bills {
1887c4bf6374SJason M. Bills   public:
188852cc112dSEd Tanous     BMCLogServiceCollection(App& app) :
18894ed77cd5SEd Tanous         Node(app, "/redfish/v1/Managers/bmc/LogServices/")
18901da66f75SEd Tanous     {
18911da66f75SEd Tanous         entityPrivileges = {
1892e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1893e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1894e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1895e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1896e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1897e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
18981da66f75SEd Tanous     }
18991da66f75SEd Tanous 
19001da66f75SEd Tanous   private:
19011da66f75SEd Tanous     /**
19021da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
19031da66f75SEd Tanous      */
19048d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
19058d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
19061da66f75SEd Tanous     {
19078d1b46d7Szhanghch05 
19081da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
19091da66f75SEd Tanous         // it has a duplicate entry for members
1910e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
19111da66f75SEd Tanous             "#LogServiceCollection.LogServiceCollection";
1912e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
1913e1f26343SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices";
1914e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1915e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
19161da66f75SEd Tanous             "Collection of LogServices for this Manager";
1917c4bf6374SJason M. Bills         nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1918c4bf6374SJason M. Bills         logServiceArray = nlohmann::json::array();
19195cb1dd27SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
19205cb1dd27SAsmitha Karunanithi         logServiceArray.push_back(
19215cb1dd27SAsmitha Karunanithi             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}});
19225cb1dd27SAsmitha Karunanithi #endif
1923c4bf6374SJason M. Bills #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1924c4bf6374SJason M. Bills         logServiceArray.push_back(
192508a4e4b5SAnthony Wilson             {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
1926c4bf6374SJason M. Bills #endif
1927e1f26343SJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] =
1928c4bf6374SJason M. Bills             logServiceArray.size();
19291da66f75SEd Tanous     }
19301da66f75SEd Tanous };
19311da66f75SEd Tanous 
1932c4bf6374SJason M. Bills class BMCJournalLogService : public Node
19331da66f75SEd Tanous {
19341da66f75SEd Tanous   public:
193552cc112dSEd Tanous     BMCJournalLogService(App& app) :
1936c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
1937e1f26343SJason M. Bills     {
1938e1f26343SJason M. Bills         entityPrivileges = {
1939e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
1940e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
1941e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1942e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1943e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1944e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1945e1f26343SJason M. Bills     }
1946e1f26343SJason M. Bills 
1947e1f26343SJason M. Bills   private:
19488d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
19498d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
1950e1f26343SJason M. Bills     {
19518d1b46d7Szhanghch05 
1952e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
1953e1f26343SJason M. Bills             "#LogService.v1_1_0.LogService";
19540f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
19550f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal";
1956c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
1957c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
1958c4bf6374SJason M. Bills         asyncResp->res.jsonValue["Id"] = "BMC Journal";
1959e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1960cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
1961cd50aa42SJason M. Bills             {"@odata.id",
1962086be238SEd Tanous              "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
1963e1f26343SJason M. Bills     }
1964e1f26343SJason M. Bills };
1965e1f26343SJason M. Bills 
1966c4bf6374SJason M. Bills static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1967e1f26343SJason M. Bills                                       sd_journal* journal,
1968c4bf6374SJason M. Bills                                       nlohmann::json& bmcJournalLogEntryJson)
1969e1f26343SJason M. Bills {
1970e1f26343SJason M. Bills     // Get the Log Entry contents
1971e1f26343SJason M. Bills     int ret = 0;
1972e1f26343SJason M. Bills 
1973a8fe54f0SJason M. Bills     std::string message;
1974a8fe54f0SJason M. Bills     std::string_view syslogID;
1975a8fe54f0SJason M. Bills     ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
1976a8fe54f0SJason M. Bills     if (ret < 0)
1977a8fe54f0SJason M. Bills     {
1978a8fe54f0SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: "
1979a8fe54f0SJason M. Bills                          << strerror(-ret);
1980a8fe54f0SJason M. Bills     }
1981a8fe54f0SJason M. Bills     if (!syslogID.empty())
1982a8fe54f0SJason M. Bills     {
1983a8fe54f0SJason M. Bills         message += std::string(syslogID) + ": ";
1984a8fe54f0SJason M. Bills     }
1985a8fe54f0SJason M. Bills 
198639e77504SEd Tanous     std::string_view msg;
198716428a1aSJason M. Bills     ret = getJournalMetadata(journal, "MESSAGE", msg);
1988e1f26343SJason M. Bills     if (ret < 0)
1989e1f26343SJason M. Bills     {
1990e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1991e1f26343SJason M. Bills         return 1;
1992e1f26343SJason M. Bills     }
1993a8fe54f0SJason M. Bills     message += std::string(msg);
1994e1f26343SJason M. Bills 
1995e1f26343SJason M. Bills     // Get the severity from the PRIORITY field
1996271584abSEd Tanous     long int severity = 8; // Default to an invalid priority
199716428a1aSJason M. Bills     ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
1998e1f26343SJason M. Bills     if (ret < 0)
1999e1f26343SJason M. Bills     {
2000e1f26343SJason M. Bills         BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
2001e1f26343SJason M. Bills     }
2002e1f26343SJason M. Bills 
2003e1f26343SJason M. Bills     // Get the Created time from the timestamp
200416428a1aSJason M. Bills     std::string entryTimeStr;
200516428a1aSJason M. Bills     if (!getEntryTimestamp(journal, entryTimeStr))
2006e1f26343SJason M. Bills     {
200716428a1aSJason M. Bills         return 1;
2008e1f26343SJason M. Bills     }
2009e1f26343SJason M. Bills 
2010e1f26343SJason M. Bills     // Fill in the log entry with the gathered data
2011c4bf6374SJason M. Bills     bmcJournalLogEntryJson = {
2012cb92c03bSAndrew Geissler         {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2013c4bf6374SJason M. Bills         {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
2014c4bf6374SJason M. Bills                           bmcJournalLogEntryID},
2015e1f26343SJason M. Bills         {"Name", "BMC Journal Entry"},
2016c4bf6374SJason M. Bills         {"Id", bmcJournalLogEntryID},
2017a8fe54f0SJason M. Bills         {"Message", std::move(message)},
2018e1f26343SJason M. Bills         {"EntryType", "Oem"},
2019738c1e61SPatrick Williams         {"Severity", severity <= 2   ? "Critical"
2020738c1e61SPatrick Williams                      : severity <= 4 ? "Warning"
2021738c1e61SPatrick Williams                                      : "OK"},
2022086be238SEd Tanous         {"OemRecordFormat", "BMC Journal Entry"},
2023e1f26343SJason M. Bills         {"Created", std::move(entryTimeStr)}};
2024e1f26343SJason M. Bills     return 0;
2025e1f26343SJason M. Bills }
2026e1f26343SJason M. Bills 
2027c4bf6374SJason M. Bills class BMCJournalLogEntryCollection : public Node
2028e1f26343SJason M. Bills {
2029e1f26343SJason M. Bills   public:
203052cc112dSEd Tanous     BMCJournalLogEntryCollection(App& app) :
2031c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
2032e1f26343SJason M. Bills     {
2033e1f26343SJason M. Bills         entityPrivileges = {
2034e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
2035e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
2036e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2037e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2038e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2039e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2040e1f26343SJason M. Bills     }
2041e1f26343SJason M. Bills 
2042e1f26343SJason M. Bills   private:
20438d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
20448d1b46d7Szhanghch05                const crow::Request& req,
2045cb13a392SEd Tanous                const std::vector<std::string>&) override
2046e1f26343SJason M. Bills     {
20478d1b46d7Szhanghch05 
2048193ad2faSJason M. Bills         static constexpr const long maxEntriesPerPage = 1000;
2049271584abSEd Tanous         uint64_t skip = 0;
2050271584abSEd Tanous         uint64_t top = maxEntriesPerPage; // Show max entries by default
20518d1b46d7Szhanghch05         if (!getSkipParam(asyncResp, req, skip))
2052193ad2faSJason M. Bills         {
2053193ad2faSJason M. Bills             return;
2054193ad2faSJason M. Bills         }
20558d1b46d7Szhanghch05         if (!getTopParam(asyncResp, req, top))
2056193ad2faSJason M. Bills         {
2057193ad2faSJason M. Bills             return;
2058193ad2faSJason M. Bills         }
2059e1f26343SJason M. Bills         // Collections don't include the static data added by SubRoute because
2060e1f26343SJason M. Bills         // it has a duplicate entry for members
2061e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
2062e1f26343SJason M. Bills             "#LogEntryCollection.LogEntryCollection";
20630f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
20640f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2065e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.id"] =
2066c4bf6374SJason M. Bills             "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2067e1f26343SJason M. Bills         asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
2068e1f26343SJason M. Bills         asyncResp->res.jsonValue["Description"] =
2069e1f26343SJason M. Bills             "Collection of BMC Journal Entries";
20700f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
20710f74e643SEd Tanous             "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries";
2072e1f26343SJason M. Bills         nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2073e1f26343SJason M. Bills         logEntryArray = nlohmann::json::array();
2074e1f26343SJason M. Bills 
2075e1f26343SJason M. Bills         // Go through the journal and use the timestamp to create a unique ID
2076e1f26343SJason M. Bills         // for each entry
2077e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
2078e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2079e1f26343SJason M. Bills         if (ret < 0)
2080e1f26343SJason M. Bills         {
2081e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
2082f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2083e1f26343SJason M. Bills             return;
2084e1f26343SJason M. Bills         }
2085e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2086e1f26343SJason M. Bills             journalTmp, sd_journal_close);
2087e1f26343SJason M. Bills         journalTmp = nullptr;
2088b01bf299SEd Tanous         uint64_t entryCount = 0;
2089e85d6b16SJason M. Bills         // Reset the unique ID on the first entry
2090e85d6b16SJason M. Bills         bool firstEntry = true;
2091e1f26343SJason M. Bills         SD_JOURNAL_FOREACH(journal.get())
2092e1f26343SJason M. Bills         {
2093193ad2faSJason M. Bills             entryCount++;
2094193ad2faSJason M. Bills             // Handle paging using skip (number of entries to skip from the
2095193ad2faSJason M. Bills             // start) and top (number of entries to display)
2096193ad2faSJason M. Bills             if (entryCount <= skip || entryCount > skip + top)
2097193ad2faSJason M. Bills             {
2098193ad2faSJason M. Bills                 continue;
2099193ad2faSJason M. Bills             }
2100193ad2faSJason M. Bills 
210116428a1aSJason M. Bills             std::string idStr;
2102e85d6b16SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2103e1f26343SJason M. Bills             {
2104e1f26343SJason M. Bills                 continue;
2105e1f26343SJason M. Bills             }
2106e1f26343SJason M. Bills 
2107e85d6b16SJason M. Bills             if (firstEntry)
2108e85d6b16SJason M. Bills             {
2109e85d6b16SJason M. Bills                 firstEntry = false;
2110e85d6b16SJason M. Bills             }
2111e85d6b16SJason M. Bills 
2112e1f26343SJason M. Bills             logEntryArray.push_back({});
2113c4bf6374SJason M. Bills             nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
2114c4bf6374SJason M. Bills             if (fillBMCJournalLogEntryJson(idStr, journal.get(),
2115c4bf6374SJason M. Bills                                            bmcJournalLogEntry) != 0)
2116e1f26343SJason M. Bills             {
2117f12894f8SJason M. Bills                 messages::internalError(asyncResp->res);
2118e1f26343SJason M. Bills                 return;
2119e1f26343SJason M. Bills             }
2120e1f26343SJason M. Bills         }
2121193ad2faSJason M. Bills         asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
2122193ad2faSJason M. Bills         if (skip + top < entryCount)
2123193ad2faSJason M. Bills         {
2124193ad2faSJason M. Bills             asyncResp->res.jsonValue["Members@odata.nextLink"] =
2125c4bf6374SJason M. Bills                 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
2126193ad2faSJason M. Bills                 std::to_string(skip + top);
2127193ad2faSJason M. Bills         }
2128e1f26343SJason M. Bills     }
2129e1f26343SJason M. Bills };
2130e1f26343SJason M. Bills 
2131c4bf6374SJason M. Bills class BMCJournalLogEntry : public Node
2132e1f26343SJason M. Bills {
2133e1f26343SJason M. Bills   public:
213452cc112dSEd Tanous     BMCJournalLogEntry(App& app) :
2135c4bf6374SJason M. Bills         Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/",
2136e1f26343SJason M. Bills              std::string())
2137e1f26343SJason M. Bills     {
2138e1f26343SJason M. Bills         entityPrivileges = {
2139e1f26343SJason M. Bills             {boost::beast::http::verb::get, {{"Login"}}},
2140e1f26343SJason M. Bills             {boost::beast::http::verb::head, {{"Login"}}},
2141e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2142e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2143e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2144e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2145e1f26343SJason M. Bills     }
2146e1f26343SJason M. Bills 
2147e1f26343SJason M. Bills   private:
21488d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
21498d1b46d7Szhanghch05                const crow::Request&,
2150e1f26343SJason M. Bills                const std::vector<std::string>& params) override
2151e1f26343SJason M. Bills     {
21528d1b46d7Szhanghch05 
2153e1f26343SJason M. Bills         if (params.size() != 1)
2154e1f26343SJason M. Bills         {
2155f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2156e1f26343SJason M. Bills             return;
2157e1f26343SJason M. Bills         }
215816428a1aSJason M. Bills         const std::string& entryID = params[0];
2159e1f26343SJason M. Bills         // Convert the unique ID back to a timestamp to find the entry
2160e1f26343SJason M. Bills         uint64_t ts = 0;
2161271584abSEd Tanous         uint64_t index = 0;
21628d1b46d7Szhanghch05         if (!getTimestampFromID(asyncResp, entryID, ts, index))
2163e1f26343SJason M. Bills         {
216416428a1aSJason M. Bills             return;
2165e1f26343SJason M. Bills         }
2166e1f26343SJason M. Bills 
2167e1f26343SJason M. Bills         sd_journal* journalTmp = nullptr;
2168e1f26343SJason M. Bills         int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2169e1f26343SJason M. Bills         if (ret < 0)
2170e1f26343SJason M. Bills         {
2171e1f26343SJason M. Bills             BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
2172f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2173e1f26343SJason M. Bills             return;
2174e1f26343SJason M. Bills         }
2175e1f26343SJason M. Bills         std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2176e1f26343SJason M. Bills             journalTmp, sd_journal_close);
2177e1f26343SJason M. Bills         journalTmp = nullptr;
2178e1f26343SJason M. Bills         // Go to the timestamp in the log and move to the entry at the index
2179af07e3f5SJason M. Bills         // tracking the unique ID
2180af07e3f5SJason M. Bills         std::string idStr;
2181af07e3f5SJason M. Bills         bool firstEntry = true;
2182e1f26343SJason M. Bills         ret = sd_journal_seek_realtime_usec(journal.get(), ts);
21832056b6d1SManojkiran Eda         if (ret < 0)
21842056b6d1SManojkiran Eda         {
21852056b6d1SManojkiran Eda             BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
21862056b6d1SManojkiran Eda                              << strerror(-ret);
21872056b6d1SManojkiran Eda             messages::internalError(asyncResp->res);
21882056b6d1SManojkiran Eda             return;
21892056b6d1SManojkiran Eda         }
2190271584abSEd Tanous         for (uint64_t i = 0; i <= index; i++)
2191e1f26343SJason M. Bills         {
2192e1f26343SJason M. Bills             sd_journal_next(journal.get());
2193af07e3f5SJason M. Bills             if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2194af07e3f5SJason M. Bills             {
2195af07e3f5SJason M. Bills                 messages::internalError(asyncResp->res);
2196af07e3f5SJason M. Bills                 return;
2197af07e3f5SJason M. Bills             }
2198af07e3f5SJason M. Bills             if (firstEntry)
2199af07e3f5SJason M. Bills             {
2200af07e3f5SJason M. Bills                 firstEntry = false;
2201af07e3f5SJason M. Bills             }
2202e1f26343SJason M. Bills         }
2203c4bf6374SJason M. Bills         // Confirm that the entry ID matches what was requested
2204af07e3f5SJason M. Bills         if (idStr != entryID)
2205c4bf6374SJason M. Bills         {
2206c4bf6374SJason M. Bills             messages::resourceMissingAtURI(asyncResp->res, entryID);
2207c4bf6374SJason M. Bills             return;
2208c4bf6374SJason M. Bills         }
2209c4bf6374SJason M. Bills 
2210c4bf6374SJason M. Bills         if (fillBMCJournalLogEntryJson(entryID, journal.get(),
2211e1f26343SJason M. Bills                                        asyncResp->res.jsonValue) != 0)
2212e1f26343SJason M. Bills         {
2213f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
2214e1f26343SJason M. Bills             return;
2215e1f26343SJason M. Bills         }
2216e1f26343SJason M. Bills     }
2217e1f26343SJason M. Bills };
2218e1f26343SJason M. Bills 
22195cb1dd27SAsmitha Karunanithi class BMCDumpService : public Node
2220c9bb6861Sraviteja-b {
2221c9bb6861Sraviteja-b   public:
222252cc112dSEd Tanous     BMCDumpService(App& app) :
22235cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
2224c9bb6861Sraviteja-b     {
2225c9bb6861Sraviteja-b         entityPrivileges = {
2226c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2227c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2228c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2229c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2230c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2231c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2232c9bb6861Sraviteja-b     }
2233c9bb6861Sraviteja-b 
2234c9bb6861Sraviteja-b   private:
22358d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22368d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
2237c9bb6861Sraviteja-b     {
2238c9bb6861Sraviteja-b 
2239c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
22405cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump";
2241c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2242d337bb72SAsmitha Karunanithi             "#LogService.v1_2_0.LogService";
2243c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Name"] = "Dump LogService";
22445cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
22455cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
2246c9bb6861Sraviteja-b         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2247c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Entries"] = {
22485cb1dd27SAsmitha Karunanithi             {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
22495cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
22505cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
22515cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
22525cb1dd27SAsmitha Karunanithi                          "Actions/LogService.ClearLog"}}},
2253d337bb72SAsmitha Karunanithi             {"#LogService.CollectDiagnosticData",
2254d337bb72SAsmitha Karunanithi              {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
2255d337bb72SAsmitha Karunanithi                          "Actions/LogService.CollectDiagnosticData"}}}};
2256c9bb6861Sraviteja-b     }
2257c9bb6861Sraviteja-b };
2258c9bb6861Sraviteja-b 
22595cb1dd27SAsmitha Karunanithi class BMCDumpEntryCollection : public Node
2260c9bb6861Sraviteja-b {
2261c9bb6861Sraviteja-b   public:
226252cc112dSEd Tanous     BMCDumpEntryCollection(App& app) :
22635cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
2264c9bb6861Sraviteja-b     {
2265c9bb6861Sraviteja-b         entityPrivileges = {
2266c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2267c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2268c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2269c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2270c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2271c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2272c9bb6861Sraviteja-b     }
2273c9bb6861Sraviteja-b 
2274c9bb6861Sraviteja-b   private:
2275c9bb6861Sraviteja-b     /**
2276c9bb6861Sraviteja-b      * Functions triggers appropriate requests on DBus
2277c9bb6861Sraviteja-b      */
22788d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
22798d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
2280c9bb6861Sraviteja-b     {
2281c9bb6861Sraviteja-b 
2282c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.type"] =
2283c9bb6861Sraviteja-b             "#LogEntryCollection.LogEntryCollection";
2284c9bb6861Sraviteja-b         asyncResp->res.jsonValue["@odata.id"] =
22855cb1dd27SAsmitha Karunanithi             "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
22865cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
2287c9bb6861Sraviteja-b         asyncResp->res.jsonValue["Description"] =
22885cb1dd27SAsmitha Karunanithi             "Collection of BMC Dump Entries";
2289c9bb6861Sraviteja-b 
22905cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "BMC");
2291c9bb6861Sraviteja-b     }
2292c9bb6861Sraviteja-b };
2293c9bb6861Sraviteja-b 
22945cb1dd27SAsmitha Karunanithi class BMCDumpEntry : public Node
2295c9bb6861Sraviteja-b {
2296c9bb6861Sraviteja-b   public:
229752cc112dSEd Tanous     BMCDumpEntry(App& app) :
22985cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/",
2299c9bb6861Sraviteja-b              std::string())
2300c9bb6861Sraviteja-b     {
2301c9bb6861Sraviteja-b         entityPrivileges = {
2302c9bb6861Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2303c9bb6861Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
2304c9bb6861Sraviteja-b             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2305c9bb6861Sraviteja-b             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2306c9bb6861Sraviteja-b             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2307c9bb6861Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2308c9bb6861Sraviteja-b     }
2309c9bb6861Sraviteja-b 
2310c9bb6861Sraviteja-b   private:
23118d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23128d1b46d7Szhanghch05                const crow::Request&,
2313c9bb6861Sraviteja-b                const std::vector<std::string>& params) override
2314c9bb6861Sraviteja-b     {
23158d1b46d7Szhanghch05 
2316c9bb6861Sraviteja-b         if (params.size() != 1)
2317c9bb6861Sraviteja-b         {
2318c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2319c9bb6861Sraviteja-b             return;
2320c9bb6861Sraviteja-b         }
23215cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "BMC");
2322c9bb6861Sraviteja-b     }
2323c9bb6861Sraviteja-b 
23248d1b46d7Szhanghch05     void doDelete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23258d1b46d7Szhanghch05                   const crow::Request&,
2326c9bb6861Sraviteja-b                   const std::vector<std::string>& params) override
2327c9bb6861Sraviteja-b     {
23288d1b46d7Szhanghch05 
2329c9bb6861Sraviteja-b         if (params.size() != 1)
2330c9bb6861Sraviteja-b         {
2331c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2332c9bb6861Sraviteja-b             return;
2333c9bb6861Sraviteja-b         }
23349878256fSStanley Chu         deleteDumpEntry(asyncResp, params[0], "bmc");
23355cb1dd27SAsmitha Karunanithi     }
23365cb1dd27SAsmitha Karunanithi };
2337c9bb6861Sraviteja-b 
2338a43be80fSAsmitha Karunanithi class BMCDumpCreate : public Node
2339a43be80fSAsmitha Karunanithi {
2340a43be80fSAsmitha Karunanithi   public:
234152cc112dSEd Tanous     BMCDumpCreate(App& app) :
2342a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2343d337bb72SAsmitha Karunanithi                   "Actions/"
2344d337bb72SAsmitha Karunanithi                   "LogService.CollectDiagnosticData/")
2345a43be80fSAsmitha Karunanithi     {
2346a43be80fSAsmitha Karunanithi         entityPrivileges = {
2347a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2348a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2349a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2350a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2351a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2352a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2353a43be80fSAsmitha Karunanithi     }
2354a43be80fSAsmitha Karunanithi 
2355a43be80fSAsmitha Karunanithi   private:
23568d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23578d1b46d7Szhanghch05                 const crow::Request& req,
2358cb13a392SEd Tanous                 const std::vector<std::string>&) override
2359a43be80fSAsmitha Karunanithi     {
23608d1b46d7Szhanghch05         createDump(asyncResp, req, "BMC");
2361a43be80fSAsmitha Karunanithi     }
2362a43be80fSAsmitha Karunanithi };
2363a43be80fSAsmitha Karunanithi 
236480319af1SAsmitha Karunanithi class BMCDumpClear : public Node
236580319af1SAsmitha Karunanithi {
236680319af1SAsmitha Karunanithi   public:
236752cc112dSEd Tanous     BMCDumpClear(App& app) :
236880319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
236980319af1SAsmitha Karunanithi                   "Actions/"
237080319af1SAsmitha Karunanithi                   "LogService.ClearLog/")
237180319af1SAsmitha Karunanithi     {
237280319af1SAsmitha Karunanithi         entityPrivileges = {
237380319af1SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
237480319af1SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
237580319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
237680319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
237780319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
237880319af1SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
237980319af1SAsmitha Karunanithi     }
238080319af1SAsmitha Karunanithi 
238180319af1SAsmitha Karunanithi   private:
23828d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
23838d1b46d7Szhanghch05                 const crow::Request&, const std::vector<std::string>&) override
238480319af1SAsmitha Karunanithi     {
23858d1b46d7Szhanghch05         clearDump(asyncResp, "BMC");
238680319af1SAsmitha Karunanithi     }
238780319af1SAsmitha Karunanithi };
238880319af1SAsmitha Karunanithi 
23895cb1dd27SAsmitha Karunanithi class SystemDumpService : public Node
2390c9bb6861Sraviteja-b {
23915cb1dd27SAsmitha Karunanithi   public:
239252cc112dSEd Tanous     SystemDumpService(App& app) :
23935cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/")
23945cb1dd27SAsmitha Karunanithi     {
23955cb1dd27SAsmitha Karunanithi         entityPrivileges = {
23965cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
23975cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
23985cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
23995cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
24005cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
24015cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
24025cb1dd27SAsmitha Karunanithi     }
24035cb1dd27SAsmitha Karunanithi 
24045cb1dd27SAsmitha Karunanithi   private:
24058d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
24068d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
24075cb1dd27SAsmitha Karunanithi     {
24085cb1dd27SAsmitha Karunanithi 
24095cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
24105cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump";
24115cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
2412d337bb72SAsmitha Karunanithi             "#LogService.v1_2_0.LogService";
24135cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "Dump LogService";
24145cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] = "System Dump LogService";
24155cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Id"] = "Dump";
24165cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
24175cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Entries"] = {
24185cb1dd27SAsmitha Karunanithi             {"@odata.id",
24195cb1dd27SAsmitha Karunanithi              "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
24205cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Actions"] = {
24215cb1dd27SAsmitha Karunanithi             {"#LogService.ClearLog",
24225cb1dd27SAsmitha Karunanithi              {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
24235cb1dd27SAsmitha Karunanithi                          "LogService.ClearLog"}}},
2424d337bb72SAsmitha Karunanithi             {"#LogService.CollectDiagnosticData",
2425d337bb72SAsmitha Karunanithi              {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
2426d337bb72SAsmitha Karunanithi                          "LogService.CollectDiagnosticData"}}}};
24275cb1dd27SAsmitha Karunanithi     }
24285cb1dd27SAsmitha Karunanithi };
24295cb1dd27SAsmitha Karunanithi 
24305cb1dd27SAsmitha Karunanithi class SystemDumpEntryCollection : public Node
24315cb1dd27SAsmitha Karunanithi {
24325cb1dd27SAsmitha Karunanithi   public:
243352cc112dSEd Tanous     SystemDumpEntryCollection(App& app) :
24345cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
24355cb1dd27SAsmitha Karunanithi     {
24365cb1dd27SAsmitha Karunanithi         entityPrivileges = {
24375cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
24385cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
24395cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
24405cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
24415cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
24425cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
24435cb1dd27SAsmitha Karunanithi     }
24445cb1dd27SAsmitha Karunanithi 
24455cb1dd27SAsmitha Karunanithi   private:
24465cb1dd27SAsmitha Karunanithi     /**
24475cb1dd27SAsmitha Karunanithi      * Functions triggers appropriate requests on DBus
24485cb1dd27SAsmitha Karunanithi      */
24498d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
24508d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
24515cb1dd27SAsmitha Karunanithi     {
24525cb1dd27SAsmitha Karunanithi 
24535cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.type"] =
24545cb1dd27SAsmitha Karunanithi             "#LogEntryCollection.LogEntryCollection";
24555cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["@odata.id"] =
24565cb1dd27SAsmitha Karunanithi             "/redfish/v1/Systems/system/LogServices/Dump/Entries";
24575cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Name"] = "System Dump Entries";
24585cb1dd27SAsmitha Karunanithi         asyncResp->res.jsonValue["Description"] =
24595cb1dd27SAsmitha Karunanithi             "Collection of System Dump Entries";
24605cb1dd27SAsmitha Karunanithi 
24615cb1dd27SAsmitha Karunanithi         getDumpEntryCollection(asyncResp, "System");
24625cb1dd27SAsmitha Karunanithi     }
24635cb1dd27SAsmitha Karunanithi };
24645cb1dd27SAsmitha Karunanithi 
24655cb1dd27SAsmitha Karunanithi class SystemDumpEntry : public Node
24665cb1dd27SAsmitha Karunanithi {
24675cb1dd27SAsmitha Karunanithi   public:
246852cc112dSEd Tanous     SystemDumpEntry(App& app) :
24695cb1dd27SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/",
24705cb1dd27SAsmitha Karunanithi              std::string())
24715cb1dd27SAsmitha Karunanithi     {
24725cb1dd27SAsmitha Karunanithi         entityPrivileges = {
24735cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
24745cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
24755cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
24765cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
24775cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
24785cb1dd27SAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
24795cb1dd27SAsmitha Karunanithi     }
24805cb1dd27SAsmitha Karunanithi 
24815cb1dd27SAsmitha Karunanithi   private:
24828d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
24838d1b46d7Szhanghch05                const crow::Request&,
24845cb1dd27SAsmitha Karunanithi                const std::vector<std::string>& params) override
24855cb1dd27SAsmitha Karunanithi     {
24868d1b46d7Szhanghch05 
24875cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
24885cb1dd27SAsmitha Karunanithi         {
2489c9bb6861Sraviteja-b             messages::internalError(asyncResp->res);
2490c9bb6861Sraviteja-b             return;
2491c9bb6861Sraviteja-b         }
24925cb1dd27SAsmitha Karunanithi         getDumpEntryById(asyncResp, params[0], "System");
24935cb1dd27SAsmitha Karunanithi     }
2494c9bb6861Sraviteja-b 
24958d1b46d7Szhanghch05     void doDelete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
24968d1b46d7Szhanghch05                   const crow::Request&,
24975cb1dd27SAsmitha Karunanithi                   const std::vector<std::string>& params) override
2498c9bb6861Sraviteja-b     {
24998d1b46d7Szhanghch05 
25005cb1dd27SAsmitha Karunanithi         if (params.size() != 1)
2501c9bb6861Sraviteja-b         {
25025cb1dd27SAsmitha Karunanithi             messages::internalError(asyncResp->res);
2503c9bb6861Sraviteja-b             return;
2504c9bb6861Sraviteja-b         }
25059878256fSStanley Chu         deleteDumpEntry(asyncResp, params[0], "system");
2506c9bb6861Sraviteja-b     }
2507c9bb6861Sraviteja-b };
2508c9bb6861Sraviteja-b 
2509a43be80fSAsmitha Karunanithi class SystemDumpCreate : public Node
2510a43be80fSAsmitha Karunanithi {
2511a43be80fSAsmitha Karunanithi   public:
251252cc112dSEd Tanous     SystemDumpCreate(App& app) :
2513a43be80fSAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2514d337bb72SAsmitha Karunanithi                   "Actions/"
2515d337bb72SAsmitha Karunanithi                   "LogService.CollectDiagnosticData/")
2516a43be80fSAsmitha Karunanithi     {
2517a43be80fSAsmitha Karunanithi         entityPrivileges = {
2518a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::get, {{"Login"}}},
2519a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::head, {{"Login"}}},
2520a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2521a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2522a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2523a43be80fSAsmitha Karunanithi             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2524a43be80fSAsmitha Karunanithi     }
2525a43be80fSAsmitha Karunanithi 
2526a43be80fSAsmitha Karunanithi   private:
25278d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25288d1b46d7Szhanghch05                 const crow::Request& req,
2529cb13a392SEd Tanous                 const std::vector<std::string>&) override
2530a43be80fSAsmitha Karunanithi     {
25318d1b46d7Szhanghch05         createDump(asyncResp, req, "System");
2532a43be80fSAsmitha Karunanithi     }
2533a43be80fSAsmitha Karunanithi };
2534a43be80fSAsmitha Karunanithi 
2535013487e5Sraviteja-b class SystemDumpClear : public Node
2536013487e5Sraviteja-b {
2537013487e5Sraviteja-b   public:
253852cc112dSEd Tanous     SystemDumpClear(App& app) :
253980319af1SAsmitha Karunanithi         Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
2540013487e5Sraviteja-b                   "Actions/"
2541013487e5Sraviteja-b                   "LogService.ClearLog/")
2542013487e5Sraviteja-b     {
2543013487e5Sraviteja-b         entityPrivileges = {
2544013487e5Sraviteja-b             {boost::beast::http::verb::get, {{"Login"}}},
2545013487e5Sraviteja-b             {boost::beast::http::verb::head, {{"Login"}}},
254680319af1SAsmitha Karunanithi             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
254780319af1SAsmitha Karunanithi             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
254880319af1SAsmitha Karunanithi             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2549013487e5Sraviteja-b             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2550013487e5Sraviteja-b     }
2551013487e5Sraviteja-b 
2552013487e5Sraviteja-b   private:
25538d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25548d1b46d7Szhanghch05                 const crow::Request&, const std::vector<std::string>&) override
2555013487e5Sraviteja-b     {
25568d1b46d7Szhanghch05         clearDump(asyncResp, "System");
2557013487e5Sraviteja-b     }
2558013487e5Sraviteja-b };
2559013487e5Sraviteja-b 
2560424c4176SJason M. Bills class CrashdumpService : public Node
2561e1f26343SJason M. Bills {
2562e1f26343SJason M. Bills   public:
256352cc112dSEd Tanous     CrashdumpService(App& app) :
2564424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
25651da66f75SEd Tanous     {
25663946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
25673946028dSAppaRao Puli         // method for security reasons.
25681da66f75SEd Tanous         entityPrivileges = {
25693946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
25703946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2571e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2572e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2573e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2574e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
25751da66f75SEd Tanous     }
25761da66f75SEd Tanous 
25771da66f75SEd Tanous   private:
25781da66f75SEd Tanous     /**
25791da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
25801da66f75SEd Tanous      */
25818d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
25828d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
25831da66f75SEd Tanous     {
25848d1b46d7Szhanghch05 
25851da66f75SEd Tanous         // Copy over the static data to include the entries added by SubRoute
25860f74e643SEd Tanous         asyncResp->res.jsonValue["@odata.id"] =
2587424c4176SJason M. Bills             "/redfish/v1/Systems/system/LogServices/Crashdump";
2588e1f26343SJason M. Bills         asyncResp->res.jsonValue["@odata.type"] =
25898e6c099aSJason M. Bills             "#LogService.v1_2_0.LogService";
25904f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
25914f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
25924f50ae4bSGunnar Mills         asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
2593e1f26343SJason M. Bills         asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2594e1f26343SJason M. Bills         asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
2595cd50aa42SJason M. Bills         asyncResp->res.jsonValue["Entries"] = {
2596cd50aa42SJason M. Bills             {"@odata.id",
2597424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
2598e1f26343SJason M. Bills         asyncResp->res.jsonValue["Actions"] = {
25995b61b5e8SJason M. Bills             {"#LogService.ClearLog",
26005b61b5e8SJason M. Bills              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
26015b61b5e8SJason M. Bills                          "Actions/LogService.ClearLog"}}},
26028e6c099aSJason M. Bills             {"#LogService.CollectDiagnosticData",
2603424c4176SJason M. Bills              {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
26048e6c099aSJason M. Bills                          "Actions/LogService.CollectDiagnosticData"}}}};
26051da66f75SEd Tanous     }
26061da66f75SEd Tanous };
26071da66f75SEd Tanous 
26085b61b5e8SJason M. Bills class CrashdumpClear : public Node
26095b61b5e8SJason M. Bills {
26105b61b5e8SJason M. Bills   public:
261152cc112dSEd Tanous     CrashdumpClear(App& app) :
26125b61b5e8SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
26135b61b5e8SJason M. Bills                   "LogService.ClearLog/")
26145b61b5e8SJason M. Bills     {
26153946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
26163946028dSAppaRao Puli         // method for security reasons.
26175b61b5e8SJason M. Bills         entityPrivileges = {
26183946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
26193946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
26205b61b5e8SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
26215b61b5e8SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
26225b61b5e8SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
26235b61b5e8SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
26245b61b5e8SJason M. Bills     }
26255b61b5e8SJason M. Bills 
26265b61b5e8SJason M. Bills   private:
26278d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
26288d1b46d7Szhanghch05                 const crow::Request&, const std::vector<std::string>&) override
26295b61b5e8SJason M. Bills     {
26305b61b5e8SJason M. Bills 
26315b61b5e8SJason M. Bills         crow::connections::systemBus->async_method_call(
26325b61b5e8SJason M. Bills             [asyncResp](const boost::system::error_code ec,
2633cb13a392SEd Tanous                         const std::string&) {
26345b61b5e8SJason M. Bills                 if (ec)
26355b61b5e8SJason M. Bills                 {
26365b61b5e8SJason M. Bills                     messages::internalError(asyncResp->res);
26375b61b5e8SJason M. Bills                     return;
26385b61b5e8SJason M. Bills                 }
26395b61b5e8SJason M. Bills                 messages::success(asyncResp->res);
26405b61b5e8SJason M. Bills             },
26415b61b5e8SJason M. Bills             crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
26425b61b5e8SJason M. Bills     }
26435b61b5e8SJason M. Bills };
26445b61b5e8SJason M. Bills 
26458d1b46d7Szhanghch05 static void
26468d1b46d7Szhanghch05     logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
26478d1b46d7Szhanghch05                       const std::string& logID, nlohmann::json& logEntryJson)
2648e855dd28SJason M. Bills {
2649043a0536SJohnathan Mantey     auto getStoredLogCallback =
2650043a0536SJohnathan Mantey         [asyncResp, logID, &logEntryJson](
2651e855dd28SJason M. Bills             const boost::system::error_code ec,
2652043a0536SJohnathan Mantey             const std::vector<std::pair<std::string, VariantType>>& params) {
2653e855dd28SJason M. Bills             if (ec)
2654e855dd28SJason M. Bills             {
2655e855dd28SJason M. Bills                 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
26561ddcf01aSJason M. Bills                 if (ec.value() ==
26571ddcf01aSJason M. Bills                     boost::system::linux_error::bad_request_descriptor)
26581ddcf01aSJason M. Bills                 {
2659043a0536SJohnathan Mantey                     messages::resourceNotFound(asyncResp->res, "LogEntry",
2660043a0536SJohnathan Mantey                                                logID);
26611ddcf01aSJason M. Bills                 }
26621ddcf01aSJason M. Bills                 else
26631ddcf01aSJason M. Bills                 {
2664e855dd28SJason M. Bills                     messages::internalError(asyncResp->res);
26651ddcf01aSJason M. Bills                 }
2666e855dd28SJason M. Bills                 return;
2667e855dd28SJason M. Bills             }
2668043a0536SJohnathan Mantey 
2669043a0536SJohnathan Mantey             std::string timestamp{};
2670043a0536SJohnathan Mantey             std::string filename{};
2671043a0536SJohnathan Mantey             std::string logfile{};
26722c70f800SEd Tanous             parseCrashdumpParameters(params, filename, timestamp, logfile);
2673043a0536SJohnathan Mantey 
2674043a0536SJohnathan Mantey             if (filename.empty() || timestamp.empty())
2675e855dd28SJason M. Bills             {
2676043a0536SJohnathan Mantey                 messages::resourceMissingAtURI(asyncResp->res, logID);
2677e855dd28SJason M. Bills                 return;
2678e855dd28SJason M. Bills             }
2679e855dd28SJason M. Bills 
2680043a0536SJohnathan Mantey             std::string crashdumpURI =
2681e855dd28SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2682043a0536SJohnathan Mantey                 logID + "/" + filename;
26838e6c099aSJason M. Bills             logEntryJson = {{"@odata.type", "#LogEntry.v1_7_0.LogEntry"},
2684043a0536SJohnathan Mantey                             {"@odata.id", "/redfish/v1/Systems/system/"
2685043a0536SJohnathan Mantey                                           "LogServices/Crashdump/Entries/" +
2686e855dd28SJason M. Bills                                               logID},
2687e855dd28SJason M. Bills                             {"Name", "CPU Crashdump"},
2688e855dd28SJason M. Bills                             {"Id", logID},
2689e855dd28SJason M. Bills                             {"EntryType", "Oem"},
26908e6c099aSJason M. Bills                             {"AdditionalDataURI", std::move(crashdumpURI)},
26918e6c099aSJason M. Bills                             {"DiagnosticDataType", "OEM"},
26928e6c099aSJason M. Bills                             {"OEMDiagnosticDataType", "PECICrashdump"},
2693043a0536SJohnathan Mantey                             {"Created", std::move(timestamp)}};
2694e855dd28SJason M. Bills         };
2695e855dd28SJason M. Bills     crow::connections::systemBus->async_method_call(
26965b61b5e8SJason M. Bills         std::move(getStoredLogCallback), crashdumpObject,
26975b61b5e8SJason M. Bills         crashdumpPath + std::string("/") + logID,
2698043a0536SJohnathan Mantey         "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
2699e855dd28SJason M. Bills }
2700e855dd28SJason M. Bills 
2701424c4176SJason M. Bills class CrashdumpEntryCollection : public Node
27021da66f75SEd Tanous {
27031da66f75SEd Tanous   public:
270452cc112dSEd Tanous     CrashdumpEntryCollection(App& app) :
2705424c4176SJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
27061da66f75SEd Tanous     {
27073946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
27083946028dSAppaRao Puli         // method for security reasons.
27091da66f75SEd Tanous         entityPrivileges = {
27103946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
27113946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2712e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2713e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2714e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2715e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
27161da66f75SEd Tanous     }
27171da66f75SEd Tanous 
27181da66f75SEd Tanous   private:
27191da66f75SEd Tanous     /**
27201da66f75SEd Tanous      * Functions triggers appropriate requests on DBus
27211da66f75SEd Tanous      */
27228d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
27238d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
27241da66f75SEd Tanous     {
27258d1b46d7Szhanghch05 
27261da66f75SEd Tanous         // Collections don't include the static data added by SubRoute because
27271da66f75SEd Tanous         // it has a duplicate entry for members
2728e1f26343SJason M. Bills         auto getLogEntriesCallback = [asyncResp](
2729e1f26343SJason M. Bills                                          const boost::system::error_code ec,
27301da66f75SEd Tanous                                          const std::vector<std::string>& resp) {
27311da66f75SEd Tanous             if (ec)
27321da66f75SEd Tanous             {
27331da66f75SEd Tanous                 if (ec.value() !=
27341da66f75SEd Tanous                     boost::system::errc::no_such_file_or_directory)
27351da66f75SEd Tanous                 {
27361da66f75SEd Tanous                     BMCWEB_LOG_DEBUG << "failed to get entries ec: "
27371da66f75SEd Tanous                                      << ec.message();
2738f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
27391da66f75SEd Tanous                     return;
27401da66f75SEd Tanous                 }
27411da66f75SEd Tanous             }
2742e1f26343SJason M. Bills             asyncResp->res.jsonValue["@odata.type"] =
27431da66f75SEd Tanous                 "#LogEntryCollection.LogEntryCollection";
27440f74e643SEd Tanous             asyncResp->res.jsonValue["@odata.id"] =
2745424c4176SJason M. Bills                 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
2746424c4176SJason M. Bills             asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
2747e1f26343SJason M. Bills             asyncResp->res.jsonValue["Description"] =
2748424c4176SJason M. Bills                 "Collection of Crashdump Entries";
2749e1f26343SJason M. Bills             nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2750e1f26343SJason M. Bills             logEntryArray = nlohmann::json::array();
2751e855dd28SJason M. Bills             std::vector<std::string> logIDs;
2752e855dd28SJason M. Bills             // Get the list of log entries and build up an empty array big
2753e855dd28SJason M. Bills             // enough to hold them
27541da66f75SEd Tanous             for (const std::string& objpath : resp)
27551da66f75SEd Tanous             {
2756e855dd28SJason M. Bills                 // Get the log ID
2757f23b7296SEd Tanous                 std::size_t lastPos = objpath.rfind('/');
2758e855dd28SJason M. Bills                 if (lastPos == std::string::npos)
27591da66f75SEd Tanous                 {
2760e855dd28SJason M. Bills                     continue;
27611da66f75SEd Tanous                 }
2762e855dd28SJason M. Bills                 logIDs.emplace_back(objpath.substr(lastPos + 1));
2763e855dd28SJason M. Bills 
2764e855dd28SJason M. Bills                 // Add a space for the log entry to the array
2765e855dd28SJason M. Bills                 logEntryArray.push_back({});
2766e855dd28SJason M. Bills             }
2767e855dd28SJason M. Bills             // Now go through and set up async calls to fill in the entries
2768e855dd28SJason M. Bills             size_t index = 0;
2769e855dd28SJason M. Bills             for (const std::string& logID : logIDs)
2770e855dd28SJason M. Bills             {
2771e855dd28SJason M. Bills                 // Add the log entry to the array
2772e855dd28SJason M. Bills                 logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
27731da66f75SEd Tanous             }
2774e1f26343SJason M. Bills             asyncResp->res.jsonValue["Members@odata.count"] =
2775e1f26343SJason M. Bills                 logEntryArray.size();
27761da66f75SEd Tanous         };
27771da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
27781da66f75SEd Tanous             std::move(getLogEntriesCallback),
27791da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper",
27801da66f75SEd Tanous             "/xyz/openbmc_project/object_mapper",
27811da66f75SEd Tanous             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
27825b61b5e8SJason M. Bills             std::array<const char*, 1>{crashdumpInterface});
27831da66f75SEd Tanous     }
27841da66f75SEd Tanous };
27851da66f75SEd Tanous 
2786424c4176SJason M. Bills class CrashdumpEntry : public Node
27871da66f75SEd Tanous {
27881da66f75SEd Tanous   public:
278952cc112dSEd Tanous     CrashdumpEntry(App& app) :
2790d53dd41fSJason M. Bills         Node(app,
2791424c4176SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/",
27921da66f75SEd Tanous              std::string())
27931da66f75SEd Tanous     {
27943946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
27953946028dSAppaRao Puli         // method for security reasons.
27961da66f75SEd Tanous         entityPrivileges = {
27973946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
27983946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2799e1f26343SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2800e1f26343SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2801e1f26343SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2802e1f26343SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
28031da66f75SEd Tanous     }
28041da66f75SEd Tanous 
28051da66f75SEd Tanous   private:
28068d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
28078d1b46d7Szhanghch05                const crow::Request&,
28081da66f75SEd Tanous                const std::vector<std::string>& params) override
28091da66f75SEd Tanous     {
28108d1b46d7Szhanghch05 
28111da66f75SEd Tanous         if (params.size() != 1)
28121da66f75SEd Tanous         {
2813f12894f8SJason M. Bills             messages::internalError(asyncResp->res);
28141da66f75SEd Tanous             return;
28151da66f75SEd Tanous         }
2816e855dd28SJason M. Bills         const std::string& logID = params[0];
2817e855dd28SJason M. Bills         logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
2818e855dd28SJason M. Bills     }
2819e855dd28SJason M. Bills };
2820e855dd28SJason M. Bills 
2821e855dd28SJason M. Bills class CrashdumpFile : public Node
2822e855dd28SJason M. Bills {
2823e855dd28SJason M. Bills   public:
282452cc112dSEd Tanous     CrashdumpFile(App& app) :
2825e855dd28SJason M. Bills         Node(app,
2826e855dd28SJason M. Bills              "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/"
2827e855dd28SJason M. Bills              "<str>/",
2828e855dd28SJason M. Bills              std::string(), std::string())
2829e855dd28SJason M. Bills     {
28303946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
28313946028dSAppaRao Puli         // method for security reasons.
2832e855dd28SJason M. Bills         entityPrivileges = {
28333946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
28343946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2835e855dd28SJason M. Bills             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2836e855dd28SJason M. Bills             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2837e855dd28SJason M. Bills             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2838e855dd28SJason M. Bills             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2839e855dd28SJason M. Bills     }
2840e855dd28SJason M. Bills 
2841e855dd28SJason M. Bills   private:
28428d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
28438d1b46d7Szhanghch05                const crow::Request&,
2844e855dd28SJason M. Bills                const std::vector<std::string>& params) override
2845e855dd28SJason M. Bills     {
28468d1b46d7Szhanghch05 
2847e855dd28SJason M. Bills         if (params.size() != 2)
2848e855dd28SJason M. Bills         {
2849e855dd28SJason M. Bills             messages::internalError(asyncResp->res);
2850e855dd28SJason M. Bills             return;
2851e855dd28SJason M. Bills         }
2852e855dd28SJason M. Bills         const std::string& logID = params[0];
2853e855dd28SJason M. Bills         const std::string& fileName = params[1];
2854e855dd28SJason M. Bills 
2855043a0536SJohnathan Mantey         auto getStoredLogCallback =
2856043a0536SJohnathan Mantey             [asyncResp, logID, fileName](
2857abf2add6SEd Tanous                 const boost::system::error_code ec,
2858043a0536SJohnathan Mantey                 const std::vector<std::pair<std::string, VariantType>>& resp) {
28591da66f75SEd Tanous                 if (ec)
28601da66f75SEd Tanous                 {
2861043a0536SJohnathan Mantey                     BMCWEB_LOG_DEBUG << "failed to get log ec: "
2862043a0536SJohnathan Mantey                                      << ec.message();
2863f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
28641da66f75SEd Tanous                     return;
28651da66f75SEd Tanous                 }
2866e855dd28SJason M. Bills 
2867043a0536SJohnathan Mantey                 std::string dbusFilename{};
2868043a0536SJohnathan Mantey                 std::string dbusTimestamp{};
2869043a0536SJohnathan Mantey                 std::string dbusFilepath{};
2870043a0536SJohnathan Mantey 
28712c70f800SEd Tanous                 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
2872043a0536SJohnathan Mantey                                          dbusFilepath);
2873043a0536SJohnathan Mantey 
2874043a0536SJohnathan Mantey                 if (dbusFilename.empty() || dbusTimestamp.empty() ||
2875043a0536SJohnathan Mantey                     dbusFilepath.empty())
28761da66f75SEd Tanous                 {
2877e855dd28SJason M. Bills                     messages::resourceMissingAtURI(asyncResp->res, fileName);
28781da66f75SEd Tanous                     return;
28791da66f75SEd Tanous                 }
2880e855dd28SJason M. Bills 
2881043a0536SJohnathan Mantey                 // Verify the file name parameter is correct
2882043a0536SJohnathan Mantey                 if (fileName != dbusFilename)
2883043a0536SJohnathan Mantey                 {
2884043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2885043a0536SJohnathan Mantey                     return;
2886043a0536SJohnathan Mantey                 }
2887043a0536SJohnathan Mantey 
2888043a0536SJohnathan Mantey                 if (!std::filesystem::exists(dbusFilepath))
2889043a0536SJohnathan Mantey                 {
2890043a0536SJohnathan Mantey                     messages::resourceMissingAtURI(asyncResp->res, fileName);
2891043a0536SJohnathan Mantey                     return;
2892043a0536SJohnathan Mantey                 }
2893043a0536SJohnathan Mantey                 std::ifstream ifs(dbusFilepath, std::ios::in |
2894043a0536SJohnathan Mantey                                                     std::ios::binary |
2895043a0536SJohnathan Mantey                                                     std::ios::ate);
2896043a0536SJohnathan Mantey                 std::ifstream::pos_type fileSize = ifs.tellg();
2897043a0536SJohnathan Mantey                 if (fileSize < 0)
2898043a0536SJohnathan Mantey                 {
2899043a0536SJohnathan Mantey                     messages::generalError(asyncResp->res);
2900043a0536SJohnathan Mantey                     return;
2901043a0536SJohnathan Mantey                 }
2902043a0536SJohnathan Mantey                 ifs.seekg(0, std::ios::beg);
2903043a0536SJohnathan Mantey 
2904043a0536SJohnathan Mantey                 auto crashData = std::make_unique<char[]>(
2905043a0536SJohnathan Mantey                     static_cast<unsigned int>(fileSize));
2906043a0536SJohnathan Mantey 
2907043a0536SJohnathan Mantey                 ifs.read(crashData.get(), static_cast<int>(fileSize));
2908043a0536SJohnathan Mantey 
2909043a0536SJohnathan Mantey                 // The cast to std::string is intentional in order to use the
2910043a0536SJohnathan Mantey                 // assign() that applies move mechanics
2911043a0536SJohnathan Mantey                 asyncResp->res.body().assign(
2912043a0536SJohnathan Mantey                     static_cast<std::string>(crashData.get()));
2913043a0536SJohnathan Mantey 
2914043a0536SJohnathan Mantey                 // Configure this to be a file download when accessed from
2915043a0536SJohnathan Mantey                 // a browser
2916e855dd28SJason M. Bills                 asyncResp->res.addHeader("Content-Disposition", "attachment");
29171da66f75SEd Tanous             };
29181da66f75SEd Tanous         crow::connections::systemBus->async_method_call(
29195b61b5e8SJason M. Bills             std::move(getStoredLogCallback), crashdumpObject,
29205b61b5e8SJason M. Bills             crashdumpPath + std::string("/") + logID,
2921043a0536SJohnathan Mantey             "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
29221da66f75SEd Tanous     }
29231da66f75SEd Tanous };
29241da66f75SEd Tanous 
29258e6c099aSJason M. Bills class CrashdumpCollect : public Node
29261da66f75SEd Tanous {
29271da66f75SEd Tanous   public:
29288e6c099aSJason M. Bills     CrashdumpCollect(App& app) :
29298e6c099aSJason M. Bills         Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
29308e6c099aSJason M. Bills                   "LogService.CollectDiagnosticData/")
29311da66f75SEd Tanous     {
29323946028dSAppaRao Puli         // Note: Deviated from redfish privilege registry for GET & HEAD
29333946028dSAppaRao Puli         // method for security reasons.
29341da66f75SEd Tanous         entityPrivileges = {
29353946028dSAppaRao Puli             {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
29363946028dSAppaRao Puli             {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
29373946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
29383946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
29393946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
29403946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
29411da66f75SEd Tanous     }
29421da66f75SEd Tanous 
29431da66f75SEd Tanous   private:
29448d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
29458d1b46d7Szhanghch05                 const crow::Request& req,
2946cb13a392SEd Tanous                 const std::vector<std::string>&) override
29471da66f75SEd Tanous     {
29481da66f75SEd Tanous 
29498e6c099aSJason M. Bills         std::string diagnosticDataType;
29508e6c099aSJason M. Bills         std::string oemDiagnosticDataType;
29518e6c099aSJason M. Bills         if (!redfish::json_util::readJson(
29528e6c099aSJason M. Bills                 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
29538e6c099aSJason M. Bills                 "OEMDiagnosticDataType", oemDiagnosticDataType))
29548e6c099aSJason M. Bills         {
29558e6c099aSJason M. Bills             return;
29568e6c099aSJason M. Bills         }
29578e6c099aSJason M. Bills 
29588e6c099aSJason M. Bills         if (diagnosticDataType != "OEM")
29598e6c099aSJason M. Bills         {
29608e6c099aSJason M. Bills             BMCWEB_LOG_ERROR
29618e6c099aSJason M. Bills                 << "Only OEM DiagnosticDataType supported for Crashdump";
29628e6c099aSJason M. Bills             messages::actionParameterValueFormatError(
29638e6c099aSJason M. Bills                 asyncResp->res, diagnosticDataType, "DiagnosticDataType",
29648e6c099aSJason M. Bills                 "CollectDiagnosticData");
29658e6c099aSJason M. Bills             return;
29668e6c099aSJason M. Bills         }
29678e6c099aSJason M. Bills 
29688e6c099aSJason M. Bills         auto collectCrashdumpCallback = [asyncResp, req](
29698e6c099aSJason M. Bills                                             const boost::system::error_code ec,
2970cb13a392SEd Tanous                                             const std::string&) {
29711da66f75SEd Tanous             if (ec)
29721da66f75SEd Tanous             {
297346229577SJames Feist                 if (ec.value() == boost::system::errc::operation_not_supported)
29741da66f75SEd Tanous                 {
2975f12894f8SJason M. Bills                     messages::resourceInStandby(asyncResp->res);
29761da66f75SEd Tanous                 }
29774363d3b2SJason M. Bills                 else if (ec.value() ==
29784363d3b2SJason M. Bills                          boost::system::errc::device_or_resource_busy)
29794363d3b2SJason M. Bills                 {
29804363d3b2SJason M. Bills                     messages::serviceTemporarilyUnavailable(asyncResp->res,
29814363d3b2SJason M. Bills                                                             "60");
29824363d3b2SJason M. Bills                 }
29831da66f75SEd Tanous                 else
29841da66f75SEd Tanous                 {
2985f12894f8SJason M. Bills                     messages::internalError(asyncResp->res);
29861da66f75SEd Tanous                 }
29871da66f75SEd Tanous                 return;
29881da66f75SEd Tanous             }
298946229577SJames Feist             std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
299066afe4faSJames Feist                 [](boost::system::error_code err, sdbusplus::message::message&,
299166afe4faSJames Feist                    const std::shared_ptr<task::TaskData>& taskData) {
299266afe4faSJames Feist                     if (!err)
299366afe4faSJames Feist                     {
2994e5d5006bSJames Feist                         taskData->messages.emplace_back(
2995e5d5006bSJames Feist                             messages::taskCompletedOK(
2996e5d5006bSJames Feist                                 std::to_string(taskData->index)));
2997831d6b09SJames Feist                         taskData->state = "Completed";
299866afe4faSJames Feist                     }
299932898ceaSJames Feist                     return task::completed;
300066afe4faSJames Feist                 },
300146229577SJames Feist                 "type='signal',interface='org.freedesktop.DBus.Properties',"
300246229577SJames Feist                 "member='PropertiesChanged',arg0namespace='com.intel."
300346229577SJames Feist                 "crashdump'");
300446229577SJames Feist             task->startTimer(std::chrono::minutes(5));
300546229577SJames Feist             task->populateResp(asyncResp->res);
3006fe306728SJames Feist             task->payload.emplace(req);
30071da66f75SEd Tanous         };
30088e6c099aSJason M. Bills 
30098e6c099aSJason M. Bills         if (oemDiagnosticDataType == "OnDemand")
30108e6c099aSJason M. Bills         {
30111da66f75SEd Tanous             crow::connections::systemBus->async_method_call(
30128e6c099aSJason M. Bills                 std::move(collectCrashdumpCallback), crashdumpObject,
30138e6c099aSJason M. Bills                 crashdumpPath, crashdumpOnDemandInterface,
30148e6c099aSJason M. Bills                 "GenerateOnDemandLog");
30151da66f75SEd Tanous         }
30168e6c099aSJason M. Bills         else if (oemDiagnosticDataType == "Telemetry")
30176eda7685SKenny L. Ku         {
30188e6c099aSJason M. Bills             crow::connections::systemBus->async_method_call(
30198e6c099aSJason M. Bills                 std::move(collectCrashdumpCallback), crashdumpObject,
30208e6c099aSJason M. Bills                 crashdumpPath, crashdumpTelemetryInterface,
30218e6c099aSJason M. Bills                 "GenerateTelemetryLog");
30226eda7685SKenny L. Ku         }
30236eda7685SKenny L. Ku         else
30246eda7685SKenny L. Ku         {
30258e6c099aSJason M. Bills             BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: "
30268e6c099aSJason M. Bills                              << oemDiagnosticDataType;
30278e6c099aSJason M. Bills             messages::actionParameterValueFormatError(
30288e6c099aSJason M. Bills                 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType",
30298e6c099aSJason M. Bills                 "CollectDiagnosticData");
30306eda7685SKenny L. Ku             return;
30316eda7685SKenny L. Ku         }
30326eda7685SKenny L. Ku     }
30336eda7685SKenny L. Ku };
30346eda7685SKenny L. Ku 
3035cb92c03bSAndrew Geissler /**
3036cb92c03bSAndrew Geissler  * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3037cb92c03bSAndrew Geissler  */
3038cb92c03bSAndrew Geissler class DBusLogServiceActionsClear : public Node
3039cb92c03bSAndrew Geissler {
3040cb92c03bSAndrew Geissler   public:
304152cc112dSEd Tanous     DBusLogServiceActionsClear(App& app) :
3042cb92c03bSAndrew Geissler         Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
30437af91514SGunnar Mills                   "LogService.ClearLog/")
3044cb92c03bSAndrew Geissler     {
3045cb92c03bSAndrew Geissler         entityPrivileges = {
3046cb92c03bSAndrew Geissler             {boost::beast::http::verb::get, {{"Login"}}},
3047cb92c03bSAndrew Geissler             {boost::beast::http::verb::head, {{"Login"}}},
3048cb92c03bSAndrew Geissler             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3049cb92c03bSAndrew Geissler             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3050cb92c03bSAndrew Geissler             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3051cb92c03bSAndrew Geissler             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3052cb92c03bSAndrew Geissler     }
3053cb92c03bSAndrew Geissler 
3054cb92c03bSAndrew Geissler   private:
3055cb92c03bSAndrew Geissler     /**
3056cb92c03bSAndrew Geissler      * Function handles POST method request.
3057cb92c03bSAndrew Geissler      * The Clear Log actions does not require any parameter.The action deletes
3058cb92c03bSAndrew Geissler      * all entries found in the Entries collection for this Log Service.
3059cb92c03bSAndrew Geissler      */
30608d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
30618d1b46d7Szhanghch05                 const crow::Request&, const std::vector<std::string>&) override
3062cb92c03bSAndrew Geissler     {
3063cb92c03bSAndrew Geissler         BMCWEB_LOG_DEBUG << "Do delete all entries.";
3064cb92c03bSAndrew Geissler 
3065cb92c03bSAndrew Geissler         // Process response from Logging service.
30662c70f800SEd Tanous         auto respHandler = [asyncResp](const boost::system::error_code ec) {
3067cb92c03bSAndrew Geissler             BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
3068cb92c03bSAndrew Geissler             if (ec)
3069cb92c03bSAndrew Geissler             {
3070cb92c03bSAndrew Geissler                 // TODO Handle for specific error code
3071cb92c03bSAndrew Geissler                 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
3072cb92c03bSAndrew Geissler                 asyncResp->res.result(
3073cb92c03bSAndrew Geissler                     boost::beast::http::status::internal_server_error);
3074cb92c03bSAndrew Geissler                 return;
3075cb92c03bSAndrew Geissler             }
3076cb92c03bSAndrew Geissler 
3077cb92c03bSAndrew Geissler             asyncResp->res.result(boost::beast::http::status::no_content);
3078cb92c03bSAndrew Geissler         };
3079cb92c03bSAndrew Geissler 
3080cb92c03bSAndrew Geissler         // Make call to Logging service to request Clear Log
3081cb92c03bSAndrew Geissler         crow::connections::systemBus->async_method_call(
30822c70f800SEd Tanous             respHandler, "xyz.openbmc_project.Logging",
3083cb92c03bSAndrew Geissler             "/xyz/openbmc_project/logging",
3084cb92c03bSAndrew Geissler             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3085cb92c03bSAndrew Geissler     }
3086cb92c03bSAndrew Geissler };
3087a3316fc6SZhikuiRen 
3088a3316fc6SZhikuiRen /****************************************************
3089a3316fc6SZhikuiRen  * Redfish PostCode interfaces
3090a3316fc6SZhikuiRen  * using DBUS interface: getPostCodesTS
3091a3316fc6SZhikuiRen  ******************************************************/
3092a3316fc6SZhikuiRen class PostCodesLogService : public Node
3093a3316fc6SZhikuiRen {
3094a3316fc6SZhikuiRen   public:
309552cc112dSEd Tanous     PostCodesLogService(App& app) :
3096a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
3097a3316fc6SZhikuiRen     {
3098a3316fc6SZhikuiRen         entityPrivileges = {
3099a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3100a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3101a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3102a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3103a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3104a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3105a3316fc6SZhikuiRen     }
3106a3316fc6SZhikuiRen 
3107a3316fc6SZhikuiRen   private:
31088d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
31098d1b46d7Szhanghch05                const crow::Request&, const std::vector<std::string>&) override
3110a3316fc6SZhikuiRen     {
3111a3316fc6SZhikuiRen 
3112a3316fc6SZhikuiRen         asyncResp->res.jsonValue = {
3113a3316fc6SZhikuiRen             {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"},
3114a3316fc6SZhikuiRen             {"@odata.type", "#LogService.v1_1_0.LogService"},
3115a3316fc6SZhikuiRen             {"Name", "POST Code Log Service"},
3116a3316fc6SZhikuiRen             {"Description", "POST Code Log Service"},
3117a3316fc6SZhikuiRen             {"Id", "BIOS POST Code Log"},
3118a3316fc6SZhikuiRen             {"OverWritePolicy", "WrapsWhenFull"},
3119a3316fc6SZhikuiRen             {"Entries",
3120a3316fc6SZhikuiRen              {{"@odata.id",
3121a3316fc6SZhikuiRen                "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
3122a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
3123a3316fc6SZhikuiRen             {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/"
3124a3316fc6SZhikuiRen                        "Actions/LogService.ClearLog"}};
3125a3316fc6SZhikuiRen     }
3126a3316fc6SZhikuiRen };
3127a3316fc6SZhikuiRen 
3128a3316fc6SZhikuiRen class PostCodesClear : public Node
3129a3316fc6SZhikuiRen {
3130a3316fc6SZhikuiRen   public:
313152cc112dSEd Tanous     PostCodesClear(App& app) :
3132a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
3133a3316fc6SZhikuiRen                   "LogService.ClearLog/")
3134a3316fc6SZhikuiRen     {
3135a3316fc6SZhikuiRen         entityPrivileges = {
3136a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3137a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
31383946028dSAppaRao Puli             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
31393946028dSAppaRao Puli             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
31403946028dSAppaRao Puli             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
31413946028dSAppaRao Puli             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
3142a3316fc6SZhikuiRen     }
3143a3316fc6SZhikuiRen 
3144a3316fc6SZhikuiRen   private:
31458d1b46d7Szhanghch05     void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
31468d1b46d7Szhanghch05                 const crow::Request&, const std::vector<std::string>&) override
3147a3316fc6SZhikuiRen     {
3148a3316fc6SZhikuiRen         BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
3149a3316fc6SZhikuiRen 
3150a3316fc6SZhikuiRen         // Make call to post-code service to request clear all
3151a3316fc6SZhikuiRen         crow::connections::systemBus->async_method_call(
3152a3316fc6SZhikuiRen             [asyncResp](const boost::system::error_code ec) {
3153a3316fc6SZhikuiRen                 if (ec)
3154a3316fc6SZhikuiRen                 {
3155a3316fc6SZhikuiRen                     // TODO Handle for specific error code
3156a3316fc6SZhikuiRen                     BMCWEB_LOG_ERROR
3157a3316fc6SZhikuiRen                         << "doClearPostCodes resp_handler got error " << ec;
3158a3316fc6SZhikuiRen                     asyncResp->res.result(
3159a3316fc6SZhikuiRen                         boost::beast::http::status::internal_server_error);
3160a3316fc6SZhikuiRen                     messages::internalError(asyncResp->res);
3161a3316fc6SZhikuiRen                     return;
3162a3316fc6SZhikuiRen                 }
3163a3316fc6SZhikuiRen             },
316415124765SJonathan Doman             "xyz.openbmc_project.State.Boot.PostCode0",
316515124765SJonathan Doman             "/xyz/openbmc_project/State/Boot/PostCode0",
3166a3316fc6SZhikuiRen             "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3167a3316fc6SZhikuiRen     }
3168a3316fc6SZhikuiRen };
3169a3316fc6SZhikuiRen 
3170a3316fc6SZhikuiRen static void fillPostCodeEntry(
31718d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp>& aResp,
31726c9a279eSManojkiran Eda     const boost::container::flat_map<
31736c9a279eSManojkiran Eda         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
3174a3316fc6SZhikuiRen     const uint16_t bootIndex, const uint64_t codeIndex = 0,
3175a3316fc6SZhikuiRen     const uint64_t skip = 0, const uint64_t top = 0)
3176a3316fc6SZhikuiRen {
3177a3316fc6SZhikuiRen     // Get the Message from the MessageRegistry
3178a3316fc6SZhikuiRen     const message_registries::Message* message =
3179*4a0bf539SManojkiran Eda         message_registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
3180a3316fc6SZhikuiRen 
3181a3316fc6SZhikuiRen     uint64_t currentCodeIndex = 0;
3182a3316fc6SZhikuiRen     nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
3183a3316fc6SZhikuiRen 
3184a3316fc6SZhikuiRen     uint64_t firstCodeTimeUs = 0;
31856c9a279eSManojkiran Eda     for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
31866c9a279eSManojkiran Eda              code : postcode)
3187a3316fc6SZhikuiRen     {
3188a3316fc6SZhikuiRen         currentCodeIndex++;
3189a3316fc6SZhikuiRen         std::string postcodeEntryID =
3190a3316fc6SZhikuiRen             "B" + std::to_string(bootIndex) + "-" +
3191a3316fc6SZhikuiRen             std::to_string(currentCodeIndex); // 1 based index in EntryID string
3192a3316fc6SZhikuiRen 
3193a3316fc6SZhikuiRen         uint64_t usecSinceEpoch = code.first;
3194a3316fc6SZhikuiRen         uint64_t usTimeOffset = 0;
3195a3316fc6SZhikuiRen 
3196a3316fc6SZhikuiRen         if (1 == currentCodeIndex)
3197a3316fc6SZhikuiRen         { // already incremented
3198a3316fc6SZhikuiRen             firstCodeTimeUs = code.first;
3199a3316fc6SZhikuiRen         }
3200a3316fc6SZhikuiRen         else
3201a3316fc6SZhikuiRen         {
3202a3316fc6SZhikuiRen             usTimeOffset = code.first - firstCodeTimeUs;
3203a3316fc6SZhikuiRen         }
3204a3316fc6SZhikuiRen 
3205a3316fc6SZhikuiRen         // skip if no specific codeIndex is specified and currentCodeIndex does
3206a3316fc6SZhikuiRen         // not fall between top and skip
3207a3316fc6SZhikuiRen         if ((codeIndex == 0) &&
3208a3316fc6SZhikuiRen             (currentCodeIndex <= skip || currentCodeIndex > top))
3209a3316fc6SZhikuiRen         {
3210a3316fc6SZhikuiRen             continue;
3211a3316fc6SZhikuiRen         }
3212a3316fc6SZhikuiRen 
32134e0453b1SGunnar Mills         // skip if a specific codeIndex is specified and does not match the
3214a3316fc6SZhikuiRen         // currentIndex
3215a3316fc6SZhikuiRen         if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3216a3316fc6SZhikuiRen         {
3217a3316fc6SZhikuiRen             // This is done for simplicity. 1st entry is needed to calculate
3218a3316fc6SZhikuiRen             // time offset. To improve efficiency, one can get to the entry
3219a3316fc6SZhikuiRen             // directly (possibly with flatmap's nth method)
3220a3316fc6SZhikuiRen             continue;
3221a3316fc6SZhikuiRen         }
3222a3316fc6SZhikuiRen 
3223a3316fc6SZhikuiRen         // currentCodeIndex is within top and skip or equal to specified code
3224a3316fc6SZhikuiRen         // index
3225a3316fc6SZhikuiRen 
3226a3316fc6SZhikuiRen         // Get the Created time from the timestamp
3227a3316fc6SZhikuiRen         std::string entryTimeStr;
32289c620e21SAsmitha Karunanithi         entryTimeStr = crow::utility::getDateTime(
32299c620e21SAsmitha Karunanithi             static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000));
3230a3316fc6SZhikuiRen 
3231a3316fc6SZhikuiRen         // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3232a3316fc6SZhikuiRen         std::ostringstream hexCode;
3233a3316fc6SZhikuiRen         hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
32346c9a279eSManojkiran Eda                 << std::get<0>(code.second);
3235a3316fc6SZhikuiRen         std::ostringstream timeOffsetStr;
3236a3316fc6SZhikuiRen         // Set Fixed -Point Notation
3237a3316fc6SZhikuiRen         timeOffsetStr << std::fixed;
3238a3316fc6SZhikuiRen         // Set precision to 4 digits
3239a3316fc6SZhikuiRen         timeOffsetStr << std::setprecision(4);
3240a3316fc6SZhikuiRen         // Add double to stream
3241a3316fc6SZhikuiRen         timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
3242a3316fc6SZhikuiRen         std::vector<std::string> messageArgs = {
3243a3316fc6SZhikuiRen             std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
3244a3316fc6SZhikuiRen 
3245a3316fc6SZhikuiRen         // Get MessageArgs template from message registry
3246a3316fc6SZhikuiRen         std::string msg;
3247a3316fc6SZhikuiRen         if (message != nullptr)
3248a3316fc6SZhikuiRen         {
3249a3316fc6SZhikuiRen             msg = message->message;
3250a3316fc6SZhikuiRen 
3251a3316fc6SZhikuiRen             // fill in this post code value
3252a3316fc6SZhikuiRen             int i = 0;
3253a3316fc6SZhikuiRen             for (const std::string& messageArg : messageArgs)
3254a3316fc6SZhikuiRen             {
3255a3316fc6SZhikuiRen                 std::string argStr = "%" + std::to_string(++i);
3256a3316fc6SZhikuiRen                 size_t argPos = msg.find(argStr);
3257a3316fc6SZhikuiRen                 if (argPos != std::string::npos)
3258a3316fc6SZhikuiRen                 {
3259a3316fc6SZhikuiRen                     msg.replace(argPos, argStr.length(), messageArg);
3260a3316fc6SZhikuiRen                 }
3261a3316fc6SZhikuiRen             }
3262a3316fc6SZhikuiRen         }
3263a3316fc6SZhikuiRen 
3264d4342a92STim Lee         // Get Severity template from message registry
3265d4342a92STim Lee         std::string severity;
3266d4342a92STim Lee         if (message != nullptr)
3267d4342a92STim Lee         {
3268d4342a92STim Lee             severity = message->severity;
3269d4342a92STim Lee         }
3270d4342a92STim Lee 
3271a3316fc6SZhikuiRen         // add to AsyncResp
3272a3316fc6SZhikuiRen         logEntryArray.push_back({});
3273a3316fc6SZhikuiRen         nlohmann::json& bmcLogEntry = logEntryArray.back();
3274743e9a1fSGunnar Mills         bmcLogEntry = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
3275a3316fc6SZhikuiRen                        {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
3276a3316fc6SZhikuiRen                                      "PostCodes/Entries/" +
3277a3316fc6SZhikuiRen                                          postcodeEntryID},
3278a3316fc6SZhikuiRen                        {"Name", "POST Code Log Entry"},
3279a3316fc6SZhikuiRen                        {"Id", postcodeEntryID},
3280a3316fc6SZhikuiRen                        {"Message", std::move(msg)},
3281*4a0bf539SManojkiran Eda                        {"MessageId", "OpenBMC.0.2.BIOSPOSTCode"},
3282a3316fc6SZhikuiRen                        {"MessageArgs", std::move(messageArgs)},
3283a3316fc6SZhikuiRen                        {"EntryType", "Event"},
3284a3316fc6SZhikuiRen                        {"Severity", std::move(severity)},
32859c620e21SAsmitha Karunanithi                        {"Created", entryTimeStr}};
3286a3316fc6SZhikuiRen     }
3287a3316fc6SZhikuiRen }
3288a3316fc6SZhikuiRen 
32898d1b46d7Szhanghch05 static void getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3290a3316fc6SZhikuiRen                                 const uint16_t bootIndex,
3291a3316fc6SZhikuiRen                                 const uint64_t codeIndex)
3292a3316fc6SZhikuiRen {
3293a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
32946c9a279eSManojkiran Eda         [aResp, bootIndex,
32956c9a279eSManojkiran Eda          codeIndex](const boost::system::error_code ec,
32966c9a279eSManojkiran Eda                     const boost::container::flat_map<
32976c9a279eSManojkiran Eda                         uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
32986c9a279eSManojkiran Eda                         postcode) {
3299a3316fc6SZhikuiRen             if (ec)
3300a3316fc6SZhikuiRen             {
3301a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3302a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3303a3316fc6SZhikuiRen                 return;
3304a3316fc6SZhikuiRen             }
3305a3316fc6SZhikuiRen 
3306a3316fc6SZhikuiRen             // skip the empty postcode boots
3307a3316fc6SZhikuiRen             if (postcode.empty())
3308a3316fc6SZhikuiRen             {
3309a3316fc6SZhikuiRen                 return;
3310a3316fc6SZhikuiRen             }
3311a3316fc6SZhikuiRen 
3312a3316fc6SZhikuiRen             fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
3313a3316fc6SZhikuiRen 
3314a3316fc6SZhikuiRen             aResp->res.jsonValue["Members@odata.count"] =
3315a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members"].size();
3316a3316fc6SZhikuiRen         },
331715124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
331815124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3319a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3320a3316fc6SZhikuiRen         bootIndex);
3321a3316fc6SZhikuiRen }
3322a3316fc6SZhikuiRen 
33238d1b46d7Szhanghch05 static void getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3324a3316fc6SZhikuiRen                                const uint16_t bootIndex,
3325a3316fc6SZhikuiRen                                const uint16_t bootCount,
3326a3316fc6SZhikuiRen                                const uint64_t entryCount, const uint64_t skip,
3327a3316fc6SZhikuiRen                                const uint64_t top)
3328a3316fc6SZhikuiRen {
3329a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3330a3316fc6SZhikuiRen         [aResp, bootIndex, bootCount, entryCount, skip,
3331a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
33326c9a279eSManojkiran Eda               const boost::container::flat_map<
33336c9a279eSManojkiran Eda                   uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
33346c9a279eSManojkiran Eda                   postcode) {
3335a3316fc6SZhikuiRen             if (ec)
3336a3316fc6SZhikuiRen             {
3337a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3338a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3339a3316fc6SZhikuiRen                 return;
3340a3316fc6SZhikuiRen             }
3341a3316fc6SZhikuiRen 
3342a3316fc6SZhikuiRen             uint64_t endCount = entryCount;
3343a3316fc6SZhikuiRen             if (!postcode.empty())
3344a3316fc6SZhikuiRen             {
3345a3316fc6SZhikuiRen                 endCount = entryCount + postcode.size();
3346a3316fc6SZhikuiRen 
3347a3316fc6SZhikuiRen                 if ((skip < endCount) && ((top + skip) > entryCount))
3348a3316fc6SZhikuiRen                 {
3349a3316fc6SZhikuiRen                     uint64_t thisBootSkip =
3350a3316fc6SZhikuiRen                         std::max(skip, entryCount) - entryCount;
3351a3316fc6SZhikuiRen                     uint64_t thisBootTop =
3352a3316fc6SZhikuiRen                         std::min(top + skip, endCount) - entryCount;
3353a3316fc6SZhikuiRen 
3354a3316fc6SZhikuiRen                     fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3355a3316fc6SZhikuiRen                                       thisBootSkip, thisBootTop);
3356a3316fc6SZhikuiRen                 }
3357a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.count"] = endCount;
3358a3316fc6SZhikuiRen             }
3359a3316fc6SZhikuiRen 
3360a3316fc6SZhikuiRen             // continue to previous bootIndex
3361a3316fc6SZhikuiRen             if (bootIndex < bootCount)
3362a3316fc6SZhikuiRen             {
3363a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3364a3316fc6SZhikuiRen                                    bootCount, endCount, skip, top);
3365a3316fc6SZhikuiRen             }
3366a3316fc6SZhikuiRen             else
3367a3316fc6SZhikuiRen             {
3368a3316fc6SZhikuiRen                 aResp->res.jsonValue["Members@odata.nextLink"] =
3369a3316fc6SZhikuiRen                     "/redfish/v1/Systems/system/LogServices/PostCodes/"
3370a3316fc6SZhikuiRen                     "Entries?$skip=" +
3371a3316fc6SZhikuiRen                     std::to_string(skip + top);
3372a3316fc6SZhikuiRen             }
3373a3316fc6SZhikuiRen         },
337415124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
337515124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3376a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3377a3316fc6SZhikuiRen         bootIndex);
3378a3316fc6SZhikuiRen }
3379a3316fc6SZhikuiRen 
33808d1b46d7Szhanghch05 static void
33818d1b46d7Szhanghch05     getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
3382a3316fc6SZhikuiRen                          const uint64_t skip, const uint64_t top)
3383a3316fc6SZhikuiRen {
3384a3316fc6SZhikuiRen     uint64_t entryCount = 0;
3385a3316fc6SZhikuiRen     crow::connections::systemBus->async_method_call(
3386a3316fc6SZhikuiRen         [aResp, entryCount, skip,
3387a3316fc6SZhikuiRen          top](const boost::system::error_code ec,
3388a3316fc6SZhikuiRen               const std::variant<uint16_t>& bootCount) {
3389a3316fc6SZhikuiRen             if (ec)
3390a3316fc6SZhikuiRen             {
3391a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3392a3316fc6SZhikuiRen                 messages::internalError(aResp->res);
3393a3316fc6SZhikuiRen                 return;
3394a3316fc6SZhikuiRen             }
3395a3316fc6SZhikuiRen             auto pVal = std::get_if<uint16_t>(&bootCount);
3396a3316fc6SZhikuiRen             if (pVal)
3397a3316fc6SZhikuiRen             {
3398a3316fc6SZhikuiRen                 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
3399a3316fc6SZhikuiRen             }
3400a3316fc6SZhikuiRen             else
3401a3316fc6SZhikuiRen             {
3402a3316fc6SZhikuiRen                 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
3403a3316fc6SZhikuiRen             }
3404a3316fc6SZhikuiRen         },
340515124765SJonathan Doman         "xyz.openbmc_project.State.Boot.PostCode0",
340615124765SJonathan Doman         "/xyz/openbmc_project/State/Boot/PostCode0",
3407a3316fc6SZhikuiRen         "org.freedesktop.DBus.Properties", "Get",
3408a3316fc6SZhikuiRen         "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
3409a3316fc6SZhikuiRen }
3410a3316fc6SZhikuiRen 
3411a3316fc6SZhikuiRen class PostCodesEntryCollection : public Node
3412a3316fc6SZhikuiRen {
3413a3316fc6SZhikuiRen   public:
341452cc112dSEd Tanous     PostCodesEntryCollection(App& app) :
3415a3316fc6SZhikuiRen         Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3416a3316fc6SZhikuiRen     {
3417a3316fc6SZhikuiRen         entityPrivileges = {
3418a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3419a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3420a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3421a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3422a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3423a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3424a3316fc6SZhikuiRen     }
3425a3316fc6SZhikuiRen 
3426a3316fc6SZhikuiRen   private:
34278d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
34288d1b46d7Szhanghch05                const crow::Request& req,
3429cb13a392SEd Tanous                const std::vector<std::string>&) override
3430a3316fc6SZhikuiRen     {
3431a3316fc6SZhikuiRen 
3432a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] =
3433a3316fc6SZhikuiRen             "#LogEntryCollection.LogEntryCollection";
3434a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3435a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3436a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3437a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3438a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3439a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3440a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3441a3316fc6SZhikuiRen 
3442a3316fc6SZhikuiRen         uint64_t skip = 0;
3443a3316fc6SZhikuiRen         uint64_t top = maxEntriesPerPage; // Show max entries by default
34448d1b46d7Szhanghch05         if (!getSkipParam(asyncResp, req, skip))
3445a3316fc6SZhikuiRen         {
3446a3316fc6SZhikuiRen             return;
3447a3316fc6SZhikuiRen         }
34488d1b46d7Szhanghch05         if (!getTopParam(asyncResp, req, top))
3449a3316fc6SZhikuiRen         {
3450a3316fc6SZhikuiRen             return;
3451a3316fc6SZhikuiRen         }
3452a3316fc6SZhikuiRen         getCurrentBootNumber(asyncResp, skip, top);
3453a3316fc6SZhikuiRen     }
3454a3316fc6SZhikuiRen };
3455a3316fc6SZhikuiRen 
3456a3316fc6SZhikuiRen class PostCodesEntry : public Node
3457a3316fc6SZhikuiRen {
3458a3316fc6SZhikuiRen   public:
345952cc112dSEd Tanous     PostCodesEntry(App& app) :
3460a3316fc6SZhikuiRen         Node(app,
3461a3316fc6SZhikuiRen              "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/",
3462a3316fc6SZhikuiRen              std::string())
3463a3316fc6SZhikuiRen     {
3464a3316fc6SZhikuiRen         entityPrivileges = {
3465a3316fc6SZhikuiRen             {boost::beast::http::verb::get, {{"Login"}}},
3466a3316fc6SZhikuiRen             {boost::beast::http::verb::head, {{"Login"}}},
3467a3316fc6SZhikuiRen             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3468a3316fc6SZhikuiRen             {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3469a3316fc6SZhikuiRen             {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3470a3316fc6SZhikuiRen             {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3471a3316fc6SZhikuiRen     }
3472a3316fc6SZhikuiRen 
3473a3316fc6SZhikuiRen   private:
34748d1b46d7Szhanghch05     void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
34758d1b46d7Szhanghch05                const crow::Request&,
3476a3316fc6SZhikuiRen                const std::vector<std::string>& params) override
3477a3316fc6SZhikuiRen     {
34788d1b46d7Szhanghch05 
3479a3316fc6SZhikuiRen         if (params.size() != 1)
3480a3316fc6SZhikuiRen         {
3481a3316fc6SZhikuiRen             messages::internalError(asyncResp->res);
3482a3316fc6SZhikuiRen             return;
3483a3316fc6SZhikuiRen         }
3484a3316fc6SZhikuiRen 
3485a3316fc6SZhikuiRen         const std::string& targetID = params[0];
3486a3316fc6SZhikuiRen 
3487a3316fc6SZhikuiRen         size_t bootPos = targetID.find('B');
3488a3316fc6SZhikuiRen         if (bootPos == std::string::npos)
3489a3316fc6SZhikuiRen         {
3490a3316fc6SZhikuiRen             // Requested ID was not found
3491a3316fc6SZhikuiRen             messages::resourceMissingAtURI(asyncResp->res, targetID);
3492a3316fc6SZhikuiRen             return;
3493a3316fc6SZhikuiRen         }
3494a3316fc6SZhikuiRen         std::string_view bootIndexStr(targetID);
3495a3316fc6SZhikuiRen         bootIndexStr.remove_prefix(bootPos + 1);
3496a3316fc6SZhikuiRen         uint16_t bootIndex = 0;
3497a3316fc6SZhikuiRen         uint64_t codeIndex = 0;
3498a3316fc6SZhikuiRen         size_t dashPos = bootIndexStr.find('-');
3499a3316fc6SZhikuiRen 
3500a3316fc6SZhikuiRen         if (dashPos == std::string::npos)
3501a3316fc6SZhikuiRen         {
3502a3316fc6SZhikuiRen             return;
3503a3316fc6SZhikuiRen         }
3504a3316fc6SZhikuiRen         std::string_view codeIndexStr(bootIndexStr);
3505a3316fc6SZhikuiRen         bootIndexStr.remove_suffix(dashPos);
3506a3316fc6SZhikuiRen         codeIndexStr.remove_prefix(dashPos + 1);
3507a3316fc6SZhikuiRen 
3508a3316fc6SZhikuiRen         bootIndex = static_cast<uint16_t>(
350923a21a1cSEd Tanous             strtoul(std::string(bootIndexStr).c_str(), nullptr, 0));
351023a21a1cSEd Tanous         codeIndex = strtoul(std::string(codeIndexStr).c_str(), nullptr, 0);
3511a3316fc6SZhikuiRen         if (bootIndex == 0 || codeIndex == 0)
3512a3316fc6SZhikuiRen         {
3513a3316fc6SZhikuiRen             BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
3514a3316fc6SZhikuiRen                              << params[0];
3515a3316fc6SZhikuiRen         }
3516a3316fc6SZhikuiRen 
3517a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
3518a3316fc6SZhikuiRen         asyncResp->res.jsonValue["@odata.id"] =
3519a3316fc6SZhikuiRen             "/redfish/v1/Systems/system/LogServices/PostCodes/"
3520a3316fc6SZhikuiRen             "Entries";
3521a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3522a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Description"] =
3523a3316fc6SZhikuiRen             "Collection of POST Code Log Entries";
3524a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3525a3316fc6SZhikuiRen         asyncResp->res.jsonValue["Members@odata.count"] = 0;
3526a3316fc6SZhikuiRen 
3527a3316fc6SZhikuiRen         getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
3528a3316fc6SZhikuiRen     }
3529a3316fc6SZhikuiRen };
3530a3316fc6SZhikuiRen 
35311da66f75SEd Tanous } // namespace redfish
3532