blob: b5efd27d28167d961ab8e3306aedc5d5c13eb1bb [file] [log] [blame]
Ed Tanous1da66f72018-07-27 16:13:37 -07001/*
2// Copyright (c) 2018 Intel Corporation
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15*/
16#pragma once
17
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080018#include "app.hpp"
George Liu7a1dbc42022-12-07 16:03:22 +080019#include "dbus_utility.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080020#include "error_messages.hpp"
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -060021#include "generated/enums/log_entry.hpp"
Ed Tanous539d8c62024-06-19 14:38:27 -070022#include "generated/enums/log_service.hpp"
Spencer Kub7028eb2021-10-26 15:27:35 +080023#include "gzfile.hpp"
George Liu647b3cd2021-07-05 12:43:56 +080024#include "http_utility.hpp"
Spencer Kub7028eb2021-10-26 15:27:35 +080025#include "human_sort.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080026#include "query.hpp"
Jason M. Bills4851d452019-03-28 11:27:48 -070027#include "registries.hpp"
28#include "registries/base_message_registry.hpp"
29#include "registries/openbmc_message_registry.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080030#include "registries/privilege_registry.hpp"
James Feist46229572020-02-19 15:11:58 -080031#include "task.hpp"
Ed Tanous5b904292024-04-16 11:10:17 -070032#include "task_messages.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080033#include "utils/dbus_utils.hpp"
Ed Tanous5b904292024-04-16 11:10:17 -070034#include "utils/json_utils.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080035#include "utils/time_utils.hpp"
Ed Tanous1da66f72018-07-27 16:13:37 -070036
Myung Bae75e8e212023-11-30 12:53:46 -080037#include <systemd/sd-id128.h>
Asmitha Karunanithi8e317782020-12-10 03:35:05 -060038#include <tinyxml2.h>
Adriana Kobylak400fd1f2021-01-29 09:01:30 -060039#include <unistd.h>
Jason M. Billse1f26342018-07-18 12:12:00 -070040
Ed Tanous07c8c202022-07-11 10:08:08 -070041#include <boost/beast/http/verb.hpp>
Ed Tanous1da66f72018-07-27 16:13:37 -070042#include <boost/container/flat_map.hpp>
Jason M. Bills1ddcf012019-11-26 14:59:21 -080043#include <boost/system/linux_error.hpp>
Ed Tanousef4c65b2023-04-24 15:28:50 -070044#include <boost/url/format.hpp>
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +020045#include <sdbusplus/asio/property.hpp>
46#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050047
George Liu7a1dbc42022-12-07 16:03:22 +080048#include <array>
George Liu647b3cd2021-07-05 12:43:56 +080049#include <charconv>
Abhilash Rajub5f288d2023-11-08 22:32:44 -060050#include <cstddef>
James Feist4418c7f2019-04-15 11:09:15 -070051#include <filesystem>
Ed Tanous18f8f602023-07-18 10:07:23 -070052#include <iterator>
Xiaochao Ma75710de2021-01-21 17:56:02 +080053#include <optional>
Ed Tanous3544d2a2023-08-06 18:12:20 -070054#include <ranges>
Ed Tanous26702d02021-11-03 15:02:33 -070055#include <span>
Ed Tanous18f8f602023-07-18 10:07:23 -070056#include <string>
Jason M. Billscd225da2019-05-08 15:31:57 -070057#include <string_view>
Ed Tanousabf2add2019-01-22 16:40:12 -080058#include <variant>
Ed Tanous1da66f72018-07-27 16:13:37 -070059
60namespace redfish
61{
62
Patrick Williams89492a12023-05-10 07:51:34 -050063constexpr const char* crashdumpObject = "com.intel.crashdump";
64constexpr const char* crashdumpPath = "/com/intel/crashdump";
65constexpr const char* crashdumpInterface = "com.intel.crashdump";
66constexpr const char* deleteAllInterface =
Jason M. Bills5b61b5e2019-10-16 10:59:02 -070067 "xyz.openbmc_project.Collection.DeleteAll";
Patrick Williams89492a12023-05-10 07:51:34 -050068constexpr const char* crashdumpOnDemandInterface =
Jason M. Bills424c4172019-03-21 13:50:33 -070069 "com.intel.crashdump.OnDemand";
Patrick Williams89492a12023-05-10 07:51:34 -050070constexpr const char* crashdumpTelemetryInterface =
Kenny L. Ku6eda7682020-06-19 09:48:36 -070071 "com.intel.crashdump.Telemetry";
Ed Tanous1da66f72018-07-27 16:13:37 -070072
Asmitha Karunanithi8e317782020-12-10 03:35:05 -060073enum class DumpCreationProgress
74{
75 DUMP_CREATE_SUCCESS,
76 DUMP_CREATE_FAILED,
77 DUMP_CREATE_INPROGRESS
78};
79
James Feistf6150402019-01-08 10:36:20 -080080namespace fs = std::filesystem;
Ed Tanous1da66f72018-07-27 16:13:37 -070081
Gunnar Mills1214b7e2020-06-04 10:11:30 -050082inline std::string translateSeverityDbusToRedfish(const std::string& s)
Andrew Geisslercb92c032018-08-17 07:56:14 -070083{
Ed Tanousd4d25792020-09-29 15:15:03 -070084 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
85 (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
86 (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
87 (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
Andrew Geisslercb92c032018-08-17 07:56:14 -070088 {
89 return "Critical";
90 }
Ed Tanous3174e4d2020-10-07 11:41:22 -070091 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
92 (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
93 (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
Andrew Geisslercb92c032018-08-17 07:56:14 -070094 {
95 return "OK";
96 }
Ed Tanous3174e4d2020-10-07 11:41:22 -070097 if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
Andrew Geisslercb92c032018-08-17 07:56:14 -070098 {
99 return "Warning";
100 }
101 return "";
102}
103
Abhishek Patel9017faf2021-09-14 22:48:55 -0500104inline std::optional<bool> getProviderNotifyAction(const std::string& notify)
105{
106 std::optional<bool> notifyAction;
107 if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Notify")
108 {
109 notifyAction = true;
110 }
111 else if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Inhibit")
112 {
113 notifyAction = false;
114 }
115
116 return notifyAction;
117}
118
Ed Tanous18f8f602023-07-18 10:07:23 -0700119inline std::string getDumpPath(std::string_view dumpType)
120{
121 std::string dbusDumpPath = "/xyz/openbmc_project/dump/";
122 std::ranges::transform(dumpType, std::back_inserter(dbusDumpPath),
123 bmcweb::asciiToLower);
124
125 return dbusDumpPath;
126}
127
Ed Tanous055713e2024-07-17 17:19:36 -0700128inline bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
Jason M. Billse85d6b12019-07-29 17:01:15 -0700129 const bool firstEntry = true)
Jason M. Bills95820182019-04-22 16:25:34 -0700130{
Ed Tanous271584a2019-07-09 16:24:22 -0700131 static time_t prevTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700132 static int index = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -0700133 if (firstEntry)
134 {
135 prevTs = 0;
136 }
137
Jason M. Bills95820182019-04-22 16:25:34 -0700138 // Get the entry timestamp
Ed Tanous271584a2019-07-09 16:24:22 -0700139 std::time_t curTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700140 std::tm timeStruct = {};
141 std::istringstream entryStream(logEntry);
142 if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
143 {
144 curTs = std::mktime(&timeStruct);
145 }
146 // If the timestamp isn't unique, increment the index
147 if (curTs == prevTs)
148 {
149 index++;
150 }
151 else
152 {
153 // Otherwise, reset it
154 index = 0;
155 }
156 // Save the timestamp
157 prevTs = curTs;
158
159 entryID = std::to_string(curTs);
160 if (index > 0)
161 {
162 entryID += "_" + std::to_string(index);
163 }
164 return true;
165}
166
Jason M. Bills95820182019-04-22 16:25:34 -0700167static bool
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500168 getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
Jason M. Bills95820182019-04-22 16:25:34 -0700169{
170 static const std::filesystem::path redfishLogDir = "/var/log";
171 static const std::string redfishLogFilename = "redfish";
172
173 // Loop through the directory looking for redfish log files
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500174 for (const std::filesystem::directory_entry& dirEnt :
Jason M. Bills95820182019-04-22 16:25:34 -0700175 std::filesystem::directory_iterator(redfishLogDir))
176 {
177 // If we find a redfish log file, save the path
178 std::string filename = dirEnt.path().filename();
Ed Tanous11ba3972022-07-11 09:50:41 -0700179 if (filename.starts_with(redfishLogFilename))
Jason M. Bills95820182019-04-22 16:25:34 -0700180 {
181 redfishLogFiles.emplace_back(redfishLogDir / filename);
182 }
183 }
184 // As the log files rotate, they are appended with a ".#" that is higher for
185 // the older logs. Since we don't expect more than 10 log files, we
186 // can just sort the list to get them in order from newest to oldest
Ed Tanous3544d2a2023-08-06 18:12:20 -0700187 std::ranges::sort(redfishLogFiles);
Jason M. Bills95820182019-04-22 16:25:34 -0700188
189 return !redfishLogFiles.empty();
190}
191
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600192inline log_entry::OriginatorTypes
193 mapDbusOriginatorTypeToRedfish(const std::string& originatorType)
194{
195 if (originatorType ==
196 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client")
197 {
198 return log_entry::OriginatorTypes::Client;
199 }
200 if (originatorType ==
201 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal")
202 {
203 return log_entry::OriginatorTypes::Internal;
204 }
205 if (originatorType ==
206 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService")
207 {
208 return log_entry::OriginatorTypes::SupportingService;
209 }
210 return log_entry::OriginatorTypes::Invalid;
211}
212
Claire Weinanaefe3782022-07-15 19:17:19 -0700213inline void parseDumpEntryFromDbusObject(
Jiaqing Zhao2d613eb2022-08-15 16:03:00 +0800214 const dbus::utility::ManagedObjectType::value_type& object,
Claire Weinanc6fecda2022-07-15 10:43:25 -0700215 std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600216 std::string& originatorId, log_entry::OriginatorTypes& originatorType,
Claire Weinanaefe3782022-07-15 19:17:19 -0700217 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
218{
219 for (const auto& interfaceMap : object.second)
220 {
221 if (interfaceMap.first == "xyz.openbmc_project.Common.Progress")
222 {
223 for (const auto& propertyMap : interfaceMap.second)
224 {
225 if (propertyMap.first == "Status")
226 {
227 const auto* status =
228 std::get_if<std::string>(&propertyMap.second);
229 if (status == nullptr)
230 {
231 messages::internalError(asyncResp->res);
232 break;
233 }
234 dumpStatus = *status;
235 }
236 }
237 }
238 else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
239 {
240 for (const auto& propertyMap : interfaceMap.second)
241 {
242 if (propertyMap.first == "Size")
243 {
244 const auto* sizePtr =
245 std::get_if<uint64_t>(&propertyMap.second);
246 if (sizePtr == nullptr)
247 {
248 messages::internalError(asyncResp->res);
249 break;
250 }
251 size = *sizePtr;
252 break;
253 }
254 }
255 }
256 else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime")
257 {
258 for (const auto& propertyMap : interfaceMap.second)
259 {
260 if (propertyMap.first == "Elapsed")
261 {
262 const uint64_t* usecsTimeStamp =
263 std::get_if<uint64_t>(&propertyMap.second);
264 if (usecsTimeStamp == nullptr)
265 {
266 messages::internalError(asyncResp->res);
267 break;
268 }
Claire Weinanc6fecda2022-07-15 10:43:25 -0700269 timestampUs = *usecsTimeStamp;
Claire Weinanaefe3782022-07-15 19:17:19 -0700270 break;
271 }
272 }
273 }
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600274 else if (interfaceMap.first ==
275 "xyz.openbmc_project.Common.OriginatedBy")
276 {
277 for (const auto& propertyMap : interfaceMap.second)
278 {
279 if (propertyMap.first == "OriginatorId")
280 {
281 const std::string* id =
282 std::get_if<std::string>(&propertyMap.second);
283 if (id == nullptr)
284 {
285 messages::internalError(asyncResp->res);
286 break;
287 }
288 originatorId = *id;
289 }
290
291 if (propertyMap.first == "OriginatorType")
292 {
293 const std::string* type =
294 std::get_if<std::string>(&propertyMap.second);
295 if (type == nullptr)
296 {
297 messages::internalError(asyncResp->res);
298 break;
299 }
300
301 originatorType = mapDbusOriginatorTypeToRedfish(*type);
302 if (originatorType == log_entry::OriginatorTypes::Invalid)
303 {
304 messages::internalError(asyncResp->res);
305 break;
306 }
307 }
308 }
309 }
Claire Weinanaefe3782022-07-15 19:17:19 -0700310 }
311}
312
Nan Zhou21ab4042022-06-26 23:07:40 +0000313static std::string getDumpEntriesPath(const std::string& dumpType)
Claire Weinanfdd26902022-03-01 14:18:25 -0800314{
315 std::string entriesPath;
316
317 if (dumpType == "BMC")
318 {
Ed Tanous253f11b2024-05-16 09:38:31 -0700319 entriesPath =
320 std::format("/redfish/v1/Managers/{}/LogServices/Dump/Entries/",
321 BMCWEB_REDFISH_MANAGER_URI_NAME);
Claire Weinanfdd26902022-03-01 14:18:25 -0800322 }
323 else if (dumpType == "FaultLog")
324 {
Ed Tanous253f11b2024-05-16 09:38:31 -0700325 entriesPath =
326 std::format("/redfish/v1/Managers/{}/LogServices/FaultLog/Entries/",
327 BMCWEB_REDFISH_MANAGER_URI_NAME);
Claire Weinanfdd26902022-03-01 14:18:25 -0800328 }
329 else if (dumpType == "System")
330 {
Ed Tanous253f11b2024-05-16 09:38:31 -0700331 entriesPath =
332 std::format("/redfish/v1/Systems/{}/LogServices/Dump/Entries/",
333 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Claire Weinanfdd26902022-03-01 14:18:25 -0800334 }
335 else
336 {
Ed Tanous62598e32023-07-17 17:06:25 -0700337 BMCWEB_LOG_ERROR("getDumpEntriesPath() invalid dump type: {}",
338 dumpType);
Claire Weinanfdd26902022-03-01 14:18:25 -0800339 }
340
341 // Returns empty string on error
342 return entriesPath;
343}
344
zhanghch058d1b46d2021-04-01 11:18:24 +0800345inline void
346 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
347 const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500348{
Claire Weinanfdd26902022-03-01 14:18:25 -0800349 std::string entriesPath = getDumpEntriesPath(dumpType);
350 if (entriesPath.empty())
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500351 {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500352 messages::internalError(asyncResp->res);
353 return;
354 }
355
George Liu5eb468d2023-06-20 17:03:24 +0800356 sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
357 dbus::utility::getManagedObjects(
358 "xyz.openbmc_project.Dump.Manager", path,
Claire Weinanfdd26902022-03-01 14:18:25 -0800359 [asyncResp, entriesPath,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800360 dumpType](const boost::system::error_code& ec,
George Liu5eb468d2023-06-20 17:03:24 +0800361 const dbus::utility::ManagedObjectType& objects) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700362 if (ec)
363 {
Ed Tanous62598e32023-07-17 17:06:25 -0700364 BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -0700365 messages::internalError(asyncResp->res);
366 return;
367 }
368
Claire Weinanfdd26902022-03-01 14:18:25 -0800369 // Remove ending slash
370 std::string odataIdStr = entriesPath;
371 if (!odataIdStr.empty())
372 {
373 odataIdStr.pop_back();
374 }
375
376 asyncResp->res.jsonValue["@odata.type"] =
377 "#LogEntryCollection.LogEntryCollection";
378 asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr);
379 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries";
Patrick Williams89492a12023-05-10 07:51:34 -0500380 asyncResp->res.jsonValue["Description"] = "Collection of " + dumpType +
381 " Dump Entries";
Claire Weinanfdd26902022-03-01 14:18:25 -0800382
Ed Tanous3544d2a2023-08-06 18:12:20 -0700383 nlohmann::json::array_t entriesArray;
Ed Tanous18f8f602023-07-18 10:07:23 -0700384 std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/";
Ed Tanous002d39b2022-05-31 08:59:27 -0700385
George Liu5eb468d2023-06-20 17:03:24 +0800386 dbus::utility::ManagedObjectType resp(objects);
Ed Tanous3544d2a2023-08-06 18:12:20 -0700387 std::ranges::sort(resp, [](const auto& l, const auto& r) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700388 return AlphanumLess<std::string>()(l.first.filename(),
389 r.first.filename());
390 });
391
392 for (auto& object : resp)
393 {
394 if (object.first.str.find(dumpEntryPath) == std::string::npos)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500395 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700396 continue;
397 }
Claire Weinanc6fecda2022-07-15 10:43:25 -0700398 uint64_t timestampUs = 0;
Ed Tanous002d39b2022-05-31 08:59:27 -0700399 uint64_t size = 0;
400 std::string dumpStatus;
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600401 std::string originatorId;
402 log_entry::OriginatorTypes originatorType =
403 log_entry::OriginatorTypes::Internal;
Jason M. Bills433b68b2022-06-28 12:24:26 -0700404 nlohmann::json::object_t thisEntry;
Ed Tanous002d39b2022-05-31 08:59:27 -0700405
406 std::string entryID = object.first.filename();
407 if (entryID.empty())
408 {
409 continue;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500410 }
411
Claire Weinanc6fecda2022-07-15 10:43:25 -0700412 parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600413 originatorId, originatorType,
Claire Weinanaefe3782022-07-15 19:17:19 -0700414 asyncResp);
Ed Tanous002d39b2022-05-31 08:59:27 -0700415
416 if (dumpStatus !=
417 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
418 !dumpStatus.empty())
419 {
420 // Dump status is not Complete, no need to enumerate
421 continue;
422 }
423
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600424 thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry";
Claire Weinanfdd26902022-03-01 14:18:25 -0800425 thisEntry["@odata.id"] = entriesPath + entryID;
Ed Tanous002d39b2022-05-31 08:59:27 -0700426 thisEntry["Id"] = entryID;
427 thisEntry["EntryType"] = "Event";
Ed Tanous002d39b2022-05-31 08:59:27 -0700428 thisEntry["Name"] = dumpType + " Dump Entry";
Claire Weinanbbd80db2022-10-26 16:55:52 -0700429 thisEntry["Created"] =
430 redfish::time_utils::getDateTimeUintUs(timestampUs);
Ed Tanous002d39b2022-05-31 08:59:27 -0700431
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600432 if (!originatorId.empty())
433 {
434 thisEntry["Originator"] = originatorId;
435 thisEntry["OriginatorType"] = originatorType;
436 }
437
Ed Tanous002d39b2022-05-31 08:59:27 -0700438 if (dumpType == "BMC")
439 {
440 thisEntry["DiagnosticDataType"] = "Manager";
Patrick Williams89492a12023-05-10 07:51:34 -0500441 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
442 "/attachment";
Claire Weinanfdd26902022-03-01 14:18:25 -0800443 thisEntry["AdditionalDataSizeBytes"] = size;
Ed Tanous002d39b2022-05-31 08:59:27 -0700444 }
445 else if (dumpType == "System")
446 {
447 thisEntry["DiagnosticDataType"] = "OEM";
448 thisEntry["OEMDiagnosticDataType"] = "System";
Patrick Williams89492a12023-05-10 07:51:34 -0500449 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
450 "/attachment";
Claire Weinanfdd26902022-03-01 14:18:25 -0800451 thisEntry["AdditionalDataSizeBytes"] = size;
Ed Tanous002d39b2022-05-31 08:59:27 -0700452 }
Patrick Williamsb2ba3072023-05-12 10:27:39 -0500453 entriesArray.emplace_back(std::move(thisEntry));
Ed Tanous002d39b2022-05-31 08:59:27 -0700454 }
455 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
Ed Tanous3544d2a2023-08-06 18:12:20 -0700456 asyncResp->res.jsonValue["Members"] = std::move(entriesArray);
Patrick Williams5a39f772023-10-20 11:20:21 -0500457 });
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500458}
459
zhanghch058d1b46d2021-04-01 11:18:24 +0800460inline void
Claire Weinanc7a6d662022-06-13 16:36:39 -0700461 getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
zhanghch058d1b46d2021-04-01 11:18:24 +0800462 const std::string& entryID, const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500463{
Claire Weinanfdd26902022-03-01 14:18:25 -0800464 std::string entriesPath = getDumpEntriesPath(dumpType);
465 if (entriesPath.empty())
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500466 {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500467 messages::internalError(asyncResp->res);
468 return;
469 }
470
George Liu5eb468d2023-06-20 17:03:24 +0800471 sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
472 dbus::utility::getManagedObjects(
473 "xyz.openbmc_project.Dump.Manager", path,
Claire Weinanfdd26902022-03-01 14:18:25 -0800474 [asyncResp, entryID, dumpType,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800475 entriesPath](const boost::system::error_code& ec,
Ed Tanous02cad962022-06-30 16:50:15 -0700476 const dbus::utility::ManagedObjectType& resp) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700477 if (ec)
478 {
Ed Tanous62598e32023-07-17 17:06:25 -0700479 BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -0700480 messages::internalError(asyncResp->res);
481 return;
482 }
483
484 bool foundDumpEntry = false;
Ed Tanous18f8f602023-07-18 10:07:23 -0700485 std::string dumpEntryPath = getDumpPath(dumpType) + "/entry/";
Ed Tanous002d39b2022-05-31 08:59:27 -0700486
487 for (const auto& objectPath : resp)
488 {
489 if (objectPath.first.str != dumpEntryPath + entryID)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500490 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700491 continue;
492 }
493
494 foundDumpEntry = true;
Claire Weinanc6fecda2022-07-15 10:43:25 -0700495 uint64_t timestampUs = 0;
Ed Tanous002d39b2022-05-31 08:59:27 -0700496 uint64_t size = 0;
497 std::string dumpStatus;
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600498 std::string originatorId;
499 log_entry::OriginatorTypes originatorType =
500 log_entry::OriginatorTypes::Internal;
Ed Tanous002d39b2022-05-31 08:59:27 -0700501
Claire Weinanaefe3782022-07-15 19:17:19 -0700502 parseDumpEntryFromDbusObject(objectPath, dumpStatus, size,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600503 timestampUs, originatorId,
504 originatorType, asyncResp);
Ed Tanous002d39b2022-05-31 08:59:27 -0700505
506 if (dumpStatus !=
507 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
508 !dumpStatus.empty())
509 {
510 // Dump status is not Complete
511 // return not found until status is changed to Completed
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +0200512 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
513 entryID);
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500514 return;
515 }
516
Ed Tanous002d39b2022-05-31 08:59:27 -0700517 asyncResp->res.jsonValue["@odata.type"] =
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600518 "#LogEntry.v1_11_0.LogEntry";
Claire Weinanfdd26902022-03-01 14:18:25 -0800519 asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID;
Ed Tanous002d39b2022-05-31 08:59:27 -0700520 asyncResp->res.jsonValue["Id"] = entryID;
521 asyncResp->res.jsonValue["EntryType"] = "Event";
Ed Tanous002d39b2022-05-31 08:59:27 -0700522 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
Claire Weinanbbd80db2022-10-26 16:55:52 -0700523 asyncResp->res.jsonValue["Created"] =
524 redfish::time_utils::getDateTimeUintUs(timestampUs);
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500525
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600526 if (!originatorId.empty())
527 {
528 asyncResp->res.jsonValue["Originator"] = originatorId;
529 asyncResp->res.jsonValue["OriginatorType"] = originatorType;
530 }
531
Ed Tanous002d39b2022-05-31 08:59:27 -0700532 if (dumpType == "BMC")
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500533 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700534 asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
535 asyncResp->res.jsonValue["AdditionalDataURI"] =
Claire Weinanfdd26902022-03-01 14:18:25 -0800536 entriesPath + entryID + "/attachment";
537 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500538 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700539 else if (dumpType == "System")
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500540 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700541 asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
542 asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System";
543 asyncResp->res.jsonValue["AdditionalDataURI"] =
Claire Weinanfdd26902022-03-01 14:18:25 -0800544 entriesPath + entryID + "/attachment";
545 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500546 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700547 }
548 if (!foundDumpEntry)
549 {
Ed Tanous62598e32023-07-17 17:06:25 -0700550 BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID);
Myung Baeb90d14f2023-05-31 14:40:39 -0500551 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
552 entryID);
Ed Tanous002d39b2022-05-31 08:59:27 -0700553 return;
554 }
Patrick Williams5a39f772023-10-20 11:20:21 -0500555 });
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500556}
557
zhanghch058d1b46d2021-04-01 11:18:24 +0800558inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Stanley Chu98782562020-11-04 16:10:24 +0800559 const std::string& entryID,
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500560 const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500561{
Patrick Williams5a39f772023-10-20 11:20:21 -0500562 auto respHandler = [asyncResp,
563 entryID](const boost::system::error_code& ec) {
Ed Tanous62598e32023-07-17 17:06:25 -0700564 BMCWEB_LOG_DEBUG("Dump Entry doDelete callback: Done");
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500565 if (ec)
566 {
George Liu3de8d8b2021-03-22 17:49:39 +0800567 if (ec.value() == EBADR)
568 {
569 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
570 return;
571 }
Ed Tanous62598e32023-07-17 17:06:25 -0700572 BMCWEB_LOG_ERROR(
573 "Dump (DBus) doDelete respHandler got error {} entryID={}", ec,
574 entryID);
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500575 messages::internalError(asyncResp->res);
576 return;
577 }
578 };
Ed Tanous18f8f602023-07-18 10:07:23 -0700579
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500580 crow::connections::systemBus->async_method_call(
581 respHandler, "xyz.openbmc_project.Dump.Manager",
Ed Tanous18f8f602023-07-18 10:07:23 -0700582 std::format("{}/entry/{}", getDumpPath(dumpType), entryID),
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500583 "xyz.openbmc_project.Object.Delete", "Delete");
584}
Abhilash Rajub5f288d2023-11-08 22:32:44 -0600585inline bool checkSizeLimit(int fd, crow::Response& res)
586{
587 long long int size = lseek(fd, 0, SEEK_END);
588 if (size <= 0)
589 {
590 BMCWEB_LOG_ERROR("Failed to get size of file, lseek() returned {}",
591 size);
592 messages::internalError(res);
593 return false;
594 }
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500595
Abhilash Rajub5f288d2023-11-08 22:32:44 -0600596 // Arbitrary max size of 20MB to accommodate BMC dumps
597 constexpr long long int maxFileSize = 20LL * 1024LL * 1024LL;
598 if (size > maxFileSize)
599 {
600 BMCWEB_LOG_ERROR("File size {} exceeds maximum allowed size of {}",
601 size, maxFileSize);
602 messages::internalError(res);
603 return false;
604 }
605 off_t rc = lseek(fd, 0, SEEK_SET);
606 if (rc < 0)
607 {
608 BMCWEB_LOG_ERROR("Failed to reset file offset to 0");
609 messages::internalError(res);
610 return false;
611 }
612 return true;
613}
Carson Labrado168d1b12023-03-27 17:04:46 +0000614inline void
615 downloadEntryCallback(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
616 const std::string& entryID,
617 const std::string& downloadEntryType,
618 const boost::system::error_code& ec,
619 const sdbusplus::message::unix_fd& unixfd)
620{
621 if (ec.value() == EBADR)
622 {
623 messages::resourceNotFound(asyncResp->res, "EntryAttachment", entryID);
624 return;
625 }
626 if (ec)
627 {
628 BMCWEB_LOG_ERROR("DBUS response error: {}", ec);
629 messages::internalError(asyncResp->res);
630 return;
631 }
632
633 // Make sure we know how to process the retrieved entry attachment
634 if ((downloadEntryType != "BMC") && (downloadEntryType != "System"))
635 {
636 BMCWEB_LOG_ERROR("downloadEntryCallback() invalid entry type: {}",
637 downloadEntryType);
638 messages::internalError(asyncResp->res);
639 }
640
641 int fd = -1;
642 fd = dup(unixfd);
643 if (fd < 0)
644 {
645 BMCWEB_LOG_ERROR("Failed to open file");
646 messages::internalError(asyncResp->res);
647 return;
648 }
Abhilash Rajub5f288d2023-11-08 22:32:44 -0600649 if (!checkSizeLimit(fd, asyncResp->res))
Carson Labrado168d1b12023-03-27 17:04:46 +0000650 {
Carson Labrado168d1b12023-03-27 17:04:46 +0000651 close(fd);
652 return;
653 }
Carson Labrado168d1b12023-03-27 17:04:46 +0000654 if (downloadEntryType == "System")
655 {
Abhilash Rajub5f288d2023-11-08 22:32:44 -0600656 if (!asyncResp->res.openFd(fd, bmcweb::EncodingType::Base64))
657 {
658 messages::internalError(asyncResp->res);
659 close(fd);
660 return;
661 }
Carson Labrado168d1b12023-03-27 17:04:46 +0000662 asyncResp->res.addHeader(
663 boost::beast::http::field::content_transfer_encoding, "Base64");
Abhilash Rajub5f288d2023-11-08 22:32:44 -0600664 return;
Carson Labrado168d1b12023-03-27 17:04:46 +0000665 }
Abhilash Rajub5f288d2023-11-08 22:32:44 -0600666 if (!asyncResp->res.openFd(fd))
Ed Tanous27b0cf92023-08-07 12:02:40 -0700667 {
Abhilash Rajub5f288d2023-11-08 22:32:44 -0600668 messages::internalError(asyncResp->res);
669 close(fd);
670 return;
Ed Tanous27b0cf92023-08-07 12:02:40 -0700671 }
Carson Labrado168d1b12023-03-27 17:04:46 +0000672 asyncResp->res.addHeader(boost::beast::http::field::content_type,
673 "application/octet-stream");
674}
675
676inline void
677 downloadDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
678 const std::string& entryID, const std::string& dumpType)
679{
680 if (dumpType != "BMC")
681 {
682 BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID);
683 messages::resourceNotFound(asyncResp->res, dumpType + " dump", entryID);
684 return;
685 }
686
Ed Tanous18f8f602023-07-18 10:07:23 -0700687 std::string dumpEntryPath = std::format("{}/entry/{}",
688 getDumpPath(dumpType), entryID);
Carson Labrado168d1b12023-03-27 17:04:46 +0000689
690 auto downloadDumpEntryHandler =
691 [asyncResp, entryID,
692 dumpType](const boost::system::error_code& ec,
693 const sdbusplus::message::unix_fd& unixfd) {
694 downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd);
695 };
696
697 crow::connections::systemBus->async_method_call(
698 std::move(downloadDumpEntryHandler), "xyz.openbmc_project.Dump.Manager",
699 dumpEntryPath, "xyz.openbmc_project.Dump.Entry", "GetFileHandle");
700}
701
702inline void
703 downloadEventLogEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
704 const std::string& systemName,
705 const std::string& entryID,
706 const std::string& dumpType)
707{
Ed Tanous25b54db2024-04-17 15:40:31 -0700708 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Carson Labrado168d1b12023-03-27 17:04:46 +0000709 {
710 // Option currently returns no systems. TBD
711 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
712 systemName);
713 return;
714 }
Ed Tanous253f11b2024-05-16 09:38:31 -0700715 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Carson Labrado168d1b12023-03-27 17:04:46 +0000716 {
717 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
718 systemName);
719 return;
720 }
721
722 std::string entryPath =
723 sdbusplus::message::object_path("/xyz/openbmc_project/logging/entry") /
724 entryID;
725
726 auto downloadEventLogEntryHandler =
727 [asyncResp, entryID,
728 dumpType](const boost::system::error_code& ec,
729 const sdbusplus::message::unix_fd& unixfd) {
730 downloadEntryCallback(asyncResp, entryID, dumpType, ec, unixfd);
731 };
732
733 crow::connections::systemBus->async_method_call(
734 std::move(downloadEventLogEntryHandler), "xyz.openbmc_project.Logging",
735 entryPath, "xyz.openbmc_project.Logging.Entry", "GetEntry");
736}
737
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600738inline DumpCreationProgress
739 mapDbusStatusToDumpProgress(const std::string& status)
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500740{
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600741 if (status ==
742 "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" ||
743 status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted")
744 {
745 return DumpCreationProgress::DUMP_CREATE_FAILED;
746 }
747 if (status ==
748 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed")
749 {
750 return DumpCreationProgress::DUMP_CREATE_SUCCESS;
751 }
752 return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
753}
754
755inline DumpCreationProgress
756 getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values)
757{
758 for (const auto& [key, val] : values)
759 {
760 if (key == "Status")
Ed Tanous002d39b2022-05-31 08:59:27 -0700761 {
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600762 const std::string* value = std::get_if<std::string>(&val);
763 if (value == nullptr)
764 {
Ed Tanous62598e32023-07-17 17:06:25 -0700765 BMCWEB_LOG_ERROR("Status property value is null");
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600766 return DumpCreationProgress::DUMP_CREATE_FAILED;
767 }
768 return mapDbusStatusToDumpProgress(*value);
769 }
770 }
771 return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
772}
773
774inline std::string getDumpEntryPath(const std::string& dumpPath)
775{
776 if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry")
777 {
Ed Tanous253f11b2024-05-16 09:38:31 -0700778 return std::format("/redfish/v1/Managers/{}/LogServices/Dump/Entries/",
Ed Tanous9f565092024-07-12 22:06:53 -0700779 BMCWEB_REDFISH_MANAGER_URI_NAME);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600780 }
781 if (dumpPath == "/xyz/openbmc_project/dump/system/entry")
782 {
Ed Tanous253f11b2024-05-16 09:38:31 -0700783 return std::format("/redfish/v1/Systems/{}/LogServices/Dump/Entries/",
784 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600785 }
786 return "";
787}
788
789inline void createDumpTaskCallback(
790 task::Payload&& payload,
791 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
792 const sdbusplus::message::object_path& createdObjPath)
793{
794 const std::string dumpPath = createdObjPath.parent_path().str;
795 const std::string dumpId = createdObjPath.filename();
796
797 std::string dumpEntryPath = getDumpEntryPath(dumpPath);
798
799 if (dumpEntryPath.empty())
800 {
Ed Tanous62598e32023-07-17 17:06:25 -0700801 BMCWEB_LOG_ERROR("Invalid dump type received");
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600802 messages::internalError(asyncResp->res);
803 return;
804 }
805
806 crow::connections::systemBus->async_method_call(
Ed Tanous8cb2c022024-03-27 16:31:46 -0700807 [asyncResp, payload = std::move(payload), createdObjPath,
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600808 dumpEntryPath{std::move(dumpEntryPath)},
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800809 dumpId](const boost::system::error_code& ec,
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600810 const std::string& introspectXml) {
811 if (ec)
812 {
Ed Tanous62598e32023-07-17 17:06:25 -0700813 BMCWEB_LOG_ERROR("Introspect call failed with error: {}",
814 ec.message());
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600815 messages::internalError(asyncResp->res);
816 return;
Ed Tanous002d39b2022-05-31 08:59:27 -0700817 }
818
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600819 // Check if the created dump object has implemented Progress
820 // interface to track dump completion. If yes, fetch the "Status"
821 // property of the interface, modify the task state accordingly.
822 // Else, return task completed.
823 tinyxml2::XMLDocument doc;
Ed Tanous002d39b2022-05-31 08:59:27 -0700824
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600825 doc.Parse(introspectXml.data(), introspectXml.size());
826 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
827 if (pRoot == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -0700828 {
Ed Tanous62598e32023-07-17 17:06:25 -0700829 BMCWEB_LOG_ERROR("XML document failed to parse");
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600830 messages::internalError(asyncResp->res);
831 return;
832 }
833 tinyxml2::XMLElement* interfaceNode =
834 pRoot->FirstChildElement("interface");
835
836 bool isProgressIntfPresent = false;
837 while (interfaceNode != nullptr)
838 {
839 const char* thisInterfaceName = interfaceNode->Attribute("name");
840 if (thisInterfaceName != nullptr)
841 {
842 if (thisInterfaceName ==
843 std::string_view("xyz.openbmc_project.Common.Progress"))
844 {
845 interfaceNode =
846 interfaceNode->NextSiblingElement("interface");
847 continue;
848 }
849 isProgressIntfPresent = true;
850 break;
851 }
852 interfaceNode = interfaceNode->NextSiblingElement("interface");
853 }
854
855 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
856 [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent](
Ed Tanous8b242752023-06-27 17:17:13 -0700857 const boost::system::error_code& ec2, sdbusplus::message_t& msg,
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600858 const std::shared_ptr<task::TaskData>& taskData) {
Ed Tanous8b242752023-06-27 17:17:13 -0700859 if (ec2)
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600860 {
Ed Tanous62598e32023-07-17 17:06:25 -0700861 BMCWEB_LOG_ERROR("{}: Error in creating dump",
862 createdObjPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600863 taskData->messages.emplace_back(messages::internalError());
864 taskData->state = "Cancelled";
865 return task::completed;
866 }
867
868 if (isProgressIntfPresent)
869 {
870 dbus::utility::DBusPropertiesMap values;
871 std::string prop;
872 msg.read(prop, values);
873
874 DumpCreationProgress dumpStatus =
875 getDumpCompletionStatus(values);
876 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED)
877 {
Ed Tanous62598e32023-07-17 17:06:25 -0700878 BMCWEB_LOG_ERROR("{}: Error in creating dump",
879 createdObjPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600880 taskData->state = "Cancelled";
881 return task::completed;
882 }
883
884 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS)
885 {
Ed Tanous62598e32023-07-17 17:06:25 -0700886 BMCWEB_LOG_DEBUG("{}: Dump creation task is in progress",
887 createdObjPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600888 return !task::completed;
889 }
890 }
891
Ed Tanous002d39b2022-05-31 08:59:27 -0700892 nlohmann::json retMessage = messages::success();
893 taskData->messages.emplace_back(retMessage);
894
Ed Tanousc51a58e2023-03-27 14:43:19 -0700895 boost::urls::url url = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -0700896 "/redfish/v1/Managers/{}/LogServices/Dump/Entries/{}",
897 BMCWEB_REDFISH_MANAGER_URI_NAME, dumpId);
Ed Tanousc51a58e2023-03-27 14:43:19 -0700898
899 std::string headerLoc = "Location: ";
900 headerLoc += url.buffer();
901
Ed Tanous002d39b2022-05-31 08:59:27 -0700902 taskData->payload->httpHeaders.emplace_back(std::move(headerLoc));
903
Ed Tanous62598e32023-07-17 17:06:25 -0700904 BMCWEB_LOG_DEBUG("{}: Dump creation task completed",
905 createdObjPath.str);
Ed Tanous002d39b2022-05-31 08:59:27 -0700906 taskData->state = "Completed";
907 return task::completed;
Patrick Williams5a39f772023-10-20 11:20:21 -0500908 },
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600909 "type='signal',interface='org.freedesktop.DBus.Properties',"
910 "member='PropertiesChanged',path='" +
911 createdObjPath.str + "'");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500912
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600913 // The task timer is set to max time limit within which the
914 // requested dump will be collected.
915 task->startTimer(std::chrono::minutes(6));
916 task->populateResp(asyncResp->res);
917 task->payload.emplace(payload);
Patrick Williams5a39f772023-10-20 11:20:21 -0500918 },
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600919 "xyz.openbmc_project.Dump.Manager", createdObjPath,
920 "org.freedesktop.DBus.Introspectable", "Introspect");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500921}
922
zhanghch058d1b46d2021-04-01 11:18:24 +0800923inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
924 const crow::Request& req, const std::string& dumpType)
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500925{
Claire Weinanfdd26902022-03-01 14:18:25 -0800926 std::string dumpPath = getDumpEntriesPath(dumpType);
927 if (dumpPath.empty())
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500928 {
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500929 messages::internalError(asyncResp->res);
930 return;
931 }
932
933 std::optional<std::string> diagnosticDataType;
934 std::optional<std::string> oemDiagnosticDataType;
935
Willy Tu15ed6782021-12-14 11:03:16 -0800936 if (!redfish::json_util::readJsonAction(
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500937 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
938 "OEMDiagnosticDataType", oemDiagnosticDataType))
939 {
940 return;
941 }
942
943 if (dumpType == "System")
944 {
945 if (!oemDiagnosticDataType || !diagnosticDataType)
946 {
Ed Tanous62598e32023-07-17 17:06:25 -0700947 BMCWEB_LOG_ERROR(
948 "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500949 messages::actionParameterMissing(
950 asyncResp->res, "CollectDiagnosticData",
951 "DiagnosticDataType & OEMDiagnosticDataType");
952 return;
953 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700954 if ((*oemDiagnosticDataType != "System") ||
955 (*diagnosticDataType != "OEM"))
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500956 {
Ed Tanous62598e32023-07-17 17:06:25 -0700957 BMCWEB_LOG_ERROR("Wrong parameter values passed");
Ed Tanousace85d62021-10-26 12:45:59 -0700958 messages::internalError(asyncResp->res);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500959 return;
960 }
Ed Tanous253f11b2024-05-16 09:38:31 -0700961 dumpPath = std::format("/redfish/v1/Systems/{}/LogServices/Dump/",
962 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500963 }
964 else if (dumpType == "BMC")
965 {
966 if (!diagnosticDataType)
967 {
Ed Tanous62598e32023-07-17 17:06:25 -0700968 BMCWEB_LOG_ERROR(
969 "CreateDump action parameter 'DiagnosticDataType' not found!");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500970 messages::actionParameterMissing(
971 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
972 return;
973 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700974 if (*diagnosticDataType != "Manager")
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500975 {
Ed Tanous62598e32023-07-17 17:06:25 -0700976 BMCWEB_LOG_ERROR(
977 "Wrong parameter value passed for 'DiagnosticDataType'");
Ed Tanousace85d62021-10-26 12:45:59 -0700978 messages::internalError(asyncResp->res);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500979 return;
980 }
Ed Tanous253f11b2024-05-16 09:38:31 -0700981 dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/Dump/",
982 BMCWEB_REDFISH_MANAGER_URI_NAME);
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500983 }
984 else
985 {
Ed Tanous62598e32023-07-17 17:06:25 -0700986 BMCWEB_LOG_ERROR("CreateDump failed. Unknown dump type");
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500987 messages::internalError(asyncResp->res);
988 return;
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500989 }
990
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600991 std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>>
992 createDumpParamVec;
993
Carson Labradof574a8e2023-03-22 02:26:00 +0000994 if (req.session != nullptr)
995 {
996 createDumpParamVec.emplace_back(
997 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId",
998 req.session->clientIp);
999 createDumpParamVec.emplace_back(
1000 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType",
1001 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client");
1002 }
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -06001003
Asmitha Karunanithia43be802020-05-07 05:05:36 -05001004 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001005 [asyncResp, payload(task::Payload(req)),
1006 dumpPath](const boost::system::error_code& ec,
1007 const sdbusplus::message_t& msg,
1008 const sdbusplus::message::object_path& objPath) mutable {
Ed Tanous002d39b2022-05-31 08:59:27 -07001009 if (ec)
1010 {
Ed Tanous62598e32023-07-17 17:06:25 -07001011 BMCWEB_LOG_ERROR("CreateDump resp_handler got error {}", ec);
Asmitha Karunanithi59075712021-10-22 01:17:41 -05001012 const sd_bus_error* dbusError = msg.get_error();
1013 if (dbusError == nullptr)
1014 {
1015 messages::internalError(asyncResp->res);
1016 return;
1017 }
1018
Ed Tanous62598e32023-07-17 17:06:25 -07001019 BMCWEB_LOG_ERROR("CreateDump DBus error: {} and error msg: {}",
1020 dbusError->name, dbusError->message);
Asmitha Karunanithi59075712021-10-22 01:17:41 -05001021 if (std::string_view(
1022 "xyz.openbmc_project.Common.Error.NotAllowed") ==
1023 dbusError->name)
1024 {
1025 messages::resourceInStandby(asyncResp->res);
1026 return;
1027 }
1028 if (std::string_view(
1029 "xyz.openbmc_project.Dump.Create.Error.Disabled") ==
1030 dbusError->name)
1031 {
1032 messages::serviceDisabled(asyncResp->res, dumpPath);
1033 return;
1034 }
1035 if (std::string_view(
1036 "xyz.openbmc_project.Common.Error.Unavailable") ==
1037 dbusError->name)
1038 {
1039 messages::resourceInUse(asyncResp->res);
1040 return;
1041 }
1042 // Other Dbus errors such as:
1043 // xyz.openbmc_project.Common.Error.InvalidArgument &
1044 // org.freedesktop.DBus.Error.InvalidArgs are all related to
1045 // the dbus call that is made here in the bmcweb
1046 // implementation and has nothing to do with the client's
1047 // input in the request. Hence, returning internal error
1048 // back to the client.
Ed Tanous002d39b2022-05-31 08:59:27 -07001049 messages::internalError(asyncResp->res);
1050 return;
1051 }
Ed Tanous62598e32023-07-17 17:06:25 -07001052 BMCWEB_LOG_DEBUG("Dump Created. Path: {}", objPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -06001053 createDumpTaskCallback(std::move(payload), asyncResp, objPath);
Patrick Williams5a39f772023-10-20 11:20:21 -05001054 },
Ed Tanous18f8f602023-07-18 10:07:23 -07001055 "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType),
Asmitha Karunanithi8e317782020-12-10 03:35:05 -06001056 "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec);
Asmitha Karunanithia43be802020-05-07 05:05:36 -05001057}
1058
zhanghch058d1b46d2021-04-01 11:18:24 +08001059inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1060 const std::string& dumpType)
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05001061{
Claire Weinan0d946212022-07-13 19:40:19 -07001062 crow::connections::systemBus->async_method_call(
1063 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001064 if (ec)
1065 {
Ed Tanous62598e32023-07-17 17:06:25 -07001066 BMCWEB_LOG_ERROR("clearDump resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001067 messages::internalError(asyncResp->res);
1068 return;
1069 }
Patrick Williams5a39f772023-10-20 11:20:21 -05001070 },
Ed Tanous18f8f602023-07-18 10:07:23 -07001071 "xyz.openbmc_project.Dump.Manager", getDumpPath(dumpType),
Claire Weinan0d946212022-07-13 19:40:19 -07001072 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05001073}
1074
Ed Tanousdf254f22024-04-01 13:25:46 -07001075inline void
Ed Tanousb9d36b42022-02-26 21:42:46 -08001076 parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params,
1077 std::string& filename, std::string& timestamp,
1078 std::string& logfile)
Johnathan Mantey043a0532020-03-10 17:15:28 -07001079{
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001080 const std::string* filenamePtr = nullptr;
1081 const std::string* timestampPtr = nullptr;
1082 const std::string* logfilePtr = nullptr;
1083
1084 const bool success = sdbusplus::unpackPropertiesNoThrow(
1085 dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr,
1086 "Filename", filenamePtr, "Log", logfilePtr);
1087
1088 if (!success)
Johnathan Mantey043a0532020-03-10 17:15:28 -07001089 {
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001090 return;
1091 }
1092
1093 if (filenamePtr != nullptr)
1094 {
1095 filename = *filenamePtr;
1096 }
1097
1098 if (timestampPtr != nullptr)
1099 {
1100 timestamp = *timestampPtr;
1101 }
1102
1103 if (logfilePtr != nullptr)
1104 {
1105 logfile = *logfilePtr;
Johnathan Mantey043a0532020-03-10 17:15:28 -07001106 }
1107}
1108
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001109inline void requestRoutesSystemLogServiceCollection(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07001110{
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001111 /**
1112 * Functions triggers appropriate requests on DBus
1113 */
Ed Tanous22d268c2022-05-19 09:39:07 -07001114 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/")
Ed Tanoused398212021-06-09 17:05:54 -07001115 .privileges(redfish::privileges::getLogServiceCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001116 .methods(boost::beast::http::verb::get)(
1117 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001118 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1119 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001120 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001121 {
1122 return;
1123 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001124 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001125 {
1126 // Option currently returns no systems. TBD
1127 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1128 systemName);
1129 return;
1130 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001131 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001132 {
1133 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1134 systemName);
1135 return;
1136 }
1137
Ed Tanous002d39b2022-05-31 08:59:27 -07001138 // Collections don't include the static data added by SubRoute
1139 // because it has a duplicate entry for members
1140 asyncResp->res.jsonValue["@odata.type"] =
1141 "#LogServiceCollection.LogServiceCollection";
1142 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07001143 std::format("/redfish/v1/Systems/{}/LogServices",
1144 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07001145 asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
1146 asyncResp->res.jsonValue["Description"] =
1147 "Collection of LogServices for this Computer System";
1148 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1149 logServiceArray = nlohmann::json::array();
1150 nlohmann::json::object_t eventLog;
1151 eventLog["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07001152 std::format("/redfish/v1/Systems/{}/LogServices/EventLog",
1153 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001154 logServiceArray.emplace_back(std::move(eventLog));
Ed Tanous25b54db2024-04-17 15:40:31 -07001155 if constexpr (BMCWEB_REDFISH_DUMP_LOG)
1156 {
1157 nlohmann::json::object_t dumpLog;
1158 dumpLog["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07001159 std::format("/redfish/v1/Systems/{}/LogServices/Dump",
1160 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07001161 logServiceArray.emplace_back(std::move(dumpLog));
1162 }
raviteja-bc9bb6862020-02-03 11:53:32 -06001163
Gunnar Mills5ffd11f2024-05-02 08:26:12 -05001164 if constexpr (BMCWEB_REDFISH_CPU_LOG)
Ed Tanous25b54db2024-04-17 15:40:31 -07001165 {
1166 nlohmann::json::object_t crashdump;
1167 crashdump["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07001168 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump",
1169 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07001170 logServiceArray.emplace_back(std::move(crashdump));
1171 }
Spencer Kub7028eb2021-10-26 15:27:35 +08001172
Ed Tanous25b54db2024-04-17 15:40:31 -07001173 if constexpr (BMCWEB_REDFISH_HOST_LOGGER)
1174 {
1175 nlohmann::json::object_t hostlogger;
1176 hostlogger["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07001177 std::format("/redfish/v1/Systems/{}/LogServices/HostLogger",
1178 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07001179 logServiceArray.emplace_back(std::move(hostlogger));
1180 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001181 asyncResp->res.jsonValue["Members@odata.count"] =
1182 logServiceArray.size();
ZhikuiRena3316fc2020-01-29 14:58:08 -08001183
George Liu7a1dbc42022-12-07 16:03:22 +08001184 constexpr std::array<std::string_view, 1> interfaces = {
1185 "xyz.openbmc_project.State.Boot.PostCode"};
1186 dbus::utility::getSubTreePaths(
1187 "/", 0, interfaces,
1188 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001189 const dbus::utility::MapperGetSubTreePathsResponse&
1190 subtreePath) {
1191 if (ec)
1192 {
Ed Tanous62598e32023-07-17 17:06:25 -07001193 BMCWEB_LOG_ERROR("{}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001194 return;
1195 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07001196
Ed Tanous002d39b2022-05-31 08:59:27 -07001197 for (const auto& pathStr : subtreePath)
1198 {
1199 if (pathStr.find("PostCode") != std::string::npos)
1200 {
1201 nlohmann::json& logServiceArrayLocal =
1202 asyncResp->res.jsonValue["Members"];
Ed Tanous613dabe2022-07-09 11:17:36 -07001203 nlohmann::json::object_t member;
Ed Tanous253f11b2024-05-16 09:38:31 -07001204 member["@odata.id"] = std::format(
1205 "/redfish/v1/Systems/{}/LogServices/PostCodes",
1206 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous613dabe2022-07-09 11:17:36 -07001207
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001208 logServiceArrayLocal.emplace_back(std::move(member));
Ed Tanous613dabe2022-07-09 11:17:36 -07001209
Ed Tanous002d39b2022-05-31 08:59:27 -07001210 asyncResp->res.jsonValue["Members@odata.count"] =
1211 logServiceArrayLocal.size();
1212 return;
1213 }
1214 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07001215 });
Patrick Williams5a39f772023-10-20 11:20:21 -05001216 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001217}
1218
1219inline void requestRoutesEventLogService(App& app)
1220{
Ed Tanous22d268c2022-05-19 09:39:07 -07001221 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/")
Ed Tanoused398212021-06-09 17:05:54 -07001222 .privileges(redfish::privileges::getLogService)
Ed Tanous002d39b2022-05-31 08:59:27 -07001223 .methods(boost::beast::http::verb::get)(
1224 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001225 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1226 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001227 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001228 {
1229 return;
1230 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001231 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001232 {
1233 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1234 systemName);
1235 return;
1236 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001237 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07001238 std::format("/redfish/v1/Systems/{}/LogServices/EventLog",
1239 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07001240 asyncResp->res.jsonValue["@odata.type"] =
Janet Adkinsb25644a2023-08-16 11:23:45 -05001241 "#LogService.v1_2_0.LogService";
Ed Tanous002d39b2022-05-31 08:59:27 -07001242 asyncResp->res.jsonValue["Name"] = "Event Log Service";
1243 asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1244 asyncResp->res.jsonValue["Id"] = "EventLog";
Ed Tanous539d8c62024-06-19 14:38:27 -07001245 asyncResp->res.jsonValue["OverWritePolicy"] =
1246 log_service::OverWritePolicy::WrapsWhenFull;
Tejas Patil7c8c4052021-06-04 17:43:14 +05301247
Ed Tanous002d39b2022-05-31 08:59:27 -07001248 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07001249 redfish::time_utils::getDateTimeOffsetNow();
Tejas Patil7c8c4052021-06-04 17:43:14 +05301250
Ed Tanous002d39b2022-05-31 08:59:27 -07001251 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
1252 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
1253 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05301254
Ed Tanous002d39b2022-05-31 08:59:27 -07001255 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07001256 std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1257 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous20fa6a22024-05-20 18:02:58 -07001258 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"]
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001259
Ed Tanous20fa6a22024-05-20 18:02:58 -07001260 = std::format(
1261 "/redfish/v1/Systems/{}/LogServices/EventLog/Actions/LogService.ClearLog",
1262 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williams5a39f772023-10-20 11:20:21 -05001263 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001264}
1265
Alexander Hansen599b9af2024-08-06 15:11:57 +02001266inline void handleSystemsLogServicesEventLogActionsClearPost(
1267 App& app, const crow::Request& req,
1268 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1269 const std::string& systemName)
1270{
1271 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
1272 {
1273 return;
1274 }
1275 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
1276 {
1277 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1278 systemName);
1279 return;
1280 }
1281
1282 // Clear the EventLog by deleting the log files
1283 std::vector<std::filesystem::path> redfishLogFiles;
1284 if (getRedfishLogFiles(redfishLogFiles))
1285 {
1286 for (const std::filesystem::path& file : redfishLogFiles)
1287 {
1288 std::error_code ec;
1289 std::filesystem::remove(file, ec);
1290 }
1291 }
1292
1293 // Reload rsyslog so it knows to start new log files
1294 crow::connections::systemBus->async_method_call(
1295 [asyncResp](const boost::system::error_code& ec) {
1296 if (ec)
1297 {
1298 BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec);
1299 messages::internalError(asyncResp->res);
1300 return;
1301 }
1302
1303 messages::success(asyncResp->res);
1304 },
1305 "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1306 "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1307 "replace");
1308}
1309
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001310inline void requestRoutesJournalEventLogClear(App& app)
1311{
Jason M. Bills4978b632022-02-22 14:17:43 -08001312 BMCWEB_ROUTE(
1313 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07001314 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
Ed Tanous432a8902021-06-14 15:28:56 -07001315 .privileges({{"ConfigureComponents"}})
Alexander Hansen599b9af2024-08-06 15:11:57 +02001316 .methods(boost::beast::http::verb::post)(std::bind_front(
1317 handleSystemsLogServicesEventLogActionsClearPost, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001318}
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001319
Jason M. Billsac992cd2022-06-24 13:31:46 -07001320enum class LogParseError
1321{
1322 success,
1323 parseFailed,
1324 messageIdNotInRegistry,
1325};
1326
1327static LogParseError
1328 fillEventLogEntryJson(const std::string& logEntryID,
1329 const std::string& logEntry,
1330 nlohmann::json::object_t& logEntryJson)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001331{
Jason M. Bills95820182019-04-22 16:25:34 -07001332 // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
Jason M. Billscd225da2019-05-08 15:31:57 -07001333 // First get the Timestamp
Ed Tanousf23b7292020-10-15 09:41:17 -07001334 size_t space = logEntry.find_first_of(' ');
Jason M. Billscd225da2019-05-08 15:31:57 -07001335 if (space == std::string::npos)
Jason M. Bills95820182019-04-22 16:25:34 -07001336 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001337 return LogParseError::parseFailed;
Jason M. Bills95820182019-04-22 16:25:34 -07001338 }
Jason M. Billscd225da2019-05-08 15:31:57 -07001339 std::string timestamp = logEntry.substr(0, space);
1340 // Then get the log contents
Ed Tanousf23b7292020-10-15 09:41:17 -07001341 size_t entryStart = logEntry.find_first_not_of(' ', space);
Jason M. Billscd225da2019-05-08 15:31:57 -07001342 if (entryStart == std::string::npos)
1343 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001344 return LogParseError::parseFailed;
Jason M. Billscd225da2019-05-08 15:31:57 -07001345 }
1346 std::string_view entry(logEntry);
1347 entry.remove_prefix(entryStart);
1348 // Use split to separate the entry into its fields
1349 std::vector<std::string> logEntryFields;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08001350 bmcweb::split(logEntryFields, entry, ',');
Jason M. Billscd225da2019-05-08 15:31:57 -07001351 // We need at least a MessageId to be valid
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001352 auto logEntryIter = logEntryFields.begin();
1353 if (logEntryIter == logEntryFields.end())
Jason M. Billscd225da2019-05-08 15:31:57 -07001354 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001355 return LogParseError::parseFailed;
Jason M. Billscd225da2019-05-08 15:31:57 -07001356 }
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001357 std::string& messageID = *logEntryIter;
Jason M. Bills4851d452019-03-28 11:27:48 -07001358 // Get the Message from the MessageRegistry
Ed Tanousfffb8c12022-02-07 23:53:03 -08001359 const registries::Message* message = registries::getMessage(messageID);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001360
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001361 logEntryIter++;
Sui Chen54417b02022-03-24 14:59:52 -07001362 if (message == nullptr)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001363 {
Ed Tanous62598e32023-07-17 17:06:25 -07001364 BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001365 return LogParseError::messageIdNotInRegistry;
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001366 }
1367
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001368 std::vector<std::string_view> messageArgs(logEntryIter,
1369 logEntryFields.end());
Ed Tanousc05bba42023-06-28 08:33:29 -07001370 messageArgs.resize(message->numberOfArgs);
1371
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001372 std::string msg = redfish::registries::fillMessageArgs(messageArgs,
1373 message->message);
1374 if (msg.empty())
Jason M. Bills4851d452019-03-28 11:27:48 -07001375 {
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001376 return LogParseError::parseFailed;
Jason M. Bills4851d452019-03-28 11:27:48 -07001377 }
1378
Jason M. Bills95820182019-04-22 16:25:34 -07001379 // Get the Created time from the timestamp. The log timestamp is in RFC3339
1380 // format which matches the Redfish format except for the fractional seconds
1381 // between the '.' and the '+', so just remove them.
Ed Tanousf23b7292020-10-15 09:41:17 -07001382 std::size_t dot = timestamp.find_first_of('.');
1383 std::size_t plus = timestamp.find_first_of('+');
Jason M. Bills95820182019-04-22 16:25:34 -07001384 if (dot != std::string::npos && plus != std::string::npos)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001385 {
Jason M. Bills95820182019-04-22 16:25:34 -07001386 timestamp.erase(dot, plus - dot);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001387 }
1388
1389 // Fill in the log entry with the gathered data
Vijay Lobo9c11a172021-10-07 16:53:16 -05001390 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07001391 logEntryJson["@odata.id"] = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -07001392 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}",
1393 BMCWEB_REDFISH_SYSTEM_URI_NAME, logEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07001394 logEntryJson["Name"] = "System Event Log Entry";
1395 logEntryJson["Id"] = logEntryID;
1396 logEntryJson["Message"] = std::move(msg);
1397 logEntryJson["MessageId"] = std::move(messageID);
1398 logEntryJson["MessageArgs"] = messageArgs;
1399 logEntryJson["EntryType"] = "Event";
1400 logEntryJson["Severity"] = message->messageSeverity;
1401 logEntryJson["Created"] = std::move(timestamp);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001402 return LogParseError::success;
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001403}
1404
Ed Tanous898f2aa2024-08-07 12:18:22 -07001405inline void fillEventLogLogEntryFromPropertyMap(
1406 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1407 const dbus::utility::DBusPropertiesMap& resp,
1408 nlohmann::json& objectToFillOut)
1409{
1410 uint32_t id = 0;
1411 uint64_t timestamp = 0;
1412 uint64_t updateTimestamp = 0;
1413 std::string severity;
1414 std::string message;
1415 const std::string* filePath = nullptr;
1416 const std::string* resolution = nullptr;
1417 bool resolved = false;
1418 std::string notify;
1419 // clang-format off
1420 bool success = sdbusplus::unpackPropertiesNoThrow(
1421 dbus_utils::UnpackErrorPrinter(), resp,
1422 "Id", id,
1423 "Message", message,
1424 "Path", filePath,
1425 "Resolution", resolution,
1426 "Resolved", resolved,
1427 "ServiceProviderNotify", notify,
1428 "Severity", severity,
1429 "Timestamp", timestamp,
1430 "UpdateTimestamp", updateTimestamp
1431 );
1432 // clang-format on
1433
1434 if (!success)
1435 {
1436 messages::internalError(asyncResp->res);
1437 return;
1438 }
1439
1440 objectToFillOut["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
1441 objectToFillOut["@odata.id"] = boost::urls::format(
1442 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}",
1443 BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(id));
1444 objectToFillOut["Name"] = "System Event Log Entry";
1445 objectToFillOut["Id"] = std::to_string(id);
1446 objectToFillOut["Message"] = message;
1447 objectToFillOut["Resolved"] = resolved;
1448 std::optional<bool> notifyAction = getProviderNotifyAction(notify);
1449 if (notifyAction)
1450 {
1451 objectToFillOut["ServiceProviderNotified"] = *notifyAction;
1452 }
1453 if ((resolution != nullptr) && !resolution->empty())
1454 {
1455 objectToFillOut["Resolution"] = *resolution;
1456 }
1457 objectToFillOut["EntryType"] = "Event";
1458 objectToFillOut["Severity"] = translateSeverityDbusToRedfish(severity);
1459 objectToFillOut["Created"] =
1460 redfish::time_utils::getDateTimeUintMs(timestamp);
1461 objectToFillOut["Modified"] =
1462 redfish::time_utils::getDateTimeUintMs(updateTimestamp);
1463 if (filePath != nullptr)
1464 {
1465 objectToFillOut["AdditionalDataURI"] = boost::urls::format(
1466 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}/attachment",
1467 BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(id));
1468 }
1469}
1470
Ed Tanousb7290962024-08-07 11:09:51 -07001471inline void afterLogEntriesGetManagedObjects(
1472 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1473 const boost::system::error_code& ec,
1474 const dbus::utility::ManagedObjectType& resp)
1475{
1476 if (ec)
1477 {
1478 // TODO Handle for specific error code
1479 BMCWEB_LOG_ERROR("getLogEntriesIfaceData resp_handler got error {}",
1480 ec);
1481 messages::internalError(asyncResp->res);
1482 return;
1483 }
1484 nlohmann::json::array_t entriesArray;
1485 for (const auto& objectPath : resp)
1486 {
Ed Tanous898f2aa2024-08-07 12:18:22 -07001487 dbus::utility::DBusPropertiesMap propsFlattened;
1488 auto isEntry = std::ranges::find_if(objectPath.second,
1489 [](const auto& object) {
1490 return object.first == "xyz.openbmc_project.Logging.Entry";
1491 });
1492 if (isEntry == objectPath.second.end())
Ed Tanousb7290962024-08-07 11:09:51 -07001493 {
1494 continue;
1495 }
Ed Tanous898f2aa2024-08-07 12:18:22 -07001496 for (const auto& interfaceMap : objectPath.second)
Ed Tanousb7290962024-08-07 11:09:51 -07001497 {
Ed Tanous898f2aa2024-08-07 12:18:22 -07001498 for (const auto& propertyMap : interfaceMap.second)
Ed Tanousb7290962024-08-07 11:09:51 -07001499 {
Ed Tanous898f2aa2024-08-07 12:18:22 -07001500 propsFlattened.emplace_back(propertyMap.first,
1501 propertyMap.second);
Ed Tanousb7290962024-08-07 11:09:51 -07001502 }
1503 }
Ed Tanous898f2aa2024-08-07 12:18:22 -07001504 fillEventLogLogEntryFromPropertyMap(asyncResp, propsFlattened,
1505 entriesArray.emplace_back());
Ed Tanousb7290962024-08-07 11:09:51 -07001506 }
Ed Tanous898f2aa2024-08-07 12:18:22 -07001507
Ed Tanousb7290962024-08-07 11:09:51 -07001508 std::ranges::sort(entriesArray, [](const nlohmann::json& left,
1509 const nlohmann::json& right) {
1510 return (left["Id"] <= right["Id"]);
1511 });
1512 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
1513 asyncResp->res.jsonValue["Members"] = std::move(entriesArray);
1514}
1515
Alexander Hansen599b9af2024-08-06 15:11:57 +02001516inline void handleSystemsLogServiceEventLogLogEntryCollection(
1517 App& app, const crow::Request& req,
1518 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1519 const std::string& systemName)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001520{
Alexander Hansen599b9af2024-08-06 15:11:57 +02001521 query_param::QueryCapabilities capabilities = {
1522 .canDelegateTop = true,
1523 .canDelegateSkip = true,
1524 };
1525 query_param::Query delegatedQuery;
1526 if (!redfish::setUpRedfishRouteWithDelegation(app, req, asyncResp,
1527 delegatedQuery, capabilities))
1528 {
1529 return;
1530 }
1531 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
1532 {
1533 // Option currently returns no systems. TBD
1534 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1535 systemName);
1536 return;
1537 }
1538 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
1539 {
1540 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1541 systemName);
1542 return;
1543 }
1544
1545 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
1546 size_t skip = delegatedQuery.skip.value_or(0);
1547
1548 // Collections don't include the static data added by SubRoute
1549 // because it has a duplicate entry for members
1550 asyncResp->res.jsonValue["@odata.type"] =
1551 "#LogEntryCollection.LogEntryCollection";
1552 asyncResp->res.jsonValue["@odata.id"] =
1553 std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1554 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1555 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1556 asyncResp->res.jsonValue["Description"] =
1557 "Collection of System Event Log Entries";
1558
1559 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1560 logEntryArray = nlohmann::json::array();
1561 // Go through the log files and create a unique ID for each
1562 // entry
1563 std::vector<std::filesystem::path> redfishLogFiles;
1564 getRedfishLogFiles(redfishLogFiles);
1565 uint64_t entryCount = 0;
1566 std::string logEntry;
1567
1568 // Oldest logs are in the last file, so start there and loop
1569 // backwards
1570 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++)
1571 {
1572 std::ifstream logStream(*it);
1573 if (!logStream.is_open())
Ed Tanous002d39b2022-05-31 08:59:27 -07001574 {
Alexander Hansen599b9af2024-08-06 15:11:57 +02001575 continue;
Ed Tanous22d268c2022-05-19 09:39:07 -07001576 }
1577
Alexander Hansen599b9af2024-08-06 15:11:57 +02001578 // Reset the unique ID on the first entry
1579 bool firstEntry = true;
1580 while (std::getline(logStream, logEntry))
Ed Tanous002d39b2022-05-31 08:59:27 -07001581 {
Alexander Hansen599b9af2024-08-06 15:11:57 +02001582 std::string idStr;
1583 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1584 {
1585 continue;
1586 }
1587 firstEntry = false;
1588
1589 nlohmann::json::object_t bmcLogEntry;
1590 LogParseError status = fillEventLogEntryJson(idStr, logEntry,
1591 bmcLogEntry);
1592 if (status == LogParseError::messageIdNotInRegistry)
1593 {
1594 continue;
1595 }
1596 if (status != LogParseError::success)
1597 {
1598 messages::internalError(asyncResp->res);
1599 return;
1600 }
1601
1602 entryCount++;
1603 // Handle paging using skip (number of entries to skip from the
1604 // start) and top (number of entries to display)
1605 if (entryCount <= skip || entryCount > skip + top)
Jason M. Bills4978b632022-02-22 14:17:43 -08001606 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001607 continue;
Jason M. Bills4978b632022-02-22 14:17:43 -08001608 }
Jason M. Bills897967d2019-07-29 17:05:30 -07001609
Alexander Hansen599b9af2024-08-06 15:11:57 +02001610 logEntryArray.emplace_back(std::move(bmcLogEntry));
1611 }
1612 }
1613 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1614 if (skip + top < entryCount)
1615 {
1616 asyncResp->res.jsonValue["Members@odata.nextLink"] =
1617 boost::urls::format(
1618 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries?$skip={}",
1619 BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(skip + top));
1620 }
1621}
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001622
Alexander Hansen599b9af2024-08-06 15:11:57 +02001623inline void requestRoutesJournalEventLogEntryCollection(App& app)
1624{
1625 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
1626 .privileges(redfish::privileges::getLogEntryCollection)
1627 .methods(boost::beast::http::verb::get)(std::bind_front(
1628 handleSystemsLogServiceEventLogLogEntryCollection, std::ref(app)));
1629}
1630
1631inline void handleSystemsLogServiceEventLogEntriesGet(
1632 App& app, const crow::Request& req,
1633 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1634 const std::string& systemName, const std::string& param)
1635{
1636 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
1637 {
1638 return;
1639 }
1640 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
1641 {
1642 // Option currently returns no systems. TBD
1643 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1644 systemName);
1645 return;
1646 }
1647
1648 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
1649 {
1650 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1651 systemName);
1652 return;
1653 }
1654
1655 const std::string& targetID = param;
1656
1657 // Go through the log files and check the unique ID for each
1658 // entry to find the target entry
1659 std::vector<std::filesystem::path> redfishLogFiles;
1660 getRedfishLogFiles(redfishLogFiles);
1661 std::string logEntry;
1662
1663 // Oldest logs are in the last file, so start there and loop
1664 // backwards
1665 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++)
1666 {
1667 std::ifstream logStream(*it);
1668 if (!logStream.is_open())
1669 {
1670 continue;
1671 }
1672
1673 // Reset the unique ID on the first entry
1674 bool firstEntry = true;
1675 while (std::getline(logStream, logEntry))
1676 {
1677 std::string idStr;
1678 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1679 {
1680 continue;
1681 }
1682 firstEntry = false;
1683
1684 if (idStr == targetID)
1685 {
Jason M. Billsde703c52022-06-23 14:19:04 -07001686 nlohmann::json::object_t bmcLogEntry;
Patrick Williams89492a12023-05-10 07:51:34 -05001687 LogParseError status = fillEventLogEntryJson(idStr, logEntry,
1688 bmcLogEntry);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001689 if (status != LogParseError::success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001690 {
1691 messages::internalError(asyncResp->res);
1692 return;
Andrew Geisslercb92c032018-08-17 07:56:14 -07001693 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001694 asyncResp->res.jsonValue.update(bmcLogEntry);
1695 return;
Jason M. Bills4978b632022-02-22 14:17:43 -08001696 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001697 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001698 }
1699 // Requested ID was not found
1700 messages::resourceNotFound(asyncResp->res, "LogEntry", targetID);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001701}
Chicago Duan336e96c2019-07-15 14:22:08 +08001702
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001703inline void requestRoutesJournalEventLogEntry(App& app)
1704{
1705 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001706 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001707 .privileges(redfish::privileges::getLogEntry)
Alexander Hansen599b9af2024-08-06 15:11:57 +02001708 .methods(boost::beast::http::verb::get)(std::bind_front(
1709 handleSystemsLogServiceEventLogEntriesGet, std::ref(app)));
1710}
1711
1712inline void dBusEventLogEntryCollection(
1713 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
1714{
1715 // Collections don't include the static data added by SubRoute
1716 // because it has a duplicate entry for members
1717 asyncResp->res.jsonValue["@odata.type"] =
1718 "#LogEntryCollection.LogEntryCollection";
1719 asyncResp->res.jsonValue["@odata.id"] =
1720 std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1721 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1722 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1723 asyncResp->res.jsonValue["Description"] =
1724 "Collection of System Event Log Entries";
1725
1726 // DBus implementation of EventLog/Entries
1727 // Make call to Logging Service to find all log entry objects
1728 sdbusplus::message::object_path path("/xyz/openbmc_project/logging");
1729 dbus::utility::getManagedObjects(
1730 "xyz.openbmc_project.Logging", path,
1731 [asyncResp](const boost::system::error_code& ec,
1732 const dbus::utility::ManagedObjectType& resp) {
Ed Tanousb7290962024-08-07 11:09:51 -07001733 afterLogEntriesGetManagedObjects(asyncResp, ec, resp);
Patrick Williams5a39f772023-10-20 11:20:21 -05001734 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001735}
1736
1737inline void requestRoutesDBusEventLogEntryCollection(App& app)
1738{
Ed Tanous22d268c2022-05-19 09:39:07 -07001739 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07001740 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001741 .methods(boost::beast::http::verb::get)(
1742 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001743 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1744 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001745 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001746 {
1747 return;
1748 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001749 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001750 {
1751 // Option currently returns no systems. TBD
1752 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1753 systemName);
1754 return;
1755 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001756 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001757 {
1758 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1759 systemName);
1760 return;
1761 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001762 dBusEventLogEntryCollection(asyncResp);
1763 });
1764}
Ed Tanous22d268c2022-05-19 09:39:07 -07001765
Alexander Hansen599b9af2024-08-06 15:11:57 +02001766inline void
1767 dBusEventLogEntryGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous898f2aa2024-08-07 12:18:22 -07001768 std::string entryID)
Alexander Hansen599b9af2024-08-06 15:11:57 +02001769{
1770 dbus::utility::escapePathForDbus(entryID);
Ed Tanous002d39b2022-05-31 08:59:27 -07001771
Alexander Hansen599b9af2024-08-06 15:11:57 +02001772 // DBus implementation of EventLog/Entries
1773 // Make call to Logging Service to find all log entry objects
1774 sdbusplus::asio::getAllProperties(
1775 *crow::connections::systemBus, "xyz.openbmc_project.Logging",
1776 "/xyz/openbmc_project/logging/entry/" + entryID, "",
1777 [asyncResp, entryID](const boost::system::error_code& ec,
1778 const dbus::utility::DBusPropertiesMap& resp) {
1779 if (ec.value() == EBADR)
1780 {
1781 messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1782 entryID);
1783 return;
1784 }
1785 if (ec)
1786 {
1787 BMCWEB_LOG_ERROR("EventLogEntry (DBus) resp_handler got error {}",
1788 ec);
1789 messages::internalError(asyncResp->res);
1790 return;
1791 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001792
Ed Tanous898f2aa2024-08-07 12:18:22 -07001793 fillEventLogLogEntryFromPropertyMap(asyncResp, resp,
1794 asyncResp->res.jsonValue);
Alexander Hansen599b9af2024-08-06 15:11:57 +02001795 });
1796}
1797
1798inline void
1799 dBusEventLogEntryPatch(const crow::Request& req,
1800 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1801 const std::string& entryId)
1802{
1803 std::optional<bool> resolved;
1804
1805 if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", resolved))
1806 {
1807 return;
1808 }
1809 BMCWEB_LOG_DEBUG("Set Resolved");
1810
1811 setDbusProperty(asyncResp, "Resolved", "xyz.openbmc_project.Logging",
1812 "/xyz/openbmc_project/logging/entry/" + entryId,
1813 "xyz.openbmc_project.Logging.Entry", "Resolved",
1814 resolved.value_or(false));
1815}
1816
1817inline void
1818 dBusEventLogEntryDelete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1819 std::string entryID)
1820{
1821 BMCWEB_LOG_DEBUG("Do delete single event entries.");
1822
1823 dbus::utility::escapePathForDbus(entryID);
1824
1825 // Process response from Logging service.
1826 auto respHandler = [asyncResp,
1827 entryID](const boost::system::error_code& ec) {
1828 BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done");
1829 if (ec)
1830 {
1831 if (ec.value() == EBADR)
Ed Tanous45ca1b82022-03-25 13:07:27 -07001832 {
Alexander Hansen599b9af2024-08-06 15:11:57 +02001833 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001834 return;
1835 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001836 // TODO Handle for specific error code
1837 BMCWEB_LOG_ERROR(
1838 "EventLogEntry (DBus) doDelete respHandler got error {}", ec);
1839 asyncResp->res.result(
1840 boost::beast::http::status::internal_server_error);
1841 return;
1842 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001843
Alexander Hansen599b9af2024-08-06 15:11:57 +02001844 asyncResp->res.result(boost::beast::http::status::ok);
1845 };
1846
1847 // Make call to Logging service to request Delete Log
1848 crow::connections::systemBus->async_method_call(
1849 respHandler, "xyz.openbmc_project.Logging",
1850 "/xyz/openbmc_project/logging/entry/" + entryID,
1851 "xyz.openbmc_project.Object.Delete", "Delete");
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001852}
Xiaochao Ma75710de2021-01-21 17:56:02 +08001853
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001854inline void requestRoutesDBusEventLogEntry(App& app)
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001855{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001856 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001857 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001858 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07001859 .methods(boost::beast::http::verb::get)(
1860 [&app](const crow::Request& req,
1861 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous898f2aa2024-08-07 12:18:22 -07001862 const std::string& systemName, const std::string& entryId) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001863 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001864 {
1865 return;
1866 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001867 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001868 {
1869 // Option currently returns no systems. TBD
1870 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1871 systemName);
1872 return;
1873 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001874 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001875 {
1876 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1877 systemName);
1878 return;
1879 }
1880
Ed Tanous898f2aa2024-08-07 12:18:22 -07001881 dBusEventLogEntryGet(asyncResp, entryId);
Patrick Williams5a39f772023-10-20 11:20:21 -05001882 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001883
1884 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001885 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001886 .privileges(redfish::privileges::patchLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001887 .methods(boost::beast::http::verb::patch)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001888 [&app](const crow::Request& req,
1889 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001890 const std::string& systemName, const std::string& entryId) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001891 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001892 {
1893 return;
1894 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001895 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001896 {
1897 // Option currently returns no systems. TBD
1898 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1899 systemName);
1900 return;
1901 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001902 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001903 {
1904 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1905 systemName);
1906 return;
1907 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001908
Alexander Hansen599b9af2024-08-06 15:11:57 +02001909 dBusEventLogEntryPatch(req, asyncResp, entryId);
Patrick Williams5a39f772023-10-20 11:20:21 -05001910 });
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001911
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001912 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001913 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001914 .privileges(redfish::privileges::deleteLogEntry)
1915
Ed Tanous002d39b2022-05-31 08:59:27 -07001916 .methods(boost::beast::http::verb::delete_)(
1917 [&app](const crow::Request& req,
1918 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001919 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001920 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001921 {
1922 return;
1923 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001924 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001925 {
1926 // Option currently returns no systems. TBD
1927 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1928 systemName);
1929 return;
1930 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001931 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001932 {
1933 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1934 systemName);
1935 return;
1936 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001937 dBusEventLogEntryDelete(asyncResp, param);
Patrick Williams5a39f772023-10-20 11:20:21 -05001938 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001939}
1940
Spencer Kub7028eb2021-10-26 15:27:35 +08001941constexpr const char* hostLoggerFolderPath = "/var/log/console";
1942
1943inline bool
1944 getHostLoggerFiles(const std::string& hostLoggerFilePath,
1945 std::vector<std::filesystem::path>& hostLoggerFiles)
1946{
1947 std::error_code ec;
1948 std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec);
1949 if (ec)
1950 {
Carson Labradobf2dded2023-08-10 00:37:06 +00001951 BMCWEB_LOG_WARNING("{}", ec.message());
Spencer Kub7028eb2021-10-26 15:27:35 +08001952 return false;
1953 }
1954 for (const std::filesystem::directory_entry& it : logPath)
1955 {
1956 std::string filename = it.path().filename();
1957 // Prefix of each log files is "log". Find the file and save the
1958 // path
Ed Tanous11ba3972022-07-11 09:50:41 -07001959 if (filename.starts_with("log"))
Spencer Kub7028eb2021-10-26 15:27:35 +08001960 {
1961 hostLoggerFiles.emplace_back(it.path());
1962 }
1963 }
1964 // As the log files rotate, they are appended with a ".#" that is higher for
1965 // the older logs. Since we start from oldest logs, sort the name in
1966 // descending order.
1967 std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(),
1968 AlphanumLess<std::string>());
1969
1970 return true;
1971}
1972
Ed Tanous02cad962022-06-30 16:50:15 -07001973inline bool getHostLoggerEntries(
1974 const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip,
1975 uint64_t top, std::vector<std::string>& logEntries, size_t& logCount)
Spencer Kub7028eb2021-10-26 15:27:35 +08001976{
1977 GzFileReader logFile;
1978
1979 // Go though all log files and expose host logs.
1980 for (const std::filesystem::path& it : hostLoggerFiles)
1981 {
1982 if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount))
1983 {
Ed Tanous62598e32023-07-17 17:06:25 -07001984 BMCWEB_LOG_ERROR("fail to expose host logs");
Spencer Kub7028eb2021-10-26 15:27:35 +08001985 return false;
1986 }
1987 }
1988 // Get lastMessage from constructor by getter
1989 std::string lastMessage = logFile.getLastMessage();
1990 if (!lastMessage.empty())
1991 {
1992 logCount++;
1993 if (logCount > skip && logCount <= (skip + top))
1994 {
1995 logEntries.push_back(lastMessage);
1996 }
1997 }
1998 return true;
1999}
2000
Ed Tanous6f056f22024-04-07 13:35:51 -07002001inline void fillHostLoggerEntryJson(std::string_view logEntryID,
2002 std::string_view msg,
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002003 nlohmann::json::object_t& logEntryJson)
Spencer Kub7028eb2021-10-26 15:27:35 +08002004{
2005 // Fill in the log entry with the gathered data.
Vijay Lobo9c11a172021-10-07 16:53:16 -05002006 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07002007 logEntryJson["@odata.id"] = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -07002008 "/redfish/v1/Systems/{}/LogServices/HostLogger/Entries/{}",
2009 BMCWEB_REDFISH_SYSTEM_URI_NAME, logEntryID);
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002010 logEntryJson["Name"] = "Host Logger Entry";
2011 logEntryJson["Id"] = logEntryID;
2012 logEntryJson["Message"] = msg;
Ed Tanous539d8c62024-06-19 14:38:27 -07002013 logEntryJson["EntryType"] = log_entry::LogEntryType::Oem;
2014 logEntryJson["Severity"] = log_entry::EventSeverity::OK;
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002015 logEntryJson["OemRecordFormat"] = "Host Logger Entry";
Spencer Kub7028eb2021-10-26 15:27:35 +08002016}
2017
2018inline void requestRoutesSystemHostLogger(App& app)
2019{
Ed Tanous22d268c2022-05-19 09:39:07 -07002020 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002021 .privileges(redfish::privileges::getLogService)
Ed Tanous14766872022-03-15 10:44:42 -07002022 .methods(boost::beast::http::verb::get)(
2023 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002024 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2025 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002026 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002027 {
2028 return;
2029 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002030 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002031 {
2032 // Option currently returns no systems. TBD
2033 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2034 systemName);
2035 return;
2036 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002037 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002038 {
2039 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2040 systemName);
2041 return;
2042 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002043 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002044 std::format("/redfish/v1/Systems/{}/LogServices/HostLogger",
2045 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002046 asyncResp->res.jsonValue["@odata.type"] =
Janet Adkinsb25644a2023-08-16 11:23:45 -05002047 "#LogService.v1_2_0.LogService";
Ed Tanous002d39b2022-05-31 08:59:27 -07002048 asyncResp->res.jsonValue["Name"] = "Host Logger Service";
2049 asyncResp->res.jsonValue["Description"] = "Host Logger Service";
2050 asyncResp->res.jsonValue["Id"] = "HostLogger";
2051 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002052 std::format("/redfish/v1/Systems/{}/LogServices/HostLogger/Entries",
2053 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williams5a39f772023-10-20 11:20:21 -05002054 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002055}
2056
2057inline void requestRoutesSystemHostLoggerCollection(App& app)
2058{
2059 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002060 "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002061 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07002062 .methods(boost::beast::http::verb::get)(
2063 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002064 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2065 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002066 query_param::QueryCapabilities capabilities = {
2067 .canDelegateTop = true,
2068 .canDelegateSkip = true,
2069 };
2070 query_param::Query delegatedQuery;
2071 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00002072 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07002073 {
2074 return;
2075 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002076 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002077 {
2078 // Option currently returns no systems. TBD
2079 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2080 systemName);
2081 return;
2082 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002083 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002084 {
2085 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2086 systemName);
2087 return;
2088 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002089 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002090 std::format("/redfish/v1/Systems/{}/LogServices/HostLogger/Entries",
2091 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002092 asyncResp->res.jsonValue["@odata.type"] =
2093 "#LogEntryCollection.LogEntryCollection";
2094 asyncResp->res.jsonValue["Name"] = "HostLogger Entries";
2095 asyncResp->res.jsonValue["Description"] =
2096 "Collection of HostLogger Entries";
2097 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2098 logEntryArray = nlohmann::json::array();
2099 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Spencer Kub7028eb2021-10-26 15:27:35 +08002100
Ed Tanous002d39b2022-05-31 08:59:27 -07002101 std::vector<std::filesystem::path> hostLoggerFiles;
2102 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2103 {
Carson Labradobf2dded2023-08-10 00:37:06 +00002104 BMCWEB_LOG_DEBUG("Failed to get host log file path");
Ed Tanous002d39b2022-05-31 08:59:27 -07002105 return;
2106 }
Ed Tanous3648c8b2022-07-25 13:39:59 -07002107 // If we weren't provided top and skip limits, use the defaults.
2108 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08002109 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous002d39b2022-05-31 08:59:27 -07002110 size_t logCount = 0;
2111 // This vector only store the entries we want to expose that
2112 // control by skip and top.
2113 std::vector<std::string> logEntries;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002114 if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries,
2115 logCount))
Ed Tanous002d39b2022-05-31 08:59:27 -07002116 {
2117 messages::internalError(asyncResp->res);
2118 return;
2119 }
2120 // If vector is empty, that means skip value larger than total
2121 // log count
2122 if (logEntries.empty())
2123 {
2124 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
2125 return;
2126 }
2127 if (!logEntries.empty())
2128 {
2129 for (size_t i = 0; i < logEntries.size(); i++)
George Liu0fda0f12021-11-16 10:06:17 +08002130 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002131 nlohmann::json::object_t hostLogEntry;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002132 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i],
2133 hostLogEntry);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002134 logEntryArray.emplace_back(std::move(hostLogEntry));
George Liu0fda0f12021-11-16 10:06:17 +08002135 }
2136
Ed Tanous002d39b2022-05-31 08:59:27 -07002137 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002138 if (skip + top < logCount)
George Liu0fda0f12021-11-16 10:06:17 +08002139 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002140 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002141 std::format(
2142 "/redfish/v1/Systems/{}/LogServices/HostLogger/Entries?$skip=",
2143 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
Ed Tanous3648c8b2022-07-25 13:39:59 -07002144 std::to_string(skip + top);
George Liu0fda0f12021-11-16 10:06:17 +08002145 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002146 }
Patrick Williams5a39f772023-10-20 11:20:21 -05002147 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002148}
2149
2150inline void requestRoutesSystemHostLoggerLogEntry(App& app)
2151{
2152 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07002153 app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002154 .privileges(redfish::privileges::getLogEntry)
2155 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002156 [&app](const crow::Request& req,
2157 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07002158 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002159 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002160 {
2161 return;
2162 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002163 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002164 {
2165 // Option currently returns no systems. TBD
2166 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2167 systemName);
2168 return;
2169 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002170 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002171 {
2172 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2173 systemName);
2174 return;
2175 }
Ed Tanous6f056f22024-04-07 13:35:51 -07002176 std::string_view targetID = param;
Spencer Kub7028eb2021-10-26 15:27:35 +08002177
Ed Tanous002d39b2022-05-31 08:59:27 -07002178 uint64_t idInt = 0;
Ed Tanousca45aa32022-01-07 09:28:45 -08002179
Ed Tanous6f056f22024-04-07 13:35:51 -07002180 auto [ptr, ec] = std::from_chars(targetID.begin(), targetID.end(),
Patrick Williams84396af2023-05-11 11:47:45 -05002181 idInt);
Ed Tanous6f056f22024-04-07 13:35:51 -07002182 if (ec != std::errc{} || ptr != targetID.end())
Ed Tanous002d39b2022-05-31 08:59:27 -07002183 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002184 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Ed Tanous002d39b2022-05-31 08:59:27 -07002185 return;
2186 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002187
Ed Tanous002d39b2022-05-31 08:59:27 -07002188 std::vector<std::filesystem::path> hostLoggerFiles;
2189 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2190 {
Carson Labradobf2dded2023-08-10 00:37:06 +00002191 BMCWEB_LOG_DEBUG("Failed to get host log file path");
Ed Tanous002d39b2022-05-31 08:59:27 -07002192 return;
2193 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002194
Ed Tanous002d39b2022-05-31 08:59:27 -07002195 size_t logCount = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002196 size_t top = 1;
Ed Tanous002d39b2022-05-31 08:59:27 -07002197 std::vector<std::string> logEntries;
2198 // We can get specific entry by skip and top. For example, if we
2199 // want to get nth entry, we can set skip = n-1 and top = 1 to
2200 // get that entry
2201 if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries,
2202 logCount))
2203 {
2204 messages::internalError(asyncResp->res);
2205 return;
2206 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002207
Ed Tanous002d39b2022-05-31 08:59:27 -07002208 if (!logEntries.empty())
2209 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002210 nlohmann::json::object_t hostLogEntry;
2211 fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry);
2212 asyncResp->res.jsonValue.update(hostLogEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07002213 return;
2214 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002215
Ed Tanous002d39b2022-05-31 08:59:27 -07002216 // Requested ID was not found
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002217 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Patrick Williams5a39f772023-10-20 11:20:21 -05002218 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002219}
2220
Claire Weinandd72e872022-08-15 14:20:06 -07002221inline void handleBMCLogServicesCollectionGet(
Claire Weinanfdd26902022-03-01 14:18:25 -08002222 crow::App& app, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002223 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2224 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002225{
2226 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2227 {
2228 return;
2229 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002230
2231 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2232 {
2233 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2234 return;
2235 }
2236
Claire Weinanfdd26902022-03-01 14:18:25 -08002237 // Collections don't include the static data added by SubRoute
2238 // because it has a duplicate entry for members
2239 asyncResp->res.jsonValue["@odata.type"] =
2240 "#LogServiceCollection.LogServiceCollection";
Ed Tanous253f11b2024-05-16 09:38:31 -07002241 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
2242 "/redfish/v1/Managers/{}/LogServices", BMCWEB_REDFISH_MANAGER_URI_NAME);
Claire Weinanfdd26902022-03-01 14:18:25 -08002243 asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
2244 asyncResp->res.jsonValue["Description"] =
2245 "Collection of LogServices for this Manager";
2246 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
2247 logServiceArray = nlohmann::json::array();
2248
Ed Tanous25b54db2024-04-17 15:40:31 -07002249 if constexpr (BMCWEB_REDFISH_BMC_JOURNAL)
2250 {
2251 nlohmann::json::object_t journal;
Ed Tanous253f11b2024-05-16 09:38:31 -07002252 journal["@odata.id"] =
2253 boost::urls::format("/redfish/v1/Managers/{}/LogServices/Journal",
2254 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07002255 logServiceArray.emplace_back(std::move(journal));
2256 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002257
2258 asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size();
2259
Ed Tanous25b54db2024-04-17 15:40:31 -07002260 if constexpr (BMCWEB_REDFISH_DUMP_LOG)
2261 {
2262 constexpr std::array<std::string_view, 1> interfaces = {
2263 "xyz.openbmc_project.Collection.DeleteAll"};
2264 dbus::utility::getSubTreePaths(
2265 "/xyz/openbmc_project/dump", 0, interfaces,
2266 [asyncResp](const boost::system::error_code& ec,
2267 const dbus::utility::MapperGetSubTreePathsResponse&
2268 subTreePaths) {
2269 if (ec)
Claire Weinanfdd26902022-03-01 14:18:25 -08002270 {
Ed Tanous25b54db2024-04-17 15:40:31 -07002271 BMCWEB_LOG_ERROR(
2272 "handleBMCLogServicesCollectionGet respHandler got error {}",
2273 ec);
2274 // Assume that getting an error simply means there are no dump
2275 // LogServices. Return without adding any error response.
2276 return;
Claire Weinanfdd26902022-03-01 14:18:25 -08002277 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002278
Ed Tanous25b54db2024-04-17 15:40:31 -07002279 nlohmann::json& logServiceArrayLocal =
2280 asyncResp->res.jsonValue["Members"];
2281
2282 for (const std::string& path : subTreePaths)
2283 {
2284 if (path == "/xyz/openbmc_project/dump/bmc")
2285 {
2286 nlohmann::json::object_t member;
Ed Tanous253f11b2024-05-16 09:38:31 -07002287 member["@odata.id"] = boost::urls::format(
2288 "/redfish/v1/Managers/{}/LogServices/Dump",
2289 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07002290 logServiceArrayLocal.emplace_back(std::move(member));
2291 }
2292 else if (path == "/xyz/openbmc_project/dump/faultlog")
2293 {
2294 nlohmann::json::object_t member;
Ed Tanous253f11b2024-05-16 09:38:31 -07002295 member["@odata.id"] = boost::urls::format(
2296 "/redfish/v1/Managers/{}/LogServices/FaultLog",
2297 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07002298 logServiceArrayLocal.emplace_back(std::move(member));
2299 }
2300 }
2301
2302 asyncResp->res.jsonValue["Members@odata.count"] =
2303 logServiceArrayLocal.size();
2304 });
2305 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002306}
2307
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002308inline void requestRoutesBMCLogServiceCollection(App& app)
2309{
Ed Tanous253f11b2024-05-16 09:38:31 -07002310 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/")
Gunnar Millsad89dcf2021-07-30 14:40:11 -05002311 .privileges(redfish::privileges::getLogServiceCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002312 .methods(boost::beast::http::verb::get)(
Claire Weinandd72e872022-08-15 14:20:06 -07002313 std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002314}
Ed Tanous1da66f72018-07-27 16:13:37 -07002315
Claire Weinanfdd26902022-03-01 14:18:25 -08002316inline void
2317 getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2318 const std::string& dumpType)
2319{
2320 std::string dumpPath;
Ed Tanous539d8c62024-06-19 14:38:27 -07002321 log_service::OverWritePolicy overWritePolicy =
2322 log_service::OverWritePolicy::Invalid;
Claire Weinanfdd26902022-03-01 14:18:25 -08002323 bool collectDiagnosticDataSupported = false;
2324
2325 if (dumpType == "BMC")
2326 {
Ed Tanous253f11b2024-05-16 09:38:31 -07002327 dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/Dump",
2328 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous539d8c62024-06-19 14:38:27 -07002329 overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull;
Claire Weinanfdd26902022-03-01 14:18:25 -08002330 collectDiagnosticDataSupported = true;
2331 }
2332 else if (dumpType == "FaultLog")
2333 {
Ed Tanous253f11b2024-05-16 09:38:31 -07002334 dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/FaultLog",
2335 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous539d8c62024-06-19 14:38:27 -07002336 overWritePolicy = log_service::OverWritePolicy::Unknown;
Claire Weinanfdd26902022-03-01 14:18:25 -08002337 collectDiagnosticDataSupported = false;
2338 }
2339 else if (dumpType == "System")
2340 {
Ed Tanous253f11b2024-05-16 09:38:31 -07002341 dumpPath = std::format("/redfish/v1/Systems/{}/LogServices/Dump",
2342 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous539d8c62024-06-19 14:38:27 -07002343 overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull;
Claire Weinanfdd26902022-03-01 14:18:25 -08002344 collectDiagnosticDataSupported = true;
2345 }
2346 else
2347 {
Ed Tanous62598e32023-07-17 17:06:25 -07002348 BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}",
2349 dumpType);
Claire Weinanfdd26902022-03-01 14:18:25 -08002350 messages::internalError(asyncResp->res);
2351 return;
2352 }
2353
2354 asyncResp->res.jsonValue["@odata.id"] = dumpPath;
2355 asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService";
2356 asyncResp->res.jsonValue["Name"] = "Dump LogService";
2357 asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService";
2358 asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename();
Ed Tanous539d8c62024-06-19 14:38:27 -07002359 asyncResp->res.jsonValue["OverWritePolicy"] = overWritePolicy;
Claire Weinanfdd26902022-03-01 14:18:25 -08002360
2361 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002362 redfish::time_utils::getDateTimeOffsetNow();
Claire Weinanfdd26902022-03-01 14:18:25 -08002363 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2364 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2365 redfishDateTimeOffset.second;
2366
2367 asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries";
Claire Weinanfdd26902022-03-01 14:18:25 -08002368
2369 if (collectDiagnosticDataSupported)
2370 {
2371 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
2372 ["target"] =
2373 dumpPath + "/Actions/LogService.CollectDiagnosticData";
2374 }
Claire Weinan0d946212022-07-13 19:40:19 -07002375
2376 constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface};
2377 dbus::utility::getSubTreePaths(
2378 "/xyz/openbmc_project/dump", 0, interfaces,
2379 [asyncResp, dumpType, dumpPath](
2380 const boost::system::error_code& ec,
2381 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2382 if (ec)
2383 {
Ed Tanous62598e32023-07-17 17:06:25 -07002384 BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", ec);
Claire Weinan0d946212022-07-13 19:40:19 -07002385 // Assume that getting an error simply means there are no dump
2386 // LogServices. Return without adding any error response.
2387 return;
2388 }
Ed Tanous18f8f602023-07-18 10:07:23 -07002389 std::string dbusDumpPath = getDumpPath(dumpType);
Claire Weinan0d946212022-07-13 19:40:19 -07002390 for (const std::string& path : subTreePaths)
2391 {
2392 if (path == dbusDumpPath)
2393 {
2394 asyncResp->res
2395 .jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
2396 dumpPath + "/Actions/LogService.ClearLog";
2397 break;
2398 }
2399 }
Patrick Williams5a39f772023-10-20 11:20:21 -05002400 });
Claire Weinanfdd26902022-03-01 14:18:25 -08002401}
2402
2403inline void handleLogServicesDumpServiceGet(
2404 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002405 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2406 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002407{
2408 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2409 {
2410 return;
2411 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002412
2413 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2414 {
2415 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2416 return;
2417 }
2418
Claire Weinanfdd26902022-03-01 14:18:25 -08002419 getDumpServiceInfo(asyncResp, dumpType);
2420}
2421
Ed Tanous22d268c2022-05-19 09:39:07 -07002422inline void handleLogServicesDumpServiceComputerSystemGet(
2423 crow::App& app, const crow::Request& req,
2424 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2425 const std::string& chassisId)
2426{
2427 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2428 {
2429 return;
2430 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002431 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002432 {
2433 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2434 return;
2435 }
2436 getDumpServiceInfo(asyncResp, "System");
2437}
2438
Claire Weinanfdd26902022-03-01 14:18:25 -08002439inline void handleLogServicesDumpEntriesCollectionGet(
2440 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002441 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2442 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002443{
2444 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2445 {
2446 return;
2447 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002448
2449 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2450 {
2451 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2452 return;
2453 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002454 getDumpEntryCollection(asyncResp, dumpType);
2455}
2456
Ed Tanous22d268c2022-05-19 09:39:07 -07002457inline void handleLogServicesDumpEntriesCollectionComputerSystemGet(
2458 crow::App& app, const crow::Request& req,
2459 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2460 const std::string& chassisId)
2461{
2462 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2463 {
2464 return;
2465 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002466 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002467 {
2468 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2469 return;
2470 }
2471 getDumpEntryCollection(asyncResp, "System");
2472}
2473
Claire Weinanfdd26902022-03-01 14:18:25 -08002474inline void handleLogServicesDumpEntryGet(
2475 crow::App& app, const std::string& dumpType, const crow::Request& req,
2476 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous253f11b2024-05-16 09:38:31 -07002477 const std::string& managerId, const std::string& dumpId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002478{
2479 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2480 {
2481 return;
2482 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002483 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2484 {
2485 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2486 return;
2487 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002488 getDumpEntryById(asyncResp, dumpId, dumpType);
2489}
Carson Labrado168d1b12023-03-27 17:04:46 +00002490
Ed Tanous22d268c2022-05-19 09:39:07 -07002491inline void handleLogServicesDumpEntryComputerSystemGet(
2492 crow::App& app, const crow::Request& req,
2493 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2494 const std::string& chassisId, const std::string& dumpId)
2495{
2496 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2497 {
2498 return;
2499 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002500 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002501 {
2502 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2503 return;
2504 }
2505 getDumpEntryById(asyncResp, dumpId, "System");
2506}
Claire Weinanfdd26902022-03-01 14:18:25 -08002507
2508inline void handleLogServicesDumpEntryDelete(
2509 crow::App& app, const std::string& dumpType, const crow::Request& req,
2510 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous253f11b2024-05-16 09:38:31 -07002511 const std::string& managerId, const std::string& dumpId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002512{
2513 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2514 {
2515 return;
2516 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002517
2518 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2519 {
2520 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2521 return;
2522 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002523 deleteDumpEntry(asyncResp, dumpId, dumpType);
2524}
2525
Ed Tanous22d268c2022-05-19 09:39:07 -07002526inline void handleLogServicesDumpEntryComputerSystemDelete(
2527 crow::App& app, const crow::Request& req,
2528 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2529 const std::string& chassisId, const std::string& dumpId)
2530{
2531 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2532 {
2533 return;
2534 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002535 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002536 {
2537 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2538 return;
2539 }
2540 deleteDumpEntry(asyncResp, dumpId, "System");
2541}
2542
Carson Labrado168d1b12023-03-27 17:04:46 +00002543inline void handleLogServicesDumpEntryDownloadGet(
2544 crow::App& app, const std::string& dumpType, const crow::Request& req,
2545 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous253f11b2024-05-16 09:38:31 -07002546 const std::string& managerId, const std::string& dumpId)
Carson Labrado168d1b12023-03-27 17:04:46 +00002547{
2548 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2549 {
2550 return;
2551 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002552
2553 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2554 {
2555 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2556 return;
2557 }
Carson Labrado168d1b12023-03-27 17:04:46 +00002558 downloadDumpEntry(asyncResp, dumpId, dumpType);
2559}
2560
2561inline void handleDBusEventLogEntryDownloadGet(
2562 crow::App& app, const std::string& dumpType, const crow::Request& req,
2563 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2564 const std::string& systemName, const std::string& entryID)
2565{
2566 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2567 {
2568 return;
2569 }
2570 if (!http_helpers::isContentTypeAllowed(
2571 req.getHeaderValue("Accept"),
2572 http_helpers::ContentType::OctetStream, true))
2573 {
2574 asyncResp->res.result(boost::beast::http::status::bad_request);
2575 return;
2576 }
2577 downloadEventLogEntry(asyncResp, systemName, entryID, dumpType);
2578}
2579
Claire Weinanfdd26902022-03-01 14:18:25 -08002580inline void handleLogServicesDumpCollectDiagnosticDataPost(
2581 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002582 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2583 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002584{
2585 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2586 {
2587 return;
2588 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002589 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2590 {
2591 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2592 return;
2593 }
2594
Claire Weinanfdd26902022-03-01 14:18:25 -08002595 createDump(asyncResp, req, dumpType);
2596}
2597
Ed Tanous22d268c2022-05-19 09:39:07 -07002598inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost(
2599 crow::App& app, const crow::Request& req,
2600 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002601 const std::string& systemName)
Ed Tanous22d268c2022-05-19 09:39:07 -07002602{
2603 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2604 {
2605 return;
2606 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002607
Ed Tanous25b54db2024-04-17 15:40:31 -07002608 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous22d268c2022-05-19 09:39:07 -07002609 {
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002610 // Option currently returns no systems. TBD
2611 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2612 systemName);
2613 return;
2614 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002615 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002616 {
2617 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2618 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07002619 return;
2620 }
2621 createDump(asyncResp, req, "System");
2622}
2623
Claire Weinanfdd26902022-03-01 14:18:25 -08002624inline void handleLogServicesDumpClearLogPost(
2625 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002626 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2627 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002628{
2629 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2630 {
2631 return;
2632 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002633
2634 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2635 {
2636 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2637 return;
2638 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002639 clearDump(asyncResp, dumpType);
2640}
2641
Ed Tanous22d268c2022-05-19 09:39:07 -07002642inline void handleLogServicesDumpClearLogComputerSystemPost(
2643 crow::App& app, const crow::Request& req,
2644 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002645 const std::string& systemName)
Ed Tanous22d268c2022-05-19 09:39:07 -07002646{
2647 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2648 {
2649 return;
2650 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002651 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous22d268c2022-05-19 09:39:07 -07002652 {
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002653 // Option currently returns no systems. TBD
2654 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2655 systemName);
2656 return;
2657 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002658 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002659 {
2660 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2661 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07002662 return;
2663 }
2664 clearDump(asyncResp, "System");
2665}
2666
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002667inline void requestRoutesBMCDumpService(App& app)
2668{
Ed Tanous253f11b2024-05-16 09:38:31 -07002669 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07002670 .privileges(redfish::privileges::getLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08002671 .methods(boost::beast::http::verb::get)(std::bind_front(
2672 handleLogServicesDumpServiceGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002673}
2674
2675inline void requestRoutesBMCDumpEntryCollection(App& app)
2676{
Ed Tanous253f11b2024-05-16 09:38:31 -07002677 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002678 .privileges(redfish::privileges::getLogEntryCollection)
Claire Weinanfdd26902022-03-01 14:18:25 -08002679 .methods(boost::beast::http::verb::get)(std::bind_front(
2680 handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002681}
2682
2683inline void requestRoutesBMCDumpEntry(App& app)
2684{
2685 BMCWEB_ROUTE(app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002686 "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002687 .privileges(redfish::privileges::getLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002688 .methods(boost::beast::http::verb::get)(std::bind_front(
2689 handleLogServicesDumpEntryGet, std::ref(app), "BMC"));
2690
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002691 BMCWEB_ROUTE(app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002692 "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002693 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002694 .methods(boost::beast::http::verb::delete_)(std::bind_front(
2695 handleLogServicesDumpEntryDelete, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002696}
2697
Carson Labrado168d1b12023-03-27 17:04:46 +00002698inline void requestRoutesBMCDumpEntryDownload(App& app)
2699{
2700 BMCWEB_ROUTE(
2701 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002702 "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/attachment/")
Carson Labrado168d1b12023-03-27 17:04:46 +00002703 .privileges(redfish::privileges::getLogEntry)
2704 .methods(boost::beast::http::verb::get)(std::bind_front(
2705 handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC"));
2706}
2707
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002708inline void requestRoutesBMCDumpCreate(App& app)
2709{
George Liu0fda0f12021-11-16 10:06:17 +08002710 BMCWEB_ROUTE(
2711 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002712 "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07002713 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002714 .methods(boost::beast::http::verb::post)(
Claire Weinanfdd26902022-03-01 14:18:25 -08002715 std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost,
2716 std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002717}
2718
2719inline void requestRoutesBMCDumpClear(App& app)
2720{
George Liu0fda0f12021-11-16 10:06:17 +08002721 BMCWEB_ROUTE(
2722 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002723 "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07002724 .privileges(redfish::privileges::postLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08002725 .methods(boost::beast::http::verb::post)(std::bind_front(
2726 handleLogServicesDumpClearLogPost, std::ref(app), "BMC"));
2727}
2728
Carson Labrado168d1b12023-03-27 17:04:46 +00002729inline void requestRoutesDBusEventLogEntryDownload(App& app)
2730{
2731 BMCWEB_ROUTE(
2732 app,
Ravi Teja9e9d99d2023-11-08 05:33:59 -06002733 "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/")
Carson Labrado168d1b12023-03-27 17:04:46 +00002734 .privileges(redfish::privileges::getLogEntry)
2735 .methods(boost::beast::http::verb::get)(std::bind_front(
2736 handleDBusEventLogEntryDownloadGet, std::ref(app), "System"));
2737}
2738
Claire Weinanfdd26902022-03-01 14:18:25 -08002739inline void requestRoutesFaultLogDumpService(App& app)
2740{
Ed Tanous253f11b2024-05-16 09:38:31 -07002741 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002742 .privileges(redfish::privileges::getLogService)
2743 .methods(boost::beast::http::verb::get)(std::bind_front(
2744 handleLogServicesDumpServiceGet, std::ref(app), "FaultLog"));
2745}
2746
2747inline void requestRoutesFaultLogDumpEntryCollection(App& app)
2748{
Ed Tanous253f11b2024-05-16 09:38:31 -07002749 BMCWEB_ROUTE(app,
2750 "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002751 .privileges(redfish::privileges::getLogEntryCollection)
2752 .methods(boost::beast::http::verb::get)(
2753 std::bind_front(handleLogServicesDumpEntriesCollectionGet,
2754 std::ref(app), "FaultLog"));
2755}
2756
2757inline void requestRoutesFaultLogDumpEntry(App& app)
2758{
Ed Tanous253f11b2024-05-16 09:38:31 -07002759 BMCWEB_ROUTE(
2760 app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002761 .privileges(redfish::privileges::getLogEntry)
2762 .methods(boost::beast::http::verb::get)(std::bind_front(
2763 handleLogServicesDumpEntryGet, std::ref(app), "FaultLog"));
2764
Ed Tanous253f11b2024-05-16 09:38:31 -07002765 BMCWEB_ROUTE(
2766 app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002767 .privileges(redfish::privileges::deleteLogEntry)
2768 .methods(boost::beast::http::verb::delete_)(std::bind_front(
2769 handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog"));
2770}
2771
2772inline void requestRoutesFaultLogDumpClear(App& app)
2773{
2774 BMCWEB_ROUTE(
2775 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002776 "/redfish/v1/Managers/<str>/LogServices/FaultLog/Actions/LogService.ClearLog/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002777 .privileges(redfish::privileges::postLogService)
2778 .methods(boost::beast::http::verb::post)(std::bind_front(
2779 handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002780}
2781
2782inline void requestRoutesSystemDumpService(App& app)
2783{
Ed Tanous22d268c2022-05-19 09:39:07 -07002784 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07002785 .privileges(redfish::privileges::getLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002786 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002787 handleLogServicesDumpServiceComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002788}
2789
2790inline void requestRoutesSystemDumpEntryCollection(App& app)
2791{
Ed Tanous22d268c2022-05-19 09:39:07 -07002792 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002793 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous22d268c2022-05-19 09:39:07 -07002794 .methods(boost::beast::http::verb::get)(std::bind_front(
2795 handleLogServicesDumpEntriesCollectionComputerSystemGet,
2796 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002797}
2798
2799inline void requestRoutesSystemDumpEntry(App& app)
2800{
2801 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002802 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002803 .privileges(redfish::privileges::getLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002804 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002805 handleLogServicesDumpEntryComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002806
2807 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002808 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002809 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002810 .methods(boost::beast::http::verb::delete_)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002811 handleLogServicesDumpEntryComputerSystemDelete, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002812}
2813
2814inline void requestRoutesSystemDumpCreate(App& app)
2815{
George Liu0fda0f12021-11-16 10:06:17 +08002816 BMCWEB_ROUTE(
2817 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002818 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07002819 .privileges(redfish::privileges::postLogService)
Ed Tanous22d268c2022-05-19 09:39:07 -07002820 .methods(boost::beast::http::verb::post)(std::bind_front(
2821 handleLogServicesDumpCollectDiagnosticDataComputerSystemPost,
2822 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002823}
2824
2825inline void requestRoutesSystemDumpClear(App& app)
2826{
George Liu0fda0f12021-11-16 10:06:17 +08002827 BMCWEB_ROUTE(
2828 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002829 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07002830 .privileges(redfish::privileges::postLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002831 .methods(boost::beast::http::verb::post)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002832 handleLogServicesDumpClearLogComputerSystemPost, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002833}
2834
2835inline void requestRoutesCrashdumpService(App& app)
2836{
2837 // Note: Deviated from redfish privilege registry for GET & HEAD
2838 // method for security reasons.
2839 /**
2840 * Functions triggers appropriate requests on DBus
2841 */
Ed Tanous22d268c2022-05-19 09:39:07 -07002842 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/")
Ed Tanoused398212021-06-09 17:05:54 -07002843 // This is incorrect, should be:
2844 //.privileges(redfish::privileges::getLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07002845 .privileges({{"ConfigureManager"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07002846 .methods(boost::beast::http::verb::get)(
2847 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002848 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2849 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002850 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002851 {
2852 return;
2853 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002854 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002855 {
2856 // Option currently returns no systems. TBD
2857 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2858 systemName);
2859 return;
2860 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002861 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002862 {
2863 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2864 systemName);
2865 return;
2866 }
2867
Ed Tanous002d39b2022-05-31 08:59:27 -07002868 // Copy over the static data to include the entries added by
2869 // SubRoute
2870 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002871 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump",
2872 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002873 asyncResp->res.jsonValue["@odata.type"] =
2874 "#LogService.v1_2_0.LogService";
2875 asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
2876 asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
V-Sanjana15b89722023-05-11 16:27:03 +05302877 asyncResp->res.jsonValue["Id"] = "Crashdump";
Ed Tanous539d8c62024-06-19 14:38:27 -07002878 asyncResp->res.jsonValue["OverWritePolicy"] =
2879 log_service::OverWritePolicy::WrapsWhenFull;
Ed Tanous002d39b2022-05-31 08:59:27 -07002880 asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
Tejas Patil7c8c4052021-06-04 17:43:14 +05302881
Ed Tanous002d39b2022-05-31 08:59:27 -07002882 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002883 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07002884 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2885 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2886 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05302887
Ed Tanous002d39b2022-05-31 08:59:27 -07002888 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002889 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump/Entries",
2890 BMCWEB_REDFISH_SYSTEM_URI_NAME);
2891 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]
2892 ["target"] = std::format(
2893 "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.ClearLog",
2894 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002895 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
Ed Tanous253f11b2024-05-16 09:38:31 -07002896 ["target"] = std::format(
2897 "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData",
2898 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williams5a39f772023-10-20 11:20:21 -05002899 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002900}
2901
2902void inline requestRoutesCrashdumpClear(App& app)
2903{
George Liu0fda0f12021-11-16 10:06:17 +08002904 BMCWEB_ROUTE(
2905 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002906 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07002907 // This is incorrect, should be:
2908 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07002909 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002910 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002911 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002912 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2913 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002914 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002915 {
2916 return;
2917 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002918 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002919 {
2920 // Option currently returns no systems. TBD
2921 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2922 systemName);
2923 return;
2924 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002925 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002926 {
2927 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2928 systemName);
2929 return;
2930 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002931 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002932 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07002933 const std::string&) {
2934 if (ec)
2935 {
2936 messages::internalError(asyncResp->res);
2937 return;
2938 }
2939 messages::success(asyncResp->res);
Patrick Williams5a39f772023-10-20 11:20:21 -05002940 },
Ed Tanous002d39b2022-05-31 08:59:27 -07002941 crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
Patrick Williams5a39f772023-10-20 11:20:21 -05002942 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002943}
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002944
zhanghch058d1b46d2021-04-01 11:18:24 +08002945static void
2946 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2947 const std::string& logID, nlohmann::json& logEntryJson)
Jason M. Billse855dd22019-10-08 11:37:48 -07002948{
Johnathan Mantey043a0532020-03-10 17:15:28 -07002949 auto getStoredLogCallback =
Ed Tanousb9d36b42022-02-26 21:42:46 -08002950 [asyncResp, logID,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002951 &logEntryJson](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08002952 const dbus::utility::DBusPropertiesMap& params) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002953 if (ec)
2954 {
Ed Tanous62598e32023-07-17 17:06:25 -07002955 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07002956 if (ec.value() ==
2957 boost::system::linux_error::bad_request_descriptor)
Jason M. Bills1ddcf012019-11-26 14:59:21 -08002958 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002959 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08002960 }
2961 else
2962 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002963 messages::internalError(asyncResp->res);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08002964 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002965 return;
2966 }
2967
2968 std::string timestamp{};
2969 std::string filename{};
2970 std::string logfile{};
2971 parseCrashdumpParameters(params, filename, timestamp, logfile);
2972
2973 if (filename.empty() || timestamp.empty())
2974 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002975 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07002976 return;
2977 }
2978
2979 std::string crashdumpURI =
Ed Tanous253f11b2024-05-16 09:38:31 -07002980 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/",
2981 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
Ed Tanous002d39b2022-05-31 08:59:27 -07002982 logID + "/" + filename;
Jason M. Bills84afc482022-06-24 12:38:23 -07002983 nlohmann::json::object_t logEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05002984 logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07002985 logEntry["@odata.id"] = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -07002986 "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/{}",
2987 BMCWEB_REDFISH_SYSTEM_URI_NAME, logID);
Jason M. Bills84afc482022-06-24 12:38:23 -07002988 logEntry["Name"] = "CPU Crashdump";
2989 logEntry["Id"] = logID;
Ed Tanous539d8c62024-06-19 14:38:27 -07002990 logEntry["EntryType"] = log_entry::LogEntryType::Oem;
Jason M. Bills84afc482022-06-24 12:38:23 -07002991 logEntry["AdditionalDataURI"] = std::move(crashdumpURI);
2992 logEntry["DiagnosticDataType"] = "OEM";
2993 logEntry["OEMDiagnosticDataType"] = "PECICrashdump";
2994 logEntry["Created"] = std::move(timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07002995
2996 // If logEntryJson references an array of LogEntry resources
2997 // ('Members' list), then push this as a new entry, otherwise set it
2998 // directly
2999 if (logEntryJson.is_array())
3000 {
3001 logEntryJson.push_back(logEntry);
3002 asyncResp->res.jsonValue["Members@odata.count"] =
3003 logEntryJson.size();
3004 }
3005 else
3006 {
Jason M. Billsd405bb52022-06-24 10:52:05 -07003007 logEntryJson.update(logEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07003008 }
3009 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003010 sdbusplus::asio::getAllProperties(
3011 *crow::connections::systemBus, crashdumpObject,
3012 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3013 std::move(getStoredLogCallback));
Jason M. Billse855dd22019-10-08 11:37:48 -07003014}
3015
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003016inline void requestRoutesCrashdumpEntryCollection(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003017{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003018 // Note: Deviated from redfish privilege registry for GET & HEAD
3019 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003020 /**
3021 * Functions triggers appropriate requests on DBus
3022 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003023 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003024 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003025 // This is incorrect, should be.
3026 //.privileges(redfish::privileges::postLogEntryCollection)
Ed Tanous432a8902021-06-14 15:28:56 -07003027 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003028 .methods(boost::beast::http::verb::get)(
3029 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003030 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3031 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003032 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003033 {
3034 return;
3035 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003036 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003037 {
3038 // Option currently returns no systems. TBD
3039 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3040 systemName);
3041 return;
3042 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003043 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003044 {
3045 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3046 systemName);
3047 return;
3048 }
3049
George Liu7a1dbc42022-12-07 16:03:22 +08003050 constexpr std::array<std::string_view, 1> interfaces = {
3051 crashdumpInterface};
3052 dbus::utility::getSubTreePaths(
3053 "/", 0, interfaces,
3054 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003055 const std::vector<std::string>& resp) {
3056 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003057 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003058 if (ec.value() !=
3059 boost::system::errc::no_such_file_or_directory)
3060 {
Ed Tanous62598e32023-07-17 17:06:25 -07003061 BMCWEB_LOG_DEBUG("failed to get entries ec: {}",
3062 ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003063 messages::internalError(asyncResp->res);
3064 return;
3065 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003066 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003067 asyncResp->res.jsonValue["@odata.type"] =
3068 "#LogEntryCollection.LogEntryCollection";
Ed Tanous253f11b2024-05-16 09:38:31 -07003069 asyncResp->res.jsonValue["@odata.id"] = std::format(
3070 "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries",
3071 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07003072 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
3073 asyncResp->res.jsonValue["Description"] =
3074 "Collection of Crashdump Entries";
3075 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3076 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003077
Ed Tanous002d39b2022-05-31 08:59:27 -07003078 for (const std::string& path : resp)
3079 {
3080 const sdbusplus::message::object_path objPath(path);
3081 // Get the log ID
3082 std::string logID = objPath.filename();
3083 if (logID.empty())
3084 {
3085 continue;
3086 }
3087 // Add the log entry to the array
3088 logCrashdumpEntry(asyncResp, logID,
3089 asyncResp->res.jsonValue["Members"]);
3090 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003091 });
Patrick Williams5a39f772023-10-20 11:20:21 -05003092 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003093}
Ed Tanous1da66f72018-07-27 16:13:37 -07003094
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003095inline void requestRoutesCrashdumpEntry(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003096{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003097 // Note: Deviated from redfish privilege registry for GET & HEAD
3098 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003099
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003100 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07003101 app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003102 // this is incorrect, should be
3103 // .privileges(redfish::privileges::getLogEntry)
Ed Tanous432a8902021-06-14 15:28:56 -07003104 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003105 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003106 [&app](const crow::Request& req,
3107 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003108 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003109 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003110 {
3111 return;
3112 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003113 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003114 {
3115 // Option currently returns no systems. TBD
3116 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3117 systemName);
3118 return;
3119 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003120 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003121 {
3122 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3123 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003124 return;
3125 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003126 const std::string& logID = param;
3127 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
Patrick Williams5a39f772023-10-20 11:20:21 -05003128 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003129}
Ed Tanous1da66f72018-07-27 16:13:37 -07003130
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003131inline void requestRoutesCrashdumpFile(App& app)
3132{
3133 // Note: Deviated from redfish privilege registry for GET & HEAD
3134 // method for security reasons.
3135 BMCWEB_ROUTE(
3136 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003137 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003138 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003139 .methods(boost::beast::http::verb::get)(
Nan Zhoua4ce1142022-08-02 18:45:25 +00003140 [](const crow::Request& req,
3141 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003142 const std::string& systemName, const std::string& logID,
3143 const std::string& fileName) {
Shounak Mitra2a9beee2022-07-20 18:41:30 +00003144 // Do not call getRedfishRoute here since the crashdump file is not a
3145 // Redfish resource.
Ed Tanous22d268c2022-05-19 09:39:07 -07003146
Ed Tanous25b54db2024-04-17 15:40:31 -07003147 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003148 {
3149 // Option currently returns no systems. TBD
3150 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3151 systemName);
3152 return;
3153 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003154 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003155 {
3156 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3157 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003158 return;
3159 }
3160
Ed Tanous002d39b2022-05-31 08:59:27 -07003161 auto getStoredLogCallback =
Ed Tanous39662a32023-02-06 15:09:46 -08003162 [asyncResp, logID, fileName, url(boost::urls::url(req.url()))](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003163 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003164 const std::vector<
3165 std::pair<std::string, dbus::utility::DbusVariantType>>&
3166 resp) {
3167 if (ec)
3168 {
Ed Tanous62598e32023-07-17 17:06:25 -07003169 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003170 messages::internalError(asyncResp->res);
3171 return;
3172 }
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003173
Ed Tanous002d39b2022-05-31 08:59:27 -07003174 std::string dbusFilename{};
3175 std::string dbusTimestamp{};
3176 std::string dbusFilepath{};
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003177
Ed Tanous002d39b2022-05-31 08:59:27 -07003178 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
3179 dbusFilepath);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003180
Ed Tanous002d39b2022-05-31 08:59:27 -07003181 if (dbusFilename.empty() || dbusTimestamp.empty() ||
3182 dbusFilepath.empty())
3183 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003184 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003185 return;
3186 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003187
Ed Tanous002d39b2022-05-31 08:59:27 -07003188 // Verify the file name parameter is correct
3189 if (fileName != dbusFilename)
3190 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003191 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003192 return;
3193 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003194
Ed Tanous27b0cf92023-08-07 12:02:40 -07003195 if (!asyncResp->res.openFile(dbusFilepath))
Ed Tanous002d39b2022-05-31 08:59:27 -07003196 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003197 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003198 return;
3199 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003200
Ed Tanous002d39b2022-05-31 08:59:27 -07003201 // Configure this to be a file download when accessed
3202 // from a browser
Ed Tanousd9f6c622022-03-17 09:12:17 -07003203 asyncResp->res.addHeader(
3204 boost::beast::http::field::content_disposition, "attachment");
Ed Tanous002d39b2022-05-31 08:59:27 -07003205 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003206 sdbusplus::asio::getAllProperties(
3207 *crow::connections::systemBus, crashdumpObject,
3208 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3209 std::move(getStoredLogCallback));
Patrick Williams5a39f772023-10-20 11:20:21 -05003210 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003211}
3212
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003213enum class OEMDiagnosticType
3214{
3215 onDemand,
3216 telemetry,
3217 invalid,
3218};
3219
Ed Tanous26ccae32023-02-16 10:28:44 -08003220inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr)
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003221{
3222 if (oemDiagStr == "OnDemand")
3223 {
3224 return OEMDiagnosticType::onDemand;
3225 }
3226 if (oemDiagStr == "Telemetry")
3227 {
3228 return OEMDiagnosticType::telemetry;
3229 }
3230
3231 return OEMDiagnosticType::invalid;
3232}
3233
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003234inline void requestRoutesCrashdumpCollect(App& app)
3235{
3236 // Note: Deviated from redfish privilege registry for GET & HEAD
3237 // method for security reasons.
George Liu0fda0f12021-11-16 10:06:17 +08003238 BMCWEB_ROUTE(
3239 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003240 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07003241 // The below is incorrect; Should be ConfigureManager
3242 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003243 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003244 .methods(boost::beast::http::verb::post)(
3245 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003246 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3247 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003248 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003249 {
3250 return;
3251 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003252
Ed Tanous25b54db2024-04-17 15:40:31 -07003253 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003254 {
3255 // Option currently returns no systems. TBD
3256 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3257 systemName);
3258 return;
3259 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003260 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003261 {
3262 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3263 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003264 return;
3265 }
3266
Ed Tanous002d39b2022-05-31 08:59:27 -07003267 std::string diagnosticDataType;
3268 std::string oemDiagnosticDataType;
3269 if (!redfish::json_util::readJsonAction(
3270 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
3271 "OEMDiagnosticDataType", oemDiagnosticDataType))
3272 {
3273 return;
3274 }
3275
3276 if (diagnosticDataType != "OEM")
3277 {
Ed Tanous62598e32023-07-17 17:06:25 -07003278 BMCWEB_LOG_ERROR(
3279 "Only OEM DiagnosticDataType supported for Crashdump");
Ed Tanous002d39b2022-05-31 08:59:27 -07003280 messages::actionParameterValueFormatError(
3281 asyncResp->res, diagnosticDataType, "DiagnosticDataType",
3282 "CollectDiagnosticData");
3283 return;
3284 }
3285
3286 OEMDiagnosticType oemDiagType =
3287 getOEMDiagnosticType(oemDiagnosticDataType);
3288
3289 std::string iface;
3290 std::string method;
3291 std::string taskMatchStr;
3292 if (oemDiagType == OEMDiagnosticType::onDemand)
3293 {
3294 iface = crashdumpOnDemandInterface;
3295 method = "GenerateOnDemandLog";
3296 taskMatchStr = "type='signal',"
3297 "interface='org.freedesktop.DBus.Properties',"
3298 "member='PropertiesChanged',"
3299 "arg0namespace='com.intel.crashdump'";
3300 }
3301 else if (oemDiagType == OEMDiagnosticType::telemetry)
3302 {
3303 iface = crashdumpTelemetryInterface;
3304 method = "GenerateTelemetryLog";
3305 taskMatchStr = "type='signal',"
3306 "interface='org.freedesktop.DBus.Properties',"
3307 "member='PropertiesChanged',"
3308 "arg0namespace='com.intel.crashdump'";
3309 }
3310 else
3311 {
Ed Tanous62598e32023-07-17 17:06:25 -07003312 BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}",
3313 oemDiagnosticDataType);
Ed Tanous002d39b2022-05-31 08:59:27 -07003314 messages::actionParameterValueFormatError(
3315 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType",
3316 "CollectDiagnosticData");
3317 return;
3318 }
3319
3320 auto collectCrashdumpCallback =
3321 [asyncResp, payload(task::Payload(req)),
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003322 taskMatchStr](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003323 const std::string&) mutable {
3324 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003325 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003326 if (ec.value() == boost::system::errc::operation_not_supported)
3327 {
3328 messages::resourceInStandby(asyncResp->res);
3329 }
3330 else if (ec.value() ==
3331 boost::system::errc::device_or_resource_busy)
3332 {
3333 messages::serviceTemporarilyUnavailable(asyncResp->res,
3334 "60");
3335 }
3336 else
3337 {
3338 messages::internalError(asyncResp->res);
3339 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003340 return;
3341 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003342 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
Ed Tanous8b242752023-06-27 17:17:13 -07003343 [](const boost::system::error_code& ec2, sdbusplus::message_t&,
Ed Tanous002d39b2022-05-31 08:59:27 -07003344 const std::shared_ptr<task::TaskData>& taskData) {
Ed Tanous8b242752023-06-27 17:17:13 -07003345 if (!ec2)
Ed Tanous002d39b2022-05-31 08:59:27 -07003346 {
3347 taskData->messages.emplace_back(messages::taskCompletedOK(
3348 std::to_string(taskData->index)));
3349 taskData->state = "Completed";
3350 }
3351 return task::completed;
Patrick Williams5a39f772023-10-20 11:20:21 -05003352 },
Ed Tanous002d39b2022-05-31 08:59:27 -07003353 taskMatchStr);
Ed Tanous1da66f72018-07-27 16:13:37 -07003354
Ed Tanous002d39b2022-05-31 08:59:27 -07003355 task->startTimer(std::chrono::minutes(5));
3356 task->populateResp(asyncResp->res);
3357 task->payload.emplace(std::move(payload));
3358 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003359
Ed Tanous002d39b2022-05-31 08:59:27 -07003360 crow::connections::systemBus->async_method_call(
3361 std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath,
3362 iface, method);
Patrick Williams5a39f772023-10-20 11:20:21 -05003363 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003364}
Kenny L. Ku6eda7682020-06-19 09:48:36 -07003365
Alexander Hansen599b9af2024-08-06 15:11:57 +02003366inline void dBusLogServiceActionsClear(
3367 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
3368{
3369 BMCWEB_LOG_DEBUG("Do delete all entries.");
3370
3371 // Process response from Logging service.
3372 auto respHandler = [asyncResp](const boost::system::error_code& ec) {
3373 BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done");
3374 if (ec)
3375 {
3376 // TODO Handle for specific error code
3377 BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec);
3378 asyncResp->res.result(
3379 boost::beast::http::status::internal_server_error);
3380 return;
3381 }
3382
3383 asyncResp->res.result(boost::beast::http::status::no_content);
3384 };
3385
3386 // Make call to Logging service to request Clear Log
3387 crow::connections::systemBus->async_method_call(
3388 respHandler, "xyz.openbmc_project.Logging",
3389 "/xyz/openbmc_project/logging",
3390 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3391}
3392
Andrew Geisslercb92c032018-08-17 07:56:14 -07003393/**
3394 * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3395 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003396inline void requestRoutesDBusLogServiceActionsClear(App& app)
Andrew Geisslercb92c032018-08-17 07:56:14 -07003397{
Andrew Geisslercb92c032018-08-17 07:56:14 -07003398 /**
3399 * Function handles POST method request.
3400 * The Clear Log actions does not require any parameter.The action deletes
3401 * all entries found in the Entries collection for this Log Service.
3402 */
Andrew Geisslercb92c032018-08-17 07:56:14 -07003403
George Liu0fda0f12021-11-16 10:06:17 +08003404 BMCWEB_ROUTE(
3405 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003406 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003407 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003408 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003409 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003410 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3411 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003412 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003413 {
3414 return;
3415 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003416 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003417 {
3418 // Option currently returns no systems. TBD
3419 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3420 systemName);
3421 return;
3422 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003423 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003424 {
3425 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3426 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003427 return;
3428 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02003429 dBusLogServiceActionsClear(asyncResp);
Patrick Williams5a39f772023-10-20 11:20:21 -05003430 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003431}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003432
3433/****************************************************
3434 * Redfish PostCode interfaces
3435 * using DBUS interface: getPostCodesTS
3436 ******************************************************/
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003437inline void requestRoutesPostCodesLogService(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003438{
Ed Tanous22d268c2022-05-19 09:39:07 -07003439 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/")
Ed Tanoused398212021-06-09 17:05:54 -07003440 .privileges(redfish::privileges::getLogService)
Ed Tanous002d39b2022-05-31 08:59:27 -07003441 .methods(boost::beast::http::verb::get)(
3442 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003443 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3444 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003445 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003446 {
3447 return;
3448 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003449 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003450 {
3451 // Option currently returns no systems. TBD
3452 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3453 systemName);
3454 return;
3455 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003456 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003457 {
3458 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3459 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003460 return;
3461 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003462 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003463 std::format("/redfish/v1/Systems/{}/LogServices/PostCodes",
3464 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07003465 asyncResp->res.jsonValue["@odata.type"] =
Janet Adkinsb25644a2023-08-16 11:23:45 -05003466 "#LogService.v1_2_0.LogService";
Ed Tanous002d39b2022-05-31 08:59:27 -07003467 asyncResp->res.jsonValue["Name"] = "POST Code Log Service";
3468 asyncResp->res.jsonValue["Description"] = "POST Code Log Service";
Ed Tanoused34a4a2023-02-08 15:43:27 -08003469 asyncResp->res.jsonValue["Id"] = "PostCodes";
Ed Tanous539d8c62024-06-19 14:38:27 -07003470 asyncResp->res.jsonValue["OverWritePolicy"] =
3471 log_service::OverWritePolicy::WrapsWhenFull;
Ed Tanous002d39b2022-05-31 08:59:27 -07003472 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003473 std::format("/redfish/v1/Systems/{}/LogServices/PostCodes/Entries",
3474 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Tejas Patil7c8c4052021-06-04 17:43:14 +05303475
Ed Tanous002d39b2022-05-31 08:59:27 -07003476 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07003477 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07003478 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
3479 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
3480 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303481
Ed Tanous20fa6a22024-05-20 18:02:58 -07003482 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]
3483 ["target"] = std::format(
3484 "/redfish/v1/Systems/{}/LogServices/PostCodes/Actions/LogService.ClearLog",
3485 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williams5a39f772023-10-20 11:20:21 -05003486 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003487}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003488
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003489inline void requestRoutesPostCodesClear(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003490{
George Liu0fda0f12021-11-16 10:06:17 +08003491 BMCWEB_ROUTE(
3492 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003493 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003494 // The following privilege is incorrect; It should be ConfigureManager
3495 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003496 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003497 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003498 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003499 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3500 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003501 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003502 {
3503 return;
3504 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003505 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003506 {
3507 // Option currently returns no systems. TBD
3508 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3509 systemName);
3510 return;
3511 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003512 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003513 {
3514 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3515 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003516 return;
3517 }
Ed Tanous62598e32023-07-17 17:06:25 -07003518 BMCWEB_LOG_DEBUG("Do delete all postcodes entries.");
ZhikuiRena3316fc2020-01-29 14:58:08 -08003519
Ed Tanous002d39b2022-05-31 08:59:27 -07003520 // Make call to post-code service to request clear all
3521 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003522 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003523 if (ec)
3524 {
3525 // TODO Handle for specific error code
Ed Tanous62598e32023-07-17 17:06:25 -07003526 BMCWEB_LOG_ERROR("doClearPostCodes resp_handler got error {}",
3527 ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07003528 asyncResp->res.result(
3529 boost::beast::http::status::internal_server_error);
3530 messages::internalError(asyncResp->res);
3531 return;
3532 }
Tony Lee18fc70c2023-08-24 16:15:54 +08003533 messages::success(asyncResp->res);
Patrick Williams5a39f772023-10-20 11:20:21 -05003534 },
Ed Tanous002d39b2022-05-31 08:59:27 -07003535 "xyz.openbmc_project.State.Boot.PostCode0",
3536 "/xyz/openbmc_project/State/Boot/PostCode0",
3537 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
Patrick Williams5a39f772023-10-20 11:20:21 -05003538 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003539}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003540
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003541/**
3542 * @brief Parse post code ID and get the current value and index value
3543 * eg: postCodeID=B1-2, currentValue=1, index=2
3544 *
3545 * @param[in] postCodeID Post Code ID
3546 * @param[out] currentValue Current value
3547 * @param[out] index Index value
3548 *
3549 * @return bool true if the parsing is successful, false the parsing fails
3550 */
Ed Tanous6f056f22024-04-07 13:35:51 -07003551inline bool parsePostCode(std::string_view postCodeID, uint64_t& currentValue,
Ed Tanousdf254f22024-04-01 13:25:46 -07003552 uint16_t& index)
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003553{
3554 std::vector<std::string> split;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08003555 bmcweb::split(split, postCodeID, '-');
Ed Tanous6f056f22024-04-07 13:35:51 -07003556 if (split.size() != 2)
3557 {
3558 return false;
3559 }
3560 std::string_view postCodeNumber = split[0];
3561 if (postCodeNumber.size() < 2)
3562 {
3563 return false;
3564 }
3565 if (postCodeNumber[0] != 'B')
3566 {
3567 return false;
3568 }
3569 postCodeNumber.remove_prefix(1);
3570 auto [ptrIndex, ecIndex] = std::from_chars(postCodeNumber.begin(),
3571 postCodeNumber.end(), index);
3572 if (ptrIndex != postCodeNumber.end() || ecIndex != std::errc())
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003573 {
3574 return false;
3575 }
3576
Ed Tanous6f056f22024-04-07 13:35:51 -07003577 std::string_view postCodeIndex = split[1];
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003578
Ed Tanous6f056f22024-04-07 13:35:51 -07003579 auto [ptrValue, ecValue] = std::from_chars(
3580 postCodeIndex.begin(), postCodeIndex.end(), currentValue);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003581
Ed Tanous6f056f22024-04-07 13:35:51 -07003582 return ptrValue == postCodeIndex.end() && ecValue == std::errc();
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003583}
3584
3585static bool fillPostCodeEntry(
Ed Tanousac106bf2023-06-07 09:24:59 -07003586 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303587 const boost::container::flat_map<
3588 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003589 const uint16_t bootIndex, const uint64_t codeIndex = 0,
3590 const uint64_t skip = 0, const uint64_t top = 0)
3591{
3592 // Get the Message from the MessageRegistry
Ed Tanousfffb8c12022-02-07 23:53:03 -08003593 const registries::Message* message =
3594 registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
Ed Tanousdc8cfa62024-04-07 13:37:25 -07003595 if (message == nullptr)
3596 {
3597 BMCWEB_LOG_ERROR("Couldn't find known message?");
3598 return false;
3599 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003600 uint64_t currentCodeIndex = 0;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003601 uint64_t firstCodeTimeUs = 0;
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303602 for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3603 code : postcode)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003604 {
3605 currentCodeIndex++;
3606 std::string postcodeEntryID =
3607 "B" + std::to_string(bootIndex) + "-" +
3608 std::to_string(currentCodeIndex); // 1 based index in EntryID string
3609
3610 uint64_t usecSinceEpoch = code.first;
3611 uint64_t usTimeOffset = 0;
3612
3613 if (1 == currentCodeIndex)
3614 { // already incremented
3615 firstCodeTimeUs = code.first;
3616 }
3617 else
3618 {
3619 usTimeOffset = code.first - firstCodeTimeUs;
3620 }
3621
3622 // skip if no specific codeIndex is specified and currentCodeIndex does
3623 // not fall between top and skip
3624 if ((codeIndex == 0) &&
3625 (currentCodeIndex <= skip || currentCodeIndex > top))
3626 {
3627 continue;
3628 }
3629
Gunnar Mills4e0453b2020-07-08 14:00:30 -05003630 // skip if a specific codeIndex is specified and does not match the
ZhikuiRena3316fc2020-01-29 14:58:08 -08003631 // currentIndex
3632 if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3633 {
3634 // This is done for simplicity. 1st entry is needed to calculate
3635 // time offset. To improve efficiency, one can get to the entry
3636 // directly (possibly with flatmap's nth method)
3637 continue;
3638 }
3639
3640 // currentCodeIndex is within top and skip or equal to specified code
3641 // index
3642
3643 // Get the Created time from the timestamp
3644 std::string entryTimeStr;
Konstantin Aladyshev2a025612023-02-15 11:52:58 +03003645 entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003646
3647 // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3648 std::ostringstream hexCode;
3649 hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303650 << std::get<0>(code.second);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003651 std::ostringstream timeOffsetStr;
3652 // Set Fixed -Point Notation
3653 timeOffsetStr << std::fixed;
3654 // Set precision to 4 digits
3655 timeOffsetStr << std::setprecision(4);
3656 // Add double to stream
3657 timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003658
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003659 std::string bootIndexStr = std::to_string(bootIndex);
3660 std::string timeOffsetString = timeOffsetStr.str();
3661 std::string hexCodeStr = hexCode.str();
3662
3663 std::array<std::string_view, 3> messageArgs = {
3664 bootIndexStr, timeOffsetString, hexCodeStr};
3665
3666 std::string msg =
3667 redfish::registries::fillMessageArgs(messageArgs, message->message);
3668 if (msg.empty())
ZhikuiRena3316fc2020-01-29 14:58:08 -08003669 {
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003670 messages::internalError(asyncResp->res);
3671 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003672 }
3673
Tim Leed4342a92020-04-27 11:47:58 +08003674 // Get Severity template from message registry
3675 std::string severity;
3676 if (message != nullptr)
3677 {
Ed Tanous5f2b84e2022-02-08 00:41:53 -08003678 severity = message->messageSeverity;
Tim Leed4342a92020-04-27 11:47:58 +08003679 }
3680
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003681 // Format entry
3682 nlohmann::json::object_t bmcLogEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05003683 bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07003684 bmcLogEntry["@odata.id"] = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -07003685 "/redfish/v1/Systems/{}/LogServices/PostCodes/Entries/{}",
3686 BMCWEB_REDFISH_SYSTEM_URI_NAME, postcodeEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07003687 bmcLogEntry["Name"] = "POST Code Log Entry";
3688 bmcLogEntry["Id"] = postcodeEntryID;
3689 bmcLogEntry["Message"] = std::move(msg);
3690 bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode";
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003691 bmcLogEntry["MessageArgs"] = messageArgs;
Jason M. Bills84afc482022-06-24 12:38:23 -07003692 bmcLogEntry["EntryType"] = "Event";
3693 bmcLogEntry["Severity"] = std::move(severity);
3694 bmcLogEntry["Created"] = entryTimeStr;
George Liu647b3cd2021-07-05 12:43:56 +08003695 if (!std::get<std::vector<uint8_t>>(code.second).empty())
3696 {
3697 bmcLogEntry["AdditionalDataURI"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003698 std::format(
3699 "/redfish/v1/Systems/{}/LogServices/PostCodes/Entries/",
3700 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
George Liu647b3cd2021-07-05 12:43:56 +08003701 postcodeEntryID + "/attachment";
3702 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003703
3704 // codeIndex is only specified when querying single entry, return only
3705 // that entry in this case
3706 if (codeIndex != 0)
3707 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003708 asyncResp->res.jsonValue.update(bmcLogEntry);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003709 return true;
3710 }
3711
Ed Tanousac106bf2023-06-07 09:24:59 -07003712 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
Patrick Williamsb2ba3072023-05-12 10:27:39 -05003713 logEntryArray.emplace_back(std::move(bmcLogEntry));
ZhikuiRena3316fc2020-01-29 14:58:08 -08003714 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003715
3716 // Return value is always false when querying multiple entries
3717 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003718}
3719
Ed Tanousac106bf2023-06-07 09:24:59 -07003720static void
3721 getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3722 const std::string& entryId)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003723{
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003724 uint16_t bootIndex = 0;
3725 uint64_t codeIndex = 0;
3726 if (!parsePostCode(entryId, codeIndex, bootIndex))
3727 {
3728 // Requested ID was not found
Ed Tanousac106bf2023-06-07 09:24:59 -07003729 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003730 return;
3731 }
3732
3733 if (bootIndex == 0 || codeIndex == 0)
3734 {
3735 // 0 is an invalid index
Ed Tanousac106bf2023-06-07 09:24:59 -07003736 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003737 return;
3738 }
3739
ZhikuiRena3316fc2020-01-29 14:58:08 -08003740 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07003741 [asyncResp, entryId, bootIndex,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003742 codeIndex](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303743 const boost::container::flat_map<
3744 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3745 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003746 if (ec)
3747 {
Ed Tanous62598e32023-07-17 17:06:25 -07003748 BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
Ed Tanousac106bf2023-06-07 09:24:59 -07003749 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003750 return;
3751 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003752
Ed Tanous002d39b2022-05-31 08:59:27 -07003753 if (postcode.empty())
3754 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003755 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Ed Tanous002d39b2022-05-31 08:59:27 -07003756 return;
3757 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003758
Ed Tanousac106bf2023-06-07 09:24:59 -07003759 if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex))
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003760 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003761 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003762 return;
3763 }
Patrick Williams5a39f772023-10-20 11:20:21 -05003764 },
Jonathan Doman15124762021-01-07 17:54:17 -08003765 "xyz.openbmc_project.State.Boot.PostCode0",
3766 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08003767 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3768 bootIndex);
3769}
3770
Ed Tanousac106bf2023-06-07 09:24:59 -07003771static void
3772 getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3773 const uint16_t bootIndex, const uint16_t bootCount,
3774 const uint64_t entryCount, size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003775{
3776 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07003777 [asyncResp, bootIndex, bootCount, entryCount, skip,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003778 top](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303779 const boost::container::flat_map<
3780 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3781 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003782 if (ec)
3783 {
Ed Tanous62598e32023-07-17 17:06:25 -07003784 BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
Ed Tanousac106bf2023-06-07 09:24:59 -07003785 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003786 return;
3787 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003788
Ed Tanous002d39b2022-05-31 08:59:27 -07003789 uint64_t endCount = entryCount;
3790 if (!postcode.empty())
3791 {
3792 endCount = entryCount + postcode.size();
Ed Tanous3648c8b2022-07-25 13:39:59 -07003793 if (skip < endCount && (top + skip) > entryCount)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003794 {
Patrick Williams89492a12023-05-10 07:51:34 -05003795 uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip),
3796 entryCount) -
3797 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003798 uint64_t thisBootTop =
Ed Tanous3648c8b2022-07-25 13:39:59 -07003799 std::min(static_cast<uint64_t>(top + skip), endCount) -
3800 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003801
Ed Tanousac106bf2023-06-07 09:24:59 -07003802 fillPostCodeEntry(asyncResp, postcode, bootIndex, 0,
3803 thisBootSkip, thisBootTop);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003804 }
Ed Tanousac106bf2023-06-07 09:24:59 -07003805 asyncResp->res.jsonValue["Members@odata.count"] = endCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003806 }
3807
3808 // continue to previous bootIndex
3809 if (bootIndex < bootCount)
3810 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003811 getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1),
Ed Tanous002d39b2022-05-31 08:59:27 -07003812 bootCount, endCount, skip, top);
3813 }
Jiaqing Zhao81584ab2022-07-28 00:33:45 +08003814 else if (skip + top < endCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07003815 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003816 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003817 std::format(
3818 "/redfish/v1/Systems/{}/LogServices/PostCodes/Entries?$skip=",
3819 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
Ed Tanous002d39b2022-05-31 08:59:27 -07003820 std::to_string(skip + top);
3821 }
Patrick Williams5a39f772023-10-20 11:20:21 -05003822 },
Jonathan Doman15124762021-01-07 17:54:17 -08003823 "xyz.openbmc_project.State.Boot.PostCode0",
3824 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08003825 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3826 bootIndex);
3827}
3828
zhanghch058d1b46d2021-04-01 11:18:24 +08003829static void
Ed Tanousac106bf2023-06-07 09:24:59 -07003830 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous3648c8b2022-07-25 13:39:59 -07003831 size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003832{
3833 uint64_t entryCount = 0;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07003834 sdbusplus::asio::getProperty<uint16_t>(
3835 *crow::connections::systemBus,
3836 "xyz.openbmc_project.State.Boot.PostCode0",
3837 "/xyz/openbmc_project/State/Boot/PostCode0",
3838 "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount",
Ed Tanousac106bf2023-06-07 09:24:59 -07003839 [asyncResp, entryCount, skip, top](const boost::system::error_code& ec,
3840 const uint16_t bootCount) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003841 if (ec)
3842 {
Ed Tanous62598e32023-07-17 17:06:25 -07003843 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanousac106bf2023-06-07 09:24:59 -07003844 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003845 return;
3846 }
Ed Tanousac106bf2023-06-07 09:24:59 -07003847 getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top);
Patrick Williams5a39f772023-10-20 11:20:21 -05003848 });
ZhikuiRena3316fc2020-01-29 14:58:08 -08003849}
3850
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003851inline void requestRoutesPostCodesEntryCollection(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003852{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003853 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003854 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003855 .privileges(redfish::privileges::getLogEntryCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003856 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003857 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003858 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3859 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003860 query_param::QueryCapabilities capabilities = {
3861 .canDelegateTop = true,
3862 .canDelegateSkip = true,
3863 };
3864 query_param::Query delegatedQuery;
3865 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00003866 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07003867 {
3868 return;
3869 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003870 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003871 {
3872 // Option currently returns no systems. TBD
3873 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3874 systemName);
3875 return;
3876 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003877
Ed Tanous253f11b2024-05-16 09:38:31 -07003878 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003879 {
3880 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3881 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003882 return;
3883 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003884 asyncResp->res.jsonValue["@odata.type"] =
3885 "#LogEntryCollection.LogEntryCollection";
3886 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003887 std::format("/redfish/v1/Systems/{}/LogServices/PostCodes/Entries",
3888 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07003889 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3890 asyncResp->res.jsonValue["Description"] =
3891 "Collection of POST Code Log Entries";
3892 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3893 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07003894 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08003895 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07003896 getCurrentBootNumber(asyncResp, skip, top);
Patrick Williams5a39f772023-10-20 11:20:21 -05003897 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003898}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003899
George Liu647b3cd2021-07-05 12:43:56 +08003900inline void requestRoutesPostCodesEntryAdditionalData(App& app)
3901{
George Liu0fda0f12021-11-16 10:06:17 +08003902 BMCWEB_ROUTE(
3903 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003904 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/")
George Liu647b3cd2021-07-05 12:43:56 +08003905 .privileges(redfish::privileges::getLogEntry)
3906 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003907 [&app](const crow::Request& req,
3908 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003909 const std::string& systemName,
Ed Tanous45ca1b82022-03-25 13:07:27 -07003910 const std::string& postCodeID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003911 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003912 {
3913 return;
3914 }
Matt Spinler72e21372023-04-19 12:53:33 -05003915 if (!http_helpers::isContentTypeAllowed(
Ed Tanous99351cd2022-08-07 16:42:51 -07003916 req.getHeaderValue("Accept"),
Ed Tanous4a0e1a02022-09-21 15:28:04 -07003917 http_helpers::ContentType::OctetStream, true))
Ed Tanous002d39b2022-05-31 08:59:27 -07003918 {
3919 asyncResp->res.result(boost::beast::http::status::bad_request);
3920 return;
3921 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003922 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003923 {
3924 // Option currently returns no systems. TBD
3925 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3926 systemName);
3927 return;
3928 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003929 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003930 {
3931 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3932 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003933 return;
3934 }
George Liu647b3cd2021-07-05 12:43:56 +08003935
Ed Tanous002d39b2022-05-31 08:59:27 -07003936 uint64_t currentValue = 0;
3937 uint16_t index = 0;
3938 if (!parsePostCode(postCodeID, currentValue, index))
3939 {
3940 messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID);
3941 return;
3942 }
George Liu647b3cd2021-07-05 12:43:56 +08003943
Ed Tanous002d39b2022-05-31 08:59:27 -07003944 crow::connections::systemBus->async_method_call(
3945 [asyncResp, postCodeID, currentValue](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003946 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003947 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>&
3948 postcodes) {
3949 if (ec.value() == EBADR)
3950 {
3951 messages::resourceNotFound(asyncResp->res, "LogEntry",
3952 postCodeID);
3953 return;
3954 }
3955 if (ec)
3956 {
Ed Tanous62598e32023-07-17 17:06:25 -07003957 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07003958 messages::internalError(asyncResp->res);
3959 return;
3960 }
George Liu647b3cd2021-07-05 12:43:56 +08003961
Ed Tanous002d39b2022-05-31 08:59:27 -07003962 size_t value = static_cast<size_t>(currentValue) - 1;
3963 if (value == std::string::npos || postcodes.size() < currentValue)
3964 {
Ed Tanous62598e32023-07-17 17:06:25 -07003965 BMCWEB_LOG_WARNING("Wrong currentValue value");
Ed Tanous002d39b2022-05-31 08:59:27 -07003966 messages::resourceNotFound(asyncResp->res, "LogEntry",
3967 postCodeID);
3968 return;
3969 }
George Liu647b3cd2021-07-05 12:43:56 +08003970
Ed Tanous002d39b2022-05-31 08:59:27 -07003971 const auto& [tID, c] = postcodes[value];
3972 if (c.empty())
3973 {
Ed Tanous62598e32023-07-17 17:06:25 -07003974 BMCWEB_LOG_WARNING("No found post code data");
Ed Tanous002d39b2022-05-31 08:59:27 -07003975 messages::resourceNotFound(asyncResp->res, "LogEntry",
3976 postCodeID);
3977 return;
3978 }
3979 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
3980 const char* d = reinterpret_cast<const char*>(c.data());
3981 std::string_view strData(d, c.size());
George Liu647b3cd2021-07-05 12:43:56 +08003982
Ed Tanousd9f6c622022-03-17 09:12:17 -07003983 asyncResp->res.addHeader(boost::beast::http::field::content_type,
Ed Tanous002d39b2022-05-31 08:59:27 -07003984 "application/octet-stream");
Ed Tanousd9f6c622022-03-17 09:12:17 -07003985 asyncResp->res.addHeader(
3986 boost::beast::http::field::content_transfer_encoding, "Base64");
Ed Tanous27b0cf92023-08-07 12:02:40 -07003987 asyncResp->res.write(crow::utility::base64encode(strData));
Patrick Williams5a39f772023-10-20 11:20:21 -05003988 },
Ed Tanous002d39b2022-05-31 08:59:27 -07003989 "xyz.openbmc_project.State.Boot.PostCode0",
3990 "/xyz/openbmc_project/State/Boot/PostCode0",
3991 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index);
Patrick Williams5a39f772023-10-20 11:20:21 -05003992 });
George Liu647b3cd2021-07-05 12:43:56 +08003993}
3994
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003995inline void requestRoutesPostCodesEntry(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003996{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003997 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07003998 app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003999 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004000 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07004001 [&app](const crow::Request& req,
4002 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07004003 const std::string& systemName, const std::string& targetID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00004004 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07004005 {
4006 return;
4007 }
Ed Tanous25b54db2024-04-17 15:40:31 -07004008 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08004009 {
4010 // Option currently returns no systems. TBD
4011 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4012 systemName);
4013 return;
4014 }
Ed Tanous253f11b2024-05-16 09:38:31 -07004015 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07004016 {
4017 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4018 systemName);
4019 return;
4020 }
4021
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08004022 getPostCodeForEntry(asyncResp, targetID);
Patrick Williams5a39f772023-10-20 11:20:21 -05004023 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004024}
ZhikuiRena3316fc2020-01-29 14:58:08 -08004025
Ed Tanous1da66f72018-07-27 16:13:37 -07004026} // namespace redfish